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