lib/librte_eal/linuxapp/kni/ethtool/igb/e1000_phy.h

   1 /*******************************************************************************
   2
   3   Intel(R) Gigabit Ethernet Linux driver
   4   Copyright(c) 2007-2012 Intel Corporation.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms and conditions of the GNU General Public License,
   8   version 2, as published by the Free Software Foundation.
   9
  10   This program is distributed in the hope it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13   more details.
  14
  15   You should have received a copy of the GNU General Public License along with
  16   this program; if not, write to the Free Software Foundation, Inc.,
  17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19   The full GNU General Public License is included in this distribution in
  20   the file called "COPYING".
  21
  22   Contact Information:
  23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25
  26 *******************************************************************************/
  27
  28 #ifndef _E1000_PHY_H_
  29 #define _E1000_PHY_H_
  30
  31 void e1000_init_phy_ops_generic(struct e1000_hw *hw);
  32 s32  e1000_null_read_reg(struct e1000_hw *hw, u32 offset, u16 *data);
  33 void e1000_null_phy_generic(struct e1000_hw *hw);
  34 s32  e1000_null_lplu_state(struct e1000_hw *hw, bool active);
  35 s32  e1000_null_write_reg(struct e1000_hw *hw, u32 offset, u16 data);
  36 s32  e1000_null_set_page(struct e1000_hw *hw, u16 data);
  37 s32 e1000_read_i2c_byte_null(struct e1000_hw *hw, u8 byte_offset,
  38                              u8 dev_addr, u8 *data);
  39 s32 e1000_write_i2c_byte_null(struct e1000_hw *hw, u8 byte_offset,
  40                               u8 dev_addr, u8 data);
  41 s32  e1000_check_downshift_generic(struct e1000_hw *hw);
  42 s32  e1000_check_polarity_m88(struct e1000_hw *hw);
  43 s32  e1000_check_polarity_igp(struct e1000_hw *hw);
  44 s32  e1000_check_polarity_ife(struct e1000_hw *hw);
  45 s32  e1000_check_reset_block_generic(struct e1000_hw *hw);
  46 s32  e1000_copper_link_setup_igp(struct e1000_hw *hw);
  47 s32  e1000_copper_link_setup_m88(struct e1000_hw *hw);
  48 s32  e1000_copper_link_setup_m88_gen2(struct e1000_hw *hw);
  49 s32  e1000_phy_force_speed_duplex_igp(struct e1000_hw *hw);
  50 s32  e1000_phy_force_speed_duplex_m88(struct e1000_hw *hw);
  51 s32  e1000_phy_force_speed_duplex_ife(struct e1000_hw *hw);
  52 s32  e1000_get_cable_length_m88(struct e1000_hw *hw);
  53 s32  e1000_get_cable_length_m88_gen2(struct e1000_hw *hw);
  54 s32  e1000_get_cable_length_igp_2(struct e1000_hw *hw);
  55 s32  e1000_get_cfg_done_generic(struct e1000_hw *hw);
  56 s32  e1000_get_phy_id(struct e1000_hw *hw);
  57 s32  e1000_get_phy_info_igp(struct e1000_hw *hw);
  58 s32  e1000_get_phy_info_m88(struct e1000_hw *hw);
  59 s32  e1000_get_phy_info_ife(struct e1000_hw *hw);
  60 s32  e1000_phy_sw_reset_generic(struct e1000_hw *hw);
  61 void e1000_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
  62 s32  e1000_phy_hw_reset_generic(struct e1000_hw *hw);
  63 s32  e1000_phy_reset_dsp_generic(struct e1000_hw *hw);
  64 s32  e1000_read_kmrn_reg_generic(struct e1000_hw *hw, u32 offset, u16 *data);
  65 s32  e1000_read_kmrn_reg_locked(struct e1000_hw *hw, u32 offset, u16 *data);
  66 s32  e1000_set_page_igp(struct e1000_hw *hw, u16 page);
  67 s32  e1000_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
  68 s32  e1000_read_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset, u16 *data);
  69 s32  e1000_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
  70 s32  e1000_set_d3_lplu_state_generic(struct e1000_hw *hw, bool active);
  71 s32  e1000_setup_copper_link_generic(struct e1000_hw *hw);
  72 s32  e1000_wait_autoneg_generic(struct e1000_hw *hw);
  73 s32  e1000_write_kmrn_reg_generic(struct e1000_hw *hw, u32 offset, u16 data);
  74 s32  e1000_write_kmrn_reg_locked(struct e1000_hw *hw, u32 offset, u16 data);
  75 s32  e1000_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
  76 s32  e1000_write_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset, u16 data);
  77 s32  e1000_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
  78 s32  e1000_phy_reset_dsp(struct e1000_hw *hw);
  79 s32  e1000_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
  80                                 u32 usec_interval, bool *success);
  81 s32  e1000_phy_init_script_igp3(struct e1000_hw *hw);
  82 enum e1000_phy_type e1000_get_phy_type_from_id(u32 phy_id);
  83 s32  e1000_determine_phy_address(struct e1000_hw *hw);
  84 s32  e1000_enable_phy_wakeup_reg_access_bm(struct e1000_hw *hw, u16 *phy_reg);
  85 s32  e1000_disable_phy_wakeup_reg_access_bm(struct e1000_hw *hw, u16 *phy_reg);
  86 void e1000_power_up_phy_copper(struct e1000_hw *hw);
  87 void e1000_power_down_phy_copper(struct e1000_hw *hw);
  88 s32  e1000_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
  89 s32  e1000_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
  90 s32  e1000_read_phy_reg_i2c(struct e1000_hw *hw, u32 offset, u16 *data);
  91 s32  e1000_write_phy_reg_i2c(struct e1000_hw *hw, u32 offset, u16 data);
  92 s32  e1000_read_sfp_data_byte(struct e1000_hw *hw, u16 offset, u8 *data);
  93 s32  e1000_write_sfp_data_byte(struct e1000_hw *hw, u16 offset, u8 data);
  94 s32  e1000_copper_link_setup_82577(struct e1000_hw *hw);
  95 s32  e1000_check_polarity_82577(struct e1000_hw *hw);
  96 s32  e1000_get_phy_info_82577(struct e1000_hw *hw);
  97 s32  e1000_phy_force_speed_duplex_82577(struct e1000_hw *hw);
  98 s32  e1000_get_cable_length_82577(struct e1000_hw *hw);
  99
 100 #define E1000_MAX_PHY_ADDR              8
 101
 102 /* IGP01E1000 Specific Registers */
 103 #define IGP01E1000_PHY_PORT_CONFIG      0x10 /* Port Config */
 104 #define IGP01E1000_PHY_PORT_STATUS      0x11 /* Status */
 105 #define IGP01E1000_PHY_PORT_CTRL        0x12 /* Control */
 106 #define IGP01E1000_PHY_LINK_HEALTH      0x13 /* PHY Link Health */
 107 #define IGP01E1000_GMII_FIFO            0x14 /* GMII FIFO */
 108 #define IGP01E1000_PHY_CHANNEL_QUALITY  0x15 /* PHY Channel Quality */
 109 #define IGP02E1000_PHY_POWER_MGMT       0x19 /* Power Management */
 110 #define IGP01E1000_PHY_PAGE_SELECT      0x1F /* Page Select */
 111 #define BM_PHY_PAGE_SELECT              22   /* Page Select for BM */
 112 #define IGP_PAGE_SHIFT                  5
 113 #define PHY_REG_MASK                    0x1F
 114
 115 #define HV_INTC_FC_PAGE_START           768
 116 #define I82578_ADDR_REG                 29
 117 #define I82577_ADDR_REG                 16
 118 #define I82577_CFG_REG                  22
 119 #define I82577_CFG_ASSERT_CRS_ON_TX     (1 << 15)
 120 #define I82577_CFG_ENABLE_DOWNSHIFT     (3 << 10) /* auto downshift 100/10 */
 121 #define I82577_CTRL_REG                 23
 122
 123 /* 82577 specific PHY registers */
 124 #define I82577_PHY_CTRL_2               18
 125 #define I82577_PHY_LBK_CTRL             19
 126 #define I82577_PHY_STATUS_2             26
 127 #define I82577_PHY_DIAG_STATUS          31
 128
 129 /* I82577 PHY Status 2 */
 130 #define I82577_PHY_STATUS2_REV_POLARITY         0x0400
 131 #define I82577_PHY_STATUS2_MDIX                 0x0800
 132 #define I82577_PHY_STATUS2_SPEED_MASK           0x0300
 133 #define I82577_PHY_STATUS2_SPEED_1000MBPS       0x0200
 134 #define I82577_PHY_STATUS2_SPEED_100MBPS        0x0100
 135
 136 /* I82577 PHY Control 2 */
 137 #define I82577_PHY_CTRL2_AUTO_MDIX              0x0400
 138 #define I82577_PHY_CTRL2_FORCE_MDI_MDIX         0x0200
 139
 140 /* I82577 PHY Diagnostics Status */
 141 #define I82577_DSTATUS_CABLE_LENGTH             0x03FC
 142 #define I82577_DSTATUS_CABLE_LENGTH_SHIFT       2
 143
 144 /* 82580 PHY Power Management */
 145 #define E1000_82580_PHY_POWER_MGMT      0xE14
 146 #define E1000_82580_PM_SPD              0x0001 /* Smart Power Down */
 147 #define E1000_82580_PM_D0_LPLU          0x0002 /* For D0a states */
 148 #define E1000_82580_PM_D3_LPLU          0x0004 /* For all other states */
 149
 150 #define IGP01E1000_PHY_PCS_INIT_REG     0x00B4
 151 #define IGP01E1000_PHY_POLARITY_MASK    0x0078
 152
 153 #define IGP01E1000_PSCR_AUTO_MDIX       0x1000
 154 #define IGP01E1000_PSCR_FORCE_MDI_MDIX  0x2000 /* 0=MDI, 1=MDIX */
 155
 156 #define IGP01E1000_PSCFR_SMART_SPEED    0x0080
 157
 158 /* Enable flexible speed on link-up */
 159 #define IGP01E1000_GMII_FLEX_SPD        0x0010
 160 #define IGP01E1000_GMII_SPD             0x0020 /* Enable SPD */
 161
 162 #define IGP02E1000_PM_SPD               0x0001 /* Smart Power Down */
 163 #define IGP02E1000_PM_D0_LPLU           0x0002 /* For D0a states */
 164 #define IGP02E1000_PM_D3_LPLU           0x0004 /* For all other states */
 165
 166 #define IGP01E1000_PLHR_SS_DOWNGRADE    0x8000
 167
 168 #define IGP01E1000_PSSR_POLARITY_REVERSED       0x0002
 169 #define IGP01E1000_PSSR_MDIX            0x0800
 170 #define IGP01E1000_PSSR_SPEED_MASK      0xC000
 171 #define IGP01E1000_PSSR_SPEED_1000MBPS  0xC000
 172
 173 #define IGP02E1000_PHY_CHANNEL_NUM      4
 174 #define IGP02E1000_PHY_AGC_A            0x11B1
 175 #define IGP02E1000_PHY_AGC_B            0x12B1
 176 #define IGP02E1000_PHY_AGC_C            0x14B1
 177 #define IGP02E1000_PHY_AGC_D            0x18B1
 178
 179 #define IGP02E1000_AGC_LENGTH_SHIFT     9   /* Course - 15:13, Fine - 12:9 */
 180 #define IGP02E1000_AGC_LENGTH_MASK      0x7F
 181 #define IGP02E1000_AGC_RANGE            15
 182
 183 #define IGP03E1000_PHY_MISC_CTRL        0x1B
 184 #define IGP03E1000_PHY_MISC_DUPLEX_MANUAL_SET   0x1000 /* Manually Set Duplex */
 185
 186 #define E1000_CABLE_LENGTH_UNDEFINED    0xFF
 187
 188 #define E1000_KMRNCTRLSTA_OFFSET        0x001F0000
 189 #define E1000_KMRNCTRLSTA_OFFSET_SHIFT  16
 190 #define E1000_KMRNCTRLSTA_REN           0x00200000
 191 #define E1000_KMRNCTRLSTA_DIAG_OFFSET   0x3    /* Kumeran Diagnostic */
 192 #define E1000_KMRNCTRLSTA_TIMEOUTS      0x4    /* Kumeran Timeouts */
 193 #define E1000_KMRNCTRLSTA_INBAND_PARAM  0x9    /* Kumeran InBand Parameters */
 194 #define E1000_KMRNCTRLSTA_IBIST_DISABLE 0x0200 /* Kumeran IBIST Disable */
 195 #define E1000_KMRNCTRLSTA_DIAG_NELPBK   0x1000 /* Nearend Loopback mode */
 196
 197 #define IFE_PHY_EXTENDED_STATUS_CONTROL 0x10
 198 #define IFE_PHY_SPECIAL_CONTROL         0x11 /* 100BaseTx PHY Special Control */
 199 #define IFE_PHY_SPECIAL_CONTROL_LED     0x1B /* PHY Special and LED Control */
 200 #define IFE_PHY_MDIX_CONTROL            0x1C /* MDI/MDI-X Control */
 201
 202 /* IFE PHY Extended Status Control */
 203 #define IFE_PESC_POLARITY_REVERSED      0x0100
 204
 205 /* IFE PHY Special Control */
 206 #define IFE_PSC_AUTO_POLARITY_DISABLE   0x0010
 207 #define IFE_PSC_FORCE_POLARITY          0x0020
 208 #define IFE_PSC_DISABLE_DYNAMIC_POWER_DOWN      0x0100
 209
 210 /* IFE PHY Special Control and LED Control */
 211 #define IFE_PSCL_PROBE_MODE             0x0020
 212 #define IFE_PSCL_PROBE_LEDS_OFF         0x0006 /* Force LEDs 0 and 2 off */
 213 #define IFE_PSCL_PROBE_LEDS_ON          0x0007 /* Force LEDs 0 and 2 on */
 214
 215 /* IFE PHY MDIX Control */
 216 #define IFE_PMC_MDIX_STATUS             0x0020 /* 1=MDI-X, 0=MDI */
 217 #define IFE_PMC_FORCE_MDIX              0x0040 /* 1=force MDI-X, 0=force MDI */
 218 #define IFE_PMC_AUTO_MDIX               0x0080 /* 1=enable auto, 0=disable */
 219
 220 /* SFP modules ID memory locations */
 221 #define E1000_SFF_IDENTIFIER_OFFSET     0x00
 222 #define E1000_SFF_IDENTIFIER_SFF        0x02
 223 #define E1000_SFF_IDENTIFIER_SFP        0x03
 224
 225 #define E1000_SFF_ETH_FLAGS_OFFSET      0x06
 226 /* Flags for SFP modules compatible with ETH up to 1Gb */
 227 struct sfp_e1000_flags {
 228         u8 e1000_base_sx:1;
 229         u8 e1000_base_lx:1;
 230         u8 e1000_base_cx:1;
 231         u8 e1000_base_t:1;
 232         u8 e100_base_lx:1;
 233         u8 e100_base_fx:1;
 234         u8 e10_base_bx10:1;
 235         u8 e10_base_px:1;
 236 };
 237
 238 /* Vendor OUIs: format of OUI is 0x[byte0][byte1][byte2][00] */
 239 #define E1000_SFF_VENDOR_OUI_TYCO       0x00407600
 240 #define E1000_SFF_VENDOR_OUI_FTL        0x00906500
 241 #define E1000_SFF_VENDOR_OUI_AVAGO      0x00176A00
 242 #define E1000_SFF_VENDOR_OUI_INTEL      0x001B2100
 243
 244 #endif