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 WL127X_FW_NAME "ti-connectivity/wl127x-fw-3.bin"
 116 #define WL128X_FW_NAME "ti-connectivity/wl128x-fw-3.bin"
 117
 118 /*
 119  * wl127x and wl128x are using the same NVS file name. However, the
 120  * ini parameters between them are different.  The driver validates
 121  * the correct NVS size in wl1271_boot_upload_nvs().
 122  */
 123 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
 124
 125 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
 126 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
 127 #define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff
 128
 129 #define WL1271_CIPHER_SUITE_GEM 0x00147201
 130
 131 #define WL1271_BUSY_WORD_CNT 1
 132 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
 133
 134 #define WL1271_ELP_HW_STATE_ASLEEP 0
 135 #define WL1271_ELP_HW_STATE_IRQ    1
 136
 137 #define WL1271_DEFAULT_BEACON_INT  100
 138 #define WL1271_DEFAULT_DTIM_PERIOD 1
 139
 140 #define WL12XX_MAX_LINKS           8
 141 #define WL1271_AP_GLOBAL_HLID      0
 142 #define WL1271_AP_BROADCAST_HLID   1
 143 #define WL1271_AP_STA_HLID_START   2
 144
 145 /*
 146  * When in AP-mode, we allow (at least) this number of mem-blocks
 147  * to be transmitted to FW for a STA in PS-mode. Only when packets are
 148  * present in the FW buffers it will wake the sleeping STA. We want to put
 149  * enough packets for the driver to transmit all of its buffered data before
 150  * the STA goes to sleep again. But we don't want to take too much mem-blocks
 151  * as it might hurt the throughput of active STAs.
 152  * The number of blocks (18) is enough for 2 large packets.
 153  */
 154 #define WL1271_PS_STA_MAX_BLOCKS  (2 * 9)
 155
 156 #define WL1271_AP_BSS_INDEX        0
 157 #define WL1271_AP_DEF_BEACON_EXP   20
 158
 159 #define ACX_TX_DESCRIPTORS         32
 160
 161 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
 162
 163 enum wl1271_state {
 164         WL1271_STATE_OFF,
 165         WL1271_STATE_ON,
 166         WL1271_STATE_PLT,
 167 };
 168
 169 enum wl1271_partition_type {
 170         PART_DOWN,
 171         PART_WORK,
 172         PART_DRPW,
 173
 174         PART_TABLE_LEN
 175 };
 176
 177 struct wl1271_partition {
 178         u32 size;
 179         u32 start;
 180 };
 181
 182 struct wl1271_partition_set {
 183         struct wl1271_partition mem;
 184         struct wl1271_partition reg;
 185         struct wl1271_partition mem2;
 186         struct wl1271_partition mem3;
 187 };
 188
 189 struct wl1271;
 190
 191 enum {
 192         FW_VER_CHIP,
 193         FW_VER_IF_TYPE,
 194         FW_VER_MAJOR,
 195         FW_VER_SUBTYPE,
 196         FW_VER_MINOR,
 197
 198         NUM_FW_VER
 199 };
 200
 201 #define FW_VER_CHIP_WL127X 6
 202 #define FW_VER_CHIP_WL128X 7
 203
 204 #define FW_VER_IF_TYPE_STA 1
 205 #define FW_VER_IF_TYPE_AP  2
 206
 207 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
 208 #define FW_VER_MINOR_1_SPARE_AP_MIN  47
 209
 210 #define FW_VER_MINOR_FWLOG_STA_MIN 70
 211
 212 struct wl1271_chip {
 213         u32 id;
 214         char fw_ver_str[ETHTOOL_BUSINFO_LEN];
 215         unsigned int fw_ver[NUM_FW_VER];
 216 };
 217
 218 struct wl1271_stats {
 219         struct acx_statistics *fw_stats;
 220         unsigned long fw_stats_update;
 221
 222         unsigned int retry_count;
 223         unsigned int excessive_retries;
 224 };
 225
 226 #define NUM_TX_QUEUES              4
 227 #define NUM_RX_PKT_DESC            8
 228
 229 #define AP_MAX_STATIONS            5
 230
 231 /* Broadcast and Global links + links to stations */
 232 #define AP_MAX_LINKS               (AP_MAX_STATIONS + 2)
 233
 234 /* FW status registers */
 235 struct wl12xx_fw_status {
 236         __le32 intr;
 237         u8  fw_rx_counter;
 238         u8  drv_rx_counter;
 239         u8  reserved;
 240         u8  tx_results_counter;
 241         __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
 242         __le32 fw_localtime;
 243
 244         /*
 245          * A bitmap (where each bit represents a single HLID)
 246          * to indicate if the station is in PS mode.
 247          */
 248         __le32 link_ps_bitmap;
 249
 250         /*
 251          * A bitmap (where each bit represents a single HLID) to indicate
 252          * if the station is in Fast mode
 253          */
 254         __le32 link_fast_bitmap;
 255
 256         /* Cumulative counter of total released mem blocks since FW-reset */
 257         __le32 total_released_blks;
 258
 259         /* Size (in Memory Blocks) of TX pool */
 260         __le32 tx_total;
 261
 262         /* Cumulative counter of released mem-blocks per AC */
 263         u8 tx_released_blks[NUM_TX_QUEUES];
 264
 265         /* Cumulative counter of freed MBs per HLID */
 266         u8 tx_lnk_free_blks[WL12XX_MAX_LINKS];
 267
 268         /* Cumulative counter of released Voice memory blocks */
 269         u8 tx_voice_released_blks;
 270         u8 padding_1[7];
 271         __le32 log_start_addr;
 272 } __packed;
 273
 274 struct wl1271_rx_mem_pool_addr {
 275         u32 addr;
 276         u32 addr_extra;
 277 };
 278
 279 #define WL1271_MAX_CHANNELS 64
 280 struct wl1271_scan {
 281         struct cfg80211_scan_request *req;
 282         unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
 283         bool failed;
 284         u8 state;
 285         u8 ssid[IEEE80211_MAX_SSID_LEN+1];
 286         size_t ssid_len;
 287 };
 288
 289 struct wl1271_if_operations {
 290         void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
 291                      bool fixed);
 292         void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
 293                      bool fixed);
 294         void (*reset)(struct wl1271 *wl);
 295         void (*init)(struct wl1271 *wl);
 296         int (*power)(struct wl1271 *wl, bool enable);
 297         struct device* (*dev)(struct wl1271 *wl);
 298         void (*enable_irq)(struct wl1271 *wl);
 299         void (*disable_irq)(struct wl1271 *wl);
 300         void (*set_block_size) (struct wl1271 *wl, unsigned int blksz);
 301 };
 302
 303 #define MAX_NUM_KEYS 14
 304 #define MAX_KEY_SIZE 32
 305
 306 struct wl1271_ap_key {
 307         u8 id;
 308         u8 key_type;
 309         u8 key_size;
 310         u8 key[MAX_KEY_SIZE];
 311         u8 hlid;
 312         u32 tx_seq_32;
 313         u16 tx_seq_16;
 314 };
 315
 316 enum wl12xx_flags {
 317         WL1271_FLAG_STA_ASSOCIATED,
 318         WL1271_FLAG_JOINED,
 319         WL1271_FLAG_GPIO_POWER,
 320         WL1271_FLAG_TX_QUEUE_STOPPED,
 321         WL1271_FLAG_TX_PENDING,
 322         WL1271_FLAG_IN_ELP,
 323         WL1271_FLAG_ELP_REQUESTED,
 324         WL1271_FLAG_PSM,
 325         WL1271_FLAG_PSM_REQUESTED,
 326         WL1271_FLAG_IRQ_RUNNING,
 327         WL1271_FLAG_IDLE,
 328         WL1271_FLAG_PSPOLL_FAILURE,
 329         WL1271_FLAG_STA_STATE_SENT,
 330         WL1271_FLAG_FW_TX_BUSY,
 331         WL1271_FLAG_AP_STARTED,
 332         WL1271_FLAG_IF_INITIALIZED,
 333         WL1271_FLAG_DUMMY_PACKET_PENDING,
 334         WL1271_FLAG_SUSPENDED,
 335         WL1271_FLAG_PENDING_WORK,
 336         WL1271_FLAG_SOFT_GEMINI,
 337         WL1271_FLAG_RX_STREAMING_STARTED,
 338         WL1271_FLAG_RECOVERY_IN_PROGRESS,
 339 };
 340
 341 struct wl1271_link {
 342         /* AP-mode - TX queue per AC in link */
 343         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 344
 345         /* accounting for allocated / available TX blocks in FW */
 346         u8 allocated_blks;
 347         u8 prev_freed_blks;
 348
 349         u8 addr[ETH_ALEN];
 350 };
 351
 352 struct wl1271 {
 353         struct platform_device *plat_dev;
 354         struct ieee80211_hw *hw;
 355         bool mac80211_registered;
 356
 357         void *if_priv;
 358
 359         struct wl1271_if_operations *if_ops;
 360
 361         void (*set_power)(bool enable);
 362         int irq;
 363         int ref_clock;
 364
 365         spinlock_t wl_lock;
 366
 367         enum wl1271_state state;
 368         struct mutex mutex;
 369
 370         unsigned long flags;
 371
 372         struct wl1271_partition_set part;
 373
 374         struct wl1271_chip chip;
 375
 376         int cmd_box_addr;
 377         int event_box_addr;
 378
 379         u8 *fw;
 380         size_t fw_len;
 381         void *nvs;
 382         size_t nvs_len;
 383
 384         s8 hw_pg_ver;
 385
 386         u8 bssid[ETH_ALEN];
 387         u8 mac_addr[ETH_ALEN];
 388         u8 bss_type;
 389         u8 set_bss_type;
 390         u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
 391         u8 ssid_len;
 392         int channel;
 393
 394         struct wl1271_acx_mem_map *target_mem_map;
 395
 396         /* Accounting for allocated / available TX blocks on HW */
 397         u32 tx_blocks_freed;
 398         u32 tx_blocks_available;
 399         u32 tx_allocated_blocks;
 400         u32 tx_results_count;
 401
 402         /* Transmitted TX packets counter for chipset interface */
 403         u32 tx_packets_count;
 404
 405         /* Time-offset between host and chipset clocks */
 406         s64 time_offset;
 407
 408         /* Session counter for the chipset */
 409         int session_counter;
 410
 411         /* Frames scheduled for transmission, not handled yet */
 412         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 413         int tx_queue_count[NUM_TX_QUEUES];
 414         long stopped_queues_map;
 415
 416         /* Frames received, not handled yet by mac80211 */
 417         struct sk_buff_head deferred_rx_queue;
 418
 419         /* Frames sent, not returned yet to mac80211 */
 420         struct sk_buff_head deferred_tx_queue;
 421
 422         struct work_struct tx_work;
 423         struct workqueue_struct *freezable_wq;
 424
 425         /* Pending TX frames */
 426         unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
 427         struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
 428         int tx_frames_cnt;
 429
 430         /*
 431          * Security sequence number
 432          *     bits 0-15: lower 16 bits part of sequence number
 433          *     bits 16-47: higher 32 bits part of sequence number
 434          *     bits 48-63: not in use
 435          */
 436         u64 tx_security_seq;
 437
 438         /* 8 bits of the last sequence number in use */
 439         u8 tx_security_last_seq_lsb;
 440
 441         /* FW Rx counter */
 442         u32 rx_counter;
 443
 444         /* Rx memory pool address */
 445         struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
 446
 447         /* Intermediate buffer, used for packet aggregation */
 448         u8 *aggr_buf;
 449
 450         /* Reusable dummy packet template */
 451         struct sk_buff *dummy_packet;
 452
 453         /* Network stack work  */
 454         struct work_struct netstack_work;
 455
 456         /* FW log buffer */
 457         u8 *fwlog;
 458
 459         /* Number of valid bytes in the FW log buffer */
 460         ssize_t fwlog_size;
 461
 462         /* Sysfs FW log entry readers wait queue */
 463         wait_queue_head_t fwlog_waitq;
 464
 465         /* Hardware recovery work */
 466         struct work_struct recovery_work;
 467
 468         /* The mbox event mask */
 469         u32 event_mask;
 470
 471         /* Mailbox pointers */
 472         u32 mbox_ptr[2];
 473
 474         /* Are we currently scanning */
 475         struct wl1271_scan scan;
 476         struct delayed_work scan_complete_work;
 477
 478         bool sched_scanning;
 479
 480         /* probe-req template for the current AP */
 481         struct sk_buff *probereq;
 482
 483         /* Our association ID */
 484         u16 aid;
 485
 486         /*
 487          * currently configured rate set:
 488          *      bits  0-15 - 802.11abg rates
 489          *      bits 16-23 - 802.11n   MCS index mask
 490          * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
 491          */
 492         u32 basic_rate_set;
 493         u32 basic_rate;
 494         u32 rate_set;
 495
 496         /* The current band */
 497         enum ieee80211_band band;
 498
 499         /* Beaconing interval (needed for ad-hoc) */
 500         u32 beacon_int;
 501
 502         /* Default key (for WEP) */
 503         u32 default_key;
 504
 505         /* Rx Streaming */
 506         struct work_struct rx_streaming_enable_work;
 507         struct work_struct rx_streaming_disable_work;
 508         struct timer_list rx_streaming_timer;
 509
 510         struct completion *elp_compl;
 511         struct completion *ps_compl;
 512         struct delayed_work elp_work;
 513         struct delayed_work pspoll_work;
 514
 515         /* counter for ps-poll delivery failures */
 516         int ps_poll_failures;
 517
 518         /* retry counter for PSM entries */
 519         u8 psm_entry_retry;
 520
 521         /* in dBm */
 522         int power_level;
 523
 524         int rssi_thold;
 525         int last_rssi_event;
 526
 527         struct wl1271_stats stats;
 528
 529         __le32 buffer_32;
 530         u32 buffer_cmd;
 531         u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
 532
 533         struct wl12xx_fw_status *fw_status;
 534         struct wl1271_tx_hw_res_if *tx_res_if;
 535
 536         struct ieee80211_vif *vif;
 537
 538         /* Current chipset configuration */
 539         struct conf_drv_settings conf;
 540
 541         bool sg_enabled;
 542
 543         bool enable_11a;
 544
 545         struct list_head list;
 546
 547         /* Most recently reported noise in dBm */
 548         s8 noise;
 549
 550         /* map for HLIDs of associated stations - when operating in AP mode */
 551         unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
 552
 553         /* recoreded keys for AP-mode - set here before AP startup */
 554         struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
 555
 556         /* bands supported by this instance of wl12xx */
 557         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 558
 559         /* RX BA constraint value */
 560         bool ba_support;
 561         u8 ba_rx_bitmap;
 562         bool ba_allowed;
 563
 564         int tcxo_clock;
 565
 566         /*
 567          * wowlan trigger was configured during suspend.
 568          * (currently, only "ANY" trigger is supported)
 569          */
 570         bool wow_enabled;
 571         bool irq_wake_enabled;
 572
 573         /*
 574          * AP-mode - links indexed by HLID. The global and broadcast links
 575          * are always active.
 576          */
 577         struct wl1271_link links[AP_MAX_LINKS];
 578
 579         /* the hlid of the link where the last transmitted skb came from */
 580         int last_tx_hlid;
 581
 582         /* AP-mode - a bitmap of links currently in PS mode according to FW */
 583         u32 ap_fw_ps_map;
 584
 585         /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
 586         unsigned long ap_ps_map;
 587
 588         /* Quirks of specific hardware revisions */
 589         unsigned int quirks;
 590
 591         /* Platform limitations */
 592         unsigned int platform_quirks;
 593 };
 594
 595 struct wl1271_station {
 596         u8 hlid;
 597 };
 598
 599 int wl1271_plt_start(struct wl1271 *wl);
 600 int wl1271_plt_stop(struct wl1271 *wl);
 601 int wl1271_recalc_rx_streaming(struct wl1271 *wl);
 602 void wl12xx_queue_recovery_work(struct wl1271 *wl);
 603 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
 604
 605 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 606
 607 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
 608
 609 #define WL1271_DEFAULT_POWER_LEVEL 0
 610
 611 #define WL1271_TX_QUEUE_LOW_WATERMARK  32
 612 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
 613
 614 #define WL1271_DEFERRED_QUEUE_LIMIT    64
 615
 616 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
 617    on in case is has been shut down shortly before */
 618 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
 619 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
 620
 621 /* Macros to handle wl1271.sta_rate_set */
 622 #define HW_BG_RATES_MASK        0xffff
 623 #define HW_HT_RATES_OFFSET      16
 624
 625 /* Quirks */
 626
 627 /* Each RX/TX transaction requires an end-of-transaction transfer */
 628 #define WL12XX_QUIRK_END_OF_TRANSACTION         BIT(0)
 629
 630 /* WL128X requires aggregated packets to be aligned to the SDIO block size */
 631 #define WL12XX_QUIRK_BLOCKSIZE_ALIGNMENT        BIT(2)
 632
 633 /*
 634  * WL127X AP mode requires Low Power DRPw (LPD) enable to reduce power
 635  * consumption
 636  */
 637 #define WL12XX_QUIRK_LPD_MODE                   BIT(3)
 638
 639 /* Older firmwares did not implement the FW logger over bus feature */
 640 #define WL12XX_QUIRK_FWLOG_NOT_IMPLEMENTED      BIT(4)
 641
 642 #define WL12XX_HW_BLOCK_SIZE    256
 643
 644 #endif