[mirror_ubuntu-bionic-kernel.git] / drivers / net / ethernet / freescale / fs_enet / fs_enet.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef FS_ENET_H
#define FS_ENET_H

#include <linux/mii.h>
#include <linux/netdevice.h>
#include <linux/types.h>
#include <linux/list.h>
#include <linux/phy.h>
#include <linux/dma-mapping.h>

#include <linux/fs_enet_pd.h>
#include <asm/fs_pd.h>

#ifdef CONFIG_CPM1
#include <asm/cpm1.h>
#endif

#if defined(CONFIG_FS_ENET_HAS_FEC)
#include <asm/cpm.h>

#if defined(CONFIG_FS_ENET_MPC5121_FEC)
/* MPC5121 FEC has different register layout */
struct fec {
	u32 fec_reserved0;
	u32 fec_ievent;			/* Interrupt event reg */
	u32 fec_imask;			/* Interrupt mask reg */
	u32 fec_reserved1;
	u32 fec_r_des_active;		/* Receive descriptor reg */
	u32 fec_x_des_active;		/* Transmit descriptor reg */
	u32 fec_reserved2[3];
	u32 fec_ecntrl;			/* Ethernet control reg */
	u32 fec_reserved3[6];
	u32 fec_mii_data;		/* MII manage frame reg */
	u32 fec_mii_speed;		/* MII speed control reg */
	u32 fec_reserved4[7];
	u32 fec_mib_ctrlstat;		/* MIB control/status reg */
	u32 fec_reserved5[7];
	u32 fec_r_cntrl;		/* Receive control reg */
	u32 fec_reserved6[15];
	u32 fec_x_cntrl;		/* Transmit Control reg */
	u32 fec_reserved7[7];
	u32 fec_addr_low;		/* Low 32bits MAC address */
	u32 fec_addr_high;		/* High 16bits MAC address */
	u32 fec_opd;			/* Opcode + Pause duration */
	u32 fec_reserved8[10];
	u32 fec_hash_table_high;	/* High 32bits hash table */
	u32 fec_hash_table_low;		/* Low 32bits hash table */
	u32 fec_grp_hash_table_high;	/* High 32bits hash table */
	u32 fec_grp_hash_table_low;	/* Low 32bits hash table */
	u32 fec_reserved9[7];
	u32 fec_x_wmrk;			/* FIFO transmit water mark */
	u32 fec_reserved10;
	u32 fec_r_bound;		/* FIFO receive bound reg */
	u32 fec_r_fstart;		/* FIFO receive start reg */
	u32 fec_reserved11[11];
	u32 fec_r_des_start;		/* Receive descriptor ring */
	u32 fec_x_des_start;		/* Transmit descriptor ring */
	u32 fec_r_buff_size;		/* Maximum receive buff size */
	u32 fec_reserved12[26];
	u32 fec_dma_control;		/* DMA Endian and other ctrl */
};
#endif

struct fec_info {
	struct fec __iomem *fecp;
	u32 mii_speed;
};
#endif

#ifdef CONFIG_CPM2
#include <asm/cpm2.h>
#endif

/* hw driver ops */
struct fs_ops {
	int (*setup_data)(struct net_device *dev);
	int (*allocate_bd)(struct net_device *dev);
	void (*free_bd)(struct net_device *dev);
	void (*cleanup_data)(struct net_device *dev);
	void (*set_multicast_list)(struct net_device *dev);
	void (*adjust_link)(struct net_device *dev);
	void (*restart)(struct net_device *dev);
	void (*stop)(struct net_device *dev);
	void (*napi_clear_event)(struct net_device *dev);
	void (*napi_enable)(struct net_device *dev);
	void (*napi_disable)(struct net_device *dev);
	void (*rx_bd_done)(struct net_device *dev);
	void (*tx_kickstart)(struct net_device *dev);
	u32 (*get_int_events)(struct net_device *dev);
	void (*clear_int_events)(struct net_device *dev, u32 int_events);
	void (*ev_error)(struct net_device *dev, u32 int_events);
	int (*get_regs)(struct net_device *dev, void *p, int *sizep);
	int (*get_regs_len)(struct net_device *dev);
	void (*tx_restart)(struct net_device *dev);
};

struct phy_info {
	unsigned int id;
	const char *name;
	void (*startup) (struct net_device * dev);
	void (*shutdown) (struct net_device * dev);
	void (*ack_int) (struct net_device * dev);
};

/* The FEC stores dest/src/type, data, and checksum for receive packets.
 */
