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 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 12
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)
177 enum wl1271_partition_type {
185 struct wl1271_partition {
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;
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
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 8
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 + WL1271_AP_STA_HLID_START)
246 /* FW status registers */
247 struct wl12xx_fw_status {
252 u8 tx_results_counter;
253 __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
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 */
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;
283 __le32 log_start_addr;
286 struct wl1271_rx_mem_pool_addr {
291 #define WL1271_MAX_CHANNELS 64
293 struct cfg80211_scan_request *req;
294 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
297 u8 ssid[IEEE80211_MAX_SSID_LEN+1];
301 struct wl1271_if_operations {
302 void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
304 void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
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 {
322 u8 key[MAX_KEY_SIZE];
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,
335 WL1271_FLAG_ELP_REQUESTED,
337 WL1271_FLAG_PSM_REQUESTED,
338 WL1271_FLAG_IRQ_RUNNING,
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,
351 WL1271_FLAG_CS_PROGRESS,
355 /* AP-mode - TX queue per AC in link */
356 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
358 /* accounting for allocated / freed packets in FW */
364 /* bitmap of TIDs where RX BA sessions are active for this link */
369 struct platform_device *plat_dev;
370 struct ieee80211_hw *hw;
371 bool mac80211_registered;
375 struct wl1271_if_operations *if_ops;
377 void (*set_power)(bool enable);
383 enum wl1271_state state;
388 struct wl1271_partition_set part;
390 struct wl1271_chip chip;
403 u8 mac_addr[ETH_ALEN];
406 u8 p2p; /* we are using p2p role */
407 u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
418 unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
419 unsigned long roles_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
420 unsigned long roc_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
422 struct wl1271_acx_mem_map *target_mem_map;
424 /* Accounting for allocated / available TX blocks on HW */
426 u32 tx_blocks_available;
427 u32 tx_allocated_blocks;
428 u32 tx_results_count;
430 /* amount of spare TX blocks to use */
433 /* Accounting for allocated / available Tx packets in HW */
434 u32 tx_pkts_freed[NUM_TX_QUEUES];
435 u32 tx_allocated_pkts[NUM_TX_QUEUES];
437 /* Transmitted TX packets counter for chipset interface */
438 u32 tx_packets_count;
440 /* Time-offset between host and chipset clocks */
443 /* Session counter for the chipset */
446 /* Frames scheduled for transmission, not handled yet */
447 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
448 int tx_queue_count[NUM_TX_QUEUES];
449 long stopped_queues_map;
451 /* Frames received, not handled yet by mac80211 */
452 struct sk_buff_head deferred_rx_queue;
454 /* Frames sent, not returned yet to mac80211 */
455 struct sk_buff_head deferred_tx_queue;
457 struct work_struct tx_work;
458 struct workqueue_struct *freezable_wq;
460 /* Pending TX frames */
461 unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
462 struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
466 * Security sequence number
467 * bits 0-15: lower 16 bits part of sequence number
468 * bits 16-47: higher 32 bits part of sequence number
469 * bits 48-63: not in use
473 /* 8 bits of the last sequence number in use */
474 u8 tx_security_last_seq_lsb;
479 /* Rx memory pool address */
480 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
482 /* Intermediate buffer, used for packet aggregation */
485 /* Reusable dummy packet template */
486 struct sk_buff *dummy_packet;
488 /* Network stack work */
489 struct work_struct netstack_work;
494 /* Number of valid bytes in the FW log buffer */
497 /* Sysfs FW log entry readers wait queue */
498 wait_queue_head_t fwlog_waitq;
500 /* Hardware recovery work */
501 struct work_struct recovery_work;
503 /* The mbox event mask */
506 /* Mailbox pointers */
509 /* Are we currently scanning */
510 struct wl1271_scan scan;
511 struct delayed_work scan_complete_work;
515 /* probe-req template for the current AP */
516 struct sk_buff *probereq;
518 /* Our association ID */
522 * currently configured rate set:
523 * bits 0-15 - 802.11abg rates
524 * bits 16-23 - 802.11n MCS index mask
525 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
530 u32 bitrate_masks[IEEE80211_NUM_BANDS];
532 /* The current band */
533 enum ieee80211_band band;
535 /* Beaconing interval (needed for ad-hoc) */
538 /* Default key (for WEP) */
542 struct work_struct rx_streaming_enable_work;
543 struct work_struct rx_streaming_disable_work;
544 struct timer_list rx_streaming_timer;
546 struct completion *elp_compl;
547 struct completion *ps_compl;
548 struct delayed_work elp_work;
549 struct delayed_work pspoll_work;
551 /* counter for ps-poll delivery failures */
552 int ps_poll_failures;
554 /* retry counter for PSM entries */
563 struct wl1271_stats stats;
567 u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
569 struct wl12xx_fw_status *fw_status;
570 struct wl1271_tx_hw_res_if *tx_res_if;
572 struct ieee80211_vif *vif;
574 /* Current chipset configuration */
575 struct conf_drv_settings conf;
581 struct list_head list;
583 /* Most recently reported noise in dBm */
586 /* map for HLIDs of associated stations - when operating in AP mode */
587 unsigned long ap_hlid_map[BITS_TO_LONGS(AP_MAX_STATIONS)];
589 /* recoreded keys for AP-mode - set here before AP startup */
590 struct wl1271_ap_key *recorded_ap_keys[MAX_NUM_KEYS];
592 /* bands supported by this instance of wl12xx */
593 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
595 /* RX BA constraint value */
603 * wowlan trigger was configured during suspend.
604 * (currently, only "ANY" trigger is supported)
607 bool irq_wake_enabled;
610 * AP-mode - links indexed by HLID. The global and broadcast links
613 struct wl1271_link links[AP_MAX_LINKS];
615 /* the hlid of the link where the last transmitted skb came from */
618 /* AP-mode - a bitmap of links currently in PS mode according to FW */
621 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
622 unsigned long ap_ps_map;
624 /* Quirks of specific hardware revisions */
627 /* Platform limitations */
628 unsigned int platform_quirks;
630 /* number of currently active RX BA sessions */
631 int ba_rx_session_count;
633 /* AP-mode - number of currently connected stations */
634 int active_sta_count;
637 struct wl1271_station {
641 int wl1271_plt_start(struct wl1271 *wl);
642 int wl1271_plt_stop(struct wl1271 *wl);
643 int wl1271_recalc_rx_streaming(struct wl1271 *wl);
644 void wl12xx_queue_recovery_work(struct wl1271 *wl);
645 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
647 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
649 #define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
651 #define WL1271_DEFAULT_POWER_LEVEL 0
653 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
654 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
656 #define WL1271_DEFERRED_QUEUE_LIMIT 64
658 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
659 on in case is has been shut down shortly before */
660 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
661 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
663 /* Macros to handle wl1271.sta_rate_set */
664 #define HW_BG_RATES_MASK 0xffff
665 #define HW_HT_RATES_OFFSET 16
669 /* Each RX/TX transaction requires an end-of-transaction transfer */
670 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)
672 /* WL128X requires aggregated packets to be aligned to the SDIO block size */
673 #define WL12XX_QUIRK_BLOCKSIZE_ALIGNMENT BIT(2)
676 * WL127X AP mode requires Low Power DRPw (LPD) enable to reduce power
679 #define WL12XX_QUIRK_LPD_MODE BIT(3)
681 /* Older firmwares did not implement the FW logger over bus feature */
682 #define WL12XX_QUIRK_FWLOG_NOT_IMPLEMENTED BIT(4)
684 #define WL12XX_HW_BLOCK_SIZE 256