[mirror_ubuntu-artful-kernel.git] / drivers / net / ethernet / stmicro / stmmac / common.h

/*******************************************************************************
  STMMAC Common Header File

  Copyright (C) 2007-2009  STMicroelectronics Ltd

  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.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
*******************************************************************************/

#include <linux/etherdevice.h>
#include <linux/netdevice.h>
#include <linux/phy.h>
#include <linux/module.h>
#include <linux/init.h>
#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
#define STMMAC_VLAN_TAG_USED
#include <linux/if_vlan.h>
#endif

#include "descs.h"
#include "mmc.h"

#undef CHIP_DEBUG_PRINT
/* Turn-on extra printk debug for MAC core, dma and descriptors */
/* #define CHIP_DEBUG_PRINT */

#ifdef CHIP_DEBUG_PRINT
#define CHIP_DBG(fmt, args...)  printk(fmt, ## args)
#else
#define CHIP_DBG(fmt, args...)  do { } while (0)
#endif

#undef FRAME_FILTER_DEBUG
/* #define FRAME_FILTER_DEBUG */

struct stmmac_extra_stats {
	/* Transmit errors */
	unsigned long tx_underflow ____cacheline_aligned;
	unsigned long tx_carrier;
	unsigned long tx_losscarrier;
	unsigned long vlan_tag;
	unsigned long tx_deferred;
	unsigned long tx_vlan;
	unsigned long tx_jabber;
	unsigned long tx_frame_flushed;
	unsigned long tx_payload_error;
	unsigned long tx_ip_header_error;
	/* Receive errors */
	unsigned long rx_desc;
	unsigned long sa_filter_fail;
	unsigned long overflow_error;
	unsigned long ipc_csum_error;
	unsigned long rx_collision;
	unsigned long rx_crc;
	unsigned long dribbling_bit;
	unsigned long rx_length;
	unsigned long rx_mii;
	unsigned long rx_multicast;
	unsigned long rx_gmac_overflow;
	unsigned long rx_watchdog;
	unsigned long da_rx_filter_fail;
	unsigned long sa_rx_filter_fail;
	unsigned long rx_missed_cntr;
	unsigned long rx_overflow_cntr;
	unsigned long rx_vlan;
	/* Tx/Rx IRQ errors */
	unsigned long tx_undeflow_irq;
	unsigned long tx_process_stopped_irq;
	unsigned long tx_jabber_irq;
	unsigned long rx_overflow_irq;
	unsigned long rx_buf_unav_irq;
	unsigned long rx_process_stopped_irq;
	unsigned long rx_watchdog_irq;
	unsigned long tx_early_irq;
	unsigned long fatal_bus_error_irq;
	/* Extra info */
	unsigned long threshold;
	unsigned long tx_pkt_n;
	unsigned long rx_pkt_n;
	unsigned long poll_n;
	unsigned long sched_timer_n;
	unsigned long normal_irq_n;
};

#define HASH_TABLE_SIZE 64
#define PAUSE_TIME 0x200

/* Flow Control defines */
#define FLOW_OFF	0
#define FLOW_RX		1
#define FLOW_TX		2
#define FLOW_AUTO	(FLOW_TX | FLOW_RX)

#define SF_DMA_MODE 1 /* DMA STORE-AND-FORWARD Operation Mode */