#define MAX_MTU 1508		/* Allow fullsized pppoe packets over VLAN */
#define MIN_MTU 46		/* this is data size */
#define CRC_LEN 4

#define PKT_MAXBUF_SIZE		(MAX_MTU+ETH_HLEN+CRC_LEN)
#define PKT_MINBUF_SIZE		(MIN_MTU+ETH_HLEN+CRC_LEN)

/* Must be a multiple of 32 (to cover both FEC & FCC) */
#define PKT_MAXBLR_SIZE		((PKT_MAXBUF_SIZE + 31) & ~31)
/* This is needed so that invalidate_xxx wont invalidate too much */
#define ENET_RX_ALIGN  16
#define ENET_RX_FRSIZE L1_CACHE_ALIGN(PKT_MAXBUF_SIZE + ENET_RX_ALIGN - 1)

struct fs_enet_private {
	struct napi_struct napi;
	struct device *dev;	/* pointer back to the device (must be initialized first) */
	struct net_device *ndev;
	spinlock_t lock;	/* during all ops except TX pckt processing */
	spinlock_t tx_lock;	/* during fs_start_xmit and fs_tx         */
	struct fs_platform_info *fpi;
	const struct fs_ops *ops;
	int rx_ring, tx_ring;
	dma_addr_t ring_mem_addr;
	void __iomem *ring_base;
	struct sk_buff **rx_skbuff;
	struct sk_buff **tx_skbuff;
	char *mapped_as_page;
	cbd_t __iomem *rx_bd_base;	/* Address of Rx and Tx buffers.    */
	cbd_t __iomem *tx_bd_base;
	cbd_t __iomem *dirty_tx;	/* ring entries to be free()ed.     */
	cbd_t __iomem *cur_rx;
	cbd_t __iomem *cur_tx;
	int tx_free;
	struct timer_list phy_timer_list;
	const struct phy_info *phy;
	u32 msg_enable;
	struct mii_if_info mii_if;
	unsigned int last_mii_status;
	int interrupt;

	int oldduplex, oldspeed, oldlink;	/* current settings */

	/* event masks */
	u32 ev_napi;		/* mask of NAPI events */
	u32 ev;			/* event mask          */
	u32 ev_err;		/* error event mask       */

	u16 bd_rx_empty;	/* mask of BD rx empty	  */
	u16 bd_rx_err;		/* mask of BD rx errors   */

	union {
		struct {
			int idx;		/* FEC1 = 0, FEC2 = 1  */
			void __iomem *fecp;	/* hw registers        */
			u32 hthi, htlo;		/* state for multicast */
		} fec;

		struct {
			int idx;		/* FCC1-3 = 0-2	       */
			void __iomem *fccp;	/* hw registers	       */
			void __iomem *ep;	/* parameter ram       */
			void __iomem *fcccp;	/* hw registers cont.  */
			void __iomem *mem;	/* FCC DPRAM */
			u32 gaddrh, gaddrl;	/* group address       */
		} fcc;

		struct {
			int idx;		/* FEC1 = 0, FEC2 = 1  */
			void __iomem *sccp;	/* hw registers        */
			void __iomem *ep;	/* parameter ram       */
			u32 hthi, htlo;		/* state for multicast */
		} scc;

	};
};

/***************************************************************************/

void fs_init_bds(struct net_device *dev);
void fs_cleanup_bds(struct net_device *dev);

/***************************************************************************/

#define DRV_MODULE_NAME		"fs_enet"
#define PFX DRV_MODULE_NAME	": "
#define DRV_MODULE_VERSION	"1.1"
#define DRV_MODULE_RELDATE	"Sep 22, 2014"

/***************************************************************************/

int fs_enet_platform_init(void);
void fs_enet_platform_cleanup(void);

/***************************************************************************/
/* buffer descriptor access macros */

/* access macros */
#if defined(CONFIG_CPM1)
/* for a a CPM1 __raw_xxx's are sufficient */
#define __cbd_out32(addr, x)	__raw_writel(x, addr)
#define __cbd_out16(addr, x)	__raw_writew(x, addr)
#define __cbd_in32(addr)	__raw_readl(addr)
#define __cbd_in16(addr)	__raw_readw(addr)
#else
/* for others play it safe */
#define __cbd_out32(addr, x)	out_be32(addr, x)
#define __cbd_out16(addr, x)	out_be16(addr, x)
#define __cbd_in32(addr)	in_be32(addr)
#define __cbd_in16(addr)	in_be16(addr)
#endif

