2 * Atheros CARL9170 driver
4 * Driver specific definitions
6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; see the file COPYING. If not, see
21 * http://www.gnu.org/licenses/.
23 * This file incorporates work covered by the following copyright and
25 * Copyright (c) 2007-2008 Atheros Communications, Inc.
27 * Permission to use, copy, modify, and/or distribute this software for any
28 * purpose with or without fee is hereby granted, provided that the above
29 * copyright notice and this permission notice appear in all copies.
31 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
32 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
33 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
34 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
35 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
36 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
37 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
42 #include <linux/kernel.h>
43 #include <linux/firmware.h>
44 #include <linux/completion.h>
45 #include <linux/spinlock.h>
46 #include <linux/hw_random.h>
47 #include <net/cfg80211.h>
48 #include <net/mac80211.h>
49 #include <linux/usb.h>
50 #ifdef CONFIG_CARL9170_LEDS
51 #include <linux/leds.h>
52 #endif /* CONFIG_CARL9170_LEDS */
53 #ifdef CONFIG_CARL9170_WPC
54 #include <linux/input.h>
55 #endif /* CONFIG_CARL9170_WPC */
63 #ifdef CONFIG_CARL9170_DEBUGFS
65 #endif /* CONFIG_CARL9170_DEBUGFS */
67 #define CARL9170FW_NAME "carl9170-1.fw"
69 #define PAYLOAD_MAX (CARL9170_MAX_CMD_LEN / 4 - 1)
71 static const u8 ar9170_qmap[__AR9170_NUM_TXQ] = { 3, 2, 1, 0 };
73 enum carl9170_rf_init_mode {
79 #define CARL9170_MAX_RX_BUFFER_SIZE 8192
81 enum carl9170_device_state {
82 CARL9170_UNKNOWN_STATE,
88 #define CARL9170_NUM_TID 16
89 #define WME_BA_BMP_SIZE 64
90 #define CARL9170_TX_USER_RATE_TRIES 3
97 #define TID_TO_WME_AC(_tid) \
98 ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
99 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
100 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
103 #define SEQ_DIFF(_start, _seq) \
104 (((_start) - (_seq)) & 0x0fff)
105 #define SEQ_PREV(_seq) \
106 (((_seq) - 1) & 0x0fff)
107 #define SEQ_NEXT(_seq) \
108 (((_seq) + 1) & 0x0fff)
109 #define BAW_WITHIN(_start, _bawsz, _seqno) \
110 ((((_seqno) - (_start)) & 0xfff) < (_bawsz))
112 enum carl9170_tid_state {
113 CARL9170_TID_STATE_INVALID,
114 CARL9170_TID_STATE_KILLED,
115 CARL9170_TID_STATE_SHUTDOWN,
116 CARL9170_TID_STATE_SUSPEND,
117 CARL9170_TID_STATE_PROGRESS,
118 CARL9170_TID_STATE_IDLE,
119 CARL9170_TID_STATE_XMIT,
122 #define CARL9170_BAW_BITS (2 * WME_BA_BMP_SIZE)
123 #define CARL9170_BAW_SIZE (BITS_TO_LONGS(CARL9170_BAW_BITS))
124 #define CARL9170_BAW_LEN (DIV_ROUND_UP(CARL9170_BAW_BITS, BITS_PER_BYTE))
126 struct carl9170_sta_tid {
127 /* must be the first entry! */
128 struct list_head list;
130 /* temporary list for RCU unlink procedure */
131 struct list_head tmp_list;
133 /* lock for the following data structures */
136 unsigned int counter;
137 enum carl9170_tid_state state;
138 u8 tid; /* TID number ( 0 - 15 ) */
139 u16 max; /* max. AMPDU size */
141 u16 snx; /* awaiting _next_ frame */
142 u16 hsn; /* highest _queued_ sequence */
143 u16 bsn; /* base of the tx/agg bitmap */
144 unsigned long bitmap[CARL9170_BAW_SIZE];
146 /* Preaggregation reorder queue */
147 struct sk_buff_head queue;
150 #define CARL9170_QUEUE_TIMEOUT 256
151 #define CARL9170_BUMP_QUEUE 1000
152 #define CARL9170_TX_TIMEOUT 2500
153 #define CARL9170_JANITOR_DELAY 128
154 #define CARL9170_QUEUE_STUCK_TIMEOUT 5500
155 #define CARL9170_STAT_WORK 30000
157 #define CARL9170_NUM_TX_AGG_MAX 30
160 * Tradeoff between stability/latency and speed.
162 * AR9170_TXQ_DEPTH is devised by dividing the amount of available
163 * tx buffers with the size of a full ethernet frame + overhead.
165 * Naturally: The higher the limit, the faster the device CAN send.
166 * However, even a slight over-commitment at the wrong time and the
167 * hardware is doomed to send all already-queued frames at suboptimal
168 * rates. This in turn leads to an enormous amount of unsuccessful
169 * retries => Latency goes up, whereas the throughput goes down. CRASH!
171 #define CARL9170_NUM_TX_LIMIT_HARD ((AR9170_TXQ_DEPTH * 3) / 2)
172 #define CARL9170_NUM_TX_LIMIT_SOFT (AR9170_TXQ_DEPTH)
174 struct carl9170_tx_queue_stats {
180 struct carl9170_vif {
182 struct ieee80211_vif __rcu *vif;
185 struct carl9170_vif_info {
186 struct list_head list;
189 struct sk_buff *beacon;
193 #define AR9170_NUM_RX_URBS 16
194 #define AR9170_NUM_RX_URBS_MUL 2
195 #define AR9170_NUM_TX_URBS 8
196 #define AR9170_NUM_RX_URBS_POOL (AR9170_NUM_RX_URBS_MUL * AR9170_NUM_RX_URBS)
198 enum carl9170_device_features {
199 CARL9170_WPS_BUTTON = BIT(0),
200 CARL9170_ONE_LED = BIT(1),
203 #ifdef CONFIG_CARL9170_LEDS
206 struct carl9170_led {
208 struct led_classdev l;
210 unsigned int toggled;
214 #endif /* CONFIG_CARL9170_LEDS */
216 enum carl9170_restart_reasons {
217 CARL9170_RR_NO_REASON = 0,
218 CARL9170_RR_FATAL_FIRMWARE_ERROR,
219 CARL9170_RR_TOO_MANY_FIRMWARE_ERRORS,
220 CARL9170_RR_WATCHDOG,
221 CARL9170_RR_STUCK_TX,
222 CARL9170_RR_UNRESPONSIVE_DEVICE,
223 CARL9170_RR_COMMAND_TIMEOUT,
224 CARL9170_RR_TOO_MANY_PHY_ERRORS,
225 CARL9170_RR_LOST_RSP,
226 CARL9170_RR_INVALID_RSP,
227 CARL9170_RR_USER_REQUEST,
232 enum carl9170_erp_modes {
233 CARL9170_ERP_INVALID,
235 CARL9170_ERP_MAC80211,
243 struct ath_common common;
244 struct ieee80211_hw *hw;
246 enum carl9170_device_state state;
247 spinlock_t state_lock;
248 enum carl9170_restart_reasons last_reason;
252 struct usb_device *udev;
253 struct usb_interface *intf;
254 struct usb_anchor rx_anch;
255 struct usb_anchor rx_work;
256 struct usb_anchor rx_pool;
257 struct usb_anchor tx_wait;
258 struct usb_anchor tx_anch;
259 struct usb_anchor tx_cmd;
260 struct usb_anchor tx_err;
261 struct tasklet_struct usb_tasklet;
262 atomic_t tx_cmd_urbs;
263 atomic_t tx_anch_urbs;
264 atomic_t rx_anch_urbs;
265 atomic_t rx_work_urbs;
266 atomic_t rx_pool_urbs;
267 kernel_ulong_t features;
269 /* firmware settings */
270 struct completion fw_load_wait;
271 struct completion fw_boot_wait;
273 const struct carl9170fw_desc_head *desc;
274 const struct firmware *fw;
276 unsigned int address;
277 unsigned int cmd_bufs;
278 unsigned int api_version;
279 unsigned int vif_num;
280 unsigned int err_counter;
281 unsigned int bug_counter;
283 unsigned int beacon_max_len;
288 unsigned int mem_blocks;
289 unsigned int mem_block_size;
290 unsigned int rx_size;
291 unsigned int tx_seq_table;
295 /* interface configuration combinations */
296 struct ieee80211_iface_limit if_comb_limits[1];
297 struct ieee80211_iface_combination if_combs[1];
299 /* reset / stuck frames/queue detection */
300 struct work_struct restart_work;
301 struct work_struct ping_work;
302 unsigned int restart_counter;
303 unsigned long queue_stop_timeout[__AR9170_NUM_TXQ];
304 unsigned long max_queue_stop_timeout[__AR9170_NUM_TXQ];
305 bool needs_full_reset;
306 atomic_t pending_restarts;
308 /* interface mode settings */
309 struct list_head vif_list;
310 unsigned long vif_bitmap;
312 struct carl9170_vif vif_priv[AR9170_MAX_VIRTUAL_MAC];
315 spinlock_t beacon_lock;
316 unsigned int global_pretbtt;
317 unsigned int global_beacon_int;
318 struct carl9170_vif_info __rcu *beacon_iter;
319 unsigned int beacon_enabled;
321 /* cryptographic engine */
323 bool rx_software_decryption;
324 bool disable_offload;
326 /* filter settings */
329 unsigned int filter_state;
330 unsigned int rx_filter_caps;
331 bool sniffer_enabled;
334 enum carl9170_erp_modes erp_mode;
337 struct ieee80211_channel *channel;
338 unsigned int num_channels;
340 unsigned int chan_fail;
341 unsigned int total_chan_fail;
345 u64 active; /* usec */
347 u64 tx_time; /* usec */
351 struct delayed_work stat_work;
352 struct survey_info *survey;
354 /* power calibration data */
363 #ifdef CONFIG_CARL9170_LEDS
365 struct delayed_work led_work;
366 struct carl9170_led leds[AR9170_NUM_LEDS];
367 #endif /* CONFIG_CARL9170_LEDS */
369 /* qos queue settings */
370 spinlock_t tx_stats_lock;
371 struct carl9170_tx_queue_stats tx_stats[__AR9170_NUM_TXQ];
372 struct ieee80211_tx_queue_params edcf[5];
373 struct completion tx_flush;
380 struct completion cmd_wait;
382 __le32 cmd_buf[PAYLOAD_MAX + 1];
383 struct carl9170_cmd cmd;
384 struct carl9170_rsp rsp;
388 unsigned int tx_dropped;
389 unsigned int tx_ack_failures;
390 unsigned int tx_fcs_errors;
391 unsigned int rx_dropped;
394 struct ar9170_eeprom eeprom;
397 struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];
398 struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
399 struct delayed_work tx_janitor;
400 unsigned long tx_janitor_last_run;
404 struct work_struct ampdu_work;
405 spinlock_t tx_ampdu_list_lock;
406 struct carl9170_sta_tid __rcu *tx_ampdu_iter;
407 struct list_head tx_ampdu_list;
408 atomic_t tx_ampdu_upload;
409 atomic_t tx_ampdu_scheduler;
410 atomic_t tx_total_pending;
411 atomic_t tx_total_queued;
412 unsigned int tx_ampdu_list_len;
415 bool tx_ampdu_schedule;
417 /* internal memory management */
419 unsigned long *mem_bitmap;
420 atomic_t mem_free_blocks;
423 /* rxstream mpdu merge */
424 struct ar9170_rx_head rx_plcp;
426 struct sk_buff *rx_failover;
427 int rx_failover_missing;
429 /* FIFO for collecting outstanding BlockAckRequest */
430 struct list_head bar_list[__AR9170_NUM_TXQ];
431 spinlock_t bar_list_lock[__AR9170_NUM_TXQ];
433 #ifdef CONFIG_CARL9170_WPC
436 struct input_dev *pbc;
440 #endif /* CONFIG_CARL9170_WPC */
442 #ifdef CONFIG_CARL9170_DEBUGFS
443 struct carl9170_debug debug;
444 struct dentry *debug_dir;
445 #endif /* CONFIG_CARL9170_DEBUGFS */
448 struct work_struct ps_work;
450 unsigned int dtim_counter;
451 unsigned long last_beacon;
452 unsigned long last_action;
453 unsigned long last_slept;
454 unsigned int sleep_ms;
455 unsigned int off_override;
459 #ifdef CONFIG_CARL9170_HWRNG
460 # define CARL9170_HWRNG_CACHE_SIZE CARL9170_MAX_CMD_PAYLOAD_LEN
465 u16 cache[CARL9170_HWRNG_CACHE_SIZE / sizeof(u16)];
466 unsigned int cache_idx;
468 #endif /* CONFIG_CARL9170_HWRNG */
471 enum carl9170_ps_off_override_reasons {
476 struct carl9170_bar_list_entry {
477 struct list_head list;
478 struct rcu_head head;
482 struct carl9170_ba_stats {
489 struct carl9170_sta_info {
492 atomic_t pending_frames;
493 unsigned int ampdu_max_len;
494 struct carl9170_sta_tid __rcu *agg[CARL9170_NUM_TID];
495 struct carl9170_ba_stats stats[CARL9170_NUM_TID];
498 struct carl9170_tx_info {
499 unsigned long timeout;
504 #define CHK_DEV_STATE(a, s) (((struct ar9170 *)a)->state >= (s))
505 #define IS_INITIALIZED(a) (CHK_DEV_STATE(a, CARL9170_STOPPED))
506 #define IS_ACCEPTING_CMD(a) (CHK_DEV_STATE(a, CARL9170_IDLE))
507 #define IS_STARTED(a) (CHK_DEV_STATE(a, CARL9170_STARTED))
509 static inline void __carl9170_set_state(struct ar9170 *ar,
510 enum carl9170_device_state newstate)
512 ar->state = newstate;
515 static inline void carl9170_set_state(struct ar9170 *ar,
516 enum carl9170_device_state newstate)
520 spin_lock_irqsave(&ar->state_lock, flags);
521 __carl9170_set_state(ar, newstate);
522 spin_unlock_irqrestore(&ar->state_lock, flags);
525 static inline void carl9170_set_state_when(struct ar9170 *ar,
526 enum carl9170_device_state min, enum carl9170_device_state newstate)
530 spin_lock_irqsave(&ar->state_lock, flags);
531 if (CHK_DEV_STATE(ar, min))
532 __carl9170_set_state(ar, newstate);
533 spin_unlock_irqrestore(&ar->state_lock, flags);
536 /* exported interface */
537 void *carl9170_alloc(size_t priv_size);
538 int carl9170_register(struct ar9170 *ar);
539 void carl9170_unregister(struct ar9170 *ar);
540 void carl9170_free(struct ar9170 *ar);
541 void carl9170_restart(struct ar9170 *ar, const enum carl9170_restart_reasons r);
542 void carl9170_ps_check(struct ar9170 *ar);
545 int carl9170_usb_open(struct ar9170 *ar);
546 void carl9170_usb_stop(struct ar9170 *ar);
547 void carl9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb);
548 void carl9170_usb_handle_tx_err(struct ar9170 *ar);
549 int carl9170_exec_cmd(struct ar9170 *ar, const enum carl9170_cmd_oids,
550 u32 plen, void *payload, u32 rlen, void *resp);
551 int __carl9170_exec_cmd(struct ar9170 *ar, struct carl9170_cmd *cmd,
552 const bool free_buf);
553 int carl9170_usb_restart(struct ar9170 *ar);
554 void carl9170_usb_reset(struct ar9170 *ar);
557 int carl9170_init_mac(struct ar9170 *ar);
558 int carl9170_set_qos(struct ar9170 *ar);
559 int carl9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);
560 int carl9170_mod_virtual_mac(struct ar9170 *ar, const unsigned int id,
562 int carl9170_set_operating_mode(struct ar9170 *ar);
563 int carl9170_set_beacon_timers(struct ar9170 *ar);
564 int carl9170_set_dyn_sifs_ack(struct ar9170 *ar);
565 int carl9170_set_rts_cts_rate(struct ar9170 *ar);
566 int carl9170_set_ampdu_settings(struct ar9170 *ar);
567 int carl9170_set_slot_time(struct ar9170 *ar);
568 int carl9170_set_mac_rates(struct ar9170 *ar);
569 int carl9170_set_hwretry_limit(struct ar9170 *ar, const u32 max_retry);
570 int carl9170_upload_key(struct ar9170 *ar, const u8 id, const u8 *mac,
571 const u8 ktype, const u8 keyidx, const u8 *keydata, const int keylen);
572 int carl9170_disable_key(struct ar9170 *ar, const u8 id);
573 int carl9170_set_mac_tpc(struct ar9170 *ar, struct ieee80211_channel *channel);
576 void carl9170_rx(struct ar9170 *ar, void *buf, unsigned int len);
577 void carl9170_handle_command_response(struct ar9170 *ar, void *buf, u32 len);
580 void carl9170_op_tx(struct ieee80211_hw *hw,
581 struct ieee80211_tx_control *control,
582 struct sk_buff *skb);
583 void carl9170_tx_janitor(struct work_struct *work);
584 void carl9170_tx_process_status(struct ar9170 *ar,
585 const struct carl9170_rsp *cmd);
586 void carl9170_tx_status(struct ar9170 *ar, struct sk_buff *skb,
588 void carl9170_tx_callback(struct ar9170 *ar, struct sk_buff *skb);
589 void carl9170_tx_drop(struct ar9170 *ar, struct sk_buff *skb);
590 void carl9170_tx_scheduler(struct ar9170 *ar);
591 void carl9170_tx_get_skb(struct sk_buff *skb);
592 int carl9170_tx_put_skb(struct sk_buff *skb);
593 int carl9170_update_beacon(struct ar9170 *ar, const bool submit);
596 #ifdef CONFIG_CARL9170_LEDS
597 int carl9170_led_register(struct ar9170 *ar);
598 void carl9170_led_unregister(struct ar9170 *ar);
599 #endif /* CONFIG_CARL9170_LEDS */
600 int carl9170_led_init(struct ar9170 *ar);
601 int carl9170_led_set_state(struct ar9170 *ar, const u32 led_state);
604 int carl9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,
605 enum nl80211_channel_type bw, enum carl9170_rf_init_mode rfi);
606 int carl9170_get_noisefloor(struct ar9170 *ar);
609 int carl9170_parse_firmware(struct ar9170 *ar);
611 extern struct ieee80211_rate __carl9170_ratetable[];
612 extern int modparam_noht;
614 static inline struct ar9170 *carl9170_get_priv(struct carl9170_vif *carl_vif)
616 return container_of(carl_vif, struct ar9170,
617 vif_priv[carl_vif->id]);
620 static inline struct ieee80211_hdr *carl9170_get_hdr(struct sk_buff *skb)
622 return (void *)((struct _carl9170_tx_superframe *)
623 skb->data)->frame_data;
626 static inline u16 get_seq_h(struct ieee80211_hdr *hdr)
628 return le16_to_cpu(hdr->seq_ctrl) >> 4;
631 static inline u16 carl9170_get_seq(struct sk_buff *skb)
633 return get_seq_h(carl9170_get_hdr(skb));
636 static inline u16 get_tid_h(struct ieee80211_hdr *hdr)
638 return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
641 static inline u16 carl9170_get_tid(struct sk_buff *skb)
643 return get_tid_h(carl9170_get_hdr(skb));
646 static inline struct ieee80211_vif *
647 carl9170_get_vif(struct carl9170_vif_info *priv)
649 return container_of((void *)priv, struct ieee80211_vif, drv_priv);
652 /* Protected by ar->mutex or RCU */
653 static inline struct ieee80211_vif *carl9170_get_main_vif(struct ar9170 *ar)
655 struct carl9170_vif_info *cvif;
657 list_for_each_entry_rcu(cvif, &ar->vif_list, list) {
659 return carl9170_get_vif(cvif);
665 static inline bool is_main_vif(struct ar9170 *ar, struct ieee80211_vif *vif)
670 ret = (carl9170_get_main_vif(ar) == vif);
675 #endif /* __CARL9170_H */