xref: /onnv-gate/usr/src/uts/common/io/igb/igb_api.h (revision 12111:a462ebfcbf99)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright(c) 2007-2010 Intel Corporation. All rights reserved.
24  */
25 
26 /*
27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  */
29 
30 /* IntelVersion: 1.53 v3_3_14_3_BHSW1 */
31 
32 #ifndef _IGB_API_H
33 #define	_IGB_API_H
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 #include "igb_hw.h"
40 
41 extern void e1000_init_function_pointers_82575(struct e1000_hw *hw);
42 extern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw);
43 extern void e1000_init_function_pointers_vf(struct e1000_hw *hw);
44 extern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw);
45 
46 s32 e1000_set_mac_type(struct e1000_hw *hw);
47 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
48 s32 e1000_init_mac_params(struct e1000_hw *hw);
49 s32 e1000_init_nvm_params(struct e1000_hw *hw);
50 s32 e1000_init_phy_params(struct e1000_hw *hw);
51 s32 e1000_get_bus_info(struct e1000_hw *hw);
52 void e1000_clear_vfta(struct e1000_hw *hw);
53 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
54 s32 e1000_force_mac_fc(struct e1000_hw *hw);
55 s32 e1000_check_for_link(struct e1000_hw *hw);
56 s32 e1000_reset_hw(struct e1000_hw *hw);
57 s32 e1000_init_hw(struct e1000_hw *hw);
58 s32 e1000_setup_link(struct e1000_hw *hw);
59 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex);
60 s32 e1000_disable_pcie_master(struct e1000_hw *hw);
61 void e1000_config_collision_dist(struct e1000_hw *hw);
62 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
63 void e1000_mta_set(struct e1000_hw *hw, u32 hash_value);
64 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
65 void e1000_update_mc_addr_list(struct e1000_hw *hw,
66     u8 *mc_addr_list, u32 mc_addr_count);
67 s32 e1000_setup_led(struct e1000_hw *hw);
68 s32 e1000_cleanup_led(struct e1000_hw *hw);
69 s32 e1000_check_reset_block(struct e1000_hw *hw);
70 s32 e1000_blink_led(struct e1000_hw *hw);
71 s32 e1000_led_on(struct e1000_hw *hw);
72 s32 e1000_led_off(struct e1000_hw *hw);
73 s32 e1000_id_led_init(struct e1000_hw *hw);
74 void e1000_reset_adaptive(struct e1000_hw *hw);
75 void e1000_update_adaptive(struct e1000_hw *hw);
76 s32 e1000_get_cable_length(struct e1000_hw *hw);
77 s32 e1000_validate_mdi_setting(struct e1000_hw *hw);
78 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
79 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
80 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg,
81     u32 offset, u8 data);
82 s32 e1000_get_phy_info(struct e1000_hw *hw);
83 void e1000_release_phy(struct e1000_hw *hw);
84 s32 e1000_acquire_phy(struct e1000_hw *hw);
85 s32 e1000_phy_hw_reset(struct e1000_hw *hw);
86 s32 e1000_phy_commit(struct e1000_hw *hw);
87 void e1000_power_up_phy(struct e1000_hw *hw);
88 void e1000_power_down_phy(struct e1000_hw *hw);
89 s32 e1000_read_mac_addr(struct e1000_hw *hw);
90 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num);
91 void e1000_reload_nvm(struct e1000_hw *hw);
92 s32 e1000_update_nvm_checksum(struct e1000_hw *hw);
93 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw);
94 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
95 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
96 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
97 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
98 s32 e1000_wait_autoneg(struct e1000_hw *hw);
99 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
100 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
101 bool e1000_check_mng_mode(struct e1000_hw *hw);
102 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
103 s32 e1000_mng_enable_host_if(struct e1000_hw *hw);
104 s32 e1000_mng_host_if_write(struct e1000_hw *hw,
105     u8 *buffer, u16 length, u16 offset, u8 *sum);
106 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
107     struct e1000_host_mng_command_header *hdr);
108 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw,
109     u8 *buffer, u16 length);
110 
111 /*
112  * TBI_ACCEPT macro definition:
113  *
114  * This macro requires:
115  *	adapter = a pointer to struct e1000_hw
116  *	status = the 8 bit status field of the Rx descriptor with EOP set
117  *	error = the 8 bit error field of the Rx descriptor with EOP set
118  *	length = the sum of all the length fields of the Rx descriptors that
119  *		make up the current frame
120  *	last_byte = the last byte of the frame DMAed by the hardware
121  *	max_frame_length = the maximum frame length we want to accept.
122  *	min_frame_length = the minimum frame length we want to accept.
123  *
124  * This macro is a conditional that should be used in the interrupt
125  * handler's Rx processing routine when RxErrors have been detected.
126  *
127  * Typical use:
128  *  ...
129  *  if (TBI_ACCEPT) {
130  *	accept_frame = true;
131  *	e1000_tbi_adjust_stats(adapter, MacAddress);
132  *	frame_length--;
133  *  } else {
134  *	accept_frame = false;
135  *  }
136  *  ...
137  */
138 
139 /* The carrier extension symbol, as received by the NIC. */
140 #define	CARRIER_EXTENSION	0x0F
141 
142 #define	TBI_ACCEPT(a, status, errors, length, last_byte, \
143     min_frame_size, max_frame_size) \
144 	(e1000_tbi_sbp_enabled_82543(a) && \
145 	(((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
146 	((last_byte) == CARRIER_EXTENSION) && \
147 	(((status) & E1000_RXD_STAT_VP) ? \
148 	    (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \
149 	    ((length) <= (max_frame_size + 1))) : \
150 	    (((length) > min_frame_size) && \
151 	    ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1)))))
152 
153 #ifdef __cplusplus
154 }
155 #endif
156 
157 #endif	/* _IGB_API_H */
158