ixgbe_phy.h revision 1.11 1 /* $NetBSD: ixgbe_phy.h,v 1.11 2018/04/04 08:13:07 msaitoh Exp $ */
2
3 /******************************************************************************
4 SPDX-License-Identifier: BSD-3-Clause
5
6 Copyright (c) 2001-2017, Intel Corporation
7 All rights reserved.
8
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
11
12 1. Redistributions of source code must retain the above copyright notice,
13 this list of conditions and the following disclaimer.
14
15 2. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions and the following disclaimer in the
17 documentation and/or other materials provided with the distribution.
18
19 3. Neither the name of the Intel Corporation nor the names of its
20 contributors may be used to endorse or promote products derived from
21 this software without specific prior written permission.
22
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 POSSIBILITY OF SUCH DAMAGE.
34
35 ******************************************************************************/
36 /*$FreeBSD: head/sys/dev/ixgbe/ixgbe_phy.h 326022 2017-11-20 19:36:21Z pfg $*/
37
38 #ifndef _IXGBE_PHY_H_
39 #define _IXGBE_PHY_H_
40
41 #include "ixgbe_type.h"
42 #define IXGBE_I2C_EEPROM_DEV_ADDR 0xA0
43 #define IXGBE_I2C_EEPROM_DEV_ADDR2 0xA2
44 #define IXGBE_I2C_EEPROM_BANK_LEN 0xFF
45
46 /* EEPROM byte offsets */
47 #define IXGBE_SFF_IDENTIFIER 0x0
48 #define IXGBE_SFF_IDENTIFIER_SFP 0x3
49 #define IXGBE_SFF_VENDOR_OUI_BYTE0 0x25
50 #define IXGBE_SFF_VENDOR_OUI_BYTE1 0x26
51 #define IXGBE_SFF_VENDOR_OUI_BYTE2 0x27
52 #define IXGBE_SFF_1GBE_COMP_CODES 0x6
53 #define IXGBE_SFF_10GBE_COMP_CODES 0x3
54 #define IXGBE_SFF_CABLE_TECHNOLOGY 0x8
55 #define IXGBE_SFF_CABLE_SPEC_COMP 0x3C
56 #define IXGBE_SFF_SFF_8472_SWAP 0x5C
57 #define IXGBE_SFF_SFF_8472_COMP 0x5E
58 #define IXGBE_SFF_SFF_8472_OSCB 0x6E
59 #define IXGBE_SFF_SFF_8472_ESCB 0x76
60 #define IXGBE_SFF_IDENTIFIER_QSFP_PLUS 0xD
61 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE0 0xA5
62 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE1 0xA6
63 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE2 0xA7
64 #define IXGBE_SFF_QSFP_CONNECTOR 0x82
65 #define IXGBE_SFF_QSFP_10GBE_COMP 0x83
66 #define IXGBE_SFF_QSFP_1GBE_COMP 0x86
67 #define IXGBE_SFF_QSFP_CABLE_LENGTH 0x92
68 #define IXGBE_SFF_QSFP_DEVICE_TECH 0x93
69
70 /* Bitmasks */
71 #define IXGBE_SFF_DA_PASSIVE_CABLE 0x4
72 #define IXGBE_SFF_DA_ACTIVE_CABLE 0x8
73 #define IXGBE_SFF_DA_SPEC_ACTIVE_LIMITING 0x4
74 #define IXGBE_SFF_1GBASESX_CAPABLE 0x1
75 #define IXGBE_SFF_1GBASELX_CAPABLE 0x2
76 #define IXGBE_SFF_1GBASET_CAPABLE 0x8
77 #define IXGBE_SFF_10GBASESR_CAPABLE 0x10
78 #define IXGBE_SFF_10GBASELR_CAPABLE 0x20
79 #define IXGBE_SFF_SOFT_RS_SELECT_MASK 0x8
80 #define IXGBE_SFF_SOFT_RS_SELECT_10G 0x8
81 #define IXGBE_SFF_SOFT_RS_SELECT_1G 0x0
82 #define IXGBE_SFF_ADDRESSING_MODE 0x4
83 #define IXGBE_SFF_QSFP_DA_ACTIVE_CABLE 0x1
84 #define IXGBE_SFF_QSFP_DA_PASSIVE_CABLE 0x8
85 #define IXGBE_SFF_QSFP_CONNECTOR_NOT_SEPARABLE 0x23
86 #define IXGBE_SFF_QSFP_TRANSMITER_850NM_VCSEL 0x0
87 #define IXGBE_I2C_EEPROM_READ_MASK 0x100
88 #define IXGBE_I2C_EEPROM_STATUS_MASK 0x3
89 #define IXGBE_I2C_EEPROM_STATUS_NO_OPERATION 0x0
90 #define IXGBE_I2C_EEPROM_STATUS_PASS 0x1
91 #define IXGBE_I2C_EEPROM_STATUS_FAIL 0x2
92 #define IXGBE_I2C_EEPROM_STATUS_IN_PROGRESS 0x3
93
94 #define IXGBE_CS4227 0xBE /* CS4227 address */
95 #define IXGBE_CS4227_GLOBAL_ID_LSB 0
96 #define IXGBE_CS4227_GLOBAL_ID_MSB 1
97 #define IXGBE_CS4227_SCRATCH 2
98 #define IXGBE_CS4227_GLOBAL_ID_VALUE 0x03E5
99 #define IXGBE_CS4227_EFUSE_PDF_SKU 0x19F
100 #define IXGBE_CS4223_SKU_ID 0x0010 /* Quad port */
101 #define IXGBE_CS4227_SKU_ID 0x0014 /* Dual port */
102 #define IXGBE_CS4227_RESET_PENDING 0x1357
103 #define IXGBE_CS4227_RESET_COMPLETE 0x5AA5
104 #define IXGBE_CS4227_RETRIES 15
105 #define IXGBE_CS4227_EFUSE_STATUS 0x0181
106 #define IXGBE_CS4227_LINE_SPARE22_MSB 0x12AD /* Reg to program speed */
107 #define IXGBE_CS4227_LINE_SPARE24_LSB 0x12B0 /* Reg to program EDC */
108 #define IXGBE_CS4227_HOST_SPARE22_MSB 0x1AAD /* Reg to program speed */
109 #define IXGBE_CS4227_HOST_SPARE24_LSB 0x1AB0 /* Reg to program EDC */
110 #define IXGBE_CS4227_EEPROM_STATUS 0x5001
111 #define IXGBE_CS4227_EEPROM_LOAD_OK 0x0001
112 #define IXGBE_CS4227_SPEED_1G 0x8000
113 #define IXGBE_CS4227_SPEED_10G 0
114 #define IXGBE_CS4227_EDC_MODE_CX1 0x0002
115 #define IXGBE_CS4227_EDC_MODE_SR 0x0004
116 #define IXGBE_CS4227_EDC_MODE_DIAG 0x0008
117 #define IXGBE_CS4227_RESET_HOLD 500 /* microseconds */
118 #define IXGBE_CS4227_RESET_DELAY 450 /* milliseconds */
119 #define IXGBE_CS4227_CHECK_DELAY 30 /* milliseconds */
120 #define IXGBE_PE 0xE0 /* Port expander address */
121 #define IXGBE_PE_OUTPUT 1 /* Output register offset */
122 #define IXGBE_PE_CONFIG 3 /* Config register offset */
123 #define IXGBE_PE_BIT1 (1 << 1)
124
125 /* Flow control defines */
126 #define IXGBE_TAF_SYM_PAUSE 0x400
127 #define IXGBE_TAF_ASM_PAUSE 0x800
128
129 /* Bit-shift macros */
130 #define IXGBE_SFF_VENDOR_OUI_BYTE0_SHIFT 24
131 #define IXGBE_SFF_VENDOR_OUI_BYTE1_SHIFT 16
132 #define IXGBE_SFF_VENDOR_OUI_BYTE2_SHIFT 8
133
134 /* Vendor OUIs: format of OUI is 0x[byte0][byte1][byte2][00] */
135 #define IXGBE_SFF_VENDOR_OUI_TYCO 0x00407600
136 #define IXGBE_SFF_VENDOR_OUI_FTL 0x00906500
137 #define IXGBE_SFF_VENDOR_OUI_AVAGO 0x00176A00
138 #define IXGBE_SFF_VENDOR_OUI_INTEL 0x001B2100
139
140 /* I2C SDA and SCL timing parameters for standard mode */
141 #define IXGBE_I2C_T_HD_STA 4
142 #define IXGBE_I2C_T_LOW 5
143 #define IXGBE_I2C_T_HIGH 4
144 #define IXGBE_I2C_T_SU_STA 5
145 #define IXGBE_I2C_T_HD_DATA 5
146 #define IXGBE_I2C_T_SU_DATA 1
147 #define IXGBE_I2C_T_RISE 1
148 #define IXGBE_I2C_T_FALL 1
149 #define IXGBE_I2C_T_SU_STO 4
150 #define IXGBE_I2C_T_BUF 5
151
152 #ifndef IXGBE_SFP_DETECT_RETRIES
153 #define IXGBE_SFP_DETECT_RETRIES 10
154
155 #endif /* IXGBE_SFP_DETECT_RETRIES */
156 #define IXGBE_TN_LASI_STATUS_REG 0x9005
157 #define IXGBE_TN_LASI_STATUS_TEMP_ALARM 0x0008
158
159 /* SFP+ SFF-8472 Compliance */
160 #define IXGBE_SFF_SFF_8472_UNSUP 0x00
161
162 s32 ixgbe_init_phy_ops_generic(struct ixgbe_hw *hw);
163 bool ixgbe_validate_phy_addr(struct ixgbe_hw *hw, u32 phy_addr);
164 enum ixgbe_phy_type ixgbe_get_phy_type_from_id(u32 phy_id);
165 s32 ixgbe_get_phy_id(struct ixgbe_hw *hw);
166 s32 ixgbe_identify_phy_generic(struct ixgbe_hw *hw);
167 s32 ixgbe_reset_phy_generic(struct ixgbe_hw *hw);
168 s32 ixgbe_read_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
169 u16 *phy_data);
170 s32 ixgbe_write_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
171 u16 phy_data);
172 s32 ixgbe_read_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
173 u32 device_type, u16 *phy_data);
174 s32 ixgbe_write_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
175 u32 device_type, u16 phy_data);
176 s32 ixgbe_setup_phy_link_generic(struct ixgbe_hw *hw);
177 s32 ixgbe_setup_phy_link_speed_generic(struct ixgbe_hw *hw,
178 ixgbe_link_speed speed,
179 bool autoneg_wait_to_complete);
180 s32 ixgbe_get_copper_link_capabilities_generic(struct ixgbe_hw *hw,
181 ixgbe_link_speed *speed,
182 bool *autoneg);
183 s32 ixgbe_check_reset_blocked(struct ixgbe_hw *hw);
184
185 /* PHY specific */
186 s32 ixgbe_check_phy_link_tnx(struct ixgbe_hw *hw,
187 ixgbe_link_speed *speed,
188 bool *link_up);
189 s32 ixgbe_setup_phy_link_tnx(struct ixgbe_hw *hw);
190 s32 ixgbe_get_phy_firmware_version_tnx(struct ixgbe_hw *hw,
191 u16 *firmware_version);
192 s32 ixgbe_get_phy_firmware_version_generic(struct ixgbe_hw *hw,
193 u16 *firmware_version);
194
195 s32 ixgbe_reset_phy_nl(struct ixgbe_hw *hw);
196 s32 ixgbe_set_copper_phy_power(struct ixgbe_hw *hw, bool on);
197 s32 ixgbe_identify_module_generic(struct ixgbe_hw *hw);
198 s32 ixgbe_identify_sfp_module_generic(struct ixgbe_hw *hw);
199 u64 ixgbe_get_supported_phy_sfp_layer_generic(struct ixgbe_hw *hw);
200 s32 ixgbe_identify_qsfp_module_generic(struct ixgbe_hw *hw);
201 s32 ixgbe_get_sfp_init_sequence_offsets(struct ixgbe_hw *hw,
202 u16 *list_offset,
203 u16 *data_offset);
204 s32 ixgbe_tn_check_overtemp(struct ixgbe_hw *hw);
205 s32 ixgbe_read_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,
206 u8 dev_addr, u8 *data);
207 s32 ixgbe_read_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,
208 u8 dev_addr, u8 *data);
209 s32 ixgbe_write_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,
210 u8 dev_addr, u8 data);
211 s32 ixgbe_write_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,
212 u8 dev_addr, u8 data);
213 s32 ixgbe_read_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,
214 u8 *eeprom_data);
215 s32 ixgbe_write_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,
216 u8 eeprom_data);
217 void ixgbe_i2c_bus_clear(struct ixgbe_hw *hw);
218 s32 ixgbe_read_i2c_combined_generic_int(struct ixgbe_hw *, u8 addr, u16 reg,
219 u16 *val, bool lock);
220 s32 ixgbe_write_i2c_combined_generic_int(struct ixgbe_hw *, u8 addr, u16 reg,
221 u16 val, bool lock);
222 #endif /* _IXGBE_PHY_H_ */
223