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

/* SPDX-License-Identifier: GPL-2.0-only */
/*******************************************************************************
  STMMAC Common Header File

  Copyright (C) 2007-2009  STMicroelectronics Ltd


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

#ifndef __COMMON_H__
#define __COMMON_H__

#include <linux/etherdevice.h>
#include <linux/netdevice.h>
#include <linux/stmmac.h>
#include <linux/phy.h>
#include <linux/pcs/pcs-xpcs.h>
#include <linux/module.h>
#if IS_ENABLED(CONFIG_VLAN_8021Q)
#define STMMAC_VLAN_TAG_USED
#include <linux/if_vlan.h>
#endif

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

/* Synopsys Core versions */
#define	DWMAC_CORE_3_40		0x34
#define	DWMAC_CORE_3_50		0x35
#define	DWMAC_CORE_4_00		0x40
#define DWMAC_CORE_4_10		0x41
#define DWMAC_CORE_5_00		0x50
#define DWMAC_CORE_5_10		0x51
#define DWXGMAC_CORE_2_10	0x21
#define DWXLGMAC_CORE_2_00	0x20

/* Device ID */
#define DWXGMAC_ID		0x76
#define DWXLGMAC_ID		0x27

#define STMMAC_CHAN0	0	/* Always supported and default for all chips */

/* These need to be power of two, and >= 4 */
#define DMA_TX_SIZE 512
#define DMA_RX_SIZE 512
#define STMMAC_GET_ENTRY(x, size)	((x + 1) & (size - 1))

#undef FRAME_FILTER_DEBUG
/* #define FRAME_FILTER_DEBUG */

/* Extra statistic and debug information exposed by ethtool */
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_errors;
	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;
	unsigned long rx_split_hdr_pkt_n;
	/* Tx/Rx IRQ error info */
	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;
	/* Tx/Rx IRQ Events */
	unsigned long rx_early_irq;
	unsigned long threshold;
	unsigned long tx_pkt_n;
	unsigned long rx_pkt_n;
	unsigned long normal_irq_n;
	unsigned long rx_normal_irq_n;
	unsigned long napi_poll;
	unsigned long tx_normal_irq_n;
	unsigned long tx_clean;
	unsigned long tx_set_ic_bit;
	unsigned long irq_receive_pmt_irq_n;
	/* MMC info */
	unsigned long mmc_tx_irq_n;
	unsigned long mmc_rx_irq_n;
	unsigned long mmc_rx_csum_offload_irq_n;
	/* EEE */
	unsigned long irq_tx_path_in_lpi_mode_n;
	unsigned long irq_tx_path_exit_lpi_mode_n;
	unsigned long irq_rx_path_in_lpi_mode_n;
	unsigned long irq_rx_path_exit_lpi_mode_n;
	unsigned long phy_eee_wakeup_error_n;
	/* Extended RDES status */
	unsigned long ip_hdr_err;
	unsigned long ip_payload_err;
	unsigned long ip_csum_bypassed;
	unsigned long ipv4_pkt_rcvd;
	unsigned long ipv6_pkt_rcvd;
	unsigned long no_ptp_rx_msg_type_ext;
	unsigned long ptp_rx_msg_type_sync;
	unsigned long ptp_rx_msg_type_follow_up;
	unsigned long ptp_rx_msg_type_delay_req;
	unsigned long ptp_rx_msg_type_delay_resp;
	unsigned long ptp_rx_msg_type_pdelay_req;
	unsigned long ptp_rx_msg_type_pdelay_resp;
	unsigned long ptp_rx_msg_type_pdelay_follow_up;
	unsigned long ptp_rx_msg_type_announce;
	unsigned long ptp_rx_msg_type_management;
	unsigned long ptp_rx_msg_pkt_reserved_type;
	unsigned long ptp_frame_type;
	unsigned long ptp_ver;
	unsigned long timestamp_dropped;
	unsigned long av_pkt_rcvd;
	unsigned long av_tagged_pkt_rcvd;
	unsigned long vlan_tag_priority_val;
	unsigned long l3_filter_match;
	unsigned long l4_filter_match;
	unsigned long l3_l4_filter_no_match;
	/* PCS */
	unsigned long irq_pcs_ane_n;
	unsigned long irq_pcs_link_n;
	unsigned long irq_rgmii_n;
	unsigned long pcs_link;
	unsigned long pcs_duplex;
	unsigned long pcs_speed;
	/* debug register */
	unsigned long mtl_tx_status_fifo_full;
	unsigned long mtl_tx_fifo_not_empty;
	unsigned long mmtl_fifo_ctrl;
	unsigned long mtl_tx_fifo_read_ctrl_write;
	unsigned long mtl_tx_fifo_read_ctrl_wait;
	unsigned long mtl_tx_fifo_read_ctrl_read;
	unsigned long mtl_tx_fifo_read_ctrl_idle;
	unsigned long mac_tx_in_pause;
	unsigned long mac_tx_frame_ctrl_xfer;
	unsigned long mac_tx_frame_ctrl_idle;
	unsigned long mac_tx_frame_ctrl_wait;
	unsigned long mac_tx_frame_ctrl_pause;
	unsigned long mac_gmii_tx_proto_engine;
	unsigned long mtl_rx_fifo_fill_level_full;
	unsigned long mtl_rx_fifo_fill_above_thresh;
	unsigned long mtl_rx_fifo_fill_below_thresh;
	unsigned long mtl_rx_fifo_fill_level_empty;
	unsigned long mtl_rx_fifo_read_ctrl_flush;
	unsigned long mtl_rx_fifo_read_ctrl_read_data;
	unsigned long mtl_rx_fifo_read_ctrl_status;
	unsigned long mtl_rx_fifo_read_ctrl_idle;
	unsigned long mtl_rx_fifo_ctrl_active;
	unsigned long mac_rx_frame_ctrl_fifo;
	unsigned long mac_gmii_rx_proto_engine;
	/* TSO */
	unsigned long tx_tso_frames;
	unsigned long tx_tso_nfrags;
};