/* DAM HW feature register fields */
#define DMA_HW_FEAT_MIISEL	0x00000001 /* 10/100 Mbps Support */
#define DMA_HW_FEAT_GMIISEL	0x00000002 /* 1000 Mbps Support */
#define DMA_HW_FEAT_HDSEL	0x00000004 /* Half-Duplex Support */
#define DMA_HW_FEAT_EXTHASHEN	0x00000008 /* Expanded DA Hash Filter */
#define DMA_HW_FEAT_HASHSEL	0x00000010 /* HASH Filter */
#define DMA_HW_FEAT_ADDMACADRSEL	0x00000020 /* Multiple MAC Addr Reg */
#define DMA_HW_FEAT_PCSSEL	0x00000040 /* PCS registers */
#define DMA_HW_FEAT_L3L4FLTREN	0x00000080 /* Layer 3 & Layer 4 Feature */
#define DMA_HW_FEAT_SMASEL	0x00000100 /* SMA(MDIO) Interface */
#define DMA_HW_FEAT_RWKSEL	0x00000200 /* PMT Remote Wakeup */
#define DMA_HW_FEAT_MGKSEL	0x00000400 /* PMT Magic Packet */
#define DMA_HW_FEAT_MMCSEL	0x00000800 /* RMON Module */
#define DMA_HW_FEAT_TSVER1SEL	0x00001000 /* Only IEEE 1588-2002 Timestamp */
#define DMA_HW_FEAT_TSVER2SEL	0x00002000 /* IEEE 1588-2008 Adv Timestamp */
#define DMA_HW_FEAT_EEESEL	0x00004000 /* Energy Efficient Ethernet */
#define DMA_HW_FEAT_AVSEL	0x00008000 /* AV Feature */
#define DMA_HW_FEAT_TXCOESEL	0x00010000 /* Checksum Offload in Tx */
#define DMA_HW_FEAT_RXTYP1COE	0x00020000 /* IP csum Offload(Type 1) in Rx */
#define DMA_HW_FEAT_RXTYP2COE	0x00040000 /* IP csum Offload(Type 2) in Rx */
#define DMA_HW_FEAT_RXFIFOSIZE	0x00080000 /* Rx FIFO > 2048 Bytes */
#define DMA_HW_FEAT_RXCHCNT	0x00300000 /* No. of additional Rx Channels */
#define DMA_HW_FEAT_TXCHCNT	0x00c00000 /* No. of additional Tx Channels */
#define DMA_HW_FEAT_ENHDESSEL	0x01000000 /* Alternate (Enhanced Descriptor) */
#define DMA_HW_FEAT_INTTSEN	0x02000000 /* Timestamping with Internal
					      System Time */
#define DMA_HW_FEAT_FLEXIPPSEN	0x04000000 /* Flexible PPS Output */
#define DMA_HW_FEAT_SAVLANINS	0x08000000 /* Source Addr or VLAN Insertion */
#define DMA_HW_FEAT_ACTPHYIF	0x70000000 /* Active/selected PHY interface */

enum rx_frame_status { /* IPC status */
	good_frame = 0,
	discard_frame = 1,
	csum_none = 2,
	llc_snap = 4,
};

enum tx_dma_irq_status {
	tx_hard_error = 1,
	tx_hard_error_bump_tc = 2,
	handle_tx_rx = 3,
};

/* DMA HW capabilities */
struct dma_features {
	unsigned int mbps_10_100;
	unsigned int mbps_1000;
	unsigned int half_duplex;
	unsigned int hash_filter;
	unsigned int multi_addr;
	unsigned int pcs;
	unsigned int sma_mdio;
	unsigned int pmt_remote_wake_up;
	unsigned int pmt_magic_frame;
	unsigned int rmon;
	/* IEEE 1588-2002*/
	unsigned int time_stamp;
	/* IEEE 1588-2008*/
	unsigned int atime_stamp;
	/* 802.3az - Energy-Efficient Ethernet (EEE) */
	unsigned int eee;
	unsigned int av;
	/* TX and RX csum */
	unsigned int tx_coe;
	unsigned int rx_coe_type1;
	unsigned int rx_coe_type2;
	unsigned int rxfifo_over_2048;
	/* TX and RX number of channels */
	unsigned int number_rx_channel;
	unsigned int number_tx_channel;
	/* Alternate (enhanced) DESC mode*/
	unsigned int enh_desc;
};

/* GMAC TX FIFO is 8K, Rx FIFO is 16K */
#define BUF_SIZE_16KiB 16384
#define BUF_SIZE_8KiB 8192
#define BUF_SIZE_4KiB 4096
#define BUF_SIZE_2KiB 2048

/* Power Down and WOL */
#define PMT_NOT_SUPPORTED 0
#define PMT_SUPPORTED 1

