[mirror_ubuntu-bionic-kernel.git] / drivers / of / of_mdio.c

/*
 * OF helpers for the MDIO (Ethernet PHY) API
 *
 * Copyright (c) 2009 Secret Lab Technologies, Ltd.
 *
 * This file is released under the GPLv2
 *
 * This file provides helper functions for extracting PHY device information
 * out of the OpenFirmware device tree and using it to populate an mii_bus.
 */

#include <linux/kernel.h>
#include <linux/device.h>
#include <linux/netdevice.h>
#include <linux/err.h>
#include <linux/phy.h>
#include <linux/phy_fixed.h>
#include <linux/of.h>
#include <linux/of_gpio.h>
#include <linux/of_irq.h>
#include <linux/of_mdio.h>
#include <linux/of_net.h>
#include <linux/module.h>

MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
MODULE_LICENSE("GPL");

/* Extract the clause 22 phy ID from the compatible string of the form
 * ethernet-phy-idAAAA.BBBB */
static int of_get_phy_id(struct device_node *device, u32 *phy_id)
{
	struct property *prop;
	const char *cp;
	unsigned int upper, lower;

	of_property_for_each_string(device, "compatible", prop, cp) {
		if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
			*phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF);
			return 0;
		}
	}
	return -EINVAL;
}

static void of_mdiobus_register_phy(struct mii_bus *mdio,
				    struct device_node *child, u32 addr)
{
	struct phy_device *phy;
	bool is_c45;
	int rc;
	u32 phy_id;

	is_c45 = of_device_is_compatible(child,
					 "ethernet-phy-ieee802.3-c45");

	if (!is_c45 && !of_get_phy_id(child, &phy_id))
		phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
	else
		phy = get_phy_device(mdio, addr, is_c45);
	if (IS_ERR(phy))
		return;

	rc = irq_of_parse_and_map(child, 0);
	if (rc > 0) {
		phy->irq = rc;
		mdio->irq[addr] = rc;
	} else {
		phy->irq = mdio->irq[addr];
	}

	if (of_property_read_bool(child, "broken-turn-around"))
		mdio->phy_ignore_ta_mask |= 1 << addr;

	/* Associate the OF node with the device structure so it
	 * can be looked up later */
	of_node_get(child);
	phy->mdio.dev.of_node = child;

	/* All data is now stored in the phy struct;
	 * register it */
	rc = phy_device_register(phy);
	if (rc) {
		phy_device_free(phy);
		of_node_put(child);
		return;
	}

	dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
		child->name, addr);
}

static void of_mdiobus_register_device(struct mii_bus *mdio,
				       struct device_node *child, u32 addr)
{
	struct mdio_device *mdiodev;
	int rc;

	mdiodev = mdio_device_create(mdio, addr);
	if (IS_ERR(mdiodev))
		return;

	/* Associate the OF node with the device structure so it
	 * can be looked up later.
	 */
	of_node_get(child);
	mdiodev->dev.of_node = child;

	/* All data is now stored in the mdiodev struct; register it. */
	rc = mdio_device_register(mdiodev);
	if (rc) {
		mdio_device_free(mdiodev);
		of_node_put(child);
		return;
	}

	dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n",
		child->name, addr);
}

int of_mdio_parse_addr(struct device *dev, const struct device_node *np)
{
	u32 addr;
	int ret;

	ret = of_property_read_u32(np, "reg", &addr);
	if (ret < 0) {
		dev_err(dev, "%s has invalid PHY address\n", np->full_name);
		return ret;
	}

	/* A PHY must have a reg property in the range [0-31] */
	if (addr >= PHY_MAX_ADDR) {
		dev_err(dev, "%s PHY address %i is too large\n",
			np->full_name, addr);
		return -EINVAL;
	}

	return addr;
}
EXPORT_SYMBOL(of_mdio_parse_addr);

/* The following is a list of PHY compatible strings which appear in
 * some DTBs. The compatible string is never matched against a PHY
 * driver, so is pointless. We only expect devices which are not PHYs
 * to have a compatible string, so they can be matched to an MDIO
 * driver.  Encourage users to upgrade their DT blobs to remove these.
 */
static const struct of_device_id whitelist_phys[] = {
	{ .compatible = "brcm,40nm-ephy" },
	{ .compatible = "marvell,88E1111", },
	{ .compatible = "marvell,88e1116", },
	{ .compatible = "marvell,88e1118", },
	{ .compatible = "marvell,88e1145", },
	{ .compatible = "marvell,88e1149r", },
	{ .compatible = "marvell,88e1310", },
	{ .compatible = "marvell,88E1510", },
	{ .compatible = "marvell,88E1514", },
	{ .compatible = "moxa,moxart-rtl8201cp", },
	{}
};

