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