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_QSGMII,
79 PHY_INTERFACE_MODE_MAX,
83 * It maps 'enum phy_interface_t' found in include/linux/phy.h
84 * into the device tree binding of 'phy-mode', so that Ethernet
85 * device driver can get phy interface from device tree.
87 static inline const char *phy_modes(phy_interface_t interface)
90 case PHY_INTERFACE_MODE_NA:
92 case PHY_INTERFACE_MODE_MII:
94 case PHY_INTERFACE_MODE_GMII:
96 case PHY_INTERFACE_MODE_SGMII:
98 case PHY_INTERFACE_MODE_TBI:
100 case PHY_INTERFACE_MODE_REVMII:
102 case PHY_INTERFACE_MODE_RMII:
104 case PHY_INTERFACE_MODE_RGMII:
106 case PHY_INTERFACE_MODE_RGMII_ID:
108 case PHY_INTERFACE_MODE_RGMII_RXID:
110 case PHY_INTERFACE_MODE_RGMII_TXID:
112 case PHY_INTERFACE_MODE_RTBI:
114 case PHY_INTERFACE_MODE_SMII:
116 case PHY_INTERFACE_MODE_XGMII:
118 case PHY_INTERFACE_MODE_MOCA:
120 case PHY_INTERFACE_MODE_QSGMII:
128 #define PHY_INIT_TIMEOUT 100000
129 #define PHY_STATE_TIME 1
130 #define PHY_FORCE_TIMEOUT 10
131 #define PHY_AN_TIMEOUT 10
133 #define PHY_MAX_ADDR 32
135 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
136 #define PHY_ID_FMT "%s:%02x"
139 * Need to be a little smaller than phydev->dev.bus_id to leave room
142 #define MII_BUS_ID_SIZE (20 - 3)
144 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
145 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
146 #define MII_ADDR_C45 (1<<30)
152 * The Bus class for PHYs. Devices which provide access to
153 * PHYs should register using this structure
157 char id[MII_BUS_ID_SIZE];
159 int (*read)(struct mii_bus *bus, int phy_id, int regnum);
160 int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
161 int (*reset)(struct mii_bus *bus);
164 * A lock to ensure that only one thing can read/write
165 * the MDIO bus at a time
167 struct mutex mdio_lock;
169 struct device *parent;
171 MDIOBUS_ALLOCATED = 1,
173 MDIOBUS_UNREGISTERED,
178 /* list of all PHYs on bus */
179 struct phy_device *phy_map[PHY_MAX_ADDR];
181 /* PHY addresses to be ignored when probing */
185 * Pointer to an array of interrupts, each PHY's
186 * interrupt at the index matching its address
190 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
192 struct mii_bus *mdiobus_alloc_size(size_t);
193 static inline struct mii_bus *mdiobus_alloc(void)
195 return mdiobus_alloc_size(0);
198 int mdiobus_register(struct mii_bus *bus);
199 void mdiobus_unregister(struct mii_bus *bus);
200 void mdiobus_free(struct mii_bus *bus);
201 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
202 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
203 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
206 #define PHY_INTERRUPT_DISABLED 0x0
207 #define PHY_INTERRUPT_ENABLED 0x80000000
209 /* PHY state machine states:
211 * DOWN: PHY device and driver are not ready for anything. probe
212 * should be called if and only if the PHY is in this state,
213 * given that the PHY device exists.
214 * - PHY driver probe function will, depending on the PHY, set
215 * the state to STARTING or READY
217 * STARTING: PHY device is coming up, and the ethernet driver is
218 * not ready. PHY drivers may set this in the probe function.
219 * If they do, they are responsible for making sure the state is
220 * eventually set to indicate whether the PHY is UP or READY,
221 * depending on the state when the PHY is done starting up.
222 * - PHY driver will set the state to READY
223 * - start will set the state to PENDING
225 * READY: PHY is ready to send and receive packets, but the
226 * controller is not. By default, PHYs which do not implement
227 * probe will be set to this state by phy_probe(). If the PHY
228 * driver knows the PHY is ready, and the PHY state is STARTING,
229 * then it sets this STATE.
230 * - start will set the state to UP
232 * PENDING: PHY device is coming up, but the ethernet driver is
233 * ready. phy_start will set this state if the PHY state is
235 * - PHY driver will set the state to UP when the PHY is ready
237 * UP: The PHY and attached device are ready to do work.
238 * Interrupts should be started here.
239 * - timer moves to AN
241 * AN: The PHY is currently negotiating the link state. Link is
242 * therefore down for now. phy_timer will set this state when it
243 * detects the state is UP. config_aneg will set this state
244 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
245 * - If autonegotiation finishes, but there's no link, it sets
246 * the state to NOLINK.
247 * - If aneg finishes with link, it sets the state to RUNNING,
248 * and calls adjust_link
249 * - If autonegotiation did not finish after an arbitrary amount
250 * of time, autonegotiation should be tried again if the PHY
251 * supports "magic" autonegotiation (back to AN)
252 * - If it didn't finish, and no magic_aneg, move to FORCING.
254 * NOLINK: PHY is up, but not currently plugged in.
255 * - If the timer notes that the link comes back, we move to RUNNING
256 * - config_aneg moves to AN
257 * - phy_stop moves to HALTED
259 * FORCING: PHY is being configured with forced settings
260 * - if link is up, move to RUNNING
261 * - If link is down, we drop to the next highest setting, and
262 * retry (FORCING) after a timeout
263 * - phy_stop moves to HALTED
265 * RUNNING: PHY is currently up, running, and possibly sending
266 * and/or receiving packets
267 * - timer will set CHANGELINK if we're polling (this ensures the
268 * link state is polled every other cycle of this state machine,
269 * which makes it every other second)
270 * - irq will set CHANGELINK
271 * - config_aneg will set AN
272 * - phy_stop moves to HALTED
274 * CHANGELINK: PHY experienced a change in link state
275 * - timer moves to RUNNING if link
276 * - timer moves to NOLINK if the link is down
277 * - phy_stop moves to HALTED
279 * HALTED: PHY is up, but no polling or interrupts are done. Or
280 * PHY is in an error state.
282 * - phy_start moves to RESUMING
284 * RESUMING: PHY was halted, but now wants to run again.
285 * - If we are forcing, or aneg is done, timer moves to RUNNING
286 * - If aneg is not done, timer moves to AN
287 * - phy_stop moves to HALTED
305 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
306 * @devices_in_package: Bit vector of devices present.
307 * @device_ids: The device identifer for each present device.
309 struct phy_c45_device_ids {
310 u32 devices_in_package;
314 /* phy_device: An instance of a PHY
316 * drv: Pointer to the driver for this PHY instance
317 * bus: Pointer to the bus this PHY is on
318 * dev: driver model device structure for this PHY
319 * phy_id: UID for this device found during discovery
320 * c45_ids: 802.3-c45 Device Identifers if is_c45.
321 * is_c45: Set to true if this phy uses clause 45 addressing.
322 * is_internal: Set to true if this phy is internal to a MAC.
323 * state: state of the PHY for management purposes
324 * dev_flags: Device-specific flags used by the PHY driver.
325 * addr: Bus address of PHY
326 * link_timeout: The number of timer firings to wait before the
327 * giving up on the current attempt at acquiring a link
328 * irq: IRQ number of the PHY's interrupt (-1 if none)
329 * phy_timer: The timer for handling the state machine
330 * phy_queue: A work_queue for the interrupt
331 * attached_dev: The attached enet driver's device instance ptr
332 * adjust_link: Callback for the enet controller to respond to
333 * changes in the link state.
335 * speed, duplex, pause, supported, advertising, lp_advertising,
336 * and autoneg are used like in mii_if_info
338 * interrupts currently only supports enabled or disabled,
339 * but could be changed in the future to support enabling
340 * and disabling specific interrupts
342 * Contains some infrastructure for polling and interrupt
343 * handling, as well as handling shifts in PHY hardware state
346 /* Information about the PHY type */
347 /* And management functions */
348 struct phy_driver *drv;
356 struct phy_c45_device_ids c45_ids;
361 enum phy_state state;
365 phy_interface_t interface;
367 /* Bus address of the PHY (0-31) */
371 * forced speed & duplex (no autoneg)
372 * partner speed & duplex & pause (autoneg)
379 /* The most recently read link state */
382 /* Enabled Interrupts */
385 /* Union of PHY and Attached devices' supported modes */
386 /* See mii.h for more info */
396 * Interrupt number for this PHY
397 * -1 means no interrupt
401 /* private data pointer */
402 /* For use by PHYs to maintain extra state */
405 /* Interrupt and Polling infrastructure */
406 struct work_struct phy_queue;
407 struct delayed_work state_queue;
408 atomic_t irq_disable;
412 struct net_device *attached_dev;
414 void (*adjust_link)(struct net_device *dev);
416 #define to_phy_device(d) container_of(d, struct phy_device, dev)
418 /* struct phy_driver: Driver structure for a particular PHY type
420 * phy_id: The result of reading the UID registers of this PHY
421 * type, and ANDing them with the phy_id_mask. This driver
422 * only works for PHYs with IDs which match this field
423 * name: The friendly name of this PHY type
424 * phy_id_mask: Defines the important bits of the phy_id
425 * features: A list of features (speed, duplex, etc) supported
427 * flags: A bitfield defining certain other features this PHY
428 * supports (like interrupts)
430 * The drivers must implement config_aneg and read_status. All
431 * other functions are optional. Note that none of these
432 * functions should be called from interrupt time. The goal is
433 * for the bus read/write functions to be able to block when the
434 * bus transaction is happening, and be freed up by an interrupt
435 * (The MPC85xx has this ability, though it is not currently
436 * supported in the driver).
441 unsigned int phy_id_mask;
446 * Called to issue a PHY software reset
448 int (*soft_reset)(struct phy_device *phydev);
451 * Called to initialize the PHY,
452 * including after a reset
454 int (*config_init)(struct phy_device *phydev);
457 * Called during discovery. Used to set
458 * up device-specific structures, if any
460 int (*probe)(struct phy_device *phydev);
462 /* PHY Power Management */
463 int (*suspend)(struct phy_device *phydev);
464 int (*resume)(struct phy_device *phydev);
467 * Configures the advertisement and resets
468 * autonegotiation if phydev->autoneg is on,
469 * forces the speed to the current settings in phydev
470 * if phydev->autoneg is off
472 int (*config_aneg)(struct phy_device *phydev);
474 /* Determines the auto negotiation result */
475 int (*aneg_done)(struct phy_device *phydev);
477 /* Determines the negotiated speed and duplex */
478 int (*read_status)(struct phy_device *phydev);
480 /* Clears any pending interrupts */
481 int (*ack_interrupt)(struct phy_device *phydev);
483 /* Enables or disables interrupts */
484 int (*config_intr)(struct phy_device *phydev);
487 * Checks if the PHY generated an interrupt.
488 * For multi-PHY devices with shared PHY interrupt pin
490 int (*did_interrupt)(struct phy_device *phydev);
492 /* Clears up any memory if needed */
493 void (*remove)(struct phy_device *phydev);
495 /* Returns true if this is a suitable driver for the given
496 * phydev. If NULL, matching is based on phy_id and
499 int (*match_phy_device)(struct phy_device *phydev);
501 /* Handles ethtool queries for hardware time stamping. */
502 int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
504 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
505 int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
508 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
509 * the phy driver promises to deliver it using netif_rx() as
510 * soon as a timestamp becomes available. One of the
511 * PTP_CLASS_ values is passed in 'type'. The function must
512 * return true if the skb is accepted for delivery.
514 bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
517 * Requests a Tx timestamp for 'skb'. The phy driver promises
518 * to deliver it using skb_complete_tx_timestamp() as soon as a
519 * timestamp becomes available. One of the PTP_CLASS_ values
520 * is passed in 'type'.
522 void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
524 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
525 * enable Wake on LAN, so set_wol is provided to be called in the
526 * ethernet driver's set_wol function. */
527 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
529 /* See set_wol, but for checking whether Wake on LAN is enabled. */
530 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
532 struct device_driver driver;
534 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
536 #define PHY_ANY_ID "MATCH ANY PHY"
537 #define PHY_ANY_UID 0xffffffff
539 /* A Structure for boards to register fixups with the PHY Lib */
541 struct list_head list;
545 int (*run)(struct phy_device *phydev);
549 * phy_read_mmd - Convenience function for reading a register
550 * from an MMD on a given PHY.
551 * @phydev: The phy_device struct
552 * @devad: The MMD to read from
553 * @regnum: The register on the MMD to read
555 * Same rules as for phy_read();
557 static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
562 return mdiobus_read(phydev->bus, phydev->addr,
563 MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
567 * phy_read - Convenience function for reading a given PHY register
568 * @phydev: the phy_device struct
569 * @regnum: register number to read
571 * NOTE: MUST NOT be called from interrupt context,
572 * because the bus read/write functions may wait for an interrupt
573 * to conclude the operation.
575 static inline int phy_read(struct phy_device *phydev, u32 regnum)
577 return mdiobus_read(phydev->bus, phydev->addr, regnum);
581 * phy_write - Convenience function for writing a given PHY register
582 * @phydev: the phy_device struct
583 * @regnum: register number to write
584 * @val: value to write to @regnum
586 * NOTE: MUST NOT be called from interrupt context,
587 * because the bus read/write functions may wait for an interrupt
588 * to conclude the operation.
590 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
592 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
596 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
597 * @phydev: the phy_device struct
599 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
600 * PHY_IGNORE_INTERRUPT
602 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
604 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
608 * phy_is_internal - Convenience function for testing if a PHY is internal
609 * @phydev: the phy_device struct
611 static inline bool phy_is_internal(struct phy_device *phydev)
613 return phydev->is_internal;
617 * phy_write_mmd - Convenience function for writing a register
618 * on an MMD on a given PHY.
619 * @phydev: The phy_device struct
620 * @devad: The MMD to read from
621 * @regnum: The register on the MMD to read
622 * @val: value to write to @regnum
624 * Same rules as for phy_write();
626 static inline int phy_write_mmd(struct phy_device *phydev, int devad,
632 regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
634 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
637 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
639 struct phy_c45_device_ids *c45_ids);
640 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
641 int phy_device_register(struct phy_device *phy);
642 int phy_init_hw(struct phy_device *phydev);
643 int phy_suspend(struct phy_device *phydev);
644 int phy_resume(struct phy_device *phydev);
645 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
646 phy_interface_t interface);
647 struct phy_device *phy_find_first(struct mii_bus *bus);
648 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
649 u32 flags, phy_interface_t interface);
650 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
651 void (*handler)(struct net_device *),
652 phy_interface_t interface);
653 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
654 void (*handler)(struct net_device *),
655 phy_interface_t interface);
656 void phy_disconnect(struct phy_device *phydev);
657 void phy_detach(struct phy_device *phydev);
658 void phy_start(struct phy_device *phydev);
659 void phy_stop(struct phy_device *phydev);
660 int phy_start_aneg(struct phy_device *phydev);
662 int phy_stop_interrupts(struct phy_device *phydev);
664 static inline int phy_read_status(struct phy_device *phydev)
666 return phydev->drv->read_status(phydev);
669 int genphy_setup_forced(struct phy_device *phydev);
670 int genphy_restart_aneg(struct phy_device *phydev);
671 int genphy_config_aneg(struct phy_device *phydev);
672 int genphy_aneg_done(struct phy_device *phydev);
673 int genphy_update_link(struct phy_device *phydev);
674 int genphy_read_status(struct phy_device *phydev);
675 int genphy_suspend(struct phy_device *phydev);
676 int genphy_resume(struct phy_device *phydev);
677 int genphy_soft_reset(struct phy_device *phydev);
678 void phy_driver_unregister(struct phy_driver *drv);
679 void phy_drivers_unregister(struct phy_driver *drv, int n);
680 int phy_driver_register(struct phy_driver *new_driver);
681 int phy_drivers_register(struct phy_driver *new_driver, int n);
682 void phy_state_machine(struct work_struct *work);
683 void phy_change(struct work_struct *work);
684 void phy_mac_interrupt(struct phy_device *phydev, int new_link);
685 void phy_start_machine(struct phy_device *phydev);
686 void phy_stop_machine(struct phy_device *phydev);
687 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
688 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
689 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
690 int phy_start_interrupts(struct phy_device *phydev);
691 void phy_print_status(struct phy_device *phydev);
692 void phy_device_free(struct phy_device *phydev);
694 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
695 int (*run)(struct phy_device *));
696 int phy_register_fixup_for_id(const char *bus_id,
697 int (*run)(struct phy_device *));
698 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
699 int (*run)(struct phy_device *));
701 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
702 int phy_get_eee_err(struct phy_device *phydev);
703 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
704 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
705 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
706 void phy_ethtool_get_wol(struct phy_device *phydev,
707 struct ethtool_wolinfo *wol);
709 int __init mdio_bus_init(void);
710 void mdio_bus_exit(void);
712 extern struct bus_type mdio_bus_type;