xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_types.h (revision e1d3d092f61a07549ab97f6f1f0c86554e0c642f)
1 /*
2  * Copyright (c) 2014-2017 The Linux Foundation. All rights reserved.
3  *
4  * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
5  *
6  *
7  * Permission to use, copy, modify, and/or distribute this software for
8  * any purpose with or without fee is hereby granted, provided that the
9  * above copyright notice and this permission notice appear in all
10  * copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
13  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
14  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
15  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
16  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
17  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
18  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
19  * PERFORMANCE OF THIS SOFTWARE.
20  */
21 
22 /*
23  * This file was originally distributed by Qualcomm Atheros, Inc.
24  * under proprietary terms before Copyright ownership was assigned
25  * to the Linux Foundation.
26  */
27 
28 /**
29  * DOC: qdf_types.h
30  * QCA driver framework (QDF) basic type definitions
31  */
32 
33 #if !defined(__QDF_TYPES_H)
34 #define __QDF_TYPES_H
35 
36 #ifndef CONFIG_MCL
37 #if !defined(__printf)
38 #define __printf(a, b)
39 #endif
40 #endif
41 
42 
43 /* Include Files */
44 #include <i_qdf_types.h>
45 
46 /* Preprocessor definitions and constants */
47 #define QDF_MAX_SGLIST 4
48 
49 /**
50  * struct qdf_sglist - scatter-gather list
51  * @nsegs: total number of segments
52  * struct __sg_segs - scatter-gather segment list
53  * @vaddr: Virtual address of the segment
54  * @len: Length of the segment
55  */
56 typedef struct qdf_sglist {
57 	uint32_t nsegs;
58 	struct __sg_segs {
59 		uint8_t  *vaddr;
60 		uint32_t len;
61 	} sg_segs[QDF_MAX_SGLIST];
62 } qdf_sglist_t;
63 
64 #define QDF_MAX_SCATTER __QDF_MAX_SCATTER
65 
66 /**
67  * QDF_SWAP_U16 - swap input u16 value
68  * @_x: variable to swap
69  */
70 #define QDF_SWAP_U16(_x) \
71 	((((_x) << 8) & 0xFF00) | (((_x) >> 8) & 0x00FF))
72 
73 /**
74  * QDF_SWAP_U32 - swap input u32 value
75  * @_x: variable to swap
76  */
77 #define QDF_SWAP_U32(_x) \
78 	(((((_x) << 24) & 0xFF000000) | (((_x) >> 24) & 0x000000FF)) | \
79 	 ((((_x) << 8) & 0x00FF0000) | (((_x) >> 8) & 0x0000FF00)))
80 
81 /* ticks per second */
82 #define QDF_TICKS_PER_SECOND (1000)
83 
84 /**
85  * QDF_ARRAY_SIZE - get array size
86  * @_arr: array variable name
87  */
88 #define QDF_ARRAY_SIZE(_arr) (sizeof(_arr) / sizeof((_arr)[0]))
89 
90 #define QDF_MAX_SCATTER __QDF_MAX_SCATTER
91 
92 /**
93  * qdf_packed - denotes structure is packed.
94  */
95 #define qdf_packed __qdf_packed
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_device_t - Platform/bus generic handle.
112  * Used for bus specific functions.
113  */
114 typedef __qdf_device_t qdf_device_t;
115 
116 /**
117  * typedef qdf_size_t - size of an object
118  */
119 typedef __qdf_size_t qdf_size_t;
120 
121 /**
122  * typedef __qdf_off_t - offset for API's that need them.
123  */
124 typedef __qdf_off_t      qdf_off_t;
125 
126 /**
127  * typedef qdf_dma_map_t - DMA mapping object.
128  */
129 typedef __qdf_dma_map_t qdf_dma_map_t;
130 
131 /**
132  * tyepdef qdf_dma_addr_t - DMA address.
133  */
134 typedef __qdf_dma_addr_t qdf_dma_addr_t;
135 
136 /**
137  * typedef __qdf_dma_size_t - DMA size.
138  */
139 typedef __qdf_dma_size_t     qdf_dma_size_t;
140 
141 /**
142  * tyepdef qdf_dma_context_t - DMA context.
143  */
144 typedef __qdf_dma_context_t qdf_dma_context_t;
145 
146 /**
147  * pointer to net device
148  */
149 typedef __qdf_netdev_t qdf_netdev_t;
150 
151 /**
152  * struct qdf_dma_map_info - Information inside a DMA map.
153  * @nsegs: total number mapped segments
154  * struct __dma_segs - Information of physical address.
155  * @paddr: physical(dam'able) address of the segment
156  * @len: length of the segment
157  */
158 typedef struct qdf_dma_map_info {
159 	uint32_t nsegs;
160 	struct __dma_segs {
161 		qdf_dma_addr_t paddr;
162 		qdf_dma_size_t len;
163 	} dma_segs[QDF_MAX_SCATTER];
164 } qdf_dmamap_info_t;
165 
166 #define qdf_iomem_t __qdf_iomem_t;
167 
168 /**
169  * typedef enum QDF_TIMER_TYPE - QDF timer type
170  * @QDF_TIMER_TYPE_SW: Deferrable SW timer it will not cause CPU to wake up
171  * on expiry
172  * @QDF_TIMER_TYPE_WAKE_APPS: Non deferrable timer which will cause CPU to
173  * wake up on expiry
174  */
175 typedef enum {
176 	QDF_TIMER_TYPE_SW,
177 	QDF_TIMER_TYPE_WAKE_APPS
178 } QDF_TIMER_TYPE;
179 
180 /**
181  * tyepdef qdf_resource_type_t - hw resources
182  * @QDF_RESOURCE_TYPE_MEM: memory resource
183  * @QDF_RESOURCE_TYPE_IO: io resource
184  * Define the hw resources the OS has allocated for the device
185  * Note that start defines a mapped area.
186  */
187 typedef enum {
188 	QDF_RESOURCE_TYPE_MEM,
189 	QDF_RESOURCE_TYPE_IO,
190 } qdf_resource_type_t;
191 
192 /**
193  * tyepdef qdf_resource_t - representation of a h/w resource.
194  * @start: start
195  * @end: end
196  * @type: resource type
197  */
198 typedef struct {
199 	uint64_t start;
200 	uint64_t end;
201 	qdf_resource_type_t type;
202 } qdf_resource_t;
203 
204 /**
205  * typedef qdf_dma_dir_t - DMA directions
206  * @QDF_DMA_BIDIRECTIONAL: bidirectional data
207  * @QDF_DMA_TO_DEVICE: data going from device to memory
208  * @QDF_DMA_FROM_DEVICE: data going from memory to device
209  */
210 typedef enum {
211 	QDF_DMA_BIDIRECTIONAL = __QDF_DMA_BIDIRECTIONAL,
212 	QDF_DMA_TO_DEVICE = __QDF_DMA_TO_DEVICE,
213 	QDF_DMA_FROM_DEVICE = __QDF_DMA_FROM_DEVICE,
214 } qdf_dma_dir_t;
215 
216 /* work queue(kernel thread)/DPC function callback */
217 typedef void (*qdf_defer_fn_t)(void *);
218 
219 /*
220  * Prototype of the critical region function that is to be
221  * executed with spinlock held and interrupt disalbed
222  */
223 typedef bool (*qdf_irqlocked_func_t)(void *);
224 
225 /* Prototype of timer function */
226 typedef void (*qdf_timer_func_t)(void *);
227 
228 #define qdf_offsetof(type, field) offsetof(type, field)
229 
230 /**
231  * typedef enum QDF_MODULE_ID  - Debug category level
232  * @QDF_MODULE_ID_TDLS: TDLS
233  * @QDF_MODULE_ID_ACS: auto channel selection
234  * @QDF_MODULE_ID_SCAN_SM: scan state machine
235  * @QDF_MODULE_ID_SCANENTRY: scan entry
236  * @QDF_MODULE_ID_WDS: WDS handling
237  * @QDF_MODULE_ID_ACTION: action management frames
238  * @QDF_MODULE_ID_ROAM: sta mode roaming
239  * @QDF_MODULE_ID_INACT: inactivity handling
240  * @QDF_MODULE_ID_DOTH: 11.h
241  * @QDF_MODULE_ID_IQUE: IQUE features
242  * @QDF_MODULE_ID_WME: WME protocol
243  * @QDF_MODULE_ID_ACL: ACL handling
244  * @QDF_MODULE_ID_WPA: WPA/RSN protocol
245  * @QDF_MODULE_ID_RADKEYS: dump 802.1x keys
246  * @QDF_MODULE_ID_RADDUMP: dump 802.1x radius packets
247  * @QDF_MODULE_ID_RADIUS: 802.1x radius client
248  * @QDF_MODULE_ID_DOT1XSM: 802.1x state machine
249  * @QDF_MODULE_ID_DOT1X: 802.1x authenticator
250  * @QDF_MODULE_ID_POWER: power save handling
251  * @QDF_MODULE_ID_STATS: state machine
252  * @QDF_MODULE_ID_OUTPUT: output handling
253  * @QDF_MODULE_ID_SCAN: scanning
254  * @QDF_MODULE_ID_AUTH: authentication handling
255  * @QDF_MODULE_ID_ASSOC: association handling
256  * @QDF_MODULE_ID_NODE: node handling
257  * @QDF_MODULE_ID_ELEMID: element id parsing
258  * @QDF_MODULE_ID_XRATE: rate set handling
259  * @QDF_MODULE_ID_INPUT: input handling
260  * @QDF_MODULE_ID_CRYPTO: crypto work
261  * @QDF_MODULE_ID_DUMPPKTS: IFF_LINK2 equivalant
262  * @QDF_MODULE_ID_DEBUG: IFF_DEBUG equivalent
263  * @QDF_MODULE_ID_MLME: MLME
264  * @QDF_MODULE_ID_RRM: Radio resource measurement
265  * @QDF_MODULE_ID_WNM: Wireless Network Management
266  * @QDF_MODULE_ID_P2P_PROT: P2P Protocol driver
267  * @QDF_MODULE_ID_PROXYARP: 11v Proxy ARP
268  * @QDF_MODULE_ID_L2TIF: Hotspot 2.0 L2 TIF
269  * @QDF_MODULE_ID_WIFIPOS: WifiPositioning Feature
270  * @QDF_MODULE_ID_WRAP: WRAP or Wireless ProxySTA
271  * @QDF_MODULE_ID_DFS: DFS debug mesg
272  * @QDF_MODULE_ID_TLSHIM: TLSHIM module ID
273  * @QDF_MODULE_ID_WMI: WMI module ID
274  * @QDF_MODULE_ID_HTT: HTT module ID
275  * @QDF_MODULE_ID_HDD: HDD module ID
276  * @QDF_MODULE_ID_SME: SME module ID
277  * @QDF_MODULE_ID_PE: PE module ID
278  * @QDF_MODULE_ID_WMA: WMA module ID
279  * @QDF_MODULE_ID_SYS: SYS module ID
280  * @QDF_MODULE_ID_QDF: QDF module ID
281  * @QDF_MODULE_ID_SAP: SAP module ID
282  * @QDF_MODULE_ID_HDD_SOFTAP: HDD SAP module ID
283  * @QDF_MODULE_ID_HDD_DATA: HDD DATA module ID
284  * @QDF_MODULE_ID_HDD_SAP_DATA: HDD SAP DATA module ID
285  * @QDF_MODULE_ID_HIF: HIF module ID
286  * @QDF_MODULE_ID_HTC: HTC module ID
287  * @QDF_MODULE_ID_TXRX: TXRX module ID
288  * @QDF_MODULE_ID_QDF_DEVICE: QDF DEVICE module ID
289  * @QDF_MODULE_ID_CFG: CFG module ID
290  * @QDF_MODULE_ID_BMI: BMI module ID
291  * @QDF_MODULE_ID_EPPING: EPPING module ID
292  * @QDF_MODULE_ID_QVIT: QVIT module ID
293  * @QDF_MODULE_ID_DP: Data-path module ID
294  * @QDF_MODULE_ID_SOC: SOC module ID
295  * @QDF_MODULE_ID_OS_IF: OS-interface module ID
296  * @QDF_MODULE_ID_TARGET_IF: targer interface module ID
297  * @QDF_MODULE_ID_SCHEDULER: schduler module ID
298  * @QDF_MODULE_ID_MGMT_TXRX: management TX/RX module ID
299  * @QDF_MODULE_ID_SERIALIZATION: serialization module ID
300  * @QDF_MODULE_ID_PMO: PMO (power manager and offloads) Module ID
301  * @QDF_MODULE_ID_P2P: P2P module ID
302  * @QDF_MODULE_ID_POLICY_MGR: Policy Manager module ID
303  * @QDF_MODULE_ID_CONFIG: CONFIG module ID
304  * @QDF_MODULE_ID_REGULATORY    : REGULATORY module ID
305  * @QDF_MODULE_ID_NAN: NAN module ID
306  * @QDF_MODULE_ID_SPECTRAL: Spectral module ID
307  * @QDF_MODULE_ID_ANY: anything
308  * @QDF_MODULE_ID_MAX: Max place holder module ID
309  */
310 typedef enum {
311 	QDF_MODULE_ID_TDLS      = 0,
312 	QDF_MODULE_ID_ACS,
313 	QDF_MODULE_ID_SCAN_SM,
314 	QDF_MODULE_ID_SCANENTRY,
315 	QDF_MODULE_ID_WDS,
316 	QDF_MODULE_ID_ACTION,
317 	QDF_MODULE_ID_ROAM,
318 	QDF_MODULE_ID_INACT,
319 	QDF_MODULE_ID_DOTH      = 8,
320 	QDF_MODULE_ID_IQUE,
321 	QDF_MODULE_ID_WME,
322 	QDF_MODULE_ID_ACL,
323 	QDF_MODULE_ID_WPA,
324 	QDF_MODULE_ID_RADKEYS,
325 	QDF_MODULE_ID_RADDUMP,
326 	QDF_MODULE_ID_RADIUS,
327 	QDF_MODULE_ID_DOT1XSM   = 16,
328 	QDF_MODULE_ID_DOT1X,
329 	QDF_MODULE_ID_POWER,
330 	QDF_MODULE_ID_STATE,
331 	QDF_MODULE_ID_OUTPUT,
332 	QDF_MODULE_ID_SCAN,
333 	QDF_MODULE_ID_AUTH,
334 	QDF_MODULE_ID_ASSOC,
335 	QDF_MODULE_ID_NODE      = 24,
336 	QDF_MODULE_ID_ELEMID,
337 	QDF_MODULE_ID_XRATE,
338 	QDF_MODULE_ID_INPUT,
339 	QDF_MODULE_ID_CRYPTO,
340 	QDF_MODULE_ID_DUMPPKTS,
341 	QDF_MODULE_ID_DEBUG,
342 	QDF_MODULE_ID_MLME,
343 	QDF_MODULE_ID_RRM       = 32,
344 	QDF_MODULE_ID_WNM,
345 	QDF_MODULE_ID_P2P_PROT,
346 	QDF_MODULE_ID_PROXYARP,
347 	QDF_MODULE_ID_L2TIF,
348 	QDF_MODULE_ID_WIFIPOS,
349 	QDF_MODULE_ID_WRAP,
350 	QDF_MODULE_ID_DFS,
351 	QDF_MODULE_ID_ATF       = 40,
352 	QDF_MODULE_ID_SPLITMAC,
353 	QDF_MODULE_ID_IOCTL,
354 	QDF_MODULE_ID_NAC,
355 	QDF_MODULE_ID_MESH,
356 	QDF_MODULE_ID_MBO,
357 	QDF_MODULE_ID_EXTIOCTL_CHANSWITCH,
358 	QDF_MODULE_ID_EXTIOCTL_CHANSSCAN,
359 	QDF_MODULE_ID_TLSHIM    = 48,
360 	QDF_MODULE_ID_WMI,
361 	QDF_MODULE_ID_HTT,
362 	QDF_MODULE_ID_HDD,
363 	QDF_MODULE_ID_SME,
364 	QDF_MODULE_ID_PE,
365 	QDF_MODULE_ID_WMA,
366 	QDF_MODULE_ID_SYS,
367 	QDF_MODULE_ID_QDF       = 56,
368 	QDF_MODULE_ID_SAP,
369 	QDF_MODULE_ID_HDD_SOFTAP,
370 	QDF_MODULE_ID_HDD_DATA,
371 	QDF_MODULE_ID_HDD_SAP_DATA,
372 	QDF_MODULE_ID_HIF,
373 	QDF_MODULE_ID_HTC,
374 	QDF_MODULE_ID_TXRX,
375 	QDF_MODULE_ID_QDF_DEVICE = 64,
376 	QDF_MODULE_ID_CFG,
377 	QDF_MODULE_ID_BMI,
378 	QDF_MODULE_ID_EPPING,
379 	QDF_MODULE_ID_QVIT,
380 	QDF_MODULE_ID_DP,
381 	QDF_MODULE_ID_SOC,
382 	QDF_MODULE_ID_OS_IF,
383 	QDF_MODULE_ID_TARGET_IF,
384 	QDF_MODULE_ID_SCHEDULER,
385 	QDF_MODULE_ID_MGMT_TXRX,
386 	QDF_MODULE_ID_SERIALIZATION,
387 	QDF_MODULE_ID_PMO,
388 	QDF_MODULE_ID_P2P,
389 	QDF_MODULE_ID_POLICY_MGR,
390 	QDF_MODULE_ID_CONFIG,
391 	QDF_MODULE_ID_REGULATORY,
392 	QDF_MODULE_ID_SA_API,
393 	QDF_MODULE_ID_NAN,
394 	QDF_MODULE_ID_OFFCHAN_TXRX,
395 	QDF_MODULE_ID_SON,
396 	QDF_MODULE_ID_SPECTRAL,
397 	QDF_MODULE_ID_ANY,
398 	QDF_MODULE_ID_MAX,
399 } QDF_MODULE_ID;
400 
401 /**
402  * typedef enum QDF_TRACE_LEVEL - Debug verbose level
403  * @QDF_TRACE_LEVEL_NONE: no trace will be logged. This value is in place
404  *			  for the qdf_trace_setlevel() to allow the user
405  *			  to turn off all traces
406  * @QDF_TRACE_LEVEL_FATAL: Indicates fatal error conditions
407  * @QDF_TRACE_LEVEL_ERROR: Indicates error conditions
408  * @QDF_TRACE_LEVEL_WARN: May indicate that an error will occur if action
409  *			  is not taken
410  * @QDF_TRACE_LEVEL_INFO: Normal operational messages that require no action
411  * @QDF_TRACE_LEVEL_INFO_HIGH: High level operational messages that require
412  *			       no action
413  * @QDF_TRACE_LEVEL_INFO_MED: Middle level operational messages that require
414  *			      no action
415  * @QDF_TRACE_LEVEL_INFO_LOW: Low level operational messages that require
416  *			      no action
417  * @QDF_TRACE_LEVEL_DEBUG: Information useful to developers for debugging
418  * @QDF_TRACE_LEVEL_ALL: All trace levels
419  * @QDF_TRACE_LEVEL_MAX: Max trace level
420  */
421 typedef enum {
422 	QDF_TRACE_LEVEL_NONE,
423 	QDF_TRACE_LEVEL_FATAL,
424 	QDF_TRACE_LEVEL_ERROR,
425 	QDF_TRACE_LEVEL_WARN,
426 	QDF_TRACE_LEVEL_INFO,
427 	QDF_TRACE_LEVEL_INFO_HIGH,
428 	QDF_TRACE_LEVEL_INFO_MED,
429 	QDF_TRACE_LEVEL_INFO_LOW,
430 	QDF_TRACE_LEVEL_DEBUG,
431 	QDF_TRACE_LEVEL_ALL,
432 	QDF_TRACE_LEVEL_MAX
433 } QDF_TRACE_LEVEL;
434 
435 /**
436  * enum tQDF_ADAPTER_MODE - Concurrency role.
437  * @QDF_STA_MODE: STA mode
438  * @QDF_SAP_MODE: SAP mode
439  * @QDF_P2P_CLIENT_MODE: P2P client mode
440  * @QDF_P2P_GO_MODE: P2P GO mode
441  * @QDF_FTM_MODE: FTM mode
442  * @QDF_IBSS_MODE: IBSS mode
443  * @QDF_MONITOR_MODE: Monitor mode
444  * @QDF_P2P_DEVICE_MODE: P2P device mode
445  * @QDF_OCB_MODE: OCB device mode
446  * @QDF_EPPING_MODE: EPPING device mode
447  * @QDF_QVIT_MODE: QVIT device mode
448  * @QDF_NDI_MODE: NAN datapath mode
449  * @QDF_WDS_MODE: WDS mode
450  * @QDF_BTAMP_MODE: BTAMP mode
451  * @QDF_AHDEMO_MODE: AHDEMO mode
452  * @QDF_MAX_NO_OF_MODE: Max place holder
453  *
454  * These are generic IDs that identify the various roles
455  * in the software system
456  */
457 enum tQDF_ADAPTER_MODE {
458 	QDF_STA_MODE,
459 	QDF_SAP_MODE,
460 	QDF_P2P_CLIENT_MODE,
461 	QDF_P2P_GO_MODE,
462 	QDF_FTM_MODE,
463 	QDF_IBSS_MODE,
464 	QDF_MONITOR_MODE,
465 	QDF_P2P_DEVICE_MODE,
466 	QDF_OCB_MODE,
467 	QDF_EPPING_MODE,
468 	QDF_QVIT_MODE,
469 	QDF_NDI_MODE,
470 	QDF_WDS_MODE,
471 	QDF_BTAMP_MODE,
472 	QDF_AHDEMO_MODE,
473 	QDF_MAX_NO_OF_MODE
474 };
475 
476 /**
477  * enum tQDF_GLOBAL_CON_MODE - global config mode when
478  * driver is loaded.
479  *
480  * @QDF_GLOBAL_MISSION_MODE: mission mode (STA, SAP...)
481  * @QDF_GLOBAL_MONITOR_MODE: Monitor Mode
482  * @QDF_GLOBAL_FTM_MODE: FTM mode
483  * @QDF_GLOBAL_IBSS_MODE: IBSS mode
484  * @QDF_GLOBAL_EPPING_MODE: EPPING mode
485  * @QDF_GLOBAL_QVIT_MODE: QVIT global mode
486  * @QDF_GLOBAL_MAX_MODE: Max place holder
487  */
488 enum tQDF_GLOBAL_CON_MODE {
489 	QDF_GLOBAL_MISSION_MODE,
490 	QDF_GLOBAL_MONITOR_MODE = 4,
491 	QDF_GLOBAL_FTM_MODE = 5,
492 	QDF_GLOBAL_IBSS_MODE = 6,
493 	QDF_GLOBAL_EPPING_MODE = 8,
494 	QDF_GLOBAL_QVIT_MODE = 9,
495 	QDF_GLOBAL_MAX_MODE
496 };
497 
498 #define  QDF_IS_EPPING_ENABLED(mode) (mode == QDF_GLOBAL_EPPING_MODE)
499 
500 
501 /**
502  * qdf_trace_msg()- logging API
503  * @module: Module identifier. A member of the QDF_MODULE_ID enumeration that
504  *	    identifies the module issuing the trace message.
505  * @level: Trace level. A member of the QDF_TRACE_LEVEL enumeration indicating
506  *	   the severity of the condition causing the trace message to be issued.
507  *	   More severe conditions are more likely to be logged.
508  * @str_format: Format string. The message to be logged. This format string
509  *	       contains printf-like replacement parameters, which follow this
510  *	       parameter in the variable argument list.
511  *
512  * Users wishing to add tracing information to their code should use
513  * QDF_TRACE.  QDF_TRACE() will compile into a call to qdf_trace_msg() when
514  * tracing is enabled.
515  *
516  * Return: nothing
517  *
518  * implemented in qdf_trace.c
519  */
520 void __printf(3, 4) qdf_trace_msg(QDF_MODULE_ID module, QDF_TRACE_LEVEL level,
521 		   char *str_format, ...);
522 
523 #ifdef CONFIG_MCL
524 #define qdf_print(args...) \
525 	QDF_TRACE(QDF_MODULE_ID_QDF, QDF_TRACE_LEVEL_ERROR, ## args)
526 
527 #else
528 #define qdf_print printk
529 #endif /* CONFIG_MCL */
530 
531 #define qdf_vprint    __qdf_vprint
532 #define qdf_snprint   __qdf_snprint
533 
534 #ifdef WLAN_OPEN_P2P_INTERFACE
535 /* This should match with WLAN_MAX_INTERFACES */
536 #define QDF_MAX_CONCURRENCY_PERSONA  (4)
537 #else
538 #define QDF_MAX_CONCURRENCY_PERSONA  (3)
539 #endif
540 
541 #define QDF_STA_MASK (1 << QDF_STA_MODE)
542 #define QDF_SAP_MASK (1 << QDF_SAP_MODE)
543 #define QDF_P2P_CLIENT_MASK (1 << QDF_P2P_CLIENT_MODE)
544 #define QDF_P2P_GO_MASK (1 << QDF_P2P_GO_MODE)
545 
546 #ifdef FEATURE_WLAN_MCC_TO_SCC_SWITCH
547 
548 /**
549  * typedef tQDF_MCC_TO_SCC_SWITCH_MODE - MCC to SCC switch mode.
550  * @QDF_MCC_TO_SCC_SWITCH_DISABLE: Disable switch
551  * @QDF_MCC_TO_SCC_SWITCH_ENABLE: Enable switch
552  * @QDF_MCC_TO_SCC_SWITCH_FORCE: Force switch with SAP restart
553  * @QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION: Force switch without
554  * restart of SAP
555  * @QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL: Switch using fav channel(s)
556  * without SAP restart
557  * @QDF_MCC_TO_SCC_SWITCH_MAX: max switch
558  */
559 typedef enum {
560 	QDF_MCC_TO_SCC_SWITCH_DISABLE = 0,
561 	QDF_MCC_TO_SCC_SWITCH_ENABLE,
562 	QDF_MCC_TO_SCC_SWITCH_FORCE,
563 	QDF_MCC_TO_SCC_SWITCH_FORCE_WITHOUT_DISCONNECTION,
564 	QDF_MCC_TO_SCC_SWITCH_WITH_FAVORITE_CHANNEL,
565 	QDF_MCC_TO_SCC_SWITCH_MAX
566 } tQDF_MCC_TO_SCC_SWITCH_MODE;
567 #endif
568 
569 #if !defined(NULL)
570 #ifdef __cplusplus
571 #define NULL   0
572 #else
573 #define NULL   ((void *)0)
574 #endif
575 #endif
576 
577 /* typedef for QDF Context... */
578 typedef void *v_CONTEXT_t;
579 
580 #define QDF_MAC_ADDR_SIZE (6)
581 #define QDF_MAC_ADDRESS_STR "%02x:%02x:%02x:%02x:%02x:%02x"
582 #define QDF_MAC_ADDR_ARRAY(a) \
583 	(a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
584 
585 /**
586  * struct qdf_mac_addr - mac address array
587  * @bytes: MAC address bytes
588  */
589 struct qdf_mac_addr {
590 	uint8_t bytes[QDF_MAC_ADDR_SIZE];
591 };
592 
593 /**
594  * This macro is used to initialize a QDF MacAddress to the broadcast
595  * MacAddress. It is used like this...
596  */
597 #define QDF_MAC_ADDR_BROADCAST_INITIALIZER \
598 	{ { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } }
599 
600 /**
601  * This macro is used to initialize a QDF MacAddress to zero
602  * It is used like this...
603  */
604 #define QDF_MAC_ADDR_ZERO_INITIALIZER { { 0, 0, 0, 0, 0, 0 } }
605 
606 #define QDF_IPV4_ADDR_SIZE (4)
607 #define QDF_IPV6_ADDR_SIZE (16)
608 #define QDF_MAX_NUM_CHAN   (128)
609 
610 /**
611  * struct qdf_tso_frag_t - fragments of a single TCP segment
612  * @paddr_low_32: Lower 32 bits of the buffer pointer
613  * @paddr_upper_16: upper 16 bits of the buffer pointer
614  * @length: length of the buffer
615  * @vaddr: virtual address
616  *
617  * This structure holds the fragments of a single TCP segment of a
618  * given jumbo TSO network buffer
619  */
620 struct qdf_tso_frag_t {
621 	uint16_t length;
622 	unsigned char *vaddr;
623 	qdf_dma_addr_t paddr;
624 };
625 
626 #define FRAG_NUM_MAX 6
627 #define TSO_SEG_MAGIC_COOKIE 0x7EED
628 
629 /**
630  * struct qdf_tso_flags_t - TSO specific flags
631  * @tso_enable: Enable transmit segmentation offload
632  * @tcp_flags_mask: Tcp_flag is inserted into the header based
633  * on the mask
634  * @l2_len: L2 length for the msdu
635  * @ip_len: IP length for the msdu
636  * @tcp_seq_num: TCP sequence number
637  * @ip_id: IP identification number
638  *
639  * This structure holds the TSO specific flags extracted from the TSO network
640  * buffer for a given TCP segment
641  */
642 struct qdf_tso_flags_t {
643 	uint32_t tso_enable:1,
644 			reserved_0a:6,
645 			fin:1,
646 			syn:1,
647 			rst:1,
648 			psh:1,
649 			ack:1,
650 			urg:1,
651 			ece:1,
652 			cwr:1,
653 			ns:1,
654 			tcp_flags_mask:9,
655 			reserved_0b:7;
656 
657 	uint32_t l2_len:16,
658 			ip_len:16;
659 
660 	uint32_t tcp_seq_num;
661 
662 	uint32_t ip_id:16,
663 			ipv4_checksum_en:1,
664 			udp_ipv4_checksum_en:1,
665 			udp_ipv6_checksum_en:1,
666 			tcp_ipv4_checksum_en:1,
667 			tcp_ipv6_checksum_en:1,
668 			partial_checksum_en:1,
669 			reserved_3a:10;
670 
671 	uint32_t checksum_offset:14,
672 			reserved_4a:2,
673 			payload_start_offset:14,
674 			reserved_4b:2;
675 
676 	uint32_t payload_end_offset:14,
677 			reserved_5:18;
678 };
679 
680 /**
681  * struct qdf_tso_seg_t - single TSO segment
682  * @tso_flags: TSO flags
683  * @num_frags: number of fragments
684  * @total_len: total length of the packet
685  * @tso_frags: array holding the fragments
686  *
687  * This structure holds the information of a single TSO segment of a jumbo
688  * TSO network buffer
689  */
690 struct qdf_tso_seg_t {
691 	struct qdf_tso_flags_t tso_flags;
692 	uint32_t num_frags;
693 	uint32_t total_len;
694 	struct qdf_tso_frag_t tso_frags[FRAG_NUM_MAX];
695 };
696 
697 /**
698  * TSO seg elem action caller locations: goes into dbg.history below.
699  * Needed to be defined outside of the feature so that
700  * callers can be coded without ifdefs (even if they get
701  * resolved to nothing)
702  */
703 enum tsoseg_dbg_caller_e {
704 	TSOSEG_LOC_UNDEFINED,
705 	TSOSEG_LOC_INIT1,
706 	TSOSEG_LOC_INIT2,
707 	TSOSEG_LOC_DEINIT,
708 	TSOSEG_LOC_PREPARETSO,
709 	TSOSEG_LOC_TXPREPLLFAST,
710 	TSOSEG_LOC_UNMAPTSO,
711 	TSOSEG_LOC_ALLOC,
712 	TSOSEG_LOC_FREE,
713 };
714 #ifdef TSOSEG_DEBUG
715 
716 #define MAX_TSO_SEG_ACT_HISTORY 16
717 struct qdf_tso_seg_dbg_t {
718 	void    *txdesc;  /* owner - (ol_txrx_tx_desc_t *) */
719 	int      cur;     /* index of last valid entry */
720 	uint16_t history[MAX_TSO_SEG_ACT_HISTORY];
721 };
722 #endif /* TSOSEG_DEBUG */
723 
724 /**
725  * qdf_tso_seg_elem_t - tso segment element
726  * @seg: instance of segment
727  * @next: pointer to the next segment
728  */
729 struct qdf_tso_seg_elem_t {
730 	struct qdf_tso_seg_t seg;
731 	uint16_t cookie:15,
732 		on_freelist:1;
733 	struct qdf_tso_seg_elem_t *next;
734 #ifdef TSOSEG_DEBUG
735 	struct qdf_tso_seg_dbg_t dbg;
736 #endif /* TSOSEG_DEBUG */
737 };
738 
739 /**
740  * struct qdf_tso_num_seg_t - single element to count for num of seg
741  * @tso_cmn_num_seg: num of seg in a jumbo skb
742  *
743  * This structure holds the information of num of segments of a jumbo
744  * TSO network buffer.
745  */
746 struct qdf_tso_num_seg_t {
747 	uint32_t tso_cmn_num_seg;
748 };
749 
750 /**
751  * qdf_tso_num_seg_elem_t - num of tso segment element for jumbo skb
752  * @num_seg: instance of num of seg
753  * @next: pointer to the next segment
754  */
755 struct qdf_tso_num_seg_elem_t {
756 	struct qdf_tso_num_seg_t num_seg;
757 	struct qdf_tso_num_seg_elem_t *next;
758 };
759 
760 /**
761  * struct qdf_tso_info_t - TSO information extracted
762  * @is_tso: is this is a TSO frame
763  * @num_segs: number of segments
764  * @tso_seg_list: list of TSO segments for this jumbo packet
765  * @curr_seg: segment that is currently being processed
766  * @tso_num_seg_list: num of tso seg for this jumbo packet
767  * @msdu_stats_idx: msdu index for tso stats
768  *
769  * This structure holds the TSO information extracted after parsing the TSO
770  * jumbo network buffer. It contains a chain of the TSO segments belonging to
771  * the jumbo packet
772  */
773 struct qdf_tso_info_t {
774 	uint8_t is_tso;
775 	uint32_t num_segs;
776 	struct qdf_tso_seg_elem_t *tso_seg_list;
777 	struct qdf_tso_seg_elem_t *curr_seg;
778 	struct qdf_tso_num_seg_elem_t *tso_num_seg_list;
779 	uint32_t msdu_stats_idx;
780 };
781 
782 /**
783  * Used to set classify bit in CE desc.
784  */
785 #define QDF_CE_TX_CLASSIFY_BIT_S   5
786 
787 /**
788  * QDF_CE_TX_PKT_TYPE_BIT_S - 2 bits starting at bit 6 in CE desc.
789  */
790 #define QDF_CE_TX_PKT_TYPE_BIT_S   6
791 
792 /**
793  * QDF_CE_TX_PKT_OFFSET_BIT_S - 12 bits --> 16-27, in the CE desciptor
794  *  the length of HTT/HTC descriptor
795  */
796 #define QDF_CE_TX_PKT_OFFSET_BIT_S  16
797 
798 /**
799  * QDF_CE_TX_PKT_OFFSET_BIT_M - Mask for packet offset in the CE descriptor.
800  */
801 #define QDF_CE_TX_PKT_OFFSET_BIT_M   0x0fff0000
802 
803 /**
804  * enum qdf_suspend_type - type of suspend
805  * @QDF_SYSTEM_SUSPEND: System suspend triggered wlan suspend
806  * @QDF_RUNTIME_SUSPEND: Runtime pm inactivity timer triggered wlan suspend
807  */
808 enum qdf_suspend_type {
809 	QDF_SYSTEM_SUSPEND,
810 	QDF_RUNTIME_SUSPEND
811 };
812 
813 #endif /* __QDF_TYPES_H */
814