]>
Commit | Line | Data |
---|---|---|
00db8189 AF |
1 | /* |
2 | * include/linux/phy.h | |
3 | * | |
4 | * Framework and drivers for configuring and reading different PHYs | |
5 | * Based on code in sungem_phy.c and gianfar_phy.c | |
6 | * | |
7 | * Author: Andy Fleming | |
8 | * | |
9 | * Copyright (c) 2004 Freescale Semiconductor, Inc. | |
10 | * | |
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. | |
15 | * | |
16 | */ | |
17 | ||
18 | #ifndef __PHY_H | |
19 | #define __PHY_H | |
20 | ||
21 | #include <linux/spinlock.h> | |
22 | #include <linux/device.h> | |
23 | ||
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) | |
31 | ||
32 | #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \ | |
33 | SUPPORTED_1000baseT_Half | \ | |
34 | SUPPORTED_1000baseT_Full) | |
35 | ||
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 | |
39 | */ | |
40 | #define PHY_POLL -1 | |
41 | #define PHY_IGNORE_INTERRUPT -2 | |
42 | ||
43 | #define PHY_HAS_INTERRUPT 0x00000001 | |
44 | #define PHY_HAS_MAGICANEG 0x00000002 | |
45 | ||
46 | #define MII_BUS_MAX 4 | |
47 | ||
48 | ||
49 | #define PHY_INIT_TIMEOUT 100000 | |
50 | #define PHY_STATE_TIME 1 | |
51 | #define PHY_FORCE_TIMEOUT 10 | |
52 | #define PHY_AN_TIMEOUT 10 | |
53 | ||
54 | #define PHY_MAX_ADDR 32 | |
55 | ||
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); | |
65 | ||
66 | /* A lock to ensure that only one thing can read/write | |
67 | * the MDIO bus at a time */ | |
68 | spinlock_t mdio_lock; | |
69 | ||
70 | struct device *dev; | |
71 | ||
72 | /* list of all PHYs on bus */ | |
73 | struct phy_device *phy_map[PHY_MAX_ADDR]; | |
74 | ||
75 | /* Pointer to an array of interrupts, each PHY's | |
76 | * interrupt at the index matching its address */ | |
77 | int *irq; | |
78 | }; | |
79 | ||
80 | #define PHY_INTERRUPT_DISABLED 0x0 | |
81 | #define PHY_INTERRUPT_ENABLED 0x80000000 | |
82 | ||
83 | /* PHY state machine states: | |
84 | * | |
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 | |
90 | * | |
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 | |
98 | * | |
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 | |
105 | * | |
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 | |
108 | * STARTING. | |
109 | * - PHY driver will set the state to UP when the PHY is ready | |
110 | * | |
111 | * UP: The PHY and attached device are ready to do work. | |
112 | * Interrupts should be started here. | |
113 | * - timer moves to AN | |
114 | * | |
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. | |
127 | * | |
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 | |
132 | * | |
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 | |
138 | * | |
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 | |
147 | * | |
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 | |
152 | * | |
153 | * HALTED: PHY is up, but no polling or interrupts are done. Or | |
154 | * PHY is in an error state. | |
155 | * | |
156 | * - phy_start moves to RESUMING | |
157 | * | |
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 | |
162 | */ | |
163 | enum phy_state { | |
164 | PHY_DOWN=0, | |
165 | PHY_STARTING, | |
166 | PHY_READY, | |
167 | PHY_PENDING, | |
168 | PHY_UP, | |
169 | PHY_AN, | |
170 | PHY_RUNNING, | |
171 | PHY_NOLINK, | |
172 | PHY_FORCING, | |
173 | PHY_CHANGELINK, | |
174 | PHY_HALTED, | |
175 | PHY_RESUMING | |
176 | }; | |
177 | ||
178 | /* phy_device: An instance of a PHY | |
179 | * | |
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. | |
197 | * | |
198 | * speed, duplex, pause, supported, advertising, and | |
199 | * autoneg are used like in mii_if_info | |
200 | * | |
201 | * interrupts currently only supports enabled or disabled, | |
202 | * but could be changed in the future to support enabling | |
203 | * and disabling specific interrupts | |
204 | * | |
205 | * Contains some infrastructure for polling and interrupt | |
206 | * handling, as well as handling shifts in PHY hardware state | |
207 | */ | |
208 | struct phy_device { | |
209 | /* Information about the PHY type */ | |
210 | /* And management functions */ | |
211 | struct phy_driver *drv; | |
212 | ||
213 | struct mii_bus *bus; | |
214 | ||
215 | struct device dev; | |
216 | ||
217 | u32 phy_id; | |
218 | ||
219 | enum phy_state state; | |
220 | ||
221 | u32 dev_flags; | |
222 | ||
223 | /* Bus address of the PHY (0-32) */ | |
224 | int addr; | |
225 | ||
226 | /* forced speed & duplex (no autoneg) | |
227 | * partner speed & duplex & pause (autoneg) | |
228 | */ | |
229 | int speed; | |
230 | int duplex; | |
231 | int pause; | |
232 | int asym_pause; | |
233 | ||
234 | /* The most recently read link state */ | |
235 | int link; | |
236 | ||
237 | /* Enabled Interrupts */ | |
238 | u32 interrupts; | |
239 | ||
240 | /* Union of PHY and Attached devices' supported modes */ | |
241 | /* See mii.h for more info */ | |
242 | u32 supported; | |
243 | u32 advertising; | |
244 | ||
245 | int autoneg; | |
246 | ||
247 | int link_timeout; | |
248 | ||
249 | /* Interrupt number for this PHY | |
250 | * -1 means no interrupt */ | |
251 | int irq; | |
252 | ||
253 | /* private data pointer */ | |
254 | /* For use by PHYs to maintain extra state */ | |
255 | void *priv; | |
256 | ||
257 | /* Interrupt and Polling infrastructure */ | |
258 | struct work_struct phy_queue; | |
259 | struct timer_list phy_timer; | |
260 | ||
261 | spinlock_t lock; | |
262 | ||
263 | struct net_device *attached_dev; | |
264 | ||
265 | void (*adjust_link)(struct net_device *dev); | |
266 | ||
267 | void (*adjust_state)(struct net_device *dev); | |
268 | }; | |
269 | #define to_phy_device(d) container_of(d, struct phy_device, dev) | |
270 | ||
271 | /* struct phy_driver: Driver structure for a particular PHY type | |
272 | * | |
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 | |
279 | * by this PHY | |
280 | * flags: A bitfield defining certain other features this PHY | |
281 | * supports (like interrupts) | |
282 | * | |
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). | |
290 | */ | |
291 | struct phy_driver { | |
292 | u32 phy_id; | |
293 | char *name; | |
294 | unsigned int phy_id_mask; | |
295 | u32 features; | |
296 | u32 flags; | |
297 | ||
298 | /* Called to initialize the PHY, | |
299 | * including after a reset */ | |
300 | int (*config_init)(struct phy_device *phydev); | |
301 | ||
302 | /* Called during discovery. Used to set | |
303 | * up device-specific structures, if any */ | |
304 | int (*probe)(struct phy_device *phydev); | |
305 | ||
306 | /* PHY Power Management */ | |
307 | int (*suspend)(struct phy_device *phydev); | |
308 | int (*resume)(struct phy_device *phydev); | |
309 | ||
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); | |
315 | ||
316 | /* Determines the negotiated speed and duplex */ | |
317 | int (*read_status)(struct phy_device *phydev); | |
318 | ||
319 | /* Clears any pending interrupts */ | |
320 | int (*ack_interrupt)(struct phy_device *phydev); | |
321 | ||
322 | /* Enables or disables interrupts */ | |
323 | int (*config_intr)(struct phy_device *phydev); | |
324 | ||
325 | /* Clears up any memory if needed */ | |
326 | void (*remove)(struct phy_device *phydev); | |
327 | ||
328 | struct device_driver driver; | |
329 | }; | |
330 | #define to_phy_driver(d) container_of(d, struct phy_driver, driver) | |
331 | ||
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); | |
e1393456 AF |
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); | |
346 | ||
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); | |
00db8189 AF |
351 | |
352 | static inline int phy_read_status(struct phy_device *phydev) { | |
353 | return phydev->drv->read_status(phydev); | |
354 | } | |
355 | ||
e1393456 | 356 | int genphy_config_advert(struct phy_device *phydev); |
00db8189 AF |
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); | |
e1393456 AF |
373 | int phy_start_interrupts(struct phy_device *phydev); |
374 | void phy_print_status(struct phy_device *phydev); | |
00db8189 AF |
375 | |
376 | extern struct bus_type mdio_bus_type; | |
00db8189 | 377 | #endif /* __PHY_H */ |