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>

11 files changed, 48 insertions, 48 deletions

diff --git a/drivers/mtd/mtd_uboot.c b/drivers/mtd/mtd_uboot.c
index 90767ec..dd0b024 100644
--- a/drivers/mtd/mtd_uboot.c
+++ b/drivers/mtd/mtd_uboot.c
@@ -54,7 +54,7 @@ static const char *get_mtdids(void)
  * @altname: Alternate name to return
  * @max_len: Length of the alternate name buffer
  *
- * @return 0 on success, an error otherwise.
+ * Return: 0 on success, an error otherwise.
  */
 int mtd_search_alternate_name(const char *mtdname, char *altname,
 			      unsigned int max_len)
diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c
index 1d45fb5..aa78d41 100644
--- a/drivers/mtd/mtdcore.c
+++ b/drivers/mtd/mtdcore.c
@@ -850,7 +850,7 @@ EXPORT_SYMBOL_GPL(get_mtd_device_nm);
  * @param mtd an MTD device
  * @param offset offset in flash
  * @param length image length
- * @return image length including bad blocks in *len_incl_bad and whether or not
+ * Return: image length including bad blocks in *len_incl_bad and whether or not
  *         the length returned was truncated in *truncated
  */
 void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset,
diff --git a/drivers/mtd/mtdpart.c b/drivers/mtd/mtdpart.c
index a435ce6..4119ea4 100644
--- a/drivers/mtd/mtdpart.c
+++ b/drivers/mtd/mtdpart.c
@@ -89,7 +89,7 @@ bool mtd_partitions_used(struct mtd_info *master)
  * @mtdparts: String describing the partition with mtdparts command syntax
  * @partition: MTD partition structure to fill
  *
- * @return 0 on success, an error otherwise.
+ * Return: 0 on success, an error otherwise.
  */
 static int mtd_parse_partition(const char **_mtdparts,
 			       struct mtd_partition *partition)
@@ -200,7 +200,7 @@ static int mtd_parse_partition(const char **_mtdparts,
  *          caller.
  * @_nparts: Size of @_parts array.
  *
- * @return 0 on success, an error otherwise.
+ * Return: 0 on success, an error otherwise.
  */
 int mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts,
 			 struct mtd_partition **_parts, int *_nparts)
diff --git a/drivers/mtd/nand/raw/cortina_nand.c b/drivers/mtd/nand/raw/cortina_nand.c
index c5e97da..88798f2 100644
--- a/drivers/mtd/nand/raw/cortina_nand.c
+++ b/drivers/mtd/nand/raw/cortina_nand.c
@@ -83,7 +83,7 @@ static int nand_waitfor_cmd_completion(struct nand_ctlr *reg, unsigned int mask)
  * Read one byte from the chip
  *
  * @param mtd	MTD device structure
- * @return	data byte
+ * Return:	data byte
  *
  * Read function for 8bit bus-width
  */
