xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_types.h (revision dd5f5c1afa4ab969b68717be955752f19527fb17)
1 /*
2  * Copyright (c) 2014-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 
20 /**
21  * DOC: qdf_types.h
22  * QCA driver framework (QDF) basic type definitions
23  */
24 
25 #if !defined(__QDF_TYPES_H)
26 #define __QDF_TYPES_H
27 
28 #define qdf_must_check __qdf_must_check
29 
30 /* Include Files */
31 #include <i_qdf_types.h>
32 #ifdef TSOSEG_DEBUG
33 #include <qdf_atomic.h>
34 #endif
35 #include "qdf_status.h"
36 
37 /* Preprocessor definitions and constants */
38 #define QDF_MAX_SGLIST 4
39 
40 #define CPU_CLUSTER_TYPE_LITTLE 0
41 #define CPU_CLUSTER_TYPE_PERF 1
42 
43 /**
44  * struct qdf_sglist - scatter-gather list
45  * @nsegs: total number of segments
46  * @sg_segs: scatter-gather segment list
47  * @sg_segs.vaddr: Virtual address of the segment
48  * @sg_segs.len: Length of the segment
49  */
50 typedef struct qdf_sglist {
51 	uint32_t nsegs;
52 	struct __sg_segs {
53 		uint8_t  *vaddr;
54 		uint32_t len;
55 	} sg_segs[QDF_MAX_SGLIST];
56 } qdf_sglist_t;
57 
58 #define QDF_MAX_SCATTER __QDF_MAX_SCATTER
59 #define QDF_NSEC_PER_MSEC __QDF_NSEC_PER_MSEC
60 #define QDF_NSEC_PER_USEC __QDF_NSEC_PER_USEC
61 #define QDF_USEC_PER_MSEC __QDF_USEC_PER_MSEC
62 #define QDF_NSEC_PER_SEC __QDF_NSEC_PER_SEC
63 
64 /**
65  * QDF_SWAP_U16 - swap input u16 value
66  * @_x: variable to swap
67  */
68 #define QDF_SWAP_U16(_x) \
69 	((((_x) << 8) & 0xFF00) | (((_x) >> 8) & 0x00FF))
70 
71 /**
72  * QDF_SWAP_U32 - swap input u32 value
73  * @_x: variable to swap
74  */
75 #define QDF_SWAP_U32(_x) \
76 	(((((_x) << 24) & 0xFF000000) | (((_x) >> 24) & 0x000000FF)) | \
77 	 ((((_x) << 8) & 0x00FF0000) | (((_x) >> 8) & 0x0000FF00)))
78 
79 /* ticks per second */
80 #define QDF_TICKS_PER_SECOND (1000)
81 
82 /**
83  * QDF_ARRAY_SIZE - get array size
84  * @_arr: array variable name
85  */
86 #define QDF_ARRAY_SIZE(_arr) (sizeof(_arr) / sizeof((_arr)[0]))
87 
88 #define QDF_MAX_SCATTER __QDF_MAX_SCATTER
89 
90 /**
91  * qdf_packed - denotes structure is packed.
92  */
93 #define qdf_packed __qdf_packed
94 
95 /**
96  * qdf_toupper - char lower to upper.
97  */
98 #define qdf_toupper __qdf_toupper
99 
100 typedef void *qdf_net_handle_t;
101 
102 typedef void *qdf_netlink_handle_t;
103 typedef void *qdf_drv_handle_t;
104 typedef void *qdf_os_handle_t;
105 typedef void *qdf_pm_t;
106 
107 /*
108  * typedef qdf_handle_t - handles opaque to each other
109  */
110 typedef void *qdf_handle_t;
111 
112 /*
113  * typedef qdf_freq_t - define frequency as a 16 bit/32 bit
114  * unsigned integer depending on the requirement
115  */
116 #ifdef CONFIG_16_BIT_FREQ_TYPE
117 typedef uint16_t qdf_freq_t;
118 #else
119 typedef uint32_t qdf_freq_t;
120 #endif
121 
122 /**
123  * typedef qdf_device_t - Platform/bus generic handle.
124  * Used for bus specific functions.
125  */
126 typedef __qdf_device_t qdf_device_t;
127 
128 /* Byte order identifiers */
129 typedef __qdf_le16_t qdf_le16_t;
130 typedef __qdf_le32_t qdf_le32_t;
131 typedef __qdf_le64_t qdf_le64_t;
132 typedef __qdf_be16_t qdf_be16_t;
133 typedef __qdf_be32_t qdf_be32_t;
134 typedef __qdf_be64_t qdf_be64_t;
135 
136 /**
137  * typedef qdf_size_t - size of an object
138  */
139 typedef __qdf_size_t qdf_size_t;
140 
141 /**
142  * typedef qdf_off_t - offset for API's that need them.
143  */
144 typedef __qdf_off_t   qdf_off_t;
145 
146 /**
147  * typedef qdf_dma_map_t - DMA mapping object.
148  */
149 typedef __qdf_dma_map_t qdf_dma_map_t;
150 
151 /**
152  * typedef qdf_dma_addr_t - DMA address.
153  */
154 typedef __qdf_dma_addr_t qdf_dma_addr_t;
155 
156 /**
157  * typedef qdf_dma_size_t - DMA size.
158  */
159 typedef __qdf_dma_size_t qdf_dma_size_t;
160 
161 /**
162  * typedef qdf_dma_context_t - DMA context.
163  */
164 typedef __qdf_dma_context_t qdf_dma_context_t;
165 
166 typedef __qdf_mem_info_t qdf_mem_info_t;
167 typedef __sgtable_t sgtable_t;
168 
169 /**
170  * typedef qdf_cpu_mask - CPU Mask
171  */
172 typedef __qdf_cpu_mask qdf_cpu_mask;
173 
174 /*
175  * pointer to net device
176  */
177 typedef __qdf_netdev_t qdf_netdev_t;
178 
179 /*
180  * pointer to napi struct
181  */
182 typedef __qdf_napi_struct qdf_napi_struct;
183 
184 /*
185  * pointer to net dev stats
186  */
187 typedef __qdf_net_dev_stats qdf_net_dev_stats;
188 
189 /*
190  * pointer to dummy net device
191  */
192 typedef __qdf_dummy_netdev_t qdf_dummy_netdev_t;
193 
194 /**
195  * struct qdf_dma_map_info - Information inside a DMA map.
196  * @nsegs: total number mapped segments
197  * @dma_segs: list of segments
198  * @dma_segs.paddr: physical(dma'able) address of the segment
199  * @dma_segs.len: length of the segment
200  */
201 typedef struct qdf_dma_map_info {
202 	uint32_t nsegs;
203 	struct __dma_segs {
204 		qdf_dma_addr_t paddr;
205 		qdf_dma_size_t len;
206 	} dma_segs[QDF_MAX_SCATTER];
207 } qdf_dmamap_info_t;
208 
209 /*
210  * struct qdf_shared_mem - Shared memory resource
211  * @mem_info: memory info struct
212  * @vaddr: virtual address
213  * @sgtable: scatter-gather table
214  * @qdf_dma_mem_context: dma address
215  *
216  * NB: not using kernel-doc format since the kernel-doc script doesn't
217  *     handle the qdf_dma_mem_context() macro
218  */
219 typedef struct qdf_shared_mem {
220 	qdf_mem_info_t mem_info;
221 	void *vaddr;
222 	sgtable_t sgtable;
223 	qdf_dma_mem_context(memctx);
224 } qdf_shared_mem_t;
225 
226 #define qdf_iomem_t __qdf_iomem_t
227 
228 /**
229  * typedef QDF_TIMER_TYPE - QDF timer type
230  * @QDF_TIMER_TYPE_SW: Deferrable SW timer it will not cause CPU to wake up
231  * on expiry
232  * @QDF_TIMER_TYPE_WAKE_APPS: Non deferrable timer which will cause CPU to
233  * wake up on expiry
234  * @QDF_TIMER_TYPE_SW_SPIN: Deferrable&Pinned SW timer, it will not cause cpu
235  * to wake up on expiry and be able to queue on assigned cpu by add_timer_on
236  */
237 typedef enum {
238 	QDF_TIMER_TYPE_SW,
239 	QDF_TIMER_TYPE_WAKE_APPS,
240 	QDF_TIMER_TYPE_SW_SPIN
241 } QDF_TIMER_TYPE;
242 
243 /**
244  * typedef qdf_resource_type_t - hw resources
245  * @QDF_RESOURCE_TYPE_MEM: memory resource
246  * @QDF_RESOURCE_TYPE_IO: io resource
247  * Define the hw resources the OS has allocated for the device
248  * Note that start defines a mapped area.
249  */
250 typedef enum {
251 	QDF_RESOURCE_TYPE_MEM,
252 	QDF_RESOURCE_TYPE_IO,
253 } qdf_resource_type_t;
254 
255 /**
256  * typedef qdf_resource_t - representation of a h/w resource.
257  * @start: start
258  * @end: end
259  * @type: resource type
260  */
261 typedef struct {
262 	uint64_t start;
263 	uint64_t end;
264 	qdf_resource_type_t type;
265 } qdf_resource_t;
266 
267 /**
268  * typedef qdf_dma_dir_t - DMA directions
269  * @QDF_DMA_BIDIRECTIONAL: bidirectional data
270  * @QDF_DMA_TO_DEVICE: data going from device to memory
271  * @QDF_DMA_FROM_DEVICE: data going from memory to device
272  */
273 typedef enum {
274 	QDF_DMA_BIDIRECTIONAL = __QDF_DMA_BIDIRECTIONAL,
275 	QDF_DMA_TO_DEVICE = __QDF_DMA_TO_DEVICE,
276 	QDF_DMA_FROM_DEVICE = __QDF_DMA_FROM_DEVICE,
277 } qdf_dma_dir_t;
278 
279 /**
280  * enum qdf_driver_type - Indicate the driver type and based on this
281  * do appropriate initialization.
282  *
283  * @QDF_DRIVER_TYPE_PRODUCTION: Driver used in the production
284  * @QDF_DRIVER_TYPE_MFG: Driver used in the Factory
285  * @QDF_DRIVER_TYPE_INVALID: Invalid and unrecognized type
286  *
287  */
288 enum qdf_driver_type {
289 	QDF_DRIVER_TYPE_PRODUCTION = 0,
290 	QDF_DRIVER_TYPE_MFG = 1,
291 	QDF_DRIVER_TYPE_INVALID = 0x7FFFFFFF
292 };
293 
294 #ifdef DP_UMAC_HW_RESET_SUPPORT
295 typedef void (*qdf_mem_release_cb) (void *ctxt, void *elem, void *elem_list);
296 #endif
297 
298 /* work queue(kernel thread)/DPC function callback */
299 typedef void (*qdf_defer_fn_t)(void *);
300 
301 /*
302  * Prototype of the critical region function that is to be
303  * executed with spinlock held and interrupt disabled
304  */
305 typedef bool (*qdf_irqlocked_func_t)(void *);
306 
307 #define qdf_offsetof(type, field) offsetof(type, field)
308 
309 /**
310  * typedef QDF_MODULE_ID  - Debug category level
311  * @QDF_MODULE_ID_MIN: The smallest/starting module id
312  * @QDF_MODULE_ID_TDLS: TDLS
313  * @QDF_MODULE_ID_ACS: auto channel selection
314  * @QDF_MODULE_ID_SCAN_SM: scan state machine
315  * @QDF_MODULE_ID_SCANENTRY: scan entry
316  * @QDF_MODULE_ID_WDS: WDS handling
317  * @QDF_MODULE_ID_ACTION: action management frames
318  * @QDF_MODULE_ID_ROAM: sta mode roaming
319  * @QDF_MODULE_ID_INACT: inactivity handling
320  * @QDF_MODULE_ID_DOTH: 11.h
321  * @QDF_MODULE_ID_IQUE: IQUE features
322  * @QDF_MODULE_ID_WME: WME protocol
323  * @QDF_MODULE_ID_ACL: ACL handling
324  * @QDF_MODULE_ID_WPA: WPA/RSN protocol
325  * @QDF_MODULE_ID_RADKEYS: dump 802.1x keys
326  * @QDF_MODULE_ID_RADDUMP: dump 802.1x radius packets
327  * @QDF_MODULE_ID_RADIUS: 802.1x radius client
328  * @QDF_MODULE_ID_DOT1XSM: 802.1x state machine
329  * @QDF_MODULE_ID_DOT1X: 802.1x authenticator
330  * @QDF_MODULE_ID_POWER: power save handling
331  * @QDF_MODULE_ID_STATS: state machine
332  * @QDF_MODULE_ID_OUTPUT: output handling
333  * @QDF_MODULE_ID_SCAN: scanning
334  * @QDF_MODULE_ID_AUTH: authentication handling
335  * @QDF_MODULE_ID_ASSOC: association handling
336  * @QDF_MODULE_ID_NODE: node handling
337  * @QDF_MODULE_ID_ELEMID: element id parsing
338  * @QDF_MODULE_ID_XRATE: rate set handling
339  * @QDF_MODULE_ID_INPUT: input handling
340  * @QDF_MODULE_ID_CRYPTO: crypto work
341  * @QDF_MODULE_ID_DUMPPKTS: IFF_LINK2 equivalent
342  * @QDF_MODULE_ID_DEBUG: IFF_DEBUG equivalent
343  * @QDF_MODULE_ID_MLME: MLME
344  * @QDF_MODULE_ID_RRM: Radio resource measurement
345  * @QDF_MODULE_ID_WNM: Wireless Network Management
346  * @QDF_MODULE_ID_P2P_PROT: P2P Protocol driver
347  * @QDF_MODULE_ID_PROXYARP: 11v Proxy ARP
348  * @QDF_MODULE_ID_L2TIF: Hotspot 2.0 L2 TIF
349  * @QDF_MODULE_ID_WIFIPOS: WifiPositioning Feature
350  * @QDF_MODULE_ID_WRAP: WRAP or Wireless ProxySTA
351  * @QDF_MODULE_ID_DFS: DFS debug mesg
352  * @QDF_MODULE_ID_TLSHIM: TLSHIM module ID
353  * @QDF_MODULE_ID_WMI: WMI module ID
354  * @QDF_MODULE_ID_HTT: HTT module ID
355  * @QDF_MODULE_ID_HDD: HDD module ID
356  * @QDF_MODULE_ID_SME: SME module ID
357  * @QDF_MODULE_ID_PE: PE module ID
358  * @QDF_MODULE_ID_WMA: WMA module ID
359  * @QDF_MODULE_ID_SYS: SYS module ID
360  * @QDF_MODULE_ID_QDF: QDF module ID
361  * @QDF_MODULE_ID_SAP: SAP module ID
362  * @QDF_MODULE_ID_HDD_SOFTAP: HDD SAP module ID
363  * @QDF_MODULE_ID_HDD_DATA: HDD DATA module ID
364  * @QDF_MODULE_ID_HDD_SAP_DATA: HDD SAP DATA module ID
365  * @QDF_MODULE_ID_HIF: HIF module ID
366  * @QDF_MODULE_ID_HTC: HTC module ID
367  * @QDF_MODULE_ID_TXRX: TXRX module ID
368  * @QDF_MODULE_ID_QDF_DEVICE: QDF DEVICE module ID
369  * @QDF_MODULE_ID_CFG: CFG module ID
370  * @QDF_MODULE_ID_BMI: BMI module ID
371  * @QDF_MODULE_ID_EPPING: EPPING module ID
372  * @QDF_MODULE_ID_QVIT: QVIT module ID
373  * @QDF_MODULE_ID_DP: Data-path module ID
374  * @QDF_MODULE_ID_HAL: Hal abstraction module ID
375  * @QDF_MODULE_ID_SOC: SOC module ID
376  * @QDF_MODULE_ID_OS_IF: OS-interface module ID
377  * @QDF_MODULE_ID_TARGET_IF: target interface module ID
378  * @QDF_MODULE_ID_SCHEDULER: scheduler module ID
379  * @QDF_MODULE_ID_MGMT_TXRX: management TX/RX module ID
380  * @QDF_MODULE_ID_SERIALIZATION: serialization module ID
381  * @QDF_MODULE_ID_PMO: PMO (power manager and offloads) Module ID
382  * @QDF_MODULE_ID_P2P: P2P module ID
383  * @QDF_MODULE_ID_POLICY_MGR: Policy Manager module ID
384  * @QDF_MODULE_ID_CONFIG: CFG (configuration) component ID
385  * @QDF_MODULE_ID_REGULATORY: REGULATORY module ID
386  * @QDF_MODULE_ID_NAN: NAN module ID
387  * @QDF_MODULE_ID_SPECTRAL: Spectral module ID
388  * @QDF_MODULE_ID_ROAM_DEBUG: Roam Debug logging
389  * @QDF_MODULE_ID_CDP: Converged Data Path module ID
390  * @QDF_MODULE_ID_DIRECT_BUF_RX: Direct Buffer Receive module ID
391  * @QDF_MODULE_ID_DISA: DISA (encryption test) module ID
392  * @QDF_MODULE_ID_GREEN_AP: Green AP related logging
393  * @QDF_MODULE_ID_FTM: FTM module ID
394  * @QDF_MODULE_ID_FD: FILS discovery logging
395  * @QDF_MODULE_ID_OCB: OCB module ID
396  * @QDF_MODULE_ID_IPA: IPA module ID
397  * @QDF_MODULE_ID_CP_STATS: Control Plane Statistics ID
398  * @QDF_MODULE_ID_ACTION_OUI: ACTION OUI module ID
399  * @QDF_MODULE_ID_TARGET: Target module ID
400  * @QDF_MODULE_ID_MBSSIE: MBSS IE ID
401  * @QDF_MODULE_ID_FWOL: FW Offload module ID
402  * @QDF_MODULE_ID_SM_ENGINE: SM engine module ID
403  * @QDF_MODULE_ID_CMN_MLME: CMN MLME module ID
404  * @QDF_MODULE_ID_CFR: CFR module ID
405  * @QDF_MODULE_ID_DP_TX_CAPTURE: Tx capture enhancement feature ID
406  * @QDF_MODULE_ID_INTEROP_ISSUES_AP: interop issues ap module ID
407  * @QDF_MODULE_ID_DENYLIST_MGR: Denylist Manager module
408  * @QDF_MODULE_ID_QLD: QCA Live Debug module ID
409  * @QDF_MODULE_ID_DYNAMIC_MODE_CHG: Dynamic mode change module ID
410  * @QDF_MODULE_ID_COEX: Coex related config module ID
411  * @QDF_MODULE_ID_FTM_TIME_SYNC: FTM Time sync module ID
412  * @QDF_MODULE_ID_PKT_CAPTURE: PACKET CAPTURE module ID
413  * @QDF_MODULE_ID_MON_FILTER: Monitor filter related config module ID
414  * @QDF_MODULE_ID_DCS: DCS module ID
415  * @QDF_MODULE_ID_RPTR: Repeater module ID
416  * @QDF_MODULE_ID_6GHZ: 6Ghz specific feature ID
417  * @QDF_MODULE_ID_IOT_SIM: IOT Simulation for rogue AP module ID
418  * @QDF_MODULE_ID_IFMGR: Interface Manager feature ID
419  * @QDF_MODULE_ID_MSCS: MSCS feature ID
420  * @QDF_MODULE_ID_GPIO: GPIO configuration module ID
421  * @QDF_MODULE_ID_DIAG: Host diag module ID
422  * @QDF_MODULE_ID_DP_INIT: INIT/DEINIT path of datapath module ID
423  * @QDF_MODULE_ID_DP_TX: TX path of datapath module ID
424  * @QDF_MODULE_ID_DP_RX: RX path of datapath module ID
425  * @QDF_MODULE_ID_DP_STATS: TX/RX stats, AST stats module ID
426  * @QDF_MODULE_ID_DP_HTT: Firmware to host DP event handling module ID
427  * @QDF_MODULE_ID_DP_PEER: DP peer module ID
428  * @QDF_MODULE_ID_DP_RX_ERROR: Packet handling from WBM release ring module ID
429  * @QDF_MODULE_ID_DP_HTT_TX_STATS: FW to host Tx  PPDU stats module ID
430  * @QDF_MODULE_ID_DP_RX_MON_STATUS: RX mon status ring module ID
431  * @QDF_MODULE_ID_DP_RX_MON_DEST: Monitor ode processing module ID
432  * @QDF_MODULE_ID_DP_REO: REO command status module ID
433  * @QDF_MODULE_ID_DP_TX_COMP: TX completion module ID
434  * @QDF_MODULE_ID_DP_VDEV: DP Vdev module ID
435  * @QDF_MODULE_ID_DP_CDP: Configuration module ID
436  * @QDF_MODULE_ID_TSO: TSO module ID
437  * @QDF_MODULE_ID_ME: Multicast Enhancement module ID
438  * @QDF_MODULE_ID_QWRAP: QWRAP module ID
439  * @QDF_MODULE_ID_DBDC_REP: DBDC repeater module ID
440  * @QDF_MODULE_ID_EXT_AP: Extended AP module ID
441  * @QDF_MODULE_ID_MLO: MLO Manager module ID
442  * @QDF_MODULE_ID_MLOIE: MLO related IE protocol processing module ID
443  * @QDF_MODULE_ID_MBSS: MBSS Framework module ID
444  * @QDF_MODULE_ID_MON: Monitor module ID
445  * @QDF_MODULE_ID_MGMT_RX_REO: Management rx-reorder module ID
446  * @QDF_MODULE_ID_AFC: AFC module ID
447  * @QDF_MODULE_ID_WIFI_RADAR: WIFI RADAR module ID
448  * @QDF_MODULE_ID_TWT: TWT module ID
449  * @QDF_MODULE_ID_WLAN_PRE_CAC: WLAN PRE CAC module ID
450  * @QDF_MODULE_ID_T2LM: T2LM module ID
451  * @QDF_MODULE_ID_DP_SAWF: DP SAWF module ID
452  * @QDF_MODULE_ID_SCS: SCS module ID
453  * @QDF_MODULE_ID_COAP: Constrained Application Protocol module ID
454  * @QDF_MODULE_ID_QMI: QMI module ID
455  * @QDF_MODULE_ID_ANY: anything
456  * @QDF_MODULE_ID_SOUNDING: txbf SOUNDING
457  * @QDF_MODULE_ID_SAWF: SAWF module ID
458  * @QDF_MODULE_ID_EPCS: EPCS module ID
459  * @QDF_MODULE_ID_MAX: Max place holder module ID
460  *
461  * New module ID needs to be added in qdf trace along with this enum.
462  */
463 typedef enum {
464 	QDF_MODULE_ID_MIN       = 0,
465 	QDF_MODULE_ID_TDLS      = QDF_MODULE_ID_MIN,
466 	QDF_MODULE_ID_ACS,
467 	QDF_MODULE_ID_SCAN_SM,
468 	QDF_MODULE_ID_SCANENTRY,
469 	QDF_MODULE_ID_WDS,
470 	QDF_MODULE_ID_ACTION,
471 	QDF_MODULE_ID_ROAM,
472 	QDF_MODULE_ID_INACT,
473 	QDF_MODULE_ID_DOTH      = 8,
474 	QDF_MODULE_ID_IQUE,
475 	QDF_MODULE_ID_WME,
476 	QDF_MODULE_ID_ACL,
477 	QDF_MODULE_ID_WPA,
478 	QDF_MODULE_ID_RADKEYS,
479 	QDF_MODULE_ID_RADDUMP,
480 	QDF_MODULE_ID_RADIUS,
481 	QDF_MODULE_ID_DOT1XSM   = 16,
482 	QDF_MODULE_ID_DOT1X,
483 	QDF_MODULE_ID_POWER,
484 	QDF_MODULE_ID_STATE,
485 	QDF_MODULE_ID_OUTPUT,
486 	QDF_MODULE_ID_SCAN,
487 	QDF_MODULE_ID_AUTH,
488 	QDF_MODULE_ID_ASSOC,
489 	QDF_MODULE_ID_NODE      = 24,
490 	QDF_MODULE_ID_ELEMID,
491 	QDF_MODULE_ID_XRATE,
492 	QDF_MODULE_ID_INPUT,
493 	QDF_MODULE_ID_CRYPTO,
494 	QDF_MODULE_ID_DUMPPKTS,
495 	QDF_MODULE_ID_DEBUG,
496 	QDF_MODULE_ID_MLME,
497 	QDF_MODULE_ID_RRM       = 32,
498 	QDF_MODULE_ID_WNM,
499 	QDF_MODULE_ID_P2P_PROT,
500 	QDF_MODULE_ID_PROXYARP,
501 	QDF_MODULE_ID_L2TIF,
502 	QDF_MODULE_ID_WIFIPOS,
503 	QDF_MODULE_ID_WRAP,
504 	QDF_MODULE_ID_DFS,
505 	QDF_MODULE_ID_ATF       = 40,
506 	QDF_MODULE_ID_SPLITMAC,
507 	QDF_MODULE_ID_IOCTL,
508 	QDF_MODULE_ID_NAC,
509 	QDF_MODULE_ID_MESH,
510 	QDF_MODULE_ID_MBO,
511 	QDF_MODULE_ID_EXTIOCTL_CHANSWITCH,
512 	QDF_MODULE_ID_EXTIOCTL_CHANSSCAN,
513 	QDF_MODULE_ID_TLSHIM    = 48,
514 	QDF_MODULE_ID_WMI,
515 	QDF_MODULE_ID_HTT,
516 	QDF_MODULE_ID_HDD,
517 	QDF_MODULE_ID_SME,
518 	QDF_MODULE_ID_PE,
519 	QDF_MODULE_ID_WMA,
520 	QDF_MODULE_ID_SYS,
521 	QDF_MODULE_ID_QDF       = 56,
522 	QDF_MODULE_ID_SAP,
523 	QDF_MODULE_ID_HDD_SOFTAP,
524 	QDF_MODULE_ID_HDD_DATA,
525 	QDF_MODULE_ID_HDD_SAP_DATA,
526 	QDF_MODULE_ID_HIF,
527 	QDF_MODULE_ID_HTC,
528 	QDF_MODULE_ID_TXRX,
529 	QDF_MODULE_ID_QDF_DEVICE = 64,
530 	QDF_MODULE_ID_CFG,
531 	QDF_MODULE_ID_BMI,
532 	QDF_MODULE_ID_EPPING,
533 	QDF_MODULE_ID_QVIT,
534 	QDF_MODULE_ID_DP,
535 	QDF_MODULE_ID_HAL,
536 	QDF_MODULE_ID_SOC,
537 	QDF_MODULE_ID_OS_IF,
538 	QDF_MODULE_ID_TARGET_IF,
539 	QDF_MODULE_ID_SCHEDULER,
540 	QDF_MODULE_ID_MGMT_TXRX,
541 	QDF_MODULE_ID_SERIALIZATION,
542 	QDF_MODULE_ID_PMO,
543 	QDF_MODULE_ID_P2P,
544 	QDF_MODULE_ID_POLICY_MGR,
545 	QDF_MODULE_ID_CONFIG,
546 	QDF_MODULE_ID_REGULATORY,
547 	QDF_MODULE_ID_SA_API,
548 	QDF_MODULE_ID_NAN,
549 	QDF_MODULE_ID_OFFCHAN_TXRX,
550 	QDF_MODULE_ID_SON,
551 	QDF_MODULE_ID_SPECTRAL,
552 	QDF_MODULE_ID_OBJ_MGR,
553 	QDF_MODULE_ID_NSS,
554 	QDF_MODULE_ID_ROAM_DEBUG,
555 	QDF_MODULE_ID_CDP,
556 	QDF_MODULE_ID_DIRECT_BUF_RX,
557 	QDF_MODULE_ID_DISA,
558 	QDF_MODULE_ID_GREEN_AP,
559 	QDF_MODULE_ID_FTM,
560 	QDF_MODULE_ID_FD,
561 	QDF_MODULE_ID_OCB,
562 	QDF_MODULE_ID_IPA,
563 	QDF_MODULE_ID_CP_STATS,
564 	QDF_MODULE_ID_ACTION_OUI,
565 	QDF_MODULE_ID_TARGET,
566 	QDF_MODULE_ID_MBSSIE,
567 	QDF_MODULE_ID_FWOL,
568 	QDF_MODULE_ID_SM_ENGINE,
569 	QDF_MODULE_ID_CMN_MLME,
570 	QDF_MODULE_ID_BSSCOLOR,
571 	QDF_MODULE_ID_CFR,
572 	QDF_MODULE_ID_DP_TX_CAPTURE,
573 	QDF_MODULE_ID_INTEROP_ISSUES_AP,
574 	QDF_MODULE_ID_DENYLIST_MGR,
575 	QDF_MODULE_ID_QLD,
576 	QDF_MODULE_ID_DYNAMIC_MODE_CHG,
577 	QDF_MODULE_ID_COEX,
578 	QDF_MODULE_ID_FTM_TIME_SYNC,
579 	QDF_MODULE_ID_PKT_CAPTURE,
580 	QDF_MODULE_ID_MON_FILTER,
581 	QDF_MODULE_ID_DCS,
582 	QDF_MODULE_ID_RPTR,
583 	QDF_MODULE_ID_6GHZ,
584 	QDF_MODULE_ID_IOT_SIM,
585 	QDF_MODULE_ID_IFMGR,
586 	QDF_MODULE_ID_MSCS,
587 	QDF_MODULE_ID_GPIO,
588 	QDF_MODULE_ID_DIAG,
589 	QDF_MODULE_ID_DP_INIT,
590 	QDF_MODULE_ID_DP_TX,
591 	QDF_MODULE_ID_DP_RX,
592 	QDF_MODULE_ID_DP_STATS,
593 	QDF_MODULE_ID_DP_HTT,
594 	QDF_MODULE_ID_DP_PEER,
595 	QDF_MODULE_ID_DP_RX_ERROR,
596 	QDF_MODULE_ID_DP_HTT_TX_STATS,
597 	QDF_MODULE_ID_DP_RX_MON_STATUS,
598 	QDF_MODULE_ID_DP_RX_MON_DEST,
599 	QDF_MODULE_ID_DP_REO,
600 	QDF_MODULE_ID_DP_TX_COMP,
601 	QDF_MODULE_ID_DP_VDEV,
602 	QDF_MODULE_ID_DP_CDP,
603 	QDF_MODULE_ID_TSO,
604 	QDF_MODULE_ID_ME,
605 	QDF_MODULE_ID_QWRAP,
606 	QDF_MODULE_ID_DBDC_REP,
607 	QDF_MODULE_ID_EXT_AP,
608 	QDF_MODULE_ID_MLO,
609 	QDF_MODULE_ID_MLOIE,
610 	QDF_MODULE_ID_MBSS,
611 	QDF_MODULE_ID_MON,
612 	QDF_MODULE_ID_MGMT_RX_REO,
613 	QDF_MODULE_ID_AFC,
614 	QDF_MODULE_ID_WIFI_RADAR,
615 	QDF_MODULE_ID_TWT,
616 	QDF_MODULE_ID_DP_UMAC_RESET,
617 	QDF_MODULE_ID_WLAN_PRE_CAC,
618 	QDF_MODULE_ID_T2LM,
619 	QDF_MODULE_ID_DP_SAWF,
620 	QDF_MODULE_ID_SCS,
621 	QDF_MODULE_ID_COAP,
622 	QDF_MODULE_ID_QMI,
623 	QDF_MODULE_ID_SOUNDING,
624 	QDF_MODULE_ID_SAWF,
625 	QDF_MODULE_ID_EPCS,
626 	QDF_MODULE_ID_ANY,
627 	QDF_MODULE_ID_MAX,
628 } QDF_MODULE_ID;
629 
630 /**
631  * typedef QDF_TRACE_LEVEL - Debug verbose level
632  * @QDF_TRACE_LEVEL_NONE: no trace will be logged. This value is in place
633  *			  for the qdf_trace_setlevel() to allow the user
634  *			  to turn off all traces
635  * @QDF_TRACE_LEVEL_FATAL: Indicates fatal error conditions
636  * @QDF_TRACE_LEVEL_ERROR: Indicates error conditions
637  * @QDF_TRACE_LEVEL_WARN: May indicate that an error will occur if action
638  *			  is not taken
639  * @QDF_TRACE_LEVEL_INFO: Normal operational messages that require no action
640  * @QDF_TRACE_LEVEL_INFO_HIGH: High level operational messages that require
641  *			       no action
642  * @QDF_TRACE_LEVEL_INFO_MED: Middle level operational messages that require
643  *			      no action
644  * @QDF_TRACE_LEVEL_INFO_LOW: Low level operational messages that require
645  *			      no action
646  * @QDF_TRACE_LEVEL_DEBUG: Information useful to developers for debugging
647  * @QDF_TRACE_LEVEL_TRACE: Indicates trace level for automation scripts,
648  *			whenever there is a context switch in driver, one
649  *			print using this trace level will be added with
650  *			the help of qdf_trace api.
651  * @QDF_TRACE_LEVEL_ALL: All trace levels
652  * @QDF_TRACE_LEVEL_MAX: Max trace level
653  */
654 typedef enum {
655 	QDF_TRACE_LEVEL_NONE,
656 	QDF_TRACE_LEVEL_FATAL,
657 	QDF_TRACE_LEVEL_ERROR,
658 	QDF_TRACE_LEVEL_WARN,
659 	QDF_TRACE_LEVEL_INFO,
660 	QDF_TRACE_LEVEL_INFO_HIGH,
661 	QDF_TRACE_LEVEL_INFO_MED,
662 	QDF_TRACE_LEVEL_INFO_LOW,
663 	QDF_TRACE_LEVEL_DEBUG,
664 	QDF_TRACE_LEVEL_TRACE,
665 	QDF_TRACE_LEVEL_ALL,
666 	QDF_TRACE_LEVEL_MAX
667 } QDF_TRACE_LEVEL;
668 
669 /**
670  * enum QDF_OPMODE - vdev operating mode
671  * @QDF_STA_MODE: STA mode
672  * @QDF_SAP_MODE: SAP mode
673  * @QDF_P2P_CLIENT_MODE: P2P client mode
674  * @QDF_P2P_GO_MODE: P2P GO mode
675  * @QDF_FTM_MODE: FTM mode
676  * @QDF_IBSS_MODE: IBSS mode
677  * @QDF_MONITOR_MODE: Monitor mode
678  * @QDF_P2P_DEVICE_MODE: P2P device mode
679  * @QDF_OCB_MODE: OCB device mode
680  * @QDF_EPPING_MODE: EPPING device mode
681  * @QDF_QVIT_MODE: QVIT device mode
682  * @QDF_NDI_MODE: NAN datapath mode
683  * @QDF_WDS_MODE: WDS mode
684  * @QDF_BTAMP_MODE: BTAMP mode
685  * @QDF_AHDEMO_MODE: AHDEMO mode
686  * @QDF_TDLS_MODE: TDLS device mode
687  * @QDF_NAN_DISC_MODE: NAN Discovery device mode
688  * @QDF_MAX_NO_OF_MODE: Max place holder
689  *
690  * These are generic IDs that identify the various roles
691  * in the software system
692  */
693 enum QDF_OPMODE {
694 	QDF_STA_MODE,
695 	QDF_SAP_MODE,
696 	QDF_P2P_CLIENT_MODE,
697 	QDF_P2P_GO_MODE,
698 	QDF_FTM_MODE,
699 	QDF_IBSS_MODE,
700 	QDF_MONITOR_MODE,
701 	QDF_P2P_DEVICE_MODE,
702 	QDF_OCB_MODE,
703 	QDF_EPPING_MODE,
704 	QDF_QVIT_MODE,
705 	QDF_NDI_MODE,
706 	QDF_WDS_MODE,
707 	QDF_BTAMP_MODE,
708 	QDF_AHDEMO_MODE,
709 	QDF_TDLS_MODE,
710 	QDF_NAN_DISC_MODE,
711 
712 	/* Add new OP Modes to qdf_opmode_str as well */
713 
714 	QDF_MAX_NO_OF_MODE
715 };
716 
717 /**
718  * qdf_opmode_str() - Return a human readable string representation of @opmode
719  * @opmode: The opmode to convert
720  *
721  * Return: string representation of @opmode
722  */
723 const char *qdf_opmode_str(const enum QDF_OPMODE opmode);
724 
725 /**
726  * enum QDF_GLOBAL_MODE - global mode when driver is loaded.
727  *
728  * @QDF_GLOBAL_MISSION_MODE: mission mode (STA, SAP...)
729  * @QDF_GLOBAL_WALTEST_MODE: WAL Test Mode
730  * @QDF_GLOBAL_MONITOR_MODE: Monitor Mode
731  * @QDF_GLOBAL_FTM_MODE: FTM mode
732  * @QDF_GLOBAL_IBSS_MODE: IBSS mode
733  * @QDF_GLOBAL_COLDBOOT_CALIB_MODE: Cold Boot Calibration Mode
734  * @QDF_GLOBAL_EPPING_MODE: EPPING mode
735  * @QDF_GLOBAL_QVIT_MODE: QVIT global mode
736  * @QDF_GLOBAL_FTM_COLDBOOT_CALIB_MODE: Cold Boot Calibration in FTM Mode
737  * @QDF_GLOBAL_MAX_MODE: Max place holder
738  */
739 enum QDF_GLOBAL_MODE {
740 	QDF_GLOBAL_MISSION_MODE,
741 	QDF_GLOBAL_WALTEST_MODE = 3,
742 	QDF_GLOBAL_MONITOR_MODE = 4,
743 	QDF_GLOBAL_FTM_MODE = 5,
744 	QDF_GLOBAL_IBSS_MODE = 6,
745 	QDF_GLOBAL_COLDBOOT_CALIB_MODE = 7,
746 	QDF_GLOBAL_EPPING_MODE = 8,
747 	QDF_GLOBAL_QVIT_MODE = 9,
748 	QDF_GLOBAL_FTM_COLDBOOT_CALIB_MODE = 10,
749 	QDF_GLOBAL_MAX_MODE
750 };
751 
752 #define  QDF_IS_EPPING_ENABLED(mode) (mode == QDF_GLOBAL_EPPING_MODE)
753 
754 #ifdef QDF_TRACE_PRINT_ENABLE
755 #define qdf_print(args...) QDF_TRACE_INFO(QDF_MODULE_ID_ANY, ## args)
756 #define qdf_alert(args...) QDF_TRACE_FATAL(QDF_MODULE_ID_ANY, ## args)
757 #define qdf_err(args...)   QDF_TRACE_ERROR(QDF_MODULE_ID_ANY, ## args)
758 #define qdf_warn(args...)  QDF_TRACE_WARN(QDF_MODULE_ID_ANY, ## args)
759 #define qdf_info(args...)  QDF_TRACE_INFO(QDF_MODULE_ID_ANY, ## args)
760 #define qdf_debug(args...) QDF_TRACE_DEBUG(QDF_MODULE_ID_ANY, ## args)
761 
762 #define qdf_nofl_print(params...) \
763 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_ANY, ## params)
764 #define qdf_nofl_alert(params...) \
765 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_ANY, ## params)
766 #define qdf_nofl_err(params...) \
767 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_ANY, ## params)
768 #define qdf_nofl_warn(params...) \
769 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_ANY, ## params)
770 #define qdf_nofl_info(params...) \
771 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_ANY, ## params)
772 #define qdf_nofl_debug(params...) \
773 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_ANY, ## params)
774 
775 #else /* QDF_TRACE_PRINT_ENABLE */
776 #define qdf_print(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, ## params)
777 #define qdf_alert(params...) QDF_TRACE_FATAL(QDF_MODULE_ID_QDF, ## params)
778 #define qdf_err(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, ## params)
779 #define qdf_warn(params...) QDF_TRACE_WARN(QDF_MODULE_ID_QDF, ## params)
780 #define qdf_info(params...) QDF_TRACE_INFO(QDF_MODULE_ID_QDF, ## params)
781 #define qdf_debug(params...) QDF_TRACE_DEBUG(QDF_MODULE_ID_QDF, ## params)
782 
783 #define qdf_nofl_alert(params...) \
784 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_QDF, ## params)
785 #define qdf_nofl_err(params...) \
786 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_QDF, ## params)
787 #define qdf_nofl_warn(params...) \
788 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_QDF, ## params)
789 #define qdf_nofl_info(params...) \
790 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_QDF, ## params)
791 #define qdf_nofl_debug(params...) \
792 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_QDF, ## params)
793 
794 #endif /* QDF_TRACE_PRINT_ENABLE */
795 
796 #define qdf_rl_alert(params...) QDF_TRACE_FATAL_RL(QDF_MODULE_ID_QDF, ## params)
797 #define qdf_rl_err(params...) QDF_TRACE_ERROR_RL(QDF_MODULE_ID_QDF, ## params)
798 #define qdf_rl_warn(params...) QDF_TRACE_WARN_RL(QDF_MODULE_ID_QDF, ## params)
799 #define qdf_rl_info(params...) QDF_TRACE_INFO_RL(QDF_MODULE_ID_QDF, ## params)
800 #define qdf_rl_debug(params...) QDF_TRACE_DEBUG_RL(QDF_MODULE_ID_QDF, ## params)
801 
802 #define qdf_rl_nofl_alert(params...) \
803 	QDF_TRACE_FATAL_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
804 #define qdf_rl_nofl_err(params...) \
805 	QDF_TRACE_ERROR_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
806 #define qdf_rl_nofl_warn(params...) \
807 	QDF_TRACE_WARN_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
808 #define qdf_rl_nofl_info(params...) \
809 	QDF_TRACE_INFO_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
810 #define qdf_rl_nofl_debug(params...) \
811 	QDF_TRACE_DEBUG_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
812 
813 #define qdf_snprint   __qdf_snprint
814 
815 #define qdf_kstrtoint __qdf_kstrtoint
816 #define qdf_kstrtouint __qdf_kstrtouint
817 
818 #ifdef WLAN_FEATURE_11BE_MLO
819 #define QDF_MAX_CONCURRENCY_PERSONA  (WLAN_MAX_VDEVS + 1)
820 #else
821 #ifdef WLAN_OPEN_P2P_INTERFACE
822 /* This should match with WLAN_MAX_INTERFACES */
823 #define QDF_MAX_CONCURRENCY_PERSONA  (WLAN_MAX_VDEVS)
824 #else
825 #define QDF_MAX_CONCURRENCY_PERSONA  (WLAN_MAX_VDEVS - 1)
826 #endif
827 #endif
828 
829 #define QDF_STA_MASK (1 << QDF_STA_MODE)
830 #define QDF_SAP_MASK (1 << QDF_SAP_MODE)
831 #define QDF_P2P_CLIENT_MASK (1 << QDF_P2P_CLIENT_MODE)
832 #define QDF_P2P_GO_MASK (1 << QDF_P2P_GO_MODE)
833 #define QDF_MONITOR_MASK (1 << QDF_MONITOR_MODE)
834 
835 #ifdef FEATURE_WLAN_MCC_TO_SCC_SWITCH
836 
837 /**
838  * typedef tQDF_MCC_TO_SCC_SWITCH_MODE - MCC to SCC switch mode.
839  * @QDF_MCC_TO_SCC_SWITCH_DISABLE: Disable switch
840  * @QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION: Force switch without
841  * restart of SAP
842  * @QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL: Switch using fav channel(s)
843  * without SAP restart
844  * @QDF_MCC_TO_SCC_SWITCH_FORCE_PREFERRED_WITHOUT_DISCONNECTION: Force switch
845  * without SAP restart. MCC is allowed only in below exception cases:
846  *	Exception Case-1: When STA is operating on DFS channel.
847  *	Exception Case-2: When STA is operating on LTE-CoEx channel.
848  *	Exception Case-3: When STA is operating on AP disabled channel.
849  * @QDF_MCC_TO_SCC_WITH_PREFERRED_BAND: Force SCC only in user preferred band.
850  * Allow MCC if STA is operating or comes up on other than user preferred band.
851  *
852  * @QDF_MCC_TO_SCC_SWITCH_MAX: max switch
853  */
854 typedef enum {
855 	QDF_MCC_TO_SCC_SWITCH_DISABLE = 0,
856 	QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION = 3,
857 	QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL,
858 	QDF_MCC_TO_SCC_SWITCH_FORCE_PREFERRED_WITHOUT_DISCONNECTION,
859 	QDF_MCC_TO_SCC_WITH_PREFERRED_BAND,
860 	QDF_MCC_TO_SCC_SWITCH_MAX
861 } tQDF_MCC_TO_SCC_SWITCH_MODE;
862 #endif
863 
864 #if !defined(NULL)
865 #ifdef __cplusplus
866 #define NULL   0
867 #else
868 #define NULL   ((void *)0)
869 #endif
870 #endif
871 
872 /**
873  * qdf_bool_parse() - parse the given string as a boolean value
874  * @bool_str: the input boolean string to parse
875  * @out_bool: the output boolean value, populated on success
876  *
877  * 1, y, Y are mapped to true, 0, n, N are mapped to false.
878  * Leading/trailing whitespace is ignored.
879  *
880  * Return: QDF_STATUS
881  */
882 QDF_STATUS qdf_bool_parse(const char *bool_str, bool *out_bool);
883 
884 /**
885  * qdf_int32_parse() - parse the given string as a 32-bit signed integer
886  * @int_str: the input integer string to parse
887  * @out_int: the output integer value, populated on success
888  *
889  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
890  * encodings via typical prefix notation. Leading/trailing whitespace is
891  * ignored.
892  *
893  * Return: QDF_STATUS
894  */
895 QDF_STATUS qdf_int32_parse(const char *int_str, int32_t *out_int);
896 
897 /**
898  * qdf_uint8_parse() - parse the given string as a 8-bit unsigned integer
899  * @int_str: the input integer string to parse
900  * @out_int: the output integer value, populated on success
901  *
902  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
903  * encodings via typical prefix notation. Leading/trailing whitespace is
904  * ignored.
905  *
906  * Return: QDF_STATUS
907  */
908 QDF_STATUS qdf_uint8_parse(const char *int_str, uint8_t *out_int);
909 
910 /**
911  * qdf_uint16_parse() - parse the given string as a 16-bit unsigned integer
912  * @int_str: the input integer string to parse
913  * @out_int: the output integer value, populated on success
914  *
915  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
916  * encodings via typical prefix notation. Leading/trailing whitespace is
917  * ignored.
918  *
919  * Return: QDF_STATUS
920  */
921 QDF_STATUS qdf_uint16_parse(const char *int_str, uint16_t *out_int);
922 
923 /**
924  * qdf_uint32_parse() - parse the given string as a 32-bit unsigned integer
925  * @int_str: the input integer string to parse
926  * @out_int: the output integer value, populated on success
927  *
928  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
929  * encodings via typical prefix notation. Leading/trailing whitespace is
930  * ignored.
931  *
932  * Return: QDF_STATUS
933  */
934 QDF_STATUS qdf_uint32_parse(const char *int_str, uint32_t *out_int);
935 
936 /**
937  * qdf_int64_parse() - parse the given string as a 64-bit signed integer
938  * @int_str: the input integer string to parse
939  * @out_int: the output integer value, populated on success
940  *
941  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
942  * encodings via typical prefix notation. Leading/trailing whitespace is
943  * ignored.
944  *
945  * Return: QDF_STATUS
946  */
947 QDF_STATUS qdf_int64_parse(const char *int_str, int64_t *out_int);
948 
949 /**
950  * qdf_uint64_parse() - parse the given string as a 64-bit unsigned integer
951  * @int_str: the input integer string to parse
952  * @out_int: the output integer value, populated on success
953  *
954  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
955  * encodings via typical prefix notation. Leading/trailing whitespace is
956  * ignored.
957  *
958  * Return: QDF_STATUS
959  */
960 QDF_STATUS qdf_uint64_parse(const char *int_str, uint64_t *out_int);
961 
962 #define QDF_MAC_ADDR_SIZE 6
963 
964 /*
965  * If the feature CONFIG_WLAN_TRACE_HIDE_MAC_ADDRESS is enabled,
966  * then the requirement is to hide 2nd, 3rd and 4th octet of the
967  * MAC address in the kernel logs and driver logs.
968  * But other management interfaces like ioctl, debugfs, sysfs,
969  * wext, unit test code or non-production simulator sw (iot_sim)
970  * should continue to log the full mac address.
971  *
972  * Developers must use QDF_FULL_MAC_FMT instead of "%pM",
973  * as this macro helps avoid accidentally breaking the feature
974  * CONFIG_WLAN_TRACE_HIDE_MAC_ADDRESS if enabled and code auditing
975  * becomes easy.
976  */
977 #define QDF_FULL_MAC_FMT "%pM"
978 #define QDF_FULL_MAC_REF(a) (a)
979 
980 #if defined(WLAN_TRACE_HIDE_MAC_ADDRESS)
981 #define QDF_MAC_ADDR_FMT "%02x:**:**:**:%02x:%02x"
982 
983 /*
984  * The input data type for QDF_MAC_ADDR_REF can be pointer or an array.
985  * In case of array, compiler was throwing following warning
986  * 'address of array will always evaluate as ‘true’
987  * and if the pointer is NULL, zero is passed to the format specifier
988  * which results in zero mac address (00:**:**:**:00:00)
989  * For this reason, input data type is typecasted to (uintptr_t).
990  */
991 #define QDF_MAC_ADDR_REF(a) \
992 	(((uintptr_t)NULL != (uintptr_t)(a)) ? (a)[0] : 0), \
993 	(((uintptr_t)NULL != (uintptr_t)(a)) ? (a)[4] : 0), \
994 	(((uintptr_t)NULL != (uintptr_t)(a)) ? (a)[5] : 0)
995 #else
996 #define QDF_MAC_ADDR_FMT "%pM"
997 #define QDF_MAC_ADDR_REF(a) (a)
998 #endif /* WLAN_TRACE_HIDE_MAC_ADDRESS */
999 
1000 #define QDF_SSID_FMT "%.*s"
1001 
1002 #if defined(WLAN_TRACE_HIDE_SSID)
1003 #define QDF_SSID_REF(_l, _s) 1, "*"
1004 #else
1005 #define QDF_SSID_REF(_l, _s) (_l), (_s)
1006 #endif /* WLAN_TRACE_HIDE_SSID */
1007 
1008 #define QDF_MAC_ADDR_BCAST_INIT { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } }
1009 #define QDF_MAC_ADDR_ZERO_INIT { { 0, 0, 0, 0, 0, 0 } }
1010 
1011 /**
1012  * struct qdf_mac_addr - A MAC address
1013  * @bytes: the raw address bytes array
1014  */
1015 struct qdf_mac_addr {
1016 	uint8_t bytes[QDF_MAC_ADDR_SIZE];
1017 };
1018 
1019 /**
1020  * enum qdf_proto_subtype - subtype of packet
1021  * @QDF_PROTO_INVALID: invalid
1022  * @QDF_PROTO_EAPOL_M1: EAPOL 1/4
1023  * @QDF_PROTO_EAPOL_M2: EAPOL 2/4
1024  * @QDF_PROTO_EAPOL_M3: EAPOL 3/4
1025  * @QDF_PROTO_EAPOL_M4: EAPOL 4/4
1026  * @QDF_PROTO_DHCP_DISCOVER: discover
1027  * @QDF_PROTO_DHCP_REQUEST: request
1028  * @QDF_PROTO_DHCP_OFFER: offer
1029  * @QDF_PROTO_DHCP_ACK: ACK
1030  * @QDF_PROTO_DHCP_NACK: NACK
1031  * @QDF_PROTO_DHCP_RELEASE: release
1032  * @QDF_PROTO_DHCP_INFORM: inform
1033  * @QDF_PROTO_DHCP_DECLINE: decline
1034  * @QDF_PROTO_ARP_REQ: arp request
1035  * @QDF_PROTO_ARP_RES: arp response
1036  * @QDF_PROTO_ICMP_REQ: icmp request
1037  * @QDF_PROTO_ICMP_RES: icmp response
1038  * @QDF_PROTO_ICMPV6_REQ: icmpv6 request
1039  * @QDF_PROTO_ICMPV6_RES: icmpv6 response
1040  * @QDF_PROTO_ICMPV6_RS: icmpv6 rs packet
1041  * @QDF_PROTO_ICMPV6_RA: icmpv6 ra packet
1042  * @QDF_PROTO_ICMPV6_NS: icmpv6 ns packet
1043  * @QDF_PROTO_ICMPV6_NA: icmpv6 na packet
1044  * @QDF_PROTO_IPV4_UDP: ipv4 udp
1045  * @QDF_PROTO_IPV4_TCP: ipv4 tcp
1046  * @QDF_PROTO_IPV6_UDP: ipv6 udp
1047  * @QDF_PROTO_IPV6_TCP: ipv6 tcp
1048  * @QDF_PROTO_MGMT_ASSOC: assoc
1049  * @QDF_PROTO_MGMT_DISASSOC: disassoc
1050  * @QDF_PROTO_MGMT_AUTH: auth
1051  * @QDF_PROTO_MGMT_DEAUTH: deauth
1052  * @QDF_ROAM_SYNCH: roam synch indication from fw
1053  * @QDF_ROAM_COMPLETE: roam complete cmd to fw
1054  * @QDF_ROAM_EVENTID: roam eventid from fw
1055  * @QDF_PROTO_DNS_QUERY: dns query
1056  * @QDF_PROTO_DNS_RES: dns response
1057  * @QDF_PROTO_EAP_REQUEST: EAP Request
1058  * @QDF_PROTO_EAP_RESPONSE: EAP Response
1059  * @QDF_PROTO_EAP_SUCCESS: EAP Success
1060  * @QDF_PROTO_EAP_FAILURE: EAP Filure
1061  * @QDF_PROTO_EAP_INITIATE: EAP Initiate
1062  * @QDF_PROTO_EAP_FINISH: EAP Finish
1063  * @QDF_PROTO_EAPOL_START: EAPOL-Start message
1064  * @QDF_PROTO_EAPOL_LOGOFF: EAPOL Log Off message.
1065  * @QDF_PROTO_EAPOL_ASF: ASF Alert message
1066  * @QDF_PROTO_EAP_REQ_ID: EAP identify request
1067  * @QDF_PROTO_EAP_RSP_ID: EAP identify response
1068  * @QDF_PROTO_EAP_M1: EAP expanded type M1
1069  * @QDF_PROTO_EAP_M2: EAP expanded type M2
1070  * @QDF_PROTO_EAP_M3: EAP expanded type M3
1071  * @QDF_PROTO_EAP_M4: EAP expanded type M4
1072  * @QDF_PROTO_EAP_M5: EAP expanded type M5
1073  * @QDF_PROTO_EAP_M6: EAP expanded type M6
1074  * @QDF_PROTO_EAP_M7: EAP expanded type M7
1075  * @QDF_PROTO_EAP_M8: EAP expanded type M8
1076  * @QDF_PROTO_EAP_WSC_START: EAP expanded type WSC start
1077  * @QDF_PROTO_EAP_WSC_ACK: EAP expanded type WSC ACK
1078  * @QDF_PROTO_EAP_WSC_NACK: EAP expanded type WSC NACK
1079  * @QDF_PROTO_EAP_WSC_DONE: EAP expanded type WSC DONE
1080  * @QDF_PROTO_EAP_WSC_FRAG_ACK: EAP expanded type WSC frag ACK
1081  * @QDF_PROTO_SUBTYPE_MAX: subtype max
1082  */
1083 enum qdf_proto_subtype {
1084 	QDF_PROTO_INVALID,
1085 	QDF_PROTO_EAPOL_M1,
1086 	QDF_PROTO_EAPOL_M2,
1087 	QDF_PROTO_EAPOL_M3,
1088 	QDF_PROTO_EAPOL_M4,
1089 	QDF_PROTO_DHCP_DISCOVER,
1090 	QDF_PROTO_DHCP_REQUEST,
1091 	QDF_PROTO_DHCP_OFFER,
1092 	QDF_PROTO_DHCP_ACK,
1093 	QDF_PROTO_DHCP_NACK,
1094 	QDF_PROTO_DHCP_RELEASE,
1095 	QDF_PROTO_DHCP_INFORM,
1096 	QDF_PROTO_DHCP_DECLINE,
1097 	QDF_PROTO_ARP_REQ,
1098 	QDF_PROTO_ARP_RES,
1099 	QDF_PROTO_ICMP_REQ,
1100 	QDF_PROTO_ICMP_RES,
1101 	QDF_PROTO_ICMPV6_REQ,
1102 	QDF_PROTO_ICMPV6_RES,
1103 	QDF_PROTO_ICMPV6_RS,
1104 	QDF_PROTO_ICMPV6_RA,
1105 	QDF_PROTO_ICMPV6_NS,
1106 	QDF_PROTO_ICMPV6_NA,
1107 	QDF_PROTO_IPV4_UDP,
1108 	QDF_PROTO_IPV4_TCP,
1109 	QDF_PROTO_IPV6_UDP,
1110 	QDF_PROTO_IPV6_TCP,
1111 	QDF_PROTO_MGMT_ASSOC,
1112 	QDF_PROTO_MGMT_DISASSOC,
1113 	QDF_PROTO_MGMT_AUTH,
1114 	QDF_PROTO_MGMT_DEAUTH,
1115 	QDF_ROAM_SYNCH,
1116 	QDF_ROAM_COMPLETE,
1117 	QDF_ROAM_EVENTID,
1118 	QDF_PROTO_DNS_QUERY,
1119 	QDF_PROTO_DNS_RES,
1120 	QDF_PROTO_EAP_REQUEST,
1121 	QDF_PROTO_EAP_RESPONSE,
1122 	QDF_PROTO_EAP_SUCCESS,
1123 	QDF_PROTO_EAP_FAILURE,
1124 	QDF_PROTO_EAP_INITIATE,
1125 	QDF_PROTO_EAP_FINISH,
1126 	QDF_PROTO_EAPOL_START,
1127 	QDF_PROTO_EAPOL_LOGOFF,
1128 	QDF_PROTO_EAPOL_ASF,
1129 	QDF_PROTO_EAP_REQ_ID,
1130 	QDF_PROTO_EAP_RSP_ID,
1131 	QDF_PROTO_EAP_M1,
1132 	QDF_PROTO_EAP_M2,
1133 	QDF_PROTO_EAP_M3,
1134 	QDF_PROTO_EAP_M4,
1135 	QDF_PROTO_EAP_M5,
1136 	QDF_PROTO_EAP_M6,
1137 	QDF_PROTO_EAP_M7,
1138 	QDF_PROTO_EAP_M8,
1139 	QDF_PROTO_EAP_WSC_START,
1140 	QDF_PROTO_EAP_WSC_ACK,
1141 	QDF_PROTO_EAP_WSC_NACK,
1142 	QDF_PROTO_EAP_WSC_DONE,
1143 	QDF_PROTO_EAP_WSC_FRAG_ACK,
1144 	QDF_PROTO_SUBTYPE_MAX
1145 };
1146 
1147 /**
1148  * qdf_mac_parse() - parse the given string as a MAC address
1149  * @mac_str: the input MAC address string to parse
1150  * @out_addr: the output MAC address value, populated on success
1151  *
1152  * A MAC address is a set of 6, colon-delimited, hexadecimal encoded octets.
1153  *
1154  * E.g.
1155  *	00:00:00:00:00:00 (zero address)
1156  *	ff:ff:ff:ff:ff:ff (broadcast address)
1157  *	12:34:56:78:90:ab (an arbitrary address)
1158  *
1159  * This implementation also accepts MAC addresses without colons. Historically,
1160  * other delimiters and groupings have been used to represent MAC addresses, but
1161  * these are not supported here. Hexadecimal digits may be in either upper or
1162  * lower case.
1163  *
1164  * Return: QDF_STATUS
1165  */
1166 QDF_STATUS qdf_mac_parse(const char *mac_str, struct qdf_mac_addr *out_addr);
1167 
1168 #define QDF_IPV4_ADDR_SIZE 4
1169 #define QDF_IPV4_ADDR_STR "%d.%d.%d.%d"
1170 #define QDF_IPV4_ADDR_ARRAY(a) (a)[0], (a)[1], (a)[2], (a)[3]
1171 #define QDF_IPV4_ADDR_ZERO_INIT { { 0, 0, 0, 0 } }
1172 
1173 /**
1174  * struct qdf_ipv4_addr - An IPV4 address
1175  * @bytes: the raw address bytes array
1176  */
1177 struct qdf_ipv4_addr {
1178 	uint8_t bytes[QDF_IPV4_ADDR_SIZE];
1179 };
1180 
1181 /**
1182  * qdf_ipv4_parse() - parse the given string as an IPV4 address
1183  * @ipv4_str: the input IPV4 address string to parse
1184  * @out_addr: the output IPV4 address value, populated on success
1185  *
1186  * An IPV4 address is a set of 4, dot-delimited, decimal encoded octets.
1187  *
1188  * E.g.
1189  *	0.0.0.0 (wildcard address)
1190  *	127.0.0.1 (loopback address)
1191  *	255.255.255.255 (broadcast address)
1192  *	192.168.0.1 (an arbitrary address)
1193  *
1194  * Historically, non-decimal encodings have also been used to represent IPV4
1195  * addresses, but these are not supported here.
1196  *
1197  * Return: QDF_STATUS
1198  */
1199 QDF_STATUS qdf_ipv4_parse(const char *ipv4_str, struct qdf_ipv4_addr *out_addr);
1200 
1201 #define QDF_IPV6_ADDR_SIZE 16
1202 #define QDF_IPV6_ADDR_HEXTET_COUNT 8
1203 #define QDF_IPV6_ADDR_STR "%x:%x:%x:%x:%x:%x:%x:%x"
1204 #define QDF_IPV6_ADDR_ARRAY(a) \
1205 	((a)[0] << 8) + (a)[1], ((a)[2] << 8) + (a)[3], \
1206 	((a)[4] << 8) + (a)[5], ((a)[6] << 8) + (a)[7], \
1207 	((a)[8] << 8) + (a)[9], ((a)[10] << 8) + (a)[11], \
1208 	((a)[12] << 8) + (a)[13], ((a)[14] << 8) + (a)[15]
1209 #define QDF_IPV6_ADDR_ZERO_INIT \
1210 	{ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } }
1211 
1212 /**
1213  * struct qdf_ipv6_addr - An IPV6 address
1214  * @bytes: the raw address bytes array
1215  */
1216 struct qdf_ipv6_addr {
1217 	uint8_t bytes[QDF_IPV6_ADDR_SIZE];
1218 };
1219 
1220 /**
1221  * qdf_ipv6_parse() - parse the given string as an IPV6 address
1222  * @ipv6_str: the input IPV6 address string to parse
1223  * @out_addr: the output IPV6 address value, populated on success
1224  *
1225  * A hextet is a pair of octets. An IPV6 address is a set of 8, colon-delimited,
1226  * hexadecimal encoded hextets. Each hextet may omit leading zeros. One or more
1227  * zero-hextets may be "compressed" using a pair of colons ("::"). Up to one
1228  * such zero-compression is allowed per address.
1229  *
1230  * E.g.
1231  *	0:0:0:0:0:0:0:0 (unspecified address)
1232  *	:: (also the unspecified address)
1233  *	0:0:0:0:0:0:0:1 (loopback address)
1234  *	::1 (also the loopback address)
1235  *	900a:ae7::6 (an arbitrary address)
1236  *	900a:ae7:0:0:0:0:0:6 (the same arbitrary address)
1237  *
1238  * Hexadecimal digits may be in either upper or lower case.
1239  *
1240  * Return: QDF_STATUS
1241  */
1242 QDF_STATUS qdf_ipv6_parse(const char *ipv6_str, struct qdf_ipv6_addr *out_addr);
1243 
1244 /**
1245  * qdf_int32_array_parse() - parse the given string as int32 array
1246  * @in_str: the input string to parse
1247  * @out_array: the output uint32 array, populated on success
1248  * @array_size: size of the array
1249  * @out_size: size of the populated array
1250  *
1251  * This API is called to convert string (each value separated by
1252  * a comma) into an uint32 array
1253  *
1254  * Return: QDF_STATUS
1255  */
1256 
1257 QDF_STATUS qdf_int32_array_parse(const char *in_str, int32_t *out_array,
1258 				 qdf_size_t array_size, qdf_size_t *out_size);
1259 
1260 /**
1261  * qdf_uint32_array_parse() - parse the given string as uint32 array
1262  * @in_str: the input string to parse
1263  * @out_array: the output uint32 array, populated on success
1264  * @array_size: size of the array
1265  * @out_size: size of the populated array
1266  *
1267  * This API is called to convert string (each value separated by
1268  * a comma) into an uint32 array
1269  *
1270  * Return: QDF_STATUS
1271  */
1272 
1273 QDF_STATUS qdf_uint32_array_parse(const char *in_str, uint32_t *out_array,
1274 				  qdf_size_t array_size, qdf_size_t *out_size);
1275 
1276 /**
1277  * qdf_uint16_array_parse() - parse the given string as uint16 array
1278  * @in_str: the input string to parse
1279  * @out_array: the output uint16 array, populated on success
1280  * @array_size: size of the array
1281  * @out_size: size of the populated array
1282  *
1283  * This API is called to convert string (each value separated by
1284  * a comma) into an uint16 array
1285  *
1286  * Return: QDF_STATUS
1287  */
1288 
1289 QDF_STATUS qdf_uint16_array_parse(const char *in_str, uint16_t *out_array,
1290 				  qdf_size_t array_size, qdf_size_t *out_size);
1291 
1292 /**
1293  * qdf_uint8_array_parse() - parse the given string as uint8 array
1294  * @in_str: the input string to parse
1295  * @out_array: the output uint8 array, populated on success
1296  * @array_size: size of the array
1297  * @out_size: size of the populated array
1298  *
1299  * This API is called to convert string (each byte separated by
1300  * a comma) into an u8 array
1301  *
1302  * Return: QDF_STATUS
1303  */
1304 QDF_STATUS qdf_uint8_array_parse(const char *in_str, uint8_t *out_array,
1305 				 qdf_size_t array_size, qdf_size_t *out_size);
1306 
1307 #define QDF_BCAST_MAC_ADDR (0xFF)
1308 #define QDF_MCAST_IPV4_MAC_ADDR (0x01)
1309 #define QDF_MCAST_IPV6_MAC_ADDR (0x33)
1310 
1311 /**
1312  * struct qdf_tso_frag_t - fragments of a single TCP segment
1313  * @paddr: physical address
1314  * @length: length of the buffer
1315  * @vaddr: virtual address
1316  *
1317  * This structure holds the fragments of a single TCP segment of a
1318  * given jumbo TSO network buffer
1319  */
1320 struct qdf_tso_frag_t {
1321 	uint16_t length;
1322 	unsigned char *vaddr;
1323 	qdf_dma_addr_t paddr;
1324 };
1325 
1326 #define FRAG_NUM_MAX 6
1327 #define TSO_SEG_MAGIC_COOKIE 0x1EED
1328 
1329 /**
1330  * struct qdf_tso_flags_t - TSO specific flags
1331  * @tso_enable: Enable transmit segmentation offload
1332  * @reserved_0a: rsvd
1333  * @fin: input bit
1334  * @syn: syn
1335  * @rst: reset
1336  * @psh: push
1337  * @ack: aknowledge
1338  * @urg: urg
1339  * @ece: ece
1340  * @cwr: cwr
1341  * @ns: ns
1342  * @reserved_0b: rsvd
1343  * @ipv4_checksum_en: Enable/Disable ipv4 checksum
1344  * @udp_ipv4_checksum_en: Enable/Disable udp ipv4 checksum
1345  * @udp_ipv6_checksum_en: Enable/Disable udp ipv6 checksum
1346  * @tcp_ipv4_checksum_en: Enable/Disable tcp ipv4 checksum
1347  * @tcp_ipv6_checksum_en: Enable/Disable tcp ipv6 checksum
1348  * @partial_checksum_en: Enable/Disable partial checksum
1349  * @reserved_3a: rsvd
1350  * @checksum_offset: checksum offset
1351  * @reserved_4a: rsvd
1352  * @payload_start_offset: payload start offset
1353  * @reserved_4b: rsvd
1354  * @payload_end_offset: payload end offset
1355  * @reserved_5: rsvd
1356  * @tcp_flags_mask: Tcp_flag is inserted into the header based
1357  * on the mask
1358  * @l2_len: L2 length for the msdu
1359  * @ip_len: IP length for the msdu
1360  * @tcp_seq_num: TCP sequence number
1361  * @ip_id: IP identification number
1362  *
1363  * This structure holds the TSO specific flags extracted from the TSO network
1364  * buffer for a given TCP segment
1365  */
1366 struct qdf_tso_flags_t {
1367 	uint32_t tso_enable:1,
1368 			reserved_0a:6,
1369 			fin:1,
1370 			syn:1,
1371 			rst:1,
1372 			psh:1,
1373 			ack:1,
1374 			urg:1,
1375 			ece:1,
1376 			cwr:1,
1377 			ns:1,
1378 			tcp_flags_mask:9,
1379 			reserved_0b:7;
1380 
1381 	uint32_t l2_len:16,
1382 			ip_len:16;
1383 
1384 	uint32_t tcp_seq_num;
1385 
1386 	uint32_t ip_id:16,
1387 			ipv4_checksum_en:1,
1388 			udp_ipv4_checksum_en:1,
1389 			udp_ipv6_checksum_en:1,
1390 			tcp_ipv4_checksum_en:1,
1391 			tcp_ipv6_checksum_en:1,
1392 			partial_checksum_en:1,
1393 			reserved_3a:10;
1394 
1395 	uint32_t checksum_offset:14,
1396 			reserved_4a:2,
1397 			payload_start_offset:14,
1398 			reserved_4b:2;
1399 
1400 	uint32_t payload_end_offset:14,
1401 			reserved_5:18;
1402 };
1403 
1404 /**
1405  * struct qdf_tso_seg_t - single TSO segment
1406  * @tso_flags: TSO flags
1407  * @num_frags: number of fragments
1408  * @total_len: total length of the packet
1409  * @tso_frags: array holding the fragments
1410  *
1411  * This structure holds the information of a single TSO segment of a jumbo
1412  * TSO network buffer
1413  */
1414 struct qdf_tso_seg_t {
1415 	struct qdf_tso_flags_t tso_flags;
1416 	uint32_t num_frags;
1417 	uint32_t total_len;
1418 	struct qdf_tso_frag_t tso_frags[FRAG_NUM_MAX];
1419 };
1420 
1421 /**
1422  * enum tsoseg_dbg_caller_e: TSO seg elem action caller locations
1423  * goes into dbg.history below.
1424  * Needed to be defined outside of the feature so that
1425  * callers can be coded without ifdefs (even if they get
1426  * resolved to nothing)
1427  * @TSOSEG_LOC_UNDEFINED: undefined
1428  * @TSOSEG_LOC_INIT1: init1
1429  * @TSOSEG_LOC_INIT2: inti2
1430  * @TSOSEG_LOC_FREE: free
1431  * @TSOSEG_LOC_ALLOC: alloc
1432  * @TSOSEG_LOC_DEINIT: deinit
1433  * @TSOSEG_LOC_GETINFO: get info
1434  * @TSOSEG_LOC_FILLHTTSEG: fill HTT segment
1435  * @TSOSEG_LOC_FILLCMNSEG: fill CMN segment
1436  * @TSOSEG_LOC_PREPARETSO: prepare TSO
1437  * @TSOSEG_LOC_TXPREPLLFAST: tx prep LL fast
1438  * @TSOSEG_LOC_UNMAPTSO: unmap TSO
1439  * @TSOSEG_LOC_UNMAPLAST: unmap last
1440  * @TSOSEG_LOC_FORCE_FREE: force free
1441  */
1442 enum tsoseg_dbg_caller_e {
1443 	TSOSEG_LOC_UNDEFINED,
1444 	TSOSEG_LOC_INIT1,
1445 	TSOSEG_LOC_INIT2,
1446 	TSOSEG_LOC_FREE,
1447 	TSOSEG_LOC_ALLOC,
1448 	TSOSEG_LOC_DEINIT,
1449 	TSOSEG_LOC_GETINFO,
1450 	TSOSEG_LOC_FILLHTTSEG,
1451 	TSOSEG_LOC_FILLCMNSEG,
1452 	TSOSEG_LOC_PREPARETSO,
1453 	TSOSEG_LOC_TXPREPLLFAST,
1454 	TSOSEG_LOC_UNMAPTSO,
1455 	TSOSEG_LOC_UNMAPLAST,
1456 	TSOSEG_LOC_FORCE_FREE,
1457 };
1458 
1459 #ifdef TSOSEG_DEBUG
1460 /*
1461  * WARNING: Don't change the history size without changing the wrap
1462  *  code in qdf_tso_seg_dbg_record function
1463  */
1464 #define MAX_TSO_SEG_ACT_HISTORY 16
1465 struct qdf_tso_seg_dbg_history_t {
1466 	uint64_t ts;
1467 	short    id;
1468 };
1469 struct qdf_tso_seg_dbg_t {
1470 	void    *txdesc;  /* owner - (ol_txrx_tx_desc_t *) */
1471 	qdf_atomic_t cur; /* index of last valid entry */
1472 	struct qdf_tso_seg_dbg_history_t h[MAX_TSO_SEG_ACT_HISTORY];
1473 };
1474 #endif /* TSOSEG_DEBUG */
1475 
1476 /**
1477  * struct qdf_tso_seg_elem_t - tso segment element
1478  * @next: pointer to the next segment
1479  * @seg: instance of segment
1480  * @cookie:
1481  * @on_freelist:
1482  * @sent_to_target:
1483  * @force_free:
1484  * @dbg: debug struct
1485  */
1486 struct qdf_tso_seg_elem_t {
1487 	struct qdf_tso_seg_elem_t *next;
1488 	struct qdf_tso_seg_t seg;
1489 	uint32_t cookie:13,
1490 		on_freelist:1,
1491 		sent_to_target:1,
1492 		force_free:1;
1493 #ifdef TSOSEG_DEBUG
1494 	struct qdf_tso_seg_dbg_t dbg;
1495 #endif /* TSOSEG_DEBUG */
1496 };
1497 
1498 /**
1499  * struct qdf_tso_num_seg_t - single element to count for num of seg
1500  * @tso_cmn_num_seg: num of seg in a jumbo skb
1501  *
1502  * This structure holds the information of num of segments of a jumbo
1503  * TSO network buffer.
1504  */
1505 struct qdf_tso_num_seg_t {
1506 	uint32_t tso_cmn_num_seg;
1507 };
1508 
1509 /**
1510  * struct qdf_tso_num_seg_elem_t - num of tso segment element for jumbo skb
1511  * @next: pointer to the next segment
1512  * @num_seg: instance of num of seg
1513  */
1514 struct qdf_tso_num_seg_elem_t {
1515 	struct qdf_tso_num_seg_elem_t *next;
1516 	struct qdf_tso_num_seg_t num_seg;
1517 };
1518 
1519 /**
1520  * struct qdf_tso_info_t - TSO information extracted
1521  * @is_tso: is this is a TSO frame
1522  * @num_segs: number of segments
1523  * @tso_seg_list: list of TSO segments for this jumbo packet
1524  * @curr_seg: segment that is currently being processed
1525  * @tso_num_seg_list: num of tso seg for this jumbo packet
1526  * @msdu_stats_idx: msdu index for tso stats
1527  *
1528  * This structure holds the TSO information extracted after parsing the TSO
1529  * jumbo network buffer. It contains a chain of the TSO segments belonging to
1530  * the jumbo packet
1531  */
1532 struct qdf_tso_info_t {
1533 	uint8_t is_tso;
1534 	uint32_t num_segs;
1535 	struct qdf_tso_seg_elem_t *tso_seg_list;
1536 	struct qdf_tso_seg_elem_t *curr_seg;
1537 	struct qdf_tso_num_seg_elem_t *tso_num_seg_list;
1538 	uint32_t msdu_stats_idx;
1539 };
1540 
1541 /**
1542  * enum qdf_suspend_type - type of suspend
1543  * @QDF_SYSTEM_SUSPEND: System suspend triggered wlan suspend
1544  * @QDF_RUNTIME_SUSPEND: Runtime pm inactivity timer triggered wlan suspend
1545  * @QDF_UNIT_TEST_WOW_SUSPEND: WoW unit test suspend
1546  */
1547 enum qdf_suspend_type {
1548 	QDF_SYSTEM_SUSPEND,
1549 	QDF_RUNTIME_SUSPEND,
1550 	QDF_UNIT_TEST_WOW_SUSPEND
1551 };
1552 
1553 /**
1554  * enum qdf_hang_reason - host hang/ssr reason
1555  * @QDF_REASON_UNSPECIFIED: Unspecified reason
1556  * @QDF_RX_HASH_NO_ENTRY_FOUND: No Map for the MAC entry for the received frame
1557  * @QDF_PEER_DELETION_TIMEDOUT: peer deletion timeout happened
1558  * @QDF_PEER_UNMAP_TIMEDOUT: peer unmap timeout
1559  * @QDF_SCAN_REQ_EXPIRED: Scan request timed out
1560  * @QDF_SCAN_ATTEMPT_FAILURES: Consecutive Scan attempt failures
1561  * @QDF_GET_MSG_BUFF_FAILURE: Unable to get the message buffer
1562  * @QDF_ACTIVE_LIST_TIMEOUT: Current command processing is timedout
1563  * @QDF_SUSPEND_TIMEOUT: Timeout for an ACK from FW for suspend request
1564  * @QDF_RESUME_TIMEOUT: Timeout for an ACK from FW for resume request
1565  * @QDF_WMI_EXCEED_MAX_PENDING_CMDS: wmi exceed max pending cmd
1566  * @QDF_AP_STA_CONNECT_REQ_TIMEOUT: SAP peer assoc timeout from FW
1567  * @QDF_STA_AP_CONNECT_REQ_TIMEOUT: STA peer assoc timeout from FW
1568  * @QDF_MAC_HW_MODE_CHANGE_TIMEOUT: HW mode change timeout from FW
1569  * @QDF_MAC_HW_MODE_CONFIG_TIMEOUT: HW dual mac cfg timeout from FW
1570  * @QDF_VDEV_START_RESPONSE_TIMED_OUT: Start response timeout from FW
1571  * @QDF_VDEV_RESTART_RESPONSE_TIMED_OUT: Restart response timeout from FW
1572  * @QDF_VDEV_STOP_RESPONSE_TIMED_OUT: Stop response timeout from FW
1573  * @QDF_VDEV_DELETE_RESPONSE_TIMED_OUT: Delete response timeout from FW
1574  * @QDF_VDEV_PEER_DELETE_ALL_RESPONSE_TIMED_OUT: Peer delete all resp timeout
1575  * @QDF_WMI_BUF_SEQUENCE_MISMATCH: WMI Tx completion buffer sequence mismatch
1576  * @QDF_HAL_REG_WRITE_FAILURE: HAL register writing failures
1577  * @QDF_SUSPEND_NO_CREDIT: host lack of credit after suspend
1578  * @QCA_HANG_BUS_FAILURE: Bus failure
1579  * @QDF_TASKLET_CREDIT_LATENCY_DETECT: tasklet or credit latency happened
1580  * @QDF_RX_REG_PKT_ROUTE_ERR: MSDU buf errors exceed thresh in REO err path
1581  * @QDF_VDEV_SM_OUT_OF_SYNC: Vdev SM is out of sync and connect req received
1582  * when already connected
1583  * @QDF_STATS_REQ_TIMEDOUT: Stats request timedout
1584  * @QDF_TX_DESC_LEAK: tx desc leak
1585  * @QDF_HOST_WAKEUP_REASON_PAGEFAULT: Host wakeup because of pagefault
1586  * @QDF_SCHED_TIMEOUT: Scheduler watchdog timedout
1587  * @QDF_SELF_PEER_DEL_FAILED: Failed to send self peer deletion cmd to fw
1588  * @QDF_DEL_SELF_STA_FAILED: Received del self sta without del bss
1589  * @QDF_FLUSH_LOGS : Recovery needed when sending flush completion to userspace
1590  * @QDF_WMI_CMD_SENT_DURING_SUSPEND: WMI command is received when target is
1591  * suspended
1592  */
1593 enum qdf_hang_reason {
1594 	QDF_REASON_UNSPECIFIED,
1595 	QDF_RX_HASH_NO_ENTRY_FOUND,
1596 	QDF_PEER_DELETION_TIMEDOUT,
1597 	QDF_PEER_UNMAP_TIMEDOUT,
1598 	QDF_SCAN_REQ_EXPIRED,
1599 	QDF_SCAN_ATTEMPT_FAILURES,
1600 	QDF_GET_MSG_BUFF_FAILURE,
1601 	QDF_ACTIVE_LIST_TIMEOUT,
1602 	QDF_SUSPEND_TIMEOUT,
1603 	QDF_RESUME_TIMEOUT,
1604 	QDF_WMI_EXCEED_MAX_PENDING_CMDS,
1605 	QDF_AP_STA_CONNECT_REQ_TIMEOUT,
1606 	QDF_STA_AP_CONNECT_REQ_TIMEOUT,
1607 	QDF_MAC_HW_MODE_CHANGE_TIMEOUT,
1608 	QDF_MAC_HW_MODE_CONFIG_TIMEOUT,
1609 	QDF_VDEV_START_RESPONSE_TIMED_OUT,
1610 	QDF_VDEV_RESTART_RESPONSE_TIMED_OUT,
1611 	QDF_VDEV_STOP_RESPONSE_TIMED_OUT,
1612 	QDF_VDEV_DELETE_RESPONSE_TIMED_OUT,
1613 	QDF_VDEV_PEER_DELETE_ALL_RESPONSE_TIMED_OUT,
1614 	QDF_WMI_BUF_SEQUENCE_MISMATCH,
1615 	QDF_HAL_REG_WRITE_FAILURE,
1616 	QDF_SUSPEND_NO_CREDIT,
1617 	QCA_HANG_BUS_FAILURE,
1618 	QDF_TASKLET_CREDIT_LATENCY_DETECT,
1619 	QDF_RX_REG_PKT_ROUTE_ERR,
1620 	QDF_VDEV_SM_OUT_OF_SYNC,
1621 	QDF_STATS_REQ_TIMEDOUT,
1622 	QDF_TX_DESC_LEAK,
1623 	QDF_HOST_WAKEUP_REASON_PAGEFAULT,
1624 	QDF_SCHED_TIMEOUT,
1625 	QDF_SELF_PEER_DEL_FAILED,
1626 	QDF_DEL_SELF_STA_FAILED,
1627 	QDF_FLUSH_LOGS,
1628 	QDF_WMI_CMD_SENT_DURING_SUSPEND,
1629 };
1630 
1631 /**
1632  * enum qdf_stats_verbosity_level - Verbosity levels for stats
1633  * for which want to have different levels
1634  * @QDF_STATS_VERBOSITY_LEVEL_LOW: Stats verbosity level low
1635  * @QDF_STATS_VERBOSITY_LEVEL_HIGH: Stats verbosity level high
1636  */
1637 enum qdf_stats_verbosity_level {
1638 	QDF_STATS_VERBOSITY_LEVEL_LOW,
1639 	QDF_STATS_VERBOSITY_LEVEL_HIGH
1640 };
1641 
1642 /**
1643  * enum qdf_clock_id - The clock IDs of the various system clocks
1644  * @QDF_CLOCK_REALTIME: Clock is close to current time of day
1645  * @QDF_CLOCK_MONOTONIC: Clock is absolute elapsed time
1646  */
1647 enum qdf_clock_id {
1648 	QDF_CLOCK_REALTIME = __QDF_CLOCK_REALTIME,
1649 	QDF_CLOCK_MONOTONIC = __QDF_CLOCK_MONOTONIC
1650 };
1651 
1652 /**
1653  * enum qdf_hrtimer_mode - Mode arguments of qdf_hrtimer_data_t
1654  * related functions
1655  * @QDF_HRTIMER_MODE_ABS: Time value is absolute
1656  * @QDF_HRTIMER_MODE_REL: Time value is relative to now
1657  * @QDF_HRTIMER_MODE_PINNED: Timer is bound to CPU
1658  */
1659 enum qdf_hrtimer_mode {
1660 	QDF_HRTIMER_MODE_ABS = __QDF_HRTIMER_MODE_ABS,
1661 	QDF_HRTIMER_MODE_REL = __QDF_HRTIMER_MODE_REL,
1662 	QDF_HRTIMER_MODE_PINNED =  __QDF_HRTIMER_MODE_PINNED,
1663 };
1664 
1665 /**
1666  * enum qdf_hrtimer_restart_status - Return values for the
1667  * qdf_hrtimer_data_t callback function
1668  * @QDF_HRTIMER_NORESTART: Timer is not restarted
1669  * @QDF_HRTIMER_RESTART: Timer must be restarted
1670  */
1671 enum qdf_hrtimer_restart_status {
1672 	QDF_HRTIMER_NORESTART = __QDF_HRTIMER_NORESTART,
1673 	QDF_HRTIMER_RESTART = __QDF_HRTIMER_RESTART,
1674 };
1675 
1676 /**
1677  * enum qdf_context_mode - Values for the
1678  * hrtimer context
1679  * @QDF_CONTEXT_HARDWARE: Runs in hw interrupt context
1680  * @QDF_CONTEXT_TASKLET: Runs in tasklet context
1681  */
1682 enum qdf_context_mode {
1683 	QDF_CONTEXT_HARDWARE = 0,
1684 	QDF_CONTEXT_TASKLET = 1,
1685 };
1686 
1687 /**
1688  * enum qdf_dp_tx_rx_status - TX/RX packet status
1689  * @QDF_TX_RX_STATUS_INVALID: default invalid status
1690  * @QDF_TX_RX_STATUS_OK: successfully sent + acked
1691  * @QDF_TX_RX_STATUS_FW_DISCARD: queued but not sent over air
1692  * @QDF_TX_RX_STATUS_NO_ACK: packet sent but no ack received
1693  * @QDF_TX_RX_STATUS_DROP: packet dropped due to congestion
1694  * @QDF_TX_RX_STATUS_DOWNLOAD_SUCC: packet delivered to target
1695  * @QDF_TX_RX_STATUS_DEFAULT: default status
1696  * @QDF_TX_RX_STATUS_MAX:
1697  */
1698 enum qdf_dp_tx_rx_status {
1699 	QDF_TX_RX_STATUS_INVALID,
1700 	QDF_TX_RX_STATUS_OK,
1701 	QDF_TX_RX_STATUS_FW_DISCARD,
1702 	QDF_TX_RX_STATUS_NO_ACK,
1703 	QDF_TX_RX_STATUS_DROP,
1704 	QDF_TX_RX_STATUS_DOWNLOAD_SUCC,
1705 	QDF_TX_RX_STATUS_DEFAULT,
1706 	QDF_TX_RX_STATUS_MAX
1707 };
1708 
1709 /**
1710  * enum qdf_pkt_type - TX/RX packet type
1711  * @QDF_TX_MGMT_PKT: Tx Management Packet
1712  * @QDF_TX_DATA_PKT: Tx data Packet
1713  * @QDF_RX_MGMT_PKT: Rx Management Packet
1714  * @QDF_RX_DATA_PKT: Rx data Packet
1715  * @QDF_INVALID_PKT: Invalid Packet type
1716  */
1717 enum qdf_pkt_type {
1718 	QDF_TX_MGMT_PKT,
1719 	QDF_TX_DATA_PKT,
1720 	QDF_RX_MGMT_PKT,
1721 	QDF_RX_DATA_PKT,
1722 	QDF_INVALID_PKT
1723 };
1724 
1725 /**
1726  * enum qdf_dp_a_status - A_STATUS
1727  * @QDF_A_STATUS_ERROR: Generic error return
1728  * @QDF_A_STATUS_OK: success
1729  */
1730 enum qdf_dp_a_status {
1731 	QDF_A_STATUS_ERROR = -1,
1732 	QDF_A_STATUS_OK,
1733 };
1734 
1735 /**
1736  * enum qdf_iommu_attr- qdf iommu domain attribute
1737  * @QDF_DOMAIN_ATTR_GEOMETRY: Domain attribute geometry
1738  * @QDF_DOMAIN_ATTR_PAGING: Domain attribute paging
1739  * @QDF_DOMAIN_ATTR_WINDOWS: Domain attribute windows
1740  * @QDF_DOMAIN_ATTR_FSL_PAMU_STASH: Domain attribute fsl pamu stash
1741  * @QDF_DOMAIN_ATTR_FSL_PAMU_ENABLE: Domain attribute fsl pamu enable
1742  * @QDF_DOMAIN_ATTR_FSL_PAMUV1: Domain attribute fsl pamu v1
1743  * @QDF_DOMAIN_ATTR_NESTING: Domain attribute Nesting
1744  * @QDF_DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE: Domain attribute dma use flush queue
1745  * @QDF_DOMAIN_ATTR_CONTEXT_BANK: Domain attribute context bank
1746  * @QDF_DOMAIN_ATTR_NON_FATAL_FAULTS: Domain attribute non fatal faults
1747  * @QDF_DOMAIN_ATTR_S1_BYPASS: Domain attribute S1 bypass
1748  * @QDF_DOMAIN_ATTR_ATOMIC: Domain attribute atomic
1749  * @QDF_DOMAIN_ATTR_SECURE_VMID: Domain attribute secure cmid
1750  * @QDF_DOMAIN_ATTR_FAST: Domain attribute fast
1751  * @QDF_DOMAIN_ATTR_PGTBL_INFO: Domain attribute pgtbl info
1752  * @QDF_DOMAIN_ATTR_USE_UPSTREAM_HINT: Domain attribute use upstream hint
1753  * @QDF_DOMAIN_ATTR_EARLY_MAP: Domain attribute early map
1754  * @QDF_DOMAIN_ATTR_PAGE_TABLE_IS_COHERENT: Domain attribute page table
1755  * is coherrent
1756  * @QDF_DOMAIN_ATTR_PAGE_TABLE_FORCE_COHERENT: Domain attribute page table
1757  * force coherrent
1758  * @QDF_DOMAIN_ATTR_USE_LLC_NWA: Domain attribute use llc nwa
1759  * @QDF_DOMAIN_ATTR_SPLIT_TABLES: Domain attribute split tables
1760  * @QDF_DOMAIN_ATTR_FAULT_MODEL_NO_CFRE: Domain attribute fault model no cfre
1761  * @QDF_DOMAIN_ATTR_FAULT_MODEL_NO_STALL: Domain attribute fault model no stall
1762  * @QDF_DOMAIN_ATTR_FAULT_MODEL_HUPCF: Domain attribute fault model hupcf
1763  * @QDF_DOMAIN_ATTR_MAX: Domain attribute max
1764  */
1765 enum qdf_iommu_attr {
1766 	QDF_DOMAIN_ATTR_GEOMETRY,
1767 	QDF_DOMAIN_ATTR_PAGING,
1768 	QDF_DOMAIN_ATTR_WINDOWS,
1769 	QDF_DOMAIN_ATTR_FSL_PAMU_STASH,
1770 	QDF_DOMAIN_ATTR_FSL_PAMU_ENABLE,
1771 	QDF_DOMAIN_ATTR_FSL_PAMUV1,
1772 	QDF_DOMAIN_ATTR_NESTING,
1773 	QDF_DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE,
1774 	QDF_DOMAIN_ATTR_CONTEXT_BANK,
1775 	QDF_DOMAIN_ATTR_NON_FATAL_FAULTS,
1776 	QDF_DOMAIN_ATTR_S1_BYPASS,
1777 	QDF_DOMAIN_ATTR_ATOMIC,
1778 	QDF_DOMAIN_ATTR_SECURE_VMID,
1779 	QDF_DOMAIN_ATTR_FAST,
1780 	QDF_DOMAIN_ATTR_PGTBL_INFO,
1781 	QDF_DOMAIN_ATTR_USE_UPSTREAM_HINT,
1782 	QDF_DOMAIN_ATTR_EARLY_MAP,
1783 	QDF_DOMAIN_ATTR_PAGE_TABLE_IS_COHERENT,
1784 	QDF_DOMAIN_ATTR_PAGE_TABLE_FORCE_COHERENT,
1785 	QDF_DOMAIN_ATTR_USE_LLC_NWA,
1786 	QDF_DOMAIN_ATTR_SPLIT_TABLES,
1787 	QDF_DOMAIN_ATTR_FAULT_MODEL_NO_CFRE,
1788 	QDF_DOMAIN_ATTR_FAULT_MODEL_NO_STALL,
1789 	QDF_DOMAIN_ATTR_FAULT_MODEL_HUPCF,
1790 	QDF_DOMAIN_ATTR_MAX,
1791 };
1792 
1793 #endif /* __QDF_TYPES_H */
1794