gpx e1000 driver.
[akaros.git] / kern / drivers / net / e1000 / e1000_api.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2008 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   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
26
27 *******************************************************************************/
28
29 FILE_LICENCE ( GPL2_OR_LATER );
30
31 #ifndef _E1000_API_H_
32 #define _E1000_API_H_
33
34 #include <stdint.h>
35 #include <stdlib.h>
36 #include <stdio.h>
37 #include <string.h>
38 #include <unistd.h>
39 #include <gpxe/io.h>
40 #include <errno.h>
41 #include <byteswap.h>
42 #include <gpxe/pci.h>
43 #include <gpxe/malloc.h>
44 #include <gpxe/if_ether.h>
45 #include <gpxe/ethernet.h>
46 #include <gpxe/iobuf.h>
47 #include <gpxe/netdevice.h>
48
49 #include "e1000_hw.h"
50
51 extern void    e1000_init_function_pointers_82542(struct e1000_hw *hw) __attribute__((weak));
52 extern void    e1000_init_function_pointers_82543(struct e1000_hw *hw) __attribute__((weak));
53 extern void    e1000_init_function_pointers_82540(struct e1000_hw *hw) __attribute__((weak));
54 extern void    e1000_init_function_pointers_82541(struct e1000_hw *hw) __attribute__((weak));
55
56 s32  e1000_set_mac_type(struct e1000_hw *hw);
57 s32  e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
58 s32  e1000_init_mac_params(struct e1000_hw *hw);
59 s32  e1000_init_nvm_params(struct e1000_hw *hw);
60 s32  e1000_init_phy_params(struct e1000_hw *hw);
61 s32  e1000_get_bus_info(struct e1000_hw *hw);
62 void e1000_clear_vfta(struct e1000_hw *hw);
63 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
64 s32  e1000_force_mac_fc(struct e1000_hw *hw);
65 s32  e1000_check_for_link(struct e1000_hw *hw);
66 s32  e1000_reset_hw(struct e1000_hw *hw);
67 s32  e1000_init_hw(struct e1000_hw *hw);
68 s32  e1000_setup_link(struct e1000_hw *hw);
69 s32  e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed,
70                                 u16 *duplex);
71 s32  e1000_disable_pcie_master(struct e1000_hw *hw);
72 void e1000_config_collision_dist(struct e1000_hw *hw);
73 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
74 void e1000_mta_set(struct e1000_hw *hw, u32 hash_value);
75 u32  e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
76 void e1000_update_mc_addr_list(struct e1000_hw *hw,
77                                u8 *mc_addr_list, u32 mc_addr_count);
78 s32  e1000_setup_led(struct e1000_hw *hw);
79 s32  e1000_cleanup_led(struct e1000_hw *hw);
80 s32  e1000_check_reset_block(struct e1000_hw *hw);
81 s32  e1000_blink_led(struct e1000_hw *hw);
82 s32  e1000_led_on(struct e1000_hw *hw);
83 s32  e1000_led_off(struct e1000_hw *hw);
84 s32 e1000_id_led_init(struct e1000_hw *hw);
85 void e1000_reset_adaptive(struct e1000_hw *hw);
86 void e1000_update_adaptive(struct e1000_hw *hw);
87 #if 0
88 s32  e1000_get_cable_length(struct e1000_hw *hw);
89 #endif
90 s32  e1000_validate_mdi_setting(struct e1000_hw *hw);
91 s32  e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
92 s32  e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
93 s32  e1000_get_phy_info(struct e1000_hw *hw);
94 void e1000_release_phy(struct e1000_hw *hw);
95 s32  e1000_acquire_phy(struct e1000_hw *hw);
96 s32  e1000_phy_hw_reset(struct e1000_hw *hw);
97 s32  e1000_phy_commit(struct e1000_hw *hw);
98 void e1000_power_up_phy(struct e1000_hw *hw);
99 void e1000_power_down_phy(struct e1000_hw *hw);
100 s32  e1000_read_mac_addr(struct e1000_hw *hw);
101 s32  e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num);
102 void e1000_reload_nvm(struct e1000_hw *hw);
103 s32  e1000_update_nvm_checksum(struct e1000_hw *hw);
104 s32  e1000_validate_nvm_checksum(struct e1000_hw *hw);
105 s32  e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
106 s32  e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
107 s32  e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
108 s32  e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words,
109                      u16 *data);
110 s32  e1000_wait_autoneg(struct e1000_hw *hw);
111 s32  e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
112 s32  e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
113 bool e1000_check_mng_mode(struct e1000_hw *hw);
114 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
115 s32  e1000_mng_enable_host_if(struct e1000_hw *hw);
116 s32  e1000_mng_host_if_write(struct e1000_hw *hw,
117                              u8 *buffer, u16 length, u16 offset, u8 *sum);
118 s32  e1000_mng_write_cmd_header(struct e1000_hw *hw,
119                                 struct e1000_host_mng_command_header *hdr);
120 s32  e1000_mng_write_dhcp_info(struct e1000_hw * hw,
121                                     u8 *buffer, u16 length);
122 u32  e1000_translate_register_82542(u32 reg) __attribute__((weak));
123
124 extern int e1000_probe(struct pci_device *pdev,
125                        const struct pci_device_id *id __unused);
126 extern void e1000_remove(struct pci_device *pdev);
127
128 #endif