[thirdparty/kernel/stable.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/mod_devicetable.h>

struct gpio_desc;
struct mii_bus;

/* 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;
};
#define to_mdio_device(d) container_of(d, 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
#define to_mdio_common_driver(d) \
	container_of(d, 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);
};
#define to_mdio_driver(d)						\
	container_of(to_mdio_common_driver(d), struct mdio_driver, mdiodrv)

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
 * @adv: 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);
}

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_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_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
 *
 * 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>
648ea013	10	#include <linux/mod_devicetable.h>
52c94dfa	11
bafbdd52	12	struct gpio_desc;
bac83c65	13	struct mii_bus;
9c717758	14
9a6f2b01 AL	15	/* Multiple levels of nesting are possible. However typically this is
	16	* limited to nested DSA like layer, a MUX layer, and the normal
	17	* user. Instead of trying to handle the general case, just define
	18	* these cases.
	19	*/
	20	enum mdio_mutex_lock_class {
	21	MDIO_MUTEX_NORMAL,
	22	MDIO_MUTEX_MUX,
	23	MDIO_MUTEX_NESTED,
	24	};
	25
e5a03bfd AL	26	struct mdio_device {
e5a03bfd AL	27	struct device dev;
a9049e0c	28
e5a03bfd	29	struct mii_bus *bus;
648ea013	30	char modalias[MDIO_NAME_SIZE];
711fdba3	31
e76a4957	32	int (bus_match)(struct device dev, struct device_driver *drv);
711fdba3 AL	33	void (device_free)(struct mdio_device mdiodev);
	34	void (device_remove)(struct mdio_device mdiodev);
	35
e5a03bfd AL	36	/* Bus address of the MDIO device (0-31) */
e5a03bfd AL	37	int addr;
7f854420	38	int flags;
6110ed2d	39	struct gpio_desc *reset_gpio;
71dd6c0d	40	struct reset_control *reset_ctrl;
04f629f7 RL	41	unsigned int reset_assert_delay;
04f629f7 RL	42	unsigned int reset_deassert_delay;
e5a03bfd AL	43	};
	44	#define to_mdio_device(d) container_of(d, struct mdio_device, dev)
	45
a9049e0c AL	46	/* struct mdio_driver_common: Common to all MDIO drivers */
	47	struct mdio_driver_common {
	48	struct device_driver driver;
	49	int flags;
	50	};
7f854420	51	#define MDIO_DEVICE_FLAG_PHY 1
a9049e0c AL	52	#define to_mdio_common_driver(d) \
	53	container_of(d, struct mdio_driver_common, driver)
	54
	55	/* struct mdio_driver: Generic MDIO driver */
	56	struct mdio_driver {
	57	struct mdio_driver_common mdiodrv;
	58
	59	/*
	60	* Called during discovery. Used to set
	61	* up device-specific structures, if any
	62	*/
	63	int (probe)(struct mdio_device mdiodev);
	64
	65	/* Clears up any memory if needed */
	66	void (remove)(struct mdio_device mdiodev);
	67	};
	68	#define to_mdio_driver(d) \
	69	container_of(to_mdio_common_driver(d), struct mdio_driver, mdiodrv)
	70
	71	void mdio_device_free(struct mdio_device *mdiodev);
	72	struct mdio_device mdio_device_create(struct mii_bus bus, int addr);
	73	int mdio_device_register(struct mdio_device *mdiodev);
	74	void mdio_device_remove(struct mdio_device *mdiodev);
bafbdd52	75	void mdio_device_reset(struct mdio_device *mdiodev, int value);
a9049e0c AL	76	int mdio_driver_register(struct mdio_driver *drv);
a9049e0c AL	77	void mdio_driver_unregister(struct mdio_driver *drv);
648ea013	78	int mdio_device_bus_match(struct device dev, struct device_driver drv);
7f854420	79
52c94dfa BH	80	static inline bool mdio_phy_id_is_c45(int phy_id)
	81	{
	82	return (phy_id & MDIO_PHY_ID_C45) && !(phy_id & ~MDIO_PHY_ID_C45_MASK);
	83	}
	84
	85	static inline __u16 mdio_phy_id_prtad(int phy_id)
	86	{
	87	return (phy_id & MDIO_PHY_ID_PRTAD) >> 5;
	88	}
	89
	90	static inline __u16 mdio_phy_id_devad(int phy_id)
	91	{
	92	return phy_id & MDIO_PHY_ID_DEVAD;
	93	}
	94
1b1c2e95 BH	95	/**
	96	* struct mdio_if_info - Ethernet controller MDIO interface
	97	* @prtad: PRTAD of the PHY (%MDIO_PRTAD_NONE if not present/unknown)
	98	* @mmds: Mask of MMDs expected to be present in the PHY. This must be
	99	* non-zero unless @prtad = %MDIO_PRTAD_NONE.
	100	* @mode_support: MDIO modes supported. If %MDIO_SUPPORTS_C22 is set then
	101	* MII register access will be passed through with @devad =
	102	* %MDIO_DEVAD_NONE. If %MDIO_EMULATE_C22 is set then access to
	103	* commonly used clause 22 registers will be translated into
	104	* clause 45 registers.
	105	* @dev: Net device structure
	106	* @mdio_read: Register read function; returns value or negative error code
	107	* @mdio_write: Register write function; returns 0 or negative error code
	108	*/
	109	struct mdio_if_info {
	110	int prtad;
23428e6b	111	u32 mmds;
1b1c2e95 BH	112	unsigned mode_support;
	113
	114	struct net_device *dev;
	115	int (mdio_read)(struct net_device dev, int prtad, int devad,
	116	u16 addr);
	117	int (mdio_write)(struct net_device dev, int prtad, int devad,
	118	u16 addr, u16 val);
	119	};
	120
	121	#define MDIO_PRTAD_NONE (-1)
	122	#define MDIO_DEVAD_NONE (-1)
9c717758 BH	123	#define MDIO_SUPPORTS_C22 1
9c717758 BH	124	#define MDIO_SUPPORTS_C45 2
1b1c2e95 BH	125	#define MDIO_EMULATE_C22 4
	126
	127	struct ethtool_cmd;
	128	struct ethtool_pauseparam;
	129	extern int mdio45_probe(struct mdio_if_info *mdio, int prtad);
	130	extern int mdio_set_flag(const struct mdio_if_info *mdio,
	131	int prtad, int devad, u16 addr, int mask,
	132	bool sense);
	133	extern int mdio45_links_ok(const struct mdio_if_info *mdio, u32 mmds);
	134	extern int mdio45_nway_restart(const struct mdio_if_info *mdio);
	135	extern void mdio45_ethtool_gset_npage(const struct mdio_if_info *mdio,
	136	struct ethtool_cmd *ecmd,
	137	u32 npage_adv, u32 npage_lpa);
8e4881aa PR	138	extern void
	139	mdio45_ethtool_ksettings_get_npage(const struct mdio_if_info *mdio,
	140	struct ethtool_link_ksettings *cmd,
	141	u32 npage_adv, u32 npage_lpa);
1b1c2e95 BH	142
	143	/**
	144	* mdio45_ethtool_gset - get settings for ETHTOOL_GSET
	145	* @mdio: MDIO interface
	146	* @ecmd: Ethtool request structure
	147	*
	148	* Since the CSRs for auto-negotiation using next pages are not fully
	149	* standardised, this function does not attempt to decode them. Use
	150	* mdio45_ethtool_gset_npage() to specify advertisement bits from next
	151	* pages.
	152	*/
	153	static inline void mdio45_ethtool_gset(const struct mdio_if_info *mdio,
	154	struct ethtool_cmd *ecmd)
	155	{
	156	mdio45_ethtool_gset_npage(mdio, ecmd, 0, 0);
	157	}
	158
8e4881aa PR	159	/**
	160	* mdio45_ethtool_ksettings_get - get settings for ETHTOOL_GLINKSETTINGS
	161	* @mdio: MDIO interface
	162	* @cmd: Ethtool request structure
	163	*
	164	* Since the CSRs for auto-negotiation using next pages are not fully
	165	* standardised, this function does not attempt to decode them. Use
	166	* mdio45_ethtool_ksettings_get_npage() to specify advertisement bits
	167	* from next pages.
	168	*/
	169	static inline void
	170	mdio45_ethtool_ksettings_get(const struct mdio_if_info *mdio,
	171	struct ethtool_link_ksettings *cmd)
	172	{
	173	mdio45_ethtool_ksettings_get_npage(mdio, cmd, 0, 0);
	174	}
	175
1b1c2e95 BH	176	extern int mdio_mii_ioctl(const struct mdio_if_info *mdio,
	177	struct mii_ioctl_data *mii_data, int cmd);
	178
b32607dd AB	179	/**
	180	* mmd_eee_cap_to_ethtool_sup_t
	181	* @eee_cap: value of the MMD EEE Capability register
	182	*
	183	* A small helper function that translates MMD EEE Capability (3.20) bits
	184	* to ethtool supported settings.
	185	*/
	186	static inline u32 mmd_eee_cap_to_ethtool_sup_t(u16 eee_cap)
	187	{
	188	u32 supported = 0;
	189
	190	if (eee_cap & MDIO_EEE_100TX)
	191	supported \|= SUPPORTED_100baseT_Full;
	192	if (eee_cap & MDIO_EEE_1000T)
	193	supported \|= SUPPORTED_1000baseT_Full;
	194	if (eee_cap & MDIO_EEE_10GT)
	195	supported \|= SUPPORTED_10000baseT_Full;
	196	if (eee_cap & MDIO_EEE_1000KX)
	197	supported \|= SUPPORTED_1000baseKX_Full;
	198	if (eee_cap & MDIO_EEE_10GKX4)
	199	supported \|= SUPPORTED_10000baseKX4_Full;
	200	if (eee_cap & MDIO_EEE_10GKR)
	201	supported \|= SUPPORTED_10000baseKR_Full;
	202
	203	return supported;
	204	}
	205
	206	/**
	207	* mmd_eee_adv_to_ethtool_adv_t
	208	* @eee_adv: value of the MMD EEE Advertisement/Link Partner Ability registers
	209	*
	210	* A small helper function that translates the MMD EEE Advertisment (7.60)
	211	* and MMD EEE Link Partner Ability (7.61) bits to ethtool advertisement
	212	* settings.
	213	*/
	214	static inline u32 mmd_eee_adv_to_ethtool_adv_t(u16 eee_adv)
	215	{
	216	u32 adv = 0;
	217
	218	if (eee_adv & MDIO_EEE_100TX)
	219	adv \|= ADVERTISED_100baseT_Full;
	220	if (eee_adv & MDIO_EEE_1000T)
	221	adv \|= ADVERTISED_1000baseT_Full;
	222	if (eee_adv & MDIO_EEE_10GT)
	223	adv \|= ADVERTISED_10000baseT_Full;
	224	if (eee_adv & MDIO_EEE_1000KX)
	225	adv \|= ADVERTISED_1000baseKX_Full;
	226	if (eee_adv & MDIO_EEE_10GKX4)
	227	adv \|= ADVERTISED_10000baseKX4_Full;
	228	if (eee_adv & MDIO_EEE_10GKR)
	229	adv \|= ADVERTISED_10000baseKR_Full;
	230
	231	return adv;
	232	}
	233
	234	/**
	235	* ethtool_adv_to_mmd_eee_adv_t
	236	* @adv: the ethtool advertisement settings
	237	*
	238	* A small helper function that translates ethtool advertisement settings
	239	* to EEE advertisements for the MMD EEE Advertisement (7.60) and
	240	* MMD EEE Link Partner Ability (7.61) registers.
	241	*/
	242	static inline u16 ethtool_adv_to_mmd_eee_adv_t(u32 adv)
243	{
244	u16 reg = 0;
245
246	if (adv & ADVERTISED_100baseT_Full)
247	reg \|= MDIO_EEE_100TX;
248	if (adv & ADVERTISED_1000baseT_Full)
249	reg \|= MDIO_EEE_1000T;
250	if (adv & ADVERTISED_10000baseT_Full)
251	reg \|= MDIO_EEE_10GT;
252	if (adv & ADVERTISED_1000baseKX_Full)
253	reg \|= MDIO_EEE_1000KX;
254	if (adv & ADVERTISED_10000baseKX4_Full)
255	reg \|= MDIO_EEE_10GKX4;
256	if (adv & ADVERTISED_10000baseKR_Full)
257	reg \|= MDIO_EEE_10GKR;
258
259	return reg;
260	}
261
744e458a HK	262	/**
	263	* linkmode_adv_to_mii_10gbt_adv_t
	264	* @advertising: the linkmode advertisement settings
	265	*
	266	* A small helper function that translates linkmode advertisement
	267	* settings to phy autonegotiation advertisements for the C45
	268	* 10GBASE-T AN CONTROL (7.32) register.
	269	*/
	270	static inline u32 linkmode_adv_to_mii_10gbt_adv_t(unsigned long *advertising)
	271	{
	272	u32 result = 0;
	273
	274	if (linkmode_test_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
	275	advertising))
	276	result \|= MDIO_AN_10GBT_CTRL_ADV2_5G;
	277	if (linkmode_test_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
	278	advertising))
	279	result \|= MDIO_AN_10GBT_CTRL_ADV5G;
	280	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
	281	advertising))
	282	result \|= MDIO_AN_10GBT_CTRL_ADV10G;
	283
	284	return result;
	285	}
	286
