/* 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> 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 { … }; struct mdio_device { … }; static inline struct mdio_device *to_mdio_device(const struct device *dev) { … } /* struct mdio_driver_common: Common to all MDIO drivers */ struct mdio_driver_common { … }; #define MDIO_DEVICE_FLAG_PHY … #define to_mdio_common_driver(__drv_c) … /* struct mdio_driver: Generic MDIO driver */ struct mdio_driver { … }; #define to_mdio_driver(__drv_m) … /* device driver data */ static inline void mdiodev_set_drvdata(struct mdio_device *mdio, void *data) { … } static inline void *mdiodev_get_drvdata(struct mdio_device *mdio) { … } 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, const struct device_driver *drv); static inline void mdio_device_get(struct mdio_device *mdiodev) { … } static inline void mdio_device_put(struct mdio_device *mdiodev) { … } static inline bool mdio_phy_id_is_c45(int phy_id) { … } static inline __u16 mdio_phy_id_prtad(int phy_id) { … } static inline __u16 mdio_phy_id_devad(int phy_id) { … } /** * 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 { … }; #define MDIO_PRTAD_NONE … #define MDIO_DEVAD_NONE … #define MDIO_SUPPORTS_C22 … #define MDIO_SUPPORTS_C45 … #define MDIO_EMULATE_C22 … 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_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) { … } 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) { … } /** * 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) { … } /** * 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) { … } /** * 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) { … } /** * 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) { … } /** * 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) { … } /** * 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_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) { … } /** * 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) { … } /** * mii_eee_cap1_mod_linkmode_t() * @adv: target the linkmode advertisement settings * @val: register value * * A function that translates value of following registers to the linkmode: * IEEE 802.3-2018 45.2.3.10 "EEE control and capability 1" register (3.20) * IEEE 802.3-2018 45.2.7.13 "EEE advertisement 1" register (7.60) * IEEE 802.3-2018 45.2.7.14 "EEE link partner ability 1" register (7.61) */ static inline void mii_eee_cap1_mod_linkmode_t(unsigned long *adv, u32 val) { … } /** * mii_eee_cap2_mod_linkmode_sup_t() * @adv: target the linkmode settings * @val: register value * * A function that translates value of following registers to the linkmode: * IEEE 802.3-2022 45.2.3.11 "EEE control and capability 2" register (3.21) */ static inline void mii_eee_cap2_mod_linkmode_sup_t(unsigned long *adv, u32 val) { … } /** * mii_eee_cap2_mod_linkmode_adv_t() * @adv: target the linkmode advertisement settings * @val: register value * * A function that translates value of following registers to the linkmode: * IEEE 802.3-2022 45.2.7.16 "EEE advertisement 2" register (7.62) * IEEE 802.3-2022 45.2.7.17 "EEE link partner ability 2" register (7.63) * Note: Currently this function is the same as mii_eee_cap2_mod_linkmode_sup_t. * For certain, not yet supported, modes however the bits differ. * Therefore create separate functions already. */ static inline void mii_eee_cap2_mod_linkmode_adv_t(unsigned long *adv, u32 val) { … } /** * linkmode_to_mii_eee_cap1_t() * @adv: the linkmode advertisement settings * * A function that translates linkmode to value for IEEE 802.3-2018 45.2.7.13 * "EEE advertisement 1" register (7.60) */ static inline u32 linkmode_to_mii_eee_cap1_t(unsigned long *adv) { … } /** * linkmode_to_mii_eee_cap2_t() * @adv: the linkmode advertisement settings * * A function that translates linkmode to value for IEEE 802.3-2022 45.2.7.16 * "EEE advertisement 2" register (7.62) */ static inline u32 linkmode_to_mii_eee_cap2_t(unsigned long *adv) { … } /** * mii_10base_t1_adv_mod_linkmode_t() * @adv: linkmode advertisement settings * @val: register value * * A function that translates IEEE 802.3cg-2019 45.2.7.26 "10BASE-T1 AN status" * register (7.527) value to the linkmode. */ static inline void mii_10base_t1_adv_mod_linkmode_t(unsigned long *adv, u16 val) { … } /** * linkmode_adv_to_mii_10base_t1_t() * @adv: linkmode advertisement settings * * A function that translates the linkmode to IEEE 802.3cg-2019 45.2.7.25 * "10BASE-T1 AN control" register (7.526) value. */ static inline u32 linkmode_adv_to_mii_10base_t1_t(unsigned long *adv) { … } /** * mii_c73_mod_linkmode - convert a Clause 73 advertisement to linkmodes * @adv: linkmode advertisement setting * @lpa: array of three u16s containing the advertisement * * Convert an IEEE 802.3 Clause 73 advertisement to ethtool link modes. */ static inline void mii_c73_mod_linkmode(unsigned long *adv, u16 *lpa) { … } 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(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); 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); int __mdiobus_c45_read(struct mii_bus *bus, int addr, int devad, u32 regnum); int mdiobus_c45_read(struct mii_bus *bus, int addr, int devad, u32 regnum); int mdiobus_c45_read_nested(struct mii_bus *bus, int addr, int devad, u32 regnum); int __mdiobus_c45_write(struct mii_bus *bus, int addr, int devad, u32 regnum, u16 val); int mdiobus_c45_write(struct mii_bus *bus, int addr, int devad, u32 regnum, u16 val); int mdiobus_c45_write_nested(struct mii_bus *bus, int addr, int devad, u32 regnum, u16 val); int mdiobus_c45_modify(struct mii_bus *bus, int addr, int devad, u32 regnum, u16 mask, u16 set); int mdiobus_c45_modify_changed(struct mii_bus *bus, int addr, int devad, u32 regnum, u16 mask, u16 set); static inline int __mdiodev_read(struct mdio_device *mdiodev, u32 regnum) { … } static inline int __mdiodev_write(struct mdio_device *mdiodev, u32 regnum, u16 val) { … } static inline int __mdiodev_modify(struct mdio_device *mdiodev, u32 regnum, u16 mask, u16 set) { … } static inline int __mdiodev_modify_changed(struct mdio_device *mdiodev, u32 regnum, u16 mask, u16 set) { … } static inline int mdiodev_read(struct mdio_device *mdiodev, u32 regnum) { … } static inline int mdiodev_write(struct mdio_device *mdiodev, u32 regnum, u16 val) { … } static inline int mdiodev_modify(struct mdio_device *mdiodev, u32 regnum, u16 mask, u16 set) { … } static inline int mdiodev_modify_changed(struct mdio_device *mdiodev, u32 regnum, u16 mask, u16 set) { … } static inline int mdiodev_c45_modify(struct mdio_device *mdiodev, int devad, u32 regnum, u16 mask, u16 set) { … } static inline int mdiodev_c45_modify_changed(struct mdio_device *mdiodev, int devad, u32 regnum, u16 mask, u16 set) { … } static inline int mdiodev_c45_read(struct mdio_device *mdiodev, int devad, u16 regnum) { … } static inline int mdiodev_c45_write(struct mdio_device *mdiodev, u32 devad, u16 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 * @_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) … #endif /* __LINUX_MDIO_H__ */
Codebase Browser
linux