/* Safety Feature statistics exposed by ethtool */
struct stmmac_safety_stats {
	unsigned long mac_errors[32];
	unsigned long mtl_errors[32];
	unsigned long dma_errors[32];
};

/* Number of fields in Safety Stats */
#define STMMAC_SAFETY_FEAT_SIZE	\
	(sizeof(struct stmmac_safety_stats) / sizeof(unsigned long))

/* CSR Frequency Access Defines*/
#define CSR_F_35M	35000000
#define CSR_F_60M	60000000
#define CSR_F_100M	100000000
#define CSR_F_150M	150000000
#define CSR_F_250M	250000000
#define CSR_F_300M	300000000

#define	MAC_CSR_H_FRQ_MASK	0x20

#define HASH_TABLE_SIZE 64
#define PAUSE_TIME 0xffff

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

/* PCS defines */
#define STMMAC_PCS_RGMII	(1 << 0)
#define STMMAC_PCS_SGMII	(1 << 1)
#define STMMAC_PCS_TBI		(1 << 2)
#define STMMAC_PCS_RTBI		(1 << 3)

#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_ADDMAC	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 */
#define DMA_HW_FEAT_TSVER2SEL	0x00002000	/* IEEE 1588-2008 PTPv2 */
#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 COE (Type 1) in Rx */
#define DMA_HW_FEAT_RXTYP2COE	0x00040000	/* IP COE (Type 2) in Rx */
#define DMA_HW_FEAT_RXFIFOSIZE	0x00080000	/* Rx FIFO > 2048 Bytes */
#define DMA_HW_FEAT_RXCHCNT	0x00300000	/* No. additional Rx Channels */
#define DMA_HW_FEAT_TXCHCNT	0x00c00000	/* No. additional Tx Channels */
#define DMA_HW_FEAT_ENHDESSEL	0x01000000	/* Alternate Descriptor */
/* Timestamping with Internal System Time */
#define DMA_HW_FEAT_INTTSEN	0x02000000
#define DMA_HW_FEAT_FLEXIPPSEN	0x04000000	/* Flexible PPS Output */
#define DMA_HW_FEAT_SAVLANINS	0x08000000	/* Source Addr or VLAN */
#define DMA_HW_FEAT_ACTPHYIF	0x70000000	/* Active/selected PHY iface */
#define DEFAULT_DMA_PBL		8

/* PCS status and mask defines */
#define	PCS_ANE_IRQ		BIT(2)	/* PCS Auto-Negotiation */
#define	PCS_LINK_IRQ		BIT(1)	/* PCS Link */
#define	PCS_RGSMIIIS_IRQ	BIT(0)	/* RGMII or SMII Interrupt */

/* Max/Min RI Watchdog Timer count value */
#define MAX_DMA_RIWT		0xff
#define MIN_DMA_RIWT		0x10
#define DEF_DMA_RIWT		0xa0
/* Tx coalesce parameters */
#define STMMAC_COAL_TX_TIMER	1000
#define STMMAC_MAX_COAL_TX_TICK	100000
#define STMMAC_TX_MAX_FRAMES	256
#define STMMAC_TX_FRAMES	25
#define STMMAC_RX_FRAMES	0

/* Packets types */
enum packets_types {
	PACKET_AVCPQ = 0x1, /* AV Untagged Control packets */
	PACKET_PTPQ = 0x2, /* PTP Packets */
	PACKET_DCBCPQ = 0x3, /* DCB Control Packets */
	PACKET_UPQ = 0x4, /* Untagged Packets */
	PACKET_MCBCQ = 0x5, /* Multicast & Broadcast Packets */
};

/* Rx IPC status */
enum rx_frame_status {
	good_frame = 0x0,
	discard_frame = 0x1,
	csum_none = 0x2,
	llc_snap = 0x4,
	dma_own = 0x8,
	rx_not_ls = 0x10,
};

/* Tx status */
enum tx_frame_status {
	tx_done = 0x0,
	tx_not_ls = 0x1,
	tx_err = 0x2,
	tx_dma_own = 0x4,
};

enum dma_irq_status {
	tx_hard_error = 0x1,
	tx_hard_error_bump_tc = 0x2,
	handle_rx = 0x4,
	handle_tx = 0x8,
};

/* EEE and LPI defines */
#define	CORE_IRQ_TX_PATH_IN_LPI_MODE	(1 << 0)
#define	CORE_IRQ_TX_PATH_EXIT_LPI_MODE	(1 << 1)
#define	CORE_IRQ_RX_PATH_IN_LPI_MODE	(1 << 2)
#define	CORE_IRQ_RX_PATH_EXIT_LPI_MODE	(1 << 3)

#define CORE_IRQ_MTL_RX_OVERFLOW	BIT(8)

/* Physical Coding Sublayer */
struct rgmii_adv {
	unsigned int pause;
	unsigned int duplex;
	unsigned int lp_pause;
	unsigned int lp_duplex;
};

#define STMMAC_PCS_PAUSE	1
#define STMMAC_PCS_ASYM_PAUSE	2

