drivers/net/wireless/wl12xx/wl1271_acx.h

   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 __WL1271_ACX_H__
  26 #define __WL1271_ACX_H__
  27
  28 #include "wl1271.h"
  29 #include "wl1271_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 meassge on MBOX #A */
  51 #define WL1271_ACX_INTR_TRACE_A            BIT(7)
  52 /* Trace meassge on MBOX #B */
  53 #define WL1271_ACX_INTR_TRACE_B            BIT(8)
  54
  55 #define WL1271_ACX_INTR_ALL                0xFFFFFFFF
  56 #define WL1271_ACX_ALL_EVENTS_VECTOR       (WL1271_ACX_INTR_WATCHDOG      | \
  57                                             WL1271_ACX_INTR_INIT_COMPLETE | \
  58                                             WL1271_ACX_INTR_EVENT_A       | \
  59                                             WL1271_ACX_INTR_EVENT_B       | \
  60                                             WL1271_ACX_INTR_CMD_COMPLETE  | \
  61                                             WL1271_ACX_INTR_HW_AVAILABLE  | \
  62                                             WL1271_ACX_INTR_DATA)
  63
  64 #define WL1271_INTR_MASK                   (WL1271_ACX_INTR_EVENT_A      | \
  65                                             WL1271_ACX_INTR_EVENT_B      | \
  66                                             WL1271_ACX_INTR_HW_AVAILABLE | \
  67                                             WL1271_ACX_INTR_DATA)
  68
  69 /* Target's information element */
  70 struct acx_header {
  71         struct wl1271_cmd_header cmd;
  72
  73         /* acx (or information element) header */
  74         __le16 id;
  75
  76         /* payload length (not including headers */
  77         __le16 len;
  78 } __packed;
  79
  80 struct acx_error_counter {
  81         struct acx_header header;
  82
  83         /* The number of PLCP errors since the last time this */
  84         /* information element was interrogated. This field is */
  85         /* automatically cleared when it is interrogated.*/
  86         __le32 PLCP_error;
  87
  88         /* The number of FCS errors since the last time this */
  89         /* information element was interrogated. This field is */
  90         /* automatically cleared when it is interrogated.*/
  91         __le32 FCS_error;
  92
  93         /* The number of MPDUs without PLCP header errors received*/
  94         /* since the last time this information element was interrogated. */
  95         /* This field is automatically cleared when it is interrogated.*/
  96         __le32 valid_frame;
  97
  98         /* the number of missed sequence numbers in the squentially */
  99         /* values of frames seq numbers */
 100         __le32 seq_num_miss;
 101 } __packed;
 102
 103 enum wl1271_psm_mode {
 104         /* Active mode */
 105         WL1271_PSM_CAM = 0,
 106
 107         /* Power save mode */
 108         WL1271_PSM_PS = 1,
 109
 110         /* Extreme low power */
 111         WL1271_PSM_ELP = 2,
 112 };
 113
 114 struct acx_sleep_auth {
 115         struct acx_header header;
 116
 117         /* The sleep level authorization of the device. */
 118         /* 0 - Always active*/
 119         /* 1 - Power down mode: light / fast sleep*/
 120         /* 2 - ELP mode: Deep / Max sleep*/
 121         u8  sleep_auth;
 122         u8  padding[3];
 123 } __packed;
 124
 125 enum {
 126         HOSTIF_PCI_MASTER_HOST_INDIRECT,
 127         HOSTIF_PCI_MASTER_HOST_DIRECT,
 128         HOSTIF_SLAVE,
 129         HOSTIF_PKT_RING,
 130         HOSTIF_DONTCARE = 0xFF
 131 };
 132
 133 #define DEFAULT_UCAST_PRIORITY          0
 134 #define DEFAULT_RX_Q_PRIORITY           0
 135 #define DEFAULT_NUM_STATIONS            1
 136 #define DEFAULT_RXQ_PRIORITY            0 /* low 0 .. 15 high  */
 137 #define DEFAULT_RXQ_TYPE                0x07    /* All frames, Data/Ctrl/Mgmt */
 138 #define TRACE_BUFFER_MAX_SIZE           256
 139
 140 #define  DP_RX_PACKET_RING_CHUNK_SIZE 1600
 141 #define  DP_TX_PACKET_RING_CHUNK_SIZE 1600
 142 #define  DP_RX_PACKET_RING_CHUNK_NUM 2
 143 #define  DP_TX_PACKET_RING_CHUNK_NUM 2
 144 #define  DP_TX_COMPLETE_TIME_OUT 20
 145
 146 #define TX_MSDU_LIFETIME_MIN       0
 147 #define TX_MSDU_LIFETIME_MAX       3000
 148 #define TX_MSDU_LIFETIME_DEF       512
 149 #define RX_MSDU_LIFETIME_MIN       0
 150 #define RX_MSDU_LIFETIME_MAX       0xFFFFFFFF
 151 #define RX_MSDU_LIFETIME_DEF       512000
 152
 153 struct acx_rx_msdu_lifetime {
 154         struct acx_header header;
 155
 156         /*
 157          * The maximum amount of time, in TU, before the
 158          * firmware discards the MSDU.
 159          */
 160         __le32 lifetime;
 161 } __packed;
 162
 163 /*
 164  * RX Config Options Table
 165  * Bit          Definition
 166  * ===          ==========
 167  * 31:14                Reserved
 168  * 13           Copy RX Status - when set, write three receive status words
 169  *              to top of rx'd MPDUs.
 170  *              When cleared, do not write three status words (added rev 1.5)
 171  * 12           Reserved
 172  * 11           RX Complete upon FCS error - when set, give rx complete
 173  *              interrupt for FCS errors, after the rx filtering, e.g. unicast
 174  *              frames not to us with FCS error will not generate an interrupt.
 175  * 10           SSID Filter Enable - When set, the WiLink discards all beacon,
 176  *              probe request, and probe response frames with an SSID that does
 177  *              not match the SSID specified by the host in the START/JOIN
 178  *              command.
 179  *              When clear, the WiLink receives frames with any SSID.
 180  * 9            Broadcast Filter Enable - When set, the WiLink discards all
 181  *              broadcast frames. When clear, the WiLink receives all received
 182  *              broadcast frames.
 183  * 8:6          Reserved
 184  * 5            BSSID Filter Enable - When set, the WiLink discards any frames
 185  *              with a BSSID that does not match the BSSID specified by the
 186  *              host.
 187  *              When clear, the WiLink receives frames from any BSSID.
 188  * 4            MAC Addr Filter - When set, the WiLink discards any frames
 189  *              with a destination address that does not match the MAC address
 190  *              of the adaptor.
 191  *              When clear, the WiLink receives frames destined to any MAC
 192  *              address.
 193  * 3            Promiscuous - When set, the WiLink receives all valid frames
 194  *              (i.e., all frames that pass the FCS check).
 195  *              When clear, only frames that pass the other filters specified
 196  *              are received.
 197  * 2            FCS - When set, the WiLink includes the FCS with the received
 198  *              frame.
 199  *              When cleared, the FCS is discarded.
 200  * 1            PLCP header - When set, write all data from baseband to frame
 201  *              buffer including PHY header.
 202  * 0            Reserved - Always equal to 0.
 203  *
 204  * RX Filter Options Table
 205  * Bit          Definition
 206  * ===          ==========
 207  * 31:12                Reserved - Always equal to 0.
 208  * 11           Association - When set, the WiLink receives all association
 209  *              related frames (association request/response, reassocation
 210  *              request/response, and disassociation). When clear, these frames
 211  *              are discarded.
 212  * 10           Auth/De auth - When set, the WiLink receives all authentication
 213  *              and de-authentication frames. When clear, these frames are
 214  *              discarded.
 215  * 9            Beacon - When set, the WiLink receives all beacon frames.
 216  *              When clear, these frames are discarded.
 217  * 8            Contention Free - When set, the WiLink receives all contention
 218  *              free frames.
 219  *              When clear, these frames are discarded.
 220  * 7            Control - When set, the WiLink receives all control frames.
 221  *              When clear, these frames are discarded.
 222  * 6            Data - When set, the WiLink receives all data frames.
 223  *              When clear, these frames are discarded.
 224  * 5            FCS Error - When set, the WiLink receives frames that have FCS
 225  *              errors.
 226  *              When clear, these frames are discarded.
 227  * 4            Management - When set, the WiLink receives all management
 228  *              frames.
 229  *              When clear, these frames are discarded.
 230  * 3            Probe Request - When set, the WiLink receives all probe request
 231  *              frames.
 232  *              When clear, these frames are discarded.
 233  * 2            Probe Response - When set, the WiLink receives all probe
 234  *              response frames.
 235  *              When clear, these frames are discarded.
 236  * 1            RTS/CTS/ACK - When set, the WiLink receives all RTS, CTS and ACK
 237  *              frames.
 238  *              When clear, these frames are discarded.
 239  * 0            Rsvd Type/Sub Type - When set, the WiLink receives all frames
 240  *              that have reserved frame types and sub types as defined by the
 241  *              802.11 specification.
 242  *              When clear, these frames are discarded.
 243  */
 244 struct acx_rx_config {
 245         struct acx_header header;
 246
 247         __le32 config_options;
 248         __le32 filter_options;
 249 } __packed;
 250
 251 struct acx_packet_detection {
 252         struct acx_header header;
 253
 254         __le32 threshold;
 255 } __packed;
 256
 257
 258 enum acx_slot_type {
 259         SLOT_TIME_LONG = 0,
 260         SLOT_TIME_SHORT = 1,
 261         DEFAULT_SLOT_TIME = SLOT_TIME_SHORT,
 262         MAX_SLOT_TIMES = 0xFF
 263 };
 264
 265 #define STATION_WONE_INDEX 0
 266
 267 struct acx_slot {
 268         struct acx_header header;
 269
 270         u8 wone_index; /* Reserved */
 271         u8 slot_time;
 272         u8 reserved[6];
 273 } __packed;
 274
 275
 276 #define ACX_MC_ADDRESS_GROUP_MAX        (8)
 277 #define ADDRESS_GROUP_MAX_LEN           (ETH_ALEN * ACX_MC_ADDRESS_GROUP_MAX)
 278
 279 struct acx_dot11_grp_addr_tbl {
 280         struct acx_header header;
 281
 282         u8 enabled;
 283         u8 num_groups;
 284         u8 pad[2];
 285         u8 mac_table[ADDRESS_GROUP_MAX_LEN];
 286 } __packed;
 287
 288 struct acx_rx_timeout {
 289         struct acx_header header;
 290
 291         __le16 ps_poll_timeout;
 292         __le16 upsd_timeout;
 293 } __packed;
 294
 295 struct acx_rts_threshold {
 296         struct acx_header header;
 297
 298         __le16 threshold;
 299         u8 pad[2];
 300 } __packed;
 301
 302 struct acx_beacon_filter_option {
 303         struct acx_header header;
 304
 305         u8 enable;
 306
 307         /*
 308          * The number of beacons without the unicast TIM
 309          * bit set that the firmware buffers before
 310          * signaling the host about ready frames.
 311          * When set to 0 and the filter is enabled, beacons
 312          * without the unicast TIM bit set are dropped.
 313          */
 314         u8 max_num_beacons;
 315         u8 pad[2];
 316 } __packed;
 317
 318 /*
 319  * ACXBeaconFilterEntry (not 221)
 320  * Byte Offset     Size (Bytes)    Definition
 321  * ===========     ============    ==========
 322  * 0               1               IE identifier
 323  * 1               1               Treatment bit mask
 324  *
 325  * ACXBeaconFilterEntry (221)
 326  * Byte Offset     Size (Bytes)    Definition
 327  * ===========     ============    ==========
 328  * 0               1               IE identifier
 329  * 1               1               Treatment bit mask
 330  * 2               3               OUI
 331  * 5               1               Type
 332  * 6               2               Version
 333  *
 334  *
 335  * Treatment bit mask - The information element handling:
 336  * bit 0 - The information element is compared and transferred
 337  * in case of change.
 338  * bit 1 - The information element is transferred to the host
 339  * with each appearance or disappearance.
 340  * Note that both bits can be set at the same time.
 341  */
 342 #define BEACON_FILTER_TABLE_MAX_IE_NUM                 (32)
 343 #define BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM (6)
 344 #define BEACON_FILTER_TABLE_IE_ENTRY_SIZE              (2)
 345 #define BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE (6)
 346 #define BEACON_FILTER_TABLE_MAX_SIZE ((BEACON_FILTER_TABLE_MAX_IE_NUM * \
 347                             BEACON_FILTER_TABLE_IE_ENTRY_SIZE) + \
 348                            (BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM * \
 349                             BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE))
 350
 351 struct acx_beacon_filter_ie_table {
 352         struct acx_header header;
 353
 354         u8 num_ie;
 355         u8 pad[3];
 356         u8 table[BEACON_FILTER_TABLE_MAX_SIZE];
 357 } __packed;
 358
 359 struct acx_conn_monit_params {
 360        struct acx_header header;
 361
 362        __le32 synch_fail_thold; /* number of beacons missed */
 363        __le32 bss_lose_timeout; /* number of TU's from synch fail */
 364 } __packed;
 365
 366 struct acx_bt_wlan_coex {
 367         struct acx_header header;
 368
 369         u8 enable;
 370         u8 pad[3];
 371 } __packed;
 372
 373 struct acx_bt_wlan_coex_param {
 374         struct acx_header header;
 375
 376         __le32 params[CONF_SG_PARAMS_MAX];
 377         u8 param_idx;
 378         u8 padding[3];
 379 } __packed;
 380
 381 struct acx_dco_itrim_params {
 382         struct acx_header header;
 383
 384         u8 enable;
 385         u8 padding[3];
 386         __le32 timeout;
 387 } __packed;
 388
 389 struct acx_energy_detection {
 390         struct acx_header header;
 391
 392         /* The RX Clear Channel Assessment threshold in the PHY */
 393         __le16 rx_cca_threshold;
 394         u8 tx_energy_detection;
 395         u8 pad;
 396 } __packed;
 397
 398 struct acx_beacon_broadcast {
 399         struct acx_header header;
 400
 401         __le16 beacon_rx_timeout;
 402         __le16 broadcast_timeout;
 403
 404         /* Enables receiving of broadcast packets in PS mode */
 405         u8 rx_broadcast_in_ps;
 406
 407         /* Consecutive PS Poll failures before updating the host */
 408         u8 ps_poll_threshold;
 409         u8 pad[2];
 410 } __packed;
 411
 412 struct acx_event_mask {
 413         struct acx_header header;
 414
 415         __le32 event_mask;
 416         __le32 high_event_mask; /* Unused */
 417 } __packed;
 418
 419 #define CFG_RX_FCS              BIT(2)
 420 #define CFG_RX_ALL_GOOD         BIT(3)
 421 #define CFG_UNI_FILTER_EN       BIT(4)
 422 #define CFG_BSSID_FILTER_EN     BIT(5)
 423 #define CFG_MC_FILTER_EN        BIT(6)
 424 #define CFG_MC_ADDR0_EN         BIT(7)
 425 #define CFG_MC_ADDR1_EN         BIT(8)
 426 #define CFG_BC_REJECT_EN        BIT(9)
 427 #define CFG_SSID_FILTER_EN      BIT(10)
 428 #define CFG_RX_INT_FCS_ERROR    BIT(11)
 429 #define CFG_RX_INT_ENCRYPTED    BIT(12)
 430 #define CFG_RX_WR_RX_STATUS     BIT(13)
 431 #define CFG_RX_FILTER_NULTI     BIT(14)
 432 #define CFG_RX_RESERVE          BIT(15)
 433 #define CFG_RX_TIMESTAMP_TSF    BIT(16)
 434
 435 #define CFG_RX_RSV_EN           BIT(0)
 436 #define CFG_RX_RCTS_ACK         BIT(1)
 437 #define CFG_RX_PRSP_EN          BIT(2)
 438 #define CFG_RX_PREQ_EN          BIT(3)
 439 #define CFG_RX_MGMT_EN          BIT(4)
 440 #define CFG_RX_FCS_ERROR        BIT(5)
 441 #define CFG_RX_DATA_EN          BIT(6)
 442 #define CFG_RX_CTL_EN           BIT(7)
 443 #define CFG_RX_CF_EN            BIT(8)
 444 #define CFG_RX_BCN_EN           BIT(9)
 445 #define CFG_RX_AUTH_EN          BIT(10)
 446 #define CFG_RX_ASSOC_EN         BIT(11)
 447
 448 #define SCAN_PASSIVE            BIT(0)
 449 #define SCAN_5GHZ_BAND          BIT(1)
 450 #define SCAN_TRIGGERED          BIT(2)
 451 #define SCAN_PRIORITY_HIGH      BIT(3)
 452
 453 /* When set, disable HW encryption */
 454 #define DF_ENCRYPTION_DISABLE      0x01
 455 #define DF_SNIFF_MODE_ENABLE       0x80
 456
 457 struct acx_feature_config {
 458         struct acx_header header;
 459
 460         __le32 options;
 461         __le32 data_flow_options;
 462 } __packed;
 463
 464 struct acx_current_tx_power {
 465         struct acx_header header;
 466
 467         u8  current_tx_power;
 468         u8  padding[3];
 469 } __packed;
 470
 471 struct acx_wake_up_condition {
 472         struct acx_header header;
 473
 474         u8 wake_up_event; /* Only one bit can be set */
 475         u8 listen_interval;
 476         u8 pad[2];
 477 } __packed;
 478
 479 struct acx_aid {
 480         struct acx_header header;
 481
 482         /*
 483          * To be set when associated with an AP.
 484          */
 485         __le16 aid;
 486         u8 pad[2];
 487 } __packed;
 488
 489 enum acx_preamble_type {
 490         ACX_PREAMBLE_LONG = 0,
 491         ACX_PREAMBLE_SHORT = 1
 492 };
 493
 494 struct acx_preamble {
 495         struct acx_header header;
 496
 497         /*
 498          * When set, the WiLink transmits the frames with a short preamble and
 499          * when cleared, the WiLink transmits the frames with a long preamble.
 500          */
 501         u8 preamble;
 502         u8 padding[3];
 503 } __packed;
 504
 505 enum acx_ctsprotect_type {
 506         CTSPROTECT_DISABLE = 0,
 507         CTSPROTECT_ENABLE = 1
 508 };
 509
 510 struct acx_ctsprotect {
 511         struct acx_header header;
 512         u8 ctsprotect;
 513         u8 padding[3];
 514 } __packed;
 515
 516 struct acx_tx_statistics {
 517         __le32 internal_desc_overflow;
 518 }  __packed;
 519
 520 struct acx_rx_statistics {
 521         __le32 out_of_mem;
 522         __le32 hdr_overflow;
 523         __le32 hw_stuck;
 524         __le32 dropped;
 525         __le32 fcs_err;
 526         __le32 xfr_hint_trig;
 527         __le32 path_reset;
 528         __le32 reset_counter;
 529 } __packed;
 530
 531 struct acx_dma_statistics {
 532         __le32 rx_requested;
 533         __le32 rx_errors;
 534         __le32 tx_requested;
 535         __le32 tx_errors;
 536 }  __packed;
 537
 538 struct acx_isr_statistics {
 539         /* host command complete */
 540         __le32 cmd_cmplt;
 541
 542         /* fiqisr() */
 543         __le32 fiqs;
 544
 545         /* (INT_STS_ND & INT_TRIG_RX_HEADER) */
 546         __le32 rx_headers;
 547
 548         /* (INT_STS_ND & INT_TRIG_RX_CMPLT) */
 549         __le32 rx_completes;
 550
 551         /* (INT_STS_ND & INT_TRIG_NO_RX_BUF) */
 552         __le32 rx_mem_overflow;
 553
 554         /* (INT_STS_ND & INT_TRIG_S_RX_RDY) */
 555         __le32 rx_rdys;
 556
 557         /* irqisr() */
 558         __le32 irqs;
 559
 560         /* (INT_STS_ND & INT_TRIG_TX_PROC) */
 561         __le32 tx_procs;
 562
 563         /* (INT_STS_ND & INT_TRIG_DECRYPT_DONE) */
 564         __le32 decrypt_done;
 565
 566         /* (INT_STS_ND & INT_TRIG_DMA0) */
 567         __le32 dma0_done;
 568
 569         /* (INT_STS_ND & INT_TRIG_DMA1) */
 570         __le32 dma1_done;
 571
 572         /* (INT_STS_ND & INT_TRIG_TX_EXC_CMPLT) */
 573         __le32 tx_exch_complete;
 574
 575         /* (INT_STS_ND & INT_TRIG_COMMAND) */
 576         __le32 commands;
 577
 578         /* (INT_STS_ND & INT_TRIG_RX_PROC) */
 579         __le32 rx_procs;
 580
 581         /* (INT_STS_ND & INT_TRIG_PM_802) */
 582         __le32 hw_pm_mode_changes;
 583
 584         /* (INT_STS_ND & INT_TRIG_ACKNOWLEDGE) */
 585         __le32 host_acknowledges;
 586
 587         /* (INT_STS_ND & INT_TRIG_PM_PCI) */
 588         __le32 pci_pm;
 589
 590         /* (INT_STS_ND & INT_TRIG_ACM_WAKEUP) */
 591         __le32 wakeups;
 592
 593         /* (INT_STS_ND & INT_TRIG_LOW_RSSI) */
 594         __le32 low_rssi;
 595 } __packed;
 596
 597 struct acx_wep_statistics {
 598         /* WEP address keys configured */
 599         __le32 addr_key_count;
 600
 601         /* default keys configured */
 602         __le32 default_key_count;
 603
 604         __le32 reserved;
 605
 606         /* number of times that WEP key not found on lookup */
 607         __le32 key_not_found;
 608
 609         /* number of times that WEP key decryption failed */
 610         __le32 decrypt_fail;
 611
 612         /* WEP packets decrypted */
 613         __le32 packets;
 614
 615         /* WEP decrypt interrupts */
 616         __le32 interrupt;
 617 } __packed;
 618
 619 #define ACX_MISSED_BEACONS_SPREAD 10
 620
 621 struct acx_pwr_statistics {
 622         /* the amount of enters into power save mode (both PD & ELP) */
 623         __le32 ps_enter;
 624
 625         /* the amount of enters into ELP mode */
 626         __le32 elp_enter;
 627
 628         /* the amount of missing beacon interrupts to the host */
 629         __le32 missing_bcns;
 630
 631         /* the amount of wake on host-access times */
 632         __le32 wake_on_host;
 633
 634         /* the amount of wake on timer-expire */
 635         __le32 wake_on_timer_exp;
 636
 637         /* the number of packets that were transmitted with PS bit set */
 638         __le32 tx_with_ps;
 639
 640         /* the number of packets that were transmitted with PS bit clear */
 641         __le32 tx_without_ps;
 642
 643         /* the number of received beacons */
 644         __le32 rcvd_beacons;
 645
 646         /* the number of entering into PowerOn (power save off) */
 647         __le32 power_save_off;
 648
 649         /* the number of entries into power save mode */
 650         __le16 enable_ps;
 651
 652         /*
 653          * the number of exits from power save, not including failed PS
 654          * transitions
 655          */
 656         __le16 disable_ps;
 657
 658         /*
 659          * the number of times the TSF counter was adjusted because
 660          * of drift
 661          */
 662         __le32 fix_tsf_ps;
 663
 664         /* Gives statistics about the spread continuous missed beacons.
 665          * The 16 LSB are dedicated for the PS mode.
 666          * The 16 MSB are dedicated for the PS mode.
 667          * cont_miss_bcns_spread[0] - single missed beacon.
 668          * cont_miss_bcns_spread[1] - two continuous missed beacons.
 669          * cont_miss_bcns_spread[2] - three continuous missed beacons.
 670          * ...
 671          * cont_miss_bcns_spread[9] - ten and more continuous missed beacons.
 672         */
 673         __le32 cont_miss_bcns_spread[ACX_MISSED_BEACONS_SPREAD];
 674
 675         /* the number of beacons in awake mode */
 676         __le32 rcvd_awake_beacons;
 677 } __packed;
 678
 679 struct acx_mic_statistics {
 680         __le32 rx_pkts;
 681         __le32 calc_failure;
 682 } __packed;
 683
 684 struct acx_aes_statistics {
 685         __le32 encrypt_fail;
 686         __le32 decrypt_fail;
 687         __le32 encrypt_packets;
 688         __le32 decrypt_packets;
 689         __le32 encrypt_interrupt;
 690         __le32 decrypt_interrupt;
 691 } __packed;
 692
 693 struct acx_event_statistics {
 694         __le32 heart_beat;
 695         __le32 calibration;
 696         __le32 rx_mismatch;
 697         __le32 rx_mem_empty;
 698         __le32 rx_pool;
 699         __le32 oom_late;
 700         __le32 phy_transmit_error;
 701         __le32 tx_stuck;
 702 } __packed;
 703
 704 struct acx_ps_statistics {
 705         __le32 pspoll_timeouts;
 706         __le32 upsd_timeouts;
 707         __le32 upsd_max_sptime;
 708         __le32 upsd_max_apturn;
 709         __le32 pspoll_max_apturn;
 710         __le32 pspoll_utilization;
 711         __le32 upsd_utilization;
 712 } __packed;
 713
 714 struct acx_rxpipe_statistics {
 715         __le32 rx_prep_beacon_drop;
 716         __le32 descr_host_int_trig_rx_data;
 717         __le32 beacon_buffer_thres_host_int_trig_rx_data;
 718         __le32 missed_beacon_host_int_trig_rx_data;
 719         __le32 tx_xfr_host_int_trig_rx_data;
 720 } __packed;
 721
 722 struct acx_statistics {
 723         struct acx_header header;
 724
 725         struct acx_tx_statistics tx;
 726         struct acx_rx_statistics rx;
 727         struct acx_dma_statistics dma;
 728         struct acx_isr_statistics isr;
 729         struct acx_wep_statistics wep;
 730         struct acx_pwr_statistics pwr;
 731         struct acx_aes_statistics aes;
 732         struct acx_mic_statistics mic;
 733         struct acx_event_statistics event;
 734         struct acx_ps_statistics ps;
 735         struct acx_rxpipe_statistics rxpipe;
 736 } __packed;
 737
 738 struct acx_rate_class {
 739         __le32 enabled_rates;
 740         u8 short_retry_limit;
 741         u8 long_retry_limit;
 742         u8 aflags;
 743         u8 reserved;
 744 };
 745
 746 #define ACX_TX_BASIC_RATE      0
 747 #define ACX_TX_AP_FULL_RATE    1
 748 #define ACX_TX_RATE_POLICY_CNT 2
 749 struct acx_rate_policy {
 750         struct acx_header header;
 751
 752         __le32 rate_class_cnt;
 753         struct acx_rate_class rate_class[CONF_TX_MAX_RATE_CLASSES];
 754 } __packed;
 755
 756 struct acx_ac_cfg {
 757         struct acx_header header;
 758         u8 ac;
 759         u8 cw_min;
 760         __le16 cw_max;
 761         u8 aifsn;
 762         u8 reserved;
 763         __le16 tx_op_limit;
 764 } __packed;
 765
 766 struct acx_tid_config {
 767         struct acx_header header;
 768         u8 queue_id;
 769         u8 channel_type;
 770         u8 tsid;
 771         u8 ps_scheme;
 772         u8 ack_policy;
 773         u8 padding[3];
 774         __le32 apsd_conf[2];
 775 } __packed;
 776
 777 struct acx_frag_threshold {
 778         struct acx_header header;
 779         __le16 frag_threshold;
 780         u8 padding[2];
 781 } __packed;
 782
 783 struct acx_tx_config_options {
 784         struct acx_header header;
 785         __le16 tx_compl_timeout;     /* msec */
 786         __le16 tx_compl_threshold;   /* number of packets */
 787 } __packed;
 788
 789 #define ACX_RX_MEM_BLOCKS     70
 790 #define ACX_TX_MIN_MEM_BLOCKS 40
 791 #define ACX_TX_DESCRIPTORS    32
 792 #define ACX_NUM_SSID_PROFILES 1
 793
 794 struct wl1271_acx_config_memory {
 795         struct acx_header header;
 796
 797         u8 rx_mem_block_num;
 798         u8 tx_min_mem_block_num;
 799         u8 num_stations;
 800         u8 num_ssid_profiles;
 801         __le32 total_tx_descriptors;
 802 } __packed;
 803
 804 struct wl1271_acx_mem_map {
 805         struct acx_header header;
 806
 807         __le32 code_start;
 808         __le32 code_end;
 809
 810         __le32 wep_defkey_start;
 811         __le32 wep_defkey_end;
 812
 813         __le32 sta_table_start;
 814         __le32 sta_table_end;
 815
 816         __le32 packet_template_start;
 817         __le32 packet_template_end;
 818
 819         /* Address of the TX result interface (control block) */
 820         __le32 tx_result;
 821         __le32 tx_result_queue_start;
 822
 823         __le32 queue_memory_start;
 824         __le32 queue_memory_end;
 825
 826         __le32 packet_memory_pool_start;
 827         __le32 packet_memory_pool_end;
 828
 829         __le32 debug_buffer1_start;
 830         __le32 debug_buffer1_end;
 831
 832         __le32 debug_buffer2_start;
 833         __le32 debug_buffer2_end;
 834
 835         /* Number of blocks FW allocated for TX packets */
 836         __le32 num_tx_mem_blocks;
 837
 838         /* Number of blocks FW allocated for RX packets */
 839         __le32 num_rx_mem_blocks;
 840
 841         /* the following 4 fields are valid in SLAVE mode only */
 842         u8 *tx_cbuf;
 843         u8 *rx_cbuf;
 844         __le32 rx_ctrl;
 845         __le32 tx_ctrl;
 846 } __packed;
 847
 848 struct wl1271_acx_rx_config_opt {
 849         struct acx_header header;
 850
 851         __le16 mblk_threshold;
 852         __le16 threshold;
 853         __le16 timeout;
 854         u8 queue_type;
 855         u8 reserved;
 856 } __packed;
 857
 858
 859 struct wl1271_acx_bet_enable {
 860         struct acx_header header;
 861
 862         u8 enable;
 863         u8 max_consecutive;
 864         u8 padding[2];
 865 } __packed;
 866
 867 #define ACX_IPV4_VERSION 4
 868 #define ACX_IPV6_VERSION 6
 869 #define ACX_IPV4_ADDR_SIZE 4
 870 struct wl1271_acx_arp_filter {
 871         struct acx_header header;
 872         u8 version;         /* ACX_IPV4_VERSION, ACX_IPV6_VERSION */
 873         u8 enable;          /* 1 to enable ARP filtering, 0 to disable */
 874         u8 padding[2];
 875         u8 address[16];     /* The configured device IP address - all ARP
 876                                requests directed to this IP address will pass
 877                                through. For IPv4, the first four bytes are
 878                                used. */
 879 } __packed;
 880
 881 struct wl1271_acx_pm_config {
 882         struct acx_header header;
 883
 884         __le32 host_clk_settling_time;
 885         u8 host_fast_wakeup_support;
 886         u8 padding[3];
 887 } __packed;
 888
 889 struct wl1271_acx_keep_alive_mode {
 890         struct acx_header header;
 891
 892         u8 enabled;
 893         u8 padding[3];
 894 } __packed;
 895
 896 enum {
 897         ACX_KEEP_ALIVE_NO_TX = 0,
 898         ACX_KEEP_ALIVE_PERIOD_ONLY
 899 };
 900
 901 enum {
 902         ACX_KEEP_ALIVE_TPL_INVALID = 0,
 903         ACX_KEEP_ALIVE_TPL_VALID
 904 };
 905
 906 struct wl1271_acx_keep_alive_config {
 907         struct acx_header header;
 908
 909         __le32 period;
 910         u8 index;
 911         u8 tpl_validation;
 912         u8 trigger;
 913         u8 padding;
 914 } __packed;
 915
 916 enum {
 917         WL1271_ACX_TRIG_TYPE_LEVEL = 0,
 918         WL1271_ACX_TRIG_TYPE_EDGE,
 919 };
 920
 921 enum {
 922         WL1271_ACX_TRIG_DIR_LOW = 0,
 923         WL1271_ACX_TRIG_DIR_HIGH,
 924         WL1271_ACX_TRIG_DIR_BIDIR,
 925 };
 926
 927 enum {
 928         WL1271_ACX_TRIG_ENABLE = 1,
 929         WL1271_ACX_TRIG_DISABLE,
 930 };
 931
 932 enum {
 933         WL1271_ACX_TRIG_METRIC_RSSI_BEACON = 0,
 934         WL1271_ACX_TRIG_METRIC_RSSI_DATA,
 935         WL1271_ACX_TRIG_METRIC_SNR_BEACON,
 936         WL1271_ACX_TRIG_METRIC_SNR_DATA,
 937 };
 938
 939 enum {
 940         WL1271_ACX_TRIG_IDX_RSSI = 0,
 941         WL1271_ACX_TRIG_COUNT = 8,
 942 };
 943
 944 struct wl1271_acx_rssi_snr_trigger {
 945         struct acx_header header;
 946
 947         __le16 threshold;
 948         __le16 pacing; /* 0 - 60000 ms */
 949         u8 metric;
 950         u8 type;
 951         u8 dir;
 952         u8 hysteresis;
 953         u8 index;
 954         u8 enable;
 955         u8 padding[2];
 956 };
 957
 958 struct wl1271_acx_rssi_snr_avg_weights {
 959         struct acx_header header;
 960
 961         u8 rssi_beacon;
 962         u8 rssi_data;
 963         u8 snr_beacon;
 964         u8 snr_data;
 965 };
 966
 967 /*
 968  * ACX_PEER_HT_CAP
 969  * Configure HT capabilities - declare the capabilities of the peer
 970  * we are connected to.
 971  */
 972 struct wl1271_acx_ht_capabilities {
 973         struct acx_header header;
 974
 975         /*
 976          * bit 0 - Allow HT Operation
 977          * bit 1 - Allow Greenfield format in TX
 978          * bit 2 - Allow Short GI in TX
 979          * bit 3 - Allow L-SIG TXOP Protection in TX
 980          * bit 4 - Allow HT Control fields in TX.
 981          *         Note, driver will still leave space for HT control in packets
 982          *         regardless of the value of this field. FW will be responsible
 983          *         to drop the HT field from any frame when this Bit set to 0.
 984          * bit 5 - Allow RD initiation in TXOP. FW is allowed to initate RD.
 985          *         Exact policy setting for this feature is TBD.
 986          *         Note, this bit can only be set to 1 if bit 3 is set to 1.
 987          */
 988         __le32 ht_capabilites;
 989
 990         /*
 991          * Indicates to which peer these capabilities apply.
 992          * For infrastructure use ff:ff:ff:ff:ff:ff that indicates relevance
 993          * for all peers.
 994          * Only valid for IBSS/DLS operation.
 995          */
 996         u8 mac_address[ETH_ALEN];
 997
 998         /*
 999          * This the maximum A-MPDU length supported by the AP. The FW may not
1000          * exceed this length when sending A-MPDUs
1001          */
1002         u8 ampdu_max_length;
1003
1004         /* This is the minimal spacing required when sending A-MPDUs to the AP*/
1005         u8 ampdu_min_spacing;
1006 } __packed;
1007
1008 /* HT Capabilites Fw Bit Mask Mapping */
1009 #define WL1271_ACX_FW_CAP_HT_OPERATION                 BIT(0)
1010 #define WL1271_ACX_FW_CAP_GREENFIELD_FRAME_FORMAT      BIT(1)
1011 #define WL1271_ACX_FW_CAP_SHORT_GI_FOR_20MHZ_PACKETS   BIT(2)
1012 #define WL1271_ACX_FW_CAP_LSIG_TXOP_PROTECTION         BIT(3)
1013 #define WL1271_ACX_FW_CAP_HT_CONTROL_FIELDS            BIT(4)
1014 #define WL1271_ACX_FW_CAP_RD_INITIATION                BIT(5)
1015
1016
1017 /*
1018  * ACX_HT_BSS_OPERATION
1019  * Configure HT capabilities - AP rules for behavior in the BSS.
1020  */
1021 struct wl1271_acx_ht_information {
1022         struct acx_header header;
1023
1024         /* Values: 0 - RIFS not allowed, 1 - RIFS allowed */
1025         u8 rifs_mode;
1026
1027         /* Values: 0 - 3 like in spec */
1028         u8 ht_protection;
1029
1030         /* Values: 0 - GF protection not required, 1 - GF protection required */
1031         u8 gf_protection;
1032
1033         /*Values: 0 - TX Burst limit not required, 1 - TX Burst Limit required*/
1034         u8 ht_tx_burst_limit;
1035
1036         /*
1037          * Values: 0 - Dual CTS protection not required,
1038          *         1 - Dual CTS Protection required
1039          * Note: When this value is set to 1 FW will protect all TXOP with RTS
1040          * frame and will not use CTS-to-self regardless of the value of the
1041          * ACX_CTS_PROTECTION information element
1042          */
1043         u8 dual_cts_protection;
1044
1045         u8 padding[3];
1046 } __packed;
1047
1048 struct wl1271_acx_fw_tsf_information {
1049         struct acx_header header;
1050
1051         __le32 current_tsf_high;
1052         __le32 current_tsf_low;
1053         __le32 last_bttt_high;
1054         __le32 last_tbtt_low;
1055         u8 last_dtim_count;
1056         u8 padding[3];
1057 } __packed;
1058
1059 enum {
1060         ACX_WAKE_UP_CONDITIONS      = 0x0002,
1061         ACX_MEM_CFG                 = 0x0003,
1062         ACX_SLOT                    = 0x0004,
1063         ACX_AC_CFG                  = 0x0007,
1064         ACX_MEM_MAP                 = 0x0008,
1065         ACX_AID                     = 0x000A,
1066         /* ACX_FW_REV is missing in the ref driver, but seems to work */
1067         ACX_FW_REV                  = 0x000D,
1068         ACX_MEDIUM_USAGE            = 0x000F,
1069         ACX_RX_CFG                  = 0x0010,
1070         ACX_TX_QUEUE_CFG            = 0x0011, /* FIXME: only used by wl1251 */
1071         ACX_STATISTICS              = 0x0013, /* Debug API */
1072         ACX_PWR_CONSUMPTION_STATISTICS = 0x0014,
1073         ACX_FEATURE_CFG             = 0x0015,
1074         ACX_TID_CFG                 = 0x001A,
1075         ACX_PS_RX_STREAMING         = 0x001B,
1076         ACX_BEACON_FILTER_OPT       = 0x001F,
1077         ACX_NOISE_HIST              = 0x0021,
1078         ACX_HDK_VERSION             = 0x0022, /* ??? */
1079         ACX_PD_THRESHOLD            = 0x0023,
1080         ACX_TX_CONFIG_OPT           = 0x0024,
1081         ACX_CCA_THRESHOLD           = 0x0025,
1082         ACX_EVENT_MBOX_MASK         = 0x0026,
1083         ACX_CONN_MONIT_PARAMS       = 0x002D,
1084         ACX_CONS_TX_FAILURE         = 0x002F,
1085         ACX_BCN_DTIM_OPTIONS        = 0x0031,
1086         ACX_SG_ENABLE               = 0x0032,
1087         ACX_SG_CFG                  = 0x0033,
1088         ACX_BEACON_FILTER_TABLE     = 0x0038,
1089         ACX_ARP_IP_FILTER           = 0x0039,
1090         ACX_ROAMING_STATISTICS_TBL  = 0x003B,
1091         ACX_RATE_POLICY             = 0x003D,
1092         ACX_CTS_PROTECTION          = 0x003E,
1093         ACX_SLEEP_AUTH              = 0x003F,
1094         ACX_PREAMBLE_TYPE           = 0x0040,
1095         ACX_ERROR_CNT               = 0x0041,
1096         ACX_IBSS_FILTER             = 0x0044,
1097         ACX_SERVICE_PERIOD_TIMEOUT  = 0x0045,
1098         ACX_TSF_INFO                = 0x0046,
1099         ACX_CONFIG_PS_WMM           = 0x0049,
1100         ACX_ENABLE_RX_DATA_FILTER   = 0x004A,
1101         ACX_SET_RX_DATA_FILTER      = 0x004B,
1102         ACX_GET_DATA_FILTER_STATISTICS = 0x004C,
1103         ACX_RX_CONFIG_OPT           = 0x004E,
1104         ACX_FRAG_CFG                = 0x004F,
1105         ACX_BET_ENABLE              = 0x0050,
1106         ACX_RSSI_SNR_TRIGGER        = 0x0051,
1107         ACX_RSSI_SNR_WEIGHTS        = 0x0052,
1108         ACX_KEEP_ALIVE_MODE         = 0x0053,
1109         ACX_SET_KEEP_ALIVE_CONFIG   = 0x0054,
1110         ACX_BA_SESSION_RESPONDER_POLICY = 0x0055,
1111         ACX_BA_SESSION_INITIATOR_POLICY = 0x0056,
1112         ACX_PEER_HT_CAP             = 0x0057,
1113         ACX_HT_BSS_OPERATION        = 0x0058,
1114         ACX_COEX_ACTIVITY           = 0x0059,
1115         ACX_SET_DCO_ITRIM_PARAMS    = 0x0061,
1116         DOT11_RX_MSDU_LIFE_TIME     = 0x1004,
1117         DOT11_CUR_TX_PWR            = 0x100D,
1118         DOT11_RX_DOT11_MODE         = 0x1012,
1119         DOT11_RTS_THRESHOLD         = 0x1013,
1120         DOT11_GROUP_ADDRESS_TBL     = 0x1014,
1121         ACX_PM_CONFIG               = 0x1016,
1122
1123         MAX_DOT11_IE = DOT11_GROUP_ADDRESS_TBL,
1124
1125         MAX_IE = 0xFFFF
1126 };
1127
1128
1129 int wl1271_acx_wake_up_conditions(struct wl1271 *wl);
1130 int wl1271_acx_sleep_auth(struct wl1271 *wl, u8 sleep_auth);
1131 int wl1271_acx_tx_power(struct wl1271 *wl, int power);
1132 int wl1271_acx_feature_cfg(struct wl1271 *wl);
1133 int wl1271_acx_mem_map(struct wl1271 *wl,
1134                        struct acx_header *mem_map, size_t len);
1135 int wl1271_acx_rx_msdu_life_time(struct wl1271 *wl);
1136 int wl1271_acx_rx_config(struct wl1271 *wl, u32 config, u32 filter);
1137 int wl1271_acx_pd_threshold(struct wl1271 *wl);
1138 int wl1271_acx_slot(struct wl1271 *wl, enum acx_slot_type slot_time);
1139 int wl1271_acx_group_address_tbl(struct wl1271 *wl, bool enable,
1140                                  void *mc_list, u32 mc_list_len);
1141 int wl1271_acx_service_period_timeout(struct wl1271 *wl);
1142 int wl1271_acx_rts_threshold(struct wl1271 *wl, u16 rts_threshold);
1143 int wl1271_acx_dco_itrim_params(struct wl1271 *wl);
1144 int wl1271_acx_beacon_filter_opt(struct wl1271 *wl, bool enable_filter);
1145 int wl1271_acx_beacon_filter_table(struct wl1271 *wl);
1146 int wl1271_acx_conn_monit_params(struct wl1271 *wl, bool enable);
1147 int wl1271_acx_sg_enable(struct wl1271 *wl, bool enable);
1148 int wl1271_acx_sg_cfg(struct wl1271 *wl);
1149 int wl1271_acx_cca_threshold(struct wl1271 *wl);
1150 int wl1271_acx_bcn_dtim_options(struct wl1271 *wl);
1151 int wl1271_acx_aid(struct wl1271 *wl, u16 aid);
1152 int wl1271_acx_event_mbox_mask(struct wl1271 *wl, u32 event_mask);
1153 int wl1271_acx_set_preamble(struct wl1271 *wl, enum acx_preamble_type preamble);
1154 int wl1271_acx_cts_protect(struct wl1271 *wl,
1155                            enum acx_ctsprotect_type ctsprotect);
1156 int wl1271_acx_statistics(struct wl1271 *wl, struct acx_statistics *stats);
1157 int wl1271_acx_rate_policies(struct wl1271 *wl);
1158 int wl1271_acx_ac_cfg(struct wl1271 *wl, u8 ac, u8 cw_min, u16 cw_max,
1159                       u8 aifsn, u16 txop);
1160 int wl1271_acx_tid_cfg(struct wl1271 *wl, u8 queue_id, u8 channel_type,
1161                        u8 tsid, u8 ps_scheme, u8 ack_policy,
1162                        u32 apsd_conf0, u32 apsd_conf1);
1163 int wl1271_acx_frag_threshold(struct wl1271 *wl);
1164 int wl1271_acx_tx_config_options(struct wl1271 *wl);
1165 int wl1271_acx_mem_cfg(struct wl1271 *wl);
1166 int wl1271_acx_init_mem_config(struct wl1271 *wl);
1167 int wl1271_acx_init_rx_interrupt(struct wl1271 *wl);
1168 int wl1271_acx_smart_reflex(struct wl1271 *wl);
1169 int wl1271_acx_bet_enable(struct wl1271 *wl, bool enable);
1170 int wl1271_acx_arp_ip_filter(struct wl1271 *wl, bool enable, __be32 address);
1171 int wl1271_acx_pm_config(struct wl1271 *wl);
1172 int wl1271_acx_keep_alive_mode(struct wl1271 *wl, bool enable);
1173 int wl1271_acx_keep_alive_config(struct wl1271 *wl, u8 index, u8 tpl_valid);
1174 int wl1271_acx_rssi_snr_trigger(struct wl1271 *wl, bool enable,
1175                                 s16 thold, u8 hyst);
1176 int wl1271_acx_rssi_snr_avg_weights(struct wl1271 *wl);
1177 int wl1271_acx_set_ht_capabilities(struct wl1271 *wl,
1178                                     struct ieee80211_sta_ht_cap *ht_cap,
1179                                     bool allow_ht_operation);
1180 int wl1271_acx_set_ht_information(struct wl1271 *wl,
1181                                    u16 ht_operation_mode);
1182 int wl1271_acx_tsf_info(struct wl1271 *wl, u64 *mactime);
1183
1184 #endif /* __WL1271_ACX_H__ */