From 185f812c419f1b4f0d10d9787d59cf9f11a2a600 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 19 Jan 2022 18:05:50 +0100 Subject: 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 --- include/abuf.h | 4 +- include/acpi/acpi_device.h | 22 ++++----- include/acpi/acpi_dp.h | 26 +++++------ include/acpi/acpi_s3.h | 2 +- include/acpi/acpi_table.h | 6 +-- include/acpi/acpigen.h | 4 +- include/ahci.h | 12 ++--- include/android_ab.h | 2 +- include/asm-generic/gpio.h | 56 +++++++++++------------ include/audio_codec.h | 2 +- include/autoboot.h | 6 +-- include/backlight.h | 4 +- include/binman.h | 10 ++--- include/blk.h | 48 ++++++++++---------- include/boot_fit.h | 2 +- include/bootcount.h | 6 +-- include/bootm.h | 6 +-- include/bootretry.h | 2 +- include/bootstage.h | 16 +++---- include/button.h | 4 +- include/cache.h | 6 +-- include/cbfs.h | 30 ++++++------- include/cli.h | 14 +++--- include/clk.h | 46 +++++++++---------- include/clk/sunxi.h | 2 +- include/command.h | 12 ++--- include/compiler.h | 2 +- include/console.h | 14 +++--- include/cpu_func.h | 2 +- include/cros_ec.h | 82 +++++++++++++++++----------------- include/crypt.h | 2 +- include/display.h | 6 +-- include/display_options.h | 4 +- include/dm/acpi.h | 14 +++--- include/dm/device-internal.h | 22 ++++----- include/dm/pci.h | 4 +- include/dm/test.h | 6 +-- include/dm/uclass-internal.h | 26 +++++------ include/dm/util.h | 2 +- include/dma.h | 24 +++++----- include/dsi_host.h | 4 +- include/dwmmc.h | 4 +- include/edid.h | 10 ++--- include/efi_loader.h | 6 +-- include/env.h | 50 ++++++++++----------- include/env_internal.h | 6 +-- include/extension_board.h | 2 +- include/fdt_region.h | 8 ++-- include/fdt_support.h | 30 ++++++------- include/fdtdec.h | 94 +++++++++++++++++++-------------------- include/fs.h | 16 +++---- include/fsl_ddr_sdram.h | 2 +- include/generic-phy.h | 40 ++++++++--------- include/gzip.h | 10 ++--- include/handoff.h | 2 +- include/hash.h | 8 ++-- include/hda_codec.h | 18 ++++---- include/hw_sha.h | 6 +-- include/hwspinlock.h | 2 +- include/i2c.h | 42 ++++++++--------- include/i2c_eeprom.h | 6 +-- include/i2s.h | 4 +- include/ide.h | 2 +- include/image.h | 56 +++++++++++------------ include/input.h | 16 +++---- include/iotrace.h | 4 +- include/irq.h | 22 ++++----- include/key_matrix.h | 4 +- include/lcd.h | 12 ++--- include/led.h | 8 ++-- include/linux/clk-provider.h | 10 ++--- include/linux/string.h | 6 +-- include/linux/zstd.h | 2 +- include/log.h | 2 +- include/mailbox-uclass.h | 4 +- include/mailbox.h | 10 ++--- include/memalign.h | 2 +- include/membuff.h | 30 ++++++------- include/menu.h | 2 +- include/miiphy.h | 4 +- include/mmc.h | 22 ++++----- include/net.h | 14 +++--- include/net/dsa.h | 8 ++-- include/net/pcap.h | 12 ++--- include/ns16550.h | 4 +- include/of_live.h | 2 +- include/p2sb.h | 10 ++--- include/panel.h | 6 +-- include/part.h | 38 ++++++++-------- include/pch.h | 10 ++--- include/pci.h | 58 ++++++++++++------------ include/pci_ep.h | 28 ++++++------ include/pci_rom.h | 2 +- include/phy-sun4i-usb.h | 4 +- include/physmem.h | 2 +- include/power-domain.h | 14 +++--- include/power/acpi_pmc.h | 10 ++--- include/power/pmic.h | 14 +++--- include/power/regulator.h | 38 ++++++++-------- include/pwm.h | 6 +-- include/pxe_utils.h | 4 +- include/ram.h | 2 +- include/reboot-mode/reboot-mode.h | 2 +- include/relocate.h | 8 ++-- include/remoteproc.h | 34 +++++++------- include/reset.h | 28 ++++++------ include/rtc.h | 34 +++++++------- include/scmi_agent.h | 4 +- include/scsi.h | 4 +- include/sdhci.h | 4 +- include/search.h | 2 +- include/serial.h | 8 ++-- include/smbios.h | 4 +- include/smem.h | 6 +-- include/sort.h | 2 +- include/sound.h | 6 +-- include/spi.h | 14 +++--- include/spi_flash.h | 10 ++--- include/spl.h | 24 +++++----- include/spl_gpio.h | 6 +-- include/spmi/spmi.h | 4 +- include/syscon.h | 10 ++--- include/test/suites.h | 2 +- include/test/ut.h | 20 ++++----- include/time.h | 10 ++--- include/tmu.h | 4 +- include/tpm-common.h | 10 ++--- include/tpm-v1.h | 58 ++++++++++++------------ include/tpm-v2.h | 36 +++++++-------- include/tpm_api.h | 58 ++++++++++++------------ include/tps6586x.h | 6 +-- include/trace.h | 2 +- include/u-boot/crc.h | 10 ++--- include/u-boot/ecdsa.h | 2 +- include/u-boot/fdt-libcrypto.h | 2 +- include/u-boot/hash-checksum.h | 2 +- include/u-boot/lz4.h | 2 +- include/u-boot/rsa.h | 4 +- include/ufs.h | 6 +-- include/usb.h | 26 +++++------ include/usb/xhci.h | 4 +- include/usb_ether.h | 8 ++-- include/video.h | 24 +++++----- include/video_bridge.h | 8 ++-- include/video_console.h | 18 ++++---- include/video_osd.h | 8 ++-- include/virtio.h | 26 +++++------ include/vsprintf.h | 24 +++++----- include/wait_bit.h | 2 +- include/wdt.h | 2 +- 150 files changed, 1016 insertions(+), 1016 deletions(-) (limited to 'include') diff --git a/include/abuf.h b/include/abuf.h index d230f72..9badda6 100644 --- a/include/abuf.h +++ b/include/abuf.h @@ -86,7 +86,7 @@ void abuf_map_sysmem(struct abuf *abuf, ulong addr, size_t size); * if less than the current size, the abuf is contracted and the data at * the end is lost. If @new_size is 0, this sets the alloced member to * false - * @return true if OK, false if out of memory + * Return: true if OK, false if out of memory */ bool abuf_realloc(struct abuf *abuf, size_t new_size); @@ -109,7 +109,7 @@ bool abuf_realloc(struct abuf *abuf, size_t new_size); * * @abuf: abuf to uninit * @sizep: if non-NULL, returns the size of the returned data - * @return data contents, allocated with malloc(), or NULL if the data could not + * Return: data contents, allocated with malloc(), or NULL if the data could not * be allocated, or the data size is 0 */ void *abuf_uninit_move(struct abuf *abuf, size_t *sizep); diff --git a/include/acpi/acpi_device.h b/include/acpi/acpi_device.h index 2c88462..16bcf3c 100644 --- a/include/acpi/acpi_device.h +++ b/include/acpi/acpi_device.h @@ -322,7 +322,7 @@ struct acpi_i2c_priv { * @dev: Device to check * @buf: Buffer to place the path in (should be ACPI_PATH_MAX long) * @maxlen: Size of buffer (typically ACPI_PATH_MAX) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_device_path(const struct udevice *dev, char *buf, int maxlen); @@ -335,7 +335,7 @@ int acpi_device_path(const struct udevice *dev, char *buf, int maxlen); * @dev: Device to check * @buf: Buffer to place the path in (should be ACPI_PATH_MAX long) * @maxlen: Size of buffer (typically ACPI_PATH_MAX) - * @return 0 if OK, -EINVAL if the device has no parent, other -ve on other + * Return: 0 if OK, -EINVAL if the device has no parent, other -ve on other * error */ int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen); @@ -347,7 +347,7 @@ int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen); * inactive or hidden devices. * * @dev: Device to check - * @return device status, as ACPI_DSTATUS_... + * Return: device status, as ACPI_DSTATUS_... */ enum acpi_dev_status acpi_device_status(const struct udevice *dev); @@ -359,7 +359,7 @@ enum acpi_dev_status acpi_device_status(const struct udevice *dev); * * @ctx: ACPI context pointer * @req_irq: Interrupt to output - * @return IRQ pin number if OK, -ve on error + * Return: IRQ pin number if OK, -ve on error */ int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx, const struct irq *req_irq); @@ -368,7 +368,7 @@ int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx, * acpi_device_write_gpio() - Write GpioIo() or GpioInt() descriptor * * @gpio: GPIO information to write - * @return GPIO pin number of first GPIO if OK, -ve on error + * Return: GPIO pin number of first GPIO if OK, -ve on error */ int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio); @@ -380,7 +380,7 @@ int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio); * * @ctx: ACPI context pointer * @desc: GPIO to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_device_write_gpio_desc(struct acpi_ctx *ctx, const struct gpio_desc *desc); @@ -394,7 +394,7 @@ int acpi_device_write_gpio_desc(struct acpi_ctx *ctx, * If an interrupt is found, an ACPI interrupt descriptor is written to the ACPI * output. If not, but if a GPIO is found, a GPIO descriptor is written. * - * @return irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO + * Return: irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO * could be found, or some other error occurred */ int acpi_device_write_interrupt_or_gpio(struct acpi_ctx *ctx, @@ -419,7 +419,7 @@ int acpi_device_write_dsm_i2c_hid(struct acpi_ctx *ctx, * * @ctx: ACPI context pointer * @dev: I2C device to write - * @return I2C address of device if OK, -ve on error + * Return: I2C address of device if OK, -ve on error */ int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev); @@ -431,7 +431,7 @@ int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev); * * @ctx: ACPI context pointer * @dev: SPI device to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev); @@ -466,7 +466,7 @@ int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev); * @stop_off_delay_ms: Delay to be inserted after enabling stop. * (_OFF method delay) * - * @return 0 if OK, -ve if at least one GPIO is not provided + * Return: 0 if OK, -ve if at least one GPIO is not provided */ int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val, const char *dw0_read, const char *dw0_write, @@ -490,7 +490,7 @@ int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val, * * @dev: Device to check * @out_name: Place to put the name (must hold ACPI_NAME_MAX bytes) - * @return 0 if a name was found, -ENOENT if not found, -ENXIO if the device + * Return: 0 if a name was found, -ENOENT if not found, -ENXIO if the device * sequence number could not be determined */ int acpi_device_infer_name(const struct udevice *dev, char *out_name); diff --git a/include/acpi/acpi_dp.h b/include/acpi/acpi_dp.h index 5e539b1..be02cc3 100644 --- a/include/acpi/acpi_dp.h +++ b/include/acpi/acpi_dp.h @@ -124,7 +124,7 @@ struct acpi_dp { * acpi_dp_new_table() - Start a new Device Property table * * @ref: ACPI reference (e.g. "_DSD") - * @return pointer to table, or NULL if out of memory + * Return: pointer to table, or NULL if out of memory */ struct acpi_dp *acpi_dp_new_table(const char *ref); @@ -136,7 +136,7 @@ struct acpi_dp *acpi_dp_new_table(const char *ref); * @dp: Table to add this property to * @name: Name of property, or NULL for none * @value: Integer value - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name, u64 value); @@ -149,7 +149,7 @@ struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name, * @dp: Table to add this property to * @name: Name of property, or NULL for none * @string: String value - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name, const char *string); @@ -162,7 +162,7 @@ struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name, * @dp: Table to add this property to * @name: Name of property, or NULL for none * @reference: Reference value - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name, const char *reference); @@ -175,7 +175,7 @@ struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name, * * @dp: Table to add this property to * @name: Name of property, or NULL for none - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array); @@ -187,7 +187,7 @@ struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array); * * @dp: Table to add this property to * @name: Name of property, or NULL for none - * @return pointer to new array node, or NULL if out of memory + * Return: pointer to new array node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name, u64 *array, int len); @@ -200,7 +200,7 @@ struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name, * @dp: Table to add this child to * @name: Name of child, or NULL for none * @child: Child node to add - * @return pointer to new child node, or NULL if out of memory + * Return: pointer to new child node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name, struct acpi_dp *child); @@ -217,7 +217,7 @@ struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name, * @index: Index of the GPIO resource in _CRS starting from zero * @pin: Pin in the GPIO resource, typically zero * @polarity: GPIO polarity. Note that ACPI_IRQ_ACTIVE_BOTH is not supported - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name, const char *ref, int index, int pin, @@ -230,7 +230,7 @@ struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name, * * @ctx: ACPI context * @table: Table to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table); @@ -242,7 +242,7 @@ int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table); * @node: Node to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop); @@ -254,7 +254,7 @@ int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop); * @node: Node to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop); @@ -266,7 +266,7 @@ int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop); * @dev: Device to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp, const char *prop); @@ -279,7 +279,7 @@ int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp, * @dev: Device to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_dev_copy_str(const struct udevice *dev, struct acpi_dp *dp, const char *prop); diff --git a/include/acpi/acpi_s3.h b/include/acpi/acpi_s3.h index 847139b..d3f271f 100644 --- a/include/acpi/acpi_s3.h +++ b/include/acpi/acpi_s3.h @@ -93,7 +93,7 @@ static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt) * This returns chipset previous sleep state from ACPI registers. * Platform codes must supply this routine in order to support ACPI S3. * - * @return ACPI_S0/S1/S2/S3/S4/S5. + * Return: ACPI_S0/S1/S2/S3/S4/S5. */ enum acpi_sleep_state chipset_prev_sleep_state(void); diff --git a/include/acpi/acpi_table.h b/include/acpi/acpi_table.h index a28eb71..dbfea3b 100644 --- a/include/acpi/acpi_table.h +++ b/include/acpi/acpi_table.h @@ -595,7 +595,7 @@ enum acpi_tables { * This keeps the version-number information in one place * * @table: ACPI table to check - * @return version number that U-Boot generates + * Return: version number that U-Boot generates */ int acpi_get_table_revision(enum acpi_tables table); @@ -604,7 +604,7 @@ int acpi_get_table_revision(enum acpi_tables table); * * @dmar: Place to put the table * @flags: DMAR flags to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags); @@ -674,7 +674,7 @@ void acpi_inc_align(struct acpi_ctx *ctx, uint amount); * * @ctx: ACPI context * @table: Table to add - * @return 0 if OK, -E2BIG if too many tables + * Return: 0 if OK, -E2BIG if too many tables */ int acpi_add_table(struct acpi_ctx *ctx, void *table); diff --git a/include/acpi/acpigen.h b/include/acpi/acpigen.h index 976f4db..2c269ed 100644 --- a/include/acpi/acpigen.h +++ b/include/acpi/acpigen.h @@ -140,7 +140,7 @@ struct acpi_tstate { * acpigen_get_current() - Get the current ACPI code output pointer * * @ctx: ACPI context pointer - * @return output pointer + * Return: output pointer */ u8 *acpigen_get_current(struct acpi_ctx *ctx); @@ -428,7 +428,7 @@ void acpigen_write_scope(struct acpi_ctx *ctx, const char *scope); * * @ctx: ACPI context pointer * @uuid: UUID to write in the form aabbccdd-eeff-gghh-iijj-kkllmmnnoopp - * @return 0 if OK, -EINVAL if the format is incorrect + * Return: 0 if OK, -EINVAL if the format is incorrect */ int acpigen_write_uuid(struct acpi_ctx *ctx, const char *uuid); diff --git a/include/ahci.h b/include/ahci.h index d545304..d7f951c 100644 --- a/include/ahci.h +++ b/include/ahci.h @@ -202,7 +202,7 @@ struct ahci_ops { * sata_reset() - reset the controller * * @dev: Controller to reset - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sata_reset(struct udevice *dev); @@ -211,7 +211,7 @@ int sata_reset(struct udevice *dev); * * @dev: Controller to reset * @port: Port number to check (0 for first) - * @return 0 if detected, -ENXIO if nothin on port, other -ve on error + * Return: 0 if detected, -ENXIO if nothin on port, other -ve on error */ int sata_dm_port_status(struct udevice *dev, int port); @@ -219,7 +219,7 @@ int sata_dm_port_status(struct udevice *dev, int port); * sata_scan() - scan SATA ports * * @dev: Controller to scan - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sata_scan(struct udevice *dev); @@ -254,7 +254,7 @@ int ahci_init_dm(struct udevice *dev, void __iomem *base); * * @ahci_dev: AHCI parent device * @devp: Returns new SCSI bus device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp); @@ -266,7 +266,7 @@ int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp); * * @ahci_dev: AHCI parent device * @base: Base address of AHCI port - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ahci_probe_scsi(struct udevice *ahci_dev, ulong base); @@ -277,7 +277,7 @@ int ahci_probe_scsi(struct udevice *ahci_dev, ulong base); * devices it finds. * * @ahci_dev: AHCI parent device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ahci_probe_scsi_pci(struct udevice *ahci_dev); diff --git a/include/android_ab.h b/include/android_ab.h index 0941eb6..3eb6112 100644 --- a/include/android_ab.h +++ b/include/android_ab.h @@ -28,7 +28,7 @@ struct disk_partition; * * @param[in] dev_desc Place to store the device description pointer * @param[in] part_info Place to store the partition information - * @return The slot number (>= 0) on success, or a negative on error + * Return: The slot number (>= 0) on success, or a negative on error */ int ab_select_slot(struct blk_desc *dev_desc, struct disk_partition *part_info); 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 @@ struct ofnode_phandle_args; * * @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 @@ int gpio_request(unsigned gpio, const char *label); * 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 @@ int gpio_free(unsigned gpio); * 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 @@ int gpio_direction_input(unsigned gpio); * * @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 @@ int gpio_direction_output(unsigned gpio, int value); * 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 @@ int gpio_get_value(unsigned gpio); * * @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 @@ struct gpio_desc { * * @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 @@ int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize); * @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 @@ int gpio_get_function(struct udevice *dev, int offset, const char **namep); * @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 @@ struct gpio_dev_priv { * * @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 @@ const char *gpio_get_bank_info(struct udevice *dev, int *offset_count); * * @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 @@ int gpio_lookup_name(const char *name, struct udevice **devp, * 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 @@ int gpio_get_values_as_int(const int *gpio_list); * * @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 @@ int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count); * * @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 @@ int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list, * * @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 @@ int gpio_claim_vector(const int *gpio_num_array, const char *fmt); * @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 @@ int gpio_request_by_name(struct udevice *dev, const char *list_name, * @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 @@ int gpio_request_list_by_name(struct udevice *dev, const char *list_name, * * @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 @@ int gpio_request_by_phandle(struct udevice *dev, * * @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 @@ int gpio_dev_request_index(struct udevice *dev, const char *nodename, * * @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 @@ int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc); * @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 @@ int gpio_free_list_nodev(struct gpio_desc *desc, int count); * * @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 @@ int dm_gpio_set_value(const struct gpio_desc *desc, int value); * 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 @@ int dm_gpio_clrset_flags(struct gpio_desc *desc, ulong clr, ulong set); * @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 @@ int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags); * @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 @@ int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr, * @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 @@ int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags); * * @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 @@ int gpio_get_number(const struct gpio_desc *desc); * * @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); diff --git a/include/audio_codec.h b/include/audio_codec.h index 2ea4ff0..a81a315 100644 --- a/include/audio_codec.h +++ b/include/audio_codec.h @@ -42,7 +42,7 @@ struct audio_codec_ops { * @mclk_freq: Codec clock frequency in Hz * @bits_per_sample: Must be 16 or 24 * @channels: Number of channels to use (1=mono, 2=stereo) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int audio_codec_set_params(struct udevice *dev, int interface, int rate, int mclk_freq, int bits_per_sample, uint channels); diff --git a/include/autoboot.h b/include/autoboot.h index d6915dd..eb20499 100644 --- a/include/autoboot.h +++ b/include/autoboot.h @@ -21,7 +21,7 @@ * This is only implemented for sandbox since other platforms don't have a way * of controlling the feature at runtime. * - * @return true if enabled, false if not + * Return: true if enabled, false if not */ bool autoboot_keyed(void); @@ -29,7 +29,7 @@ bool autoboot_keyed(void); * autoboot_set_keyed() - set whether keyed autoboot should be used * * @autoboot_keyed: true to enable the feature, false to disable - * @return old value of the flag + * Return: old value of the flag */ bool autoboot_set_keyed(bool autoboot_keyed); #else @@ -55,7 +55,7 @@ static inline bool autoboot_set_keyed(bool autoboot_keyed) * bootcmd, failbootcmd or altbootcmd depending on the current state. * Return this command so it can be executed. * - * @return command to executed + * Return: command to executed */ const char *bootdelay_process(void); diff --git a/include/backlight.h b/include/backlight.h index b44da50..c841882 100644 --- a/include/backlight.h +++ b/include/backlight.h @@ -41,7 +41,7 @@ struct backlight_ops { * backlight_enable() - Enable a backlight * * @dev: Backlight device to enable - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int backlight_enable(struct udevice *dev); @@ -50,7 +50,7 @@ int backlight_enable(struct udevice *dev); * * @dev: Backlight device to update * @percent: Brightness value (0 to 100, or BACKLIGHT_... value) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int backlight_set_brightness(struct udevice *dev, int percent); diff --git a/include/binman.h b/include/binman.h index 5958dfb..62a522e 100644 --- a/include/binman.h +++ b/include/binman.h @@ -29,7 +29,7 @@ struct binman_entry { * @name: Name of entry * @bufp: Returns a pointer to the entry * @sizep: Returns the size of the entry - * @return 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the + * Return: 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the * entry cannot be found, other error code other error */ int binman_entry_map(ofnode parent, const char *name, void **bufp, int *sizep); @@ -57,7 +57,7 @@ int binman_get_rom_offset(void); * * @name: Path to entry to examine (e.g. "/read-only/u-boot") * @entry: Returns information about the entry - * @return 0 if OK, -ENOENT if the path is not found, other -ve value if the + * Return: 0 if OK, -ENOENT if the path is not found, other -ve value if the * binman information is invalid (missing image-pos or size) */ int binman_entry_find(const char *name, struct binman_entry *entry); @@ -66,7 +66,7 @@ int binman_entry_find(const char *name, struct binman_entry *entry); * binman_section_find_node() - Find a binman node * * @name: Name of node to look for - * @return Node that was found, ofnode_null() if not found + * Return: Node that was found, ofnode_null() if not found */ ofnode binman_section_find_node(const char *name); @@ -78,7 +78,7 @@ ofnode binman_section_find_node(const char *name); * * @name: Name of subnode, typically a section. This must be in the top-level * binman node - * @return 0 if OK, -EINVAL if there is no /binman node, -ECHILD if multiple + * Return: 0 if OK, -EINVAL if there is no /binman node, -ECHILD if multiple * images are being used but the first image is not available, -ENOENT if * the requested subnode cannot be found */ @@ -89,7 +89,7 @@ int binman_select_subnode(const char *name); * * This locates the binary symbol information in the device tree ready for use * - * @return 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node + * Return: 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node */ int binman_init(void); diff --git a/include/blk.h b/include/blk.h index 133204a..d06098b 100644 --- a/include/blk.h +++ b/include/blk.h @@ -136,7 +136,7 @@ int blkcache_init(void); * @param blksz - size in bytes of each block * @param buf - buffer to contain cached data * - * @return - 1 if block returned from cache, 0 otherwise. + * Return: - 1 if block returned from cache, 0 otherwise. */ int blkcache_read(int iftype, int dev, lbaint_t start, lbaint_t blkcnt, @@ -297,7 +297,7 @@ unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start, * @if_type: Interface type (enum if_type_t) * @devnum: Device number (specific to each interface type) * @devp: the device, if found - * @return 0 if found, -ENODEV if no device found, or other -ve error value + * Return: 0 if found, -ENODEV if no device found, or other -ve error value */ int blk_find_device(int if_type, int devnum, struct udevice **devp); @@ -307,7 +307,7 @@ int blk_find_device(int if_type, int devnum, struct udevice **devp); * @if_type: Interface type (enum if_type_t) * @devnum: Device number (specific to each interface type) * @devp: the device, if found - * @return 0 if found, -ENODEV if no device found, or other -ve error value + * Return: 0 if found, -ENODEV if no device found, or other -ve error value */ int blk_get_device(int if_type, int devnum, struct udevice **devp); @@ -318,7 +318,7 @@ int blk_get_device(int if_type, int devnum, struct udevice **devp); * * @devnum: Device number (specific to each interface type) * @devp: the device, if found - * @return 0 if found, -ENODEV if no device, or other -ve error value + * Return: 0 if found, -ENODEV if no device, or other -ve error value */ int blk_first_device(int if_type, struct udevice **devp); @@ -332,7 +332,7 @@ int blk_first_device(int if_type, struct udevice **devp); * * @devp: On entry, the previous device returned. On exit, the next * device, if found - * @return 0 if found, -ENODEV if no device, or other -ve error value + * Return: 0 if found, -ENODEV if no device, or other -ve error value */ int blk_next_device(struct udevice **devp); @@ -388,7 +388,7 @@ int blk_probe_or_unbind(struct udevice *dev); * The devices are removed and then unbound. * * @if_type: Interface type to unbind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_unbind_all(int if_type); @@ -399,7 +399,7 @@ int blk_unbind_all(int if_type); * next number is safe to use for a newly allocated device. * * @if_type: Interface type to scan - * @return maximum device number found, or -ENODEV if none, or other -ve on + * Return: maximum device number found, or -ENODEV if none, or other -ve on * error */ int blk_find_max_devnum(enum if_type if_type); @@ -411,7 +411,7 @@ int blk_find_max_devnum(enum if_type if_type); * an interface type @if_type. * * @if_type: Interface type to scan - * @return next device number safe to use, or -ve on error + * Return: next device number safe to use, or -ve on error */ int blk_next_free_devnum(enum if_type if_type); @@ -422,7 +422,7 @@ int blk_next_free_devnum(enum if_type if_type); * * @dev: Device to update * @hwpart: Partition number to select - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_select_hwpart(struct udevice *dev, int hwpart); @@ -559,7 +559,7 @@ struct blk_driver *blk_driver_lookup_type(int if_type); * * @if_type: Block device type * @devnum: Device number - * @return point to block device descriptor, or NULL if not found + * Return: point to block device descriptor, or NULL if not found */ struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum); @@ -571,7 +571,7 @@ struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum); * * @if_typename: Block device type name * @devnum: Device number - * @return point to block device descriptor, or NULL if not found + * Return: point to block device descriptor, or NULL if not found */ struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, int devnum); @@ -585,7 +585,7 @@ struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, * * @desc: Block device descriptor for the device to select * @hwpart: Partition number to select - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_dselect_hwpart(struct blk_desc *desc, int hwpart); @@ -596,7 +596,7 @@ int blk_dselect_hwpart(struct blk_desc *desc, int hwpart); * then displays a list of partitions. * * @if_type: Block device type - * @return 0 if OK, -ENODEV if there is none of that type + * Return: 0 if OK, -ENODEV if there is none of that type */ int blk_list_part(enum if_type if_type); @@ -617,7 +617,7 @@ void blk_list_devices(enum if_type if_type); * * @if_type: Block device type * @devnum: Device number - * @return 0 if OK, -ENODEV for invalid device number + * Return: 0 if OK, -ENODEV for invalid device number */ int blk_show_device(enum if_type if_type, int devnum); @@ -629,7 +629,7 @@ int blk_show_device(enum if_type if_type, int devnum); * * @if_type: Block device type * @devnum: Device number - * @return 0 if OK, -ENODEV for invalid device number, -ENOENT if the block + * Return: 0 if OK, -ENODEV for invalid device number, -ENOENT if the block * device is not connected */ int blk_print_device_num(enum if_type if_type, int devnum); @@ -639,7 +639,7 @@ int blk_print_device_num(enum if_type if_type, int devnum); * * @if_type: Block device type * @devnum: Device number - * @return 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if + * Return: 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if * the interface type is not supported, other -ve on other error */ int blk_print_part_devnum(enum if_type if_type, int devnum); @@ -651,7 +651,7 @@ int blk_print_part_devnum(enum if_type if_type, int devnum); * @devnum: Device number * @blkcnt: Number of blocks to read * @buffer: Address to write data to - * @return number of blocks read, or -ve error number on error + * Return: number of blocks read, or -ve error number on error */ ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start, lbaint_t blkcnt, void *buffer); @@ -663,7 +663,7 @@ ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start, * @devnum: Device number * @blkcnt: Number of blocks to write * @buffer: Address to read data from - * @return number of blocks written, or -ve error number on error + * Return: number of blocks written, or -ve error number on error */ ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start, lbaint_t blkcnt, const void *buffer); @@ -677,7 +677,7 @@ ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start, * @if_type: Block device type * @devnum: Device number * @hwpart: Partition number to select - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart); @@ -685,7 +685,7 @@ int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart); * blk_get_if_type_name() - Get the name of an interface type * * @if_type: Interface type to check - * @return name of interface, or NULL if none + * Return: name of interface, or NULL if none */ const char *blk_get_if_type_name(enum if_type if_type); @@ -696,7 +696,7 @@ const char *blk_get_if_type_name(enum if_type if_type); * @argv: Command arguments * @if_type: Interface type * @cur_devnump: Current device number for this interface type - * @return 0 if OK, CMD_RET_ERROR on error + * Return: 0 if OK, CMD_RET_ERROR on error */ int blk_common_cmd(int argc, char *const argv[], enum if_type if_type, int *cur_devnump); @@ -714,7 +714,7 @@ enum blk_flag_t { * * @flags: Indicates type of device to return * @devp: Returns pointer to the first device in that uclass, or NULL if none - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp); @@ -727,7 +727,7 @@ int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp); * @devp: On entry, pointer to device to lookup. On exit, returns pointer * to the next device in the uclass if no error occurred, or -ENODEV if * there is no next device. - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp); @@ -751,7 +751,7 @@ int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp); * blk_count_devices() - count the number of devices of a particular type * * @flags: Indicates type of device to find - * @return number of devices matching those flags + * Return: number of devices matching those flags */ int blk_count_devices(enum blk_flag_t flag); diff --git a/include/boot_fit.h b/include/boot_fit.h index f75fed6..092cfb0 100644 --- a/include/boot_fit.h +++ b/include/boot_fit.h @@ -8,6 +8,6 @@ * locate_dtb_in_fit - Find a DTB matching the board in a FIT image * @fit: pointer to the FIT image * - * @return a pointer to a matching DTB blob if found, NULL otherwise + * Return: a pointer to a matching DTB blob if found, NULL otherwise */ void *locate_dtb_in_fit(const void *fit); diff --git a/include/bootcount.h b/include/bootcount.h index 796b237..fccee7e 100644 --- a/include/bootcount.h +++ b/include/bootcount.h @@ -45,7 +45,7 @@ struct bootcount_ops { * * @dev: Device to read from * @bootcount: Place to put the current bootcount - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_bootcount_get(struct udevice *dev, u32 *bootcount); @@ -54,7 +54,7 @@ int dm_bootcount_get(struct udevice *dev, u32 *bootcount); * * @dev: Device to read from * @bootcount: Value to be written to the backing storage - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_bootcount_set(struct udevice *dev, u32 bootcount); @@ -66,7 +66,7 @@ void bootcount_store(ulong); /** * bootcount_load() - load the current bootcount * - * @return bootcount, read from the appropriate location + * Return: bootcount, read from the appropriate location */ ulong bootcount_load(void); diff --git a/include/bootm.h b/include/bootm.h index 48fc668..7ed5650 100644 --- a/include/bootm.h +++ b/include/bootm.h @@ -29,7 +29,7 @@ struct cmd_tbl; * argc is adjusted accordingly. This avoids confusion as to how * many arguments are available for the OS. * @images: Pointers to os/initrd/fdt - * @return 1 on error. On success the OS boots so this function does + * Return: 1 on error. On success the OS boots so this function does * not return. */ typedef int boot_os_fn(int flag, int argc, char *const argv[], @@ -106,7 +106,7 @@ void board_preboot_os(void); * @buf: buffer holding commandline string to adjust * @maxlen: Maximum length of buffer at @buf (including \0) * @flags: Flags to control what happens (see bootm_cmdline_t) - * @return 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too + * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too * long */ int bootm_process_cmdline(char *buf, int maxlen, int flags); @@ -120,7 +120,7 @@ int bootm_process_cmdline(char *buf, int maxlen, int flags); * - performing substitutions in the command line ('bootargs_subst' envvar) * * @flags: Flags to control what happens (see bootm_cmdline_t) - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int bootm_process_cmdline_env(int flags); diff --git a/include/bootretry.h b/include/bootretry.h index 0cedd30..1e8aa83 100644 --- a/include/bootretry.h +++ b/include/bootretry.h @@ -14,7 +14,7 @@ * Check for a keypress repeatedly, resetting the watchdog each time. If a * keypress is not received within the command timeout, return an error. * - * @return 0 if a key is received in time, -ETIMEDOUT if not + * Return: 0 if a key is received in time, -ETIMEDOUT if not */ int bootretry_tstc_timeout(void); diff --git a/include/bootstage.h b/include/bootstage.h index 8d1989a..99a334a 100644 --- a/include/bootstage.h +++ b/include/bootstage.h @@ -248,7 +248,7 @@ void show_boot_progress(int val); * Call this after relocation has happened and after malloc has been initted. * We need to copy any pointers in bootstage records that were added pre- * relocation, since memory can be overwritten later. - * @return Always returns 0, to indicate success + * Return: Always returns 0, to indicate success */ int bootstage_relocate(void); @@ -280,7 +280,7 @@ ulong bootstage_mark_name(enum bootstage_id id, const char *name); * @param file Filename to record (NULL if none) * @param func Function name to record * @param linenum Line number to record - * @return recorded time stamp + * Return: recorded time stamp */ ulong bootstage_mark_code(const char *file, const char *func, int linenum); @@ -294,7 +294,7 @@ ulong bootstage_mark_code(const char *file, const char *func, * * @param id Bootstage id to record this timestamp against * @param name Textual name to display for this id in the report (maybe NULL) - * @return start timestamp in microseconds + * Return: start timestamp in microseconds */ uint32_t bootstage_start(enum bootstage_id id, const char *name); @@ -306,7 +306,7 @@ uint32_t bootstage_start(enum bootstage_id id, const char *name); * as many times as you like. * * @param id Bootstage id to record this timestamp against - * @return time spent in this iteration of the activity (i.e. the time now + * Return: time spent in this iteration of the activity (i.e. the time now * less the start time recorded in the last bootstage_start() call * with this id. */ @@ -318,7 +318,7 @@ void bootstage_report(void); /** * Add bootstage information to the device tree * - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int bootstage_fdt_add_report(void); @@ -327,7 +327,7 @@ int bootstage_fdt_add_report(void); * * @param base Base address of memory buffer * @param size Size of memory buffer - * @return 0 if stashed ok, -1 if out of space + * Return: 0 if stashed ok, -1 if out of space */ int bootstage_stash(void *base, int size); @@ -339,7 +339,7 @@ int bootstage_stash(void *base, int size); * * @param base Base address of memory buffer * @param size Size of memory buffer (-1 if unknown) - * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if + * Return: 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if * there is not space for read the stashed data, or other error if * something else went wrong */ @@ -348,7 +348,7 @@ int bootstage_unstash(const void *base, int size); /** * bootstage_get_size() - Get the size of the bootstage data * - * @return size of boostage data in bytes + * Return: size of boostage data in bytes */ int bootstage_get_size(void); diff --git a/include/button.h b/include/button.h index ee14fad..96e6b19 100644 --- a/include/button.h +++ b/include/button.h @@ -46,7 +46,7 @@ struct button_ops { * * @label: button label to look up * @devp: Returns the associated device, if found - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int button_get_by_label(const char *label, struct udevice **devp); @@ -54,7 +54,7 @@ int button_get_by_label(const char *label, struct udevice **devp); * button_get_state() - get the state of a button * * @dev: button device to change - * @return button state button_state_t, or -ve on error + * Return: button state button_state_t, or -ve on error */ enum button_state_t button_get_state(struct udevice *dev); diff --git a/include/cache.h b/include/cache.h index ecb7956..b12fec2 100644 --- a/include/cache.h +++ b/include/cache.h @@ -49,7 +49,7 @@ struct cache_ops { * * @dev: Device to check (UCLASS_CACHE) * @info: Returns cache info - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cache_get_info(struct udevice *dev, struct cache_info *info); @@ -57,7 +57,7 @@ int cache_get_info(struct udevice *dev, struct cache_info *info); * cache_enable() - Enable cache * * @dev: Device to check (UCLASS_CACHE) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cache_enable(struct udevice *dev); @@ -65,7 +65,7 @@ int cache_enable(struct udevice *dev); * cache_disable() - Flush and disable cache * * @dev: Device to check (UCLASS_CACHE) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cache_disable(struct udevice *dev); #endif diff --git a/include/cbfs.h b/include/cbfs.h index ae94f1d..7449873 100644 --- a/include/cbfs.h +++ b/include/cbfs.h @@ -136,14 +136,14 @@ struct cbfs_cachenode { * file_cbfs_error() - Return a string describing the most recent error * condition. * - * @return A pointer to the constant string. + * Return: A pointer to the constant string. */ const char *file_cbfs_error(void); /** * cbfs_get_result() - Get the result of the last CBFS operation * - *@return last result + *Return: last result */ enum cbfs_result cbfs_get_result(void); @@ -151,21 +151,21 @@ enum cbfs_result cbfs_get_result(void); * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM. * * @end_of_rom: Points to the end of the ROM the CBFS should be read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int file_cbfs_init(ulong end_of_rom); /** * file_cbfs_get_header() - Get the header structure for the current CBFS. * - * @return A pointer to the constant structure, or NULL if there is none. + * Return: A pointer to the constant structure, or NULL if there is none. */ const struct cbfs_header *file_cbfs_get_header(void); /** * cbfs_get_first() - Get the first file in a CBFS * - * @return pointer to first file, or NULL if it is empty + * Return: pointer to first file, or NULL if it is empty */ const struct cbfs_cachenode *cbfs_get_first(const struct cbfs_priv *priv); @@ -180,7 +180,7 @@ void cbfs_get_next(const struct cbfs_cachenode **filep); /** * file_cbfs_get_first() - Get a handle for the first file in CBFS. * - * @return A handle for the first file in CBFS, NULL on error. + * Return: A handle for the first file in CBFS, NULL on error. */ const struct cbfs_cachenode *file_cbfs_get_first(void); @@ -196,7 +196,7 @@ void file_cbfs_get_next(const struct cbfs_cachenode **file); * * @name: The name to search for. * - * @return A handle to the file, or NULL on error. + * Return: A handle to the file, or NULL on error. */ const struct cbfs_cachenode *file_cbfs_find(const char *name); @@ -205,7 +205,7 @@ const struct cbfs_cachenode *file_cbfs_find(const char *name); * * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up) * @name: Filename to look for - * @return pointer to CBFS node if found, else NULL + * Return: pointer to CBFS node if found, else NULL */ const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs, const char *name); @@ -217,7 +217,7 @@ const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs, * @size: Size of CBFS if known, else CBFS_SIZE_UNKNOWN * @require_header: true to read a header at the start, false to not require one * @cbfsp: Returns a pointer to CBFS on success - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cbfs_init_mem(ulong base, ulong size, bool require_hdr, struct cbfs_priv **privp); @@ -235,7 +235,7 @@ int cbfs_init_mem(ulong base, ulong size, bool require_hdr, * @end_of_rom: Points to the end of the ROM the CBFS should be read from * @name: The name to search for * @node: Returns the contents of the node if found (i.e. copied into *node) - * @return 0 on success, -ENOENT if not found, -EFAULT on bad header + * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header */ int file_cbfs_find_uncached(ulong end_of_rom, const char *name, struct cbfs_cachenode *node); @@ -249,7 +249,7 @@ int file_cbfs_find_uncached(ulong end_of_rom, const char *name, * @base: Points to the base of the CBFS * @name: The name to search for * @node: Returns the contents of the node if found (i.e. copied into *node) - * @return 0 on success, -ENOENT if not found, -EFAULT on bad header + * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header */ int file_cbfs_find_uncached_base(ulong base, const char *name, struct cbfs_cachenode *node); @@ -259,7 +259,7 @@ int file_cbfs_find_uncached_base(ulong base, const char *name, * * @file: The handle to the file. * - * @return The name of the file, NULL on error. + * Return: The name of the file, NULL on error. */ const char *file_cbfs_name(const struct cbfs_cachenode *file); @@ -268,7 +268,7 @@ const char *file_cbfs_name(const struct cbfs_cachenode *file); * * @file: The handle to the file. * - * @return The size of the file, zero on error. + * Return: The size of the file, zero on error. */ u32 file_cbfs_size(const struct cbfs_cachenode *file); @@ -277,7 +277,7 @@ u32 file_cbfs_size(const struct cbfs_cachenode *file); * * @file: The handle to the file. * - * @return The type of the file, zero on error. + * Return: The type of the file, zero on error. */ u32 file_cbfs_type(const struct cbfs_cachenode *file); @@ -288,7 +288,7 @@ u32 file_cbfs_type(const struct cbfs_cachenode *file); * @buffer: Where to read it into memory. * @maxsize: Maximum number of bytes to read * - * @return If positive or zero, the number of characters read. If negative, an + * Return: If positive or zero, the number of characters read. If negative, an * error occurred. */ long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer, diff --git a/include/cli.h b/include/cli.h index 3449fa6..ba5b8eb 100644 --- a/include/cli.h +++ b/include/cli.h @@ -20,7 +20,7 @@ void cli_simple_loop(void); * * @cmd: String containing the command to execute * @flag Flag value - see CMD_FLAG_... - * @return 1 - command executed, repeatable + * Return: 1 - command executed, repeatable * 0 - command executed but not repeatable, interrupted commands are * always considered not repeatable * -1 - not executed (unrecognized, bootd recursion or too many args) @@ -35,7 +35,7 @@ int cli_simple_run_command(const char *cmd, int flag); * @param input Input string possible containing $() / ${} vars * @param output Output string with $() / ${} vars expanded * @param max_size Maximum size of @output (including terminator) - * @return 0 if OK, -ENOSPC if we ran out of space in @output + * Return: 0 if OK, -ENOSPC if we ran out of space in @output */ int cli_simple_process_macros(const char *input, char *output, int max_size); @@ -50,7 +50,7 @@ int cli_simple_process_macros(const char *input, char *output, int max_size); * * @param cmd String containing list of commands * @param flag Execution flags (CMD_FLAG_...) - * @return 0 on success, or != 0 on error. + * Return: 0 on success, or != 0 on error. */ int cli_simple_run_command_list(char *cmd, int flag); @@ -60,7 +60,7 @@ int cli_simple_run_command_list(char *cmd, int flag); * This is a convenience function which calls cli_readline_into_buffer(). * * @prompt: Prompt to display - * @return command line length excluding terminator, or -ve on error + * Return: command line length excluding terminator, or -ve on error */ int cli_readline(const char *const prompt); @@ -82,7 +82,7 @@ int cli_readline(const char *const prompt); * @prompt: Prompt to display * @buffer: Place to put the line that is entered * @timeout: Timeout in milliseconds, 0 if none - * @return command line length excluding terminator, or -ve on error: of the + * Return: command line length excluding terminator, or -ve on error: of the * timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout * parameter), then -2 is returned. If a break is detected (Ctrl-C) then * -1 is returned. @@ -105,7 +105,7 @@ int cli_readline_into_buffer(const char *const prompt, char *buffer, * * @line: Command line to parse * @args: Array to hold arguments - * @return number of arguments + * Return: number of arguments */ int cli_simple_parse_line(char *line, char *argv[]); @@ -121,7 +121,7 @@ int cli_simple_parse_line(char *line, char *argv[]); * @cmdp: On entry, the command that will be executed if the FDT does * not have a command. Returns the command to execute after * checking the FDT. - * @return true to execute securely, else false + * Return: true to execute securely, else false */ bool cli_process_fdt(const char **cmdp); diff --git a/include/clk.h b/include/clk.h index df5255e..040d2d6 100644 --- a/include/clk.h +++ b/include/clk.h @@ -112,7 +112,7 @@ struct phandle_1_arg; * @dev: Device containing the phandle * @cells: Phandle info * @clock: A pointer to a clock struct to initialise - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells, struct clk *clk); @@ -130,7 +130,7 @@ int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells, * @index: The index of the clock to request, within the client's list of * clocks. * @clock A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); @@ -144,7 +144,7 @@ int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); * @index: The index of the clock to request, within the client's list of * clocks. * @clock A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk); @@ -159,7 +159,7 @@ int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk); * * @dev: The client device. * @bulk A pointer to a clock bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); @@ -176,7 +176,7 @@ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); * @name: The name of the clock to request, within the client's list of * clocks. * @clock: A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); @@ -189,7 +189,7 @@ int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); * @name: The name of the clock to request, within the client's list of * clocks. * @clock: A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk); @@ -249,7 +249,7 @@ struct clk *devm_clk_get_optional(struct udevice *dev, const char *id); * @clk: A clock struct array that was previously successfully * requested by clk_request/get_by_*(). * @count Number of clock contained in the array - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_release_all(struct clk *clk, int count); @@ -351,7 +351,7 @@ static inline int clk_set_defaults(struct udevice *dev, int stage) * * @clk: A clock bulk struct that was previously successfully * requested by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ static inline int clk_release_bulk(struct clk_bulk *bulk) { @@ -371,7 +371,7 @@ static inline int clk_release_bulk(struct clk_bulk *bulk) * @clock: A pointer to a clock struct to initialize. The caller must * have already initialized any field in this struct which the * clock provider uses to identify the clock. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_request(struct udevice *dev, struct clk *clk); @@ -380,7 +380,7 @@ int clk_request(struct udevice *dev, struct clk *clk); * * @clock: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_free(struct clk *clk); @@ -389,7 +389,7 @@ int clk_free(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz on success, 0 for invalid clock, or -ve error code + * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code * for other errors. */ ulong clk_get_rate(struct clk *clk); @@ -399,7 +399,7 @@ ulong clk_get_rate(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return pointer to parent's struct clk, or error code passed as pointer + * Return: pointer to parent's struct clk, or error code passed as pointer */ struct clk *clk_get_parent(struct clk *clk); @@ -408,7 +408,7 @@ struct clk *clk_get_parent(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz, or -ve error code. + * Return: clock rate in Hz, or -ve error code. */ long long clk_get_parent_rate(struct clk *clk); @@ -431,7 +431,7 @@ long long clk_get_parent_rate(struct clk *clk); * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @rate: desired clock rate in Hz. - * @return rounded rate in Hz, or -ve error code. + * Return: rounded rate in Hz, or -ve error code. */ ulong clk_round_rate(struct clk *clk, ulong rate); @@ -441,7 +441,7 @@ ulong clk_round_rate(struct clk *clk, ulong rate); * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @rate: New clock rate in Hz. - * @return new rate, or -ve error code. + * Return: new rate, or -ve error code. */ ulong clk_set_rate(struct clk *clk, ulong rate); @@ -452,7 +452,7 @@ ulong clk_set_rate(struct clk *clk, ulong rate); * clk_request/get_by_*(). * @parent: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return new rate, or -ve error code. + * Return: new rate, or -ve error code. */ int clk_set_parent(struct clk *clk, struct clk *parent); @@ -461,7 +461,7 @@ int clk_set_parent(struct clk *clk, struct clk *parent); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_enable(struct clk *clk); @@ -470,7 +470,7 @@ int clk_enable(struct clk *clk); * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_enable_bulk(struct clk_bulk *bulk); @@ -479,7 +479,7 @@ int clk_enable_bulk(struct clk_bulk *bulk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_disable(struct clk *clk); @@ -488,7 +488,7 @@ int clk_disable(struct clk *clk); * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_disable_bulk(struct clk_bulk *bulk); @@ -511,7 +511,7 @@ bool clk_is_match(const struct clk *p, const struct clk *q); * * @clkp: A pointer to clock struct that has been found among added clocks * to UCLASS_CLK - * @return zero on success, or -ENOENT on error + * Return: zero on success, or -ENOENT on error */ int clk_get_by_id(ulong id, struct clk **clkp); @@ -520,7 +520,7 @@ int clk_get_by_id(ulong id, struct clk **clkp); * * @clk A pointer to the clk * - * @return true on binded, or false on no + * Return: true on binded, or false on no */ bool clk_dev_binded(struct clk *clk); @@ -606,7 +606,7 @@ static inline bool clk_dev_binded(struct clk *clk) * clk_valid() - check if clk is valid * * @clk: the clock to check - * @return true if valid, or false + * Return: true if valid, or false */ static inline bool clk_valid(struct clk *clk) { diff --git a/include/clk/sunxi.h b/include/clk/sunxi.h index d4ad5fd..a2239b9 100644 --- a/include/clk/sunxi.h +++ b/include/clk/sunxi.h @@ -91,7 +91,7 @@ extern struct clk_ops sunxi_clk_ops; * * @dev: reset device * @count: reset count - * @return 0 success, or error value + * Return: 0 success, or error value */ int sunxi_reset_bind(struct udevice *dev, ulong count); diff --git a/include/command.h b/include/command.h index f8e07a5..0cf12fd 100644 --- a/include/command.h +++ b/include/command.h @@ -96,7 +96,7 @@ int cmd_auto_complete(const char *const prompt, char *buf, int *np, * * @cmdtp: Command which caused the error * @err: Error code (0 if none, -ve for error, like -EIO) - * @return 0 (CMD_RET_SUCCESS) if there is not error, + * Return: 0 (CMD_RET_SUCCESS) if there is not error, * 1 (CMD_RET_FAILURE) if an error is found * -1 (CMD_RET_USAGE) if 'usage' error is found */ @@ -138,7 +138,7 @@ int cmd_process_error(struct cmd_tbl *cmdtp, int err); * @arg: Pointers to the command to check. If a valid specifier is present it * will be the last character of the string, following a '.' * @default_size: Default size to return if there is no specifier - * @return data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid + * Return: data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid * character, or CMD_DATA_SIZE_STR for a string */ int cmd_get_data_size(char *arg, int default_size); @@ -198,7 +198,7 @@ int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc, * @s: String to replace with * @global: true to replace all matches in @data, false to replace just the * first - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size, const char *r, const char *s, bool global); @@ -229,7 +229,7 @@ enum command_ret_t { * is left unchanged. * @param ticks If ticks is not null, this function set it to the * number of ticks the command took to complete. - * @return 0 if the command succeeded, 1 if it failed + * Return: 0 if the command succeeded, 1 if it failed */ int cmd_process(int flag, int argc, char *const argv[], int *repeatable, unsigned long *ticks); @@ -250,7 +250,7 @@ void fixup_cmdtable(struct cmd_tbl *cmdtp, int size); * simply hang. * * @cmdline: Command line string to execute - * @return 0 if OK, 1 for error + * Return: 0 if OK, 1 for error */ int board_run_command(const char *cmdline); @@ -266,7 +266,7 @@ int run_command_repeatable(const char *cmd, int flag); * @param cmd List of commands to run, each separated bu semicolon * @param len Length of commands excluding terminator if known (-1 if not) * @param flag Execution flags (CMD_FLAG_...) - * @return 0 on success, or != 0 on error. + * Return: 0 on success, or != 0 on error. */ int run_command_list(const char *cmd, int len, int flag); #endif /* __ASSEMBLY__ */ diff --git a/include/compiler.h b/include/compiler.h index 8cf1179..ef7b2cb 100644 --- a/include/compiler.h +++ b/include/compiler.h @@ -157,7 +157,7 @@ typedef unsigned long int uintptr_t; /** * tools_build() - check if we are building host tools * - * @return true if building for the host, false if for a target + * Return: true if building for the host, false if for a target */ static inline bool tools_build(void) { diff --git a/include/console.h b/include/console.h index b182440..ceb733b 100644 --- a/include/console.h +++ b/include/console.h @@ -33,7 +33,7 @@ int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */ * Iterates over registered STDIO devices and match them with given @flags * and @name. * - * @return pointer to the &struct stdio_dev if found, or NULL otherwise + * Return: pointer to the &struct stdio_dev if found, or NULL otherwise */ struct stdio_dev *console_search_dev(int flags, const char *name); @@ -44,7 +44,7 @@ struct stdio_dev *console_search_dev(int flags, const char *name); * This should be called as soon as malloc() is available so that the maximum * amount of console output can be recorded. * - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int console_record_init(void); @@ -60,7 +60,7 @@ void console_record_reset(void); * * This should be called to enable the console buffer. * - * @return 0 (always) + * Return: 0 (always) */ int console_record_reset_enable(void); @@ -72,7 +72,7 @@ int console_record_reset_enable(void); * * @str: Place to put string * @maxlen: Maximum length of @str including nul terminator - * @return length of string returned, or -ENOSPC if the console buffer was + * Return: length of string returned, or -ENOSPC if the console buffer was * overflowed by the output */ int console_record_readline(char *str, int maxlen); @@ -80,7 +80,7 @@ int console_record_readline(char *str, int maxlen); /** * console_record_avail() - Get the number of available bytes in console output * - * @return available bytes (0 if empty) + * Return: available bytes (0 if empty) */ int console_record_avail(void); @@ -91,7 +91,7 @@ int console_record_avail(void); * returned if a function calls e.g. `getc()` * * @str: the string to write - * @return the number of bytes added + * Return: the number of bytes added */ int console_in_puts(const char *str); #else @@ -141,7 +141,7 @@ static inline int console_in_puts(const char *str) * This function prints a banner on devices which (we assume) did not receive * it before relocation. * - * @return 0 (meaning no errors) + * Return: 0 (meaning no errors) */ int console_announce_r(void); diff --git a/include/cpu_func.h b/include/cpu_func.h index 23cd5ec..45e8a0a 100644 --- a/include/cpu_func.h +++ b/include/cpu_func.h @@ -45,7 +45,7 @@ int is_core_valid(unsigned int core); * This is used on PowerPC, SH and X86 machines as a CPU init mechanism. It is * called during the pre-relocation init sequence in board_init_f(). * - * @return 0 if oK, -ve on error + * Return: 0 if oK, -ve on error */ int checkcpu(void); diff --git a/include/cros_ec.h b/include/cros_ec.h index ef89def..2a77286 100644 --- a/include/cros_ec.h +++ b/include/cros_ec.h @@ -67,7 +67,7 @@ struct fdt_cros_ec { * @param dev CROS-EC device * @param id Place to put the ID * @param maxlen Maximum length of the ID field - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_id(struct udevice *dev, char *id, int maxlen); @@ -78,7 +78,7 @@ int cros_ec_read_id(struct udevice *dev, char *id, int maxlen); * * @param dev CROS-EC device * @param scan Place to put the scan results - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan); @@ -88,7 +88,7 @@ int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan); * Send a message requesting the next event and return the result. * * @param event Place to put the event. - * @return 0 if ok, <0 on error. + * Return: 0 if ok, <0 on error. */ int cros_ec_get_next_event(struct udevice *dev, struct ec_response_get_next_event *event); @@ -98,7 +98,7 @@ int cros_ec_get_next_event(struct udevice *dev, * * @param dev CROS-EC device * @param image Destination for image identifier - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_read_current_image(struct udevice *dev, enum ec_current_image *image); @@ -109,7 +109,7 @@ int cros_ec_read_current_image(struct udevice *dev, * @param dev CROS-EC device * @param hash_offset Offset in flash to read from * @param hash Destination for hash information - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_read_hash(struct udevice *dev, uint hash_offset, struct ec_response_vboot_hash *hash); @@ -122,7 +122,7 @@ int cros_ec_read_hash(struct udevice *dev, uint hash_offset, * @param dev CROS-EC device * @param cmd Reboot command * @param flags Flags for reboot command (EC_REBOOT_FLAG_*) - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags); @@ -133,7 +133,7 @@ int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags); * If no external interrupt is configured, this always returns 1. * * @param dev CROS-EC device - * @return 0 if no interrupt is pending + * Return: 0 if no interrupt is pending */ int cros_ec_interrupt_pending(struct udevice *dev); @@ -151,7 +151,7 @@ enum { * * @param blob Device tree blob containing setup information * @param cros_ecp Returns pointer to the cros_ec device, or NULL if none - * @return 0 if we got an cros_ec device and all is well (or no cros_ec is + * Return: 0 if we got an cros_ec device and all is well (or no cros_ec is * expected), -ve if we should have an cros_ec device but failed to find * one, or init failed (-CROS_EC_ERR_...). */ @@ -170,7 +170,7 @@ int cros_ec_info(struct udevice *dev, struct ec_response_mkbp_info *info); * * @param dev CROS-EC device * @param events_ptr Destination for event flags. Not changed on error. - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr); @@ -179,7 +179,7 @@ int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr); * * @param dev CROS-EC device * @param events Event flags to clear - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_clear_host_events(struct udevice *dev, uint32_t events); @@ -192,7 +192,7 @@ int cros_ec_clear_host_events(struct udevice *dev, uint32_t events); * @param set_flags New flag values; only bits in set_mask are applied; * ignored if set_mask=0. * @param prot Destination for updated protection state from EC. - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_flash_protect(struct udevice *dev, uint32_t set_mask, uint32_t set_flags, @@ -202,7 +202,7 @@ int cros_ec_flash_protect(struct udevice *dev, uint32_t set_mask, * Run internal tests on the cros_ec interface. * * @param dev CROS-EC device - * @return 0 if ok, <0 if the test failed + * Return: 0 if ok, <0 if the test failed */ int cros_ec_test(struct udevice *dev); @@ -212,7 +212,7 @@ int cros_ec_test(struct udevice *dev); * @param dev CROS-EC device * @param image the content to write * @param imafge_size content length - * @return 0 if ok, <0 if the test failed + * Return: 0 if ok, <0 if the test failed */ int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t *image, int image_size); @@ -220,7 +220,7 @@ int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t *image, /** * Return a pointer to the board's CROS-EC device * - * @return pointer to CROS-EC device, or NULL if none is available + * Return: pointer to CROS-EC device, or NULL if none is available */ struct udevice *board_get_cros_ec_dev(void); @@ -302,7 +302,7 @@ void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len); * * @param data Data block to checksum * @param size Size of data block in bytes - * @return checksum value (0 to 255) + * Return: checksum value (0 to 255) */ int cros_ec_calc_checksum(const uint8_t *data, int size); @@ -321,7 +321,7 @@ int cros_ec_flash_erase(struct udevice *dev, uint32_t offset, uint32_t size); * @param data Pointer to data buffer to read into * @param offset Offset within flash to read from * @param size Number of bytes to read - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_flash_read(struct udevice *dev, uint8_t *data, uint32_t offset, uint32_t size); @@ -353,7 +353,7 @@ int cros_ec_read_flashinfo(struct udevice *dev, * @param data Pointer to data buffer to write * @param offset Offset within flash to write to. * @param size Number of bytes to write - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data, uint32_t offset, uint32_t size); @@ -365,7 +365,7 @@ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data, * @param region Flash region to query * @param offset Returns offset of flash region in EC flash * @param size Returns size of flash region - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_flash_offset(struct udevice *dev, enum ec_flash_region region, uint32_t *offset, uint32_t *size); @@ -383,7 +383,7 @@ int cros_ec_get_sku_id(struct udevice *dev); * * @param dev CROS-EC device * @param block Buffer of VbNvContext to be read/write - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_nvdata(struct udevice *dev, uint8_t *block, int size); int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size); @@ -393,7 +393,7 @@ int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size); * * @param dev CROS-EC device * @param versionp This is set to point to the version information - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_version(struct udevice *dev, struct ec_response_get_version **versionp); @@ -403,7 +403,7 @@ int cros_ec_read_version(struct udevice *dev, * * @param dev CROS-EC device * @param versionp This is set to point to the build string - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_build_info(struct udevice *dev, char **strp); @@ -413,7 +413,7 @@ int cros_ec_read_build_info(struct udevice *dev, char **strp); * @param dev CROS-EC device * @param index index of the LDO/FET to switch * @param state new state of the LDO/FET : EC_LDO_STATE_ON|OFF - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state); @@ -423,7 +423,7 @@ int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state); * @param dev CROS-EC device * @param index index of the LDO/FET to switch * @param state current state of the LDO/FET : EC_LDO_STATE_ON|OFF - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state); @@ -433,7 +433,7 @@ int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state); * This permits delayed reporting of the EC error if it failed during * early init. * - * @return error (0 if there was no error, -ve if there was an error) + * Return: error (0 if there was no error, -ve if there was an error) */ int cros_ec_get_error(void); @@ -468,7 +468,7 @@ int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *msg, /** * cros_ec_get_events_b() - Get event mask B * - * @return value of event mask, default value of 0 if it could not be read + * Return: value of event mask, default value of 0 if it could not be read */ uint64_t cros_ec_get_events_b(struct udevice *dev); @@ -477,7 +477,7 @@ uint64_t cros_ec_get_events_b(struct udevice *dev); * * Any pending events in the B range are cleared * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_clear_events_b(struct udevice *dev, uint64_t mask); @@ -486,7 +486,7 @@ int cros_ec_clear_events_b(struct udevice *dev, uint64_t mask); * * @param dev CROS-EC device * @param region Flash region to query - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region); @@ -499,7 +499,7 @@ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region); * * @param dev CROS-EC device * @param flags Flags to use (EC_BATTERY_CUTOFF_FLAG_...) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_battery_cutoff(struct udevice *dev, uint8_t flags); @@ -512,7 +512,7 @@ int cros_ec_battery_cutoff(struct udevice *dev, uint8_t flags); * @param dev CROS-EC device * @param index Index of the pwm * @param duty Desired duty cycle, in 0..EC_PWM_MAX_DUTY range. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_set_pwm_duty(struct udevice *dev, uint8_t index, uint16_t duty); @@ -524,7 +524,7 @@ int cros_ec_set_pwm_duty(struct udevice *dev, uint8_t index, uint16_t duty); * * @param dev CROS-EC device * @param limit_powerp Returns whether power is limited (0 or 1) - * @return 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL + * Return: 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL * if the EC returned an invalid response */ int cros_ec_read_limit_power(struct udevice *dev, int *limit_powerp); @@ -534,7 +534,7 @@ int cros_ec_read_limit_power(struct udevice *dev, int *limit_powerp); * * @param dev CROS-EC device * @param flags Flags to use (EC_POWER_BUTTON_...) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_config_powerbtn(struct udevice *dev, uint32_t flags); @@ -544,7 +544,7 @@ int cros_ec_config_powerbtn(struct udevice *dev, uint32_t flags); * Determines whether a lid close event is reported * * @param dev CROS-EC device - * @return shufdown mas if OK, -ve on error + * Return: shufdown mas if OK, -ve on error */ int cros_ec_get_lid_shutdown_mask(struct udevice *dev); @@ -555,7 +555,7 @@ int cros_ec_get_lid_shutdown_mask(struct udevice *dev); * * @param dev CROS-EC device * @param enable true to enable reporting, false to disable - * @return shufdown mas if OK, -ve on error + * Return: shufdown mas if OK, -ve on error */ int cros_ec_set_lid_shutdown_mask(struct udevice *dev, int enable); @@ -567,7 +567,7 @@ int cros_ec_set_lid_shutdown_mask(struct udevice *dev, int enable); * * @dev: CROS-EC device * @handshakep: If non-NULL, returns received handshake value on error - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_hello(struct udevice *dev, uint *handshakep); @@ -578,7 +578,7 @@ int cros_ec_hello(struct udevice *dev, uint *handshakep); * * @dev: CROS-EC device * @featuresp: Returns a bitmask of supported features - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_get_features(struct udevice *dev, u64 *featuresp); @@ -587,7 +587,7 @@ int cros_ec_get_features(struct udevice *dev, u64 *featuresp); * * @dev: CROS-EC device * @feature: Feature number to check (enum ec_feature_code) - * @return true if supported, false if not, -ve on error + * Return: true if supported, false if not, -ve on error */ int cros_ec_check_feature(struct udevice *dev, uint feature); @@ -595,7 +595,7 @@ int cros_ec_check_feature(struct udevice *dev, uint feature); * cros_ec_get_switches() - Get switches value * * @dev: CROS-EC device - * @return switches value, or -ENOSYS if not supported, or other -ve value on + * Return: switches value, or -ENOSYS if not supported, or other -ve value on * other error */ int cros_ec_get_switches(struct udevice *dev); @@ -604,7 +604,7 @@ int cros_ec_get_switches(struct udevice *dev); * cros_ec_vstore_supported() - Check if vstore is supported * * @dev: CROS-EC device - * @return false if not supported, true if supported, -ve on error + * Return: false if not supported, true if supported, -ve on error */ int cros_ec_vstore_supported(struct udevice *dev); @@ -613,7 +613,7 @@ int cros_ec_vstore_supported(struct udevice *dev); * * @dev: CROS-EC device * @lockedp: mask of locked slots - * @return number of vstore slots supported by the EC,, -ve on error + * Return: number of vstore slots supported by the EC,, -ve on error */ int cros_ec_vstore_info(struct udevice *dev, u32 *lockedp); @@ -623,7 +623,7 @@ int cros_ec_vstore_info(struct udevice *dev, u32 *lockedp); * @dev: CROS-EC device * @slot: vstore slot to read from * @data: buffer to store read data, must be EC_VSTORE_SLOT_SIZE bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_vstore_read(struct udevice *dev, int slot, uint8_t *data); @@ -638,7 +638,7 @@ int cros_ec_vstore_read(struct udevice *dev, int slot, uint8_t *data); * @slot: vstore slot to write into * @data: data to write * @size: size of data in bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_vstore_write(struct udevice *dev, int slot, const uint8_t *data, size_t size); diff --git a/include/crypt.h b/include/crypt.h index f18a170..3301f3b 100644 --- a/include/crypt.h +++ b/include/crypt.h @@ -9,6 +9,6 @@ * @equal Pointer to an int where the result is stored * '0' = unequal * '1' = equal - * @return 0 on success, error code of errno else + * Return: 0 on success, error code of errno else */ int crypt_compare(const char *should, const char *passphrase, int *equal); diff --git a/include/display.h b/include/display.h index 6629461..3d01217 100644 --- a/include/display.h +++ b/include/display.h @@ -27,7 +27,7 @@ struct display_plat { * display_read_timing() - Read timing information * * @dev: Device to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int display_read_timing(struct udevice *dev, struct display_timing *timing); @@ -37,7 +37,7 @@ int display_read_timing(struct udevice *dev, struct display_timing *timing); * @dev: Device to enable * @panel_bpp: Number of bits per pixel for panel * @timing: Display timings - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int display_enable(struct udevice *dev, int panel_bpp, const struct display_timing *timing); @@ -45,7 +45,7 @@ int display_enable(struct udevice *dev, int panel_bpp, /** * display_in_use() - Check if a display is in use by any device * - * @return true if the device is in use (display_enable() has been called + * Return: true if the device is in use (display_enable() has been called * successfully), else false */ bool display_in_use(struct udevice *dev); diff --git a/include/display_options.h b/include/display_options.h index 43810cb..33fcbb8 100644 --- a/include/display_options.h +++ b/include/display_options.h @@ -66,7 +66,7 @@ int print_buffer(ulong addr, const void *data, uint width, uint count, * @linelen: Number of values to print per line; specify 0 for default length * @out: Output buffer to hold the dump * @size: Size of output buffer in bytes - * @return number of bytes processed, if OK, -ENOSPC if buffer too small + * Return: number of bytes processed, if OK, -ENOSPC if buffer too small * */ int hexdump_line(ulong addr, const void *data, uint width, uint count, @@ -91,7 +91,7 @@ int display_options(void); * @newlines: true to include two newlines at the start * @buf: place to put string * @size: Size of buf (string is truncated to fit) - * @return buf + * Return: buf */ char *display_options_get_banner(bool newlines, char *buf, int size); diff --git a/include/dm/acpi.h b/include/dm/acpi.h index 7f1f2ef..0fa239e 100644 --- a/include/dm/acpi.h +++ b/include/dm/acpi.h @@ -139,7 +139,7 @@ struct acpi_ops { * @dev: Device to check * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX * bytes - * @return 0 if OK, -ENOENT if no name is available, other -ve value on + * Return: 0 if OK, -ENOENT if no name is available, other -ve value on * other error */ int acpi_get_name(const struct udevice *dev, char *out_name); @@ -159,7 +159,7 @@ int acpi_get_name(const struct udevice *dev, char *out_name); * * @out_name: Place to put the name * @name: Name to copy - * @return 0 (always) + * Return: 0 (always) */ int acpi_copy_name(char *out_name, const char *name); @@ -169,7 +169,7 @@ int acpi_copy_name(char *out_name, const char *name); * This scans through all devices and tells them to write any tables they want * to write. * - * @return 0 if OK, -ve if any device returned an error + * Return: 0 if OK, -ve if any device returned an error */ int acpi_write_dev_tables(struct acpi_ctx *ctx); @@ -179,7 +179,7 @@ int acpi_write_dev_tables(struct acpi_ctx *ctx); * This is called to create the SSDT code for all devices. * * @ctx: ACPI context to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_fill_ssdt(struct acpi_ctx *ctx); @@ -189,7 +189,7 @@ int acpi_fill_ssdt(struct acpi_ctx *ctx); * This is called to create the DSDT code for all devices. * * @ctx: ACPI context to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_inject_dsdt(struct acpi_ctx *ctx); @@ -200,7 +200,7 @@ int acpi_inject_dsdt(struct acpi_ctx *ctx); * * @ctx: ACPI context to use * @nhlt: Pointer to nhlt information to add to - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_setup_nhlt(struct acpi_ctx *ctx, struct nhlt *nhlt); @@ -223,7 +223,7 @@ void acpi_dump_items(enum acpi_dump_option option); * @dev: Device to check * @out_path: Buffer to place the path in (should be ACPI_PATH_MAX long) * @maxlen: Size of buffer (typically ACPI_PATH_MAX) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen); diff --git a/include/dm/device-internal.h b/include/dm/device-internal.h index e6b71cb..02002ac 100644 --- a/include/dm/device-internal.h +++ b/include/dm/device-internal.h @@ -109,7 +109,7 @@ struct udevice; * @ofnode: Devicetree node for this device. This is ofnode_null() for * devices which don't use devicetree or don't have a node. * @devp: if non-NULL, returns a pointer to the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_bind(struct udevice *parent, const struct driver *drv, const char *name, void *plat, ofnode node, @@ -132,7 +132,7 @@ int device_bind(struct udevice *parent, const struct driver *drv, * @node: Device tree node for this device. This is invalid for devices which * don't use device tree. * @devp: if non-NULL, returns a pointer to the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_bind_with_driver_data(struct udevice *parent, const struct driver *drv, const char *name, @@ -149,7 +149,7 @@ int device_bind_with_driver_data(struct udevice *parent, * is set. If false bind the driver always. * @info: Name and plat for this device * @devp: if non-NULL, returns a pointer to the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, const struct driver_info *info, struct udevice **devp); @@ -159,7 +159,7 @@ int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, * * @dev: pointer to device to be reparented * @new_parent: pointer to new parent device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_reparent(struct udevice *dev, struct udevice *new_parent); @@ -175,7 +175,7 @@ int device_reparent(struct udevice *dev, struct udevice *new_parent); * All private data associated with the device is allocated. * * @dev: Pointer to device to process - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_of_to_plat(struct udevice *dev); @@ -186,7 +186,7 @@ int device_of_to_plat(struct udevice *dev); * first. * * @dev: Pointer to device to probe - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_probe(struct udevice *dev); @@ -198,7 +198,7 @@ int device_probe(struct udevice *dev); * * @dev: Pointer to device to remove * @flags: Flags for selective device removal (DM_REMOVE_...) - * @return 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if + * Return: 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if * this is a vital device and flags is DM_REMOVE_NON_VITAL, other -ve on * error (such an error here is normally a very bad thing) */ @@ -214,7 +214,7 @@ static inline int device_remove(struct udevice *dev, uint flags) { return 0; } * Unbind a device and remove all memory used by it * * @dev: Pointer to device to unbind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) int device_unbind(struct udevice *dev); @@ -237,7 +237,7 @@ static inline void device_free(struct udevice *dev) {} * * @dev: The device that is to be stripped of its children * @drv: The targeted driver - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) int device_chld_unbind(struct udevice *dev, struct driver *drv); @@ -261,7 +261,7 @@ static inline int device_chld_unbind(struct udevice *dev, struct driver *drv) * @dev: The device whose children are to be removed * @drv: The targeted driver * @flags: Flag, if this functions is called in the pre-OS stage - * @return 0 on success, -EPROBE_DEFER if any child failed to remove, other + * Return: 0 on success, -EPROBE_DEFER if any child failed to remove, other * -ve on error */ #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) @@ -385,7 +385,7 @@ void dev_set_uclass_plat(struct udevice *dev, void *uclass_plat); * * @dev: Simple bus device (parent of target device) * @addr: Address to translate - * @return new address + * Return: new address */ fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr); diff --git a/include/dm/pci.h b/include/dm/pci.h index bddacbf..d35d24d 100644 --- a/include/dm/pci.h +++ b/include/dm/pci.h @@ -16,7 +16,7 @@ struct udevice; * This returns an int to avoid a dependency on pci.h * * @dev: PCI device - * @return devfn in bits 15...8 if found (pci_dev_t format), or -ENODEV if not + * Return: devfn in bits 15...8 if found (pci_dev_t format), or -ENODEV if not * found */ int pci_get_devfn(struct udevice *dev); @@ -33,7 +33,7 @@ int pci_get_devfn(struct udevice *dev); * @reg: reg value from dt-plat.c array (first member). This is not a * pointer type, since the caller may use fdt32_t or fdt64_t depending on * the address sizes. - * @return device/function for that device (pci_dev_t format) + * Return: device/function for that device (pci_dev_t format) */ static inline int pci_ofplat_get_devfn(u32 reg) { diff --git a/include/dm/test.h b/include/dm/test.h index a9562b2..4919064 100644 --- a/include/dm/test.h +++ b/include/dm/test.h @@ -26,7 +26,7 @@ struct dm_test_pdata { * @dev: Device to operate on * @pingval: Value to ping the device with * @pingret: Returns resulting value from driver - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ struct test_ops { int (*ping)(struct udevice *dev, int pingval, int *pingret); @@ -189,7 +189,7 @@ int testfdt_ping(struct udevice *dev, int pingval, int *pingret); * @dev: Device to test * @base: Base address, used to check ping return value * @priv: Pointer to private test information - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, uint32_t base, struct dm_test_priv *priv); @@ -199,7 +199,7 @@ int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, * * @dms: Overall test state * @num_devices: Number of test devices to check - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_check_devices(struct unit_test_state *uts, int num_devices); diff --git a/include/dm/uclass-internal.h b/include/dm/uclass-internal.h index fb0edcc..e71b86a 100644 --- a/include/dm/uclass-internal.h +++ b/include/dm/uclass-internal.h @@ -89,7 +89,7 @@ void uclass_set_priv(struct uclass *uc, void *priv); * This allows assigning the sequence number in the binding order. * * @uc: uclass to check - * @return The next free sequence number + * Return: The next free sequence number */ int uclass_find_next_free_seq(struct uclass *uc); @@ -101,7 +101,7 @@ int uclass_find_next_free_seq(struct uclass *uc); * @dev: Device that needs to be probed * @ret: Error to return. If non-zero then the device is not probed * @devp: Returns the value of 'dev' if there is no error - * @return ret, if non-zero, else the result of the device_probe() call + * Return: ret, if non-zero, else the result of the device_probe() call */ int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp); @@ -112,7 +112,7 @@ int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp); * * The device is not prepared for use - this is an internal function. * - * @return the index of the device in the uclass list or -ENODEV if not found. + * Return: the index of the device in the uclass list or -ENODEV if not found. */ int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp); @@ -125,7 +125,7 @@ int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp); * The device is not prepared for use - this is an internal function. * The function uclass_get_device_tail() can be used to probe the device. * - * @return the uclass pointer of a child at the given index or + * Return: the uclass pointer of a child at the given index or * return NULL on error. */ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp); @@ -138,7 +138,7 @@ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp); * The device is not prepared for use - this is an internal function. * The function uclass_get_device_tail() can be used to probe the device. * - * @return 0 if OK (found or not found), -ve on error + * Return: 0 if OK (found or not found), -ve on error */ int uclass_find_first_device(enum uclass_id id, struct udevice **devp); @@ -150,7 +150,7 @@ int uclass_find_first_device(enum uclass_id id, struct udevice **devp); * The device is not prepared for use - this is an internal function. * The function uclass_get_device_tail() can be used to probe the device. * - * @return 0 if OK (found or not found), -ve on error + * Return: 0 if OK (found or not found), -ve on error */ int uclass_find_next_device(struct udevice **devp); @@ -164,7 +164,7 @@ int uclass_find_next_device(struct udevice **devp); * @id: ID to look up * @name: name of a device to find * @devp: Returns pointer to device (the first one with the name) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int uclass_find_device_by_name(enum uclass_id id, const char *name, struct udevice **devp); @@ -179,7 +179,7 @@ int uclass_find_device_by_name(enum uclass_id id, const char *name, * @id: ID to look up * @seq: Sequence number to find (0=first) * @devp: Returns pointer to device (there is only one per for each seq) - * @return 0 if OK, -ENODEV if not found + * Return: 0 if OK, -ENODEV if not found */ int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp); @@ -195,7 +195,7 @@ int uclass_find_device_by_seq(enum uclass_id id, int seq, * @id: ID to look up * @node: Device tree offset to search for (if -ve then -ENODEV is returned) * @devp: Returns pointer to device (there is only one for each node) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int uclass_find_device_by_of_offset(enum uclass_id id, int node, struct udevice **devp); @@ -211,7 +211,7 @@ int uclass_find_device_by_of_offset(enum uclass_id id, int node, * @id: ID to look up * @node: Device tree offset to search for (if NULL then -ENODEV is returned) * @devp: Returns pointer to device (there is only one for each node) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node, struct udevice **devp); @@ -227,7 +227,7 @@ int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node, * @parent: Parent device containing the phandle pointer * @name: Name of property in the parent device node * @devp: Returns pointer to device (there is only one for each node) - * @return 0 if OK, -ENOENT if there is no @name present in the node, other + * Return: 0 if OK, -ENOENT if there is no @name present in the node, other * -ve on error */ int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent, @@ -317,7 +317,7 @@ int uclass_get_count(void); * uclass_find() - Find uclass by its id * * @id: Id to serach for - * @return pointer to uclass, or NULL if not found + * Return: pointer to uclass, or NULL if not found */ struct uclass *uclass_find(enum uclass_id key); @@ -327,7 +327,7 @@ struct uclass *uclass_find(enum uclass_id key); * Destroy a uclass and all its devices * * @uc: uclass to destroy - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int uclass_destroy(struct uclass *uc); diff --git a/include/dm/util.h b/include/dm/util.h index 17baf55..4428f04 100644 --- a/include/dm/util.h +++ b/include/dm/util.h @@ -20,7 +20,7 @@ struct list_head; * list_count_items() - Count number of items in a list * * @param head: Head of list - * @return number of items, or 0 if empty + * Return: number of items, or 0 if empty */ int list_count_items(struct list_head *head); diff --git a/include/dma.h b/include/dma.h index a64580a..9b39221 100644 --- a/include/dma.h +++ b/include/dma.h @@ -179,7 +179,7 @@ struct dma { * @index: The index of the DMA to request, within the client's list of * DMA channels. * @dma: A pointer to a DMA struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_get_by_index(struct udevice *dev, int index, struct dma *dma); @@ -196,7 +196,7 @@ int dma_get_by_index(struct udevice *dev, int index, struct dma *dma); * @name: The name of the DMA to request, within the client's list of * DMA channels. * @dma: A pointer to a DMA struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_get_by_name(struct udevice *dev, const char *name, struct dma *dma); # else @@ -225,7 +225,7 @@ static inline int dma_get_by_name(struct udevice *dev, const char *name, * @dma: A pointer to a DMA struct to initialize. The caller must * have already initialized any field in this struct which the * DMA provider uses to identify the DMA channel. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_request(struct udevice *dev, struct dma *dma); @@ -234,7 +234,7 @@ int dma_request(struct udevice *dev, struct dma *dma); * * @dma: A DMA struct that was previously successfully requested by * dma_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_free(struct dma *dma); @@ -243,7 +243,7 @@ int dma_free(struct dma *dma); * * @dma: A DMA struct that was previously successfully requested by * dma_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_enable(struct dma *dma); @@ -252,7 +252,7 @@ int dma_enable(struct dma *dma); * * @dma: A DMA struct that was previously successfully requested by * dma_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_disable(struct dma *dma); @@ -266,7 +266,7 @@ int dma_disable(struct dma *dma); * dma_request/get_by_*(). * @dst: The receive buffer pointer. * @size: The receive buffer size - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_prepare_rcv_buf(struct dma *dma, void *dst, size_t size); @@ -277,7 +277,7 @@ int dma_prepare_rcv_buf(struct dma *dma, void *dst, size_t size); * dma_request/get_by_*(). * @dst: The destination pointer. * @metadata: DMA driver's channel specific data - * @return length of received data on success, or zero - no data, + * Return: length of received data on success, or zero - no data, * or -ve error code. */ int dma_receive(struct dma *dma, void **dst, void *metadata); @@ -290,7 +290,7 @@ int dma_receive(struct dma *dma, void **dst, void *metadata); * @src: The source pointer. * @len: Length of the data to be sent (number of bytes). * @metadata: DMA driver's channel specific data - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_send(struct dma *dma, void *src, size_t len, void *metadata); @@ -302,7 +302,7 @@ int dma_send(struct dma *dma, void *src, size_t len, void *metadata); * configuration data client needs * @cfg_data: Pointer to store pointer to DMA driver specific * configuration data for the given cfg_id (output param) - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_get_cfg(struct dma *dma, u32 cfg_id, void **cfg_data); #endif /* CONFIG_DMA_CHANNELS */ @@ -315,7 +315,7 @@ int dma_get_cfg(struct dma *dma, u32 cfg_id, void **cfg_data); * @transfer_type - transfer type should be one/multiple of * DMA_SUPPORTS_* * @devp - udevice pointer to return the found device - * @return - will return on success and devp will hold the + * Return: - will return on success and devp will hold the * pointer to the device */ int dma_get_device(u32 transfer_type, struct udevice **devp); @@ -327,7 +327,7 @@ int dma_get_device(u32 transfer_type, struct udevice **devp); * @dst - destination pointer * @src - souce pointer * @len - data length to be copied - * @return - on successful transfer returns no of bytes + * Return: - on successful transfer returns no of bytes transferred and on failure return error code. */ int dma_memcpy(void *dst, void *src, size_t len); diff --git a/include/dsi_host.h b/include/dsi_host.h index 9dfc7b3..83f8839 100644 --- a/include/dsi_host.h +++ b/include/dsi_host.h @@ -54,7 +54,7 @@ struct dsi_host_ops { * @timing: Display timings * @max_data_lanes: maximum number of data lines * @phy_ops: set of function pointers for performing physical operations - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dsi_host_init(struct udevice *dev, struct mipi_dsi_device *device, @@ -66,7 +66,7 @@ int dsi_host_init(struct udevice *dev, * dsi_host_enable * * @dev: dsi host device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dsi_host_enable(struct udevice *dev); diff --git a/include/dwmmc.h b/include/dwmmc.h index 5fc8ed8..136a95b 100644 --- a/include/dwmmc.h +++ b/include/dwmmc.h @@ -284,7 +284,7 @@ void dwmci_setup_cfg(struct mmc_config *cfg, struct dwmci_host *host, * @cfg: Empty configuration structure (generally &plat->cfg). This is * normally all zeroes at this point. The only purpose of passing * this in is to set mmc->cfg to it. - * @return 0 if OK, -ve if the block device could not be created + * Return: 0 if OK, -ve if the block device could not be created */ int dwmci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); @@ -297,7 +297,7 @@ int dwmci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); * @host: DWMMC host structure * @max_clk: Maximum supported clock speed in HZ (e.g. 150000000) * @min_clk: Minimum supported clock speed in HZ (e.g. 400000) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int add_dwmci(struct dwmci_host *host, u32 max_clk, u32 min_clk); #endif /* !CONFIG_BLK */ diff --git a/include/edid.h b/include/edid.h index 2562733..cee7c4c 100644 --- a/include/edid.h +++ b/include/edid.h @@ -277,7 +277,7 @@ void edid_print_info(struct edid1_info *edid_info); * Check the EDID info. * * @param info The EDID info to be checked - * @return 0 on valid, or -1 on invalid + * Return: 0 on valid, or -1 on invalid */ int edid_check_info(struct edid1_info *info); @@ -286,7 +286,7 @@ int edid_check_info(struct edid1_info *info); * * @param edid_block EDID block data * - * @return 0 on success, or a negative errno on error + * Return: 0 on success, or a negative errno on error */ int edid_check_checksum(u8 *edid_block); @@ -298,7 +298,7 @@ int edid_check_checksum(u8 *edid_block); * @param hmax Returns the maxium horizontal rate * @param vmin Returns the minimum vertical rate * @param vmax Returns the maxium vertical rate - * @return 0 on success, or -1 on error + * Return: 0 on success, or -1 on error */ int edid_get_ranges(struct edid1_info *edid, unsigned int *hmin, unsigned int *hmax, unsigned int *vmin, @@ -319,7 +319,7 @@ struct display_timing; * @param mode_valid Callback validating mode, returning true is mode is * supported, false otherwise. * @parem valid_priv Pointer to private data for mode_valid callback - * @return 0 if timings are OK, -ve on error + * Return: 0 if timings are OK, -ve on error */ int edid_get_timing_validate(u8 *buf, int buf_size, struct display_timing *timing, @@ -337,7 +337,7 @@ int edid_get_timing_validate(u8 *buf, int buf_size, * @param panel_bits_per_colourp Place to put the number of bits per * colour supported by the panel. This will be set to * -1 if not available - * @return 0 if timings are OK, -ve on error + * Return: 0 if timings are OK, -ve on error */ int edid_get_timing(u8 *buf, int buf_size, struct display_timing *timing, int *panel_bits_per_colourp); diff --git a/include/efi_loader.h b/include/efi_loader.h index f20d361..701efcd 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -553,7 +553,7 @@ void efi_initrd_deregister(void); * * Called by bootefi to make ACPI tables available * - * @return 0 if OK, -ENOMEM if no memory is available for the tables + * Return: 0 if OK, -ENOMEM if no memory is available for the tables */ efi_status_t efi_acpi_register(void); /** @@ -561,7 +561,7 @@ efi_status_t efi_acpi_register(void); * * Called by bootefi to make SMBIOS tables available * - * @return 0 if OK, -ENOMEM if no memory is available for the tables + * Return: 0 if OK, -ENOMEM if no memory is available for the tables */ efi_status_t efi_smbios_register(void); @@ -976,7 +976,7 @@ efi_status_t efi_capsule_authenticate(const void *capsule, /** * Install the ESRT system table. * - * @return status code + * Return: status code */ efi_status_t efi_esrt_register(void); diff --git a/include/env.h b/include/env.h index ff8943e..60acb54 100644 --- a/include/env.h +++ b/include/env.h @@ -68,7 +68,7 @@ enum env_redund_flags { * This value increments every time the environment changes, so can be used an * an indication of this * - * @return environment ID + * Return: environment ID */ int env_get_id(void); @@ -78,7 +78,7 @@ int env_get_id(void); * This locates the environment or uses the default if nothing is available. * This must be called before env_get() will work. * - * @return 0 if OK, -ENODEV if no environment drivers are enabled + * Return: 0 if OK, -ENODEV if no environment drivers are enabled */ int env_init(void); @@ -98,7 +98,7 @@ void env_relocate(void); * case this function calls env_get_f(). * * @varname: Variable to look up - * @return value of variable, or NULL if not found + * Return: value of variable, or NULL if not found */ char *env_get(const char *varname); @@ -108,7 +108,7 @@ char *env_get(const char *varname); * place of env_get without changing error handling otherwise. * * @varname: Variable to look up - * @return value of variable, or NULL if not found + * Return: value of variable, or NULL if not found */ char *from_env(const char *envvar); @@ -120,7 +120,7 @@ char *from_env(const char *envvar); * support reading the value (slowly) and some will not. * * @varname: Variable to look up - * @return actual length of the variable value excluding the terminating + * Return: actual length of the variable value excluding the terminating * NULL-byte, or -1 if the variable is not found */ int env_get_f(const char *name, char *buf, unsigned int len); @@ -128,7 +128,7 @@ int env_get_f(const char *name, char *buf, unsigned int len); /** * env_get_yesno() - Read an environment variable as a boolean * - * @return 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default + * Return: 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default * to true), 0 if otherwise */ int env_get_yesno(const char *var); @@ -136,7 +136,7 @@ int env_get_yesno(const char *var); /** * env_get_autostart() - Check if autostart is enabled * - * @return true if the "autostart" env var exists and is set to "yes" + * Return: true if the "autostart" env var exists and is set to "yes" */ bool env_get_autostart(void); @@ -148,7 +148,7 @@ bool env_get_autostart(void); * * @varname: Variable to adjust * @value: Value to set for the variable, or NULL or "" to delete the variable - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_set(const char *varname, const char *value); @@ -161,7 +161,7 @@ int env_set(const char *varname, const char *value); * @name: Variable to look up * @base: Base to use (e.g. 10 for base 10, 2 for binary) * @default_val: Default value to return if no value is found - * @return the value found, or @default_val if none + * Return: the value found, or @default_val if none */ ulong env_get_ulong(const char *name, int base, ulong default_val); @@ -170,7 +170,7 @@ ulong env_get_ulong(const char *name, int base, ulong default_val); * * @varname: Variable to adjust * @value: Value to set for the variable (will be converted to a string) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_set_ulong(const char *varname, ulong value); @@ -191,7 +191,7 @@ ulong env_get_hex(const char *varname, ulong default_val); * * @varname: Variable to adjust * @value: Value to set for the variable (will be converted to a hex string) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_set_hex(const char *varname, ulong value); @@ -200,7 +200,7 @@ int env_set_hex(const char *varname, ulong value); * * @varname: Environment variable to set * @addr: Value to set it to - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ static inline int env_set_addr(const char *varname, const void *addr) { @@ -216,7 +216,7 @@ static inline int env_set_addr(const char *varname, const void *addr) * @maxsz: Size of buffer to use for matches * @buf: Buffer to use for matches * @dollar_comp: non-zero to wrap each match in ${...} - * @return number of matches found (in @cmdv) + * Return: number of matches found (in @cmdv) */ int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf, bool dollar_comp); @@ -226,7 +226,7 @@ int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf, * * @name: Environment variable to get (e.g. "ethaddr") * @enetaddr: Place to put MAC address (6 bytes) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr); @@ -235,7 +235,7 @@ int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr); * * @name: Environment variable to set (e.g. "ethaddr") * @enetaddr: Pointer to MAC address to put into the variable (6 bytes) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr); @@ -258,35 +258,35 @@ int env_set_default_vars(int nvars, char *const vars[], int flags); /** * env_load() - Load the environment from storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_load(void); /** * env_reload() - Re-Load the environment from current storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_reload(void); /** * env_save() - Save the environment to storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_save(void); /** * env_erase() - Erase the environment on storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_erase(void); /** * env_select() - Select the environment storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_select(const char *name); @@ -300,7 +300,7 @@ int env_select(const char *name); * @check: non-zero to check the CRC at the start of the environment, 0 to * ignore it * @flags: Flags controlling matching (H_... - see search.h) - * @return 0 if imported successfully, -ENOMSG if the CRC was bad, -EIO if + * Return: 0 if imported successfully, -ENOMSG if the CRC was bad, -EIO if * something else went wrong */ int env_import(const char *buf, int check, int flags); @@ -311,7 +311,7 @@ int env_import(const char *buf, int check, int flags); * Export from hash table into binary representation * * @env_out: Buffer to contain the environment (must be large enough!) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_export(struct environment_s *env_out); @@ -323,7 +323,7 @@ int env_export(struct environment_s *env_out); * @buf1_read_fail: 0 if buf1 is valid, non-zero if invalid * @buf2: Second environment (struct environemnt_s *) * @buf2_read_fail: 0 if buf2 is valid, non-zero if invalid - * @return 0 if OK, + * Return: 0 if OK, * -EIO if no environment is valid, * -ENOMSG if the CRC was bad */ @@ -339,7 +339,7 @@ int env_check_redund(const char *buf1, int buf1_read_fail, * @buf2: Second environment (struct environemnt_s *) * @buf2_read_fail: 0 if buf2 is valid, non-zero if invalid * @flags: Flags controlling matching (H_... - see search.h) - * @return 0 if OK, -EIO if no environment is valid, -ENOMSG if the CRC was bad + * Return: 0 if OK, -EIO if no environment is valid, -ENOMSG if the CRC was bad */ int env_import_redund(const char *buf1, int buf1_read_fail, const char *buf2, int buf2_read_fail, @@ -349,7 +349,7 @@ int env_import_redund(const char *buf1, int buf1_read_fail, * env_get_default() - Look up a variable from the default environment * * @name: Variable to look up - * @return value if found, NULL if not found in default environment + * Return: value if found, NULL if not found in default environment */ char *env_get_default(const char *name); diff --git a/include/env_internal.h b/include/env_internal.h index 174c3b1..07c227e 100644 --- a/include/env_internal.h +++ b/include/env_internal.h @@ -220,7 +220,7 @@ extern struct hsearch_data env_htab; * It is a weak function allowing board to overidde the default interface for * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE * - * @return string of interface, empty if not supported + * Return: string of interface, empty if not supported */ const char *env_ext4_get_intf(void); @@ -230,7 +230,7 @@ const char *env_ext4_get_intf(void); * It is a weak function allowing board to overidde the default device and * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART * - * @return string of device and partition + * Return: string of device and partition */ const char *env_ext4_get_dev_part(void); @@ -242,7 +242,7 @@ const char *env_ext4_get_dev_part(void); * @op: operations performed on the environment * @prio: priority between the multiple environments, 0 being the * highest priority - * @return an enum env_location value on success, or -ve error code. + * Return: an enum env_location value on success, or -ve error code. */ enum env_location env_get_location(enum env_operation op, int prio); #endif /* DO_DEPS_ONLY */ diff --git a/include/extension_board.h b/include/extension_board.h index c530a0a..3b75b5b 100644 --- a/include/extension_board.h +++ b/include/extension_board.h @@ -19,7 +19,7 @@ struct extension { /** * extension_board_scan - Add system-specific function to scan extension board. * @param extension_list List of extension board information to update. - * @return the number of extension. + * Return: the number of extension. * * This function is called if CONFIG_CMD_EXTENSION is defined. * Needs to fill the list extension_list with elements. diff --git a/include/fdt_region.h b/include/fdt_region.h index d0c6876..b4930df 100644 --- a/include/fdt_region.h +++ b/include/fdt_region.h @@ -131,7 +131,7 @@ struct fdt_region_state { * @path_len: Length of path, must be large enough to hold the longest * path in the tree * @add_string_tab: 1 to add a region for the string table - * @return number of regions in list. If this is >max_regions then the + * Return: number of regions in list. If this is >max_regions then the * region array was exhausted. You should increase max_regions and try * the call again. */ @@ -232,7 +232,7 @@ int fdt_find_regions(const void *fdt, char * const inc[], int inc_count, * @data: Pointer to data (node name, property name, compatible * string, value (not yet supported) * @size: Size of data, or 0 if none - * @return 0 to exclude, 1 to include, -1 if no information is + * Return: 0 to exclude, 1 to include, -1 if no information is * available * @priv: Private pointer passed to h_include * @region: Returns list of regions, sorted by offset @@ -243,7 +243,7 @@ int fdt_find_regions(const void *fdt, char * const inc[], int inc_count, * path in the tree * @flags: Various flags that control the region algortihm, see * FDT_REG_... - * @return number of regions in list. If this is >max_regions then the + * Return: number of regions in list. If this is >max_regions then the * region array was exhausted. You should increase max_regions and try * the call again. Only the first max_regions elements are available in the * array. @@ -295,7 +295,7 @@ int fdt_next_region(const void *fdt, * @count: Number of regions * @max_regions: Number of entries that can fit in @region * @info: Region state as returned from fdt_next_region() - * @return new number of regions in @region (i.e. count + the number added) + * Return: new number of regions in @region (i.e. count + the number added) * or -FDT_ERR_NOSPACE if there was not enough space. */ int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count, diff --git a/include/fdt_support.h b/include/fdt_support.h index 8ec461a..e7cd4aa 100644 --- a/include/fdt_support.h +++ b/include/fdt_support.h @@ -18,7 +18,7 @@ * Defined in arch/$(ARCH)/lib/bootm-fdt.c * * @blob: FDT blob to write to - * @return 0 if ok, or -ve FDT_ERR_... on failure + * Return: 0 if ok, or -ve FDT_ERR_... on failure */ int arch_fixup_fdt(void *blob); @@ -37,7 +37,7 @@ u32 fdt_getprop_u32_default(const void *fdt, const char *path, * See doc/device-tree-bindings/root.txt * * @param fdt FDT address in memory - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_root(void *fdt); @@ -47,7 +47,7 @@ int fdt_root(void *fdt); * In particular, this adds the kernel command line (bootargs) to the FDT. * * @param fdt FDT address in memory - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_chosen(void *fdt); @@ -55,7 +55,7 @@ int fdt_chosen(void *fdt); * Add initrd information to the FDT before booting the OS. * * @param fdt FDT address in memory - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end); @@ -89,7 +89,7 @@ void do_fixup_by_compat_u32(void *fdt, const char *compat, * @param blob FDT blob to update * @param start Begin of DRAM mapping in physical memory * @param size Size of the single memory bank - * @return 0 if ok, or -1 or -FDT_ERR_... on error + * Return: 0 if ok, or -1 or -FDT_ERR_... on error */ int fdt_fixup_memory(void *blob, u64 start, u64 size); @@ -105,7 +105,7 @@ int fdt_fixup_memory(void *blob, u64 start, u64 size); * @param size Array of size to hold the size of each region. * @param banks Number of memory banks to create. If 0, the reg * property will be left untouched. - * @return 0 if ok, or -1 or -FDT_ERR_... on error + * Return: 0 if ok, or -1 or -FDT_ERR_... on error */ #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks); @@ -132,7 +132,7 @@ void fdt_fixup_qe_firmware(void *fdt); * @param blob FDT blob to update * @param path path within dt * @param display name of display timing to match - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_fixup_display(void *blob, const char *path, const char *display); @@ -161,7 +161,7 @@ static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {} * @param type type (if specified, otherwise pass NULL) * @param os os-type (if specified, otherwise pass NULL) * @param arch architecture (if specified, otherwise pass NULL) - * @return 0 if ok, or -1 or -FDT_ERR_... on error + * Return: 0 if ok, or -1 or -FDT_ERR_... on error */ int fdt_record_loadable(void *blob, u32 index, const char *name, uintptr_t load_addr, u32 size, uintptr_t entry_point, @@ -182,7 +182,7 @@ int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name); * * @param blob FDT blob to update * @param bd Pointer to board data - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int ft_board_setup(void *blob, struct bd_info *bd); @@ -212,7 +212,7 @@ void ft_board_setup_ex(void *blob, struct bd_info *bd); * * @param blob FDT blob to update * @param bd Pointer to board data - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int ft_system_setup(void *blob, struct bd_info *bd); @@ -223,7 +223,7 @@ void set_working_fdt_addr(ulong addr); * * @param blob FDT blob to update * @param extrasize additional bytes needed - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_shrink_to_minimum(void *blob, uint extrasize); int fdt_increase_size(void *fdt, int add_len); @@ -254,7 +254,7 @@ void fdt_del_node_and_alias(void *blob, const char *alias); * @param blob Pointer to device tree blob * @param node_offset Node DT offset * @param in_addr Pointer to the address to translate - * @return translated address or OF_BAD_ADDR on error + * Return: translated address or OF_BAD_ADDR on error */ u64 fdt_translate_address(const void *blob, int node_offset, const __be32 *in_addr); @@ -266,7 +266,7 @@ u64 fdt_translate_address(const void *blob, int node_offset, * @param blob Pointer to device tree blob * @param node_offset Node DT offset * @param in_addr Pointer to the DMA address to translate - * @return translated DMA address or OF_BAD_ADDR on error + * Return: translated DMA address or OF_BAD_ADDR on error */ u64 fdt_translate_dma_address(const void *blob, int node_offset, const __be32 *in_addr); @@ -280,7 +280,7 @@ u64 fdt_translate_dma_address(const void *blob, int node_offset, * @param cpu Pointer to variable storing the range's cpu address * @param bus Pointer to variable storing the range's bus address * @param size Pointer to variable storing the range's size - * @return translated DMA address or OF_BAD_ADDR on error + * Return: translated DMA address or OF_BAD_ADDR on error */ int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu, dma_addr_t *bus, u64 *size); @@ -403,7 +403,7 @@ int fdtdec_get_int(const void *blob, int node, const char *prop_name, * * @param blob FDT blob * @param node parent node - * @return number of child node; 0 if there is not child node + * Return: number of child node; 0 if there is not child node */ int fdtdec_get_child_count(const void *blob, int node); #endif diff --git a/include/fdtdec.h b/include/fdtdec.h index 15f2d2b..9a7b6a7 100644 --- a/include/fdtdec.h +++ b/include/fdtdec.h @@ -148,7 +148,7 @@ static inline u8 *dtb_dt_embedded(void) * Compute the size of a resource. * * @param res the resource to operate on - * @return the size of the resource + * Return: the size of the resource */ static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res) { @@ -241,7 +241,7 @@ struct fdtdec_phandle_args { * @cells_count: Cell count to use if @cells_name is NULL * @index: index of a phandle to parse out * @out_args: optional pointer to output arguments structure (will be filled) - * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if + * Return: 0 on success (with @out_args filled out if not NULL), -ENOENT if * @list_name does not exist, a phandle was not found, @cells_name * could not be found, the arguments were truncated or there were too * many arguments. @@ -268,7 +268,7 @@ int fdtdec_parse_phandle_with_args(const void *blob, int src_node, * @param blob FDT blob to use * @param name Root name of alias to search for * @param id Compatible ID to look for - * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more + * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more */ int fdtdec_next_alias(const void *blob, const char *name, enum fdt_compat_id id, int *upto); @@ -282,7 +282,7 @@ int fdtdec_next_alias(const void *blob, const char *name, * * @param blob FDT blob to use * @param node Node containing compatible string to find - * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match + * Return: compatible ID, or COMPAT_UNKNOWN if we cannot find a match */ enum fdt_compat_id fdtdec_lookup(const void *blob, int node); @@ -296,7 +296,7 @@ enum fdt_compat_id fdtdec_lookup(const void *blob, int node); * @param blob FDT blob to use * @param node Start node for search * @param id Compatible ID to look for (enum fdt_compat_id) - * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more + * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more */ int fdtdec_next_compatible(const void *blob, int node, enum fdt_compat_id id); @@ -313,7 +313,7 @@ int fdtdec_next_compatible(const void *blob, int node, * @param node Start node for search * @param id Compatible ID to look for (enum fdt_compat_id) * @param depthp Current depth (set to 0 before first call) - * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more + * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more */ int fdtdec_next_compatible_subnode(const void *blob, int node, enum fdt_compat_id id, int *depthp); @@ -339,7 +339,7 @@ int fdtdec_next_compatible_subnode(const void *blob, int node, * @param sizep a pointer to store the size into. Use NULL if not required * @param translate Indicates whether to translate the returned value * using the parent node's ranges property. - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node, const char *prop_name, int index, int na, int ns, @@ -361,7 +361,7 @@ fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node, * @param sizep a pointer to store the size into. Use NULL if not required * @param translate Indicates whether to translate the returned value * using the parent node's ranges property. - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent, int node, const char *prop_name, int index, fdt_size_t *sizep, @@ -387,7 +387,7 @@ fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent, * @param sizep a pointer to store the size into. Use NULL if not required * @param translate Indicates whether to translate the returned value * using the parent node's ranges property. - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node, const char *prop_name, int index, fdt_size_t *sizep, @@ -414,7 +414,7 @@ fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node, * @param blob FDT blob * @param node node to examine * @param prop_name name of property to find - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr(const void *blob, int node, const char *prop_name); @@ -442,7 +442,7 @@ fdt_addr_t fdtdec_get_addr(const void *blob, int node, * @param node node to examine * @param prop_name name of property to find * @param sizep a pointer to store the size into. Use NULL if not required - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, const char *prop_name, fdt_size_t *sizep); @@ -455,7 +455,7 @@ fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, * @param node node to examine * @param vendor vendor id of the pci device * @param device device id of the pci device - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device); @@ -467,7 +467,7 @@ int fdtdec_get_pci_vendev(const void *blob, int node, * @param dev device to examine * @param addr pci address in the form of fdt_pci_addr * @param bar returns base address of the pci device's registers - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr, u32 *bar); @@ -479,7 +479,7 @@ int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr, * @param blob FDT blob * @param node node to examine * @param res the resource structure to return the bus range - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdtdec_get_pci_bus_range(const void *blob, int node, @@ -494,7 +494,7 @@ int fdtdec_get_pci_bus_range(const void *blob, int node, * @param node node to examine * @param prop_name name of property to find * @param default_val default value to return if the property is not found - * @return integer value, if found, or default_val if not + * Return: integer value, if found, or default_val if not */ s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, s32 default_val); @@ -507,7 +507,7 @@ s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, * @param node node to examine * @param prop_name name of property to find * @param default_val default value to return if the property is not found - * @return unsigned integer value, if found, or default_val if not + * Return: unsigned integer value, if found, or default_val if not */ unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name, unsigned int default_val); @@ -519,7 +519,7 @@ unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name, * * @param ptr Pointer to property * @param cells Number of cells containing the number - * @return the value in the cells + * Return: the value in the cells */ u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells); @@ -533,7 +533,7 @@ u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells); * @param node node to examine * @param prop_name name of property to find * @param default_val default value to return if the property is not found - * @return integer value, if found, or default_val if not + * Return: integer value, if found, or default_val if not */ uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, uint64_t default_val); @@ -547,7 +547,7 @@ uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, * * @param blob FDT blob * @param node node to examine - * @return integer value 0 (not enabled) or 1 (enabled) + * Return: integer value 0 (not enabled) or 1 (enabled) */ int fdtdec_get_is_enabled(const void *blob, int node); @@ -556,7 +556,7 @@ int fdtdec_get_is_enabled(const void *blob, int node); * * If not, a message is printed to the console if the console is ready. * - * @return 0 if all ok, -1 if not + * Return: 0 if all ok, -1 if not */ int fdtdec_prepare_fdt(void); @@ -604,7 +604,7 @@ int fdtdec_check_fdt(void); * @param id Compatible ID to look for * @param node_list Place to put list of found nodes * @param maxcount Maximum number of nodes to find - * @return number of nodes found on success, FDT_ERR_... on error + * Return: number of nodes found on success, FDT_ERR_... on error */ int fdtdec_find_aliases_for_id(const void *blob, const char *name, enum fdt_compat_id id, int *node_list, int maxcount); @@ -645,7 +645,7 @@ int fdtdec_add_aliases_for_id(const void *blob, const char *name, * @param node Node to look up * @param seqp This is set to the sequence number if one is found, * but otherwise the value is left alone - * @return 0 if a sequence was found, -ve if not + * Return: 0 if a sequence was found, -ve if not */ int fdtdec_get_alias_seq(const void *blob, const char *base, int node, int *seqp); @@ -659,7 +659,7 @@ int fdtdec_get_alias_seq(const void *blob, const char *base, int node, * @param blob Device tree blob (if NULL, then error is returned) * @param base Base name for alias susbystem (before the number) * - * @return 0 highest alias ID, -1 if not found + * Return: 0 highest alias ID, -1 if not found */ int fdtdec_get_alias_highest_id(const void *blob, const char *base); @@ -668,7 +668,7 @@ int fdtdec_get_alias_highest_id(const void *blob, const char *base); * * @param blob Device tree blob (if NULL, then NULL is returned) * @param name Property name to look up - * @return Value of property, or NULL if it does not exist + * Return: Value of property, or NULL if it does not exist */ const char *fdtdec_get_chosen_prop(const void *blob, const char *name); @@ -680,7 +680,7 @@ const char *fdtdec_get_chosen_prop(const void *blob, const char *name); * * @param blob Device tree blob (if NULL, then error is returned) * @param name Property name, e.g. "stdout-path" - * @return Node offset referred to by that chosen node, or -ve FDT_ERR_... + * Return: Node offset referred to by that chosen node, or -ve FDT_ERR_... */ int fdtdec_get_chosen_node(const void *blob, const char *name); @@ -688,7 +688,7 @@ int fdtdec_get_chosen_node(const void *blob, const char *name); * Get the name for a compatible ID * * @param id Compatible ID to look for - * @return compatible string for that id + * Return: compatible string for that id */ const char *fdtdec_get_compatible(enum fdt_compat_id id); @@ -698,7 +698,7 @@ const char *fdtdec_get_compatible(enum fdt_compat_id id); * @param blob FDT blob * @param node node to examine * @param prop_name name of property to find - * @return node offset if found, -ve error code on error + * Return: node offset if found, -ve error code on error */ int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); @@ -712,7 +712,7 @@ int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); * @param prop_name name of property to find * @param array array to fill with data * @param count number of array elements - * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, + * Return: 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, * or -FDT_ERR_BADLAYOUT if not enough data */ int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, @@ -728,7 +728,7 @@ int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, * @param prop_name name of property to find * @param array array to fill with data * @param count number of array elements - * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the + * Return: number of array elements if ok, or -FDT_ERR_NOTFOUND if the * property is not found */ int fdtdec_get_int_array_count(const void *blob, int node, @@ -747,7 +747,7 @@ int fdtdec_get_int_array_count(const void *blob, int node, * @param node node to examine * @param prop_name name of property to find * @param count number of array elements - * @return pointer to array if found, or NULL if the property is not + * Return: pointer to array if found, or NULL if the property is not * found or there is not enough data */ const u32 *fdtdec_locate_array(const void *blob, int node, @@ -762,7 +762,7 @@ const u32 *fdtdec_locate_array(const void *blob, int node, * @param blob FDT blob * @param node node to examine * @param prop_name name of property to find - * @return 1 if the properly is present; 0 if it isn't present + * Return: 1 if the properly is present; 0 if it isn't present */ int fdtdec_get_bool(const void *blob, int node, const char *prop_name); @@ -771,7 +771,7 @@ int fdtdec_get_bool(const void *blob, int node, const char *prop_name); * * @param blob FDT blob * @param node parent node - * @return number of child node; 0 if there is not child node + * Return: number of child node; 0 if there is not child node */ int fdtdec_get_child_count(const void *blob, int node); @@ -785,7 +785,7 @@ int fdtdec_get_child_count(const void *blob, int node); * @param prop_name name of property to find * @param array array to fill with data * @param count number of array elements - * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found, + * Return: 0 if ok, or -FDT_ERR_MISSING if the property is not found, * or -FDT_ERR_BADLAYOUT if not enough data */ int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, @@ -801,7 +801,7 @@ int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, * @param node node to examine * @param prop_name name of property to find * @param count number of array elements - * @return pointer to byte array if found, or NULL if the property is not + * Return: pointer to byte array if found, or NULL if the property is not * found or there is not enough data */ const u8 *fdtdec_locate_byte_array(const void *blob, int node, @@ -815,7 +815,7 @@ const u8 *fdtdec_locate_byte_array(const void *blob, int node, * @param property name of the property to parse * @param index index of the resource to retrieve * @param res returns the resource - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdt_get_resource(const void *fdt, int node, const char *property, unsigned int index, struct fdt_resource *res); @@ -911,7 +911,7 @@ struct display_timing { * @param node 'display-timing' node containing the timing subnodes * @param index Index number to read (0=first timing subnode) * @param config Place to put timings - * @return 0 if OK, -FDT_ERR_NOTFOUND if not found + * Return: 0 if OK, -FDT_ERR_NOTFOUND if not found */ int fdtdec_decode_display_timing(const void *blob, int node, int index, struct display_timing *config); @@ -929,7 +929,7 @@ int fdtdec_decode_display_timing(const void *blob, int node, int index, * address instead of hard coding the value in the case where the memory size * and start address cannot be detected automatically. * - * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or + * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or * invalid */ int fdtdec_setup_mem_size_base(void); @@ -946,7 +946,7 @@ int fdtdec_setup_mem_size_base(void); * address instead of hard coding the value in the case where the memory size * and start address cannot be detected automatically. * - * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or + * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or * invalid */ int fdtdec_setup_mem_size_base_lowest(void); @@ -963,7 +963,7 @@ int fdtdec_setup_mem_size_base_lowest(void); * information instead of hard coding the information in cases where it cannot * be detected automatically. * - * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or + * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or * invalid */ int fdtdec_setup_memory_banksize(void); @@ -988,7 +988,7 @@ int fdtdec_setup_memory_banksize(void); * @param fdt FDT blob * @param mac buffer containing the MAC address to set * @param size size of MAC address - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size); @@ -999,7 +999,7 @@ int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size); * @param node offset in the FDT blob of the node whose phandle is to * be set * @param phandle phandle to set for the given node - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ static inline int fdtdec_set_phandle(void *blob, int node, uint32_t phandle) { @@ -1058,7 +1058,7 @@ static inline int fdtdec_set_phandle(void *blob, int node, uint32_t phandle) * @param phandlep return location for the phandle of the carveout region * can be NULL if no phandle should be added * @param flags bitmask of flags to set for the carveout region - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_add_reserved_memory(void *blob, const char *basename, const struct fdt_memory *carveout, @@ -1082,7 +1082,7 @@ int fdtdec_add_reserved_memory(void *blob, const char *basename, * @param compatiblesp return location for compatible strings * @param countp return location for the number of compatible strings * @param flags return location for the flags of the carveout - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_get_carveout(const void *blob, const char *node, const char *prop_name, unsigned int index, @@ -1149,7 +1149,7 @@ int fdtdec_get_carveout(const void *blob, const char *node, * @param compatibles compatible strings to set for the carveout * @param count number of compatible strings * @param flags bitmask of flags to set for the carveout - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_set_carveout(void *blob, const char *node, const char *prop_name, unsigned int index, const struct fdt_memory *carveout, @@ -1182,7 +1182,7 @@ int fdtdec_board_setup(const void *fdt_blob); * @param rescan Returns a flag indicating that fdt has changed and rescanning * the fdt is required * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fdtdec_resetup(int *rescan); #endif @@ -1228,7 +1228,7 @@ void *board_fdt_blob_setup(int *err); * ignore) * @param sizep Returns total memory size (NULL to ignore) * @param bd Updated with the memory bank information (NULL to skip) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id, phys_addr_t *basep, phys_size_t *sizep, @@ -1237,7 +1237,7 @@ int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id, /** * fdtdec_get_srcname() - Get the name of where the devicetree comes from * - * @return source name + * Return: source name */ const char *fdtdec_get_srcname(void); diff --git a/include/fs.h b/include/fs.h index 1c79e29..c8df388 100644 --- a/include/fs.h +++ b/include/fs.h @@ -27,7 +27,7 @@ struct blk_desc; * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -39,7 +39,7 @@ int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc, * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_ext2load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -118,7 +118,7 @@ int fs_exists(const char *filename); * * @filename: Name of the file * @size: Size of file - * @return 0 if ok with valid *size, negative on error + * Return: 0 if ok with valid *size, negative on error */ int fs_size(const char *filename, loff_t *size); @@ -195,7 +195,7 @@ struct fs_dir_stream { * fs_opendir - Open a directory * * @filename: the path to directory to open - * @return a pointer to the directory stream or NULL on error and errno + * Return: a pointer to the directory stream or NULL on error and errno * set appropriately */ struct fs_dir_stream *fs_opendir(const char *filename); @@ -209,7 +209,7 @@ struct fs_dir_stream *fs_opendir(const char *filename); * longer valid. * * @dirs: the directory stream - * @return the next directory entry (only valid until next fs_readdir() or + * Return: the next directory entry (only valid until next fs_readdir() or * fs_closedir() call, do not attempt to free()) or NULL if the end of * the directory is reached. */ @@ -228,7 +228,7 @@ void fs_closedir(struct fs_dir_stream *dirs); * If a given name is a directory, it will be deleted only if it's empty * * @filename: Name of file or directory to delete - * @return 0 on success, -1 on error conditions + * Return: 0 on success, -1 on error conditions */ int fs_unlink(const char *filename); @@ -236,7 +236,7 @@ int fs_unlink(const char *filename); * fs_mkdir - Create a directory * * @filename: Name of directory to create - * @return 0 on success, -1 on error conditions + * Return: 0 on success, -1 on error conditions */ int fs_mkdir(const char *filename); @@ -281,7 +281,7 @@ int do_fs_type(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_fs_types(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[]); diff --git a/include/fsl_ddr_sdram.h b/include/fsl_ddr_sdram.h index 56c9db2..a7272e4 100644 --- a/include/fsl_ddr_sdram.h +++ b/include/fsl_ddr_sdram.h @@ -483,7 +483,7 @@ typedef struct fixed_ddr_parm{ /** * fsl_initdram() - Set up the SDRAM * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsl_initdram(void); diff --git a/include/generic-phy.h b/include/generic-phy.h index 9a11659..ff48b37 100644 --- a/include/generic-phy.h +++ b/include/generic-phy.h @@ -79,7 +79,7 @@ struct phy_ops { * If power_off() is not implemented, it must power down the phy. * * @phy: PHY port to be de-initialized - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*exit)(struct phy *phy); @@ -91,7 +91,7 @@ struct phy_ops { * During runtime, the PHY may need to be reset in order to * re-establish connection etc without being shut down or exit. * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*reset)(struct phy *phy); @@ -105,7 +105,7 @@ struct phy_ops { * setup done in init(). If init() is not implemented, it must take care * of setting up the context (PLLs, ...) * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*power_on)(struct phy *phy); @@ -119,7 +119,7 @@ struct phy_ops { * init()/deinit() are not implemented, it must not de-initialize * everything. * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*power_off)(struct phy *phy); @@ -133,7 +133,7 @@ struct phy_ops { * This function configures the PHY for it's main function following * power_on/off() after beeing initialized. * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*configure)(struct phy *phy, void *params); }; @@ -161,7 +161,7 @@ struct phy_bulk { * generic_phy_init() - initialize the PHY port * * @phy: the PHY port to initialize - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_init(struct phy *phy); @@ -169,7 +169,7 @@ int generic_phy_init(struct phy *phy); * generic_phy_init() - de-initialize the PHY device * * @phy: PHY port to be de-initialized - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_exit(struct phy *phy); @@ -177,7 +177,7 @@ int generic_phy_exit(struct phy *phy); * generic_phy_reset() - resets a PHY device without shutting down * * @phy: PHY port to be reset - *@return 0 if OK, or a negative error code + *Return: 0 if OK, or a negative error code */ int generic_phy_reset(struct phy *phy); @@ -185,7 +185,7 @@ int generic_phy_reset(struct phy *phy); * generic_phy_power_on() - power on a PHY device * * @phy: PHY port to be powered on - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_power_on(struct phy *phy); @@ -193,7 +193,7 @@ int generic_phy_power_on(struct phy *phy); * generic_phy_power_off() - power off a PHY device * * @phy: PHY port to be powered off - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_power_off(struct phy *phy); @@ -202,7 +202,7 @@ int generic_phy_power_off(struct phy *phy); * * @phy: PHY port to be configured * @params: PHY Parameters, underlying data is specific to the PHY function - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_configure(struct phy *phy, void *params); @@ -230,7 +230,7 @@ int generic_phy_configure(struct phy *phy, void *params); * the USB2 phy can be accessed by passing index '0' and the USB3 phy can * be accessed by passing index '1' * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_get_by_index(struct udevice *user, int index, struct phy *phy); @@ -261,7 +261,7 @@ int generic_phy_get_by_index(struct udevice *user, int index, * the USB2 phy can be accessed by passing index '0' and the USB3 phy can * be accessed by passing index '1' * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_get_by_index_nodev(ofnode node, int index, struct phy *phy); @@ -288,7 +288,7 @@ int generic_phy_get_by_index_nodev(ofnode node, int index, struct phy *phy); * }; * the USB3 phy can be accessed using "usb3phy", and USB2 by using "usb2phy" * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_get_by_name(struct udevice *user, const char *phy_name, struct phy *phy); @@ -302,7 +302,7 @@ int generic_phy_get_by_name(struct udevice *user, const char *phy_name, * * @dev: The consumer device. * @bulk A pointer to a phy bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk); @@ -311,7 +311,7 @@ int generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_init_bulk(struct phy_bulk *bulk); @@ -320,7 +320,7 @@ int generic_phy_init_bulk(struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_exit_bulk(struct phy_bulk *bulk); @@ -329,7 +329,7 @@ int generic_phy_exit_bulk(struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_power_on_bulk(struct phy_bulk *bulk); @@ -338,7 +338,7 @@ int generic_phy_power_on_bulk(struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_power_off_bulk(struct phy_bulk *bulk); @@ -413,7 +413,7 @@ static inline int generic_phy_power_off_bulk(struct phy_bulk *bulk) * generic_phy_valid() - check if PHY port is valid * * @phy: the PHY port to check - * @return TRUE if valid, or FALSE + * Return: TRUE if valid, or FALSE */ static inline bool generic_phy_valid(struct phy *phy) { diff --git a/include/gzip.h b/include/gzip.h index cb4db3d..e578b28 100644 --- a/include/gzip.h +++ b/include/gzip.h @@ -16,7 +16,7 @@ struct blk_desc; * * @src: Pointer to gzip file * @len: Length of data - * @return length of header in bytes, or -1 if not enough data + * Return: length of header in bytes, or -1 if not enough data */ int gzip_parse_header(const unsigned char *src, unsigned long len); @@ -27,7 +27,7 @@ int gzip_parse_header(const unsigned char *src, unsigned long len); * @dstlen: Size of destination buffer * @src: Source data to decompress * @lenp: Returns length of uncompressed data - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp); @@ -40,7 +40,7 @@ int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp); * @lenp: On entry, length data at @src. On exit, number of bytes used from @src * @stoponerr: 0 to continue when a decode error is found, 1 to stop * @offset: start offset within the src buffer - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp, int stoponerr, int offset); @@ -71,7 +71,7 @@ void gzwrite_progress_finish(int retcode, ulong totalwritten, ulong totalsize, * @startoffs: offset in bytes of first write * @szexpected: expected uncompressed length, may be zero to use gzip trailer * for files under 4GiB - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf, ulong startoffs, ulong szexpected); @@ -84,7 +84,7 @@ int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf, * number of bytes used in the buffer * @src: Source data to compress * @srclen: Size of source data - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int gzip(void *dst, unsigned long *lenp, unsigned char *src, ulong srclen); diff --git a/include/handoff.h b/include/handoff.h index 070a79c..0104b83 100644 --- a/include/handoff.h +++ b/include/handoff.h @@ -38,7 +38,7 @@ void handoff_load_dram_banks(struct spl_handoff *ho); * write_spl_handoff(). * * @ho: Handoff area to fill in - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int handoff_arch_save(struct spl_handoff *ho); diff --git a/include/hash.h b/include/hash.h index cfafbe7..8b3f79e 100644 --- a/include/hash.h +++ b/include/hash.h @@ -114,7 +114,7 @@ int hash_command(const char *algo_name, int flags, struct cmd_tbl *cmdtp, * If NULL, then it is assumed that the caller has * allocated enough space for the hash. This is possible * since the caller is selecting the algorithm. - * @return 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm, + * Return: 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm, * -ENOSPC if the output buffer is not large enough. */ int hash_block(const char *algo_name, const void *data, unsigned int len, @@ -131,7 +131,7 @@ int hash_block(const char *algo_name, const void *data, unsigned int len, * @algo_name: Hash algorithm to look up * @algop: Pointer to the hash_algo struct if found * - * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. + * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. */ int hash_lookup_algo(const char *algo_name, struct hash_algo **algop); @@ -144,7 +144,7 @@ int hash_lookup_algo(const char *algo_name, struct hash_algo **algop); * @algo_name: Hash algorithm to look up * @algop: Pointer to the hash_algo struct if found * - * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. + * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. */ int hash_progressive_lookup_algo(const char *algo_name, struct hash_algo **algop); @@ -159,7 +159,7 @@ int hash_progressive_lookup_algo(const char *algo_name, * @str: Hash string to get parsed * @result: Binary array of the parsed hash string * - * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. + * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. */ int hash_parse_string(const char *algo_name, const char *str, uint8_t *result); diff --git a/include/hda_codec.h b/include/hda_codec.h index 56de571..247eafe 100644 --- a/include/hda_codec.h +++ b/include/hda_codec.h @@ -27,7 +27,7 @@ struct hda_codec_priv { * hda_wait_for_ready() - Wait for the codec to indicate it is ready * * @regs: HDA registers - * @return 0 if OK -ETIMEDOUT if codec did not respond in time + * Return: 0 if OK -ETIMEDOUT if codec did not respond in time */ int hda_wait_for_ready(struct hda_regs *regs); @@ -35,7 +35,7 @@ int hda_wait_for_ready(struct hda_regs *regs); * hda_wait_for_valid() - Wait for the codec to accept the last command * * @regs: HDA registers - * @return 0 if OK -ETIMEDOUT if codec did not respond in time + * Return: 0 if OK -ETIMEDOUT if codec did not respond in time */ int hda_wait_for_valid(struct hda_regs *regs); @@ -43,8 +43,8 @@ int hda_wait_for_valid(struct hda_regs *regs); * hda_codec_detect() - Detect which codecs are present * * @regs: HDA registers - * @return bit mask of active codecs (0 if none) - * @return 0 if OK, -ve on error + * Return: bit mask of active codecs (0 if none) + * Return: 0 if OK, -ve on error */ int hda_codec_detect(struct hda_regs *regs); @@ -54,7 +54,7 @@ int hda_codec_detect(struct hda_regs *regs); * @dev: Sound device * @regs: HDA registers * @codec_mask: Mask of codecs to init (bits 3:0) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask); @@ -66,7 +66,7 @@ int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask); * * @dev: Sound device * @frequency_hz: Beep frequency in hertz - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int hda_codec_start_beep(struct udevice *dev, int frequency_hz); @@ -76,7 +76,7 @@ int hda_codec_start_beep(struct udevice *dev, int frequency_hz); * This tells the sound hardware to stop a previously started beep. * * @dev: Sound device - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int hda_codec_stop_beep(struct udevice *dev); @@ -86,7 +86,7 @@ int hda_codec_stop_beep(struct udevice *dev); * This should be called at the start of the probe() method. * * @dev: Sound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int hda_codec_init(struct udevice *dev); @@ -96,7 +96,7 @@ int hda_codec_init(struct udevice *dev); * This should be called at the end of the probe() method. * * @dev: Sound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int hda_codec_finish_init(struct udevice *dev); diff --git a/include/hw_sha.h b/include/hw_sha.h index d4f3471..b9bb583 100644 --- a/include/hw_sha.h +++ b/include/hw_sha.h @@ -65,7 +65,7 @@ void hw_sha1(const uchar *in_addr, uint buflen, uchar *out_addr, * * @algo: Pointer to the hash_algo struct * @ctxp: Pointer to the pointer of the context for hashing - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_init(struct hash_algo *algo, void **ctxp); @@ -79,7 +79,7 @@ int hw_sha_init(struct hash_algo *algo, void **ctxp); * @buf: Pointer to the buffer being hashed * @size: Size of the buffer being hashed * @is_last: 1 if this is the last update; 0 otherwise - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf, unsigned int size, int is_last); @@ -93,7 +93,7 @@ int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf, * @ctx: Pointer to the context for hashing * @dest_buf: Pointer to the destination buffer where hash is to be copied * @size: Size of the buffer being hashed - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_finish(struct hash_algo *algo, void *ctx, void *dest_buf, int size); diff --git a/include/hwspinlock.h b/include/hwspinlock.h index 99389c1..d8556c0 100644 --- a/include/hwspinlock.h +++ b/include/hwspinlock.h @@ -39,7 +39,7 @@ struct hwspinlock { * @index: The index of the hardware spinlock to request, within the * client's list of hardware spinlock. * @hws: A pointer to a hardware spinlock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int hwspinlock_get_by_index(struct udevice *dev, int index, struct hwspinlock *hws); diff --git a/include/i2c.h b/include/i2c.h index a35e99b..22add0b 100644 --- a/include/i2c.h +++ b/include/i2c.h @@ -184,7 +184,7 @@ struct i2c_msg_list { * @buffer: Place to put data * @len: Number of bytes to read * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); @@ -198,7 +198,7 @@ int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); * @buffer: Buffer containing data to write * @len: Number of bytes to write * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, int len); @@ -214,7 +214,7 @@ int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, * @chip_addr: 7-bit address to probe (10-bit and others are not supported) * @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags) * @devp: Returns the device found, or NULL if none - * @return 0 if a chip was found at that address, -ve if not + * Return: 0 if a chip was found at that address, -ve if not */ int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, struct udevice **devp); @@ -226,7 +226,7 @@ int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, * * @dev: Device to use for transfer * @addr: Address to read from - * @return value read, or -ve on error + * Return: value read, or -ve on error */ int dm_i2c_reg_read(struct udevice *dev, uint offset); @@ -238,7 +238,7 @@ int dm_i2c_reg_read(struct udevice *dev, uint offset); * @dev: Device to use for transfer * @addr: Address to write to * @val: Value to write (normally a byte) - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); @@ -252,7 +252,7 @@ int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); * @offset: Address for the R/W operation * @clr: Bitmask of bits that should be cleared * @set: Bitmask of bits that should be set - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set); @@ -265,7 +265,7 @@ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set); * @dev: Device to use for transfer * @msg: List of messages to transfer * @nmsgs: Number of messages to transfer - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); @@ -274,7 +274,7 @@ int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); * * @bus: Bus to adjust * @speed: Requested speed in Hz - * @return 0 if OK, -EINVAL for invalid values + * Return: 0 if OK, -EINVAL for invalid values */ int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); @@ -282,7 +282,7 @@ int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); * dm_i2c_get_bus_speed() - get the speed of a bus * * @bus: Bus to check - * @return speed of selected I2C bus in Hz, -ve on error + * Return: speed of selected I2C bus in Hz, -ve on error */ int dm_i2c_get_bus_speed(struct udevice *bus); @@ -294,7 +294,7 @@ int dm_i2c_get_bus_speed(struct udevice *bus); * * @dev: Chip to adjust * @flags: New flags - * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error + * Return: 0 if OK, -EINVAL if value is unsupported, other -ve value on error */ int i2c_set_chip_flags(struct udevice *dev, uint flags); @@ -303,7 +303,7 @@ int i2c_set_chip_flags(struct udevice *dev, uint flags); * * @dev: Chip to check * @flagsp: Place to put flags - * @return 0 if OK, other -ve value on error + * Return: 0 if OK, other -ve value on error */ int i2c_get_chip_flags(struct udevice *dev, uint *flagsp); @@ -334,14 +334,14 @@ int i2c_get_chip_offset_len(struct udevice *dev); * function to set the bits that are valid to be used for offset overflow. * * @mask: The mask to be used for high offset bits within address - * @return 0 if OK, other -ve value on error + * Return: 0 if OK, other -ve value on error */ int i2c_set_chip_addr_offset_mask(struct udevice *dev, uint mask); /* * i2c_get_chip_addr_offset_mask() - get mask of address bits usable by offset * - * @return current chip addr offset mask + * Return: current chip addr offset mask */ uint i2c_get_chip_addr_offset_mask(struct udevice *dev); @@ -351,7 +351,7 @@ uint i2c_get_chip_addr_offset_mask(struct udevice *dev); * See the deblock() method in 'struct dm_i2c_ops' for full information * * @bus: Bus to recover - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int i2c_deblock(struct udevice *bus); @@ -366,7 +366,7 @@ int i2c_deblock(struct udevice *bus); * @scl_count: Number of SCL clock cycles generated to deblock SDA * @start_count:Number of I2C start conditions sent after deblocking SDA * @delay: Delay between SCL clock line changes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ struct gpio_desc; int i2c_deblock_gpio_loop(struct gpio_desc *sda_pin, struct gpio_desc *scl_pin, @@ -567,7 +567,7 @@ void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs); * * @dev: Device to find an emulator for * @emulp: Returns the associated emulator, if found * - * @return 0 if OK, -ENOENT or -ENODEV if not found + * Return: 0 if OK, -ENOENT or -ENODEV if not found */ int i2c_emul_find(struct udevice *dev, struct udevice **emulp); @@ -589,7 +589,7 @@ void i2c_emul_set_idx(struct udevice *dev, int emul_idx); * Given an emulator this returns the associated device * * @emul: Emulator for the device - * @return device that @emul is emulating + * Return: device that @emul is emulating */ struct udevice *i2c_emul_get_device(struct udevice *emul); @@ -606,7 +606,7 @@ extern struct acpi_ops i2c_acpi_ops; * properties. * * @dev: I2C device to process - * @return 0 if OK, -EINVAL if acpi,hid is not present + * Return: 0 if OK, -EINVAL if acpi,hid is not present */ int acpi_i2c_of_to_plat(struct udevice *dev); @@ -967,7 +967,7 @@ enum { * Get FDT values for i2c bus. * * @param blob Device tree blbo - * @return the number of I2C bus + * Return: the number of I2C bus */ void board_i2c_init(const void *blob); @@ -976,7 +976,7 @@ void board_i2c_init(const void *blob); * * @param blob Device tree blbo * @param node FDT I2C node to find - * @return the number of I2C bus (zero based), or -1 on error + * Return: the number of I2C bus (zero based), or -1 on error */ int i2c_get_bus_num_fdt(int node); @@ -985,7 +985,7 @@ int i2c_get_bus_num_fdt(int node); * * @param blob Device tree blbo * @param node FDT I2C node to find - * @return 0 if port was reset, -1 if not found + * Return: 0 if port was reset, -1 if not found */ int i2c_reset_port_fdt(const void *blob, int node); diff --git a/include/i2c_eeprom.h b/include/i2c_eeprom.h index cd620d5..3ad5656 100644 --- a/include/i2c_eeprom.h +++ b/include/i2c_eeprom.h @@ -28,7 +28,7 @@ struct i2c_eeprom { * @buf: Place to put data * @size: Number of bytes to read * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int i2c_eeprom_read(struct udevice *dev, int offset, uint8_t *buf, int size); @@ -40,7 +40,7 @@ int i2c_eeprom_read(struct udevice *dev, int offset, uint8_t *buf, int size); * @buf: Buffer containing data to write * @size: Number of bytes to write * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int i2c_eeprom_write(struct udevice *dev, int offset, uint8_t *buf, int size); @@ -49,7 +49,7 @@ int i2c_eeprom_write(struct udevice *dev, int offset, uint8_t *buf, int size); * * @dev: Chip to query * - * @return +ve size in bytes on success, -ve on failure + * Return: +ve size in bytes on success, -ve on failure */ int i2c_eeprom_size(struct udevice *dev); diff --git a/include/i2s.h b/include/i2s.h index 7760aab..c9fbeb5 100644 --- a/include/i2s.h +++ b/include/i2s.h @@ -108,7 +108,7 @@ struct i2s_ops { * @dev: I2C device * @data: Data buffer to play * @data_size: Size of data buffer in bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int i2s_tx_data(struct udevice *dev, void *data, uint data_size); @@ -118,7 +118,7 @@ int i2s_tx_data(struct udevice *dev, void *data, uint data_size); * @param pi2s_tx pointer of i2s transmitter parameter structure. * @param data address of the data buffer * @param data_size size of the data (in bytes) - * @return int value 0 for success, -1 in case of error + * Return: int value 0 for success, -1 in case of error */ int i2s_transfer_tx_data(struct i2s_uc_priv *pi2s_tx, void *data, uint data_size); diff --git a/include/ide.h b/include/ide.h index 1b37d67..6073943 100644 --- a/include/ide.h +++ b/include/ide.h @@ -64,7 +64,7 @@ void ide_led(uchar led, uchar status); /** * board_start_ide() - Start up the board IDE interfac * - * @return 0 if ok + * Return: 0 if ok */ int board_start_ide(void); diff --git a/include/image.h b/include/image.h index fd662e7..1cdc70f 100644 --- a/include/image.h +++ b/include/image.h @@ -422,7 +422,7 @@ const char *genimg_get_os_name(uint8_t os); * genimg_get_os_short_name() - get the short name for an OS * * @param os OS (IH_OS_...) - * @return OS short name, or "unknown" if unknown + * Return: OS short name, or "unknown" if unknown */ const char *genimg_get_os_short_name(uint8_t comp); @@ -432,7 +432,7 @@ const char *genimg_get_arch_name(uint8_t arch); * genimg_get_arch_short_name() - get the short name for an architecture * * @param arch Architecture type (IH_ARCH_...) - * @return architecture short name, or "unknown" if unknown + * Return: architecture short name, or "unknown" if unknown */ const char *genimg_get_arch_short_name(uint8_t arch); @@ -442,7 +442,7 @@ const char *genimg_get_type_name(uint8_t type); * genimg_get_type_short_name() - get the short name for an image type * * @param type Image type (IH_TYPE_...) - * @return image short name, or "unknown" if unknown + * Return: image short name, or "unknown" if unknown */ const char *genimg_get_type_short_name(uint8_t type); @@ -452,7 +452,7 @@ const char *genimg_get_comp_name(uint8_t comp); * genimg_get_comp_short_name() - get the short name for a compression method * * @param comp compression method (IH_COMP_...) - * @return compression method short name, or "unknown" if unknown + * Return: compression method short name, or "unknown" if unknown */ const char *genimg_get_comp_short_name(uint8_t comp); @@ -461,7 +461,7 @@ const char *genimg_get_comp_short_name(uint8_t comp); * * @category: Category of item * @id: Item ID - * @return name of item, or "Unknown ..." if unknown + * Return: name of item, or "Unknown ..." if unknown */ const char *genimg_get_cat_name(enum ih_category category, uint id); @@ -470,7 +470,7 @@ const char *genimg_get_cat_name(enum ih_category category, uint id); * * @category: Category of item * @id: Item ID - * @return short name of item, or "Unknown ..." if unknown + * Return: short name of item, or "Unknown ..." if unknown */ const char *genimg_get_cat_short_name(enum ih_category category, uint id); @@ -478,7 +478,7 @@ const char *genimg_get_cat_short_name(enum ih_category category, uint id); * genimg_get_cat_count() - Get the number of items in a category * * @category: Category to check - * @return the number of items in the category (IH_xxx_COUNT) + * Return: the number of items in the category (IH_xxx_COUNT) */ int genimg_get_cat_count(enum ih_category category); @@ -486,7 +486,7 @@ int genimg_get_cat_count(enum ih_category category); * genimg_get_cat_desc() - Get the description of a category * * @category: Category to check - * @return the description of a category, e.g. "architecture". This + * Return: the description of a category, e.g. "architecture". This * effectively converts the enum to a string. */ const char *genimg_get_cat_desc(enum ih_category category); @@ -496,7 +496,7 @@ const char *genimg_get_cat_desc(enum ih_category category); * * @category: Category to check * @id: Item ID - * @return true or false as to whether a category has an item + * Return: true or false as to whether a category has an item */ bool genimg_cat_has_id(enum ih_category category, uint id); @@ -588,7 +588,7 @@ int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, * @param datap Returns address of loaded image * @param lenp Returns length of loaded image * - * @return node offset of base image, or -ve error code on error + * Return: node offset of base image, or -ve error code on error */ int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, const char **fit_unamep, const char **fit_uname_configp, @@ -622,7 +622,7 @@ int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, * @param load_op Decribes what to do with the load address * @param datap Returns address of loaded image * @param lenp Returns length of loaded image - * @return node offset of image, or -ve error code on error + * Return: node offset of image, or -ve error code on error */ int fit_image_load(bootm_headers_t *images, ulong addr, const char **fit_unamep, const char **fit_uname_configp, @@ -637,7 +637,7 @@ int fit_image_load(bootm_headers_t *images, ulong addr, * * @addr: Address of script * @fit_uname: FIT subimage name - * @return result code (enum command_ret_t) + * Return: result code (enum command_ret_t) */ int image_source_script(ulong addr, const char *fit_uname); @@ -827,7 +827,7 @@ static inline int image_check_target_arch(const image_header_t *hdr) * * @buf: Address in U-Boot memory where image is loaded. * @len: Length of the compressed image. - * @return compression type or IH_COMP_NONE if not compressed. + * Return: compression type or IH_COMP_NONE if not compressed. * * Note: Only following compression types are supported now. * lzo, lzma, gzip, bzip2 @@ -845,7 +845,7 @@ int image_decomp_type(const unsigned char *buf, ulong len); * @image_buf: Address to decompress from * @image_len: Number of bytes in @image_buf to decompress * @unc_len: Available space for decompression - * @return 0 if OK, -ve on error (BOOTM_ERR_...) + * Return: 0 if OK, -ve on error (BOOTM_ERR_...) */ int image_decomp(int comp, ulong load, ulong image_start, int type, void *load_buf, void *image_buf, ulong image_len, @@ -860,7 +860,7 @@ int image_decomp(int comp, ulong load, ulong image_start, int type, * @blob: FDT to update * @of_size: Size of the FDT * @lmb: Points to logical memory block structure - * @return 0 if ok, <0 on failure + * Return: 0 if ok, <0 on failure */ int image_setup_libfdt(bootm_headers_t *images, void *blob, int of_size, struct lmb *lmb); @@ -872,7 +872,7 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob, * paramters to the FDT if libfdt is available. * * @param images Images information - * @return 0 if ok, <0 on failure + * Return: 0 if ok, <0 on failure */ int image_setup_linux(bootm_headers_t *images); @@ -882,7 +882,7 @@ int image_setup_linux(bootm_headers_t *images); * @image: Address of image * @start: Returns start address of image * @end : Returns end address of image - * @return 0 if OK, 1 if the image was not recognised + * Return: 0 if OK, 1 if the image was not recognised */ int bootz_setup(ulong image, ulong *start, ulong *end); @@ -893,7 +893,7 @@ int bootz_setup(ulong image, ulong *start, ulong *end); * @start: Returns start address of image * @size : Returns size image * @force_reloc: Ignore image->ep field, always place image to RAM start - * @return 0 if OK, 1 if the image was not recognised + * Return: 0 if OK, 1 if the image was not recognised */ int booti_setup(ulong image, ulong *relocated_addr, ulong *size, bool force_reloc); @@ -1068,7 +1068,7 @@ int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); * sure that there are no strange tags or broken nodes in the FIT. * * @fit: pointer to the FIT format image header - * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check + * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check * failed (e.g. due to bad structure), -ENOMSG if the description is * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images * path is missing @@ -1269,7 +1269,7 @@ ll_entry_declare(struct padding_algo, __name, paddings) * image_get_checksum_algo() - Look up a checksum algorithm * * @param full_name Name of algorithm in the form "checksum,crypto" - * @return pointer to algorithm information, or NULL if not found + * Return: pointer to algorithm information, or NULL if not found */ struct checksum_algo *image_get_checksum_algo(const char *full_name); @@ -1277,7 +1277,7 @@ struct checksum_algo *image_get_checksum_algo(const char *full_name); * image_get_crypto_algo() - Look up a cryptosystem algorithm * * @param full_name Name of algorithm in the form "checksum,crypto" - * @return pointer to algorithm information, or NULL if not found + * Return: pointer to algorithm information, or NULL if not found */ struct crypto_algo *image_get_crypto_algo(const char *full_name); @@ -1285,7 +1285,7 @@ struct crypto_algo *image_get_crypto_algo(const char *full_name); * image_get_padding_algo() - Look up a padding algorithm * * @param name Name of padding algorithm - * @return pointer to algorithm information, or NULL if not found + * Return: pointer to algorithm information, or NULL if not found */ struct padding_algo *image_get_padding_algo(const char *name); @@ -1301,7 +1301,7 @@ struct padding_algo *image_get_padding_algo(const char *name); * therefore nothing was checked. The caller may wish * to fall back to other mechanisms, or refuse to * boot. - * @return 0 if all verified ok, <0 on error + * Return: 0 if all verified ok, <0 on error */ int fit_image_verify_required_sigs(const void *fit, int image_noffset, const char *data, size_t size, const void *sig_blob, @@ -1320,7 +1320,7 @@ int fit_image_verify_required_sigs(const void *fit, int image_noffset, * -1 then any signature will do. * @err_msgp: In the event of an error, this will be pointed to a * help error string to display to the user. - * @return 0 if all verified ok, <0 on error + * Return: 0 if all verified ok, <0 on error */ int fit_image_check_sig(const void *fit, int noffset, const void *data, size_t size, int required_keynode, char **err_msgp); @@ -1341,7 +1341,7 @@ int fit_image_decrypt_data(const void *fit, * @fdt_regions: Regions as returned by libfdt * @count: Number of regions returned by libfdt * @region: Place to put list of regions (NULL to allocate it) - * @return pointer to list of regions, or NULL if out of memory + * Return: pointer to list of regions, or NULL if out of memory */ struct image_region *fit_region_make_list(const void *fit, struct fdt_region *fdt_regions, int count, @@ -1440,7 +1440,7 @@ bool android_image_print_dtb_contents(ulong hdr_addr); * in each (FDT) image node. * * @name: Device tree description - * @return 0 if this device tree should be used, non-zero to try the next + * Return: 0 if this device tree should be used, non-zero to try the next */ int board_fit_config_name_match(const char *name); @@ -1457,7 +1457,7 @@ int board_fit_config_name_match(const char *name); * @node: offset of image node * @image: pointer to the image start pointer * @size: pointer to the image size - * @return no return value (failure should be handled internally) + * Return: no return value (failure should be handled internally) */ void board_fit_image_post_process(const void *fit, int node, void **p_image, size_t *p_size); @@ -1476,7 +1476,7 @@ ulong fdt_getprop_u32(const void *fdt, int node, const char *prop); * the node described by the default configuration if it exists. * * @fdt: pointer to flat device tree - * @return the node if found, -ve otherwise + * Return: the node if found, -ve otherwise */ int fit_find_config_node(const void *fdt); diff --git a/include/input.h b/include/input.h index 3285a3f..e99dbb0 100644 --- a/include/input.h +++ b/include/input.h @@ -71,7 +71,7 @@ struct stdio_dev; * @param config Input state * @param keycode List of key codes to examine * @param num_keycodes Number of key codes - * @return number of ascii characters sent, or 0 if none, or -1 for an + * Return: number of ascii characters sent, or 0 if none, or -1 for an * internal error */ int input_send_keycodes(struct input_config *config, int keycode[], int count); @@ -90,7 +90,7 @@ int input_send_keycodes(struct input_config *config, int keycode[], int count); * @param config Input state * @param new_keycode New keycode to add/remove * @param release true if this key was released, false if depressed - * @return number of ascii characters sent, or 0 if none, or -1 for an + * Return: number of ascii characters sent, or 0 if none, or -1 for an * internal error */ int input_add_keycode(struct input_config *config, int new_keycode, @@ -112,7 +112,7 @@ int input_add_table(struct input_config *config, int left_keycode, * Test if keys are available to be read * * @param config Input state - * @return 0 if no keys available, 1 if keys are available + * Return: 0 if no keys available, 1 if keys are available */ int input_tstc(struct input_config *config); @@ -122,7 +122,7 @@ int input_tstc(struct input_config *config); * TODO: U-Boot wants 0 for no key, but Ctrl-@ is a valid key... * * @param config Input state - * @return key, or 0 if no key, or -1 if error + * Return: key, or 0 if no key, or -1 if error */ int input_getc(struct input_config *config); @@ -130,7 +130,7 @@ int input_getc(struct input_config *config); * Register a new device with stdio and switch to it if wanted * * @param dev Pointer to device - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int input_stdio_register(struct stdio_dev *dev); @@ -168,7 +168,7 @@ void input_allow_repeats(struct input_config *config, bool allow_repeats); * updating. * * @param config Input state - * @return -1 if no LEDs need updating, other value if they do + * Return: -1 if no LEDs need updating, other value if they do */ int input_leds_changed(struct input_config *config); @@ -179,7 +179,7 @@ int input_leds_changed(struct input_config *config); * * @param config Input state * @param german true to use German keyboard layout, false for US - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int input_add_tables(struct input_config *config, bool german); @@ -188,7 +188,7 @@ int input_add_tables(struct input_config *config, bool german); * * @param config Input state * @param leds Initial LED value (INPUT_LED_ mask), 0 suggested - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int input_init(struct input_config *config, int leds); diff --git a/include/iotrace.h b/include/iotrace.h index 380da1f..7ff2e83 100644 --- a/include/iotrace.h +++ b/include/iotrace.h @@ -81,7 +81,7 @@ void iotrace_reset_checksum(void); /** * iotrace_get_checksum() - Get the current checksum value * - * @return currect checksum value + * Return: currect checksum value */ u32 iotrace_get_checksum(void); @@ -122,7 +122,7 @@ void iotrace_set_enabled(int enable); /** * iotrace_get_enabled() - Get whether iotracing is enabled or not * - * @return true if enabled, false if disabled + * Return: true if enabled, false if disabled */ int iotrace_get_enabled(void); diff --git a/include/irq.h b/include/irq.h index a0965e4..1d08cb8 100644 --- a/include/irq.h +++ b/include/irq.h @@ -147,7 +147,7 @@ struct irq_ops { * * @irq: IRQ description containing device and ID, e.g. previously * returned by irq_get_by_index() - * @return true if valid, false if not + * Return: true if valid, false if not */ static inline bool irq_is_valid(const struct irq *irq) { @@ -169,7 +169,7 @@ int irq_route_pmc_gpio_gpe(struct udevice *dev, uint pmc_gpe_num); * @dev: IRQ device * @irq: Interrupt number to set * @active_low: true if active low, false for active high - * @return 0 if OK, -EINVAL if @irq is invalid + * Return: 0 if OK, -EINVAL if @irq is invalid */ int irq_set_polarity(struct udevice *dev, uint irq, bool active_low); @@ -177,7 +177,7 @@ int irq_set_polarity(struct udevice *dev, uint irq, bool active_low); * irq_snapshot_polarities() - record IRQ polarities for later restore * * @dev: IRQ device - * @return 0 + * Return: 0 */ int irq_snapshot_polarities(struct udevice *dev); @@ -185,7 +185,7 @@ int irq_snapshot_polarities(struct udevice *dev); * irq_restore_polarities() - restore IRQ polarities * * @dev: IRQ device - * @return 0 + * Return: 0 */ int irq_restore_polarities(struct udevice *dev); @@ -195,7 +195,7 @@ int irq_restore_polarities(struct udevice *dev); * Clears the interrupt if pending * * @dev: IRQ device - * @return 0 if interrupt is not pending, 1 if it was (and so has been + * Return: 0 if interrupt is not pending, 1 if it was (and so has been * cleared), -ve on error */ int irq_read_and_clear(struct irq *irq); @@ -224,7 +224,7 @@ struct phandle_2_arg; * @dev: Device containing the phandle * @cells: Phandle info * @irq: A pointer to a irq struct to initialise - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int irq_get_by_phandle(struct udevice *dev, const struct phandle_2_arg *cells, struct irq *irq); @@ -242,7 +242,7 @@ int irq_get_by_phandle(struct udevice *dev, const struct phandle_2_arg *cells, * @index: The index of the irq to request, within the client's list of * irqs. * @irq: A pointer to a irq struct to initialise. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int irq_get_by_index(struct udevice *dev, int index, struct irq *irq); @@ -258,7 +258,7 @@ int irq_get_by_index(struct udevice *dev, int index, struct irq *irq); * @irq: A pointer to a irq struct to initialise. The caller must * have already initialised any field in this struct which the * irq provider uses to identify the irq. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int irq_request(struct udevice *dev, struct irq *irq); @@ -267,7 +267,7 @@ int irq_request(struct udevice *dev, struct irq *irq); * * @irq: A irq struct that was previously successfully requested by * irq_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int irq_free(struct irq *irq); @@ -278,7 +278,7 @@ int irq_free(struct irq *irq); * * @type: Type to find * @devp: Returns the device, if found - * @return 0 if OK, -ENODEV if not found, other -ve error if uclass failed to + * Return: 0 if OK, -ENODEV if not found, other -ve error if uclass failed to * probe */ int irq_first_device_type(enum irq_dev_t type, struct udevice **devp); @@ -291,7 +291,7 @@ int irq_first_device_type(enum irq_dev_t type, struct udevice **devp); * * @irq: irq to convert * @acpi_irq: Output ACPI interrupt information - * @return ACPI pin number or -ve on error + * Return: ACPI pin number or -ve on error */ int irq_get_acpi(const struct irq *irq, struct acpi_irq *acpi_irq); diff --git a/include/key_matrix.h b/include/key_matrix.h index 519722f..e7420b9 100644 --- a/include/key_matrix.h +++ b/include/key_matrix.h @@ -66,7 +66,7 @@ int key_matrix_decode(struct key_matrix *config, struct key_matrix_key *keys, * @param config Keyboard matrix config * @param blob FDT blob * @param node Node containing compatible data - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int key_matrix_decode_fdt(struct udevice *dev, struct key_matrix *config); @@ -77,7 +77,7 @@ int key_matrix_decode_fdt(struct udevice *dev, struct key_matrix *config); * @param rows Number of rows in key matrix * @param cols Number of columns in key matrix * @param ghost_filter Non-zero to enable ghost filtering - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int key_matrix_init(struct key_matrix *config, int rows, int cols, int ghost_filter); diff --git a/include/lcd.h b/include/lcd.h index 9a4c0da..51a7931 100644 --- a/include/lcd.h +++ b/include/lcd.h @@ -76,42 +76,42 @@ int lcd_display_bitmap(ulong bmp_image, int x, int y); /** * Get the width of the LCD in pixels * - * @return width of LCD in pixels + * Return: width of LCD in pixels */ int lcd_get_pixel_width(void); /** * Get the height of the LCD in pixels * - * @return height of LCD in pixels + * Return: height of LCD in pixels */ int lcd_get_pixel_height(void); /** * Get the number of text lines/rows on the LCD * - * @return number of rows + * Return: number of rows */ int lcd_get_screen_rows(void); /** * Get the number of text columns on the LCD * - * @return number of columns + * Return: number of columns */ int lcd_get_screen_columns(void); /** * Get the background color of the LCD * - * @return background color value + * Return: background color value */ int lcd_getbgcolor(void); /** * Get the foreground color of the LCD * - * @return foreground color value + * Return: foreground color value */ int lcd_getfgcolor(void); diff --git a/include/led.h b/include/led.h index 02766fa..8eeb5a7 100644 --- a/include/led.h +++ b/include/led.h @@ -78,7 +78,7 @@ struct led_ops { * * @label: LED label to look up * @devp: Returns the associated device, if found - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int led_get_by_label(const char *label, struct udevice **devp); @@ -87,7 +87,7 @@ int led_get_by_label(const char *label, struct udevice **devp); * * @dev: LED device to change * @state: LED state to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int led_set_state(struct udevice *dev, enum led_state_t state); @@ -95,7 +95,7 @@ int led_set_state(struct udevice *dev, enum led_state_t state); * led_get_state() - get the state of an LED * * @dev: LED device to change - * @return LED state led_state_t, or -ve on error + * Return: LED state led_state_t, or -ve on error */ enum led_state_t led_get_state(struct udevice *dev); @@ -104,7 +104,7 @@ enum led_state_t led_get_state(struct udevice *dev); * * @dev: LED device to change * @period_ms: LED blink period in milliseconds - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int led_set_period(struct udevice *dev, int period_ms); diff --git a/include/linux/clk-provider.h b/include/linux/clk-provider.h index 9d296f2..9a61166 100644 --- a/include/linux/clk-provider.h +++ b/include/linux/clk-provider.h @@ -84,7 +84,7 @@ u8 clk_mux_get_parent(struct clk *clk); * @table: array of register values corresponding to the parent index (optional) * @flags: hardware-specific flags * @index: parent clock index - * @return the register value + * Return: the register value */ unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index); @@ -143,7 +143,7 @@ extern const struct clk_ops clk_divider_ops; * * @table: array of register values corresponding to valid dividers * @val: value to convert - * @return the divider + * Return: the divider */ unsigned int clk_divider_get_table_div(const struct clk_div_table *table, unsigned int val); @@ -156,7 +156,7 @@ unsigned int clk_divider_get_table_div(const struct clk_div_table *table, * * @table: array of register values corresponding to valid dividers * @div: requested divider - * @return the register value + * Return: the register value */ unsigned int clk_divider_get_table_val(const struct clk_div_table *table, unsigned int div); @@ -167,7 +167,7 @@ unsigned int clk_divider_get_table_val(const struct clk_div_table *table, * @table: array of valid dividers (optional) * @div: divider to check * @flags: hardware-specific flags - * @return true if the divider is valid, false otherwise + * Return: true if the divider is valid, false otherwise */ bool clk_divider_is_valid_div(const struct clk_div_table *table, unsigned int div, unsigned long flags); @@ -177,7 +177,7 @@ bool clk_divider_is_valid_div(const struct clk_div_table *table, * * @table: array of valid dividers * @div: divider to check - * @return true if the divider is found in the @table array, false otherwise + * Return: true if the divider is found in the @table array, false otherwise */ bool clk_divider_is_valid_table_div(const struct clk_div_table *table, unsigned int div); diff --git a/include/linux/string.h b/include/linux/string.h index 3169c93..df1c1c5 100644 --- a/include/linux/string.h +++ b/include/linux/string.h @@ -62,7 +62,7 @@ extern char * strchr(const char *,int); * NULL * @s: string to search * @c: character to search for - * @return position of @c in @s, or end of @s if not found + * Return: position of @c in @s, or end of @s if not found */ const char *strchrnul(const char *s, int c); @@ -89,7 +89,7 @@ extern __kernel_size_t strnlen(const char *,__kernel_size_t); * * @s: string to search * @reject: strings which cause the search to halt - * @return number of characters at the start of @s which are not in @reject + * Return: number of characters at the start of @s which are not in @reject */ size_t strcspn(const char *s, const char *reject); #endif @@ -136,7 +136,7 @@ void *memchr_inv(const void *, int, size_t); * * @src: data to copy in * @len: number of bytes to copy - * @return allocated buffer with the copied contents, or NULL if not enough + * Return: allocated buffer with the copied contents, or NULL if not enough * memory is available * */ diff --git a/include/linux/zstd.h b/include/linux/zstd.h index 35ba4c9..aed20fc 100644 --- a/include/linux/zstd.h +++ b/include/linux/zstd.h @@ -1151,7 +1151,7 @@ struct abuf; * * @in: Input buffer to decompress * @out: Output buffer to hold the results (must be large enough) - * @return size of the decompressed data, or -ve on error + * Return: size of the decompressed data, or -ve on error */ int zstd_decompress(struct abuf *in, struct abuf *out); diff --git a/include/log.h b/include/log.h index e0e12ce..ce48d51 100644 --- a/include/log.h +++ b/include/log.h @@ -660,7 +660,7 @@ int log_remove_filter(const char *drv_name, int filter_num); * * @drv: Driver of device to enable * @enable: true to enable, false to disable - * @return 0 if OK, -ENOENT if the driver was not found + * Return: 0 if OK, -ENOENT if the driver was not found */ int log_device_set_enable(struct log_driver *drv, bool enable); diff --git a/include/mailbox-uclass.h b/include/mailbox-uclass.h index 3c60c76..866ca0a 100644 --- a/include/mailbox-uclass.h +++ b/include/mailbox-uclass.h @@ -62,7 +62,7 @@ struct mbox_ops { * * @chan: The channel to send to the message to. * @data: A pointer to the message to send. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int (*send)(struct mbox_chan *chan, const void *data); /** @@ -73,7 +73,7 @@ struct mbox_ops { * * @chan: The channel to receive to the message from. * @data: A pointer to the buffer to hold the received message. - * @return 0 if OK, -ENODATA if no message was available, or a negative + * Return: 0 if OK, -ENODATA if no message was available, or a negative * error code. */ int (*recv)(struct mbox_chan *chan, void *data); diff --git a/include/mailbox.h b/include/mailbox.h index 93f4715..323b6c2 100644 --- a/include/mailbox.h +++ b/include/mailbox.h @@ -76,7 +76,7 @@ struct mbox_chan { * @index: The index of the mailbox channel to request, within the * client's list of channels. * @chan A pointer to a channel object to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan); @@ -94,7 +94,7 @@ int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan); * @name: The name of the mailbox channel to request, within the client's * list of channels. * @chan A pointer to a channel object to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_get_by_name(struct udevice *dev, const char *name, struct mbox_chan *chan); @@ -104,7 +104,7 @@ int mbox_get_by_name(struct udevice *dev, const char *name, * * @chan: A channel object that was previously successfully requested by * calling mbox_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_free(struct mbox_chan *chan); @@ -120,7 +120,7 @@ int mbox_free(struct mbox_chan *chan); * the memory region pointed at by @data is determined by the * mailbox provider. Providers that solely transfer notifications * will ignore this parameter. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_send(struct mbox_chan *chan, const void *data); @@ -139,7 +139,7 @@ int mbox_send(struct mbox_chan *chan, const void *data); * notifications will ignore this parameter. * @timeout_us: The maximum time to wait for a message to be available, in * micro-seconds. A value of 0 does not wait at all. - * @return 0 if OK, -ENODATA if no message was available, or a negative error + * Return: 0 if OK, -ENODATA if no message was available, or a negative error * code. */ int mbox_recv(struct mbox_chan *chan, void *data, ulong timeout_us); diff --git a/include/memalign.h b/include/memalign.h index 44f4a86..f67f0a7 100644 --- a/include/memalign.h +++ b/include/memalign.h @@ -103,7 +103,7 @@ * * @size: Minimum number of bytes to allocate * - * @return pointer to new memory region, or NULL if there is no more memory + * Return: pointer to new memory region, or NULL if there is no more memory * available. */ static inline void *malloc_cache_aligned(size_t size) diff --git a/include/membuff.h b/include/membuff.h index c992067..21051b0 100644 --- a/include/membuff.h +++ b/include/membuff.h @@ -62,7 +62,7 @@ void membuff_purge(struct membuff *mb); * @maxlen: the number of bytes we want to write * @update: true to update the membuff as if the write happened, false to not * @data: the address data can be written to - * @return number of bytes which can be written + * Return: number of bytes which can be written */ int membuff_putraw(struct membuff *mb, int maxlen, bool update, char **data); @@ -80,7 +80,7 @@ int membuff_putraw(struct membuff *mb, int maxlen, bool update, char **data); * @update: true to update the membuff as if the bytes have been read (use * false to check bytes without reading them) * @data: returns address of data in input membuff - * @return the number of bytes available at *@data + * Return: the number of bytes available at *@data */ int membuff_getraw(struct membuff *mb, int maxlen, bool update, char **data); @@ -89,14 +89,14 @@ int membuff_getraw(struct membuff *mb, int maxlen, bool update, char **data); * * @mb: membuff to adjust * @ch: byte to write - * @return true on success, false if membuff is full + * Return: true on success, false if membuff is full */ bool membuff_putbyte(struct membuff *mb, int ch); /** * @mb: membuff to adjust * membuff_getbyte() - Read a byte from the membuff - * @return the byte read, or -1 if the membuff is empty + * Return: the byte read, or -1 if the membuff is empty */ int membuff_getbyte(struct membuff *mb); @@ -107,7 +107,7 @@ int membuff_getbyte(struct membuff *mb); * removing it from the membuff. * * @mb: membuff to adjust - * @return the byte peeked, or -1 if the membuff is empty + * Return: the byte peeked, or -1 if the membuff is empty */ int membuff_peekbyte(struct membuff *mb); @@ -120,7 +120,7 @@ int membuff_peekbyte(struct membuff *mb); * @mb: membuff to adjust * @Buff: address of membuff to transfer bytes to * @maxlen: maximum number of bytes to read - * @return the number of bytes read + * Return: the number of bytes read */ int membuff_get(struct membuff *mb, char *buff, int maxlen); @@ -133,7 +133,7 @@ int membuff_get(struct membuff *mb, char *buff, int maxlen); * @mb: membuff to adjust * @data: the data to write * @length: number of bytes to write from 'data' - * @return the number of bytes added + * Return: the number of bytes added */ int membuff_put(struct membuff *mb, const char *buff, int length); @@ -141,7 +141,7 @@ int membuff_put(struct membuff *mb, const char *buff, int length); * membuff_isempty() - check if a membuff is empty * * @mb: membuff to check - * @return true if empty, else false + * Return: true if empty, else false */ bool membuff_isempty(struct membuff *mb); @@ -149,7 +149,7 @@ bool membuff_isempty(struct membuff *mb); * membuff_avail() - check available data in a membuff * * @mb: membuff to check - * @return number of bytes of data available + * Return: number of bytes of data available */ int membuff_avail(struct membuff *mb); @@ -159,7 +159,7 @@ int membuff_avail(struct membuff *mb); * Note that a membuff can only old data up to one byte less than its size. * * @mb: membuff to check - * @return total size + * Return: total size */ int membuff_size(struct membuff *mb); @@ -170,7 +170,7 @@ int membuff_size(struct membuff *mb); * possible * * @mb: membuff to adjust - * @return true on success + * Return: true on success */ bool membuff_makecontig(struct membuff *mb); @@ -178,7 +178,7 @@ bool membuff_makecontig(struct membuff *mb); * membuff_free() - find the number of bytes that can be written to a membuff * * @mb: membuff to check - * @return returns the number of bytes free in a membuff + * Return: returns the number of bytes free in a membuff */ int membuff_free(struct membuff *mb); @@ -192,7 +192,7 @@ int membuff_free(struct membuff *mb); * @mb: membuff to adjust * @str: Place to put the line * @maxlen: Maximum line length (excluding terminator) - * @return number of bytes read (including terminator) if a line has been + * Return: number of bytes read (including terminator) if a line has been * read, 0 if nothing was there */ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch); @@ -205,7 +205,7 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch); * @mb: membuff to adjust * @by: Number of bytes to increase the size by * @max: Maximum size to allow - * @return 0 if the expand succeeded, -ENOMEM if not enough memory, -E2BIG + * Return: 0 if the expand succeeded, -ENOMEM if not enough memory, -E2BIG * if the the size would exceed @max */ int membuff_extend_by(struct membuff *mb, int by, int max); @@ -231,7 +231,7 @@ void membuff_uninit(struct membuff *mb); * * @mb: membuff to init * @size: size of membuff to create - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int membuff_new(struct membuff *mb, int size); diff --git a/include/menu.h b/include/menu.h index 9ab9b21..ad58594 100644 --- a/include/menu.h +++ b/include/menu.h @@ -30,7 +30,7 @@ int menu_default_choice(struct menu *m, void **choice); * * @bootdelay: Delay to wait before running the default menu option (0 to run * the entry immediately) - * @return If it returns, it always returns -1 to indicate that the boot should + * Return: If it returns, it always returns -1 to indicate that the boot should * be aborted and the command prompt should be provided */ int menu_show(int bootdelay); diff --git a/include/miiphy.h b/include/miiphy.h index 77a0035..235ae06 100644 --- a/include/miiphy.h +++ b/include/miiphy.h @@ -165,7 +165,7 @@ void dm_mdio_probe_devices(void); * @ethdev: ethernet device to connect to the PHY * @interface: MAC-PHY protocol * - * @return pointer to phy_device, or 0 on error + * Return: pointer to phy_device, or 0 on error */ struct phy_device *dm_mdio_phy_connect(struct udevice *mdiodev, int phyaddr, struct udevice *ethdev, @@ -179,7 +179,7 @@ struct phy_device *dm_mdio_phy_connect(struct udevice *mdiodev, int phyaddr, * * @ethdev: ethernet device * - * @return pointer to phy_device, or 0 on error + * Return: pointer to phy_device, or 0 on error */ struct phy_device *dm_eth_phy_connect(struct udevice *ethdev); diff --git a/include/mmc.h b/include/mmc.h index 244d2dc..6bdcce8 100644 --- a/include/mmc.h +++ b/include/mmc.h @@ -390,7 +390,7 @@ struct mmc_uclass_priv { * will be available. * * @dev: Device - * @return associated mmc struct pointer if available, else NULL + * Return: associated mmc struct pointer if available, else NULL */ struct mmc *mmc_get_mmc_dev(const struct udevice *dev); @@ -768,7 +768,7 @@ struct mmc *mmc_create(const struct mmc_config *cfg, void *priv); * @dev: MMC device to set up * @mmc: MMC struct * @cfg: MMC configuration - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_bind(struct udevice *dev, struct mmc *mmc, const struct mmc_config *cfg); @@ -778,7 +778,7 @@ void mmc_destroy(struct mmc *mmc); * mmc_unbind() - Unbind a MMC device's child block device * * @dev: MMC device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_unbind(struct udevice *dev); int mmc_initialize(struct bd_info *bis); @@ -793,7 +793,7 @@ int mmc_deinit(struct mmc *mmc); * * @dev: MMC device * @cfg: MMC configuration - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg); @@ -803,7 +803,7 @@ int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg); * * @dev: MMC device * @cfg: MMC configuration - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_pwrseq_get_power(struct udevice *dev, struct mmc_config *cfg); #endif @@ -814,7 +814,7 @@ int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size); * mmc_voltage_to_mv() - Convert a mmc_voltage in mV * * @voltage: The mmc_voltage to convert - * @return the value in mV if OK, -EINVAL on error (invalid mmc_voltage value) + * Return: the value in mV if OK, -EINVAL on error (invalid mmc_voltage value) */ int mmc_voltage_to_mv(enum mmc_voltage voltage); @@ -823,7 +823,7 @@ int mmc_voltage_to_mv(enum mmc_voltage voltage); * @mmc: MMC struct * @clock: bus frequency in Hz * @disable: flag indicating if the clock must on or off - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_set_clock(struct mmc *mmc, uint clock, bool disable); @@ -837,7 +837,7 @@ void print_mmc_devices(char separator); /** * get_mmc_num() - get the total MMC device number * - * @return 0 if there is no MMC device, else the number of devices + * Return: 0 if there is no MMC device, else the number of devices */ int get_mmc_num(void); int mmc_switch_part(struct mmc *mmc, unsigned int part_num); @@ -898,7 +898,7 @@ int mmc_set_bkops_enable(struct mmc *mmc); * * @param mmc Pointer to a MMC device struct * @param quiet Be quiet, do not print error messages when card is not detected. - * @return 0 on success, <0 on error. + * Return: 0 on success, <0 on error. */ int mmc_get_op_cond(struct mmc *mmc, bool quiet); @@ -909,7 +909,7 @@ int mmc_get_op_cond(struct mmc *mmc, bool quiet); * initializatin. * * @param mmc Pointer to a MMC device struct - * @return 0 on success, <0 on error. + * Return: 0 on success, <0 on error. */ int mmc_start_init(struct mmc *mmc); @@ -956,7 +956,7 @@ int mmc_get_env_dev(void); * mmc_get_blk_desc() - Get the block descriptor for an MMC device * * @mmc: MMC device - * @return block device if found, else NULL + * Return: block device if found, else NULL */ struct blk_desc *mmc_get_blk_desc(struct mmc *mmc); diff --git a/include/net.h b/include/net.h index cec8c98..b02e4f6 100644 --- a/include/net.h +++ b/include/net.h @@ -67,7 +67,7 @@ struct in_addr { * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -274,7 +274,7 @@ int eth_get_dev_index(void); /* get the device index */ * @base_name: Base name for variable, typically "eth" * @index: Index of interface being updated (>=0) * @enetaddr: Pointer to MAC address to put into the variable - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int eth_env_set_enetaddr_by_index(const char *base_name, int index, uchar *enetaddr); @@ -628,7 +628,7 @@ void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, * * @addr: Address to check (must be 16-bit aligned) * @nbytes: Number of bytes to check (normally a multiple of 2) - * @return 16-bit IP checksum + * Return: 16-bit IP checksum */ unsigned compute_ip_checksum(const void *addr, unsigned nbytes); @@ -638,7 +638,7 @@ unsigned compute_ip_checksum(const void *addr, unsigned nbytes); * @offset: Offset of first sum (if odd we do a byte-swap) * @sum: First checksum * @new_sum: New checksum to add - * @return updated 16-bit IP checksum + * Return: updated 16-bit IP checksum */ unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); @@ -649,7 +649,7 @@ unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); * * @addr: Address to check (must be 16-bit aligned) * @nbytes: Number of bytes to check (normally a multiple of 2) - * @return true if the checksum matches, false if not + * Return: true if the checksum matches, false if not */ int ip_checksum_ok(const void *addr, unsigned nbytes); @@ -917,7 +917,7 @@ int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len); * @param interface - the DFU medium name - e.g. "mmc" * @param devstring - the DFU medium number - e.g. "1" * - * @return - 0 on success, other value on failure + * Return: - 0 on success, other value on failure */ int update_tftp(ulong addr, char *interface, char *devstring); @@ -927,7 +927,7 @@ int update_tftp(ulong addr, char *interface, char *devstring); * @var: Environment variable to convert. The value of this variable must be * in the format format a.b.c.d, where each value is a decimal number from * 0 to 255 - * @return IP address, or 0 if invalid + * Return: IP address, or 0 if invalid */ static inline struct in_addr env_get_ip(char *var) { diff --git a/include/net/dsa.h b/include/net/dsa.h index 1b1068c..9fa9d4e 100644 --- a/include/net/dsa.h +++ b/include/net/dsa.h @@ -130,7 +130,7 @@ struct dsa_pdata { * @tailroom: Size, in bytes, of tailroom needed for the DSA tag. * Total headroom and tailroom size should not exceed * DSA_MAX_OVR. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom); @@ -142,7 +142,7 @@ int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom); * Can be called at driver probe time or later. * * @dev: DSA device pointer - * @return Master Eth 'udevice' pointer if OK, NULL on error + * Return: Master Eth 'udevice' pointer if OK, NULL on error */ struct udevice *dsa_get_master(struct udevice *dev); @@ -153,7 +153,7 @@ struct udevice *dsa_get_master(struct udevice *dev); * * @dev: DSA switch udevice pointer * @port: Port index - * @return OF node reference if OK, NULL on error + * Return: OF node reference if OK, NULL on error */ ofnode dsa_port_get_ofnode(struct udevice *dev, int port); @@ -164,7 +164,7 @@ ofnode dsa_port_get_ofnode(struct udevice *dev, int port); * Can be called at driver probe time or later. * * @pdev: DSA port device pointer - * @return 'dsa_port_pdata' pointer if OK, NULL on error + * Return: 'dsa_port_pdata' pointer if OK, NULL on error */ static inline struct dsa_port_pdata * dsa_port_get_pdata(struct udevice *pdev) diff --git a/include/net/pcap.h b/include/net/pcap.h index 512ba98..6184bf5 100644 --- a/include/net/pcap.h +++ b/include/net/pcap.h @@ -10,7 +10,7 @@ * @paddr physicaly memory address to store buffer * @size maximum size of capture file in memory * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_init(phys_addr_t paddr, unsigned long size); @@ -19,28 +19,28 @@ int pcap_init(phys_addr_t paddr, unsigned long size); * * @start if true, start capture if false stop capture * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_start_stop(bool start); /** * pcap_clear() - clear pcap capture buffer and statistics * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_clear(void); /** * pcap_print_status() - print status of pcap capture * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_print_status(void); /** * pcap_active() - check if pcap is enabled * - * @return TRUE if active, FALSE if not. + * Return: TRUE if active, FALSE if not. */ bool pcap_active(void); @@ -50,6 +50,6 @@ bool pcap_active(void); * @packet: packet to post * @len: packet length in bytes * @outgoing packet direction (outgoing/incoming) - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_post(const void *packet, size_t len, bool outgoing); diff --git a/include/ns16550.h b/include/ns16550.h index bef2071..3d9002d 100644 --- a/include/ns16550.h +++ b/include/ns16550.h @@ -237,7 +237,7 @@ void ns16550_reinit(struct ns16550 *com_port, int baud_divisor); * @port: UART port * @clock: UART input clock speed in Hz * @baudrate: Required baud rate - * @return baud rate divisor that should be used + * Return: baud rate divisor that should be used */ int ns16550_calc_divisor(struct ns16550 *port, int clock, int baudrate); @@ -257,7 +257,7 @@ int ns16550_serial_of_to_plat(struct udevice *dev); * ns16550_serial_probe() - probe a serial port * * This sets up the serial port ready for use, except for the baud rate - * @return 0, or -ve on error + * Return: 0, or -ve on error */ int ns16550_serial_probe(struct udevice *dev); diff --git a/include/of_live.h b/include/of_live.h index b8561f5..b2b9679 100644 --- a/include/of_live.h +++ b/include/of_live.h @@ -16,7 +16,7 @@ struct device_node; * * @fdt_blob: Input tree to convert * @rootp: Returns live tree that was created - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int of_live_build(const void *fdt_blob, struct device_node **rootp); diff --git a/include/p2sb.h b/include/p2sb.h index ddbc8d5..00acc8d 100644 --- a/include/p2sb.h +++ b/include/p2sb.h @@ -63,7 +63,7 @@ struct p2sb_ops { * * @dev: P2SB device * @hide: true to hide the device, false to show it - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int p2sb_set_hide(struct udevice *dev, bool hide); @@ -74,7 +74,7 @@ int p2sb_set_hide(struct udevice *dev, bool hide); * * @dev: Device to read from * @offset: Offset within device to read - * @return value read + * Return: value read */ uint pcr_read32(struct udevice *dev, uint offset); uint pcr_read16(struct udevice *dev, uint offset); @@ -149,7 +149,7 @@ static inline void pcr_clrbits8(struct udevice *dev, uint offset, uint clr) * * @dev: Child device (whose parent is UCLASS_P2SB) * @portid: Port ID of child device - * @return 0 if OK, -ENODEV is the p2sb device could not be found + * Return: 0 if OK, -ENODEV is the p2sb device could not be found */ int p2sb_set_port_id(struct udevice *dev, int portid); @@ -157,7 +157,7 @@ int p2sb_set_port_id(struct udevice *dev, int portid); * p2sb_get_port_id() - Get the port ID for a p2sb child device * * @dev: Child device (whose parent is UCLASS_P2SB) - * @return Port ID of that child + * Return: Port ID of that child */ int p2sb_get_port_id(struct udevice *dev); @@ -166,7 +166,7 @@ int p2sb_get_port_id(struct udevice *dev); * * @dev: Child device (whose parent is UCLASS_P2SB) * @offset: Offset within that child's address space - * @return pointer to that offset within the child's address space + * Return: pointer to that offset within the child's address space */ void *pcr_reg_address(struct udevice *dev, uint offset); diff --git a/include/panel.h b/include/panel.h index cd596d4..ab417bc 100644 --- a/include/panel.h +++ b/include/panel.h @@ -43,7 +43,7 @@ struct panel_ops { * * @dev: Panel device containing the backlight to enable * @enable: true to enable the backlight, false to dis - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_enable_backlight(struct udevice *dev); @@ -52,7 +52,7 @@ int panel_enable_backlight(struct udevice *dev); * * @dev: Panel device containing the backlight to update * @percent: Brightness value (0 to 100, or BACKLIGHT_... value) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_set_backlight(struct udevice *dev, int percent); @@ -60,7 +60,7 @@ int panel_set_backlight(struct udevice *dev, int percent); * panel_get_display_timing() - Get display timings from panel. * * @dev: Panel device containing the display timings - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_get_display_timing(struct udevice *dev, struct display_timing *timing); diff --git a/include/part.h b/include/part.h index b8d8e1f..53cfbdd 100644 --- a/include/part.h +++ b/include/part.h @@ -97,7 +97,7 @@ struct disk_part { * @ifname: Interface name (e.g. "ide", "scsi") * @dev: Device number (0 for first device on that interface, 1 for * second, etc. - * @return pointer to the block device, or NULL if not available, or an + * Return: pointer to the block device, or NULL if not available, or an * error occurred. */ struct blk_desc *blk_get_dev(const char *ifname, int dev); @@ -142,7 +142,7 @@ void dev_print(struct blk_desc *dev_desc); * and hardware partition number (e.g. "2.4") for devices that * support it (currently only MMC). * @dev_desc: Returns a pointer to the block device on success - * @return block device number (local to the interface), or -1 on error + * Return: block device number (local to the interface), or -1 on error */ int blk_get_device_by_str(const char *ifname, const char *dev_str, struct blk_desc **dev_desc); @@ -177,7 +177,7 @@ int blk_get_device_by_str(const char *ifname, const char *dev_str, * @allow_whole_dev: true to allow the user to select partition 0 * (which means the whole device), false to require a valid * partition number >= 1 - * @return partition number, or -1 on error + * Return: partition number, or -1 on error * */ int blk_get_device_part_str(const char *ifname, const char *dev_part_str, @@ -193,7 +193,7 @@ int blk_get_device_part_str(const char *ifname, const char *dev_part_str, * @param info - returns the disk partition info * @param part_type - only search in partitions of this type * - * @return - the partition number on match (starting on 1), -1 on no match, + * Return: - the partition number on match (starting on 1), -1 on no match, * otherwise error */ int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name, @@ -207,7 +207,7 @@ int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name, * @param gpt_name - the specified table entry name * @param info - returns the disk partition info * - * @return - the partition number on match (starting on 1), -1 on no match, + * Return: - the partition number on match (starting on 1), -1 on no match, * otherwise error */ int part_get_info_by_name(struct blk_desc *dev_desc, @@ -230,7 +230,7 @@ int part_get_info_by_name(struct blk_desc *dev_desc, * @param[in] allow_whole_dev true to allow the user to select partition 0 * (which means the whole device), false to require a valid * partition number >= 1 - * @return the partition number on success, or negative errno on error + * Return: the partition number on success, or negative errno on error */ int part_get_info_by_dev_and_name_or_num(const char *dev_iface, const char *dev_part_str, @@ -352,7 +352,7 @@ struct part_driver { * @param gpt_h - pointer to GPT header representation * @param gpt_e - pointer to GPT partition table entries * - * @return - zero on success, otherwise error + * Return: - zero on success, otherwise error */ int write_gpt_table(struct blk_desc *dev_desc, gpt_header *gpt_h, gpt_entry *gpt_e); @@ -366,7 +366,7 @@ int write_gpt_table(struct blk_desc *dev_desc, * @param partitions - list of partitions * @param parts - number of partitions * - * @return zero on success + * Return: zero on success */ int gpt_fill_pte(struct blk_desc *dev_desc, gpt_header *gpt_h, gpt_entry *gpt_e, @@ -380,7 +380,7 @@ int gpt_fill_pte(struct blk_desc *dev_desc, * @param str_guid - disk guid string representation * @param parts_count - number of partitions * - * @return - error on str_guid conversion error + * Return: - error on str_guid conversion error */ int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, char *str_guid, int parts_count); @@ -393,7 +393,7 @@ int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, * @param partitions - list of partitions * @param parts - number of partitions * - * @return zero on success + * Return: zero on success */ int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, struct disk_partition *partitions, const int parts_count); @@ -404,7 +404,7 @@ int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, * @param dev_desc - block device descriptor * @param buf - buffer which contains the MBR and Primary GPT info * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); @@ -414,7 +414,7 @@ int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); * @param dev_desc - block device descriptor * @param buf - buffer which contains the MBR and Primary GPT info * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); @@ -428,7 +428,7 @@ int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); * @param gpt_head - pointer to GPT header data read from medium * @param gpt_pte - pointer to GPT partition table enties read from medium * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, gpt_entry **gpt_pte); @@ -447,7 +447,7 @@ int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, * @param gpt_head - pointer to GPT header data read from medium * @param gpt_pte - pointer to GPT partition table enties read from medium * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int gpt_verify_partitions(struct blk_desc *dev_desc, struct disk_partition *partitions, int parts, @@ -463,7 +463,7 @@ int gpt_verify_partitions(struct blk_desc *dev_desc, * @param dev_desc - block device descriptor * @param guid - pre-allocated string in which to return the GUID * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int get_disk_guid(struct blk_desc *dev_desc, char *guid); @@ -475,7 +475,7 @@ int get_disk_guid(struct blk_desc *dev_desc, char *guid); * * @param buf - buffer which contains the MBR * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int is_valid_dos_buf(void *buf); @@ -485,7 +485,7 @@ int is_valid_dos_buf(void *buf); * @param dev_desc - block device descriptor * @param buf - buffer which contains the MBR * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int write_mbr_sector(struct blk_desc *dev_desc, void *buf); @@ -500,7 +500,7 @@ int layout_mbr_partitions(struct disk_partition *p, int count, /** * part_driver_get_count() - get partition driver count * - * @return - number of partition drivers + * Return: - number of partition drivers */ static inline int part_driver_get_count(void) { @@ -510,7 +510,7 @@ static inline int part_driver_get_count(void) /** * part_driver_get_first() - get first partition driver * - * @return - pointer to first partition driver on success, otherwise NULL + * Return: - pointer to first partition driver on success, otherwise NULL */ static inline struct part_driver *part_driver_get_first(void) { diff --git a/include/pch.h b/include/pch.h index 6205668..d2b6862 100644 --- a/include/pch.h +++ b/include/pch.h @@ -110,7 +110,7 @@ struct pch_ops { * * @dev: PCH device to check * @sbasep: Returns address of SPI base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no SPI base) + * Return: 0 if OK, -ve on error (e.g. there is no SPI base) */ int pch_get_spi_base(struct udevice *dev, ulong *sbasep); @@ -120,7 +120,7 @@ int pch_get_spi_base(struct udevice *dev, ulong *sbasep); * @dev: PCH device to adjust * @protect: true to protect, false to unprotect * - * @return 0 on success, -ENOSYS if not implemented + * Return: 0 on success, -ENOSYS if not implemented */ int pch_set_spi_protect(struct udevice *dev, bool protect); @@ -129,7 +129,7 @@ int pch_set_spi_protect(struct udevice *dev, bool protect); * * @dev: PCH device to check * @gbasep: Returns address of GPIO base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no GPIO base) + * Return: 0 if OK, -ve on error (e.g. there is no GPIO base) */ int pch_get_gpio_base(struct udevice *dev, u32 *gbasep); @@ -138,7 +138,7 @@ int pch_get_gpio_base(struct udevice *dev, u32 *gbasep); * * @dev: PCH device to check * @iobasep: Returns address of IO base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no IO base) + * Return: 0 if OK, -ve on error (e.g. there is no IO base) */ int pch_get_io_base(struct udevice *dev, u32 *iobasep); @@ -154,7 +154,7 @@ int pch_get_io_base(struct udevice *dev, u32 *iobasep); * @req: PCH request ID * @data: Input/output data * @size: Size of input data (and maximum size of output data) - * @return size of output data on sucesss, -ve on error + * Return: size of output data on sucesss, -ve on error */ int pch_ioctl(struct udevice *dev, ulong req, void *data, int size); diff --git a/include/pci.h b/include/pci.h index ad1171b..9e7910b 100644 --- a/include/pci.h +++ b/include/pci.h @@ -812,7 +812,7 @@ void pciauto_config_init(struct pci_controller *hose); * @size: Amount of bytes to allocate * @bar: Returns the PCI bus address of the allocated resource * @supports_64bit: Whether to allow allocations above the 32-bit boundary - * @return 0 if successful, -1 on failure + * Return: 0 if successful, -1 on failure */ int pciauto_region_allocate(struct pci_region *res, pci_size_t size, pci_addr_t *bar, bool supports_64bit); @@ -898,7 +898,7 @@ void pci_write_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum, * @hose: PCI hose to use * @dev: PCI device to inspect * @barnum: BAR number (0-5) - * @return address of the bar, masking out any control bits + * Return: address of the bar, masking out any control bits * */ u32 pci_read_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum); @@ -998,7 +998,7 @@ struct dm_pci_ops { * dm_pci_get_bdf() - Get the BDF value for a device * * @dev: Device to check - * @return bus/device/function value (see PCI_BDF()) + * Return: bus/device/function value (see PCI_BDF()) */ pci_dev_t dm_pci_get_bdf(const struct udevice *dev); @@ -1015,7 +1015,7 @@ pci_dev_t dm_pci_get_bdf(const struct udevice *dev); * driver interface. * * @bus: Bus containing devices to bind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bind_bus_devices(struct udevice *bus); @@ -1030,7 +1030,7 @@ int pci_bind_bus_devices(struct udevice *bus); * devices are mapped into memory and I/O space ready for use. * * @bus: Bus containing devices to bind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_auto_config_devices(struct udevice *bus); @@ -1039,7 +1039,7 @@ int pci_auto_config_devices(struct udevice *bus); * * @bdf: PCI device address: bus, device and function -see PCI_BDF() * @devp: Returns the device for this address, if found - * @return 0 if OK, -ENODEV if not found + * Return: 0 if OK, -ENODEV if not found */ int dm_pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp); @@ -1048,7 +1048,7 @@ int dm_pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp); * * @find_devfn: PCI device address (device and function only) * @devp: Returns the device for this address, if found - * @return 0 if OK, -ENODEV if not found + * Return: 0 if OK, -ENODEV if not found */ int pci_bus_find_devfn(const struct udevice *bus, pci_dev_t find_devfn, struct udevice **devp); @@ -1062,7 +1062,7 @@ int pci_bus_find_devfn(const struct udevice *bus, pci_dev_t find_devfn, * * @devp: Set to the first available device, or NULL if no more are left * or we got an error - * @return 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) + * Return: 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) */ int pci_find_first_device(struct udevice **devp); @@ -1074,7 +1074,7 @@ int pci_find_first_device(struct udevice **devp); * * @devp: On entry, the last device returned. Set to the next available * device, or NULL if no more are left or we got an error - * @return 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) + * Return: 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) */ int pci_find_next_device(struct udevice **devp); @@ -1082,7 +1082,7 @@ int pci_find_next_device(struct udevice **devp); * pci_get_ff() - Returns a mask for the given access size * * @size: Access size - * @return 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for + * Return: 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for * PCI_SIZE_32 */ int pci_get_ff(enum pci_size_t size); @@ -1097,7 +1097,7 @@ int pci_get_ff(enum pci_size_t size); * parameter is decremented for each non-matching device so * can be called repeatedly. * @devp: Returns matching device if found - * @return 0 if found, -ENODEV if not + * Return: 0 if found, -ENODEV if not */ int pci_bus_find_devices(struct udevice *bus, const struct pci_device_id *ids, int *indexp, struct udevice **devp); @@ -1109,7 +1109,7 @@ int pci_bus_find_devices(struct udevice *bus, const struct pci_device_id *ids, * @index: Index number of device to find, 0 for the first match, 1 for * the second, etc. * @devp: Returns matching device if found - * @return 0 if found, -ENODEV if not + * Return: 0 if found, -ENODEV if not */ int pci_find_device_id(const struct pci_device_id *ids, int index, struct udevice **devp); @@ -1126,7 +1126,7 @@ int pci_find_device_id(const struct pci_device_id *ids, int index, * * @hose: PCI hose to scan * @bdf: PCI bus address to scan (PCI_BUS(bdf) is the bus number) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_pci_hose_probe_bus(struct udevice *bus); @@ -1141,7 +1141,7 @@ int dm_pci_hose_probe_bus(struct udevice *bus); * @offset: Register offset to read * @valuep: Place to put the returned value * @size: Access size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bus_read_config(const struct udevice *bus, pci_dev_t bdf, int offset, unsigned long *valuep, enum pci_size_t size); @@ -1154,7 +1154,7 @@ int pci_bus_read_config(const struct udevice *bus, pci_dev_t bdf, int offset, * @offset: Register offset to write * @value: Value to write * @size: Access size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset, unsigned long value, enum pci_size_t size); @@ -1169,7 +1169,7 @@ int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset, * @offset: Register offset to update * @clr: Bits to clear * @set: Bits to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bus_clrset_config32(struct udevice *bus, pci_dev_t bdf, int offset, u32 clr, u32 set); @@ -1271,7 +1271,7 @@ int pci_generic_mmap_read_config( * * @pdev: Physical Function udevice handle * @vf_en: Number of Virtual Function devices to enable - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int pci_sriov_init(struct udevice *pdev, int vf_en); @@ -1279,7 +1279,7 @@ int pci_sriov_init(struct udevice *pdev, int vf_en); * pci_sriov_get_totalvfs() - Get total available Virtual Function devices * * @pdev: Physical Function udevice handle - * @return count on success, -ve on error + * Return: count on success, -ve on error */ int pci_sriov_get_totalvfs(struct udevice *pdev); #endif @@ -1335,7 +1335,7 @@ static inline int pci_read_config_byte(pci_dev_t pcidev, int offset, * devices are mapped into memory and I/O space ready for use. * * @dev: Device to configure - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_pciauto_config_device(struct udevice *dev); @@ -1349,7 +1349,7 @@ int dm_pciauto_config_device(struct udevice *dev); * @value: Value to transform (32-bit value read from @offset & ~3) * @offset: Register offset that was read * @size: Required size of the result - * @return the value that would have been obtained if the read had been + * Return: the value that would have been obtained if the read had been * performed at the given offset with the correct size */ ulong pci_conv_32_to_size(ulong value, uint offset, enum pci_size_t size); @@ -1365,7 +1365,7 @@ ulong pci_conv_32_to_size(ulong value, uint offset, enum pci_size_t size); * @value: Value to transform (32-bit value read from @offset & ~3) * @offset: Register offset that should be written * @size: Required size of the write - * @return the value that should be written as a 32-bit access to @offset & ~3. + * Return: the value that should be written as a 32-bit access to @offset & ~3. */ ulong pci_conv_size_to_32(ulong old, ulong value, uint offset, enum pci_size_t size); @@ -1374,7 +1374,7 @@ ulong pci_conv_size_to_32(ulong old, ulong value, uint offset, * pci_get_controller() - obtain the controller to use for a bus * * @dev: Device to check - * @return pointer to the controller device for this bus + * Return: pointer to the controller device for this bus */ struct udevice *pci_get_controller(struct udevice *dev); @@ -1385,7 +1385,7 @@ struct udevice *pci_get_controller(struct udevice *dev); * @iop: Returns a pointer to the I/O region, or NULL if none * @memp: Returns a pointer to the memory region, or NULL if none * @prefp: Returns a pointer to the pre-fetch region, or NULL if none - * @return the number of non-NULL regions returned, normally 3 + * Return: the number of non-NULL regions returned, normally 3 */ int pci_get_regions(struct udevice *dev, struct pci_region **iop, struct pci_region **memp, struct pci_region **prefp); @@ -1417,7 +1417,7 @@ u32 dm_pci_read_bar32(const struct udevice *dev, int barnum); * @dev: Device containing the PCI address * @addr: PCI address to convert * @flags: Flags for the region type (PCI_REGION_...) - * @return physical address corresponding to that PCI bus address + * Return: physical address corresponding to that PCI bus address */ phys_addr_t dm_pci_bus_to_phys(struct udevice *dev, pci_addr_t addr, unsigned long flags); @@ -1428,7 +1428,7 @@ phys_addr_t dm_pci_bus_to_phys(struct udevice *dev, pci_addr_t addr, * @dev: Device containing the bus address * @addr: Physical address to convert * @flags: Flags for the region type (PCI_REGION_...) - * @return PCI bus address corresponding to that physical address + * Return: PCI bus address corresponding to that physical address */ pci_addr_t dm_pci_phys_to_bus(struct udevice *dev, phys_addr_t addr, unsigned long flags); @@ -1582,7 +1582,7 @@ int dm_pci_flr(struct udevice *dev); * @device: Device ID * @index: 0 to find the first match, 1 for second, etc. * @devp: Returns pointer to the device, if found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int dm_pci_find_device(unsigned int vendor, unsigned int device, int index, struct udevice **devp); @@ -1593,7 +1593,7 @@ int dm_pci_find_device(unsigned int vendor, unsigned int device, int index, * @find_class: 3-byte (24-bit) class value to find * @index: 0 to find the first match, 1 for second, etc. * @devp: Returns pointer to the device, if found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int dm_pci_find_class(uint find_class, int index, struct udevice **devp); @@ -1705,7 +1705,7 @@ struct dm_pci_emul_ops { * @find_devfn: PCI device and function address (PCI_DEVFN()) * @containerp: Returns container device if found * @emulp: Returns emulated device if found - * @return 0 if found, -ENODEV if not found + * Return: 0 if found, -ENODEV if not found */ int sandbox_pci_get_emul(const struct udevice *bus, pci_dev_t find_devfn, struct udevice **containerp, struct udevice **emulp); @@ -1715,7 +1715,7 @@ int sandbox_pci_get_emul(const struct udevice *bus, pci_dev_t find_devfn, * * @emul: Emulation device to check * @devp: Returns the client device emulated by this device - * @return 0 if OK, -ENOENT if the device has no client yet + * Return: 0 if OK, -ENOENT if the device has no client yet */ int sandbox_pci_get_client(struct udevice *emul, struct udevice **devp); diff --git a/include/pci_ep.h b/include/pci_ep.h index 00e8c6d..e8e5800 100644 --- a/include/pci_ep.h +++ b/include/pci_ep.h @@ -255,7 +255,7 @@ struct pci_ep_ops { * @dev: device to write to * @func_num: EP function to fill * @hdr: header to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_write_header(struct udevice *dev, uint func_num, struct pci_ep_header *hdr); @@ -266,7 +266,7 @@ int pci_ep_write_header(struct udevice *dev, uint func_num, * @dev: device to write to * @func_num: EP function to fill * @hdr: header to read to - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_read_header(struct udevice *dev, uint func_num, struct pci_ep_header *hdr); @@ -276,7 +276,7 @@ int pci_ep_read_header(struct udevice *dev, uint func_num, * @dev: device to set * @func_num: EP function to set * @bar: bar data - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_set_bar(struct udevice *dev, uint func_num, struct pci_bar *bar); @@ -287,7 +287,7 @@ int pci_ep_set_bar(struct udevice *dev, uint func_num, struct pci_bar *bar); * @func_num: EP function to read * @bar: struct to copy data to * @barno: bar number to read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_read_bar(struct udevice *dev, uint func_no, struct pci_bar *ep_bar, enum pci_barno barno); @@ -298,7 +298,7 @@ int pci_ep_read_bar(struct udevice *dev, uint func_no, struct pci_bar *ep_bar, * @dev: device to clear * @func_num: EP function to clear * @bar: bar number - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_clear_bar(struct udevice *dev, uint func_num, enum pci_barno bar); /** @@ -312,7 +312,7 @@ int pci_ep_clear_bar(struct udevice *dev, uint func_num, enum pci_barno bar); * @addr: local physical address base * @pci_addr: pci address to translate to * @size: region size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_map_addr(struct udevice *dev, uint func_num, phys_addr_t addr, u64 pci_addr, size_t size); @@ -324,7 +324,7 @@ int pci_ep_map_addr(struct udevice *dev, uint func_num, phys_addr_t addr, * @dev: device to set * @func_num: EP function to set * @addr: local physical address base - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_unmap_addr(struct udevice *dev, uint func_num, phys_addr_t addr); @@ -337,7 +337,7 @@ int pci_ep_unmap_addr(struct udevice *dev, uint func_num, phys_addr_t addr); * @dev: device to set * @func_num: EP function to set * @interrupts: required interrupts count - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_set_msi(struct udevice *dev, uint func_num, uint interrupts); @@ -349,7 +349,7 @@ int pci_ep_set_msi(struct udevice *dev, uint func_num, uint interrupts); * * @dev: device to use * @func_num: EP function to use - * @return msi count if OK, -EINVAL if msi were not enabled at host. + * Return: msi count if OK, -EINVAL if msi were not enabled at host. */ int pci_ep_get_msi(struct udevice *dev, uint func_num); @@ -362,7 +362,7 @@ int pci_ep_get_msi(struct udevice *dev, uint func_num); * @dev: device to set * @func_num: EP function to set * @interrupts: required interrupts count - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_set_msix(struct udevice *dev, uint func_num, uint interrupts); @@ -374,7 +374,7 @@ int pci_ep_set_msix(struct udevice *dev, uint func_num, uint interrupts); * * @dev: device to use * @func_num: EP function to use - * @return msi count if OK, -EINVAL if msi were not enabled at host. + * Return: msi count if OK, -EINVAL if msi were not enabled at host. */ int pci_ep_get_msix(struct udevice *dev, uint func_num); @@ -385,7 +385,7 @@ int pci_ep_get_msix(struct udevice *dev, uint func_num); * @func_num: EP function to set * @type: type of irq to send * @interrupt_num: interrupt vector to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_raise_irq(struct udevice *dev, uint func_num, enum pci_ep_irq_type type, uint interrupt_num); @@ -396,7 +396,7 @@ int pci_ep_raise_irq(struct udevice *dev, uint func_num, * process. * * @dev: device to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_start(struct udevice *dev); @@ -407,7 +407,7 @@ int pci_ep_start(struct udevice *dev); * link. * * @dev: device to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_stop(struct udevice *dev); diff --git a/include/pci_rom.h b/include/pci_rom.h index 895c962..1cc61c3 100644 --- a/include/pci_rom.h +++ b/include/pci_rom.h @@ -60,7 +60,7 @@ int dm_pci_run_vga_bios(struct udevice *dev, int (*int15_handler)(void), * the mapping ourselves. * * @vendev: Vendor and device for the video device - * @return standard vendor and device expected by the ROM + * Return: standard vendor and device expected by the ROM */ uint32_t board_map_oprom_vendev(uint32_t vendev); diff --git a/include/phy-sun4i-usb.h b/include/phy-sun4i-usb.h index b0a45b2..c37c593 100644 --- a/include/phy-sun4i-usb.h +++ b/include/phy-sun4i-usb.h @@ -11,7 +11,7 @@ * sun4i_usb_phy_id_detect - detect ID pin of USB PHY * * @phy: USB PHY port to detect ID pin - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int sun4i_usb_phy_id_detect(struct phy *phy); @@ -19,7 +19,7 @@ int sun4i_usb_phy_id_detect(struct phy *phy); * sun4i_usb_phy_vbus_detect - detect VBUS pin of USB PHY * * @phy: USB PHY port to detect VBUS pin - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int sun4i_usb_phy_vbus_detect(struct phy *phy); diff --git a/include/physmem.h b/include/physmem.h index 03d3a78..c88ae96 100644 --- a/include/physmem.h +++ b/include/physmem.h @@ -16,6 +16,6 @@ * @param c The character to set each byte of the region to. * @param n The number of bytes to set. * - * @return The physical address of the memory which was set. + * Return: The physical address of the memory which was set. */ phys_addr_t arch_phys_memset(phys_addr_t s, int c, phys_size_t n); diff --git a/include/power-domain.h b/include/power-domain.h index 62ff199..113276b 100644 --- a/include/power-domain.h +++ b/include/power-domain.h @@ -74,7 +74,7 @@ struct power_domain { * * @dev: The client device. * @power_domain A pointer to a power domain struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_get(struct udevice *dev, struct power_domain *power_domain); @@ -93,7 +93,7 @@ int power_domain_get(struct udevice *dev, struct power_domain *power_domain) * @power_domain: A pointer to a power domain struct to initialize. * @index: Power domain index to be powered on. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_get_by_index(struct udevice *dev, @@ -112,7 +112,7 @@ int power_domain_get_by_index(struct udevice *dev, * * @power_domain: A power domain struct that was previously successfully * requested by power_domain_get(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_free(struct power_domain *power_domain); @@ -128,7 +128,7 @@ static inline int power_domain_free(struct power_domain *power_domain) * * @power_domain: A power domain struct that was previously successfully * requested by power_domain_get(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_on(struct power_domain *power_domain); @@ -144,7 +144,7 @@ static inline int power_domain_on(struct power_domain *power_domain) * * @power_domain: A power domain struct that was previously successfully * requested by power_domain_get(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_off(struct power_domain *power_domain); @@ -160,7 +160,7 @@ static inline int power_domain_off(struct power_domain *power_domain) * * @dev: The client device. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN) int dev_power_domain_on(struct udevice *dev); @@ -176,7 +176,7 @@ static inline int dev_power_domain_on(struct udevice *dev) * * @dev: The client device. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN) int dev_power_domain_off(struct udevice *dev); diff --git a/include/power/acpi_pmc.h b/include/power/acpi_pmc.h index 64176d7..62c4dcb 100644 --- a/include/power/acpi_pmc.h +++ b/include/power/acpi_pmc.h @@ -141,7 +141,7 @@ struct acpi_pmc_ops { * This reads the current state of the PMC. This reads in the common registers, * then calls the device's init() method to read the SoC-specific registers. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pmc_init(struct udevice *dev); @@ -151,7 +151,7 @@ int pmc_init(struct udevice *dev); * This reads various state registers and returns the sleep state from * which the system woke. * - * @return enum acpi_sleep_state indicating the previous sleep state + * Return: enum acpi_sleep_state indicating the previous sleep state * (ACPI_S0, ACPI_S3 or ACPI_S5), or -ve on error */ int pmc_prev_sleep_state(struct udevice *dev); @@ -162,7 +162,7 @@ int pmc_prev_sleep_state(struct udevice *dev); * Disables the timer/counter in the PMC * * @dev: PMC device to use - * @return 0 + * Return: 0 */ int pmc_disable_tco(struct udevice *dev); @@ -176,7 +176,7 @@ int pmc_disable_tco(struct udevice *dev); * * @dev: PMC device to use * @enable: true to enable global reset, false to disable - * @return 0 + * Return: 0 */ int pmc_global_reset_set_enable(struct udevice *dev, bool enable); @@ -190,7 +190,7 @@ void pmc_dump_info(struct udevice *dev); * pmc_gpe_init() - Set up general-purpose events * * @dev: PMC device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pmc_gpe_init(struct udevice *dev); diff --git a/include/power/pmic.h b/include/power/pmic.h index 97f855c..70f2709 100644 --- a/include/power/pmic.h +++ b/include/power/pmic.h @@ -201,7 +201,7 @@ struct pmic_child_info { * * @pmic - pmic device - the parent of found child's * @child_info - N-childs info array - * @return a positive number of childs, or 0 if no child found (error) + * Return: a positive number of childs, or 0 if no child found (error) * * Note: For N-childs the child_info array should have N+1 entries and the last * entry prefix should be NULL - the same as for drivers compatible. @@ -236,7 +236,7 @@ int pmic_bind_children(struct udevice *pmic, ofnode parent, * * @name - device name * @devp - returned pointer to the pmic device - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. * * The returned devp device can be used with pmic_read/write calls */ @@ -248,7 +248,7 @@ int pmic_get(const char *name, struct udevice **devp); * The required pmic device can be obtained by 'pmic_get()' * * @dev - pointer to the UCLASS_PMIC device - * @return register count value on success or negative value of errno. + * Return: register count value on success or negative value of errno. */ int pmic_reg_count(struct udevice *dev); @@ -261,7 +261,7 @@ int pmic_reg_count(struct udevice *dev); * @reg - device register offset * @buffer - pointer to read/write buffer * @len - byte count for read/write - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int pmic_read(struct udevice *dev, uint reg, uint8_t *buffer, int len); int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len); @@ -271,7 +271,7 @@ int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len); * * @dev: PMIC device to read * @reg: Register to read - * @return value read on success or negative value of errno. + * Return: value read on success or negative value of errno. */ int pmic_reg_read(struct udevice *dev, uint reg); @@ -281,7 +281,7 @@ int pmic_reg_read(struct udevice *dev, uint reg); * @dev: PMIC device to write * @reg: Register to write * @value: Value to write - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int pmic_reg_write(struct udevice *dev, uint reg, uint value); @@ -295,7 +295,7 @@ int pmic_reg_write(struct udevice *dev, uint reg, uint value); * @reg: Register to update * @clr: Bit mask to clear (set those bits that you want cleared) * @set: Bit mask to set (set those bits that you want set) - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int pmic_clrsetbits(struct udevice *dev, uint reg, uint clr, uint set); diff --git a/include/power/regulator.h b/include/power/regulator.h index fad87c9..ff1bfc2 100644 --- a/include/power/regulator.h +++ b/include/power/regulator.h @@ -274,7 +274,7 @@ struct dm_regulator_ops { * * @dev - pointer to the regulator device * @modep - pointer to the returned mode info array - * @return - count of modep entries on success or negative errno if fail. + * Return: - count of modep entries on success or negative errno if fail. */ int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep); @@ -282,7 +282,7 @@ int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep); * regulator_get_value: get microvoltage voltage value of a given regulator * * @dev - pointer to the regulator device - * @return - positive output value [uV] on success or negative errno if fail. + * Return: - positive output value [uV] on success or negative errno if fail. */ int regulator_get_value(struct udevice *dev); @@ -291,7 +291,7 @@ int regulator_get_value(struct udevice *dev); * * @dev - pointer to the regulator device * @uV - the output value to set [micro Volts] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_value(struct udevice *dev, int uV); @@ -300,7 +300,7 @@ int regulator_set_value(struct udevice *dev, int uV); * * @dev - pointer to the regulator device * @uV - the output suspend value to set [micro Volts] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_suspend_value(struct udevice *dev, int uV); @@ -308,7 +308,7 @@ int regulator_set_suspend_value(struct udevice *dev, int uV); * regulator_get_suspend_value: get the suspend microvoltage value of a given regulator. * * @dev - pointer to the regulator device - * @return - positive output value [uV] on success or negative errno if fail. + * Return: - positive output value [uV] on success or negative errno if fail. */ int regulator_get_suspend_value(struct udevice *dev); @@ -318,7 +318,7 @@ int regulator_get_suspend_value(struct udevice *dev); * * @dev - pointer to the regulator device * @uV - the output value to set [micro Volts] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_value_force(struct udevice *dev, int uV); @@ -326,7 +326,7 @@ int regulator_set_value_force(struct udevice *dev, int uV); * regulator_get_current: get microampere value of a given regulator * * @dev - pointer to the regulator device - * @return - positive output current [uA] on success or negative errno if fail. + * Return: - positive output current [uA] on success or negative errno if fail. */ int regulator_get_current(struct udevice *dev); @@ -335,7 +335,7 @@ int regulator_get_current(struct udevice *dev); * * @dev - pointer to the regulator device * @uA - set the output current [micro Amps] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_current(struct udevice *dev, int uA); @@ -343,7 +343,7 @@ int regulator_set_current(struct udevice *dev, int uA); * regulator_get_enable: get regulator device enable state. * * @dev - pointer to the regulator device - * @return - true/false of enable state or -errno val if fails + * Return: - true/false of enable state or -errno val if fails */ int regulator_get_enable(struct udevice *dev); @@ -352,7 +352,7 @@ int regulator_get_enable(struct udevice *dev); * * @dev - pointer to the regulator device * @enable - set true or false - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_enable(struct udevice *dev, bool enable); @@ -362,7 +362,7 @@ int regulator_set_enable(struct udevice *dev, bool enable); * * @dev - pointer to the regulator device * @enable - set true or false - * @return - 0 on success or if enabling is not supported + * Return: - 0 on success or if enabling is not supported * -errno val if fails. */ int regulator_set_enable_if_allowed(struct udevice *dev, bool enable); @@ -372,7 +372,7 @@ int regulator_set_enable_if_allowed(struct udevice *dev, bool enable); * * @dev - pointer to the regulator device * @enable - set true or false - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_suspend_enable(struct udevice *dev, bool enable); @@ -380,7 +380,7 @@ int regulator_set_suspend_enable(struct udevice *dev, bool enable); * regulator_get_suspend_enable: get regulator suspend enable state * * @dev - pointer to the regulator device - * @return - true/false of enable state or -errno val if fails + * Return: - true/false of enable state or -errno val if fails */ int regulator_get_suspend_enable(struct udevice *dev); @@ -388,7 +388,7 @@ int regulator_get_suspend_enable(struct udevice *dev); * regulator_get_mode: get active operation mode id of a given regulator * * @dev - pointer to the regulator device - * @return - positive mode 'id' number on success or -errno val if fails + * Return: - positive mode 'id' number on success or -errno val if fails * Note: * The device can provide an array of operating modes, which is type of struct * dm_regulator_mode. Each mode has it's own 'id', which should be unique inside @@ -402,7 +402,7 @@ int regulator_get_mode(struct udevice *dev); * * @dev - pointer to the regulator device * @mode_id - mode id to set ('id' field of struct type dm_regulator_mode) - * @return - 0 on success or -errno value if fails + * Return: - 0 on success or -errno value if fails * Note: * The device can provide an array of operating modes, which is type of struct * dm_regulator_mode. Each mode has it's own 'id', which should be unique inside @@ -493,7 +493,7 @@ int regulator_autoset_by_name(const char *platname, struct udevice **devp); * @list_devp - an array of returned pointers to the successfully setup * regulator devices if non-NULL passed * @verbose - (true/false) print each regulator setup info, or be quiet - * @return 0 on successfully setup of all list entries, otherwise first error. + * Return: 0 on successfully setup of all list entries, otherwise first error. * * The returned 'regulator' devices can be used with: * - regulator_get/set_* @@ -515,7 +515,7 @@ int regulator_list_autoset(const char *list_platname[], * * @devname - expected string for 'dev->name' of regulator device * @devp - returned pointer to the regulator device - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. * * The returned 'regulator' device is probed and can be used with: * - regulator_get/set_* @@ -528,7 +528,7 @@ int regulator_get_by_devname(const char *devname, struct udevice **devp); * * @platname - expected string for uc_pdata->name of regulator uclass plat * @devp - returns pointer to the regulator device or NULL on error - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. * * The returned 'regulator' device is probed and can be used with: * - regulator_get/set_* @@ -546,7 +546,7 @@ int regulator_get_by_platname(const char *platname, struct udevice **devp); * @dev - device with supply phandle * @supply_name - phandle name of regulator * @devp - returned pointer to the supply device - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int device_get_supply_regulator(struct udevice *dev, const char *supply_name, struct udevice **devp); diff --git a/include/pwm.h b/include/pwm.h index 668551e..bfdc1e3 100644 --- a/include/pwm.h +++ b/include/pwm.h @@ -63,7 +63,7 @@ struct pwm_ops { * @channel: PWM channel to update * @period_ns: PWM period in nanoseconds * @duty_ns: PWM duty period in nanoseconds - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pwm_set_config(struct udevice *dev, uint channel, uint period_ns, uint duty_ns); @@ -74,7 +74,7 @@ int pwm_set_config(struct udevice *dev, uint channel, uint period_ns, * @dev: PWM device to update * @channel: PWM channel to update * @enable: true to enable, false to disable - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pwm_set_enable(struct udevice *dev, uint channel, bool enable); @@ -84,7 +84,7 @@ int pwm_set_enable(struct udevice *dev, uint channel, bool enable); * @dev: PWM device to update * @channel: PWM channel to update * @polarity: true to invert, false to keep normal polarity - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pwm_set_invert(struct udevice *dev, uint channel, bool polarity); diff --git a/include/pxe_utils.h b/include/pxe_utils.h index b7037f8..dad2668 100644 --- a/include/pxe_utils.h +++ b/include/pxe_utils.h @@ -205,7 +205,7 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len); * @allow_abs_path: true to allow absolute paths * @bootfile: Bootfile whose directory loaded files are relative to, NULL if * none - * @return 0 if OK, -ENOMEM if out of memory, -E2BIG if bootfile is larger than + * Return: 0 if OK, -ENOMEM if out of memory, -E2BIG if bootfile is larger than * MAX_TFTP_PATH_LEN bytes */ int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, @@ -232,7 +232,7 @@ int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt); * pxe_get_file_size() - Read the value of the 'filesize' environment variable * * @sizep: Place to put the value - * @return 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid + * Return: 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid */ int pxe_get_file_size(ulong *sizep); diff --git a/include/ram.h b/include/ram.h index 273d415..2fc971d 100644 --- a/include/ram.h +++ b/include/ram.h @@ -32,7 +32,7 @@ struct ram_ops { * * @dev: Device to check (UCLASS_RAM) * @info: Returns RAM info - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ram_get_info(struct udevice *dev, struct ram_info *info); diff --git a/include/reboot-mode/reboot-mode.h b/include/reboot-mode/reboot-mode.h index 86b51f8..5fbd7c8 100644 --- a/include/reboot-mode/reboot-mode.h +++ b/include/reboot-mode/reboot-mode.h @@ -49,7 +49,7 @@ struct reboot_mode_ops { * dm_reboot_mode_update() - Update the reboot mode env variable. * * @dev: Device to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_reboot_mode_update(struct udevice *dev); diff --git a/include/relocate.h b/include/relocate.h index 26682da..2dbfd90 100644 --- a/include/relocate.h +++ b/include/relocate.h @@ -16,7 +16,7 @@ DECLARE_GLOBAL_DATA_PTR; /** * copy_uboot_to_ram() - Copy U-Boot to its new relocated position * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int copy_uboot_to_ram(void); @@ -25,7 +25,7 @@ int copy_uboot_to_ram(void); * * This clears the memory used by global variables * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int clear_bss(void); @@ -35,7 +35,7 @@ int clear_bss(void); * This processes the relocation tables to ensure that the code can run in its * new location. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int do_elf_reloc_fixups(void); @@ -46,7 +46,7 @@ int do_elf_reloc_fixups(void); * which need to manually relocate some things. * * @ptr: Pointer to relocate - * @return new pointer value + * Return: new pointer value */ static inline void *manual_reloc(void *ptr) { diff --git a/include/remoteproc.h b/include/remoteproc.h index 089131f..a8e6546 100644 --- a/include/remoteproc.h +++ b/include/remoteproc.h @@ -134,20 +134,20 @@ struct dm_rproc_ops { #if CONFIG_IS_ENABLED(REMOTEPROC) /** * rproc_init() - Initialize all bound remote proc devices - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_init(void); /** * rproc_dev_init() - Initialize a remote proc device based on id * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_dev_init(int id); /** * rproc_is_initialized() - check to see if remoteproc devices are initialized - * @return true if all devices are initialized, false otherwise. + * Return: true if all devices are initialized, false otherwise. */ bool rproc_is_initialized(void); @@ -156,35 +156,35 @@ bool rproc_is_initialized(void); * @id: id of the remote processor * @addr: address in memory where the image is located * @size: size of the image - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_load(int id, ulong addr, ulong size); /** * rproc_start() - Start a remote processor * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_start(int id); /** * rproc_stop() - Stop a remote processor * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_stop(int id); /** * rproc_reset() - reset a remote processor * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_reset(int id); /** * rproc_ping() - ping a remote processor to check if it can communicate * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. * * NOTE: this might need communication path available, which is not implemented * as part of remoteproc framework - hook on to appropriate bus architecture to @@ -195,7 +195,7 @@ int rproc_ping(int id); /** * rproc_is_running() - check to see if remote processor is running * @id: id of the remote processor - * @return 0 if running, 1 if not running, -ve on error. + * Return: 0 if running, 1 if not running, -ve on error. * * NOTE: this may not involve actual communication capability of the remote * processor, but just ensures that it is out of reset and executing code. @@ -210,7 +210,7 @@ int rproc_is_running(int id); * * @addr: address of the image to verify * @size: size of the image - * @return 0 if the image looks good, else appropriate error value. + * Return: 0 if the image looks good, else appropriate error value. */ int rproc_elf32_sanity_check(ulong addr, ulong size); @@ -222,7 +222,7 @@ int rproc_elf32_sanity_check(ulong addr, ulong size); * * @addr: address of the image to verify * @size: size of the image - * @return 0 if the image looks good, else appropriate error value. + * Return: 0 if the image looks good, else appropriate error value. */ int rproc_elf64_sanity_check(ulong addr, ulong size); @@ -231,7 +231,7 @@ int rproc_elf64_sanity_check(ulong addr, ulong size); * @dev: device loading the ELF32 image * @addr: valid ELF32 image address * @size: size of the image - * @return 0 if the image is successfully loaded, else appropriate error value. + * Return: 0 if the image is successfully loaded, else appropriate error value. */ int rproc_elf32_load_image(struct udevice *dev, unsigned long addr, ulong size); @@ -240,7 +240,7 @@ int rproc_elf32_load_image(struct udevice *dev, unsigned long addr, ulong size); * @dev: device loading the ELF64 image * @addr: valid ELF64 image address * @size: size of the image - * @return 0 if the image is successfully loaded, else appropriate error value. + * Return: 0 if the image is successfully loaded, else appropriate error value. */ int rproc_elf64_load_image(struct udevice *dev, ulong addr, ulong size); @@ -251,7 +251,7 @@ int rproc_elf64_load_image(struct udevice *dev, ulong addr, ulong size); * @size: size of the image * * Auto detects if the image is ELF32 or ELF64 image and load accordingly. - * @return 0 if the image is successfully loaded, else appropriate error value. + * Return: 0 if the image is successfully loaded, else appropriate error value. */ int rproc_elf_load_image(struct udevice *dev, unsigned long addr, ulong size); @@ -279,7 +279,7 @@ ulong rproc_elf_get_boot_addr(struct udevice *dev, ulong addr); * @rsc_size: pointer to the found resource table size. Updated on operation * success * - * @return 0 if a valid resource table is successfully loaded, -ENODATA if there + * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there * is no resource table (which is optional), or another appropriate error value. */ int rproc_elf32_load_rsc_table(struct udevice *dev, ulong fw_addr, @@ -298,7 +298,7 @@ int rproc_elf32_load_rsc_table(struct udevice *dev, ulong fw_addr, * @rsc_size: pointer to the found resource table size. Updated on operation * success * - * @return 0 if a valid resource table is successfully loaded, -ENODATA if there + * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there * is no resource table (which is optional), or another appropriate error value. */ int rproc_elf64_load_rsc_table(struct udevice *dev, ulong fw_addr, @@ -317,7 +317,7 @@ int rproc_elf64_load_rsc_table(struct udevice *dev, ulong fw_addr, * @rsc_size: pointer to the found resource table size. Updated on operation * success * - * @return 0 if a valid resource table is successfully loaded, -ENODATA if there + * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there * is no resource table (which is optional), or another appropriate error value. */ int rproc_elf_load_rsc_table(struct udevice *dev, ulong fw_addr, diff --git a/include/reset.h b/include/reset.h index cde2c4b..965f02e 100644 --- a/include/reset.h +++ b/include/reset.h @@ -190,7 +190,7 @@ struct reset_ctl_bulk *devm_reset_bulk_get_optional_by_node(struct udevice *dev, * @index: The index of the reset signal to request, within the client's * list of reset signals. * @reset_ctl A pointer to a reset control struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_by_index(struct udevice *dev, int index, struct reset_ctl *reset_ctl); @@ -205,7 +205,7 @@ int reset_get_by_index(struct udevice *dev, int index, * @index: The index of the reset signal to request, within the client's * list of reset signals. * @reset_ctl A pointer to a reset control struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_by_index_nodev(ofnode node, int index, struct reset_ctl *reset_ctl); @@ -222,7 +222,7 @@ int reset_get_by_index_nodev(ofnode node, int index, * * @dev: The client device. * @bulk A pointer to a reset control bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk); @@ -240,7 +240,7 @@ int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk); * @name: The name of the reset signal to request, within the client's * list of reset signals. * @reset_ctl: A pointer to a reset control struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_by_name(struct udevice *dev, const char *name, struct reset_ctl *reset_ctl); @@ -250,7 +250,7 @@ int reset_get_by_name(struct udevice *dev, const char *name, * * @reset_ctl: A reset control struct. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_request(struct reset_ctl *reset_ctl); @@ -259,7 +259,7 @@ int reset_request(struct reset_ctl *reset_ctl); * * @reset_ctl: A reset control struct that was previously successfully * requested by reset_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_free(struct reset_ctl *reset_ctl); @@ -273,7 +273,7 @@ int reset_free(struct reset_ctl *reset_ctl); * * @reset_ctl: A reset control struct that was previously successfully * requested by reset_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_assert(struct reset_ctl *reset_ctl); @@ -288,7 +288,7 @@ int reset_assert(struct reset_ctl *reset_ctl); * * @bulk: A reset control bulk struct that was previously successfully * requested by reset_get_bulk(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_assert_bulk(struct reset_ctl_bulk *bulk); @@ -301,7 +301,7 @@ int reset_assert_bulk(struct reset_ctl_bulk *bulk); * * @reset_ctl: A reset control struct that was previously successfully * requested by reset_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_deassert(struct reset_ctl *reset_ctl); @@ -315,7 +315,7 @@ int reset_deassert(struct reset_ctl *reset_ctl); * * @bulk: A reset control bulk struct that was previously successfully * requested by reset_get_bulk(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_deassert_bulk(struct reset_ctl_bulk *bulk); @@ -323,7 +323,7 @@ int reset_deassert_bulk(struct reset_ctl_bulk *bulk); * rst_status - Check reset signal status. * * @reset_ctl: The reset signal to check. - * @return 0 if deasserted, positive if asserted, or a negative + * Return: 0 if deasserted, positive if asserted, or a negative * error code. */ int reset_status(struct reset_ctl *reset_ctl); @@ -337,7 +337,7 @@ int reset_status(struct reset_ctl *reset_ctl); * @reset_ctl: A reset struct array that was previously successfully * requested by reset_get_by_*(). * @count Number of reset contained in the array - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_release_all(struct reset_ctl *reset_ctl, int count); @@ -351,7 +351,7 @@ int reset_release_all(struct reset_ctl *reset_ctl, int count); * * @bulk: A reset control bulk struct that was previously successfully * requested by reset_get_bulk(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ static inline int reset_release_bulk(struct reset_ctl_bulk *bulk) { @@ -462,7 +462,7 @@ static inline int reset_release_bulk(struct reset_ctl_bulk *bulk) * reset_valid() - check if reset is valid * * @reset_ctl: the reset to check - * @return TRUE if valid, or FALSE + * Return: TRUE if valid, or FALSE */ static inline bool reset_valid(struct reset_ctl *reset_ctl) { diff --git a/include/rtc.h b/include/rtc.h index 1efc0db..6c7fcad 100644 --- a/include/rtc.h +++ b/include/rtc.h @@ -94,7 +94,7 @@ struct rtc_ops { * @dev: Device to write to * @reg: Register to write * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int (*write8)(struct udevice *dev, unsigned int reg, int val); }; @@ -107,7 +107,7 @@ struct rtc_ops { * * @dev: Device to read from * @time: Place to put the current time - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_get(struct udevice *dev, struct rtc_time *time); @@ -116,7 +116,7 @@ int dm_rtc_get(struct udevice *dev, struct rtc_time *time); * * @dev: Device to read from * @time: Time to write into the RTC - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_set(struct udevice *dev, struct rtc_time *time); @@ -129,7 +129,7 @@ int dm_rtc_set(struct udevice *dev, struct rtc_time *time); * the caller. * * @dev: Device to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_reset(struct udevice *dev); @@ -140,7 +140,7 @@ int dm_rtc_reset(struct udevice *dev); * @reg: First register to read * @buf: Output buffer * @len: Number of registers to read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf, unsigned int len); @@ -151,7 +151,7 @@ int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf, unsigned int len * @reg: First register to write * @buf: Input buffer * @len: Number of registers to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_write(struct udevice *dev, unsigned int reg, const u8 *buf, unsigned int len); @@ -161,7 +161,7 @@ int dm_rtc_write(struct udevice *dev, unsigned int reg, * * @dev: Device to read from * @reg: Register to read - * @return value read, or -ve on error + * Return: value read, or -ve on error */ int rtc_read8(struct udevice *dev, unsigned int reg); @@ -171,7 +171,7 @@ int rtc_read8(struct udevice *dev, unsigned int reg); * @dev: Device to write to * @reg: Register to write * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_write8(struct udevice *dev, unsigned int reg, int val); @@ -181,7 +181,7 @@ int rtc_write8(struct udevice *dev, unsigned int reg, int val); * @dev: Device to read from * @reg: Offset to start reading from * @valuep: Place to put the value that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep); @@ -191,7 +191,7 @@ int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep); * @dev: Device to write to * @reg: Register to start writing to * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_write16(struct udevice *dev, unsigned int reg, u16 value); @@ -201,7 +201,7 @@ int rtc_write16(struct udevice *dev, unsigned int reg, u16 value); * @dev: Device to read from * @reg: Offset to start reading from * @valuep: Place to put the value that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep); @@ -211,7 +211,7 @@ int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep); * @dev: Device to write to * @reg: Register to start writing to * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_write32(struct udevice *dev, unsigned int reg, u32 value); @@ -231,7 +231,7 @@ void rtc_enable_32khz_output(void); * rtc_read8() - Read an 8-bit register * * @reg: Register to read - * @return value read + * Return: value read */ int rtc_read8(int reg); @@ -247,7 +247,7 @@ void rtc_write8(int reg, uchar val); * rtc_read32() - Read a 32-bit value from the RTC * * @reg: Offset to start reading from - * @return value read + * Return: value read */ u32 rtc_read32(int reg); @@ -269,7 +269,7 @@ void rtc_init(void); * is_leap_year - Check if year is a leap year * * @year Year - * @return 1 if leap year + * Return: 1 if leap year */ static inline bool is_leap_year(unsigned int year) { @@ -283,7 +283,7 @@ static inline bool is_leap_year(unsigned int year) * It sets time->tm_wdaay to the correct day of the week. * * @time: Time to inspect. tm_wday is updated - * @return 0 if OK, -EINVAL if the weekday could not be determined + * Return: 0 if OK, -EINVAL if the weekday could not be determined */ int rtc_calc_weekday(struct rtc_time *time); @@ -309,7 +309,7 @@ void rtc_to_tm(u64 time_t, struct rtc_time *time); * Note that tm_wday and tm_yday are ignored. * * @time: Broken-out time to convert - * @return corresponding time_t value, seconds since 1970-01-01 00:00:00 + * Return: corresponding time_t value, seconds since 1970-01-01 00:00:00 */ unsigned long rtc_mktime(const struct rtc_time *time); diff --git a/include/scmi_agent.h b/include/scmi_agent.h index ed40c73..5015c06 100644 --- a/include/scmi_agent.h +++ b/include/scmi_agent.h @@ -53,7 +53,7 @@ struct scmi_msg { * * @dev: SCMI agent device * @msg: Message structure reference - * @return 0 on success and a negative errno on failure + * Return: 0 on success and a negative errno on failure */ int devm_scmi_process_msg(struct udevice *dev, struct scmi_msg *msg); @@ -61,7 +61,7 @@ int devm_scmi_process_msg(struct udevice *dev, struct scmi_msg *msg); * scmi_to_linux_errno() - Convert an SCMI error code into a Linux errno code * * @scmi_errno: SCMI error code value - * @return 0 for successful status and a negative errno otherwise + * Return: 0 for successful status and a negative errno otherwise */ int scmi_to_linux_errno(s32 scmi_errno); diff --git a/include/scsi.h b/include/scsi.h index 0a475a8..66a2caa 100644 --- a/include/scsi.h +++ b/include/scsi.h @@ -207,7 +207,7 @@ extern struct scsi_ops scsi_ops; * * @dev: SCSI bus * @cmd: Command to execute - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd); @@ -215,7 +215,7 @@ int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd); * scsi_bus_reset() - reset the bus * * @dev: SCSI bus to reset - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int scsi_bus_reset(struct udevice *dev); diff --git a/include/sdhci.h b/include/sdhci.h index c718dd7..c8d69f5 100644 --- a/include/sdhci.h +++ b/include/sdhci.h @@ -470,7 +470,7 @@ int sdhci_setup_cfg(struct mmc_config *cfg, struct sdhci_host *host, * @cfg: Empty configuration structure (generally &plat->cfg). This is * normally all zeroes at this point. The only purpose of passing * this in is to set mmc->cfg to it. - * @return 0 if OK, -ve if the block device could not be created + * Return: 0 if OK, -ve if the block device could not be created */ int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); #else @@ -483,7 +483,7 @@ int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); * @host: SDHCI host structure * @f_max: Maximum supported clock frequency in HZ (0 for default) * @f_min: Minimum supported clock frequency in HZ (0 for default) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int add_sdhci(struct sdhci_host *host, u32 f_max, u32 f_min); #endif /* !CONFIG_BLK */ diff --git a/include/search.h b/include/search.h index d0bb443..7faf23f 100644 --- a/include/search.h +++ b/include/search.h @@ -86,7 +86,7 @@ int hmatch_r(const char *match, int last_idx, struct env_entry **retval, * @key: Name of entry to delete * @htab: Hash table * @flag: Flags to use (H_...) - * @return 0 on success, -ENOENT if not found, -EPERM if the hash table callback + * Return: 0 on success, -ENOENT if not found, -EPERM if the hash table callback * rejected changing the variable, -EINVAL if the hash table refused to * delete the variable */ diff --git a/include/serial.h b/include/serial.h index 6d1e62c..19a8c0c 100644 --- a/include/serial.h +++ b/include/serial.h @@ -293,7 +293,7 @@ struct serial_dev_priv { * * @dev: Device pointer * @serial_config: Returns config information (see SERIAL_... above) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int serial_getconfig(struct udevice *dev, uint *config); @@ -305,7 +305,7 @@ int serial_getconfig(struct udevice *dev, uint *config); * * @dev: Device pointer * @serial_config: number of bits, parity and number of stopbits to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int serial_setconfig(struct udevice *dev, uint config); @@ -314,7 +314,7 @@ int serial_setconfig(struct udevice *dev, uint config); * * @dev: Device pointer * @info: struct serial_device_info to fill - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int serial_getinfo(struct udevice *dev, struct serial_device_info *info); @@ -333,7 +333,7 @@ void sh_serial_initialize(void); * The total size of the output must be less than CONFIG_SYS_PBSIZE. * * @fmt: Printf format string, followed by format arguments - * @return number of characters written + * Return: number of characters written */ int serial_printf(const char *fmt, ...) __attribute__ ((format (__printf__, 1, 2))); diff --git a/include/smbios.h b/include/smbios.h index acfcbfe..c9df270 100644 --- a/include/smbios.h +++ b/include/smbios.h @@ -271,7 +271,7 @@ char *smbios_string(const struct smbios_header *header, int index); * main loop has started) to update the BIOS version string (SMBIOS table 0). * * @version: New version string to use - * @return 0 if OK, -ENOENT if no version string was previously written, + * Return: 0 if OK, -ENOENT if no version string was previously written, * -ENOSPC if the new string is too large to fit */ int smbios_update_version(const char *version); @@ -287,7 +287,7 @@ int smbios_update_version(const char *version); * * @smbios_tab: Start of SMBIOS tables * @version: New version string to use - * @return 0 if OK, -ENOENT if no version string was previously written, + * Return: 0 if OK, -ENOENT if no version string was previously written, * -ENOSPC if the new string is too large to fit */ int smbios_update_version_full(void *smbios_tab, const char *version); diff --git a/include/smem.h b/include/smem.h index 83da9e1..b19c534 100644 --- a/include/smem.h +++ b/include/smem.h @@ -57,7 +57,7 @@ struct smem_ops { * @host: remote processor id, or -1 * @item: smem item handle * @size: number of bytes to be allocated - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error * * Allocate space for a given smem item of size @size, given that the item is * not yet allocated. @@ -69,7 +69,7 @@ int smem_alloc(struct udevice *dev, unsigned int host, unsigned int item, size_t * @host: the remote processor, or -1 for all processors. * @item: smem item handle * @size: pointer to be filled out with size of the item - * @return pointer on success, NULL on error + * Return: pointer on success, NULL on error * * Looks up smem item and returns pointer to it. Size of smem * item is returned in @size. @@ -80,7 +80,7 @@ void *smem_get(struct udevice *dev, unsigned int host, unsigned int item, size_t * smem_get_free_space() - retrieve amount of free space in a partition * @host: the remote processor identifying a partition, or -1 * for all processors. - * @return size in bytes, -ve on error + * Return: size in bytes, -ve on error * * To be used by smem clients as a quick way to determine if any new * allocations has been made. diff --git a/include/sort.h b/include/sort.h index 0c6b588..76483cf 100644 --- a/include/sort.h +++ b/include/sort.h @@ -27,7 +27,7 @@ void qsort(void *base, size_t nmemb, size_t size, * * @s1: First string to compare * @s2: Second string to compare - * @return comparison value (less than, equal to, or greater than 0) + * Return: comparison value (less than, equal to, or greater than 0) */ int strcmp_compar(const void *s1, const void *s2); diff --git a/include/sound.h b/include/sound.h index 71bd850..dab9ea1 100644 --- a/include/sound.h +++ b/include/sound.h @@ -116,7 +116,7 @@ int sound_setup(struct udevice *dev); * @dev: Sound device * @msecs: Duration of beep in milliseconds * @frequency_hz: Frequency of the beep in Hertz - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sound_beep(struct udevice *dev, int msecs, int frequency_hz); @@ -128,7 +128,7 @@ int sound_beep(struct udevice *dev, int msecs, int frequency_hz); * * @dev: Sound device * @frequency_hz: Beep frequency in hertz - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int sound_start_beep(struct udevice *dev, int frequency_hz); @@ -138,7 +138,7 @@ int sound_start_beep(struct udevice *dev, int frequency_hz); * This tells the sound hardware to stop a previously started beep. * * @dev: Sound device - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int sound_stop_beep(struct udevice *dev); diff --git a/include/spi.h b/include/spi.h index dc3b211..fa9ab12 100644 --- a/include/spi.h +++ b/include/spi.h @@ -561,7 +561,7 @@ struct dm_spi_emul_ops { * @cs: Chip select to look for * @busp: Returns bus device * @devp: Return slave device - * @return 0 if found, -ENODEV on error + * Return: 0 if found, -ENODEV on error */ int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp, struct udevice **devp); @@ -586,7 +586,7 @@ int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp, * @dev_name: Name of the new device thus created * @busp: Returns bus device * @devp: Return slave device - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode, const char *drv_name, const char *dev_name, @@ -595,7 +595,7 @@ int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode, /** * spi_chip_select() - Get the chip select for a slave * - * @return the chip select this slave is attached to + * Return: the chip select this slave is attached to */ int spi_chip_select(struct udevice *slave); @@ -605,7 +605,7 @@ int spi_chip_select(struct udevice *slave); * @bus: SPI bus to search * @cs: Chip select to look for * @devp: Returns the slave device if found - * @return 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached, + * Return: 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached, * other -ve value on error */ int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp); @@ -630,7 +630,7 @@ int spi_slave_of_to_plat(struct udevice *dev, struct dm_spi_slave_plat *plat); * @bus: The SPI bus * @cs: The chip select (0..n-1) * @info: Returns information about the chip select, if valid - * @return 0 if OK (and @info is set up), -ENODEV if the chip select + * Return: 0 if OK (and @info is set up), -ENODEV if the chip select * is invalid, other -ve value on error */ int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info); @@ -649,7 +649,7 @@ struct sandbox_state; * @bus: SPI bus requesting the emulator * @slave: SPI slave device requesting the emulator * @emuip: Returns pointer to emulator - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sandbox_spi_get_emul(struct sandbox_state *state, struct udevice *bus, struct udevice *slave, @@ -715,7 +715,7 @@ int dm_spi_xfer(struct udevice *dev, unsigned int bitlen, * @map_sizep: Returns size of mapped SPI * @offsetp: Returns start offset of SPI flash where the map works * correctly (offsets before this are not visible) - * @return 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not + * Return: 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not * available */ int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep, diff --git a/include/spi_flash.h b/include/spi_flash.h index 4566fea..d33d0dd 100644 --- a/include/spi_flash.h +++ b/include/spi_flash.h @@ -47,7 +47,7 @@ struct dm_spi_flash_ops { * @offset: Offset into device in bytes to read from * @len: Number of bytes to read * @buf: Buffer to put the data that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); @@ -58,7 +58,7 @@ int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); * @offset: Offset into device in bytes to write to * @len: Number of bytes to write * @buf: Buffer containing bytes to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, const void *buf); @@ -71,7 +71,7 @@ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, * @dev: SPI flash device * @offset: Offset into device in bytes to start erasing * @len: Number of bytes to erase - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); @@ -83,7 +83,7 @@ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); * defined. * * @dev: SPI flash device - * @return 0 if no region is write-protected, 1 if a region is + * Return: 0 if no region is write-protected, 1 if a region is * write-protected, -ENOSYS if the driver does not implement this, * other -ve value on error */ @@ -97,7 +97,7 @@ int spl_flash_get_sw_write_prot(struct udevice *dev); * do this, typically with of-platdata * * @dev: SPI-flash device to probe - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_std_probe(struct udevice *dev); diff --git a/include/spl.h b/include/spl.h index 0af0ee3..9fc5ac6 100644 --- a/include/spl.h +++ b/include/spl.h @@ -106,7 +106,7 @@ enum u_boot_phase { * ... * } * - * @return U-Boot phase + * Return: U-Boot phase */ static inline enum u_boot_phase spl_phase(void) { @@ -127,7 +127,7 @@ static inline enum u_boot_phase spl_phase(void) /** * spl_prev_phase() - Figure out the previous U-Boot phase * - * @return the previous phase from this one, e.g. if called in SPL this returns + * Return: the previous phase from this one, e.g. if called in SPL this returns * PHASE_TPL, if TPL is enabled */ static inline enum u_boot_phase spl_prev_phase(void) @@ -144,7 +144,7 @@ static inline enum u_boot_phase spl_prev_phase(void) /** * spl_next_phase() - Figure out the next U-Boot phase * - * @return the next phase from this one, e.g. if called in TPL this returns + * Return: the next phase from this one, e.g. if called in TPL this returns * PHASE_SPL */ static inline enum u_boot_phase spl_next_phase(void) @@ -159,7 +159,7 @@ static inline enum u_boot_phase spl_next_phase(void) /** * spl_phase_name() - Get the name of the current phase * - * @return phase name + * Return: phase name */ static inline const char *spl_phase_name(enum u_boot_phase phase) { @@ -180,7 +180,7 @@ static inline const char *spl_phase_name(enum u_boot_phase phase) * spl_phase_prefix() - Get the prefix of the current phase * * @phase: Phase to look up - * @return phase prefix ("spl", "tpl", etc.) + * Return: phase prefix ("spl", "tpl", etc.) */ static inline const char *spl_phase_prefix(enum u_boot_phase phase) { @@ -291,7 +291,7 @@ ulong spl_get_image_size(void); * This returns the address that the next stage is linked to run at, i.e. * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE * - * @return text-base address + * Return: text-base address */ ulong spl_get_image_text_base(void); @@ -435,7 +435,7 @@ void spl_set_header_raw_uboot(struct spl_image_info *spl_image); * * @spl_image: Image description to set up * @header image header to parse - * @return 0 if a header was correctly parsed, -ve on error + * Return: 0 if a header was correctly parsed, -ve on error */ int spl_parse_image_header(struct spl_image_info *spl_image, const struct image_header *header); @@ -484,7 +484,7 @@ void __noreturn jump_to_image_optee(struct spl_image_info *spl_image); * wants to load the kernel or U-Boot. This function should be provided by * the board. * - * @return 0 if SPL should start the kernel, 1 if U-Boot must be started + * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started */ int spl_start_uboot(void); @@ -628,7 +628,7 @@ void spl_board_init(void); * This will normally be true, but if U-Boot jumps to second U-Boot, it will * be false. This should be implemented by board-specific code. * - * @return true if U-Boot booted from SPL, else false + * Return: true if U-Boot booted from SPL, else false */ bool spl_was_boot_source(void); @@ -637,7 +637,7 @@ bool spl_was_boot_source(void); * @param usb_index - usb controller number * @param mmc_dev - mmc device nubmer * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); @@ -653,7 +653,7 @@ int spl_mmc_load_image(struct spl_image_info *spl_image, * @param raw_part Partition to load from (in RAW mode) * @param raw_sect Sector to load from (in RAW mode) * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int spl_mmc_load(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, @@ -669,7 +669,7 @@ int spl_mmc_load(struct spl_image_info *spl_image, * @param raw_part Fat partition to load from * @param filename Name of file to load * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int spl_usb_load(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, diff --git a/include/spl_gpio.h b/include/spl_gpio.h index e410e62..e39ac3f 100644 --- a/include/spl_gpio.h +++ b/include/spl_gpio.h @@ -36,7 +36,7 @@ * @regs: Pointer to GPIO registers * @gpio: GPIO to adjust (SoC-specific) * @pull: Pull value (SoC-specific) - * @return return 0 if OK, -ve on error + * Return: return 0 if OK, -ve on error */ int spl_gpio_set_pull(void *regs, uint gpio, int pull); @@ -46,7 +46,7 @@ int spl_gpio_set_pull(void *regs, uint gpio, int pull); * @regs: Pointer to GPIO registers * @gpio: GPIO to adjust (SoC-specific) * @value: 0 to set the output low, 1 to set it high - * @return return 0 if OK, -ve on error + * Return: return 0 if OK, -ve on error */ int spl_gpio_output(void *regs, uint gpio, int value); @@ -55,7 +55,7 @@ int spl_gpio_output(void *regs, uint gpio, int value); * * @regs: Pointer to GPIO registers * @gpio: GPIO to adjust (SoC-specific) - * @return return 0 if OK, -ve on error + * Return: return 0 if OK, -ve on error */ int spl_gpio_input(void *regs, uint gpio); diff --git a/include/spmi/spmi.h b/include/spmi/spmi.h index 3242e6b..3f8bba1 100644 --- a/include/spmi/spmi.h +++ b/include/spmi/spmi.h @@ -26,7 +26,7 @@ struct dm_spmi_ops { * @usid SlaveID * @pid Peripheral ID * @reg: Register to read - * @return value read on success or negative value of errno. + * Return: value read on success or negative value of errno. */ int spmi_reg_read(struct udevice *dev, int usid, int pid, int reg); @@ -38,7 +38,7 @@ int spmi_reg_read(struct udevice *dev, int usid, int pid, int reg); * @pid Peripheral ID * @reg: Register to write * @value: Value to write - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int spmi_reg_write(struct udevice *dev, int usid, int pid, int reg, uint8_t value); diff --git a/include/syscon.h b/include/syscon.h index 2e02199..f5e6cc1 100644 --- a/include/syscon.h +++ b/include/syscon.h @@ -43,7 +43,7 @@ struct syscon_base_plat { * * @dev: Device to check (UCLASS_SCON) * @info: Returns regmap for the device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ struct regmap *syscon_get_regmap(struct udevice *dev); @@ -56,7 +56,7 @@ struct regmap *syscon_get_regmap(struct udevice *dev); * * @driver_data: Driver data value to look up * @devp: Returns the controller correponding to @driver_data - * @return 0 on success, -ENODEV if the ID was not found, or other -ve error + * Return: 0 on success, -ENODEV if the ID was not found, or other -ve error * code */ int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp); @@ -69,7 +69,7 @@ int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp); * are in use. This function looks up the regmap given this driver data. * * @driver_data: Driver data value to look up - * @return register map correponding to @driver_data, or -ve error code + * Return: register map correponding to @driver_data, or -ve error code */ struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data); @@ -81,7 +81,7 @@ struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data); * * @dev: Device using the system controller * @name: Name of property referring to the system controller - * @return A pointer to the regmap if found, ERR_PTR(-ve) on error + * Return: A pointer to the regmap if found, ERR_PTR(-ve) on error */ struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev, const char *name); @@ -90,7 +90,7 @@ struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev, * syscon_get_first_range() - get the first memory range from a syscon regmap * * @driver_data: Driver data value to look up - * @return first region of register map correponding to @driver_data, or + * Return: first region of register map correponding to @driver_data, or * -ve error code */ void *syscon_get_first_range(ulong driver_data); diff --git a/include/test/suites.h b/include/test/suites.h index d35cd83..6553a76 100644 --- a/include/test/suites.h +++ b/include/test/suites.h @@ -20,7 +20,7 @@ struct unit_test; * @argc: Argument count provided. Must be >= 1. If this is 1 then all * tests are run, otherwise only the one named @argv[1] is run. * @argv: Arguments: argv[1] is the test to run (if @argc >= 2) - * @return 0 if OK, CMD_RET_FAILURE on failure + * Return: 0 if OK, CMD_RET_FAILURE on failure */ int cmd_ut_category(const char *name, const char *prefix, struct unit_test *tests, int n_ents, diff --git a/include/test/ut.h b/include/test/ut.h index fb2e5fc..18740f5 100644 --- a/include/test/ut.h +++ b/include/test/ut.h @@ -52,7 +52,7 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line, * * @uts: Test state * @fmt: printf() format string for the error, followed by args - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...) __attribute__ ((format (__printf__, 2, 3))); @@ -69,7 +69,7 @@ int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...) * * @uts: Test state * @fmt: printf() format string for the error, followed by args - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...) __attribute__ ((format (__printf__, 2, 3))); @@ -78,7 +78,7 @@ int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...) * ut_check_skipline() - Check that the next console line exists and skip it * * @uts: Test state - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int ut_check_skipline(struct unit_test_state *uts); @@ -93,7 +93,7 @@ int ut_check_skipline(struct unit_test_state *uts); * * @uts: Test state * @fmt: printf() format string to look for, followed by args - * @return 0 if OK, -ENOENT if not found, other value on error + * Return: 0 if OK, -ENOENT if not found, other value on error */ int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...); @@ -104,7 +104,7 @@ int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...); * from the console * * @uts: Test state - * @return 0 if OK (console has no output), other value on error + * Return: 0 if OK (console has no output), other value on error */ int ut_check_console_end(struct unit_test_state *uts); @@ -114,7 +114,7 @@ int ut_check_console_end(struct unit_test_state *uts); * This only supports a byte dump. * * @total_bytes: Size of the expected dump in bytes` - * @return 0 if OK (looks like a dump and the length matches), other value on + * Return: 0 if OK (looks like a dump and the length matches), other value on * error */ int ut_check_console_dump(struct unit_test_state *uts, int total_bytes); @@ -332,7 +332,7 @@ int ut_check_console_dump(struct unit_test_state *uts, int total_bytes); /** * ut_check_free() - Return the number of bytes free in the malloc() pool * - * @return bytes free + * Return: bytes free */ ulong ut_check_free(void); @@ -340,7 +340,7 @@ ulong ut_check_free(void); * ut_check_delta() - Return the number of bytes allocated/freed * * @last: Last value from ut_check_free - * @return free memory delta from @last; positive means more memory has been + * Return: free memory delta from @last; positive means more memory has been * allocated, negative means less has been allocated (i.e. some is freed) */ long ut_check_delta(ulong last); @@ -377,7 +377,7 @@ void ut_set_skip_delays(struct unit_test_state *uts, bool skip_delays); /** * test_get_state() - Get the active test state * - * @return the currently active test state, or NULL if none + * Return: the currently active test state, or NULL if none */ struct unit_test_state *test_get_state(void); @@ -403,7 +403,7 @@ void test_set_state(struct unit_test_state *uts); * @count: Number of tests to run * @select_name: Name of a single test to run (from the list provided). If NULL * then all tests are run - * @return 0 if all tests passed, -1 if any failed + * Return: 0 if all tests passed, -1 if any failed */ int ut_run_list(const char *name, const char *prefix, struct unit_test *tests, int count, const char *select_name); diff --git a/include/time.h b/include/time.h index 3f00e68..9deb2cf 100644 --- a/include/time.h +++ b/include/time.h @@ -24,7 +24,7 @@ uint64_t get_timer_us(uint64_t base); * delays of over an hour. For 64-bit machines it uses a 64-bit value. * *@base: Base time to consider - *@return elapsed time since @base + *Return: elapsed time since @base */ unsigned long get_timer_us_long(unsigned long base); @@ -87,7 +87,7 @@ uint64_t usec_to_tick(unsigned long usec); * usec2ticks() - Convert microseconds to internal ticks * * @usec: Value of microseconds to convert - * @return Corresponding internal ticks value, calculated using get_tbclk() + * Return: Corresponding internal ticks value, calculated using get_tbclk() */ ulong usec2ticks(unsigned long usec); @@ -95,7 +95,7 @@ ulong usec2ticks(unsigned long usec); * ticks2usec() - Convert internal ticks to microseconds * * @ticks: Value of ticks to convert - * @return Corresponding microseconds value, calculated using get_tbclk() + * Return: Corresponding microseconds value, calculated using get_tbclk() */ ulong ticks2usec(unsigned long ticks); @@ -112,7 +112,7 @@ void wait_ticks(unsigned long ticks); /** * timer_get_us() - Get monotonic microsecond timer * - * @return value of monotonic microsecond timer + * Return: value of monotonic microsecond timer */ unsigned long timer_get_us(void); @@ -122,7 +122,7 @@ unsigned long timer_get_us(void); * This is an internal value used by the timer on the system. Ticks increase * monotonically at the rate given by get_tbclk(). * - * @return current tick value + * Return: current tick value */ uint64_t get_ticks(void); diff --git a/include/tmu.h b/include/tmu.h index da07a22..f4389f8 100644 --- a/include/tmu.h +++ b/include/tmu.h @@ -31,7 +31,7 @@ enum tmu_status_t { * Monitors status of the TMU device and exynos temperature * * @param temp pointer to the current temperature value - * @return enum tmu_status_t value, code indicating event to execute + * Return: enum tmu_status_t value, code indicating event to execute * and -1 on error */ enum tmu_status_t tmu_monitor(int *temp); @@ -40,7 +40,7 @@ enum tmu_status_t tmu_monitor(int *temp); * Initialize TMU device * * @param blob FDT blob - * @return int value, 0 for success + * Return: int value, 0 for success */ int tmu_init(const void *blob); #endif /* _THERMAL_H_ */ diff --git a/include/tpm-common.h b/include/tpm-common.h index 998b4fb..a28629e 100644 --- a/include/tpm-common.h +++ b/include/tpm-common.h @@ -220,7 +220,7 @@ int tpm_close(struct udevice *dev); * tpm_clear_and_reenable() - Force clear the TPM and reenable it * * @dev: TPM device - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ u32 tpm_clear_and_reenable(struct udevice *dev); @@ -230,7 +230,7 @@ u32 tpm_clear_and_reenable(struct udevice *dev); * @dev: Device to check * @buf: Buffer to put the string * @size: Maximum size of buffer - * @return length of string, or -ENOSPC it no space + * Return: length of string, or -ENOSPC it no space */ int tpm_get_desc(struct udevice *dev, char *buf, int size); @@ -263,14 +263,14 @@ int tpm_xfer(struct udevice *dev, const u8 *sendbuf, size_t send_size, * Initialize TPM device. It must be called before any TPM commands. * * @dev - TPM device - * @return 0 on success, non-0 on error. + * Return: 0 on success, non-0 on error. */ int tpm_init(struct udevice *dev); /** * Retrieve the array containing all the v1 (resp. v2) commands. * - * @return a struct cmd_tbl array. + * Return: a struct cmd_tbl array. */ #if defined(CONFIG_TPM_V1) struct cmd_tbl *get_tpm1_commands(unsigned int *size); @@ -296,7 +296,7 @@ static inline struct cmd_tbl *get_tpm2_commands(unsigned int *size) * it supports. * * @dev: TPM device - * @return version number (TPM_V1 or TPMV2) + * Return: version number (TPM_V1 or TPMV2) */ enum tpm_version tpm_get_version(struct udevice *dev); diff --git a/include/tpm-v1.h b/include/tpm-v1.h index fcfe1f0..33d53fb 100644 --- a/include/tpm-v1.h +++ b/include/tpm-v1.h @@ -287,7 +287,7 @@ struct __packed tpm_nv_data_public { * * @param dev TPM device * @param mode TPM startup mode - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_startup(struct udevice *dev, enum tpm_startup_type mode); @@ -295,7 +295,7 @@ u32 tpm1_startup(struct udevice *dev, enum tpm_startup_type mode); * Issue a TPM_SelfTestFull command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_self_test_full(struct udevice *dev); @@ -303,7 +303,7 @@ u32 tpm1_self_test_full(struct udevice *dev); * Issue a TPM_ContinueSelfTest command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_continue_self_test(struct udevice *dev); @@ -316,7 +316,7 @@ u32 tpm1_continue_self_test(struct udevice *dev); * @param index index of the area * @param perm TPM_NV_ATTRIBUTES of the area * @param size size of the area - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); @@ -329,7 +329,7 @@ u32 tpm1_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); * @param index index of the area * @param data output buffer of the area contents * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); @@ -342,7 +342,7 @@ u32 tpm1_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @param index index of the area * @param data input buffer to be wrote to the area * @param length length of data bytes of input buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_nv_write_value(struct udevice *dev, u32 index, const void *data, u32 length); @@ -356,7 +356,7 @@ u32 tpm1_nv_write_value(struct udevice *dev, u32 index, const void *data, * recorded * @param out_digest 160-bit PCR value after execution of the * command - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_extend(struct udevice *dev, u32 index, const void *in_digest, void *out_digest); @@ -368,7 +368,7 @@ u32 tpm1_extend(struct udevice *dev, u32 index, const void *in_digest, * @param index index of the PCR * @param data output buffer for contents of the named PCR * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); @@ -378,7 +378,7 @@ u32 tpm1_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); * * @param dev TPM device * @param presence TPM physical presence flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_tsc_physical_presence(struct udevice *dev, u16 presence); @@ -388,7 +388,7 @@ u32 tpm1_tsc_physical_presence(struct udevice *dev, u16 presence); * @param dev TPM device * @param data output buffer for the public endorsement key * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_read_pubek(struct udevice *dev, void *data, size_t count); @@ -396,7 +396,7 @@ u32 tpm1_read_pubek(struct udevice *dev, void *data, size_t count); * Issue a TPM_ForceClear command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_force_clear(struct udevice *dev); @@ -404,7 +404,7 @@ u32 tpm1_force_clear(struct udevice *dev); * Issue a TPM_PhysicalEnable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_physical_enable(struct udevice *dev); @@ -412,7 +412,7 @@ u32 tpm1_physical_enable(struct udevice *dev); * Issue a TPM_PhysicalDisable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_physical_disable(struct udevice *dev); @@ -421,7 +421,7 @@ u32 tpm1_physical_disable(struct udevice *dev); * * @param dev TPM device * @param state boolean state of the deactivated flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_physical_set_deactivated(struct udevice *dev, u8 state); @@ -435,7 +435,7 @@ u32 tpm1_physical_set_deactivated(struct udevice *dev, u8 state); * limited to be 4-byte wide * @param cap output buffer for capability information * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, void *cap, size_t count); @@ -445,7 +445,7 @@ u32 tpm1_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, * * @param dev TPM device * @param auth_handle handle of the auth session - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_terminate_auth_session(struct udevice *dev, u32 auth_handle); @@ -458,7 +458,7 @@ u32 tpm1_terminate_auth_session(struct udevice *dev, u32 auth_handle); * * @param dev TPM device * @param auth_handle pointer to the (new) auth handle or NULL. - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_oiap(struct udevice *dev, u32 *auth_handle); @@ -466,7 +466,7 @@ u32 tpm1_oiap(struct udevice *dev, u32 *auth_handle); * Ends an active OIAP session. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_end_oiap(struct udevice *dev); @@ -480,7 +480,7 @@ u32 tpm1_end_oiap(struct udevice *dev); * @param key_length size of the key structure * @param parent_key_usage_auth usage auth for the parent key * @param key_handle pointer to the key handle - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, size_t key_length, const void *parent_key_usage_auth, @@ -498,7 +498,7 @@ u32 tpm1_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, * @param pubkey_len pointer to the pub key buffer len. On entry: the size of * the provided pubkey buffer. On successful exit: the size * of the stored TPM_PUBKEY structure (iff pubkey != NULL). - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_pub_key_oiap(struct udevice *dev, u32 key_handle, const void *usage_auth, void *pubkey, @@ -509,7 +509,7 @@ u32 tpm1_get_pub_key_oiap(struct udevice *dev, u32 key_handle, * * @param dev TPM device * @param pflags Place to put permanent flags - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_permanent_flags(struct udevice *dev, struct tpm_permanent_flags *pflags); @@ -519,7 +519,7 @@ u32 tpm1_get_permanent_flags(struct udevice *dev, * * @param dev TPM device * @param perm Returns permissions value - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_permissions(struct udevice *dev, u32 index, u32 *perm); @@ -529,7 +529,7 @@ u32 tpm1_get_permissions(struct udevice *dev, u32 index, u32 *perm); * @param dev TPM device * @param key_handle handle of the resource * @param resource_type type of the resource - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); @@ -541,7 +541,7 @@ u32 tpm1_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); * @param auth Usage auth of the key to search for * @param pubkey_digest SHA1 hash of the pub key structure of the key * @param[out] handle The handle of the key (Non-null iff found) - * @return 0 if key was found in TPM; != 0 if not. + * Return: 0 if key was found in TPM; != 0 if not. */ u32 tpm1_find_key_sha1(struct udevice *dev, const u8 auth[20], const u8 pubkey_digest[20], u32 *handle); @@ -555,7 +555,7 @@ u32 tpm1_find_key_sha1(struct udevice *dev, const u8 auth[20], * @param dev TPM device * @param data output buffer for the random bytes * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_random(struct udevice *dev, void *data, u32 count); @@ -563,7 +563,7 @@ u32 tpm1_get_random(struct udevice *dev, void *data, u32 count); * tpm_finalise_physical_presence() - Finalise physical presence * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm1_finalise_physical_presence(struct udevice *dev); @@ -571,7 +571,7 @@ u32 tpm1_finalise_physical_presence(struct udevice *dev); * tpm_nv_enable_locking() - lock the non-volatile space * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm1_nv_set_locked(struct udevice *dev); @@ -579,7 +579,7 @@ u32 tpm1_nv_set_locked(struct udevice *dev); * tpm_set_global_lock() - set the global lock * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_set_global_lock(struct udevice *dev); @@ -587,7 +587,7 @@ u32 tpm_set_global_lock(struct udevice *dev); * tpm_resume() - start up the TPM from resume (after suspend) * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm1_resume(struct udevice *dev); diff --git a/include/tpm-v2.h b/include/tpm-v2.h index 4e9dd52..e79c90b 100644 --- a/include/tpm-v2.h +++ b/include/tpm-v2.h @@ -425,7 +425,7 @@ enum { * @dev TPM device * @mode TPM startup mode * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode); @@ -435,7 +435,7 @@ u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode); * @dev TPM device * @full_test Asking to perform all tests or only the untested ones * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test); @@ -447,7 +447,7 @@ u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test); * @pw Password * @pw_sz Length of the password * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw, const ssize_t pw_sz); @@ -463,7 +463,7 @@ u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw, * @nv_attributes TPM_NV_ATTRIBUTES of the area * @nv_policy policy to use * @nv_policy_size size of the policy - * @return return code of the operation + * Return: return code of the operation */ u32 tpm2_nv_define_space(struct udevice *dev, u32 space_index, size_t space_size, u32 nv_attributes, @@ -478,7 +478,7 @@ u32 tpm2_nv_define_space(struct udevice *dev, u32 space_index, * @digest Value representing the event to be recorded * @digest_len len of the hash * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm, const u8 *digest, u32 digest_len); @@ -490,7 +490,7 @@ u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm, * @index Index of data to read * @data Place to put data * @count Number of bytes of data - * @return code of the operation + * Return: code of the operation */ u32 tpm2_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); @@ -501,7 +501,7 @@ u32 tpm2_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @index Index of data to write * @data Data to write * @count Number of bytes of data - * @return code of the operation + * Return: code of the operation */ u32 tpm2_nv_write_value(struct udevice *dev, u32 index, const void *data, u32 count); @@ -517,7 +517,7 @@ u32 tpm2_nv_write_value(struct udevice *dev, u32 index, const void *data, * @digest_len len of the data * @updates Optional out parameter: number of updates for this PCR * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz, u16 algorithm, void *data, u32 digest_len, @@ -533,7 +533,7 @@ u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz, * @buf Output buffer for capability information * @prop_count Size of output buffer * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property, void *buf, size_t prop_count); @@ -545,7 +545,7 @@ u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property, * @pw Password * @pw_sz Length of the password * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz); @@ -559,7 +559,7 @@ u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz); * @recovery_time Time before decrementation of the failure count * @lockout_recovery Time to wait after a lockout * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_dam_parameters(struct udevice *dev, const char *pw, const ssize_t pw_sz, unsigned int max_tries, @@ -576,7 +576,7 @@ u32 tpm2_dam_parameters(struct udevice *dev, const char *pw, * @oldpw Old password * @oldpw_sz Length of the old password * - * @return code of the operation + * Return: code of the operation */ int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw, const ssize_t newpw_sz, const char *oldpw, @@ -591,7 +591,7 @@ int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw, * @index Index of the PCR * @digest New key to access the PCR * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw, const ssize_t pw_sz, u32 index, const char *key); @@ -606,7 +606,7 @@ u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw, * @digest New key to access the PCR * @key_sz Length of the new key * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw, const ssize_t pw_sz, u32 index, const char *key, @@ -619,7 +619,7 @@ u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw, * @param data output buffer for the random bytes * @param count size of output buffer * - * @return return code of the operation + * Return: return code of the operation */ u32 tpm2_get_random(struct udevice *dev, void *data, u32 count); @@ -630,7 +630,7 @@ u32 tpm2_get_random(struct udevice *dev, void *data, u32 count); * * @dev TPM device * @index Index of data to lock - * @return code of the operation + * Return: code of the operation */ u32 tpm2_write_lock(struct udevice *dev, u32 index); @@ -641,7 +641,7 @@ u32 tpm2_write_lock(struct udevice *dev, u32 index); * before calling the kernel. * * @dev TPM device - * @return code of the operation + * Return: code of the operation */ u32 tpm2_disable_platform_hierarchy(struct udevice *dev); @@ -653,7 +653,7 @@ u32 tpm2_disable_platform_hierarchy(struct udevice *dev); * @recvbuf: Buffer to save the response to * @recv_size: Pointer to the size of the response buffer * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_submit_command(struct udevice *dev, const u8 *sendbuf, u8 *recvbuf, size_t *recv_size); diff --git a/include/tpm_api.h b/include/tpm_api.h index f13d98c..ef45b43 100644 --- a/include/tpm_api.h +++ b/include/tpm_api.h @@ -16,7 +16,7 @@ * * @param dev TPM device * @param mode TPM startup mode - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode); @@ -24,7 +24,7 @@ u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode); * Issue a TPM_SelfTestFull command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_self_test_full(struct udevice *dev); @@ -32,7 +32,7 @@ u32 tpm_self_test_full(struct udevice *dev); * Issue a TPM_ContinueSelfTest command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_continue_self_test(struct udevice *dev); @@ -45,7 +45,7 @@ u32 tpm_continue_self_test(struct udevice *dev); * @param index index of the area * @param perm TPM_NV_ATTRIBUTES of the area * @param size size of the area - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); @@ -58,7 +58,7 @@ u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); * @param index index of the area * @param data output buffer of the area contents * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); @@ -71,7 +71,7 @@ u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @param index index of the area * @param data input buffer to be wrote to the area * @param length length of data bytes of input buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data, u32 length); @@ -85,7 +85,7 @@ u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data, * recorded * @param out_digest 160-bit PCR value after execution of the * command - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_pcr_extend(struct udevice *dev, u32 index, const void *in_digest, void *out_digest); @@ -97,7 +97,7 @@ u32 tpm_pcr_extend(struct udevice *dev, u32 index, const void *in_digest, * @param index index of the PCR * @param data output buffer for contents of the named PCR * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); @@ -107,7 +107,7 @@ u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); * * @param dev TPM device * @param presence TPM physical presence flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence); @@ -117,7 +117,7 @@ u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence); * @param dev TPM device * @param data output buffer for the public endorsement key * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count); @@ -125,7 +125,7 @@ u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count); * Issue a TPM_ForceClear command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_force_clear(struct udevice *dev); @@ -133,7 +133,7 @@ u32 tpm_force_clear(struct udevice *dev); * Issue a TPM_PhysicalEnable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_physical_enable(struct udevice *dev); @@ -141,7 +141,7 @@ u32 tpm_physical_enable(struct udevice *dev); * Issue a TPM_PhysicalDisable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_physical_disable(struct udevice *dev); @@ -150,7 +150,7 @@ u32 tpm_physical_disable(struct udevice *dev); * * @param dev TPM device * @param state boolean state of the deactivated flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state); @@ -164,7 +164,7 @@ u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state); * limited to be 4-byte wide * @param cap output buffer for capability information * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, void *cap, size_t count); @@ -174,7 +174,7 @@ u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, * * @param dev TPM device * @param auth_handle handle of the auth session - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle); @@ -187,7 +187,7 @@ u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle); * * @param dev TPM device * @param auth_handle pointer to the (new) auth handle or NULL. - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_oiap(struct udevice *dev, u32 *auth_handle); @@ -195,7 +195,7 @@ u32 tpm_oiap(struct udevice *dev, u32 *auth_handle); * Ends an active OIAP session. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_end_oiap(struct udevice *dev); @@ -209,7 +209,7 @@ u32 tpm_end_oiap(struct udevice *dev); * @param key_length size of the key structure * @param parent_key_usage_auth usage auth for the parent key * @param key_handle pointer to the key handle - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, size_t key_length, const void *parent_key_usage_auth, @@ -227,7 +227,7 @@ u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, * @param pubkey_len pointer to the pub key buffer len. On entry: the size of * the provided pubkey buffer. On successful exit: the size * of the stored TPM_PUBKEY structure (iff pubkey != NULL). - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle, const void *usage_auth, void *pubkey, @@ -238,7 +238,7 @@ u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle, * * @param dev TPM device * @param perm Returns permissions value - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm); @@ -248,7 +248,7 @@ u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm); * @param dev TPM device * @param key_handle handle of the resource * @param resource_type type of the resource - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); @@ -260,7 +260,7 @@ u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); * @param auth Usage auth of the key to search for * @param pubkey_digest SHA1 hash of the pub key structure of the key * @param[out] handle The handle of the key (Non-null iff found) - * @return 0 if key was found in TPM; != 0 if not. + * Return: 0 if key was found in TPM; != 0 if not. */ u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20], const u8 pubkey_digest[20], u32 *handle); @@ -274,7 +274,7 @@ u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20], * @param dev TPM device * @param data output buffer for the random bytes * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_random(struct udevice *dev, void *data, u32 count); @@ -282,7 +282,7 @@ u32 tpm_get_random(struct udevice *dev, void *data, u32 count); * tpm_finalise_physical_presence() - Finalise physical presence * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_finalise_physical_presence(struct udevice *dev); @@ -290,7 +290,7 @@ u32 tpm_finalise_physical_presence(struct udevice *dev); * tpm_nv_enable_locking() - lock the non-volatile space * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_nv_enable_locking(struct udevice *dev); @@ -298,7 +298,7 @@ u32 tpm_nv_enable_locking(struct udevice *dev); * tpm_set_global_lock() - set the global lock * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_set_global_lock(struct udevice *dev); @@ -307,7 +307,7 @@ u32 tpm_set_global_lock(struct udevice *dev); * * @param dev TPM device * @param index Index of space to lock - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_write_lock(struct udevice *dev, u32 index); @@ -315,7 +315,7 @@ u32 tpm_write_lock(struct udevice *dev, u32 index); * tpm_resume() - start up the TPM from resume (after suspend) * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_resume(struct udevice *dev); diff --git a/include/tps6586x.h b/include/tps6586x.h index aa4270c..b89074b 100644 --- a/include/tps6586x.h +++ b/include/tps6586x.h @@ -20,7 +20,7 @@ enum { * Enable PWM mode for selected SM0-2 * * @param mask Mask of synchronous converter to enable (TPS6586X_PWM_...) - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int tps6586x_set_pwm_mode(int mask); @@ -36,7 +36,7 @@ int tps6586x_set_pwm_mode(int mask); * If this condition is not met, no adjustment will be * done and an error will be reported. Use -1 to skip * this check. - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate, int min_sm0_over_sm1); @@ -46,7 +46,7 @@ int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate, * on the device. This function must be called before using other functions. * * @param bus I2C bus containing the TPS6586X chip - * @return 0 (always succeeds) + * Return: 0 (always succeeds) */ int tps6586x_init(struct udevice *bus); diff --git a/include/trace.h b/include/trace.h index 606dba9..e7aee02 100644 --- a/include/trace.h +++ b/include/trace.h @@ -55,7 +55,7 @@ void trace_print_stats(void); * @param buff Buffer in which to place data, or NULL to count size * @param buff_size Size of buffer * @param needed Returns number of bytes used / needed - * @return 0 if ok, -1 on error (buffer exhausted) + * Return: 0 if ok, -1 on error (buffer exhausted) */ int trace_list_functions(void *buff, size_t buff_size, size_t *needed); diff --git a/include/u-boot/crc.h b/include/u-boot/crc.h index bfd477f..52ec6a9 100644 --- a/include/u-boot/crc.h +++ b/include/u-boot/crc.h @@ -21,7 +21,7 @@ * @crc_start: CRC8 start value * @vptr: Buffer to checksum * @len: Length of buffer in bytes - * @return CRC8 checksum + * Return: CRC8 checksum */ unsigned int crc8(unsigned int crc_start, const unsigned char *vptr, int len); @@ -48,7 +48,7 @@ void crc16_ccitt_wd_buf(const uint8_t *in, uint len, * calculation) * @buf: Bytes to checksum * @len: Number of bytes to checksum - * @return checksum value + * Return: checksum value */ uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len); @@ -63,7 +63,7 @@ uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len); * @buf: Bytes to checksum * @len: Number of bytes to checksum * @chunk_sz: Chunk size to use between watchdog resets - * @return checksum + * Return: checksum */ uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len, uint chunk_sz); @@ -78,7 +78,7 @@ uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len, * calculation) * @buf: Bytes to checksum * @len: Number of bytes to checksum - * @return checksum value + * Return: checksum value */ uint32_t crc32_no_comp(uint32_t crc, const unsigned char *buf, uint len); @@ -115,7 +115,7 @@ void crc32c_init(uint32_t *crc32c_table, uint32_t pol); * @data: Data bytes to checksum * @length: Number of bytes to process * @crc32c_table:: CRC table - * @return checksum value + * Return: checksum value */ uint32_t crc32c_cal(uint32_t crc, const char *data, int length, uint32_t *crc32c_table); diff --git a/include/u-boot/ecdsa.h b/include/u-boot/ecdsa.h index f6951c7..0ceb0c1 100644 --- a/include/u-boot/ecdsa.h +++ b/include/u-boot/ecdsa.h @@ -57,7 +57,7 @@ int ecdsa_add_verify_data(struct image_sign_info *info, void *keydest); * @data_len: Data length * @sig: Signature * @sig_len: Number of bytes in signature - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ int ecdsa_verify(struct image_sign_info *info, const struct image_region region[], int region_count, diff --git a/include/u-boot/fdt-libcrypto.h b/include/u-boot/fdt-libcrypto.h index 5142f37..b15d8a1 100644 --- a/include/u-boot/fdt-libcrypto.h +++ b/include/u-boot/fdt-libcrypto.h @@ -19,7 +19,7 @@ * @prop_name: What to call the property in the FDT * @num: pointer to a libcrypto big number * @num_bits: How big is 'num' in bits? - * @return 0 if all good all working, -ve on horror + * Return: 0 if all good all working, -ve on horror */ int fdt_add_bignum(void *blob, int noffset, const char *prop_name, BIGNUM *num, int num_bits); diff --git a/include/u-boot/hash-checksum.h b/include/u-boot/hash-checksum.h index 7f16b37..bcc6ba4 100644 --- a/include/u-boot/hash-checksum.h +++ b/include/u-boot/hash-checksum.h @@ -21,7 +21,7 @@ struct image_region; * @region_count: Number of regions in the region array * @checksum: Buffer contanining the output hash * - * @return 0 if OK, < 0 if error + * Return: 0 if OK, < 0 if error */ int hash_calculate(const char *name, const struct image_region *region, int region_count, diff --git a/include/u-boot/lz4.h b/include/u-boot/lz4.h index 1276fb9..e18b39a 100644 --- a/include/u-boot/lz4.h +++ b/include/u-boot/lz4.h @@ -13,7 +13,7 @@ * @srcn: Length of source data * @dst: Destination for uncompressed data * @dstn: Returns length of uncompressed data - * @return 0 if OK, -EPROTONOSUPPORT if the magic number or version number are + * Return: 0 if OK, -EPROTONOSUPPORT if the magic number or version number are * not recognised or independent blocks are used, -EINVAL if the reserved * fields are non-zero, or input is overrun, -EENOBUFS if the destination * buffer is overrun, -EEPROTO if the compressed data causes an error in diff --git a/include/u-boot/rsa.h b/include/u-boot/rsa.h index 7556aa5..2ed2ac7 100644 --- a/include/u-boot/rsa.h +++ b/include/u-boot/rsa.h @@ -75,7 +75,7 @@ int rsa_add_verify_data(struct image_sign_info *info, void *keydest); * @hash: Hash according to algorithm specified in @info * @sig: Signature * @sig_len: Number of bytes in signature - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ int rsa_verify_hash(struct image_sign_info *info, const uint8_t *hash, uint8_t *sig, uint sig_len); @@ -90,7 +90,7 @@ int rsa_verify_hash(struct image_sign_info *info, * @data_len: Data length * @sig: Signature * @sig_len: Number of bytes in signature - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ int rsa_verify(struct image_sign_info *info, const struct image_region region[], int region_count, diff --git a/include/ufs.h b/include/ufs.h index bda135c..702b835 100644 --- a/include/ufs.h +++ b/include/ufs.h @@ -7,7 +7,7 @@ struct udevice; /** * ufs_probe() - initialize all devices in the UFS uclass * - * @return 0 if Ok, -ve on error + * Return: 0 if Ok, -ve on error */ int ufs_probe(void); @@ -16,7 +16,7 @@ int ufs_probe(void); * * @index: index in the uclass sequence * - * @return 0 if successfully probed, -ve on error + * Return: 0 if successfully probed, -ve on error */ int ufs_probe_dev(int index); @@ -26,7 +26,7 @@ int ufs_probe_dev(int index); * @ufs_dev: UFS device * @scsi_devp: Pointer to scsi device * - * @return 0 if Ok, -ve on error + * Return: 0 if Ok, -ve on error */ int ufs_scsi_bind(struct udevice *ufs_dev, struct udevice **scsi_devp); #endif diff --git a/include/usb.h b/include/usb.h index b3851fd..f032de8 100644 --- a/include/usb.h +++ b/include/usb.h @@ -832,7 +832,7 @@ struct usb_device *usb_get_dev_index(struct udevice *bus, int index); * @do_read: true to read the device descriptor before an address is set * (should be false for XHCI buses, true otherwise) * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB) - * @return 0 if OK, -ve on error */ + * Return: 0 if OK, -ve on error */ int usb_setup_device(struct usb_device *dev, bool do_read, struct usb_device *parent); @@ -862,7 +862,7 @@ int usb_hub_scan(struct udevice *hub); * @port: Hub port number (numbered from 1) * @speed: USB speed to use for this device * @devp: Returns pointer to device if all is well - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_scan_device(struct udevice *parent, int port, enum usb_device_speed speed, struct udevice **devp); @@ -874,7 +874,7 @@ int usb_scan_device(struct udevice *parent, int port, * will be a device with uclass UCLASS_USB. * * @dev: Device to check - * @return The bus, or NULL if not found (this indicates a critical error in + * Return: The bus, or NULL if not found (this indicates a critical error in * the USB stack */ struct udevice *usb_get_bus(struct udevice *dev); @@ -967,7 +967,7 @@ void usb_find_usb2_hub_address_port(struct usb_device *udev, * @devp: returns a pointer of a new device structure. With driver model this * is a device pointer, but with legacy USB this pointer is * driver-specific. - * @return 0 if OK, -ENOSPC if we have found out of room for new devices + * Return: 0 if OK, -ENOSPC if we have found out of room for new devices */ int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp); @@ -990,7 +990,7 @@ int usb_alloc_device(struct usb_device *dev); * representation of this hub can be updated. * * @dev: Hub device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_update_hub_device(struct usb_device *dev); @@ -1002,7 +1002,7 @@ int usb_update_hub_device(struct usb_device *dev); * * @dev: USB device * @size: maximum transfer bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_get_max_xfer_size(struct usb_device *dev, size_t *size); @@ -1018,7 +1018,7 @@ int usb_get_max_xfer_size(struct usb_device *dev, size_t *size); * @desc_list: List of points or USB descriptors, terminated by NULL. * The first entry must be struct usb_device_descriptor, * and others follow on after that. - * @return 0 if OK, -ENOSYS if not implemented, other -ve on error + * Return: 0 if OK, -ENOSYS if not implemented, other -ve on error */ int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings, void **desc_list); @@ -1029,7 +1029,7 @@ int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings, * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_emul_control(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length, @@ -1041,7 +1041,7 @@ int usb_emul_control(struct udevice *emul, struct usb_device *udev, * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_emul_bulk(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length); @@ -1052,7 +1052,7 @@ int usb_emul_bulk(struct udevice *emul, struct usb_device *udev, * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_emul_int(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length, int interval, @@ -1067,7 +1067,7 @@ int usb_emul_int(struct udevice *emul, struct usb_device *udev, * @pipe: Describes pipe being used, and includes the device number * @port1: Describes port number on the parent hub * @emulp: Returns pointer to emulator, or NULL if not found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int usb_emul_find(struct udevice *bus, ulong pipe, int port1, struct udevice **emulp); @@ -1077,7 +1077,7 @@ int usb_emul_find(struct udevice *bus, ulong pipe, int port1, * * @dev: USB device to check * @emulp: Returns pointer to emulator, or NULL if not found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp); @@ -1087,7 +1087,7 @@ int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp); * @ptr: a pointer to a list of USB descriptor pointers * @type: type of USB descriptor to find * @index: if @type is USB_DT_CONFIG, this is the configuration value - * @return a pointer to the USB descriptor found, NULL if not found + * Return: a pointer to the USB descriptor found, NULL if not found */ struct usb_generic_descriptor **usb_emul_find_descriptor( struct usb_generic_descriptor **ptr, int type, int index); diff --git a/include/usb/xhci.h b/include/usb/xhci.h index 01e63cf..ea4cf3f 100644 --- a/include/usb/xhci.h +++ b/include/usb/xhci.h @@ -1265,7 +1265,7 @@ int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr, * xhci_deregister() - Unregister an XHCI controller * * @dev: Controller device - * @return 0 if registered, -ve on error + * Return: 0 if registered, -ve on error */ int xhci_deregister(struct udevice *dev); @@ -1275,7 +1275,7 @@ int xhci_deregister(struct udevice *dev); * @dev: Controller device * @hccr: Host controller control registers * @hcor: Not sure what this means - * @return 0 if registered, -ve on error + * Return: 0 if registered, -ve on error */ int xhci_register(struct udevice *dev, struct xhci_hccr *hccr, struct xhci_hcor *hcor); diff --git a/include/usb_ether.h b/include/usb_ether.h index e85acad..8c7bd06 100644 --- a/include/usb_ether.h +++ b/include/usb_ether.h @@ -43,7 +43,7 @@ struct ueth_data { * @dev: USB device * @ss: Place to put USB ethernet data * @rxsize: Maximum size to allocate for the receive buffer - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize); @@ -51,7 +51,7 @@ int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize); * usb_ether_deregister() - deregister a USB ethernet device * * @ueth: USB Ethernet device - * @return 0 + * Return: 0 */ int usb_ether_deregister(struct ueth_data *ueth); @@ -62,7 +62,7 @@ int usb_ether_deregister(struct ueth_data *ueth); * * @ueth: USB Ethernet device * @rxsize: Maximum size to receive - * @return 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is + * Return: 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is * larger than the size passed ot usb_ether_register(), other -ve on error */ int usb_ether_receive(struct ueth_data *ueth, int rxsize); @@ -77,7 +77,7 @@ int usb_ether_receive(struct ueth_data *ueth, int rxsize); * @ueth: USB Ethernet device * @ptrp: Returns a pointer to the start of the next packet if there is * one available - * @return number of bytes available, or 0 if none + * Return: number of bytes available, or 0 if none */ int usb_ether_get_rx_bytes(struct ueth_data *ueth, uint8_t **ptrp); diff --git a/include/video.h b/include/video.h index 1d75a90..48a71dc 100644 --- a/include/video.h +++ b/include/video.h @@ -151,7 +151,7 @@ struct video_ops { * * @addrp: On entry, the top of available memory. On exit, the new top, * after allocating the required memory. - * @return 0 + * Return: 0 */ int video_reserve(ulong *addrp); @@ -160,7 +160,7 @@ int video_reserve(ulong *addrp); * video_clear() - Clear a device's frame buffer to background color. * * @dev: Device to clear - * @return 0 + * Return: 0 */ int video_clear(struct udevice *dev); #endif /* CONFIG_DM_VIDEO */ @@ -202,7 +202,7 @@ void video_sync_all(void); * - if a coordinate is -ve then it will be offset to the * left/top of the centre by that many pixels * - if a coordinate is positive it will be used unchnaged. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y, bool align); @@ -211,7 +211,7 @@ int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y, * video_get_xsize() - Get the width of the display in pixels * * @dev: Device to check - * @return device frame buffer width in pixels + * Return: device frame buffer width in pixels */ int video_get_xsize(struct udevice *dev); @@ -219,7 +219,7 @@ int video_get_xsize(struct udevice *dev); * video_get_ysize() - Get the height of the display in pixels * * @dev: Device to check - * @return device frame buffer height in pixels + * Return: device frame buffer height in pixels */ int video_get_ysize(struct udevice *dev); @@ -251,7 +251,7 @@ void video_set_default_colors(struct udevice *dev, bool invert); * @dev: Vidconsole device being updated * @from: Start/end address within the framebuffer (->fb) * @to: Other address within the frame buffer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int video_sync_copy(struct udevice *dev, void *from, void *to); @@ -260,7 +260,7 @@ int video_sync_copy(struct udevice *dev, void *from, void *to); * video_sync_copy_all() - Sync the entire framebuffer to the copy * * @dev: Vidconsole device being updated - * @return 0 (always) + * Return: 0 (always) */ int video_sync_copy_all(struct udevice *dev); #else @@ -279,7 +279,7 @@ static inline int video_sync_copy_all(struct udevice *dev) /** * video_is_active() - Test if one video device it active * - * @return true if at least one video device is active, else false. + * Return: true if at least one video device is active, else false. */ bool video_is_active(void); @@ -299,28 +299,28 @@ int video_display_bitmap(ulong bmp_image, int x, int y); /** * Get the width of the screen in pixels * - * @return width of screen in pixels + * Return: width of screen in pixels */ int video_get_pixel_width(void); /** * Get the height of the screen in pixels * - * @return height of screen in pixels + * Return: height of screen in pixels */ int video_get_pixel_height(void); /** * Get the number of text lines/rows on the screen * - * @return number of rows + * Return: number of rows */ int video_get_screen_rows(void); /** * Get the number of text columns on the screen * - * @return number of columns + * Return: number of columns */ int video_get_screen_columns(void); diff --git a/include/video_bridge.h b/include/video_bridge.h index 22e93db..3b429ea 100644 --- a/include/video_bridge.h +++ b/include/video_bridge.h @@ -70,7 +70,7 @@ struct video_bridge_ops { /** * video_bridge_attach() - attach a video bridge * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bridge_attach(struct udevice *dev); @@ -78,7 +78,7 @@ int video_bridge_attach(struct udevice *dev); * video_bridge_set_backlight() - Set the backlight brightness * * @percent: brightness percentage (0=off, 100=full brightness) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bridge_set_backlight(struct udevice *dev, int percent); @@ -94,7 +94,7 @@ int video_bridge_set_active(struct udevice *dev, bool active); * check_attached() - check if a bridge is correctly attached * * @dev: Device to check - * @return 0 if attached, -EENOTCONN if not, or other -ve error + * Return: 0 if attached, -EENOTCONN if not, or other -ve error */ int video_bridge_check_attached(struct udevice *dev); @@ -104,7 +104,7 @@ int video_bridge_check_attached(struct udevice *dev); * @dev: Device to read from * @buf: Buffer to read into * @buf_size: Buffer size - * @return number of bytes read, <=0 for error + * Return: number of bytes read, <=0 for error */ int video_bridge_read_edid(struct udevice *dev, u8 *buf, int buf_size); diff --git a/include/video_console.h b/include/video_console.h index 06b798e..5921767 100644 --- a/include/video_console.h +++ b/include/video_console.h @@ -170,7 +170,7 @@ struct vidconsole_ops { * is the X position multipled by VID_FRAC_DIV. * @y: Pixel Y position (0=top-most pixel) * @ch: Character to write - * @return number of fractional pixels that the cursor should move, + * Return: number of fractional pixels that the cursor should move, * if all is OK, -EAGAIN if we ran out of space on this line, other -ve * on error */ @@ -183,7 +183,7 @@ int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch); * @rowdst: Destination text row (0=top) * @rowsrc: Source start text row * @count: Number of text rows to move - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, uint count); @@ -196,7 +196,7 @@ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, * @dev: Device to adjust * @row: Text row to adjust (0=top) * @clr: Raw colour (pixel value) to write to each pixel - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_set_row(struct udevice *dev, uint row, int clr); @@ -212,7 +212,7 @@ int vidconsole_set_row(struct udevice *dev, uint row, int clr); * * @dev: Device to adjust * @ch: Character to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_put_char(struct udevice *dev, char ch); @@ -228,7 +228,7 @@ int vidconsole_put_char(struct udevice *dev, char ch); * * @dev: Device to adjust * @str: String to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_put_string(struct udevice *dev, const char *str); @@ -238,7 +238,7 @@ int vidconsole_put_string(struct udevice *dev, const char *str); * @dev: Device to adjust * @col: New cursor text column * @row: New cursor text row - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ void vidconsole_position_cursor(struct udevice *dev, unsigned col, unsigned row); @@ -252,7 +252,7 @@ void vidconsole_position_cursor(struct udevice *dev, unsigned col, * * @priv private data of the console device * @idx color index - * @return color value + * Return: color value */ u32 vid_console_color(struct video_priv *priv, unsigned int idx); @@ -268,7 +268,7 @@ u32 vid_console_color(struct video_priv *priv, unsigned int idx); * @dev: Vidconsole device being updated * @from: Start/end address within the framebuffer (->fb) * @to: Other address within the frame buffer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int vidconsole_sync_copy(struct udevice *dev, void *from, void *to); @@ -283,7 +283,7 @@ int vidconsole_sync_copy(struct udevice *dev, void *from, void *to); * @dst: Destination address within the framebuffer (->fb) * @src: Source address within the framebuffer (->fb) * @size: Number of bytes to transfer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int vidconsole_memmove(struct udevice *dev, void *dst, const void *src, diff --git a/include/video_osd.h b/include/video_osd.h index 01ac94b..dc60baf 100644 --- a/include/video_osd.h +++ b/include/video_osd.h @@ -125,7 +125,7 @@ struct video_osd_ops { * @dev: OSD instance to query. * @info: Pointer to a structure that takes the information read from the * OSD instance. - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_get_info(struct udevice *dev, struct video_osd_info *info); @@ -155,7 +155,7 @@ int video_osd_get_info(struct udevice *dev, struct video_osd_info *info); * coordinate on the OSD screen. * @buflen: Length of the data in the passed buffer (in byte). * @count: Write count many repetitions of the given text data - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf, size_t buflen, uint count); @@ -167,7 +167,7 @@ int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf, * @dev: OSD instance to write to. * @col The number of characters in the window's columns * @row The number of characters in the window's rows - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_set_size(struct udevice *dev, uint col, uint row); @@ -184,7 +184,7 @@ int video_osd_set_size(struct udevice *dev, uint col, uint row); * interpretation of the value is driver-specific, and possible * values should be defined e.g. in a driver include file. * @text: The string data that should be printed on the OSD - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_print(struct udevice *dev, uint col, uint row, ulong color, char *text); diff --git a/include/virtio.h b/include/virtio.h index 34e2bfd..062a246 100644 --- a/include/virtio.h +++ b/include/virtio.h @@ -228,7 +228,7 @@ struct virtio_dev_priv { * @offset: the offset of the configuration field * @buf: the buffer to write the field value into * @len: the length of the buffer - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_get_config(struct udevice *vdev, unsigned int offset, void *buf, unsigned int len); @@ -240,7 +240,7 @@ int virtio_get_config(struct udevice *vdev, unsigned int offset, * @offset: the offset of the configuration field * @buf: the buffer to read the field value from * @len: the length of the buffer - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_set_config(struct udevice *vdev, unsigned int offset, void *buf, unsigned int len); @@ -250,7 +250,7 @@ int virtio_set_config(struct udevice *vdev, unsigned int offset, * * @vdev: the real virtio device * @counter: the returned config generation counter - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_generation(struct udevice *vdev, u32 *counter); @@ -259,7 +259,7 @@ int virtio_generation(struct udevice *vdev, u32 *counter); * * @vdev: the real virtio device * @status: the returned status byte - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_get_status(struct udevice *vdev, u8 *status); @@ -268,7 +268,7 @@ int virtio_get_status(struct udevice *vdev, u8 *status); * * @vdev: the real virtio device * @status: the new status byte - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_set_status(struct udevice *vdev, u8 status); @@ -276,7 +276,7 @@ int virtio_set_status(struct udevice *vdev, u8 status); * virtio_reset() - reset the device * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_reset(struct udevice *vdev); @@ -285,7 +285,7 @@ int virtio_reset(struct udevice *vdev); * * @vdev: the real virtio device * @features: the first 32 feature bits (all we currently need) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_get_features(struct udevice *vdev, u64 *features); @@ -293,7 +293,7 @@ int virtio_get_features(struct udevice *vdev, u64 *features); * virtio_set_features() - confirm what device features we'll be using * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_set_features(struct udevice *vdev); @@ -303,7 +303,7 @@ int virtio_set_features(struct udevice *vdev); * @vdev: the real virtio device * @nvqs: the number of virtqueues to find * @vqs: on success, includes new virtqueues - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs, struct virtqueue *vqs[]); @@ -312,7 +312,7 @@ int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs, * virtio_del_vqs() - free virtqueues found by find_vqs() * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_del_vqs(struct udevice *vdev); @@ -321,7 +321,7 @@ int virtio_del_vqs(struct udevice *vdev); * * @vdev: the real virtio device * @vq: virtqueue to process - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_notify(struct udevice *vdev, struct virtqueue *vq); @@ -337,7 +337,7 @@ void virtio_add_status(struct udevice *vdev, u8 status); * virtio_finalize_features() - helper to finalize features * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_finalize_features(struct udevice *vdev); @@ -366,7 +366,7 @@ void virtio_driver_features_init(struct virtio_dev_priv *priv, /** * virtio_init() - helper to enumerate all known virtio devices * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_init(void); diff --git a/include/vsprintf.h b/include/vsprintf.h index 8bfafa0..532ef36 100644 --- a/include/vsprintf.h +++ b/include/vsprintf.h @@ -16,7 +16,7 @@ * @param cp The string to be converted * @param endp Updated to point to the first character not converted * @param base The number base to use (0 for the default) - * @return value decoded from string (0 if invalid) + * Return: value decoded from string (0 if invalid) * * Converts a string to an unsigned long. If there are invalid characters at * the end these are ignored. In the worst case, if all characters are invalid, @@ -36,7 +36,7 @@ ulong simple_strtoul(const char *cp, char **endp, unsigned int base); * * @param cp The string to be converted * @param endp Updated to point to the first character not converted - * @return value decoded from string (0 if invalid) + * Return: value decoded from string (0 if invalid) * * Converts a hex string to an unsigned long. If there are invalid characters at * the end these are ignored. In the worst case, if all characters are invalid, @@ -49,7 +49,7 @@ unsigned long hextoul(const char *cp, char **endp); * * @param cp The string to be converted * @param endp Updated to point to the first character not converted - * @return value decoded from string (0 if invalid) + * Return: value decoded from string (0 if invalid) * * Converts a decimal string to an unsigned long. If there are invalid * characters at the end these are ignored. In the worst case, if all characters @@ -62,7 +62,7 @@ unsigned long dectoul(const char *cp, char **endp); * @param cp The string to be converted * @param base The number base to use (0 for the default) * @param res The converted result value - * @return 0 if conversion is successful and *res is set to the converted + * Return: 0 if conversion is successful and *res is set to the converted * value, otherwise it returns -EINVAL and *res is set to 0. * * strict_strtoul converts a string to an unsigned long only if the @@ -99,7 +99,7 @@ long long simple_strtoll(const char *cp, char **endp, unsigned int base); * For example, "abc123" would return 123. * * @str: String to exxamine - * @return training number if found, else -1 + * Return: training number if found, else -1 */ long trailing_strtol(const char *str); @@ -114,7 +114,7 @@ long trailing_strtol(const char *str); * @str: String to exxamine * @end: Pointer to end of string to examine, or NULL to use the * whole string - * @return training number if found, else -1 + * Return: training number if found, else -1 */ long trailing_strtoln(const char *str, const char *end); @@ -164,7 +164,7 @@ int sprintf(char *buf, const char *fmt, ...) * @param buf The buffer to place the result into * @param fmt The format string to use * @param args Arguments for the format string - * @return the number of characters which have been written into + * Return: the number of characters which have been written into * the @buf not including the trailing '\0'. * * If you're not already dealing with a va_list consider using scnprintf(). @@ -181,7 +181,7 @@ int vsprintf(char *buf, const char *fmt, va_list args); * simple_... functions, so should be used immediately * * @val: Value to convert - * @return string containing the decimal representation of @val + * Return: string containing the decimal representation of @val */ char *simple_itoa(ulong val); @@ -193,7 +193,7 @@ char *simple_itoa(ulong val); * simple_... functions, so should be used immediately * * @val: Value to convert - * @return string containing the hexecimal representation of @val + * Return: string containing the hexecimal representation of @val */ char *simple_xtoa(ulong num); @@ -204,7 +204,7 @@ char *simple_xtoa(ulong num); * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param ... Arguments for the format string - * @return the number of characters which would be + * Return: the number of characters which would be * generated for the given input, excluding the trailing null, * as per ISO C99. If the return is greater than or equal to * @size, the resulting string is truncated. @@ -237,7 +237,7 @@ int scnprintf(char *buf, size_t size, const char *fmt, ...) * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return The number characters which would be generated for the given + * Return: The number characters which would be generated for the given * input, excluding the trailing '\0', as per ISO C99. Note that fewer * characters may be written if this number of characters is >= size. * @@ -262,7 +262,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list args); * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return the number of characters which have been written into + * Return: the number of characters which have been written into * the @buf not including the trailing '\0'. If @size is == 0 the function * returns 0. * diff --git a/include/wait_bit.h b/include/wait_bit.h index dc2ffeb..dcc5c4f 100644 --- a/include/wait_bit.h +++ b/include/wait_bit.h @@ -31,7 +31,7 @@ * @param set Selects wait condition (bit set or clear) * @param timeout_ms Timeout (in milliseconds) * @param breakable Enables CTRL-C interruption - * @return 0 on success, -ETIMEDOUT or -EINTR on failure + * Return: 0 on success, -ETIMEDOUT or -EINTR on failure */ #define BUILD_WAIT_FOR_BIT(sfx, type, read) \ diff --git a/include/wdt.h b/include/wdt.h index baaa9db..5026f5a 100644 --- a/include/wdt.h +++ b/include/wdt.h @@ -60,7 +60,7 @@ int wdt_reset(struct udevice *dev); * * @dev: WDT Device * @flags: Driver specific flags - * @return 0 if OK -ve on error. If wdt action is system reset, + * Return: 0 if OK -ve on error. If wdt action is system reset, * this function may never return. */ int wdt_expire_now(struct udevice *dev, ulong flags); -- cgit v1.1