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