drivers/net/sfc/mdio_10g.h

   1 /****************************************************************************
   2  * Driver for Solarflare Solarstorm network controllers and boards
   3  * Copyright 2006-2008 Solarflare Communications Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published
   7  * by the Free Software Foundation, incorporated herein by reference.
   8  */
   9
  10 #ifndef EFX_MDIO_10G_H
  11 #define EFX_MDIO_10G_H
  12
  13 /*
  14  * Definitions needed for doing 10G MDIO as specified in clause 45
  15  * MDIO, which do not appear in Linux yet. Also some helper functions.
  16  */
  17
  18 #include "efx.h"
  19 #include "boards.h"
  20
  21 /* Numbering of the MDIO Manageable Devices (MMDs) */
  22 /* Physical Medium Attachment/ Physical Medium Dependent sublayer */
  23 #define MDIO_MMD_PMAPMD (1)
  24 /* WAN Interface Sublayer */
  25 #define MDIO_MMD_WIS    (2)
  26 /* Physical Coding Sublayer */
  27 #define MDIO_MMD_PCS    (3)
  28 /* PHY Extender Sublayer */
  29 #define MDIO_MMD_PHYXS  (4)
  30 /* Extender Sublayer */
  31 #define MDIO_MMD_DTEXS  (5)
  32 /* Transmission convergence */
  33 #define MDIO_MMD_TC     (6)
  34 /* Auto negotiation */
  35 #define MDIO_MMD_AN     (7)
  36 /* Clause 22 extension */
  37 #define MDIO_MMD_C22EXT 29
  38
  39 /* Generic register locations */
  40 #define MDIO_MMDREG_CTRL1       (0)
  41 #define MDIO_MMDREG_STAT1       (1)
  42 #define MDIO_MMDREG_IDHI        (2)
  43 #define MDIO_MMDREG_IDLOW       (3)
  44 #define MDIO_MMDREG_SPEED       (4)
  45 #define MDIO_MMDREG_DEVS0       (5)
  46 #define MDIO_MMDREG_DEVS1       (6)
  47 #define MDIO_MMDREG_CTRL2       (7)
  48 #define MDIO_MMDREG_STAT2       (8)
  49 #define MDIO_MMDREG_TXDIS       (9)
  50
  51 /* Bits in MMDREG_CTRL1 */
  52 /* Reset */
  53 #define MDIO_MMDREG_CTRL1_RESET_LBN     (15)
  54 #define MDIO_MMDREG_CTRL1_RESET_WIDTH   (1)
  55 /* Loopback */
  56 /* Loopback bit for WIS, PCS, PHYSX and DTEXS */
  57 #define MDIO_MMDREG_CTRL1_LBACK_LBN     (14)
  58 #define MDIO_MMDREG_CTRL1_LBACK_WIDTH   (1)
  59 /* Low power */
  60 #define MDIO_MMDREG_CTRL1_LPOWER_LBN    (11)
  61 #define MDIO_MMDREG_CTRL1_LPOWER_WIDTH  (1)
  62
  63 /* Bits in MMDREG_STAT1 */
  64 #define MDIO_MMDREG_STAT1_FAULT_LBN     (7)
  65 #define MDIO_MMDREG_STAT1_FAULT_WIDTH   (1)
  66 /* Link state */
  67 #define MDIO_MMDREG_STAT1_LINK_LBN      (2)
  68 #define MDIO_MMDREG_STAT1_LINK_WIDTH    (1)
  69 /* Low power ability */
  70 #define MDIO_MMDREG_STAT1_LPABLE_LBN    (1)
  71 #define MDIO_MMDREG_STAT1_LPABLE_WIDTH  (1)
  72
  73 /* Bits in ID reg */
  74 #define MDIO_ID_REV(_id32)      (_id32 & 0xf)
  75 #define MDIO_ID_MODEL(_id32)    ((_id32 >> 4) & 0x3f)
  76 #define MDIO_ID_OUI(_id32)      (_id32 >> 10)
  77
  78 /* Bits in MMDREG_DEVS0/1. Someone thoughtfully layed things out
  79  * so the 'bit present' bit number of an MMD is the number of
  80  * that MMD */
  81 #define DEV_PRESENT_BIT(_b) (1 << _b)
  82
  83 #define MDIO_MMDREG_DEVS_PHYXS  DEV_PRESENT_BIT(MDIO_MMD_PHYXS)
  84 #define MDIO_MMDREG_DEVS_PCS    DEV_PRESENT_BIT(MDIO_MMD_PCS)
  85 #define MDIO_MMDREG_DEVS_PMAPMD DEV_PRESENT_BIT(MDIO_MMD_PMAPMD)
  86 #define MDIO_MMDREG_DEVS_AN     DEV_PRESENT_BIT(MDIO_MMD_AN)
  87 #define MDIO_MMDREG_DEVS_C22EXT DEV_PRESENT_BIT(MDIO_MMD_C22EXT)
  88
  89 /* Bits in MMDREG_SPEED */
  90 #define MDIO_MMDREG_SPEED_10G_LBN       0
  91 #define MDIO_MMDREG_SPEED_10G_WIDTH     1
  92 #define MDIO_MMDREG_SPEED_1000M_LBN     4
  93 #define MDIO_MMDREG_SPEED_1000M_WIDTH   1
  94 #define MDIO_MMDREG_SPEED_100M_LBN      5
  95 #define MDIO_MMDREG_SPEED_100M_WIDTH    1
  96 #define MDIO_MMDREG_SPEED_10M_LBN       6
  97 #define MDIO_MMDREG_SPEED_10M_WIDTH     1
  98
  99 /* Bits in MMDREG_STAT2 */
 100 #define MDIO_MMDREG_STAT2_PRESENT_VAL   (2)
 101 #define MDIO_MMDREG_STAT2_PRESENT_LBN   (14)
 102 #define MDIO_MMDREG_STAT2_PRESENT_WIDTH (2)
 103
 104 /* Bits in MMDREG_TXDIS */
 105 #define MDIO_MMDREG_TXDIS_GLOBAL_LBN    (0)
 106 #define MDIO_MMDREG_TXDIS_GLOBAL_WIDTH  (1)
 107
 108 /* MMD-specific bits, ordered by MMD, then register */
 109 #define MDIO_PMAPMD_CTRL1_LBACK_LBN     (0)
 110 #define MDIO_PMAPMD_CTRL1_LBACK_WIDTH   (1)
 111
 112 /* PMA type (4 bits) */
 113 #define MDIO_PMAPMD_CTRL2_10G_CX4       (0x0)
 114 #define MDIO_PMAPMD_CTRL2_10G_EW        (0x1)
 115 #define MDIO_PMAPMD_CTRL2_10G_LW        (0x2)
 116 #define MDIO_PMAPMD_CTRL2_10G_SW        (0x3)
 117 #define MDIO_PMAPMD_CTRL2_10G_LX4       (0x4)
 118 #define MDIO_PMAPMD_CTRL2_10G_ER        (0x5)
 119 #define MDIO_PMAPMD_CTRL2_10G_LR        (0x6)
 120 #define MDIO_PMAPMD_CTRL2_10G_SR        (0x7)
 121 /* Reserved */
 122 #define MDIO_PMAPMD_CTRL2_10G_BT        (0x9)
 123 /* Reserved */
 124 /* Reserved */
 125 #define MDIO_PMAPMD_CTRL2_1G_BT         (0xc)
 126 /* Reserved */
 127 #define MDIO_PMAPMD_CTRL2_100_BT        (0xe)
 128 #define MDIO_PMAPMD_CTRL2_10_BT         (0xf)
 129 #define MDIO_PMAPMD_CTRL2_TYPE_MASK     (0xf)
 130
 131 /* PMA 10GBT registers */
 132 #define MDIO_PMAPMD_10GBT_TXPWR         (131)
 133 #define MDIO_PMAPMD_10GBT_TXPWR_SHORT_LBN (0)
 134 #define MDIO_PMAPMD_10GBT_TXPWR_SHORT_WIDTH (1)
 135
 136 /* PHY XGXS Status 2 */
 137 #define MDIO_PHYXS_STATUS2              (8)
 138 #define MDIO_PHYXS_STATUS2_RX_FAULT_LBN 10
 139
 140 /* PHY XGXS lane state */
 141 #define MDIO_PHYXS_LANE_STATE           (0x18)
 142 #define MDIO_PHYXS_LANE_ALIGNED_LBN     (12)
 143
 144 /* AN registers */
 145 #define MDIO_AN_CTRL_XNP_LBN            13
 146 #define MDIO_AN_STATUS                  (1)
 147 #define MDIO_AN_STATUS_XNP_LBN          (7)
 148 #define MDIO_AN_STATUS_PAGE_LBN         (6)
 149 #define MDIO_AN_STATUS_AN_DONE_LBN      (5)
 150 #define MDIO_AN_STATUS_LP_AN_CAP_LBN    (0)
 151
 152 #define MDIO_AN_ADVERTISE               16
 153 #define MDIO_AN_ADVERTISE_XNP_LBN       12
 154 #define MDIO_AN_LPA                     19
 155 #define MDIO_AN_XNP                     22
 156 #define MDIO_AN_LPA_XNP                 25
 157
 158 #define MDIO_AN_10GBT_ADVERTISE         32
 159 #define MDIO_AN_10GBT_STATUS            (33)
 160 #define MDIO_AN_10GBT_STATUS_MS_FLT_LBN (15) /* MASTER/SLAVE config fault */
 161 #define MDIO_AN_10GBT_STATUS_MS_LBN     (14) /* MASTER/SLAVE config */
 162 #define MDIO_AN_10GBT_STATUS_LOC_OK_LBN (13) /* Local OK */
 163 #define MDIO_AN_10GBT_STATUS_REM_OK_LBN (12) /* Remote OK */
 164 #define MDIO_AN_10GBT_STATUS_LP_10G_LBN (11) /* Link partner is 10GBT capable */
 165 #define MDIO_AN_10GBT_STATUS_LP_LTA_LBN (10) /* LP loop timing ability */
 166 #define MDIO_AN_10GBT_STATUS_LP_TRR_LBN (9)  /* LP Training Reset Request */
 167
 168
 169 /* Packing of the prt and dev arguments of clause 45 style MDIO into a
 170  * single int so they can be passed into the mdio_read/write functions
 171  * that currently exist. Note that as Falcon is the only current user,
 172  * the packed form is chosen to match what Falcon needs to write into
 173  * a register. This is checked at compile-time so do not change it. If
 174  * your target chip needs things layed out differently you will need
 175  * to unpack the arguments in your chip-specific mdio functions.
 176  */
 177  /* These are defined by the standard. */
 178 #define MDIO45_PRT_ID_WIDTH  (5)
 179 #define MDIO45_DEV_ID_WIDTH  (5)
 180
 181 /* The prt ID is just packed in immediately to the left of the dev ID */
 182 #define MDIO45_PRT_DEV_WIDTH (MDIO45_PRT_ID_WIDTH + MDIO45_DEV_ID_WIDTH)
 183
 184 #define MDIO45_PRT_ID_MASK   ((1 << MDIO45_PRT_DEV_WIDTH) - 1)
 185 /* This is the prt + dev extended by 1 bit to hold the 'is clause 45' flag. */
 186 #define MDIO45_XPRT_ID_WIDTH   (MDIO45_PRT_DEV_WIDTH + 1)
 187 #define MDIO45_XPRT_ID_MASK   ((1 << MDIO45_XPRT_ID_WIDTH) - 1)
 188 #define MDIO45_XPRT_ID_IS10G   (1 << (MDIO45_XPRT_ID_WIDTH - 1))
 189
 190
 191 #define MDIO45_PRT_ID_COMP_LBN   MDIO45_DEV_ID_WIDTH
 192 #define MDIO45_PRT_ID_COMP_WIDTH  MDIO45_PRT_ID_WIDTH
 193 #define MDIO45_DEV_ID_COMP_LBN    0
 194 #define MDIO45_DEV_ID_COMP_WIDTH  MDIO45_DEV_ID_WIDTH
 195
 196 /* Compose port and device into a phy_id */
 197 static inline int mdio_clause45_pack(u8 prt, u8 dev)
 198 {
 199         efx_dword_t phy_id;
 200         EFX_POPULATE_DWORD_2(phy_id, MDIO45_PRT_ID_COMP, prt,
 201                              MDIO45_DEV_ID_COMP, dev);
 202         return MDIO45_XPRT_ID_IS10G | EFX_DWORD_VAL(phy_id);
 203 }
 204
 205 static inline void mdio_clause45_unpack(u32 val, u8 *prt, u8 *dev)
 206 {
 207         efx_dword_t phy_id;
 208         EFX_POPULATE_DWORD_1(phy_id, EFX_DWORD_0, val);
 209         *prt = EFX_DWORD_FIELD(phy_id, MDIO45_PRT_ID_COMP);
 210         *dev = EFX_DWORD_FIELD(phy_id, MDIO45_DEV_ID_COMP);
 211 }
 212
 213 static inline int mdio_clause45_read(struct efx_nic *efx,
 214                                      u8 prt, u8 dev, u16 addr)
 215 {
 216         return efx->mii.mdio_read(efx->net_dev,
 217                                   mdio_clause45_pack(prt, dev), addr);
 218 }
 219
 220 static inline void mdio_clause45_write(struct efx_nic *efx,
 221                                        u8 prt, u8 dev, u16 addr, int value)
 222 {
 223         efx->mii.mdio_write(efx->net_dev,
 224                             mdio_clause45_pack(prt, dev), addr, value);
 225 }
 226
 227
 228 static inline u32 mdio_clause45_read_id(struct efx_nic *efx, int mmd)
 229 {
 230         int phy_id = efx->mii.phy_id;
 231         u16 id_low = mdio_clause45_read(efx, phy_id, mmd, MDIO_MMDREG_IDLOW);
 232         u16 id_hi = mdio_clause45_read(efx, phy_id, mmd, MDIO_MMDREG_IDHI);
 233         return (id_hi << 16) | (id_low);
 234 }
 235
 236 static inline bool mdio_clause45_phyxgxs_lane_sync(struct efx_nic *efx)
 237 {
 238         int i, lane_status;
 239         bool sync;
 240
 241         for (i = 0; i < 2; ++i)
 242                 lane_status = mdio_clause45_read(efx, efx->mii.phy_id,
 243                                                  MDIO_MMD_PHYXS,
 244                                                  MDIO_PHYXS_LANE_STATE);
 245
 246         sync = !!(lane_status & (1 << MDIO_PHYXS_LANE_ALIGNED_LBN));
 247         if (!sync)
 248                 EFX_LOG(efx, "XGXS lane status: %x\n", lane_status);
 249         return sync;
 250 }
 251
 252 extern const char *mdio_clause45_mmd_name(int mmd);
 253
 254 /*
 255  * Reset a specific MMD and wait for reset to clear.
 256  * Return number of spins left (>0) on success, -%ETIMEDOUT on failure.
 257  *
 258  * This function will sleep
 259  */
 260 extern int mdio_clause45_reset_mmd(struct efx_nic *efx, int mmd,
 261                                    int spins, int spintime);
 262
 263 /* As mdio_clause45_check_mmd but for multiple MMDs */
 264 int mdio_clause45_check_mmds(struct efx_nic *efx,
 265                              unsigned int mmd_mask, unsigned int fatal_mask);
 266
 267 /* Check the link status of specified mmds in bit mask */
 268 extern bool mdio_clause45_links_ok(struct efx_nic *efx,
 269                                    unsigned int mmd_mask);
 270
 271 /* Generic transmit disable support though PMAPMD */
 272 extern void mdio_clause45_transmit_disable(struct efx_nic *efx);
 273
 274 /* Generic part of reconfigure: set/clear loopback bits */
 275 extern void mdio_clause45_phy_reconfigure(struct efx_nic *efx);
 276
 277 /* Set the power state of the specified MMDs */
 278 extern void mdio_clause45_set_mmds_lpower(struct efx_nic *efx,
 279                                           int low_power, unsigned int mmd_mask);
 280
 281 /* Read (some of) the PHY settings over MDIO */
 282 extern void mdio_clause45_get_settings(struct efx_nic *efx,
 283                                        struct ethtool_cmd *ecmd);
 284
 285 /* Read (some of) the PHY settings over MDIO */
 286 extern void
 287 mdio_clause45_get_settings_ext(struct efx_nic *efx, struct ethtool_cmd *ecmd,
 288                                u32 xnp, u32 xnp_lpa);
 289
 290 /* Set (some of) the PHY settings over MDIO */
 291 extern int mdio_clause45_set_settings(struct efx_nic *efx,
 292                                       struct ethtool_cmd *ecmd);
 293
 294 /* Set pause parameters to be advertised through AN (if available) */
 295 extern void mdio_clause45_set_pause(struct efx_nic *efx);
 296
 297 /* Get pause parameters from AN if available (otherwise return
 298  * requested pause parameters)
 299  */
 300 enum efx_fc_type mdio_clause45_get_pause(struct efx_nic *efx);
 301
 302 /* Wait for specified MMDs to exit reset within a timeout */
 303 extern int mdio_clause45_wait_reset_mmds(struct efx_nic *efx,
 304                                          unsigned int mmd_mask);
 305
 306 /* Set or clear flag, debouncing */
 307 extern void mdio_clause45_set_flag(struct efx_nic *efx, u8 prt, u8 dev,
 308                                    u16 addr, int bit, bool sense);
 309
 310 #endif /* EFX_MDIO_10G_H */