xref: /freebsd/sys/dev/e1000/e1000_hw.h (revision 6ae1554a5d9b318f8ad53ccc39fa5a961403da73)
1 /******************************************************************************
2 
3   Copyright (c) 2001-2015, 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$*/
34 
35 #ifndef _E1000_HW_H_
36 #define _E1000_HW_H_
37 
38 #include "e1000_osdep.h"
39 #include "e1000_regs.h"
40 #include "e1000_defines.h"
41 
42 struct e1000_hw;
43 
44 #define E1000_DEV_ID_82542			0x1000
45 #define E1000_DEV_ID_82543GC_FIBER		0x1001
46 #define E1000_DEV_ID_82543GC_COPPER		0x1004
47 #define E1000_DEV_ID_82544EI_COPPER		0x1008
48 #define E1000_DEV_ID_82544EI_FIBER		0x1009
49 #define E1000_DEV_ID_82544GC_COPPER		0x100C
50 #define E1000_DEV_ID_82544GC_LOM		0x100D
51 #define E1000_DEV_ID_82540EM			0x100E
52 #define E1000_DEV_ID_82540EM_LOM		0x1015
53 #define E1000_DEV_ID_82540EP_LOM		0x1016
54 #define E1000_DEV_ID_82540EP			0x1017
55 #define E1000_DEV_ID_82540EP_LP			0x101E
56 #define E1000_DEV_ID_82545EM_COPPER		0x100F
57 #define E1000_DEV_ID_82545EM_FIBER		0x1011
58 #define E1000_DEV_ID_82545GM_COPPER		0x1026
59 #define E1000_DEV_ID_82545GM_FIBER		0x1027
60 #define E1000_DEV_ID_82545GM_SERDES		0x1028
61 #define E1000_DEV_ID_82546EB_COPPER		0x1010
62 #define E1000_DEV_ID_82546EB_FIBER		0x1012
63 #define E1000_DEV_ID_82546EB_QUAD_COPPER	0x101D
64 #define E1000_DEV_ID_82546GB_COPPER		0x1079
65 #define E1000_DEV_ID_82546GB_FIBER		0x107A
66 #define E1000_DEV_ID_82546GB_SERDES		0x107B
67 #define E1000_DEV_ID_82546GB_PCIE		0x108A
68 #define E1000_DEV_ID_82546GB_QUAD_COPPER	0x1099
69 #define E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3	0x10B5
70 #define E1000_DEV_ID_82541EI			0x1013
71 #define E1000_DEV_ID_82541EI_MOBILE		0x1018
72 #define E1000_DEV_ID_82541ER_LOM		0x1014
73 #define E1000_DEV_ID_82541ER			0x1078
74 #define E1000_DEV_ID_82541GI			0x1076
75 #define E1000_DEV_ID_82541GI_LF			0x107C
76 #define E1000_DEV_ID_82541GI_MOBILE		0x1077
77 #define E1000_DEV_ID_82547EI			0x1019
78 #define E1000_DEV_ID_82547EI_MOBILE		0x101A
79 #define E1000_DEV_ID_82547GI			0x1075
80 #define E1000_DEV_ID_82571EB_COPPER		0x105E
81 #define E1000_DEV_ID_82571EB_FIBER		0x105F
82 #define E1000_DEV_ID_82571EB_SERDES		0x1060
83 #define E1000_DEV_ID_82571EB_SERDES_DUAL	0x10D9
84 #define E1000_DEV_ID_82571EB_SERDES_QUAD	0x10DA
85 #define E1000_DEV_ID_82571EB_QUAD_COPPER	0x10A4
86 #define E1000_DEV_ID_82571PT_QUAD_COPPER	0x10D5
87 #define E1000_DEV_ID_82571EB_QUAD_FIBER		0x10A5
88 #define E1000_DEV_ID_82571EB_QUAD_COPPER_LP	0x10BC
89 #define E1000_DEV_ID_82572EI_COPPER		0x107D
90 #define E1000_DEV_ID_82572EI_FIBER		0x107E
91 #define E1000_DEV_ID_82572EI_SERDES		0x107F
92 #define E1000_DEV_ID_82572EI			0x10B9
93 #define E1000_DEV_ID_82573E			0x108B
94 #define E1000_DEV_ID_82573E_IAMT		0x108C
95 #define E1000_DEV_ID_82573L			0x109A
96 #define E1000_DEV_ID_82574L			0x10D3
97 #define E1000_DEV_ID_82574LA			0x10F6
98 #define E1000_DEV_ID_82583V			0x150C
99 #define E1000_DEV_ID_80003ES2LAN_COPPER_DPT	0x1096
100 #define E1000_DEV_ID_80003ES2LAN_SERDES_DPT	0x1098
101 #define E1000_DEV_ID_80003ES2LAN_COPPER_SPT	0x10BA
102 #define E1000_DEV_ID_80003ES2LAN_SERDES_SPT	0x10BB
103 #define E1000_DEV_ID_ICH8_82567V_3		0x1501
104 #define E1000_DEV_ID_ICH8_IGP_M_AMT		0x1049
105 #define E1000_DEV_ID_ICH8_IGP_AMT		0x104A
106 #define E1000_DEV_ID_ICH8_IGP_C			0x104B
107 #define E1000_DEV_ID_ICH8_IFE			0x104C
108 #define E1000_DEV_ID_ICH8_IFE_GT		0x10C4
109 #define E1000_DEV_ID_ICH8_IFE_G			0x10C5
110 #define E1000_DEV_ID_ICH8_IGP_M			0x104D
111 #define E1000_DEV_ID_ICH9_IGP_M			0x10BF
112 #define E1000_DEV_ID_ICH9_IGP_M_AMT		0x10F5
113 #define E1000_DEV_ID_ICH9_IGP_M_V		0x10CB
114 #define E1000_DEV_ID_ICH9_IGP_AMT		0x10BD
115 #define E1000_DEV_ID_ICH9_BM			0x10E5
116 #define E1000_DEV_ID_ICH9_IGP_C			0x294C
117 #define E1000_DEV_ID_ICH9_IFE			0x10C0
118 #define E1000_DEV_ID_ICH9_IFE_GT		0x10C3
119 #define E1000_DEV_ID_ICH9_IFE_G			0x10C2
120 #define E1000_DEV_ID_ICH10_R_BM_LM		0x10CC
121 #define E1000_DEV_ID_ICH10_R_BM_LF		0x10CD
122 #define E1000_DEV_ID_ICH10_R_BM_V		0x10CE
123 #define E1000_DEV_ID_ICH10_D_BM_LM		0x10DE
124 #define E1000_DEV_ID_ICH10_D_BM_LF		0x10DF
125 #define E1000_DEV_ID_ICH10_D_BM_V		0x1525
126 #define E1000_DEV_ID_PCH_M_HV_LM		0x10EA
127 #define E1000_DEV_ID_PCH_M_HV_LC		0x10EB
128 #define E1000_DEV_ID_PCH_D_HV_DM		0x10EF
129 #define E1000_DEV_ID_PCH_D_HV_DC		0x10F0
130 #define E1000_DEV_ID_PCH2_LV_LM			0x1502
131 #define E1000_DEV_ID_PCH2_LV_V			0x1503
132 #define E1000_DEV_ID_PCH_LPT_I217_LM		0x153A
133 #define E1000_DEV_ID_PCH_LPT_I217_V		0x153B
134 #define E1000_DEV_ID_PCH_LPTLP_I218_LM		0x155A
135 #define E1000_DEV_ID_PCH_LPTLP_I218_V		0x1559
136 #define E1000_DEV_ID_PCH_I218_LM2		0x15A0
137 #define E1000_DEV_ID_PCH_I218_V2		0x15A1
138 #define E1000_DEV_ID_PCH_I218_LM3		0x15A2 /* Wildcat Point PCH */
139 #define E1000_DEV_ID_PCH_I218_V3		0x15A3 /* Wildcat Point PCH */
140 #define E1000_DEV_ID_82576			0x10C9
141 #define E1000_DEV_ID_82576_FIBER		0x10E6
142 #define E1000_DEV_ID_82576_SERDES		0x10E7
143 #define E1000_DEV_ID_82576_QUAD_COPPER		0x10E8
144 #define E1000_DEV_ID_82576_QUAD_COPPER_ET2	0x1526
145 #define E1000_DEV_ID_82576_NS			0x150A
146 #define E1000_DEV_ID_82576_NS_SERDES		0x1518
147 #define E1000_DEV_ID_82576_SERDES_QUAD		0x150D
148 #define E1000_DEV_ID_82576_VF			0x10CA
149 #define E1000_DEV_ID_82576_VF_HV		0x152D
150 #define E1000_DEV_ID_I350_VF			0x1520
151 #define E1000_DEV_ID_I350_VF_HV			0x152F
152 #define E1000_DEV_ID_82575EB_COPPER		0x10A7
153 #define E1000_DEV_ID_82575EB_FIBER_SERDES	0x10A9
154 #define E1000_DEV_ID_82575GB_QUAD_COPPER	0x10D6
155 #define E1000_DEV_ID_82580_COPPER		0x150E
156 #define E1000_DEV_ID_82580_FIBER		0x150F
157 #define E1000_DEV_ID_82580_SERDES		0x1510
158 #define E1000_DEV_ID_82580_SGMII		0x1511
159 #define E1000_DEV_ID_82580_COPPER_DUAL		0x1516
160 #define E1000_DEV_ID_82580_QUAD_FIBER		0x1527
161 #define E1000_DEV_ID_I350_COPPER		0x1521
162 #define E1000_DEV_ID_I350_FIBER			0x1522
163 #define E1000_DEV_ID_I350_SERDES		0x1523
164 #define E1000_DEV_ID_I350_SGMII			0x1524
165 #define E1000_DEV_ID_I350_DA4			0x1546
166 #define E1000_DEV_ID_I210_COPPER		0x1533
167 #define E1000_DEV_ID_I210_COPPER_OEM1		0x1534
168 #define E1000_DEV_ID_I210_COPPER_IT		0x1535
169 #define E1000_DEV_ID_I210_FIBER			0x1536
170 #define E1000_DEV_ID_I210_SERDES		0x1537
171 #define E1000_DEV_ID_I210_SGMII			0x1538
172 #define E1000_DEV_ID_I210_COPPER_FLASHLESS	0x157B
173 #define E1000_DEV_ID_I210_SERDES_FLASHLESS	0x157C
174 #define E1000_DEV_ID_I211_COPPER		0x1539
175 #define E1000_DEV_ID_I354_BACKPLANE_1GBPS	0x1F40
176 #define E1000_DEV_ID_I354_SGMII			0x1F41
177 #define E1000_DEV_ID_I354_BACKPLANE_2_5GBPS	0x1F45
178 #define E1000_DEV_ID_DH89XXCC_SGMII		0x0438
179 #define E1000_DEV_ID_DH89XXCC_SERDES		0x043A
180 #define E1000_DEV_ID_DH89XXCC_BACKPLANE		0x043C
181 #define E1000_DEV_ID_DH89XXCC_SFP		0x0440
182 
183 #define E1000_REVISION_0	0
184 #define E1000_REVISION_1	1
185 #define E1000_REVISION_2	2
186 #define E1000_REVISION_3	3
187 #define E1000_REVISION_4	4
188 
189 #define E1000_FUNC_0		0
190 #define E1000_FUNC_1		1
191 #define E1000_FUNC_2		2
192 #define E1000_FUNC_3		3
193 
194 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0	0
195 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1	3
196 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN2	6
197 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN3	9
198 
199 enum e1000_mac_type {
200 	e1000_undefined = 0,
201 	e1000_82542,
202 	e1000_82543,
203 	e1000_82544,
204 	e1000_82540,
205 	e1000_82545,
206 	e1000_82545_rev_3,
207 	e1000_82546,
208 	e1000_82546_rev_3,
209 	e1000_82541,
210 	e1000_82541_rev_2,
211 	e1000_82547,
212 	e1000_82547_rev_2,
213 	e1000_82571,
214 	e1000_82572,
215 	e1000_82573,
216 	e1000_82574,
217 	e1000_82583,
218 	e1000_80003es2lan,
219 	e1000_ich8lan,
220 	e1000_ich9lan,
221 	e1000_ich10lan,
222 	e1000_pchlan,
223 	e1000_pch2lan,
224 	e1000_pch_lpt,
225 	e1000_82575,
226 	e1000_82576,
227 	e1000_82580,
228 	e1000_i350,
229 	e1000_i354,
230 	e1000_i210,
231 	e1000_i211,
232 	e1000_vfadapt,
233 	e1000_vfadapt_i350,
234 	e1000_num_macs  /* List is 1-based, so subtract 1 for TRUE count. */
235 };
236 
237 enum e1000_media_type {
238 	e1000_media_type_unknown = 0,
239 	e1000_media_type_copper = 1,
240 	e1000_media_type_fiber = 2,
241 	e1000_media_type_internal_serdes = 3,
242 	e1000_num_media_types
243 };
244 
245 enum e1000_nvm_type {
246 	e1000_nvm_unknown = 0,
247 	e1000_nvm_none,
248 	e1000_nvm_eeprom_spi,
249 	e1000_nvm_eeprom_microwire,
250 	e1000_nvm_flash_hw,
251 	e1000_nvm_invm,
252 	e1000_nvm_flash_sw
253 };
254 
255 enum e1000_nvm_override {
256 	e1000_nvm_override_none = 0,
257 	e1000_nvm_override_spi_small,
258 	e1000_nvm_override_spi_large,
259 	e1000_nvm_override_microwire_small,
260 	e1000_nvm_override_microwire_large
261 };
262 
263 enum e1000_phy_type {
264 	e1000_phy_unknown = 0,
265 	e1000_phy_none,
266 	e1000_phy_m88,
267 	e1000_phy_igp,
268 	e1000_phy_igp_2,
269 	e1000_phy_gg82563,
270 	e1000_phy_igp_3,
271 	e1000_phy_ife,
272 	e1000_phy_bm,
273 	e1000_phy_82578,
274 	e1000_phy_82577,
275 	e1000_phy_82579,
276 	e1000_phy_i217,
277 	e1000_phy_82580,
278 	e1000_phy_vf,
279 	e1000_phy_i210,
280 };
281 
282 enum e1000_bus_type {
283 	e1000_bus_type_unknown = 0,
284 	e1000_bus_type_pci,
285 	e1000_bus_type_pcix,
286 	e1000_bus_type_pci_express,
287 	e1000_bus_type_reserved
288 };
289 
290 enum e1000_bus_speed {
291 	e1000_bus_speed_unknown = 0,
292 	e1000_bus_speed_33,
293 	e1000_bus_speed_66,
294 	e1000_bus_speed_100,
295 	e1000_bus_speed_120,
296 	e1000_bus_speed_133,
297 	e1000_bus_speed_2500,
298 	e1000_bus_speed_5000,
299 	e1000_bus_speed_reserved
300 };
301 
302 enum e1000_bus_width {
303 	e1000_bus_width_unknown = 0,
304 	e1000_bus_width_pcie_x1,
305 	e1000_bus_width_pcie_x2,
306 	e1000_bus_width_pcie_x4 = 4,
307 	e1000_bus_width_pcie_x8 = 8,
308 	e1000_bus_width_32,
309 	e1000_bus_width_64,
310 	e1000_bus_width_reserved
311 };
312 
313 enum e1000_1000t_rx_status {
314 	e1000_1000t_rx_status_not_ok = 0,
315 	e1000_1000t_rx_status_ok,
316 	e1000_1000t_rx_status_undefined = 0xFF
317 };
318 
319 enum e1000_rev_polarity {
320 	e1000_rev_polarity_normal = 0,
321 	e1000_rev_polarity_reversed,
322 	e1000_rev_polarity_undefined = 0xFF
323 };
324 
325 enum e1000_fc_mode {
326 	e1000_fc_none = 0,
327 	e1000_fc_rx_pause,
328 	e1000_fc_tx_pause,
329 	e1000_fc_full,
330 	e1000_fc_default = 0xFF
331 };
332 
333 enum e1000_ffe_config {
334 	e1000_ffe_config_enabled = 0,
335 	e1000_ffe_config_active,
336 	e1000_ffe_config_blocked
337 };
338 
339 enum e1000_dsp_config {
340 	e1000_dsp_config_disabled = 0,
341 	e1000_dsp_config_enabled,
342 	e1000_dsp_config_activated,
343 	e1000_dsp_config_undefined = 0xFF
344 };
345 
346 enum e1000_ms_type {
347 	e1000_ms_hw_default = 0,
348 	e1000_ms_force_master,
349 	e1000_ms_force_slave,
350 	e1000_ms_auto
351 };
352 
353 enum e1000_smart_speed {
354 	e1000_smart_speed_default = 0,
355 	e1000_smart_speed_on,
356 	e1000_smart_speed_off
357 };
358 
359 enum e1000_serdes_link_state {
360 	e1000_serdes_link_down = 0,
361 	e1000_serdes_link_autoneg_progress,
362 	e1000_serdes_link_autoneg_complete,
363 	e1000_serdes_link_forced_up
364 };
365 
366 #define __le16 u16
367 #define __le32 u32
368 #define __le64 u64
369 /* Receive Descriptor */
370 struct e1000_rx_desc {
371 	__le64 buffer_addr; /* Address of the descriptor's data buffer */
372 	__le16 length;      /* Length of data DMAed into data buffer */
373 	__le16 csum; /* Packet checksum */
374 	u8  status;  /* Descriptor status */
375 	u8  errors;  /* Descriptor Errors */
376 	__le16 special;
377 };
378 
379 /* Receive Descriptor - Extended */
380 union e1000_rx_desc_extended {
381 	struct {
382 		__le64 buffer_addr;
383 		__le64 reserved;
384 	} read;
385 	struct {
386 		struct {
387 			__le32 mrq; /* Multiple Rx Queues */
388 			union {
389 				__le32 rss; /* RSS Hash */
390 				struct {
391 					__le16 ip_id;  /* IP id */
392 					__le16 csum;   /* Packet Checksum */
393 				} csum_ip;
394 			} hi_dword;
395 		} lower;
396 		struct {
397 			__le32 status_error;  /* ext status/error */
398 			__le16 length;
399 			__le16 vlan; /* VLAN tag */
400 		} upper;
401 	} wb;  /* writeback */
402 };
403 
404 #define MAX_PS_BUFFERS 4
405 
406 /* Number of packet split data buffers (not including the header buffer) */
407 #define PS_PAGE_BUFFERS	(MAX_PS_BUFFERS - 1)
408 
409 /* Receive Descriptor - Packet Split */
410 union e1000_rx_desc_packet_split {
411 	struct {
412 		/* one buffer for protocol header(s), three data buffers */
413 		__le64 buffer_addr[MAX_PS_BUFFERS];
414 	} read;
415 	struct {
416 		struct {
417 			__le32 mrq;  /* Multiple Rx Queues */
418 			union {
419 				__le32 rss; /* RSS Hash */
420 				struct {
421 					__le16 ip_id;    /* IP id */
422 					__le16 csum;     /* Packet Checksum */
423 				} csum_ip;
424 			} hi_dword;
425 		} lower;
426 		struct {
427 			__le32 status_error;  /* ext status/error */
428 			__le16 length0;  /* length of buffer 0 */
429 			__le16 vlan;  /* VLAN tag */
430 		} middle;
431 		struct {
432 			__le16 header_status;
433 			/* length of buffers 1-3 */
434 			__le16 length[PS_PAGE_BUFFERS];
435 		} upper;
436 		__le64 reserved;
437 	} wb; /* writeback */
438 };
439 
440 /* Transmit Descriptor */
441 struct e1000_tx_desc {
442 	__le64 buffer_addr;   /* Address of the descriptor's data buffer */
443 	union {
444 		__le32 data;
445 		struct {
446 			__le16 length;  /* Data buffer length */
447 			u8 cso;  /* Checksum offset */
448 			u8 cmd;  /* Descriptor control */
449 		} flags;
450 	} lower;
451 	union {
452 		__le32 data;
453 		struct {
454 			u8 status; /* Descriptor status */
455 			u8 css;  /* Checksum start */
456 			__le16 special;
457 		} fields;
458 	} upper;
459 };
460 
461 /* Offload Context Descriptor */
462 struct e1000_context_desc {
463 	union {
464 		__le32 ip_config;
465 		struct {
466 			u8 ipcss;  /* IP checksum start */
467 			u8 ipcso;  /* IP checksum offset */
468 			__le16 ipcse;  /* IP checksum end */
469 		} ip_fields;
470 	} lower_setup;
471 	union {
472 		__le32 tcp_config;
473 		struct {
474 			u8 tucss;  /* TCP checksum start */
475 			u8 tucso;  /* TCP checksum offset */
476 			__le16 tucse;  /* TCP checksum end */
477 		} tcp_fields;
478 	} upper_setup;
479 	__le32 cmd_and_length;
480 	union {
481 		__le32 data;
482 		struct {
483 			u8 status;  /* Descriptor status */
484 			u8 hdr_len;  /* Header length */
485 			__le16 mss;  /* Maximum segment size */
486 		} fields;
487 	} tcp_seg_setup;
488 };
489 
490 /* Offload data descriptor */
491 struct e1000_data_desc {
492 	__le64 buffer_addr;  /* Address of the descriptor's buffer address */
493 	union {
494 		__le32 data;
495 		struct {
496 			__le16 length;  /* Data buffer length */
497 			u8 typ_len_ext;
498 			u8 cmd;
499 		} flags;
500 	} lower;
501 	union {
502 		__le32 data;
503 		struct {
504 			u8 status;  /* Descriptor status */
505 			u8 popts;  /* Packet Options */
506 			__le16 special;
507 		} fields;
508 	} upper;
509 };
510 
511 /* Statistics counters collected by the MAC */
512 struct e1000_hw_stats {
513 	u64 crcerrs;
514 	u64 algnerrc;
515 	u64 symerrs;
516 	u64 rxerrc;
517 	u64 mpc;
518 	u64 scc;
519 	u64 ecol;
520 	u64 mcc;
521 	u64 latecol;
522 	u64 colc;
523 	u64 dc;
524 	u64 tncrs;
525 	u64 sec;
526 	u64 cexterr;
527 	u64 rlec;
528 	u64 xonrxc;
529 	u64 xontxc;
530 	u64 xoffrxc;
531 	u64 xofftxc;
532 	u64 fcruc;
533 	u64 prc64;
534 	u64 prc127;
535 	u64 prc255;
536 	u64 prc511;
537 	u64 prc1023;
538 	u64 prc1522;
539 	u64 gprc;
540 	u64 bprc;
541 	u64 mprc;
542 	u64 gptc;
543 	u64 gorc;
544 	u64 gotc;
545 	u64 rnbc;
546 	u64 ruc;
547 	u64 rfc;
548 	u64 roc;
549 	u64 rjc;
550 	u64 mgprc;
551 	u64 mgpdc;
552 	u64 mgptc;
553 	u64 tor;
554 	u64 tot;
555 	u64 tpr;
556 	u64 tpt;
557 	u64 ptc64;
558 	u64 ptc127;
559 	u64 ptc255;
560 	u64 ptc511;
561 	u64 ptc1023;
562 	u64 ptc1522;
563 	u64 mptc;
564 	u64 bptc;
565 	u64 tsctc;
566 	u64 tsctfc;
567 	u64 iac;
568 	u64 icrxptc;
569 	u64 icrxatc;
570 	u64 ictxptc;
571 	u64 ictxatc;
572 	u64 ictxqec;
573 	u64 ictxqmtc;
574 	u64 icrxdmtc;
575 	u64 icrxoc;
576 	u64 cbtmpc;
577 	u64 htdpmc;
578 	u64 cbrdpc;
579 	u64 cbrmpc;
580 	u64 rpthc;
581 	u64 hgptc;
582 	u64 htcbdpc;
583 	u64 hgorc;
584 	u64 hgotc;
585 	u64 lenerrs;
586 	u64 scvpc;
587 	u64 hrmpc;
588 	u64 doosync;
589 	u64 o2bgptc;
590 	u64 o2bspc;
591 	u64 b2ospc;
592 	u64 b2ogprc;
593 };
594 
595 struct e1000_vf_stats {
596 	u64 base_gprc;
597 	u64 base_gptc;
598 	u64 base_gorc;
599 	u64 base_gotc;
600 	u64 base_mprc;
601 	u64 base_gotlbc;
602 	u64 base_gptlbc;
603 	u64 base_gorlbc;
604 	u64 base_gprlbc;
605 
606 	u32 last_gprc;
607 	u32 last_gptc;
608 	u32 last_gorc;
609 	u32 last_gotc;
610 	u32 last_mprc;
611 	u32 last_gotlbc;
612 	u32 last_gptlbc;
613 	u32 last_gorlbc;
614 	u32 last_gprlbc;
615 
616 	u64 gprc;
617 	u64 gptc;
618 	u64 gorc;
619 	u64 gotc;
620 	u64 mprc;
621 	u64 gotlbc;
622 	u64 gptlbc;
623 	u64 gorlbc;
624 	u64 gprlbc;
625 };
626 
627 struct e1000_phy_stats {
628 	u32 idle_errors;
629 	u32 receive_errors;
630 };
631 
632 struct e1000_host_mng_dhcp_cookie {
633 	u32 signature;
634 	u8  status;
635 	u8  reserved0;
636 	u16 vlan_id;
637 	u32 reserved1;
638 	u16 reserved2;
639 	u8  reserved3;
640 	u8  checksum;
641 };
642 
643 /* Host Interface "Rev 1" */
644 struct e1000_host_command_header {
645 	u8 command_id;
646 	u8 command_length;
647 	u8 command_options;
648 	u8 checksum;
649 };
650 
651 #define E1000_HI_MAX_DATA_LENGTH	252
652 struct e1000_host_command_info {
653 	struct e1000_host_command_header command_header;
654 	u8 command_data[E1000_HI_MAX_DATA_LENGTH];
655 };
656 
657 /* Host Interface "Rev 2" */
658 struct e1000_host_mng_command_header {
659 	u8  command_id;
660 	u8  checksum;
661 	u16 reserved1;
662 	u16 reserved2;
663 	u16 command_length;
664 };
665 
666 #define E1000_HI_MAX_MNG_DATA_LENGTH	0x6F8
667 struct e1000_host_mng_command_info {
668 	struct e1000_host_mng_command_header command_header;
669 	u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
670 };
671 
672 #include "e1000_mac.h"
673 #include "e1000_phy.h"
674 #include "e1000_nvm.h"
675 #include "e1000_manage.h"
676 #include "e1000_mbx.h"
677 
678 /* Function pointers for the MAC. */
679 struct e1000_mac_operations {
680 	s32  (*init_params)(struct e1000_hw *);
681 	s32  (*id_led_init)(struct e1000_hw *);
682 	s32  (*blink_led)(struct e1000_hw *);
683 	bool (*check_mng_mode)(struct e1000_hw *);
684 	s32  (*check_for_link)(struct e1000_hw *);
685 	s32  (*cleanup_led)(struct e1000_hw *);
686 	void (*clear_hw_cntrs)(struct e1000_hw *);
687 	void (*clear_vfta)(struct e1000_hw *);
688 	s32  (*get_bus_info)(struct e1000_hw *);
689 	void (*set_lan_id)(struct e1000_hw *);
690 	s32  (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
691 	s32  (*led_on)(struct e1000_hw *);
692 	s32  (*led_off)(struct e1000_hw *);
693 	void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32);
694 	s32  (*reset_hw)(struct e1000_hw *);
695 	s32  (*init_hw)(struct e1000_hw *);
696 	void (*shutdown_serdes)(struct e1000_hw *);
697 	void (*power_up_serdes)(struct e1000_hw *);
698 	s32  (*setup_link)(struct e1000_hw *);
699 	s32  (*setup_physical_interface)(struct e1000_hw *);
700 	s32  (*setup_led)(struct e1000_hw *);
701 	void (*write_vfta)(struct e1000_hw *, u32, u32);
702 	void (*config_collision_dist)(struct e1000_hw *);
703 	int  (*rar_set)(struct e1000_hw *, u8*, u32);
704 	s32  (*read_mac_addr)(struct e1000_hw *);
705 	s32  (*validate_mdi_setting)(struct e1000_hw *);
706 	s32  (*set_obff_timer)(struct e1000_hw *, u32);
707 	s32  (*acquire_swfw_sync)(struct e1000_hw *, u16);
708 	void (*release_swfw_sync)(struct e1000_hw *, u16);
709 };
710 
711 /* When to use various PHY register access functions:
712  *
713  *                 Func   Caller
714  *   Function      Does   Does    When to use
715  *   ~~~~~~~~~~~~  ~~~~~  ~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
716  *   X_reg         L,P,A  n/a     for simple PHY reg accesses
717  *   X_reg_locked  P,A    L       for multiple accesses of different regs
718  *                                on different pages
719  *   X_reg_page    A      L,P     for multiple accesses of different regs
720  *                                on the same page
721  *
722  * Where X=[read|write], L=locking, P=sets page, A=register access
723  *
724  */
725 struct e1000_phy_operations {
726 	s32  (*init_params)(struct e1000_hw *);
727 	s32  (*acquire)(struct e1000_hw *);
728 	s32  (*cfg_on_link_up)(struct e1000_hw *);
729 	s32  (*check_polarity)(struct e1000_hw *);
730 	s32  (*check_reset_block)(struct e1000_hw *);
731 	s32  (*commit)(struct e1000_hw *);
732 	s32  (*force_speed_duplex)(struct e1000_hw *);
733 	s32  (*get_cfg_done)(struct e1000_hw *hw);
734 	s32  (*get_cable_length)(struct e1000_hw *);
735 	s32  (*get_info)(struct e1000_hw *);
736 	s32  (*set_page)(struct e1000_hw *, u16);
737 	s32  (*read_reg)(struct e1000_hw *, u32, u16 *);
738 	s32  (*read_reg_locked)(struct e1000_hw *, u32, u16 *);
739 	s32  (*read_reg_page)(struct e1000_hw *, u32, u16 *);
740 	void (*release)(struct e1000_hw *);
741 	s32  (*reset)(struct e1000_hw *);
742 	s32  (*set_d0_lplu_state)(struct e1000_hw *, bool);
743 	s32  (*set_d3_lplu_state)(struct e1000_hw *, bool);
744 	s32  (*write_reg)(struct e1000_hw *, u32, u16);
745 	s32  (*write_reg_locked)(struct e1000_hw *, u32, u16);
746 	s32  (*write_reg_page)(struct e1000_hw *, u32, u16);
747 	void (*power_up)(struct e1000_hw *);
748 	void (*power_down)(struct e1000_hw *);
749 	s32 (*read_i2c_byte)(struct e1000_hw *, u8, u8, u8 *);
750 	s32 (*write_i2c_byte)(struct e1000_hw *, u8, u8, u8);
751 };
752 
753 /* Function pointers for the NVM. */
754 struct e1000_nvm_operations {
755 	s32  (*init_params)(struct e1000_hw *);
756 	s32  (*acquire)(struct e1000_hw *);
757 	s32  (*read)(struct e1000_hw *, u16, u16, u16 *);
758 	void (*release)(struct e1000_hw *);
759 	void (*reload)(struct e1000_hw *);
760 	s32  (*update)(struct e1000_hw *);
761 	s32  (*valid_led_default)(struct e1000_hw *, u16 *);
762 	s32  (*validate)(struct e1000_hw *);
763 	s32  (*write)(struct e1000_hw *, u16, u16, u16 *);
764 };
765 
766 struct e1000_mac_info {
767 	struct e1000_mac_operations ops;
768 	u8 addr[ETH_ADDR_LEN];
769 	u8 perm_addr[ETH_ADDR_LEN];
770 
771 	enum e1000_mac_type type;
772 
773 	u32 collision_delta;
774 	u32 ledctl_default;
775 	u32 ledctl_mode1;
776 	u32 ledctl_mode2;
777 	u32 mc_filter_type;
778 	u32 tx_packet_delta;
779 	u32 txcw;
780 
781 	u16 current_ifs_val;
782 	u16 ifs_max_val;
783 	u16 ifs_min_val;
784 	u16 ifs_ratio;
785 	u16 ifs_step_size;
786 	u16 mta_reg_count;
787 	u16 uta_reg_count;
788 
789 	/* Maximum size of the MTA register table in all supported adapters */
790 #define MAX_MTA_REG 128
791 	u32 mta_shadow[MAX_MTA_REG];
792 	u16 rar_entry_count;
793 
794 	u8  forced_speed_duplex;
795 
796 	bool adaptive_ifs;
797 	bool has_fwsm;
798 	bool arc_subsystem_valid;
799 	bool asf_firmware_present;
800 	bool autoneg;
801 	bool autoneg_failed;
802 	bool get_link_status;
803 	bool in_ifs_mode;
804 	bool report_tx_early;
805 	enum e1000_serdes_link_state serdes_link_state;
806 	bool serdes_has_link;
807 	bool tx_pkt_filtering;
808 	u32 max_frame_size;
809 };
810 
811 struct e1000_phy_info {
812 	struct e1000_phy_operations ops;
813 	enum e1000_phy_type type;
814 
815 	enum e1000_1000t_rx_status local_rx;
816 	enum e1000_1000t_rx_status remote_rx;
817 	enum e1000_ms_type ms_type;
818 	enum e1000_ms_type original_ms_type;
819 	enum e1000_rev_polarity cable_polarity;
820 	enum e1000_smart_speed smart_speed;
821 
822 	u32 addr;
823 	u32 id;
824 	u32 reset_delay_us; /* in usec */
825 	u32 revision;
826 
827 	enum e1000_media_type media_type;
828 
829 	u16 autoneg_advertised;
830 	u16 autoneg_mask;
831 	u16 cable_length;
832 	u16 max_cable_length;
833 	u16 min_cable_length;
834 
835 	u8 mdix;
836 
837 	bool disable_polarity_correction;
838 	bool is_mdix;
839 	bool polarity_correction;
840 	bool speed_downgraded;
841 	bool autoneg_wait_to_complete;
842 };
843 
844 struct e1000_nvm_info {
845 	struct e1000_nvm_operations ops;
846 	enum e1000_nvm_type type;
847 	enum e1000_nvm_override override;
848 
849 	u32 flash_bank_size;
850 	u32 flash_base_addr;
851 
852 	u16 word_size;
853 	u16 delay_usec;
854 	u16 address_bits;
855 	u16 opcode_bits;
856 	u16 page_size;
857 };
858 
859 struct e1000_bus_info {
860 	enum e1000_bus_type type;
861 	enum e1000_bus_speed speed;
862 	enum e1000_bus_width width;
863 
864 	u16 func;
865 	u16 pci_cmd_word;
866 };
867 
868 struct e1000_fc_info {
869 	u32 high_water;  /* Flow control high-water mark */
870 	u32 low_water;  /* Flow control low-water mark */
871 	u16 pause_time;  /* Flow control pause timer */
872 	u16 refresh_time;  /* Flow control refresh timer */
873 	bool send_xon;  /* Flow control send XON */
874 	bool strict_ieee;  /* Strict IEEE mode */
875 	enum e1000_fc_mode current_mode;  /* FC mode in effect */
876 	enum e1000_fc_mode requested_mode;  /* FC mode requested by caller */
877 };
878 
879 struct e1000_mbx_operations {
880 	s32 (*init_params)(struct e1000_hw *hw);
881 	s32 (*read)(struct e1000_hw *, u32 *, u16,  u16);
882 	s32 (*write)(struct e1000_hw *, u32 *, u16, u16);
883 	s32 (*read_posted)(struct e1000_hw *, u32 *, u16,  u16);
884 	s32 (*write_posted)(struct e1000_hw *, u32 *, u16, u16);
885 	s32 (*check_for_msg)(struct e1000_hw *, u16);
886 	s32 (*check_for_ack)(struct e1000_hw *, u16);
887 	s32 (*check_for_rst)(struct e1000_hw *, u16);
888 };
889 
890 struct e1000_mbx_stats {
891 	u32 msgs_tx;
892 	u32 msgs_rx;
893 
894 	u32 acks;
895 	u32 reqs;
896 	u32 rsts;
897 };
898 
899 struct e1000_mbx_info {
900 	struct e1000_mbx_operations ops;
901 	struct e1000_mbx_stats stats;
902 	u32 timeout;
903 	u32 usec_delay;
904 	u16 size;
905 };
906 
907 struct e1000_dev_spec_82541 {
908 	enum e1000_dsp_config dsp_config;
909 	enum e1000_ffe_config ffe_config;
910 	u16 spd_default;
911 	bool phy_init_script;
912 };
913 
914 struct e1000_dev_spec_82542 {
915 	bool dma_fairness;
916 };
917 
918 struct e1000_dev_spec_82543 {
919 	u32  tbi_compatibility;
920 	bool dma_fairness;
921 	bool init_phy_disabled;
922 };
923 
924 struct e1000_dev_spec_82571 {
925 	bool laa_is_present;
926 	u32 smb_counter;
927 	E1000_MUTEX swflag_mutex;
928 };
929 
930 struct e1000_dev_spec_80003es2lan {
931 	bool  mdic_wa_enable;
932 };
933 
934 struct e1000_shadow_ram {
935 	u16  value;
936 	bool modified;
937 };
938 
939 #define E1000_SHADOW_RAM_WORDS		2048
940 
941 /* I218 PHY Ultra Low Power (ULP) states */
942 enum e1000_ulp_state {
943 	e1000_ulp_state_unknown,
944 	e1000_ulp_state_off,
945 	e1000_ulp_state_on,
946 };
947 
948 struct e1000_dev_spec_ich8lan {
949 	bool kmrn_lock_loss_workaround_enabled;
950 	struct e1000_shadow_ram shadow_ram[E1000_SHADOW_RAM_WORDS];
951 	E1000_MUTEX nvm_mutex;
952 	E1000_MUTEX swflag_mutex;
953 	bool nvm_k1_enabled;
954 	bool eee_disable;
955 	u16 eee_lp_ability;
956 	enum e1000_ulp_state ulp_state;
957 };
958 
959 struct e1000_dev_spec_82575 {
960 	bool sgmii_active;
961 	bool global_device_reset;
962 	bool eee_disable;
963 	bool module_plugged;
964 	bool clear_semaphore_once;
965 	u32 mtu;
966 	struct sfp_e1000_flags eth_flags;
967 	u8 media_port;
968 	bool media_changed;
969 };
970 
971 struct e1000_dev_spec_vf {
972 	u32 vf_number;
973 	u32 v2p_mailbox;
974 };
975 
976 struct e1000_hw {
977 	void *back;
978 
979 	u8 *hw_addr;
980 	u8 *flash_address;
981 	unsigned long io_base;
982 
983 	struct e1000_mac_info  mac;
984 	struct e1000_fc_info   fc;
985 	struct e1000_phy_info  phy;
986 	struct e1000_nvm_info  nvm;
987 	struct e1000_bus_info  bus;
988 	struct e1000_mbx_info mbx;
989 	struct e1000_host_mng_dhcp_cookie mng_cookie;
990 
991 	union {
992 		struct e1000_dev_spec_82541 _82541;
993 		struct e1000_dev_spec_82542 _82542;
994 		struct e1000_dev_spec_82543 _82543;
995 		struct e1000_dev_spec_82571 _82571;
996 		struct e1000_dev_spec_80003es2lan _80003es2lan;
997 		struct e1000_dev_spec_ich8lan ich8lan;
998 		struct e1000_dev_spec_82575 _82575;
999 		struct e1000_dev_spec_vf vf;
1000 	} dev_spec;
1001 
1002 	u16 device_id;
1003 	u16 subsystem_vendor_id;
1004 	u16 subsystem_device_id;
1005 	u16 vendor_id;
1006 
1007 	u8  revision_id;
1008 };
1009 
1010 #include "e1000_82541.h"
1011 #include "e1000_82543.h"
1012 #include "e1000_82571.h"
1013 #include "e1000_80003es2lan.h"
1014 #include "e1000_ich8lan.h"
1015 #include "e1000_82575.h"
1016 #include "e1000_i210.h"
1017 
1018 /* These functions must be implemented by drivers */
1019 void e1000_pci_clear_mwi(struct e1000_hw *hw);
1020 void e1000_pci_set_mwi(struct e1000_hw *hw);
1021 s32  e1000_read_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
1022 s32  e1000_write_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
1023 void e1000_read_pci_cfg(struct e1000_hw *hw, u32 reg, u16 *value);
1024 void e1000_write_pci_cfg(struct e1000_hw *hw, u32 reg, u16 *value);
1025 
1026 #endif
1027