[deliverable/linux.git] / drivers / net / ethernet / renesas / sh_eth.h

/*  SuperH Ethernet device driver
 *
 *  Copyright (C) 2006-2012 Nobuhiro Iwamatsu
 *  Copyright (C) 2008-2012 Renesas Solutions Corp.
 *
 *  This program is free software; you can redistribute it and/or modify it
 *  under the terms and conditions of the GNU General Public License,
 *  version 2, as published by the Free Software Foundation.
 *
 *  This program is distributed in the hope it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *
 *  The full GNU General Public License is included in this distribution in
 *  the file called "COPYING".
 */

#ifndef __SH_ETH_H__
#define __SH_ETH_H__

#define CARDNAME	"sh-eth"
#define TX_TIMEOUT	(5*HZ)
#define TX_RING_SIZE	64	/* Tx ring size */
#define RX_RING_SIZE	64	/* Rx ring size */
#define TX_RING_MIN	64
#define RX_RING_MIN	64
#define TX_RING_MAX	1024
#define RX_RING_MAX	1024
#define PKT_BUF_SZ	1538
#define SH_ETH_TSU_TIMEOUT_MS	500
#define SH_ETH_TSU_CAM_ENTRIES	32

enum {
	/* IMPORTANT: To keep ethtool register dump working, add new
	 * register names immediately before SH_ETH_MAX_REGISTER_OFFSET.
	 */

	/* E-DMAC registers */
	EDSR = 0,
	EDMR,
	EDTRR,
	EDRRR,
	EESR,
	EESIPR,
	TDLAR,
	TDFAR,
	TDFXR,
	TDFFR,
	RDLAR,
	RDFAR,
	RDFXR,
	RDFFR,
	TRSCER,
	RMFCR,
	TFTR,
	FDR,
	RMCR,
	EDOCR,
	TFUCR,
	RFOCR,
	RMIIMODE,
	FCFTR,
	RPADIR,
	TRIMD,
	RBWAR,
	TBRAR,

	/* Ether registers */
	ECMR,
	ECSR,
	ECSIPR,
	PIR,
	PSR,
	RDMLR,
	PIPR,
	RFLR,
	IPGR,
	APR,
	MPR,
	PFTCR,
	PFRCR,
	RFCR,
	RFCF,
	TPAUSER,
	TPAUSECR,
	BCFR,
	BCFRR,
	GECMR,
	BCULR,
	MAHR,
	MALR,
	TROCR,
	CDCR,
	LCCR,
	CNDCR,
	CEFCR,
	FRECR,
	TSFRCR,
	TLFRCR,
	CERCR,
	CEECR,
	MAFCR,
	RTRATE,
	CSMR,
	RMII_MII,

	/* TSU Absolute address */
	ARSTR,
	TSU_CTRST,
	TSU_FWEN0,
	TSU_FWEN1,
	TSU_FCM,
	TSU_BSYSL0,
	TSU_BSYSL1,
	TSU_PRISL0,
	TSU_PRISL1,
	TSU_FWSL0,
	TSU_FWSL1,
	TSU_FWSLC,
	TSU_QTAG0,
	TSU_QTAG1,
	TSU_QTAGM0,
	TSU_QTAGM1,
	TSU_FWSR,
	TSU_FWINMK,
	TSU_ADQT0,
	TSU_ADQT1,
	TSU_VTAG0,
	TSU_VTAG1,
	TSU_ADSBSY,
	TSU_TEN,
	TSU_POST1,
	TSU_POST2,
	TSU_POST3,
	TSU_POST4,
	TSU_ADRH0,
	/* TSU_ADR{H,L}{0..31} are assumed to be contiguous */

	TXNLCR0,
	TXALCR0,
	RXNLCR0,
	RXALCR0,
	FWNLCR0,
	FWALCR0,
	TXNLCR1,
	TXALCR1,
	RXNLCR1,
	RXALCR1,
	FWNLCR1,
	FWALCR1,

	/* This value must be written at last. */
	SH_ETH_MAX_REGISTER_OFFSET,
};

enum {
	SH_ETH_REG_GIGABIT,
	SH_ETH_REG_FAST_RZ,
	SH_ETH_REG_FAST_RCAR,
	SH_ETH_REG_FAST_SH4,
	SH_ETH_REG_FAST_SH3_SH2
};

/* Driver's parameters */
#if defined(CONFIG_CPU_SH4) || defined(CONFIG_ARCH_SHMOBILE)
#define SH_ETH_RX_ALIGN		32
#else
#define SH_ETH_RX_ALIGN		2
#endif

/* Register's bits
 */
/* EDSR : sh7734, sh7757, sh7763, r8a7740, and r7s72100 only */
enum EDSR_BIT {
	EDSR_ENT = 0x01, EDSR_ENR = 0x02,
};
#define EDSR_ENALL (EDSR_ENT|EDSR_ENR)

/* GECMR : sh7734, sh7763 and r8a7740 only */
enum GECMR_BIT {
	GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
};

/* EDMR */
enum DMAC_M_BIT {
	EDMR_EL = 0x40, /* Litte endian */
	EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
	EDMR_SRST_GETHER = 0x03,
	EDMR_SRST_ETHER = 0x01,
};

/* EDTRR */
enum DMAC_T_BIT {
	EDTRR_TRNS_GETHER = 0x03,
	EDTRR_TRNS_ETHER = 0x01,
};

/* EDRRR */
enum EDRRR_R_BIT {
	EDRRR_R = 0x01,
};

/* TPAUSER */
enum TPAUSER_BIT {
	TPAUSER_TPAUSE = 0x0000ffff,
	TPAUSER_UNLIMITED = 0,
};

/* BCFR */
enum BCFR_BIT {
	BCFR_RPAUSE = 0x0000ffff,
	BCFR_UNLIMITED = 0,
};

/* PIR */
enum PIR_BIT {
	PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
};

/* PSR */
enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };

