drivers/net/ixgbe/base/ixgbe_phy.h

   1 /*******************************************************************************
   2
   3 Copyright (c) 2001-2015, 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
  34 #ifndef _IXGBE_PHY_H_
  35 #define _IXGBE_PHY_H_
  36
  37 #include "ixgbe_type.h"
  38 #define IXGBE_I2C_EEPROM_DEV_ADDR       0xA0
  39 #define IXGBE_I2C_EEPROM_DEV_ADDR2      0xA2
  40 #define IXGBE_I2C_EEPROM_BANK_LEN       0xFF
  41
  42 /* EEPROM byte offsets */
  43 #define IXGBE_SFF_IDENTIFIER            0x0
  44 #define IXGBE_SFF_IDENTIFIER_SFP        0x3
  45 #define IXGBE_SFF_VENDOR_OUI_BYTE0      0x25
  46 #define IXGBE_SFF_VENDOR_OUI_BYTE1      0x26
  47 #define IXGBE_SFF_VENDOR_OUI_BYTE2      0x27
  48 #define IXGBE_SFF_1GBE_COMP_CODES       0x6
  49 #define IXGBE_SFF_10GBE_COMP_CODES      0x3
  50 #define IXGBE_SFF_CABLE_TECHNOLOGY      0x8
  51 #define IXGBE_SFF_CABLE_SPEC_COMP       0x3C
  52 #define IXGBE_SFF_SFF_8472_SWAP         0x5C
  53 #define IXGBE_SFF_SFF_8472_COMP         0x5E
  54 #define IXGBE_SFF_SFF_8472_OSCB         0x6E
  55 #define IXGBE_SFF_SFF_8472_ESCB         0x76
  56 #define IXGBE_SFF_IDENTIFIER_QSFP_PLUS  0xD
  57 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE0 0xA5
  58 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE1 0xA6
  59 #define IXGBE_SFF_QSFP_VENDOR_OUI_BYTE2 0xA7
  60 #define IXGBE_SFF_QSFP_CONNECTOR        0x82
  61 #define IXGBE_SFF_QSFP_10GBE_COMP       0x83
  62 #define IXGBE_SFF_QSFP_1GBE_COMP        0x86
  63 #define IXGBE_SFF_QSFP_CABLE_LENGTH     0x92
  64 #define IXGBE_SFF_QSFP_DEVICE_TECH      0x93
  65
  66 /* Bitmasks */
  67 #define IXGBE_SFF_DA_PASSIVE_CABLE      0x4
  68 #define IXGBE_SFF_DA_ACTIVE_CABLE       0x8
  69 #define IXGBE_SFF_DA_SPEC_ACTIVE_LIMITING       0x4
  70 #define IXGBE_SFF_1GBASESX_CAPABLE      0x1
  71 #define IXGBE_SFF_1GBASELX_CAPABLE      0x2
  72 #define IXGBE_SFF_1GBASET_CAPABLE       0x8
  73 #define IXGBE_SFF_10GBASESR_CAPABLE     0x10
  74 #define IXGBE_SFF_10GBASELR_CAPABLE     0x20
  75 #define IXGBE_SFF_SOFT_RS_SELECT_MASK   0x8
  76 #define IXGBE_SFF_SOFT_RS_SELECT_10G    0x8
  77 #define IXGBE_SFF_SOFT_RS_SELECT_1G     0x0
  78 #define IXGBE_SFF_ADDRESSING_MODE       0x4
  79 #define IXGBE_SFF_QSFP_DA_ACTIVE_CABLE  0x1
  80 #define IXGBE_SFF_QSFP_DA_PASSIVE_CABLE 0x8
  81 #define IXGBE_SFF_QSFP_CONNECTOR_NOT_SEPARABLE  0x23
  82 #define IXGBE_SFF_QSFP_TRANSMITER_850NM_VCSEL   0x0
  83 #define IXGBE_I2C_EEPROM_READ_MASK      0x100
  84 #define IXGBE_I2C_EEPROM_STATUS_MASK    0x3
  85 #define IXGBE_I2C_EEPROM_STATUS_NO_OPERATION    0x0
  86 #define IXGBE_I2C_EEPROM_STATUS_PASS    0x1
  87 #define IXGBE_I2C_EEPROM_STATUS_FAIL    0x2
  88 #define IXGBE_I2C_EEPROM_STATUS_IN_PROGRESS     0x3
  89
  90 #define IXGBE_CS4227                    0xBE    /* CS4227 address */
  91 #define IXGBE_CS4227_GLOBAL_ID_LSB      0
  92 #define IXGBE_CS4227_GLOBAL_ID_MSB      1
  93 #define IXGBE_CS4227_SCRATCH            2
  94 #define IXGBE_CS4227_GLOBAL_ID_VALUE    0x03E5
  95 #define IXGBE_CS4227_EFUSE_PDF_SKU      0x19F
  96 #define IXGBE_CS4223_SKU_ID             0x0010  /* Quad port */
  97 #define IXGBE_CS4227_SKU_ID             0x0014  /* Dual port */
  98 #define IXGBE_CS4227_RESET_PENDING      0x1357
  99 #define IXGBE_CS4227_RESET_COMPLETE     0x5AA5
 100 #define IXGBE_CS4227_RETRIES            15
 101 #define IXGBE_CS4227_EFUSE_STATUS       0x0181
 102 #define IXGBE_CS4227_LINE_SPARE22_MSB   0x12AD  /* Reg to program speed */
 103 #define IXGBE_CS4227_LINE_SPARE24_LSB   0x12B0  /* Reg to program EDC */
 104 #define IXGBE_CS4227_HOST_SPARE22_MSB   0x1AAD  /* Reg to program speed */
 105 #define IXGBE_CS4227_HOST_SPARE24_LSB   0x1AB0  /* Reg to program EDC */
 106 #define IXGBE_CS4227_EEPROM_STATUS      0x5001
 107 #define IXGBE_CS4227_EEPROM_LOAD_OK     0x0001
 108 #define IXGBE_CS4227_SPEED_1G           0x8000
 109 #define IXGBE_CS4227_SPEED_10G          0
 110 #define IXGBE_CS4227_EDC_MODE_CX1       0x0002
 111 #define IXGBE_CS4227_EDC_MODE_SR        0x0004
 112 #define IXGBE_CS4227_EDC_MODE_DIAG      0x0008
 113 #define IXGBE_CS4227_RESET_HOLD         500     /* microseconds */
 114 #define IXGBE_CS4227_RESET_DELAY        450     /* milliseconds */
 115 #define IXGBE_CS4227_CHECK_DELAY        30      /* milliseconds */
 116 #define IXGBE_PE                        0xE0    /* Port expander address */
 117 #define IXGBE_PE_OUTPUT                 1       /* Output register offset */
 118 #define IXGBE_PE_CONFIG                 3       /* Config register offset */
 119 #define IXGBE_PE_BIT1                   (1 << 1)
 120
 121 /* Flow control defines */
 122 #define IXGBE_TAF_SYM_PAUSE             0x400
 123 #define IXGBE_TAF_ASM_PAUSE             0x800
 124
 125 /* Bit-shift macros */
 126 #define IXGBE_SFF_VENDOR_OUI_BYTE0_SHIFT        24
 127 #define IXGBE_SFF_VENDOR_OUI_BYTE1_SHIFT        16
 128 #define IXGBE_SFF_VENDOR_OUI_BYTE2_SHIFT        8
 129
 130 /* Vendor OUIs: format of OUI is 0x[byte0][byte1][byte2][00] */
 131 #define IXGBE_SFF_VENDOR_OUI_TYCO       0x00407600
 132 #define IXGBE_SFF_VENDOR_OUI_FTL        0x00906500
 133 #define IXGBE_SFF_VENDOR_OUI_AVAGO      0x00176A00
 134 #define IXGBE_SFF_VENDOR_OUI_INTEL      0x001B2100
 135
 136 /* I2C SDA and SCL timing parameters for standard mode */
 137 #define IXGBE_I2C_T_HD_STA      4
 138 #define IXGBE_I2C_T_LOW         5
 139 #define IXGBE_I2C_T_HIGH        4
 140 #define IXGBE_I2C_T_SU_STA      5
 141 #define IXGBE_I2C_T_HD_DATA     5
 142 #define IXGBE_I2C_T_SU_DATA     1
 143 #define IXGBE_I2C_T_RISE        1
 144 #define IXGBE_I2C_T_FALL        1
 145 #define IXGBE_I2C_T_SU_STO      4
 146 #define IXGBE_I2C_T_BUF         5
 147
 148 #ifndef IXGBE_SFP_DETECT_RETRIES
 149 #define IXGBE_SFP_DETECT_RETRIES        10
 150
 151 #endif /* IXGBE_SFP_DETECT_RETRIES */
 152 #define IXGBE_TN_LASI_STATUS_REG        0x9005
 153 #define IXGBE_TN_LASI_STATUS_TEMP_ALARM 0x0008
 154
 155 /* SFP+ SFF-8472 Compliance */
 156 #define IXGBE_SFF_SFF_8472_UNSUP        0x00
 157
 158 /* More phy definitions */
 159 #define IXGBE_M88E1500_COPPER_CTRL              0       /* Page 0 reg */
 160 #define IXGBE_M88E1500_COPPER_CTRL_RESET        (1u << 15)
 161 #define IXGBE_M88E1500_COPPER_CTRL_AN_EN        (1u << 12)
 162 #define IXGBE_M88E1500_COPPER_CTRL_POWER_DOWN   (1u << 11)
 163 #define IXGBE_M88E1500_COPPER_CTRL_RESTART_AN   (1u << 9)
 164 #define IXGBE_M88E1500_COPPER_CTRL_FULL_DUPLEX  (1u << 8)
 165 #define IXGBE_M88E1500_COPPER_CTRL_SPEED_MSB    (1u << 6)
 166 #define IXGBE_M88E1500_COPPER_STATUS            1       /* Page 0 reg */
 167 #define IXGBE_M88E1500_COPPER_STATUS_AN_DONE    (1u << 5)
 168 #define IXGBE_M88E1500_COPPER_AN                4       /* Page 0 reg */
 169 #define IXGBE_M88E1500_COPPER_AN_AS_PAUSE       (1u << 11)
 170 #define IXGBE_M88E1500_COPPER_AN_PAUSE          (1u << 10)
 171 #define IXGBE_M88E1500_COPPER_AN_T4             (1u << 9)
 172 #define IXGBE_M88E1500_COPPER_AN_100TX_FD       (1u << 8)
 173 #define IXGBE_M88E1500_COPPER_AN_100TX_HD       (1u << 7)
 174 #define IXGBE_M88E1500_COPPER_AN_10TX_FD        (1u << 6)
 175 #define IXGBE_M88E1500_COPPER_AN_10TX_HD        (1u << 5)
 176 #define IXGBE_M88E1500_COPPER_AN_LP_ABILITY     5       /* Page 0 reg */
 177 #define IXGBE_M88E1500_COPPER_AN_LP_AS_PAUSE    (1u << 11)
 178 #define IXGBE_M88E1500_COPPER_AN_LP_PAUSE       (1u << 10)
 179 #define IXGBE_M88E1500_1000T_CTRL               9       /* Page 0 reg */
 180 /* 1=Configure PHY as Master 0=Configure PHY as Slave */
 181 #define IXGBE_M88E1500_1000T_CTRL_MS_VALUE      (1u << 11)
 182 #define IXGBE_M88E1500_1000T_CTRL_1G_FD         (1u << 9)
 183 /* 1=Master/Slave manual config value 0=Automatic Master/Slave config */
 184 #define IXGBE_M88E1500_1000T_CTRL_MS_ENABLE     (1u << 12)
 185 #define IXGBE_M88E1500_1000T_CTRL_FULL_DUPLEX   (1u << 9)
 186 #define IXGBE_M88E1500_1000T_CTRL_HALF_DUPLEX   (1u << 8)
 187 #define IXGBE_M88E1500_1000T_STATUS             10      /* Page 0 reg */
 188 #define IXGBE_M88E1500_AUTO_COPPER_SGMII        0x2
 189 #define IXGBE_M88E1500_AUTO_COPPER_BASEX        0x3
 190 #define IXGBE_M88E1500_STATUS_LINK              (1u << 2) /* Interface Link Bit */
 191 #define IXGBE_M88E1500_MAC_CTRL_1               16      /* Page 0 reg */
 192 #define IXGBE_M88E1500_MAC_CTRL_1_MODE_MASK     0x0380 /* Mode Select */
 193 #define IXGBE_M88E1500_MAC_CTRL_1_DWN_SHIFT     12
 194 #define IXGBE_M88E1500_MAC_CTRL_1_DWN_4X        3u
 195 #define IXGBE_M88E1500_MAC_CTRL_1_ED_SHIFT      8
 196 #define IXGBE_M88E1500_MAC_CTRL_1_ED_TM         3u
 197 #define IXGBE_M88E1500_MAC_CTRL_1_MDIX_SHIFT    5
 198 #define IXGBE_M88E1500_MAC_CTRL_1_MDIX_AUTO     3u
 199 #define IXGBE_M88E1500_MAC_CTRL_1_POWER_DOWN    (1u << 2)
 200 #define IXGBE_M88E1500_PHY_SPEC_STATUS          17      /* Page 0 reg */
 201 #define IXGBE_M88E1500_PHY_SPEC_STATUS_SPEED_SHIFT      14
 202 #define IXGBE_M88E1500_PHY_SPEC_STATUS_SPEED_MASK       3u
 203 #define IXGBE_M88E1500_PHY_SPEC_STATUS_SPEED_10         0u
 204 #define IXGBE_M88E1500_PHY_SPEC_STATUS_SPEED_100        1u
 205 #define IXGBE_M88E1500_PHY_SPEC_STATUS_SPEED_1000       2u
 206 #define IXGBE_M88E1500_PHY_SPEC_STATUS_DUPLEX           (1u << 13)
 207 #define IXGBE_M88E1500_PHY_SPEC_STATUS_RESOLVED         (1u << 11)
 208 #define IXGBE_M88E1500_PHY_SPEC_STATUS_LINK             (1u << 10)
 209 #define IXGBE_M88E1500_PAGE_ADDR                22      /* All pages reg */
 210 #define IXGBE_M88E1500_FIBER_CTRL               0       /* Page 1 reg */
 211 #define IXGBE_M88E1500_FIBER_CTRL_RESET         (1u << 15)
 212 #define IXGBE_M88E1500_FIBER_CTRL_SPEED_LSB     (1u << 13)
 213 #define IXGBE_M88E1500_FIBER_CTRL_AN_EN         (1u << 12)
 214 #define IXGBE_M88E1500_FIBER_CTRL_POWER_DOWN    (1u << 11)
 215 #define IXGBE_M88E1500_FIBER_CTRL_DUPLEX_FULL   (1u << 8)
 216 #define IXGBE_M88E1500_FIBER_CTRL_SPEED_MSB     (1u << 6)
 217 #define IXGBE_M88E1500_MAC_SPEC_CTRL            16      /* Page 2 reg */
 218 #define IXGBE_M88E1500_MAC_SPEC_CTRL_POWER_DOWN (1u << 3)
 219 #define IXGBE_M88E1500_EEE_CTRL_1               0       /* Page 18 reg */
 220 #define IXGBE_M88E1500_EEE_CTRL_1_MS            (1u << 0) /* EEE Master/Slave */
 221 #define IXGBE_M88E1500_GEN_CTRL                 20      /* Page 18 reg */
 222 #define IXGBE_M88E1500_GEN_CTRL_RESET           (1u << 15)
 223 #define IXGBE_M88E1500_GEN_CTRL_MODE_SGMII_COPPER       1u /* Mode bits 0-2 */
 224
 225 s32 ixgbe_init_phy_ops_generic(struct ixgbe_hw *hw);
 226 bool ixgbe_validate_phy_addr(struct ixgbe_hw *hw, u32 phy_addr);
 227 enum ixgbe_phy_type ixgbe_get_phy_type_from_id(u32 phy_id);
 228 s32 ixgbe_get_phy_id(struct ixgbe_hw *hw);
 229 s32 ixgbe_identify_phy_generic(struct ixgbe_hw *hw);
 230 s32 ixgbe_reset_phy_generic(struct ixgbe_hw *hw);
 231 s32 ixgbe_read_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
 232                            u16 *phy_data);
 233 s32 ixgbe_write_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
 234                             u16 phy_data);
 235 s32 ixgbe_read_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
 236                                u32 device_type, u16 *phy_data);
 237 s32 ixgbe_write_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
 238                                 u32 device_type, u16 phy_data);
 239 s32 ixgbe_setup_phy_link_generic(struct ixgbe_hw *hw);
 240 s32 ixgbe_setup_phy_link_speed_generic(struct ixgbe_hw *hw,
 241                                        ixgbe_link_speed speed,
 242                                        bool autoneg_wait_to_complete);
 243 s32 ixgbe_get_copper_link_capabilities_generic(struct ixgbe_hw *hw,
 244                                                ixgbe_link_speed *speed,
 245                                                bool *autoneg);
 246 s32 ixgbe_check_reset_blocked(struct ixgbe_hw *hw);
 247
 248 /* PHY specific */
 249 s32 ixgbe_check_phy_link_tnx(struct ixgbe_hw *hw,
 250                              ixgbe_link_speed *speed,
 251                              bool *link_up);
 252 s32 ixgbe_setup_phy_link_tnx(struct ixgbe_hw *hw);
 253 s32 ixgbe_get_phy_firmware_version_tnx(struct ixgbe_hw *hw,
 254                                        u16 *firmware_version);
 255 s32 ixgbe_get_phy_firmware_version_generic(struct ixgbe_hw *hw,
 256                                            u16 *firmware_version);
 257
 258 s32 ixgbe_reset_phy_nl(struct ixgbe_hw *hw);
 259 s32 ixgbe_set_copper_phy_power(struct ixgbe_hw *hw, bool on);
 260 s32 ixgbe_identify_module_generic(struct ixgbe_hw *hw);
 261 s32 ixgbe_identify_sfp_module_generic(struct ixgbe_hw *hw);
 262 s32 ixgbe_get_supported_phy_sfp_layer_generic(struct ixgbe_hw *hw);
 263 s32 ixgbe_identify_qsfp_module_generic(struct ixgbe_hw *hw);
 264 s32 ixgbe_get_sfp_init_sequence_offsets(struct ixgbe_hw *hw,
 265                                         u16 *list_offset,
 266                                         u16 *data_offset);
 267 s32 ixgbe_tn_check_overtemp(struct ixgbe_hw *hw);
 268 s32 ixgbe_read_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,
 269                                 u8 dev_addr, u8 *data);
 270 s32 ixgbe_read_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,
 271                                          u8 dev_addr, u8 *data);
 272 s32 ixgbe_write_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,
 273                                  u8 dev_addr, u8 data);
 274 s32 ixgbe_write_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,
 275                                           u8 dev_addr, u8 data);
 276 s32 ixgbe_read_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,
 277                                   u8 *eeprom_data);
 278 s32 ixgbe_write_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,
 279                                    u8 eeprom_data);
 280 void ixgbe_i2c_bus_clear(struct ixgbe_hw *hw);
 281 s32 ixgbe_read_i2c_combined_generic_int(struct ixgbe_hw *, u8 addr, u16 reg,
 282                                         u16 *val, bool lock);
 283 s32 ixgbe_write_i2c_combined_generic_int(struct ixgbe_hw *, u8 addr, u16 reg,
 284                                          u16 val, bool lock);
 285 #endif /* _IXGBE_PHY_H_ */