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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * linux/mdio.h: definitions for MDIO (clause 45) transceivers
 * Copyright 2006-2009 Solarflare Communications Inc.
 */
#ifndef __LINUX_MDIO_H__
#define __LINUX_MDIO_H__

#include <uapi/linux/mdio.h>
#include <linux/bitfield.h>
#include <linux/mod_devicetable.h>

/* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
 * IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips.
 */
#define MII_ADDR_C45		(1<<30)
#define MII_DEVADDR_C45_SHIFT	16
#define MII_DEVADDR_C45_MASK	GENMASK(20, 16)
#define MII_REGADDR_C45_MASK	GENMASK(15, 0)

struct gpio_desc;
struct mii_bus;
struct reset_control;

/* Multiple levels of nesting are possible. However typically this is
 * limited to nested DSA like layer, a MUX layer, and the normal
 * user. Instead of trying to handle the general case, just define
 * these cases.
 */
enum mdio_mutex_lock_class {
	MDIO_MUTEX_NORMAL,
	MDIO_MUTEX_MUX,
	MDIO_MUTEX_NESTED,
};

struct mdio_device {
	struct device dev;

	struct mii_bus *bus;
	char modalias[MDIO_NAME_SIZE];

	int (*bus_match)(struct device *dev, struct device_driver *drv);
	void (*device_free)(struct mdio_device *mdiodev);
	void (*device_remove)(struct mdio_device *mdiodev);

	/* Bus address of the MDIO device (0-31) */
	int addr;
	int flags;
	struct gpio_desc *reset_gpio;
	struct reset_control *reset_ctrl;
	unsigned int reset_assert_delay;
	unsigned int reset_deassert_delay;
};

static inline struct mdio_device *to_mdio_device(const struct device *dev)
{
	return container_of(dev, struct mdio_device, dev);
}

/* struct mdio_driver_common: Common to all MDIO drivers */
struct mdio_driver_common {
	struct device_driver driver;
	int flags;
};
#define MDIO_DEVICE_FLAG_PHY		1

static inline struct mdio_driver_common *
to_mdio_common_driver(const struct device_driver *driver)
{
	return container_of(driver, struct mdio_driver_common, driver);
}

/* struct mdio_driver: Generic MDIO driver */
struct mdio_driver {
	struct mdio_driver_common mdiodrv;

	/*
	 * Called during discovery.  Used to set
	 * up device-specific structures, if any
	 */
	int (*probe)(struct mdio_device *mdiodev);

	/* Clears up any memory if needed */
	void (*remove)(struct mdio_device *mdiodev);

	/* Quiesces the device on system shutdown, turns off interrupts etc */
	void (*shutdown)(struct mdio_device *mdiodev);
};

static inline struct mdio_driver *
to_mdio_driver(const struct device_driver *driver)
{
	return container_of(to_mdio_common_driver(driver), struct mdio_driver,
			    mdiodrv);
}

/* device driver data */
static inline void mdiodev_set_drvdata(struct mdio_device *mdio, void *data)
{
	dev_set_drvdata(&mdio->dev, data);
}

static inline void *mdiodev_get_drvdata(struct mdio_device *mdio)
{
	return dev_get_drvdata(&mdio->dev);
}

void mdio_device_free(struct mdio_device *mdiodev);
struct mdio_device *mdio_device_create(struct mii_bus *bus, int addr);
int mdio_device_register(struct mdio_device *mdiodev);
void mdio_device_remove(struct mdio_device *mdiodev);
void mdio_device_reset(struct mdio_device *mdiodev, int value);
int mdio_driver_register(struct mdio_driver *drv);
void mdio_driver_unregister(struct mdio_driver *drv);
int mdio_device_bus_match(struct device *dev, struct device_driver *drv);

static inline bool mdio_phy_id_is_c45(int phy_id)
{
	return (phy_id & MDIO_PHY_ID_C45) && !(phy_id & ~MDIO_PHY_ID_C45_MASK);
}

static inline __u16 mdio_phy_id_prtad(int phy_id)
{
	return (phy_id & MDIO_PHY_ID_PRTAD) >> 5;
}

static inline __u16 mdio_phy_id_devad(int phy_id)
{
	return phy_id & MDIO_PHY_ID_DEVAD;
}

/**
 * struct mdio_if_info - Ethernet controller MDIO interface
 * @prtad: PRTAD of the PHY (%MDIO_PRTAD_NONE if not present/unknown)
 * @mmds: Mask of MMDs expected to be present in the PHY.  This must be
 *	non-zero unless @prtad = %MDIO_PRTAD_NONE.
 * @mode_support: MDIO modes supported.  If %MDIO_SUPPORTS_C22 is set then
 *	MII register access will be passed through with @devad =
 *	%MDIO_DEVAD_NONE.  If %MDIO_EMULATE_C22 is set then access to
 *	commonly used clause 22 registers will be translated into
 *	clause 45 registers.
 * @dev: Net device structure
 * @mdio_read: Register read function; returns value or negative error code
 * @mdio_write: Register write function; returns 0 or negative error code
 */
struct mdio_if_info {
	int prtad;
	u32 mmds;
	unsigned mode_support;

	struct net_device *dev;
	int (*mdio_read)(struct net_device *dev, int prtad, int devad,
			 u16 addr);
	int (*mdio_write)(struct net_device *dev, int prtad, int devad,
			  u16 addr, u16 val);
};