/* EESR */
enum EESR_BIT {
	EESR_TWB1	= 0x80000000,
	EESR_TWB	= 0x40000000,	/* same as TWB0 */
	EESR_TC1	= 0x20000000,
	EESR_TUC	= 0x10000000,
	EESR_ROC	= 0x08000000,
	EESR_TABT	= 0x04000000,
	EESR_RABT	= 0x02000000,
	EESR_RFRMER	= 0x01000000,	/* same as RFCOF */
	EESR_ADE	= 0x00800000,
	EESR_ECI	= 0x00400000,
	EESR_FTC	= 0x00200000,	/* same as TC or TC0 */
	EESR_TDE	= 0x00100000,
	EESR_TFE	= 0x00080000,	/* same as TFUF */
	EESR_FRC	= 0x00040000,	/* same as FR */
	EESR_RDE	= 0x00020000,
	EESR_RFE	= 0x00010000,
	EESR_CND	= 0x00000800,
	EESR_DLC	= 0x00000400,
	EESR_CD		= 0x00000200,
	EESR_RTO	= 0x00000100,
	EESR_RMAF	= 0x00000080,
	EESR_CEEF	= 0x00000040,
	EESR_CELF	= 0x00000020,
	EESR_RRF	= 0x00000010,
	EESR_RTLF	= 0x00000008,
	EESR_RTSF	= 0x00000004,
	EESR_PRE	= 0x00000002,
	EESR_CERF	= 0x00000001,
};

#define EESR_RX_CHECK		(EESR_FRC  | /* Frame recv */		\
				 EESR_RMAF | /* Multicast address recv */ \
				 EESR_RRF  | /* Bit frame recv */	\
				 EESR_RTLF | /* Long frame recv */	\
				 EESR_RTSF | /* Short frame recv */	\
				 EESR_PRE  | /* PHY-LSI recv error */	\
				 EESR_CERF)  /* Recv frame CRC error */

#define DEFAULT_TX_CHECK	(EESR_FTC | EESR_CND | EESR_DLC | EESR_CD | \
				 EESR_RTO)
#define DEFAULT_EESR_ERR_CHECK	(EESR_TWB | EESR_TABT | EESR_RABT | EESR_RFE | \
				 EESR_RDE | EESR_RFRMER | EESR_ADE | \
				 EESR_TFE | EESR_TDE | EESR_ECI)

/* EESIPR */
enum DMAC_IM_BIT {
	DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
	DMAC_M_RABT = 0x02000000,
	DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
	DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
	DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
	DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
	DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
	DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
	DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
	DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
	DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
	DMAC_M_RINT1 = 0x00000001,
};

/* Receive descriptor bit */
enum RD_STS_BIT {
	RD_RACT = 0x80000000, RD_RDLE = 0x40000000,
	RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
	RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
	RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
	RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
	RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
	RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
	RD_RFS1 = 0x00000001,
};
#define RDF1ST	RD_RFP1
#define RDFEND	RD_RFP0
#define RD_RFP	(RD_RFP1|RD_RFP0)

/* FCFTR */
enum FCFTR_BIT {
	FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
	FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
	FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
};
#define DEFAULT_FIFO_F_D_RFF	(FCFTR_RFF2 | FCFTR_RFF1 | FCFTR_RFF0)
#define DEFAULT_FIFO_F_D_RFD	(FCFTR_RFD2 | FCFTR_RFD1 | FCFTR_RFD0)

/* Transmit descriptor bit */
enum TD_STS_BIT {
	TD_TACT = 0x80000000, TD_TDLE = 0x40000000,
	TD_TFP1 = 0x20000000, TD_TFP0 = 0x10000000,
	TD_TFE  = 0x08000000, TD_TWBI = 0x04000000,
};
#define TDF1ST	TD_TFP1
#define TDFEND	TD_TFP0
#define TD_TFP	(TD_TFP1|TD_TFP0)

/* RMCR */
enum RMCR_BIT {
	RMCR_RNC = 0x00000001,
};

/* ECMR */
enum FELIC_MODE_BIT {
	ECMR_TRCCM = 0x04000000, ECMR_RCSC = 0x00800000,
	ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
	ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
	ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
	ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
	ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
	ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
};

/* ECSR */
enum ECSR_STATUS_BIT {
	ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
	ECSR_LCHNG = 0x04,
	ECSR_MPD = 0x02, ECSR_ICD = 0x01,
};

#define DEFAULT_ECSR_INIT	(ECSR_BRCRX | ECSR_PSRTO | ECSR_LCHNG | \
				 ECSR_ICD | ECSIPR_MPDIP)

/* ECSIPR */
enum ECSIPR_STATUS_MASK_BIT {
	ECSIPR_BRCRXIP = 0x20, ECSIPR_PSRTOIP = 0x10,
	ECSIPR_LCHNGIP = 0x04,
	ECSIPR_MPDIP = 0x02, ECSIPR_ICDIP = 0x01,
};

#define DEFAULT_ECSIPR_INIT	(ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | \
				 ECSIPR_LCHNGIP | ECSIPR_ICDIP | ECSIPR_MPDIP)

/* APR */
enum APR_BIT {
	APR_AP = 0x00000001,
};

/* MPR */
enum MPR_BIT {
	MPR_MP = 0x00000001,
};

/* TRSCER */
enum DESC_I_BIT {
	DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
	DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
	DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
	DESC_I_RINT1 = 0x0001,
};

#define DEFAULT_TRSCER_ERR_MASK (DESC_I_RINT8 | DESC_I_RINT5 | DESC_I_TINT2)

/* RPADIR */
enum RPADIR_BIT {
	RPADIR_PADS1 = 0x20000, RPADIR_PADS0 = 0x10000,
	RPADIR_PADR = 0x0003f,
};

/* FDR */
#define DEFAULT_FDR_INIT	0x00000707

/* ARSTR */
enum ARSTR_BIT { ARSTR_ARSTR = 0x00000001, };

