qcacld-3.0: Fix Datapath Component Documentation

The kernel-doc script identified some documentation issues in components/dp, so fix them. Change-Id: Ic6297d80cda845287e7a472add244c489afd253b CRs-Fixed: 3362039
2022-12-15 11:48:44 -08:00
Parent dc200c6377
--- a/components/dp/core/inc/wlan_dp_txrx.h
+++ b/components/dp/core/inc/wlan_dp_txrx.h
@@ -92,7 +92,7 @@ void dp_softap_check_wait_for_tx_eap_pkt(struct wlan_dp_intf *dp_intf,
 * dp_post_dhcp_ind() - Send DHCP START/STOP indication to FW
 * @dp_intf: pointer to dp interface
 * @mac_addr: mac address
- * @type: WMA message type
+ * @dhcp_start: true if DHCP start, otherwise DHCP stop
 *
 * Return: error number
 */
@@ -102,7 +102,7 @@ int dp_post_dhcp_ind(struct wlan_dp_intf *dp_intf,
 /**
 * dp_softap_inspect_dhcp_packet() - Inspect DHCP packet
 * @dp_intf: pointer to dp interface
- * @skb: pointer to OS packet (sk_buff)
+ * @nbuf: pointer to OS packet (sk_buff)
 * @dir: direction
 *
 * Inspect the Tx/Rx frame, and send DHCP START/STOP notification to the FW
@@ -148,7 +148,7 @@ int dp_softap_inspect_dhcp_packet(struct wlan_dp_intf *dp_intf,

 /**
 * dp_rx_flush_packet_cbk() - flush rx packet handler
- * @dp_intf_context: pointer to DP interface context
+ * @dp_intf_ctx: pointer to DP interface context
 * @vdev_id: vdev_id of the packets to be flushed
 *
 * Flush rx packet callback registered with data path. DP will call this to
@@ -182,7 +182,7 @@ void dp_softap_tx_timeout(struct wlan_dp_intf *dp_intf);

 /**
 * dp_softap_rx_packet_cbk() - Receive packet handler for SAP
- * @dp_intf_context: pointer to DP interface context
+ * @intf_ctx: pointer to DP interface context
 * @rx_buf: pointer to rx qdf_nbuf
 *
 * Receive callback registered with data path.  DP will call this to notify
@@ -232,19 +232,19 @@ QDF_STATUS dp_rx_packet_cbk(void *dp_intf_context, qdf_nbuf_t rx_buf);
 #if defined(WLAN_SUPPORT_RX_FISA)
 /**
 * wlan_dp_rx_fisa_cbk() - Entry function to FISA to handle aggregation
- * @soc: core txrx main context
- * @vdev: Handle DP vdev
+ * @dp_soc: core txrx main context
+ * @dp_vdev: Handle DP vdev
 * @nbuf_list: List nbufs to be aggregated
 *
 * Return: Success on aggregation
 */
 QDF_STATUS wlan_dp_rx_fisa_cbk(void *dp_soc, void *dp_vdev,
-			       qdf_nbuf_t rxbuf_list);
+			       qdf_nbuf_t nbuf_list);

 /**
 * wlan_dp_rx_fisa_flush_by_ctx_id() - Flush function to end of context
 *				   flushing of aggregates
- * @soc: core txrx main context
+ * @dp_soc: core txrx main context
 * @ring_num: REO number to flush the flow Rxed on the REO
 *
 * Return: Success on flushing the flows for the REO
@@ -253,7 +253,7 @@ QDF_STATUS wlan_dp_rx_fisa_flush_by_ctx_id(void *dp_soc, int ring_num);

 /**
 * wlan_dp_rx_fisa_flush_by_vdev_id() - Flush fisa aggregates per vdev id
- * @soc: core txrx main context
+ * @dp_soc: core txrx main context
 * @vdev_id: vdev ID
 *
 * Return: Success on flushing the flows for the vdev
@@ -268,8 +268,9 @@ static inline QDF_STATUS wlan_dp_rx_fisa_flush_by_vdev_id(void *dp_soc,
 #endif

 /**
- * dp_rx_deliver_to_stack() - DP helper function to deliver RX pkts to stack
- * @dp_intf_context: pointer to DP interface context
+ * wlan_dp_rx_deliver_to_stack() - DP helper function to deliver RX pkts to
+ *                                 stack
+ * @dp_intf: pointer to DP interface context
 * @nbuf: pointer to nbuf
 *
 * The function calls the appropriate stack function depending upon the packet
@@ -283,7 +284,7 @@ QDF_STATUS wlan_dp_rx_deliver_to_stack(struct wlan_dp_intf *dp_intf,

 /**
 * dp_rx_thread_gro_flush_ind_cbk() - receive handler to flush GRO packets
- * @dp_intf_context: pointer to DP interface context
+ * @intf_ctx: pointer to DP interface context
 * @rx_ctx_id: RX CTX Id for which flush should happen
 *
 * Receive callback registered with DP layer which flushes GRO packets
@@ -292,11 +293,11 @@ QDF_STATUS wlan_dp_rx_deliver_to_stack(struct wlan_dp_intf *dp_intf,
 * Return: QDF_STATUS_E_FAILURE if any errors encountered,
 *	   QDF_STATUS_SUCCESS otherwise
 */
-QDF_STATUS dp_rx_thread_gro_flush_ind_cbk(void *dp_intf_ctx, int rx_ctx_id);
+QDF_STATUS dp_rx_thread_gro_flush_ind_cbk(void *intf_ctx, int rx_ctx_id);

 /**
 * dp_rx_pkt_thread_enqueue_cbk() - receive pkt handler to enqueue into thread
- * @dp_intf_context: pointer to DP interface context
+ * @intf_ctx: pointer to DP interface context
 * @nbuf_list: pointer to qdf_nbuf list
 *
 * Receive callback registered with DP layer which enqueues packets into dp rx
@@ -305,7 +306,7 @@ QDF_STATUS dp_rx_thread_gro_flush_ind_cbk(void *dp_intf_ctx, int rx_ctx_id);
 * Return: QDF_STATUS_E_FAILURE if any errors encountered,
 *	   QDF_STATUS_SUCCESS otherwise
 */
-QDF_STATUS dp_rx_pkt_thread_enqueue_cbk(void *dp_intf_ctx,
+QDF_STATUS dp_rx_pkt_thread_enqueue_cbk(void *intf_ctx,
 					qdf_nbuf_t nbuf_list);

 /**
@@ -508,7 +509,7 @@ dp_start_xmit(struct wlan_dp_intf *dp_intf, qdf_nbuf_t nbuf);
 /**
 * dp_mon_rx_packet_cbk() - Receive callback registered with OL layer.
 * @context: pointer to qdf context
- * @rx_buf: pointer to rx qdf_nbuf
+ * @rxbuf: pointer to rx qdf_nbuf
 *
 * TL will call this to notify the HDD when one or more packets were
 * received for a registered STA.
@@ -565,9 +566,9 @@ void dp_rx_monitor_callback(ol_osif_vdev_handle vdev, qdf_nbuf_t mpdu,
 void dp_sta_notify_tx_comp_cb(qdf_nbuf_t nbuf, void *ctx, uint16_t flag);

 /**
- * dp_softap_notify_tx_comp_cb() - notify softap tx comp registered with dp
+ * dp_softap_notify_tx_compl_cbk() - notify softap tx comp registered with dp
 * @nbuf: pointer to nbuf
- * @ctx: osif context
+ * @context: osif context
 * @flag: tx status flag
 *
 * Return: None
@@ -589,12 +590,10 @@ static inline bool dp_rx_pkt_tracepoints_enabled(void)

 #ifdef CONFIG_DP_PKT_ADD_TIMESTAMP
 /**
- * dp_pkt_add_timestamp() - add timestamp in data payload
- *
- * @dp_intf - DP interface
- * @index - timestamp index which decides offset in payload
- * @time - time to update in payload
- * @nbuf - Network socket buffer
+ * wlan_dp_pkt_add_timestamp() - add timestamp in data payload
+ * @dp_intf: DP interface
+ * @index: timestamp index which decides offset in payload
+ * @nbuf: Network socket buffer
 *
 * Return: none
 */
--- a/components/dp/core/src/wlan_dp_fisa_rx.c
+++ b/components/dp/core/src/wlan_dp_fisa_rx.c
@@ -155,6 +155,8 @@ static void nbuf_skip_rx_pkt_tlv(struct dp_soc *soc, qdf_nbuf_t nbuf)
 /**
 * print_flow_tuple() - Debug function to dump flow tuple
 * @flow_tuple: flow tuple containing tuple info
+ * @str: destination buffer
+ * @size: size of @str
 *
 * Return: NONE
 */
@@ -339,6 +341,7 @@ static void dp_rx_fisa_record_ft_lock_event(uint8_t reo_id, const char *func,
 * __dp_rx_fisa_acquire_ft_lock() - Acquire lock which protects SW FT entries
 * @fisa_hdl: Handle to fisa context
 * @reo_id: REO ID
+ * @func: calling function name
 *
 * Return: None
 */
@@ -357,6 +360,7 @@ __dp_rx_fisa_acquire_ft_lock(struct dp_rx_fst *fisa_hdl,
 * __dp_rx_fisa_release_ft_lock() - Release lock which protects SW FT entries
 * @fisa_hdl: Handle to fisa context
 * @reo_id: REO ID
+ * @func: calling function name
 *
 * Return: None
 */
@@ -453,6 +457,7 @@ dp_rx_fisa_setup_cmem_fse(struct dp_rx_fst *fisa_hdl, uint32_t hashed_flow_idx,
 * @sw_ft_entry: Pointer to softerware flow table entry
 * @flow_hash: flow_hash for the flow
 * @vdev: Saving dp_vdev in FT later used in the flushing the flow
+ * @soc_hdl: HAL soc handle
 * @flow_id: Flow ID of the flow
 *
 * Return: NONE
@@ -667,8 +672,9 @@ static bool is_flow_idx_valid(bool flow_invalid, bool flow_timeout)

 #ifdef WLAN_SUPPORT_RX_FISA_HIST
 /**
- * dp_rx_fisa_get_pkt_hist() - Get ptr to pkt history from rx sw ft entry
+ * dp_rx_fisa_save_pkt_hist() - Save pkt history from rx sw ft entry
 * @ft_entry: sw ft entry
+ * @pkt_hist: pkt history ptr
 *
 * Return: None
 */
@@ -681,7 +687,7 @@ dp_rx_fisa_save_pkt_hist(struct dp_fisa_rx_sw_ft *ft_entry,
 }

 /**
- * dp_rx_fisa_set_pkt_hist() - Set rx sw ft entry pkt history
+ * dp_rx_fisa_restore_pkt_hist() - Restore rx sw ft entry pkt history
 * @ft_entry: sw ft entry
 * @pkt_hist: pkt history ptr
 *
@@ -1268,7 +1274,8 @@ dp_rx_fisa_aggr_tcp(struct dp_rx_fst *fisa_hdl,
 /**
 * get_transport_payload_offset() - Get offset to payload
 * @fisa_hdl: Handle to FISA context
- * @rx_tlv_hdr: TLV hdr pointer
+ * @l3_hdr_offset: layer 3 header offset
+ * @l4_hdr_offset: layer 4 header offset
 *
 * Return: Offset value to transport payload
 */
@@ -1283,7 +1290,8 @@ static inline int get_transport_payload_offset(struct dp_rx_fst *fisa_hdl,
 /**
 * get_transport_header_offset() - Get transport header offset
 * @fisa_flow: Handle to FISA sw flow entry
- * @rx_tlv_hdr: TLV hdr pointer
+ * @l3_hdr_offset: layer 3 header offset
+ * @l4_hdr_offset: layer 4 header offset
 *
 * Return: Offset value to transport header
 */
@@ -1299,6 +1307,7 @@ int get_transport_header_offset(struct dp_fisa_rx_sw_ft *fisa_flow,

 /**
 * dp_rx_fisa_aggr_udp() - Aggregate incoming to UDP nbuf
+ * @fisa_hdl: Handle fisa context
 * @fisa_flow: Handle to SW flow entry, which holds the aggregated nbuf
 * @nbuf: Incoming nbuf
 *
@@ -1609,7 +1618,7 @@ dp_rx_fisa_flush_tcp_flow(struct dp_vdev *vdev,
 /**
 * dp_rx_fisa_flush_flow() - Flush all aggregated nbuf of the flow
 * @vdev: handle to dp_vdev
- * @fisa_flow: Flow for which aggregates to be flushed
+ * @flow: Flow for which aggregates to be flushed
 *
 * Return: None
 */
@@ -1632,7 +1641,7 @@ static void dp_rx_fisa_flush_flow(struct dp_vdev *vdev,
 * @rx_tlv_hdr: current msdu RX PKT TLV
 *
 * Return: true - current flow aggregation should stop,
-	   false - continue to aggregate.
+ *	   false - continue to aggregate.
 */
 static bool dp_fisa_aggregation_should_stop(
 				struct dp_fisa_rx_sw_ft *fisa_flow,
--- a/components/dp/core/src/wlan_dp_fisa_rx.h
+++ b/components/dp/core/src/wlan_dp_fisa_rx.h
@@ -95,7 +95,7 @@ QDF_STATUS dp_rx_dump_fisa_stats(struct dp_soc *soc);
 *
 * Return: QDF_STATUS
 */
-QDF_STATUS dp_fisa_rx(struct dp_soc *dp_fisa_rx_hdl, struct dp_vdev *vdev,
+QDF_STATUS dp_fisa_rx(struct dp_soc *soc, struct dp_vdev *vdev,
 		      qdf_nbuf_t nbuf_list);

 /**
--- a/components/dp/core/src/wlan_dp_main.c
+++ b/components/dp/core/src/wlan_dp_main.c
@@ -231,7 +231,7 @@ void dp_wait_complete_tasks(struct wlan_dp_psoc_context *dp_ctx)

 #ifdef CONFIG_DP_TRACE
 /**
- * dp_convert_string_to_u8_array() - used to convert string into u8 array
+ * dp_convert_string_to_array() - used to convert string into u8 array
 * @str: String to be converted
 * @array: Array where converted value is stored
 * @len: Length of the populated array
@@ -1646,7 +1646,7 @@ dp_direct_link_refill_ring_init(struct dp_direct_link_context *direct_link_ctx)
 /**
 * dp_direct_link_refill_ring_deinit() - De-initialize refill ring that would be
 *  used for Direct Link DP
- * @direct_link_ctx: DP Direct Link context
+ * @dlink_ctx: DP Direct Link context
 *
 * Return: None
 */
--- a/components/dp/core/src/wlan_dp_nud_tracking.c
+++ b/components/dp/core/src/wlan_dp_nud_tracking.c
@@ -334,7 +334,7 @@ static void dp_nud_process_failure_event(struct wlan_dp_intf *dp_intf)

 /**
 * dp_nud_filter_netevent() - filter netevents for STA interface
- * @neighbour: Pointer to neighbour
+ * @netdev_addr: Pointer to neighbour
 * @gw_mac_addr: Gateway MAC address
 * @nud_state: Current NUD state
 *
--- a/components/dp/core/src/wlan_dp_prealloc.c
+++ b/components/dp/core/src/wlan_dp_prealloc.c
@@ -79,7 +79,7 @@ struct dp_consistent_prealloc {

 /**
 * struct dp_multi_page_prealloc -  element representing DP pre-alloc multiple
-				    pages memory
+ *				    pages memory
 * @desc_type: source descriptor type for memory allocation
 * @element_size: single element size
 * @element_num: total number of elements should be allocated
@@ -98,7 +98,7 @@ struct dp_multi_page_prealloc {

 /**
 * struct dp_consistent_prealloc_unaligned - element representing DP pre-alloc
-					     unaligned memory
+ *					     unaligned memory
 * @ring_type: HAL ring type
 * @size: size of pre-alloc memory
 * @in_use: whether this element is in use (occupied)