xref: /OK3568_Linux_fs/kernel/drivers/net/ethernet/atheros/atl1c/atl1c.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright(c) 2008 - 2009 Atheros Corporation. All rights reserved.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Derived from Intel e1000 driver
6*4882a593Smuzhiyun  * Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef _ATL1C_H_
10*4882a593Smuzhiyun #define _ATL1C_H_
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/interrupt.h>
13*4882a593Smuzhiyun #include <linux/types.h>
14*4882a593Smuzhiyun #include <linux/errno.h>
15*4882a593Smuzhiyun #include <linux/module.h>
16*4882a593Smuzhiyun #include <linux/pci.h>
17*4882a593Smuzhiyun #include <linux/netdevice.h>
18*4882a593Smuzhiyun #include <linux/etherdevice.h>
19*4882a593Smuzhiyun #include <linux/skbuff.h>
20*4882a593Smuzhiyun #include <linux/ioport.h>
21*4882a593Smuzhiyun #include <linux/slab.h>
22*4882a593Smuzhiyun #include <linux/list.h>
23*4882a593Smuzhiyun #include <linux/delay.h>
24*4882a593Smuzhiyun #include <linux/sched.h>
25*4882a593Smuzhiyun #include <linux/in.h>
26*4882a593Smuzhiyun #include <linux/ip.h>
27*4882a593Smuzhiyun #include <linux/ipv6.h>
28*4882a593Smuzhiyun #include <linux/udp.h>
29*4882a593Smuzhiyun #include <linux/mii.h>
30*4882a593Smuzhiyun #include <linux/io.h>
31*4882a593Smuzhiyun #include <linux/vmalloc.h>
32*4882a593Smuzhiyun #include <linux/pagemap.h>
33*4882a593Smuzhiyun #include <linux/tcp.h>
34*4882a593Smuzhiyun #include <linux/ethtool.h>
35*4882a593Smuzhiyun #include <linux/if_vlan.h>
36*4882a593Smuzhiyun #include <linux/workqueue.h>
37*4882a593Smuzhiyun #include <net/checksum.h>
38*4882a593Smuzhiyun #include <net/ip6_checksum.h>
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun #include "atl1c_hw.h"
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun /* Wake Up Filter Control */
43*4882a593Smuzhiyun #define AT_WUFC_LNKC 0x00000001 /* Link Status Change Wakeup Enable */
44*4882a593Smuzhiyun #define AT_WUFC_MAG  0x00000002 /* Magic Packet Wakeup Enable */
45*4882a593Smuzhiyun #define AT_WUFC_EX   0x00000004 /* Directed Exact Wakeup Enable */
46*4882a593Smuzhiyun #define AT_WUFC_MC   0x00000008 /* Multicast Wakeup Enable */
47*4882a593Smuzhiyun #define AT_WUFC_BC   0x00000010 /* Broadcast Wakeup Enable */
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun #define AT_VLAN_TO_TAG(_vlan, _tag)	   \
50*4882a593Smuzhiyun 	_tag =  ((((_vlan) >> 8) & 0xFF)  |\
51*4882a593Smuzhiyun 		 (((_vlan) & 0xFF) << 8))
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun #define AT_TAG_TO_VLAN(_tag, _vlan) 	 \
54*4882a593Smuzhiyun 	_vlan = ((((_tag) >> 8) & 0xFF) |\
55*4882a593Smuzhiyun 		(((_tag) & 0xFF) << 8))
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #define SPEED_0		   0xffff
58*4882a593Smuzhiyun #define HALF_DUPLEX        1
59*4882a593Smuzhiyun #define FULL_DUPLEX        2
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun #define AT_RX_BUF_SIZE		(ETH_FRAME_LEN + VLAN_HLEN + ETH_FCS_LEN)
62*4882a593Smuzhiyun #define MAX_JUMBO_FRAME_SIZE	(6*1024)
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun #define AT_MAX_RECEIVE_QUEUE    4
65*4882a593Smuzhiyun #define AT_DEF_RECEIVE_QUEUE	1
66*4882a593Smuzhiyun #define AT_MAX_TRANSMIT_QUEUE	2
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun #define AT_DMA_HI_ADDR_MASK     0xffffffff00000000ULL
69*4882a593Smuzhiyun #define AT_DMA_LO_ADDR_MASK     0x00000000ffffffffULL
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun #define AT_TX_WATCHDOG  (5 * HZ)
72*4882a593Smuzhiyun #define AT_MAX_INT_WORK		5
73*4882a593Smuzhiyun #define AT_TWSI_EEPROM_TIMEOUT 	100
74*4882a593Smuzhiyun #define AT_HW_MAX_IDLE_DELAY 	10
75*4882a593Smuzhiyun #define AT_SUSPEND_LINK_TIMEOUT 100
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun #define AT_ASPM_L0S_TIMER	6
78*4882a593Smuzhiyun #define AT_ASPM_L1_TIMER	12
79*4882a593Smuzhiyun #define AT_LCKDET_TIMER		12
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun #define ATL1C_PCIE_L0S_L1_DISABLE 	0x01
82*4882a593Smuzhiyun #define ATL1C_PCIE_PHY_RESET		0x02
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun #define ATL1C_ASPM_L0s_ENABLE		0x0001
85*4882a593Smuzhiyun #define ATL1C_ASPM_L1_ENABLE		0x0002
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun #define AT_REGS_LEN	(74 * sizeof(u32))
88*4882a593Smuzhiyun #define AT_EEPROM_LEN 	512
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun #define ATL1C_GET_DESC(R, i, type)	(&(((type *)((R)->desc))[i]))
91*4882a593Smuzhiyun #define ATL1C_RFD_DESC(R, i)	ATL1C_GET_DESC(R, i, struct atl1c_rx_free_desc)
92*4882a593Smuzhiyun #define ATL1C_TPD_DESC(R, i)	ATL1C_GET_DESC(R, i, struct atl1c_tpd_desc)
93*4882a593Smuzhiyun #define ATL1C_RRD_DESC(R, i)	ATL1C_GET_DESC(R, i, struct atl1c_recv_ret_status)
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun /* tpd word 1 bit 0:7 General Checksum task offload */
96*4882a593Smuzhiyun #define TPD_L4HDR_OFFSET_MASK	0x00FF
97*4882a593Smuzhiyun #define TPD_L4HDR_OFFSET_SHIFT	0
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun /* tpd word 1 bit 0:7 Large Send task offload (IPv4/IPV6) */
100*4882a593Smuzhiyun #define TPD_TCPHDR_OFFSET_MASK	0x00FF
101*4882a593Smuzhiyun #define TPD_TCPHDR_OFFSET_SHIFT	0
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun /* tpd word 1 bit 0:7 Custom Checksum task offload */
104*4882a593Smuzhiyun #define TPD_PLOADOFFSET_MASK	0x00FF
105*4882a593Smuzhiyun #define TPD_PLOADOFFSET_SHIFT	0
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun /* tpd word 1 bit 8:17 */
108*4882a593Smuzhiyun #define TPD_CCSUM_EN_MASK	0x0001
109*4882a593Smuzhiyun #define TPD_CCSUM_EN_SHIFT	8
110*4882a593Smuzhiyun #define TPD_IP_CSUM_MASK	0x0001
111*4882a593Smuzhiyun #define TPD_IP_CSUM_SHIFT	9
112*4882a593Smuzhiyun #define TPD_TCP_CSUM_MASK	0x0001
113*4882a593Smuzhiyun #define TPD_TCP_CSUM_SHIFT	10
114*4882a593Smuzhiyun #define TPD_UDP_CSUM_MASK	0x0001
115*4882a593Smuzhiyun #define TPD_UDP_CSUM_SHIFT	11
116*4882a593Smuzhiyun #define TPD_LSO_EN_MASK		0x0001	/* TCP Large Send Offload */
117*4882a593Smuzhiyun #define TPD_LSO_EN_SHIFT	12
118*4882a593Smuzhiyun #define TPD_LSO_VER_MASK	0x0001
119*4882a593Smuzhiyun #define TPD_LSO_VER_SHIFT	13 	/* 0 : ipv4; 1 : ipv4/ipv6 */
120*4882a593Smuzhiyun #define TPD_CON_VTAG_MASK	0x0001
121*4882a593Smuzhiyun #define TPD_CON_VTAG_SHIFT	14
122*4882a593Smuzhiyun #define TPD_INS_VTAG_MASK	0x0001
123*4882a593Smuzhiyun #define TPD_INS_VTAG_SHIFT	15
124*4882a593Smuzhiyun #define TPD_IPV4_PACKET_MASK	0x0001  /* valid when LSO VER  is 1 */
125*4882a593Smuzhiyun #define TPD_IPV4_PACKET_SHIFT	16
126*4882a593Smuzhiyun #define TPD_ETH_TYPE_MASK	0x0001
127*4882a593Smuzhiyun #define TPD_ETH_TYPE_SHIFT	17	/* 0 : 802.3 frame; 1 : Ethernet */
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun /* tpd word 18:25 Custom Checksum task offload */
130*4882a593Smuzhiyun #define TPD_CCSUM_OFFSET_MASK	0x00FF
131*4882a593Smuzhiyun #define TPD_CCSUM_OFFSET_SHIFT	18
132*4882a593Smuzhiyun #define TPD_CCSUM_EPAD_MASK	0x0001
133*4882a593Smuzhiyun #define TPD_CCSUM_EPAD_SHIFT	30
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun /* tpd word 18:30 Large Send task offload (IPv4/IPV6) */
136*4882a593Smuzhiyun #define TPD_MSS_MASK            0x1FFF
137*4882a593Smuzhiyun #define TPD_MSS_SHIFT		18
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun #define TPD_EOP_MASK		0x0001
140*4882a593Smuzhiyun #define TPD_EOP_SHIFT		31
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun struct atl1c_tpd_desc {
143*4882a593Smuzhiyun 	__le16	buffer_len; /* include 4-byte CRC */
144*4882a593Smuzhiyun 	__le16	vlan_tag;
145*4882a593Smuzhiyun 	__le32	word1;
146*4882a593Smuzhiyun 	__le64	buffer_addr;
147*4882a593Smuzhiyun };
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun struct atl1c_tpd_ext_desc {
150*4882a593Smuzhiyun 	u32 reservd_0;
151*4882a593Smuzhiyun 	__le32 word1;
152*4882a593Smuzhiyun 	__le32 pkt_len;
153*4882a593Smuzhiyun 	u32 reservd_1;
154*4882a593Smuzhiyun };
155*4882a593Smuzhiyun /* rrs word 0 bit 0:31 */
156*4882a593Smuzhiyun #define RRS_RX_CSUM_MASK	0xFFFF
157*4882a593Smuzhiyun #define RRS_RX_CSUM_SHIFT	0
158*4882a593Smuzhiyun #define RRS_RX_RFD_CNT_MASK	0x000F
159*4882a593Smuzhiyun #define RRS_RX_RFD_CNT_SHIFT	16
160*4882a593Smuzhiyun #define RRS_RX_RFD_INDEX_MASK	0x0FFF
161*4882a593Smuzhiyun #define RRS_RX_RFD_INDEX_SHIFT	20
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun /* rrs flag bit 0:16 */
164*4882a593Smuzhiyun #define RRS_HEAD_LEN_MASK	0x00FF
165*4882a593Smuzhiyun #define RRS_HEAD_LEN_SHIFT	0
166*4882a593Smuzhiyun #define RRS_HDS_TYPE_MASK	0x0003
167*4882a593Smuzhiyun #define RRS_HDS_TYPE_SHIFT	8
168*4882a593Smuzhiyun #define RRS_CPU_NUM_MASK	0x0003
169*4882a593Smuzhiyun #define	RRS_CPU_NUM_SHIFT	10
170*4882a593Smuzhiyun #define RRS_HASH_FLG_MASK	0x000F
171*4882a593Smuzhiyun #define RRS_HASH_FLG_SHIFT	12
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun #define RRS_HDS_TYPE_HEAD	1
174*4882a593Smuzhiyun #define RRS_HDS_TYPE_DATA	2
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun #define RRS_IS_NO_HDS_TYPE(flag) \
177*4882a593Smuzhiyun 	((((flag) >> (RRS_HDS_TYPE_SHIFT)) & RRS_HDS_TYPE_MASK) == 0)
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun #define RRS_IS_HDS_HEAD(flag) \
180*4882a593Smuzhiyun 	((((flag) >> (RRS_HDS_TYPE_SHIFT)) & RRS_HDS_TYPE_MASK) == \
181*4882a593Smuzhiyun 			RRS_HDS_TYPE_HEAD)
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun #define RRS_IS_HDS_DATA(flag) \
184*4882a593Smuzhiyun 	((((flag) >> (RRS_HDS_TYPE_SHIFT)) & RRS_HDS_TYPE_MASK) == \
185*4882a593Smuzhiyun 			RRS_HDS_TYPE_DATA)
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun /* rrs word 3 bit 0:31 */
188*4882a593Smuzhiyun #define RRS_PKT_SIZE_MASK	0x3FFF
189*4882a593Smuzhiyun #define RRS_PKT_SIZE_SHIFT	0
190*4882a593Smuzhiyun #define RRS_ERR_L4_CSUM_MASK	0x0001
191*4882a593Smuzhiyun #define RRS_ERR_L4_CSUM_SHIFT	14
192*4882a593Smuzhiyun #define RRS_ERR_IP_CSUM_MASK	0x0001
193*4882a593Smuzhiyun #define RRS_ERR_IP_CSUM_SHIFT	15
194*4882a593Smuzhiyun #define RRS_VLAN_INS_MASK	0x0001
195*4882a593Smuzhiyun #define RRS_VLAN_INS_SHIFT	16
196*4882a593Smuzhiyun #define RRS_PROT_ID_MASK	0x0007
197*4882a593Smuzhiyun #define RRS_PROT_ID_SHIFT	17
198*4882a593Smuzhiyun #define RRS_RX_ERR_SUM_MASK	0x0001
199*4882a593Smuzhiyun #define RRS_RX_ERR_SUM_SHIFT	20
200*4882a593Smuzhiyun #define RRS_RX_ERR_CRC_MASK	0x0001
201*4882a593Smuzhiyun #define RRS_RX_ERR_CRC_SHIFT	21
202*4882a593Smuzhiyun #define RRS_RX_ERR_FAE_MASK	0x0001
203*4882a593Smuzhiyun #define RRS_RX_ERR_FAE_SHIFT	22
204*4882a593Smuzhiyun #define RRS_RX_ERR_TRUNC_MASK	0x0001
205*4882a593Smuzhiyun #define RRS_RX_ERR_TRUNC_SHIFT	23
206*4882a593Smuzhiyun #define RRS_RX_ERR_RUNC_MASK	0x0001
207*4882a593Smuzhiyun #define RRS_RX_ERR_RUNC_SHIFT	24
208*4882a593Smuzhiyun #define RRS_RX_ERR_ICMP_MASK	0x0001
209*4882a593Smuzhiyun #define RRS_RX_ERR_ICMP_SHIFT	25
210*4882a593Smuzhiyun #define RRS_PACKET_BCAST_MASK	0x0001
211*4882a593Smuzhiyun #define RRS_PACKET_BCAST_SHIFT	26
212*4882a593Smuzhiyun #define RRS_PACKET_MCAST_MASK	0x0001
213*4882a593Smuzhiyun #define RRS_PACKET_MCAST_SHIFT	27
214*4882a593Smuzhiyun #define RRS_PACKET_TYPE_MASK	0x0001
215*4882a593Smuzhiyun #define RRS_PACKET_TYPE_SHIFT	28
216*4882a593Smuzhiyun #define RRS_FIFO_FULL_MASK	0x0001
217*4882a593Smuzhiyun #define RRS_FIFO_FULL_SHIFT	29
218*4882a593Smuzhiyun #define RRS_802_3_LEN_ERR_MASK 	0x0001
219*4882a593Smuzhiyun #define RRS_802_3_LEN_ERR_SHIFT 30
220*4882a593Smuzhiyun #define RRS_RXD_UPDATED_MASK	0x0001
221*4882a593Smuzhiyun #define RRS_RXD_UPDATED_SHIFT	31
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun #define RRS_ERR_L4_CSUM         0x00004000
224*4882a593Smuzhiyun #define RRS_ERR_IP_CSUM         0x00008000
225*4882a593Smuzhiyun #define RRS_VLAN_INS            0x00010000
226*4882a593Smuzhiyun #define RRS_RX_ERR_SUM          0x00100000
227*4882a593Smuzhiyun #define RRS_RX_ERR_CRC          0x00200000
228*4882a593Smuzhiyun #define RRS_802_3_LEN_ERR	0x40000000
229*4882a593Smuzhiyun #define RRS_RXD_UPDATED		0x80000000
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun #define RRS_PACKET_TYPE_802_3  	1
232*4882a593Smuzhiyun #define RRS_PACKET_TYPE_ETH	0
233*4882a593Smuzhiyun #define RRS_PACKET_IS_ETH(word) \
234*4882a593Smuzhiyun 	((((word) >> RRS_PACKET_TYPE_SHIFT) & RRS_PACKET_TYPE_MASK) == \
235*4882a593Smuzhiyun 			RRS_PACKET_TYPE_ETH)
236*4882a593Smuzhiyun #define RRS_RXD_IS_VALID(word) \
237*4882a593Smuzhiyun 	((((word) >> RRS_RXD_UPDATED_SHIFT) & RRS_RXD_UPDATED_MASK) == 1)
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun #define RRS_PACKET_PROT_IS_IPV4_ONLY(word) \
240*4882a593Smuzhiyun 	((((word) >> RRS_PROT_ID_SHIFT) & RRS_PROT_ID_MASK) == 1)
241*4882a593Smuzhiyun #define RRS_PACKET_PROT_IS_IPV6_ONLY(word) \
242*4882a593Smuzhiyun 	((((word) >> RRS_PROT_ID_SHIFT) & RRS_PROT_ID_MASK) == 6)
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun struct atl1c_recv_ret_status {
245*4882a593Smuzhiyun 	__le32  word0;
246*4882a593Smuzhiyun 	__le32	rss_hash;
247*4882a593Smuzhiyun 	__le16	vlan_tag;
248*4882a593Smuzhiyun 	__le16	flag;
249*4882a593Smuzhiyun 	__le32	word3;
250*4882a593Smuzhiyun };
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun /* RFD descriptor */
253*4882a593Smuzhiyun struct atl1c_rx_free_desc {
254*4882a593Smuzhiyun 	__le64	buffer_addr;
255*4882a593Smuzhiyun };
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun /* DMA Order Settings */
258*4882a593Smuzhiyun enum atl1c_dma_order {
259*4882a593Smuzhiyun 	atl1c_dma_ord_in = 1,
260*4882a593Smuzhiyun 	atl1c_dma_ord_enh = 2,
261*4882a593Smuzhiyun 	atl1c_dma_ord_out = 4
262*4882a593Smuzhiyun };
263*4882a593Smuzhiyun 
264*4882a593Smuzhiyun enum atl1c_dma_rcb {
265*4882a593Smuzhiyun 	atl1c_rcb_64 = 0,
266*4882a593Smuzhiyun 	atl1c_rcb_128 = 1
267*4882a593Smuzhiyun };
268*4882a593Smuzhiyun 
269*4882a593Smuzhiyun enum atl1c_mac_speed {
270*4882a593Smuzhiyun 	atl1c_mac_speed_0 = 0,
271*4882a593Smuzhiyun 	atl1c_mac_speed_10_100 = 1,
272*4882a593Smuzhiyun 	atl1c_mac_speed_1000 = 2
273*4882a593Smuzhiyun };
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun enum atl1c_dma_req_block {
276*4882a593Smuzhiyun 	atl1c_dma_req_128 = 0,
277*4882a593Smuzhiyun 	atl1c_dma_req_256 = 1,
278*4882a593Smuzhiyun 	atl1c_dma_req_512 = 2,
279*4882a593Smuzhiyun 	atl1c_dma_req_1024 = 3,
280*4882a593Smuzhiyun 	atl1c_dma_req_2048 = 4,
281*4882a593Smuzhiyun 	atl1c_dma_req_4096 = 5
282*4882a593Smuzhiyun };
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun enum atl1c_nic_type {
286*4882a593Smuzhiyun 	athr_l1c = 0,
287*4882a593Smuzhiyun 	athr_l2c = 1,
288*4882a593Smuzhiyun 	athr_l2c_b,
289*4882a593Smuzhiyun 	athr_l2c_b2,
290*4882a593Smuzhiyun 	athr_l1d,
291*4882a593Smuzhiyun 	athr_l1d_2,
292*4882a593Smuzhiyun };
293*4882a593Smuzhiyun 
294*4882a593Smuzhiyun enum atl1c_trans_queue {
295*4882a593Smuzhiyun 	atl1c_trans_normal = 0,
296*4882a593Smuzhiyun 	atl1c_trans_high = 1
297*4882a593Smuzhiyun };
298*4882a593Smuzhiyun 
299*4882a593Smuzhiyun struct atl1c_hw_stats {
300*4882a593Smuzhiyun 	/* rx */
301*4882a593Smuzhiyun 	unsigned long rx_ok;		/* The number of good packet received. */
302*4882a593Smuzhiyun 	unsigned long rx_bcast;		/* The number of good broadcast packet received. */
303*4882a593Smuzhiyun 	unsigned long rx_mcast;		/* The number of good multicast packet received. */
304*4882a593Smuzhiyun 	unsigned long rx_pause;		/* The number of Pause packet received. */
305*4882a593Smuzhiyun 	unsigned long rx_ctrl;		/* The number of Control packet received other than Pause frame. */
306*4882a593Smuzhiyun 	unsigned long rx_fcs_err;	/* The number of packets with bad FCS. */
307*4882a593Smuzhiyun 	unsigned long rx_len_err;	/* The number of packets with mismatch of length field and actual size. */
308*4882a593Smuzhiyun 	unsigned long rx_byte_cnt;	/* The number of bytes of good packet received. FCS is NOT included. */
309*4882a593Smuzhiyun 	unsigned long rx_runt;		/* The number of packets received that are less than 64 byte long and with good FCS. */
310*4882a593Smuzhiyun 	unsigned long rx_frag;		/* The number of packets received that are less than 64 byte long and with bad FCS. */
311*4882a593Smuzhiyun 	unsigned long rx_sz_64;		/* The number of good and bad packets received that are 64 byte long. */
312*4882a593Smuzhiyun 	unsigned long rx_sz_65_127;	/* The number of good and bad packets received that are between 65 and 127-byte long. */
313*4882a593Smuzhiyun 	unsigned long rx_sz_128_255;	/* The number of good and bad packets received that are between 128 and 255-byte long. */
314*4882a593Smuzhiyun 	unsigned long rx_sz_256_511;	/* The number of good and bad packets received that are between 256 and 511-byte long. */
315*4882a593Smuzhiyun 	unsigned long rx_sz_512_1023;	/* The number of good and bad packets received that are between 512 and 1023-byte long. */
316*4882a593Smuzhiyun 	unsigned long rx_sz_1024_1518;	/* The number of good and bad packets received that are between 1024 and 1518-byte long. */
317*4882a593Smuzhiyun 	unsigned long rx_sz_1519_max;	/* The number of good and bad packets received that are between 1519-byte and MTU. */
318*4882a593Smuzhiyun 	unsigned long rx_sz_ov;		/* The number of good and bad packets received that are more than MTU size truncated by Selene. */
319*4882a593Smuzhiyun 	unsigned long rx_rxf_ov;	/* The number of frame dropped due to occurrence of RX FIFO overflow. */
320*4882a593Smuzhiyun 	unsigned long rx_rrd_ov;	/* The number of frame dropped due to occurrence of RRD overflow. */
321*4882a593Smuzhiyun 	unsigned long rx_align_err;	/* Alignment Error */
322*4882a593Smuzhiyun 	unsigned long rx_bcast_byte_cnt; /* The byte count of broadcast packet received, excluding FCS. */
323*4882a593Smuzhiyun 	unsigned long rx_mcast_byte_cnt; /* The byte count of multicast packet received, excluding FCS. */
324*4882a593Smuzhiyun 	unsigned long rx_err_addr;	/* The number of packets dropped due to address filtering. */
325*4882a593Smuzhiyun 
326*4882a593Smuzhiyun 	/* tx */
327*4882a593Smuzhiyun 	unsigned long tx_ok;		/* The number of good packet transmitted. */
328*4882a593Smuzhiyun 	unsigned long tx_bcast;		/* The number of good broadcast packet transmitted. */
329*4882a593Smuzhiyun 	unsigned long tx_mcast;		/* The number of good multicast packet transmitted. */
330*4882a593Smuzhiyun 	unsigned long tx_pause;		/* The number of Pause packet transmitted. */
331*4882a593Smuzhiyun 	unsigned long tx_exc_defer;	/* The number of packets transmitted with excessive deferral. */
332*4882a593Smuzhiyun 	unsigned long tx_ctrl;		/* The number of packets transmitted is a control frame, excluding Pause frame. */
333*4882a593Smuzhiyun 	unsigned long tx_defer;		/* The number of packets transmitted that is deferred. */
334*4882a593Smuzhiyun 	unsigned long tx_byte_cnt;	/* The number of bytes of data transmitted. FCS is NOT included. */
335*4882a593Smuzhiyun 	unsigned long tx_sz_64;		/* The number of good and bad packets transmitted that are 64 byte long. */
336*4882a593Smuzhiyun 	unsigned long tx_sz_65_127;	/* The number of good and bad packets transmitted that are between 65 and 127-byte long. */
337*4882a593Smuzhiyun 	unsigned long tx_sz_128_255;	/* The number of good and bad packets transmitted that are between 128 and 255-byte long. */
338*4882a593Smuzhiyun 	unsigned long tx_sz_256_511;	/* The number of good and bad packets transmitted that are between 256 and 511-byte long. */
339*4882a593Smuzhiyun 	unsigned long tx_sz_512_1023;	/* The number of good and bad packets transmitted that are between 512 and 1023-byte long. */
340*4882a593Smuzhiyun 	unsigned long tx_sz_1024_1518;	/* The number of good and bad packets transmitted that are between 1024 and 1518-byte long. */
341*4882a593Smuzhiyun 	unsigned long tx_sz_1519_max;	/* The number of good and bad packets transmitted that are between 1519-byte and MTU. */
342*4882a593Smuzhiyun 	unsigned long tx_1_col;		/* The number of packets subsequently transmitted successfully with a single prior collision. */
343*4882a593Smuzhiyun 	unsigned long tx_2_col;		/* The number of packets subsequently transmitted successfully with multiple prior collisions. */
344*4882a593Smuzhiyun 	unsigned long tx_late_col;	/* The number of packets transmitted with late collisions. */
345*4882a593Smuzhiyun 	unsigned long tx_abort_col;	/* The number of transmit packets aborted due to excessive collisions. */
346*4882a593Smuzhiyun 	unsigned long tx_underrun;	/* The number of transmit packets aborted due to transmit FIFO underrun, or TRD FIFO underrun */
347*4882a593Smuzhiyun 	unsigned long tx_rd_eop;	/* The number of times that read beyond the EOP into the next frame area when TRD was not written timely */
348*4882a593Smuzhiyun 	unsigned long tx_len_err;	/* The number of transmit packets with length field does NOT match the actual frame size. */
349*4882a593Smuzhiyun 	unsigned long tx_trunc;		/* The number of transmit packets truncated due to size exceeding MTU. */
350*4882a593Smuzhiyun 	unsigned long tx_bcast_byte;	/* The byte count of broadcast packet transmitted, excluding FCS. */
351*4882a593Smuzhiyun 	unsigned long tx_mcast_byte;	/* The byte count of multicast packet transmitted, excluding FCS. */
352*4882a593Smuzhiyun };
353*4882a593Smuzhiyun 
354*4882a593Smuzhiyun struct atl1c_hw {
355*4882a593Smuzhiyun 	u8 __iomem      *hw_addr;            /* inner register address */
356*4882a593Smuzhiyun 	struct atl1c_adapter *adapter;
357*4882a593Smuzhiyun 	enum atl1c_nic_type  nic_type;
358*4882a593Smuzhiyun 	enum atl1c_dma_order dma_order;
359*4882a593Smuzhiyun 	enum atl1c_dma_rcb   rcb_value;
360*4882a593Smuzhiyun 	enum atl1c_dma_req_block dmar_block;
361*4882a593Smuzhiyun 
362*4882a593Smuzhiyun 	u16 device_id;
363*4882a593Smuzhiyun 	u16 vendor_id;
364*4882a593Smuzhiyun 	u16 subsystem_id;
365*4882a593Smuzhiyun 	u16 subsystem_vendor_id;
366*4882a593Smuzhiyun 	u8 revision_id;
367*4882a593Smuzhiyun 	u16 phy_id1;
368*4882a593Smuzhiyun 	u16 phy_id2;
369*4882a593Smuzhiyun 
370*4882a593Smuzhiyun 	u32 intr_mask;
371*4882a593Smuzhiyun 
372*4882a593Smuzhiyun 	u8 preamble_len;
373*4882a593Smuzhiyun 	u16 max_frame_size;
374*4882a593Smuzhiyun 	u16 min_frame_size;
375*4882a593Smuzhiyun 
376*4882a593Smuzhiyun 	enum atl1c_mac_speed mac_speed;
377*4882a593Smuzhiyun 	bool mac_duplex;
378*4882a593Smuzhiyun 	bool hibernate;
379*4882a593Smuzhiyun 	u16 media_type;
380*4882a593Smuzhiyun #define MEDIA_TYPE_AUTO_SENSOR  0
381*4882a593Smuzhiyun #define MEDIA_TYPE_100M_FULL    1
382*4882a593Smuzhiyun #define MEDIA_TYPE_100M_HALF    2
383*4882a593Smuzhiyun #define MEDIA_TYPE_10M_FULL     3
384*4882a593Smuzhiyun #define MEDIA_TYPE_10M_HALF     4
385*4882a593Smuzhiyun 
386*4882a593Smuzhiyun 	u16 autoneg_advertised;
387*4882a593Smuzhiyun 	u16 mii_autoneg_adv_reg;
388*4882a593Smuzhiyun 	u16 mii_1000t_ctrl_reg;
389*4882a593Smuzhiyun 
390*4882a593Smuzhiyun 	u16 tx_imt;	/* TX Interrupt Moderator timer ( 2us resolution) */
391*4882a593Smuzhiyun 	u16 rx_imt;	/* RX Interrupt Moderator timer ( 2us resolution) */
392*4882a593Smuzhiyun 	u16 ict;        /* Interrupt Clear timer (2us resolution) */
393*4882a593Smuzhiyun 	u16 ctrl_flags;
394*4882a593Smuzhiyun #define ATL1C_INTR_CLEAR_ON_READ	0x0001
395*4882a593Smuzhiyun #define ATL1C_INTR_MODRT_ENABLE	 	0x0002
396*4882a593Smuzhiyun #define ATL1C_CMB_ENABLE		0x0004
397*4882a593Smuzhiyun #define ATL1C_SMB_ENABLE		0x0010
398*4882a593Smuzhiyun #define ATL1C_TXQ_MODE_ENHANCE		0x0020
399*4882a593Smuzhiyun #define ATL1C_RX_IPV6_CHKSUM		0x0040
400*4882a593Smuzhiyun #define ATL1C_ASPM_L0S_SUPPORT		0x0080
401*4882a593Smuzhiyun #define ATL1C_ASPM_L1_SUPPORT		0x0100
402*4882a593Smuzhiyun #define ATL1C_ASPM_CTRL_MON		0x0200
403*4882a593Smuzhiyun #define ATL1C_HIB_DISABLE		0x0400
404*4882a593Smuzhiyun #define ATL1C_APS_MODE_ENABLE           0x0800
405*4882a593Smuzhiyun #define ATL1C_LINK_EXT_SYNC             0x1000
406*4882a593Smuzhiyun #define ATL1C_CLK_GATING_EN             0x2000
407*4882a593Smuzhiyun #define ATL1C_FPGA_VERSION              0x8000
408*4882a593Smuzhiyun 	u16 link_cap_flags;
409*4882a593Smuzhiyun #define ATL1C_LINK_CAP_1000M		0x0001
410*4882a593Smuzhiyun 	u32 smb_timer;
411*4882a593Smuzhiyun 
412*4882a593Smuzhiyun 	u16 rrd_thresh; /* Threshold of number of RRD produced to trigger
413*4882a593Smuzhiyun 			  interrupt request */
414*4882a593Smuzhiyun 	u16 tpd_thresh;
415*4882a593Smuzhiyun 	u8 tpd_burst;   /* Number of TPD to prefetch in cache-aligned burst. */
416*4882a593Smuzhiyun 	u8 rfd_burst;
417*4882a593Smuzhiyun 	u32 base_cpu;
418*4882a593Smuzhiyun 	u32 indirect_tab;
419*4882a593Smuzhiyun 	u8 mac_addr[ETH_ALEN];
420*4882a593Smuzhiyun 	u8 perm_mac_addr[ETH_ALEN];
421*4882a593Smuzhiyun 
422*4882a593Smuzhiyun 	bool phy_configured;
423*4882a593Smuzhiyun 	bool re_autoneg;
424*4882a593Smuzhiyun 	bool emi_ca;
425*4882a593Smuzhiyun 	bool msi_lnkpatch;	/* link patch for specific platforms */
426*4882a593Smuzhiyun };
427*4882a593Smuzhiyun 
428*4882a593Smuzhiyun /*
429*4882a593Smuzhiyun  * atl1c_ring_header represents a single, contiguous block of DMA space
430*4882a593Smuzhiyun  * mapped for the three descriptor rings (tpd, rfd, rrd) described below
431*4882a593Smuzhiyun  */
432*4882a593Smuzhiyun struct atl1c_ring_header {
433*4882a593Smuzhiyun 	void *desc;		/* virtual address */
434*4882a593Smuzhiyun 	dma_addr_t dma;		/* physical address*/
435*4882a593Smuzhiyun 	unsigned int size;	/* length in bytes */
436*4882a593Smuzhiyun };
437*4882a593Smuzhiyun 
438*4882a593Smuzhiyun /*
439*4882a593Smuzhiyun  * atl1c_buffer is wrapper around a pointer to a socket buffer
440*4882a593Smuzhiyun  * so a DMA handle can be stored along with the skb
441*4882a593Smuzhiyun  */
442*4882a593Smuzhiyun struct atl1c_buffer {
443*4882a593Smuzhiyun 	struct sk_buff *skb;	/* socket buffer */
444*4882a593Smuzhiyun 	u16 length;		/* rx buffer length */
445*4882a593Smuzhiyun 	u16 flags;		/* information of buffer */
446*4882a593Smuzhiyun #define ATL1C_BUFFER_FREE		0x0001
447*4882a593Smuzhiyun #define ATL1C_BUFFER_BUSY		0x0002
448*4882a593Smuzhiyun #define ATL1C_BUFFER_STATE_MASK		0x0003
449*4882a593Smuzhiyun 
450*4882a593Smuzhiyun #define ATL1C_PCIMAP_SINGLE		0x0004
451*4882a593Smuzhiyun #define ATL1C_PCIMAP_PAGE		0x0008
452*4882a593Smuzhiyun #define ATL1C_PCIMAP_TYPE_MASK		0x000C
453*4882a593Smuzhiyun 
454*4882a593Smuzhiyun #define ATL1C_PCIMAP_TODEVICE		0x0010
455*4882a593Smuzhiyun #define ATL1C_PCIMAP_FROMDEVICE		0x0020
456*4882a593Smuzhiyun #define ATL1C_PCIMAP_DIRECTION_MASK	0x0030
457*4882a593Smuzhiyun 	dma_addr_t dma;
458*4882a593Smuzhiyun };
459*4882a593Smuzhiyun 
460*4882a593Smuzhiyun #define ATL1C_SET_BUFFER_STATE(buff, state) do {	\
461*4882a593Smuzhiyun 	((buff)->flags) &= ~ATL1C_BUFFER_STATE_MASK;	\
462*4882a593Smuzhiyun 	((buff)->flags) |= (state);			\
463*4882a593Smuzhiyun 	} while (0)
464*4882a593Smuzhiyun 
465*4882a593Smuzhiyun #define ATL1C_SET_PCIMAP_TYPE(buff, type, direction) do {	\
466*4882a593Smuzhiyun 	((buff)->flags) &= ~ATL1C_PCIMAP_TYPE_MASK;		\
467*4882a593Smuzhiyun 	((buff)->flags) |= (type);				\
468*4882a593Smuzhiyun 	((buff)->flags) &= ~ATL1C_PCIMAP_DIRECTION_MASK;	\
469*4882a593Smuzhiyun 	((buff)->flags) |= (direction);				\
470*4882a593Smuzhiyun 	} while (0)
471*4882a593Smuzhiyun 
472*4882a593Smuzhiyun /* transimit packet descriptor (tpd) ring */
473*4882a593Smuzhiyun struct atl1c_tpd_ring {
474*4882a593Smuzhiyun 	void *desc;		/* descriptor ring virtual address */
475*4882a593Smuzhiyun 	dma_addr_t dma;		/* descriptor ring physical address */
476*4882a593Smuzhiyun 	u16 size;		/* descriptor ring length in bytes */
477*4882a593Smuzhiyun 	u16 count;		/* number of descriptors in the ring */
478*4882a593Smuzhiyun 	u16 next_to_use;
479*4882a593Smuzhiyun 	atomic_t next_to_clean;
480*4882a593Smuzhiyun 	struct atl1c_buffer *buffer_info;
481*4882a593Smuzhiyun };
482*4882a593Smuzhiyun 
483*4882a593Smuzhiyun /* receive free descriptor (rfd) ring */
484*4882a593Smuzhiyun struct atl1c_rfd_ring {
485*4882a593Smuzhiyun 	void *desc;		/* descriptor ring virtual address */
486*4882a593Smuzhiyun 	dma_addr_t dma;		/* descriptor ring physical address */
487*4882a593Smuzhiyun 	u16 size;		/* descriptor ring length in bytes */
488*4882a593Smuzhiyun 	u16 count;		/* number of descriptors in the ring */
489*4882a593Smuzhiyun 	u16 next_to_use;
490*4882a593Smuzhiyun 	u16 next_to_clean;
491*4882a593Smuzhiyun 	struct atl1c_buffer *buffer_info;
492*4882a593Smuzhiyun };
493*4882a593Smuzhiyun 
494*4882a593Smuzhiyun /* receive return descriptor (rrd) ring */
495*4882a593Smuzhiyun struct atl1c_rrd_ring {
496*4882a593Smuzhiyun 	void *desc;		/* descriptor ring virtual address */
497*4882a593Smuzhiyun 	dma_addr_t dma;		/* descriptor ring physical address */
498*4882a593Smuzhiyun 	u16 size;		/* descriptor ring length in bytes */
499*4882a593Smuzhiyun 	u16 count;		/* number of descriptors in the ring */
500*4882a593Smuzhiyun 	u16 next_to_use;
501*4882a593Smuzhiyun 	u16 next_to_clean;
502*4882a593Smuzhiyun };
503*4882a593Smuzhiyun 
504*4882a593Smuzhiyun /* board specific private data structure */
505*4882a593Smuzhiyun struct atl1c_adapter {
506*4882a593Smuzhiyun 	struct net_device   *netdev;
507*4882a593Smuzhiyun 	struct pci_dev      *pdev;
508*4882a593Smuzhiyun 	struct napi_struct  napi;
509*4882a593Smuzhiyun 	struct page         *rx_page;
510*4882a593Smuzhiyun 	unsigned int	    rx_page_offset;
511*4882a593Smuzhiyun 	unsigned int	    rx_frag_size;
512*4882a593Smuzhiyun 	struct atl1c_hw        hw;
513*4882a593Smuzhiyun 	struct atl1c_hw_stats  hw_stats;
514*4882a593Smuzhiyun 	struct mii_if_info  mii;    /* MII interface info */
515*4882a593Smuzhiyun 	u16 rx_buffer_len;
516*4882a593Smuzhiyun 
517*4882a593Smuzhiyun 	unsigned long flags;
518*4882a593Smuzhiyun #define __AT_TESTING        0x0001
519*4882a593Smuzhiyun #define __AT_RESETTING      0x0002
520*4882a593Smuzhiyun #define __AT_DOWN           0x0003
521*4882a593Smuzhiyun 	unsigned long work_event;
522*4882a593Smuzhiyun #define	ATL1C_WORK_EVENT_RESET		0
523*4882a593Smuzhiyun #define	ATL1C_WORK_EVENT_LINK_CHANGE	1
524*4882a593Smuzhiyun 	u32 msg_enable;
525*4882a593Smuzhiyun 
526*4882a593Smuzhiyun 	bool have_msi;
527*4882a593Smuzhiyun 	u32 wol;
528*4882a593Smuzhiyun 	u16 link_speed;
529*4882a593Smuzhiyun 	u16 link_duplex;
530*4882a593Smuzhiyun 
531*4882a593Smuzhiyun 	spinlock_t mdio_lock;
532*4882a593Smuzhiyun 	atomic_t irq_sem;
533*4882a593Smuzhiyun 
534*4882a593Smuzhiyun 	struct work_struct common_task;
535*4882a593Smuzhiyun 	struct timer_list watchdog_timer;
536*4882a593Smuzhiyun 	struct timer_list phy_config_timer;
537*4882a593Smuzhiyun 
538*4882a593Smuzhiyun 	/* All Descriptor memory */
539*4882a593Smuzhiyun 	struct atl1c_ring_header ring_header;
540*4882a593Smuzhiyun 	struct atl1c_tpd_ring tpd_ring[AT_MAX_TRANSMIT_QUEUE];
541*4882a593Smuzhiyun 	struct atl1c_rfd_ring rfd_ring;
542*4882a593Smuzhiyun 	struct atl1c_rrd_ring rrd_ring;
543*4882a593Smuzhiyun 	u32 bd_number;     /* board number;*/
544*4882a593Smuzhiyun };
545*4882a593Smuzhiyun 
546*4882a593Smuzhiyun #define AT_WRITE_REG(a, reg, value) ( \
547*4882a593Smuzhiyun 		writel((value), ((a)->hw_addr + reg)))
548*4882a593Smuzhiyun 
549*4882a593Smuzhiyun #define AT_WRITE_FLUSH(a) (\
550*4882a593Smuzhiyun 		readl((a)->hw_addr))
551*4882a593Smuzhiyun 
552*4882a593Smuzhiyun #define AT_READ_REG(a, reg, pdata) do {					\
553*4882a593Smuzhiyun 		if (unlikely((a)->hibernate)) {				\
554*4882a593Smuzhiyun 			readl((a)->hw_addr + reg);			\
555*4882a593Smuzhiyun 			*(u32 *)pdata = readl((a)->hw_addr + reg);	\
556*4882a593Smuzhiyun 		} else {						\
557*4882a593Smuzhiyun 			*(u32 *)pdata = readl((a)->hw_addr + reg);	\
558*4882a593Smuzhiyun 		}							\
559*4882a593Smuzhiyun 	} while (0)
560*4882a593Smuzhiyun 
561*4882a593Smuzhiyun #define AT_WRITE_REGB(a, reg, value) (\
562*4882a593Smuzhiyun 		writeb((value), ((a)->hw_addr + reg)))
563*4882a593Smuzhiyun 
564*4882a593Smuzhiyun #define AT_READ_REGB(a, reg) (\
565*4882a593Smuzhiyun 		readb((a)->hw_addr + reg))
566*4882a593Smuzhiyun 
567*4882a593Smuzhiyun #define AT_WRITE_REGW(a, reg, value) (\
568*4882a593Smuzhiyun 		writew((value), ((a)->hw_addr + reg)))
569*4882a593Smuzhiyun 
570*4882a593Smuzhiyun #define AT_READ_REGW(a, reg, pdata) do {				\
571*4882a593Smuzhiyun 		if (unlikely((a)->hibernate)) {				\
572*4882a593Smuzhiyun 			readw((a)->hw_addr + reg);			\
573*4882a593Smuzhiyun 			*(u16 *)pdata = readw((a)->hw_addr + reg);	\
574*4882a593Smuzhiyun 		} else {						\
575*4882a593Smuzhiyun 			*(u16 *)pdata = readw((a)->hw_addr + reg);	\
576*4882a593Smuzhiyun 		}							\
577*4882a593Smuzhiyun 	} while (0)
578*4882a593Smuzhiyun 
579*4882a593Smuzhiyun #define AT_WRITE_REG_ARRAY(a, reg, offset, value) ( \
580*4882a593Smuzhiyun 		writel((value), (((a)->hw_addr + reg) + ((offset) << 2))))
581*4882a593Smuzhiyun 
582*4882a593Smuzhiyun #define AT_READ_REG_ARRAY(a, reg, offset) ( \
583*4882a593Smuzhiyun 		readl(((a)->hw_addr + reg) + ((offset) << 2)))
584*4882a593Smuzhiyun 
585*4882a593Smuzhiyun extern char atl1c_driver_name[];
586*4882a593Smuzhiyun 
587*4882a593Smuzhiyun void atl1c_reinit_locked(struct atl1c_adapter *adapter);
588*4882a593Smuzhiyun s32 atl1c_reset_hw(struct atl1c_hw *hw);
589*4882a593Smuzhiyun void atl1c_set_ethtool_ops(struct net_device *netdev);
590*4882a593Smuzhiyun #endif /* _ATL1C_H_ */
591