/* 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;
	unsigned int hash_tb_sz;
	unsigned int tsoen;
	/* TX and RX csum */
	unsigned int tx_coe;
	unsigned int rx_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;
	/* TX and RX number of queues */
	unsigned int number_rx_queues;
	unsigned int number_tx_queues;
	/* PPS output */
	unsigned int pps_out_num;
	/* Alternate (enhanced) DESC mode */
	unsigned int enh_desc;
	/* TX and RX FIFO sizes */
	unsigned int tx_fifo_size;
	unsigned int rx_fifo_size;
	/* Automotive Safety Package */
	unsigned int asp;
	/* RX Parser */
	unsigned int frpsel;
	unsigned int frpbs;
	unsigned int frpes;
	unsigned int addr64;
	unsigned int rssen;
	unsigned int vlhash;
	unsigned int sphen;
	unsigned int vlins;
	unsigned int dvlan;
	unsigned int l3l4fnum;
	unsigned int arpoffsel;
	/* TSN Features */
	unsigned int estwid;
	unsigned int estdep;
	unsigned int estsel;
	unsigned int fpesel;
	unsigned int tbssel;
};

/* RX Buffer size must be multiple of 4/8/16 bytes */
#define BUF_SIZE_16KiB 16368
#define BUF_SIZE_8KiB 8188
#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_ENABLE_RX		0x00000004	/* Receiver Enable */

/* Default LPI timers */
#define STMMAC_DEFAULT_LIT_LS	0x3E8
#define STMMAC_DEFAULT_TWT_LS	0x1E

#define STMMAC_CHAIN_MODE	0x1
#define STMMAC_RING_MODE	0x2

#define JUMBO_LEN		9000

/* Receive Side Scaling */
#define STMMAC_RSS_HASH_KEY_SIZE	40
#define STMMAC_RSS_MAX_TABLE_SIZE	256

/* VLAN */
#define STMMAC_VLAN_NONE	0x0
#define STMMAC_VLAN_REMOVE	0x1
#define STMMAC_VLAN_INSERT	0x2
#define STMMAC_VLAN_REPLACE	0x3

extern const struct stmmac_desc_ops enh_desc_ops;
extern const struct stmmac_desc_ops ndesc_ops;

struct mac_device_info;

extern const struct stmmac_hwtimestamp stmmac_ptp;
extern const struct stmmac_mode_ops dwmac4_ring_mode_ops;

struct mac_link {
	u32 speed_mask;
	u32 speed10;
	u32 speed100;
	u32 speed1000;
	u32 speed2500;
	u32 duplex;
	struct {
		u32 speed2500;
		u32 speed5000;
		u32 speed10000;
	} xgmii;
	struct {
		u32 speed25000;
		u32 speed40000;
		u32 speed50000;
		u32 speed100000;
	} xlgmii;
};

struct mii_regs {
	unsigned int addr;	/* MII Address */
	unsigned int data;	/* MII Data */
	unsigned int addr_shift;	/* MII address shift */
	unsigned int reg_shift;		/* MII reg shift */
	unsigned int addr_mask;		/* MII address mask */
	unsigned int reg_mask;		/* MII reg mask */
	unsigned int clk_csr_shift;
	unsigned int clk_csr_mask;
};

struct mac_device_info {
	const struct stmmac_ops *mac;
	const struct stmmac_desc_ops *desc;
	const struct stmmac_dma_ops *dma;
	const struct stmmac_mode_ops *mode;
	const struct stmmac_hwtimestamp *ptp;
	const struct stmmac_tc_ops *tc;
	const struct stmmac_mmc_ops *mmc;
	const struct mdio_xpcs_ops *xpcs;
	struct mdio_xpcs_args xpcs_args;
	struct mii_regs mii;	/* MII register Addresses */
	struct mac_link link;
	void __iomem *pcsr;     /* vpointer to device CSRs */
	unsigned int multicast_filter_bins;
	unsigned int unicast_filter_entries;
	unsigned int mcast_bits_log2;
	unsigned int rx_csum;
	unsigned int pcs;
	unsigned int pmt;
	unsigned int ps;
	unsigned int xlgmac;
	unsigned int num_vlan;
	u32 vlan_filter[32];
	unsigned int promisc;
};

struct stmmac_rx_routing {
	u32 reg_mask;
	u32 reg_shift;
};

int dwmac100_setup(struct stmmac_priv *priv);
int dwmac1000_setup(struct stmmac_priv *priv);
int dwmac4_setup(struct stmmac_priv *priv);
int dwxgmac2_setup(struct stmmac_priv *priv);
int dwxlgmac2_setup(struct stmmac_priv *priv);

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

void stmmac_dwmac4_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
				unsigned int high, unsigned int low);
void stmmac_dwmac4_get_mac_addr(void __iomem *ioaddr, unsigned char *addr,
				unsigned int high, unsigned int low);
void stmmac_dwmac4_set_mac(void __iomem *ioaddr, bool enable);

void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);

extern const struct stmmac_mode_ops ring_mode_ops;
extern const struct stmmac_mode_ops chain_mode_ops;
extern const struct stmmac_desc_ops dwmac4_desc_ops;

#endif /* __COMMON_H__ */
Commit	Line	Data
4fa9c49f	1	/* SPDX-License-Identifier: GPL-2.0-only */
47dd7a54 GC	2	/*******************************************************************************
	3	STMMAC Common Header File
	4
	5	Copyright (C) 2007-2009 STMicroelectronics Ltd
	6
47dd7a54 GC	7
	8	Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
	9	*******************************************************************************/
	10
