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