@@ -504,7 +504,7 @@ static void ca_nand_command(struct mtd_info *mtd, unsigned int command,
  * Set up NAND bus width and page size
  *
  * @param info		nand_info structure
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 static int set_bus_width_page_size(struct mtd_info *mtd)
 {
@@ -724,7 +724,7 @@ static int ca_do_bch_encode(struct mtd_info *mtd, struct nand_chip *chip,
  * @param page		page number
  * @param with_ecc	1 to enable ECC, 0 to disable ECC
  * @param is_writing	0 for read, 1 for write
- * @return		0 when successfully completed
+ * Return:		0 when successfully completed
  *			-ETIMEDOUT when command timeout
  */
 static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip,
@@ -952,7 +952,7 @@ static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip,
  * @param chip	nand chip info structure
  * @param buf	buffer to store read data
  * @param page	page number to read
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-ETIMEDOUT when command timeout
  */
 static int nand_read_page_hwecc(struct mtd_info *mtd,
@@ -980,7 +980,7 @@ static int nand_read_page_hwecc(struct mtd_info *mtd,
  * @param mtd	mtd info structure
  * @param chip	nand chip info structure
  * @param buf	data buffer
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-ETIMEDOUT when command timeout
  */
 static int nand_write_page_hwecc(struct mtd_info *mtd,
@@ -1009,7 +1009,7 @@ static int nand_write_page_hwecc(struct mtd_info *mtd,
  * @param chip	nand chip info structure
  * @param buf	buffer to store read data
  * @param page	page number to read
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-ETIMEDOUT when command timeout
  */
 static int nand_read_page_raw(struct mtd_info *mtd,
@@ -1037,7 +1037,7 @@ static int nand_read_page_raw(struct mtd_info *mtd,
  * @param mtd	mtd info structure
  * @param chip	nand chip info structure
  * @param buf	data buffer
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-ETIMEDOUT when command timeout
  */
 static int nand_write_page_raw(struct mtd_info *mtd,
@@ -1067,7 +1067,7 @@ static int nand_write_page_raw(struct mtd_info *mtd,
  * @param page		page number to read
  * @param with_ecc	1 to enable ECC, 0 to disable ECC
  * @param is_writing	0 for read, 1 for write
- * @return		0 when successfully completed
+ * Return:		0 when successfully completed
  *			-ETIMEDOUT when command timeout
  */
 static int nand_rw_oob(struct mtd_info *mtd, struct nand_chip *chip,
@@ -1137,7 +1137,7 @@ static int nand_read_oob(struct mtd_info *mtd, struct nand_chip *chip, int page)
  * @param mtd	mtd info structure
  * @param chip	nand chip info structure
  * @param page	page number to write
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-ETIMEDOUT when command timeout
  */
 static int nand_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
@@ -1239,7 +1239,7 @@ static void nand_config_flash_type(struct nand_chip *nand)
  * config oob layout
  *
  * @param chip  nand chip info structure
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-EINVAL when ECC bytes exceed OOB size
  */
 static int nand_config_oob_layout(struct nand_chip *nand)
diff --git a/drivers/mtd/nand/raw/nand_util.c b/drivers/mtd/nand/raw/nand_util.c
index 5409c9f..5150607 100644
--- a/drivers/mtd/nand/raw/nand_util.c
+++ b/drivers/mtd/nand/raw/nand_util.c
@@ -47,7 +47,7 @@ typedef struct mtd_info		mtd_info_t;
  *
  * @param mtd		nand mtd instance to erase
  * @param opts		options,  @see struct nand_erase_options
- * @return		0 in case of success
+ * Return:		0 in case of success
  *
  * This code is ported from flash_eraseall.c from Linux mtd utils by
  * Arcom Control System Ltd.
@@ -202,7 +202,7 @@ int nand_erase_opts(struct mtd_info *mtd,
  * @param mtd		nand mtd instance
  * @param tight		bring device in lock tight mode
  *
- * @return		0 on success, -1 in case of error
+ * Return:		0 on success, -1 in case of error
  *
  * The lock / lock-tight command only applies to the whole chip. To get some
  * parts of the chip lock and others unlocked use the following sequence:
@@ -258,7 +258,7 @@ int nand_lock(struct mtd_info *mtd, int tight)
  * @param mtd		nand mtd instance
  * @param offset	page address to query (must be page-aligned!)
  *
- * @return		-1 in case of error
+ * Return:		-1 in case of error
  *			>0 lock status:
  *			  bitfield with the following combinations:
  *			  NAND_LOCK_STATUS_TIGHT: page in tight state
@@ -308,7 +308,7 @@ int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
  *			page size mtd->writesize)
  * @param allexcept	if set, unlock everything not selected
  *
- * @return		0 on success, -1 in case of error
+ * Return:		0 on success, -1 in case of error
  */
 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
 	int allexcept)
@@ -405,7 +405,7 @@ int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
  * @param offset offset in flash
  * @param length image length
  * @param used length of flash needed for the requested length
- * @return 0 if the image fits and there are no bad blocks
+ * Return: 0 if the image fits and there are no bad blocks
  *         1 if the image fits, but there are bad blocks
  *        -1 if the image does not fit
  */
@@ -476,7 +476,7 @@ static size_t drop_ffs(const struct mtd_info *mtd, const u_char *buf,
  * @param mtd		nand mtd instance
  * @param ops		MTD operations, including data to verify
  * @param ofs		offset in flash
- * @return		0 in case of success
+ * Return:		0 in case of success
  */
 int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
 			 loff_t ofs)
@@ -517,7 +517,7 @@ int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
  * @param ofs		offset in flash
  * @param len		buffer length
  * @param buf		buffer to read from
- * @return		0 in case of success
+ * Return:		0 in case of success
  */
 int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
 {
@@ -568,7 +568,7 @@ int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
  *			exceed the buffer
  * @param buffer        buffer to read from
  * @param flags		flags modifying the behaviour of the write to NAND
- * @return		0 in case of success
+ * Return:		0 in case of success
  */
 int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
 			size_t *actual, loff_t lim, u_char *buffer, int flags)
@@ -702,7 +702,7 @@ int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  * @param lim maximum size that actual may be in order to not exceed the
  * buffer
  * @param buffer buffer to write to
- * @return 0 in case of success
+ * Return: 0 in case of success
  */
 int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
 		       size_t *actual, loff_t lim, u_char *buffer)
@@ -793,7 +793,7 @@ int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  * @param buf buffer to check
  * @param patt the pattern to check
  * @param size buffer size in bytes
- * @return 1 if there are only patt bytes in buf
+ * Return: 1 if there are only patt bytes in buf
  *         0 if something else was found
  */
 static int check_pattern(const u_char *buf, u_char patt, int size)
@@ -815,7 +815,7 @@ static int check_pattern(const u_char *buf, u_char patt, int size)
  *
  * @param mtd nand mtd instance
  * @param offset offset in flash
- * @return 0 if the block is still good
+ * Return: 0 if the block is still good
  */
 int nand_torture(struct mtd_info *mtd, loff_t offset)
 {
diff --git a/drivers/mtd/nand/raw/octeontx_bch.c b/drivers/mtd/nand/raw/octeontx_bch.c
index a417728..24ffa51 100644
--- a/drivers/mtd/nand/raw/octeontx_bch.c
+++ b/drivers/mtd/nand/raw/octeontx_bch.c
@@ -218,7 +218,7 @@ static const struct pci_device_id octeontx_bchvf_pci_id_table[] = {
  * @param[out] ecc	8-byte aligned pointer to where ecc data should go
  * @param[in] resp	pointer to where responses will be written.
  *
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
  */
 int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size,
 			u8 bch_level, dma_addr_t ecc, dma_addr_t resp)
@@ -259,7 +259,7 @@ int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size,
  *				This should not be the same as block_ecc_in.
  * @param[in] resp		pointer to where responses will be written.
  *
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
  */
 
 int octeontx_bch_decode(struct bch_vf *vf, dma_addr_t block_ecc_in,
diff --git a/drivers/mtd/nand/raw/octeontx_bch.h b/drivers/mtd/nand/raw/octeontx_bch.h
index 3aaa52c..95a9b71 100644
--- a/drivers/mtd/nand/raw/octeontx_bch.h
+++ b/drivers/mtd/nand/raw/octeontx_bch.h
@@ -75,7 +75,7 @@ int octeontx_bch_wait(struct bch_vf *vf, union bch_resp *resp,
  * @param[out] ecc	8-byte aligned pointer to where ecc data should go
  * @param[in] resp	pointer to where responses will be written.
  *
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
  */
 int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size,
 			u8 bch_level, dma_addr_t ecc, dma_addr_t resp);
@@ -95,7 +95,7 @@ int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size,
  *				This should not be the same as block_ecc_in.
  * @param[in] resp		pointer to where responses will be written.
  *
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
  */
 
 int octeontx_bch_decode(struct bch_vf *vf, dma_addr_t block_ecc_in,
@@ -124,7 +124,7 @@ static inline void octeontx_bch_write_doorbell(u64 num_commands,
  * In this case, the initial probe returns success but the actual probing
  * is deferred until the BCH VF has been probed.
  *
- * @return	0 for success, otherwise error
+ * Return:	0 for success, otherwise error
  */
 int octeontx_pci_nand_deferred_probe(void);
 
diff --git a/drivers/mtd/nand/raw/octeontx_nand.c b/drivers/mtd/nand/raw/octeontx_nand.c
index 75476c0..ff363a5 100644
--- a/drivers/mtd/nand/raw/octeontx_nand.c
+++ b/drivers/mtd/nand/raw/octeontx_nand.c
@@ -2179,7 +2179,7 @@ int octeontx_pci_nand_disable(struct udevice *dev)
  * In this case, the initial probe returns success but the actual probing
  * is deferred until the BCH VF has been probed.
  *
- * @return	0 for success, otherwise error
+ * Return:	0 for success, otherwise error
  */
 int octeontx_pci_nand_deferred_probe(void)
 {
diff --git a/drivers/mtd/nand/raw/omap_gpmc.c b/drivers/mtd/nand/raw/omap_gpmc.c
index 107447f..8b9ff4d 100644
--- a/drivers/mtd/nand/raw/omap_gpmc.c
+++ b/drivers/mtd/nand/raw/omap_gpmc.c
@@ -117,7 +117,7 @@ static uint32_t gen_true_ecc(uint8_t *ecc_buf)
  * @read_ecc:		 ecc read from nand flash
  * @calc_ecc:		 ecc read from ECC registers
  *
- * @return 0 if data is OK or corrected, else returns -1
+ * Return: 0 if data is OK or corrected, else returns -1
  */
 static int __maybe_unused omap_correct_data(struct mtd_info *mtd, uint8_t *dat,
 				uint8_t *read_ecc, uint8_t *calc_ecc)
@@ -488,7 +488,7 @@ static void omap_reverse_list(u8 *list, unsigned int length)
  * @read_ecc:	ecc read from nand flash (ignored)
  * @calc_ecc:	ecc read from ECC registers
  *
- * @return 0 if data is OK or corrected, else returns -1
+ * Return: 0 if data is OK or corrected, else returns -1
  */
 static int omap_correct_data_bch(struct mtd_info *mtd, uint8_t *dat,
 				uint8_t *read_ecc, uint8_t *calc_ecc)
diff --git a/drivers/mtd/nand/raw/tegra_nand.c b/drivers/mtd/nand/raw/tegra_nand.c
index 8e70c8e..d2801d4 100644
--- a/drivers/mtd/nand/raw/tegra_nand.c
+++ b/drivers/mtd/nand/raw/tegra_nand.c
@@ -152,7 +152,7 @@ static int nand_waitfor_cmd_completion(struct nand_ctlr *reg)
  * Read one byte from the chip
  *
  * @param mtd	MTD device structure
- * @return	data byte
+ * Return:	data byte
  *
  * Read function for 8bit bus-width
  */
@@ -466,7 +466,7 @@ static void stop_command(struct nand_ctlr *reg)
  *
  * @param info		nand_info structure
  * @param *reg_val	address of reg_val
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 static int set_bus_width_page_size(struct mtd_info *our_mtd,
 				   struct fdt_nand *config, u32 *reg_val)
@@ -505,7 +505,7 @@ static int set_bus_width_page_size(struct mtd_info *our_mtd,
  * @param page		page number
  * @param with_ecc	1 to enable ECC, 0 to disable ECC
  * @param is_writing	0 for read, 1 for write
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-EIO when command timeout
  */
 static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip,
@@ -655,7 +655,7 @@ static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip,
  * @param chip	nand chip info structure
  * @param buf	buffer to store read data
  * @param page	page number to read
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-EIO when command timeout
  */
 static int nand_read_page_hwecc(struct mtd_info *mtd,
@@ -687,7 +687,7 @@ static int nand_write_page_hwecc(struct mtd_info *mtd,
  * @param chip	nand chip info structure
  * @param buf	buffer to store read data
  * @param page	page number to read
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-EINVAL when chip->oob_poi is not double-word aligned
  *		-EIO when command timeout
  */
@@ -720,7 +720,7 @@ static int nand_write_page_raw(struct mtd_info *mtd,
  * @param page		page number to read
  * @param with_ecc	1 to enable ECC, 0 to disable ECC
  * @param is_writing	0 for read, 1 for write
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-EINVAL when chip->oob_poi is not double-word aligned
  *		-EIO when command timeout
  */
@@ -838,7 +838,7 @@ static int nand_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
  * @param mtd	mtd info structure
  * @param chip	nand chip info structure
  * @param page	page number to write
- * @return	0 when successfully completed
+ * Return:	0 when successfully completed
  *		-EINVAL when chip->oob_poi is not double-word aligned
  *		-EIO when command timeout
  */
@@ -900,7 +900,7 @@ static void setup_timing(unsigned timing[FDT_NAND_TIMING_COUNT],
  *
  * @param dev		Driver model device
  * @param config	Device tree NAND configuration
- * @return 0 if ok, -ve on error (FDT_ERR_...)
+ * Return: 0 if ok, -ve on error (FDT_ERR_...)
  */
 static int fdt_decode_nand(struct udevice *dev, struct fdt_nand *config)
 {
diff --git a/drivers/mtd/onenand/onenand_base.c b/drivers/mtd/onenand/onenand_base.c
index 56e1858..f94597c 100644
--- a/drivers/mtd/onenand/onenand_base.c
+++ b/drivers/mtd/onenand/onenand_base.c
@@ -148,7 +148,7 @@ static void onenand_writew(unsigned short value, void __iomem * addr)
  * onenand_block_address - [DEFAULT] Get block address
  * @param device	the device id
  * @param block		the block
- * @return		translated block address if DDP, otherwise same
+ * Return:		translated block address if DDP, otherwise same
  *
  * Setup Start Address 1 Register (F100h)
  */
@@ -165,7 +165,7 @@ static int onenand_block_address(struct onenand_chip *this, int block)
  * onenand_bufferram_address - [DEFAULT] Get bufferram address
  * @param device	the device id
  * @param block		the block
- * @return		set DBS value if DDP, otherwise 0
+ * Return:		set DBS value if DDP, otherwise 0
  *
  * Setup Start Address 2 Register (F101h) for DDP
  */
@@ -182,7 +182,7 @@ static int onenand_bufferram_address(struct onenand_chip *this, int block)
  * onenand_page_address - [DEFAULT] Get page address
  * @param page		the page address
  * @param sector	the sector address
- * @return		combined page and sector address
+ * Return:		combined page and sector address
  *
  * Setup Start Address 8 Register (F107h)
  */
@@ -202,7 +202,7 @@ static int onenand_page_address(int page, int sector)
  * @param dataram1	DataRAM index
  * @param sectors	the sector address
  * @param count		the number of sectors
- * @return		the start buffer value
+ * Return:		the start buffer value
  *
  * Setup Start Buffer Register (F200h)
  */
@@ -511,7 +511,7 @@ static int onenand_wait(struct mtd_info *mtd, int state)
  * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
  * @param mtd		MTD data structure
  * @param area		BufferRAM area
- * @return		offset given area
+ * Return:		offset given area
  *
  * Return BufferRAM offset given area
  */
@@ -612,7 +612,7 @@ static int onenand_write_bufferram(struct mtd_info *mtd, loff_t addr, int area,
  * onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode
  * @param mtd		MTD data structure
  * @param addr		address to check
- * @return		blockpage address
+ * Return:		blockpage address
  *
  * Get blockpage address at 2x program mode
  */
@@ -636,7 +636,7 @@ static int onenand_get_2x_blockpage(struct mtd_info *mtd, loff_t addr)
  * onenand_check_bufferram - [GENERIC] Check BufferRAM information
  * @param mtd		MTD data structure
  * @param addr		address to check
- * @return		1 if there are valid data, otherwise 0
+ * Return:		1 if there are valid data, otherwise 0
  *
  * Check bufferram if there is data we required
  */