qcacld-3.0: Fix core/bmi documentation

The kernel-doc script identified some documentation errors in the
core/bmi folder, so fix them.

Change-Id: I1ec447b56eb38358c4d875d9e0f1ecbe935be57e
CRs-Fixed: 3385916

core/bmi/inc/bmi.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2013-2019 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -31,7 +32,7 @@
 struct ol_context;
 
 /**
- * struct hif_config_info - Place Holder for hif confiruation
+ * struct ol_config_info - Place Holder for offload configuration
  * @enable_uart_print: UART Print
  * @enable_self_recovery: Self Recovery
  * @enable_fw_log:      To Enable FW LOG

core/bmi/src/i_bmi.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2014-2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -127,13 +127,13 @@ enum ATH_BIN_FILE {
 
 /**
  * struct bmi_info - Structure to hold BMI Specific information
- * @bmi_cmd_buff - BMI Command Buffer
+ * @bmi_cmd_buff: BMI Command Buffer
- * @bmi_rsp_buff - BMI Response Buffer
+ * @bmi_rsp_buff: BMI Response Buffer
- * @bmi_cmd_da - BMI Command Physical address
+ * @bmi_cmd_da: BMI Command Physical address
- * @bmi_rsp_da - BMI Response Physical address
+ * @bmi_rsp_da: BMI Response Physical address
- * @bmi_done - Flag to check if BMI Phase is complete
+ * @bmi_done: Flag to check if BMI Phase is complete
- * @board_id - board ID
+ * @board_id: board ID
- * @fw_files - FW files
+ * @fw_files: FW files
  *
  */
 struct bmi_info {
@@ -149,11 +149,13 @@ struct bmi_info {
 /**
  * struct ol_context - Structure to hold OL context
  * @bmi: BMI info
+ * @cfg_info: OL config info
  * @cal_in_flash: For Firmware Flash Download
  * @qdf_dev: QDF Device
- * @scn: HIF Context
  * @ramdump_work: Work for Ramdump collection
- * @fw_indication_work: Work for Fw inciation
+ * @fw_indication_work: Work for Fw indication
+ * @fw_dl_wakelock: Firmware download wakelock
+ * @scn: HIF Context
  * @tgt_def: Target Defnition pointer
  * @fw_crashed_cb: Callback for firmware crashed ind
  *

core/bmi/src/ol_fw.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2014-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -543,7 +543,7 @@ struct ramdump_info {
 	unsigned long size;
 };
 
-/**
+/*
  * if have platform driver support, reinit will be called by CNSS.
  * recovery flag will be cleaned and CRASHED indication will be sent
  * to user space by reinit function. If not support, clean recovery
@@ -1762,7 +1762,7 @@ ol_get_max_section_count(struct hif_opaque_softc *scn)
 
 /**
  * ol_set_ram_config_reg() - set target RAM configuration register
- * @sc: pointer of hif_softc context
+ * @scn: pointer of hif_softc context
  * @config: value to be written to the register
  *
  * This function will write the given value to target RAM configuration
@@ -1850,9 +1850,9 @@ ol_get_iram_len_and_pos(struct hif_opaque_softc *scn, uint32_t *pos,
 
 /**
  * ol_target_coredump() - API to collect target ramdump
- * @inst - private context
+ * @inst: private context
- * @memory_block - non-NULL reserved memory location
+ * @memory_block: non-NULL reserved memory location
- * @block_len - size of the dump to collect
+ * @block_len: size of the dump to collect
  *
  * Function to perform core dump for the target.
  *