1 /* 2 * This file is part of wl1271 3 * 4 * Copyright (C) 2009 Nokia Corporation 5 * 6 * Contact: Luciano Coelho <luciano.coelho@nokia.com> 7 * 8 * This program is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License 10 * version 2 as published by the Free Software Foundation. 11 * 12 * This program is distributed in the hope that it will be useful, but 13 * WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 * General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 20 * 02110-1301 USA 21 * 22 */ 23 24 #ifndef __CONF_H__ 25 #define __CONF_H__ 26 27 enum { 28 CONF_HW_BIT_RATE_1MBPS = BIT(0), 29 CONF_HW_BIT_RATE_2MBPS = BIT(1), 30 CONF_HW_BIT_RATE_5_5MBPS = BIT(2), 31 CONF_HW_BIT_RATE_6MBPS = BIT(3), 32 CONF_HW_BIT_RATE_9MBPS = BIT(4), 33 CONF_HW_BIT_RATE_11MBPS = BIT(5), 34 CONF_HW_BIT_RATE_12MBPS = BIT(6), 35 CONF_HW_BIT_RATE_18MBPS = BIT(7), 36 CONF_HW_BIT_RATE_22MBPS = BIT(8), 37 CONF_HW_BIT_RATE_24MBPS = BIT(9), 38 CONF_HW_BIT_RATE_36MBPS = BIT(10), 39 CONF_HW_BIT_RATE_48MBPS = BIT(11), 40 CONF_HW_BIT_RATE_54MBPS = BIT(12), 41 CONF_HW_BIT_RATE_MCS_0 = BIT(13), 42 CONF_HW_BIT_RATE_MCS_1 = BIT(14), 43 CONF_HW_BIT_RATE_MCS_2 = BIT(15), 44 CONF_HW_BIT_RATE_MCS_3 = BIT(16), 45 CONF_HW_BIT_RATE_MCS_4 = BIT(17), 46 CONF_HW_BIT_RATE_MCS_5 = BIT(18), 47 CONF_HW_BIT_RATE_MCS_6 = BIT(19), 48 CONF_HW_BIT_RATE_MCS_7 = BIT(20), 49 CONF_HW_BIT_RATE_MCS_8 = BIT(21), 50 CONF_HW_BIT_RATE_MCS_9 = BIT(22), 51 CONF_HW_BIT_RATE_MCS_10 = BIT(23), 52 CONF_HW_BIT_RATE_MCS_11 = BIT(24), 53 CONF_HW_BIT_RATE_MCS_12 = BIT(25), 54 CONF_HW_BIT_RATE_MCS_13 = BIT(26), 55 CONF_HW_BIT_RATE_MCS_14 = BIT(27), 56 CONF_HW_BIT_RATE_MCS_15 = BIT(28), 57 }; 58 59 enum { 60 CONF_HW_RATE_INDEX_1MBPS = 0, 61 CONF_HW_RATE_INDEX_2MBPS = 1, 62 CONF_HW_RATE_INDEX_5_5MBPS = 2, 63 CONF_HW_RATE_INDEX_6MBPS = 3, 64 CONF_HW_RATE_INDEX_9MBPS = 4, 65 CONF_HW_RATE_INDEX_11MBPS = 5, 66 CONF_HW_RATE_INDEX_12MBPS = 6, 67 CONF_HW_RATE_INDEX_18MBPS = 7, 68 CONF_HW_RATE_INDEX_22MBPS = 8, 69 CONF_HW_RATE_INDEX_24MBPS = 9, 70 CONF_HW_RATE_INDEX_36MBPS = 10, 71 CONF_HW_RATE_INDEX_48MBPS = 11, 72 CONF_HW_RATE_INDEX_54MBPS = 12, 73 CONF_HW_RATE_INDEX_MAX = CONF_HW_RATE_INDEX_54MBPS, 74 }; 75 76 #define CONF_HW_RXTX_RATE_UNSUPPORTED 0xff 77 78 enum { 79 CONF_SG_DISABLE = 0, 80 CONF_SG_PROTECTIVE, 81 CONF_SG_OPPORTUNISTIC 82 }; 83 84 enum { 85 /* 86 * Configure the min and max time BT gains the antenna 87 * in WLAN / BT master basic rate 88 * 89 * Range: 0 - 255 (ms) 90 */ 91 CONF_SG_ACL_BT_MASTER_MIN_BR = 0, 92 CONF_SG_ACL_BT_MASTER_MAX_BR, 93 94 /* 95 * Configure the min and max time BT gains the antenna 96 * in WLAN / BT slave basic rate 97 * 98 * Range: 0 - 255 (ms) 99 */ 100 CONF_SG_ACL_BT_SLAVE_MIN_BR, 101 CONF_SG_ACL_BT_SLAVE_MAX_BR, 102 103 /* 104 * Configure the min and max time BT gains the antenna 105 * in WLAN / BT master EDR 106 * 107 * Range: 0 - 255 (ms) 108 */ 109 CONF_SG_ACL_BT_MASTER_MIN_EDR, 110 CONF_SG_ACL_BT_MASTER_MAX_EDR, 111 112 /* 113 * Configure the min and max time BT gains the antenna 114 * in WLAN / BT slave EDR 115 * 116 * Range: 0 - 255 (ms) 117 */ 118 CONF_SG_ACL_BT_SLAVE_MIN_EDR, 119 CONF_SG_ACL_BT_SLAVE_MAX_EDR, 120 121 /* 122 * The maximum time WLAN can gain the antenna 123 * in WLAN PSM / BT master/slave BR 124 * 125 * Range: 0 - 255 (ms) 126 */ 127 CONF_SG_ACL_WLAN_PS_MASTER_BR, 128 CONF_SG_ACL_WLAN_PS_SLAVE_BR, 129 130 /* 131 * The maximum time WLAN can gain the antenna 132 * in WLAN PSM / BT master/slave EDR 133 * 134 * Range: 0 - 255 (ms) 135 */ 136 CONF_SG_ACL_WLAN_PS_MASTER_EDR, 137 CONF_SG_ACL_WLAN_PS_SLAVE_EDR, 138 139 /* TODO: explain these values */ 140 CONF_SG_ACL_WLAN_ACTIVE_MASTER_MIN_BR, 141 CONF_SG_ACL_WLAN_ACTIVE_MASTER_MAX_BR, 142 CONF_SG_ACL_WLAN_ACTIVE_SLAVE_MIN_BR, 143 CONF_SG_ACL_WLAN_ACTIVE_SLAVE_MAX_BR, 144 CONF_SG_ACL_WLAN_ACTIVE_MASTER_MIN_EDR, 145 CONF_SG_ACL_WLAN_ACTIVE_MASTER_MAX_EDR, 146 CONF_SG_ACL_WLAN_ACTIVE_SLAVE_MIN_EDR, 147 CONF_SG_ACL_WLAN_ACTIVE_SLAVE_MAX_EDR, 148 149 CONF_SG_ACL_ACTIVE_SCAN_WLAN_BR, 150 CONF_SG_ACL_ACTIVE_SCAN_WLAN_EDR, 151 CONF_SG_ACL_PASSIVE_SCAN_BT_BR, 152 CONF_SG_ACL_PASSIVE_SCAN_WLAN_BR, 153 CONF_SG_ACL_PASSIVE_SCAN_BT_EDR, 154 CONF_SG_ACL_PASSIVE_SCAN_WLAN_EDR, 155 156 /* 157 * Compensation percentage of probe requests when scan initiated 158 * during BT voice/ACL link. 159 * 160 * Range: 0 - 255 (%) 161 */ 162 CONF_SG_AUTO_SCAN_PROBE_REQ, 163 164 /* 165 * Compensation percentage of probe requests when active scan initiated 166 * during BT voice 167 * 168 * Range: 0 - 255 (%) 169 */ 170 CONF_SG_ACTIVE_SCAN_DURATION_FACTOR_HV3, 171 172 /* 173 * Compensation percentage of WLAN active scan window if initiated 174 * during BT A2DP 175 * 176 * Range: 0 - 1000 (%) 177 */ 178 CONF_SG_ACTIVE_SCAN_DURATION_FACTOR_A2DP, 179 180 /* 181 * Compensation percentage of WLAN passive scan window if initiated 182 * during BT A2DP BR 183 * 184 * Range: 0 - 1000 (%) 185 */ 186 CONF_SG_PASSIVE_SCAN_DURATION_FACTOR_A2DP_BR, 187 188 /* 189 * Compensation percentage of WLAN passive scan window if initiated 190 * during BT A2DP EDR 191 * 192 * Range: 0 - 1000 (%) 193 */ 194 CONF_SG_PASSIVE_SCAN_DURATION_FACTOR_A2DP_EDR, 195 196 /* 197 * Compensation percentage of WLAN passive scan window if initiated 198 * during BT voice 199 * 200 * Range: 0 - 1000 (%) 201 */ 202 CONF_SG_PASSIVE_SCAN_DURATION_FACTOR_HV3, 203 204 /* TODO: explain these values */ 205 CONF_SG_CONSECUTIVE_HV3_IN_PASSIVE_SCAN, 206 CONF_SG_BCN_HV3_COLLISION_THRESH_IN_PASSIVE_SCAN, 207 CONF_SG_TX_RX_PROTECTION_BWIDTH_IN_PASSIVE_SCAN, 208 209 /* 210 * Defines whether the SG will force WLAN host to enter/exit PSM 211 * 212 * Range: 1 - SG can force, 0 - host handles PSM 213 */ 214 CONF_SG_STA_FORCE_PS_IN_BT_SCO, 215 216 /* 217 * Defines antenna configuration (single/dual antenna) 218 * 219 * Range: 0 - single antenna, 1 - dual antenna 220 */ 221 CONF_SG_ANTENNA_CONFIGURATION, 222 223 /* 224 * The threshold (percent) of max consecutive beacon misses before 225 * increasing priority of beacon reception. 226 * 227 * Range: 0 - 100 (%) 228 */ 229 CONF_SG_BEACON_MISS_PERCENT, 230 231 /* 232 * Protection time of the DHCP procedure. 233 * 234 * Range: 0 - 100000 (ms) 235 */ 236 CONF_SG_DHCP_TIME, 237 238 /* 239 * RX guard time before the beginning of a new BT voice frame during 240 * which no new WLAN trigger frame is transmitted. 241 * 242 * Range: 0 - 100000 (us) 243 */ 244 CONF_SG_RXT, 245 246 /* 247 * TX guard time before the beginning of a new BT voice frame during 248 * which no new WLAN frame is transmitted. 249 * 250 * Range: 0 - 100000 (us) 251 */ 252 253 CONF_SG_TXT, 254 255 /* 256 * Enable adaptive RXT/TXT algorithm. If disabled, the host values 257 * will be utilized. 258 * 259 * Range: 0 - disable, 1 - enable 260 */ 261 CONF_SG_ADAPTIVE_RXT_TXT, 262 263 /* TODO: explain this value */ 264 CONF_SG_GENERAL_USAGE_BIT_MAP, 265 266 /* 267 * Number of consecutive BT voice frames not interrupted by WLAN 268 * 269 * Range: 0 - 100 270 */ 271 CONF_SG_HV3_MAX_SERVED, 272 273 /* 274 * The used WLAN legacy service period during active BT ACL link 275 * 276 * Range: 0 - 255 (ms) 277 */ 278 CONF_SG_PS_POLL_TIMEOUT, 279 280 /* 281 * The used WLAN UPSD service period during active BT ACL link 282 * 283 * Range: 0 - 255 (ms) 284 */ 285 CONF_SG_UPSD_TIMEOUT, 286 287 CONF_SG_CONSECUTIVE_CTS_THRESHOLD, 288 CONF_SG_STA_RX_WINDOW_AFTER_DTIM, 289 CONF_SG_STA_CONNECTION_PROTECTION_TIME, 290 291 /* AP params */ 292 CONF_AP_BEACON_MISS_TX, 293 CONF_AP_RX_WINDOW_AFTER_BEACON, 294 CONF_AP_BEACON_WINDOW_INTERVAL, 295 CONF_AP_CONNECTION_PROTECTION_TIME, 296 CONF_AP_BT_ACL_VAL_BT_SERVE_TIME, 297 CONF_AP_BT_ACL_VAL_WL_SERVE_TIME, 298 299 /* CTS Diluting params */ 300 CONF_SG_CTS_DILUTED_BAD_RX_PACKETS_TH, 301 CONF_SG_CTS_CHOP_IN_DUAL_ANT_SCO_MASTER, 302 303 CONF_SG_TEMP_PARAM_1, 304 CONF_SG_TEMP_PARAM_2, 305 CONF_SG_TEMP_PARAM_3, 306 CONF_SG_TEMP_PARAM_4, 307 CONF_SG_TEMP_PARAM_5, 308 CONF_SG_TEMP_PARAM_6, 309 CONF_SG_TEMP_PARAM_7, 310 CONF_SG_TEMP_PARAM_8, 311 CONF_SG_TEMP_PARAM_9, 312 CONF_SG_TEMP_PARAM_10, 313 314 CONF_SG_PARAMS_MAX, 315 CONF_SG_PARAMS_ALL = 0xff 316 }; 317 318 struct conf_sg_settings { 319 u32 params[CONF_SG_PARAMS_MAX]; 320 u8 state; 321 } __packed; 322 323 enum conf_rx_queue_type { 324 CONF_RX_QUEUE_TYPE_LOW_PRIORITY, /* All except the high priority */ 325 CONF_RX_QUEUE_TYPE_HIGH_PRIORITY, /* Management and voice packets */ 326 }; 327 328 struct conf_rx_settings { 329 /* 330 * The maximum amount of time, in TU, before the 331 * firmware discards the MSDU. 332 * 333 * Range: 0 - 0xFFFFFFFF 334 */ 335 u32 rx_msdu_life_time; 336 337 /* 338 * Packet detection threshold in the PHY. 339 * 340 * FIXME: details unknown. 341 */ 342 u32 packet_detection_threshold; 343 344 /* 345 * The longest time the STA will wait to receive traffic from the AP 346 * after a PS-poll has been transmitted. 347 * 348 * Range: 0 - 200000 349 */ 350 u16 ps_poll_timeout; 351 /* 352 * The longest time the STA will wait to receive traffic from the AP 353 * after a frame has been sent from an UPSD enabled queue. 354 * 355 * Range: 0 - 200000 356 */ 357 u16 upsd_timeout; 358 359 /* 360 * The number of octets in an MPDU, below which an RTS/CTS 361 * handshake is not performed. 362 * 363 * Range: 0 - 4096 364 */ 365 u16 rts_threshold; 366 367 /* 368 * The RX Clear Channel Assessment threshold in the PHY 369 * (the energy threshold). 370 * 371 * Range: ENABLE_ENERGY_D == 0x140A 372 * DISABLE_ENERGY_D == 0xFFEF 373 */ 374 u16 rx_cca_threshold; 375 376 /* 377 * Occupied Rx mem-blocks number which requires interrupting the host 378 * (0 = no buffering, 0xffff = disabled). 379 * 380 * Range: u16 381 */ 382 u16 irq_blk_threshold; 383 384 /* 385 * Rx packets number which requires interrupting the host 386 * (0 = no buffering). 387 * 388 * Range: u16 389 */ 390 u16 irq_pkt_threshold; 391 392 /* 393 * Max time in msec the FW may delay RX-Complete interrupt. 394 * 395 * Range: 1 - 100 396 */ 397 u16 irq_timeout; 398 399 /* 400 * The RX queue type. 401 * 402 * Range: RX_QUEUE_TYPE_RX_LOW_PRIORITY, RX_QUEUE_TYPE_RX_HIGH_PRIORITY, 403 */ 404 u8 queue_type; 405 } __packed; 406 407 #define CONF_TX_MAX_RATE_CLASSES 10 408 409 #define CONF_TX_RATE_MASK_UNSPECIFIED 0 410 #define CONF_TX_RATE_MASK_BASIC (CONF_HW_BIT_RATE_1MBPS | \ 411 CONF_HW_BIT_RATE_2MBPS) 412 #define CONF_TX_RATE_RETRY_LIMIT 10 413 414 /* basic rates for p2p operations (probe req/resp, etc.) */ 415 #define CONF_TX_RATE_MASK_BASIC_P2P CONF_HW_BIT_RATE_6MBPS 416 417 /* 418 * Rates supported for data packets when operating as AP. Note the absence 419 * of the 22Mbps rate. There is a FW limitation on 12 rates so we must drop 420 * one. The rate dropped is not mandatory under any operating mode. 421 */ 422 #define CONF_TX_AP_ENABLED_RATES (CONF_HW_BIT_RATE_1MBPS | \ 423 CONF_HW_BIT_RATE_2MBPS | CONF_HW_BIT_RATE_5_5MBPS | \ 424 CONF_HW_BIT_RATE_6MBPS | CONF_HW_BIT_RATE_9MBPS | \ 425 CONF_HW_BIT_RATE_11MBPS | CONF_HW_BIT_RATE_12MBPS | \ 426 CONF_HW_BIT_RATE_18MBPS | CONF_HW_BIT_RATE_24MBPS | \ 427 CONF_HW_BIT_RATE_36MBPS | CONF_HW_BIT_RATE_48MBPS | \ 428 CONF_HW_BIT_RATE_54MBPS) 429 430 #define CONF_TX_CCK_RATES (CONF_HW_BIT_RATE_1MBPS | \ 431 CONF_HW_BIT_RATE_2MBPS | CONF_HW_BIT_RATE_5_5MBPS | \ 432 CONF_HW_BIT_RATE_11MBPS) 433 434 #define CONF_TX_OFDM_RATES (CONF_HW_BIT_RATE_6MBPS | \ 435 CONF_HW_BIT_RATE_12MBPS | CONF_HW_BIT_RATE_24MBPS | \ 436 CONF_HW_BIT_RATE_36MBPS | CONF_HW_BIT_RATE_48MBPS | \ 437 CONF_HW_BIT_RATE_54MBPS) 438 439 #define CONF_TX_MCS_RATES (CONF_HW_BIT_RATE_MCS_0 | \ 440 CONF_HW_BIT_RATE_MCS_1 | CONF_HW_BIT_RATE_MCS_2 | \ 441 CONF_HW_BIT_RATE_MCS_3 | CONF_HW_BIT_RATE_MCS_4 | \ 442 CONF_HW_BIT_RATE_MCS_5 | CONF_HW_BIT_RATE_MCS_6 | \ 443 CONF_HW_BIT_RATE_MCS_7) 444 445 #define CONF_TX_MIMO_RATES (CONF_HW_BIT_RATE_MCS_8 | \ 446 CONF_HW_BIT_RATE_MCS_9 | CONF_HW_BIT_RATE_MCS_10 | \ 447 CONF_HW_BIT_RATE_MCS_11 | CONF_HW_BIT_RATE_MCS_12 | \ 448 CONF_HW_BIT_RATE_MCS_13 | CONF_HW_BIT_RATE_MCS_14 | \ 449 CONF_HW_BIT_RATE_MCS_15) 450 451 /* 452 * Default rates for management traffic when operating in AP mode. This 453 * should be configured according to the basic rate set of the AP 454 */ 455 #define CONF_TX_AP_DEFAULT_MGMT_RATES (CONF_HW_BIT_RATE_1MBPS | \ 456 CONF_HW_BIT_RATE_2MBPS | CONF_HW_BIT_RATE_5_5MBPS) 457 458 /* default rates for working as IBSS (11b and OFDM) */ 459 #define CONF_TX_IBSS_DEFAULT_RATES (CONF_HW_BIT_RATE_1MBPS | \ 460 CONF_HW_BIT_RATE_2MBPS | CONF_HW_BIT_RATE_5_5MBPS | \ 461 CONF_HW_BIT_RATE_11MBPS | CONF_TX_OFDM_RATES); 462 463 struct conf_tx_rate_class { 464 465 /* 466 * The rates enabled for this rate class. 467 * 468 * Range: CONF_HW_BIT_RATE_* bit mask 469 */ 470 u32 enabled_rates; 471 472 /* 473 * The dot11 short retry limit used for TX retries. 474 * 475 * Range: u8 476 */ 477 u8 short_retry_limit; 478 479 /* 480 * The dot11 long retry limit used for TX retries. 481 * 482 * Range: u8 483 */ 484 u8 long_retry_limit; 485 486 /* 487 * Flags controlling the attributes of TX transmission. 488 * 489 * Range: bit 0: Truncate - when set, FW attempts to send a frame stop 490 * when the total valid per-rate attempts have 491 * been exhausted; otherwise transmissions 492 * will continue at the lowest available rate 493 * until the appropriate one of the 494 * short_retry_limit, long_retry_limit, 495 * dot11_max_transmit_msdu_life_time, or 496 * max_tx_life_time, is exhausted. 497 * 1: Preamble Override - indicates if the preamble type 498 * should be used in TX. 499 * 2: Preamble Type - the type of the preamble to be used by 500 * the policy (0 - long preamble, 1 - short preamble. 501 */ 502 u8 aflags; 503 } __packed; 504 505 #define CONF_TX_MAX_AC_COUNT 4 506 507 /* Slot number setting to start transmission at PIFS interval */ 508 #define CONF_TX_AIFS_PIFS 1 509 /* Slot number setting to start transmission at DIFS interval normal 510 * DCF access */ 511 #define CONF_TX_AIFS_DIFS 2 512 513 514 enum conf_tx_ac { 515 CONF_TX_AC_BE = 0, /* best effort / legacy */ 516 CONF_TX_AC_BK = 1, /* background */ 517 CONF_TX_AC_VI = 2, /* video */ 518 CONF_TX_AC_VO = 3, /* voice */ 519 CONF_TX_AC_CTS2SELF = 4, /* fictitious AC, follows AC_VO */ 520 CONF_TX_AC_ANY_TID = 0xff 521 }; 522 523 struct conf_tx_ac_category { 524 /* 525 * The AC class identifier. 526 * 527 * Range: enum conf_tx_ac 528 */ 529 u8 ac; 530 531 /* 532 * The contention window minimum size (in slots) for the access 533 * class. 534 * 535 * Range: u8 536 */ 537 u8 cw_min; 538 539 /* 540 * The contention window maximum size (in slots) for the access 541 * class. 542 * 543 * Range: u8 544 */ 545 u16 cw_max; 546 547 /* 548 * The AIF value (in slots) for the access class. 549 * 550 * Range: u8 551 */ 552 u8 aifsn; 553 554 /* 555 * The TX Op Limit (in microseconds) for the access class. 556 * 557 * Range: u16 558 */ 559 u16 tx_op_limit; 560 } __packed; 561 562 #define CONF_TX_MAX_TID_COUNT 8 563 564 /* Allow TX BA on all TIDs but 6,7. These are currently reserved in the FW */ 565 #define CONF_TX_BA_ENABLED_TID_BITMAP 0x3F 566 567 enum { 568 CONF_CHANNEL_TYPE_DCF = 0, /* DC/LEGACY*/ 569 CONF_CHANNEL_TYPE_EDCF = 1, /* EDCA*/ 570 CONF_CHANNEL_TYPE_HCCA = 2, /* HCCA*/ 571 }; 572 573 enum { 574 CONF_PS_SCHEME_LEGACY = 0, 575 CONF_PS_SCHEME_UPSD_TRIGGER = 1, 576 CONF_PS_SCHEME_LEGACY_PSPOLL = 2, 577 CONF_PS_SCHEME_SAPSD = 3, 578 }; 579 580 enum { 581 CONF_ACK_POLICY_LEGACY = 0, 582 CONF_ACK_POLICY_NO_ACK = 1, 583 CONF_ACK_POLICY_BLOCK = 2, 584 }; 585 586 587 struct conf_tx_tid { 588 u8 queue_id; 589 u8 channel_type; 590 u8 tsid; 591 u8 ps_scheme; 592 u8 ack_policy; 593 u32 apsd_conf[2]; 594 } __packed; 595 596 struct conf_tx_settings { 597 /* 598 * The TX ED value for TELEC Enable/Disable. 599 * 600 * Range: 0, 1 601 */ 602 u8 tx_energy_detection; 603 604 /* 605 * Configuration for rate classes for TX (currently only one 606 * rate class supported). Used in non-AP mode. 607 */ 608 struct conf_tx_rate_class sta_rc_conf; 609 610 /* 611 * Configuration for access categories for TX rate control. 612 */ 613 u8 ac_conf_count; 614 struct conf_tx_ac_category ac_conf[CONF_TX_MAX_AC_COUNT]; 615 616 /* 617 * AP-mode - allow this number of TX retries to a station before an 618 * event is triggered from FW. 619 * In AP-mode the hlids of unreachable stations are given in the 620 * "sta_tx_retry_exceeded" member in the event mailbox. 621 */ 622 u8 max_tx_retries; 623 624 /* 625 * AP-mode - after this number of seconds a connected station is 626 * considered inactive. 627 */ 628 u16 ap_aging_period; 629 630 /* 631 * Configuration for TID parameters. 632 */ 633 u8 tid_conf_count; 634 struct conf_tx_tid tid_conf[CONF_TX_MAX_TID_COUNT]; 635 636 /* 637 * The TX fragmentation threshold. 638 * 639 * Range: u16 640 */ 641 u16 frag_threshold; 642 643 /* 644 * Max time in msec the FW may delay frame TX-Complete interrupt. 645 * 646 * Range: u16 647 */ 648 u16 tx_compl_timeout; 649 650 /* 651 * Completed TX packet count which requires to issue the TX-Complete 652 * interrupt. 653 * 654 * Range: u16 655 */ 656 u16 tx_compl_threshold; 657 658 /* 659 * The rate used for control messages and scanning on the 2.4GHz band 660 * 661 * Range: CONF_HW_BIT_RATE_* bit mask 662 */ 663 u32 basic_rate; 664 665 /* 666 * The rate used for control messages and scanning on the 5GHz band 667 * 668 * Range: CONF_HW_BIT_RATE_* bit mask 669 */ 670 u32 basic_rate_5; 671 672 /* 673 * TX retry limits for templates 674 */ 675 u8 tmpl_short_retry_limit; 676 u8 tmpl_long_retry_limit; 677 678 /* Time in ms for Tx watchdog timer to expire */ 679 u32 tx_watchdog_timeout; 680 } __packed; 681 682 enum { 683 CONF_WAKE_UP_EVENT_BEACON = 0x01, /* Wake on every Beacon*/ 684 CONF_WAKE_UP_EVENT_DTIM = 0x02, /* Wake on every DTIM*/ 685 CONF_WAKE_UP_EVENT_N_DTIM = 0x04, /* Wake every Nth DTIM */ 686 CONF_WAKE_UP_EVENT_N_BEACONS = 0x08, /* Wake every Nth beacon */ 687 CONF_WAKE_UP_EVENT_BITS_MASK = 0x0F 688 }; 689 690 #define CONF_MAX_BCN_FILT_IE_COUNT 32 691 692 #define CONF_BCN_RULE_PASS_ON_CHANGE BIT(0) 693 #define CONF_BCN_RULE_PASS_ON_APPEARANCE BIT(1) 694 695 #define CONF_BCN_IE_OUI_LEN 3 696 #define CONF_BCN_IE_VER_LEN 2 697 698 struct conf_bcn_filt_rule { 699 /* 700 * IE number to which to associate a rule. 701 * 702 * Range: u8 703 */ 704 u8 ie; 705 706 /* 707 * Rule to associate with the specific ie. 708 * 709 * Range: CONF_BCN_RULE_PASS_ON_* 710 */ 711 u8 rule; 712 713 /* 714 * OUI for the vendor specifie IE (221) 715 */ 716 u8 oui[CONF_BCN_IE_OUI_LEN]; 717 718 /* 719 * Type for the vendor specifie IE (221) 720 */ 721 u8 type; 722 723 /* 724 * Version for the vendor specifie IE (221) 725 */ 726 u8 version[CONF_BCN_IE_VER_LEN]; 727 } __packed; 728 729 #define CONF_MAX_RSSI_SNR_TRIGGERS 8 730 731 enum { 732 CONF_TRIG_METRIC_RSSI_BEACON = 0, 733 CONF_TRIG_METRIC_RSSI_DATA, 734 CONF_TRIG_METRIC_SNR_BEACON, 735 CONF_TRIG_METRIC_SNR_DATA 736 }; 737 738 enum { 739 CONF_TRIG_EVENT_TYPE_LEVEL = 0, 740 CONF_TRIG_EVENT_TYPE_EDGE 741 }; 742 743 enum { 744 CONF_TRIG_EVENT_DIR_LOW = 0, 745 CONF_TRIG_EVENT_DIR_HIGH, 746 CONF_TRIG_EVENT_DIR_BIDIR 747 }; 748 749 struct conf_sig_weights { 750 751 /* 752 * RSSI from beacons average weight. 753 * 754 * Range: u8 755 */ 756 u8 rssi_bcn_avg_weight; 757 758 /* 759 * RSSI from data average weight. 760 * 761 * Range: u8 762 */ 763 u8 rssi_pkt_avg_weight; 764 765 /* 766 * SNR from beacons average weight. 767 * 768 * Range: u8 769 */ 770 u8 snr_bcn_avg_weight; 771 772 /* 773 * SNR from data average weight. 774 * 775 * Range: u8 776 */ 777 u8 snr_pkt_avg_weight; 778 } __packed; 779 780 enum conf_bcn_filt_mode { 781 CONF_BCN_FILT_MODE_DISABLED = 0, 782 CONF_BCN_FILT_MODE_ENABLED = 1 783 }; 784 785 enum conf_bet_mode { 786 CONF_BET_MODE_DISABLE = 0, 787 CONF_BET_MODE_ENABLE = 1, 788 }; 789 790 struct conf_conn_settings { 791 /* 792 * Firmware wakeup conditions configuration. The host may set only 793 * one bit. 794 * 795 * Range: CONF_WAKE_UP_EVENT_* 796 */ 797 u8 wake_up_event; 798 799 /* 800 * Listen interval for beacons or Dtims. 801 * 802 * Range: 0 for beacon and Dtim wakeup 803 * 1-10 for x Dtims 804 * 1-255 for x beacons 805 */ 806 u8 listen_interval; 807 808 /* 809 * Firmware wakeup conditions during suspend 810 * Range: CONF_WAKE_UP_EVENT_* 811 */ 812 u8 suspend_wake_up_event; 813 814 /* 815 * Listen interval during suspend. 816 * Currently will be in DTIMs (1-10) 817 * 818 */ 819 u8 suspend_listen_interval; 820 821 /* 822 * Enable or disable the beacon filtering. 823 * 824 * Range: CONF_BCN_FILT_MODE_* 825 */ 826 u8 bcn_filt_mode; 827 828 /* 829 * Configure Beacon filter pass-thru rules. 830 */ 831 u8 bcn_filt_ie_count; 832 struct conf_bcn_filt_rule bcn_filt_ie[CONF_MAX_BCN_FILT_IE_COUNT]; 833 834 /* 835 * The number of consecutive beacons to lose, before the firmware 836 * becomes out of synch. 837 * 838 * Range: u32 839 */ 840 u32 synch_fail_thold; 841 842 /* 843 * After out-of-synch, the number of TU's to wait without a further 844 * received beacon (or probe response) before issuing the BSS_EVENT_LOSE 845 * event. 846 * 847 * Range: u32 848 */ 849 u32 bss_lose_timeout; 850 851 /* 852 * Beacon receive timeout. 853 * 854 * Range: u32 855 */ 856 u32 beacon_rx_timeout; 857 858 /* 859 * Broadcast receive timeout. 860 * 861 * Range: u32 862 */ 863 u32 broadcast_timeout; 864 865 /* 866 * Enable/disable reception of broadcast packets in power save mode 867 * 868 * Range: 1 - enable, 0 - disable 869 */ 870 u8 rx_broadcast_in_ps; 871 872 /* 873 * Consecutive PS Poll failures before sending event to driver 874 * 875 * Range: u8 876 */ 877 u8 ps_poll_threshold; 878 879 /* 880 * Configuration of signal average weights. 881 */ 882 struct conf_sig_weights sig_weights; 883 884 /* 885 * Specifies if beacon early termination procedure is enabled or 886 * disabled. 887 * 888 * Range: CONF_BET_MODE_* 889 */ 890 u8 bet_enable; 891 892 /* 893 * Specifies the maximum number of consecutive beacons that may be 894 * early terminated. After this number is reached at least one full 895 * beacon must be correctly received in FW before beacon ET 896 * resumes. 897 * 898 * Range 0 - 255 899 */ 900 u8 bet_max_consecutive; 901 902 /* 903 * Specifies the maximum number of times to try PSM entry if it fails 904 * (if sending the appropriate null-func message fails.) 905 * 906 * Range 0 - 255 907 */ 908 u8 psm_entry_retries; 909 910 /* 911 * Specifies the maximum number of times to try PSM exit if it fails 912 * (if sending the appropriate null-func message fails.) 913 * 914 * Range 0 - 255 915 */ 916 u8 psm_exit_retries; 917 918 /* 919 * Specifies the maximum number of times to try transmit the PSM entry 920 * null-func frame for each PSM entry attempt 921 * 922 * Range 0 - 255 923 */ 924 u8 psm_entry_nullfunc_retries; 925 926 /* 927 * Specifies the dynamic PS timeout in ms that will be used 928 * by the FW when in AUTO_PS mode 929 */ 930 u16 dynamic_ps_timeout; 931 932 /* 933 * Specifies whether dynamic PS should be disabled and PSM forced. 934 * This is required for certain WiFi certification tests. 935 */ 936 u8 forced_ps; 937 938 /* 939 * 940 * Specifies the interval of the connection keep-alive null-func 941 * frame in ms. 942 * 943 * Range: 1000 - 3600000 944 */ 945 u32 keep_alive_interval; 946 947 /* 948 * Maximum listen interval supported by the driver in units of beacons. 949 * 950 * Range: u16 951 */ 952 u8 max_listen_interval; 953 954 /* 955 * Default sleep authorization for a new STA interface. This determines 956 * whether we can go to ELP. 957 */ 958 u8 sta_sleep_auth; 959 } __packed; 960 961 enum { 962 CONF_REF_CLK_19_2_E, 963 CONF_REF_CLK_26_E, 964 CONF_REF_CLK_38_4_E, 965 CONF_REF_CLK_52_E, 966 CONF_REF_CLK_38_4_M_XTAL, 967 CONF_REF_CLK_26_M_XTAL, 968 }; 969 970 enum single_dual_band_enum { 971 CONF_SINGLE_BAND, 972 CONF_DUAL_BAND 973 }; 974 975 #define CONF_RSSI_AND_PROCESS_COMPENSATION_SIZE 15 976 #define CONF_NUMBER_OF_SUB_BANDS_5 7 977 #define CONF_NUMBER_OF_RATE_GROUPS 6 978 #define CONF_NUMBER_OF_CHANNELS_2_4 14 979 #define CONF_NUMBER_OF_CHANNELS_5 35 980 981 struct conf_itrim_settings { 982 /* enable dco itrim */ 983 u8 enable; 984 985 /* moderation timeout in microsecs from the last TX */ 986 u32 timeout; 987 } __packed; 988 989 enum conf_fast_wakeup { 990 CONF_FAST_WAKEUP_ENABLE, 991 CONF_FAST_WAKEUP_DISABLE, 992 }; 993 994 struct conf_pm_config_settings { 995 /* 996 * Host clock settling time 997 * 998 * Range: 0 - 30000 us 999 */ 1000 u32 host_clk_settling_time; 1001 1002 /* 1003 * Host fast wakeup support 1004 * 1005 * Range: enum conf_fast_wakeup 1006 */ 1007 u8 host_fast_wakeup_support; 1008 } __packed; 1009 1010 struct conf_roam_trigger_settings { 1011 /* 1012 * The minimum interval between two trigger events. 1013 * 1014 * Range: 0 - 60000 ms 1015 */ 1016 u16 trigger_pacing; 1017 1018 /* 1019 * The weight for rssi/beacon average calculation 1020 * 1021 * Range: 0 - 255 1022 */ 1023 u8 avg_weight_rssi_beacon; 1024 1025 /* 1026 * The weight for rssi/data frame average calculation 1027 * 1028 * Range: 0 - 255 1029 */ 1030 u8 avg_weight_rssi_data; 1031 1032 /* 1033 * The weight for snr/beacon average calculation 1034 * 1035 * Range: 0 - 255 1036 */ 1037 u8 avg_weight_snr_beacon; 1038 1039 /* 1040 * The weight for snr/data frame average calculation 1041 * 1042 * Range: 0 - 255 1043 */ 1044 u8 avg_weight_snr_data; 1045 } __packed; 1046 1047 struct conf_scan_settings { 1048 /* 1049 * The minimum time to wait on each channel for active scans 1050 * 1051 * Range: u32 tu/1000 1052 */ 1053 u32 min_dwell_time_active; 1054 1055 /* 1056 * The maximum time to wait on each channel for active scans 1057 * 1058 * Range: u32 tu/1000 1059 */ 1060 u32 max_dwell_time_active; 1061 1062 /* 1063 * The minimum time to wait on each channel for passive scans 1064 * 1065 * Range: u32 tu/1000 1066 */ 1067 u32 min_dwell_time_passive; 1068 1069 /* 1070 * The maximum time to wait on each channel for passive scans 1071 * 1072 * Range: u32 tu/1000 1073 */ 1074 u32 max_dwell_time_passive; 1075 1076 /* 1077 * Number of probe requests to transmit on each active scan channel 1078 * 1079 * Range: u8 1080 */ 1081 u16 num_probe_reqs; 1082 1083 /* 1084 * Scan trigger (split scan) timeout. The FW will split the scan 1085 * operation into slices of the given time and allow the FW to schedule 1086 * other tasks in between. 1087 * 1088 * Range: u32 Microsecs 1089 */ 1090 u32 split_scan_timeout; 1091 } __packed; 1092 1093 struct conf_sched_scan_settings { 1094 /* 1095 * The base time to wait on the channel for active scans (in TU/1000). 1096 * The minimum dwell time is calculated according to this: 1097 * min_dwell_time = base + num_of_probes_to_be_sent * delta_per_probe 1098 * The maximum dwell time is calculated according to this: 1099 * max_dwell_time = min_dwell_time + max_dwell_time_delta 1100 */ 1101 u32 base_dwell_time; 1102 1103 /* The delta between the min dwell time and max dwell time for 1104 * active scans (in TU/1000s). The max dwell time is used by the FW once 1105 * traffic is detected on the channel. 1106 */ 1107 u32 max_dwell_time_delta; 1108 1109 /* Delta added to min dwell time per each probe in 2.4 GHz (TU/1000) */ 1110 u32 dwell_time_delta_per_probe; 1111 1112 /* Delta added to min dwell time per each probe in 5 GHz (TU/1000) */ 1113 u32 dwell_time_delta_per_probe_5; 1114 1115 /* time to wait on the channel for passive scans (in TU/1000) */ 1116 u32 dwell_time_passive; 1117 1118 /* time to wait on the channel for DFS scans (in TU/1000) */ 1119 u32 dwell_time_dfs; 1120 1121 /* number of probe requests to send on each channel in active scans */ 1122 u8 num_probe_reqs; 1123 1124 /* RSSI threshold to be used for filtering */ 1125 s8 rssi_threshold; 1126 1127 /* SNR threshold to be used for filtering */ 1128 s8 snr_threshold; 1129 } __packed; 1130 1131 struct conf_ht_setting { 1132 u8 rx_ba_win_size; 1133 u8 tx_ba_win_size; 1134 u16 inactivity_timeout; 1135 1136 /* bitmap of enabled TIDs for TX BA sessions */ 1137 u8 tx_ba_tid_bitmap; 1138 } __packed; 1139 1140 struct conf_memory_settings { 1141 /* Number of stations supported in IBSS mode */ 1142 u8 num_stations; 1143 1144 /* Number of ssid profiles used in IBSS mode */ 1145 u8 ssid_profiles; 1146 1147 /* Number of memory buffers allocated to rx pool */ 1148 u8 rx_block_num; 1149 1150 /* Minimum number of blocks allocated to tx pool */ 1151 u8 tx_min_block_num; 1152 1153 /* Disable/Enable dynamic memory */ 1154 u8 dynamic_memory; 1155 1156 /* 1157 * Minimum required free tx memory blocks in order to assure optimum 1158 * performance 1159 * 1160 * Range: 0-120 1161 */ 1162 u8 min_req_tx_blocks; 1163 1164 /* 1165 * Minimum required free rx memory blocks in order to assure optimum 1166 * performance 1167 * 1168 * Range: 0-120 1169 */ 1170 u8 min_req_rx_blocks; 1171 1172 /* 1173 * Minimum number of mem blocks (free+used) guaranteed for TX 1174 * 1175 * Range: 0-120 1176 */ 1177 u8 tx_min; 1178 } __packed; 1179 1180 struct conf_fm_coex { 1181 u8 enable; 1182 u8 swallow_period; 1183 u8 n_divider_fref_set_1; 1184 u8 n_divider_fref_set_2; 1185 u16 m_divider_fref_set_1; 1186 u16 m_divider_fref_set_2; 1187 u32 coex_pll_stabilization_time; 1188 u16 ldo_stabilization_time; 1189 u8 fm_disturbed_band_margin; 1190 u8 swallow_clk_diff; 1191 } __packed; 1192 1193 struct conf_rx_streaming_settings { 1194 /* 1195 * RX Streaming duration (in msec) from last tx/rx 1196 * 1197 * Range: u32 1198 */ 1199 u32 duration; 1200 1201 /* 1202 * Bitmap of tids to be polled during RX streaming. 1203 * (Note: it doesn't look like it really matters) 1204 * 1205 * Range: 0x1-0xff 1206 */ 1207 u8 queues; 1208 1209 /* 1210 * RX Streaming interval. 1211 * (Note:this value is also used as the rx streaming timeout) 1212 * Range: 0 (disabled), 10 - 100 1213 */ 1214 u8 interval; 1215 1216 /* 1217 * enable rx streaming also when there is no coex activity 1218 */ 1219 u8 always; 1220 } __packed; 1221 1222 struct conf_fwlog { 1223 /* Continuous or on-demand */ 1224 u8 mode; 1225 1226 /* 1227 * Number of memory blocks dedicated for the FW logger 1228 * 1229 * Range: 1-3, or 0 to disable the FW logger 1230 */ 1231 u8 mem_blocks; 1232 1233 /* Minimum log level threshold */ 1234 u8 severity; 1235 1236 /* Include/exclude timestamps from the log messages */ 1237 u8 timestamp; 1238 1239 /* See enum wl1271_fwlogger_output */ 1240 u8 output; 1241 1242 /* Regulates the frequency of log messages */ 1243 u8 threshold; 1244 } __packed; 1245 1246 #define ACX_RATE_MGMT_NUM_OF_RATES 13 1247 struct conf_rate_policy_settings { 1248 u16 rate_retry_score; 1249 u16 per_add; 1250 u16 per_th1; 1251 u16 per_th2; 1252 u16 max_per; 1253 u8 inverse_curiosity_factor; 1254 u8 tx_fail_low_th; 1255 u8 tx_fail_high_th; 1256 u8 per_alpha_shift; 1257 u8 per_add_shift; 1258 u8 per_beta1_shift; 1259 u8 per_beta2_shift; 1260 u8 rate_check_up; 1261 u8 rate_check_down; 1262 u8 rate_retry_policy[ACX_RATE_MGMT_NUM_OF_RATES]; 1263 } __packed; 1264 1265 struct conf_hangover_settings { 1266 u32 recover_time; 1267 u8 hangover_period; 1268 u8 dynamic_mode; 1269 u8 early_termination_mode; 1270 u8 max_period; 1271 u8 min_period; 1272 u8 increase_delta; 1273 u8 decrease_delta; 1274 u8 quiet_time; 1275 u8 increase_time; 1276 u8 window_size; 1277 } __packed; 1278 1279 /* 1280 * The conf version consists of 4 bytes. The two MSB are the wlcore 1281 * version, the two LSB are the lower driver's private conf 1282 * version. 1283 */ 1284 #define WLCORE_CONF_VERSION (0x0002 << 16) 1285 #define WLCORE_CONF_MASK 0xffff0000 1286 #define WLCORE_CONF_SIZE (sizeof(struct wlcore_conf_header) + \ 1287 sizeof(struct wlcore_conf)) 1288 1289 struct wlcore_conf_header { 1290 __le32 magic; 1291 __le32 version; 1292 __le32 checksum; 1293 } __packed; 1294 1295 struct wlcore_conf { 1296 struct conf_sg_settings sg; 1297 struct conf_rx_settings rx; 1298 struct conf_tx_settings tx; 1299 struct conf_conn_settings conn; 1300 struct conf_itrim_settings itrim; 1301 struct conf_pm_config_settings pm_config; 1302 struct conf_roam_trigger_settings roam_trigger; 1303 struct conf_scan_settings scan; 1304 struct conf_sched_scan_settings sched_scan; 1305 struct conf_ht_setting ht; 1306 struct conf_memory_settings mem; 1307 struct conf_fm_coex fm_coex; 1308 struct conf_rx_streaming_settings rx_streaming; 1309 struct conf_fwlog fwlog; 1310 struct conf_rate_policy_settings rate; 1311 struct conf_hangover_settings hangover; 1312 } __packed; 1313 1314 struct wlcore_conf_file { 1315 struct wlcore_conf_header header; 1316 struct wlcore_conf core; 1317 u8 priv[0]; 1318 } __packed; 1319 1320 #endif 1321