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