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