Skip to content

Commit

Permalink
regmap: Fixup the kernel-doc comments on functions/structures
Browse files Browse the repository at this point in the history 
Most of the kernel-doc comments in regmap don't actually generate
correctly. This patch fixes up a few common issues, corrects some typos
and adds some missing argument descriptions.

The most common issues being using a : after the function name which
causes the short description to not render correctly and not separating
the long and short descriptions of the function. There are quite a few
instances of arguments not being described or given the wrong name as
well.

This patch doesn't fixup functions/structures that are currently missing
descriptions.

Signed-off-by: Charles Keepax <ckeepax@opensource.wolfsonmicro.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
  • Loading branch information
Charles Keepax authored and Mark Brown committed Jan 12, 2017
1 parent daaadbf commit 2cf8e2d
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 143 deletions.
20 changes: 10 additions & 10 deletions drivers/base/regmap/regcache.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ void regcache_exit(struct regmap *map)
}

/**
* regcache_read: Fetch the value of a given register from the cache.
* regcache_read - Fetch the value of a given register from the cache.
*
* @map: map to configure.
* @reg: The register index.
Expand Down Expand Up @@ -255,7 +255,7 @@ int regcache_read(struct regmap *map,
}

/**
* regcache_write: Set the value of a given register in the cache.
* regcache_write - Set the value of a given register in the cache.
*
* @map: map to configure.
* @reg: The register index.
Expand Down Expand Up @@ -328,7 +328,7 @@ static int regcache_default_sync(struct regmap *map, unsigned int min,
}

/**
* regcache_sync: Sync the register cache with the hardware.
* regcache_sync - Sync the register cache with the hardware.
*
* @map: map to configure.
*
Expand Down Expand Up @@ -396,7 +396,7 @@ int regcache_sync(struct regmap *map)
EXPORT_SYMBOL_GPL(regcache_sync);

/**
* regcache_sync_region: Sync part of the register cache with the hardware.
* regcache_sync_region - Sync part of the register cache with the hardware.
*
* @map: map to sync.
* @min: first register to sync
Expand Down Expand Up @@ -452,7 +452,7 @@ int regcache_sync_region(struct regmap *map, unsigned int min,
EXPORT_SYMBOL_GPL(regcache_sync_region);

/**
* regcache_drop_region: Discard part of the register cache
* regcache_drop_region - Discard part of the register cache
*
* @map: map to operate on
* @min: first register to discard
Expand Down Expand Up @@ -483,10 +483,10 @@ int regcache_drop_region(struct regmap *map, unsigned int min,
EXPORT_SYMBOL_GPL(regcache_drop_region);

/**
* regcache_cache_only: Put a register map into cache only mode
* regcache_cache_only - Put a register map into cache only mode
*
* @map: map to configure
* @cache_only: flag if changes should be written to the hardware
* @enable: flag if changes should be written to the hardware
*
* When a register map is marked as cache only writes to the register
* map API will only update the register cache, they will not cause
Expand All @@ -505,7 +505,7 @@ void regcache_cache_only(struct regmap *map, bool enable)
EXPORT_SYMBOL_GPL(regcache_cache_only);

/**
* regcache_mark_dirty: Indicate that HW registers were reset to default values
* regcache_mark_dirty - Indicate that HW registers were reset to default values
*
* @map: map to mark
*
Expand All @@ -527,10 +527,10 @@ void regcache_mark_dirty(struct regmap *map)
EXPORT_SYMBOL_GPL(regcache_mark_dirty);

/**
* regcache_cache_bypass: Put a register map into cache bypass mode
* regcache_cache_bypass - Put a register map into cache bypass mode
*
* @map: map to configure
* @cache_bypass: flag if changes should not be written to the cache
* @enable: flag if changes should not be written to the cache
*
* When a register map is marked with the cache bypass option, writes
* to the register map API will only update the hardware and not the
Expand Down
62 changes: 33 additions & 29 deletions drivers/base/regmap/regmap-irq.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -398,13 +398,14 @@ static const struct irq_domain_ops regmap_domain_ops = {
};

/**
* regmap_add_irq_chip(): Use standard regmap IRQ controller handling
* regmap_add_irq_chip() - Use standard regmap IRQ controller handling
*
* map: The regmap for the device.
* irq: The IRQ the device uses to signal interrupts
* irq_flags: The IRQF_ flags to use for the primary interrupt.
* chip: Configuration for the interrupt controller.
* data: Runtime data structure for the controller, allocated on success
* @map: The regmap for the device.
* @irq: The IRQ the device uses to signal interrupts.
* @irq_flags: The IRQF_ flags to use for the primary interrupt.
* @irq_base: Allocate at specific IRQ number if irq_base > 0.
* @chip: Configuration for the interrupt controller.
* @data: Runtime data structure for the controller, allocated on success.
*
* Returns 0 on success or an errno on failure.
*
Expand Down Expand Up @@ -659,12 +660,12 @@ int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
EXPORT_SYMBOL_GPL(regmap_add_irq_chip);

/**
* regmap_del_irq_chip(): Stop interrupt handling for a regmap IRQ chip
* regmap_del_irq_chip() - Stop interrupt handling for a regmap IRQ chip
*
* @irq: Primary IRQ for the device
* @d: regmap_irq_chip_data allocated by regmap_add_irq_chip()
* @d: &regmap_irq_chip_data allocated by regmap_add_irq_chip()
*
* This function also dispose all mapped irq on chip.
* This function also disposes of all mapped IRQs on the chip.
*/
void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *d)
{
Expand Down Expand Up @@ -723,18 +724,19 @@ static int devm_regmap_irq_chip_match(struct device *dev, void *res, void *data)
}