#define MDIO_PRTAD_NONE			(-1)
#define MDIO_DEVAD_NONE			(-1)
#define MDIO_SUPPORTS_C22		1
#define MDIO_SUPPORTS_C45		2
#define MDIO_EMULATE_C22		4

struct ethtool_cmd;
struct ethtool_pauseparam;
extern int mdio45_probe(struct mdio_if_info *mdio, int prtad);
extern int mdio_set_flag(const struct mdio_if_info *mdio,
			 int prtad, int devad, u16 addr, int mask,
			 bool sense);
extern int mdio45_links_ok(const struct mdio_if_info *mdio, u32 mmds);
extern int mdio45_nway_restart(const struct mdio_if_info *mdio);
extern void mdio45_ethtool_gset_npage(const struct mdio_if_info *mdio,
				      struct ethtool_cmd *ecmd,
				      u32 npage_adv, u32 npage_lpa);
extern void
mdio45_ethtool_ksettings_get_npage(const struct mdio_if_info *mdio,
				   struct ethtool_link_ksettings *cmd,
				   u32 npage_adv, u32 npage_lpa);

/**
 * mdio45_ethtool_gset - get settings for ETHTOOL_GSET
 * @mdio: MDIO interface
 * @ecmd: Ethtool request structure
 *
 * Since the CSRs for auto-negotiation using next pages are not fully
 * standardised, this function does not attempt to decode them.  Use
 * mdio45_ethtool_gset_npage() to specify advertisement bits from next
 * pages.
 */
static inline void mdio45_ethtool_gset(const struct mdio_if_info *mdio,
				       struct ethtool_cmd *ecmd)
{
	mdio45_ethtool_gset_npage(mdio, ecmd, 0, 0);
}

/**
 * mdio45_ethtool_ksettings_get - get settings for ETHTOOL_GLINKSETTINGS
 * @mdio: MDIO interface
 * @cmd: Ethtool request structure
 *
 * Since the CSRs for auto-negotiation using next pages are not fully
 * standardised, this function does not attempt to decode them.  Use
 * mdio45_ethtool_ksettings_get_npage() to specify advertisement bits
 * from next pages.
 */
static inline void
mdio45_ethtool_ksettings_get(const struct mdio_if_info *mdio,
			     struct ethtool_link_ksettings *cmd)
{
	mdio45_ethtool_ksettings_get_npage(mdio, cmd, 0, 0);
}

extern int mdio_mii_ioctl(const struct mdio_if_info *mdio,
			  struct mii_ioctl_data *mii_data, int cmd);

/**
 * mmd_eee_cap_to_ethtool_sup_t
 * @eee_cap: value of the MMD EEE Capability register
 *
 * A small helper function that translates MMD EEE Capability (3.20) bits
 * to ethtool supported settings.
 */
static inline u32 mmd_eee_cap_to_ethtool_sup_t(u16 eee_cap)
{
	u32 supported = 0;

	if (eee_cap & MDIO_EEE_100TX)
		supported |= SUPPORTED_100baseT_Full;
	if (eee_cap & MDIO_EEE_1000T)
		supported |= SUPPORTED_1000baseT_Full;
	if (eee_cap & MDIO_EEE_10GT)
		supported |= SUPPORTED_10000baseT_Full;
	if (eee_cap & MDIO_EEE_1000KX)
		supported |= SUPPORTED_1000baseKX_Full;
	if (eee_cap & MDIO_EEE_10GKX4)
		supported |= SUPPORTED_10000baseKX4_Full;
	if (eee_cap & MDIO_EEE_10GKR)
		supported |= SUPPORTED_10000baseKR_Full;

	return supported;
}

/**
 * mmd_eee_adv_to_ethtool_adv_t
 * @eee_adv: value of the MMD EEE Advertisement/Link Partner Ability registers
 *
 * A small helper function that translates the MMD EEE Advertisment (7.60)
 * and MMD EEE Link Partner Ability (7.61) bits to ethtool advertisement
 * settings.
 */
static inline u32 mmd_eee_adv_to_ethtool_adv_t(u16 eee_adv)
{
	u32 adv = 0;

	if (eee_adv & MDIO_EEE_100TX)
		adv |= ADVERTISED_100baseT_Full;
	if (eee_adv & MDIO_EEE_1000T)
		adv |= ADVERTISED_1000baseT_Full;
	if (eee_adv & MDIO_EEE_10GT)
		adv |= ADVERTISED_10000baseT_Full;
	if (eee_adv & MDIO_EEE_1000KX)
		adv |= ADVERTISED_1000baseKX_Full;
	if (eee_adv & MDIO_EEE_10GKX4)
		adv |= ADVERTISED_10000baseKX4_Full;
	if (eee_adv & MDIO_EEE_10GKR)
		adv |= ADVERTISED_10000baseKR_Full;

	return adv;
}

/**
 * ethtool_adv_to_mmd_eee_adv_t
 * @adv: the ethtool advertisement settings
 *
 * A small helper function that translates ethtool advertisement settings
 * to EEE advertisements for the MMD EEE Advertisement (7.60) and
 * MMD EEE Link Partner Ability (7.61) registers.
 */
