[deliverable/linux.git] / drivers / net / phy / mdio_bus.c

/*
 * drivers/net/phy/mdio_bus.c
 *
 * MDIO Bus interface
 *
 * Author: Andy Fleming
 *
 * Copyright (c) 2004 Freescale Semiconductor, Inc.
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/unistd.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/of_device.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/module.h>
#include <linux/mii.h>
#include <linux/ethtool.h>
#include <linux/phy.h>

#include <asm/io.h>
#include <asm/irq.h>
#include <asm/uaccess.h>

/**
 * mdiobus_alloc_size - allocate a mii_bus structure
 * @size: extra amount of memory to allocate for private storage.
 * If non-zero, then bus->priv is points to that memory.
 *
 * Description: called by a bus driver to allocate an mii_bus
 * structure to fill in.
 */
struct mii_bus *mdiobus_alloc_size(size_t size)
{
	struct mii_bus *bus;
	size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
	size_t alloc_size;

	/* If we alloc extra space, it should be aligned */
	if (size)
		alloc_size = aligned_size + size;
	else
		alloc_size = sizeof(*bus);

	bus = kzalloc(alloc_size, GFP_KERNEL);
	if (bus) {
		bus->state = MDIOBUS_ALLOCATED;
		if (size)
			bus->priv = (void *)bus + aligned_size;
	}

	return bus;
}
EXPORT_SYMBOL(mdiobus_alloc_size);

/**
 * mdiobus_release - mii_bus device release callback
 * @d: the target struct device that contains the mii_bus
 *
 * Description: called when the last reference to an mii_bus is
 * dropped, to free the underlying memory.
 */
static void mdiobus_release(struct device *d)
{
	struct mii_bus *bus = to_mii_bus(d);
	BUG_ON(bus->state != MDIOBUS_RELEASED &&
	       /* for compatibility with error handling in drivers */
	       bus->state != MDIOBUS_ALLOCATED);
	kfree(bus);
}

static struct class mdio_bus_class = {
	.name		= "mdio_bus",
	.dev_release	= mdiobus_release,
};

#if IS_ENABLED(CONFIG_OF_MDIO)
/* Helper function for of_mdio_find_bus */
static int of_mdio_bus_match(struct device *dev, void *mdio_bus_np)
{
	return dev->of_node == mdio_bus_np;
}
/**
 * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
 * @mdio_bus_np: Pointer to the mii_bus.
 *
 * Returns a pointer to the mii_bus, or NULL if none found.
 *
 * Because the association of a device_node and mii_bus is made via
 * of_mdiobus_register(), the mii_bus cannot be found before it is
 * registered with of_mdiobus_register().
 *
 */
struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
{
	struct device *d;

	if (!mdio_bus_np)
		return NULL;

	d = class_find_device(&mdio_bus_class, NULL,  mdio_bus_np,
			      of_mdio_bus_match);

	return d ? to_mii_bus(d) : NULL;
}
EXPORT_SYMBOL(of_mdio_find_bus);
#endif

/**
 * mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
 * @bus: target mii_bus
 *
 * Description: Called by a bus driver to bring up all the PHYs
 *   on a given bus, and attach them to the bus.
 *
 * Returns 0 on success or < 0 on error.
 */
int mdiobus_register(struct mii_bus *bus)
{
	int i, err;

	if (NULL == bus || NULL == bus->name ||
			NULL == bus->read ||
			NULL == bus->write)
		return -EINVAL;

	BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
	       bus->state != MDIOBUS_UNREGISTERED);

	bus->dev.parent = bus->parent;
	bus->dev.class = &mdio_bus_class;
	bus->dev.groups = NULL;
	dev_set_name(&bus->dev, "%s", bus->id);

	err = device_register(&bus->dev);
	if (err) {
		pr_err("mii_bus %s failed to register\n", bus->id);
		return -EINVAL;
	}

	mutex_init(&bus->mdio_lock);

	if (bus->reset)
		bus->reset(bus);

	for (i = 0; i < PHY_MAX_ADDR; i++) {
		if ((bus->phy_mask & (1 << i)) == 0) {
			struct phy_device *phydev;

			phydev = mdiobus_scan(bus, i);
			if (IS_ERR(phydev)) {
				err = PTR_ERR(phydev);
				goto error;
			}
		}
	}

	bus->state = MDIOBUS_REGISTERED;
	pr_info("%s: probed\n", bus->name);
	return 0;

