xref: /wlan-dirver/qca-wifi-host-cmn/dp/wifi3.0/dp_tx_flow_control.c (revision 4865edfd190c086bbe2c69aae12a8226f877b91e)
1 /*
2  * Copyright (c) 2015-2018 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <cds_api.h>
20 
21 /* OS abstraction libraries */
22 #include <qdf_nbuf.h>           /* qdf_nbuf_t, etc. */
23 #include <qdf_atomic.h>         /* qdf_atomic_read, etc. */
24 #include <qdf_util.h>           /* qdf_unlikely */
25 #include "dp_types.h"
26 #include "dp_tx_desc.h"
27 
28 #include <cdp_txrx_handle.h>
29 #include "dp_internal.h"
30 #define INVALID_FLOW_ID 0xFF
31 #define MAX_INVALID_BIN 3
32 
33 /**
34  * dp_tx_dump_flow_pool_info() - dump global_pool and flow_pool info
35  *
36  * @ctx: Handle to struct dp_soc.
37  *
38  * Return: none
39  */
40 void dp_tx_dump_flow_pool_info(void *ctx)
41 {
42 	struct dp_soc *soc = ctx;
43 	struct dp_txrx_pool_stats *pool_stats = &soc->pool_stats;
44 	struct dp_tx_desc_pool_s *pool = NULL;
45 	struct dp_tx_desc_pool_s tmp_pool;
46 	int i;
47 
48 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
49 		"No of pool map received %d", pool_stats->pool_map_count);
50 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
51 		"No of pool unmap received %d",	pool_stats->pool_unmap_count);
52 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
53 		"Pkt dropped due to unavailablity of pool %d",
54 		pool_stats->pkt_drop_no_pool);
55 
56 	/*
57 	 * Nested spin lock.
58 	 * Always take in below order.
59 	 * flow_pool_array_lock -> flow_pool_lock
60 	 */
61 	qdf_spin_lock_bh(&soc->flow_pool_array_lock);
62 	for (i = 0; i < MAX_TXDESC_POOLS; i++) {
63 		pool = &soc->tx_desc[i];
64 		if (pool->status > FLOW_POOL_INVALID)
65 			continue;
66 		qdf_spin_lock_bh(&pool->flow_pool_lock);
67 		qdf_mem_copy(&tmp_pool, pool, sizeof(tmp_pool));
68 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
69 		qdf_spin_unlock_bh(&soc->flow_pool_array_lock);
70 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR, "\n");
71 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
72 			"Flow_pool_id %d :: status %d",
73 			tmp_pool.flow_pool_id, tmp_pool.status);
74 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
75 			"Total %d :: Available %d",
76 			tmp_pool.pool_size, tmp_pool.avail_desc);
77 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
78 			"Start threshold %d :: Stop threshold %d",
79 			 tmp_pool.start_th, tmp_pool.stop_th);
80 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
81 			"Member flow_id  %d :: flow_type %d",
82 			tmp_pool.flow_pool_id, tmp_pool.flow_type);
83 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
84 			"Pkt dropped due to unavailablity of descriptors %d",
85 			tmp_pool.pkt_drop_no_desc);
86 		qdf_spin_lock_bh(&soc->flow_pool_array_lock);
87 	}
88 	qdf_spin_unlock_bh(&soc->flow_pool_array_lock);
89 }
90 
91 /**
92  * dp_tx_clear_flow_pool_stats() - clear flow pool statistics
93  *
94  * @soc: Handle to struct dp_soc.
95  *
96  * Return: None
97  */
98 void dp_tx_clear_flow_pool_stats(struct dp_soc *soc)
99 {
100 
101 	if (!soc) {
102 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
103 			"%s: soc is null\n", __func__);
104 		return;
105 	}
106 	qdf_mem_zero(&soc->pool_stats, sizeof(soc->pool_stats));
107 }
108 
109 /**
110  * dp_tx_create_flow_pool() - create flow pool
111  * @soc: Handle to struct dp_soc
112  * @flow_pool_id: flow pool id
113  * @flow_pool_size: flow pool size
114  *
115  * Return: flow_pool pointer / NULL for error
116  */
117 struct dp_tx_desc_pool_s *dp_tx_create_flow_pool(struct dp_soc *soc,
118 	uint8_t flow_pool_id, uint16_t flow_pool_size)
119 {
120 	struct dp_tx_desc_pool_s *pool;
121 	uint32_t stop_threshold;
122 	uint32_t start_threshold;
123 
124 	if (!soc) {
125 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
126 		   "%s: soc is NULL\n", __func__);
127 		return NULL;
128 	}
129 	pool = &soc->tx_desc[flow_pool_id];
130 	qdf_spin_lock_bh(&pool->flow_pool_lock);
131 	if (pool->status == FLOW_POOL_INVALID) {
132 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
133 		   "%s: flow pool already allocated\n", __func__);
134 		if (pool->avail_desc > pool->start_th)
135 			pool->status = FLOW_POOL_ACTIVE_UNPAUSED;
136 		else
137 			pool->status = FLOW_POOL_ACTIVE_PAUSED;
138 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
139 		return pool;
140 	}
141 
142 	if (dp_tx_desc_pool_alloc(soc, flow_pool_id, flow_pool_size)) {
143 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
144 		return NULL;
145 	}
146 
147 	stop_threshold = wlan_cfg_get_tx_flow_stop_queue_th(soc->wlan_cfg_ctx);
148 	start_threshold = stop_threshold +
149 		wlan_cfg_get_tx_flow_start_queue_offset(soc->wlan_cfg_ctx);
150 
151 	pool->flow_pool_id = flow_pool_id;
152 	pool->pool_size = flow_pool_size;
153 	pool->avail_desc = flow_pool_size;
154 	pool->status = FLOW_POOL_ACTIVE_UNPAUSED;
155 	/* INI is in percentage so divide by 100 */
156 	pool->start_th = (start_threshold * flow_pool_size)/100;
157 	pool->stop_th = (stop_threshold * flow_pool_size)/100;
158 
159 	qdf_spin_unlock_bh(&pool->flow_pool_lock);
160 
161 	return pool;
162 }
163 
164 /**
165  * dp_tx_delete_flow_pool() - delete flow pool
166  * @soc: Handle to struct dp_soc
167  * @pool: flow pool pointer
168  * @force: free pool forcefully
169  *
170  * Delete flow_pool if all tx descriptors are available.
171  * Otherwise put it in FLOW_POOL_INVALID state.
172  * If force is set then pull all available descriptors to
173  * global pool.
174  *
175  * Return: 0 for success or error
176  */
177 int dp_tx_delete_flow_pool(struct dp_soc *soc, struct dp_tx_desc_pool_s *pool,
178 	bool force)
179 {
180 	if (!soc || !pool) {
181 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
182 		   "%s: pool or soc is NULL\n", __func__);
183 		QDF_ASSERT(0);
184 		return ENOMEM;
185 	}
186 
187 	qdf_spin_lock_bh(&pool->flow_pool_lock);
188 	if (pool->avail_desc < pool->pool_size) {
189 		pool->status = FLOW_POOL_INVALID;
190 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
191 		return EAGAIN;
192 	}
193 
194 	/* We have all the descriptors for the pool, we can delete the pool */
195 	dp_tx_desc_pool_free(soc, pool->flow_pool_id);
196 	qdf_spin_unlock_bh(&pool->flow_pool_lock);
197 	return 0;
198 }
199 
200 /**
201  * dp_tx_flow_pool_vdev_map() - Map flow_pool with vdev
202  * @pdev: Handle to struct dp_pdev
203  * @pool: flow_pool
204  * @vdev_id: flow_id /vdev_id
205  *
206  * Return: none
207  */
208 static void dp_tx_flow_pool_vdev_map(struct dp_pdev *pdev,
209 	struct dp_tx_desc_pool_s *pool, uint8_t vdev_id)
210 {
211 	struct dp_vdev *vdev;
212 	struct dp_soc *soc = pdev->soc;
213 
214 	vdev = (struct dp_vdev *)cdp_get_vdev_from_vdev_id((void *)soc,
215 					(struct cdp_pdev *)pdev, vdev_id);
216 	if (!vdev) {
217 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
218 		   "%s: invalid vdev_id %d\n",
219 		   __func__, vdev_id);
220 		return;
221 	}
222 
223 	vdev->pool = pool;
224 	qdf_spin_lock_bh(&pool->flow_pool_lock);
225 	pool->pool_owner_ctx = soc;
226 	pool->flow_pool_id = vdev_id;
227 	qdf_spin_unlock_bh(&pool->flow_pool_lock);
228 }
229 
230 /**
231  * dp_tx_flow_pool_vdev_unmap() - Unmap flow_pool from vdev
232  * @pdev: Handle to struct dp_pdev
233  * @pool: flow_pool
234  * @vdev_id: flow_id /vdev_id
235  *
236  * Return: none
237  */
238 static void dp_tx_flow_pool_vdev_unmap(struct dp_pdev *pdev,
239 		struct dp_tx_desc_pool_s *pool, uint8_t vdev_id)
240 {
241 	struct dp_vdev *vdev;
242 	struct dp_soc *soc = pdev->soc;
243 
244 	vdev = (struct dp_vdev *)cdp_get_vdev_from_vdev_id((void *)soc,
245 					(struct cdp_pdev *)pdev, vdev_id);
246 	if (!vdev) {
247 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
248 		   "%s: invalid vdev_id %d\n",
249 		   __func__, vdev_id);
250 		return;
251 	}
252 
253 	vdev->pool = NULL;
254 }
255 
256 /**
257  * dp_tx_flow_pool_map_handler() - Map flow_id with pool of descriptors
258  * @pdev: Handle to struct dp_pdev
259  * @flow_id: flow id
260  * @flow_type: flow type
261  * @flow_pool_id: pool id
262  * @flow_pool_size: pool size
263  *
264  * Process below target to host message
265  * HTT_T2H_MSG_TYPE_FLOW_POOL_MAP
266  *
267  * Return: none
268  */
269 QDF_STATUS dp_tx_flow_pool_map_handler(struct dp_pdev *pdev, uint8_t flow_id,
270 	uint8_t flow_type, uint8_t flow_pool_id, uint16_t flow_pool_size)
271 {
272 	struct dp_soc *soc = pdev->soc;
273 	struct dp_tx_desc_pool_s *pool;
274 	enum htt_flow_type type = flow_type;
275 
276 
277 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_INFO,
278 		"%s: flow_id %d flow_type %d flow_pool_id %d flow_pool_size %d\n",
279 		__func__, flow_id, flow_type, flow_pool_id, flow_pool_size);
280 
281 	if (qdf_unlikely(!soc)) {
282 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
283 			"%s: soc is NULL", __func__);
284 		return QDF_STATUS_E_FAULT;
285 	}
286 	soc->pool_stats.pool_map_count++;
287 
288 	pool = dp_tx_create_flow_pool(soc, flow_pool_id,
289 			flow_pool_size);
290 	if (pool == NULL) {
291 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
292 			   "%s: creation of flow_pool %d size %d failed\n",
293 			   __func__, flow_pool_id, flow_pool_size);
294 		return QDF_STATUS_E_RESOURCES;
295 	}
296 
297 	switch (type) {
298 
299 	case FLOW_TYPE_VDEV:
300 		dp_tx_flow_pool_vdev_map(pdev, pool, flow_id);
301 		break;
302 	default:
303 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
304 		   "%s: flow type %d not supported !!!\n",
305 		   __func__, type);
306 		break;
307 	}
308 
309 	return QDF_STATUS_SUCCESS;
310 }
311 
312 /**
313  * dp_tx_flow_pool_unmap_handler() - Unmap flow_id from pool of descriptors
314  * @pdev: Handle to struct dp_pdev
315  * @flow_id: flow id
316  * @flow_type: flow type
317  * @flow_pool_id: pool id
318  *
319  * Process below target to host message
320  * HTT_T2H_MSG_TYPE_FLOW_POOL_UNMAP
321  *
322  * Return: none
323  */
324 void dp_tx_flow_pool_unmap_handler(struct dp_pdev *pdev, uint8_t flow_id,
325 	uint8_t flow_type, uint8_t flow_pool_id)
326 {
327 	struct dp_soc *soc = pdev->soc;
328 	struct dp_tx_desc_pool_s *pool;
329 	enum htt_flow_type type = flow_type;
330 
331 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_INFO,
332 		"%s: flow_id %d flow_type %d flow_pool_id %d\n",
333 		__func__, flow_id, flow_type, flow_pool_id);
334 
335 	if (qdf_unlikely(!pdev)) {
336 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
337 			"%s: pdev is NULL", __func__);
338 		return;
339 	}
340 	soc->pool_stats.pool_unmap_count++;
341 
342 	pool = &soc->tx_desc[flow_pool_id];
343 	if (!pool) {
344 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
345 		   "%s: flow_pool not available flow_pool_id %d\n",
346 		   __func__, type);
347 		return;
348 	}
349 
350 	switch (type) {
351 
352 	case FLOW_TYPE_VDEV:
353 		dp_tx_flow_pool_vdev_unmap(pdev, pool, flow_id);
354 		break;
355 	default:
356 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
357 		   "%s: flow type %d not supported !!!\n",
358 		   __func__, type);
359 		return;
360 	}
361 
362 	/* only delete if all descriptors are available */
363 	dp_tx_delete_flow_pool(soc, pool, false);
364 }
365 
366 /**
367  * dp_tx_flow_control_init() - Initialize tx flow control
368  * @tx_desc_pool: Handle to flow_pool
369  *
370  * Return: none
371  */
372 void dp_tx_flow_control_init(struct dp_soc *soc)
373 {
374 	qdf_spinlock_create(&soc->flow_pool_array_lock);
375 }
376 
377 /**
378  * dp_tx_flow_control_deinit() - Deregister fw based tx flow control
379  * @tx_desc_pool: Handle to flow_pool
380  *
381  * Return: none
382  */
383 void dp_tx_flow_control_deinit(struct dp_soc *soc)
384 {
385 	qdf_spinlock_destroy(&soc->flow_pool_array_lock);
386 }
387 
388 /**
389  * dp_txrx_register_pause_cb() - Register pause callback
390  * @ctx: Handle to struct dp_soc
391  * @pause_cb: Tx pause_cb
392  *
393  * Return: none
394  */
395 QDF_STATUS dp_txrx_register_pause_cb(struct cdp_soc_t *handle,
396 	tx_pause_callback pause_cb)
397 {
398 	struct dp_soc *soc = (struct dp_soc *)handle;
399 
400 	if (!soc || !pause_cb) {
401 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
402 			FL("soc or pause_cb is NULL"));
403 		return QDF_STATUS_E_INVAL;
404 	}
405 	soc->pause_cb = pause_cb;
406 
407 	return QDF_STATUS_SUCCESS;
408 }
409 
410 QDF_STATUS dp_tx_flow_pool_map(struct cdp_soc_t *handle, struct cdp_pdev *pdev,
411 				uint8_t vdev_id)
412 {
413 	struct dp_soc *soc = (struct dp_soc *)handle;
414 	int tx_ring_size = wlan_cfg_tx_ring_size(soc->wlan_cfg_ctx);
415 
416 	return (dp_tx_flow_pool_map_handler((struct dp_pdev *)pdev, vdev_id,
417 				FLOW_TYPE_VDEV,	vdev_id, tx_ring_size));
418 }
419 
420 void dp_tx_flow_pool_unmap(struct cdp_soc_t *soc, struct cdp_pdev *pdev,
421 			   uint8_t vdev_id)
422 {
423 	return(dp_tx_flow_pool_unmap_handler((struct dp_pdev *)pdev, vdev_id,
424 				FLOW_TYPE_VDEV, vdev_id));
425 }
426