drivers/net/wireless/wl12xx/wl12xx.h

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
   5  * Copyright (C) 2008-2009 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 __WL12XX_H__
  26 #define __WL12XX_H__
  27
  28 #include <linux/mutex.h>
  29 #include <linux/completion.h>
  30 #include <linux/spinlock.h>
  31 #include <linux/list.h>
  32 #include <linux/bitops.h>
  33 #include <net/mac80211.h>
  34
  35 #include "conf.h"
  36 #include "ini.h"
  37
  38 #define DRIVER_NAME "wl1271"
  39 #define DRIVER_PREFIX DRIVER_NAME ": "
  40
  41 /*
  42  * FW versions support BA 11n
  43  * versions marks x.x.x.50-60.x
  44  */
  45 #define WL12XX_BA_SUPPORT_FW_COST_VER2_START    50
  46 #define WL12XX_BA_SUPPORT_FW_COST_VER2_END      60
  47
  48 enum {
  49         DEBUG_NONE      = 0,
  50         DEBUG_IRQ       = BIT(0),
  51         DEBUG_SPI       = BIT(1),
  52         DEBUG_BOOT      = BIT(2),
  53         DEBUG_MAILBOX   = BIT(3),
  54         DEBUG_TESTMODE  = BIT(4),
  55         DEBUG_EVENT     = BIT(5),
  56         DEBUG_TX        = BIT(6),
  57         DEBUG_RX        = BIT(7),
  58         DEBUG_SCAN      = BIT(8),
  59         DEBUG_CRYPT     = BIT(9),
  60         DEBUG_PSM       = BIT(10),
  61         DEBUG_MAC80211  = BIT(11),
  62         DEBUG_CMD       = BIT(12),
  63         DEBUG_ACX       = BIT(13),
  64         DEBUG_SDIO      = BIT(14),
  65         DEBUG_FILTERS   = BIT(15),
  66         DEBUG_ADHOC     = BIT(16),
  67         DEBUG_AP        = BIT(17),
  68         DEBUG_MASTER    = (DEBUG_ADHOC | DEBUG_AP),
  69         DEBUG_ALL       = ~0,
  70 };
  71
  72 extern u32 wl12xx_debug_level;
  73
  74 #define DEBUG_DUMP_LIMIT 1024
  75
  76 #define wl1271_error(fmt, arg...) \
  77         pr_err(DRIVER_PREFIX "ERROR " fmt "\n", ##arg)
  78
  79 #define wl1271_warning(fmt, arg...) \
  80         pr_warning(DRIVER_PREFIX "WARNING " fmt "\n", ##arg)
  81
  82 #define wl1271_notice(fmt, arg...) \
  83         pr_info(DRIVER_PREFIX fmt "\n", ##arg)
  84
  85 #define wl1271_info(fmt, arg...) \
  86         pr_info(DRIVER_PREFIX fmt "\n", ##arg)
  87
  88 #define wl1271_debug(level, fmt, arg...) \
  89         do { \
  90                 if (level & wl12xx_debug_level) \
  91                         pr_debug(DRIVER_PREFIX fmt "\n", ##arg); \
  92         } while (0)
  93
  94 /* TODO: use pr_debug_hex_dump when it will be available */
  95 #define wl1271_dump(level, prefix, buf, len)    \
  96         do { \
  97                 if (level & wl12xx_debug_level) \
  98                         print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
  99                                        DUMP_PREFIX_OFFSET, 16, 1,       \
 100                                        buf,                             \
 101                                        min_t(size_t, len, DEBUG_DUMP_LIMIT), \
 102                                        0);                              \
 103         } while (0)
 104
 105 #define wl1271_dump_ascii(level, prefix, buf, len)      \
 106         do { \
 107                 if (level & wl12xx_debug_level) \
 108                         print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
 109                                        DUMP_PREFIX_OFFSET, 16, 1,       \
 110                                        buf,                             \
 111                                        min_t(size_t, len, DEBUG_DUMP_LIMIT), \
 112                                        true);                           \
 113         } while (0)
 114
 115 #define WL1271_DEFAULT_STA_RX_CONFIG (CFG_UNI_FILTER_EN |       \
 116                                   CFG_BSSID_FILTER_EN | \
 117                                   CFG_MC_FILTER_EN)
 118
 119 #define WL1271_DEFAULT_STA_RX_FILTER (CFG_RX_RCTS_ACK | CFG_RX_PRSP_EN |  \
 120                                   CFG_RX_MGMT_EN | CFG_RX_DATA_EN |   \
 121                                   CFG_RX_CTL_EN | CFG_RX_BCN_EN |     \
 122                                   CFG_RX_AUTH_EN | CFG_RX_ASSOC_EN)
 123
 124 #define WL1271_DEFAULT_AP_RX_CONFIG  0
 125
 126 #define WL1271_DEFAULT_AP_RX_FILTER  (CFG_RX_RCTS_ACK | CFG_RX_PREQ_EN | \
 127                                   CFG_RX_MGMT_EN | CFG_RX_DATA_EN | \
 128                                   CFG_RX_CTL_EN | CFG_RX_AUTH_EN | \
 129                                   CFG_RX_ASSOC_EN)
 130
 131
 132
 133 #define WL1271_FW_NAME "ti-connectivity/wl1271-fw-2.bin"
 134 #define WL128X_FW_NAME "ti-connectivity/wl128x-fw.bin"
 135 #define WL127X_AP_FW_NAME "ti-connectivity/wl1271-fw-ap.bin"
 136 #define WL128X_AP_FW_NAME "ti-connectivity/wl128x-fw-ap.bin"
 137
 138 /*
 139  * wl127x and wl128x are using the same NVS file name. However, the
 140  * ini parameters between them are different.  The driver validates
 141  * the correct NVS size in wl1271_boot_upload_nvs().
 142  */
 143 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
 144
 145 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
 146 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
 147
 148 #define WL1271_CIPHER_SUITE_GEM 0x00147201
 149
 150 #define WL1271_BUSY_WORD_CNT 1
 151 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
 152
 153 #define WL1271_ELP_HW_STATE_ASLEEP 0
 154 #define WL1271_ELP_HW_STATE_IRQ    1
 155
 156 #define WL1271_DEFAULT_BEACON_INT  100
 157 #define WL1271_DEFAULT_DTIM_PERIOD 1
 158
 159 #define WL1271_AP_GLOBAL_HLID      0
 160 #define WL1271_AP_BROADCAST_HLID   1
 161 #define WL1271_AP_STA_HLID_START   2
 162
 163 /*
 164  * When in AP-mode, we allow (at least) this number of mem-blocks
 165  * to be transmitted to FW for a STA in PS-mode. Only when packets are
 166  * present in the FW buffers it will wake the sleeping STA. We want to put
 167  * enough packets for the driver to transmit all of its buffered data before
 168  * the STA goes to sleep again. But we don't want to take too much mem-blocks
 169  * as it might hurt the throughput of active STAs.
 170  * The number of blocks (18) is enough for 2 large packets.
 171  */
 172 #define WL1271_PS_STA_MAX_BLOCKS  (2 * 9)
 173
 174 #define WL1271_AP_BSS_INDEX        0
 175 #define WL1271_AP_DEF_BEACON_EXP   20
 176
 177 #define ACX_TX_DESCRIPTORS         32
 178
 179 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
 180
 181 enum wl1271_state {
 182         WL1271_STATE_OFF,
 183         WL1271_STATE_ON,
 184         WL1271_STATE_PLT,
 185 };
 186
 187 enum wl1271_partition_type {
 188         PART_DOWN,
 189         PART_WORK,
 190         PART_DRPW,
 191
 192         PART_TABLE_LEN
 193 };
 194
 195 struct wl1271_partition {
 196         u32 size;
 197         u32 start;
 198 };
 199
 200 struct wl1271_partition_set {
 201         struct wl1271_partition mem;
 202         struct wl1271_partition reg;
 203         struct wl1271_partition mem2;
 204         struct wl1271_partition mem3;
 205 };
 206
 207 struct wl1271;
 208
 209 enum {
 210         FW_VER_CHIP,
 211         FW_VER_IF_TYPE,
 212         FW_VER_MAJOR,
 213         FW_VER_SUBTYPE,
 214         FW_VER_MINOR,
 215
 216         NUM_FW_VER
 217 };
 218
 219 #define FW_VER_CHIP_WL127X 6
 220 #define FW_VER_CHIP_WL128X 7
 221
 222 #define FW_VER_IF_TYPE_STA 1
 223 #define FW_VER_IF_TYPE_AP  2
 224
 225 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
 226 #define FW_VER_MINOR_1_SPARE_AP_MIN  47
 227
 228 struct wl1271_chip {
 229         u32 id;
 230         char fw_ver_str[ETHTOOL_BUSINFO_LEN];
 231         unsigned int fw_ver[NUM_FW_VER];
 232 };
 233
 234 struct wl1271_stats {
 235         struct acx_statistics *fw_stats;
 236         unsigned long fw_stats_update;
 237
 238         unsigned int retry_count;
 239         unsigned int excessive_retries;
 240 };
 241
 242 #define NUM_TX_QUEUES              4
 243 #define NUM_RX_PKT_DESC            8
 244
 245 #define AP_MAX_STATIONS            5
 246
 247 /* Broadcast and Global links + links to stations */
 248 #define AP_MAX_LINKS               (AP_MAX_STATIONS + 2)
 249
 250 /* FW status registers common for AP/STA */
 251 struct wl1271_fw_common_status {
 252         __le32 intr;
 253         u8  fw_rx_counter;
 254         u8  drv_rx_counter;
 255         u8  reserved;
 256         u8  tx_results_counter;
 257         __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
 258         __le32 tx_released_blks[NUM_TX_QUEUES];
 259         __le32 fw_localtime;
 260 } __packed;
 261
 262 /* FW status registers for AP */
 263 struct wl1271_fw_ap_status {
 264         struct wl1271_fw_common_status common;
 265
 266         /* Next fields valid only in AP FW */
 267
 268         /*
 269          * A bitmap (where each bit represents a single HLID)
 270          * to indicate if the station is in PS mode.
 271          */
 272         __le32 link_ps_bitmap;
 273
 274         /* Number of freed MBs per HLID */
 275         u8 tx_lnk_free_blks[AP_MAX_LINKS];
 276         u8 padding_1[1];
 277 } __packed;
 278
 279 /* FW status registers for STA */
 280 struct wl1271_fw_sta_status {
 281         struct wl1271_fw_common_status common;
 282
 283         u8  tx_total;
 284         u8  reserved1;
 285         __le16 reserved2;
 286         /* Total structure size is 68 bytes */
 287         u32 padding;
 288 } __packed;
 289
 290 struct wl1271_fw_full_status {
 291         union {
 292                 struct wl1271_fw_common_status common;
 293                 struct wl1271_fw_sta_status sta;
 294                 struct wl1271_fw_ap_status ap;
 295         };
 296 } __packed;
 297
 298
 299 struct wl1271_rx_mem_pool_addr {
 300         u32 addr;
 301         u32 addr_extra;
 302 };
 303
 304 #define WL1271_MAX_CHANNELS 64
 305 struct wl1271_scan {
 306         struct cfg80211_scan_request *req;
 307         unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
 308         bool failed;
 309         u8 state;
 310         u8 ssid[IW_ESSID_MAX_SIZE+1];
 311         size_t ssid_len;
 312 };
 313
 314 struct wl1271_if_operations {
 315         void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
 316                      bool fixed);
 317         void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
 318                      bool fixed);
 319         void (*reset)(struct wl1271 *wl);
 320         void (*init)(struct wl1271 *wl);
 321         int (*power)(struct wl1271 *wl, bool enable);
 322         struct device* (*dev)(struct wl1271 *wl);
 323         void (*enable_irq)(struct wl1271 *wl);
 324         void (*disable_irq)(struct wl1271 *wl);
 325         void (*set_block_size) (struct wl1271 *wl, unsigned int blksz);
 326 };
 327
 328 #define MAX_NUM_KEYS 14
 329 #define MAX_KEY_SIZE 32
 330
 331 struct wl1271_ap_key {
 332         u8 id;
 333         u8 key_type;
 334         u8 key_size;
 335         u8 key[MAX_KEY_SIZE];
 336         u8 hlid;
 337         u32 tx_seq_32;
 338         u16 tx_seq_16;
 339 };
 340
 341 enum wl12xx_flags {
 342         WL1271_FLAG_STA_ASSOCIATED,
 343         WL1271_FLAG_JOINED,
 344         WL1271_FLAG_GPIO_POWER,
 345         WL1271_FLAG_TX_QUEUE_STOPPED,
 346         WL1271_FLAG_TX_PENDING,
 347         WL1271_FLAG_IN_ELP,
 348         WL1271_FLAG_PSM,
 349         WL1271_FLAG_PSM_REQUESTED,
 350         WL1271_FLAG_IRQ_RUNNING,
 351         WL1271_FLAG_IDLE,
 352         WL1271_FLAG_IDLE_REQUESTED,
 353         WL1271_FLAG_PSPOLL_FAILURE,
 354         WL1271_FLAG_STA_STATE_SENT,
 355         WL1271_FLAG_FW_TX_BUSY,
 356         WL1271_FLAG_AP_STARTED,
 357         WL1271_FLAG_IF_INITIALIZED,
 358         WL1271_FLAG_DUMMY_PACKET_PENDING,
 359 };
 360
 361 struct wl1271_link {
 362         /* AP-mode - TX queue per AC in link */
 363         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 364
 365         /* accounting for allocated / available TX blocks in FW */
 366         u8 allocated_blks;
 367         u8 prev_freed_blks;
 368
 369         u8 addr[ETH_ALEN];
 370 };
 371
 372 struct wl1271 {
 373         struct platform_device *plat_dev;
 374         struct ieee80211_hw *hw;
 375         bool mac80211_registered;
 376
 377         void *if_priv;
 378
 379         struct wl1271_if_operations *if_ops;
 380
 381         void (*set_power)(bool enable);
 382         int irq;
 383         int ref_clock;
 384
 385         spinlock_t wl_lock;
 386
 387         enum wl1271_state state;
 388         struct mutex mutex;
 389
 390         unsigned long flags;
 391
 392         struct wl1271_partition_set part;
 393
 394         struct wl1271_chip chip;
 395
 396         int cmd_box_addr;
 397         int event_box_addr;
 398
 399         u8 *fw;
 400         size_t fw_len;
 401         u8 fw_bss_type;
 402         void *nvs;
 403         size_t nvs_len;
 404
 405         s8 hw_pg_ver;
 406
 407         u8 bssid[ETH_ALEN];
 408         u8 mac_addr[ETH_ALEN];
 409         u8 bss_type;
 410         u8 set_bss_type;
 411         u8 ssid[IW_ESSID_MAX_SIZE + 1];
 412         u8 ssid_len;
 413         int channel;
 414
 415         struct wl1271_acx_mem_map *target_mem_map;
 416
 417         /* Accounting for allocated / available TX blocks on HW */
 418         u32 tx_blocks_freed[NUM_TX_QUEUES];
 419         u32 tx_blocks_available;
 420         u32 tx_allocated_blocks;
 421         u32 tx_results_count;
 422
 423         /* Transmitted TX packets counter for chipset interface */
 424         u32 tx_packets_count;
 425
 426         /* Time-offset between host and chipset clocks */
 427         s64 time_offset;
 428
 429         /* Session counter for the chipset */
 430         int session_counter;
 431
 432         /* Frames scheduled for transmission, not handled yet */
 433         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 434         int tx_queue_count;
 435
 436         /* Frames received, not handled yet by mac80211 */
 437         struct sk_buff_head deferred_rx_queue;
 438
 439         /* Frames sent, not returned yet to mac80211 */
 440         struct sk_buff_head deferred_tx_queue;
 441
 442         struct work_struct tx_work;
 443
 444         /* Pending TX frames */
 445         unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
 446         struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
 447         int tx_frames_cnt;
 448
 449         /* Security sequence number counters */
 450         u8 tx_security_last_seq;
 451         s64 tx_security_seq;
 452
 453         /* FW Rx counter */
 454         u32 rx_counter;
 455
 456         /* Rx memory pool address */
 457         struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
 458
 459         /* Intermediate buffer, used for packet aggregation */
 460         u8 *aggr_buf;
 461
 462         /* Reusable dummy packet template */
 463         struct sk_buff *dummy_packet;
 464
 465         /* Network stack work  */
 466         struct work_struct netstack_work;
 467
 468         /* Hardware recovery work */
 469         struct work_struct recovery_work;
 470
 471         /* The mbox event mask */
 472         u32 event_mask;
 473
 474         /* Mailbox pointers */
 475         u32 mbox_ptr[2];
 476
 477         /* Are we currently scanning */
 478         struct wl1271_scan scan;
 479         struct delayed_work scan_complete_work;
 480
 481         /* probe-req template for the current AP */
 482         struct sk_buff *probereq;
 483
 484         /* Our association ID */
 485         u16 aid;
 486
 487         /*
 488          * currently configured rate set:
 489          *      bits  0-15 - 802.11abg rates
 490          *      bits 16-23 - 802.11n   MCS index mask
 491          * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
 492          */
 493         u32 basic_rate_set;
 494         u32 basic_rate;
 495         u32 rate_set;
 496
 497         /* The current band */
 498         enum ieee80211_band band;
 499
 500         /* Beaconing interval (needed for ad-hoc) */
 501         u32 beacon_int;
 502
 503         /* Default key (for WEP) */
 504         u32 default_key;
 505
 506         unsigned int filters;
 507         unsigned int rx_config;
 508         unsigned int rx_filter;
 509
 510         struct completion *elp_compl;
 511         struct delayed_work elp_work;
 512         struct delayed_work pspoll_work;
 513
 514         /* counter for ps-poll delivery failures */
 515         int ps_poll_failures;
 516
 517         /* retry counter for PSM entries */
 518         u8 psm_entry_retry;
 519
 520         /* in dBm */
 521         int power_level;
 522
 523         int rssi_thold;
 524         int last_rssi_event;
 525
 526         struct wl1271_stats stats;
 527
 528         __le32 buffer_32;
 529         u32 buffer_cmd;
 530         u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
 531
 532         struct wl1271_fw_full_status *fw_status;
 533         struct wl1271_tx_hw_res_if *tx_res_if;
 534
 535         struct ieee80211_vif *vif;
 536
 537         /* Current chipset configuration */
 538         struct conf_drv_settings conf;
 539
 540         bool sg_enabled;
 541
 542         bool enable_11a;
 543
 544         struct list_head list;
 545
 546         /* Most recently reported noise in dBm */
 547         s8 noise;
 548
 549         /* map for HLIDs of associated stations - when operating in AP mode */
 550         unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
 551
 552         /* recoreded keys for AP-mode - set here before AP startup */
 553         struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
 554
 555         /* bands supported by this instance of wl12xx */
 556         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 557
 558         /* RX BA constraint value */
 559         bool ba_support;
 560         u8 ba_rx_bitmap;
 561
 562         int tcxo_clock;
 563
 564         /*
 565          * AP-mode - links indexed by HLID. The global and broadcast links
 566          * are always active.
 567          */
 568         struct wl1271_link links[AP_MAX_LINKS];
 569
 570         /* the hlid of the link where the last transmitted skb came from */
 571         int last_tx_hlid;
 572
 573         /* AP-mode - a bitmap of links currently in PS mode according to FW */
 574         u32 ap_fw_ps_map;
 575
 576         /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
 577         unsigned long ap_ps_map;
 578
 579         /* Quirks of specific hardware revisions */
 580         unsigned int quirks;
 581
 582         /* Platform limitations */
 583         unsigned int platform_quirks;
 584 };
 585
 586 struct wl1271_station {
 587         u8 hlid;
 588 };
 589
 590 int wl1271_plt_start(struct wl1271 *wl);
 591 int wl1271_plt_stop(struct wl1271 *wl);
 592
 593 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 594
 595 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
 596
 597 #define WL1271_DEFAULT_POWER_LEVEL 0
 598
 599 #define WL1271_TX_QUEUE_LOW_WATERMARK  10
 600 #define WL1271_TX_QUEUE_HIGH_WATERMARK 25
 601
 602 #define WL1271_DEFERRED_QUEUE_LIMIT    64
 603
 604 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
 605    on in case is has been shut down shortly before */
 606 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
 607 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
 608
 609 /* Macros to handle wl1271.sta_rate_set */
 610 #define HW_BG_RATES_MASK        0xffff
 611 #define HW_HT_RATES_OFFSET      16
 612
 613 /* Quirks */
 614
 615 /* Each RX/TX transaction requires an end-of-transaction transfer */
 616 #define WL12XX_QUIRK_END_OF_TRANSACTION         BIT(0)
 617
 618 /*
 619  * Older firmwares use 2 spare TX blocks
 620  * (for STA < 6.1.3.50.58 or for AP < 6.2.0.0.47)
 621  */
 622 #define WL12XX_QUIRK_USE_2_SPARE_BLOCKS         BIT(1)
 623
 624 /* WL128X requires aggregated packets to be aligned to the SDIO block size */
 625 #define WL12XX_QUIRK_BLOCKSIZE_ALIGNMENT        BIT(2)
 626
 627 #endif