xref: /openbmc/linux/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.h (revision 5ef12cb4a3a78ffb331c03a795a15eea4ae35155)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*******************************************************************************
3 
4   Intel 10 Gigabit PCI Express Linux driver
5   Copyright(c) 1999 - 2016 Intel Corporation.
6 
7   This program is free software; you can redistribute it and/or modify it
8   under the terms and conditions of the GNU General Public License,
9   version 2, as published by the Free Software Foundation.
10 
11   This program is distributed in the hope it will be useful, but WITHOUT
12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14   more details.
15 
16   You should have received a copy of the GNU General Public License along with
17   this program; if not, write to the Free Software Foundation, Inc.,
18   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 
20   The full GNU General Public License is included in this distribution in
21   the file called "COPYING".
22 
23   Contact Information:
24   Linux NICS <linux.nics@intel.com>
25   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
26   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 
28 *******************************************************************************/
29 
30 #ifndef _IXGBE_PHY_H_
31 #define _IXGBE_PHY_H_
32 
33 #include "ixgbe_type.h"
34 #define IXGBE_I2C_EEPROM_DEV_ADDR    0xA0
35 #define IXGBE_I2C_EEPROM_DEV_ADDR2   0xA2
36 
37 /* EEPROM byte offsets */
38 #define IXGBE_SFF_IDENTIFIER		0x0
39 #define IXGBE_SFF_IDENTIFIER_SFP	0x3
40 #define IXGBE_SFF_VENDOR_OUI_BYTE0	0x25
41 #define IXGBE_SFF_VENDOR_OUI_BYTE1	0x26
42 #define IXGBE_SFF_VENDOR_OUI_BYTE2	0x27
43 #define IXGBE_SFF_1GBE_COMP_CODES	0x6
44 #define IXGBE_SFF_10GBE_COMP_CODES	0x3
45 #define IXGBE_SFF_CABLE_TECHNOLOGY	0x8
46 #define IXGBE_SFF_CABLE_SPEC_COMP	0x3C
47 #define IXGBE_SFF_SFF_8472_SWAP		0x5C
48 #define IXGBE_SFF_SFF_8472_COMP		0x5E
49 #define IXGBE_SFF_SFF_8472_OSCB		0x6E
50 #define IXGBE_SFF_SFF_8472_ESCB		0x76
51 #define IXGBE_SFF_IDENTIFIER_QSFP_PLUS	0xD
52 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE0	0xA5
53 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE1	0xA6
54 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE2	0xA7
55 #define IXGBE_SFF_QSFP_CONNECTOR	0x82
56 #define IXGBE_SFF_QSFP_10GBE_COMP	0x83
57 #define IXGBE_SFF_QSFP_1GBE_COMP	0x86
58 #define IXGBE_SFF_QSFP_CABLE_LENGTH	0x92
59 #define IXGBE_SFF_QSFP_DEVICE_TECH	0x93
60 
61 /* Bitmasks */
62 #define IXGBE_SFF_DA_PASSIVE_CABLE		0x4
63 #define IXGBE_SFF_DA_ACTIVE_CABLE		0x8
64 #define IXGBE_SFF_DA_SPEC_ACTIVE_LIMITING	0x4
65 #define IXGBE_SFF_1GBASESX_CAPABLE		0x1
66 #define IXGBE_SFF_1GBASELX_CAPABLE		0x2
67 #define IXGBE_SFF_1GBASET_CAPABLE		0x8
68 #define IXGBE_SFF_10GBASESR_CAPABLE		0x10
69 #define IXGBE_SFF_10GBASELR_CAPABLE		0x20
70 #define IXGBE_SFF_SOFT_RS_SELECT_MASK		0x8
71 #define IXGBE_SFF_SOFT_RS_SELECT_10G		0x8
72 #define IXGBE_SFF_SOFT_RS_SELECT_1G		0x0
73 #define IXGBE_SFF_ADDRESSING_MODE		0x4
74 #define IXGBE_SFF_QSFP_DA_ACTIVE_CABLE		0x1
75 #define IXGBE_SFF_QSFP_DA_PASSIVE_CABLE		0x8
76 #define IXGBE_SFF_QSFP_CONNECTOR_NOT_SEPARABLE	0x23
77 #define IXGBE_SFF_QSFP_TRANSMITER_850NM_VCSEL	0x0
78 #define IXGBE_I2C_EEPROM_READ_MASK		0x100
79 #define IXGBE_I2C_EEPROM_STATUS_MASK		0x3
80 #define IXGBE_I2C_EEPROM_STATUS_NO_OPERATION	0x0
81 #define IXGBE_I2C_EEPROM_STATUS_PASS		0x1
82 #define IXGBE_I2C_EEPROM_STATUS_FAIL		0x2
83 #define IXGBE_I2C_EEPROM_STATUS_IN_PROGRESS	0x3
84 #define IXGBE_CS4227				0xBE    /* CS4227 address */
85 #define IXGBE_CS4227_GLOBAL_ID_LSB		0
86 #define IXGBE_CS4227_GLOBAL_ID_MSB		1
87 #define IXGBE_CS4227_SCRATCH			2
88 #define IXGBE_CS4227_EFUSE_PDF_SKU		0x19F
89 #define IXGBE_CS4223_SKU_ID			0x0010  /* Quad port */
90 #define IXGBE_CS4227_SKU_ID			0x0014  /* Dual port */
91 #define IXGBE_CS4227_RESET_PENDING		0x1357
92 #define IXGBE_CS4227_RESET_COMPLETE		0x5AA5
93 #define IXGBE_CS4227_RETRIES			15
94 #define IXGBE_CS4227_EFUSE_STATUS		0x0181
95 #define IXGBE_CS4227_LINE_SPARE22_MSB		0x12AD	/* Reg to set speed */
96 #define IXGBE_CS4227_LINE_SPARE24_LSB		0x12B0	/* Reg to set EDC */
97 #define IXGBE_CS4227_HOST_SPARE22_MSB		0x1AAD	/* Reg to set speed */
98 #define IXGBE_CS4227_HOST_SPARE24_LSB		0x1AB0	/* Reg to program EDC */
99 #define IXGBE_CS4227_EEPROM_STATUS		0x5001
100 #define IXGBE_CS4227_EEPROM_LOAD_OK		0x0001
101 #define IXGBE_CS4227_SPEED_1G			0x8000
102 #define IXGBE_CS4227_SPEED_10G			0
103 #define IXGBE_CS4227_EDC_MODE_CX1		0x0002
104 #define IXGBE_CS4227_EDC_MODE_SR		0x0004
105 #define IXGBE_CS4227_EDC_MODE_DIAG		0x0008
106 #define IXGBE_CS4227_RESET_HOLD			500	/* microseconds */
107 #define IXGBE_CS4227_RESET_DELAY		500	/* milliseconds */
108 #define IXGBE_CS4227_CHECK_DELAY		30	/* milliseconds */
109 #define IXGBE_PE				0xE0	/* Port expander addr */
110 #define IXGBE_PE_OUTPUT				1	/* Output reg offset */
111 #define IXGBE_PE_CONFIG				3	/* Config reg offset */
112 #define IXGBE_PE_BIT1				BIT(1)
113 
114 /* Flow control defines */
115 #define IXGBE_TAF_SYM_PAUSE                  0x400
116 #define IXGBE_TAF_ASM_PAUSE                  0x800
117 
118 /* Bit-shift macros */
119 #define IXGBE_SFF_VENDOR_OUI_BYTE0_SHIFT    24
120 #define IXGBE_SFF_VENDOR_OUI_BYTE1_SHIFT    16
121 #define IXGBE_SFF_VENDOR_OUI_BYTE2_SHIFT    8
122 
123 /* Vendor OUIs: format of OUI is 0x[byte0][byte1][byte2][00] */
124 #define IXGBE_SFF_VENDOR_OUI_TYCO     0x00407600
125 #define IXGBE_SFF_VENDOR_OUI_FTL      0x00906500
126 #define IXGBE_SFF_VENDOR_OUI_AVAGO    0x00176A00
127 #define IXGBE_SFF_VENDOR_OUI_INTEL    0x001B2100
128 
129 /* I2C SDA and SCL timing parameters for standard mode */
130 #define IXGBE_I2C_T_HD_STA  4
131 #define IXGBE_I2C_T_LOW     5
132 #define IXGBE_I2C_T_HIGH    4
133 #define IXGBE_I2C_T_SU_STA  5
134 #define IXGBE_I2C_T_HD_DATA 5
135 #define IXGBE_I2C_T_SU_DATA 1
136 #define IXGBE_I2C_T_RISE    1
137 #define IXGBE_I2C_T_FALL    1
138 #define IXGBE_I2C_T_SU_STO  4
139 #define IXGBE_I2C_T_BUF     5
140 
141 #define IXGBE_SFP_DETECT_RETRIES	2
142 
143 #define IXGBE_TN_LASI_STATUS_REG        0x9005
144 #define IXGBE_TN_LASI_STATUS_TEMP_ALARM 0x0008
145 
146 /* SFP+ SFF-8472 Compliance code */
147 #define IXGBE_SFF_SFF_8472_UNSUP      0x00
148 
149 s32 ixgbe_identify_phy_generic(struct ixgbe_hw *hw);
150 s32 ixgbe_reset_phy_generic(struct ixgbe_hw *hw);
151 s32 ixgbe_read_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
152 			       u32 device_type, u16 *phy_data);
153 s32 ixgbe_write_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
154 				u32 device_type, u16 phy_data);
155 s32 ixgbe_read_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr,
156 			   u32 device_type, u16 *phy_data);
157 s32 ixgbe_write_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr,
158 			    u32 device_type, u16 phy_data);
159 s32 ixgbe_setup_phy_link_generic(struct ixgbe_hw *hw);
160 s32 ixgbe_setup_phy_link_speed_generic(struct ixgbe_hw *hw,
161 				       ixgbe_link_speed speed,
162 				       bool autoneg_wait_to_complete);
163 s32 ixgbe_get_copper_link_capabilities_generic(struct ixgbe_hw *hw,
164 					       ixgbe_link_speed *speed,
165 					       bool *autoneg);
166 bool ixgbe_check_reset_blocked(struct ixgbe_hw *hw);
167 
168 /* PHY specific */
169 s32 ixgbe_check_phy_link_tnx(struct ixgbe_hw *hw,
170 			     ixgbe_link_speed *speed,
171 			     bool *link_up);
172 s32 ixgbe_setup_phy_link_tnx(struct ixgbe_hw *hw);
173 
174 s32 ixgbe_reset_phy_nl(struct ixgbe_hw *hw);
175 s32 ixgbe_set_copper_phy_power(struct ixgbe_hw *hw, bool on);
176 s32 ixgbe_identify_module_generic(struct ixgbe_hw *hw);
177 s32 ixgbe_identify_sfp_module_generic(struct ixgbe_hw *hw);
178 s32 ixgbe_get_sfp_init_sequence_offsets(struct ixgbe_hw *hw,
179 					u16 *list_offset,
180 					u16 *data_offset);
181 s32 ixgbe_tn_check_overtemp(struct ixgbe_hw *hw);
182 s32 ixgbe_read_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,
183 				u8 dev_addr, u8 *data);
184 s32 ixgbe_read_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,
185 					 u8 dev_addr, u8 *data);
186 s32 ixgbe_write_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,
187 				 u8 dev_addr, u8 data);
188 s32 ixgbe_write_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,
189 					  u8 dev_addr, u8 data);
190 s32 ixgbe_read_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,
191 				  u8 *eeprom_data);
192 s32 ixgbe_read_i2c_sff8472_generic(struct ixgbe_hw *hw, u8 byte_offset,
193 				   u8 *sff8472_data);
194 s32 ixgbe_write_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,
195 				   u8 eeprom_data);
196 s32 ixgbe_read_i2c_combined_generic_int(struct ixgbe_hw *, u8 addr, u16 reg,
197 					u16 *val, bool lock);
198 s32 ixgbe_write_i2c_combined_generic_int(struct ixgbe_hw *, u8 addr, u16 reg,
199 					 u16 val, bool lock);
200 #endif /* _IXGBE_PHY_H_ */
201