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