ixgbe_type.h revision 172043
1/*******************************************************************************
2
3  Copyright (c) 2001-2007, Intel Corporation
4  All rights reserved.
5
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8
9   1. Redistributions of source code must retain the above copyright notice,
10      this list of conditions and the following disclaimer.
11
12   2. Redistributions in binary form must reproduce the above copyright
13      notice, this list of conditions and the following disclaimer in the
14      documentation and/or other materials provided with the distribution.
15
16   3. Neither the name of the Intel Corporation nor the names of its
17      contributors may be used to endorse or promote products derived from
18      this software without specific prior written permission.
19
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31
32*******************************************************************************/
33/* $FreeBSD: head/sys/dev/ixgbe/ixgbe_type.h 172043 2007-09-04 02:31:35Z jfv $ */
34
35#ifndef _IXGBE_TYPE_H_
36#define _IXGBE_TYPE_H_
37
38#include "ixgbe_osdep.h"
39
40/* Vendor ID */
41#define IXGBE_INTEL_VENDOR_ID   0x8086
42
43/* Device IDs */
44#define IXGBE_DEV_ID_82598AF_DUAL_PORT   0x10C6
45#define IXGBE_DEV_ID_82598AF_SINGLE_PORT 0x10C7
46#define IXGBE_DEV_ID_82598EB_CX4         0x10DD
47
48/* General Registers */
49#define IXGBE_CTRL      0x00000
50#define IXGBE_STATUS    0x00008
51#define IXGBE_CTRL_EXT  0x00018
52#define IXGBE_ESDP      0x00020
53#define IXGBE_EODSDP    0x00028
54#define IXGBE_LEDCTL    0x00200
55#define IXGBE_FRTIMER   0x00048
56#define IXGBE_TCPTIMER  0x0004C
57
58/* NVM Registers */
59#define IXGBE_EEC       0x10010
60#define IXGBE_EERD      0x10014
61#define IXGBE_FLA       0x1001C
62#define IXGBE_EEMNGCTL  0x10110
63#define IXGBE_EEMNGDATA 0x10114
64#define IXGBE_FLMNGCTL  0x10118
65#define IXGBE_FLMNGDATA 0x1011C
66#define IXGBE_FLMNGCNT  0x10120
67#define IXGBE_FLOP      0x1013C
68#define IXGBE_GRC       0x10200
69
70/* Interrupt Registers */
71#define IXGBE_EICR      0x00800
72#define IXGBE_EICS      0x00808
73#define IXGBE_EIMS      0x00880
74#define IXGBE_EIMC      0x00888
75#define IXGBE_EIAC      0x00810
76#define IXGBE_EIAM      0x00890
77#define IXGBE_EITR(_i) (0x00820 + ((_i) * 4)) /* 0x820-0x86c */
78#define IXGBE_IVAR(_i) (0x00900 + ((_i) * 4)) /* 24 at 0x900-0x960 */
79#define IXGBE_MSIXT     0x00000 /* MSI-X Table. 0x0000 - 0x01C */
80#define IXGBE_MSIXPBA   0x02000 /* MSI-X Pending bit array */
81#define IXGBE_PBACL     0x11068
82#define IXGBE_GPIE      0x00898
83
84/* Flow Control Registers */
85#define IXGBE_PFCTOP    0x03008
86#define IXGBE_FCTTV(_i) (0x03200 + ((_i) * 4)) /* 4 of these (0-3) */
87#define IXGBE_FCRTL(_i) (0x03220 + ((_i) * 8)) /* 8 of these (0-7) */
88#define IXGBE_FCRTH(_i) (0x03260 + ((_i) * 8)) /* 8 of these (0-7) */
89#define IXGBE_FCRTV     0x032A0
90#define IXGBE_TFCS      0x0CE00
91
92/* Receive DMA Registers */
93#define IXGBE_RDBAL(_i) (0x01000 + ((_i) * 0x40)) /* 64 of each (0-63)*/
94#define IXGBE_RDBAH(_i) (0x01004 + ((_i) * 0x40))
95#define IXGBE_RDLEN(_i) (0x01008 + ((_i) * 0x40))
96#define IXGBE_RDH(_i)   (0x01010 + ((_i) * 0x40))
97#define IXGBE_RDT(_i)   (0x01018 + ((_i) * 0x40))
98#define IXGBE_RXDCTL(_i) (0x01028 + ((_i) * 0x40))
99#define IXGBE_SRRCTL(_i) (0x02100 + ((_i) * 4))
100					     /* array of 16 (0x02100-0x0213C) */
101#define IXGBE_DCA_RXCTRL(_i)    (0x02200 + ((_i) * 4))
102					     /* array of 16 (0x02200-0x0223C) */
103#define IXGBE_RDRXCTL    0x02F00
104#define IXGBE_RXPBSIZE(_i)      (0x03C00 + ((_i) * 4))
105					     /* 8 of these 0x03C00 - 0x03C1C */
106#define IXGBE_RXCTRL    0x03000
107#define IXGBE_DROPEN    0x03D04
108#define IXGBE_RXPBSIZE_SHIFT 10
109
110/* Receive Registers */
111#define IXGBE_RXCSUM    0x05000
112#define IXGBE_RFCTL     0x05008
113#define IXGBE_MTA(_i)   (0x05200 + ((_i) * 4))
114				   /* Multicast Table Array - 128 entries */
115#define IXGBE_RAL(_i)   (0x05400 + ((_i) * 8)) /* 16 of these (0-15) */
116#define IXGBE_RAH(_i)   (0x05404 + ((_i) * 8)) /* 16 of these (0-15) */
117#define IXGBE_PSRTYPE   0x05480
118				   /* 0x5480-0x54BC Packet split receive type */
119#define IXGBE_VFTA(_i)  (0x0A000 + ((_i) * 4))
120					 /* array of 4096 1-bit vlan filters */
121#define IXGBE_VFTAVIND(_j, _i)  (0x0A200 + ((_j) * 0x200) + ((_i) * 4))
122				     /*array of 4096 4-bit vlan vmdq indicies */
123#define IXGBE_FCTRL     0x05080
124#define IXGBE_VLNCTRL   0x05088
125#define IXGBE_MCSTCTRL  0x05090
126#define IXGBE_MRQC      0x05818
127#define IXGBE_VMD_CTL   0x0581C
128#define IXGBE_IMIR(_i)  (0x05A80 + ((_i) * 4))  /* 8 of these (0-7) */
129#define IXGBE_IMIREXT(_i)       (0x05AA0 + ((_i) * 4))  /* 8 of these (0-7) */
130#define IXGBE_IMIRVP    0x05AC0
131#define IXGBE_RETA(_i)  (0x05C00 + ((_i) * 4))  /* 32 of these (0-31) */
132#define IXGBE_RSSRK(_i) (0x05C80 + ((_i) * 4))  /* 10 of these (0-9) */
133
134/* Transmit DMA registers */
135#define IXGBE_TDBAL(_i) (0x06000 + ((_i) * 0x40))/* 32 of these (0-31)*/
136#define IXGBE_TDBAH(_i) (0x06004 + ((_i) * 0x40))
137#define IXGBE_TDLEN(_i) (0x06008 + ((_i) * 0x40))
138#define IXGBE_TDH(_i)   (0x06010 + ((_i) * 0x40))
139#define IXGBE_TDT(_i)   (0x06018 + ((_i) * 0x40))
140#define IXGBE_TXDCTL(_i) (0x06028 + ((_i) * 0x40))
141#define IXGBE_TDWBAL(_i) (0x06038 + ((_i) * 0x40))
142#define IXGBE_TDWBAH(_i) (0x0603C + ((_i) * 0x40))
143#define IXGBE_DTXCTL    0x07E00
144#define IXGBE_DCA_TXCTRL(_i)    (0x07200 + ((_i) * 4))
145					      /* there are 16 of these (0-15) */
146#define IXGBE_TIPG      0x0CB00
147#define IXGBE_TXPBSIZE(_i)      (0x0CC00 + ((_i) *0x04))
148						      /* there are 8 of these */
149#define IXGBE_MNGTXMAP  0x0CD10
150#define IXGBE_TIPG_FIBER_DEFAULT 3
151#define IXGBE_TXPBSIZE_SHIFT    10
152
153/* Wake up registers */
154#define IXGBE_WUC       0x05800
155#define IXGBE_WUFC      0x05808
156#define IXGBE_WUS       0x05810
157#define IXGBE_IPAV      0x05838
158#define IXGBE_IP4AT     0x05840 /* IPv4 table 0x5840-0x5858 */
159#define IXGBE_IP6AT     0x05880 /* IPv6 table 0x5880-0x588F */
160#define IXGBE_WUPL      0x05900
161#define IXGBE_WUPM      0x05A00 /* wake up pkt memory 0x5A00-0x5A7C */
162#define IXGBE_FHFT      0x09000 /* Flex host filter table 9000-93FC */
163
164/* Music registers */
165#define IXGBE_RMCS      0x03D00
166#define IXGBE_DPMCS     0x07F40
167#define IXGBE_PDPMCS    0x0CD00
168#define IXGBE_RUPPBMR   0x050A0
169#define IXGBE_RT2CR(_i) (0x03C20 + ((_i) * 4)) /* 8 of these (0-7) */
170#define IXGBE_RT2SR(_i) (0x03C40 + ((_i) * 4)) /* 8 of these (0-7) */
171#define IXGBE_TDTQ2TCCR(_i)     (0x0602C + ((_i) * 0x40)) /* 8 of these (0-7) */
172#define IXGBE_TDTQ2TCSR(_i)     (0x0622C + ((_i) * 0x40)) /* 8 of these (0-7) */
173#define IXGBE_TDPT2TCCR(_i)     (0x0CD20 + ((_i) * 4)) /* 8 of these (0-7) */
174#define IXGBE_TDPT2TCSR(_i)     (0x0CD40 + ((_i) * 4)) /* 8 of these (0-7) */
175
176/* Stats registers */
177#define IXGBE_CRCERRS   0x04000
178#define IXGBE_ILLERRC   0x04004
179#define IXGBE_ERRBC     0x04008
180#define IXGBE_MSPDC     0x04010
181#define IXGBE_MPC(_i)   (0x03FA0 + ((_i) * 4)) /* 8 of these 3FA0-3FBC*/
182#define IXGBE_MLFC      0x04034
183#define IXGBE_MRFC      0x04038
184#define IXGBE_RLEC      0x04040
185#define IXGBE_LXONTXC   0x03F60
186#define IXGBE_LXONRXC   0x0CF60
187#define IXGBE_LXOFFTXC  0x03F68
188#define IXGBE_LXOFFRXC  0x0CF68
189#define IXGBE_PXONTXC(_i)       (0x03F00 + ((_i) * 4)) /* 8 of these 3F00-3F1C*/
190#define IXGBE_PXONRXC(_i)       (0x0CF00 + ((_i) * 4)) /* 8 of these CF00-CF1C*/
191#define IXGBE_PXOFFTXC(_i)      (0x03F20 + ((_i) * 4)) /* 8 of these 3F20-3F3C*/
192#define IXGBE_PXOFFRXC(_i)      (0x0CF20 + ((_i) * 4)) /* 8 of these CF20-CF3C*/
193#define IXGBE_PRC64     0x0405C
194#define IXGBE_PRC127    0x04060
195#define IXGBE_PRC255    0x04064
196#define IXGBE_PRC511    0x04068
197#define IXGBE_PRC1023   0x0406C
198#define IXGBE_PRC1522   0x04070
199#define IXGBE_GPRC      0x04074
200#define IXGBE_BPRC      0x04078
201#define IXGBE_MPRC      0x0407C
202#define IXGBE_GPTC      0x04080
203#define IXGBE_GORCL     0x04088
204#define IXGBE_GORCH     0x0408C
205#define IXGBE_GOTCL     0x04090
206#define IXGBE_GOTCH     0x04094
207#define IXGBE_RNBC(_i)  (0x03FC0 + ((_i) * 4)) /* 8 of these 3FC0-3FDC*/
208#define IXGBE_RUC       0x040A4
209#define IXGBE_RFC       0x040A8
210#define IXGBE_ROC       0x040AC
211#define IXGBE_RJC       0x040B0
212#define IXGBE_MNGPRC    0x040B4
213#define IXGBE_MNGPDC    0x040B8
214#define IXGBE_MNGPTC    0x0CF90
215#define IXGBE_TORL      0x040C0
216#define IXGBE_TORH      0x040C4
217#define IXGBE_TPR       0x040D0
218#define IXGBE_TPT       0x040D4
219#define IXGBE_PTC64     0x040D8
220#define IXGBE_PTC127    0x040DC
221#define IXGBE_PTC255    0x040E0
222#define IXGBE_PTC511    0x040E4
223#define IXGBE_PTC1023   0x040E8
224#define IXGBE_PTC1522   0x040EC
225#define IXGBE_MPTC      0x040F0
226#define IXGBE_BPTC      0x040F4
227#define IXGBE_XEC       0x04120
228
229#define IXGBE_RQSMR(_i) (0x02300 + ((_i) * 4)) /* 16 of these */
230#define IXGBE_TQSMR(_i) (0x07300 + ((_i) * 4)) /* 8 of these */
231
232#define IXGBE_QPRC(_i) (0x01030 + ((_i) * 0x40)) /* 16 of these */
233#define IXGBE_QPTC(_i) (0x06030 + ((_i) * 0x40)) /* 16 of these */
234#define IXGBE_QBRC(_i) (0x01034 + ((_i) * 0x40)) /* 16 of these */
235#define IXGBE_QBTC(_i) (0x06034 + ((_i) * 0x40)) /* 16 of these */
236
237/* Management */
238#define IXGBE_MAVTV(_i) (0x05010 + ((_i) * 4)) /* 8 of these (0-7) */
239#define IXGBE_MFUTP(_i) (0x05030 + ((_i) * 4)) /* 8 of these (0-7) */
240#define IXGBE_MANC      0x05820
241#define IXGBE_MFVAL     0x05824
242#define IXGBE_MANC2H    0x05860
243#define IXGBE_MDEF(_i)  (0x05890 + ((_i) * 4)) /* 8 of these (0-7) */
244#define IXGBE_MIPAF     0x058B0
245#define IXGBE_MMAL(_i)  (0x05910 + ((_i) * 8)) /* 4 of these (0-3) */
246#define IXGBE_MMAH(_i)  (0x05914 + ((_i) * 8)) /* 4 of these (0-3) */
247#define IXGBE_FTFT      0x09400 /* 0x9400-0x97FC */
248
249/* ARC Subsystem registers */
250#define IXGBE_HICR      0x15F00
251#define IXGBE_FWSTS     0x15F0C
252#define IXGBE_HSMC0R    0x15F04
253#define IXGBE_HSMC1R    0x15F08
254#define IXGBE_SWSR      0x15F10
255#define IXGBE_HFDR      0x15FE8
256#define IXGBE_FLEX_MNG  0x15800 /* 0x15800 - 0x15EFC */
257
258/* PCI-E registers */
259#define IXGBE_GCR       0x11000
260#define IXGBE_GTV       0x11004
261#define IXGBE_FUNCTAG   0x11008
262#define IXGBE_GLT       0x1100C
263#define IXGBE_GSCL_1    0x11010
264#define IXGBE_GSCL_2    0x11014
265#define IXGBE_GSCL_3    0x11018
266#define IXGBE_GSCL_4    0x1101C
267#define IXGBE_GSCN_0    0x11020
268#define IXGBE_GSCN_1    0x11024
269#define IXGBE_GSCN_2    0x11028
270#define IXGBE_GSCN_3    0x1102C
271#define IXGBE_FACTPS    0x10150
272#define IXGBE_PCIEANACTL  0x11040
273#define IXGBE_SWSM      0x10140
274#define IXGBE_FWSM      0x10148
275#define IXGBE_GSSR      0x10160
276#define IXGBE_MREVID    0x11064
277#define IXGBE_DCA_ID    0x11070
278#define IXGBE_DCA_CTRL  0x11074
279
280/* Diagnostic Registers */
281#define IXGBE_RDSTATCTL   0x02C20
282#define IXGBE_RDSTAT(_i)  (0x02C00 + ((_i) * 4)) /* 0x02C00-0x02C1C */
283#define IXGBE_RDHMPN      0x02F08
284#define IXGBE_RIC_DW(_i)  (0x02F10 + ((_i) * 4))
285#define IXGBE_RDPROBE     0x02F20
286#define IXGBE_TDSTATCTL   0x07C20
287#define IXGBE_TDSTAT(_i)  (0x07C00 + ((_i) * 4)) /* 0x07C00 - 0x07C1C */
288#define IXGBE_TDHMPN      0x07F08
289#define IXGBE_TIC_DW(_i)  (0x07F10 + ((_i) * 4))
290#define IXGBE_TDPROBE     0x07F20
291#define IXGBE_TXBUFCTRL   0x0C600
292#define IXGBE_TXBUFDATA0  0x0C610
293#define IXGBE_TXBUFDATA1  0x0C614
294#define IXGBE_TXBUFDATA2  0x0C618
295#define IXGBE_TXBUFDATA3  0x0C61C
296#define IXGBE_RXBUFCTRL   0x03600
297#define IXGBE_RXBUFDATA0  0x03610
298#define IXGBE_RXBUFDATA1  0x03614
299#define IXGBE_RXBUFDATA2  0x03618
300#define IXGBE_RXBUFDATA3  0x0361C
301#define IXGBE_PCIE_DIAG(_i)     (0x11090 + ((_i) * 4)) /* 8 of these */
302#define IXGBE_RFVAL     0x050A4
303#define IXGBE_MDFTC1    0x042B8
304#define IXGBE_MDFTC2    0x042C0
305#define IXGBE_MDFTFIFO1 0x042C4
306#define IXGBE_MDFTFIFO2 0x042C8
307#define IXGBE_MDFTS     0x042CC
308#define IXGBE_RXDATAWRPTR(_i)   (0x03700 + ((_i) * 4)) /* 8 of these 3700-370C*/
309#define IXGBE_RXDESCWRPTR(_i)   (0x03710 + ((_i) * 4)) /* 8 of these 3710-371C*/
310#define IXGBE_RXDATARDPTR(_i)   (0x03720 + ((_i) * 4)) /* 8 of these 3720-372C*/
311#define IXGBE_RXDESCRDPTR(_i)   (0x03730 + ((_i) * 4)) /* 8 of these 3730-373C*/
312#define IXGBE_TXDATAWRPTR(_i)   (0x0C700 + ((_i) * 4)) /* 8 of these C700-C70C*/
313#define IXGBE_TXDESCWRPTR(_i)   (0x0C710 + ((_i) * 4)) /* 8 of these C710-C71C*/
314#define IXGBE_TXDATARDPTR(_i)   (0x0C720 + ((_i) * 4)) /* 8 of these C720-C72C*/
315#define IXGBE_TXDESCRDPTR(_i)   (0x0C730 + ((_i) * 4)) /* 8 of these C730-C73C*/
316#define IXGBE_PCIEECCCTL 0x1106C
317#define IXGBE_PBTXECC   0x0C300
318#define IXGBE_PBRXECC   0x03300
319#define IXGBE_GHECCR    0x110B0
320
321/* MAC Registers */
322#define IXGBE_PCS1GCFIG 0x04200
323#define IXGBE_PCS1GLCTL 0x04208
324#define IXGBE_PCS1GLSTA 0x0420C
325#define IXGBE_PCS1GDBG0 0x04210
326#define IXGBE_PCS1GDBG1 0x04214
327#define IXGBE_PCS1GANA  0x04218
328#define IXGBE_PCS1GANLP 0x0421C
329#define IXGBE_PCS1GANNP 0x04220
330#define IXGBE_PCS1GANLPNP 0x04224
331#define IXGBE_HLREG0    0x04240
332#define IXGBE_HLREG1    0x04244
333#define IXGBE_PAP       0x04248
334#define IXGBE_MACA      0x0424C
335#define IXGBE_APAE      0x04250
336#define IXGBE_ARD       0x04254
337#define IXGBE_AIS       0x04258
338#define IXGBE_MSCA      0x0425C
339#define IXGBE_MSRWD     0x04260
340#define IXGBE_MLADD     0x04264
341#define IXGBE_MHADD     0x04268
342#define IXGBE_TREG      0x0426C
343#define IXGBE_PCSS1     0x04288
344#define IXGBE_PCSS2     0x0428C
345#define IXGBE_XPCSS     0x04290
346#define IXGBE_SERDESC   0x04298
347#define IXGBE_MACS      0x0429C
348#define IXGBE_AUTOC     0x042A0
349#define IXGBE_LINKS     0x042A4
350#define IXGBE_AUTOC2    0x042A8
351#define IXGBE_AUTOC3    0x042AC
352#define IXGBE_ANLP1     0x042B0
353#define IXGBE_ANLP2     0x042B4
354#define IXGBE_ATLASCTL  0x04800
355
356
357/* CTRL Bit Masks */
358#define IXGBE_CTRL_GIO_DIS      0x00000004 /* Global IO Master Disable bit */
359#define IXGBE_CTRL_LNK_RST      0x00000008 /* Link Reset. Resets everything. */
360#define IXGBE_CTRL_RST          0x04000000 /* Reset (SW) */
361
362/* FACTPS */
363#define IXGBE_FACTPS_LFS        0x40000000 /* LAN Function Select */
364
365/* MHADD Bit Masks */
366#define IXGBE_MHADD_MFS_MASK    0xFFFF0000
367#define IXGBE_MHADD_MFS_SHIFT   16
368
369/* Extended Device Control */
370#define IXGBE_CTRL_EXT_NS_DIS   0x00010000 /* No Snoop disable */
371#define IXGBE_CTRL_EXT_RO_DIS   0x00020000 /* Relaxed Ordering disable */
372#define IXGBE_CTRL_EXT_DRV_LOAD 0x10000000 /* Driver loaded bit for FW */
373
374/* Direct Cache Access (DCA) definitions */
375#define IXGBE_DCA_CTRL_DCA_ENABLE  0x00000000 /* DCA Enable */
376#define IXGBE_DCA_CTRL_DCA_DISABLE 0x00000001 /* DCA Disable */
377
378#define IXGBE_DCA_CTRL_DCA_MODE_CB1 0x00 /* DCA Mode CB1 */
379#define IXGBE_DCA_CTRL_DCA_MODE_CB2 0x02 /* DCA Mode CB2 */
380
381#define IXGBE_DCA_RXCTRL_CPUID_MASK 0x0000001F /* Rx CPUID Mask */
382#define IXGBE_DCA_RXCTRL_DESC_DCA_EN (1 << 5) /* DCA Rx Desc enable */
383#define IXGBE_DCA_RXCTRL_HEAD_DCA_EN (1 << 6) /* DCA Rx Desc header enable */
384#define IXGBE_DCA_RXCTRL_DATA_DCA_EN (1 << 7) /* DCA Rx Desc payload enable */
385
386#define IXGBE_DCA_TXCTRL_CPUID_MASK 0x0000001F /* Tx CPUID Mask */
387#define IXGBE_DCA_TXCTRL_DESC_DCA_EN (1 << 5) /* DCA Tx Desc enable */
388#define IXGBE_DCA_TXCTRL_TX_WB_RO_EN (1 << 11) /* TX Desc writeback RO bit */
389#define IXGBE_DCA_MAX_QUEUES_82598   16 /* DCA regs only on 16 queues */
390
391/* MSCA Bit Masks */
392#define IXGBE_MSCA_NP_ADDR_MASK      0x0000FFFF /* MDI Address (new protocol) */
393#define IXGBE_MSCA_NP_ADDR_SHIFT     0
394#define IXGBE_MSCA_DEV_TYPE_MASK     0x001F0000 /* Device Type (new protocol) */
395#define IXGBE_MSCA_DEV_TYPE_SHIFT    16 /* Register Address (old protocol */
396#define IXGBE_MSCA_PHY_ADDR_MASK     0x03E00000 /* PHY Address mask */
397#define IXGBE_MSCA_PHY_ADDR_SHIFT    21 /* PHY Address shift*/
398#define IXGBE_MSCA_OP_CODE_MASK      0x0C000000 /* OP CODE mask */
399#define IXGBE_MSCA_OP_CODE_SHIFT     26 /* OP CODE shift */
400#define IXGBE_MSCA_ADDR_CYCLE        0x00000000 /* OP CODE 00 (addr cycle) */
401#define IXGBE_MSCA_WRITE             0x04000000 /* OP CODE 01 (write) */
402#define IXGBE_MSCA_READ              0x08000000 /* OP CODE 10 (read) */
403#define IXGBE_MSCA_READ_AUTOINC      0x0C000000 /* OP CODE 11 (read, auto inc)*/
404#define IXGBE_MSCA_ST_CODE_MASK      0x30000000 /* ST Code mask */
405#define IXGBE_MSCA_ST_CODE_SHIFT     28 /* ST Code shift */
406#define IXGBE_MSCA_NEW_PROTOCOL      0x00000000 /* ST CODE 00 (new protocol) */
407#define IXGBE_MSCA_OLD_PROTOCOL      0x10000000 /* ST CODE 01 (old protocol) */
408#define IXGBE_MSCA_MDI_COMMAND       0x40000000 /* Initiate MDI command */
409#define IXGBE_MSCA_MDI_IN_PROG_EN    0x80000000 /* MDI in progress enable */
410
411/* MSRWD bit masks */
412#define IXGBE_MSRWD_WRITE_DATA_MASK     0x0000FFFF
413#define IXGBE_MSRWD_WRITE_DATA_SHIFT    0
414#define IXGBE_MSRWD_READ_DATA_MASK      0xFFFF0000
415#define IXGBE_MSRWD_READ_DATA_SHIFT     16
416
417/* Atlas registers */
418#define IXGBE_ATLAS_PDN_LPBK    0x24
419#define IXGBE_ATLAS_PDN_10G     0xB
420#define IXGBE_ATLAS_PDN_1G      0xC
421#define IXGBE_ATLAS_PDN_AN      0xD
422
423/* Atlas bit masks */
424#define IXGBE_ATLASCTL_WRITE_CMD        0x00010000
425#define IXGBE_ATLAS_PDN_TX_REG_EN       0x10
426#define IXGBE_ATLAS_PDN_TX_10G_QL_ALL   0xF0
427#define IXGBE_ATLAS_PDN_TX_1G_QL_ALL    0xF0
428#define IXGBE_ATLAS_PDN_TX_AN_QL_ALL    0xF0
429
430/* Device Type definitions for new protocol MDIO commands */
431#define IXGBE_MDIO_PMA_PMD_DEV_TYPE               0x1
432#define IXGBE_MDIO_PCS_DEV_TYPE                   0x3
433#define IXGBE_MDIO_PHY_XS_DEV_TYPE                0x4
434#define IXGBE_MDIO_AUTO_NEG_DEV_TYPE              0x7
435#define IXGBE_MDIO_VENDOR_SPECIFIC_1_DEV_TYPE     0x1E   /* Device 30 */
436
437#define IXGBE_MDIO_COMMAND_TIMEOUT     100 /* PHY Timeout for 1 GB mode */
438
439#define IXGBE_MDIO_VENDOR_SPECIFIC_1_CONTROL      0x0    /* VS1 Control Reg */
440#define IXGBE_MDIO_VENDOR_SPECIFIC_1_STATUS       0x1    /* VS1 Status Reg */
441#define IXGBE_MDIO_VENDOR_SPECIFIC_1_LINK_STATUS  0x0008 /* 1 = Link Up */
442#define IXGBE_MDIO_VENDOR_SPECIFIC_1_SPEED_STATUS 0x0010 /* 0 - 10G, 1 - 1G */
443#define IXGBE_MDIO_VENDOR_SPECIFIC_1_10G_SPEED    0x0018
444#define IXGBE_MDIO_VENDOR_SPECIFIC_1_1G_SPEED     0x0010
445
446#define IXGBE_MDIO_AUTO_NEG_CONTROL    0x0 /* AUTO_NEG Control Reg */
447#define IXGBE_MDIO_AUTO_NEG_STATUS     0x1 /* AUTO_NEG Status Reg */
448#define IXGBE_MDIO_PHY_XS_CONTROL      0x0 /* PHY_XS Control Reg */
449#define IXGBE_MDIO_PHY_XS_RESET        0x8000 /* PHY_XS Reset */
450#define IXGBE_MDIO_PHY_ID_HIGH         0x2 /* PHY ID High Reg*/
451#define IXGBE_MDIO_PHY_ID_LOW          0x3 /* PHY ID Low Reg*/
452#define IXGBE_MDIO_PHY_SPEED_ABILITY   0x4 /* Speed Abilty Reg */
453#define IXGBE_MDIO_PHY_SPEED_10G       0x0001 /* 10G capable */
454#define IXGBE_MDIO_PHY_SPEED_1G        0x0010 /* 1G capable */
455
456#define IXGBE_PHY_REVISION_MASK        0xFFFFFFF0
457#define IXGBE_MAX_PHY_ADDR             32
458
459/* PHY IDs*/
460#define QT2022_PHY_ID    0x0043A400
461
462/* General purpose Interrupt Enable */
463#define IXGBE_GPIE_MSIX_MODE      0x00000010 /* MSI-X mode */
464#define IXGBE_GPIE_OCD            0x00000020 /* Other Clear Disable */
465#define IXGBE_GPIE_EIMEN          0x00000040 /* Immediate Interrupt Enable */
466#define IXGBE_GPIE_EIAME          0x40000000
467#define IXGBE_GPIE_PBA_SUPPORT    0x80000000
468
469/* Transmit Flow Control status */
470#define IXGBE_TFCS_TXOFF         0x00000001
471#define IXGBE_TFCS_TXOFF0        0x00000100
472#define IXGBE_TFCS_TXOFF1        0x00000200
473#define IXGBE_TFCS_TXOFF2        0x00000400
474#define IXGBE_TFCS_TXOFF3        0x00000800
475#define IXGBE_TFCS_TXOFF4        0x00001000
476#define IXGBE_TFCS_TXOFF5        0x00002000
477#define IXGBE_TFCS_TXOFF6        0x00004000
478#define IXGBE_TFCS_TXOFF7        0x00008000
479
480/* TCP Timer */
481#define IXGBE_TCPTIMER_KS            0x00000100
482#define IXGBE_TCPTIMER_COUNT_ENABLE  0x00000200
483#define IXGBE_TCPTIMER_COUNT_FINISH  0x00000400
484#define IXGBE_TCPTIMER_LOOP          0x00000800
485#define IXGBE_TCPTIMER_DURATION_MASK 0x000000FF
486
487/* HLREG0 Bit Masks */
488#define IXGBE_HLREG0_TXCRCEN      0x00000001   /* bit  0 */
489#define IXGBE_HLREG0_RXCRCSTRP    0x00000002   /* bit  1 */
490#define IXGBE_HLREG0_JUMBOEN      0x00000004   /* bit  2 */
491#define IXGBE_HLREG0_TXPADEN      0x00000400   /* bit 10 */
492#define IXGBE_HLREG0_TXPAUSEEN    0x00001000   /* bit 12 */
493#define IXGBE_HLREG0_RXPAUSEEN    0x00004000   /* bit 14 */
494#define IXGBE_HLREG0_LPBK         0x00008000   /* bit 15 */
495#define IXGBE_HLREG0_MDCSPD       0x00010000   /* bit 16 */
496#define IXGBE_HLREG0_CONTMDC      0x00020000   /* bit 17 */
497#define IXGBE_HLREG0_CTRLFLTR     0x00040000   /* bit 18 */
498#define IXGBE_HLREG0_PREPEND      0x00F00000   /* bits 20-23 */
499#define IXGBE_HLREG0_PRIPAUSEEN   0x01000000   /* bit 24 */
500#define IXGBE_HLREG0_RXPAUSERECDA 0x06000000   /* bits 25-26 */
501#define IXGBE_HLREG0_RXLNGTHERREN 0x08000000   /* bit 27 */
502#define IXGBE_HLREG0_RXPADSTRIPEN 0x10000000   /* bit 28 */
503
504/* VMD_CTL bitmasks */
505#define IXGBE_VMD_CTL_VMDQ_EN     0x00000001
506#define IXGBE_VMD_CTL_VMDQ_FILTER 0x00000002
507
508/* RDHMPN and TDHMPN bitmasks */
509#define IXGBE_RDHMPN_RDICADDR       0x007FF800
510#define IXGBE_RDHMPN_RDICRDREQ      0x00800000
511#define IXGBE_RDHMPN_RDICADDR_SHIFT 11
512#define IXGBE_TDHMPN_TDICADDR       0x003FF800
513#define IXGBE_TDHMPN_TDICRDREQ      0x00800000
514#define IXGBE_TDHMPN_TDICADDR_SHIFT 11
515
516/* Receive Checksum Control */
517#define IXGBE_RXCSUM_IPPCSE     0x00001000   /* IP payload checksum enable */
518#define IXGBE_RXCSUM_PCSD       0x00002000   /* packet checksum disabled */
519
520/* FCRTL Bit Masks */
521#define IXGBE_FCRTL_XONE        0x80000000  /* bit 31, XON enable */
522#define IXGBE_FCRTH_FCEN        0x80000000  /* Rx Flow control enable */
523
524/* PAP bit masks*/
525#define IXGBE_PAP_TXPAUSECNT_MASK   0x0000FFFF /* Pause counter mask */
526
527/* RMCS Bit Masks */
528#define IXGBE_RMCS_RRM          0x00000002 /* Receive Recylce Mode enable */
529/* Receive Arbitration Control: 0 Round Robin, 1 DFP */
530#define IXGBE_RMCS_RAC          0x00000004
531#define IXGBE_RMCS_DFP          IXGBE_RMCS_RAC /* Deficit Fixed Priority ena */
532#define IXGBE_RMCS_TFCE_802_3X  0x00000008 /* Tx Priority flow control ena */
533#define IXGBE_RMCS_TFCE_PRIORITY 0x00000010 /* Tx Priority flow control ena */
534#define IXGBE_RMCS_ARBDIS       0x00000040 /* Arbitration disable bit */
535
536/* Interrupt register bitmasks */
537
538/* Extended Interrupt Cause Read */
539#define IXGBE_EICR_RTX_QUEUE    0x0000FFFF /* RTx Queue Interrupt */
540#define IXGBE_EICR_LSC          0x00100000 /* Link Status Change */
541#define IXGBE_EICR_MNG          0x00400000 /* Managability Event Interrupt */
542#define IXGBE_EICR_PBUR         0x10000000 /* Packet Buffer Handler Error */
543#define IXGBE_EICR_DHER         0x20000000 /* Descriptor Handler Error */
544#define IXGBE_EICR_TCP_TIMER    0x40000000 /* TCP Timer */
545#define IXGBE_EICR_OTHER        0x80000000 /* Interrupt Cause Active */
546
547/* Extended Interrupt Cause Set */
548#define IXGBE_EICS_RTX_QUEUE    IXGBE_EICR_RTX_QUEUE /* RTx Queue Interrupt */
549#define IXGBE_EICS_LSC          IXGBE_EICR_LSC /* Link Status Change */
550#define IXGBE_EICR_GPI_SDP0     0x01000000 /* Gen Purpose Interrupt on SDP0 */
551#define IXGBE_EICS_MNG          IXGBE_EICR_MNG /* MNG Event Interrupt */
552#define IXGBE_EICS_PBUR         IXGBE_EICR_PBUR /* Pkt Buf Handler Error */
553#define IXGBE_EICS_DHER         IXGBE_EICR_DHER /* Desc Handler Error */
554#define IXGBE_EICS_TCP_TIMER    IXGBE_EICR_TCP_TIMER /* TCP Timer */
555#define IXGBE_EICS_OTHER        IXGBE_EICR_OTHER     /* INT Cause Active */
556
557/* Extended Interrupt Mask Set */
558#define IXGBE_EIMS_RTX_QUEUE    IXGBE_EICR_RTX_QUEUE /* RTx Queue Interrupt */
559#define IXGBE_EIMS_LSC          IXGBE_EICR_LSC       /* Link Status Change */
560#define IXGBE_EIMS_MNG          IXGBE_EICR_MNG       /* MNG Event Interrupt */
561#define IXGBE_EIMS_PBUR         IXGBE_EICR_PBUR      /* Pkt Buf Handler Error */
562#define IXGBE_EIMS_DHER         IXGBE_EICR_DHER      /* Descr Handler Error */
563#define IXGBE_EIMS_TCP_TIMER    IXGBE_EICR_TCP_TIMER /* TCP Timer */
564#define IXGBE_EIMS_OTHER        IXGBE_EICR_OTHER     /* INT Cause Active */
565
566/* Extended Interrupt Mask Clear */
567#define IXGBE_EIMC_RTX_QUEUE    IXGBE_EICR_RTX_QUEUE /* RTx Queue Interrupt */
568#define IXGBE_EIMC_LSC          IXGBE_EICR_LSC       /* Link Status Change */
569#define IXGBE_EIMC_MNG          IXGBE_EICR_MNG       /* MNG Event Interrupt */
570#define IXGBE_EIMC_PBUR         IXGBE_EICR_PBUR      /* Pkt Buf Handler Error */
571#define IXGBE_EIMC_DHER         IXGBE_EICR_DHER      /* Desc Handler Error */
572#define IXGBE_EIMC_TCP_TIMER    IXGBE_EICR_TCP_TIMER /* TCP Timer */
573#define IXGBE_EIMC_OTHER        IXGBE_EICR_OTHER     /* INT Cause Active */
574
575#define IXGBE_EIMS_ENABLE_MASK ( \
576				IXGBE_EIMS_RTX_QUEUE       | \
577				IXGBE_EIMS_LSC             | \
578				IXGBE_EIMS_TCP_TIMER       | \
579				IXGBE_EIMS_OTHER)
580
581/* Immediate Interrupt RX (A.K.A. Low Latency Interrupt) */
582#define IXGBE_IMIR_PORT_IM_EN     0x00010000  /* TCP port enable */
583#define IXGBE_IMIR_PORT_BP        0x00020000  /* TCP port check bypass */
584#define IXGBE_IMIREXT_SIZE_BP     0x00001000  /* Packet size bypass */
585#define IXGBE_IMIREXT_CTRL_URG    0x00002000  /* Check URG bit in header */
586#define IXGBE_IMIREXT_CTRL_ACK    0x00004000  /* Check ACK bit in header */
587#define IXGBE_IMIREXT_CTRL_PSH    0x00008000  /* Check PSH bit in header */
588#define IXGBE_IMIREXT_CTRL_RST    0x00010000  /* Check RST bit in header */
589#define IXGBE_IMIREXT_CTRL_SYN    0x00020000  /* Check SYN bit in header */
590#define IXGBE_IMIREXT_CTRL_FIN    0x00040000  /* Check FIN bit in header */
591#define IXGBE_IMIREXT_CTRL_BP     0x00080000  /* Bypass check of control bits */
592
593/* Interrupt clear mask */
594#define IXGBE_IRQ_CLEAR_MASK    0xFFFFFFFF
595
596/* Interrupt Vector Allocation Registers */
597#define IXGBE_IVAR_REG_NUM      25
598#define IXGBE_IVAR_TXRX_ENTRY   96
599#define IXGBE_IVAR_RX_ENTRY     64
600#define IXGBE_IVAR_RX_QUEUE(_i)    (0 + (_i))
601#define IXGBE_IVAR_TX_QUEUE(_i)    (64 + (_i))
602#define IXGBE_IVAR_TX_ENTRY     32
603
604#define IXGBE_IVAR_TCP_TIMER_INDEX       96 /* 0 based index */
605#define IXGBE_IVAR_OTHER_CAUSES_INDEX    97 /* 0 based index */
606
607#define IXGBE_MSIX_VECTOR(_i)   (0 + (_i))
608
609#define IXGBE_IVAR_ALLOC_VAL    0x80 /* Interrupt Allocation valid */
610
611/* VLAN Control Bit Masks */
612#define IXGBE_VLNCTRL_VET       0x0000FFFF  /* bits 0-15 */
613#define IXGBE_VLNCTRL_CFI       0x10000000  /* bit 28 */
614#define IXGBE_VLNCTRL_CFIEN     0x20000000  /* bit 29 */
615#define IXGBE_VLNCTRL_VFE       0x40000000  /* bit 30 */
616#define IXGBE_VLNCTRL_VME       0x80000000  /* bit 31 */
617
618#define IXGBE_ETHERNET_IEEE_VLAN_TYPE 0x8100  /* 802.1q protocol */
619
620/* STATUS Bit Masks */
621#define IXGBE_STATUS_LAN_ID     0x0000000C /* LAN ID */
622#define IXGBE_STATUS_GIO        0x00080000 /* GIO Master Enable Status */
623
624#define IXGBE_STATUS_LAN_ID_0   0x00000000 /* LAN ID 0 */
625#define IXGBE_STATUS_LAN_ID_1   0x00000004 /* LAN ID 1 */
626
627/* ESDP Bit Masks */
628#define IXGBE_ESDP_SDP4 0x00000001 /* SDP4 Data Value */
629#define IXGBE_ESDP_SDP5 0x00000002 /* SDP5 Data Value */
630#define IXGBE_ESDP_SDP4_DIR     0x00000004 /* SDP4 IO direction */
631#define IXGBE_ESDP_SDP5_DIR     0x00000008 /* SDP5 IO direction */
632
633/* LEDCTL Bit Masks */
634#define IXGBE_LED_IVRT_BASE      0x00000040
635#define IXGBE_LED_BLINK_BASE     0x00000080
636#define IXGBE_LED_MODE_MASK_BASE 0x0000000F
637#define IXGBE_LED_OFFSET(_base, _i) (_base << (8 * (_i)))
638#define IXGBE_LED_MODE_SHIFT(_i) (8*(_i))
639#define IXGBE_LED_IVRT(_i)       IXGBE_LED_OFFSET(IXGBE_LED_IVRT_BASE, _i)
640#define IXGBE_LED_BLINK(_i)      IXGBE_LED_OFFSET(IXGBE_LED_BLINK_BASE, _i)
641#define IXGBE_LED_MODE_MASK(_i)  IXGBE_LED_OFFSET(IXGBE_LED_MODE_MASK_BASE, _i)
642
643/* LED modes */
644#define IXGBE_LED_LINK_UP       0x0
645#define IXGBE_LED_LINK_10G      0x1
646#define IXGBE_LED_MAC           0x2
647#define IXGBE_LED_FILTER        0x3
648#define IXGBE_LED_LINK_ACTIVE   0x4
649#define IXGBE_LED_LINK_1G       0x5
650#define IXGBE_LED_ON            0xE
651#define IXGBE_LED_OFF           0xF
652
653/* AUTOC Bit Masks */
654#define IXGBE_AUTOC_KX4_SUPP    0x80000000
655#define IXGBE_AUTOC_KX_SUPP     0x40000000
656#define IXGBE_AUTOC_PAUSE       0x30000000
657#define IXGBE_AUTOC_RF          0x08000000
658#define IXGBE_AUTOC_PD_TMR      0x06000000
659#define IXGBE_AUTOC_AN_RX_LOOSE 0x01000000
660#define IXGBE_AUTOC_AN_RX_DRIFT 0x00800000
661#define IXGBE_AUTOC_AN_RX_ALIGN 0x007C0000
662#define IXGBE_AUTOC_AN_RESTART  0x00001000
663#define IXGBE_AUTOC_FLU         0x00000001
664#define IXGBE_AUTOC_LMS_SHIFT   13
665#define IXGBE_AUTOC_LMS_MASK   (0x7 << IXGBE_AUTOC_LMS_SHIFT)
666#define IXGBE_AUTOC_LMS_1G_LINK_NO_AN  (0x0 << IXGBE_AUTOC_LMS_SHIFT)
667#define IXGBE_AUTOC_LMS_10G_LINK_NO_AN (0x1 << IXGBE_AUTOC_LMS_SHIFT)
668#define IXGBE_AUTOC_LMS_1G_AN  (0x2 << IXGBE_AUTOC_LMS_SHIFT)
669#define IXGBE_AUTOC_LMS_KX4_AN (0x4 << IXGBE_AUTOC_LMS_SHIFT)
670#define IXGBE_AUTOC_LMS_KX4_AN_1G_AN   (0x6 << IXGBE_AUTOC_LMS_SHIFT)
671#define IXGBE_AUTOC_LMS_ATTACH_TYPE    (0x7 << IXGBE_AUTOC_10G_PMA_PMD_SHIFT)
672
673#define IXGBE_AUTOC_1G_PMA_PMD      0x00000200
674#define IXGBE_AUTOC_10G_PMA_PMD     0x00000180
675#define IXGBE_AUTOC_10G_PMA_PMD_SHIFT 7
676#define IXGBE_AUTOC_1G_PMA_PMD_SHIFT 9
677#define IXGBE_AUTOC_10G_XAUI   (0x0 << IXGBE_AUTOC_10G_PMA_PMD_SHIFT)
678#define IXGBE_AUTOC_10G_KX4    (0x1 << IXGBE_AUTOC_10G_PMA_PMD_SHIFT)
679#define IXGBE_AUTOC_10G_CX4    (0x2 << IXGBE_AUTOC_10G_PMA_PMD_SHIFT)
680#define IXGBE_AUTOC_1G_BX      (0x0 << IXGBE_AUTOC_1G_PMA_PMD_SHIFT)
681#define IXGBE_AUTOC_1G_KX      (0x1 << IXGBE_AUTOC_1G_PMA_PMD_SHIFT)
682
683/* LINKS Bit Masks */
684#define IXGBE_LINKS_KX_AN_COMP  0x80000000
685#define IXGBE_LINKS_UP          0x40000000
686#define IXGBE_LINKS_SPEED       0x20000000
687#define IXGBE_LINKS_MODE        0x18000000
688#define IXGBE_LINKS_RX_MODE     0x06000000
689#define IXGBE_LINKS_TX_MODE     0x01800000
690#define IXGBE_LINKS_XGXS_EN     0x00400000
691#define IXGBE_LINKS_PCS_1G_EN   0x00200000
692#define IXGBE_LINKS_1G_AN_EN    0x00100000
693#define IXGBE_LINKS_KX_AN_IDLE  0x00080000
694#define IXGBE_LINKS_1G_SYNC     0x00040000
695#define IXGBE_LINKS_10G_ALIGN   0x00020000
696#define IXGBE_LINKS_10G_LANE_SYNC 0x00017000
697#define IXGBE_LINKS_TL_FAULT    0x00001000
698#define IXGBE_LINKS_SIGNAL      0x00000F00
699
700#define IXGBE_AUTO_NEG_TIME     45 /* 4.5 Seconds */
701
702#define FIBER_LINK_UP_LIMIT     50
703
704/* PCS1GLSTA Bit Masks */
705#define IXGBE_PCS1GLSTA_LINK_OK         1
706#define IXGBE_PCS1GLSTA_SYNK_OK         0x10
707#define IXGBE_PCS1GLSTA_AN_COMPLETE     0x10000
708#define IXGBE_PCS1GLSTA_AN_PAGE_RX      0x20000
709#define IXGBE_PCS1GLSTA_AN_TIMED_OUT    0x40000
710#define IXGBE_PCS1GLSTA_AN_REMOTE_FAULT 0x80000
711#define IXGBE_PCS1GLSTA_AN_ERROR_RWS    0x100000
712
713#define IXGBE_PCS1GANA_SYM_PAUSE        0x80
714#define IXGBE_PCS1GANA_ASM_PAUSE        0x100
715
716/* PCS1GLCTL Bit Masks */
717#define IXGBE_PCS1GLCTL_AN_1G_TIMEOUT_EN  0x00040000 /* PCS 1G autoneg timeout enable (bit 18) */
718#define IXGBE_PCS1GLCTL_FLV_LINK_UP     1
719#define IXGBE_PCS1GLCTL_FORCE_LINK      0x20
720#define IXGBE_PCS1GLCTL_LOW_LINK_LATCH  0x40
721#define IXGBE_PCS1GLCTL_AN_ENABLE       0x10000
722#define IXGBE_PCS1GLCTL_AN_RESTART      0x20000
723
724/* SW Semaphore Register bitmasks */
725#define IXGBE_SWSM_SMBI 0x00000001 /* Driver Semaphore bit */
726#define IXGBE_SWSM_SWESMBI 0x00000002 /* FW Semaphore bit */
727#define IXGBE_SWSM_WMNG 0x00000004 /* Wake MNG Clock */
728
729/* GSSR definitions */
730#define IXGBE_GSSR_EEP_SM     0x0001
731#define IXGBE_GSSR_PHY0_SM    0x0002
732#define IXGBE_GSSR_PHY1_SM    0x0004
733#define IXGBE_GSSR_MAC_CSR_SM 0x0008
734#define IXGBE_GSSR_FLASH_SM   0x0010
735
736/* EEC Register */
737#define IXGBE_EEC_SK        0x00000001 /* EEPROM Clock */
738#define IXGBE_EEC_CS        0x00000002 /* EEPROM Chip Select */
739#define IXGBE_EEC_DI        0x00000004 /* EEPROM Data In */
740#define IXGBE_EEC_DO        0x00000008 /* EEPROM Data Out */
741#define IXGBE_EEC_FWE_MASK  0x00000030 /* FLASH Write Enable */
742#define IXGBE_EEC_FWE_DIS   0x00000010 /* Disable FLASH writes */
743#define IXGBE_EEC_FWE_EN    0x00000020 /* Enable FLASH writes */
744#define IXGBE_EEC_FWE_SHIFT 4
745#define IXGBE_EEC_REQ       0x00000040 /* EEPROM Access Request */
746#define IXGBE_EEC_GNT       0x00000080 /* EEPROM Access Grant */
747#define IXGBE_EEC_PRES      0x00000100 /* EEPROM Present */
748#define IXGBE_EEC_ARD       0x00000200 /* EEPROM Auto Read Done */
749/* EEPROM Addressing bits based on type (0-small, 1-large) */
750#define IXGBE_EEC_ADDR_SIZE 0x00000400
751#define IXGBE_EEC_SIZE      0x00007800 /* EEPROM Size */
752
753#define IXGBE_EEC_SIZE_SHIFT          11
754#define IXGBE_EEPROM_WORD_SIZE_SHIFT  6
755#define IXGBE_EEPROM_OPCODE_BITS      8
756
757/* Checksum and EEPROM pointers */
758#define IXGBE_EEPROM_CHECKSUM   0x3F
759#define IXGBE_EEPROM_SUM        0xBABA
760#define IXGBE_PCIE_ANALOG_PTR   0x03
761#define IXGBE_ATLAS0_CONFIG_PTR 0x04
762#define IXGBE_ATLAS1_CONFIG_PTR 0x05
763#define IXGBE_PCIE_GENERAL_PTR  0x06
764#define IXGBE_PCIE_CONFIG0_PTR  0x07
765#define IXGBE_PCIE_CONFIG1_PTR  0x08
766#define IXGBE_CORE0_PTR         0x09
767#define IXGBE_CORE1_PTR         0x0A
768#define IXGBE_MAC0_PTR          0x0B
769#define IXGBE_MAC1_PTR          0x0C
770#define IXGBE_CSR0_CONFIG_PTR   0x0D
771#define IXGBE_CSR1_CONFIG_PTR   0x0E
772#define IXGBE_FW_PTR            0x0F
773
774/* Legacy EEPROM word offsets */
775#define IXGBE_ISCSI_BOOT_CAPS           0x0033
776#define IXGBE_ISCSI_SETUP_PORT_0        0x0030
777#define IXGBE_ISCSI_SETUP_PORT_1        0x0034
778
779/* EEPROM Commands - SPI */
780#define IXGBE_EEPROM_MAX_RETRY_SPI      5000 /* Max wait 5ms for RDY signal */
781#define IXGBE_EEPROM_STATUS_RDY_SPI     0x01
782#define IXGBE_EEPROM_READ_OPCODE_SPI    0x03  /* EEPROM read opcode */
783#define IXGBE_EEPROM_WRITE_OPCODE_SPI   0x02  /* EEPROM write opcode */
784#define IXGBE_EEPROM_A8_OPCODE_SPI      0x08  /* opcode bit-3 = addr bit-8 */
785#define IXGBE_EEPROM_WREN_OPCODE_SPI    0x06  /* EEPROM set Write Ena latch */
786/* EEPROM reset Write Enbale latch */
787#define IXGBE_EEPROM_WRDI_OPCODE_SPI    0x04
788#define IXGBE_EEPROM_RDSR_OPCODE_SPI    0x05  /* EEPROM read Status reg */
789#define IXGBE_EEPROM_WRSR_OPCODE_SPI    0x01  /* EEPROM write Status reg */
790#define IXGBE_EEPROM_ERASE4K_OPCODE_SPI 0x20  /* EEPROM ERASE 4KB */
791#define IXGBE_EEPROM_ERASE64K_OPCODE_SPI  0xD8  /* EEPROM ERASE 64KB */
792#define IXGBE_EEPROM_ERASE256_OPCODE_SPI  0xDB  /* EEPROM ERASE 256B */
793
794/* EEPROM Read Register */
795#define IXGBE_EEPROM_READ_REG_DATA   16   /* data offset in EEPROM read reg */
796#define IXGBE_EEPROM_READ_REG_DONE   2    /* Offset to READ done bit */
797#define IXGBE_EEPROM_READ_REG_START  1    /* First bit to start operation */
798#define IXGBE_EEPROM_READ_ADDR_SHIFT 2    /* Shift to the address bits */
799
800#define IXGBE_ETH_LENGTH_OF_ADDRESS   6
801
802#ifndef IXGBE_EEPROM_GRANT_ATTEMPTS
803#define IXGBE_EEPROM_GRANT_ATTEMPTS 1000 /* EEPROM # attempts to gain grant */
804#endif
805
806#ifndef IXGBE_EERD_ATTEMPTS
807/* Number of 5 microseconds we wait for EERD read to complete */
808#define IXGBE_EERD_ATTEMPTS 100000
809#endif
810
811/* PCI Bus Info */
812#define IXGBE_PCI_LINK_STATUS     0xB2
813#define IXGBE_PCI_LINK_WIDTH      0x3F0
814#define IXGBE_PCI_LINK_WIDTH_1    0x10
815#define IXGBE_PCI_LINK_WIDTH_2    0x20
816#define IXGBE_PCI_LINK_WIDTH_4    0x40
817#define IXGBE_PCI_LINK_WIDTH_8    0x80
818#define IXGBE_PCI_LINK_SPEED      0xF
819#define IXGBE_PCI_LINK_SPEED_2500 0x1
820#define IXGBE_PCI_LINK_SPEED_5000 0x2
821#define IXGBE_PCI_HEADER_TYPE_REGISTER  0x0E
822#define IXGBE_PCI_HEADER_TYPE_MULTIFUNC 0x80
823
824/* Number of 100 microseconds we wait for PCI Express master disable */
825#define IXGBE_PCI_MASTER_DISABLE_TIMEOUT 800
826
827/* PHY Types */
828#define IXGBE_M88E1145_E_PHY_ID  0x01410CD0
829
830/* Check whether address is multicast.  This is little-endian specific check.*/
831#define IXGBE_IS_MULTICAST(Address) \
832		(bool)(((u8 *)(Address))[0] & ((u8)0x01))
833
834/* Check whether an address is broadcast. */
835#define IXGBE_IS_BROADCAST(Address)                      \
836		((((u8 *)(Address))[0] == ((u8)0xff)) && \
837		(((u8 *)(Address))[1] == ((u8)0xff)))
838
839/* RAH */
840#define IXGBE_RAH_VIND_MASK     0x003C0000
841#define IXGBE_RAH_VIND_SHIFT    18
842#define IXGBE_RAH_AV            0x80000000
843
844/* Filters */
845#define IXGBE_MC_TBL_SIZE       128  /* Multicast Filter Table (4096 bits) */
846#define IXGBE_VLAN_FILTER_TBL_SIZE 128  /* VLAN Filter Table (4096 bits) */
847
848/* Header split receive */
849#define IXGBE_RFCTL_ISCSI_DIS       0x00000001
850#define IXGBE_RFCTL_ISCSI_DWC_MASK  0x0000003E
851#define IXGBE_RFCTL_ISCSI_DWC_SHIFT 1
852#define IXGBE_RFCTL_NFSW_DIS        0x00000040
853#define IXGBE_RFCTL_NFSR_DIS        0x00000080
854#define IXGBE_RFCTL_NFS_VER_MASK    0x00000300
855#define IXGBE_RFCTL_NFS_VER_SHIFT   8
856#define IXGBE_RFCTL_NFS_VER_2       0
857#define IXGBE_RFCTL_NFS_VER_3       1
858#define IXGBE_RFCTL_NFS_VER_4       2
859#define IXGBE_RFCTL_IPV6_DIS        0x00000400
860#define IXGBE_RFCTL_IPV6_XSUM_DIS   0x00000800
861#define IXGBE_RFCTL_IPFRSP_DIS      0x00004000
862#define IXGBE_RFCTL_IPV6_EX_DIS     0x00010000
863#define IXGBE_RFCTL_NEW_IPV6_EXT_DIS 0x00020000
864
865/* Transmit Config masks */
866#define IXGBE_TXDCTL_ENABLE     0x02000000 /* Enable specific Tx Queue */
867#define IXGBE_TXDCTL_SWFLSH     0x04000000 /* Tx Desc. write-back flushing */
868/* Enable short packet padding to 64 bytes */
869#define IXGBE_TX_PAD_ENABLE     0x00000400
870#define IXGBE_JUMBO_FRAME_ENABLE 0x00000004  /* Allow jumbo frames */
871/* This allows for 16K packets + 4k for vlan */
872#define IXGBE_MAX_FRAME_SZ      0x40040000
873
874#define IXGBE_TDWBAL_HEAD_WB_ENABLE   0x1      /* Tx head write-back enable */
875#define IXGBE_TDWBAL_SEQNUM_WB_ENABLE 0x2      /* Tx seq. # write-back enable */
876
877/* Receive Config masks */
878#define IXGBE_RXCTRL_RXEN       0x00000001  /* Enable Receiver */
879#define IXGBE_RXCTRL_DMBYPS     0x00000002  /* Descriptor Monitor Bypass */
880#define IXGBE_RXDCTL_ENABLE     0x02000000  /* Enable specific Rx Queue */
881
882#define IXGBE_FCTRL_SBP 0x00000002 /* Store Bad Packet */
883#define IXGBE_FCTRL_MPE 0x00000100 /* Multicast Promiscuous Ena*/
884#define IXGBE_FCTRL_UPE 0x00000200 /* Unicast Promiscuous Ena */
885#define IXGBE_FCTRL_BAM 0x00000400 /* Broadcast Accept Mode */
886#define IXGBE_FCTRL_PMCF 0x00001000 /* Pass MAC Control Frames */
887#define IXGBE_FCTRL_DPF 0x00002000 /* Discard Pause Frame */
888/* Receive Priority Flow Control Enbale */
889#define IXGBE_FCTRL_RPFCE 0x00004000
890#define IXGBE_FCTRL_RFCE 0x00008000 /* Receive Flow Control Ena */
891
892/* Multiple Receive Queue Control */
893#define IXGBE_MRQC_RSSEN                 0x00000001  /* RSS Enable */
894#define IXGBE_MRQC_RSS_FIELD_MASK        0xFFFF0000
895#define IXGBE_MRQC_RSS_FIELD_IPV4_TCP    0x00010000
896#define IXGBE_MRQC_RSS_FIELD_IPV4        0x00020000
897#define IXGBE_MRQC_RSS_FIELD_IPV6_EX_TCP 0x00040000
898#define IXGBE_MRQC_RSS_FIELD_IPV6_EX     0x00080000
899#define IXGBE_MRQC_RSS_FIELD_IPV6        0x00100000
900#define IXGBE_MRQC_RSS_FIELD_IPV6_TCP    0x00200000
901#define IXGBE_MRQC_RSS_FIELD_IPV4_UDP    0x00400000
902#define IXGBE_MRQC_RSS_FIELD_IPV6_UDP    0x00800000
903#define IXGBE_MRQC_RSS_FIELD_IPV6_EX_UDP 0x01000000
904
905#define IXGBE_TXD_POPTS_IXSM 0x01       /* Insert IP checksum */
906#define IXGBE_TXD_POPTS_TXSM 0x02       /* Insert TCP/UDP checksum */
907#define IXGBE_TXD_CMD_EOP    0x01000000 /* End of Packet */
908#define IXGBE_TXD_CMD_IFCS   0x02000000 /* Insert FCS (Ethernet CRC) */
909#define IXGBE_TXD_CMD_IC     0x04000000 /* Insert Checksum */
910#define IXGBE_TXD_CMD_RS     0x08000000 /* Report Status */
911#define IXGBE_TXD_CMD_DEXT   0x20000000 /* Descriptor extension (0 = legacy) */
912#define IXGBE_TXD_CMD_VLE    0x40000000 /* Add VLAN tag */
913#define IXGBE_TXD_STAT_DD    0x00000001 /* Descriptor Done */
914
915/* Receive Descriptor bit definitions */
916#define IXGBE_RXD_STAT_DD       0x01    /* Descriptor Done */
917#define IXGBE_RXD_STAT_EOP      0x02    /* End of Packet */
918#define IXGBE_RXD_STAT_IXSM     0x04    /* Ignore checksum */
919#define IXGBE_RXD_STAT_VP       0x08    /* IEEE VLAN Packet */
920#define IXGBE_RXD_STAT_UDPCS    0x10    /* UDP xsum caculated */
921#define IXGBE_RXD_STAT_L4CS     0x20    /* L4 xsum calculated */
922#define IXGBE_RXD_STAT_IPCS     0x40    /* IP xsum calculated */
923#define IXGBE_RXD_STAT_PIF      0x80    /* passed in-exact filter */
924#define IXGBE_RXD_STAT_CRCV     0x100   /* Speculative CRC Valid */
925#define IXGBE_RXD_STAT_VEXT     0x200   /* 1st VLAN found */
926#define IXGBE_RXD_STAT_UDPV     0x400   /* Valid UDP checksum */
927#define IXGBE_RXD_STAT_DYNINT   0x800   /* Pkt caused INT via DYNINT */
928#define IXGBE_RXD_STAT_ACK      0x8000  /* ACK Packet indication */
929#define IXGBE_RXD_ERR_CE        0x01    /* CRC Error */
930#define IXGBE_RXD_ERR_LE        0x02    /* Length Error */
931#define IXGBE_RXD_ERR_PE        0x08    /* Packet Error */
932#define IXGBE_RXD_ERR_OSE       0x10    /* Oversize Error */
933#define IXGBE_RXD_ERR_USE       0x20    /* Undersize Error */
934#define IXGBE_RXD_ERR_TCPE      0x40    /* TCP/UDP Checksum Error */
935#define IXGBE_RXD_ERR_IPE       0x80    /* IP Checksum Error */
936#define IXGBE_RXDADV_HBO        0x00800000
937#define IXGBE_RXDADV_ERR_CE     0x01000000 /* CRC Error */
938#define IXGBE_RXDADV_ERR_LE     0x02000000 /* Length Error */
939#define IXGBE_RXDADV_ERR_PE     0x08000000 /* Packet Error */
940#define IXGBE_RXDADV_ERR_OSE    0x10000000 /* Oversize Error */
941#define IXGBE_RXDADV_ERR_USE    0x20000000 /* Undersize Error */
942#define IXGBE_RXDADV_ERR_TCPE   0x40000000 /* TCP/UDP Checksum Error */
943#define IXGBE_RXDADV_ERR_IPE    0x80000000 /* IP Checksum Error */
944#define IXGBE_RXD_VLAN_ID_MASK  0x0FFF  /* VLAN ID is in lower 12 bits */
945#define IXGBE_RXD_PRI_MASK      0xE000  /* Priority is in upper 3 bits */
946#define IXGBE_RXD_PRI_SHIFT     13
947#define IXGBE_RXD_CFI_MASK      0x1000  /* CFI is bit 12 */
948#define IXGBE_RXD_CFI_SHIFT     12
949
950/* SRRCTL bit definitions */
951#define IXGBE_SRRCTL_BSIZEPKT_SHIFT     10     /* so many KBs */
952#define IXGBE_SRRCTL_BSIZEPKT_MASK      0x0000007F
953#define IXGBE_SRRCTL_BSIZEHDR_MASK      0x00003F00
954#define IXGBE_SRRCTL_DESCTYPE_LEGACY    0x00000000
955#define IXGBE_SRRCTL_DESCTYPE_ADV_ONEBUF 0x02000000
956#define IXGBE_SRRCTL_DESCTYPE_HDR_SPLIT  0x04000000
957#define IXGBE_SRRCTL_DESCTYPE_HDR_REPLICATION_LARGE_PKT 0x08000000
958#define IXGBE_SRRCTL_DESCTYPE_HDR_SPLIT_ALWAYS 0x0A000000
959#define IXGBE_SRRCTL_DESCTYPE_MASK      0x0E000000
960
961#define IXGBE_RXDPS_HDRSTAT_HDRSP       0x00008000
962#define IXGBE_RXDPS_HDRSTAT_HDRLEN_MASK 0x000003FF
963
964#define IXGBE_RXDADV_RSSTYPE_MASK       0x0000000F
965#define IXGBE_RXDADV_PKTTYPE_MASK       0x0000FFF0
966#define IXGBE_RXDADV_HDRBUFLEN_MASK     0x00007FE0
967#define IXGBE_RXDADV_HDRBUFLEN_SHIFT    5
968#define IXGBE_RXDADV_SPLITHEADER_EN     0x00001000
969#define IXGBE_RXDADV_SPH                0x8000
970
971/* RSS Hash results */
972#define IXGBE_RXDADV_RSSTYPE_NONE       0x00000000
973#define IXGBE_RXDADV_RSSTYPE_IPV4_TCP   0x00000001
974#define IXGBE_RXDADV_RSSTYPE_IPV4       0x00000002
975#define IXGBE_RXDADV_RSSTYPE_IPV6_TCP   0x00000003
976#define IXGBE_RXDADV_RSSTYPE_IPV6_EX    0x00000004
977#define IXGBE_RXDADV_RSSTYPE_IPV6       0x00000005
978#define IXGBE_RXDADV_RSSTYPE_IPV6_TCP_EX 0x00000006
979#define IXGBE_RXDADV_RSSTYPE_IPV4_UDP   0x00000007
980#define IXGBE_RXDADV_RSSTYPE_IPV6_UDP   0x00000008
981#define IXGBE_RXDADV_RSSTYPE_IPV6_UDP_EX 0x00000009
982
983/* RSS Packet Types as indicated in the receive descriptor. */
984#define IXGBE_RXDADV_PKTTYPE_NONE       0x00000000
985#define IXGBE_RXDADV_PKTTYPE_IPV4       0x00000010 /* IPv4 hdr present */
986#define IXGBE_RXDADV_PKTTYPE_IPV4_EX    0x00000020 /* IPv4 hdr + extensions */
987#define IXGBE_RXDADV_PKTTYPE_IPV6       0x00000040 /* IPv6 hdr present */
988#define IXGBE_RXDADV_PKTTYPE_IPV6_EX    0x00000080 /* IPv6 hdr + extensions */
989#define IXGBE_RXDADV_PKTTYPE_TCP        0x00000100 /* TCP hdr present */
990#define IXGBE_RXDADV_PKTTYPE_UDP        0x00000200 /* UDP hdr present */
991#define IXGBE_RXDADV_PKTTYPE_SCTP       0x00000400 /* SCTP hdr present */
992#define IXGBE_RXDADV_PKTTYPE_NFS        0x00000800 /* NFS hdr present */
993
994/* Masks to determine if packets should be dropped due to frame errors */
995#define IXGBE_RXD_ERR_FRAME_ERR_MASK ( \
996				      IXGBE_RXD_ERR_CE | \
997				      IXGBE_RXD_ERR_LE | \
998				      IXGBE_RXD_ERR_PE | \
999				      IXGBE_RXD_ERR_OSE | \
1000				      IXGBE_RXD_ERR_USE)
1001
1002#define IXGBE_RXDADV_ERR_FRAME_ERR_MASK ( \
1003				      IXGBE_RXDADV_ERR_CE | \
1004				      IXGBE_RXDADV_ERR_LE | \
1005				      IXGBE_RXDADV_ERR_PE | \
1006				      IXGBE_RXDADV_ERR_OSE | \
1007				      IXGBE_RXDADV_ERR_USE)
1008
1009/* Multicast bit mask */
1010#define IXGBE_MCSTCTRL_MFE      0x4
1011
1012/* Number of Transmit and Receive Descriptors must be a multiple of 8 */
1013#define IXGBE_REQ_TX_DESCRIPTOR_MULTIPLE  8
1014#define IXGBE_REQ_RX_DESCRIPTOR_MULTIPLE  8
1015#define IXGBE_REQ_TX_BUFFER_GRANULARITY   1024
1016
1017/* Vlan-specific macros */
1018#define IXGBE_RX_DESC_SPECIAL_VLAN_MASK  0x0FFF /* VLAN ID in lower 12 bits */
1019#define IXGBE_RX_DESC_SPECIAL_PRI_MASK   0xE000 /* Priority in upper 3 bits */
1020#define IXGBE_RX_DESC_SPECIAL_PRI_SHIFT  0x000D /* Priority in upper 3 of 16 */
1021#define IXGBE_TX_DESC_SPECIAL_PRI_SHIFT  IXGBE_RX_DESC_SPECIAL_PRI_SHIFT
1022
1023/* Transmit Descriptor - Legacy */
1024struct ixgbe_legacy_tx_desc {
1025	u64 buffer_addr;       /* Address of the descriptor's data buffer */
1026	union {
1027		u32 data;
1028		struct {
1029			u16 length;    /* Data buffer length */
1030			u8 cso; /* Checksum offset */
1031			u8 cmd; /* Descriptor control */
1032		} flags;
1033	} lower;
1034	union {
1035		u32 data;
1036		struct {
1037			u8 status;     /* Descriptor status */
1038			u8 css; /* Checksum start */
1039			u16 vlan;
1040		} fields;
1041	} upper;
1042};
1043
1044/* Transmit Descriptor - Advanced */
1045union ixgbe_adv_tx_desc {
1046	struct {
1047		u64 buffer_addr;       /* Address of descriptor's data buf */
1048		u32 cmd_type_len;
1049		u32 olinfo_status;
1050	} read;
1051	struct {
1052		u64 rsvd;       /* Reserved */
1053		u32 nxtseq_seed;
1054		u32 status;
1055	} wb;
1056};
1057
1058/* Receive Descriptor - Legacy */
1059struct ixgbe_legacy_rx_desc {
1060	u64 buffer_addr; /* Address of the descriptor's data buffer */
1061	u16 length;      /* Length of data DMAed into data buffer */
1062	u16 csum;        /* Packet checksum */
1063	u8 status;       /* Descriptor status */
1064	u8 errors;       /* Descriptor Errors */
1065	u16 vlan;
1066};
1067
1068/* Receive Descriptor - Advanced */
1069union ixgbe_adv_rx_desc {
1070	struct {
1071		u64 pkt_addr; /* Packet buffer address */
1072		u64 hdr_addr; /* Header buffer address */
1073	} read;
1074	struct {
1075		struct {
1076			struct {
1077				u16 pkt_info; /* RSS type, Packet type */
1078				u16 hdr_info; /* Split Header, header len */
1079			} lo_dword;
1080			union {
1081				u32 rss; /* RSS Hash */
1082				struct {
1083					u16 ip_id; /* IP id */
1084					u16 csum; /* Packet Checksum */
1085				} csum_ip;
1086			} hi_dword;
1087		} lower;
1088		struct {
1089			u32 status_error; /* ext status/error */
1090			u16 length; /* Packet length */
1091			u16 vlan; /* VLAN tag */
1092		} upper;
1093	} wb;  /* writeback */
1094};
1095
1096/* Context descriptors */
1097struct ixgbe_adv_tx_context_desc {
1098	u32 vlan_macip_lens;
1099	u32 seqnum_seed;
1100	u32 type_tucmd_mlhl;
1101	u32 mss_l4len_idx;
1102};
1103
1104/* Adv Transmit Descriptor Config Masks */
1105#define IXGBE_ADVTXD_DTALEN_MASK      0x0000FFFF /* Data buffer length(bytes) */
1106#define IXGBE_ADVTXD_DTYP_MASK  0x00F00000 /* DTYP mask */
1107#define IXGBE_ADVTXD_DTYP_CTXT  0x00200000 /* Advanced Context Desc */
1108#define IXGBE_ADVTXD_DTYP_DATA  0x00300000 /* Advanced Data Descriptor */
1109#define IXGBE_ADVTXD_DCMD_EOP   IXGBE_TXD_CMD_EOP  /* End of Packet */
1110#define IXGBE_ADVTXD_DCMD_IFCS  IXGBE_TXD_CMD_IFCS /* Insert FCS */
1111#define IXGBE_ADVTXD_DCMD_RDMA  0x04000000 /* RDMA */
1112#define IXGBE_ADVTXD_DCMD_RS    IXGBE_TXD_CMD_RS   /* Report Status */
1113#define IXGBE_ADVTXD_DCMD_DDTYP_ISCSI 0x10000000     /* DDP hdr type or iSCSI */
1114#define IXGBE_ADVTXD_DCMD_DEXT  IXGBE_TXD_CMD_DEXT /* Desc ext (1=Adv) */
1115#define IXGBE_ADVTXD_DCMD_VLE   IXGBE_TXD_CMD_VLE  /* VLAN pkt enable */
1116#define IXGBE_ADVTXD_DCMD_TSE   0x80000000 /* TCP Seg enable */
1117#define IXGBE_ADVTXD_STAT_DD    IXGBE_TXD_STAT_DD  /* Descriptor Done */
1118#define IXGBE_ADVTXD_STAT_SN_CRC      0x00000002 /* NXTSEQ/SEED present in WB */
1119#define IXGBE_ADVTXD_STAT_RSV   0x0000000C /* STA Reserved */
1120#define IXGBE_ADVTXD_IDX_SHIFT  4 /* Adv desc Index shift */
1121#define IXGBE_ADVTXD_POPTS_SHIFT      8  /* Adv desc POPTS shift */
1122#define IXGBE_ADVTXD_POPTS_IXSM (IXGBE_TXD_POPTS_IXSM << \
1123				IXGBE_ADVTXD_POPTS_SHIFT)
1124#define IXGBE_ADVTXD_POPTS_TXSM (IXGBE_TXD_POPTS_TXSM << \
1125				IXGBE_ADVTXD_POPTS_SHIFT)
1126#define IXGBE_ADVTXD_POPTS_EOM  0x00000400 /* Enable L bit-RDMA DDP hdr */
1127#define IXGBE_ADVTXD_POPTS_ISCO_1ST   0x00000000 /* 1st TSO of iSCSI PDU */
1128#define IXGBE_ADVTXD_POPTS_ISCO_MDL   0x00000800 /* Middle TSO of iSCSI PDU */
1129#define IXGBE_ADVTXD_POPTS_ISCO_LAST  0x00001000 /* Last TSO of iSCSI PDU */
1130#define IXGBE_ADVTXD_POPTS_ISCO_FULL 0x00001800 /* 1st&Last TSO-full iSCSI PDU*/
1131#define IXGBE_ADVTXD_POPTS_RSV  0x00002000 /* POPTS Reserved */
1132#define IXGBE_ADVTXD_PAYLEN_SHIFT  14 /* Adv desc PAYLEN shift */
1133#define IXGBE_ADVTXD_MACLEN_SHIFT  9  /* Adv ctxt desc mac len shift */
1134#define IXGBE_ADVTXD_VLAN_SHIFT    16  /* Adv ctxt vlan tag shift */
1135#define IXGBE_ADVTXD_TUCMD_IPV4    0x00000400  /* IP Packet Type: 1=IPv4 */
1136#define IXGBE_ADVTXD_TUCMD_IPV6    0x00000000  /* IP Packet Type: 0=IPv6 */
1137#define IXGBE_ADVTXD_TUCMD_L4T_UDP 0x00000000  /* L4 Packet TYPE of UDP */
1138#define IXGBE_ADVTXD_TUCMD_L4T_TCP 0x00000800  /* L4 Packet TYPE of TCP */
1139#define IXGBE_ADVTXD_TUCMD_MKRREQ  0x00002000 /* Req requires Markers and CRC */
1140#define IXGBE_ADVTXD_L4LEN_SHIFT   8  /* Adv ctxt L4LEN shift */
1141#define IXGBE_ADVTXD_MSS_SHIFT     16  /* Adv ctxt MSS shift */
1142
1143/* Autonegotiation advertised speeds */
1144typedef u32 ixgbe_autoneg_advertised;
1145/* Link speed */
1146typedef u32 ixgbe_link_speed;
1147#define IXGBE_LINK_SPEED_UNKNOWN   0
1148#define IXGBE_LINK_SPEED_100_FULL  0x0008
1149#define IXGBE_LINK_SPEED_1GB_FULL  0x0020
1150#define IXGBE_LINK_SPEED_10GB_FULL 0x0080
1151
1152
1153enum ixgbe_eeprom_type {
1154	ixgbe_eeprom_uninitialized = 0,
1155	ixgbe_eeprom_spi,
1156	ixgbe_eeprom_none /* No NVM support */
1157};
1158
1159enum ixgbe_mac_type {
1160	ixgbe_mac_unknown = 0,
1161	ixgbe_mac_82598EB,
1162	ixgbe_num_macs
1163};
1164
1165enum ixgbe_phy_type {
1166	ixgbe_phy_unknown = 0,
1167	ixgbe_phy_qt,
1168	ixgbe_phy_xaui
1169};
1170
1171enum ixgbe_media_type {
1172	ixgbe_media_type_unknown = 0,
1173	ixgbe_media_type_fiber,
1174	ixgbe_media_type_copper,
1175	ixgbe_media_type_backplane
1176};
1177
1178/* Flow Control Settings */
1179enum ixgbe_fc_type {
1180	ixgbe_fc_none = 0,
1181	ixgbe_fc_rx_pause,
1182	ixgbe_fc_tx_pause,
1183	ixgbe_fc_full,
1184	ixgbe_fc_default
1185};
1186
1187/* PCI bus types */
1188enum ixgbe_bus_type {
1189	ixgbe_bus_type_unknown = 0,
1190	ixgbe_bus_type_pci,
1191	ixgbe_bus_type_pcix,
1192	ixgbe_bus_type_pci_express,
1193	ixgbe_bus_type_reserved
1194};
1195
1196/* PCI bus speeds */
1197enum ixgbe_bus_speed {
1198	ixgbe_bus_speed_unknown = 0,
1199	ixgbe_bus_speed_33,
1200	ixgbe_bus_speed_66,
1201	ixgbe_bus_speed_100,
1202	ixgbe_bus_speed_120,
1203	ixgbe_bus_speed_133,
1204	ixgbe_bus_speed_2500,
1205	ixgbe_bus_speed_5000,
1206	ixgbe_bus_speed_reserved
1207};
1208
1209/* PCI bus widths */
1210enum ixgbe_bus_width {
1211	ixgbe_bus_width_unknown = 0,
1212	ixgbe_bus_width_pcie_x1,
1213	ixgbe_bus_width_pcie_x2,
1214	ixgbe_bus_width_pcie_x4,
1215	ixgbe_bus_width_pcie_x8,
1216	ixgbe_bus_width_32,
1217	ixgbe_bus_width_64,
1218	ixgbe_bus_width_reserved
1219};
1220
1221struct ixgbe_eeprom_info {
1222	enum ixgbe_eeprom_type type;
1223	u16 word_size;
1224	u16 address_bits;
1225};
1226
1227struct ixgbe_addr_filter_info {
1228	u32 num_mc_addrs;
1229	u32 rar_used_count;
1230	u32 mc_addr_in_rar_count;
1231	u32 mta_in_use;
1232};
1233
1234/* Bus parameters */
1235struct ixgbe_bus_info {
1236	enum ixgbe_bus_speed speed;
1237	enum ixgbe_bus_width width;
1238	enum ixgbe_bus_type type;
1239};
1240
1241/* Flow control parameters */
1242struct ixgbe_fc_info {
1243	u32 high_water; /* Flow Control High-water */
1244	u32 low_water; /* Flow Control Low-water */
1245	u16 pause_time; /* Flow Control Pause timer */
1246	bool send_xon; /* Flow control send XON */
1247	bool strict_ieee; /* Strict IEEE mode */
1248	enum ixgbe_fc_type type; /* Type of flow control */
1249	enum ixgbe_fc_type original_type;
1250};
1251
1252/* Statistics counters collected by the MAC */
1253struct ixgbe_hw_stats {
1254	u64 crcerrs;
1255	u64 illerrc;
1256	u64 errbc;
1257	u64 mspdc;
1258	u64 mpctotal;
1259	u64 mpc[8];
1260	u64 mlfc;
1261	u64 mrfc;
1262	u64 rlec;
1263	u64 lxontxc;
1264	u64 lxonrxc;
1265	u64 lxofftxc;
1266	u64 lxoffrxc;
1267	u64 pxontxc[8];
1268	u64 pxonrxc[8];
1269	u64 pxofftxc[8];
1270	u64 pxoffrxc[8];
1271	u64 prc64;
1272	u64 prc127;
1273	u64 prc255;
1274	u64 prc511;
1275	u64 prc1023;
1276	u64 prc1522;
1277	u64 gprc;
1278	u64 bprc;
1279	u64 mprc;
1280	u64 gptc;
1281	u64 gorc;
1282	u64 gotc;
1283	u64 rnbc[8];
1284	u64 ruc;
1285	u64 rfc;
1286	u64 roc;
1287	u64 rjc;
1288	u64 mngprc;
1289	u64 mngpdc;
1290	u64 mngptc;
1291	u64 tor;
1292	u64 tpr;
1293	u64 tpt;
1294	u64 ptc64;
1295	u64 ptc127;
1296	u64 ptc255;
1297	u64 ptc511;
1298	u64 ptc1023;
1299	u64 ptc1522;
1300	u64 mptc;
1301	u64 bptc;
1302	u64 xec;
1303	u64 rqsmr[16];
1304	u64 tqsmr[8];
1305	u64 qprc[16];
1306	u64 qptc[16];
1307	u64 qbrc[16];
1308	u64 qbtc[16];
1309};
1310
1311
1312/* forward declaration */
1313struct ixgbe_hw;
1314
1315/* Function pointer table */
1316struct ixgbe_functions
1317{
1318	s32 (*ixgbe_func_init_hw)(struct ixgbe_hw *);
1319	s32 (*ixgbe_func_reset_hw)(struct ixgbe_hw *);
1320	s32 (*ixgbe_func_start_hw)(struct ixgbe_hw *);
1321	s32 (*ixgbe_func_clear_hw_cntrs)(struct ixgbe_hw *);
1322	enum ixgbe_media_type (*ixgbe_func_get_media_type)(struct ixgbe_hw *);
1323	s32 (*ixgbe_func_get_mac_addr)(struct ixgbe_hw *, u8 *);
1324	u32 (*ixgbe_func_get_num_of_tx_queues)(struct ixgbe_hw *);
1325	u32 (*ixgbe_func_get_num_of_rx_queues)(struct ixgbe_hw *);
1326	s32 (*ixgbe_func_stop_adapter)(struct ixgbe_hw *);
1327	s32 (*ixgbe_func_get_bus_info)(struct ixgbe_hw *);
1328	s32 (*ixgbe_func_read_analog_reg8)(struct ixgbe_hw*, u32, u8*);
1329	s32 (*ixgbe_func_write_analog_reg8)(struct ixgbe_hw*, u32, u8);
1330	/* PHY */
1331	s32 (*ixgbe_func_identify_phy)(struct ixgbe_hw *);
1332	s32 (*ixgbe_func_reset_phy)(struct ixgbe_hw *);
1333	s32 (*ixgbe_func_read_phy_reg)(struct ixgbe_hw *, u32, u32, u16 *);
1334	s32 (*ixgbe_func_write_phy_reg)(struct ixgbe_hw *, u32, u32, u16);
1335	s32 (*ixgbe_func_setup_phy_link)(struct ixgbe_hw *);
1336	s32 (*ixgbe_func_setup_phy_link_speed)(struct ixgbe_hw *,
1337					       ixgbe_link_speed,
1338					       bool, bool);
1339	s32 (*ixgbe_func_check_phy_link)(struct ixgbe_hw *, ixgbe_link_speed *,
1340					 bool *);
1341
1342	/* Link */
1343	s32 (*ixgbe_func_setup_link)(struct ixgbe_hw *);
1344	s32 (*ixgbe_func_setup_link_speed)(struct ixgbe_hw *, ixgbe_link_speed,
1345					   bool, bool);
1346	s32 (*ixgbe_func_check_link)(struct ixgbe_hw *, ixgbe_link_speed *,
1347				     bool *);
1348	s32 (*ixgbe_func_get_link_settings)(struct ixgbe_hw *,
1349					    ixgbe_link_speed *,
1350					    bool *);
1351
1352	/* LED */
1353	s32 (*ixgbe_func_led_on)(struct ixgbe_hw *, u32);
1354	s32 (*ixgbe_func_led_off)(struct ixgbe_hw *, u32);
1355	s32 (*ixgbe_func_blink_led_start)(struct ixgbe_hw *, u32);
1356	s32 (*ixgbe_func_blink_led_stop)(struct ixgbe_hw *, u32);
1357
1358	/* EEPROM */
1359	s32 (*ixgbe_func_init_eeprom_params)(struct ixgbe_hw *);
1360	s32 (*ixgbe_func_read_eeprom)(struct ixgbe_hw *, u16, u16 *);
1361	s32 (*ixgbe_func_write_eeprom)(struct ixgbe_hw *, u16, u16);
1362	s32 (*ixgbe_func_validate_eeprom_checksum)(struct ixgbe_hw *, u16 *);
1363	s32 (*ixgbe_func_update_eeprom_checksum)(struct ixgbe_hw *);
1364
1365	/* RAR, Multicast, VLAN */
1366	s32 (*ixgbe_func_set_rar)(struct ixgbe_hw *, u32, u8 *, u32 , u32);
1367	s32 (*ixgbe_func_init_rx_addrs)(struct ixgbe_hw *);
1368	u32 (*ixgbe_func_get_num_rx_addrs)(struct ixgbe_hw *);
1369	s32 (*ixgbe_func_update_mc_addr_list)(struct ixgbe_hw *, u8 *, u32,
1370					      u32);
1371	s32 (*ixgbe_func_enable_mc)(struct ixgbe_hw *);
1372	s32 (*ixgbe_func_disable_mc)(struct ixgbe_hw *);
1373	s32 (*ixgbe_func_clear_vfta)(struct ixgbe_hw *);
1374	s32 (*ixgbe_func_set_vfta)(struct ixgbe_hw *, u32, u32, bool);
1375
1376	/* Flow Control */
1377	s32 (*ixgbe_func_setup_fc)(struct ixgbe_hw *, s32);
1378};
1379
1380struct ixgbe_mac_info {
1381	enum ixgbe_mac_type type;
1382	u8                  addr[IXGBE_ETH_LENGTH_OF_ADDRESS];
1383	u8                  perm_addr[IXGBE_ETH_LENGTH_OF_ADDRESS];
1384	s32                 mc_filter_type;
1385	u32                 link_attach_type;
1386	u32                 link_mode_select;
1387	bool                link_settings_loaded;
1388	bool                autoneg;
1389	bool                autoneg_failed;
1390};
1391
1392struct ixgbe_phy_info {
1393	enum ixgbe_phy_type             type;
1394	u32                             addr;
1395	u32                             id;
1396	u32                             revision;
1397	enum ixgbe_media_type           media_type;
1398	ixgbe_autoneg_advertised        autoneg_advertised;
1399	bool                            autoneg_wait_to_complete;
1400};
1401
1402struct ixgbe_hw {
1403	u8                              *hw_addr;
1404	void                            *back;
1405	struct ixgbe_functions          func;
1406	struct ixgbe_mac_info           mac;
1407	struct ixgbe_addr_filter_info   addr_ctrl;
1408	struct ixgbe_fc_info            fc;
1409	struct ixgbe_phy_info           phy;
1410	struct ixgbe_eeprom_info        eeprom;
1411	struct ixgbe_bus_info           bus;
1412	u16                             device_id;
1413	u16                             vendor_id;
1414	u16                             subsystem_device_id;
1415	u16                             subsystem_vendor_id;
1416	u8                              revision_id;
1417	bool                            adapter_stopped;
1418};
1419
1420
1421#define ixgbe_func_from_hw_struct(hw, _func) hw->func._func
1422
1423#define ixgbe_call_func(hw, func, params, error) \
1424		(ixgbe_func_from_hw_struct(hw, func) != NULL) ? \
1425		ixgbe_func_from_hw_struct(hw, func) params: error
1426
1427/* Error Codes */
1428#define IXGBE_SUCCESS                           0
1429#define IXGBE_ERR_EEPROM                        -1
1430#define IXGBE_ERR_EEPROM_CHECKSUM               -2
1431#define IXGBE_ERR_PHY                           -3
1432#define IXGBE_ERR_CONFIG                        -4
1433#define IXGBE_ERR_PARAM                         -5
1434#define IXGBE_ERR_MAC_TYPE                      -6
1435#define IXGBE_ERR_UNKNOWN_PHY                   -7
1436#define IXGBE_ERR_LINK_SETUP                    -8
1437#define IXGBE_ERR_ADAPTER_STOPPED               -9
1438#define IXGBE_ERR_INVALID_MAC_ADDR              -10
1439#define IXGBE_ERR_DEVICE_NOT_SUPPORTED          -11
1440#define IXGBE_ERR_MASTER_REQUESTS_PENDING       -12
1441#define IXGBE_ERR_INVALID_LINK_SETTINGS         -13
1442#define IXGBE_ERR_AUTONEG_NOT_COMPLETE          -14
1443#define IXGBE_ERR_RESET_FAILED                  -15
1444#define IXGBE_ERR_SWFW_SYNC                     -16
1445#define IXGBE_ERR_PHY_ADDR_INVALID              -17
1446#define IXGBE_NOT_IMPLEMENTED                   0x7FFFFFFF
1447
1448#ifndef UNREFERENCED_PARAMETER
1449#define UNREFERENCED_PARAMETER(_p)
1450#endif
1451
1452#endif /* _IXGBE_TYPE_H_ */
1453