linux/drivers/net/wireless/ti/wlcore/acx.h
<<
>>
Prefs
   1/*
   2 * This file is part of wl1271
   3 *
   4 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
   5 * Copyright (C) 2008-2010 Nokia Corporation
   6 *
   7 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
   8 *
   9 * This program is free software; you can redistribute it and/or
  10 * modify it under the terms of the GNU General Public License
  11 * version 2 as published by the Free Software Foundation.
  12 *
  13 * This program is distributed in the hope that it will be useful, but
  14 * WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 * General Public License for more details.
  17 *
  18 * You should have received a copy of the GNU General Public License
  19 * along with this program; if not, write to the Free Software
  20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21 * 02110-1301 USA
  22 *
  23 */
  24
  25#ifndef __ACX_H__
  26#define __ACX_H__
  27
  28#include "wlcore.h"
  29#include "cmd.h"
  30
  31/*************************************************************************
  32
  33    Host Interrupt Register (WiLink -> Host)
  34
  35**************************************************************************/
  36/* HW Initiated interrupt Watchdog timer expiration */
  37#define WL1271_ACX_INTR_WATCHDOG           BIT(0)
  38/* Init sequence is done (masked interrupt, detection through polling only ) */
  39#define WL1271_ACX_INTR_INIT_COMPLETE      BIT(1)
  40/* Event was entered to Event MBOX #A*/
  41#define WL1271_ACX_INTR_EVENT_A            BIT(2)
  42/* Event was entered to Event MBOX #B*/
  43#define WL1271_ACX_INTR_EVENT_B            BIT(3)
  44/* Command processing completion*/
  45#define WL1271_ACX_INTR_CMD_COMPLETE       BIT(4)
  46/* Signaling the host on HW wakeup */
  47#define WL1271_ACX_INTR_HW_AVAILABLE       BIT(5)
  48/* The MISC bit is used for aggregation of RX, TxComplete and TX rate update */
  49#define WL1271_ACX_INTR_DATA               BIT(6)
  50/* Trace message on MBOX #A */
  51#define WL1271_ACX_INTR_TRACE_A            BIT(7)
  52/* Trace message on MBOX #B */
  53#define WL1271_ACX_INTR_TRACE_B            BIT(8)
  54/* SW FW Initiated interrupt Watchdog timer expiration */
  55#define WL1271_ACX_SW_INTR_WATCHDOG        BIT(9)
  56
  57#define WL1271_ACX_INTR_ALL             0xFFFFFFFF
  58
  59/* all possible interrupts - only appropriate ones will be masked in */
  60#define WLCORE_ALL_INTR_MASK            (WL1271_ACX_INTR_WATCHDOG     | \
  61                                        WL1271_ACX_INTR_EVENT_A       | \
  62                                        WL1271_ACX_INTR_EVENT_B       | \
  63                                        WL1271_ACX_INTR_HW_AVAILABLE  | \
  64                                        WL1271_ACX_INTR_DATA          | \
  65                                        WL1271_ACX_SW_INTR_WATCHDOG)
  66
  67/* Target's information element */
  68struct acx_header {
  69        struct wl1271_cmd_header cmd;
  70
  71        /* acx (or information element) header */
  72        __le16 id;
  73
  74        /* payload length (not including headers */
  75        __le16 len;
  76} __packed;
  77
  78struct acx_error_counter {
  79        struct acx_header header;
  80
  81        /* The number of PLCP errors since the last time this */
  82        /* information element was interrogated. This field is */
  83        /* automatically cleared when it is interrogated.*/
  84        __le32 PLCP_error;
  85
  86        /* The number of FCS errors since the last time this */
  87        /* information element was interrogated. This field is */
  88        /* automatically cleared when it is interrogated.*/
  89        __le32 FCS_error;
  90
  91        /* The number of MPDUs without PLCP header errors received*/
  92        /* since the last time this information element was interrogated. */
  93        /* This field is automatically cleared when it is interrogated.*/
  94        __le32 valid_frame;
  95
  96        /* the number of missed sequence numbers in the squentially */
  97        /* values of frames seq numbers */
  98        __le32 seq_num_miss;
  99} __packed;
 100
 101enum wl12xx_role {
 102        WL1271_ROLE_STA = 0,
 103        WL1271_ROLE_IBSS,
 104        WL1271_ROLE_AP,
 105        WL1271_ROLE_DEVICE,
 106        WL1271_ROLE_P2P_CL,
 107        WL1271_ROLE_P2P_GO,
 108
 109        WL12XX_INVALID_ROLE_TYPE = 0xff
 110};
 111
 112enum wl1271_psm_mode {
 113        /* Active mode */
 114        WL1271_PSM_CAM = 0,
 115
 116        /* Power save mode */
 117        WL1271_PSM_PS = 1,
 118
 119        /* Extreme low power */
 120        WL1271_PSM_ELP = 2,
 121
 122        WL1271_PSM_MAX = WL1271_PSM_ELP,
 123
 124        /* illegal out of band value of PSM mode */
 125        WL1271_PSM_ILLEGAL = 0xff
 126};
 127
 128struct acx_sleep_auth {
 129        struct acx_header header;
 130
 131        /* The sleep level authorization of the device. */
 132        /* 0 - Always active*/
 133        /* 1 - Power down mode: light / fast sleep*/
 134        /* 2 - ELP mode: Deep / Max sleep*/
 135        u8  sleep_auth;
 136        u8  padding[3];
 137} __packed;
 138
 139enum {
 140        HOSTIF_PCI_MASTER_HOST_INDIRECT,
 141        HOSTIF_PCI_MASTER_HOST_DIRECT,
 142        HOSTIF_SLAVE,
 143        HOSTIF_PKT_RING,
 144        HOSTIF_DONTCARE = 0xFF
 145};
 146
 147#define DEFAULT_UCAST_PRIORITY          0
 148#define DEFAULT_RX_Q_PRIORITY           0
 149#define DEFAULT_RXQ_PRIORITY            0 /* low 0 .. 15 high  */
 150#define DEFAULT_RXQ_TYPE                0x07    /* All frames, Data/Ctrl/Mgmt */
 151#define TRACE_BUFFER_MAX_SIZE           256
 152
 153#define  DP_RX_PACKET_RING_CHUNK_SIZE 1600
 154#define  DP_TX_PACKET_RING_CHUNK_SIZE 1600
 155#define  DP_RX_PACKET_RING_CHUNK_NUM 2
 156#define  DP_TX_PACKET_RING_CHUNK_NUM 2
 157#define  DP_TX_COMPLETE_TIME_OUT 20
 158
 159#define TX_MSDU_LIFETIME_MIN       0
 160#define TX_MSDU_LIFETIME_MAX       3000
 161#define TX_MSDU_LIFETIME_DEF       512
 162#define RX_MSDU_LIFETIME_MIN       0
 163#define RX_MSDU_LIFETIME_MAX       0xFFFFFFFF
 164#define RX_MSDU_LIFETIME_DEF       512000
 165
 166struct acx_rx_msdu_lifetime {
 167        struct acx_header header;
 168
 169        /*
 170         * The maximum amount of time, in TU, before the
 171         * firmware discards the MSDU.
 172         */
 173        __le32 lifetime;
 174} __packed;
 175
 176enum acx_slot_type {
 177        SLOT_TIME_LONG = 0,
 178        SLOT_TIME_SHORT = 1,
 179        DEFAULT_SLOT_TIME = SLOT_TIME_SHORT,
 180        MAX_SLOT_TIMES = 0xFF
 181};
 182
 183#define STATION_WONE_INDEX 0
 184
 185struct acx_slot {
 186        struct acx_header header;
 187
 188        u8 role_id;
 189        u8 wone_index; /* Reserved */
 190        u8 slot_time;
 191        u8 reserved[5];
 192} __packed;
 193
 194
 195#define ACX_MC_ADDRESS_GROUP_MAX        (8)
 196#define ADDRESS_GROUP_MAX_LEN           (ETH_ALEN * ACX_MC_ADDRESS_GROUP_MAX)
 197
 198struct acx_dot11_grp_addr_tbl {
 199        struct acx_header header;
 200
 201        u8 role_id;
 202        u8 enabled;
 203        u8 num_groups;
 204        u8 pad[1];
 205        u8 mac_table[ADDRESS_GROUP_MAX_LEN];
 206} __packed;
 207
 208struct acx_rx_timeout {
 209        struct acx_header header;
 210
 211        u8 role_id;
 212        u8 reserved;
 213        __le16 ps_poll_timeout;
 214        __le16 upsd_timeout;
 215        u8 padding[2];
 216} __packed;
 217
 218struct acx_rts_threshold {
 219        struct acx_header header;
 220
 221        u8 role_id;
 222        u8 reserved;
 223        __le16 threshold;
 224} __packed;
 225
 226struct acx_beacon_filter_option {
 227        struct acx_header header;
 228
 229        u8 role_id;
 230        u8 enable;
 231        /*
 232         * The number of beacons without the unicast TIM
 233         * bit set that the firmware buffers before
 234         * signaling the host about ready frames.
 235         * When set to 0 and the filter is enabled, beacons
 236         * without the unicast TIM bit set are dropped.
 237         */
 238        u8 max_num_beacons;
 239        u8 pad[1];
 240} __packed;
 241
 242/*
 243 * ACXBeaconFilterEntry (not 221)
 244 * Byte Offset     Size (Bytes)    Definition
 245 * ===========     ============    ==========
 246 * 0               1               IE identifier
 247 * 1               1               Treatment bit mask
 248 *
 249 * ACXBeaconFilterEntry (221)
 250 * Byte Offset     Size (Bytes)    Definition
 251 * ===========     ============    ==========
 252 * 0               1               IE identifier
 253 * 1               1               Treatment bit mask
 254 * 2               3               OUI
 255 * 5               1               Type
 256 * 6               2               Version
 257 *
 258 *
 259 * Treatment bit mask - The information element handling:
 260 * bit 0 - The information element is compared and transferred
 261 * in case of change.
 262 * bit 1 - The information element is transferred to the host
 263 * with each appearance or disappearance.
 264 * Note that both bits can be set at the same time.
 265 */
 266#define BEACON_FILTER_TABLE_MAX_IE_NUM                 (32)
 267#define BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM (6)
 268#define BEACON_FILTER_TABLE_IE_ENTRY_SIZE              (2)
 269#define BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE (6)
 270#define BEACON_FILTER_TABLE_MAX_SIZE ((BEACON_FILTER_TABLE_MAX_IE_NUM * \
 271                            BEACON_FILTER_TABLE_IE_ENTRY_SIZE) + \
 272                           (BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM * \
 273                            BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE))
 274
 275struct acx_beacon_filter_ie_table {
 276        struct acx_header header;
 277
 278        u8 role_id;
 279        u8 num_ie;
 280        u8 pad[2];
 281        u8 table[BEACON_FILTER_TABLE_MAX_SIZE];
 282} __packed;
 283
 284struct acx_conn_monit_params {
 285       struct acx_header header;
 286
 287           u8 role_id;
 288           u8 padding[3];
 289       __le32 synch_fail_thold; /* number of beacons missed */
 290       __le32 bss_lose_timeout; /* number of TU's from synch fail */
 291} __packed;
 292
 293struct acx_bt_wlan_coex {
 294        struct acx_header header;
 295
 296        u8 enable;
 297        u8 pad[3];
 298} __packed;
 299
 300struct acx_bt_wlan_coex_param {
 301        struct acx_header header;
 302
 303        __le32 params[CONF_SG_PARAMS_MAX];
 304        u8 param_idx;
 305        u8 padding[3];
 306} __packed;
 307
 308struct acx_dco_itrim_params {
 309        struct acx_header header;
 310
 311        u8 enable;
 312        u8 padding[3];
 313        __le32 timeout;
 314} __packed;
 315
 316struct acx_energy_detection {
 317        struct acx_header header;
 318
 319        /* The RX Clear Channel Assessment threshold in the PHY */
 320        __le16 rx_cca_threshold;
 321        u8 tx_energy_detection;
 322        u8 pad;
 323} __packed;
 324
 325struct acx_beacon_broadcast {
 326        struct acx_header header;
 327
 328        u8 role_id;
 329        /* Enables receiving of broadcast packets in PS mode */
 330        u8 rx_broadcast_in_ps;
 331
 332        __le16 beacon_rx_timeout;
 333        __le16 broadcast_timeout;
 334
 335        /* Consecutive PS Poll failures before updating the host */
 336        u8 ps_poll_threshold;
 337        u8 pad[1];
 338} __packed;
 339
 340struct acx_event_mask {
 341        struct acx_header header;
 342
 343        __le32 event_mask;
 344        __le32 high_event_mask; /* Unused */
 345} __packed;
 346
 347#define SCAN_PASSIVE            BIT(0)
 348#define SCAN_5GHZ_BAND          BIT(1)
 349#define SCAN_TRIGGERED          BIT(2)
 350#define SCAN_PRIORITY_HIGH      BIT(3)
 351
 352/* When set, disable HW encryption */
 353#define DF_ENCRYPTION_DISABLE      0x01
 354#define DF_SNIFF_MODE_ENABLE       0x80
 355
 356struct acx_feature_config {
 357        struct acx_header header;
 358
 359        u8 role_id;
 360        u8 padding[3];
 361        __le32 options;
 362        __le32 data_flow_options;
 363} __packed;
 364
 365struct acx_current_tx_power {
 366        struct acx_header header;
 367
 368        u8  role_id;
 369        u8  current_tx_power;
 370        u8  padding[2];
 371} __packed;
 372
 373struct acx_wake_up_condition {
 374        struct acx_header header;
 375
 376        u8 role_id;
 377        u8 wake_up_event; /* Only one bit can be set */
 378        u8 listen_interval;
 379        u8 pad[1];
 380} __packed;
 381
 382struct acx_aid {
 383        struct acx_header header;
 384
 385        /*
 386         * To be set when associated with an AP.
 387         */
 388        u8 role_id;
 389        u8 reserved;
 390        __le16 aid;
 391} __packed;
 392
 393enum acx_preamble_type {
 394        ACX_PREAMBLE_LONG = 0,
 395        ACX_PREAMBLE_SHORT = 1
 396};
 397
 398struct acx_preamble {
 399        struct acx_header header;
 400
 401        /*
 402         * When set, the WiLink transmits the frames with a short preamble and
 403         * when cleared, the WiLink transmits the frames with a long preamble.
 404         */
 405        u8 role_id;
 406        u8 preamble;
 407        u8 padding[2];
 408} __packed;
 409
 410enum acx_ctsprotect_type {
 411        CTSPROTECT_DISABLE = 0,
 412        CTSPROTECT_ENABLE = 1
 413};
 414
 415struct acx_ctsprotect {
 416        struct acx_header header;
 417        u8 role_id;
 418        u8 ctsprotect;
 419        u8 padding[2];
 420} __packed;
 421
 422struct acx_rate_class {
 423        __le32 enabled_rates;
 424        u8 short_retry_limit;
 425        u8 long_retry_limit;
 426        u8 aflags;
 427        u8 reserved;
 428};
 429
 430struct acx_rate_policy {
 431        struct acx_header header;
 432
 433        __le32 rate_policy_idx;
 434        struct acx_rate_class rate_policy;
 435} __packed;
 436
 437struct acx_ac_cfg {
 438        struct acx_header header;
 439        u8 role_id;
 440        u8 ac;
 441        u8 aifsn;
 442        u8 cw_min;
 443        __le16 cw_max;
 444        __le16 tx_op_limit;
 445} __packed;
 446
 447struct acx_tid_config {
 448        struct acx_header header;
 449        u8 role_id;
 450        u8 queue_id;
 451        u8 channel_type;
 452        u8 tsid;
 453        u8 ps_scheme;
 454        u8 ack_policy;
 455        u8 padding[2];
 456        __le32 apsd_conf[2];
 457} __packed;
 458
 459struct acx_frag_threshold {
 460        struct acx_header header;
 461        __le16 frag_threshold;
 462        u8 padding[2];
 463} __packed;
 464
 465struct acx_tx_config_options {
 466        struct acx_header header;
 467        __le16 tx_compl_timeout;     /* msec */
 468        __le16 tx_compl_threshold;   /* number of packets */
 469} __packed;
 470
 471struct wl12xx_acx_config_memory {
 472        struct acx_header header;
 473
 474        u8 rx_mem_block_num;
 475        u8 tx_min_mem_block_num;
 476        u8 num_stations;
 477        u8 num_ssid_profiles;
 478        __le32 total_tx_descriptors;
 479        u8 dyn_mem_enable;
 480        u8 tx_free_req;
 481        u8 rx_free_req;
 482        u8 tx_min;
 483        u8 fwlog_blocks;
 484        u8 padding[3];
 485} __packed;
 486
 487struct wl1271_acx_mem_map {
 488        struct acx_header header;
 489
 490        __le32 code_start;
 491        __le32 code_end;
 492
 493        __le32 wep_defkey_start;
 494        __le32 wep_defkey_end;
 495
 496        __le32 sta_table_start;
 497        __le32 sta_table_end;
 498
 499        __le32 packet_template_start;
 500        __le32 packet_template_end;
 501
 502        /* Address of the TX result interface (control block) */
 503        __le32 tx_result;
 504        __le32 tx_result_queue_start;
 505
 506        __le32 queue_memory_start;
 507        __le32 queue_memory_end;
 508
 509        __le32 packet_memory_pool_start;
 510        __le32 packet_memory_pool_end;
 511
 512        __le32 debug_buffer1_start;
 513        __le32 debug_buffer1_end;
 514
 515        __le32 debug_buffer2_start;
 516        __le32 debug_buffer2_end;
 517
 518        /* Number of blocks FW allocated for TX packets */
 519        __le32 num_tx_mem_blocks;
 520
 521        /* Number of blocks FW allocated for RX packets */
 522        __le32 num_rx_mem_blocks;
 523
 524        /* the following 4 fields are valid in SLAVE mode only */
 525        u8 *tx_cbuf;
 526        u8 *rx_cbuf;
 527        __le32 rx_ctrl;
 528        __le32 tx_ctrl;
 529} __packed;
 530
 531struct wl1271_acx_rx_config_opt {
 532        struct acx_header header;
 533
 534        __le16 mblk_threshold;
 535        __le16 threshold;
 536        __le16 timeout;
 537        u8 queue_type;
 538        u8 reserved;
 539} __packed;
 540
 541
 542struct wl1271_acx_bet_enable {
 543        struct acx_header header;
 544
 545        u8 role_id;
 546        u8 enable;
 547        u8 max_consecutive;
 548        u8 padding[1];
 549} __packed;
 550
 551#define ACX_IPV4_VERSION 4
 552#define ACX_IPV6_VERSION 6
 553#define ACX_IPV4_ADDR_SIZE 4
 554
 555/* bitmap of enabled arp_filter features */
 556#define ACX_ARP_FILTER_ARP_FILTERING    BIT(0)
 557#define ACX_ARP_FILTER_AUTO_ARP         BIT(1)
 558
 559struct wl1271_acx_arp_filter {
 560        struct acx_header header;
 561        u8 role_id;
 562        u8 version;         /* ACX_IPV4_VERSION, ACX_IPV6_VERSION */
 563        u8 enable;          /* bitmap of enabled ARP filtering features */
 564        u8 padding[1];
 565        u8 address[16];     /* The configured device IP address - all ARP
 566                               requests directed to this IP address will pass
 567                               through. For IPv4, the first four bytes are
 568                               used. */
 569} __packed;
 570
 571struct wl1271_acx_pm_config {
 572        struct acx_header header;
 573
 574        __le32 host_clk_settling_time;
 575        u8 host_fast_wakeup_support;
 576        u8 padding[3];
 577} __packed;
 578
 579struct wl1271_acx_keep_alive_mode {
 580        struct acx_header header;
 581
 582        u8 role_id;
 583        u8 enabled;
 584        u8 padding[2];
 585} __packed;
 586
 587enum {
 588        ACX_KEEP_ALIVE_NO_TX = 0,
 589        ACX_KEEP_ALIVE_PERIOD_ONLY
 590};
 591
 592enum {
 593        ACX_KEEP_ALIVE_TPL_INVALID = 0,
 594        ACX_KEEP_ALIVE_TPL_VALID
 595};
 596
 597struct wl1271_acx_keep_alive_config {
 598        struct acx_header header;
 599
 600        u8 role_id;
 601        u8 index;
 602        u8 tpl_validation;
 603        u8 trigger;
 604        __le32 period;
 605} __packed;
 606
 607/* TODO: maybe this needs to be moved somewhere else? */
 608#define HOST_IF_CFG_RX_FIFO_ENABLE     BIT(0)
 609#define HOST_IF_CFG_TX_EXTRA_BLKS_SWAP BIT(1)
 610#define HOST_IF_CFG_TX_PAD_TO_SDIO_BLK BIT(3)
 611#define HOST_IF_CFG_RX_PAD_TO_SDIO_BLK BIT(4)
 612#define HOST_IF_CFG_ADD_RX_ALIGNMENT   BIT(6)
 613
 614enum {
 615        WL1271_ACX_TRIG_TYPE_LEVEL = 0,
 616        WL1271_ACX_TRIG_TYPE_EDGE,
 617};
 618
 619enum {
 620        WL1271_ACX_TRIG_DIR_LOW = 0,
 621        WL1271_ACX_TRIG_DIR_HIGH,
 622        WL1271_ACX_TRIG_DIR_BIDIR,
 623};
 624
 625enum {
 626        WL1271_ACX_TRIG_ENABLE = 1,
 627        WL1271_ACX_TRIG_DISABLE,
 628};
 629
 630enum {
 631        WL1271_ACX_TRIG_METRIC_RSSI_BEACON = 0,
 632        WL1271_ACX_TRIG_METRIC_RSSI_DATA,
 633        WL1271_ACX_TRIG_METRIC_SNR_BEACON,
 634        WL1271_ACX_TRIG_METRIC_SNR_DATA,
 635};
 636
 637enum {
 638        WL1271_ACX_TRIG_IDX_RSSI = 0,
 639        WL1271_ACX_TRIG_COUNT = 8,
 640};
 641
 642struct wl1271_acx_rssi_snr_trigger {
 643        struct acx_header header;
 644
 645        u8 role_id;
 646        u8 metric;
 647        u8 type;
 648        u8 dir;
 649        __le16 threshold;
 650        __le16 pacing; /* 0 - 60000 ms */
 651        u8 hysteresis;
 652        u8 index;
 653        u8 enable;
 654        u8 padding[1];
 655};
 656
 657struct wl1271_acx_rssi_snr_avg_weights {
 658        struct acx_header header;
 659
 660        u8 role_id;
 661        u8 padding[3];
 662        u8 rssi_beacon;
 663        u8 rssi_data;
 664        u8 snr_beacon;
 665        u8 snr_data;
 666};
 667
 668
 669/* special capability bit (not employed by the 802.11n spec) */
 670#define WL12XX_HT_CAP_HT_OPERATION BIT(16)
 671
 672/*
 673 * ACX_PEER_HT_CAP
 674 * Configure HT capabilities - declare the capabilities of the peer
 675 * we are connected to.
 676 */
 677struct wl1271_acx_ht_capabilities {
 678        struct acx_header header;
 679
 680        /* bitmask of capability bits supported by the peer */
 681        __le32 ht_capabilites;
 682
 683        /* Indicates to which link these capabilities apply. */
 684        u8 hlid;
 685
 686        /*
 687         * This the maximum A-MPDU length supported by the AP. The FW may not
 688         * exceed this length when sending A-MPDUs
 689         */
 690        u8 ampdu_max_length;
 691
 692        /* This is the minimal spacing required when sending A-MPDUs to the AP*/
 693        u8 ampdu_min_spacing;
 694
 695        u8 padding;
 696} __packed;
 697
 698/*
 699 * ACX_HT_BSS_OPERATION
 700 * Configure HT capabilities - AP rules for behavior in the BSS.
 701 */
 702struct wl1271_acx_ht_information {
 703        struct acx_header header;
 704
 705        u8 role_id;
 706
 707        /* Values: 0 - RIFS not allowed, 1 - RIFS allowed */
 708        u8 rifs_mode;
 709
 710        /* Values: 0 - 3 like in spec */
 711        u8 ht_protection;
 712
 713        /* Values: 0 - GF protection not required, 1 - GF protection required */
 714        u8 gf_protection;
 715
 716        /*Values: 0 - TX Burst limit not required, 1 - TX Burst Limit required*/
 717        u8 ht_tx_burst_limit;
 718
 719        /*
 720         * Values: 0 - Dual CTS protection not required,
 721         *         1 - Dual CTS Protection required
 722         * Note: When this value is set to 1 FW will protect all TXOP with RTS
 723         * frame and will not use CTS-to-self regardless of the value of the
 724         * ACX_CTS_PROTECTION information element
 725         */
 726        u8 dual_cts_protection;
 727
 728        u8 padding[2];
 729} __packed;
 730
 731struct wl1271_acx_ba_initiator_policy {
 732        struct acx_header header;
 733
 734        /* Specifies role Id, Range 0-7, 0xFF means ANY role. */
 735        u8 role_id;
 736
 737        /*
 738         * Per TID setting for allowing TX BA. Set a bit to 1 to allow
 739         * TX BA sessions for the corresponding TID.
 740         */
 741        u8 tid_bitmap;
 742
 743        /* Windows size in number of packets */
 744        u8 win_size;
 745
 746        u8 padding1[1];
 747
 748        /* As initiator inactivity timeout in time units(TU) of 1024us */
 749        u16 inactivity_timeout;
 750
 751        u8 padding[2];
 752} __packed;
 753
 754struct wl1271_acx_ba_receiver_setup {
 755        struct acx_header header;
 756
 757        /* Specifies link id, range 0-31 */
 758        u8 hlid;
 759
 760        u8 tid;
 761
 762        u8 enable;
 763
 764        /* Windows size in number of packets */
 765        u8 win_size;
 766
 767        /* BA session starting sequence number.  RANGE 0-FFF */
 768        u16 ssn;
 769
 770        u8 padding[2];
 771} __packed;
 772
 773struct wl12xx_acx_fw_tsf_information {
 774        struct acx_header header;
 775
 776        u8 role_id;
 777        u8 padding1[3];
 778        __le32 current_tsf_high;
 779        __le32 current_tsf_low;
 780        __le32 last_bttt_high;
 781        __le32 last_tbtt_low;
 782        u8 last_dtim_count;
 783        u8 padding2[3];
 784} __packed;
 785
 786struct wl1271_acx_ps_rx_streaming {
 787        struct acx_header header;
 788
 789        u8 role_id;
 790        u8 tid;
 791        u8 enable;
 792
 793        /* interval between triggers (10-100 msec) */
 794        u8 period;
 795
 796        /* timeout before first trigger (0-200 msec) */
 797        u8 timeout;
 798        u8 padding[3];
 799} __packed;
 800
 801struct wl1271_acx_ap_max_tx_retry {
 802        struct acx_header header;
 803
 804        u8 role_id;
 805        u8 padding_1;
 806
 807        /*
 808         * the number of frames transmission failures before
 809         * issuing the aging event.
 810         */
 811        __le16 max_tx_retry;
 812} __packed;
 813
 814struct wl1271_acx_config_ps {
 815        struct acx_header header;
 816
 817        u8 exit_retries;
 818        u8 enter_retries;
 819        u8 padding[2];
 820        __le32 null_data_rate;
 821} __packed;
 822
 823struct wl1271_acx_inconnection_sta {
 824        struct acx_header header;
 825
 826        u8 addr[ETH_ALEN];
 827        u8 padding1[2];
 828} __packed;
 829
 830/*
 831 * ACX_FM_COEX_CFG
 832 * set the FM co-existence parameters.
 833 */
 834struct wl1271_acx_fm_coex {
 835        struct acx_header header;
 836        /* enable(1) / disable(0) the FM Coex feature */
 837        u8 enable;
 838        /*
 839         * Swallow period used in COEX PLL swallowing mechanism.
 840         * 0xFF = use FW default
 841         */
 842        u8 swallow_period;
 843        /*
 844         * The N divider used in COEX PLL swallowing mechanism for Fref of
 845         * 38.4/19.2 Mhz. 0xFF = use FW default
 846         */
 847        u8 n_divider_fref_set_1;
 848        /*
 849         * The N divider used in COEX PLL swallowing mechanism for Fref of
 850         * 26/52 Mhz. 0xFF = use FW default
 851         */
 852        u8 n_divider_fref_set_2;
 853        /*
 854         * The M divider used in COEX PLL swallowing mechanism for Fref of
 855         * 38.4/19.2 Mhz. 0xFFFF = use FW default
 856         */
 857        __le16 m_divider_fref_set_1;
 858        /*
 859         * The M divider used in COEX PLL swallowing mechanism for Fref of
 860         * 26/52 Mhz. 0xFFFF = use FW default
 861         */
 862        __le16 m_divider_fref_set_2;
 863        /*
 864         * The time duration in uSec required for COEX PLL to stabilize.
 865         * 0xFFFFFFFF = use FW default
 866         */
 867        __le32 coex_pll_stabilization_time;
 868        /*
 869         * The time duration in uSec required for LDO to stabilize.
 870         * 0xFFFFFFFF = use FW default
 871         */
 872        __le16 ldo_stabilization_time;
 873        /*
 874         * The disturbed frequency band margin around the disturbed frequency
 875         * center (single sided).
 876         * For example, if 2 is configured, the following channels will be
 877         * considered disturbed channel:
 878         *   80 +- 0.1 MHz, 91 +- 0.1 MHz, 98 +- 0.1 MHz, 102 +- 0.1 MH
 879         * 0xFF = use FW default
 880         */
 881        u8 fm_disturbed_band_margin;
 882        /*
 883         * The swallow clock difference of the swallowing mechanism.
 884         * 0xFF = use FW default
 885         */
 886        u8 swallow_clk_diff;
 887} __packed;
 888
 889#define ACX_RATE_MGMT_ALL_PARAMS 0xff
 890struct wl12xx_acx_set_rate_mgmt_params {
 891        struct acx_header header;
 892
 893        u8 index; /* 0xff to configure all params */
 894        u8 padding1;
 895        __le16 rate_retry_score;
 896        __le16 per_add;
 897        __le16 per_th1;
 898        __le16 per_th2;
 899        __le16 max_per;
 900        u8 inverse_curiosity_factor;
 901        u8 tx_fail_low_th;
 902        u8 tx_fail_high_th;
 903        u8 per_alpha_shift;
 904        u8 per_add_shift;
 905        u8 per_beta1_shift;
 906        u8 per_beta2_shift;
 907        u8 rate_check_up;
 908        u8 rate_check_down;
 909        u8 rate_retry_policy[ACX_RATE_MGMT_NUM_OF_RATES];
 910        u8 padding2[2];
 911} __packed;
 912
 913struct wl12xx_acx_config_hangover {
 914        struct acx_header header;
 915
 916        __le32 recover_time;
 917        u8 hangover_period;
 918        u8 dynamic_mode;
 919        u8 early_termination_mode;
 920        u8 max_period;
 921        u8 min_period;
 922        u8 increase_delta;
 923        u8 decrease_delta;
 924        u8 quiet_time;
 925        u8 increase_time;
 926        u8 window_size;
 927        u8 padding[2];
 928} __packed;
 929
 930
 931struct acx_default_rx_filter {
 932        struct acx_header header;
 933        u8 enable;
 934
 935        /* action of type FILTER_XXX */
 936        u8 default_action;
 937
 938        u8 pad[2];
 939} __packed;
 940
 941
 942struct acx_rx_filter_cfg {
 943        struct acx_header header;
 944
 945        u8 enable;
 946
 947        /* 0 - WL1271_MAX_RX_FILTERS-1 */
 948        u8 index;
 949
 950        u8 action;
 951
 952        u8 num_fields;
 953        u8 fields[0];
 954} __packed;
 955
 956struct acx_roaming_stats {
 957        struct acx_header header;
 958
 959        u8      role_id;
 960        u8      pad[3];
 961        u32     missed_beacons;
 962        u8      snr_data;
 963        u8      snr_bacon;
 964        s8      rssi_data;
 965        s8      rssi_beacon;
 966} __packed;
 967
 968enum {
 969        ACX_WAKE_UP_CONDITIONS           = 0x0000,
 970        ACX_MEM_CFG                      = 0x0001,
 971        ACX_SLOT                         = 0x0002,
 972        ACX_AC_CFG                       = 0x0003,
 973        ACX_MEM_MAP                      = 0x0004,
 974        ACX_AID                          = 0x0005,
 975        ACX_MEDIUM_USAGE                 = 0x0006,
 976        ACX_STATISTICS                   = 0x0007,
 977        ACX_PWR_CONSUMPTION_STATISTICS   = 0x0008,
 978        ACX_TID_CFG                      = 0x0009,
 979        ACX_PS_RX_STREAMING              = 0x000A,
 980        ACX_BEACON_FILTER_OPT            = 0x000B,
 981        ACX_NOISE_HIST                   = 0x000C,
 982        ACX_HDK_VERSION                  = 0x000D,
 983        ACX_PD_THRESHOLD                 = 0x000E,
 984        ACX_TX_CONFIG_OPT                = 0x000F,
 985        ACX_CCA_THRESHOLD                = 0x0010,
 986        ACX_EVENT_MBOX_MASK              = 0x0011,
 987        ACX_CONN_MONIT_PARAMS            = 0x0012,
 988        ACX_DISABLE_BROADCASTS           = 0x0013,
 989        ACX_BCN_DTIM_OPTIONS             = 0x0014,
 990        ACX_SG_ENABLE                    = 0x0015,
 991        ACX_SG_CFG                       = 0x0016,
 992        ACX_FM_COEX_CFG                  = 0x0017,
 993        ACX_BEACON_FILTER_TABLE          = 0x0018,
 994        ACX_ARP_IP_FILTER                = 0x0019,
 995        ACX_ROAMING_STATISTICS_TBL       = 0x001A,
 996        ACX_RATE_POLICY                  = 0x001B,
 997        ACX_CTS_PROTECTION               = 0x001C,
 998        ACX_SLEEP_AUTH                   = 0x001D,
 999        ACX_PREAMBLE_TYPE                = 0x001E,
1000        ACX_ERROR_CNT                    = 0x001F,
1001        ACX_IBSS_FILTER                  = 0x0020,
1002        ACX_SERVICE_PERIOD_TIMEOUT       = 0x0021,
1003        ACX_TSF_INFO                     = 0x0022,
1004        ACX_CONFIG_PS_WMM                = 0x0023,
1005        ACX_ENABLE_RX_DATA_FILTER        = 0x0024,
1006        ACX_SET_RX_DATA_FILTER           = 0x0025,
1007        ACX_GET_DATA_FILTER_STATISTICS   = 0x0026,
1008        ACX_RX_CONFIG_OPT                = 0x0027,
1009        ACX_FRAG_CFG                     = 0x0028,
1010        ACX_BET_ENABLE                   = 0x0029,
1011        ACX_RSSI_SNR_TRIGGER             = 0x002A,
1012        ACX_RSSI_SNR_WEIGHTS             = 0x002B,
1013        ACX_KEEP_ALIVE_MODE              = 0x002C,
1014        ACX_SET_KEEP_ALIVE_CONFIG        = 0x002D,
1015        ACX_BA_SESSION_INIT_POLICY       = 0x002E,
1016        ACX_BA_SESSION_RX_SETUP          = 0x002F,
1017        ACX_PEER_HT_CAP                  = 0x0030,
1018        ACX_HT_BSS_OPERATION             = 0x0031,
1019        ACX_COEX_ACTIVITY                = 0x0032,
1020        ACX_BURST_MODE                   = 0x0033,
1021        ACX_SET_RATE_MGMT_PARAMS         = 0x0034,
1022        ACX_GET_RATE_MGMT_PARAMS         = 0x0035,
1023        ACX_SET_RATE_ADAPT_PARAMS        = 0x0036,
1024        ACX_SET_DCO_ITRIM_PARAMS         = 0x0037,
1025        ACX_GEN_FW_CMD                   = 0x0038,
1026        ACX_HOST_IF_CFG_BITMAP           = 0x0039,
1027        ACX_MAX_TX_FAILURE               = 0x003A,
1028        ACX_UPDATE_INCONNECTION_STA_LIST = 0x003B,
1029        DOT11_RX_MSDU_LIFE_TIME          = 0x003C,
1030        DOT11_CUR_TX_PWR                 = 0x003D,
1031        DOT11_RTS_THRESHOLD              = 0x003E,
1032        DOT11_GROUP_ADDRESS_TBL          = 0x003F,
1033        ACX_PM_CONFIG                    = 0x0040,
1034        ACX_CONFIG_PS                    = 0x0041,
1035        ACX_CONFIG_HANGOVER              = 0x0042,
1036        ACX_FEATURE_CFG                  = 0x0043,
1037        ACX_PROTECTION_CFG               = 0x0044,
1038};
1039
1040
1041int wl1271_acx_wake_up_conditions(struct wl1271 *wl,
1042                                  struct wl12xx_vif *wlvif,
1043                                  u8 wake_up_event, u8 listen_interval);
1044int wl1271_acx_sleep_auth(struct wl1271 *wl, u8 sleep_auth);
1045int wl1271_acx_tx_power(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1046                        int power);
1047int wl1271_acx_feature_cfg(struct wl1271 *wl, struct wl12xx_vif *wlvif);
1048int wl1271_acx_mem_map(struct wl1271 *wl,
1049                       struct acx_header *mem_map, size_t len);
1050int wl1271_acx_rx_msdu_life_time(struct wl1271 *wl);
1051int wl1271_acx_slot(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1052                    enum acx_slot_type slot_time);
1053int wl1271_acx_group_address_tbl(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1054                                 bool enable, void *mc_list, u32 mc_list_len);
1055int wl1271_acx_service_period_timeout(struct wl1271 *wl,
1056                                      struct wl12xx_vif *wlvif);
1057int wl1271_acx_rts_threshold(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1058                             u32 rts_threshold);
1059int wl1271_acx_dco_itrim_params(struct wl1271 *wl);
1060int wl1271_acx_beacon_filter_opt(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1061                                 bool enable_filter);
1062int wl1271_acx_beacon_filter_table(struct wl1271 *wl,
1063                                   struct wl12xx_vif *wlvif);
1064int wl1271_acx_conn_monit_params(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1065                                 bool enable);
1066int wl1271_acx_sg_enable(struct wl1271 *wl, bool enable);
1067int wl12xx_acx_sg_cfg(struct wl1271 *wl);
1068int wl1271_acx_cca_threshold(struct wl1271 *wl);
1069int wl1271_acx_bcn_dtim_options(struct wl1271 *wl, struct wl12xx_vif *wlvif);
1070int wl1271_acx_aid(struct wl1271 *wl, struct wl12xx_vif *wlvif, u16 aid);
1071int wl1271_acx_event_mbox_mask(struct wl1271 *wl, u32 event_mask);
1072int wl1271_acx_set_preamble(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1073                            enum acx_preamble_type preamble);
1074int wl1271_acx_cts_protect(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1075                           enum acx_ctsprotect_type ctsprotect);
1076int wl1271_acx_statistics(struct wl1271 *wl, void *stats);
1077int wl1271_acx_sta_rate_policies(struct wl1271 *wl, struct wl12xx_vif *wlvif);
1078int wl1271_acx_ap_rate_policy(struct wl1271 *wl, struct conf_tx_rate_class *c,
1079                      u8 idx);
1080int wl1271_acx_ac_cfg(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1081                      u8 ac, u8 cw_min, u16 cw_max, u8 aifsn, u16 txop);
1082int wl1271_acx_tid_cfg(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1083                       u8 queue_id, u8 channel_type,
1084                       u8 tsid, u8 ps_scheme, u8 ack_policy,
1085                       u32 apsd_conf0, u32 apsd_conf1);
1086int wl1271_acx_frag_threshold(struct wl1271 *wl, u32 frag_threshold);
1087int wl1271_acx_tx_config_options(struct wl1271 *wl);
1088int wl12xx_acx_mem_cfg(struct wl1271 *wl);
1089int wl1271_acx_init_mem_config(struct wl1271 *wl);
1090int wl1271_acx_init_rx_interrupt(struct wl1271 *wl);
1091int wl1271_acx_smart_reflex(struct wl1271 *wl);
1092int wl1271_acx_bet_enable(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1093                          bool enable);
1094int wl1271_acx_arp_ip_filter(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1095                             u8 enable, __be32 address);
1096int wl1271_acx_pm_config(struct wl1271 *wl);
1097int wl1271_acx_keep_alive_mode(struct wl1271 *wl, struct wl12xx_vif *vif,
1098                               bool enable);
1099int wl1271_acx_keep_alive_config(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1100                                 u8 index, u8 tpl_valid);
1101int wl1271_acx_rssi_snr_trigger(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1102                                bool enable, s16 thold, u8 hyst);
1103int wl1271_acx_rssi_snr_avg_weights(struct wl1271 *wl,
1104                                    struct wl12xx_vif *wlvif);
1105int wl1271_acx_set_ht_capabilities(struct wl1271 *wl,
1106                                    struct ieee80211_sta_ht_cap *ht_cap,
1107                                    bool allow_ht_operation, u8 hlid);
1108int wl1271_acx_set_ht_information(struct wl1271 *wl,
1109                                   struct wl12xx_vif *wlvif,
1110                                   u16 ht_operation_mode);
1111int wl12xx_acx_set_ba_initiator_policy(struct wl1271 *wl,
1112                                       struct wl12xx_vif *wlvif);
1113int wl12xx_acx_set_ba_receiver_session(struct wl1271 *wl, u8 tid_index,
1114                                       u16 ssn, bool enable, u8 peer_hlid);
1115int wl12xx_acx_tsf_info(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1116                        u64 *mactime);
1117int wl1271_acx_ps_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1118                               bool enable);
1119int wl1271_acx_ap_max_tx_retry(struct wl1271 *wl, struct wl12xx_vif *wlvif);
1120int wl12xx_acx_config_ps(struct wl1271 *wl, struct wl12xx_vif *wlvif);
1121int wl1271_acx_set_inconnection_sta(struct wl1271 *wl, u8 *addr);
1122int wl1271_acx_fm_coex(struct wl1271 *wl);
1123int wl12xx_acx_set_rate_mgmt_params(struct wl1271 *wl);
1124int wl12xx_acx_config_hangover(struct wl1271 *wl);
1125int wlcore_acx_average_rssi(struct wl1271 *wl, struct wl12xx_vif *wlvif,
1126                            s8 *avg_rssi);
1127
1128#ifdef CONFIG_PM
1129int wl1271_acx_default_rx_filter_enable(struct wl1271 *wl, bool enable,
1130                                        enum rx_filter_action action);
1131int wl1271_acx_set_rx_filter(struct wl1271 *wl, u8 index, bool enable,
1132                             struct wl12xx_rx_filter *filter);
1133#endif /* CONFIG_PM */
1134#endif /* __WL1271_ACX_H__ */
1135