/* TSU_FWEN0 */
enum TSU_FWEN0_BIT {
	TSU_FWEN0_0 = 0x00000001,
};

/* TSU_ADSBSY */
enum TSU_ADSBSY_BIT {
	TSU_ADSBSY_0 = 0x00000001,
};

/* TSU_TEN */
enum TSU_TEN_BIT {
	TSU_TEN_0 = 0x80000000,
};

/* TSU_FWSL0 */
enum TSU_FWSL0_BIT {
	TSU_FWSL0_FW50 = 0x1000, TSU_FWSL0_FW40 = 0x0800,
	TSU_FWSL0_FW30 = 0x0400, TSU_FWSL0_FW20 = 0x0200,
	TSU_FWSL0_FW10 = 0x0100, TSU_FWSL0_RMSA0 = 0x0010,
};

/* TSU_FWSLC */
enum TSU_FWSLC_BIT {
	TSU_FWSLC_POSTENU = 0x2000, TSU_FWSLC_POSTENL = 0x1000,
	TSU_FWSLC_CAMSEL03 = 0x0080, TSU_FWSLC_CAMSEL02 = 0x0040,
	TSU_FWSLC_CAMSEL01 = 0x0020, TSU_FWSLC_CAMSEL00 = 0x0010,
	TSU_FWSLC_CAMSEL13 = 0x0008, TSU_FWSLC_CAMSEL12 = 0x0004,
	TSU_FWSLC_CAMSEL11 = 0x0002, TSU_FWSLC_CAMSEL10 = 0x0001,
};

/* TSU_VTAGn */
#define TSU_VTAG_ENABLE		0x80000000
#define TSU_VTAG_VID_MASK	0x00000fff

/* The sh ether Tx buffer descriptors.
 * This structure should be 20 bytes.
 */
struct sh_eth_txdesc {
	u32 status;		/* TD0 */
#if defined(__LITTLE_ENDIAN)
	u16 pad0;		/* TD1 */
	u16 buffer_length;	/* TD1 */
#else
	u16 buffer_length;	/* TD1 */
	u16 pad0;		/* TD1 */
#endif
	u32 addr;		/* TD2 */
	u32 pad1;		/* padding data */
} __aligned(2) __packed;

/* The sh ether Rx buffer descriptors.
 * This structure should be 20 bytes.
 */
struct sh_eth_rxdesc {
	u32 status;		/* RD0 */
#if defined(__LITTLE_ENDIAN)
	u16 frame_length;	/* RD1 */
	u16 buffer_length;	/* RD1 */
#else
	u16 buffer_length;	/* RD1 */
	u16 frame_length;	/* RD1 */
#endif
	u32 addr;		/* RD2 */
	u32 pad0;		/* padding data */
} __aligned(2) __packed;

/* This structure is used by each CPU dependency handling. */
struct sh_eth_cpu_data {
	/* optional functions */
	void (*chip_reset)(struct net_device *ndev);
	void (*set_duplex)(struct net_device *ndev);
	void (*set_rate)(struct net_device *ndev);

	/* mandatory initialize value */
	int register_type;
	u32 eesipr_value;

	/* optional initialize value */
	u32 ecsr_value;
	u32 ecsipr_value;
	u32 fdr_value;
	u32 fcftr_value;
	u32 rpadir_value;

	/* interrupt checking mask */
	u32 tx_check;
	u32 eesr_err_check;

	/* Error mask */
	u32 trscer_err_mask;

	/* hardware features */
	unsigned long irq_flags; /* IRQ configuration flags */
	unsigned no_psr:1;	/* EtherC DO NOT have PSR */
	unsigned apr:1;		/* EtherC have APR */
	unsigned mpr:1;		/* EtherC have MPR */
	unsigned tpauser:1;	/* EtherC have TPAUSER */
	unsigned bculr:1;	/* EtherC have BCULR */
	unsigned tsu:1;		/* EtherC have TSU */
	unsigned hw_swap:1;	/* E-DMAC have DE bit in EDMR */
	unsigned rpadir:1;	/* E-DMAC have RPADIR */
	unsigned no_trimd:1;	/* E-DMAC DO NOT have TRIMD */
	unsigned no_ade:1;	/* E-DMAC DO NOT have ADE bit in EESR */
	unsigned hw_crc:1;	/* E-DMAC have CSMR */
	unsigned select_mii:1;	/* EtherC have RMII_MII (MII select register) */
	unsigned shift_rd0:1;	/* shift Rx descriptor word 0 right by 16 */
	unsigned rmiimode:1;	/* EtherC has RMIIMODE register */
	unsigned rtrate:1;	/* EtherC has RTRATE register */
};

struct sh_eth_private {
	struct platform_device *pdev;
	struct sh_eth_cpu_data *cd;
	const u16 *reg_offset;
	void __iomem *addr;
	void __iomem *tsu_addr;
	u32 num_rx_ring;
	u32 num_tx_ring;
	dma_addr_t rx_desc_dma;
	dma_addr_t tx_desc_dma;
	struct sh_eth_rxdesc *rx_ring;
	struct sh_eth_txdesc *tx_ring;
	struct sk_buff **rx_skbuff;
	struct sk_buff **tx_skbuff;
	spinlock_t lock;		/* Register access lock */
	u32 cur_rx, dirty_rx;		/* Producer/consumer ring indices */
	u32 cur_tx, dirty_tx;
	u32 rx_buf_sz;			/* Based on MTU+slack. */
	int edmac_endian;
	struct napi_struct napi;
	bool irq_enabled;
	/* MII transceiver section. */
	u32 phy_id;			/* PHY ID */
	struct mii_bus *mii_bus;	/* MDIO bus control */
	struct phy_device *phydev;	/* PHY device control */
	int link;
	phy_interface_t phy_interface;
	int msg_enable;
	int speed;
	int duplex;
	int port;			/* for TSU */
	int vlan_num_ids;		/* for VLAN tag filter */

