Skip to content

Commit ef4f235

Browse files
rddunlapbroonie
authored andcommitted
regmap: clean up kernel-doc comments
- 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> Signed-off-by: Mark Brown <broonie@kernel.org>
1 parent aba0c1a commit ef4f235

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

include/linux/regmap.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ typedef void (*regmap_hw_free_context)(void *context);
587587
* must serialise with respect to non-async I/O.
588588
* @reg_write: Write a single register value to the given register address. This
589589
* write operation has to complete when returning from the function.
590-
* @reg_write_noinc: Write multiple register value to the same register. This
590+
* @reg_noinc_write: Write multiple register values to the same register. This
591591
* write operation has to complete when returning from the function.
592592
* @reg_update_bits: Update bits operation to be used against volatile
593593
* registers, intended for devices supporting some mechanism
@@ -596,6 +596,8 @@ typedef void (*regmap_hw_free_context)(void *context);
596596
* @read: Read operation. Data is returned in the buffer used to transmit
597597
* data.
598598
* @reg_read: Read a single register value from a given register address.
599+
* @reg_noinc_read: Read multiple register values from the same register. This
600+
* read operation has to complete when returning from the function.
599601
* @free_context: Free context.
600602
* @async_alloc: Allocate a regmap_async() structure.
601603
* @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 device *dev, unsigned int reg);
991993
/**
992994
* regmap_init_sdw_mbq_cfg() - Initialise MBQ SDW register map with config
993995
*
994-
* @sdw: Device that will be interacted with
996+
* @dev: &struct device that will be interacted with
997+
* @sdw: Soundwire device that will be interacted with
995998
* @config: Configuration for register map
996999
* @mbq_config: Properties for the MBQ registers
9971000
*
@@ -1584,6 +1587,7 @@ regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
15841587
* struct regmap_irq_type - IRQ type definitions.
15851588
*
15861589
* @type_reg_offset: Offset register for the irq type setting.
1590+
* @type_reg_mask: Device interrupt mask
15871591
* @type_rising_val: Register value to configure RISING type irq.
15881592
* @type_falling_val: Register value to configure FALLING type irq.
15891593
* @type_level_low_val: Register value to configure LEVEL_LOW type irq.
@@ -1717,6 +1721,8 @@ struct regmap_irq_chip_data;
17171721
* main status base, [0, num_config_regs[ for any config
17181722
* register base, and [0, num_regs[ for any other base.
17191723
* If unspecified then regmap_irq_get_irq_reg_linear() is used.
1724+
* @irq_reqres: Callback function to request IRQ resources (may be %NULL)
1725+
* @irq_relres: Callback function to release IRQ resources (may be %NULL)
17201726
* @irq_drv_data: Driver specific IRQ data which is passed as parameter when
17211727
* driver specific pre/post interrupt handler is called.
17221728
*

0 commit comments

Comments
 (0)