xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_types.h (revision 11f5a63a6cbdda84849a730de22f0a71e635d58c)
1 /*
2  * Copyright (c) 2014-2019 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /**
20  * DOC: qdf_types.h
21  * QCA driver framework (QDF) basic type definitions
22  */
23 
24 #if !defined(__QDF_TYPES_H)
25 #define __QDF_TYPES_H
26 
27 #define qdf_must_check __qdf_must_check
28 
29 /* Include Files */
30 #include <i_qdf_types.h>
31 #include <stdarg.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 /**
41  * struct qdf_sglist - scatter-gather list
42  * @nsegs: total number of segments
43  * struct __sg_segs - scatter-gather segment list
44  * @vaddr: Virtual address of the segment
45  * @len: Length of the segment
46  */
47 typedef struct qdf_sglist {
48 	uint32_t nsegs;
49 	struct __sg_segs {
50 		uint8_t  *vaddr;
51 		uint32_t len;
52 	} sg_segs[QDF_MAX_SGLIST];
53 } qdf_sglist_t;
54 
55 #define QDF_MAX_SCATTER __QDF_MAX_SCATTER
56 #define QDF_NSEC_PER_MSEC __QDF_NSEC_PER_MSEC
57 
58 /**
59  * QDF_SWAP_U16 - swap input u16 value
60  * @_x: variable to swap
61  */
62 #define QDF_SWAP_U16(_x) \
63 	((((_x) << 8) & 0xFF00) | (((_x) >> 8) & 0x00FF))
64 
65 /**
66  * QDF_SWAP_U32 - swap input u32 value
67  * @_x: variable to swap
68  */
69 #define QDF_SWAP_U32(_x) \
70 	(((((_x) << 24) & 0xFF000000) | (((_x) >> 24) & 0x000000FF)) | \
71 	 ((((_x) << 8) & 0x00FF0000) | (((_x) >> 8) & 0x0000FF00)))
72 
73 /* ticks per second */
74 #define QDF_TICKS_PER_SECOND (1000)
75 
76 /**
77  * QDF_ARRAY_SIZE - get array size
78  * @_arr: array variable name
79  */
80 #define QDF_ARRAY_SIZE(_arr) (sizeof(_arr) / sizeof((_arr)[0]))
81 
82 #define QDF_MAX_SCATTER __QDF_MAX_SCATTER
83 
84 /**
85  * qdf_packed - denotes structure is packed.
86  */
87 #define qdf_packed __qdf_packed
88 
89 /**
90  * qdf_toupper - char lower to upper.
91  */
92 #define qdf_toupper __qdf_toupper
93 
94 typedef void *qdf_net_handle_t;
95 
96 typedef void *qdf_netlink_handle_t;
97 typedef void *qdf_drv_handle_t;
98 typedef void *qdf_os_handle_t;
99 typedef void *qdf_pm_t;
100 
101 
102 /**
103  * typedef qdf_handle_t - handles opaque to each other
104  */
105 typedef void *qdf_handle_t;
106 
107 /**
108  * typedef qdf_device_t - Platform/bus generic handle.
109  * Used for bus specific functions.
110  */
111 typedef __qdf_device_t qdf_device_t;
112 
113 /* Byte order identifiers */
114 typedef __qdf_le16_t qdf_le16_t;
115 typedef __qdf_le32_t qdf_le32_t;
116 typedef __qdf_le64_t qdf_le64_t;
117 typedef __qdf_be16_t qdf_be16_t;
118 typedef __qdf_be32_t qdf_be32_t;
119 typedef __qdf_be64_t qdf_be64_t;
120 
121 /**
122  * typedef qdf_size_t - size of an object
123  */
124 typedef __qdf_size_t qdf_size_t;
125 
126 /**
127  * typedef __qdf_off_t - offset for API's that need them.
128  */
129 typedef __qdf_off_t      qdf_off_t;
130 
131 /**
132  * typedef qdf_dma_map_t - DMA mapping object.
133  */
134 typedef __qdf_dma_map_t qdf_dma_map_t;
135 
136 /**
137  * tyepdef qdf_dma_addr_t - DMA address.
138  */
139 typedef __qdf_dma_addr_t qdf_dma_addr_t;
140 
141 /**
142  * typedef __qdf_dma_size_t - DMA size.
143  */
144 typedef __qdf_dma_size_t     qdf_dma_size_t;
145 
146 /**
147  * tyepdef qdf_dma_context_t - DMA context.
148  */
149 typedef __qdf_dma_context_t qdf_dma_context_t;
150 
151 typedef __qdf_mem_info_t qdf_mem_info_t;
152 typedef __sgtable_t sgtable_t;
153 
154 /**
155  * typepdef qdf_cpu_mask - CPU Mask
156  */
157 typedef __qdf_cpu_mask qdf_cpu_mask;
158 
159 /**
160  * pointer to net device
161  */
162 typedef __qdf_netdev_t qdf_netdev_t;
163 
164 /**
165  * struct qdf_dma_map_info - Information inside a DMA map.
166  * @nsegs: total number mapped segments
167  * struct __dma_segs - Information of physical address.
168  * @paddr: physical(dam'able) address of the segment
169  * @len: length of the segment
170  */
171 typedef struct qdf_dma_map_info {
172 	uint32_t nsegs;
173 	struct __dma_segs {
174 		qdf_dma_addr_t paddr;
175 		qdf_dma_size_t len;
176 	} dma_segs[QDF_MAX_SCATTER];
177 } qdf_dmamap_info_t;
178 
179 /**
180  * struct qdf_shared_mem - Shared memory resource
181  * @mem_info: memory info struct
182  * @vaddr: virtual address
183  * @sgtable: scatter-gather table
184  * @memctx: dma address
185  */
186 typedef struct qdf_shared_mem {
187 	qdf_mem_info_t mem_info;
188 	void *vaddr;
189 	sgtable_t sgtable;
190 	qdf_dma_mem_context(memctx);
191 } qdf_shared_mem_t;
192 
193 #define qdf_iomem_t __qdf_iomem_t;
194 
195 /**
196  * typedef enum QDF_TIMER_TYPE - QDF timer type
197  * @QDF_TIMER_TYPE_SW: Deferrable SW timer it will not cause CPU to wake up
198  * on expiry
199  * @QDF_TIMER_TYPE_WAKE_APPS: Non deferrable timer which will cause CPU to
200  * wake up on expiry
201  */
202 typedef enum {
203 	QDF_TIMER_TYPE_SW,
204 	QDF_TIMER_TYPE_WAKE_APPS
205 } QDF_TIMER_TYPE;
206 
207 /**
208  * tyepdef qdf_resource_type_t - hw resources
209  * @QDF_RESOURCE_TYPE_MEM: memory resource
210  * @QDF_RESOURCE_TYPE_IO: io resource
211  * Define the hw resources the OS has allocated for the device
212  * Note that start defines a mapped area.
213  */
214 typedef enum {
215 	QDF_RESOURCE_TYPE_MEM,
216 	QDF_RESOURCE_TYPE_IO,
217 } qdf_resource_type_t;
218 
219 /**
220  * tyepdef qdf_resource_t - representation of a h/w resource.
221  * @start: start
222  * @end: end
223  * @type: resource type
224  */
225 typedef struct {
226 	uint64_t start;
227 	uint64_t end;
228 	qdf_resource_type_t type;
229 } qdf_resource_t;
230 
231 /**
232  * typedef qdf_dma_dir_t - DMA directions
233  * @QDF_DMA_BIDIRECTIONAL: bidirectional data
234  * @QDF_DMA_TO_DEVICE: data going from device to memory
235  * @QDF_DMA_FROM_DEVICE: data going from memory to device
236  */
237 typedef enum {
238 	QDF_DMA_BIDIRECTIONAL = __QDF_DMA_BIDIRECTIONAL,
239 	QDF_DMA_TO_DEVICE = __QDF_DMA_TO_DEVICE,
240 	QDF_DMA_FROM_DEVICE = __QDF_DMA_FROM_DEVICE,
241 } qdf_dma_dir_t;
242 
243 /**
244  * enum qdf_driver_type - Indicate the driver type and based on this
245  * do appropriate initialization.
246  *
247  * @QDF_DRIVER_TYPE_PRODUCTION: Driver used in the production
248  * @QDF_DRIVER_TYPE_MFG: Driver used in the Factory
249  * @QDF_DRIVER_TYPE_INVALID: Invalid and unrecognized type
250  *
251  */
252 enum qdf_driver_type {
253 	QDF_DRIVER_TYPE_PRODUCTION = 0,
254 	QDF_DRIVER_TYPE_MFG = 1,
255 	QDF_DRIVER_TYPE_INVALID = 0x7FFFFFFF
256 };
257 
258 /* work queue(kernel thread)/DPC function callback */
259 typedef void (*qdf_defer_fn_t)(void *);
260 
261 /*
262  * Prototype of the critical region function that is to be
263  * executed with spinlock held and interrupt disalbed
264  */
265 typedef bool (*qdf_irqlocked_func_t)(void *);
266 
267 #define qdf_offsetof(type, field) offsetof(type, field)
268 
269 /**
270  * typedef enum QDF_MODULE_ID  - Debug category level
271  * @QDF_MODULE_ID_MIN: The smallest/starting module id
272  * @QDF_MODULE_ID_TDLS: TDLS
273  * @QDF_MODULE_ID_ACS: auto channel selection
274  * @QDF_MODULE_ID_SCAN_SM: scan state machine
275  * @QDF_MODULE_ID_SCANENTRY: scan entry
276  * @QDF_MODULE_ID_WDS: WDS handling
277  * @QDF_MODULE_ID_ACTION: action management frames
278  * @QDF_MODULE_ID_ROAM: sta mode roaming
279  * @QDF_MODULE_ID_INACT: inactivity handling
280  * @QDF_MODULE_ID_DOTH: 11.h
281  * @QDF_MODULE_ID_IQUE: IQUE features
282  * @QDF_MODULE_ID_WME: WME protocol
283  * @QDF_MODULE_ID_ACL: ACL handling
284  * @QDF_MODULE_ID_WPA: WPA/RSN protocol
285  * @QDF_MODULE_ID_RADKEYS: dump 802.1x keys
286  * @QDF_MODULE_ID_RADDUMP: dump 802.1x radius packets
287  * @QDF_MODULE_ID_RADIUS: 802.1x radius client
288  * @QDF_MODULE_ID_DOT1XSM: 802.1x state machine
289  * @QDF_MODULE_ID_DOT1X: 802.1x authenticator
290  * @QDF_MODULE_ID_POWER: power save handling
291  * @QDF_MODULE_ID_STATS: state machine
292  * @QDF_MODULE_ID_OUTPUT: output handling
293  * @QDF_MODULE_ID_SCAN: scanning
294  * @QDF_MODULE_ID_AUTH: authentication handling
295  * @QDF_MODULE_ID_ASSOC: association handling
296  * @QDF_MODULE_ID_NODE: node handling
297  * @QDF_MODULE_ID_ELEMID: element id parsing
298  * @QDF_MODULE_ID_XRATE: rate set handling
299  * @QDF_MODULE_ID_INPUT: input handling
300  * @QDF_MODULE_ID_CRYPTO: crypto work
301  * @QDF_MODULE_ID_DUMPPKTS: IFF_LINK2 equivalant
302  * @QDF_MODULE_ID_DEBUG: IFF_DEBUG equivalent
303  * @QDF_MODULE_ID_MLME: MLME
304  * @QDF_MODULE_ID_RRM: Radio resource measurement
305  * @QDF_MODULE_ID_WNM: Wireless Network Management
306  * @QDF_MODULE_ID_P2P_PROT: P2P Protocol driver
307  * @QDF_MODULE_ID_PROXYARP: 11v Proxy ARP
308  * @QDF_MODULE_ID_L2TIF: Hotspot 2.0 L2 TIF
309  * @QDF_MODULE_ID_WIFIPOS: WifiPositioning Feature
310  * @QDF_MODULE_ID_WRAP: WRAP or Wireless ProxySTA
311  * @QDF_MODULE_ID_DFS: DFS debug mesg
312  * @QDF_MODULE_ID_TLSHIM: TLSHIM module ID
313  * @QDF_MODULE_ID_WMI: WMI module ID
314  * @QDF_MODULE_ID_HTT: HTT module ID
315  * @QDF_MODULE_ID_HDD: HDD module ID
316  * @QDF_MODULE_ID_SME: SME module ID
317  * @QDF_MODULE_ID_PE: PE module ID
318  * @QDF_MODULE_ID_WMA: WMA module ID
319  * @QDF_MODULE_ID_SYS: SYS module ID
320  * @QDF_MODULE_ID_QDF: QDF module ID
321  * @QDF_MODULE_ID_SAP: SAP module ID
322  * @QDF_MODULE_ID_HDD_SOFTAP: HDD SAP module ID
323  * @QDF_MODULE_ID_HDD_DATA: HDD DATA module ID
324  * @QDF_MODULE_ID_HDD_SAP_DATA: HDD SAP DATA module ID
325  * @QDF_MODULE_ID_HIF: HIF module ID
326  * @QDF_MODULE_ID_HTC: HTC module ID
327  * @QDF_MODULE_ID_TXRX: TXRX module ID
328  * @QDF_MODULE_ID_QDF_DEVICE: QDF DEVICE module ID
329  * @QDF_MODULE_ID_CFG: CFG module ID
330  * @QDF_MODULE_ID_BMI: BMI module ID
331  * @QDF_MODULE_ID_EPPING: EPPING module ID
332  * @QDF_MODULE_ID_QVIT: QVIT module ID
333  * @QDF_MODULE_ID_DP: Data-path module ID
334  * @QDF_MODULE_ID_HAL: Hal abstraction module ID
335  * @QDF_MODULE_ID_SOC: SOC module ID
336  * @QDF_MODULE_ID_OS_IF: OS-interface module ID
337  * @QDF_MODULE_ID_TARGET_IF: targer interface module ID
338  * @QDF_MODULE_ID_SCHEDULER: schduler module ID
339  * @QDF_MODULE_ID_MGMT_TXRX: management TX/RX module ID
340  * @QDF_MODULE_ID_SERIALIZATION: serialization module ID
341  * @QDF_MODULE_ID_PMO: PMO (power manager and offloads) Module ID
342  * @QDF_MODULE_ID_P2P: P2P module ID
343  * @QDF_MODULE_ID_POLICY_MGR: Policy Manager module ID
344  * @QDF_MODULE_ID_CONFIG: CFG (configuration) component ID
345  * @QDF_MODULE_ID_REGULATORY: REGULATORY module ID
346  * @QDF_MODULE_ID_NAN: NAN module ID
347  * @QDF_MODULE_ID_SPECTRAL: Spectral module ID
348  * @QDF_MODULE_ID_ROAM_DEBUG: Roam Debug logging
349  * @QDF_MODULE_ID_CDP: Converged Data Path module ID
350  * @QDF_MODULE_ID_DIRECT_BUF_RX: Direct Buffer Receive module ID
351  * @QDF_MODULE_ID_DISA: DISA (encryption test) module ID
352  * @QDF_MODULE_ID_GREEN_AP: Green AP related logging
353  * @QDF_MODULE_ID_FTM: FTM module ID
354  * @QDF_MODULE_ID_EXTAP: Extender AP module ID
355  * @QDF_MODULE_ID_FD: FILS discovery logging
356  * @QDF_MODULE_ID_OCB: OCB module ID
357  * @QDF_MODULE_ID_IPA: IPA module ID
358  * @QDF_MODULE_ID_CP_STATS: Control Plane Statistics ID
359  * @QDF_MODULE_ID_ACTION_OUI: ACTION OUI module ID
360  * @QDF_MODULE_ID_TARGET: Target module ID
361  * @QDF_MODULE_ID_MBSSIE: MBSS IE ID
362  * @QDF_MODULE_ID_FWOL: FW Offload module ID
363  * @QDF_MODULE_ID_SM_ENGINE: SM engine module ID
364  * @QDF_MODULE_ID_CMN_MLME: CMN MLME module ID
365  * @QDF_MODULE_ID_CFR: CFR module ID
366  * @QDF_MODULE_ID_TX_CAPTURE: Tx capture enhancement feature ID
367  * @QDF_MODULE_ID_INTEROP_ISSUES_AP: interop issues ap module ID
368  * @QDF_MODULE_ID_BLACKLIST_MGR: Blacklist Manager module
369  * @QDF_MODULE_ID_QLD: QCA Live Debug module ID
370  * @QDF_MODULE_ID_DYNAMIC_MODE_CHG: Dynamic mode change module ID
371  * @QDF_MODULE_ID_ANY: anything
372  * @QDF_MODULE_ID_MAX: Max place holder module ID
373  */
374 typedef enum {
375 	QDF_MODULE_ID_MIN       = 0,
376 	QDF_MODULE_ID_TDLS      = QDF_MODULE_ID_MIN,
377 	QDF_MODULE_ID_ACS,
378 	QDF_MODULE_ID_SCAN_SM,
379 	QDF_MODULE_ID_SCANENTRY,
380 	QDF_MODULE_ID_WDS,
381 	QDF_MODULE_ID_ACTION,
382 	QDF_MODULE_ID_ROAM,
383 	QDF_MODULE_ID_INACT,
384 	QDF_MODULE_ID_DOTH      = 8,
385 	QDF_MODULE_ID_IQUE,
386 	QDF_MODULE_ID_WME,
387 	QDF_MODULE_ID_ACL,
388 	QDF_MODULE_ID_WPA,
389 	QDF_MODULE_ID_RADKEYS,
390 	QDF_MODULE_ID_RADDUMP,
391 	QDF_MODULE_ID_RADIUS,
392 	QDF_MODULE_ID_DOT1XSM   = 16,
393 	QDF_MODULE_ID_DOT1X,
394 	QDF_MODULE_ID_POWER,
395 	QDF_MODULE_ID_STATE,
396 	QDF_MODULE_ID_OUTPUT,
397 	QDF_MODULE_ID_SCAN,
398 	QDF_MODULE_ID_AUTH,
399 	QDF_MODULE_ID_ASSOC,
400 	QDF_MODULE_ID_NODE      = 24,
401 	QDF_MODULE_ID_ELEMID,
402 	QDF_MODULE_ID_XRATE,
403 	QDF_MODULE_ID_INPUT,
404 	QDF_MODULE_ID_CRYPTO,
405 	QDF_MODULE_ID_DUMPPKTS,
406 	QDF_MODULE_ID_DEBUG,
407 	QDF_MODULE_ID_MLME,
408 	QDF_MODULE_ID_RRM       = 32,
409 	QDF_MODULE_ID_WNM,
410 	QDF_MODULE_ID_P2P_PROT,
411 	QDF_MODULE_ID_PROXYARP,
412 	QDF_MODULE_ID_L2TIF,
413 	QDF_MODULE_ID_WIFIPOS,
414 	QDF_MODULE_ID_WRAP,
415 	QDF_MODULE_ID_DFS,
416 	QDF_MODULE_ID_ATF       = 40,
417 	QDF_MODULE_ID_SPLITMAC,
418 	QDF_MODULE_ID_IOCTL,
419 	QDF_MODULE_ID_NAC,
420 	QDF_MODULE_ID_MESH,
421 	QDF_MODULE_ID_MBO,
422 	QDF_MODULE_ID_EXTIOCTL_CHANSWITCH,
423 	QDF_MODULE_ID_EXTIOCTL_CHANSSCAN,
424 	QDF_MODULE_ID_TLSHIM    = 48,
425 	QDF_MODULE_ID_WMI,
426 	QDF_MODULE_ID_HTT,
427 	QDF_MODULE_ID_HDD,
428 	QDF_MODULE_ID_SME,
429 	QDF_MODULE_ID_PE,
430 	QDF_MODULE_ID_WMA,
431 	QDF_MODULE_ID_SYS,
432 	QDF_MODULE_ID_QDF       = 56,
433 	QDF_MODULE_ID_SAP,
434 	QDF_MODULE_ID_HDD_SOFTAP,
435 	QDF_MODULE_ID_HDD_DATA,
436 	QDF_MODULE_ID_HDD_SAP_DATA,
437 	QDF_MODULE_ID_HIF,
438 	QDF_MODULE_ID_HTC,
439 	QDF_MODULE_ID_TXRX,
440 	QDF_MODULE_ID_QDF_DEVICE = 64,
441 	QDF_MODULE_ID_CFG,
442 	QDF_MODULE_ID_BMI,
443 	QDF_MODULE_ID_EPPING,
444 	QDF_MODULE_ID_QVIT,
445 	QDF_MODULE_ID_DP,
446 	QDF_MODULE_ID_HAL,
447 	QDF_MODULE_ID_SOC,
448 	QDF_MODULE_ID_OS_IF,
449 	QDF_MODULE_ID_TARGET_IF,
450 	QDF_MODULE_ID_SCHEDULER,
451 	QDF_MODULE_ID_MGMT_TXRX,
452 	QDF_MODULE_ID_SERIALIZATION,
453 	QDF_MODULE_ID_PMO,
454 	QDF_MODULE_ID_P2P,
455 	QDF_MODULE_ID_POLICY_MGR,
456 	QDF_MODULE_ID_CONFIG,
457 	QDF_MODULE_ID_REGULATORY,
458 	QDF_MODULE_ID_SA_API,
459 	QDF_MODULE_ID_NAN,
460 	QDF_MODULE_ID_OFFCHAN_TXRX,
461 	QDF_MODULE_ID_SON,
462 	QDF_MODULE_ID_SPECTRAL,
463 	QDF_MODULE_ID_OBJ_MGR,
464 	QDF_MODULE_ID_NSS,
465 	QDF_MODULE_ID_ROAM_DEBUG,
466 	QDF_MODULE_ID_CDP,
467 	QDF_MODULE_ID_DIRECT_BUF_RX,
468 	QDF_MODULE_ID_DISA,
469 	QDF_MODULE_ID_GREEN_AP,
470 	QDF_MODULE_ID_FTM,
471 	QDF_MODULE_ID_EXTAP,
472 	QDF_MODULE_ID_FD,
473 	QDF_MODULE_ID_OCB,
474 	QDF_MODULE_ID_IPA,
475 	QDF_MODULE_ID_CP_STATS,
476 	QDF_MODULE_ID_ACTION_OUI,
477 	QDF_MODULE_ID_TARGET,
478 	QDF_MODULE_ID_MBSSIE,
479 	QDF_MODULE_ID_FWOL,
480 	QDF_MODULE_ID_SM_ENGINE,
481 	QDF_MODULE_ID_CMN_MLME,
482 	QDF_MODULE_ID_BSSCOLOR,
483 	QDF_MODULE_ID_CFR,
484 	QDF_MODULE_ID_TX_CAPTURE,
485 	QDF_MODULE_ID_INTEROP_ISSUES_AP,
486 	QDF_MODULE_ID_BLACKLIST_MGR,
487 	QDF_MODULE_ID_QLD,
488 	QDF_MODULE_ID_DYNAMIC_MODE_CHG,
489 	QDF_MODULE_ID_ANY,
490 	QDF_MODULE_ID_MAX,
491 } QDF_MODULE_ID;
492 
493 /**
494  * typedef enum QDF_TRACE_LEVEL - Debug verbose level
495  * @QDF_TRACE_LEVEL_NONE: no trace will be logged. This value is in place
496  *			  for the qdf_trace_setlevel() to allow the user
497  *			  to turn off all traces
498  * @QDF_TRACE_LEVEL_FATAL: Indicates fatal error conditions
499  * @QDF_TRACE_LEVEL_ERROR: Indicates error conditions
500  * @QDF_TRACE_LEVEL_WARN: May indicate that an error will occur if action
501  *			  is not taken
502  * @QDF_TRACE_LEVEL_INFO: Normal operational messages that require no action
503  * @QDF_TRACE_LEVEL_INFO_HIGH: High level operational messages that require
504  *			       no action
505  * @QDF_TRACE_LEVEL_INFO_MED: Middle level operational messages that require
506  *			      no action
507  * @QDF_TRACE_LEVEL_INFO_LOW: Low level operational messages that require
508  *			      no action
509  * @QDF_TRACE_LEVEL_DEBUG: Information useful to developers for debugging
510  * @QDF_TRACE_LEVEL_TRACE: Indicates trace level for automation scripts,
511  *			whenever there is a context switch in driver, one
512  *			print using this trace level will be added with
513  *			the help of qdf_trace api.
514  * @QDF_TRACE_LEVEL_ALL: All trace levels
515  * @QDF_TRACE_LEVEL_MAX: Max trace level
516  */
517 typedef enum {
518 	QDF_TRACE_LEVEL_NONE,
519 	QDF_TRACE_LEVEL_FATAL,
520 	QDF_TRACE_LEVEL_ERROR,
521 	QDF_TRACE_LEVEL_WARN,
522 	QDF_TRACE_LEVEL_INFO,
523 	QDF_TRACE_LEVEL_INFO_HIGH,
524 	QDF_TRACE_LEVEL_INFO_MED,
525 	QDF_TRACE_LEVEL_INFO_LOW,
526 	QDF_TRACE_LEVEL_DEBUG,
527 	QDF_TRACE_LEVEL_TRACE,
528 	QDF_TRACE_LEVEL_ALL,
529 	QDF_TRACE_LEVEL_MAX
530 } QDF_TRACE_LEVEL;
531 
532 /**
533  * enum QDF_OPMODE - vdev operating mode
534  * @QDF_STA_MODE: STA mode
535  * @QDF_SAP_MODE: SAP mode
536  * @QDF_P2P_CLIENT_MODE: P2P client mode
537  * @QDF_P2P_GO_MODE: P2P GO mode
538  * @QDF_FTM_MODE: FTM mode
539  * @QDF_IBSS_MODE: IBSS mode
540  * @QDF_MONITOR_MODE: Monitor mode
541  * @QDF_P2P_DEVICE_MODE: P2P device mode
542  * @QDF_OCB_MODE: OCB device mode
543  * @QDF_EPPING_MODE: EPPING device mode
544  * @QDF_QVIT_MODE: QVIT device mode
545  * @QDF_NDI_MODE: NAN datapath mode
546  * @QDF_WDS_MODE: WDS mode
547  * @QDF_BTAMP_MODE: BTAMP mode
548  * @QDF_AHDEMO_MODE: AHDEMO mode
549  * @QDF_TDLS_MODE: TDLS device mode
550  * @QDF_NAN_DISC_MODE: NAN Discovery device mode
551  * @QDF_MAX_NO_OF_MODE: Max place holder
552  *
553  * These are generic IDs that identify the various roles
554  * in the software system
555  */
556 enum QDF_OPMODE {
557 	QDF_STA_MODE,
558 	QDF_SAP_MODE,
559 	QDF_P2P_CLIENT_MODE,
560 	QDF_P2P_GO_MODE,
561 	QDF_FTM_MODE,
562 	QDF_IBSS_MODE,
563 	QDF_MONITOR_MODE,
564 	QDF_P2P_DEVICE_MODE,
565 	QDF_OCB_MODE,
566 	QDF_EPPING_MODE,
567 	QDF_QVIT_MODE,
568 	QDF_NDI_MODE,
569 	QDF_WDS_MODE,
570 	QDF_BTAMP_MODE,
571 	QDF_AHDEMO_MODE,
572 	QDF_TDLS_MODE,
573 	QDF_NAN_DISC_MODE,
574 
575 	/* Add new OP Modes to qdf_opmode_str as well */
576 
577 	QDF_MAX_NO_OF_MODE
578 };
579 
580 /**
581  * qdf_opmode_str() - Return a human readable string representation of @opmode
582  * @opmode: The opmode to convert
583  *
584  * Return: string representation of @opmode
585  */
586 const char *qdf_opmode_str(const enum QDF_OPMODE opmode);
587 
588 /**
589  * enum QDF_GLOBAL_MODE - global mode when driver is loaded.
590  *
591  * @QDF_GLOBAL_MISSION_MODE: mission mode (STA, SAP...)
592  * @QDF_GLOBAL_WALTEST_MODE: WAL Test Mode
593  * @QDF_GLOBAL_MONITOR_MODE: Monitor Mode
594  * @QDF_GLOBAL_FTM_MODE: FTM mode
595  * @QDF_GLOBAL_IBSS_MODE: IBSS mode
596  * @QDF_GLOBAL_COLDBOOT_CALIB_MODEL: Cold Boot Calibration Mode
597  * @QDF_GLOBAL_EPPING_MODE: EPPING mode
598  * @QDF_GLOBAL_QVIT_MODE: QVIT global mode
599  * @QDF_GLOBAL_FTM_COLDBOOT_CALIB_MODE: Cold Boot Calibration in FTM Mode
600  * @QDF_GLOBAL_MAX_MODE: Max place holder
601  */
602 enum QDF_GLOBAL_MODE {
603 	QDF_GLOBAL_MISSION_MODE,
604 	QDF_GLOBAL_WALTEST_MODE = 3,
605 	QDF_GLOBAL_MONITOR_MODE = 4,
606 	QDF_GLOBAL_FTM_MODE = 5,
607 	QDF_GLOBAL_IBSS_MODE = 6,
608 	QDF_GLOBAL_COLDBOOT_CALIB_MODE = 7,
609 	QDF_GLOBAL_EPPING_MODE = 8,
610 	QDF_GLOBAL_QVIT_MODE = 9,
611 	QDF_GLOBAL_FTM_COLDBOOT_CALIB_MODE = 10,
612 	QDF_GLOBAL_MAX_MODE
613 };
614 
615 #define  QDF_IS_EPPING_ENABLED(mode) (mode == QDF_GLOBAL_EPPING_MODE)
616 
617 #ifdef QDF_TRACE_PRINT_ENABLE
618 #define qdf_print(args...) QDF_TRACE_INFO(QDF_MODULE_ID_ANY, ## args)
619 #define qdf_alert(args...) QDF_TRACE_FATAL(QDF_MODULE_ID_ANY, ## args)
620 #define qdf_err(args...)   QDF_TRACE_ERROR(QDF_MODULE_ID_ANY, ## args)
621 #define qdf_warn(args...)  QDF_TRACE_WARN(QDF_MODULE_ID_ANY, ## args)
622 #define qdf_info(args...)  QDF_TRACE_INFO(QDF_MODULE_ID_ANY, ## args)
623 #define qdf_debug(args...) QDF_TRACE_DEBUG(QDF_MODULE_ID_ANY, ## args)
624 
625 #define qdf_nofl_print(params...) \
626 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_ANY, ## params)
627 #define qdf_nofl_alert(params...) \
628 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_ANY, ## params)
629 #define qdf_nofl_err(params...) \
630 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_ANY, ## params)
631 #define qdf_nofl_warn(params...) \
632 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_ANY, ## params)
633 #define qdf_nofl_info(params...) \
634 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_ANY, ## params)
635 #define qdf_nofl_debug(params...) \
636 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_ANY, ## params)
637 
638 #else /* QDF_TRACE_PRINT_ENABLE */
639 #define qdf_print(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, ## params)
640 #define qdf_alert(params...) QDF_TRACE_FATAL(QDF_MODULE_ID_QDF, ## params)
641 #define qdf_err(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, ## params)
642 #define qdf_warn(params...) QDF_TRACE_WARN(QDF_MODULE_ID_QDF, ## params)
643 #define qdf_info(params...) QDF_TRACE_INFO(QDF_MODULE_ID_QDF, ## params)
644 #define qdf_debug(params...) QDF_TRACE_DEBUG(QDF_MODULE_ID_QDF, ## params)
645 
646 #define qdf_nofl_alert(params...) \
647 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_QDF, ## params)
648 #define qdf_nofl_err(params...) \
649 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_QDF, ## params)
650 #define qdf_nofl_warn(params...) \
651 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_QDF, ## params)
652 #define qdf_nofl_info(params...) \
653 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_QDF, ## params)
654 #define qdf_nofl_debug(params...) \
655 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_QDF, ## params)
656 
657 #endif /* QDF_TRACE_PRINT_ENABLE */
658 
659 #define qdf_rl_alert(params...) QDF_TRACE_FATAL_RL(QDF_MODULE_ID_QDF, ## params)
660 #define qdf_rl_err(params...) QDF_TRACE_ERROR_RL(QDF_MODULE_ID_QDF, ## params)
661 #define qdf_rl_warn(params...) QDF_TRACE_WARN_RL(QDF_MODULE_ID_QDF, ## params)
662 #define qdf_rl_info(params...) QDF_TRACE_INFO_RL(QDF_MODULE_ID_QDF, ## params)
663 #define qdf_rl_debug(params...) QDF_TRACE_DEBUG_RL(QDF_MODULE_ID_QDF, ## params)
664 
665 #define qdf_rl_nofl_alert(params...) \
666 	QDF_TRACE_FATAL_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
667 #define qdf_rl_nofl_err(params...) \
668 	QDF_TRACE_ERROR_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
669 #define qdf_rl_nofl_warn(params...) \
670 	QDF_TRACE_WARN_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
671 #define qdf_rl_nofl_info(params...) \
672 	QDF_TRACE_INFO_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
673 #define qdf_rl_nofl_debug(params...) \
674 	QDF_TRACE_DEBUG_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
675 
676 #define qdf_vprint    __qdf_vprint
677 #define qdf_snprint   __qdf_snprint
678 
679 #define qdf_kstrtoint __qdf_kstrtoint
680 #define qdf_kstrtouint __qdf_kstrtouint
681 
682 #ifdef WLAN_OPEN_P2P_INTERFACE
683 /* This should match with WLAN_MAX_INTERFACES */
684 #define QDF_MAX_CONCURRENCY_PERSONA  (4)
685 #else
686 #define QDF_MAX_CONCURRENCY_PERSONA  (3)
687 #endif
688 
689 #define QDF_STA_MASK (1 << QDF_STA_MODE)
690 #define QDF_SAP_MASK (1 << QDF_SAP_MODE)
691 #define QDF_P2P_CLIENT_MASK (1 << QDF_P2P_CLIENT_MODE)
692 #define QDF_P2P_GO_MASK (1 << QDF_P2P_GO_MODE)
693 
694 #ifdef FEATURE_WLAN_MCC_TO_SCC_SWITCH
695 
696 /**
697  * typedef tQDF_MCC_TO_SCC_SWITCH_MODE - MCC to SCC switch mode.
698  * @QDF_MCC_TO_SCC_SWITCH_DISABLE: Disable switch
699  * @QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION: Force switch without
700  * restart of SAP
701  * @QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL: Switch using fav channel(s)
702  * without SAP restart
703  * @QDF_MCC_TO_SCC_SWITCH_FORCE_PREFERRED_WITHOUT_DISCONNECTION: Force switch
704  * without SAP restart. MCC is allowed only in below exception cases:
705  *	Exception Case-1: When STA is operating on DFS channel.
706  *	Exception Case-2: When STA is operating on LTE-CoEx channel.
707  *	Exception Case-3: When STA is operating on AP disabled channel.
708  * @QDF_MCC_TO_SCC_WITH_PREFERRED_BAND: Force SCC only in user preferred band.
709  * Allow MCC if STA is operating or comes up on other than user preferred band.
710  *
711  * @QDF_MCC_TO_SCC_SWITCH_MAX: max switch
712  */
713 typedef enum {
714 	QDF_MCC_TO_SCC_SWITCH_DISABLE = 0,
715 	QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION = 3,
716 	QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL,
717 	QDF_MCC_TO_SCC_SWITCH_FORCE_PREFERRED_WITHOUT_DISCONNECTION,
718 	QDF_MCC_TO_SCC_WITH_PREFERRED_BAND,
719 	QDF_MCC_TO_SCC_SWITCH_MAX
720 } tQDF_MCC_TO_SCC_SWITCH_MODE;
721 #endif
722 
723 #if !defined(NULL)
724 #ifdef __cplusplus
725 #define NULL   0
726 #else
727 #define NULL   ((void *)0)
728 #endif
729 #endif
730 
731 /**
732  * qdf_bool_parse() - parse the given string as a boolean value
733  * @bool_str: the input boolean string to parse
734  * @out_bool: the output boolean value, populated on success
735  *
736  * 1, y, Y are mapped to true, 0, n, N are mapped to false.
737  * Leading/trailing whitespace is ignored.
738  *
739  * Return: QDF_STATUS
740  */
741 QDF_STATUS qdf_bool_parse(const char *bool_str, bool *out_bool);
742 
743 /**
744  * qdf_int32_parse() - parse the given string as a 32-bit signed integer
745  * @int_str: the input integer string to parse
746  * @out_int: the output integer value, populated on success
747  *
748  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
749  * encodings via typical prefix notation. Leading/trailing whitespace is
750  * ignored.
751  *
752  * Return: QDF_STATUS
753  */
754 QDF_STATUS qdf_int32_parse(const char *int_str, int32_t *out_int);
755 
756 /**
757  * qdf_uint32_parse() - parse the given string as a 32-bit unsigned integer
758  * @int_str: the input integer string to parse
759  * @out_int: the output integer value, populated on success
760  *
761  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
762  * encodings via typical prefix notation. Leading/trailing whitespace is
763  * ignored.
764  *
765  * Return: QDF_STATUS
766  */
767 QDF_STATUS qdf_uint32_parse(const char *int_str, uint32_t *out_int);
768 
769 /**
770  * qdf_int64_parse() - parse the given string as a 64-bit signed integer
771  * @int_str: the input integer string to parse
772  * @out_int: the output integer value, populated on success
773  *
774  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
775  * encodings via typical prefix notation. Leading/trailing whitespace is
776  * ignored.
777  *
778  * Return: QDF_STATUS
779  */
780 QDF_STATUS qdf_int64_parse(const char *int_str, int64_t *out_int);
781 
782 /**
783  * qdf_uint64_parse() - parse the given string as a 64-bit unsigned integer
784  * @int_str: the input integer string to parse
785  * @out_int: the output integer value, populated on success
786  *
787  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
788  * encodings via typical prefix notation. Leading/trailing whitespace is
789  * ignored.
790  *
791  * Return: QDF_STATUS
792  */
793 QDF_STATUS qdf_uint64_parse(const char *int_str, uint64_t *out_int);
794 
795 #define QDF_MAC_ADDR_SIZE 6
796 #define QDF_MAC_ADDR_STR "%02x:%02x:%02x:%02x:%02x:%02x"
797 #define QDF_MAC_ADDR_ARRAY(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
798 #define QDF_MAC_ADDR_BCAST_INIT { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } }
799 #define QDF_MAC_ADDR_ZERO_INIT { { 0, 0, 0, 0, 0, 0 } }
800 
801 /**
802  * struct qdf_mac_addr - A MAC address
803  * @bytes: the raw address bytes array
804  */
805 struct qdf_mac_addr {
806 	uint8_t bytes[QDF_MAC_ADDR_SIZE];
807 };
808 
809 /**
810  * qdf_mac_parse() - parse the given string as a MAC address
811  * @mac_str: the input MAC address string to parse
812  * @out_addr: the output MAC address value, populated on success
813  *
814  * A MAC address is a set of 6, colon-delimited, hexadecimal encoded octets.
815  *
816  * E.g.
817  *	00:00:00:00:00:00 (zero address)
818  *	ff:ff:ff:ff:ff:ff (broadcast address)
819  *	12:34:56:78:90:ab (an arbitrary address)
820  *
821  * This implementation also accepts MAC addresses without colons. Historically,
822  * other delimiters and groupings have been used to represent MAC addresses, but
823  * these are not supported here. Hexadecimal digits may be in either upper or
824  * lower case.
825  *
826  * Return: QDF_STATUS
827  */
828 QDF_STATUS qdf_mac_parse(const char *mac_str, struct qdf_mac_addr *out_addr);
829 
830 #define QDF_IPV4_ADDR_SIZE 4
831 #define QDF_IPV4_ADDR_STR "%d.%d.%d.%d"
832 #define QDF_IPV4_ADDR_ARRAY(a) (a)[0], (a)[1], (a)[2], (a)[3]
833 #define QDF_IPV4_ADDR_ZERO_INIT { { 0, 0, 0, 0 } }
834 
835 /**
836  * struct qdf_ipv4_addr - An IPV4 address
837  * @bytes: the raw address bytes array
838  */
839 struct qdf_ipv4_addr {
840 	uint8_t bytes[QDF_IPV4_ADDR_SIZE];
841 };
842 
843 /**
844  * qdf_ipv4_parse() - parse the given string as an IPV4 address
845  * @ipv4_str: the input IPV4 address string to parse
846  * @out_addr: the output IPV4 address value, populated on success
847  *
848  * An IPV4 address is a set of 4, dot-delimited, decimal encoded octets.
849  *
850  * E.g.
851  *	0.0.0.0 (wildcard address)
852  *	127.0.0.1 (loopback address)
853  *	255.255.255.255 (broadcast address)
854  *	192.168.0.1 (an arbitrary address)
855  *
856  * Historically, non-decimal encodings have also been used to represent IPV4
857  * addresses, but these are not supported here.
858  *
859  * Return: QDF_STATUS
860  */
861 QDF_STATUS qdf_ipv4_parse(const char *ipv4_str, struct qdf_ipv4_addr *out_addr);
862 
863 #define QDF_IPV6_ADDR_SIZE 16
864 #define QDF_IPV6_ADDR_HEXTET_COUNT 8
865 #define QDF_IPV6_ADDR_STR "%x:%x:%x:%x:%x:%x:%x:%x"
866 #define QDF_IPV6_ADDR_ARRAY(a) \
867 	((a)[0] << 8) + (a)[1], ((a)[2] << 8) + (a)[3], \
868 	((a)[4] << 8) + (a)[5], ((a)[6] << 8) + (a)[7], \
869 	((a)[8] << 8) + (a)[9], ((a)[10] << 8) + (a)[11], \
870 	((a)[12] << 8) + (a)[13], ((a)[14] << 8) + (a)[15]
871 #define QDF_IPV6_ADDR_ZERO_INIT \
872 	{ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } }
873 
874 /**
875  * struct qdf_ipv6_addr - An IPV6 address
876  * @bytes: the raw address bytes array
877  */
878 struct qdf_ipv6_addr {
879 	uint8_t bytes[QDF_IPV6_ADDR_SIZE];
880 };
881 
882 /**
883  * qdf_ipv6_parse() - parse the given string as an IPV6 address
884  * @ipv6_str: the input IPV6 address string to parse
885  * @out_addr: the output IPV6 address value, populated on success
886  *
887  * A hextet is a pair of octets. An IPV6 address is a set of 8, colon-delimited,
888  * hexadecimal encoded hextets. Each hextet may omit leading zeros. One or more
889  * zero-hextets may be "compressed" using a pair of colons ("::"). Up to one
890  * such zero-compression is allowed per address.
891  *
892  * E.g.
893  *	0:0:0:0:0:0:0:0 (unspecified address)
894  *	:: (also the unspecified address)
895  *	0:0:0:0:0:0:0:1 (loopback address)
896  *	::1 (also the loopback address)
897  *	900a:ae7::6 (an arbitrary address)
898  *	900a:ae7:0:0:0:0:0:6 (the same arbitrary address)
899  *
900  * Hexadecimal digits may be in either upper or lower case.
901  *
902  * Return: QDF_STATUS
903  */
904 QDF_STATUS qdf_ipv6_parse(const char *ipv6_str, struct qdf_ipv6_addr *out_addr);
905 
906 /**
907  * qdf_uint16_array_parse() - parse the given string as uint16 array
908  * @in_str: the input string to parse
909  * @out_array: the output uint16 array, populated on success
910  * @array_size: size of the array
911  * @out_size: size of the populated array
912  *
913  * This API is called to convert string (each value separated by
914  * a comma) into an uint16 array
915  *
916  * Return: QDF_STATUS
917  */
918 
919 QDF_STATUS qdf_uint16_array_parse(const char *in_str, uint16_t *out_array,
920 				  qdf_size_t array_size, qdf_size_t *out_size);
921 
922 /**
923  * qdf_uint8_array_parse() - parse the given string as uint8 array
924  * @in_str: the input string to parse
925  * @out_array: the output uint8 array, populated on success
926  * @array_size: size of the array
927  * @out_size: size of the populated array
928  *
929  * This API is called to convert string (each byte separated by
930  * a comma) into an u8 array
931  *
932  * Return: QDF_STATUS
933  */
934 QDF_STATUS qdf_uint8_array_parse(const char *in_str, uint8_t *out_array,
935 				 qdf_size_t array_size, qdf_size_t *out_size);
936 
937 #define QDF_MAX_NUM_CHAN   (128)
938 
939 #define QDF_BCAST_MAC_ADDR (0xFF)
940 #define QDF_MCAST_IPV4_MAC_ADDR (0x01)
941 #define QDF_MCAST_IPV6_MAC_ADDR (0x33)
942 
943 /**
944  * struct qdf_tso_frag_t - fragments of a single TCP segment
945  * @paddr_low_32: Lower 32 bits of the buffer pointer
946  * @paddr_upper_16: upper 16 bits of the buffer pointer
947  * @length: length of the buffer
948  * @vaddr: virtual address
949  *
950  * This structure holds the fragments of a single TCP segment of a
951  * given jumbo TSO network buffer
952  */
953 struct qdf_tso_frag_t {
954 	uint16_t length;
955 	unsigned char *vaddr;
956 	qdf_dma_addr_t paddr;
957 };
958 
959 #define FRAG_NUM_MAX 6
960 #define TSO_SEG_MAGIC_COOKIE 0x1EED
961 
962 /**
963  * struct qdf_tso_flags_t - TSO specific flags
964  * @tso_enable: Enable transmit segmentation offload
965  * @tcp_flags_mask: Tcp_flag is inserted into the header based
966  * on the mask
967  * @l2_len: L2 length for the msdu
968  * @ip_len: IP length for the msdu
969  * @tcp_seq_num: TCP sequence number
970  * @ip_id: IP identification number
971  *
972  * This structure holds the TSO specific flags extracted from the TSO network
973  * buffer for a given TCP segment
974  */
975 struct qdf_tso_flags_t {
976 	uint32_t tso_enable:1,
977 			reserved_0a:6,
978 			fin:1,
979 			syn:1,
980 			rst:1,
981 			psh:1,
982 			ack:1,
983 			urg:1,
984 			ece:1,
985 			cwr:1,
986 			ns:1,
987 			tcp_flags_mask:9,
988 			reserved_0b:7;
989 
990 	uint32_t l2_len:16,
991 			ip_len:16;
992 
993 	uint32_t tcp_seq_num;
994 
995 	uint32_t ip_id:16,
996 			ipv4_checksum_en:1,
997 			udp_ipv4_checksum_en:1,
998 			udp_ipv6_checksum_en:1,
999 			tcp_ipv4_checksum_en:1,
1000 			tcp_ipv6_checksum_en:1,
1001 			partial_checksum_en:1,
1002 			reserved_3a:10;
1003 
1004 	uint32_t checksum_offset:14,
1005 			reserved_4a:2,
1006 			payload_start_offset:14,
1007 			reserved_4b:2;
1008 
1009 	uint32_t payload_end_offset:14,
1010 			reserved_5:18;
1011 };
1012 
1013 /**
1014  * struct qdf_tso_seg_t - single TSO segment
1015  * @tso_flags: TSO flags
1016  * @num_frags: number of fragments
1017  * @total_len: total length of the packet
1018  * @tso_frags: array holding the fragments
1019  *
1020  * This structure holds the information of a single TSO segment of a jumbo
1021  * TSO network buffer
1022  */
1023 struct qdf_tso_seg_t {
1024 	struct qdf_tso_flags_t tso_flags;
1025 	uint32_t num_frags;
1026 	uint32_t total_len;
1027 	struct qdf_tso_frag_t tso_frags[FRAG_NUM_MAX];
1028 };
1029 
1030 /**
1031  * TSO seg elem action caller locations: goes into dbg.history below.
1032  * Needed to be defined outside of the feature so that
1033  * callers can be coded without ifdefs (even if they get
1034  * resolved to nothing)
1035  */
1036 enum tsoseg_dbg_caller_e {
1037 	TSOSEG_LOC_UNDEFINED,
1038 	TSOSEG_LOC_INIT1,
1039 	TSOSEG_LOC_INIT2,
1040 	TSOSEG_LOC_FREE,
1041 	TSOSEG_LOC_ALLOC,
1042 	TSOSEG_LOC_DEINIT,
1043 	TSOSEG_LOC_GETINFO,
1044 	TSOSEG_LOC_FILLHTTSEG,
1045 	TSOSEG_LOC_FILLCMNSEG,
1046 	TSOSEG_LOC_PREPARETSO,
1047 	TSOSEG_LOC_TXPREPLLFAST,
1048 	TSOSEG_LOC_UNMAPTSO,
1049 	TSOSEG_LOC_UNMAPLAST,
1050 	TSOSEG_LOC_FORCE_FREE,
1051 };
1052 #ifdef TSOSEG_DEBUG
1053 
1054 /**
1055  * WARNING: Don't change the history size without changing the wrap
1056  *  code in qdf_tso_seg_dbg_record function
1057  */
1058 #define MAX_TSO_SEG_ACT_HISTORY 16
1059 struct qdf_tso_seg_dbg_history_t {
1060 	uint64_t ts;
1061 	short    id;
1062 };
1063 struct qdf_tso_seg_dbg_t {
1064 	void    *txdesc;  /* owner - (ol_txrx_tx_desc_t *) */
1065 	qdf_atomic_t cur; /* index of last valid entry */
1066 	struct qdf_tso_seg_dbg_history_t h[MAX_TSO_SEG_ACT_HISTORY];
1067 };
1068 #endif /* TSOSEG_DEBUG */
1069 
1070 /**
1071  * qdf_tso_seg_elem_t - tso segment element
1072  * @next: pointer to the next segment
1073  * @seg: instance of segment
1074  */
1075 struct qdf_tso_seg_elem_t {
1076 	struct qdf_tso_seg_elem_t *next;
1077 	struct qdf_tso_seg_t seg;
1078 	uint32_t cookie:13,
1079 		on_freelist:1,
1080 		sent_to_target:1,
1081 		force_free:1;
1082 #ifdef TSOSEG_DEBUG
1083 	struct qdf_tso_seg_dbg_t dbg;
1084 #endif /* TSOSEG_DEBUG */
1085 };
1086 
1087 /**
1088  * struct qdf_tso_num_seg_t - single element to count for num of seg
1089  * @tso_cmn_num_seg: num of seg in a jumbo skb
1090  *
1091  * This structure holds the information of num of segments of a jumbo
1092  * TSO network buffer.
1093  */
1094 struct qdf_tso_num_seg_t {
1095 	uint32_t tso_cmn_num_seg;
1096 };
1097 
1098 /**
1099  * qdf_tso_num_seg_elem_t - num of tso segment element for jumbo skb
1100  * @next: pointer to the next segment
1101  * @num_seg: instance of num of seg
1102  */
1103 struct qdf_tso_num_seg_elem_t {
1104 	struct qdf_tso_num_seg_elem_t *next;
1105 	struct qdf_tso_num_seg_t num_seg;
1106 };
1107 
1108 /**
1109  * struct qdf_tso_info_t - TSO information extracted
1110  * @is_tso: is this is a TSO frame
1111  * @num_segs: number of segments
1112  * @tso_seg_list: list of TSO segments for this jumbo packet
1113  * @curr_seg: segment that is currently being processed
1114  * @tso_num_seg_list: num of tso seg for this jumbo packet
1115  * @msdu_stats_idx: msdu index for tso stats
1116  *
1117  * This structure holds the TSO information extracted after parsing the TSO
1118  * jumbo network buffer. It contains a chain of the TSO segments belonging to
1119  * the jumbo packet
1120  */
1121 struct qdf_tso_info_t {
1122 	uint8_t is_tso;
1123 	uint32_t num_segs;
1124 	struct qdf_tso_seg_elem_t *tso_seg_list;
1125 	struct qdf_tso_seg_elem_t *curr_seg;
1126 	struct qdf_tso_num_seg_elem_t *tso_num_seg_list;
1127 	uint32_t msdu_stats_idx;
1128 };
1129 
1130 /**
1131  * Used to set classify bit in CE desc.
1132  */
1133 #define QDF_CE_TX_CLASSIFY_BIT_S   5
1134 
1135 /**
1136  * QDF_CE_TX_PKT_TYPE_BIT_S - 2 bits starting at bit 6 in CE desc.
1137  */
1138 #define QDF_CE_TX_PKT_TYPE_BIT_S   6
1139 
1140 /**
1141  * QDF_CE_TX_PKT_OFFSET_BIT_S - 12 bits --> 16-27, in the CE desciptor
1142  *  the length of HTT/HTC descriptor
1143  */
1144 #define QDF_CE_TX_PKT_OFFSET_BIT_S  16
1145 
1146 /**
1147  * QDF_CE_TX_PKT_OFFSET_BIT_M - Mask for packet offset in the CE descriptor.
1148  */
1149 #define QDF_CE_TX_PKT_OFFSET_BIT_M   0x0fff0000
1150 
1151 /**
1152  * enum qdf_suspend_type - type of suspend
1153  * @QDF_SYSTEM_SUSPEND: System suspend triggered wlan suspend
1154  * @QDF_RUNTIME_SUSPEND: Runtime pm inactivity timer triggered wlan suspend
1155  */
1156 enum qdf_suspend_type {
1157 	QDF_SYSTEM_SUSPEND,
1158 	QDF_RUNTIME_SUSPEND
1159 };
1160 
1161 /**
1162  * enum qdf_hang_reason - host hang/ssr reason
1163  * @QDF_REASON_UNSPECIFIED: Unspecified reason
1164  * @QDF_RX_HASH_NO_ENTRY_FOUND: No Map for the MAC entry for the received frame
1165  * @QDF_PEER_DELETION_TIMEDOUT: peer deletion timeout happened
1166  * @QDF_PEER_UNMAP_TIMEDOUT: peer unmap timeout
1167  * @QDF_SCAN_REQ_EXPIRED: Scan request timed out
1168  * @QDF_SCAN_ATTEMPT_FAILURES: Consecutive Scan attempt failures
1169  * @QDF_GET_MSG_BUFF_FAILURE: Unable to get the message buffer
1170  * @QDF_ACTIVE_LIST_TIMEOUT: Current command processing is timedout
1171  * @QDF_SUSPEND_TIMEOUT: Timeout for an ACK from FW for suspend request
1172  * @QDF_RESUME_TIMEOUT: Timeout for an ACK from FW for resume request
1173  * @QDF_WMI_EXCEED_MAX_PENDING_CMDS: wmi exceed max pending cmd
1174  */
1175 enum qdf_hang_reason {
1176 	QDF_REASON_UNSPECIFIED = 0,
1177 	QDF_RX_HASH_NO_ENTRY_FOUND = 1,
1178 	QDF_PEER_DELETION_TIMEDOUT = 2,
1179 	QDF_PEER_UNMAP_TIMEDOUT = 3,
1180 	QDF_SCAN_REQ_EXPIRED = 4,
1181 	QDF_SCAN_ATTEMPT_FAILURES = 5,
1182 	QDF_GET_MSG_BUFF_FAILURE = 6,
1183 	QDF_ACTIVE_LIST_TIMEOUT = 7,
1184 	QDF_SUSPEND_TIMEOUT = 8,
1185 	QDF_RESUME_TIMEOUT = 9,
1186 	QDF_WMI_EXCEED_MAX_PENDING_CMDS = 10,
1187 };
1188 
1189 /**
1190  * enum qdf_stats_verbosity_level - Verbosity levels for stats
1191  * for which want to have different levels
1192  * @QDF_STATS_VERBOSITY_LEVEL_LOW: Stats verbosity level low
1193  * @QDF_STATS_VERBOSITY_LEVEL_HIGH: Stats verbosity level high
1194  */
1195 enum qdf_stats_verbosity_level {
1196 	QDF_STATS_VERBOSITY_LEVEL_LOW,
1197 	QDF_STATS_VERBOSITY_LEVEL_HIGH
1198 };
1199 
1200 /**
1201  * enum qdf_clock_id - The clock IDs of the various system clocks
1202  * @QDF_CLOCK_REALTIME: Clock is close to current time of day
1203  * @QDF_CLOCK_MONOTONIC: Clock is absolute elapsed time
1204  */
1205 enum qdf_clock_id {
1206 	QDF_CLOCK_REALTIME = __QDF_CLOCK_REALTIME,
1207 	QDF_CLOCK_MONOTONIC = __QDF_CLOCK_MONOTONIC
1208 };
1209 
1210 /**
1211  * enum qdf_hrtimer_mode - Mode arguments of qdf_hrtimer_data_t
1212  * related functions
1213  * @QDF_HRTIMER_MODE_ABS: Time value is absolute
1214  * @QDF_HRTIMER_MODE_REL: Time value is relative to now
1215  * @QDF_HRTIMER_MODE_PINNED: Timer is bound to CPU
1216  */
1217 enum qdf_hrtimer_mode {
1218 	QDF_HRTIMER_MODE_ABS = __QDF_HRTIMER_MODE_ABS,
1219 	QDF_HRTIMER_MODE_REL = __QDF_HRTIMER_MODE_REL,
1220 	QDF_HRTIMER_MODE_PINNED =  __QDF_HRTIMER_MODE_PINNED,
1221 };
1222 
1223 /**
1224  * enum qdf_hrtimer_restart_status - Return values for the
1225  * qdf_hrtimer_data_t callback function
1226  * @QDF_HRTIMER_NORESTART: Timer is not restarted
1227  * @QDF_HRTIMER_RESTART: Timer must be restarted
1228  */
1229 enum qdf_hrtimer_restart_status {
1230 	QDF_HRTIMER_NORESTART = __QDF_HRTIMER_NORESTART,
1231 	QDF_HRTIMER_RESTART = __QDF_HRTIMER_RESTART,
1232 };
1233 
1234 /**
1235  * enum qdf_context_mode - Values for the
1236  * hrtimer context
1237  * @QDF_CONTEXT_HARDWARE: Runs in hw interrupt context
1238  * @QDF_CONTEXT_TASKLET: Runs in tasklet context
1239  */
1240 enum qdf_context_mode {
1241 	QDF_CONTEXT_HARDWARE = 0,
1242 	QDF_CONTEXT_TASKLET = 1,
1243 };
1244 
1245 #endif /* __QDF_TYPES_H */
1246