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