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 Packet Capture Documentation

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

Change-Id: I9fc7922978cbfacf3f8a733561dd0f94c6cea3b4
CRs-Fixed: 3359684
This commit is contained in:
Jeff Johnson
2022-12-13 13:17:58 -08:00
committed by Madan Koyyalamudi
parent 4ba68cd451
commit 139cf10b44
9 changed files with 79 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
components/pkt_capture/core/inc/wlan_pkt_capture_data_txrx.h
View File

@@ -43,7 +43,7 @@
#endif
/**
* pkt_capture_data_process_type - data pkt types to process
* enum pkt_capture_data_process_type - data pkt types to process
* for packet capture mode
* @TXRX_PROCESS_TYPE_DATA_RX: process RX packets (normal rx + offloaded rx)
* @TXRX_PROCESS_TYPE_DATA_TX: process TX packets (ofloaded tx)
@@ -80,7 +80,7 @@ void pkt_capture_datapkt_process(
uint8_t vdev_id,
qdf_nbuf_t mon_buf_list,
enum pkt_capture_data_process_type type,
uint8_t tid, uint8_t status, bool pktformat,
uint8_t tid, uint8_t status, bool pkt_format,
uint8_t *bssid, void *pdev,
uint8_t tx_retry_cnt);
@@ -91,6 +91,7 @@ void pkt_capture_datapkt_process(
* @head_msdu: pointer to head msdu
* @vdev_id: vdev_id
* @pdev: pdev handle
* @status: capture status
*
* Return: none
*/
@@ -153,7 +154,7 @@ void pkt_capture_offload_deliver_indication_handler(
#endif
/**
* pkt_capture_tx_hdr_elem_t - tx packets header structure to
* struct pkt_capture_tx_hdr_elem_t - tx packets header structure to
* be used to update radiotap header for packet capture mode
* @timestamp: timestamp
* @preamble: preamble
@@ -161,7 +162,7 @@ void pkt_capture_offload_deliver_indication_handler(
* @rate: rate
* @rssi_comb: rssi in dBm
* @nss: if nss 1 means 1ss and 2 means 2ss
* @bw: BW (0=>20MHz, 1=>40MHz, 2=>80MHz, 3=>160MHz)
* @bw: BW (0=>20 MHz, 1=>40 MHz, 2=>80 MHz, 3=>160 MHz)
* @stbc: STBC
* @sgi: SGI
* @ldpc: LDPC
@@ -169,6 +170,8 @@ void pkt_capture_offload_deliver_indication_handler(
* @dir: direction rx: 0 and tx: 1
* @status: tx status
* @tx_retry_cnt: tx retry count
* @framectrl: frame control
* @seqno: sequence number
* @ppdu_id: ppdu_id of msdu
*/
struct pkt_capture_tx_hdr_elem_t {
@@ -183,8 +186,8 @@ struct pkt_capture_tx_hdr_elem_t {
bool sgi;
bool ldpc;
bool beamformed;
bool dir; /* rx:0 , tx:1 */
uint8_t status; /* tx status */
bool dir;
uint8_t status;
uint8_t tx_retry_cnt;
uint16_t framectrl;
uint16_t seqno;
@@ -192,7 +195,7 @@ struct pkt_capture_tx_hdr_elem_t {
};
/**
* pkt_capture_ppdu_stats_q_node - node structure to be enqueued
* struct pkt_capture_ppdu_stats_q_node - node structure to be enqueued
* in ppdu_stats_q
* @node: list node
* @buf: buffer data received from ppdu_stats

7
components/pkt_capture/core/inc/wlan_pkt_capture_main.h
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2020-2021 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
@@ -57,9 +58,9 @@
/**
* enum pkt_capture_tx_status - packet capture tx status
* @pktcapture_tx_status_ok: successfully sent + acked
* @pktcapture_tx_status_discard: discard - not sent
* @pktcapture_tx_status_no_ack: no_ack - sent, but no ack
* @pkt_capture_tx_status_ok: successfully sent + acked
* @pkt_capture_tx_status_discard: discard - not sent
* @pkt_capture_tx_status_no_ack: no_ack - sent, but no ack
*
* This enum has tx status types for packet capture mode
*/

9
components/pkt_capture/core/inc/wlan_pkt_capture_mon_thread.h
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 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
@@ -46,7 +47,7 @@ typedef void (*pkt_capture_mon_thread_cb)(
uint8_t *bssid,
uint8_t tx_retry_cnt);
/*
/**
* struct pkt_capture_mon_pkt - mon packet wrapper for mon data from TXRX
* @list: List for storing mon packets
* @context: Callback context
@@ -130,7 +131,7 @@ struct radiotap_header {
/**
* pkt_capture_suspend_mon_thread() - suspend packet capture mon thread
* vdev: pointer to vdev object manager
* @vdev: pointer to vdev object manager
*
* Return: 0 on success, -EINVAL on failure
*/
@@ -138,7 +139,7 @@ int pkt_capture_suspend_mon_thread(struct wlan_objmgr_vdev *vdev);
/**
* pkt_capture_resume_mon_thread() - resume packet capture mon thread
* vdev: pointer to vdev object manager
* @vdev: pointer to vdev object manager
*
* Resume packet capture MON thread by completing RX thread resume event.
*
@@ -148,7 +149,7 @@ void pkt_capture_resume_mon_thread(struct wlan_objmgr_vdev *vdev);
/**
* pkt_capture_drop_monpkt() - API to drop pending mon packets
* mon_ctx: pointer to packet capture mon context
* @mon_ctx: pointer to packet capture mon context
*
* This api drops all the pending packets in the queue.
*

13
components/pkt_capture/core/src/wlan_pkt_capture_data_txrx.c
View File

@@ -229,7 +229,7 @@ static void pkt_capture_tx_get_phy_info(
* pkt capture mode(normal tx + offloaded tx) to prepare radiotap header
* @pdev: device handler
* @tx_status: tx status to be updated
* @mon_hdr: tx data header
* @pktcapture_hdr: tx data header
*
* Return: none
*/
@@ -654,6 +654,7 @@ void pkt_capture_msdu_process_pkts(
#ifdef WLAN_FEATURE_PKT_CAPTURE_V2
/**
* pkt_capture_dp_rx_skip_tlvs() - Skip TLVs len + L2 hdr_offset, save in nbuf
* @soc: DP soc context
* @nbuf: nbuf to be updated
* @l3_padding: l3_padding
*
@@ -782,7 +783,7 @@ uint8_t pkt_capture_get_rx_rtap_flags(struct hal_rx_pkt_capture_flags *flags)
/**
* pkt_capture_rx_mon_get_rx_status() - Get rx status
* @context: objmgr vdev
* @psoc: dp_soc handle
* @dp_soc: dp_soc handle
* @desc: Pointer to struct rx_pkt_tlvs
* @rx_status: Pointer to struct mon_rx_status
*
@@ -1082,14 +1083,14 @@ free_buf:
/**
* pkt_capture_tx_data_cb() - process data tx and rx packets
* for pkt capture mode. (normal tx/rx + offloaded tx/rx)
* @context: capture context (unused)
* @ppdev: pdev handle
* @nbuf_list: netbuf list
* @vdev_id: vdev id for which packet is captured
* @mon_buf_list: netbuf list
* @type: data process type
* @tid: tid number
* @status: Tx status
* @pktformat: Frame format
* @pkt_format: Frame format
* @bssid: bssid
* @pdev: pdev handle
* @tx_retry_cnt: tx retry count
*
* Return: none

2
components/pkt_capture/core/src/wlan_pkt_capture_main.c
View File

@@ -399,7 +399,7 @@ pkt_capture_process_tx_data(void *soc, void *log_data, u_int16_t vdev_id,
/**
* pkt_capture_is_frame_filter_set() - Check frame filter is set
* @nbuf: buffer address
* @buf: buffer address
* @frame_filter: frame filter address
* @direction: frame direction
*

9
components/pkt_capture/core/src/wlan_pkt_capture_mgmt_txrx.c
View File

@@ -57,11 +57,13 @@ pkt_capture_mgmt_status_map(uint8_t status)
* pkt_capture_mgmtpkt_cb() - callback to process management packets
* for pkt capture mode
* @context: vdev handler
* @ppdev: unused param
* @nbuf_list: netbuf list
* @vdev_id: vdev id for which packet is captured
* @tid: tid number
* @ch_freq: channel frequency
* @pkt_format: Frame format
* @bssid:
* @tx_retry_cnt: tx retry count
*
* Return: none
@@ -622,9 +624,12 @@ pkt_capture_is_beacon_forward_enable(struct wlan_objmgr_vdev *vdev,
#endif
/**
* process_pktcapture_mgmt_rx_data_cb() - process management rx packets
* @rx_params: mgmt rx event params
* pkt_capture_mgmt_rx_data_cb() - process management rx packets
* @psoc: psoc object
* @peer: Peer object
* @wbuf: netbuf
* @rx_params: mgmt rx event params
* @frm_type: frame type
*
* Return: none
*/

44
components/pkt_capture/dispatcher/inc/wlan_pkt_capture_public_structs.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2020-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-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
@@ -40,12 +40,12 @@ enum pkt_capture_mode {
* enum pkt_capture_config - packet capture config
* @PACKET_CAPTURE_CONFIG_TRIGGER_ENABLE: enable capture for trigger frames only
* @PACKET_CAPTURE_CONFIG_QOS_ENABLE: enable capture for qos frames only
* @PACKET_CAPTURE_CONFIG_CONNECT_NO_BEACON_ENABLE: drop all beacons, when
* @PACKET_CAPTURE_CONFIG_BEACON_ENABLE: enable only connected BSSID
* beacons, when device in connected state
* @PACKET_CAPTURE_CONFIG_OFF_CHANNEL_BEACON_ENABLE: enable off channel
* beacons, when device in connected state
* @PACKET_CAPTURE_CONFIG_NO_BEACON_ENABLE: drop all beacons, when
* device in connected state
* @PACKET_CAPTURE_CONFIG_CONNECT_BEACON_ENABLE: enable only connected BSSID
* beacons, when device in connected state
* @PACKET_CAPTURE_CONFIG_CONNECT_OFF_CHANNEL_BEACON_ENABLE: enable off channel
* beacons, when device in connected state
*/
enum pkt_capture_config {
PACKET_CAPTURE_CONFIG_TRIGGER_ENABLE = BIT(0),
@@ -99,6 +99,7 @@ struct pkt_capture_callbacks {
* pointers for packet capture component
* @pkt_capture_send_mode: send packet capture mode
* @pkt_capture_send_config: send packet capture config
* @pkt_capture_send_beacon_interval: send beacon interval
*
*/
struct wlan_pkt_capture_tx_ops {
@@ -135,8 +136,26 @@ struct wlan_pkt_capture_rx_ops {
};
/**
* pkt_capture_data_frame_type - Represent the various
* enum pkt_capture_data_frame_type - Represent the various
* data types to be filtered in packet capture.
* @PKT_CAPTURE_DATA_FRAME_TYPE_ALL:
* @PKT_CAPTURE_DATA_FRAME_TYPE_ARP:
* @PKT_CAPTURE_DATA_FRAME_TYPE_DHCPV4:
* @PKT_CAPTURE_DATA_FRAME_TYPE_DHCPV6:
* @PKT_CAPTURE_DATA_FRAME_TYPE_EAPOL:
* @PKT_CAPTURE_DATA_FRAME_TYPE_DNSV4:
* @PKT_CAPTURE_DATA_FRAME_TYPE_DNSV6:
* @PKT_CAPTURE_DATA_FRAME_TYPE_TCP_SYN:
* @PKT_CAPTURE_DATA_FRAME_TYPE_TCP_SYNACK:
* @PKT_CAPTURE_DATA_FRAME_TYPE_TCP_FIN:
* @PKT_CAPTURE_DATA_FRAME_TYPE_TCP_FINACK:
* @PKT_CAPTURE_DATA_FRAME_TYPE_TCP_ACK:
* @PKT_CAPTURE_DATA_FRAME_TYPE_TCP_RST:
* @PKT_CAPTURE_DATA_FRAME_TYPE_ICMPV4:
* @PKT_CAPTURE_DATA_FRAME_TYPE_ICMPV6:
* @PKT_CAPTURE_DATA_FRAME_TYPE_RTP:
* @PKT_CAPTURE_DATA_FRAME_TYPE_SIP:
* @PKT_CAPTURE_DATA_FRAME_QOS_NULL:
*/
enum pkt_capture_data_frame_type {
PKT_CAPTURE_DATA_FRAME_TYPE_ALL = BIT(0),
@@ -161,14 +180,14 @@ enum pkt_capture_data_frame_type {
};
/**
* pkt_capture_mgmt_frame_type - Represent the various
* enum pkt_capture_mgmt_frame_type - Represent the various
* mgmt types to be sent over the monitor interface.
* @PKT_CAPTURE_MGMT_FRAME_TYPE_ALL: All the MGMT Frames.
* @PKT_CAPTURE_MGMT_CONNECT_NO_BEACON: All the MGMT Frames
* except the Beacons. Valid only in the Connect state.
* @PKT_CAPTURE_MGMT_CONNECT_BEACON: Only the connected
* BSSID Beacons. Valid only in the Connect state.
* @PKT_CAPTURE_MONITOR_MGMT_CONNECT_SCAN_BEACON: Represents
* @PKT_CAPTURE_MGMT_CONNECT_SCAN_BEACON: Represents
* the Beacons obtained during the scan (off channel and connected channel)
* when in connected state.
*/
@@ -182,7 +201,7 @@ enum pkt_capture_mgmt_frame_type {
};
/**
* pkt_capture_ctrl_frame_type - Represent the various
* enum pkt_capture_ctrl_frame_type - Represent the various
* ctrl types to be sent over the monitor interface.
* @PKT_CAPTURE_CTRL_FRAME_TYPE_ALL: All the ctrl Frames.
* @PKT_CAPTURE_CTRL_TRIGGER_FRAME: Trigger Frame.
@@ -198,6 +217,8 @@ enum pkt_capture_ctrl_frame_type {
* vendor command QCA_NL80211_VENDOR_SUBCMD_SET_MONITOR_MODE to set the
* monitor mode.
*
* @PKT_CAPTURE_ATTR_SET_MONITOR_MODE_INVALID: Invalid value
*
* @PKT_CAPTURE_ATTR_SET_MONITOR_MODE_DATA_TX_FRAME_TYPE: u32 attribute,
* Represents the tx data packet type to be monitored (u32). These data packets
* are represented by enum pkt_capture_data_frame_type.
@@ -226,6 +247,9 @@ enum pkt_capture_ctrl_frame_type {
* An interval only for the connected beacon interval, which expects that the
* connected BSSID's beacons shall be sent on the monitor interface only on this
* specific interval.
*
* @PKT_CAPTURE_ATTR_SET_MONITOR_MODE_AFTER_LAST: Internal use
* @PKT_CAPTURE_ATTR_SET_MONITOR_MODE_MAX: Value of last valid enumeration
*/
enum pkt_capture_attr_set_monitor_mode {
PKT_CAPTURE_ATTR_SET_MONITOR_MODE_INVALID = 0,

21
components/pkt_capture/dispatcher/inc/wlan_pkt_capture_ucfg_api.h
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2020-2021 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
@@ -63,7 +64,7 @@ ucfg_pkt_capture_get_mode(struct wlan_objmgr_psoc *psoc);
/**
* ucfg_pkt_capture_suspend_mon_thread() - suspend packet capture mon thread
* vdev: pointer to vdev object manager
* @vdev: pointer to vdev object manager
*
* Return: 0 on success, -EINVAL on failure
*/
@@ -71,7 +72,7 @@ int ucfg_pkt_capture_suspend_mon_thread(struct wlan_objmgr_vdev *vdev);
/**
* ucfg_pkt_capture_resume_mon_thread() - resume packet capture mon thread
* vdev: pointer to vdev object manager
* @vdev: pointer to vdev object manager
*
* Resume packet capture MON thread by completing RX thread resume event
*
@@ -82,8 +83,8 @@ void ucfg_pkt_capture_resume_mon_thread(struct wlan_objmgr_vdev *vdev);
/**
* ucfg_pkt_capture_register_callbacks - Register packet capture callbacks
* @vdev: pointer to wlan vdev object manager
* mon_cb: callback to call
* context: callback context
* @mon_cb: callback to call
* @context: callback context
*
* Return: QDF_STATUS
*/
@@ -102,9 +103,9 @@ QDF_STATUS
ucfg_pkt_capture_deregister_callbacks(struct wlan_objmgr_vdev *vdev);
/**
* ucfg_pkt_capturee_set_pktcap_mode - Set packet capture mode
* ucfg_pkt_capture_set_pktcap_mode - Set packet capture mode
* @psoc: pointer to psoc object
* @mode: mode to be set
* @val: mode to be set
*
* Return: None
*/
@@ -121,7 +122,7 @@ enum pkt_capture_mode
ucfg_pkt_capture_get_pktcap_mode(struct wlan_objmgr_psoc *psoc);
/**
* ucfg_pkt_capturee_set_pktcap_config - Set packet capture config
* ucfg_pkt_capture_set_pktcap_config - Set packet capture config
* @vdev: pointer to vdev object
* @config: config to be set
*
@@ -251,7 +252,7 @@ struct htt_tx_data_hdr_information *ucfg_pkt_capture_tx_get_txcomplete_data_hdr(
* @type: data process type
* @tid: tid number
* @status: Tx status
* @pktformat: Frame format
* @pkt_format: Frame format
* @bssid: bssid
* @pdev: pdev handle
* @tx_retry_cnt: tx retry count
@@ -276,7 +277,7 @@ void ucfg_pkt_capture_tx_completion_process(
void ucfg_pkt_capture_record_channel(struct wlan_objmgr_vdev *vdev);
/**
* ucfg_pkt_capture_register_callbacks - ucfg API to register WMA callbacks
* ucfg_pkt_capture_register_wma_callbacks - ucfg API to register WMA callbacks
* @psoc: pointer to psoc object
* @cb_obj: Pointer to packet capture callback structure
*
@@ -287,7 +288,7 @@ ucfg_pkt_capture_register_wma_callbacks(struct wlan_objmgr_psoc *psoc,
struct pkt_capture_callbacks *cb_obj);
/**
* ucfg_pkt_capture_set_filter ucfg API to set frame filter
* ucfg_pkt_capture_set_filter() - ucfg API to set frame filter
* @frame_filter: pkt capture frame filter data
* @vdev: pointer to vdev
*

68
components/pkt_capture/dispatcher/src/wlan_pkt_capture_ucfg_api.c
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2020-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-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
@@ -35,14 +35,6 @@ enum pkt_capture_mode ucfg_pkt_capture_get_mode(struct wlan_objmgr_psoc *psoc)
return pkt_capture_get_mode(psoc);
}
/**
* ucfg_pkt_capture_register_callbacks - Register packet capture callbacks
* @vdev: pointer to wlan vdev object manager
* mon_cb: callback to call
* context: callback context
*
* Return: 0 in case of success, invalid in case of failure.
*/
QDF_STATUS
ucfg_pkt_capture_register_callbacks(struct wlan_objmgr_vdev *vdev,
QDF_STATUS (*mon_cb)(void *, qdf_nbuf_t),
@@ -51,74 +43,35 @@ ucfg_pkt_capture_register_callbacks(struct wlan_objmgr_vdev *vdev,
return pkt_capture_register_callbacks(vdev, mon_cb, context);
}
/**
* ucfg_pkt_capture_deregister_callbacks - De-register packet capture callbacks
* @vdev: pointer to wlan vdev object manager
*
* Return: 0 in case of success, invalid in case of failure.
*/
QDF_STATUS ucfg_pkt_capture_deregister_callbacks(struct wlan_objmgr_vdev *vdev)
{
return pkt_capture_deregister_callbacks(vdev);
}
/**
* ucfg_pkt_capture_set_pktcap_mode - Set packet capture mode
* @psoc: pointer to psoc object
* @mode: mode to be set
*
* Return: None
*/
void ucfg_pkt_capture_set_pktcap_mode(struct wlan_objmgr_psoc *psoc,
enum pkt_capture_mode mode)
{
pkt_capture_set_pktcap_mode(psoc, mode);
}
/**
* ucfg_pkt_capture_get_pktcap_mode - Get packet capture mode
* @psoc: pointer to psoc object
*
* Return: enum pkt_capture_mode
*/
enum pkt_capture_mode
ucfg_pkt_capture_get_pktcap_mode(struct wlan_objmgr_psoc *psoc)
{
return pkt_capture_get_pktcap_mode(psoc);
}
/**
* ucfg_pkt_capture_set_pktcap_config - Set packet capture config
* @vdev: pointer to vdev object
* @config: config to be set
*
* Return: None
*/
void ucfg_pkt_capture_set_pktcap_config(struct wlan_objmgr_vdev *vdev,
enum pkt_capture_config config)
{
pkt_capture_set_pktcap_config(vdev, config);
}
/**
* ucfg_pkt_capture_get_pktcap_config - Get packet capture config
* @vdev: pointer to vdev object
*
* Return: config value
*/
enum pkt_capture_config
ucfg_pkt_capture_get_pktcap_config(struct wlan_objmgr_vdev *vdev)
{
return pkt_capture_get_pktcap_config(vdev);
}
/**
* ucfg_pkt_capture_init() - Packet capture component initialization.
*
* This function gets called when packet capture initializing.
*
* Return: QDF_STATUS_SUCCESS - in case of success.
*/
QDF_STATUS ucfg_pkt_capture_init(void)
{
QDF_STATUS status;
@@ -215,15 +168,6 @@ void ucfg_pkt_capture_resume_mon_thread(struct wlan_objmgr_vdev *vdev)
pkt_capture_resume_mon_thread(vdev);
}
/**
* ucfg_process_pktcapture_mgmt_tx_data() - process management tx packets
* @pdev: pointer to pdev object
* @params: management offload event params
* @nbuf: netbuf
* @status: status
*
* Return: QDF_STATUS
*/
QDF_STATUS
ucfg_pkt_capture_process_mgmt_tx_data(struct wlan_objmgr_pdev *pdev,
struct mgmt_offload_event_params *params,
@@ -245,16 +189,6 @@ ucfg_pkt_capture_mgmt_tx(struct wlan_objmgr_pdev *pdev,
pkt_capture_mgmt_tx(pdev, nbuf, chan_freq, preamble_type);
}
/**
* ucfg_process_pktcapture_mgmt_tx_completion(): process mgmt tx completion
* for pkt capture mode
* @pdev: pointer to pdev object
* @desc_id: desc_id
* @status: status
* @params: management offload event params
*
* Return: none
*/
void
ucfg_pkt_capture_mgmt_tx_completion(struct wlan_objmgr_pdev *pdev,
uint32_t desc_id,