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