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_BASIC_FEATURES (SUPPORTED_10baseT_Half | \
31 SUPPORTED_10baseT_Full | \
32 SUPPORTED_100baseT_Half | \
33 SUPPORTED_100baseT_Full | \
38 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
39 SUPPORTED_1000baseT_Half | \
40 SUPPORTED_1000baseT_Full)
43 * Set phydev->irq to PHY_POLL if interrupts are not supported,
44 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
45 * the attached driver handles the interrupt
48 #define PHY_IGNORE_INTERRUPT -2
50 #define PHY_HAS_INTERRUPT 0x00000001
51 #define PHY_HAS_MAGICANEG 0x00000002
53 /* Interface Mode definitions */
55 PHY_INTERFACE_MODE_NA
,
56 PHY_INTERFACE_MODE_MII
,
57 PHY_INTERFACE_MODE_GMII
,
58 PHY_INTERFACE_MODE_SGMII
,
59 PHY_INTERFACE_MODE_TBI
,
60 PHY_INTERFACE_MODE_RMII
,
61 PHY_INTERFACE_MODE_RGMII
,
62 PHY_INTERFACE_MODE_RGMII_ID
,
63 PHY_INTERFACE_MODE_RGMII_RXID
,
64 PHY_INTERFACE_MODE_RGMII_TXID
,
65 PHY_INTERFACE_MODE_RTBI
,
66 PHY_INTERFACE_MODE_SMII
,
70 #define PHY_INIT_TIMEOUT 100000
71 #define PHY_STATE_TIME 1
72 #define PHY_FORCE_TIMEOUT 10
73 #define PHY_AN_TIMEOUT 10
75 #define PHY_MAX_ADDR 32
77 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
78 #define PHY_ID_FMT "%s:%02x"
81 * Need to be a little smaller than phydev->dev.bus_id to leave room
84 #define MII_BUS_ID_SIZE (20 - 3)
86 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
87 IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
88 #define MII_ADDR_C45 (1<<30)
94 * The Bus class for PHYs. Devices which provide access to
95 * PHYs should register using this structure
99 char id
[MII_BUS_ID_SIZE
];
101 int (*read
)(struct mii_bus
*bus
, int phy_id
, int regnum
);
102 int (*write
)(struct mii_bus
*bus
, int phy_id
, int regnum
, u16 val
);
103 int (*reset
)(struct mii_bus
*bus
);
106 * A lock to ensure that only one thing can read/write
107 * the MDIO bus at a time
109 struct mutex mdio_lock
;
111 struct device
*parent
;
113 MDIOBUS_ALLOCATED
= 1,
115 MDIOBUS_UNREGISTERED
,
120 /* list of all PHYs on bus */
121 struct phy_device
*phy_map
[PHY_MAX_ADDR
];
123 /* PHY addresses to be ignored when probing */
127 * Pointer to an array of interrupts, each PHY's
128 * interrupt at the index matching its address
132 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
134 struct mii_bus
*mdiobus_alloc_size(size_t);
135 static inline struct mii_bus
*mdiobus_alloc(void)
137 return mdiobus_alloc_size(0);
140 int mdiobus_register(struct mii_bus
*bus
);
141 void mdiobus_unregister(struct mii_bus
*bus
);
142 void mdiobus_free(struct mii_bus
*bus
);
143 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
);
144 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
);
145 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
);
148 #define PHY_INTERRUPT_DISABLED 0x0
149 #define PHY_INTERRUPT_ENABLED 0x80000000
151 /* PHY state machine states:
153 * DOWN: PHY device and driver are not ready for anything. probe
154 * should be called if and only if the PHY is in this state,
155 * given that the PHY device exists.
156 * - PHY driver probe function will, depending on the PHY, set
157 * the state to STARTING or READY
159 * STARTING: PHY device is coming up, and the ethernet driver is
160 * not ready. PHY drivers may set this in the probe function.
161 * If they do, they are responsible for making sure the state is
162 * eventually set to indicate whether the PHY is UP or READY,
163 * depending on the state when the PHY is done starting up.
164 * - PHY driver will set the state to READY
165 * - start will set the state to PENDING
167 * READY: PHY is ready to send and receive packets, but the
168 * controller is not. By default, PHYs which do not implement
169 * probe will be set to this state by phy_probe(). If the PHY
170 * driver knows the PHY is ready, and the PHY state is STARTING,
171 * then it sets this STATE.
172 * - start will set the state to UP
174 * PENDING: PHY device is coming up, but the ethernet driver is
175 * ready. phy_start will set this state if the PHY state is
177 * - PHY driver will set the state to UP when the PHY is ready
179 * UP: The PHY and attached device are ready to do work.
180 * Interrupts should be started here.
181 * - timer moves to AN
183 * AN: The PHY is currently negotiating the link state. Link is
184 * therefore down for now. phy_timer will set this state when it
185 * detects the state is UP. config_aneg will set this state
186 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
187 * - If autonegotiation finishes, but there's no link, it sets
188 * the state to NOLINK.
189 * - If aneg finishes with link, it sets the state to RUNNING,
190 * and calls adjust_link
191 * - If autonegotiation did not finish after an arbitrary amount
192 * of time, autonegotiation should be tried again if the PHY
193 * supports "magic" autonegotiation (back to AN)
194 * - If it didn't finish, and no magic_aneg, move to FORCING.
196 * NOLINK: PHY is up, but not currently plugged in.
197 * - If the timer notes that the link comes back, we move to RUNNING
198 * - config_aneg moves to AN
199 * - phy_stop moves to HALTED
201 * FORCING: PHY is being configured with forced settings
202 * - if link is up, move to RUNNING
203 * - If link is down, we drop to the next highest setting, and
204 * retry (FORCING) after a timeout
205 * - phy_stop moves to HALTED
207 * RUNNING: PHY is currently up, running, and possibly sending
208 * and/or receiving packets
209 * - timer will set CHANGELINK if we're polling (this ensures the
210 * link state is polled every other cycle of this state machine,
211 * which makes it every other second)
212 * - irq will set CHANGELINK
213 * - config_aneg will set AN
214 * - phy_stop moves to HALTED
216 * CHANGELINK: PHY experienced a change in link state
217 * - timer moves to RUNNING if link
218 * - timer moves to NOLINK if the link is down
219 * - phy_stop moves to HALTED
221 * HALTED: PHY is up, but no polling or interrupts are done. Or
222 * PHY is in an error state.
224 * - phy_start moves to RESUMING
226 * RESUMING: PHY was halted, but now wants to run again.
227 * - If we are forcing, or aneg is done, timer moves to RUNNING
228 * - If aneg is not done, timer moves to AN
229 * - phy_stop moves to HALTED
247 /* phy_device: An instance of a PHY
249 * drv: Pointer to the driver for this PHY instance
250 * bus: Pointer to the bus this PHY is on
251 * dev: driver model device structure for this PHY
252 * phy_id: UID for this device found during discovery
253 * state: state of the PHY for management purposes
254 * dev_flags: Device-specific flags used by the PHY driver.
255 * addr: Bus address of PHY
256 * link_timeout: The number of timer firings to wait before the
257 * giving up on the current attempt at acquiring a link
258 * irq: IRQ number of the PHY's interrupt (-1 if none)
259 * phy_timer: The timer for handling the state machine
260 * phy_queue: A work_queue for the interrupt
261 * attached_dev: The attached enet driver's device instance ptr
262 * adjust_link: Callback for the enet controller to respond to
263 * changes in the link state.
264 * adjust_state: Callback for the enet driver to respond to
265 * changes in the state machine.
267 * speed, duplex, pause, supported, advertising, and
268 * autoneg are used like in mii_if_info
270 * interrupts currently only supports enabled or disabled,
271 * but could be changed in the future to support enabling
272 * and disabling specific interrupts
274 * Contains some infrastructure for polling and interrupt
275 * handling, as well as handling shifts in PHY hardware state
278 /* Information about the PHY type */
279 /* And management functions */
280 struct phy_driver
*drv
;
288 enum phy_state state
;
292 phy_interface_t interface
;
294 /* Bus address of the PHY (0-31) */
298 * forced speed & duplex (no autoneg)
299 * partner speed & duplex & pause (autoneg)
306 /* The most recently read link state */
309 /* Enabled Interrupts */
312 /* Union of PHY and Attached devices' supported modes */
313 /* See mii.h for more info */
322 * Interrupt number for this PHY
323 * -1 means no interrupt
327 /* private data pointer */
328 /* For use by PHYs to maintain extra state */
331 /* Interrupt and Polling infrastructure */
332 struct work_struct phy_queue
;
333 struct delayed_work state_queue
;
334 atomic_t irq_disable
;
338 struct net_device
*attached_dev
;
340 void (*adjust_link
)(struct net_device
*dev
);
342 void (*adjust_state
)(struct net_device
*dev
);
344 #define to_phy_device(d) container_of(d, struct phy_device, dev)
346 /* struct phy_driver: Driver structure for a particular PHY type
348 * phy_id: The result of reading the UID registers of this PHY
349 * type, and ANDing them with the phy_id_mask. This driver
350 * only works for PHYs with IDs which match this field
351 * name: The friendly name of this PHY type
352 * phy_id_mask: Defines the important bits of the phy_id
353 * features: A list of features (speed, duplex, etc) supported
355 * flags: A bitfield defining certain other features this PHY
356 * supports (like interrupts)
358 * The drivers must implement config_aneg and read_status. All
359 * other functions are optional. Note that none of these
360 * functions should be called from interrupt time. The goal is
361 * for the bus read/write functions to be able to block when the
362 * bus transaction is happening, and be freed up by an interrupt
363 * (The MPC85xx has this ability, though it is not currently
364 * supported in the driver).
369 unsigned int phy_id_mask
;
374 * Called to initialize the PHY,
375 * including after a reset
377 int (*config_init
)(struct phy_device
*phydev
);
380 * Called during discovery. Used to set
381 * up device-specific structures, if any
383 int (*probe
)(struct phy_device
*phydev
);
385 /* PHY Power Management */
386 int (*suspend
)(struct phy_device
*phydev
);
387 int (*resume
)(struct phy_device
*phydev
);
390 * Configures the advertisement and resets
391 * autonegotiation if phydev->autoneg is on,
392 * forces the speed to the current settings in phydev
393 * if phydev->autoneg is off
395 int (*config_aneg
)(struct phy_device
*phydev
);
397 /* Determines the negotiated speed and duplex */
398 int (*read_status
)(struct phy_device
*phydev
);
400 /* Clears any pending interrupts */
401 int (*ack_interrupt
)(struct phy_device
*phydev
);
403 /* Enables or disables interrupts */
404 int (*config_intr
)(struct phy_device
*phydev
);
407 * Checks if the PHY generated an interrupt.
408 * For multi-PHY devices with shared PHY interrupt pin
410 int (*did_interrupt
)(struct phy_device
*phydev
);
412 /* Clears up any memory if needed */
413 void (*remove
)(struct phy_device
*phydev
);
415 /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
416 int (*hwtstamp
)(struct phy_device
*phydev
, struct ifreq
*ifr
);
419 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
420 * the phy driver promises to deliver it using netif_rx() as
421 * soon as a timestamp becomes available. One of the
422 * PTP_CLASS_ values is passed in 'type'. The function must
423 * return true if the skb is accepted for delivery.
425 bool (*rxtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
428 * Requests a Tx timestamp for 'skb'. The phy driver promises
429 * to deliver it using skb_complete_tx_timestamp() as soon as a
430 * timestamp becomes available. One of the PTP_CLASS_ values
431 * is passed in 'type'.
433 void (*txtstamp
)(struct phy_device
*dev
, struct sk_buff
*skb
, int type
);
435 struct device_driver driver
;
437 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
439 #define PHY_ANY_ID "MATCH ANY PHY"
440 #define PHY_ANY_UID 0xffffffff
442 /* A Structure for boards to register fixups with the PHY Lib */
444 struct list_head list
;
448 int (*run
)(struct phy_device
*phydev
);
452 * phy_read - Convenience function for reading a given PHY register
453 * @phydev: the phy_device struct
454 * @regnum: register number to read
456 * NOTE: MUST NOT be called from interrupt context,
457 * because the bus read/write functions may wait for an interrupt
458 * to conclude the operation.
460 static inline int phy_read(struct phy_device
*phydev
, u32 regnum
)
462 return mdiobus_read(phydev
->bus
, phydev
->addr
, regnum
);
466 * phy_write - Convenience function for writing a given PHY register
467 * @phydev: the phy_device struct
468 * @regnum: register number to write
469 * @val: value to write to @regnum
471 * NOTE: MUST NOT be called from interrupt context,
472 * because the bus read/write functions may wait for an interrupt
473 * to conclude the operation.
475 static inline int phy_write(struct phy_device
*phydev
, u32 regnum
, u16 val
)
477 return mdiobus_write(phydev
->bus
, phydev
->addr
, regnum
, val
);
480 int get_phy_id(struct mii_bus
*bus
, int addr
, u32
*phy_id
);
481 struct phy_device
* get_phy_device(struct mii_bus
*bus
, int addr
);
482 int phy_device_register(struct phy_device
*phy
);
483 int phy_init_hw(struct phy_device
*phydev
);
484 struct phy_device
* phy_attach(struct net_device
*dev
,
485 const char *bus_id
, u32 flags
, phy_interface_t interface
);
486 struct phy_device
*phy_find_first(struct mii_bus
*bus
);
487 int phy_connect_direct(struct net_device
*dev
, struct phy_device
*phydev
,
488 void (*handler
)(struct net_device
*), u32 flags
,
489 phy_interface_t interface
);
490 struct phy_device
* phy_connect(struct net_device
*dev
, const char *bus_id
,
491 void (*handler
)(struct net_device
*), u32 flags
,
492 phy_interface_t interface
);
493 void phy_disconnect(struct phy_device
*phydev
);
494 void phy_detach(struct phy_device
*phydev
);
495 void phy_start(struct phy_device
*phydev
);
496 void phy_stop(struct phy_device
*phydev
);
497 int phy_start_aneg(struct phy_device
*phydev
);
499 int phy_stop_interrupts(struct phy_device
*phydev
);
501 static inline int phy_read_status(struct phy_device
*phydev
) {
502 return phydev
->drv
->read_status(phydev
);
505 int genphy_restart_aneg(struct phy_device
*phydev
);
506 int genphy_config_aneg(struct phy_device
*phydev
);
507 int genphy_update_link(struct phy_device
*phydev
);
508 int genphy_read_status(struct phy_device
*phydev
);
509 int genphy_suspend(struct phy_device
*phydev
);
510 int genphy_resume(struct phy_device
*phydev
);
511 void phy_driver_unregister(struct phy_driver
*drv
);
512 int phy_driver_register(struct phy_driver
*new_driver
);
513 void phy_state_machine(struct work_struct
*work
);
514 void phy_start_machine(struct phy_device
*phydev
,
515 void (*handler
)(struct net_device
*));
516 void phy_stop_machine(struct phy_device
*phydev
);
517 int phy_ethtool_sset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
518 int phy_ethtool_gset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
);
519 int phy_mii_ioctl(struct phy_device
*phydev
,
520 struct ifreq
*ifr
, int cmd
);
521 int phy_start_interrupts(struct phy_device
*phydev
);
522 void phy_print_status(struct phy_device
*phydev
);
523 void phy_device_free(struct phy_device
*phydev
);
525 int phy_register_fixup(const char *bus_id
, u32 phy_uid
, u32 phy_uid_mask
,
526 int (*run
)(struct phy_device
*));
527 int phy_register_fixup_for_id(const char *bus_id
,
528 int (*run
)(struct phy_device
*));
529 int phy_register_fixup_for_uid(u32 phy_uid
, u32 phy_uid_mask
,
530 int (*run
)(struct phy_device
*));
531 int phy_scan_fixups(struct phy_device
*phydev
);
533 int __init
mdio_bus_init(void);
534 void mdio_bus_exit(void);
536 extern struct bus_type mdio_bus_type
;