/*
 * Return true if the child node is for a phy. It must either:
 * o Compatible string of "ethernet-phy-idX.X"
 * o Compatible string of "ethernet-phy-ieee802.3-c45"
 * o Compatible string of "ethernet-phy-ieee802.3-c22"
 * o In the white list above (and issue a warning)
 * o No compatibility string
 *
 * A device which is not a phy is expected to have a compatible string
 * indicating what sort of device it is.
 */
static bool of_mdiobus_child_is_phy(struct device_node *child)
{
	u32 phy_id;

	if (of_get_phy_id(child, &phy_id) != -EINVAL)
		return true;

	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
		return true;

	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
		return true;

	if (of_match_node(whitelist_phys, child)) {
		pr_warn(FW_WARN
			"%s: Whitelisted compatible string. Please remove\n",
			child->full_name);
		return true;
	}

	if (!of_find_property(child, "compatible", NULL))
		return true;

	return false;
}

/**
 * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
 * @mdio: pointer to mii_bus structure
 * @np: pointer to device_node of MDIO bus.
 *
 * This function registers the mii_bus structure and registers a phy_device
 * for each child node of @np.
 */
int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
{
	struct device_node *child;
	bool scanphys = false;
	int addr, rc;

	/* Do not continue if the node is disabled */
	if (!of_device_is_available(np))
		return -ENODEV;

	/* Mask out all PHYs from auto probing.  Instead the PHYs listed in
	 * the device tree are populated after the bus has been registered */
	mdio->phy_mask = ~0;

	mdio->dev.of_node = np;

	/* Register the MDIO bus */
	rc = mdiobus_register(mdio);
	if (rc)
		return rc;

	/* Loop over the child nodes and register a phy_device for each phy */
	for_each_available_child_of_node(np, child) {
		addr = of_mdio_parse_addr(&mdio->dev, child);
		if (addr < 0) {
			scanphys = true;
			continue;
		}

		if (of_mdiobus_child_is_phy(child))
			of_mdiobus_register_phy(mdio, child, addr);
		else
			of_mdiobus_register_device(mdio, child, addr);
	}

	if (!scanphys)
		return 0;

	/* auto scan for PHYs with empty reg property */
	for_each_available_child_of_node(np, child) {
		/* Skip PHYs with reg property set */
		if (of_find_property(child, "reg", NULL))
			continue;

		for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
			/* skip already registered PHYs */
			if (mdiobus_is_registered_device(mdio, addr))
				continue;

			/* be noisy to encourage people to set reg property */
			dev_info(&mdio->dev, "scan phy %s at address %i\n",
				 child->name, addr);

			if (of_mdiobus_child_is_phy(child))
				of_mdiobus_register_phy(mdio, child, addr);
		}
	}

	return 0;
}
EXPORT_SYMBOL(of_mdiobus_register);

/* Helper function for of_phy_find_device */
static int of_phy_match(struct device *dev, void *phy_np)
{
	return dev->of_node == phy_np;
}

/**
 * of_phy_find_device - Give a PHY node, find the phy_device
 * @phy_np: Pointer to the phy's device tree node
 *
 * If successful, returns a pointer to the phy_device with the embedded
 * struct device refcount incremented by one, or NULL on failure.
 */
struct phy_device *of_phy_find_device(struct device_node *phy_np)
{
	struct device *d;
	struct mdio_device *mdiodev;

	if (!phy_np)
		return NULL;

	d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
	if (d) {
		mdiodev = to_mdio_device(d);
		if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
			return to_phy_device(d);
		put_device(d);
	}

	return NULL;
}
EXPORT_SYMBOL(of_phy_find_device);

/**
 * of_phy_connect - Connect to the phy described in the device tree
 * @dev: pointer to net_device claiming the phy
 * @phy_np: Pointer to device tree node for the PHY
 * @hndlr: Link state callback for the network device
 * @flags: flags to pass to the PHY
 * @iface: PHY data interface type
 *
 * If successful, returns a pointer to the phy_device with the embedded
 * struct device refcount incremented by one, or NULL on failure. The
 * refcount must be dropped by calling phy_disconnect() or phy_detach().
 */
struct phy_device *of_phy_connect(struct net_device *dev,
				  struct device_node *phy_np,
				  void (*hndlr)(struct net_device *), u32 flags,
				  phy_interface_t iface)
{
	struct phy_device *phy = of_phy_find_device(phy_np);
	int ret;

	if (!phy)
		return NULL;

	phy->dev_flags = flags;

	ret = phy_connect_direct(dev, phy, hndlr, iface);

	/* refcount is held by phy_connect_direct() on success */
	put_device(&phy->mdio.dev);

	return ret ? NULL : phy;
}
EXPORT_SYMBOL(of_phy_connect);

/**
 * of_phy_get_and_connect
 * - Get phy node and connect to the phy described in the device tree
 * @dev: pointer to net_device claiming the phy
 * @np: Pointer to device tree node for the net_device claiming the phy
 * @hndlr: Link state callback for the network device
 *
 * If successful, returns a pointer to the phy_device with the embedded
 * struct device refcount incremented by one, or NULL on failure. The
 * refcount must be dropped by calling phy_disconnect() or phy_detach().
 */
struct phy_device *of_phy_get_and_connect(struct net_device *dev,
					  struct device_node *np,
					  void (*hndlr)(struct net_device *))
{
	phy_interface_t iface;
	struct device_node *phy_np;
	struct phy_device *phy;

	iface = of_get_phy_mode(np);
	if (iface < 0)
		return NULL;

	phy_np = of_parse_phandle(np, "phy-handle", 0);
	if (!phy_np)
		return NULL;

	phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);

	of_node_put(phy_np);

	return phy;
}
EXPORT_SYMBOL(of_phy_get_and_connect);

/**
 * of_phy_attach - Attach to a PHY without starting the state machine
 * @dev: pointer to net_device claiming the phy
 * @phy_np: Node pointer for the PHY
 * @flags: flags to pass to the PHY
 * @iface: PHY data interface type
 *
 * If successful, returns a pointer to the phy_device with the embedded
 * struct device refcount incremented by one, or NULL on failure. The
 * refcount must be dropped by calling phy_disconnect() or phy_detach().
 */
struct phy_device *of_phy_attach(struct net_device *dev,
				 struct device_node *phy_np, u32 flags,
				 phy_interface_t iface)
{
	struct phy_device *phy = of_phy_find_device(phy_np);
	int ret;

	if (!phy)
		return NULL;

	ret = phy_attach_direct(dev, phy, flags, iface);

	/* refcount is held by phy_attach_direct() on success */
	put_device(&phy->mdio.dev);

	return ret ? NULL : phy;
}
EXPORT_SYMBOL(of_phy_attach);

/*
 * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
 * support two DT bindings:
 * - the old DT binding, where 'fixed-link' was a property with 5
 *   cells encoding various informations about the fixed PHY
 * - the new DT binding, where 'fixed-link' is a sub-node of the
 *   Ethernet device.
 */
bool of_phy_is_fixed_link(struct device_node *np)
{
	struct device_node *dn;
	int len, err;
	const char *managed;

	/* New binding */
	dn = of_get_child_by_name(np, "fixed-link");
	if (dn) {
		of_node_put(dn);
		return true;
	}

	err = of_property_read_string(np, "managed", &managed);
	if (err == 0 && strcmp(managed, "auto") != 0)
		return true;

	/* Old binding */
	if (of_get_property(np, "fixed-link", &len) &&
	    len == (5 * sizeof(__be32)))
		return true;

	return false;
}
EXPORT_SYMBOL(of_phy_is_fixed_link);

int of_phy_register_fixed_link(struct device_node *np)
{
	struct fixed_phy_status status = {};
	struct device_node *fixed_link_node;
	const __be32 *fixed_link_prop;
	int link_gpio;
	int len, err;
	struct phy_device *phy;
	const char *managed;

	err = of_property_read_string(np, "managed", &managed);
	if (err == 0) {
		if (strcmp(managed, "in-band-status") == 0) {
			/* status is zeroed, namely its .link member */
			phy = fixed_phy_register(PHY_POLL, &status, -1, np);
			return PTR_ERR_OR_ZERO(phy);
		}
	}

	/* New binding */
	fixed_link_node = of_get_child_by_name(np, "fixed-link");
	if (fixed_link_node) {
		status.link = 1;
		status.duplex = of_property_read_bool(fixed_link_node,
						      "full-duplex");
		if (of_property_read_u32(fixed_link_node, "speed",
					 &status.speed)) {
			of_node_put(fixed_link_node);
			return -EINVAL;
		}
		status.pause = of_property_read_bool(fixed_link_node, "pause");
		status.asym_pause = of_property_read_bool(fixed_link_node,
							  "asym-pause");
		link_gpio = of_get_named_gpio_flags(fixed_link_node,
						    "link-gpios", 0, NULL);
		of_node_put(fixed_link_node);
		if (link_gpio == -EPROBE_DEFER)
			return -EPROBE_DEFER;

		phy = fixed_phy_register(PHY_POLL, &status, link_gpio, np);
		return PTR_ERR_OR_ZERO(phy);
	}

	/* Old binding */
	fixed_link_prop = of_get_property(np, "fixed-link", &len);
	if (fixed_link_prop && len == (5 * sizeof(__be32))) {
		status.link = 1;
		status.duplex = be32_to_cpu(fixed_link_prop[1]);
		status.speed = be32_to_cpu(fixed_link_prop[2]);
		status.pause = be32_to_cpu(fixed_link_prop[3]);
		status.asym_pause = be32_to_cpu(fixed_link_prop[4]);
		phy = fixed_phy_register(PHY_POLL, &status, -1, np);
		return PTR_ERR_OR_ZERO(phy);
	}

	return -ENODEV;
}
EXPORT_SYMBOL(of_phy_register_fixed_link);