error:
	while (--i >= 0) {
		if (bus->phy_map[i])
			device_unregister(&bus->phy_map[i]->dev);
	}
	device_del(&bus->dev);
	return err;
}
EXPORT_SYMBOL(mdiobus_register);

void mdiobus_unregister(struct mii_bus *bus)
{
	int i;

	BUG_ON(bus->state != MDIOBUS_REGISTERED);
	bus->state = MDIOBUS_UNREGISTERED;

	device_del(&bus->dev);
	for (i = 0; i < PHY_MAX_ADDR; i++) {
		if (bus->phy_map[i])
			device_unregister(&bus->phy_map[i]->dev);
		bus->phy_map[i] = NULL;
	}
}
EXPORT_SYMBOL(mdiobus_unregister);

/**
 * mdiobus_free - free a struct mii_bus
 * @bus: mii_bus to free
 *
 * This function releases the reference to the underlying device
 * object in the mii_bus.  If this is the last reference, the mii_bus
 * will be freed.
 */
void mdiobus_free(struct mii_bus *bus)
{
	/*
	 * For compatibility with error handling in drivers.
	 */
	if (bus->state == MDIOBUS_ALLOCATED) {
		kfree(bus);
		return;
	}

	BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
	bus->state = MDIOBUS_RELEASED;

	put_device(&bus->dev);
}
EXPORT_SYMBOL(mdiobus_free);

struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
{
	struct phy_device *phydev;
	int err;

	phydev = get_phy_device(bus, addr, false);
	if (IS_ERR(phydev) || phydev == NULL)
		return phydev;

	err = phy_device_register(phydev);
	if (err) {
		phy_device_free(phydev);
		return NULL;
	}

	return phydev;
}
EXPORT_SYMBOL(mdiobus_scan);

/**
 * mdiobus_read - Convenience function for reading a given MII mgmt register
 * @bus: the mii_bus struct
 * @addr: the phy address
 * @regnum: register number to read
 *
 * NOTE: MUST NOT be called from interrupt context,
 * because the bus read/write functions may wait for an interrupt
 * to conclude the operation.
 */
int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
{
	int retval;

	BUG_ON(in_interrupt());

	mutex_lock(&bus->mdio_lock);
	retval = bus->read(bus, addr, regnum);
	mutex_unlock(&bus->mdio_lock);

	return retval;
}
EXPORT_SYMBOL(mdiobus_read);

/**
 * mdiobus_write - Convenience function for writing a given MII mgmt register
 * @bus: the mii_bus struct
 * @addr: the phy address
 * @regnum: register number to write
 * @val: value to write to @regnum
 *
 * NOTE: MUST NOT be called from interrupt context,
 * because the bus read/write functions may wait for an interrupt
 * to conclude the operation.
 */
int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
{
	int err;

	BUG_ON(in_interrupt());

	mutex_lock(&bus->mdio_lock);
	err = bus->write(bus, addr, regnum, val);
	mutex_unlock(&bus->mdio_lock);

	return err;
}
EXPORT_SYMBOL(mdiobus_write);

/**
 * mdio_bus_match - determine if given PHY driver supports the given PHY device
 * @dev: target PHY device
 * @drv: given PHY driver
 *
 * Description: Given a PHY device, and a PHY driver, return 1 if
 *   the driver supports the device.  Otherwise, return 0.
 */
static int mdio_bus_match(struct device *dev, struct device_driver *drv)
{
	struct phy_device *phydev = to_phy_device(dev);
	struct phy_driver *phydrv = to_phy_driver(drv);

	if (of_driver_match_device(dev, drv))
		return 1;

	if (phydrv->match_phy_device)
		return phydrv->match_phy_device(phydev);

	return ((phydrv->phy_id & phydrv->phy_id_mask) ==
		(phydev->phy_id & phydrv->phy_id_mask));
}

#ifdef CONFIG_PM