/* Common MAC defines */
#define MAC_CTRL_REG		0x00000000	/* MAC Control */
#define MAC_ENABLE_TX		0x00000008	/* Transmitter Enable */
#define MAC_RNABLE_RX		0x00000004	/* Receiver Enable */

struct stmmac_desc_ops {
	/* DMA RX descriptor ring initialization */
	void (*init_rx_desc) (struct dma_desc *p, unsigned int ring_size,
			      int disable_rx_ic);
	/* DMA TX descriptor ring initialization */
	void (*init_tx_desc) (struct dma_desc *p, unsigned int ring_size);

	/* Invoked by the xmit function to prepare the tx descriptor */
	void (*prepare_tx_desc) (struct dma_desc *p, int is_fs, int len,
				 int csum_flag);
	/* Set/get the owner of the descriptor */
	void (*set_tx_owner) (struct dma_desc *p);
	int (*get_tx_owner) (struct dma_desc *p);
	/* Invoked by the xmit function to close the tx descriptor */
	void (*close_tx_desc) (struct dma_desc *p);
	/* Clean the tx descriptor as soon as the tx irq is received */
	void (*release_tx_desc) (struct dma_desc *p);
	/* Clear interrupt on tx frame completion. When this bit is
	 * set an interrupt happens as soon as the frame is transmitted */
	void (*clear_tx_ic) (struct dma_desc *p);
	/* Last tx segment reports the transmit status */
	int (*get_tx_ls) (struct dma_desc *p);
	/* Return the transmit status looking at the TDES1 */
	int (*tx_status) (void *data, struct stmmac_extra_stats *x,
			  struct dma_desc *p, void __iomem *ioaddr);
	/* Get the buffer size from the descriptor */
	int (*get_tx_len) (struct dma_desc *p);
	/* Handle extra events on specific interrupts hw dependent */
	int (*get_rx_owner) (struct dma_desc *p);
	void (*set_rx_owner) (struct dma_desc *p);
	/* Get the receive frame size */
	int (*get_rx_frame_len) (struct dma_desc *p);
	/* Return the reception status looking at the RDES1 */
	int (*rx_status) (void *data, struct stmmac_extra_stats *x,
			  struct dma_desc *p);
};

struct stmmac_dma_ops {
	/* DMA core initialization */
	int (*init) (void __iomem *ioaddr, int pbl, u32 dma_tx, u32 dma_rx);
	/* Dump DMA registers */
	void (*dump_regs) (void __iomem *ioaddr);
	/* Set tx/rx threshold in the csr6 register
	 * An invalid value enables the store-and-forward mode */
	void (*dma_mode) (void __iomem *ioaddr, int txmode, int rxmode);
	/* To track extra statistic (if supported) */
	void (*dma_diagnostic_fr) (void *data, struct stmmac_extra_stats *x,
				   void __iomem *ioaddr);
	void (*enable_dma_transmission) (void __iomem *ioaddr);
	void (*enable_dma_irq) (void __iomem *ioaddr);
	void (*disable_dma_irq) (void __iomem *ioaddr);
	void (*start_tx) (void __iomem *ioaddr);
	void (*stop_tx) (void __iomem *ioaddr);
	void (*start_rx) (void __iomem *ioaddr);
	void (*stop_rx) (void __iomem *ioaddr);
	int (*dma_interrupt) (void __iomem *ioaddr,
			      struct stmmac_extra_stats *x);
	/* If supported then get the optional core features */
	unsigned int (*get_hw_feature) (void __iomem *ioaddr);
};

struct stmmac_ops {
	/* MAC core initialization */
	void (*core_init) (void __iomem *ioaddr) ____cacheline_aligned;
	/* Support checksum offload engine */
	int  (*rx_coe) (void __iomem *ioaddr);
	/* Dump MAC registers */
	void (*dump_regs) (void __iomem *ioaddr);
	/* Handle extra events on specific interrupts hw dependent */
	void (*host_irq_status) (void __iomem *ioaddr);
	/* Multicast filter setting */
	void (*set_filter) (struct net_device *dev);
	/* Flow control setting */
	void (*flow_ctrl) (void __iomem *ioaddr, unsigned int duplex,
			   unsigned int fc, unsigned int pause_time);
	/* Set power management mode (e.g. magic frame) */
	void (*pmt) (void __iomem *ioaddr, unsigned long mode);
	/* Set/Get Unicast MAC addresses */
	void (*set_umac_addr) (void __iomem *ioaddr, unsigned char *addr,
			       unsigned int reg_n);
	void (*get_umac_addr) (void __iomem *ioaddr, unsigned char *addr,
			       unsigned int reg_n);
};

