wlcore_i.h revision 8388569a34396fccee22ae8348ca624959694ce0 
1/*
2 * This file is part of wl1271
3 *
4 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
5 * Copyright (C) 2008-2009 Nokia Corporation
6 *
7 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
8 *
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.
12 *
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.
17 *
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
21 * 02110-1301 USA
22 *
23 */
24
25#ifndef __WLCORE_I_H__
26#define __WLCORE_I_H__
27
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>
34
35#include "conf.h"
36#include "ini.h"
37
38#define WL127X_FW_NAME_MULTI "ti-connectivity/wl127x-fw-4-mr.bin"
39#define WL127X_FW_NAME_SINGLE "ti-connectivity/wl127x-fw-4-sr.bin"
40
41#define WL128X_FW_NAME_MULTI "ti-connectivity/wl128x-fw-4-mr.bin"
42#define WL128X_FW_NAME_SINGLE "ti-connectivity/wl128x-fw-4-sr.bin"
43
44#define WL127X_PLT_FW_NAME "ti-connectivity/wl127x-fw-4-plt.bin"
45#define WL128X_PLT_FW_NAME "ti-connectivity/wl128x-fw-4-plt.bin"
46
47/*
48 * wl127x and wl128x are using the same NVS file name. However, the
49 * ini parameters between them are different.  The driver validates
50 * the correct NVS size in wl1271_boot_upload_nvs().
51 */
52#define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
53
54#define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
55#define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
56#define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff
57
58#define WL1271_CIPHER_SUITE_GEM 0x00147201
59
60#define WL1271_BUSY_WORD_CNT 1
61#define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
62
63#define WL1271_ELP_HW_STATE_ASLEEP 0
64#define WL1271_ELP_HW_STATE_IRQ    1
65
66#define WL1271_DEFAULT_BEACON_INT  100
67#define WL1271_DEFAULT_DTIM_PERIOD 1
68
69#define WL12XX_MAX_ROLES           4
70#define WL12XX_MAX_LINKS           12
71#define WL12XX_INVALID_ROLE_ID     0xff
72#define WL12XX_INVALID_LINK_ID     0xff
73
74#define WL12XX_MAX_RATE_POLICIES 16
75
76/* Defined by FW as 0. Will not be freed or allocated. */
77#define WL12XX_SYSTEM_HLID         0
78
79/*
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.
86 */
87#define WL1271_PS_STA_MAX_PACKETS  2
88
89#define WL1271_AP_BSS_INDEX        0
90#define WL1271_AP_DEF_BEACON_EXP   20
91
92#define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
93
94enum wl1271_state {
95	WL1271_STATE_OFF,
96	WL1271_STATE_ON,
97};
98
99enum wl12xx_fw_type {
100	WL12XX_FW_TYPE_NONE,
101	WL12XX_FW_TYPE_NORMAL,
102	WL12XX_FW_TYPE_MULTI,
103	WL12XX_FW_TYPE_PLT,
104};
105
106struct wl1271;
107
108enum {
109	FW_VER_CHIP,
110	FW_VER_IF_TYPE,
111	FW_VER_MAJOR,
112	FW_VER_SUBTYPE,
113	FW_VER_MINOR,
114
115	NUM_FW_VER
116};
117
118#define FW_VER_CHIP_WL127X 6
119#define FW_VER_CHIP_WL128X 7
120
121#define FW_VER_IF_TYPE_STA 1
122#define FW_VER_IF_TYPE_AP  2
123
124#define FW_VER_MINOR_1_SPARE_STA_MIN 58
125#define FW_VER_MINOR_1_SPARE_AP_MIN  47
126
127#define FW_VER_MINOR_FWLOG_STA_MIN 70
128
129struct wl1271_chip {
130	u32 id;
131	char fw_ver_str[ETHTOOL_BUSINFO_LEN];
132	unsigned int fw_ver[NUM_FW_VER];
133};
134
135struct wl1271_stats {
136	struct acx_statistics *fw_stats;
137	unsigned long fw_stats_update;
138
139	unsigned int retry_count;
140	unsigned int excessive_retries;
141};
142
143#define NUM_TX_QUEUES              4
144#define NUM_RX_PKT_DESC            8
145
146#define AP_MAX_STATIONS            8
147
148struct wl_fw_packet_counters {
149	/* Cumulative counter of released packets per AC */
150	u8 tx_released_pkts[NUM_TX_QUEUES];
151
152	/* Cumulative counter of freed packets per HLID */
153	u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
154
155	/* Cumulative counter of released Voice memory blocks */
156	u8 tx_voice_released_blks;
157
158	u8 padding[3];
159} __packed;
160
161/* FW status registers */
162struct wl_fw_status {
163	__le32 intr;
164	u8  fw_rx_counter;
165	u8  drv_rx_counter;
166	u8  reserved;
167	u8  tx_results_counter;
168	__le32 rx_pkt_descs[NUM_RX_PKT_DESC];
169	__le32 fw_localtime;
170
171	/*
172	 * A bitmap (where each bit represents a single HLID)
173	 * to indicate if the station is in PS mode.
174	 */
175	__le32 link_ps_bitmap;
176
177	/*
178	 * A bitmap (where each bit represents a single HLID) to indicate
179	 * if the station is in Fast mode
180	 */
181	__le32 link_fast_bitmap;
182
183	/* Cumulative counter of total released mem blocks since FW-reset */
184	__le32 total_released_blks;
185
186	/* Size (in Memory Blocks) of TX pool */
187	__le32 tx_total;
188
189	struct wl_fw_packet_counters counters;
190
191	__le32 log_start_addr;
192
193	/* Private status to be used by the lower drivers */
194	u8 priv[0];
195} __packed;
196
197struct wl1271_rx_mem_pool_addr {
198	u32 addr;
199	u32 addr_extra;
200};
201
202#define WL1271_MAX_CHANNELS 64
203struct wl1271_scan {
204	struct cfg80211_scan_request *req;
205	unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
206	bool failed;
207	u8 state;
208	u8 ssid[IEEE80211_MAX_SSID_LEN+1];
209	size_t ssid_len;
210};
211
212struct wl1271_if_operations {
213	void (*read)(struct device *child, int addr, void *buf, size_t len,
214		     bool fixed);
215	void (*write)(struct device *child, int addr, void *buf, size_t len,
216		     bool fixed);
217	void (*reset)(struct device *child);
218	void (*init)(struct device *child);
219	int (*power)(struct device *child, bool enable);
220	void (*set_block_size) (struct device *child, unsigned int blksz);
221};
222
223#define MAX_NUM_KEYS 14
224#define MAX_KEY_SIZE 32
225
226struct wl1271_ap_key {
227	u8 id;
228	u8 key_type;
229	u8 key_size;
230	u8 key[MAX_KEY_SIZE];
231	u8 hlid;
232	u32 tx_seq_32;
233	u16 tx_seq_16;
234};
235
236enum wl12xx_flags {
237	WL1271_FLAG_GPIO_POWER,
238	WL1271_FLAG_TX_QUEUE_STOPPED,
239	WL1271_FLAG_TX_PENDING,
240	WL1271_FLAG_IN_ELP,
241	WL1271_FLAG_ELP_REQUESTED,
242	WL1271_FLAG_IRQ_RUNNING,
243	WL1271_FLAG_FW_TX_BUSY,
244	WL1271_FLAG_DUMMY_PACKET_PENDING,
245	WL1271_FLAG_SUSPENDED,
246	WL1271_FLAG_PENDING_WORK,
247	WL1271_FLAG_SOFT_GEMINI,
248	WL1271_FLAG_RECOVERY_IN_PROGRESS,
249	WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
250	WL1271_FLAG_INTENDED_FW_RECOVERY,
251};
252
253enum wl12xx_vif_flags {
254	WLVIF_FLAG_INITIALIZED,
255	WLVIF_FLAG_STA_ASSOCIATED,
256	WLVIF_FLAG_STA_AUTHORIZED,
257	WLVIF_FLAG_IBSS_JOINED,
258	WLVIF_FLAG_AP_STARTED,
259	WLVIF_FLAG_IN_PS,
260	WLVIF_FLAG_STA_STATE_SENT,
261	WLVIF_FLAG_RX_STREAMING_STARTED,
262	WLVIF_FLAG_PSPOLL_FAILURE,
263	WLVIF_FLAG_CS_PROGRESS,
264	WLVIF_FLAG_AP_PROBE_RESP_SET,
265	WLVIF_FLAG_IN_USE,
266};
267
268struct wl1271_link {
269	/* AP-mode - TX queue per AC in link */
270	struct sk_buff_head tx_queue[NUM_TX_QUEUES];
271
272	/* accounting for allocated / freed packets in FW */
273	u8 allocated_pkts;
274	u8 prev_freed_pkts;
275
276	u8 addr[ETH_ALEN];
277
278	/* bitmap of TIDs where RX BA sessions are active for this link */
279	u8 ba_bitmap;
280};
281
282#define WL1271_MAX_RX_FILTERS 5
283#define WL1271_RX_FILTER_MAX_FIELDS 8
284
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)
291
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)
295
296enum rx_filter_action {
297	FILTER_DROP = 0,
298	FILTER_SIGNAL = 1,
299	FILTER_FW_HANDLE = 2
300};
301
302struct wl12xx_rx_filter_field {
303	__le16 offset;
304	u8 len;
305	u8 flags;
306	u8 *pattern;
307} __packed;
308
309struct wl12xx_rx_filter {
310	u8 action;
311	int num_fields;
312	struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
313};
314
315struct wl1271_station {
316	u8 hlid;
317};
318
319struct wl12xx_vif {
320	struct wl1271 *wl;
321	struct list_head list;
322	unsigned long flags;
323	u8 bss_type;
324	u8 p2p; /* we are using p2p role */
325	u8 role_id;
326
327	/* sta/ibss specific */
328	u8 dev_role_id;
329	u8 dev_hlid;
330
331	union {
332		struct {
333			u8 hlid;
334			u8 ba_rx_bitmap;
335
336			u8 basic_rate_idx;
337			u8 ap_rate_idx;
338			u8 p2p_rate_idx;
339
340			bool qos;
341		} sta;
342		struct {
343			u8 global_hlid;
344			u8 bcast_hlid;
345
346			/* HLIDs bitmap of associated stations */
347			unsigned long sta_hlid_map[BITS_TO_LONGS(
348							WL12XX_MAX_LINKS)];
349
350			/* recoreded keys - set here before AP startup */
351			struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
352
353			u8 mgmt_rate_idx;
354			u8 bcast_rate_idx;
355			u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
356		} ap;
357	};
358
359	/* the hlid of the last transmitted skb */
360	int last_tx_hlid;
361
362	unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
363
364	u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
365	u8 ssid_len;
366
367	/* The current band */
368	enum ieee80211_band band;
369	int channel;
370	enum nl80211_channel_type channel_type;
371
372	u32 bitrate_masks[IEEE80211_NUM_BANDS];
373	u32 basic_rate_set;
374
375	/*
376	 * currently configured rate set:
377	 *	bits  0-15 - 802.11abg rates
378	 *	bits 16-23 - 802.11n   MCS index mask
379	 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
380	 */
381	u32 basic_rate;
382	u32 rate_set;
383
384	/* probe-req template for the current AP */
385	struct sk_buff *probereq;
386
387	/* Beaconing interval (needed for ad-hoc) */
388	u32 beacon_int;
389
390	/* Default key (for WEP) */
391	u32 default_key;
392
393	/* Our association ID */
394	u16 aid;
395
396	/* Session counter for the chipset */
397	int session_counter;
398
399	/* retry counter for PSM entries */
400	u8 psm_entry_retry;
401
402	/* in dBm */
403	int power_level;
404
405	int rssi_thold;
406	int last_rssi_event;
407
408	/* save the current encryption type for auto-arp config */
409	u8 encryption_type;
410	__be32 ip_addr;
411
412	/* RX BA constraint value */
413	bool ba_support;
414	bool ba_allowed;
415
416	/* Rx Streaming */
417	struct work_struct rx_streaming_enable_work;
418	struct work_struct rx_streaming_disable_work;
419	struct timer_list rx_streaming_timer;
420
421	/* does the current role use GEM for encryption (AP or STA) */
422	bool is_gem;
423
424	/*
425	 * This struct must be last!
426	 * data that has to be saved acrossed reconfigs (e.g. recovery)
427	 * should be declared in this struct.
428	 */
429	struct {
430		u8 persistent[0];
431		/*
432		 * Security sequence number
433		 *     bits 0-15: lower 16 bits part of sequence number
434		 *     bits 16-47: higher 32 bits part of sequence number
435		 *     bits 48-63: not in use
436		 */
437		u64 tx_security_seq;
438
439		/* 8 bits of the last sequence number in use */
440		u8 tx_security_last_seq_lsb;
441	};
442};
443
444static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
445{
446	return (struct wl12xx_vif *)vif->drv_priv;
447}
448
449static inline
450struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
451{
452	return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
453}
454
455#define wl12xx_for_each_wlvif(wl, wlvif) \
456		list_for_each_entry(wlvif, &wl->wlvif_list, list)
457
458#define wl12xx_for_each_wlvif_continue(wl, wlvif) \
459		list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
460
461#define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type)	\
462		wl12xx_for_each_wlvif(wl, wlvif)		\
463			if (wlvif->bss_type == _bss_type)
464
465#define wl12xx_for_each_wlvif_sta(wl, wlvif)	\
466		wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
467
468#define wl12xx_for_each_wlvif_ap(wl, wlvif)	\
469		wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
470
471int wl1271_plt_start(struct wl1271 *wl);
472int wl1271_plt_stop(struct wl1271 *wl);
473int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
474void wl12xx_queue_recovery_work(struct wl1271 *wl);
475size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
476int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
477					u16 offset, u8 flags,
478					u8 *pattern, u8 len);
479void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
480struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
481int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
482void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
483				     u8 *buf);
484
485#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
486
487#define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
488#define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
489
490#define WL1271_DEFAULT_POWER_LEVEL 0
491
492#define WL1271_TX_QUEUE_LOW_WATERMARK  32
493#define WL1271_TX_QUEUE_HIGH_WATERMARK 256
494
495#define WL1271_DEFERRED_QUEUE_LIMIT    64
496
497/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
498   on in case is has been shut down shortly before */
499#define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
500#define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
501
502/* Macros to handle wl1271.sta_rate_set */
503#define HW_BG_RATES_MASK	0xffff
504#define HW_HT_RATES_OFFSET	16
505#define HW_MIMO_RATES_OFFSET	24
506
507#define WL12XX_HW_BLOCK_SIZE	256
508
509#endif /* __WLCORE_I_H__ */
510