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                           struct module *owner);
  19
  20 static inline int of_mdiobus_register(struct mii_bus *mdio,
  21                                       struct device_node *np)
  22 {
  23         return __of_mdiobus_register(mdio, np, THIS_MODULE);
  24 }
  25
  26 int __devm_of_mdiobus_register(struct device *dev, struct mii_bus *mdio,
  27                                struct device_node *np, struct module *owner);
  28
  29 static inline int devm_of_mdiobus_register(struct device *dev,
  30                                            struct mii_bus *mdio,
  31                                            struct device_node *np)
  32 {
  33         return __devm_of_mdiobus_register(dev, mdio, np, THIS_MODULE);
  34 }
  35
  36 struct mdio_device *of_mdio_find_device(struct device_node *np);
  37 struct phy_device *of_phy_find_device(struct device_node *phy_np);
  38 struct phy_device *
  39 of_phy_connect(struct net_device *dev, struct device_node *phy_np,
  40                void (*hndlr)(struct net_device *), u32 flags,
  41                phy_interface_t iface);
  42 struct phy_device *
  43 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
  44                        void (*hndlr)(struct net_device *));
  45
  46 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np);
  47 int of_phy_register_fixed_link(struct device_node *np);
  48 void of_phy_deregister_fixed_link(struct device_node *np);
  49 bool of_phy_is_fixed_link(struct device_node *np);
  50 int of_mdiobus_phy_device_register(struct mii_bus *mdio, struct phy_device *phy,
  51                                    struct device_node *child, u32 addr);
  52
  53 static inline int of_mdio_parse_addr(struct device *dev,
  54                                      const struct device_node *np)
  55 {
  56         u32 addr;
  57         int ret;
  58
  59         ret = of_property_read_u32(np, "reg", &addr);
  60         if (ret < 0) {
  61                 dev_err(dev, "%s has invalid PHY address\n", np->full_name);
  62                 return ret;
  63         }
  64
  65         /* A PHY must have a reg property in the range [0-31] */
  66         if (addr >= PHY_MAX_ADDR) {
  67                 dev_err(dev, "%s PHY address %i is too large\n",
  68                         np->full_name, addr);
  69                 return -EINVAL;
  70         }
  71
  72         return addr;
  73 }
  74
  75 #else /* CONFIG_OF_MDIO */
  76 static inline bool of_mdiobus_child_is_phy(struct device_node *child)
  77 {
  78         return false;
  79 }
  80
  81 static inline int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
  82 {
  83         /*
  84          * Fall back to the non-DT function to register a bus.
  85          * This way, we don't have to keep compat bits around in drivers.
  86          */
  87
  88         return mdiobus_register(mdio);
  89 }
  90
  91 static inline int devm_of_mdiobus_register(struct device *dev,
  92                                            struct mii_bus *mdio,
  93                                            struct device_node *np)
  94 {
  95         return devm_mdiobus_register(dev, mdio);
  96 }
  97
  98 static inline struct mdio_device *of_mdio_find_device(struct device_node *np)
  99 {
 100         return NULL;
 101 }
 102
 103 static inline struct phy_device *of_phy_find_device(struct device_node *phy_np)
 104 {
 105         return NULL;
 106 }
 107
 108 static inline struct phy_device *of_phy_connect(struct net_device *dev,
 109                                                 struct device_node *phy_np,
 110                                                 void (*hndlr)(struct net_device *),
 111                                                 u32 flags, phy_interface_t iface)
 112 {
 113         return NULL;
 114 }
 115
 116 static inline struct phy_device *
 117 of_phy_get_and_connect(struct net_device *dev, struct device_node *np,
 118                        void (*hndlr)(struct net_device *))
 119 {
 120         return NULL;
 121 }
 122
 123 static inline struct mii_bus *of_mdio_find_bus(struct device_node *mdio_np)
 124 {
 125         return NULL;
 126 }
 127
 128 static inline int of_mdio_parse_addr(struct device *dev,
 129                                      const struct device_node *np)
 130 {
 131         return -ENOSYS;
 132 }
 133 static inline int of_phy_register_fixed_link(struct device_node *np)
 134 {
 135         return -ENOSYS;
 136 }
 137 static inline void of_phy_deregister_fixed_link(struct device_node *np)
 138 {
 139 }
 140 static inline bool of_phy_is_fixed_link(struct device_node *np)
 141 {
 142         return false;
 143 }
 144
 145 static inline int of_mdiobus_phy_device_register(struct mii_bus *mdio,
 146                                             struct phy_device *phy,
 147                                             struct device_node *child, u32 addr)
 148 {
 149         return -ENOSYS;
 150 }
 151 #endif
 152
 153
 154 #endif /* __LINUX_OF_MDIO_H */