void of_phy_deregister_fixed_link(struct device_node *np)
{
	struct phy_device *phydev;

	phydev = of_phy_find_device(np);
	if (!phydev)
		return;

	fixed_phy_unregister(phydev);

	put_device(&phydev->mdio.dev);	/* of_phy_find_device() */
	phy_device_free(phydev);	/* fixed_phy_register() */
}
EXPORT_SYMBOL(of_phy_deregister_fixed_link);
Commit	Line	Data
8bc487d1 GL	1	/*
	2	* OF helpers for the MDIO (Ethernet PHY) API
	3	*
	4	* Copyright (c) 2009 Secret Lab Technologies, Ltd.
	5	*
	6	* This file is released under the GPLv2
	7	*
	8	* This file provides helper functions for extracting PHY device information
	9	* out of the OpenFirmware device tree and using it to populate an mii_bus.
	10	*/
	11
24c30dbb AV	12	#include <linux/kernel.h>
	13	#include <linux/device.h>
	14	#include <linux/netdevice.h>
	15	#include <linux/err.h>
8bc487d1	16	#include <linux/phy.h>
3be2a49e	17	#include <linux/phy_fixed.h>
8bc487d1	18	#include <linux/of.h>
a5597008	19	#include <linux/of_gpio.h>
e3873444	20	#include <linux/of_irq.h>
8bc487d1	21	#include <linux/of_mdio.h>
b7862412	22	#include <linux/of_net.h>
8bc487d1 GL	23	#include <linux/module.h>
	24
	25	MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
	26	MODULE_LICENSE("GPL");
	27
3c6f5592 JG	28	/* Extract the clause 22 phy ID from the compatible string of the form
	29	* ethernet-phy-idAAAA.BBBB */
	30	static int of_get_phy_id(struct device_node device, u32 phy_id)
	31	{
	32	struct property *prop;
	33	const char *cp;
	34	unsigned int upper, lower;
	35
	36	of_property_for_each_string(device, "compatible", prop, cp) {
	37	if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
	38	*phy_id = ((upper & 0xFFFF) << 16) \| (lower & 0xFFFF);
	39	return 0;
	40	}
	41	}
	42	return -EINVAL;
	43	}
	44
