diff mbox series

[net-next,v6,03/10] net: phy: introduce phy_read_mmd_poll_timeout macro

Message ID 20200323025633.6069-4-zhengdejin5@gmail.com
State Superseded
Headers show
Series introduce read_poll_timeout | expand

Commit Message

Dejin Zheng March 23, 2020, 2:56 a.m. UTC
it is sometimes necessary to poll a phy register by phy_read_mmd()
function until its value satisfies some condition. introduce
phy_read_mmd_poll_timeout() macros that do this.

Suggested-by: Andrew Lunn <andrew@lunn.ch>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Signed-off-by: Dejin Zheng <zhengdejin5@gmail.com>
---
v5 -> v6:
	- no changed
v4 -> v5:
	- no changed
v3 -> v4:
	- deal with precedence issues for parameter cond.
v2 -> v3:
	- modify the parameter order of newly added functions.
	  phy_read_mmd_poll_timeout(val, cond, sleep_us, timeout_us, \
				     phydev, devaddr, regnum)
				||
				\/
	  phy_read_mmd_poll_timeout(phydev, devaddr regnum, val, cond, \
				    sleep_us, timeout_us)
v1 -> v2:
	- passed a phydev, device address and a reg to replace args...
	  parameter in phy_read_mmd_poll_timeout() by Andrew Lunn 's
	  suggestion. Andrew Lunn <andrew@lunn.ch>, Thanks very much for
	  your help!
	- handle phy_read_mmd return an error(the return value < 0) in
	  phy_read_mmd_poll_timeout(). Thanks Andrew again.


 include/linux/phy.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Florian Fainelli March 23, 2020, 3:21 a.m. UTC | #1
On 3/22/2020 7:56 PM, Dejin Zheng wrote:
> it is sometimes necessary to poll a phy register by phy_read_mmd()
> function until its value satisfies some condition. introduce
> phy_read_mmd_poll_timeout() macros that do this.
> 
> Suggested-by: Andrew Lunn <andrew@lunn.ch>
> Reviewed-by: Andrew Lunn <andrew@lunn.ch>
> Signed-off-by: Dejin Zheng <zhengdejin5@gmail.com>
> ---
> v5 -> v6:
> 	- no changed
> v4 -> v5:
> 	- no changed
> v3 -> v4:
> 	- deal with precedence issues for parameter cond.
> v2 -> v3:
> 	- modify the parameter order of newly added functions.
> 	  phy_read_mmd_poll_timeout(val, cond, sleep_us, timeout_us, \
> 				     phydev, devaddr, regnum)
> 				||
> 				\/
> 	  phy_read_mmd_poll_timeout(phydev, devaddr regnum, val, cond, \
> 				    sleep_us, timeout_us)
> v1 -> v2:
> 	- passed a phydev, device address and a reg to replace args...
> 	  parameter in phy_read_mmd_poll_timeout() by Andrew Lunn 's
> 	  suggestion. Andrew Lunn <andrew@lunn.ch>, Thanks very much for
> 	  your help!
> 	- handle phy_read_mmd return an error(the return value < 0) in
> 	  phy_read_mmd_poll_timeout(). Thanks Andrew again.
> 
> 
>  include/linux/phy.h | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/include/linux/phy.h b/include/linux/phy.h
> index 36d9dea04016..42a5ec9288d5 100644
> --- a/include/linux/phy.h
> +++ b/include/linux/phy.h
> @@ -24,6 +24,7 @@
>  #include <linux/mod_devicetable.h>
>  #include <linux/u64_stats_sync.h>
>  #include <linux/irqreturn.h>
> +#include <linux/iopoll.h>
>  
>  #include <linux/atomic.h>
>  
> @@ -784,6 +785,20 @@ static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
>   */
>  int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
>  
> +#define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
> +				  sleep_us, timeout_us) \
> +({ \
> +	int ret = 0; \
> +	ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
> +				sleep_us, timeout_us, phydev, devaddr, \
> +				regnum); \
> +	if (val <  0) \
> +		ret = val; \
> +	if (ret) \
> +		phydev_err(phydev, "%s failed: %d\n", __func__, ret); \

Likewise, you may consider declaring ret as __ret to avoid any possible
shadowing/re-declaration. With that:

Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
diff mbox series

Patch

diff --git a/include/linux/phy.h b/include/linux/phy.h
index 36d9dea04016..42a5ec9288d5 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -24,6 +24,7 @@ 
 #include <linux/mod_devicetable.h>
 #include <linux/u64_stats_sync.h>
 #include <linux/irqreturn.h>
+#include <linux/iopoll.h>
 
 #include <linux/atomic.h>
 
@@ -784,6 +785,20 @@  static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
  */
 int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
 
+#define phy_read_mmd_poll_timeout(phydev, devaddr, regnum, val, cond, \
+				  sleep_us, timeout_us) \
+({ \
+	int ret = 0; \
+	ret = read_poll_timeout(phy_read_mmd, val, (cond) || val < 0, \
+				sleep_us, timeout_us, phydev, devaddr, \
+				regnum); \
+	if (val <  0) \
+		ret = val; \
+	if (ret) \
+		phydev_err(phydev, "%s failed: %d\n", __func__, ret); \
+	ret; \
+})
+
 /**
  * __phy_read_mmd - Convenience function for reading a register
  * from an MMD on a given PHY.