static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
{
	struct device_driver *drv = phydev->dev.driver;
	struct phy_driver *phydrv = to_phy_driver(drv);
	struct net_device *netdev = phydev->attached_dev;

	if (!drv || !phydrv->suspend)
		return false;

	/* PHY not attached? May suspend. */
	if (!netdev)
		return true;

	/*
	 * Don't suspend PHY if the attched netdev parent may wakeup.
	 * The parent may point to a PCI device, as in tg3 driver.
	 */
	if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
		return false;

	/*
	 * Also don't suspend PHY if the netdev itself may wakeup. This
	 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
	 * e.g. SoC devices.
	 */
	if (device_may_wakeup(&netdev->dev))
		return false;

	return true;
}

static int mdio_bus_suspend(struct device *dev)
{
	struct phy_driver *phydrv = to_phy_driver(dev->driver);
	struct phy_device *phydev = to_phy_device(dev);

	/*
	 * We must stop the state machine manually, otherwise it stops out of
	 * control, possibly with the phydev->lock held. Upon resume, netdev
	 * may call phy routines that try to grab the same lock, and that may
	 * lead to a deadlock.
	 */
	if (phydev->attached_dev && phydev->adjust_link)
		phy_stop_machine(phydev);

	if (!mdio_bus_phy_may_suspend(phydev))
		return 0;

	return phydrv->suspend(phydev);
}

static int mdio_bus_resume(struct device *dev)
{
	struct phy_driver *phydrv = to_phy_driver(dev->driver);
	struct phy_device *phydev = to_phy_device(dev);
	int ret;

	if (!mdio_bus_phy_may_suspend(phydev))
		goto no_resume;

	ret = phydrv->resume(phydev);
	if (ret < 0)
		return ret;

no_resume:
	if (phydev->attached_dev && phydev->adjust_link)
		phy_start_machine(phydev, NULL);

	return 0;
}

static int mdio_bus_restore(struct device *dev)
{
	struct phy_device *phydev = to_phy_device(dev);
	struct net_device *netdev = phydev->attached_dev;
	int ret;

	if (!netdev)
		return 0;

	ret = phy_init_hw(phydev);
	if (ret < 0)
		return ret;

	/* The PHY needs to renegotiate. */
	phydev->link = 0;
	phydev->state = PHY_UP;

	phy_start_machine(phydev, NULL);

	return 0;
}

static struct dev_pm_ops mdio_bus_pm_ops = {
	.suspend = mdio_bus_suspend,
	.resume = mdio_bus_resume,
	.freeze = mdio_bus_suspend,
	.thaw = mdio_bus_resume,
	.restore = mdio_bus_restore,
};

#define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)

#else

#define MDIO_BUS_PM_OPS NULL

#endif /* CONFIG_PM */

struct bus_type mdio_bus_type = {
	.name		= "mdio_bus",
	.match		= mdio_bus_match,
	.pm		= MDIO_BUS_PM_OPS,
};
EXPORT_SYMBOL(mdio_bus_type);

int __init mdio_bus_init(void)
{
	int ret;

	ret = class_register(&mdio_bus_class);
	if (!ret) {
		ret = bus_register(&mdio_bus_type);
		if (ret)
			class_unregister(&mdio_bus_class);
	}

	return ret;
}

void mdio_bus_exit(void)
{
	class_unregister(&mdio_bus_class);
	bus_unregister(&mdio_bus_type);
}
Commit	Line	Data
00db8189 AF	1	/*
	2	* drivers/net/phy/mdio_bus.c
	3	*
	4	* MDIO Bus interface
	5	*
	6	* Author: Andy Fleming
	7	*
	8	* Copyright (c) 2004 Freescale Semiconductor, Inc.
	9	*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the
	12	* Free Software Foundation; either version 2 of the License, or (at your
	13	* option) any later version.
	14	*
	15	*/
8d242488 JP	16
	17	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	18
00db8189	19	#include <linux/kernel.h>
00db8189 AF	20	#include <linux/string.h>
	21	#include <linux/errno.h>
	22	#include <linux/unistd.h>
	23	#include <linux/slab.h>
	24	#include <linux/interrupt.h>
	25	#include <linux/init.h>
	26	#include <linux/delay.h>