b520bd07 SS	45	static void of_mdiobus_register_phy(struct mii_bus *mdio,
b520bd07 SS	46	struct device_node *child, u32 addr)
2e79cb30 FF	47	{
	48	struct phy_device *phy;
	49	bool is_c45;
f15c586d	50	int rc;
3c6f5592	51	u32 phy_id;
2e79cb30 FF	52
	53	is_c45 = of_device_is_compatible(child,
	54	"ethernet-phy-ieee802.3-c45");
	55
3c6f5592 JG	56	if (!is_c45 && !of_get_phy_id(child, &phy_id))
	57	phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
	58	else
	59	phy = get_phy_device(mdio, addr, is_c45);
af5840a9	60	if (IS_ERR(phy))
b520bd07	61	return;
2e79cb30	62
f15c586d BD	63	rc = irq_of_parse_and_map(child, 0);
	64	if (rc > 0) {
	65	phy->irq = rc;
1bc16add	66	mdio->irq[addr] = rc;
f15c586d	67	} else {
1bc16add	68	phy->irq = mdio->irq[addr];
2e79cb30 FF	69	}
2e79cb30 FF	70
ab6016e0 FF	71	if (of_property_read_bool(child, "broken-turn-around"))
	72	mdio->phy_ignore_ta_mask \|= 1 << addr;
	73
2e79cb30 FF	74	/* Associate the OF node with the device structure so it
	75	* can be looked up later */
	76	of_node_get(child);
e5a03bfd	77	phy->mdio.dev.of_node = child;
2e79cb30 FF	78
	79	/* All data is now stored in the phy struct;
	80	* register it */
	81	rc = phy_device_register(phy);
	82	if (rc) {
	83	phy_device_free(phy);
	84	of_node_put(child);
b520bd07	85	return;
2e79cb30 FF	86	}
	87
	88	dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
8fdade4b	89	child->name, addr);
2e79cb30 FF	90	}
2e79cb30 FF	91
b520bd07 SS	92	static void of_mdiobus_register_device(struct mii_bus *mdio,
b520bd07 SS	93	struct device_node *child, u32 addr)
a9049e0c AL	94	{
	95	struct mdio_device *mdiodev;
	96	int rc;
	97
	98	mdiodev = mdio_device_create(mdio, addr);
a3478bae	99	if (IS_ERR(mdiodev))
b520bd07	100	return;
a9049e0c AL	101
	102	/* Associate the OF node with the device structure so it
	103	* can be looked up later.
	104	*/
	105	of_node_get(child);
	106	mdiodev->dev.of_node = child;
	107
	108	/* All data is now stored in the mdiodev struct; register it. */
	109	rc = mdio_device_register(mdiodev);
	110	if (rc) {
	111	mdio_device_free(mdiodev);
	112	of_node_put(child);
b520bd07	113	return;
a9049e0c AL	114	}
	115
	116	dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n",
	117	child->name, addr);
a9049e0c AL	118	}
a9049e0c AL	119
33d67377	120	int of_mdio_parse_addr(struct device dev, const struct device_node np)
8f838288 DM	121	{
	122	u32 addr;
	123	int ret;
	124
	125	ret = of_property_read_u32(np, "reg", &addr);
	126	if (ret < 0) {
	127	dev_err(dev, "%s has invalid PHY address\n", np->full_name);
	128	return ret;
	129	}
	130
	131	/* A PHY must have a reg property in the range [0-31] */
	132	if (addr >= PHY_MAX_ADDR) {
	133	dev_err(dev, "%s PHY address %i is too large\n",
	134	np->full_name, addr);
	135	return -EINVAL;
	136	}
	137
	138	return addr;
	139	}
33d67377	140	EXPORT_SYMBOL(of_mdio_parse_addr);
8f838288	141
ae461131 AL	142	/* The following is a list of PHY compatible strings which appear in
	143	* some DTBs. The compatible string is never matched against a PHY
	144	* driver, so is pointless. We only expect devices which are not PHYs
	145	* to have a compatible string, so they can be matched to an MDIO
	146	* driver. Encourage users to upgrade their DT blobs to remove these.
	147	*/
	148	static const struct of_device_id whitelist_phys[] = {
	149	{ .compatible = "brcm,40nm-ephy" },
	150	{ .compatible = "marvell,88E1111", },
	151	{ .compatible = "marvell,88e1116", },
	152	{ .compatible = "marvell,88e1118", },
f5a952c0	153	{ .compatible = "marvell,88e1145", },
ae461131 AL	154	{ .compatible = "marvell,88e1149r", },
	155	{ .compatible = "marvell,88e1310", },
	156	{ .compatible = "marvell,88E1510", },
	157	{ .compatible = "marvell,88E1514", },
	158	{ .compatible = "moxa,moxart-rtl8201cp", },
	159	{}
	160	};
	161
801a8ef5 AL	162	/*
	163	* Return true if the child node is for a phy. It must either:
	164	* o Compatible string of "ethernet-phy-idX.X"
	165	* o Compatible string of "ethernet-phy-ieee802.3-c45"
	166	* o Compatible string of "ethernet-phy-ieee802.3-c22"
ae461131	167	* o In the white list above (and issue a warning)
801a8ef5 AL	168	* o No compatibility string
	169	*
	170	* A device which is not a phy is expected to have a compatible string
	171	* indicating what sort of device it is.
	172	*/
	173	static bool of_mdiobus_child_is_phy(struct device_node *child)
	174	{
	175	u32 phy_id;
	176
	177	if (of_get_phy_id(child, &phy_id) != -EINVAL)
	178	return true;
	179
	180	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
	181	return true;
	182
	183	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
	184	return true;
	185
ae461131 AL	186	if (of_match_node(whitelist_phys, child)) {
	187	pr_warn(FW_WARN
	188	"%s: Whitelisted compatible string. Please remove\n",
	189	child->full_name);
	190	return true;
	191	}
	192
801a8ef5 AL	193	if (!of_find_property(child, "compatible", NULL))
	194	return true;
	195
	196	return false;
	197	}
	198