	unsigned no_ether_link:1;
	unsigned ether_link_active_low:1;
	unsigned is_opened:1;
};

static inline void sh_eth_soft_swap(char *src, int len)
{
#ifdef __LITTLE_ENDIAN__
	u32 *p = (u32 *)src;
	u32 *maxp;
	maxp = p + ((len + sizeof(u32) - 1) / sizeof(u32));

	for (; p < maxp; p++)
		*p = swab32(*p);
#endif
}

static inline void *sh_eth_tsu_get_offset(struct sh_eth_private *mdp,
					  int enum_index)
{
	return mdp->tsu_addr + mdp->reg_offset[enum_index];
}

static inline void sh_eth_tsu_write(struct sh_eth_private *mdp, u32 data,
				    int enum_index)
{
	iowrite32(data, mdp->tsu_addr + mdp->reg_offset[enum_index]);
}

static inline u32 sh_eth_tsu_read(struct sh_eth_private *mdp, int enum_index)
{
	return ioread32(mdp->tsu_addr + mdp->reg_offset[enum_index]);
}

#endif	/* #ifndef __SH_ETH_H__ */
Commit	Line	Data
128296fc	1	/* SuperH Ethernet device driver
86a74ff2	2	*
f0e81fec NI	3	* Copyright (C) 2006-2012 Nobuhiro Iwamatsu
f0e81fec NI	4	* Copyright (C) 2008-2012 Renesas Solutions Corp.
86a74ff2 NI	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms and conditions of the GNU General Public License,
	8	* version 2, as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
86a74ff2 NI	14	*
	15	* The full GNU General Public License is included in this distribution in
	16	* the file called "COPYING".
	17	*/
	18
	19	#ifndef __SH_ETH_H__
	20	#define __SH_ETH_H__
	21
86a74ff2 NI	22	#define CARDNAME "sh-eth"
86a74ff2 NI	23	#define TX_TIMEOUT (5*HZ)
b0ca2a21 NI	24	#define TX_RING_SIZE 64 /* Tx ring size */
b0ca2a21 NI	25	#define RX_RING_SIZE 64 /* Rx ring size */
525b8075 YS	26	#define TX_RING_MIN 64
	27	#define RX_RING_MIN 64
	28	#define TX_RING_MAX 1024
	29	#define RX_RING_MAX 1024
730c8c69	30	#define PKT_BUF_SZ 1538
6743fe6d YS	31	#define SH_ETH_TSU_TIMEOUT_MS 500
6743fe6d YS	32	#define SH_ETH_TSU_CAM_ENTRIES 32
86a74ff2	33
4a55530f	34	enum {
6b4b4fea BH	35	/* IMPORTANT: To keep ethtool register dump working, add new
	36	* register names immediately before SH_ETH_MAX_REGISTER_OFFSET.
	37	*/
	38
4a55530f YS	39	/* E-DMAC registers */
	40	EDSR = 0,
	41	EDMR,
	42	EDTRR,
	43	EDRRR,
	44	EESR,
	45	EESIPR,
	46	TDLAR,
	47	TDFAR,
	48	TDFXR,
	49	TDFFR,
	50	RDLAR,
	51	RDFAR,
	52	RDFXR,
	53	RDFFR,
	54	TRSCER,
	55	RMFCR,
	56	TFTR,
	57	FDR,
	58	RMCR,
	59	EDOCR,
	60	TFUCR,
	61	RFOCR,
55754f19	62	RMIIMODE,
4a55530f YS	63	FCFTR,
	64	RPADIR,
	65	TRIMD,
	66	RBWAR,
	67	TBRAR,
	68
	69	/* Ether registers */
	70	ECMR,
	71	ECSR,
	72	ECSIPR,
	73	PIR,
	74	PSR,
	75	RDMLR,
	76	PIPR,
	77	RFLR,
	78	IPGR,
	79	APR,
	80	MPR,
	81	PFTCR,
	82	PFRCR,
	83	RFCR,
	84	RFCF,
	85	TPAUSER,
	86	TPAUSECR,
	87	BCFR,
	88	BCFRR,
	89	GECMR,
	90	BCULR,
	91	MAHR,
	92	MALR,
	93	TROCR,
	94	CDCR,
	95	LCCR,
	96	CNDCR,
	97	CEFCR,
	98	FRECR,
	99	TSFRCR,
	100	TLFRCR,
	101	CERCR,
	102	CEECR,
	103	MAFCR,
	104	RTRATE,
f0e81fec NI	105	CSMR,
f0e81fec NI	106	RMII_MII,
4a55530f YS	107
	108	/* TSU Absolute address */
	109	ARSTR,
	110	TSU_CTRST,
	111	TSU_FWEN0,
	112	TSU_FWEN1,
	113	TSU_FCM,
	114	TSU_BSYSL0,
	115	TSU_BSYSL1,
	116	TSU_PRISL0,
	117	TSU_PRISL1,
	118	TSU_FWSL0,
	119	TSU_FWSL1,
	120	TSU_FWSLC,
	121	TSU_QTAG0,
	122	TSU_QTAG1,
	123	TSU_QTAGM0,
	124	TSU_QTAGM1,
	125	TSU_FWSR,
	126	TSU_FWINMK,
	127	TSU_ADQT0,
	128	TSU_ADQT1,
	129	TSU_VTAG0,
	130	TSU_VTAG1,
	131	TSU_ADSBSY,
	132	TSU_TEN,
	133	TSU_POST1,
	134	TSU_POST2,
	135	TSU_POST3,
	136	TSU_POST4,
	137	TSU_ADRH0,
6b4b4fea	138	/* TSU_ADR{H,L}{0..31} are assumed to be contiguous */
4a55530f YS	139
	140	TXNLCR0,
	141	TXALCR0,
	142	RXNLCR0,
	143	RXALCR0,
	144	FWNLCR0,
	145	FWALCR0,
	146	TXNLCR1,
	147	TXALCR1,
	148	RXNLCR1,
	149	RXALCR1,
	150	FWNLCR1,
	151	FWALCR1,
	152
	153	/* This value must be written at last. */
	154	SH_ETH_MAX_REGISTER_OFFSET,
	155	};
	156