bd4242df RK	11	#ifndef __COMMON_H__
	12	#define __COMMON_H__
	13
bfab27a1	14	#include <linux/etherdevice.h>
5e33c791	15	#include <linux/netdevice.h>
afea0365	16	#include <linux/stmmac.h>
bfab27a1	17	#include <linux/phy.h>
2fa4e4b7	18	#include <linux/pcs/pcs-xpcs.h>
bfab27a1	19	#include <linux/module.h>
12c70f30	20	#if IS_ENABLED(CONFIG_VLAN_8021Q)
8f617541 GC	21	#define STMMAC_VLAN_TAG_USED
	22	#include <linux/if_vlan.h>
	23	#endif
	24
56b106ae	25	#include "descs.h"
42de047d	26	#include "hwif.h"
1c901a46	27	#include "mmc.h"
56b106ae	28
62a2ab93	29	/* Synopsys Core versions */
48ae5554 JA	30	#define DWMAC_CORE_3_40 0x34
	31	#define DWMAC_CORE_3_50 0x35
	32	#define DWMAC_CORE_4_00 0x40
	33	#define DWMAC_CORE_4_10 0x41
	34	#define DWMAC_CORE_5_00 0x50
	35	#define DWMAC_CORE_5_10 0x51
	36	#define DWXGMAC_CORE_2_10 0x21
4a4ccde0 JA	37	#define DWXLGMAC_CORE_2_00 0x20
	38
	39	/* Device ID */
	40	#define DWXGMAC_ID 0x76
	41	#define DWXLGMAC_ID 0x27
48ae5554	42
48863ce5	43	#define STMMAC_CHAN0 0 /* Always supported and default for all chips */
62a2ab93	44
22d3efe5	45	/* These need to be power of two, and >= 4 */
e3ad57c9 GC	46	#define DMA_TX_SIZE 512
	47	#define DMA_RX_SIZE 512
	48	#define STMMAC_GET_ENTRY(x, size) ((x + 1) & (size - 1))
	49
