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