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
,
80 #define PHY_INIT_TIMEOUT 100000
81 #define PHY_STATE_TIME 1
82 #define PHY_FORCE_TIMEOUT 10
83 #define PHY_AN_TIMEOUT 10
85 #define PHY_MAX_ADDR 32
87 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
88 #define PHY_ID_FMT "%s:%02x"
91 * Need to be a little smaller than phydev->dev.bus_id to leave room
94 #define MII_BUS_ID_SIZE (20 - 3)
96 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
97 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
98 #define MII_ADDR_C45 (1<<30)
104 * The Bus class for PHYs. Devices which provide access to
105 * PHYs should register using this structure
109 char id
[MII_BUS_ID_SIZE
];
111 int (*read
)(struct mii_bus
*bus
, int phy_id
, int regnum
);
112 int (*write
)(struct mii_bus
*bus
, int phy_id
, int regnum
, u16 val
);
113 int (*reset
)(struct mii_bus
*bus
);
116 * A lock to ensure that only one thing can read/write
117 * the MDIO bus at a time
119 struct mutex mdio_lock
;
121 struct device
*parent
;
123 MDIOBUS_ALLOCATED
= 1,
125 MDIOBUS_UNREGISTERED
,
130 /* list of all PHYs on bus */
131 struct phy_device
*phy_map
[PHY_MAX_ADDR
];
133 /* PHY addresses to be ignored when probing */
137 * Pointer to an array of interrupts, each PHY's
138 * interrupt at the index matching its address
142 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
144 struct mii_bus
*mdiobus_alloc_size(size_t);
145 static inline struct mii_bus
*mdiobus_alloc(void)
147 return mdiobus_alloc_size(0);
150 int mdiobus_register(struct mii_bus
*bus
);
151 void mdiobus_unregister(struct mii_bus
*bus
);
152 void mdiobus_free(struct mii_bus
*bus
);
153 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
);
154 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
155 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
158 #define PHY_INTERRUPT_DISABLED 0x0
159 #define PHY_INTERRUPT_ENABLED 0x80000000
161 /* PHY state machine states:
163 * DOWN: PHY device and driver are not ready for anything. probe
164 * should be called if and only if the PHY is in this state,
165 * given that the PHY device exists.
166 * - PHY driver probe function will, depending on the PHY, set
167 * the state to STARTING or READY
169 * STARTING: PHY device is coming up, and the ethernet driver is
170 * not ready. PHY drivers may set this in the probe function.
171 * If they do, they are responsible for making sure the state is
172 * eventually set to indicate whether the PHY is UP or READY,
173 * depending on the state when the PHY is done starting up.
174 * - PHY driver will set the state to READY
175 * - start will set the state to PENDING
177 * READY: PHY is ready to send and receive packets, but the
178 * controller is not. By default, PHYs which do not implement
179 * probe will be set to this state by phy_probe(). If the PHY
180 * driver knows the PHY is ready, and the PHY state is STARTING,
181 * then it sets this STATE.
182 * - start will set the state to UP
184 * PENDING: PHY device is coming up, but the ethernet driver is
185 * ready. phy_start will set this state if the PHY state is
187 * - PHY driver will set the state to UP when the PHY is ready
189 * UP: The PHY and attached device are ready to do work.
190 * Interrupts should be started here.
191 * - timer moves to AN
193 * AN: The PHY is currently negotiating the link state. Link is
194 * therefore down for now. phy_timer will set this state when it
195 * detects the state is UP. config_aneg will set this state
196 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
197 * - If autonegotiation finishes, but there's no link, it sets
198 * the state to NOLINK.
199 * - If aneg finishes with link, it sets the state to RUNNING,
200 * and calls adjust_link
201 * - If autonegotiation did not finish after an arbitrary amount
202 * of time, autonegotiation should be tried again if the PHY
203 * supports "magic" autonegotiation (back to AN)
204 * - If it didn't finish, and no magic_aneg, move to FORCING.
206 * NOLINK: PHY is up, but not currently plugged in.
207 * - If the timer notes that the link comes back, we move to RUNNING
208 * - config_aneg moves to AN
209 * - phy_stop moves to HALTED
211 * FORCING: PHY is being configured with forced settings
212 * - if link is up, move to RUNNING
213 * - If link is down, we drop to the next highest setting, and
214 * retry (FORCING) after a timeout
215 * - phy_stop moves to HALTED
217 * RUNNING: PHY is currently up, running, and possibly sending
218 * and/or receiving packets
219 * - timer will set CHANGELINK if we're polling (this ensures the
220 * link state is polled every other cycle of this state machine,
221 * which makes it every other second)
222 * - irq will set CHANGELINK
223 * - config_aneg will set AN
224 * - phy_stop moves to HALTED
226 * CHANGELINK: PHY experienced a change in link state
227 * - timer moves to RUNNING if link
228 * - timer moves to NOLINK if the link is down
229 * - phy_stop moves to HALTED
231 * HALTED: PHY is up, but no polling or interrupts are done. Or
232 * PHY is in an error state.
234 * - phy_start moves to RESUMING
236 * RESUMING: PHY was halted, but now wants to run again.
237 * - If we are forcing, or aneg is done, timer moves to RUNNING
238 * - If aneg is not done, timer moves to AN
239 * - phy_stop moves to HALTED
257 * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
258 * @devices_in_package: Bit vector of devices present.
259 * @device_ids: The device identifer for each present device.
261 struct phy_c45_device_ids
{
262 u32 devices_in_package
;
266 /* phy_device: An instance of a PHY
268 * drv: Pointer to the driver for this PHY instance
269 * bus: Pointer to the bus this PHY is on
270 * dev: driver model device structure for this PHY
271 * phy_id: UID for this device found during discovery
272 * c45_ids: 802.3-c45 Device Identifers if is_c45.
273 * is_c45: Set to true if this phy uses clause 45 addressing.
274 * is_internal: Set to true if this phy is internal to a MAC.
275 * state: state of the PHY for management purposes
276 * dev_flags: Device-specific flags used by the PHY driver.
277 * addr: Bus address of PHY
278 * link_timeout: The number of timer firings to wait before the
279 * giving up on the current attempt at acquiring a link
280 * irq: IRQ number of the PHY's interrupt (-1 if none)
281 * phy_timer: The timer for handling the state machine
282 * phy_queue: A work_queue for the interrupt
283 * attached_dev: The attached enet driver's device instance ptr
284 * adjust_link: Callback for the enet controller to respond to
285 * changes in the link state.
287 * speed, duplex, pause, supported, advertising, lp_advertising,
288 * and autoneg are used like in mii_if_info
290 * interrupts currently only supports enabled or disabled,
291 * but could be changed in the future to support enabling
292 * and disabling specific interrupts
294 * Contains some infrastructure for polling and interrupt
295 * handling, as well as handling shifts in PHY hardware state
298 /* Information about the PHY type */
299 /* And management functions */
300 struct phy_driver
*drv
;
308 struct phy_c45_device_ids c45_ids
;
312 enum phy_state state
;
316 phy_interface_t interface
;
318 /* Bus address of the PHY (0-31) */
322 * forced speed & duplex (no autoneg)
323 * partner speed & duplex & pause (autoneg)
330 /* The most recently read link state */
333 /* Enabled Interrupts */
336 /* Union of PHY and Attached devices' supported modes */
337 /* See mii.h for more info */
347 * Interrupt number for this PHY
348 * -1 means no interrupt
352 /* private data pointer */
353 /* For use by PHYs to maintain extra state */
356 /* Interrupt and Polling infrastructure */
357 struct work_struct phy_queue
;
358 struct delayed_work state_queue
;
359 atomic_t irq_disable
;
363 struct net_device
*attached_dev
;
365 void (*adjust_link
)(struct net_device
*dev
);
367 #define to_phy_device(d) container_of(d, struct phy_device, dev)
369 /* struct phy_driver: Driver structure for a particular PHY type
371 * phy_id: The result of reading the UID registers of this PHY
372 * type, and ANDing them with the phy_id_mask. This driver
373 * only works for PHYs with IDs which match this field
374 * name: The friendly name of this PHY type
375 * phy_id_mask: Defines the important bits of the phy_id
376 * features: A list of features (speed, duplex, etc) supported
378 * flags: A bitfield defining certain other features this PHY
379 * supports (like interrupts)
381 * The drivers must implement config_aneg and read_status. All
382 * other functions are optional. Note that none of these
383 * functions should be called from interrupt time. The goal is
384 * for the bus read/write functions to be able to block when the
385 * bus transaction is happening, and be freed up by an interrupt
386 * (The MPC85xx has this ability, though it is not currently
387 * supported in the driver).
392 unsigned int phy_id_mask
;
397 * Called to initialize the PHY,
398 * including after a reset
400 int (*config_init
)(struct phy_device
*phydev
);
403 * Called during discovery. Used to set
404 * up device-specific structures, if any
406 int (*probe
)(struct phy_device
*phydev
);
408 /* PHY Power Management */
409 int (*suspend
)(struct phy_device
*phydev
);
410 int (*resume
)(struct phy_device
*phydev
);
413 * Configures the advertisement and resets
414 * autonegotiation if phydev->autoneg is on,
415 * forces the speed to the current settings in phydev
416 * if phydev->autoneg is off
418 int (*config_aneg
)(struct phy_device
*phydev
);
420 /* Determines the negotiated speed and duplex */
421 int (*read_status
)(struct phy_device
*phydev
);
423 /* Clears any pending interrupts */
424 int (*ack_interrupt
)(struct phy_device
*phydev
);
426 /* Enables or disables interrupts */
427 int (*config_intr
)(struct phy_device
*phydev
);
430 * Checks if the PHY generated an interrupt.
431 * For multi-PHY devices with shared PHY interrupt pin
433 int (*did_interrupt
)(struct phy_device
*phydev
);
435 /* Clears up any memory if needed */
436 void (*remove
)(struct phy_device
*phydev
);
438 /* Returns true if this is a suitable driver for the given
439 * phydev. If NULL, matching is based on phy_id and
442 int (*match_phy_device
)(struct phy_device
*phydev
);
444 /* Handles ethtool queries for hardware time stamping. */
445 int (*ts_info
)(struct phy_device
*phydev
, struct ethtool_ts_info
*ti
);
447 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
448 int (*hwtstamp
)(struct phy_device
*phydev
, struct ifreq
*ifr
);
451 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
452 * the phy driver promises to deliver it using netif_rx() as
453 * soon as a timestamp becomes available. One of the
454 * PTP_CLASS_ values is passed in 'type'. The function must
455 * return true if the skb is accepted for delivery.
457 bool (*rxtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
460 * Requests a Tx timestamp for 'skb'. The phy driver promises
461 * to deliver it using skb_complete_tx_timestamp() as soon as a
462 * timestamp becomes available. One of the PTP_CLASS_ values
463 * is passed in 'type'.
465 void (*txtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
467 /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
468 * enable Wake on LAN, so set_wol is provided to be called in the
469 * ethernet driver's set_wol function. */
470 int (*set_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
472 /* See set_wol, but for checking whether Wake on LAN is enabled. */
473 void (*get_wol
)(struct phy_device
*dev
, struct ethtool_wolinfo
*wol
);
475 struct device_driver driver
;
477 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
479 #define PHY_ANY_ID "MATCH ANY PHY"
480 #define PHY_ANY_UID 0xffffffff
482 /* A Structure for boards to register fixups with the PHY Lib */
484 struct list_head list
;
488 int (*run
)(struct phy_device
*phydev
);
492 * phy_read_mmd - Convenience function for reading a register
493 * from an MMD on a given PHY.
494 * @phydev: The phy_device struct
495 * @devad: The MMD to read from
496 * @regnum: The register on the MMD to read
498 * Same rules as for phy_read();
500 static inline int phy_read_mmd(struct phy_device
*phydev
, int devad
, u32 regnum
)
505 return mdiobus_read(phydev
->bus
, phydev
->addr
,
506 MII_ADDR_C45
| (devad
<< 16) | (regnum
& 0xffff));
510 * phy_read - Convenience function for reading a given PHY register
511 * @phydev: the phy_device struct
512 * @regnum: register number to read
514 * NOTE: MUST NOT be called from interrupt context,
515 * because the bus read/write functions may wait for an interrupt
516 * to conclude the operation.
518 static inline int phy_read(struct phy_device
*phydev
, u32 regnum
)
520 return mdiobus_read(phydev
->bus
, phydev
->addr
, regnum
);
524 * phy_write - Convenience function for writing a given PHY register
525 * @phydev: the phy_device struct
526 * @regnum: register number to write
527 * @val: value to write to @regnum
529 * NOTE: MUST NOT be called from interrupt context,
530 * because the bus read/write functions may wait for an interrupt
531 * to conclude the operation.
533 static inline int phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
535 return mdiobus_write(phydev
->bus
, phydev
->addr
, regnum
, val
);
539 * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
540 * @phydev: the phy_device struct
542 * NOTE: must be kept in sync with addition/removal of PHY_POLL and
543 * PHY_IGNORE_INTERRUPT
545 static inline bool phy_interrupt_is_valid(struct phy_device
*phydev
)
547 return phydev
->irq
!= PHY_POLL
&& phydev
->irq
!= PHY_IGNORE_INTERRUPT
;
551 * phy_is_internal - Convenience function for testing if a PHY is internal
552 * @phydev: the phy_device struct
554 static inline bool phy_is_internal(struct phy_device
*phydev
)
556 return phydev
->is_internal
;
560 * phy_write_mmd - Convenience function for writing a register
561 * on an MMD on a given PHY.
562 * @phydev: The phy_device struct
563 * @devad: The MMD to read from
564 * @regnum: The register on the MMD to read
565 * @val: value to write to @regnum
567 * Same rules as for phy_write();
569 static inline int phy_write_mmd(struct phy_device
*phydev
, int devad
,
575 regnum
= MII_ADDR_C45
| ((devad
& 0x1f) << 16) | (regnum
& 0xffff);
577 return mdiobus_write(phydev
->bus
, phydev
->addr
, regnum
, val
);
580 struct phy_device
*phy_device_create(struct mii_bus
*bus
, int addr
, int phy_id
,
582 struct phy_c45_device_ids
*c45_ids
);
583 struct phy_device
*get_phy_device(struct mii_bus
*bus
, int addr
, bool is_c45
);
584 int phy_device_register(struct phy_device
*phy
);
585 int phy_init_hw(struct phy_device
*phydev
);
586 int phy_suspend(struct phy_device
*phydev
);
587 int phy_resume(struct phy_device
*phydev
);
588 struct phy_device
*phy_attach(struct net_device
*dev
, const char *bus_id
,
589 phy_interface_t interface
);
590 struct phy_device
*phy_find_first(struct mii_bus
*bus
);
591 int phy_attach_direct(struct net_device
*dev
, struct phy_device
*phydev
,
592 u32 flags
, phy_interface_t interface
);
593 int phy_connect_direct(struct net_device
*dev
, struct phy_device
*phydev
,
594 void (*handler
)(struct net_device
*),
595 phy_interface_t interface
);
596 struct phy_device
*phy_connect(struct net_device
*dev
, const char *bus_id
,
597 void (*handler
)(struct net_device
*),
598 phy_interface_t interface
);
599 void phy_disconnect(struct phy_device
*phydev
);
600 void phy_detach(struct phy_device
*phydev
);
601 void phy_start(struct phy_device
*phydev
);
602 void phy_stop(struct phy_device
*phydev
);
603 int phy_start_aneg(struct phy_device
*phydev
);
605 int phy_stop_interrupts(struct phy_device
*phydev
);
607 static inline int phy_read_status(struct phy_device
*phydev
)
609 return phydev
->drv
->read_status(phydev
);
612 int genphy_setup_forced(struct phy_device
*phydev
);
613 int genphy_restart_aneg(struct phy_device
*phydev
);
614 int genphy_config_aneg(struct phy_device
*phydev
);
615 int genphy_update_link(struct phy_device
*phydev
);
616 int genphy_read_status(struct phy_device
*phydev
);
617 int genphy_suspend(struct phy_device
*phydev
);
618 int genphy_resume(struct phy_device
*phydev
);
619 void phy_driver_unregister(struct phy_driver
*drv
);
620 void phy_drivers_unregister(struct phy_driver
*drv
, int n
);
621 int phy_driver_register(struct phy_driver
*new_driver
);
622 int phy_drivers_register(struct phy_driver
*new_driver
, int n
);
623 void phy_state_machine(struct work_struct
*work
);
624 void phy_change(struct work_struct
*work
);
625 void phy_mac_interrupt(struct phy_device
*phydev
, int new_link
);
626 void phy_start_machine(struct phy_device
*phydev
);
627 void phy_stop_machine(struct phy_device
*phydev
);
628 int phy_ethtool_sset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
629 int phy_ethtool_gset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
630 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
);
631 int phy_start_interrupts(struct phy_device
*phydev
);
632 void phy_print_status(struct phy_device
*phydev
);
633 void phy_device_free(struct phy_device
*phydev
);
635 int phy_register_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
,
636 int (*run
)(struct phy_device
*));
637 int phy_register_fixup_for_id(const char *bus_id
,
638 int (*run
)(struct phy_device
*));
639 int phy_register_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
,
640 int (*run
)(struct phy_device
*));
642 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
);
643 int phy_get_eee_err(struct phy_device
*phydev
);
644 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
645 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
);
646 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
);
647 void phy_ethtool_get_wol(struct phy_device
*phydev
,
648 struct ethtool_wolinfo
*wol
);
650 int __init
mdio_bus_init(void);
651 void mdio_bus_exit(void);
653 extern struct bus_type mdio_bus_type
;