Pileus Git - ~andy/linux/blob - drivers/net/wireless/wl12xx/conf.h

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