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
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 WL1271_AGGR_BUFFER_SIZE (5 * PAGE_SIZE)
95 WL12XX_FW_TYPE_NORMAL
,
112 #define FW_VER_CHIP_WL127X 6
113 #define FW_VER_CHIP_WL128X 7
115 #define FW_VER_IF_TYPE_STA 1
116 #define FW_VER_IF_TYPE_AP 2
118 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
119 #define FW_VER_MINOR_1_SPARE_AP_MIN 47
121 #define FW_VER_MINOR_FWLOG_STA_MIN 70
125 char fw_ver_str
[ETHTOOL_BUSINFO_LEN
];
126 unsigned int fw_ver
[NUM_FW_VER
];
129 #define NUM_TX_QUEUES 4
131 #define AP_MAX_STATIONS 8
133 struct wl_fw_packet_counters
{
134 /* Cumulative counter of released packets per AC */
135 u8 tx_released_pkts
[NUM_TX_QUEUES
];
137 /* Cumulative counter of freed packets per HLID */
138 u8 tx_lnk_free_pkts
[WL12XX_MAX_LINKS
];
140 /* Cumulative counter of released Voice memory blocks */
141 u8 tx_voice_released_blks
;
146 /* FW status registers */
147 struct wl_fw_status_1
{
152 u8 tx_results_counter
;
153 __le32 rx_pkt_descs
[0];
157 * Each HW arch has a different number of Rx descriptors.
158 * The length of the status depends on it, since it holds an array
161 #define WLCORE_FW_STATUS_1_LEN(num_rx_desc) \
162 (sizeof(struct wl_fw_status_1) + \
163 (sizeof(((struct wl_fw_status_1 *)0)->rx_pkt_descs[0])) * \
166 struct wl_fw_status_2
{
170 * A bitmap (where each bit represents a single HLID)
171 * to indicate if the station is in PS mode.
173 __le32 link_ps_bitmap
;
176 * A bitmap (where each bit represents a single HLID) to indicate
177 * if the station is in Fast mode
179 __le32 link_fast_bitmap
;
181 /* Cumulative counter of total released mem blocks since FW-reset */
182 __le32 total_released_blks
;
184 /* Size (in Memory Blocks) of TX pool */
187 struct wl_fw_packet_counters counters
;
189 __le32 log_start_addr
;
191 /* Private status to be used by the lower drivers */
195 #define WL1271_MAX_CHANNELS 64
197 struct cfg80211_scan_request
*req
;
198 unsigned long scanned_ch
[BITS_TO_LONGS(WL1271_MAX_CHANNELS
)];
201 u8 ssid
[IEEE80211_MAX_SSID_LEN
+1];
205 struct wl1271_if_operations
{
206 int __must_check (*read
)(struct device
*child
, int addr
, void *buf
,
207 size_t len
, bool fixed
);
208 int __must_check (*write
)(struct device
*child
, int addr
, void *buf
,
209 size_t len
, bool fixed
);
210 void (*reset
)(struct device
*child
);
211 void (*init
)(struct device
*child
);
212 int (*power
)(struct device
*child
, bool enable
);
213 void (*set_block_size
) (struct device
*child
, unsigned int blksz
);
216 #define MAX_NUM_KEYS 14
217 #define MAX_KEY_SIZE 32
219 struct wl1271_ap_key
{
223 u8 key
[MAX_KEY_SIZE
];
230 WL1271_FLAG_GPIO_POWER
,
231 WL1271_FLAG_TX_QUEUE_STOPPED
,
232 WL1271_FLAG_TX_PENDING
,
234 WL1271_FLAG_ELP_REQUESTED
,
235 WL1271_FLAG_IRQ_RUNNING
,
236 WL1271_FLAG_FW_TX_BUSY
,
237 WL1271_FLAG_DUMMY_PACKET_PENDING
,
238 WL1271_FLAG_SUSPENDED
,
239 WL1271_FLAG_PENDING_WORK
,
240 WL1271_FLAG_SOFT_GEMINI
,
241 WL1271_FLAG_RECOVERY_IN_PROGRESS
,
242 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS
,
243 WL1271_FLAG_INTENDED_FW_RECOVERY
,
244 WL1271_FLAG_IO_FAILED
,
247 enum wl12xx_vif_flags
{
248 WLVIF_FLAG_INITIALIZED
,
249 WLVIF_FLAG_STA_ASSOCIATED
,
250 WLVIF_FLAG_STA_AUTHORIZED
,
251 WLVIF_FLAG_IBSS_JOINED
,
252 WLVIF_FLAG_AP_STARTED
,
254 WLVIF_FLAG_STA_STATE_SENT
,
255 WLVIF_FLAG_RX_STREAMING_STARTED
,
256 WLVIF_FLAG_PSPOLL_FAILURE
,
257 WLVIF_FLAG_CS_PROGRESS
,
258 WLVIF_FLAG_AP_PROBE_RESP_SET
,
263 /* AP-mode - TX queue per AC in link */
264 struct sk_buff_head tx_queue
[NUM_TX_QUEUES
];
266 /* accounting for allocated / freed packets in FW */
272 /* bitmap of TIDs where RX BA sessions are active for this link */
276 #define WL1271_MAX_RX_FILTERS 5
277 #define WL1271_RX_FILTER_MAX_FIELDS 8
279 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
280 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
281 #define RX_FILTER_FIELD_OVERHEAD \
282 (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
283 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE \
284 (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
286 #define WL1271_RX_FILTER_FLAG_MASK BIT(0)
287 #define WL1271_RX_FILTER_FLAG_IP_HEADER 0
288 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER BIT(1)
290 enum rx_filter_action
{
296 struct wl12xx_rx_filter_field
{
303 struct wl12xx_rx_filter
{
306 struct wl12xx_rx_filter_field fields
[WL1271_RX_FILTER_MAX_FIELDS
];
309 struct wl1271_station
{
315 struct list_head list
;
318 u8 p2p
; /* we are using p2p role */
321 /* sta/ibss specific */
340 /* HLIDs bitmap of associated stations */
341 unsigned long sta_hlid_map
[BITS_TO_LONGS(
344 /* recoreded keys - set here before AP startup */
345 struct wl1271_ap_key
*recorded_keys
[MAX_NUM_KEYS
];
349 u8 ucast_rate_idx
[CONF_TX_MAX_AC_COUNT
];
353 /* the hlid of the last transmitted skb */
356 unsigned long links_map
[BITS_TO_LONGS(WL12XX_MAX_LINKS
)];
358 u8 ssid
[IEEE80211_MAX_SSID_LEN
+ 1];
361 /* The current band */
362 enum ieee80211_band band
;
364 enum nl80211_channel_type channel_type
;
366 u32 bitrate_masks
[WLCORE_NUM_BANDS
];
370 * currently configured rate set:
371 * bits 0-15 - 802.11abg rates
372 * bits 16-23 - 802.11n MCS index mask
373 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
378 /* probe-req template for the current AP */
379 struct sk_buff
*probereq
;
381 /* Beaconing interval (needed for ad-hoc) */
384 /* Default key (for WEP) */
387 /* Our association ID */
390 /* Session counter for the chipset */
393 /* retry counter for PSM entries */
402 /* save the current encryption type for auto-arp config */
406 /* RX BA constraint value */
411 struct work_struct rx_streaming_enable_work
;
412 struct work_struct rx_streaming_disable_work
;
413 struct timer_list rx_streaming_timer
;
416 * This struct must be last!
417 * data that has to be saved acrossed reconfigs (e.g. recovery)
418 * should be declared in this struct.
423 * Security sequence number
424 * bits 0-15: lower 16 bits part of sequence number
425 * bits 16-47: higher 32 bits part of sequence number
426 * bits 48-63: not in use
430 /* 8 bits of the last sequence number in use */
431 u8 tx_security_last_seq_lsb
;
435 static inline struct wl12xx_vif
*wl12xx_vif_to_data(struct ieee80211_vif
*vif
)
437 return (struct wl12xx_vif
*)vif
->drv_priv
;
441 struct ieee80211_vif
*wl12xx_wlvif_to_vif(struct wl12xx_vif
*wlvif
)
443 return container_of((void *)wlvif
, struct ieee80211_vif
, drv_priv
);
446 #define wl12xx_for_each_wlvif(wl, wlvif) \
447 list_for_each_entry(wlvif, &wl->wlvif_list, list)
449 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
450 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
452 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
453 wl12xx_for_each_wlvif(wl, wlvif) \
454 if (wlvif->bss_type == _bss_type)
456 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
457 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
459 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
460 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
462 int wl1271_plt_start(struct wl1271
*wl
);
463 int wl1271_plt_stop(struct wl1271
*wl
);
464 int wl1271_recalc_rx_streaming(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
465 void wl12xx_queue_recovery_work(struct wl1271
*wl
);
466 size_t wl12xx_copy_fwlog(struct wl1271
*wl
, u8
*memblock
, size_t maxlen
);
467 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter
*filter
,
468 u16 offset
, u8 flags
,
469 u8
*pattern
, u8 len
);
470 void wl1271_rx_filter_free(struct wl12xx_rx_filter
*filter
);
471 struct wl12xx_rx_filter
*wl1271_rx_filter_alloc(void);
472 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter
*filter
);
473 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter
*filter
,
476 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
478 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
479 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
481 #define WL1271_DEFAULT_POWER_LEVEL 0
483 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
484 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
486 #define WL1271_DEFERRED_QUEUE_LIMIT 64
488 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
489 on in case is has been shut down shortly before */
490 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
491 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
493 /* Macros to handle wl1271.sta_rate_set */
494 #define HW_BG_RATES_MASK 0xffff
495 #define HW_HT_RATES_OFFSET 16
496 #define HW_MIMO_RATES_OFFSET 24
498 #define WL12XX_HW_BLOCK_SIZE 256
500 #endif /* __WLCORE_I_H__ */