[mirror_ubuntu-hirsute-kernel.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 phy_device *
of_phy_attach(struct net_device *dev, struct device_node *phy_np,
	      u32 flags, phy_interface_t iface);

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 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 phy_device *of_phy_attach(struct net_device *dev,
					       struct device_node *phy_np,
					       u32 flags, phy_interface_t iface)
{
	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 ));
a0bd96f5 BG	29	struct phy_device *
	30	of_phy_attach(struct net_device dev, struct device_node phy_np,
	31	u32 flags, phy_interface_t iface);
8bc487d1	32
a0bd96f5 BG	33	struct mii_bus of_mdio_find_bus(struct device_node mdio_np);
	34	int of_phy_register_fixed_link(struct device_node *np);
	35	void of_phy_deregister_fixed_link(struct device_node *np);
	36	bool of_phy_is_fixed_link(struct device_node *np);
	37	int of_mdiobus_phy_device_register(struct mii_bus mdio, struct phy_device phy,
	38	struct device_node *child, u32 addr);
4798a714 JM	39
	40	static inline int of_mdio_parse_addr(struct device *dev,
	41	const struct device_node *np)
	42	{
	43	u32 addr;
	44	int ret;
	45
	46	ret = of_property_read_u32(np, "reg", &addr);
	47	if (ret < 0) {
	48	dev_err(dev, "%s has invalid PHY address\n", np->full_name);
	49	return ret;
	50	}
	51
	52	/* A PHY must have a reg property in the range [0-31] */
	53	if (addr >= PHY_MAX_ADDR) {
	54	dev_err(dev, "%s PHY address %i is too large\n",
	55	np->full_name, addr);
	56	return -EINVAL;
	57	}
	58
	59	return addr;
	60	}
	61
e6e14f63	62	#else /* CONFIG_OF_MDIO */
7df2281a	63	static inline bool of_mdiobus_child_is_phy(struct device_node *child)
0aa4d016 AT	64	{
	65	return false;
	66	}
	67
2a5cf801	68	static inline int of_mdiobus_register(struct mii_bus mdio, struct device_node np)
f9dc9ac5	69	{
23a456f0 DM	70	/*
	71	* Fall back to the non-DT function to register a bus.
	72	* This way, we don't have to keep compat bits around in drivers.
	73	*/
	74
	75	return mdiobus_register(mdio);
f9dc9ac5 SK	76	}
f9dc9ac5 SK	77
b5b6775d RK	78	static inline struct mdio_device of_mdio_find_device(struct device_node np)
	79	{
	80	return NULL;
	81	}
	82
2a5cf801	83	static inline struct phy_device of_phy_find_device(struct device_node phy_np)
f9dc9ac5 SK	84	{
	85	return NULL;
	86	}
	87
2a5cf801 MB	88	static inline struct phy_device of_phy_connect(struct net_device dev,
	89	struct device_node *phy_np,
	90	void (hndlr)(struct net_device ),
	91	u32 flags, phy_interface_t iface)
f9dc9ac5 SK	92	{
	93	return NULL;
	94	}
	95
b7862412 DL	96	static inline struct phy_device *
	97	of_phy_get_and_connect(struct net_device dev, struct device_node np,
	98	void (hndlr)(struct net_device ))
	99	{
	100	return NULL;
	101	}
	102
7614aba6 AF	103	static inline struct phy_device of_phy_attach(struct net_device dev,
	104	struct device_node *phy_np,
	105	u32 flags, phy_interface_t iface)
	106	{
	107	return NULL;
	108	}
	109
2a5cf801	110	static inline struct mii_bus of_mdio_find_bus(struct device_node mdio_np)
f9dc9ac5 SK	111	{
	112	return NULL;
	113	}
33d67377 FF	114
	115	static inline int of_mdio_parse_addr(struct device *dev,
	116	const struct device_node *np)
	117	{
	118	return -ENOSYS;
	119	}
3be2a49e TP	120	static inline int of_phy_register_fixed_link(struct device_node *np)
	121	{
	122	return -ENOSYS;
	123	}
3f65047c JH	124	static inline void of_phy_deregister_fixed_link(struct device_node *np)
	125	{
	126	}
3be2a49e TP	127	static inline bool of_phy_is_fixed_link(struct device_node *np)
	128	{
	129	return false;
	130	}
5972157c OR	131
	132	static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
	133	struct phy_device *phy,
	134	struct device_node *child, u32 addr)
	135	{
	136	return -ENOSYS;
	137	}
3be2a49e TP	138	#endif
	139
	140
8bc487d1	141	#endif /* __LINUX_OF_MDIO_H */