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