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/module.h>
11 #include <linux/mutex.h>
13 #include <linux/phy.h>
14 #include <linux/platform_device.h>
15 #include <linux/rtnetlink.h>
16 #include <linux/slab.h>
17 #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),
72 static const char * const mod_state_strings[] = {
73 [SFP_MOD_EMPTY] = "empty",
74 [SFP_MOD_ERROR] = "error",
75 [SFP_MOD_PROBE] = "probe",
76 [SFP_MOD_WAITDEV] = "waitdev",
77 [SFP_MOD_HPOWER] = "hpower",
78 [SFP_MOD_WAITPWR] = "waitpwr",
79 [SFP_MOD_PRESENT] = "present",
82 static const char *mod_state_to_str(unsigned short mod_state)
84 if (mod_state >= ARRAY_SIZE(mod_state_strings))
85 return "Unknown module state";
86 return mod_state_strings[mod_state];
89 static const char * const dev_state_strings[] = {
90 [SFP_DEV_DETACHED] = "detached",
91 [SFP_DEV_DOWN] = "down",
95 static const char *dev_state_to_str(unsigned short dev_state)
97 if (dev_state >= ARRAY_SIZE(dev_state_strings))
98 return "Unknown device state";
99 return dev_state_strings[dev_state];
102 static const char * const event_strings[] = {
103 [SFP_E_INSERT] = "insert",
104 [SFP_E_REMOVE] = "remove",
105 [SFP_E_DEV_ATTACH] = "dev_attach",
106 [SFP_E_DEV_DETACH] = "dev_detach",
107 [SFP_E_DEV_DOWN] = "dev_down",
108 [SFP_E_DEV_UP] = "dev_up",
109 [SFP_E_TX_FAULT] = "tx_fault",
110 [SFP_E_TX_CLEAR] = "tx_clear",
111 [SFP_E_LOS_HIGH] = "los_high",
112 [SFP_E_LOS_LOW] = "los_low",
113 [SFP_E_TIMEOUT] = "timeout",
116 static const char *event_to_str(unsigned short event)
118 if (event >= ARRAY_SIZE(event_strings))
119 return "Unknown event";
120 return event_strings[event];
123 static const char * const sm_state_strings[] = {
124 [SFP_S_DOWN] = "down",
125 [SFP_S_WAIT] = "wait",
126 [SFP_S_INIT] = "init",
127 [SFP_S_INIT_TX_FAULT] = "init_tx_fault",
128 [SFP_S_WAIT_LOS] = "wait_los",
129 [SFP_S_LINK_UP] = "link_up",
130 [SFP_S_TX_FAULT] = "tx_fault",
131 [SFP_S_REINIT] = "reinit",
132 [SFP_S_TX_DISABLE] = "rx_disable",
135 static const char *sm_state_to_str(unsigned short sm_state)
137 if (sm_state >= ARRAY_SIZE(sm_state_strings))
138 return "Unknown state";
139 return sm_state_strings[sm_state];
142 static const char *gpio_of_names[] = {
150 static const enum gpiod_flags gpio_flags[] = {
158 #define T_WAIT msecs_to_jiffies(50)
159 #define T_INIT_JIFFIES msecs_to_jiffies(300)
160 #define T_RESET_US 10
161 #define T_FAULT_RECOVER msecs_to_jiffies(1000)
163 /* SFP module presence detection is poor: the three MOD DEF signals are
164 * the same length on the PCB, which means it's possible for MOD DEF 0 to
165 * connect before the I2C bus on MOD DEF 1/2.
167 * The SFF-8472 specifies t_serial ("Time from power on until module is
168 * ready for data transmission over the two wire serial bus.") as 300ms.
170 #define T_SERIAL msecs_to_jiffies(300)
171 #define T_HPOWER_LEVEL msecs_to_jiffies(300)
172 #define T_PROBE_RETRY_INIT msecs_to_jiffies(100)
173 #define R_PROBE_RETRY_INIT 10
174 #define T_PROBE_RETRY_SLOW msecs_to_jiffies(5000)
175 #define R_PROBE_RETRY_SLOW 12
177 /* SFP modules appear to always have their PHY configured for bus address
178 * 0x56 (which with mdio-i2c, translates to a PHY address of 22).
180 #define SFP_PHY_ADDR 22
184 bool (*module_supported)(const struct sfp_eeprom_id *id);
189 struct i2c_adapter *i2c;
190 struct mii_bus *i2c_mii;
191 struct sfp_bus *sfp_bus;
192 struct phy_device *mod_phy;
193 const struct sff_data *type;
196 unsigned int (*get_state)(struct sfp *);
197 void (*set_state)(struct sfp *, unsigned int);
198 int (*read)(struct sfp *, bool, u8, void *, size_t);
199 int (*write)(struct sfp *, bool, u8, void *, size_t);
201 struct gpio_desc *gpio[GPIO_MAX];
202 int gpio_irq[GPIO_MAX];
206 struct mutex st_mutex; /* Protects state */
207 unsigned int state_soft_mask;
209 struct delayed_work poll;
210 struct delayed_work timeout;
211 struct mutex sm_mutex; /* Protects state machine */
212 unsigned char sm_mod_state;
213 unsigned char sm_mod_tries_init;
214 unsigned char sm_mod_tries;
215 unsigned char sm_dev_state;
216 unsigned short sm_state;
217 unsigned int sm_retries;
219 struct sfp_eeprom_id id;
220 unsigned int module_power_mW;
222 #if IS_ENABLED(CONFIG_HWMON)
223 struct sfp_diag diag;
224 struct delayed_work hwmon_probe;
225 unsigned int hwmon_tries;
226 struct device *hwmon_dev;
232 static bool sff_module_supported(const struct sfp_eeprom_id *id)
234 return id->base.phys_id == SFP_PHYS_ID_SFF &&
235 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP;
238 static const struct sff_data sff_data = {
239 .gpios = SFP_F_LOS | SFP_F_TX_FAULT | SFP_F_TX_DISABLE,
240 .module_supported = sff_module_supported,
243 static bool sfp_module_supported(const struct sfp_eeprom_id *id)
245 return id->base.phys_id == SFP_PHYS_ID_SFP &&
246 id->base.phys_ext_id == SFP_PHYS_EXT_ID_SFP;
249 static const struct sff_data sfp_data = {
250 .gpios = SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT |
251 SFP_F_TX_DISABLE | SFP_F_RATE_SELECT,
252 .module_supported = sfp_module_supported,
255 static const struct of_device_id sfp_of_match[] = {
256 { .compatible = "sff,sff", .data = &sff_data, },
257 { .compatible = "sff,sfp", .data = &sfp_data, },
260 MODULE_DEVICE_TABLE(of, sfp_of_match);
262 static unsigned long poll_jiffies;
264 static unsigned int sfp_gpio_get_state(struct sfp *sfp)
266 unsigned int i, state, v;
268 for (i = state = 0; i < GPIO_MAX; i++) {
269 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
272 v = gpiod_get_value_cansleep(sfp->gpio[i]);
280 static unsigned int sff_gpio_get_state(struct sfp *sfp)
282 return sfp_gpio_get_state(sfp) | SFP_F_PRESENT;
285 static void sfp_gpio_set_state(struct sfp *sfp, unsigned int state)
287 if (state & SFP_F_PRESENT) {
288 /* If the module is present, drive the signals */
289 if (sfp->gpio[GPIO_TX_DISABLE])
290 gpiod_direction_output(sfp->gpio[GPIO_TX_DISABLE],
291 state & SFP_F_TX_DISABLE);
292 if (state & SFP_F_RATE_SELECT)
293 gpiod_direction_output(sfp->gpio[GPIO_RATE_SELECT],
294 state & SFP_F_RATE_SELECT);
296 /* Otherwise, let them float to the pull-ups */
297 if (sfp->gpio[GPIO_TX_DISABLE])
298 gpiod_direction_input(sfp->gpio[GPIO_TX_DISABLE]);
299 if (state & SFP_F_RATE_SELECT)
300 gpiod_direction_input(sfp->gpio[GPIO_RATE_SELECT]);
304 static int sfp_i2c_read(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
307 struct i2c_msg msgs[2];
308 u8 bus_addr = a2 ? 0x51 : 0x50;
312 msgs[0].addr = bus_addr;
315 msgs[0].buf = &dev_addr;
316 msgs[1].addr = bus_addr;
317 msgs[1].flags = I2C_M_RD;
326 msgs[1].len = this_len;
328 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
332 if (ret != ARRAY_SIZE(msgs))
335 msgs[1].buf += this_len;
336 dev_addr += this_len;
340 return msgs[1].buf - (u8 *)buf;
343 static int sfp_i2c_write(struct sfp *sfp, bool a2, u8 dev_addr, void *buf,
346 struct i2c_msg msgs[1];
347 u8 bus_addr = a2 ? 0x51 : 0x50;
350 msgs[0].addr = bus_addr;
352 msgs[0].len = 1 + len;
353 msgs[0].buf = kmalloc(1 + len, GFP_KERNEL);
357 msgs[0].buf[0] = dev_addr;
358 memcpy(&msgs[0].buf[1], buf, len);
360 ret = i2c_transfer(sfp->i2c, msgs, ARRAY_SIZE(msgs));
367 return ret == ARRAY_SIZE(msgs) ? len : 0;
370 static int sfp_i2c_configure(struct sfp *sfp, struct i2c_adapter *i2c)
372 struct mii_bus *i2c_mii;
375 if (!i2c_check_functionality(i2c, I2C_FUNC_I2C))
379 sfp->read = sfp_i2c_read;
380 sfp->write = sfp_i2c_write;
382 i2c_mii = mdio_i2c_alloc(sfp->dev, i2c);
384 return PTR_ERR(i2c_mii);
386 i2c_mii->name = "SFP I2C Bus";
387 i2c_mii->phy_mask = ~0;
389 ret = mdiobus_register(i2c_mii);
391 mdiobus_free(i2c_mii);
395 sfp->i2c_mii = i2c_mii;
401 static int sfp_read(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
403 return sfp->read(sfp, a2, addr, buf, len);
406 static int sfp_write(struct sfp *sfp, bool a2, u8 addr, void *buf, size_t len)
408 return sfp->write(sfp, a2, addr, buf, len);
411 static unsigned int sfp_soft_get_state(struct sfp *sfp)
413 unsigned int state = 0;
416 if (sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status)) ==
418 if (status & SFP_STATUS_RX_LOS)
420 if (status & SFP_STATUS_TX_FAULT)
421 state |= SFP_F_TX_FAULT;
424 return state & sfp->state_soft_mask;
427 static void sfp_soft_set_state(struct sfp *sfp, unsigned int state)
431 if (sfp_read(sfp, true, SFP_STATUS, &status, sizeof(status)) ==
433 if (state & SFP_F_TX_DISABLE)
434 status |= SFP_STATUS_TX_DISABLE_FORCE;
436 status &= ~SFP_STATUS_TX_DISABLE_FORCE;
438 sfp_write(sfp, true, SFP_STATUS, &status, sizeof(status));
442 static void sfp_soft_start_poll(struct sfp *sfp)
444 const struct sfp_eeprom_id *id = &sfp->id;
446 sfp->state_soft_mask = 0;
447 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_DISABLE &&
448 !sfp->gpio[GPIO_TX_DISABLE])
449 sfp->state_soft_mask |= SFP_F_TX_DISABLE;
450 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_TX_FAULT &&
451 !sfp->gpio[GPIO_TX_FAULT])
452 sfp->state_soft_mask |= SFP_F_TX_FAULT;
453 if (id->ext.enhopts & SFP_ENHOPTS_SOFT_RX_LOS &&
454 !sfp->gpio[GPIO_LOS])
455 sfp->state_soft_mask |= SFP_F_LOS;
457 if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) &&
459 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
462 static void sfp_soft_stop_poll(struct sfp *sfp)
464 sfp->state_soft_mask = 0;
467 static unsigned int sfp_get_state(struct sfp *sfp)
469 unsigned int state = sfp->get_state(sfp);
471 if (state & SFP_F_PRESENT &&
472 sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT))
473 state |= sfp_soft_get_state(sfp);
478 static void sfp_set_state(struct sfp *sfp, unsigned int state)
480 sfp->set_state(sfp, state);
482 if (state & SFP_F_PRESENT &&
483 sfp->state_soft_mask & SFP_F_TX_DISABLE)
484 sfp_soft_set_state(sfp, state);
487 static unsigned int sfp_check(void *buf, size_t len)
491 for (p = buf, check = 0; len; p++, len--)
498 #if IS_ENABLED(CONFIG_HWMON)
499 static umode_t sfp_hwmon_is_visible(const void *data,
500 enum hwmon_sensor_types type,
501 u32 attr, int channel)
503 const struct sfp *sfp = data;
508 case hwmon_temp_min_alarm:
509 case hwmon_temp_max_alarm:
510 case hwmon_temp_lcrit_alarm:
511 case hwmon_temp_crit_alarm:
514 case hwmon_temp_lcrit:
515 case hwmon_temp_crit:
516 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
519 case hwmon_temp_input:
520 case hwmon_temp_label:
527 case hwmon_in_min_alarm:
528 case hwmon_in_max_alarm:
529 case hwmon_in_lcrit_alarm:
530 case hwmon_in_crit_alarm:
535 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
546 case hwmon_curr_min_alarm:
547 case hwmon_curr_max_alarm:
548 case hwmon_curr_lcrit_alarm:
549 case hwmon_curr_crit_alarm:
552 case hwmon_curr_lcrit:
553 case hwmon_curr_crit:
554 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
557 case hwmon_curr_input:
558 case hwmon_curr_label:
564 /* External calibration of receive power requires
565 * floating point arithmetic. Doing that in the kernel
566 * is not easy, so just skip it. If the module does
567 * not require external calibration, we can however
568 * show receiver power, since FP is then not needed.
570 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL &&
574 case hwmon_power_min_alarm:
575 case hwmon_power_max_alarm:
576 case hwmon_power_lcrit_alarm:
577 case hwmon_power_crit_alarm:
578 case hwmon_power_min:
579 case hwmon_power_max:
580 case hwmon_power_lcrit:
581 case hwmon_power_crit:
582 if (!(sfp->id.ext.enhopts & SFP_ENHOPTS_ALARMWARN))
585 case hwmon_power_input:
586 case hwmon_power_label:
596 static int sfp_hwmon_read_sensor(struct sfp *sfp, int reg, long *value)
601 err = sfp_read(sfp, true, reg, &val, sizeof(val));
605 *value = be16_to_cpu(val);
610 static void sfp_hwmon_to_rx_power(long *value)
612 *value = DIV_ROUND_CLOSEST(*value, 10);
615 static void sfp_hwmon_calibrate(struct sfp *sfp, unsigned int slope, int offset,
618 if (sfp->id.ext.diagmon & SFP_DIAGMON_EXT_CAL)
619 *value = DIV_ROUND_CLOSEST(*value * slope, 256) + offset;
622 static void sfp_hwmon_calibrate_temp(struct sfp *sfp, long *value)
624 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_t_slope),
625 be16_to_cpu(sfp->diag.cal_t_offset), value);
627 if (*value >= 0x8000)
630 *value = DIV_ROUND_CLOSEST(*value * 1000, 256);
633 static void sfp_hwmon_calibrate_vcc(struct sfp *sfp, long *value)
635 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_v_slope),
636 be16_to_cpu(sfp->diag.cal_v_offset), value);
638 *value = DIV_ROUND_CLOSEST(*value, 10);
641 static void sfp_hwmon_calibrate_bias(struct sfp *sfp, long *value)
643 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txi_slope),
644 be16_to_cpu(sfp->diag.cal_txi_offset), value);
646 *value = DIV_ROUND_CLOSEST(*value, 500);
649 static void sfp_hwmon_calibrate_tx_power(struct sfp *sfp, long *value)
651 sfp_hwmon_calibrate(sfp, be16_to_cpu(sfp->diag.cal_txpwr_slope),
652 be16_to_cpu(sfp->diag.cal_txpwr_offset), value);
654 *value = DIV_ROUND_CLOSEST(*value, 10);
657 static int sfp_hwmon_read_temp(struct sfp *sfp, int reg, long *value)
661 err = sfp_hwmon_read_sensor(sfp, reg, value);
665 sfp_hwmon_calibrate_temp(sfp, value);
670 static int sfp_hwmon_read_vcc(struct sfp *sfp, int reg, long *value)
674 err = sfp_hwmon_read_sensor(sfp, reg, value);
678 sfp_hwmon_calibrate_vcc(sfp, value);
683 static int sfp_hwmon_read_bias(struct sfp *sfp, int reg, long *value)
687 err = sfp_hwmon_read_sensor(sfp, reg, value);
691 sfp_hwmon_calibrate_bias(sfp, value);
696 static int sfp_hwmon_read_tx_power(struct sfp *sfp, int reg, long *value)
700 err = sfp_hwmon_read_sensor(sfp, reg, value);
704 sfp_hwmon_calibrate_tx_power(sfp, value);
709 static int sfp_hwmon_read_rx_power(struct sfp *sfp, int reg, long *value)
713 err = sfp_hwmon_read_sensor(sfp, reg, value);
717 sfp_hwmon_to_rx_power(value);
722 static int sfp_hwmon_temp(struct sfp *sfp, u32 attr, long *value)
728 case hwmon_temp_input:
729 return sfp_hwmon_read_temp(sfp, SFP_TEMP, value);
731 case hwmon_temp_lcrit:
732 *value = be16_to_cpu(sfp->diag.temp_low_alarm);
733 sfp_hwmon_calibrate_temp(sfp, value);
737 *value = be16_to_cpu(sfp->diag.temp_low_warn);
738 sfp_hwmon_calibrate_temp(sfp, value);
741 *value = be16_to_cpu(sfp->diag.temp_high_warn);
742 sfp_hwmon_calibrate_temp(sfp, value);
745 case hwmon_temp_crit:
746 *value = be16_to_cpu(sfp->diag.temp_high_alarm);
747 sfp_hwmon_calibrate_temp(sfp, value);
750 case hwmon_temp_lcrit_alarm:
751 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
755 *value = !!(status & SFP_ALARM0_TEMP_LOW);
758 case hwmon_temp_min_alarm:
759 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
763 *value = !!(status & SFP_WARN0_TEMP_LOW);
766 case hwmon_temp_max_alarm:
767 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
771 *value = !!(status & SFP_WARN0_TEMP_HIGH);
774 case hwmon_temp_crit_alarm:
775 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
779 *value = !!(status & SFP_ALARM0_TEMP_HIGH);
788 static int sfp_hwmon_vcc(struct sfp *sfp, u32 attr, long *value)
795 return sfp_hwmon_read_vcc(sfp, SFP_VCC, value);
798 *value = be16_to_cpu(sfp->diag.volt_low_alarm);
799 sfp_hwmon_calibrate_vcc(sfp, value);
803 *value = be16_to_cpu(sfp->diag.volt_low_warn);
804 sfp_hwmon_calibrate_vcc(sfp, value);
808 *value = be16_to_cpu(sfp->diag.volt_high_warn);
809 sfp_hwmon_calibrate_vcc(sfp, value);
813 *value = be16_to_cpu(sfp->diag.volt_high_alarm);
814 sfp_hwmon_calibrate_vcc(sfp, value);
817 case hwmon_in_lcrit_alarm:
818 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
822 *value = !!(status & SFP_ALARM0_VCC_LOW);
825 case hwmon_in_min_alarm:
826 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
830 *value = !!(status & SFP_WARN0_VCC_LOW);
833 case hwmon_in_max_alarm:
834 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
838 *value = !!(status & SFP_WARN0_VCC_HIGH);
841 case hwmon_in_crit_alarm:
842 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
846 *value = !!(status & SFP_ALARM0_VCC_HIGH);
855 static int sfp_hwmon_bias(struct sfp *sfp, u32 attr, long *value)
861 case hwmon_curr_input:
862 return sfp_hwmon_read_bias(sfp, SFP_TX_BIAS, value);
864 case hwmon_curr_lcrit:
865 *value = be16_to_cpu(sfp->diag.bias_low_alarm);
866 sfp_hwmon_calibrate_bias(sfp, value);
870 *value = be16_to_cpu(sfp->diag.bias_low_warn);
871 sfp_hwmon_calibrate_bias(sfp, value);
875 *value = be16_to_cpu(sfp->diag.bias_high_warn);
876 sfp_hwmon_calibrate_bias(sfp, value);
879 case hwmon_curr_crit:
880 *value = be16_to_cpu(sfp->diag.bias_high_alarm);
881 sfp_hwmon_calibrate_bias(sfp, value);
884 case hwmon_curr_lcrit_alarm:
885 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
889 *value = !!(status & SFP_ALARM0_TX_BIAS_LOW);
892 case hwmon_curr_min_alarm:
893 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
897 *value = !!(status & SFP_WARN0_TX_BIAS_LOW);
900 case hwmon_curr_max_alarm:
901 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
905 *value = !!(status & SFP_WARN0_TX_BIAS_HIGH);
908 case hwmon_curr_crit_alarm:
909 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
913 *value = !!(status & SFP_ALARM0_TX_BIAS_HIGH);
922 static int sfp_hwmon_tx_power(struct sfp *sfp, u32 attr, long *value)
928 case hwmon_power_input:
929 return sfp_hwmon_read_tx_power(sfp, SFP_TX_POWER, value);
931 case hwmon_power_lcrit:
932 *value = be16_to_cpu(sfp->diag.txpwr_low_alarm);
933 sfp_hwmon_calibrate_tx_power(sfp, value);
936 case hwmon_power_min:
937 *value = be16_to_cpu(sfp->diag.txpwr_low_warn);
938 sfp_hwmon_calibrate_tx_power(sfp, value);
941 case hwmon_power_max:
942 *value = be16_to_cpu(sfp->diag.txpwr_high_warn);
943 sfp_hwmon_calibrate_tx_power(sfp, value);
946 case hwmon_power_crit:
947 *value = be16_to_cpu(sfp->diag.txpwr_high_alarm);
948 sfp_hwmon_calibrate_tx_power(sfp, value);
951 case hwmon_power_lcrit_alarm:
952 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
956 *value = !!(status & SFP_ALARM0_TXPWR_LOW);
959 case hwmon_power_min_alarm:
960 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
964 *value = !!(status & SFP_WARN0_TXPWR_LOW);
967 case hwmon_power_max_alarm:
968 err = sfp_read(sfp, true, SFP_WARN0, &status, sizeof(status));
972 *value = !!(status & SFP_WARN0_TXPWR_HIGH);
975 case hwmon_power_crit_alarm:
976 err = sfp_read(sfp, true, SFP_ALARM0, &status, sizeof(status));
980 *value = !!(status & SFP_ALARM0_TXPWR_HIGH);
989 static int sfp_hwmon_rx_power(struct sfp *sfp, u32 attr, long *value)
995 case hwmon_power_input:
996 return sfp_hwmon_read_rx_power(sfp, SFP_RX_POWER, value);
998 case hwmon_power_lcrit:
999 *value = be16_to_cpu(sfp->diag.rxpwr_low_alarm);
1000 sfp_hwmon_to_rx_power(value);
1003 case hwmon_power_min:
1004 *value = be16_to_cpu(sfp->diag.rxpwr_low_warn);
1005 sfp_hwmon_to_rx_power(value);
1008 case hwmon_power_max:
1009 *value = be16_to_cpu(sfp->diag.rxpwr_high_warn);
1010 sfp_hwmon_to_rx_power(value);
1013 case hwmon_power_crit:
1014 *value = be16_to_cpu(sfp->diag.rxpwr_high_alarm);
1015 sfp_hwmon_to_rx_power(value);
1018 case hwmon_power_lcrit_alarm:
1019 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1023 *value = !!(status & SFP_ALARM1_RXPWR_LOW);
1026 case hwmon_power_min_alarm:
1027 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1031 *value = !!(status & SFP_WARN1_RXPWR_LOW);
1034 case hwmon_power_max_alarm:
1035 err = sfp_read(sfp, true, SFP_WARN1, &status, sizeof(status));
1039 *value = !!(status & SFP_WARN1_RXPWR_HIGH);
1042 case hwmon_power_crit_alarm:
1043 err = sfp_read(sfp, true, SFP_ALARM1, &status, sizeof(status));
1047 *value = !!(status & SFP_ALARM1_RXPWR_HIGH);
1056 static int sfp_hwmon_read(struct device *dev, enum hwmon_sensor_types type,
1057 u32 attr, int channel, long *value)
1059 struct sfp *sfp = dev_get_drvdata(dev);
1063 return sfp_hwmon_temp(sfp, attr, value);
1065 return sfp_hwmon_vcc(sfp, attr, value);
1067 return sfp_hwmon_bias(sfp, attr, value);
1071 return sfp_hwmon_tx_power(sfp, attr, value);
1073 return sfp_hwmon_rx_power(sfp, attr, value);
1082 static const char *const sfp_hwmon_power_labels[] = {
1087 static int sfp_hwmon_read_string(struct device *dev,
1088 enum hwmon_sensor_types type,
1089 u32 attr, int channel, const char **str)
1094 case hwmon_curr_label:
1103 case hwmon_temp_label:
1104 *str = "temperature";
1112 case hwmon_in_label:
1121 case hwmon_power_label:
1122 *str = sfp_hwmon_power_labels[channel];
1135 static const struct hwmon_ops sfp_hwmon_ops = {
1136 .is_visible = sfp_hwmon_is_visible,
1137 .read = sfp_hwmon_read,
1138 .read_string = sfp_hwmon_read_string,
1141 static u32 sfp_hwmon_chip_config[] = {
1142 HWMON_C_REGISTER_TZ,
1146 static const struct hwmon_channel_info sfp_hwmon_chip = {
1148 .config = sfp_hwmon_chip_config,
1151 static u32 sfp_hwmon_temp_config[] = {
1153 HWMON_T_MAX | HWMON_T_MIN |
1154 HWMON_T_MAX_ALARM | HWMON_T_MIN_ALARM |
1155 HWMON_T_CRIT | HWMON_T_LCRIT |
1156 HWMON_T_CRIT_ALARM | HWMON_T_LCRIT_ALARM |
1161 static const struct hwmon_channel_info sfp_hwmon_temp_channel_info = {
1163 .config = sfp_hwmon_temp_config,
1166 static u32 sfp_hwmon_vcc_config[] = {
1168 HWMON_I_MAX | HWMON_I_MIN |
1169 HWMON_I_MAX_ALARM | HWMON_I_MIN_ALARM |
1170 HWMON_I_CRIT | HWMON_I_LCRIT |
1171 HWMON_I_CRIT_ALARM | HWMON_I_LCRIT_ALARM |
1176 static const struct hwmon_channel_info sfp_hwmon_vcc_channel_info = {
1178 .config = sfp_hwmon_vcc_config,
1181 static u32 sfp_hwmon_bias_config[] = {
1183 HWMON_C_MAX | HWMON_C_MIN |
1184 HWMON_C_MAX_ALARM | HWMON_C_MIN_ALARM |
1185 HWMON_C_CRIT | HWMON_C_LCRIT |
1186 HWMON_C_CRIT_ALARM | HWMON_C_LCRIT_ALARM |
1191 static const struct hwmon_channel_info sfp_hwmon_bias_channel_info = {
1193 .config = sfp_hwmon_bias_config,
1196 static u32 sfp_hwmon_power_config[] = {
1197 /* Transmit power */
1199 HWMON_P_MAX | HWMON_P_MIN |
1200 HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1201 HWMON_P_CRIT | HWMON_P_LCRIT |
1202 HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1206 HWMON_P_MAX | HWMON_P_MIN |
1207 HWMON_P_MAX_ALARM | HWMON_P_MIN_ALARM |
1208 HWMON_P_CRIT | HWMON_P_LCRIT |
1209 HWMON_P_CRIT_ALARM | HWMON_P_LCRIT_ALARM |
1214 static const struct hwmon_channel_info sfp_hwmon_power_channel_info = {
1215 .type = hwmon_power,
1216 .config = sfp_hwmon_power_config,
1219 static const struct hwmon_channel_info *sfp_hwmon_info[] = {
1221 &sfp_hwmon_vcc_channel_info,
1222 &sfp_hwmon_temp_channel_info,
1223 &sfp_hwmon_bias_channel_info,
1224 &sfp_hwmon_power_channel_info,
1228 static const struct hwmon_chip_info sfp_hwmon_chip_info = {
1229 .ops = &sfp_hwmon_ops,
1230 .info = sfp_hwmon_info,
1233 static void sfp_hwmon_probe(struct work_struct *work)
1235 struct sfp *sfp = container_of(work, struct sfp, hwmon_probe.work);
1238 err = sfp_read(sfp, true, 0, &sfp->diag, sizeof(sfp->diag));
1240 if (sfp->hwmon_tries--) {
1241 mod_delayed_work(system_wq, &sfp->hwmon_probe,
1242 T_PROBE_RETRY_SLOW);
1244 dev_warn(sfp->dev, "hwmon probe failed: %d\n", err);
1249 sfp->hwmon_name = kstrdup(dev_name(sfp->dev), GFP_KERNEL);
1250 if (!sfp->hwmon_name) {
1251 dev_err(sfp->dev, "out of memory for hwmon name\n");
1255 for (i = 0; sfp->hwmon_name[i]; i++)
1256 if (hwmon_is_bad_char(sfp->hwmon_name[i]))
1257 sfp->hwmon_name[i] = '_';
1259 sfp->hwmon_dev = hwmon_device_register_with_info(sfp->dev,
1260 sfp->hwmon_name, sfp,
1261 &sfp_hwmon_chip_info,
1263 if (IS_ERR(sfp->hwmon_dev))
1264 dev_err(sfp->dev, "failed to register hwmon device: %ld\n",
1265 PTR_ERR(sfp->hwmon_dev));
1268 static int sfp_hwmon_insert(struct sfp *sfp)
1270 if (sfp->id.ext.sff8472_compliance == SFP_SFF8472_COMPLIANCE_NONE)
1273 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_DDM))
1276 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1277 /* This driver in general does not support address
1282 mod_delayed_work(system_wq, &sfp->hwmon_probe, 1);
1283 sfp->hwmon_tries = R_PROBE_RETRY_SLOW;
1288 static void sfp_hwmon_remove(struct sfp *sfp)
1290 cancel_delayed_work_sync(&sfp->hwmon_probe);
1291 if (!IS_ERR_OR_NULL(sfp->hwmon_dev)) {
1292 hwmon_device_unregister(sfp->hwmon_dev);
1293 sfp->hwmon_dev = NULL;
1294 kfree(sfp->hwmon_name);
1298 static int sfp_hwmon_init(struct sfp *sfp)
1300 INIT_DELAYED_WORK(&sfp->hwmon_probe, sfp_hwmon_probe);
1305 static void sfp_hwmon_exit(struct sfp *sfp)
1307 cancel_delayed_work_sync(&sfp->hwmon_probe);
1310 static int sfp_hwmon_insert(struct sfp *sfp)
1315 static void sfp_hwmon_remove(struct sfp *sfp)
1319 static int sfp_hwmon_init(struct sfp *sfp)
1324 static void sfp_hwmon_exit(struct sfp *sfp)
1330 static void sfp_module_tx_disable(struct sfp *sfp)
1332 dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1333 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 1);
1334 sfp->state |= SFP_F_TX_DISABLE;
1335 sfp_set_state(sfp, sfp->state);
1338 static void sfp_module_tx_enable(struct sfp *sfp)
1340 dev_dbg(sfp->dev, "tx disable %u -> %u\n",
1341 sfp->state & SFP_F_TX_DISABLE ? 1 : 0, 0);
1342 sfp->state &= ~SFP_F_TX_DISABLE;
1343 sfp_set_state(sfp, sfp->state);
1346 static void sfp_module_tx_fault_reset(struct sfp *sfp)
1348 unsigned int state = sfp->state;
1350 if (state & SFP_F_TX_DISABLE)
1353 sfp_set_state(sfp, state | SFP_F_TX_DISABLE);
1357 sfp_set_state(sfp, state);
1360 /* SFP state machine */
1361 static void sfp_sm_set_timer(struct sfp *sfp, unsigned int timeout)
1364 mod_delayed_work(system_power_efficient_wq, &sfp->timeout,
1367 cancel_delayed_work(&sfp->timeout);
1370 static void sfp_sm_next(struct sfp *sfp, unsigned int state,
1371 unsigned int timeout)
1373 sfp->sm_state = state;
1374 sfp_sm_set_timer(sfp, timeout);
1377 static void sfp_sm_mod_next(struct sfp *sfp, unsigned int state,
1378 unsigned int timeout)
1380 sfp->sm_mod_state = state;
1381 sfp_sm_set_timer(sfp, timeout);
1384 static void sfp_sm_phy_detach(struct sfp *sfp)
1386 phy_stop(sfp->mod_phy);
1387 sfp_remove_phy(sfp->sfp_bus);
1388 phy_device_remove(sfp->mod_phy);
1389 phy_device_free(sfp->mod_phy);
1390 sfp->mod_phy = NULL;
1393 static void sfp_sm_probe_phy(struct sfp *sfp)
1395 struct phy_device *phy;
1398 phy = mdiobus_scan(sfp->i2c_mii, SFP_PHY_ADDR);
1399 if (phy == ERR_PTR(-ENODEV)) {
1400 dev_info(sfp->dev, "no PHY detected\n");
1404 dev_err(sfp->dev, "mdiobus scan returned %ld\n", PTR_ERR(phy));
1408 err = sfp_add_phy(sfp->sfp_bus, phy);
1410 phy_device_remove(phy);
1411 phy_device_free(phy);
1412 dev_err(sfp->dev, "sfp_add_phy failed: %d\n", err);
1420 static void sfp_sm_link_up(struct sfp *sfp)
1422 sfp_link_up(sfp->sfp_bus);
1423 sfp_sm_next(sfp, SFP_S_LINK_UP, 0);
1426 static void sfp_sm_link_down(struct sfp *sfp)
1428 sfp_link_down(sfp->sfp_bus);
1431 static void sfp_sm_link_check_los(struct sfp *sfp)
1433 unsigned int los = sfp->state & SFP_F_LOS;
1435 /* If neither SFP_OPTIONS_LOS_INVERTED nor SFP_OPTIONS_LOS_NORMAL
1436 * are set, we assume that no LOS signal is available.
1438 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_INVERTED))
1440 else if (!(sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_NORMAL)))
1444 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
1446 sfp_sm_link_up(sfp);
1449 static bool sfp_los_event_active(struct sfp *sfp, unsigned int event)
1451 return (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_INVERTED) &&
1452 event == SFP_E_LOS_LOW) ||
1453 (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_NORMAL) &&
1454 event == SFP_E_LOS_HIGH);
1457 static bool sfp_los_event_inactive(struct sfp *sfp, unsigned int event)
1459 return (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_INVERTED) &&
1460 event == SFP_E_LOS_HIGH) ||
1461 (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_LOS_NORMAL) &&
1462 event == SFP_E_LOS_LOW);
1465 static void sfp_sm_fault(struct sfp *sfp, unsigned int next_state, bool warn)
1467 if (sfp->sm_retries && !--sfp->sm_retries) {
1469 "module persistently indicates fault, disabling\n");
1470 sfp_sm_next(sfp, SFP_S_TX_DISABLE, 0);
1473 dev_err(sfp->dev, "module transmit fault indicated\n");
1475 sfp_sm_next(sfp, next_state, T_FAULT_RECOVER);
1479 static void sfp_sm_probe_for_phy(struct sfp *sfp)
1481 /* Setting the serdes link mode is guesswork: there's no
1482 * field in the EEPROM which indicates what mode should
1485 * If it's a gigabit-only fiber module, it probably does
1486 * not have a PHY, so switch to 802.3z negotiation mode.
1487 * Otherwise, switch to SGMII mode (which is required to
1488 * support non-gigabit speeds) and probe for a PHY.
1490 if (sfp->id.base.e1000_base_t ||
1491 sfp->id.base.e100_base_lx ||
1492 sfp->id.base.e100_base_fx)
1493 sfp_sm_probe_phy(sfp);
1496 static int sfp_module_parse_power(struct sfp *sfp)
1498 u32 power_mW = 1000;
1500 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_POWER_DECL))
1502 if (sfp->id.ext.options & cpu_to_be16(SFP_OPTIONS_HIGH_POWER_LEVEL))
1505 if (power_mW > sfp->max_power_mW) {
1506 /* Module power specification exceeds the allowed maximum. */
1507 if (sfp->id.ext.sff8472_compliance ==
1508 SFP_SFF8472_COMPLIANCE_NONE &&
1509 !(sfp->id.ext.diagmon & SFP_DIAGMON_DDM)) {
1510 /* The module appears not to implement bus address
1511 * 0xa2, so assume that the module powers up in the
1515 "Host does not support %u.%uW modules\n",
1516 power_mW / 1000, (power_mW / 100) % 10);
1520 "Host does not support %u.%uW modules, module left in power mode 1\n",
1521 power_mW / 1000, (power_mW / 100) % 10);
1526 /* If the module requires a higher power mode, but also requires
1527 * an address change sequence, warn the user that the module may
1528 * not be functional.
1530 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE && power_mW > 1000) {
1532 "Address Change Sequence not supported but module requires %u.%uW, module may not be functional\n",
1533 power_mW / 1000, (power_mW / 100) % 10);
1537 sfp->module_power_mW = power_mW;
1542 static int sfp_sm_mod_hpower(struct sfp *sfp, bool enable)
1547 err = sfp_read(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1548 if (err != sizeof(val)) {
1549 dev_err(sfp->dev, "Failed to read EEPROM: %d\n", err);
1558 err = sfp_write(sfp, true, SFP_EXT_STATUS, &val, sizeof(val));
1559 if (err != sizeof(val)) {
1560 dev_err(sfp->dev, "Failed to write EEPROM: %d\n", err);
1565 dev_info(sfp->dev, "Module switched to %u.%uW power level\n",
1566 sfp->module_power_mW / 1000,
1567 (sfp->module_power_mW / 100) % 10);
1572 static int sfp_sm_mod_probe(struct sfp *sfp, bool report)
1574 /* SFP module inserted - read I2C data */
1575 struct sfp_eeprom_id id;
1580 ret = sfp_read(sfp, false, 0, &id, sizeof(id));
1583 dev_err(sfp->dev, "failed to read EEPROM: %d\n", ret);
1587 if (ret != sizeof(id)) {
1588 dev_err(sfp->dev, "EEPROM short read: %d\n", ret);
1592 /* Cotsworks do not seem to update the checksums when they
1593 * do the final programming with the final module part number,
1594 * serial number and date code.
1596 cotsworks = !memcmp(id.base.vendor_name, "COTSWORKS ", 16);
1598 /* Validate the checksum over the base structure */
1599 check = sfp_check(&id.base, sizeof(id.base) - 1);
1600 if (check != id.base.cc_base) {
1603 "EEPROM base structure checksum failure (0x%02x != 0x%02x)\n",
1604 check, id.base.cc_base);
1607 "EEPROM base structure checksum failure: 0x%02x != 0x%02x\n",
1608 check, id.base.cc_base);
1609 print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
1610 16, 1, &id, sizeof(id), true);
1615 check = sfp_check(&id.ext, sizeof(id.ext) - 1);
1616 if (check != id.ext.cc_ext) {
1619 "EEPROM extended structure checksum failure (0x%02x != 0x%02x)\n",
1620 check, id.ext.cc_ext);
1623 "EEPROM extended structure checksum failure: 0x%02x != 0x%02x\n",
1624 check, id.ext.cc_ext);
1625 print_hex_dump(KERN_ERR, "sfp EE: ", DUMP_PREFIX_OFFSET,
1626 16, 1, &id, sizeof(id), true);
1627 memset(&id.ext, 0, sizeof(id.ext));
1633 dev_info(sfp->dev, "module %.*s %.*s rev %.*s sn %.*s dc %.*s\n",
1634 (int)sizeof(id.base.vendor_name), id.base.vendor_name,
1635 (int)sizeof(id.base.vendor_pn), id.base.vendor_pn,
1636 (int)sizeof(id.base.vendor_rev), id.base.vendor_rev,
1637 (int)sizeof(id.ext.vendor_sn), id.ext.vendor_sn,
1638 (int)sizeof(id.ext.datecode), id.ext.datecode);
1640 /* Check whether we support this module */
1641 if (!sfp->type->module_supported(&id)) {
1643 "module is not supported - phys id 0x%02x 0x%02x\n",
1644 sfp->id.base.phys_id, sfp->id.base.phys_ext_id);
1648 /* If the module requires address swap mode, warn about it */
1649 if (sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)
1651 "module address swap to access page 0xA2 is not supported.\n");
1653 /* Parse the module power requirement */
1654 ret = sfp_module_parse_power(sfp);
1661 static void sfp_sm_mod_remove(struct sfp *sfp)
1663 if (sfp->sm_mod_state > SFP_MOD_WAITDEV)
1664 sfp_module_remove(sfp->sfp_bus);
1666 sfp_hwmon_remove(sfp);
1668 memset(&sfp->id, 0, sizeof(sfp->id));
1669 sfp->module_power_mW = 0;
1671 dev_info(sfp->dev, "module removed\n");
1674 /* This state machine tracks the upstream's state */
1675 static void sfp_sm_device(struct sfp *sfp, unsigned int event)
1677 switch (sfp->sm_dev_state) {
1679 if (event == SFP_E_DEV_ATTACH)
1680 sfp->sm_dev_state = SFP_DEV_DOWN;
1684 if (event == SFP_E_DEV_DETACH)
1685 sfp->sm_dev_state = SFP_DEV_DETACHED;
1686 else if (event == SFP_E_DEV_UP)
1687 sfp->sm_dev_state = SFP_DEV_UP;
1691 if (event == SFP_E_DEV_DETACH)
1692 sfp->sm_dev_state = SFP_DEV_DETACHED;
1693 else if (event == SFP_E_DEV_DOWN)
1694 sfp->sm_dev_state = SFP_DEV_DOWN;
1699 /* This state machine tracks the insert/remove state of the module, probes
1700 * the on-board EEPROM, and sets up the power level.
1702 static void sfp_sm_module(struct sfp *sfp, unsigned int event)
1706 /* Handle remove event globally, it resets this state machine */
1707 if (event == SFP_E_REMOVE) {
1708 if (sfp->sm_mod_state > SFP_MOD_PROBE)
1709 sfp_sm_mod_remove(sfp);
1710 sfp_sm_mod_next(sfp, SFP_MOD_EMPTY, 0);
1714 /* Handle device detach globally */
1715 if (sfp->sm_dev_state < SFP_DEV_DOWN &&
1716 sfp->sm_mod_state > SFP_MOD_WAITDEV) {
1717 if (sfp->module_power_mW > 1000 &&
1718 sfp->sm_mod_state > SFP_MOD_HPOWER)
1719 sfp_sm_mod_hpower(sfp, false);
1720 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
1724 switch (sfp->sm_mod_state) {
1726 if (event == SFP_E_INSERT) {
1727 sfp_sm_mod_next(sfp, SFP_MOD_PROBE, T_SERIAL);
1728 sfp->sm_mod_tries_init = R_PROBE_RETRY_INIT;
1729 sfp->sm_mod_tries = R_PROBE_RETRY_SLOW;
1734 /* Wait for T_PROBE_INIT to time out */
1735 if (event != SFP_E_TIMEOUT)
1738 err = sfp_sm_mod_probe(sfp, sfp->sm_mod_tries == 1);
1739 if (err == -EAGAIN) {
1740 if (sfp->sm_mod_tries_init &&
1741 --sfp->sm_mod_tries_init) {
1742 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
1744 } else if (sfp->sm_mod_tries && --sfp->sm_mod_tries) {
1745 if (sfp->sm_mod_tries == R_PROBE_RETRY_SLOW - 1)
1747 "please wait, module slow to respond\n");
1748 sfp_sm_set_timer(sfp, T_PROBE_RETRY_SLOW);
1753 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
1757 sfp_sm_mod_next(sfp, SFP_MOD_WAITDEV, 0);
1759 case SFP_MOD_WAITDEV:
1760 /* Ensure that the device is attached before proceeding */
1761 if (sfp->sm_dev_state < SFP_DEV_DOWN)
1764 /* Report the module insertion to the upstream device */
1765 err = sfp_module_insert(sfp->sfp_bus, &sfp->id);
1767 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
1771 /* If this is a power level 1 module, we are done */
1772 if (sfp->module_power_mW <= 1000)
1775 sfp_sm_mod_next(sfp, SFP_MOD_HPOWER, 0);
1777 case SFP_MOD_HPOWER:
1778 /* Enable high power mode */
1779 err = sfp_sm_mod_hpower(sfp, true);
1781 if (err != -EAGAIN) {
1782 sfp_module_remove(sfp->sfp_bus);
1783 sfp_sm_mod_next(sfp, SFP_MOD_ERROR, 0);
1785 sfp_sm_set_timer(sfp, T_PROBE_RETRY_INIT);
1790 sfp_sm_mod_next(sfp, SFP_MOD_WAITPWR, T_HPOWER_LEVEL);
1793 case SFP_MOD_WAITPWR:
1794 /* Wait for T_HPOWER_LEVEL to time out */
1795 if (event != SFP_E_TIMEOUT)
1799 sfp_sm_mod_next(sfp, SFP_MOD_PRESENT, 0);
1802 case SFP_MOD_PRESENT:
1807 #if IS_ENABLED(CONFIG_HWMON)
1808 if (sfp->sm_mod_state >= SFP_MOD_WAITDEV &&
1809 IS_ERR_OR_NULL(sfp->hwmon_dev)) {
1810 err = sfp_hwmon_insert(sfp);
1812 dev_warn(sfp->dev, "hwmon probe failed: %d\n", err);
1817 static void sfp_sm_main(struct sfp *sfp, unsigned int event)
1819 unsigned long timeout;
1821 /* Some events are global */
1822 if (sfp->sm_state != SFP_S_DOWN &&
1823 (sfp->sm_mod_state != SFP_MOD_PRESENT ||
1824 sfp->sm_dev_state != SFP_DEV_UP)) {
1825 if (sfp->sm_state == SFP_S_LINK_UP &&
1826 sfp->sm_dev_state == SFP_DEV_UP)
1827 sfp_sm_link_down(sfp);
1829 sfp_sm_phy_detach(sfp);
1830 sfp_module_tx_disable(sfp);
1831 sfp_soft_stop_poll(sfp);
1832 sfp_sm_next(sfp, SFP_S_DOWN, 0);
1836 /* The main state machine */
1837 switch (sfp->sm_state) {
1839 if (sfp->sm_mod_state != SFP_MOD_PRESENT ||
1840 sfp->sm_dev_state != SFP_DEV_UP)
1843 if (!(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE))
1844 sfp_soft_start_poll(sfp);
1846 sfp_module_tx_enable(sfp);
1848 /* Initialise the fault clearance retries */
1849 sfp->sm_retries = 5;
1851 /* We need to check the TX_FAULT state, which is not defined
1852 * while TX_DISABLE is asserted. The earliest we want to do
1853 * anything (such as probe for a PHY) is 50ms.
1855 sfp_sm_next(sfp, SFP_S_WAIT, T_WAIT);
1859 if (event != SFP_E_TIMEOUT)
1862 if (sfp->state & SFP_F_TX_FAULT) {
1863 /* Wait t_init before indicating that the link is up,
1864 * provided the current state indicates no TX_FAULT. If
1865 * TX_FAULT clears before this time, that's fine too.
1867 timeout = T_INIT_JIFFIES;
1868 if (timeout > T_WAIT)
1873 sfp_sm_next(sfp, SFP_S_INIT, timeout);
1875 /* TX_FAULT is not asserted, assume the module has
1876 * finished initialising.
1883 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
1884 /* TX_FAULT is still asserted after t_init, so assume
1887 sfp_sm_fault(sfp, SFP_S_INIT_TX_FAULT,
1888 sfp->sm_retries == 5);
1889 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
1890 init_done: /* TX_FAULT deasserted or we timed out with TX_FAULT
1891 * clear. Probe for the PHY and check the LOS state.
1893 sfp_sm_probe_for_phy(sfp);
1894 sfp_sm_link_check_los(sfp);
1896 /* Reset the fault retry count */
1897 sfp->sm_retries = 5;
1901 case SFP_S_INIT_TX_FAULT:
1902 if (event == SFP_E_TIMEOUT) {
1903 sfp_module_tx_fault_reset(sfp);
1904 sfp_sm_next(sfp, SFP_S_INIT, T_INIT_JIFFIES);
1908 case SFP_S_WAIT_LOS:
1909 if (event == SFP_E_TX_FAULT)
1910 sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
1911 else if (sfp_los_event_inactive(sfp, event))
1912 sfp_sm_link_up(sfp);
1916 if (event == SFP_E_TX_FAULT) {
1917 sfp_sm_link_down(sfp);
1918 sfp_sm_fault(sfp, SFP_S_TX_FAULT, true);
1919 } else if (sfp_los_event_active(sfp, event)) {
1920 sfp_sm_link_down(sfp);
1921 sfp_sm_next(sfp, SFP_S_WAIT_LOS, 0);
1925 case SFP_S_TX_FAULT:
1926 if (event == SFP_E_TIMEOUT) {
1927 sfp_module_tx_fault_reset(sfp);
1928 sfp_sm_next(sfp, SFP_S_REINIT, T_INIT_JIFFIES);
1933 if (event == SFP_E_TIMEOUT && sfp->state & SFP_F_TX_FAULT) {
1934 sfp_sm_fault(sfp, SFP_S_TX_FAULT, false);
1935 } else if (event == SFP_E_TIMEOUT || event == SFP_E_TX_CLEAR) {
1936 dev_info(sfp->dev, "module transmit fault recovered\n");
1937 sfp_sm_link_check_los(sfp);
1941 case SFP_S_TX_DISABLE:
1946 static void sfp_sm_event(struct sfp *sfp, unsigned int event)
1948 mutex_lock(&sfp->sm_mutex);
1950 dev_dbg(sfp->dev, "SM: enter %s:%s:%s event %s\n",
1951 mod_state_to_str(sfp->sm_mod_state),
1952 dev_state_to_str(sfp->sm_dev_state),
1953 sm_state_to_str(sfp->sm_state),
1954 event_to_str(event));
1956 sfp_sm_device(sfp, event);
1957 sfp_sm_module(sfp, event);
1958 sfp_sm_main(sfp, event);
1960 dev_dbg(sfp->dev, "SM: exit %s:%s:%s\n",
1961 mod_state_to_str(sfp->sm_mod_state),
1962 dev_state_to_str(sfp->sm_dev_state),
1963 sm_state_to_str(sfp->sm_state));
1965 mutex_unlock(&sfp->sm_mutex);
1968 static void sfp_attach(struct sfp *sfp)
1970 sfp_sm_event(sfp, SFP_E_DEV_ATTACH);
1973 static void sfp_detach(struct sfp *sfp)
1975 sfp_sm_event(sfp, SFP_E_DEV_DETACH);
1978 static void sfp_start(struct sfp *sfp)
1980 sfp_sm_event(sfp, SFP_E_DEV_UP);
1983 static void sfp_stop(struct sfp *sfp)
1985 sfp_sm_event(sfp, SFP_E_DEV_DOWN);
1988 static int sfp_module_info(struct sfp *sfp, struct ethtool_modinfo *modinfo)
1990 /* locking... and check module is present */
1992 if (sfp->id.ext.sff8472_compliance &&
1993 !(sfp->id.ext.diagmon & SFP_DIAGMON_ADDRMODE)) {
1994 modinfo->type = ETH_MODULE_SFF_8472;
1995 modinfo->eeprom_len = ETH_MODULE_SFF_8472_LEN;
1997 modinfo->type = ETH_MODULE_SFF_8079;
1998 modinfo->eeprom_len = ETH_MODULE_SFF_8079_LEN;
2003 static int sfp_module_eeprom(struct sfp *sfp, struct ethtool_eeprom *ee,
2006 unsigned int first, last, len;
2013 last = ee->offset + ee->len;
2014 if (first < ETH_MODULE_SFF_8079_LEN) {
2015 len = min_t(unsigned int, last, ETH_MODULE_SFF_8079_LEN);
2018 ret = sfp_read(sfp, false, first, data, len);
2025 if (first < ETH_MODULE_SFF_8472_LEN && last > ETH_MODULE_SFF_8079_LEN) {
2026 len = min_t(unsigned int, last, ETH_MODULE_SFF_8472_LEN);
2028 first -= ETH_MODULE_SFF_8079_LEN;
2030 ret = sfp_read(sfp, true, first, data, len);
2037 static const struct sfp_socket_ops sfp_module_ops = {
2038 .attach = sfp_attach,
2039 .detach = sfp_detach,
2042 .module_info = sfp_module_info,
2043 .module_eeprom = sfp_module_eeprom,
2046 static void sfp_timeout(struct work_struct *work)
2048 struct sfp *sfp = container_of(work, struct sfp, timeout.work);
2051 sfp_sm_event(sfp, SFP_E_TIMEOUT);
2055 static void sfp_check_state(struct sfp *sfp)
2057 unsigned int state, i, changed;
2059 mutex_lock(&sfp->st_mutex);
2060 state = sfp_get_state(sfp);
2061 changed = state ^ sfp->state;
2062 changed &= SFP_F_PRESENT | SFP_F_LOS | SFP_F_TX_FAULT;
2064 for (i = 0; i < GPIO_MAX; i++)
2065 if (changed & BIT(i))
2066 dev_dbg(sfp->dev, "%s %u -> %u\n", gpio_of_names[i],
2067 !!(sfp->state & BIT(i)), !!(state & BIT(i)));
2069 state |= sfp->state & (SFP_F_TX_DISABLE | SFP_F_RATE_SELECT);
2073 if (changed & SFP_F_PRESENT)
2074 sfp_sm_event(sfp, state & SFP_F_PRESENT ?
2075 SFP_E_INSERT : SFP_E_REMOVE);
2077 if (changed & SFP_F_TX_FAULT)
2078 sfp_sm_event(sfp, state & SFP_F_TX_FAULT ?
2079 SFP_E_TX_FAULT : SFP_E_TX_CLEAR);
2081 if (changed & SFP_F_LOS)
2082 sfp_sm_event(sfp, state & SFP_F_LOS ?
2083 SFP_E_LOS_HIGH : SFP_E_LOS_LOW);
2085 mutex_unlock(&sfp->st_mutex);
2088 static irqreturn_t sfp_irq(int irq, void *data)
2090 struct sfp *sfp = data;
2092 sfp_check_state(sfp);
2097 static void sfp_poll(struct work_struct *work)
2099 struct sfp *sfp = container_of(work, struct sfp, poll.work);
2101 sfp_check_state(sfp);
2103 if (sfp->state_soft_mask & (SFP_F_LOS | SFP_F_TX_FAULT) ||
2105 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2108 static struct sfp *sfp_alloc(struct device *dev)
2112 sfp = kzalloc(sizeof(*sfp), GFP_KERNEL);
2114 return ERR_PTR(-ENOMEM);
2118 mutex_init(&sfp->sm_mutex);
2119 mutex_init(&sfp->st_mutex);
2120 INIT_DELAYED_WORK(&sfp->poll, sfp_poll);
2121 INIT_DELAYED_WORK(&sfp->timeout, sfp_timeout);
2123 sfp_hwmon_init(sfp);
2128 static void sfp_cleanup(void *data)
2130 struct sfp *sfp = data;
2132 sfp_hwmon_exit(sfp);
2134 cancel_delayed_work_sync(&sfp->poll);
2135 cancel_delayed_work_sync(&sfp->timeout);
2137 mdiobus_unregister(sfp->i2c_mii);
2138 mdiobus_free(sfp->i2c_mii);
2141 i2c_put_adapter(sfp->i2c);
2145 static int sfp_probe(struct platform_device *pdev)
2147 const struct sff_data *sff;
2148 struct i2c_adapter *i2c;
2152 sfp = sfp_alloc(&pdev->dev);
2154 return PTR_ERR(sfp);
2156 platform_set_drvdata(pdev, sfp);
2158 err = devm_add_action(sfp->dev, sfp_cleanup, sfp);
2162 sff = sfp->type = &sfp_data;
2164 if (pdev->dev.of_node) {
2165 struct device_node *node = pdev->dev.of_node;
2166 const struct of_device_id *id;
2167 struct device_node *np;
2169 id = of_match_node(sfp_of_match, node);
2173 sff = sfp->type = id->data;
2175 np = of_parse_phandle(node, "i2c-bus", 0);
2177 dev_err(sfp->dev, "missing 'i2c-bus' property\n");
2181 i2c = of_find_i2c_adapter_by_node(np);
2183 } else if (has_acpi_companion(&pdev->dev)) {
2184 struct acpi_device *adev = ACPI_COMPANION(&pdev->dev);
2185 struct fwnode_handle *fw = acpi_fwnode_handle(adev);
2186 struct fwnode_reference_args args;
2187 struct acpi_handle *acpi_handle;
2190 ret = acpi_node_get_property_reference(fw, "i2c-bus", 0, &args);
2191 if (ret || !is_acpi_device_node(args.fwnode)) {
2192 dev_err(&pdev->dev, "missing 'i2c-bus' property\n");
2196 acpi_handle = ACPI_HANDLE_FWNODE(args.fwnode);
2197 i2c = i2c_acpi_find_adapter_by_handle(acpi_handle);
2203 return -EPROBE_DEFER;
2205 err = sfp_i2c_configure(sfp, i2c);
2207 i2c_put_adapter(i2c);
2211 for (i = 0; i < GPIO_MAX; i++)
2212 if (sff->gpios & BIT(i)) {
2213 sfp->gpio[i] = devm_gpiod_get_optional(sfp->dev,
2214 gpio_of_names[i], gpio_flags[i]);
2215 if (IS_ERR(sfp->gpio[i]))
2216 return PTR_ERR(sfp->gpio[i]);
2219 sfp->get_state = sfp_gpio_get_state;
2220 sfp->set_state = sfp_gpio_set_state;
2222 /* Modules that have no detect signal are always present */
2223 if (!(sfp->gpio[GPIO_MODDEF0]))
2224 sfp->get_state = sff_gpio_get_state;
2226 device_property_read_u32(&pdev->dev, "maximum-power-milliwatt",
2227 &sfp->max_power_mW);
2228 if (!sfp->max_power_mW)
2229 sfp->max_power_mW = 1000;
2231 dev_info(sfp->dev, "Host maximum power %u.%uW\n",
2232 sfp->max_power_mW / 1000, (sfp->max_power_mW / 100) % 10);
2234 /* Get the initial state, and always signal TX disable,
2235 * since the network interface will not be up.
2237 sfp->state = sfp_get_state(sfp) | SFP_F_TX_DISABLE;
2239 if (sfp->gpio[GPIO_RATE_SELECT] &&
2240 gpiod_get_value_cansleep(sfp->gpio[GPIO_RATE_SELECT]))
2241 sfp->state |= SFP_F_RATE_SELECT;
2242 sfp_set_state(sfp, sfp->state);
2243 sfp_module_tx_disable(sfp);
2244 if (sfp->state & SFP_F_PRESENT) {
2246 sfp_sm_event(sfp, SFP_E_INSERT);
2250 for (i = 0; i < GPIO_MAX; i++) {
2251 if (gpio_flags[i] != GPIOD_IN || !sfp->gpio[i])
2254 sfp->gpio_irq[i] = gpiod_to_irq(sfp->gpio[i]);
2255 if (!sfp->gpio_irq[i]) {
2256 sfp->need_poll = true;
2260 err = devm_request_threaded_irq(sfp->dev, sfp->gpio_irq[i],
2263 IRQF_TRIGGER_RISING |
2264 IRQF_TRIGGER_FALLING,
2265 dev_name(sfp->dev), sfp);
2267 sfp->gpio_irq[i] = 0;
2268 sfp->need_poll = true;
2273 mod_delayed_work(system_wq, &sfp->poll, poll_jiffies);
2275 /* We could have an issue in cases no Tx disable pin is available or
2276 * wired as modules using a laser as their light source will continue to
2277 * be active when the fiber is removed. This could be a safety issue and
2278 * we should at least warn the user about that.
2280 if (!sfp->gpio[GPIO_TX_DISABLE])
2282 "No tx_disable pin: SFP modules will always be emitting.\n");
2284 sfp->sfp_bus = sfp_register_socket(sfp->dev, sfp, &sfp_module_ops);
2291 static int sfp_remove(struct platform_device *pdev)
2293 struct sfp *sfp = platform_get_drvdata(pdev);
2295 sfp_unregister_socket(sfp->sfp_bus);
2300 static void sfp_shutdown(struct platform_device *pdev)
2302 struct sfp *sfp = platform_get_drvdata(pdev);
2305 for (i = 0; i < GPIO_MAX; i++) {
2306 if (!sfp->gpio_irq[i])
2309 devm_free_irq(sfp->dev, sfp->gpio_irq[i], sfp);
2312 cancel_delayed_work_sync(&sfp->poll);
2313 cancel_delayed_work_sync(&sfp->timeout);
2316 static struct platform_driver sfp_driver = {
2318 .remove = sfp_remove,
2319 .shutdown = sfp_shutdown,
2322 .of_match_table = sfp_of_match,
2326 static int sfp_init(void)
2328 poll_jiffies = msecs_to_jiffies(100);
2330 return platform_driver_register(&sfp_driver);
2332 module_init(sfp_init);
2334 static void sfp_exit(void)
2336 platform_driver_unregister(&sfp_driver);
2338 module_exit(sfp_exit);
2340 MODULE_ALIAS("platform:sfp");
2341 MODULE_AUTHOR("Russell King");
2342 MODULE_LICENSE("GPL v2");