]> asedeno.scripts.mit.edu Git - linux.git/blob - include/linux/phy.h
59bb31ee132ffb5c5b90483fe5743f003fa3fbd2
[linux.git] / include / linux / phy.h
1 /*
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/compiler.h>
20 #include <linux/spinlock.h>
21 #include <linux/ethtool.h>
22 #include <linux/linkmode.h>
23 #include <linux/mdio.h>
24 #include <linux/mii.h>
25 #include <linux/module.h>
26 #include <linux/timer.h>
27 #include <linux/workqueue.h>
28 #include <linux/mod_devicetable.h>
29
30 #include <linux/atomic.h>
31
32 #define PHY_DEFAULT_FEATURES    (SUPPORTED_Autoneg | \
33                                  SUPPORTED_TP | \
34                                  SUPPORTED_MII)
35
36 #define PHY_10BT_FEATURES       (SUPPORTED_10baseT_Half | \
37                                  SUPPORTED_10baseT_Full)
38
39 #define PHY_100BT_FEATURES      (SUPPORTED_100baseT_Half | \
40                                  SUPPORTED_100baseT_Full)
41
42 #define PHY_1000BT_FEATURES     (SUPPORTED_1000baseT_Half | \
43                                  SUPPORTED_1000baseT_Full)
44
45 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
52
53 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
54 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
55 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
56 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
57 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
58 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
59 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
60
61 /*
62  * Set phydev->irq to PHY_POLL if interrupts are not supported,
63  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
64  * the attached driver handles the interrupt
65  */
66 #define PHY_POLL                -1
67 #define PHY_IGNORE_INTERRUPT    -2
68
69 #define PHY_IS_INTERNAL         0x00000001
70 #define PHY_RST_AFTER_CLK_EN    0x00000002
71 #define MDIO_DEVICE_IS_PHY      0x80000000
72
73 /* Interface Mode definitions */
74 typedef enum {
75         PHY_INTERFACE_MODE_NA,
76         PHY_INTERFACE_MODE_INTERNAL,
77         PHY_INTERFACE_MODE_MII,
78         PHY_INTERFACE_MODE_GMII,
79         PHY_INTERFACE_MODE_SGMII,
80         PHY_INTERFACE_MODE_TBI,
81         PHY_INTERFACE_MODE_REVMII,
82         PHY_INTERFACE_MODE_RMII,
83         PHY_INTERFACE_MODE_RGMII,
84         PHY_INTERFACE_MODE_RGMII_ID,
85         PHY_INTERFACE_MODE_RGMII_RXID,
86         PHY_INTERFACE_MODE_RGMII_TXID,
87         PHY_INTERFACE_MODE_RTBI,
88         PHY_INTERFACE_MODE_SMII,
89         PHY_INTERFACE_MODE_XGMII,
90         PHY_INTERFACE_MODE_MOCA,
91         PHY_INTERFACE_MODE_QSGMII,
92         PHY_INTERFACE_MODE_TRGMII,
93         PHY_INTERFACE_MODE_1000BASEX,
94         PHY_INTERFACE_MODE_2500BASEX,
95         PHY_INTERFACE_MODE_RXAUI,
96         PHY_INTERFACE_MODE_XAUI,
97         /* 10GBASE-KR, XFI, SFI - single lane 10G Serdes */
98         PHY_INTERFACE_MODE_10GKR,
99         PHY_INTERFACE_MODE_MAX,
100 } phy_interface_t;
101
102 /**
103  * phy_supported_speeds - return all speeds currently supported by a phy device
104  * @phy: The phy device to return supported speeds of.
105  * @speeds: buffer to store supported speeds in.
106  * @size: size of speeds buffer.
107  *
108  * Description: Returns the number of supported speeds, and
109  * fills the speeds * buffer with the supported speeds. If speeds buffer is
110  * too small to contain * all currently supported speeds, will return as
111  * many speeds as can fit.
112  */
113 unsigned int phy_supported_speeds(struct phy_device *phy,
114                                       unsigned int *speeds,
115                                       unsigned int size);
116
117 /**
118  * It maps 'enum phy_interface_t' found in include/linux/phy.h
119  * into the device tree binding of 'phy-mode', so that Ethernet
120  * device driver can get phy interface from device tree.
121  */
122 static inline const char *phy_modes(phy_interface_t interface)
123 {
124         switch (interface) {
125         case PHY_INTERFACE_MODE_NA:
126                 return "";
127         case PHY_INTERFACE_MODE_INTERNAL:
128                 return "internal";
129         case PHY_INTERFACE_MODE_MII:
130                 return "mii";
131         case PHY_INTERFACE_MODE_GMII:
132                 return "gmii";
133         case PHY_INTERFACE_MODE_SGMII:
134                 return "sgmii";
135         case PHY_INTERFACE_MODE_TBI:
136                 return "tbi";
137         case PHY_INTERFACE_MODE_REVMII:
138                 return "rev-mii";
139         case PHY_INTERFACE_MODE_RMII:
140                 return "rmii";
141         case PHY_INTERFACE_MODE_RGMII:
142                 return "rgmii";
143         case PHY_INTERFACE_MODE_RGMII_ID:
144                 return "rgmii-id";
145         case PHY_INTERFACE_MODE_RGMII_RXID:
146                 return "rgmii-rxid";
147         case PHY_INTERFACE_MODE_RGMII_TXID:
148                 return "rgmii-txid";
149         case PHY_INTERFACE_MODE_RTBI:
150                 return "rtbi";
151         case PHY_INTERFACE_MODE_SMII:
152                 return "smii";
153         case PHY_INTERFACE_MODE_XGMII:
154                 return "xgmii";
155         case PHY_INTERFACE_MODE_MOCA:
156                 return "moca";
157         case PHY_INTERFACE_MODE_QSGMII:
158                 return "qsgmii";
159         case PHY_INTERFACE_MODE_TRGMII:
160                 return "trgmii";
161         case PHY_INTERFACE_MODE_1000BASEX:
162                 return "1000base-x";
163         case PHY_INTERFACE_MODE_2500BASEX:
164                 return "2500base-x";
165         case PHY_INTERFACE_MODE_RXAUI:
166                 return "rxaui";
167         case PHY_INTERFACE_MODE_XAUI:
168                 return "xaui";
169         case PHY_INTERFACE_MODE_10GKR:
170                 return "10gbase-kr";
171         default:
172                 return "unknown";
173         }
174 }
175
176
177 #define PHY_INIT_TIMEOUT        100000
178 #define PHY_STATE_TIME          1
179 #define PHY_FORCE_TIMEOUT       10
180
181 #define PHY_MAX_ADDR    32
182
183 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
184 #define PHY_ID_FMT "%s:%02x"
185
186 #define MII_BUS_ID_SIZE 61
187
188 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
189    IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
190 #define MII_ADDR_C45 (1<<30)
191
192 struct device;
193 struct phylink;
194 struct sk_buff;
195
196 /*
197  * The Bus class for PHYs.  Devices which provide access to
198  * PHYs should register using this structure
199  */
200 struct mii_bus {
201         struct module *owner;
202         const char *name;
203         char id[MII_BUS_ID_SIZE];
204         void *priv;
205         int (*read)(struct mii_bus *bus, int addr, int regnum);
206         int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
207         int (*reset)(struct mii_bus *bus);
208
209         /*
210          * A lock to ensure that only one thing can read/write
211          * the MDIO bus at a time
212          */
213         struct mutex mdio_lock;
214
215         struct device *parent;
216         enum {
217                 MDIOBUS_ALLOCATED = 1,
218                 MDIOBUS_REGISTERED,
219                 MDIOBUS_UNREGISTERED,
220                 MDIOBUS_RELEASED,
221         } state;
222         struct device dev;
223
224         /* list of all PHYs on bus */
225         struct mdio_device *mdio_map[PHY_MAX_ADDR];
226
227         /* PHY addresses to be ignored when probing */
228         u32 phy_mask;
229
230         /* PHY addresses to ignore the TA/read failure */
231         u32 phy_ignore_ta_mask;
232
233         /*
234          * An array of interrupts, each PHY's interrupt at the index
235          * matching its address
236          */
237         int irq[PHY_MAX_ADDR];
238
239         /* GPIO reset pulse width in microseconds */
240         int reset_delay_us;
241         /* RESET GPIO descriptor pointer */
242         struct gpio_desc *reset_gpiod;
243 };
244 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
245
246 struct mii_bus *mdiobus_alloc_size(size_t);
247 static inline struct mii_bus *mdiobus_alloc(void)
248 {
249         return mdiobus_alloc_size(0);
250 }
251
252 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
253 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
254 void mdiobus_unregister(struct mii_bus *bus);
255 void mdiobus_free(struct mii_bus *bus);
256 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
257 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
258 {
259         return devm_mdiobus_alloc_size(dev, 0);
260 }
261
262 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
263 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
264
265 #define PHY_INTERRUPT_DISABLED  false
266 #define PHY_INTERRUPT_ENABLED   true
267
268 /* PHY state machine states:
269  *
270  * DOWN: PHY device and driver are not ready for anything.  probe
271  * should be called if and only if the PHY is in this state,
272  * given that the PHY device exists.
273  * - PHY driver probe function will, depending on the PHY, set
274  * the state to STARTING or READY
275  *
276  * STARTING:  PHY device is coming up, and the ethernet driver is
277  * not ready.  PHY drivers may set this in the probe function.
278  * If they do, they are responsible for making sure the state is
279  * eventually set to indicate whether the PHY is UP or READY,
280  * depending on the state when the PHY is done starting up.
281  * - PHY driver will set the state to READY
282  * - start will set the state to PENDING
283  *
284  * READY: PHY is ready to send and receive packets, but the
285  * controller is not.  By default, PHYs which do not implement
286  * probe will be set to this state by phy_probe().  If the PHY
287  * driver knows the PHY is ready, and the PHY state is STARTING,
288  * then it sets this STATE.
289  * - start will set the state to UP
290  *
291  * PENDING: PHY device is coming up, but the ethernet driver is
292  * ready.  phy_start will set this state if the PHY state is
293  * STARTING.
294  * - PHY driver will set the state to UP when the PHY is ready
295  *
296  * UP: The PHY and attached device are ready to do work.
297  * Interrupts should be started here.
298  * - timer moves to NOLINK or RUNNING
299  *
300  * NOLINK: PHY is up, but not currently plugged in.
301  * - If the timer notes that the link comes back, we move to RUNNING
302  * - phy_stop moves to HALTED
303  *
304  * FORCING: PHY is being configured with forced settings
305  * - if link is up, move to RUNNING
306  * - If link is down, we drop to the next highest setting, and
307  *   retry (FORCING) after a timeout
308  * - phy_stop moves to HALTED
309  *
310  * RUNNING: PHY is currently up, running, and possibly sending
311  * and/or receiving packets
312  * - timer will set CHANGELINK if we're polling (this ensures the
313  *   link state is polled every other cycle of this state machine,
314  *   which makes it every other second)
315  * - irq will set CHANGELINK
316  * - phy_stop moves to HALTED
317  *
318  * CHANGELINK: PHY experienced a change in link state
319  * - timer moves to RUNNING if link
320  * - timer moves to NOLINK if the link is down
321  * - phy_stop moves to HALTED
322  *
323  * HALTED: PHY is up, but no polling or interrupts are done. Or
324  * PHY is in an error state.
325  *
326  * - phy_start moves to RESUMING
327  *
328  * RESUMING: PHY was halted, but now wants to run again.
329  * - If we are forcing, or aneg is done, timer moves to RUNNING
330  * - If aneg is not done, timer moves to AN
331  * - phy_stop moves to HALTED
332  */
333 enum phy_state {
334         PHY_DOWN = 0,
335         PHY_STARTING,
336         PHY_READY,
337         PHY_PENDING,
338         PHY_UP,
339         PHY_RUNNING,
340         PHY_NOLINK,
341         PHY_FORCING,
342         PHY_CHANGELINK,
343         PHY_HALTED,
344         PHY_RESUMING
345 };
346
347 /**
348  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
349  * @devices_in_package: Bit vector of devices present.
350  * @device_ids: The device identifer for each present device.
351  */
352 struct phy_c45_device_ids {
353         u32 devices_in_package;
354         u32 device_ids[8];
355 };
356
357 /* phy_device: An instance of a PHY
358  *
359  * drv: Pointer to the driver for this PHY instance
360  * phy_id: UID for this device found during discovery
361  * c45_ids: 802.3-c45 Device Identifers if is_c45.
362  * is_c45:  Set to true if this phy uses clause 45 addressing.
363  * is_internal: Set to true if this phy is internal to a MAC.
364  * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc.
365  * has_fixups: Set to true if this phy has fixups/quirks.
366  * suspended: Set to true if this phy has been suspended successfully.
367  * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
368  * loopback_enabled: Set true if this phy has been loopbacked successfully.
369  * state: state of the PHY for management purposes
370  * dev_flags: Device-specific flags used by the PHY driver.
371  * link_timeout: The number of timer firings to wait before the
372  * giving up on the current attempt at acquiring a link
373  * irq: IRQ number of the PHY's interrupt (-1 if none)
374  * phy_timer: The timer for handling the state machine
375  * phy_queue: A work_queue for the phy_mac_interrupt
376  * attached_dev: The attached enet driver's device instance ptr
377  * adjust_link: Callback for the enet controller to respond to
378  * changes in the link state.
379  *
380  * speed, duplex, pause, supported, advertising, lp_advertising,
381  * and autoneg are used like in mii_if_info
382  *
383  * interrupts currently only supports enabled or disabled,
384  * but could be changed in the future to support enabling
385  * and disabling specific interrupts
386  *
387  * Contains some infrastructure for polling and interrupt
388  * handling, as well as handling shifts in PHY hardware state
389  */
390 struct phy_device {
391         struct mdio_device mdio;
392
393         /* Information about the PHY type */
394         /* And management functions */
395         struct phy_driver *drv;
396
397         u32 phy_id;
398
399         struct phy_c45_device_ids c45_ids;
400         unsigned is_c45:1;
401         unsigned is_internal:1;
402         unsigned is_pseudo_fixed_link:1;
403         unsigned has_fixups:1;
404         unsigned suspended:1;
405         unsigned sysfs_links:1;
406         unsigned loopback_enabled:1;
407
408         unsigned autoneg:1;
409         /* The most recently read link state */
410         unsigned link:1;
411
412         /* Interrupts are enabled */
413         unsigned interrupts:1;
414
415         enum phy_state state;
416
417         u32 dev_flags;
418
419         phy_interface_t interface;
420
421         /*
422          * forced speed & duplex (no autoneg)
423          * partner speed & duplex & pause (autoneg)
424          */
425         int speed;
426         int duplex;
427         int pause;
428         int asym_pause;
429
430         /* Union of PHY and Attached devices' supported modes */
431         /* See mii.h for more info */
432         u32 supported;
433         u32 advertising;
434         u32 lp_advertising;
435
436         /* Energy efficient ethernet modes which should be prohibited */
437         u32 eee_broken_modes;
438
439         int link_timeout;
440
441 #ifdef CONFIG_LED_TRIGGER_PHY
442         struct phy_led_trigger *phy_led_triggers;
443         unsigned int phy_num_led_triggers;
444         struct phy_led_trigger *last_triggered;
445
446         struct phy_led_trigger *led_link_trigger;
447 #endif
448
449         /*
450          * Interrupt number for this PHY
451          * -1 means no interrupt
452          */
453         int irq;
454
455         /* private data pointer */
456         /* For use by PHYs to maintain extra state */
457         void *priv;
458
459         /* Interrupt and Polling infrastructure */
460         struct work_struct phy_queue;
461         struct delayed_work state_queue;
462
463         struct mutex lock;
464
465         struct phylink *phylink;
466         struct net_device *attached_dev;
467
468         u8 mdix;
469         u8 mdix_ctrl;
470
471         void (*phy_link_change)(struct phy_device *, bool up, bool do_carrier);
472         void (*adjust_link)(struct net_device *dev);
473 };
474 #define to_phy_device(d) container_of(to_mdio_device(d), \
475                                       struct phy_device, mdio)
476
477 /* struct phy_driver: Driver structure for a particular PHY type
478  *
479  * driver_data: static driver data
480  * phy_id: The result of reading the UID registers of this PHY
481  *   type, and ANDing them with the phy_id_mask.  This driver
482  *   only works for PHYs with IDs which match this field
483  * name: The friendly name of this PHY type
484  * phy_id_mask: Defines the important bits of the phy_id
485  * features: A list of features (speed, duplex, etc) supported
486  *   by this PHY
487  * flags: A bitfield defining certain other features this PHY
488  *   supports (like interrupts)
489  *
490  * All functions are optional. If config_aneg or read_status
491  * are not implemented, the phy core uses the genphy versions.
492  * Note that none of these functions should be called from
493  * interrupt time. The goal is for the bus read/write functions
494  * to be able to block when the bus transaction is happening,
495  * and be freed up by an interrupt (The MPC85xx has this ability,
496  * though it is not currently supported in the driver).
497  */
498 struct phy_driver {
499         struct mdio_driver_common mdiodrv;
500         u32 phy_id;
501         char *name;
502         u32 phy_id_mask;
503         const unsigned long * const features;
504         u32 flags;
505         const void *driver_data;
506
507         /*
508          * Called to issue a PHY software reset
509          */
510         int (*soft_reset)(struct phy_device *phydev);
511
512         /*
513          * Called to initialize the PHY,
514          * including after a reset
515          */
516         int (*config_init)(struct phy_device *phydev);
517
518         /*
519          * Called during discovery.  Used to set
520          * up device-specific structures, if any
521          */
522         int (*probe)(struct phy_device *phydev);
523
524         /* PHY Power Management */
525         int (*suspend)(struct phy_device *phydev);
526         int (*resume)(struct phy_device *phydev);
527
528         /*
529          * Configures the advertisement and resets
530          * autonegotiation if phydev->autoneg is on,
531          * forces the speed to the current settings in phydev
532          * if phydev->autoneg is off
533          */
534         int (*config_aneg)(struct phy_device *phydev);
535
536         /* Determines the auto negotiation result */
537         int (*aneg_done)(struct phy_device *phydev);
538
539         /* Determines the negotiated speed and duplex */
540         int (*read_status)(struct phy_device *phydev);
541
542         /* Clears any pending interrupts */
543         int (*ack_interrupt)(struct phy_device *phydev);
544
545         /* Enables or disables interrupts */
546         int (*config_intr)(struct phy_device *phydev);
547
548         /*
549          * Checks if the PHY generated an interrupt.
550          * For multi-PHY devices with shared PHY interrupt pin
551          */
552         int (*did_interrupt)(struct phy_device *phydev);
553
554         /* Clears up any memory if needed */
555         void (*remove)(struct phy_device *phydev);
556
557         /* Returns true if this is a suitable driver for the given
558          * phydev.  If NULL, matching is based on phy_id and
559          * phy_id_mask.
560          */
561         int (*match_phy_device)(struct phy_device *phydev);
562
563         /* Handles ethtool queries for hardware time stamping. */
564         int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
565
566         /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
567         int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
568
569         /*
570          * Requests a Rx timestamp for 'skb'. If the skb is accepted,
571          * the phy driver promises to deliver it using netif_rx() as
572          * soon as a timestamp becomes available. One of the
573          * PTP_CLASS_ values is passed in 'type'. The function must
574          * return true if the skb is accepted for delivery.
575          */
576         bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
577
578         /*
579          * Requests a Tx timestamp for 'skb'. The phy driver promises
580          * to deliver it using skb_complete_tx_timestamp() as soon as a
581          * timestamp becomes available. One of the PTP_CLASS_ values
582          * is passed in 'type'.
583          */
584         void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
585
586         /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
587          * enable Wake on LAN, so set_wol is provided to be called in the
588          * ethernet driver's set_wol function. */
589         int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
590
591         /* See set_wol, but for checking whether Wake on LAN is enabled. */
592         void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
593
594         /*
595          * Called to inform a PHY device driver when the core is about to
596          * change the link state. This callback is supposed to be used as
597          * fixup hook for drivers that need to take action when the link
598          * state changes. Drivers are by no means allowed to mess with the
599          * PHY device structure in their implementations.
600          */
601         void (*link_change_notify)(struct phy_device *dev);
602
603         /*
604          * Phy specific driver override for reading a MMD register.
605          * This function is optional for PHY specific drivers.  When
606          * not provided, the default MMD read function will be used
607          * by phy_read_mmd(), which will use either a direct read for
608          * Clause 45 PHYs or an indirect read for Clause 22 PHYs.
609          *  devnum is the MMD device number within the PHY device,
610          *  regnum is the register within the selected MMD device.
611          */
612         int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
613
614         /*
615          * Phy specific driver override for writing a MMD register.
616          * This function is optional for PHY specific drivers.  When
617          * not provided, the default MMD write function will be used
618          * by phy_write_mmd(), which will use either a direct write for
619          * Clause 45 PHYs, or an indirect write for Clause 22 PHYs.
620          *  devnum is the MMD device number within the PHY device,
621          *  regnum is the register within the selected MMD device.
622          *  val is the value to be written.
623          */
624         int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
625                          u16 val);
626
627         int (*read_page)(struct phy_device *dev);
628         int (*write_page)(struct phy_device *dev, int page);
629
630         /* Get the size and type of the eeprom contained within a plug-in
631          * module */
632         int (*module_info)(struct phy_device *dev,
633                            struct ethtool_modinfo *modinfo);
634
635         /* Get the eeprom information from the plug-in module */
636         int (*module_eeprom)(struct phy_device *dev,
637                              struct ethtool_eeprom *ee, u8 *data);
638
639         /* Get statistics from the phy using ethtool */
640         int (*get_sset_count)(struct phy_device *dev);
641         void (*get_strings)(struct phy_device *dev, u8 *data);
642         void (*get_stats)(struct phy_device *dev,
643                           struct ethtool_stats *stats, u64 *data);
644
645         /* Get and Set PHY tunables */
646         int (*get_tunable)(struct phy_device *dev,
647                            struct ethtool_tunable *tuna, void *data);
648         int (*set_tunable)(struct phy_device *dev,
649                             struct ethtool_tunable *tuna,
650                             const void *data);
651         int (*set_loopback)(struct phy_device *dev, bool enable);
652 };
653 #define to_phy_driver(d) container_of(to_mdio_common_driver(d),         \
654                                       struct phy_driver, mdiodrv)
655
656 #define PHY_ANY_ID "MATCH ANY PHY"
657 #define PHY_ANY_UID 0xffffffff
658
659 /* A Structure for boards to register fixups with the PHY Lib */
660 struct phy_fixup {
661         struct list_head list;
662         char bus_id[MII_BUS_ID_SIZE + 3];
663         u32 phy_uid;
664         u32 phy_uid_mask;
665         int (*run)(struct phy_device *phydev);
666 };
667
668 const char *phy_speed_to_str(int speed);
669 const char *phy_duplex_to_str(unsigned int duplex);
670
671 /* A structure for mapping a particular speed and duplex
672  * combination to a particular SUPPORTED and ADVERTISED value
673  */
674 struct phy_setting {
675         u32 speed;
676         u8 duplex;
677         u8 bit;
678 };
679
680 const struct phy_setting *
681 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
682                    size_t maxbit, bool exact);
683 size_t phy_speeds(unsigned int *speeds, size_t size,
684                   unsigned long *mask, size_t maxbit);
685
686 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
687
688 /**
689  * phy_read_mmd - Convenience function for reading a register
690  * from an MMD on a given PHY.
691  * @phydev: The phy_device struct
692  * @devad: The MMD to read from
693  * @regnum: The register on the MMD to read
694  *
695  * Same rules as for phy_read();
696  */
697 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
698
699 /**
700  * phy_read - Convenience function for reading a given PHY register
701  * @phydev: the phy_device struct
702  * @regnum: register number to read
703  *
704  * NOTE: MUST NOT be called from interrupt context,
705  * because the bus read/write functions may wait for an interrupt
706  * to conclude the operation.
707  */
708 static inline int phy_read(struct phy_device *phydev, u32 regnum)
709 {
710         return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
711 }
712
713 /**
714  * __phy_read - convenience function for reading a given PHY register
715  * @phydev: the phy_device struct
716  * @regnum: register number to read
717  *
718  * The caller must have taken the MDIO bus lock.
719  */
720 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
721 {
722         return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
723 }
724
725 /**
726  * phy_write - Convenience function for writing a given PHY register
727  * @phydev: the phy_device struct
728  * @regnum: register number to write
729  * @val: value to write to @regnum
730  *
731  * NOTE: MUST NOT be called from interrupt context,
732  * because the bus read/write functions may wait for an interrupt
733  * to conclude the operation.
734  */
735 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
736 {
737         return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
738 }
739
740 /**
741  * __phy_write - Convenience function for writing a given PHY register
742  * @phydev: the phy_device struct
743  * @regnum: register number to write
744  * @val: value to write to @regnum
745  *
746  * The caller must have taken the MDIO bus lock.
747  */
748 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
749 {
750         return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
751                                val);
752 }
753
754 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
755 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
756
757 /**
758  * __phy_set_bits - Convenience function for setting bits in a PHY register
759  * @phydev: the phy_device struct
760  * @regnum: register number to write
761  * @val: bits to set
762  *
763  * The caller must have taken the MDIO bus lock.
764  */
765 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
766 {
767         return __phy_modify(phydev, regnum, 0, val);
768 }
769
770 /**
771  * __phy_clear_bits - Convenience function for clearing bits in a PHY register
772  * @phydev: the phy_device struct
773  * @regnum: register number to write
774  * @val: bits to clear
775  *
776  * The caller must have taken the MDIO bus lock.
777  */
778 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
779                                    u16 val)
780 {
781         return __phy_modify(phydev, regnum, val, 0);
782 }
783
784 /**
785  * phy_set_bits - Convenience function for setting bits in a PHY register
786  * @phydev: the phy_device struct
787  * @regnum: register number to write
788  * @val: bits to set
789  */
790 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
791 {
792         return phy_modify(phydev, regnum, 0, val);
793 }
794
795 /**
796  * phy_clear_bits - Convenience function for clearing bits in a PHY register
797  * @phydev: the phy_device struct
798  * @regnum: register number to write
799  * @val: bits to clear
800  */
801 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
802 {
803         return phy_modify(phydev, regnum, val, 0);
804 }
805
806 /**
807  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
808  * @phydev: the phy_device struct
809  *
810  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
811  * PHY_IGNORE_INTERRUPT
812  */
813 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
814 {
815         return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
816 }
817
818 /**
819  * phy_polling_mode - Convenience function for testing whether polling is
820  * used to detect PHY status changes
821  * @phydev: the phy_device struct
822  */
823 static inline bool phy_polling_mode(struct phy_device *phydev)
824 {
825         return phydev->irq == PHY_POLL;
826 }
827
828 /**
829  * phy_is_internal - Convenience function for testing if a PHY is internal
830  * @phydev: the phy_device struct
831  */
832 static inline bool phy_is_internal(struct phy_device *phydev)
833 {
834         return phydev->is_internal;
835 }
836
837 /**
838  * phy_interface_mode_is_rgmii - Convenience function for testing if a
839  * PHY interface mode is RGMII (all variants)
840  * @mode: the phy_interface_t enum
841  */
842 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
843 {
844         return mode >= PHY_INTERFACE_MODE_RGMII &&
845                 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
846 };
847
848 /**
849  * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
850  *   negotiation
851  * @mode: one of &enum phy_interface_t
852  *
853  * Returns true if the phy interface mode uses the 16-bit negotiation
854  * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
855  */
856 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
857 {
858         return mode == PHY_INTERFACE_MODE_1000BASEX ||
859                mode == PHY_INTERFACE_MODE_2500BASEX;
860 }
861
862 /**
863  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
864  * is RGMII (all variants)
865  * @phydev: the phy_device struct
866  */
867 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
868 {
869         return phy_interface_mode_is_rgmii(phydev->interface);
870 };
871
872 /*
873  * phy_is_pseudo_fixed_link - Convenience function for testing if this
874  * PHY is the CPU port facing side of an Ethernet switch, or similar.
875  * @phydev: the phy_device struct
876  */
877 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
878 {
879         return phydev->is_pseudo_fixed_link;
880 }
881
882 /**
883  * phy_write_mmd - Convenience function for writing a register
884  * on an MMD on a given PHY.
885  * @phydev: The phy_device struct
886  * @devad: The MMD to read from
887  * @regnum: The register on the MMD to read
888  * @val: value to write to @regnum
889  *
890  * Same rules as for phy_write();
891  */
892 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
893
894 int phy_save_page(struct phy_device *phydev);
895 int phy_select_page(struct phy_device *phydev, int page);
896 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
897 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
898 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
899 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
900                      u16 mask, u16 set);
901
902 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
903                                      bool is_c45,
904                                      struct phy_c45_device_ids *c45_ids);
905 #if IS_ENABLED(CONFIG_PHYLIB)
906 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
907 int phy_device_register(struct phy_device *phy);
908 void phy_device_free(struct phy_device *phydev);
909 #else
910 static inline
911 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
912 {
913         return NULL;
914 }
915
916 static inline int phy_device_register(struct phy_device *phy)
917 {
918         return 0;
919 }
920
921 static inline void phy_device_free(struct phy_device *phydev) { }
922 #endif /* CONFIG_PHYLIB */
923 void phy_device_remove(struct phy_device *phydev);
924 int phy_init_hw(struct phy_device *phydev);
925 int phy_suspend(struct phy_device *phydev);
926 int phy_resume(struct phy_device *phydev);
927 int __phy_resume(struct phy_device *phydev);
928 int phy_loopback(struct phy_device *phydev, bool enable);
929 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
930                               phy_interface_t interface);
931 struct phy_device *phy_find_first(struct mii_bus *bus);
932 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
933                       u32 flags, phy_interface_t interface);
934 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
935                        void (*handler)(struct net_device *),
936                        phy_interface_t interface);
937 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
938                                void (*handler)(struct net_device *),
939                                phy_interface_t interface);
940 void phy_disconnect(struct phy_device *phydev);
941 void phy_detach(struct phy_device *phydev);
942 void phy_start(struct phy_device *phydev);
943 void phy_stop(struct phy_device *phydev);
944 int phy_start_aneg(struct phy_device *phydev);
945 int phy_aneg_done(struct phy_device *phydev);
946 int phy_speed_down(struct phy_device *phydev, bool sync);
947 int phy_speed_up(struct phy_device *phydev);
948
949 int phy_stop_interrupts(struct phy_device *phydev);
950 int phy_restart_aneg(struct phy_device *phydev);
951 int phy_reset_after_clk_enable(struct phy_device *phydev);
952
953 static inline void phy_device_reset(struct phy_device *phydev, int value)
954 {
955         mdio_device_reset(&phydev->mdio, value);
956 }
957
958 #define phydev_err(_phydev, format, args...)    \
959         dev_err(&_phydev->mdio.dev, format, ##args)
960
961 #define phydev_info(_phydev, format, args...)   \
962         dev_info(&_phydev->mdio.dev, format, ##args)
963
964 #define phydev_warn(_phydev, format, args...)   \
965         dev_warn(&_phydev->mdio.dev, format, ##args)
966
967 #define phydev_dbg(_phydev, format, args...)    \
968         dev_dbg(&_phydev->mdio.dev, format, ##args)
969
970 static inline const char *phydev_name(const struct phy_device *phydev)
971 {
972         return dev_name(&phydev->mdio.dev);
973 }
974
975 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
976         __printf(2, 3);
977 void phy_attached_info(struct phy_device *phydev);
978
979 /* Clause 22 PHY */
980 int genphy_config_init(struct phy_device *phydev);
981 int genphy_setup_forced(struct phy_device *phydev);
982 int genphy_restart_aneg(struct phy_device *phydev);
983 int genphy_config_aneg(struct phy_device *phydev);
984 int genphy_aneg_done(struct phy_device *phydev);
985 int genphy_update_link(struct phy_device *phydev);
986 int genphy_read_status(struct phy_device *phydev);
987 int genphy_suspend(struct phy_device *phydev);
988 int genphy_resume(struct phy_device *phydev);
989 int genphy_loopback(struct phy_device *phydev, bool enable);
990 int genphy_soft_reset(struct phy_device *phydev);
991 static inline int genphy_no_soft_reset(struct phy_device *phydev)
992 {
993         return 0;
994 }
995 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
996                                 u16 regnum);
997 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
998                                  u16 regnum, u16 val);
999
1000 /* Clause 45 PHY */
1001 int genphy_c45_restart_aneg(struct phy_device *phydev);
1002 int genphy_c45_aneg_done(struct phy_device *phydev);
1003 int genphy_c45_read_link(struct phy_device *phydev, u32 mmd_mask);
1004 int genphy_c45_read_lpa(struct phy_device *phydev);
1005 int genphy_c45_read_pma(struct phy_device *phydev);
1006 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1007 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1008 int genphy_c45_read_mdix(struct phy_device *phydev);
1009
1010 /* The gen10g_* functions are the old Clause 45 stub */
1011 int gen10g_config_aneg(struct phy_device *phydev);
1012 int gen10g_read_status(struct phy_device *phydev);
1013 int gen10g_no_soft_reset(struct phy_device *phydev);
1014 int gen10g_config_init(struct phy_device *phydev);
1015 int gen10g_suspend(struct phy_device *phydev);
1016 int gen10g_resume(struct phy_device *phydev);
1017
1018 static inline int phy_read_status(struct phy_device *phydev)
1019 {
1020         if (!phydev->drv)
1021                 return -EIO;
1022
1023         if (phydev->drv->read_status)
1024                 return phydev->drv->read_status(phydev);
1025         else
1026                 return genphy_read_status(phydev);
1027 }
1028
1029 void phy_driver_unregister(struct phy_driver *drv);
1030 void phy_drivers_unregister(struct phy_driver *drv, int n);
1031 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1032 int phy_drivers_register(struct phy_driver *new_driver, int n,
1033                          struct module *owner);
1034 void phy_state_machine(struct work_struct *work);
1035 void phy_change_work(struct work_struct *work);
1036 void phy_mac_interrupt(struct phy_device *phydev);
1037 void phy_start_machine(struct phy_device *phydev);
1038 void phy_stop_machine(struct phy_device *phydev);
1039 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
1040 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1041                                struct ethtool_link_ksettings *cmd);
1042 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1043                               const struct ethtool_link_ksettings *cmd);
1044 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1045 int phy_start_interrupts(struct phy_device *phydev);
1046 void phy_print_status(struct phy_device *phydev);
1047 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1048 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1049 void phy_support_sym_pause(struct phy_device *phydev);
1050 void phy_support_asym_pause(struct phy_device *phydev);
1051 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1052                        bool autoneg);
1053 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1054 bool phy_validate_pause(struct phy_device *phydev,
1055                         struct ethtool_pauseparam *pp);
1056
1057 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1058                        int (*run)(struct phy_device *));
1059 int phy_register_fixup_for_id(const char *bus_id,
1060                               int (*run)(struct phy_device *));
1061 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1062                                int (*run)(struct phy_device *));
1063
1064 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1065 int phy_unregister_fixup_for_id(const char *bus_id);
1066 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1067
1068 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1069 int phy_get_eee_err(struct phy_device *phydev);
1070 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1071 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1072 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1073 void phy_ethtool_get_wol(struct phy_device *phydev,
1074                          struct ethtool_wolinfo *wol);
1075 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1076                                    struct ethtool_link_ksettings *cmd);
1077 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1078                                    const struct ethtool_link_ksettings *cmd);
1079 int phy_ethtool_nway_reset(struct net_device *ndev);
1080
1081 #if IS_ENABLED(CONFIG_PHYLIB)
1082 int __init mdio_bus_init(void);
1083 void mdio_bus_exit(void);
1084 #endif
1085
1086 /* Inline function for use within net/core/ethtool.c (built-in) */
1087 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
1088 {
1089         if (!phydev->drv)
1090                 return -EIO;
1091
1092         mutex_lock(&phydev->lock);
1093         phydev->drv->get_strings(phydev, data);
1094         mutex_unlock(&phydev->lock);
1095
1096         return 0;
1097 }
1098
1099 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev)
1100 {
1101         int ret;
1102
1103         if (!phydev->drv)
1104                 return -EIO;
1105
1106         if (phydev->drv->get_sset_count &&
1107             phydev->drv->get_strings &&
1108             phydev->drv->get_stats) {
1109                 mutex_lock(&phydev->lock);
1110                 ret = phydev->drv->get_sset_count(phydev);
1111                 mutex_unlock(&phydev->lock);
1112
1113                 return ret;
1114         }
1115
1116         return -EOPNOTSUPP;
1117 }
1118
1119 static inline int phy_ethtool_get_stats(struct phy_device *phydev,
1120                                         struct ethtool_stats *stats, u64 *data)
1121 {
1122         if (!phydev->drv)
1123                 return -EIO;
1124
1125         mutex_lock(&phydev->lock);
1126         phydev->drv->get_stats(phydev, stats, data);
1127         mutex_unlock(&phydev->lock);
1128
1129         return 0;
1130 }
1131
1132 extern struct bus_type mdio_bus_type;
1133
1134 struct mdio_board_info {
1135         const char      *bus_id;
1136         char            modalias[MDIO_NAME_SIZE];
1137         int             mdio_addr;
1138         const void      *platform_data;
1139 };
1140
1141 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1142 int mdiobus_register_board_info(const struct mdio_board_info *info,
1143                                 unsigned int n);
1144 #else
1145 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1146                                               unsigned int n)
1147 {
1148         return 0;
1149 }
1150 #endif
1151
1152
1153 /**
1154  * module_phy_driver() - Helper macro for registering PHY drivers
1155  * @__phy_drivers: array of PHY drivers to register
1156  *
1157  * Helper macro for PHY drivers which do not do anything special in module
1158  * init/exit. Each module may only use this macro once, and calling it
1159  * replaces module_init() and module_exit().
1160  */
1161 #define phy_module_driver(__phy_drivers, __count)                       \
1162 static int __init phy_module_init(void)                                 \
1163 {                                                                       \
1164         return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1165 }                                                                       \
1166 module_init(phy_module_init);                                           \
1167 static void __exit phy_module_exit(void)                                \
1168 {                                                                       \
1169         phy_drivers_unregister(__phy_drivers, __count);                 \
1170 }                                                                       \
1171 module_exit(phy_module_exit)
1172
1173 #define module_phy_driver(__phy_drivers)                                \
1174         phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1175
1176 #endif /* __PHY_H */