2 * Framework and drivers for configuring and reading different PHYs
3 * Based on code in sungem_phy.c and gianfar_phy.c
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
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.
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>
29 #include <linux/atomic.h>
31 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
35 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
36 SUPPORTED_10baseT_Full)
38 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
39 SUPPORTED_100baseT_Full)
41 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
42 SUPPORTED_1000baseT_Full)
44 #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
45 PHY_100BT_FEATURES | \
48 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
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
58 #define PHY_IGNORE_INTERRUPT -2
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
65 /* Interface Mode definitions */
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
,
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.
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.
105 unsigned int phy_supported_speeds(struct phy_device
*phy
,
106 unsigned int *speeds
,
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.
114 static inline const char *phy_modes(phy_interface_t interface
)
117 case PHY_INTERFACE_MODE_NA
:
119 case PHY_INTERFACE_MODE_INTERNAL
:
121 case PHY_INTERFACE_MODE_MII
:
123 case PHY_INTERFACE_MODE_GMII
:
125 case PHY_INTERFACE_MODE_SGMII
:
127 case PHY_INTERFACE_MODE_TBI
:
129 case PHY_INTERFACE_MODE_REVMII
:
131 case PHY_INTERFACE_MODE_RMII
:
133 case PHY_INTERFACE_MODE_RGMII
:
135 case PHY_INTERFACE_MODE_RGMII_ID
:
137 case PHY_INTERFACE_MODE_RGMII_RXID
:
139 case PHY_INTERFACE_MODE_RGMII_TXID
:
141 case PHY_INTERFACE_MODE_RTBI
:
143 case PHY_INTERFACE_MODE_SMII
:
145 case PHY_INTERFACE_MODE_XGMII
:
147 case PHY_INTERFACE_MODE_MOCA
:
149 case PHY_INTERFACE_MODE_QSGMII
:
151 case PHY_INTERFACE_MODE_TRGMII
:
153 case PHY_INTERFACE_MODE_1000BASEX
:
155 case PHY_INTERFACE_MODE_2500BASEX
:
157 case PHY_INTERFACE_MODE_RXAUI
:
159 case PHY_INTERFACE_MODE_XAUI
:
161 case PHY_INTERFACE_MODE_10GKR
:
169 #define PHY_INIT_TIMEOUT 100000
170 #define PHY_STATE_TIME 1
171 #define PHY_FORCE_TIMEOUT 10
172 #define PHY_AN_TIMEOUT 10
174 #define PHY_MAX_ADDR 32
176 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
177 #define PHY_ID_FMT "%s:%02x"
179 #define MII_BUS_ID_SIZE 61
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)
190 * The Bus class for PHYs. Devices which provide access to
191 * PHYs should register using this structure
194 struct module
*owner
;
196 char id
[MII_BUS_ID_SIZE
];
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
);
203 * A lock to ensure that only one thing can read/write
204 * the MDIO bus at a time
206 struct mutex mdio_lock
;
208 struct device
*parent
;
210 MDIOBUS_ALLOCATED
= 1,
212 MDIOBUS_UNREGISTERED
,
217 /* list of all PHYs on bus */
218 struct mdio_device
*mdio_map
[PHY_MAX_ADDR
];
220 /* PHY addresses to be ignored when probing */
223 /* PHY addresses to ignore the TA/read failure */
224 u32 phy_ignore_ta_mask
;
227 * An array of interrupts, each PHY's interrupt at the index
228 * matching its address
230 int irq
[PHY_MAX_ADDR
];
232 /* GPIO reset pulse width in microseconds */
234 /* RESET GPIO descriptor pointer */
235 struct gpio_desc
*reset_gpiod
;
237 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
239 struct mii_bus
*mdiobus_alloc_size(size_t);
240 static inline struct mii_bus
*mdiobus_alloc(void)
242 return mdiobus_alloc_size(0);
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
);
250 static inline struct mii_bus
*devm_mdiobus_alloc(struct device
*dev
)
252 return devm_mdiobus_alloc_size(dev
, 0);
255 void devm_mdiobus_free(struct device
*dev
, struct mii_bus
*bus
);
256 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
);
258 #define PHY_INTERRUPT_DISABLED 0x0
259 #define PHY_INTERRUPT_ENABLED 0x80000000
261 /* PHY state machine states:
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
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
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
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
287 * - PHY driver will set the state to UP when the PHY is ready
289 * UP: The PHY and attached device are ready to do work.
290 * Interrupts should be started here.
291 * - timer moves to AN
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.
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
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
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
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
331 * HALTED: PHY is up, but no polling or interrupts are done. Or
332 * PHY is in an error state.
334 * - phy_start moves to RESUMING
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
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.
361 struct phy_c45_device_ids
{
362 u32 devices_in_package
;
366 /* phy_device: An instance of a PHY
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 * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
377 * loopback_enabled: Set true if this phy has been loopbacked successfully.
378 * state: state of the PHY for management purposes
379 * dev_flags: Device-specific flags used by the PHY driver.
380 * link_timeout: The number of timer firings to wait before the
381 * giving up on the current attempt at acquiring a link
382 * irq: IRQ number of the PHY's interrupt (-1 if none)
383 * phy_timer: The timer for handling the state machine
384 * phy_queue: A work_queue for the phy_mac_interrupt
385 * attached_dev: The attached enet driver's device instance ptr
386 * adjust_link: Callback for the enet controller to respond to
387 * changes in the link state.
389 * speed, duplex, pause, supported, advertising, lp_advertising,
390 * and autoneg are used like in mii_if_info
392 * interrupts currently only supports enabled or disabled,
393 * but could be changed in the future to support enabling
394 * and disabling specific interrupts
396 * Contains some infrastructure for polling and interrupt
397 * handling, as well as handling shifts in PHY hardware state
400 struct mdio_device mdio
;
402 /* Information about the PHY type */
403 /* And management functions */
404 struct phy_driver
*drv
;
408 struct phy_c45_device_ids c45_ids
;
411 bool is_pseudo_fixed_link
;
415 bool loopback_enabled
;
417 enum phy_state state
;
421 phy_interface_t interface
;
424 * forced speed & duplex (no autoneg)
425 * partner speed & duplex & pause (autoneg)
432 /* The most recently read link state */
435 /* Enabled Interrupts */
438 /* Union of PHY and Attached devices' supported modes */
439 /* See mii.h for more info */
444 /* Energy efficient ethernet modes which should be prohibited */
445 u32 eee_broken_modes
;
451 #ifdef CONFIG_LED_TRIGGER_PHY
452 struct phy_led_trigger
*phy_led_triggers
;
453 unsigned int phy_num_led_triggers
;
454 struct phy_led_trigger
*last_triggered
;
456 struct phy_led_trigger
*led_link_trigger
;
460 * Interrupt number for this PHY
461 * -1 means no interrupt
465 /* private data pointer */
466 /* For use by PHYs to maintain extra state */
469 /* Interrupt and Polling infrastructure */
470 struct work_struct phy_queue
;
471 struct delayed_work state_queue
;
475 struct phylink
*phylink
;
476 struct net_device
*attached_dev
;
481 void (*phy_link_change
)(struct phy_device
*, bool up
, bool do_carrier
);
482 void (*adjust_link
)(struct net_device
*dev
);
484 #define to_phy_device(d) container_of(to_mdio_device(d), \
485 struct phy_device, mdio)
487 /* struct phy_driver: Driver structure for a particular PHY type
489 * driver_data: static driver data
490 * phy_id: The result of reading the UID registers of this PHY
491 * type, and ANDing them with the phy_id_mask. This driver
492 * only works for PHYs with IDs which match this field
493 * name: The friendly name of this PHY type
494 * phy_id_mask: Defines the important bits of the phy_id
495 * features: A list of features (speed, duplex, etc) supported
497 * flags: A bitfield defining certain other features this PHY
498 * supports (like interrupts)
500 * All functions are optional. If config_aneg or read_status
501 * are not implemented, the phy core uses the genphy versions.
502 * Note that none of these functions should be called from
503 * interrupt time. The goal is for the bus read/write functions
504 * to be able to block when the bus transaction is happening,
505 * and be freed up by an interrupt (The MPC85xx has this ability,
506 * though it is not currently supported in the driver).
509 struct mdio_driver_common mdiodrv
;
515 const void *driver_data
;
518 * Called to issue a PHY software reset
520 int (*soft_reset
)(struct phy_device
*phydev
);
523 * Called to initialize the PHY,
524 * including after a reset
526 int (*config_init
)(struct phy_device
*phydev
);
529 * Called during discovery. Used to set
530 * up device-specific structures, if any
532 int (*probe
)(struct phy_device
*phydev
);
534 /* PHY Power Management */
535 int (*suspend
)(struct phy_device
*phydev
);
536 int (*resume
)(struct phy_device
*phydev
);
539 * Configures the advertisement and resets
540 * autonegotiation if phydev->autoneg is on,
541 * forces the speed to the current settings in phydev
542 * if phydev->autoneg is off
544 int (*config_aneg
)(struct phy_device
*phydev
);
546 /* Determines the auto negotiation result */
547 int (*aneg_done
)(struct phy_device
*phydev
);
549 /* Determines the negotiated speed and duplex */
550 int (*read_status
)(struct phy_device
*phydev
);
552 /* Clears any pending interrupts */
553 int (*ack_interrupt
)(struct phy_device
*phydev
);
555 /* Enables or disables interrupts */
556 int (*config_intr
)(struct phy_device
*phydev
);
559 * Checks if the PHY generated an interrupt.
560 * For multi-PHY devices with shared PHY interrupt pin
562 int (*did_interrupt
)(struct phy_device
*phydev
);
564 /* Clears up any memory if needed */
565 void (*remove
)(struct phy_device
*phydev
);
567 /* Returns true if this is a suitable driver for the given
568 * phydev. If NULL, matching is based on phy_id and
571 int (*match_phy_device
)(struct phy_device
*phydev
);
573 /* Handles ethtool queries for hardware time stamping. */
574 int (*ts_info
)(struct phy_device
*phydev
, struct ethtool_ts_info
*ti
);
576 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
577 int (*hwtstamp
)(struct phy_device
*phydev
, struct ifreq
*ifr
);
580 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
581 * the phy driver promises to deliver it using netif_rx() as
582 * soon as a timestamp becomes available. One of the
583 * PTP_CLASS_ values is passed in 'type'. The function must
584 * return true if the skb is accepted for delivery.
586 bool (*rxtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
589 * Requests a Tx timestamp for 'skb'. The phy driver promises
590 * to deliver it using skb_complete_tx_timestamp() as soon as a
591 * timestamp becomes available. One of the PTP_CLASS_ values
592 * is passed in 'type'.
594 void (*txtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
596 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
597 * enable Wake on LAN, so set_wol is provided to be called in the
598 * ethernet driver's set_wol function. */
599 int (*set_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
601 /* See set_wol, but for checking whether Wake on LAN is enabled. */
602 void (*get_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
605 * Called to inform a PHY device driver when the core is about to
606 * change the link state. This callback is supposed to be used as
607 * fixup hook for drivers that need to take action when the link
608 * state changes. Drivers are by no means allowed to mess with the
609 * PHY device structure in their implementations.
611 void (*link_change_notify
)(struct phy_device
*dev
);
614 * Phy specific driver override for reading a MMD register.
615 * This function is optional for PHY specific drivers. When
616 * not provided, the default MMD read function will be used
617 * by phy_read_mmd(), which will use either a direct read for
618 * Clause 45 PHYs or an indirect read for Clause 22 PHYs.
619 * devnum is the MMD device number within the PHY device,
620 * regnum is the register within the selected MMD device.
622 int (*read_mmd
)(struct phy_device
*dev
, int devnum
, u16 regnum
);
625 * Phy specific driver override for writing a MMD register.
626 * This function is optional for PHY specific drivers. When
627 * not provided, the default MMD write function will be used
628 * by phy_write_mmd(), which will use either a direct write for
629 * Clause 45 PHYs, or an indirect write for Clause 22 PHYs.
630 * devnum is the MMD device number within the PHY device,
631 * regnum is the register within the selected MMD device.
632 * val is the value to be written.
634 int (*write_mmd
)(struct phy_device
*dev
, int devnum
, u16 regnum
,
637 int (*read_page
)(struct phy_device
*dev
);
638 int (*write_page
)(struct phy_device
*dev
, int page
);
640 /* Get the size and type of the eeprom contained within a plug-in
642 int (*module_info
)(struct phy_device
*dev
,
643 struct ethtool_modinfo
*modinfo
);
645 /* Get the eeprom information from the plug-in module */
646 int (*module_eeprom
)(struct phy_device
*dev
,
647 struct ethtool_eeprom
*ee
, u8
*data
);
649 /* Get statistics from the phy using ethtool */
650 int (*get_sset_count
)(struct phy_device
*dev
);
651 void (*get_strings
)(struct phy_device
*dev
, u8
*data
);
652 void (*get_stats
)(struct phy_device
*dev
,
653 struct ethtool_stats
*stats
, u64
*data
);
655 /* Get and Set PHY tunables */
656 int (*get_tunable
)(struct phy_device
*dev
,
657 struct ethtool_tunable
*tuna
, void *data
);
658 int (*set_tunable
)(struct phy_device
*dev
,
659 struct ethtool_tunable
*tuna
,
661 int (*set_loopback
)(struct phy_device
*dev
, bool enable
);
663 #define to_phy_driver(d) container_of(to_mdio_common_driver(d), \
664 struct phy_driver, mdiodrv)
666 #define PHY_ANY_ID "MATCH ANY PHY"
667 #define PHY_ANY_UID 0xffffffff
669 /* A Structure for boards to register fixups with the PHY Lib */
671 struct list_head list
;
672 char bus_id
[MII_BUS_ID_SIZE
+ 3];
675 int (*run
)(struct phy_device
*phydev
);
678 const char *phy_speed_to_str(int speed
);
679 const char *phy_duplex_to_str(unsigned int duplex
);
681 /* A structure for mapping a particular speed and duplex
682 * combination to a particular SUPPORTED and ADVERTISED value
690 const struct phy_setting
*
691 phy_lookup_setting(int speed
, int duplex
, const unsigned long *mask
,
692 size_t maxbit
, bool exact
);
693 size_t phy_speeds(unsigned int *speeds
, size_t size
,
694 unsigned long *mask
, size_t maxbit
);
696 void phy_resolve_aneg_linkmode(struct phy_device
*phydev
);
699 * phy_read_mmd - Convenience function for reading a register
700 * from an MMD on a given PHY.
701 * @phydev: The phy_device struct
702 * @devad: The MMD to read from
703 * @regnum: The register on the MMD to read
705 * Same rules as for phy_read();
707 int phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
);
710 * phy_read - Convenience function for reading a given PHY register
711 * @phydev: the phy_device struct
712 * @regnum: register number to read
714 * NOTE: MUST NOT be called from interrupt context,
715 * because the bus read/write functions may wait for an interrupt
716 * to conclude the operation.
718 static inline int phy_read(struct phy_device
*phydev
, u32 regnum
)
720 return mdiobus_read(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
);
724 * __phy_read - convenience function for reading a given PHY register
725 * @phydev: the phy_device struct
726 * @regnum: register number to read
728 * The caller must have taken the MDIO bus lock.
730 static inline int __phy_read(struct phy_device
*phydev
, u32 regnum
)
732 return __mdiobus_read(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
);
736 * phy_write - Convenience function for writing a given PHY register
737 * @phydev: the phy_device struct
738 * @regnum: register number to write
739 * @val: value to write to @regnum
741 * NOTE: MUST NOT be called from interrupt context,
742 * because the bus read/write functions may wait for an interrupt
743 * to conclude the operation.
745 static inline int phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
747 return mdiobus_write(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
, val
);
751 * __phy_write - Convenience function for writing a given PHY register
752 * @phydev: the phy_device struct
753 * @regnum: register number to write
754 * @val: value to write to @regnum
756 * The caller must have taken the MDIO bus lock.
758 static inline int __phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
760 return __mdiobus_write(phydev
->mdio
.bus
, phydev
->mdio
.addr
, regnum
,
764 int __phy_modify(struct phy_device
*phydev
, u32 regnum
, u16 mask
, u16 set
);
765 int phy_modify(struct phy_device
*phydev
, u32 regnum
, u16 mask
, u16 set
);
768 * __phy_set_bits - Convenience function for setting bits in a PHY register
769 * @phydev: the phy_device struct
770 * @regnum: register number to write
773 * The caller must have taken the MDIO bus lock.
775 static inline int __phy_set_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
777 return __phy_modify(phydev
, regnum
, 0, val
);
781 * __phy_clear_bits - Convenience function for clearing bits in a PHY register
782 * @phydev: the phy_device struct
783 * @regnum: register number to write
784 * @val: bits to clear
786 * The caller must have taken the MDIO bus lock.
788 static inline int __phy_clear_bits(struct phy_device
*phydev
, u32 regnum
,
791 return __phy_modify(phydev
, regnum
, val
, 0);
795 * phy_set_bits - Convenience function for setting bits in a PHY register
796 * @phydev: the phy_device struct
797 * @regnum: register number to write
800 static inline int phy_set_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
802 return phy_modify(phydev
, regnum
, 0, val
);
806 * phy_clear_bits - Convenience function for clearing bits in a PHY register
807 * @phydev: the phy_device struct
808 * @regnum: register number to write
809 * @val: bits to clear
811 static inline int phy_clear_bits(struct phy_device
*phydev
, u32 regnum
, u16 val
)
813 return phy_modify(phydev
, regnum
, val
, 0);
817 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
818 * @phydev: the phy_device struct
820 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
821 * PHY_IGNORE_INTERRUPT
823 static inline bool phy_interrupt_is_valid(struct phy_device
*phydev
)
825 return phydev
->irq
!= PHY_POLL
&& phydev
->irq
!= PHY_IGNORE_INTERRUPT
;
829 * phy_is_internal - Convenience function for testing if a PHY is internal
830 * @phydev: the phy_device struct
832 static inline bool phy_is_internal(struct phy_device
*phydev
)
834 return phydev
->is_internal
;
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
842 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode
)
844 return mode
>= PHY_INTERFACE_MODE_RGMII
&&
845 mode
<= PHY_INTERFACE_MODE_RGMII_TXID
;
849 * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
851 * @mode: one of &enum phy_interface_t
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)
856 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode
)
858 return mode
== PHY_INTERFACE_MODE_1000BASEX
||
859 mode
== PHY_INTERFACE_MODE_2500BASEX
;
863 * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
864 * is RGMII (all variants)
865 * @phydev: the phy_device struct
867 static inline bool phy_interface_is_rgmii(struct phy_device
*phydev
)
869 return phy_interface_mode_is_rgmii(phydev
->interface
);
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
877 static inline bool phy_is_pseudo_fixed_link(struct phy_device
*phydev
)
879 return phydev
->is_pseudo_fixed_link
;
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
890 * Same rules as for phy_write();
892 int phy_write_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
, u16 val
);
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
,
902 struct phy_device
*phy_device_create(struct mii_bus
*bus
, int addr
, int phy_id
,
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
);
911 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
)
916 static inline int phy_device_register(struct phy_device
*phy
)
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
);
947 int phy_stop_interrupts(struct phy_device
*phydev
);
948 int phy_restart_aneg(struct phy_device
*phydev
);
949 int phy_reset_after_clk_enable(struct phy_device
*phydev
);
951 static inline void phy_device_reset(struct phy_device
*phydev
, int value
)
953 mdio_device_reset(&phydev
->mdio
, value
);
956 #define phydev_err(_phydev, format, args...) \
957 dev_err(&_phydev->mdio.dev, format, ##args)
959 #define phydev_dbg(_phydev, format, args...) \
960 dev_dbg(&_phydev->mdio.dev, format, ##args)
962 static inline const char *phydev_name(const struct phy_device
*phydev
)
964 return dev_name(&phydev
->mdio
.dev
);
967 void phy_attached_print(struct phy_device
*phydev
, const char *fmt
, ...)
969 void phy_attached_info(struct phy_device
*phydev
);
972 int genphy_config_init(struct phy_device
*phydev
);
973 int genphy_setup_forced(struct phy_device
*phydev
);
974 int genphy_restart_aneg(struct phy_device
*phydev
);
975 int genphy_config_aneg(struct phy_device
*phydev
);
976 int genphy_aneg_done(struct phy_device
*phydev
);
977 int genphy_update_link(struct phy_device
*phydev
);
978 int genphy_read_status(struct phy_device
*phydev
);
979 int genphy_suspend(struct phy_device
*phydev
);
980 int genphy_resume(struct phy_device
*phydev
);
981 int genphy_loopback(struct phy_device
*phydev
, bool enable
);
982 int genphy_soft_reset(struct phy_device
*phydev
);
983 static inline int genphy_no_soft_reset(struct phy_device
*phydev
)
989 int genphy_c45_restart_aneg(struct phy_device
*phydev
);
990 int genphy_c45_aneg_done(struct phy_device
*phydev
);
991 int genphy_c45_read_link(struct phy_device
*phydev
, u32 mmd_mask
);
992 int genphy_c45_read_lpa(struct phy_device
*phydev
);
993 int genphy_c45_read_pma(struct phy_device
*phydev
);
994 int genphy_c45_pma_setup_forced(struct phy_device
*phydev
);
995 int genphy_c45_an_disable_aneg(struct phy_device
*phydev
);
996 int genphy_c45_read_mdix(struct phy_device
*phydev
);
998 static inline int phy_read_status(struct phy_device
*phydev
)
1003 if (phydev
->drv
->read_status
)
1004 return phydev
->drv
->read_status(phydev
);
1006 return genphy_read_status(phydev
);
1009 void phy_driver_unregister(struct phy_driver
*drv
);
1010 void phy_drivers_unregister(struct phy_driver
*drv
, int n
);
1011 int phy_driver_register(struct phy_driver
*new_driver
, struct module
*owner
);
1012 int phy_drivers_register(struct phy_driver
*new_driver
, int n
,
1013 struct module
*owner
);
1014 void phy_state_machine(struct work_struct
*work
);
1015 void phy_change(struct phy_device
*phydev
);
1016 void phy_change_work(struct work_struct
*work
);
1017 void phy_mac_interrupt(struct phy_device
*phydev
);
1018 void phy_start_machine(struct phy_device
*phydev
);
1019 void phy_stop_machine(struct phy_device
*phydev
);
1020 void phy_trigger_machine(struct phy_device
*phydev
, bool sync
);
1021 int phy_ethtool_sset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
1022 void phy_ethtool_ksettings_get(struct phy_device
*phydev
,
1023 struct ethtool_link_ksettings
*cmd
);
1024 int phy_ethtool_ksettings_set(struct phy_device
*phydev
,
1025 const struct ethtool_link_ksettings
*cmd
);
1026 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
);
1027 int phy_start_interrupts(struct phy_device
*phydev
);
1028 void phy_print_status(struct phy_device
*phydev
);
1029 int phy_set_max_speed(struct phy_device
*phydev
, u32 max_speed
);
1031 int phy_register_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
,
1032 int (*run
)(struct phy_device
*));
1033 int phy_register_fixup_for_id(const char *bus_id
,
1034 int (*run
)(struct phy_device
*));
1035 int phy_register_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
,
1036 int (*run
)(struct phy_device
*));
1038 int phy_unregister_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
);
1039 int phy_unregister_fixup_for_id(const char *bus_id
);
1040 int phy_unregister_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
);
1042 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
);
1043 int phy_get_eee_err(struct phy_device
*phydev
);
1044 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
1045 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
1046 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
);
1047 void phy_ethtool_get_wol(struct phy_device
*phydev
,
1048 struct ethtool_wolinfo
*wol
);
1049 int phy_ethtool_get_link_ksettings(struct net_device
*ndev
,
1050 struct ethtool_link_ksettings
*cmd
);
1051 int phy_ethtool_set_link_ksettings(struct net_device
*ndev
,
1052 const struct ethtool_link_ksettings
*cmd
);
1053 int phy_ethtool_nway_reset(struct net_device
*ndev
);
1055 #if IS_ENABLED(CONFIG_PHYLIB)
1056 int __init
mdio_bus_init(void);
1057 void mdio_bus_exit(void);
1060 extern struct bus_type mdio_bus_type
;
1062 struct mdio_board_info
{
1064 char modalias
[MDIO_NAME_SIZE
];
1066 const void *platform_data
;
1069 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1070 int mdiobus_register_board_info(const struct mdio_board_info
*info
,
1073 static inline int mdiobus_register_board_info(const struct mdio_board_info
*i
,
1082 * module_phy_driver() - Helper macro for registering PHY drivers
1083 * @__phy_drivers: array of PHY drivers to register
1085 * Helper macro for PHY drivers which do not do anything special in module
1086 * init/exit. Each module may only use this macro once, and calling it
1087 * replaces module_init() and module_exit().
1089 #define phy_module_driver(__phy_drivers, __count) \
1090 static int __init phy_module_init(void) \
1092 return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1094 module_init(phy_module_init); \
1095 static void __exit phy_module_exit(void) \
1097 phy_drivers_unregister(__phy_drivers, __count); \
1099 module_exit(phy_module_exit)
1101 #define module_phy_driver(__phy_drivers) \
1102 phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1104 #endif /* __PHY_H */