8d3214c4 SS	157	enum {
8d3214c4 SS	158	SH_ETH_REG_GIGABIT,
db893473	159	SH_ETH_REG_FAST_RZ,
8d3214c4 SS	160	SH_ETH_REG_FAST_RCAR,
	161	SH_ETH_REG_FAST_SH4,
	162	SH_ETH_REG_FAST_SH3_SH2
	163	};
	164
380af9e3	165	/* Driver's parameters */
73a0d907	166	#if defined(CONFIG_CPU_SH4) \|\| defined(CONFIG_ARCH_SHMOBILE)
4d6a949c	167	#define SH_ETH_RX_ALIGN 32
380af9e3	168	#else
4d6a949c	169	#define SH_ETH_RX_ALIGN 2
380af9e3 YS	170	#endif
380af9e3 YS	171
128296fc	172	/* Register's bits
b0ca2a21	173	*/
db893473	174	/* EDSR : sh7734, sh7757, sh7763, r8a7740, and r7s72100 only */
b0ca2a21 NI	175	enum EDSR_BIT {
	176	EDSR_ENT = 0x01, EDSR_ENR = 0x02,
	177	};
	178	#define EDSR_ENALL (EDSR_ENT\|EDSR_ENR)
	179
41d5ffeb	180	/* GECMR : sh7734, sh7763 and r8a7740 only */
b0ca2a21 NI	181	enum GECMR_BIT {
	182	GECMR_10 = 0x0, GECMR_100 = 0x04, GECMR_1000 = 0x01,
	183	};
86a74ff2 NI	184
	185	/* EDMR */
	186	enum DMAC_M_BIT {
380af9e3	187	EDMR_EL = 0x40, /* Litte endian */
b0ca2a21	188	EDMR_DL1 = 0x20, EDMR_DL0 = 0x10,
c5ed5368 YS	189	EDMR_SRST_GETHER = 0x03,
c5ed5368 YS	190	EDMR_SRST_ETHER = 0x01,
86a74ff2 NI	191	};
	192
	193	/* EDTRR */
	194	enum DMAC_T_BIT {
c5ed5368 YS	195	EDTRR_TRNS_GETHER = 0x03,
c5ed5368 YS	196	EDTRR_TRNS_ETHER = 0x01,
86a74ff2 NI	197	};
86a74ff2 NI	198
128296fc	199	/* EDRRR */
86a74ff2 NI	200	enum EDRRR_R_BIT {
	201	EDRRR_R = 0x01,
	202	};
	203
	204	/* TPAUSER */
	205	enum TPAUSER_BIT {
	206	TPAUSER_TPAUSE = 0x0000ffff,
	207	TPAUSER_UNLIMITED = 0,
	208	};
	209
	210	/* BCFR */
	211	enum BCFR_BIT {
	212	BCFR_RPAUSE = 0x0000ffff,
	213	BCFR_UNLIMITED = 0,
	214	};
	215
	216	/* PIR */
	217	enum PIR_BIT {
	218	PIR_MDI = 0x08, PIR_MDO = 0x04, PIR_MMD = 0x02, PIR_MDC = 0x01,
	219	};
	220
	221	/* PSR */
	222	enum PHY_STATUS_BIT { PHY_ST_LINK = 0x01, };
	223
	224	/* EESR */
	225	enum EESR_BIT {
380af9e3 YS	226	EESR_TWB1 = 0x80000000,
	227	EESR_TWB = 0x40000000, /* same as TWB0 */
	228	EESR_TC1 = 0x20000000,
	229	EESR_TUC = 0x10000000,
	230	EESR_ROC = 0x08000000,
	231	EESR_TABT = 0x04000000,
	232	EESR_RABT = 0x02000000,
	233	EESR_RFRMER = 0x01000000, /* same as RFCOF */
	234	EESR_ADE = 0x00800000,
	235	EESR_ECI = 0x00400000,
	236	EESR_FTC = 0x00200000, /* same as TC or TC0 */
	237	EESR_TDE = 0x00100000,
	238	EESR_TFE = 0x00080000, /* same as TFUF */
	239	EESR_FRC = 0x00040000, /* same as FR */
	240	EESR_RDE = 0x00020000,
	241	EESR_RFE = 0x00010000,
	242	EESR_CND = 0x00000800,
	243	EESR_DLC = 0x00000400,
	244	EESR_CD = 0x00000200,
	245	EESR_RTO = 0x00000100,
	246	EESR_RMAF = 0x00000080,
	247	EESR_CEEF = 0x00000040,
	248	EESR_CELF = 0x00000020,
	249	EESR_RRF = 0x00000010,
	250	EESR_RTLF = 0x00000008,
	251	EESR_RTSF = 0x00000004,
	252	EESR_PRE = 0x00000002,
	253	EESR_CERF = 0x00000001,
	254	};
	255
ea7d69e7 SS	256	#define EESR_RX_CHECK (EESR_FRC \| /* Frame recv */ \
	257	EESR_RMAF \| /* Multicast address recv */ \
	258	EESR_RRF \| /* Bit frame recv */ \
	259	EESR_RTLF \| /* Long frame recv */ \
	260	EESR_RTSF \| /* Short frame recv */ \
	261	EESR_PRE \| /* PHY-LSI recv error */ \
	262	EESR_CERF) /* Recv frame CRC error */
	263
