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