Merge tag 'doc-2022-04-rc1' of https://source.denx.de/u-boot/custodians/u-boot-efi

Pull request doc-2022-04-rc1

Replace @return by Return: in code comments.

12 files changed, 23 insertions, 23 deletions

diff --git a/drivers/net/fec_mxc.c b/drivers/net/fec_mxc.c
index 811bc275c1c..985b0384473 100644
--- a/drivers/net/fec_mxc.c
+++ b/drivers/net/fec_mxc.c
@@ -331,7 +331,7 @@ static int fec_tx_task_disable(struct fec_priv *fec)
  * @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 @@ static void fec_halt(struct eth_device *dev)
  * @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 @@ out:
 /**
  * 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 189fe7c631a..d139029f4e5 100644
--- a/drivers/net/octeontx2/cgx.c
+++ b/drivers/net/octeontx2/cgx.c
@@ -52,7 +52,7 @@ char lmac_speed_to_str[][8] = {
  *
  * @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 f287692712c..b1f6f067bfa 100644
--- a/drivers/net/octeontx2/cgx.h
+++ b/drivers/net/octeontx2/cgx.h
@@ -82,7 +82,7 @@ static inline u64 cgx_read(struct cgx *cgx, u8 lmac, u64 offset)
  *
  * @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 84a7eab8140..3b30992cb6e 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 5954737b5c6..a5665a25f2a 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 d513917ee75..cd098d6cd6a 100644
--- a/drivers/net/octeontx2/nix_af.c
+++ b/drivers/net/octeontx2/nix_af.c
@@ -336,7 +336,7 @@ int npa_af_shutdown(struct npa_af *npa_af)
  *
  * @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 @@ static int nix_af_setup_sq(struct nix *nix)
  * @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 c0a834b89ad..62bc7a644a5 100644
--- a/drivers/net/octeontx2/rvu.h
+++ b/drivers/net/octeontx2/rvu.h
@@ -101,7 +101,7 @@ int qmem_alloc(struct qmem *q, u32 qsize, size_t entry_sz);
  * @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 173b28ba4bb..4d8173f5ba7 100644
--- a/drivers/net/octeontx2/rvu_common.c
+++ b/drivers/net/octeontx2/rvu_common.c
@@ -41,7 +41,7 @@ void qmem_free(struct qmem *q)
  * @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 6f443b4ea81..5e14f82de5a 100644
--- a/drivers/net/pfe_eth/pfe_driver.c
+++ b/drivers/net/pfe_eth/pfe_driver.c
@@ -25,7 +25,7 @@ static struct rx_desc_s *g_rx_desc;
  * @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 @@ int pfe_eth_free_pkt(struct udevice *dev, uchar *packet, int length)
  * @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 @@ int pfe_send(int phy_port, void *data, int length)
  *  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 @@ static int pfe_hif_init(struct pfe_ddr_address *pfe_addr)
  *
  * @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 0c27a668b59..d338b363d57 100644
--- a/drivers/net/pfe_eth/pfe_eth.c
+++ b/drivers/net/pfe_eth/pfe_eth.c
@@ -101,7 +101,7 @@ static int pfe_eth_write_hwaddr(struct udevice *dev)
  *
  * @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 93e5ea55c78..6669048181e 100644
--- a/drivers/net/pfe_eth/pfe_firmware.c
+++ b/drivers/net/pfe_eth/pfe_firmware.c
@@ -37,7 +37,7 @@ static const void *pfe_esbc_hdr_addr;
  * @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 @@ err:
  * @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 @@ static int pfe_get_fw(const void **data,
 /*
  * 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 @@ int pfe_spi_flash_init(void)
  * 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 722f5c238fa..4db6f3158c3 100644
--- a/drivers/net/pfe_eth/pfe_hw.c
+++ b/drivers/net/pfe_eth/pfe_hw.c
@@ -128,7 +128,7 @@ static void pe_pmem_memcpy_to32(int id, u32 dst, const void *src,
  * @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 @@ void pe_dmem_write(int id, u32 val, u32 addr, u8 size)
  * @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 @@ static void class_bus_write(u32 val, u32 addr, u8 size)
  * 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)
 {