380af9e3 YS	264	#define DEFAULT_TX_CHECK (EESR_FTC \| EESR_CND \| EESR_DLC \| EESR_CD \| \
380af9e3 YS	265	EESR_RTO)
ca8c3585	266	#define DEFAULT_EESR_ERR_CHECK (EESR_TWB \| EESR_TABT \| EESR_RABT \| EESR_RFE \| \
380af9e3 YS	267	EESR_RDE \| EESR_RFRMER \| EESR_ADE \| \
380af9e3 YS	268	EESR_TFE \| EESR_TDE \| EESR_ECI)
86a74ff2 NI	269
	270	/* EESIPR */
	271	enum DMAC_IM_BIT {
	272	DMAC_M_TWB = 0x40000000, DMAC_M_TABT = 0x04000000,
	273	DMAC_M_RABT = 0x02000000,
	274	DMAC_M_RFRMER = 0x01000000, DMAC_M_ADF = 0x00800000,
	275	DMAC_M_ECI = 0x00400000, DMAC_M_FTC = 0x00200000,
	276	DMAC_M_TDE = 0x00100000, DMAC_M_TFE = 0x00080000,
	277	DMAC_M_FRC = 0x00040000, DMAC_M_RDE = 0x00020000,
	278	DMAC_M_RFE = 0x00010000, DMAC_M_TINT4 = 0x00000800,
	279	DMAC_M_TINT3 = 0x00000400, DMAC_M_TINT2 = 0x00000200,
	280	DMAC_M_TINT1 = 0x00000100, DMAC_M_RINT8 = 0x00000080,
	281	DMAC_M_RINT5 = 0x00000010, DMAC_M_RINT4 = 0x00000008,
	282	DMAC_M_RINT3 = 0x00000004, DMAC_M_RINT2 = 0x00000002,
	283	DMAC_M_RINT1 = 0x00000001,
	284	};
	285
	286	/* Receive descriptor bit */
	287	enum RD_STS_BIT {
c238041f	288	RD_RACT = 0x80000000, RD_RDLE = 0x40000000,
b0ca2a21	289	RD_RFP1 = 0x20000000, RD_RFP0 = 0x10000000,
86a74ff2 NI	290	RD_RFE = 0x08000000, RD_RFS10 = 0x00000200,
	291	RD_RFS9 = 0x00000100, RD_RFS8 = 0x00000080,
	292	RD_RFS7 = 0x00000040, RD_RFS6 = 0x00000020,
	293	RD_RFS5 = 0x00000010, RD_RFS4 = 0x00000008,
	294	RD_RFS3 = 0x00000004, RD_RFS2 = 0x00000002,
	295	RD_RFS1 = 0x00000001,
	296	};
b0ca2a21 NI	297	#define RDF1ST RD_RFP1
	298	#define RDFEND RD_RFP0
	299	#define RD_RFP (RD_RFP1\|RD_RFP0)
86a74ff2 NI	300
	301	/* FCFTR */
	302	enum FCFTR_BIT {
	303	FCFTR_RFF2 = 0x00040000, FCFTR_RFF1 = 0x00020000,
	304	FCFTR_RFF0 = 0x00010000, FCFTR_RFD2 = 0x00000004,
	305	FCFTR_RFD1 = 0x00000002, FCFTR_RFD0 = 0x00000001,
	306	};
380af9e3 YS	307	#define DEFAULT_FIFO_F_D_RFF (FCFTR_RFF2 \| FCFTR_RFF1 \| FCFTR_RFF0)
380af9e3 YS	308	#define DEFAULT_FIFO_F_D_RFD (FCFTR_RFD2 \| FCFTR_RFD1 \| FCFTR_RFD0)
86a74ff2	309
c8bbe37a	310	/* Transmit descriptor bit */
86a74ff2	311	enum TD_STS_BIT {
c8bbe37a SS	312	TD_TACT = 0x80000000, TD_TDLE = 0x40000000,
	313	TD_TFP1 = 0x20000000, TD_TFP0 = 0x10000000,
	314	TD_TFE = 0x08000000, TD_TWBI = 0x04000000,
86a74ff2 NI	315	};
	316	#define TDF1ST TD_TFP1
	317	#define TDFEND TD_TFP0
	318	#define TD_TFP (TD_TFP1\|TD_TFP0)
	319
	320	/* RMCR */
305a3388 SS	321	enum RMCR_BIT {
	322	RMCR_RNC = 0x00000001,
	323	};
380af9e3	324
86a74ff2 NI	325	/* ECMR */
86a74ff2 NI	326	enum FELIC_MODE_BIT {
b0ca2a21 NI	327	ECMR_TRCCM = 0x04000000, ECMR_RCSC = 0x00800000,
b0ca2a21 NI	328	ECMR_DPAD = 0x00200000, ECMR_RZPF = 0x00100000,
86a74ff2 NI	329	ECMR_ZPF = 0x00080000, ECMR_PFR = 0x00040000, ECMR_RXF = 0x00020000,
	330	ECMR_TXF = 0x00010000, ECMR_MCT = 0x00002000, ECMR_PRCEF = 0x00001000,
	331	ECMR_PMDE = 0x00000200, ECMR_RE = 0x00000040, ECMR_TE = 0x00000020,
65ac8851	332	ECMR_RTM = 0x00000010, ECMR_ILB = 0x00000008, ECMR_ELB = 0x00000004,
380af9e3	333	ECMR_DM = 0x00000002, ECMR_PRM = 0x00000001,
86a74ff2 NI	334	};
	335
	336	/* ECSR */
	337	enum ECSR_STATUS_BIT {
b0ca2a21	338	ECSR_BRCRX = 0x20, ECSR_PSRTO = 0x10,
b0ca2a21	339	ECSR_LCHNG = 0x04,
86a74ff2 NI	340	ECSR_MPD = 0x02, ECSR_ICD = 0x01,
	341	};
	342
