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 __WL12XX_H__
26 #define __WL12XX_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 ACX_TX_DESCRIPTORS 16
93
94 #define WL1271_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
95
96 enum wl1271_state {
97 WL1271_STATE_OFF,
98 WL1271_STATE_ON,
99 };
100
101 enum wl12xx_fw_type {
102 WL12XX_FW_TYPE_NONE,
103 WL12XX_FW_TYPE_NORMAL,
104 WL12XX_FW_TYPE_MULTI,
105 WL12XX_FW_TYPE_PLT,
106 };
107
108 enum wl1271_partition_type {
109 PART_DOWN,
110 PART_WORK,
111 PART_DRPW,
112
113 PART_TABLE_LEN
114 };
115
116 struct wl1271_partition {
117 u32 size;
118 u32 start;
119 };
120
121 struct wl1271_partition_set {
122 struct wl1271_partition mem;
123 struct wl1271_partition reg;
124 struct wl1271_partition mem2;
125 struct wl1271_partition mem3;
126 };
127
128 struct wl1271;
129
130 enum {
131 FW_VER_CHIP,
132 FW_VER_IF_TYPE,
133 FW_VER_MAJOR,
134 FW_VER_SUBTYPE,
135 FW_VER_MINOR,
136
137 NUM_FW_VER
138 };
139
140 #define FW_VER_CHIP_WL127X 6
141 #define FW_VER_CHIP_WL128X 7
142
143 #define FW_VER_IF_TYPE_STA 1
144 #define FW_VER_IF_TYPE_AP 2
145
146 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
147 #define FW_VER_MINOR_1_SPARE_AP_MIN 47
148
149 #define FW_VER_MINOR_FWLOG_STA_MIN 70
150
151 struct wl1271_chip {
152 u32 id;
153 char fw_ver_str[ETHTOOL_BUSINFO_LEN];
154 unsigned int fw_ver[NUM_FW_VER];
155 };
156
157 struct wl1271_stats {
158 struct acx_statistics *fw_stats;
159 unsigned long fw_stats_update;
160
161 unsigned int retry_count;
162 unsigned int excessive_retries;
163 };
164
165 #define NUM_TX_QUEUES 4
166 #define NUM_RX_PKT_DESC 8
167
168 #define AP_MAX_STATIONS 8
169
170 /* FW status registers */
171 struct wl12xx_fw_status {
172 __le32 intr;
173 u8 fw_rx_counter;
174 u8 drv_rx_counter;
175 u8 reserved;
176 u8 tx_results_counter;
177 __le32 rx_pkt_descs[NUM_RX_PKT_DESC];
178 __le32 fw_localtime;
179
180 /*
181 * A bitmap (where each bit represents a single HLID)
182 * to indicate if the station is in PS mode.
183 */
184 __le32 link_ps_bitmap;
185
186 /*
187 * A bitmap (where each bit represents a single HLID) to indicate
188 * if the station is in Fast mode
189 */
190 __le32 link_fast_bitmap;
191
192 /* Cumulative counter of total released mem blocks since FW-reset */
193 __le32 total_released_blks;
194
195 /* Size (in Memory Blocks) of TX pool */
196 __le32 tx_total;
197
198 /* Cumulative counter of released packets per AC */
199 u8 tx_released_pkts[NUM_TX_QUEUES];
200
201 /* Cumulative counter of freed packets per HLID */
202 u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
203
204 /* Cumulative counter of released Voice memory blocks */
205 u8 tx_voice_released_blks;
206 u8 padding_1[3];
207 __le32 log_start_addr;
208 } __packed;
209
210 struct wl1271_rx_mem_pool_addr {
211 u32 addr;
212 u32 addr_extra;
213 };
214
215 #define WL1271_MAX_CHANNELS 64
216 struct wl1271_scan {
217 struct cfg80211_scan_request *req;
218 unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
219 bool failed;
220 u8 state;
221 u8 ssid[IEEE80211_MAX_SSID_LEN+1];
222 size_t ssid_len;
223 };
224
225 struct wl1271_if_operations {
226 void (*read)(struct device *child, int addr, void *buf, size_t len,
227 bool fixed);
228 void (*write)(struct device *child, int addr, void *buf, size_t len,
229 bool fixed);
230 void (*reset)(struct device *child);
231 void (*init)(struct device *child);
232 int (*power)(struct device *child, bool enable);
233 void (*set_block_size) (struct device *child, unsigned int blksz);
234 };
235
236 #define MAX_NUM_KEYS 14
237 #define MAX_KEY_SIZE 32
238
239 struct wl1271_ap_key {
240 u8 id;
241 u8 key_type;
242 u8 key_size;
243 u8 key[MAX_KEY_SIZE];
244 u8 hlid;
245 u32 tx_seq_32;
246 u16 tx_seq_16;
247 };
248
249 enum wl12xx_flags {
250 WL1271_FLAG_GPIO_POWER,
251 WL1271_FLAG_TX_QUEUE_STOPPED,
252 WL1271_FLAG_TX_PENDING,
253 WL1271_FLAG_IN_ELP,
254 WL1271_FLAG_ELP_REQUESTED,
255 WL1271_FLAG_IRQ_RUNNING,
256 WL1271_FLAG_FW_TX_BUSY,
257 WL1271_FLAG_DUMMY_PACKET_PENDING,
258 WL1271_FLAG_SUSPENDED,
259 WL1271_FLAG_PENDING_WORK,
260 WL1271_FLAG_SOFT_GEMINI,
261 WL1271_FLAG_RECOVERY_IN_PROGRESS,
262 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
263 WL1271_FLAG_INTENDED_FW_RECOVERY,
264 };
265
266 enum wl12xx_vif_flags {
267 WLVIF_FLAG_INITIALIZED,
268 WLVIF_FLAG_STA_ASSOCIATED,
269 WLVIF_FLAG_STA_AUTHORIZED,
270 WLVIF_FLAG_IBSS_JOINED,
271 WLVIF_FLAG_AP_STARTED,
272 WLVIF_FLAG_IN_PS,
273 WLVIF_FLAG_STA_STATE_SENT,
274 WLVIF_FLAG_RX_STREAMING_STARTED,
275 WLVIF_FLAG_PSPOLL_FAILURE,
276 WLVIF_FLAG_CS_PROGRESS,
277 WLVIF_FLAG_AP_PROBE_RESP_SET,
278 WLVIF_FLAG_IN_USE,
279 };
280
281 struct wl1271_link {
282 /* AP-mode - TX queue per AC in link */
283 struct sk_buff_head tx_queue[NUM_TX_QUEUES];
284
285 /* accounting for allocated / freed packets in FW */
286 u8 allocated_pkts;
287 u8 prev_freed_pkts;
288
289 u8 addr[ETH_ALEN];
290
291 /* bitmap of TIDs where RX BA sessions are active for this link */
292 u8 ba_bitmap;
293 };
294
295 struct wl1271 {
296 struct ieee80211_hw *hw;
297 bool mac80211_registered;
298
299 struct device *dev;
300
301 void *if_priv;
302
303 struct wl1271_if_operations *if_ops;
304
305 void (*set_power)(bool enable);
306 int irq;
307 int ref_clock;
308
309 spinlock_t wl_lock;
310
311 enum wl1271_state state;
312 enum wl12xx_fw_type fw_type;
313 bool plt;
314 u8 last_vif_count;
315 struct mutex mutex;
316
317 unsigned long flags;
318
319 struct wl1271_partition_set part;
320
321 struct wl1271_chip chip;
322
323 int cmd_box_addr;
324 int event_box_addr;
325
326 u8 *fw;
327 size_t fw_len;
328 void *nvs;
329 size_t nvs_len;
330
331 s8 hw_pg_ver;
332
333 /* address read from the fuse ROM */
334 u32 fuse_oui_addr;
335 u32 fuse_nic_addr;
336
337 /* we have up to 2 MAC addresses */
338 struct mac_address addresses[2];
339 int channel;
340 u8 system_hlid;
341
342 unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
343 unsigned long roles_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
344 unsigned long roc_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
345 unsigned long rate_policies_map[
346 BITS_TO_LONGS(WL12XX_MAX_RATE_POLICIES)];
347
348 struct list_head wlvif_list;
349
350 u8 sta_count;
351 u8 ap_count;
352
353 struct wl1271_acx_mem_map *target_mem_map;
354
355 /* Accounting for allocated / available TX blocks on HW */
356 u32 tx_blocks_freed;
357 u32 tx_blocks_available;
358 u32 tx_allocated_blocks;
359 u32 tx_results_count;
360
361 /* amount of spare TX blocks to use */
362 u32 tx_spare_blocks;
363
364 /* Accounting for allocated / available Tx packets in HW */
365 u32 tx_pkts_freed[NUM_TX_QUEUES];
366 u32 tx_allocated_pkts[NUM_TX_QUEUES];
367
368 /* Transmitted TX packets counter for chipset interface */
369 u32 tx_packets_count;
370
371 /* Time-offset between host and chipset clocks */
372 s64 time_offset;
373
374 /* Frames scheduled for transmission, not handled yet */
375 int tx_queue_count[NUM_TX_QUEUES];
376 long stopped_queues_map;
377
378 /* Frames received, not handled yet by mac80211 */
379 struct sk_buff_head deferred_rx_queue;
380
381 /* Frames sent, not returned yet to mac80211 */
382 struct sk_buff_head deferred_tx_queue;
383
384 struct work_struct tx_work;
385 struct workqueue_struct *freezable_wq;
386
387 /* Pending TX frames */
388 unsigned long tx_frames_map[BITS_TO_LONGS(ACX_TX_DESCRIPTORS)];
389 struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
390 int tx_frames_cnt;
391
392 /* FW Rx counter */
393 u32 rx_counter;
394
395 /* Rx memory pool address */
396 struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
397
398 /* Intermediate buffer, used for packet aggregation */
399 u8 *aggr_buf;
400
401 /* Reusable dummy packet template */
402 struct sk_buff *dummy_packet;
403
404 /* Network stack work */
405 struct work_struct netstack_work;
406
407 /* FW log buffer */
408 u8 *fwlog;
409
410 /* Number of valid bytes in the FW log buffer */
411 ssize_t fwlog_size;
412
413 /* Sysfs FW log entry readers wait queue */
414 wait_queue_head_t fwlog_waitq;
415
416 /* Hardware recovery work */
417 struct work_struct recovery_work;
418
419 /* The mbox event mask */
420 u32 event_mask;
421
422 /* Mailbox pointers */
423 u32 mbox_ptr[2];
424
425 /* Are we currently scanning */
426 struct ieee80211_vif *scan_vif;
427 struct wl1271_scan scan;
428 struct delayed_work scan_complete_work;
429
430 bool sched_scanning;
431
432 /* The current band */
433 enum ieee80211_band band;
434
435 struct completion *elp_compl;
436 struct delayed_work elp_work;
437
438 /* in dBm */
439 int power_level;
440
441 struct wl1271_stats stats;
442
443 __le32 buffer_32;
444 u32 buffer_cmd;
445 u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
446
447 struct wl12xx_fw_status *fw_status;
448 struct wl1271_tx_hw_res_if *tx_res_if;
449
450 /* Current chipset configuration */
451 struct conf_drv_settings conf;
452
453 bool sg_enabled;
454
455 bool enable_11a;
456
457 /* Most recently reported noise in dBm */
458 s8 noise;
459
460 /* bands supported by this instance of wl12xx */
461 struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
462
463 int tcxo_clock;
464
465 /*
466 * wowlan trigger was configured during suspend.
467 * (currently, only "ANY" trigger is supported)
468 */
469 bool wow_enabled;
470 bool irq_wake_enabled;
471
472 /*
473 * AP-mode - links indexed by HLID. The global and broadcast links
474 * are always active.
475 */
476 struct wl1271_link links[WL12XX_MAX_LINKS];
477
478 /* AP-mode - a bitmap of links currently in PS mode according to FW */
479 u32 ap_fw_ps_map;
480
481 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
482 unsigned long ap_ps_map;
483
484 /* Quirks of specific hardware revisions */
485 unsigned int quirks;
486
487 /* Platform limitations */
488 unsigned int platform_quirks;
489
490 /* number of currently active RX BA sessions */
491 int ba_rx_session_count;
492
493 /* AP-mode - number of currently connected stations */
494 int active_sta_count;
495
496 /* last wlvif we transmitted from */
497 struct wl12xx_vif *last_wlvif;
498
499 /* work to fire when Tx is stuck */
500 struct delayed_work tx_watchdog_work;
501 };
502
503 struct wl1271_station {
504 u8 hlid;
505 };
506
507 struct wl12xx_vif {
508 struct wl1271 *wl;
509 struct list_head list;
510 unsigned long flags;
511 u8 bss_type;
512 u8 p2p; /* we are using p2p role */
513 u8 role_id;
514
515 /* sta/ibss specific */
516 u8 dev_role_id;
517 u8 dev_hlid;
518
519 union {
520 struct {
521 u8 hlid;
522 u8 ba_rx_bitmap;
523
524 u8 basic_rate_idx;
525 u8 ap_rate_idx;
526 u8 p2p_rate_idx;
527
528 bool qos;
529 } sta;
530 struct {
531 u8 global_hlid;
532 u8 bcast_hlid;
533
534 /* HLIDs bitmap of associated stations */
535 unsigned long sta_hlid_map[BITS_TO_LONGS(
536 WL12XX_MAX_LINKS)];
537
538 /* recoreded keys - set here before AP startup */
539 struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
540
541 u8 mgmt_rate_idx;
542 u8 bcast_rate_idx;
543 u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
544 } ap;
545 };
546
547 /* the hlid of the last transmitted skb */
548 int last_tx_hlid;
549
550 unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
551
552 u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
553 u8 ssid_len;
554
555 /* The current band */
556 enum ieee80211_band band;
557 int channel;
558
559 u32 bitrate_masks[IEEE80211_NUM_BANDS];
560 u32 basic_rate_set;
561
562 /*
563 * currently configured rate set:
564 * bits 0-15 - 802.11abg rates
565 * bits 16-23 - 802.11n MCS index mask
566 * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
567 */
568 u32 basic_rate;
569 u32 rate_set;
570
571 /* probe-req template for the current AP */
572 struct sk_buff *probereq;
573
574 /* Beaconing interval (needed for ad-hoc) */
575 u32 beacon_int;
576
577 /* Default key (for WEP) */
578 u32 default_key;
579
580 /* Our association ID */
581 u16 aid;
582
583 /* Session counter for the chipset */
584 int session_counter;
585
586 /* retry counter for PSM entries */
587 u8 psm_entry_retry;
588
589 /* in dBm */
590 int power_level;
591
592 int rssi_thold;
593 int last_rssi_event;
594
595 /* save the current encryption type for auto-arp config */
596 u8 encryption_type;
597 __be32 ip_addr;
598
599 /* RX BA constraint value */
600 bool ba_support;
601 bool ba_allowed;
602
603 /* Rx Streaming */
604 struct work_struct rx_streaming_enable_work;
605 struct work_struct rx_streaming_disable_work;
606 struct timer_list rx_streaming_timer;
607
608 /*
609 * This struct must be last!
610 * data that has to be saved acrossed reconfigs (e.g. recovery)
611 * should be declared in this struct.
612 */
613 struct {
614 u8 persistent[0];
615 /*
616 * Security sequence number
617 * bits 0-15: lower 16 bits part of sequence number
618 * bits 16-47: higher 32 bits part of sequence number
619 * bits 48-63: not in use
620 */
621 u64 tx_security_seq;
622
623 /* 8 bits of the last sequence number in use */
624 u8 tx_security_last_seq_lsb;
625 };
626 };
627
wl12xx_vif_to_data(struct ieee80211_vif * vif)628 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
629 {
630 return (struct wl12xx_vif *)vif->drv_priv;
631 }
632
633 static inline
wl12xx_wlvif_to_vif(struct wl12xx_vif * wlvif)634 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
635 {
636 return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
637 }
638
639 #define wl12xx_for_each_wlvif(wl, wlvif) \
640 list_for_each_entry(wlvif, &wl->wlvif_list, list)
641
642 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
643 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
644
645 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \
646 wl12xx_for_each_wlvif(wl, wlvif) \
647 if (wlvif->bss_type == _bss_type)
648
649 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \
650 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
651
652 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \
653 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
654
655 int wl1271_plt_start(struct wl1271 *wl);
656 int wl1271_plt_stop(struct wl1271 *wl);
657 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
658 void wl12xx_queue_recovery_work(struct wl1271 *wl);
659 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
660
661 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
662
663 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
664 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
665
666 #define WL1271_DEFAULT_POWER_LEVEL 0
667
668 #define WL1271_TX_QUEUE_LOW_WATERMARK 32
669 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
670
671 #define WL1271_DEFERRED_QUEUE_LIMIT 64
672
673 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
674 on in case is has been shut down shortly before */
675 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
676 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
677
678 /* Macros to handle wl1271.sta_rate_set */
679 #define HW_BG_RATES_MASK 0xffff
680 #define HW_HT_RATES_OFFSET 16
681
682 /* Quirks */
683
684 /* Each RX/TX transaction requires an end-of-transaction transfer */
685 #define WL12XX_QUIRK_END_OF_TRANSACTION BIT(0)
686
687 /* wl127x and SPI don't support SDIO block size alignment */
688 #define WL12XX_QUIRK_NO_BLOCKSIZE_ALIGNMENT BIT(2)
689
690 /* Older firmwares did not implement the FW logger over bus feature */
691 #define WL12XX_QUIRK_FWLOG_NOT_IMPLEMENTED BIT(4)
692
693 #define WL12XX_HW_BLOCK_SIZE 256
694
695 #endif
696