56b106ae GC	50	#undef FRAME_FILTER_DEBUG
56b106ae GC	51	/* #define FRAME_FILTER_DEBUG */
47dd7a54	52
915c199f	53	/* Extra statistic and debug information exposed by ethtool */
47dd7a54 GC	54	struct stmmac_extra_stats {
	55	/* Transmit errors */
	56	unsigned long tx_underflow ____cacheline_aligned;
	57	unsigned long tx_carrier;
	58	unsigned long tx_losscarrier;
3c20f72f	59	unsigned long vlan_tag;
47dd7a54 GC	60	unsigned long tx_deferred;
	61	unsigned long tx_vlan;
	62	unsigned long tx_jabber;
	63	unsigned long tx_frame_flushed;
	64	unsigned long tx_payload_error;
	65	unsigned long tx_ip_header_error;
	66	/* Receive errors */
	67	unsigned long rx_desc;
3c20f72f GC	68	unsigned long sa_filter_fail;
	69	unsigned long overflow_error;
	70	unsigned long ipc_csum_error;
47dd7a54	71	unsigned long rx_collision;
e0a76606	72	unsigned long rx_crc_errors;
1cc5a735	73	unsigned long dribbling_bit;
1b924032	74	unsigned long rx_length;
47dd7a54 GC	75	unsigned long rx_mii;
	76	unsigned long rx_multicast;
	77	unsigned long rx_gmac_overflow;
	78	unsigned long rx_watchdog;
	79	unsigned long da_rx_filter_fail;
	80	unsigned long sa_rx_filter_fail;
	81	unsigned long rx_missed_cntr;
	82	unsigned long rx_overflow_cntr;
	83	unsigned long rx_vlan;
b5418e13	84	unsigned long rx_split_hdr_pkt_n;
62a2ab93	85	/* Tx/Rx IRQ error info */
47dd7a54 GC	86	unsigned long tx_undeflow_irq;
	87	unsigned long tx_process_stopped_irq;
	88	unsigned long tx_jabber_irq;
	89	unsigned long rx_overflow_irq;
	90	unsigned long rx_buf_unav_irq;
	91	unsigned long rx_process_stopped_irq;
	92	unsigned long rx_watchdog_irq;
	93	unsigned long tx_early_irq;
	94	unsigned long fatal_bus_error_irq;
62a2ab93 GC	95	/* Tx/Rx IRQ Events */
62a2ab93 GC	96	unsigned long rx_early_irq;
47dd7a54 GC	97	unsigned long threshold;
	98	unsigned long tx_pkt_n;
	99	unsigned long rx_pkt_n;
47dd7a54	100	unsigned long normal_irq_n;
9125cdd1 GC	101	unsigned long rx_normal_irq_n;
	102	unsigned long napi_poll;
	103	unsigned long tx_normal_irq_n;
	104	unsigned long tx_clean;
0e80bdc9	105	unsigned long tx_set_ic_bit;
62a2ab93 GC	106	unsigned long irq_receive_pmt_irq_n;
62a2ab93 GC	107	/* MMC info */
d765955d GC	108	unsigned long mmc_tx_irq_n;
	109	unsigned long mmc_rx_irq_n;
	110	unsigned long mmc_rx_csum_offload_irq_n;
	111	/* EEE */
d765955d GC	112	unsigned long irq_tx_path_in_lpi_mode_n;
	113	unsigned long irq_tx_path_exit_lpi_mode_n;
	114	unsigned long irq_rx_path_in_lpi_mode_n;
	115	unsigned long irq_rx_path_exit_lpi_mode_n;
	116	unsigned long phy_eee_wakeup_error_n;
c24602ef GC	117	/* Extended RDES status */
	118	unsigned long ip_hdr_err;
	119	unsigned long ip_payload_err;
	120	unsigned long ip_csum_bypassed;
	121	unsigned long ipv4_pkt_rcvd;
	122	unsigned long ipv6_pkt_rcvd;
ee112c12 GC	123	unsigned long no_ptp_rx_msg_type_ext;
	124	unsigned long ptp_rx_msg_type_sync;
	125	unsigned long ptp_rx_msg_type_follow_up;
	126	unsigned long ptp_rx_msg_type_delay_req;
	127	unsigned long ptp_rx_msg_type_delay_resp;
	128	unsigned long ptp_rx_msg_type_pdelay_req;
	129	unsigned long ptp_rx_msg_type_pdelay_resp;
	130	unsigned long ptp_rx_msg_type_pdelay_follow_up;
	131	unsigned long ptp_rx_msg_type_announce;
	132	unsigned long ptp_rx_msg_type_management;
	133	unsigned long ptp_rx_msg_pkt_reserved_type;
c24602ef GC	134	unsigned long ptp_frame_type;
	135	unsigned long ptp_ver;
	136	unsigned long timestamp_dropped;
	137	unsigned long av_pkt_rcvd;
	138	unsigned long av_tagged_pkt_rcvd;
	139	unsigned long vlan_tag_priority_val;
	140	unsigned long l3_filter_match;
	141	unsigned long l4_filter_match;
	142	unsigned long l3_l4_filter_no_match;
0982a0f6 GC	143	/* PCS */
	144	unsigned long irq_pcs_ane_n;
	145	unsigned long irq_pcs_link_n;
	146	unsigned long irq_rgmii_n;
e58bb43f GC	147	unsigned long pcs_link;
	148	unsigned long pcs_duplex;
	149	unsigned long pcs_speed;
2f7a791c GC	150	/* debug register */
	151	unsigned long mtl_tx_status_fifo_full;
	152	unsigned long mtl_tx_fifo_not_empty;
	153	unsigned long mmtl_fifo_ctrl;
	154	unsigned long mtl_tx_fifo_read_ctrl_write;
	155	unsigned long mtl_tx_fifo_read_ctrl_wait;
	156	unsigned long mtl_tx_fifo_read_ctrl_read;
	157	unsigned long mtl_tx_fifo_read_ctrl_idle;
	158	unsigned long mac_tx_in_pause;
	159	unsigned long mac_tx_frame_ctrl_xfer;
	160	unsigned long mac_tx_frame_ctrl_idle;
	161	unsigned long mac_tx_frame_ctrl_wait;
	162	unsigned long mac_tx_frame_ctrl_pause;
	163	unsigned long mac_gmii_tx_proto_engine;
	164	unsigned long mtl_rx_fifo_fill_level_full;
	165	unsigned long mtl_rx_fifo_fill_above_thresh;
	166	unsigned long mtl_rx_fifo_fill_below_thresh;
	167	unsigned long mtl_rx_fifo_fill_level_empty;
	168	unsigned long mtl_rx_fifo_read_ctrl_flush;
	169	unsigned long mtl_rx_fifo_read_ctrl_read_data;
	170	unsigned long mtl_rx_fifo_read_ctrl_status;
	171	unsigned long mtl_rx_fifo_read_ctrl_idle;
	172	unsigned long mtl_rx_fifo_ctrl_active;
	173	unsigned long mac_rx_frame_ctrl_fifo;
	174	unsigned long mac_gmii_rx_proto_engine;
f748be53 AT	175	/* TSO */
	176	unsigned long tx_tso_frames;
	177	unsigned long tx_tso_nfrags;
47dd7a54 GC	178	};
47dd7a54 GC	179
8bf993a5 JA	180	/* Safety Feature statistics exposed by ethtool */
	181	struct stmmac_safety_stats {
	182	unsigned long mac_errors[32];
	183	unsigned long mtl_errors[32];
	184	unsigned long dma_errors[32];
	185	};
	186
	187	/* Number of fields in Safety Stats */
	188	#define STMMAC_SAFETY_FEAT_SIZE \
	189	(sizeof(struct stmmac_safety_stats) / sizeof(unsigned long))
	190
cd7201f4 GC	191	/* CSR Frequency Access Defines*/
	192	#define CSR_F_35M 35000000
	193	#define CSR_F_60M 60000000
	194	#define CSR_F_100M 100000000
	195	#define CSR_F_150M 150000000
	196	#define CSR_F_250M 250000000
	197	#define CSR_F_300M 300000000
	198
	199	#define MAC_CSR_H_FRQ_MASK 0x20
	200
aec7ff27	201	#define HASH_TABLE_SIZE 64
f88203a2	202	#define PAUSE_TIME 0xffff
aec7ff27 GC	203
	204	/* Flow Control defines */
	205	#define FLOW_OFF 0
	206	#define FLOW_RX 1
	207	#define FLOW_TX 2
	208	#define FLOW_AUTO (FLOW_TX \| FLOW_RX)
	209
e58bb43f GC	210	/* PCS defines */
	211	#define STMMAC_PCS_RGMII (1 << 0)
	212	#define STMMAC_PCS_SGMII (1 << 1)
	213	#define STMMAC_PCS_TBI (1 << 2)
	214	#define STMMAC_PCS_RTBI (1 << 3)
	215
