include/linux/of_mdio.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * OF helpers for the MDIO (Ethernet PHY) API
   4  *
   5  * Copyright (c) 2009 Secret Lab Technologies, Ltd.
   6  */
   7
   8 #ifndef __LINUX_OF_MDIO_H
   9 #define __LINUX_OF_MDIO_H
  10
  11 #include <linux/device.h>
  12 #include <linux/phy.h>
  13 #include <linux/of.h>
  14
  15 #if IS_ENABLED(CONFIG_OF_MDIO)
  16 bool of_mdiobus_child_is_phy(struct device_node *child);
  17 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np);
  18 int devm_of_mdiobus_register(struct device *dev, struct mii_bus *mdio,
  19                              struct device_node *np);
  20 struct mdio_device *of_mdio_find_device(struct device_node *np);
  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 *
  27 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
  28                        void (*hndlr)(struct net_device *));
  29 struct phy_device *
  30 of_phy_attach(struct net_device *dev, struct device_node *phy_np,
  31               u32 flags, phy_interface_t iface);
  32
  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);
  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
  62 #else /* CONFIG_OF_MDIO */
  63 static inline bool of_mdiobus_child_is_phy(struct device_node *child)
  64 {
  65         return false;
  66 }
  67
  68 static inline int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
  69 {
  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);
  76 }
  77
  78 static inline struct mdio_device *of_mdio_find_device(struct device_node *np)
  79 {
  80         return NULL;
  81 }
  82
  83 static inline struct phy_device *of_phy_find_device(struct device_node *phy_np)
  84 {
  85         return NULL;
  86 }
  87
  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)
  92 {
  93         return NULL;
  94 }
  95
  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
 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
 110 static inline struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np)
 111 {
 112         return NULL;
 113 }
 114
 115 static inline int of_mdio_parse_addr(struct device *dev,
 116                                      const struct device_node *np)
 117 {
 118         return -ENOSYS;
 119 }
 120 static inline int of_phy_register_fixed_link(struct device_node *np)
 121 {
 122         return -ENOSYS;
 123 }
 124 static inline void of_phy_deregister_fixed_link(struct device_node *np)
 125 {
 126 }
 127 static inline bool of_phy_is_fixed_link(struct device_node *np)
 128 {
 129         return false;
 130 }
 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 }
 138 #endif
 139
 140
 141 #endif /* __LINUX_OF_MDIO_H */