xref: /linux/drivers/net/ethernet/intel/e1000e/hw.h (revision abacaf559950eec0d99d37ff6b92049409af5943)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright(c) 1999 - 2018 Intel Corporation. */
3 
4 #ifndef _E1000E_HW_H_
5 #define _E1000E_HW_H_
6 
7 #include "regs.h"
8 #include "defines.h"
9 
10 struct e1000_hw;
11 
12 #define E1000_DEV_ID_82571EB_COPPER		0x105E
13 #define E1000_DEV_ID_82571EB_FIBER		0x105F
14 #define E1000_DEV_ID_82571EB_SERDES		0x1060
15 #define E1000_DEV_ID_82571EB_QUAD_COPPER	0x10A4
16 #define E1000_DEV_ID_82571PT_QUAD_COPPER	0x10D5
17 #define E1000_DEV_ID_82571EB_QUAD_FIBER		0x10A5
18 #define E1000_DEV_ID_82571EB_QUAD_COPPER_LP	0x10BC
19 #define E1000_DEV_ID_82571EB_SERDES_DUAL	0x10D9
20 #define E1000_DEV_ID_82571EB_SERDES_QUAD	0x10DA
21 #define E1000_DEV_ID_82572EI_COPPER		0x107D
22 #define E1000_DEV_ID_82572EI_FIBER		0x107E
23 #define E1000_DEV_ID_82572EI_SERDES		0x107F
24 #define E1000_DEV_ID_82572EI			0x10B9
25 #define E1000_DEV_ID_82573E			0x108B
26 #define E1000_DEV_ID_82573E_IAMT		0x108C
27 #define E1000_DEV_ID_82573L			0x109A
28 #define E1000_DEV_ID_82574L			0x10D3
29 #define E1000_DEV_ID_82574LA			0x10F6
30 #define E1000_DEV_ID_82583V			0x150C
31 #define E1000_DEV_ID_80003ES2LAN_COPPER_DPT	0x1096
32 #define E1000_DEV_ID_80003ES2LAN_SERDES_DPT	0x1098
33 #define E1000_DEV_ID_80003ES2LAN_COPPER_SPT	0x10BA
34 #define E1000_DEV_ID_80003ES2LAN_SERDES_SPT	0x10BB
35 #define E1000_DEV_ID_ICH8_82567V_3		0x1501
36 #define E1000_DEV_ID_ICH8_IGP_M_AMT		0x1049
37 #define E1000_DEV_ID_ICH8_IGP_AMT		0x104A
38 #define E1000_DEV_ID_ICH8_IGP_C			0x104B
39 #define E1000_DEV_ID_ICH8_IFE			0x104C
40 #define E1000_DEV_ID_ICH8_IFE_GT		0x10C4
41 #define E1000_DEV_ID_ICH8_IFE_G			0x10C5
42 #define E1000_DEV_ID_ICH8_IGP_M			0x104D
43 #define E1000_DEV_ID_ICH9_IGP_AMT		0x10BD
44 #define E1000_DEV_ID_ICH9_BM			0x10E5
45 #define E1000_DEV_ID_ICH9_IGP_M_AMT		0x10F5
46 #define E1000_DEV_ID_ICH9_IGP_M			0x10BF
47 #define E1000_DEV_ID_ICH9_IGP_M_V		0x10CB
48 #define E1000_DEV_ID_ICH9_IGP_C			0x294C
49 #define E1000_DEV_ID_ICH9_IFE			0x10C0
50 #define E1000_DEV_ID_ICH9_IFE_GT		0x10C3
51 #define E1000_DEV_ID_ICH9_IFE_G			0x10C2
52 #define E1000_DEV_ID_ICH10_R_BM_LM		0x10CC
53 #define E1000_DEV_ID_ICH10_R_BM_LF		0x10CD
54 #define E1000_DEV_ID_ICH10_R_BM_V		0x10CE
55 #define E1000_DEV_ID_ICH10_D_BM_LM		0x10DE
56 #define E1000_DEV_ID_ICH10_D_BM_LF		0x10DF
57 #define E1000_DEV_ID_ICH10_D_BM_V		0x1525
58 #define E1000_DEV_ID_PCH_M_HV_LM		0x10EA
59 #define E1000_DEV_ID_PCH_M_HV_LC		0x10EB
60 #define E1000_DEV_ID_PCH_D_HV_DM		0x10EF
61 #define E1000_DEV_ID_PCH_D_HV_DC		0x10F0
62 #define E1000_DEV_ID_PCH2_LV_LM			0x1502
63 #define E1000_DEV_ID_PCH2_LV_V			0x1503
64 #define E1000_DEV_ID_PCH_LPT_I217_LM		0x153A
65 #define E1000_DEV_ID_PCH_LPT_I217_V		0x153B
66 #define E1000_DEV_ID_PCH_LPTLP_I218_LM		0x155A
67 #define E1000_DEV_ID_PCH_LPTLP_I218_V		0x1559
68 #define E1000_DEV_ID_PCH_I218_LM2		0x15A0
69 #define E1000_DEV_ID_PCH_I218_V2		0x15A1
70 #define E1000_DEV_ID_PCH_I218_LM3		0x15A2	/* Wildcat Point PCH */
71 #define E1000_DEV_ID_PCH_I218_V3		0x15A3	/* Wildcat Point PCH */
72 #define E1000_DEV_ID_PCH_SPT_I219_LM		0x156F	/* SPT PCH */
73 #define E1000_DEV_ID_PCH_SPT_I219_V		0x1570	/* SPT PCH */
74 #define E1000_DEV_ID_PCH_SPT_I219_LM2		0x15B7	/* SPT-H PCH */
75 #define E1000_DEV_ID_PCH_SPT_I219_V2		0x15B8	/* SPT-H PCH */
76 #define E1000_DEV_ID_PCH_LBG_I219_LM3		0x15B9	/* LBG PCH */
77 #define E1000_DEV_ID_PCH_SPT_I219_LM4		0x15D7
78 #define E1000_DEV_ID_PCH_SPT_I219_V4		0x15D8
79 #define E1000_DEV_ID_PCH_SPT_I219_LM5		0x15E3
80 #define E1000_DEV_ID_PCH_SPT_I219_V5		0x15D6
81 #define E1000_DEV_ID_PCH_CNP_I219_LM6		0x15BD
82 #define E1000_DEV_ID_PCH_CNP_I219_V6		0x15BE
83 #define E1000_DEV_ID_PCH_CNP_I219_LM7		0x15BB
84 #define E1000_DEV_ID_PCH_CNP_I219_V7		0x15BC
85 #define E1000_DEV_ID_PCH_ICP_I219_LM8		0x15DF
86 #define E1000_DEV_ID_PCH_ICP_I219_V8		0x15E0
87 #define E1000_DEV_ID_PCH_ICP_I219_LM9		0x15E1
88 #define E1000_DEV_ID_PCH_ICP_I219_V9		0x15E2
89 #define E1000_DEV_ID_PCH_CMP_I219_LM10		0x0D4E
90 #define E1000_DEV_ID_PCH_CMP_I219_V10		0x0D4F
91 #define E1000_DEV_ID_PCH_CMP_I219_LM11		0x0D4C
92 #define E1000_DEV_ID_PCH_CMP_I219_V11		0x0D4D
93 #define E1000_DEV_ID_PCH_CMP_I219_LM12		0x0D53
94 #define E1000_DEV_ID_PCH_CMP_I219_V12		0x0D55
95 #define E1000_DEV_ID_PCH_TGP_I219_LM13		0x15FB
96 #define E1000_DEV_ID_PCH_TGP_I219_V13		0x15FC
97 #define E1000_DEV_ID_PCH_TGP_I219_LM14		0x15F9
98 #define E1000_DEV_ID_PCH_TGP_I219_V14		0x15FA
99 #define E1000_DEV_ID_PCH_TGP_I219_LM15		0x15F4
100 #define E1000_DEV_ID_PCH_TGP_I219_V15		0x15F5
101 #define E1000_DEV_ID_PCH_RPL_I219_LM23		0x0DC5
102 #define E1000_DEV_ID_PCH_RPL_I219_V23		0x0DC6
103 #define E1000_DEV_ID_PCH_ADP_I219_LM16		0x1A1E
104 #define E1000_DEV_ID_PCH_ADP_I219_V16		0x1A1F
105 #define E1000_DEV_ID_PCH_ADP_I219_LM17		0x1A1C
106 #define E1000_DEV_ID_PCH_ADP_I219_V17		0x1A1D
107 #define E1000_DEV_ID_PCH_RPL_I219_LM22		0x0DC7
108 #define E1000_DEV_ID_PCH_RPL_I219_V22		0x0DC8
109 #define E1000_DEV_ID_PCH_MTP_I219_LM18		0x550A
110 #define E1000_DEV_ID_PCH_MTP_I219_V18		0x550B
111 #define E1000_DEV_ID_PCH_ADP_I219_LM19		0x550C
112 #define E1000_DEV_ID_PCH_ADP_I219_V19		0x550D
113 #define E1000_DEV_ID_PCH_LNP_I219_LM20		0x550E
114 #define E1000_DEV_ID_PCH_LNP_I219_V20		0x550F
115 #define E1000_DEV_ID_PCH_LNP_I219_LM21		0x5510
116 #define E1000_DEV_ID_PCH_LNP_I219_V21		0x5511
117 #define E1000_DEV_ID_PCH_ARL_I219_LM24		0x57A0
118 #define E1000_DEV_ID_PCH_ARL_I219_V24		0x57A1
119 #define E1000_DEV_ID_PCH_PTP_I219_LM25		0x57B3
120 #define E1000_DEV_ID_PCH_PTP_I219_V25		0x57B4
121 #define E1000_DEV_ID_PCH_PTP_I219_LM27		0x57B7
122 #define E1000_DEV_ID_PCH_PTP_I219_V27		0x57B8
123 #define E1000_DEV_ID_PCH_NVL_I219_LM29		0x57B9
124 #define E1000_DEV_ID_PCH_NVL_I219_V29		0x57BA
125 
126 #define E1000_REVISION_4	4
127 
128 #define E1000_FUNC_1		1
129 
130 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0	0
131 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1	3
132 
133 enum e1000_mac_type {
134 	e1000_82571,
135 	e1000_82572,
136 	e1000_82573,
137 	e1000_82574,
138 	e1000_82583,
139 	e1000_80003es2lan,
140 	e1000_ich8lan,
141 	e1000_ich9lan,
142 	e1000_ich10lan,
143 	e1000_pchlan,
144 	e1000_pch2lan,
145 	e1000_pch_lpt,
146 	e1000_pch_spt,
147 	e1000_pch_cnp,
148 	e1000_pch_tgp,
149 	e1000_pch_adp,
150 	e1000_pch_mtp,
151 	e1000_pch_lnp,
152 	e1000_pch_ptp,
153 	e1000_pch_nvp,
154 };
155 
156 enum e1000_media_type {
157 	e1000_media_type_unknown = 0,
158 	e1000_media_type_copper = 1,
159 	e1000_media_type_fiber = 2,
160 	e1000_media_type_internal_serdes = 3,
161 	e1000_num_media_types
162 };
163 
164 enum e1000_nvm_type {
165 	e1000_nvm_unknown = 0,
166 	e1000_nvm_none,
167 	e1000_nvm_eeprom_spi,
168 	e1000_nvm_flash_hw,
169 	e1000_nvm_flash_sw
170 };
171 
172 enum e1000_nvm_override {
173 	e1000_nvm_override_none = 0,
174 	e1000_nvm_override_spi_small,
175 	e1000_nvm_override_spi_large
176 };
177 
178 enum e1000_phy_type {
179 	e1000_phy_unknown = 0,
180 	e1000_phy_none,
181 	e1000_phy_m88,
182 	e1000_phy_igp,
183 	e1000_phy_igp_2,
184 	e1000_phy_gg82563,
185 	e1000_phy_igp_3,
186 	e1000_phy_ife,
187 	e1000_phy_bm,
188 	e1000_phy_82578,
189 	e1000_phy_82577,
190 	e1000_phy_82579,
191 	e1000_phy_i217,
192 };
193 
194 enum e1000_bus_width {
195 	e1000_bus_width_unknown = 0,
196 	e1000_bus_width_pcie_x1,
197 	e1000_bus_width_pcie_x2,
198 	e1000_bus_width_pcie_x4 = 4,
199 	e1000_bus_width_pcie_x8 = 8,
200 	e1000_bus_width_32,
201 	e1000_bus_width_64,
202 	e1000_bus_width_reserved
203 };
204 
205 enum e1000_1000t_rx_status {
206 	e1000_1000t_rx_status_not_ok = 0,
207 	e1000_1000t_rx_status_ok,
208 	e1000_1000t_rx_status_undefined = 0xFF
209 };
210 
211 enum e1000_rev_polarity {
212 	e1000_rev_polarity_normal = 0,
213 	e1000_rev_polarity_reversed,
214 	e1000_rev_polarity_undefined = 0xFF
215 };
216 
217 enum e1000_fc_mode {
218 	e1000_fc_none = 0,
219 	e1000_fc_rx_pause,
220 	e1000_fc_tx_pause,
221 	e1000_fc_full,
222 	e1000_fc_default = 0xFF
223 };
224 
225 enum e1000_ms_type {
226 	e1000_ms_hw_default = 0,
227 	e1000_ms_force_master,
228 	e1000_ms_force_slave,
229 	e1000_ms_auto
230 };
231 
232 enum e1000_smart_speed {
233 	e1000_smart_speed_default = 0,
234 	e1000_smart_speed_on,
235 	e1000_smart_speed_off
236 };
237 
238 enum e1000_serdes_link_state {
239 	e1000_serdes_link_down = 0,
240 	e1000_serdes_link_autoneg_progress,
241 	e1000_serdes_link_autoneg_complete,
242 	e1000_serdes_link_forced_up
243 };
244 
245 /* Receive Descriptor - Extended */
246 union e1000_rx_desc_extended {
247 	struct {
248 		__le64 buffer_addr;
249 		__le64 reserved;
250 	} read;
251 	struct {
252 		struct {
253 			__le32 mrq;	      /* Multiple Rx Queues */
254 			union {
255 				__le32 rss;	    /* RSS Hash */
256 				struct {
257 					__le16 ip_id;  /* IP id */
258 					__le16 csum;   /* Packet Checksum */
259 				} csum_ip;
260 			} hi_dword;
261 		} lower;
262 		struct {
263 			__le32 status_error;     /* ext status/error */
264 			__le16 length;
265 			__le16 vlan;	     /* VLAN tag */
266 		} upper;
267 	} wb;  /* writeback */
268 };
269 
270 #define MAX_PS_BUFFERS 4
271 
272 /* Number of packet split data buffers (not including the header buffer) */
273 #define PS_PAGE_BUFFERS	(MAX_PS_BUFFERS - 1)
274 
275 /* Receive Descriptor - Packet Split */
276 union e1000_rx_desc_packet_split {
277 	struct {
278 		/* one buffer for protocol header(s), three data buffers */
279 		__le64 buffer_addr[MAX_PS_BUFFERS];
280 	} read;
281 	struct {
282 		struct {
283 			__le32 mrq;	      /* Multiple Rx Queues */
284 			union {
285 				__le32 rss;	      /* RSS Hash */
286 				struct {
287 					__le16 ip_id;    /* IP id */
288 					__le16 csum;     /* Packet Checksum */
289 				} csum_ip;
290 			} hi_dword;
291 		} lower;
292 		struct {
293 			__le32 status_error;     /* ext status/error */
294 			__le16 length0;	  /* length of buffer 0 */
295 			__le16 vlan;	     /* VLAN tag */
296 		} middle;
297 		struct {
298 			__le16 header_status;
299 			/* length of buffers 1-3 */
300 			__le16 length[PS_PAGE_BUFFERS];
301 		} upper;
302 		__le64 reserved;
303 	} wb; /* writeback */
304 };
305 
306 /* Transmit Descriptor */
307 struct e1000_tx_desc {
308 	__le64 buffer_addr;      /* Address of the descriptor's data buffer */
309 	union {
310 		__le32 data;
311 		struct {
312 			__le16 length;    /* Data buffer length */
313 			u8 cso;	/* Checksum offset */
314 			u8 cmd;	/* Descriptor control */
315 		} flags;
316 	} lower;
317 	union {
318 		__le32 data;
319 		struct {
320 			u8 status;     /* Descriptor status */
321 			u8 css;	/* Checksum start */
322 			__le16 special;
323 		} fields;
324 	} upper;
325 };
326 
327 /* Offload Context Descriptor */
328 struct e1000_context_desc {
329 	union {
330 		__le32 ip_config;
331 		struct {
332 			u8 ipcss;      /* IP checksum start */
333 			u8 ipcso;      /* IP checksum offset */
334 			__le16 ipcse;     /* IP checksum end */
335 		} ip_fields;
336 	} lower_setup;
337 	union {
338 		__le32 tcp_config;
339 		struct {
340 			u8 tucss;      /* TCP checksum start */
341 			u8 tucso;      /* TCP checksum offset */
342 			__le16 tucse;     /* TCP checksum end */
343 		} tcp_fields;
344 	} upper_setup;
345 	__le32 cmd_and_length;
346 	union {
347 		__le32 data;
348 		struct {
349 			u8 status;     /* Descriptor status */
350 			u8 hdr_len;    /* Header length */
351 			__le16 mss;       /* Maximum segment size */
352 		} fields;
353 	} tcp_seg_setup;
354 };
355 
356 /* Offload data descriptor */
357 struct e1000_data_desc {
358 	__le64 buffer_addr;   /* Address of the descriptor's buffer address */
359 	union {
360 		__le32 data;
361 		struct {
362 			__le16 length;    /* Data buffer length */
363 			u8 typ_len_ext;
364 			u8 cmd;
365 		} flags;
366 	} lower;
367 	union {
368 		__le32 data;
369 		struct {
370 			u8 status;     /* Descriptor status */
371 			u8 popts;      /* Packet Options */
372 			__le16 special;
373 		} fields;
374 	} upper;
375 };
376 
377 /* Statistics counters collected by the MAC */
378 struct e1000_hw_stats {
379 	u64 crcerrs;
380 	u64 algnerrc;
381 	u64 symerrs;
382 	u64 rxerrc;
383 	u64 mpc;
384 	u64 scc;
385 	u64 ecol;
386 	u64 mcc;
387 	u64 latecol;
388 	u64 colc;
389 	u64 dc;
390 	u64 tncrs;
391 	u64 sec;
392 	u64 cexterr;
393 	u64 rlec;
394 	u64 xonrxc;
395 	u64 xontxc;
396 	u64 xoffrxc;
397 	u64 xofftxc;
398 	u64 fcruc;
399 	u64 prc64;
400 	u64 prc127;
401 	u64 prc255;
402 	u64 prc511;
403 	u64 prc1023;
404 	u64 prc1522;
405 	u64 gprc;
406 	u64 bprc;
407 	u64 mprc;
408 	u64 gptc;
409 	u64 gorc;
410 	u64 gotc;
411 	u64 rnbc;
412 	u64 ruc;
413 	u64 rfc;
414 	u64 roc;
415 	u64 rjc;
416 	u64 mgprc;
417 	u64 mgpdc;
418 	u64 mgptc;
419 	u64 tor;
420 	u64 tot;
421 	u64 tpr;
422 	u64 tpt;
423 	u64 ptc64;
424 	u64 ptc127;
425 	u64 ptc255;
426 	u64 ptc511;
427 	u64 ptc1023;
428 	u64 ptc1522;
429 	u64 mptc;
430 	u64 bptc;
431 	u64 tsctc;
432 	u64 tsctfc;
433 	u64 iac;
434 	u64 icrxptc;
435 	u64 icrxatc;
436 	u64 ictxptc;
437 	u64 ictxatc;
438 	u64 ictxqec;
439 	u64 ictxqmtc;
440 	u64 icrxdmtc;
441 	u64 icrxoc;
442 };
443 
444 struct e1000_phy_stats {
445 	u32 idle_errors;
446 	u32 receive_errors;
447 };
448 
449 struct e1000_host_mng_dhcp_cookie {
450 	u32 signature;
451 	u8 status;
452 	u8 reserved0;
453 	u16 vlan_id;
454 	u32 reserved1;
455 	u16 reserved2;
456 	u8 reserved3;
457 	u8 checksum;
458 };
459 
460 /* Host Interface "Rev 1" */
461 struct e1000_host_command_header {
462 	u8 command_id;
463 	u8 command_length;
464 	u8 command_options;
465 	u8 checksum;
466 };
467 
468 #define E1000_HI_MAX_DATA_LENGTH	252
469 struct e1000_host_command_info {
470 	struct e1000_host_command_header command_header;
471 	u8 command_data[E1000_HI_MAX_DATA_LENGTH];
472 };
473 
474 /* Host Interface "Rev 2" */
475 struct e1000_host_mng_command_header {
476 	u8 command_id;
477 	u8 checksum;
478 	u16 reserved1;
479 	u16 reserved2;
480 	u16 command_length;
481 };
482 
483 #define E1000_HI_MAX_MNG_DATA_LENGTH	0x6F8
484 struct e1000_host_mng_command_info {
485 	struct e1000_host_mng_command_header command_header;
486 	u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
487 };
488 
489 #include "mac.h"
490 #include "phy.h"
491 #include "nvm.h"
492 #include "manage.h"
493 
494 /* Function pointers for the MAC. */
495 struct e1000_mac_operations {
496 	s32  (*id_led_init)(struct e1000_hw *);
497 	s32  (*blink_led)(struct e1000_hw *);
498 	bool (*check_mng_mode)(struct e1000_hw *);
499 	s32  (*check_for_link)(struct e1000_hw *);
500 	s32  (*cleanup_led)(struct e1000_hw *);
501 	void (*clear_hw_cntrs)(struct e1000_hw *);
502 	void (*clear_vfta)(struct e1000_hw *);
503 	s32  (*get_bus_info)(struct e1000_hw *);
504 	void (*set_lan_id)(struct e1000_hw *);
505 	s32  (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
506 	s32  (*led_on)(struct e1000_hw *);
507 	s32  (*led_off)(struct e1000_hw *);
508 	void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32);
509 	s32  (*reset_hw)(struct e1000_hw *);
510 	s32  (*init_hw)(struct e1000_hw *);
511 	s32  (*setup_link)(struct e1000_hw *);
512 	s32  (*setup_physical_interface)(struct e1000_hw *);
513 	s32  (*setup_led)(struct e1000_hw *);
514 	void (*write_vfta)(struct e1000_hw *, u32, u32);
515 	void (*config_collision_dist)(struct e1000_hw *);
516 	int  (*rar_set)(struct e1000_hw *, u8 *, u32);
517 	s32  (*read_mac_addr)(struct e1000_hw *);
518 	u32  (*rar_get_count)(struct e1000_hw *);
519 };
520 
521 /* When to use various PHY register access functions:
522  *
523  *                 Func   Caller
524  *   Function      Does   Does    When to use
525  *   ~~~~~~~~~~~~  ~~~~~  ~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
526  *   X_reg         L,P,A  n/a     for simple PHY reg accesses
527  *   X_reg_locked  P,A    L       for multiple accesses of different regs
528  *                                on different pages
529  *   X_reg_page    A      L,P     for multiple accesses of different regs
530  *                                on the same page
531  *
532  * Where X=[read|write], L=locking, P=sets page, A=register access
533  *
534  */
535 struct e1000_phy_operations {
536 	s32  (*acquire)(struct e1000_hw *);
537 	s32  (*cfg_on_link_up)(struct e1000_hw *);
538 	s32  (*check_polarity)(struct e1000_hw *);
539 	s32  (*check_reset_block)(struct e1000_hw *);
540 	s32  (*commit)(struct e1000_hw *);
541 	s32  (*force_speed_duplex)(struct e1000_hw *);
542 	s32  (*get_cfg_done)(struct e1000_hw *hw);
543 	s32  (*get_cable_length)(struct e1000_hw *);
544 	s32  (*get_info)(struct e1000_hw *);
545 	s32  (*set_page)(struct e1000_hw *, u16);
546 	s32  (*read_reg)(struct e1000_hw *, u32, u16 *);
547 	s32  (*read_reg_locked)(struct e1000_hw *, u32, u16 *);
548 	s32  (*read_reg_page)(struct e1000_hw *, u32, u16 *);
549 	void (*release)(struct e1000_hw *);
550 	s32  (*reset)(struct e1000_hw *);
551 	s32  (*set_d0_lplu_state)(struct e1000_hw *, bool);
552 	s32  (*set_d3_lplu_state)(struct e1000_hw *, bool);
553 	s32  (*write_reg)(struct e1000_hw *, u32, u16);
554 	s32  (*write_reg_locked)(struct e1000_hw *, u32, u16);
555 	s32  (*write_reg_page)(struct e1000_hw *, u32, u16);
556 	void (*power_up)(struct e1000_hw *);
557 	void (*power_down)(struct e1000_hw *);
558 };
559 
560 /* Function pointers for the NVM. */
561 struct e1000_nvm_operations {
562 	s32  (*acquire)(struct e1000_hw *);
563 	s32  (*read)(struct e1000_hw *, u16, u16, u16 *);
564 	void (*release)(struct e1000_hw *);
565 	void (*reload)(struct e1000_hw *);
566 	s32  (*update)(struct e1000_hw *);
567 	s32  (*valid_led_default)(struct e1000_hw *, u16 *);
568 	s32  (*validate)(struct e1000_hw *);
569 	s32  (*write)(struct e1000_hw *, u16, u16, u16 *);
570 };
571 
572 struct e1000_mac_info {
573 	struct e1000_mac_operations ops;
574 	u8 addr[ETH_ALEN];
575 	u8 perm_addr[ETH_ALEN];
576 
577 	enum e1000_mac_type type;
578 
579 	u32 collision_delta;
580 	u32 ledctl_default;
581 	u32 ledctl_mode1;
582 	u32 ledctl_mode2;
583 	u32 mc_filter_type;
584 	u32 tx_packet_delta;
585 	u32 txcw;
586 
587 	u16 current_ifs_val;
588 	u16 ifs_max_val;
589 	u16 ifs_min_val;
590 	u16 ifs_ratio;
591 	u16 ifs_step_size;
592 	u16 mta_reg_count;
593 
594 	/* Maximum size of the MTA register table in all supported adapters */
595 #define MAX_MTA_REG 128
596 	u32 mta_shadow[MAX_MTA_REG];
597 	u16 rar_entry_count;
598 
599 	u8 forced_speed_duplex;
600 
601 	bool adaptive_ifs;
602 	bool has_fwsm;
603 	bool arc_subsystem_valid;
604 	bool autoneg;
605 	bool autoneg_failed;
606 	bool get_link_status;
607 	bool in_ifs_mode;
608 	bool serdes_has_link;
609 	bool tx_pkt_filtering;
610 	enum e1000_serdes_link_state serdes_link_state;
611 };
612 
613 struct e1000_phy_info {
614 	struct e1000_phy_operations ops;
615 
616 	enum e1000_phy_type type;
617 
618 	enum e1000_1000t_rx_status local_rx;
619 	enum e1000_1000t_rx_status remote_rx;
620 	enum e1000_ms_type ms_type;
621 	enum e1000_ms_type original_ms_type;
622 	enum e1000_rev_polarity cable_polarity;
623 	enum e1000_smart_speed smart_speed;
624 
625 	u32 addr;
626 	u32 id;
627 	u32 reset_delay_us;	/* in usec */
628 	u32 revision;
629 	u32 retry_count;
630 
631 	enum e1000_media_type media_type;
632 
633 	u16 autoneg_advertised;
634 	u16 autoneg_mask;
635 	u16 cable_length;
636 	u16 max_cable_length;
637 	u16 min_cable_length;
638 
639 	u8 mdix;
640 
641 	bool disable_polarity_correction;
642 	bool is_mdix;
643 	bool polarity_correction;
644 	bool speed_downgraded;
645 	bool autoneg_wait_to_complete;
646 	bool retry_enabled;
647 };
648 
649 struct e1000_nvm_info {
650 	struct e1000_nvm_operations ops;
651 
652 	enum e1000_nvm_type type;
653 	enum e1000_nvm_override override;
654 
655 	u32 flash_bank_size;
656 	u32 flash_base_addr;
657 
658 	u16 word_size;
659 	u16 delay_usec;
660 	u16 address_bits;
661 	u16 opcode_bits;
662 	u16 page_size;
663 };
664 
665 struct e1000_bus_info {
666 	enum e1000_bus_width width;
667 
668 	u16 func;
669 };
670 
671 struct e1000_fc_info {
672 	u32 high_water;          /* Flow control high-water mark */
673 	u32 low_water;           /* Flow control low-water mark */
674 	u16 pause_time;          /* Flow control pause timer */
675 	u16 refresh_time;        /* Flow control refresh timer */
676 	bool send_xon;           /* Flow control send XON */
677 	bool strict_ieee;        /* Strict IEEE mode */
678 	enum e1000_fc_mode current_mode; /* FC mode in effect */
679 	enum e1000_fc_mode requested_mode; /* FC mode requested by caller */
680 };
681 
682 struct e1000_dev_spec_82571 {
683 	bool laa_is_present;
684 	u32 smb_counter;
685 };
686 
687 struct e1000_dev_spec_80003es2lan {
688 	bool mdic_wa_enable;
689 };
690 
691 struct e1000_shadow_ram {
692 	u16 value;
693 	bool modified;
694 };
695 
696 #define E1000_ICH8_SHADOW_RAM_WORDS		2048
697 
698 /* I218 PHY Ultra Low Power (ULP) states */
699 enum e1000_ulp_state {
700 	e1000_ulp_state_unknown,
701 	e1000_ulp_state_off,
702 	e1000_ulp_state_on,
703 };
704 
705 struct e1000_dev_spec_ich8lan {
706 	bool kmrn_lock_loss_workaround_enabled;
707 	struct e1000_shadow_ram shadow_ram[E1000_ICH8_SHADOW_RAM_WORDS];
708 	bool nvm_k1_enabled;
709 	bool eee_disable;
710 	u16 eee_lp_ability;
711 	enum e1000_ulp_state ulp_state;
712 };
713 
714 struct e1000_hw {
715 	struct e1000_adapter *adapter;
716 
717 	void __iomem *hw_addr;
718 	void __iomem *flash_address;
719 
720 	struct e1000_mac_info mac;
721 	struct e1000_fc_info fc;
722 	struct e1000_phy_info phy;
723 	struct e1000_nvm_info nvm;
724 	struct e1000_bus_info bus;
725 	struct e1000_host_mng_dhcp_cookie mng_cookie;
726 
727 	union {
728 		struct e1000_dev_spec_82571 e82571;
729 		struct e1000_dev_spec_80003es2lan e80003es2lan;
730 		struct e1000_dev_spec_ich8lan ich8lan;
731 	} dev_spec;
732 };
733 
734 #include "82571.h"
735 #include "80003es2lan.h"
736 #include "ich8lan.h"
737 
738 #endif /* _E1000E_HW_H_ */
739