[PATCH] pinctrl: sh-pfc: Improve PINMUX_IPSR_PHYS() documentation

[PATCH] pinctrl: sh-pfc: Improve PINMUX_IPSR_PHYS() documentation

[Geert Uytterhoeven]

  - The IPSR field is meant for documentation only,
  - The function name refers to the pin function, not to the IPSR field.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
To be queued in sh-pfc-for-v5.2.

 drivers/pinctrl/sh-pfc/sh_pfc.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/pinctrl/sh-pfc/sh_pfc.h b/drivers/pinctrl/sh-pfc/sh_pfc.h
index 2a6abeb62bab659b..7db5819eea7e6e0d 100644
--- a/drivers/pinctrl/sh-pfc/sh_pfc.h
+++ b/drivers/pinctrl/sh-pfc/sh_pfc.h
@@ -418,8 +418,8 @@ extern const struct sh_pfc_soc_info shx3_pinmux_info;
 /*
  * Describe a pinmux configuration in which a pin is physically multiplexed
  * with other pins.
- *   - ipsr: IPSR field
- *   - fn: Function name, also referring to the IPSR field
+ *   - ipsr: IPSR field (unused, for documentation purposes only)
+ *   - fn: Function name
  *   - psel: Physical multiplexing selector
  */
 #define PINMUX_IPSR_PHYS(ipsr, fn, psel) \
-- 
2.17.1

Re: [PATCH] pinctrl: sh-pfc: Improve PINMUX_IPSR_PHYS() documentation

[Niklas Söderlund]

Hi Geert,

Thanks for your work.

On 2019-03-20 11:44:46 +0100, Geert Uytterhoeven wrote:
>   - The IPSR field is meant for documentation only,
>   - The function name refers to the pin function, not to the IPSR field.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Reviewed-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>

> ---
> To be queued in sh-pfc-for-v5.2.
> 
>  drivers/pinctrl/sh-pfc/sh_pfc.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/pinctrl/sh-pfc/sh_pfc.h b/drivers/pinctrl/sh-pfc/sh_pfc.h
> index 2a6abeb62bab659b..7db5819eea7e6e0d 100644
> --- a/drivers/pinctrl/sh-pfc/sh_pfc.h
> +++ b/drivers/pinctrl/sh-pfc/sh_pfc.h
> @@ -418,8 +418,8 @@ extern const struct sh_pfc_soc_info shx3_pinmux_info;
>  /*
>   * Describe a pinmux configuration in which a pin is physically multiplexed
>   * with other pins.
> - *   - ipsr: IPSR field
> - *   - fn: Function name, also referring to the IPSR field
> + *   - ipsr: IPSR field (unused, for documentation purposes only)
> + *   - fn: Function name
>   *   - psel: Physical multiplexing selector
>   */
>  #define PINMUX_IPSR_PHYS(ipsr, fn, psel) \
> -- 
> 2.17.1
> 

-- 
Regards,
Niklas Söderlund