/**
* devm_regmap_add_irq_chip(): Resource manager regmap_add_irq_chip()
* devm_regmap_add_irq_chip() - Resource manager regmap_add_irq_chip()
*
* @dev: The device pointer on which irq_chip belongs to.
* @map: The regmap for the device.
* @irq: The IRQ the device uses to signal interrupts
* @dev: The device pointer on which irq_chip belongs to.
* @map: The regmap for the device.
* @irq: The IRQ the device uses to signal interrupts
* @irq_flags: The IRQF_ flags to use for the primary interrupt.
* @chip: Configuration for the interrupt controller.
* @data: Runtime data structure for the controller, allocated on success
* @irq_base: Allocate at specific IRQ number if irq_base > 0.
* @chip: Configuration for the interrupt controller.
* @data: Runtime data structure for the controller, allocated on success
*
* Returns 0 on success or an errno on failure.
*
* The regmap_irq_chip data automatically be released when the device is
* The &regmap_irq_chip_data will be automatically released when the device is
* unbound.
*/
int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
Expand Down Expand Up @@ -765,11 +767,13 @@ int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
EXPORT_SYMBOL_GPL(devm_regmap_add_irq_chip);

/**
* devm_regmap_del_irq_chip(): Resource managed regmap_del_irq_chip()
* devm_regmap_del_irq_chip() - Resource managed regmap_del_irq_chip()
*
* @dev: Device for which which resource was allocated.
* @irq: Primary IRQ for the device
* @d: regmap_irq_chip_data allocated by regmap_add_irq_chip()
* @irq: Primary IRQ for the device.
* @data: &regmap_irq_chip_data allocated by regmap_add_irq_chip().
*
* A resource managed version of regmap_del_irq_chip().
*/
void devm_regmap_del_irq_chip(struct device *dev, int irq,
struct regmap_irq_chip_data *data)
Expand All @@ -786,11 +790,11 @@ void devm_regmap_del_irq_chip(struct device *dev, int irq,
EXPORT_SYMBOL_GPL(devm_regmap_del_irq_chip);

/**
* regmap_irq_chip_get_base(): Retrieve interrupt base for a regmap IRQ chip
* regmap_irq_chip_get_base() - Retrieve interrupt base for a regmap IRQ chip
*
* Useful for drivers to request their own IRQs.
* @data: regmap irq controller to operate on.
*
* @data: regmap_irq controller to operate on.
* Useful for drivers to request their own IRQs.
*/
int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data)
{
Expand All @@ -800,12 +804,12 @@ int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data)
EXPORT_SYMBOL_GPL(regmap_irq_chip_get_base);

/**
* regmap_irq_get_virq(): Map an interrupt on a chip to a virtual IRQ
* regmap_irq_get_virq() - Map an interrupt on a chip to a virtual IRQ
*
* Useful for drivers to request their own IRQs.
* @data: regmap irq controller to operate on.
* @irq: index of the interrupt requested in the chip IRQs.
*
* @data: regmap_irq controller to operate on.
* @irq: index of the interrupt requested in the chip IRQs
* Useful for drivers to request their own IRQs.
*/
int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq)
{
Expand All @@ -818,14 +822,14 @@ int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq)
EXPORT_SYMBOL_GPL(regmap_irq_get_virq);

/**
* regmap_irq_get_domain(): Retrieve the irq_domain for the chip
* regmap_irq_get_domain() - Retrieve the irq_domain for the chip
*
* @data: regmap_irq controller to operate on.
*
* Useful for drivers to request their own IRQs and for integration
* with subsystems. For ease of integration NULL is accepted as a
* domain, allowing devices to just call this even if no domain is
* allocated.
*
* @data: regmap_irq controller to operate on.
*/
struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data)
{
Expand Down
Loading

0 comments on commit 2cf8e2d

Please sign in to comment.