xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_types.h (revision f28396d060cff5c6519f883cb28ae0116ce479f1)
1 /*
2  * Copyright (c) 2014-2020 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_COEX: Coex related config module ID
381  * @QDF_MODULE_ID_FTM_TIME_SYNC: FTM Time sync module ID
382  * @QDF_MODULE_ID_PKT_CAPTURE: PACKET CAPTURE module ID
383  * @QDF_MODULE_ID_MON_FILTER: Monitor filter related config module ID
384  * @QDF_MODULE_ID_ANY: anything
385  * @QDF_MODULE_ID_MAX: Max place holder module ID
386  */
387 typedef enum {
388 	QDF_MODULE_ID_MIN       = 0,
389 	QDF_MODULE_ID_TDLS      = QDF_MODULE_ID_MIN,
390 	QDF_MODULE_ID_ACS,
391 	QDF_MODULE_ID_SCAN_SM,
392 	QDF_MODULE_ID_SCANENTRY,
393 	QDF_MODULE_ID_WDS,
394 	QDF_MODULE_ID_ACTION,
395 	QDF_MODULE_ID_ROAM,
396 	QDF_MODULE_ID_INACT,
397 	QDF_MODULE_ID_DOTH      = 8,
398 	QDF_MODULE_ID_IQUE,
399 	QDF_MODULE_ID_WME,
400 	QDF_MODULE_ID_ACL,
401 	QDF_MODULE_ID_WPA,
402 	QDF_MODULE_ID_RADKEYS,
403 	QDF_MODULE_ID_RADDUMP,
404 	QDF_MODULE_ID_RADIUS,
405 	QDF_MODULE_ID_DOT1XSM   = 16,
406 	QDF_MODULE_ID_DOT1X,
407 	QDF_MODULE_ID_POWER,
408 	QDF_MODULE_ID_STATE,
409 	QDF_MODULE_ID_OUTPUT,
410 	QDF_MODULE_ID_SCAN,
411 	QDF_MODULE_ID_AUTH,
412 	QDF_MODULE_ID_ASSOC,
413 	QDF_MODULE_ID_NODE      = 24,
414 	QDF_MODULE_ID_ELEMID,
415 	QDF_MODULE_ID_XRATE,
416 	QDF_MODULE_ID_INPUT,
417 	QDF_MODULE_ID_CRYPTO,
418 	QDF_MODULE_ID_DUMPPKTS,
419 	QDF_MODULE_ID_DEBUG,
420 	QDF_MODULE_ID_MLME,
421 	QDF_MODULE_ID_RRM       = 32,
422 	QDF_MODULE_ID_WNM,
423 	QDF_MODULE_ID_P2P_PROT,
424 	QDF_MODULE_ID_PROXYARP,
425 	QDF_MODULE_ID_L2TIF,
426 	QDF_MODULE_ID_WIFIPOS,
427 	QDF_MODULE_ID_WRAP,
428 	QDF_MODULE_ID_DFS,
429 	QDF_MODULE_ID_ATF       = 40,
430 	QDF_MODULE_ID_SPLITMAC,
431 	QDF_MODULE_ID_IOCTL,
432 	QDF_MODULE_ID_NAC,
433 	QDF_MODULE_ID_MESH,
434 	QDF_MODULE_ID_MBO,
435 	QDF_MODULE_ID_EXTIOCTL_CHANSWITCH,
436 	QDF_MODULE_ID_EXTIOCTL_CHANSSCAN,
437 	QDF_MODULE_ID_TLSHIM    = 48,
438 	QDF_MODULE_ID_WMI,
439 	QDF_MODULE_ID_HTT,
440 	QDF_MODULE_ID_HDD,
441 	QDF_MODULE_ID_SME,
442 	QDF_MODULE_ID_PE,
443 	QDF_MODULE_ID_WMA,
444 	QDF_MODULE_ID_SYS,
445 	QDF_MODULE_ID_QDF       = 56,
446 	QDF_MODULE_ID_SAP,
447 	QDF_MODULE_ID_HDD_SOFTAP,
448 	QDF_MODULE_ID_HDD_DATA,
449 	QDF_MODULE_ID_HDD_SAP_DATA,
450 	QDF_MODULE_ID_HIF,
451 	QDF_MODULE_ID_HTC,
452 	QDF_MODULE_ID_TXRX,
453 	QDF_MODULE_ID_QDF_DEVICE = 64,
454 	QDF_MODULE_ID_CFG,
455 	QDF_MODULE_ID_BMI,
456 	QDF_MODULE_ID_EPPING,
457 	QDF_MODULE_ID_QVIT,
458 	QDF_MODULE_ID_DP,
459 	QDF_MODULE_ID_HAL,
460 	QDF_MODULE_ID_SOC,
461 	QDF_MODULE_ID_OS_IF,
462 	QDF_MODULE_ID_TARGET_IF,
463 	QDF_MODULE_ID_SCHEDULER,
464 	QDF_MODULE_ID_MGMT_TXRX,
465 	QDF_MODULE_ID_SERIALIZATION,
466 	QDF_MODULE_ID_PMO,
467 	QDF_MODULE_ID_P2P,
468 	QDF_MODULE_ID_POLICY_MGR,
469 	QDF_MODULE_ID_CONFIG,
470 	QDF_MODULE_ID_REGULATORY,
471 	QDF_MODULE_ID_SA_API,
472 	QDF_MODULE_ID_NAN,
473 	QDF_MODULE_ID_OFFCHAN_TXRX,
474 	QDF_MODULE_ID_SON,
475 	QDF_MODULE_ID_SPECTRAL,
476 	QDF_MODULE_ID_OBJ_MGR,
477 	QDF_MODULE_ID_NSS,
478 	QDF_MODULE_ID_ROAM_DEBUG,
479 	QDF_MODULE_ID_CDP,
480 	QDF_MODULE_ID_DIRECT_BUF_RX,
481 	QDF_MODULE_ID_DISA,
482 	QDF_MODULE_ID_GREEN_AP,
483 	QDF_MODULE_ID_FTM,
484 	QDF_MODULE_ID_EXTAP,
485 	QDF_MODULE_ID_FD,
486 	QDF_MODULE_ID_OCB,
487 	QDF_MODULE_ID_IPA,
488 	QDF_MODULE_ID_CP_STATS,
489 	QDF_MODULE_ID_ACTION_OUI,
490 	QDF_MODULE_ID_TARGET,
491 	QDF_MODULE_ID_MBSSIE,
492 	QDF_MODULE_ID_FWOL,
493 	QDF_MODULE_ID_SM_ENGINE,
494 	QDF_MODULE_ID_CMN_MLME,
495 	QDF_MODULE_ID_BSSCOLOR,
496 	QDF_MODULE_ID_CFR,
497 	QDF_MODULE_ID_TX_CAPTURE,
498 	QDF_MODULE_ID_INTEROP_ISSUES_AP,
499 	QDF_MODULE_ID_BLACKLIST_MGR,
500 	QDF_MODULE_ID_QLD,
501 	QDF_MODULE_ID_DYNAMIC_MODE_CHG,
502 	QDF_MODULE_ID_COEX,
503 	QDF_MODULE_ID_FTM_TIME_SYNC,
504 	QDF_MODULE_ID_PKT_CAPTURE,
505 	QDF_MODULE_ID_MON_FILTER,
506 	QDF_MODULE_ID_ANY,
507 	QDF_MODULE_ID_MAX,
508 } QDF_MODULE_ID;
509 
510 /**
511  * typedef enum QDF_TRACE_LEVEL - Debug verbose level
512  * @QDF_TRACE_LEVEL_NONE: no trace will be logged. This value is in place
513  *			  for the qdf_trace_setlevel() to allow the user
514  *			  to turn off all traces
515  * @QDF_TRACE_LEVEL_FATAL: Indicates fatal error conditions
516  * @QDF_TRACE_LEVEL_ERROR: Indicates error conditions
517  * @QDF_TRACE_LEVEL_WARN: May indicate that an error will occur if action
518  *			  is not taken
519  * @QDF_TRACE_LEVEL_INFO: Normal operational messages that require no action
520  * @QDF_TRACE_LEVEL_INFO_HIGH: High level operational messages that require
521  *			       no action
522  * @QDF_TRACE_LEVEL_INFO_MED: Middle level operational messages that require
523  *			      no action
524  * @QDF_TRACE_LEVEL_INFO_LOW: Low level operational messages that require
525  *			      no action
526  * @QDF_TRACE_LEVEL_DEBUG: Information useful to developers for debugging
527  * @QDF_TRACE_LEVEL_TRACE: Indicates trace level for automation scripts,
528  *			whenever there is a context switch in driver, one
529  *			print using this trace level will be added with
530  *			the help of qdf_trace api.
531  * @QDF_TRACE_LEVEL_ALL: All trace levels
532  * @QDF_TRACE_LEVEL_MAX: Max trace level
533  */
534 typedef enum {
535 	QDF_TRACE_LEVEL_NONE,
536 	QDF_TRACE_LEVEL_FATAL,
537 	QDF_TRACE_LEVEL_ERROR,
538 	QDF_TRACE_LEVEL_WARN,
539 	QDF_TRACE_LEVEL_INFO,
540 	QDF_TRACE_LEVEL_INFO_HIGH,
541 	QDF_TRACE_LEVEL_INFO_MED,
542 	QDF_TRACE_LEVEL_INFO_LOW,
543 	QDF_TRACE_LEVEL_DEBUG,
544 	QDF_TRACE_LEVEL_TRACE,
545 	QDF_TRACE_LEVEL_ALL,
546 	QDF_TRACE_LEVEL_MAX
547 } QDF_TRACE_LEVEL;
548 
549 /**
550  * enum QDF_OPMODE - vdev operating mode
551  * @QDF_STA_MODE: STA mode
552  * @QDF_SAP_MODE: SAP mode
553  * @QDF_P2P_CLIENT_MODE: P2P client mode
554  * @QDF_P2P_GO_MODE: P2P GO mode
555  * @QDF_FTM_MODE: FTM mode
556  * @QDF_IBSS_MODE: IBSS mode
557  * @QDF_MONITOR_MODE: Monitor mode
558  * @QDF_P2P_DEVICE_MODE: P2P device mode
559  * @QDF_OCB_MODE: OCB device mode
560  * @QDF_EPPING_MODE: EPPING device mode
561  * @QDF_QVIT_MODE: QVIT device mode
562  * @QDF_NDI_MODE: NAN datapath mode
563  * @QDF_WDS_MODE: WDS mode
564  * @QDF_BTAMP_MODE: BTAMP mode
565  * @QDF_AHDEMO_MODE: AHDEMO mode
566  * @QDF_TDLS_MODE: TDLS device mode
567  * @QDF_NAN_DISC_MODE: NAN Discovery device mode
568  * @QDF_MAX_NO_OF_MODE: Max place holder
569  *
570  * These are generic IDs that identify the various roles
571  * in the software system
572  */
573 enum QDF_OPMODE {
574 	QDF_STA_MODE,
575 	QDF_SAP_MODE,
576 	QDF_P2P_CLIENT_MODE,
577 	QDF_P2P_GO_MODE,
578 	QDF_FTM_MODE,
579 	QDF_IBSS_MODE,
580 	QDF_MONITOR_MODE,
581 	QDF_P2P_DEVICE_MODE,
582 	QDF_OCB_MODE,
583 	QDF_EPPING_MODE,
584 	QDF_QVIT_MODE,
585 	QDF_NDI_MODE,
586 	QDF_WDS_MODE,
587 	QDF_BTAMP_MODE,
588 	QDF_AHDEMO_MODE,
589 	QDF_TDLS_MODE,
590 	QDF_NAN_DISC_MODE,
591 
592 	/* Add new OP Modes to qdf_opmode_str as well */
593 
594 	QDF_MAX_NO_OF_MODE
595 };
596 
597 /**
598  * qdf_opmode_str() - Return a human readable string representation of @opmode
599  * @opmode: The opmode to convert
600  *
601  * Return: string representation of @opmode
602  */
603 const char *qdf_opmode_str(const enum QDF_OPMODE opmode);
604 
605 /**
606  * enum QDF_GLOBAL_MODE - global mode when driver is loaded.
607  *
608  * @QDF_GLOBAL_MISSION_MODE: mission mode (STA, SAP...)
609  * @QDF_GLOBAL_WALTEST_MODE: WAL Test Mode
610  * @QDF_GLOBAL_MONITOR_MODE: Monitor Mode
611  * @QDF_GLOBAL_FTM_MODE: FTM mode
612  * @QDF_GLOBAL_IBSS_MODE: IBSS mode
613  * @QDF_GLOBAL_COLDBOOT_CALIB_MODEL: Cold Boot Calibration Mode
614  * @QDF_GLOBAL_EPPING_MODE: EPPING mode
615  * @QDF_GLOBAL_QVIT_MODE: QVIT global mode
616  * @QDF_GLOBAL_FTM_COLDBOOT_CALIB_MODE: Cold Boot Calibration in FTM Mode
617  * @QDF_GLOBAL_MAX_MODE: Max place holder
618  */
619 enum QDF_GLOBAL_MODE {
620 	QDF_GLOBAL_MISSION_MODE,
621 	QDF_GLOBAL_WALTEST_MODE = 3,
622 	QDF_GLOBAL_MONITOR_MODE = 4,
623 	QDF_GLOBAL_FTM_MODE = 5,
624 	QDF_GLOBAL_IBSS_MODE = 6,
625 	QDF_GLOBAL_COLDBOOT_CALIB_MODE = 7,
626 	QDF_GLOBAL_EPPING_MODE = 8,
627 	QDF_GLOBAL_QVIT_MODE = 9,
628 	QDF_GLOBAL_FTM_COLDBOOT_CALIB_MODE = 10,
629 	QDF_GLOBAL_MAX_MODE
630 };
631 
632 #define  QDF_IS_EPPING_ENABLED(mode) (mode == QDF_GLOBAL_EPPING_MODE)
633 
634 #ifdef QDF_TRACE_PRINT_ENABLE
635 #define qdf_print(args...) QDF_TRACE_INFO(QDF_MODULE_ID_ANY, ## args)
636 #define qdf_alert(args...) QDF_TRACE_FATAL(QDF_MODULE_ID_ANY, ## args)
637 #define qdf_err(args...)   QDF_TRACE_ERROR(QDF_MODULE_ID_ANY, ## args)
638 #define qdf_warn(args...)  QDF_TRACE_WARN(QDF_MODULE_ID_ANY, ## args)
639 #define qdf_info(args...)  QDF_TRACE_INFO(QDF_MODULE_ID_ANY, ## args)
640 #define qdf_debug(args...) QDF_TRACE_DEBUG(QDF_MODULE_ID_ANY, ## args)
641 
642 #define qdf_nofl_print(params...) \
643 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_ANY, ## params)
644 #define qdf_nofl_alert(params...) \
645 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_ANY, ## params)
646 #define qdf_nofl_err(params...) \
647 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_ANY, ## params)
648 #define qdf_nofl_warn(params...) \
649 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_ANY, ## params)
650 #define qdf_nofl_info(params...) \
651 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_ANY, ## params)
652 #define qdf_nofl_debug(params...) \
653 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_ANY, ## params)
654 
655 #else /* QDF_TRACE_PRINT_ENABLE */
656 #define qdf_print(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, ## params)
657 #define qdf_alert(params...) QDF_TRACE_FATAL(QDF_MODULE_ID_QDF, ## params)
658 #define qdf_err(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, ## params)
659 #define qdf_warn(params...) QDF_TRACE_WARN(QDF_MODULE_ID_QDF, ## params)
660 #define qdf_info(params...) QDF_TRACE_INFO(QDF_MODULE_ID_QDF, ## params)
661 #define qdf_debug(params...) QDF_TRACE_DEBUG(QDF_MODULE_ID_QDF, ## params)
662 
663 #define qdf_nofl_alert(params...) \
664 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_QDF, ## params)
665 #define qdf_nofl_err(params...) \
666 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_QDF, ## params)
667 #define qdf_nofl_warn(params...) \
668 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_QDF, ## params)
669 #define qdf_nofl_info(params...) \
670 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_QDF, ## params)
671 #define qdf_nofl_debug(params...) \
672 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_QDF, ## params)
673 
674 #endif /* QDF_TRACE_PRINT_ENABLE */
675 
676 #define qdf_rl_alert(params...) QDF_TRACE_FATAL_RL(QDF_MODULE_ID_QDF, ## params)
677 #define qdf_rl_err(params...) QDF_TRACE_ERROR_RL(QDF_MODULE_ID_QDF, ## params)
678 #define qdf_rl_warn(params...) QDF_TRACE_WARN_RL(QDF_MODULE_ID_QDF, ## params)
679 #define qdf_rl_info(params...) QDF_TRACE_INFO_RL(QDF_MODULE_ID_QDF, ## params)
680 #define qdf_rl_debug(params...) QDF_TRACE_DEBUG_RL(QDF_MODULE_ID_QDF, ## params)
681 
682 #define qdf_rl_nofl_alert(params...) \
683 	QDF_TRACE_FATAL_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
684 #define qdf_rl_nofl_err(params...) \
685 	QDF_TRACE_ERROR_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
686 #define qdf_rl_nofl_warn(params...) \
687 	QDF_TRACE_WARN_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
688 #define qdf_rl_nofl_info(params...) \
689 	QDF_TRACE_INFO_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
690 #define qdf_rl_nofl_debug(params...) \
691 	QDF_TRACE_DEBUG_RL_NO_FL(QDF_MODULE_ID_QDF, ## params)
692 
693 #define qdf_snprint   __qdf_snprint
694 
695 #define qdf_kstrtoint __qdf_kstrtoint
696 #define qdf_kstrtouint __qdf_kstrtouint
697 
698 #ifdef WLAN_OPEN_P2P_INTERFACE
699 /* This should match with WLAN_MAX_INTERFACES */
700 #define QDF_MAX_CONCURRENCY_PERSONA  (WLAN_MAX_VDEVS)
701 #else
702 #define QDF_MAX_CONCURRENCY_PERSONA  (WLAN_MAX_VDEVS - 1)
703 #endif
704 
705 #define QDF_STA_MASK (1 << QDF_STA_MODE)
706 #define QDF_SAP_MASK (1 << QDF_SAP_MODE)
707 #define QDF_P2P_CLIENT_MASK (1 << QDF_P2P_CLIENT_MODE)
708 #define QDF_P2P_GO_MASK (1 << QDF_P2P_GO_MODE)
709 #define QDF_MONITOR_MASK (1 << QDF_MONITOR_MODE)
710 
711 #ifdef FEATURE_WLAN_MCC_TO_SCC_SWITCH
712 
713 /**
714  * typedef tQDF_MCC_TO_SCC_SWITCH_MODE - MCC to SCC switch mode.
715  * @QDF_MCC_TO_SCC_SWITCH_DISABLE: Disable switch
716  * @QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION: Force switch without
717  * restart of SAP
718  * @QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL: Switch using fav channel(s)
719  * without SAP restart
720  * @QDF_MCC_TO_SCC_SWITCH_FORCE_PREFERRED_WITHOUT_DISCONNECTION: Force switch
721  * without SAP restart. MCC is allowed only in below exception cases:
722  *	Exception Case-1: When STA is operating on DFS channel.
723  *	Exception Case-2: When STA is operating on LTE-CoEx channel.
724  *	Exception Case-3: When STA is operating on AP disabled channel.
725  * @QDF_MCC_TO_SCC_WITH_PREFERRED_BAND: Force SCC only in user preferred band.
726  * Allow MCC if STA is operating or comes up on other than user preferred band.
727  *
728  * @QDF_MCC_TO_SCC_SWITCH_MAX: max switch
729  */
730 typedef enum {
731 	QDF_MCC_TO_SCC_SWITCH_DISABLE = 0,
732 	QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION = 3,
733 	QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL,
734 	QDF_MCC_TO_SCC_SWITCH_FORCE_PREFERRED_WITHOUT_DISCONNECTION,
735 	QDF_MCC_TO_SCC_WITH_PREFERRED_BAND,
736 	QDF_MCC_TO_SCC_SWITCH_MAX
737 } tQDF_MCC_TO_SCC_SWITCH_MODE;
738 #endif
739 
740 #if !defined(NULL)
741 #ifdef __cplusplus
742 #define NULL   0
743 #else
744 #define NULL   ((void *)0)
745 #endif
746 #endif
747 
748 /**
749  * qdf_bool_parse() - parse the given string as a boolean value
750  * @bool_str: the input boolean string to parse
751  * @out_bool: the output boolean value, populated on success
752  *
753  * 1, y, Y are mapped to true, 0, n, N are mapped to false.
754  * Leading/trailing whitespace is ignored.
755  *
756  * Return: QDF_STATUS
757  */
758 QDF_STATUS qdf_bool_parse(const char *bool_str, bool *out_bool);
759 
760 /**
761  * qdf_int32_parse() - parse the given string as a 32-bit signed integer
762  * @int_str: the input integer string to parse
763  * @out_int: the output integer value, populated on success
764  *
765  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
766  * encodings via typical prefix notation. Leading/trailing whitespace is
767  * ignored.
768  *
769  * Return: QDF_STATUS
770  */
771 QDF_STATUS qdf_int32_parse(const char *int_str, int32_t *out_int);
772 
773 /**
774  * qdf_uint32_parse() - parse the given string as a 32-bit unsigned integer
775  * @int_str: the input integer string to parse
776  * @out_int: the output integer value, populated on success
777  *
778  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
779  * encodings via typical prefix notation. Leading/trailing whitespace is
780  * ignored.
781  *
782  * Return: QDF_STATUS
783  */
784 QDF_STATUS qdf_uint32_parse(const char *int_str, uint32_t *out_int);
785 
786 /**
787  * qdf_int64_parse() - parse the given string as a 64-bit signed integer
788  * @int_str: the input integer string to parse
789  * @out_int: the output integer value, populated on success
790  *
791  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
792  * encodings via typical prefix notation. Leading/trailing whitespace is
793  * ignored.
794  *
795  * Return: QDF_STATUS
796  */
797 QDF_STATUS qdf_int64_parse(const char *int_str, int64_t *out_int);
798 
799 /**
800  * qdf_uint64_parse() - parse the given string as a 64-bit unsigned integer
801  * @int_str: the input integer string to parse
802  * @out_int: the output integer value, populated on success
803  *
804  * Supports binary (0b), octal (0o), decimal (no prefix), and hexadecimal (0x)
805  * encodings via typical prefix notation. Leading/trailing whitespace is
806  * ignored.
807  *
808  * Return: QDF_STATUS
809  */
810 QDF_STATUS qdf_uint64_parse(const char *int_str, uint64_t *out_int);
811 
812 #define QDF_MAC_ADDR_SIZE 6
813 #define QDF_MAC_ADDR_STR "%02x:%02x:%02x:%02x:%02x:%02x"
814 #define QDF_MAC_ADDR_ARRAY(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
815 #define QDF_MAC_ADDR_BCAST_INIT { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } }
816 #define QDF_MAC_ADDR_ZERO_INIT { { 0, 0, 0, 0, 0, 0 } }
817 
818 /**
819  * struct qdf_mac_addr - A MAC address
820  * @bytes: the raw address bytes array
821  */
822 struct qdf_mac_addr {
823 	uint8_t bytes[QDF_MAC_ADDR_SIZE];
824 };
825 
826 /**
827  * qdf_mac_parse() - parse the given string as a MAC address
828  * @mac_str: the input MAC address string to parse
829  * @out_addr: the output MAC address value, populated on success
830  *
831  * A MAC address is a set of 6, colon-delimited, hexadecimal encoded octets.
832  *
833  * E.g.
834  *	00:00:00:00:00:00 (zero address)
835  *	ff:ff:ff:ff:ff:ff (broadcast address)
836  *	12:34:56:78:90:ab (an arbitrary address)
837  *
838  * This implementation also accepts MAC addresses without colons. Historically,
839  * other delimiters and groupings have been used to represent MAC addresses, but
840  * these are not supported here. Hexadecimal digits may be in either upper or
841  * lower case.
842  *
843  * Return: QDF_STATUS
844  */
845 QDF_STATUS qdf_mac_parse(const char *mac_str, struct qdf_mac_addr *out_addr);
846 
847 #define QDF_IPV4_ADDR_SIZE 4
848 #define QDF_IPV4_ADDR_STR "%d.%d.%d.%d"
849 #define QDF_IPV4_ADDR_ARRAY(a) (a)[0], (a)[1], (a)[2], (a)[3]
850 #define QDF_IPV4_ADDR_ZERO_INIT { { 0, 0, 0, 0 } }
851 
852 /**
853  * struct qdf_ipv4_addr - An IPV4 address
854  * @bytes: the raw address bytes array
855  */
856 struct qdf_ipv4_addr {
857 	uint8_t bytes[QDF_IPV4_ADDR_SIZE];
858 };
859 
860 /**
861  * qdf_ipv4_parse() - parse the given string as an IPV4 address
862  * @ipv4_str: the input IPV4 address string to parse
863  * @out_addr: the output IPV4 address value, populated on success
864  *
865  * An IPV4 address is a set of 4, dot-delimited, decimal encoded octets.
866  *
867  * E.g.
868  *	0.0.0.0 (wildcard address)
869  *	127.0.0.1 (loopback address)
870  *	255.255.255.255 (broadcast address)
871  *	192.168.0.1 (an arbitrary address)
872  *
873  * Historically, non-decimal encodings have also been used to represent IPV4
874  * addresses, but these are not supported here.
875  *
876  * Return: QDF_STATUS
877  */
878 QDF_STATUS qdf_ipv4_parse(const char *ipv4_str, struct qdf_ipv4_addr *out_addr);
879 
880 #define QDF_IPV6_ADDR_SIZE 16
881 #define QDF_IPV6_ADDR_HEXTET_COUNT 8
882 #define QDF_IPV6_ADDR_STR "%x:%x:%x:%x:%x:%x:%x:%x"
883 #define QDF_IPV6_ADDR_ARRAY(a) \
884 	((a)[0] << 8) + (a)[1], ((a)[2] << 8) + (a)[3], \
885 	((a)[4] << 8) + (a)[5], ((a)[6] << 8) + (a)[7], \
886 	((a)[8] << 8) + (a)[9], ((a)[10] << 8) + (a)[11], \
887 	((a)[12] << 8) + (a)[13], ((a)[14] << 8) + (a)[15]
888 #define QDF_IPV6_ADDR_ZERO_INIT \
889 	{ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } }
890 
891 /**
892  * struct qdf_ipv6_addr - An IPV6 address
893  * @bytes: the raw address bytes array
894  */
895 struct qdf_ipv6_addr {
896 	uint8_t bytes[QDF_IPV6_ADDR_SIZE];
897 };
898 
899 /**
900  * qdf_ipv6_parse() - parse the given string as an IPV6 address
901  * @ipv6_str: the input IPV6 address string to parse
902  * @out_addr: the output IPV6 address value, populated on success
903  *
904  * A hextet is a pair of octets. An IPV6 address is a set of 8, colon-delimited,
905  * hexadecimal encoded hextets. Each hextet may omit leading zeros. One or more
906  * zero-hextets may be "compressed" using a pair of colons ("::"). Up to one
907  * such zero-compression is allowed per address.
908  *
909  * E.g.
910  *	0:0:0:0:0:0:0:0 (unspecified address)
911  *	:: (also the unspecified address)
912  *	0:0:0:0:0:0:0:1 (loopback address)
913  *	::1 (also the loopback address)
914  *	900a:ae7::6 (an arbitrary address)
915  *	900a:ae7:0:0:0:0:0:6 (the same arbitrary address)
916  *
917  * Hexadecimal digits may be in either upper or lower case.
918  *
919  * Return: QDF_STATUS
920  */
921 QDF_STATUS qdf_ipv6_parse(const char *ipv6_str, struct qdf_ipv6_addr *out_addr);
922 
923 /**
924  * qdf_uint16_array_parse() - parse the given string as uint16 array
925  * @in_str: the input string to parse
926  * @out_array: the output uint16 array, populated on success
927  * @array_size: size of the array
928  * @out_size: size of the populated array
929  *
930  * This API is called to convert string (each value separated by
931  * a comma) into an uint16 array
932  *
933  * Return: QDF_STATUS
934  */
935 
936 QDF_STATUS qdf_uint16_array_parse(const char *in_str, uint16_t *out_array,
937 				  qdf_size_t array_size, qdf_size_t *out_size);
938 
939 /**
940  * qdf_uint8_array_parse() - parse the given string as uint8 array
941  * @in_str: the input string to parse
942  * @out_array: the output uint8 array, populated on success
943  * @array_size: size of the array
944  * @out_size: size of the populated array
945  *
946  * This API is called to convert string (each byte separated by
947  * a comma) into an u8 array
948  *
949  * Return: QDF_STATUS
950  */
951 QDF_STATUS qdf_uint8_array_parse(const char *in_str, uint8_t *out_array,
952 				 qdf_size_t array_size, qdf_size_t *out_size);
953 
954 #define QDF_MAX_NUM_CHAN   (128)
955 
956 #define QDF_BCAST_MAC_ADDR (0xFF)
957 #define QDF_MCAST_IPV4_MAC_ADDR (0x01)
958 #define QDF_MCAST_IPV6_MAC_ADDR (0x33)
959 
960 /**
961  * struct qdf_tso_frag_t - fragments of a single TCP segment
962  * @paddr_low_32: Lower 32 bits of the buffer pointer
963  * @paddr_upper_16: upper 16 bits of the buffer pointer
964  * @length: length of the buffer
965  * @vaddr: virtual address
966  *
967  * This structure holds the fragments of a single TCP segment of a
968  * given jumbo TSO network buffer
969  */
970 struct qdf_tso_frag_t {
971 	uint16_t length;
972 	unsigned char *vaddr;
973 	qdf_dma_addr_t paddr;
974 };
975 
976 #define FRAG_NUM_MAX 6
977 #define TSO_SEG_MAGIC_COOKIE 0x1EED
978 
979 /**
980  * struct qdf_tso_flags_t - TSO specific flags
981  * @tso_enable: Enable transmit segmentation offload
982  * @tcp_flags_mask: Tcp_flag is inserted into the header based
983  * on the mask
984  * @l2_len: L2 length for the msdu
985  * @ip_len: IP length for the msdu
986  * @tcp_seq_num: TCP sequence number
987  * @ip_id: IP identification number
988  *
989  * This structure holds the TSO specific flags extracted from the TSO network
990  * buffer for a given TCP segment
991  */
992 struct qdf_tso_flags_t {
993 	uint32_t tso_enable:1,
994 			reserved_0a:6,
995 			fin:1,
996 			syn:1,
997 			rst:1,
998 			psh:1,
999 			ack:1,
1000 			urg:1,
1001 			ece:1,
1002 			cwr:1,
1003 			ns:1,
1004 			tcp_flags_mask:9,
1005 			reserved_0b:7;
1006 
1007 	uint32_t l2_len:16,
1008 			ip_len:16;
1009 
1010 	uint32_t tcp_seq_num;
1011 
1012 	uint32_t ip_id:16,
1013 			ipv4_checksum_en:1,
1014 			udp_ipv4_checksum_en:1,
1015 			udp_ipv6_checksum_en:1,
1016 			tcp_ipv4_checksum_en:1,
1017 			tcp_ipv6_checksum_en:1,
1018 			partial_checksum_en:1,
1019 			reserved_3a:10;
1020 
1021 	uint32_t checksum_offset:14,
1022 			reserved_4a:2,
1023 			payload_start_offset:14,
1024 			reserved_4b:2;
1025 
1026 	uint32_t payload_end_offset:14,
1027 			reserved_5:18;
1028 };
1029 
1030 /**
1031  * struct qdf_tso_seg_t - single TSO segment
1032  * @tso_flags: TSO flags
1033  * @num_frags: number of fragments
1034  * @total_len: total length of the packet
1035  * @tso_frags: array holding the fragments
1036  *
1037  * This structure holds the information of a single TSO segment of a jumbo
1038  * TSO network buffer
1039  */
1040 struct qdf_tso_seg_t {
1041 	struct qdf_tso_flags_t tso_flags;
1042 	uint32_t num_frags;
1043 	uint32_t total_len;
1044 	struct qdf_tso_frag_t tso_frags[FRAG_NUM_MAX];
1045 };
1046 
1047 /**
1048  * TSO seg elem action caller locations: goes into dbg.history below.
1049  * Needed to be defined outside of the feature so that
1050  * callers can be coded without ifdefs (even if they get
1051  * resolved to nothing)
1052  */
1053 enum tsoseg_dbg_caller_e {
1054 	TSOSEG_LOC_UNDEFINED,
1055 	TSOSEG_LOC_INIT1,
1056 	TSOSEG_LOC_INIT2,
1057 	TSOSEG_LOC_FREE,
1058 	TSOSEG_LOC_ALLOC,
1059 	TSOSEG_LOC_DEINIT,
1060 	TSOSEG_LOC_GETINFO,
1061 	TSOSEG_LOC_FILLHTTSEG,
1062 	TSOSEG_LOC_FILLCMNSEG,
1063 	TSOSEG_LOC_PREPARETSO,
1064 	TSOSEG_LOC_TXPREPLLFAST,
1065 	TSOSEG_LOC_UNMAPTSO,
1066 	TSOSEG_LOC_UNMAPLAST,
1067 	TSOSEG_LOC_FORCE_FREE,
1068 };
1069 #ifdef TSOSEG_DEBUG
1070 
1071 /**
1072  * WARNING: Don't change the history size without changing the wrap
1073  *  code in qdf_tso_seg_dbg_record function
1074  */
1075 #define MAX_TSO_SEG_ACT_HISTORY 16
1076 struct qdf_tso_seg_dbg_history_t {
1077 	uint64_t ts;
1078 	short    id;
1079 };
1080 struct qdf_tso_seg_dbg_t {
1081 	void    *txdesc;  /* owner - (ol_txrx_tx_desc_t *) */
1082 	qdf_atomic_t cur; /* index of last valid entry */
1083 	struct qdf_tso_seg_dbg_history_t h[MAX_TSO_SEG_ACT_HISTORY];
1084 };
1085 #endif /* TSOSEG_DEBUG */
1086 
1087 /**
1088  * qdf_tso_seg_elem_t - tso segment element
1089  * @next: pointer to the next segment
1090  * @seg: instance of segment
1091  */
1092 struct qdf_tso_seg_elem_t {
1093 	struct qdf_tso_seg_elem_t *next;
1094 	struct qdf_tso_seg_t seg;
1095 	uint32_t cookie:13,
1096 		on_freelist:1,
1097 		sent_to_target:1,
1098 		force_free:1;
1099 #ifdef TSOSEG_DEBUG
1100 	struct qdf_tso_seg_dbg_t dbg;
1101 #endif /* TSOSEG_DEBUG */
1102 };
1103 
1104 /**
1105  * struct qdf_tso_num_seg_t - single element to count for num of seg
1106  * @tso_cmn_num_seg: num of seg in a jumbo skb
1107  *
1108  * This structure holds the information of num of segments of a jumbo
1109  * TSO network buffer.
1110  */
1111 struct qdf_tso_num_seg_t {
1112 	uint32_t tso_cmn_num_seg;
1113 };
1114 
1115 /**
1116  * qdf_tso_num_seg_elem_t - num of tso segment element for jumbo skb
1117  * @next: pointer to the next segment
1118  * @num_seg: instance of num of seg
1119  */
1120 struct qdf_tso_num_seg_elem_t {
1121 	struct qdf_tso_num_seg_elem_t *next;
1122 	struct qdf_tso_num_seg_t num_seg;
1123 };
1124 
1125 /**
1126  * struct qdf_tso_info_t - TSO information extracted
1127  * @is_tso: is this is a TSO frame
1128  * @num_segs: number of segments
1129  * @tso_seg_list: list of TSO segments for this jumbo packet
1130  * @curr_seg: segment that is currently being processed
1131  * @tso_num_seg_list: num of tso seg for this jumbo packet
1132  * @msdu_stats_idx: msdu index for tso stats
1133  *
1134  * This structure holds the TSO information extracted after parsing the TSO
1135  * jumbo network buffer. It contains a chain of the TSO segments belonging to
1136  * the jumbo packet
1137  */
1138 struct qdf_tso_info_t {
1139 	uint8_t is_tso;
1140 	uint32_t num_segs;
1141 	struct qdf_tso_seg_elem_t *tso_seg_list;
1142 	struct qdf_tso_seg_elem_t *curr_seg;
1143 	struct qdf_tso_num_seg_elem_t *tso_num_seg_list;
1144 	uint32_t msdu_stats_idx;
1145 };
1146 
1147 /**
1148  * Used to set classify bit in CE desc.
1149  */
1150 #define QDF_CE_TX_CLASSIFY_BIT_S   5
1151 
1152 /**
1153  * QDF_CE_TX_PKT_TYPE_BIT_S - 2 bits starting at bit 6 in CE desc.
1154  */
1155 #define QDF_CE_TX_PKT_TYPE_BIT_S   6
1156 
1157 /**
1158  * QDF_CE_TX_PKT_OFFSET_BIT_S - 12 bits --> 16-27, in the CE desciptor
1159  *  the length of HTT/HTC descriptor
1160  */
1161 #define QDF_CE_TX_PKT_OFFSET_BIT_S  16
1162 
1163 /**
1164  * QDF_CE_TX_PKT_OFFSET_BIT_M - Mask for packet offset in the CE descriptor.
1165  */
1166 #define QDF_CE_TX_PKT_OFFSET_BIT_M   0x0fff0000
1167 
1168 /**
1169  * enum qdf_suspend_type - type of suspend
1170  * @QDF_SYSTEM_SUSPEND: System suspend triggered wlan suspend
1171  * @QDF_RUNTIME_SUSPEND: Runtime pm inactivity timer triggered wlan suspend
1172  */
1173 enum qdf_suspend_type {
1174 	QDF_SYSTEM_SUSPEND,
1175 	QDF_RUNTIME_SUSPEND
1176 };
1177 
1178 /**
1179  * enum qdf_hang_reason - host hang/ssr reason
1180  * @QDF_REASON_UNSPECIFIED: Unspecified reason
1181  * @QDF_RX_HASH_NO_ENTRY_FOUND: No Map for the MAC entry for the received frame
1182  * @QDF_PEER_DELETION_TIMEDOUT: peer deletion timeout happened
1183  * @QDF_PEER_UNMAP_TIMEDOUT: peer unmap timeout
1184  * @QDF_SCAN_REQ_EXPIRED: Scan request timed out
1185  * @QDF_SCAN_ATTEMPT_FAILURES: Consecutive Scan attempt failures
1186  * @QDF_GET_MSG_BUFF_FAILURE: Unable to get the message buffer
1187  * @QDF_ACTIVE_LIST_TIMEOUT: Current command processing is timedout
1188  * @QDF_SUSPEND_TIMEOUT: Timeout for an ACK from FW for suspend request
1189  * @QDF_RESUME_TIMEOUT: Timeout for an ACK from FW for resume request
1190  * @QDF_WMI_EXCEED_MAX_PENDING_CMDS: wmi exceed max pending cmd
1191  */
1192 enum qdf_hang_reason {
1193 	QDF_REASON_UNSPECIFIED = 0,
1194 	QDF_RX_HASH_NO_ENTRY_FOUND = 1,
1195 	QDF_PEER_DELETION_TIMEDOUT = 2,
1196 	QDF_PEER_UNMAP_TIMEDOUT = 3,
1197 	QDF_SCAN_REQ_EXPIRED = 4,
1198 	QDF_SCAN_ATTEMPT_FAILURES = 5,
1199 	QDF_GET_MSG_BUFF_FAILURE = 6,
1200 	QDF_ACTIVE_LIST_TIMEOUT = 7,
1201 	QDF_SUSPEND_TIMEOUT = 8,
1202 	QDF_RESUME_TIMEOUT = 9,
1203 	QDF_WMI_EXCEED_MAX_PENDING_CMDS = 10,
1204 };
1205 
1206 /**
1207  * enum qdf_stats_verbosity_level - Verbosity levels for stats
1208  * for which want to have different levels
1209  * @QDF_STATS_VERBOSITY_LEVEL_LOW: Stats verbosity level low
1210  * @QDF_STATS_VERBOSITY_LEVEL_HIGH: Stats verbosity level high
1211  */
1212 enum qdf_stats_verbosity_level {
1213 	QDF_STATS_VERBOSITY_LEVEL_LOW,
1214 	QDF_STATS_VERBOSITY_LEVEL_HIGH
1215 };
1216 
1217 /**
1218  * enum qdf_clock_id - The clock IDs of the various system clocks
1219  * @QDF_CLOCK_REALTIME: Clock is close to current time of day
1220  * @QDF_CLOCK_MONOTONIC: Clock is absolute elapsed time
1221  */
1222 enum qdf_clock_id {
1223 	QDF_CLOCK_REALTIME = __QDF_CLOCK_REALTIME,
1224 	QDF_CLOCK_MONOTONIC = __QDF_CLOCK_MONOTONIC
1225 };
1226 
1227 /**
1228  * enum qdf_hrtimer_mode - Mode arguments of qdf_hrtimer_data_t
1229  * related functions
1230  * @QDF_HRTIMER_MODE_ABS: Time value is absolute
1231  * @QDF_HRTIMER_MODE_REL: Time value is relative to now
1232  * @QDF_HRTIMER_MODE_PINNED: Timer is bound to CPU
1233  */
1234 enum qdf_hrtimer_mode {
1235 	QDF_HRTIMER_MODE_ABS = __QDF_HRTIMER_MODE_ABS,
1236 	QDF_HRTIMER_MODE_REL = __QDF_HRTIMER_MODE_REL,
1237 	QDF_HRTIMER_MODE_PINNED =  __QDF_HRTIMER_MODE_PINNED,
1238 };
1239 
1240 /**
1241  * enum qdf_hrtimer_restart_status - Return values for the
1242  * qdf_hrtimer_data_t callback function
1243  * @QDF_HRTIMER_NORESTART: Timer is not restarted
1244  * @QDF_HRTIMER_RESTART: Timer must be restarted
1245  */
1246 enum qdf_hrtimer_restart_status {
1247 	QDF_HRTIMER_NORESTART = __QDF_HRTIMER_NORESTART,
1248 	QDF_HRTIMER_RESTART = __QDF_HRTIMER_RESTART,
1249 };
1250 
1251 /**
1252  * enum qdf_context_mode - Values for the
1253  * hrtimer context
1254  * @QDF_CONTEXT_HARDWARE: Runs in hw interrupt context
1255  * @QDF_CONTEXT_TASKLET: Runs in tasklet context
1256  */
1257 enum qdf_context_mode {
1258 	QDF_CONTEXT_HARDWARE = 0,
1259 	QDF_CONTEXT_TASKLET = 1,
1260 };
1261 
1262 /**
1263  * enum qdf_dp_tx_rx_status - TX/RX packet status
1264  * @QDF_TX_RX_STATUS_INVALID: default invalid status
1265  * @QDF_TX_RX_STATUS_OK: successfully sent + acked
1266  * @QDF_TX_RX_STATUS_FW_DISCARD: packet not sent
1267  * @QDF_TX_RX_STATUS_NO_ACK: packet sent but no ack
1268  * @QDF_TX_RX_STATUS_DROP: packet dropped in host
1269  */
1270 enum qdf_dp_tx_rx_status {
1271 	QDF_TX_RX_STATUS_INVALID,
1272 	QDF_TX_RX_STATUS_OK,
1273 	QDF_TX_RX_STATUS_FW_DISCARD,
1274 	QDF_TX_RX_STATUS_NO_ACK,
1275 	QDF_TX_RX_STATUS_DROP,
1276 };
1277 
1278 #endif /* __QDF_TYPES_H */
1279