From ac73d2ec1d98ea5ef9544ea10cdd73d9aefef670 Mon Sep 17 00:00:00 2001 From: Jeff Johnson Date: Wed, 14 Dec 2022 10:00:46 -0800 Subject: [PATCH] qcacld-3.0: Fix TDLS Documentation The kernel-doc script identified a multitude of documentation issues in components/tdls, so fix them. Change-Id: I365496d70e903bae1abad7b807687904f7f15af7 CRs-Fixed: 3360666 --- .../tdls/core/src/wlan_tdls_cmds_process.c | 3 +- .../tdls/core/src/wlan_tdls_cmds_process.h | 8 +-- components/tdls/core/src/wlan_tdls_ct.c | 18 +++--- components/tdls/core/src/wlan_tdls_ct.h | 15 ++--- components/tdls/core/src/wlan_tdls_main.c | 20 +++---- components/tdls/core/src/wlan_tdls_main.h | 36 ++++++----- components/tdls/core/src/wlan_tdls_peer.c | 2 + components/tdls/core/src/wlan_tdls_peer.h | 12 ++-- .../tdls/dispatcher/inc/wlan_tdls_api.h | 2 +- .../dispatcher/inc/wlan_tdls_public_structs.h | 60 ++++++++++++------- .../tdls/dispatcher/inc/wlan_tdls_ucfg_api.h | 6 +- .../tdls/dispatcher/src/wlan_tdls_ucfg_api.c | 6 +- 12 files changed, 109 insertions(+), 79 deletions(-) diff --git a/components/tdls/core/src/wlan_tdls_cmds_process.c b/components/tdls/core/src/wlan_tdls_cmds_process.c index a7dc9a0ff2..51947018a6 100644 --- a/components/tdls/core/src/wlan_tdls_cmds_process.c +++ b/components/tdls/core/src/wlan_tdls_cmds_process.c @@ -194,6 +194,7 @@ void tdls_update_6g_power(struct wlan_objmgr_vdev *vdev, /** * tdls_decrement_peer_count() - decrement connected TDLS peer counter + * @vdev: vdev object * @soc_obj: TDLS soc object * * Used in scheduler thread context, no lock needed. @@ -1413,7 +1414,7 @@ free_req: } /** - * tdls_process_add_peer_rsp() - handle response for update TDLS peer + * tdls_update_peer_rsp() - handle response for update TDLS peer * @rsp: TDLS add peer response * * Return: QDF_STATUS_SUCCESS for success; other values if failed diff --git a/components/tdls/core/src/wlan_tdls_cmds_process.h b/components/tdls/core/src/wlan_tdls_cmds_process.h index 2a9cd33e95..95e2cc9d83 100644 --- a/components/tdls/core/src/wlan_tdls_cmds_process.h +++ b/components/tdls/core/src/wlan_tdls_cmds_process.h @@ -141,7 +141,7 @@ tdls_release_serialization_command(struct wlan_objmgr_vdev *vdev, /** * tdls_get_connected_peer_count_from_vdev() - Get TDLS connected peer count - * @tdls_vdev: Pointer to vdev obj + * @vdev: Pointer to vdev obj * * Return: Connected peer count */ @@ -176,7 +176,7 @@ QDF_STATUS tdls_send_mgmt_tx_completion( struct tdls_mgmt_tx_completion_ind *tx_complete); /** - * tdls_process_add_peer_rsp() - handle response for delete TDLS peer + * tdls_process_del_peer_rsp() - handle response for delete TDLS peer * @rsp: TDLS delete peer response * * Return: QDF status @@ -214,8 +214,8 @@ QDF_STATUS tdls_process_connection_tracker_notify(struct wlan_objmgr_vdev *vdev, struct tdls_event_info *evt); /** - * tdls_validate_mgmt_request() -validate mgmt request - * @tdls_validate: action frame request + * tdls_validate_mgmt_request() - validate mgmt request + * @tdls_mgmt_req: action frame request * * Return: 0 for success or -EINVAL otherwise */ diff --git a/components/tdls/core/src/wlan_tdls_ct.c b/components/tdls/core/src/wlan_tdls_ct.c index 26e9fa829c..2eb414e9bb 100644 --- a/components/tdls/core/src/wlan_tdls_ct.c +++ b/components/tdls/core/src/wlan_tdls_ct.c @@ -183,8 +183,8 @@ void tdls_implicit_enable(struct tdls_vdev_priv_obj *tdls_vdev) /** * tdls_ct_sampling_tx_rx() - collect tx/rx traffic sample - * @tdls_vdev_obj: tdls vdev object - * @tdls_soc_obj: tdls soc object + * @tdls_vdev: tdls vdev object + * @tdls_soc: tdls soc object * * Function to update data traffic information in tdls connection * tracker data structure for connection tracker operation @@ -743,8 +743,8 @@ tdls_ct_process_idle_and_discovery(struct tdls_peer *curr_peer, /** * tdls_ct_process_connected_link() - process the traffic * @curr_peer: tdls peer needs to be examined - * @tdls_vdev_obj: tdls vdev - * @tdls_soc_obj: tdls soc context + * @tdls_vdev: tdls vdev + * @tdls_soc: tdls soc context * * Function to check the peer traffic data in active STA * session @@ -795,7 +795,7 @@ static void tdls_ct_process_connected_link( /** * tdls_ct_process_cap_supported() - process TDLS supported peer. * @curr_peer: tdls peer needs to be examined - * @tdls_vdev_obj: tdls vdev context + * @tdls_vdev: tdls vdev context * @tdls_soc_obj: tdls soc context * * Function to check the peer traffic data for tdls supported peer @@ -835,8 +835,8 @@ static void tdls_ct_process_cap_supported(struct tdls_peer *curr_peer, /** * tdls_ct_process_cap_unknown() - process unknown peer * @curr_peer: tdls peer needs to be examined - * @tdls_vdev_obj: tdls vdev object - * @tdls_soc_obj: tdls soc object + * @tdls_vdev: tdls vdev object + * @tdls_soc: tdls soc object * * Function check the peer traffic data , when tdls capability is unknown * @@ -844,10 +844,10 @@ static void tdls_ct_process_cap_supported(struct tdls_peer *curr_peer, */ static void tdls_ct_process_cap_unknown(struct tdls_peer *curr_peer, struct tdls_vdev_priv_obj *tdls_vdev, - struct tdls_soc_priv_obj *tdlsa_soc) + struct tdls_soc_priv_obj *tdls_soc) { if (TDLS_IS_EXTERNAL_CONTROL_ENABLED( - tdlsa_soc->tdls_configs.tdls_feature_flags) && + tdls_soc->tdls_configs.tdls_feature_flags) && (!curr_peer->is_forced_peer)) return; diff --git a/components/tdls/core/src/wlan_tdls_ct.h b/components/tdls/core/src/wlan_tdls_ct.h index f99c9d7c5c..5adfaf89a2 100644 --- a/components/tdls/core/src/wlan_tdls_ct.h +++ b/components/tdls/core/src/wlan_tdls_ct.h @@ -1,5 +1,6 @@ /* * Copyright (c) 2017-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 @@ -82,7 +83,7 @@ void tdls_update_tx_pkt_cnt(struct wlan_objmgr_vdev *vdev, struct qdf_mac_addr *mac_addr); /** - * wlan_hdd_tdls_implicit_send_discovery_request() - send discovery request + * tdls_implicit_send_discovery_request() - send discovery request * @tdls_vdev_obj: tdls vdev object * * Return: None @@ -92,7 +93,7 @@ void tdls_implicit_send_discovery_request( /** * tdls_recv_discovery_resp() - handling of tdls discovery response - * @soc: object manager + * @tdls_vdev: tdls vdev object * @mac: mac address of peer from which the response was received * * Return: 0 for success or negative errno otherwise @@ -137,7 +138,7 @@ void tdls_ct_idle_handler(void *user_data); /** * tdls_discovery_timeout_peer_cb() - tdls discovery timeout callback - * @userData: tdls vdev + * @user_data: tdls vdev * * Return: None */ @@ -145,7 +146,7 @@ void tdls_discovery_timeout_peer_cb(void *user_data); /** * tdls_implicit_disable() - disable implicit tdls triggering - * @pHddTdlsCtx: TDLS context + * @tdls_vdev: TDLS vdev context * * Return: Void */ @@ -153,7 +154,7 @@ void tdls_implicit_disable(struct tdls_vdev_priv_obj *tdls_vdev); /** * tdls_is_vdev_authenticated() - check the vdev authentication state - * @vdev: vdev oobject + * @vdev: vdev object * * Return: true or false */ @@ -170,7 +171,7 @@ void tdls_teardown_connections(struct tdls_link_teardown *tdls_teardown); /** * tdls_disable_offchan_and_teardown_links - Disable offchannel * and teardown TDLS links - * @tdls_soc : tdls soc object + * @vdev: vdev object * * Return: None */ @@ -203,7 +204,7 @@ int tdls_set_tdls_offchannel(struct tdls_soc_priv_obj *tdls_soc, /** * tdls_set_tdls_offchannelmode() - set tdls off-channel mode - * @adapter: Pointer to the HDD adapter + * @vdev: vdev object * @offchanmode: tdls off-channel mode * * This function sets tdls off-channel mode diff --git a/components/tdls/core/src/wlan_tdls_main.c b/components/tdls/core/src/wlan_tdls_main.c index 2dd6e43e4c..cd30114684 100644 --- a/components/tdls/core/src/wlan_tdls_main.c +++ b/components/tdls/core/src/wlan_tdls_main.c @@ -480,7 +480,7 @@ static void tdls_get_all_peers_from_list( /** * tdls_process_reset_all_peers() - Reset all tdls peers - * @delete_all_peers_ind: Delete all peers indication + * @vdev: vdev object * * This function is called to reset all tdls peers and * notify upper layers of teardown inidcation @@ -715,8 +715,8 @@ void tdls_timer_restart(struct wlan_objmgr_vdev *vdev, } /** - * wlan_hdd_tdls_monitor_timers_stop() - stop all monitoring timers - * @hdd_tdls_ctx: TDLS context + * tdls_monitor_timers_stop() - stop all monitoring timers + * @tdls_vdev: TDLS vdev object * * Return: none */ @@ -758,7 +758,7 @@ static void tdls_peer_idle_timers_stop(struct tdls_vdev_priv_obj *tdls_vdev) } /** - * wlan_hdd_tdls_ct_timers_stop() - stop tdls connection tracker timers + * tdls_ct_timers_stop() - stop tdls connection tracker timers * @tdls_vdev: TDLS vdev * * Return: None @@ -770,7 +770,7 @@ static void tdls_ct_timers_stop(struct tdls_vdev_priv_obj *tdls_vdev) } /** - * wlan_hdd_tdls_timers_stop() - stop all the tdls timers running + * tdls_timers_stop() - stop all the tdls timers running * @tdls_vdev: TDLS vdev * * Return: none @@ -985,8 +985,8 @@ bool tdls_check_is_tdls_allowed(struct wlan_objmgr_vdev *vdev) } /** - * cds_set_tdls_ct_mode() - Set the tdls connection tracker mode - * @hdd_ctx: hdd context + * tdls_set_ct_mode() - Set the tdls connection tracker mode + * @psoc: psoc context * * This routine is called to set the tdls connection tracker operation status * @@ -1167,7 +1167,7 @@ static QDF_STATUS tdls_post_msg_flush_cb(struct scheduler_msg *msg) /** * tdls_process_session_update() - update session count information * @psoc: soc object - * @notification: TDLS os if notification + * @cmd_type: type of command * * update the session information in connection tracker * @@ -1780,8 +1780,8 @@ release_mode_ref: } /** - * wlan_hdd_tdls_scan_done_callback() - callback for tdls scan done event - * @pAdapter: HDD adapter + * tdls_scan_done_callback() - callback for tdls scan done event + * @tdls_soc: tdls soc object * * Return: Void */ diff --git a/components/tdls/core/src/wlan_tdls_main.h b/components/tdls/core/src/wlan_tdls_main.h index 192d6b78be..9fe28d2bbd 100644 --- a/components/tdls/core/src/wlan_tdls_main.h +++ b/components/tdls/core/src/wlan_tdls_main.h @@ -109,9 +109,9 @@ struct tdls_conn_info { /** * enum tdls_nss_transition_state - TDLS NSS transition states - * @TDLS_NSS_TRANSITION_UNKNOWN: default state - * @TDLS_NSS_TRANSITION_2x2_to_1x1: transition from 2x2 to 1x1 stream - * @TDLS_NSS_TRANSITION_1x1_to_2x2: transition from 1x1 to 2x2 stream + * @TDLS_NSS_TRANSITION_S_UNKNOWN: default state + * @TDLS_NSS_TRANSITION_S_2x2_to_1x1: transition from 2x2 to 1x1 stream + * @TDLS_NSS_TRANSITION_S_1x1_to_2x2: transition from 1x1 to 2x2 stream */ enum tdls_nss_transition_state { TDLS_NSS_TRANSITION_S_UNKNOWN = 0, @@ -134,7 +134,7 @@ struct tdls_conn_tracker_mac_table { }; /** - * struct tdls_set_state_db - to record set tdls state command, we need to + * struct tdls_set_state_info - to record set tdls state command, we need to * set correct tdls state to firmware: * 1. enable tdls in firmware before tdls connection; * 2. disable tdls if concurrency happen, before disable tdls, all active peer @@ -149,7 +149,7 @@ struct tdls_set_state_info { }; /** - * struct tdls_psoc_priv_ctx - tdls context + * struct tdls_soc_priv_obj - tdls soc private context * @soc: objmgr psoc * @tdls_current_mode: current tdls mode * @tdls_last_mode: last tdls mode @@ -171,10 +171,15 @@ struct tdls_set_state_info { * @tdls_nss_transition_mode: tdls nss transition mode * @tdls_teardown_peers_cnt: tdls tear down peer count * @set_state_info: set tdls state info + * @tdls_rx_cb: TDLS RX callback + * @tdls_rx_cb_data: TDLS RX callback context + * @tdls_wmm_cb: TDLS WMM check callback + * @tdls_wmm_cb_data: TDLS WMM check callback context * @tdls_event_cb: tdls event callback * @tdls_evt_cb_data: tdls event user data * @tdls_peer_context: userdata for register/deregister TDLS peer * @tdls_reg_peer: register tdls peer with datapath + * @tdls_dp_vdev_update: notify datapath of vdev updates * @tx_q_ack: queue for tx frames waiting for ack * @tdls_con_cap: tdls concurrency support * @tdls_send_mgmt_req: store eWNI_SME_TDLS_SEND_MGMT_REQ value @@ -182,7 +187,7 @@ struct tdls_set_state_info { * @tdls_del_sta_req: store eWNI_SME_TDLS_DEL_STA_REQ value * @tdls_update_peer_state: store WMA_UPDATE_TDLS_PEER_STATE value * @tdls_del_all_peers:store eWNI_SME_DEL_ALL_TDLS_PEERS - * @tdls_update_dp_vdev_flags store CDP_UPDATE_TDLS_FLAGS + * @tdls_update_dp_vdev_flags: store CDP_UPDATE_TDLS_FLAGS * @tdls_idle_peer_data: provide information about idle peer * @tdls_ct_spinlock: connection tracker spin lock * @is_prevent_suspend: prevent suspend or not @@ -196,7 +201,7 @@ struct tdls_set_state_info { * @fw_tdls_11ax_capability: bool for tdls 11ax fw capability * @fw_tdls_6g_capability: bool for tdls 6g fw capability * @bss_sta_power: bss sta power - * @@bss_sta_power_type: bss sta power type + * @bss_sta_power_type: bss sta power type * @fw_tdls_wideband_capability: bool for tdls wideband fw capability */ struct tdls_soc_priv_obj { @@ -269,6 +274,7 @@ struct tdls_soc_priv_obj { * @ct_peer_table: linear mac address table for counting the packets * @valid_mac_entries: number of valid mac entry in @ct_peer_mac_table * @magic: magic + * @session_id: vdev ID * @tx_queue: tx frame queue * @tdls_teardown_comp: tdls teardown completion */ @@ -329,6 +335,7 @@ struct tdls_peer_mlme_info { * @reason: reason * @state_change_notification: state change notification * @qos: QOS capability of TDLS link + * @tdls_info: MLME info */ struct tdls_peer { qdf_list_node_t node; @@ -537,7 +544,7 @@ void tdls_timer_restart(struct wlan_objmgr_vdev *vdev, uint32_t expiration_time); /** - * wlan_hdd_tdls_timers_stop() - stop all the tdls timers running + * tdls_timers_stop() - stop all the tdls timers running * @tdls_vdev: TDLS vdev * * Return: none @@ -557,8 +564,8 @@ QDF_STATUS tdls_get_vdev_objects(struct wlan_objmgr_vdev *vdev, struct tdls_soc_priv_obj **tdls_soc_obj); /** - * cds_set_tdls_ct_mode() - Set the tdls connection tracker mode - * @hdd_ctx: hdd context + * tdls_set_ct_mode() - Set the tdls connection tracker mode + * @psoc: objmgr psoc object * * This routine is called to set the tdls connection tracker operation status * @@ -637,6 +644,7 @@ void tdls_notify_decrement_session(struct wlan_objmgr_psoc *psoc); /** * tdls_send_update_to_fw - update tdls status info * @tdls_vdev_obj: tdls vdev private object. + * @tdls_soc_obj: TDLS soc private object * @tdls_prohibited: indicates whether tdls is prohibited. * @tdls_chan_swit_prohibited: indicates whether tdls channel switch * is prohibited. @@ -751,14 +759,14 @@ void tdls_scan_complete_event_handler(struct wlan_objmgr_vdev *vdev, /** * tdls_scan_callback() - callback for TDLS scan operation - * @soc: tdls soc pvt object + * @tdls_soc: tdls soc pvt object * * Return: QDF_STATUS */ QDF_STATUS tdls_scan_callback(struct tdls_soc_priv_obj *tdls_soc); /** - * wlan_hdd_tdls_scan_done_callback() - callback for tdls scan done event + * tdls_scan_done_callback() - callback for tdls scan done event * @tdls_soc: tdls soc object * * Return: Void @@ -769,9 +777,9 @@ void tdls_scan_done_callback(struct tdls_soc_priv_obj *tdls_soc); * tdls_scan_serialization_comp_info_cb() - callback for scan start * @vdev: VDEV on which the scan command is being processed * @comp_info: serialize rules info + * @cmd: the serialization command * - * Return: negative = caller should stop and return error code immediately - * 1 = caller can continue to scan + * Return: Void */ void tdls_scan_serialization_comp_info_cb(struct wlan_objmgr_vdev *vdev, union wlan_serialization_rules_info *comp_info, diff --git a/components/tdls/core/src/wlan_tdls_peer.c b/components/tdls/core/src/wlan_tdls_peer.c index f90068682a..08b4418fbf 100644 --- a/components/tdls/core/src/wlan_tdls_peer.c +++ b/components/tdls/core/src/wlan_tdls_peer.c @@ -691,6 +691,7 @@ void tdls_extract_peer_state_param(struct tdls_peer_update_state *peer_param, #ifdef TDLS_WOW_ENABLED /** * tdls_prevent_suspend(): Prevent suspend for TDLS + * @tdls_soc: TDLS soc object * * Acquire wake lock and prevent suspend for TDLS * @@ -709,6 +710,7 @@ static void tdls_prevent_suspend(struct tdls_soc_priv_obj *tdls_soc) /** * tdls_allow_suspend(): Allow suspend for TDLS + * @tdls_soc: TDLS soc object * * Release wake lock and allow suspend for TDLS * diff --git a/components/tdls/core/src/wlan_tdls_peer.h b/components/tdls/core/src/wlan_tdls_peer.h index 9a70ae9c16..95ba485ee1 100644 --- a/components/tdls/core/src/wlan_tdls_peer.h +++ b/components/tdls/core/src/wlan_tdls_peer.h @@ -37,7 +37,7 @@ struct tdls_search_peer_param { }; /** - * struct tdls_progress_param - used to search progress TDLS peer + * struct tdls_search_progress_param - used to search progress TDLS peer * @skip_self: skip self peer * @macaddr: MAC address of peer * @peer: pointer to the found peer @@ -86,8 +86,8 @@ struct tdls_peer * tdls_find_all_peer(struct tdls_soc_priv_obj *soc_obj, const uint8_t *macaddr); /** - * tdls_find_all_peer() - find peer matching the input MACaddr in soc range - * @soc_obj: TDLS soc object + * tdls_find_opclass() - find Operating Class based upon channel + * @psoc: objmgr soc object * @channel:channel number * @bw_offset: offset to bandwidth * @@ -136,8 +136,8 @@ qdf_freq_t tdls_get_offchan_freq(struct wlan_objmgr_vdev *vdev, struct tdls_soc_priv_obj *soc_obj); /** - * tdls_get_offchan_freq() - Get preferred offchannel bandwidth on basis of - * frequency + * tdls_get_offchan_bw() - Get preferred offchannel bandwidth on basis of + * frequency * @soc_obj: TDLS SOC object * @off_chan_freq: Offchannel frequency * @@ -162,7 +162,7 @@ void tdls_extract_peer_state_param(struct tdls_peer_update_state *peer_param, struct tdls_peer *peer); /** - * tdls_set_link_status() - set link statue for TDLS peer + * tdls_set_peer_link_status() - set link statue for TDLS peer * @peer: TDLS peer * @link_state: link state * @link_reason: reason with link status diff --git a/components/tdls/dispatcher/inc/wlan_tdls_api.h b/components/tdls/dispatcher/inc/wlan_tdls_api.h index d1e9573d03..200b3149c0 100644 --- a/components/tdls/dispatcher/inc/wlan_tdls_api.h +++ b/components/tdls/dispatcher/inc/wlan_tdls_api.h @@ -60,7 +60,7 @@ void wlan_tdls_teardown_links_sync(struct wlan_objmgr_psoc *psoc); * wlan_tdls_notify_sta_disconnect() - notify sta disconnect * @vdev_id: pointer to soc object * @lfr_roam: indicate, whether disconnect due to lfr roam - * @bool user_disconnect: disconnect from user space + * @user_disconnect: disconnect from user space * @vdev: vdev object manager * * Notify sta disconnect event to TDLS component diff --git a/components/tdls/dispatcher/inc/wlan_tdls_public_structs.h b/components/tdls/dispatcher/inc/wlan_tdls_public_structs.h index 674c517af7..1e70d67e53 100644 --- a/components/tdls/dispatcher/inc/wlan_tdls_public_structs.h +++ b/components/tdls/dispatcher/inc/wlan_tdls_public_structs.h @@ -283,12 +283,13 @@ enum tdls_event_type { /** * enum tdls_state_t - tdls state - * @QCA_WIFI_HAL_TDLS_DISABLED: TDLS is not enabled, or is disabled now - * @QCA_WIFI_HAL_TDLS_ENABLED: TDLS is enabled, but not yet tried - * @QCA_WIFI_HAL_TDLS_ESTABLISHED: Direct link is established - * @QCA_WIFI_HAL_TDLS_ESTABLISHED_OFF_CHANNEL: Direct link established using MCC - * @QCA_WIFI_HAL_TDLS_DROPPED: Direct link was established, but is now dropped - * @QCA_WIFI_HAL_TDLS_FAILED: Direct link failed + * @QCA_WIFI_HAL_TDLS_S_DISABLED: TDLS is not enabled, or is disabled now + * @QCA_WIFI_HAL_TDLS_S_ENABLED: TDLS is enabled, but not yet tried + * @QCA_WIFI_HAL_TDLS_S_ESTABLISHED: Direct link is established + * @QCA_WIFI_HAL_TDLS_S_ESTABLISHED_OFF_CHANNEL: Direct link established using + * MCC + * @QCA_WIFI_HAL_TDLS_S_DROPPED: Direct link was established, but is now dropped + * @QCA_WIFI_HAL_TDLS_S_FAILED: Direct link failed */ enum tdls_state_t { QCA_WIFI_HAL_TDLS_S_DISABLED = 1, @@ -343,7 +344,7 @@ enum tdls_event_msg_type { * handle this * @TDLS_EXIT_BT_BUSY: BT exited busy mode, TDLS connection tracker needs to * handle this - * @DLS_SCAN_STARTED: TDLS module received a scan start event, TDLS connection + * @TDLS_SCAN_STARTED: TDLS module received a scan start event, TDLS connection * tracker needs to handle this * @TDLS_SCAN_COMPLETED: TDLS module received a scan complete event, TDLS * connection tracker needs to handle this @@ -385,6 +386,7 @@ enum tdls_disable_sources { * @vdev: vdev object * @reason: used with teardown indication * @peer_mac: MAC address of the TDLS peer + * @status: operation status */ struct tdls_osif_indication { struct wlan_objmgr_vdev *vdev; @@ -580,7 +582,7 @@ struct tdls_rx_mgmt_frame { }; /** - * tdls_rx_callback() - Callback for rx mgmt frame + * typedef tdls_rx_callback() - Callback for rx mgmt frame * @user_data: user data associated to this rx mgmt frame. * @rx_frame: RX mgmt frame * @@ -592,8 +594,8 @@ typedef void (*tdls_rx_callback)(void *user_data, struct tdls_rx_mgmt_frame *rx_frame); /** - * tdls_wmm_check() - Callback for wmm info - * @psoc: psoc object + * typedef tdls_wmm_check() - Callback for wmm info + * @vdev_id: ID of the vdev to check * * This callback will be used to check wmm information * @@ -637,7 +639,8 @@ typedef QDF_STATUS typedef void (*tdls_offchan_parms_callback)(struct wlan_objmgr_vdev *vdev); /** - * tdls_vdev_init_cb() - Callback for initializing the tdls private structure + * typedef tdls_vdev_init_cb() - Callback for initializing the tdls private + * structure * @vdev: vdev object * * This callback will be used to create the vdev private object and store @@ -646,8 +649,10 @@ typedef void (*tdls_offchan_parms_callback)(struct wlan_objmgr_vdev *vdev); * Return: QDF_STATUS */ typedef QDF_STATUS (*tdls_vdev_init_cb)(struct wlan_objmgr_vdev *vdev); + /** - * tdls_vdev_deinit_cb() - Callback for deinitializing the tdls private struct + * typedef tdls_vdev_deinit_cb() - Callback for deinitializing the tdls + * private structure * @vdev: vdev object * * This callback will be used to destroy the vdev private object. @@ -657,7 +662,7 @@ typedef QDF_STATUS (*tdls_vdev_init_cb)(struct wlan_objmgr_vdev *vdev); typedef void (*tdls_vdev_deinit_cb)(struct wlan_objmgr_vdev *vdev); /** - * tdls_osif_cb() - Callbacks for updating osif params. + * struct tdls_osif_cb - Callbacks for updating osif params. * @tdls_osif_conn_update: Update osif params when TDLS peer is connected * @tdls_osif_disconn_update: Update osif params when TDLS peer is disconnected * @@ -677,6 +682,10 @@ struct tdls_osif_cb { * @tdls_update_peer_state: pass WMA_UPDATE_TDLS_PEER_STATE value * @tdls_del_all_peers: pass eWNI_SME_DEL_ALL_TDLS_PEERS * @tdls_update_dp_vdev_flags: pass CDP_UPDATE_TDLS_FLAGS + * @tdls_rx_cb: TDLS RX callback + * @tdls_rx_cb_data: TDLS RX callback context + * @tdls_wmm_cb: TDLS WMM check callback + * @tdls_wmm_cb_data: TDLS WMM check callback context * @tdls_event_cb: tdls event callback * @tdls_evt_cb_data: tdls event data * @tdls_peer_context: userdata for register/deregister TDLS peer @@ -684,7 +693,7 @@ struct tdls_osif_cb { * @tdls_dp_vdev_update: update vdev flags in datapath * @tdls_osif_init_cb: callback to initialize the tdls priv * @tdls_osif_deinit_cb: callback to deinitialize the tdls priv - * @tdls_osif_cb: callback to update osif params + * @tdls_osif_update_cb: callback to update osif params */ struct tdls_start_params { struct tdls_user_config config; @@ -753,7 +762,7 @@ struct tdls_del_peer_request { }; /** - * struct vhgmcsinfo - VHT MCS information + * struct vhtmcsinfo - VHT MCS information * @rx_mcs_map: RX MCS map 2 bits for each stream, total 8 streams * @rx_highest: Indicates highest long GI VHT PPDU data rate * STA can receive. Rate expressed in units of 1 Mbps. @@ -777,7 +786,7 @@ struct vhtmcsinfo { * * This structure is the "VHT capabilities element" as * described in 802.11ac D3.0 8.4.2.160 - * @vht_cap_info: VHT capability info + * @vht_capinfo: VHT capability info * @supp_mcs: VHT MCS supported rates */ struct vhtcap { @@ -785,6 +794,7 @@ struct vhtcap { struct vhtmcsinfo supp_mcs; }; +#ifdef WLAN_FEATURE_11AX /** * struct hecap - HE capabilities * @@ -792,8 +802,8 @@ struct vhtcap { * described in 802.11ax D4.0 section 9.4.2.232.3 * @mac_cap_info: MAC capability info * @phycap_info: Phy Capability info + * @he_cap_mcs_info: HE capabilities MCS information */ -#ifdef WLAN_FEATURE_11AX struct hecap { uint8_t mac_cap_info[6]; uint8_t phycap_info[11]; @@ -976,6 +986,7 @@ struct tdls_peer_params { * struct tdls_peer_update_state - TDLS peer state parameters * @vdev_id: vdev id * @peer_macaddr: peer mac address + * @peer_state: peer state * @peer_cap: peer capabality * @resp_reqd: response needed */ @@ -993,6 +1004,7 @@ struct tdls_peer_update_state { * @peer_mac_addr: Peer mac address * @tdls_off_ch_bw_offset: Target off-channel bandwidth offset * @tdls_off_ch: Target Off Channel + * @tdls_sw_mode: Switch mode * @oper_class: Operating class for target channel * @is_responder: Responder or initiator * @tdls_off_chan_freq: Target Off Channel frequency @@ -1059,7 +1071,7 @@ struct tdls_event_notify { }; /** - * struct tdls_event_notify - tdls event notify + * struct tdls_send_mgmt - tdls send management frame * @peer_mac: peer's mac address * @frame_type: Type of TDLS mgmt frame to be sent * @dialog: dialog token used in the frame. @@ -1112,7 +1124,7 @@ struct tdls_get_all_peers { }; /** - * struct tdls_send_action_frame_request - tdls send mgmt request + * struct tdls_action_frame_request - tdls send mgmt request * @vdev: vdev object * @chk_frame: This struct used to validate mgmt frame * @session_id: session id @@ -1152,6 +1164,7 @@ struct tdls_set_responder_req { * @tdls_prohibited: peer mac addr * @tdls_chan_swit_prohibited: peer type * @lfr_roam: is trigger due to lfr + * @user_disconnect: should userspace be notified of disconnect * @session_id: session id */ struct tdls_sta_notify_params { @@ -1220,7 +1233,7 @@ struct tdls_set_offchannel { }; /** - * struct tdls_set_offchan_mode - TDLS set offchannel mode + * struct tdls_set_offchanmode - TDLS set offchannel mode * @vdev: vdev object * @offchan_mode: Updated tdls offchannel mode value. * @callback: callback to release vdev ref. @@ -1232,7 +1245,7 @@ struct tdls_set_offchanmode { }; /** - * struct tdls_set_offchan_offset - TDLS set offchannel mode + * struct tdls_set_secoffchanneloffset - TDLS set secondary offchannel offset * @vdev: vdev object * @offchan_offset: Offchan offset value. * @callback: callback to release vdev ref. @@ -1310,7 +1323,7 @@ struct tdls_del_sta_rsp { struct wlan_objmgr_psoc *psoc; }; -/* +/** * struct tdls_send_mgmt_request - tdls management request * @message_type: type of pe message * @length: length of the frame. @@ -1322,6 +1335,7 @@ struct tdls_del_sta_rsp { * @peer_capability: peer capability information * @bssid: bssid * @peer_mac: mac address of the peer + * @ac: Access Category to use * @add_ie: additional ie's to be included */ struct tdls_send_mgmt_request { @@ -1359,8 +1373,10 @@ struct tdls_send_mgmt_request { * @vht_cap: vht capability * @he_cap_len: he capability length * @he_cap: he capability + * @he_6ghz_cap: HE 6 GHz capability * @uapsd_queues: uapsd queue as sSirMacQosInfoStation * @max_sp: maximum service period + * @is_pmf: is PMF active */ struct tdls_add_sta_req { uint16_t message_type; diff --git a/components/tdls/dispatcher/inc/wlan_tdls_ucfg_api.h b/components/tdls/dispatcher/inc/wlan_tdls_ucfg_api.h index f1a67285ca..600c8a0b01 100644 --- a/components/tdls/dispatcher/inc/wlan_tdls_ucfg_api.h +++ b/components/tdls/dispatcher/inc/wlan_tdls_ucfg_api.h @@ -66,7 +66,7 @@ QDF_STATUS ucfg_tdls_psoc_open(struct wlan_objmgr_psoc *psoc); QDF_STATUS ucfg_tdls_psoc_close(struct wlan_objmgr_psoc *psoc); /** - * ucfg_tdls_psoc_start() - TDLS module start + * ucfg_tdls_update_config() - TDLS module start * @psoc: psoc object * @req: tdls start paramets * @@ -120,7 +120,7 @@ void ucfg_update_fw_tdls_6g_capability(struct wlan_objmgr_psoc *psoc, bool is_fw_tdls_6g_capable); /** - * ucfg_tdls_is_fw_11ax_supported() - Get FW TDLS 11ax capability from TLDS + * ucfg_tdls_is_fw_11ax_capable() - Get FW TDLS 11ax capability from TLDS * component. * @psoc: psoc object * @@ -284,7 +284,7 @@ void ucfg_tdls_notify_sta_connect(uint8_t vdev_id, * ucfg_tdls_notify_sta_disconnect() - notify sta disconnect * @vdev_id: pointer to soc object * @lfr_roam: indicate, whether disconnect due to lfr roam - * @bool user_disconnect: disconnect from user space + * @user_disconnect: disconnect from user space * @vdev: vdev object manager * * Notify sta disconnect event to TDLS component diff --git a/components/tdls/dispatcher/src/wlan_tdls_ucfg_api.c b/components/tdls/dispatcher/src/wlan_tdls_ucfg_api.c index ea490a760e..bdf3ec93e6 100644 --- a/components/tdls/dispatcher/src/wlan_tdls_ucfg_api.c +++ b/components/tdls/dispatcher/src/wlan_tdls_ucfg_api.c @@ -236,7 +236,8 @@ static QDF_STATUS tdls_object_init_params( #ifdef TDLS_WOW_ENABLED /** - * tdls_wow_init(): Create/init wake lock for TDLS + * tdls_wow_init() - Create/init wake lock for TDLS + * @soc_obj: TDLS private soc object * * Create/init wake lock for TDLS if DVR isn't supported * @@ -253,7 +254,8 @@ static void tdls_wow_init(struct tdls_soc_priv_obj *soc_obj) } /** - * tdls_wow_deinit(): Destroy/deinit wake lock for TDLS + * tdls_wow_deinit() - Destroy/deinit wake lock for TDLS + * @soc_obj: TDLS private soc object * * Destroy/deinit wake lock for TDLS if DVR isn't supported *