3d1e4db2	27	#include <linux/device.h>
a30e2c18	28	#include <linux/of_device.h>
00db8189 AF	29	#include <linux/netdevice.h>
	30	#include <linux/etherdevice.h>
	31	#include <linux/skbuff.h>
	32	#include <linux/spinlock.h>
	33	#include <linux/mm.h>
	34	#include <linux/module.h>
00db8189 AF	35	#include <linux/mii.h>
	36	#include <linux/ethtool.h>
	37	#include <linux/phy.h>
	38
	39	#include <asm/io.h>
	40	#include <asm/irq.h>
	41	#include <asm/uaccess.h>
	42
298cf9be	43	/**
eb8a54a7	44	* mdiobus_alloc_size - allocate a mii_bus structure
af58f1d6 RD	45	* @size: extra amount of memory to allocate for private storage.
af58f1d6 RD	46	* If non-zero, then bus->priv is points to that memory.
298cf9be LB	47	*
	48	* Description: called by a bus driver to allocate an mii_bus
	49	* structure to fill in.
	50	*/
eb8a54a7	51	struct mii_bus *mdiobus_alloc_size(size_t size)
298cf9be	52	{
46abc021	53	struct mii_bus *bus;
eb8a54a7 TT	54	size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
	55	size_t alloc_size;
	56
	57	/* If we alloc extra space, it should be aligned */
	58	if (size)
	59	alloc_size = aligned_size + size;
	60	else
	61	alloc_size = sizeof(*bus);
46abc021	62
eb8a54a7 TT	63	bus = kzalloc(alloc_size, GFP_KERNEL);
eb8a54a7 TT	64	if (bus) {
46abc021	65	bus->state = MDIOBUS_ALLOCATED;
eb8a54a7 TT	66	if (size)
	67	bus->priv = (void *)bus + aligned_size;
	68	}
46abc021 LB	69
46abc021 LB	70	return bus;
298cf9be	71	}
eb8a54a7	72	EXPORT_SYMBOL(mdiobus_alloc_size);
298cf9be	73
46abc021 LB	74	/**
46abc021 LB	75	* mdiobus_release - mii_bus device release callback
78c36b15	76	* @d: the target struct device that contains the mii_bus
46abc021 LB	77	*
	78	* Description: called when the last reference to an mii_bus is
	79	* dropped, to free the underlying memory.
	80	*/
	81	static void mdiobus_release(struct device *d)
	82	{
	83	struct mii_bus *bus = to_mii_bus(d);
161c8d2f KH	84	BUG_ON(bus->state != MDIOBUS_RELEASED &&
	85	/* for compatibility with error handling in drivers */
	86	bus->state != MDIOBUS_ALLOCATED);
46abc021 LB	87	kfree(bus);
	88	}
	89
	90	static struct class mdio_bus_class = {
	91	.name = "mdio_bus",
	92	.dev_release = mdiobus_release,
	93	};
	94
b943fbb0	95	#if IS_ENABLED(CONFIG_OF_MDIO)
25106022 DD	96	/* Helper function for of_mdio_find_bus */
	97	static int of_mdio_bus_match(struct device dev, void mdio_bus_np)
	98	{
	99	return dev->of_node == mdio_bus_np;
	100	}
	101	/**
	102	* of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
f41ef2e7	103	* @mdio_bus_np: Pointer to the mii_bus.
25106022 DD	104	*
	105	* Returns a pointer to the mii_bus, or NULL if none found.
	106	*
	107	* Because the association of a device_node and mii_bus is made via
	108	* of_mdiobus_register(), the mii_bus cannot be found before it is
	109	* registered with of_mdiobus_register().
	110	*
	111	*/
	112	struct mii_bus of_mdio_find_bus(struct device_node mdio_bus_np)
	113	{
	114	struct device *d;
	115
	116	if (!mdio_bus_np)
	117	return NULL;
	118
	119	d = class_find_device(&mdio_bus_class, NULL, mdio_bus_np,
	120	of_mdio_bus_match);
	121
	122	return d ? to_mii_bus(d) : NULL;
	123	}
	124	EXPORT_SYMBOL(of_mdio_find_bus);
	125	#endif
	126