static inline u16 ethtool_adv_to_mmd_eee_adv_t(u32 adv)
{
	u16 reg = 0;

	if (adv & ADVERTISED_100baseT_Full)
		reg |= MDIO_EEE_100TX;
	if (adv & ADVERTISED_1000baseT_Full)
		reg |= MDIO_EEE_1000T;
	if (adv & ADVERTISED_10000baseT_Full)
		reg |= MDIO_EEE_10GT;
	if (adv & ADVERTISED_1000baseKX_Full)
		reg |= MDIO_EEE_1000KX;
	if (adv & ADVERTISED_10000baseKX4_Full)
		reg |= MDIO_EEE_10GKX4;
	if (adv & ADVERTISED_10000baseKR_Full)
		reg |= MDIO_EEE_10GKR;

	return reg;
}

/**
 * linkmode_adv_to_mii_10gbt_adv_t
 * @advertising: the linkmode advertisement settings
 *
 * A small helper function that translates linkmode advertisement
 * settings to phy autonegotiation advertisements for the C45
 * 10GBASE-T AN CONTROL (7.32) register.
 */
static inline u32 linkmode_adv_to_mii_10gbt_adv_t(unsigned long *advertising)
{
	u32 result = 0;

	if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
			      advertising))
		result |= MDIO_AN_10GBT_CTRL_ADV2_5G;
	if (linkmode_test_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
			      advertising))
		result |= MDIO_AN_10GBT_CTRL_ADV5G;
	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
			      advertising))
		result |= MDIO_AN_10GBT_CTRL_ADV10G;

	return result;
}

/**
 * mii_10gbt_stat_mod_linkmode_lpa_t
 * @advertising: target the linkmode advertisement settings
 * @lpa: value of the C45 10GBASE-T AN STATUS register
 *
 * A small helper function that translates C45 10GBASE-T AN STATUS register bits
 * to linkmode advertisement settings. Other bits in advertising aren't changed.
 */
static inline void mii_10gbt_stat_mod_linkmode_lpa_t(unsigned long *advertising,
						     u32 lpa)
{
	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
			 advertising, lpa & MDIO_AN_10GBT_STAT_LP2_5G);
	linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
			 advertising, lpa & MDIO_AN_10GBT_STAT_LP5G);
	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
			 advertising, lpa & MDIO_AN_10GBT_STAT_LP10G);
}

/**
 * mii_t1_adv_l_mod_linkmode_t
 * @advertising: target the linkmode advertisement settings
 * @lpa: value of the BASE-T1 Autonegotiation Advertisement [15:0] Register
 *
 * A small helper function that translates BASE-T1 Autonegotiation
 * Advertisement [15:0] Register bits to linkmode advertisement settings.
 * Other bits in advertising aren't changed.
 */
static inline void mii_t1_adv_l_mod_linkmode_t(unsigned long *advertising, u32 lpa)
{
	linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising,
			 lpa & MDIO_AN_T1_ADV_L_PAUSE_CAP);
	linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising,
			 lpa & MDIO_AN_T1_ADV_L_PAUSE_ASYM);
}

/**
 * mii_t1_adv_m_mod_linkmode_t
 * @advertising: target the linkmode advertisement settings
 * @lpa: value of the BASE-T1 Autonegotiation Advertisement [31:16] Register
 *
 * A small helper function that translates BASE-T1 Autonegotiation
 * Advertisement [31:16] Register bits to linkmode advertisement settings.
 * Other bits in advertising aren't changed.
 */
static inline void mii_t1_adv_m_mod_linkmode_t(unsigned long *advertising, u32 lpa)
{
	linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT,
			 advertising, lpa & MDIO_AN_T1_ADV_M_B10L);
}

/**
 * linkmode_adv_to_mii_t1_adv_l_t
 * @advertising: the linkmode advertisement settings
 *
 * A small helper function that translates linkmode advertisement
 * settings to phy autonegotiation advertisements for the
 * BASE-T1 Autonegotiation Advertisement [15:0] Register.
 */
static inline u32 linkmode_adv_to_mii_t1_adv_l_t(unsigned long *advertising)
{
	u32 result = 0;

	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising))
		result |= MDIO_AN_T1_ADV_L_PAUSE_CAP;
	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising))
		result |= MDIO_AN_T1_ADV_L_PAUSE_ASYM;

	return result;
}

/**
 * linkmode_adv_to_mii_t1_adv_m_t
 * @advertising: the linkmode advertisement settings
 *
 * A small helper function that translates linkmode advertisement
 * settings to phy autonegotiation advertisements for the
 * BASE-T1 Autonegotiation Advertisement [31:16] Register.
 */
static inline u32 linkmode_adv_to_mii_t1_adv_m_t(unsigned long *advertising)
{
	u32 result = 0;

	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT, advertising))
		result |= MDIO_AN_T1_ADV_M_B10L;

	return result;
}

int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
int __mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
			     u16 mask, u16 set);

int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum);
int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val);
int mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask,
		   u16 set);
int mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
			   u16 mask, u16 set);

static inline int mdiodev_read(struct mdio_device *mdiodev, u32 regnum)
{
	return mdiobus_read(mdiodev->bus, mdiodev->addr, regnum);
}

static inline int mdiodev_write(struct mdio_device *mdiodev, u32 regnum,
				u16 val)
{
	return mdiobus_write(mdiodev->bus, mdiodev->addr, regnum, val);
}

