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