/* write */
#define CBDW_SC(_cbd, _sc) 		__cbd_out16(&(_cbd)->cbd_sc, (_sc))
#define CBDW_DATLEN(_cbd, _datlen)	__cbd_out16(&(_cbd)->cbd_datlen, (_datlen))
#define CBDW_BUFADDR(_cbd, _bufaddr)	__cbd_out32(&(_cbd)->cbd_bufaddr, (_bufaddr))

/* read */
#define CBDR_SC(_cbd) 			__cbd_in16(&(_cbd)->cbd_sc)
#define CBDR_DATLEN(_cbd)		__cbd_in16(&(_cbd)->cbd_datlen)
#define CBDR_BUFADDR(_cbd)		__cbd_in32(&(_cbd)->cbd_bufaddr)

/* set bits */
#define CBDS_SC(_cbd, _sc) 		CBDW_SC(_cbd, CBDR_SC(_cbd) | (_sc))

/* clear bits */
#define CBDC_SC(_cbd, _sc) 		CBDW_SC(_cbd, CBDR_SC(_cbd) & ~(_sc))

/*******************************************************************/

extern const struct fs_ops fs_fec_ops;
extern const struct fs_ops fs_fcc_ops;
extern const struct fs_ops fs_scc_ops;

/*******************************************************************/

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
48257c4f PA	2	#ifndef FS_ENET_H
	3	#define FS_ENET_H
	4
	5	#include <linux/mii.h>
	6	#include <linux/netdevice.h>
	7	#include <linux/types.h>
48257c4f	8	#include <linux/list.h>
5b4b8454	9	#include <linux/phy.h>
d6bd3a39	10	#include <linux/dma-mapping.h>
48257c4f PA	11
48257c4f PA	12	#include <linux/fs_enet_pd.h>
5427828e	13	#include <asm/fs_pd.h>
48257c4f	14
48257c4f	15	#ifdef CONFIG_CPM1
b5677d84	16	#include <asm/cpm1.h>
60ab4361 AG	17	#endif
	18
	19	#if defined(CONFIG_FS_ENET_HAS_FEC)
	20	#include <asm/cpm.h>
	21
	22	#if defined(CONFIG_FS_ENET_MPC5121_FEC)
	23	/* MPC5121 FEC has different register layout */
	24	struct fec {
	25	u32 fec_reserved0;
	26	u32 fec_ievent; /* Interrupt event reg */
	27	u32 fec_imask; /* Interrupt mask reg */
	28	u32 fec_reserved1;
	29	u32 fec_r_des_active; /* Receive descriptor reg */
	30	u32 fec_x_des_active; /* Transmit descriptor reg */
	31	u32 fec_reserved2[3];
	32	u32 fec_ecntrl; /* Ethernet control reg */
	33	u32 fec_reserved3[6];
	34	u32 fec_mii_data; /* MII manage frame reg */
	35	u32 fec_mii_speed; /* MII speed control reg */
	36	u32 fec_reserved4[7];
	37	u32 fec_mib_ctrlstat; /* MIB control/status reg */
	38	u32 fec_reserved5[7];
	39	u32 fec_r_cntrl; /* Receive control reg */
	40	u32 fec_reserved6[15];
	41	u32 fec_x_cntrl; /* Transmit Control reg */
	42	u32 fec_reserved7[7];
	43	u32 fec_addr_low; /* Low 32bits MAC address */
	44	u32 fec_addr_high; /* High 16bits MAC address */
	45	u32 fec_opd; /* Opcode + Pause duration */
	46	u32 fec_reserved8[10];
	47	u32 fec_hash_table_high; /* High 32bits hash table */
	48	u32 fec_hash_table_low; /* Low 32bits hash table */
	49	u32 fec_grp_hash_table_high; /* High 32bits hash table */
	50	u32 fec_grp_hash_table_low; /* Low 32bits hash table */
	51	u32 fec_reserved9[7];
	52	u32 fec_x_wmrk; /* FIFO transmit water mark */
	53	u32 fec_reserved10;
	54	u32 fec_r_bound; /* FIFO receive bound reg */
	55	u32 fec_r_fstart; /* FIFO receive start reg */
	56	u32 fec_reserved11[11];
	57	u32 fec_r_des_start; /* Receive descriptor ring */
	58	u32 fec_x_des_start; /* Transmit descriptor ring */
	59	u32 fec_r_buff_size; /* Maximum receive buff size */
	60	u32 fec_reserved12[26];
	61	u32 fec_dma_control; /* DMA Endian and other ctrl */
	62	};
	63	#endif
