4 * Framework and drivers for configuring and reading different PHYs
5 * Based on code in sungem_phy.c and gianfar_phy.c
9 * Copyright (c) 2004 Freescale Semiconductor, Inc.
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
21 #include <linux/spinlock.h>
22 #include <linux/ethtool.h>
23 #include <linux/mii.h>
24 #include <linux/timer.h>
25 #include <linux/workqueue.h>
26 #include <linux/mod_devicetable.h>
28 #include <linux/atomic.h>
30 #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
34 #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
35 SUPPORTED_10baseT_Full)
37 #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
38 SUPPORTED_100baseT_Full)
40 #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
41 SUPPORTED_1000baseT_Full)
43 #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
44 PHY_100BT_FEATURES | \
47 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
52 * Set phydev->irq to PHY_POLL if interrupts are not supported,
53 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
54 * the attached driver handles the interrupt
57 #define PHY_IGNORE_INTERRUPT -2
59 #define PHY_HAS_INTERRUPT 0x00000001
60 #define PHY_HAS_MAGICANEG 0x00000002
61 #define PHY_IS_INTERNAL 0x00000004
63 /* Interface Mode definitions */
65 PHY_INTERFACE_MODE_NA,
66 PHY_INTERFACE_MODE_MII,
67 PHY_INTERFACE_MODE_GMII,
68 PHY_INTERFACE_MODE_SGMII,
69 PHY_INTERFACE_MODE_TBI,
70 PHY_INTERFACE_MODE_REVMII,
71 PHY_INTERFACE_MODE_RMII,
72 PHY_INTERFACE_MODE_RGMII,
73 PHY_INTERFACE_MODE_RGMII_ID,
74 PHY_INTERFACE_MODE_RGMII_RXID,
75 PHY_INTERFACE_MODE_RGMII_TXID,
76 PHY_INTERFACE_MODE_RTBI,
77 PHY_INTERFACE_MODE_SMII,
81 #define PHY_INIT_TIMEOUT 100000
82 #define PHY_STATE_TIME 1
83 #define PHY_FORCE_TIMEOUT 10
84 #define PHY_AN_TIMEOUT 10
86 #define PHY_MAX_ADDR 32
88 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
89 #define PHY_ID_FMT "%s:%02x"
92 * Need to be a little smaller than phydev->dev.bus_id to leave room
95 #define MII_BUS_ID_SIZE (20 - 3)
97 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
98 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
99 #define MII_ADDR_C45 (1<<30)
105 * The Bus class for PHYs. Devices which provide access to
106 * PHYs should register using this structure
110 char id[MII_BUS_ID_SIZE];
112 int (*read)(struct mii_bus *bus, int phy_id, int regnum);
113 int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
114 int (*reset)(struct mii_bus *bus);
117 * A lock to ensure that only one thing can read/write
118 * the MDIO bus at a time
120 struct mutex mdio_lock;
122 struct device *parent;
124 MDIOBUS_ALLOCATED = 1,
126 MDIOBUS_UNREGISTERED,
131 /* list of all PHYs on bus */
132 struct phy_device *phy_map[PHY_MAX_ADDR];
134 /* PHY addresses to be ignored when probing */
138 * Pointer to an array of interrupts, each PHY's
139 * interrupt at the index matching its address
143 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
145 struct mii_bus *mdiobus_alloc_size(size_t);
146 static inline struct mii_bus *mdiobus_alloc(void)
148 return mdiobus_alloc_size(0);
151 int mdiobus_register(struct mii_bus *bus);
152 void mdiobus_unregister(struct mii_bus *bus);
153 void mdiobus_free(struct mii_bus *bus);
154 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
155 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
156 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
159 #define PHY_INTERRUPT_DISABLED 0x0
160 #define PHY_INTERRUPT_ENABLED 0x80000000
162 /* PHY state machine states:
164 * DOWN: PHY device and driver are not ready for anything. probe
165 * should be called if and only if the PHY is in this state,
166 * given that the PHY device exists.
167 * - PHY driver probe function will, depending on the PHY, set
168 * the state to STARTING or READY
170 * STARTING: PHY device is coming up, and the ethernet driver is
171 * not ready. PHY drivers may set this in the probe function.
172 * If they do, they are responsible for making sure the state is
173 * eventually set to indicate whether the PHY is UP or READY,
174 * depending on the state when the PHY is done starting up.
175 * - PHY driver will set the state to READY
176 * - start will set the state to PENDING
178 * READY: PHY is ready to send and receive packets, but the
179 * controller is not. By default, PHYs which do not implement
180 * probe will be set to this state by phy_probe(). If the PHY
181 * driver knows the PHY is ready, and the PHY state is STARTING,
182 * then it sets this STATE.
183 * - start will set the state to UP
185 * PENDING: PHY device is coming up, but the ethernet driver is
186 * ready. phy_start will set this state if the PHY state is
188 * - PHY driver will set the state to UP when the PHY is ready
190 * UP: The PHY and attached device are ready to do work.
191 * Interrupts should be started here.
192 * - timer moves to AN
194 * AN: The PHY is currently negotiating the link state. Link is
195 * therefore down for now. phy_timer will set this state when it
196 * detects the state is UP. config_aneg will set this state
197 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
198 * - If autonegotiation finishes, but there's no link, it sets
199 * the state to NOLINK.
200 * - If aneg finishes with link, it sets the state to RUNNING,
201 * and calls adjust_link
202 * - If autonegotiation did not finish after an arbitrary amount
203 * of time, autonegotiation should be tried again if the PHY
204 * supports "magic" autonegotiation (back to AN)
205 * - If it didn't finish, and no magic_aneg, move to FORCING.
207 * NOLINK: PHY is up, but not currently plugged in.
208 * - If the timer notes that the link comes back, we move to RUNNING
209 * - config_aneg moves to AN
210 * - phy_stop moves to HALTED
212 * FORCING: PHY is being configured with forced settings
213 * - if link is up, move to RUNNING
214 * - If link is down, we drop to the next highest setting, and
215 * retry (FORCING) after a timeout
216 * - phy_stop moves to HALTED
218 * RUNNING: PHY is currently up, running, and possibly sending
219 * and/or receiving packets
220 * - timer will set CHANGELINK if we're polling (this ensures the
221 * link state is polled every other cycle of this state machine,
222 * which makes it every other second)
223 * - irq will set CHANGELINK
224 * - config_aneg will set AN
225 * - phy_stop moves to HALTED
227 * CHANGELINK: PHY experienced a change in link state
228 * - timer moves to RUNNING if link
229 * - timer moves to NOLINK if the link is down
230 * - phy_stop moves to HALTED
232 * HALTED: PHY is up, but no polling or interrupts are done. Or
233 * PHY is in an error state.
235 * - phy_start moves to RESUMING
237 * RESUMING: PHY was halted, but now wants to run again.
238 * - If we are forcing, or aneg is done, timer moves to RUNNING
239 * - If aneg is not done, timer moves to AN
240 * - phy_stop moves to HALTED
258 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
259 * @devices_in_package: Bit vector of devices present.
260 * @device_ids: The device identifer for each present device.
262 struct phy_c45_device_ids {
263 u32 devices_in_package;
267 /* phy_device: An instance of a PHY
269 * drv: Pointer to the driver for this PHY instance
270 * bus: Pointer to the bus this PHY is on
271 * dev: driver model device structure for this PHY
272 * phy_id: UID for this device found during discovery
273 * c45_ids: 802.3-c45 Device Identifers if is_c45.
274 * is_c45: Set to true if this phy uses clause 45 addressing.
275 * is_internal: Set to true if this phy is internal to a MAC.
276 * state: state of the PHY for management purposes
277 * dev_flags: Device-specific flags used by the PHY driver.
278 * addr: Bus address of PHY
279 * link_timeout: The number of timer firings to wait before the
280 * giving up on the current attempt at acquiring a link
281 * irq: IRQ number of the PHY's interrupt (-1 if none)
282 * phy_timer: The timer for handling the state machine
283 * phy_queue: A work_queue for the interrupt
284 * attached_dev: The attached enet driver's device instance ptr
285 * adjust_link: Callback for the enet controller to respond to
286 * changes in the link state.
287 * adjust_state: Callback for the enet driver to respond to
288 * changes in the state machine.
290 * speed, duplex, pause, supported, advertising, lp_advertising,
291 * and autoneg are used like in mii_if_info
293 * interrupts currently only supports enabled or disabled,
294 * but could be changed in the future to support enabling
295 * and disabling specific interrupts
297 * Contains some infrastructure for polling and interrupt
298 * handling, as well as handling shifts in PHY hardware state
301 /* Information about the PHY type */
302 /* And management functions */
303 struct phy_driver *drv;
311 struct phy_c45_device_ids c45_ids;
315 enum phy_state state;
319 phy_interface_t interface;
321 /* Bus address of the PHY (0-31) */
325 * forced speed & duplex (no autoneg)
326 * partner speed & duplex & pause (autoneg)
333 /* The most recently read link state */
336 /* Enabled Interrupts */
339 /* Union of PHY and Attached devices' supported modes */
340 /* See mii.h for more info */
350 * Interrupt number for this PHY
351 * -1 means no interrupt
355 /* private data pointer */
356 /* For use by PHYs to maintain extra state */
359 /* Interrupt and Polling infrastructure */
360 struct work_struct phy_queue;
361 struct delayed_work state_queue;
362 atomic_t irq_disable;
366 struct net_device *attached_dev;
368 void (*adjust_link)(struct net_device *dev);
370 void (*adjust_state)(struct net_device *dev);
372 #define to_phy_device(d) container_of(d, struct phy_device, dev)
374 /* struct phy_driver: Driver structure for a particular PHY type
376 * phy_id: The result of reading the UID registers of this PHY
377 * type, and ANDing them with the phy_id_mask. This driver
378 * only works for PHYs with IDs which match this field
379 * name: The friendly name of this PHY type
380 * phy_id_mask: Defines the important bits of the phy_id
381 * features: A list of features (speed, duplex, etc) supported
383 * flags: A bitfield defining certain other features this PHY
384 * supports (like interrupts)
386 * The drivers must implement config_aneg and read_status. All
387 * other functions are optional. Note that none of these
388 * functions should be called from interrupt time. The goal is
389 * for the bus read/write functions to be able to block when the
390 * bus transaction is happening, and be freed up by an interrupt
391 * (The MPC85xx has this ability, though it is not currently
392 * supported in the driver).
397 unsigned int phy_id_mask;
402 * Called to initialize the PHY,
403 * including after a reset
405 int (*config_init)(struct phy_device *phydev);
408 * Called during discovery. Used to set
409 * up device-specific structures, if any
411 int (*probe)(struct phy_device *phydev);
413 /* PHY Power Management */
414 int (*suspend)(struct phy_device *phydev);
415 int (*resume)(struct phy_device *phydev);
418 * Configures the advertisement and resets
419 * autonegotiation if phydev->autoneg is on,
420 * forces the speed to the current settings in phydev
421 * if phydev->autoneg is off
423 int (*config_aneg)(struct phy_device *phydev);
425 /* Determines the negotiated speed and duplex */
426 int (*read_status)(struct phy_device *phydev);
428 /* Clears any pending interrupts */
429 int (*ack_interrupt)(struct phy_device *phydev);
431 /* Enables or disables interrupts */
432 int (*config_intr)(struct phy_device *phydev);
435 * Checks if the PHY generated an interrupt.
436 * For multi-PHY devices with shared PHY interrupt pin
438 int (*did_interrupt)(struct phy_device *phydev);
440 /* Clears up any memory if needed */
441 void (*remove)(struct phy_device *phydev);
443 /* Returns true if this is a suitable driver for the given
444 * phydev. If NULL, matching is based on phy_id and
447 int (*match_phy_device)(struct phy_device *phydev);
449 /* Handles ethtool queries for hardware time stamping. */
450 int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
452 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
453 int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
456 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
457 * the phy driver promises to deliver it using netif_rx() as
458 * soon as a timestamp becomes available. One of the
459 * PTP_CLASS_ values is passed in 'type'. The function must
460 * return true if the skb is accepted for delivery.
462 bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
465 * Requests a Tx timestamp for 'skb'. The phy driver promises
466 * to deliver it using skb_complete_tx_timestamp() as soon as a
467 * timestamp becomes available. One of the PTP_CLASS_ values
468 * is passed in 'type'.
470 void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
472 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
473 * enable Wake on LAN, so set_wol is provided to be called in the
474 * ethernet driver's set_wol function. */
475 int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
477 /* See set_wol, but for checking whether Wake on LAN is enabled. */
478 void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
480 struct device_driver driver;
482 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
484 #define PHY_ANY_ID "MATCH ANY PHY"
485 #define PHY_ANY_UID 0xffffffff
487 /* A Structure for boards to register fixups with the PHY Lib */
489 struct list_head list;
493 int (*run)(struct phy_device *phydev);
497 * phy_read - Convenience function for reading a given PHY register
498 * @phydev: the phy_device struct
499 * @regnum: register number to read
501 * NOTE: MUST NOT be called from interrupt context,
502 * because the bus read/write functions may wait for an interrupt
503 * to conclude the operation.
505 static inline int phy_read(struct phy_device *phydev, u32 regnum)
507 return mdiobus_read(phydev->bus, phydev->addr, regnum);
511 * phy_write - Convenience function for writing a given PHY register
512 * @phydev: the phy_device struct
513 * @regnum: register number to write
514 * @val: value to write to @regnum
516 * NOTE: MUST NOT be called from interrupt context,
517 * because the bus read/write functions may wait for an interrupt
518 * to conclude the operation.
520 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
522 return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
526 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
527 * @phydev: the phy_device struct
529 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
530 * PHY_IGNORE_INTERRUPT
532 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
534 return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
538 * phy_is_internal - Convenience function for testing if a PHY is internal
539 * @phydev: the phy_device struct
541 static inline bool phy_is_internal(struct phy_device *phydev)
543 return phydev->is_internal;
546 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
547 bool is_c45, struct phy_c45_device_ids *c45_ids);
548 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
549 int phy_device_register(struct phy_device *phy);
550 int phy_init_hw(struct phy_device *phydev);
551 struct phy_device * phy_attach(struct net_device *dev,
552 const char *bus_id, phy_interface_t interface);
553 struct phy_device *phy_find_first(struct mii_bus *bus);
554 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
555 void (*handler)(struct net_device *),
556 phy_interface_t interface);
557 struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
558 void (*handler)(struct net_device *),
559 phy_interface_t interface);
560 void phy_disconnect(struct phy_device *phydev);
561 void phy_detach(struct phy_device *phydev);
562 void phy_start(struct phy_device *phydev);
563 void phy_stop(struct phy_device *phydev);
564 int phy_start_aneg(struct phy_device *phydev);
566 int phy_stop_interrupts(struct phy_device *phydev);
568 static inline int phy_read_status(struct phy_device *phydev) {
569 return phydev->drv->read_status(phydev);
572 int genphy_setup_forced(struct phy_device *phydev);
573 int genphy_restart_aneg(struct phy_device *phydev);
574 int genphy_config_aneg(struct phy_device *phydev);
575 int genphy_update_link(struct phy_device *phydev);
576 int genphy_read_status(struct phy_device *phydev);
577 int genphy_suspend(struct phy_device *phydev);
578 int genphy_resume(struct phy_device *phydev);
579 void phy_driver_unregister(struct phy_driver *drv);
580 void phy_drivers_unregister(struct phy_driver *drv, int n);
581 int phy_driver_register(struct phy_driver *new_driver);
582 int phy_drivers_register(struct phy_driver *new_driver, int n);
583 void phy_state_machine(struct work_struct *work);
584 void phy_change(struct work_struct *work);
585 void phy_mac_interrupt(struct phy_device *phydev, int new_link);
586 void phy_start_machine(struct phy_device *phydev,
587 void (*handler)(struct net_device *));
588 void phy_stop_machine(struct phy_device *phydev);
589 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
590 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
591 int phy_mii_ioctl(struct phy_device *phydev,
592 struct ifreq *ifr, int cmd);
593 int phy_start_interrupts(struct phy_device *phydev);
594 void phy_print_status(struct phy_device *phydev);
595 void phy_device_free(struct phy_device *phydev);
597 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
598 int (*run)(struct phy_device *));
599 int phy_register_fixup_for_id(const char *bus_id,
600 int (*run)(struct phy_device *));
601 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
602 int (*run)(struct phy_device *));
603 int phy_scan_fixups(struct phy_device *phydev);
605 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
606 int phy_get_eee_err(struct phy_device *phydev);
607 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
608 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
609 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
610 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
612 int __init mdio_bus_init(void);
613 void mdio_bus_exit(void);
615 extern struct bus_type mdio_bus_type;