8bc487d1 GL	199	/**
	200	* of_mdiobus_register - Register mii_bus and create PHYs from the device tree
	201	* @mdio: pointer to mii_bus structure
	202	* @np: pointer to device_node of MDIO bus.
	203	*
	204	* This function registers the mii_bus structure and registers a phy_device
	205	* for each child node of @np.
	206	*/
	207	int of_mdiobus_register(struct mii_bus mdio, struct device_node np)
	208	{
8bc487d1	209	struct device_node *child;
2e79cb30	210	bool scanphys = false;
e7f4dc35	211	int addr, rc;
8bc487d1	212
a77f4f70 FF	213	/* Do not continue if the node is disabled */
	214	if (!of_device_is_available(np))
	215	return -ENODEV;
	216
8bc487d1 GL	217	/* Mask out all PHYs from auto probing. Instead the PHYs listed in
	218	* the device tree are populated after the bus has been registered */
	219	mdio->phy_mask = ~0;
	220
25106022 DD	221	mdio->dev.of_node = np;
25106022 DD	222
8bc487d1 GL	223	/* Register the MDIO bus */
	224	rc = mdiobus_register(mdio);
	225	if (rc)
	226	return rc;
	227
801a8ef5	228	/* Loop over the child nodes and register a phy_device for each phy */
e207e761	229	for_each_available_child_of_node(np, child) {
8f838288 DM	230	addr = of_mdio_parse_addr(&mdio->dev, child);
8f838288 DM	231	if (addr < 0) {
779d835e	232	scanphys = true;
19458860 DD	233	continue;
	234	}
	235
801a8ef5 AL	236	if (of_mdiobus_child_is_phy(child))
801a8ef5 AL	237	of_mdiobus_register_phy(mdio, child, addr);
a9049e0c AL	238	else
a9049e0c AL	239	of_mdiobus_register_device(mdio, child, addr);
8bc487d1 GL	240	}
8bc487d1 GL	241
779d835e SH	242	if (!scanphys)
	243	return 0;
	244
	245	/* auto scan for PHYs with empty reg property */
	246	for_each_available_child_of_node(np, child) {
	247	/* Skip PHYs with reg property set */
2fca6d28	248	if (of_find_property(child, "reg", NULL))
779d835e SH	249	continue;
779d835e SH	250
779d835e SH	251	for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
779d835e SH	252	/* skip already registered PHYs */
7f854420	253	if (mdiobus_is_registered_device(mdio, addr))
779d835e SH	254	continue;
	255
	256	/* be noisy to encourage people to set reg property */
	257	dev_info(&mdio->dev, "scan phy %s at address %i\n",
	258	child->name, addr);
	259
801a8ef5 AL	260	if (of_mdiobus_child_is_phy(child))
801a8ef5 AL	261	of_mdiobus_register_phy(mdio, child, addr);
779d835e SH	262	}
	263	}
	264
8bc487d1 GL	265	return 0;
	266	}
	267	EXPORT_SYMBOL(of_mdiobus_register);
	268
