wl12xx: enable AP advanced functionality
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / net / wireless / wl12xx / wl12xx.h
blob61a7c2163ea2e463e0357e887de582f569dc374d
1 /*
2 * This file is part of wl1271
4 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
5 * Copyright (C) 2008-2009 Nokia Corporation
7 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
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.
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.
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
25 #ifndef __WL12XX_H__
26 #define __WL12XX_H__
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>
35 #include "conf.h"
36 #include "ini.h"
38 #define DRIVER_NAME "wl1271"
39 #define DRIVER_PREFIX DRIVER_NAME ": "
42 * FW versions support BA 11n
43 * versions marks x.x.x.50-60.x
45 #define WL12XX_BA_SUPPORT_FW_COST_VER2_START 50
46 #define WL12XX_BA_SUPPORT_FW_COST_VER2_END 60
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,
72 extern u32 wl12xx_debug_level;
74 #define DEBUG_DUMP_LIMIT 1024
76 #define wl1271_error(fmt, arg...) \
77 pr_err(DRIVER_PREFIX "ERROR " fmt "\n", ##arg)
79 #define wl1271_warning(fmt, arg...) \
80 pr_warning(DRIVER_PREFIX "WARNING " fmt "\n", ##arg)
82 #define wl1271_notice(fmt, arg...) \
83 pr_info(DRIVER_PREFIX fmt "\n", ##arg)
85 #define wl1271_info(fmt, arg...) \
86 pr_info(DRIVER_PREFIX fmt "\n", ##arg)
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)
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)
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)
115 #define WL127X_FW_NAME "ti-connectivity/wl127x-fw-3.bin"
116 #define WL128X_FW_NAME "ti-connectivity/wl128x-fw-3.bin"
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().
123 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
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
129 #define WL1271_CIPHER_SUITE_GEM 0x00147201
131 #define WL1271_BUSY_WORD_CNT 1
132 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
134 #define WL1271_ELP_HW_STATE_ASLEEP 0
135 #define WL1271_ELP_HW_STATE_IRQ 1
137 #define WL1271_DEFAULT_BEACON_INT 100
138 #define WL1271_DEFAULT_DTIM_PERIOD 1
140 #define WL12XX_MAX_ROLES 4
141 #define WL12XX_MAX_LINKS 8
142 #define WL12XX_INVALID_ROLE_ID 0xff
143 #define WL12XX_INVALID_LINK_ID 0xff
145 /* Defined by FW as 0. Will not be freed or allocated. */
146 #define WL12XX_SYSTEM_HLID 0
149 * TODO: we currently don't support multirole. remove
150 * this constant from the code when we do.
152 #define WL1271_AP_STA_HLID_START 3
155 * When in AP-mode, we allow (at least) this number of packets
156 * to be transmitted to FW for a STA in PS-mode. Only when packets are
157 * present in the FW buffers it will wake the sleeping STA. We want to put
158 * enough packets for the driver to transmit all of its buffered data before
159 * the STA goes to sleep again. But we don't want to take too much memory
160 * as it might hurt the throughput of active STAs.
162 #define WL1271_PS_STA_MAX_PACKETS 2
164 #define WL1271_AP_BSS_INDEX 0
165 #define WL1271_AP_DEF_BEACON_EXP 20
167 #define ACX_TX_DESCRIPTORS 16
169 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
171 enum wl1271_state {
172 WL1271_STATE_OFF,
173 WL1271_STATE_ON,
174 WL1271_STATE_PLT,
177 enum wl1271_partition_type {
178 PART_DOWN,
179 PART_WORK,
180 PART_DRPW,
182 PART_TABLE_LEN
185 struct wl1271_partition {
186 u32 size;
187 u32 start;
190 struct wl1271_partition_set {
191 struct wl1271_partition mem;
192 struct wl1271_partition reg;
193 struct wl1271_partition mem2;
194 struct wl1271_partition mem3;
197 struct wl1271;
199 enum {
200 FW_VER_CHIP,
201 FW_VER_IF_TYPE,
202 FW_VER_MAJOR,
203 FW_VER_SUBTYPE,
204 FW_VER_MINOR,
206 NUM_FW_VER
209 #define FW_VER_CHIP_WL127X 6
210 #define FW_VER_CHIP_WL128X 7
212 #define FW_VER_IF_TYPE_STA 1
213 #define FW_VER_IF_TYPE_AP 2
215 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
216 #define FW_VER_MINOR_1_SPARE_AP_MIN 47
218 #define FW_VER_MINOR_FWLOG_STA_MIN 70
220 struct wl1271_chip {
221 u32 id;
222 char fw_ver_str[ETHTOOL_BUSINFO_LEN];
223 unsigned int fw_ver[NUM_FW_VER];
226 struct wl1271_stats {
227 struct acx_statistics *fw_stats;
228 unsigned long fw_stats_update;
230 unsigned int retry_count;
231 unsigned int excessive_retries;
234 #define NUM_TX_QUEUES 4
235 #define NUM_RX_PKT_DESC 8
237 #define AP_MAX_STATIONS 5
239 /* Broadcast and Global links + system link + links to stations */
241 * TODO: when WL1271_AP_STA_HLID_START is no longer constant, change all
242 * the places that use this.
244 #define AP_MAX_LINKS (AP_MAX_STATIONS + 3)
246 /* FW status registers */
247 struct wl12xx_fw_status {
248 __le32 intr;
249 u8 fw_rx_counter;
250 u8 drv_rx_counter;
251 u8 reserved;
252 u8 tx_results_counter;
253 __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
254 __le32 fw_localtime;
257 * A bitmap (where each bit represents a single HLID)
258 * to indicate if the station is in PS mode.
260 __le32 link_ps_bitmap;
263 * A bitmap (where each bit represents a single HLID) to indicate
264 * if the station is in Fast mode
266 __le32 link_fast_bitmap;
268 /* Cumulative counter of total released mem blocks since FW-reset */
269 __le32 total_released_blks;
271 /* Size (in Memory Blocks) of TX pool */
272 __le32 tx_total;
274 /* Cumulative counter of released packets per AC */
275 u8 tx_released_pkts[NUM_TX_QUEUES];
277 /* Cumulative counter of freed packets per HLID */
278 u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
280 /* Cumulative counter of released Voice memory blocks */
281 u8 tx_voice_released_blks;
282 u8 padding_1[7];
283 __le32 log_start_addr;
284 } __packed;
286 struct wl1271_rx_mem_pool_addr {
287 u32 addr;
288 u32 addr_extra;
291 #define WL1271_MAX_CHANNELS 64
292 struct wl1271_scan {
293 struct cfg80211_scan_request *req;
294 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
295 bool failed;
296 u8 state;
297 u8 ssid[IEEE80211_MAX_SSID_LEN+1];
298 size_t ssid_len;
301 struct wl1271_if_operations {
302 void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
303 bool fixed);
304 void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
305 bool fixed);
306 void (*reset)(struct wl1271 *wl);
307 void (*init)(struct wl1271 *wl);
308 int (*power)(struct wl1271 *wl, bool enable);
309 struct device* (*dev)(struct wl1271 *wl);
310 void (*enable_irq)(struct wl1271 *wl);
311 void (*disable_irq)(struct wl1271 *wl);
312 void (*set_block_size) (struct wl1271 *wl, unsigned int blksz);
315 #define MAX_NUM_KEYS 14
316 #define MAX_KEY_SIZE 32
318 struct wl1271_ap_key {
319 u8 id;
320 u8 key_type;
321 u8 key_size;
322 u8 key[MAX_KEY_SIZE];
323 u8 hlid;
324 u32 tx_seq_32;
325 u16 tx_seq_16;
328 enum wl12xx_flags {
329 WL1271_FLAG_STA_ASSOCIATED,
330 WL1271_FLAG_IBSS_JOINED,
331 WL1271_FLAG_GPIO_POWER,
332 WL1271_FLAG_TX_QUEUE_STOPPED,
333 WL1271_FLAG_TX_PENDING,
334 WL1271_FLAG_IN_ELP,
335 WL1271_FLAG_ELP_REQUESTED,
336 WL1271_FLAG_PSM,
337 WL1271_FLAG_PSM_REQUESTED,
338 WL1271_FLAG_IRQ_RUNNING,
339 WL1271_FLAG_IDLE,
340 WL1271_FLAG_PSPOLL_FAILURE,
341 WL1271_FLAG_STA_STATE_SENT,
342 WL1271_FLAG_FW_TX_BUSY,
343 WL1271_FLAG_AP_STARTED,
344 WL1271_FLAG_IF_INITIALIZED,
345 WL1271_FLAG_DUMMY_PACKET_PENDING,
346 WL1271_FLAG_SUSPENDED,
347 WL1271_FLAG_PENDING_WORK,
348 WL1271_FLAG_SOFT_GEMINI,
349 WL1271_FLAG_RX_STREAMING_STARTED,
350 WL1271_FLAG_RECOVERY_IN_PROGRESS,
353 struct wl1271_link {
354 /* AP-mode - TX queue per AC in link */
355 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
357 /* accounting for allocated / freed packets in FW */
358 u8 allocated_pkts;
359 u8 prev_freed_pkts;
361 u8 addr[ETH_ALEN];
363 /* bitmap of TIDs where RX BA sessions are active for this link */
364 u8 ba_bitmap;
367 struct wl1271 {
368 struct platform_device *plat_dev;
369 struct ieee80211_hw *hw;
370 bool mac80211_registered;
372 void *if_priv;
374 struct wl1271_if_operations *if_ops;
376 void (*set_power)(bool enable);
377 int irq;
378 int ref_clock;
380 spinlock_t wl_lock;
382 enum wl1271_state state;
383 struct mutex mutex;
385 unsigned long flags;
387 struct wl1271_partition_set part;
389 struct wl1271_chip chip;
391 int cmd_box_addr;
392 int event_box_addr;
394 u8 *fw;
395 size_t fw_len;
396 void *nvs;
397 size_t nvs_len;
399 s8 hw_pg_ver;
401 u8 bssid[ETH_ALEN];
402 u8 mac_addr[ETH_ALEN];
403 u8 bss_type;
404 u8 set_bss_type;
405 u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
406 u8 ssid_len;
407 int channel;
408 u8 role_id;
409 u8 dev_role_id;
410 u8 system_hlid;
411 u8 sta_hlid;
412 u8 dev_hlid;
413 u8 ap_global_hlid;
414 u8 ap_bcast_hlid;
416 unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
417 unsigned long roles_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
418 unsigned long roc_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
420 struct wl1271_acx_mem_map *target_mem_map;
422 /* Accounting for allocated / available TX blocks on HW */
423 u32 tx_blocks_freed;
424 u32 tx_blocks_available;
425 u32 tx_allocated_blocks;
426 u32 tx_results_count;
428 /* Accounting for allocated / available Tx packets in HW */
429 u32 tx_pkts_freed[NUM_TX_QUEUES];
430 u32 tx_allocated_pkts[NUM_TX_QUEUES];
432 /* Transmitted TX packets counter for chipset interface */
433 u32 tx_packets_count;
435 /* Time-offset between host and chipset clocks */
436 s64 time_offset;
438 /* Session counter for the chipset */
439 int session_counter;
441 /* Frames scheduled for transmission, not handled yet */
442 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
443 int tx_queue_count[NUM_TX_QUEUES];
444 long stopped_queues_map;
446 /* Frames received, not handled yet by mac80211 */
447 struct sk_buff_head deferred_rx_queue;
449 /* Frames sent, not returned yet to mac80211 */
450 struct sk_buff_head deferred_tx_queue;
452 struct work_struct tx_work;
453 struct workqueue_struct *freezable_wq;
455 /* Pending TX frames */
456 unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
457 struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
458 int tx_frames_cnt;
461 * Security sequence number
462 * bits 0-15: lower 16 bits part of sequence number
463 * bits 16-47: higher 32 bits part of sequence number
464 * bits 48-63: not in use
466 u64 tx_security_seq;
468 /* 8 bits of the last sequence number in use */
469 u8 tx_security_last_seq_lsb;
471 /* FW Rx counter */
472 u32 rx_counter;
474 /* Rx memory pool address */
475 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
477 /* Intermediate buffer, used for packet aggregation */
478 u8 *aggr_buf;
480 /* Reusable dummy packet template */
481 struct sk_buff *dummy_packet;
483 /* Network stack work */
484 struct work_struct netstack_work;
486 /* FW log buffer */
487 u8 *fwlog;
489 /* Number of valid bytes in the FW log buffer */
490 ssize_t fwlog_size;
492 /* Sysfs FW log entry readers wait queue */
493 wait_queue_head_t fwlog_waitq;
495 /* Hardware recovery work */
496 struct work_struct recovery_work;
498 /* The mbox event mask */
499 u32 event_mask;
501 /* Mailbox pointers */
502 u32 mbox_ptr[2];
504 /* Are we currently scanning */
505 struct wl1271_scan scan;
506 struct delayed_work scan_complete_work;
508 bool sched_scanning;
510 /* probe-req template for the current AP */
511 struct sk_buff *probereq;
513 /* Our association ID */
514 u16 aid;
517 * currently configured rate set:
518 * bits 0-15 - 802.11abg rates
519 * bits 16-23 - 802.11n MCS index mask
520 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
522 u32 basic_rate_set;
523 u32 basic_rate;
524 u32 rate_set;
526 /* The current band */
527 enum ieee80211_band band;
529 /* Beaconing interval (needed for ad-hoc) */
530 u32 beacon_int;
532 /* Default key (for WEP) */
533 u32 default_key;
535 /* Rx Streaming */
536 struct work_struct rx_streaming_enable_work;
537 struct work_struct rx_streaming_disable_work;
538 struct timer_list rx_streaming_timer;
540 struct completion *elp_compl;
541 struct completion *ps_compl;
542 struct delayed_work elp_work;
543 struct delayed_work pspoll_work;
545 /* counter for ps-poll delivery failures */
546 int ps_poll_failures;
548 /* retry counter for PSM entries */
549 u8 psm_entry_retry;
551 /* in dBm */
552 int power_level;
554 int rssi_thold;
555 int last_rssi_event;
557 struct wl1271_stats stats;
559 __le32 buffer_32;
560 u32 buffer_cmd;
561 u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
563 struct wl12xx_fw_status *fw_status;
564 struct wl1271_tx_hw_res_if *tx_res_if;
566 struct ieee80211_vif *vif;
568 /* Current chipset configuration */
569 struct conf_drv_settings conf;
571 bool sg_enabled;
573 bool enable_11a;
575 struct list_head list;
577 /* Most recently reported noise in dBm */
578 s8 noise;
580 /* map for HLIDs of associated stations - when operating in AP mode */
581 unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
583 /* recoreded keys for AP-mode - set here before AP startup */
584 struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
586 /* bands supported by this instance of wl12xx */
587 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
589 /* RX BA constraint value */
590 bool ba_support;
591 u8 ba_rx_bitmap;
592 bool ba_allowed;
594 int tcxo_clock;
597 * wowlan trigger was configured during suspend.
598 * (currently, only "ANY" trigger is supported)
600 bool wow_enabled;
601 bool irq_wake_enabled;
604 * AP-mode - links indexed by HLID. The global and broadcast links
605 * are always active.
607 struct wl1271_link links[AP_MAX_LINKS];
609 /* the hlid of the link where the last transmitted skb came from */
610 int last_tx_hlid;
612 /* AP-mode - a bitmap of links currently in PS mode according to FW */
613 u32 ap_fw_ps_map;
615 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
616 unsigned long ap_ps_map;
618 /* Quirks of specific hardware revisions */
619 unsigned int quirks;
621 /* Platform limitations */
622 unsigned int platform_quirks;
624 /* number of currently active RX BA sessions */
625 int ba_rx_session_count;
628 struct wl1271_station {
629 u8 hlid;
632 int wl1271_plt_start(struct wl1271 *wl);
633 int wl1271_plt_stop(struct wl1271 *wl);
634 int wl1271_recalc_rx_streaming(struct wl1271 *wl);
635 void wl12xx_queue_recovery_work(struct wl1271 *wl);
636 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
638 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
640 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
642 #define WL1271_DEFAULT_POWER_LEVEL 0
644 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
645 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
647 #define WL1271_DEFERRED_QUEUE_LIMIT 64
649 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
650 on in case is has been shut down shortly before */
651 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
652 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
654 /* Macros to handle wl1271.sta_rate_set */
655 #define HW_BG_RATES_MASK 0xffff
656 #define HW_HT_RATES_OFFSET 16
658 /* Quirks */
660 /* Each RX/TX transaction requires an end-of-transaction transfer */
661 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)
663 /* WL128X requires aggregated packets to be aligned to the SDIO block size */
664 #define WL12XX_QUIRK_BLOCKSIZE_ALIGNMENT BIT(2)
667 * WL127X AP mode requires Low Power DRPw (LPD) enable to reduce power
668 * consumption
670 #define WL12XX_QUIRK_LPD_MODE BIT(3)
672 /* Older firmwares did not implement the FW logger over bus feature */
673 #define WL12XX_QUIRK_FWLOG_NOT_IMPLEMENTED BIT(4)
675 #define WL12XX_HW_BLOCK_SIZE 256
677 #endif