[PATCH] regmap: clean up kernel-doc comments

Randy Dunlap posted 1 patch 9 hours ago
include/linux/regmap.h |   10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
[PATCH] regmap: clean up kernel-doc comments
Posted by Randy Dunlap 9 hours ago
- add/correct missing struct members in struct regmap_bus
- add a missing function parameter @dev
- add missing struct member in struct regmap_irq_type
- add missing struct members in struct regmap_irq_chip

to prevent kernel-doc warnings:

Warning: include/linux/regmap.h:630 struct member 'reg_noinc_write' not
 described in 'regmap_bus'
Warning: include/linux/regmap.h:630 struct member 'reg_noinc_read' not
 described in 'regmap_bus'
Warning: include/linux/regmap.h:630 Excess struct member 'reg_write_noinc'
 description in 'regmap_bus'
Warning: include/linux/regmap.h:1001 function parameter 'dev' not
 described in 'regmap_init_sdw_mbq_cfg'
Warning: include/linux/regmap.h:1600 struct member 'type_reg_mask' not
 described in 'regmap_irq_type'
Warning: include/linux/regmap.h:1775 struct member 'irq_reqres' not
 described in 'regmap_irq_chip'
Warning: include/linux/regmap.h:1775 struct member 'irq_relres' not
 described in 'regmap_irq_chip'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Mark Brown <broonie@kernel.org>
Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>

 include/linux/regmap.h |   10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

--- linux-next-20260722.orig/include/linux/regmap.h
+++ linux-next-20260722/include/linux/regmap.h
@@ -587,7 +587,7 @@ typedef void (*regmap_hw_free_context)(v
  *               must serialise with respect to non-async I/O.
  * @reg_write: Write a single register value to the given register address. This
  *             write operation has to complete when returning from the function.
- * @reg_write_noinc: Write multiple register value to the same register. This
+ * @reg_noinc_write: Write multiple register values to the same register. This
  *             write operation has to complete when returning from the function.
  * @reg_update_bits: Update bits operation to be used against volatile
  *                   registers, intended for devices supporting some mechanism
@@ -596,6 +596,8 @@ typedef void (*regmap_hw_free_context)(v
  * @read: Read operation.  Data is returned in the buffer used to transmit
  *         data.
  * @reg_read: Read a single register value from a given register address.
+ * @reg_noinc_read: Read multiple register values from the same register. This
+ *             read operation has to complete when returning from the function.
  * @free_context: Free context.
  * @async_alloc: Allocate a regmap_async() structure.
  * @read_flag_mask: Mask to be set in the top byte of the register when doing
@@ -991,7 +993,8 @@ bool regmap_ac97_default_volatile(struct
 /**
  * regmap_init_sdw_mbq_cfg() - Initialise MBQ SDW register map with config
  *
- * @sdw: Device that will be interacted with
+ * @dev: &struct device that will be interacted with
+ * @sdw: Soundwire device that will be interacted with
  * @config: Configuration for register map
  * @mbq_config: Properties for the MBQ registers
  *
@@ -1584,6 +1587,7 @@ regmap_fields_force_update_bits(struct r
  * struct regmap_irq_type - IRQ type definitions.
  *
  * @type_reg_offset: Offset register for the irq type setting.
+ * @type_reg_mask: Device interrupt mask
  * @type_rising_val: Register value to configure RISING type irq.
  * @type_falling_val: Register value to configure FALLING type irq.
  * @type_level_low_val: Register value to configure LEVEL_LOW type irq.
@@ -1717,6 +1721,8 @@ struct regmap_irq_chip_data;
  *		 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_reqres:	 Callback function to request IRQ resources (may be %NULL)
+ * @irq_relres:  Callback function to release IRQ resources (may be %NULL)
  * @irq_drv_data:    Driver specific IRQ data which is passed as parameter when
  *		     driver specific pre/post interrupt handler is called.
  *
Re: [PATCH] regmap: clean up kernel-doc comments
Posted by Mark Brown 3 hours ago
On Thu, 23 Jul 2026 11:12:15 -0700, Randy Dunlap wrote:
> - add/correct missing struct members in struct regmap_bus
> - add a missing function parameter @dev
> - add missing struct member in struct regmap_irq_type
> - add missing struct members in struct regmap_irq_chip
> 
> to prevent kernel-doc warnings:
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regmap.git for-next

Thanks!

[1/1] regmap: clean up kernel-doc comments
      https://git.kernel.org/broonie/misc/c/ef4f2357df6e

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark