xref: /freebsd/sys/dev/e1000/e1000_hw.h (revision 3157ba21)
1 /******************************************************************************
2 
3   Copyright (c) 2001-2010, 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 
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_82576                    0x10C9
131 #define E1000_DEV_ID_82576_FIBER              0x10E6
132 #define E1000_DEV_ID_82576_SERDES             0x10E7
133 #define E1000_DEV_ID_82576_QUAD_COPPER        0x10E8
134 #define E1000_DEV_ID_82576_NS                 0x150A
135 #define E1000_DEV_ID_82576_NS_SERDES          0x1518
136 #define E1000_DEV_ID_82576_SERDES_QUAD        0x150D
137 #define E1000_DEV_ID_82575EB_COPPER           0x10A7
138 #define E1000_DEV_ID_82575EB_FIBER_SERDES     0x10A9
139 #define E1000_DEV_ID_82575GB_QUAD_COPPER      0x10D6
140 #define E1000_DEV_ID_82575GB_QUAD_COPPER_PM   0x10E2
141 #define E1000_DEV_ID_82580_COPPER             0x150E
142 #define E1000_DEV_ID_82580_FIBER              0x150F
143 #define E1000_DEV_ID_82580_SERDES             0x1510
144 #define E1000_DEV_ID_82580_SGMII              0x1511
145 #define E1000_DEV_ID_82580_COPPER_DUAL        0x1516
146 #define E1000_REVISION_0 0
147 #define E1000_REVISION_1 1
148 #define E1000_REVISION_2 2
149 #define E1000_REVISION_3 3
150 #define E1000_REVISION_4 4
151 
152 #define E1000_FUNC_0     0
153 #define E1000_FUNC_1     1
154 #define E1000_FUNC_2     2
155 #define E1000_FUNC_3     3
156 
157 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0   0
158 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1   3
159 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN2   6
160 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN3   9
161 
162 enum e1000_mac_type {
163 	e1000_undefined = 0,
164 	e1000_82542,
165 	e1000_82543,
166 	e1000_82544,
167 	e1000_82540,
168 	e1000_82545,
169 	e1000_82545_rev_3,
170 	e1000_82546,
171 	e1000_82546_rev_3,
172 	e1000_82541,
173 	e1000_82541_rev_2,
174 	e1000_82547,
175 	e1000_82547_rev_2,
176 	e1000_82571,
177 	e1000_82572,
178 	e1000_82573,
179 	e1000_82574,
180 	e1000_82583,
181 	e1000_80003es2lan,
182 	e1000_ich8lan,
183 	e1000_ich9lan,
184 	e1000_ich10lan,
185 	e1000_pchlan,
186 	e1000_82575,
187 	e1000_82576,
188 	e1000_82580,
189 	e1000_num_macs  /* List is 1-based, so subtract 1 for TRUE count. */
190 };
191 
192 enum e1000_media_type {
193 	e1000_media_type_unknown = 0,
194 	e1000_media_type_copper = 1,
195 	e1000_media_type_fiber = 2,
196 	e1000_media_type_internal_serdes = 3,
197 	e1000_num_media_types
198 };
199 
200 enum e1000_nvm_type {
201 	e1000_nvm_unknown = 0,
202 	e1000_nvm_none,
203 	e1000_nvm_eeprom_spi,
204 	e1000_nvm_eeprom_microwire,
205 	e1000_nvm_flash_hw,
206 	e1000_nvm_flash_sw
207 };
208 
209 enum e1000_nvm_override {
210 	e1000_nvm_override_none = 0,
211 	e1000_nvm_override_spi_small,
212 	e1000_nvm_override_spi_large,
213 	e1000_nvm_override_microwire_small,
214 	e1000_nvm_override_microwire_large
215 };
216 
217 enum e1000_phy_type {
218 	e1000_phy_unknown = 0,
219 	e1000_phy_none,
220 	e1000_phy_m88,
221 	e1000_phy_igp,
222 	e1000_phy_igp_2,
223 	e1000_phy_gg82563,
224 	e1000_phy_igp_3,
225 	e1000_phy_ife,
226 	e1000_phy_bm,
227 	e1000_phy_82578,
228 	e1000_phy_82577,
229 	e1000_phy_82580,
230 	e1000_phy_vf,
231 };
232 
233 enum e1000_bus_type {
234 	e1000_bus_type_unknown = 0,
235 	e1000_bus_type_pci,
236 	e1000_bus_type_pcix,
237 	e1000_bus_type_pci_express,
238 	e1000_bus_type_reserved
239 };
240 
241 enum e1000_bus_speed {
242 	e1000_bus_speed_unknown = 0,
243 	e1000_bus_speed_33,
244 	e1000_bus_speed_66,
245 	e1000_bus_speed_100,
246 	e1000_bus_speed_120,
247 	e1000_bus_speed_133,
248 	e1000_bus_speed_2500,
249 	e1000_bus_speed_5000,
250 	e1000_bus_speed_reserved
251 };
252 
253 enum e1000_bus_width {
254 	e1000_bus_width_unknown = 0,
255 	e1000_bus_width_pcie_x1,
256 	e1000_bus_width_pcie_x2,
257 	e1000_bus_width_pcie_x4 = 4,
258 	e1000_bus_width_pcie_x8 = 8,
259 	e1000_bus_width_32,
260 	e1000_bus_width_64,
261 	e1000_bus_width_reserved
262 };
263 
264 enum e1000_1000t_rx_status {
265 	e1000_1000t_rx_status_not_ok = 0,
266 	e1000_1000t_rx_status_ok,
267 	e1000_1000t_rx_status_undefined = 0xFF
268 };
269 
270 enum e1000_rev_polarity {
271 	e1000_rev_polarity_normal = 0,
272 	e1000_rev_polarity_reversed,
273 	e1000_rev_polarity_undefined = 0xFF
274 };
275 
276 enum e1000_fc_mode {
277 	e1000_fc_none = 0,
278 	e1000_fc_rx_pause,
279 	e1000_fc_tx_pause,
280 	e1000_fc_full,
281 	e1000_fc_default = 0xFF
282 };
283 
284 enum e1000_ffe_config {
285 	e1000_ffe_config_enabled = 0,
286 	e1000_ffe_config_active,
287 	e1000_ffe_config_blocked
288 };
289 
290 enum e1000_dsp_config {
291 	e1000_dsp_config_disabled = 0,
292 	e1000_dsp_config_enabled,
293 	e1000_dsp_config_activated,
294 	e1000_dsp_config_undefined = 0xFF
295 };
296 
297 enum e1000_ms_type {
298 	e1000_ms_hw_default = 0,
299 	e1000_ms_force_master,
300 	e1000_ms_force_slave,
301 	e1000_ms_auto
302 };
303 
304 enum e1000_smart_speed {
305 	e1000_smart_speed_default = 0,
306 	e1000_smart_speed_on,
307 	e1000_smart_speed_off
308 };
309 
310 enum e1000_serdes_link_state {
311 	e1000_serdes_link_down = 0,
312 	e1000_serdes_link_autoneg_progress,
313 	e1000_serdes_link_autoneg_complete,
314 	e1000_serdes_link_forced_up
315 };
316 
317 /* Receive Descriptor */
318 struct e1000_rx_desc {
319 	__le64 buffer_addr; /* Address of the descriptor's data buffer */
320 	__le16 length;      /* Length of data DMAed into data buffer */
321 	__le16 csum;        /* Packet checksum */
322 	u8  status;         /* Descriptor status */
323 	u8  errors;         /* Descriptor Errors */
324 	__le16 special;
325 };
326 
327 /* Receive Descriptor - Extended */
328 union e1000_rx_desc_extended {
329 	struct {
330 		__le64 buffer_addr;
331 		__le64 reserved;
332 	} read;
333 	struct {
334 		struct {
335 			__le32 mrq;           /* Multiple Rx Queues */
336 			union {
337 				__le32 rss;         /* RSS Hash */
338 				struct {
339 					__le16 ip_id;  /* IP id */
340 					__le16 csum;   /* Packet Checksum */
341 				} csum_ip;
342 			} hi_dword;
343 		} lower;
344 		struct {
345 			__le32 status_error;  /* ext status/error */
346 			__le16 length;
347 			__le16 vlan;          /* VLAN tag */
348 		} upper;
349 	} wb;  /* writeback */
350 };
351 
352 #define MAX_PS_BUFFERS 4
353 /* Receive Descriptor - Packet Split */
354 union e1000_rx_desc_packet_split {
355 	struct {
356 		/* one buffer for protocol header(s), three data buffers */
357 		__le64 buffer_addr[MAX_PS_BUFFERS];
358 	} read;
359 	struct {
360 		struct {
361 			__le32 mrq;           /* Multiple Rx Queues */
362 			union {
363 				__le32 rss;           /* RSS Hash */
364 				struct {
365 					__le16 ip_id;    /* IP id */
366 					__le16 csum;     /* Packet Checksum */
367 				} csum_ip;
368 			} hi_dword;
369 		} lower;
370 		struct {
371 			__le32 status_error;  /* ext status/error */
372 			__le16 length0;       /* length of buffer 0 */
373 			__le16 vlan;          /* VLAN tag */
374 		} middle;
375 		struct {
376 			__le16 header_status;
377 			__le16 length[3];     /* length of buffers 1-3 */
378 		} upper;
379 		__le64 reserved;
380 	} wb; /* writeback */
381 };
382 
383 /* Transmit Descriptor */
384 struct e1000_tx_desc {
385 	__le64 buffer_addr;   /* Address of the descriptor's data buffer */
386 	union {
387 		__le32 data;
388 		struct {
389 			__le16 length;    /* Data buffer length */
390 			u8 cso;           /* Checksum offset */
391 			u8 cmd;           /* Descriptor control */
392 		} flags;
393 	} lower;
394 	union {
395 		__le32 data;
396 		struct {
397 			u8 status;        /* Descriptor status */
398 			u8 css;           /* Checksum start */
399 			__le16 special;
400 		} fields;
401 	} upper;
402 };
403 
404 /* Offload Context Descriptor */
405 struct e1000_context_desc {
406 	union {
407 		__le32 ip_config;
408 		struct {
409 			u8 ipcss;         /* IP checksum start */
410 			u8 ipcso;         /* IP checksum offset */
411 			__le16 ipcse;     /* IP checksum end */
412 		} ip_fields;
413 	} lower_setup;
414 	union {
415 		__le32 tcp_config;
416 		struct {
417 			u8 tucss;         /* TCP checksum start */
418 			u8 tucso;         /* TCP checksum offset */
419 			__le16 tucse;     /* TCP checksum end */
420 		} tcp_fields;
421 	} upper_setup;
422 	__le32 cmd_and_length;
423 	union {
424 		__le32 data;
425 		struct {
426 			u8 status;        /* Descriptor status */
427 			u8 hdr_len;       /* Header length */
428 			__le16 mss;       /* Maximum segment size */
429 		} fields;
430 	} tcp_seg_setup;
431 };
432 
433 /* Offload data descriptor */
434 struct e1000_data_desc {
435 	__le64 buffer_addr;   /* Address of the descriptor's buffer address */
436 	union {
437 		__le32 data;
438 		struct {
439 			__le16 length;    /* Data buffer length */
440 			u8 typ_len_ext;
441 			u8 cmd;
442 		} flags;
443 	} lower;
444 	union {
445 		__le32 data;
446 		struct {
447 			u8 status;        /* Descriptor status */
448 			u8 popts;         /* Packet Options */
449 			__le16 special;
450 		} fields;
451 	} upper;
452 };
453 
454 /* Statistics counters collected by the MAC */
455 struct e1000_hw_stats {
456 	u64 crcerrs;
457 	u64 algnerrc;
458 	u64 symerrs;
459 	u64 rxerrc;
460 	u64 mpc;
461 	u64 scc;
462 	u64 ecol;
463 	u64 mcc;
464 	u64 latecol;
465 	u64 colc;
466 	u64 dc;
467 	u64 tncrs;
468 	u64 sec;
469 	u64 cexterr;
470 	u64 rlec;
471 	u64 xonrxc;
472 	u64 xontxc;
473 	u64 xoffrxc;
474 	u64 xofftxc;
475 	u64 fcruc;
476 	u64 prc64;
477 	u64 prc127;
478 	u64 prc255;
479 	u64 prc511;
480 	u64 prc1023;
481 	u64 prc1522;
482 	u64 gprc;
483 	u64 bprc;
484 	u64 mprc;
485 	u64 gptc;
486 	u64 gorc;
487 	u64 gotc;
488 	u64 rnbc;
489 	u64 ruc;
490 	u64 rfc;
491 	u64 roc;
492 	u64 rjc;
493 	u64 mgprc;
494 	u64 mgpdc;
495 	u64 mgptc;
496 	u64 tor;
497 	u64 tot;
498 	u64 tpr;
499 	u64 tpt;
500 	u64 ptc64;
501 	u64 ptc127;
502 	u64 ptc255;
503 	u64 ptc511;
504 	u64 ptc1023;
505 	u64 ptc1522;
506 	u64 mptc;
507 	u64 bptc;
508 	u64 tsctc;
509 	u64 tsctfc;
510 	u64 iac;
511 	u64 icrxptc;
512 	u64 icrxatc;
513 	u64 ictxptc;
514 	u64 ictxatc;
515 	u64 ictxqec;
516 	u64 ictxqmtc;
517 	u64 icrxdmtc;
518 	u64 icrxoc;
519 	u64 cbtmpc;
520 	u64 htdpmc;
521 	u64 cbrdpc;
522 	u64 cbrmpc;
523 	u64 rpthc;
524 	u64 hgptc;
525 	u64 htcbdpc;
526 	u64 hgorc;
527 	u64 hgotc;
528 	u64 lenerrs;
529 	u64 scvpc;
530 	u64 hrmpc;
531 	u64 doosync;
532 };
533 
534 
535 struct e1000_phy_stats {
536 	u32 idle_errors;
537 	u32 receive_errors;
538 };
539 
540 struct e1000_host_mng_dhcp_cookie {
541 	u32 signature;
542 	u8  status;
543 	u8  reserved0;
544 	u16 vlan_id;
545 	u32 reserved1;
546 	u16 reserved2;
547 	u8  reserved3;
548 	u8  checksum;
549 };
550 
551 /* Host Interface "Rev 1" */
552 struct e1000_host_command_header {
553 	u8 command_id;
554 	u8 command_length;
555 	u8 command_options;
556 	u8 checksum;
557 };
558 
559 #define E1000_HI_MAX_DATA_LENGTH     252
560 struct e1000_host_command_info {
561 	struct e1000_host_command_header command_header;
562 	u8 command_data[E1000_HI_MAX_DATA_LENGTH];
563 };
564 
565 /* Host Interface "Rev 2" */
566 struct e1000_host_mng_command_header {
567 	u8  command_id;
568 	u8  checksum;
569 	u16 reserved1;
570 	u16 reserved2;
571 	u16 command_length;
572 };
573 
574 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
575 struct e1000_host_mng_command_info {
576 	struct e1000_host_mng_command_header command_header;
577 	u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
578 };
579 
580 #include "e1000_mac.h"
581 #include "e1000_phy.h"
582 #include "e1000_nvm.h"
583 #include "e1000_manage.h"
584 
585 struct e1000_mac_operations {
586 	/* Function pointers for the MAC. */
587 	s32  (*init_params)(struct e1000_hw *);
588 	s32  (*id_led_init)(struct e1000_hw *);
589 	s32  (*blink_led)(struct e1000_hw *);
590 	s32  (*check_for_link)(struct e1000_hw *);
591 	bool (*check_mng_mode)(struct e1000_hw *hw);
592 	s32  (*cleanup_led)(struct e1000_hw *);
593 	void (*clear_hw_cntrs)(struct e1000_hw *);
594 	void (*clear_vfta)(struct e1000_hw *);
595 	s32  (*get_bus_info)(struct e1000_hw *);
596 	void (*set_lan_id)(struct e1000_hw *);
597 	s32  (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
598 	s32  (*led_on)(struct e1000_hw *);
599 	s32  (*led_off)(struct e1000_hw *);
600 	void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32);
601 	s32  (*reset_hw)(struct e1000_hw *);
602 	s32  (*init_hw)(struct e1000_hw *);
603 	void (*shutdown_serdes)(struct e1000_hw *);
604 	void (*power_up_serdes)(struct e1000_hw *);
605 	s32  (*setup_link)(struct e1000_hw *);
606 	s32  (*setup_physical_interface)(struct e1000_hw *);
607 	s32  (*setup_led)(struct e1000_hw *);
608 	void (*write_vfta)(struct e1000_hw *, u32, u32);
609 	void (*config_collision_dist)(struct e1000_hw *);
610 	void (*rar_set)(struct e1000_hw *, u8*, u32);
611 	s32  (*read_mac_addr)(struct e1000_hw *);
612 	s32  (*validate_mdi_setting)(struct e1000_hw *);
613 	s32  (*mng_host_if_write)(struct e1000_hw *, u8*, u16, u16, u8*);
614 	s32  (*mng_write_cmd_header)(struct e1000_hw *hw,
615                       struct e1000_host_mng_command_header*);
616 	s32  (*mng_enable_host_if)(struct e1000_hw *);
617 	s32  (*wait_autoneg)(struct e1000_hw *);
618 };
619 
620 struct e1000_phy_operations {
621 	s32  (*init_params)(struct e1000_hw *);
622 	s32  (*acquire)(struct e1000_hw *);
623 	s32  (*cfg_on_link_up)(struct e1000_hw *);
624 	s32  (*check_polarity)(struct e1000_hw *);
625 	s32  (*check_reset_block)(struct e1000_hw *);
626 	s32  (*commit)(struct e1000_hw *);
627 	s32  (*force_speed_duplex)(struct e1000_hw *);
628 	s32  (*get_cfg_done)(struct e1000_hw *hw);
629 	s32  (*get_cable_length)(struct e1000_hw *);
630 	s32  (*get_info)(struct e1000_hw *);
631 	s32  (*read_reg)(struct e1000_hw *, u32, u16 *);
632 	s32  (*read_reg_locked)(struct e1000_hw *, u32, u16 *);
633 	void (*release)(struct e1000_hw *);
634 	s32  (*reset)(struct e1000_hw *);
635 	s32  (*set_d0_lplu_state)(struct e1000_hw *, bool);
636 	s32  (*set_d3_lplu_state)(struct e1000_hw *, bool);
637 	s32  (*write_reg)(struct e1000_hw *, u32, u16);
638 	s32  (*write_reg_locked)(struct e1000_hw *, u32, u16);
639 	void (*power_up)(struct e1000_hw *);
640 	void (*power_down)(struct e1000_hw *);
641 };
642 
643 struct e1000_nvm_operations {
644 	s32  (*init_params)(struct e1000_hw *);
645 	s32  (*acquire)(struct e1000_hw *);
646 	s32  (*read)(struct e1000_hw *, u16, u16, u16 *);
647 	void (*release)(struct e1000_hw *);
648 	void (*reload)(struct e1000_hw *);
649 	s32  (*update)(struct e1000_hw *);
650 	s32  (*valid_led_default)(struct e1000_hw *, u16 *);
651 	s32  (*validate)(struct e1000_hw *);
652 	s32  (*write)(struct e1000_hw *, u16, u16, u16 *);
653 };
654 
655 struct e1000_mac_info {
656 	struct e1000_mac_operations ops;
657 	u8 addr[6];
658 	u8 perm_addr[6];
659 
660 	enum e1000_mac_type type;
661 
662 	u32 collision_delta;
663 	u32 ledctl_default;
664 	u32 ledctl_mode1;
665 	u32 ledctl_mode2;
666 	u32 mc_filter_type;
667 	u32 tx_packet_delta;
668 	u32 txcw;
669 
670 	u16 current_ifs_val;
671 	u16 ifs_max_val;
672 	u16 ifs_min_val;
673 	u16 ifs_ratio;
674 	u16 ifs_step_size;
675 	u16 mta_reg_count;
676 	u16 uta_reg_count;
677 
678 	/* Maximum size of the MTA register table in all supported adapters */
679 	#define MAX_MTA_REG 128
680 	u32 mta_shadow[MAX_MTA_REG];
681 	u16 rar_entry_count;
682 
683 	u8  forced_speed_duplex;
684 
685 	bool adaptive_ifs;
686 	bool has_fwsm;
687 	bool arc_subsystem_valid;
688 	bool asf_firmware_present;
689 	bool autoneg;
690 	bool autoneg_failed;
691 	bool get_link_status;
692 	bool in_ifs_mode;
693 	bool report_tx_early;
694 	enum e1000_serdes_link_state serdes_link_state;
695 	bool serdes_has_link;
696 	bool tx_pkt_filtering;
697 };
698 
699 struct e1000_phy_info {
700 	struct e1000_phy_operations ops;
701 	enum e1000_phy_type type;
702 
703 	enum e1000_1000t_rx_status local_rx;
704 	enum e1000_1000t_rx_status remote_rx;
705 	enum e1000_ms_type ms_type;
706 	enum e1000_ms_type original_ms_type;
707 	enum e1000_rev_polarity cable_polarity;
708 	enum e1000_smart_speed smart_speed;
709 
710 	u32 addr;
711 	u32 id;
712 	u32 reset_delay_us; /* in usec */
713 	u32 revision;
714 
715 	enum e1000_media_type media_type;
716 
717 	u16 autoneg_advertised;
718 	u16 autoneg_mask;
719 	u16 cable_length;
720 	u16 max_cable_length;
721 	u16 min_cable_length;
722 
723 	u8 mdix;
724 
725 	bool disable_polarity_correction;
726 	bool is_mdix;
727 	bool polarity_correction;
728 	bool reset_disable;
729 	bool speed_downgraded;
730 	bool autoneg_wait_to_complete;
731 };
732 
733 struct e1000_nvm_info {
734 	struct e1000_nvm_operations ops;
735 	enum e1000_nvm_type type;
736 	enum e1000_nvm_override override;
737 
738 	u32 flash_bank_size;
739 	u32 flash_base_addr;
740 
741 	u16 word_size;
742 	u16 delay_usec;
743 	u16 address_bits;
744 	u16 opcode_bits;
745 	u16 page_size;
746 };
747 
748 struct e1000_bus_info {
749 	enum e1000_bus_type type;
750 	enum e1000_bus_speed speed;
751 	enum e1000_bus_width width;
752 
753 	u16 func;
754 	u16 pci_cmd_word;
755 };
756 
757 struct e1000_fc_info {
758 	u32 high_water;          /* Flow control high-water mark */
759 	u32 low_water;           /* Flow control low-water mark */
760 	u16 pause_time;          /* Flow control pause timer */
761 	bool send_xon;           /* Flow control send XON */
762 	bool strict_ieee;        /* Strict IEEE mode */
763 	enum e1000_fc_mode current_mode; /* FC mode in effect */
764 	enum e1000_fc_mode requested_mode; /* FC mode requested by caller */
765 };
766 
767 struct e1000_dev_spec_82541 {
768 	enum e1000_dsp_config dsp_config;
769 	enum e1000_ffe_config ffe_config;
770 	u16 spd_default;
771 	bool phy_init_script;
772 };
773 
774 struct e1000_dev_spec_82542 {
775 	bool dma_fairness;
776 };
777 
778 struct e1000_dev_spec_82543 {
779 	u32  tbi_compatibility;
780 	bool dma_fairness;
781 	bool init_phy_disabled;
782 };
783 
784 struct e1000_dev_spec_82571 {
785 	bool laa_is_present;
786 	u32 smb_counter;
787 };
788 
789 struct e1000_dev_spec_80003es2lan {
790 	bool  mdic_wa_enable;
791 };
792 
793 struct e1000_shadow_ram {
794 	u16  value;
795 	bool modified;
796 };
797 
798 #define E1000_SHADOW_RAM_WORDS		2048
799 
800 struct e1000_dev_spec_ich8lan {
801 	bool kmrn_lock_loss_workaround_enabled;
802 	struct e1000_shadow_ram shadow_ram[E1000_SHADOW_RAM_WORDS];
803 	E1000_MUTEX nvm_mutex;
804 	E1000_MUTEX swflag_mutex;
805 	bool nvm_k1_enabled;
806 };
807 
808 struct e1000_dev_spec_82575 {
809 	bool sgmii_active;
810 	bool global_device_reset;
811 };
812 
813 struct e1000_dev_spec_vf {
814 	u32	vf_number;
815 	u32	v2p_mailbox;
816 };
817 
818 
819 struct e1000_hw {
820 	void *back;
821 
822 	u8 *hw_addr;
823 	u8 *flash_address;
824 	unsigned long io_base;
825 
826 	struct e1000_mac_info  mac;
827 	struct e1000_fc_info   fc;
828 	struct e1000_phy_info  phy;
829 	struct e1000_nvm_info  nvm;
830 	struct e1000_bus_info  bus;
831 	struct e1000_host_mng_dhcp_cookie mng_cookie;
832 
833 	union {
834 		struct e1000_dev_spec_82541	_82541;
835 		struct e1000_dev_spec_82542	_82542;
836 		struct e1000_dev_spec_82543	_82543;
837 		struct e1000_dev_spec_82571	_82571;
838 		struct e1000_dev_spec_80003es2lan _80003es2lan;
839 		struct e1000_dev_spec_ich8lan	ich8lan;
840 		struct e1000_dev_spec_82575	_82575;
841 		struct e1000_dev_spec_vf	vf;
842 	} dev_spec;
843 
844 	u16 device_id;
845 	u16 subsystem_vendor_id;
846 	u16 subsystem_device_id;
847 	u16 vendor_id;
848 
849 	u8  revision_id;
850 };
851 
852 #include "e1000_82541.h"
853 #include "e1000_82543.h"
854 #include "e1000_82571.h"
855 #include "e1000_80003es2lan.h"
856 #include "e1000_ich8lan.h"
857 #include "e1000_82575.h"
858 
859 /* These functions must be implemented by drivers */
860 void e1000_pci_clear_mwi(struct e1000_hw *hw);
861 void e1000_pci_set_mwi(struct e1000_hw *hw);
862 s32  e1000_read_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
863 s32  e1000_write_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
864 void e1000_read_pci_cfg(struct e1000_hw *hw, u32 reg, u16 *value);
865 void e1000_write_pci_cfg(struct e1000_hw *hw, u32 reg, u16 *value);
866 
867 #endif
868