ceb69499	216	#define SF_DMA_MODE 1 /* DMA STORE-AND-FORWARD Operation Mode */
aec7ff27	217
1db123fb	218	/* DAM HW feature register fields */
ceb69499 GC	219	#define DMA_HW_FEAT_MIISEL 0x00000001 /* 10/100 Mbps Support */
	220	#define DMA_HW_FEAT_GMIISEL 0x00000002 /* 1000 Mbps Support */
	221	#define DMA_HW_FEAT_HDSEL 0x00000004 /* Half-Duplex Support */
	222	#define DMA_HW_FEAT_EXTHASHEN 0x00000008 /* Expanded DA Hash Filter */
	223	#define DMA_HW_FEAT_HASHSEL 0x00000010 /* HASH Filter */
	224	#define DMA_HW_FEAT_ADDMAC 0x00000020 /* Multiple MAC Addr Reg */
	225	#define DMA_HW_FEAT_PCSSEL 0x00000040 /* PCS registers */
	226	#define DMA_HW_FEAT_L3L4FLTREN 0x00000080 /* Layer 3 & Layer 4 Feature */
	227	#define DMA_HW_FEAT_SMASEL 0x00000100 /* SMA(MDIO) Interface */
	228	#define DMA_HW_FEAT_RWKSEL 0x00000200 /* PMT Remote Wakeup */
	229	#define DMA_HW_FEAT_MGKSEL 0x00000400 /* PMT Magic Packet */
	230	#define DMA_HW_FEAT_MMCSEL 0x00000800 /* RMON Module */
	231	#define DMA_HW_FEAT_TSVER1SEL 0x00001000 /* Only IEEE 1588-2002 */
	232	#define DMA_HW_FEAT_TSVER2SEL 0x00002000 /* IEEE 1588-2008 PTPv2 */
	233	#define DMA_HW_FEAT_EEESEL 0x00004000 /* Energy Efficient Ethernet */
	234	#define DMA_HW_FEAT_AVSEL 0x00008000 /* AV Feature */
	235	#define DMA_HW_FEAT_TXCOESEL 0x00010000 /* Checksum Offload in Tx */
	236	#define DMA_HW_FEAT_RXTYP1COE 0x00020000 /* IP COE (Type 1) in Rx */
	237	#define DMA_HW_FEAT_RXTYP2COE 0x00040000 /* IP COE (Type 2) in Rx */
	238	#define DMA_HW_FEAT_RXFIFOSIZE 0x00080000 /* Rx FIFO > 2048 Bytes */
	239	#define DMA_HW_FEAT_RXCHCNT 0x00300000 /* No. additional Rx Channels */
	240	#define DMA_HW_FEAT_TXCHCNT 0x00c00000 /* No. additional Tx Channels */
	241	#define DMA_HW_FEAT_ENHDESSEL 0x01000000 /* Alternate Descriptor */
	242	/* Timestamping with Internal System Time */
	243	#define DMA_HW_FEAT_INTTSEN 0x02000000
	244	#define DMA_HW_FEAT_FLEXIPPSEN 0x04000000 /* Flexible PPS Output */
	245	#define DMA_HW_FEAT_SAVLANINS 0x08000000 /* Source Addr or VLAN */
	246	#define DMA_HW_FEAT_ACTPHYIF 0x70000000 /* Active/selected PHY iface */
0f1f88a8	247	#define DEFAULT_DMA_PBL 8
1db123fb	248
70523e63 GC	249	/* PCS status and mask defines */
	250	#define PCS_ANE_IRQ BIT(2) /* PCS Auto-Negotiation */
	251	#define PCS_LINK_IRQ BIT(1) /* PCS Link */
	252	#define PCS_RGSMIIIS_IRQ BIT(0) /* RGMII or SMII Interrupt */
	253
62a2ab93 GC	254	/* Max/Min RI Watchdog Timer count value */
62a2ab93 GC	255	#define MAX_DMA_RIWT 0xff
01d1689d	256	#define MIN_DMA_RIWT 0x10
4e4337cc	257	#define DEF_DMA_RIWT 0xa0
9125cdd1	258	/* Tx coalesce parameters */
8fce3331	259	#define STMMAC_COAL_TX_TIMER 1000
9125cdd1 GC	260	#define STMMAC_MAX_COAL_TX_TICK 100000
9125cdd1 GC	261	#define STMMAC_TX_MAX_FRAMES 256
da202451 JA	262	#define STMMAC_TX_FRAMES 25
da202451 JA	263	#define STMMAC_RX_FRAMES 0
9125cdd1	264
abe80fdc JP	265	/* Packets types */
	266	enum packets_types {
	267	PACKET_AVCPQ = 0x1, /* AV Untagged Control packets */
	268	PACKET_PTPQ = 0x2, /* PTP Packets */
	269	PACKET_DCBCPQ = 0x3, /* DCB Control Packets */
	270	PACKET_UPQ = 0x4, /* Untagged Packets */
	271	PACKET_MCBCQ = 0x5, /* Multicast & Broadcast Packets */
	272	};
	273
ceb69499 GC	274	/* Rx IPC status */
ceb69499 GC	275	enum rx_frame_status {
c1fa3212 FG	276	good_frame = 0x0,
	277	discard_frame = 0x1,
	278	csum_none = 0x2,
	279	llc_snap = 0x4,
	280	dma_own = 0x8,
753a7109	281	rx_not_ls = 0x10,
47dd7a54 GC	282	};
47dd7a54 GC	283
c363b658 FG	284	/* Tx status */
	285	enum tx_frame_status {
	286	tx_done = 0x0,
	287	tx_not_ls = 0x1,
	288	tx_err = 0x2,
	289	tx_dma_own = 0x4,
	290	};
	291