struct mac_link {
	int port;
	int duplex;
	int speed;
};

struct mii_regs {
	unsigned int addr;	/* MII Address */
	unsigned int data;	/* MII Data */
};

struct stmmac_ring_mode_ops {
	unsigned int (*is_jumbo_frm) (int len, int ehn_desc);
	unsigned int (*jumbo_frm) (void *priv, struct sk_buff *skb, int csum);
	void (*refill_desc3) (int bfsize, struct dma_desc *p);
	void (*init_desc3) (int des3_as_data_buf, struct dma_desc *p);
	void (*init_dma_chain) (struct dma_desc *des, dma_addr_t phy_addr,
				unsigned int size);
	void (*clean_desc3) (struct dma_desc *p);
	int (*set_16kib_bfsize) (int mtu);
};

struct mac_device_info {
	const struct stmmac_ops		*mac;
	const struct stmmac_desc_ops	*desc;
	const struct stmmac_dma_ops	*dma;
	const struct stmmac_ring_mode_ops	*ring;
	struct mii_regs mii;	/* MII register Addresses */
	struct mac_link link;
	unsigned int synopsys_uid;
};

struct mac_device_info *dwmac1000_setup(void __iomem *ioaddr);
struct mac_device_info *dwmac100_setup(void __iomem *ioaddr);

extern void stmmac_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
				unsigned int high, unsigned int low);
extern void stmmac_get_mac_addr(void __iomem *ioaddr, unsigned char *addr,
				unsigned int high, unsigned int low);

extern void stmmac_set_mac(void __iomem *ioaddr, bool enable);

extern void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);
extern const struct stmmac_ring_mode_ops ring_mode_ops;
Commit	Line	Data
47dd7a54 GC	1	/*******************************************************************************
	2	STMMAC Common Header File
	3
	4	Copyright (C) 2007-2009 STMicroelectronics Ltd
	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.
	14
	15	You should have received a copy of the GNU General Public License along with
	16	this program; if not, write to the Free Software Foundation, Inc.,
	17	51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	18
	19	The full GNU General Public License is included in this distribution in
	20	the file called "COPYING".
	21
	22	Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
	23	*******************************************************************************/
	24
bfab27a1	25	#include <linux/etherdevice.h>
5e33c791	26	#include <linux/netdevice.h>
bfab27a1 GC	27	#include <linux/phy.h>
	28	#include <linux/module.h>
	29	#include <linux/init.h>
8f617541 GC	30	#if defined(CONFIG_VLAN_8021Q) \|\| defined(CONFIG_VLAN_8021Q_MODULE)
	31	#define STMMAC_VLAN_TAG_USED
	32	#include <linux/if_vlan.h>
	33	#endif
	34
56b106ae	35	#include "descs.h"
1c901a46	36	#include "mmc.h"
56b106ae GC	37
	38	#undef CHIP_DEBUG_PRINT
	39	/* Turn-on extra printk debug for MAC core, dma and descriptors */
	40	/* #define CHIP_DEBUG_PRINT */
	41
	42	#ifdef CHIP_DEBUG_PRINT
	43	#define CHIP_DBG(fmt, args...) printk(fmt, ## args)
	44	#else
	45	#define CHIP_DBG(fmt, args...) do { } while (0)
	46	#endif
	47
	48	#undef FRAME_FILTER_DEBUG
	49	/* #define FRAME_FILTER_DEBUG */
