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