5b4b8454 VB	64
5b4b8454 VB	65	struct fec_info {
60ab4361	66	struct fec __iomem *fecp;
0fb300fa	67	u32 mii_speed;
5b4b8454	68	};
48257c4f PA	69	#endif
	70
	71	#ifdef CONFIG_CPM2
	72	#include <asm/cpm2.h>
	73	#endif
	74
	75	/* hw driver ops */
	76	struct fs_ops {
	77	int (setup_data)(struct net_device dev);
	78	int (allocate_bd)(struct net_device dev);
	79	void (free_bd)(struct net_device dev);
	80	void (cleanup_data)(struct net_device dev);
	81	void (set_multicast_list)(struct net_device dev);
5b4b8454	82	void (adjust_link)(struct net_device dev);
48257c4f PA	83	void (restart)(struct net_device dev);
48257c4f PA	84	void (stop)(struct net_device dev);
8572763a CL	85	void (napi_clear_event)(struct net_device dev);
	86	void (napi_enable)(struct net_device dev);
	87	void (napi_disable)(struct net_device dev);
48257c4f PA	88	void (rx_bd_done)(struct net_device dev);
	89	void (tx_kickstart)(struct net_device dev);
	90	u32 (get_int_events)(struct net_device dev);
	91	void (clear_int_events)(struct net_device dev, u32 int_events);
	92	void (ev_error)(struct net_device dev, u32 int_events);
	93	int (get_regs)(struct net_device dev, void p, int sizep);
	94	int (get_regs_len)(struct net_device dev);
	95	void (tx_restart)(struct net_device dev);
	96	};
	97
	98	struct phy_info {
	99	unsigned int id;
	100	const char *name;
	101	void (startup) (struct net_device dev);
	102	void (shutdown) (struct net_device dev);
	103	void (ack_int) (struct net_device dev);
	104	};
	105
	106	/* The FEC stores dest/src/type, data, and checksum for receive packets.
	107	*/
	108	#define MAX_MTU 1508 /* Allow fullsized pppoe packets over VLAN */
	109	#define MIN_MTU 46 /* this is data size */
	110	#define CRC_LEN 4
	111
	112	#define PKT_MAXBUF_SIZE (MAX_MTU+ETH_HLEN+CRC_LEN)
	113	#define PKT_MINBUF_SIZE (MIN_MTU+ETH_HLEN+CRC_LEN)
	114
	115	/* Must be a multiple of 32 (to cover both FEC & FCC) */
	116	#define PKT_MAXBLR_SIZE ((PKT_MAXBUF_SIZE + 31) & ~31)
	117	/* This is needed so that invalidate_xxx wont invalidate too much */
0d0d9c15 SW	118	#define ENET_RX_ALIGN 16
0d0d9c15 SW	119	#define ENET_RX_FRSIZE L1_CACHE_ALIGN(PKT_MAXBUF_SIZE + ENET_RX_ALIGN - 1)
48257c4f	120
48257c4f	121	struct fs_enet_private {
bea3348e	122	struct napi_struct napi;
48257c4f	123	struct device dev; / pointer back to the device (must be initialized first) */
f860f49e	124	struct net_device *ndev;
48257c4f PA	125	spinlock_t lock; /* during all ops except TX pckt processing */
48257c4f PA	126	spinlock_t tx_lock; /* during fs_start_xmit and fs_tx */
976de6a8	127	struct fs_platform_info *fpi;
48257c4f PA	128	const struct fs_ops *ops;
	129	int rx_ring, tx_ring;
	130	dma_addr_t ring_mem_addr;
31a5bb04	131	void __iomem *ring_base;
48257c4f PA	132	struct sk_buff **rx_skbuff;
48257c4f PA	133	struct sk_buff **tx_skbuff;
4fc9b87b	134	char *mapped_as_page;
31a5bb04 SW	135	cbd_t __iomem rx_bd_base; / Address of Rx and Tx buffers. */
	136	cbd_t __iomem *tx_bd_base;
	137	cbd_t __iomem dirty_tx; / ring entries to be free()ed. */
	138	cbd_t __iomem *cur_rx;
	139	cbd_t __iomem *cur_tx;
48257c4f	140	int tx_free;
48257c4f PA	141	struct timer_list phy_timer_list;
	142	const struct phy_info *phy;
	143	u32 msg_enable;
	144	struct mii_if_info mii_if;
	145	unsigned int last_mii_status;
48257c4f PA	146	int interrupt;
48257c4f PA	147
5b4b8454	148	int oldduplex, oldspeed, oldlink; /* current settings */
48257c4f PA	149
48257c4f PA	150	/* event masks */
8572763a CL	151	u32 ev_napi; /* mask of NAPI events */
8572763a CL	152	u32 ev; /* event mask */
48257c4f PA	153	u32 ev_err; /* error event mask */
	154
	155	u16 bd_rx_empty; /* mask of BD rx empty */
	156	u16 bd_rx_err; /* mask of BD rx errors */
	157
	158	union {
	159	struct {
	160	int idx; /* FEC1 = 0, FEC2 = 1 */
31a5bb04	161	void __iomem fecp; / hw registers */
48257c4f PA	162	u32 hthi, htlo; /* state for multicast */
	163	} fec;
	164
	165	struct {
	166	int idx; /* FCC1-3 = 0-2 */
31a5bb04 SW	167	void __iomem fccp; / hw registers */
	168	void __iomem ep; / parameter ram */
	169	void __iomem fcccp; / hw registers cont. */
	170	void __iomem mem; / FCC DPRAM */
48257c4f PA	171	u32 gaddrh, gaddrl; /* group address */
	172	} fcc;
	173
	174	struct {
	175	int idx; /* FEC1 = 0, FEC2 = 1 */
31a5bb04 SW	176	void __iomem sccp; / hw registers */
31a5bb04 SW	177	void __iomem ep; / parameter ram */
48257c4f PA	178	u32 hthi, htlo; /* state for multicast */
	179	} scc;
	180
	181	};
	182	};
	183
	184	/***************************************************************************/
