[deliverable/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_irq.h>
#include <linux/of_mdio.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 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 (!phy || IS_ERR(phy))
		return 1;

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

	/* Associate the OF node with the device structure so it
	 * can be looked up later */
	of_node_get(child);
	phy->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 1;
	}

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

	return 0;
}

static 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;
}

/**
 * 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;
	const __be32 *paddr;
	bool scanphys = false;
	int addr, rc, i;

	/* 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;

	/* Clear all the IRQ properties */
	if (mdio->irq)
		for (i=0; i<PHY_MAX_ADDR; i++)
			mdio->irq[i] = PHY_POLL;

	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 one */
	for_each_available_child_of_node(np, child) {
		addr = of_mdio_parse_addr(&mdio->dev, child);
		if (addr < 0) {
			scanphys = true;
			continue;
		}

		rc = of_mdiobus_register_phy(mdio, child, addr);
		if (rc)
			continue;
	}

	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 */
		paddr = of_get_property(child, "reg", NULL);
		if (paddr)
			continue;

		for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
			/* skip already registered PHYs */
			if (mdio->phy_map[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);

			rc = of_mdiobus_register_phy(mdio, child, addr);
			if (rc)
				continue;
		}
	}

	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
 *
 * Returns a pointer to the phy_device.
 */
struct phy_device *of_phy_find_device(struct device_node *phy_np)
{
	struct device *d;
	if (!phy_np)
		return NULL;

	d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
	return d ? to_phy_device(d) : 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
 * @iface: PHY data interface type
 *
 * Returns a pointer to the phy_device if successful.  NULL otherwise
 */
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);

	if (!phy)
		return NULL;

	phy->dev_flags = flags;

	return phy_connect_direct(dev, phy, hndlr, iface) ? NULL : phy;
}
EXPORT_SYMBOL(of_phy_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
 */
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);

	if (!phy)
		return NULL;

	return phy_attach_direct(dev, phy, flags, iface) ? NULL : phy;
}
EXPORT_SYMBOL(of_phy_attach);

#if defined(CONFIG_FIXED_PHY)
/*
 * 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;

	/* New binding */
	dn = of_get_child_by_name(np, "fixed-link");
	if (dn) {
		of_node_put(dn);
		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 len;
	struct phy_device *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))
			return -EINVAL;
		status.pause = of_property_read_bool(fixed_link_node, "pause");
		status.asym_pause = of_property_read_bool(fixed_link_node,
							  "asym-pause");
		of_node_put(fixed_link_node);
		phy = fixed_phy_register(PHY_POLL, &status, np);
		return IS_ERR(phy) ? PTR_ERR(phy) : 0;
	}

	/* 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, np);
		return IS_ERR(phy) ? PTR_ERR(phy) : 0;
	}

	return -ENODEV;
}
EXPORT_SYMBOL(of_phy_register_fixed_link);
#endif
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>
e3873444	19	#include <linux/of_irq.h>
8bc487d1 GL	20	#include <linux/of_mdio.h>
	21	#include <linux/module.h>
	22
	23	MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
	24	MODULE_LICENSE("GPL");
	25
3c6f5592 JG	26	/* Extract the clause 22 phy ID from the compatible string of the form
	27	* ethernet-phy-idAAAA.BBBB */
	28	static int of_get_phy_id(struct device_node device, u32 phy_id)
	29	{
	30	struct property *prop;
	31	const char *cp;
	32	unsigned int upper, lower;
	33
	34	of_property_for_each_string(device, "compatible", prop, cp) {
	35	if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
	36	*phy_id = ((upper & 0xFFFF) << 16) \| (lower & 0xFFFF);
	37	return 0;
	38	}
	39	}
	40	return -EINVAL;
	41	}
	42
2e79cb30 FF	43	static int of_mdiobus_register_phy(struct mii_bus mdio, struct device_node child,
	44	u32 addr)
	45	{
	46	struct phy_device *phy;
	47	bool is_c45;
f15c586d	48	int rc;
3c6f5592	49	u32 phy_id;
2e79cb30 FF	50
	51	is_c45 = of_device_is_compatible(child,
	52	"ethernet-phy-ieee802.3-c45");
	53
3c6f5592 JG	54	if (!is_c45 && !of_get_phy_id(child, &phy_id))
	55	phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
	56	else
	57	phy = get_phy_device(mdio, addr, is_c45);
2e79cb30 FF	58	if (!phy \|\| IS_ERR(phy))
	59	return 1;
	60
f15c586d BD	61	rc = irq_of_parse_and_map(child, 0);
	62	if (rc > 0) {
	63	phy->irq = rc;
	64	if (mdio->irq)
	65	mdio->irq[addr] = rc;
	66	} else {
	67	if (mdio->irq)
	68	phy->irq = mdio->irq[addr];
2e79cb30 FF	69	}
	70
	71	/* Associate the OF node with the device structure so it
	72	* can be looked up later */
	73	of_node_get(child);
	74	phy->dev.of_node = child;
	75
	76	/* All data is now stored in the phy struct;
	77	* register it */
	78	rc = phy_device_register(phy);
	79	if (rc) {
	80	phy_device_free(phy);
	81	of_node_put(child);
	82	return 1;
	83	}
	84
	85	dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
8fdade4b	86	child->name, addr);
2e79cb30 FF	87
	88	return 0;
	89	}
	90
