drivers/net/phy/sfp.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/acpi.h>
   3 #include <linux/ctype.h>
   4 #include <linux/debugfs.h>
   5 #include <linux/delay.h>
   6 #include <linux/gpio/consumer.h>
   7 #include <linux/hwmon.h>
   8 #include <linux/i2c.h>
   9 #include <linux/interrupt.h>
  10 #include <linux/jiffies.h>
  11 #include <linux/mdio/mdio-i2c.h>
  12 #include <linux/module.h>
  13 #include <linux/mutex.h>
  14 #include <linux/of.h>
  15 #include <linux/phy.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/rtnetlink.h>
  18 #include <linux/slab.h>
  19 #include <linux/workqueue.h>
  20
  21 #include "sfp.h"
  22 #include "swphy.h"
  23
  24 enum {
  25         GPIO_MODDEF0,
  26         GPIO_LOS,
  27         GPIO_TX_FAULT,
  28         GPIO_TX_DISABLE,
  29         GPIO_RATE_SELECT,
  30         GPIO_MAX,
  31
  32         SFP_F_PRESENT = BIT(GPIO_MODDEF0),
  33         SFP_F_LOS = BIT(GPIO_LOS),
  34         SFP_F_TX_FAULT = BIT(GPIO_TX_FAULT),
  35         SFP_F_TX_DISABLE = BIT(GPIO_TX_DISABLE),
  36         SFP_F_RATE_SELECT = BIT(GPIO_RATE_SELECT),
  37
  38         SFP_E_INSERT = 0,
  39         SFP_E_REMOVE,
  40         SFP_E_DEV_ATTACH,
  41         SFP_E_DEV_DETACH,
  42         SFP_E_DEV_DOWN,
  43         SFP_E_DEV_UP,
  44         SFP_E_TX_FAULT,
  45         SFP_E_TX_CLEAR,
  46         SFP_E_LOS_HIGH,
  47         SFP_E_LOS_LOW,
  48         SFP_E_TIMEOUT,
  49
  50         SFP_MOD_EMPTY = 0,
  51         SFP_MOD_ERROR,
  52         SFP_MOD_PROBE,
  53         SFP_MOD_WAITDEV,
  54         SFP_MOD_HPOWER,
  55         SFP_MOD_WAITPWR,
  56         SFP_MOD_PRESENT,
  57
  58         SFP_DEV_DETACHED = 0,
  59         SFP_DEV_DOWN,
  60         SFP_DEV_UP,
  61
  62         SFP_S_DOWN = 0,
  63         SFP_S_FAIL,
  64         SFP_S_WAIT,
  65         SFP_S_INIT,
  66         SFP_S_INIT_PHY,
  67         SFP_S_INIT_TX_FAULT,
  68         SFP_S_WAIT_LOS,
  69         SFP_S_LINK_UP,
  70         SFP_S_TX_FAULT,
  71         SFP_S_REINIT,
  72         SFP_S_TX_DISABLE,
  73 };
  74
  75 static const char  * const mod_state_strings[] = {
  76         [SFP_MOD_EMPTY] = "empty",
  77         [SFP_MOD_ERROR] = "error",
  78         [SFP_MOD_PROBE] = "probe",
  79         [SFP_MOD_WAITDEV] = "waitdev",
  80         [SFP_MOD_HPOWER] = "hpower",
  81         [SFP_MOD_WAITPWR] = "waitpwr",
  82         [SFP_MOD_PRESENT] = "present",
  83 };
  84
  85 static const char *mod_state_to_str(unsigned short mod_state)
  86 {
  87         if (mod_state >= ARRAY_SIZE(mod_state_strings))
  88                 return "Unknown module state";
  89         return mod_state_strings[mod_state];
  90 }
  91
  92 static const char * const dev_state_strings[] = {
  93         [SFP_DEV_DETACHED] = "detached",
  94         [SFP_DEV_DOWN] = "down",
  95         [SFP_DEV_UP] = "up",
  96 };
  97
  98 static const char *dev_state_to_str(unsigned short dev_state)
  99 {
 100         if (dev_state >= ARRAY_SIZE(dev_state_strings))
 101                 return "Unknown device state";
 102         return dev_state_strings[dev_state];
 103 }
 104
 105 static const char * const event_strings[] = {
 106         [SFP_E_INSERT] = "insert",
 107         [SFP_E_REMOVE] = "remove",
 108         [SFP_E_DEV_ATTACH] = "dev_attach",
 109         [SFP_E_DEV_DETACH] = "dev_detach",
 110         [SFP_E_DEV_DOWN] = "dev_down",
 111         [SFP_E_DEV_UP] = "dev_up",
 112         [SFP_E_TX_FAULT] = "tx_fault",
 113         [SFP_E_TX_CLEAR] = "tx_clear",
 114         [SFP_E_LOS_HIGH] = "los_high",
 115         [SFP_E_LOS_LOW] = "los_low",
 116         [SFP_E_TIMEOUT] = "timeout",
 117 };
 118
 119 static const char *event_to_str(unsigned short event)
 120 {
 121         if (event >= ARRAY_SIZE(event_strings))
 122                 return "Unknown event";
 123         return event_strings[event];
 124 }
 125
 126 static const char * const sm_state_strings[] = {
 127         [SFP_S_DOWN] = "down",
 128         [SFP_S_FAIL] = "fail",
 129         [SFP_S_WAIT] = "wait",
 130         [SFP_S_INIT] = "init",
 131         [SFP_S_INIT_PHY] = "init_phy",
 132         [SFP_S_INIT_TX_FAULT] = "init_tx_fault",
 133         [SFP_S_WAIT_LOS] = "wait_los",
 134         [SFP_S_LINK_UP] = "link_up",
 135         [SFP_S_TX_FAULT] = "tx_fault",
 136         [SFP_S_REINIT] = "reinit",
 137         [SFP_S_TX_DISABLE] = "tx_disable",
 138 };
 139
 140 static const char *sm_state_to_str(unsigned short sm_state)
 141 {
 142         if (sm_state >= ARRAY_SIZE(sm_state_strings))
 143                 return "Unknown state";
 144         return sm_state_strings[sm_state];
 145 }
 146
 147 static const char *gpio_of_names[] = {
 148         "mod-def0",
 149         "los",
 150         "tx-fault",
 151         "tx-disable",
 152         "rate-select0",
 153 };
 154
 155 static const enum gpiod_flags gpio_flags[] = {
 156         GPIOD_IN,
 157         GPIOD_IN,
 158         GPIOD_IN,
 159         GPIOD_ASIS,
 160         GPIOD_ASIS,
 161 };
 162
 163 /* t_start_up (SFF-8431) or t_init (SFF-8472) is the time required for a
 164  * non-cooled module to initialise its laser safety circuitry. We wait
 165  * an initial T_WAIT period before we check the tx fault to give any PHY
 166  * on board (for a copper SFP) time to initialise.
 167  */
 168 #define T_WAIT                  msecs_to_jiffies(50)
 169 #define T_WAIT_ROLLBALL         msecs_to_jiffies(25000)
 170 #define T_START_UP              msecs_to_jiffies(300)
 171 #define T_START_UP_BAD_GPON     msecs_to_jiffies(60000)
 172
 173 /* t_reset is the time required to assert the TX_DISABLE signal to reset
 174  * an indicated TX_FAULT.
 175  */
 176 #define T_RESET_US              10
 177 #define T_FAULT_RECOVER         msecs_to_jiffies(1000)
 178
 179 /* N_FAULT_INIT is the number of recovery attempts at module initialisation
 180  * time. If the TX_FAULT signal is not deasserted after this number of
 181  * attempts at clearing it, we decide that the module is faulty.
 182  * N_FAULT is the same but after the module has initialised.
 183  */
 184 #define N_FAULT_INIT            5
 185 #define N_FAULT                 5
 186
 187 /* T_PHY_RETRY is the time interval between attempts to probe the PHY.
 188  * R_PHY_RETRY is the number of attempts.
 189  */
 190 #define T_PHY_RETRY             msecs_to_jiffies(50)
 191 #define R_PHY_RETRY             12
 192
 193 /* SFP module presence detection is poor: the three MOD DEF signals are
 194  * the same length on the PCB, which means it's possible for MOD DEF 0 to
 195  * connect before the I2C bus on MOD DEF 1/2.
 196  *
 197  * The SFF-8472 specifies t_serial ("Time from power on until module is
 198  * ready for data transmission over the two wire serial bus.") as 300ms.
 199  */
 200 #define T_SERIAL                msecs_to_jiffies(300)
 201 #define T_HPOWER_LEVEL          msecs_to_jiffies(300)
 202 #define T_PROBE_RETRY_INIT      msecs_to_jiffies(100)
 203 #define R_PROBE_RETRY_INIT      10
 204 #define T_PROBE_RETRY_SLOW      msecs_to_jiffies(5000)
 205 #define R_PROBE_RETRY_SLOW      12
 206
 207 /* SFP modules appear to always have their PHY configured for bus address
 208  * 0x56 (which with mdio-i2c, translates to a PHY address of 22).
 209  * RollBall SFPs access phy via SFP Enhanced Digital Diagnostic Interface
 210  * via address 0x51 (mdio-i2c will use RollBall protocol on this address).
 211  */
 212 #define SFP_PHY_ADDR            22
 213 #define SFP_PHY_ADDR_ROLLBALL   17
 214
 215 /* SFP_EEPROM_BLOCK_SIZE is the size of data chunk to read the EEPROM
 216  * at a time. Some SFP modules and also some Linux I2C drivers do not like
 217  * reads longer than 16 bytes.
 218  */
 219 #define SFP_EEPROM_BLOCK_SIZE   16
 220
 221 struct sff_data {
 222         unsigned int gpios;
 223         bool (*module_supported)(const struct sfp_eeprom_id *id);
 224 };
 225
 226 struct sfp {
 227         struct device *dev;
 228         struct i2c_adapter *i2c;
 229         struct mii_bus *i2c_mii;
 230         struct sfp_bus *sfp_bus;
 231         enum mdio_i2c_proto mdio_protocol;
 232         struct phy_device *mod_phy;
 233         const struct sff_data *type;
 234         size_t i2c_block_size;
 235         u32 max_power_mW;
 236
 237         unsigned int (*get_state)(struct sfp *);
 238         void (*set_state)(struct sfp *, unsigned int);
 239         int (*read)(struct sfp *, bool, u8, void *, size_t);
 240         int (*write)(struct sfp *, bool, u8, void *, size_t);
 241
 242         struct gpio_desc *gpio[GPIO_MAX];
 243         int gpio_irq[GPIO_MAX];
 244
 245         bool need_poll;
 246
 247         struct mutex st_mutex;                  /* Protects state */
 248         unsigned int state_hw_mask;
 249         unsigned int state_soft_mask;
 250         unsigned int state;
 251         struct delayed_work poll;
 252         struct delayed_work timeout;
 253         struct mutex sm_mutex;                  /* Protects state machine */
 254         unsigned char sm_mod_state;
 255         unsigned char sm_mod_tries_init;
 256         unsigned char sm_mod_tries;
 257         unsigned char sm_dev_state;
 258         unsigned short sm_state;
 259         unsigned char sm_fault_retries;
 260         unsigned char sm_phy_retries;
 261
 262         struct sfp_eeprom_id id;
 263         unsigned int module_power_mW;
 264         unsigned int module_t_start_up;
 265         unsigned int module_t_wait;
 266         bool tx_fault_ignore;
 267
 268         const struct sfp_quirk *quirk;
 269
 270 #if IS_ENABLED(CONFIG_HWMON)
 271         struct sfp_diag diag;
 272         struct delayed_work hwmon_probe;
 273         unsigned int hwmon_tries;
 274         struct device *hwmon_dev;
 275         char *hwmon_name;
 276 #endif
 277
 278 #if IS_ENABLED(CONFIG_DEBUG_FS)
 279         struct dentry *debugfs_dir;
 280 #endif
 281 };
 282
 283 static bool sff_module_supported(const struct sfp_eeprom_id *id)
 284 {
 285         return id->base.phys_id == SFF8024_ID_SFF_8472 &&
 286                id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP;
 287 }
 288
 289 static const struct sff_data sff_data = {
 290         .gpios = SFP_F_LOS | SFP_F_TX_FAULT | SFP_F_TX_DISABLE,
 291         .module_supported = sff_module_supported,
 292 };
 293
 294 static bool sfp_module_supported(const struct sfp_eeprom_id *id)
 295 {
 296         if (id->base.phys_id == SFF8024_ID_SFP &&
 297             id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP)
 298                 return true;
 299
 300         /* SFP GPON module Ubiquiti U-Fiber Instant has in its EEPROM stored
 301          * phys id SFF instead of SFP. Therefore mark this module explicitly
 302          * as supported based on vendor name and pn match.
 303          */
 304         if (id->base.phys_id == SFF8024_ID_SFF_8472 &&
 305             id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP &&
 306             !memcmp(id->base.vendor_name, "UBNT            ", 16) &&
 307             !memcmp(id->base.vendor_pn, "UF-INSTANT      ", 16))
 308                 return true;
 309
 310         return false;
 311 }
 312
 313 static const struct sff_data sfp_data = {
 314         .gpios = SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT |
 315                  SFP_F_TX_DISABLE | SFP_F_RATE_SELECT,
 316         .module_supported = sfp_module_supported,
 317 };
 318
 319 static const struct of_device_id sfp_of_match[] = {
 320         { .compatible = "sff,sff", .data = &sff_data, },
 321         { .compatible = "sff,sfp", .data = &sfp_data, },
 322         { },
 323 };
 324 MODULE_DEVICE_TABLE(of, sfp_of_match);
 325
 326 static void sfp_fixup_long_startup(struct sfp *sfp)
 327 {
 328         sfp->module_t_start_up = T_START_UP_BAD_GPON;
 329 }
 330
 331 static void sfp_fixup_ignore_tx_fault(struct sfp *sfp)
 332 {
 333         sfp->tx_fault_ignore = true;
 334 }
 335
 336 static void sfp_fixup_halny_gsfp(struct sfp *sfp)
 337 {
 338         /* Ignore the TX_FAULT and LOS signals on this module.
 339          * these are possibly used for other purposes on this
 340          * module, e.g. a serial port.
 341          */
 342         sfp->state_hw_mask &= ~(SFP_F_TX_FAULT | SFP_F_LOS);
 343 }
 344
 345 static void sfp_fixup_rollball(struct sfp *sfp)
 346 {
 347         sfp->mdio_protocol = MDIO_I2C_ROLLBALL;
 348         sfp->module_t_wait = T_WAIT_ROLLBALL;
 349 }
 350
 351 static void sfp_fixup_rollball_cc(struct sfp *sfp)
 352 {
 353         sfp_fixup_rollball(sfp);
 354
 355         /* Some RollBall SFPs may have wrong (zero) extended compliance code
 356          * burned in EEPROM. For PHY probing we need the correct one.
 357          */
 358         sfp->id.base.extended_cc = SFF8024_ECC_10GBASE_T_SFI;
 359 }
 360
 361 static void sfp_quirk_2500basex(const struct sfp_eeprom_id *id,
 362                                 unsigned long *modes,
 363                                 unsigned long *interfaces)
 364 {
 365         linkmode_set_bit(ETHTOOL_LINK_MODE_2500baseX_Full_BIT, modes);
 366         __set_bit(PHY_INTERFACE_MODE_2500BASEX, interfaces);
 367 }
 368
 369 static void sfp_quirk_ubnt_uf_instant(const struct sfp_eeprom_id *id,
 370                                       unsigned long *modes,
 371                                       unsigned long *interfaces)
 372 {
 373         /* Ubiquiti U-Fiber Instant module claims that support all transceiver
 374          * types including 10G Ethernet which is not truth. So clear all claimed
 375          * modes and set only one mode which module supports: 1000baseX_Full.
 376          */
 377         linkmode_zero(modes);
 378         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT, modes);
 379 }
 380
 381 #define SFP_QUIRK(_v, _p, _m, _f) \
 382         { .vendor = _v, .part = _p, .modes = _m, .fixup = _f, }
 383 #define SFP_QUIRK_M(_v, _p, _m) SFP_QUIRK(_v, _p, _m, NULL)
 384 #define SFP_QUIRK_F(_v, _p, _f) SFP_QUIRK(_v, _p, NULL, _f)
 385
 386 static const struct sfp_quirk sfp_quirks[] = {
 387         // Alcatel Lucent G-010S-P can operate at 2500base-X, but incorrectly
 388         // report 2500MBd NRZ in their EEPROM
 389         SFP_QUIRK_M("ALCATELLUCENT", "G010SP", sfp_quirk_2500basex),
 390
 391         // Alcatel Lucent G-010S-A can operate at 2500base-X, but report 3.2GBd
 392         // NRZ in their EEPROM
 393         SFP_QUIRK("ALCATELLUCENT", "3FE46541AA", sfp_quirk_2500basex,
 394                   sfp_fixup_long_startup),
 395
 396         SFP_QUIRK_F("HALNy", "HL-GSFP", sfp_fixup_halny_gsfp),
 397
 398         // Huawei MA5671A can operate at 2500base-X, but report 1.2GBd NRZ in
 399         // their EEPROM
 400         SFP_QUIRK("HUAWEI", "MA5671A", sfp_quirk_2500basex,
 401                   sfp_fixup_ignore_tx_fault),
 402
 403         // Lantech 8330-262D-E can operate at 2500base-X, but incorrectly report
 404         // 2500MBd NRZ in their EEPROM
 405         SFP_QUIRK_M("Lantech", "8330-262D-E", sfp_quirk_2500basex),
 406
 407         SFP_QUIRK_M("UBNT", "UF-INSTANT", sfp_quirk_ubnt_uf_instant),
 408
 409         SFP_QUIRK_F("OEM", "SFP-10G-T", sfp_fixup_rollball_cc),
 410         SFP_QUIRK_F("OEM", "RTSFP-10", sfp_fixup_rollball_cc),
 411         SFP_QUIRK_F("OEM", "RTSFP-10G", sfp_fixup_rollball_cc),
 412         SFP_QUIRK_F("Turris", "RTSFP-10", sfp_fixup_rollball),
 413         SFP_QUIRK_F("Turris", "RTSFP-10G", sfp_fixup_rollball),
 414 };
 415
 416 static size_t sfp_strlen(const char *str, size_t maxlen)
 417 {
 418         size_t size, i;
 419
 420         /* Trailing characters should be filled with space chars, but
 421          * some manufacturers can't read SFF-8472 and use NUL.
 422          */
 423         for (i = 0, size = 0; i < maxlen; i++)
 424                 if (str[i] != ' ' && str[i] != '\0')
 425                         size = i + 1;
 426
 427         return size;
 428 }
 429
 430 static bool sfp_match(const char *qs, const char *str, size_t len)
 431 {
 432         if (!qs)
 433                 return true;
 434         if (strlen(qs) != len)
 435                 return false;
 436         return !strncmp(qs, str, len);
 437 }
 438
 439 static const struct sfp_quirk *sfp_lookup_quirk(const struct sfp_eeprom_id *id)
 440 {
 441         const struct sfp_quirk *q;
 442         unsigned int i;
 443         size_t vs, ps;
 444
 445         vs = sfp_strlen(id->base.vendor_name, ARRAY_SIZE(id->base.vendor_name));
 446         ps = sfp_strlen(id->base.vendor_pn, ARRAY_SIZE(id->base.vendor_pn));
 447
 448         for (i = 0, q = sfp_quirks; i < ARRAY_SIZE(sfp_quirks); i++, q++)
 449                 if (sfp_match(q->vendor, id->base.vendor_name, vs) &&
 450                     sfp_match(q->part, id->base.vendor_pn, ps))
 451                         return q;
 452
 453         return NULL;
 454 }
 455
 456 static unsigned long poll_jiffies;
 457
 458 static unsigned int sfp_gpio_get_state(struct sfp *sfp)
 459 {
 460         unsigned int i, state, v;
 461
 462         for (i = state = 0; i < GPIO_MAX; i++) {
 463                 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
 464                         continue;
 465
 466                 v = gpiod_get_value_cansleep(sfp->gpio[i]);
 467                 if (v)
 468                         state |= BIT(i);
 469         }
 470
 471         return state;
 472 }
 473
 474 static unsigned int sff_gpio_get_state(struct sfp *sfp)
 475 {
 476         return sfp_gpio_get_state(sfp) | SFP_F_PRESENT;
 477 }
 478
 479 static void sfp_gpio_set_state(struct sfp *sfp, unsigned int state)
 480 {
 481         if (state & SFP_F_PRESENT) {
 482                 /* If the module is present, drive the signals */
 483                 if (sfp->gpio[GPIO_TX_DISABLE])
 484                         gpiod_direction_output(sfp->gpio[GPIO_TX_DISABLE],
 485                                                state & SFP_F_TX_DISABLE);
 486                 if (state & SFP_F_RATE_SELECT)
 487                         gpiod_direction_output(sfp->gpio[GPIO_RATE_SELECT],
 488                                                state & SFP_F_RATE_SELECT);
 489         } else {
 490                 /* Otherwise, let them float to the pull-ups */
 491                 if (sfp->gpio[GPIO_TX_DISABLE])
 492                         gpiod_direction_input(sfp->gpio[GPIO_TX_DISABLE]);
 493                 if (state & SFP_F_RATE_SELECT)
 494                         gpiod_direction_input(sfp->gpio[GPIO_RATE_SELECT]);
 495         }
 496 }
 497
 498 static int sfp_i2c_read(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
 499                         size_t len)
 500 {
 501         struct i2c_msg msgs[2];
 502         u8 bus_addr = a2 ? 0x51 : 0x50;
 503         size_t block_size = sfp->i2c_block_size;
 504         size_t this_len;
 505         int ret;
 506
 507         msgs[0].addr = bus_addr;
 508         msgs[0].flags = 0;
 509         msgs[0].len = 1;
 510         msgs[0].buf = &dev_addr;
 511         msgs[1].addr = bus_addr;
 512         msgs[1].flags = I2C_M_RD;
 513         msgs[1].len = len;
 514         msgs[1].buf = buf;
 515
 516         while (len) {
 517                 this_len = len;
 518                 if (this_len > block_size)
 519                         this_len = block_size;
 520
 521                 msgs[1].len = this_len;
 522
 523                 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
 524                 if (ret < 0)
 525                         return ret;
 526
 527                 if (ret != ARRAY_SIZE(msgs))
 528                         break;
 529
 530                 msgs[1].buf += this_len;
 531                 dev_addr += this_len;
 532                 len -= this_len;
 533         }
 534
 535         return msgs[1].buf - (u8 *)buf;
 536 }
 537
 538 static int sfp_i2c_write(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
 539         size_t len)
 540 {
 541         struct i2c_msg msgs[1];
 542         u8 bus_addr = a2 ? 0x51 : 0x50;
 543         int ret;
 544
 545         msgs[0].addr = bus_addr;
 546         msgs[0].flags = 0;
 547         msgs[0].len = 1 + len;
 548         msgs[0].buf = kmalloc(1 + len, GFP_KERNEL);
 549         if (!msgs[0].buf)
 550                 return -ENOMEM;
 551
 552         msgs[0].buf[0] = dev_addr;
 553         memcpy(&msgs[0].buf[1], buf, len);
 554
 555         ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
 556
 557         kfree(msgs[0].buf);
 558
 559         if (ret < 0)
 560                 return ret;
 561
 562         return ret == ARRAY_SIZE(msgs) ? len : 0;
 563 }
 564
 565 static int sfp_i2c_configure(struct sfp *sfp, struct i2c_adapter *i2c)
 566 {
 567         if (!i2c_check_functionality(i2c, I2C_FUNC_I2C))
 568                 return -EINVAL;
 569
 570         sfp->i2c = i2c;
 571         sfp->read = sfp_i2c_read;
 572         sfp->write = sfp_i2c_write;
 573
 574         return 0;
 575 }
 576
 577 static int sfp_i2c_mdiobus_create(struct sfp *sfp)
 578 {
 579         struct mii_bus *i2c_mii;
 580         int ret;
 581
 582         i2c_mii = mdio_i2c_alloc(sfp->dev, sfp->i2c, sfp->mdio_protocol);
 583         if (IS_ERR(i2c_mii))
 584                 return PTR_ERR(i2c_mii);
 585
 586         i2c_mii->name = "SFP I2C Bus";
 587         i2c_mii->phy_mask = ~0;
 588
 589         ret = mdiobus_register(i2c_mii);
 590         if (ret < 0) {
 591                 mdiobus_free(i2c_mii);
 592                 return ret;
 593         }
 594
 595         sfp->i2c_mii = i2c_mii;
 596
 597         return 0;
 598 }
 599
 600 static void sfp_i2c_mdiobus_destroy(struct sfp *sfp)
 601 {
 602         mdiobus_unregister(sfp->i2c_mii);
 603         sfp->i2c_mii = NULL;
 604 }
 605
 606 /* Interface */
 607 static int sfp_read(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
 608 {
 609         return sfp->read(sfp, a2, addr, buf, len);
 610 }
 611
 612 static int sfp_write(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
 613 {
 614         return sfp->write(sfp, a2, addr, buf, len);
 615 }
 616
 617 static unsigned int sfp_soft_get_state(struct sfp *sfp)
 618 {
 619         unsigned int state = 0;
 620         u8 status;
 621         int ret;
 622
 623         ret = sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status));
 624         if (ret == sizeof(status)) {
 625                 if (status & SFP_STATUS_RX_LOS)
 626                         state |= SFP_F_LOS;
 627                 if (status & SFP_STATUS_TX_FAULT)
 628                         state |= SFP_F_TX_FAULT;
 629         } else {
 630                 dev_err_ratelimited(sfp->dev,
 631                                     "failed to read SFP soft status: %pe\n",
 632                                     ERR_PTR(ret));
 633                 /* Preserve the current state */
 634                 state = sfp->state;
 635         }
 636
 637         return state & sfp->state_soft_mask;
 638 }
 639
 640 static void sfp_soft_set_state(struct sfp *sfp, unsigned int state)
 641 {
 642         u8 status;
 643
 644         if (sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status)) ==
 645                      sizeof(status)) {
 646                 if (state & SFP_F_TX_DISABLE)
 647                         status |= SFP_STATUS_TX_DISABLE_FORCE;
 648                 else
 649                         status &= ~SFP_STATUS_TX_DISABLE_FORCE;
 650
 651                 sfp_write(sfp, true, SFP_STATUS, &status, sizeof(status));
 652         }
 653 }
 654
 655 static void sfp_soft_start_poll(struct sfp *sfp)
 656 {
 657         const struct sfp_eeprom_id *id = &sfp->id;
 658         unsigned int mask = 0;
 659
 660         sfp->state_soft_mask = 0;
 661         if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_DISABLE)
 662                 mask |= SFP_F_TX_DISABLE;
 663         if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_FAULT)
 664                 mask |= SFP_F_TX_FAULT;
 665         if (id->ext.enhopts & SFP_ENHOPTS_SOFT_RX_LOS)
 666                 mask |= SFP_F_LOS;
 667
 668         // Poll the soft state for hardware pins we want to ignore
 669         sfp->state_soft_mask = ~sfp->state_hw_mask & mask;
 670
 671         if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) &&
 672             !sfp->need_poll)
 673                 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
 674 }
 675
 676 static void sfp_soft_stop_poll(struct sfp *sfp)
 677 {
 678         sfp->state_soft_mask = 0;
 679 }
 680
 681 static unsigned int sfp_get_state(struct sfp *sfp)
 682 {
 683         unsigned int soft = sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT);
 684         unsigned int state;
 685
 686         state = sfp->get_state(sfp) & sfp->state_hw_mask;
 687         if (state & SFP_F_PRESENT && soft)
 688                 state |= sfp_soft_get_state(sfp);
 689
 690         return state;
 691 }
 692
 693 static void sfp_set_state(struct sfp *sfp, unsigned int state)
 694 {
 695         sfp->set_state(sfp, state);
 696
 697         if (state & SFP_F_PRESENT &&
 698             sfp->state_soft_mask & SFP_F_TX_DISABLE)
 699                 sfp_soft_set_state(sfp, state);
 700 }
 701
 702 static unsigned int sfp_check(void *buf, size_t len)
 703 {
 704         u8 *p, check;
 705
 706         for (p = buf, check = 0; len; p++, len--)
 707                 check += *p;
 708
 709         return check;
 710 }
 711
 712 /* hwmon */
 713 #if IS_ENABLED(CONFIG_HWMON)
 714 static umode_t sfp_hwmon_is_visible(const void *data,
 715                                     enum hwmon_sensor_types type,
 716                                     u32 attr, int channel)
 717 {
 718         const struct sfp *sfp = data;
 719
 720         switch (type) {
 721         case hwmon_temp:
 722                 switch (attr) {
 723                 case hwmon_temp_min_alarm:
 724                 case hwmon_temp_max_alarm:
 725                 case hwmon_temp_lcrit_alarm:
 726                 case hwmon_temp_crit_alarm:
 727                 case hwmon_temp_min:
 728                 case hwmon_temp_max:
 729                 case hwmon_temp_lcrit:
 730                 case hwmon_temp_crit:
 731                         if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
 732                                 return 0;
 733                         fallthrough;
 734                 case hwmon_temp_input:
 735                 case hwmon_temp_label:
 736                         return 0444;
 737                 default:
 738                         return 0;
 739                 }
 740         case hwmon_in:
 741                 switch (attr) {
 742                 case hwmon_in_min_alarm:
 743                 case hwmon_in_max_alarm:
 744                 case hwmon_in_lcrit_alarm:
 745                 case hwmon_in_crit_alarm:
 746                 case hwmon_in_min:
 747                 case hwmon_in_max:
 748                 case hwmon_in_lcrit:
 749                 case hwmon_in_crit:
 750                         if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
 751                                 return 0;
 752                         fallthrough;
 753                 case hwmon_in_input:
 754                 case hwmon_in_label:
 755                         return 0444;
 756                 default:
 757                         return 0;
 758                 }
 759         case hwmon_curr:
 760                 switch (attr) {
 761                 case hwmon_curr_min_alarm:
 762                 case hwmon_curr_max_alarm:
 763                 case hwmon_curr_lcrit_alarm:
 764                 case hwmon_curr_crit_alarm:
 765                 case hwmon_curr_min:
 766                 case hwmon_curr_max:
 767                 case hwmon_curr_lcrit:
 768                 case hwmon_curr_crit:
 769                         if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
 770                                 return 0;
 771                         fallthrough;
 772                 case hwmon_curr_input:
 773                 case hwmon_curr_label:
 774                         return 0444;
 775                 default:
 776                         return 0;
 777                 }
 778         case hwmon_power:
 779                 /* External calibration of receive power requires
 780                  * floating point arithmetic. Doing that in the kernel
 781                  * is not easy, so just skip it. If the module does
 782                  * not require external calibration, we can however
 783                  * show receiver power, since FP is then not needed.
 784                  */
 785                 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL &&
 786                     channel == 1)
 787                         return 0;
 788                 switch (attr) {
 789                 case hwmon_power_min_alarm:
 790                 case hwmon_power_max_alarm:
 791                 case hwmon_power_lcrit_alarm:
 792                 case hwmon_power_crit_alarm:
 793                 case hwmon_power_min:
 794                 case hwmon_power_max:
 795                 case hwmon_power_lcrit:
 796                 case hwmon_power_crit:
 797                         if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
 798                                 return 0;
 799                         fallthrough;
 800                 case hwmon_power_input:
 801                 case hwmon_power_label:
 802                         return 0444;
 803                 default:
 804                         return 0;
 805                 }
 806         default:
 807                 return 0;
 808         }
 809 }
 810
 811 static int sfp_hwmon_read_sensor(struct sfp *sfp, int reg, long *value)
 812 {
 813         __be16 val;
 814         int err;
 815
 816         err = sfp_read(sfp, true, reg, &val, sizeof(val));
 817         if (err < 0)
 818                 return err;
 819
 820         *value = be16_to_cpu(val);
 821
 822         return 0;
 823 }
 824
 825 static void sfp_hwmon_to_rx_power(long *value)
 826 {
 827         *value = DIV_ROUND_CLOSEST(*value, 10);
 828 }
 829
 830 static void sfp_hwmon_calibrate(struct sfp *sfp, unsigned int slope, int offset,
 831                                 long *value)
 832 {
 833         if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL)
 834                 *value = DIV_ROUND_CLOSEST(*value * slope, 256) + offset;
 835 }
 836
 837 static void sfp_hwmon_calibrate_temp(struct sfp *sfp, long *value)
 838 {
 839         sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_t_slope),
 840                             be16_to_cpu(sfp->diag.cal_t_offset), value);
 841
 842         if (*value >= 0x8000)
 843                 *value -= 0x10000;
 844
 845         *value = DIV_ROUND_CLOSEST(*value * 1000, 256);
 846 }
 847
 848 static void sfp_hwmon_calibrate_vcc(struct sfp *sfp, long *value)
 849 {
 850         sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_v_slope),
 851                             be16_to_cpu(sfp->diag.cal_v_offset), value);
 852
 853         *value = DIV_ROUND_CLOSEST(*value, 10);
 854 }
 855
 856 static void sfp_hwmon_calibrate_bias(struct sfp *sfp, long *value)
 857 {
 858         sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txi_slope),
 859                             be16_to_cpu(sfp->diag.cal_txi_offset), value);
 860
 861         *value = DIV_ROUND_CLOSEST(*value, 500);
 862 }
 863
 864 static void sfp_hwmon_calibrate_tx_power(struct sfp *sfp, long *value)
 865 {
 866         sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txpwr_slope),
 867                             be16_to_cpu(sfp->diag.cal_txpwr_offset), value);
 868
 869         *value = DIV_ROUND_CLOSEST(*value, 10);
 870 }
 871
 872 static int sfp_hwmon_read_temp(struct sfp *sfp, int reg, long *value)
 873 {
 874         int err;
 875
 876         err = sfp_hwmon_read_sensor(sfp, reg, value);
 877         if (err < 0)
 878                 return err;
 879
 880         sfp_hwmon_calibrate_temp(sfp, value);
 881
 882         return 0;
 883 }
 884
 885 static int sfp_hwmon_read_vcc(struct sfp *sfp, int reg, long *value)
 886 {
 887         int err;
 888
 889         err = sfp_hwmon_read_sensor(sfp, reg, value);
 890         if (err < 0)
 891                 return err;
 892
 893         sfp_hwmon_calibrate_vcc(sfp, value);
 894
 895         return 0;
 896 }
 897
 898 static int sfp_hwmon_read_bias(struct sfp *sfp, int reg, long *value)
 899 {
 900         int err;
 901
 902         err = sfp_hwmon_read_sensor(sfp, reg, value);
 903         if (err < 0)
 904                 return err;
 905
 906         sfp_hwmon_calibrate_bias(sfp, value);
 907
 908         return 0;
 909 }
 910
 911 static int sfp_hwmon_read_tx_power(struct sfp *sfp, int reg, long *value)
 912 {
 913         int err;
 914
 915         err = sfp_hwmon_read_sensor(sfp, reg, value);
 916         if (err < 0)
 917                 return err;
 918
 919         sfp_hwmon_calibrate_tx_power(sfp, value);
 920
 921         return 0;
 922 }
 923
 924 static int sfp_hwmon_read_rx_power(struct sfp *sfp, int reg, long *value)
 925 {
 926         int err;
 927
 928         err = sfp_hwmon_read_sensor(sfp, reg, value);
 929         if (err < 0)
 930                 return err;
 931
 932         sfp_hwmon_to_rx_power(value);
 933
 934         return 0;
 935 }
 936
 937 static int sfp_hwmon_temp(struct sfp *sfp, u32 attr, long *value)
 938 {
 939         u8 status;
 940         int err;
 941
 942         switch (attr) {
 943         case hwmon_temp_input:
 944                 return sfp_hwmon_read_temp(sfp, SFP_TEMP, value);
 945
 946         case hwmon_temp_lcrit:
 947                 *value = be16_to_cpu(sfp->diag.temp_low_alarm);
 948                 sfp_hwmon_calibrate_temp(sfp, value);
 949                 return 0;
 950
 951         case hwmon_temp_min:
 952                 *value = be16_to_cpu(sfp->diag.temp_low_warn);
 953                 sfp_hwmon_calibrate_temp(sfp, value);
 954                 return 0;
 955         case hwmon_temp_max:
 956                 *value = be16_to_cpu(sfp->diag.temp_high_warn);
 957                 sfp_hwmon_calibrate_temp(sfp, value);
 958                 return 0;
 959
 960         case hwmon_temp_crit:
 961                 *value = be16_to_cpu(sfp->diag.temp_high_alarm);
 962                 sfp_hwmon_calibrate_temp(sfp, value);
 963                 return 0;
 964
 965         case hwmon_temp_lcrit_alarm:
 966                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
 967                 if (err < 0)
 968                         return err;
 969
 970                 *value = !!(status & SFP_ALARM0_TEMP_LOW);
 971                 return 0;
 972
 973         case hwmon_temp_min_alarm:
 974                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
 975                 if (err < 0)
 976                         return err;
 977
 978                 *value = !!(status & SFP_WARN0_TEMP_LOW);
 979                 return 0;
 980
 981         case hwmon_temp_max_alarm:
 982                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
 983                 if (err < 0)
 984                         return err;
 985
 986                 *value = !!(status & SFP_WARN0_TEMP_HIGH);
 987                 return 0;
 988
 989         case hwmon_temp_crit_alarm:
 990                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
 991                 if (err < 0)
 992                         return err;
 993
 994                 *value = !!(status & SFP_ALARM0_TEMP_HIGH);
 995                 return 0;
 996         default:
 997                 return -EOPNOTSUPP;
 998         }
 999
1000         return -EOPNOTSUPP;
1001 }
1002
1003 static int sfp_hwmon_vcc(struct sfp *sfp, u32 attr, long *value)
1004 {
1005         u8 status;
1006         int err;
1007
1008         switch (attr) {
1009         case hwmon_in_input:
1010                 return sfp_hwmon_read_vcc(sfp, SFP_VCC, value);
1011
1012         case hwmon_in_lcrit:
1013                 *value = be16_to_cpu(sfp->diag.volt_low_alarm);
1014                 sfp_hwmon_calibrate_vcc(sfp, value);
1015                 return 0;
1016
1017         case hwmon_in_min:
1018                 *value = be16_to_cpu(sfp->diag.volt_low_warn);
1019                 sfp_hwmon_calibrate_vcc(sfp, value);
1020                 return 0;
1021
1022         case hwmon_in_max:
1023                 *value = be16_to_cpu(sfp->diag.volt_high_warn);
1024                 sfp_hwmon_calibrate_vcc(sfp, value);
1025                 return 0;
1026
1027         case hwmon_in_crit:
1028                 *value = be16_to_cpu(sfp->diag.volt_high_alarm);
1029                 sfp_hwmon_calibrate_vcc(sfp, value);
1030                 return 0;
1031
1032         case hwmon_in_lcrit_alarm:
1033                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1034                 if (err < 0)
1035                         return err;
1036
1037                 *value = !!(status & SFP_ALARM0_VCC_LOW);
1038                 return 0;
1039
1040         case hwmon_in_min_alarm:
1041                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1042                 if (err < 0)
1043                         return err;
1044
1045                 *value = !!(status & SFP_WARN0_VCC_LOW);
1046                 return 0;
1047
1048         case hwmon_in_max_alarm:
1049                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1050                 if (err < 0)
1051                         return err;
1052
1053                 *value = !!(status & SFP_WARN0_VCC_HIGH);
1054                 return 0;
1055
1056         case hwmon_in_crit_alarm:
1057                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1058                 if (err < 0)
1059                         return err;
1060
1061                 *value = !!(status & SFP_ALARM0_VCC_HIGH);
1062                 return 0;
1063         default:
1064                 return -EOPNOTSUPP;
1065         }
1066
1067         return -EOPNOTSUPP;
1068 }
1069
1070 static int sfp_hwmon_bias(struct sfp *sfp, u32 attr, long *value)
1071 {
1072         u8 status;
1073         int err;
1074
1075         switch (attr) {
1076         case hwmon_curr_input:
1077                 return sfp_hwmon_read_bias(sfp, SFP_TX_BIAS, value);
1078
1079         case hwmon_curr_lcrit:
1080                 *value = be16_to_cpu(sfp->diag.bias_low_alarm);
1081                 sfp_hwmon_calibrate_bias(sfp, value);
1082                 return 0;
1083
1084         case hwmon_curr_min:
1085                 *value = be16_to_cpu(sfp->diag.bias_low_warn);
1086                 sfp_hwmon_calibrate_bias(sfp, value);
1087                 return 0;
1088
1089         case hwmon_curr_max:
1090                 *value = be16_to_cpu(sfp->diag.bias_high_warn);
1091                 sfp_hwmon_calibrate_bias(sfp, value);
1092                 return 0;
1093
1094         case hwmon_curr_crit:
1095                 *value = be16_to_cpu(sfp->diag.bias_high_alarm);
1096                 sfp_hwmon_calibrate_bias(sfp, value);
1097                 return 0;
1098
1099         case hwmon_curr_lcrit_alarm:
1100                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1101                 if (err < 0)
1102                         return err;
1103
1104                 *value = !!(status & SFP_ALARM0_TX_BIAS_LOW);
1105                 return 0;
1106
1107         case hwmon_curr_min_alarm:
1108                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1109                 if (err < 0)
1110                         return err;
1111
1112                 *value = !!(status & SFP_WARN0_TX_BIAS_LOW);
1113                 return 0;
1114
1115         case hwmon_curr_max_alarm:
1116                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1117                 if (err < 0)
1118                         return err;
1119
1120                 *value = !!(status & SFP_WARN0_TX_BIAS_HIGH);
1121                 return 0;
1122
1123         case hwmon_curr_crit_alarm:
1124                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1125                 if (err < 0)
1126                         return err;
1127
1128                 *value = !!(status & SFP_ALARM0_TX_BIAS_HIGH);
1129                 return 0;
1130         default:
1131                 return -EOPNOTSUPP;
1132         }
1133
1134         return -EOPNOTSUPP;
1135 }
1136
1137 static int sfp_hwmon_tx_power(struct sfp *sfp, u32 attr, long *value)
1138 {
1139         u8 status;
1140         int err;
1141
1142         switch (attr) {
1143         case hwmon_power_input:
1144                 return sfp_hwmon_read_tx_power(sfp, SFP_TX_POWER, value);
1145
1146         case hwmon_power_lcrit:
1147                 *value = be16_to_cpu(sfp->diag.txpwr_low_alarm);
1148                 sfp_hwmon_calibrate_tx_power(sfp, value);
1149                 return 0;
1150
1151         case hwmon_power_min:
1152                 *value = be16_to_cpu(sfp->diag.txpwr_low_warn);
1153                 sfp_hwmon_calibrate_tx_power(sfp, value);
1154                 return 0;
1155
1156         case hwmon_power_max:
1157                 *value = be16_to_cpu(sfp->diag.txpwr_high_warn);
1158                 sfp_hwmon_calibrate_tx_power(sfp, value);
1159                 return 0;
1160
1161         case hwmon_power_crit:
1162                 *value = be16_to_cpu(sfp->diag.txpwr_high_alarm);
1163                 sfp_hwmon_calibrate_tx_power(sfp, value);
1164                 return 0;
1165
1166         case hwmon_power_lcrit_alarm:
1167                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1168                 if (err < 0)
1169                         return err;
1170
1171                 *value = !!(status & SFP_ALARM0_TXPWR_LOW);
1172                 return 0;
1173
1174         case hwmon_power_min_alarm:
1175                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1176                 if (err < 0)
1177                         return err;
1178
1179                 *value = !!(status & SFP_WARN0_TXPWR_LOW);
1180                 return 0;
1181
1182         case hwmon_power_max_alarm:
1183                 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1184                 if (err < 0)
1185                         return err;
1186
1187                 *value = !!(status & SFP_WARN0_TXPWR_HIGH);
1188                 return 0;
1189
1190         case hwmon_power_crit_alarm:
1191                 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1192                 if (err < 0)
1193                         return err;
1194
1195                 *value = !!(status & SFP_ALARM0_TXPWR_HIGH);
1196                 return 0;
1197         default:
1198                 return -EOPNOTSUPP;
1199         }
1200
1201         return -EOPNOTSUPP;
1202 }
1203
1204 static int sfp_hwmon_rx_power(struct sfp *sfp, u32 attr, long *value)
1205 {
1206         u8 status;
1207         int err;
1208
1209         switch (attr) {
1210         case hwmon_power_input:
1211                 return sfp_hwmon_read_rx_power(sfp, SFP_RX_POWER, value);
1212
1213         case hwmon_power_lcrit:
1214                 *value = be16_to_cpu(sfp->diag.rxpwr_low_alarm);
1215                 sfp_hwmon_to_rx_power(value);
1216                 return 0;
1217
1218         case hwmon_power_min:
1219                 *value = be16_to_cpu(sfp->diag.rxpwr_low_warn);
1220                 sfp_hwmon_to_rx_power(value);
1221                 return 0;
1222
1223         case hwmon_power_max:
1224                 *value = be16_to_cpu(sfp->diag.rxpwr_high_warn);
1225                 sfp_hwmon_to_rx_power(value);
1226                 return 0;
1227
1228         case hwmon_power_crit:
1229                 *value = be16_to_cpu(sfp->diag.rxpwr_high_alarm);
1230                 sfp_hwmon_to_rx_power(value);
1231                 return 0;
1232
1233         case hwmon_power_lcrit_alarm:
1234                 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1235                 if (err < 0)
1236                         return err;
1237
1238                 *value = !!(status & SFP_ALARM1_RXPWR_LOW);
1239                 return 0;
1240
1241         case hwmon_power_min_alarm:
1242                 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1243                 if (err < 0)
1244                         return err;
1245
1246                 *value = !!(status & SFP_WARN1_RXPWR_LOW);
1247                 return 0;
1248
1249         case hwmon_power_max_alarm:
1250                 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1251                 if (err < 0)
1252                         return err;
1253
1254                 *value = !!(status & SFP_WARN1_RXPWR_HIGH);
1255                 return 0;
1256
1257         case hwmon_power_crit_alarm:
1258                 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1259                 if (err < 0)
1260                         return err;
1261
1262                 *value = !!(status & SFP_ALARM1_RXPWR_HIGH);
1263                 return 0;
1264         default:
1265                 return -EOPNOTSUPP;
1266         }
1267
1268         return -EOPNOTSUPP;
1269 }
1270
1271 static int sfp_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
1272                           u32 attr, int channel, long *value)
1273 {
1274         struct sfp *sfp = dev_get_drvdata(dev);
1275
1276         switch (type) {
1277         case hwmon_temp:
1278                 return sfp_hwmon_temp(sfp, attr, value);
1279         case hwmon_in:
1280                 return sfp_hwmon_vcc(sfp, attr, value);
1281         case hwmon_curr:
1282                 return sfp_hwmon_bias(sfp, attr, value);
1283         case hwmon_power:
1284                 switch (channel) {
1285                 case 0:
1286                         return sfp_hwmon_tx_power(sfp, attr, value);
1287                 case 1:
1288                         return sfp_hwmon_rx_power(sfp, attr, value);
1289                 default:
1290                         return -EOPNOTSUPP;
1291                 }
1292         default:
1293                 return -EOPNOTSUPP;
1294         }
1295 }
1296
1297 static const char *const sfp_hwmon_power_labels[] = {
1298         "TX_power",
1299         "RX_power",
1300 };
1301
1302 static int sfp_hwmon_read_string(struct device *dev,
1303                                  enum hwmon_sensor_types type,
1304                                  u32 attr, int channel, const char **str)
1305 {
1306         switch (type) {
1307         case hwmon_curr:
1308                 switch (attr) {
1309                 case hwmon_curr_label:
1310                         *str = "bias";
1311                         return 0;
1312                 default:
1313                         return -EOPNOTSUPP;
1314                 }
1315                 break;
1316         case hwmon_temp:
1317                 switch (attr) {
1318                 case hwmon_temp_label:
1319                         *str = "temperature";
1320                         return 0;
1321                 default:
1322                         return -EOPNOTSUPP;
1323                 }
1324                 break;
1325         case hwmon_in:
1326                 switch (attr) {
1327                 case hwmon_in_label:
1328                         *str = "VCC";
1329                         return 0;
1330                 default:
1331                         return -EOPNOTSUPP;
1332                 }
1333                 break;
1334         case hwmon_power:
1335                 switch (attr) {
1336                 case hwmon_power_label:
1337                         *str = sfp_hwmon_power_labels[channel];
1338                         return 0;
1339                 default:
1340                         return -EOPNOTSUPP;
1341                 }
1342                 break;
1343         default:
1344                 return -EOPNOTSUPP;
1345         }
1346
1347         return -EOPNOTSUPP;
1348 }
1349
1350 static const struct hwmon_ops sfp_hwmon_ops = {
1351         .is_visible = sfp_hwmon_is_visible,
1352         .read = sfp_hwmon_read,
1353         .read_string = sfp_hwmon_read_string,
1354 };
1355
1356 static const struct hwmon_channel_info *sfp_hwmon_info[] = {
1357         HWMON_CHANNEL_INFO(chip,
1358                            HWMON_C_REGISTER_TZ),
1359         HWMON_CHANNEL_INFO(in,
1360                            HWMON_I_INPUT |
1361                            HWMON_I_MAX | HWMON_I_MIN |
1362                            HWMON_I_MAX_ALARM | HWMON_I_MIN_ALARM |
1363                            HWMON_I_CRIT | HWMON_I_LCRIT |
1364                            HWMON_I_CRIT_ALARM | HWMON_I_LCRIT_ALARM |
1365                            HWMON_I_LABEL),
1366         HWMON_CHANNEL_INFO(temp,
1367                            HWMON_T_INPUT |
1368                            HWMON_T_MAX | HWMON_T_MIN |
1369                            HWMON_T_MAX_ALARM | HWMON_T_MIN_ALARM |
1370                            HWMON_T_CRIT | HWMON_T_LCRIT |
1371                            HWMON_T_CRIT_ALARM | HWMON_T_LCRIT_ALARM |
1372                            HWMON_T_LABEL),
1373         HWMON_CHANNEL_INFO(curr,
1374                            HWMON_C_INPUT |
1375                            HWMON_C_MAX | HWMON_C_MIN |
1376                            HWMON_C_MAX_ALARM | HWMON_C_MIN_ALARM |
1377                            HWMON_C_CRIT | HWMON_C_LCRIT |
1378                            HWMON_C_CRIT_ALARM | HWMON_C_LCRIT_ALARM |
1379                            HWMON_C_LABEL),
1380         HWMON_CHANNEL_INFO(power,
1381                            /* Transmit power */
1382                            HWMON_P_INPUT |
1383                            HWMON_P_MAX | HWMON_P_MIN |
1384                            HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1385                            HWMON_P_CRIT | HWMON_P_LCRIT |
1386                            HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1387                            HWMON_P_LABEL,
1388                            /* Receive power */
1389                            HWMON_P_INPUT |
1390                            HWMON_P_MAX | HWMON_P_MIN |
1391                            HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1392                            HWMON_P_CRIT | HWMON_P_LCRIT |
1393                            HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1394                            HWMON_P_LABEL),
1395         NULL,
1396 };
1397
1398 static const struct hwmon_chip_info sfp_hwmon_chip_info = {
1399         .ops = &sfp_hwmon_ops,
1400         .info = sfp_hwmon_info,
1401 };
1402
1403 static void sfp_hwmon_probe(struct work_struct *work)
1404 {
1405         struct sfp *sfp = container_of(work, struct sfp, hwmon_probe.work);
1406         int err;
1407
1408         /* hwmon interface needs to access 16bit registers in atomic way to
1409          * guarantee coherency of the diagnostic monitoring data. If it is not
1410          * possible to guarantee coherency because EEPROM is broken in such way
1411          * that does not support atomic 16bit read operation then we have to
1412          * skip registration of hwmon device.
1413          */
1414         if (sfp->i2c_block_size < 2) {
1415                 dev_info(sfp->dev,
1416                          "skipping hwmon device registration due to broken EEPROM\n");
1417                 dev_info(sfp->dev,
1418                          "diagnostic EEPROM area cannot be read atomically to guarantee data coherency\n");
1419                 return;
1420         }
1421
1422         err = sfp_read(sfp, true, 0, &sfp->diag, sizeof(sfp->diag));
1423         if (err < 0) {
1424                 if (sfp->hwmon_tries--) {
1425                         mod_delayed_work(system_wq, &sfp->hwmon_probe,
1426                                          T_PROBE_RETRY_SLOW);
1427                 } else {
1428                         dev_warn(sfp->dev, "hwmon probe failed: %pe\n",
1429                                  ERR_PTR(err));
1430                 }
1431                 return;
1432         }
1433
1434         sfp->hwmon_name = hwmon_sanitize_name(dev_name(sfp->dev));
1435         if (IS_ERR(sfp->hwmon_name)) {
1436                 dev_err(sfp->dev, "out of memory for hwmon name\n");
1437                 return;
1438         }
1439
1440         sfp->hwmon_dev = hwmon_device_register_with_info(sfp->dev,
1441                                                          sfp->hwmon_name, sfp,
1442                                                          &sfp_hwmon_chip_info,
1443                                                          NULL);
1444         if (IS_ERR(sfp->hwmon_dev))
1445                 dev_err(sfp->dev, "failed to register hwmon device: %ld\n",
1446                         PTR_ERR(sfp->hwmon_dev));
1447 }
1448
1449 static int sfp_hwmon_insert(struct sfp *sfp)
1450 {
1451         if (sfp->id.ext.sff8472_compliance == SFP_SFF8472_COMPLIANCE_NONE)
1452                 return 0;
1453
1454         if (!(sfp->id.ext.diagmon & SFP_DIAGMON_DDM))
1455                 return 0;
1456
1457         if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1458                 /* This driver in general does not support address
1459                  * change.
1460                  */
1461                 return 0;
1462
1463         mod_delayed_work(system_wq, &sfp->hwmon_probe, 1);
1464         sfp->hwmon_tries = R_PROBE_RETRY_SLOW;
1465
1466         return 0;
1467 }
1468
1469 static void sfp_hwmon_remove(struct sfp *sfp)
1470 {
1471         cancel_delayed_work_sync(&sfp->hwmon_probe);
1472         if (!IS_ERR_OR_NULL(sfp->hwmon_dev)) {
1473                 hwmon_device_unregister(sfp->hwmon_dev);
1474                 sfp->hwmon_dev = NULL;
1475                 kfree(sfp->hwmon_name);
1476         }
1477 }
1478
1479 static int sfp_hwmon_init(struct sfp *sfp)
1480 {
1481         INIT_DELAYED_WORK(&sfp->hwmon_probe, sfp_hwmon_probe);
1482
1483         return 0;
1484 }
1485
1486 static void sfp_hwmon_exit(struct sfp *sfp)
1487 {
1488         cancel_delayed_work_sync(&sfp->hwmon_probe);
1489 }
1490 #else
1491 static int sfp_hwmon_insert(struct sfp *sfp)
1492 {
1493         return 0;
1494 }
1495
1496 static void sfp_hwmon_remove(struct sfp *sfp)
1497 {
1498 }
1499
1500 static int sfp_hwmon_init(struct sfp *sfp)
1501 {
1502         return 0;
1503 }
1504
1505 static void sfp_hwmon_exit(struct sfp *sfp)
1506 {
1507 }
1508 #endif
1509
1510 /* Helpers */
1511 static void sfp_module_tx_disable(struct sfp *sfp)
1512 {
1513         dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1514                 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 1);
1515         sfp->state |= SFP_F_TX_DISABLE;
1516         sfp_set_state(sfp, sfp->state);
1517 }
1518
1519 static void sfp_module_tx_enable(struct sfp *sfp)
1520 {
1521         dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1522                 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 0);
1523         sfp->state &= ~SFP_F_TX_DISABLE;
1524         sfp_set_state(sfp, sfp->state);
1525 }
1526
1527 #if IS_ENABLED(CONFIG_DEBUG_FS)
1528 static int sfp_debug_state_show(struct seq_file *s, void *data)
1529 {
1530         struct sfp *sfp = s->private;
1531
1532         seq_printf(s, "Module state: %s\n",
1533                    mod_state_to_str(sfp->sm_mod_state));
1534         seq_printf(s, "Module probe attempts: %d %d\n",
1535                    R_PROBE_RETRY_INIT - sfp->sm_mod_tries_init,
1536                    R_PROBE_RETRY_SLOW - sfp->sm_mod_tries);
1537         seq_printf(s, "Device state: %s\n",
1538                    dev_state_to_str(sfp->sm_dev_state));
1539         seq_printf(s, "Main state: %s\n",
1540                    sm_state_to_str(sfp->sm_state));
1541         seq_printf(s, "Fault recovery remaining retries: %d\n",
1542                    sfp->sm_fault_retries);
1543         seq_printf(s, "PHY probe remaining retries: %d\n",
1544                    sfp->sm_phy_retries);
1545         seq_printf(s, "moddef0: %d\n", !!(sfp->state & SFP_F_PRESENT));
1546         seq_printf(s, "rx_los: %d\n", !!(sfp->state & SFP_F_LOS));
1547         seq_printf(s, "tx_fault: %d\n", !!(sfp->state & SFP_F_TX_FAULT));
1548         seq_printf(s, "tx_disable: %d\n", !!(sfp->state & SFP_F_TX_DISABLE));
1549         return 0;
1550 }
1551 DEFINE_SHOW_ATTRIBUTE(sfp_debug_state);
1552
1553 static void sfp_debugfs_init(struct sfp *sfp)
1554 {
1555         sfp->debugfs_dir = debugfs_create_dir(dev_name(sfp->dev), NULL);
1556
1557         debugfs_create_file("state", 0600, sfp->debugfs_dir, sfp,
1558                             &sfp_debug_state_fops);
1559 }
1560
1561 static void sfp_debugfs_exit(struct sfp *sfp)
1562 {
1563         debugfs_remove_recursive(sfp->debugfs_dir);
1564 }
1565 #else
1566 static void sfp_debugfs_init(struct sfp *sfp)
1567 {
1568 }
1569
1570 static void sfp_debugfs_exit(struct sfp *sfp)
1571 {
1572 }
1573 #endif
1574
1575 static void sfp_module_tx_fault_reset(struct sfp *sfp)
1576 {
1577         unsigned int state = sfp->state;
1578
1579         if (state & SFP_F_TX_DISABLE)
1580                 return;
1581
1582         sfp_set_state(sfp, state | SFP_F_TX_DISABLE);
1583
1584         udelay(T_RESET_US);
1585
1586         sfp_set_state(sfp, state);
1587 }
1588
1589 /* SFP state machine */
1590 static void sfp_sm_set_timer(struct sfp *sfp, unsigned int timeout)
1591 {
1592         if (timeout)
1593                 mod_delayed_work(system_power_efficient_wq, &sfp->timeout,
1594                                  timeout);
1595         else
1596                 cancel_delayed_work(&sfp->timeout);
1597 }
1598
1599 static void sfp_sm_next(struct sfp *sfp, unsigned int state,
1600                         unsigned int timeout)
1601 {
1602         sfp->sm_state = state;
1603         sfp_sm_set_timer(sfp, timeout);
1604 }
1605
1606 static void sfp_sm_mod_next(struct sfp *sfp, unsigned int state,
1607                             unsigned int timeout)
1608 {
1609         sfp->sm_mod_state = state;
1610         sfp_sm_set_timer(sfp, timeout);
1611 }
1612
1613 static void sfp_sm_phy_detach(struct sfp *sfp)
1614 {
1615         sfp_remove_phy(sfp->sfp_bus);
1616         phy_device_remove(sfp->mod_phy);
1617         phy_device_free(sfp->mod_phy);
1618         sfp->mod_phy = NULL;
1619 }
1620
1621 static int sfp_sm_probe_phy(struct sfp *sfp, int addr, bool is_c45)
1622 {
1623         struct phy_device *phy;
1624         int err;
1625
1626         phy = get_phy_device(sfp->i2c_mii, addr, is_c45);
1627         if (phy == ERR_PTR(-ENODEV))
1628                 return PTR_ERR(phy);
1629         if (IS_ERR(phy)) {
1630                 dev_err(sfp->dev, "mdiobus scan returned %pe\n", phy);
1631                 return PTR_ERR(phy);
1632         }
1633
1634         err = phy_device_register(phy);
1635         if (err) {
1636                 phy_device_free(phy);
1637                 dev_err(sfp->dev, "phy_device_register failed: %pe\n",
1638                         ERR_PTR(err));
1639                 return err;
1640         }
1641
1642         err = sfp_add_phy(sfp->sfp_bus, phy);
1643         if (err) {
1644                 phy_device_remove(phy);
1645                 phy_device_free(phy);
1646                 dev_err(sfp->dev, "sfp_add_phy failed: %pe\n", ERR_PTR(err));
1647                 return err;
1648         }
1649
1650         sfp->mod_phy = phy;
1651
1652         return 0;
1653 }
1654
1655 static void sfp_sm_link_up(struct sfp *sfp)
1656 {
1657         sfp_link_up(sfp->sfp_bus);
1658         sfp_sm_next(sfp, SFP_S_LINK_UP, 0);
1659 }
1660
1661 static void sfp_sm_link_down(struct sfp *sfp)
1662 {
1663         sfp_link_down(sfp->sfp_bus);
1664 }
1665
1666 static void sfp_sm_link_check_los(struct sfp *sfp)
1667 {
1668         const __be16 los_inverted = cpu_to_be16(SFP_OPTIONS_LOS_INVERTED);
1669         const __be16 los_normal = cpu_to_be16(SFP_OPTIONS_LOS_NORMAL);
1670         __be16 los_options = sfp->id.ext.options & (los_inverted | los_normal);
1671         bool los = false;
1672
1673         /* If neither SFP_OPTIONS_LOS_INVERTED nor SFP_OPTIONS_LOS_NORMAL
1674          * are set, we assume that no LOS signal is available. If both are
1675          * set, we assume LOS is not implemented (and is meaningless.)
1676          */
1677         if (los_options == los_inverted)
1678                 los = !(sfp->state & SFP_F_LOS);
1679         else if (los_options == los_normal)
1680                 los = !!(sfp->state & SFP_F_LOS);
1681
1682         if (los)
1683                 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
1684         else
1685                 sfp_sm_link_up(sfp);
1686 }
1687
1688 static bool sfp_los_event_active(struct sfp *sfp, unsigned int event)
1689 {
1690         const __be16 los_inverted = cpu_to_be16(SFP_OPTIONS_LOS_INVERTED);
1691         const __be16 los_normal = cpu_to_be16(SFP_OPTIONS_LOS_NORMAL);
1692         __be16 los_options = sfp->id.ext.options & (los_inverted | los_normal);
1693
1694         return (los_options == los_inverted && event == SFP_E_LOS_LOW) ||
1695                (los_options == los_normal && event == SFP_E_LOS_HIGH);
1696 }
1697
1698 static bool sfp_los_event_inactive(struct sfp *sfp, unsigned int event)
1699 {
1700         const __be16 los_inverted = cpu_to_be16(SFP_OPTIONS_LOS_INVERTED);
1701         const __be16 los_normal = cpu_to_be16(SFP_OPTIONS_LOS_NORMAL);
1702         __be16 los_options = sfp->id.ext.options & (los_inverted | los_normal);
1703
1704         return (los_options == los_inverted && event == SFP_E_LOS_HIGH) ||
1705                (los_options == los_normal && event == SFP_E_LOS_LOW);
1706 }
1707
1708 static void sfp_sm_fault(struct sfp *sfp, unsigned int next_state, bool warn)
1709 {
1710         if (sfp->sm_fault_retries && !--sfp->sm_fault_retries) {
1711                 dev_err(sfp->dev,
1712                         "module persistently indicates fault, disabling\n");
1713                 sfp_sm_next(sfp, SFP_S_TX_DISABLE, 0);
1714         } else {
1715                 if (warn)
1716                         dev_err(sfp->dev, "module transmit fault indicated\n");
1717
1718                 sfp_sm_next(sfp, next_state, T_FAULT_RECOVER);
1719         }
1720 }
1721
1722 static int sfp_sm_add_mdio_bus(struct sfp *sfp)
1723 {
1724         if (sfp->mdio_protocol != MDIO_I2C_NONE)
1725                 return sfp_i2c_mdiobus_create(sfp);
1726
1727         return 0;
1728 }
1729
1730 /* Probe a SFP for a PHY device if the module supports copper - the PHY
1731  * normally sits at I2C bus address 0x56, and may either be a clause 22
1732  * or clause 45 PHY.
1733  *
1734  * Clause 22 copper SFP modules normally operate in Cisco SGMII mode with
1735  * negotiation enabled, but some may be in 1000base-X - which is for the
1736  * PHY driver to determine.
1737  *
1738  * Clause 45 copper SFP+ modules (10G) appear to switch their interface
1739  * mode according to the negotiated line speed.
1740  */
1741 static int sfp_sm_probe_for_phy(struct sfp *sfp)
1742 {
1743         int err = 0;
1744
1745         switch (sfp->mdio_protocol) {
1746         case MDIO_I2C_NONE:
1747                 break;
1748
1749         case MDIO_I2C_MARVELL_C22:
1750                 err = sfp_sm_probe_phy(sfp, SFP_PHY_ADDR, false);
1751                 break;
1752
1753         case MDIO_I2C_C45:
1754                 err = sfp_sm_probe_phy(sfp, SFP_PHY_ADDR, true);
1755                 break;
1756
1757         case MDIO_I2C_ROLLBALL:
1758                 err = sfp_sm_probe_phy(sfp, SFP_PHY_ADDR_ROLLBALL, true);
1759                 break;
1760         }
1761
1762         return err;
1763 }
1764
1765 static int sfp_module_parse_power(struct sfp *sfp)
1766 {
1767         u32 power_mW = 1000;
1768         bool supports_a2;
1769
1770         if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_POWER_DECL))
1771                 power_mW = 1500;
1772         if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_HIGH_POWER_LEVEL))
1773                 power_mW = 2000;
1774
1775         supports_a2 = sfp->id.ext.sff8472_compliance !=
1776                                 SFP_SFF8472_COMPLIANCE_NONE ||
1777                       sfp->id.ext.diagmon & SFP_DIAGMON_DDM;
1778
1779         if (power_mW > sfp->max_power_mW) {
1780                 /* Module power specification exceeds the allowed maximum. */
1781                 if (!supports_a2) {
1782                         /* The module appears not to implement bus address
1783                          * 0xa2, so assume that the module powers up in the
1784                          * indicated mode.
1785                          */
1786                         dev_err(sfp->dev,
1787                                 "Host does not support %u.%uW modules\n",
1788                                 power_mW / 1000, (power_mW / 100) % 10);
1789                         return -EINVAL;
1790                 } else {
1791                         dev_warn(sfp->dev,
1792                                  "Host does not support %u.%uW modules, module left in power mode 1\n",
1793                                  power_mW / 1000, (power_mW / 100) % 10);
1794                         return 0;
1795                 }
1796         }
1797
1798         if (power_mW <= 1000) {
1799                 /* Modules below 1W do not require a power change sequence */
1800                 sfp->module_power_mW = power_mW;
1801                 return 0;
1802         }
1803
1804         if (!supports_a2) {
1805                 /* The module power level is below the host maximum and the
1806                  * module appears not to implement bus address 0xa2, so assume
1807                  * that the module powers up in the indicated mode.
1808                  */
1809                 return 0;
1810         }
1811
1812         /* If the module requires a higher power mode, but also requires
1813          * an address change sequence, warn the user that the module may
1814          * not be functional.
1815          */
1816         if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE) {
1817                 dev_warn(sfp->dev,
1818                          "Address Change Sequence not supported but module requires %u.%uW, module may not be functional\n",
1819                          power_mW / 1000, (power_mW / 100) % 10);
1820                 return 0;
1821         }
1822
1823         sfp->module_power_mW = power_mW;
1824
1825         return 0;
1826 }
1827
1828 static int sfp_sm_mod_hpower(struct sfp *sfp, bool enable)
1829 {
1830         u8 val;
1831         int err;
1832
1833         err = sfp_read(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1834         if (err != sizeof(val)) {
1835                 dev_err(sfp->dev, "Failed to read EEPROM: %pe\n", ERR_PTR(err));
1836                 return -EAGAIN;
1837         }
1838
1839         /* DM7052 reports as a high power module, responds to reads (with
1840          * all bytes 0xff) at 0x51 but does not accept writes.  In any case,
1841          * if the bit is already set, we're already in high power mode.
1842          */
1843         if (!!(val & BIT(0)) == enable)
1844                 return 0;
1845
1846         if (enable)
1847                 val |= BIT(0);
1848         else
1849                 val &= ~BIT(0);
1850
1851         err = sfp_write(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1852         if (err != sizeof(val)) {
1853                 dev_err(sfp->dev, "Failed to write EEPROM: %pe\n",
1854                         ERR_PTR(err));
1855                 return -EAGAIN;
1856         }
1857
1858         if (enable)
1859                 dev_info(sfp->dev, "Module switched to %u.%uW power level\n",
1860                          sfp->module_power_mW / 1000,
1861                          (sfp->module_power_mW / 100) % 10);
1862
1863         return 0;
1864 }
1865
1866 /* GPON modules based on Realtek RTL8672 and RTL9601C chips (e.g. V-SOL
1867  * V2801F, CarlitoxxPro CPGOS03-0490, Ubiquiti U-Fiber Instant, ...) do
1868  * not support multibyte reads from the EEPROM. Each multi-byte read
1869  * operation returns just one byte of EEPROM followed by zeros. There is
1870  * no way to identify which modules are using Realtek RTL8672 and RTL9601C
1871  * chips. Moreover every OEM of V-SOL V2801F module puts its own vendor
1872  * name and vendor id into EEPROM, so there is even no way to detect if
1873  * module is V-SOL V2801F. Therefore check for those zeros in the read
1874  * data and then based on check switch to reading EEPROM to one byte
1875  * at a time.
1876  */
1877 static bool sfp_id_needs_byte_io(struct sfp *sfp, void *buf, size_t len)
1878 {
1879         size_t i, block_size = sfp->i2c_block_size;
1880
1881         /* Already using byte IO */
1882         if (block_size == 1)
1883                 return false;
1884
1885         for (i = 1; i < len; i += block_size) {
1886                 if (memchr_inv(buf + i, '\0', min(block_size - 1, len - i)))
1887                         return false;
1888         }
1889         return true;
1890 }
1891
1892 static int sfp_cotsworks_fixup_check(struct sfp *sfp, struct sfp_eeprom_id *id)
1893 {
1894         u8 check;
1895         int err;
1896
1897         if (id->base.phys_id != SFF8024_ID_SFF_8472 ||
1898             id->base.phys_ext_id != SFP_PHYS_EXT_ID_SFP ||
1899             id->base.connector != SFF8024_CONNECTOR_LC) {
1900                 dev_warn(sfp->dev, "Rewriting fiber module EEPROM with corrected values\n");
1901                 id->base.phys_id = SFF8024_ID_SFF_8472;
1902                 id->base.phys_ext_id = SFP_PHYS_EXT_ID_SFP;
1903                 id->base.connector = SFF8024_CONNECTOR_LC;
1904                 err = sfp_write(sfp, false, SFP_PHYS_ID, &id->base, 3);
1905                 if (err != 3) {
1906                         dev_err(sfp->dev,
1907                                 "Failed to rewrite module EEPROM: %pe\n",
1908                                 ERR_PTR(err));
1909                         return err;
1910                 }
1911
1912                 /* Cotsworks modules have been found to require a delay between write operations. */
1913                 mdelay(50);
1914
1915                 /* Update base structure checksum */
1916                 check = sfp_check(&id->base, sizeof(id->base) - 1);
1917                 err = sfp_write(sfp, false, SFP_CC_BASE, &check, 1);
1918                 if (err != 1) {
1919                         dev_err(sfp->dev,
1920                                 "Failed to update base structure checksum in fiber module EEPROM: %pe\n",
1921                                 ERR_PTR(err));
1922                         return err;
1923                 }
1924         }
1925         return 0;
1926 }
1927
1928 static int sfp_sm_mod_probe(struct sfp *sfp, bool report)
1929 {
1930         /* SFP module inserted - read I2C data */
1931         struct sfp_eeprom_id id;
1932         bool cotsworks_sfbg;
1933         bool cotsworks;
1934         u8 check;
1935         int ret;
1936
1937         sfp->i2c_block_size = SFP_EEPROM_BLOCK_SIZE;
1938
1939         ret = sfp_read(sfp, false, 0, &id.base, sizeof(id.base));
1940         if (ret < 0) {
1941                 if (report)
1942                         dev_err(sfp->dev, "failed to read EEPROM: %pe\n",
1943                                 ERR_PTR(ret));
1944                 return -EAGAIN;
1945         }
1946
1947         if (ret != sizeof(id.base)) {
1948                 dev_err(sfp->dev, "EEPROM short read: %pe\n", ERR_PTR(ret));
1949                 return -EAGAIN;
1950         }
1951
1952         /* Some SFP modules (e.g. Nokia 3FE46541AA) lock up if read from
1953          * address 0x51 is just one byte at a time. Also SFF-8472 requires
1954          * that EEPROM supports atomic 16bit read operation for diagnostic
1955          * fields, so do not switch to one byte reading at a time unless it
1956          * is really required and we have no other option.
1957          */
1958         if (sfp_id_needs_byte_io(sfp, &id.base, sizeof(id.base))) {
1959                 dev_info(sfp->dev,
1960                          "Detected broken RTL8672/RTL9601C emulated EEPROM\n");
1961                 dev_info(sfp->dev,
1962                          "Switching to reading EEPROM to one byte at a time\n");
1963                 sfp->i2c_block_size = 1;
1964
1965                 ret = sfp_read(sfp, false, 0, &id.base, sizeof(id.base));
1966                 if (ret < 0) {
1967                         if (report)
1968                                 dev_err(sfp->dev,
1969                                         "failed to read EEPROM: %pe\n",
1970                                         ERR_PTR(ret));
1971                         return -EAGAIN;
1972                 }
1973
1974                 if (ret != sizeof(id.base)) {
1975                         dev_err(sfp->dev, "EEPROM short read: %pe\n",
1976                                 ERR_PTR(ret));
1977                         return -EAGAIN;
1978                 }
1979         }
1980
1981         /* Cotsworks do not seem to update the checksums when they
1982          * do the final programming with the final module part number,
1983          * serial number and date code.
1984          */
1985         cotsworks = !memcmp(id.base.vendor_name, "COTSWORKS       ", 16);
1986         cotsworks_sfbg = !memcmp(id.base.vendor_pn, "SFBG", 4);
1987
1988         /* Cotsworks SFF module EEPROM do not always have valid phys_id,
1989          * phys_ext_id, and connector bytes.  Rewrite SFF EEPROM bytes if
1990          * Cotsworks PN matches and bytes are not correct.
1991          */
1992         if (cotsworks && cotsworks_sfbg) {
1993                 ret = sfp_cotsworks_fixup_check(sfp, &id);
1994                 if (ret < 0)
1995                         return ret;
1996         }
1997
1998         /* Validate the checksum over the base structure */
1999         check = sfp_check(&id.base, sizeof(id.base) - 1);
2000         if (check != id.base.cc_base) {
2001                 if (cotsworks) {
2002                         dev_warn(sfp->dev,
2003                                  "EEPROM base structure checksum failure (0x%02x != 0x%02x)\n",
2004                                  check, id.base.cc_base);
2005                 } else {
2006                         dev_err(sfp->dev,
2007                                 "EEPROM base structure checksum failure: 0x%02x != 0x%02x\n",
2008                                 check, id.base.cc_base);
2009                         print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
2010                                        16, 1, &id, sizeof(id), true);
2011                         return -EINVAL;
2012                 }
2013         }
2014
2015         ret = sfp_read(sfp, false, SFP_CC_BASE + 1, &id.ext, sizeof(id.ext));
2016         if (ret < 0) {
2017                 if (report)
2018                         dev_err(sfp->dev, "failed to read EEPROM: %pe\n",
2019                                 ERR_PTR(ret));
2020                 return -EAGAIN;
2021         }
2022
2023         if (ret != sizeof(id.ext)) {
2024                 dev_err(sfp->dev, "EEPROM short read: %pe\n", ERR_PTR(ret));
2025                 return -EAGAIN;
2026         }
2027
2028         check = sfp_check(&id.ext, sizeof(id.ext) - 1);
2029         if (check != id.ext.cc_ext) {
2030                 if (cotsworks) {
2031                         dev_warn(sfp->dev,
2032                                  "EEPROM extended structure checksum failure (0x%02x != 0x%02x)\n",
2033                                  check, id.ext.cc_ext);
2034                 } else {
2035                         dev_err(sfp->dev,
2036                                 "EEPROM extended structure checksum failure: 0x%02x != 0x%02x\n",
2037                                 check, id.ext.cc_ext);
2038                         print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
2039                                        16, 1, &id, sizeof(id), true);
2040                         memset(&id.ext, 0, sizeof(id.ext));
2041                 }
2042         }
2043
2044         sfp->id = id;
2045
2046         dev_info(sfp->dev, "module %.*s %.*s rev %.*s sn %.*s dc %.*s\n",
2047                  (int)sizeof(id.base.vendor_name), id.base.vendor_name,
2048                  (int)sizeof(id.base.vendor_pn), id.base.vendor_pn,
2049                  (int)sizeof(id.base.vendor_rev), id.base.vendor_rev,
2050                  (int)sizeof(id.ext.vendor_sn), id.ext.vendor_sn,
2051                  (int)sizeof(id.ext.datecode), id.ext.datecode);
2052
2053         /* Check whether we support this module */
2054         if (!sfp->type->module_supported(&id)) {
2055                 dev_err(sfp->dev,
2056                         "module is not supported - phys id 0x%02x 0x%02x\n",
2057                         sfp->id.base.phys_id, sfp->id.base.phys_ext_id);
2058                 return -EINVAL;
2059         }
2060
2061         /* If the module requires address swap mode, warn about it */
2062         if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
2063                 dev_warn(sfp->dev,
2064                          "module address swap to access page 0xA2 is not supported.\n");
2065
2066         /* Parse the module power requirement */
2067         ret = sfp_module_parse_power(sfp);
2068         if (ret < 0)
2069                 return ret;
2070
2071         /* Initialise state bits to use from hardware */
2072         sfp->state_hw_mask = SFP_F_PRESENT;
2073         if (sfp->gpio[GPIO_TX_DISABLE])
2074                 sfp->state_hw_mask |= SFP_F_TX_DISABLE;
2075         if (sfp->gpio[GPIO_TX_FAULT])
2076                 sfp->state_hw_mask |= SFP_F_TX_FAULT;
2077         if (sfp->gpio[GPIO_LOS])
2078                 sfp->state_hw_mask |= SFP_F_LOS;
2079
2080         sfp->module_t_start_up = T_START_UP;
2081         sfp->module_t_wait = T_WAIT;
2082
2083         sfp->tx_fault_ignore = false;
2084
2085         if (sfp->id.base.extended_cc == SFF8024_ECC_10GBASE_T_SFI ||
2086             sfp->id.base.extended_cc == SFF8024_ECC_10GBASE_T_SR ||
2087             sfp->id.base.extended_cc == SFF8024_ECC_5GBASE_T ||
2088             sfp->id.base.extended_cc == SFF8024_ECC_2_5GBASE_T)
2089                 sfp->mdio_protocol = MDIO_I2C_C45;
2090         else if (sfp->id.base.e1000_base_t)
2091                 sfp->mdio_protocol = MDIO_I2C_MARVELL_C22;
2092         else
2093                 sfp->mdio_protocol = MDIO_I2C_NONE;
2094
2095         sfp->quirk = sfp_lookup_quirk(&id);
2096         if (sfp->quirk && sfp->quirk->fixup)
2097                 sfp->quirk->fixup(sfp);
2098
2099         return 0;
2100 }
2101
2102 static void sfp_sm_mod_remove(struct sfp *sfp)
2103 {
2104         if (sfp->sm_mod_state > SFP_MOD_WAITDEV)
2105                 sfp_module_remove(sfp->sfp_bus);
2106
2107         sfp_hwmon_remove(sfp);
2108
2109         memset(&sfp->id, 0, sizeof(sfp->id));
2110         sfp->module_power_mW = 0;
2111
2112         dev_info(sfp->dev, "module removed\n");
2113 }
2114
2115 /* This state machine tracks the upstream's state */
2116 static void sfp_sm_device(struct sfp *sfp, unsigned int event)
2117 {
2118         switch (sfp->sm_dev_state) {
2119         default:
2120                 if (event == SFP_E_DEV_ATTACH)
2121                         sfp->sm_dev_state = SFP_DEV_DOWN;
2122                 break;
2123
2124         case SFP_DEV_DOWN:
2125                 if (event == SFP_E_DEV_DETACH)
2126                         sfp->sm_dev_state = SFP_DEV_DETACHED;
2127                 else if (event == SFP_E_DEV_UP)
2128                         sfp->sm_dev_state = SFP_DEV_UP;
2129                 break;
2130
2131         case SFP_DEV_UP:
2132                 if (event == SFP_E_DEV_DETACH)
2133                         sfp->sm_dev_state = SFP_DEV_DETACHED;
2134                 else if (event == SFP_E_DEV_DOWN)
2135                         sfp->sm_dev_state = SFP_DEV_DOWN;
2136                 break;
2137         }
2138 }
2139
2140 /* This state machine tracks the insert/remove state of the module, probes
2141  * the on-board EEPROM, and sets up the power level.
2142  */
2143 static void sfp_sm_module(struct sfp *sfp, unsigned int event)
2144 {
2145         int err;
2146
2147         /* Handle remove event globally, it resets this state machine */
2148         if (event == SFP_E_REMOVE) {
2149                 if (sfp->sm_mod_state > SFP_MOD_PROBE)
2150                         sfp_sm_mod_remove(sfp);
2151                 sfp_sm_mod_next(sfp, SFP_MOD_EMPTY, 0);
2152                 return;
2153         }
2154
2155         /* Handle device detach globally */
2156         if (sfp->sm_dev_state < SFP_DEV_DOWN &&
2157             sfp->sm_mod_state > SFP_MOD_WAITDEV) {
2158                 if (sfp->module_power_mW > 1000 &&
2159                     sfp->sm_mod_state > SFP_MOD_HPOWER)
2160                         sfp_sm_mod_hpower(sfp, false);
2161                 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
2162                 return;
2163         }
2164
2165         switch (sfp->sm_mod_state) {
2166         default:
2167                 if (event == SFP_E_INSERT) {
2168                         sfp_sm_mod_next(sfp, SFP_MOD_PROBE, T_SERIAL);
2169                         sfp->sm_mod_tries_init = R_PROBE_RETRY_INIT;
2170                         sfp->sm_mod_tries = R_PROBE_RETRY_SLOW;
2171                 }
2172                 break;
2173
2174         case SFP_MOD_PROBE:
2175                 /* Wait for T_PROBE_INIT to time out */
2176                 if (event != SFP_E_TIMEOUT)
2177                         break;
2178
2179                 err = sfp_sm_mod_probe(sfp, sfp->sm_mod_tries == 1);
2180                 if (err == -EAGAIN) {
2181                         if (sfp->sm_mod_tries_init &&
2182                            --sfp->sm_mod_tries_init) {
2183                                 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
2184                                 break;
2185                         } else if (sfp->sm_mod_tries && --sfp->sm_mod_tries) {
2186                                 if (sfp->sm_mod_tries == R_PROBE_RETRY_SLOW - 1)
2187                                         dev_warn(sfp->dev,
2188                                                  "please wait, module slow to respond\n");
2189                                 sfp_sm_set_timer(sfp, T_PROBE_RETRY_SLOW);
2190                                 break;
2191                         }
2192                 }
2193                 if (err < 0) {
2194                         sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
2195                         break;
2196                 }
2197
2198                 err = sfp_hwmon_insert(sfp);
2199                 if (err)
2200                         dev_warn(sfp->dev, "hwmon probe failed: %pe\n",
2201                                  ERR_PTR(err));
2202
2203                 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
2204                 fallthrough;
2205         case SFP_MOD_WAITDEV:
2206                 /* Ensure that the device is attached before proceeding */
2207                 if (sfp->sm_dev_state < SFP_DEV_DOWN)
2208                         break;
2209
2210                 /* Report the module insertion to the upstream device */
2211                 err = sfp_module_insert(sfp->sfp_bus, &sfp->id,
2212                                         sfp->quirk);
2213                 if (err < 0) {
2214                         sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
2215                         break;
2216                 }
2217
2218                 /* If this is a power level 1 module, we are done */
2219                 if (sfp->module_power_mW <= 1000)
2220                         goto insert;
2221
2222                 sfp_sm_mod_next(sfp, SFP_MOD_HPOWER, 0);
2223                 fallthrough;
2224         case SFP_MOD_HPOWER:
2225                 /* Enable high power mode */
2226                 err = sfp_sm_mod_hpower(sfp, true);
2227                 if (err < 0) {
2228                         if (err != -EAGAIN) {
2229                                 sfp_module_remove(sfp->sfp_bus);
2230                                 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
2231                         } else {
2232                                 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
2233                         }
2234                         break;
2235                 }
2236
2237                 sfp_sm_mod_next(sfp, SFP_MOD_WAITPWR, T_HPOWER_LEVEL);
2238                 break;
2239
2240         case SFP_MOD_WAITPWR:
2241                 /* Wait for T_HPOWER_LEVEL to time out */
2242                 if (event != SFP_E_TIMEOUT)
2243                         break;
2244
2245         insert:
2246                 sfp_sm_mod_next(sfp, SFP_MOD_PRESENT, 0);
2247                 break;
2248
2249         case SFP_MOD_PRESENT:
2250         case SFP_MOD_ERROR:
2251                 break;
2252         }
2253 }
2254
2255 static void sfp_sm_main(struct sfp *sfp, unsigned int event)
2256 {
2257         unsigned long timeout;
2258         int ret;
2259
2260         /* Some events are global */
2261         if (sfp->sm_state != SFP_S_DOWN &&
2262             (sfp->sm_mod_state != SFP_MOD_PRESENT ||
2263              sfp->sm_dev_state != SFP_DEV_UP)) {
2264                 if (sfp->sm_state == SFP_S_LINK_UP &&
2265                     sfp->sm_dev_state == SFP_DEV_UP)
2266                         sfp_sm_link_down(sfp);
2267                 if (sfp->sm_state > SFP_S_INIT)
2268                         sfp_module_stop(sfp->sfp_bus);
2269                 if (sfp->mod_phy)
2270                         sfp_sm_phy_detach(sfp);
2271                 if (sfp->i2c_mii)
2272                         sfp_i2c_mdiobus_destroy(sfp);
2273                 sfp_module_tx_disable(sfp);
2274                 sfp_soft_stop_poll(sfp);
2275                 sfp_sm_next(sfp, SFP_S_DOWN, 0);
2276                 return;
2277         }
2278
2279         /* The main state machine */
2280         switch (sfp->sm_state) {
2281         case SFP_S_DOWN:
2282                 if (sfp->sm_mod_state != SFP_MOD_PRESENT ||
2283                     sfp->sm_dev_state != SFP_DEV_UP)
2284                         break;
2285
2286                 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE))
2287                         sfp_soft_start_poll(sfp);
2288
2289                 sfp_module_tx_enable(sfp);
2290
2291                 /* Initialise the fault clearance retries */
2292                 sfp->sm_fault_retries = N_FAULT_INIT;
2293
2294                 /* We need to check the TX_FAULT state, which is not defined
2295                  * while TX_DISABLE is asserted. The earliest we want to do
2296                  * anything (such as probe for a PHY) is 50ms (or more on
2297                  * specific modules).
2298                  */
2299                 sfp_sm_next(sfp, SFP_S_WAIT, sfp->module_t_wait);
2300                 break;
2301
2302         case SFP_S_WAIT:
2303                 if (event != SFP_E_TIMEOUT)
2304                         break;
2305
2306                 if (sfp->state & SFP_F_TX_FAULT) {
2307                         /* Wait up to t_init (SFF-8472) or t_start_up (SFF-8431)
2308                          * from the TX_DISABLE deassertion for the module to
2309                          * initialise, which is indicated by TX_FAULT
2310                          * deasserting.
2311                          */
2312                         timeout = sfp->module_t_start_up;
2313                         if (timeout > sfp->module_t_wait)
2314                                 timeout -= sfp->module_t_wait;
2315                         else
2316                                 timeout = 1;
2317
2318                         sfp_sm_next(sfp, SFP_S_INIT, timeout);
2319                 } else {
2320                         /* TX_FAULT is not asserted, assume the module has
2321                          * finished initialising.
2322                          */
2323                         goto init_done;
2324                 }
2325                 break;
2326
2327         case SFP_S_INIT:
2328                 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
2329                         /* TX_FAULT is still asserted after t_init
2330                          * or t_start_up, so assume there is a fault.
2331                          */
2332                         sfp_sm_fault(sfp, SFP_S_INIT_TX_FAULT,
2333                                      sfp->sm_fault_retries == N_FAULT_INIT);
2334                 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
2335         init_done:
2336                         /* Create mdiobus and start trying for PHY */
2337                         ret = sfp_sm_add_mdio_bus(sfp);
2338                         if (ret < 0) {
2339                                 sfp_sm_next(sfp, SFP_S_FAIL, 0);
2340                                 break;
2341                         }
2342                         sfp->sm_phy_retries = R_PHY_RETRY;
2343                         goto phy_probe;
2344                 }
2345                 break;
2346
2347         case SFP_S_INIT_PHY:
2348                 if (event != SFP_E_TIMEOUT)
2349                         break;
2350         phy_probe:
2351                 /* TX_FAULT deasserted or we timed out with TX_FAULT
2352                  * clear.  Probe for the PHY and check the LOS state.
2353                  */
2354                 ret = sfp_sm_probe_for_phy(sfp);
2355                 if (ret == -ENODEV) {
2356                         if (--sfp->sm_phy_retries) {
2357                                 sfp_sm_next(sfp, SFP_S_INIT_PHY, T_PHY_RETRY);
2358                                 break;
2359                         } else {
2360                                 dev_info(sfp->dev, "no PHY detected\n");
2361                         }
2362                 } else if (ret) {
2363                         sfp_sm_next(sfp, SFP_S_FAIL, 0);
2364                         break;
2365                 }
2366                 if (sfp_module_start(sfp->sfp_bus)) {
2367                         sfp_sm_next(sfp, SFP_S_FAIL, 0);
2368                         break;
2369                 }
2370                 sfp_sm_link_check_los(sfp);
2371
2372                 /* Reset the fault retry count */
2373                 sfp->sm_fault_retries = N_FAULT;
2374                 break;
2375
2376         case SFP_S_INIT_TX_FAULT:
2377                 if (event == SFP_E_TIMEOUT) {
2378                         sfp_module_tx_fault_reset(sfp);
2379                         sfp_sm_next(sfp, SFP_S_INIT, sfp->module_t_start_up);
2380                 }
2381                 break;
2382
2383         case SFP_S_WAIT_LOS:
2384                 if (event == SFP_E_TX_FAULT)
2385                         sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
2386                 else if (sfp_los_event_inactive(sfp, event))
2387                         sfp_sm_link_up(sfp);
2388                 break;
2389
2390         case SFP_S_LINK_UP:
2391                 if (event == SFP_E_TX_FAULT) {
2392                         sfp_sm_link_down(sfp);
2393                         sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
2394                 } else if (sfp_los_event_active(sfp, event)) {
2395                         sfp_sm_link_down(sfp);
2396                         sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
2397                 }
2398                 break;
2399
2400         case SFP_S_TX_FAULT:
2401                 if (event == SFP_E_TIMEOUT) {
2402                         sfp_module_tx_fault_reset(sfp);
2403                         sfp_sm_next(sfp, SFP_S_REINIT, sfp->module_t_start_up);
2404                 }
2405                 break;
2406
2407         case SFP_S_REINIT:
2408                 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
2409                         sfp_sm_fault(sfp, SFP_S_TX_FAULT, false);
2410                 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
2411                         dev_info(sfp->dev, "module transmit fault recovered\n");
2412                         sfp_sm_link_check_los(sfp);
2413                 }
2414                 break;
2415
2416         case SFP_S_TX_DISABLE:
2417                 break;
2418         }
2419 }
2420
2421 static void sfp_sm_event(struct sfp *sfp, unsigned int event)
2422 {
2423         mutex_lock(&sfp->sm_mutex);
2424
2425         dev_dbg(sfp->dev, "SM: enter %s:%s:%s event %s\n",
2426                 mod_state_to_str(sfp->sm_mod_state),
2427                 dev_state_to_str(sfp->sm_dev_state),
2428                 sm_state_to_str(sfp->sm_state),
2429                 event_to_str(event));
2430
2431         sfp_sm_device(sfp, event);
2432         sfp_sm_module(sfp, event);
2433         sfp_sm_main(sfp, event);
2434
2435         dev_dbg(sfp->dev, "SM: exit %s:%s:%s\n",
2436                 mod_state_to_str(sfp->sm_mod_state),
2437                 dev_state_to_str(sfp->sm_dev_state),
2438                 sm_state_to_str(sfp->sm_state));
2439
2440         mutex_unlock(&sfp->sm_mutex);
2441 }
2442
2443 static void sfp_attach(struct sfp *sfp)
2444 {
2445         sfp_sm_event(sfp, SFP_E_DEV_ATTACH);
2446 }
2447
2448 static void sfp_detach(struct sfp *sfp)
2449 {
2450         sfp_sm_event(sfp, SFP_E_DEV_DETACH);
2451 }
2452
2453 static void sfp_start(struct sfp *sfp)
2454 {
2455         sfp_sm_event(sfp, SFP_E_DEV_UP);
2456 }
2457
2458 static void sfp_stop(struct sfp *sfp)
2459 {
2460         sfp_sm_event(sfp, SFP_E_DEV_DOWN);
2461 }
2462
2463 static int sfp_module_info(struct sfp *sfp, struct ethtool_modinfo *modinfo)
2464 {
2465         /* locking... and check module is present */
2466
2467         if (sfp->id.ext.sff8472_compliance &&
2468             !(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)) {
2469                 modinfo->type = ETH_MODULE_SFF_8472;
2470                 modinfo->eeprom_len = ETH_MODULE_SFF_8472_LEN;
2471         } else {
2472                 modinfo->type = ETH_MODULE_SFF_8079;
2473                 modinfo->eeprom_len = ETH_MODULE_SFF_8079_LEN;
2474         }
2475         return 0;
2476 }
2477
2478 static int sfp_module_eeprom(struct sfp *sfp, struct ethtool_eeprom *ee,
2479                              u8 *data)
2480 {
2481         unsigned int first, last, len;
2482         int ret;
2483
2484         if (ee->len == 0)
2485                 return -EINVAL;
2486
2487         first = ee->offset;
2488         last = ee->offset + ee->len;
2489         if (first < ETH_MODULE_SFF_8079_LEN) {
2490                 len = min_t(unsigned int, last, ETH_MODULE_SFF_8079_LEN);
2491                 len -= first;
2492
2493                 ret = sfp_read(sfp, false, first, data, len);
2494                 if (ret < 0)
2495                         return ret;
2496
2497                 first += len;
2498                 data += len;
2499         }
2500         if (first < ETH_MODULE_SFF_8472_LEN && last > ETH_MODULE_SFF_8079_LEN) {
2501                 len = min_t(unsigned int, last, ETH_MODULE_SFF_8472_LEN);
2502                 len -= first;
2503                 first -= ETH_MODULE_SFF_8079_LEN;
2504
2505                 ret = sfp_read(sfp, true, first, data, len);
2506                 if (ret < 0)
2507                         return ret;
2508         }
2509         return 0;
2510 }
2511
2512 static int sfp_module_eeprom_by_page(struct sfp *sfp,
2513                                      const struct ethtool_module_eeprom *page,
2514                                      struct netlink_ext_ack *extack)
2515 {
2516         if (page->bank) {
2517                 NL_SET_ERR_MSG(extack, "Banks not supported");
2518                 return -EOPNOTSUPP;
2519         }
2520
2521         if (page->page) {
2522                 NL_SET_ERR_MSG(extack, "Only page 0 supported");
2523                 return -EOPNOTSUPP;
2524         }
2525
2526         if (page->i2c_address != 0x50 &&
2527             page->i2c_address != 0x51) {
2528                 NL_SET_ERR_MSG(extack, "Only address 0x50 and 0x51 supported");
2529                 return -EOPNOTSUPP;
2530         }
2531
2532         return sfp_read(sfp, page->i2c_address == 0x51, page->offset,
2533                         page->data, page->length);
2534 };
2535
2536 static const struct sfp_socket_ops sfp_module_ops = {
2537         .attach = sfp_attach,
2538         .detach = sfp_detach,
2539         .start = sfp_start,
2540         .stop = sfp_stop,
2541         .module_info = sfp_module_info,
2542         .module_eeprom = sfp_module_eeprom,
2543         .module_eeprom_by_page = sfp_module_eeprom_by_page,
2544 };
2545
2546 static void sfp_timeout(struct work_struct *work)
2547 {
2548         struct sfp *sfp = container_of(work, struct sfp, timeout.work);
2549
2550         rtnl_lock();
2551         sfp_sm_event(sfp, SFP_E_TIMEOUT);
2552         rtnl_unlock();
2553 }
2554
2555 static void sfp_check_state(struct sfp *sfp)
2556 {
2557         unsigned int state, i, changed;
2558
2559         mutex_lock(&sfp->st_mutex);
2560         state = sfp_get_state(sfp);
2561         changed = state ^ sfp->state;
2562         if (sfp->tx_fault_ignore)
2563                 changed &= SFP_F_PRESENT | SFP_F_LOS;
2564         else
2565                 changed &= SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT;
2566
2567         for (i = 0; i < GPIO_MAX; i++)
2568                 if (changed & BIT(i))
2569                         dev_dbg(sfp->dev, "%s %u -> %u\n", gpio_of_names[i],
2570                                 !!(sfp->state & BIT(i)), !!(state & BIT(i)));
2571
2572         state |= sfp->state & (SFP_F_TX_DISABLE | SFP_F_RATE_SELECT);
2573         sfp->state = state;
2574
2575         rtnl_lock();
2576         if (changed & SFP_F_PRESENT)
2577                 sfp_sm_event(sfp, state & SFP_F_PRESENT ?
2578                                 SFP_E_INSERT : SFP_E_REMOVE);
2579
2580         if (changed & SFP_F_TX_FAULT)
2581                 sfp_sm_event(sfp, state & SFP_F_TX_FAULT ?
2582                                 SFP_E_TX_FAULT : SFP_E_TX_CLEAR);
2583
2584         if (changed & SFP_F_LOS)
2585                 sfp_sm_event(sfp, state & SFP_F_LOS ?
2586                                 SFP_E_LOS_HIGH : SFP_E_LOS_LOW);
2587         rtnl_unlock();
2588         mutex_unlock(&sfp->st_mutex);
2589 }
2590
2591 static irqreturn_t sfp_irq(int irq, void *data)
2592 {
2593         struct sfp *sfp = data;
2594
2595         sfp_check_state(sfp);
2596
2597         return IRQ_HANDLED;
2598 }
2599
2600 static void sfp_poll(struct work_struct *work)
2601 {
2602         struct sfp *sfp = container_of(work, struct sfp, poll.work);
2603
2604         sfp_check_state(sfp);
2605
2606         if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) ||
2607             sfp->need_poll)
2608                 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2609 }
2610
2611 static struct sfp *sfp_alloc(struct device *dev)
2612 {
2613         struct sfp *sfp;
2614
2615         sfp = kzalloc(sizeof(*sfp), GFP_KERNEL);
2616         if (!sfp)
2617                 return ERR_PTR(-ENOMEM);
2618
2619         sfp->dev = dev;
2620         sfp->i2c_block_size = SFP_EEPROM_BLOCK_SIZE;
2621
2622         mutex_init(&sfp->sm_mutex);
2623         mutex_init(&sfp->st_mutex);
2624         INIT_DELAYED_WORK(&sfp->poll, sfp_poll);
2625         INIT_DELAYED_WORK(&sfp->timeout, sfp_timeout);
2626
2627         sfp_hwmon_init(sfp);
2628
2629         return sfp;
2630 }
2631
2632 static void sfp_cleanup(void *data)
2633 {
2634         struct sfp *sfp = data;
2635
2636         sfp_hwmon_exit(sfp);
2637
2638         cancel_delayed_work_sync(&sfp->poll);
2639         cancel_delayed_work_sync(&sfp->timeout);
2640         if (sfp->i2c_mii) {
2641                 mdiobus_unregister(sfp->i2c_mii);
2642                 mdiobus_free(sfp->i2c_mii);
2643         }
2644         if (sfp->i2c)
2645                 i2c_put_adapter(sfp->i2c);
2646         kfree(sfp);
2647 }
2648
2649 static int sfp_probe(struct platform_device *pdev)
2650 {
2651         const struct sff_data *sff;
2652         struct i2c_adapter *i2c;
2653         char *sfp_irq_name;
2654         struct sfp *sfp;
2655         int err, i;
2656
2657         sfp = sfp_alloc(&pdev->dev);
2658         if (IS_ERR(sfp))
2659                 return PTR_ERR(sfp);
2660
2661         platform_set_drvdata(pdev, sfp);
2662
2663         err = devm_add_action_or_reset(sfp->dev, sfp_cleanup, sfp);
2664         if (err < 0)
2665                 return err;
2666
2667         sff = sfp->type = &sfp_data;
2668
2669         if (pdev->dev.of_node) {
2670                 struct device_node *node = pdev->dev.of_node;
2671                 const struct of_device_id *id;
2672                 struct device_node *np;
2673
2674                 id = of_match_node(sfp_of_match, node);
2675                 if (WARN_ON(!id))
2676                         return -EINVAL;
2677
2678                 sff = sfp->type = id->data;
2679
2680                 np = of_parse_phandle(node, "i2c-bus", 0);
2681                 if (!np) {
2682                         dev_err(sfp->dev, "missing 'i2c-bus' property\n");
2683                         return -ENODEV;
2684                 }
2685
2686                 i2c = of_find_i2c_adapter_by_node(np);
2687                 of_node_put(np);
2688         } else if (has_acpi_companion(&pdev->dev)) {
2689                 struct acpi_device *adev = ACPI_COMPANION(&pdev->dev);
2690                 struct fwnode_handle *fw = acpi_fwnode_handle(adev);
2691                 struct fwnode_reference_args args;
2692                 struct acpi_handle *acpi_handle;
2693                 int ret;
2694
2695                 ret = acpi_node_get_property_reference(fw, "i2c-bus", 0, &args);
2696                 if (ret || !is_acpi_device_node(args.fwnode)) {
2697                         dev_err(&pdev->dev, "missing 'i2c-bus' property\n");
2698                         return -ENODEV;
2699                 }
2700
2701                 acpi_handle = ACPI_HANDLE_FWNODE(args.fwnode);
2702                 i2c = i2c_acpi_find_adapter_by_handle(acpi_handle);
2703         } else {
2704                 return -EINVAL;
2705         }
2706
2707         if (!i2c)
2708                 return -EPROBE_DEFER;
2709
2710         err = sfp_i2c_configure(sfp, i2c);
2711         if (err < 0) {
2712                 i2c_put_adapter(i2c);
2713                 return err;
2714         }
2715
2716         for (i = 0; i < GPIO_MAX; i++)
2717                 if (sff->gpios & BIT(i)) {
2718                         sfp->gpio[i] = devm_gpiod_get_optional(sfp->dev,
2719                                            gpio_of_names[i], gpio_flags[i]);
2720                         if (IS_ERR(sfp->gpio[i]))
2721                                 return PTR_ERR(sfp->gpio[i]);
2722                 }
2723
2724         sfp->state_hw_mask = SFP_F_PRESENT;
2725
2726         sfp->get_state = sfp_gpio_get_state;
2727         sfp->set_state = sfp_gpio_set_state;
2728
2729         /* Modules that have no detect signal are always present */
2730         if (!(sfp->gpio[GPIO_MODDEF0]))
2731                 sfp->get_state = sff_gpio_get_state;
2732
2733         device_property_read_u32(&pdev->dev, "maximum-power-milliwatt",
2734                                  &sfp->max_power_mW);
2735         if (!sfp->max_power_mW)
2736                 sfp->max_power_mW = 1000;
2737
2738         dev_info(sfp->dev, "Host maximum power %u.%uW\n",
2739                  sfp->max_power_mW / 1000, (sfp->max_power_mW / 100) % 10);
2740
2741         /* Get the initial state, and always signal TX disable,
2742          * since the network interface will not be up.
2743          */
2744         sfp->state = sfp_get_state(sfp) | SFP_F_TX_DISABLE;
2745
2746         if (sfp->gpio[GPIO_RATE_SELECT] &&
2747             gpiod_get_value_cansleep(sfp->gpio[GPIO_RATE_SELECT]))
2748                 sfp->state |= SFP_F_RATE_SELECT;
2749         sfp_set_state(sfp, sfp->state);
2750         sfp_module_tx_disable(sfp);
2751         if (sfp->state & SFP_F_PRESENT) {
2752                 rtnl_lock();
2753                 sfp_sm_event(sfp, SFP_E_INSERT);
2754                 rtnl_unlock();
2755         }
2756
2757         for (i = 0; i < GPIO_MAX; i++) {
2758                 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
2759                         continue;
2760
2761                 sfp->gpio_irq[i] = gpiod_to_irq(sfp->gpio[i]);
2762                 if (sfp->gpio_irq[i] < 0) {
2763                         sfp->gpio_irq[i] = 0;
2764                         sfp->need_poll = true;
2765                         continue;
2766                 }
2767
2768                 sfp_irq_name = devm_kasprintf(sfp->dev, GFP_KERNEL,
2769                                               "%s-%s", dev_name(sfp->dev),
2770                                               gpio_of_names[i]);
2771
2772                 if (!sfp_irq_name)
2773                         return -ENOMEM;
2774
2775                 err = devm_request_threaded_irq(sfp->dev, sfp->gpio_irq[i],
2776                                                 NULL, sfp_irq,
2777                                                 IRQF_ONESHOT |
2778                                                 IRQF_TRIGGER_RISING |
2779                                                 IRQF_TRIGGER_FALLING,
2780                                                 sfp_irq_name, sfp);
2781                 if (err) {
2782                         sfp->gpio_irq[i] = 0;
2783                         sfp->need_poll = true;
2784                 }
2785         }
2786
2787         if (sfp->need_poll)
2788                 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2789
2790         /* We could have an issue in cases no Tx disable pin is available or
2791          * wired as modules using a laser as their light source will continue to
2792          * be active when the fiber is removed. This could be a safety issue and
2793          * we should at least warn the user about that.
2794          */
2795         if (!sfp->gpio[GPIO_TX_DISABLE])
2796                 dev_warn(sfp->dev,
2797                          "No tx_disable pin: SFP modules will always be emitting.\n");
2798
2799         sfp->sfp_bus = sfp_register_socket(sfp->dev, sfp, &sfp_module_ops);
2800         if (!sfp->sfp_bus)
2801                 return -ENOMEM;
2802
2803         sfp_debugfs_init(sfp);
2804
2805         return 0;
2806 }
2807
2808 static int sfp_remove(struct platform_device *pdev)
2809 {
2810         struct sfp *sfp = platform_get_drvdata(pdev);
2811
2812         sfp_debugfs_exit(sfp);
2813         sfp_unregister_socket(sfp->sfp_bus);
2814
2815         rtnl_lock();
2816         sfp_sm_event(sfp, SFP_E_REMOVE);
2817         rtnl_unlock();
2818
2819         return 0;
2820 }
2821
2822 static void sfp_shutdown(struct platform_device *pdev)
2823 {
2824         struct sfp *sfp = platform_get_drvdata(pdev);
2825         int i;
2826
2827         for (i = 0; i < GPIO_MAX; i++) {
2828                 if (!sfp->gpio_irq[i])
2829                         continue;
2830
2831                 devm_free_irq(sfp->dev, sfp->gpio_irq[i], sfp);
2832         }
2833
2834         cancel_delayed_work_sync(&sfp->poll);
2835         cancel_delayed_work_sync(&sfp->timeout);
2836 }
2837
2838 static struct platform_driver sfp_driver = {
2839         .probe = sfp_probe,
2840         .remove = sfp_remove,
2841         .shutdown = sfp_shutdown,
2842         .driver = {
2843                 .name = "sfp",
2844                 .of_match_table = sfp_of_match,
2845         },
2846 };
2847
2848 static int sfp_init(void)
2849 {
2850         poll_jiffies = msecs_to_jiffies(100);
2851
2852         return platform_driver_register(&sfp_driver);
2853 }
2854 module_init(sfp_init);
2855
2856 static void sfp_exit(void)
2857 {
2858         platform_driver_unregister(&sfp_driver);
2859 }
2860 module_exit(sfp_exit);
2861
2862 MODULE_ALIAS("platform:sfp");
2863 MODULE_AUTHOR("Russell King");
2864 MODULE_LICENSE("GPL v2");