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 struct wilink_family_data {
39 const char *name;
40 const char *nvs_name; /* wl12xx nvs file */
41 const char *cfg_name; /* wl18xx cfg file */
42 };
43
44 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
45 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
46 #define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff
47 /* Use smaller padding for GEM, as some APs have issues when it's too big */
48 #define WL1271_TX_SQN_POST_RECOVERY_PADDING_GEM 0x20
49
50
51 #define WL1271_CIPHER_SUITE_GEM 0x00147201
52
53 #define WL1271_BUSY_WORD_CNT 1
54 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
55
56 #define WL1271_ELP_HW_STATE_ASLEEP 0
57 #define WL1271_ELP_HW_STATE_IRQ 1
58
59 #define WL1271_DEFAULT_BEACON_INT 100
60 #define WL1271_DEFAULT_DTIM_PERIOD 1
61
62 #define WL12XX_MAX_ROLES 4
63 #define WL12XX_INVALID_ROLE_ID 0xff
64 #define WL12XX_INVALID_LINK_ID 0xff
65
66 /*
67 * max number of links allowed by all HWs.
68 * this is NOT the actual max links supported by the current hw.
69 */
70 #define WLCORE_MAX_LINKS 16
71
72 /* the driver supports the 2.4Ghz and 5Ghz bands */
73 #define WLCORE_NUM_BANDS 2
74
75 #define WL12XX_MAX_RATE_POLICIES 16
76 #define WLCORE_MAX_KLV_TEMPLATES 4
77
78 /* Defined by FW as 0. Will not be freed or allocated. */
79 #define WL12XX_SYSTEM_HLID 0
80
81 /*
82 * When in AP-mode, we allow (at least) this number of packets
83 * to be transmitted to FW for a STA in PS-mode. Only when packets are
84 * present in the FW buffers it will wake the sleeping STA. We want to put
85 * enough packets for the driver to transmit all of its buffered data before
86 * the STA goes to sleep again. But we don't want to take too much memory
87 * as it might hurt the throughput of active STAs.
88 */
89 #define WL1271_PS_STA_MAX_PACKETS 2
90
91 #define WL1271_AP_BSS_INDEX 0
92 #define WL1271_AP_DEF_BEACON_EXP 20
93
94 enum wlcore_state {
95 WLCORE_STATE_OFF,
96 WLCORE_STATE_RESTARTING,
97 WLCORE_STATE_ON,
98 };
99
100 enum wl12xx_fw_type {
101 WL12XX_FW_TYPE_NONE,
102 WL12XX_FW_TYPE_NORMAL,
103 WL12XX_FW_TYPE_MULTI,
104 WL12XX_FW_TYPE_PLT,
105 };
106
107 struct wl1271;
108
109 enum {
110 FW_VER_CHIP,
111 FW_VER_IF_TYPE,
112 FW_VER_MAJOR,
113 FW_VER_SUBTYPE,
114 FW_VER_MINOR,
115
116 NUM_FW_VER
117 };
118
119 struct wl1271_chip {
120 u32 id;
121 char fw_ver_str[ETHTOOL_FWVERS_LEN];
122 unsigned int fw_ver[NUM_FW_VER];
123 char phy_fw_ver_str[ETHTOOL_FWVERS_LEN];
124 };
125
126 #define NUM_TX_QUEUES 4
127
128 struct wl_fw_status {
129 u32 intr;
130 u8 fw_rx_counter;
131 u8 drv_rx_counter;
132 u8 tx_results_counter;
133 __le32 *rx_pkt_descs;
134
135 u32 fw_localtime;
136
137 /*
138 * A bitmap (where each bit represents a single HLID)
139 * to indicate if the station is in PS mode.
140 */
141 u32 link_ps_bitmap;
142
143 /*
144 * A bitmap (where each bit represents a single HLID) to indicate
145 * if the station is in Fast mode
146 */
147 u32 link_fast_bitmap;
148
149 /* Cumulative counter of total released mem blocks since FW-reset */
150 u32 total_released_blks;
151
152 /* Size (in Memory Blocks) of TX pool */
153 u32 tx_total;
154
155 struct {
156 /*
157 * Cumulative counter of released packets per AC
158 * (length of the array is NUM_TX_QUEUES)
159 */
160 u8 *tx_released_pkts;
161
162 /*
163 * Cumulative counter of freed packets per HLID
164 * (length of the array is wl->num_links)
165 */
166 u8 *tx_lnk_free_pkts;
167
168 /* Cumulative counter of released Voice memory blocks */
169 u8 tx_voice_released_blks;
170
171 /* Tx rate of the last transmitted packet */
172 u8 tx_last_rate;
173
174 /* Tx rate or Tx rate estimate pre calculated by fw in mbps */
175 u8 tx_last_rate_mbps;
176
177 /* hlid for which the rates were reported */
178 u8 hlid;
179 } counters;
180
181 u32 log_start_addr;
182
183 /* Private status to be used by the lower drivers */
184 void *priv;
185 };
186
187 #define WL1271_MAX_CHANNELS 64
188 struct wl1271_scan {
189 struct cfg80211_scan_request *req;
190 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
191 bool failed;
192 u8 state;
193 u8 ssid[IEEE80211_MAX_SSID_LEN+1];
194 size_t ssid_len;
195 };
196
197 struct wl1271_if_operations {
198 int __must_check (*read)(struct device *child, int addr, void *buf,
199 size_t len, bool fixed);
200 int __must_check (*write)(struct device *child, int addr, void *buf,
201 size_t len, bool fixed);
202 void (*reset)(struct device *child);
203 void (*init)(struct device *child);
204 int (*power)(struct device *child, bool enable);
205 void (*set_block_size) (struct device *child, unsigned int blksz);
206 };
207
208 struct wlcore_platdev_data {
209 struct wl1271_if_operations *if_ops;
210 const struct wilink_family_data *family;
211
212 bool ref_clock_xtal; /* specify whether the clock is XTAL or not */
213 u32 ref_clock_freq; /* in Hertz */
214 u32 tcxo_clock_freq; /* in Hertz, tcxo is always XTAL */
215 bool pwr_in_suspend;
216 };
217
218 #define MAX_NUM_KEYS 14
219 #define MAX_KEY_SIZE 32
220
221 struct wl1271_ap_key {
222 u8 id;
223 u8 key_type;
224 u8 key_size;
225 u8 key[MAX_KEY_SIZE];
226 u8 hlid;
227 u32 tx_seq_32;
228 u16 tx_seq_16;
229 };
230
231 enum wl12xx_flags {
232 WL1271_FLAG_GPIO_POWER,
233 WL1271_FLAG_TX_QUEUE_STOPPED,
234 WL1271_FLAG_TX_PENDING,
235 WL1271_FLAG_IN_ELP,
236 WL1271_FLAG_IRQ_RUNNING,
237 WL1271_FLAG_FW_TX_BUSY,
238 WL1271_FLAG_DUMMY_PACKET_PENDING,
239 WL1271_FLAG_SUSPENDED,
240 WL1271_FLAG_PENDING_WORK,
241 WL1271_FLAG_SOFT_GEMINI,
242 WL1271_FLAG_RECOVERY_IN_PROGRESS,
243 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
244 WL1271_FLAG_INTENDED_FW_RECOVERY,
245 WL1271_FLAG_IO_FAILED,
246 WL1271_FLAG_REINIT_TX_WDOG,
247 };
248
249 enum wl12xx_vif_flags {
250 WLVIF_FLAG_INITIALIZED,
251 WLVIF_FLAG_STA_ASSOCIATED,
252 WLVIF_FLAG_STA_AUTHORIZED,
253 WLVIF_FLAG_IBSS_JOINED,
254 WLVIF_FLAG_AP_STARTED,
255 WLVIF_FLAG_IN_PS,
256 WLVIF_FLAG_STA_STATE_SENT,
257 WLVIF_FLAG_RX_STREAMING_STARTED,
258 WLVIF_FLAG_PSPOLL_FAILURE,
259 WLVIF_FLAG_CS_PROGRESS,
260 WLVIF_FLAG_AP_PROBE_RESP_SET,
261 WLVIF_FLAG_IN_USE,
262 WLVIF_FLAG_ACTIVE,
263 WLVIF_FLAG_BEACON_DISABLED,
264 };
265
266 struct wl12xx_vif;
267
268 struct 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 /* the last fw rate index we used for this link */
282 u8 fw_rate_idx;
283
284 /* the last fw rate [Mbps] we used for this link */
285 u8 fw_rate_mbps;
286
287 /* The wlvif this link belongs to. Might be null for global links */
288 struct wl12xx_vif *wlvif;
289
290 /*
291 * total freed FW packets on the link - used for tracking the
292 * AES/TKIP PN across recoveries. Re-initialized each time
293 * from the wl1271_station structure.
294 */
295 u64 total_freed_pkts;
296 };
297
298 #define WL1271_MAX_RX_FILTERS 5
299 #define WL1271_RX_FILTER_MAX_FIELDS 8
300
301 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
302 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
303 #define RX_FILTER_FIELD_OVERHEAD \
304 (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
305 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE \
306 (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
307
308 #define WL1271_RX_FILTER_FLAG_MASK BIT(0)
309 #define WL1271_RX_FILTER_FLAG_IP_HEADER 0
310 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER BIT(1)
311
312 enum rx_filter_action {
313 FILTER_DROP = 0,
314 FILTER_SIGNAL = 1,
315 FILTER_FW_HANDLE = 2
316 };
317
318 enum plt_mode {
319 PLT_OFF = 0,
320 PLT_ON = 1,
321 PLT_FEM_DETECT = 2,
322 PLT_CHIP_AWAKE = 3
323 };
324
325 struct wl12xx_rx_filter_field {
326 __le16 offset;
327 u8 len;
328 u8 flags;
329 u8 *pattern;
330 } __packed;
331
332 struct wl12xx_rx_filter {
333 u8 action;
334 int num_fields;
335 struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
336 };
337
338 struct wl1271_station {
339 u8 hlid;
340 bool in_connection;
341
342 /*
343 * total freed FW packets on the link to the STA - used for tracking the
344 * AES/TKIP PN across recoveries. Re-initialized each time from the
345 * wl1271_station structure.
346 * Used in both AP and STA mode.
347 */
348 u64 total_freed_pkts;
349 };
350
351 struct wl12xx_vif {
352 struct wl1271 *wl;
353 struct list_head list;
354 unsigned long flags;
355 u8 bss_type;
356 u8 p2p; /* we are using p2p role */
357 u8 role_id;
358
359 /* sta/ibss specific */
360 u8 dev_role_id;
361 u8 dev_hlid;
362
363 union {
364 struct {
365 u8 hlid;
366
367 u8 basic_rate_idx;
368 u8 ap_rate_idx;
369 u8 p2p_rate_idx;
370
371 u8 klv_template_id;
372
373 bool qos;
374 /* channel type we started the STA role with */
375 enum nl80211_channel_type role_chan_type;
376 } sta;
377 struct {
378 u8 global_hlid;
379 u8 bcast_hlid;
380
381 /* HLIDs bitmap of associated stations */
382 unsigned long sta_hlid_map[BITS_TO_LONGS(
383 WLCORE_MAX_LINKS)];
384
385 /* recoreded keys - set here before AP startup */
386 struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
387
388 u8 mgmt_rate_idx;
389 u8 bcast_rate_idx;
390 u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
391 } ap;
392 };
393
394 /* the hlid of the last transmitted skb */
395 int last_tx_hlid;
396
397 /* counters of packets per AC, across all links in the vif */
398 int tx_queue_count[NUM_TX_QUEUES];
399
400 unsigned long links_map[BITS_TO_LONGS(WLCORE_MAX_LINKS)];
401
402 u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
403 u8 ssid_len;
404
405 /* The current band */
406 enum nl80211_band band;
407 int channel;
408 enum nl80211_channel_type channel_type;
409
410 u32 bitrate_masks[WLCORE_NUM_BANDS];
411 u32 basic_rate_set;
412
413 /*
414 * currently configured rate set:
415 * bits 0-15 - 802.11abg rates
416 * bits 16-23 - 802.11n MCS index mask
417 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
418 */
419 u32 basic_rate;
420 u32 rate_set;
421
422 /* probe-req template for the current AP */
423 struct sk_buff *probereq;
424
425 /* Beaconing interval (needed for ad-hoc) */
426 u32 beacon_int;
427
428 /* Default key (for WEP) */
429 u32 default_key;
430
431 /* Our association ID */
432 u16 aid;
433
434 /* retry counter for PSM entries */
435 u8 psm_entry_retry;
436
437 /* in dBm */
438 int power_level;
439
440 int rssi_thold;
441 int last_rssi_event;
442
443 /* save the current encryption type for auto-arp config */
444 u8 encryption_type;
445 __be32 ip_addr;
446
447 /* RX BA constraint value */
448 bool ba_support;
449 bool ba_allowed;
450
451 bool wmm_enabled;
452
453 bool radar_enabled;
454
455 /* Rx Streaming */
456 struct work_struct rx_streaming_enable_work;
457 struct work_struct rx_streaming_disable_work;
458 struct timer_list rx_streaming_timer;
459
460 struct delayed_work channel_switch_work;
461 struct delayed_work connection_loss_work;
462
463 /* number of in connection stations */
464 int inconn_count;
465
466 /*
467 * This vif's queues are mapped to mac80211 HW queues as:
468 * VO - hw_queue_base
469 * VI - hw_queue_base + 1
470 * BE - hw_queue_base + 2
471 * BK - hw_queue_base + 3
472 */
473 int hw_queue_base;
474
475 /* do we have a pending auth reply? (and ROC) */
476 bool ap_pending_auth_reply;
477
478 /* time when we sent the pending auth reply */
479 unsigned long pending_auth_reply_time;
480
481 /* work for canceling ROC after pending auth reply */
482 struct delayed_work pending_auth_complete_work;
483
484 /* update rate conrol */
485 enum ieee80211_sta_rx_bandwidth rc_update_bw;
486 struct ieee80211_sta_ht_cap rc_ht_cap;
487 struct work_struct rc_update_work;
488
489 /*
490 * total freed FW packets on the link.
491 * For STA this holds the PN of the link to the AP.
492 * For AP this holds the PN of the broadcast link.
493 */
494 u64 total_freed_pkts;
495
496 /*
497 * This struct must be last!
498 * data that has to be saved acrossed reconfigs (e.g. recovery)
499 * should be declared in this struct.
500 */
501 struct {
502 u8 persistent[0];
503 };
504 };
505
wl12xx_vif_to_data(struct ieee80211_vif * vif)506 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
507 {
508 WARN_ON(!vif);
509 return (struct wl12xx_vif *)vif->drv_priv;
510 }
511
512 static inline
wl12xx_wlvif_to_vif(struct wl12xx_vif * wlvif)513 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
514 {
515 return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
516 }
517
wlcore_is_p2p_mgmt(struct wl12xx_vif * wlvif)518 static inline bool wlcore_is_p2p_mgmt(struct wl12xx_vif *wlvif)
519 {
520 return wl12xx_wlvif_to_vif(wlvif)->type == NL80211_IFTYPE_P2P_DEVICE;
521 }
522
523 #define wl12xx_for_each_wlvif(wl, wlvif) \
524 list_for_each_entry(wlvif, &wl->wlvif_list, list)
525
526 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
527 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
528
529 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
530 wl12xx_for_each_wlvif(wl, wlvif) \
531 if (wlvif->bss_type == _bss_type)
532
533 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
534 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
535
536 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
537 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
538
539 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
540 int wl1271_plt_stop(struct wl1271 *wl);
541 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
542 void wl12xx_queue_recovery_work(struct wl1271 *wl);
543 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
544 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
545 u16 offset, u8 flags,
546 const u8 *pattern, u8 len);
547 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
548 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
549 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
550 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
551 u8 *buf);
552
553 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
554
555 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
556 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
557
558 #define WL1271_DEFAULT_POWER_LEVEL 0
559
560 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
561 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
562
563 #define WL1271_DEFERRED_QUEUE_LIMIT 64
564
565 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
566 on in case is has been shut down shortly before */
567 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
568 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
569
570 /* Macros to handle wl1271.sta_rate_set */
571 #define HW_BG_RATES_MASK 0xffff
572 #define HW_HT_RATES_OFFSET 16
573 #define HW_MIMO_RATES_OFFSET 24
574
575 #endif /* __WLCORE_I_H__ */
576
