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 /* The Bus class for PHYs. Devices which provide access to
57 * PHYs should register using this structure */
62 int (*read)(struct mii_bus *bus, int phy_id, int regnum);
63 int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
64 int (*reset)(struct mii_bus *bus);
66 /* A lock to ensure that only one thing can read/write
67 * the MDIO bus at a time */
72 /* list of all PHYs on bus */
73 struct phy_device *phy_map[PHY_MAX_ADDR];
75 /* Pointer to an array of interrupts, each PHY's
76 * interrupt at the index matching its address */
80 #define PHY_INTERRUPT_DISABLED 0x0
81 #define PHY_INTERRUPT_ENABLED 0x80000000
83 /* PHY state machine states:
85 * DOWN: PHY device and driver are not ready for anything. probe
86 * should be called if and only if the PHY is in this state,
87 * given that the PHY device exists.
88 * - PHY driver probe function will, depending on the PHY, set
89 * the state to STARTING or READY
91 * STARTING: PHY device is coming up, and the ethernet driver is
92 * not ready. PHY drivers may set this in the probe function.
93 * If they do, they are responsible for making sure the state is
94 * eventually set to indicate whether the PHY is UP or READY,
95 * depending on the state when the PHY is done starting up.
96 * - PHY driver will set the state to READY
97 * - start will set the state to PENDING
99 * READY: PHY is ready to send and receive packets, but the
100 * controller is not. By default, PHYs which do not implement
101 * probe will be set to this state by phy_probe(). If the PHY
102 * driver knows the PHY is ready, and the PHY state is STARTING,
103 * then it sets this STATE.
104 * - start will set the state to UP
106 * PENDING: PHY device is coming up, but the ethernet driver is
107 * ready. phy_start will set this state if the PHY state is
109 * - PHY driver will set the state to UP when the PHY is ready
111 * UP: The PHY and attached device are ready to do work.
112 * Interrupts should be started here.
113 * - timer moves to AN
115 * AN: The PHY is currently negotiating the link state. Link is
116 * therefore down for now. phy_timer will set this state when it
117 * detects the state is UP. config_aneg will set this state
118 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
119 * - If autonegotiation finishes, but there's no link, it sets
120 * the state to NOLINK.
121 * - If aneg finishes with link, it sets the state to RUNNING,
122 * and calls adjust_link
123 * - If autonegotiation did not finish after an arbitrary amount
124 * of time, autonegotiation should be tried again if the PHY
125 * supports "magic" autonegotiation (back to AN)
126 * - If it didn't finish, and no magic_aneg, move to FORCING.
128 * NOLINK: PHY is up, but not currently plugged in.
129 * - If the timer notes that the link comes back, we move to RUNNING
130 * - config_aneg moves to AN
131 * - phy_stop moves to HALTED
133 * FORCING: PHY is being configured with forced settings
134 * - if link is up, move to RUNNING
135 * - If link is down, we drop to the next highest setting, and
136 * retry (FORCING) after a timeout
137 * - phy_stop moves to HALTED
139 * RUNNING: PHY is currently up, running, and possibly sending
140 * and/or receiving packets
141 * - timer will set CHANGELINK if we're polling (this ensures the
142 * link state is polled every other cycle of this state machine,
143 * which makes it every other second)
144 * - irq will set CHANGELINK
145 * - config_aneg will set AN
146 * - phy_stop moves to HALTED
148 * CHANGELINK: PHY experienced a change in link state
149 * - timer moves to RUNNING if link
150 * - timer moves to NOLINK if the link is down
151 * - phy_stop moves to HALTED
153 * HALTED: PHY is up, but no polling or interrupts are done. Or
154 * PHY is in an error state.
156 * - phy_start moves to RESUMING
158 * RESUMING: PHY was halted, but now wants to run again.
159 * - If we are forcing, or aneg is done, timer moves to RUNNING
160 * - If aneg is not done, timer moves to AN
161 * - phy_stop moves to HALTED
178 /* phy_device: An instance of a PHY
180 * drv: Pointer to the driver for this PHY instance
181 * bus: Pointer to the bus this PHY is on
182 * dev: driver model device structure for this PHY
183 * phy_id: UID for this device found during discovery
184 * state: state of the PHY for management purposes
185 * dev_flags: Device-specific flags used by the PHY driver.
186 * addr: Bus address of PHY
187 * link_timeout: The number of timer firings to wait before the
188 * giving up on the current attempt at acquiring a link
189 * irq: IRQ number of the PHY's interrupt (-1 if none)
190 * phy_timer: The timer for handling the state machine
191 * phy_queue: A work_queue for the interrupt
192 * attached_dev: The attached enet driver's device instance ptr
193 * adjust_link: Callback for the enet controller to respond to
194 * changes in the link state.
195 * adjust_state: Callback for the enet driver to respond to
196 * changes in the state machine.
198 * speed, duplex, pause, supported, advertising, and
199 * autoneg are used like in mii_if_info
201 * interrupts currently only supports enabled or disabled,
202 * but could be changed in the future to support enabling
203 * and disabling specific interrupts
205 * Contains some infrastructure for polling and interrupt
206 * handling, as well as handling shifts in PHY hardware state
209 /* Information about the PHY type */
210 /* And management functions */
211 struct phy_driver *drv;
219 enum phy_state state;
223 /* Bus address of the PHY (0-32) */
226 /* forced speed & duplex (no autoneg)
227 * partner speed & duplex & pause (autoneg)
234 /* The most recently read link state */
237 /* Enabled Interrupts */
240 /* Union of PHY and Attached devices' supported modes */
241 /* See mii.h for more info */
249 /* Interrupt number for this PHY
250 * -1 means no interrupt */
253 /* private data pointer */
254 /* For use by PHYs to maintain extra state */
257 /* Interrupt and Polling infrastructure */
258 struct work_struct phy_queue;
259 struct timer_list phy_timer;
263 struct net_device *attached_dev;
265 void (*adjust_link)(struct net_device *dev);
267 void (*adjust_state)(struct net_device *dev);
269 #define to_phy_device(d) container_of(d, struct phy_device, dev)
271 /* struct phy_driver: Driver structure for a particular PHY type
273 * phy_id: The result of reading the UID registers of this PHY
274 * type, and ANDing them with the phy_id_mask. This driver
275 * only works for PHYs with IDs which match this field
276 * name: The friendly name of this PHY type
277 * phy_id_mask: Defines the important bits of the phy_id
278 * features: A list of features (speed, duplex, etc) supported
280 * flags: A bitfield defining certain other features this PHY
281 * supports (like interrupts)
283 * The drivers must implement config_aneg and read_status. All
284 * other functions are optional. Note that none of these
285 * functions should be called from interrupt time. The goal is
286 * for the bus read/write functions to be able to block when the
287 * bus transaction is happening, and be freed up by an interrupt
288 * (The MPC85xx has this ability, though it is not currently
289 * supported in the driver).
294 unsigned int phy_id_mask;
298 /* Called to initialize the PHY,
299 * including after a reset */
300 int (*config_init)(struct phy_device *phydev);
302 /* Called during discovery. Used to set
303 * up device-specific structures, if any */
304 int (*probe)(struct phy_device *phydev);
306 /* PHY Power Management */
307 int (*suspend)(struct phy_device *phydev);
308 int (*resume)(struct phy_device *phydev);
310 /* Configures the advertisement and resets
311 * autonegotiation if phydev->autoneg is on,
312 * forces the speed to the current settings in phydev
313 * if phydev->autoneg is off */
314 int (*config_aneg)(struct phy_device *phydev);
316 /* Determines the negotiated speed and duplex */
317 int (*read_status)(struct phy_device *phydev);
319 /* Clears any pending interrupts */
320 int (*ack_interrupt)(struct phy_device *phydev);
322 /* Enables or disables interrupts */
323 int (*config_intr)(struct phy_device *phydev);
325 /* Clears up any memory if needed */
326 void (*remove)(struct phy_device *phydev);
328 struct device_driver driver;
330 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
332 int phy_read(struct phy_device *phydev, u16 regnum);
333 int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
334 struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
335 int phy_clear_interrupt(struct phy_device *phydev);
336 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
337 struct phy_device * phy_attach(struct net_device *dev,
338 const char *phy_id, u32 flags);
339 struct phy_device * phy_connect(struct net_device *dev, const char *phy_id,
340 void (*handler)(struct net_device *), u32 flags);
341 void phy_disconnect(struct phy_device *phydev);
342 void phy_detach(struct phy_device *phydev);
343 void phy_start(struct phy_device *phydev);
344 void phy_stop(struct phy_device *phydev);
345 int phy_start_aneg(struct phy_device *phydev);
347 int mdiobus_register(struct mii_bus *bus);
348 void mdiobus_unregister(struct mii_bus *bus);
349 void phy_sanitize_settings(struct phy_device *phydev);
350 int phy_stop_interrupts(struct phy_device *phydev);
352 static inline int phy_read_status(struct phy_device *phydev) {
353 return phydev->drv->read_status(phydev);
356 int genphy_config_advert(struct phy_device *phydev);
357 int genphy_setup_forced(struct phy_device *phydev);
358 int genphy_restart_aneg(struct phy_device *phydev);
359 int genphy_config_aneg(struct phy_device *phydev);
360 int genphy_update_link(struct phy_device *phydev);
361 int genphy_read_status(struct phy_device *phydev);
362 void phy_driver_unregister(struct phy_driver *drv);
363 int phy_driver_register(struct phy_driver *new_driver);
364 void phy_prepare_link(struct phy_device *phydev,
365 void (*adjust_link)(struct net_device *));
366 void phy_start_machine(struct phy_device *phydev,
367 void (*handler)(struct net_device *));
368 void phy_stop_machine(struct phy_device *phydev);
369 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
370 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
371 int phy_mii_ioctl(struct phy_device *phydev,
372 struct mii_ioctl_data *mii_data, int cmd);
373 int phy_start_interrupts(struct phy_device *phydev);
374 void phy_print_status(struct phy_device *phydev);
376 extern struct bus_type mdio_bus_type;