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