47dd7a54	50
47dd7a54 GC	51	struct stmmac_extra_stats {
	52	/* Transmit errors */
	53	unsigned long tx_underflow ____cacheline_aligned;
	54	unsigned long tx_carrier;
	55	unsigned long tx_losscarrier;
3c20f72f	56	unsigned long vlan_tag;
47dd7a54 GC	57	unsigned long tx_deferred;
	58	unsigned long tx_vlan;
	59	unsigned long tx_jabber;
	60	unsigned long tx_frame_flushed;
	61	unsigned long tx_payload_error;
	62	unsigned long tx_ip_header_error;
	63	/* Receive errors */
	64	unsigned long rx_desc;
3c20f72f GC	65	unsigned long sa_filter_fail;
	66	unsigned long overflow_error;
	67	unsigned long ipc_csum_error;
47dd7a54 GC	68	unsigned long rx_collision;
47dd7a54 GC	69	unsigned long rx_crc;
1cc5a735	70	unsigned long dribbling_bit;
1b924032	71	unsigned long rx_length;
47dd7a54 GC	72	unsigned long rx_mii;
	73	unsigned long rx_multicast;
	74	unsigned long rx_gmac_overflow;
	75	unsigned long rx_watchdog;
	76	unsigned long da_rx_filter_fail;
	77	unsigned long sa_rx_filter_fail;
	78	unsigned long rx_missed_cntr;
	79	unsigned long rx_overflow_cntr;
	80	unsigned long rx_vlan;
	81	/* Tx/Rx IRQ errors */
	82	unsigned long tx_undeflow_irq;
	83	unsigned long tx_process_stopped_irq;
	84	unsigned long tx_jabber_irq;
	85	unsigned long rx_overflow_irq;
	86	unsigned long rx_buf_unav_irq;
	87	unsigned long rx_process_stopped_irq;
	88	unsigned long rx_watchdog_irq;
	89	unsigned long tx_early_irq;
	90	unsigned long fatal_bus_error_irq;
	91	/* Extra info */
	92	unsigned long threshold;
	93	unsigned long tx_pkt_n;
	94	unsigned long rx_pkt_n;
	95	unsigned long poll_n;
	96	unsigned long sched_timer_n;
	97	unsigned long normal_irq_n;
	98	};
	99
aec7ff27 GC	100	#define HASH_TABLE_SIZE 64
	101	#define PAUSE_TIME 0x200
	102
	103	/* Flow Control defines */
	104	#define FLOW_OFF 0
	105	#define FLOW_RX 1
	106	#define FLOW_TX 2
	107	#define FLOW_AUTO (FLOW_TX \| FLOW_RX)
	108
	109	#define SF_DMA_MODE 1 /* DMA STORE-AND-FORWARD Operation Mode */
	110
