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/spinlock.h>
20 #include <linux/ethtool.h>
21 #include <linux/mii.h>
22 #include <linux/timer.h>
23 #include <linux/workqueue.h>
24 #include <linux/mod_devicetable.h>
26 #include <linux/atomic.h>
28 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
32 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
33 SUPPORTED_10baseT_Full)
35 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
36 SUPPORTED_100baseT_Full)
38 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
39 SUPPORTED_1000baseT_Full)
41 #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
42 PHY_100BT_FEATURES | \
45 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
50 * Set phydev->irq to PHY_POLL if interrupts are not supported,
51 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
52 * the attached driver handles the interrupt
55 #define PHY_IGNORE_INTERRUPT -2
57 #define PHY_HAS_INTERRUPT 0x00000001
58 #define PHY_HAS_MAGICANEG 0x00000002
59 #define PHY_IS_INTERNAL 0x00000004
61 /* Interface Mode definitions */
63 PHY_INTERFACE_MODE_NA
,
64 PHY_INTERFACE_MODE_MII
,
65 PHY_INTERFACE_MODE_GMII
,
66 PHY_INTERFACE_MODE_SGMII
,
67 PHY_INTERFACE_MODE_TBI
,
68 PHY_INTERFACE_MODE_REVMII
,
69 PHY_INTERFACE_MODE_RMII
,
70 PHY_INTERFACE_MODE_RGMII
,
71 PHY_INTERFACE_MODE_RGMII_ID
,
72 PHY_INTERFACE_MODE_RGMII_RXID
,
73 PHY_INTERFACE_MODE_RGMII_TXID
,
74 PHY_INTERFACE_MODE_RTBI
,
75 PHY_INTERFACE_MODE_SMII
,
76 PHY_INTERFACE_MODE_XGMII
,
77 PHY_INTERFACE_MODE_MOCA
,
78 PHY_INTERFACE_MODE_MAX
,
82 * It maps 'enum phy_interface_t' found in include/linux/phy.h
83 * into the device tree binding of 'phy-mode', so that Ethernet
84 * device driver can get phy interface from device tree.
86 static inline const char *phy_modes(phy_interface_t interface
)
89 case PHY_INTERFACE_MODE_NA
:
91 case PHY_INTERFACE_MODE_MII
:
93 case PHY_INTERFACE_MODE_GMII
:
95 case PHY_INTERFACE_MODE_SGMII
:
97 case PHY_INTERFACE_MODE_TBI
:
99 case PHY_INTERFACE_MODE_REVMII
:
101 case PHY_INTERFACE_MODE_RMII
:
103 case PHY_INTERFACE_MODE_RGMII
:
105 case PHY_INTERFACE_MODE_RGMII_ID
:
107 case PHY_INTERFACE_MODE_RGMII_RXID
:
109 case PHY_INTERFACE_MODE_RGMII_TXID
:
111 case PHY_INTERFACE_MODE_RTBI
:
113 case PHY_INTERFACE_MODE_SMII
:
115 case PHY_INTERFACE_MODE_XGMII
:
117 case PHY_INTERFACE_MODE_MOCA
:
125 #define PHY_INIT_TIMEOUT 100000
126 #define PHY_STATE_TIME 1
127 #define PHY_FORCE_TIMEOUT 10
128 #define PHY_AN_TIMEOUT 10
130 #define PHY_MAX_ADDR 32
132 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
133 #define PHY_ID_FMT "%s:%02x"
136 * Need to be a little smaller than phydev->dev.bus_id to leave room
139 #define MII_BUS_ID_SIZE (20 - 3)
141 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
142 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
143 #define MII_ADDR_C45 (1<<30)
149 * The Bus class for PHYs. Devices which provide access to
150 * PHYs should register using this structure
154 char id
[MII_BUS_ID_SIZE
];
156 int (*read
)(struct mii_bus
*bus
, int phy_id
, int regnum
);
157 int (*write
)(struct mii_bus
*bus
, int phy_id
, int regnum
, u16 val
);
158 int (*reset
)(struct mii_bus
*bus
);
161 * A lock to ensure that only one thing can read/write
162 * the MDIO bus at a time
164 struct mutex mdio_lock
;
166 struct device
*parent
;
168 MDIOBUS_ALLOCATED
= 1,
170 MDIOBUS_UNREGISTERED
,
175 /* list of all PHYs on bus */
176 struct phy_device
*phy_map
[PHY_MAX_ADDR
];
178 /* PHY addresses to be ignored when probing */
182 * Pointer to an array of interrupts, each PHY's
183 * interrupt at the index matching its address
187 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
189 struct mii_bus
*mdiobus_alloc_size(size_t);
190 static inline struct mii_bus
*mdiobus_alloc(void)
192 return mdiobus_alloc_size(0);
195 int mdiobus_register(struct mii_bus
*bus
);
196 void mdiobus_unregister(struct mii_bus
*bus
);
197 void mdiobus_free(struct mii_bus
*bus
);
198 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
);
199 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
200 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
203 #define PHY_INTERRUPT_DISABLED 0x0
204 #define PHY_INTERRUPT_ENABLED 0x80000000
206 /* PHY state machine states:
208 * DOWN: PHY device and driver are not ready for anything. probe
209 * should be called if and only if the PHY is in this state,
210 * given that the PHY device exists.
211 * - PHY driver probe function will, depending on the PHY, set
212 * the state to STARTING or READY
214 * STARTING: PHY device is coming up, and the ethernet driver is
215 * not ready. PHY drivers may set this in the probe function.
216 * If they do, they are responsible for making sure the state is
217 * eventually set to indicate whether the PHY is UP or READY,
218 * depending on the state when the PHY is done starting up.
219 * - PHY driver will set the state to READY
220 * - start will set the state to PENDING
222 * READY: PHY is ready to send and receive packets, but the
223 * controller is not. By default, PHYs which do not implement
224 * probe will be set to this state by phy_probe(). If the PHY
225 * driver knows the PHY is ready, and the PHY state is STARTING,
226 * then it sets this STATE.
227 * - start will set the state to UP
229 * PENDING: PHY device is coming up, but the ethernet driver is
230 * ready. phy_start will set this state if the PHY state is
232 * - PHY driver will set the state to UP when the PHY is ready
234 * UP: The PHY and attached device are ready to do work.
235 * Interrupts should be started here.
236 * - timer moves to AN
238 * AN: The PHY is currently negotiating the link state. Link is
239 * therefore down for now. phy_timer will set this state when it
240 * detects the state is UP. config_aneg will set this state
241 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
242 * - If autonegotiation finishes, but there's no link, it sets
243 * the state to NOLINK.
244 * - If aneg finishes with link, it sets the state to RUNNING,
245 * and calls adjust_link
246 * - If autonegotiation did not finish after an arbitrary amount
247 * of time, autonegotiation should be tried again if the PHY
248 * supports "magic" autonegotiation (back to AN)
249 * - If it didn't finish, and no magic_aneg, move to FORCING.
251 * NOLINK: PHY is up, but not currently plugged in.
252 * - If the timer notes that the link comes back, we move to RUNNING
253 * - config_aneg moves to AN
254 * - phy_stop moves to HALTED
256 * FORCING: PHY is being configured with forced settings
257 * - if link is up, move to RUNNING
258 * - If link is down, we drop to the next highest setting, and
259 * retry (FORCING) after a timeout
260 * - phy_stop moves to HALTED
262 * RUNNING: PHY is currently up, running, and possibly sending
263 * and/or receiving packets
264 * - timer will set CHANGELINK if we're polling (this ensures the
265 * link state is polled every other cycle of this state machine,
266 * which makes it every other second)
267 * - irq will set CHANGELINK
268 * - config_aneg will set AN
269 * - phy_stop moves to HALTED
271 * CHANGELINK: PHY experienced a change in link state
272 * - timer moves to RUNNING if link
273 * - timer moves to NOLINK if the link is down
274 * - phy_stop moves to HALTED
276 * HALTED: PHY is up, but no polling or interrupts are done. Or
277 * PHY is in an error state.
279 * - phy_start moves to RESUMING
281 * RESUMING: PHY was halted, but now wants to run again.
282 * - If we are forcing, or aneg is done, timer moves to RUNNING
283 * - If aneg is not done, timer moves to AN
284 * - phy_stop moves to HALTED
302 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
303 * @devices_in_package: Bit vector of devices present.
304 * @device_ids: The device identifer for each present device.
306 struct phy_c45_device_ids
{
307 u32 devices_in_package
;
311 /* phy_device: An instance of a PHY
313 * drv: Pointer to the driver for this PHY instance
314 * bus: Pointer to the bus this PHY is on
315 * dev: driver model device structure for this PHY
316 * phy_id: UID for this device found during discovery
317 * c45_ids: 802.3-c45 Device Identifers if is_c45.
318 * is_c45: Set to true if this phy uses clause 45 addressing.
319 * is_internal: Set to true if this phy is internal to a MAC.
320 * state: state of the PHY for management purposes
321 * dev_flags: Device-specific flags used by the PHY driver.
322 * addr: Bus address of PHY
323 * link_timeout: The number of timer firings to wait before the
324 * giving up on the current attempt at acquiring a link
325 * irq: IRQ number of the PHY's interrupt (-1 if none)
326 * phy_timer: The timer for handling the state machine
327 * phy_queue: A work_queue for the interrupt
328 * attached_dev: The attached enet driver's device instance ptr
329 * adjust_link: Callback for the enet controller to respond to
330 * changes in the link state.
332 * speed, duplex, pause, supported, advertising, lp_advertising,
333 * and autoneg are used like in mii_if_info
335 * interrupts currently only supports enabled or disabled,
336 * but could be changed in the future to support enabling
337 * and disabling specific interrupts
339 * Contains some infrastructure for polling and interrupt
340 * handling, as well as handling shifts in PHY hardware state
343 /* Information about the PHY type */
344 /* And management functions */
345 struct phy_driver
*drv
;
353 struct phy_c45_device_ids c45_ids
;
358 enum phy_state state
;
362 phy_interface_t interface
;
364 /* Bus address of the PHY (0-31) */
368 * forced speed & duplex (no autoneg)
369 * partner speed & duplex & pause (autoneg)
376 /* The most recently read link state */
379 /* Enabled Interrupts */
382 /* Union of PHY and Attached devices' supported modes */
383 /* See mii.h for more info */
393 * Interrupt number for this PHY
394 * -1 means no interrupt
398 /* private data pointer */
399 /* For use by PHYs to maintain extra state */
402 /* Interrupt and Polling infrastructure */
403 struct work_struct phy_queue
;
404 struct delayed_work state_queue
;
405 atomic_t irq_disable
;
409 struct net_device
*attached_dev
;
411 void (*adjust_link
)(struct net_device
*dev
);
413 #define to_phy_device(d) container_of(d, struct phy_device, dev)
415 /* struct phy_driver: Driver structure for a particular PHY type
417 * phy_id: The result of reading the UID registers of this PHY
418 * type, and ANDing them with the phy_id_mask. This driver
419 * only works for PHYs with IDs which match this field
420 * name: The friendly name of this PHY type
421 * phy_id_mask: Defines the important bits of the phy_id
422 * features: A list of features (speed, duplex, etc) supported
424 * flags: A bitfield defining certain other features this PHY
425 * supports (like interrupts)
427 * The drivers must implement config_aneg and read_status. All
428 * other functions are optional. Note that none of these
429 * functions should be called from interrupt time. The goal is
430 * for the bus read/write functions to be able to block when the
431 * bus transaction is happening, and be freed up by an interrupt
432 * (The MPC85xx has this ability, though it is not currently
433 * supported in the driver).
438 unsigned int phy_id_mask
;
443 * Called to issue a PHY software reset
445 int (*soft_reset
)(struct phy_device
*phydev
);
448 * Called to initialize the PHY,
449 * including after a reset
451 int (*config_init
)(struct phy_device
*phydev
);
454 * Called during discovery. Used to set
455 * up device-specific structures, if any
457 int (*probe
)(struct phy_device
*phydev
);
459 /* PHY Power Management */
460 int (*suspend
)(struct phy_device
*phydev
);
461 int (*resume
)(struct phy_device
*phydev
);
464 * Configures the advertisement and resets
465 * autonegotiation if phydev->autoneg is on,
466 * forces the speed to the current settings in phydev
467 * if phydev->autoneg is off
469 int (*config_aneg
)(struct phy_device
*phydev
);
471 /* Determines the auto negotiation result */
472 int (*aneg_done
)(struct phy_device
*phydev
);
474 /* Determines the negotiated speed and duplex */
475 int (*read_status
)(struct phy_device
*phydev
);
477 /* Clears any pending interrupts */
478 int (*ack_interrupt
)(struct phy_device
*phydev
);
480 /* Enables or disables interrupts */
481 int (*config_intr
)(struct phy_device
*phydev
);
484 * Checks if the PHY generated an interrupt.
485 * For multi-PHY devices with shared PHY interrupt pin
487 int (*did_interrupt
)(struct phy_device
*phydev
);
489 /* Clears up any memory if needed */
490 void (*remove
)(struct phy_device
*phydev
);
492 /* Returns true if this is a suitable driver for the given
493 * phydev. If NULL, matching is based on phy_id and
496 int (*match_phy_device
)(struct phy_device
*phydev
);
498 /* Handles ethtool queries for hardware time stamping. */
499 int (*ts_info
)(struct phy_device
*phydev
, struct ethtool_ts_info
*ti
);
501 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
502 int (*hwtstamp
)(struct phy_device
*phydev
, struct ifreq
*ifr
);
505 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
506 * the phy driver promises to deliver it using netif_rx() as
507 * soon as a timestamp becomes available. One of the
508 * PTP_CLASS_ values is passed in 'type'. The function must
509 * return true if the skb is accepted for delivery.
511 bool (*rxtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
514 * Requests a Tx timestamp for 'skb'. The phy driver promises
515 * to deliver it using skb_complete_tx_timestamp() as soon as a
516 * timestamp becomes available. One of the PTP_CLASS_ values
517 * is passed in 'type'.
519 void (*txtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
521 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
522 * enable Wake on LAN, so set_wol is provided to be called in the
523 * ethernet driver's set_wol function. */
524 int (*set_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
526 /* See set_wol, but for checking whether Wake on LAN is enabled. */
527 void (*get_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
529 struct device_driver driver
;
531 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
533 #define PHY_ANY_ID "MATCH ANY PHY"
534 #define PHY_ANY_UID 0xffffffff
536 /* A Structure for boards to register fixups with the PHY Lib */
538 struct list_head list
;
542 int (*run
)(struct phy_device
*phydev
);
546 * phy_read_mmd - Convenience function for reading a register
547 * from an MMD on a given PHY.
548 * @phydev: The phy_device struct
549 * @devad: The MMD to read from
550 * @regnum: The register on the MMD to read
552 * Same rules as for phy_read();
554 static inline int phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
)
559 return mdiobus_read(phydev
->bus
, phydev
->addr
,
560 MII_ADDR_C45
| (devad
<< 16) | (regnum
& 0xffff));
564 * phy_read - Convenience function for reading a given PHY register
565 * @phydev: the phy_device struct
566 * @regnum: register number to read
568 * NOTE: MUST NOT be called from interrupt context,
569 * because the bus read/write functions may wait for an interrupt
570 * to conclude the operation.
572 static inline int phy_read(struct phy_device
*phydev
, u32 regnum
)
574 return mdiobus_read(phydev
->bus
, phydev
->addr
, regnum
);
578 * phy_write - Convenience function for writing a given PHY register
579 * @phydev: the phy_device struct
580 * @regnum: register number to write
581 * @val: value to write to @regnum
583 * NOTE: MUST NOT be called from interrupt context,
584 * because the bus read/write functions may wait for an interrupt
585 * to conclude the operation.
587 static inline int phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
589 return mdiobus_write(phydev
->bus
, phydev
->addr
, regnum
, val
);
593 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
594 * @phydev: the phy_device struct
596 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
597 * PHY_IGNORE_INTERRUPT
599 static inline bool phy_interrupt_is_valid(struct phy_device
*phydev
)
601 return phydev
->irq
!= PHY_POLL
&& phydev
->irq
!= PHY_IGNORE_INTERRUPT
;
605 * phy_is_internal - Convenience function for testing if a PHY is internal
606 * @phydev: the phy_device struct
608 static inline bool phy_is_internal(struct phy_device
*phydev
)
610 return phydev
->is_internal
;
614 * phy_write_mmd - Convenience function for writing a register
615 * on an MMD on a given PHY.
616 * @phydev: The phy_device struct
617 * @devad: The MMD to read from
618 * @regnum: The register on the MMD to read
619 * @val: value to write to @regnum
621 * Same rules as for phy_write();
623 static inline int phy_write_mmd(struct phy_device
*phydev
, int devad
,
629 regnum
= MII_ADDR_C45
| ((devad
& 0x1f) << 16) | (regnum
& 0xffff);
631 return mdiobus_write(phydev
->bus
, phydev
->addr
, regnum
, val
);
634 struct phy_device
*phy_device_create(struct mii_bus
*bus
, int addr
, int phy_id
,
636 struct phy_c45_device_ids
*c45_ids
);
637 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
);
638 int phy_device_register(struct phy_device
*phy
);
639 int phy_init_hw(struct phy_device
*phydev
);
640 int phy_suspend(struct phy_device
*phydev
);
641 int phy_resume(struct phy_device
*phydev
);
642 struct phy_device
*phy_attach(struct net_device
*dev
, const char *bus_id
,
643 phy_interface_t interface
);
644 struct phy_device
*phy_find_first(struct mii_bus
*bus
);
645 int phy_attach_direct(struct net_device
*dev
, struct phy_device
*phydev
,
646 u32 flags
, phy_interface_t interface
);
647 int phy_connect_direct(struct net_device
*dev
, struct phy_device
*phydev
,
648 void (*handler
)(struct net_device
*),
649 phy_interface_t interface
);
650 struct phy_device
*phy_connect(struct net_device
*dev
, const char *bus_id
,
651 void (*handler
)(struct net_device
*),
652 phy_interface_t interface
);
653 void phy_disconnect(struct phy_device
*phydev
);
654 void phy_detach(struct phy_device
*phydev
);
655 void phy_start(struct phy_device
*phydev
);
656 void phy_stop(struct phy_device
*phydev
);
657 int phy_start_aneg(struct phy_device
*phydev
);
659 int phy_stop_interrupts(struct phy_device
*phydev
);
661 static inline int phy_read_status(struct phy_device
*phydev
)
663 return phydev
->drv
->read_status(phydev
);
666 int genphy_setup_forced(struct phy_device
*phydev
);
667 int genphy_restart_aneg(struct phy_device
*phydev
);
668 int genphy_config_aneg(struct phy_device
*phydev
);
669 int genphy_aneg_done(struct phy_device
*phydev
);
670 int genphy_update_link(struct phy_device
*phydev
);
671 int genphy_read_status(struct phy_device
*phydev
);
672 int genphy_suspend(struct phy_device
*phydev
);
673 int genphy_resume(struct phy_device
*phydev
);
674 int genphy_soft_reset(struct phy_device
*phydev
);
675 void phy_driver_unregister(struct phy_driver
*drv
);
676 void phy_drivers_unregister(struct phy_driver
*drv
, int n
);
677 int phy_driver_register(struct phy_driver
*new_driver
);
678 int phy_drivers_register(struct phy_driver
*new_driver
, int n
);
679 void phy_state_machine(struct work_struct
*work
);
680 void phy_change(struct work_struct
*work
);
681 void phy_mac_interrupt(struct phy_device
*phydev
, int new_link
);
682 void phy_start_machine(struct phy_device
*phydev
);
683 void phy_stop_machine(struct phy_device
*phydev
);
684 int phy_ethtool_sset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
685 int phy_ethtool_gset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
686 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
);
687 int phy_start_interrupts(struct phy_device
*phydev
);
688 void phy_print_status(struct phy_device
*phydev
);
689 void phy_device_free(struct phy_device
*phydev
);
691 int phy_register_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
,
692 int (*run
)(struct phy_device
*));
693 int phy_register_fixup_for_id(const char *bus_id
,
694 int (*run
)(struct phy_device
*));
695 int phy_register_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
,
696 int (*run
)(struct phy_device
*));
698 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
);
699 int phy_get_eee_err(struct phy_device
*phydev
);
700 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
701 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
702 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
);
703 void phy_ethtool_get_wol(struct phy_device
*phydev
,
704 struct ethtool_wolinfo
*wol
);
706 int __init
mdio_bus_init(void);
707 void mdio_bus_exit(void);
709 extern struct bus_type mdio_bus_type
;