Linux v2.6.15-rc6
[pohmelfs.git] / include / linux / phy.h
blob92a9696fdebe0ecb7bad1922bffe3c8e360026d5
1 /*
2 * include/linux/phy.h
4 * Framework and drivers for configuring and reading different PHYs
5 * Based on code in sungem_phy.c and gianfar_phy.c
7 * Author: Andy Fleming
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.
18 #ifndef __PHY_H
19 #define __PHY_H
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 | \
28 SUPPORTED_Autoneg | \
29 SUPPORTED_TP | \
30 SUPPORTED_MII)
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
40 #define PHY_POLL -1
41 #define PHY_IGNORE_INTERRUPT -2
43 #define PHY_HAS_INTERRUPT 0x00000001
44 #define PHY_HAS_MAGICANEG 0x00000002
46 #define MII_BUS_MAX 4
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 */
58 struct mii_bus {
59 const char *name;
60 int id;
61 void *priv;
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 */
68 spinlock_t mdio_lock;
70 struct device *dev;
72 /* list of all PHYs on bus */
73 struct phy_device *phy_map[PHY_MAX_ADDR];
75 /* Phy addresses to be ignored when probing */
76 u32 phy_mask;
78 /* Pointer to an array of interrupts, each PHY's
79 * interrupt at the index matching its address */
80 int *irq;
83 #define PHY_INTERRUPT_DISABLED 0x0
84 #define PHY_INTERRUPT_ENABLED 0x80000000
86 /* PHY state machine states:
88 * DOWN: PHY device and driver are not ready for anything. probe
89 * should be called if and only if the PHY is in this state,
90 * given that the PHY device exists.
91 * - PHY driver probe function will, depending on the PHY, set
92 * the state to STARTING or READY
94 * STARTING: PHY device is coming up, and the ethernet driver is
95 * not ready. PHY drivers may set this in the probe function.
96 * If they do, they are responsible for making sure the state is
97 * eventually set to indicate whether the PHY is UP or READY,
98 * depending on the state when the PHY is done starting up.
99 * - PHY driver will set the state to READY
100 * - start will set the state to PENDING
102 * READY: PHY is ready to send and receive packets, but the
103 * controller is not. By default, PHYs which do not implement
104 * probe will be set to this state by phy_probe(). If the PHY
105 * driver knows the PHY is ready, and the PHY state is STARTING,
106 * then it sets this STATE.
107 * - start will set the state to UP
109 * PENDING: PHY device is coming up, but the ethernet driver is
110 * ready. phy_start will set this state if the PHY state is
111 * STARTING.
112 * - PHY driver will set the state to UP when the PHY is ready
114 * UP: The PHY and attached device are ready to do work.
115 * Interrupts should be started here.
116 * - timer moves to AN
118 * AN: The PHY is currently negotiating the link state. Link is
119 * therefore down for now. phy_timer will set this state when it
120 * detects the state is UP. config_aneg will set this state
121 * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
122 * - If autonegotiation finishes, but there's no link, it sets
123 * the state to NOLINK.
124 * - If aneg finishes with link, it sets the state to RUNNING,
125 * and calls adjust_link
126 * - If autonegotiation did not finish after an arbitrary amount
127 * of time, autonegotiation should be tried again if the PHY
128 * supports "magic" autonegotiation (back to AN)
129 * - If it didn't finish, and no magic_aneg, move to FORCING.
131 * NOLINK: PHY is up, but not currently plugged in.
132 * - If the timer notes that the link comes back, we move to RUNNING
133 * - config_aneg moves to AN
134 * - phy_stop moves to HALTED
136 * FORCING: PHY is being configured with forced settings
137 * - if link is up, move to RUNNING
138 * - If link is down, we drop to the next highest setting, and
139 * retry (FORCING) after a timeout
140 * - phy_stop moves to HALTED
142 * RUNNING: PHY is currently up, running, and possibly sending
143 * and/or receiving packets
144 * - timer will set CHANGELINK if we're polling (this ensures the
145 * link state is polled every other cycle of this state machine,
146 * which makes it every other second)
147 * - irq will set CHANGELINK
148 * - config_aneg will set AN
149 * - phy_stop moves to HALTED
151 * CHANGELINK: PHY experienced a change in link state
152 * - timer moves to RUNNING if link
153 * - timer moves to NOLINK if the link is down
154 * - phy_stop moves to HALTED
156 * HALTED: PHY is up, but no polling or interrupts are done. Or
157 * PHY is in an error state.
159 * - phy_start moves to RESUMING
161 * RESUMING: PHY was halted, but now wants to run again.
162 * - If we are forcing, or aneg is done, timer moves to RUNNING
163 * - If aneg is not done, timer moves to AN
164 * - phy_stop moves to HALTED
166 enum phy_state {
167 PHY_DOWN=0,
168 PHY_STARTING,
169 PHY_READY,
170 PHY_PENDING,
171 PHY_UP,
172 PHY_AN,
173 PHY_RUNNING,
174 PHY_NOLINK,
175 PHY_FORCING,
176 PHY_CHANGELINK,
177 PHY_HALTED,
178 PHY_RESUMING
181 /* phy_device: An instance of a PHY
183 * drv: Pointer to the driver for this PHY instance
184 * bus: Pointer to the bus this PHY is on
185 * dev: driver model device structure for this PHY
186 * phy_id: UID for this device found during discovery
187 * state: state of the PHY for management purposes
188 * dev_flags: Device-specific flags used by the PHY driver.
189 * addr: Bus address of PHY
190 * link_timeout: The number of timer firings to wait before the
191 * giving up on the current attempt at acquiring a link
192 * irq: IRQ number of the PHY's interrupt (-1 if none)
193 * phy_timer: The timer for handling the state machine
194 * phy_queue: A work_queue for the interrupt
195 * attached_dev: The attached enet driver's device instance ptr
196 * adjust_link: Callback for the enet controller to respond to
197 * changes in the link state.
198 * adjust_state: Callback for the enet driver to respond to
199 * changes in the state machine.
201 * speed, duplex, pause, supported, advertising, and
202 * autoneg are used like in mii_if_info
204 * interrupts currently only supports enabled or disabled,
205 * but could be changed in the future to support enabling
206 * and disabling specific interrupts
208 * Contains some infrastructure for polling and interrupt
209 * handling, as well as handling shifts in PHY hardware state
211 struct phy_device {
212 /* Information about the PHY type */
213 /* And management functions */
214 struct phy_driver *drv;
216 struct mii_bus *bus;
218 struct device dev;
220 u32 phy_id;
222 enum phy_state state;
224 u32 dev_flags;
226 /* Bus address of the PHY (0-32) */
227 int addr;
229 /* forced speed & duplex (no autoneg)
230 * partner speed & duplex & pause (autoneg)
232 int speed;
233 int duplex;
234 int pause;
235 int asym_pause;
237 /* The most recently read link state */
238 int link;
240 /* Enabled Interrupts */
241 u32 interrupts;
243 /* Union of PHY and Attached devices' supported modes */
244 /* See mii.h for more info */
245 u32 supported;
246 u32 advertising;
248 int autoneg;
250 int link_timeout;
252 /* Interrupt number for this PHY
253 * -1 means no interrupt */
254 int irq;
256 /* private data pointer */
257 /* For use by PHYs to maintain extra state */
258 void *priv;
260 /* Interrupt and Polling infrastructure */
261 struct work_struct phy_queue;
262 struct timer_list phy_timer;
264 spinlock_t lock;
266 struct net_device *attached_dev;
268 void (*adjust_link)(struct net_device *dev);
270 void (*adjust_state)(struct net_device *dev);
272 #define to_phy_device(d) container_of(d, struct phy_device, dev)
274 /* struct phy_driver: Driver structure for a particular PHY type
276 * phy_id: The result of reading the UID registers of this PHY
277 * type, and ANDing them with the phy_id_mask. This driver
278 * only works for PHYs with IDs which match this field
279 * name: The friendly name of this PHY type
280 * phy_id_mask: Defines the important bits of the phy_id
281 * features: A list of features (speed, duplex, etc) supported
282 * by this PHY
283 * flags: A bitfield defining certain other features this PHY
284 * supports (like interrupts)
286 * The drivers must implement config_aneg and read_status. All
287 * other functions are optional. Note that none of these
288 * functions should be called from interrupt time. The goal is
289 * for the bus read/write functions to be able to block when the
290 * bus transaction is happening, and be freed up by an interrupt
291 * (The MPC85xx has this ability, though it is not currently
292 * supported in the driver).
294 struct phy_driver {
295 u32 phy_id;
296 char *name;
297 unsigned int phy_id_mask;
298 u32 features;
299 u32 flags;
301 /* Called to initialize the PHY,
302 * including after a reset */
303 int (*config_init)(struct phy_device *phydev);
305 /* Called during discovery. Used to set
306 * up device-specific structures, if any */
307 int (*probe)(struct phy_device *phydev);
309 /* PHY Power Management */
310 int (*suspend)(struct phy_device *phydev);
311 int (*resume)(struct phy_device *phydev);
313 /* Configures the advertisement and resets
314 * autonegotiation if phydev->autoneg is on,
315 * forces the speed to the current settings in phydev
316 * if phydev->autoneg is off */
317 int (*config_aneg)(struct phy_device *phydev);
319 /* Determines the negotiated speed and duplex */
320 int (*read_status)(struct phy_device *phydev);
322 /* Clears any pending interrupts */
323 int (*ack_interrupt)(struct phy_device *phydev);
325 /* Enables or disables interrupts */
326 int (*config_intr)(struct phy_device *phydev);
328 /* Clears up any memory if needed */
329 void (*remove)(struct phy_device *phydev);
331 struct device_driver driver;
333 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
335 int phy_read(struct phy_device *phydev, u16 regnum);
336 int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
337 struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
338 int phy_clear_interrupt(struct phy_device *phydev);
339 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
340 struct phy_device * phy_attach(struct net_device *dev,
341 const char *phy_id, u32 flags);
342 struct phy_device * phy_connect(struct net_device *dev, const char *phy_id,
343 void (*handler)(struct net_device *), u32 flags);
344 void phy_disconnect(struct phy_device *phydev);
345 void phy_detach(struct phy_device *phydev);
346 void phy_start(struct phy_device *phydev);
347 void phy_stop(struct phy_device *phydev);
348 int phy_start_aneg(struct phy_device *phydev);
350 int mdiobus_register(struct mii_bus *bus);
351 void mdiobus_unregister(struct mii_bus *bus);
352 void phy_sanitize_settings(struct phy_device *phydev);
353 int phy_stop_interrupts(struct phy_device *phydev);
355 static inline int phy_read_status(struct phy_device *phydev) {
356 return phydev->drv->read_status(phydev);
359 int genphy_config_advert(struct phy_device *phydev);
360 int genphy_setup_forced(struct phy_device *phydev);
361 int genphy_restart_aneg(struct phy_device *phydev);
362 int genphy_config_aneg(struct phy_device *phydev);
363 int genphy_update_link(struct phy_device *phydev);
364 int genphy_read_status(struct phy_device *phydev);
365 void phy_driver_unregister(struct phy_driver *drv);
366 int phy_driver_register(struct phy_driver *new_driver);
367 void phy_prepare_link(struct phy_device *phydev,
368 void (*adjust_link)(struct net_device *));
369 void phy_start_machine(struct phy_device *phydev,
370 void (*handler)(struct net_device *));
371 void phy_stop_machine(struct phy_device *phydev);
372 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
373 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
374 int phy_mii_ioctl(struct phy_device *phydev,
375 struct mii_ioctl_data *mii_data, int cmd);
376 int phy_start_interrupts(struct phy_device *phydev);
377 void phy_print_status(struct phy_device *phydev);
379 extern struct bus_type mdio_bus_type;
380 #endif /* __PHY_H */