08a7963a JP	269	/* Helper function for of_phy_find_device */
	270	static int of_phy_match(struct device dev, void phy_np)
	271	{
61c7a080	272	return dev->of_node == phy_np;
08a7963a JP	273	}
08a7963a JP	274
8bc487d1 GL	275	/**
	276	* of_phy_find_device - Give a PHY node, find the phy_device
	277	* @phy_np: Pointer to the phy's device tree node
	278	*
f018ae7a RK	279	* If successful, returns a pointer to the phy_device with the embedded
f018ae7a RK	280	* struct device refcount incremented by one, or NULL on failure.
8bc487d1 GL	281	*/
	282	struct phy_device of_phy_find_device(struct device_node phy_np)
	283	{
	284	struct device *d;
6ed74236 AL	285	struct mdio_device *mdiodev;
6ed74236 AL	286
8bc487d1 GL	287	if (!phy_np)
	288	return NULL;
	289
08a7963a	290	d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
6ed74236 AL	291	if (d) {
	292	mdiodev = to_mdio_device(d);
	293	if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
	294	return to_phy_device(d);
3ae30f4c	295	put_device(d);
6ed74236 AL	296	}
	297
	298	return NULL;
8bc487d1 GL	299	}
	300	EXPORT_SYMBOL(of_phy_find_device);
	301
	302	/**
	303	* of_phy_connect - Connect to the phy described in the device tree
	304	* @dev: pointer to net_device claiming the phy
	305	* @phy_np: Pointer to device tree node for the PHY
	306	* @hndlr: Link state callback for the network device
735c1e25	307	* @flags: flags to pass to the PHY
8bc487d1 GL	308	* @iface: PHY data interface type
8bc487d1 GL	309	*
f018ae7a RK	310	* If successful, returns a pointer to the phy_device with the embedded
	311	* struct device refcount incremented by one, or NULL on failure. The
	312	* refcount must be dropped by calling phy_disconnect() or phy_detach().
8bc487d1 GL	313	*/
	314	struct phy_device of_phy_connect(struct net_device dev,
	315	struct device_node *phy_np,
	316	void (hndlr)(struct net_device ), u32 flags,
	317	phy_interface_t iface)
	318	{
	319	struct phy_device *phy = of_phy_find_device(phy_np);
f018ae7a	320	int ret;
8bc487d1 GL	321
	322	if (!phy)
	323	return NULL;
	324
2f637151 FF	325	phy->dev_flags = flags;
2f637151 FF	326
f018ae7a RK	327	ret = phy_connect_direct(dev, phy, hndlr, iface);
	328
	329	/* refcount is held by phy_connect_direct() on success */
e5a03bfd	330	put_device(&phy->mdio.dev);
f018ae7a RK	331
f018ae7a RK	332	return ret ? NULL : phy;
8bc487d1 GL	333	}
8bc487d1 GL	334	EXPORT_SYMBOL(of_phy_connect);
24c30dbb	335
b7862412 DL	336	/**
	337	* of_phy_get_and_connect
	338	* - Get phy node and connect to the phy described in the device tree
	339	* @dev: pointer to net_device claiming the phy
	340	* @np: Pointer to device tree node for the net_device claiming the phy
	341	* @hndlr: Link state callback for the network device
	342	*
	343	* If successful, returns a pointer to the phy_device with the embedded
	344	* struct device refcount incremented by one, or NULL on failure. The
	345	* refcount must be dropped by calling phy_disconnect() or phy_detach().
	346	*/
	347	struct phy_device of_phy_get_and_connect(struct net_device dev,
	348	struct device_node *np,
	349	void (hndlr)(struct net_device ))
	350	{
	351	phy_interface_t iface;
	352	struct device_node *phy_np;
	353	struct phy_device *phy;
	354
	355	iface = of_get_phy_mode(np);
	356	if (iface < 0)
	357	return NULL;
	358
	359	phy_np = of_parse_phandle(np, "phy-handle", 0);
	360	if (!phy_np)
	361	return NULL;
	362
	363	phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);
	364
	365	of_node_put(phy_np);
	366
	367	return phy;
	368	}
	369	EXPORT_SYMBOL(of_phy_get_and_connect);
	370
