phy.h 13 KB

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