static inline int mdiodev_modify(struct mdio_device *mdiodev, u32 regnum,
				 u16 mask, u16 set)
{
	return mdiobus_modify(mdiodev->bus, mdiodev->addr, regnum, mask, set);
}

static inline int mdiodev_modify_changed(struct mdio_device *mdiodev,
					 u32 regnum, u16 mask, u16 set)
{
	return mdiobus_modify_changed(mdiodev->bus, mdiodev->addr, regnum,
				      mask, set);
}

static inline u32 mdiobus_c45_addr(int devad, u16 regnum)
{
	return MII_ADDR_C45 | devad << MII_DEVADDR_C45_SHIFT | regnum;
}

static inline u16 mdiobus_c45_regad(u32 regnum)
{
	return FIELD_GET(MII_REGADDR_C45_MASK, regnum);
}

static inline u16 mdiobus_c45_devad(u32 regnum)
{
	return FIELD_GET(MII_DEVADDR_C45_MASK, regnum);
}

static inline int __mdiobus_c45_read(struct mii_bus *bus, int prtad, int devad,
				     u16 regnum)
{
	return __mdiobus_read(bus, prtad, mdiobus_c45_addr(devad, regnum));
}

static inline int __mdiobus_c45_write(struct mii_bus *bus, int prtad, int devad,
				      u16 regnum, u16 val)
{
	return __mdiobus_write(bus, prtad, mdiobus_c45_addr(devad, regnum),
			       val);
}

static inline int mdiobus_c45_read(struct mii_bus *bus, int prtad, int devad,
				   u16 regnum)
{
	return mdiobus_read(bus, prtad, mdiobus_c45_addr(devad, regnum));
}

static inline int mdiobus_c45_write(struct mii_bus *bus, int prtad, int devad,
				    u16 regnum, u16 val)
{
	return mdiobus_write(bus, prtad, mdiobus_c45_addr(devad, regnum), val);
}

int mdiobus_register_device(struct mdio_device *mdiodev);
int mdiobus_unregister_device(struct mdio_device *mdiodev);
bool mdiobus_is_registered_device(struct mii_bus *bus, int addr);
struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr);

/**
 * mdio_module_driver() - Helper macro for registering mdio drivers
 * @_mdio_driver: driver to register
 *
 * Helper macro for MDIO drivers which do not do anything special in module
 * init/exit. Each module may only use this macro once, and calling it
 * replaces module_init() and module_exit().
 */
#define mdio_module_driver(_mdio_driver)				\
static int __init mdio_module_init(void)				\
{									\
	return mdio_driver_register(&_mdio_driver);			\
}									\
module_init(mdio_module_init);						\
static void __exit mdio_module_exit(void)				\
{									\
	mdio_driver_unregister(&_mdio_driver);				\
}									\
module_exit(mdio_module_exit)

#endif /* __LINUX_MDIO_H__ */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
52c94dfa BH	2	/*
	3	* linux/mdio.h: definitions for MDIO (clause 45) transceivers
	4	* Copyright 2006-2009 Solarflare Communications Inc.
52c94dfa	5	*/
52c94dfa BH	6	#ifndef __LINUX_MDIO_H__
	7	#define __LINUX_MDIO_H__
	8
607ca46e	9	#include <uapi/linux/mdio.h>
c6af53f0	10	#include <linux/bitfield.h>
648ea013	11	#include <linux/mod_devicetable.h>
52c94dfa	12
90ce665c RK	13	/* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
	14	* IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips.
	15	*/
	16	#define MII_ADDR_C45 (1<<30)
	17	#define MII_DEVADDR_C45_SHIFT 16
c6af53f0	18	#define MII_DEVADDR_C45_MASK GENMASK(20, 16)
90ce665c RK	19	#define MII_REGADDR_C45_MASK GENMASK(15, 0)
90ce665c RK	20
bafbdd52	21	struct gpio_desc;
bac83c65	22	struct mii_bus;
33374098	23	struct reset_control;
9c717758	24
9a6f2b01 AL	25	/* Multiple levels of nesting are possible. However typically this is
	26	* limited to nested DSA like layer, a MUX layer, and the normal
	27	* user. Instead of trying to handle the general case, just define
	28	* these cases.
	29	*/
	30	enum mdio_mutex_lock_class {
	31	MDIO_MUTEX_NORMAL,
	32	MDIO_MUTEX_MUX,
	33	MDIO_MUTEX_NESTED,
	34	};
	35
e5a03bfd AL	36	struct mdio_device {
e5a03bfd AL	37	struct device dev;
a9049e0c	38
e5a03bfd	39	struct mii_bus *bus;
648ea013	40	char modalias[MDIO_NAME_SIZE];
711fdba3	41
e76a4957	42	int (bus_match)(struct device dev, struct device_driver *drv);
711fdba3 AL	43	void (device_free)(struct mdio_device mdiodev);
	44	void (device_remove)(struct mdio_device mdiodev);
	45
e5a03bfd AL	46	/* Bus address of the MDIO device (0-31) */
e5a03bfd AL	47	int addr;
7f854420	48	int flags;
6110ed2d	49	struct gpio_desc *reset_gpio;
71dd6c0d	50	struct reset_control *reset_ctrl;
04f629f7 RL	51	unsigned int reset_assert_delay;
04f629f7 RL	52	unsigned int reset_deassert_delay;
e5a03bfd	53	};
7eab14de AL	54
	55	static inline struct mdio_device to_mdio_device(const struct device dev)
	56	{
	57	return container_of(dev, struct mdio_device, dev);
	58	}
