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