b3df0da8 RD	127	/**
	128	* mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
	129	* @bus: target mii_bus
e1393456	130	*
b3df0da8 RD	131	* Description: Called by a bus driver to bring up all the PHYs
	132	* on a given bus, and attach them to the bus.
	133	*
	134	* Returns 0 on success or < 0 on error.
e1393456 AF	135	*/
	136	int mdiobus_register(struct mii_bus *bus)
	137	{
161c8d2f	138	int i, err;
e1393456	139
e1393456 AF	140	if (NULL == bus \|\| NULL == bus->name \|\|
	141	NULL == bus->read \|\|
	142	NULL == bus->write)
	143	return -EINVAL;
	144
46abc021 LB	145	BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
	146	bus->state != MDIOBUS_UNREGISTERED);
	147
	148	bus->dev.parent = bus->parent;
	149	bus->dev.class = &mdio_bus_class;
	150	bus->dev.groups = NULL;
036b6687	151	dev_set_name(&bus->dev, "%s", bus->id);
46abc021 LB	152
	153	err = device_register(&bus->dev);
	154	if (err) {
8d242488	155	pr_err("mii_bus %s failed to register\n", bus->id);
46abc021 LB	156	return -EINVAL;
	157	}
	158
d1e7fe4d AB	159	mutex_init(&bus->mdio_lock);
d1e7fe4d AB	160
e1393456 AF	161	if (bus->reset)
	162	bus->reset(bus);
	163
	164	for (i = 0; i < PHY_MAX_ADDR; i++) {
4fd5f812 LB	165	if ((bus->phy_mask & (1 << i)) == 0) {
4fd5f812 LB	166	struct phy_device *phydev;
e1393456	167
4fd5f812	168	phydev = mdiobus_scan(bus, i);
161c8d2f	169	if (IS_ERR(phydev)) {
4fd5f812	170	err = PTR_ERR(phydev);
161c8d2f KH	171	goto error;
161c8d2f KH	172	}
64b1c2b4	173	}
e1393456 AF	174	}
e1393456 AF	175
161c8d2f	176	bus->state = MDIOBUS_REGISTERED;
e1393456	177	pr_info("%s: probed\n", bus->name);
161c8d2f	178	return 0;
e1393456	179
161c8d2f KH	180	error:
	181	while (--i >= 0) {
	182	if (bus->phy_map[i])
	183	device_unregister(&bus->phy_map[i]->dev);
	184	}
	185	device_del(&bus->dev);
e1393456 AF	186	return err;
	187	}
	188	EXPORT_SYMBOL(mdiobus_register);
	189
	190	void mdiobus_unregister(struct mii_bus *bus)
	191	{
	192	int i;
	193
46abc021 LB	194	BUG_ON(bus->state != MDIOBUS_REGISTERED);
	195	bus->state = MDIOBUS_UNREGISTERED;
	196
3e44017b	197	device_del(&bus->dev);
e1393456	198	for (i = 0; i < PHY_MAX_ADDR; i++) {
6f4a7f41	199	if (bus->phy_map[i])
e1393456	200	device_unregister(&bus->phy_map[i]->dev);
4dea547f	201	bus->phy_map[i] = NULL;
e1393456 AF	202	}
	203	}
	204	EXPORT_SYMBOL(mdiobus_unregister);
	205
298cf9be LB	206	/**
	207	* mdiobus_free - free a struct mii_bus
	208	* @bus: mii_bus to free
	209	*
46abc021 LB	210	* This function releases the reference to the underlying device
	211	* object in the mii_bus. If this is the last reference, the mii_bus
	212	* will be freed.
298cf9be LB	213	*/
	214	void mdiobus_free(struct mii_bus *bus)
	215	{
46abc021 LB	216	/*
	217	* For compatibility with error handling in drivers.
	218	*/
	219	if (bus->state == MDIOBUS_ALLOCATED) {
	220	kfree(bus);
	221	return;
	222	}
	223
	224	BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
	225	bus->state = MDIOBUS_RELEASED;
	226
	227	put_device(&bus->dev);
298cf9be LB	228	}
	229	EXPORT_SYMBOL(mdiobus_free);
	230
