Subject: [PATCHv3 2/4] phy: core: Add devm_of_phy_get_by_index to phy-core

From: [email-masked] (Kishon Vijay Abraham I)
Date: Mon, 11 May 2015 20:39:57 +0530

Hi,

On Thursday 23 April 2015 04:34 AM, Arun Ramamurthy wrote:
> Some generic drivers, such as ehci, may use multiple phys and for such
> drivers referencing phy(s) by name(s) does not make sense. Instead of
> inventing new naming schemes and using custom code to iterate through them,
> such drivers are better of using nameless phy bindings and using this newly
> introduced API to iterate through them.
>
> Signed-off-by: Arun Ramamurthy <[email-masked]>
> Reviewed-by: Ray Jui <[email-masked]>
> Reviewed-by: Scott Branden <[email-masked]>
> ---
>   Documentation/phy.txt   |  7 ++++++-
>   drivers/phy/phy-core.c  | 32 ++++++++++++++++++++++++++++++++
>   include/linux/phy/phy.h |  8 ++++++++
>   3 files changed, 46 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/phy.txt b/Documentation/phy.txt
> index 371361c..b388c5a 100644
> --- a/Documentation/phy.txt
> +++ b/Documentation/phy.txt
> @@ -76,6 +76,8 @@ struct phy *phy_get(struct device *dev, const char *string);
>   struct phy *phy_optional_get(struct device *dev, const char *string);
>   struct phy *devm_phy_get(struct device *dev, const char *string);
>   struct phy *devm_phy_optional_get(struct device *dev, const char *string);
> +struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
> +				     int index);
>
>   phy_get, phy_optional_get, devm_phy_get and devm_phy_optional_get can
>   be used to get the PHY. In the case of dt boot, the string arguments
> @@ -86,7 +88,10 @@ successful PHY get. On driver detach, release function is invoked on
>   the the devres data and devres data is freed. phy_optional_get and
>   devm_phy_optional_get should be used when the phy is optional. These
>   two functions will never return -ENODEV, but instead returns NULL when
> -the phy cannot be found.
> +the phy cannot be found.Some generic drivers, such as ehci, may use multiple
> +phys and for such drivers referencing phy(s) by name(s) does not make sense. In
> +this case, devm_of_phy_get_by_index can be used to get a phy reference based on
> +the index.
>
>   It should be noted that NULL is a valid phy reference. All phy
>   consumer calls on the NULL phy become NOPs. That is the release calls,
> diff --git a/drivers/phy/phy-core.c b/drivers/phy/phy-core.c
> index 3791838..964a84d 100644
> --- a/drivers/phy/phy-core.c
> +++ b/drivers/phy/phy-core.c
> @@ -623,6 +623,38 @@ struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
>   EXPORT_SYMBOL_GPL(devm_of_phy_get);
>
>   /**
> + * 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(), 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)
> +{
> +	struct phy **ptr, *phy;
> +
> +	ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
> +	if (!ptr)
> +		return ERR_PTR(-ENOMEM);
> +
> +	phy = _of_phy_get(np, index);
> +	if (!IS_ERR(phy)) {
> +		*ptr = phy;
> +		devres_add(dev, ptr);
> +	} else {
> +		devres_free(ptr);
> +	}
> +
> +	return phy;
> +}
> +EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
> +
> +/**
>    * phy_create() - create a new phy
>    * @dev: device that is creating the new phy
>    * @node: device node of the phy
> diff --git a/include/linux/phy/phy.h b/include/linux/phy/phy.h
> index a0197fa..978d5af 100644
> --- a/include/linux/phy/phy.h
> +++ b/include/linux/phy/phy.h
> @@ -133,6 +133,8 @@ struct phy *devm_phy_get(struct device *dev, const char *string);
>   struct phy *devm_phy_optional_get(struct device *dev, const char *string);
>   struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
>   			    const char *con_id);
> +struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
> +				     int index);
>   void phy_put(struct phy *phy);
>   void devm_phy_put(struct device *dev, struct phy *phy);
>   struct phy *of_phy_get(struct device_node *np, const char *con_id);
> @@ -261,6 +263,12 @@ static inline struct phy *devm_of_phy_get(struct device *dev,
>   	return ERR_PTR(-ENOSYS);
>   }
>
> +struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
> +				     int index);

Fixed the compilation error because of the ';' in the end and merged it to 
linux-phy.

Thanks
Kishon