]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
regmap-irq: Fix typo in documentation for .get_irq_reg()
authorAidan MacDonald <aidanmacdonald.0x0@gmail.com>
Tue, 9 May 2023 11:00:55 +0000 (12:00 +0100)
committerMark Brown <broonie@kernel.org>
Thu, 11 May 2023 01:25:57 +0000 (10:25 +0900)
It refers to a non-existent "num_type_settings" value, which is
an old name I'd used during development of config registers and
later dropped because it wasn't very clear.

The correct bound for the range is num_config_regs, which can
be verified by checking the implementation.

Signed-off-by: Aidan MacDonald <aidanmacdonald.0x0@gmail.com
Link: https://lore.kernel.org/r/20230509110100.3980123-2-aidanmacdonald.0x0@gmail.com
Signed-off-by: Mark Brown <broonie@kernel.org
include/linux/regmap.h

index f820bd44d16ffea335f06760336f6887c0e53795..253f99fb282fe2fa6665e7aec436fc865b8379a9 100644 (file)
@@ -1606,7 +1606,7 @@ struct regmap_irq_chip_data;
  *              addresses. The base register will be one of @status_base,
  *              @mask_base, etc., @main_status, or any of @config_base.
  *              The index will be in the range [0, num_main_regs[ for the
- *              main status base, [0, num_type_settings[ for any config
+ *              main status base, [0, num_config_regs[ for any config
  *              register base, and [0, num_regs[ for any other base.
  *              If unspecified then regmap_irq_get_irq_reg_linear() is used.
  * @irq_drv_data:    Driver specific IRQ data which is passed as parameter when