380af9e3 YS	343	#define DEFAULT_ECSR_INIT (ECSR_BRCRX \| ECSR_PSRTO \| ECSR_LCHNG \| \
380af9e3 YS	344	ECSR_ICD \| ECSIPR_MPDIP)
b0ca2a21	345
86a74ff2 NI	346	/* ECSIPR */
86a74ff2 NI	347	enum ECSIPR_STATUS_MASK_BIT {
b0ca2a21	348	ECSIPR_BRCRXIP = 0x20, ECSIPR_PSRTOIP = 0x10,
b0ca2a21	349	ECSIPR_LCHNGIP = 0x04,
86a74ff2 NI	350	ECSIPR_MPDIP = 0x02, ECSIPR_ICDIP = 0x01,
	351	};
	352
380af9e3 YS	353	#define DEFAULT_ECSIPR_INIT (ECSIPR_BRCRXIP \| ECSIPR_PSRTOIP \| \
380af9e3 YS	354	ECSIPR_LCHNGIP \| ECSIPR_ICDIP \| ECSIPR_MPDIP)
b0ca2a21	355
86a74ff2 NI	356	/* APR */
	357	enum APR_BIT {
	358	APR_AP = 0x00000001,
	359	};
	360
	361	/* MPR */
	362	enum MPR_BIT {
	363	MPR_MP = 0x00000001,
	364	};
	365
	366	/* TRSCER */
	367	enum DESC_I_BIT {
	368	DESC_I_TINT4 = 0x0800, DESC_I_TINT3 = 0x0400, DESC_I_TINT2 = 0x0200,
	369	DESC_I_TINT1 = 0x0100, DESC_I_RINT8 = 0x0080, DESC_I_RINT5 = 0x0010,
	370	DESC_I_RINT4 = 0x0008, DESC_I_RINT3 = 0x0004, DESC_I_RINT2 = 0x0002,
	371	DESC_I_RINT1 = 0x0001,
	372	};
	373
b284fbe3 NI	374	#define DEFAULT_TRSCER_ERR_MASK (DESC_I_RINT8 \| DESC_I_RINT5 \| DESC_I_TINT2)
b284fbe3 NI	375
86a74ff2 NI	376	/* RPADIR */
	377	enum RPADIR_BIT {
	378	RPADIR_PADS1 = 0x20000, RPADIR_PADS0 = 0x10000,
	379	RPADIR_PADR = 0x0003f,
	380	};
	381
	382	/* FDR */
380af9e3 YS	383	#define DEFAULT_FDR_INIT 0x00000707
380af9e3 YS	384
86a74ff2 NI	385	/* ARSTR */
	386	enum ARSTR_BIT { ARSTR_ARSTR = 0x00000001, };
	387
	388	/* TSU_FWEN0 */
	389	enum TSU_FWEN0_BIT {
	390	TSU_FWEN0_0 = 0x00000001,
	391	};
	392
	393	/* TSU_ADSBSY */
	394	enum TSU_ADSBSY_BIT {
	395	TSU_ADSBSY_0 = 0x00000001,
	396	};
	397
	398	/* TSU_TEN */
	399	enum TSU_TEN_BIT {
	400	TSU_TEN_0 = 0x80000000,
	401	};
	402
	403	/* TSU_FWSL0 */
	404	enum TSU_FWSL0_BIT {
	405	TSU_FWSL0_FW50 = 0x1000, TSU_FWSL0_FW40 = 0x0800,
	406	TSU_FWSL0_FW30 = 0x0400, TSU_FWSL0_FW20 = 0x0200,
	407	TSU_FWSL0_FW10 = 0x0100, TSU_FWSL0_RMSA0 = 0x0010,
	408	};
	409
	410	/* TSU_FWSLC */
	411	enum TSU_FWSLC_BIT {
	412	TSU_FWSLC_POSTENU = 0x2000, TSU_FWSLC_POSTENL = 0x1000,
	413	TSU_FWSLC_CAMSEL03 = 0x0080, TSU_FWSLC_CAMSEL02 = 0x0040,
	414	TSU_FWSLC_CAMSEL01 = 0x0020, TSU_FWSLC_CAMSEL00 = 0x0010,
	415	TSU_FWSLC_CAMSEL13 = 0x0008, TSU_FWSLC_CAMSEL12 = 0x0004,
	416	TSU_FWSLC_CAMSEL11 = 0x0002, TSU_FWSLC_CAMSEL10 = 0x0001,
	417	};
	418
71cc7c37 YS	419	/* TSU_VTAGn */
	420	#define TSU_VTAG_ENABLE 0x80000000
	421	#define TSU_VTAG_VID_MASK 0x00000fff
	422