48257c4f PA	185
	186	void fs_init_bds(struct net_device *dev);
	187	void fs_cleanup_bds(struct net_device *dev);
	188
	189	/***************************************************************************/
	190
	191	#define DRV_MODULE_NAME "fs_enet"
	192	#define PFX DRV_MODULE_NAME ": "
d43a396a LC	193	#define DRV_MODULE_VERSION "1.1"
d43a396a LC	194	#define DRV_MODULE_RELDATE "Sep 22, 2014"
48257c4f PA	195
	196	/***************************************************************************/
	197
	198	int fs_enet_platform_init(void);
	199	void fs_enet_platform_cleanup(void);
	200
	201	/***************************************************************************/
48257c4f PA	202	/* buffer descriptor access macros */
	203
	204	/* access macros */
	205	#if defined(CONFIG_CPM1)
	206	/* for a a CPM1 __raw_xxx's are sufficient */
	207	#define __cbd_out32(addr, x) __raw_writel(x, addr)
	208	#define __cbd_out16(addr, x) __raw_writew(x, addr)
	209	#define __cbd_in32(addr) __raw_readl(addr)
	210	#define __cbd_in16(addr) __raw_readw(addr)
	211	#else
	212	/* for others play it safe */
	213	#define __cbd_out32(addr, x) out_be32(addr, x)
	214	#define __cbd_out16(addr, x) out_be16(addr, x)
	215	#define __cbd_in32(addr) in_be32(addr)
	216	#define __cbd_in16(addr) in_be16(addr)
	217	#endif
	218
	219	/* write */
	220	#define CBDW_SC(_cbd, _sc) __cbd_out16(&(_cbd)->cbd_sc, (_sc))
	221	#define CBDW_DATLEN(_cbd, _datlen) __cbd_out16(&(_cbd)->cbd_datlen, (_datlen))
	222	#define CBDW_BUFADDR(_cbd, _bufaddr) __cbd_out32(&(_cbd)->cbd_bufaddr, (_bufaddr))
	223
	224	/* read */
	225	#define CBDR_SC(_cbd) __cbd_in16(&(_cbd)->cbd_sc)
	226	#define CBDR_DATLEN(_cbd) __cbd_in16(&(_cbd)->cbd_datlen)
	227	#define CBDR_BUFADDR(_cbd) __cbd_in32(&(_cbd)->cbd_bufaddr)
	228
	229	/* set bits */
	230	#define CBDS_SC(_cbd, _sc) CBDW_SC(_cbd, CBDR_SC(_cbd) \| (_sc))
	231
	232	/* clear bits */
	233	#define CBDC_SC(_cbd, _sc) CBDW_SC(_cbd, CBDR_SC(_cbd) & ~(_sc))
	234
	235	/*******************************************************************/
	236
	237	extern const struct fs_ops fs_fec_ops;
	238	extern const struct fs_ops fs_fcc_ops;
	239	extern const struct fs_ops fs_scc_ops;
	240
	241	/*******************************************************************/
	242
48257c4f	243	#endif