xref: /wlan-driver/qca-wifi-host-cmn/dp/wifi3.0/li/dp_li_tx.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
3  * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 #ifndef __DP_LI_TX_H
20 #define __DP_LI_TX_H
21 
22 #include <dp_types.h>
23 
24 /**
25  * dp_tx_hw_enqueue_li() - Enqueue to TCL HW for transmit
26  * @soc: DP Soc Handle
27  * @vdev: DP vdev handle
28  * @tx_desc: Tx Descriptor Handle
29  * @fw_metadata: Metadata to send to Target Firmware along with frame
30  * @tx_exc_metadata: Handle that holds exception path meta data
31  * @msdu_info: MSDU information
32  *
33  *  Gets the next free TCL HW DMA descriptor and sets up required parameters
34  *  from software Tx descriptor
35  *
36  * Return: QDF_STATUS_SUCCESS: success
37  *         QDF_STATUS_E_RESOURCES: Error return
38  */
39 QDF_STATUS
40 dp_tx_hw_enqueue_li(struct dp_soc *soc, struct dp_vdev *vdev,
41 		    struct dp_tx_desc_s *tx_desc, uint16_t fw_metadata,
42 		    struct cdp_tx_exception_metadata *tx_exc_metadata,
43 		    struct dp_tx_msdu_info_s *msdu_info);
44 /**
45  * dp_tx_comp_get_params_from_hal_desc_li() - Get TX desc from HAL comp desc
46  * @soc: DP soc handle
47  * @tx_comp_hal_desc: HAL TX Comp Descriptor
48  * @r_tx_desc: SW Tx Descriptor retrieved from HAL desc.
49  *
50  * Return: QDF_STATUS
51  */
52 QDF_STATUS
53 dp_tx_comp_get_params_from_hal_desc_li(struct dp_soc *soc,
54 				       void *tx_comp_hal_desc,
55 				       struct dp_tx_desc_s **r_tx_desc);
56 
57 /**
58  * dp_tx_process_htt_completion_li() - Tx HTT Completion Indication Handler
59  * @soc: Handle to DP soc structure
60  * @tx_desc: software descriptor head pointer
61  * @status: Tx completion status from HTT descriptor
62  * @ring_id: ring number
63  *
64  * This function will process HTT Tx indication messages from Target
65  *
66  * Return: none
67  */
68 void dp_tx_process_htt_completion_li(struct dp_soc *soc,
69 				     struct dp_tx_desc_s *tx_desc,
70 				     uint8_t *status,
71 				     uint8_t ring_id);
72 
73 /**
74  * dp_tx_desc_pool_init_li() - Initialize Tx Descriptor pool(s)
75  * @soc: Handle to DP Soc structure
76  * @num_elem: pool descriptor number
77  * @pool_id: pool to allocate
78  * @spcl_tx_desc: if special desc
79  *
80  * Return: QDF_STATUS_SUCCESS - success, others - failure
81  */
82 QDF_STATUS dp_tx_desc_pool_init_li(struct dp_soc *soc,
83 				   uint32_t num_elem,
84 				   uint8_t pool_id,
85 				   bool spcl_tx_desc);
86 
87 /**
88  * dp_tx_desc_pool_deinit_li() - De-initialize Tx Descriptor pool(s)
89  * @soc: Handle to DP Soc structure
90  * @tx_desc_pool: Tx descriptor pool handler
91  * @pool_id: pool to deinit
92  * @spcl_tx_desc: if special desc
93  *
94  * Return: None.
95  */
96 void dp_tx_desc_pool_deinit_li(struct dp_soc *soc,
97 			       struct dp_tx_desc_pool_s *tx_desc_pool,
98 			       uint8_t pool_id, bool spcl_tx_desc);
99 
100 /**
101  * dp_tx_compute_tx_delay_li() - Compute HW Tx completion delay
102  * @soc: Handle to DP Soc structure
103  * @vdev: vdev
104  * @ts: Tx completion status
105  * @delay_us: Delay to be calculated in microseconds
106  *
107  * Return: QDF_STATUS
108  */
109 QDF_STATUS dp_tx_compute_tx_delay_li(struct dp_soc *soc,
110 				     struct dp_vdev *vdev,
111 				     struct hal_tx_completion_status *ts,
112 				     uint32_t *delay_us);
113 
114 /**
115  * dp_tx_desc_pool_alloc_li() - Allocate TX descriptor pool
116  * @soc: Handle to DP Soc structure
117  * @num_elem: Number of elements to allocate
118  * @pool_id: TCL descriptor pool ID
119  *
120  * Return: QDF_STATUS
121  */
122 QDF_STATUS dp_tx_desc_pool_alloc_li(struct dp_soc *soc, uint32_t num_elem,
123 				    uint8_t pool_id);
124 
125 /**
126  * dp_tx_desc_pool_free_li() - Free TX descriptor pool
127  * @soc: Handle to DP Soc structure
128  * @pool_id: TCL descriptor pool ID
129  *
130  * Return: none
131  */
132 void dp_tx_desc_pool_free_li(struct dp_soc *soc, uint8_t pool_id);
133 #endif
134