128296fc	423	/* The sh ether Tx buffer descriptors.
86a74ff2 NI	424	* This structure should be 20 bytes.
	425	*/
	426	struct sh_eth_txdesc {
	427	u32 status; /* TD0 */
10b9194f	428	#if defined(__LITTLE_ENDIAN)
86a74ff2 NI	429	u16 pad0; /* TD1 */
	430	u16 buffer_length; /* TD1 */
	431	#else
	432	u16 buffer_length; /* TD1 */
	433	u16 pad0; /* TD1 */
	434	#endif
	435	u32 addr; /* TD2 */
	436	u32 pad1; /* padding data */
128296fc	437	} __aligned(2) __packed;
86a74ff2	438
128296fc	439	/* The sh ether Rx buffer descriptors.
86a74ff2 NI	440	* This structure should be 20 bytes.
	441	*/
	442	struct sh_eth_rxdesc {
	443	u32 status; /* RD0 */
10b9194f	444	#if defined(__LITTLE_ENDIAN)
86a74ff2 NI	445	u16 frame_length; /* RD1 */
	446	u16 buffer_length; /* RD1 */
	447	#else
	448	u16 buffer_length; /* RD1 */
	449	u16 frame_length; /* RD1 */
	450	#endif
	451	u32 addr; /* RD2 */
	452	u32 pad0; /* padding data */
128296fc	453	} __aligned(2) __packed;
86a74ff2	454
380af9e3 YS	455	/* This structure is used by each CPU dependency handling. */
	456	struct sh_eth_cpu_data {
	457	/* optional functions */
	458	void (chip_reset)(struct net_device ndev);
	459	void (set_duplex)(struct net_device ndev);
	460	void (set_rate)(struct net_device ndev);
	461
	462	/* mandatory initialize value */
a3153d8c	463	int register_type;
0799c2d6	464	u32 eesipr_value;
380af9e3 YS	465
380af9e3 YS	466	/* optional initialize value */
0799c2d6 GU	467	u32 ecsr_value;
	468	u32 ecsipr_value;
	469	u32 fdr_value;
	470	u32 fcftr_value;
	471	u32 rpadir_value;
380af9e3 YS	472
380af9e3 YS	473	/* interrupt checking mask */
0799c2d6 GU	474	u32 tx_check;
0799c2d6 GU	475	u32 eesr_err_check;
380af9e3	476
b284fbe3	477	/* Error mask */
0799c2d6	478	u32 trscer_err_mask;
b284fbe3	479
380af9e3	480	/* hardware features */
128296fc SS	481	unsigned long irq_flags; /* IRQ configuration flags */
	482	unsigned no_psr:1; /* EtherC DO NOT have PSR */
	483	unsigned apr:1; /* EtherC have APR */
	484	unsigned mpr:1; /* EtherC have MPR */
	485	unsigned tpauser:1; /* EtherC have TPAUSER */
	486	unsigned bculr:1; /* EtherC have BCULR */
	487	unsigned tsu:1; /* EtherC have TSU */
	488	unsigned hw_swap:1; /* E-DMAC have DE bit in EDMR */
	489	unsigned rpadir:1; /* E-DMAC have RPADIR */
	490	unsigned no_trimd:1; /* E-DMAC DO NOT have TRIMD */
380af9e3	491	unsigned no_ade:1; /* E-DMAC DO NOT have ADE bit in EESR */
f0e81fec	492	unsigned hw_crc:1; /* E-DMAC have CSMR */
5e7a76be	493	unsigned select_mii:1; /* EtherC have RMII_MII (MII select register) */
ac8025a6	494	unsigned shift_rd0:1; /* shift Rx descriptor word 0 right by 16 */
55754f19	495	unsigned rmiimode:1; /* EtherC has RMIIMODE register */
6b4b4fea	496	unsigned rtrate:1; /* EtherC has RTRATE register */
380af9e3 YS	497	};
380af9e3 YS	498
86a74ff2	499	struct sh_eth_private {
bcd5149d	500	struct platform_device *pdev;
380af9e3	501	struct sh_eth_cpu_data *cd;
4a55530f	502	const u16 *reg_offset;
ae70644d	503	void __iomem *addr;
4a55530f	504	void __iomem *tsu_addr;
525b8075 YS	505	u32 num_rx_ring;
525b8075 YS	506	u32 num_tx_ring;
86a74ff2 NI	507	dma_addr_t rx_desc_dma;
	508	dma_addr_t tx_desc_dma;
	509	struct sh_eth_rxdesc *rx_ring;
	510	struct sh_eth_txdesc *tx_ring;
	511	struct sk_buff **rx_skbuff;
	512	struct sk_buff **tx_skbuff;
128296fc SS	513	spinlock_t lock; /* Register access lock */
128296fc SS	514	u32 cur_rx, dirty_rx; /* Producer/consumer ring indices */
86a74ff2	515	u32 cur_tx, dirty_tx;
128296fc	516	u32 rx_buf_sz; /* Based on MTU+slack. */
71557a37	517	int edmac_endian;
3719109d	518	struct napi_struct napi;
283e38db	519	bool irq_enabled;
86a74ff2	520	/* MII transceiver section. */
128296fc	521	u32 phy_id; /* PHY ID */
86a74ff2 NI	522	struct mii_bus mii_bus; / MDIO bus control */
86a74ff2 NI	523	struct phy_device phydev; / PHY device control */
3340d2aa	524	int link;
e47c9052	525	phy_interface_t phy_interface;
86a74ff2 NI	526	int msg_enable;
	527	int speed;
	528	int duplex;
128296fc SS	529	int port; /* for TSU */
128296fc SS	530	int vlan_num_ids; /* for VLAN tag filter */
4923576b YS	531
	532	unsigned no_ether_link:1;
	533	unsigned ether_link_active_low:1;
7fa2955f	534	unsigned is_opened:1;
86a74ff2 NI	535	};
86a74ff2 NI	536
380af9e3	537	static inline void sh_eth_soft_swap(char *src, int len)
86a74ff2 NI	538	{
	539	#ifdef __LITTLE_ENDIAN__
	540	u32 p = (u32 )src;
	541	u32 *maxp;
	542	maxp = p + ((len + sizeof(u32) - 1) / sizeof(u32));
	543
	544	for (; p < maxp; p++)
	545	p = swab32(p);
	546	#endif
	547	}
380af9e3	548
6743fe6d YS	549	static inline void sh_eth_tsu_get_offset(struct sh_eth_private mdp,
	550	int enum_index)
	551	{
	552	return mdp->tsu_addr + mdp->reg_offset[enum_index];
	553	}
	554
0799c2d6 GU	555	static inline void sh_eth_tsu_write(struct sh_eth_private *mdp, u32 data,
0799c2d6 GU	556	int enum_index)
4a55530f	557	{
ae70644d	558	iowrite32(data, mdp->tsu_addr + mdp->reg_offset[enum_index]);
4a55530f YS	559	}
4a55530f YS	560
0799c2d6	561	static inline u32 sh_eth_tsu_read(struct sh_eth_private *mdp, int enum_index)
4a55530f	562	{
ae70644d	563	return ioread32(mdp->tsu_addr + mdp->reg_offset[enum_index]);
4a55530f YS	564	}
4a55530f YS	565
380af9e3	566	#endif /* #ifndef __SH_ETH_H__ */