qcacld-3.0: Fix P2P Documentation

The kernel-doc script identified a few documentation issues in
components/p2p, so fix them.

Change-Id: I24e612e8976e721281a6ede4afefd20de0622599
CRs-Fixed: 3359593
This commit is contained in:
Jeff Johnson
2022-12-13 10:04:09 -08:00
committed by Madan Koyyalamudi
parent 116c817bb8
commit a24656423c
5 changed files with 25 additions and 22 deletions

View File

@@ -116,7 +116,7 @@ enum p2p_event_type {
/**
* struct p2p_tx_conf_event - p2p tx confirm event
* @p2p_soc_obj: p2p soc private object
* @buf: buffer address
* @nbuf: buffer address
* @status: tx status
*/
struct p2p_tx_conf_event {
@@ -292,7 +292,8 @@ struct action_frame_random_mac {
};
/**
* p2p_request_mgr_callback_t() - callback to process set mac filter result
* typedef p2p_request_mgr_callback_t() - callback to process set mac filter
* result
* @result: bool
* @context: callback context.
*

View File

@@ -171,9 +171,11 @@ struct p2p_frame_info {
* @off_chan: Is this off channel tx
* @no_cck: Required cck or not
* @no_ack: Required ack or not
* @rand_mac_tx: Use random MAC address
* @duration: Duration for the RoC
* @tx_timer: RoC timer
* @frame_info: Frame type information
* @nbuf: Network buffer
*/
struct tx_action_context {
qdf_list_node_t node;

View File

@@ -51,7 +51,7 @@ enum mcc_quota_type {
};
/**
* struct chan_quota - mcc channel quota
* struct channel_quota - mcc channel quota
* @chan_mhz: frequency of the channel for which the quota is set
* @channel_time_quota: channel time quota expressed as percentage
*/

View File

@@ -245,7 +245,7 @@ struct noa_descriptor {
* @opps_ps: opps ps state of the AP
* @ct_window: ct window in TUs
* @vdev_id: vdev id
* @num_descriptors: number of NOA descriptors
* @num_desc: number of NOA descriptors
* @noa_desc: noa descriptors
*/
struct p2p_noa_info {
@@ -267,7 +267,7 @@ struct p2p_protocol_callbacks {
/**
* enum p2p_attr_id - enum for P2P attributes ID in P2P IE
* @P2P_ATTR_STATUS - Attribute Status none
* @P2P_ATTR_STATUS: Attribute Status none
* @P2P_ATTR_MINOR_REASON_CODE: Minor reason code attribute
* @P2P_ATTR_CAPABILITY: Capability attribute
* @P2P_ATTR_DEVICE_ID: device ID attribute
@@ -289,13 +289,13 @@ struct p2p_protocol_callbacks {
* @P2P_ATTR_OOB_GO_NEG_CHANNEL: GO neg channel attribute
* @P2P_ATTR_SERVICE_HASH: Service HASH attribute
* @P2P_ATTR_SESSION_INFORMATION_DATA: Session Info data attribute
* @P2P_ATTR_CONNECTION_CAPABILITY = Connection capability attribute
* @P2P_ATTR_ADVERTISEMENT_ID = Advertisement ID attribute
* @P2P_ATTR_ADVERTISED_SERVICE = Advertised Service attribute
* @P2P_ATTR_SESSION_ID = Session ID attribute
* @P2P_ATTR_FEATURE_CAPABILITY = Feature capability attribute
* @P2P_ATTR_PERSISTENT_GROUP -Persistent group attribute
* @P2P_ATTR_VENDOR_SPECIFIC - Vendor specific attribute
* @P2P_ATTR_CONNECTION_CAPABILITY: Connection capability attribute
* @P2P_ATTR_ADVERTISEMENT_ID: Advertisement ID attribute
* @P2P_ATTR_ADVERTISED_SERVICE: Advertised Service attribute
* @P2P_ATTR_SESSION_ID: Session ID attribute
* @P2P_ATTR_FEATURE_CAPABILITY: Feature capability attribute
* @P2P_ATTR_PERSISTENT_GROUP: Persistent group attribute
* @P2P_ATTR_VENDOR_SPECIFIC: Vendor specific attribute
*/
enum p2p_attr_id {
P2P_ATTR_STATUS = 0,

View File

@@ -40,7 +40,7 @@ struct p2p_protocol_callbacks;
struct mcc_quota_info;
/**
* p2p_rx_callback() - Callback for rx mgmt frame
* typedef p2p_rx_callback() - Callback for rx mgmt frame
* @user_data: user data associated to this rx mgmt frame.
* @rx_frame: RX mgmt frame
*
@@ -52,7 +52,7 @@ typedef void (*p2p_rx_callback)(void *user_data,
struct p2p_rx_mgmt_frame *rx_frame);
/**
* p2p_action_tx_cnf_callback() - Callback for tx confirmation
* typedef p2p_action_tx_cnf_callback() - Callback for tx confirmation
* @user_data: user data associated to this tx confirmation
* @tx_cnf: tx confirmation information
*
@@ -65,7 +65,7 @@ typedef void (*p2p_action_tx_cnf_callback)(void *user_data,
struct p2p_tx_cnf *tx_cnf);
/**
* p2p_lo_event_callback() - Callback for listen offload event
* typedef p2p_lo_event_callback() - Callback for listen offload event
* @user_data: user data associated to this lo event
* @p2p_lo_event: listen offload event information
*
@@ -77,7 +77,7 @@ typedef void (*p2p_lo_event_callback)(void *user_data,
struct p2p_lo_event *p2p_lo_event);
/**
* p2p_event_callback() - Callback for P2P event
* typedef p2p_event_callback() - Callback for P2P event
* @user_data: user data associated to this p2p event
* @p2p_event: p2p event information
*
@@ -89,7 +89,7 @@ typedef void (*p2p_event_callback)(void *user_data,
struct p2p_event *p2p_event);
/**
* mcc_quota_event_callback() - Callback for mcc quota
* typedef mcc_quota_event_callback() - Callback for mcc quota
* @psoc: psoc object
* @vdev: vdev object
* @mcc_quota: mcc quota event information
@@ -105,10 +105,10 @@ typedef QDF_STATUS (*mcc_quota_event_callback)(struct wlan_objmgr_psoc *psoc,
/**
* struct p2p_start_param - p2p soc start parameters. Below callbacks
* will be registered by the HDD
* @rx_callback: Function pointer to hdd rx callback. This
* @rx_cb: Function pointer to hdd rx callback. This
* function will be used to give rx frames to hdd
* @rx_cb_data: RX callback user data
* @event_cb: Founction pointer to hdd p2p event callback.
* @event_cb: Function pointer to hdd p2p event callback.
* This function will be used to give p2p event
* to hdd
* @event_cb_data: Pointer to p2p event callback user data
@@ -116,7 +116,7 @@ typedef QDF_STATUS (*mcc_quota_event_callback)(struct wlan_objmgr_psoc *psoc,
* This function will be used to give tx confirm
* to hdd
* @tx_cnf_cb_data: Pointer to p2p tx confirm callback user data
* @lo_event_cb: Founction pointer to p2p listen offload
* @lo_event_cb: Function pointer to p2p listen offload
* callback. This function will be used to give
* listen offload stopped event to hdd
* @lo_event_cb_data: Pointer to p2p listen offload callback user data
@@ -230,7 +230,7 @@ QDF_STATUS ucfg_p2p_roc_cancel_req(struct wlan_objmgr_psoc *soc,
QDF_STATUS ucfg_p2p_cleanup_roc_by_vdev(struct wlan_objmgr_vdev *vdev);
/**
* ucfg_p2p_cleanup_roc_by_poc() - Cleanup roc request by psoc
* ucfg_p2p_cleanup_roc_by_psoc() - Cleanup roc request by psoc
* @psoc: pointer to psoc object
*
* This function call P2P API to cleanup roc request by psoc
@@ -250,7 +250,7 @@ QDF_STATUS ucfg_p2p_cleanup_roc_by_psoc(struct wlan_objmgr_psoc *psoc);
QDF_STATUS ucfg_p2p_cleanup_tx_by_vdev(struct wlan_objmgr_vdev *vdev);
/**
* ucfg_p2p_cleanup_tx_by_poc() - Cleanup tx request by psoc
* ucfg_p2p_cleanup_tx_by_psoc() - Cleanup tx request by psoc
* @psoc: pointer to psoc object
*
* This function call P2P API to cleanup tx action frame request by psoc