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