samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qcacld-3.0: Fix NAN Documentation

Browse Source 
The kernel-doc script identified a multitude of documentation issues
in components/nan, so fix them.

Change-Id: Ibec4c381da3088f704264d04f756d82d20613c46
CRs-Fixed: 3359549
This commit is contained in:
Jeff Johnson
2022-12-13 09:01:07 -08:00
committed by Madan Koyyalamudi
parent cb647fd309
commit 116c817bb8
4 changed files with 32 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
components/nan/core/inc/nan_public_structs.h
View File

@@ -118,21 +118,23 @@ enum nan_datapath_status_type {
/**
* enum nan_datapath_reason_code - NDP command rsp reason code value
* @NDP_UNSUPPORTED_CONCURRENCY: Will be used in unsupported concurrency cases
* @NDP_NAN_DATA_IFACE_CREATE_FAILED: ndi create failed
* @NDP_NAN_DATA_IFACE_DELETE_FAILED: ndi delete failed
* @NDP_DATA_INITIATOR_REQ_FAILED: data initiator request failed
* @NDP_DATA_RESPONDER_REQ_FAILED: data responder request failed
* @NDP_INVALID_SERVICE_INSTANCE_ID: invalid service instance id
* @NDP_INVALID_NDP_INSTANCE_ID: invalid ndp instance id
* @NDP_INVALID_RSP_CODE: invalid response code in ndp responder request
* @NDP_INVALID_APP_INFO_LEN: invalid app info length
* @NDP_NMF_REQ_FAIL: OTA nan mgmt frame failure for data request
* @NDP_NMF_RSP_FAIL: OTA nan mgmt frame failure for data response
* @NDP_NMF_CNF_FAIL: OTA nan mgmt frame failure for confirm
* @NDP_END_FAILED: ndp end failed
* @NDP_NMF_END_REQ_FAIL: OTA nan mgmt frame failure for data end
* @NDP_VENDOR_SPECIFIC_ERROR: other vendor specific failures
* @NAN_DATAPATH_UNSUPPORTED_CONCURRENCY: Will be used in unsupported
* concurrency cases
* @NAN_DATAPATH_NAN_DATA_IFACE_CREATE_FAILED: ndi create failed
* @NAN_DATAPATH_NAN_DATA_IFACE_DELETE_FAILED: ndi delete failed
* @NAN_DATAPATH_DATA_INITIATOR_REQ_FAILED: data initiator request failed
* @NAN_DATAPATH_DATA_RESPONDER_REQ_FAILED: data responder request failed
* @NAN_DATAPATH_INVALID_SERVICE_INSTANCE_ID: invalid service instance id
* @NAN_DATAPATH_INVALID_NDP_INSTANCE_ID: invalid ndp instance id
* @NAN_DATAPATH_INVALID_RSP_CODE: invalid response code in ndp responder
* request
* @NAN_DATAPATH_INVALID_APP_INFO_LEN: invalid app info length
* @NAN_DATAPATH_NMF_REQ_FAIL: OTA nan mgmt frame failure for data request
* @NAN_DATAPATH_NMF_RSP_FAIL: OTA nan mgmt frame failure for data response
* @NAN_DATAPATH_NMF_CNF_FAIL: OTA nan mgmt frame failure for confirm
* @NAN_DATAPATH_END_FAILED: ndp end failed
* @NAN_DATAPATH_NMF_END_REQ_FAIL: OTA nan mgmt frame failure for data end
* @NAN_DATAPATH_VENDOR_SPECIFIC_ERROR: other vendor specific failures
*/
enum nan_datapath_reason_code {
NAN_DATAPATH_UNSUPPORTED_CONCURRENCY = 9000,
@@ -214,6 +216,7 @@ enum nan_datapath_end_reason_code {
/**
* enum nan_datapath_state - NAN datapath states
* @NAN_DATA_INVALID_STATE: Invalid state
* @NAN_DATA_NDI_CREATING_STATE: NDI create is in progress
* @NAN_DATA_NDI_CREATED_STATE: NDI successfully created
* @NAN_DATA_NDI_DELETING_STATE: NDI delete is in progress
@@ -352,7 +355,6 @@ struct nan_datapath_inf_create_req {
struct nan_datapath_inf_create_rsp {
uint32_t status;
uint32_t reason;
uint8_t sta_id;
};
/**
@@ -651,7 +653,7 @@ struct nan_datapath_end_indication_event {
};
/**
* struct nan_datapath_peer_ind - ndp peer indication
* struct nan_dump_msg - ndp logging message
* @msg: msg received by FW
* @data_len: data length
*
@@ -706,7 +708,7 @@ struct nan_datapath_confirm_event {
* @ndp_initiator_mac_addr: NDI mac address of the peer initiating NDP
* @ndp_instance_id: locally created NDP instance ID
* @role: self role for NDP
* @ndp_accept_policy: accept policy configured by the upper layer
* @policy: accept policy configured by the upper layer
* @ndp_config: ndp configuration params
* @ndp_info: ndp application info
* @ncs_sk_type: indicates NCS_SK_128 or NCS_SK_256

1
components/nan/dispatcher/inc/cfg_nan.h
View File

@@ -21,7 +21,6 @@
#define __NAN_CFG_H__
/**
*
* DOC: nan_cfg.h
*
* NAN feature INI configuration parameter definitions

2
components/nan/dispatcher/inc/cfg_nan_api.h
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2018-2020 The Linux Foundation. All rights reserved.
* Copyright (c) 2022 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
@@ -20,7 +21,6 @@
#define __NAN_CFG_API_H__
/**
*
* DOC: nan_cfg_api.h
*
* NAN feature INI configuration parameters get/set APIs

17
components/nan/dispatcher/inc/nan_ucfg_api.h
View File

@@ -36,11 +36,18 @@
ucfg_is_nan_conc_control_supported(psoc))
#ifdef WLAN_FEATURE_NAN
/**
* ucfg_nan_set_ndi_state: set ndi state
* @vdev: pointer to vdev object
* @state: value to set
*
* Return: status of operation
*/
#define ucfg_nan_set_ndi_state(vdev, state) \
__ucfg_nan_set_ndi_state(vdev, state, __func__)
/**
* ucfg_nan_set_ndi_state: set ndi state
* __ucfg_nan_set_ndi_state: set ndi state
* @vdev: pointer to vdev object
* @state: value to set
* @func: Caller of this API
@@ -217,7 +224,6 @@ QDF_STATUS ucfg_nan_get_callbacks(struct wlan_objmgr_psoc *psoc,
* process nan datapath initiator request from userspace
* @vdev: nan vdev pointer
* @in_req: NDP request
* @psoc: pointer to psoc object
* @req_type: type of request
*
* Return: status of operation
@@ -243,14 +249,13 @@ void ucfg_nan_datapath_event_handler(struct wlan_objmgr_psoc *psoc,
* ucfg_nan_register_hdd_callbacks: ucfg API to set hdd callbacks
* @psoc: pointer to psoc object
* @cb_obj: structs containing callbacks
* @os_if_event_handler: os if event handler callback
*
* Return: status of operation
*/
int ucfg_nan_register_hdd_callbacks(struct wlan_objmgr_psoc *psoc,
struct nan_callbacks *cb_obj);
/*
/**
* ucfg_nan_register_lim_callbacks: ucfg API to set lim callbacks
* @psoc: pointer to psoc object
* @cb_obj: structs containing callbacks
@@ -310,7 +315,7 @@ bool ucfg_is_nan_dbs_supported(struct wlan_objmgr_psoc *psoc);
bool ucfg_is_ndi_dbs_supported(struct wlan_objmgr_psoc *psoc);
/**
* ucfg_is_nan_dbs_supported() - ucfg API to query NAN SAP support
* ucfg_is_nan_sap_supported() - ucfg API to query NAN SAP support
* @psoc: pointer to psoc object
*
* This function returns NAN SAP support status
@@ -529,7 +534,7 @@ bool ucfg_is_nan_allowed_on_freq(struct wlan_objmgr_pdev *pdev, uint32_t freq);
bool ucfg_get_disable_6g_nan(struct wlan_objmgr_psoc *psoc);
/**
* ucfg_nan_is_mlo_sta_nan_ndi_allowed()- Get support for MLO STA +
* ucfg_is_mlo_sta_nan_ndi_allowed()- Get support for MLO STA +
* NAN Disc + NDI concurrency
* @psoc: pointer to psoc object
*