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 "wl1271-fw-2.bin"
 134 #define WL1271_AP_FW_NAME "wl1271-fw-ap.bin"
 135
 136 #define WL1271_NVS_NAME "wl1271-nvs.bin"
 137
 138 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
 139 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
 140
 141 #define WL1271_CIPHER_SUITE_GEM 0x00147201
 142
 143 #define WL1271_BUSY_WORD_CNT 1
 144 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
 145
 146 #define WL1271_ELP_HW_STATE_ASLEEP 0
 147 #define WL1271_ELP_HW_STATE_IRQ    1
 148
 149 #define WL1271_DEFAULT_BEACON_INT  100
 150 #define WL1271_DEFAULT_DTIM_PERIOD 1
 151
 152 #define WL1271_AP_GLOBAL_HLID      0
 153 #define WL1271_AP_BROADCAST_HLID   1
 154 #define WL1271_AP_STA_HLID_START   2
 155
 156 #define WL1271_AP_BSS_INDEX        0
 157 #define WL1271_AP_DEF_INACTIV_SEC  300
 158 #define WL1271_AP_DEF_BEACON_EXP   20
 159
 160 #define ACX_TX_DESCRIPTORS         32
 161
 162 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
 163
 164 enum wl1271_state {
 165         WL1271_STATE_OFF,
 166         WL1271_STATE_ON,
 167         WL1271_STATE_PLT,
 168 };
 169
 170 enum wl1271_partition_type {
 171         PART_DOWN,
 172         PART_WORK,
 173         PART_DRPW,
 174
 175         PART_TABLE_LEN
 176 };
 177
 178 struct wl1271_partition {
 179         u32 size;
 180         u32 start;
 181 };
 182
 183 struct wl1271_partition_set {
 184         struct wl1271_partition mem;
 185         struct wl1271_partition reg;
 186         struct wl1271_partition mem2;
 187         struct wl1271_partition mem3;
 188 };
 189
 190 struct wl1271;
 191
 192 #define WL12XX_NUM_FW_VER 5
 193
 194 /* FIXME: I'm not sure about this structure name */
 195 struct wl1271_chip {
 196         u32 id;
 197         char fw_ver_str[ETHTOOL_BUSINFO_LEN];
 198         unsigned int fw_ver[WL12XX_NUM_FW_VER];
 199 };
 200
 201 struct wl1271_stats {
 202         struct acx_statistics *fw_stats;
 203         unsigned long fw_stats_update;
 204
 205         unsigned int retry_count;
 206         unsigned int excessive_retries;
 207 };
 208
 209 #define NUM_TX_QUEUES              4
 210 #define NUM_RX_PKT_DESC            8
 211
 212 #define AP_MAX_STATIONS            5
 213
 214 /* Broadcast and Global links + links to stations */
 215 #define AP_MAX_LINKS               (AP_MAX_STATIONS + 2)
 216
 217 /* FW status registers common for AP/STA */
 218 struct wl1271_fw_common_status {
 219         __le32 intr;
 220         u8  fw_rx_counter;
 221         u8  drv_rx_counter;
 222         u8  reserved;
 223         u8  tx_results_counter;
 224         __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
 225         __le32 tx_released_blks[NUM_TX_QUEUES];
 226         __le32 fw_localtime;
 227 } __packed;
 228
 229 /* FW status registers for AP */
 230 struct wl1271_fw_ap_status {
 231         struct wl1271_fw_common_status common;
 232
 233         /* Next fields valid only in AP FW */
 234
 235         /*
 236          * A bitmap (where each bit represents a single HLID)
 237          * to indicate if the station is in PS mode.
 238          */
 239         __le32 link_ps_bitmap;
 240
 241         /* Number of freed MBs per HLID */
 242         u8 tx_lnk_free_blks[AP_MAX_LINKS];
 243         u8 padding_1[1];
 244 } __packed;
 245
 246 /* FW status registers for STA */
 247 struct wl1271_fw_sta_status {
 248         struct wl1271_fw_common_status common;
 249
 250         u8  tx_total;
 251         u8  reserved1;
 252         __le16 reserved2;
 253 } __packed;
 254
 255 struct wl1271_fw_full_status {
 256         union {
 257                 struct wl1271_fw_common_status common;
 258                 struct wl1271_fw_sta_status sta;
 259                 struct wl1271_fw_ap_status ap;
 260         };
 261 } __packed;
 262
 263
 264 struct wl1271_rx_mem_pool_addr {
 265         u32 addr;
 266         u32 addr_extra;
 267 };
 268
 269 struct wl1271_scan {
 270         struct cfg80211_scan_request *req;
 271         bool *scanned_ch;
 272         bool failed;
 273         u8 state;
 274         u8 ssid[IW_ESSID_MAX_SIZE+1];
 275         size_t ssid_len;
 276 };
 277
 278 struct wl1271_if_operations {
 279         void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
 280                      bool fixed);
 281         void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
 282                      bool fixed);
 283         void (*reset)(struct wl1271 *wl);
 284         void (*init)(struct wl1271 *wl);
 285         int (*power)(struct wl1271 *wl, bool enable);
 286         struct device* (*dev)(struct wl1271 *wl);
 287         void (*enable_irq)(struct wl1271 *wl);
 288         void (*disable_irq)(struct wl1271 *wl);
 289 };
 290
 291 #define MAX_NUM_KEYS 14
 292 #define MAX_KEY_SIZE 32
 293
 294 struct wl1271_ap_key {
 295         u8 id;
 296         u8 key_type;
 297         u8 key_size;
 298         u8 key[MAX_KEY_SIZE];
 299         u8 hlid;
 300         u32 tx_seq_32;
 301         u16 tx_seq_16;
 302 };
 303
 304 enum wl12xx_flags {
 305         WL1271_FLAG_STA_ASSOCIATED,
 306         WL1271_FLAG_JOINED,
 307         WL1271_FLAG_GPIO_POWER,
 308         WL1271_FLAG_TX_QUEUE_STOPPED,
 309         WL1271_FLAG_IN_ELP,
 310         WL1271_FLAG_PSM,
 311         WL1271_FLAG_PSM_REQUESTED,
 312         WL1271_FLAG_IRQ_PENDING,
 313         WL1271_FLAG_IRQ_RUNNING,
 314         WL1271_FLAG_IDLE,
 315         WL1271_FLAG_IDLE_REQUESTED,
 316         WL1271_FLAG_PSPOLL_FAILURE,
 317         WL1271_FLAG_STA_STATE_SENT,
 318         WL1271_FLAG_FW_TX_BUSY,
 319         WL1271_FLAG_AP_STARTED
 320 };
 321
 322 struct wl1271 {
 323         struct platform_device *plat_dev;
 324         struct ieee80211_hw *hw;
 325         bool mac80211_registered;
 326
 327         void *if_priv;
 328
 329         struct wl1271_if_operations *if_ops;
 330
 331         void (*set_power)(bool enable);
 332         int irq;
 333         int ref_clock;
 334
 335         spinlock_t wl_lock;
 336
 337         enum wl1271_state state;
 338         struct mutex mutex;
 339
 340         unsigned long flags;
 341
 342         struct wl1271_partition_set part;
 343
 344         struct wl1271_chip chip;
 345
 346         int cmd_box_addr;
 347         int event_box_addr;
 348
 349         u8 *fw;
 350         size_t fw_len;
 351         u8 fw_bss_type;
 352         struct wl1271_nvs_file *nvs;
 353         size_t nvs_len;
 354
 355         s8 hw_pg_ver;
 356
 357         u8 bssid[ETH_ALEN];
 358         u8 mac_addr[ETH_ALEN];
 359         u8 bss_type;
 360         u8 set_bss_type;
 361         u8 ssid[IW_ESSID_MAX_SIZE + 1];
 362         u8 ssid_len;
 363         int channel;
 364
 365         struct wl1271_acx_mem_map *target_mem_map;
 366
 367         /* Accounting for allocated / available TX blocks on HW */
 368         u32 tx_blocks_freed[NUM_TX_QUEUES];
 369         u32 tx_blocks_available;
 370         u32 tx_results_count;
 371
 372         /* Transmitted TX packets counter for chipset interface */
 373         u32 tx_packets_count;
 374
 375         /* Time-offset between host and chipset clocks */
 376         s64 time_offset;
 377
 378         /* Session counter for the chipset */
 379         int session_counter;
 380
 381         /* Frames scheduled for transmission, not handled yet */
 382         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 383         int tx_queue_count;
 384
 385         struct work_struct tx_work;
 386
 387         /* Pending TX frames */
 388         unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
 389         struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
 390         int tx_frames_cnt;
 391
 392         /* Security sequence number counters */
 393         u8 tx_security_last_seq;
 394         s64 tx_security_seq;
 395
 396         /* FW Rx counter */
 397         u32 rx_counter;
 398
 399         /* Rx memory pool address */
 400         struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
 401
 402         /* Intermediate buffer, used for packet aggregation */
 403         u8 *aggr_buf;
 404
 405         /* The target interrupt mask */
 406         struct work_struct irq_work;
 407
 408         /* Hardware recovery work */
 409         struct work_struct recovery_work;
 410
 411         /* The mbox event mask */
 412         u32 event_mask;
 413
 414         /* Mailbox pointers */
 415         u32 mbox_ptr[2];
 416
 417         /* Are we currently scanning */
 418         struct wl1271_scan scan;
 419         struct delayed_work scan_complete_work;
 420
 421         /* probe-req template for the current AP */
 422         struct sk_buff *probereq;
 423
 424         /* Our association ID */
 425         u16 aid;
 426
 427         /*
 428          * currently configured rate set:
 429          *      bits  0-15 - 802.11abg rates
 430          *      bits 16-23 - 802.11n   MCS index mask
 431          * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
 432          */
 433         u32 basic_rate_set;
 434         u32 basic_rate;
 435         u32 rate_set;
 436
 437         /* The current band */
 438         enum ieee80211_band band;
 439
 440         /* Beaconing interval (needed for ad-hoc) */
 441         u32 beacon_int;
 442
 443         /* Default key (for WEP) */
 444         u32 default_key;
 445
 446         unsigned int filters;
 447         unsigned int rx_config;
 448         unsigned int rx_filter;
 449
 450         struct completion *elp_compl;
 451         struct delayed_work elp_work;
 452         struct delayed_work pspoll_work;
 453
 454         /* counter for ps-poll delivery failures */
 455         int ps_poll_failures;
 456
 457         /* retry counter for PSM entries */
 458         u8 psm_entry_retry;
 459
 460         /* in dBm */
 461         int power_level;
 462
 463         int rssi_thold;
 464         int last_rssi_event;
 465
 466         struct wl1271_stats stats;
 467
 468         __le32 buffer_32;
 469         u32 buffer_cmd;
 470         u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
 471
 472         struct wl1271_fw_full_status *fw_status;
 473         struct wl1271_tx_hw_res_if *tx_res_if;
 474
 475         struct ieee80211_vif *vif;
 476
 477         /* Current chipset configuration */
 478         struct conf_drv_settings conf;
 479
 480         bool sg_enabled;
 481
 482         bool enable_11a;
 483
 484         struct list_head list;
 485
 486         /* Most recently reported noise in dBm */
 487         s8 noise;
 488
 489         /* map for HLIDs of associated stations - when operating in AP mode */
 490         unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
 491
 492         /* recoreded keys for AP-mode - set here before AP startup */
 493         struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
 494
 495         /* bands supported by this instance of wl12xx */
 496         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 497
 498         /* RX BA constraint value */
 499         bool ba_support;
 500         u8 ba_rx_bitmap;
 501 };
 502
 503 struct wl1271_station {
 504         u8 hlid;
 505 };
 506
 507 int wl1271_plt_start(struct wl1271 *wl);
 508 int wl1271_plt_stop(struct wl1271 *wl);
 509
 510 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 511
 512 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
 513
 514 #define WL1271_DEFAULT_POWER_LEVEL 0
 515
 516 #define WL1271_TX_QUEUE_LOW_WATERMARK  10
 517 #define WL1271_TX_QUEUE_HIGH_WATERMARK 25
 518
 519 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
 520    on in case is has been shut down shortly before */
 521 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
 522 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
 523
 524 /* Macros to handle wl1271.sta_rate_set */
 525 #define HW_BG_RATES_MASK        0xffff
 526 #define HW_HT_RATES_OFFSET      16
 527
 528 #endif