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 WL127X_FW_NAME "ti-connectivity/wl127x-fw-3.bin"
39 #define WL128X_FW_NAME "ti-connectivity/wl128x-fw-3.bin"
42 * wl127x and wl128x are using the same NVS file name. However, the
43 * ini parameters between them are different. The driver validates
44 * the correct NVS size in wl1271_boot_upload_nvs().
46 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
48 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
49 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
50 #define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff
52 #define WL1271_CIPHER_SUITE_GEM 0x00147201
54 #define WL1271_BUSY_WORD_CNT 1
55 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
57 #define WL1271_ELP_HW_STATE_ASLEEP 0
58 #define WL1271_ELP_HW_STATE_IRQ 1
60 #define WL1271_DEFAULT_BEACON_INT 100
61 #define WL1271_DEFAULT_DTIM_PERIOD 1
63 #define WL12XX_MAX_ROLES 4
64 #define WL12XX_MAX_LINKS 12
65 #define WL12XX_INVALID_ROLE_ID 0xff
66 #define WL12XX_INVALID_LINK_ID 0xff
68 #define WL12XX_MAX_RATE_POLICIES 16
70 /* Defined by FW as 0. Will not be freed or allocated. */
71 #define WL12XX_SYSTEM_HLID 0
74 * When in AP-mode, we allow (at least) this number of packets
75 * to be transmitted to FW for a STA in PS-mode. Only when packets are
76 * present in the FW buffers it will wake the sleeping STA. We want to put
77 * enough packets for the driver to transmit all of its buffered data before
78 * the STA goes to sleep again. But we don't want to take too much memory
79 * as it might hurt the throughput of active STAs.
81 #define WL1271_PS_STA_MAX_PACKETS 2
83 #define WL1271_AP_BSS_INDEX 0
84 #define WL1271_AP_DEF_BEACON_EXP 20
86 #define ACX_TX_DESCRIPTORS 16
88 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
96 enum wl1271_partition_type
{
104 struct wl1271_partition
{
109 struct wl1271_partition_set
{
110 struct wl1271_partition mem
;
111 struct wl1271_partition reg
;
112 struct wl1271_partition mem2
;
113 struct wl1271_partition mem3
;
128 #define FW_VER_CHIP_WL127X 6
129 #define FW_VER_CHIP_WL128X 7
131 #define FW_VER_IF_TYPE_STA 1
132 #define FW_VER_IF_TYPE_AP 2
134 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
135 #define FW_VER_MINOR_1_SPARE_AP_MIN 47
137 #define FW_VER_MINOR_FWLOG_STA_MIN 70
141 char fw_ver_str
[ETHTOOL_BUSINFO_LEN
];
142 unsigned int fw_ver
[NUM_FW_VER
];
145 struct wl1271_stats
{
146 struct acx_statistics
*fw_stats
;
147 unsigned long fw_stats_update
;
149 unsigned int retry_count
;
150 unsigned int excessive_retries
;
153 #define NUM_TX_QUEUES 4
154 #define NUM_RX_PKT_DESC 8
156 #define AP_MAX_STATIONS 8
158 /* FW status registers */
159 struct wl12xx_fw_status
{
164 u8 tx_results_counter
;
165 __le32 rx_pkt_descs
[NUM_RX_PKT_DESC
];
169 * A bitmap (where each bit represents a single HLID)
170 * to indicate if the station is in PS mode.
172 __le32 link_ps_bitmap
;
175 * A bitmap (where each bit represents a single HLID) to indicate
176 * if the station is in Fast mode
178 __le32 link_fast_bitmap
;
180 /* Cumulative counter of total released mem blocks since FW-reset */
181 __le32 total_released_blks
;
183 /* Size (in Memory Blocks) of TX pool */
186 /* Cumulative counter of released packets per AC */
187 u8 tx_released_pkts
[NUM_TX_QUEUES
];
189 /* Cumulative counter of freed packets per HLID */
190 u8 tx_lnk_free_pkts
[WL12XX_MAX_LINKS
];
192 /* Cumulative counter of released Voice memory blocks */
193 u8 tx_voice_released_blks
;
195 __le32 log_start_addr
;
198 struct wl1271_rx_mem_pool_addr
{
203 #define WL1271_MAX_CHANNELS 64
205 struct cfg80211_scan_request
*req
;
206 unsigned long scanned_ch
[BITS_TO_LONGS(WL1271_MAX_CHANNELS
)];
209 u8 ssid
[IEEE80211_MAX_SSID_LEN
+1];
213 struct wl1271_if_operations
{
214 void (*read
)(struct device
*child
, int addr
, void *buf
, size_t len
,
216 void (*write
)(struct device
*child
, int addr
, void *buf
, size_t len
,
218 void (*reset
)(struct device
*child
);
219 void (*init
)(struct device
*child
);
220 int (*power
)(struct device
*child
, bool enable
);
221 void (*set_block_size
) (struct device
*child
, unsigned int blksz
);
224 #define MAX_NUM_KEYS 14
225 #define MAX_KEY_SIZE 32
227 struct wl1271_ap_key
{
231 u8 key
[MAX_KEY_SIZE
];
238 WL1271_FLAG_GPIO_POWER
,
239 WL1271_FLAG_TX_QUEUE_STOPPED
,
240 WL1271_FLAG_TX_PENDING
,
242 WL1271_FLAG_ELP_REQUESTED
,
243 WL1271_FLAG_IRQ_RUNNING
,
244 WL1271_FLAG_FW_TX_BUSY
,
245 WL1271_FLAG_DUMMY_PACKET_PENDING
,
246 WL1271_FLAG_SUSPENDED
,
247 WL1271_FLAG_PENDING_WORK
,
248 WL1271_FLAG_SOFT_GEMINI
,
249 WL1271_FLAG_RECOVERY_IN_PROGRESS
,
252 enum wl12xx_vif_flags
{
253 WLVIF_FLAG_INITIALIZED
,
254 WLVIF_FLAG_STA_ASSOCIATED
,
255 WLVIF_FLAG_IBSS_JOINED
,
256 WLVIF_FLAG_AP_STARTED
,
258 WLVIF_FLAG_PSM_REQUESTED
,
259 WLVIF_FLAG_STA_STATE_SENT
,
260 WLVIF_FLAG_RX_STREAMING_STARTED
,
261 WLVIF_FLAG_PSPOLL_FAILURE
,
262 WLVIF_FLAG_CS_PROGRESS
,
263 WLVIF_FLAG_AP_PROBE_RESP_SET
,
268 /* AP-mode - TX queue per AC in link */
269 struct sk_buff_head tx_queue
[NUM_TX_QUEUES
];
271 /* accounting for allocated / freed packets in FW */
277 /* bitmap of TIDs where RX BA sessions are active for this link */
282 struct ieee80211_hw
*hw
;
283 bool mac80211_registered
;
289 struct wl1271_if_operations
*if_ops
;
291 void (*set_power
)(bool enable
);
297 enum wl1271_state state
;
302 struct wl1271_partition_set part
;
304 struct wl1271_chip chip
;
316 u8 mac_addr
[ETH_ALEN
];
320 unsigned long links_map
[BITS_TO_LONGS(WL12XX_MAX_LINKS
)];
321 unsigned long roles_map
[BITS_TO_LONGS(WL12XX_MAX_ROLES
)];
322 unsigned long roc_map
[BITS_TO_LONGS(WL12XX_MAX_ROLES
)];
323 unsigned long rate_policies_map
[
324 BITS_TO_LONGS(WL12XX_MAX_RATE_POLICIES
)];
326 struct list_head wlvif_list
;
331 struct wl1271_acx_mem_map
*target_mem_map
;
333 /* Accounting for allocated / available TX blocks on HW */
335 u32 tx_blocks_available
;
336 u32 tx_allocated_blocks
;
337 u32 tx_results_count
;
339 /* amount of spare TX blocks to use */
342 /* Accounting for allocated / available Tx packets in HW */
343 u32 tx_pkts_freed
[NUM_TX_QUEUES
];
344 u32 tx_allocated_pkts
[NUM_TX_QUEUES
];
346 /* Transmitted TX packets counter for chipset interface */
347 u32 tx_packets_count
;
349 /* Time-offset between host and chipset clocks */
352 /* Frames scheduled for transmission, not handled yet */
353 int tx_queue_count
[NUM_TX_QUEUES
];
354 long stopped_queues_map
;
356 /* Frames received, not handled yet by mac80211 */
357 struct sk_buff_head deferred_rx_queue
;
359 /* Frames sent, not returned yet to mac80211 */
360 struct sk_buff_head deferred_tx_queue
;
362 struct work_struct tx_work
;
363 struct workqueue_struct
*freezable_wq
;
365 /* Pending TX frames */
366 unsigned long tx_frames_map
[BITS_TO_LONGS(ACX_TX_DESCRIPTORS
)];
367 struct sk_buff
*tx_frames
[ACX_TX_DESCRIPTORS
];
373 /* Rx memory pool address */
374 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr
;
376 /* Intermediate buffer, used for packet aggregation */
379 /* Reusable dummy packet template */
380 struct sk_buff
*dummy_packet
;
382 /* Network stack work */
383 struct work_struct netstack_work
;
388 /* Number of valid bytes in the FW log buffer */
391 /* Sysfs FW log entry readers wait queue */
392 wait_queue_head_t fwlog_waitq
;
394 /* Hardware recovery work */
395 struct work_struct recovery_work
;
397 /* The mbox event mask */
400 /* Mailbox pointers */
403 /* Are we currently scanning */
404 struct ieee80211_vif
*scan_vif
;
405 struct wl1271_scan scan
;
406 struct delayed_work scan_complete_work
;
410 /* The current band */
411 enum ieee80211_band band
;
413 struct completion
*elp_compl
;
414 struct delayed_work elp_work
;
419 struct wl1271_stats stats
;
423 u32 buffer_busyword
[WL1271_BUSY_WORD_CNT
];
425 struct wl12xx_fw_status
*fw_status
;
426 struct wl1271_tx_hw_res_if
*tx_res_if
;
428 struct ieee80211_vif
*vif
;
430 /* Current chipset configuration */
431 struct conf_drv_settings conf
;
437 struct list_head list
;
439 /* Most recently reported noise in dBm */
442 /* bands supported by this instance of wl12xx */
443 struct ieee80211_supported_band bands
[IEEE80211_NUM_BANDS
];
448 * wowlan trigger was configured during suspend.
449 * (currently, only "ANY" trigger is supported)
452 bool irq_wake_enabled
;
455 * AP-mode - links indexed by HLID. The global and broadcast links
458 struct wl1271_link links
[WL12XX_MAX_LINKS
];
460 /* AP-mode - a bitmap of links currently in PS mode according to FW */
463 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
464 unsigned long ap_ps_map
;
466 /* Quirks of specific hardware revisions */
469 /* Platform limitations */
470 unsigned int platform_quirks
;
472 /* number of currently active RX BA sessions */
473 int ba_rx_session_count
;
475 /* AP-mode - number of currently connected stations */
476 int active_sta_count
;
478 /* last wlvif we transmitted from */
479 struct wl12xx_vif
*last_wlvif
;
482 struct wl1271_station
{
488 struct list_head list
;
491 u8 p2p
; /* we are using p2p role */
494 /* sta/ibss specific */
511 /* HLIDs bitmap of associated stations */
512 unsigned long sta_hlid_map
[BITS_TO_LONGS(
515 /* recoreded keys - set here before AP startup */
516 struct wl1271_ap_key
*recorded_keys
[MAX_NUM_KEYS
];
520 u8 ucast_rate_idx
[CONF_TX_MAX_AC_COUNT
];
524 /* the hlid of the last transmitted skb */
527 unsigned long links_map
[BITS_TO_LONGS(WL12XX_MAX_LINKS
)];
529 u8 ssid
[IEEE80211_MAX_SSID_LEN
+ 1];
532 /* The current band */
533 enum ieee80211_band band
;
536 u32 bitrate_masks
[IEEE80211_NUM_BANDS
];
540 * currently configured rate set:
541 * bits 0-15 - 802.11abg rates
542 * bits 16-23 - 802.11n MCS index mask
543 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
548 /* probe-req template for the current AP */
549 struct sk_buff
*probereq
;
551 /* Beaconing interval (needed for ad-hoc) */
554 /* Default key (for WEP) */
557 /* Our association ID */
560 /* Session counter for the chipset */
563 struct completion
*ps_compl
;
564 struct delayed_work pspoll_work
;
566 /* counter for ps-poll delivery failures */
567 int ps_poll_failures
;
569 /* retry counter for PSM entries */
578 /* RX BA constraint value */
583 struct work_struct rx_streaming_enable_work
;
584 struct work_struct rx_streaming_disable_work
;
585 struct timer_list rx_streaming_timer
;
588 * This struct must be last!
589 * data that has to be saved acrossed reconfigs (e.g. recovery)
590 * should be declared in this struct.
595 * Security sequence number
596 * bits 0-15: lower 16 bits part of sequence number
597 * bits 16-47: higher 32 bits part of sequence number
598 * bits 48-63: not in use
602 /* 8 bits of the last sequence number in use */
603 u8 tx_security_last_seq_lsb
;
607 static inline struct wl12xx_vif
*wl12xx_vif_to_data(struct ieee80211_vif
*vif
)
609 return (struct wl12xx_vif
*)vif
->drv_priv
;
613 struct ieee80211_vif
*wl12xx_wlvif_to_vif(struct wl12xx_vif
*wlvif
)
615 return container_of((void *)wlvif
, struct ieee80211_vif
, drv_priv
);
618 #define wl12xx_for_each_wlvif(wl, wlvif) \
619 list_for_each_entry(wlvif, &wl->wlvif_list, list)
621 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
622 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
624 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
625 wl12xx_for_each_wlvif(wl, wlvif) \
626 if (wlvif->bss_type == _bss_type)
628 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
629 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
631 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
632 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
634 int wl1271_plt_start(struct wl1271
*wl
);
635 int wl1271_plt_stop(struct wl1271
*wl
);
636 int wl1271_recalc_rx_streaming(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
637 void wl12xx_queue_recovery_work(struct wl1271
*wl
);
638 size_t wl12xx_copy_fwlog(struct wl1271
*wl
, u8
*memblock
, size_t maxlen
);
640 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
642 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
643 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
645 #define WL1271_DEFAULT_POWER_LEVEL 0
647 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
648 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
650 #define WL1271_DEFERRED_QUEUE_LIMIT 64
652 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
653 on in case is has been shut down shortly before */
654 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
655 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
657 /* Macros to handle wl1271.sta_rate_set */
658 #define HW_BG_RATES_MASK 0xffff
659 #define HW_HT_RATES_OFFSET 16
663 /* Each RX/TX transaction requires an end-of-transaction transfer */
664 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)
666 /* wl127x and SPI don't support SDIO block size alignment */
667 #define WL12XX_QUIRK_NO_BLOCKSIZE_ALIGNMENT BIT(2)
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