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
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>
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
53 DEBUG_MAILBOX = BIT(3),
54 DEBUG_TESTMODE = BIT(4),
61 DEBUG_MAC80211 = BIT(11),
65 DEBUG_FILTERS = BIT(15),
66 DEBUG_ADHOC = BIT(16),
68 DEBUG_MASTER = (DEBUG_ADHOC | DEBUG_AP),
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...) \
90 if (level & wl12xx_debug_level) \
91 pr_debug(DRIVER_PREFIX fmt "\n", ##arg); \
94 /* TODO: use pr_debug_hex_dump when it will be available */
95 #define wl1271_dump(level, prefix, buf, len) \
97 if (level & wl12xx_debug_level) \
98 print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
99 DUMP_PREFIX_OFFSET, 16, 1, \
101 min_t(size_t, len, DEBUG_DUMP_LIMIT), \
105 #define wl1271_dump_ascii(level, prefix, buf, len) \
107 if (level & wl12xx_debug_level) \
108 print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
109 DUMP_PREFIX_OFFSET, 16, 1, \
111 min_t(size_t, len, DEBUG_DUMP_LIMIT), \
115 #define WL1271_DEFAULT_STA_RX_CONFIG (CFG_UNI_FILTER_EN | \
116 CFG_BSSID_FILTER_EN | \
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)
124 #define WL1271_DEFAULT_AP_RX_CONFIG 0
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 | \
133 #define WL1271_FW_NAME "ti-connectivity/wl1271-fw-2.bin"
134 #define WL128X_FW_NAME "ti-connectivity/wl128x-fw.bin"
135 #define WL1271_AP_FW_NAME "ti-connectivity/wl1271-fw-ap.bin"
138 * wl127x and wl128x are using the same NVS file name. However, the
139 * ini parameters between them are different. The driver validates
140 * the correct NVS size in wl1271_boot_upload_nvs().
142 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
144 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
145 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
147 #define WL1271_CIPHER_SUITE_GEM 0x00147201
149 #define WL1271_BUSY_WORD_CNT 1
150 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
152 #define WL1271_ELP_HW_STATE_ASLEEP 0
153 #define WL1271_ELP_HW_STATE_IRQ 1
155 #define WL1271_DEFAULT_BEACON_INT 100
156 #define WL1271_DEFAULT_DTIM_PERIOD 1
158 #define WL1271_AP_GLOBAL_HLID 0
159 #define WL1271_AP_BROADCAST_HLID 1
160 #define WL1271_AP_STA_HLID_START 2
163 * When in AP-mode, we allow (at least) this number of mem-blocks
164 * to be transmitted to FW for a STA in PS-mode. Only when packets are
165 * present in the FW buffers it will wake the sleeping STA. We want to put
166 * enough packets for the driver to transmit all of its buffered data before
167 * the STA goes to sleep again. But we don't want to take too much mem-blocks
168 * as it might hurt the throughput of active STAs.
169 * The number of blocks (18) is enough for 2 large packets.
171 #define WL1271_PS_STA_MAX_BLOCKS (2 * 9)
173 #define WL1271_AP_BSS_INDEX 0
174 #define WL1271_AP_DEF_INACTIV_SEC 300
175 #define WL1271_AP_DEF_BEACON_EXP 20
177 #define ACX_TX_DESCRIPTORS 32
179 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
187 enum wl1271_partition_type {
195 struct wl1271_partition {
200 struct wl1271_partition_set {
201 struct wl1271_partition mem;
202 struct wl1271_partition reg;
203 struct wl1271_partition mem2;
204 struct wl1271_partition mem3;
209 #define WL12XX_NUM_FW_VER 5
211 /* FIXME: I'm not sure about this structure name */
214 char fw_ver_str[ETHTOOL_BUSINFO_LEN];
215 unsigned int fw_ver[WL12XX_NUM_FW_VER];
218 struct wl1271_stats {
219 struct acx_statistics *fw_stats;
220 unsigned long fw_stats_update;
222 unsigned int retry_count;
223 unsigned int excessive_retries;
226 #define NUM_TX_QUEUES 4
227 #define NUM_RX_PKT_DESC 8
229 #define AP_MAX_STATIONS 5
231 /* Broadcast and Global links + links to stations */
232 #define AP_MAX_LINKS (AP_MAX_STATIONS + 2)
234 /* FW status registers common for AP/STA */
235 struct wl1271_fw_common_status {
240 u8 tx_results_counter;
241 __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
242 __le32 tx_released_blks[NUM_TX_QUEUES];
246 /* FW status registers for AP */
247 struct wl1271_fw_ap_status {
248 struct wl1271_fw_common_status common;
250 /* Next fields valid only in AP FW */
253 * A bitmap (where each bit represents a single HLID)
254 * to indicate if the station is in PS mode.
256 __le32 link_ps_bitmap;
258 /* Number of freed MBs per HLID */
259 u8 tx_lnk_free_blks[AP_MAX_LINKS];
263 /* FW status registers for STA */
264 struct wl1271_fw_sta_status {
265 struct wl1271_fw_common_status common;
272 struct wl1271_fw_full_status {
274 struct wl1271_fw_common_status common;
275 struct wl1271_fw_sta_status sta;
276 struct wl1271_fw_ap_status ap;
281 struct wl1271_rx_mem_pool_addr {
287 struct cfg80211_scan_request *req;
291 u8 ssid[IW_ESSID_MAX_SIZE+1];
295 struct wl1271_if_operations {
296 void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
298 void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
300 void (*reset)(struct wl1271 *wl);
301 void (*init)(struct wl1271 *wl);
302 int (*power)(struct wl1271 *wl, bool enable);
303 struct device* (*dev)(struct wl1271 *wl);
304 void (*enable_irq)(struct wl1271 *wl);
305 void (*disable_irq)(struct wl1271 *wl);
306 void (*set_block_size) (struct wl1271 *wl);
309 #define MAX_NUM_KEYS 14
310 #define MAX_KEY_SIZE 32
312 struct wl1271_ap_key {
316 u8 key[MAX_KEY_SIZE];
323 WL1271_FLAG_STA_ASSOCIATED,
325 WL1271_FLAG_GPIO_POWER,
326 WL1271_FLAG_TX_QUEUE_STOPPED,
327 WL1271_FLAG_TX_PENDING,
330 WL1271_FLAG_PSM_REQUESTED,
331 WL1271_FLAG_IRQ_RUNNING,
333 WL1271_FLAG_IDLE_REQUESTED,
334 WL1271_FLAG_PSPOLL_FAILURE,
335 WL1271_FLAG_STA_STATE_SENT,
336 WL1271_FLAG_FW_TX_BUSY,
337 WL1271_FLAG_AP_STARTED
341 /* AP-mode - TX queue per AC in link */
342 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
344 /* accounting for allocated / available TX blocks in FW */
352 struct platform_device *plat_dev;
353 struct ieee80211_hw *hw;
354 bool mac80211_registered;
358 struct wl1271_if_operations *if_ops;
360 void (*set_power)(bool enable);
366 enum wl1271_state state;
371 struct wl1271_partition_set part;
373 struct wl1271_chip chip;
387 u8 mac_addr[ETH_ALEN];
390 u8 ssid[IW_ESSID_MAX_SIZE + 1];
394 struct wl1271_acx_mem_map *target_mem_map;
396 /* Accounting for allocated / available TX blocks on HW */
397 u32 tx_blocks_freed[NUM_TX_QUEUES];
398 u32 tx_blocks_available;
399 u32 tx_results_count;
401 /* Transmitted TX packets counter for chipset interface */
402 u32 tx_packets_count;
404 /* Time-offset between host and chipset clocks */
407 /* Session counter for the chipset */
410 /* Frames scheduled for transmission, not handled yet */
411 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
414 /* Frames received, not handled yet by mac80211 */
415 struct sk_buff_head deferred_rx_queue;
417 /* Frames sent, not returned yet to mac80211 */
418 struct sk_buff_head deferred_tx_queue;
420 struct work_struct tx_work;
422 /* Pending TX frames */
423 unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
424 struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
427 /* Security sequence number counters */
428 u8 tx_security_last_seq;
434 /* Rx memory pool address */
435 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
437 /* Intermediate buffer, used for packet aggregation */
440 /* Network stack work */
441 struct work_struct netstack_work;
443 /* Hardware recovery work */
444 struct work_struct recovery_work;
446 /* The mbox event mask */
449 /* Mailbox pointers */
452 /* Are we currently scanning */
453 struct wl1271_scan scan;
454 struct delayed_work scan_complete_work;
456 /* probe-req template for the current AP */
457 struct sk_buff *probereq;
459 /* Our association ID */
463 * currently configured rate set:
464 * bits 0-15 - 802.11abg rates
465 * bits 16-23 - 802.11n MCS index mask
466 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
472 /* The current band */
473 enum ieee80211_band band;
475 /* Beaconing interval (needed for ad-hoc) */
478 /* Default key (for WEP) */
481 unsigned int filters;
482 unsigned int rx_config;
483 unsigned int rx_filter;
485 struct completion *elp_compl;
486 struct delayed_work elp_work;
487 struct delayed_work pspoll_work;
489 /* counter for ps-poll delivery failures */
490 int ps_poll_failures;
492 /* retry counter for PSM entries */
501 struct wl1271_stats stats;
505 u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
507 struct wl1271_fw_full_status *fw_status;
508 struct wl1271_tx_hw_res_if *tx_res_if;
510 struct ieee80211_vif *vif;
512 /* Current chipset configuration */
513 struct conf_drv_settings conf;
519 struct list_head list;
521 /* Most recently reported noise in dBm */
524 /* map for HLIDs of associated stations - when operating in AP mode */
525 unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
527 /* recoreded keys for AP-mode - set here before AP startup */
528 struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
530 /* bands supported by this instance of wl12xx */
531 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
533 /* RX BA constraint value */
541 * AP-mode - links indexed by HLID. The global and broadcast links
544 struct wl1271_link links[AP_MAX_LINKS];
546 /* the hlid of the link where the last transmitted skb came from */
549 /* AP-mode - a bitmap of links currently in PS mode according to FW */
552 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
553 unsigned long ap_ps_map;
555 /* Quirks of specific hardware revisions */
559 struct wl1271_station {
563 int wl1271_plt_start(struct wl1271 *wl);
564 int wl1271_plt_stop(struct wl1271 *wl);
566 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
568 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
570 #define WL1271_DEFAULT_POWER_LEVEL 0
572 #define WL1271_TX_QUEUE_LOW_WATERMARK 10
573 #define WL1271_TX_QUEUE_HIGH_WATERMARK 25
575 #define WL1271_DEFERRED_QUEUE_LIMIT 64
577 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
578 on in case is has been shut down shortly before */
579 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
580 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
582 /* Macros to handle wl1271.sta_rate_set */
583 #define HW_BG_RATES_MASK 0xffff
584 #define HW_HT_RATES_OFFSET 16
588 /* Each RX/TX transaction requires an end-of-transaction transfer */
589 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)