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
48 /* Use smaller padding for GEM, as some APs have issues when it's too big */
49 #define WL1271_TX_SQN_POST_RECOVERY_PADDING_GEM 0x20
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_INVALID_ROLE_ID 0xff
65 #define WL12XX_INVALID_LINK_ID 0xff
68 * max number of links allowed by all HWs.
69 * this is NOT the actual max links supported by the current hw.
71 #define WLCORE_MAX_LINKS 16
73 /* the driver supports the 2.4Ghz and 5Ghz bands */
74 #define WLCORE_NUM_BANDS 2
76 #define WL12XX_MAX_RATE_POLICIES 16
77 #define WLCORE_MAX_KLV_TEMPLATES 4
79 /* Defined by FW as 0. Will not be freed or allocated. */
80 #define WL12XX_SYSTEM_HLID 0
83 * When in AP-mode, we allow (at least) this number of packets
84 * to be transmitted to FW for a STA in PS-mode. Only when packets are
85 * present in the FW buffers it will wake the sleeping STA. We want to put
86 * enough packets for the driver to transmit all of its buffered data before
87 * the STA goes to sleep again. But we don't want to take too much memory
88 * as it might hurt the throughput of active STAs.
90 #define WL1271_PS_STA_MAX_PACKETS 2
92 #define WL1271_AP_BSS_INDEX 0
93 #define WL1271_AP_DEF_BEACON_EXP 20
97 WLCORE_STATE_RESTARTING
,
101 enum wl12xx_fw_type
{
103 WL12XX_FW_TYPE_NORMAL
,
104 WL12XX_FW_TYPE_MULTI
,
122 char fw_ver_str
[ETHTOOL_FWVERS_LEN
];
123 unsigned int fw_ver
[NUM_FW_VER
];
124 char phy_fw_ver_str
[ETHTOOL_FWVERS_LEN
];
127 #define NUM_TX_QUEUES 4
129 struct wl_fw_status
{
133 u8 tx_results_counter
;
134 __le32
*rx_pkt_descs
;
139 * A bitmap (where each bit represents a single HLID)
140 * to indicate if the station is in PS mode.
145 * A bitmap (where each bit represents a single HLID) to indicate
146 * if the station is in Fast mode
148 u32 link_fast_bitmap
;
150 /* Cumulative counter of total released mem blocks since FW-reset */
151 u32 total_released_blks
;
153 /* Size (in Memory Blocks) of TX pool */
158 * Cumulative counter of released packets per AC
159 * (length of the array is NUM_TX_QUEUES)
161 u8
*tx_released_pkts
;
164 * Cumulative counter of freed packets per HLID
165 * (length of the array is wl->num_links)
167 u8
*tx_lnk_free_pkts
;
169 /* Cumulative counter of released Voice memory blocks */
170 u8 tx_voice_released_blks
;
172 /* Tx rate of the last transmitted packet */
178 /* Private status to be used by the lower drivers */
182 #define WL1271_MAX_CHANNELS 64
184 struct cfg80211_scan_request
*req
;
185 unsigned long scanned_ch
[BITS_TO_LONGS(WL1271_MAX_CHANNELS
)];
188 u8 ssid
[IEEE80211_MAX_SSID_LEN
+1];
192 struct wl1271_if_operations
{
193 int __must_check (*read
)(struct device
*child
, int addr
, void *buf
,
194 size_t len
, bool fixed
);
195 int __must_check (*write
)(struct device
*child
, int addr
, void *buf
,
196 size_t len
, bool fixed
);
197 void (*reset
)(struct device
*child
);
198 void (*init
)(struct device
*child
);
199 int (*power
)(struct device
*child
, bool enable
);
200 void (*set_block_size
) (struct device
*child
, unsigned int blksz
);
203 struct wlcore_platdev_data
{
204 struct wl12xx_platform_data
*pdata
;
205 struct wl1271_if_operations
*if_ops
;
208 #define MAX_NUM_KEYS 14
209 #define MAX_KEY_SIZE 32
211 struct wl1271_ap_key
{
215 u8 key
[MAX_KEY_SIZE
];
222 WL1271_FLAG_GPIO_POWER
,
223 WL1271_FLAG_TX_QUEUE_STOPPED
,
224 WL1271_FLAG_TX_PENDING
,
226 WL1271_FLAG_ELP_REQUESTED
,
227 WL1271_FLAG_IRQ_RUNNING
,
228 WL1271_FLAG_FW_TX_BUSY
,
229 WL1271_FLAG_DUMMY_PACKET_PENDING
,
230 WL1271_FLAG_SUSPENDED
,
231 WL1271_FLAG_PENDING_WORK
,
232 WL1271_FLAG_SOFT_GEMINI
,
233 WL1271_FLAG_RECOVERY_IN_PROGRESS
,
234 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS
,
235 WL1271_FLAG_INTENDED_FW_RECOVERY
,
236 WL1271_FLAG_IO_FAILED
,
237 WL1271_FLAG_REINIT_TX_WDOG
,
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
,
259 /* AP-mode - TX queue per AC in link */
260 struct sk_buff_head tx_queue
[NUM_TX_QUEUES
];
262 /* accounting for allocated / freed packets in FW */
268 /* bitmap of TIDs where RX BA sessions are active for this link */
271 /* The wlvif this link belongs to. Might be null for global links */
272 struct wl12xx_vif
*wlvif
;
275 * total freed FW packets on the link - used for tracking the
276 * AES/TKIP PN across recoveries. Re-initialized each time
277 * from the wl1271_station structure.
279 u64 total_freed_pkts
;
282 #define WL1271_MAX_RX_FILTERS 5
283 #define WL1271_RX_FILTER_MAX_FIELDS 8
285 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
286 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
287 #define RX_FILTER_FIELD_OVERHEAD \
288 (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
289 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE \
290 (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
292 #define WL1271_RX_FILTER_FLAG_MASK BIT(0)
293 #define WL1271_RX_FILTER_FLAG_IP_HEADER 0
294 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER BIT(1)
296 enum rx_filter_action
{
309 struct wl12xx_rx_filter_field
{
316 struct wl12xx_rx_filter
{
319 struct wl12xx_rx_filter_field fields
[WL1271_RX_FILTER_MAX_FIELDS
];
322 struct wl1271_station
{
327 * total freed FW packets on the link to the STA - used for tracking the
328 * AES/TKIP PN across recoveries. Re-initialized each time from the
329 * wl1271_station structure.
330 * Used in both AP and STA mode.
332 u64 total_freed_pkts
;
337 struct list_head list
;
340 u8 p2p
; /* we are using p2p role */
343 /* sta/ibss specific */
358 /* channel type we started the STA role with */
359 enum nl80211_channel_type role_chan_type
;
365 /* HLIDs bitmap of associated stations */
366 unsigned long sta_hlid_map
[BITS_TO_LONGS(
369 /* recoreded keys - set here before AP startup */
370 struct wl1271_ap_key
*recorded_keys
[MAX_NUM_KEYS
];
374 u8 ucast_rate_idx
[CONF_TX_MAX_AC_COUNT
];
378 /* the hlid of the last transmitted skb */
381 /* counters of packets per AC, across all links in the vif */
382 int tx_queue_count
[NUM_TX_QUEUES
];
384 unsigned long links_map
[BITS_TO_LONGS(WLCORE_MAX_LINKS
)];
386 u8 ssid
[IEEE80211_MAX_SSID_LEN
+ 1];
389 /* The current band */
390 enum ieee80211_band band
;
392 enum nl80211_channel_type channel_type
;
394 u32 bitrate_masks
[WLCORE_NUM_BANDS
];
398 * currently configured rate set:
399 * bits 0-15 - 802.11abg rates
400 * bits 16-23 - 802.11n MCS index mask
401 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
406 /* probe-req template for the current AP */
407 struct sk_buff
*probereq
;
409 /* Beaconing interval (needed for ad-hoc) */
412 /* Default key (for WEP) */
415 /* Our association ID */
418 /* retry counter for PSM entries */
427 /* save the current encryption type for auto-arp config */
431 /* RX BA constraint value */
438 struct work_struct rx_streaming_enable_work
;
439 struct work_struct rx_streaming_disable_work
;
440 struct timer_list rx_streaming_timer
;
442 struct delayed_work channel_switch_work
;
443 struct delayed_work connection_loss_work
;
445 /* number of in connection stations */
449 * This vif's queues are mapped to mac80211 HW queues as:
451 * VI - hw_queue_base + 1
452 * BE - hw_queue_base + 2
453 * BK - hw_queue_base + 3
457 /* do we have a pending auth reply? (and ROC) */
458 bool ap_pending_auth_reply
;
460 /* time when we sent the pending auth reply */
461 unsigned long pending_auth_reply_time
;
463 /* work for canceling ROC after pending auth reply */
464 struct delayed_work pending_auth_complete_work
;
466 /* update rate conrol */
467 enum ieee80211_sta_rx_bandwidth rc_update_bw
;
468 struct work_struct rc_update_work
;
471 * total freed FW packets on the link.
472 * For STA this holds the PN of the link to the AP.
473 * For AP this holds the PN of the broadcast link.
475 u64 total_freed_pkts
;
478 * This struct must be last!
479 * data that has to be saved acrossed reconfigs (e.g. recovery)
480 * should be declared in this struct.
487 static inline struct wl12xx_vif
*wl12xx_vif_to_data(struct ieee80211_vif
*vif
)
490 return (struct wl12xx_vif
*)vif
->drv_priv
;
494 struct ieee80211_vif
*wl12xx_wlvif_to_vif(struct wl12xx_vif
*wlvif
)
496 return container_of((void *)wlvif
, struct ieee80211_vif
, drv_priv
);
499 #define wl12xx_for_each_wlvif(wl, wlvif) \
500 list_for_each_entry(wlvif, &wl->wlvif_list, list)
502 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
503 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
505 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
506 wl12xx_for_each_wlvif(wl, wlvif) \
507 if (wlvif->bss_type == _bss_type)
509 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
510 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
512 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
513 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
515 int wl1271_plt_start(struct wl1271
*wl
, const enum plt_mode plt_mode
);
516 int wl1271_plt_stop(struct wl1271
*wl
);
517 int wl1271_recalc_rx_streaming(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
518 void wl12xx_queue_recovery_work(struct wl1271
*wl
);
519 size_t wl12xx_copy_fwlog(struct wl1271
*wl
, u8
*memblock
, size_t maxlen
);
520 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter
*filter
,
521 u16 offset
, u8 flags
,
522 const u8
*pattern
, u8 len
);
523 void wl1271_rx_filter_free(struct wl12xx_rx_filter
*filter
);
524 struct wl12xx_rx_filter
*wl1271_rx_filter_alloc(void);
525 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter
*filter
);
526 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter
*filter
,
529 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
531 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
532 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
534 #define WL1271_DEFAULT_POWER_LEVEL 0
536 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
537 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
539 #define WL1271_DEFERRED_QUEUE_LIMIT 64
541 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
542 on in case is has been shut down shortly before */
543 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
544 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
546 /* Macros to handle wl1271.sta_rate_set */
547 #define HW_BG_RATES_MASK 0xffff
548 #define HW_HT_RATES_OFFSET 16
549 #define HW_MIMO_RATES_OFFSET 24
551 #endif /* __WLCORE_I_H__ */