[linux-block.git] / include / linux / of_mdio.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * OF helpers for the MDIO (Ethernet PHY) API
 *
 * Copyright (c) 2009 Secret Lab Technologies, Ltd.
 */

#ifndef __LINUX_OF_MDIO_H
#define __LINUX_OF_MDIO_H

#include <linux/device.h>
#include <linux/phy.h>
#include <linux/of.h>

#if IS_ENABLED(CONFIG_OF_MDIO)
bool of_mdiobus_child_is_phy(struct device_node *child);
int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np);
int devm_of_mdiobus_register(struct device *dev, struct mii_bus *mdio,
			     struct device_node *np);
struct mdio_device *of_mdio_find_device(struct device_node *np);
struct phy_device *of_phy_find_device(struct device_node *phy_np);
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 *
of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
		       void (*hndlr)(struct net_device *));

struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np);
int of_phy_register_fixed_link(struct device_node *np);
void of_phy_deregister_fixed_link(struct device_node *np);
bool of_phy_is_fixed_link(struct device_node *np);
int of_mdiobus_phy_device_register(struct mii_bus *mdio, struct phy_device *phy,
				   struct device_node *child, u32 addr);

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

#else /* CONFIG_OF_MDIO */
static inline bool of_mdiobus_child_is_phy(struct device_node *child)
{
	return false;
}

static inline int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
{
	/*
	 * Fall back to the non-DT function to register a bus.
	 * This way, we don't have to keep compat bits around in drivers.
	 */

	return mdiobus_register(mdio);
}

static inline int devm_of_mdiobus_register(struct device *dev,
					   struct mii_bus *mdio,
					   struct device_node *np)
{
	return devm_mdiobus_register(dev, mdio);
}

static inline struct mdio_device *of_mdio_find_device(struct device_node *np)
{
	return NULL;
}

static inline struct phy_device *of_phy_find_device(struct device_node *phy_np)
{
	return NULL;
}

static inline 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)
{
	return NULL;
}

static inline struct phy_device *
of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
		       void (*hndlr)(struct net_device *))
{
	return NULL;
}

static inline struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np)
{
	return NULL;
}

static inline int of_mdio_parse_addr(struct device *dev,
				     const struct device_node *np)
{
	return -ENOSYS;
}
static inline int of_phy_register_fixed_link(struct device_node *np)
{
	return -ENOSYS;
}
static inline void of_phy_deregister_fixed_link(struct device_node *np)
{
}
static inline bool of_phy_is_fixed_link(struct device_node *np)
{
	return false;
}

static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
					    struct phy_device *phy,
					    struct device_node *child, u32 addr)
{
	return -ENOSYS;
}
#endif


#endif /* __LINUX_OF_MDIO_H */
Commit	Line	Data
55716d26	1	/* SPDX-License-Identifier: GPL-2.0-only */
8bc487d1 GL	2	/*
	3	* OF helpers for the MDIO (Ethernet PHY) API
	4	*
	5	* Copyright (c) 2009 Secret Lab Technologies, Ltd.
8bc487d1 GL	6	*/
	7
	8	#ifndef __LINUX_OF_MDIO_H
	9	#define __LINUX_OF_MDIO_H
	10
14eeb6e0	11	#include <linux/device.h>
8bc487d1 GL	12	#include <linux/phy.h>
	13	#include <linux/of.h>
	14
e6e14f63	15	#if IS_ENABLED(CONFIG_OF_MDIO)
a0bd96f5 BG	16	bool of_mdiobus_child_is_phy(struct device_node *child);
a0bd96f5 BG	17	int of_mdiobus_register(struct mii_bus mdio, struct device_node np);
14eeb6e0 BG	18	int devm_of_mdiobus_register(struct device dev, struct mii_bus mdio,
14eeb6e0 BG	19	struct device_node *np);
b5b6775d	20	struct mdio_device of_mdio_find_device(struct device_node np);
a0bd96f5 BG	21	struct phy_device of_phy_find_device(struct device_node phy_np);
	22	struct phy_device *
	23	of_phy_connect(struct net_device dev, struct device_node phy_np,
	24	void (hndlr)(struct net_device ), u32 flags,
	25	phy_interface_t iface);
	26	struct phy_device *