9125cdd1 GC	292	enum dma_irq_status {
	293	tx_hard_error = 0x1,
	294	tx_hard_error_bump_tc = 0x2,
	295	handle_rx = 0x4,
	296	handle_tx = 0x8,
aec7ff27	297	};
47dd7a54	298
915c199f	299	/* EEE and LPI defines */
162fb1d6	300	#define CORE_IRQ_TX_PATH_IN_LPI_MODE (1 << 0)
	301	#define CORE_IRQ_TX_PATH_EXIT_LPI_MODE (1 << 1)
	302	#define CORE_IRQ_RX_PATH_IN_LPI_MODE (1 << 2)
	303	#define CORE_IRQ_RX_PATH_EXIT_LPI_MODE (1 << 3)
0982a0f6	304
48863ce5	305	#define CORE_IRQ_MTL_RX_OVERFLOW BIT(8)
d765955d	306
915c199f	307	/* Physical Coding Sublayer */
e58bb43f GC	308	struct rgmii_adv {
	309	unsigned int pause;
	310	unsigned int duplex;
	311	unsigned int lp_pause;
	312	unsigned int lp_duplex;
	313	};
	314
	315	#define STMMAC_PCS_PAUSE 1
	316	#define STMMAC_PCS_ASYM_PAUSE 2
	317
e7434821 GC	318	/* DMA HW capabilities */
	319	struct dma_features {
	320	unsigned int mbps_10_100;
	321	unsigned int mbps_1000;
	322	unsigned int half_duplex;
	323	unsigned int hash_filter;
	324	unsigned int multi_addr;
	325	unsigned int pcs;
	326	unsigned int sma_mdio;
	327	unsigned int pmt_remote_wake_up;
	328	unsigned int pmt_magic_frame;
	329	unsigned int rmon;
ceb69499	330	/* IEEE 1588-2002 */
e7434821	331	unsigned int time_stamp;
ceb69499	332	/* IEEE 1588-2008 */
e7434821 GC	333	unsigned int atime_stamp;
	334	/* 802.3az - Energy-Efficient Ethernet (EEE) */
	335	unsigned int eee;
	336	unsigned int av;
b8ef7020	337	unsigned int hash_tb_sz;
48863ce5	338	unsigned int tsoen;
e7434821 GC	339	/* TX and RX csum */
e7434821 GC	340	unsigned int tx_coe;
48863ce5	341	unsigned int rx_coe;
e7434821 GC	342	unsigned int rx_coe_type1;
	343	unsigned int rx_coe_type2;
	344	unsigned int rxfifo_over_2048;
	345	/* TX and RX number of channels */
	346	unsigned int number_rx_channel;
	347	unsigned int number_tx_channel;
9eb12474	348	/* TX and RX number of queues */
	349	unsigned int number_rx_queues;
	350	unsigned int number_tx_queues;
9a8a02c9 JA	351	/* PPS output */
9a8a02c9 JA	352	unsigned int pps_out_num;
ceb69499	353	/* Alternate (enhanced) DESC mode */
e7434821	354	unsigned int enh_desc;
11fbf811 TR	355	/* TX and RX FIFO sizes */
	356	unsigned int tx_fifo_size;
	357	unsigned int rx_fifo_size;
8bf993a5 JA	358	/* Automotive Safety Package */
8bf993a5 JA	359	unsigned int asp;
4dbbe8dd JA	360	/* RX Parser */
	361	unsigned int frpsel;
	362	unsigned int frpbs;
	363	unsigned int frpes;
a993db88	364	unsigned int addr64;
76067459	365	unsigned int rssen;
3cd1cfcb	366	unsigned int vlhash;
67afd6d1	367	unsigned int sphen;
30d93227 JA	368	unsigned int vlins;
30d93227 JA	369	unsigned int dvlan;
425eabdd	370	unsigned int l3l4fnum;
5904a980	371	unsigned int arpoffsel;
504723af JA	372	/* TSN Features */
	373	unsigned int estwid;
	374	unsigned int estdep;
	375	unsigned int estsel;
1ac14241	376	unsigned int fpesel;
430b383c	377	unsigned int tbssel;
e7434821 GC	378	};
e7434821 GC	379
86051317 JA	380	/* RX Buffer size must be multiple of 4/8/16 bytes */
86051317 JA	381	#define BUF_SIZE_16KiB 16368
8137b6ef	382	#define BUF_SIZE_8KiB 8188
aec7ff27 GC	383	#define BUF_SIZE_4KiB 4096
aec7ff27 GC	384	#define BUF_SIZE_2KiB 2048
47dd7a54	385
aec7ff27 GC	386	/* Power Down and WOL */
	387	#define PMT_NOT_SUPPORTED 0
	388	#define PMT_SUPPORTED 1
47dd7a54	389
aec7ff27 GC	390	/* Common MAC defines */
	391	#define MAC_CTRL_REG 0x00000000 /* MAC Control */
	392	#define MAC_ENABLE_TX 0x00000008 /* Transmitter Enable */
28089222	393	#define MAC_ENABLE_RX 0x00000004 /* Receiver Enable */
47dd7a54	394
d765955d	395	/* Default LPI timers */
f5351ef7	396	#define STMMAC_DEFAULT_LIT_LS 0x3E8
438a62b1	397	#define STMMAC_DEFAULT_TWT_LS 0x1E
d765955d	398
4a7d666a GC	399	#define STMMAC_CHAIN_MODE 0x1
	400	#define STMMAC_RING_MODE 0x2
	401
