// SPDX-License-Identifier: GPL-2.0-or-later /* * phy-core.c -- Generic Phy framework. * * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com * * Author: Kishon Vijay Abraham I <[email protected]> */ #include <linux/kernel.h> #include <linux/export.h> #include <linux/module.h> #include <linux/err.h> #include <linux/debugfs.h> #include <linux/device.h> #include <linux/slab.h> #include <linux/of.h> #include <linux/phy/phy.h> #include <linux/idr.h> #include <linux/pm_runtime.h> #include <linux/regulator/consumer.h> static void phy_release(struct device *dev); static const struct class phy_class = …; static struct dentry *phy_debugfs_root; static DEFINE_MUTEX(phy_provider_mutex); static LIST_HEAD(phy_provider_list); static LIST_HEAD(phys); static DEFINE_IDA(phy_ida); static void devm_phy_release(struct device *dev, void *res) { … } static void devm_phy_provider_release(struct device *dev, void *res) { … } static void devm_phy_consume(struct device *dev, void *res) { … } static int devm_phy_match(struct device *dev, void *res, void *match_data) { … } /** * phy_create_lookup() - allocate and register PHY/device association * @phy: the phy of the association * @con_id: connection ID string on device * @dev_id: the device of the association * * Creates and registers phy_lookup entry. */ int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id) { … } EXPORT_SYMBOL_GPL(…); /** * phy_remove_lookup() - find and remove PHY/device association * @phy: the phy of the association * @con_id: connection ID string on device * @dev_id: the device of the association * * Finds and unregisters phy_lookup entry that was created with * phy_create_lookup(). */ void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id) { … } EXPORT_SYMBOL_GPL(…); static struct phy *phy_find(struct device *dev, const char *con_id) { … } static struct phy_provider *of_phy_provider_lookup(struct device_node *node) { … } int phy_pm_runtime_get(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); int phy_pm_runtime_get_sync(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); int phy_pm_runtime_put(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); int phy_pm_runtime_put_sync(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); void phy_pm_runtime_allow(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); void phy_pm_runtime_forbid(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_init - phy internal initialization before phy operation * @phy: the phy returned by phy_get() * * Used to allow phy's driver to perform phy internal initialization, * such as PLL block powering, clock initialization or anything that's * is required by the phy to perform the start of operation. * Must be called before phy_power_on(). * * Return: %0 if successful, a negative error code otherwise */ int phy_init(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_exit - Phy internal un-initialization * @phy: the phy returned by phy_get() * * Must be called after phy_power_off(). * * Return: %0 if successful, a negative error code otherwise */ int phy_exit(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_power_on - Enable the phy and enter proper operation * @phy: the phy returned by phy_get() * * Must be called after phy_init(). * * Return: %0 if successful, a negative error code otherwise */ int phy_power_on(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_power_off - Disable the phy. * @phy: the phy returned by phy_get() * * Must be called before phy_exit(). * * Return: %0 if successful, a negative error code otherwise */ int phy_power_off(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode) { … } EXPORT_SYMBOL_GPL(…); int phy_set_media(struct phy *phy, enum phy_media media) { … } EXPORT_SYMBOL_GPL(…); int phy_set_speed(struct phy *phy, int speed) { … } EXPORT_SYMBOL_GPL(…); int phy_reset(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_calibrate() - Tunes the phy hw parameters for current configuration * @phy: the phy returned by phy_get() * * Used to calibrate phy hardware, typically by adjusting some parameters in * runtime, which are otherwise lost after host controller reset and cannot * be applied in phy_init() or phy_power_on(). * * Return: %0 if successful, a negative error code otherwise */ int phy_calibrate(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_notify_connect() - phy connect notification * @phy: the phy returned by phy_get() * @port: the port index for connect * * If the phy needs to get connection status, the callback can be used. * Returns: %0 if successful, a negative error code otherwise */ int phy_notify_connect(struct phy *phy, int port) { … } EXPORT_SYMBOL_GPL(…); /** * phy_notify_disconnect() - phy disconnect notification * @phy: the phy returned by phy_get() * @port: the port index for disconnect * * If the phy needs to get connection status, the callback can be used. * * Returns: %0 if successful, a negative error code otherwise */ int phy_notify_disconnect(struct phy *phy, int port) { … } EXPORT_SYMBOL_GPL(…); /** * phy_configure() - Changes the phy parameters * @phy: the phy returned by phy_get() * @opts: New configuration to apply * * Used to change the PHY parameters. phy_init() must have been called * on the phy. The configuration will be applied on the current phy * mode, that can be changed using phy_set_mode(). * * Return: %0 if successful, a negative error code otherwise */ int phy_configure(struct phy *phy, union phy_configure_opts *opts) { … } EXPORT_SYMBOL_GPL(…); /** * phy_validate() - Checks the phy parameters * @phy: the phy returned by phy_get() * @mode: phy_mode the configuration is applicable to. * @submode: PHY submode the configuration is applicable to. * @opts: Configuration to check * * Used to check that the current set of parameters can be handled by * the phy. Implementations are free to tune the parameters passed as * arguments if needed by some implementation detail or * constraints. It will not change any actual configuration of the * PHY, so calling it as many times as deemed fit will have no side * effect. * * Return: %0 if successful, a negative error code otherwise */ int phy_validate(struct phy *phy, enum phy_mode mode, int submode, union phy_configure_opts *opts) { … } EXPORT_SYMBOL_GPL(…); /** * _of_phy_get() - lookup and obtain a reference to a phy by phandle * @np: device_node for which to get the phy * @index: the index of the phy * * Returns the phy associated with the given phandle value, * after getting a refcount to it or -ENODEV if there is no such phy or * -EPROBE_DEFER if there is a phandle to the phy, but the device is * not yet loaded. This function uses of_xlate call back function provided * while registering the phy_provider to find the phy instance. */ static struct phy *_of_phy_get(struct device_node *np, int index) { … } /** * of_phy_get() - lookup and obtain a reference to a phy using a device_node. * @np: device_node for which to get the phy * @con_id: name of the phy from device's point of view * * Returns the phy driver, after getting a refcount to it; or * -ENODEV if there is no such phy. The caller is responsible for * calling of_phy_put() to release that count. */ struct phy *of_phy_get(struct device_node *np, const char *con_id) { … } EXPORT_SYMBOL_GPL(…); /** * of_phy_put() - release the PHY * @phy: the phy returned by of_phy_get() * * Releases a refcount the caller received from of_phy_get(). */ void of_phy_put(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * phy_put() - release the PHY * @dev: device that wants to release this phy * @phy: the phy returned by phy_get() * * Releases a refcount the caller received from phy_get(). */ void phy_put(struct device *dev, struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * devm_phy_put() - release the PHY * @dev: device that wants to release this phy * @phy: the phy returned by devm_phy_get() * * destroys the devres associated with this phy and invokes phy_put * to release the phy. */ void devm_phy_put(struct device *dev, struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * of_phy_simple_xlate() - returns the phy instance from phy provider * @dev: the PHY provider device * @args: of_phandle_args (not used here) * * Intended to be used by phy provider for the common case where #phy-cells is * 0. For other cases where #phy-cells is greater than '0', the phy provider * should provide a custom of_xlate function that reads the *args* and returns * the appropriate phy. */ struct phy *of_phy_simple_xlate(struct device *dev, const struct of_phandle_args *args) { … } EXPORT_SYMBOL_GPL(…); /** * phy_get() - lookup and obtain a reference to a phy. * @dev: device that requests this phy * @string: the phy name as given in the dt data or the name of the controller * port for non-dt case * * Returns the phy driver, after getting a refcount to it; or * -ENODEV if there is no such phy. The caller is responsible for * calling phy_put() to release that count. */ struct phy *phy_get(struct device *dev, const char *string) { … } EXPORT_SYMBOL_GPL(…); /** * devm_phy_get() - lookup and obtain a reference to a phy. * @dev: device that requests this phy * @string: the phy name as given in the dt data or phy device name * for non-dt case * * Gets the phy using phy_get(), and associates a device with it using * devres. On driver detach, release function is invoked on the devres data, * then, devres data is freed. */ struct phy *devm_phy_get(struct device *dev, const char *string) { … } EXPORT_SYMBOL_GPL(…); /** * devm_phy_optional_get() - lookup and obtain a reference to an optional phy. * @dev: device that requests this phy * @string: the phy name as given in the dt data or phy device name * for non-dt case * * Gets the phy using phy_get(), and associates a device with it using * devres. On driver detach, release function is invoked on the devres * data, then, devres data is freed. This differs to devm_phy_get() in * that if the phy does not exist, it is not considered an error and * -ENODEV will not be returned. Instead the NULL phy is returned, * which can be passed to all other phy consumer calls. */ struct phy *devm_phy_optional_get(struct device *dev, const char *string) { … } EXPORT_SYMBOL_GPL(…); /** * devm_of_phy_get() - lookup and obtain a reference to a phy. * @dev: device that requests this phy * @np: node containing the phy * @con_id: name of the phy from device's point of view * * Gets the phy using of_phy_get(), and associates a device with it using * devres. On driver detach, release function is invoked on the devres data, * then, devres data is freed. */ struct phy *devm_of_phy_get(struct device *dev, struct device_node *np, const char *con_id) { … } EXPORT_SYMBOL_GPL(…); /** * devm_of_phy_optional_get() - lookup and obtain a reference to an optional * phy. * @dev: device that requests this phy * @np: node containing the phy * @con_id: name of the phy from device's point of view * * Gets the phy using of_phy_get(), and associates a device with it using * devres. On driver detach, release function is invoked on the devres data, * then, devres data is freed. This differs to devm_of_phy_get() in * that if the phy does not exist, it is not considered an error and * -ENODEV will not be returned. Instead the NULL phy is returned, * which can be passed to all other phy consumer calls. */ struct phy *devm_of_phy_optional_get(struct device *dev, struct device_node *np, const char *con_id) { … } EXPORT_SYMBOL_GPL(…); /** * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index. * @dev: device that requests this phy * @np: node containing the phy * @index: index of the phy * * Gets the phy using _of_phy_get(), then gets a refcount to it, * and associates a device with it using devres. On driver detach, * release function is invoked on the devres data, * then, devres data is freed. * */ struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np, int index) { … } EXPORT_SYMBOL_GPL(…); /** * phy_create() - create a new phy * @dev: device that is creating the new phy * @node: device node of the phy * @ops: function pointers for performing phy operations * * Called to create a phy using phy framework. */ struct phy *phy_create(struct device *dev, struct device_node *node, const struct phy_ops *ops) { … } EXPORT_SYMBOL_GPL(…); /** * devm_phy_create() - create a new phy * @dev: device that is creating the new phy * @node: device node of the phy * @ops: function pointers for performing phy operations * * Creates a new PHY device adding it to the PHY class. * While at that, it also associates the device with the phy using devres. * On driver detach, release function is invoked on the devres data, * then, devres data is freed. */ struct phy *devm_phy_create(struct device *dev, struct device_node *node, const struct phy_ops *ops) { … } EXPORT_SYMBOL_GPL(…); /** * phy_destroy() - destroy the phy * @phy: the phy to be destroyed * * Called to destroy the phy. */ void phy_destroy(struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * devm_phy_destroy() - destroy the PHY * @dev: device that wants to release this phy * @phy: the phy returned by devm_phy_get() * * destroys the devres associated with this phy and invokes phy_destroy * to destroy the phy. */ void devm_phy_destroy(struct device *dev, struct phy *phy) { … } EXPORT_SYMBOL_GPL(…); /** * __of_phy_provider_register() - create/register phy provider with the framework * @dev: struct device of the phy provider * @children: device node containing children (if different from dev->of_node) * @owner: the module owner containing of_xlate * @of_xlate: function pointer to obtain phy instance from phy provider * * Creates struct phy_provider from dev and of_xlate function pointer. * This is used in the case of dt boot for finding the phy instance from * phy provider. * * If the PHY provider doesn't nest children directly but uses a separate * child node to contain the individual children, the @children parameter * can be used to override the default. If NULL, the default (dev->of_node) * will be used. If non-NULL, the device node must be a child (or further * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL * error code is returned. */ struct phy_provider *__of_phy_provider_register(struct device *dev, struct device_node *children, struct module *owner, struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args)) { … } EXPORT_SYMBOL_GPL(…); /** * __devm_of_phy_provider_register() - create/register phy provider with the * framework * @dev: struct device of the phy provider * @children: device node containing children (if different from dev->of_node) * @owner: the module owner containing of_xlate * @of_xlate: function pointer to obtain phy instance from phy provider * * Creates struct phy_provider from dev and of_xlate function pointer. * This is used in the case of dt boot for finding the phy instance from * phy provider. While at that, it also associates the device with the * phy provider using devres. On driver detach, release function is invoked * on the devres data, then, devres data is freed. */ struct phy_provider *__devm_of_phy_provider_register(struct device *dev, struct device_node *children, struct module *owner, struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args)) { … } EXPORT_SYMBOL_GPL(…); /** * of_phy_provider_unregister() - unregister phy provider from the framework * @phy_provider: phy provider returned by of_phy_provider_register() * * Removes the phy_provider created using of_phy_provider_register(). */ void of_phy_provider_unregister(struct phy_provider *phy_provider) { … } EXPORT_SYMBOL_GPL(…); /** * devm_of_phy_provider_unregister() - remove phy provider from the framework * @dev: struct device of the phy provider * @phy_provider: phy provider returned by of_phy_provider_register() * * destroys the devres associated with this phy provider and invokes * of_phy_provider_unregister to unregister the phy provider. */ void devm_of_phy_provider_unregister(struct device *dev, struct phy_provider *phy_provider) { … } EXPORT_SYMBOL_GPL(…); /** * phy_release() - release the phy * @dev: the dev member within phy * * When the last reference to the device is removed, it is called * from the embedded kobject as release method. */ static void phy_release(struct device *dev) { … } static int __init phy_core_init(void) { … } device_initcall(phy_core_init); static void __exit phy_core_exit(void) { … } module_exit(phy_core_exit);
Codebase Browser
linux