e5a03bfd	59
a9049e0c AL	60	/* struct mdio_driver_common: Common to all MDIO drivers */
	61	struct mdio_driver_common {
	62	struct device_driver driver;
	63	int flags;
	64	};
7f854420	65	#define MDIO_DEVICE_FLAG_PHY 1
7eab14de AL	66
	67	static inline struct mdio_driver_common *
	68	to_mdio_common_driver(const struct device_driver *driver)
	69	{
	70	return container_of(driver, struct mdio_driver_common, driver);
	71	}
a9049e0c AL	72
	73	/* struct mdio_driver: Generic MDIO driver */
	74	struct mdio_driver {
	75	struct mdio_driver_common mdiodrv;
	76
	77	/*
	78	* Called during discovery. Used to set
	79	* up device-specific structures, if any
	80	*/
	81	int (probe)(struct mdio_device mdiodev);
	82
	83	/* Clears up any memory if needed */
	84	void (remove)(struct mdio_device mdiodev);
cf957997 VO	85
	86	/* Quiesces the device on system shutdown, turns off interrupts etc */
	87	void (shutdown)(struct mdio_device mdiodev);
a9049e0c	88	};
7eab14de AL	89
	90	static inline struct mdio_driver *
	91	to_mdio_driver(const struct device_driver *driver)
	92	{
	93	return container_of(to_mdio_common_driver(driver), struct mdio_driver,
	94	mdiodrv);
	95	}
a9049e0c	96
36b1a2fc HK	97	/* device driver data */
	98	static inline void mdiodev_set_drvdata(struct mdio_device mdio, void data)
	99	{
	100	dev_set_drvdata(&mdio->dev, data);
	101	}
	102
	103	static inline void mdiodev_get_drvdata(struct mdio_device mdio)
	104	{
	105	return dev_get_drvdata(&mdio->dev);
	106	}
	107
a9049e0c AL	108	void mdio_device_free(struct mdio_device *mdiodev);
	109	struct mdio_device mdio_device_create(struct mii_bus bus, int addr);
	110	int mdio_device_register(struct mdio_device *mdiodev);
	111	void mdio_device_remove(struct mdio_device *mdiodev);
bafbdd52	112	void mdio_device_reset(struct mdio_device *mdiodev, int value);
a9049e0c AL	113	int mdio_driver_register(struct mdio_driver *drv);
a9049e0c AL	114	void mdio_driver_unregister(struct mdio_driver *drv);
648ea013	115	int mdio_device_bus_match(struct device dev, struct device_driver drv);
7f854420	116
52c94dfa BH	117	static inline bool mdio_phy_id_is_c45(int phy_id)
	118	{
	119	return (phy_id & MDIO_PHY_ID_C45) && !(phy_id & ~MDIO_PHY_ID_C45_MASK);
	120	}
	121
	122	static inline __u16 mdio_phy_id_prtad(int phy_id)
	123	{
	124	return (phy_id & MDIO_PHY_ID_PRTAD) >> 5;
	125	}
	126
	127	static inline __u16 mdio_phy_id_devad(int phy_id)
	128	{
	129	return phy_id & MDIO_PHY_ID_DEVAD;
	130	}
	131
1b1c2e95 BH	132	/**
	133	* struct mdio_if_info - Ethernet controller MDIO interface
	134	* @prtad: PRTAD of the PHY (%MDIO_PRTAD_NONE if not present/unknown)
	135	* @mmds: Mask of MMDs expected to be present in the PHY. This must be
	136	* non-zero unless @prtad = %MDIO_PRTAD_NONE.
	137	* @mode_support: MDIO modes supported. If %MDIO_SUPPORTS_C22 is set then
	138	* MII register access will be passed through with @devad =
	139	* %MDIO_DEVAD_NONE. If %MDIO_EMULATE_C22 is set then access to
	140	* commonly used clause 22 registers will be translated into
	141	* clause 45 registers.
	142	* @dev: Net device structure
	143	* @mdio_read: Register read function; returns value or negative error code
	144	* @mdio_write: Register write function; returns 0 or negative error code
	145	*/
	146	struct mdio_if_info {
	147	int prtad;
23428e6b	148	u32 mmds;
1b1c2e95 BH	149	unsigned mode_support;
	150
	151	struct net_device *dev;
	152	int (mdio_read)(struct net_device dev, int prtad, int devad,
	153	u16 addr);
	154	int (mdio_write)(struct net_device dev, int prtad, int devad,
	155	u16 addr, u16 val);
	156	};
	157
	158	#define MDIO_PRTAD_NONE (-1)
	159	#define MDIO_DEVAD_NONE (-1)
