nrf_wifi: fix all Doxygen issues

Fix all Doxygen issues found in nrf_wifi.

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

nrf_wifi/bus_if/bal/inc/bal_api.h

@@ -18,8 +18,6 @@
 /**
  * @brief  Initialize the BAL layer.
  *
- * @param opriv Pointer to the OSAL layer context returned by the
- *			nrf_wifi_osal_init API.
  * @param cfg_params Pointer to the configuration parameters for the BAL layer.
  * @param intr_callbk_fn Pointer to the callback function which the user of this
  *	       layer needs to implement to handle interrupts from the RPU.
@@ -42,8 +40,6 @@ struct nrf_wifi_bal_priv *nrf_wifi_bal_init(struct nrf_wifi_bal_cfg_params *cfg_
  *
  * @param bpriv Pointer to the BAL layer context returned by the
  *              @ref nrf_wifi_bal_init API.
- *
- * @return None.
  */
 void nrf_wifi_bal_deinit(struct nrf_wifi_bal_priv *bpriv);
 
@@ -64,8 +60,6 @@ struct nrf_wifi_bal_dev_ctx *nrf_wifi_bal_dev_add(struct nrf_wifi_bal_priv *bpri
  *
  * @param bal_dev_ctx Pointer to the device context returned by the
  *                    @ref nrf_wifi_bal_dev_add API.
- *
- * @return None.
  */
 void nrf_wifi_bal_dev_rem(struct nrf_wifi_bal_dev_ctx *bal_dev_ctx);
 
@@ -84,8 +78,6 @@ enum nrf_wifi_status nrf_wifi_bal_dev_init(struct nrf_wifi_bal_dev_ctx *bal_dev_
  *
  * @param bal_dev_ctx Pointer to the device context returned by the
  *                    @ref nrf_wifi_bal_dev_add API.
- *
- * @return None.
  */
 void nrf_wifi_bal_dev_deinit(struct nrf_wifi_bal_dev_ctx *bal_dev_ctx);
 
@@ -105,8 +97,6 @@ unsigned int nrf_wifi_bal_read_word(void *ctx, unsigned long addr_offset);
  * @param ctx Pointer to the context.
  * @param addr_offset Address offset to write to.
  * @param val Value to write.
- *
- * @return None.
  */
 void nrf_wifi_bal_write_word(void *ctx,
 		unsigned long addr_offset,
@@ -119,8 +109,6 @@ void nrf_wifi_bal_write_word(void *ctx,
  * @param dest_addr Pointer to the destination address.
  * @param src_addr_offset Source address offset to read from.
  * @param len Length of the data to read.
- *
- * @return None.
  */
 void nrf_wifi_bal_read_block(void *ctx,
 		void *dest_addr,
@@ -134,8 +122,6 @@ void nrf_wifi_bal_read_block(void *ctx,
  * @param dest_addr_offset Destination address offset to write to.
  * @param src_addr Pointer to the source address.
  * @param len Length of the data to write.
- *
- * @return None.
  */
 void nrf_wifi_bal_write_block(void *ctx,
 		unsigned long dest_addr_offset,
@@ -164,8 +150,6 @@ unsigned long nrf_wifi_bal_dma_map(void *ctx,
  * @param phy_addr Physical address to unmap.
  * @param len Length of the data to unmap.
  * @param dma_dir DMA direction.
- *
- * @return None.
  */
 unsigned long nrf_wifi_bal_dma_unmap(void *ctx,
 		unsigned long phy_addr,
@@ -176,26 +160,20 @@ unsigned long nrf_wifi_bal_dma_unmap(void *ctx,
  * @brief Enable bus access recording.
  *
  * @param ctx Pointer to the context.
- *
- * @return None.
  */
 void nrf_wifi_bal_bus_access_rec_enab(void *ctx);
 
 /**
  * @brief Disable bus access recording.
  *
  * @param ctx Pointer to the context.
- *
- * @return None.
  */
 void nrf_wifi_bal_bus_access_rec_disab(void *ctx);
 
 /**
  * @brief Print bus access count.
  *
  * @param ctx Pointer to the context.
- *
- * @return None.
  */
 void nrf_wifi_bal_bus_access_cnt_print(void *ctx);
 
@@ -204,17 +182,13 @@ void nrf_wifi_bal_bus_access_cnt_print(void *ctx);
  * @brief Put the RPU to sleep.
  *
  * @param ctx Pointer to the context.
- *
- * @return None.
  */
 void nrf_wifi_bal_rpu_ps_sleep(void *ctx);
 
 /**
  * @brief Wake up the RPU from sleep.
  *
  * @param ctx Pointer to the context.
- *
- * @return None.
  */
 void nrf_wifi_bal_rpu_ps_wake(void *ctx);
 

nrf_wifi/fw_if/umac_if/inc/default/fmac_api.h

@@ -889,8 +889,6 @@ enum nrf_wifi_status nrf_wifi_fmac_get_conn_info(void *fmac_dev_ctx,
  *	    driver. It does the following:
  *		- De-initializes the HAL layer.
  *		- Frees the context for the UMAC IF layer.
- *
- * @return None
  */
 void nrf_wifi_fmac_deinit(struct nrf_wifi_fmac_priv *fpriv);
 
@@ -900,8 +898,6 @@ void nrf_wifi_fmac_deinit(struct nrf_wifi_fmac_priv *fpriv);
  *
  * This is a wrapper function which frees the memory for
  * an RPU instance at the UMAC layer.
- *
- * @return None.
  */
 void nrf_wifi_fmac_dev_rem(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx);
 
@@ -945,8 +941,6 @@ enum nrf_wifi_status nrf_wifi_fmac_dev_init(struct nrf_wifi_fmac_dev_ctx *fmac_d
  * This function de-initializes the firmware of an RPU instance.
  *		- RPU UMAC deinitialization command is executed
  *		- RX and TX is deallocated for firmware via UMAC command
- *
- * @return None.
  */
 void nrf_wifi_fmac_dev_deinit(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx);
 

nrf_wifi/fw_if/umac_if/inc/radio_test/fmac_api.h

@@ -94,8 +94,10 @@ enum nrf_wifi_status nrf_wifi_fmac_radio_test_prog_rx(struct nrf_wifi_fmac_dev_c
  * @param rf_test_type Type of RF test to be performed.
  * @param cap_data Pointer to the memory where the RF test capture is to be stored.
  * @param num_samples Number of RF test samples to capture.
+ * @param capture_timeout Capture timeout.
  * @param lna_gain LNA gain value.
  * @param bb_gain Baseband gain value.
+ * @param timeout_status Timeout status.
  *
  * This function is used to send a command to:
  *	- The RPU firmware to start the RF test capture in radio test mode.
@@ -213,8 +215,6 @@ enum nrf_wifi_status nrf_wifi_fmac_rf_test_compute_xo(struct nrf_wifi_fmac_dev_c
  *
  *	- De-initializes the HAL layer.
  *	- Frees the context for the UMAC IF layer.
- *
- * @return None
  */
 void nrf_wifi_fmac_deinit_rt(struct nrf_wifi_fmac_priv *fpriv);
 
@@ -224,8 +224,6 @@ void nrf_wifi_fmac_deinit_rt(struct nrf_wifi_fmac_priv *fpriv);
  * @param fmac_dev_ctx Pointer to the context of the RPU instance to be removed.
  *
  * This function handles the removal of an RPU instance at the UMAC IF layer.
- *
- * @return None.
  */
 void nrf_wifi_fmac_dev_rem_rt(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx);
 
@@ -263,8 +261,6 @@ enum nrf_wifi_status nrf_wifi_fmac_dev_init_rt(struct nrf_wifi_fmac_dev_ctx *fma
  * @param fmac_dev_ctx Pointer to the context of the RPU instance to be removed.
  *
  * This function de-initializes the firmware of an RPU instance.
- *
- * @return None.
  */
 void nrf_wifi_fmac_dev_deinit_rt(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx);
 

nrf_wifi/hw_if/hal/inc/hal_api.h

@@ -62,8 +62,6 @@ nrf_wifi_hal_init(struct nrf_wifi_hal_cfg_params *cfg_params,
  *
  * This API is used to deinitialize the HAL layer and is expected to be called
  * after done using the HAL layer.
- *
- * @return None.
  */
 void nrf_wifi_hal_deinit(struct nrf_wifi_hal_priv *hpriv);
 
@@ -94,7 +92,7 @@ enum NRF_WIFI_HAL_STATUS nrf_wifi_hal_status_unlocked(struct nrf_wifi_hal_dev_ct
  *
  * @param hal_ctx Pointer to HAL context.
  * @param cmd Pointer to command data.
- * @param cmd_size Size of the command data pointed to by @cmd.
+ * @param cmd_size Size of the command data pointed to by @p cmd.
  *
  * This function takes care of sending a command to the RPU. It does the
  * following:
@@ -142,7 +140,7 @@ enum nrf_wifi_status nrf_wifi_hal_data_cmd_send(struct nrf_wifi_hal_dev_ctx *hal
 /**
  * @brief Process events from the RPU.
  *
- * @param hpriv Pointer to HAL context.
+ * @param hal_ctx Pointer to HAL context.
  *
  * This function processes the events which have been queued into the event
  * queue by an ISR. It does the following: