/*
 * Altera 10/100/1000 triple speed ethernet mac
 *
 * Copyright (C) 2008 Altera Corporation.
 * Copyright (C) 2010 Thomas Chou <thomas@wytron.com.tw>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef _ALTERA_TSE_H_
#define _ALTERA_TSE_H_

#include <linux/bitops.h>
#define __packed_1_    __packed __aligned(1)

/* dma type */
#define ALT_SGDMA       0
#define ALT_MSGDMA      1

/* SGDMA Stuff */
#define ALT_SGDMA_STATUS_BUSY_MSK                               BIT(4)

#define ALT_SGDMA_CONTROL_RUN_MSK                               BIT(5)
#define ALT_SGDMA_CONTROL_STOP_DMA_ER_MSK                       BIT(6)
#define ALT_SGDMA_CONTROL_SOFTWARERESET_MSK                     BIT(16)

/*
 * Descriptor control bit masks & offsets
 *
 * Note: The control byte physically occupies bits [31:24] in memory.
 *       The following bit-offsets are expressed relative to the LSB of
 *       the control register bitfield.
 */
#define ALT_SGDMA_DESCRIPTOR_CONTROL_GENERATE_EOP_MSK           BIT(0)
#define ALT_SGDMA_DESCRIPTOR_CONTROL_READ_FIXED_ADDRESS_MSK     BIT(1)
#define ALT_SGDMA_DESCRIPTOR_CONTROL_WRITE_FIXED_ADDRESS_MSK    BIT(2)
#define ALT_SGDMA_DESCRIPTOR_CONTROL_OWNED_BY_HW_MSK            BIT(7)

/*
 * Descriptor status bit masks & offsets
 *
 * Note: The status byte physically occupies bits [23:16] in memory.
 *       The following bit-offsets are expressed relative to the LSB of
 *       the status register bitfield.
 */
#define ALT_SGDMA_DESCRIPTOR_STATUS_TERMINATED_BY_EOP_MSK       BIT(7)

/*
 * The SGDMA controller buffer descriptor allocates
 * 64 bits for each address. To support ANSI C, the
 * struct implementing a descriptor places 32-bits
 * of padding directly above each address; each pad must
 * be cleared when initializing a descriptor.
 */

/*
 * Buffer Descriptor data structure
 *
 */
struct alt_sgdma_descriptor {
        u32 source;     /* the address of data to be read. */
        u32 source_pad;

        u32 destination;        /* the address to write data */
        u32 destination_pad;

        u32 next;       /* the next descriptor in the list. */
        u32 next_pad;

        u16 bytes_to_transfer; /* the number of bytes to transfer */
        u8 read_burst;
        u8 write_burst;

        u16 actual_bytes_transferred;/* bytes transferred by DMA */
        u8 descriptor_status;
        u8 descriptor_control;

} __packed_1_;

/* SG-DMA Control/Status Slave registers map */

struct alt_sgdma_registers {
        u32 status;
        u32 status_pad[3];
        u32 control;
        u32 control_pad[3];
        u32 next_descriptor_pointer;
        u32 descriptor_pad[3];
};

/* mSGDMA Stuff */

/* mSGDMA extended descriptor format */
struct msgdma_extended_desc {
        u32 read_addr_lo;       /* data buffer source address low bits */
        u32 write_addr_lo;      /* data buffer destination address low bits */
        u32 len;
        u32 burst_seq_num;
        u32 stride;
        u32 read_addr_hi;       /* data buffer source address high bits */
        u32 write_addr_hi;      /* data buffer destination address high bits */
        u32 control;            /* characteristics of the transfer */
};

/* mSGDMA descriptor control field bit definitions */
#define MSGDMA_DESC_CTL_GEN_SOP         BIT(8)
#define MSGDMA_DESC_CTL_GEN_EOP         BIT(9)
#define MSGDMA_DESC_CTL_END_ON_EOP      BIT(12)
#define MSGDMA_DESC_CTL_END_ON_LEN      BIT(13)
#define MSGDMA_DESC_CTL_GO              BIT(31)

/* Tx buffer control flags */
#define MSGDMA_DESC_CTL_TX_SINGLE       (MSGDMA_DESC_CTL_GEN_SOP |      \
                                         MSGDMA_DESC_CTL_GEN_EOP |      \
                                         MSGDMA_DESC_CTL_GO)

#define MSGDMA_DESC_CTL_RX_SINGLE       (MSGDMA_DESC_CTL_END_ON_EOP |   \
                                         MSGDMA_DESC_CTL_END_ON_LEN |   \
                                         MSGDMA_DESC_CTL_GO)

/* mSGDMA extended descriptor stride definitions */
#define MSGDMA_DESC_TX_STRIDE           0x00010001
#define MSGDMA_DESC_RX_STRIDE           0x00010001

/* mSGDMA dispatcher control and status register map */
struct msgdma_csr {
        u32 status;             /* Read/Clear */
        u32 control;            /* Read/Write */
        u32 rw_fill_level;
        u32 resp_fill_level;    /* bit 15:0 */
        u32 rw_seq_num;
        u32 pad[3];             /* reserved */
};

/* mSGDMA CSR status register bit definitions */
#define MSGDMA_CSR_STAT_BUSY                    BIT(0)
#define MSGDMA_CSR_STAT_RESETTING               BIT(6)
#define MSGDMA_CSR_STAT_MASK                    0x3FF

/* mSGDMA CSR control register bit definitions */
#define MSGDMA_CSR_CTL_RESET                    BIT(1)

/* mSGDMA response register map */
struct msgdma_response {
        u32 bytes_transferred;
        u32 status;
};

/* TSE Stuff */
#define ALTERA_TSE_CMD_TX_ENA_MSK               BIT(0)
#define ALTERA_TSE_CMD_RX_ENA_MSK               BIT(1)
#define ALTERA_TSE_CMD_ETH_SPEED_MSK            BIT(3)
#define ALTERA_TSE_CMD_HD_ENA_MSK               BIT(10)
#define ALTERA_TSE_CMD_SW_RESET_MSK             BIT(13)
#define ALTERA_TSE_CMD_ENA_10_MSK               BIT(25)

#define ALT_TSE_SW_RESET_TIMEOUT                (3 * CONFIG_SYS_HZ)
#define ALT_TSE_SGDMA_BUSY_TIMEOUT              (3 * CONFIG_SYS_HZ)

/* MAC register Space */

struct alt_tse_mac {
        u32 megacore_revision;
        u32 scratch_pad;
        u32 command_config;
        u32 mac_addr_0;
        u32 mac_addr_1;
        u32 max_frame_length;
        u32 pause_quanta;
        u32 rx_sel_empty_threshold;
        u32 rx_sel_full_threshold;
        u32 tx_sel_empty_threshold;
        u32 tx_sel_full_threshold;
        u32 rx_almost_empty_threshold;
        u32 rx_almost_full_threshold;
        u32 tx_almost_empty_threshold;
        u32 tx_almost_full_threshold;
        u32 mdio_phy0_addr;
        u32 mdio_phy1_addr;

        u32 reserved1[0x29];

        /*FIFO control register. */
        u32 tx_cmd_stat;
        u32 rx_cmd_stat;

        u32 reserved2[0x44];

        /*Registers 0 to 31 within PHY device 0/1 */
        u32 mdio_phy0[0x20];
        u32 mdio_phy1[0x20];

        /*4 Supplemental MAC Addresses */
        u32 supp_mac_addr_0_0;
        u32 supp_mac_addr_0_1;
        u32 supp_mac_addr_1_0;
        u32 supp_mac_addr_1_1;
        u32 supp_mac_addr_2_0;
        u32 supp_mac_addr_2_1;
        u32 supp_mac_addr_3_0;
        u32 supp_mac_addr_3_1;

        u32 reserved3[0x38];
};

struct tse_ops {
        int (*send)(struct udevice *dev, void *packet, int length);
        int (*recv)(struct udevice *dev, int flags, uchar **packetp);
        int (*free_pkt)(struct udevice *dev, uchar *packet, int length);
        void (*stop)(struct udevice *dev);
};

struct altera_tse_priv {
        struct alt_tse_mac *mac_dev;
        void *sgdma_rx;
        void *sgdma_tx;
        unsigned int rx_fifo_depth;
        unsigned int tx_fifo_depth;
        void *rx_desc;
        void *tx_desc;
        void *rx_resp;
        unsigned char *rx_buf;
        unsigned int phyaddr;
        unsigned int interface;
        struct phy_device *phydev;
        struct mii_dev *bus;
        const struct tse_ops *ops;
        int dma_type;
};

#endif /* _ALTERA_TSE_H_ */