1db123fb RK	111	/* DAM HW feature register fields */
	112	#define DMA_HW_FEAT_MIISEL 0x00000001 /* 10/100 Mbps Support */
	113	#define DMA_HW_FEAT_GMIISEL 0x00000002 /* 1000 Mbps Support */
	114	#define DMA_HW_FEAT_HDSEL 0x00000004 /* Half-Duplex Support */
	115	#define DMA_HW_FEAT_EXTHASHEN 0x00000008 /* Expanded DA Hash Filter */
	116	#define DMA_HW_FEAT_HASHSEL 0x00000010 /* HASH Filter */
	117	#define DMA_HW_FEAT_ADDMACADRSEL 0x00000020 /* Multiple MAC Addr Reg */
	118	#define DMA_HW_FEAT_PCSSEL 0x00000040 /* PCS registers */
	119	#define DMA_HW_FEAT_L3L4FLTREN 0x00000080 /* Layer 3 & Layer 4 Feature */
	120	#define DMA_HW_FEAT_SMASEL 0x00000100 /* SMA(MDIO) Interface */
	121	#define DMA_HW_FEAT_RWKSEL 0x00000200 /* PMT Remote Wakeup */
	122	#define DMA_HW_FEAT_MGKSEL 0x00000400 /* PMT Magic Packet */
	123	#define DMA_HW_FEAT_MMCSEL 0x00000800 /* RMON Module */
	124	#define DMA_HW_FEAT_TSVER1SEL 0x00001000 /* Only IEEE 1588-2002 Timestamp */
	125	#define DMA_HW_FEAT_TSVER2SEL 0x00002000 /* IEEE 1588-2008 Adv Timestamp */
	126	#define DMA_HW_FEAT_EEESEL 0x00004000 /* Energy Efficient Ethernet */
	127	#define DMA_HW_FEAT_AVSEL 0x00008000 /* AV Feature */
	128	#define DMA_HW_FEAT_TXCOESEL 0x00010000 /* Checksum Offload in Tx */
	129	#define DMA_HW_FEAT_RXTYP1COE 0x00020000 /* IP csum Offload(Type 1) in Rx */
	130	#define DMA_HW_FEAT_RXTYP2COE 0x00040000 /* IP csum Offload(Type 2) in Rx */
	131	#define DMA_HW_FEAT_RXFIFOSIZE 0x00080000 /* Rx FIFO > 2048 Bytes */
	132	#define DMA_HW_FEAT_RXCHCNT 0x00300000 /* No. of additional Rx Channels */
	133	#define DMA_HW_FEAT_TXCHCNT 0x00c00000 /* No. of additional Tx Channels */
	134	#define DMA_HW_FEAT_ENHDESSEL 0x01000000 /* Alternate (Enhanced Descriptor) */
	135	#define DMA_HW_FEAT_INTTSEN 0x02000000 /* Timestamping with Internal
	136	System Time */
	137	#define DMA_HW_FEAT_FLEXIPPSEN 0x04000000 /* Flexible PPS Output */
	138	#define DMA_HW_FEAT_SAVLANINS 0x08000000 /* Source Addr or VLAN Insertion */
	139	#define DMA_HW_FEAT_ACTPHYIF 0x70000000 /* Active/selected PHY interface */
	140
aec7ff27	141	enum rx_frame_status { /* IPC status */
47dd7a54 GC	142	good_frame = 0,
	143	discard_frame = 1,
	144	csum_none = 2,
3eeb2997	145	llc_snap = 4,
47dd7a54 GC	146	};
47dd7a54 GC	147
aec7ff27 GC	148	enum tx_dma_irq_status {
	149	tx_hard_error = 1,
	150	tx_hard_error_bump_tc = 2,
	151	handle_tx_rx = 3,
	152	};
47dd7a54	153
e7434821 GC	154	/* DMA HW capabilities */
	155	struct dma_features {
	156	unsigned int mbps_10_100;
	157	unsigned int mbps_1000;
	158	unsigned int half_duplex;
	159	unsigned int hash_filter;
	160	unsigned int multi_addr;
	161	unsigned int pcs;
	162	unsigned int sma_mdio;
	163	unsigned int pmt_remote_wake_up;
	164	unsigned int pmt_magic_frame;
	165	unsigned int rmon;
	166	/* IEEE 1588-2002*/
	167	unsigned int time_stamp;
	168	/* IEEE 1588-2008*/
	169	unsigned int atime_stamp;
	170	/* 802.3az - Energy-Efficient Ethernet (EEE) */
	171	unsigned int eee;
	172	unsigned int av;
	173	/* TX and RX csum */
	174	unsigned int tx_coe;
	175	unsigned int rx_coe_type1;
	176	unsigned int rx_coe_type2;
	177	unsigned int rxfifo_over_2048;
	178	/* TX and RX number of channels */
	179	unsigned int number_rx_channel;
	180	unsigned int number_tx_channel;
	181	/* Alternate (enhanced) DESC mode*/
	182	unsigned int enh_desc;
	183	};
	184
aec7ff27 GC	185	/* GMAC TX FIFO is 8K, Rx FIFO is 16K */
	186	#define BUF_SIZE_16KiB 16384
	187	#define BUF_SIZE_8KiB 8192
	188	#define BUF_SIZE_4KiB 4096
	189	#define BUF_SIZE_2KiB 2048
