xref: /linux/drivers/net/phy/mdio_bus.c (revision 1a9239bb4253f9076b5b4b2a1a4e8d7defd77a95)
1 // SPDX-License-Identifier: GPL-2.0+
2 /* MDIO Bus interface
3  *
4  * Author: Andy Fleming
5  *
6  * Copyright (c) 2004 Freescale Semiconductor, Inc.
7  */
8 
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 
11 #include <linux/delay.h>
12 #include <linux/device.h>
13 #include <linux/errno.h>
14 #include <linux/etherdevice.h>
15 #include <linux/ethtool.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/init.h>
18 #include <linux/interrupt.h>
19 #include <linux/io.h>
20 #include <linux/kernel.h>
21 #include <linux/micrel_phy.h>
22 #include <linux/mii.h>
23 #include <linux/mm.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/of_device.h>
27 #include <linux/of_mdio.h>
28 #include <linux/phy.h>
29 #include <linux/reset.h>
30 #include <linux/skbuff.h>
31 #include <linux/slab.h>
32 #include <linux/spinlock.h>
33 #include <linux/string.h>
34 #include <linux/uaccess.h>
35 #include <linux/unistd.h>
36 
37 #define CREATE_TRACE_POINTS
38 #include <trace/events/mdio.h>
39 
40 #include "mdio-boardinfo.h"
41 
mdiobus_register_gpiod(struct mdio_device * mdiodev)42 static int mdiobus_register_gpiod(struct mdio_device *mdiodev)
43 {
44 	/* Deassert the optional reset signal */
45 	mdiodev->reset_gpio = gpiod_get_optional(&mdiodev->dev,
46 						 "reset", GPIOD_OUT_LOW);
47 	if (IS_ERR(mdiodev->reset_gpio))
48 		return PTR_ERR(mdiodev->reset_gpio);
49 
50 	if (mdiodev->reset_gpio)
51 		gpiod_set_consumer_name(mdiodev->reset_gpio, "PHY reset");
52 
53 	return 0;
54 }
55 
mdiobus_register_reset(struct mdio_device * mdiodev)56 static int mdiobus_register_reset(struct mdio_device *mdiodev)
57 {
58 	struct reset_control *reset;
59 
60 	reset = reset_control_get_optional_exclusive(&mdiodev->dev, "phy");
61 	if (IS_ERR(reset))
62 		return PTR_ERR(reset);
63 
64 	mdiodev->reset_ctrl = reset;
65 
66 	return 0;
67 }
68 
mdiobus_register_device(struct mdio_device * mdiodev)69 int mdiobus_register_device(struct mdio_device *mdiodev)
70 {
71 	int err;
72 
73 	if (mdiodev->bus->mdio_map[mdiodev->addr])
74 		return -EBUSY;
75 
76 	if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY) {
77 		err = mdiobus_register_gpiod(mdiodev);
78 		if (err)
79 			return err;
80 
81 		err = mdiobus_register_reset(mdiodev);
82 		if (err)
83 			return err;
84 
85 		/* Assert the reset signal */
86 		mdio_device_reset(mdiodev, 1);
87 	}
88 
89 	mdiodev->bus->mdio_map[mdiodev->addr] = mdiodev;
90 
91 	return 0;
92 }
93 EXPORT_SYMBOL(mdiobus_register_device);
94 
mdiobus_unregister_device(struct mdio_device * mdiodev)95 int mdiobus_unregister_device(struct mdio_device *mdiodev)
96 {
97 	if (mdiodev->bus->mdio_map[mdiodev->addr] != mdiodev)
98 		return -EINVAL;
99 
100 	reset_control_put(mdiodev->reset_ctrl);
101 
102 	mdiodev->bus->mdio_map[mdiodev->addr] = NULL;
103 
104 	return 0;
105 }
106 EXPORT_SYMBOL(mdiobus_unregister_device);
107 
mdiobus_find_device(struct mii_bus * bus,int addr)108 static struct mdio_device *mdiobus_find_device(struct mii_bus *bus, int addr)
109 {
110 	bool addr_valid = addr >= 0 && addr < ARRAY_SIZE(bus->mdio_map);
111 
112 	if (WARN_ONCE(!addr_valid, "addr %d out of range\n", addr))
113 		return NULL;
114 
115 	return bus->mdio_map[addr];
116 }
117 
mdiobus_get_phy(struct mii_bus * bus,int addr)118 struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr)
119 {
120 	struct mdio_device *mdiodev;
121 
122 	mdiodev = mdiobus_find_device(bus, addr);
123 	if (!mdiodev)
124 		return NULL;
125 
126 	if (!(mdiodev->flags & MDIO_DEVICE_FLAG_PHY))
127 		return NULL;
128 
129 	return container_of(mdiodev, struct phy_device, mdio);
130 }
131 EXPORT_SYMBOL(mdiobus_get_phy);
132 
mdiobus_is_registered_device(struct mii_bus * bus,int addr)133 bool mdiobus_is_registered_device(struct mii_bus *bus, int addr)
134 {
135 	return mdiobus_find_device(bus, addr) != NULL;
136 }
137 EXPORT_SYMBOL(mdiobus_is_registered_device);
138 
139 /**
140  * mdiobus_alloc_size - allocate a mii_bus structure
141  * @size: extra amount of memory to allocate for private storage.
142  * If non-zero, then bus->priv is points to that memory.
143  *
144  * Description: called by a bus driver to allocate an mii_bus
145  * structure to fill in.
146  */
mdiobus_alloc_size(size_t size)147 struct mii_bus *mdiobus_alloc_size(size_t size)
148 {
149 	struct mii_bus *bus;
150 	size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
151 	size_t alloc_size;
152 	int i;
153 
154 	/* If we alloc extra space, it should be aligned */
155 	if (size)
156 		alloc_size = aligned_size + size;
157 	else
158 		alloc_size = sizeof(*bus);
159 
160 	bus = kzalloc(alloc_size, GFP_KERNEL);
161 	if (!bus)
162 		return NULL;
163 
164 	bus->state = MDIOBUS_ALLOCATED;
165 	if (size)
166 		bus->priv = (void *)bus + aligned_size;
167 
168 	/* Initialise the interrupts to polling and 64-bit seqcounts */
169 	for (i = 0; i < PHY_MAX_ADDR; i++) {
170 		bus->irq[i] = PHY_POLL;
171 		u64_stats_init(&bus->stats[i].syncp);
172 	}
173 
174 	return bus;
175 }
176 EXPORT_SYMBOL(mdiobus_alloc_size);
177 
178 /**
179  * mdiobus_release - mii_bus device release callback
180  * @d: the target struct device that contains the mii_bus
181  *
182  * Description: called when the last reference to an mii_bus is
183  * dropped, to free the underlying memory.
184  */
mdiobus_release(struct device * d)185 static void mdiobus_release(struct device *d)
186 {
187 	struct mii_bus *bus = to_mii_bus(d);
188 
189 	WARN(bus->state != MDIOBUS_RELEASED &&
190 	     /* for compatibility with error handling in drivers */
191 	     bus->state != MDIOBUS_ALLOCATED,
192 	     "%s: not in RELEASED or ALLOCATED state\n",
193 	     bus->id);
194 
195 	if (bus->state == MDIOBUS_RELEASED)
196 		fwnode_handle_put(dev_fwnode(d));
197 
198 	kfree(bus);
199 }
200 
201 struct mdio_bus_stat_attr {
202 	int addr;
203 	unsigned int field_offset;
204 };
205 
mdio_bus_get_stat(struct mdio_bus_stats * s,unsigned int offset)206 static u64 mdio_bus_get_stat(struct mdio_bus_stats *s, unsigned int offset)
207 {
208 	const char *p = (const char *)s + offset;
209 	unsigned int start;
210 	u64 val = 0;
211 
212 	do {
213 		start = u64_stats_fetch_begin(&s->syncp);
214 		val = u64_stats_read((const u64_stats_t *)p);
215 	} while (u64_stats_fetch_retry(&s->syncp, start));
216 
217 	return val;
218 }
219 
mdio_bus_get_global_stat(struct mii_bus * bus,unsigned int offset)220 static u64 mdio_bus_get_global_stat(struct mii_bus *bus, unsigned int offset)
221 {
222 	unsigned int i;
223 	u64 val = 0;
224 
225 	for (i = 0; i < PHY_MAX_ADDR; i++)
226 		val += mdio_bus_get_stat(&bus->stats[i], offset);
227 
228 	return val;
229 }
230 
mdio_bus_stat_field_show(struct device * dev,struct device_attribute * attr,char * buf)231 static ssize_t mdio_bus_stat_field_show(struct device *dev,
232 					struct device_attribute *attr,
233 					char *buf)
234 {
235 	struct mii_bus *bus = to_mii_bus(dev);
236 	struct mdio_bus_stat_attr *sattr;
237 	struct dev_ext_attribute *eattr;
238 	u64 val;
239 
240 	eattr = container_of(attr, struct dev_ext_attribute, attr);
241 	sattr = eattr->var;
242 
243 	if (sattr->addr < 0)
244 		val = mdio_bus_get_global_stat(bus, sattr->field_offset);
245 	else
246 		val = mdio_bus_get_stat(&bus->stats[sattr->addr],
247 					sattr->field_offset);
248 
249 	return sysfs_emit(buf, "%llu\n", val);
250 }
251 
mdio_bus_device_stat_field_show(struct device * dev,struct device_attribute * attr,char * buf)252 static ssize_t mdio_bus_device_stat_field_show(struct device *dev,
253 					       struct device_attribute *attr,
254 					       char *buf)
255 {
256 	struct mdio_device *mdiodev = to_mdio_device(dev);
257 	struct mii_bus *bus = mdiodev->bus;
258 	struct mdio_bus_stat_attr *sattr;
259 	struct dev_ext_attribute *eattr;
260 	int addr = mdiodev->addr;
261 	u64 val;
262 
263 	eattr = container_of(attr, struct dev_ext_attribute, attr);
264 	sattr = eattr->var;
265 
266 	val = mdio_bus_get_stat(&bus->stats[addr], sattr->field_offset);
267 
268 	return sysfs_emit(buf, "%llu\n", val);
269 }
270 
271 #define MDIO_BUS_STATS_ATTR_DECL(field, file)				\
272 static struct dev_ext_attribute dev_attr_mdio_bus_##field = {		\
273 	.attr = { .attr = { .name = file, .mode = 0444 },		\
274 		     .show = mdio_bus_stat_field_show,			\
275 	},								\
276 	.var = &((struct mdio_bus_stat_attr) {				\
277 		-1, offsetof(struct mdio_bus_stats, field)		\
278 	}),								\
279 };									\
280 static struct dev_ext_attribute dev_attr_mdio_bus_device_##field = {	\
281 	.attr = { .attr = { .name = file, .mode = 0444 },		\
282 		     .show = mdio_bus_device_stat_field_show,		\
283 	},								\
284 	.var = &((struct mdio_bus_stat_attr) {				\
285 		-1, offsetof(struct mdio_bus_stats, field)		\
286 	}),								\
287 };
288 
289 #define MDIO_BUS_STATS_ATTR(field)					\
290 	MDIO_BUS_STATS_ATTR_DECL(field, __stringify(field))
291 
292 MDIO_BUS_STATS_ATTR(transfers);
293 MDIO_BUS_STATS_ATTR(errors);
294 MDIO_BUS_STATS_ATTR(writes);
295 MDIO_BUS_STATS_ATTR(reads);
296 
297 #define MDIO_BUS_STATS_ADDR_ATTR_DECL(field, addr, file)		\
298 static struct dev_ext_attribute dev_attr_mdio_bus_addr_##field##_##addr = { \
299 	.attr = { .attr = { .name = file, .mode = 0444 },		\
300 		     .show = mdio_bus_stat_field_show,			\
301 	},								\
302 	.var = &((struct mdio_bus_stat_attr) {				\
303 		addr, offsetof(struct mdio_bus_stats, field)		\
304 	}),								\
305 }
306 
307 #define MDIO_BUS_STATS_ADDR_ATTR(field, addr)				\
308 	MDIO_BUS_STATS_ADDR_ATTR_DECL(field, addr,			\
309 				 __stringify(field) "_" __stringify(addr))
310 
311 #define MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(addr)			\
312 	MDIO_BUS_STATS_ADDR_ATTR(transfers, addr);			\
313 	MDIO_BUS_STATS_ADDR_ATTR(errors, addr);				\
314 	MDIO_BUS_STATS_ADDR_ATTR(writes, addr);				\
315 	MDIO_BUS_STATS_ADDR_ATTR(reads, addr)				\
316 
317 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(0);
318 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(1);
319 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(2);
320 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(3);
321 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(4);
322 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(5);
323 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(6);
324 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(7);
325 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(8);
326 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(9);
327 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(10);
328 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(11);
329 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(12);
330 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(13);
331 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(14);
332 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(15);
333 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(16);
334 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(17);
335 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(18);
336 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(19);
337 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(20);
338 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(21);
339 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(22);
340 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(23);
341 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(24);
342 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(25);
343 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(26);
344 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(27);
345 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(28);
346 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(29);
347 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(30);
348 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(31);
349 
350 #define MDIO_BUS_STATS_ADDR_ATTR_GROUP(addr)				\
351 	&dev_attr_mdio_bus_addr_transfers_##addr.attr.attr,		\
352 	&dev_attr_mdio_bus_addr_errors_##addr.attr.attr,		\
353 	&dev_attr_mdio_bus_addr_writes_##addr.attr.attr,		\
354 	&dev_attr_mdio_bus_addr_reads_##addr.attr.attr			\
355 
356 static struct attribute *mdio_bus_statistics_attrs[] = {
357 	&dev_attr_mdio_bus_transfers.attr.attr,
358 	&dev_attr_mdio_bus_errors.attr.attr,
359 	&dev_attr_mdio_bus_writes.attr.attr,
360 	&dev_attr_mdio_bus_reads.attr.attr,
361 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(0),
362 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(1),
363 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(2),
364 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(3),
365 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(4),
366 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(5),
367 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(6),
368 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(7),
369 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(8),
370 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(9),
371 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(10),
372 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(11),
373 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(12),
374 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(13),
375 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(14),
376 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(15),
377 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(16),
378 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(17),
379 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(18),
380 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(19),
381 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(20),
382 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(21),
383 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(22),
384 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(23),
385 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(24),
386 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(25),
387 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(26),
388 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(27),
389 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(28),
390 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(29),
391 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(30),
392 	MDIO_BUS_STATS_ADDR_ATTR_GROUP(31),
393 	NULL,
394 };
395 
396 static const struct attribute_group mdio_bus_statistics_group = {
397 	.name	= "statistics",
398 	.attrs	= mdio_bus_statistics_attrs,
399 };
400 
401 static const struct attribute_group *mdio_bus_groups[] = {
402 	&mdio_bus_statistics_group,
403 	NULL,
404 };
405 
406 static struct class mdio_bus_class = {
407 	.name		= "mdio_bus",
408 	.dev_release	= mdiobus_release,
409 	.dev_groups	= mdio_bus_groups,
410 };
411 
412 /**
413  * mdio_find_bus - Given the name of a mdiobus, find the mii_bus.
414  * @mdio_name: The name of a mdiobus.
415  *
416  * Returns a reference to the mii_bus, or NULL if none found.  The
417  * embedded struct device will have its reference count incremented,
418  * and this must be put_deviced'ed once the bus is finished with.
419  */
mdio_find_bus(const char * mdio_name)420 struct mii_bus *mdio_find_bus(const char *mdio_name)
421 {
422 	struct device *d;
423 
424 	d = class_find_device_by_name(&mdio_bus_class, mdio_name);
425 	return d ? to_mii_bus(d) : NULL;
426 }
427 EXPORT_SYMBOL(mdio_find_bus);
428 
429 #if IS_ENABLED(CONFIG_OF_MDIO)
430 /**
431  * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
432  * @mdio_bus_np: Pointer to the mii_bus.
433  *
434  * Returns a reference to the mii_bus, or NULL if none found.  The
435  * embedded struct device will have its reference count incremented,
436  * and this must be put once the bus is finished with.
437  *
438  * Because the association of a device_node and mii_bus is made via
439  * of_mdiobus_register(), the mii_bus cannot be found before it is
440  * registered with of_mdiobus_register().
441  *
442  */
of_mdio_find_bus(struct device_node * mdio_bus_np)443 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
444 {
445 	struct device *d;
446 
447 	if (!mdio_bus_np)
448 		return NULL;
449 
450 	d = class_find_device_by_of_node(&mdio_bus_class, mdio_bus_np);
451 	return d ? to_mii_bus(d) : NULL;
452 }
453 EXPORT_SYMBOL(of_mdio_find_bus);
454 
455 /* Walk the list of subnodes of a mdio bus and look for a node that
456  * matches the mdio device's address with its 'reg' property. If
457  * found, set the of_node pointer for the mdio device. This allows
458  * auto-probed phy devices to be supplied with information passed in
459  * via DT.
460  * If a PHY package is found, PHY is searched also there.
461  */
of_mdiobus_find_phy(struct device * dev,struct mdio_device * mdiodev,struct device_node * np)462 static int of_mdiobus_find_phy(struct device *dev, struct mdio_device *mdiodev,
463 			       struct device_node *np)
464 {
465 	struct device_node *child;
466 
467 	for_each_available_child_of_node(np, child) {
468 		int addr;
469 
470 		if (of_node_name_eq(child, "ethernet-phy-package")) {
471 			/* Validate PHY package reg presence */
472 			if (!of_property_present(child, "reg")) {
473 				of_node_put(child);
474 				return -EINVAL;
475 			}
476 
477 			if (!of_mdiobus_find_phy(dev, mdiodev, child)) {
478 				/* The refcount for the PHY package will be
479 				 * incremented later when PHY join the Package.
480 				 */
481 				of_node_put(child);
482 				return 0;
483 			}
484 
485 			continue;
486 		}
487 
488 		addr = of_mdio_parse_addr(dev, child);
489 		if (addr < 0)
490 			continue;
491 
492 		if (addr == mdiodev->addr) {
493 			device_set_node(dev, of_fwnode_handle(child));
494 			/* The refcount on "child" is passed to the mdio
495 			 * device. Do _not_ use of_node_put(child) here.
496 			 */
497 			return 0;
498 		}
499 	}
500 
501 	return -ENODEV;
502 }
503 
of_mdiobus_link_mdiodev(struct mii_bus * bus,struct mdio_device * mdiodev)504 static void of_mdiobus_link_mdiodev(struct mii_bus *bus,
505 				    struct mdio_device *mdiodev)
506 {
507 	struct device *dev = &mdiodev->dev;
508 
509 	if (dev->of_node || !bus->dev.of_node)
510 		return;
511 
512 	of_mdiobus_find_phy(dev, mdiodev, bus->dev.of_node);
513 }
514 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
of_mdiobus_link_mdiodev(struct mii_bus * mdio,struct mdio_device * mdiodev)515 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
516 					   struct mdio_device *mdiodev)
517 {
518 }
519 #endif
520 
521 /**
522  * mdiobus_create_device - create a full MDIO device given
523  * a mdio_board_info structure
524  * @bus: MDIO bus to create the devices on
525  * @bi: mdio_board_info structure describing the devices
526  *
527  * Returns 0 on success or < 0 on error.
528  */
mdiobus_create_device(struct mii_bus * bus,struct mdio_board_info * bi)529 static int mdiobus_create_device(struct mii_bus *bus,
530 				 struct mdio_board_info *bi)
531 {
532 	struct mdio_device *mdiodev;
533 	int ret = 0;
534 
535 	mdiodev = mdio_device_create(bus, bi->mdio_addr);
536 	if (IS_ERR(mdiodev))
537 		return -ENODEV;
538 
539 	strscpy(mdiodev->modalias, bi->modalias,
540 		sizeof(mdiodev->modalias));
541 	mdiodev->bus_match = mdio_device_bus_match;
542 	mdiodev->dev.platform_data = (void *)bi->platform_data;
543 
544 	ret = mdio_device_register(mdiodev);
545 	if (ret)
546 		mdio_device_free(mdiodev);
547 
548 	return ret;
549 }
550 
mdiobus_scan(struct mii_bus * bus,int addr,bool c45)551 static struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr, bool c45)
552 {
553 	struct phy_device *phydev = ERR_PTR(-ENODEV);
554 	struct fwnode_handle *fwnode;
555 	char node_name[16];
556 	int err;
557 
558 	phydev = get_phy_device(bus, addr, c45);
559 	if (IS_ERR(phydev))
560 		return phydev;
561 
562 	/* For DT, see if the auto-probed phy has a corresponding child
563 	 * in the bus node, and set the of_node pointer in this case.
564 	 */
565 	of_mdiobus_link_mdiodev(bus, &phydev->mdio);
566 
567 	/* Search for a swnode for the phy in the swnode hierarchy of the bus.
568 	 * If there is no swnode for the phy provided, just ignore it.
569 	 */
570 	if (dev_fwnode(&bus->dev) && !dev_fwnode(&phydev->mdio.dev)) {
571 		snprintf(node_name, sizeof(node_name), "ethernet-phy@%d",
572 			 addr);
573 		fwnode = fwnode_get_named_child_node(dev_fwnode(&bus->dev),
574 						     node_name);
575 		if (fwnode)
576 			device_set_node(&phydev->mdio.dev, fwnode);
577 	}
578 
579 	err = phy_device_register(phydev);
580 	if (err) {
581 		phy_device_free(phydev);
582 		return ERR_PTR(-ENODEV);
583 	}
584 
585 	return phydev;
586 }
587 
588 /**
589  * mdiobus_scan_c22 - scan one address on a bus for C22 MDIO devices.
590  * @bus: mii_bus to scan
591  * @addr: address on bus to scan
592  *
593  * This function scans one address on the MDIO bus, looking for
594  * devices which can be identified using a vendor/product ID in
595  * registers 2 and 3. Not all MDIO devices have such registers, but
596  * PHY devices typically do. Hence this function assumes anything
597  * found is a PHY, or can be treated as a PHY. Other MDIO devices,
598  * such as switches, will probably not be found during the scan.
599  */
mdiobus_scan_c22(struct mii_bus * bus,int addr)600 struct phy_device *mdiobus_scan_c22(struct mii_bus *bus, int addr)
601 {
602 	return mdiobus_scan(bus, addr, false);
603 }
604 EXPORT_SYMBOL(mdiobus_scan_c22);
605 
606 /**
607  * mdiobus_scan_c45 - scan one address on a bus for C45 MDIO devices.
608  * @bus: mii_bus to scan
609  * @addr: address on bus to scan
610  *
611  * This function scans one address on the MDIO bus, looking for
612  * devices which can be identified using a vendor/product ID in
613  * registers 2 and 3. Not all MDIO devices have such registers, but
614  * PHY devices typically do. Hence this function assumes anything
615  * found is a PHY, or can be treated as a PHY. Other MDIO devices,
616  * such as switches, will probably not be found during the scan.
617  */
mdiobus_scan_c45(struct mii_bus * bus,int addr)618 static struct phy_device *mdiobus_scan_c45(struct mii_bus *bus, int addr)
619 {
620 	return mdiobus_scan(bus, addr, true);
621 }
622 
mdiobus_scan_bus_c22(struct mii_bus * bus)623 static int mdiobus_scan_bus_c22(struct mii_bus *bus)
624 {
625 	int i;
626 
627 	for (i = 0; i < PHY_MAX_ADDR; i++) {
628 		if ((bus->phy_mask & BIT(i)) == 0) {
629 			struct phy_device *phydev;
630 
631 			phydev = mdiobus_scan_c22(bus, i);
632 			if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV))
633 				return PTR_ERR(phydev);
634 		}
635 	}
636 	return 0;
637 }
638 
mdiobus_scan_bus_c45(struct mii_bus * bus)639 static int mdiobus_scan_bus_c45(struct mii_bus *bus)
640 {
641 	int i;
642 
643 	for (i = 0; i < PHY_MAX_ADDR; i++) {
644 		if ((bus->phy_mask & BIT(i)) == 0) {
645 			struct phy_device *phydev;
646 
647 			/* Don't scan C45 if we already have a C22 device */
648 			if (bus->mdio_map[i])
649 				continue;
650 
651 			phydev = mdiobus_scan_c45(bus, i);
652 			if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV))
653 				return PTR_ERR(phydev);
654 		}
655 	}
656 	return 0;
657 }
658 
659 /* There are some C22 PHYs which do bad things when where is a C45
660  * transaction on the bus, like accepting a read themselves, and
661  * stomping over the true devices reply, to performing a write to
662  * themselves which was intended for another device. Now that C22
663  * devices have been found, see if any of them are bad for C45, and if we
664  * should skip the C45 scan.
665  */
mdiobus_prevent_c45_scan(struct mii_bus * bus)666 static bool mdiobus_prevent_c45_scan(struct mii_bus *bus)
667 {
668 	int i;
669 
670 	for (i = 0; i < PHY_MAX_ADDR; i++) {
671 		struct phy_device *phydev;
672 		u32 oui;
673 
674 		phydev = mdiobus_get_phy(bus, i);
675 		if (!phydev)
676 			continue;
677 		oui = phydev->phy_id >> 10;
678 
679 		if (oui == MICREL_OUI)
680 			return true;
681 	}
682 	return false;
683 }
684 
685 /**
686  * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
687  * @bus: target mii_bus
688  * @owner: module containing bus accessor functions
689  *
690  * Description: Called by a bus driver to bring up all the PHYs
691  *   on a given bus, and attach them to the bus. Drivers should use
692  *   mdiobus_register() rather than __mdiobus_register() unless they
693  *   need to pass a specific owner module. MDIO devices which are not
694  *   PHYs will not be brought up by this function. They are expected
695  *   to be explicitly listed in DT and instantiated by of_mdiobus_register().
696  *
697  * Returns 0 on success or < 0 on error.
698  */
__mdiobus_register(struct mii_bus * bus,struct module * owner)699 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
700 {
701 	struct mdio_device *mdiodev;
702 	struct gpio_desc *gpiod;
703 	bool prevent_c45_scan;
704 	int i, err;
705 
706 	if (!bus || !bus->name)
707 		return -EINVAL;
708 
709 	/* An access method always needs both read and write operations */
710 	if (!!bus->read != !!bus->write || !!bus->read_c45 != !!bus->write_c45)
711 		return -EINVAL;
712 
713 	/* At least one method is mandatory */
714 	if (!bus->read && !bus->read_c45)
715 		return -EINVAL;
716 
717 	if (bus->parent && bus->parent->of_node)
718 		bus->parent->of_node->fwnode.flags |=
719 					FWNODE_FLAG_NEEDS_CHILD_BOUND_ON_ADD;
720 
721 	WARN(bus->state != MDIOBUS_ALLOCATED &&
722 	     bus->state != MDIOBUS_UNREGISTERED,
723 	     "%s: not in ALLOCATED or UNREGISTERED state\n", bus->id);
724 
725 	bus->owner = owner;
726 	bus->dev.parent = bus->parent;
727 	bus->dev.class = &mdio_bus_class;
728 	bus->dev.groups = NULL;
729 	dev_set_name(&bus->dev, "%s", bus->id);
730 
731 	/* If the bus state is allocated, we're registering a fresh bus
732 	 * that may have a fwnode associated with it. Grab a reference
733 	 * to the fwnode. This will be dropped when the bus is released.
734 	 * If the bus was set to unregistered, it means that the bus was
735 	 * previously registered, and we've already grabbed a reference.
736 	 */
737 	if (bus->state == MDIOBUS_ALLOCATED)
738 		fwnode_handle_get(dev_fwnode(&bus->dev));
739 
740 	/* We need to set state to MDIOBUS_UNREGISTERED to correctly release
741 	 * the device in mdiobus_free()
742 	 *
743 	 * State will be updated later in this function in case of success
744 	 */
745 	bus->state = MDIOBUS_UNREGISTERED;
746 
747 	err = device_register(&bus->dev);
748 	if (err) {
749 		pr_err("mii_bus %s failed to register\n", bus->id);
750 		return -EINVAL;
751 	}
752 
753 	mutex_init(&bus->mdio_lock);
754 	mutex_init(&bus->shared_lock);
755 
756 	/* assert bus level PHY GPIO reset */
757 	gpiod = devm_gpiod_get_optional(&bus->dev, "reset", GPIOD_OUT_HIGH);
758 	if (IS_ERR(gpiod)) {
759 		err = dev_err_probe(&bus->dev, PTR_ERR(gpiod),
760 				    "mii_bus %s couldn't get reset GPIO\n",
761 				    bus->id);
762 		device_del(&bus->dev);
763 		return err;
764 	} else	if (gpiod) {
765 		bus->reset_gpiod = gpiod;
766 		fsleep(bus->reset_delay_us);
767 		gpiod_set_value_cansleep(gpiod, 0);
768 		if (bus->reset_post_delay_us > 0)
769 			fsleep(bus->reset_post_delay_us);
770 	}
771 
772 	if (bus->reset) {
773 		err = bus->reset(bus);
774 		if (err)
775 			goto error_reset_gpiod;
776 	}
777 
778 	if (bus->read) {
779 		err = mdiobus_scan_bus_c22(bus);
780 		if (err)
781 			goto error;
782 	}
783 
784 	prevent_c45_scan = mdiobus_prevent_c45_scan(bus);
785 
786 	if (!prevent_c45_scan && bus->read_c45) {
787 		err = mdiobus_scan_bus_c45(bus);
788 		if (err)
789 			goto error;
790 	}
791 
792 	mdiobus_setup_mdiodev_from_board_info(bus, mdiobus_create_device);
793 
794 	bus->state = MDIOBUS_REGISTERED;
795 	dev_dbg(&bus->dev, "probed\n");
796 	return 0;
797 
798 error:
799 	for (i = 0; i < PHY_MAX_ADDR; i++) {
800 		mdiodev = bus->mdio_map[i];
801 		if (!mdiodev)
802 			continue;
803 
804 		mdiodev->device_remove(mdiodev);
805 		mdiodev->device_free(mdiodev);
806 	}
807 error_reset_gpiod:
808 	/* Put PHYs in RESET to save power */
809 	if (bus->reset_gpiod)
810 		gpiod_set_value_cansleep(bus->reset_gpiod, 1);
811 
812 	device_del(&bus->dev);
813 	return err;
814 }
815 EXPORT_SYMBOL(__mdiobus_register);
816 
mdiobus_unregister(struct mii_bus * bus)817 void mdiobus_unregister(struct mii_bus *bus)
818 {
819 	struct mdio_device *mdiodev;
820 	int i;
821 
822 	if (WARN_ON_ONCE(bus->state != MDIOBUS_REGISTERED))
823 		return;
824 	bus->state = MDIOBUS_UNREGISTERED;
825 
826 	for (i = 0; i < PHY_MAX_ADDR; i++) {
827 		mdiodev = bus->mdio_map[i];
828 		if (!mdiodev)
829 			continue;
830 
831 		if (mdiodev->reset_gpio)
832 			gpiod_put(mdiodev->reset_gpio);
833 
834 		mdiodev->device_remove(mdiodev);
835 		mdiodev->device_free(mdiodev);
836 	}
837 
838 	/* Put PHYs in RESET to save power */
839 	if (bus->reset_gpiod)
840 		gpiod_set_value_cansleep(bus->reset_gpiod, 1);
841 
842 	device_del(&bus->dev);
843 }
844 EXPORT_SYMBOL(mdiobus_unregister);
845 
846 /**
847  * mdiobus_free - free a struct mii_bus
848  * @bus: mii_bus to free
849  *
850  * This function releases the reference to the underlying device
851  * object in the mii_bus.  If this is the last reference, the mii_bus
852  * will be freed.
853  */
mdiobus_free(struct mii_bus * bus)854 void mdiobus_free(struct mii_bus *bus)
855 {
856 	/* For compatibility with error handling in drivers. */
857 	if (bus->state == MDIOBUS_ALLOCATED) {
858 		kfree(bus);
859 		return;
860 	}
861 
862 	WARN(bus->state != MDIOBUS_UNREGISTERED,
863 	     "%s: not in UNREGISTERED state\n", bus->id);
864 	bus->state = MDIOBUS_RELEASED;
865 
866 	put_device(&bus->dev);
867 }
868 EXPORT_SYMBOL(mdiobus_free);
869 
mdiobus_stats_acct(struct mdio_bus_stats * stats,bool op,int ret)870 static void mdiobus_stats_acct(struct mdio_bus_stats *stats, bool op, int ret)
871 {
872 	preempt_disable();
873 	u64_stats_update_begin(&stats->syncp);
874 
875 	u64_stats_inc(&stats->transfers);
876 	if (ret < 0) {
877 		u64_stats_inc(&stats->errors);
878 		goto out;
879 	}
880 
881 	if (op)
882 		u64_stats_inc(&stats->reads);
883 	else
884 		u64_stats_inc(&stats->writes);
885 out:
886 	u64_stats_update_end(&stats->syncp);
887 	preempt_enable();
888 }
889 
890 /**
891  * __mdiobus_read - Unlocked version of the mdiobus_read function
892  * @bus: the mii_bus struct
893  * @addr: the phy address
894  * @regnum: register number to read
895  *
896  * Read a MDIO bus register. Caller must hold the mdio bus lock.
897  *
898  * NOTE: MUST NOT be called from interrupt context.
899  */
__mdiobus_read(struct mii_bus * bus,int addr,u32 regnum)900 int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
901 {
902 	int retval;
903 
904 	lockdep_assert_held_once(&bus->mdio_lock);
905 
906 	if (bus->read)
907 		retval = bus->read(bus, addr, regnum);
908 	else
909 		retval = -EOPNOTSUPP;
910 
911 	trace_mdio_access(bus, 1, addr, regnum, retval, retval);
912 	mdiobus_stats_acct(&bus->stats[addr], true, retval);
913 
914 	return retval;
915 }
916 EXPORT_SYMBOL(__mdiobus_read);
917 
918 /**
919  * __mdiobus_write - Unlocked version of the mdiobus_write function
920  * @bus: the mii_bus struct
921  * @addr: the phy address
922  * @regnum: register number to write
923  * @val: value to write to @regnum
924  *
925  * Write a MDIO bus register. Caller must hold the mdio bus lock.
926  *
927  * NOTE: MUST NOT be called from interrupt context.
928  */
__mdiobus_write(struct mii_bus * bus,int addr,u32 regnum,u16 val)929 int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
930 {
931 	int err;
932 
933 	lockdep_assert_held_once(&bus->mdio_lock);
934 
935 	if (bus->write)
936 		err = bus->write(bus, addr, regnum, val);
937 	else
938 		err = -EOPNOTSUPP;
939 
940 	trace_mdio_access(bus, 0, addr, regnum, val, err);
941 	mdiobus_stats_acct(&bus->stats[addr], false, err);
942 
943 	return err;
944 }
945 EXPORT_SYMBOL(__mdiobus_write);
946 
947 /**
948  * __mdiobus_modify_changed - Unlocked version of the mdiobus_modify function
949  * @bus: the mii_bus struct
950  * @addr: the phy address
951  * @regnum: register number to modify
952  * @mask: bit mask of bits to clear
953  * @set: bit mask of bits to set
954  *
955  * Read, modify, and if any change, write the register value back to the
956  * device. Any error returns a negative number.
957  *
958  * NOTE: MUST NOT be called from interrupt context.
959  */
__mdiobus_modify_changed(struct mii_bus * bus,int addr,u32 regnum,u16 mask,u16 set)960 int __mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
961 			     u16 mask, u16 set)
962 {
963 	int new, ret;
964 
965 	ret = __mdiobus_read(bus, addr, regnum);
966 	if (ret < 0)
967 		return ret;
968 
969 	new = (ret & ~mask) | set;
970 	if (new == ret)
971 		return 0;
972 
973 	ret = __mdiobus_write(bus, addr, regnum, new);
974 
975 	return ret < 0 ? ret : 1;
976 }
977 EXPORT_SYMBOL_GPL(__mdiobus_modify_changed);
978 
979 /**
980  * __mdiobus_c45_read - Unlocked version of the mdiobus_c45_read function
981  * @bus: the mii_bus struct
982  * @addr: the phy address
983  * @devad: device address to read
984  * @regnum: register number to read
985  *
986  * Read a MDIO bus register. Caller must hold the mdio bus lock.
987  *
988  * NOTE: MUST NOT be called from interrupt context.
989  */
__mdiobus_c45_read(struct mii_bus * bus,int addr,int devad,u32 regnum)990 int __mdiobus_c45_read(struct mii_bus *bus, int addr, int devad, u32 regnum)
991 {
992 	int retval;
993 
994 	lockdep_assert_held_once(&bus->mdio_lock);
995 
996 	if (bus->read_c45)
997 		retval = bus->read_c45(bus, addr, devad, regnum);
998 	else
999 		retval = -EOPNOTSUPP;
1000 
1001 	trace_mdio_access(bus, 1, addr, regnum, retval, retval);
1002 	mdiobus_stats_acct(&bus->stats[addr], true, retval);
1003 
1004 	return retval;
1005 }
1006 EXPORT_SYMBOL(__mdiobus_c45_read);
1007 
1008 /**
1009  * __mdiobus_c45_write - Unlocked version of the mdiobus_write function
1010  * @bus: the mii_bus struct
1011  * @addr: the phy address
1012  * @devad: device address to read
1013  * @regnum: register number to write
1014  * @val: value to write to @regnum
1015  *
1016  * Write a MDIO bus register. Caller must hold the mdio bus lock.
1017  *
1018  * NOTE: MUST NOT be called from interrupt context.
1019  */
__mdiobus_c45_write(struct mii_bus * bus,int addr,int devad,u32 regnum,u16 val)1020 int __mdiobus_c45_write(struct mii_bus *bus, int addr, int devad, u32 regnum,
1021 			u16 val)
1022 {
1023 	int err;
1024 
1025 	lockdep_assert_held_once(&bus->mdio_lock);
1026 
1027 	if (bus->write_c45)
1028 		err = bus->write_c45(bus, addr, devad, regnum, val);
1029 	else
1030 		err = -EOPNOTSUPP;
1031 
1032 	trace_mdio_access(bus, 0, addr, regnum, val, err);
1033 	mdiobus_stats_acct(&bus->stats[addr], false, err);
1034 
1035 	return err;
1036 }
1037 EXPORT_SYMBOL(__mdiobus_c45_write);
1038 
1039 /**
1040  * __mdiobus_c45_modify_changed - Unlocked version of the mdiobus_modify function
1041  * @bus: the mii_bus struct
1042  * @addr: the phy address
1043  * @devad: device address to read
1044  * @regnum: register number to modify
1045  * @mask: bit mask of bits to clear
1046  * @set: bit mask of bits to set
1047  *
1048  * Read, modify, and if any change, write the register value back to the
1049  * device. Any error returns a negative number.
1050  *
1051  * NOTE: MUST NOT be called from interrupt context.
1052  */
__mdiobus_c45_modify_changed(struct mii_bus * bus,int addr,int devad,u32 regnum,u16 mask,u16 set)1053 static int __mdiobus_c45_modify_changed(struct mii_bus *bus, int addr,
1054 					int devad, u32 regnum, u16 mask,
1055 					u16 set)
1056 {
1057 	int new, ret;
1058 
1059 	ret = __mdiobus_c45_read(bus, addr, devad, regnum);
1060 	if (ret < 0)
1061 		return ret;
1062 
1063 	new = (ret & ~mask) | set;
1064 	if (new == ret)
1065 		return 0;
1066 
1067 	ret = __mdiobus_c45_write(bus, addr, devad, regnum, new);
1068 
1069 	return ret < 0 ? ret : 1;
1070 }
1071 
1072 /**
1073  * mdiobus_read_nested - Nested version of the mdiobus_read function
1074  * @bus: the mii_bus struct
1075  * @addr: the phy address
1076  * @regnum: register number to read
1077  *
1078  * In case of nested MDIO bus access avoid lockdep false positives by
1079  * using mutex_lock_nested().
1080  *
1081  * NOTE: MUST NOT be called from interrupt context,
1082  * because the bus read/write functions may wait for an interrupt
1083  * to conclude the operation.
1084  */
mdiobus_read_nested(struct mii_bus * bus,int addr,u32 regnum)1085 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
1086 {
1087 	int retval;
1088 
1089 	mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
1090 	retval = __mdiobus_read(bus, addr, regnum);
1091 	mutex_unlock(&bus->mdio_lock);
1092 
1093 	return retval;
1094 }
1095 EXPORT_SYMBOL(mdiobus_read_nested);
1096 
1097 /**
1098  * mdiobus_read - Convenience function for reading a given MII mgmt register
1099  * @bus: the mii_bus struct
1100  * @addr: the phy address
1101  * @regnum: register number to read
1102  *
1103  * NOTE: MUST NOT be called from interrupt context,
1104  * because the bus read/write functions may wait for an interrupt
1105  * to conclude the operation.
1106  */
mdiobus_read(struct mii_bus * bus,int addr,u32 regnum)1107 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
1108 {
1109 	int retval;
1110 
1111 	mutex_lock(&bus->mdio_lock);
1112 	retval = __mdiobus_read(bus, addr, regnum);
1113 	mutex_unlock(&bus->mdio_lock);
1114 
1115 	return retval;
1116 }
1117 EXPORT_SYMBOL(mdiobus_read);
1118 
1119 /**
1120  * mdiobus_c45_read - Convenience function for reading a given MII mgmt register
1121  * @bus: the mii_bus struct
1122  * @addr: the phy address
1123  * @devad: device address to read
1124  * @regnum: register number to read
1125  *
1126  * NOTE: MUST NOT be called from interrupt context,
1127  * because the bus read/write functions may wait for an interrupt
1128  * to conclude the operation.
1129  */
mdiobus_c45_read(struct mii_bus * bus,int addr,int devad,u32 regnum)1130 int mdiobus_c45_read(struct mii_bus *bus, int addr, int devad, u32 regnum)
1131 {
1132 	int retval;
1133 
1134 	mutex_lock(&bus->mdio_lock);
1135 	retval = __mdiobus_c45_read(bus, addr, devad, regnum);
1136 	mutex_unlock(&bus->mdio_lock);
1137 
1138 	return retval;
1139 }
1140 EXPORT_SYMBOL(mdiobus_c45_read);
1141 
1142 /**
1143  * mdiobus_c45_read_nested - Nested version of the mdiobus_c45_read function
1144  * @bus: the mii_bus struct
1145  * @addr: the phy address
1146  * @devad: device address to read
1147  * @regnum: register number to read
1148  *
1149  * In case of nested MDIO bus access avoid lockdep false positives by
1150  * using mutex_lock_nested().
1151  *
1152  * NOTE: MUST NOT be called from interrupt context,
1153  * because the bus read/write functions may wait for an interrupt
1154  * to conclude the operation.
1155  */
mdiobus_c45_read_nested(struct mii_bus * bus,int addr,int devad,u32 regnum)1156 int mdiobus_c45_read_nested(struct mii_bus *bus, int addr, int devad,
1157 			    u32 regnum)
1158 {
1159 	int retval;
1160 
1161 	mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
1162 	retval = __mdiobus_c45_read(bus, addr, devad, regnum);
1163 	mutex_unlock(&bus->mdio_lock);
1164 
1165 	return retval;
1166 }
1167 EXPORT_SYMBOL(mdiobus_c45_read_nested);
1168 
1169 /**
1170  * mdiobus_write_nested - Nested version of the mdiobus_write function
1171  * @bus: the mii_bus struct
1172  * @addr: the phy address
1173  * @regnum: register number to write
1174  * @val: value to write to @regnum
1175  *
1176  * In case of nested MDIO bus access avoid lockdep false positives by
1177  * using mutex_lock_nested().
1178  *
1179  * NOTE: MUST NOT be called from interrupt context,
1180  * because the bus read/write functions may wait for an interrupt
1181  * to conclude the operation.
1182  */
mdiobus_write_nested(struct mii_bus * bus,int addr,u32 regnum,u16 val)1183 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
1184 {
1185 	int err;
1186 
1187 	mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
1188 	err = __mdiobus_write(bus, addr, regnum, val);
1189 	mutex_unlock(&bus->mdio_lock);
1190 
1191 	return err;
1192 }
1193 EXPORT_SYMBOL(mdiobus_write_nested);
1194 
1195 /**
1196  * mdiobus_write - Convenience function for writing a given MII mgmt register
1197  * @bus: the mii_bus struct
1198  * @addr: the phy address
1199  * @regnum: register number to write
1200  * @val: value to write to @regnum
1201  *
1202  * NOTE: MUST NOT be called from interrupt context,
1203  * because the bus read/write functions may wait for an interrupt
1204  * to conclude the operation.
1205  */
mdiobus_write(struct mii_bus * bus,int addr,u32 regnum,u16 val)1206 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
1207 {
1208 	int err;
1209 
1210 	mutex_lock(&bus->mdio_lock);
1211 	err = __mdiobus_write(bus, addr, regnum, val);
1212 	mutex_unlock(&bus->mdio_lock);
1213 
1214 	return err;
1215 }
1216 EXPORT_SYMBOL(mdiobus_write);
1217 
1218 /**
1219  * mdiobus_c45_write - Convenience function for writing a given MII mgmt register
1220  * @bus: the mii_bus struct
1221  * @addr: the phy address
1222  * @devad: device address to read
1223  * @regnum: register number to write
1224  * @val: value to write to @regnum
1225  *
1226  * NOTE: MUST NOT be called from interrupt context,
1227  * because the bus read/write functions may wait for an interrupt
1228  * to conclude the operation.
1229  */
mdiobus_c45_write(struct mii_bus * bus,int addr,int devad,u32 regnum,u16 val)1230 int mdiobus_c45_write(struct mii_bus *bus, int addr, int devad, u32 regnum,
1231 		      u16 val)
1232 {
1233 	int err;
1234 
1235 	mutex_lock(&bus->mdio_lock);
1236 	err = __mdiobus_c45_write(bus, addr, devad, regnum, val);
1237 	mutex_unlock(&bus->mdio_lock);
1238 
1239 	return err;
1240 }
1241 EXPORT_SYMBOL(mdiobus_c45_write);
1242 
1243 /**
1244  * mdiobus_c45_write_nested - Nested version of the mdiobus_c45_write function
1245  * @bus: the mii_bus struct
1246  * @addr: the phy address
1247  * @devad: device address to read
1248  * @regnum: register number to write
1249  * @val: value to write to @regnum
1250  *
1251  * In case of nested MDIO bus access avoid lockdep false positives by
1252  * using mutex_lock_nested().
1253  *
1254  * NOTE: MUST NOT be called from interrupt context,
1255  * because the bus read/write functions may wait for an interrupt
1256  * to conclude the operation.
1257  */
mdiobus_c45_write_nested(struct mii_bus * bus,int addr,int devad,u32 regnum,u16 val)1258 int mdiobus_c45_write_nested(struct mii_bus *bus, int addr, int devad,
1259 			     u32 regnum, u16 val)
1260 {
1261 	int err;
1262 
1263 	mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
1264 	err = __mdiobus_c45_write(bus, addr, devad, regnum, val);
1265 	mutex_unlock(&bus->mdio_lock);
1266 
1267 	return err;
1268 }
1269 EXPORT_SYMBOL(mdiobus_c45_write_nested);
1270 
1271 /*
1272  * __mdiobus_modify - Convenience function for modifying a given mdio device
1273  *	register
1274  * @bus: the mii_bus struct
1275  * @addr: the phy address
1276  * @regnum: register number to write
1277  * @mask: bit mask of bits to clear
1278  * @set: bit mask of bits to set
1279  */
__mdiobus_modify(struct mii_bus * bus,int addr,u32 regnum,u16 mask,u16 set)1280 int __mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask,
1281 		     u16 set)
1282 {
1283 	int err;
1284 
1285 	err = __mdiobus_modify_changed(bus, addr, regnum, mask, set);
1286 
1287 	return err < 0 ? err : 0;
1288 }
1289 EXPORT_SYMBOL_GPL(__mdiobus_modify);
1290 
1291 /**
1292  * mdiobus_modify - Convenience function for modifying a given mdio device
1293  *	register
1294  * @bus: the mii_bus struct
1295  * @addr: the phy address
1296  * @regnum: register number to write
1297  * @mask: bit mask of bits to clear
1298  * @set: bit mask of bits to set
1299  */
mdiobus_modify(struct mii_bus * bus,int addr,u32 regnum,u16 mask,u16 set)1300 int mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask, u16 set)
1301 {
1302 	int err;
1303 
1304 	mutex_lock(&bus->mdio_lock);
1305 	err = __mdiobus_modify(bus, addr, regnum, mask, set);
1306 	mutex_unlock(&bus->mdio_lock);
1307 
1308 	return err;
1309 }
1310 EXPORT_SYMBOL_GPL(mdiobus_modify);
1311 
1312 /**
1313  * mdiobus_c45_modify - Convenience function for modifying a given mdio device
1314  *	register
1315  * @bus: the mii_bus struct
1316  * @addr: the phy address
1317  * @devad: device address to read
1318  * @regnum: register number to write
1319  * @mask: bit mask of bits to clear
1320  * @set: bit mask of bits to set
1321  */
mdiobus_c45_modify(struct mii_bus * bus,int addr,int devad,u32 regnum,u16 mask,u16 set)1322 int mdiobus_c45_modify(struct mii_bus *bus, int addr, int devad, u32 regnum,
1323 		       u16 mask, u16 set)
1324 {
1325 	int err;
1326 
1327 	mutex_lock(&bus->mdio_lock);
1328 	err = __mdiobus_c45_modify_changed(bus, addr, devad, regnum,
1329 					   mask, set);
1330 	mutex_unlock(&bus->mdio_lock);
1331 
1332 	return err < 0 ? err : 0;
1333 }
1334 EXPORT_SYMBOL_GPL(mdiobus_c45_modify);
1335 
1336 /**
1337  * mdiobus_modify_changed - Convenience function for modifying a given mdio
1338  *	device register and returning if it changed
1339  * @bus: the mii_bus struct
1340  * @addr: the phy address
1341  * @regnum: register number to write
1342  * @mask: bit mask of bits to clear
1343  * @set: bit mask of bits to set
1344  */
mdiobus_modify_changed(struct mii_bus * bus,int addr,u32 regnum,u16 mask,u16 set)1345 int mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
1346 			   u16 mask, u16 set)
1347 {
1348 	int err;
1349 
1350 	mutex_lock(&bus->mdio_lock);
1351 	err = __mdiobus_modify_changed(bus, addr, regnum, mask, set);
1352 	mutex_unlock(&bus->mdio_lock);
1353 
1354 	return err;
1355 }
1356 EXPORT_SYMBOL_GPL(mdiobus_modify_changed);
1357 
1358 /**
1359  * mdiobus_c45_modify_changed - Convenience function for modifying a given mdio
1360  *	device register and returning if it changed
1361  * @bus: the mii_bus struct
1362  * @addr: the phy address
1363  * @devad: device address to read
1364  * @regnum: register number to write
1365  * @mask: bit mask of bits to clear
1366  * @set: bit mask of bits to set
1367  */
mdiobus_c45_modify_changed(struct mii_bus * bus,int addr,int devad,u32 regnum,u16 mask,u16 set)1368 int mdiobus_c45_modify_changed(struct mii_bus *bus, int addr, int devad,
1369 			       u32 regnum, u16 mask, u16 set)
1370 {
1371 	int err;
1372 
1373 	mutex_lock(&bus->mdio_lock);
1374 	err = __mdiobus_c45_modify_changed(bus, addr, devad, regnum, mask, set);
1375 	mutex_unlock(&bus->mdio_lock);
1376 
1377 	return err;
1378 }
1379 EXPORT_SYMBOL_GPL(mdiobus_c45_modify_changed);
1380 
1381 /**
1382  * mdio_bus_match - determine if given MDIO driver supports the given
1383  *		    MDIO device
1384  * @dev: target MDIO device
1385  * @drv: given MDIO driver
1386  *
1387  * Description: Given a MDIO device, and a MDIO driver, return 1 if
1388  *   the driver supports the device.  Otherwise, return 0. This may
1389  *   require calling the devices own match function, since different classes
1390  *   of MDIO devices have different match criteria.
1391  */
mdio_bus_match(struct device * dev,const struct device_driver * drv)1392 static int mdio_bus_match(struct device *dev, const struct device_driver *drv)
1393 {
1394 	const struct mdio_driver *mdiodrv = to_mdio_driver(drv);
1395 	struct mdio_device *mdio = to_mdio_device(dev);
1396 
1397 	/* Both the driver and device must type-match */
1398 	if (!(mdiodrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY) !=
1399 	    !(mdio->flags & MDIO_DEVICE_FLAG_PHY))
1400 		return 0;
1401 
1402 	if (of_driver_match_device(dev, drv))
1403 		return 1;
1404 
1405 	if (mdio->bus_match)
1406 		return mdio->bus_match(dev, drv);
1407 
1408 	return 0;
1409 }
1410 
mdio_uevent(const struct device * dev,struct kobj_uevent_env * env)1411 static int mdio_uevent(const struct device *dev, struct kobj_uevent_env *env)
1412 {
1413 	int rc;
1414 
1415 	/* Some devices have extra OF data and an OF-style MODALIAS */
1416 	rc = of_device_uevent_modalias(dev, env);
1417 	if (rc != -ENODEV)
1418 		return rc;
1419 
1420 	return 0;
1421 }
1422 
1423 static struct attribute *mdio_bus_device_statistics_attrs[] = {
1424 	&dev_attr_mdio_bus_device_transfers.attr.attr,
1425 	&dev_attr_mdio_bus_device_errors.attr.attr,
1426 	&dev_attr_mdio_bus_device_writes.attr.attr,
1427 	&dev_attr_mdio_bus_device_reads.attr.attr,
1428 	NULL,
1429 };
1430 
1431 static const struct attribute_group mdio_bus_device_statistics_group = {
1432 	.name	= "statistics",
1433 	.attrs	= mdio_bus_device_statistics_attrs,
1434 };
1435 
1436 static const struct attribute_group *mdio_bus_dev_groups[] = {
1437 	&mdio_bus_device_statistics_group,
1438 	NULL,
1439 };
1440 
1441 const struct bus_type mdio_bus_type = {
1442 	.name		= "mdio_bus",
1443 	.dev_groups	= mdio_bus_dev_groups,
1444 	.match		= mdio_bus_match,
1445 	.uevent		= mdio_uevent,
1446 };
1447 EXPORT_SYMBOL(mdio_bus_type);
1448 
mdio_bus_init(void)1449 int __init mdio_bus_init(void)
1450 {
1451 	int ret;
1452 
1453 	ret = class_register(&mdio_bus_class);
1454 	if (!ret) {
1455 		ret = bus_register(&mdio_bus_type);
1456 		if (ret)
1457 			class_unregister(&mdio_bus_class);
1458 	}
1459 
1460 	return ret;
1461 }
1462 
1463 #if IS_ENABLED(CONFIG_PHYLIB)
mdio_bus_exit(void)1464 void mdio_bus_exit(void)
1465 {
1466 	class_unregister(&mdio_bus_class);
1467 	bus_unregister(&mdio_bus_type);
1468 }
1469 EXPORT_SYMBOL_GPL(mdio_bus_exit);
1470 #else
1471 module_init(mdio_bus_init);
1472 /* no module_exit, intentional */
1473 MODULE_LICENSE("GPL");
1474 MODULE_DESCRIPTION("MDIO bus/device layer");
1475 #endif
1476