xref: /linux-6.15/include/linux/phy.h (revision e8333284)
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/netlink.h>
19 #include <linux/mdio.h>
20 #include <linux/mii.h>
21 #include <linux/mii_timestamper.h>
22 #include <linux/module.h>
23 #include <linux/timer.h>
24 #include <linux/workqueue.h>
25 #include <linux/mod_devicetable.h>
26 #include <linux/u64_stats_sync.h>
27 #include <linux/irqreturn.h>
28 #include <linux/iopoll.h>
29 #include <linux/refcount.h>
30 
31 #include <linux/atomic.h>
32 
33 #define PHY_DEFAULT_FEATURES	(SUPPORTED_Autoneg | \
34 				 SUPPORTED_TP | \
35 				 SUPPORTED_MII)
36 
37 #define PHY_10BT_FEATURES	(SUPPORTED_10baseT_Half | \
38 				 SUPPORTED_10baseT_Full)
39 
40 #define PHY_100BT_FEATURES	(SUPPORTED_100baseT_Half | \
41 				 SUPPORTED_100baseT_Full)
42 
43 #define PHY_1000BT_FEATURES	(SUPPORTED_1000baseT_Half | \
44 				 SUPPORTED_1000baseT_Full)
45 
46 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
47 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
48 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
49 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
50 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
51 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
52 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
53 extern __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
54 
55 #define PHY_BASIC_FEATURES ((unsigned long *)&phy_basic_features)
56 #define PHY_BASIC_T1_FEATURES ((unsigned long *)&phy_basic_t1_features)
57 #define PHY_GBIT_FEATURES ((unsigned long *)&phy_gbit_features)
58 #define PHY_GBIT_FIBRE_FEATURES ((unsigned long *)&phy_gbit_fibre_features)
59 #define PHY_GBIT_ALL_PORTS_FEATURES ((unsigned long *)&phy_gbit_all_ports_features)
60 #define PHY_10GBIT_FEATURES ((unsigned long *)&phy_10gbit_features)
61 #define PHY_10GBIT_FEC_FEATURES ((unsigned long *)&phy_10gbit_fec_features)
62 #define PHY_10GBIT_FULL_FEATURES ((unsigned long *)&phy_10gbit_full_features)
63 
64 extern const int phy_basic_ports_array[3];
65 extern const int phy_fibre_port_array[1];
66 extern const int phy_all_ports_features_array[7];
67 extern const int phy_10_100_features_array[4];
68 extern const int phy_basic_t1_features_array[2];
69 extern const int phy_gbit_features_array[2];
70 extern const int phy_10gbit_features_array[1];
71 
72 /*
73  * Set phydev->irq to PHY_POLL if interrupts are not supported,
74  * or not desired for this PHY.  Set to PHY_MAC_INTERRUPT if
75  * the attached MAC driver handles the interrupt
76  */
77 #define PHY_POLL		-1
78 #define PHY_MAC_INTERRUPT	-2
79 
80 #define PHY_IS_INTERNAL		0x00000001
81 #define PHY_RST_AFTER_CLK_EN	0x00000002
82 #define PHY_POLL_CABLE_TEST	0x00000004
83 #define MDIO_DEVICE_IS_PHY	0x80000000
84 
85 /**
86  * enum phy_interface_t - Interface Mode definitions
87  *
88  * @PHY_INTERFACE_MODE_NA: Not Applicable - don't touch
89  * @PHY_INTERFACE_MODE_INTERNAL: No interface, MAC and PHY combined
90  * @PHY_INTERFACE_MODE_MII: Median-independent interface
91  * @PHY_INTERFACE_MODE_GMII: Gigabit median-independent interface
92  * @PHY_INTERFACE_MODE_SGMII: Serial gigabit media-independent interface
93  * @PHY_INTERFACE_MODE_TBI: Ten Bit Interface
94  * @PHY_INTERFACE_MODE_REVMII: Reverse Media Independent Interface
95  * @PHY_INTERFACE_MODE_RMII: Reduced Media Independent Interface
96  * @PHY_INTERFACE_MODE_REVRMII: Reduced Media Independent Interface in PHY role
97  * @PHY_INTERFACE_MODE_RGMII: Reduced gigabit media-independent interface
98  * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay
99  * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
100  * @PHY_INTERFACE_MODE_RGMII_TXID: RGMII with Internal RX delay
101  * @PHY_INTERFACE_MODE_RTBI: Reduced TBI
102  * @PHY_INTERFACE_MODE_SMII: ??? MII
103  * @PHY_INTERFACE_MODE_XGMII: 10 gigabit media-independent interface
104  * @PHY_INTERFACE_MODE_XLGMII:40 gigabit media-independent interface
105  * @PHY_INTERFACE_MODE_MOCA: Multimedia over Coax
106  * @PHY_INTERFACE_MODE_QSGMII: Quad SGMII
107  * @PHY_INTERFACE_MODE_TRGMII: Turbo RGMII
108  * @PHY_INTERFACE_MODE_100BASEX: 100 BaseX
109  * @PHY_INTERFACE_MODE_1000BASEX: 1000 BaseX
110  * @PHY_INTERFACE_MODE_2500BASEX: 2500 BaseX
111  * @PHY_INTERFACE_MODE_5GBASER: 5G BaseR
112  * @PHY_INTERFACE_MODE_RXAUI: Reduced XAUI
113  * @PHY_INTERFACE_MODE_XAUI: 10 Gigabit Attachment Unit Interface
114  * @PHY_INTERFACE_MODE_10GBASER: 10G BaseR
115  * @PHY_INTERFACE_MODE_USXGMII:  Universal Serial 10GE MII
116  * @PHY_INTERFACE_MODE_10GKR: 10GBASE-KR - with Clause 73 AN
117  * @PHY_INTERFACE_MODE_MAX: Book keeping
118  *
119  * Describes the interface between the MAC and PHY.
120  */
121 typedef enum {
122 	PHY_INTERFACE_MODE_NA,
123 	PHY_INTERFACE_MODE_INTERNAL,
124 	PHY_INTERFACE_MODE_MII,
125 	PHY_INTERFACE_MODE_GMII,
126 	PHY_INTERFACE_MODE_SGMII,
127 	PHY_INTERFACE_MODE_TBI,
128 	PHY_INTERFACE_MODE_REVMII,
129 	PHY_INTERFACE_MODE_RMII,
130 	PHY_INTERFACE_MODE_REVRMII,
131 	PHY_INTERFACE_MODE_RGMII,
132 	PHY_INTERFACE_MODE_RGMII_ID,
133 	PHY_INTERFACE_MODE_RGMII_RXID,
134 	PHY_INTERFACE_MODE_RGMII_TXID,
135 	PHY_INTERFACE_MODE_RTBI,
136 	PHY_INTERFACE_MODE_SMII,
137 	PHY_INTERFACE_MODE_XGMII,
138 	PHY_INTERFACE_MODE_XLGMII,
139 	PHY_INTERFACE_MODE_MOCA,
140 	PHY_INTERFACE_MODE_QSGMII,
141 	PHY_INTERFACE_MODE_TRGMII,
142 	PHY_INTERFACE_MODE_100BASEX,
143 	PHY_INTERFACE_MODE_1000BASEX,
144 	PHY_INTERFACE_MODE_2500BASEX,
145 	PHY_INTERFACE_MODE_5GBASER,
146 	PHY_INTERFACE_MODE_RXAUI,
147 	PHY_INTERFACE_MODE_XAUI,
148 	/* 10GBASE-R, XFI, SFI - single lane 10G Serdes */
149 	PHY_INTERFACE_MODE_10GBASER,
150 	PHY_INTERFACE_MODE_USXGMII,
151 	/* 10GBASE-KR - with Clause 73 AN */
152 	PHY_INTERFACE_MODE_10GKR,
153 	PHY_INTERFACE_MODE_MAX,
154 } phy_interface_t;
155 
156 /*
157  * phy_supported_speeds - return all speeds currently supported by a PHY device
158  */
159 unsigned int phy_supported_speeds(struct phy_device *phy,
160 				      unsigned int *speeds,
161 				      unsigned int size);
162 
163 /**
164  * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
165  * @interface: enum phy_interface_t value
166  *
167  * Description: maps enum &phy_interface_t defined in this file
168  * into the device tree binding of 'phy-mode', so that Ethernet
169  * device driver can get PHY interface from device tree.
170  */
171 static inline const char *phy_modes(phy_interface_t interface)
172 {
173 	switch (interface) {
174 	case PHY_INTERFACE_MODE_NA:
175 		return "";
176 	case PHY_INTERFACE_MODE_INTERNAL:
177 		return "internal";
178 	case PHY_INTERFACE_MODE_MII:
179 		return "mii";
180 	case PHY_INTERFACE_MODE_GMII:
181 		return "gmii";
182 	case PHY_INTERFACE_MODE_SGMII:
183 		return "sgmii";
184 	case PHY_INTERFACE_MODE_TBI:
185 		return "tbi";
186 	case PHY_INTERFACE_MODE_REVMII:
187 		return "rev-mii";
188 	case PHY_INTERFACE_MODE_RMII:
189 		return "rmii";
190 	case PHY_INTERFACE_MODE_REVRMII:
191 		return "rev-rmii";
192 	case PHY_INTERFACE_MODE_RGMII:
193 		return "rgmii";
194 	case PHY_INTERFACE_MODE_RGMII_ID:
195 		return "rgmii-id";
196 	case PHY_INTERFACE_MODE_RGMII_RXID:
197 		return "rgmii-rxid";
198 	case PHY_INTERFACE_MODE_RGMII_TXID:
199 		return "rgmii-txid";
200 	case PHY_INTERFACE_MODE_RTBI:
201 		return "rtbi";
202 	case PHY_INTERFACE_MODE_SMII:
203 		return "smii";
204 	case PHY_INTERFACE_MODE_XGMII:
205 		return "xgmii";
206 	case PHY_INTERFACE_MODE_XLGMII:
207 		return "xlgmii";
208 	case PHY_INTERFACE_MODE_MOCA:
209 		return "moca";
210 	case PHY_INTERFACE_MODE_QSGMII:
211 		return "qsgmii";
212 	case PHY_INTERFACE_MODE_TRGMII:
213 		return "trgmii";
214 	case PHY_INTERFACE_MODE_1000BASEX:
215 		return "1000base-x";
216 	case PHY_INTERFACE_MODE_2500BASEX:
217 		return "2500base-x";
218 	case PHY_INTERFACE_MODE_5GBASER:
219 		return "5gbase-r";
220 	case PHY_INTERFACE_MODE_RXAUI:
221 		return "rxaui";
222 	case PHY_INTERFACE_MODE_XAUI:
223 		return "xaui";
224 	case PHY_INTERFACE_MODE_10GBASER:
225 		return "10gbase-r";
226 	case PHY_INTERFACE_MODE_USXGMII:
227 		return "usxgmii";
228 	case PHY_INTERFACE_MODE_10GKR:
229 		return "10gbase-kr";
230 	case PHY_INTERFACE_MODE_100BASEX:
231 		return "100base-x";
232 	default:
233 		return "unknown";
234 	}
235 }
236 
237 
238 #define PHY_INIT_TIMEOUT	100000
239 #define PHY_FORCE_TIMEOUT	10
240 
241 #define PHY_MAX_ADDR	32
242 
243 /* Used when trying to connect to a specific phy (mii bus id:phy device id) */
244 #define PHY_ID_FMT "%s:%02x"
245 
246 #define MII_BUS_ID_SIZE	61
247 
248 struct device;
249 struct phylink;
250 struct sfp_bus;
251 struct sfp_upstream_ops;
252 struct sk_buff;
253 
254 /**
255  * struct mdio_bus_stats - Statistics counters for MDIO busses
256  * @transfers: Total number of transfers, i.e. @writes + @reads
257  * @errors: Number of MDIO transfers that returned an error
258  * @writes: Number of write transfers
259  * @reads: Number of read transfers
260  * @syncp: Synchronisation for incrementing statistics
261  */
262 struct mdio_bus_stats {
263 	u64_stats_t transfers;
264 	u64_stats_t errors;
265 	u64_stats_t writes;
266 	u64_stats_t reads;
267 	/* Must be last, add new statistics above */
268 	struct u64_stats_sync syncp;
269 };
270 
271 /**
272  * struct phy_package_shared - Shared information in PHY packages
273  * @addr: Common PHY address used to combine PHYs in one package
274  * @refcnt: Number of PHYs connected to this shared data
275  * @flags: Initialization of PHY package
276  * @priv_size: Size of the shared private data @priv
277  * @priv: Driver private data shared across a PHY package
278  *
279  * Represents a shared structure between different phydev's in the same
280  * package, for example a quad PHY. See phy_package_join() and
281  * phy_package_leave().
282  */
283 struct phy_package_shared {
284 	int addr;
285 	refcount_t refcnt;
286 	unsigned long flags;
287 	size_t priv_size;
288 
289 	/* private data pointer */
290 	/* note that this pointer is shared between different phydevs and
291 	 * the user has to take care of appropriate locking. It is allocated
292 	 * and freed automatically by phy_package_join() and
293 	 * phy_package_leave().
294 	 */
295 	void *priv;
296 };
297 
298 /* used as bit number in atomic bitops */
299 #define PHY_SHARED_F_INIT_DONE  0
300 #define PHY_SHARED_F_PROBE_DONE 1
301 
302 /**
303  * struct mii_bus - Represents an MDIO bus
304  *
305  * @owner: Who owns this device
306  * @name: User friendly name for this MDIO device, or driver name
307  * @id: Unique identifier for this bus, typical from bus hierarchy
308  * @priv: Driver private data
309  *
310  * The Bus class for PHYs.  Devices which provide access to
311  * PHYs should register using this structure
312  */
313 struct mii_bus {
314 	struct module *owner;
315 	const char *name;
316 	char id[MII_BUS_ID_SIZE];
317 	void *priv;
318 	/** @read: Perform a read transfer on the bus */
319 	int (*read)(struct mii_bus *bus, int addr, int regnum);
320 	/** @write: Perform a write transfer on the bus */
321 	int (*write)(struct mii_bus *bus, int addr, int regnum, u16 val);
322 	/** @reset: Perform a reset of the bus */
323 	int (*reset)(struct mii_bus *bus);
324 
325 	/** @stats: Statistic counters per device on the bus */
326 	struct mdio_bus_stats stats[PHY_MAX_ADDR];
327 
328 	/**
329 	 * @mdio_lock: A lock to ensure that only one thing can read/write
330 	 * the MDIO bus at a time
331 	 */
332 	struct mutex mdio_lock;
333 
334 	/** @parent: Parent device of this bus */
335 	struct device *parent;
336 	/** @state: State of bus structure */
337 	enum {
338 		MDIOBUS_ALLOCATED = 1,
339 		MDIOBUS_REGISTERED,
340 		MDIOBUS_UNREGISTERED,
341 		MDIOBUS_RELEASED,
342 	} state;
343 
344 	/** @dev: Kernel device representation */
345 	struct device dev;
346 
347 	/** @mdio_map: list of all MDIO devices on bus */
348 	struct mdio_device *mdio_map[PHY_MAX_ADDR];
349 
350 	/** @phy_mask: PHY addresses to be ignored when probing */
351 	u32 phy_mask;
352 
353 	/** @phy_ignore_ta_mask: PHY addresses to ignore the TA/read failure */
354 	u32 phy_ignore_ta_mask;
355 
356 	/**
357 	 * @irq: An array of interrupts, each PHY's interrupt at the index
358 	 * matching its address
359 	 */
360 	int irq[PHY_MAX_ADDR];
361 
362 	/** @reset_delay_us: GPIO reset pulse width in microseconds */
363 	int reset_delay_us;
364 	/** @reset_post_delay_us: GPIO reset deassert delay in microseconds */
365 	int reset_post_delay_us;
366 	/** @reset_gpiod: Reset GPIO descriptor pointer */
367 	struct gpio_desc *reset_gpiod;
368 
369 	/** @probe_capabilities: bus capabilities, used for probing */
370 	enum {
371 		MDIOBUS_NO_CAP = 0,
372 		MDIOBUS_C22,
373 		MDIOBUS_C45,
374 		MDIOBUS_C22_C45,
375 	} probe_capabilities;
376 
377 	/** @shared_lock: protect access to the shared element */
378 	struct mutex shared_lock;
379 
380 	/** @shared: shared state across different PHYs */
381 	struct phy_package_shared *shared[PHY_MAX_ADDR];
382 };
383 #define to_mii_bus(d) container_of(d, struct mii_bus, dev)
384 
385 struct mii_bus *mdiobus_alloc_size(size_t size);
386 
387 /**
388  * mdiobus_alloc - Allocate an MDIO bus structure
389  *
390  * The internal state of the MDIO bus will be set of MDIOBUS_ALLOCATED ready
391  * for the driver to register the bus.
392  */
393 static inline struct mii_bus *mdiobus_alloc(void)
394 {
395 	return mdiobus_alloc_size(0);
396 }
397 
398 int __mdiobus_register(struct mii_bus *bus, struct module *owner);
399 int __devm_mdiobus_register(struct device *dev, struct mii_bus *bus,
400 			    struct module *owner);
401 #define mdiobus_register(bus) __mdiobus_register(bus, THIS_MODULE)
402 #define devm_mdiobus_register(dev, bus) \
403 		__devm_mdiobus_register(dev, bus, THIS_MODULE)
404 
405 void mdiobus_unregister(struct mii_bus *bus);
406 void mdiobus_free(struct mii_bus *bus);
407 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv);
408 static inline struct mii_bus *devm_mdiobus_alloc(struct device *dev)
409 {
410 	return devm_mdiobus_alloc_size(dev, 0);
411 }
412 
413 struct mii_bus *mdio_find_bus(const char *mdio_name);
414 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr);
415 
416 #define PHY_INTERRUPT_DISABLED	false
417 #define PHY_INTERRUPT_ENABLED	true
418 
419 /**
420  * enum phy_state - PHY state machine states:
421  *
422  * @PHY_DOWN: PHY device and driver are not ready for anything.  probe
423  * should be called if and only if the PHY is in this state,
424  * given that the PHY device exists.
425  * - PHY driver probe function will set the state to @PHY_READY
426  *
427  * @PHY_READY: PHY is ready to send and receive packets, but the
428  * controller is not.  By default, PHYs which do not implement
429  * probe will be set to this state by phy_probe().
430  * - start will set the state to UP
431  *
432  * @PHY_UP: The PHY and attached device are ready to do work.
433  * Interrupts should be started here.
434  * - timer moves to @PHY_NOLINK or @PHY_RUNNING
435  *
436  * @PHY_NOLINK: PHY is up, but not currently plugged in.
437  * - irq or timer will set @PHY_RUNNING if link comes back
438  * - phy_stop moves to @PHY_HALTED
439  *
440  * @PHY_RUNNING: PHY is currently up, running, and possibly sending
441  * and/or receiving packets
442  * - irq or timer will set @PHY_NOLINK if link goes down
443  * - phy_stop moves to @PHY_HALTED
444  *
445  * @PHY_CABLETEST: PHY is performing a cable test. Packet reception/sending
446  * is not expected to work, carrier will be indicated as down. PHY will be
447  * poll once per second, or on interrupt for it current state.
448  * Once complete, move to UP to restart the PHY.
449  * - phy_stop aborts the running test and moves to @PHY_HALTED
450  *
451  * @PHY_HALTED: PHY is up, but no polling or interrupts are done. Or
452  * PHY is in an error state.
453  * - phy_start moves to @PHY_UP
454  */
455 enum phy_state {
456 	PHY_DOWN = 0,
457 	PHY_READY,
458 	PHY_HALTED,
459 	PHY_UP,
460 	PHY_RUNNING,
461 	PHY_NOLINK,
462 	PHY_CABLETEST,
463 };
464 
465 #define MDIO_MMD_NUM 32
466 
467 /**
468  * struct phy_c45_device_ids - 802.3-c45 Device Identifiers
469  * @devices_in_package: IEEE 802.3 devices in package register value.
470  * @mmds_present: bit vector of MMDs present.
471  * @device_ids: The device identifer for each present device.
472  */
473 struct phy_c45_device_ids {
474 	u32 devices_in_package;
475 	u32 mmds_present;
476 	u32 device_ids[MDIO_MMD_NUM];
477 };
478 
479 struct macsec_context;
480 struct macsec_ops;
481 
482 /**
483  * struct phy_device - An instance of a PHY
484  *
485  * @mdio: MDIO bus this PHY is on
486  * @drv: Pointer to the driver for this PHY instance
487  * @phy_id: UID for this device found during discovery
488  * @c45_ids: 802.3-c45 Device Identifiers if is_c45.
489  * @is_c45:  Set to true if this PHY uses clause 45 addressing.
490  * @is_internal: Set to true if this PHY is internal to a MAC.
491  * @is_pseudo_fixed_link: Set to true if this PHY is an Ethernet switch, etc.
492  * @is_gigabit_capable: Set to true if PHY supports 1000Mbps
493  * @has_fixups: Set to true if this PHY has fixups/quirks.
494  * @suspended: Set to true if this PHY has been suspended successfully.
495  * @suspended_by_mdio_bus: Set to true if this PHY was suspended by MDIO bus.
496  * @sysfs_links: Internal boolean tracking sysfs symbolic links setup/removal.
497  * @loopback_enabled: Set true if this PHY has been loopbacked successfully.
498  * @downshifted_rate: Set true if link speed has been downshifted.
499  * @is_on_sfp_module: Set true if PHY is located on an SFP module.
500  * @mac_managed_pm: Set true if MAC driver takes of suspending/resuming PHY
501  * @state: State of the PHY for management purposes
502  * @dev_flags: Device-specific flags used by the PHY driver.
503  *		Bits [15:0] are free to use by the PHY driver to communicate
504  *			    driver specific behavior.
505  *		Bits [23:16] are currently reserved for future use.
506  *		Bits [31:24] are reserved for defining generic
507  *			     PHY driver behavior.
508  * @irq: IRQ number of the PHY's interrupt (-1 if none)
509  * @phy_timer: The timer for handling the state machine
510  * @phylink: Pointer to phylink instance for this PHY
511  * @sfp_bus_attached: Flag indicating whether the SFP bus has been attached
512  * @sfp_bus: SFP bus attached to this PHY's fiber port
513  * @attached_dev: The attached enet driver's device instance ptr
514  * @adjust_link: Callback for the enet controller to respond to changes: in the
515  *               link state.
516  * @phy_link_change: Callback for phylink for notification of link change
517  * @macsec_ops: MACsec offloading ops.
518  *
519  * @speed: Current link speed
520  * @duplex: Current duplex
521  * @port: Current port
522  * @pause: Current pause
523  * @asym_pause: Current asymmetric pause
524  * @supported: Combined MAC/PHY supported linkmodes
525  * @advertising: Currently advertised linkmodes
526  * @adv_old: Saved advertised while power saving for WoL
527  * @lp_advertising: Current link partner advertised linkmodes
528  * @eee_broken_modes: Energy efficient ethernet modes which should be prohibited
529  * @autoneg: Flag autoneg being used
530  * @link: Current link state
531  * @autoneg_complete: Flag auto negotiation of the link has completed
532  * @mdix: Current crossover
533  * @mdix_ctrl: User setting of crossover
534  * @interrupts: Flag interrupts have been enabled
535  * @interface: enum phy_interface_t value
536  * @skb: Netlink message for cable diagnostics
537  * @nest: Netlink nest used for cable diagnostics
538  * @ehdr: nNtlink header for cable diagnostics
539  * @phy_led_triggers: Array of LED triggers
540  * @phy_num_led_triggers: Number of triggers in @phy_led_triggers
541  * @led_link_trigger: LED trigger for link up/down
542  * @last_triggered: last LED trigger for link speed
543  * @master_slave_set: User requested master/slave configuration
544  * @master_slave_get: Current master/slave advertisement
545  * @master_slave_state: Current master/slave configuration
546  * @mii_ts: Pointer to time stamper callbacks
547  * @lock:  Mutex for serialization access to PHY
548  * @state_queue: Work queue for state machine
549  * @shared: Pointer to private data shared by phys in one package
550  * @priv: Pointer to driver private data
551  *
552  * interrupts currently only supports enabled or disabled,
553  * but could be changed in the future to support enabling
554  * and disabling specific interrupts
555  *
556  * Contains some infrastructure for polling and interrupt
557  * handling, as well as handling shifts in PHY hardware state
558  */
559 struct phy_device {
560 	struct mdio_device mdio;
561 
562 	/* Information about the PHY type */
563 	/* And management functions */
564 	struct phy_driver *drv;
565 
566 	u32 phy_id;
567 
568 	struct phy_c45_device_ids c45_ids;
569 	unsigned is_c45:1;
570 	unsigned is_internal:1;
571 	unsigned is_pseudo_fixed_link:1;
572 	unsigned is_gigabit_capable:1;
573 	unsigned has_fixups:1;
574 	unsigned suspended:1;
575 	unsigned suspended_by_mdio_bus:1;
576 	unsigned sysfs_links:1;
577 	unsigned loopback_enabled:1;
578 	unsigned downshifted_rate:1;
579 	unsigned is_on_sfp_module:1;
580 	unsigned mac_managed_pm:1;
581 
582 	unsigned autoneg:1;
583 	/* The most recently read link state */
584 	unsigned link:1;
585 	unsigned autoneg_complete:1;
586 
587 	/* Interrupts are enabled */
588 	unsigned interrupts:1;
589 
590 	enum phy_state state;
591 
592 	u32 dev_flags;
593 
594 	phy_interface_t interface;
595 
596 	/*
597 	 * forced speed & duplex (no autoneg)
598 	 * partner speed & duplex & pause (autoneg)
599 	 */
600 	int speed;
601 	int duplex;
602 	int port;
603 	int pause;
604 	int asym_pause;
605 	u8 master_slave_get;
606 	u8 master_slave_set;
607 	u8 master_slave_state;
608 
609 	/* Union of PHY and Attached devices' supported link modes */
610 	/* See ethtool.h for more info */
611 	__ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
612 	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
613 	__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
614 	/* used with phy_speed_down */
615 	__ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
616 
617 	/* Energy efficient ethernet modes which should be prohibited */
618 	u32 eee_broken_modes;
619 
620 #ifdef CONFIG_LED_TRIGGER_PHY
621 	struct phy_led_trigger *phy_led_triggers;
622 	unsigned int phy_num_led_triggers;
623 	struct phy_led_trigger *last_triggered;
624 
625 	struct phy_led_trigger *led_link_trigger;
626 #endif
627 
628 	/*
629 	 * Interrupt number for this PHY
630 	 * -1 means no interrupt
631 	 */
632 	int irq;
633 
634 	/* private data pointer */
635 	/* For use by PHYs to maintain extra state */
636 	void *priv;
637 
638 	/* shared data pointer */
639 	/* For use by PHYs inside the same package that need a shared state. */
640 	struct phy_package_shared *shared;
641 
642 	/* Reporting cable test results */
643 	struct sk_buff *skb;
644 	void *ehdr;
645 	struct nlattr *nest;
646 
647 	/* Interrupt and Polling infrastructure */
648 	struct delayed_work state_queue;
649 
650 	struct mutex lock;
651 
652 	/* This may be modified under the rtnl lock */
653 	bool sfp_bus_attached;
654 	struct sfp_bus *sfp_bus;
655 	struct phylink *phylink;
656 	struct net_device *attached_dev;
657 	struct mii_timestamper *mii_ts;
658 
659 	u8 mdix;
660 	u8 mdix_ctrl;
661 
662 	void (*phy_link_change)(struct phy_device *phydev, bool up);
663 	void (*adjust_link)(struct net_device *dev);
664 
665 #if IS_ENABLED(CONFIG_MACSEC)
666 	/* MACsec management functions */
667 	const struct macsec_ops *macsec_ops;
668 #endif
669 };
670 
671 static inline struct phy_device *to_phy_device(const struct device *dev)
672 {
673 	return container_of(to_mdio_device(dev), struct phy_device, mdio);
674 }
675 
676 /**
677  * struct phy_tdr_config - Configuration of a TDR raw test
678  *
679  * @first: Distance for first data collection point
680  * @last: Distance for last data collection point
681  * @step: Step between data collection points
682  * @pair: Bitmap of cable pairs to collect data for
683  *
684  * A structure containing possible configuration parameters
685  * for a TDR cable test. The driver does not need to implement
686  * all the parameters, but should report what is actually used.
687  * All distances are in centimeters.
688  */
689 struct phy_tdr_config {
690 	u32 first;
691 	u32 last;
692 	u32 step;
693 	s8 pair;
694 };
695 #define PHY_PAIR_ALL -1
696 
697 /**
698  * struct phy_driver - Driver structure for a particular PHY type
699  *
700  * @mdiodrv: Data common to all MDIO devices
701  * @phy_id: The result of reading the UID registers of this PHY
702  *   type, and ANDing them with the phy_id_mask.  This driver
703  *   only works for PHYs with IDs which match this field
704  * @name: The friendly name of this PHY type
705  * @phy_id_mask: Defines the important bits of the phy_id
706  * @features: A mandatory list of features (speed, duplex, etc)
707  *   supported by this PHY
708  * @flags: A bitfield defining certain other features this PHY
709  *   supports (like interrupts)
710  * @driver_data: Static driver data
711  *
712  * All functions are optional. If config_aneg or read_status
713  * are not implemented, the phy core uses the genphy versions.
714  * Note that none of these functions should be called from
715  * interrupt time. The goal is for the bus read/write functions
716  * to be able to block when the bus transaction is happening,
717  * and be freed up by an interrupt (The MPC85xx has this ability,
718  * though it is not currently supported in the driver).
719  */
720 struct phy_driver {
721 	struct mdio_driver_common mdiodrv;
722 	u32 phy_id;
723 	char *name;
724 	u32 phy_id_mask;
725 	const unsigned long * const features;
726 	u32 flags;
727 	const void *driver_data;
728 
729 	/**
730 	 * @soft_reset: Called to issue a PHY software reset
731 	 */
732 	int (*soft_reset)(struct phy_device *phydev);
733 
734 	/**
735 	 * @config_init: Called to initialize the PHY,
736 	 * including after a reset
737 	 */
738 	int (*config_init)(struct phy_device *phydev);
739 
740 	/**
741 	 * @probe: Called during discovery.  Used to set
742 	 * up device-specific structures, if any
743 	 */
744 	int (*probe)(struct phy_device *phydev);
745 
746 	/**
747 	 * @get_features: Probe the hardware to determine what
748 	 * abilities it has.  Should only set phydev->supported.
749 	 */
750 	int (*get_features)(struct phy_device *phydev);
751 
752 	/* PHY Power Management */
753 	/** @suspend: Suspend the hardware, saving state if needed */
754 	int (*suspend)(struct phy_device *phydev);
755 	/** @resume: Resume the hardware, restoring state if needed */
756 	int (*resume)(struct phy_device *phydev);
757 
758 	/**
759 	 * @config_aneg: Configures the advertisement and resets
760 	 * autonegotiation if phydev->autoneg is on,
761 	 * forces the speed to the current settings in phydev
762 	 * if phydev->autoneg is off
763 	 */
764 	int (*config_aneg)(struct phy_device *phydev);
765 
766 	/** @aneg_done: Determines the auto negotiation result */
767 	int (*aneg_done)(struct phy_device *phydev);
768 
769 	/** @read_status: Determines the negotiated speed and duplex */
770 	int (*read_status)(struct phy_device *phydev);
771 
772 	/**
773 	 * @config_intr: Enables or disables interrupts.
774 	 * It should also clear any pending interrupts prior to enabling the
775 	 * IRQs and after disabling them.
776 	 */
777 	int (*config_intr)(struct phy_device *phydev);
778 
779 	/** @handle_interrupt: Override default interrupt handling */
780 	irqreturn_t (*handle_interrupt)(struct phy_device *phydev);
781 
782 	/** @remove: Clears up any memory if needed */
783 	void (*remove)(struct phy_device *phydev);
784 
785 	/**
786 	 * @match_phy_device: Returns true if this is a suitable
787 	 * driver for the given phydev.	 If NULL, matching is based on
788 	 * phy_id and phy_id_mask.
789 	 */
790 	int (*match_phy_device)(struct phy_device *phydev);
791 
792 	/**
793 	 * @set_wol: Some devices (e.g. qnap TS-119P II) require PHY
794 	 * register changes to enable Wake on LAN, so set_wol is
795 	 * provided to be called in the ethernet driver's set_wol
796 	 * function.
797 	 */
798 	int (*set_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
799 
800 	/**
801 	 * @get_wol: See set_wol, but for checking whether Wake on LAN
802 	 * is enabled.
803 	 */
804 	void (*get_wol)(struct phy_device *dev, struct ethtool_wolinfo *wol);
805 
806 	/**
807 	 * @link_change_notify: Called to inform a PHY device driver
808 	 * when the core is about to change the link state. This
809 	 * callback is supposed to be used as fixup hook for drivers
810 	 * that need to take action when the link state
811 	 * changes. Drivers are by no means allowed to mess with the
812 	 * PHY device structure in their implementations.
813 	 */
814 	void (*link_change_notify)(struct phy_device *dev);
815 
816 	/**
817 	 * @read_mmd: PHY specific driver override for reading a MMD
818 	 * register.  This function is optional for PHY specific
819 	 * drivers.  When not provided, the default MMD read function
820 	 * will be used by phy_read_mmd(), which will use either a
821 	 * direct read for Clause 45 PHYs or an indirect read for
822 	 * Clause 22 PHYs.  devnum is the MMD device number within the
823 	 * PHY device, regnum is the register within the selected MMD
824 	 * device.
825 	 */
826 	int (*read_mmd)(struct phy_device *dev, int devnum, u16 regnum);
827 
828 	/**
829 	 * @write_mmd: PHY specific driver override for writing a MMD
830 	 * register.  This function is optional for PHY specific
831 	 * drivers.  When not provided, the default MMD write function
832 	 * will be used by phy_write_mmd(), which will use either a
833 	 * direct write for Clause 45 PHYs, or an indirect write for
834 	 * Clause 22 PHYs.  devnum is the MMD device number within the
835 	 * PHY device, regnum is the register within the selected MMD
836 	 * device.  val is the value to be written.
837 	 */
838 	int (*write_mmd)(struct phy_device *dev, int devnum, u16 regnum,
839 			 u16 val);
840 
841 	/** @read_page: Return the current PHY register page number */
842 	int (*read_page)(struct phy_device *dev);
843 	/** @write_page: Set the current PHY register page number */
844 	int (*write_page)(struct phy_device *dev, int page);
845 
846 	/**
847 	 * @module_info: Get the size and type of the eeprom contained
848 	 * within a plug-in module
849 	 */
850 	int (*module_info)(struct phy_device *dev,
851 			   struct ethtool_modinfo *modinfo);
852 
853 	/**
854 	 * @module_eeprom: Get the eeprom information from the plug-in
855 	 * module
856 	 */
857 	int (*module_eeprom)(struct phy_device *dev,
858 			     struct ethtool_eeprom *ee, u8 *data);
859 
860 	/** @cable_test_start: Start a cable test */
861 	int (*cable_test_start)(struct phy_device *dev);
862 
863 	/**  @cable_test_tdr_start: Start a raw TDR cable test */
864 	int (*cable_test_tdr_start)(struct phy_device *dev,
865 				    const struct phy_tdr_config *config);
866 
867 	/**
868 	 * @cable_test_get_status: Once per second, or on interrupt,
869 	 * request the status of the test.
870 	 */
871 	int (*cable_test_get_status)(struct phy_device *dev, bool *finished);
872 
873 	/* Get statistics from the PHY using ethtool */
874 	/** @get_sset_count: Number of statistic counters */
875 	int (*get_sset_count)(struct phy_device *dev);
876 	/** @get_strings: Names of the statistic counters */
877 	void (*get_strings)(struct phy_device *dev, u8 *data);
878 	/** @get_stats: Return the statistic counter values */
879 	void (*get_stats)(struct phy_device *dev,
880 			  struct ethtool_stats *stats, u64 *data);
881 
882 	/* Get and Set PHY tunables */
883 	/** @get_tunable: Return the value of a tunable */
884 	int (*get_tunable)(struct phy_device *dev,
885 			   struct ethtool_tunable *tuna, void *data);
886 	/** @set_tunable: Set the value of a tunable */
887 	int (*set_tunable)(struct phy_device *dev,
888 			    struct ethtool_tunable *tuna,
889 			    const void *data);
890 	/** @set_loopback: Set the loopback mood of the PHY */
891 	int (*set_loopback)(struct phy_device *dev, bool enable);
892 	/** @get_sqi: Get the signal quality indication */
893 	int (*get_sqi)(struct phy_device *dev);
894 	/** @get_sqi_max: Get the maximum signal quality indication */
895 	int (*get_sqi_max)(struct phy_device *dev);
896 };
897 #define to_phy_driver(d) container_of(to_mdio_common_driver(d),		\
898 				      struct phy_driver, mdiodrv)
899 
900 #define PHY_ANY_ID "MATCH ANY PHY"
901 #define PHY_ANY_UID 0xffffffff
902 
903 #define PHY_ID_MATCH_EXACT(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 0)
904 #define PHY_ID_MATCH_MODEL(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 4)
905 #define PHY_ID_MATCH_VENDOR(id) .phy_id = (id), .phy_id_mask = GENMASK(31, 10)
906 
907 /* A Structure for boards to register fixups with the PHY Lib */
908 struct phy_fixup {
909 	struct list_head list;
910 	char bus_id[MII_BUS_ID_SIZE + 3];
911 	u32 phy_uid;
912 	u32 phy_uid_mask;
913 	int (*run)(struct phy_device *phydev);
914 };
915 
916 const char *phy_speed_to_str(int speed);
917 const char *phy_duplex_to_str(unsigned int duplex);
918 
919 /* A structure for mapping a particular speed and duplex
920  * combination to a particular SUPPORTED and ADVERTISED value
921  */
922 struct phy_setting {
923 	u32 speed;
924 	u8 duplex;
925 	u8 bit;
926 };
927 
928 const struct phy_setting *
929 phy_lookup_setting(int speed, int duplex, const unsigned long *mask,
930 		   bool exact);
931 size_t phy_speeds(unsigned int *speeds, size_t size,
932 		  unsigned long *mask);
933 void of_set_phy_supported(struct phy_device *phydev);
934 void of_set_phy_eee_broken(struct phy_device *phydev);
935 int phy_speed_down_core(struct phy_device *phydev);
936 
937 /**
938  * phy_is_started - Convenience function to check whether PHY is started
939  * @phydev: The phy_device struct
940  */
941 static inline bool phy_is_started(struct phy_device *phydev)
942 {
943 	return phydev->state >= PHY_UP;
944 }
945 
946 void phy_resolve_aneg_pause(struct phy_device *phydev);
947 void phy_resolve_aneg_linkmode(struct phy_device *phydev);
948 void phy_check_downshift(struct phy_device *phydev);
949 
950 /**
951  * phy_read - Convenience function for reading a given PHY register
952  * @phydev: the phy_device struct
953  * @regnum: register number to read
954  *
955  * NOTE: MUST NOT be called from interrupt context,
956  * because the bus read/write functions may wait for an interrupt
957  * to conclude the operation.
958  */
959 static inline int phy_read(struct phy_device *phydev, u32 regnum)
960 {
961 	return mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
962 }
963 
964 #define phy_read_poll_timeout(phydev, regnum, val, cond, sleep_us, \
965 				timeout_us, sleep_before_read) \
966 ({ \
967 	int __ret = read_poll_timeout(phy_read, val, (cond) || val < 0, \
968 		sleep_us, timeout_us, sleep_before_read, phydev, regnum); \
969 	if (val <  0) \
970 		__ret = val; \
971 	if (__ret) \
972 		phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
973 	__ret; \
974 })
975 
976 
977 /**
978  * __phy_read - convenience function for reading a given PHY register
979  * @phydev: the phy_device struct
980  * @regnum: register number to read
981  *
982  * The caller must have taken the MDIO bus lock.
983  */
984 static inline int __phy_read(struct phy_device *phydev, u32 regnum)
985 {
986 	return __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr, regnum);
987 }
988 
989 /**
990  * phy_write - Convenience function for writing a given PHY register
991  * @phydev: the phy_device struct
992  * @regnum: register number to write
993  * @val: value to write to @regnum
994  *
995  * NOTE: MUST NOT be called from interrupt context,
996  * because the bus read/write functions may wait for an interrupt
997  * to conclude the operation.
998  */
999 static inline int phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1000 {
1001 	return mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum, val);
1002 }
1003 
1004 /**
1005  * __phy_write - Convenience function for writing a given PHY register
1006  * @phydev: the phy_device struct
1007  * @regnum: register number to write
1008  * @val: value to write to @regnum
1009  *
1010  * The caller must have taken the MDIO bus lock.
1011  */
1012 static inline int __phy_write(struct phy_device *phydev, u32 regnum, u16 val)
1013 {
1014 	return __mdiobus_write(phydev->mdio.bus, phydev->mdio.addr, regnum,
1015 			       val);
1016 }
1017 
1018 /**
1019  * __phy_modify_changed() - Convenience function for modifying a PHY register
1020  * @phydev: a pointer to a &struct phy_device
1021  * @regnum: register number
1022  * @mask: bit mask of bits to clear
1023  * @set: bit mask of bits to set
1024  *
1025  * Unlocked helper function which allows a PHY register to be modified as
1026  * new register value = (old register value & ~mask) | set
1027  *
1028  * Returns negative errno, 0 if there was no change, and 1 in case of change
1029  */
1030 static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
1031 				       u16 mask, u16 set)
1032 {
1033 	return __mdiobus_modify_changed(phydev->mdio.bus, phydev->mdio.addr,
1034 					regnum, mask, set);
1035 }
1036 
1037 /*
1038  * phy_read_mmd - Convenience function for reading a register
1039  * from an MMD on a given PHY.
1040  */
1041 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1042 
1043 /**
1044  * phy_read_mmd_poll_timeout - Periodically poll a PHY register until a
1045  *                             condition is met or a timeout occurs
1046  *
1047  * @phydev: The phy_device struct
1048  * @devaddr: The MMD to read from
1049  * @regnum: The register on the MMD to read
1050  * @val: Variable to read the register into
1051  * @cond: Break condition (usually involving @val)
1052  * @sleep_us: Maximum time to sleep between reads in us (0
1053  *            tight-loops).  Should be less than ~20ms since usleep_range
1054  *            is used (see Documentation/timers/timers-howto.rst).
1055  * @timeout_us: Timeout in us, 0 means never timeout
1056  * @sleep_before_read: if it is true, sleep @sleep_us before read.
1057  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
1058  * case, the last read value at @args is stored in @val. Must not
1059  * be called from atomic context if sleep_us or timeout_us are used.
1060  */
1061 #define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
1062 				  sleep_us, timeout_us, sleep_before_read) \
1063 ({ \
1064 	int __ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
1065 				  sleep_us, timeout_us, sleep_before_read, \
1066 				  phydev, devaddr, regnum); \
1067 	if (val <  0) \
1068 		__ret = val; \
1069 	if (__ret) \
1070 		phydev_err(phydev, "%s failed: %d\n", __func__, __ret); \
1071 	__ret; \
1072 })
1073 
1074 /*
1075  * __phy_read_mmd - Convenience function for reading a register
1076  * from an MMD on a given PHY.
1077  */
1078 int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
1079 
1080 /*
1081  * phy_write_mmd - Convenience function for writing a register
1082  * on an MMD on a given PHY.
1083  */
1084 int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1085 
1086 /*
1087  * __phy_write_mmd - Convenience function for writing a register
1088  * on an MMD on a given PHY.
1089  */
1090 int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
1091 
1092 int __phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1093 			 u16 set);
1094 int phy_modify_changed(struct phy_device *phydev, u32 regnum, u16 mask,
1095 		       u16 set);
1096 int __phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1097 int phy_modify(struct phy_device *phydev, u32 regnum, u16 mask, u16 set);
1098 
1099 int __phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1100 			     u16 mask, u16 set);
1101 int phy_modify_mmd_changed(struct phy_device *phydev, int devad, u32 regnum,
1102 			   u16 mask, u16 set);
1103 int __phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1104 		     u16 mask, u16 set);
1105 int phy_modify_mmd(struct phy_device *phydev, int devad, u32 regnum,
1106 		   u16 mask, u16 set);
1107 
1108 /**
1109  * __phy_set_bits - Convenience function for setting bits in a PHY register
1110  * @phydev: the phy_device struct
1111  * @regnum: register number to write
1112  * @val: bits to set
1113  *
1114  * The caller must have taken the MDIO bus lock.
1115  */
1116 static inline int __phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1117 {
1118 	return __phy_modify(phydev, regnum, 0, val);
1119 }
1120 
1121 /**
1122  * __phy_clear_bits - Convenience function for clearing bits in a PHY register
1123  * @phydev: the phy_device struct
1124  * @regnum: register number to write
1125  * @val: bits to clear
1126  *
1127  * The caller must have taken the MDIO bus lock.
1128  */
1129 static inline int __phy_clear_bits(struct phy_device *phydev, u32 regnum,
1130 				   u16 val)
1131 {
1132 	return __phy_modify(phydev, regnum, val, 0);
1133 }
1134 
1135 /**
1136  * phy_set_bits - Convenience function for setting bits in a PHY register
1137  * @phydev: the phy_device struct
1138  * @regnum: register number to write
1139  * @val: bits to set
1140  */
1141 static inline int phy_set_bits(struct phy_device *phydev, u32 regnum, u16 val)
1142 {
1143 	return phy_modify(phydev, regnum, 0, val);
1144 }
1145 
1146 /**
1147  * phy_clear_bits - Convenience function for clearing bits in a PHY register
1148  * @phydev: the phy_device struct
1149  * @regnum: register number to write
1150  * @val: bits to clear
1151  */
1152 static inline int phy_clear_bits(struct phy_device *phydev, u32 regnum, u16 val)
1153 {
1154 	return phy_modify(phydev, regnum, val, 0);
1155 }
1156 
1157 /**
1158  * __phy_set_bits_mmd - Convenience function for setting bits in a register
1159  * on MMD
1160  * @phydev: the phy_device struct
1161  * @devad: the MMD containing register to modify
1162  * @regnum: register number to modify
1163  * @val: bits to set
1164  *
1165  * The caller must have taken the MDIO bus lock.
1166  */
1167 static inline int __phy_set_bits_mmd(struct phy_device *phydev, int devad,
1168 		u32 regnum, u16 val)
1169 {
1170 	return __phy_modify_mmd(phydev, devad, regnum, 0, val);
1171 }
1172 
1173 /**
1174  * __phy_clear_bits_mmd - Convenience function for clearing bits in a register
1175  * on MMD
1176  * @phydev: the phy_device struct
1177  * @devad: the MMD containing register to modify
1178  * @regnum: register number to modify
1179  * @val: bits to clear
1180  *
1181  * The caller must have taken the MDIO bus lock.
1182  */
1183 static inline int __phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1184 		u32 regnum, u16 val)
1185 {
1186 	return __phy_modify_mmd(phydev, devad, regnum, val, 0);
1187 }
1188 
1189 /**
1190  * phy_set_bits_mmd - Convenience function for setting bits in a register
1191  * on MMD
1192  * @phydev: the phy_device struct
1193  * @devad: the MMD containing register to modify
1194  * @regnum: register number to modify
1195  * @val: bits to set
1196  */
1197 static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
1198 		u32 regnum, u16 val)
1199 {
1200 	return phy_modify_mmd(phydev, devad, regnum, 0, val);
1201 }
1202 
1203 /**
1204  * phy_clear_bits_mmd - Convenience function for clearing bits in a register
1205  * on MMD
1206  * @phydev: the phy_device struct
1207  * @devad: the MMD containing register to modify
1208  * @regnum: register number to modify
1209  * @val: bits to clear
1210  */
1211 static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
1212 		u32 regnum, u16 val)
1213 {
1214 	return phy_modify_mmd(phydev, devad, regnum, val, 0);
1215 }
1216 
1217 /**
1218  * phy_interrupt_is_valid - Convenience function for testing a given PHY irq
1219  * @phydev: the phy_device struct
1220  *
1221  * NOTE: must be kept in sync with addition/removal of PHY_POLL and
1222  * PHY_MAC_INTERRUPT
1223  */
1224 static inline bool phy_interrupt_is_valid(struct phy_device *phydev)
1225 {
1226 	return phydev->irq != PHY_POLL && phydev->irq != PHY_MAC_INTERRUPT;
1227 }
1228 
1229 /**
1230  * phy_polling_mode - Convenience function for testing whether polling is
1231  * used to detect PHY status changes
1232  * @phydev: the phy_device struct
1233  */
1234 static inline bool phy_polling_mode(struct phy_device *phydev)
1235 {
1236 	if (phydev->state == PHY_CABLETEST)
1237 		if (phydev->drv->flags & PHY_POLL_CABLE_TEST)
1238 			return true;
1239 
1240 	return phydev->irq == PHY_POLL;
1241 }
1242 
1243 /**
1244  * phy_has_hwtstamp - Tests whether a PHY time stamp configuration.
1245  * @phydev: the phy_device struct
1246  */
1247 static inline bool phy_has_hwtstamp(struct phy_device *phydev)
1248 {
1249 	return phydev && phydev->mii_ts && phydev->mii_ts->hwtstamp;
1250 }
1251 
1252 /**
1253  * phy_has_rxtstamp - Tests whether a PHY supports receive time stamping.
1254  * @phydev: the phy_device struct
1255  */
1256 static inline bool phy_has_rxtstamp(struct phy_device *phydev)
1257 {
1258 	return phydev && phydev->mii_ts && phydev->mii_ts->rxtstamp;
1259 }
1260 
1261 /**
1262  * phy_has_tsinfo - Tests whether a PHY reports time stamping and/or
1263  * PTP hardware clock capabilities.
1264  * @phydev: the phy_device struct
1265  */
1266 static inline bool phy_has_tsinfo(struct phy_device *phydev)
1267 {
1268 	return phydev && phydev->mii_ts && phydev->mii_ts->ts_info;
1269 }
1270 
1271 /**
1272  * phy_has_txtstamp - Tests whether a PHY supports transmit time stamping.
1273  * @phydev: the phy_device struct
1274  */
1275 static inline bool phy_has_txtstamp(struct phy_device *phydev)
1276 {
1277 	return phydev && phydev->mii_ts && phydev->mii_ts->txtstamp;
1278 }
1279 
1280 static inline int phy_hwtstamp(struct phy_device *phydev, struct ifreq *ifr)
1281 {
1282 	return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
1283 }
1284 
1285 static inline bool phy_rxtstamp(struct phy_device *phydev, struct sk_buff *skb,
1286 				int type)
1287 {
1288 	return phydev->mii_ts->rxtstamp(phydev->mii_ts, skb, type);
1289 }
1290 
1291 static inline int phy_ts_info(struct phy_device *phydev,
1292 			      struct ethtool_ts_info *tsinfo)
1293 {
1294 	return phydev->mii_ts->ts_info(phydev->mii_ts, tsinfo);
1295 }
1296 
1297 static inline void phy_txtstamp(struct phy_device *phydev, struct sk_buff *skb,
1298 				int type)
1299 {
1300 	phydev->mii_ts->txtstamp(phydev->mii_ts, skb, type);
1301 }
1302 
1303 /**
1304  * phy_is_internal - Convenience function for testing if a PHY is internal
1305  * @phydev: the phy_device struct
1306  */
1307 static inline bool phy_is_internal(struct phy_device *phydev)
1308 {
1309 	return phydev->is_internal;
1310 }
1311 
1312 /**
1313  * phy_on_sfp - Convenience function for testing if a PHY is on an SFP module
1314  * @phydev: the phy_device struct
1315  */
1316 static inline bool phy_on_sfp(struct phy_device *phydev)
1317 {
1318 	return phydev->is_on_sfp_module;
1319 }
1320 
1321 /**
1322  * phy_interface_mode_is_rgmii - Convenience function for testing if a
1323  * PHY interface mode is RGMII (all variants)
1324  * @mode: the &phy_interface_t enum
1325  */
1326 static inline bool phy_interface_mode_is_rgmii(phy_interface_t mode)
1327 {
1328 	return mode >= PHY_INTERFACE_MODE_RGMII &&
1329 		mode <= PHY_INTERFACE_MODE_RGMII_TXID;
1330 };
1331 
1332 /**
1333  * phy_interface_mode_is_8023z() - does the PHY interface mode use 802.3z
1334  *   negotiation
1335  * @mode: one of &enum phy_interface_t
1336  *
1337  * Returns true if the PHY interface mode uses the 16-bit negotiation
1338  * word as defined in 802.3z. (See 802.3-2015 37.2.1 Config_Reg encoding)
1339  */
1340 static inline bool phy_interface_mode_is_8023z(phy_interface_t mode)
1341 {
1342 	return mode == PHY_INTERFACE_MODE_1000BASEX ||
1343 	       mode == PHY_INTERFACE_MODE_2500BASEX;
1344 }
1345 
1346 /**
1347  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
1348  * is RGMII (all variants)
1349  * @phydev: the phy_device struct
1350  */
1351 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
1352 {
1353 	return phy_interface_mode_is_rgmii(phydev->interface);
1354 };
1355 
1356 /**
1357  * phy_is_pseudo_fixed_link - Convenience function for testing if this
1358  * PHY is the CPU port facing side of an Ethernet switch, or similar.
1359  * @phydev: the phy_device struct
1360  */
1361 static inline bool phy_is_pseudo_fixed_link(struct phy_device *phydev)
1362 {
1363 	return phydev->is_pseudo_fixed_link;
1364 }
1365 
1366 int phy_save_page(struct phy_device *phydev);
1367 int phy_select_page(struct phy_device *phydev, int page);
1368 int phy_restore_page(struct phy_device *phydev, int oldpage, int ret);
1369 int phy_read_paged(struct phy_device *phydev, int page, u32 regnum);
1370 int phy_write_paged(struct phy_device *phydev, int page, u32 regnum, u16 val);
1371 int phy_modify_paged_changed(struct phy_device *phydev, int page, u32 regnum,
1372 			     u16 mask, u16 set);
1373 int phy_modify_paged(struct phy_device *phydev, int page, u32 regnum,
1374 		     u16 mask, u16 set);
1375 
1376 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
1377 				     bool is_c45,
1378 				     struct phy_c45_device_ids *c45_ids);
1379 #if IS_ENABLED(CONFIG_PHYLIB)
1380 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45);
1381 int phy_device_register(struct phy_device *phy);
1382 void phy_device_free(struct phy_device *phydev);
1383 #else
1384 static inline
1385 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1386 {
1387 	return NULL;
1388 }
1389 
1390 static inline int phy_device_register(struct phy_device *phy)
1391 {
1392 	return 0;
1393 }
1394 
1395 static inline void phy_device_free(struct phy_device *phydev) { }
1396 #endif /* CONFIG_PHYLIB */
1397 void phy_device_remove(struct phy_device *phydev);
1398 int phy_init_hw(struct phy_device *phydev);
1399 int phy_suspend(struct phy_device *phydev);
1400 int phy_resume(struct phy_device *phydev);
1401 int __phy_resume(struct phy_device *phydev);
1402 int phy_loopback(struct phy_device *phydev, bool enable);
1403 void phy_sfp_attach(void *upstream, struct sfp_bus *bus);
1404 void phy_sfp_detach(void *upstream, struct sfp_bus *bus);
1405 int phy_sfp_probe(struct phy_device *phydev,
1406 	          const struct sfp_upstream_ops *ops);
1407 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1408 			      phy_interface_t interface);
1409 struct phy_device *phy_find_first(struct mii_bus *bus);
1410 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1411 		      u32 flags, phy_interface_t interface);
1412 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1413 		       void (*handler)(struct net_device *),
1414 		       phy_interface_t interface);
1415 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1416 			       void (*handler)(struct net_device *),
1417 			       phy_interface_t interface);
1418 void phy_disconnect(struct phy_device *phydev);
1419 void phy_detach(struct phy_device *phydev);
1420 void phy_start(struct phy_device *phydev);
1421 void phy_stop(struct phy_device *phydev);
1422 int phy_config_aneg(struct phy_device *phydev);
1423 int phy_start_aneg(struct phy_device *phydev);
1424 int phy_aneg_done(struct phy_device *phydev);
1425 int phy_speed_down(struct phy_device *phydev, bool sync);
1426 int phy_speed_up(struct phy_device *phydev);
1427 
1428 int phy_restart_aneg(struct phy_device *phydev);
1429 int phy_reset_after_clk_enable(struct phy_device *phydev);
1430 
1431 #if IS_ENABLED(CONFIG_PHYLIB)
1432 int phy_start_cable_test(struct phy_device *phydev,
1433 			 struct netlink_ext_ack *extack);
1434 int phy_start_cable_test_tdr(struct phy_device *phydev,
1435 			     struct netlink_ext_ack *extack,
1436 			     const struct phy_tdr_config *config);
1437 #else
1438 static inline
1439 int phy_start_cable_test(struct phy_device *phydev,
1440 			 struct netlink_ext_ack *extack)
1441 {
1442 	NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1443 	return -EOPNOTSUPP;
1444 }
1445 static inline
1446 int phy_start_cable_test_tdr(struct phy_device *phydev,
1447 			     struct netlink_ext_ack *extack,
1448 			     const struct phy_tdr_config *config)
1449 {
1450 	NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");
1451 	return -EOPNOTSUPP;
1452 }
1453 #endif
1454 
1455 int phy_cable_test_result(struct phy_device *phydev, u8 pair, u16 result);
1456 int phy_cable_test_fault_length(struct phy_device *phydev, u8 pair,
1457 				u16 cm);
1458 
1459 static inline void phy_device_reset(struct phy_device *phydev, int value)
1460 {
1461 	mdio_device_reset(&phydev->mdio, value);
1462 }
1463 
1464 #define phydev_err(_phydev, format, args...)	\
1465 	dev_err(&_phydev->mdio.dev, format, ##args)
1466 
1467 #define phydev_info(_phydev, format, args...)	\
1468 	dev_info(&_phydev->mdio.dev, format, ##args)
1469 
1470 #define phydev_warn(_phydev, format, args...)	\
1471 	dev_warn(&_phydev->mdio.dev, format, ##args)
1472 
1473 #define phydev_dbg(_phydev, format, args...)	\
1474 	dev_dbg(&_phydev->mdio.dev, format, ##args)
1475 
1476 static inline const char *phydev_name(const struct phy_device *phydev)
1477 {
1478 	return dev_name(&phydev->mdio.dev);
1479 }
1480 
1481 static inline void phy_lock_mdio_bus(struct phy_device *phydev)
1482 {
1483 	mutex_lock(&phydev->mdio.bus->mdio_lock);
1484 }
1485 
1486 static inline void phy_unlock_mdio_bus(struct phy_device *phydev)
1487 {
1488 	mutex_unlock(&phydev->mdio.bus->mdio_lock);
1489 }
1490 
1491 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1492 	__printf(2, 3);
1493 char *phy_attached_info_irq(struct phy_device *phydev)
1494 	__malloc;
1495 void phy_attached_info(struct phy_device *phydev);
1496 
1497 /* Clause 22 PHY */
1498 int genphy_read_abilities(struct phy_device *phydev);
1499 int genphy_setup_forced(struct phy_device *phydev);
1500 int genphy_restart_aneg(struct phy_device *phydev);
1501 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1502 int genphy_config_eee_advert(struct phy_device *phydev);
1503 int __genphy_config_aneg(struct phy_device *phydev, bool changed);
1504 int genphy_aneg_done(struct phy_device *phydev);
1505 int genphy_update_link(struct phy_device *phydev);
1506 int genphy_read_lpa(struct phy_device *phydev);
1507 int genphy_read_status_fixed(struct phy_device *phydev);
1508 int genphy_read_status(struct phy_device *phydev);
1509 int genphy_suspend(struct phy_device *phydev);
1510 int genphy_resume(struct phy_device *phydev);
1511 int genphy_loopback(struct phy_device *phydev, bool enable);
1512 int genphy_soft_reset(struct phy_device *phydev);
1513 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev);
1514 
1515 static inline int genphy_config_aneg(struct phy_device *phydev)
1516 {
1517 	return __genphy_config_aneg(phydev, false);
1518 }
1519 
1520 static inline int genphy_no_config_intr(struct phy_device *phydev)
1521 {
1522 	return 0;
1523 }
1524 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad,
1525 				u16 regnum);
1526 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1527 				 u16 regnum, u16 val);
1528 
1529 /* Clause 37 */
1530 int genphy_c37_config_aneg(struct phy_device *phydev);
1531 int genphy_c37_read_status(struct phy_device *phydev);
1532 
1533 /* Clause 45 PHY */
1534 int genphy_c45_restart_aneg(struct phy_device *phydev);
1535 int genphy_c45_check_and_restart_aneg(struct phy_device *phydev, bool restart);
1536 int genphy_c45_aneg_done(struct phy_device *phydev);
1537 int genphy_c45_read_link(struct phy_device *phydev);
1538 int genphy_c45_read_lpa(struct phy_device *phydev);
1539 int genphy_c45_read_pma(struct phy_device *phydev);
1540 int genphy_c45_pma_setup_forced(struct phy_device *phydev);
1541 int genphy_c45_an_config_aneg(struct phy_device *phydev);
1542 int genphy_c45_an_disable_aneg(struct phy_device *phydev);
1543 int genphy_c45_read_mdix(struct phy_device *phydev);
1544 int genphy_c45_pma_read_abilities(struct phy_device *phydev);
1545 int genphy_c45_read_status(struct phy_device *phydev);
1546 int genphy_c45_config_aneg(struct phy_device *phydev);
1547 int genphy_c45_loopback(struct phy_device *phydev, bool enable);
1548 int genphy_c45_pma_resume(struct phy_device *phydev);
1549 int genphy_c45_pma_suspend(struct phy_device *phydev);
1550 
1551 /* Generic C45 PHY driver */
1552 extern struct phy_driver genphy_c45_driver;
1553 
1554 /* The gen10g_* functions are the old Clause 45 stub */
1555 int gen10g_config_aneg(struct phy_device *phydev);
1556 
1557 static inline int phy_read_status(struct phy_device *phydev)
1558 {
1559 	if (!phydev->drv)
1560 		return -EIO;
1561 
1562 	if (phydev->drv->read_status)
1563 		return phydev->drv->read_status(phydev);
1564 	else
1565 		return genphy_read_status(phydev);
1566 }
1567 
1568 void phy_driver_unregister(struct phy_driver *drv);
1569 void phy_drivers_unregister(struct phy_driver *drv, int n);
1570 int phy_driver_register(struct phy_driver *new_driver, struct module *owner);
1571 int phy_drivers_register(struct phy_driver *new_driver, int n,
1572 			 struct module *owner);
1573 void phy_error(struct phy_device *phydev);
1574 void phy_state_machine(struct work_struct *work);
1575 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies);
1576 void phy_trigger_machine(struct phy_device *phydev);
1577 void phy_mac_interrupt(struct phy_device *phydev);
1578 void phy_start_machine(struct phy_device *phydev);
1579 void phy_stop_machine(struct phy_device *phydev);
1580 void phy_ethtool_ksettings_get(struct phy_device *phydev,
1581 			       struct ethtool_link_ksettings *cmd);
1582 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1583 			      const struct ethtool_link_ksettings *cmd);
1584 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd);
1585 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd);
1586 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd);
1587 int phy_disable_interrupts(struct phy_device *phydev);
1588 void phy_request_interrupt(struct phy_device *phydev);
1589 void phy_free_interrupt(struct phy_device *phydev);
1590 void phy_print_status(struct phy_device *phydev);
1591 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed);
1592 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode);
1593 void phy_advertise_supported(struct phy_device *phydev);
1594 void phy_support_sym_pause(struct phy_device *phydev);
1595 void phy_support_asym_pause(struct phy_device *phydev);
1596 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
1597 		       bool autoneg);
1598 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
1599 bool phy_validate_pause(struct phy_device *phydev,
1600 			struct ethtool_pauseparam *pp);
1601 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
1602 
1603 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
1604 			   const int *delay_values, int size, bool is_rx);
1605 
1606 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
1607 		       bool *tx_pause, bool *rx_pause);
1608 
1609 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
1610 		       int (*run)(struct phy_device *));
1611 int phy_register_fixup_for_id(const char *bus_id,
1612 			      int (*run)(struct phy_device *));
1613 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
1614 			       int (*run)(struct phy_device *));
1615 
1616 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask);
1617 int phy_unregister_fixup_for_id(const char *bus_id);
1618 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask);
1619 
1620 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable);
1621 int phy_get_eee_err(struct phy_device *phydev);
1622 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data);
1623 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data);
1624 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol);
1625 void phy_ethtool_get_wol(struct phy_device *phydev,
1626 			 struct ethtool_wolinfo *wol);
1627 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1628 				   struct ethtool_link_ksettings *cmd);
1629 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1630 				   const struct ethtool_link_ksettings *cmd);
1631 int phy_ethtool_nway_reset(struct net_device *ndev);
1632 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size);
1633 void phy_package_leave(struct phy_device *phydev);
1634 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1635 			  int addr, size_t priv_size);
1636 
1637 #if IS_ENABLED(CONFIG_PHYLIB)
1638 int __init mdio_bus_init(void);
1639 void mdio_bus_exit(void);
1640 #endif
1641 
1642 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data);
1643 int phy_ethtool_get_sset_count(struct phy_device *phydev);
1644 int phy_ethtool_get_stats(struct phy_device *phydev,
1645 			  struct ethtool_stats *stats, u64 *data);
1646 
1647 static inline int phy_package_read(struct phy_device *phydev, u32 regnum)
1648 {
1649 	struct phy_package_shared *shared = phydev->shared;
1650 
1651 	if (!shared)
1652 		return -EIO;
1653 
1654 	return mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1655 }
1656 
1657 static inline int __phy_package_read(struct phy_device *phydev, u32 regnum)
1658 {
1659 	struct phy_package_shared *shared = phydev->shared;
1660 
1661 	if (!shared)
1662 		return -EIO;
1663 
1664 	return __mdiobus_read(phydev->mdio.bus, shared->addr, regnum);
1665 }
1666 
1667 static inline int phy_package_write(struct phy_device *phydev,
1668 				    u32 regnum, u16 val)
1669 {
1670 	struct phy_package_shared *shared = phydev->shared;
1671 
1672 	if (!shared)
1673 		return -EIO;
1674 
1675 	return mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1676 }
1677 
1678 static inline int __phy_package_write(struct phy_device *phydev,
1679 				      u32 regnum, u16 val)
1680 {
1681 	struct phy_package_shared *shared = phydev->shared;
1682 
1683 	if (!shared)
1684 		return -EIO;
1685 
1686 	return __mdiobus_write(phydev->mdio.bus, shared->addr, regnum, val);
1687 }
1688 
1689 static inline bool __phy_package_set_once(struct phy_device *phydev,
1690 					  unsigned int b)
1691 {
1692 	struct phy_package_shared *shared = phydev->shared;
1693 
1694 	if (!shared)
1695 		return false;
1696 
1697 	return !test_and_set_bit(b, &shared->flags);
1698 }
1699 
1700 static inline bool phy_package_init_once(struct phy_device *phydev)
1701 {
1702 	return __phy_package_set_once(phydev, PHY_SHARED_F_INIT_DONE);
1703 }
1704 
1705 static inline bool phy_package_probe_once(struct phy_device *phydev)
1706 {
1707 	return __phy_package_set_once(phydev, PHY_SHARED_F_PROBE_DONE);
1708 }
1709 
1710 extern struct bus_type mdio_bus_type;
1711 
1712 struct mdio_board_info {
1713 	const char	*bus_id;
1714 	char		modalias[MDIO_NAME_SIZE];
1715 	int		mdio_addr;
1716 	const void	*platform_data;
1717 };
1718 
1719 #if IS_ENABLED(CONFIG_MDIO_DEVICE)
1720 int mdiobus_register_board_info(const struct mdio_board_info *info,
1721 				unsigned int n);
1722 #else
1723 static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
1724 					      unsigned int n)
1725 {
1726 	return 0;
1727 }
1728 #endif
1729 
1730 
1731 /**
1732  * phy_module_driver() - Helper macro for registering PHY drivers
1733  * @__phy_drivers: array of PHY drivers to register
1734  * @__count: Numbers of members in array
1735  *
1736  * Helper macro for PHY drivers which do not do anything special in module
1737  * init/exit. Each module may only use this macro once, and calling it
1738  * replaces module_init() and module_exit().
1739  */
1740 #define phy_module_driver(__phy_drivers, __count)			\
1741 static int __init phy_module_init(void)					\
1742 {									\
1743 	return phy_drivers_register(__phy_drivers, __count, THIS_MODULE); \
1744 }									\
1745 module_init(phy_module_init);						\
1746 static void __exit phy_module_exit(void)				\
1747 {									\
1748 	phy_drivers_unregister(__phy_drivers, __count);			\
1749 }									\
1750 module_exit(phy_module_exit)
1751 
1752 #define module_phy_driver(__phy_drivers)				\
1753 	phy_module_driver(__phy_drivers, ARRAY_SIZE(__phy_drivers))
1754 
1755 bool phy_driver_is_genphy(struct phy_device *phydev);
1756 bool phy_driver_is_genphy_10g(struct phy_device *phydev);
1757 
1758 #endif /* __PHY_H */
1759