2618abb7 VB	402	#define JUMBO_LEN 9000
2618abb7 VB	403
76067459 JA	404	/* Receive Side Scaling */
	405	#define STMMAC_RSS_HASH_KEY_SIZE 40
	406	#define STMMAC_RSS_MAX_TABLE_SIZE 256
	407
30d93227 JA	408	/* VLAN */
	409	#define STMMAC_VLAN_NONE 0x0
	410	#define STMMAC_VLAN_REMOVE 0x1
	411	#define STMMAC_VLAN_INSERT 0x2
	412	#define STMMAC_VLAN_REPLACE 0x3
	413
915af656 AS	414	extern const struct stmmac_desc_ops enh_desc_ops;
	415	extern const struct stmmac_desc_ops ndesc_ops;
	416
7ed24bbe VB	417	struct mac_device_info;
7ed24bbe VB	418
915af656	419	extern const struct stmmac_hwtimestamp stmmac_ptp;
48863ce5	420	extern const struct stmmac_mode_ops dwmac4_ring_mode_ops;
915af656	421
47dd7a54	422	struct mac_link {
ca84dfb9 LC	423	u32 speed_mask;
	424	u32 speed10;
	425	u32 speed100;
	426	u32 speed1000;
2142754f	427	u32 speed2500;
ca84dfb9	428	u32 duplex;
5b0d7d7d JA	429	struct {
	430	u32 speed2500;
	431	u32 speed5000;
	432	u32 speed10000;
	433	} xgmii;
8a880936 JA	434	struct {
	435	u32 speed25000;
	436	u32 speed40000;
	437	u32 speed50000;
	438	u32 speed100000;
	439	} xlgmii;
47dd7a54 GC	440	};
	441
	442	struct mii_regs {
	443	unsigned int addr; /* MII Address */
	444	unsigned int data; /* MII Data */
b91dce4c LC	445	unsigned int addr_shift; /* MII address shift */
	446	unsigned int reg_shift; /* MII reg shift */
	447	unsigned int addr_mask; /* MII address mask */
	448	unsigned int reg_mask; /* MII reg mask */
	449	unsigned int clk_csr_shift;
	450	unsigned int clk_csr_mask;
47dd7a54 GC	451	};
47dd7a54 GC	452
47dd7a54	453	struct mac_device_info {
ceb69499 GC	454	const struct stmmac_ops *mac;
	455	const struct stmmac_desc_ops *desc;
	456	const struct stmmac_dma_ops *dma;
29896a67	457	const struct stmmac_mode_ops *mode;
891434b1	458	const struct stmmac_hwtimestamp *ptp;
4dbbe8dd	459	const struct stmmac_tc_ops *tc;
3b1dd2c5	460	const struct stmmac_mmc_ops *mmc;
f213bbe8 JA	461	const struct mdio_xpcs_ops *xpcs;
f213bbe8 JA	462	struct mdio_xpcs_args xpcs_args;
db98a0b0 GC	463	struct mii_regs mii; /* MII register Addresses */
db98a0b0 GC	464	struct mac_link link;
7ed24bbe	465	void __iomem pcsr; / vpointer to device CSRs */
b8ef7020 BH	466	unsigned int multicast_filter_bins;
	467	unsigned int unicast_filter_entries;
	468	unsigned int mcast_bits_log2;
d2afb5bd	469	unsigned int rx_csum;
3fe5cadb GC	470	unsigned int pcs;
3fe5cadb GC	471	unsigned int pmt;
02e57b9d	472	unsigned int ps;
4a4ccde0	473	unsigned int xlgmac;
ed64639b WVK	474	unsigned int num_vlan;
ed64639b WVK	475	u32 vlan_filter[32];
c89f44ff	476	unsigned int promisc;
47dd7a54 GC	477	};
47dd7a54 GC	478
abe80fdc JP	479	struct stmmac_rx_routing {
	480	u32 reg_mask;
	481	u32 reg_shift;
	482	};
	483
5f0456b4 JA	484	int dwmac100_setup(struct stmmac_priv *priv);
	485	int dwmac1000_setup(struct stmmac_priv *priv);
	486	int dwmac4_setup(struct stmmac_priv *priv);
2142754f	487	int dwxgmac2_setup(struct stmmac_priv *priv);
4a4ccde0	488	int dwxlgmac2_setup(struct stmmac_priv *priv);
aec7ff27	489
d6cc64ef JP	490	void stmmac_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
	491	unsigned int high, unsigned int low);
	492	void stmmac_get_mac_addr(void __iomem ioaddr, unsigned char addr,
	493	unsigned int high, unsigned int low);
d6cc64ef	494	void stmmac_set_mac(void __iomem *ioaddr, bool enable);
bfab27a1	495
477286b5 AT	496	void stmmac_dwmac4_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
	497	unsigned int high, unsigned int low);
	498	void stmmac_dwmac4_get_mac_addr(void __iomem ioaddr, unsigned char addr,
	499	unsigned int high, unsigned int low);
	500	void stmmac_dwmac4_set_mac(void __iomem *ioaddr, bool enable);
	501
d6cc64ef	502	void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);
70523e63	503
29896a67 GC	504	extern const struct stmmac_mode_ops ring_mode_ops;
29896a67 GC	505	extern const struct stmmac_mode_ops chain_mode_ops;
f748be53	506	extern const struct stmmac_desc_ops dwmac4_desc_ops;
bd4242df RK	507
bd4242df RK	508	#endif /* __COMMON_H__ */