9004a14c HK	287	/**
	288	* mii_10gbt_stat_mod_linkmode_lpa_t
	289	* @advertising: target the linkmode advertisement settings
	290	* @adv: value of the C45 10GBASE-T AN STATUS register
	291	*
	292	* A small helper function that translates C45 10GBASE-T AN STATUS register bits
	293	* to linkmode advertisement settings. Other bits in advertising aren't changed.
	294	*/
	295	static inline void mii_10gbt_stat_mod_linkmode_lpa_t(unsigned long *advertising,
	296	u32 lpa)
	297	{
	298	linkmode_mod_bit(ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
	299	advertising, lpa & MDIO_AN_10GBT_STAT_LP2_5G);
	300	linkmode_mod_bit(ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
	301	advertising, lpa & MDIO_AN_10GBT_STAT_LP5G);
	302	linkmode_mod_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
	303	advertising, lpa & MDIO_AN_10GBT_STAT_LP10G);
	304	}
	305
34dc08e4 RK	306	int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
	307	int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
	308
bac83c65 AL	309	int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
	310	int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum);
	311	int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
	312	int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val);
	313
7f854420 AL	314	int mdiobus_register_device(struct mdio_device *mdiodev);
	315	int mdiobus_unregister_device(struct mdio_device *mdiodev);
	316	bool mdiobus_is_registered_device(struct mii_bus *bus, int addr);
	317	struct phy_device mdiobus_get_phy(struct mii_bus bus, int addr);
	318
a9049e0c	319	/**
b70f43a1	320	* mdio_module_driver() - Helper macro for registering mdio drivers
a9049e0c AL	321	*
	322	* Helper macro for MDIO drivers which do not do anything special in module
	323	* init/exit. Each module may only use this macro once, and calling it
	324	* replaces module_init() and module_exit().
	325	*/
	326	#define mdio_module_driver(_mdio_driver) \
	327	static int __init mdio_module_init(void) \
	328	{ \
	329	return mdio_driver_register(&_mdio_driver); \
	330	} \
	331	module_init(mdio_module_init); \
	332	static void __exit mdio_module_exit(void) \
	333	{ \
	334	mdio_driver_unregister(&_mdio_driver); \
	335	} \
	336	module_exit(mdio_module_exit)
	337
52c94dfa	338	#endif /* __LINUX_MDIO_H__ */