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