1 // SPDX-License-Identifier: GPL-2.0-only
20  * struct sfp_bus - internal representation of a sfp bus
50 	/* Ubiquiti U-Fiber Instant module claims that support all transceiver  in sfp_quirk_ubnt_uf_instant()
52 	 * modes and set only one mode which module supports: 1000baseX_Full.  in sfp_quirk_ubnt_uf_instant()
55 	phylink_set(modes, 1000baseX_Full);  in sfp_quirk_ubnt_uf_instant()
60 		// Alcatel Lucent G-010S-P can operate at 2500base-X, but
66 		// Alcatel Lucent G-010S-A can operate at 2500base-X, but
72 		// Huawei MA5671A can operate at 2500base-X, but report 1.2GBd
79 		.part = "UF-INSTANT",
111 	vs = sfp_strlen(id->base.vendor_name, ARRAY_SIZE(id->base.vendor_name));  in sfp_lookup_quirk()
112 	ps = sfp_strlen(id->base.vendor_pn, ARRAY_SIZE(id->base.vendor_pn));  in sfp_lookup_quirk()
115 		if (sfp_match(q->vendor, id->base.vendor_name, vs) &&  in sfp_lookup_quirk()
116 		    sfp_match(q->part, id->base.vendor_pn, ps))  in sfp_lookup_quirk()
123  * sfp_parse_port() - Parse the EEPROM base ID, setting the port type
130  * %PORT_TP, %PORT_FIBRE or %PORT_OTHER. If @support is non-%NULL,
142 	switch (id->base.connector) {  in sfp_parse_port()
163 		if (id->base.e1000_base_t) {  in sfp_parse_port()
175 		dev_warn(bus->sfp_dev, "SFP: unknown connector id 0x%02x\n",  in sfp_parse_port()
176 			 id->base.connector);  in sfp_parse_port()
198  * sfp_may_have_phy() - indicate whether the module may have a PHY
207 	if (id->base.e1000_base_t)  in sfp_may_have_phy()
210 	if (id->base.phys_id != SFF8024_ID_DWDM_SFP) {  in sfp_may_have_phy()
211 		switch (id->base.extended_cc) {  in sfp_may_have_phy()
225  * sfp_parse_support() - Parse the eeprom id for supported link modes
241 	if (id->base.br_nominal) {  in sfp_parse_support()
242 		if (id->base.br_nominal != 255) {  in sfp_parse_support()
243 			br_nom = id->base.br_nominal * 100;  in sfp_parse_support()
244 			br_min = br_nom - id->base.br_nominal * id->ext.br_min;  in sfp_parse_support()
245 			br_max = br_nom + id->base.br_nominal * id->ext.br_max;  in sfp_parse_support()
246 		} else if (id->ext.br_max) {  in sfp_parse_support()
247 			br_nom = 250 * id->ext.br_max;  in sfp_parse_support()
248 			br_max = br_nom + br_nom * id->ext.br_min / 100;  in sfp_parse_support()
249 			br_min = br_nom - br_nom * id->ext.br_min / 100;  in sfp_parse_support()
256 		if (br_min == br_max && id->base.sfp_ct_passive)  in sfp_parse_support()
261 	if (id->base.e10g_base_sr)  in sfp_parse_support()
263 	if (id->base.e10g_base_lr)  in sfp_parse_support()
265 	if (id->base.e10g_base_lrm)  in sfp_parse_support()
267 	if (id->base.e10g_base_er)  in sfp_parse_support()
269 	if (id->base.e1000_base_sx ||  in sfp_parse_support()
270 	    id->base.e1000_base_lx ||  in sfp_parse_support()
271 	    id->base.e1000_base_cx)  in sfp_parse_support()
272 		phylink_set(modes, 1000baseX_Full);  in sfp_parse_support()
273 	if (id->base.e1000_base_t) {  in sfp_parse_support()
274 		phylink_set(modes, 1000baseT_Half);  in sfp_parse_support()
275 		phylink_set(modes, 1000baseT_Full);  in sfp_parse_support()
278 	/* 1000Base-PX or 1000Base-BX10 */  in sfp_parse_support()
279 	if ((id->base.e_base_px || id->base.e_base_bx10) &&  in sfp_parse_support()
281 		phylink_set(modes, 1000baseX_Full);  in sfp_parse_support()
283 	/* 100Base-FX, 100Base-LX, 100Base-PX, 100Base-BX10 */  in sfp_parse_support()
284 	if (id->base.e100_base_fx || id->base.e100_base_lx)  in sfp_parse_support()
286 	if ((id->base.e_base_px || id->base.e_base_bx10) && br_nom == 100)  in sfp_parse_support()
292 	if ((id->base.sfp_ct_passive || id->base.sfp_ct_active) && br_nom) {  in sfp_parse_support()
299 			phylink_set(modes, 1000baseX_Full);  in sfp_parse_support()
301 	if (id->base.sfp_ct_passive) {  in sfp_parse_support()
302 		if (id->base.passive.sff8431_app_e)  in sfp_parse_support()
305 	if (id->base.sfp_ct_active) {  in sfp_parse_support()
306 		if (id->base.active.sff8431_app_e ||  in sfp_parse_support()
307 		    id->base.active.sff8431_lim) {  in sfp_parse_support()
312 	switch (id->base.extended_cc) {  in sfp_parse_support()
341 		dev_warn(bus->sfp_dev,  in sfp_parse_support()
342 			 "Unknown/unsupported extended compliance code: 0x%02x\n",  in sfp_parse_support()
343 			 id->base.extended_cc);  in sfp_parse_support()
348 	if (id->base.fc_speed_100 ||  in sfp_parse_support()
349 	    id->base.fc_speed_200 ||  in sfp_parse_support()
350 	    id->base.fc_speed_400) {  in sfp_parse_support()
351 		if (id->base.br_nominal >= 31)  in sfp_parse_support()
353 		if (id->base.br_nominal >= 12)  in sfp_parse_support()
354 			phylink_set(modes, 1000baseX_Full);  in sfp_parse_support()
359 	 * 1310nm/1550nm) are not 1000BASE-BX compliant due to the differing  in sfp_parse_support()
362 	 * Do the same for modules supporting 2500BASE-X. Note that some  in sfp_parse_support()
364 	 * 2500BASE-X, so we allow some slack here.  in sfp_parse_support()
368 			phylink_set(modes, 1000baseX_Full);  in sfp_parse_support()
373 	if (bus->sfp_quirk)  in sfp_parse_support()
374 		bus->sfp_quirk->modes(id, modes);  in sfp_parse_support()
385  * sfp_select_interface() - Select appropriate phy_interface_t mode
414 	if (phylink_test(link_modes, 1000baseT_Half) ||  in sfp_select_interface()
415 	    phylink_test(link_modes, 1000baseT_Full))  in sfp_select_interface()
418 	if (phylink_test(link_modes, 1000baseX_Full))  in sfp_select_interface()
424 	dev_warn(bus->sfp_dev, "Unable to ascertain link mode\n");  in sfp_select_interface()
435 	return bus->registered ? bus->upstream_ops : NULL;  in sfp_get_upstream_ops()
447 		if (sfp->fwnode == fwnode) {  in sfp_bus_get()
448 			kref_get(&sfp->kref);  in sfp_bus_get()
455 		kref_init(&new->kref);  in sfp_bus_get()
456 		new->fwnode = fwnode;  in sfp_bus_get()
457 		list_add(&new->node, &sfp_buses);  in sfp_bus_get()
473 	list_del(&bus->node);  in sfp_bus_release()
479  * sfp_bus_put() - put a reference on the &struct sfp_bus
488 		kref_put_mutex(&bus->kref, sfp_bus_release, &sfp_mutex);  in sfp_bus_put()
494 	const struct sfp_upstream_ops *ops = bus->upstream_ops;  in sfp_register_bus()
498 		if (ops->link_down)  in sfp_register_bus()
499 			ops->link_down(bus->upstream);  in sfp_register_bus()
500 		if (ops->connect_phy && bus->phydev) {  in sfp_register_bus()
501 			ret = ops->connect_phy(bus->upstream, bus->phydev);  in sfp_register_bus()
506 	bus->registered = true;  in sfp_register_bus()
507 	bus->socket_ops->attach(bus->sfp);  in sfp_register_bus()
508 	if (bus->started)  in sfp_register_bus()
509 		bus->socket_ops->start(bus->sfp);  in sfp_register_bus()
510 	bus->upstream_ops->attach(bus->upstream, bus);  in sfp_register_bus()
516 	const struct sfp_upstream_ops *ops = bus->upstream_ops;  in sfp_unregister_bus()
518 	if (bus->registered) {  in sfp_unregister_bus()
519 		bus->upstream_ops->detach(bus->upstream, bus);  in sfp_unregister_bus()
520 		if (bus->started)  in sfp_unregister_bus()
521 			bus->socket_ops->stop(bus->sfp);  in sfp_unregister_bus()
522 		bus->socket_ops->detach(bus->sfp);  in sfp_unregister_bus()
523 		if (bus->phydev && ops && ops->disconnect_phy)  in sfp_unregister_bus()
524 			ops->disconnect_phy(bus->upstream);  in sfp_unregister_bus()
526 	bus->registered = false;  in sfp_unregister_bus()
530  * sfp_get_module_info() - Get the ethtool_modinfo for a SFP module
541 	return bus->socket_ops->module_info(bus->sfp, modinfo);  in sfp_get_module_info()
546  * sfp_get_module_eeprom() - Read the SFP module EEPROM
549  * @data: buffer to contain the EEPROM data (must be at least @ee->len bytes)
559 	return bus->socket_ops->module_eeprom(bus->sfp, ee, data);  in sfp_get_module_eeprom()
564  * sfp_get_module_eeprom_by_page() - Read a page from the SFP module EEPROM
579 	return bus->socket_ops->module_eeprom_by_page(bus->sfp, page, extack);  in sfp_get_module_eeprom_by_page()
584  * sfp_upstream_start() - Inform the SFP that the network device is up
594 	if (bus->registered)  in sfp_upstream_start()
595 		bus->socket_ops->start(bus->sfp);  in sfp_upstream_start()
596 	bus->started = true;  in sfp_upstream_start()
601  * sfp_upstream_stop() - Inform the SFP that the network device is down
611 	if (bus->registered)  in sfp_upstream_stop()
612 		bus->socket_ops->stop(bus->sfp);  in sfp_upstream_stop()
613 	bus->started = false;  in sfp_upstream_stop()
619 	bus->upstream_ops = NULL;  in sfp_upstream_clear()
620 	bus->upstream = NULL;  in sfp_upstream_clear()
624  * sfp_bus_find_fwnode() - parse and locate the SFP bus from fwnode
632  *	- on success, a pointer to the sfp_bus structure,
633  *	- %NULL if no SFP is specified,
634  *	- on failure, an error pointer value:
636  *	- corresponding to the errors detailed for
638  *	- %-ENOMEM if we failed to allocate the bus.
639  *	- an error from the upstream's connect_phy() method.
649 	if (ret == -ENOENT)  in sfp_bus_find_fwnode()
657 		return ERR_PTR(-ENOMEM);  in sfp_bus_find_fwnode()
664  * sfp_bus_add_upstream() - parse and register the neighbouring device
674  *	- on success, a pointer to the sfp_bus structure,
675  *	- %NULL if no SFP is specified,
676  *	- on failure, an error pointer value:
678  *	- corresponding to the errors detailed for
680  *	- %-ENOMEM if we failed to allocate the bus.
681  *	- an error from the upstream's connect_phy() method.
693 	kref_get(&bus->kref);  in sfp_bus_add_upstream()
694 	bus->upstream_ops = ops;  in sfp_bus_add_upstream()
695 	bus->upstream = upstream;  in sfp_bus_add_upstream()
697 	if (bus->sfp) {  in sfp_bus_add_upstream()
714  * sfp_bus_del_upstream() - Delete a sfp bus
724 		if (bus->sfp)  in sfp_bus_del_upstream()
740 	if (ops && ops->connect_phy)  in sfp_add_phy()
741 		ret = ops->connect_phy(bus->upstream, phydev);  in sfp_add_phy()
744 		bus->phydev = phydev;  in sfp_add_phy()
754 	if (ops && ops->disconnect_phy)  in sfp_remove_phy()
755 		ops->disconnect_phy(bus->upstream);  in sfp_remove_phy()
756 	bus->phydev = NULL;  in sfp_remove_phy()
764 	if (ops && ops->link_up)  in sfp_link_up()
765 		ops->link_up(bus->upstream);  in sfp_link_up()
773 	if (ops && ops->link_down)  in sfp_link_down()
774 		ops->link_down(bus->upstream);  in sfp_link_down()
783 	bus->sfp_quirk = sfp_lookup_quirk(id);  in sfp_module_insert()
785 	if (ops && ops->module_insert)  in sfp_module_insert()
786 		ret = ops->module_insert(bus->upstream, id);  in sfp_module_insert()
796 	if (ops && ops->module_remove)  in sfp_module_remove()
797 		ops->module_remove(bus->upstream);  in sfp_module_remove()
799 	bus->sfp_quirk = NULL;  in sfp_module_remove()
808 	if (ops && ops->module_start)  in sfp_module_start()
809 		ret = ops->module_start(bus->upstream);  in sfp_module_start()
819 	if (ops && ops->module_stop)  in sfp_module_stop()
820 		ops->module_stop(bus->upstream);  in sfp_module_stop()
826 	bus->sfp_dev = NULL;  in sfp_socket_clear()
827 	bus->sfp = NULL;  in sfp_socket_clear()
828 	bus->socket_ops = NULL;  in sfp_socket_clear()
834 	struct sfp_bus *bus = sfp_bus_get(dev->fwnode);  in sfp_register_socket()
839 		bus->sfp_dev = dev;  in sfp_register_socket()
840 		bus->sfp = sfp;  in sfp_register_socket()
841 		bus->socket_ops = ops;  in sfp_register_socket()
843 		if (bus->upstream_ops) {  in sfp_register_socket()
863 	if (bus->upstream_ops)  in sfp_unregister_socket()