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 WL127X_AP_FW_NAME "ti-connectivity/wl1271-fw-ap.bin"
136 #define WL128X_AP_FW_NAME "ti-connectivity/wl128x-fw-ap.bin"
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().
143 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
145 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
146 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
148 #define WL1271_CIPHER_SUITE_GEM 0x00147201
150 #define WL1271_BUSY_WORD_CNT 1
151 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
153 #define WL1271_ELP_HW_STATE_ASLEEP 0
154 #define WL1271_ELP_HW_STATE_IRQ 1
156 #define WL1271_DEFAULT_BEACON_INT 100
157 #define WL1271_DEFAULT_DTIM_PERIOD 1
159 #define WL1271_AP_GLOBAL_HLID 0
160 #define WL1271_AP_BROADCAST_HLID 1
161 #define WL1271_AP_STA_HLID_START 2
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.
172 #define WL1271_PS_STA_MAX_BLOCKS (2 * 9)
174 #define WL1271_AP_BSS_INDEX 0
175 #define WL1271_AP_DEF_INACTIV_SEC 300
176 #define WL1271_AP_DEF_BEACON_EXP 20
178 #define ACX_TX_DESCRIPTORS 32
180 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
188 enum wl1271_partition_type {
196 struct wl1271_partition {
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;
220 #define FW_VER_CHIP_WL127X 6
221 #define FW_VER_CHIP_WL128X 7
223 #define FW_VER_IF_TYPE_STA 1
224 #define FW_VER_IF_TYPE_AP 2
226 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
227 #define FW_VER_MINOR_1_SPARE_AP_MIN 47
229 #define FW_VER_MINOR_FWLOG_STA_MIN 70
233 char fw_ver_str[ETHTOOL_BUSINFO_LEN];
234 unsigned int fw_ver[NUM_FW_VER];
237 struct wl1271_stats {
238 struct acx_statistics *fw_stats;
239 unsigned long fw_stats_update;
241 unsigned int retry_count;
242 unsigned int excessive_retries;
245 #define NUM_TX_QUEUES 4
246 #define NUM_RX_PKT_DESC 8
248 #define AP_MAX_STATIONS 5
250 /* Broadcast and Global links + links to stations */
251 #define AP_MAX_LINKS (AP_MAX_STATIONS + 2)
253 /* FW status registers common for AP/STA */
254 struct wl1271_fw_common_status {
259 u8 tx_results_counter;
260 __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
261 __le32 tx_released_blks[NUM_TX_QUEUES];
265 /* FW status registers for AP */
266 struct wl1271_fw_ap_status {
267 struct wl1271_fw_common_status common;
269 /* Next fields valid only in AP FW */
272 * A bitmap (where each bit represents a single HLID)
273 * to indicate if the station is in PS mode.
275 __le32 link_ps_bitmap;
277 /* Number of freed MBs per HLID */
278 u8 tx_lnk_free_blks[AP_MAX_LINKS];
282 /* FW status registers for STA */
283 struct wl1271_fw_sta_status {
284 struct wl1271_fw_common_status common;
289 __le32 log_start_addr;
292 struct wl1271_fw_full_status {
294 struct wl1271_fw_common_status common;
295 struct wl1271_fw_sta_status sta;
296 struct wl1271_fw_ap_status ap;
301 struct wl1271_rx_mem_pool_addr {
306 #define WL1271_MAX_CHANNELS 64
308 struct cfg80211_scan_request *req;
309 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
312 u8 ssid[IW_ESSID_MAX_SIZE+1];
316 struct wl1271_if_operations {
317 void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
319 void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
321 void (*reset)(struct wl1271 *wl);
322 void (*init)(struct wl1271 *wl);
323 int (*power)(struct wl1271 *wl, bool enable);
324 struct device* (*dev)(struct wl1271 *wl);
325 void (*enable_irq)(struct wl1271 *wl);
326 void (*disable_irq)(struct wl1271 *wl);
327 void (*set_block_size) (struct wl1271 *wl, unsigned int blksz);
330 #define MAX_NUM_KEYS 14
331 #define MAX_KEY_SIZE 32
333 struct wl1271_ap_key {
337 u8 key[MAX_KEY_SIZE];
344 WL1271_FLAG_STA_ASSOCIATED,
346 WL1271_FLAG_GPIO_POWER,
347 WL1271_FLAG_TX_QUEUE_STOPPED,
348 WL1271_FLAG_TX_PENDING,
350 WL1271_FLAG_ELP_REQUESTED,
352 WL1271_FLAG_PSM_REQUESTED,
353 WL1271_FLAG_IRQ_RUNNING,
355 WL1271_FLAG_PSPOLL_FAILURE,
356 WL1271_FLAG_STA_STATE_SENT,
357 WL1271_FLAG_FW_TX_BUSY,
358 WL1271_FLAG_AP_STARTED,
359 WL1271_FLAG_IF_INITIALIZED,
360 WL1271_FLAG_DUMMY_PACKET_PENDING,
361 WL1271_FLAG_SUSPENDED,
362 WL1271_FLAG_PENDING_WORK,
363 WL1271_FLAG_SOFT_GEMINI,
364 WL1271_FLAG_RX_STREAMING_STARTED,
365 WL1271_FLAG_RECOVERY_IN_PROGRESS,
369 /* AP-mode - TX queue per AC in link */
370 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
372 /* accounting for allocated / available TX blocks in FW */
380 struct platform_device *plat_dev;
381 struct ieee80211_hw *hw;
382 bool mac80211_registered;
386 struct wl1271_if_operations *if_ops;
388 void (*set_power)(bool enable);
394 enum wl1271_state state;
399 struct wl1271_partition_set part;
401 struct wl1271_chip chip;
415 u8 mac_addr[ETH_ALEN];
418 u8 ssid[IW_ESSID_MAX_SIZE + 1];
422 struct wl1271_acx_mem_map *target_mem_map;
424 /* Accounting for allocated / available TX blocks on HW */
425 u32 tx_blocks_freed[NUM_TX_QUEUES];
426 u32 tx_blocks_available;
427 u32 tx_allocated_blocks;
428 u32 tx_results_count;
430 /* Transmitted TX packets counter for chipset interface */
431 u32 tx_packets_count;
433 /* Time-offset between host and chipset clocks */
436 /* Session counter for the chipset */
439 /* Frames scheduled for transmission, not handled yet */
440 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
443 /* Frames received, not handled yet by mac80211 */
444 struct sk_buff_head deferred_rx_queue;
446 /* Frames sent, not returned yet to mac80211 */
447 struct sk_buff_head deferred_tx_queue;
449 struct work_struct tx_work;
450 struct workqueue_struct *freezable_wq;
452 /* Pending TX frames */
453 unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
454 struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
457 /* Security sequence number counters */
458 u8 tx_security_last_seq;
464 /* Rx memory pool address */
465 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
467 /* Intermediate buffer, used for packet aggregation */
470 /* Reusable dummy packet template */
471 struct sk_buff *dummy_packet;
473 /* Network stack work */
474 struct work_struct netstack_work;
479 /* Number of valid bytes in the FW log buffer */
482 /* Sysfs FW log entry readers wait queue */
483 wait_queue_head_t fwlog_waitq;
485 /* Hardware recovery work */
486 struct work_struct recovery_work;
488 /* The mbox event mask */
491 /* Mailbox pointers */
494 /* Are we currently scanning */
495 struct wl1271_scan scan;
496 struct delayed_work scan_complete_work;
500 /* probe-req template for the current AP */
501 struct sk_buff *probereq;
503 /* Our association ID */
507 * currently configured rate set:
508 * bits 0-15 - 802.11abg rates
509 * bits 16-23 - 802.11n MCS index mask
510 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
516 /* The current band */
517 enum ieee80211_band band;
519 /* Beaconing interval (needed for ad-hoc) */
522 /* Default key (for WEP) */
526 struct work_struct rx_streaming_enable_work;
527 struct work_struct rx_streaming_disable_work;
528 struct timer_list rx_streaming_timer;
530 unsigned int filters;
531 unsigned int rx_config;
532 unsigned int rx_filter;
534 struct completion *elp_compl;
535 struct completion *ps_compl;
536 struct delayed_work elp_work;
537 struct delayed_work pspoll_work;
539 /* counter for ps-poll delivery failures */
540 int ps_poll_failures;
542 /* retry counter for PSM entries */
551 struct wl1271_stats stats;
555 u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
557 struct wl1271_fw_full_status *fw_status;
558 struct wl1271_tx_hw_res_if *tx_res_if;
560 struct ieee80211_vif *vif;
562 /* Current chipset configuration */
563 struct conf_drv_settings conf;
569 struct list_head list;
571 /* Most recently reported noise in dBm */
574 /* map for HLIDs of associated stations - when operating in AP mode */
575 unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
577 /* recoreded keys for AP-mode - set here before AP startup */
578 struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
580 /* bands supported by this instance of wl12xx */
581 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
583 /* RX BA constraint value */
591 * wowlan trigger was configured during suspend.
592 * (currently, only "ANY" trigger is supported)
595 bool irq_wake_enabled;
598 * AP-mode - links indexed by HLID. The global and broadcast links
601 struct wl1271_link links[AP_MAX_LINKS];
603 /* the hlid of the link where the last transmitted skb came from */
606 /* AP-mode - a bitmap of links currently in PS mode according to FW */
609 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
610 unsigned long ap_ps_map;
612 /* Quirks of specific hardware revisions */
615 /* Platform limitations */
616 unsigned int platform_quirks;
619 struct wl1271_station {
623 int wl1271_plt_start(struct wl1271 *wl);
624 int wl1271_plt_stop(struct wl1271 *wl);
625 int wl1271_recalc_rx_streaming(struct wl1271 *wl);
626 void wl12xx_queue_recovery_work(struct wl1271 *wl);
627 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
629 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
631 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
633 #define WL1271_DEFAULT_POWER_LEVEL 0
635 #define WL1271_TX_QUEUE_LOW_WATERMARK 10
636 #define WL1271_TX_QUEUE_HIGH_WATERMARK 25
638 #define WL1271_DEFERRED_QUEUE_LIMIT 64
640 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
641 on in case is has been shut down shortly before */
642 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
643 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
645 /* Macros to handle wl1271.sta_rate_set */
646 #define HW_BG_RATES_MASK 0xffff
647 #define HW_HT_RATES_OFFSET 16
651 /* Each RX/TX transaction requires an end-of-transaction transfer */
652 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)
655 * Older firmwares use 2 spare TX blocks
656 * (for STA < 6.1.3.50.58 or for AP < 6.2.0.0.47)
658 #define WL12XX_QUIRK_USE_2_SPARE_BLOCKS BIT(1)
660 /* WL128X requires aggregated packets to be aligned to the SDIO block size */
661 #define WL12XX_QUIRK_BLOCKSIZE_ALIGNMENT BIT(2)
664 * WL127X AP mode requires Low Power DRPw (LPD) enable to reduce power
667 #define WL12XX_QUIRK_LPD_MODE BIT(3)
669 /* Older firmwares did not implement the FW logger over bus feature */
670 #define WL12XX_QUIRK_FWLOG_NOT_IMPLEMENTED BIT(4)
672 #define WL12XX_HW_BLOCK_SIZE 256