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