[linux.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>

#define DEFAULT_GPIO_RESET_DELAY	10	/* in microseconds */

MODULE_AUTHOR("Grant Likely <[email protected]>");
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 int 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 PTR_ERR(phy);

	rc = of_irq_get(child, 0);
	if (rc == -EPROBE_DEFER) {
		phy_device_free(phy);
		return rc;
	}
	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;

	of_property_read_u32(child, "reset-assert-us",
			     &phy->mdio.reset_assert_delay);
	of_property_read_u32(child, "reset-deassert-us",
			     &phy->mdio.reset_deassert_delay);

	/* 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;
	phy->mdio.dev.fwnode = of_fwnode_handle(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 rc;
	}

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

static int 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 PTR_ERR(mdiodev);

	/* Associate the OF node with the device structure so it
	 * can be looked up later.
	 */
	of_node_get(child);
	mdiodev->dev.of_node = child;
	mdiodev->dev.fwnode = of_fwnode_handle(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 rc;
	}

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

/* 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 = "broadcom,bcm5241" },
	{ .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
			"%pOF: Whitelisted compatible string. Please remove\n",
			child);
		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;

	if (!np)
		return mdiobus_register(mdio);

	/* 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;
	mdio->dev.fwnode = of_fwnode_handle(np);

	/* Get bus level PHY reset GPIO details */
	mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;
	of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);

	/* 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))
			rc = of_mdiobus_register_phy(mdio, child, addr);
		else
			rc = of_mdiobus_register_device(mdio, child, addr);

		if (rc == -ENODEV)
			dev_err(&mdio->dev,
				"MDIO device at address %d is missing.\n",
				addr);
		else if (rc)
			goto unregister;
	}

	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 %pOFn at address %i\n",
				 child, addr);

			if (of_mdiobus_child_is_phy(child)) {
				rc = of_mdiobus_register_phy(mdio, child, addr);
				if (rc && rc != -ENODEV)
					goto unregister;
			}
		}
	}

	return 0;

unregister:
	mdiobus_unregister(mdio);
	return rc;
}
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;
	int ret;

	iface = of_get_phy_mode(np);
	if (iface < 0)
		return NULL;
	if (of_phy_is_fixed_link(np)) {
		ret = of_phy_register_fixed_link(np);
		if (ret < 0) {
			netdev_err(dev, "broken fixed-link specification\n");
			return NULL;
		}
		phy_np = of_node_get(np);
	} else {
		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;
	u32 fixed_link_prop[5];
	const char *managed;
	int link_gpio = -1;

	if (of_property_read_string(np, "managed", &managed) == 0 &&
	    strcmp(managed, "in-band-status") == 0) {
		/* status is zeroed, namely its .link member */
		goto register_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;

		goto register_phy;
	}

	/* Old binding */
	if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,
				       ARRAY_SIZE(fixed_link_prop)) == 0) {
		status.link = 1;
		status.duplex = fixed_link_prop[1];
		status.speed  = fixed_link_prop[2];
		status.pause  = fixed_link_prop[3];
		status.asym_pause = fixed_link_prop[4];
		goto register_phy;
	}

	return -ENODEV;

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