47dd7a54	190
aec7ff27 GC	191	/* Power Down and WOL */
	192	#define PMT_NOT_SUPPORTED 0
	193	#define PMT_SUPPORTED 1
47dd7a54	194
aec7ff27 GC	195	/* Common MAC defines */
	196	#define MAC_CTRL_REG 0x00000000 /* MAC Control */
	197	#define MAC_ENABLE_TX 0x00000008 /* Transmitter Enable */
	198	#define MAC_RNABLE_RX 0x00000004 /* Receiver Enable */
47dd7a54	199
db98a0b0 GC	200	struct stmmac_desc_ops {
db98a0b0 GC	201	/* DMA RX descriptor ring initialization */
47dd7a54	202	void (init_rx_desc) (struct dma_desc p, unsigned int ring_size,
db98a0b0 GC	203	int disable_rx_ic);
db98a0b0 GC	204	/* DMA TX descriptor ring initialization */
47dd7a54 GC	205	void (init_tx_desc) (struct dma_desc p, unsigned int ring_size);
	206
	207	/* Invoked by the xmit function to prepare the tx descriptor */
	208	void (prepare_tx_desc) (struct dma_desc p, int is_fs, int len,
	209	int csum_flag);
	210	/* Set/get the owner of the descriptor */
	211	void (set_tx_owner) (struct dma_desc p);
	212	int (get_tx_owner) (struct dma_desc p);
	213	/* Invoked by the xmit function to close the tx descriptor */
	214	void (close_tx_desc) (struct dma_desc p);
	215	/* Clean the tx descriptor as soon as the tx irq is received */
	216	void (release_tx_desc) (struct dma_desc p);
	217	/* Clear interrupt on tx frame completion. When this bit is
	218	* set an interrupt happens as soon as the frame is transmitted */
	219	void (clear_tx_ic) (struct dma_desc p);
	220	/* Last tx segment reports the transmit status */
	221	int (get_tx_ls) (struct dma_desc p);
	222	/* Return the transmit status looking at the TDES1 */
	223	int (tx_status) (void data, struct stmmac_extra_stats *x,
ad01b7d4	224	struct dma_desc p, void __iomem ioaddr);
47dd7a54 GC	225	/* Get the buffer size from the descriptor */
	226	int (get_tx_len) (struct dma_desc p);
	227	/* Handle extra events on specific interrupts hw dependent */
47dd7a54 GC	228	int (get_rx_owner) (struct dma_desc p);
	229	void (set_rx_owner) (struct dma_desc p);
	230	/* Get the receive frame size */
	231	int (get_rx_frame_len) (struct dma_desc p);
	232	/* Return the reception status looking at the RDES1 */
	233	int (rx_status) (void data, struct stmmac_extra_stats *x,
	234	struct dma_desc *p);
db98a0b0 GC	235	};
	236
	237	struct stmmac_dma_ops {
	238	/* DMA core initialization */
ad01b7d4	239	int (init) (void __iomem ioaddr, int pbl, u32 dma_tx, u32 dma_rx);
db98a0b0	240	/* Dump DMA registers */
ad01b7d4	241	void (dump_regs) (void __iomem ioaddr);
db98a0b0 GC	242	/* Set tx/rx threshold in the csr6 register
db98a0b0 GC	243	* An invalid value enables the store-and-forward mode */
ad01b7d4	244	void (dma_mode) (void __iomem ioaddr, int txmode, int rxmode);
db98a0b0 GC	245	/* To track extra statistic (if supported) */
db98a0b0 GC	246	void (dma_diagnostic_fr) (void data, struct stmmac_extra_stats *x,
ad01b7d4 GC	247	void __iomem *ioaddr);
	248	void (enable_dma_transmission) (void __iomem ioaddr);
	249	void (enable_dma_irq) (void __iomem ioaddr);
	250	void (disable_dma_irq) (void __iomem ioaddr);
	251	void (start_tx) (void __iomem ioaddr);
	252	void (stop_tx) (void __iomem ioaddr);
	253	void (start_rx) (void __iomem ioaddr);
	254	void (stop_rx) (void __iomem ioaddr);
	255	int (dma_interrupt) (void __iomem ioaddr,
aec7ff27	256	struct stmmac_extra_stats *x);
e7434821 GC	257	/* If supported then get the optional core features */
e7434821 GC	258	unsigned int (get_hw_feature) (void __iomem ioaddr);
db98a0b0 GC	259	};
	260
	261	struct stmmac_ops {
	262	/* MAC core initialization */
ad01b7d4	263	void (core_init) (void __iomem ioaddr) ____cacheline_aligned;
ebbb293f GC	264	/* Support checksum offload engine */
ebbb293f GC	265	int (rx_coe) (void __iomem ioaddr);
db98a0b0	266	/* Dump MAC registers */
ad01b7d4	267	void (dump_regs) (void __iomem ioaddr);
db98a0b0	268	/* Handle extra events on specific interrupts hw dependent */
ad01b7d4	269	void (host_irq_status) (void __iomem ioaddr);
47dd7a54 GC	270	/* Multicast filter setting */
	271	void (set_filter) (struct net_device dev);
	272	/* Flow control setting */
ad01b7d4	273	void (flow_ctrl) (void __iomem ioaddr, unsigned int duplex,
47dd7a54 GC	274	unsigned int fc, unsigned int pause_time);
47dd7a54 GC	275	/* Set power management mode (e.g. magic frame) */
ad01b7d4	276	void (pmt) (void __iomem ioaddr, unsigned long mode);
47dd7a54	277	/* Set/Get Unicast MAC addresses */
ad01b7d4	278	void (set_umac_addr) (void __iomem ioaddr, unsigned char *addr,
db98a0b0	279	unsigned int reg_n);
ad01b7d4	280	void (get_umac_addr) (void __iomem ioaddr, unsigned char *addr,
db98a0b0	281	unsigned int reg_n);
47dd7a54 GC	282	};
	283
	284	struct mac_link {
	285	int port;
	286	int duplex;
	287	int speed;
	288	};
	289
	290	struct mii_regs {
	291	unsigned int addr; /* MII Address */
	292	unsigned int data; /* MII Data */
	293	};
	294
