blob: 66bd5060a65b2bd9c6453583a0db67efcb6080f1 [file] [log] [blame]
David Ertmane78b80b2014-02-04 01:56:06 +00001/* Intel PRO/1000 Linux driver
Yanir Lubetkin529498c2015-06-02 17:05:50 +03002 * Copyright(c) 1999 - 2015 Intel Corporation.
David Ertmane78b80b2014-02-04 01:56:06 +00003 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
15 *
16 * Contact Information:
17 * Linux NICS <linux.nics@intel.com>
18 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
19 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
20 */
Auke Kokbc7f75f2007-09-17 12:30:59 -070021
22#ifndef _E1000_HW_H_
23#define _E1000_HW_H_
24
Bruce Allanc556d602013-02-05 00:30:59 -080025#include "regs.h"
Bruce Allana9bb6292013-01-12 07:26:22 +000026#include "defines.h"
Auke Kokbc7f75f2007-09-17 12:30:59 -070027
28struct e1000_hw;
Auke Kokbc7f75f2007-09-17 12:30:59 -070029
Auke Kokbc7f75f2007-09-17 12:30:59 -070030#define E1000_DEV_ID_82571EB_COPPER 0x105E
31#define E1000_DEV_ID_82571EB_FIBER 0x105F
32#define E1000_DEV_ID_82571EB_SERDES 0x1060
33#define E1000_DEV_ID_82571EB_QUAD_COPPER 0x10A4
Auke Kok040babf2007-10-31 15:22:05 -070034#define E1000_DEV_ID_82571PT_QUAD_COPPER 0x10D5
Auke Kokbc7f75f2007-09-17 12:30:59 -070035#define E1000_DEV_ID_82571EB_QUAD_FIBER 0x10A5
36#define E1000_DEV_ID_82571EB_QUAD_COPPER_LP 0x10BC
Auke Kok040babf2007-10-31 15:22:05 -070037#define E1000_DEV_ID_82571EB_SERDES_DUAL 0x10D9
38#define E1000_DEV_ID_82571EB_SERDES_QUAD 0x10DA
Auke Kokbc7f75f2007-09-17 12:30:59 -070039#define E1000_DEV_ID_82572EI_COPPER 0x107D
40#define E1000_DEV_ID_82572EI_FIBER 0x107E
41#define E1000_DEV_ID_82572EI_SERDES 0x107F
42#define E1000_DEV_ID_82572EI 0x10B9
43#define E1000_DEV_ID_82573E 0x108B
44#define E1000_DEV_ID_82573E_IAMT 0x108C
45#define E1000_DEV_ID_82573L 0x109A
Bruce Allan4662e822008-08-26 18:37:06 -070046#define E1000_DEV_ID_82574L 0x10D3
Bruce Allanbef28b12009-03-24 23:28:02 -070047#define E1000_DEV_ID_82574LA 0x10F6
Bruce Allana9bb6292013-01-12 07:26:22 +000048#define E1000_DEV_ID_82583V 0x150C
Auke Kokbc7f75f2007-09-17 12:30:59 -070049#define E1000_DEV_ID_80003ES2LAN_COPPER_DPT 0x1096
50#define E1000_DEV_ID_80003ES2LAN_SERDES_DPT 0x1098
51#define E1000_DEV_ID_80003ES2LAN_COPPER_SPT 0x10BA
52#define E1000_DEV_ID_80003ES2LAN_SERDES_SPT 0x10BB
Bruce Allan9e135a22009-12-01 15:50:31 +000053#define E1000_DEV_ID_ICH8_82567V_3 0x1501
Auke Kokbc7f75f2007-09-17 12:30:59 -070054#define E1000_DEV_ID_ICH8_IGP_M_AMT 0x1049
55#define E1000_DEV_ID_ICH8_IGP_AMT 0x104A
56#define E1000_DEV_ID_ICH8_IGP_C 0x104B
57#define E1000_DEV_ID_ICH8_IFE 0x104C
58#define E1000_DEV_ID_ICH8_IFE_GT 0x10C4
59#define E1000_DEV_ID_ICH8_IFE_G 0x10C5
60#define E1000_DEV_ID_ICH8_IGP_M 0x104D
61#define E1000_DEV_ID_ICH9_IGP_AMT 0x10BD
Bruce Allan2f15f9d2008-08-26 18:36:36 -070062#define E1000_DEV_ID_ICH9_BM 0x10E5
Bruce Allan97ac8ca2008-04-29 09:16:05 -070063#define E1000_DEV_ID_ICH9_IGP_M_AMT 0x10F5
64#define E1000_DEV_ID_ICH9_IGP_M 0x10BF
65#define E1000_DEV_ID_ICH9_IGP_M_V 0x10CB
Auke Kokbc7f75f2007-09-17 12:30:59 -070066#define E1000_DEV_ID_ICH9_IGP_C 0x294C
67#define E1000_DEV_ID_ICH9_IFE 0x10C0
68#define E1000_DEV_ID_ICH9_IFE_GT 0x10C3
69#define E1000_DEV_ID_ICH9_IFE_G 0x10C2
Bruce Allan97ac8ca2008-04-29 09:16:05 -070070#define E1000_DEV_ID_ICH10_R_BM_LM 0x10CC
71#define E1000_DEV_ID_ICH10_R_BM_LF 0x10CD
72#define E1000_DEV_ID_ICH10_R_BM_V 0x10CE
Bruce Allanf4187b52008-08-26 18:36:50 -070073#define E1000_DEV_ID_ICH10_D_BM_LM 0x10DE
74#define E1000_DEV_ID_ICH10_D_BM_LF 0x10DF
Bruce Allan10df0b92010-05-10 15:02:52 +000075#define E1000_DEV_ID_ICH10_D_BM_V 0x1525
Bruce Allana4f58f52009-06-02 11:29:18 +000076#define E1000_DEV_ID_PCH_M_HV_LM 0x10EA
77#define E1000_DEV_ID_PCH_M_HV_LC 0x10EB
78#define E1000_DEV_ID_PCH_D_HV_DM 0x10EF
79#define E1000_DEV_ID_PCH_D_HV_DC 0x10F0
Bruce Alland3738bb2010-06-16 13:27:28 +000080#define E1000_DEV_ID_PCH2_LV_LM 0x1502
81#define E1000_DEV_ID_PCH2_LV_V 0x1503
Bruce Allan2fbe4522012-04-19 03:21:47 +000082#define E1000_DEV_ID_PCH_LPT_I217_LM 0x153A
83#define E1000_DEV_ID_PCH_LPT_I217_V 0x153B
Bruce Allan16e310a2012-10-09 01:11:26 +000084#define E1000_DEV_ID_PCH_LPTLP_I218_LM 0x155A
85#define E1000_DEV_ID_PCH_LPTLP_I218_V 0x1559
Bruce Allan91a3d822013-06-29 01:15:16 +000086#define E1000_DEV_ID_PCH_I218_LM2 0x15A0
87#define E1000_DEV_ID_PCH_I218_V2 0x15A1
88#define E1000_DEV_ID_PCH_I218_LM3 0x15A2 /* Wildcat Point PCH */
89#define E1000_DEV_ID_PCH_I218_V3 0x15A3 /* Wildcat Point PCH */
David Ertman79849eb2015-02-10 09:10:43 +000090#define E1000_DEV_ID_PCH_SPT_I219_LM 0x156F /* SPT PCH */
91#define E1000_DEV_ID_PCH_SPT_I219_V 0x1570 /* SPT PCH */
92#define E1000_DEV_ID_PCH_SPT_I219_LM2 0x15B7 /* SPT-H PCH */
93#define E1000_DEV_ID_PCH_SPT_I219_V2 0x15B8 /* SPT-H PCH */
Raanan Avargilf3ed9352015-10-20 17:13:01 +030094#define E1000_DEV_ID_PCH_LBG_I219_LM3 0x15B9 /* LBG PCH */
Raanan Avargil9cd34b32015-12-22 15:35:05 +020095#define E1000_DEV_ID_PCH_SPT_I219_LM4 0x15D7
96#define E1000_DEV_ID_PCH_SPT_I219_V4 0x15D8
97#define E1000_DEV_ID_PCH_SPT_I219_LM5 0x15E3
98#define E1000_DEV_ID_PCH_SPT_I219_V5 0x15D6
Sasha Neftin3a3173b2017-04-06 10:26:32 +030099#define E1000_DEV_ID_PCH_CNP_I219_LM6 0x15BD
100#define E1000_DEV_ID_PCH_CNP_I219_V6 0x15BE
101#define E1000_DEV_ID_PCH_CNP_I219_LM7 0x15BB
102#define E1000_DEV_ID_PCH_CNP_I219_V7 0x15BC
Auke Kokbc7f75f2007-09-17 12:30:59 -0700103
Bruce Allana9bb6292013-01-12 07:26:22 +0000104#define E1000_REVISION_4 4
Bruce Allan4662e822008-08-26 18:37:06 -0700105
Bruce Allana9bb6292013-01-12 07:26:22 +0000106#define E1000_FUNC_1 1
Auke Kokbc7f75f2007-09-17 12:30:59 -0700107
Bruce Allana9bb6292013-01-12 07:26:22 +0000108#define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0 0
109#define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1 3
Bruce Allan608f8a02010-01-13 02:04:58 +0000110
Auke Kokbc7f75f2007-09-17 12:30:59 -0700111enum e1000_mac_type {
112 e1000_82571,
113 e1000_82572,
114 e1000_82573,
Bruce Allan4662e822008-08-26 18:37:06 -0700115 e1000_82574,
Alexander Duyck8c81c9c2009-03-19 01:12:27 +0000116 e1000_82583,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700117 e1000_80003es2lan,
118 e1000_ich8lan,
119 e1000_ich9lan,
Bruce Allanf4187b52008-08-26 18:36:50 -0700120 e1000_ich10lan,
Bruce Allana4f58f52009-06-02 11:29:18 +0000121 e1000_pchlan,
Bruce Alland3738bb2010-06-16 13:27:28 +0000122 e1000_pch2lan,
Bruce Allan2fbe4522012-04-19 03:21:47 +0000123 e1000_pch_lpt,
David Ertman79849eb2015-02-10 09:10:43 +0000124 e1000_pch_spt,
Sasha Neftin3a3173b2017-04-06 10:26:32 +0300125 e1000_pch_cnp,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700126};
127
128enum e1000_media_type {
129 e1000_media_type_unknown = 0,
130 e1000_media_type_copper = 1,
131 e1000_media_type_fiber = 2,
132 e1000_media_type_internal_serdes = 3,
133 e1000_num_media_types
134};
135
136enum e1000_nvm_type {
137 e1000_nvm_unknown = 0,
138 e1000_nvm_none,
139 e1000_nvm_eeprom_spi,
140 e1000_nvm_flash_hw,
141 e1000_nvm_flash_sw
142};
143
144enum e1000_nvm_override {
145 e1000_nvm_override_none = 0,
146 e1000_nvm_override_spi_small,
147 e1000_nvm_override_spi_large
148};
149
150enum e1000_phy_type {
151 e1000_phy_unknown = 0,
152 e1000_phy_none,
153 e1000_phy_m88,
154 e1000_phy_igp,
155 e1000_phy_igp_2,
156 e1000_phy_gg82563,
157 e1000_phy_igp_3,
158 e1000_phy_ife,
Bruce Allan97ac8ca2008-04-29 09:16:05 -0700159 e1000_phy_bm,
Bruce Allana4f58f52009-06-02 11:29:18 +0000160 e1000_phy_82578,
161 e1000_phy_82577,
Bruce Alland3738bb2010-06-16 13:27:28 +0000162 e1000_phy_82579,
Bruce Allan2fbe4522012-04-19 03:21:47 +0000163 e1000_phy_i217,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700164};
165
166enum e1000_bus_width {
167 e1000_bus_width_unknown = 0,
168 e1000_bus_width_pcie_x1,
169 e1000_bus_width_pcie_x2,
170 e1000_bus_width_pcie_x4 = 4,
David Ertman79849eb2015-02-10 09:10:43 +0000171 e1000_bus_width_pcie_x8 = 8,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700172 e1000_bus_width_32,
173 e1000_bus_width_64,
174 e1000_bus_width_reserved
175};
176
177enum e1000_1000t_rx_status {
178 e1000_1000t_rx_status_not_ok = 0,
179 e1000_1000t_rx_status_ok,
180 e1000_1000t_rx_status_undefined = 0xFF
181};
182
Bruce Allan362e20c2013-02-20 04:05:45 +0000183enum e1000_rev_polarity {
Auke Kokbc7f75f2007-09-17 12:30:59 -0700184 e1000_rev_polarity_normal = 0,
185 e1000_rev_polarity_reversed,
186 e1000_rev_polarity_undefined = 0xFF
187};
188
Bruce Allan5c48ef3e22008-11-21 16:57:36 -0800189enum e1000_fc_mode {
Auke Kokbc7f75f2007-09-17 12:30:59 -0700190 e1000_fc_none = 0,
191 e1000_fc_rx_pause,
192 e1000_fc_tx_pause,
193 e1000_fc_full,
194 e1000_fc_default = 0xFF
195};
196
197enum e1000_ms_type {
198 e1000_ms_hw_default = 0,
199 e1000_ms_force_master,
200 e1000_ms_force_slave,
201 e1000_ms_auto
202};
203
204enum e1000_smart_speed {
205 e1000_smart_speed_default = 0,
206 e1000_smart_speed_on,
207 e1000_smart_speed_off
208};
209
dave grahamc9523372009-02-10 12:52:28 +0000210enum e1000_serdes_link_state {
211 e1000_serdes_link_down = 0,
212 e1000_serdes_link_autoneg_progress,
213 e1000_serdes_link_autoneg_complete,
214 e1000_serdes_link_forced_up
215};
216
Auke Kokbc7f75f2007-09-17 12:30:59 -0700217/* Receive Descriptor - Extended */
218union e1000_rx_desc_extended {
219 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000220 __le64 buffer_addr;
221 __le64 reserved;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700222 } read;
223 struct {
224 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000225 __le32 mrq; /* Multiple Rx Queues */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700226 union {
Al Viroa39fe742007-12-11 19:50:34 +0000227 __le32 rss; /* RSS Hash */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700228 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000229 __le16 ip_id; /* IP id */
230 __le16 csum; /* Packet Checksum */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700231 } csum_ip;
232 } hi_dword;
233 } lower;
234 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000235 __le32 status_error; /* ext status/error */
236 __le16 length;
237 __le16 vlan; /* VLAN tag */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700238 } upper;
239 } wb; /* writeback */
240};
241
242#define MAX_PS_BUFFERS 4
Wei Yangc96ddb02013-05-25 06:23:45 +0000243
244/* Number of packet split data buffers (not including the header buffer) */
Bruce Allan0cf04592013-08-02 03:33:32 +0000245#define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 1)
246
Auke Kokbc7f75f2007-09-17 12:30:59 -0700247/* Receive Descriptor - Packet Split */
248union e1000_rx_desc_packet_split {
249 struct {
250 /* one buffer for protocol header(s), three data buffers */
Al Viroa39fe742007-12-11 19:50:34 +0000251 __le64 buffer_addr[MAX_PS_BUFFERS];
Auke Kokbc7f75f2007-09-17 12:30:59 -0700252 } read;
253 struct {
254 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000255 __le32 mrq; /* Multiple Rx Queues */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700256 union {
Al Viroa39fe742007-12-11 19:50:34 +0000257 __le32 rss; /* RSS Hash */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700258 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000259 __le16 ip_id; /* IP id */
260 __le16 csum; /* Packet Checksum */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700261 } csum_ip;
262 } hi_dword;
263 } lower;
264 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000265 __le32 status_error; /* ext status/error */
266 __le16 length0; /* length of buffer 0 */
267 __le16 vlan; /* VLAN tag */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700268 } middle;
269 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000270 __le16 header_status;
Wei Yangc96ddb02013-05-25 06:23:45 +0000271 /* length of buffers 1-3 */
272 __le16 length[PS_PAGE_BUFFERS];
Auke Kokbc7f75f2007-09-17 12:30:59 -0700273 } upper;
Al Viroa39fe742007-12-11 19:50:34 +0000274 __le64 reserved;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700275 } wb; /* writeback */
276};
277
278/* Transmit Descriptor */
279struct e1000_tx_desc {
Al Viroa39fe742007-12-11 19:50:34 +0000280 __le64 buffer_addr; /* Address of the descriptor's data buffer */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700281 union {
Al Viroa39fe742007-12-11 19:50:34 +0000282 __le32 data;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700283 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000284 __le16 length; /* Data buffer length */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700285 u8 cso; /* Checksum offset */
286 u8 cmd; /* Descriptor control */
287 } flags;
288 } lower;
289 union {
Al Viroa39fe742007-12-11 19:50:34 +0000290 __le32 data;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700291 struct {
292 u8 status; /* Descriptor status */
293 u8 css; /* Checksum start */
Al Viroa39fe742007-12-11 19:50:34 +0000294 __le16 special;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700295 } fields;
296 } upper;
297};
298
299/* Offload Context Descriptor */
300struct e1000_context_desc {
301 union {
Al Viroa39fe742007-12-11 19:50:34 +0000302 __le32 ip_config;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700303 struct {
304 u8 ipcss; /* IP checksum start */
305 u8 ipcso; /* IP checksum offset */
Al Viroa39fe742007-12-11 19:50:34 +0000306 __le16 ipcse; /* IP checksum end */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700307 } ip_fields;
308 } lower_setup;
309 union {
Al Viroa39fe742007-12-11 19:50:34 +0000310 __le32 tcp_config;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700311 struct {
312 u8 tucss; /* TCP checksum start */
313 u8 tucso; /* TCP checksum offset */
Al Viroa39fe742007-12-11 19:50:34 +0000314 __le16 tucse; /* TCP checksum end */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700315 } tcp_fields;
316 } upper_setup;
Al Viroa39fe742007-12-11 19:50:34 +0000317 __le32 cmd_and_length;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700318 union {
Al Viroa39fe742007-12-11 19:50:34 +0000319 __le32 data;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700320 struct {
321 u8 status; /* Descriptor status */
322 u8 hdr_len; /* Header length */
Al Viroa39fe742007-12-11 19:50:34 +0000323 __le16 mss; /* Maximum segment size */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700324 } fields;
325 } tcp_seg_setup;
326};
327
328/* Offload data descriptor */
329struct e1000_data_desc {
Al Viroa39fe742007-12-11 19:50:34 +0000330 __le64 buffer_addr; /* Address of the descriptor's buffer address */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700331 union {
Al Viroa39fe742007-12-11 19:50:34 +0000332 __le32 data;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700333 struct {
Al Viroa39fe742007-12-11 19:50:34 +0000334 __le16 length; /* Data buffer length */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700335 u8 typ_len_ext;
336 u8 cmd;
337 } flags;
338 } lower;
339 union {
Al Viroa39fe742007-12-11 19:50:34 +0000340 __le32 data;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700341 struct {
342 u8 status; /* Descriptor status */
343 u8 popts; /* Packet Options */
Bruce Allana9bb6292013-01-12 07:26:22 +0000344 __le16 special;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700345 } fields;
346 } upper;
347};
348
349/* Statistics counters collected by the MAC */
350struct e1000_hw_stats {
351 u64 crcerrs;
352 u64 algnerrc;
353 u64 symerrs;
354 u64 rxerrc;
355 u64 mpc;
356 u64 scc;
357 u64 ecol;
358 u64 mcc;
359 u64 latecol;
360 u64 colc;
361 u64 dc;
362 u64 tncrs;
363 u64 sec;
364 u64 cexterr;
365 u64 rlec;
366 u64 xonrxc;
367 u64 xontxc;
368 u64 xoffrxc;
369 u64 xofftxc;
370 u64 fcruc;
371 u64 prc64;
372 u64 prc127;
373 u64 prc255;
374 u64 prc511;
375 u64 prc1023;
376 u64 prc1522;
377 u64 gprc;
378 u64 bprc;
379 u64 mprc;
380 u64 gptc;
Bruce Allan7c257692008-04-23 11:09:00 -0700381 u64 gorc;
382 u64 gotc;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700383 u64 rnbc;
384 u64 ruc;
385 u64 rfc;
386 u64 roc;
387 u64 rjc;
388 u64 mgprc;
389 u64 mgpdc;
390 u64 mgptc;
Bruce Allan7c257692008-04-23 11:09:00 -0700391 u64 tor;
392 u64 tot;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700393 u64 tpr;
394 u64 tpt;
395 u64 ptc64;
396 u64 ptc127;
397 u64 ptc255;
398 u64 ptc511;
399 u64 ptc1023;
400 u64 ptc1522;
401 u64 mptc;
402 u64 bptc;
403 u64 tsctc;
404 u64 tsctfc;
405 u64 iac;
406 u64 icrxptc;
407 u64 icrxatc;
408 u64 ictxptc;
409 u64 ictxatc;
410 u64 ictxqec;
411 u64 ictxqmtc;
412 u64 icrxdmtc;
413 u64 icrxoc;
414};
415
416struct e1000_phy_stats {
417 u32 idle_errors;
418 u32 receive_errors;
419};
420
421struct e1000_host_mng_dhcp_cookie {
422 u32 signature;
Bruce Allane80bd1d2013-05-01 01:19:46 +0000423 u8 status;
424 u8 reserved0;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700425 u16 vlan_id;
426 u32 reserved1;
427 u16 reserved2;
Bruce Allane80bd1d2013-05-01 01:19:46 +0000428 u8 reserved3;
429 u8 checksum;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700430};
431
432/* Host Interface "Rev 1" */
433struct e1000_host_command_header {
434 u8 command_id;
435 u8 command_length;
436 u8 command_options;
437 u8 checksum;
438};
439
Bruce Allana9bb6292013-01-12 07:26:22 +0000440#define E1000_HI_MAX_DATA_LENGTH 252
Auke Kokbc7f75f2007-09-17 12:30:59 -0700441struct e1000_host_command_info {
442 struct e1000_host_command_header command_header;
443 u8 command_data[E1000_HI_MAX_DATA_LENGTH];
444};
445
446/* Host Interface "Rev 2" */
447struct e1000_host_mng_command_header {
Bruce Allane80bd1d2013-05-01 01:19:46 +0000448 u8 command_id;
449 u8 checksum;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700450 u16 reserved1;
451 u16 reserved2;
452 u16 command_length;
453};
454
Bruce Allana9bb6292013-01-12 07:26:22 +0000455#define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
Auke Kokbc7f75f2007-09-17 12:30:59 -0700456struct e1000_host_mng_command_info {
457 struct e1000_host_mng_command_header command_header;
458 u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
459};
460
Bruce Allanbdfe2da2013-01-22 08:44:19 +0000461#include "mac.h"
Bruce Allan93b9f8b2013-01-22 08:44:25 +0000462#include "phy.h"
Bruce Alland2263112013-01-22 08:44:30 +0000463#include "nvm.h"
Bruce Allan948f97a2013-01-22 08:44:35 +0000464#include "manage.h"
Bruce Allanbdfe2da2013-01-22 08:44:19 +0000465
Bruce Allana9bb6292013-01-12 07:26:22 +0000466/* Function pointers for the MAC. */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700467struct e1000_mac_operations {
Bruce Allana4f58f52009-06-02 11:29:18 +0000468 s32 (*id_led_init)(struct e1000_hw *);
Bruce Allandbf80dc2011-04-16 00:34:40 +0000469 s32 (*blink_led)(struct e1000_hw *);
Bruce Allan4662e822008-08-26 18:37:06 -0700470 bool (*check_mng_mode)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700471 s32 (*check_for_link)(struct e1000_hw *);
472 s32 (*cleanup_led)(struct e1000_hw *);
473 void (*clear_hw_cntrs)(struct e1000_hw *);
Bruce Allancaaddaf2009-12-01 15:46:43 +0000474 void (*clear_vfta)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700475 s32 (*get_bus_info)(struct e1000_hw *);
Bruce Allanf4d2dd42010-01-13 02:05:18 +0000476 void (*set_lan_id)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700477 s32 (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
478 s32 (*led_on)(struct e1000_hw *);
479 s32 (*led_off)(struct e1000_hw *);
Bruce Allanab8932f2010-01-13 02:05:38 +0000480 void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700481 s32 (*reset_hw)(struct e1000_hw *);
482 s32 (*init_hw)(struct e1000_hw *);
483 s32 (*setup_link)(struct e1000_hw *);
484 s32 (*setup_physical_interface)(struct e1000_hw *);
Bruce Allana4f58f52009-06-02 11:29:18 +0000485 s32 (*setup_led)(struct e1000_hw *);
Bruce Allancaaddaf2009-12-01 15:46:43 +0000486 void (*write_vfta)(struct e1000_hw *, u32, u32);
Bruce Allan57cde762012-02-22 09:02:58 +0000487 void (*config_collision_dist)(struct e1000_hw *);
David Ertmanb3e5bf12014-05-06 03:50:17 +0000488 int (*rar_set)(struct e1000_hw *, u8 *, u32);
Bruce Allan608f8a02010-01-13 02:04:58 +0000489 s32 (*read_mac_addr)(struct e1000_hw *);
David Ertmanb3e5bf12014-05-06 03:50:17 +0000490 u32 (*rar_get_count)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700491};
492
Bruce Allane921eb12012-11-28 09:28:37 +0000493/* When to use various PHY register access functions:
Bruce Allan2b6b1682011-05-13 07:20:09 +0000494 *
495 * Func Caller
496 * Function Does Does When to use
497 * ~~~~~~~~~~~~ ~~~~~ ~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
498 * X_reg L,P,A n/a for simple PHY reg accesses
499 * X_reg_locked P,A L for multiple accesses of different regs
500 * on different pages
501 * X_reg_page A L,P for multiple accesses of different regs
502 * on the same page
503 *
504 * Where X=[read|write], L=locking, P=sets page, A=register access
505 *
506 */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700507struct e1000_phy_operations {
Bruce Allan94d81862009-11-20 23:25:26 +0000508 s32 (*acquire)(struct e1000_hw *);
509 s32 (*cfg_on_link_up)(struct e1000_hw *);
Bruce Allana4f58f52009-06-02 11:29:18 +0000510 s32 (*check_polarity)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700511 s32 (*check_reset_block)(struct e1000_hw *);
Bruce Allan94d81862009-11-20 23:25:26 +0000512 s32 (*commit)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700513 s32 (*force_speed_duplex)(struct e1000_hw *);
514 s32 (*get_cfg_done)(struct e1000_hw *hw);
515 s32 (*get_cable_length)(struct e1000_hw *);
Bruce Allan94d81862009-11-20 23:25:26 +0000516 s32 (*get_info)(struct e1000_hw *);
Bruce Allan2b6b1682011-05-13 07:20:09 +0000517 s32 (*set_page)(struct e1000_hw *, u16);
Bruce Allan94d81862009-11-20 23:25:26 +0000518 s32 (*read_reg)(struct e1000_hw *, u32, u16 *);
519 s32 (*read_reg_locked)(struct e1000_hw *, u32, u16 *);
Bruce Allan2b6b1682011-05-13 07:20:09 +0000520 s32 (*read_reg_page)(struct e1000_hw *, u32, u16 *);
Bruce Allan94d81862009-11-20 23:25:26 +0000521 void (*release)(struct e1000_hw *);
522 s32 (*reset)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700523 s32 (*set_d0_lplu_state)(struct e1000_hw *, bool);
524 s32 (*set_d3_lplu_state)(struct e1000_hw *, bool);
Bruce Allan94d81862009-11-20 23:25:26 +0000525 s32 (*write_reg)(struct e1000_hw *, u32, u16);
526 s32 (*write_reg_locked)(struct e1000_hw *, u32, u16);
Bruce Allan2b6b1682011-05-13 07:20:09 +0000527 s32 (*write_reg_page)(struct e1000_hw *, u32, u16);
Bruce Allan17f208d2009-12-01 15:47:22 +0000528 void (*power_up)(struct e1000_hw *);
529 void (*power_down)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700530};
531
532/* Function pointers for the NVM. */
533struct e1000_nvm_operations {
Bruce Allan94d81862009-11-20 23:25:26 +0000534 s32 (*acquire)(struct e1000_hw *);
535 s32 (*read)(struct e1000_hw *, u16, u16, u16 *);
536 void (*release)(struct e1000_hw *);
Bruce Allane85e3632012-02-22 09:03:14 +0000537 void (*reload)(struct e1000_hw *);
Bruce Allan94d81862009-11-20 23:25:26 +0000538 s32 (*update)(struct e1000_hw *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700539 s32 (*valid_led_default)(struct e1000_hw *, u16 *);
Bruce Allan94d81862009-11-20 23:25:26 +0000540 s32 (*validate)(struct e1000_hw *);
541 s32 (*write)(struct e1000_hw *, u16, u16, u16 *);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700542};
543
544struct e1000_mac_info {
545 struct e1000_mac_operations ops;
Bruce Alland8d5f8a2011-02-25 07:09:37 +0000546 u8 addr[ETH_ALEN];
547 u8 perm_addr[ETH_ALEN];
Auke Kokbc7f75f2007-09-17 12:30:59 -0700548
549 enum e1000_mac_type type;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700550
551 u32 collision_delta;
552 u32 ledctl_default;
553 u32 ledctl_mode1;
554 u32 ledctl_mode2;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700555 u32 mc_filter_type;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700556 u32 tx_packet_delta;
557 u32 txcw;
558
559 u16 current_ifs_val;
560 u16 ifs_max_val;
561 u16 ifs_min_val;
562 u16 ifs_ratio;
563 u16 ifs_step_size;
564 u16 mta_reg_count;
Bruce Allanab8932f2010-01-13 02:05:38 +0000565
566 /* Maximum size of the MTA register table in all supported adapters */
Bruce Allanf0ff4392013-02-20 04:05:39 +0000567#define MAX_MTA_REG 128
Bruce Allanab8932f2010-01-13 02:05:38 +0000568 u32 mta_shadow[MAX_MTA_REG];
Auke Kokbc7f75f2007-09-17 12:30:59 -0700569 u16 rar_entry_count;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700570
Bruce Allane80bd1d2013-05-01 01:19:46 +0000571 u8 forced_speed_duplex;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700572
Bruce Allanf464ba82010-01-07 16:31:35 +0000573 bool adaptive_ifs;
Bruce Allana65a4a02010-05-10 15:01:51 +0000574 bool has_fwsm;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700575 bool arc_subsystem_valid;
576 bool autoneg;
577 bool autoneg_failed;
578 bool get_link_status;
579 bool in_ifs_mode;
580 bool serdes_has_link;
581 bool tx_pkt_filtering;
dave grahamc9523372009-02-10 12:52:28 +0000582 enum e1000_serdes_link_state serdes_link_state;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700583};
584
585struct e1000_phy_info {
586 struct e1000_phy_operations ops;
587
588 enum e1000_phy_type type;
589
590 enum e1000_1000t_rx_status local_rx;
591 enum e1000_1000t_rx_status remote_rx;
592 enum e1000_ms_type ms_type;
593 enum e1000_ms_type original_ms_type;
594 enum e1000_rev_polarity cable_polarity;
595 enum e1000_smart_speed smart_speed;
596
597 u32 addr;
598 u32 id;
Bruce Allane80bd1d2013-05-01 01:19:46 +0000599 u32 reset_delay_us; /* in usec */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700600 u32 revision;
601
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700602 enum e1000_media_type media_type;
603
Auke Kokbc7f75f2007-09-17 12:30:59 -0700604 u16 autoneg_advertised;
605 u16 autoneg_mask;
606 u16 cable_length;
607 u16 max_cable_length;
608 u16 min_cable_length;
609
610 u8 mdix;
611
612 bool disable_polarity_correction;
613 bool is_mdix;
614 bool polarity_correction;
615 bool speed_downgraded;
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700616 bool autoneg_wait_to_complete;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700617};
618
619struct e1000_nvm_info {
620 struct e1000_nvm_operations ops;
621
622 enum e1000_nvm_type type;
623 enum e1000_nvm_override override;
624
625 u32 flash_bank_size;
626 u32 flash_base_addr;
627
628 u16 word_size;
629 u16 delay_usec;
630 u16 address_bits;
631 u16 opcode_bits;
632 u16 page_size;
633};
634
635struct e1000_bus_info {
636 enum e1000_bus_width width;
637
638 u16 func;
639};
640
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700641struct e1000_fc_info {
642 u32 high_water; /* Flow control high-water mark */
643 u32 low_water; /* Flow control low-water mark */
644 u16 pause_time; /* Flow control pause timer */
Bruce Allana3055952010-05-10 15:02:12 +0000645 u16 refresh_time; /* Flow control refresh timer */
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700646 bool send_xon; /* Flow control send XON */
647 bool strict_ieee; /* Strict IEEE mode */
Bruce Allan5c48ef3e22008-11-21 16:57:36 -0800648 enum e1000_fc_mode current_mode; /* FC mode in effect */
649 enum e1000_fc_mode requested_mode; /* FC mode requested by caller */
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700650};
651
Auke Kokbc7f75f2007-09-17 12:30:59 -0700652struct e1000_dev_spec_82571 {
653 bool laa_is_present;
Dave Graham23a2d1b2009-06-08 14:28:17 +0000654 u32 smb_counter;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700655};
656
Bruce Allan3421eec2009-12-08 07:28:20 +0000657struct e1000_dev_spec_80003es2lan {
Bruce Allane80bd1d2013-05-01 01:19:46 +0000658 bool mdic_wa_enable;
Bruce Allan3421eec2009-12-08 07:28:20 +0000659};
660
Auke Kokbc7f75f2007-09-17 12:30:59 -0700661struct e1000_shadow_ram {
Bruce Allane80bd1d2013-05-01 01:19:46 +0000662 u16 value;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700663 bool modified;
664};
665
666#define E1000_ICH8_SHADOW_RAM_WORDS 2048
667
David Ertman74f350e2014-02-22 03:15:17 +0000668/* I218 PHY Ultra Low Power (ULP) states */
669enum e1000_ulp_state {
670 e1000_ulp_state_unknown,
671 e1000_ulp_state_off,
672 e1000_ulp_state_on,
673};
674
Auke Kokbc7f75f2007-09-17 12:30:59 -0700675struct e1000_dev_spec_ich8lan {
676 bool kmrn_lock_loss_workaround_enabled;
677 struct e1000_shadow_ram shadow_ram[E1000_ICH8_SHADOW_RAM_WORDS];
Bruce Allan1d5846b2009-10-29 13:46:05 +0000678 bool nvm_k1_enabled;
Bruce Allane52997f2010-06-16 13:27:49 +0000679 bool eee_disable;
Bruce Allan2fbe4522012-04-19 03:21:47 +0000680 u16 eee_lp_ability;
David Ertman74f350e2014-02-22 03:15:17 +0000681 enum e1000_ulp_state ulp_state;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700682};
683
684struct e1000_hw {
685 struct e1000_adapter *adapter;
686
Bruce Allanc5083cf2011-12-16 00:45:40 +0000687 void __iomem *hw_addr;
688 void __iomem *flash_address;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700689
Bruce Allane80bd1d2013-05-01 01:19:46 +0000690 struct e1000_mac_info mac;
691 struct e1000_fc_info fc;
692 struct e1000_phy_info phy;
693 struct e1000_nvm_info nvm;
694 struct e1000_bus_info bus;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700695 struct e1000_host_mng_dhcp_cookie mng_cookie;
696
697 union {
Bruce Allane80bd1d2013-05-01 01:19:46 +0000698 struct e1000_dev_spec_82571 e82571;
Bruce Allan3421eec2009-12-08 07:28:20 +0000699 struct e1000_dev_spec_80003es2lan e80003es2lan;
Bruce Allane80bd1d2013-05-01 01:19:46 +0000700 struct e1000_dev_spec_ich8lan ich8lan;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700701 } dev_spec;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700702};
703
Bruce Allanf25701d2013-01-22 08:44:04 +0000704#include "82571.h"
Bruce Allan21b5a6f2013-01-22 08:44:09 +0000705#include "80003es2lan.h"
Bruce Allan1b41db32013-01-22 08:44:14 +0000706#include "ich8lan.h"
Bruce Allanf25701d2013-01-22 08:44:04 +0000707
Auke Kokbc7f75f2007-09-17 12:30:59 -0700708#endif