phylib: Add support for board-level PHY fixups
[linux-2.6.git] / include / linux / phy.h
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 #include <linux/ethtool.h>
24 #include <linux/mii.h>
25 #include <linux/timer.h>
26 #include <linux/workqueue.h>
27
28 #include <asm/atomic.h>
29
30 #define PHY_BASIC_FEATURES      (SUPPORTED_10baseT_Half | \
31                                  SUPPORTED_10baseT_Full | \
32                                  SUPPORTED_100baseT_Half | \
33                                  SUPPORTED_100baseT_Full | \
34                                  SUPPORTED_Autoneg | \
35                                  SUPPORTED_TP | \
36                                  SUPPORTED_MII)
37
38 #define PHY_GBIT_FEATURES       (PHY_BASIC_FEATURES | \
39                                  SUPPORTED_1000baseT_Half | \
40                                  SUPPORTED_1000baseT_Full)
41
42 /*
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
46  */
47 #define PHY_POLL                -1
48 #define PHY_IGNORE_INTERRUPT    -2
49
50 #define PHY_HAS_INTERRUPT       0x00000001
51 #define PHY_HAS_MAGICANEG       0x00000002
52
53 /* Interface Mode definitions */
54 typedef enum {
55         PHY_INTERFACE_MODE_MII,
56         PHY_INTERFACE_MODE_GMII,
57         PHY_INTERFACE_MODE_SGMII,
58         PHY_INTERFACE_MODE_TBI,
59         PHY_INTERFACE_MODE_RMII,
60         PHY_INTERFACE_MODE_RGMII,
61         PHY_INTERFACE_MODE_RGMII_ID,
62         PHY_INTERFACE_MODE_RGMII_RXID,
63         PHY_INTERFACE_MODE_RGMII_TXID,
64         PHY_INTERFACE_MODE_RTBI
65 } phy_interface_t;
66
67
68 #define PHY_INIT_TIMEOUT        100000
69 #define PHY_STATE_TIME          1
70 #define PHY_FORCE_TIMEOUT       10
71 #define PHY_AN_TIMEOUT          10
72
73 #define PHY_MAX_ADDR    32
74
75 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
76 #define PHY_ID_FMT "%s:%02x"
77
78 /*
79  * Need to be a little smaller than phydev->dev.bus_id to leave room
80  * for the ":%02x"
81  */
82 #define MII_BUS_ID_SIZE (BUS_ID_SIZE - 3)
83
84 /*
85  * The Bus class for PHYs.  Devices which provide access to
86  * PHYs should register using this structure
87  */
88 struct mii_bus {
89         const char *name;
90         char id[MII_BUS_ID_SIZE];
91         void *priv;
92         int (*read)(struct mii_bus *bus, int phy_id, int regnum);
93         int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
94         int (*reset)(struct mii_bus *bus);
95
96         /*
97          * A lock to ensure that only one thing can read/write
98          * the MDIO bus at a time
99          */
100         struct mutex mdio_lock;
101
102         struct device *dev;
103
104         /* list of all PHYs on bus */
105         struct phy_device *phy_map[PHY_MAX_ADDR];
106
107         /* Phy addresses to be ignored when probing */
108         u32 phy_mask;
109
110         /*
111          * Pointer to an array of interrupts, each PHY's
112          * interrupt at the index matching its address
113          */
114         int *irq;
115 };
116
117 #define PHY_INTERRUPT_DISABLED  0x0
118 #define PHY_INTERRUPT_ENABLED   0x80000000
119
120 /* PHY state machine states:
121  *
122  * DOWN: PHY device and driver are not ready for anything.  probe
123  * should be called if and only if the PHY is in this state,
124  * given that the PHY device exists.
125  * - PHY driver probe function will, depending on the PHY, set
126  * the state to STARTING or READY
127  *
128  * STARTING:  PHY device is coming up, and the ethernet driver is
129  * not ready.  PHY drivers may set this in the probe function.
130  * If they do, they are responsible for making sure the state is
131  * eventually set to indicate whether the PHY is UP or READY,
132  * depending on the state when the PHY is done starting up.
133  * - PHY driver will set the state to READY
134  * - start will set the state to PENDING
135  *
136  * READY: PHY is ready to send and receive packets, but the
137  * controller is not.  By default, PHYs which do not implement
138  * probe will be set to this state by phy_probe().  If the PHY
139  * driver knows the PHY is ready, and the PHY state is STARTING,
140  * then it sets this STATE.
141  * - start will set the state to UP
142  *
143  * PENDING: PHY device is coming up, but the ethernet driver is
144  * ready.  phy_start will set this state if the PHY state is
145  * STARTING.
146  * - PHY driver will set the state to UP when the PHY is ready
147  *
148  * UP: The PHY and attached device are ready to do work.
149  * Interrupts should be started here.
150  * - timer moves to AN
151  *
152  * AN: The PHY is currently negotiating the link state.  Link is
153  * therefore down for now.  phy_timer will set this state when it
154  * detects the state is UP.  config_aneg will set this state
155  * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
156  * - If autonegotiation finishes, but there's no link, it sets
157  *   the state to NOLINK.
158  * - If aneg finishes with link, it sets the state to RUNNING,
159  *   and calls adjust_link
160  * - If autonegotiation did not finish after an arbitrary amount
161  *   of time, autonegotiation should be tried again if the PHY
162  *   supports "magic" autonegotiation (back to AN)
163  * - If it didn't finish, and no magic_aneg, move to FORCING.
164  *
165  * NOLINK: PHY is up, but not currently plugged in.
166  * - If the timer notes that the link comes back, we move to RUNNING
167  * - config_aneg moves to AN
168  * - phy_stop moves to HALTED
169  *
170  * FORCING: PHY is being configured with forced settings
171  * - if link is up, move to RUNNING
172  * - If link is down, we drop to the next highest setting, and
173  *   retry (FORCING) after a timeout
174  * - phy_stop moves to HALTED
175  *
176  * RUNNING: PHY is currently up, running, and possibly sending
177  * and/or receiving packets
178  * - timer will set CHANGELINK if we're polling (this ensures the
179  *   link state is polled every other cycle of this state machine,
180  *   which makes it every other second)
181  * - irq will set CHANGELINK
182  * - config_aneg will set AN
183  * - phy_stop moves to HALTED
184  *
185  * CHANGELINK: PHY experienced a change in link state
186  * - timer moves to RUNNING if link
187  * - timer moves to NOLINK if the link is down
188  * - phy_stop moves to HALTED
189  *
190  * HALTED: PHY is up, but no polling or interrupts are done. Or
191  * PHY is in an error state.
192  *
193  * - phy_start moves to RESUMING
194  *
195  * RESUMING: PHY was halted, but now wants to run again.
196  * - If we are forcing, or aneg is done, timer moves to RUNNING
197  * - If aneg is not done, timer moves to AN
198  * - phy_stop moves to HALTED
199  */
200 enum phy_state {
201         PHY_DOWN=0,
202         PHY_STARTING,
203         PHY_READY,
204         PHY_PENDING,
205         PHY_UP,
206         PHY_AN,
207         PHY_RUNNING,
208         PHY_NOLINK,
209         PHY_FORCING,
210         PHY_CHANGELINK,
211         PHY_HALTED,
212         PHY_RESUMING
213 };
214
215 /* phy_device: An instance of a PHY
216  *
217  * drv: Pointer to the driver for this PHY instance
218  * bus: Pointer to the bus this PHY is on
219  * dev: driver model device structure for this PHY
220  * phy_id: UID for this device found during discovery
221  * state: state of the PHY for management purposes
222  * dev_flags: Device-specific flags used by the PHY driver.
223  * addr: Bus address of PHY
224  * link_timeout: The number of timer firings to wait before the
225  * giving up on the current attempt at acquiring a link
226  * irq: IRQ number of the PHY's interrupt (-1 if none)
227  * phy_timer: The timer for handling the state machine
228  * phy_queue: A work_queue for the interrupt
229  * attached_dev: The attached enet driver's device instance ptr
230  * adjust_link: Callback for the enet controller to respond to
231  * changes in the link state.
232  * adjust_state: Callback for the enet driver to respond to
233  * changes in the state machine.
234  *
235  * speed, duplex, pause, supported, advertising, and
236  * autoneg are used like in mii_if_info
237  *
238  * interrupts currently only supports enabled or disabled,
239  * but could be changed in the future to support enabling
240  * and disabling specific interrupts
241  *
242  * Contains some infrastructure for polling and interrupt
243  * handling, as well as handling shifts in PHY hardware state
244  */
245 struct phy_device {
246         /* Information about the PHY type */
247         /* And management functions */
248         struct phy_driver *drv;
249
250         struct mii_bus *bus;
251
252         struct device dev;
253
254         u32 phy_id;
255
256         enum phy_state state;
257
258         u32 dev_flags;
259
260         phy_interface_t interface;
261
262         /* Bus address of the PHY (0-32) */
263         int addr;
264
265         /*
266          * forced speed & duplex (no autoneg)
267          * partner speed & duplex & pause (autoneg)
268          */
269         int speed;
270         int duplex;
271         int pause;
272         int asym_pause;
273
274         /* The most recently read link state */
275         int link;
276
277         /* Enabled Interrupts */
278         u32 interrupts;
279
280         /* Union of PHY and Attached devices' supported modes */
281         /* See mii.h for more info */
282         u32 supported;
283         u32 advertising;
284
285         int autoneg;
286
287         int link_timeout;
288
289         /*
290          * Interrupt number for this PHY
291          * -1 means no interrupt
292          */
293         int irq;
294
295         /* private data pointer */
296         /* For use by PHYs to maintain extra state */
297         void *priv;
298
299         /* Interrupt and Polling infrastructure */
300         struct work_struct phy_queue;
301         struct work_struct state_queue;
302         struct timer_list phy_timer;
303         atomic_t irq_disable;
304
305         struct mutex lock;
306
307         struct net_device *attached_dev;
308
309         void (*adjust_link)(struct net_device *dev);
310
311         void (*adjust_state)(struct net_device *dev);
312 };
313 #define to_phy_device(d) container_of(d, struct phy_device, dev)
314
315 /* struct phy_driver: Driver structure for a particular PHY type
316  *
317  * phy_id: The result of reading the UID registers of this PHY
318  *   type, and ANDing them with the phy_id_mask.  This driver
319  *   only works for PHYs with IDs which match this field
320  * name: The friendly name of this PHY type
321  * phy_id_mask: Defines the important bits of the phy_id
322  * features: A list of features (speed, duplex, etc) supported
323  *   by this PHY
324  * flags: A bitfield defining certain other features this PHY
325  *   supports (like interrupts)
326  *
327  * The drivers must implement config_aneg and read_status.  All
328  * other functions are optional. Note that none of these
329  * functions should be called from interrupt time.  The goal is
330  * for the bus read/write functions to be able to block when the
331  * bus transaction is happening, and be freed up by an interrupt
332  * (The MPC85xx has this ability, though it is not currently
333  * supported in the driver).
334  */
335 struct phy_driver {
336         u32 phy_id;
337         char *name;
338         unsigned int phy_id_mask;
339         u32 features;
340         u32 flags;
341
342         /*
343          * Called to initialize the PHY,
344          * including after a reset
345          */
346         int (*config_init)(struct phy_device *phydev);
347
348         /*
349          * Called during discovery.  Used to set
350          * up device-specific structures, if any
351          */
352         int (*probe)(struct phy_device *phydev);
353
354         /* PHY Power Management */
355         int (*suspend)(struct phy_device *phydev);
356         int (*resume)(struct phy_device *phydev);
357
358         /*
359          * Configures the advertisement and resets
360          * autonegotiation if phydev->autoneg is on,
361          * forces the speed to the current settings in phydev
362          * if phydev->autoneg is off
363          */
364         int (*config_aneg)(struct phy_device *phydev);
365
366         /* Determines the negotiated speed and duplex */
367         int (*read_status)(struct phy_device *phydev);
368
369         /* Clears any pending interrupts */
370         int (*ack_interrupt)(struct phy_device *phydev);
371
372         /* Enables or disables interrupts */
373         int (*config_intr)(struct phy_device *phydev);
374
375         /* Clears up any memory if needed */
376         void (*remove)(struct phy_device *phydev);
377
378         struct device_driver driver;
379 };
380 #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
381
382 #define PHY_ANY_ID "MATCH ANY PHY"
383 #define PHY_ANY_UID 0xffffffff
384
385 /* A Structure for boards to register fixups with the PHY Lib */
386 struct phy_fixup {
387         struct list_head list;
388         char bus_id[BUS_ID_SIZE];
389         u32 phy_uid;
390         u32 phy_uid_mask;
391         int (*run)(struct phy_device *phydev);
392 };
393
394 int phy_read(struct phy_device *phydev, u16 regnum);
395 int phy_write(struct phy_device *phydev, u16 regnum, u16 val);
396 int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id);
397 struct phy_device* get_phy_device(struct mii_bus *bus, int addr);
398 int phy_clear_interrupt(struct phy_device *phydev);
399 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts);
400 struct phy_device * phy_attach(struct net_device *dev,
401                 const char *bus_id, u32 flags, phy_interface_t interface);
402 struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
403                 void (*handler)(struct net_device *), u32 flags,
404                 phy_interface_t interface);
405 void phy_disconnect(struct phy_device *phydev);
406 void phy_detach(struct phy_device *phydev);
407 void phy_start(struct phy_device *phydev);
408 void phy_stop(struct phy_device *phydev);
409 int phy_start_aneg(struct phy_device *phydev);
410
411 int mdiobus_register(struct mii_bus *bus);
412 void mdiobus_unregister(struct mii_bus *bus);
413 void phy_sanitize_settings(struct phy_device *phydev);
414 int phy_stop_interrupts(struct phy_device *phydev);
415
416 static inline int phy_read_status(struct phy_device *phydev) {
417         return phydev->drv->read_status(phydev);
418 }
419
420 int genphy_config_advert(struct phy_device *phydev);
421 int genphy_setup_forced(struct phy_device *phydev);
422 int genphy_restart_aneg(struct phy_device *phydev);
423 int genphy_config_aneg(struct phy_device *phydev);
424 int genphy_update_link(struct phy_device *phydev);
425 int genphy_read_status(struct phy_device *phydev);
426 void phy_driver_unregister(struct phy_driver *drv);
427 int phy_driver_register(struct phy_driver *new_driver);
428 void phy_prepare_link(struct phy_device *phydev,
429                 void (*adjust_link)(struct net_device *));
430 void phy_start_machine(struct phy_device *phydev,
431                 void (*handler)(struct net_device *));
432 void phy_stop_machine(struct phy_device *phydev);
433 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
434 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
435 int phy_mii_ioctl(struct phy_device *phydev,
436                 struct mii_ioctl_data *mii_data, int cmd);
437 int phy_start_interrupts(struct phy_device *phydev);
438 void phy_print_status(struct phy_device *phydev);
439 struct phy_device* phy_device_create(struct mii_bus *bus, int addr, int phy_id);
440 void phy_device_free(struct phy_device *phydev);
441
442 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
443                 int (*run)(struct phy_device *));
444 int phy_register_fixup_for_id(const char *bus_id,
445                 int (*run)(struct phy_device *));
446 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
447                 int (*run)(struct phy_device *));
448 int phy_scan_fixups(struct phy_device *phydev);
449
450 extern struct bus_type mdio_bus_type;
451 #endif /* __PHY_H */