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/drivers/net/fec_mxc.c b/drivers/net/fec_mxc.c
index 811bc27..985b038 100644
--- a/drivers/net/fec_mxc.c
+++ b/drivers/net/fec_mxc.c
@@ -331,7 +331,7 @@
* @param[in] fec all we know about the device yet
* @param[in] count receive buffer count to be allocated
* @param[in] dsize desired size of each receive buffer
- * @return 0 on success
+ * Return: 0 on success
*
* Init all RX descriptors to default values.
*/
@@ -703,7 +703,7 @@
* @param[in] dev Our ethernet device to handle
* @param[in] packet Pointer to the data to be transmitted
* @param[in] length Data count in bytes
- * @return 0 on success
+ * Return: 0 on success
*/
#ifdef CONFIG_DM_ETH
static int fecmxc_send(struct udevice *dev, void *packet, int length)
@@ -854,7 +854,7 @@
/**
* Pull one frame from the card
* @param[in] dev Our ethernet device to handle
- * @return Length of packet read
+ * Return: Length of packet read
*/
#ifdef CONFIG_DM_ETH
static int fecmxc_recv(struct udevice *dev, int flags, uchar **packetp)
diff --git a/drivers/net/octeontx2/cgx.c b/drivers/net/octeontx2/cgx.c
index 189fe7c..d139029 100644
--- a/drivers/net/octeontx2/cgx.c
+++ b/drivers/net/octeontx2/cgx.c
@@ -52,7 +52,7 @@
*
* @param instance instance to find
*
- * @return pointer to lmac data structure or NULL if not found
+ * Return: pointer to lmac data structure or NULL if not found
*/
struct lmac *nix_get_cgx_lmac(int lmac_instance)
{
diff --git a/drivers/net/octeontx2/cgx.h b/drivers/net/octeontx2/cgx.h
index f287692..b1f6f06 100644
--- a/drivers/net/octeontx2/cgx.h
+++ b/drivers/net/octeontx2/cgx.h
@@ -82,7 +82,7 @@
*
* @param instance instance to find
*
- * @return pointer to lmac data structure or NULL if not found
+ * Return: pointer to lmac data structure or NULL if not found
*/
struct lmac *nix_get_cgx_lmac(int lmac_instance);
diff --git a/drivers/net/octeontx2/lmt.h b/drivers/net/octeontx2/lmt.h
index 84a7eab..3b30992 100644
--- a/drivers/net/octeontx2/lmt.h
+++ b/drivers/net/octeontx2/lmt.h
@@ -15,7 +15,7 @@
* @param ptr address in memory to add incr to
* @param incr amount to increment memory location by (signed)
*
- * @return Value of memory location before increment
+ * Return: Value of memory location before increment
*/
static inline s64 atomic_fetch_and_add64_nosync(s64 *ptr, s64 incr)
{
diff --git a/drivers/net/octeontx2/nix.c b/drivers/net/octeontx2/nix.c
index 5954737..a5665a2 100644
--- a/drivers/net/octeontx2/nix.c
+++ b/drivers/net/octeontx2/nix.c
@@ -36,7 +36,7 @@
* @param elem_size Size of each element
* @param msg Text string to show when allocation fails
*
- * @return A valid memory location or NULL on failure
+ * Return: A valid memory location or NULL on failure
*/
static void *nix_memalloc(int num_elements, size_t elem_size, const char *msg)
{
diff --git a/drivers/net/octeontx2/nix_af.c b/drivers/net/octeontx2/nix_af.c
index d513917..cd098d6 100644
--- a/drivers/net/octeontx2/nix_af.c
+++ b/drivers/net/octeontx2/nix_af.c
@@ -336,7 +336,7 @@
*
* @param nix Handle to setup
*
- * @return 0, or negative on failure
+ * Return: 0, or negative on failure
*/
static int nix_af_setup_sq(struct nix *nix)
{
@@ -445,7 +445,7 @@
* @param cindex Context index
* @param resp Result pointer
*
- * @return 0 for success, -EBUSY on failure
+ * Return: 0 for success, -EBUSY on failure
*/
static int nix_aq_issue_command(struct nix_af *nix_af,
int lf,
diff --git a/drivers/net/octeontx2/rvu.h b/drivers/net/octeontx2/rvu.h
index c0a834b..62bc7a6 100644
--- a/drivers/net/octeontx2/rvu.h
+++ b/drivers/net/octeontx2/rvu.h
@@ -101,7 +101,7 @@
* @param inst_size Size of each instruction
* @param res_size Size of each result
*
- * @return -ENOMEM on error, 0 on success
+ * Return: -ENOMEM on error, 0 on success
*/
int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize,
size_t inst_size, size_t res_size);
diff --git a/drivers/net/octeontx2/rvu_common.c b/drivers/net/octeontx2/rvu_common.c
index 173b28b..4d8173f 100644
--- a/drivers/net/octeontx2/rvu_common.c
+++ b/drivers/net/octeontx2/rvu_common.c
@@ -41,7 +41,7 @@
* @param inst_size Size of each instruction
* @param res_size Size of each result
*
- * @return -ENOMEM on error, 0 on success
+ * Return: -ENOMEM on error, 0 on success
*/
int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize,
size_t inst_size, size_t res_size)
diff --git a/drivers/net/pfe_eth/pfe_driver.c b/drivers/net/pfe_eth/pfe_driver.c
index 6f443b4..5e14f82 100644
--- a/drivers/net/pfe_eth/pfe_driver.c
+++ b/drivers/net/pfe_eth/pfe_driver.c
@@ -25,7 +25,7 @@
* @param[out] pkt_ptr - Pointer to store rx packet
* @param[out] phy_port - Pointer to store recv phy port
*
- * @return -1 if no packet, else return length of packet.
+ * Return: -1 if no packet, else return length of packet.
*/
int pfe_recv(uchar **pkt_ptr, int *phy_port)
{
@@ -121,7 +121,7 @@
* @param[in] data Pointer to the data
* @param[in] length Length of the ethernet packet to be transferred.
*
- * @return -1 if tx Q is full, else returns the tx location where the pkt is
+ * Return: -1 if tx Q is full, else returns the tx location where the pkt is
* placed.
*/
int pfe_send(int phy_port, void *data, int length)
@@ -190,7 +190,7 @@
* locations
* if success, moves the tx_to_send to next location.
*
- * @return -1 if TX ownership bit is not cleared by hw.
+ * Return: -1 if TX ownership bit is not cleared by hw.
* else on success (tx done completion) return zero.
*/
int pfe_tx_done(void)
@@ -557,7 +557,7 @@
*
* @param[in] edev Pointer to eth device structure.
*
- * @return 0, on success.
+ * Return: 0, on success.
*/
static int pfe_hw_init(struct pfe_ddr_address *pfe_addr)
{
diff --git a/drivers/net/pfe_eth/pfe_eth.c b/drivers/net/pfe_eth/pfe_eth.c
index 0c27a66..d338b36 100644
--- a/drivers/net/pfe_eth/pfe_eth.c
+++ b/drivers/net/pfe_eth/pfe_eth.c
@@ -101,7 +101,7 @@
*
* @param[in] edev Pointer to eth device structure.
*
- * @return none
+ * Return: none
*/
static inline void pfe_eth_stop(struct udevice *dev)
{
diff --git a/drivers/net/pfe_eth/pfe_firmware.c b/drivers/net/pfe_eth/pfe_firmware.c
index 93e5ea5..6669048 100644
--- a/drivers/net/pfe_eth/pfe_firmware.c
+++ b/drivers/net/pfe_eth/pfe_firmware.c
@@ -37,7 +37,7 @@
* @param pe_mask Mask of PE id's to load firmware to
* @param pfe_firmware Pointer to the firmware image
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
static int pfe_load_elf(int pe_mask, uint8_t *pfe_firmware)
{
@@ -99,7 +99,7 @@
* @param size pointer to size of the firmware
* @param fw_name pfe firmware name, either class or tmu
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
static int pfe_get_fw(const void **data,
size_t *size, char *fw_name)
@@ -148,7 +148,7 @@
/*
* Check PFE FIT image
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
static int pfe_fit_check(void)
{
@@ -248,7 +248,7 @@
* firmware files
* Takes PE's out of reset
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
int pfe_firmware_init(void)
{
diff --git a/drivers/net/pfe_eth/pfe_hw.c b/drivers/net/pfe_eth/pfe_hw.c
index 722f5c2..4db6f31 100644
--- a/drivers/net/pfe_eth/pfe_hw.c
+++ b/drivers/net/pfe_eth/pfe_hw.c
@@ -128,7 +128,7 @@
* @param[in] addr PMEM read address (must be aligned on size)
* @param[in] size Number of bytes to read (maximum 4, must not
* cross 32bit boundaries)
- * @return the data read (in PE endianness, i.e BE).
+ * Return: the data read (in PE endianness, i.e BE).
*/
u32 pe_pmem_read(int id, u32 addr, u8 size)
{
@@ -176,7 +176,7 @@
* @param[in] addr DMEM read address (must be aligned on size)
* @param[in] size Number of bytes to read (maximum 4, must not
* cross 32bit boundaries)
- * @return the data read (in PE endianness, i.e BE).
+ * Return: the data read (in PE endianness, i.e BE).
*/
u32 pe_dmem_read(int id, u32 addr, u8 size)
{
@@ -222,7 +222,7 @@
* through indirect access registers.
* @param[in] addr Address to read from (must be aligned on size)
* @param[in] size Number of bytes to read (1, 2 or 4)
- * @return the read data
+ * Return: the read data
*/
static u32 class_bus_read(u32 addr, u8 size)
{