xref: /OK3568_Linux_fs/kernel/drivers/net/ethernet/atheros/alx/hw.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (c) 2013 Johannes Berg <johannes@sipsolutions.net>
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  *  This file is free software: you may copy, redistribute and/or modify it
5*4882a593Smuzhiyun  *  under the terms of the GNU General Public License as published by the
6*4882a593Smuzhiyun  *  Free Software Foundation, either version 2 of the License, or (at your
7*4882a593Smuzhiyun  *  option) any later version.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  *  This file is distributed in the hope that it will be useful, but
10*4882a593Smuzhiyun  *  WITHOUT ANY WARRANTY; without even the implied warranty of
11*4882a593Smuzhiyun  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12*4882a593Smuzhiyun  *  General Public License for more details.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  *  You should have received a copy of the GNU General Public License
15*4882a593Smuzhiyun  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16*4882a593Smuzhiyun  *
17*4882a593Smuzhiyun  * This file incorporates work covered by the following copyright and
18*4882a593Smuzhiyun  * permission notice:
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * Copyright (c) 2012 Qualcomm Atheros, Inc.
21*4882a593Smuzhiyun  *
22*4882a593Smuzhiyun  * Permission to use, copy, modify, and/or distribute this software for any
23*4882a593Smuzhiyun  * purpose with or without fee is hereby granted, provided that the above
24*4882a593Smuzhiyun  * copyright notice and this permission notice appear in all copies.
25*4882a593Smuzhiyun  *
26*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
27*4882a593Smuzhiyun  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
28*4882a593Smuzhiyun  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
29*4882a593Smuzhiyun  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
30*4882a593Smuzhiyun  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
31*4882a593Smuzhiyun  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
32*4882a593Smuzhiyun  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
33*4882a593Smuzhiyun  */
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #ifndef ALX_HW_H_
36*4882a593Smuzhiyun #define ALX_HW_H_
37*4882a593Smuzhiyun #include <linux/types.h>
38*4882a593Smuzhiyun #include <linux/mdio.h>
39*4882a593Smuzhiyun #include <linux/pci.h>
40*4882a593Smuzhiyun #include <linux/if_vlan.h>
41*4882a593Smuzhiyun #include "reg.h"
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun /* Transmit Packet Descriptor, contains 4 32-bit words.
44*4882a593Smuzhiyun  *
45*4882a593Smuzhiyun  *   31               16               0
46*4882a593Smuzhiyun  *   +----------------+----------------+
47*4882a593Smuzhiyun  *   |    vlan-tag    |   buf length   |
48*4882a593Smuzhiyun  *   +----------------+----------------+
49*4882a593Smuzhiyun  *   |              Word 1             |
50*4882a593Smuzhiyun  *   +----------------+----------------+
51*4882a593Smuzhiyun  *   |      Word 2: buf addr lo        |
52*4882a593Smuzhiyun  *   +----------------+----------------+
53*4882a593Smuzhiyun  *   |      Word 3: buf addr hi        |
54*4882a593Smuzhiyun  *   +----------------+----------------+
55*4882a593Smuzhiyun  *
56*4882a593Smuzhiyun  * Word 2 and 3 combine to form a 64-bit buffer address
57*4882a593Smuzhiyun  *
58*4882a593Smuzhiyun  * Word 1 has three forms, depending on the state of bit 8/12/13:
59*4882a593Smuzhiyun  * if bit8 =='1', the definition is just for custom checksum offload.
60*4882a593Smuzhiyun  * if bit8 == '0' && bit12 == '1' && bit13 == '1', the *FIRST* descriptor
61*4882a593Smuzhiyun  *     for the skb is special for LSO V2, Word 2 become total skb length ,
62*4882a593Smuzhiyun  *     Word 3 is meaningless.
63*4882a593Smuzhiyun  * other condition, the definition is for general skb or ip/tcp/udp
64*4882a593Smuzhiyun  *     checksum or LSO(TSO) offload.
65*4882a593Smuzhiyun  *
66*4882a593Smuzhiyun  * Here is the depiction:
67*4882a593Smuzhiyun  *
68*4882a593Smuzhiyun  *   0-+                                  0-+
69*4882a593Smuzhiyun  *   1 |                                  1 |
70*4882a593Smuzhiyun  *   2 |                                  2 |
71*4882a593Smuzhiyun  *   3 |    Payload offset                3 |    L4 header offset
72*4882a593Smuzhiyun  *   4 |        (7:0)                     4 |        (7:0)
73*4882a593Smuzhiyun  *   5 |                                  5 |
74*4882a593Smuzhiyun  *   6 |                                  6 |
75*4882a593Smuzhiyun  *   7-+                                  7-+
76*4882a593Smuzhiyun  *   8      Custom csum enable = 1        8      Custom csum enable = 0
77*4882a593Smuzhiyun  *   9      General IPv4 checksum         9      General IPv4 checksum
78*4882a593Smuzhiyun  *   10     General TCP checksum          10     General TCP checksum
79*4882a593Smuzhiyun  *   11     General UDP checksum          11     General UDP checksum
80*4882a593Smuzhiyun  *   12     Large Send Segment enable     12     Large Send Segment enable
81*4882a593Smuzhiyun  *   13     Large Send Segment type       13     Large Send Segment type
82*4882a593Smuzhiyun  *   14     VLAN tagged                   14     VLAN tagged
83*4882a593Smuzhiyun  *   15     Insert VLAN tag               15     Insert VLAN tag
84*4882a593Smuzhiyun  *   16     IPv4 packet                   16     IPv4 packet
85*4882a593Smuzhiyun  *   17     Ethernet frame type           17     Ethernet frame type
86*4882a593Smuzhiyun  *   18-+                                 18-+
87*4882a593Smuzhiyun  *   19 |                                 19 |
88*4882a593Smuzhiyun  *   20 |                                 20 |
89*4882a593Smuzhiyun  *   21 |   Custom csum offset            21 |
90*4882a593Smuzhiyun  *   22 |       (25:18)                   22 |
91*4882a593Smuzhiyun  *   23 |                                 23 |   MSS (30:18)
92*4882a593Smuzhiyun  *   24 |                                 24 |
93*4882a593Smuzhiyun  *   25-+                                 25 |
94*4882a593Smuzhiyun  *   26-+                                 26 |
95*4882a593Smuzhiyun  *   27 |                                 27 |
96*4882a593Smuzhiyun  *   28 |   Reserved                      28 |
97*4882a593Smuzhiyun  *   29 |                                 29 |
98*4882a593Smuzhiyun  *   30-+                                 30-+
99*4882a593Smuzhiyun  *   31     End of packet                 31     End of packet
100*4882a593Smuzhiyun  */
101*4882a593Smuzhiyun struct alx_txd {
102*4882a593Smuzhiyun 	__le16 len;
103*4882a593Smuzhiyun 	__le16 vlan_tag;
104*4882a593Smuzhiyun 	__le32 word1;
105*4882a593Smuzhiyun 	union {
106*4882a593Smuzhiyun 		__le64 addr;
107*4882a593Smuzhiyun 		struct {
108*4882a593Smuzhiyun 			__le32 pkt_len;
109*4882a593Smuzhiyun 			__le32 resvd;
110*4882a593Smuzhiyun 		} l;
111*4882a593Smuzhiyun 	} adrl;
112*4882a593Smuzhiyun } __packed;
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun /* tpd word 1 */
115*4882a593Smuzhiyun #define TPD_CXSUMSTART_MASK		0x00FF
116*4882a593Smuzhiyun #define TPD_CXSUMSTART_SHIFT		0
117*4882a593Smuzhiyun #define TPD_L4HDROFFSET_MASK		0x00FF
118*4882a593Smuzhiyun #define TPD_L4HDROFFSET_SHIFT		0
119*4882a593Smuzhiyun #define TPD_CXSUM_EN_MASK		0x0001
120*4882a593Smuzhiyun #define TPD_CXSUM_EN_SHIFT		8
121*4882a593Smuzhiyun #define TPD_IP_XSUM_MASK		0x0001
122*4882a593Smuzhiyun #define TPD_IP_XSUM_SHIFT		9
123*4882a593Smuzhiyun #define TPD_TCP_XSUM_MASK		0x0001
124*4882a593Smuzhiyun #define TPD_TCP_XSUM_SHIFT		10
125*4882a593Smuzhiyun #define TPD_UDP_XSUM_MASK		0x0001
126*4882a593Smuzhiyun #define TPD_UDP_XSUM_SHIFT		11
127*4882a593Smuzhiyun #define TPD_LSO_EN_MASK			0x0001
128*4882a593Smuzhiyun #define TPD_LSO_EN_SHIFT		12
129*4882a593Smuzhiyun #define TPD_LSO_V2_MASK			0x0001
130*4882a593Smuzhiyun #define TPD_LSO_V2_SHIFT		13
131*4882a593Smuzhiyun #define TPD_VLTAGGED_MASK		0x0001
132*4882a593Smuzhiyun #define TPD_VLTAGGED_SHIFT		14
133*4882a593Smuzhiyun #define TPD_INS_VLTAG_MASK		0x0001
134*4882a593Smuzhiyun #define TPD_INS_VLTAG_SHIFT		15
135*4882a593Smuzhiyun #define TPD_IPV4_MASK			0x0001
136*4882a593Smuzhiyun #define TPD_IPV4_SHIFT			16
137*4882a593Smuzhiyun #define TPD_ETHTYPE_MASK		0x0001
138*4882a593Smuzhiyun #define TPD_ETHTYPE_SHIFT		17
139*4882a593Smuzhiyun #define TPD_CXSUMOFFSET_MASK		0x00FF
140*4882a593Smuzhiyun #define TPD_CXSUMOFFSET_SHIFT		18
141*4882a593Smuzhiyun #define TPD_MSS_MASK			0x1FFF
142*4882a593Smuzhiyun #define TPD_MSS_SHIFT			18
143*4882a593Smuzhiyun #define TPD_EOP_MASK			0x0001
144*4882a593Smuzhiyun #define TPD_EOP_SHIFT			31
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun #define DESC_GET(_x, _name) ((_x) >> _name##SHIFT & _name##MASK)
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun /* Receive Free Descriptor */
149*4882a593Smuzhiyun struct alx_rfd {
150*4882a593Smuzhiyun 	__le64 addr;		/* data buffer address, length is
151*4882a593Smuzhiyun 				 * declared in register --- every
152*4882a593Smuzhiyun 				 * buffer has the same size
153*4882a593Smuzhiyun 				 */
154*4882a593Smuzhiyun } __packed;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun /* Receive Return Descriptor, contains 4 32-bit words.
157*4882a593Smuzhiyun  *
158*4882a593Smuzhiyun  *   31               16               0
159*4882a593Smuzhiyun  *   +----------------+----------------+
160*4882a593Smuzhiyun  *   |              Word 0             |
161*4882a593Smuzhiyun  *   +----------------+----------------+
162*4882a593Smuzhiyun  *   |     Word 1: RSS Hash value      |
163*4882a593Smuzhiyun  *   +----------------+----------------+
164*4882a593Smuzhiyun  *   |              Word 2             |
165*4882a593Smuzhiyun  *   +----------------+----------------+
166*4882a593Smuzhiyun  *   |              Word 3             |
167*4882a593Smuzhiyun  *   +----------------+----------------+
168*4882a593Smuzhiyun  *
169*4882a593Smuzhiyun  * Word 0 depiction         &            Word 2 depiction:
170*4882a593Smuzhiyun  *
171*4882a593Smuzhiyun  *   0--+                                 0--+
172*4882a593Smuzhiyun  *   1  |                                 1  |
173*4882a593Smuzhiyun  *   2  |                                 2  |
174*4882a593Smuzhiyun  *   3  |                                 3  |
175*4882a593Smuzhiyun  *   4  |                                 4  |
176*4882a593Smuzhiyun  *   5  |                                 5  |
177*4882a593Smuzhiyun  *   6  |                                 6  |
178*4882a593Smuzhiyun  *   7  |    IP payload checksum          7  |     VLAN tag
179*4882a593Smuzhiyun  *   8  |         (15:0)                  8  |      (15:0)
180*4882a593Smuzhiyun  *   9  |                                 9  |
181*4882a593Smuzhiyun  *   10 |                                 10 |
182*4882a593Smuzhiyun  *   11 |                                 11 |
183*4882a593Smuzhiyun  *   12 |                                 12 |
184*4882a593Smuzhiyun  *   13 |                                 13 |
185*4882a593Smuzhiyun  *   14 |                                 14 |
186*4882a593Smuzhiyun  *   15-+                                 15-+
187*4882a593Smuzhiyun  *   16-+                                 16-+
188*4882a593Smuzhiyun  *   17 |     Number of RFDs              17 |
189*4882a593Smuzhiyun  *   18 |        (19:16)                  18 |
190*4882a593Smuzhiyun  *   19-+                                 19 |     Protocol ID
191*4882a593Smuzhiyun  *   20-+                                 20 |      (23:16)
192*4882a593Smuzhiyun  *   21 |                                 21 |
193*4882a593Smuzhiyun  *   22 |                                 22 |
194*4882a593Smuzhiyun  *   23 |                                 23-+
195*4882a593Smuzhiyun  *   24 |                                 24 |     Reserved
196*4882a593Smuzhiyun  *   25 |     Start index of RFD-ring     25-+
197*4882a593Smuzhiyun  *   26 |         (31:20)                 26 |     RSS Q-num (27:25)
198*4882a593Smuzhiyun  *   27 |                                 27-+
199*4882a593Smuzhiyun  *   28 |                                 28-+
200*4882a593Smuzhiyun  *   29 |                                 29 |     RSS Hash algorithm
201*4882a593Smuzhiyun  *   30 |                                 30 |      (31:28)
202*4882a593Smuzhiyun  *   31-+                                 31-+
203*4882a593Smuzhiyun  *
204*4882a593Smuzhiyun  * Word 3 depiction:
205*4882a593Smuzhiyun  *
206*4882a593Smuzhiyun  *   0--+
207*4882a593Smuzhiyun  *   1  |
208*4882a593Smuzhiyun  *   2  |
209*4882a593Smuzhiyun  *   3  |
210*4882a593Smuzhiyun  *   4  |
211*4882a593Smuzhiyun  *   5  |
212*4882a593Smuzhiyun  *   6  |
213*4882a593Smuzhiyun  *   7  |    Packet length (include FCS)
214*4882a593Smuzhiyun  *   8  |         (13:0)
215*4882a593Smuzhiyun  *   9  |
216*4882a593Smuzhiyun  *   10 |
217*4882a593Smuzhiyun  *   11 |
218*4882a593Smuzhiyun  *   12 |
219*4882a593Smuzhiyun  *   13-+
220*4882a593Smuzhiyun  *   14      L4 Header checksum error
221*4882a593Smuzhiyun  *   15      IPv4 checksum error
222*4882a593Smuzhiyun  *   16      VLAN tagged
223*4882a593Smuzhiyun  *   17-+
224*4882a593Smuzhiyun  *   18 |    Protocol ID (19:17)
225*4882a593Smuzhiyun  *   19-+
226*4882a593Smuzhiyun  *   20      Receive error summary
227*4882a593Smuzhiyun  *   21      FCS(CRC) error
228*4882a593Smuzhiyun  *   22      Frame alignment error
229*4882a593Smuzhiyun  *   23      Truncated packet
230*4882a593Smuzhiyun  *   24      Runt packet
231*4882a593Smuzhiyun  *   25      Incomplete packet due to insufficient rx-desc
232*4882a593Smuzhiyun  *   26      Broadcast packet
233*4882a593Smuzhiyun  *   27      Multicast packet
234*4882a593Smuzhiyun  *   28      Ethernet type (EII or 802.3)
235*4882a593Smuzhiyun  *   29      FIFO overflow
236*4882a593Smuzhiyun  *   30      Length error (for 802.3, length field mismatch with actual len)
237*4882a593Smuzhiyun  *   31      Updated, indicate to driver that this RRD is refreshed.
238*4882a593Smuzhiyun  */
239*4882a593Smuzhiyun struct alx_rrd {
240*4882a593Smuzhiyun 	__le32 word0;
241*4882a593Smuzhiyun 	__le32 rss_hash;
242*4882a593Smuzhiyun 	__le32 word2;
243*4882a593Smuzhiyun 	__le32 word3;
244*4882a593Smuzhiyun } __packed;
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun /* rrd word 0 */
247*4882a593Smuzhiyun #define RRD_XSUM_MASK		0xFFFF
248*4882a593Smuzhiyun #define RRD_XSUM_SHIFT		0
249*4882a593Smuzhiyun #define RRD_NOR_MASK		0x000F
250*4882a593Smuzhiyun #define RRD_NOR_SHIFT		16
251*4882a593Smuzhiyun #define RRD_SI_MASK		0x0FFF
252*4882a593Smuzhiyun #define RRD_SI_SHIFT		20
253*4882a593Smuzhiyun 
254*4882a593Smuzhiyun /* rrd word 2 */
255*4882a593Smuzhiyun #define RRD_VLTAG_MASK		0xFFFF
256*4882a593Smuzhiyun #define RRD_VLTAG_SHIFT		0
257*4882a593Smuzhiyun #define RRD_PID_MASK		0x00FF
258*4882a593Smuzhiyun #define RRD_PID_SHIFT		16
259*4882a593Smuzhiyun /* non-ip packet */
260*4882a593Smuzhiyun #define RRD_PID_NONIP		0
261*4882a593Smuzhiyun /* ipv4(only) */
262*4882a593Smuzhiyun #define RRD_PID_IPV4		1
263*4882a593Smuzhiyun /* tcp/ipv6 */
264*4882a593Smuzhiyun #define RRD_PID_IPV6TCP		2
265*4882a593Smuzhiyun /* tcp/ipv4 */
266*4882a593Smuzhiyun #define RRD_PID_IPV4TCP		3
267*4882a593Smuzhiyun /* udp/ipv6 */
268*4882a593Smuzhiyun #define RRD_PID_IPV6UDP		4
269*4882a593Smuzhiyun /* udp/ipv4 */
270*4882a593Smuzhiyun #define RRD_PID_IPV4UDP		5
271*4882a593Smuzhiyun /* ipv6(only) */
272*4882a593Smuzhiyun #define RRD_PID_IPV6		6
273*4882a593Smuzhiyun /* LLDP packet */
274*4882a593Smuzhiyun #define RRD_PID_LLDP		7
275*4882a593Smuzhiyun /* 1588 packet */
276*4882a593Smuzhiyun #define RRD_PID_1588		8
277*4882a593Smuzhiyun #define RRD_RSSQ_MASK		0x0007
278*4882a593Smuzhiyun #define RRD_RSSQ_SHIFT		25
279*4882a593Smuzhiyun #define RRD_RSSALG_MASK		0x000F
280*4882a593Smuzhiyun #define RRD_RSSALG_SHIFT	28
281*4882a593Smuzhiyun #define RRD_RSSALG_TCPV6	0x1
282*4882a593Smuzhiyun #define RRD_RSSALG_IPV6		0x2
283*4882a593Smuzhiyun #define RRD_RSSALG_TCPV4	0x4
284*4882a593Smuzhiyun #define RRD_RSSALG_IPV4		0x8
285*4882a593Smuzhiyun 
286*4882a593Smuzhiyun /* rrd word 3 */
287*4882a593Smuzhiyun #define RRD_PKTLEN_MASK		0x3FFF
288*4882a593Smuzhiyun #define RRD_PKTLEN_SHIFT	0
289*4882a593Smuzhiyun #define RRD_ERR_L4_MASK		0x0001
290*4882a593Smuzhiyun #define RRD_ERR_L4_SHIFT	14
291*4882a593Smuzhiyun #define RRD_ERR_IPV4_MASK	0x0001
292*4882a593Smuzhiyun #define RRD_ERR_IPV4_SHIFT	15
293*4882a593Smuzhiyun #define RRD_VLTAGGED_MASK	0x0001
294*4882a593Smuzhiyun #define RRD_VLTAGGED_SHIFT	16
295*4882a593Smuzhiyun #define RRD_OLD_PID_MASK	0x0007
296*4882a593Smuzhiyun #define RRD_OLD_PID_SHIFT	17
297*4882a593Smuzhiyun #define RRD_ERR_RES_MASK	0x0001
298*4882a593Smuzhiyun #define RRD_ERR_RES_SHIFT	20
299*4882a593Smuzhiyun #define RRD_ERR_FCS_MASK	0x0001
300*4882a593Smuzhiyun #define RRD_ERR_FCS_SHIFT	21
301*4882a593Smuzhiyun #define RRD_ERR_FAE_MASK	0x0001
302*4882a593Smuzhiyun #define RRD_ERR_FAE_SHIFT	22
303*4882a593Smuzhiyun #define RRD_ERR_TRUNC_MASK	0x0001
304*4882a593Smuzhiyun #define RRD_ERR_TRUNC_SHIFT	23
305*4882a593Smuzhiyun #define RRD_ERR_RUNT_MASK	0x0001
306*4882a593Smuzhiyun #define RRD_ERR_RUNT_SHIFT	24
307*4882a593Smuzhiyun #define RRD_ERR_ICMP_MASK	0x0001
308*4882a593Smuzhiyun #define RRD_ERR_ICMP_SHIFT	25
309*4882a593Smuzhiyun #define RRD_BCAST_MASK		0x0001
310*4882a593Smuzhiyun #define RRD_BCAST_SHIFT		26
311*4882a593Smuzhiyun #define RRD_MCAST_MASK		0x0001
312*4882a593Smuzhiyun #define RRD_MCAST_SHIFT		27
313*4882a593Smuzhiyun #define RRD_ETHTYPE_MASK	0x0001
314*4882a593Smuzhiyun #define RRD_ETHTYPE_SHIFT	28
315*4882a593Smuzhiyun #define RRD_ERR_FIFOV_MASK	0x0001
316*4882a593Smuzhiyun #define RRD_ERR_FIFOV_SHIFT	29
317*4882a593Smuzhiyun #define RRD_ERR_LEN_MASK	0x0001
318*4882a593Smuzhiyun #define RRD_ERR_LEN_SHIFT	30
319*4882a593Smuzhiyun #define RRD_UPDATED_MASK	0x0001
320*4882a593Smuzhiyun #define RRD_UPDATED_SHIFT	31
321*4882a593Smuzhiyun 
322*4882a593Smuzhiyun 
323*4882a593Smuzhiyun #define ALX_MAX_SETUP_LNK_CYCLE	50
324*4882a593Smuzhiyun 
325*4882a593Smuzhiyun /* for FlowControl */
326*4882a593Smuzhiyun #define ALX_FC_RX		0x01
327*4882a593Smuzhiyun #define ALX_FC_TX		0x02
328*4882a593Smuzhiyun #define ALX_FC_ANEG		0x04
329*4882a593Smuzhiyun 
330*4882a593Smuzhiyun /* for sleep control */
331*4882a593Smuzhiyun #define ALX_SLEEP_WOL_PHY	0x00000001
332*4882a593Smuzhiyun #define ALX_SLEEP_WOL_MAGIC	0x00000002
333*4882a593Smuzhiyun #define ALX_SLEEP_CIFS		0x00000004
334*4882a593Smuzhiyun #define ALX_SLEEP_ACTIVE	(ALX_SLEEP_WOL_PHY | \
335*4882a593Smuzhiyun 				 ALX_SLEEP_WOL_MAGIC | \
336*4882a593Smuzhiyun 				 ALX_SLEEP_CIFS)
337*4882a593Smuzhiyun 
338*4882a593Smuzhiyun /* for RSS hash type */
339*4882a593Smuzhiyun #define ALX_RSS_HASH_TYPE_IPV4		0x1
340*4882a593Smuzhiyun #define ALX_RSS_HASH_TYPE_IPV4_TCP	0x2
341*4882a593Smuzhiyun #define ALX_RSS_HASH_TYPE_IPV6		0x4
342*4882a593Smuzhiyun #define ALX_RSS_HASH_TYPE_IPV6_TCP	0x8
343*4882a593Smuzhiyun #define ALX_RSS_HASH_TYPE_ALL		(ALX_RSS_HASH_TYPE_IPV4 | \
344*4882a593Smuzhiyun 					 ALX_RSS_HASH_TYPE_IPV4_TCP | \
345*4882a593Smuzhiyun 					 ALX_RSS_HASH_TYPE_IPV6 | \
346*4882a593Smuzhiyun 					 ALX_RSS_HASH_TYPE_IPV6_TCP)
347*4882a593Smuzhiyun #define ALX_FRAME_PAD		16
348*4882a593Smuzhiyun #define ALX_RAW_MTU(_mtu)	(_mtu + ETH_HLEN + ETH_FCS_LEN + VLAN_HLEN)
349*4882a593Smuzhiyun #define ALX_MAX_FRAME_LEN(_mtu)	(ALIGN((ALX_RAW_MTU(_mtu) + ALX_FRAME_PAD), 8))
350*4882a593Smuzhiyun #define ALX_DEF_RXBUF_SIZE	ALX_MAX_FRAME_LEN(1500)
351*4882a593Smuzhiyun #define ALX_MAX_JUMBO_PKT_SIZE	(9*1024)
352*4882a593Smuzhiyun #define ALX_MAX_TSO_PKT_SIZE	(7*1024)
353*4882a593Smuzhiyun #define ALX_MAX_FRAME_SIZE	ALX_MAX_JUMBO_PKT_SIZE
354*4882a593Smuzhiyun 
355*4882a593Smuzhiyun #define ALX_MAX_RX_QUEUES	8
356*4882a593Smuzhiyun #define ALX_MAX_TX_QUEUES	4
357*4882a593Smuzhiyun #define ALX_MAX_HANDLED_INTRS	5
358*4882a593Smuzhiyun 
359*4882a593Smuzhiyun #define ALX_ISR_MISC		(ALX_ISR_PCIE_LNKDOWN | \
360*4882a593Smuzhiyun 				 ALX_ISR_DMAW | \
361*4882a593Smuzhiyun 				 ALX_ISR_DMAR | \
362*4882a593Smuzhiyun 				 ALX_ISR_SMB | \
363*4882a593Smuzhiyun 				 ALX_ISR_MANU | \
364*4882a593Smuzhiyun 				 ALX_ISR_TIMER)
365*4882a593Smuzhiyun 
366*4882a593Smuzhiyun #define ALX_ISR_FATAL		(ALX_ISR_PCIE_LNKDOWN | \
367*4882a593Smuzhiyun 				 ALX_ISR_DMAW | ALX_ISR_DMAR)
368*4882a593Smuzhiyun 
369*4882a593Smuzhiyun #define ALX_ISR_ALERT		(ALX_ISR_RXF_OV | \
370*4882a593Smuzhiyun 				 ALX_ISR_TXF_UR | \
371*4882a593Smuzhiyun 				 ALX_ISR_RFD_UR)
372*4882a593Smuzhiyun 
373*4882a593Smuzhiyun #define ALX_ISR_ALL_QUEUES	(ALX_ISR_TX_Q0 | \
374*4882a593Smuzhiyun 				 ALX_ISR_TX_Q1 | \
375*4882a593Smuzhiyun 				 ALX_ISR_TX_Q2 | \
376*4882a593Smuzhiyun 				 ALX_ISR_TX_Q3 | \
377*4882a593Smuzhiyun 				 ALX_ISR_RX_Q0 | \
378*4882a593Smuzhiyun 				 ALX_ISR_RX_Q1 | \
379*4882a593Smuzhiyun 				 ALX_ISR_RX_Q2 | \
380*4882a593Smuzhiyun 				 ALX_ISR_RX_Q3 | \
381*4882a593Smuzhiyun 				 ALX_ISR_RX_Q4 | \
382*4882a593Smuzhiyun 				 ALX_ISR_RX_Q5 | \
383*4882a593Smuzhiyun 				 ALX_ISR_RX_Q6 | \
384*4882a593Smuzhiyun 				 ALX_ISR_RX_Q7)
385*4882a593Smuzhiyun 
386*4882a593Smuzhiyun /* Statistics counters collected by the MAC
387*4882a593Smuzhiyun  *
388*4882a593Smuzhiyun  * The order of the fields must match the strings in alx_gstrings_stats
389*4882a593Smuzhiyun  * All stats fields should be u64
390*4882a593Smuzhiyun  * See ethtool.c
391*4882a593Smuzhiyun  */
392*4882a593Smuzhiyun struct alx_hw_stats {
393*4882a593Smuzhiyun 	/* rx */
394*4882a593Smuzhiyun 	u64 rx_ok;		/* good RX packets */
395*4882a593Smuzhiyun 	u64 rx_bcast;		/* good RX broadcast packets */
396*4882a593Smuzhiyun 	u64 rx_mcast;		/* good RX multicast packets */
397*4882a593Smuzhiyun 	u64 rx_pause;		/* RX pause frames */
398*4882a593Smuzhiyun 	u64 rx_ctrl;		/* RX control packets other than pause frames */
399*4882a593Smuzhiyun 	u64 rx_fcs_err;		/* RX packets with bad FCS */
400*4882a593Smuzhiyun 	u64 rx_len_err;		/* RX packets with length != actual size */
401*4882a593Smuzhiyun 	u64 rx_byte_cnt;	/* good bytes received. FCS is NOT included */
402*4882a593Smuzhiyun 	u64 rx_runt;		/* RX packets < 64 bytes with good FCS */
403*4882a593Smuzhiyun 	u64 rx_frag;		/* RX packets < 64 bytes with bad FCS */
404*4882a593Smuzhiyun 	u64 rx_sz_64B;		/* 64 byte RX packets */
405*4882a593Smuzhiyun 	u64 rx_sz_127B;		/* 65-127 byte RX packets */
406*4882a593Smuzhiyun 	u64 rx_sz_255B;		/* 128-255 byte RX packets */
407*4882a593Smuzhiyun 	u64 rx_sz_511B;		/* 256-511 byte RX packets */
408*4882a593Smuzhiyun 	u64 rx_sz_1023B;	/* 512-1023 byte RX packets */
409*4882a593Smuzhiyun 	u64 rx_sz_1518B;	/* 1024-1518 byte RX packets */
410*4882a593Smuzhiyun 	u64 rx_sz_max;		/* 1519 byte to MTU RX packets */
411*4882a593Smuzhiyun 	u64 rx_ov_sz;		/* truncated RX packets, size > MTU */
412*4882a593Smuzhiyun 	u64 rx_ov_rxf;		/* frames dropped due to RX FIFO overflow */
413*4882a593Smuzhiyun 	u64 rx_ov_rrd;		/* frames dropped due to RRD overflow */
414*4882a593Smuzhiyun 	u64 rx_align_err;	/* alignment errors */
415*4882a593Smuzhiyun 	u64 rx_bc_byte_cnt;	/* RX broadcast bytes, excluding FCS */
416*4882a593Smuzhiyun 	u64 rx_mc_byte_cnt;	/* RX multicast bytes, excluding FCS */
417*4882a593Smuzhiyun 	u64 rx_err_addr;	/* packets dropped due to address filtering */
418*4882a593Smuzhiyun 
419*4882a593Smuzhiyun 	/* tx */
420*4882a593Smuzhiyun 	u64 tx_ok;		/* good TX packets */
421*4882a593Smuzhiyun 	u64 tx_bcast;		/* good TX broadcast packets */
422*4882a593Smuzhiyun 	u64 tx_mcast;		/* good TX multicast packets */
423*4882a593Smuzhiyun 	u64 tx_pause;		/* TX pause frames */
424*4882a593Smuzhiyun 	u64 tx_exc_defer;	/* TX packets deferred excessively */
425*4882a593Smuzhiyun 	u64 tx_ctrl;		/* TX control frames, excluding pause frames */
426*4882a593Smuzhiyun 	u64 tx_defer;		/* TX packets deferred */
427*4882a593Smuzhiyun 	u64 tx_byte_cnt;	/* bytes transmitted, FCS is NOT included */
428*4882a593Smuzhiyun 	u64 tx_sz_64B;		/* 64 byte TX packets */
429*4882a593Smuzhiyun 	u64 tx_sz_127B;		/* 65-127 byte TX packets */
430*4882a593Smuzhiyun 	u64 tx_sz_255B;		/* 128-255 byte TX packets */
431*4882a593Smuzhiyun 	u64 tx_sz_511B;		/* 256-511 byte TX packets */
432*4882a593Smuzhiyun 	u64 tx_sz_1023B;	/* 512-1023 byte TX packets */
433*4882a593Smuzhiyun 	u64 tx_sz_1518B;	/* 1024-1518 byte TX packets */
434*4882a593Smuzhiyun 	u64 tx_sz_max;		/* 1519 byte to MTU TX packets */
435*4882a593Smuzhiyun 	u64 tx_single_col;	/* packets TX after a single collision */
436*4882a593Smuzhiyun 	u64 tx_multi_col;	/* packets TX after multiple collisions */
437*4882a593Smuzhiyun 	u64 tx_late_col;	/* TX packets with late collisions */
438*4882a593Smuzhiyun 	u64 tx_abort_col;	/* TX packets aborted w/excessive collisions */
439*4882a593Smuzhiyun 	u64 tx_underrun;	/* TX packets aborted due to TX FIFO underrun
440*4882a593Smuzhiyun 				 * or TRD FIFO underrun
441*4882a593Smuzhiyun 				 */
442*4882a593Smuzhiyun 	u64 tx_trd_eop;		/* reads beyond the EOP into the next frame
443*4882a593Smuzhiyun 				 * when TRD was not written timely
444*4882a593Smuzhiyun 				 */
445*4882a593Smuzhiyun 	u64 tx_len_err;		/* TX packets where length != actual size */
446*4882a593Smuzhiyun 	u64 tx_trunc;		/* TX packets truncated due to size > MTU */
447*4882a593Smuzhiyun 	u64 tx_bc_byte_cnt;	/* broadcast bytes transmitted, excluding FCS */
448*4882a593Smuzhiyun 	u64 tx_mc_byte_cnt;	/* multicast bytes transmitted, excluding FCS */
449*4882a593Smuzhiyun 	u64 update;
450*4882a593Smuzhiyun };
451*4882a593Smuzhiyun 
452*4882a593Smuzhiyun 
453*4882a593Smuzhiyun /* maximum interrupt vectors for msix */
454*4882a593Smuzhiyun #define ALX_MAX_MSIX_INTRS	16
455*4882a593Smuzhiyun 
456*4882a593Smuzhiyun #define ALX_GET_FIELD(_data, _field)					\
457*4882a593Smuzhiyun 	(((_data) >> _field ## _SHIFT) & _field ## _MASK)
458*4882a593Smuzhiyun 
459*4882a593Smuzhiyun #define ALX_SET_FIELD(_data, _field, _value)	do {			\
460*4882a593Smuzhiyun 		(_data) &= ~(_field ## _MASK << _field ## _SHIFT);	\
461*4882a593Smuzhiyun 		(_data) |= ((_value) & _field ## _MASK) << _field ## _SHIFT;\
462*4882a593Smuzhiyun 	} while (0)
463*4882a593Smuzhiyun 
464*4882a593Smuzhiyun struct alx_hw {
465*4882a593Smuzhiyun 	struct pci_dev *pdev;
466*4882a593Smuzhiyun 	u8 __iomem *hw_addr;
467*4882a593Smuzhiyun 
468*4882a593Smuzhiyun 	/* current & permanent mac addr */
469*4882a593Smuzhiyun 	u8 mac_addr[ETH_ALEN];
470*4882a593Smuzhiyun 	u8 perm_addr[ETH_ALEN];
471*4882a593Smuzhiyun 
472*4882a593Smuzhiyun 	u16 mtu;
473*4882a593Smuzhiyun 	u16 imt;
474*4882a593Smuzhiyun 	u8 dma_chnl;
475*4882a593Smuzhiyun 	u8 max_dma_chnl;
476*4882a593Smuzhiyun 	/* tpd threshold to trig INT */
477*4882a593Smuzhiyun 	u32 ith_tpd;
478*4882a593Smuzhiyun 	u32 rx_ctrl;
479*4882a593Smuzhiyun 	u32 mc_hash[2];
480*4882a593Smuzhiyun 
481*4882a593Smuzhiyun 	u32 smb_timer;
482*4882a593Smuzhiyun 	/* SPEED_* + DUPLEX_*, SPEED_UNKNOWN if link is down */
483*4882a593Smuzhiyun 	int link_speed;
484*4882a593Smuzhiyun 	u8 duplex;
485*4882a593Smuzhiyun 
486*4882a593Smuzhiyun 	/* auto-neg advertisement or force mode config */
487*4882a593Smuzhiyun 	u8 flowctrl;
488*4882a593Smuzhiyun 	u32 adv_cfg;
489*4882a593Smuzhiyun 
490*4882a593Smuzhiyun 	spinlock_t mdio_lock;
491*4882a593Smuzhiyun 	struct mdio_if_info mdio;
492*4882a593Smuzhiyun 	u16 phy_id[2];
493*4882a593Smuzhiyun 
494*4882a593Smuzhiyun 	/* PHY link patch flag */
495*4882a593Smuzhiyun 	bool lnk_patch;
496*4882a593Smuzhiyun 
497*4882a593Smuzhiyun 	/* cumulated stats from the hardware (registers are cleared on read) */
498*4882a593Smuzhiyun 	struct alx_hw_stats stats;
499*4882a593Smuzhiyun };
500*4882a593Smuzhiyun 
alx_hw_revision(struct alx_hw * hw)501*4882a593Smuzhiyun static inline int alx_hw_revision(struct alx_hw *hw)
502*4882a593Smuzhiyun {
503*4882a593Smuzhiyun 	return hw->pdev->revision >> ALX_PCI_REVID_SHIFT;
504*4882a593Smuzhiyun }
505*4882a593Smuzhiyun 
alx_hw_with_cr(struct alx_hw * hw)506*4882a593Smuzhiyun static inline bool alx_hw_with_cr(struct alx_hw *hw)
507*4882a593Smuzhiyun {
508*4882a593Smuzhiyun 	return hw->pdev->revision & 1;
509*4882a593Smuzhiyun }
510*4882a593Smuzhiyun 
alx_hw_giga(struct alx_hw * hw)511*4882a593Smuzhiyun static inline bool alx_hw_giga(struct alx_hw *hw)
512*4882a593Smuzhiyun {
513*4882a593Smuzhiyun 	return hw->pdev->device & 1;
514*4882a593Smuzhiyun }
515*4882a593Smuzhiyun 
alx_write_mem8(struct alx_hw * hw,u32 reg,u8 val)516*4882a593Smuzhiyun static inline void alx_write_mem8(struct alx_hw *hw, u32 reg, u8 val)
517*4882a593Smuzhiyun {
518*4882a593Smuzhiyun 	writeb(val, hw->hw_addr + reg);
519*4882a593Smuzhiyun }
520*4882a593Smuzhiyun 
alx_write_mem16(struct alx_hw * hw,u32 reg,u16 val)521*4882a593Smuzhiyun static inline void alx_write_mem16(struct alx_hw *hw, u32 reg, u16 val)
522*4882a593Smuzhiyun {
523*4882a593Smuzhiyun 	writew(val, hw->hw_addr + reg);
524*4882a593Smuzhiyun }
525*4882a593Smuzhiyun 
alx_read_mem16(struct alx_hw * hw,u32 reg)526*4882a593Smuzhiyun static inline u16 alx_read_mem16(struct alx_hw *hw, u32 reg)
527*4882a593Smuzhiyun {
528*4882a593Smuzhiyun 	return readw(hw->hw_addr + reg);
529*4882a593Smuzhiyun }
530*4882a593Smuzhiyun 
alx_write_mem32(struct alx_hw * hw,u32 reg,u32 val)531*4882a593Smuzhiyun static inline void alx_write_mem32(struct alx_hw *hw, u32 reg, u32 val)
532*4882a593Smuzhiyun {
533*4882a593Smuzhiyun 	writel(val, hw->hw_addr + reg);
534*4882a593Smuzhiyun }
535*4882a593Smuzhiyun 
alx_read_mem32(struct alx_hw * hw,u32 reg)536*4882a593Smuzhiyun static inline u32 alx_read_mem32(struct alx_hw *hw, u32 reg)
537*4882a593Smuzhiyun {
538*4882a593Smuzhiyun 	return readl(hw->hw_addr + reg);
539*4882a593Smuzhiyun }
540*4882a593Smuzhiyun 
alx_post_write(struct alx_hw * hw)541*4882a593Smuzhiyun static inline void alx_post_write(struct alx_hw *hw)
542*4882a593Smuzhiyun {
543*4882a593Smuzhiyun 	readl(hw->hw_addr);
544*4882a593Smuzhiyun }
545*4882a593Smuzhiyun 
546*4882a593Smuzhiyun int alx_get_perm_macaddr(struct alx_hw *hw, u8 *addr);
547*4882a593Smuzhiyun void alx_reset_phy(struct alx_hw *hw);
548*4882a593Smuzhiyun void alx_reset_pcie(struct alx_hw *hw);
549*4882a593Smuzhiyun void alx_enable_aspm(struct alx_hw *hw, bool l0s_en, bool l1_en);
550*4882a593Smuzhiyun int alx_setup_speed_duplex(struct alx_hw *hw, u32 ethadv, u8 flowctrl);
551*4882a593Smuzhiyun void alx_post_phy_link(struct alx_hw *hw);
552*4882a593Smuzhiyun int alx_read_phy_reg(struct alx_hw *hw, u16 reg, u16 *phy_data);
553*4882a593Smuzhiyun int alx_write_phy_reg(struct alx_hw *hw, u16 reg, u16 phy_data);
554*4882a593Smuzhiyun int alx_read_phy_ext(struct alx_hw *hw, u8 dev, u16 reg, u16 *pdata);
555*4882a593Smuzhiyun int alx_write_phy_ext(struct alx_hw *hw, u8 dev, u16 reg, u16 data);
556*4882a593Smuzhiyun int alx_read_phy_link(struct alx_hw *hw);
557*4882a593Smuzhiyun int alx_clear_phy_intr(struct alx_hw *hw);
558*4882a593Smuzhiyun void alx_cfg_mac_flowcontrol(struct alx_hw *hw, u8 fc);
559*4882a593Smuzhiyun void alx_start_mac(struct alx_hw *hw);
560*4882a593Smuzhiyun int alx_reset_mac(struct alx_hw *hw);
561*4882a593Smuzhiyun void alx_set_macaddr(struct alx_hw *hw, const u8 *addr);
562*4882a593Smuzhiyun bool alx_phy_configured(struct alx_hw *hw);
563*4882a593Smuzhiyun void alx_configure_basic(struct alx_hw *hw);
564*4882a593Smuzhiyun void alx_mask_msix(struct alx_hw *hw, int index, bool mask);
565*4882a593Smuzhiyun void alx_disable_rss(struct alx_hw *hw);
566*4882a593Smuzhiyun bool alx_get_phy_info(struct alx_hw *hw);
567*4882a593Smuzhiyun void alx_update_hw_stats(struct alx_hw *hw);
568*4882a593Smuzhiyun 
alx_speed_to_ethadv(int speed,u8 duplex)569*4882a593Smuzhiyun static inline u32 alx_speed_to_ethadv(int speed, u8 duplex)
570*4882a593Smuzhiyun {
571*4882a593Smuzhiyun 	if (speed == SPEED_1000 && duplex == DUPLEX_FULL)
572*4882a593Smuzhiyun 		return ADVERTISED_1000baseT_Full;
573*4882a593Smuzhiyun 	if (speed == SPEED_100 && duplex == DUPLEX_FULL)
574*4882a593Smuzhiyun 		return ADVERTISED_100baseT_Full;
575*4882a593Smuzhiyun 	if (speed == SPEED_100 && duplex== DUPLEX_HALF)
576*4882a593Smuzhiyun 		return ADVERTISED_100baseT_Half;
577*4882a593Smuzhiyun 	if (speed == SPEED_10 && duplex == DUPLEX_FULL)
578*4882a593Smuzhiyun 		return ADVERTISED_10baseT_Full;
579*4882a593Smuzhiyun 	if (speed == SPEED_10 && duplex == DUPLEX_HALF)
580*4882a593Smuzhiyun 		return ADVERTISED_10baseT_Half;
581*4882a593Smuzhiyun 	return 0;
582*4882a593Smuzhiyun }
583*4882a593Smuzhiyun 
584*4882a593Smuzhiyun #endif
585