4fd5f812 LB	231	struct phy_device mdiobus_scan(struct mii_bus bus, int addr)
	232	{
	233	struct phy_device *phydev;
	234	int err;
	235
ac28b9f8	236	phydev = get_phy_device(bus, addr, false);
4fd5f812 LB	237	if (IS_ERR(phydev) \|\| phydev == NULL)
	238	return phydev;
	239
4dea547f	240	err = phy_device_register(phydev);
4fd5f812	241	if (err) {
4fd5f812	242	phy_device_free(phydev);
4dea547f	243	return NULL;
4fd5f812 LB	244	}
4fd5f812 LB	245
4fd5f812 LB	246	return phydev;
	247	}
	248	EXPORT_SYMBOL(mdiobus_scan);
	249
2e888103 LB	250	/**
	251	* mdiobus_read - Convenience function for reading a given MII mgmt register
	252	* @bus: the mii_bus struct
	253	* @addr: the phy address
	254	* @regnum: register number to read
	255	*
	256	* NOTE: MUST NOT be called from interrupt context,
	257	* because the bus read/write functions may wait for an interrupt
	258	* to conclude the operation.
	259	*/
abf35df2	260	int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
2e888103 LB	261	{
	262	int retval;
	263
	264	BUG_ON(in_interrupt());
	265
	266	mutex_lock(&bus->mdio_lock);
	267	retval = bus->read(bus, addr, regnum);
	268	mutex_unlock(&bus->mdio_lock);
	269
	270	return retval;
	271	}
	272	EXPORT_SYMBOL(mdiobus_read);
	273
	274	/**
	275	* mdiobus_write - Convenience function for writing a given MII mgmt register
	276	* @bus: the mii_bus struct
	277	* @addr: the phy address
	278	* @regnum: register number to write
	279	* @val: value to write to @regnum
	280	*
	281	* NOTE: MUST NOT be called from interrupt context,
	282	* because the bus read/write functions may wait for an interrupt
	283	* to conclude the operation.
	284	*/
abf35df2	285	int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
2e888103 LB	286	{
	287	int err;
	288
	289	BUG_ON(in_interrupt());
	290
	291	mutex_lock(&bus->mdio_lock);
	292	err = bus->write(bus, addr, regnum, val);
	293	mutex_unlock(&bus->mdio_lock);
	294
	295	return err;
	296	}
	297	EXPORT_SYMBOL(mdiobus_write);
	298
b3df0da8 RD	299	/**
	300	* mdio_bus_match - determine if given PHY driver supports the given PHY device
	301	* @dev: target PHY device
	302	* @drv: given PHY driver
00db8189	303	*
b3df0da8 RD	304	* Description: Given a PHY device, and a PHY driver, return 1 if
b3df0da8 RD	305	* the driver supports the device. Otherwise, return 0.
00db8189 AF	306	*/
	307	static int mdio_bus_match(struct device dev, struct device_driver drv)
	308	{
	309	struct phy_device *phydev = to_phy_device(dev);
	310	struct phy_driver *phydrv = to_phy_driver(drv);
	311
a30e2c18 DD	312	if (of_driver_match_device(dev, drv))
	313	return 1;
	314
	315	if (phydrv->match_phy_device)
	316	return phydrv->match_phy_device(phydev);
	317
5f708dd9 KG	318	return ((phydrv->phy_id & phydrv->phy_id_mask) ==
5f708dd9 KG	319	(phydev->phy_id & phydrv->phy_id_mask));
00db8189 AF	320	}
00db8189 AF	321
2f5cb434 AV	322	#ifdef CONFIG_PM
2f5cb434 AV	323
3d1e4db2 AV	324	static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
	325	{
	326	struct device_driver *drv = phydev->dev.driver;
	327	struct phy_driver *phydrv = to_phy_driver(drv);
	328	struct net_device *netdev = phydev->attached_dev;
	329
	330	if (!drv \|\| !phydrv->suspend)
	331	return false;
	332
	333	/* PHY not attached? May suspend. */
	334	if (!netdev)
	335	return true;
	336
	337	/*
	338	* Don't suspend PHY if the attched netdev parent may wakeup.
	339	* The parent may point to a PCI device, as in tg3 driver.
	340	*/
	341	if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
	342	return false;
	343
	344	/*
	345	* Also don't suspend PHY if the netdev itself may wakeup. This
	346	* is the case for devices w/o underlaying pwr. mgmt. aware bus,
	347	* e.g. SoC devices.
	348	*/
	349	if (device_may_wakeup(&netdev->dev))
	350	return false;
	351
	352	return true;
	353	}
	354
