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 * When in AP-mode, we allow (at least) this number of packets
150 * to be transmitted to FW for a STA in PS-mode. Only when packets are
151 * present in the FW buffers it will wake the sleeping STA. We want to put
152 * enough packets for the driver to transmit all of its buffered data before
153 * the STA goes to sleep again. But we don't want to take too much memory
154 * as it might hurt the throughput of active STAs.
156 #define WL1271_PS_STA_MAX_PACKETS 2
158 #define WL1271_AP_BSS_INDEX 0
159 #define WL1271_AP_DEF_BEACON_EXP 20
161 #define ACX_TX_DESCRIPTORS 16
163 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
171 enum wl1271_partition_type
{
179 struct wl1271_partition
{
184 struct wl1271_partition_set
{
185 struct wl1271_partition mem
;
186 struct wl1271_partition reg
;
187 struct wl1271_partition mem2
;
188 struct wl1271_partition mem3
;
203 #define FW_VER_CHIP_WL127X 6
204 #define FW_VER_CHIP_WL128X 7
206 #define FW_VER_IF_TYPE_STA 1
207 #define FW_VER_IF_TYPE_AP 2
209 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
210 #define FW_VER_MINOR_1_SPARE_AP_MIN 47
212 #define FW_VER_MINOR_FWLOG_STA_MIN 70
216 char fw_ver_str
[ETHTOOL_BUSINFO_LEN
];
217 unsigned int fw_ver
[NUM_FW_VER
];
220 struct wl1271_stats
{
221 struct acx_statistics
*fw_stats
;
222 unsigned long fw_stats_update
;
224 unsigned int retry_count
;
225 unsigned int excessive_retries
;
228 #define NUM_TX_QUEUES 4
229 #define NUM_RX_PKT_DESC 8
231 #define AP_MAX_STATIONS 8
233 /* FW status registers */
234 struct wl12xx_fw_status
{
239 u8 tx_results_counter
;
240 __le32 rx_pkt_descs
[NUM_RX_PKT_DESC
];
244 * A bitmap (where each bit represents a single HLID)
245 * to indicate if the station is in PS mode.
247 __le32 link_ps_bitmap
;
250 * A bitmap (where each bit represents a single HLID) to indicate
251 * if the station is in Fast mode
253 __le32 link_fast_bitmap
;
255 /* Cumulative counter of total released mem blocks since FW-reset */
256 __le32 total_released_blks
;
258 /* Size (in Memory Blocks) of TX pool */
261 /* Cumulative counter of released packets per AC */
262 u8 tx_released_pkts
[NUM_TX_QUEUES
];
264 /* Cumulative counter of freed packets per HLID */
265 u8 tx_lnk_free_pkts
[WL12XX_MAX_LINKS
];
267 /* Cumulative counter of released Voice memory blocks */
268 u8 tx_voice_released_blks
;
270 __le32 log_start_addr
;
273 struct wl1271_rx_mem_pool_addr
{
278 #define WL1271_MAX_CHANNELS 64
280 struct cfg80211_scan_request
*req
;
281 unsigned long scanned_ch
[BITS_TO_LONGS(WL1271_MAX_CHANNELS
)];
284 u8 ssid
[IEEE80211_MAX_SSID_LEN
+1];
288 struct wl1271_if_operations
{
289 void (*read
)(struct wl1271
*wl
, int addr
, void *buf
, size_t len
,
291 void (*write
)(struct wl1271
*wl
, int addr
, void *buf
, size_t len
,
293 void (*reset
)(struct wl1271
*wl
);
294 void (*init
)(struct wl1271
*wl
);
295 int (*power
)(struct wl1271
*wl
, bool enable
);
296 struct device
* (*dev
)(struct wl1271
*wl
);
297 void (*enable_irq
)(struct wl1271
*wl
);
298 void (*disable_irq
)(struct wl1271
*wl
);
299 void (*set_block_size
) (struct wl1271
*wl
, unsigned int blksz
);
302 #define MAX_NUM_KEYS 14
303 #define MAX_KEY_SIZE 32
305 struct wl1271_ap_key
{
309 u8 key
[MAX_KEY_SIZE
];
316 WL1271_FLAG_GPIO_POWER
,
317 WL1271_FLAG_TX_QUEUE_STOPPED
,
318 WL1271_FLAG_TX_PENDING
,
320 WL1271_FLAG_ELP_REQUESTED
,
321 WL1271_FLAG_IRQ_RUNNING
,
323 WL1271_FLAG_FW_TX_BUSY
,
324 WL1271_FLAG_DUMMY_PACKET_PENDING
,
325 WL1271_FLAG_SUSPENDED
,
326 WL1271_FLAG_PENDING_WORK
,
327 WL1271_FLAG_SOFT_GEMINI
,
328 WL1271_FLAG_RECOVERY_IN_PROGRESS
,
331 enum wl12xx_vif_flags
{
332 WLVIF_FLAG_INITIALIZED
,
333 WLVIF_FLAG_STA_ASSOCIATED
,
334 WLVIF_FLAG_IBSS_JOINED
,
335 WLVIF_FLAG_AP_STARTED
,
337 WLVIF_FLAG_PSM_REQUESTED
,
338 WLVIF_FLAG_STA_STATE_SENT
,
339 WLVIF_FLAG_RX_STREAMING_STARTED
,
340 WLVIF_FLAG_PSPOLL_FAILURE
,
341 WLVIF_FLAG_CS_PROGRESS
,
345 /* AP-mode - TX queue per AC in link */
346 struct sk_buff_head tx_queue
[NUM_TX_QUEUES
];
348 /* accounting for allocated / freed packets in FW */
354 /* bitmap of TIDs where RX BA sessions are active for this link */
359 struct platform_device
*plat_dev
;
360 struct ieee80211_hw
*hw
;
361 bool mac80211_registered
;
365 struct wl1271_if_operations
*if_ops
;
367 void (*set_power
)(bool enable
);
373 enum wl1271_state state
;
378 struct wl1271_partition_set part
;
380 struct wl1271_chip chip
;
392 u8 mac_addr
[ETH_ALEN
];
396 unsigned long links_map
[BITS_TO_LONGS(WL12XX_MAX_LINKS
)];
397 unsigned long roles_map
[BITS_TO_LONGS(WL12XX_MAX_ROLES
)];
398 unsigned long roc_map
[BITS_TO_LONGS(WL12XX_MAX_ROLES
)];
400 struct list_head wlvif_list
;
404 struct wl1271_acx_mem_map
*target_mem_map
;
406 /* Accounting for allocated / available TX blocks on HW */
408 u32 tx_blocks_available
;
409 u32 tx_allocated_blocks
;
410 u32 tx_results_count
;
412 /* amount of spare TX blocks to use */
415 /* Accounting for allocated / available Tx packets in HW */
416 u32 tx_pkts_freed
[NUM_TX_QUEUES
];
417 u32 tx_allocated_pkts
[NUM_TX_QUEUES
];
419 /* Transmitted TX packets counter for chipset interface */
420 u32 tx_packets_count
;
422 /* Time-offset between host and chipset clocks */
425 /* Frames scheduled for transmission, not handled yet */
426 int tx_queue_count
[NUM_TX_QUEUES
];
427 long stopped_queues_map
;
429 /* Frames received, not handled yet by mac80211 */
430 struct sk_buff_head deferred_rx_queue
;
432 /* Frames sent, not returned yet to mac80211 */
433 struct sk_buff_head deferred_tx_queue
;
435 struct work_struct tx_work
;
436 struct workqueue_struct
*freezable_wq
;
438 /* Pending TX frames */
439 unsigned long tx_frames_map
[BITS_TO_LONGS(ACX_TX_DESCRIPTORS
)];
440 struct sk_buff
*tx_frames
[ACX_TX_DESCRIPTORS
];
446 /* Rx memory pool address */
447 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr
;
449 /* Intermediate buffer, used for packet aggregation */
452 /* Reusable dummy packet template */
453 struct sk_buff
*dummy_packet
;
455 /* Network stack work */
456 struct work_struct netstack_work
;
461 /* Number of valid bytes in the FW log buffer */
464 /* Sysfs FW log entry readers wait queue */
465 wait_queue_head_t fwlog_waitq
;
467 /* Hardware recovery work */
468 struct work_struct recovery_work
;
470 /* The mbox event mask */
473 /* Mailbox pointers */
476 /* Are we currently scanning */
477 struct ieee80211_vif
*scan_vif
;
478 struct wl1271_scan scan
;
479 struct delayed_work scan_complete_work
;
483 /* The current band */
484 enum ieee80211_band band
;
486 struct completion
*elp_compl
;
487 struct delayed_work elp_work
;
492 struct wl1271_stats stats
;
496 u32 buffer_busyword
[WL1271_BUSY_WORD_CNT
];
498 struct wl12xx_fw_status
*fw_status
;
499 struct wl1271_tx_hw_res_if
*tx_res_if
;
501 struct ieee80211_vif
*vif
;
503 /* Current chipset configuration */
504 struct conf_drv_settings conf
;
510 struct list_head list
;
512 /* Most recently reported noise in dBm */
515 /* bands supported by this instance of wl12xx */
516 struct ieee80211_supported_band bands
[IEEE80211_NUM_BANDS
];
521 * wowlan trigger was configured during suspend.
522 * (currently, only "ANY" trigger is supported)
525 bool irq_wake_enabled
;
528 * AP-mode - links indexed by HLID. The global and broadcast links
531 struct wl1271_link links
[WL12XX_MAX_LINKS
];
533 /* AP-mode - a bitmap of links currently in PS mode according to FW */
536 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
537 unsigned long ap_ps_map
;
539 /* Quirks of specific hardware revisions */
542 /* Platform limitations */
543 unsigned int platform_quirks
;
545 /* number of currently active RX BA sessions */
546 int ba_rx_session_count
;
548 /* AP-mode - number of currently connected stations */
549 int active_sta_count
;
552 struct wl1271_station
{
558 struct list_head list
;
561 u8 p2p
; /* we are using p2p role */
564 /* sta/ibss specific */
577 /* HLIDs bitmap of associated stations */
578 unsigned long sta_hlid_map
[BITS_TO_LONGS(
581 /* recoreded keys - set here before AP startup */
582 struct wl1271_ap_key
*recorded_keys
[MAX_NUM_KEYS
];
586 /* the hlid of the last transmitted skb */
589 unsigned long links_map
[BITS_TO_LONGS(WL12XX_MAX_LINKS
)];
591 u8 ssid
[IEEE80211_MAX_SSID_LEN
+ 1];
594 u32 bitrate_masks
[IEEE80211_NUM_BANDS
];
598 * currently configured rate set:
599 * bits 0-15 - 802.11abg rates
600 * bits 16-23 - 802.11n MCS index mask
601 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
606 /* probe-req template for the current AP */
607 struct sk_buff
*probereq
;
609 /* Beaconing interval (needed for ad-hoc) */
612 /* Default key (for WEP) */
615 /* Our association ID */
618 /* Session counter for the chipset */
621 struct completion
*ps_compl
;
622 struct delayed_work pspoll_work
;
624 /* counter for ps-poll delivery failures */
625 int ps_poll_failures
;
627 /* retry counter for PSM entries */
633 /* RX BA constraint value */
638 struct work_struct rx_streaming_enable_work
;
639 struct work_struct rx_streaming_disable_work
;
640 struct timer_list rx_streaming_timer
;
643 * This struct must be last!
644 * data that has to be saved acrossed reconfigs (e.g. recovery)
645 * should be declared in this struct.
650 * Security sequence number
651 * bits 0-15: lower 16 bits part of sequence number
652 * bits 16-47: higher 32 bits part of sequence number
653 * bits 48-63: not in use
657 /* 8 bits of the last sequence number in use */
658 u8 tx_security_last_seq_lsb
;
662 static inline struct wl12xx_vif
*wl12xx_vif_to_data(struct ieee80211_vif
*vif
)
664 return (struct wl12xx_vif
*)vif
->drv_priv
;
668 struct ieee80211_vif
*wl12xx_wlvif_to_vif(struct wl12xx_vif
*wlvif
)
670 return container_of((void *)wlvif
, struct ieee80211_vif
, drv_priv
);
673 #define wl12xx_for_each_wlvif(wl, wlvif) \
674 list_for_each_entry(wlvif, &wl->wlvif_list, list)
676 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
677 wl12xx_for_each_wlvif(wl, wlvif) \
678 if (wlvif->bss_type == _bss_type)
680 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
681 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
683 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
684 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
686 int wl1271_plt_start(struct wl1271
*wl
);
687 int wl1271_plt_stop(struct wl1271
*wl
);
688 int wl1271_recalc_rx_streaming(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
689 void wl12xx_queue_recovery_work(struct wl1271
*wl
);
690 size_t wl12xx_copy_fwlog(struct wl1271
*wl
, u8
*memblock
, size_t maxlen
);
692 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
694 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
695 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
697 #define WL1271_DEFAULT_POWER_LEVEL 0
699 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
700 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
702 #define WL1271_DEFERRED_QUEUE_LIMIT 64
704 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
705 on in case is has been shut down shortly before */
706 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
707 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
709 /* Macros to handle wl1271.sta_rate_set */
710 #define HW_BG_RATES_MASK 0xffff
711 #define HW_HT_RATES_OFFSET 16
715 /* Each RX/TX transaction requires an end-of-transaction transfer */
716 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)
718 /* WL128X requires aggregated packets to be aligned to the SDIO block size */
719 #define WL12XX_QUIRK_BLOCKSIZE_ALIGNMENT BIT(2)
721 /* Older firmwares did not implement the FW logger over bus feature */
722 #define WL12XX_QUIRK_FWLOG_NOT_IMPLEMENTED BIT(4)
724 #define WL12XX_HW_BLOCK_SIZE 256