[tcp] Merge boolean flags into a single "flags" field
[gpxe.git] / src / drivers / net / e1000e / e1000e.h
blobc057350df5a449903b2cd248c39176e4361c008c
1 /*******************************************************************************
3 Intel PRO/1000 Linux driver
4 Copyright(c) 1999 - 2009 Intel Corporation.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms and conditions of the GNU General Public License,
8 version 2, as published by the Free Software Foundation.
10 This program is distributed in the hope it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 more details.
15 You should have received a copy of the GNU General Public License along with
16 this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
22 Contact Information:
23 Linux NICS <linux.nics@intel.com>
24 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *******************************************************************************/
29 FILE_LICENCE ( GPL2_OR_LATER );
31 /* Linux PRO/1000 Ethernet Driver main header file */
33 #ifndef _E1000E_H_
34 #define _E1000E_H_
36 #include <stdint.h>
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <string.h>
40 #include <unistd.h>
41 #include <gpxe/io.h>
42 #include <errno.h>
43 #include <byteswap.h>
44 #include <gpxe/pci.h>
45 #include <gpxe/malloc.h>
46 #include <gpxe/if_ether.h>
47 #include <gpxe/ethernet.h>
48 #include <gpxe/iobuf.h>
49 #include <gpxe/netdevice.h>
51 /* Begin OS Dependencies */
53 #define u8 unsigned char
54 #define bool boolean_t
55 #define dma_addr_t unsigned long
56 #define __le16 uint16_t
57 #define __le32 uint32_t
58 #define __le64 uint64_t
60 #define __iomem
62 #define msleep(x) mdelay(x)
64 #define ETH_FCS_LEN 4
66 typedef int spinlock_t;
67 typedef enum {
68 false = 0,
69 true = 1
70 } boolean_t;
72 /* End OS Dependencies */
74 #include "e1000e_hw.h"
76 #define E1000_TX_FLAGS_CSUM 0x00000001
77 #define E1000_TX_FLAGS_VLAN 0x00000002
78 #define E1000_TX_FLAGS_TSO 0x00000004
79 #define E1000_TX_FLAGS_IPV4 0x00000008
80 #define E1000_TX_FLAGS_VLAN_MASK 0xffff0000
81 #define E1000_TX_FLAGS_VLAN_SHIFT 16
83 #define E1000_MAX_PER_TXD 8192
84 #define E1000_MAX_TXD_PWR 12
86 #define MINIMUM_DHCP_PACKET_SIZE 282
88 struct e1000_info;
90 #define e_dbg(arg...) if (0) { printf (arg); };
92 #ifdef CONFIG_E1000E_MSIX
93 /* Interrupt modes, as used by the IntMode paramter */
94 #define E1000E_INT_MODE_LEGACY 0
95 #define E1000E_INT_MODE_MSI 1
96 #define E1000E_INT_MODE_MSIX 2
98 #endif /* CONFIG_E1000E_MSIX */
99 #ifndef CONFIG_E1000E_NAPI
100 #define E1000_MAX_INTR 10
102 #endif /* CONFIG_E1000E_NAPI */
103 /* Tx/Rx descriptor defines */
104 #define E1000_DEFAULT_TXD 256
105 #define E1000_MAX_TXD 4096
106 #define E1000_MIN_TXD 64
108 #define E1000_DEFAULT_RXD 256
109 #define E1000_MAX_RXD 4096
110 #define E1000_MIN_RXD 64
112 #define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */
113 #define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */
115 /* Early Receive defines */
116 #define E1000_ERT_2048 0x100
118 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
120 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
121 /* How many Rx Buffers do we bundle into one write to the hardware ? */
122 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
124 #define AUTO_ALL_MODES 0
125 #define E1000_EEPROM_APME 0x0400
127 #define E1000_MNG_VLAN_NONE (-1)
129 /* Number of packet split data buffers (not including the header buffer) */
130 #define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 1)
132 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
134 #define DEFAULT_JUMBO 9234
136 enum e1000_boards {
137 board_82571,
138 board_82572,
139 board_82573,
140 board_82574,
141 board_80003es2lan,
142 board_ich8lan,
143 board_ich9lan,
144 board_ich10lan,
145 board_pchlan,
146 board_82583,
149 /* board specific private data structure */
150 struct e1000_adapter {
151 const struct e1000_info *ei;
153 /* OS defined structs */
154 struct net_device *netdev;
155 struct pci_device *pdev;
156 struct net_device_stats net_stats;
158 /* structs defined in e1000_hw.h */
159 struct e1000_hw hw;
161 struct e1000_phy_info phy_info;
163 u32 wol;
164 u32 pba;
165 u32 max_hw_frame_size;
167 bool fc_autoneg;
169 unsigned int flags;
170 unsigned int flags2;
172 #define NUM_TX_DESC 8
173 #define NUM_RX_DESC 8
175 struct io_buffer *tx_iobuf[NUM_TX_DESC];
176 struct io_buffer *rx_iobuf[NUM_RX_DESC];
178 struct e1000_tx_desc *tx_base;
179 struct e1000_rx_desc *rx_base;
181 uint32_t tx_ring_size;
182 uint32_t rx_ring_size;
184 uint32_t tx_head;
185 uint32_t tx_tail;
186 uint32_t tx_fill_ctr;
188 uint32_t rx_curr;
190 uint32_t ioaddr;
191 uint32_t irqno;
193 uint32_t tx_int_delay;
194 uint32_t tx_abs_int_delay;
195 uint32_t txd_cmd;
198 struct e1000_info {
199 enum e1000_mac_type mac;
200 unsigned int flags;
201 unsigned int flags2;
202 u32 pba;
203 u32 max_hw_frame_size;
204 s32 (*get_variants)(struct e1000_adapter *);
205 void (*init_ops)(struct e1000_hw *);
208 /* hardware capability, feature, and workaround flags */
209 #define FLAG_HAS_AMT (1 << 0)
210 #define FLAG_HAS_FLASH (1 << 1)
211 #define FLAG_HAS_HW_VLAN_FILTER (1 << 2)
212 #define FLAG_HAS_WOL (1 << 3)
213 #define FLAG_HAS_ERT (1 << 4)
214 #define FLAG_HAS_CTRLEXT_ON_LOAD (1 << 5)
215 #define FLAG_HAS_SWSM_ON_LOAD (1 << 6)
216 #define FLAG_HAS_JUMBO_FRAMES (1 << 7)
217 #define FLAG_IS_ICH (1 << 9)
218 #ifdef CONFIG_E1000E_MSIX
219 #define FLAG_HAS_MSIX (1 << 10)
220 #endif
221 #define FLAG_HAS_SMART_POWER_DOWN (1 << 11)
222 #define FLAG_IS_QUAD_PORT_A (1 << 12)
223 #define FLAG_IS_QUAD_PORT (1 << 13)
224 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN (1 << 14)
225 #define FLAG_APME_IN_WUC (1 << 15)
226 #define FLAG_APME_IN_CTRL3 (1 << 16)
227 #define FLAG_APME_CHECK_PORT_B (1 << 17)
228 #define FLAG_DISABLE_FC_PAUSE_TIME (1 << 18)
229 #define FLAG_NO_WAKE_UCAST (1 << 19)
230 #define FLAG_MNG_PT_ENABLED (1 << 20)
231 #define FLAG_RESET_OVERWRITES_LAA (1 << 21)
232 #define FLAG_TARC_SPEED_MODE_BIT (1 << 22)
233 #define FLAG_TARC_SET_BIT_ZERO (1 << 23)
234 #define FLAG_RX_NEEDS_RESTART (1 << 24)
235 #define FLAG_LSC_GIG_SPEED_DROP (1 << 25)
236 #define FLAG_SMART_POWER_DOWN (1 << 26)
237 #define FLAG_MSI_ENABLED (1 << 27)
238 #define FLAG_RX_CSUM_ENABLED (1 << 28)
239 #define FLAG_TSO_FORCE (1 << 29)
240 #define FLAG_RX_RESTART_NOW (1 << 30)
241 #define FLAG_MSI_TEST_FAILED (1 << 31)
243 /* CRC Stripping defines */
244 #define FLAG2_CRC_STRIPPING (1 << 0)
245 #define FLAG2_HAS_PHY_WAKEUP (1 << 1)
247 #define E1000_RX_DESC_PS(R, i) \
248 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
249 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
250 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
251 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
252 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
254 enum e1000_state_t {
255 __E1000E_TESTING,
256 __E1000E_RESETTING,
257 __E1000E_DOWN
260 enum latency_range {
261 lowest_latency = 0,
262 low_latency = 1,
263 bulk_latency = 2,
264 latency_invalid = 255
267 extern void e1000e_check_options(struct e1000_adapter *adapter);
269 extern void e1000e_reset(struct e1000_adapter *adapter);
270 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
272 extern void e1000e_init_function_pointers_82571(struct e1000_hw *hw)
273 __attribute__((weak));
274 extern void e1000e_init_function_pointers_80003es2lan(struct e1000_hw *hw)
275 __attribute__((weak));
276 extern void e1000e_init_function_pointers_ich8lan(struct e1000_hw *hw)
277 __attribute__((weak));
279 extern int e1000e_probe(struct pci_device *pdev,
280 const struct pci_device_id *id __unused);
282 extern void e1000e_remove(struct pci_device *pdev);
284 extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);
286 static inline s32 e1000e_commit_phy(struct e1000_hw *hw)
288 if (hw->phy.ops.commit)
289 return hw->phy.ops.commit(hw);
291 return 0;
294 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
296 extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);
297 extern void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state);
299 extern void e1000e_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
300 bool state);
301 extern void e1000e_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
302 extern void e1000e_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
303 extern void e1000e_disable_gig_wol_ich8lan(struct e1000_hw *hw);
305 extern s32 e1000e_check_for_copper_link(struct e1000_hw *hw);
306 extern s32 e1000e_check_for_fiber_link(struct e1000_hw *hw);
307 extern s32 e1000e_check_for_serdes_link(struct e1000_hw *hw);
308 extern s32 e1000e_cleanup_led_generic(struct e1000_hw *hw);
309 extern s32 e1000e_led_on_generic(struct e1000_hw *hw);
310 extern s32 e1000e_led_off_generic(struct e1000_hw *hw);
311 extern s32 e1000e_get_bus_info_pcie(struct e1000_hw *hw);
312 extern s32 e1000e_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed, u16 *duplex);
313 extern s32 e1000e_get_speed_and_duplex_fiber_serdes(struct e1000_hw *hw, u16 *speed, u16 *duplex);
314 extern s32 e1000e_disable_pcie_master(struct e1000_hw *hw);
315 extern s32 e1000e_get_auto_rd_done(struct e1000_hw *hw);
316 extern s32 e1000e_id_led_init(struct e1000_hw *hw);
317 extern void e1000e_clear_hw_cntrs_base(struct e1000_hw *hw);
318 extern s32 e1000e_setup_fiber_serdes_link(struct e1000_hw *hw);
319 extern s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
320 extern s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
321 extern s32 e1000e_setup_link(struct e1000_hw *hw);
322 static inline void e1000e_clear_vfta(struct e1000_hw *hw)
324 hw->mac.ops.clear_vfta(hw);
326 extern void e1000e_init_rx_addrs(struct e1000_hw *hw, u16 rar_count);
327 extern void e1000e_update_mc_addr_list_generic(struct e1000_hw *hw,
328 u8 *mc_addr_list,
329 u32 mc_addr_count);
330 extern void e1000e_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
331 extern s32 e1000e_set_fc_watermarks(struct e1000_hw *hw);
332 extern void e1000e_set_pcie_no_snoop(struct e1000_hw *hw, u32 no_snoop);
333 extern s32 e1000e_get_hw_semaphore(struct e1000_hw *hw);
334 extern s32 e1000e_valid_led_default(struct e1000_hw *hw, u16 *data);
335 extern void e1000e_config_collision_dist(struct e1000_hw *hw);
336 extern s32 e1000e_config_fc_after_link_up(struct e1000_hw *hw);
337 extern s32 e1000e_force_mac_fc(struct e1000_hw *hw);
338 extern s32 e1000e_blink_led(struct e1000_hw *hw);
339 extern void e1000e_write_vfta_generic(struct e1000_hw *hw, u32 offset, u32 value);
340 static inline void e1000e_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
342 if (hw->mac.ops.write_vfta)
343 hw->mac.ops.write_vfta(hw, offset, value);
345 extern void e1000e_reset_adaptive(struct e1000_hw *hw);
346 extern void e1000e_update_adaptive(struct e1000_hw *hw);
348 extern s32 e1000e_setup_copper_link(struct e1000_hw *hw);
349 extern void e1000e_put_hw_semaphore(struct e1000_hw *hw);
350 extern s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
351 #if 0
352 extern s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
353 #endif
354 #if 0
355 extern s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
356 #endif
357 extern s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
358 extern s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
359 extern s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
360 extern s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
361 extern s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
362 extern s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
363 #if 0
364 extern s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
365 #endif
366 extern s32 e1000e_get_cfg_done(struct e1000_hw *hw);
367 #if 0
368 extern s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
369 #endif
370 extern s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
371 extern s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
372 extern s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
373 extern enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
374 extern s32 e1000e_determine_phy_address(struct e1000_hw *hw);
375 extern s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
376 extern s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
377 #if 0
378 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
379 #endif
380 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
381 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
382 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
383 u32 usec_interval, bool *success);
384 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
385 extern s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
386 extern s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
387 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
389 static inline s32 e1000e_phy_hw_reset(struct e1000_hw *hw)
391 if (hw->phy.ops.reset)
392 return hw->phy.ops.reset(hw);
394 return 0;
397 static inline s32 e1000e_check_reset_block(struct e1000_hw *hw)
399 if (hw->phy.ops.check_reset_block)
400 return hw->phy.ops.check_reset_block(hw);
402 return 0;
405 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
407 if (hw->phy.ops.read_reg)
408 return hw->phy.ops.read_reg(hw, offset, data);
410 return 0;
413 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
415 if (hw->phy.ops.write_reg)
416 return hw->phy.ops.write_reg(hw, offset, data);
418 return 0;
421 #if 0
422 static inline s32 e1000e_get_cable_length(struct e1000_hw *hw)
424 if (hw->phy.ops.get_cable_length)
425 return hw->phy.ops.get_cable_length(hw);
427 return 0;
429 #endif
431 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
432 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
433 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
434 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
435 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
436 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
437 extern void e1000e_release_nvm(struct e1000_hw *hw);
439 static inline s32 e1000e_read_mac_addr(struct e1000_hw *hw)
441 if (hw->mac.ops.read_mac_addr)
442 return hw->mac.ops.read_mac_addr(hw);
444 return e1000e_read_mac_addr_generic(hw);
447 static inline s32 e1000e_validate_nvm_checksum(struct e1000_hw *hw)
449 return hw->nvm.ops.validate(hw);
452 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
454 return hw->nvm.ops.update(hw);
457 static inline s32 e1000e_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
459 return hw->nvm.ops.read(hw, offset, words, data);
462 static inline s32 e1000e_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
464 return hw->nvm.ops.write(hw, offset, words, data);
467 static inline s32 e1000e_get_phy_info(struct e1000_hw *hw)
469 if (hw->phy.ops.get_info)
470 return hw->phy.ops.get_info(hw);
472 return 0;
475 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
476 #if 0
477 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
478 #endif
480 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
482 return readl(hw->hw_addr + reg);
485 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
487 writel(val, hw->hw_addr + reg);
490 #define er32(reg) __er32(hw, E1000_##reg)
491 #define ew32(reg, val) __ew32(hw, E1000_##reg, (val))
492 #define e1e_flush() er32(STATUS)
494 #define E1000_WRITE_REG(a, reg, value) \
495 writel((value), ((a)->hw_addr + reg))
497 #define E1000_READ_REG(a, reg) (readl((a)->hw_addr + reg))
499 #define E1000_WRITE_REG_ARRAY(a, reg, offset, value) \
500 writel((value), ((a)->hw_addr + reg + ((offset) << 2)))
502 #define E1000_READ_REG_ARRAY(a, reg, offset) ( \
503 readl((a)->hw_addr + reg + ((offset) << 2)))
505 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
506 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
508 static inline u16 __er16flash(struct e1000_hw *hw, unsigned long reg)
510 return readw(hw->flash_address + reg);
513 static inline u32 __er32flash(struct e1000_hw *hw, unsigned long reg)
515 return readl(hw->flash_address + reg);
518 static inline void __ew16flash(struct e1000_hw *hw, unsigned long reg, u16 val)
520 writew(val, hw->flash_address + reg);
523 static inline void __ew32flash(struct e1000_hw *hw, unsigned long reg, u32 val)
525 writel(val, hw->flash_address + reg);
528 #define er16flash(reg) __er16flash(hw, (reg))
529 #define er32flash(reg) __er32flash(hw, (reg))
530 #define ew16flash(reg, val) __ew16flash(hw, (reg), (val))
531 #define ew32flash(reg, val) __ew32flash(hw, (reg), (val))
533 #endif /* _E1000E_H_ */