qcacmn: Fix utils/host_diag_log documentation

The kernel-doc script has identified multiple documentation issues in
the utils/host_diag_log folder, so fix them.

Change-Id: Iaaa241e7f2a18dd7952d491b31487c0b048cca52
CRs-Fixed: 3461770

utils/host_diag_log/inc/host_diag_core_event.h

@@ -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
@@ -105,6 +105,7 @@ enum mgmt_frm_subtype {
  * @AUTH_WPA2_PSK: WPA2 PSK based auth
  * @AUTH_WAPI_CERT: WAPI CERT based auth
  * @AUTH_WAPI_PSK: WAPI PSK based auth
+ * @AUTH_MAX: max enumeration
  */
 enum mgmt_auth_type {
 	AUTH_OPEN = 0x00,
@@ -129,6 +130,7 @@ enum mgmt_auth_type {
  * @ENC_MODE_AES_GCMP: AES with GCMP encryption
  * @ENC_MODE_AES_GCMP_256: AES with 256 bit GCMP encryption
  * @ENC_MODE_SMS4: WAPI based SMS4 encryption
+ * @ENC_MODE_MAX: max enumeration
  */
 enum mgmt_encrypt_type {
 	ENC_MODE_OPEN = 0x00,
@@ -153,6 +155,7 @@ enum mgmt_encrypt_type {
  * @BW_5MHZ: 5 MHz of channel bonding
  * @BW_10MHZ: 10 MHz of channel bonding
  * @BW_320MHZ: 320 MHz of channel bonding
+ * @BW_MAX: max enumeration
  */
 enum mgmt_ch_width {
 	BW_20MHZ = 0x00,
@@ -183,6 +186,7 @@ enum mgmt_ch_width {
  * @DOT11_MODE_11AX_ONLY: 802.11-AX only mode
  * @DOT11_MODE_11BE: 802.11-BE mode
  * @DOT11_MODE_11BE_ONLY: 802.11-BE only mode
+ * @DOT11_MODE_MAX: max enumeration
  */
 enum mgmt_dot11_mode {
 	DOT11_MODE_ABG = 0x00,
@@ -220,6 +224,7 @@ enum mgmt_dot11_mode {
  * @WDS_PERSONA: WDS mode
  * @BTAMP_PERSONA: BT amp mode
  * @AHDEMO_PERSONA: AH demo mode
+ * @MAX_PERSONA: max enumeration
  */
 enum mgmt_bss_type {
 	STA_PERSONA = 0x00,
@@ -253,6 +258,7 @@ enum mgmt_bss_type {
  * @WLAN_STATUS_DRIVER_LOADED: Driver Loaded
  * @WLAN_STATUS_BUS_EXCEPTION: bus/link exception
  * @WLAN_STATUS_DEVICE_TEMPERATURE_HIGH: chip temperature high
+ * @WLAN_STATUS_MAX: max enumeration
  */
 enum wlan_bringup_status {
 	WLAN_STATUS_DISABLED = 0,
@@ -330,8 +336,7 @@ typedef struct {
 } host_event_wlan_qos_payload_type;
 
 /**
- * host_event_wlan_connection_stats: to capture connection details
- *
+ * struct host_event_wlan_connection_stats - to capture connection details
  * @rssi: RSSI signal strength of connected AP, units in dbM
  * @ssid_len: length of SSID
  * @ssid: SSID of AP where STA is connected
@@ -386,8 +391,8 @@ typedef struct {
 } host_event_wlan_pe_payload_type;
 
 /**
- * host_event_wlan_mgmt_payload_type: To capture TX/RX mgmt frames' payload
- *
+ * struct host_event_wlan_mgmt_payload_type - To capture TX/RX mgmt frame
+ *                                            payload
  * @mgmt_type: type of frames, value: enum wifi_frm_type
  * @mgmt_subtype: subtype of mgmt frame, value: enum mgmt_frm_subtype
  * @operating_channel: operating channel of AP
@@ -491,7 +496,8 @@ typedef struct {
   Event ID: EVENT_WLAN_POWERSAVE_WOW_STATS
   ------------------------------------------------------------------------*/
 /**
- * host_event_wlan_powersave_wow_stats - Structure holding wow stats information
+ * struct host_event_wlan_powersave_wow_stats - Structure holding wow stats
+ *                                              information
  * @wow_ucast_wake_up_count: wow unicast packet wakeup count
  * @wow_bcast_wake_up_count: wow broadcast packet wakeup count
  * @wow_ipv4_mcast_wake_up_count: wow ipv4 multicast packet wakeup count
@@ -512,6 +518,10 @@ typedef struct {
  * @wow_icmpv4_count: wow icmpv4 packet count
  * @wow_icmpv6_count: wow icmpv6 packet count
  * @wow_oem_response_wake_up_count: wow  oem response packet wakeup count
+ * @Reserved_1: reserved for future use
+ * @Reserved_2: reserved for future use
+ * @Reserved_3: reserved for future use
+ * @Reserved_4: reserved for future use
  *
  * This structure contains the wow stats information related to diag event
  */
@@ -559,7 +569,7 @@ typedef struct {
  * struct host_event_wlan_eapol - Structure holding the eapol information
  * @event_sub_type:	0-Transmitted, 1-Received
  * @eapol_packet_type:	0 - EAP Start, 1 - EAPOL Start, 2 - EAPOL Logoff
-			3 - EAPOL Key, 4 - EAPOL Encapsulated Alert
+ *			3 - EAPOL Key, 4 - EAPOL Encapsulated Alert
  * @eapol_key_info:	This field from the driver is in big endian format.
  *			So, the masks .0x8013. can be used to extract the
  *			message type. After masking, the values corresponding
@@ -695,7 +705,7 @@ struct host_event_wlan_log_complete {
 /**
  * struct host_event_wlan_kickout - Holds diag event details
  * @reasoncode: Indicates the reasoncode of event
- * @peer_macaddr: Indicates the peer macaddr
+ * @peer_mac: Indicates the peer macaddr
  * @vdev_id: Indicate unique id for identifying the VDEV
  *
  * This structure holds the diag event related information
@@ -711,10 +721,10 @@ struct host_event_wlan_kickout {
   Event ID: EVENT_WLAN_SOFTAP_DATASTALL/EVENT_WLAN_STA_DATASTALL
   ------------------------------------------------------------------------*/
 /**
- * struct host_event_wlan_softap_datastall - Holds diag event details
+ * struct host_event_wlan_datastall - Holds diag event details
  * @reason: Indicates the reason of event
  *
- *This structure holds the host diag event related information
+ * This structure holds the host diag event related information
  */
 
 struct host_event_wlan_datastall {
@@ -728,7 +738,7 @@ struct host_event_wlan_datastall {
  * struct host_event_wlan_ssr_reinit - Holds diag event details
  * @status: Indicates the status of event
  *
- *This structure holds the host diag event related information
+ * This structure holds the host diag event related information
  */
 
 struct host_event_wlan_ssr_reinit {
@@ -742,7 +752,7 @@ struct host_event_wlan_ssr_reinit {
  * struct host_event_wlan_ssr_shutdown - Holds diag event details
  * @status: Indicates the status of event
  *
- *This structure holds the host diag event related information
+ * This structure holds the host diag event related information
  */
 
 struct host_event_wlan_ssr_shutdown {

utils/host_diag_log/inc/host_diag_core_log.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2014-2017, 2019-2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-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
@@ -252,6 +252,8 @@ typedef struct {
 /**
  * struct host_log_pktlog_info - Packet log info
  * @log_hdr: Log header
+ * @version: Version
+ * @seq_no:  Sequence number
  * @buf_len: Length of the buffer that follows
  * @buf:     Buffer containing the packet log info
  *
@@ -291,7 +293,7 @@ struct host_log_cold_boot_cal_data_type {
 #define WLAN_MAX_SSID_SIZE              32
 
 /**
- * host_log_wlan_mgmt_tx_rx_info: To capture TX/RX mgmt frames' payload
+ * struct host_log_wlan_mgmt_tx_rx_info - To capture TX/RX mgmt frames' payload
  * @hdr: Log header
  * @version: Version number of the payload
  * @vdev_id: Vdev id
@@ -360,7 +362,7 @@ struct wlan_roam_cu_trigger_data {
 } qdf_packed;
 
 /**
- * Struct wlan_roam_rssi_trigger_data - RSSI roam trigger related
+ * struct wlan_roam_rssi_trigger_data - RSSI roam trigger related
  * parameters
  * @threshold: RSSI threshold value in dBm for LOW rssi roam trigger
  */

utils/host_diag_log/src/i_host_diag_core_event.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2014-2019, 2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-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
@@ -99,7 +99,7 @@ enum auth_timeout_type {
  * not poor.
  * @DIAG_ROAM_REASON_CONGESTION: Roam triggered considering the connected
  * channel or environment being very noisy / congested.
- * @DIAG_ROAM_REASON_EXPLICIT_REQUEST: Roam triggered due to an explicit request
+ * @DIAG_ROAM_REASON_USER_TRIGGER: Roam triggered due to an explicit request
  * from the user (user space).
  * @DIAG_ROAM_REASON_BTM: Roam triggered due to BTM request frame received from
  * connected AP.
@@ -140,6 +140,7 @@ enum diag_roam_reason {
 
 /**
  * enum diag_roam_sub_reason - Used by attribute
+ * @DIAG_ROAM_SUB_REASON_UNKNOWN: Roam sub-reason unknown/unspecified
  * @DIAG_ROAM_SUB_REASON_PERIODIC_TIMER: Roam scan triggered due to periodic
  * timer expiry
  * @DIAG_ROAM_SUB_REASON_INACTIVITY_TIMER_LOW_RSSI: Roam scan trigger due
@@ -205,8 +206,8 @@ static inline void host_log_low_resource_failure(uint8_t event_sub_type)
  * requested rsn info in assoc request
  * @ucast_cipher: Unicast ciphers used in assoc request
  * @mcast_cipher: Group ciphers used in assoc request
- * @akm_suite: Gives information about akm suites used in assoc request
- * @group_mgmt: Requested group mgmt cipher suite
+ * @auth_suite: Gives information about akm suites used in assoc request
+ * @gp_mgmt_cipher: Requested group mgmt cipher suite
  *
  * This function is used to send RSN info used in assoc req to user space
  *