phy.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775
  1. /*
  2. * Framework and drivers for configuring and reading different PHYs
  3. * Based on code in sungem_phy.c and gianfar_phy.c
  4. *
  5. * Author: Andy Fleming
  6. *
  7. * Copyright (c) 2004 Freescale Semiconductor, Inc.
  8. *
  9. * This program is free software; you can redistribute it and/or modify it
  10. * under the terms of the GNU General Public License as published by the
  11. * Free Software Foundation; either version 2 of the License, or (at your
  12. * option) any later version.
  13. *
  14. */
  15. #ifndef __PHY_H
  16. #define __PHY_H
  17. #include <linux/spinlock.h>
  18. #include <linux/ethtool.h>
  19. #include <linux/mii.h>
  20. #include <linux/timer.h>
  21. #include <linux/workqueue.h>
  22. #include <linux/mod_devicetable.h>
  23. #include <linux/atomic.h>
  24. #define PHY_DEFAULT_FEATURES (SUPPORTED_Autoneg | \
  25. SUPPORTED_TP | \
  26. SUPPORTED_MII)
  27. #define PHY_10BT_FEATURES (SUPPORTED_10baseT_Half | \
  28. SUPPORTED_10baseT_Full)
  29. #define PHY_100BT_FEATURES (SUPPORTED_100baseT_Half | \
  30. SUPPORTED_100baseT_Full)
  31. #define PHY_1000BT_FEATURES (SUPPORTED_1000baseT_Half | \
  32. SUPPORTED_1000baseT_Full)
  33. #define PHY_BASIC_FEATURES (PHY_10BT_FEATURES | \
  34. PHY_100BT_FEATURES | \
  35. PHY_DEFAULT_FEATURES)
  36. #define PHY_GBIT_FEATURES (PHY_BASIC_FEATURES | \
  37. PHY_1000BT_FEATURES)
  38. /*
  39. * Set phydev->irq to PHY_POLL if interrupts are not supported,
  40. * or not desired for this PHY. Set to PHY_IGNORE_INTERRUPT if
  41. * the attached driver handles the interrupt
  42. */
  43. #define PHY_POLL -1
  44. #define PHY_IGNORE_INTERRUPT -2
  45. #define PHY_HAS_INTERRUPT 0x00000001
  46. #define PHY_HAS_MAGICANEG 0x00000002
  47. #define PHY_IS_INTERNAL 0x00000004
  48. /* Interface Mode definitions */
  49. typedef enum {
  50. PHY_INTERFACE_MODE_NA,
  51. PHY_INTERFACE_MODE_MII,
  52. PHY_INTERFACE_MODE_GMII,
  53. PHY_INTERFACE_MODE_SGMII,
  54. PHY_INTERFACE_MODE_TBI,
  55. PHY_INTERFACE_MODE_REVMII,
  56. PHY_INTERFACE_MODE_RMII,
  57. PHY_INTERFACE_MODE_RGMII,
  58. PHY_INTERFACE_MODE_RGMII_ID,
  59. PHY_INTERFACE_MODE_RGMII_RXID,
  60. PHY_INTERFACE_MODE_RGMII_TXID,
  61. PHY_INTERFACE_MODE_RTBI,
  62. PHY_INTERFACE_MODE_SMII,
  63. PHY_INTERFACE_MODE_XGMII,
  64. PHY_INTERFACE_MODE_MOCA,
  65. PHY_INTERFACE_MODE_QSGMII,
  66. PHY_INTERFACE_MODE_MAX,
  67. } phy_interface_t;
  68. /**
  69. * It maps 'enum phy_interface_t' found in include/linux/phy.h
  70. * into the device tree binding of 'phy-mode', so that Ethernet
  71. * device driver can get phy interface from device tree.
  72. */
  73. static inline const char *phy_modes(phy_interface_t interface)
  74. {
  75. switch (interface) {
  76. case PHY_INTERFACE_MODE_NA:
  77. return "";
  78. case PHY_INTERFACE_MODE_MII:
  79. return "mii";
  80. case PHY_INTERFACE_MODE_GMII:
  81. return "gmii";
  82. case PHY_INTERFACE_MODE_SGMII:
  83. return "sgmii";
  84. case PHY_INTERFACE_MODE_TBI:
  85. return "tbi";
  86. case PHY_INTERFACE_MODE_REVMII:
  87. return "rev-mii";
  88. case PHY_INTERFACE_MODE_RMII:
  89. return "rmii";
  90. case PHY_INTERFACE_MODE_RGMII:
  91. return "rgmii";
  92. case PHY_INTERFACE_MODE_RGMII_ID:
  93. return "rgmii-id";
  94. case PHY_INTERFACE_MODE_RGMII_RXID:
  95. return "rgmii-rxid";
  96. case PHY_INTERFACE_MODE_RGMII_TXID:
  97. return "rgmii-txid";
  98. case PHY_INTERFACE_MODE_RTBI:
  99. return "rtbi";
  100. case PHY_INTERFACE_MODE_SMII:
  101. return "smii";
  102. case PHY_INTERFACE_MODE_XGMII:
  103. return "xgmii";
  104. case PHY_INTERFACE_MODE_MOCA:
  105. return "moca";
  106. case PHY_INTERFACE_MODE_QSGMII:
  107. return "qsgmii";
  108. default:
  109. return "unknown";
  110. }
  111. }
  112. #define PHY_INIT_TIMEOUT 100000
  113. #define PHY_STATE_TIME 1
  114. #define PHY_FORCE_TIMEOUT 10
  115. #define PHY_AN_TIMEOUT 10
  116. #define PHY_MAX_ADDR 32
  117. /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
  118. #define PHY_ID_FMT "%s:%02x"
  119. /*
  120. * Need to be a little smaller than phydev->dev.bus_id to leave room
  121. * for the ":%02x"
  122. */
  123. #define MII_BUS_ID_SIZE (20 - 3)
  124. /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
  125. IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
  126. #define MII_ADDR_C45 (1<<30)
  127. struct device;
  128. struct sk_buff;
  129. /*
  130. * The Bus class for PHYs. Devices which provide access to
  131. * PHYs should register using this structure
  132. */
  133. struct mii_bus {
  134. const char *name;
  135. char id[MII_BUS_ID_SIZE];
  136. void *priv;
  137. int (*read)(struct mii_bus *bus, int phy_id, int regnum);
  138. int (*write)(struct mii_bus *bus, int phy_id, int regnum, u16 val);
  139. int (*reset)(struct mii_bus *bus);
  140. /*
  141. * A lock to ensure that only one thing can read/write
  142. * the MDIO bus at a time
  143. */
  144. struct mutex mdio_lock;
  145. struct device *parent;
  146. enum {
  147. MDIOBUS_ALLOCATED = 1,
  148. MDIOBUS_REGISTERED,
  149. MDIOBUS_UNREGISTERED,
  150. MDIOBUS_RELEASED,
  151. } state;
  152. struct device dev;
  153. /* list of all PHYs on bus */
  154. struct phy_device *phy_map[PHY_MAX_ADDR];
  155. /* PHY addresses to be ignored when probing */
  156. u32 phy_mask;
  157. /*
  158. * Pointer to an array of interrupts, each PHY's
  159. * interrupt at the index matching its address
  160. */
  161. int *irq;
  162. };
  163. #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
  164. struct mii_bus *mdiobus_alloc_size(size_t);
  165. static inline struct mii_bus *mdiobus_alloc(void)
  166. {
  167. return mdiobus_alloc_size(0);
  168. }
  169. int mdiobus_register(struct mii_bus *bus);
  170. void mdiobus_unregister(struct mii_bus *bus);
  171. void mdiobus_free(struct mii_bus *bus);
  172. struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
  173. static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
  174. {
  175. return devm_mdiobus_alloc_size(dev, 0);
  176. }
  177. void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
  178. struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
  179. int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum);
  180. int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val);
  181. #define PHY_INTERRUPT_DISABLED 0x0
  182. #define PHY_INTERRUPT_ENABLED 0x80000000
  183. /* PHY state machine states:
  184. *
  185. * DOWN: PHY device and driver are not ready for anything. probe
  186. * should be called if and only if the PHY is in this state,
  187. * given that the PHY device exists.
  188. * - PHY driver probe function will, depending on the PHY, set
  189. * the state to STARTING or READY
  190. *
  191. * STARTING: PHY device is coming up, and the ethernet driver is
  192. * not ready. PHY drivers may set this in the probe function.
  193. * If they do, they are responsible for making sure the state is
  194. * eventually set to indicate whether the PHY is UP or READY,
  195. * depending on the state when the PHY is done starting up.
  196. * - PHY driver will set the state to READY
  197. * - start will set the state to PENDING
  198. *
  199. * READY: PHY is ready to send and receive packets, but the
  200. * controller is not. By default, PHYs which do not implement
  201. * probe will be set to this state by phy_probe(). If the PHY
  202. * driver knows the PHY is ready, and the PHY state is STARTING,
  203. * then it sets this STATE.
  204. * - start will set the state to UP
  205. *
  206. * PENDING: PHY device is coming up, but the ethernet driver is
  207. * ready. phy_start will set this state if the PHY state is
  208. * STARTING.
  209. * - PHY driver will set the state to UP when the PHY is ready
  210. *
  211. * UP: The PHY and attached device are ready to do work.
  212. * Interrupts should be started here.
  213. * - timer moves to AN
  214. *
  215. * AN: The PHY is currently negotiating the link state. Link is
  216. * therefore down for now. phy_timer will set this state when it
  217. * detects the state is UP. config_aneg will set this state
  218. * whenever called with phydev->autoneg set to AUTONEG_ENABLE.
  219. * - If autonegotiation finishes, but there's no link, it sets
  220. * the state to NOLINK.
  221. * - If aneg finishes with link, it sets the state to RUNNING,
  222. * and calls adjust_link
  223. * - If autonegotiation did not finish after an arbitrary amount
  224. * of time, autonegotiation should be tried again if the PHY
  225. * supports "magic" autonegotiation (back to AN)
  226. * - If it didn't finish, and no magic_aneg, move to FORCING.
  227. *
  228. * NOLINK: PHY is up, but not currently plugged in.
  229. * - If the timer notes that the link comes back, we move to RUNNING
  230. * - config_aneg moves to AN
  231. * - phy_stop moves to HALTED
  232. *
  233. * FORCING: PHY is being configured with forced settings
  234. * - if link is up, move to RUNNING
  235. * - If link is down, we drop to the next highest setting, and
  236. * retry (FORCING) after a timeout
  237. * - phy_stop moves to HALTED
  238. *
  239. * RUNNING: PHY is currently up, running, and possibly sending
  240. * and/or receiving packets
  241. * - timer will set CHANGELINK if we're polling (this ensures the
  242. * link state is polled every other cycle of this state machine,
  243. * which makes it every other second)
  244. * - irq will set CHANGELINK
  245. * - config_aneg will set AN
  246. * - phy_stop moves to HALTED
  247. *
  248. * CHANGELINK: PHY experienced a change in link state
  249. * - timer moves to RUNNING if link
  250. * - timer moves to NOLINK if the link is down
  251. * - phy_stop moves to HALTED
  252. *
  253. * HALTED: PHY is up, but no polling or interrupts are done. Or
  254. * PHY is in an error state.
  255. *
  256. * - phy_start moves to RESUMING
  257. *
  258. * RESUMING: PHY was halted, but now wants to run again.
  259. * - If we are forcing, or aneg is done, timer moves to RUNNING
  260. * - If aneg is not done, timer moves to AN
  261. * - phy_stop moves to HALTED
  262. */
  263. enum phy_state {
  264. PHY_DOWN = 0,
  265. PHY_STARTING,
  266. PHY_READY,
  267. PHY_PENDING,
  268. PHY_UP,
  269. PHY_AN,
  270. PHY_RUNNING,
  271. PHY_NOLINK,
  272. PHY_FORCING,
  273. PHY_CHANGELINK,
  274. PHY_HALTED,
  275. PHY_RESUMING
  276. };
  277. /**
  278. * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
  279. * @devices_in_package: Bit vector of devices present.
  280. * @device_ids: The device identifer for each present device.
  281. */
  282. struct phy_c45_device_ids {
  283. u32 devices_in_package;
  284. u32 device_ids[8];
  285. };
  286. /* phy_device: An instance of a PHY
  287. *
  288. * drv: Pointer to the driver for this PHY instance
  289. * bus: Pointer to the bus this PHY is on
  290. * dev: driver model device structure for this PHY
  291. * phy_id: UID for this device found during discovery
  292. * c45_ids: 802.3-c45 Device Identifers if is_c45.
  293. * is_c45: Set to true if this phy uses clause 45 addressing.
  294. * is_internal: Set to true if this phy is internal to a MAC.
  295. * state: state of the PHY for management purposes
  296. * dev_flags: Device-specific flags used by the PHY driver.
  297. * addr: Bus address of PHY
  298. * link_timeout: The number of timer firings to wait before the
  299. * giving up on the current attempt at acquiring a link
  300. * irq: IRQ number of the PHY's interrupt (-1 if none)
  301. * phy_timer: The timer for handling the state machine
  302. * phy_queue: A work_queue for the interrupt
  303. * attached_dev: The attached enet driver's device instance ptr
  304. * adjust_link: Callback for the enet controller to respond to
  305. * changes in the link state.
  306. *
  307. * speed, duplex, pause, supported, advertising, lp_advertising,
  308. * and autoneg are used like in mii_if_info
  309. *
  310. * interrupts currently only supports enabled or disabled,
  311. * but could be changed in the future to support enabling
  312. * and disabling specific interrupts
  313. *
  314. * Contains some infrastructure for polling and interrupt
  315. * handling, as well as handling shifts in PHY hardware state
  316. */
  317. struct phy_device {
  318. /* Information about the PHY type */
  319. /* And management functions */
  320. struct phy_driver *drv;
  321. struct mii_bus *bus;
  322. struct device dev;
  323. u32 phy_id;
  324. struct phy_c45_device_ids c45_ids;
  325. bool is_c45;
  326. bool is_internal;
  327. bool has_fixups;
  328. enum phy_state state;
  329. u32 dev_flags;
  330. phy_interface_t interface;
  331. /* Bus address of the PHY (0-31) */
  332. int addr;
  333. /*
  334. * forced speed & duplex (no autoneg)
  335. * partner speed & duplex & pause (autoneg)
  336. */
  337. int speed;
  338. int duplex;
  339. int pause;
  340. int asym_pause;
  341. /* The most recently read link state */
  342. int link;
  343. /* Enabled Interrupts */
  344. u32 interrupts;
  345. /* Union of PHY and Attached devices' supported modes */
  346. /* See mii.h for more info */
  347. u32 supported;
  348. u32 advertising;
  349. u32 lp_advertising;
  350. int autoneg;
  351. int link_timeout;
  352. /*
  353. * Interrupt number for this PHY
  354. * -1 means no interrupt
  355. */
  356. int irq;
  357. /* private data pointer */
  358. /* For use by PHYs to maintain extra state */
  359. void *priv;
  360. /* Interrupt and Polling infrastructure */
  361. struct work_struct phy_queue;
  362. struct delayed_work state_queue;
  363. atomic_t irq_disable;
  364. struct mutex lock;
  365. struct net_device *attached_dev;
  366. void (*adjust_link)(struct net_device *dev);
  367. };
  368. #define to_phy_device(d) container_of(d, struct phy_device, dev)
  369. /* struct phy_driver: Driver structure for a particular PHY type
  370. *
  371. * phy_id: The result of reading the UID registers of this PHY
  372. * type, and ANDing them with the phy_id_mask. This driver
  373. * only works for PHYs with IDs which match this field
  374. * name: The friendly name of this PHY type
  375. * phy_id_mask: Defines the important bits of the phy_id
  376. * features: A list of features (speed, duplex, etc) supported
  377. * by this PHY
  378. * flags: A bitfield defining certain other features this PHY
  379. * supports (like interrupts)
  380. *
  381. * The drivers must implement config_aneg and read_status. All
  382. * other functions are optional. Note that none of these
  383. * functions should be called from interrupt time. The goal is
  384. * for the bus read/write functions to be able to block when the
  385. * bus transaction is happening, and be freed up by an interrupt
  386. * (The MPC85xx has this ability, though it is not currently
  387. * supported in the driver).
  388. */
  389. struct phy_driver {
  390. u32 phy_id;
  391. char *name;
  392. unsigned int phy_id_mask;
  393. u32 features;
  394. u32 flags;
  395. /*
  396. * Called to issue a PHY software reset
  397. */
  398. int (*soft_reset)(struct phy_device *phydev);
  399. /*
  400. * Called to initialize the PHY,
  401. * including after a reset
  402. */
  403. int (*config_init)(struct phy_device *phydev);
  404. /*
  405. * Called during discovery. Used to set
  406. * up device-specific structures, if any
  407. */
  408. int (*probe)(struct phy_device *phydev);
  409. /* PHY Power Management */
  410. int (*suspend)(struct phy_device *phydev);
  411. int (*resume)(struct phy_device *phydev);
  412. /*
  413. * Configures the advertisement and resets
  414. * autonegotiation if phydev->autoneg is on,
  415. * forces the speed to the current settings in phydev
  416. * if phydev->autoneg is off
  417. */
  418. int (*config_aneg)(struct phy_device *phydev);
  419. /* Determines the auto negotiation result */
  420. int (*aneg_done)(struct phy_device *phydev);
  421. /* Determines the negotiated speed and duplex */
  422. int (*read_status)(struct phy_device *phydev);
  423. /* Clears any pending interrupts */
  424. int (*ack_interrupt)(struct phy_device *phydev);
  425. /* Enables or disables interrupts */
  426. int (*config_intr)(struct phy_device *phydev);
  427. /*
  428. * Checks if the PHY generated an interrupt.
  429. * For multi-PHY devices with shared PHY interrupt pin
  430. */
  431. int (*did_interrupt)(struct phy_device *phydev);
  432. /* Clears up any memory if needed */
  433. void (*remove)(struct phy_device *phydev);
  434. /* Returns true if this is a suitable driver for the given
  435. * phydev. If NULL, matching is based on phy_id and
  436. * phy_id_mask.
  437. */
  438. int (*match_phy_device)(struct phy_device *phydev);
  439. /* Handles ethtool queries for hardware time stamping. */
  440. int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
  441. /* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
  442. int (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
  443. /*
  444. * Requests a Rx timestamp for 'skb'. If the skb is accepted,
  445. * the phy driver promises to deliver it using netif_rx() as
  446. * soon as a timestamp becomes available. One of the
  447. * PTP_CLASS_ values is passed in 'type'. The function must
  448. * return true if the skb is accepted for delivery.
  449. */
  450. bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
  451. /*
  452. * Requests a Tx timestamp for 'skb'. The phy driver promises
  453. * to deliver it using skb_complete_tx_timestamp() as soon as a
  454. * timestamp becomes available. One of the PTP_CLASS_ values
  455. * is passed in 'type'.
  456. */
  457. void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
  458. /* Some devices (e.g. qnap TS-119P II) require PHY register changes to
  459. * enable Wake on LAN, so set_wol is provided to be called in the
  460. * ethernet driver's set_wol function. */
  461. int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
  462. /* See set_wol, but for checking whether Wake on LAN is enabled. */
  463. void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
  464. /*
  465. * Called to inform a PHY device driver when the core is about to
  466. * change the link state. This callback is supposed to be used as
  467. * fixup hook for drivers that need to take action when the link
  468. * state changes. Drivers are by no means allowed to mess with the
  469. * PHY device structure in their implementations.
  470. */
  471. void (*link_change_notify)(struct phy_device *dev);
  472. /* A function provided by a phy specific driver to override the
  473. * the PHY driver framework support for reading a MMD register
  474. * from the PHY. If not supported, return -1. This function is
  475. * optional for PHY specific drivers, if not provided then the
  476. * default MMD read function is used by the PHY framework.
  477. */
  478. int (*read_mmd_indirect)(struct phy_device *dev, int ptrad,
  479. int devnum, int regnum);
  480. /* A function provided by a phy specific driver to override the
  481. * the PHY driver framework support for writing a MMD register
  482. * from the PHY. This function is optional for PHY specific drivers,
  483. * if not provided then the default MMD read function is used by
  484. * the PHY framework.
  485. */
  486. void (*write_mmd_indirect)(struct phy_device *dev, int ptrad,
  487. int devnum, int regnum, u32 val);
  488. struct device_driver driver;
  489. };
  490. #define to_phy_driver(d) container_of(d, struct phy_driver, driver)
  491. #define PHY_ANY_ID "MATCH ANY PHY"
  492. #define PHY_ANY_UID 0xffffffff
  493. /* A Structure for boards to register fixups with the PHY Lib */
  494. struct phy_fixup {
  495. struct list_head list;
  496. char bus_id[20];
  497. u32 phy_uid;
  498. u32 phy_uid_mask;
  499. int (*run)(struct phy_device *phydev);
  500. };
  501. /**
  502. * phy_read_mmd - Convenience function for reading a register
  503. * from an MMD on a given PHY.
  504. * @phydev: The phy_device struct
  505. * @devad: The MMD to read from
  506. * @regnum: The register on the MMD to read
  507. *
  508. * Same rules as for phy_read();
  509. */
  510. static inline int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum)
  511. {
  512. if (!phydev->is_c45)
  513. return -EOPNOTSUPP;
  514. return mdiobus_read(phydev->bus, phydev->addr,
  515. MII_ADDR_C45 | (devad << 16) | (regnum & 0xffff));
  516. }
  517. /**
  518. * phy_read_mmd_indirect - reads data from the MMD registers
  519. * @phydev: The PHY device bus
  520. * @prtad: MMD Address
  521. * @devad: MMD DEVAD
  522. * @addr: PHY address on the MII bus
  523. *
  524. * Description: it reads data from the MMD registers (clause 22 to access to
  525. * clause 45) of the specified phy address.
  526. */
  527. int phy_read_mmd_indirect(struct phy_device *phydev, int prtad,
  528. int devad, int addr);
  529. /**
  530. * phy_read - Convenience function for reading a given PHY register
  531. * @phydev: the phy_device struct
  532. * @regnum: register number to read
  533. *
  534. * NOTE: MUST NOT be called from interrupt context,
  535. * because the bus read/write functions may wait for an interrupt
  536. * to conclude the operation.
  537. */
  538. static inline int phy_read(struct phy_device *phydev, u32 regnum)
  539. {
  540. return mdiobus_read(phydev->bus, phydev->addr, regnum);
  541. }
  542. /**
  543. * phy_write - Convenience function for writing a given PHY register
  544. * @phydev: the phy_device struct
  545. * @regnum: register number to write
  546. * @val: value to write to @regnum
  547. *
  548. * NOTE: MUST NOT be called from interrupt context,
  549. * because the bus read/write functions may wait for an interrupt
  550. * to conclude the operation.
  551. */
  552. static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
  553. {
  554. return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
  555. }
  556. /**
  557. * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
  558. * @phydev: the phy_device struct
  559. *
  560. * NOTE: must be kept in sync with addition/removal of PHY_POLL and
  561. * PHY_IGNORE_INTERRUPT
  562. */
  563. static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
  564. {
  565. return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
  566. }
  567. /**
  568. * phy_is_internal - Convenience function for testing if a PHY is internal
  569. * @phydev: the phy_device struct
  570. */
  571. static inline bool phy_is_internal(struct phy_device *phydev)
  572. {
  573. return phydev->is_internal;
  574. }
  575. /**
  576. * phy_write_mmd - Convenience function for writing a register
  577. * on an MMD on a given PHY.
  578. * @phydev: The phy_device struct
  579. * @devad: The MMD to read from
  580. * @regnum: The register on the MMD to read
  581. * @val: value to write to @regnum
  582. *
  583. * Same rules as for phy_write();
  584. */
  585. static inline int phy_write_mmd(struct phy_device *phydev, int devad,
  586. u32 regnum, u16 val)
  587. {
  588. if (!phydev->is_c45)
  589. return -EOPNOTSUPP;
  590. regnum = MII_ADDR_C45 | ((devad & 0x1f) << 16) | (regnum & 0xffff);
  591. return mdiobus_write(phydev->bus, phydev->addr, regnum, val);
  592. }
  593. /**
  594. * phy_write_mmd_indirect - writes data to the MMD registers
  595. * @phydev: The PHY device
  596. * @prtad: MMD Address
  597. * @devad: MMD DEVAD
  598. * @addr: PHY address on the MII bus
  599. * @data: data to write in the MMD register
  600. *
  601. * Description: Write data from the MMD registers of the specified
  602. * phy address.
  603. */
  604. void phy_write_mmd_indirect(struct phy_device *phydev, int prtad,
  605. int devad, int addr, u32 data);
  606. struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
  607. bool is_c45,
  608. struct phy_c45_device_ids *c45_ids);
  609. struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
  610. int phy_device_register(struct phy_device *phy);
  611. int phy_init_hw(struct phy_device *phydev);
  612. int phy_suspend(struct phy_device *phydev);
  613. int phy_resume(struct phy_device *phydev);
  614. struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
  615. phy_interface_t interface);
  616. struct phy_device *phy_find_first(struct mii_bus *bus);
  617. int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
  618. u32 flags, phy_interface_t interface);
  619. int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
  620. void (*handler)(struct net_device *),
  621. phy_interface_t interface);
  622. struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
  623. void (*handler)(struct net_device *),
  624. phy_interface_t interface);
  625. void phy_disconnect(struct phy_device *phydev);
  626. void phy_detach(struct phy_device *phydev);
  627. void phy_start(struct phy_device *phydev);
  628. void phy_stop(struct phy_device *phydev);
  629. int phy_start_aneg(struct phy_device *phydev);
  630. int phy_stop_interrupts(struct phy_device *phydev);
  631. static inline int phy_read_status(struct phy_device *phydev)
  632. {
  633. return phydev->drv->read_status(phydev);
  634. }
  635. int genphy_config_init(struct phy_device *phydev);
  636. int genphy_setup_forced(struct phy_device *phydev);
  637. int genphy_restart_aneg(struct phy_device *phydev);
  638. int genphy_config_aneg(struct phy_device *phydev);
  639. int genphy_aneg_done(struct phy_device *phydev);
  640. int genphy_update_link(struct phy_device *phydev);
  641. int genphy_read_status(struct phy_device *phydev);
  642. int genphy_suspend(struct phy_device *phydev);
  643. int genphy_resume(struct phy_device *phydev);
  644. int genphy_soft_reset(struct phy_device *phydev);
  645. void phy_driver_unregister(struct phy_driver *drv);
  646. void phy_drivers_unregister(struct phy_driver *drv, int n);
  647. int phy_driver_register(struct phy_driver *new_driver);
  648. int phy_drivers_register(struct phy_driver *new_driver, int n);
  649. void phy_state_machine(struct work_struct *work);
  650. void phy_change(struct work_struct *work);
  651. void phy_mac_interrupt(struct phy_device *phydev, int new_link);
  652. void phy_start_machine(struct phy_device *phydev);
  653. void phy_stop_machine(struct phy_device *phydev);
  654. int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
  655. int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd);
  656. int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
  657. int phy_start_interrupts(struct phy_device *phydev);
  658. void phy_print_status(struct phy_device *phydev);
  659. void phy_device_free(struct phy_device *phydev);
  660. int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
  661. int (*run)(struct phy_device *));
  662. int phy_register_fixup_for_id(const char *bus_id,
  663. int (*run)(struct phy_device *));
  664. int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
  665. int (*run)(struct phy_device *));
  666. int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
  667. int phy_get_eee_err(struct phy_device *phydev);
  668. int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
  669. int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
  670. int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
  671. void phy_ethtool_get_wol(struct phy_device *phydev,
  672. struct ethtool_wolinfo *wol);
  673. int __init mdio_bus_init(void);
  674. void mdio_bus_exit(void);
  675. extern struct bus_type mdio_bus_type;
  676. #endif /* __PHY_H */