2f5cb434	355	static int mdio_bus_suspend(struct device *dev)
00db8189	356	{
3d1e4db2	357	struct phy_driver *phydrv = to_phy_driver(dev->driver);
0f0ca340	358	struct phy_device *phydev = to_phy_device(dev);
00db8189	359
541cd3ee AV	360	/*
	361	* We must stop the state machine manually, otherwise it stops out of
	362	* control, possibly with the phydev->lock held. Upon resume, netdev
	363	* may call phy routines that try to grab the same lock, and that may
	364	* lead to a deadlock.
	365	*/
fddd9101	366	if (phydev->attached_dev && phydev->adjust_link)
541cd3ee AV	367	phy_stop_machine(phydev);
541cd3ee AV	368
3d1e4db2 AV	369	if (!mdio_bus_phy_may_suspend(phydev))
3d1e4db2 AV	370	return 0;
541cd3ee	371
3d1e4db2	372	return phydrv->suspend(phydev);
00db8189 AF	373	}
00db8189 AF	374
2f5cb434	375	static int mdio_bus_resume(struct device *dev)
00db8189	376	{
3d1e4db2	377	struct phy_driver *phydrv = to_phy_driver(dev->driver);
0f0ca340	378	struct phy_device *phydev = to_phy_device(dev);
541cd3ee	379	int ret;
00db8189	380
3d1e4db2	381	if (!mdio_bus_phy_may_suspend(phydev))
541cd3ee AV	382	goto no_resume;
	383
	384	ret = phydrv->resume(phydev);
	385	if (ret < 0)
	386	return ret;
	387
	388	no_resume:
fddd9101	389	if (phydev->attached_dev && phydev->adjust_link)
541cd3ee AV	390	phy_start_machine(phydev, NULL);
	391
	392	return 0;
00db8189 AF	393	}
00db8189 AF	394
2f5cb434 AV	395	static int mdio_bus_restore(struct device *dev)
	396	{
	397	struct phy_device *phydev = to_phy_device(dev);
	398	struct net_device *netdev = phydev->attached_dev;
	399	int ret;
	400
	401	if (!netdev)
	402	return 0;
	403
	404	ret = phy_init_hw(phydev);
	405	if (ret < 0)
	406	return ret;
	407
	408	/* The PHY needs to renegotiate. */
	409	phydev->link = 0;
	410	phydev->state = PHY_UP;
	411
	412	phy_start_machine(phydev, NULL);
	413
	414	return 0;
	415	}
	416
	417	static struct dev_pm_ops mdio_bus_pm_ops = {
	418	.suspend = mdio_bus_suspend,
	419	.resume = mdio_bus_resume,
	420	.freeze = mdio_bus_suspend,
	421	.thaw = mdio_bus_resume,
	422	.restore = mdio_bus_restore,
	423	};
	424
	425	#define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
	426
	427	#else
	428
	429	#define MDIO_BUS_PM_OPS NULL
	430
	431	#endif /* CONFIG_PM */
	432
00db8189 AF	433	struct bus_type mdio_bus_type = {
	434	.name = "mdio_bus",
	435	.match = mdio_bus_match,
2f5cb434	436	.pm = MDIO_BUS_PM_OPS,
00db8189	437	};
11b0bacd	438	EXPORT_SYMBOL(mdio_bus_type);
00db8189	439
67c4f3fa	440	int __init mdio_bus_init(void)
00db8189	441	{
46abc021 LB	442	int ret;
	443
	444	ret = class_register(&mdio_bus_class);
	445	if (!ret) {
	446	ret = bus_register(&mdio_bus_type);
	447	if (ret)
	448	class_unregister(&mdio_bus_class);
	449	}
	450
	451	return ret;
00db8189 AF	452	}
00db8189 AF	453
dc85dec6	454	void mdio_bus_exit(void)
e1393456	455	{
46abc021	456	class_unregister(&mdio_bus_class);
e1393456 AF	457	bus_unregister(&mdio_bus_type);
e1393456 AF	458	}