9c717758 BH	160	#define MDIO_SUPPORTS_C22 1
9c717758 BH	161	#define MDIO_SUPPORTS_C45 2
1b1c2e95 BH	162	#define MDIO_EMULATE_C22 4
	163
	164	struct ethtool_cmd;
	165	struct ethtool_pauseparam;
	166	extern int mdio45_probe(struct mdio_if_info *mdio, int prtad);
	167	extern int mdio_set_flag(const struct mdio_if_info *mdio,
	168	int prtad, int devad, u16 addr, int mask,
	169	bool sense);
	170	extern int mdio45_links_ok(const struct mdio_if_info *mdio, u32 mmds);
	171	extern int mdio45_nway_restart(const struct mdio_if_info *mdio);
	172	extern void mdio45_ethtool_gset_npage(const struct mdio_if_info *mdio,
	173	struct ethtool_cmd *ecmd,
	174	u32 npage_adv, u32 npage_lpa);
8e4881aa PR	175	extern void
	176	mdio45_ethtool_ksettings_get_npage(const struct mdio_if_info *mdio,
	177	struct ethtool_link_ksettings *cmd,
	178	u32 npage_adv, u32 npage_lpa);
1b1c2e95 BH	179
	180	/**
	181	* mdio45_ethtool_gset - get settings for ETHTOOL_GSET
	182	* @mdio: MDIO interface
	183	* @ecmd: Ethtool request structure
	184	*
	185	* Since the CSRs for auto-negotiation using next pages are not fully
	186	* standardised, this function does not attempt to decode them. Use
	187	* mdio45_ethtool_gset_npage() to specify advertisement bits from next
	188	* pages.
	189	*/
	190	static inline void mdio45_ethtool_gset(const struct mdio_if_info *mdio,
	191	struct ethtool_cmd *ecmd)
	192	{
	193	mdio45_ethtool_gset_npage(mdio, ecmd, 0, 0);
	194	}
	195
8e4881aa PR	196	/**
	197	* mdio45_ethtool_ksettings_get - get settings for ETHTOOL_GLINKSETTINGS
	198	* @mdio: MDIO interface
	199	* @cmd: Ethtool request structure
	200	*
	201	* Since the CSRs for auto-negotiation using next pages are not fully
	202	* standardised, this function does not attempt to decode them. Use
	203	* mdio45_ethtool_ksettings_get_npage() to specify advertisement bits
	204	* from next pages.
	205	*/
	206	static inline void
	207	mdio45_ethtool_ksettings_get(const struct mdio_if_info *mdio,
	208	struct ethtool_link_ksettings *cmd)
	209	{
	210	mdio45_ethtool_ksettings_get_npage(mdio, cmd, 0, 0);
	211	}
	212
1b1c2e95 BH	213	extern int mdio_mii_ioctl(const struct mdio_if_info *mdio,
	214	struct mii_ioctl_data *mii_data, int cmd);
	215
b32607dd AB	216	/**
	217	* mmd_eee_cap_to_ethtool_sup_t
	218	* @eee_cap: value of the MMD EEE Capability register
	219	*
	220	* A small helper function that translates MMD EEE Capability (3.20) bits
	221	* to ethtool supported settings.
	222	*/
	223	static inline u32 mmd_eee_cap_to_ethtool_sup_t(u16 eee_cap)
	224	{
	225	u32 supported = 0;
	226
	227	if (eee_cap & MDIO_EEE_100TX)
	228	supported \|= SUPPORTED_100baseT_Full;
	229	if (eee_cap & MDIO_EEE_1000T)
	230	supported \|= SUPPORTED_1000baseT_Full;
	231	if (eee_cap & MDIO_EEE_10GT)
	232	supported \|= SUPPORTED_10000baseT_Full;
	233	if (eee_cap & MDIO_EEE_1000KX)
	234	supported \|= SUPPORTED_1000baseKX_Full;
	235	if (eee_cap & MDIO_EEE_10GKX4)
	236	supported \|= SUPPORTED_10000baseKX4_Full;
	237	if (eee_cap & MDIO_EEE_10GKR)
	238	supported \|= SUPPORTED_10000baseKR_Full;
	239
	240	return supported;
	241	}
	242
	243	/**
	244	* mmd_eee_adv_to_ethtool_adv_t
	245	* @eee_adv: value of the MMD EEE Advertisement/Link Partner Ability registers
	246	*
	247	* A small helper function that translates the MMD EEE Advertisment (7.60)
	248	* and MMD EEE Link Partner Ability (7.61) bits to ethtool advertisement
	249	* settings.
	250	*/
	251	static inline u32 mmd_eee_adv_to_ethtool_adv_t(u16 eee_adv)
	252	{
	253	u32 adv = 0;
	254
	255	if (eee_adv & MDIO_EEE_100TX)
	256	adv \|= ADVERTISED_100baseT_Full;
	257	if (eee_adv & MDIO_EEE_1000T)
	258	adv \|= ADVERTISED_1000baseT_Full;
	259	if (eee_adv & MDIO_EEE_10GT)
	260	adv \|= ADVERTISED_10000baseT_Full;
	261	if (eee_adv & MDIO_EEE_1000KX)
	262	adv \|= ADVERTISED_1000baseKX_Full;
	263	if (eee_adv & MDIO_EEE_10GKX4)
	264	adv \|= ADVERTISED_10000baseKX4_Full;
	265	if (eee_adv & MDIO_EEE_10GKR)
	266	adv \|= ADVERTISED_10000baseKR_Full;
	267
	268	return adv;
	269	}
	270
	271	/**
	272	* ethtool_adv_to_mmd_eee_adv_t
	273	* @adv: the ethtool advertisement settings
	274	*
	275	* A small helper function that translates ethtool advertisement settings
	276	* to EEE advertisements for the MMD EEE Advertisement (7.60) and
	277	* MMD EEE Link Partner Ability (7.61) registers.
	278	*/
	279	static inline u16 ethtool_adv_to_mmd_eee_adv_t(u32 adv)
