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] = "rx_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;
253 #if IS_ENABLED(CONFIG_HWMON)
254 struct sfp_diag diag;
255 struct delayed_work hwmon_probe;
256 unsigned int hwmon_tries;
257 struct device *hwmon_dev;
263 static bool sff_module_supported(const struct sfp_eeprom_id *id)
265 return id->base.phys_id == SFF8024_ID_SFF_8472 &&
266 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP;
269 static const struct sff_data sff_data = {
270 .gpios = SFP_F_LOS | SFP_F_TX_FAULT | SFP_F_TX_DISABLE,
271 .module_supported = sff_module_supported,
274 static bool sfp_module_supported(const struct sfp_eeprom_id *id)
276 return id->base.phys_id == SFF8024_ID_SFP &&
277 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP;
280 static const struct sff_data sfp_data = {
281 .gpios = SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT |
282 SFP_F_TX_DISABLE | SFP_F_RATE_SELECT,
283 .module_supported = sfp_module_supported,
286 static const struct of_device_id sfp_of_match[] = {
287 { .compatible = "sff,sff", .data = &sff_data, },
288 { .compatible = "sff,sfp", .data = &sfp_data, },
291 MODULE_DEVICE_TABLE(of, sfp_of_match);
293 static unsigned long poll_jiffies;
295 static unsigned int sfp_gpio_get_state(struct sfp *sfp)
297 unsigned int i, state, v;
299 for (i = state = 0; i < GPIO_MAX; i++) {
300 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
303 v = gpiod_get_value_cansleep(sfp->gpio[i]);
311 static unsigned int sff_gpio_get_state(struct sfp *sfp)
313 return sfp_gpio_get_state(sfp) | SFP_F_PRESENT;
316 static void sfp_gpio_set_state(struct sfp *sfp, unsigned int state)
318 if (state & SFP_F_PRESENT) {
319 /* If the module is present, drive the signals */
320 if (sfp->gpio[GPIO_TX_DISABLE])
321 gpiod_direction_output(sfp->gpio[GPIO_TX_DISABLE],
322 state & SFP_F_TX_DISABLE);
323 if (state & SFP_F_RATE_SELECT)
324 gpiod_direction_output(sfp->gpio[GPIO_RATE_SELECT],
325 state & SFP_F_RATE_SELECT);
327 /* Otherwise, let them float to the pull-ups */
328 if (sfp->gpio[GPIO_TX_DISABLE])
329 gpiod_direction_input(sfp->gpio[GPIO_TX_DISABLE]);
330 if (state & SFP_F_RATE_SELECT)
331 gpiod_direction_input(sfp->gpio[GPIO_RATE_SELECT]);
335 static int sfp_i2c_read(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
338 struct i2c_msg msgs[2];
348 block_size = sfp->i2c_block_size;
352 msgs[0].addr = bus_addr;
355 msgs[0].buf = &dev_addr;
356 msgs[1].addr = bus_addr;
357 msgs[1].flags = I2C_M_RD;
363 if (this_len > block_size)
364 this_len = block_size;
366 msgs[1].len = this_len;
368 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
372 if (ret != ARRAY_SIZE(msgs))
375 msgs[1].buf += this_len;
376 dev_addr += this_len;
380 return msgs[1].buf - (u8 *)buf;
383 static int sfp_i2c_write(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
386 struct i2c_msg msgs[1];
387 u8 bus_addr = a2 ? 0x51 : 0x50;
390 msgs[0].addr = bus_addr;
392 msgs[0].len = 1 + len;
393 msgs[0].buf = kmalloc(1 + len, GFP_KERNEL);
397 msgs[0].buf[0] = dev_addr;
398 memcpy(&msgs[0].buf[1], buf, len);
400 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
407 return ret == ARRAY_SIZE(msgs) ? len : 0;
410 static int sfp_i2c_configure(struct sfp *sfp, struct i2c_adapter *i2c)
412 struct mii_bus *i2c_mii;
415 if (!i2c_check_functionality(i2c, I2C_FUNC_I2C))
419 sfp->read = sfp_i2c_read;
420 sfp->write = sfp_i2c_write;
422 i2c_mii = mdio_i2c_alloc(sfp->dev, i2c);
424 return PTR_ERR(i2c_mii);
426 i2c_mii->name = "SFP I2C Bus";
427 i2c_mii->phy_mask = ~0;
429 ret = mdiobus_register(i2c_mii);
431 mdiobus_free(i2c_mii);
435 sfp->i2c_mii = i2c_mii;
441 static int sfp_read(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
443 return sfp->read(sfp, a2, addr, buf, len);
446 static int sfp_write(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
448 return sfp->write(sfp, a2, addr, buf, len);
451 static unsigned int sfp_soft_get_state(struct sfp *sfp)
453 unsigned int state = 0;
457 ret = sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status));
458 if (ret == sizeof(status)) {
459 if (status & SFP_STATUS_RX_LOS)
461 if (status & SFP_STATUS_TX_FAULT)
462 state |= SFP_F_TX_FAULT;
464 dev_err_ratelimited(sfp->dev,
465 "failed to read SFP soft status: %d\n",
467 /* Preserve the current state */
471 return state & sfp->state_soft_mask;
474 static void sfp_soft_set_state(struct sfp *sfp, unsigned int state)
478 if (sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status)) ==
480 if (state & SFP_F_TX_DISABLE)
481 status |= SFP_STATUS_TX_DISABLE_FORCE;
483 status &= ~SFP_STATUS_TX_DISABLE_FORCE;
485 sfp_write(sfp, true, SFP_STATUS, &status, sizeof(status));
489 static void sfp_soft_start_poll(struct sfp *sfp)
491 const struct sfp_eeprom_id *id = &sfp->id;
493 sfp->state_soft_mask = 0;
494 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_DISABLE &&
495 !sfp->gpio[GPIO_TX_DISABLE])
496 sfp->state_soft_mask |= SFP_F_TX_DISABLE;
497 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_FAULT &&
498 !sfp->gpio[GPIO_TX_FAULT])
499 sfp->state_soft_mask |= SFP_F_TX_FAULT;
500 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_RX_LOS &&
501 !sfp->gpio[GPIO_LOS])
502 sfp->state_soft_mask |= SFP_F_LOS;
504 if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) &&
506 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
509 static void sfp_soft_stop_poll(struct sfp *sfp)
511 sfp->state_soft_mask = 0;
514 static unsigned int sfp_get_state(struct sfp *sfp)
516 unsigned int state = sfp->get_state(sfp);
518 if (state & SFP_F_PRESENT &&
519 sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT))
520 state |= sfp_soft_get_state(sfp);
525 static void sfp_set_state(struct sfp *sfp, unsigned int state)
527 sfp->set_state(sfp, state);
529 if (state & SFP_F_PRESENT &&
530 sfp->state_soft_mask & SFP_F_TX_DISABLE)
531 sfp_soft_set_state(sfp, state);
534 static unsigned int sfp_check(void *buf, size_t len)
538 for (p = buf, check = 0; len; p++, len--)
545 #if IS_ENABLED(CONFIG_HWMON)
546 static umode_t sfp_hwmon_is_visible(const void *data,
547 enum hwmon_sensor_types type,
548 u32 attr, int channel)
550 const struct sfp *sfp = data;
555 case hwmon_temp_min_alarm:
556 case hwmon_temp_max_alarm:
557 case hwmon_temp_lcrit_alarm:
558 case hwmon_temp_crit_alarm:
561 case hwmon_temp_lcrit:
562 case hwmon_temp_crit:
563 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
566 case hwmon_temp_input:
567 case hwmon_temp_label:
574 case hwmon_in_min_alarm:
575 case hwmon_in_max_alarm:
576 case hwmon_in_lcrit_alarm:
577 case hwmon_in_crit_alarm:
582 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
593 case hwmon_curr_min_alarm:
594 case hwmon_curr_max_alarm:
595 case hwmon_curr_lcrit_alarm:
596 case hwmon_curr_crit_alarm:
599 case hwmon_curr_lcrit:
600 case hwmon_curr_crit:
601 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
604 case hwmon_curr_input:
605 case hwmon_curr_label:
611 /* External calibration of receive power requires
612 * floating point arithmetic. Doing that in the kernel
613 * is not easy, so just skip it. If the module does
614 * not require external calibration, we can however
615 * show receiver power, since FP is then not needed.
617 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL &&
621 case hwmon_power_min_alarm:
622 case hwmon_power_max_alarm:
623 case hwmon_power_lcrit_alarm:
624 case hwmon_power_crit_alarm:
625 case hwmon_power_min:
626 case hwmon_power_max:
627 case hwmon_power_lcrit:
628 case hwmon_power_crit:
629 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
632 case hwmon_power_input:
633 case hwmon_power_label:
643 static int sfp_hwmon_read_sensor(struct sfp *sfp, int reg, long *value)
648 err = sfp_read(sfp, true, reg, &val, sizeof(val));
652 *value = be16_to_cpu(val);
657 static void sfp_hwmon_to_rx_power(long *value)
659 *value = DIV_ROUND_CLOSEST(*value, 10);
662 static void sfp_hwmon_calibrate(struct sfp *sfp, unsigned int slope, int offset,
665 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL)
666 *value = DIV_ROUND_CLOSEST(*value * slope, 256) + offset;
669 static void sfp_hwmon_calibrate_temp(struct sfp *sfp, long *value)
671 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_t_slope),
672 be16_to_cpu(sfp->diag.cal_t_offset), value);
674 if (*value >= 0x8000)
677 *value = DIV_ROUND_CLOSEST(*value * 1000, 256);
680 static void sfp_hwmon_calibrate_vcc(struct sfp *sfp, long *value)
682 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_v_slope),
683 be16_to_cpu(sfp->diag.cal_v_offset), value);
685 *value = DIV_ROUND_CLOSEST(*value, 10);
688 static void sfp_hwmon_calibrate_bias(struct sfp *sfp, long *value)
690 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txi_slope),
691 be16_to_cpu(sfp->diag.cal_txi_offset), value);
693 *value = DIV_ROUND_CLOSEST(*value, 500);
696 static void sfp_hwmon_calibrate_tx_power(struct sfp *sfp, long *value)
698 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txpwr_slope),
699 be16_to_cpu(sfp->diag.cal_txpwr_offset), value);
701 *value = DIV_ROUND_CLOSEST(*value, 10);
704 static int sfp_hwmon_read_temp(struct sfp *sfp, int reg, long *value)
708 err = sfp_hwmon_read_sensor(sfp, reg, value);
712 sfp_hwmon_calibrate_temp(sfp, value);
717 static int sfp_hwmon_read_vcc(struct sfp *sfp, int reg, long *value)
721 err = sfp_hwmon_read_sensor(sfp, reg, value);
725 sfp_hwmon_calibrate_vcc(sfp, value);
730 static int sfp_hwmon_read_bias(struct sfp *sfp, int reg, long *value)
734 err = sfp_hwmon_read_sensor(sfp, reg, value);
738 sfp_hwmon_calibrate_bias(sfp, value);
743 static int sfp_hwmon_read_tx_power(struct sfp *sfp, int reg, long *value)
747 err = sfp_hwmon_read_sensor(sfp, reg, value);
751 sfp_hwmon_calibrate_tx_power(sfp, value);
756 static int sfp_hwmon_read_rx_power(struct sfp *sfp, int reg, long *value)
760 err = sfp_hwmon_read_sensor(sfp, reg, value);
764 sfp_hwmon_to_rx_power(value);
769 static int sfp_hwmon_temp(struct sfp *sfp, u32 attr, long *value)
775 case hwmon_temp_input:
776 return sfp_hwmon_read_temp(sfp, SFP_TEMP, value);
778 case hwmon_temp_lcrit:
779 *value = be16_to_cpu(sfp->diag.temp_low_alarm);
780 sfp_hwmon_calibrate_temp(sfp, value);
784 *value = be16_to_cpu(sfp->diag.temp_low_warn);
785 sfp_hwmon_calibrate_temp(sfp, value);
788 *value = be16_to_cpu(sfp->diag.temp_high_warn);
789 sfp_hwmon_calibrate_temp(sfp, value);
792 case hwmon_temp_crit:
793 *value = be16_to_cpu(sfp->diag.temp_high_alarm);
794 sfp_hwmon_calibrate_temp(sfp, value);
797 case hwmon_temp_lcrit_alarm:
798 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
802 *value = !!(status & SFP_ALARM0_TEMP_LOW);
805 case hwmon_temp_min_alarm:
806 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
810 *value = !!(status & SFP_WARN0_TEMP_LOW);
813 case hwmon_temp_max_alarm:
814 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
818 *value = !!(status & SFP_WARN0_TEMP_HIGH);
821 case hwmon_temp_crit_alarm:
822 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
826 *value = !!(status & SFP_ALARM0_TEMP_HIGH);
835 static int sfp_hwmon_vcc(struct sfp *sfp, u32 attr, long *value)
842 return sfp_hwmon_read_vcc(sfp, SFP_VCC, value);
845 *value = be16_to_cpu(sfp->diag.volt_low_alarm);
846 sfp_hwmon_calibrate_vcc(sfp, value);
850 *value = be16_to_cpu(sfp->diag.volt_low_warn);
851 sfp_hwmon_calibrate_vcc(sfp, value);
855 *value = be16_to_cpu(sfp->diag.volt_high_warn);
856 sfp_hwmon_calibrate_vcc(sfp, value);
860 *value = be16_to_cpu(sfp->diag.volt_high_alarm);
861 sfp_hwmon_calibrate_vcc(sfp, value);
864 case hwmon_in_lcrit_alarm:
865 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
869 *value = !!(status & SFP_ALARM0_VCC_LOW);
872 case hwmon_in_min_alarm:
873 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
877 *value = !!(status & SFP_WARN0_VCC_LOW);
880 case hwmon_in_max_alarm:
881 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
885 *value = !!(status & SFP_WARN0_VCC_HIGH);
888 case hwmon_in_crit_alarm:
889 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
893 *value = !!(status & SFP_ALARM0_VCC_HIGH);
902 static int sfp_hwmon_bias(struct sfp *sfp, u32 attr, long *value)
908 case hwmon_curr_input:
909 return sfp_hwmon_read_bias(sfp, SFP_TX_BIAS, value);
911 case hwmon_curr_lcrit:
912 *value = be16_to_cpu(sfp->diag.bias_low_alarm);
913 sfp_hwmon_calibrate_bias(sfp, value);
917 *value = be16_to_cpu(sfp->diag.bias_low_warn);
918 sfp_hwmon_calibrate_bias(sfp, value);
922 *value = be16_to_cpu(sfp->diag.bias_high_warn);
923 sfp_hwmon_calibrate_bias(sfp, value);
926 case hwmon_curr_crit:
927 *value = be16_to_cpu(sfp->diag.bias_high_alarm);
928 sfp_hwmon_calibrate_bias(sfp, value);
931 case hwmon_curr_lcrit_alarm:
932 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
936 *value = !!(status & SFP_ALARM0_TX_BIAS_LOW);
939 case hwmon_curr_min_alarm:
940 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
944 *value = !!(status & SFP_WARN0_TX_BIAS_LOW);
947 case hwmon_curr_max_alarm:
948 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
952 *value = !!(status & SFP_WARN0_TX_BIAS_HIGH);
955 case hwmon_curr_crit_alarm:
956 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
960 *value = !!(status & SFP_ALARM0_TX_BIAS_HIGH);
969 static int sfp_hwmon_tx_power(struct sfp *sfp, u32 attr, long *value)
975 case hwmon_power_input:
976 return sfp_hwmon_read_tx_power(sfp, SFP_TX_POWER, value);
978 case hwmon_power_lcrit:
979 *value = be16_to_cpu(sfp->diag.txpwr_low_alarm);
980 sfp_hwmon_calibrate_tx_power(sfp, value);
983 case hwmon_power_min:
984 *value = be16_to_cpu(sfp->diag.txpwr_low_warn);
985 sfp_hwmon_calibrate_tx_power(sfp, value);
988 case hwmon_power_max:
989 *value = be16_to_cpu(sfp->diag.txpwr_high_warn);
990 sfp_hwmon_calibrate_tx_power(sfp, value);
993 case hwmon_power_crit:
994 *value = be16_to_cpu(sfp->diag.txpwr_high_alarm);
995 sfp_hwmon_calibrate_tx_power(sfp, value);
998 case hwmon_power_lcrit_alarm:
999 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1003 *value = !!(status & SFP_ALARM0_TXPWR_LOW);
1006 case hwmon_power_min_alarm:
1007 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1011 *value = !!(status & SFP_WARN0_TXPWR_LOW);
1014 case hwmon_power_max_alarm:
1015 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
1019 *value = !!(status & SFP_WARN0_TXPWR_HIGH);
1022 case hwmon_power_crit_alarm:
1023 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
1027 *value = !!(status & SFP_ALARM0_TXPWR_HIGH);
1036 static int sfp_hwmon_rx_power(struct sfp *sfp, u32 attr, long *value)
1042 case hwmon_power_input:
1043 return sfp_hwmon_read_rx_power(sfp, SFP_RX_POWER, value);
1045 case hwmon_power_lcrit:
1046 *value = be16_to_cpu(sfp->diag.rxpwr_low_alarm);
1047 sfp_hwmon_to_rx_power(value);
1050 case hwmon_power_min:
1051 *value = be16_to_cpu(sfp->diag.rxpwr_low_warn);
1052 sfp_hwmon_to_rx_power(value);
1055 case hwmon_power_max:
1056 *value = be16_to_cpu(sfp->diag.rxpwr_high_warn);
1057 sfp_hwmon_to_rx_power(value);
1060 case hwmon_power_crit:
1061 *value = be16_to_cpu(sfp->diag.rxpwr_high_alarm);
1062 sfp_hwmon_to_rx_power(value);
1065 case hwmon_power_lcrit_alarm:
1066 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1070 *value = !!(status & SFP_ALARM1_RXPWR_LOW);
1073 case hwmon_power_min_alarm:
1074 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1078 *value = !!(status & SFP_WARN1_RXPWR_LOW);
1081 case hwmon_power_max_alarm:
1082 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1086 *value = !!(status & SFP_WARN1_RXPWR_HIGH);
1089 case hwmon_power_crit_alarm:
1090 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1094 *value = !!(status & SFP_ALARM1_RXPWR_HIGH);
1103 static int sfp_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
1104 u32 attr, int channel, long *value)
1106 struct sfp *sfp = dev_get_drvdata(dev);
1110 return sfp_hwmon_temp(sfp, attr, value);
1112 return sfp_hwmon_vcc(sfp, attr, value);
1114 return sfp_hwmon_bias(sfp, attr, value);
1118 return sfp_hwmon_tx_power(sfp, attr, value);
1120 return sfp_hwmon_rx_power(sfp, attr, value);
1129 static const char *const sfp_hwmon_power_labels[] = {
1134 static int sfp_hwmon_read_string(struct device *dev,
1135 enum hwmon_sensor_types type,
1136 u32 attr, int channel, const char **str)
1141 case hwmon_curr_label:
1150 case hwmon_temp_label:
1151 *str = "temperature";
1159 case hwmon_in_label:
1168 case hwmon_power_label:
1169 *str = sfp_hwmon_power_labels[channel];
1182 static const struct hwmon_ops sfp_hwmon_ops = {
1183 .is_visible = sfp_hwmon_is_visible,
1184 .read = sfp_hwmon_read,
1185 .read_string = sfp_hwmon_read_string,
1188 static u32 sfp_hwmon_chip_config[] = {
1189 HWMON_C_REGISTER_TZ,
1193 static const struct hwmon_channel_info sfp_hwmon_chip = {
1195 .config = sfp_hwmon_chip_config,
1198 static u32 sfp_hwmon_temp_config[] = {
1200 HWMON_T_MAX | HWMON_T_MIN |
1201 HWMON_T_MAX_ALARM | HWMON_T_MIN_ALARM |
1202 HWMON_T_CRIT | HWMON_T_LCRIT |
1203 HWMON_T_CRIT_ALARM | HWMON_T_LCRIT_ALARM |
1208 static const struct hwmon_channel_info sfp_hwmon_temp_channel_info = {
1210 .config = sfp_hwmon_temp_config,
1213 static u32 sfp_hwmon_vcc_config[] = {
1215 HWMON_I_MAX | HWMON_I_MIN |
1216 HWMON_I_MAX_ALARM | HWMON_I_MIN_ALARM |
1217 HWMON_I_CRIT | HWMON_I_LCRIT |
1218 HWMON_I_CRIT_ALARM | HWMON_I_LCRIT_ALARM |
1223 static const struct hwmon_channel_info sfp_hwmon_vcc_channel_info = {
1225 .config = sfp_hwmon_vcc_config,
1228 static u32 sfp_hwmon_bias_config[] = {
1230 HWMON_C_MAX | HWMON_C_MIN |
1231 HWMON_C_MAX_ALARM | HWMON_C_MIN_ALARM |
1232 HWMON_C_CRIT | HWMON_C_LCRIT |
1233 HWMON_C_CRIT_ALARM | HWMON_C_LCRIT_ALARM |
1238 static const struct hwmon_channel_info sfp_hwmon_bias_channel_info = {
1240 .config = sfp_hwmon_bias_config,
1243 static u32 sfp_hwmon_power_config[] = {
1244 /* Transmit power */
1246 HWMON_P_MAX | HWMON_P_MIN |
1247 HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1248 HWMON_P_CRIT | HWMON_P_LCRIT |
1249 HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1253 HWMON_P_MAX | HWMON_P_MIN |
1254 HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1255 HWMON_P_CRIT | HWMON_P_LCRIT |
1256 HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1261 static const struct hwmon_channel_info sfp_hwmon_power_channel_info = {
1262 .type = hwmon_power,
1263 .config = sfp_hwmon_power_config,
1266 static const struct hwmon_channel_info *sfp_hwmon_info[] = {
1268 &sfp_hwmon_vcc_channel_info,
1269 &sfp_hwmon_temp_channel_info,
1270 &sfp_hwmon_bias_channel_info,
1271 &sfp_hwmon_power_channel_info,
1275 static const struct hwmon_chip_info sfp_hwmon_chip_info = {
1276 .ops = &sfp_hwmon_ops,
1277 .info = sfp_hwmon_info,
1280 static void sfp_hwmon_probe(struct work_struct *work)
1282 struct sfp *sfp = container_of(work, struct sfp, hwmon_probe.work);
1285 err = sfp_read(sfp, true, 0, &sfp->diag, sizeof(sfp->diag));
1287 if (sfp->hwmon_tries--) {
1288 mod_delayed_work(system_wq, &sfp->hwmon_probe,
1289 T_PROBE_RETRY_SLOW);
1291 dev_warn(sfp->dev, "hwmon probe failed: %d\n", err);
1296 sfp->hwmon_name = kstrdup(dev_name(sfp->dev), GFP_KERNEL);
1297 if (!sfp->hwmon_name) {
1298 dev_err(sfp->dev, "out of memory for hwmon name\n");
1302 for (i = 0; sfp->hwmon_name[i]; i++)
1303 if (hwmon_is_bad_char(sfp->hwmon_name[i]))
1304 sfp->hwmon_name[i] = '_';
1306 sfp->hwmon_dev = hwmon_device_register_with_info(sfp->dev,
1307 sfp->hwmon_name, sfp,
1308 &sfp_hwmon_chip_info,
1310 if (IS_ERR(sfp->hwmon_dev))
1311 dev_err(sfp->dev, "failed to register hwmon device: %ld\n",
1312 PTR_ERR(sfp->hwmon_dev));
1315 static int sfp_hwmon_insert(struct sfp *sfp)
1317 if (sfp->id.ext.sff8472_compliance == SFP_SFF8472_COMPLIANCE_NONE)
1320 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_DDM))
1323 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1324 /* This driver in general does not support address
1329 mod_delayed_work(system_wq, &sfp->hwmon_probe, 1);
1330 sfp->hwmon_tries = R_PROBE_RETRY_SLOW;
1335 static void sfp_hwmon_remove(struct sfp *sfp)
1337 cancel_delayed_work_sync(&sfp->hwmon_probe);
1338 if (!IS_ERR_OR_NULL(sfp->hwmon_dev)) {
1339 hwmon_device_unregister(sfp->hwmon_dev);
1340 sfp->hwmon_dev = NULL;
1341 kfree(sfp->hwmon_name);
1345 static int sfp_hwmon_init(struct sfp *sfp)
1347 INIT_DELAYED_WORK(&sfp->hwmon_probe, sfp_hwmon_probe);
1352 static void sfp_hwmon_exit(struct sfp *sfp)
1354 cancel_delayed_work_sync(&sfp->hwmon_probe);
1357 static int sfp_hwmon_insert(struct sfp *sfp)
1362 static void sfp_hwmon_remove(struct sfp *sfp)
1366 static int sfp_hwmon_init(struct sfp *sfp)
1371 static void sfp_hwmon_exit(struct sfp *sfp)
1377 static void sfp_module_tx_disable(struct sfp *sfp)
1379 dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1380 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 1);
1381 sfp->state |= SFP_F_TX_DISABLE;
1382 sfp_set_state(sfp, sfp->state);
1385 static void sfp_module_tx_enable(struct sfp *sfp)
1387 dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1388 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 0);
1389 sfp->state &= ~SFP_F_TX_DISABLE;
1390 sfp_set_state(sfp, sfp->state);
1393 static void sfp_module_tx_fault_reset(struct sfp *sfp)
1395 unsigned int state = sfp->state;
1397 if (state & SFP_F_TX_DISABLE)
1400 sfp_set_state(sfp, state | SFP_F_TX_DISABLE);
1404 sfp_set_state(sfp, state);
1407 /* SFP state machine */
1408 static void sfp_sm_set_timer(struct sfp *sfp, unsigned int timeout)
1411 mod_delayed_work(system_power_efficient_wq, &sfp->timeout,
1414 cancel_delayed_work(&sfp->timeout);
1417 static void sfp_sm_next(struct sfp *sfp, unsigned int state,
1418 unsigned int timeout)
1420 sfp->sm_state = state;
1421 sfp_sm_set_timer(sfp, timeout);
1424 static void sfp_sm_mod_next(struct sfp *sfp, unsigned int state,
1425 unsigned int timeout)
1427 sfp->sm_mod_state = state;
1428 sfp_sm_set_timer(sfp, timeout);
1431 static void sfp_sm_phy_detach(struct sfp *sfp)
1433 sfp_remove_phy(sfp->sfp_bus);
1434 phy_device_remove(sfp->mod_phy);
1435 phy_device_free(sfp->mod_phy);
1436 sfp->mod_phy = NULL;
1439 static int sfp_sm_probe_phy(struct sfp *sfp, bool is_c45)
1441 struct phy_device *phy;
1444 phy = get_phy_device(sfp->i2c_mii, SFP_PHY_ADDR, is_c45);
1445 if (phy == ERR_PTR(-ENODEV))
1446 return PTR_ERR(phy);
1448 dev_err(sfp->dev, "mdiobus scan returned %ld\n", PTR_ERR(phy));
1449 return PTR_ERR(phy);
1452 err = phy_device_register(phy);
1454 phy_device_free(phy);
1455 dev_err(sfp->dev, "phy_device_register failed: %d\n", err);
1459 err = sfp_add_phy(sfp->sfp_bus, phy);
1461 phy_device_remove(phy);
1462 phy_device_free(phy);
1463 dev_err(sfp->dev, "sfp_add_phy failed: %d\n", err);
1472 static void sfp_sm_link_up(struct sfp *sfp)
1474 sfp_link_up(sfp->sfp_bus);
1475 sfp_sm_next(sfp, SFP_S_LINK_UP, 0);
1478 static void sfp_sm_link_down(struct sfp *sfp)
1480 sfp_link_down(sfp->sfp_bus);
1483 static void sfp_sm_link_check_los(struct sfp *sfp)
1485 unsigned int los = sfp->state & SFP_F_LOS;
1487 /* If neither SFP_OPTIONS_LOS_INVERTED nor SFP_OPTIONS_LOS_NORMAL
1488 * are set, we assume that no LOS signal is available.
1490 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_INVERTED))
1492 else if (!(sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_NORMAL)))
1496 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
1498 sfp_sm_link_up(sfp);
1501 static bool sfp_los_event_active(struct sfp *sfp, unsigned int event)
1503 return (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_INVERTED) &&
1504 event == SFP_E_LOS_LOW) ||
1505 (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_NORMAL) &&
1506 event == SFP_E_LOS_HIGH);
1509 static bool sfp_los_event_inactive(struct sfp *sfp, unsigned int event)
1511 return (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_INVERTED) &&
1512 event == SFP_E_LOS_HIGH) ||
1513 (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_NORMAL) &&
1514 event == SFP_E_LOS_LOW);
1517 static void sfp_sm_fault(struct sfp *sfp, unsigned int next_state, bool warn)
1519 if (sfp->sm_fault_retries && !--sfp->sm_fault_retries) {
1521 "module persistently indicates fault, disabling\n");
1522 sfp_sm_next(sfp, SFP_S_TX_DISABLE, 0);
1525 dev_err(sfp->dev, "module transmit fault indicated\n");
1527 sfp_sm_next(sfp, next_state, T_FAULT_RECOVER);
1531 /* Probe a SFP for a PHY device if the module supports copper - the PHY
1532 * normally sits at I2C bus address 0x56, and may either be a clause 22
1535 * Clause 22 copper SFP modules normally operate in Cisco SGMII mode with
1536 * negotiation enabled, but some may be in 1000base-X - which is for the
1537 * PHY driver to determine.
1539 * Clause 45 copper SFP+ modules (10G) appear to switch their interface
1540 * mode according to the negotiated line speed.
1542 static int sfp_sm_probe_for_phy(struct sfp *sfp)
1546 switch (sfp->id.base.extended_cc) {
1547 case SFF8024_ECC_10GBASE_T_SFI:
1548 case SFF8024_ECC_10GBASE_T_SR:
1549 case SFF8024_ECC_5GBASE_T:
1550 case SFF8024_ECC_2_5GBASE_T:
1551 err = sfp_sm_probe_phy(sfp, true);
1555 if (sfp->id.base.e1000_base_t)
1556 err = sfp_sm_probe_phy(sfp, false);
1562 static int sfp_module_parse_power(struct sfp *sfp)
1564 u32 power_mW = 1000;
1566 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_POWER_DECL))
1568 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_HIGH_POWER_LEVEL))
1571 if (power_mW > sfp->max_power_mW) {
1572 /* Module power specification exceeds the allowed maximum. */
1573 if (sfp->id.ext.sff8472_compliance ==
1574 SFP_SFF8472_COMPLIANCE_NONE &&
1575 !(sfp->id.ext.diagmon & SFP_DIAGMON_DDM)) {
1576 /* The module appears not to implement bus address
1577 * 0xa2, so assume that the module powers up in the
1581 "Host does not support %u.%uW modules\n",
1582 power_mW / 1000, (power_mW / 100) % 10);
1586 "Host does not support %u.%uW modules, module left in power mode 1\n",
1587 power_mW / 1000, (power_mW / 100) % 10);
1592 /* If the module requires a higher power mode, but also requires
1593 * an address change sequence, warn the user that the module may
1594 * not be functional.
1596 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE && power_mW > 1000) {
1598 "Address Change Sequence not supported but module requires %u.%uW, module may not be functional\n",
1599 power_mW / 1000, (power_mW / 100) % 10);
1603 sfp->module_power_mW = power_mW;
1608 static int sfp_sm_mod_hpower(struct sfp *sfp, bool enable)
1613 err = sfp_read(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1614 if (err != sizeof(val)) {
1615 dev_err(sfp->dev, "Failed to read EEPROM: %d\n", err);
1619 /* DM7052 reports as a high power module, responds to reads (with
1620 * all bytes 0xff) at 0x51 but does not accept writes. In any case,
1621 * if the bit is already set, we're already in high power mode.
1623 if (!!(val & BIT(0)) == enable)
1631 err = sfp_write(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1632 if (err != sizeof(val)) {
1633 dev_err(sfp->dev, "Failed to write EEPROM: %d\n", err);
1638 dev_info(sfp->dev, "Module switched to %u.%uW power level\n",
1639 sfp->module_power_mW / 1000,
1640 (sfp->module_power_mW / 100) % 10);
1645 /* Some modules (Nokia 3FE46541AA) lock up if byte 0x51 is read as a
1646 * single read. Switch back to reading 16 byte blocks unless we have
1647 * a CarlitoxxPro module (rebranded VSOL V2801F). Even more annoyingly,
1648 * some VSOL V2801F have the vendor name changed to OEM.
1650 static int sfp_quirk_i2c_block_size(const struct sfp_eeprom_base *base)
1652 if (!memcmp(base->vendor_name, "VSOL ", 16))
1654 if (!memcmp(base->vendor_name, "OEM ", 16) &&
1655 !memcmp(base->vendor_pn, "V2801F ", 16))
1658 /* Some modules can't cope with long reads */
1662 static void sfp_quirks_base(struct sfp *sfp, const struct sfp_eeprom_base *base)
1664 sfp->i2c_block_size = sfp_quirk_i2c_block_size(base);
1667 static int sfp_cotsworks_fixup_check(struct sfp *sfp, struct sfp_eeprom_id *id)
1672 if (id->base.phys_id != SFF8024_ID_SFF_8472 ||
1673 id->base.phys_ext_id != SFP_PHYS_EXT_ID_SFP ||
1674 id->base.connector != SFF8024_CONNECTOR_LC) {
1675 dev_warn(sfp->dev, "Rewriting fiber module EEPROM with corrected values\n");
1676 id->base.phys_id = SFF8024_ID_SFF_8472;
1677 id->base.phys_ext_id = SFP_PHYS_EXT_ID_SFP;
1678 id->base.connector = SFF8024_CONNECTOR_LC;
1679 err = sfp_write(sfp, false, SFP_PHYS_ID, &id->base, 3);
1681 dev_err(sfp->dev, "Failed to rewrite module EEPROM: %d\n", err);
1685 /* Cotsworks modules have been found to require a delay between write operations. */
1688 /* Update base structure checksum */
1689 check = sfp_check(&id->base, sizeof(id->base) - 1);
1690 err = sfp_write(sfp, false, SFP_CC_BASE, &check, 1);
1692 dev_err(sfp->dev, "Failed to update base structure checksum in fiber module EEPROM: %d\n", err);
1699 static int sfp_sm_mod_probe(struct sfp *sfp, bool report)
1701 /* SFP module inserted - read I2C data */
1702 struct sfp_eeprom_id id;
1703 bool cotsworks_sfbg;
1708 /* Some modules (CarlitoxxPro CPGOS03-0490) do not support multibyte
1709 * reads from the EEPROM, so start by reading the base identifying
1710 * information one byte at a time.
1712 sfp->i2c_block_size = 1;
1714 ret = sfp_read(sfp, false, 0, &id.base, sizeof(id.base));
1717 dev_err(sfp->dev, "failed to read EEPROM: %d\n", ret);
1721 if (ret != sizeof(id.base)) {
1722 dev_err(sfp->dev, "EEPROM short read: %d\n", ret);
1726 /* Cotsworks do not seem to update the checksums when they
1727 * do the final programming with the final module part number,
1728 * serial number and date code.
1730 cotsworks = !memcmp(id.base.vendor_name, "COTSWORKS ", 16);
1731 cotsworks_sfbg = !memcmp(id.base.vendor_pn, "SFBG", 4);
1733 /* Cotsworks SFF module EEPROM do not always have valid phys_id,
1734 * phys_ext_id, and connector bytes. Rewrite SFF EEPROM bytes if
1735 * Cotsworks PN matches and bytes are not correct.
1737 if (cotsworks && cotsworks_sfbg) {
1738 ret = sfp_cotsworks_fixup_check(sfp, &id);
1743 /* Validate the checksum over the base structure */
1744 check = sfp_check(&id.base, sizeof(id.base) - 1);
1745 if (check != id.base.cc_base) {
1748 "EEPROM base structure checksum failure (0x%02x != 0x%02x)\n",
1749 check, id.base.cc_base);
1752 "EEPROM base structure checksum failure: 0x%02x != 0x%02x\n",
1753 check, id.base.cc_base);
1754 print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
1755 16, 1, &id, sizeof(id), true);
1760 /* Apply any early module-specific quirks */
1761 sfp_quirks_base(sfp, &id.base);
1763 ret = sfp_read(sfp, false, SFP_CC_BASE + 1, &id.ext, sizeof(id.ext));
1766 dev_err(sfp->dev, "failed to read EEPROM: %d\n", ret);
1770 if (ret != sizeof(id.ext)) {
1771 dev_err(sfp->dev, "EEPROM short read: %d\n", ret);
1775 check = sfp_check(&id.ext, sizeof(id.ext) - 1);
1776 if (check != id.ext.cc_ext) {
1779 "EEPROM extended structure checksum failure (0x%02x != 0x%02x)\n",
1780 check, id.ext.cc_ext);
1783 "EEPROM extended structure checksum failure: 0x%02x != 0x%02x\n",
1784 check, id.ext.cc_ext);
1785 print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
1786 16, 1, &id, sizeof(id), true);
1787 memset(&id.ext, 0, sizeof(id.ext));
1793 dev_info(sfp->dev, "module %.*s %.*s rev %.*s sn %.*s dc %.*s\n",
1794 (int)sizeof(id.base.vendor_name), id.base.vendor_name,
1795 (int)sizeof(id.base.vendor_pn), id.base.vendor_pn,
1796 (int)sizeof(id.base.vendor_rev), id.base.vendor_rev,
1797 (int)sizeof(id.ext.vendor_sn), id.ext.vendor_sn,
1798 (int)sizeof(id.ext.datecode), id.ext.datecode);
1800 /* Check whether we support this module */
1801 if (!sfp->type->module_supported(&id)) {
1803 "module is not supported - phys id 0x%02x 0x%02x\n",
1804 sfp->id.base.phys_id, sfp->id.base.phys_ext_id);
1808 /* If the module requires address swap mode, warn about it */
1809 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1811 "module address swap to access page 0xA2 is not supported.\n");
1813 /* Parse the module power requirement */
1814 ret = sfp_module_parse_power(sfp);
1818 if (!memcmp(id.base.vendor_name, "ALCATELLUCENT ", 16) &&
1819 !memcmp(id.base.vendor_pn, "3FE46541AA ", 16))
1820 sfp->module_t_start_up = T_START_UP_BAD_GPON;
1822 sfp->module_t_start_up = T_START_UP;
1827 static void sfp_sm_mod_remove(struct sfp *sfp)
1829 if (sfp->sm_mod_state > SFP_MOD_WAITDEV)
1830 sfp_module_remove(sfp->sfp_bus);
1832 sfp_hwmon_remove(sfp);
1834 memset(&sfp->id, 0, sizeof(sfp->id));
1835 sfp->module_power_mW = 0;
1837 dev_info(sfp->dev, "module removed\n");
1840 /* This state machine tracks the upstream's state */
1841 static void sfp_sm_device(struct sfp *sfp, unsigned int event)
1843 switch (sfp->sm_dev_state) {
1845 if (event == SFP_E_DEV_ATTACH)
1846 sfp->sm_dev_state = SFP_DEV_DOWN;
1850 if (event == SFP_E_DEV_DETACH)
1851 sfp->sm_dev_state = SFP_DEV_DETACHED;
1852 else if (event == SFP_E_DEV_UP)
1853 sfp->sm_dev_state = SFP_DEV_UP;
1857 if (event == SFP_E_DEV_DETACH)
1858 sfp->sm_dev_state = SFP_DEV_DETACHED;
1859 else if (event == SFP_E_DEV_DOWN)
1860 sfp->sm_dev_state = SFP_DEV_DOWN;
1865 /* This state machine tracks the insert/remove state of the module, probes
1866 * the on-board EEPROM, and sets up the power level.
1868 static void sfp_sm_module(struct sfp *sfp, unsigned int event)
1872 /* Handle remove event globally, it resets this state machine */
1873 if (event == SFP_E_REMOVE) {
1874 if (sfp->sm_mod_state > SFP_MOD_PROBE)
1875 sfp_sm_mod_remove(sfp);
1876 sfp_sm_mod_next(sfp, SFP_MOD_EMPTY, 0);
1880 /* Handle device detach globally */
1881 if (sfp->sm_dev_state < SFP_DEV_DOWN &&
1882 sfp->sm_mod_state > SFP_MOD_WAITDEV) {
1883 if (sfp->module_power_mW > 1000 &&
1884 sfp->sm_mod_state > SFP_MOD_HPOWER)
1885 sfp_sm_mod_hpower(sfp, false);
1886 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
1890 switch (sfp->sm_mod_state) {
1892 if (event == SFP_E_INSERT) {
1893 sfp_sm_mod_next(sfp, SFP_MOD_PROBE, T_SERIAL);
1894 sfp->sm_mod_tries_init = R_PROBE_RETRY_INIT;
1895 sfp->sm_mod_tries = R_PROBE_RETRY_SLOW;
1900 /* Wait for T_PROBE_INIT to time out */
1901 if (event != SFP_E_TIMEOUT)
1904 err = sfp_sm_mod_probe(sfp, sfp->sm_mod_tries == 1);
1905 if (err == -EAGAIN) {
1906 if (sfp->sm_mod_tries_init &&
1907 --sfp->sm_mod_tries_init) {
1908 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
1910 } else if (sfp->sm_mod_tries && --sfp->sm_mod_tries) {
1911 if (sfp->sm_mod_tries == R_PROBE_RETRY_SLOW - 1)
1913 "please wait, module slow to respond\n");
1914 sfp_sm_set_timer(sfp, T_PROBE_RETRY_SLOW);
1919 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
1923 err = sfp_hwmon_insert(sfp);
1925 dev_warn(sfp->dev, "hwmon probe failed: %d\n", err);
1927 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
1929 case SFP_MOD_WAITDEV:
1930 /* Ensure that the device is attached before proceeding */
1931 if (sfp->sm_dev_state < SFP_DEV_DOWN)
1934 /* Report the module insertion to the upstream device */
1935 err = sfp_module_insert(sfp->sfp_bus, &sfp->id);
1937 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
1941 /* If this is a power level 1 module, we are done */
1942 if (sfp->module_power_mW <= 1000)
1945 sfp_sm_mod_next(sfp, SFP_MOD_HPOWER, 0);
1947 case SFP_MOD_HPOWER:
1948 /* Enable high power mode */
1949 err = sfp_sm_mod_hpower(sfp, true);
1951 if (err != -EAGAIN) {
1952 sfp_module_remove(sfp->sfp_bus);
1953 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
1955 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
1960 sfp_sm_mod_next(sfp, SFP_MOD_WAITPWR, T_HPOWER_LEVEL);
1963 case SFP_MOD_WAITPWR:
1964 /* Wait for T_HPOWER_LEVEL to time out */
1965 if (event != SFP_E_TIMEOUT)
1969 sfp_sm_mod_next(sfp, SFP_MOD_PRESENT, 0);
1972 case SFP_MOD_PRESENT:
1978 static void sfp_sm_main(struct sfp *sfp, unsigned int event)
1980 unsigned long timeout;
1983 /* Some events are global */
1984 if (sfp->sm_state != SFP_S_DOWN &&
1985 (sfp->sm_mod_state != SFP_MOD_PRESENT ||
1986 sfp->sm_dev_state != SFP_DEV_UP)) {
1987 if (sfp->sm_state == SFP_S_LINK_UP &&
1988 sfp->sm_dev_state == SFP_DEV_UP)
1989 sfp_sm_link_down(sfp);
1990 if (sfp->sm_state > SFP_S_INIT)
1991 sfp_module_stop(sfp->sfp_bus);
1993 sfp_sm_phy_detach(sfp);
1994 sfp_module_tx_disable(sfp);
1995 sfp_soft_stop_poll(sfp);
1996 sfp_sm_next(sfp, SFP_S_DOWN, 0);
2000 /* The main state machine */
2001 switch (sfp->sm_state) {
2003 if (sfp->sm_mod_state != SFP_MOD_PRESENT ||
2004 sfp->sm_dev_state != SFP_DEV_UP)
2007 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE))
2008 sfp_soft_start_poll(sfp);
2010 sfp_module_tx_enable(sfp);
2012 /* Initialise the fault clearance retries */
2013 sfp->sm_fault_retries = N_FAULT_INIT;
2015 /* We need to check the TX_FAULT state, which is not defined
2016 * while TX_DISABLE is asserted. The earliest we want to do
2017 * anything (such as probe for a PHY) is 50ms.
2019 sfp_sm_next(sfp, SFP_S_WAIT, T_WAIT);
2023 if (event != SFP_E_TIMEOUT)
2026 if (sfp->state & SFP_F_TX_FAULT) {
2027 /* Wait up to t_init (SFF-8472) or t_start_up (SFF-8431)
2028 * from the TX_DISABLE deassertion for the module to
2029 * initialise, which is indicated by TX_FAULT
2032 timeout = sfp->module_t_start_up;
2033 if (timeout > T_WAIT)
2038 sfp_sm_next(sfp, SFP_S_INIT, timeout);
2040 /* TX_FAULT is not asserted, assume the module has
2041 * finished initialising.
2048 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
2049 /* TX_FAULT is still asserted after t_init or
2050 * or t_start_up, so assume there is a fault.
2052 sfp_sm_fault(sfp, SFP_S_INIT_TX_FAULT,
2053 sfp->sm_fault_retries == N_FAULT_INIT);
2054 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
2056 sfp->sm_phy_retries = R_PHY_RETRY;
2061 case SFP_S_INIT_PHY:
2062 if (event != SFP_E_TIMEOUT)
2065 /* TX_FAULT deasserted or we timed out with TX_FAULT
2066 * clear. Probe for the PHY and check the LOS state.
2068 ret = sfp_sm_probe_for_phy(sfp);
2069 if (ret == -ENODEV) {
2070 if (--sfp->sm_phy_retries) {
2071 sfp_sm_next(sfp, SFP_S_INIT_PHY, T_PHY_RETRY);
2074 dev_info(sfp->dev, "no PHY detected\n");
2077 sfp_sm_next(sfp, SFP_S_FAIL, 0);
2080 if (sfp_module_start(sfp->sfp_bus)) {
2081 sfp_sm_next(sfp, SFP_S_FAIL, 0);
2084 sfp_sm_link_check_los(sfp);
2086 /* Reset the fault retry count */
2087 sfp->sm_fault_retries = N_FAULT;
2090 case SFP_S_INIT_TX_FAULT:
2091 if (event == SFP_E_TIMEOUT) {
2092 sfp_module_tx_fault_reset(sfp);
2093 sfp_sm_next(sfp, SFP_S_INIT, sfp->module_t_start_up);
2097 case SFP_S_WAIT_LOS:
2098 if (event == SFP_E_TX_FAULT)
2099 sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
2100 else if (sfp_los_event_inactive(sfp, event))
2101 sfp_sm_link_up(sfp);
2105 if (event == SFP_E_TX_FAULT) {
2106 sfp_sm_link_down(sfp);
2107 sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
2108 } else if (sfp_los_event_active(sfp, event)) {
2109 sfp_sm_link_down(sfp);
2110 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
2114 case SFP_S_TX_FAULT:
2115 if (event == SFP_E_TIMEOUT) {
2116 sfp_module_tx_fault_reset(sfp);
2117 sfp_sm_next(sfp, SFP_S_REINIT, sfp->module_t_start_up);
2122 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
2123 sfp_sm_fault(sfp, SFP_S_TX_FAULT, false);
2124 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
2125 dev_info(sfp->dev, "module transmit fault recovered\n");
2126 sfp_sm_link_check_los(sfp);
2130 case SFP_S_TX_DISABLE:
2135 static void sfp_sm_event(struct sfp *sfp, unsigned int event)
2137 mutex_lock(&sfp->sm_mutex);
2139 dev_dbg(sfp->dev, "SM: enter %s:%s:%s event %s\n",
2140 mod_state_to_str(sfp->sm_mod_state),
2141 dev_state_to_str(sfp->sm_dev_state),
2142 sm_state_to_str(sfp->sm_state),
2143 event_to_str(event));
2145 sfp_sm_device(sfp, event);
2146 sfp_sm_module(sfp, event);
2147 sfp_sm_main(sfp, event);
2149 dev_dbg(sfp->dev, "SM: exit %s:%s:%s\n",
2150 mod_state_to_str(sfp->sm_mod_state),
2151 dev_state_to_str(sfp->sm_dev_state),
2152 sm_state_to_str(sfp->sm_state));
2154 mutex_unlock(&sfp->sm_mutex);
2157 static void sfp_attach(struct sfp *sfp)
2159 sfp_sm_event(sfp, SFP_E_DEV_ATTACH);
2162 static void sfp_detach(struct sfp *sfp)
2164 sfp_sm_event(sfp, SFP_E_DEV_DETACH);
2167 static void sfp_start(struct sfp *sfp)
2169 sfp_sm_event(sfp, SFP_E_DEV_UP);
2172 static void sfp_stop(struct sfp *sfp)
2174 sfp_sm_event(sfp, SFP_E_DEV_DOWN);
2177 static int sfp_module_info(struct sfp *sfp, struct ethtool_modinfo *modinfo)
2179 /* locking... and check module is present */
2181 if (sfp->id.ext.sff8472_compliance &&
2182 !(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)) {
2183 modinfo->type = ETH_MODULE_SFF_8472;
2184 modinfo->eeprom_len = ETH_MODULE_SFF_8472_LEN;
2186 modinfo->type = ETH_MODULE_SFF_8079;
2187 modinfo->eeprom_len = ETH_MODULE_SFF_8079_LEN;
2192 static int sfp_module_eeprom(struct sfp *sfp, struct ethtool_eeprom *ee,
2195 unsigned int first, last, len;
2202 last = ee->offset + ee->len;
2203 if (first < ETH_MODULE_SFF_8079_LEN) {
2204 len = min_t(unsigned int, last, ETH_MODULE_SFF_8079_LEN);
2207 ret = sfp_read(sfp, false, first, data, len);
2214 if (first < ETH_MODULE_SFF_8472_LEN && last > ETH_MODULE_SFF_8079_LEN) {
2215 len = min_t(unsigned int, last, ETH_MODULE_SFF_8472_LEN);
2217 first -= ETH_MODULE_SFF_8079_LEN;
2219 ret = sfp_read(sfp, true, first, data, len);
2226 static const struct sfp_socket_ops sfp_module_ops = {
2227 .attach = sfp_attach,
2228 .detach = sfp_detach,
2231 .module_info = sfp_module_info,
2232 .module_eeprom = sfp_module_eeprom,
2235 static void sfp_timeout(struct work_struct *work)
2237 struct sfp *sfp = container_of(work, struct sfp, timeout.work);
2240 sfp_sm_event(sfp, SFP_E_TIMEOUT);
2244 static void sfp_check_state(struct sfp *sfp)
2246 unsigned int state, i, changed;
2248 mutex_lock(&sfp->st_mutex);
2249 state = sfp_get_state(sfp);
2250 changed = state ^ sfp->state;
2251 changed &= SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT;
2253 for (i = 0; i < GPIO_MAX; i++)
2254 if (changed & BIT(i))
2255 dev_dbg(sfp->dev, "%s %u -> %u\n", gpio_of_names[i],
2256 !!(sfp->state & BIT(i)), !!(state & BIT(i)));
2258 state |= sfp->state & (SFP_F_TX_DISABLE | SFP_F_RATE_SELECT);
2262 if (changed & SFP_F_PRESENT)
2263 sfp_sm_event(sfp, state & SFP_F_PRESENT ?
2264 SFP_E_INSERT : SFP_E_REMOVE);
2266 if (changed & SFP_F_TX_FAULT)
2267 sfp_sm_event(sfp, state & SFP_F_TX_FAULT ?
2268 SFP_E_TX_FAULT : SFP_E_TX_CLEAR);
2270 if (changed & SFP_F_LOS)
2271 sfp_sm_event(sfp, state & SFP_F_LOS ?
2272 SFP_E_LOS_HIGH : SFP_E_LOS_LOW);
2274 mutex_unlock(&sfp->st_mutex);
2277 static irqreturn_t sfp_irq(int irq, void *data)
2279 struct sfp *sfp = data;
2281 sfp_check_state(sfp);
2286 static void sfp_poll(struct work_struct *work)
2288 struct sfp *sfp = container_of(work, struct sfp, poll.work);
2290 sfp_check_state(sfp);
2292 if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) ||
2294 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2297 static struct sfp *sfp_alloc(struct device *dev)
2301 sfp = kzalloc(sizeof(*sfp), GFP_KERNEL);
2303 return ERR_PTR(-ENOMEM);
2307 mutex_init(&sfp->sm_mutex);
2308 mutex_init(&sfp->st_mutex);
2309 INIT_DELAYED_WORK(&sfp->poll, sfp_poll);
2310 INIT_DELAYED_WORK(&sfp->timeout, sfp_timeout);
2312 sfp_hwmon_init(sfp);
2317 static void sfp_cleanup(void *data)
2319 struct sfp *sfp = data;
2321 sfp_hwmon_exit(sfp);
2323 cancel_delayed_work_sync(&sfp->poll);
2324 cancel_delayed_work_sync(&sfp->timeout);
2326 mdiobus_unregister(sfp->i2c_mii);
2327 mdiobus_free(sfp->i2c_mii);
2330 i2c_put_adapter(sfp->i2c);
2334 static int sfp_probe(struct platform_device *pdev)
2336 const struct sff_data *sff;
2337 struct i2c_adapter *i2c;
2342 sfp = sfp_alloc(&pdev->dev);
2344 return PTR_ERR(sfp);
2346 platform_set_drvdata(pdev, sfp);
2348 err = devm_add_action(sfp->dev, sfp_cleanup, sfp);
2352 sff = sfp->type = &sfp_data;
2354 if (pdev->dev.of_node) {
2355 struct device_node *node = pdev->dev.of_node;
2356 const struct of_device_id *id;
2357 struct device_node *np;
2359 id = of_match_node(sfp_of_match, node);
2363 sff = sfp->type = id->data;
2365 np = of_parse_phandle(node, "i2c-bus", 0);
2367 dev_err(sfp->dev, "missing 'i2c-bus' property\n");
2371 i2c = of_find_i2c_adapter_by_node(np);
2373 } else if (has_acpi_companion(&pdev->dev)) {
2374 struct acpi_device *adev = ACPI_COMPANION(&pdev->dev);
2375 struct fwnode_handle *fw = acpi_fwnode_handle(adev);
2376 struct fwnode_reference_args args;
2377 struct acpi_handle *acpi_handle;
2380 ret = acpi_node_get_property_reference(fw, "i2c-bus", 0, &args);
2381 if (ret || !is_acpi_device_node(args.fwnode)) {
2382 dev_err(&pdev->dev, "missing 'i2c-bus' property\n");
2386 acpi_handle = ACPI_HANDLE_FWNODE(args.fwnode);
2387 i2c = i2c_acpi_find_adapter_by_handle(acpi_handle);
2393 return -EPROBE_DEFER;
2395 err = sfp_i2c_configure(sfp, i2c);
2397 i2c_put_adapter(i2c);
2401 for (i = 0; i < GPIO_MAX; i++)
2402 if (sff->gpios & BIT(i)) {
2403 sfp->gpio[i] = devm_gpiod_get_optional(sfp->dev,
2404 gpio_of_names[i], gpio_flags[i]);
2405 if (IS_ERR(sfp->gpio[i]))
2406 return PTR_ERR(sfp->gpio[i]);
2409 sfp->get_state = sfp_gpio_get_state;
2410 sfp->set_state = sfp_gpio_set_state;
2412 /* Modules that have no detect signal are always present */
2413 if (!(sfp->gpio[GPIO_MODDEF0]))
2414 sfp->get_state = sff_gpio_get_state;
2416 device_property_read_u32(&pdev->dev, "maximum-power-milliwatt",
2417 &sfp->max_power_mW);
2418 if (!sfp->max_power_mW)
2419 sfp->max_power_mW = 1000;
2421 dev_info(sfp->dev, "Host maximum power %u.%uW\n",
2422 sfp->max_power_mW / 1000, (sfp->max_power_mW / 100) % 10);
2424 /* Get the initial state, and always signal TX disable,
2425 * since the network interface will not be up.
2427 sfp->state = sfp_get_state(sfp) | SFP_F_TX_DISABLE;
2429 if (sfp->gpio[GPIO_RATE_SELECT] &&
2430 gpiod_get_value_cansleep(sfp->gpio[GPIO_RATE_SELECT]))
2431 sfp->state |= SFP_F_RATE_SELECT;
2432 sfp_set_state(sfp, sfp->state);
2433 sfp_module_tx_disable(sfp);
2434 if (sfp->state & SFP_F_PRESENT) {
2436 sfp_sm_event(sfp, SFP_E_INSERT);
2440 for (i = 0; i < GPIO_MAX; i++) {
2441 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
2444 sfp->gpio_irq[i] = gpiod_to_irq(sfp->gpio[i]);
2445 if (sfp->gpio_irq[i] < 0) {
2446 sfp->gpio_irq[i] = 0;
2447 sfp->need_poll = true;
2451 sfp_irq_name = devm_kasprintf(sfp->dev, GFP_KERNEL,
2452 "%s-%s", dev_name(sfp->dev),
2458 err = devm_request_threaded_irq(sfp->dev, sfp->gpio_irq[i],
2461 IRQF_TRIGGER_RISING |
2462 IRQF_TRIGGER_FALLING,
2465 sfp->gpio_irq[i] = 0;
2466 sfp->need_poll = true;
2471 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2473 /* We could have an issue in cases no Tx disable pin is available or
2474 * wired as modules using a laser as their light source will continue to
2475 * be active when the fiber is removed. This could be a safety issue and
2476 * we should at least warn the user about that.
2478 if (!sfp->gpio[GPIO_TX_DISABLE])
2480 "No tx_disable pin: SFP modules will always be emitting.\n");
2482 sfp->sfp_bus = sfp_register_socket(sfp->dev, sfp, &sfp_module_ops);
2489 static int sfp_remove(struct platform_device *pdev)
2491 struct sfp *sfp = platform_get_drvdata(pdev);
2493 sfp_unregister_socket(sfp->sfp_bus);
2496 sfp_sm_event(sfp, SFP_E_REMOVE);
2502 static void sfp_shutdown(struct platform_device *pdev)
2504 struct sfp *sfp = platform_get_drvdata(pdev);
2507 for (i = 0; i < GPIO_MAX; i++) {
2508 if (!sfp->gpio_irq[i])
2511 devm_free_irq(sfp->dev, sfp->gpio_irq[i], sfp);
2514 cancel_delayed_work_sync(&sfp->poll);
2515 cancel_delayed_work_sync(&sfp->timeout);
2518 static struct platform_driver sfp_driver = {
2520 .remove = sfp_remove,
2521 .shutdown = sfp_shutdown,
2524 .of_match_table = sfp_of_match,
2528 static int sfp_init(void)
2530 poll_jiffies = msecs_to_jiffies(100);
2532 return platform_driver_register(&sfp_driver);
2534 module_init(sfp_init);
2536 static void sfp_exit(void)
2538 platform_driver_unregister(&sfp_driver);
2540 module_exit(sfp_exit);
2542 MODULE_ALIAS("platform:sfp");
2543 MODULE_AUTHOR("Russell King");
2544 MODULE_LICENSE("GPL v2");