286a8372 GC	295	struct stmmac_ring_mode_ops {
	296	unsigned int (*is_jumbo_frm) (int len, int ehn_desc);
	297	unsigned int (jumbo_frm) (void priv, struct sk_buff *skb, int csum);
	298	void (refill_desc3) (int bfsize, struct dma_desc p);
	299	void (init_desc3) (int des3_as_data_buf, struct dma_desc p);
	300	void (init_dma_chain) (struct dma_desc des, dma_addr_t phy_addr,
	301	unsigned int size);
	302	void (clean_desc3) (struct dma_desc p);
	303	int (*set_16kib_bfsize) (int mtu);
	304	};
	305
47dd7a54	306	struct mac_device_info {
cadb7924	307	const struct stmmac_ops *mac;
	308	const struct stmmac_desc_ops *desc;
	309	const struct stmmac_dma_ops *dma;
286a8372	310	const struct stmmac_ring_mode_ops *ring;
db98a0b0 GC	311	struct mii_regs mii; /* MII register Addresses */
db98a0b0 GC	312	struct mac_link link;
f0b9d786	313	unsigned int synopsys_uid;
47dd7a54 GC	314	};
47dd7a54 GC	315
ad01b7d4 GC	316	struct mac_device_info dwmac1000_setup(void __iomem ioaddr);
ad01b7d4 GC	317	struct mac_device_info dwmac100_setup(void __iomem ioaddr);
aec7ff27	318
ad01b7d4	319	extern void stmmac_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
aec7ff27	320	unsigned int high, unsigned int low);
ad01b7d4	321	extern void stmmac_get_mac_addr(void __iomem ioaddr, unsigned char addr,
aec7ff27	322	unsigned int high, unsigned int low);
bfab27a1 GC	323
	324	extern void stmmac_set_mac(void __iomem *ioaddr, bool enable);
	325
ad01b7d4	326	extern void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);
286a8372	327	extern const struct stmmac_ring_mode_ops ring_mode_ops;