1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/acpi.h>
3 #include <linux/ctype.h>
4 #include <linux/delay.h>
5 #include <linux/gpio/consumer.h>
6 #include <linux/hwmon.h>
8 #include <linux/interrupt.h>
9 #include <linux/jiffies.h>
10 #include <linux/mdio/mdio-i2c.h>
11 #include <linux/module.h>
12 #include <linux/mutex.h>
14 #include <linux/phy.h>
15 #include <linux/platform_device.h>
16 #include <linux/rtnetlink.h>
17 #include <linux/slab.h>
18 #include <linux/workqueue.h>
31 SFP_F_PRESENT = BIT(GPIO_MODDEF0),
32 SFP_F_LOS = BIT(GPIO_LOS),
33 SFP_F_TX_FAULT = BIT(GPIO_TX_FAULT),
34 SFP_F_TX_DISABLE = BIT(GPIO_TX_DISABLE),
35 SFP_F_RATE_SELECT = BIT(GPIO_RATE_SELECT),
74 static const char * const mod_state_strings[] = {
75 [SFP_MOD_EMPTY] = "empty",
76 [SFP_MOD_ERROR] = "error",
77 [SFP_MOD_PROBE] = "probe",
78 [SFP_MOD_WAITDEV] = "waitdev",
79 [SFP_MOD_HPOWER] = "hpower",
80 [SFP_MOD_WAITPWR] = "waitpwr",
81 [SFP_MOD_PRESENT] = "present",
84 static const char *mod_state_to_str(unsigned short mod_state)
86 if (mod_state >= ARRAY_SIZE(mod_state_strings))
87 return "Unknown module state";
88 return mod_state_strings[mod_state];
91 static const char * const dev_state_strings[] = {
92 [SFP_DEV_DETACHED] = "detached",
93 [SFP_DEV_DOWN] = "down",
97 static const char *dev_state_to_str(unsigned short dev_state)
99 if (dev_state >= ARRAY_SIZE(dev_state_strings))
100 return "Unknown device state";
101 return dev_state_strings[dev_state];
104 static const char * const event_strings[] = {
105 [SFP_E_INSERT] = "insert",
106 [SFP_E_REMOVE] = "remove",
107 [SFP_E_DEV_ATTACH] = "dev_attach",
108 [SFP_E_DEV_DETACH] = "dev_detach",
109 [SFP_E_DEV_DOWN] = "dev_down",
110 [SFP_E_DEV_UP] = "dev_up",
111 [SFP_E_TX_FAULT] = "tx_fault",
112 [SFP_E_TX_CLEAR] = "tx_clear",
113 [SFP_E_LOS_HIGH] = "los_high",
114 [SFP_E_LOS_LOW] = "los_low",
115 [SFP_E_TIMEOUT] = "timeout",
118 static const char *event_to_str(unsigned short event)
120 if (event >= ARRAY_SIZE(event_strings))
121 return "Unknown event";
122 return event_strings[event];
125 static const char * const sm_state_strings[] = {
126 [SFP_S_DOWN] = "down",
127 [SFP_S_FAIL] = "fail",
128 [SFP_S_WAIT] = "wait",
129 [SFP_S_INIT] = "init",
130 [SFP_S_INIT_PHY] = "init_phy",
131 [SFP_S_INIT_TX_FAULT] = "init_tx_fault",
132 [SFP_S_WAIT_LOS] = "wait_los",
133 [SFP_S_LINK_UP] = "link_up",
134 [SFP_S_TX_FAULT] = "tx_fault",
135 [SFP_S_REINIT] = "reinit",
136 [SFP_S_TX_DISABLE] = "tx_disable",
139 static const char *sm_state_to_str(unsigned short sm_state)
141 if (sm_state >= ARRAY_SIZE(sm_state_strings))
142 return "Unknown state";
143 return sm_state_strings[sm_state];
146 static const char *gpio_of_names[] = {
154 static const enum gpiod_flags gpio_flags[] = {
162 /* t_start_up (SFF-8431) or t_init (SFF-8472) is the time required for a
163 * non-cooled module to initialise its laser safety circuitry. We wait
164 * an initial T_WAIT period before we check the tx fault to give any PHY
165 * on board (for a copper SFP) time to initialise.
167 #define T_WAIT msecs_to_jiffies(50)
168 #define T_START_UP msecs_to_jiffies(300)
169 #define T_START_UP_BAD_GPON msecs_to_jiffies(60000)
171 /* t_reset is the time required to assert the TX_DISABLE signal to reset
172 * an indicated TX_FAULT.
174 #define T_RESET_US 10
175 #define T_FAULT_RECOVER msecs_to_jiffies(1000)
177 /* N_FAULT_INIT is the number of recovery attempts at module initialisation
178 * time. If the TX_FAULT signal is not deasserted after this number of
179 * attempts at clearing it, we decide that the module is faulty.
180 * N_FAULT is the same but after the module has initialised.
182 #define N_FAULT_INIT 5
185 /* T_PHY_RETRY is the time interval between attempts to probe the PHY.
186 * R_PHY_RETRY is the number of attempts.
188 #define T_PHY_RETRY msecs_to_jiffies(50)
189 #define R_PHY_RETRY 12
191 /* SFP module presence detection is poor: the three MOD DEF signals are
192 * the same length on the PCB, which means it's possible for MOD DEF 0 to
193 * connect before the I2C bus on MOD DEF 1/2.
195 * The SFF-8472 specifies t_serial ("Time from power on until module is
196 * ready for data transmission over the two wire serial bus.") as 300ms.
198 #define T_SERIAL msecs_to_jiffies(300)
199 #define T_HPOWER_LEVEL msecs_to_jiffies(300)
200 #define T_PROBE_RETRY_INIT msecs_to_jiffies(100)
201 #define R_PROBE_RETRY_INIT 10
202 #define T_PROBE_RETRY_SLOW msecs_to_jiffies(5000)
203 #define R_PROBE_RETRY_SLOW 12
205 /* SFP modules appear to always have their PHY configured for bus address
206 * 0x56 (which with mdio-i2c, translates to a PHY address of 22).
208 #define SFP_PHY_ADDR 22
212 bool (*module_supported)(const struct sfp_eeprom_id *id);
217 struct i2c_adapter *i2c;
218 struct mii_bus *i2c_mii;
219 struct sfp_bus *sfp_bus;
220 struct phy_device *mod_phy;
221 const struct sff_data *type;
222 size_t i2c_block_size;
225 unsigned int (*get_state)(struct sfp *);
226 void (*set_state)(struct sfp *, unsigned int);
227 int (*read)(struct sfp *, bool, u8, void *, size_t);
228 int (*write)(struct sfp *, bool, u8, void *, size_t);
230 struct gpio_desc *gpio[GPIO_MAX];
231 int gpio_irq[GPIO_MAX];
235 struct mutex st_mutex; /* Protects state */
236 unsigned int state_soft_mask;
238 struct delayed_work poll;
239 struct delayed_work timeout;
240 struct mutex sm_mutex; /* Protects state machine */
241 unsigned char sm_mod_state;
242 unsigned char sm_mod_tries_init;
243 unsigned char sm_mod_tries;
244 unsigned char sm_dev_state;
245 unsigned short sm_state;
246 unsigned char sm_fault_retries;
247 unsigned char sm_phy_retries;
249 struct sfp_eeprom_id id;
250 unsigned int module_power_mW;
251 unsigned int module_t_start_up;
252 bool tx_fault_ignore;
254 #if IS_ENABLED(CONFIG_HWMON)
255 struct sfp_diag diag;
256 struct delayed_work hwmon_probe;
257 unsigned int hwmon_tries;
258 struct device *hwmon_dev;
264 static bool sff_module_supported(const struct sfp_eeprom_id *id)
266 return id->base.phys_id == SFF8024_ID_SFF_8472 &&
267 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP;
270 static const struct sff_data sff_data = {
271 .gpios = SFP_F_LOS | SFP_F_TX_FAULT | SFP_F_TX_DISABLE,
272 .module_supported = sff_module_supported,
275 static bool sfp_module_supported(const struct sfp_eeprom_id *id)
277 if (id->base.phys_id == SFF8024_ID_SFP &&
278 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP)
281 /* SFP GPON module Ubiquiti U-Fiber Instant has in its EEPROM stored
282 * phys id SFF instead of SFP. Therefore mark this module explicitly
283 * as supported based on vendor name and pn match.
285 if (id->base.phys_id == SFF8024_ID_SFF_8472 &&
286 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP &&
287 !memcmp(id->base.vendor_name, "UBNT ", 16) &&
288 !memcmp(id->base.vendor_pn, "UF-INSTANT ", 16))
294 static const struct sff_data sfp_data = {
295 .gpios = SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT |
296 SFP_F_TX_DISABLE | SFP_F_RATE_SELECT,
297 .module_supported = sfp_module_supported,
300 static const struct of_device_id sfp_of_match[] = {
301 { .compatible = "sff,sff", .data = &sff_data, },
302 { .compatible = "sff,sfp", .data = &sfp_data, },
305 MODULE_DEVICE_TABLE(of, sfp_of_match);
307 static unsigned long poll_jiffies;
309 static unsigned int sfp_gpio_get_state(struct sfp *sfp)
311 unsigned int i, state, v;
313 for (i = state = 0; i < GPIO_MAX; i++) {
314 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
317 v = gpiod_get_value_cansleep(sfp->gpio[i]);
325 static unsigned int sff_gpio_get_state(struct sfp *sfp)
327 return sfp_gpio_get_state(sfp) | SFP_F_PRESENT;
330 static void sfp_gpio_set_state(struct sfp *sfp, unsigned int state)
332 if (state & SFP_F_PRESENT) {
333 /* If the module is present, drive the signals */
334 if (sfp->gpio[GPIO_TX_DISABLE])
335 gpiod_direction_output(sfp->gpio[GPIO_TX_DISABLE],
336 state & SFP_F_TX_DISABLE);
337 if (state & SFP_F_RATE_SELECT)
338 gpiod_direction_output(sfp->gpio[GPIO_RATE_SELECT],
339 state & SFP_F_RATE_SELECT);
341 /* Otherwise, let them float to the pull-ups */
342 if (sfp->gpio[GPIO_TX_DISABLE])
343 gpiod_direction_input(sfp->gpio[GPIO_TX_DISABLE]);
344 if (state & SFP_F_RATE_SELECT)
345 gpiod_direction_input(sfp->gpio[GPIO_RATE_SELECT]);
349 static int sfp_i2c_read(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
352 struct i2c_msg msgs[2];
353 u8 bus_addr = a2 ? 0x51 : 0x50;
354 size_t block_size = sfp->i2c_block_size;
358 msgs[0].addr = bus_addr;
361 msgs[0].buf = &dev_addr;
362 msgs[1].addr = bus_addr;
363 msgs[1].flags = I2C_M_RD;
369 if (this_len > block_size)
370 this_len = block_size;
372 msgs[1].len = this_len;
374 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
378 if (ret != ARRAY_SIZE(msgs))
381 msgs[1].buf += this_len;
382 dev_addr += this_len;
386 return msgs[1].buf - (u8 *)buf;
389 static int sfp_i2c_write(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
392 struct i2c_msg msgs[1];
393 u8 bus_addr = a2 ? 0x51 : 0x50;
396 msgs[0].addr = bus_addr;
398 msgs[0].len = 1 + len;
399 msgs[0].buf = kmalloc(1 + len, GFP_KERNEL);
403 msgs[0].buf[0] = dev_addr;
404 memcpy(&msgs[0].buf[1], buf, len);
406 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
413 return ret == ARRAY_SIZE(msgs) ? len : 0;
416 static int sfp_i2c_configure(struct sfp *sfp, struct i2c_adapter *i2c)
418 struct mii_bus *i2c_mii;
421 if (!i2c_check_functionality(i2c, I2C_FUNC_I2C))
425 sfp->read = sfp_i2c_read;
426 sfp->write = sfp_i2c_write;
428 i2c_mii = mdio_i2c_alloc(sfp->dev, i2c);
430 return PTR_ERR(i2c_mii);
432 i2c_mii->name = "SFP I2C Bus";
433 i2c_mii->phy_mask = ~0;
435 ret = mdiobus_register(i2c_mii);
437 mdiobus_free(i2c_mii);
441 sfp->i2c_mii = i2c_mii;
447 static int sfp_read(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
449 return sfp->read(sfp, a2, addr, buf, len);
452 static int sfp_write(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
454 return sfp->write(sfp, a2, addr, buf, len);
457 static unsigned int sfp_soft_get_state(struct sfp *sfp)
459 unsigned int state = 0;
463 ret = sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status));
464 if (ret == sizeof(status)) {
465 if (status & SFP_STATUS_RX_LOS)
467 if (status & SFP_STATUS_TX_FAULT)
468 state |= SFP_F_TX_FAULT;
470 dev_err_ratelimited(sfp->dev,
471 "failed to read SFP soft status: %d\n",
473 /* Preserve the current state */
477 return state & sfp->state_soft_mask;
480 static void sfp_soft_set_state(struct sfp *sfp, unsigned int state)
484 if (sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status)) ==
486 if (state & SFP_F_TX_DISABLE)
487 status |= SFP_STATUS_TX_DISABLE_FORCE;
489 status &= ~SFP_STATUS_TX_DISABLE_FORCE;
491 sfp_write(sfp, true, SFP_STATUS, &status, sizeof(status));
495 static void sfp_soft_start_poll(struct sfp *sfp)
497 const struct sfp_eeprom_id *id = &sfp->id;
499 sfp->state_soft_mask = 0;
500 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_DISABLE &&
501 !sfp->gpio[GPIO_TX_DISABLE])
502 sfp->state_soft_mask |= SFP_F_TX_DISABLE;
503 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_FAULT &&
504 !sfp->gpio[GPIO_TX_FAULT])
505 sfp->state_soft_mask |= SFP_F_TX_FAULT;
506 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_RX_LOS &&
507 !sfp->gpio[GPIO_LOS])
508 sfp->state_soft_mask |= SFP_F_LOS;
510 if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) &&
512 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
515 static void sfp_soft_stop_poll(struct sfp *sfp)
517 sfp->state_soft_mask = 0;
520 static unsigned int sfp_get_state(struct sfp *sfp)
522 unsigned int state = sfp->get_state(sfp);
524 if (state & SFP_F_PRESENT &&
525 sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT))
526 state |= sfp_soft_get_state(sfp);
531 static void sfp_set_state(struct sfp *sfp, unsigned int state)
533 sfp->set_state(sfp, state);
535 if (state & SFP_F_PRESENT &&
536 sfp->state_soft_mask & SFP_F_TX_DISABLE)
537 sfp_soft_set_state(sfp, state);
540 static unsigned int sfp_check(void *buf, size_t len)
544 for (p = buf, check = 0; len; p++, len--)
551 #if IS_ENABLED(CONFIG_HWMON)
552 static umode_t sfp_hwmon_is_visible(const void *data,
553 enum hwmon_sensor_types type,
554 u32 attr, int channel)
556 const struct sfp *sfp = data;
561 case hwmon_temp_min_alarm:
562 case hwmon_temp_max_alarm:
563 case hwmon_temp_lcrit_alarm:
564 case hwmon_temp_crit_alarm:
567 case hwmon_temp_lcrit:
568 case hwmon_temp_crit:
569 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
572 case hwmon_temp_input:
573 case hwmon_temp_label:
580 case hwmon_in_min_alarm:
581 case hwmon_in_max_alarm:
582 case hwmon_in_lcrit_alarm:
583 case hwmon_in_crit_alarm:
588 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
599 case hwmon_curr_min_alarm:
600 case hwmon_curr_max_alarm:
601 case hwmon_curr_lcrit_alarm:
602 case hwmon_curr_crit_alarm:
605 case hwmon_curr_lcrit:
606 case hwmon_curr_crit:
607 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
610 case hwmon_curr_input:
611 case hwmon_curr_label:
617 /* External calibration of receive power requires
618 * floating point arithmetic. Doing that in the kernel
619 * is not easy, so just skip it. If the module does
620 * not require external calibration, we can however
621 * show receiver power, since FP is then not needed.
623 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL &&
627 case hwmon_power_min_alarm:
628 case hwmon_power_max_alarm:
629 case hwmon_power_lcrit_alarm:
630 case hwmon_power_crit_alarm:
631 case hwmon_power_min:
632 case hwmon_power_max:
633 case hwmon_power_lcrit:
634 case hwmon_power_crit:
635 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
638 case hwmon_power_input:
639 case hwmon_power_label:
649 static int sfp_hwmon_read_sensor(struct sfp *sfp, int reg, long *value)
654 err = sfp_read(sfp, true, reg, &val, sizeof(val));
658 *value = be16_to_cpu(val);
663 static void sfp_hwmon_to_rx_power(long *value)
665 *value = DIV_ROUND_CLOSEST(*value, 10);
668 static void sfp_hwmon_calibrate(struct sfp *sfp, unsigned int slope, int offset,
671 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL)
672 *value = DIV_ROUND_CLOSEST(*value * slope, 256) + offset;
675 static void sfp_hwmon_calibrate_temp(struct sfp *sfp, long *value)
677 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_t_slope),
678 be16_to_cpu(sfp->diag.cal_t_offset), value);
680 if (*value >= 0x8000)
683 *value = DIV_ROUND_CLOSEST(*value * 1000, 256);
686 static void sfp_hwmon_calibrate_vcc(struct sfp *sfp, long *value)
688 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_v_slope),
689 be16_to_cpu(sfp->diag.cal_v_offset), value);
691 *value = DIV_ROUND_CLOSEST(*value, 10);
694 static void sfp_hwmon_calibrate_bias(struct sfp *sfp, long *value)
696 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txi_slope),
697 be16_to_cpu(sfp->diag.cal_txi_offset), value);
699 *value = DIV_ROUND_CLOSEST(*value, 500);
702 static void sfp_hwmon_calibrate_tx_power(struct sfp *sfp, long *value)
704 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txpwr_slope),
705 be16_to_cpu(sfp->diag.cal_txpwr_offset), value);
707 *value = DIV_ROUND_CLOSEST(*value, 10);
710 static int sfp_hwmon_read_temp(struct sfp *sfp, int reg, long *value)
714 err = sfp_hwmon_read_sensor(sfp, reg, value);
718 sfp_hwmon_calibrate_temp(sfp, value);
723 static int sfp_hwmon_read_vcc(struct sfp *sfp, int reg, long *value)
727 err = sfp_hwmon_read_sensor(sfp, reg, value);
731 sfp_hwmon_calibrate_vcc(sfp, value);
736 static int sfp_hwmon_read_bias(struct sfp *sfp, int reg, long *value)
740 err = sfp_hwmon_read_sensor(sfp, reg, value);
744 sfp_hwmon_calibrate_bias(sfp, value);
749 static int sfp_hwmon_read_tx_power(struct sfp *sfp, int reg, long *value)
753 err = sfp_hwmon_read_sensor(sfp, reg, value);
757 sfp_hwmon_calibrate_tx_power(sfp, value);
762 static int sfp_hwmon_read_rx_power(struct sfp *sfp, int reg, long *value)
766 err = sfp_hwmon_read_sensor(sfp, reg, value);
770 sfp_hwmon_to_rx_power(value);
775 static int sfp_hwmon_temp(struct sfp *sfp, u32 attr, long *value)
781 case hwmon_temp_input:
782 return sfp_hwmon_read_temp(sfp, SFP_TEMP, value);
784 case hwmon_temp_lcrit:
785 *value = be16_to_cpu(sfp->diag.temp_low_alarm);
786 sfp_hwmon_calibrate_temp(sfp, value);
790 *value = be16_to_cpu(sfp->diag.temp_low_warn);
791 sfp_hwmon_calibrate_temp(sfp, value);
794 *value = be16_to_cpu(sfp->diag.temp_high_warn);
795 sfp_hwmon_calibrate_temp(sfp, value);
798 case hwmon_temp_crit:
799 *value = be16_to_cpu(sfp->diag.temp_high_alarm);
800 sfp_hwmon_calibrate_temp(sfp, value);
803 case hwmon_temp_lcrit_alarm:
804 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
808 *value = !!(status & SFP_ALARM0_TEMP_LOW);
811 case hwmon_temp_min_alarm:
812 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
816 *value = !!(status & SFP_WARN0_TEMP_LOW);
819 case hwmon_temp_max_alarm:
820 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
824 *value = !!(status & SFP_WARN0_TEMP_HIGH);
827 case hwmon_temp_crit_alarm:
828 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
832 *value = !!(status & SFP_ALARM0_TEMP_HIGH);
841 static int sfp_hwmon_vcc(struct sfp *sfp, u32 attr, long *value)
848 return sfp_hwmon_read_vcc(sfp, SFP_VCC, value);
851 *value = be16_to_cpu(sfp->diag.volt_low_alarm);
852 sfp_hwmon_calibrate_vcc(sfp, value);
856 *value = be16_to_cpu(sfp->diag.volt_low_warn);
857 sfp_hwmon_calibrate_vcc(sfp, value);
861 *value = be16_to_cpu(sfp->diag.volt_high_warn);
862 sfp_hwmon_calibrate_vcc(sfp, value);
866 *value = be16_to_cpu(sfp->diag.volt_high_alarm);
867 sfp_hwmon_calibrate_vcc(sfp, value);
870 case hwmon_in_lcrit_alarm:
871 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
875 *value = !!(status & SFP_ALARM0_VCC_LOW);
878 case hwmon_in_min_alarm:
879 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
883 *value = !!(status & SFP_WARN0_VCC_LOW);
886 case hwmon_in_max_alarm:
887 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
891 *value = !!(status & SFP_WARN0_VCC_HIGH);
894 case hwmon_in_crit_alarm:
895 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
899 *value = !!(status & SFP_ALARM0_VCC_HIGH);
908 static int sfp_hwmon_bias(struct sfp *sfp, u32 attr, long *value)
914 case hwmon_curr_input:
915 return sfp_hwmon_read_bias(sfp, SFP_TX_BIAS, value);
917 case hwmon_curr_lcrit:
918 *value = be16_to_cpu(sfp->diag.bias_low_alarm);
919 sfp_hwmon_calibrate_bias(sfp, value);
923 *value = be16_to_cpu(sfp->diag.bias_low_warn);
924 sfp_hwmon_calibrate_bias(sfp, value);
928 *value = be16_to_cpu(sfp->diag.bias_high_warn);
929 sfp_hwmon_calibrate_bias(sfp, value);
932 case hwmon_curr_crit:
933 *value = be16_to_cpu(sfp->diag.bias_high_alarm);
934 sfp_hwmon_calibrate_bias(sfp, value);
937 case hwmon_curr_lcrit_alarm:
938 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
942 *value = !!(status & SFP_ALARM0_TX_BIAS_LOW);
945 case hwmon_curr_min_alarm:
946 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
950 *value = !!(status & SFP_WARN0_TX_BIAS_LOW);
953 case hwmon_curr_max_alarm:
954 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
958 *value = !!(status & SFP_WARN0_TX_BIAS_HIGH);
961 case hwmon_curr_crit_alarm:
962 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
966 *value = !!(status & SFP_ALARM0_TX_BIAS_HIGH);
975 static int sfp_hwmon_tx_power(struct sfp *sfp, u32 attr, long *value)
981 case hwmon_power_input:
982 return sfp_hwmon_read_tx_power(sfp, SFP_TX_POWER, value);
984 case hwmon_power_lcrit:
985 *value = be16_to_cpu(sfp->diag.txpwr_low_alarm);
986 sfp_hwmon_calibrate_tx_power(sfp, value);
989 case hwmon_power_min:
990 *value = be16_to_cpu(sfp->diag.txpwr_low_warn);
991 sfp_hwmon_calibrate_tx_power(sfp, value);
994 case hwmon_power_max:
995 *value = be16_to_cpu(sfp->diag.txpwr_high_warn);
996 sfp_hwmon_calibrate_tx_power(sfp, value);
999 case hwmon_power_crit:
1000 *value = be16_to_cpu(sfp->diag.txpwr_high_alarm);
1001 sfp_hwmon_calibrate_tx_power(sfp, value);
1004 case hwmon_power_lcrit_alarm:
1005 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1009 *value = !!(status & SFP_ALARM0_TXPWR_LOW);
1012 case hwmon_power_min_alarm:
1013 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1017 *value = !!(status & SFP_WARN0_TXPWR_LOW);
1020 case hwmon_power_max_alarm:
1021 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1025 *value = !!(status & SFP_WARN0_TXPWR_HIGH);
1028 case hwmon_power_crit_alarm:
1029 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1033 *value = !!(status & SFP_ALARM0_TXPWR_HIGH);
1042 static int sfp_hwmon_rx_power(struct sfp *sfp, u32 attr, long *value)
1048 case hwmon_power_input:
1049 return sfp_hwmon_read_rx_power(sfp, SFP_RX_POWER, value);
1051 case hwmon_power_lcrit:
1052 *value = be16_to_cpu(sfp->diag.rxpwr_low_alarm);
1053 sfp_hwmon_to_rx_power(value);
1056 case hwmon_power_min:
1057 *value = be16_to_cpu(sfp->diag.rxpwr_low_warn);
1058 sfp_hwmon_to_rx_power(value);
1061 case hwmon_power_max:
1062 *value = be16_to_cpu(sfp->diag.rxpwr_high_warn);
1063 sfp_hwmon_to_rx_power(value);
1066 case hwmon_power_crit:
1067 *value = be16_to_cpu(sfp->diag.rxpwr_high_alarm);
1068 sfp_hwmon_to_rx_power(value);
1071 case hwmon_power_lcrit_alarm:
1072 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1076 *value = !!(status & SFP_ALARM1_RXPWR_LOW);
1079 case hwmon_power_min_alarm:
1080 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1084 *value = !!(status & SFP_WARN1_RXPWR_LOW);
1087 case hwmon_power_max_alarm:
1088 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1092 *value = !!(status & SFP_WARN1_RXPWR_HIGH);
1095 case hwmon_power_crit_alarm:
1096 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1100 *value = !!(status & SFP_ALARM1_RXPWR_HIGH);
1109 static int sfp_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
1110 u32 attr, int channel, long *value)
1112 struct sfp *sfp = dev_get_drvdata(dev);
1116 return sfp_hwmon_temp(sfp, attr, value);
1118 return sfp_hwmon_vcc(sfp, attr, value);
1120 return sfp_hwmon_bias(sfp, attr, value);
1124 return sfp_hwmon_tx_power(sfp, attr, value);
1126 return sfp_hwmon_rx_power(sfp, attr, value);
1135 static const char *const sfp_hwmon_power_labels[] = {
1140 static int sfp_hwmon_read_string(struct device *dev,
1141 enum hwmon_sensor_types type,
1142 u32 attr, int channel, const char **str)
1147 case hwmon_curr_label:
1156 case hwmon_temp_label:
1157 *str = "temperature";
1165 case hwmon_in_label:
1174 case hwmon_power_label:
1175 *str = sfp_hwmon_power_labels[channel];
1188 static const struct hwmon_ops sfp_hwmon_ops = {
1189 .is_visible = sfp_hwmon_is_visible,
1190 .read = sfp_hwmon_read,
1191 .read_string = sfp_hwmon_read_string,
1194 static u32 sfp_hwmon_chip_config[] = {
1195 HWMON_C_REGISTER_TZ,
1199 static const struct hwmon_channel_info sfp_hwmon_chip = {
1201 .config = sfp_hwmon_chip_config,
1204 static u32 sfp_hwmon_temp_config[] = {
1206 HWMON_T_MAX | HWMON_T_MIN |
1207 HWMON_T_MAX_ALARM | HWMON_T_MIN_ALARM |
1208 HWMON_T_CRIT | HWMON_T_LCRIT |
1209 HWMON_T_CRIT_ALARM | HWMON_T_LCRIT_ALARM |
1214 static const struct hwmon_channel_info sfp_hwmon_temp_channel_info = {
1216 .config = sfp_hwmon_temp_config,
1219 static u32 sfp_hwmon_vcc_config[] = {
1221 HWMON_I_MAX | HWMON_I_MIN |
1222 HWMON_I_MAX_ALARM | HWMON_I_MIN_ALARM |
1223 HWMON_I_CRIT | HWMON_I_LCRIT |
1224 HWMON_I_CRIT_ALARM | HWMON_I_LCRIT_ALARM |
1229 static const struct hwmon_channel_info sfp_hwmon_vcc_channel_info = {
1231 .config = sfp_hwmon_vcc_config,
1234 static u32 sfp_hwmon_bias_config[] = {
1236 HWMON_C_MAX | HWMON_C_MIN |
1237 HWMON_C_MAX_ALARM | HWMON_C_MIN_ALARM |
1238 HWMON_C_CRIT | HWMON_C_LCRIT |
1239 HWMON_C_CRIT_ALARM | HWMON_C_LCRIT_ALARM |
1244 static const struct hwmon_channel_info sfp_hwmon_bias_channel_info = {
1246 .config = sfp_hwmon_bias_config,
1249 static u32 sfp_hwmon_power_config[] = {
1250 /* Transmit power */
1252 HWMON_P_MAX | HWMON_P_MIN |
1253 HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1254 HWMON_P_CRIT | HWMON_P_LCRIT |
1255 HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1259 HWMON_P_MAX | HWMON_P_MIN |
1260 HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1261 HWMON_P_CRIT | HWMON_P_LCRIT |
1262 HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1267 static const struct hwmon_channel_info sfp_hwmon_power_channel_info = {
1268 .type = hwmon_power,
1269 .config = sfp_hwmon_power_config,
1272 static const struct hwmon_channel_info *sfp_hwmon_info[] = {
1274 &sfp_hwmon_vcc_channel_info,
1275 &sfp_hwmon_temp_channel_info,
1276 &sfp_hwmon_bias_channel_info,
1277 &sfp_hwmon_power_channel_info,
1281 static const struct hwmon_chip_info sfp_hwmon_chip_info = {
1282 .ops = &sfp_hwmon_ops,
1283 .info = sfp_hwmon_info,
1286 static void sfp_hwmon_probe(struct work_struct *work)
1288 struct sfp *sfp = container_of(work, struct sfp, hwmon_probe.work);
1291 /* hwmon interface needs to access 16bit registers in atomic way to
1292 * guarantee coherency of the diagnostic monitoring data. If it is not
1293 * possible to guarantee coherency because EEPROM is broken in such way
1294 * that does not support atomic 16bit read operation then we have to
1295 * skip registration of hwmon device.
1297 if (sfp->i2c_block_size < 2) {
1299 "skipping hwmon device registration due to broken EEPROM\n");
1301 "diagnostic EEPROM area cannot be read atomically to guarantee data coherency\n");
1305 err = sfp_read(sfp, true, 0, &sfp->diag, sizeof(sfp->diag));
1307 if (sfp->hwmon_tries--) {
1308 mod_delayed_work(system_wq, &sfp->hwmon_probe,
1309 T_PROBE_RETRY_SLOW);
1311 dev_warn(sfp->dev, "hwmon probe failed: %d\n", err);
1316 sfp->hwmon_name = kstrdup(dev_name(sfp->dev), GFP_KERNEL);
1317 if (!sfp->hwmon_name) {
1318 dev_err(sfp->dev, "out of memory for hwmon name\n");
1322 for (i = 0; sfp->hwmon_name[i]; i++)
1323 if (hwmon_is_bad_char(sfp->hwmon_name[i]))
1324 sfp->hwmon_name[i] = '_';
1326 sfp->hwmon_dev = hwmon_device_register_with_info(sfp->dev,
1327 sfp->hwmon_name, sfp,
1328 &sfp_hwmon_chip_info,
1330 if (IS_ERR(sfp->hwmon_dev))
1331 dev_err(sfp->dev, "failed to register hwmon device: %ld\n",
1332 PTR_ERR(sfp->hwmon_dev));
1335 static int sfp_hwmon_insert(struct sfp *sfp)
1337 if (sfp->id.ext.sff8472_compliance == SFP_SFF8472_COMPLIANCE_NONE)
1340 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_DDM))
1343 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1344 /* This driver in general does not support address
1349 mod_delayed_work(system_wq, &sfp->hwmon_probe, 1);
1350 sfp->hwmon_tries = R_PROBE_RETRY_SLOW;
1355 static void sfp_hwmon_remove(struct sfp *sfp)
1357 cancel_delayed_work_sync(&sfp->hwmon_probe);
1358 if (!IS_ERR_OR_NULL(sfp->hwmon_dev)) {
1359 hwmon_device_unregister(sfp->hwmon_dev);
1360 sfp->hwmon_dev = NULL;
1361 kfree(sfp->hwmon_name);
1365 static int sfp_hwmon_init(struct sfp *sfp)
1367 INIT_DELAYED_WORK(&sfp->hwmon_probe, sfp_hwmon_probe);
1372 static void sfp_hwmon_exit(struct sfp *sfp)
1374 cancel_delayed_work_sync(&sfp->hwmon_probe);
1377 static int sfp_hwmon_insert(struct sfp *sfp)
1382 static void sfp_hwmon_remove(struct sfp *sfp)
1386 static int sfp_hwmon_init(struct sfp *sfp)
1391 static void sfp_hwmon_exit(struct sfp *sfp)
1397 static void sfp_module_tx_disable(struct sfp *sfp)
1399 dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1400 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 1);
1401 sfp->state |= SFP_F_TX_DISABLE;
1402 sfp_set_state(sfp, sfp->state);
1405 static void sfp_module_tx_enable(struct sfp *sfp)
1407 dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1408 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 0);
1409 sfp->state &= ~SFP_F_TX_DISABLE;
1410 sfp_set_state(sfp, sfp->state);
1413 static void sfp_module_tx_fault_reset(struct sfp *sfp)
1415 unsigned int state = sfp->state;
1417 if (state & SFP_F_TX_DISABLE)
1420 sfp_set_state(sfp, state | SFP_F_TX_DISABLE);
1424 sfp_set_state(sfp, state);
1427 /* SFP state machine */
1428 static void sfp_sm_set_timer(struct sfp *sfp, unsigned int timeout)
1431 mod_delayed_work(system_power_efficient_wq, &sfp->timeout,
1434 cancel_delayed_work(&sfp->timeout);
1437 static void sfp_sm_next(struct sfp *sfp, unsigned int state,
1438 unsigned int timeout)
1440 sfp->sm_state = state;
1441 sfp_sm_set_timer(sfp, timeout);
1444 static void sfp_sm_mod_next(struct sfp *sfp, unsigned int state,
1445 unsigned int timeout)
1447 sfp->sm_mod_state = state;
1448 sfp_sm_set_timer(sfp, timeout);
1451 static void sfp_sm_phy_detach(struct sfp *sfp)
1453 sfp_remove_phy(sfp->sfp_bus);
1454 phy_device_remove(sfp->mod_phy);
1455 phy_device_free(sfp->mod_phy);
1456 sfp->mod_phy = NULL;
1459 static int sfp_sm_probe_phy(struct sfp *sfp, bool is_c45)
1461 struct phy_device *phy;
1464 phy = get_phy_device(sfp->i2c_mii, SFP_PHY_ADDR, is_c45);
1465 if (phy == ERR_PTR(-ENODEV))
1466 return PTR_ERR(phy);
1468 dev_err(sfp->dev, "mdiobus scan returned %ld\n", PTR_ERR(phy));
1469 return PTR_ERR(phy);
1472 err = phy_device_register(phy);
1474 phy_device_free(phy);
1475 dev_err(sfp->dev, "phy_device_register failed: %d\n", err);
1479 err = sfp_add_phy(sfp->sfp_bus, phy);
1481 phy_device_remove(phy);
1482 phy_device_free(phy);
1483 dev_err(sfp->dev, "sfp_add_phy failed: %d\n", err);
1492 static void sfp_sm_link_up(struct sfp *sfp)
1494 sfp_link_up(sfp->sfp_bus);
1495 sfp_sm_next(sfp, SFP_S_LINK_UP, 0);
1498 static void sfp_sm_link_down(struct sfp *sfp)
1500 sfp_link_down(sfp->sfp_bus);
1503 static void sfp_sm_link_check_los(struct sfp *sfp)
1505 const __be16 los_inverted = cpu_to_be16(SFP_OPTIONS_LOS_INVERTED);
1506 const __be16 los_normal = cpu_to_be16(SFP_OPTIONS_LOS_NORMAL);
1507 __be16 los_options = sfp->id.ext.options & (los_inverted | los_normal);
1510 /* If neither SFP_OPTIONS_LOS_INVERTED nor SFP_OPTIONS_LOS_NORMAL
1511 * are set, we assume that no LOS signal is available. If both are
1512 * set, we assume LOS is not implemented (and is meaningless.)
1514 if (los_options == los_inverted)
1515 los = !(sfp->state & SFP_F_LOS);
1516 else if (los_options == los_normal)
1517 los = !!(sfp->state & SFP_F_LOS);
1520 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
1522 sfp_sm_link_up(sfp);
1525 static bool sfp_los_event_active(struct sfp *sfp, unsigned int event)
1527 const __be16 los_inverted = cpu_to_be16(SFP_OPTIONS_LOS_INVERTED);
1528 const __be16 los_normal = cpu_to_be16(SFP_OPTIONS_LOS_NORMAL);
1529 __be16 los_options = sfp->id.ext.options & (los_inverted | los_normal);
1531 return (los_options == los_inverted && event == SFP_E_LOS_LOW) ||
1532 (los_options == los_normal && event == SFP_E_LOS_HIGH);
1535 static bool sfp_los_event_inactive(struct sfp *sfp, unsigned int event)
1537 const __be16 los_inverted = cpu_to_be16(SFP_OPTIONS_LOS_INVERTED);
1538 const __be16 los_normal = cpu_to_be16(SFP_OPTIONS_LOS_NORMAL);
1539 __be16 los_options = sfp->id.ext.options & (los_inverted | los_normal);
1541 return (los_options == los_inverted && event == SFP_E_LOS_HIGH) ||
1542 (los_options == los_normal && event == SFP_E_LOS_LOW);
1545 static void sfp_sm_fault(struct sfp *sfp, unsigned int next_state, bool warn)
1547 if (sfp->sm_fault_retries && !--sfp->sm_fault_retries) {
1549 "module persistently indicates fault, disabling\n");
1550 sfp_sm_next(sfp, SFP_S_TX_DISABLE, 0);
1553 dev_err(sfp->dev, "module transmit fault indicated\n");
1555 sfp_sm_next(sfp, next_state, T_FAULT_RECOVER);
1559 /* Probe a SFP for a PHY device if the module supports copper - the PHY
1560 * normally sits at I2C bus address 0x56, and may either be a clause 22
1563 * Clause 22 copper SFP modules normally operate in Cisco SGMII mode with
1564 * negotiation enabled, but some may be in 1000base-X - which is for the
1565 * PHY driver to determine.
1567 * Clause 45 copper SFP+ modules (10G) appear to switch their interface
1568 * mode according to the negotiated line speed.
1570 static int sfp_sm_probe_for_phy(struct sfp *sfp)
1574 switch (sfp->id.base.extended_cc) {
1575 case SFF8024_ECC_10GBASE_T_SFI:
1576 case SFF8024_ECC_10GBASE_T_SR:
1577 case SFF8024_ECC_5GBASE_T:
1578 case SFF8024_ECC_2_5GBASE_T:
1579 err = sfp_sm_probe_phy(sfp, true);
1583 if (sfp->id.base.e1000_base_t)
1584 err = sfp_sm_probe_phy(sfp, false);
1590 static int sfp_module_parse_power(struct sfp *sfp)
1592 u32 power_mW = 1000;
1595 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_POWER_DECL))
1597 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_HIGH_POWER_LEVEL))
1600 supports_a2 = sfp->id.ext.sff8472_compliance !=
1601 SFP_SFF8472_COMPLIANCE_NONE ||
1602 sfp->id.ext.diagmon & SFP_DIAGMON_DDM;
1604 if (power_mW > sfp->max_power_mW) {
1605 /* Module power specification exceeds the allowed maximum. */
1607 /* The module appears not to implement bus address
1608 * 0xa2, so assume that the module powers up in the
1612 "Host does not support %u.%uW modules\n",
1613 power_mW / 1000, (power_mW / 100) % 10);
1617 "Host does not support %u.%uW modules, module left in power mode 1\n",
1618 power_mW / 1000, (power_mW / 100) % 10);
1623 if (power_mW <= 1000) {
1624 /* Modules below 1W do not require a power change sequence */
1625 sfp->module_power_mW = power_mW;
1630 /* The module power level is below the host maximum and the
1631 * module appears not to implement bus address 0xa2, so assume
1632 * that the module powers up in the indicated mode.
1637 /* If the module requires a higher power mode, but also requires
1638 * an address change sequence, warn the user that the module may
1639 * not be functional.
1641 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE) {
1643 "Address Change Sequence not supported but module requires %u.%uW, module may not be functional\n",
1644 power_mW / 1000, (power_mW / 100) % 10);
1648 sfp->module_power_mW = power_mW;
1653 static int sfp_sm_mod_hpower(struct sfp *sfp, bool enable)
1658 err = sfp_read(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1659 if (err != sizeof(val)) {
1660 dev_err(sfp->dev, "Failed to read EEPROM: %d\n", err);
1664 /* DM7052 reports as a high power module, responds to reads (with
1665 * all bytes 0xff) at 0x51 but does not accept writes. In any case,
1666 * if the bit is already set, we're already in high power mode.
1668 if (!!(val & BIT(0)) == enable)
1676 err = sfp_write(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1677 if (err != sizeof(val)) {
1678 dev_err(sfp->dev, "Failed to write EEPROM: %d\n", err);
1683 dev_info(sfp->dev, "Module switched to %u.%uW power level\n",
1684 sfp->module_power_mW / 1000,
1685 (sfp->module_power_mW / 100) % 10);
1690 /* GPON modules based on Realtek RTL8672 and RTL9601C chips (e.g. V-SOL
1691 * V2801F, CarlitoxxPro CPGOS03-0490, Ubiquiti U-Fiber Instant, ...) do
1692 * not support multibyte reads from the EEPROM. Each multi-byte read
1693 * operation returns just one byte of EEPROM followed by zeros. There is
1694 * no way to identify which modules are using Realtek RTL8672 and RTL9601C
1695 * chips. Moreover every OEM of V-SOL V2801F module puts its own vendor
1696 * name and vendor id into EEPROM, so there is even no way to detect if
1697 * module is V-SOL V2801F. Therefore check for those zeros in the read
1698 * data and then based on check switch to reading EEPROM to one byte
1701 static bool sfp_id_needs_byte_io(struct sfp *sfp, void *buf, size_t len)
1703 size_t i, block_size = sfp->i2c_block_size;
1705 /* Already using byte IO */
1706 if (block_size == 1)
1709 for (i = 1; i < len; i += block_size) {
1710 if (memchr_inv(buf + i, '\0', min(block_size - 1, len - i)))
1716 static int sfp_cotsworks_fixup_check(struct sfp *sfp, struct sfp_eeprom_id *id)
1721 if (id->base.phys_id != SFF8024_ID_SFF_8472 ||
1722 id->base.phys_ext_id != SFP_PHYS_EXT_ID_SFP ||
1723 id->base.connector != SFF8024_CONNECTOR_LC) {
1724 dev_warn(sfp->dev, "Rewriting fiber module EEPROM with corrected values\n");
1725 id->base.phys_id = SFF8024_ID_SFF_8472;
1726 id->base.phys_ext_id = SFP_PHYS_EXT_ID_SFP;
1727 id->base.connector = SFF8024_CONNECTOR_LC;
1728 err = sfp_write(sfp, false, SFP_PHYS_ID, &id->base, 3);
1730 dev_err(sfp->dev, "Failed to rewrite module EEPROM: %d\n", err);
1734 /* Cotsworks modules have been found to require a delay between write operations. */
1737 /* Update base structure checksum */
1738 check = sfp_check(&id->base, sizeof(id->base) - 1);
1739 err = sfp_write(sfp, false, SFP_CC_BASE, &check, 1);
1741 dev_err(sfp->dev, "Failed to update base structure checksum in fiber module EEPROM: %d\n", err);
1748 static int sfp_sm_mod_probe(struct sfp *sfp, bool report)
1750 /* SFP module inserted - read I2C data */
1751 struct sfp_eeprom_id id;
1752 bool cotsworks_sfbg;
1757 /* Some SFP modules and also some Linux I2C drivers do not like reads
1758 * longer than 16 bytes, so read the EEPROM in chunks of 16 bytes at
1761 sfp->i2c_block_size = 16;
1763 ret = sfp_read(sfp, false, 0, &id.base, sizeof(id.base));
1766 dev_err(sfp->dev, "failed to read EEPROM: %d\n", ret);
1770 if (ret != sizeof(id.base)) {
1771 dev_err(sfp->dev, "EEPROM short read: %d\n", ret);
1775 /* Some SFP modules (e.g. Nokia 3FE46541AA) lock up if read from
1776 * address 0x51 is just one byte at a time. Also SFF-8472 requires
1777 * that EEPROM supports atomic 16bit read operation for diagnostic
1778 * fields, so do not switch to one byte reading at a time unless it
1779 * is really required and we have no other option.
1781 if (sfp_id_needs_byte_io(sfp, &id.base, sizeof(id.base))) {
1783 "Detected broken RTL8672/RTL9601C emulated EEPROM\n");
1785 "Switching to reading EEPROM to one byte at a time\n");
1786 sfp->i2c_block_size = 1;
1788 ret = sfp_read(sfp, false, 0, &id.base, sizeof(id.base));
1791 dev_err(sfp->dev, "failed to read EEPROM: %d\n",
1796 if (ret != sizeof(id.base)) {
1797 dev_err(sfp->dev, "EEPROM short read: %d\n", ret);
1802 /* Cotsworks do not seem to update the checksums when they
1803 * do the final programming with the final module part number,
1804 * serial number and date code.
1806 cotsworks = !memcmp(id.base.vendor_name, "COTSWORKS ", 16);
1807 cotsworks_sfbg = !memcmp(id.base.vendor_pn, "SFBG", 4);
1809 /* Cotsworks SFF module EEPROM do not always have valid phys_id,
1810 * phys_ext_id, and connector bytes. Rewrite SFF EEPROM bytes if
1811 * Cotsworks PN matches and bytes are not correct.
1813 if (cotsworks && cotsworks_sfbg) {
1814 ret = sfp_cotsworks_fixup_check(sfp, &id);
1819 /* Validate the checksum over the base structure */
1820 check = sfp_check(&id.base, sizeof(id.base) - 1);
1821 if (check != id.base.cc_base) {
1824 "EEPROM base structure checksum failure (0x%02x != 0x%02x)\n",
1825 check, id.base.cc_base);
1828 "EEPROM base structure checksum failure: 0x%02x != 0x%02x\n",
1829 check, id.base.cc_base);
1830 print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
1831 16, 1, &id, sizeof(id), true);
1836 ret = sfp_read(sfp, false, SFP_CC_BASE + 1, &id.ext, sizeof(id.ext));
1839 dev_err(sfp->dev, "failed to read EEPROM: %d\n", ret);
1843 if (ret != sizeof(id.ext)) {
1844 dev_err(sfp->dev, "EEPROM short read: %d\n", ret);
1848 check = sfp_check(&id.ext, sizeof(id.ext) - 1);
1849 if (check != id.ext.cc_ext) {
1852 "EEPROM extended structure checksum failure (0x%02x != 0x%02x)\n",
1853 check, id.ext.cc_ext);
1856 "EEPROM extended structure checksum failure: 0x%02x != 0x%02x\n",
1857 check, id.ext.cc_ext);
1858 print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
1859 16, 1, &id, sizeof(id), true);
1860 memset(&id.ext, 0, sizeof(id.ext));
1866 dev_info(sfp->dev, "module %.*s %.*s rev %.*s sn %.*s dc %.*s\n",
1867 (int)sizeof(id.base.vendor_name), id.base.vendor_name,
1868 (int)sizeof(id.base.vendor_pn), id.base.vendor_pn,
1869 (int)sizeof(id.base.vendor_rev), id.base.vendor_rev,
1870 (int)sizeof(id.ext.vendor_sn), id.ext.vendor_sn,
1871 (int)sizeof(id.ext.datecode), id.ext.datecode);
1873 /* Check whether we support this module */
1874 if (!sfp->type->module_supported(&id)) {
1876 "module is not supported - phys id 0x%02x 0x%02x\n",
1877 sfp->id.base.phys_id, sfp->id.base.phys_ext_id);
1881 /* If the module requires address swap mode, warn about it */
1882 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1884 "module address swap to access page 0xA2 is not supported.\n");
1886 /* Parse the module power requirement */
1887 ret = sfp_module_parse_power(sfp);
1891 if (!memcmp(id.base.vendor_name, "ALCATELLUCENT ", 16) &&
1892 !memcmp(id.base.vendor_pn, "3FE46541AA ", 16))
1893 sfp->module_t_start_up = T_START_UP_BAD_GPON;
1895 sfp->module_t_start_up = T_START_UP;
1897 if (!memcmp(id.base.vendor_name, "HUAWEI ", 16) &&
1898 !memcmp(id.base.vendor_pn, "MA5671A ", 16))
1899 sfp->tx_fault_ignore = true;
1901 sfp->tx_fault_ignore = false;
1906 static void sfp_sm_mod_remove(struct sfp *sfp)
1908 if (sfp->sm_mod_state > SFP_MOD_WAITDEV)
1909 sfp_module_remove(sfp->sfp_bus);
1911 sfp_hwmon_remove(sfp);
1913 memset(&sfp->id, 0, sizeof(sfp->id));
1914 sfp->module_power_mW = 0;
1916 dev_info(sfp->dev, "module removed\n");
1919 /* This state machine tracks the upstream's state */
1920 static void sfp_sm_device(struct sfp *sfp, unsigned int event)
1922 switch (sfp->sm_dev_state) {
1924 if (event == SFP_E_DEV_ATTACH)
1925 sfp->sm_dev_state = SFP_DEV_DOWN;
1929 if (event == SFP_E_DEV_DETACH)
1930 sfp->sm_dev_state = SFP_DEV_DETACHED;
1931 else if (event == SFP_E_DEV_UP)
1932 sfp->sm_dev_state = SFP_DEV_UP;
1936 if (event == SFP_E_DEV_DETACH)
1937 sfp->sm_dev_state = SFP_DEV_DETACHED;
1938 else if (event == SFP_E_DEV_DOWN)
1939 sfp->sm_dev_state = SFP_DEV_DOWN;
1944 /* This state machine tracks the insert/remove state of the module, probes
1945 * the on-board EEPROM, and sets up the power level.
1947 static void sfp_sm_module(struct sfp *sfp, unsigned int event)
1951 /* Handle remove event globally, it resets this state machine */
1952 if (event == SFP_E_REMOVE) {
1953 if (sfp->sm_mod_state > SFP_MOD_PROBE)
1954 sfp_sm_mod_remove(sfp);
1955 sfp_sm_mod_next(sfp, SFP_MOD_EMPTY, 0);
1959 /* Handle device detach globally */
1960 if (sfp->sm_dev_state < SFP_DEV_DOWN &&
1961 sfp->sm_mod_state > SFP_MOD_WAITDEV) {
1962 if (sfp->module_power_mW > 1000 &&
1963 sfp->sm_mod_state > SFP_MOD_HPOWER)
1964 sfp_sm_mod_hpower(sfp, false);
1965 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
1969 switch (sfp->sm_mod_state) {
1971 if (event == SFP_E_INSERT) {
1972 sfp_sm_mod_next(sfp, SFP_MOD_PROBE, T_SERIAL);
1973 sfp->sm_mod_tries_init = R_PROBE_RETRY_INIT;
1974 sfp->sm_mod_tries = R_PROBE_RETRY_SLOW;
1979 /* Wait for T_PROBE_INIT to time out */
1980 if (event != SFP_E_TIMEOUT)
1983 err = sfp_sm_mod_probe(sfp, sfp->sm_mod_tries == 1);
1984 if (err == -EAGAIN) {
1985 if (sfp->sm_mod_tries_init &&
1986 --sfp->sm_mod_tries_init) {
1987 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
1989 } else if (sfp->sm_mod_tries && --sfp->sm_mod_tries) {
1990 if (sfp->sm_mod_tries == R_PROBE_RETRY_SLOW - 1)
1992 "please wait, module slow to respond\n");
1993 sfp_sm_set_timer(sfp, T_PROBE_RETRY_SLOW);
1998 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
2002 err = sfp_hwmon_insert(sfp);
2004 dev_warn(sfp->dev, "hwmon probe failed: %d\n", err);
2006 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
2008 case SFP_MOD_WAITDEV:
2009 /* Ensure that the device is attached before proceeding */
2010 if (sfp->sm_dev_state < SFP_DEV_DOWN)
2013 /* Report the module insertion to the upstream device */
2014 err = sfp_module_insert(sfp->sfp_bus, &sfp->id);
2016 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
2020 /* If this is a power level 1 module, we are done */
2021 if (sfp->module_power_mW <= 1000)
2024 sfp_sm_mod_next(sfp, SFP_MOD_HPOWER, 0);
2026 case SFP_MOD_HPOWER:
2027 /* Enable high power mode */
2028 err = sfp_sm_mod_hpower(sfp, true);
2030 if (err != -EAGAIN) {
2031 sfp_module_remove(sfp->sfp_bus);
2032 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
2034 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
2039 sfp_sm_mod_next(sfp, SFP_MOD_WAITPWR, T_HPOWER_LEVEL);
2042 case SFP_MOD_WAITPWR:
2043 /* Wait for T_HPOWER_LEVEL to time out */
2044 if (event != SFP_E_TIMEOUT)
2048 sfp_sm_mod_next(sfp, SFP_MOD_PRESENT, 0);
2051 case SFP_MOD_PRESENT:
2057 static void sfp_sm_main(struct sfp *sfp, unsigned int event)
2059 unsigned long timeout;
2062 /* Some events are global */
2063 if (sfp->sm_state != SFP_S_DOWN &&
2064 (sfp->sm_mod_state != SFP_MOD_PRESENT ||
2065 sfp->sm_dev_state != SFP_DEV_UP)) {
2066 if (sfp->sm_state == SFP_S_LINK_UP &&
2067 sfp->sm_dev_state == SFP_DEV_UP)
2068 sfp_sm_link_down(sfp);
2069 if (sfp->sm_state > SFP_S_INIT)
2070 sfp_module_stop(sfp->sfp_bus);
2072 sfp_sm_phy_detach(sfp);
2073 sfp_module_tx_disable(sfp);
2074 sfp_soft_stop_poll(sfp);
2075 sfp_sm_next(sfp, SFP_S_DOWN, 0);
2079 /* The main state machine */
2080 switch (sfp->sm_state) {
2082 if (sfp->sm_mod_state != SFP_MOD_PRESENT ||
2083 sfp->sm_dev_state != SFP_DEV_UP)
2086 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE))
2087 sfp_soft_start_poll(sfp);
2089 sfp_module_tx_enable(sfp);
2091 /* Initialise the fault clearance retries */
2092 sfp->sm_fault_retries = N_FAULT_INIT;
2094 /* We need to check the TX_FAULT state, which is not defined
2095 * while TX_DISABLE is asserted. The earliest we want to do
2096 * anything (such as probe for a PHY) is 50ms.
2098 sfp_sm_next(sfp, SFP_S_WAIT, T_WAIT);
2102 if (event != SFP_E_TIMEOUT)
2105 if (sfp->state & SFP_F_TX_FAULT) {
2106 /* Wait up to t_init (SFF-8472) or t_start_up (SFF-8431)
2107 * from the TX_DISABLE deassertion for the module to
2108 * initialise, which is indicated by TX_FAULT
2111 timeout = sfp->module_t_start_up;
2112 if (timeout > T_WAIT)
2117 sfp_sm_next(sfp, SFP_S_INIT, timeout);
2119 /* TX_FAULT is not asserted, assume the module has
2120 * finished initialising.
2127 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
2128 /* TX_FAULT is still asserted after t_init or
2129 * or t_start_up, so assume there is a fault.
2131 sfp_sm_fault(sfp, SFP_S_INIT_TX_FAULT,
2132 sfp->sm_fault_retries == N_FAULT_INIT);
2133 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
2135 sfp->sm_phy_retries = R_PHY_RETRY;
2140 case SFP_S_INIT_PHY:
2141 if (event != SFP_E_TIMEOUT)
2144 /* TX_FAULT deasserted or we timed out with TX_FAULT
2145 * clear. Probe for the PHY and check the LOS state.
2147 ret = sfp_sm_probe_for_phy(sfp);
2148 if (ret == -ENODEV) {
2149 if (--sfp->sm_phy_retries) {
2150 sfp_sm_next(sfp, SFP_S_INIT_PHY, T_PHY_RETRY);
2153 dev_info(sfp->dev, "no PHY detected\n");
2156 sfp_sm_next(sfp, SFP_S_FAIL, 0);
2159 if (sfp_module_start(sfp->sfp_bus)) {
2160 sfp_sm_next(sfp, SFP_S_FAIL, 0);
2163 sfp_sm_link_check_los(sfp);
2165 /* Reset the fault retry count */
2166 sfp->sm_fault_retries = N_FAULT;
2169 case SFP_S_INIT_TX_FAULT:
2170 if (event == SFP_E_TIMEOUT) {
2171 sfp_module_tx_fault_reset(sfp);
2172 sfp_sm_next(sfp, SFP_S_INIT, sfp->module_t_start_up);
2176 case SFP_S_WAIT_LOS:
2177 if (event == SFP_E_TX_FAULT)
2178 sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
2179 else if (sfp_los_event_inactive(sfp, event))
2180 sfp_sm_link_up(sfp);
2184 if (event == SFP_E_TX_FAULT) {
2185 sfp_sm_link_down(sfp);
2186 sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
2187 } else if (sfp_los_event_active(sfp, event)) {
2188 sfp_sm_link_down(sfp);
2189 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
2193 case SFP_S_TX_FAULT:
2194 if (event == SFP_E_TIMEOUT) {
2195 sfp_module_tx_fault_reset(sfp);
2196 sfp_sm_next(sfp, SFP_S_REINIT, sfp->module_t_start_up);
2201 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
2202 sfp_sm_fault(sfp, SFP_S_TX_FAULT, false);
2203 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
2204 dev_info(sfp->dev, "module transmit fault recovered\n");
2205 sfp_sm_link_check_los(sfp);
2209 case SFP_S_TX_DISABLE:
2214 static void sfp_sm_event(struct sfp *sfp, unsigned int event)
2216 mutex_lock(&sfp->sm_mutex);
2218 dev_dbg(sfp->dev, "SM: enter %s:%s:%s event %s\n",
2219 mod_state_to_str(sfp->sm_mod_state),
2220 dev_state_to_str(sfp->sm_dev_state),
2221 sm_state_to_str(sfp->sm_state),
2222 event_to_str(event));
2224 sfp_sm_device(sfp, event);
2225 sfp_sm_module(sfp, event);
2226 sfp_sm_main(sfp, event);
2228 dev_dbg(sfp->dev, "SM: exit %s:%s:%s\n",
2229 mod_state_to_str(sfp->sm_mod_state),
2230 dev_state_to_str(sfp->sm_dev_state),
2231 sm_state_to_str(sfp->sm_state));
2233 mutex_unlock(&sfp->sm_mutex);
2236 static void sfp_attach(struct sfp *sfp)
2238 sfp_sm_event(sfp, SFP_E_DEV_ATTACH);
2241 static void sfp_detach(struct sfp *sfp)
2243 sfp_sm_event(sfp, SFP_E_DEV_DETACH);
2246 static void sfp_start(struct sfp *sfp)
2248 sfp_sm_event(sfp, SFP_E_DEV_UP);
2251 static void sfp_stop(struct sfp *sfp)
2253 sfp_sm_event(sfp, SFP_E_DEV_DOWN);
2256 static int sfp_module_info(struct sfp *sfp, struct ethtool_modinfo *modinfo)
2258 /* locking... and check module is present */
2260 if (sfp->id.ext.sff8472_compliance &&
2261 !(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)) {
2262 modinfo->type = ETH_MODULE_SFF_8472;
2263 modinfo->eeprom_len = ETH_MODULE_SFF_8472_LEN;
2265 modinfo->type = ETH_MODULE_SFF_8079;
2266 modinfo->eeprom_len = ETH_MODULE_SFF_8079_LEN;
2271 static int sfp_module_eeprom(struct sfp *sfp, struct ethtool_eeprom *ee,
2274 unsigned int first, last, len;
2281 last = ee->offset + ee->len;
2282 if (first < ETH_MODULE_SFF_8079_LEN) {
2283 len = min_t(unsigned int, last, ETH_MODULE_SFF_8079_LEN);
2286 ret = sfp_read(sfp, false, first, data, len);
2293 if (first < ETH_MODULE_SFF_8472_LEN && last > ETH_MODULE_SFF_8079_LEN) {
2294 len = min_t(unsigned int, last, ETH_MODULE_SFF_8472_LEN);
2296 first -= ETH_MODULE_SFF_8079_LEN;
2298 ret = sfp_read(sfp, true, first, data, len);
2305 static const struct sfp_socket_ops sfp_module_ops = {
2306 .attach = sfp_attach,
2307 .detach = sfp_detach,
2310 .module_info = sfp_module_info,
2311 .module_eeprom = sfp_module_eeprom,
2314 static void sfp_timeout(struct work_struct *work)
2316 struct sfp *sfp = container_of(work, struct sfp, timeout.work);
2319 sfp_sm_event(sfp, SFP_E_TIMEOUT);
2323 static void sfp_check_state(struct sfp *sfp)
2325 unsigned int state, i, changed;
2327 mutex_lock(&sfp->st_mutex);
2328 state = sfp_get_state(sfp);
2329 changed = state ^ sfp->state;
2330 if (sfp->tx_fault_ignore)
2331 changed &= SFP_F_PRESENT | SFP_F_LOS;
2333 changed &= SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT;
2335 for (i = 0; i < GPIO_MAX; i++)
2336 if (changed & BIT(i))
2337 dev_dbg(sfp->dev, "%s %u -> %u\n", gpio_of_names[i],
2338 !!(sfp->state & BIT(i)), !!(state & BIT(i)));
2340 state |= sfp->state & (SFP_F_TX_DISABLE | SFP_F_RATE_SELECT);
2344 if (changed & SFP_F_PRESENT)
2345 sfp_sm_event(sfp, state & SFP_F_PRESENT ?
2346 SFP_E_INSERT : SFP_E_REMOVE);
2348 if (changed & SFP_F_TX_FAULT)
2349 sfp_sm_event(sfp, state & SFP_F_TX_FAULT ?
2350 SFP_E_TX_FAULT : SFP_E_TX_CLEAR);
2352 if (changed & SFP_F_LOS)
2353 sfp_sm_event(sfp, state & SFP_F_LOS ?
2354 SFP_E_LOS_HIGH : SFP_E_LOS_LOW);
2356 mutex_unlock(&sfp->st_mutex);
2359 static irqreturn_t sfp_irq(int irq, void *data)
2361 struct sfp *sfp = data;
2363 sfp_check_state(sfp);
2368 static void sfp_poll(struct work_struct *work)
2370 struct sfp *sfp = container_of(work, struct sfp, poll.work);
2372 sfp_check_state(sfp);
2374 if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) ||
2376 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2379 static struct sfp *sfp_alloc(struct device *dev)
2383 sfp = kzalloc(sizeof(*sfp), GFP_KERNEL);
2385 return ERR_PTR(-ENOMEM);
2389 mutex_init(&sfp->sm_mutex);
2390 mutex_init(&sfp->st_mutex);
2391 INIT_DELAYED_WORK(&sfp->poll, sfp_poll);
2392 INIT_DELAYED_WORK(&sfp->timeout, sfp_timeout);
2394 sfp_hwmon_init(sfp);
2399 static void sfp_cleanup(void *data)
2401 struct sfp *sfp = data;
2403 sfp_hwmon_exit(sfp);
2405 cancel_delayed_work_sync(&sfp->poll);
2406 cancel_delayed_work_sync(&sfp->timeout);
2408 mdiobus_unregister(sfp->i2c_mii);
2409 mdiobus_free(sfp->i2c_mii);
2412 i2c_put_adapter(sfp->i2c);
2416 static int sfp_probe(struct platform_device *pdev)
2418 const struct sff_data *sff;
2419 struct i2c_adapter *i2c;
2424 sfp = sfp_alloc(&pdev->dev);
2426 return PTR_ERR(sfp);
2428 platform_set_drvdata(pdev, sfp);
2430 err = devm_add_action_or_reset(sfp->dev, sfp_cleanup, sfp);
2434 sff = sfp->type = &sfp_data;
2436 if (pdev->dev.of_node) {
2437 struct device_node *node = pdev->dev.of_node;
2438 const struct of_device_id *id;
2439 struct device_node *np;
2441 id = of_match_node(sfp_of_match, node);
2445 sff = sfp->type = id->data;
2447 np = of_parse_phandle(node, "i2c-bus", 0);
2449 dev_err(sfp->dev, "missing 'i2c-bus' property\n");
2453 i2c = of_find_i2c_adapter_by_node(np);
2455 } else if (has_acpi_companion(&pdev->dev)) {
2456 struct acpi_device *adev = ACPI_COMPANION(&pdev->dev);
2457 struct fwnode_handle *fw = acpi_fwnode_handle(adev);
2458 struct fwnode_reference_args args;
2459 struct acpi_handle *acpi_handle;
2462 ret = acpi_node_get_property_reference(fw, "i2c-bus", 0, &args);
2463 if (ret || !is_acpi_device_node(args.fwnode)) {
2464 dev_err(&pdev->dev, "missing 'i2c-bus' property\n");
2468 acpi_handle = ACPI_HANDLE_FWNODE(args.fwnode);
2469 i2c = i2c_acpi_find_adapter_by_handle(acpi_handle);
2475 return -EPROBE_DEFER;
2477 err = sfp_i2c_configure(sfp, i2c);
2479 i2c_put_adapter(i2c);
2483 for (i = 0; i < GPIO_MAX; i++)
2484 if (sff->gpios & BIT(i)) {
2485 sfp->gpio[i] = devm_gpiod_get_optional(sfp->dev,
2486 gpio_of_names[i], gpio_flags[i]);
2487 if (IS_ERR(sfp->gpio[i]))
2488 return PTR_ERR(sfp->gpio[i]);
2491 sfp->get_state = sfp_gpio_get_state;
2492 sfp->set_state = sfp_gpio_set_state;
2494 /* Modules that have no detect signal are always present */
2495 if (!(sfp->gpio[GPIO_MODDEF0]))
2496 sfp->get_state = sff_gpio_get_state;
2498 device_property_read_u32(&pdev->dev, "maximum-power-milliwatt",
2499 &sfp->max_power_mW);
2500 if (!sfp->max_power_mW)
2501 sfp->max_power_mW = 1000;
2503 dev_info(sfp->dev, "Host maximum power %u.%uW\n",
2504 sfp->max_power_mW / 1000, (sfp->max_power_mW / 100) % 10);
2506 /* Get the initial state, and always signal TX disable,
2507 * since the network interface will not be up.
2509 sfp->state = sfp_get_state(sfp) | SFP_F_TX_DISABLE;
2511 if (sfp->gpio[GPIO_RATE_SELECT] &&
2512 gpiod_get_value_cansleep(sfp->gpio[GPIO_RATE_SELECT]))
2513 sfp->state |= SFP_F_RATE_SELECT;
2514 sfp_set_state(sfp, sfp->state);
2515 sfp_module_tx_disable(sfp);
2516 if (sfp->state & SFP_F_PRESENT) {
2518 sfp_sm_event(sfp, SFP_E_INSERT);
2522 for (i = 0; i < GPIO_MAX; i++) {
2523 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
2526 sfp->gpio_irq[i] = gpiod_to_irq(sfp->gpio[i]);
2527 if (sfp->gpio_irq[i] < 0) {
2528 sfp->gpio_irq[i] = 0;
2529 sfp->need_poll = true;
2533 sfp_irq_name = devm_kasprintf(sfp->dev, GFP_KERNEL,
2534 "%s-%s", dev_name(sfp->dev),
2540 err = devm_request_threaded_irq(sfp->dev, sfp->gpio_irq[i],
2543 IRQF_TRIGGER_RISING |
2544 IRQF_TRIGGER_FALLING,
2547 sfp->gpio_irq[i] = 0;
2548 sfp->need_poll = true;
2553 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2555 /* We could have an issue in cases no Tx disable pin is available or
2556 * wired as modules using a laser as their light source will continue to
2557 * be active when the fiber is removed. This could be a safety issue and
2558 * we should at least warn the user about that.
2560 if (!sfp->gpio[GPIO_TX_DISABLE])
2562 "No tx_disable pin: SFP modules will always be emitting.\n");
2564 sfp->sfp_bus = sfp_register_socket(sfp->dev, sfp, &sfp_module_ops);
2571 static int sfp_remove(struct platform_device *pdev)
2573 struct sfp *sfp = platform_get_drvdata(pdev);
2575 sfp_unregister_socket(sfp->sfp_bus);
2578 sfp_sm_event(sfp, SFP_E_REMOVE);
2584 static void sfp_shutdown(struct platform_device *pdev)
2586 struct sfp *sfp = platform_get_drvdata(pdev);
2589 for (i = 0; i < GPIO_MAX; i++) {
2590 if (!sfp->gpio_irq[i])
2593 devm_free_irq(sfp->dev, sfp->gpio_irq[i], sfp);
2596 cancel_delayed_work_sync(&sfp->poll);
2597 cancel_delayed_work_sync(&sfp->timeout);
2600 static struct platform_driver sfp_driver = {
2602 .remove = sfp_remove,
2603 .shutdown = sfp_shutdown,
2606 .of_match_table = sfp_of_match,
2610 static int sfp_init(void)
2612 poll_jiffies = msecs_to_jiffies(100);
2614 return platform_driver_register(&sfp_driver);
2616 module_init(sfp_init);
2618 static void sfp_exit(void)
2620 platform_driver_unregister(&sfp_driver);
2622 module_exit(sfp_exit);
2624 MODULE_ALIAS("platform:sfp");
2625 MODULE_AUTHOR("Russell King");
2626 MODULE_LICENSE("GPL v2");