leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pinctrl: core: Fix a bunch of kerneldoc issues

Browse Source 
Most are likely due to bitrot/API slip.  Some are formatting issues.

Fixes the following W=1 kernel build warning(s):

 drivers/pinctrl/core.c:167: warning: Function parameter or member 'pin' not described in 'pin_get_name'
 drivers/pinctrl/core.c:167: warning: Excess function parameter 'name' description in 'pin_get_name'
 drivers/pinctrl/core.c:584: warning: Function parameter or member 'selector' not described in 'pinctrl_generic_get_group'
 drivers/pinctrl/core.c:584: warning: Excess function parameter 'gselector' description in 'pinctrl_generic_get_group'
 drivers/pinctrl/core.c:1356: error: Cannot parse struct or union!
 drivers/pinctrl/core.c:1458: warning: Function parameter or member 'map' not described in 'pinctrl_unregister_mappings'
 drivers/pinctrl/core.c:1458: warning: Excess function parameter 'maps' description in 'pinctrl_unregister_mappings'
 drivers/pinctrl/core.c:2239: warning: Function parameter or member 'pctldev' not described in 'devm_pinctrl_register_and_init'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200713144930.1034632-12-lee.jones@linaro.org
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
This commit is contained in:
Lee Jones
2020-07-13 15:49:16 +01:00
committed by Linus Walleij
parent ea0b879b5d
commit 9c340bbbf7
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
drivers/pinctrl/core.c
View File

@@ -161,7 +161,7 @@ int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name)
/** /**
* pin_get_name_from_id() - look up a pin name from a pin id * pin_get_name_from_id() - look up a pin name from a pin id
* @pctldev: the pin control device to lookup the pin on * @pctldev: the pin control device to lookup the pin on
* @name: the name of the pin to look up * @pin: pin number/id to look up
*/ */
const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin) const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin)
{ {
@@ -577,7 +577,7 @@ EXPORT_SYMBOL_GPL(pinctrl_generic_get_group_pins);
/** /**
* pinctrl_generic_get_group() - returns a pin group based on the number * pinctrl_generic_get_group() - returns a pin group based on the number
* @pctldev: pin controller device * @pctldev: pin controller device
* @gselector: group number * @selector: group number
*/ */
struct group_desc *pinctrl_generic_get_group(struct pinctrl_dev *pctldev, struct group_desc *pinctrl_generic_get_group(struct pinctrl_dev *pctldev,
unsigned int selector) unsigned int selector)
@@ -1329,7 +1329,7 @@ static void devm_pinctrl_release(struct device *dev, void *res)
} }
/** /**
* struct devm_pinctrl_get() - Resource managed pinctrl_get() * devm_pinctrl_get() - Resource managed pinctrl_get()
* @dev: the device to obtain the handle for * @dev: the device to obtain the handle for
* *
* If there is a need to explicitly destroy the returned struct pinctrl, * If there is a need to explicitly destroy the returned struct pinctrl,
@@ -1451,7 +1451,7 @@ EXPORT_SYMBOL_GPL(pinctrl_register_mappings);
/** /**
* pinctrl_unregister_mappings() - unregister a set of pin controller mappings * pinctrl_unregister_mappings() - unregister a set of pin controller mappings
* @maps: the pincontrol mappings table passed to pinctrl_register_mappings() * @map: the pincontrol mappings table passed to pinctrl_register_mappings()
* when registering the mappings. * when registering the mappings.
*/ */
void pinctrl_unregister_mappings(const struct pinctrl_map *map) void pinctrl_unregister_mappings(const struct pinctrl_map *map)
@@ -2226,9 +2226,9 @@ EXPORT_SYMBOL_GPL(devm_pinctrl_register);
* @dev: parent device for this pin controller * @dev: parent device for this pin controller
* @pctldesc: descriptor for this pin controller * @pctldesc: descriptor for this pin controller
* @driver_data: private pin controller data for this pin controller * @driver_data: private pin controller data for this pin controller
* @pctldev: pin controller device
* *
* Returns an error pointer if pincontrol register failed. Otherwise * Returns zero on success or an error number on failure.
* it returns valid pinctrl handle.
* *
* The pinctrl device will be automatically released when the device is unbound. * The pinctrl device will be automatically released when the device is unbound.
*/ */