8f838288 DM	91	static int of_mdio_parse_addr(struct device dev, const struct device_node np)
	92	{
	93	u32 addr;
	94	int ret;
	95
	96	ret = of_property_read_u32(np, "reg", &addr);
	97	if (ret < 0) {
	98	dev_err(dev, "%s has invalid PHY address\n", np->full_name);
	99	return ret;
	100	}
	101
	102	/* A PHY must have a reg property in the range [0-31] */
	103	if (addr >= PHY_MAX_ADDR) {
	104	dev_err(dev, "%s PHY address %i is too large\n",
	105	np->full_name, addr);
	106	return -EINVAL;
	107	}
	108
	109	return addr;
	110	}
	111
8bc487d1 GL	112	/**
	113	* of_mdiobus_register - Register mii_bus and create PHYs from the device tree
	114	* @mdio: pointer to mii_bus structure
	115	* @np: pointer to device_node of MDIO bus.
	116	*
	117	* This function registers the mii_bus structure and registers a phy_device
	118	* for each child node of @np.
	119	*/
	120	int of_mdiobus_register(struct mii_bus mdio, struct device_node np)
	121	{
8bc487d1	122	struct device_node *child;
779d835e	123	const __be32 *paddr;
2e79cb30	124	bool scanphys = false;
4cd984b0	125	int addr, rc, i;
8bc487d1 GL	126
	127	/* Mask out all PHYs from auto probing. Instead the PHYs listed in
	128	* the device tree are populated after the bus has been registered */
	129	mdio->phy_mask = ~0;
	130
	131	/* Clear all the IRQ properties */
	132	if (mdio->irq)
	133	for (i=0; i<PHY_MAX_ADDR; i++)
	134	mdio->irq[i] = PHY_POLL;
	135
25106022 DD	136	mdio->dev.of_node = np;
25106022 DD	137
8bc487d1 GL	138	/* Register the MDIO bus */
	139	rc = mdiobus_register(mdio);
	140	if (rc)
	141	return rc;
	142
	143	/* Loop over the child nodes and register a phy_device for each one */
e207e761	144	for_each_available_child_of_node(np, child) {
8f838288 DM	145	addr = of_mdio_parse_addr(&mdio->dev, child);
8f838288 DM	146	if (addr < 0) {
779d835e	147	scanphys = true;
19458860 DD	148	continue;
	149	}
	150
2e79cb30 FF	151	rc = of_mdiobus_register_phy(mdio, child, addr);
2e79cb30 FF	152	if (rc)
8bc487d1	153	continue;
8bc487d1 GL	154	}
8bc487d1 GL	155
779d835e SH	156	if (!scanphys)
	157	return 0;
	158
	159	/* auto scan for PHYs with empty reg property */
	160	for_each_available_child_of_node(np, child) {
	161	/* Skip PHYs with reg property set */
24f28dde	162	paddr = of_get_property(child, "reg", NULL);
779d835e SH	163	if (paddr)
	164	continue;
	165
779d835e SH	166	for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
	167	/* skip already registered PHYs */
	168	if (mdio->phy_map[addr])
	169	continue;
	170
	171	/* be noisy to encourage people to set reg property */
	172	dev_info(&mdio->dev, "scan phy %s at address %i\n",
	173	child->name, addr);
	174
2e79cb30 FF	175	rc = of_mdiobus_register_phy(mdio, child, addr);
2e79cb30 FF	176	if (rc)
779d835e	177	continue;
779d835e SH	178	}
	179	}
	180
8bc487d1 GL	181	return 0;
	182	}
	183	EXPORT_SYMBOL(of_mdiobus_register);
	184
