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 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
671 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
672 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
673
674 /* A Structure for boards to register fixups with the PHY Lib */
675 struct phy_fixup {
676 struct list_head list;
677 char bus_id[MII_BUS_ID_SIZE + 3];
678 u32 phy_uid;
679 u32 phy_uid_mask;
680 int (*run)(struct phy_device *phydev);
681 };
682
683 const char *phy_speed_to_str(int speed);
684 const char *phy_duplex_to_str(unsigned int duplex);
685
686 /* A structure for mapping a particular speed and duplex
687 * combination to a particular SUPPORTED and ADVERTISED value
688 */
689 struct phy_setting {
690 u32 speed;
691 u8 duplex;
692 u8 bit;
693 };
694
695 const struct phy_setting *
696 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
697 size_t maxbit, bool exact);
698 size_t phy_speeds(unsigned int *speeds, size_t size,
699 unsigned long *mask, size_t maxbit);
700
701 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
702
703 /**
704 * phy_read_mmd - Convenience function for reading a register
705 * from an MMD on a given PHY.
706 * @phydev: The phy_device struct
707 * @devad: The MMD to read from
708 * @regnum: The register on the MMD to read
709 *
710 * Same rules as for phy_read();
711 */
712 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
713
714 /**
715 * phy_read - Convenience function for reading a given PHY register
716 * @phydev: the phy_device struct
717 * @regnum: register number to read
718 *
719 * NOTE: MUST NOT be called from interrupt context,
720 * because the bus read/write functions may wait for an interrupt
721 * to conclude the operation.
722 */
phy_read(struct phy_device * phydev,u32 regnum)723 static inline int phy_read(struct phy_device *phydev, u32 regnum)
724 {
725 return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
726 }
727
728 /**
729 * __phy_read - convenience function for reading a given PHY register
730 * @phydev: the phy_device struct
731 * @regnum: register number to read
732 *
733 * The caller must have taken the MDIO bus lock.
734 */
__phy_read(struct phy_device * phydev,u32 regnum)735 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
736 {
737 return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
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 * NOTE: MUST NOT be called from interrupt context,
747 * because the bus read/write functions may wait for an interrupt
748 * to conclude the operation.
749 */
phy_write(struct phy_device * phydev,u32 regnum,u16 val)750 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
751 {
752 return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
753 }
754
755 /**
756 * __phy_write - Convenience function for writing a given PHY register
757 * @phydev: the phy_device struct
758 * @regnum: register number to write
759 * @val: value to write to @regnum
760 *
761 * The caller must have taken the MDIO bus lock.
762 */
__phy_write(struct phy_device * phydev,u32 regnum,u16 val)763 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
764 {
765 return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
766 val);
767 }
768
769 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
770 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
771
772 /**
773 * __phy_set_bits - Convenience function for setting bits in a PHY register
774 * @phydev: the phy_device struct
775 * @regnum: register number to write
776 * @val: bits to set
777 *
778 * The caller must have taken the MDIO bus lock.
779 */
__phy_set_bits(struct phy_device * phydev,u32 regnum,u16 val)780 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
781 {
782 return __phy_modify(phydev, regnum, 0, val);
783 }
784
785 /**
786 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
787 * @phydev: the phy_device struct
788 * @regnum: register number to write
789 * @val: bits to clear
790 *
791 * The caller must have taken the MDIO bus lock.
792 */
__phy_clear_bits(struct phy_device * phydev,u32 regnum,u16 val)793 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
794 u16 val)
795 {
796 return __phy_modify(phydev, regnum, val, 0);
797 }
798
799 /**
800 * phy_set_bits - Convenience function for setting bits in a PHY register
801 * @phydev: the phy_device struct
802 * @regnum: register number to write
803 * @val: bits to set
804 */
phy_set_bits(struct phy_device * phydev,u32 regnum,u16 val)805 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
806 {
807 return phy_modify(phydev, regnum, 0, val);
808 }
809
810 /**
811 * phy_clear_bits - Convenience function for clearing bits in a PHY register
812 * @phydev: the phy_device struct
813 * @regnum: register number to write
814 * @val: bits to clear
815 */
phy_clear_bits(struct phy_device * phydev,u32 regnum,u16 val)816 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
817 {
818 return phy_modify(phydev, regnum, val, 0);
819 }
820
821 /**
822 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
823 * @phydev: the phy_device struct
824 *
825 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
826 * PHY_IGNORE_INTERRUPT
827 */
phy_interrupt_is_valid(struct phy_device * phydev)828 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
829 {
830 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
831 }
832
833 /**
834 * phy_polling_mode - Convenience function for testing whether polling is
835 * used to detect PHY status changes
836 * @phydev: the phy_device struct
837 */
phy_polling_mode(struct phy_device * phydev)838 static inline bool phy_polling_mode(struct phy_device *phydev)
839 {
840 return phydev->irq == PHY_POLL;
841 }
842
843 /**
844 * phy_is_internal - Convenience function for testing if a PHY is internal
845 * @phydev: the phy_device struct
846 */
phy_is_internal(struct phy_device * phydev)847 static inline bool phy_is_internal(struct phy_device *phydev)
848 {
849 return phydev->is_internal;
850 }
851
852 /**
853 * phy_interface_mode_is_rgmii - Convenience function for testing if a
854 * PHY interface mode is RGMII (all variants)
855 * @mode: the phy_interface_t enum
856 */
phy_interface_mode_is_rgmii(phy_interface_t mode)857 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
858 {
859 return mode >= PHY_INTERFACE_MODE_RGMII &&
860 mode <= PHY_INTERFACE_MODE_RGMII_TXID;
861 };
862
863 /**
864 * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
865 * negotiation
866 * @mode: one of &enum phy_interface_t
867 *
868 * Returns true if the phy interface mode uses the 16-bit negotiation
869 * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
870 */
phy_interface_mode_is_8023z(phy_interface_t mode)871 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
872 {
873 return mode == PHY_INTERFACE_MODE_1000BASEX ||
874 mode == PHY_INTERFACE_MODE_2500BASEX;
875 }
876
877 /**
878 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
879 * is RGMII (all variants)
880 * @phydev: the phy_device struct
881 */
phy_interface_is_rgmii(struct phy_device * phydev)882 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
883 {
884 return phy_interface_mode_is_rgmii(phydev->interface);
885 };
886
887 /*
888 * phy_is_pseudo_fixed_link - Convenience function for testing if this
889 * PHY is the CPU port facing side of an Ethernet switch, or similar.
890 * @phydev: the phy_device struct
891 */
phy_is_pseudo_fixed_link(struct phy_device * phydev)892 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
893 {
894 return phydev->is_pseudo_fixed_link;
895 }
896
897 /**
898 * phy_write_mmd - Convenience function for writing a register
899 * on an MMD on a given PHY.
900 * @phydev: The phy_device struct
901 * @devad: The MMD to read from
902 * @regnum: The register on the MMD to read
903 * @val: value to write to @regnum
904 *
905 * Same rules as for phy_write();
906 */
907 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
908
909 int phy_save_page(struct phy_device *phydev);
910 int phy_select_page(struct phy_device *phydev, int page);
911 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
912 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
913 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
914 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
915 u16 mask, u16 set);
916
917 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
918 bool is_c45,
919 struct phy_c45_device_ids *c45_ids);
920 #if IS_ENABLED(CONFIG_PHYLIB)
921 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
922 int phy_device_register(struct phy_device *phy);
923 void phy_device_free(struct phy_device *phydev);
924 #else
925 static inline
get_phy_device(struct mii_bus * bus,int addr,bool is_c45)926 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
927 {
928 return NULL;
929 }
930
phy_device_register(struct phy_device * phy)931 static inline int phy_device_register(struct phy_device *phy)
932 {
933 return 0;
934 }
935
phy_device_free(struct phy_device * phydev)936 static inline void phy_device_free(struct phy_device *phydev) { }
937 #endif /* CONFIG_PHYLIB */
938 void phy_device_remove(struct phy_device *phydev);
939 int phy_init_hw(struct phy_device *phydev);
940 int phy_suspend(struct phy_device *phydev);
941 int phy_resume(struct phy_device *phydev);
942 int __phy_resume(struct phy_device *phydev);
943 int phy_loopback(struct phy_device *phydev, bool enable);
944 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
945 phy_interface_t interface);
946 struct phy_device *phy_find_first(struct mii_bus *bus);
947 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
948 u32 flags, phy_interface_t interface);
949 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
950 void (*handler)(struct net_device *),
951 phy_interface_t interface);
952 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
953 void (*handler)(struct net_device *),
954 phy_interface_t interface);
955 void phy_disconnect(struct phy_device *phydev);
956 void phy_detach(struct phy_device *phydev);
957 void phy_start(struct phy_device *phydev);
958 void phy_stop(struct phy_device *phydev);
959 int phy_start_aneg(struct phy_device *phydev);
960 int phy_aneg_done(struct phy_device *phydev);
961 int phy_speed_down(struct phy_device *phydev, bool sync);
962 int phy_speed_up(struct phy_device *phydev);
963
964 int phy_stop_interrupts(struct phy_device *phydev);
965 int phy_restart_aneg(struct phy_device *phydev);
966 int phy_reset_after_clk_enable(struct phy_device *phydev);
967
phy_device_reset(struct phy_device * phydev,int value)968 static inline void phy_device_reset(struct phy_device *phydev, int value)
969 {
970 mdio_device_reset(&phydev->mdio, value);
971 }
972
973 #define phydev_err(_phydev, format, args...) \
974 dev_err(&_phydev->mdio.dev, format, ##args)
975
976 #define phydev_dbg(_phydev, format, args...) \
977 dev_dbg(&_phydev->mdio.dev, format, ##args)
978
phydev_name(const struct phy_device * phydev)979 static inline const char *phydev_name(const struct phy_device *phydev)
980 {
981 return dev_name(&phydev->mdio.dev);
982 }
983
984 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
985 __printf(2, 3);
986 void phy_attached_info(struct phy_device *phydev);
987
988 /* Clause 22 PHY */
989 int genphy_config_init(struct phy_device *phydev);
990 int genphy_setup_forced(struct phy_device *phydev);
991 int genphy_restart_aneg(struct phy_device *phydev);
992 int genphy_config_aneg(struct phy_device *phydev);
993 int genphy_aneg_done(struct phy_device *phydev);
994 int genphy_update_link(struct phy_device *phydev);
995 int genphy_read_status(struct phy_device *phydev);
996 int genphy_suspend(struct phy_device *phydev);
997 int genphy_resume(struct phy_device *phydev);
998 int genphy_loopback(struct phy_device *phydev, bool enable);
999 int genphy_soft_reset(struct phy_device *phydev);
genphy_no_soft_reset(struct phy_device * phydev)1000 static inline int genphy_no_soft_reset(struct phy_device *phydev)
1001 {
1002 return 0;
1003 }
1004 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1005 u16 regnum);
1006 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1007 u16 regnum, u16 val);
1008
1009 /* Clause 45 PHY */
1010 int genphy_c45_restart_aneg(struct phy_device *phydev);
1011 int genphy_c45_aneg_done(struct phy_device *phydev);
1012 int genphy_c45_read_link(struct phy_device *phydev, u32 mmd_mask);
1013 int genphy_c45_read_lpa(struct phy_device *phydev);
1014 int genphy_c45_read_pma(struct phy_device *phydev);
1015 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1016 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1017 int genphy_c45_read_mdix(struct phy_device *phydev);
1018
1019 /* The gen10g_* functions are the old Clause 45 stub */
1020 int gen10g_config_aneg(struct phy_device *phydev);
1021 int gen10g_read_status(struct phy_device *phydev);
1022 int gen10g_no_soft_reset(struct phy_device *phydev);
1023 int gen10g_config_init(struct phy_device *phydev);
1024 int gen10g_suspend(struct phy_device *phydev);
1025 int gen10g_resume(struct phy_device *phydev);
1026
phy_read_status(struct phy_device * phydev)1027 static inline int phy_read_status(struct phy_device *phydev)
1028 {
1029 if (!phydev->drv)
1030 return -EIO;
1031
1032 if (phydev->drv->read_status)
1033 return phydev->drv->read_status(phydev);
1034 else
1035 return genphy_read_status(phydev);
1036 }
1037
1038 void phy_driver_unregister(struct phy_driver *drv);
1039 void phy_drivers_unregister(struct phy_driver *drv, int n);
1040 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1041 int phy_drivers_register(struct phy_driver *new_driver, int n,
1042 struct module *owner);
1043 void phy_state_machine(struct work_struct *work);
1044 void phy_change_work(struct work_struct *work);
1045 void phy_mac_interrupt(struct phy_device *phydev);
1046 void phy_start_machine(struct phy_device *phydev);
1047 void phy_stop_machine(struct phy_device *phydev);
1048 void phy_trigger_machine(struct phy_device *phydev, bool sync);
1049 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
1050 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1051 struct ethtool_link_ksettings *cmd);
1052 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1053 const struct ethtool_link_ksettings *cmd);
1054 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1055 int phy_start_interrupts(struct phy_device *phydev);
1056 void phy_print_status(struct phy_device *phydev);
1057 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1058
1059 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1060 int (*run)(struct phy_device *));
1061 int phy_register_fixup_for_id(const char *bus_id,
1062 int (*run)(struct phy_device *));
1063 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1064 int (*run)(struct phy_device *));
1065
1066 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1067 int phy_unregister_fixup_for_id(const char *bus_id);
1068 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1069
1070 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1071 int phy_get_eee_err(struct phy_device *phydev);
1072 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1073 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1074 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1075 void phy_ethtool_get_wol(struct phy_device *phydev,
1076 struct ethtool_wolinfo *wol);
1077 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1078 struct ethtool_link_ksettings *cmd);
1079 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1080 const struct ethtool_link_ksettings *cmd);
1081 int phy_ethtool_nway_reset(struct net_device *ndev);
1082
1083 #if IS_ENABLED(CONFIG_PHYLIB)
1084 int __init mdio_bus_init(void);
1085 void mdio_bus_exit(void);
1086 #endif
1087
1088 /* Inline function for use within net/core/ethtool.c (built-in) */
phy_ethtool_get_strings(struct phy_device * phydev,u8 * data)1089 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
1090 {
1091 if (!phydev->drv)
1092 return -EIO;
1093
1094 mutex_lock(&phydev->lock);
1095 phydev->drv->get_strings(phydev, data);
1096 mutex_unlock(&phydev->lock);
1097
1098 return 0;
1099 }
1100
phy_ethtool_get_sset_count(struct phy_device * phydev)1101 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev)
1102 {
1103 int ret;
1104
1105 if (!phydev->drv)
1106 return -EIO;
1107
1108 if (phydev->drv->get_sset_count &&
1109 phydev->drv->get_strings &&
1110 phydev->drv->get_stats) {
1111 mutex_lock(&phydev->lock);
1112 ret = phydev->drv->get_sset_count(phydev);
1113 mutex_unlock(&phydev->lock);
1114
1115 return ret;
1116 }
1117
1118 return -EOPNOTSUPP;
1119 }
1120
phy_ethtool_get_stats(struct phy_device * phydev,struct ethtool_stats * stats,u64 * data)1121 static inline int phy_ethtool_get_stats(struct phy_device *phydev,
1122 struct ethtool_stats *stats, u64 *data)
1123 {
1124 if (!phydev->drv)
1125 return -EIO;
1126
1127 mutex_lock(&phydev->lock);
1128 phydev->drv->get_stats(phydev, stats, data);
1129 mutex_unlock(&phydev->lock);
1130
1131 return 0;
1132 }
1133
1134 extern struct bus_type mdio_bus_type;
1135
1136 struct mdio_board_info {
1137 const char *bus_id;
1138 char modalias[MDIO_NAME_SIZE];
1139 int mdio_addr;
1140 const void *platform_data;
1141 };
1142
1143 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1144 int mdiobus_register_board_info(const struct mdio_board_info *info,
1145 unsigned int n);
1146 #else
mdiobus_register_board_info(const struct mdio_board_info * i,unsigned int n)1147 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1148 unsigned int n)
1149 {
1150 return 0;
1151 }
1152 #endif
1153
1154
1155 /**
1156 * module_phy_driver() - Helper macro for registering PHY drivers
1157 * @__phy_drivers: array of PHY drivers to register
1158 *
1159 * Helper macro for PHY drivers which do not do anything special in module
1160 * init/exit. Each module may only use this macro once, and calling it
1161 * replaces module_init() and module_exit().
1162 */
1163 #define phy_module_driver(__phy_drivers, __count) \
1164 static int __init phy_module_init(void) \
1165 { \
1166 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1167 } \
1168 module_init(phy_module_init); \
1169 static void __exit phy_module_exit(void) \
1170 { \
1171 phy_drivers_unregister(__phy_drivers, __count); \
1172 } \
1173 module_exit(phy_module_exit)
1174
1175 #define module_phy_driver(__phy_drivers) \
1176 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1177
1178 #endif /* __PHY_H */
1179