doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
diff --git a/lib/acpi/acpi_device.c b/lib/acpi/acpi_device.c
index b5f2ceb..1b838fd 100644
--- a/lib/acpi/acpi_device.c
+++ b/lib/acpi/acpi_device.c
@@ -27,7 +27,7 @@
* @buf: Buffer to hold the path
* @buf_len: Length of buffer
* @cur: Current position in the buffer
- * @return new position in buffer after adding @dev, or -ve on error
+ * Return: new position in buffer after adding @dev, or -ve on error
*/
static int acpi_device_path_fill(const struct udevice *dev, char *buf,
size_t buf_len, int cur)
@@ -97,7 +97,7 @@
*
* Write a forward length for a large resource (2 bytes)
*
- * @return pointer to the zero word (for fixing up later)
+ * Return: pointer to the zero word (for fixing up later)
*/
static void *largeres_write_len_f(struct acpi_ctx *ctx)
{
@@ -597,7 +597,7 @@
* @dev: I2C device to convert
* @i2c: Place to put the new structure
* @scope: Scope of the I2C device (this is the controller path)
- * @return chip address of device
+ * Return: chip address of device
*/
static int acpi_device_set_i2c(const struct udevice *dev, struct acpi_i2c *i2c,
const char *scope)
@@ -719,7 +719,7 @@
* @dev: SPI device to convert
* @spi: Place to put the new structure
* @scope: Scope of the SPI device (this is the controller path)
- * @return 0 (always)
+ * Return: 0 (always)
*/
static int acpi_device_set_spi(const struct udevice *dev, struct acpi_spi *spi,
const char *scope)
diff --git a/lib/binman.c b/lib/binman.c
index 530df6a..cfe1e5f 100644
--- a/lib/binman.c
+++ b/lib/binman.c
@@ -37,7 +37,7 @@
* depends on whether multiple-images is in use.
*
* @nodep: Returns the node found, on success
- * @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
*/
static int find_image_node(ofnode *nodep)
diff --git a/lib/efi/efi_app.c b/lib/efi/efi_app.c
index 6980933..1e5606c 100644
--- a/lib/efi/efi_app.c
+++ b/lib/efi/efi_app.c
@@ -79,7 +79,7 @@
* @device_path: EFI device path structure for this
* @len: Length of @device_path in bytes
* @devp: Returns the bound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int efi_bind_block(efi_handle_t handle, struct efi_block_io *blkio,
struct efi_device_path *device_path, int len,
diff --git a/lib/efi/efi_stub.c b/lib/efi/efi_stub.c
index 646cde3..a35fce1 100644
--- a/lib/efi/efi_stub.c
+++ b/lib/efi/efi_stub.c
@@ -152,7 +152,7 @@
* EFI we must first change to 32-bit mode. To do this we need to find the
* correct code segment to use (an entry in the Global Descriptor Table).
*
- * @return code segment GDT offset, or 0 for 32-bit EFI, -ENOENT if not found
+ * Return: code segment GDT offset, or 0 for 32-bit EFI, -ENOENT if not found
*/
static int get_codeseg32(void)
{
diff --git a/lib/efi_loader/efi_acpi.c b/lib/efi_loader/efi_acpi.c
index a62c340..83f025e 100644
--- a/lib/efi_loader/efi_acpi.c
+++ b/lib/efi_loader/efi_acpi.c
@@ -15,7 +15,7 @@
/*
* Install the ACPI table as a configuration table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_acpi_register(void)
{
diff --git a/lib/efi_loader/efi_device_path.c b/lib/efi_loader/efi_device_path.c
index 735ed0b..c61f485 100644
--- a/lib/efi_loader/efi_device_path.c
+++ b/lib/efi_loader/efi_device_path.c
@@ -51,7 +51,7 @@
* Determine if an MMC device is an SD card.
*
* @desc block device descriptor
- * @return true if the device is an SD card
+ * Return: true if the device is an SD card
*/
static bool is_sd(struct blk_desc *desc)
{
@@ -223,7 +223,7 @@
* Determine the last device path node that is not the end node.
*
* @dp device path
- * @return last node before the end node if it exists
+ * Return: last node before the end node if it exists
* otherwise NULL
*/
const struct efi_device_path *efi_dp_last_node(const struct efi_device_path *dp)
@@ -572,7 +572,7 @@
*
* @buf pointer to the end of the device path
* @dev device
- * @return pointer to the end of the device path
+ * Return: pointer to the end of the device path
*/
__maybe_unused static void *dp_fill(void *buf, struct udevice *dev)
{
diff --git a/lib/efi_loader/efi_device_path_to_text.c b/lib/efi_loader/efi_device_path_to_text.c
index 57fa9d9..d8a83c8 100644
--- a/lib/efi_loader/efi_device_path_to_text.c
+++ b/lib/efi_loader/efi_device_path_to_text.c
@@ -225,7 +225,7 @@
*
* @s output buffer
* @dp device path node
- * @return next unused buffer address
+ * Return: next unused buffer address
*/
static char *dp_media(char *s, struct efi_device_path *dp)
{
@@ -310,7 +310,7 @@
*
* @buffer output buffer
* @dp device path or node
- * @return end of string
+ * Return: end of string
*/
static char *efi_convert_single_device_node_to_text(
char *buffer,
@@ -350,7 +350,7 @@
* device_node device node to be converted
* display_only true if the shorter text representation shall be used
* allow_shortcuts true if shortcut forms may be used
- * @return text representation of the device path
+ * Return: text representation of the device path
* NULL if out of memory of device_path is NULL
*/
static uint16_t EFIAPI *efi_convert_device_node_to_text(
@@ -383,7 +383,7 @@
* device_path device path to be converted
* display_only true if the shorter text representation shall be used
* allow_shortcuts true if shortcut forms may be used
- * @return text representation of the device path
+ * Return: text representation of the device path
* NULL if out of memory of device_path is NULL
*/
static uint16_t EFIAPI *efi_convert_device_path_to_text(
diff --git a/lib/efi_loader/efi_device_path_utilities.c b/lib/efi_loader/efi_device_path_utilities.c
index 9401532..a07d9ba 100644
--- a/lib/efi_loader/efi_device_path_utilities.c
+++ b/lib/efi_loader/efi_device_path_utilities.c
@@ -22,7 +22,7 @@
* for details.
*
* @device_path device path
- * @return size in bytes
+ * Return: size in bytes
*/
static efi_uintn_t EFIAPI get_device_path_size(
const struct efi_device_path *device_path)
@@ -50,7 +50,7 @@
* for details.
*
* @device_path device path
- * @return copy of the device path
+ * Return: copy of the device path
*/
static struct efi_device_path * EFIAPI duplicate_device_path(
const struct efi_device_path *device_path)
@@ -70,7 +70,7 @@
*
* @src1 1st device path
* @src2 2nd device path
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_path(
const struct efi_device_path *src1,
@@ -91,7 +91,7 @@
*
* @device_path device path
* @device_node device node
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_node(
const struct efi_device_path *device_path,
@@ -112,7 +112,7 @@
*
* @device_path 1st device path
* @device_path_instance 2nd device path
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_path_instance(
const struct efi_device_path *device_path,
@@ -134,7 +134,7 @@
*
* @device_path_instance next device path instance
* @device_path_instance_size size of the device path instance
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI get_next_device_path_instance(
struct efi_device_path **device_path_instance,
@@ -156,7 +156,7 @@
*
* @device_path device path
* @device_node device node
- * @return concatenated device path
+ * Return: concatenated device path
*/
static bool EFIAPI is_device_path_multi_instance(
const struct efi_device_path *device_path)
@@ -177,7 +177,7 @@
* @node_type node type
* @node_sub_type node sub type
* @node_length node length
- * @return device path node
+ * Return: device path node
*/
static struct efi_device_path * EFIAPI create_device_node(
uint8_t node_type, uint8_t node_sub_type, uint16_t node_length)
diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c
index 7f0b507..1c51a3f 100644
--- a/lib/efi_loader/efi_memory.c
+++ b/lib/efi_loader/efi_memory.c
@@ -452,7 +452,7 @@
* @memory_type usage type of the allocated memory
* @pages number of pages to be allocated
* @memory allocated memory
- * @return status code
+ * Return: status code
*/
efi_status_t efi_allocate_pages(enum efi_allocate_type type,
enum efi_memory_type memory_type,
@@ -680,7 +680,7 @@
* @map_key key for the memory map
* @descriptor_size size of an individual memory descriptor
* @descriptor_version version number of the memory descriptor structure
- * @return status code
+ * Return: status code
*/
efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
struct efi_mem_desc *memory_map,
diff --git a/lib/efi_loader/efi_smbios.c b/lib/efi_loader/efi_smbios.c
index fc0b233..306c0bc 100644
--- a/lib/efi_loader/efi_smbios.c
+++ b/lib/efi_loader/efi_smbios.c
@@ -16,7 +16,7 @@
/*
* Install the SMBIOS table as a configuration table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_smbios_register(void)
{
diff --git a/lib/efi_selftest/dtbdump.c b/lib/efi_selftest/dtbdump.c
index f6ddaa3..ed3b985 100644
--- a/lib/efi_selftest/dtbdump.c
+++ b/lib/efi_selftest/dtbdump.c
@@ -160,7 +160,7 @@
* Convert FDT value to host endianness.
*
* @val FDT value
- * @return converted value
+ * Return: converted value
*/
static u32 f2h(fdt32_t val)
{
diff --git a/lib/efi_selftest/efi_selftest.c b/lib/efi_selftest/efi_selftest.c
index 39ee2ed..3da34b1 100644
--- a/lib/efi_selftest/efi_selftest.c
+++ b/lib/efi_selftest/efi_selftest.c
@@ -75,7 +75,7 @@
*
* @test the test to be executed
* @failures counter that will be incremented if a failure occurs
- * @return EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(struct efi_unit_test *test, unsigned int *failures)
{
@@ -100,7 +100,7 @@
*
* @test the test to be executed
* @failures counter that will be incremented if a failure occurs
- * @return EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(struct efi_unit_test *test, unsigned int *failures)
{
@@ -125,7 +125,7 @@
*
* @test the test to be torn down
* @failures counter that will be incremented if a failure occurs
- * @return EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(struct efi_unit_test *test, unsigned int *failures)
{
diff --git a/lib/efi_selftest/efi_selftest_block_device.c b/lib/efi_selftest/efi_selftest_block_device.c
index 15f0375..ad53dac 100644
--- a/lib/efi_selftest/efi_selftest_block_device.c
+++ b/lib/efi_selftest/efi_selftest_block_device.c
@@ -57,7 +57,7 @@
* Reset service of the block IO protocol.
*
* @this block IO protocol
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI reset(
struct efi_block_io *this,
@@ -74,7 +74,7 @@
* @lba start of the read in logical blocks
* @buffer_size number of bytes to read
* @buffer target buffer
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI read_blocks(
struct efi_block_io *this, u32 media_id, u64 lba,
@@ -99,7 +99,7 @@
* @lba start of the write in logical blocks
* @buffer_size number of bytes to read
* @buffer source buffer
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI write_blocks(
struct efi_block_io *this, u32 media_id, u64 lba,
@@ -120,7 +120,7 @@
* Flush service of the block IO protocol.
*
* @this block IO protocol
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI flush_blocks(struct efi_block_io *this)
{
@@ -131,7 +131,7 @@
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
@@ -278,7 +278,7 @@
* Get length of device path without end tag.
*
* @dp device path
- * @return length of device path in bytes
+ * Return: length of device path in bytes
*/
static efi_uintn_t dp_size(struct efi_device_path *dp)
{
diff --git a/lib/efi_selftest/efi_selftest_controllers.c b/lib/efi_selftest/efi_selftest_controllers.c
index 38720bb..d2bbd1c 100644
--- a/lib/efi_selftest/efi_selftest_controllers.c
+++ b/lib/efi_selftest/efi_selftest_controllers.c
@@ -35,7 +35,7 @@
* @handle handle on which child controllers are installed
* @protocol protocol for which the child controllers were installed
* @count number of child controllers
- * @return status code
+ * Return: status code
*/
static efi_status_t count_child_controllers(efi_handle_t handle,
efi_guid_t *protocol,
@@ -69,7 +69,7 @@
* @this driver binding protocol
* @controller_handle handle of the controller
* @remaining_device_path path specifying the child controller
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI supported(
struct efi_driver_binding_protocol *this,
@@ -106,7 +106,7 @@
* @this driver binding protocol
* @controller_handle handle of the controller
* @remaining_device_path path specifying the child controller
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI start(
struct efi_driver_binding_protocol *this,
@@ -161,7 +161,7 @@
*
* @controller_handle parent controller
* @child_handle child controller
- * @return status code
+ * Return: status code
*/
static efi_status_t disconnect_child(efi_handle_t controller_handle,
efi_handle_t child_handle)
@@ -191,7 +191,7 @@
* @controller_handle handle of the controller
* @number_of_children number of child controllers to remove
* @child_handle_buffer handles of the child controllers to remove
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI stop(
struct efi_driver_binding_protocol *this,
diff --git a/lib/efi_selftest/efi_selftest_exception.c b/lib/efi_selftest/efi_selftest_exception.c
index 6e900a3..d86228a 100644
--- a/lib/efi_selftest/efi_selftest_exception.c
+++ b/lib/efi_selftest/efi_selftest_exception.c
@@ -63,7 +63,7 @@
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
diff --git a/lib/efi_selftest/efi_selftest_fdt.c b/lib/efi_selftest/efi_selftest_fdt.c
index 412ba28..739f029 100644
--- a/lib/efi_selftest/efi_selftest_fdt.c
+++ b/lib/efi_selftest/efi_selftest_fdt.c
@@ -51,7 +51,7 @@
*
* @property name of the property
* @node name of the node or NULL for root node
- * @return value of the property
+ * Return: value of the property
*/
static char *get_property(const u16 *property, const u16 *node)
{
diff --git a/lib/efi_selftest/efi_selftest_load_file.c b/lib/efi_selftest/efi_selftest_load_file.c
index 4473e7c..bf955cb 100644
--- a/lib/efi_selftest/efi_selftest_load_file.c
+++ b/lib/efi_selftest/efi_selftest_load_file.c
@@ -166,7 +166,7 @@
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
diff --git a/lib/efi_selftest/efi_selftest_loadimage.c b/lib/efi_selftest/efi_selftest_loadimage.c
index 06a87df..4975d80 100644
--- a/lib/efi_selftest/efi_selftest_loadimage.c
+++ b/lib/efi_selftest/efi_selftest_loadimage.c
@@ -370,7 +370,7 @@
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
diff --git a/lib/efi_selftest/efi_selftest_miniapp_exception.c b/lib/efi_selftest/efi_selftest_miniapp_exception.c
index 59b7e51..9be0e7e 100644
--- a/lib/efi_selftest/efi_selftest_miniapp_exception.c
+++ b/lib/efi_selftest/efi_selftest_miniapp_exception.c
@@ -15,7 +15,7 @@
*
* @handle handle of the loaded image
* @systable system table
- * @return status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t handle,
struct efi_system_table *systable)
diff --git a/lib/efi_selftest/efi_selftest_miniapp_return.c b/lib/efi_selftest/efi_selftest_miniapp_return.c
index 5709e39..25a2bd1 100644
--- a/lib/efi_selftest/efi_selftest_miniapp_return.c
+++ b/lib/efi_selftest/efi_selftest_miniapp_return.c
@@ -16,7 +16,7 @@
*
* @handle handle of the loaded image
* @systable system table
- * @return status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t handle,
struct efi_system_table *systable)
diff --git a/lib/efi_selftest/efi_selftest_startimage_exit.c b/lib/efi_selftest/efi_selftest_startimage_exit.c
index 11207b8..5d4c0a6 100644
--- a/lib/efi_selftest/efi_selftest_startimage_exit.c
+++ b/lib/efi_selftest/efi_selftest_startimage_exit.c
@@ -43,7 +43,7 @@
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
diff --git a/lib/efi_selftest/efi_selftest_startimage_return.c b/lib/efi_selftest/efi_selftest_startimage_return.c
index fabf53d..44c2364 100644
--- a/lib/efi_selftest/efi_selftest_startimage_return.c
+++ b/lib/efi_selftest/efi_selftest_startimage_return.c
@@ -43,7 +43,7 @@
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
diff --git a/lib/efi_selftest/efi_selftest_tcg2.c b/lib/efi_selftest/efi_selftest_tcg2.c
index c5b0b7d..2eed588 100644
--- a/lib/efi_selftest/efi_selftest_tcg2.c
+++ b/lib/efi_selftest/efi_selftest_tcg2.c
@@ -401,7 +401,7 @@
* efi_status_t decompress() - Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
@@ -438,7 +438,7 @@
* Preexisting variable values are saved and will be restored by
* calling restore_boot_variable().
*
- * @return status code
+ * Return: status code
*/
static efi_status_t setup_boot_variable(void)
{
@@ -494,7 +494,7 @@
*
* Restore the variable values saved in setup_boot_variable().
*
- * @return status code
+ * Return: status code
*/
static efi_status_t restore_boot_variable(void)
{
@@ -536,7 +536,7 @@
* void *find_smbios_table() - Find smbios table
*
* @systable system table
- * @return status code
+ * Return: status code
*/
static void *find_smbios_table(const struct efi_system_table *systable)
{
@@ -554,7 +554,7 @@
* efi_status_t setup_smbios_table() - Prepare the dummy SMBIOS table
*
* @systable system table
- * @return status code
+ * Return: status code
*/
static efi_status_t setup_smbios_table(const struct efi_system_table *systable)
{
@@ -676,7 +676,7 @@
*
* @tcg2 tcg2 protocol
* @manufacturer_id pointer to the manufacturer_id
- * @return status code
+ * Return: status code
*/
static efi_status_t get_manufacturer_id(struct efi_tcg2_protocol *tcg2, u32 *manufacturer_id)
{
@@ -716,7 +716,7 @@
*
* @tcg2 tcg2 protocol
* @manufacturer_id pointer to the manufacturer_id
- * @return status code
+ * Return: status code
*/
static efi_status_t get_manufacturer_id_buffer_small(struct efi_tcg2_protocol *tcg2)
{
@@ -742,7 +742,7 @@
*
* @tcg2 tcg2 protocol
* @idx pcr index to read
- * @return status code
+ * Return: status code
*/
static efi_status_t read_pcr(struct efi_tcg2_protocol *tcg2, u32 idx)
{
@@ -779,7 +779,7 @@
/**
* int validate_pcrs() - Compare the expected and actual pcrs
*
- * @return status code
+ * Return: status code
*/
static int validate_pcrs(void)
{
diff --git a/lib/fdtdec.c b/lib/fdtdec.c
index 280cda6..87aa677 100644
--- a/lib/fdtdec.c
+++ b/lib/fdtdec.c
@@ -656,7 +656,7 @@
* @param min_len minimum property length in bytes
* @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
found, or -FDT_ERR_BADLAYOUT if not enough data
- * @return pointer to cell, which is only valid if err == 0
+ * Return: pointer to cell, which is only valid if err == 0
*/
static const void *get_prop_check_min_len(const void *blob, int node,
const char *prop_name, int min_len,
@@ -1219,7 +1219,7 @@
/**
* fdt_find_separate() - Find a devicetree at the end of the image
*
- * @return pointer to FDT blob
+ * Return: pointer to FDT blob
*/
static void *fdt_find_separate(void)
{
diff --git a/lib/of_live.c b/lib/of_live.c
index 05a45ed..2cb0dd9 100644
--- a/lib/of_live.c
+++ b/lib/of_live.c
@@ -257,7 +257,7 @@
* can be used.
* @blob: The blob to expand
* @mynodes: The device_node tree created by the call
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int unflatten_device_tree(const void *blob,
struct device_node **mynodes)
diff --git a/lib/rsa/rsa-mod-exp.c b/lib/rsa/rsa-mod-exp.c
index 74f9eb1..d259b2a 100644
--- a/lib/rsa/rsa-mod-exp.c
+++ b/lib/rsa/rsa-mod-exp.c
@@ -59,7 +59,7 @@
*
* @key: Key containing modulus to check
* @num: Number to check against modulus, as little endian word array
- * @return 0 if num < modulus, 1 if num >= modulus
+ * Return: 0 if num < modulus, 1 if num >= modulus
*/
static int greater_equal_modulus(const struct rsa_public_key *key,
uint32_t num[])
@@ -315,7 +315,7 @@
*
* @keyptr: RSA key
* @inout: Big-endian word array containing value and result
- * @return 0 on successful calculation, otherwise failure error code
+ * Return: 0 on successful calculation, otherwise failure error code
*
* FIXME: Use pow_mod() instead of zynq_pow_mod()
* pow_mod calculation required for zynq is bit different from
diff --git a/lib/rsa/rsa-sign.c b/lib/rsa/rsa-sign.c
index 3b6e5f0..a95a3d2 100644
--- a/lib/rsa/rsa-sign.c
+++ b/lib/rsa/rsa-sign.c
@@ -38,7 +38,7 @@
* @keydir: Directory containins the key
* @name Name of key file (will have a .crt extension)
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_pem_get_pub_key(const char *keydir, const char *name, EVP_PKEY **evpp)
{
@@ -96,7 +96,7 @@
* @name Name of key
* @engine Engine to use
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_engine_get_pub_key(const char *keydir, const char *name,
ENGINE *engine, EVP_PKEY **evpp)
@@ -156,7 +156,7 @@
* @name Name of key file (will have a .crt extension)
* @engine Engine to use
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_get_pub_key(const char *keydir, const char *name,
ENGINE *engine, EVP_PKEY **evpp)
@@ -172,7 +172,7 @@
* @keydir: Directory containing the key
* @name Name of key file (will have a .key extension)
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_pem_get_priv_key(const char *keydir, const char *name,
const char *keyfile, EVP_PKEY **evpp)
@@ -215,7 +215,7 @@
* @name Name of key
* @engine Engine to use
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_engine_get_priv_key(const char *keydir, const char *name,
const char *keyfile,
@@ -283,7 +283,7 @@
* @name Name of key
* @engine Engine to use for signing
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_get_priv_key(const char *keydir, const char *name,
const char *keyfile, ENGINE *engine, EVP_PKEY **evpp)
diff --git a/lib/rsa/rsa-verify.c b/lib/rsa/rsa-verify.c
index 83f7564..fbb2d35 100644
--- a/lib/rsa/rsa-verify.c
+++ b/lib/rsa/rsa-verify.c
@@ -47,7 +47,7 @@
* @msg: Padded message
* @pad_len: Number of expected padding bytes
* @algo: Checksum algo structure having information on DER encoding etc.
- * @return 0 on success, != 0 on failure
+ * Return: 0 on success, != 0 on failure
*/
static int rsa_verify_padding(const uint8_t *msg, const int pad_len,
struct checksum_algo *algo)
@@ -122,7 +122,7 @@
* @seed_len: Size of the input octet string
* @output: Specifies the output octet string
* @output_len: Size of the output octet string
- * @return 0 if the octet string was correctly generated, others on error
+ * Return: 0 if the octet string was correctly generated, others on error
*/
static int mask_generation_function1(struct checksum_algo *checksum,
uint8_t *seed, int seed_len,
@@ -325,7 +325,7 @@
* @sig_len: Number of bytes in signature
* @hash: Pointer to the expected hash
* @key_len: Number of bytes in rsa key
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
static int rsa_verify_key(struct image_sign_info *info,
struct key_prop *prop, const uint8_t *sig,
@@ -437,7 +437,7 @@
* @sig: Signature
* @sig_len: Number of bytes in signature
* @node: Node having the RSA Key properties
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
static int rsa_verify_with_keynode(struct image_sign_info *info,
const void *hash, uint8_t *sig,
diff --git a/lib/strto.c b/lib/strto.c
index 7bba1e3..f191884 100644
--- a/lib/strto.c
+++ b/lib/strto.c
@@ -42,7 +42,7 @@
* This ignore case
*
* @ch: Character to convert (expects '0'..'9', 'a'..'f' or 'A'..'F')
- * @return value of digit (0..0xf) or 255 if the character is invalid
+ * Return: value of digit (0..0xf) or 255 if the character is invalid
*/
static uint decode_digit(int ch)
{
diff --git a/lib/tpm-utils.h b/lib/tpm-utils.h
index d680d14..a519e18 100644
--- a/lib/tpm-utils.h
+++ b/lib/tpm-utils.h
@@ -31,7 +31,7 @@
* @param size size of output string
* @param format format string
* @param ... data points
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
int pack_byte_string(u8 *str, size_t size, const char *format, ...);
@@ -46,7 +46,7 @@
* @param size size of output string
* @param format format string
* @param ... data points
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
int unpack_byte_string(const u8 *str, size_t size, const char *format, ...);
@@ -54,7 +54,7 @@
* Get TPM command size.
*
* @param command byte string of TPM command
- * @return command size of the TPM command
+ * Return: command size of the TPM command
*/
u32 tpm_command_size(const void *command);
@@ -62,7 +62,7 @@
* Get TPM response return code, which is one of TPM_RESULT values.
*
* @param response byte string of TPM response
- * @return return code of the TPM response
+ * Return: return code of the TPM response
*/
u32 tpm_return_code(const void *response);
@@ -76,7 +76,7 @@
* @param size_ptr output buffer size (input parameter) and TPM
* response length (output parameter); this parameter
* is a bidirectional
- * @return return code of the TPM response
+ * Return: return code of the TPM response
*/
u32 tpm_sendrecv_command(struct udevice *dev, const void *command,
void *response, size_t *size_ptr);
diff --git a/lib/zstd/bitstream.h b/lib/zstd/bitstream.h
index 73aacc9..44abfd5 100644
--- a/lib/zstd/bitstream.h
+++ b/lib/zstd/bitstream.h
@@ -127,7 +127,7 @@
****************************************************************/
/*! BIT_initCStream() :
* `dstCapacity` must be > sizeof(void*)
- * @return : 0 if success,
+ * Return: 0 if success,
otherwise an error code (can be tested using ERR_isError() ) */
ZSTD_STATIC size_t BIT_initCStream(BIT_CStream_t *bitC, void *startPtr, size_t dstCapacity)
{
@@ -184,7 +184,7 @@
}
/*! BIT_closeCStream() :
- * @return : size of CStream, in bytes,
+ * Return: size of CStream, in bytes,
or 0 if it could not fit into dstBuffer */
ZSTD_STATIC size_t BIT_closeCStream(BIT_CStream_t *bitC)
{
@@ -259,7 +259,7 @@
* local register is not modified.
* On 32-bits, maxNbBits==24.
* On 64-bits, maxNbBits==56.
- * @return : value extracted
+ * Return: value extracted
*/
ZSTD_STATIC size_t BIT_lookBits(const BIT_DStream_t *bitD, U32 nbBits)
{
@@ -280,7 +280,7 @@
/*! BIT_readBits() :
* Read (consume) next n bits from local register and update.
* Pay attention to not read more than nbBits contained into local register.
- * @return : extracted value.
+ * Return: extracted value.
*/
ZSTD_STATIC size_t BIT_readBits(BIT_DStream_t *bitD, U32 nbBits)
{
diff --git a/lib/zstd/decompress.c b/lib/zstd/decompress.c
index ae3be3f..edfddd8 100644
--- a/lib/zstd/decompress.c
+++ b/lib/zstd/decompress.c
@@ -306,7 +306,7 @@
* compatible with legacy mode
* `srcSize` must be the exact length of some number of ZSTD compressed and/or
* skippable frames
- * @return : decompressed size of the frames contained */
+ * Return: decompressed size of the frames contained */
unsigned long long ZSTD_findDecompressedSize(const void *src, size_t srcSize)
{
{
@@ -1497,7 +1497,7 @@
* compatible with legacy mode
* `src` must point to the start of a ZSTD frame, ZSTD legacy frame, or skippable frame
* `srcSize` must be at least as large as the frame contained
- * @return : the compressed size of the frame starting at `src` */
+ * Return: the compressed size of the frame starting at `src` */
size_t ZSTD_findFrameCompressedSize(const void *src, size_t srcSize)
{
if (srcSize >= ZSTD_skippableHeaderSize && (ZSTD_readLE32(src) & 0xFFFFFFF0U) == ZSTD_MAGIC_SKIPPABLE_START) {
@@ -1860,7 +1860,7 @@
/* ZSTD_loadEntropy() :
* dict : must point at beginning of a valid zstd dictionary
- * @return : size of entropy tables read */
+ * Return: size of entropy tables read */
static size_t ZSTD_loadEntropy(ZSTD_entropyTables_t *entropy, const void *const dict, size_t const dictSize)
{
const BYTE *dictPtr = (const BYTE *)dict;