Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 1 | /* |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 2 | * Framework and drivers for configuring and reading different PHYs |
| 3 | * Based on code in sungem_phy.c and gianfar_phy.c |
| 4 | * |
| 5 | * Author: Andy Fleming |
| 6 | * |
| 7 | * Copyright (c) 2004 Freescale Semiconductor, Inc. |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify it |
| 10 | * under the terms of the GNU General Public License as published by the |
| 11 | * Free Software Foundation; either version 2 of the License, or (at your |
| 12 | * option) any later version. |
| 13 | * |
| 14 | */ |
| 15 | |
| 16 | #ifndef __PHY_H |
| 17 | #define __PHY_H |
| 18 | |
| 19 | #include <linux/spinlock.h> |
Maciej W. Rozycki | 13df29f | 2006-10-03 16:18:28 +0100 | [diff] [blame] | 20 | #include <linux/ethtool.h> |
| 21 | #include <linux/mii.h> |
Russell King | 3e3aaf6 | 2015-09-24 20:36:02 +0100 | [diff] [blame] | 22 | #include <linux/module.h> |
Maciej W. Rozycki | 13df29f | 2006-10-03 16:18:28 +0100 | [diff] [blame] | 23 | #include <linux/timer.h> |
| 24 | #include <linux/workqueue.h> |
David Woodhouse | 8626d3b | 2010-04-02 01:05:27 +0000 | [diff] [blame] | 25 | #include <linux/mod_devicetable.h> |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 26 | |
Arun Sharma | 60063497 | 2011-07-26 16:09:06 -0700 | [diff] [blame] | 27 | #include <linux/atomic.h> |
Maciej W. Rozycki | 0ac4952 | 2007-09-28 22:42:14 -0700 | [diff] [blame] | 28 | |
Florian Fainelli | e9fbdf1 | 2013-12-05 14:52:13 -0800 | [diff] [blame] | 29 | #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 30 | SUPPORTED_TP | \ |
| 31 | SUPPORTED_MII) |
| 32 | |
Florian Fainelli | e9fbdf1 | 2013-12-05 14:52:13 -0800 | [diff] [blame] | 33 | #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \ |
| 34 | SUPPORTED_10baseT_Full) |
| 35 | |
| 36 | #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \ |
| 37 | SUPPORTED_100baseT_Full) |
| 38 | |
| 39 | #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 40 | SUPPORTED_1000baseT_Full) |
| 41 | |
Florian Fainelli | e9fbdf1 | 2013-12-05 14:52:13 -0800 | [diff] [blame] | 42 | #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \ |
| 43 | PHY_100BT_FEATURES | \ |
| 44 | PHY_DEFAULT_FEATURES) |
| 45 | |
| 46 | #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \ |
| 47 | PHY_1000BT_FEATURES) |
| 48 | |
| 49 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 50 | /* |
| 51 | * Set phydev->irq to PHY_POLL if interrupts are not supported, |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 52 | * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if |
| 53 | * the attached driver handles the interrupt |
| 54 | */ |
| 55 | #define PHY_POLL -1 |
| 56 | #define PHY_IGNORE_INTERRUPT -2 |
| 57 | |
| 58 | #define PHY_HAS_INTERRUPT 0x00000001 |
| 59 | #define PHY_HAS_MAGICANEG 0x00000002 |
Florian Fainelli | 4284b6a | 2013-05-23 01:11:12 +0000 | [diff] [blame] | 60 | #define PHY_IS_INTERNAL 0x00000004 |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 61 | |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 62 | /* Interface Mode definitions */ |
| 63 | typedef enum { |
Shawn Guo | 4157ef1 | 2011-07-05 16:42:09 +0800 | [diff] [blame] | 64 | PHY_INTERFACE_MODE_NA, |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 65 | PHY_INTERFACE_MODE_MII, |
| 66 | PHY_INTERFACE_MODE_GMII, |
| 67 | PHY_INTERFACE_MODE_SGMII, |
| 68 | PHY_INTERFACE_MODE_TBI, |
Florian Fainelli | 2cc70ba | 2013-05-28 04:07:21 +0000 | [diff] [blame] | 69 | PHY_INTERFACE_MODE_REVMII, |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 70 | PHY_INTERFACE_MODE_RMII, |
| 71 | PHY_INTERFACE_MODE_RGMII, |
Kim Phillips | a999589 | 2007-04-13 01:25:57 -0500 | [diff] [blame] | 72 | PHY_INTERFACE_MODE_RGMII_ID, |
Kim Phillips | 7d400a4 | 2007-11-26 16:17:48 -0600 | [diff] [blame] | 73 | PHY_INTERFACE_MODE_RGMII_RXID, |
| 74 | PHY_INTERFACE_MODE_RGMII_TXID, |
Shawn Guo | 4157ef1 | 2011-07-05 16:42:09 +0800 | [diff] [blame] | 75 | PHY_INTERFACE_MODE_RTBI, |
| 76 | PHY_INTERFACE_MODE_SMII, |
Andy Fleming | 898dd0b | 2014-01-10 14:26:46 +0800 | [diff] [blame] | 77 | PHY_INTERFACE_MODE_XGMII, |
Florian Fainelli | fd70f72 | 2014-02-13 16:08:42 -0800 | [diff] [blame] | 78 | PHY_INTERFACE_MODE_MOCA, |
Thomas Petazzoni | b9d1208 | 2014-04-15 15:50:19 +0200 | [diff] [blame] | 79 | PHY_INTERFACE_MODE_QSGMII, |
Florian Fainelli | 8a2fe56 | 2014-02-11 17:27:39 -0800 | [diff] [blame] | 80 | PHY_INTERFACE_MODE_MAX, |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 81 | } phy_interface_t; |
| 82 | |
Florian Fainelli | 8a2fe56 | 2014-02-11 17:27:39 -0800 | [diff] [blame] | 83 | /** |
| 84 | * It maps 'enum phy_interface_t' found in include/linux/phy.h |
| 85 | * into the device tree binding of 'phy-mode', so that Ethernet |
| 86 | * device driver can get phy interface from device tree. |
| 87 | */ |
| 88 | static inline const char *phy_modes(phy_interface_t interface) |
| 89 | { |
| 90 | switch (interface) { |
| 91 | case PHY_INTERFACE_MODE_NA: |
| 92 | return ""; |
| 93 | case PHY_INTERFACE_MODE_MII: |
| 94 | return "mii"; |
| 95 | case PHY_INTERFACE_MODE_GMII: |
| 96 | return "gmii"; |
| 97 | case PHY_INTERFACE_MODE_SGMII: |
| 98 | return "sgmii"; |
| 99 | case PHY_INTERFACE_MODE_TBI: |
| 100 | return "tbi"; |
| 101 | case PHY_INTERFACE_MODE_REVMII: |
| 102 | return "rev-mii"; |
| 103 | case PHY_INTERFACE_MODE_RMII: |
| 104 | return "rmii"; |
| 105 | case PHY_INTERFACE_MODE_RGMII: |
| 106 | return "rgmii"; |
| 107 | case PHY_INTERFACE_MODE_RGMII_ID: |
| 108 | return "rgmii-id"; |
| 109 | case PHY_INTERFACE_MODE_RGMII_RXID: |
| 110 | return "rgmii-rxid"; |
| 111 | case PHY_INTERFACE_MODE_RGMII_TXID: |
| 112 | return "rgmii-txid"; |
| 113 | case PHY_INTERFACE_MODE_RTBI: |
| 114 | return "rtbi"; |
| 115 | case PHY_INTERFACE_MODE_SMII: |
| 116 | return "smii"; |
| 117 | case PHY_INTERFACE_MODE_XGMII: |
| 118 | return "xgmii"; |
Florian Fainelli | fd70f72 | 2014-02-13 16:08:42 -0800 | [diff] [blame] | 119 | case PHY_INTERFACE_MODE_MOCA: |
| 120 | return "moca"; |
Thomas Petazzoni | b9d1208 | 2014-04-15 15:50:19 +0200 | [diff] [blame] | 121 | case PHY_INTERFACE_MODE_QSGMII: |
| 122 | return "qsgmii"; |
Florian Fainelli | 8a2fe56 | 2014-02-11 17:27:39 -0800 | [diff] [blame] | 123 | default: |
| 124 | return "unknown"; |
| 125 | } |
| 126 | } |
| 127 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 128 | |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 129 | #define PHY_INIT_TIMEOUT 100000 |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 130 | #define PHY_STATE_TIME 1 |
| 131 | #define PHY_FORCE_TIMEOUT 10 |
| 132 | #define PHY_AN_TIMEOUT 10 |
| 133 | |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 134 | #define PHY_MAX_ADDR 32 |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 135 | |
Kumar Gala | a4d00f1 | 2006-01-11 11:27:33 -0800 | [diff] [blame] | 136 | /* Used when trying to connect to a specific phy (mii bus id:phy device id) */ |
Andy Fleming | 9d9326d | 2008-04-09 19:38:13 -0500 | [diff] [blame] | 137 | #define PHY_ID_FMT "%s:%02x" |
| 138 | |
| 139 | /* |
| 140 | * Need to be a little smaller than phydev->dev.bus_id to leave room |
| 141 | * for the ":%02x" |
| 142 | */ |
David S. Miller | 8e401ec | 2009-05-26 21:16:25 -0700 | [diff] [blame] | 143 | #define MII_BUS_ID_SIZE (20 - 3) |
Kumar Gala | a4d00f1 | 2006-01-11 11:27:33 -0800 | [diff] [blame] | 144 | |
Jason Gunthorpe | abf35df | 2010-03-09 09:17:42 +0000 | [diff] [blame] | 145 | /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit |
| 146 | IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */ |
| 147 | #define MII_ADDR_C45 (1<<30) |
| 148 | |
Paul Gortmaker | 313162d | 2012-01-30 11:46:54 -0500 | [diff] [blame] | 149 | struct device; |
| 150 | struct sk_buff; |
| 151 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 152 | /* |
| 153 | * The Bus class for PHYs. Devices which provide access to |
| 154 | * PHYs should register using this structure |
| 155 | */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 156 | struct mii_bus { |
Russell King | 3e3aaf6 | 2015-09-24 20:36:02 +0100 | [diff] [blame] | 157 | struct module *owner; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 158 | const char *name; |
Andy Fleming | 9d9326d | 2008-04-09 19:38:13 -0500 | [diff] [blame] | 159 | char id[MII_BUS_ID_SIZE]; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 160 | void *priv; |
| 161 | int (*read)(struct mii_bus *bus, int phy_id, int regnum); |
| 162 | int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val); |
| 163 | int (*reset)(struct mii_bus *bus); |
| 164 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 165 | /* |
| 166 | * A lock to ensure that only one thing can read/write |
| 167 | * the MDIO bus at a time |
| 168 | */ |
Nate Case | 35b5f6b | 2008-01-29 10:05:09 -0600 | [diff] [blame] | 169 | struct mutex mdio_lock; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 170 | |
Lennert Buytenhek | 18ee49d | 2008-10-01 15:41:33 +0000 | [diff] [blame] | 171 | struct device *parent; |
Lennert Buytenhek | 46abc02 | 2008-10-08 16:33:40 -0700 | [diff] [blame] | 172 | enum { |
| 173 | MDIOBUS_ALLOCATED = 1, |
| 174 | MDIOBUS_REGISTERED, |
| 175 | MDIOBUS_UNREGISTERED, |
| 176 | MDIOBUS_RELEASED, |
| 177 | } state; |
| 178 | struct device dev; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 179 | |
| 180 | /* list of all PHYs on bus */ |
| 181 | struct phy_device *phy_map[PHY_MAX_ADDR]; |
| 182 | |
Peter Meerwald | c688399 | 2010-09-02 04:06:24 +0000 | [diff] [blame] | 183 | /* PHY addresses to be ignored when probing */ |
Matt Porter | f896424 | 2005-11-02 16:13:06 -0700 | [diff] [blame] | 184 | u32 phy_mask; |
| 185 | |
Florian Fainelli | 922f2dd | 2015-05-12 10:33:24 -0700 | [diff] [blame] | 186 | /* PHY addresses to ignore the TA/read failure */ |
| 187 | u32 phy_ignore_ta_mask; |
| 188 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 189 | /* |
| 190 | * Pointer to an array of interrupts, each PHY's |
| 191 | * interrupt at the index matching its address |
| 192 | */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 193 | int *irq; |
| 194 | }; |
Lennert Buytenhek | 46abc02 | 2008-10-08 16:33:40 -0700 | [diff] [blame] | 195 | #define to_mii_bus(d) container_of(d, struct mii_bus, dev) |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 196 | |
Timur Tabi | eb8a54a7 | 2012-01-12 15:23:04 -0800 | [diff] [blame] | 197 | struct mii_bus *mdiobus_alloc_size(size_t); |
| 198 | static inline struct mii_bus *mdiobus_alloc(void) |
| 199 | { |
| 200 | return mdiobus_alloc_size(0); |
| 201 | } |
| 202 | |
Russell King | 3e3aaf6 | 2015-09-24 20:36:02 +0100 | [diff] [blame] | 203 | int __mdiobus_register(struct mii_bus *bus, struct module *owner); |
| 204 | #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE) |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 205 | void mdiobus_unregister(struct mii_bus *bus); |
| 206 | void mdiobus_free(struct mii_bus *bus); |
Grygorii Strashko | 6d48f44 | 2014-04-30 15:23:33 +0300 | [diff] [blame] | 207 | struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv); |
| 208 | static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev) |
| 209 | { |
| 210 | return devm_mdiobus_alloc_size(dev, 0); |
| 211 | } |
| 212 | |
| 213 | void devm_mdiobus_free(struct device *dev, struct mii_bus *bus); |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 214 | struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr); |
Jason Gunthorpe | abf35df | 2010-03-09 09:17:42 +0000 | [diff] [blame] | 215 | int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum); |
| 216 | int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val); |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 217 | |
| 218 | |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 219 | #define PHY_INTERRUPT_DISABLED 0x0 |
| 220 | #define PHY_INTERRUPT_ENABLED 0x80000000 |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 221 | |
| 222 | /* PHY state machine states: |
| 223 | * |
| 224 | * DOWN: PHY device and driver are not ready for anything. probe |
| 225 | * should be called if and only if the PHY is in this state, |
| 226 | * given that the PHY device exists. |
| 227 | * - PHY driver probe function will, depending on the PHY, set |
| 228 | * the state to STARTING or READY |
| 229 | * |
| 230 | * STARTING: PHY device is coming up, and the ethernet driver is |
| 231 | * not ready. PHY drivers may set this in the probe function. |
| 232 | * If they do, they are responsible for making sure the state is |
| 233 | * eventually set to indicate whether the PHY is UP or READY, |
| 234 | * depending on the state when the PHY is done starting up. |
| 235 | * - PHY driver will set the state to READY |
| 236 | * - start will set the state to PENDING |
| 237 | * |
| 238 | * READY: PHY is ready to send and receive packets, but the |
| 239 | * controller is not. By default, PHYs which do not implement |
| 240 | * probe will be set to this state by phy_probe(). If the PHY |
| 241 | * driver knows the PHY is ready, and the PHY state is STARTING, |
| 242 | * then it sets this STATE. |
| 243 | * - start will set the state to UP |
| 244 | * |
| 245 | * PENDING: PHY device is coming up, but the ethernet driver is |
| 246 | * ready. phy_start will set this state if the PHY state is |
| 247 | * STARTING. |
| 248 | * - PHY driver will set the state to UP when the PHY is ready |
| 249 | * |
| 250 | * UP: The PHY and attached device are ready to do work. |
| 251 | * Interrupts should be started here. |
| 252 | * - timer moves to AN |
| 253 | * |
| 254 | * AN: The PHY is currently negotiating the link state. Link is |
| 255 | * therefore down for now. phy_timer will set this state when it |
| 256 | * detects the state is UP. config_aneg will set this state |
| 257 | * whenever called with phydev->autoneg set to AUTONEG_ENABLE. |
| 258 | * - If autonegotiation finishes, but there's no link, it sets |
| 259 | * the state to NOLINK. |
| 260 | * - If aneg finishes with link, it sets the state to RUNNING, |
| 261 | * and calls adjust_link |
| 262 | * - If autonegotiation did not finish after an arbitrary amount |
| 263 | * of time, autonegotiation should be tried again if the PHY |
| 264 | * supports "magic" autonegotiation (back to AN) |
| 265 | * - If it didn't finish, and no magic_aneg, move to FORCING. |
| 266 | * |
| 267 | * NOLINK: PHY is up, but not currently plugged in. |
| 268 | * - If the timer notes that the link comes back, we move to RUNNING |
| 269 | * - config_aneg moves to AN |
| 270 | * - phy_stop moves to HALTED |
| 271 | * |
| 272 | * FORCING: PHY is being configured with forced settings |
| 273 | * - if link is up, move to RUNNING |
| 274 | * - If link is down, we drop to the next highest setting, and |
| 275 | * retry (FORCING) after a timeout |
| 276 | * - phy_stop moves to HALTED |
| 277 | * |
| 278 | * RUNNING: PHY is currently up, running, and possibly sending |
| 279 | * and/or receiving packets |
| 280 | * - timer will set CHANGELINK if we're polling (this ensures the |
| 281 | * link state is polled every other cycle of this state machine, |
| 282 | * which makes it every other second) |
| 283 | * - irq will set CHANGELINK |
| 284 | * - config_aneg will set AN |
| 285 | * - phy_stop moves to HALTED |
| 286 | * |
| 287 | * CHANGELINK: PHY experienced a change in link state |
| 288 | * - timer moves to RUNNING if link |
| 289 | * - timer moves to NOLINK if the link is down |
| 290 | * - phy_stop moves to HALTED |
| 291 | * |
| 292 | * HALTED: PHY is up, but no polling or interrupts are done. Or |
| 293 | * PHY is in an error state. |
| 294 | * |
| 295 | * - phy_start moves to RESUMING |
| 296 | * |
| 297 | * RESUMING: PHY was halted, but now wants to run again. |
| 298 | * - If we are forcing, or aneg is done, timer moves to RUNNING |
| 299 | * - If aneg is not done, timer moves to AN |
| 300 | * - phy_stop moves to HALTED |
| 301 | */ |
| 302 | enum phy_state { |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 303 | PHY_DOWN = 0, |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 304 | PHY_STARTING, |
| 305 | PHY_READY, |
| 306 | PHY_PENDING, |
| 307 | PHY_UP, |
| 308 | PHY_AN, |
| 309 | PHY_RUNNING, |
| 310 | PHY_NOLINK, |
| 311 | PHY_FORCING, |
| 312 | PHY_CHANGELINK, |
| 313 | PHY_HALTED, |
| 314 | PHY_RESUMING |
| 315 | }; |
| 316 | |
David Daney | ac28b9f | 2012-06-27 07:33:35 +0000 | [diff] [blame] | 317 | /** |
| 318 | * struct phy_c45_device_ids - 802.3-c45 Device Identifiers |
| 319 | * @devices_in_package: Bit vector of devices present. |
| 320 | * @device_ids: The device identifer for each present device. |
| 321 | */ |
| 322 | struct phy_c45_device_ids { |
| 323 | u32 devices_in_package; |
| 324 | u32 device_ids[8]; |
| 325 | }; |
Richard Cochran | c1f19b5 | 2010-07-17 08:49:36 +0000 | [diff] [blame] | 326 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 327 | /* phy_device: An instance of a PHY |
| 328 | * |
| 329 | * drv: Pointer to the driver for this PHY instance |
| 330 | * bus: Pointer to the bus this PHY is on |
| 331 | * dev: driver model device structure for this PHY |
| 332 | * phy_id: UID for this device found during discovery |
David Daney | ac28b9f | 2012-06-27 07:33:35 +0000 | [diff] [blame] | 333 | * c45_ids: 802.3-c45 Device Identifers if is_c45. |
| 334 | * is_c45: Set to true if this phy uses clause 45 addressing. |
Florian Fainelli | 4284b6a | 2013-05-23 01:11:12 +0000 | [diff] [blame] | 335 | * is_internal: Set to true if this phy is internal to a MAC. |
Florian Fainelli | 5a11dd7 | 2015-08-31 15:56:46 +0200 | [diff] [blame] | 336 | * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc. |
Florian Fainelli | aae8826 | 2015-01-26 22:05:38 -0800 | [diff] [blame] | 337 | * has_fixups: Set to true if this phy has fixups/quirks. |
Florian Fainelli | 8a477a6 | 2015-01-26 22:05:39 -0800 | [diff] [blame] | 338 | * suspended: Set to true if this phy has been suspended successfully. |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 339 | * state: state of the PHY for management purposes |
| 340 | * dev_flags: Device-specific flags used by the PHY driver. |
| 341 | * addr: Bus address of PHY |
| 342 | * link_timeout: The number of timer firings to wait before the |
| 343 | * giving up on the current attempt at acquiring a link |
| 344 | * irq: IRQ number of the PHY's interrupt (-1 if none) |
| 345 | * phy_timer: The timer for handling the state machine |
| 346 | * phy_queue: A work_queue for the interrupt |
| 347 | * attached_dev: The attached enet driver's device instance ptr |
| 348 | * adjust_link: Callback for the enet controller to respond to |
| 349 | * changes in the link state. |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 350 | * |
Florian Fainelli | 114002b | 2013-12-06 13:01:30 -0800 | [diff] [blame] | 351 | * speed, duplex, pause, supported, advertising, lp_advertising, |
| 352 | * and autoneg are used like in mii_if_info |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 353 | * |
| 354 | * interrupts currently only supports enabled or disabled, |
| 355 | * but could be changed in the future to support enabling |
| 356 | * and disabling specific interrupts |
| 357 | * |
| 358 | * Contains some infrastructure for polling and interrupt |
| 359 | * handling, as well as handling shifts in PHY hardware state |
| 360 | */ |
| 361 | struct phy_device { |
| 362 | /* Information about the PHY type */ |
| 363 | /* And management functions */ |
| 364 | struct phy_driver *drv; |
| 365 | |
| 366 | struct mii_bus *bus; |
| 367 | |
| 368 | struct device dev; |
| 369 | |
| 370 | u32 phy_id; |
| 371 | |
David Daney | ac28b9f | 2012-06-27 07:33:35 +0000 | [diff] [blame] | 372 | struct phy_c45_device_ids c45_ids; |
| 373 | bool is_c45; |
Florian Fainelli | 4284b6a | 2013-05-23 01:11:12 +0000 | [diff] [blame] | 374 | bool is_internal; |
Florian Fainelli | 5a11dd7 | 2015-08-31 15:56:46 +0200 | [diff] [blame] | 375 | bool is_pseudo_fixed_link; |
Florian Fainelli | b0ae009 | 2014-02-11 17:27:41 -0800 | [diff] [blame] | 376 | bool has_fixups; |
Florian Fainelli | 8a477a6 | 2015-01-26 22:05:39 -0800 | [diff] [blame] | 377 | bool suspended; |
David Daney | ac28b9f | 2012-06-27 07:33:35 +0000 | [diff] [blame] | 378 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 379 | enum phy_state state; |
| 380 | |
| 381 | u32 dev_flags; |
| 382 | |
Andy Fleming | e8a2b6a | 2006-12-01 12:01:06 -0600 | [diff] [blame] | 383 | phy_interface_t interface; |
| 384 | |
Peter Meerwald | c688399 | 2010-09-02 04:06:24 +0000 | [diff] [blame] | 385 | /* Bus address of the PHY (0-31) */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 386 | int addr; |
| 387 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 388 | /* |
| 389 | * forced speed & duplex (no autoneg) |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 390 | * partner speed & duplex & pause (autoneg) |
| 391 | */ |
| 392 | int speed; |
| 393 | int duplex; |
| 394 | int pause; |
| 395 | int asym_pause; |
| 396 | |
| 397 | /* The most recently read link state */ |
| 398 | int link; |
| 399 | |
| 400 | /* Enabled Interrupts */ |
| 401 | u32 interrupts; |
| 402 | |
| 403 | /* Union of PHY and Attached devices' supported modes */ |
| 404 | /* See mii.h for more info */ |
| 405 | u32 supported; |
| 406 | u32 advertising; |
Florian Fainelli | 114002b | 2013-12-06 13:01:30 -0800 | [diff] [blame] | 407 | u32 lp_advertising; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 408 | |
| 409 | int autoneg; |
| 410 | |
| 411 | int link_timeout; |
| 412 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 413 | /* |
| 414 | * Interrupt number for this PHY |
| 415 | * -1 means no interrupt |
| 416 | */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 417 | int irq; |
| 418 | |
| 419 | /* private data pointer */ |
| 420 | /* For use by PHYs to maintain extra state */ |
| 421 | void *priv; |
| 422 | |
| 423 | /* Interrupt and Polling infrastructure */ |
| 424 | struct work_struct phy_queue; |
Marcin Slusarz | a390d1f | 2009-03-13 15:41:19 -0700 | [diff] [blame] | 425 | struct delayed_work state_queue; |
Maciej W. Rozycki | 0ac4952 | 2007-09-28 22:42:14 -0700 | [diff] [blame] | 426 | atomic_t irq_disable; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 427 | |
Nate Case | 35b5f6b | 2008-01-29 10:05:09 -0600 | [diff] [blame] | 428 | struct mutex lock; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 429 | |
| 430 | struct net_device *attached_dev; |
| 431 | |
David Thomson | 634ec36 | 2015-07-10 13:56:54 +1200 | [diff] [blame] | 432 | u8 mdix; |
| 433 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 434 | void (*adjust_link)(struct net_device *dev); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 435 | }; |
| 436 | #define to_phy_device(d) container_of(d, struct phy_device, dev) |
| 437 | |
| 438 | /* struct phy_driver: Driver structure for a particular PHY type |
| 439 | * |
| 440 | * phy_id: The result of reading the UID registers of this PHY |
| 441 | * type, and ANDing them with the phy_id_mask. This driver |
| 442 | * only works for PHYs with IDs which match this field |
| 443 | * name: The friendly name of this PHY type |
| 444 | * phy_id_mask: Defines the important bits of the phy_id |
| 445 | * features: A list of features (speed, duplex, etc) supported |
| 446 | * by this PHY |
| 447 | * flags: A bitfield defining certain other features this PHY |
| 448 | * supports (like interrupts) |
Johan Hovold | 860f6e9 | 2014-11-19 12:59:14 +0100 | [diff] [blame] | 449 | * driver_data: static driver data |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 450 | * |
| 451 | * The drivers must implement config_aneg and read_status. All |
| 452 | * other functions are optional. Note that none of these |
| 453 | * functions should be called from interrupt time. The goal is |
| 454 | * for the bus read/write functions to be able to block when the |
| 455 | * bus transaction is happening, and be freed up by an interrupt |
| 456 | * (The MPC85xx has this ability, though it is not currently |
| 457 | * supported in the driver). |
| 458 | */ |
| 459 | struct phy_driver { |
| 460 | u32 phy_id; |
| 461 | char *name; |
| 462 | unsigned int phy_id_mask; |
| 463 | u32 features; |
| 464 | u32 flags; |
Johan Hovold | 860f6e9 | 2014-11-19 12:59:14 +0100 | [diff] [blame] | 465 | const void *driver_data; |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 466 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 467 | /* |
Florian Fainelli | 9df81dd | 2014-02-17 13:34:03 -0800 | [diff] [blame] | 468 | * Called to issue a PHY software reset |
| 469 | */ |
| 470 | int (*soft_reset)(struct phy_device *phydev); |
| 471 | |
| 472 | /* |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 473 | * Called to initialize the PHY, |
| 474 | * including after a reset |
| 475 | */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 476 | int (*config_init)(struct phy_device *phydev); |
| 477 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 478 | /* |
| 479 | * Called during discovery. Used to set |
| 480 | * up device-specific structures, if any |
| 481 | */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 482 | int (*probe)(struct phy_device *phydev); |
| 483 | |
| 484 | /* PHY Power Management */ |
| 485 | int (*suspend)(struct phy_device *phydev); |
| 486 | int (*resume)(struct phy_device *phydev); |
| 487 | |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 488 | /* |
| 489 | * Configures the advertisement and resets |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 490 | * autonegotiation if phydev->autoneg is on, |
| 491 | * forces the speed to the current settings in phydev |
Andy Fleming | c5e38a9 | 2008-04-09 19:38:27 -0500 | [diff] [blame] | 492 | * if phydev->autoneg is off |
| 493 | */ |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 494 | int (*config_aneg)(struct phy_device *phydev); |
| 495 | |
Florian Fainelli | 76a423a | 2014-02-11 17:27:37 -0800 | [diff] [blame] | 496 | /* Determines the auto negotiation result */ |
| 497 | int (*aneg_done)(struct phy_device *phydev); |
| 498 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 499 | /* Determines the negotiated speed and duplex */ |
| 500 | int (*read_status)(struct phy_device *phydev); |
| 501 | |
| 502 | /* Clears any pending interrupts */ |
| 503 | int (*ack_interrupt)(struct phy_device *phydev); |
| 504 | |
| 505 | /* Enables or disables interrupts */ |
| 506 | int (*config_intr)(struct phy_device *phydev); |
| 507 | |
Anatolij Gustschin | a8729eb | 2009-04-07 02:01:42 +0000 | [diff] [blame] | 508 | /* |
| 509 | * Checks if the PHY generated an interrupt. |
| 510 | * For multi-PHY devices with shared PHY interrupt pin |
| 511 | */ |
| 512 | int (*did_interrupt)(struct phy_device *phydev); |
| 513 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 514 | /* Clears up any memory if needed */ |
| 515 | void (*remove)(struct phy_device *phydev); |
| 516 | |
David Daney | a30e2c1 | 2012-06-27 07:33:37 +0000 | [diff] [blame] | 517 | /* Returns true if this is a suitable driver for the given |
| 518 | * phydev. If NULL, matching is based on phy_id and |
| 519 | * phy_id_mask. |
| 520 | */ |
| 521 | int (*match_phy_device)(struct phy_device *phydev); |
| 522 | |
Richard Cochran | c8f3a8c | 2012-04-03 22:59:17 +0000 | [diff] [blame] | 523 | /* Handles ethtool queries for hardware time stamping. */ |
| 524 | int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti); |
| 525 | |
Richard Cochran | c1f19b5 | 2010-07-17 08:49:36 +0000 | [diff] [blame] | 526 | /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */ |
| 527 | int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr); |
| 528 | |
| 529 | /* |
| 530 | * Requests a Rx timestamp for 'skb'. If the skb is accepted, |
| 531 | * the phy driver promises to deliver it using netif_rx() as |
| 532 | * soon as a timestamp becomes available. One of the |
| 533 | * PTP_CLASS_ values is passed in 'type'. The function must |
| 534 | * return true if the skb is accepted for delivery. |
| 535 | */ |
| 536 | bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); |
| 537 | |
| 538 | /* |
| 539 | * Requests a Tx timestamp for 'skb'. The phy driver promises |
Richard Cochran | da92b19 | 2011-10-21 00:49:15 +0000 | [diff] [blame] | 540 | * to deliver it using skb_complete_tx_timestamp() as soon as a |
Richard Cochran | c1f19b5 | 2010-07-17 08:49:36 +0000 | [diff] [blame] | 541 | * timestamp becomes available. One of the PTP_CLASS_ values |
| 542 | * is passed in 'type'. |
| 543 | */ |
| 544 | void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type); |
| 545 | |
Michael Stapelberg | 42e836e | 2013-03-11 13:56:44 +0000 | [diff] [blame] | 546 | /* Some devices (e.g. qnap TS-119P II) require PHY register changes to |
| 547 | * enable Wake on LAN, so set_wol is provided to be called in the |
| 548 | * ethernet driver's set_wol function. */ |
| 549 | int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); |
| 550 | |
| 551 | /* See set_wol, but for checking whether Wake on LAN is enabled. */ |
| 552 | void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol); |
| 553 | |
Daniel Mack | 2b8f2a2 | 2014-06-18 11:01:41 +0200 | [diff] [blame] | 554 | /* |
| 555 | * Called to inform a PHY device driver when the core is about to |
| 556 | * change the link state. This callback is supposed to be used as |
| 557 | * fixup hook for drivers that need to take action when the link |
| 558 | * state changes. Drivers are by no means allowed to mess with the |
| 559 | * PHY device structure in their implementations. |
| 560 | */ |
| 561 | void (*link_change_notify)(struct phy_device *dev); |
| 562 | |
Vince Bridgers | 0c1d77d | 2014-07-29 15:19:57 -0500 | [diff] [blame] | 563 | /* A function provided by a phy specific driver to override the |
| 564 | * the PHY driver framework support for reading a MMD register |
| 565 | * from the PHY. If not supported, return -1. This function is |
| 566 | * optional for PHY specific drivers, if not provided then the |
| 567 | * default MMD read function is used by the PHY framework. |
| 568 | */ |
| 569 | int (*read_mmd_indirect)(struct phy_device *dev, int ptrad, |
| 570 | int devnum, int regnum); |
| 571 | |
| 572 | /* A function provided by a phy specific driver to override the |
| 573 | * the PHY driver framework support for writing a MMD register |
| 574 | * from the PHY. This function is optional for PHY specific drivers, |
| 575 | * if not provided then the default MMD read function is used by |
| 576 | * the PHY framework. |
| 577 | */ |
| 578 | void (*write_mmd_indirect)(struct phy_device *dev, int ptrad, |
| 579 | int devnum, int regnum, u32 val); |
| 580 | |
Ed Swierk | 2f43836 | 2015-01-02 17:27:56 -0800 | [diff] [blame] | 581 | /* Get the size and type of the eeprom contained within a plug-in |
| 582 | * module */ |
| 583 | int (*module_info)(struct phy_device *dev, |
| 584 | struct ethtool_modinfo *modinfo); |
| 585 | |
| 586 | /* Get the eeprom information from the plug-in module */ |
| 587 | int (*module_eeprom)(struct phy_device *dev, |
| 588 | struct ethtool_eeprom *ee, u8 *data); |
| 589 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 590 | struct device_driver driver; |
| 591 | }; |
| 592 | #define to_phy_driver(d) container_of(d, struct phy_driver, driver) |
| 593 | |
Andy Fleming | f62220d | 2008-04-18 17:29:54 -0500 | [diff] [blame] | 594 | #define PHY_ANY_ID "MATCH ANY PHY" |
| 595 | #define PHY_ANY_UID 0xffffffff |
| 596 | |
| 597 | /* A Structure for boards to register fixups with the PHY Lib */ |
| 598 | struct phy_fixup { |
| 599 | struct list_head list; |
David S. Miller | 8e401ec | 2009-05-26 21:16:25 -0700 | [diff] [blame] | 600 | char bus_id[20]; |
Andy Fleming | f62220d | 2008-04-18 17:29:54 -0500 | [diff] [blame] | 601 | u32 phy_uid; |
| 602 | u32 phy_uid_mask; |
| 603 | int (*run)(struct phy_device *phydev); |
| 604 | }; |
| 605 | |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 606 | /** |
Andy Fleming | efabdfb | 2014-01-10 14:25:09 +0800 | [diff] [blame] | 607 | * phy_read_mmd - Convenience function for reading a register |
| 608 | * from an MMD on a given PHY. |
| 609 | * @phydev: The phy_device struct |
| 610 | * @devad: The MMD to read from |
| 611 | * @regnum: The register on the MMD to read |
| 612 | * |
| 613 | * Same rules as for phy_read(); |
| 614 | */ |
| 615 | static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) |
| 616 | { |
| 617 | if (!phydev->is_c45) |
| 618 | return -EOPNOTSUPP; |
| 619 | |
| 620 | return mdiobus_read(phydev->bus, phydev->addr, |
| 621 | MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff)); |
| 622 | } |
| 623 | |
| 624 | /** |
Florian Fainelli | 66ce7fb | 2014-08-22 18:55:43 -0700 | [diff] [blame] | 625 | * phy_read_mmd_indirect - reads data from the MMD registers |
| 626 | * @phydev: The PHY device bus |
| 627 | * @prtad: MMD Address |
| 628 | * @devad: MMD DEVAD |
| 629 | * @addr: PHY address on the MII bus |
| 630 | * |
| 631 | * Description: it reads data from the MMD registers (clause 22 to access to |
| 632 | * clause 45) of the specified phy address. |
| 633 | */ |
| 634 | int phy_read_mmd_indirect(struct phy_device *phydev, int prtad, |
| 635 | int devad, int addr); |
| 636 | |
| 637 | /** |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 638 | * phy_read - Convenience function for reading a given PHY register |
| 639 | * @phydev: the phy_device struct |
| 640 | * @regnum: register number to read |
| 641 | * |
| 642 | * NOTE: MUST NOT be called from interrupt context, |
| 643 | * because the bus read/write functions may wait for an interrupt |
| 644 | * to conclude the operation. |
| 645 | */ |
Jason Gunthorpe | abf35df | 2010-03-09 09:17:42 +0000 | [diff] [blame] | 646 | static inline int phy_read(struct phy_device *phydev, u32 regnum) |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 647 | { |
| 648 | return mdiobus_read(phydev->bus, phydev->addr, regnum); |
| 649 | } |
| 650 | |
| 651 | /** |
| 652 | * phy_write - Convenience function for writing a given PHY register |
| 653 | * @phydev: the phy_device struct |
| 654 | * @regnum: register number to write |
| 655 | * @val: value to write to @regnum |
| 656 | * |
| 657 | * NOTE: MUST NOT be called from interrupt context, |
| 658 | * because the bus read/write functions may wait for an interrupt |
| 659 | * to conclude the operation. |
| 660 | */ |
Jason Gunthorpe | abf35df | 2010-03-09 09:17:42 +0000 | [diff] [blame] | 661 | static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val) |
Lennert Buytenhek | 2e88810 | 2008-09-29 17:12:35 +0000 | [diff] [blame] | 662 | { |
| 663 | return mdiobus_write(phydev->bus, phydev->addr, regnum, val); |
| 664 | } |
| 665 | |
Florian Fainelli | 2c7b492 | 2013-05-19 22:53:42 +0000 | [diff] [blame] | 666 | /** |
| 667 | * phy_interrupt_is_valid - Convenience function for testing a given PHY irq |
| 668 | * @phydev: the phy_device struct |
| 669 | * |
| 670 | * NOTE: must be kept in sync with addition/removal of PHY_POLL and |
| 671 | * PHY_IGNORE_INTERRUPT |
| 672 | */ |
| 673 | static inline bool phy_interrupt_is_valid(struct phy_device *phydev) |
| 674 | { |
| 675 | return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT; |
| 676 | } |
| 677 | |
Florian Fainelli | 4284b6a | 2013-05-23 01:11:12 +0000 | [diff] [blame] | 678 | /** |
| 679 | * phy_is_internal - Convenience function for testing if a PHY is internal |
| 680 | * @phydev: the phy_device struct |
| 681 | */ |
| 682 | static inline bool phy_is_internal(struct phy_device *phydev) |
| 683 | { |
| 684 | return phydev->is_internal; |
| 685 | } |
| 686 | |
Andy Fleming | efabdfb | 2014-01-10 14:25:09 +0800 | [diff] [blame] | 687 | /** |
Florian Fainelli | e463d88 | 2015-05-26 12:19:58 -0700 | [diff] [blame] | 688 | * phy_interface_is_rgmii - Convenience function for testing if a PHY interface |
| 689 | * is RGMII (all variants) |
| 690 | * @phydev: the phy_device struct |
| 691 | */ |
| 692 | static inline bool phy_interface_is_rgmii(struct phy_device *phydev) |
| 693 | { |
| 694 | return phydev->interface >= PHY_INTERFACE_MODE_RGMII && |
| 695 | phydev->interface <= PHY_INTERFACE_MODE_RGMII_TXID; |
Florian Fainelli | 5a11dd7 | 2015-08-31 15:56:46 +0200 | [diff] [blame] | 696 | }; |
| 697 | |
| 698 | /* |
| 699 | * phy_is_pseudo_fixed_link - Convenience function for testing if this |
| 700 | * PHY is the CPU port facing side of an Ethernet switch, or similar. |
| 701 | * @phydev: the phy_device struct |
| 702 | */ |
| 703 | static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev) |
| 704 | { |
| 705 | return phydev->is_pseudo_fixed_link; |
Florian Fainelli | e463d88 | 2015-05-26 12:19:58 -0700 | [diff] [blame] | 706 | } |
| 707 | |
| 708 | /** |
Andy Fleming | efabdfb | 2014-01-10 14:25:09 +0800 | [diff] [blame] | 709 | * phy_write_mmd - Convenience function for writing a register |
| 710 | * on an MMD on a given PHY. |
| 711 | * @phydev: The phy_device struct |
| 712 | * @devad: The MMD to read from |
| 713 | * @regnum: The register on the MMD to read |
| 714 | * @val: value to write to @regnum |
| 715 | * |
| 716 | * Same rules as for phy_write(); |
| 717 | */ |
| 718 | static inline int phy_write_mmd(struct phy_device *phydev, int devad, |
| 719 | u32 regnum, u16 val) |
| 720 | { |
| 721 | if (!phydev->is_c45) |
| 722 | return -EOPNOTSUPP; |
| 723 | |
| 724 | regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff); |
| 725 | |
| 726 | return mdiobus_write(phydev->bus, phydev->addr, regnum, val); |
| 727 | } |
| 728 | |
Florian Fainelli | 66ce7fb | 2014-08-22 18:55:43 -0700 | [diff] [blame] | 729 | /** |
| 730 | * phy_write_mmd_indirect - writes data to the MMD registers |
| 731 | * @phydev: The PHY device |
| 732 | * @prtad: MMD Address |
| 733 | * @devad: MMD DEVAD |
| 734 | * @addr: PHY address on the MII bus |
| 735 | * @data: data to write in the MMD register |
| 736 | * |
| 737 | * Description: Write data from the MMD registers of the specified |
| 738 | * phy address. |
| 739 | */ |
| 740 | void phy_write_mmd_indirect(struct phy_device *phydev, int prtad, |
| 741 | int devad, int addr, u32 data); |
| 742 | |
David Daney | ac28b9f | 2012-06-27 07:33:35 +0000 | [diff] [blame] | 743 | struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id, |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 744 | bool is_c45, |
| 745 | struct phy_c45_device_ids *c45_ids); |
David Daney | ac28b9f | 2012-06-27 07:33:35 +0000 | [diff] [blame] | 746 | struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45); |
Grant Likely | 4dea547 | 2009-04-25 12:52:46 +0000 | [diff] [blame] | 747 | int phy_device_register(struct phy_device *phy); |
Russell King | 38737e4 | 2015-09-24 20:36:28 +0100 | [diff] [blame] | 748 | void phy_device_remove(struct phy_device *phydev); |
Anton Vorontsov | 2f5cb43 | 2009-12-30 08:23:30 +0000 | [diff] [blame] | 749 | int phy_init_hw(struct phy_device *phydev); |
Sebastian Hesselbarth | 481b5d9 | 2013-12-13 10:20:27 +0100 | [diff] [blame] | 750 | int phy_suspend(struct phy_device *phydev); |
| 751 | int phy_resume(struct phy_device *phydev); |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 752 | struct phy_device *phy_attach(struct net_device *dev, const char *bus_id, |
| 753 | phy_interface_t interface); |
Jiri Pirko | f8f76db | 2010-02-04 10:23:02 -0800 | [diff] [blame] | 754 | struct phy_device *phy_find_first(struct mii_bus *bus); |
Andy Fleming | 257184d | 2014-01-10 14:27:54 +0800 | [diff] [blame] | 755 | int phy_attach_direct(struct net_device *dev, struct phy_device *phydev, |
| 756 | u32 flags, phy_interface_t interface); |
Grant Likely | fa94f6d | 2009-04-25 12:52:51 +0000 | [diff] [blame] | 757 | int phy_connect_direct(struct net_device *dev, struct phy_device *phydev, |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 758 | void (*handler)(struct net_device *), |
| 759 | phy_interface_t interface); |
| 760 | struct phy_device *phy_connect(struct net_device *dev, const char *bus_id, |
| 761 | void (*handler)(struct net_device *), |
| 762 | phy_interface_t interface); |
Andy Fleming | e139345 | 2005-08-24 18:46:21 -0500 | [diff] [blame] | 763 | void phy_disconnect(struct phy_device *phydev); |
| 764 | void phy_detach(struct phy_device *phydev); |
| 765 | void phy_start(struct phy_device *phydev); |
| 766 | void phy_stop(struct phy_device *phydev); |
| 767 | int phy_start_aneg(struct phy_device *phydev); |
| 768 | |
Andy Fleming | e139345 | 2005-08-24 18:46:21 -0500 | [diff] [blame] | 769 | int phy_stop_interrupts(struct phy_device *phydev); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 770 | |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 771 | static inline int phy_read_status(struct phy_device *phydev) |
| 772 | { |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 773 | return phydev->drv->read_status(phydev); |
| 774 | } |
| 775 | |
Daniel Mack | af6b696 | 2014-04-16 17:19:12 +0200 | [diff] [blame] | 776 | int genphy_config_init(struct phy_device *phydev); |
Madalin Bucur | 3fb69bc | 2013-11-20 16:38:19 -0600 | [diff] [blame] | 777 | int genphy_setup_forced(struct phy_device *phydev); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 778 | int genphy_restart_aneg(struct phy_device *phydev); |
| 779 | int genphy_config_aneg(struct phy_device *phydev); |
Florian Fainelli | a9fa6e6 | 2014-02-11 17:27:36 -0800 | [diff] [blame] | 780 | int genphy_aneg_done(struct phy_device *phydev); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 781 | int genphy_update_link(struct phy_device *phydev); |
| 782 | int genphy_read_status(struct phy_device *phydev); |
Giuseppe Cavallaro | 0f0ca34 | 2008-11-28 16:24:56 -0800 | [diff] [blame] | 783 | int genphy_suspend(struct phy_device *phydev); |
| 784 | int genphy_resume(struct phy_device *phydev); |
Florian Fainelli | 797ac07 | 2014-02-17 13:34:02 -0800 | [diff] [blame] | 785 | int genphy_soft_reset(struct phy_device *phydev); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 786 | void phy_driver_unregister(struct phy_driver *drv); |
Christian Hohnstaedt | d5bf907 | 2012-07-04 05:44:34 +0000 | [diff] [blame] | 787 | void phy_drivers_unregister(struct phy_driver *drv, int n); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 788 | int phy_driver_register(struct phy_driver *new_driver); |
Christian Hohnstaedt | d5bf907 | 2012-07-04 05:44:34 +0000 | [diff] [blame] | 789 | int phy_drivers_register(struct phy_driver *new_driver, int n); |
Anton Vorontsov | 4f9c85a | 2010-01-18 05:37:16 +0000 | [diff] [blame] | 790 | void phy_state_machine(struct work_struct *work); |
Florian Fainelli | 5ea94e7 | 2013-05-19 22:53:43 +0000 | [diff] [blame] | 791 | void phy_change(struct work_struct *work); |
| 792 | void phy_mac_interrupt(struct phy_device *phydev, int new_link); |
Sergei Shtylyov | 29935ae | 2014-01-05 03:27:17 +0300 | [diff] [blame] | 793 | void phy_start_machine(struct phy_device *phydev); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 794 | void phy_stop_machine(struct phy_device *phydev); |
| 795 | int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd); |
| 796 | int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd); |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 797 | int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd); |
Andy Fleming | e139345 | 2005-08-24 18:46:21 -0500 | [diff] [blame] | 798 | int phy_start_interrupts(struct phy_device *phydev); |
| 799 | void phy_print_status(struct phy_device *phydev); |
Anton Vorontsov | 6f4a7f4 | 2007-12-04 16:17:33 +0300 | [diff] [blame] | 800 | void phy_device_free(struct phy_device *phydev); |
Simon Horman | f3a6bd3 | 2015-09-30 15:15:52 +0900 | [diff] [blame] | 801 | int phy_set_max_speed(struct phy_device *phydev, u32 max_speed); |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 802 | |
Andy Fleming | f62220d | 2008-04-18 17:29:54 -0500 | [diff] [blame] | 803 | int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask, |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 804 | int (*run)(struct phy_device *)); |
Andy Fleming | f62220d | 2008-04-18 17:29:54 -0500 | [diff] [blame] | 805 | int phy_register_fixup_for_id(const char *bus_id, |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 806 | int (*run)(struct phy_device *)); |
Andy Fleming | f62220d | 2008-04-18 17:29:54 -0500 | [diff] [blame] | 807 | int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask, |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 808 | int (*run)(struct phy_device *)); |
Andy Fleming | f62220d | 2008-04-18 17:29:54 -0500 | [diff] [blame] | 809 | |
Giuseppe CAVALLARO | a59a4d1 | 2012-06-27 21:14:38 +0000 | [diff] [blame] | 810 | int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable); |
| 811 | int phy_get_eee_err(struct phy_device *phydev); |
| 812 | int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data); |
| 813 | int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data); |
Michael Stapelberg | 42e836e | 2013-03-11 13:56:44 +0000 | [diff] [blame] | 814 | int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol); |
Sergei Shtylyov | 4017b4d | 2014-01-05 03:20:17 +0300 | [diff] [blame] | 815 | void phy_ethtool_get_wol(struct phy_device *phydev, |
| 816 | struct ethtool_wolinfo *wol); |
Giuseppe CAVALLARO | a59a4d1 | 2012-06-27 21:14:38 +0000 | [diff] [blame] | 817 | |
Andy Fleming | 9b9a8bf | 2008-05-02 13:00:51 -0500 | [diff] [blame] | 818 | int __init mdio_bus_init(void); |
| 819 | void mdio_bus_exit(void); |
| 820 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 821 | extern struct bus_type mdio_bus_type; |
Johan Hovold | c31accd | 2014-11-11 19:45:57 +0100 | [diff] [blame] | 822 | |
| 823 | /** |
| 824 | * module_phy_driver() - Helper macro for registering PHY drivers |
| 825 | * @__phy_drivers: array of PHY drivers to register |
| 826 | * |
| 827 | * Helper macro for PHY drivers which do not do anything special in module |
| 828 | * init/exit. Each module may only use this macro once, and calling it |
| 829 | * replaces module_init() and module_exit(). |
| 830 | */ |
| 831 | #define phy_module_driver(__phy_drivers, __count) \ |
| 832 | static int __init phy_module_init(void) \ |
| 833 | { \ |
| 834 | return phy_drivers_register(__phy_drivers, __count); \ |
| 835 | } \ |
| 836 | module_init(phy_module_init); \ |
| 837 | static void __exit phy_module_exit(void) \ |
| 838 | { \ |
| 839 | phy_drivers_unregister(__phy_drivers, __count); \ |
| 840 | } \ |
| 841 | module_exit(phy_module_exit) |
| 842 | |
| 843 | #define module_phy_driver(__phy_drivers) \ |
| 844 | phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers)) |
| 845 | |
Andy Fleming | 00db818 | 2005-07-30 19:31:23 -0400 | [diff] [blame] | 846 | #endif /* __PHY_H */ |