xref: /freebsd/sys/dev/ixgbe/ixgbe_api.h (revision 35a04710d7286aa9538917fd7f8e417dbee95b82)
1 /*******************************************************************************
2 
3   Copyright (c) 2001-2007, Intel Corporation
4   All rights reserved.
5 
6   Redistribution and use in source and binary forms, with or without
7   modification, are permitted provided that the following conditions are met:
8 
9    1. Redistributions of source code must retain the above copyright notice,
10       this list of conditions and the following disclaimer.
11 
12    2. Redistributions in binary form must reproduce the above copyright
13       notice, this list of conditions and the following disclaimer in the
14       documentation and/or other materials provided with the distribution.
15 
16    3. Neither the name of the Intel Corporation nor the names of its
17       contributors may be used to endorse or promote products derived from
18       this software without specific prior written permission.
19 
20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   POSSIBILITY OF SUCH DAMAGE.
31 
32 *******************************************************************************/
33 /* $FreeBSD$ */
34 
35 #ifndef _IXGBE_API_H_
36 #define _IXGBE_API_H_
37 
38 #include "ixgbe_type.h"
39 
40 s32 ixgbe_init_shared_code(struct ixgbe_hw *hw);
41 
42 s32 ixgbe_set_mac_type(struct ixgbe_hw *hw);
43 s32 ixgbe_init_hw(struct ixgbe_hw *hw);
44 s32 ixgbe_reset_hw(struct ixgbe_hw *hw);
45 s32 ixgbe_start_hw(struct ixgbe_hw *hw);
46 s32 ixgbe_clear_hw_cntrs(struct ixgbe_hw *hw);
47 enum ixgbe_media_type ixgbe_get_media_type(struct ixgbe_hw *hw);
48 s32 ixgbe_get_mac_addr(struct ixgbe_hw *hw, u8 *mac_addr);
49 s32 ixgbe_get_bus_info(struct ixgbe_hw *hw);
50 u32 ixgbe_get_num_of_tx_queues(struct ixgbe_hw *hw);
51 u32 ixgbe_get_num_of_rx_queues(struct ixgbe_hw *hw);
52 s32 ixgbe_stop_adapter(struct ixgbe_hw *hw);
53 
54 s32 ixgbe_identify_phy(struct ixgbe_hw *hw);
55 s32 ixgbe_reset_phy(struct ixgbe_hw *hw);
56 s32 ixgbe_read_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
57 		       u16 *phy_data);
58 s32 ixgbe_write_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
59 			u16 phy_data);
60 
61 s32 ixgbe_setup_link(struct ixgbe_hw *hw);
62 s32 ixgbe_setup_link_speed(struct ixgbe_hw *hw, ixgbe_link_speed speed,
63 			   bool autoneg, bool autoneg_wait_to_complete);
64 s32 ixgbe_check_link(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
65 		     bool *link_up);
66 s32 ixgbe_get_link_settings(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
67 			    bool *autoneg);
68 s32 ixgbe_led_on(struct ixgbe_hw *hw, u32 index);
69 s32 ixgbe_led_off(struct ixgbe_hw *hw, u32 index);
70 s32 ixgbe_blink_led_start(struct ixgbe_hw *hw, u32 index);
71 s32 ixgbe_blink_led_stop(struct ixgbe_hw *hw, u32 index);
72 
73 s32 ixgbe_init_eeprom_params(struct ixgbe_hw *hw);
74 s32 ixgbe_write_eeprom(struct ixgbe_hw *hw, u16 offset, u16 data);
75 s32 ixgbe_read_eeprom(struct ixgbe_hw *hw, u16 offset, u16 *data);
76 s32 ixgbe_validate_eeprom_checksum(struct ixgbe_hw *hw, u16 *checksum_val);
77 s32 ixgbe_update_eeprom_checksum(struct ixgbe_hw *hw);
78 
79 s32 ixgbe_set_rar(struct ixgbe_hw *hw, u32 index, u8 *addr,
80 		      u32 vind, u32 enable_addr);
81 s32 ixgbe_init_rx_addrs(struct ixgbe_hw *hw);
82 u32 ixgbe_get_num_rx_addrs(struct ixgbe_hw *hw);
83 s32 ixgbe_update_mc_addr_list(struct ixgbe_hw *hw, u8 *mc_addr_list,
84 				  u32 mc_addr_count, u32 pad);
85 s32 ixgbe_enable_mc(struct ixgbe_hw *hw);
86 s32 ixgbe_disable_mc(struct ixgbe_hw *hw);
87 s32 ixgbe_clear_vfta(struct ixgbe_hw *hw);
88 s32 ixgbe_set_vfta(struct ixgbe_hw *hw, u32 vlan,
89 		   u32 vind, bool vlan_on);
90 
91 s32 ixgbe_setup_fc(struct ixgbe_hw *hw, s32 packetbuf_num);
92 
93 void ixgbe_set_mta(struct ixgbe_hw *hw, u8 *mc_addr);
94 s32 ixgbe_read_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 *val);
95 s32 ixgbe_write_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 val);
96 
97 #endif /* _IXGBE_API_H_ */
98