[igb] Add igb driver
[people/pcmattman/gpxe.git] / src / drivers / net / igb / igb_api.h
1 /*******************************************************************************
2
3   Intel(R) Gigabit Ethernet Linux driver
4   Copyright(c) 2007-2009 Intel Corporation.
5
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.
9
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.
14
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.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25
26 *******************************************************************************/
27
28 FILE_LICENCE ( GPL2_ONLY );
29
30 #ifndef _IGB_API_H_
31 #define _IGB_API_H_
32
33 #include <stdint.h>
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <unistd.h>
38 #include <gpxe/io.h>
39 #include <errno.h>
40 #include <byteswap.h>
41 #include <gpxe/pci.h>
42 #include <gpxe/malloc.h>
43 #include <gpxe/if_ether.h>
44 #include <gpxe/ethernet.h>
45 #include <gpxe/iobuf.h>
46 #include <gpxe/netdevice.h>
47
48 #include "igb_hw.h"
49
50 extern void    igb_init_function_pointers_82575(struct e1000_hw *hw) __attribute__((weak));
51 extern void    igb_rx_fifo_flush_82575(struct e1000_hw *hw) __attribute__((weak));
52 extern void    igb_init_function_pointers_vf(struct e1000_hw *hw) __attribute__((weak));
53 extern void    igb_shutdown_fiber_serdes_link(struct e1000_hw *hw) __attribute__((weak));
54
55 s32  igb_set_mac_type(struct e1000_hw *hw);
56 s32  igb_setup_init_funcs(struct e1000_hw *hw, bool init_device);
57 s32  igb_init_mac_params(struct e1000_hw *hw);
58 s32  igb_init_nvm_params(struct e1000_hw *hw);
59 s32  igb_init_phy_params(struct e1000_hw *hw);
60 s32  igb_init_mbx_params(struct e1000_hw *hw);
61 s32  igb_get_bus_info(struct e1000_hw *hw);
62 void igb_clear_vfta(struct e1000_hw *hw);
63 void igb_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
64 s32  igb_force_mac_fc(struct e1000_hw *hw);
65 s32  igb_check_for_link(struct e1000_hw *hw);
66 s32  igb_reset_hw(struct e1000_hw *hw);
67 s32  igb_init_hw(struct e1000_hw *hw);
68 s32  igb_setup_link(struct e1000_hw *hw);
69 s32  igb_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed,
70                                 u16 *duplex);
71 s32  igb_disable_pcie_master(struct e1000_hw *hw);
72 void igb_config_collision_dist(struct e1000_hw *hw);
73 void igb_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
74 void igb_mta_set(struct e1000_hw *hw, u32 hash_value);
75 u32  igb_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
76 void igb_update_mc_addr_list(struct e1000_hw *hw,
77                                u8 *mc_addr_list, u32 mc_addr_count);
78 s32  igb_setup_led(struct e1000_hw *hw);
79 s32  igb_cleanup_led(struct e1000_hw *hw);
80 s32  igb_check_reset_block(struct e1000_hw *hw);
81 s32  igb_blink_led(struct e1000_hw *hw);
82 s32  igb_led_on(struct e1000_hw *hw);
83 s32  igb_led_off(struct e1000_hw *hw);
84 s32 igb_id_led_init(struct e1000_hw *hw);
85 void igb_reset_adaptive(struct e1000_hw *hw);
86 void igb_update_adaptive(struct e1000_hw *hw);
87 #if 0
88 s32  igb_get_cable_length(struct e1000_hw *hw);
89 #endif
90 s32  igb_validate_mdi_setting(struct e1000_hw *hw);
91 s32  igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
92 s32  igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
93 s32  igb_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg,
94                                u32 offset, u8 data);
95 s32  igb_get_phy_info(struct e1000_hw *hw);
96 void igb_release_phy(struct e1000_hw *hw);
97 s32  igb_acquire_phy(struct e1000_hw *hw);
98 s32  igb_phy_hw_reset(struct e1000_hw *hw);
99 s32  igb_phy_commit(struct e1000_hw *hw);
100 void igb_power_up_phy(struct e1000_hw *hw);
101 void igb_power_down_phy(struct e1000_hw *hw);
102 s32  igb_read_mac_addr(struct e1000_hw *hw);
103 s32  igb_read_pba_num(struct e1000_hw *hw, u32 *part_num);
104 void igb_reload_nvm(struct e1000_hw *hw);
105 s32  igb_update_nvm_checksum(struct e1000_hw *hw);
106 s32  igb_validate_nvm_checksum(struct e1000_hw *hw);
107 s32  igb_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
108 s32  igb_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
109 s32  igb_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
110 s32  igb_write_nvm(struct e1000_hw *hw, u16 offset, u16 words,
111                      u16 *data);
112 s32  igb_wait_autoneg(struct e1000_hw *hw);
113 s32  igb_set_d3_lplu_state(struct e1000_hw *hw, bool active);
114 s32  igb_set_d0_lplu_state(struct e1000_hw *hw, bool active);
115 bool igb_check_mng_mode(struct e1000_hw *hw);
116 bool igb_enable_tx_pkt_filtering(struct e1000_hw *hw);
117 s32  igb_mng_enable_host_if(struct e1000_hw *hw);
118 s32  igb_mng_host_if_write(struct e1000_hw *hw,
119                              u8 *buffer, u16 length, u16 offset, u8 *sum);
120 s32  igb_mng_write_cmd_header(struct e1000_hw *hw,
121                                 struct e1000_host_mng_command_header *hdr);
122 s32  igb_mng_write_dhcp_info(struct e1000_hw * hw,
123                                     u8 *buffer, u16 length);
124
125 /*
126  * TBI_ACCEPT macro definition:
127  *
128  * This macro requires:
129  *      adapter = a pointer to struct e1000_hw
130  *      status = the 8 bit status field of the Rx descriptor with EOP set
131  *      error = the 8 bit error field of the Rx descriptor with EOP set
132  *      length = the sum of all the length fields of the Rx descriptors that
133  *               make up the current frame
134  *      last_byte = the last byte of the frame DMAed by the hardware
135  *      max_frame_length = the maximum frame length we want to accept.
136  *      min_frame_length = the minimum frame length we want to accept.
137  *
138  * This macro is a conditional that should be used in the interrupt
139  * handler's Rx processing routine when RxErrors have been detected.
140  *
141  * Typical use:
142  *  ...
143  *  if (TBI_ACCEPT) {
144  *      accept_frame = true;
145  *      e1000_tbi_adjust_stats(adapter, MacAddress);
146  *      frame_length--;
147  *  } else {
148  *      accept_frame = false;
149  *  }
150  *  ...
151  */
152
153 /* The carrier extension symbol, as received by the NIC. */
154 #define CARRIER_EXTENSION   0x0F
155
156 #define TBI_ACCEPT(a, status, errors, length, last_byte, min_frame_size, max_frame_size) \
157     (e1000_tbi_sbp_enabled_82543(a) && \
158      (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
159      ((last_byte) == CARRIER_EXTENSION) && \
160      (((status) & E1000_RXD_STAT_VP) ? \
161           (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \
162            ((length) <= (max_frame_size + 1))) : \
163           (((length) > min_frame_size) && \
164            ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1)))))
165
166 #endif /* _IGB_API_H_ */