doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
diff --git a/include/asm-generic/gpio.h b/include/asm-generic/gpio.h
index fa9b807..adc19e9 100644
--- a/include/asm-generic/gpio.h
+++ b/include/asm-generic/gpio.h
@@ -50,7 +50,7 @@
*
* @param gpio GPIO number
* @param label User label for this GPIO
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_request(unsigned gpio, const char *label);
@@ -59,7 +59,7 @@
* Stop using the GPIO. This function should not alter pin configuration.
*
* @param gpio GPIO number
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_free(unsigned gpio);
@@ -68,7 +68,7 @@
* Make a GPIO an input.
*
* @param gpio GPIO number
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_direction_input(unsigned gpio);
@@ -78,7 +78,7 @@
*
* @param gpio GPIO number
* @param value GPIO value (0 for low or 1 for high)
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_direction_output(unsigned gpio, int value);
@@ -88,7 +88,7 @@
* or an output.
*
* @param gpio GPIO number
- * @return 0 if low, 1 if high, -1 on error
+ * Return: 0 if low, 1 if high, -1 on error
*/
int gpio_get_value(unsigned gpio);
@@ -99,7 +99,7 @@
*
* @param gpio GPIO number
* @param value GPIO value (0 for low or 1 for high)
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_set_value(unsigned gpio, int value);
@@ -146,7 +146,7 @@
*
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
- * @return true if valid, false if not
+ * Return: true if valid, false if not
*/
static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
{
@@ -184,7 +184,7 @@
* @offset: Offset of device GPIO to check
* @namep: If non-NULL, this is set to the name given when the GPIO
* was requested, or -1 if it has not been requested
- * @return -ENODATA if the driver returned an unknown function,
+ * Return: -ENODATA if the driver returned an unknown function,
* -ENODEV if the device is not active, -EINVAL if the offset is invalid.
* GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the
* function from enum gpio_func_t.
@@ -203,7 +203,7 @@
* @offset: Offset of device GPIO to check
* @namep: If non-NULL, this is set to the name given when the GPIO
* was requested, or -1 if it has not been requested
- * @return -ENODATA if the driver returned an unknown function,
+ * Return: -ENODATA if the driver returned an unknown function,
* -ENODEV if the device is not active, -EINVAL if the offset is invalid.
* Otherwise returns the function from enum gpio_func_t.
*/
@@ -434,7 +434,7 @@
*
* @dev: Device to look up
* @offset_count: Returns number of GPIOs within this bank
- * @return bank name of this device
+ * Return: bank name of this device
*/
const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
@@ -447,7 +447,7 @@
*
* @name: Name to look up
* @desc: Returns description, on success
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
@@ -489,7 +489,7 @@
* etc. then returns the resulting integer.
*
* @gpio_list: List of GPIOs to collect
- * @return resulting integer value, or -ve on error
+ * Return: resulting integer value, or -ve on error
*/
int gpio_get_values_as_int(const int *gpio_list);
@@ -501,7 +501,7 @@
*
* @desc_list: List of GPIOs to collect
* @count: Number of GPIOs
- * @return resulting integer value, or -ve on error
+ * Return: resulting integer value, or -ve on error
*/
int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
@@ -525,7 +525,7 @@
*
* @desc_list: List of GPIOs to collect
* @count: Number of GPIOs
- * @return resulting integer value, or -ve on error
+ * Return: resulting integer value, or -ve on error
*/
int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list,
int count);
@@ -535,7 +535,7 @@
*
* @gpio_num_array: array of gpios to claim, terminated by -1
* @fmt: format string for GPIO names, e.g. "board_id%d"
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
@@ -572,7 +572,7 @@
* @desc: Returns GPIO description information. If there is no such
* GPIO, @desc->dev will be NULL.
* @flags: Indicates the GPIO input/output settings (GPIOD_...)
- * @return 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
+ * Return: 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
* something wrong with the list, or other -ve for another error (e.g.
* -EBUSY if a GPIO was already requested)
*/
@@ -598,7 +598,7 @@
* @max_count: Maximum number of GPIOs to return (@desc_list must be at least
* this big)
* @flags: Indicates the GPIO input/output settings (GPIOD_...)
- * @return number of GPIOs requested, or -ve on error
+ * Return: number of GPIOs requested, or -ve on error
*/
int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
struct gpio_desc *desc_list, int max_count,
@@ -612,7 +612,7 @@
*
* @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name())
* @label: Label to attach to the GPIO while claimed
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpio_request(struct gpio_desc *desc, const char *label);
@@ -629,7 +629,7 @@
*
* @dev: Device requesting the GPIO
* @list_name: Name of GPIO list (e.g. "board-id-gpios")
- * @return number of GPIOs (0 for an empty property) or -ENOENT if the list
+ * Return: number of GPIOs (0 for an empty property) or -ENOENT if the list
* does not exist
*/
int gpio_get_list_count(struct udevice *dev, const char *list_name);
@@ -677,7 +677,7 @@
*
* @dev: Device which requested the GPIO
* @desc: GPIO to free
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
@@ -690,7 +690,7 @@
* @dev: Device which requested the GPIOs
* @desc: List of GPIOs to free
* @count: Number of GPIOs in the list
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
@@ -713,7 +713,7 @@
*
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
- * @return GPIO value (0 for inactive, 1 for active) or -ve on error
+ * Return: GPIO value (0 for inactive, 1 for active) or -ve on error
*/
int dm_gpio_get_value(const struct gpio_desc *desc);
@@ -732,7 +732,7 @@
* previously returned by gpio_request_by_name()
* @clr: Flags to clear (GPIOD_...)
* @set: Flags to set (GPIOD_...)
- * @return 0 if OK, -EINVAL if the flags had obvious conflicts,
+ * Return: 0 if OK, -EINVAL if the flags had obvious conflicts,
* -ERECALLCONFLICT if there was a non-obvious hardware conflict when attempting
* to set the flags
*/
@@ -748,7 +748,7 @@
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
* @flags: New flags to use
- * @return 0 if OK, -ve on error, in which case desc->flags is not updated
+ * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
*/
int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
@@ -762,7 +762,7 @@
* @clr: Flags to clear (GPIOD_...), e.g. GPIOD_MASK_DIR if you are
* changing the direction
* @set: Flags to set (GPIOD_...)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr,
ulong set);
@@ -775,7 +775,7 @@
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
* @flags: place to put the used flags
- * @return 0 if OK, -ve on error, in which case desc->flags is not updated
+ * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
*/
int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags);
@@ -787,7 +787,7 @@
*
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
- * @return GPIO number, or -ve if not found
+ * Return: GPIO number, or -ve if not found
*/
int gpio_get_number(const struct gpio_desc *desc);
@@ -799,7 +799,7 @@
*
* @desc: GPIO description to convert
* @gpio: Output ACPI GPIO information
- * @return ACPI pin number or -ve on error
+ * Return: ACPI pin number or -ve on error
*/
int gpio_get_acpi(const struct gpio_desc *desc, struct acpi_gpio *gpio);