[PATCH] regmap: clarify struct regmap::max_register value some more

[PATCH] regmap: clarify struct regmap::max_register value some more

[Ahmad Fatoum]

We already have documentation for the member that was taken from Linux,
but still managed to use it wrongly at multiple places that were
recently fixed. To prevent such issues from reoccurring in the future,
expand the documentation a bit.

Suggested-by: Robin van der Gracht <robin@protonic.nl>
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 include/linux/regmap.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index 690dc3b1dccb..9e38fbc12e16 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -31,6 +31,9 @@ enum regmap_endian {
  *         data.
  *
  * @max_register: Optional, specifies the maximum valid register index.
+ *		  This must be a valid register address and thus a multiple
+ *		  of the register stride returned by regmap_get_reg_stride()
+ *		  after registration.
  *
  * @read_flag_mask: Mask to be set in the top byte of the register when doing
  *                  a read.
-- 
2.39.2

Re: [PATCH] regmap: clarify struct regmap::max_register value some more

[Robin van der Gracht]

Thanks!

Acked-by: Robin van der Gracht <robin@protonic.nl>

On Thu, 11 Jan 2024 08:34:12 +0100
Ahmad Fatoum <a.fatoum@pengutronix.de> wrote:

> We already have documentation for the member that was taken from Linux,
> but still managed to use it wrongly at multiple places that were
> recently fixed. To prevent such issues from reoccurring in the future,
> expand the documentation a bit.
> 
> Suggested-by: Robin van der Gracht <robin@protonic.nl>
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
>  include/linux/regmap.h | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/include/linux/regmap.h b/include/linux/regmap.h
> index 690dc3b1dccb..9e38fbc12e16 100644
> --- a/include/linux/regmap.h
> +++ b/include/linux/regmap.h
> @@ -31,6 +31,9 @@ enum regmap_endian {
>   *         data.
>   *
>   * @max_register: Optional, specifies the maximum valid register index.
> + *		  This must be a valid register address and thus a multiple
> + *		  of the register stride returned by regmap_get_reg_stride()
> + *		  after registration.
>   *
>   * @read_flag_mask: Mask to be set in the top byte of the register when doing
>   *                  a read.

Re: [PATCH] regmap: clarify struct regmap::max_register value some more

[Sascha Hauer]

On Thu, 11 Jan 2024 08:34:12 +0100, Ahmad Fatoum wrote:
> We already have documentation for the member that was taken from Linux,
> but still managed to use it wrongly at multiple places that were
> recently fixed. To prevent such issues from reoccurring in the future,
> expand the documentation a bit.
> 
> 

Applied, thanks!

[1/1] regmap: clarify struct regmap::max_register value some more
      commit: 36e096eeed5cd1a5f0f8a0930cd5473d4bd5a699

Best regards,
-- 
Sascha Hauer <s.hauer@pengutronix.de>