xref: /wlan-dirver/qca-wifi-host-cmn/dp/wifi3.0/dp_tx_flow_control.c (revision 1b9674e21e24478fba4530f5ae7396b9555e9c6a)
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", __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 (flow_pool_id >= MAX_TXDESC_POOLS) {
125 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
126 		   "%s: invalid flow_pool_id %d", __func__, flow_pool_id);
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_INACTIVE) || pool->pool_create_cnt) {
132 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
133 			"%s: flow pool already allocated, attached %d times",
134 			__func__, pool->pool_create_cnt);
135 		if (pool->avail_desc > pool->start_th)
136 			pool->status = FLOW_POOL_ACTIVE_UNPAUSED;
137 		else
138 			pool->status = FLOW_POOL_ACTIVE_PAUSED;
139 
140 		pool->pool_create_cnt++;
141 
142 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
143 		return pool;
144 	}
145 
146 	if (dp_tx_desc_pool_alloc(soc, flow_pool_id, flow_pool_size)) {
147 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
148 		return NULL;
149 	}
150 
151 	stop_threshold = wlan_cfg_get_tx_flow_stop_queue_th(soc->wlan_cfg_ctx);
152 	start_threshold = stop_threshold +
153 		wlan_cfg_get_tx_flow_start_queue_offset(soc->wlan_cfg_ctx);
154 
155 	pool->flow_pool_id = flow_pool_id;
156 	pool->pool_size = flow_pool_size;
157 	pool->avail_desc = flow_pool_size;
158 	pool->status = FLOW_POOL_ACTIVE_UNPAUSED;
159 	/* INI is in percentage so divide by 100 */
160 	pool->start_th = (start_threshold * flow_pool_size)/100;
161 	pool->stop_th = (stop_threshold * flow_pool_size)/100;
162 	pool->pool_create_cnt++;
163 
164 	qdf_spin_unlock_bh(&pool->flow_pool_lock);
165 
166 	return pool;
167 }
168 
169 /**
170  * dp_tx_delete_flow_pool() - delete flow pool
171  * @soc: Handle to struct dp_soc
172  * @pool: flow pool pointer
173  * @force: free pool forcefully
174  *
175  * Delete flow_pool if all tx descriptors are available.
176  * Otherwise put it in FLOW_POOL_INVALID state.
177  * If force is set then pull all available descriptors to
178  * global pool.
179  *
180  * Return: 0 for success or error
181  */
182 int dp_tx_delete_flow_pool(struct dp_soc *soc, struct dp_tx_desc_pool_s *pool,
183 	bool force)
184 {
185 	if (!soc || !pool) {
186 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
187 		   "%s: pool or soc is NULL", __func__);
188 		QDF_ASSERT(0);
189 		return ENOMEM;
190 	}
191 
192 	qdf_spin_lock_bh(&pool->flow_pool_lock);
193 	if (!pool->pool_create_cnt) {
194 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
195 			  "flow pool either not created or alread deleted");
196 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
197 		return -ENOENT;
198 	}
199 	pool->pool_create_cnt--;
200 	if (pool->pool_create_cnt) {
201 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
202 			  "%s: pool is still attached, pending detach %d",
203 			  __func__, pool->pool_create_cnt);
204 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
205 		return -EAGAIN;
206 	}
207 
208 	if (pool->avail_desc < pool->pool_size) {
209 		pool->status = FLOW_POOL_INVALID;
210 		qdf_spin_unlock_bh(&pool->flow_pool_lock);
211 		return -EAGAIN;
212 	}
213 
214 	/* We have all the descriptors for the pool, we can delete the pool */
215 	dp_tx_desc_pool_free(soc, pool->flow_pool_id);
216 	qdf_spin_unlock_bh(&pool->flow_pool_lock);
217 	return 0;
218 }
219 
220 /**
221  * dp_tx_flow_pool_vdev_map() - Map flow_pool with vdev
222  * @pdev: Handle to struct dp_pdev
223  * @pool: flow_pool
224  * @vdev_id: flow_id /vdev_id
225  *
226  * Return: none
227  */
228 static void dp_tx_flow_pool_vdev_map(struct dp_pdev *pdev,
229 	struct dp_tx_desc_pool_s *pool, uint8_t vdev_id)
230 {
231 	struct dp_vdev *vdev;
232 	struct dp_soc *soc = pdev->soc;
233 
234 	vdev = (struct dp_vdev *)cdp_get_vdev_from_vdev_id((void *)soc,
235 					(struct cdp_pdev *)pdev, vdev_id);
236 	if (!vdev) {
237 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
238 		   "%s: invalid vdev_id %d",
239 		   __func__, vdev_id);
240 		return;
241 	}
242 
243 	vdev->pool = pool;
244 	qdf_spin_lock_bh(&pool->flow_pool_lock);
245 	pool->pool_owner_ctx = soc;
246 	pool->flow_pool_id = vdev_id;
247 	qdf_spin_unlock_bh(&pool->flow_pool_lock);
248 }
249 
250 /**
251  * dp_tx_flow_pool_vdev_unmap() - Unmap flow_pool from vdev
252  * @pdev: Handle to struct dp_pdev
253  * @pool: flow_pool
254  * @vdev_id: flow_id /vdev_id
255  *
256  * Return: none
257  */
258 static void dp_tx_flow_pool_vdev_unmap(struct dp_pdev *pdev,
259 		struct dp_tx_desc_pool_s *pool, uint8_t vdev_id)
260 {
261 	struct dp_vdev *vdev;
262 	struct dp_soc *soc = pdev->soc;
263 
264 	vdev = (struct dp_vdev *)cdp_get_vdev_from_vdev_id((void *)soc,
265 					(struct cdp_pdev *)pdev, vdev_id);
266 	if (!vdev) {
267 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
268 		   "%s: invalid vdev_id %d",
269 		   __func__, vdev_id);
270 		return;
271 	}
272 
273 	vdev->pool = NULL;
274 }
275 
276 /**
277  * dp_tx_flow_pool_map_handler() - Map flow_id with pool of descriptors
278  * @pdev: Handle to struct dp_pdev
279  * @flow_id: flow id
280  * @flow_type: flow type
281  * @flow_pool_id: pool id
282  * @flow_pool_size: pool size
283  *
284  * Process below target to host message
285  * HTT_T2H_MSG_TYPE_FLOW_POOL_MAP
286  *
287  * Return: none
288  */
289 QDF_STATUS dp_tx_flow_pool_map_handler(struct dp_pdev *pdev, uint8_t flow_id,
290 	uint8_t flow_type, uint8_t flow_pool_id, uint16_t flow_pool_size)
291 {
292 	struct dp_soc *soc = pdev->soc;
293 	struct dp_tx_desc_pool_s *pool;
294 	enum htt_flow_type type = flow_type;
295 
296 
297 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_INFO,
298 		"%s: flow_id %d flow_type %d flow_pool_id %d flow_pool_size %d",
299 		__func__, flow_id, flow_type, flow_pool_id, flow_pool_size);
300 
301 	if (qdf_unlikely(!soc)) {
302 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
303 			"%s: soc is NULL", __func__);
304 		return QDF_STATUS_E_FAULT;
305 	}
306 	soc->pool_stats.pool_map_count++;
307 
308 	pool = dp_tx_create_flow_pool(soc, flow_pool_id,
309 			flow_pool_size);
310 	if (pool == NULL) {
311 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
312 			   "%s: creation of flow_pool %d size %d failed",
313 			   __func__, flow_pool_id, flow_pool_size);
314 		return QDF_STATUS_E_RESOURCES;
315 	}
316 
317 	switch (type) {
318 
319 	case FLOW_TYPE_VDEV:
320 		dp_tx_flow_pool_vdev_map(pdev, pool, flow_id);
321 		break;
322 	default:
323 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
324 		   "%s: flow type %d not supported !!!",
325 		   __func__, type);
326 		break;
327 	}
328 
329 	return QDF_STATUS_SUCCESS;
330 }
331 
332 /**
333  * dp_tx_flow_pool_unmap_handler() - Unmap flow_id from pool of descriptors
334  * @pdev: Handle to struct dp_pdev
335  * @flow_id: flow id
336  * @flow_type: flow type
337  * @flow_pool_id: pool id
338  *
339  * Process below target to host message
340  * HTT_T2H_MSG_TYPE_FLOW_POOL_UNMAP
341  *
342  * Return: none
343  */
344 void dp_tx_flow_pool_unmap_handler(struct dp_pdev *pdev, uint8_t flow_id,
345 	uint8_t flow_type, uint8_t flow_pool_id)
346 {
347 	struct dp_soc *soc = pdev->soc;
348 	struct dp_tx_desc_pool_s *pool;
349 	enum htt_flow_type type = flow_type;
350 
351 	QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_INFO,
352 		"%s: flow_id %d flow_type %d flow_pool_id %d",
353 		__func__, flow_id, flow_type, flow_pool_id);
354 
355 	if (qdf_unlikely(!pdev)) {
356 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
357 			"%s: pdev is NULL", __func__);
358 		return;
359 	}
360 	soc->pool_stats.pool_unmap_count++;
361 
362 	pool = &soc->tx_desc[flow_pool_id];
363 	if (!pool) {
364 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
365 		   "%s: flow_pool not available flow_pool_id %d",
366 		   __func__, type);
367 		return;
368 	}
369 
370 	switch (type) {
371 
372 	case FLOW_TYPE_VDEV:
373 		dp_tx_flow_pool_vdev_unmap(pdev, pool, flow_id);
374 		break;
375 	default:
376 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
377 		   "%s: flow type %d not supported !!!",
378 		   __func__, type);
379 		return;
380 	}
381 
382 	/* only delete if all descriptors are available */
383 	dp_tx_delete_flow_pool(soc, pool, false);
384 }
385 
386 /**
387  * dp_tx_flow_control_init() - Initialize tx flow control
388  * @tx_desc_pool: Handle to flow_pool
389  *
390  * Return: none
391  */
392 void dp_tx_flow_control_init(struct dp_soc *soc)
393 {
394 	qdf_spinlock_create(&soc->flow_pool_array_lock);
395 }
396 
397 /**
398  * dp_tx_flow_control_deinit() - Deregister fw based tx flow control
399  * @tx_desc_pool: Handle to flow_pool
400  *
401  * Return: none
402  */
403 void dp_tx_flow_control_deinit(struct dp_soc *soc)
404 {
405 	qdf_spinlock_destroy(&soc->flow_pool_array_lock);
406 }
407 
408 /**
409  * dp_txrx_register_pause_cb() - Register pause callback
410  * @ctx: Handle to struct dp_soc
411  * @pause_cb: Tx pause_cb
412  *
413  * Return: none
414  */
415 QDF_STATUS dp_txrx_register_pause_cb(struct cdp_soc_t *handle,
416 	tx_pause_callback pause_cb)
417 {
418 	struct dp_soc *soc = (struct dp_soc *)handle;
419 
420 	if (!soc || !pause_cb) {
421 		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_ERROR,
422 			FL("soc or pause_cb is NULL"));
423 		return QDF_STATUS_E_INVAL;
424 	}
425 	soc->pause_cb = pause_cb;
426 
427 	return QDF_STATUS_SUCCESS;
428 }
429 
430 QDF_STATUS dp_tx_flow_pool_map(struct cdp_soc_t *handle, struct cdp_pdev *pdev,
431 				uint8_t vdev_id)
432 {
433 	struct dp_soc *soc = (struct dp_soc *)handle;
434 	int tx_ring_size = wlan_cfg_tx_ring_size(soc->wlan_cfg_ctx);
435 
436 	return (dp_tx_flow_pool_map_handler((struct dp_pdev *)pdev, vdev_id,
437 				FLOW_TYPE_VDEV,	vdev_id, tx_ring_size));
438 }
439 
440 void dp_tx_flow_pool_unmap(struct cdp_soc_t *soc, struct cdp_pdev *pdev,
441 			   uint8_t vdev_id)
442 {
443 	return(dp_tx_flow_pool_unmap_handler((struct dp_pdev *)pdev, vdev_id,
444 				FLOW_TYPE_VDEV, vdev_id));
445 }
446