ixgbe_api.h revision 215911 
1/******************************************************************************
2
3  Copyright (c) 2001-2010, 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: head/sys/dev/ixgbe/ixgbe_api.h 215911 2010-11-26 22:46:32Z jfv $*/
34
35#ifndef _IXGBE_API_H_
36#define _IXGBE_API_H_
37
38#include "ixgbe_type.h"
39
40s32 ixgbe_init_shared_code(struct ixgbe_hw *hw);
41
42s32 ixgbe_set_mac_type(struct ixgbe_hw *hw);
43s32 ixgbe_init_hw(struct ixgbe_hw *hw);
44s32 ixgbe_reset_hw(struct ixgbe_hw *hw);
45s32 ixgbe_start_hw(struct ixgbe_hw *hw);
46void ixgbe_enable_relaxed_ordering(struct ixgbe_hw *hw);
47s32 ixgbe_clear_hw_cntrs(struct ixgbe_hw *hw);
48enum ixgbe_media_type ixgbe_get_media_type(struct ixgbe_hw *hw);
49s32 ixgbe_get_mac_addr(struct ixgbe_hw *hw, u8 *mac_addr);
50s32 ixgbe_get_bus_info(struct ixgbe_hw *hw);
51u32 ixgbe_get_num_of_tx_queues(struct ixgbe_hw *hw);
52u32 ixgbe_get_num_of_rx_queues(struct ixgbe_hw *hw);
53s32 ixgbe_stop_adapter(struct ixgbe_hw *hw);
54s32 ixgbe_read_pba_num(struct ixgbe_hw *hw, u32 *pba_num);
55s32 ixgbe_read_pba_string(struct ixgbe_hw *hw, u8 *pba_num, u32 pba_num_size);
56s32 ixgbe_read_pba_length(struct ixgbe_hw *hw, u32 *pba_num_size);
57
58s32 ixgbe_identify_phy(struct ixgbe_hw *hw);
59s32 ixgbe_reset_phy(struct ixgbe_hw *hw);
60s32 ixgbe_read_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
61                       u16 *phy_data);
62s32 ixgbe_write_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
63                        u16 phy_data);
64
65s32 ixgbe_setup_phy_link(struct ixgbe_hw *hw);
66s32 ixgbe_check_phy_link(struct ixgbe_hw *hw,
67                         ixgbe_link_speed *speed,
68                         bool *link_up);
69s32 ixgbe_setup_phy_link_speed(struct ixgbe_hw *hw,
70                               ixgbe_link_speed speed,
71                               bool autoneg,
72                               bool autoneg_wait_to_complete);
73void ixgbe_disable_tx_laser(struct ixgbe_hw *hw);
74void ixgbe_enable_tx_laser(struct ixgbe_hw *hw);
75void ixgbe_flap_tx_laser(struct ixgbe_hw *hw);
76s32 ixgbe_setup_link(struct ixgbe_hw *hw, ixgbe_link_speed speed,
77                           bool autoneg, bool autoneg_wait_to_complete);
78s32 ixgbe_check_link(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
79                     bool *link_up, bool link_up_wait_to_complete);
80s32 ixgbe_get_link_capabilities(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
81                            bool *autoneg);
82s32 ixgbe_led_on(struct ixgbe_hw *hw, u32 index);
83s32 ixgbe_led_off(struct ixgbe_hw *hw, u32 index);
84s32 ixgbe_blink_led_start(struct ixgbe_hw *hw, u32 index);
85s32 ixgbe_blink_led_stop(struct ixgbe_hw *hw, u32 index);
86
87s32 ixgbe_init_eeprom_params(struct ixgbe_hw *hw);
88s32 ixgbe_write_eeprom(struct ixgbe_hw *hw, u16 offset, u16 data);
89s32 ixgbe_read_eeprom(struct ixgbe_hw *hw, u16 offset, u16 *data);
90s32 ixgbe_validate_eeprom_checksum(struct ixgbe_hw *hw, u16 *checksum_val);
91s32 ixgbe_update_eeprom_checksum(struct ixgbe_hw *hw);
92
93s32 ixgbe_insert_mac_addr(struct ixgbe_hw *hw, u8 *addr, u32 vmdq);
94s32 ixgbe_set_rar(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
95                  u32 enable_addr);
96s32 ixgbe_clear_rar(struct ixgbe_hw *hw, u32 index);
97s32 ixgbe_set_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
98s32 ixgbe_clear_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
99s32 ixgbe_init_rx_addrs(struct ixgbe_hw *hw);
100u32 ixgbe_get_num_rx_addrs(struct ixgbe_hw *hw);
101s32 ixgbe_update_uc_addr_list(struct ixgbe_hw *hw, u8 *addr_list,
102                              u32 addr_count, ixgbe_mc_addr_itr func);
103s32 ixgbe_update_mc_addr_list(struct ixgbe_hw *hw, u8 *mc_addr_list,
104                              u32 mc_addr_count, ixgbe_mc_addr_itr func);
105void ixgbe_add_uc_addr(struct ixgbe_hw *hw, u8 *addr_list, u32 vmdq);
106s32 ixgbe_enable_mc(struct ixgbe_hw *hw);
107s32 ixgbe_disable_mc(struct ixgbe_hw *hw);
108s32 ixgbe_clear_vfta(struct ixgbe_hw *hw);
109s32 ixgbe_set_vfta(struct ixgbe_hw *hw, u32 vlan,
110                   u32 vind, bool vlan_on);
111
112s32 ixgbe_fc_enable(struct ixgbe_hw *hw, s32 packetbuf_num);
113
114void ixgbe_set_mta(struct ixgbe_hw *hw, u8 *mc_addr);
115s32 ixgbe_get_phy_firmware_version(struct ixgbe_hw *hw,
116                                   u16 *firmware_version);
117s32 ixgbe_read_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 *val);
118s32 ixgbe_write_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 val);
119s32 ixgbe_init_uta_tables(struct ixgbe_hw *hw);
120s32 ixgbe_read_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 *eeprom_data);
121u32 ixgbe_get_supported_physical_layer(struct ixgbe_hw *hw);
122s32 ixgbe_enable_rx_dma(struct ixgbe_hw *hw, u32 regval);
123s32 ixgbe_reinit_fdir_tables_82599(struct ixgbe_hw *hw);
124s32 ixgbe_init_fdir_signature_82599(struct ixgbe_hw *hw, u32 pballoc);
125s32 ixgbe_init_fdir_perfect_82599(struct ixgbe_hw *hw, u32 pballoc);
126s32 ixgbe_fdir_add_signature_filter_82599(struct ixgbe_hw *hw,
127                                          union ixgbe_atr_input *input,
128                                          u8 queue);
129s32 ixgbe_fdir_add_perfect_filter_82599(struct ixgbe_hw *hw,
130                                        union ixgbe_atr_input *input,
131                                        struct ixgbe_atr_input_masks *masks,
132                                        u16 soft_id,
133                                        u8 queue);
134u16 ixgbe_atr_compute_hash_82599(union ixgbe_atr_input *input, u32 key);
135s32 ixgbe_atr_set_vlan_id_82599(union ixgbe_atr_input *input, __be16 vlan_id);
136s32 ixgbe_atr_set_src_ipv4_82599(union ixgbe_atr_input *input, __be32 src_addr);
137s32 ixgbe_atr_set_dst_ipv4_82599(union ixgbe_atr_input *input, __be32 dst_addr);
138s32 ixgbe_atr_set_src_ipv6_82599(union ixgbe_atr_input *input, __be32 src_addr_0,
139                                 __be32 src_addr_1, __be32 src_addr_2,
140                                 __be32 src_addr_3);
141s32 ixgbe_atr_set_dst_ipv6_82599(union ixgbe_atr_input *input, __be32 dst_addr_0,
142                                 __be32 dst_addr_1, __be32 dst_addr_2,
143                                 __be32 dst_addr_3);
144s32 ixgbe_atr_set_src_port_82599(union ixgbe_atr_input *input, __be16 src_port);
145s32 ixgbe_atr_set_dst_port_82599(union ixgbe_atr_input *input, __be16 dst_port);
146s32 ixgbe_atr_set_flex_byte_82599(union ixgbe_atr_input *input, __be16 flex_byte);
147s32 ixgbe_atr_set_vm_pool_82599(union ixgbe_atr_input *input, u8 vm_pool);
148s32 ixgbe_atr_set_l4type_82599(union ixgbe_atr_input *input, u8 l4type);
149s32 ixgbe_atr_get_vlan_id_82599(union ixgbe_atr_input *input, __be16 *vlan_id);
150s32 ixgbe_atr_get_src_ipv4_82599(union ixgbe_atr_input *input, __be32 *src_addr);
151s32 ixgbe_atr_get_dst_ipv4_82599(union ixgbe_atr_input *input, __be32 *dst_addr);
152s32 ixgbe_atr_get_src_ipv6_82599(union ixgbe_atr_input *input, __be32 *src_addr_0,
153                                 __be32 *src_addr_1, __be32 *src_addr_2,
154                                 __be32 *src_addr_3);
155s32 ixgbe_atr_get_dst_ipv6_82599(union ixgbe_atr_input *input, __be32 *dst_addr_0,
156                                 __be32 *dst_addr_1, __be32 *dst_addr_2,
157                                 __be32 *dst_addr_3);
158s32 ixgbe_atr_get_src_port_82599(union ixgbe_atr_input *input, __be16 *src_port);
159s32 ixgbe_atr_get_dst_port_82599(union ixgbe_atr_input *input, __be16 *dst_port);
160s32 ixgbe_atr_get_flex_byte_82599(union ixgbe_atr_input *input,
161                                  __be16 *flex_byte);
162s32 ixgbe_atr_get_vm_pool_82599(union ixgbe_atr_input *input, u8 *vm_pool);
163s32 ixgbe_atr_get_l4type_82599(union ixgbe_atr_input *input, u8 *l4type);
164s32 ixgbe_read_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
165                        u8 *data);
166s32 ixgbe_write_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
167                         u8 data);
168s32 ixgbe_write_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 eeprom_data);
169s32 ixgbe_get_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr);
170s32 ixgbe_set_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr);
171s32 ixgbe_get_device_caps(struct ixgbe_hw *hw, u16 *device_caps);
172s32 ixgbe_acquire_swfw_semaphore(struct ixgbe_hw *hw, u16 mask);
173void ixgbe_release_swfw_semaphore(struct ixgbe_hw *hw, u16 mask);
174s32 ixgbe_get_wwn_prefix(struct ixgbe_hw *hw, u16 *wwnn_prefix,
175                         u16 *wwpn_prefix);
176s32 ixgbe_get_fcoe_boot_status(struct ixgbe_hw *hw, u16 *bs);
177
178
179#endif /* _IXGBE_API_H_ */
180