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