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