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/device.h>
24 #define PHY_BASIC_FEATURES (SUPPORTED_10baseT_Half | \
25 SUPPORTED_10baseT_Full | \
26 SUPPORTED_100baseT_Half | \
27 SUPPORTED_100baseT_Full | \
32 #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
33 SUPPORTED_1000baseT_Half | \
34 SUPPORTED_1000baseT_Full)
36 /* Set phydev->irq to PHY_POLL if interrupts are not supported,
37 * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
38 * the attached driver handles the interrupt
41 #define PHY_IGNORE_INTERRUPT -2
43 #define PHY_HAS_INTERRUPT 0x00000001
44 #define PHY_HAS_MAGICANEG 0x00000002
49 #define PHY_INIT_TIMEOUT 100000
50 #define PHY_STATE_TIME 1
51 #define PHY_FORCE_TIMEOUT 10
52 #define PHY_AN_TIMEOUT 10
54 #define PHY_MAX_ADDR 32
56 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
57 #define PHY_ID_FMT "%x:%02x"
59 /* The Bus class for PHYs. Devices which provide access to
60 * PHYs should register using this structure */
65 int (*read)(struct mii_bus *bus, int phy_id, int regnum);
66 int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
67 int (*reset)(struct mii_bus *bus);
69 /* A lock to ensure that only one thing can read/write
70 * the MDIO bus at a time */
75 /* list of all PHYs on bus */
76 struct phy_device *phy_map[PHY_MAX_ADDR];
78 /* Phy addresses to be ignored when probing */
81 /* Pointer to an array of interrupts, each PHY's
82 * interrupt at the index matching its address */
86 #define PHY_INTERRUPT_DISABLED 0x0
87 #define PHY_INTERRUPT_ENABLED 0x80000000
89 /* PHY state machine states:
91 * DOWN: PHY device and driver are not ready for anything. probe
92 * should be called if and only if the PHY is in this state,
93 * given that the PHY device exists.
94 * - PHY driver probe function will, depending on the PHY, set
95 * the state to STARTING or READY
97 * STARTING: PHY device is coming up, and the ethernet driver is
98 * not ready. PHY drivers may set this in the probe function.
99 * If they do, they are responsible for making sure the state is
100 * eventually set to indicate whether the PHY is UP or READY,
101 * depending on the state when the PHY is done starting up.
102 * - PHY driver will set the state to READY
103 * - start will set the state to PENDING
105 * READY: PHY is ready to send and receive packets, but the
106 * controller is not. By default, PHYs which do not implement
107 * probe will be set to this state by phy_probe(). If the PHY
108 * driver knows the PHY is ready, and the PHY state is STARTING,
109 * then it sets this STATE.
110 * - start will set the state to UP
112 * PENDING: PHY device is coming up, but the ethernet driver is
113 * ready. phy_start will set this state if the PHY state is
115 * - PHY driver will set the state to UP when the PHY is ready
117 * UP: The PHY and attached device are ready to do work.
118 * Interrupts should be started here.
119 * - timer moves to AN
121 * AN: The PHY is currently negotiating the link state. Link is
122 * therefore down for now. phy_timer will set this state when it
123 * detects the state is UP. config_aneg will set this state
124 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
125 * - If autonegotiation finishes, but there's no link, it sets
126 * the state to NOLINK.
127 * - If aneg finishes with link, it sets the state to RUNNING,
128 * and calls adjust_link
129 * - If autonegotiation did not finish after an arbitrary amount
130 * of time, autonegotiation should be tried again if the PHY
131 * supports "magic" autonegotiation (back to AN)
132 * - If it didn't finish, and no magic_aneg, move to FORCING.
134 * NOLINK: PHY is up, but not currently plugged in.
135 * - If the timer notes that the link comes back, we move to RUNNING
136 * - config_aneg moves to AN
137 * - phy_stop moves to HALTED
139 * FORCING: PHY is being configured with forced settings
140 * - if link is up, move to RUNNING
141 * - If link is down, we drop to the next highest setting, and
142 * retry (FORCING) after a timeout
143 * - phy_stop moves to HALTED
145 * RUNNING: PHY is currently up, running, and possibly sending
146 * and/or receiving packets
147 * - timer will set CHANGELINK if we're polling (this ensures the
148 * link state is polled every other cycle of this state machine,
149 * which makes it every other second)
150 * - irq will set CHANGELINK
151 * - config_aneg will set AN
152 * - phy_stop moves to HALTED
154 * CHANGELINK: PHY experienced a change in link state
155 * - timer moves to RUNNING if link
156 * - timer moves to NOLINK if the link is down
157 * - phy_stop moves to HALTED
159 * HALTED: PHY is up, but no polling or interrupts are done. Or
160 * PHY is in an error state.
162 * - phy_start moves to RESUMING
164 * RESUMING: PHY was halted, but now wants to run again.
165 * - If we are forcing, or aneg is done, timer moves to RUNNING
166 * - If aneg is not done, timer moves to AN
167 * - phy_stop moves to HALTED
184 /* phy_device: An instance of a PHY
186 * drv: Pointer to the driver for this PHY instance
187 * bus: Pointer to the bus this PHY is on
188 * dev: driver model device structure for this PHY
189 * phy_id: UID for this device found during discovery
190 * state: state of the PHY for management purposes
191 * dev_flags: Device-specific flags used by the PHY driver.
192 * addr: Bus address of PHY
193 * link_timeout: The number of timer firings to wait before the
194 * giving up on the current attempt at acquiring a link
195 * irq: IRQ number of the PHY's interrupt (-1 if none)
196 * phy_timer: The timer for handling the state machine
197 * phy_queue: A work_queue for the interrupt
198 * attached_dev: The attached enet driver's device instance ptr
199 * adjust_link: Callback for the enet controller to respond to
200 * changes in the link state.
201 * adjust_state: Callback for the enet driver to respond to
202 * changes in the state machine.
204 * speed, duplex, pause, supported, advertising, and
205 * autoneg are used like in mii_if_info
207 * interrupts currently only supports enabled or disabled,
208 * but could be changed in the future to support enabling
209 * and disabling specific interrupts
211 * Contains some infrastructure for polling and interrupt
212 * handling, as well as handling shifts in PHY hardware state
215 /* Information about the PHY type */
216 /* And management functions */
217 struct phy_driver *drv;
225 enum phy_state state;
229 /* Bus address of the PHY (0-32) */
232 /* forced speed & duplex (no autoneg)
233 * partner speed & duplex & pause (autoneg)
240 /* The most recently read link state */
243 /* Enabled Interrupts */
246 /* Union of PHY and Attached devices' supported modes */
247 /* See mii.h for more info */
255 /* Interrupt number for this PHY
256 * -1 means no interrupt */
259 /* private data pointer */
260 /* For use by PHYs to maintain extra state */
263 /* Interrupt and Polling infrastructure */
264 struct work_struct phy_queue;
265 struct timer_list phy_timer;
269 struct net_device *attached_dev;
271 void (*adjust_link)(struct net_device *dev);
273 void (*adjust_state)(struct net_device *dev);
275 #define to_phy_device(d) container_of(d, struct phy_device, dev)
277 /* struct phy_driver: Driver structure for a particular PHY type
279 * phy_id: The result of reading the UID registers of this PHY
280 * type, and ANDing them with the phy_id_mask. This driver
281 * only works for PHYs with IDs which match this field
282 * name: The friendly name of this PHY type
283 * phy_id_mask: Defines the important bits of the phy_id
284 * features: A list of features (speed, duplex, etc) supported
286 * flags: A bitfield defining certain other features this PHY
287 * supports (like interrupts)
289 * The drivers must implement config_aneg and read_status. All
290 * other functions are optional. Note that none of these
291 * functions should be called from interrupt time. The goal is
292 * for the bus read/write functions to be able to block when the
293 * bus transaction is happening, and be freed up by an interrupt
294 * (The MPC85xx has this ability, though it is not currently
295 * supported in the driver).
300 unsigned int phy_id_mask;
304 /* Called to initialize the PHY,
305 * including after a reset */
306 int (*config_init)(struct phy_device *phydev);
308 /* Called during discovery. Used to set
309 * up device-specific structures, if any */
310 int (*probe)(struct phy_device *phydev);
312 /* PHY Power Management */
313 int (*suspend)(struct phy_device *phydev);
314 int (*resume)(struct phy_device *phydev);
316 /* Configures the advertisement and resets
317 * autonegotiation if phydev->autoneg is on,
318 * forces the speed to the current settings in phydev
319 * if phydev->autoneg is off */
320 int (*config_aneg)(struct phy_device *phydev);
322 /* Determines the negotiated speed and duplex */
323 int (*read_status)(struct phy_device *phydev);
325 /* Clears any pending interrupts */
326 int (*ack_interrupt)(struct phy_device *phydev);
328 /* Enables or disables interrupts */
329 int (*config_intr)(struct phy_device *phydev);
331 /* Clears up any memory if needed */
332 void (*remove)(struct phy_device *phydev);
334 struct device_driver driver;
336 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
338 int phy_read(struct phy_device *phydev, u16 regnum);
339 int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
340 struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
341 int phy_clear_interrupt(struct phy_device *phydev);
342 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
343 struct phy_device * phy_attach(struct net_device *dev,
344 const char *phy_id, u32 flags);
345 struct phy_device * phy_connect(struct net_device *dev, const char *phy_id,
346 void (*handler)(struct net_device *), u32 flags);
347 void phy_disconnect(struct phy_device *phydev);
348 void phy_detach(struct phy_device *phydev);
349 void phy_start(struct phy_device *phydev);
350 void phy_stop(struct phy_device *phydev);
351 int phy_start_aneg(struct phy_device *phydev);
353 int mdiobus_register(struct mii_bus *bus);
354 void mdiobus_unregister(struct mii_bus *bus);
355 void phy_sanitize_settings(struct phy_device *phydev);
356 int phy_stop_interrupts(struct phy_device *phydev);
358 static inline int phy_read_status(struct phy_device *phydev) {
359 return phydev->drv->read_status(phydev);
362 int genphy_config_advert(struct phy_device *phydev);
363 int genphy_setup_forced(struct phy_device *phydev);
364 int genphy_restart_aneg(struct phy_device *phydev);
365 int genphy_config_aneg(struct phy_device *phydev);
366 int genphy_update_link(struct phy_device *phydev);
367 int genphy_read_status(struct phy_device *phydev);
368 void phy_driver_unregister(struct phy_driver *drv);
369 int phy_driver_register(struct phy_driver *new_driver);
370 void phy_prepare_link(struct phy_device *phydev,
371 void (*adjust_link)(struct net_device *));
372 void phy_start_machine(struct phy_device *phydev,
373 void (*handler)(struct net_device *));
374 void phy_stop_machine(struct phy_device *phydev);
375 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
376 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
377 int phy_mii_ioctl(struct phy_device *phydev,
378 struct mii_ioctl_data *mii_data, int cmd);
379 int phy_start_interrupts(struct phy_device *phydev);
380 void phy_print_status(struct phy_device *phydev);
382 extern struct bus_type mdio_bus_type;