wlcore_i.h revision f1a26e638e646d971f77c5a5186ee254b3f4e818 
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 (5 * 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
135#define NUM_TX_QUEUES              4
136
137#define AP_MAX_STATIONS            8
138
139struct wl_fw_packet_counters {
140	/* Cumulative counter of released packets per AC */
141	u8 tx_released_pkts[NUM_TX_QUEUES];
142
143	/* Cumulative counter of freed packets per HLID */
144	u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
145
146	/* Cumulative counter of released Voice memory blocks */
147	u8 tx_voice_released_blks;
148
149	u8 padding[3];
150} __packed;
151
152/* FW status registers */
153struct wl_fw_status_1 {
154	__le32 intr;
155	u8  fw_rx_counter;
156	u8  drv_rx_counter;
157	u8  reserved;
158	u8  tx_results_counter;
159	__le32 rx_pkt_descs[0];
160} __packed;
161
162/*
163 * Each HW arch has a different number of Rx descriptors.
164 * The length of the status depends on it, since it holds an array
165 * of descriptors.
166 */
167#define WLCORE_FW_STATUS_1_LEN(num_rx_desc) \
168		(sizeof(struct wl_fw_status_1) + \
169		(sizeof(((struct wl_fw_status_1 *)0)->rx_pkt_descs[0])) * \
170		num_rx_desc)
171
172struct wl_fw_status_2 {
173	__le32 fw_localtime;
174
175	/*
176	 * A bitmap (where each bit represents a single HLID)
177	 * to indicate if the station is in PS mode.
178	 */
179	__le32 link_ps_bitmap;
180
181	/*
182	 * A bitmap (where each bit represents a single HLID) to indicate
183	 * if the station is in Fast mode
184	 */
185	__le32 link_fast_bitmap;
186
187	/* Cumulative counter of total released mem blocks since FW-reset */
188	__le32 total_released_blks;
189
190	/* Size (in Memory Blocks) of TX pool */
191	__le32 tx_total;
192
193	struct wl_fw_packet_counters counters;
194
195	__le32 log_start_addr;
196
197	/* Private status to be used by the lower drivers */
198	u8 priv[0];
199} __packed;
200
201#define WL1271_MAX_CHANNELS 64
202struct wl1271_scan {
203	struct cfg80211_scan_request *req;
204	unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
205	bool failed;
206	u8 state;
207	u8 ssid[IEEE80211_MAX_SSID_LEN+1];
208	size_t ssid_len;
209};
210
211struct wl1271_if_operations {
212	int __must_check (*read)(struct device *child, int addr, void *buf,
213				 size_t len, bool fixed);
214	int __must_check (*write)(struct device *child, int addr, void *buf,
215				  size_t len, bool fixed);
216	void (*reset)(struct device *child);
217	void (*init)(struct device *child);
218	int (*power)(struct device *child, bool enable);
219	void (*set_block_size) (struct device *child, unsigned int blksz);
220};
221
222#define MAX_NUM_KEYS 14
223#define MAX_KEY_SIZE 32
224
225struct wl1271_ap_key {
226	u8 id;
227	u8 key_type;
228	u8 key_size;
229	u8 key[MAX_KEY_SIZE];
230	u8 hlid;
231	u32 tx_seq_32;
232	u16 tx_seq_16;
233};
234
235enum wl12xx_flags {
236	WL1271_FLAG_GPIO_POWER,
237	WL1271_FLAG_TX_QUEUE_STOPPED,
238	WL1271_FLAG_TX_PENDING,
239	WL1271_FLAG_IN_ELP,
240	WL1271_FLAG_ELP_REQUESTED,
241	WL1271_FLAG_IRQ_RUNNING,
242	WL1271_FLAG_FW_TX_BUSY,
243	WL1271_FLAG_DUMMY_PACKET_PENDING,
244	WL1271_FLAG_SUSPENDED,
245	WL1271_FLAG_PENDING_WORK,
246	WL1271_FLAG_SOFT_GEMINI,
247	WL1271_FLAG_RECOVERY_IN_PROGRESS,
248	WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
249	WL1271_FLAG_INTENDED_FW_RECOVERY,
250};
251
252enum wl12xx_vif_flags {
253	WLVIF_FLAG_INITIALIZED,
254	WLVIF_FLAG_STA_ASSOCIATED,
255	WLVIF_FLAG_STA_AUTHORIZED,
256	WLVIF_FLAG_IBSS_JOINED,
257	WLVIF_FLAG_AP_STARTED,
258	WLVIF_FLAG_IN_PS,
259	WLVIF_FLAG_STA_STATE_SENT,
260	WLVIF_FLAG_RX_STREAMING_STARTED,
261	WLVIF_FLAG_PSPOLL_FAILURE,
262	WLVIF_FLAG_CS_PROGRESS,
263	WLVIF_FLAG_AP_PROBE_RESP_SET,
264	WLVIF_FLAG_IN_USE,
265};
266
267struct wl1271_link {
268	/* AP-mode - TX queue per AC in link */
269	struct sk_buff_head tx_queue[NUM_TX_QUEUES];
270
271	/* accounting for allocated / freed packets in FW */
272	u8 allocated_pkts;
273	u8 prev_freed_pkts;
274
275	u8 addr[ETH_ALEN];
276
277	/* bitmap of TIDs where RX BA sessions are active for this link */
278	u8 ba_bitmap;
279};
280
281#define WL1271_MAX_RX_FILTERS 5
282#define WL1271_RX_FILTER_MAX_FIELDS 8
283
284#define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
285#define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
286#define RX_FILTER_FIELD_OVERHEAD				\
287	(sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
288#define WL1271_RX_FILTER_MAX_PATTERN_SIZE			\
289	(WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
290
291#define WL1271_RX_FILTER_FLAG_MASK                BIT(0)
292#define WL1271_RX_FILTER_FLAG_IP_HEADER           0
293#define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER     BIT(1)
294
295enum rx_filter_action {
296	FILTER_DROP = 0,
297	FILTER_SIGNAL = 1,
298	FILTER_FW_HANDLE = 2
299};
300
301struct wl12xx_rx_filter_field {
302	__le16 offset;
303	u8 len;
304	u8 flags;
305	u8 *pattern;
306} __packed;
307
308struct wl12xx_rx_filter {
309	u8 action;
310	int num_fields;
311	struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
312};
313
314struct wl1271_station {
315	u8 hlid;
316};
317
318struct wl12xx_vif {
319	struct wl1271 *wl;
320	struct list_head list;
321	unsigned long flags;
322	u8 bss_type;
323	u8 p2p; /* we are using p2p role */
324	u8 role_id;
325
326	/* sta/ibss specific */
327	u8 dev_role_id;
328	u8 dev_hlid;
329
330	union {
331		struct {
332			u8 hlid;
333			u8 ba_rx_bitmap;
334
335			u8 basic_rate_idx;
336			u8 ap_rate_idx;
337			u8 p2p_rate_idx;
338
339			bool qos;
340		} sta;
341		struct {
342			u8 global_hlid;
343			u8 bcast_hlid;
344
345			/* HLIDs bitmap of associated stations */
346			unsigned long sta_hlid_map[BITS_TO_LONGS(
347							WL12XX_MAX_LINKS)];
348
349			/* recoreded keys - set here before AP startup */
350			struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
351
352			u8 mgmt_rate_idx;
353			u8 bcast_rate_idx;
354			u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
355		} ap;
356	};
357
358	/* the hlid of the last transmitted skb */
359	int last_tx_hlid;
360
361	unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
362
363	u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
364	u8 ssid_len;
365
366	/* The current band */
367	enum ieee80211_band band;
368	int channel;
369	enum nl80211_channel_type channel_type;
370
371	u32 bitrate_masks[IEEE80211_NUM_BANDS];
372	u32 basic_rate_set;
373
374	/*
375	 * currently configured rate set:
376	 *	bits  0-15 - 802.11abg rates
377	 *	bits 16-23 - 802.11n   MCS index mask
378	 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
379	 */
380	u32 basic_rate;
381	u32 rate_set;
382
383	/* probe-req template for the current AP */
384	struct sk_buff *probereq;
385
386	/* Beaconing interval (needed for ad-hoc) */
387	u32 beacon_int;
388
389	/* Default key (for WEP) */
390	u32 default_key;
391
392	/* Our association ID */
393	u16 aid;
394
395	/* Session counter for the chipset */
396	int session_counter;
397
398	/* retry counter for PSM entries */
399	u8 psm_entry_retry;
400
401	/* in dBm */
402	int power_level;
403
404	int rssi_thold;
405	int last_rssi_event;
406
407	/* save the current encryption type for auto-arp config */
408	u8 encryption_type;
409	__be32 ip_addr;
410
411	/* RX BA constraint value */
412	bool ba_support;
413	bool ba_allowed;
414
415	/* Rx Streaming */
416	struct work_struct rx_streaming_enable_work;
417	struct work_struct rx_streaming_disable_work;
418	struct timer_list rx_streaming_timer;
419
420	/*
421	 * This struct must be last!
422	 * data that has to be saved acrossed reconfigs (e.g. recovery)
423	 * should be declared in this struct.
424	 */
425	struct {
426		u8 persistent[0];
427		/*
428		 * Security sequence number
429		 *     bits 0-15: lower 16 bits part of sequence number
430		 *     bits 16-47: higher 32 bits part of sequence number
431		 *     bits 48-63: not in use
432		 */
433		u64 tx_security_seq;
434
435		/* 8 bits of the last sequence number in use */
436		u8 tx_security_last_seq_lsb;
437	};
438};
439
440static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
441{
442	return (struct wl12xx_vif *)vif->drv_priv;
443}
444
445static inline
446struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
447{
448	return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
449}
450
451#define wl12xx_for_each_wlvif(wl, wlvif) \
452		list_for_each_entry(wlvif, &wl->wlvif_list, list)
453
454#define wl12xx_for_each_wlvif_continue(wl, wlvif) \
455		list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
456
457#define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type)	\
458		wl12xx_for_each_wlvif(wl, wlvif)		\
459			if (wlvif->bss_type == _bss_type)
460
461#define wl12xx_for_each_wlvif_sta(wl, wlvif)	\
462		wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
463
464#define wl12xx_for_each_wlvif_ap(wl, wlvif)	\
465		wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
466
467int wl1271_plt_start(struct wl1271 *wl);
468int wl1271_plt_stop(struct wl1271 *wl);
469int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
470void wl12xx_queue_recovery_work(struct wl1271 *wl);
471size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
472int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
473					u16 offset, u8 flags,
474					u8 *pattern, u8 len);
475void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
476struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
477int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
478void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
479				     u8 *buf);
480
481#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
482
483#define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
484#define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
485
486#define WL1271_DEFAULT_POWER_LEVEL 0
487
488#define WL1271_TX_QUEUE_LOW_WATERMARK  32
489#define WL1271_TX_QUEUE_HIGH_WATERMARK 256
490
491#define WL1271_DEFERRED_QUEUE_LIMIT    64
492
493/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
494   on in case is has been shut down shortly before */
495#define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
496#define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
497
498/* Macros to handle wl1271.sta_rate_set */
499#define HW_BG_RATES_MASK	0xffff
500#define HW_HT_RATES_OFFSET	16
501#define HW_MIMO_RATES_OFFSET	24
502
503#define WL12XX_HW_BLOCK_SIZE	256
504
505#endif /* __WLCORE_I_H__ */
506