280	{
281	u16 reg = 0;
282
283	if (adv & ADVERTISED_100baseT_Full)
284	reg \|= MDIO_EEE_100TX;
285	if (adv & ADVERTISED_1000baseT_Full)
286	reg \|= MDIO_EEE_1000T;
287	if (adv & ADVERTISED_10000baseT_Full)
288	reg \|= MDIO_EEE_10GT;
289	if (adv & ADVERTISED_1000baseKX_Full)
290	reg \|= MDIO_EEE_1000KX;
291	if (adv & ADVERTISED_10000baseKX4_Full)
292	reg \|= MDIO_EEE_10GKX4;
293	if (adv & ADVERTISED_10000baseKR_Full)
294	reg \|= MDIO_EEE_10GKR;
295
296	return reg;
297	}
298
744e458a HK	299	/**
	300	* linkmode_adv_to_mii_10gbt_adv_t
	301	* @advertising: the linkmode advertisement settings
	302	*
	303	* A small helper function that translates linkmode advertisement
	304	* settings to phy autonegotiation advertisements for the C45
	305	* 10GBASE-T AN CONTROL (7.32) register.
	306	*/
	307	static inline u32 linkmode_adv_to_mii_10gbt_adv_t(unsigned long *advertising)
	308	{
	309	u32 result = 0;
	310
	311	if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
	312	advertising))
	313	result \|= MDIO_AN_10GBT_CTRL_ADV2_5G;
	314	if (linkmode_test_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
	315	advertising))
	316	result \|= MDIO_AN_10GBT_CTRL_ADV5G;
	317	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
	318	advertising))
	319	result \|= MDIO_AN_10GBT_CTRL_ADV10G;
	320
	321	return result;
	322	}
	323
9004a14c HK	324	/**
	325	* mii_10gbt_stat_mod_linkmode_lpa_t
	326	* @advertising: target the linkmode advertisement settings
39097ab6	327	* @lpa: value of the C45 10GBASE-T AN STATUS register
9004a14c HK	328	*
	329	* A small helper function that translates C45 10GBASE-T AN STATUS register bits
	330	* to linkmode advertisement settings. Other bits in advertising aren't changed.
	331	*/
	332	static inline void mii_10gbt_stat_mod_linkmode_lpa_t(unsigned long *advertising,
	333	u32 lpa)
	334	{
	335	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
	336	advertising, lpa & MDIO_AN_10GBT_STAT_LP2_5G);
	337	linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
	338	advertising, lpa & MDIO_AN_10GBT_STAT_LP5G);
	339	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
	340	advertising, lpa & MDIO_AN_10GBT_STAT_LP10G);
	341	}
	342
3da8ffd8 AT	343	/**
	344	* mii_t1_adv_l_mod_linkmode_t
	345	* @advertising: target the linkmode advertisement settings
	346	* @lpa: value of the BASE-T1 Autonegotiation Advertisement [15:0] Register
	347	*
	348	* A small helper function that translates BASE-T1 Autonegotiation
	349	* Advertisement [15:0] Register bits to linkmode advertisement settings.
	350	* Other bits in advertising aren't changed.
	351	*/
	352	static inline void mii_t1_adv_l_mod_linkmode_t(unsigned long *advertising, u32 lpa)
	353	{
	354	linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising,
	355	lpa & MDIO_AN_T1_ADV_L_PAUSE_CAP);
	356	linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising,
	357	lpa & MDIO_AN_T1_ADV_L_PAUSE_ASYM);
	358	}
	359
	360	/**
	361	* mii_t1_adv_m_mod_linkmode_t
	362	* @advertising: target the linkmode advertisement settings
	363	* @lpa: value of the BASE-T1 Autonegotiation Advertisement [31:16] Register
	364	*
	365	* A small helper function that translates BASE-T1 Autonegotiation
	366	* Advertisement [31:16] Register bits to linkmode advertisement settings.
	367	* Other bits in advertising aren't changed.
	368	*/
	369	static inline void mii_t1_adv_m_mod_linkmode_t(unsigned long *advertising, u32 lpa)
	370	{
	371	linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT,
	372	advertising, lpa & MDIO_AN_T1_ADV_M_B10L);
	373	}
	374
	375	/**
	376	* linkmode_adv_to_mii_t1_adv_l_t
	377	* @advertising: the linkmode advertisement settings
	378	*
	379	* A small helper function that translates linkmode advertisement
	380	* settings to phy autonegotiation advertisements for the
	381	* BASE-T1 Autonegotiation Advertisement [15:0] Register.
	382	*/
	383	static inline u32 linkmode_adv_to_mii_t1_adv_l_t(unsigned long *advertising)
	384	{
	385	u32 result = 0;
	386
	387	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising))
	388	result \|= MDIO_AN_T1_ADV_L_PAUSE_CAP;
	389	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising))
	390	result \|= MDIO_AN_T1_ADV_L_PAUSE_ASYM;
	391
	392	return result;
	393	}
	394
	395	/**
	396	* linkmode_adv_to_mii_t1_adv_m_t
	397	* @advertising: the linkmode advertisement settings
	398	*
	399	* A small helper function that translates linkmode advertisement
	400	* settings to phy autonegotiation advertisements for the
	401	* BASE-T1 Autonegotiation Advertisement [31:16] Register.
	402	*/
	403	static inline u32 linkmode_adv_to_mii_t1_adv_m_t(unsigned long *advertising)
	404	{
	405	u32 result = 0;
	406
407	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1L_Full_BIT, advertising))
408	result \|= MDIO_AN_T1_ADV_M_B10L;
409
410	return result;
411	}
412
34dc08e4 RK	413	int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
34dc08e4 RK	414	int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
6cc7cf81 RK	415	int __mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
6cc7cf81 RK	416	u16 mask, u16 set);
34dc08e4	417
bac83c65 AL	418	int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
	419	int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum);
	420	int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
	421	int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val);
