xref: /linux-6.15/include/linux/phy.h (revision 226b96c2)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Framework and drivers for configuring and reading different PHYs
4  * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c
5  *
6  * Author: Andy Fleming
7  *
8  * Copyright (c) 2004 Freescale Semiconductor, Inc.
9  */
10 
11 #ifndef __PHY_H
12 #define __PHY_H
13 
14 #include <linux/compiler.h>
15 #include <linux/spinlock.h>
16 #include <linux/ethtool.h>
17 #include <linux/linkmode.h>
18 #include <linux/mdio.h>
19 #include <linux/mii.h>
20 #include <linux/module.h>
21 #include <linux/timer.h>
22 #include <linux/workqueue.h>
23 #include <linux/mod_devicetable.h>
24 
25 #include <linux/atomic.h>
26 
27 #define PHY_DEFAULT_FEATURES	(SUPPORTED_Autoneg | \
28 				 SUPPORTED_TP | \
29 				 SUPPORTED_MII)
30 
31 #define PHY_10BT_FEATURES	(SUPPORTED_10baseT_Half | \
32 				 SUPPORTED_10baseT_Full)
33 
34 #define PHY_100BT_FEATURES	(SUPPORTED_100baseT_Half | \
35 				 SUPPORTED_100baseT_Full)
36 
37 #define PHY_1000BT_FEATURES	(SUPPORTED_1000baseT_Half | \
38 				 SUPPORTED_1000baseT_Full)
39 
40 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
41 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
42 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
43 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
44 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
45 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
48 
49 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
50 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
51 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
52 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
53 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
54 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
55 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
56 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
57 
58 extern const int phy_10_100_features_array[4];
59 extern const int phy_basic_t1_features_array[2];
60 extern const int phy_gbit_features_array[2];
61 extern const int phy_10gbit_features_array[1];
62 
63 /*
64  * Set phydev->irq to PHY_POLL if interrupts are not supported,
65  * or not desired for this PHY.  Set to PHY_IGNORE_INTERRUPT if
66  * the attached driver handles the interrupt
67  */
68 #define PHY_POLL		-1
69 #define PHY_IGNORE_INTERRUPT	-2
70 
71 #define PHY_IS_INTERNAL		0x00000001
72 #define PHY_RST_AFTER_CLK_EN	0x00000002
73 #define MDIO_DEVICE_IS_PHY	0x80000000
74 
75 /* Interface Mode definitions */
76 typedef enum {
77 	PHY_INTERFACE_MODE_NA,
78 	PHY_INTERFACE_MODE_INTERNAL,
79 	PHY_INTERFACE_MODE_MII,
80 	PHY_INTERFACE_MODE_GMII,
81 	PHY_INTERFACE_MODE_SGMII,
82 	PHY_INTERFACE_MODE_TBI,
83 	PHY_INTERFACE_MODE_REVMII,
84 	PHY_INTERFACE_MODE_RMII,
85 	PHY_INTERFACE_MODE_RGMII,
86 	PHY_INTERFACE_MODE_RGMII_ID,
87 	PHY_INTERFACE_MODE_RGMII_RXID,
88 	PHY_INTERFACE_MODE_RGMII_TXID,
89 	PHY_INTERFACE_MODE_RTBI,
90 	PHY_INTERFACE_MODE_SMII,
91 	PHY_INTERFACE_MODE_XGMII,
92 	PHY_INTERFACE_MODE_MOCA,
93 	PHY_INTERFACE_MODE_QSGMII,
94 	PHY_INTERFACE_MODE_TRGMII,
95 	PHY_INTERFACE_MODE_1000BASEX,
96 	PHY_INTERFACE_MODE_2500BASEX,
97 	PHY_INTERFACE_MODE_RXAUI,
98 	PHY_INTERFACE_MODE_XAUI,
99 	/* 10GBASE-KR, XFI, SFI - single lane 10G Serdes */
100 	PHY_INTERFACE_MODE_10GKR,
101 	PHY_INTERFACE_MODE_USXGMII,
102 	PHY_INTERFACE_MODE_MAX,
103 } phy_interface_t;
104 
105 /**
106  * phy_supported_speeds - return all speeds currently supported by a phy device
107  * @phy: The phy device to return supported speeds of.
108  * @speeds: buffer to store supported speeds in.
109  * @size: size of speeds buffer.
110  *
111  * Description: Returns the number of supported speeds, and fills
112  * the speeds buffer with the supported speeds. If speeds buffer is
113  * too small to contain all currently supported speeds, will return as
114  * many speeds as can fit.
115  */
116 unsigned int phy_supported_speeds(struct phy_device *phy,
117 				      unsigned int *speeds,
118 				      unsigned int size);
119 
120 /**
121  * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
122  * @interface: enum phy_interface_t value
123  *
124  * Description: maps 'enum phy_interface_t' defined in this file
125  * into the device tree binding of 'phy-mode', so that Ethernet
126  * device driver can get phy interface from device tree.
127  */
128 static inline const char *phy_modes(phy_interface_t interface)
129 {
130 	switch (interface) {
131 	case PHY_INTERFACE_MODE_NA:
132 		return "";
133 	case PHY_INTERFACE_MODE_INTERNAL:
134 		return "internal";
135 	case PHY_INTERFACE_MODE_MII:
136 		return "mii";
137 	case PHY_INTERFACE_MODE_GMII:
138 		return "gmii";
139 	case PHY_INTERFACE_MODE_SGMII:
140 		return "sgmii";
141 	case PHY_INTERFACE_MODE_TBI:
142 		return "tbi";
143 	case PHY_INTERFACE_MODE_REVMII:
144 		return "rev-mii";
145 	case PHY_INTERFACE_MODE_RMII:
146 		return "rmii";
147 	case PHY_INTERFACE_MODE_RGMII:
148 		return "rgmii";
149 	case PHY_INTERFACE_MODE_RGMII_ID:
150 		return "rgmii-id";
151 	case PHY_INTERFACE_MODE_RGMII_RXID:
152 		return "rgmii-rxid";
153 	case PHY_INTERFACE_MODE_RGMII_TXID:
154 		return "rgmii-txid";
155 	case PHY_INTERFACE_MODE_RTBI:
156 		return "rtbi";
157 	case PHY_INTERFACE_MODE_SMII:
158 		return "smii";
159 	case PHY_INTERFACE_MODE_XGMII:
160 		return "xgmii";
161 	case PHY_INTERFACE_MODE_MOCA:
162 		return "moca";
163 	case PHY_INTERFACE_MODE_QSGMII:
164 		return "qsgmii";
165 	case PHY_INTERFACE_MODE_TRGMII:
166 		return "trgmii";
167 	case PHY_INTERFACE_MODE_1000BASEX:
168 		return "1000base-x";
169 	case PHY_INTERFACE_MODE_2500BASEX:
170 		return "2500base-x";
171 	case PHY_INTERFACE_MODE_RXAUI:
172 		return "rxaui";
173 	case PHY_INTERFACE_MODE_XAUI:
174 		return "xaui";
175 	case PHY_INTERFACE_MODE_10GKR:
176 		return "10gbase-kr";
177 	case PHY_INTERFACE_MODE_USXGMII:
178 		return "usxgmii";
179 	default:
180 		return "unknown";
181 	}
182 }
183 
184 
185 #define PHY_INIT_TIMEOUT	100000
186 #define PHY_FORCE_TIMEOUT	10
187 
188 #define PHY_MAX_ADDR	32
189 
190 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
191 #define PHY_ID_FMT "%s:%02x"
192 
193 #define MII_BUS_ID_SIZE	61
194 
195 /* Or MII_ADDR_C45 into regnum for read/write on mii_bus to enable the 21 bit
196    IEEE 802.3ae clause 45 addressing mode used by 10GIGE phy chips. */
197 #define MII_ADDR_C45 (1<<30)
198 
199 struct device;
200 struct phylink;
201 struct sk_buff;
202 
203 /*
204  * The Bus class for PHYs.  Devices which provide access to
205  * PHYs should register using this structure
206  */
207 struct mii_bus {
208 	struct module *owner;
209 	const char *name;
210 	char id[MII_BUS_ID_SIZE];
211 	void *priv;
212 	int (*read)(struct mii_bus *bus, int addr, int regnum);
213 	int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
214 	int (*reset)(struct mii_bus *bus);
215 
216 	/*
217 	 * A lock to ensure that only one thing can read/write
218 	 * the MDIO bus at a time
219 	 */
220 	struct mutex mdio_lock;
221 
222 	struct device *parent;
223 	enum {
224 		MDIOBUS_ALLOCATED = 1,
225 		MDIOBUS_REGISTERED,
226 		MDIOBUS_UNREGISTERED,
227 		MDIOBUS_RELEASED,
228 	} state;
229 	struct device dev;
230 
231 	/* list of all PHYs on bus */
232 	struct mdio_device *mdio_map[PHY_MAX_ADDR];
233 
234 	/* PHY addresses to be ignored when probing */
235 	u32 phy_mask;
236 
237 	/* PHY addresses to ignore the TA/read failure */
238 	u32 phy_ignore_ta_mask;
239 
240 	/*
241 	 * An array of interrupts, each PHY's interrupt at the index
242 	 * matching its address
243 	 */
244 	int irq[PHY_MAX_ADDR];
245 
246 	/* GPIO reset pulse width in microseconds */
247 	int reset_delay_us;
248 	/* RESET GPIO descriptor pointer */
249 	struct gpio_desc *reset_gpiod;
250 };
251 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
252 
253 struct mii_bus *mdiobus_alloc_size(size_t);
254 static inline struct mii_bus *mdiobus_alloc(void)
255 {
256 	return mdiobus_alloc_size(0);
257 }
258 
259 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
260 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
261 void mdiobus_unregister(struct mii_bus *bus);
262 void mdiobus_free(struct mii_bus *bus);
263 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
264 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
265 {
266 	return devm_mdiobus_alloc_size(dev, 0);
267 }
268 
269 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus);
270 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
271 
272 #define PHY_INTERRUPT_DISABLED	false
273 #define PHY_INTERRUPT_ENABLED	true
274 
275 /* PHY state machine states:
276  *
277  * DOWN: PHY device and driver are not ready for anything.  probe
278  * should be called if and only if the PHY is in this state,
279  * given that the PHY device exists.
280  * - PHY driver probe function will set the state to READY
281  *
282  * READY: PHY is ready to send and receive packets, but the
283  * controller is not.  By default, PHYs which do not implement
284  * probe will be set to this state by phy_probe().
285  * - start will set the state to UP
286  *
287  * UP: The PHY and attached device are ready to do work.
288  * Interrupts should be started here.
289  * - timer moves to NOLINK or RUNNING
290  *
291  * NOLINK: PHY is up, but not currently plugged in.
292  * - irq or timer will set RUNNING if link comes back
293  * - phy_stop moves to HALTED
294  *
295  * RUNNING: PHY is currently up, running, and possibly sending
296  * and/or receiving packets
297  * - irq or timer will set NOLINK if link goes down
298  * - phy_stop moves to HALTED
299  *
300  * HALTED: PHY is up, but no polling or interrupts are done. Or
301  * PHY is in an error state.
302  * - phy_start moves to UP
303  */
304 enum phy_state {
305 	PHY_DOWN = 0,
306 	PHY_READY,
307 	PHY_HALTED,
308 	PHY_UP,
309 	PHY_RUNNING,
310 	PHY_NOLINK,
311 };
312 
313 /**
314  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
315  * @devices_in_package: Bit vector of devices present.
316  * @device_ids: The device identifer for each present device.
317  */
318 struct phy_c45_device_ids {
319 	u32 devices_in_package;
320 	u32 device_ids[8];
321 };
322 
323 /* phy_device: An instance of a PHY
324  *
325  * drv: Pointer to the driver for this PHY instance
326  * phy_id: UID for this device found during discovery
327  * c45_ids: 802.3-c45 Device Identifers if is_c45.
328  * is_c45:  Set to true if this phy uses clause 45 addressing.
329  * is_internal: Set to true if this phy is internal to a MAC.
330  * is_pseudo_fixed_link: Set to true if this phy is an Ethernet switch, etc.
331  * is_gigabit_capable: Set to true if PHY supports 1000Mbps
332  * has_fixups: Set to true if this phy has fixups/quirks.
333  * suspended: Set to true if this phy has been suspended successfully.
334  * sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
335  * loopback_enabled: Set true if this phy has been loopbacked successfully.
336  * state: state of the PHY for management purposes
337  * dev_flags: Device-specific flags used by the PHY driver.
338  * irq: IRQ number of the PHY's interrupt (-1 if none)
339  * phy_timer: The timer for handling the state machine
340  * attached_dev: The attached enet driver's device instance ptr
341  * adjust_link: Callback for the enet controller to respond to
342  * changes in the link state.
343  *
344  * speed, duplex, pause, supported, advertising, lp_advertising,
345  * and autoneg are used like in mii_if_info
346  *
347  * interrupts currently only supports enabled or disabled,
348  * but could be changed in the future to support enabling
349  * and disabling specific interrupts
350  *
351  * Contains some infrastructure for polling and interrupt
352  * handling, as well as handling shifts in PHY hardware state
353  */
354 struct phy_device {
355 	struct mdio_device mdio;
356 
357 	/* Information about the PHY type */
358 	/* And management functions */
359 	struct phy_driver *drv;
360 
361 	u32 phy_id;
362 
363 	struct phy_c45_device_ids c45_ids;
364 	unsigned is_c45:1;
365 	unsigned is_internal:1;
366 	unsigned is_pseudo_fixed_link:1;
367 	unsigned is_gigabit_capable:1;
368 	unsigned has_fixups:1;
369 	unsigned suspended:1;
370 	unsigned sysfs_links:1;
371 	unsigned loopback_enabled:1;
372 
373 	unsigned autoneg:1;
374 	/* The most recently read link state */
375 	unsigned link:1;
376 	unsigned autoneg_complete:1;
377 
378 	/* Interrupts are enabled */
379 	unsigned interrupts:1;
380 
381 	enum phy_state state;
382 
383 	u32 dev_flags;
384 
385 	phy_interface_t interface;
386 
387 	/*
388 	 * forced speed & duplex (no autoneg)
389 	 * partner speed & duplex & pause (autoneg)
390 	 */
391 	int speed;
392 	int duplex;
393 	int pause;
394 	int asym_pause;
395 
396 	/* Union of PHY and Attached devices' supported link modes */
397 	/* See ethtool.h for more info */
398 	__ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
399 	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
400 	__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
401 
402 	/* Energy efficient ethernet modes which should be prohibited */
403 	u32 eee_broken_modes;
404 
405 #ifdef CONFIG_LED_TRIGGER_PHY
406 	struct phy_led_trigger *phy_led_triggers;
407 	unsigned int phy_num_led_triggers;
408 	struct phy_led_trigger *last_triggered;
409 
410 	struct phy_led_trigger *led_link_trigger;
411 #endif
412 
413 	/*
414 	 * Interrupt number for this PHY
415 	 * -1 means no interrupt
416 	 */
417 	int irq;
418 
419 	/* private data pointer */
420 	/* For use by PHYs to maintain extra state */
421 	void *priv;
422 
423 	/* Interrupt and Polling infrastructure */
424 	struct delayed_work state_queue;
425 
426 	struct mutex lock;
427 
428 	struct phylink *phylink;
429 	struct net_device *attached_dev;
430 
431 	u8 mdix;
432 	u8 mdix_ctrl;
433 
434 	void (*phy_link_change)(struct phy_device *, bool up, bool do_carrier);
435 	void (*adjust_link)(struct net_device *dev);
436 };
437 #define to_phy_device(d) container_of(to_mdio_device(d), \
438 				      struct phy_device, mdio)
439 
440 /* struct phy_driver: Driver structure for a particular PHY type
441  *
442  * driver_data: static driver data
443  * phy_id: The result of reading the UID registers of this PHY
444  *   type, and ANDing them with the phy_id_mask.  This driver
445  *   only works for PHYs with IDs which match this field
446  * name: The friendly name of this PHY type
447  * phy_id_mask: Defines the important bits of the phy_id
448  * features: A mandatory list of features (speed, duplex, etc)
449  *   supported by this PHY
450  * flags: A bitfield defining certain other features this PHY
451  *   supports (like interrupts)
452  *
453  * All functions are optional. If config_aneg or read_status
454  * are not implemented, the phy core uses the genphy versions.
455  * Note that none of these functions should be called from
456  * interrupt time. The goal is for the bus read/write functions
457  * to be able to block when the bus transaction is happening,
458  * and be freed up by an interrupt (The MPC85xx has this ability,
459  * though it is not currently supported in the driver).
460  */
461 struct phy_driver {
462 	struct mdio_driver_common mdiodrv;
463 	u32 phy_id;
464 	char *name;
465 	u32 phy_id_mask;
466 	const unsigned long * const features;
467 	u32 flags;
468 	const void *driver_data;
469 
470 	/*
471 	 * Called to issue a PHY software reset
472 	 */
473 	int (*soft_reset)(struct phy_device *phydev);
474 
475 	/*
476 	 * Called to initialize the PHY,
477 	 * including after a reset
478 	 */
479 	int (*config_init)(struct phy_device *phydev);
480 
481 	/*
482 	 * Called during discovery.  Used to set
483 	 * up device-specific structures, if any
484 	 */
485 	int (*probe)(struct phy_device *phydev);
486 
487 	/*
488 	 * Probe the hardware to determine what abilities it has.
489 	 * Should only set phydev->supported.
490 	 */
491 	int (*get_features)(struct phy_device *phydev);
492 
493 	/* PHY Power Management */
494 	int (*suspend)(struct phy_device *phydev);
495 	int (*resume)(struct phy_device *phydev);
496 
497 	/*
498 	 * Configures the advertisement and resets
499 	 * autonegotiation if phydev->autoneg is on,
500 	 * forces the speed to the current settings in phydev
501 	 * if phydev->autoneg is off
502 	 */
503 	int (*config_aneg)(struct phy_device *phydev);
504 
505 	/* Determines the auto negotiation result */
506 	int (*aneg_done)(struct phy_device *phydev);
507 
508 	/* Determines the negotiated speed and duplex */
509 	int (*read_status)(struct phy_device *phydev);
510 
511 	/* Clears any pending interrupts */
512 	int (*ack_interrupt)(struct phy_device *phydev);
513 
514 	/* Enables or disables interrupts */
515 	int (*config_intr)(struct phy_device *phydev);
516 
517 	/*
518 	 * Checks if the PHY generated an interrupt.
519 	 * For multi-PHY devices with shared PHY interrupt pin
520 	 */
521 	int (*did_interrupt)(struct phy_device *phydev);
522 
523 	/* Override default interrupt handling */
524 	int (*handle_interrupt)(struct phy_device *phydev);
525 
526 	/* Clears up any memory if needed */
527 	void (*remove)(struct phy_device *phydev);
528 
529 	/* Returns true if this is a suitable driver for the given
530 	 * phydev.  If NULL, matching is based on phy_id and
531 	 * phy_id_mask.
532 	 */
533 	int (*match_phy_device)(struct phy_device *phydev);
534 
535 	/* Handles ethtool queries for hardware time stamping. */
536 	int (*ts_info)(struct phy_device *phydev, struct ethtool_ts_info *ti);
537 
538 	/* Handles SIOCSHWTSTAMP ioctl for hardware time stamping. */
539 	int  (*hwtstamp)(struct phy_device *phydev, struct ifreq *ifr);
540 
541 	/*
542 	 * Requests a Rx timestamp for 'skb'. If the skb is accepted,
543 	 * the phy driver promises to deliver it using netif_rx() as
544 	 * soon as a timestamp becomes available. One of the
545 	 * PTP_CLASS_ values is passed in 'type'. The function must
546 	 * return true if the skb is accepted for delivery.
547 	 */
548 	bool (*rxtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
549 
550 	/*
551 	 * Requests a Tx timestamp for 'skb'. The phy driver promises
552 	 * to deliver it using skb_complete_tx_timestamp() as soon as a
553 	 * timestamp becomes available. One of the PTP_CLASS_ values
554 	 * is passed in 'type'.
555 	 */
556 	void (*txtstamp)(struct phy_device *dev, struct sk_buff *skb, int type);
557 
558 	/* Some devices (e.g. qnap TS-119P II) require PHY register changes to
559 	 * enable Wake on LAN, so set_wol is provided to be called in the
560 	 * ethernet driver's set_wol function. */
561 	int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
562 
563 	/* See set_wol, but for checking whether Wake on LAN is enabled. */
564 	void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
565 
566 	/*
567 	 * Called to inform a PHY device driver when the core is about to
568 	 * change the link state. This callback is supposed to be used as
569 	 * fixup hook for drivers that need to take action when the link
570 	 * state changes. Drivers are by no means allowed to mess with the
571 	 * PHY device structure in their implementations.
572 	 */
573 	void (*link_change_notify)(struct phy_device *dev);
574 
575 	/*
576 	 * Phy specific driver override for reading a MMD register.
577 	 * This function is optional for PHY specific drivers.  When
578 	 * not provided, the default MMD read function will be used
579 	 * by phy_read_mmd(), which will use either a direct read for
580 	 * Clause 45 PHYs or an indirect read for Clause 22 PHYs.
581 	 *  devnum is the MMD device number within the PHY device,
582 	 *  regnum is the register within the selected MMD device.
583 	 */
584 	int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
585 
586 	/*
587 	 * Phy specific driver override for writing a MMD register.
588 	 * This function is optional for PHY specific drivers.  When
589 	 * not provided, the default MMD write function will be used
590 	 * by phy_write_mmd(), which will use either a direct write for
591 	 * Clause 45 PHYs, or an indirect write for Clause 22 PHYs.
592 	 *  devnum is the MMD device number within the PHY device,
593 	 *  regnum is the register within the selected MMD device.
594 	 *  val is the value to be written.
595 	 */
596 	int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
597 			 u16 val);
598 
599 	int (*read_page)(struct phy_device *dev);
600 	int (*write_page)(struct phy_device *dev, int page);
601 
602 	/* Get the size and type of the eeprom contained within a plug-in
603 	 * module */
604 	int (*module_info)(struct phy_device *dev,
605 			   struct ethtool_modinfo *modinfo);
606 
607 	/* Get the eeprom information from the plug-in module */
608 	int (*module_eeprom)(struct phy_device *dev,
609 			     struct ethtool_eeprom *ee, u8 *data);
610 
611 	/* Get statistics from the phy using ethtool */
612 	int (*get_sset_count)(struct phy_device *dev);
613 	void (*get_strings)(struct phy_device *dev, u8 *data);
614 	void (*get_stats)(struct phy_device *dev,
615 			  struct ethtool_stats *stats, u64 *data);
616 
617 	/* Get and Set PHY tunables */
618 	int (*get_tunable)(struct phy_device *dev,
619 			   struct ethtool_tunable *tuna, void *data);
620 	int (*set_tunable)(struct phy_device *dev,
621 			    struct ethtool_tunable *tuna,
622 			    const void *data);
623 	int (*set_loopback)(struct phy_device *dev, bool enable);
624 };
625 #define to_phy_driver(d) container_of(to_mdio_common_driver(d),		\
626 				      struct phy_driver, mdiodrv)
627 
628 #define PHY_ANY_ID "MATCH ANY PHY"
629 #define PHY_ANY_UID 0xffffffff
630 
631 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
632 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
633 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
634 
635 /* A Structure for boards to register fixups with the PHY Lib */
636 struct phy_fixup {
637 	struct list_head list;
638 	char bus_id[MII_BUS_ID_SIZE + 3];
639 	u32 phy_uid;
640 	u32 phy_uid_mask;
641 	int (*run)(struct phy_device *phydev);
642 };
643 
644 const char *phy_speed_to_str(int speed);
645 const char *phy_duplex_to_str(unsigned int duplex);
646 
647 /* A structure for mapping a particular speed and duplex
648  * combination to a particular SUPPORTED and ADVERTISED value
649  */
650 struct phy_setting {
651 	u32 speed;
652 	u8 duplex;
653 	u8 bit;
654 };
655 
656 const struct phy_setting *
657 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
658 		   bool exact);
659 size_t phy_speeds(unsigned int *speeds, size_t size,
660 		  unsigned long *mask);
661 void of_set_phy_supported(struct phy_device *phydev);
662 void of_set_phy_eee_broken(struct phy_device *phydev);
663 
664 /**
665  * phy_is_started - Convenience function to check whether PHY is started
666  * @phydev: The phy_device struct
667  */
668 static inline bool phy_is_started(struct phy_device *phydev)
669 {
670 	return phydev->state >= PHY_UP;
671 }
672 
673 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
674 
675 /**
676  * phy_read - Convenience function for reading a given PHY register
677  * @phydev: the phy_device struct
678  * @regnum: register number to read
679  *
680  * NOTE: MUST NOT be called from interrupt context,
681  * because the bus read/write functions may wait for an interrupt
682  * to conclude the operation.
683  */
684 static inline int phy_read(struct phy_device *phydev, u32 regnum)
685 {
686 	return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
687 }
688 
689 /**
690  * __phy_read - convenience function for reading a given PHY register
691  * @phydev: the phy_device struct
692  * @regnum: register number to read
693  *
694  * The caller must have taken the MDIO bus lock.
695  */
696 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
697 {
698 	return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
699 }
700 
701 /**
702  * phy_write - Convenience function for writing a given PHY register
703  * @phydev: the phy_device struct
704  * @regnum: register number to write
705  * @val: value to write to @regnum
706  *
707  * NOTE: MUST NOT be called from interrupt context,
708  * because the bus read/write functions may wait for an interrupt
709  * to conclude the operation.
710  */
711 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
712 {
713 	return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
714 }
715 
716 /**
717  * __phy_write - Convenience function for writing a given PHY register
718  * @phydev: the phy_device struct
719  * @regnum: register number to write
720  * @val: value to write to @regnum
721  *
722  * The caller must have taken the MDIO bus lock.
723  */
724 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
725 {
726 	return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
727 			       val);
728 }
729 
730 /**
731  * phy_read_mmd - Convenience function for reading a register
732  * from an MMD on a given PHY.
733  * @phydev: The phy_device struct
734  * @devad: The MMD to read from
735  * @regnum: The register on the MMD to read
736  *
737  * Same rules as for phy_read();
738  */
739 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
740 
741 /**
742  * __phy_read_mmd - Convenience function for reading a register
743  * from an MMD on a given PHY.
744  * @phydev: The phy_device struct
745  * @devad: The MMD to read from
746  * @regnum: The register on the MMD to read
747  *
748  * Same rules as for __phy_read();
749  */
750 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
751 
752 /**
753  * phy_write_mmd - Convenience function for writing a register
754  * on an MMD on a given PHY.
755  * @phydev: The phy_device struct
756  * @devad: The MMD to write to
757  * @regnum: The register on the MMD to read
758  * @val: value to write to @regnum
759  *
760  * Same rules as for phy_write();
761  */
762 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
763 
764 /**
765  * __phy_write_mmd - Convenience function for writing a register
766  * on an MMD on a given PHY.
767  * @phydev: The phy_device struct
768  * @devad: The MMD to write to
769  * @regnum: The register on the MMD to read
770  * @val: value to write to @regnum
771  *
772  * Same rules as for __phy_write();
773  */
774 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
775 
776 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
777 			 u16 set);
778 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
779 		       u16 set);
780 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
781 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
782 
783 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
784 			     u16 mask, u16 set);
785 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
786 			   u16 mask, u16 set);
787 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
788 		     u16 mask, u16 set);
789 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
790 		   u16 mask, u16 set);
791 
792 /**
793  * __phy_set_bits - Convenience function for setting bits in a PHY register
794  * @phydev: the phy_device struct
795  * @regnum: register number to write
796  * @val: bits to set
797  *
798  * The caller must have taken the MDIO bus lock.
799  */
800 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
801 {
802 	return __phy_modify(phydev, regnum, 0, val);
803 }
804 
805 /**
806  * __phy_clear_bits - Convenience function for clearing bits in a PHY register
807  * @phydev: the phy_device struct
808  * @regnum: register number to write
809  * @val: bits to clear
810  *
811  * The caller must have taken the MDIO bus lock.
812  */
813 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
814 				   u16 val)
815 {
816 	return __phy_modify(phydev, regnum, val, 0);
817 }
818 
819 /**
820  * phy_set_bits - Convenience function for setting bits in a PHY register
821  * @phydev: the phy_device struct
822  * @regnum: register number to write
823  * @val: bits to set
824  */
825 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
826 {
827 	return phy_modify(phydev, regnum, 0, val);
828 }
829 
830 /**
831  * phy_clear_bits - Convenience function for clearing bits in a PHY register
832  * @phydev: the phy_device struct
833  * @regnum: register number to write
834  * @val: bits to clear
835  */
836 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
837 {
838 	return phy_modify(phydev, regnum, val, 0);
839 }
840 
841 /**
842  * __phy_set_bits_mmd - Convenience function for setting bits in a register
843  * on MMD
844  * @phydev: the phy_device struct
845  * @devad: the MMD containing register to modify
846  * @regnum: register number to modify
847  * @val: bits to set
848  *
849  * The caller must have taken the MDIO bus lock.
850  */
851 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
852 		u32 regnum, u16 val)
853 {
854 	return __phy_modify_mmd(phydev, devad, regnum, 0, val);
855 }
856 
857 /**
858  * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
859  * on MMD
860  * @phydev: the phy_device struct
861  * @devad: the MMD containing register to modify
862  * @regnum: register number to modify
863  * @val: bits to clear
864  *
865  * The caller must have taken the MDIO bus lock.
866  */
867 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
868 		u32 regnum, u16 val)
869 {
870 	return __phy_modify_mmd(phydev, devad, regnum, val, 0);
871 }
872 
873 /**
874  * phy_set_bits_mmd - Convenience function for setting bits in a register
875  * on MMD
876  * @phydev: the phy_device struct
877  * @devad: the MMD containing register to modify
878  * @regnum: register number to modify
879  * @val: bits to set
880  */
881 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
882 		u32 regnum, u16 val)
883 {
884 	return phy_modify_mmd(phydev, devad, regnum, 0, val);
885 }
886 
887 /**
888  * phy_clear_bits_mmd - Convenience function for clearing bits in a register
889  * on MMD
890  * @phydev: the phy_device struct
891  * @devad: the MMD containing register to modify
892  * @regnum: register number to modify
893  * @val: bits to clear
894  */
895 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
896 		u32 regnum, u16 val)
897 {
898 	return phy_modify_mmd(phydev, devad, regnum, val, 0);
899 }
900 
901 /**
902  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
903  * @phydev: the phy_device struct
904  *
905  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
906  * PHY_IGNORE_INTERRUPT
907  */
908 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
909 {
910 	return phydev->irq != PHY_POLL && phydev->irq != PHY_IGNORE_INTERRUPT;
911 }
912 
913 /**
914  * phy_polling_mode - Convenience function for testing whether polling is
915  * used to detect PHY status changes
916  * @phydev: the phy_device struct
917  */
918 static inline bool phy_polling_mode(struct phy_device *phydev)
919 {
920 	return phydev->irq == PHY_POLL;
921 }
922 
923 /**
924  * phy_is_internal - Convenience function for testing if a PHY is internal
925  * @phydev: the phy_device struct
926  */
927 static inline bool phy_is_internal(struct phy_device *phydev)
928 {
929 	return phydev->is_internal;
930 }
931 
932 /**
933  * phy_interface_mode_is_rgmii - Convenience function for testing if a
934  * PHY interface mode is RGMII (all variants)
935  * @mode: the phy_interface_t enum
936  */
937 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
938 {
939 	return mode >= PHY_INTERFACE_MODE_RGMII &&
940 		mode <= PHY_INTERFACE_MODE_RGMII_TXID;
941 };
942 
943 /**
944  * phy_interface_mode_is_8023z() - does the phy interface mode use 802.3z
945  *   negotiation
946  * @mode: one of &enum phy_interface_t
947  *
948  * Returns true if the phy interface mode uses the 16-bit negotiation
949  * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
950  */
951 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
952 {
953 	return mode == PHY_INTERFACE_MODE_1000BASEX ||
954 	       mode == PHY_INTERFACE_MODE_2500BASEX;
955 }
956 
957 /**
958  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
959  * is RGMII (all variants)
960  * @phydev: the phy_device struct
961  */
962 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
963 {
964 	return phy_interface_mode_is_rgmii(phydev->interface);
965 };
966 
967 /*
968  * phy_is_pseudo_fixed_link - Convenience function for testing if this
969  * PHY is the CPU port facing side of an Ethernet switch, or similar.
970  * @phydev: the phy_device struct
971  */
972 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
973 {
974 	return phydev->is_pseudo_fixed_link;
975 }
976 
977 int phy_save_page(struct phy_device *phydev);
978 int phy_select_page(struct phy_device *phydev, int page);
979 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
980 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
981 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
982 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
983 		     u16 mask, u16 set);
984 
985 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
986 				     bool is_c45,
987 				     struct phy_c45_device_ids *c45_ids);
988 #if IS_ENABLED(CONFIG_PHYLIB)
989 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
990 int phy_device_register(struct phy_device *phy);
991 void phy_device_free(struct phy_device *phydev);
992 #else
993 static inline
994 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
995 {
996 	return NULL;
997 }
998 
999 static inline int phy_device_register(struct phy_device *phy)
1000 {
1001 	return 0;
1002 }
1003 
1004 static inline void phy_device_free(struct phy_device *phydev) { }
1005 #endif /* CONFIG_PHYLIB */
1006 void phy_device_remove(struct phy_device *phydev);
1007 int phy_init_hw(struct phy_device *phydev);
1008 int phy_suspend(struct phy_device *phydev);
1009 int phy_resume(struct phy_device *phydev);
1010 int __phy_resume(struct phy_device *phydev);
1011 int phy_loopback(struct phy_device *phydev, bool enable);
1012 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1013 			      phy_interface_t interface);
1014 struct phy_device *phy_find_first(struct mii_bus *bus);
1015 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1016 		      u32 flags, phy_interface_t interface);
1017 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1018 		       void (*handler)(struct net_device *),
1019 		       phy_interface_t interface);
1020 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1021 			       void (*handler)(struct net_device *),
1022 			       phy_interface_t interface);
1023 void phy_disconnect(struct phy_device *phydev);
1024 void phy_detach(struct phy_device *phydev);
1025 void phy_start(struct phy_device *phydev);
1026 void phy_stop(struct phy_device *phydev);
1027 int phy_start_aneg(struct phy_device *phydev);
1028 int phy_aneg_done(struct phy_device *phydev);
1029 int phy_speed_down(struct phy_device *phydev, bool sync);
1030 int phy_speed_up(struct phy_device *phydev);
1031 
1032 int phy_restart_aneg(struct phy_device *phydev);
1033 int phy_reset_after_clk_enable(struct phy_device *phydev);
1034 
1035 static inline void phy_device_reset(struct phy_device *phydev, int value)
1036 {
1037 	mdio_device_reset(&phydev->mdio, value);
1038 }
1039 
1040 #define phydev_err(_phydev, format, args...)	\
1041 	dev_err(&_phydev->mdio.dev, format, ##args)
1042 
1043 #define phydev_info(_phydev, format, args...)	\
1044 	dev_info(&_phydev->mdio.dev, format, ##args)
1045 
1046 #define phydev_warn(_phydev, format, args...)	\
1047 	dev_warn(&_phydev->mdio.dev, format, ##args)
1048 
1049 #define phydev_dbg(_phydev, format, args...)	\
1050 	dev_dbg(&_phydev->mdio.dev, format, ##args)
1051 
1052 static inline const char *phydev_name(const struct phy_device *phydev)
1053 {
1054 	return dev_name(&phydev->mdio.dev);
1055 }
1056 
1057 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1058 	__printf(2, 3);
1059 void phy_attached_info(struct phy_device *phydev);
1060 
1061 /* Clause 22 PHY */
1062 int genphy_config_init(struct phy_device *phydev);
1063 int genphy_read_abilities(struct phy_device *phydev);
1064 int genphy_setup_forced(struct phy_device *phydev);
1065 int genphy_restart_aneg(struct phy_device *phydev);
1066 int genphy_config_eee_advert(struct phy_device *phydev);
1067 int genphy_config_aneg(struct phy_device *phydev);
1068 int genphy_aneg_done(struct phy_device *phydev);
1069 int genphy_update_link(struct phy_device *phydev);
1070 int genphy_read_status(struct phy_device *phydev);
1071 int genphy_suspend(struct phy_device *phydev);
1072 int genphy_resume(struct phy_device *phydev);
1073 int genphy_loopback(struct phy_device *phydev, bool enable);
1074 int genphy_soft_reset(struct phy_device *phydev);
1075 static inline int genphy_no_soft_reset(struct phy_device *phydev)
1076 {
1077 	return 0;
1078 }
1079 static inline int genphy_no_ack_interrupt(struct phy_device *phydev)
1080 {
1081 	return 0;
1082 }
1083 static inline int genphy_no_config_intr(struct phy_device *phydev)
1084 {
1085 	return 0;
1086 }
1087 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1088 				u16 regnum);
1089 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1090 				 u16 regnum, u16 val);
1091 
1092 /* Clause 45 PHY */
1093 int genphy_c45_restart_aneg(struct phy_device *phydev);
1094 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1095 int genphy_c45_aneg_done(struct phy_device *phydev);
1096 int genphy_c45_read_link(struct phy_device *phydev);
1097 int genphy_c45_read_lpa(struct phy_device *phydev);
1098 int genphy_c45_read_pma(struct phy_device *phydev);
1099 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1100 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1101 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1102 int genphy_c45_read_mdix(struct phy_device *phydev);
1103 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1104 int genphy_c45_read_status(struct phy_device *phydev);
1105 
1106 /* The gen10g_* functions are the old Clause 45 stub */
1107 int gen10g_config_aneg(struct phy_device *phydev);
1108 
1109 static inline int phy_read_status(struct phy_device *phydev)
1110 {
1111 	if (!phydev->drv)
1112 		return -EIO;
1113 
1114 	if (phydev->drv->read_status)
1115 		return phydev->drv->read_status(phydev);
1116 	else
1117 		return genphy_read_status(phydev);
1118 }
1119 
1120 void phy_driver_unregister(struct phy_driver *drv);
1121 void phy_drivers_unregister(struct phy_driver *drv, int n);
1122 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1123 int phy_drivers_register(struct phy_driver *new_driver, int n,
1124 			 struct module *owner);
1125 void phy_state_machine(struct work_struct *work);
1126 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1127 void phy_mac_interrupt(struct phy_device *phydev);
1128 void phy_start_machine(struct phy_device *phydev);
1129 void phy_stop_machine(struct phy_device *phydev);
1130 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd);
1131 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1132 			       struct ethtool_link_ksettings *cmd);
1133 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1134 			      const struct ethtool_link_ksettings *cmd);
1135 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1136 void phy_request_interrupt(struct phy_device *phydev);
1137 void phy_free_interrupt(struct phy_device *phydev);
1138 void phy_print_status(struct phy_device *phydev);
1139 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1140 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1141 void phy_advertise_supported(struct phy_device *phydev);
1142 void phy_support_sym_pause(struct phy_device *phydev);
1143 void phy_support_asym_pause(struct phy_device *phydev);
1144 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1145 		       bool autoneg);
1146 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1147 bool phy_validate_pause(struct phy_device *phydev,
1148 			struct ethtool_pauseparam *pp);
1149 
1150 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1151 		       int (*run)(struct phy_device *));
1152 int phy_register_fixup_for_id(const char *bus_id,
1153 			      int (*run)(struct phy_device *));
1154 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1155 			       int (*run)(struct phy_device *));
1156 
1157 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1158 int phy_unregister_fixup_for_id(const char *bus_id);
1159 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1160 
1161 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1162 int phy_get_eee_err(struct phy_device *phydev);
1163 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1164 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1165 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1166 void phy_ethtool_get_wol(struct phy_device *phydev,
1167 			 struct ethtool_wolinfo *wol);
1168 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1169 				   struct ethtool_link_ksettings *cmd);
1170 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1171 				   const struct ethtool_link_ksettings *cmd);
1172 int phy_ethtool_nway_reset(struct net_device *ndev);
1173 
1174 #if IS_ENABLED(CONFIG_PHYLIB)
1175 int __init mdio_bus_init(void);
1176 void mdio_bus_exit(void);
1177 #endif
1178 
1179 /* Inline function for use within net/core/ethtool.c (built-in) */
1180 static inline int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
1181 {
1182 	if (!phydev->drv)
1183 		return -EIO;
1184 
1185 	mutex_lock(&phydev->lock);
1186 	phydev->drv->get_strings(phydev, data);
1187 	mutex_unlock(&phydev->lock);
1188 
1189 	return 0;
1190 }
1191 
1192 static inline int phy_ethtool_get_sset_count(struct phy_device *phydev)
1193 {
1194 	int ret;
1195 
1196 	if (!phydev->drv)
1197 		return -EIO;
1198 
1199 	if (phydev->drv->get_sset_count &&
1200 	    phydev->drv->get_strings &&
1201 	    phydev->drv->get_stats) {
1202 		mutex_lock(&phydev->lock);
1203 		ret = phydev->drv->get_sset_count(phydev);
1204 		mutex_unlock(&phydev->lock);
1205 
1206 		return ret;
1207 	}
1208 
1209 	return -EOPNOTSUPP;
1210 }
1211 
1212 static inline int phy_ethtool_get_stats(struct phy_device *phydev,
1213 					struct ethtool_stats *stats, u64 *data)
1214 {
1215 	if (!phydev->drv)
1216 		return -EIO;
1217 
1218 	mutex_lock(&phydev->lock);
1219 	phydev->drv->get_stats(phydev, stats, data);
1220 	mutex_unlock(&phydev->lock);
1221 
1222 	return 0;
1223 }
1224 
1225 extern struct bus_type mdio_bus_type;
1226 
1227 struct mdio_board_info {
1228 	const char	*bus_id;
1229 	char		modalias[MDIO_NAME_SIZE];
1230 	int		mdio_addr;
1231 	const void	*platform_data;
1232 };
1233 
1234 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1235 int mdiobus_register_board_info(const struct mdio_board_info *info,
1236 				unsigned int n);
1237 #else
1238 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1239 					      unsigned int n)
1240 {
1241 	return 0;
1242 }
1243 #endif
1244 
1245 
1246 /**
1247  * module_phy_driver() - Helper macro for registering PHY drivers
1248  * @__phy_drivers: array of PHY drivers to register
1249  *
1250  * Helper macro for PHY drivers which do not do anything special in module
1251  * init/exit. Each module may only use this macro once, and calling it
1252  * replaces module_init() and module_exit().
1253  */
1254 #define phy_module_driver(__phy_drivers, __count)			\
1255 static int __init phy_module_init(void)					\
1256 {									\
1257 	return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1258 }									\
1259 module_init(phy_module_init);						\
1260 static void __exit phy_module_exit(void)				\
1261 {									\
1262 	phy_drivers_unregister(__phy_drivers, __count);			\
1263 }									\
1264 module_exit(phy_module_exit)
1265 
1266 #define module_phy_driver(__phy_drivers)				\
1267 	phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1268 
1269 bool phy_driver_is_genphy(struct phy_device *phydev);
1270 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
1271 
1272 #endif /* __PHY_H */
1273