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
25 #ifndef __WLCORE_I_H__
26 #define __WLCORE_I_H__
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>
39 * wl127x and wl128x are using the same NVS file name. However, the
40 * ini parameters between them are different. The driver validates
41 * the correct NVS size in wl1271_boot_upload_nvs().
43 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
45 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
46 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
47 #define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff
49 #define WL1271_CIPHER_SUITE_GEM 0x00147201
51 #define WL1271_BUSY_WORD_CNT 1
52 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
54 #define WL1271_ELP_HW_STATE_ASLEEP 0
55 #define WL1271_ELP_HW_STATE_IRQ 1
57 #define WL1271_DEFAULT_BEACON_INT 100
58 #define WL1271_DEFAULT_DTIM_PERIOD 1
60 #define WL12XX_MAX_ROLES 4
61 #define WL12XX_MAX_LINKS 12
62 #define WL12XX_INVALID_ROLE_ID 0xff
63 #define WL12XX_INVALID_LINK_ID 0xff
65 /* the driver supports the 2.4Ghz and 5Ghz bands */
66 #define WLCORE_NUM_BANDS 2
68 #define WL12XX_MAX_RATE_POLICIES 16
69 #define WLCORE_MAX_KLV_TEMPLATES 4
71 /* Defined by FW as 0. Will not be freed or allocated. */
72 #define WL12XX_SYSTEM_HLID 0
75 * When in AP-mode, we allow (at least) this number of packets
76 * to be transmitted to FW for a STA in PS-mode. Only when packets are
77 * present in the FW buffers it will wake the sleeping STA. We want to put
78 * enough packets for the driver to transmit all of its buffered data before
79 * the STA goes to sleep again. But we don't want to take too much memory
80 * as it might hurt the throughput of active STAs.
82 #define WL1271_PS_STA_MAX_PACKETS 2
84 #define WL1271_AP_BSS_INDEX 0
85 #define WL1271_AP_DEF_BEACON_EXP 20
89 WLCORE_STATE_RESTARTING,
95 WL12XX_FW_TYPE_NORMAL,
114 char fw_ver_str[ETHTOOL_FWVERS_LEN];
115 unsigned int fw_ver[NUM_FW_VER];
116 char phy_fw_ver_str[ETHTOOL_FWVERS_LEN];
119 #define NUM_TX_QUEUES 4
121 #define AP_MAX_STATIONS 8
123 struct wl_fw_packet_counters {
124 /* Cumulative counter of released packets per AC */
125 u8 tx_released_pkts[NUM_TX_QUEUES];
127 /* Cumulative counter of freed packets per HLID */
128 u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
130 /* Cumulative counter of released Voice memory blocks */
131 u8 tx_voice_released_blks;
133 /* Tx rate of the last transmitted packet */
139 /* FW status registers */
140 struct wl_fw_status_1 {
145 u8 tx_results_counter;
146 __le32 rx_pkt_descs[0];
150 * Each HW arch has a different number of Rx descriptors.
151 * The length of the status depends on it, since it holds an array
154 #define WLCORE_FW_STATUS_1_LEN(num_rx_desc) \
155 (sizeof(struct wl_fw_status_1) + \
156 (sizeof(((struct wl_fw_status_1 *)0)->rx_pkt_descs[0])) * \
159 struct wl_fw_status_2 {
163 * A bitmap (where each bit represents a single HLID)
164 * to indicate if the station is in PS mode.
166 __le32 link_ps_bitmap;
169 * A bitmap (where each bit represents a single HLID) to indicate
170 * if the station is in Fast mode
172 __le32 link_fast_bitmap;
174 /* Cumulative counter of total released mem blocks since FW-reset */
175 __le32 total_released_blks;
177 /* Size (in Memory Blocks) of TX pool */
180 struct wl_fw_packet_counters counters;
182 __le32 log_start_addr;
184 /* Private status to be used by the lower drivers */
188 #define WL1271_MAX_CHANNELS 64
190 struct cfg80211_scan_request *req;
191 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
194 u8 ssid[IEEE80211_MAX_SSID_LEN+1];
198 struct wl1271_if_operations {
199 int __must_check (*read)(struct device *child, int addr, void *buf,
200 size_t len, bool fixed);
201 int __must_check (*write)(struct device *child, int addr, void *buf,
202 size_t len, bool fixed);
203 void (*reset)(struct device *child);
204 void (*init)(struct device *child);
205 int (*power)(struct device *child, bool enable);
206 void (*set_block_size) (struct device *child, unsigned int blksz);
209 #define MAX_NUM_KEYS 14
210 #define MAX_KEY_SIZE 32
212 struct wl1271_ap_key {
216 u8 key[MAX_KEY_SIZE];
223 WL1271_FLAG_GPIO_POWER,
224 WL1271_FLAG_TX_QUEUE_STOPPED,
225 WL1271_FLAG_TX_PENDING,
227 WL1271_FLAG_ELP_REQUESTED,
228 WL1271_FLAG_IRQ_RUNNING,
229 WL1271_FLAG_FW_TX_BUSY,
230 WL1271_FLAG_DUMMY_PACKET_PENDING,
231 WL1271_FLAG_SUSPENDED,
232 WL1271_FLAG_PENDING_WORK,
233 WL1271_FLAG_SOFT_GEMINI,
234 WL1271_FLAG_RECOVERY_IN_PROGRESS,
235 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
236 WL1271_FLAG_INTENDED_FW_RECOVERY,
237 WL1271_FLAG_IO_FAILED,
240 enum wl12xx_vif_flags {
241 WLVIF_FLAG_INITIALIZED,
242 WLVIF_FLAG_STA_ASSOCIATED,
243 WLVIF_FLAG_STA_AUTHORIZED,
244 WLVIF_FLAG_IBSS_JOINED,
245 WLVIF_FLAG_AP_STARTED,
247 WLVIF_FLAG_STA_STATE_SENT,
248 WLVIF_FLAG_RX_STREAMING_STARTED,
249 WLVIF_FLAG_PSPOLL_FAILURE,
250 WLVIF_FLAG_CS_PROGRESS,
251 WLVIF_FLAG_AP_PROBE_RESP_SET,
258 /* AP-mode - TX queue per AC in link */
259 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
261 /* accounting for allocated / freed packets in FW */
267 /* bitmap of TIDs where RX BA sessions are active for this link */
270 /* The wlvif this link belongs to. Might be null for global links */
271 struct wl12xx_vif *wlvif;
274 #define WL1271_MAX_RX_FILTERS 5
275 #define WL1271_RX_FILTER_MAX_FIELDS 8
277 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
278 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
279 #define RX_FILTER_FIELD_OVERHEAD \
280 (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
281 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE \
282 (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
284 #define WL1271_RX_FILTER_FLAG_MASK BIT(0)
285 #define WL1271_RX_FILTER_FLAG_IP_HEADER 0
286 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER BIT(1)
288 enum rx_filter_action {
300 struct wl12xx_rx_filter_field {
307 struct wl12xx_rx_filter {
310 struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
313 struct wl1271_station {
320 struct list_head list;
323 u8 p2p; /* we are using p2p role */
326 /* sta/ibss specific */
341 /* channel type we started the STA role with */
342 enum nl80211_channel_type role_chan_type;
348 /* HLIDs bitmap of associated stations */
349 unsigned long sta_hlid_map[BITS_TO_LONGS(
352 /* recoreded keys - set here before AP startup */
353 struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
357 u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
361 /* the hlid of the last transmitted skb */
364 /* counters of packets per AC, across all links in the vif */
365 int tx_queue_count[NUM_TX_QUEUES];
367 unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
369 u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
372 /* The current band */
373 enum ieee80211_band band;
375 enum nl80211_channel_type channel_type;
377 u32 bitrate_masks[WLCORE_NUM_BANDS];
381 * currently configured rate set:
382 * bits 0-15 - 802.11abg rates
383 * bits 16-23 - 802.11n MCS index mask
384 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
389 /* probe-req template for the current AP */
390 struct sk_buff *probereq;
392 /* Beaconing interval (needed for ad-hoc) */
395 /* Default key (for WEP) */
398 /* Our association ID */
401 /* retry counter for PSM entries */
410 /* save the current encryption type for auto-arp config */
414 /* RX BA constraint value */
421 struct work_struct rx_streaming_enable_work;
422 struct work_struct rx_streaming_disable_work;
423 struct timer_list rx_streaming_timer;
425 struct delayed_work channel_switch_work;
426 struct delayed_work connection_loss_work;
428 /* number of in connection stations */
432 * This vif's queues are mapped to mac80211 HW queues as:
434 * VI - hw_queue_base + 1
435 * BE - hw_queue_base + 2
436 * BK - hw_queue_base + 3
441 * This struct must be last!
442 * data that has to be saved acrossed reconfigs (e.g. recovery)
443 * should be declared in this struct.
448 * Security sequence number
449 * bits 0-15: lower 16 bits part of sequence number
450 * bits 16-47: higher 32 bits part of sequence number
451 * bits 48-63: not in use
455 /* 8 bits of the last sequence number in use */
456 u8 tx_security_last_seq_lsb;
460 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
463 return (struct wl12xx_vif *)vif->drv_priv;
467 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
469 return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
472 #define wl12xx_for_each_wlvif(wl, wlvif) \
473 list_for_each_entry(wlvif, &wl->wlvif_list, list)
475 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
476 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
478 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
479 wl12xx_for_each_wlvif(wl, wlvif) \
480 if (wlvif->bss_type == _bss_type)
482 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
483 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
485 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
486 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
488 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
489 int wl1271_plt_stop(struct wl1271 *wl);
490 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
491 void wl12xx_queue_recovery_work(struct wl1271 *wl);
492 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
493 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
494 u16 offset, u8 flags,
495 u8 *pattern, u8 len);
496 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
497 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
498 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
499 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
502 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
504 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
505 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
507 #define WL1271_DEFAULT_POWER_LEVEL 0
509 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
510 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
512 #define WL1271_DEFERRED_QUEUE_LIMIT 64
514 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
515 on in case is has been shut down shortly before */
516 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
517 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
519 /* Macros to handle wl1271.sta_rate_set */
520 #define HW_BG_RATES_MASK 0xffff
521 #define HW_HT_RATES_OFFSET 16
522 #define HW_MIMO_RATES_OFFSET 24
524 #define WL12XX_HW_BLOCK_SIZE 256
526 #endif /* __WLCORE_I_H__ */