drivers/net/wireless/wl1251/wl1251.h

   1 /*
   2  * This file is part of wl1251
   3  *
   4  * Copyright (c) 1998-2007 Texas Instruments Incorporated
   5  * Copyright (C) 2008-2009 Nokia Corporation
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * version 2 as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  19  * 02110-1301 USA
  20  *
  21  */
  22
  23 #ifndef __WL1251_H__
  24 #define __WL1251_H__
  25
  26 #include <linux/mutex.h>
  27 #include <linux/list.h>
  28 #include <linux/bitops.h>
  29 #include <net/mac80211.h>
  30
  31 #define DRIVER_NAME "wl1251"
  32 #define DRIVER_PREFIX DRIVER_NAME ": "
  33
  34 enum {
  35         DEBUG_NONE      = 0,
  36         DEBUG_IRQ       = BIT(0),
  37         DEBUG_SPI       = BIT(1),
  38         DEBUG_BOOT      = BIT(2),
  39         DEBUG_MAILBOX   = BIT(3),
  40         DEBUG_NETLINK   = BIT(4),
  41         DEBUG_EVENT     = BIT(5),
  42         DEBUG_TX        = BIT(6),
  43         DEBUG_RX        = BIT(7),
  44         DEBUG_SCAN      = BIT(8),
  45         DEBUG_CRYPT     = BIT(9),
  46         DEBUG_PSM       = BIT(10),
  47         DEBUG_MAC80211  = BIT(11),
  48         DEBUG_CMD       = BIT(12),
  49         DEBUG_ACX       = BIT(13),
  50         DEBUG_ALL       = ~0,
  51 };
  52
  53 #define DEBUG_LEVEL (DEBUG_NONE)
  54
  55 #define DEBUG_DUMP_LIMIT 1024
  56
  57 #define wl1251_error(fmt, arg...) \
  58         printk(KERN_ERR DRIVER_PREFIX "ERROR " fmt "\n", ##arg)
  59
  60 #define wl1251_warning(fmt, arg...) \
  61         printk(KERN_WARNING DRIVER_PREFIX "WARNING " fmt "\n", ##arg)
  62
  63 #define wl1251_notice(fmt, arg...) \
  64         printk(KERN_INFO DRIVER_PREFIX fmt "\n", ##arg)
  65
  66 #define wl1251_info(fmt, arg...) \
  67         printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg)
  68
  69 #define wl1251_debug(level, fmt, arg...) \
  70         do { \
  71                 if (level & DEBUG_LEVEL) \
  72                         printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg); \
  73         } while (0)
  74
  75 #define wl1251_dump(level, prefix, buf, len)    \
  76         do { \
  77                 if (level & DEBUG_LEVEL) \
  78                         print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
  79                                        DUMP_PREFIX_OFFSET, 16, 1,       \
  80                                        buf,                             \
  81                                        min_t(size_t, len, DEBUG_DUMP_LIMIT), \
  82                                        0);                              \
  83         } while (0)
  84
  85 #define wl1251_dump_ascii(level, prefix, buf, len)      \
  86         do { \
  87                 if (level & DEBUG_LEVEL) \
  88                         print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
  89                                        DUMP_PREFIX_OFFSET, 16, 1,       \
  90                                        buf,                             \
  91                                        min_t(size_t, len, DEBUG_DUMP_LIMIT), \
  92                                        true);                           \
  93         } while (0)
  94
  95 #define WL1251_DEFAULT_RX_CONFIG (CFG_UNI_FILTER_EN |   \
  96                                   CFG_BSSID_FILTER_EN)
  97
  98 #define WL1251_DEFAULT_RX_FILTER (CFG_RX_PRSP_EN |  \
  99                                   CFG_RX_MGMT_EN |  \
 100                                   CFG_RX_DATA_EN |  \
 101                                   CFG_RX_CTL_EN |   \
 102                                   CFG_RX_BCN_EN |   \
 103                                   CFG_RX_AUTH_EN |  \
 104                                   CFG_RX_ASSOC_EN)
 105
 106 #define WL1251_BUSY_WORD_LEN 8
 107
 108 struct boot_attr {
 109         u32 radio_type;
 110         u8 mac_clock;
 111         u8 arm_clock;
 112         int firmware_debug;
 113         u32 minor;
 114         u32 major;
 115         u32 bugfix;
 116 };
 117
 118 enum wl1251_state {
 119         WL1251_STATE_OFF,
 120         WL1251_STATE_ON,
 121         WL1251_STATE_PLT,
 122 };
 123
 124 enum wl1251_partition_type {
 125         PART_DOWN,
 126         PART_WORK,
 127         PART_DRPW,
 128
 129         PART_TABLE_LEN
 130 };
 131
 132 enum wl1251_station_mode {
 133         STATION_ACTIVE_MODE,
 134         STATION_POWER_SAVE_MODE,
 135         STATION_IDLE,
 136 };
 137
 138 struct wl1251_partition {
 139         u32 size;
 140         u32 start;
 141 };
 142
 143 struct wl1251_partition_set {
 144         struct wl1251_partition mem;
 145         struct wl1251_partition reg;
 146 };
 147
 148 struct wl1251;
 149
 150 struct wl1251_stats {
 151         struct acx_statistics *fw_stats;
 152         unsigned long fw_stats_update;
 153
 154         unsigned int retry_count;
 155         unsigned int excessive_retries;
 156 };
 157
 158 struct wl1251_debugfs {
 159         struct dentry *rootdir;
 160         struct dentry *fw_statistics;
 161
 162         struct dentry *tx_internal_desc_overflow;
 163
 164         struct dentry *rx_out_of_mem;
 165         struct dentry *rx_hdr_overflow;
 166         struct dentry *rx_hw_stuck;
 167         struct dentry *rx_dropped;
 168         struct dentry *rx_fcs_err;
 169         struct dentry *rx_xfr_hint_trig;
 170         struct dentry *rx_path_reset;
 171         struct dentry *rx_reset_counter;
 172
 173         struct dentry *dma_rx_requested;
 174         struct dentry *dma_rx_errors;
 175         struct dentry *dma_tx_requested;
 176         struct dentry *dma_tx_errors;
 177
 178         struct dentry *isr_cmd_cmplt;
 179         struct dentry *isr_fiqs;
 180         struct dentry *isr_rx_headers;
 181         struct dentry *isr_rx_mem_overflow;
 182         struct dentry *isr_rx_rdys;
 183         struct dentry *isr_irqs;
 184         struct dentry *isr_tx_procs;
 185         struct dentry *isr_decrypt_done;
 186         struct dentry *isr_dma0_done;
 187         struct dentry *isr_dma1_done;
 188         struct dentry *isr_tx_exch_complete;
 189         struct dentry *isr_commands;
 190         struct dentry *isr_rx_procs;
 191         struct dentry *isr_hw_pm_mode_changes;
 192         struct dentry *isr_host_acknowledges;
 193         struct dentry *isr_pci_pm;
 194         struct dentry *isr_wakeups;
 195         struct dentry *isr_low_rssi;
 196
 197         struct dentry *wep_addr_key_count;
 198         struct dentry *wep_default_key_count;
 199         /* skipping wep.reserved */
 200         struct dentry *wep_key_not_found;
 201         struct dentry *wep_decrypt_fail;
 202         struct dentry *wep_packets;
 203         struct dentry *wep_interrupt;
 204
 205         struct dentry *pwr_ps_enter;
 206         struct dentry *pwr_elp_enter;
 207         struct dentry *pwr_missing_bcns;
 208         struct dentry *pwr_wake_on_host;
 209         struct dentry *pwr_wake_on_timer_exp;
 210         struct dentry *pwr_tx_with_ps;
 211         struct dentry *pwr_tx_without_ps;
 212         struct dentry *pwr_rcvd_beacons;
 213         struct dentry *pwr_power_save_off;
 214         struct dentry *pwr_enable_ps;
 215         struct dentry *pwr_disable_ps;
 216         struct dentry *pwr_fix_tsf_ps;
 217         /* skipping cont_miss_bcns_spread for now */
 218         struct dentry *pwr_rcvd_awake_beacons;
 219
 220         struct dentry *mic_rx_pkts;
 221         struct dentry *mic_calc_failure;
 222
 223         struct dentry *aes_encrypt_fail;
 224         struct dentry *aes_decrypt_fail;
 225         struct dentry *aes_encrypt_packets;
 226         struct dentry *aes_decrypt_packets;
 227         struct dentry *aes_encrypt_interrupt;
 228         struct dentry *aes_decrypt_interrupt;
 229
 230         struct dentry *event_heart_beat;
 231         struct dentry *event_calibration;
 232         struct dentry *event_rx_mismatch;
 233         struct dentry *event_rx_mem_empty;
 234         struct dentry *event_rx_pool;
 235         struct dentry *event_oom_late;
 236         struct dentry *event_phy_transmit_error;
 237         struct dentry *event_tx_stuck;
 238
 239         struct dentry *ps_pspoll_timeouts;
 240         struct dentry *ps_upsd_timeouts;
 241         struct dentry *ps_upsd_max_sptime;
 242         struct dentry *ps_upsd_max_apturn;
 243         struct dentry *ps_pspoll_max_apturn;
 244         struct dentry *ps_pspoll_utilization;
 245         struct dentry *ps_upsd_utilization;
 246
 247         struct dentry *rxpipe_rx_prep_beacon_drop;
 248         struct dentry *rxpipe_descr_host_int_trig_rx_data;
 249         struct dentry *rxpipe_beacon_buffer_thres_host_int_trig_rx_data;
 250         struct dentry *rxpipe_missed_beacon_host_int_trig_rx_data;
 251         struct dentry *rxpipe_tx_xfr_host_int_trig_rx_data;
 252
 253         struct dentry *tx_queue_len;
 254         struct dentry *tx_queue_status;
 255
 256         struct dentry *retry_count;
 257         struct dentry *excessive_retries;
 258 };
 259
 260 struct wl1251_if_operations {
 261         void (*read)(struct wl1251 *wl, int addr, void *buf, size_t len);
 262         void (*write)(struct wl1251 *wl, int addr, void *buf, size_t len);
 263         void (*read_elp)(struct wl1251 *wl, int addr, u32 *val);
 264         void (*write_elp)(struct wl1251 *wl, int addr, u32 val);
 265         int  (*power)(struct wl1251 *wl, bool enable);
 266         void (*reset)(struct wl1251 *wl);
 267         void (*enable_irq)(struct wl1251 *wl);
 268         void (*disable_irq)(struct wl1251 *wl);
 269 };
 270
 271 struct wl1251 {
 272         struct ieee80211_hw *hw;
 273         bool mac80211_registered;
 274
 275         void *if_priv;
 276         const struct wl1251_if_operations *if_ops;
 277
 278         void (*set_power)(bool enable);
 279         int irq;
 280         bool use_eeprom;
 281
 282         spinlock_t wl_lock;
 283
 284         enum wl1251_state state;
 285         struct mutex mutex;
 286
 287         int physical_mem_addr;
 288         int physical_reg_addr;
 289         int virtual_mem_addr;
 290         int virtual_reg_addr;
 291
 292         int cmd_box_addr;
 293         int event_box_addr;
 294         struct boot_attr boot_attr;
 295
 296         u8 *fw;
 297         size_t fw_len;
 298         u8 *nvs;
 299         size_t nvs_len;
 300
 301         u8 bssid[ETH_ALEN];
 302         u8 mac_addr[ETH_ALEN];
 303         u8 bss_type;
 304         u8 listen_int;
 305         int channel;
 306
 307         void *target_mem_map;
 308         struct acx_data_path_params_resp *data_path;
 309
 310         /* Number of TX packets transferred to the FW, modulo 16 */
 311         u32 data_in_count;
 312
 313         /* Frames scheduled for transmission, not handled yet */
 314         struct sk_buff_head tx_queue;
 315         bool tx_queue_stopped;
 316
 317         struct work_struct tx_work;
 318         struct work_struct filter_work;
 319
 320         /* Pending TX frames */
 321         struct sk_buff *tx_frames[16];
 322
 323         /*
 324          * Index pointing to the next TX complete entry
 325          * in the cyclic XT complete array we get from
 326          * the FW.
 327          */
 328         u32 next_tx_complete;
 329
 330         /* FW Rx counter */
 331         u32 rx_counter;
 332
 333         /* Rx frames handled */
 334         u32 rx_handled;
 335
 336         /* Current double buffer */
 337         u32 rx_current_buffer;
 338         u32 rx_last_id;
 339
 340         /* The target interrupt mask */
 341         u32 intr_mask;
 342         struct work_struct irq_work;
 343
 344         /* The mbox event mask */
 345         u32 event_mask;
 346
 347         /* Mailbox pointers */
 348         u32 mbox_ptr[2];
 349
 350         /* Are we currently scanning */
 351         bool scanning;
 352
 353         /* Default key (for WEP) */
 354         u32 default_key;
 355
 356         unsigned int tx_mgmt_frm_rate;
 357         unsigned int tx_mgmt_frm_mod;
 358
 359         unsigned int rx_config;
 360         unsigned int rx_filter;
 361
 362         /* is firmware in elp mode */
 363         bool elp;
 364
 365         struct delayed_work elp_work;
 366
 367         enum wl1251_station_mode station_mode;
 368
 369         /* PSM mode requested */
 370         bool psm_requested;
 371
 372         u16 beacon_int;
 373         u8 dtim_period;
 374
 375         /* in dBm */
 376         int power_level;
 377
 378         int rssi_thold;
 379
 380         struct wl1251_stats stats;
 381         struct wl1251_debugfs debugfs;
 382
 383         u32 buffer_32;
 384         u32 buffer_cmd;
 385         u8 buffer_busyword[WL1251_BUSY_WORD_LEN];
 386         struct wl1251_rx_descriptor *rx_descriptor;
 387
 388         struct ieee80211_vif *vif;
 389
 390         u32 chip_id;
 391         char fw_ver[21];
 392
 393         /* Most recently reported noise in dBm */
 394         s8 noise;
 395 };
 396
 397 int wl1251_plt_start(struct wl1251 *wl);
 398 int wl1251_plt_stop(struct wl1251 *wl);
 399
 400 struct ieee80211_hw *wl1251_alloc_hw(void);
 401 int wl1251_free_hw(struct wl1251 *wl);
 402 int wl1251_init_ieee80211(struct wl1251 *wl);
 403 void wl1251_enable_interrupts(struct wl1251 *wl);
 404 void wl1251_disable_interrupts(struct wl1251 *wl);
 405
 406 #define DEFAULT_HW_GEN_MODULATION_TYPE    CCK_LONG /* Long Preamble */
 407 #define DEFAULT_HW_GEN_TX_RATE          RATE_2MBPS
 408 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 409
 410 #define WL1251_DEFAULT_POWER_LEVEL 20
 411
 412 #define WL1251_TX_QUEUE_LOW_WATERMARK  10
 413 #define WL1251_TX_QUEUE_HIGH_WATERMARK 25
 414
 415 #define WL1251_DEFAULT_BEACON_INT 100
 416 #define WL1251_DEFAULT_DTIM_PERIOD 1
 417
 418 #define WL1251_DEFAULT_CHANNEL 0
 419
 420 #define WL1251_DEFAULT_BET_CONSECUTIVE 10
 421
 422 #define CHIP_ID_1251_PG10                  (0x7010101)
 423 #define CHIP_ID_1251_PG11                  (0x7020101)
 424 #define CHIP_ID_1251_PG12                  (0x7030101)
 425 #define CHIP_ID_1271_PG10                  (0x4030101)
 426 #define CHIP_ID_1271_PG20                  (0x4030111)
 427
 428 #define WL1251_FW_NAME "wl1251-fw.bin"
 429 #define WL1251_NVS_NAME "wl1251-nvs.bin"
 430
 431 #define WL1251_POWER_ON_SLEEP 10 /* in milliseconds */
 432
 433 #define WL1251_PART_DOWN_MEM_START      0x0
 434 #define WL1251_PART_DOWN_MEM_SIZE       0x16800
 435 #define WL1251_PART_DOWN_REG_START      REGISTERS_BASE
 436 #define WL1251_PART_DOWN_REG_SIZE       REGISTERS_DOWN_SIZE
 437
 438 #define WL1251_PART_WORK_MEM_START      0x28000
 439 #define WL1251_PART_WORK_MEM_SIZE       0x14000
 440 #define WL1251_PART_WORK_REG_START      REGISTERS_BASE
 441 #define WL1251_PART_WORK_REG_SIZE       REGISTERS_WORK_SIZE
 442
 443 #define WL1251_DEFAULT_LOW_RSSI_WEIGHT          10
 444 #define WL1251_DEFAULT_LOW_RSSI_DEPTH           10
 445
 446 #endif