Эх сурвалжийг харах

qcacmn: Fix dp/wifi3.0/li documentation

The kernel-doc script identified a large number of documentation
issues in dp/wifi3.0/li, so fix those issues. In addition, there are a
number of instances where public functions have their implementation
documented instead of having their interface documented, so move that
documentation.

Change-Id: I38f98ebaa5373338cdff68dbde5c0d66780413c2
CRs-Fixed: 3373156
Jeff Johnson 2 жил өмнө
parent
commit
4f341433ba

+ 3 - 3
dp/wifi3.0/li/dp_li.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 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
@@ -62,7 +62,7 @@ struct dp_peer_li {
 };
 
 /**
- * dp_get_soc_context_size_LI() - get context size for dp_soc_li
+ * dp_get_soc_context_size_li() - get context size for dp_soc_li
  *
  * Return: value in bytes for LI specific soc structure
  */
@@ -78,7 +78,7 @@ void dp_initialize_arch_ops_li(struct dp_arch_ops *arch_ops);
 
 /**
  * dp_get_context_size_li() - get LI specific size for peer/vdev/pdev/soc
- * @arch_ops: arch ops pointer
+ * @context_type: DP context type for which the size is needed
  *
  * Return: size in bytes for the context_type
  */

+ 2 - 15
dp/wifi3.0/li/dp_li_rx.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 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
@@ -61,7 +61,7 @@ bool is_sa_da_idx_valid(uint32_t max_ast,
 /**
  * dp_rx_mec_check_wrapper() - wrapper to dp_rx_mcast_echo_check
  * @soc: core DP main context
- * @peer: dp peer handler
+ * @txrx_peer: dp peer handler
  * @rx_tlv_hdr: start of the rx TLV header
  * @nbuf: pkt buffer
  *
@@ -188,19 +188,6 @@ dp_rx_intrabss_fwd_li(struct dp_soc *soc,
 }
 #endif
 
-/**
- * dp_rx_process_li() - Brain of the Rx processing functionality
- *		     Called from the bottom half (tasklet/NET_RX_SOFTIRQ)
- * @int_ctx: per interrupt context
- * @hal_ring: opaque pointer to the HAL Rx Ring, which will be serviced
- * @reo_ring_num: ring number (0, 1, 2 or 3) of the reo ring.
- * @quota: No. of units (packets) that can be serviced in one shot.
- *
- * This function implements the core of Rx functionality. This is
- * expected to handle only non-error frames.
- *
- * Return: uint32_t: No. of elements processed
- */
 uint32_t dp_rx_process_li(struct dp_intr *int_ctx,
 			  hal_ring_handle_t hal_ring_hdl, uint8_t reo_ring_num,
 			  uint32_t quota)

+ 16 - 2
dp/wifi3.0/li/dp_li_rx.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 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
@@ -24,6 +24,19 @@
 #include <dp_rx.h>
 #include "dp_li.h"
 
+/**
+ * dp_rx_process_li() - Brain of the Rx processing functionality
+ *		     Called from the bottom half (tasklet/NET_RX_SOFTIRQ)
+ * @int_ctx: per interrupt context
+ * @hal_ring_hdl: opaque pointer to the HAL Rx Ring, which will be serviced
+ * @reo_ring_num: ring number (0, 1, 2 or 3) of the reo ring.
+ * @quota: No. of units (packets) that can be serviced in one shot.
+ *
+ * This function implements the core of Rx functionality. This is
+ * expected to handle only non-error frames.
+ *
+ * Return: uint32_t: No. of elements processed
+ */
 uint32_t dp_rx_process_li(struct dp_intr *int_ctx,
 			  hal_ring_handle_t hal_ring_hdl, uint8_t reo_ring_num,
 			  uint32_t quota);
@@ -202,7 +215,8 @@ void *dp_rx_cookie_2_va_rxdma_buf_prefetch(struct dp_soc *soc, uint32_t cookie)
 
 /**
  * dp_rx_prefetch_hw_sw_nbuf_desc() - function to prefetch HW and SW desc
- * @soc: Handle to HAL Soc structure
+ * @soc: Handle to DP Soc structure
+ * @hal_soc: Handle to HAL Soc structure
  * @num_entries: valid number of HW descriptors
  * @hal_ring_hdl: Destination ring pointer
  * @last_prefetched_hw_desc: pointer to the last prefetched HW descriptor

+ 8 - 7
dp/wifi3.0/li/dp_li_tx.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 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
@@ -260,12 +260,12 @@ release_tx_desc:
 }
 
 #ifdef QCA_OL_TX_MULTIQ_SUPPORT
-/*
- * dp_tx_get_rbm_id()- Get the RBM ID for data transmission completion.
- * @dp_soc - DP soc structure pointer
- * @ring_id - Transmit Queue/ring_id to be used when XPS is enabled
+/**
+ * dp_tx_get_rbm_id_li() - Get the RBM ID for data transmission completion.
+ * @soc: DP soc structure pointer
+ * @ring_id: Transmit Queue/ring_id to be used when XPS is enabled
  *
- * Return - HAL ring handle
+ * Return: HAL ring handle
  */
 #ifdef IPA_OFFLOAD
 static inline uint8_t dp_tx_get_rbm_id_li(struct dp_soc *soc,
@@ -373,7 +373,8 @@ QDF_STATUS dp_tx_compute_hw_delay_li(struct dp_soc *soc,
  * dp_sawf_config_li - Configure sawf specific fields in tcl
  *
  * @soc: DP soc handle
- * @hhal_tx_desc_cached: tx descriptor
+ * @hal_tx_desc_cached: tx descriptor
+ * @fw_metadata: firmware metadata
  * @vdev_id: vdev id
  * @nbuf: skb buffer
  *

+ 3 - 4
dp/wifi3.0/li/dp_li_tx.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 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
@@ -26,10 +26,9 @@
  * @soc: DP Soc Handle
  * @vdev: DP vdev handle
  * @tx_desc: Tx Descriptor Handle
- * @tid: TID from HLOS for overriding default DSCP-TID mapping
  * @fw_metadata: Metadata to send to Target Firmware along with frame
- * @ring_id: Ring ID of H/W ring to which we enqueue the packet
  * @tx_exc_metadata: Handle that holds exception path meta data
+ * @msdu_info: MSDU information
  *
  *  Gets the next free TCL HW DMA descriptor and sets up required parameters
  *  from software Tx descriptor
@@ -58,7 +57,7 @@ void dp_tx_comp_get_params_from_hal_desc_li(struct dp_soc *soc,
  * dp_tx_process_htt_completion_li() - Tx HTT Completion Indication Handler
  * @soc: Handle to DP soc structure
  * @tx_desc: software descriptor head pointer
- * @status : Tx completion status from HTT descriptor
+ * @status: Tx completion status from HTT descriptor
  * @ring_id: ring number
  *
  * This function will process HTT Tx indication messages from Target