6cc7cf81 RK	422	int mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask,
6cc7cf81 RK	423	u16 set);
79365f36 RKO	424	int mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
79365f36 RKO	425	u16 mask, u16 set);
bac83c65	426
0ebecb26 SA	427	static inline int mdiodev_read(struct mdio_device *mdiodev, u32 regnum)
	428	{
	429	return mdiobus_read(mdiodev->bus, mdiodev->addr, regnum);
	430	}
	431
	432	static inline int mdiodev_write(struct mdio_device *mdiodev, u32 regnum,
	433	u16 val)
	434	{
	435	return mdiobus_write(mdiodev->bus, mdiodev->addr, regnum, val);
	436	}
	437
	438	static inline int mdiodev_modify(struct mdio_device *mdiodev, u32 regnum,
	439	u16 mask, u16 set)
	440	{
	441	return mdiobus_modify(mdiodev->bus, mdiodev->addr, regnum, mask, set);
	442	}
	443
	444	static inline int mdiodev_modify_changed(struct mdio_device *mdiodev,
	445	u32 regnum, u16 mask, u16 set)
	446	{
	447	return mdiobus_modify_changed(mdiodev->bus, mdiodev->addr, regnum,
	448	mask, set);
	449	}
	450
90ce665c RK	451	static inline u32 mdiobus_c45_addr(int devad, u16 regnum)
	452	{
	453	return MII_ADDR_C45 \| devad << MII_DEVADDR_C45_SHIFT \| regnum;
	454	}
	455
c6af53f0 RKO	456	static inline u16 mdiobus_c45_regad(u32 regnum)
	457	{
	458	return FIELD_GET(MII_REGADDR_C45_MASK, regnum);
	459	}
	460
	461	static inline u16 mdiobus_c45_devad(u32 regnum)
	462	{
	463	return FIELD_GET(MII_DEVADDR_C45_MASK, regnum);
	464	}
	465
90ce665c RK	466	static inline int __mdiobus_c45_read(struct mii_bus *bus, int prtad, int devad,
	467	u16 regnum)
	468	{
	469	return __mdiobus_read(bus, prtad, mdiobus_c45_addr(devad, regnum));
	470	}
	471
	472	static inline int __mdiobus_c45_write(struct mii_bus *bus, int prtad, int devad,
	473	u16 regnum, u16 val)
	474	{
	475	return __mdiobus_write(bus, prtad, mdiobus_c45_addr(devad, regnum),
	476	val);
	477	}
	478
	479	static inline int mdiobus_c45_read(struct mii_bus *bus, int prtad, int devad,
	480	u16 regnum)
	481	{
	482	return mdiobus_read(bus, prtad, mdiobus_c45_addr(devad, regnum));
	483	}
	484
2dab432c IC	485	static inline int mdiobus_c45_write(struct mii_bus *bus, int prtad, int devad,
	486	u16 regnum, u16 val)
	487	{
	488	return mdiobus_write(bus, prtad, mdiobus_c45_addr(devad, regnum), val);
	489	}
	490
7f854420 AL	491	int mdiobus_register_device(struct mdio_device *mdiodev);
	492	int mdiobus_unregister_device(struct mdio_device *mdiodev);
	493	bool mdiobus_is_registered_device(struct mii_bus *bus, int addr);
	494	struct phy_device mdiobus_get_phy(struct mii_bus bus, int addr);
	495
a9049e0c	496	/**
b70f43a1	497	* mdio_module_driver() - Helper macro for registering mdio drivers
39097ab6	498	* @_mdio_driver: driver to register
a9049e0c AL	499	*
	500	* Helper macro for MDIO drivers which do not do anything special in module
	501	* init/exit. Each module may only use this macro once, and calling it
	502	* replaces module_init() and module_exit().
	503	*/
	504	#define mdio_module_driver(_mdio_driver) \
	505	static int __init mdio_module_init(void) \
	506	{ \
	507	return mdio_driver_register(&_mdio_driver); \
	508	} \
	509	module_init(mdio_module_init); \
	510	static void __exit mdio_module_exit(void) \
	511	{ \
	512	mdio_driver_unregister(&_mdio_driver); \
	513	} \
	514	module_exit(mdio_module_exit)
	515
52c94dfa	516	#endif /* __LINUX_MDIO_H__ */