b7862412 DL	27	of_phy_get_and_connect(struct net_device dev, struct device_node np,
b7862412 DL	28	void (hndlr)(struct net_device ));
8bc487d1	29
a0bd96f5 BG	30	struct mii_bus of_mdio_find_bus(struct device_node mdio_np);
	31	int of_phy_register_fixed_link(struct device_node *np);
	32	void of_phy_deregister_fixed_link(struct device_node *np);
	33	bool of_phy_is_fixed_link(struct device_node *np);
	34	int of_mdiobus_phy_device_register(struct mii_bus mdio, struct phy_device phy,
	35	struct device_node *child, u32 addr);
4798a714 JM	36
	37	static inline int of_mdio_parse_addr(struct device *dev,
	38	const struct device_node *np)
	39	{
	40	u32 addr;
	41	int ret;
	42
	43	ret = of_property_read_u32(np, "reg", &addr);
	44	if (ret < 0) {
	45	dev_err(dev, "%s has invalid PHY address\n", np->full_name);
	46	return ret;
	47	}
	48
	49	/* A PHY must have a reg property in the range [0-31] */
	50	if (addr >= PHY_MAX_ADDR) {
	51	dev_err(dev, "%s PHY address %i is too large\n",
	52	np->full_name, addr);
	53	return -EINVAL;
	54	}
	55
	56	return addr;
	57	}
	58
e6e14f63	59	#else /* CONFIG_OF_MDIO */
7df2281a	60	static inline bool of_mdiobus_child_is_phy(struct device_node *child)
0aa4d016 AT	61	{
	62	return false;
	63	}
	64
2a5cf801	65	static inline int of_mdiobus_register(struct mii_bus mdio, struct device_node np)
f9dc9ac5	66	{
23a456f0 DM	67	/*
	68	* Fall back to the non-DT function to register a bus.
	69	* This way, we don't have to keep compat bits around in drivers.
	70	*/
	71
	72	return mdiobus_register(mdio);
f9dc9ac5 SK	73	}
f9dc9ac5 SK	74
86544c3d VO	75	static inline int devm_of_mdiobus_register(struct device *dev,
	76	struct mii_bus *mdio,
	77	struct device_node *np)
	78	{
	79	return devm_mdiobus_register(dev, mdio);
	80	}
	81
b5b6775d RK	82	static inline struct mdio_device of_mdio_find_device(struct device_node np)
	83	{
	84	return NULL;
	85	}
	86
2a5cf801	87	static inline struct phy_device of_phy_find_device(struct device_node phy_np)
f9dc9ac5 SK	88	{
	89	return NULL;
	90	}
	91
2a5cf801 MB	92	static inline struct phy_device of_phy_connect(struct net_device dev,
	93	struct device_node *phy_np,
	94	void (hndlr)(struct net_device ),
	95	u32 flags, phy_interface_t iface)
f9dc9ac5 SK	96	{
	97	return NULL;
	98	}
	99
b7862412 DL	100	static inline struct phy_device *
	101	of_phy_get_and_connect(struct net_device dev, struct device_node np,
	102	void (hndlr)(struct net_device ))
	103	{
	104	return NULL;
	105	}
	106
2a5cf801	107	static inline struct mii_bus of_mdio_find_bus(struct device_node mdio_np)
f9dc9ac5 SK	108	{
	109	return NULL;
	110	}
33d67377 FF	111
	112	static inline int of_mdio_parse_addr(struct device *dev,
	113	const struct device_node *np)
	114	{
	115	return -ENOSYS;
	116	}
3be2a49e TP	117	static inline int of_phy_register_fixed_link(struct device_node *np)
	118	{
	119	return -ENOSYS;
	120	}
3f65047c JH	121	static inline void of_phy_deregister_fixed_link(struct device_node *np)
	122	{
	123	}
3be2a49e TP	124	static inline bool of_phy_is_fixed_link(struct device_node *np)
	125	{
	126	return false;
	127	}
5972157c OR	128
	129	static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
	130	struct phy_device *phy,
	131	struct device_node *child, u32 addr)
	132	{
	133	return -ENOSYS;
	134	}
3be2a49e TP	135	#endif
	136
	137
8bc487d1	138	#endif /* __LINUX_OF_MDIO_H */