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