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 "/*(DEBLOBBED)*/"
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_INVALID_ROLE_ID 0xff
62 #define WL12XX_INVALID_LINK_ID 0xff
65 * max number of links allowed by all HWs.
66 * this is NOT the actual max links supported by the current hw.
68 #define WLCORE_MAX_LINKS 16
70 /* the driver supports the 2.4Ghz and 5Ghz bands */
71 #define WLCORE_NUM_BANDS 2
73 #define WL12XX_MAX_RATE_POLICIES 16
74 #define WLCORE_MAX_KLV_TEMPLATES 4
76 /* Defined by FW as 0. Will not be freed or allocated. */
77 #define WL12XX_SYSTEM_HLID 0
80 * When in AP-mode, we allow (at least) this number of packets
81 * to be transmitted to FW for a STA in PS-mode. Only when packets are
82 * present in the FW buffers it will wake the sleeping STA. We want to put
83 * enough packets for the driver to transmit all of its buffered data before
84 * the STA goes to sleep again. But we don't want to take too much memory
85 * as it might hurt the throughput of active STAs.
87 #define WL1271_PS_STA_MAX_PACKETS 2
89 #define WL1271_AP_BSS_INDEX 0
90 #define WL1271_AP_DEF_BEACON_EXP 20
94 WLCORE_STATE_RESTARTING,
100 WL12XX_FW_TYPE_NORMAL,
101 WL12XX_FW_TYPE_MULTI,
119 char fw_ver_str[ETHTOOL_FWVERS_LEN];
120 unsigned int fw_ver[NUM_FW_VER];
121 char phy_fw_ver_str[ETHTOOL_FWVERS_LEN];
124 #define NUM_TX_QUEUES 4
126 struct wl_fw_status {
130 u8 tx_results_counter;
131 __le32 *rx_pkt_descs;
136 * A bitmap (where each bit represents a single HLID)
137 * to indicate if the station is in PS mode.
142 * A bitmap (where each bit represents a single HLID) to indicate
143 * if the station is in Fast mode
145 u32 link_fast_bitmap;
147 /* Cumulative counter of total released mem blocks since FW-reset */
148 u32 total_released_blks;
150 /* Size (in Memory Blocks) of TX pool */
155 * Cumulative counter of released packets per AC
156 * (length of the array is NUM_TX_QUEUES)
158 u8 *tx_released_pkts;
161 * Cumulative counter of freed packets per HLID
162 * (length of the array is wl->num_links)
164 u8 *tx_lnk_free_pkts;
166 /* Cumulative counter of released Voice memory blocks */
167 u8 tx_voice_released_blks;
169 /* Tx rate of the last transmitted packet */
175 /* Private status to be used by the lower drivers */
179 #define WL1271_MAX_CHANNELS 64
181 struct cfg80211_scan_request *req;
182 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
185 u8 ssid[IEEE80211_MAX_SSID_LEN+1];
189 struct wl1271_if_operations {
190 int __must_check (*read)(struct device *child, int addr, void *buf,
191 size_t len, bool fixed);
192 int __must_check (*write)(struct device *child, int addr, void *buf,
193 size_t len, bool fixed);
194 void (*reset)(struct device *child);
195 void (*init)(struct device *child);
196 int (*power)(struct device *child, bool enable);
197 void (*set_block_size) (struct device *child, unsigned int blksz);
200 struct wlcore_platdev_data {
201 struct wl12xx_platform_data *pdata;
202 struct wl1271_if_operations *if_ops;
205 #define MAX_NUM_KEYS 14
206 #define MAX_KEY_SIZE 32
208 struct wl1271_ap_key {
212 u8 key[MAX_KEY_SIZE];
219 WL1271_FLAG_GPIO_POWER,
220 WL1271_FLAG_TX_QUEUE_STOPPED,
221 WL1271_FLAG_TX_PENDING,
223 WL1271_FLAG_ELP_REQUESTED,
224 WL1271_FLAG_IRQ_RUNNING,
225 WL1271_FLAG_FW_TX_BUSY,
226 WL1271_FLAG_DUMMY_PACKET_PENDING,
227 WL1271_FLAG_SUSPENDED,
228 WL1271_FLAG_PENDING_WORK,
229 WL1271_FLAG_SOFT_GEMINI,
230 WL1271_FLAG_RECOVERY_IN_PROGRESS,
231 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
232 WL1271_FLAG_INTENDED_FW_RECOVERY,
233 WL1271_FLAG_IO_FAILED,
234 WL1271_FLAG_REINIT_TX_WDOG,
237 enum wl12xx_vif_flags {
238 WLVIF_FLAG_INITIALIZED,
239 WLVIF_FLAG_STA_ASSOCIATED,
240 WLVIF_FLAG_STA_AUTHORIZED,
241 WLVIF_FLAG_IBSS_JOINED,
242 WLVIF_FLAG_AP_STARTED,
244 WLVIF_FLAG_STA_STATE_SENT,
245 WLVIF_FLAG_RX_STREAMING_STARTED,
246 WLVIF_FLAG_PSPOLL_FAILURE,
247 WLVIF_FLAG_CS_PROGRESS,
248 WLVIF_FLAG_AP_PROBE_RESP_SET,
256 /* AP-mode - TX queue per AC in link */
257 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
259 /* accounting for allocated / freed packets in FW */
265 /* bitmap of TIDs where RX BA sessions are active for this link */
268 /* The wlvif this link belongs to. Might be null for global links */
269 struct wl12xx_vif *wlvif;
272 * total freed FW packets on the link - used for tracking the
273 * AES/TKIP PN across recoveries. Re-initialized each time
274 * from the wl1271_station structure.
276 u64 total_freed_pkts;
279 #define WL1271_MAX_RX_FILTERS 5
280 #define WL1271_RX_FILTER_MAX_FIELDS 8
282 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
283 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
284 #define RX_FILTER_FIELD_OVERHEAD \
285 (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
286 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE \
287 (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
289 #define WL1271_RX_FILTER_FLAG_MASK BIT(0)
290 #define WL1271_RX_FILTER_FLAG_IP_HEADER 0
291 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER BIT(1)
293 enum rx_filter_action {
306 struct wl12xx_rx_filter_field {
313 struct wl12xx_rx_filter {
316 struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
319 struct wl1271_station {
324 * total freed FW packets on the link to the STA - used for tracking the
325 * AES/TKIP PN across recoveries. Re-initialized each time from the
326 * wl1271_station structure.
328 u64 total_freed_pkts;
333 struct list_head list;
336 u8 p2p; /* we are using p2p role */
339 /* sta/ibss specific */
354 /* channel type we started the STA role with */
355 enum nl80211_channel_type role_chan_type;
361 /* HLIDs bitmap of associated stations */
362 unsigned long sta_hlid_map[BITS_TO_LONGS(
365 /* recoreded keys - set here before AP startup */
366 struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
370 u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
374 /* the hlid of the last transmitted skb */
377 /* counters of packets per AC, across all links in the vif */
378 int tx_queue_count[NUM_TX_QUEUES];
380 unsigned long links_map[BITS_TO_LONGS(WLCORE_MAX_LINKS)];
382 u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
385 /* The current band */
386 enum ieee80211_band band;
388 enum nl80211_channel_type channel_type;
390 u32 bitrate_masks[WLCORE_NUM_BANDS];
394 * currently configured rate set:
395 * bits 0-15 - 802.11abg rates
396 * bits 16-23 - 802.11n MCS index mask
397 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
402 /* probe-req template for the current AP */
403 struct sk_buff *probereq;
405 /* Beaconing interval (needed for ad-hoc) */
408 /* Default key (for WEP) */
411 /* Our association ID */
414 /* retry counter for PSM entries */
423 /* save the current encryption type for auto-arp config */
427 /* RX BA constraint value */
434 struct work_struct rx_streaming_enable_work;
435 struct work_struct rx_streaming_disable_work;
436 struct timer_list rx_streaming_timer;
438 struct delayed_work channel_switch_work;
439 struct delayed_work connection_loss_work;
441 /* number of in connection stations */
445 * This vif's queues are mapped to mac80211 HW queues as:
447 * VI - hw_queue_base + 1
448 * BE - hw_queue_base + 2
449 * BK - hw_queue_base + 3
453 /* do we have a pending auth reply? (and ROC) */
454 bool ap_pending_auth_reply;
456 /* time when we sent the pending auth reply */
457 unsigned long pending_auth_reply_time;
459 /* work for canceling ROC after pending auth reply */
460 struct delayed_work pending_auth_complete_work;
463 * This struct must be last!
464 * data that has to be saved acrossed reconfigs (e.g. recovery)
465 * should be declared in this struct.
471 * total freed FW packets on the link - used for
472 * storing the AES/TKIP PN during recovery, as this
473 * structure is not zeroed out.
474 * For STA this holds the PN of the link to the AP.
475 * For AP this holds the PN of the broadcast link.
477 u64 total_freed_pkts;
481 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
484 return (struct wl12xx_vif *)vif->drv_priv;
488 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
490 return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
493 #define wl12xx_for_each_wlvif(wl, wlvif) \
494 list_for_each_entry(wlvif, &wl->wlvif_list, list)
496 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
497 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
499 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
500 wl12xx_for_each_wlvif(wl, wlvif) \
501 if (wlvif->bss_type == _bss_type)
503 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
504 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
506 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
507 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
509 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
510 int wl1271_plt_stop(struct wl1271 *wl);
511 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
512 void wl12xx_queue_recovery_work(struct wl1271 *wl);
513 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
514 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
515 u16 offset, u8 flags,
516 const u8 *pattern, u8 len);
517 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
518 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
519 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
520 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
523 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
525 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
526 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
528 #define WL1271_DEFAULT_POWER_LEVEL 0
530 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
531 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
533 #define WL1271_DEFERRED_QUEUE_LIMIT 64
535 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
536 on in case is has been shut down shortly before */
537 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
538 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
540 /* Macros to handle wl1271.sta_rate_set */
541 #define HW_BG_RATES_MASK 0xffff
542 #define HW_HT_RATES_OFFSET 16
543 #define HW_MIMO_RATES_OFFSET 24
545 #endif /* __WLCORE_I_H__ */