08a7963a JP	185	/* Helper function for of_phy_find_device */
	186	static int of_phy_match(struct device dev, void phy_np)
	187	{
61c7a080	188	return dev->of_node == phy_np;
08a7963a JP	189	}
08a7963a JP	190
8bc487d1 GL	191	/**
	192	* of_phy_find_device - Give a PHY node, find the phy_device
	193	* @phy_np: Pointer to the phy's device tree node
	194	*
	195	* Returns a pointer to the phy_device.
	196	*/
	197	struct phy_device of_phy_find_device(struct device_node phy_np)
	198	{
	199	struct device *d;
8bc487d1 GL	200	if (!phy_np)
	201	return NULL;
	202
08a7963a	203	d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
8bc487d1 GL	204	return d ? to_phy_device(d) : NULL;
	205	}
	206	EXPORT_SYMBOL(of_phy_find_device);
	207
	208	/**
	209	* of_phy_connect - Connect to the phy described in the device tree
	210	* @dev: pointer to net_device claiming the phy
	211	* @phy_np: Pointer to device tree node for the PHY
	212	* @hndlr: Link state callback for the network device
	213	* @iface: PHY data interface type
	214	*
25985edc	215	* Returns a pointer to the phy_device if successful. NULL otherwise
8bc487d1 GL	216	*/
	217	struct phy_device of_phy_connect(struct net_device dev,
	218	struct device_node *phy_np,
	219	void (hndlr)(struct net_device ), u32 flags,
	220	phy_interface_t iface)
	221	{
	222	struct phy_device *phy = of_phy_find_device(phy_np);
	223
	224	if (!phy)
	225	return NULL;
	226
2f637151 FF	227	phy->dev_flags = flags;
2f637151 FF	228
f9a8f83b	229	return phy_connect_direct(dev, phy, hndlr, iface) ? NULL : phy;
8bc487d1 GL	230	}
8bc487d1 GL	231	EXPORT_SYMBOL(of_phy_connect);
24c30dbb	232
7614aba6 AF	233	/**
	234	* of_phy_attach - Attach to a PHY without starting the state machine
	235	* @dev: pointer to net_device claiming the phy
	236	* @phy_np: Node pointer for the PHY
	237	* @flags: flags to pass to the PHY
	238	* @iface: PHY data interface type
	239	*/
	240	struct phy_device of_phy_attach(struct net_device dev,
	241	struct device_node *phy_np, u32 flags,
	242	phy_interface_t iface)
	243	{
	244	struct phy_device *phy = of_phy_find_device(phy_np);
	245
	246	if (!phy)
	247	return NULL;
	248
	249	return phy_attach_direct(dev, phy, flags, iface) ? NULL : phy;
	250	}
	251	EXPORT_SYMBOL(of_phy_attach);
3be2a49e TP	252
	253	#if defined(CONFIG_FIXED_PHY)
	254	/*
	255	* of_phy_is_fixed_link() and of_phy_register_fixed_link() must
	256	* support two DT bindings:
	257	* - the old DT binding, where 'fixed-link' was a property with 5
	258	* cells encoding various informations about the fixed PHY
	259	* - the new DT binding, where 'fixed-link' is a sub-node of the
	260	* Ethernet device.
	261	*/
	262	bool of_phy_is_fixed_link(struct device_node *np)
	263	{
	264	struct device_node *dn;
	265	int len;
	266
	267	/* New binding */
	268	dn = of_get_child_by_name(np, "fixed-link");
	269	if (dn) {
	270	of_node_put(dn);
	271	return true;
	272	}
	273
	274	/* Old binding */
	275	if (of_get_property(np, "fixed-link", &len) &&
	276	len == (5 * sizeof(__be32)))
	277	return true;
	278
	279	return false;
	280	}
	281	EXPORT_SYMBOL(of_phy_is_fixed_link);
	282
	283	int of_phy_register_fixed_link(struct device_node *np)
	284	{
	285	struct fixed_phy_status status = {};
	286	struct device_node *fixed_link_node;
	287	const __be32 *fixed_link_prop;
	288	int len;
fd2ef0ba	289	struct phy_device *phy;
3be2a49e TP	290
	291	/* New binding */
	292	fixed_link_node = of_get_child_by_name(np, "fixed-link");
	293	if (fixed_link_node) {
	294	status.link = 1;
a72e1541 RR	295	status.duplex = of_property_read_bool(fixed_link_node,
a72e1541 RR	296	"full-duplex");
3be2a49e TP	297	if (of_property_read_u32(fixed_link_node, "speed", &status.speed))
3be2a49e TP	298	return -EINVAL;
a72e1541 RR	299	status.pause = of_property_read_bool(fixed_link_node, "pause");
	300	status.asym_pause = of_property_read_bool(fixed_link_node,
	301	"asym-pause");
3be2a49e	302	of_node_put(fixed_link_node);
fd2ef0ba PG	303	phy = fixed_phy_register(PHY_POLL, &status, np);
fd2ef0ba PG	304	return IS_ERR(phy) ? PTR_ERR(phy) : 0;
3be2a49e TP	305	}
	306
	307	/* Old binding */
	308	fixed_link_prop = of_get_property(np, "fixed-link", &len);
	309	if (fixed_link_prop && len == (5 * sizeof(__be32))) {
	310	status.link = 1;
	311	status.duplex = be32_to_cpu(fixed_link_prop[1]);
	312	status.speed = be32_to_cpu(fixed_link_prop[2]);
	313	status.pause = be32_to_cpu(fixed_link_prop[3]);
	314	status.asym_pause = be32_to_cpu(fixed_link_prop[4]);
fd2ef0ba PG	315	phy = fixed_phy_register(PHY_POLL, &status, np);
fd2ef0ba PG	316	return IS_ERR(phy) ? PTR_ERR(phy) : 0;
3be2a49e TP	317	}
	318
	319	return -ENODEV;
	320	}
	321	EXPORT_SYMBOL(of_phy_register_fixed_link);
	322	#endif