1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Copyright (C) 2017 Texas Instruments Incorporated - http://www.ti.com/
4 * Written by Jean-Jacques Hiblot <jjhiblot@ti.com>
7 #ifndef __GENERIC_PHY_H
8 #define __GENERIC_PHY_H
10 #include <dm/ofnode.h>
12 struct ofnode_phandle_args;
15 * struct phy - A handle to (allowing control of) a single phy port.
17 * Clients provide storage for phy handles. The content of the structure is
18 * managed solely by the PHY API and PHY drivers. A phy struct is
19 * initialized by "get"ing the phy struct. The phy struct is passed to all
20 * other phy APIs to identify which PHY port to operate upon.
22 * @dev: The device which implements the PHY port.
23 * @id: The PHY ID within the provider.
32 * struct udevice_ops - set of function pointers for phy operations
33 * @init: operation to be performed for initializing phy (optional)
34 * @exit: operation to be performed while exiting (optional)
35 * @reset: reset the phy (optional).
36 * @power_on: powering on the phy (optional)
37 * @power_off: powering off the phy (optional)
41 * of_xlate - Translate a client's device-tree (OF) phy specifier.
43 * The PHY core calls this function as the first step in implementing
44 * a client's generic_phy_get_by_*() call.
46 * If this function pointer is set to NULL, the PHY core will use a
47 * default implementation, which assumes #phy-cells = <0> or
48 * #phy-cells = <1>, and in the later case that the DT cell
49 * contains a simple integer PHY port ID.
51 * @phy: The phy struct to hold the translation result.
52 * @args: The phy specifier values from device tree.
53 * @return 0 if OK, or a negative error code.
55 int (*of_xlate)(struct phy *phy, struct ofnode_phandle_args *args);
58 * init - initialize the hardware.
60 * Hardware intialization should not be done in during probe() but
61 * should be implemented in this init() function. It could be starting
62 * PLL, taking a controller out of reset, routing, etc. This function
63 * is typically called only once per PHY port.
64 * If power_on() is not implemented, it must power up the phy.
66 * @phy: the PHY port to initialize
67 * @return 0 if OK, or a negative error code.
69 int (*init)(struct phy *phy);
72 * exit - de-initialize the PHY device
74 * Hardware de-intialization should be done here. Every step done in
75 * init() should be undone here.
76 * This could be used to suspend the phy to reduce power consumption or
77 * to put the phy in a known condition before booting the OS (though it
78 * is NOT called automatically before booting the OS)
79 * If power_off() is not implemented, it must power down the phy.
81 * @phy: PHY port to be de-initialized
82 * @return 0 if OK, or a negative error code
84 int (*exit)(struct phy *phy);
87 * reset - resets a PHY device without shutting down
89 * @phy: PHY port to be reset
91 * During runtime, the PHY may need to be reset in order to
92 * re-establish connection etc without being shut down or exit.
94 * @return 0 if OK, or a negative error code
96 int (*reset)(struct phy *phy);
99 * power_on - power on a PHY device
101 * @phy: PHY port to be powered on
103 * During runtime, the PHY may need to be powered on or off several
104 * times. This function is used to power on the PHY. It relies on the
105 * setup done in init(). If init() is not implemented, it must take care
106 * of setting up the context (PLLs, ...)
108 * @return 0 if OK, or a negative error code
110 int (*power_on)(struct phy *phy);
113 * power_off - power off a PHY device
115 * @phy: PHY port to be powered off
117 * During runtime, the PHY may need to be powered on or off several
118 * times. This function is used to power off the PHY. Except if
119 * init()/deinit() are not implemented, it must not de-initialize
122 * @return 0 if OK, or a negative error code
124 int (*power_off)(struct phy *phy);
128 * struct phy_bulk - A handle to (allowing control of) a bulk of phys.
130 * Consumers provide storage for the phy bulk. The content of the structure is
131 * managed solely by the phy API. A phy bulk struct is initialized
132 * by "get"ing the phy bulk struct.
133 * The phy bulk struct is passed to all other bulk phy APIs to apply
134 * the API to all the phy in the bulk struct.
136 * @phys: An array of phy handles.
137 * @count: The number of phy handles in the phys array.
147 * generic_phy_init() - initialize the PHY port
149 * @phy: the PHY port to initialize
150 * @return 0 if OK, or a negative error code
152 int generic_phy_init(struct phy *phy);
155 * generic_phy_init() - de-initialize the PHY device
157 * @phy: PHY port to be de-initialized
158 * @return 0 if OK, or a negative error code
160 int generic_phy_exit(struct phy *phy);
163 * generic_phy_reset() - resets a PHY device without shutting down
165 * @phy: PHY port to be reset
166 *@return 0 if OK, or a negative error code
168 int generic_phy_reset(struct phy *phy);
171 * generic_phy_power_on() - power on a PHY device
173 * @phy: PHY port to be powered on
174 * @return 0 if OK, or a negative error code
176 int generic_phy_power_on(struct phy *phy);
179 * generic_phy_power_off() - power off a PHY device
181 * @phy: PHY port to be powered off
182 * @return 0 if OK, or a negative error code
184 int generic_phy_power_off(struct phy *phy);
188 * generic_phy_get_by_index() - Get a PHY device by integer index.
190 * @user: the client device
191 * @index: The index in the list of available PHYs
192 * @phy: A pointer to the PHY port
194 * This looks up a PHY device for a client device based on its position in the
195 * list of the possible PHYs.
198 * usb1: usb_otg_ss@xxx {
199 * compatible = "xxx";
203 * phys = <&usb2_phy>, <&usb3_phy>;
207 * the USB2 phy can be accessed by passing index '0' and the USB3 phy can
208 * be accessed by passing index '1'
210 * @return 0 if OK, or a negative error code
212 int generic_phy_get_by_index(struct udevice *user, int index,
216 * generic_phy_get_by_node() - Get a PHY device by integer index on ofnode
218 * @node: The client ofnode.
219 * @index: The index in the list of available PHYs
220 * @phy: A pointer to the PHY port
222 * This looks up a PHY device for a client device based on its ofnode and on
223 * its position in the list of the possible PHYs.
226 * usb1: usb_otg_ss@xxx {
227 * compatible = "xxx";
231 * phys = <&usb2_phy>, <&usb3_phy>;
235 * the USB2 phy can be accessed by passing index '0' and the USB3 phy can
236 * be accessed by passing index '1'
238 * @return 0 if OK, or a negative error code
240 int generic_phy_get_by_node(ofnode node, int index, struct phy *phy);
243 * generic_phy_get_by_name() - Get a PHY device by its name.
245 * @user: the client device
246 * @phy_name: The name of the PHY in the list of possible PHYs
247 * @phy: A pointer to the PHY port
249 * This looks up a PHY device for a client device in the
250 * list of the possible PHYs based on its name.
253 * usb1: usb_otg_ss@xxx {
254 * compatible = "xxx";
258 * phys = <&usb2_phy>, <&usb3_phy>;
259 * phy-names = "usb2phy", "usb3phy";
263 * the USB3 phy can be accessed using "usb3phy", and USB2 by using "usb2phy"
265 * @return 0 if OK, or a negative error code
267 int generic_phy_get_by_name(struct udevice *user, const char *phy_name,
271 * generic_phy_get_bulk - Get all phys of a device.
273 * This looks up and gets all phys of the consumer device; each device is
274 * assumed to have n phys associated with it somehow, and this function finds
275 * and gets all of them in a separate structure.
277 * @dev: The consumer device.
278 * @bulk A pointer to a phy bulk struct to initialize.
279 * @return 0 if OK, or a negative error code.
281 int generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk);
284 * generic_phy_init_bulk() - Initialize all phys in a phy bulk struct.
286 * @bulk: A phy bulk struct that was previously successfully requested
287 * by generic_phy_get_bulk().
288 * @return 0 if OK, or negative error code.
290 int generic_phy_init_bulk(struct phy_bulk *bulk);
293 * generic_phy_exit_bulk() - de-initialize all phys in a phy bulk struct.
295 * @bulk: A phy bulk struct that was previously successfully requested
296 * by generic_phy_get_bulk().
297 * @return 0 if OK, or negative error code.
299 int generic_phy_exit_bulk(struct phy_bulk *bulk);
302 * generic_phy_power_on_bulk() - Power on all phys in a phy bulk struct.
304 * @bulk: A phy bulk struct that was previously successfully requested
305 * by generic_phy_get_bulk().
306 * @return 0 if OK, or negative error code.
308 int generic_phy_power_on_bulk(struct phy_bulk *bulk);
311 * generic_phy_power_off_bulk() - Power off all phys in a phy bulk struct.
313 * @bulk: A phy bulk struct that was previously successfully requested
314 * by generic_phy_get_bulk().
315 * @return 0 if OK, or negative error code.
317 int generic_phy_power_off_bulk(struct phy_bulk *bulk);
319 #else /* CONFIG_PHY */
321 static inline int generic_phy_init(struct phy *phy)
326 static inline int generic_phy_exit(struct phy *phy)
331 static inline int generic_phy_reset(struct phy *phy)
336 static inline int generic_phy_power_on(struct phy *phy)
341 static inline int generic_phy_power_off(struct phy *phy)
346 static inline int generic_phy_get_by_index(struct udevice *user, int index,
352 static inline int generic_phy_get_by_name(struct udevice *user, const char *phy_name,
359 generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk)
364 static inline int generic_phy_init_bulk(struct phy_bulk *bulk)
369 static inline int generic_phy_exit_bulk(struct phy_bulk *bulk)
374 static inline int generic_phy_power_on_bulk(struct phy_bulk *bulk)
379 static inline int generic_phy_power_off_bulk(struct phy_bulk *bulk)
384 #endif /* CONFIG_PHY */
387 * generic_phy_valid() - check if PHY port is valid
389 * @phy: the PHY port to check
390 * @return TRUE if valid, or FALSE
392 static inline bool generic_phy_valid(struct phy *phy)
394 return phy && phy->dev;
397 #endif /*__GENERIC_PHY_H */