7614aba6 AF	371	/**
	372	* of_phy_attach - Attach to a PHY without starting the state machine
	373	* @dev: pointer to net_device claiming the phy
	374	* @phy_np: Node pointer for the PHY
	375	* @flags: flags to pass to the PHY
	376	* @iface: PHY data interface type
f018ae7a RK	377	*
	378	* If successful, returns a pointer to the phy_device with the embedded
	379	* struct device refcount incremented by one, or NULL on failure. The
	380	* refcount must be dropped by calling phy_disconnect() or phy_detach().
7614aba6 AF	381	*/
	382	struct phy_device of_phy_attach(struct net_device dev,
	383	struct device_node *phy_np, u32 flags,
	384	phy_interface_t iface)
	385	{
	386	struct phy_device *phy = of_phy_find_device(phy_np);
f018ae7a	387	int ret;
7614aba6 AF	388
	389	if (!phy)
	390	return NULL;
	391
f018ae7a RK	392	ret = phy_attach_direct(dev, phy, flags, iface);
	393
	394	/* refcount is held by phy_attach_direct() on success */
e5a03bfd	395	put_device(&phy->mdio.dev);
f018ae7a RK	396
f018ae7a RK	397	return ret ? NULL : phy;
7614aba6 AF	398	}
7614aba6 AF	399	EXPORT_SYMBOL(of_phy_attach);
3be2a49e	400
3be2a49e TP	401	/*
	402	* of_phy_is_fixed_link() and of_phy_register_fixed_link() must
	403	* support two DT bindings:
	404	* - the old DT binding, where 'fixed-link' was a property with 5
	405	* cells encoding various informations about the fixed PHY
	406	* - the new DT binding, where 'fixed-link' is a sub-node of the
	407	* Ethernet device.
	408	*/
	409	bool of_phy_is_fixed_link(struct device_node *np)
	410	{
	411	struct device_node *dn;
4cba5c21 SS	412	int len, err;
4cba5c21 SS	413	const char *managed;
3be2a49e TP	414
	415	/* New binding */
	416	dn = of_get_child_by_name(np, "fixed-link");
	417	if (dn) {
	418	of_node_put(dn);
	419	return true;
	420	}
	421
4cba5c21 SS	422	err = of_property_read_string(np, "managed", &managed);
	423	if (err == 0 && strcmp(managed, "auto") != 0)
	424	return true;
	425
3be2a49e TP	426	/* Old binding */
	427	if (of_get_property(np, "fixed-link", &len) &&
	428	len == (5 * sizeof(__be32)))
	429	return true;
	430
	431	return false;
	432	}
	433	EXPORT_SYMBOL(of_phy_is_fixed_link);
	434
	435	int of_phy_register_fixed_link(struct device_node *np)
	436	{
	437	struct fixed_phy_status status = {};
	438	struct device_node *fixed_link_node;
	439	const __be32 *fixed_link_prop;
a5597008	440	int link_gpio;
4cba5c21	441	int len, err;
fd2ef0ba	442	struct phy_device *phy;
4cba5c21 SS	443	const char *managed;
	444
	445	err = of_property_read_string(np, "managed", &managed);
	446	if (err == 0) {
	447	if (strcmp(managed, "in-band-status") == 0) {
	448	/* status is zeroed, namely its .link member */
a5597008	449	phy = fixed_phy_register(PHY_POLL, &status, -1, np);
5189b1d8	450	return PTR_ERR_OR_ZERO(phy);
4cba5c21 SS	451	}
4cba5c21 SS	452	}
3be2a49e TP	453
	454	/* New binding */
	455	fixed_link_node = of_get_child_by_name(np, "fixed-link");
	456	if (fixed_link_node) {
	457	status.link = 1;
a72e1541 RR	458	status.duplex = of_property_read_bool(fixed_link_node,
a72e1541 RR	459	"full-duplex");
48c1699d JH	460	if (of_property_read_u32(fixed_link_node, "speed",
	461	&status.speed)) {
	462	of_node_put(fixed_link_node);
3be2a49e	463	return -EINVAL;
48c1699d	464	}
a72e1541 RR	465	status.pause = of_property_read_bool(fixed_link_node, "pause");
	466	status.asym_pause = of_property_read_bool(fixed_link_node,
	467	"asym-pause");
a5597008 AL	468	link_gpio = of_get_named_gpio_flags(fixed_link_node,
a5597008 AL	469	"link-gpios", 0, NULL);
3be2a49e	470	of_node_put(fixed_link_node);
a5597008 AL	471	if (link_gpio == -EPROBE_DEFER)
	472	return -EPROBE_DEFER;
	473
	474	phy = fixed_phy_register(PHY_POLL, &status, link_gpio, np);
5189b1d8	475	return PTR_ERR_OR_ZERO(phy);
3be2a49e TP	476	}
	477
	478	/* Old binding */
	479	fixed_link_prop = of_get_property(np, "fixed-link", &len);
	480	if (fixed_link_prop && len == (5 * sizeof(__be32))) {
	481	status.link = 1;
	482	status.duplex = be32_to_cpu(fixed_link_prop[1]);
	483	status.speed = be32_to_cpu(fixed_link_prop[2]);
	484	status.pause = be32_to_cpu(fixed_link_prop[3]);
	485	status.asym_pause = be32_to_cpu(fixed_link_prop[4]);
a5597008	486	phy = fixed_phy_register(PHY_POLL, &status, -1, np);
5189b1d8	487	return PTR_ERR_OR_ZERO(phy);
3be2a49e TP	488	}
	489
	490	return -ENODEV;
	491	}
	492	EXPORT_SYMBOL(of_phy_register_fixed_link);
3f65047c JH	493
	494	void of_phy_deregister_fixed_link(struct device_node *np)
	495	{
	496	struct phy_device *phydev;
	497
	498	phydev = of_phy_find_device(np);
	499	if (!phydev)
	500	return;
	501
	502	fixed_phy_unregister(phydev);
	503
	504	put_device(&phydev->mdio.dev); /* of_phy_find_device() */
	505	phy_device_free(phydev); /* fixed_phy_register() */
	506	}
	507	EXPORT_SYMBOL(of_phy_deregister_fixed_link);