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 #define CARL9170_MAX_RX_BUFFER_SIZE 8192
75 enum carl9170_device_state
{
76 CARL9170_UNKNOWN_STATE
,
82 #define WME_BA_BMP_SIZE 64
83 #define CARL9170_TX_USER_RATE_TRIES 3
85 #define TID_TO_WME_AC(_tid) \
86 ((((_tid) == 0) || ((_tid) == 3)) ? IEEE80211_AC_BE : \
87 (((_tid) == 1) || ((_tid) == 2)) ? IEEE80211_AC_BK : \
88 (((_tid) == 4) || ((_tid) == 5)) ? IEEE80211_AC_VI : \
91 #define SEQ_DIFF(_start, _seq) \
92 (((_start) - (_seq)) & 0x0fff)
93 #define SEQ_PREV(_seq) \
94 (((_seq) - 1) & 0x0fff)
95 #define SEQ_NEXT(_seq) \
96 (((_seq) + 1) & 0x0fff)
97 #define BAW_WITHIN(_start, _bawsz, _seqno) \
98 ((((_seqno) - (_start)) & 0xfff) < (_bawsz))
100 enum carl9170_tid_state
{
101 CARL9170_TID_STATE_INVALID
,
102 CARL9170_TID_STATE_KILLED
,
103 CARL9170_TID_STATE_SHUTDOWN
,
104 CARL9170_TID_STATE_SUSPEND
,
105 CARL9170_TID_STATE_PROGRESS
,
106 CARL9170_TID_STATE_IDLE
,
107 CARL9170_TID_STATE_XMIT
,
110 #define CARL9170_BAW_BITS (2 * WME_BA_BMP_SIZE)
111 #define CARL9170_BAW_SIZE (BITS_TO_LONGS(CARL9170_BAW_BITS))
112 #define CARL9170_BAW_LEN (DIV_ROUND_UP(CARL9170_BAW_BITS, BITS_PER_BYTE))
114 struct carl9170_sta_tid
{
115 /* must be the first entry! */
116 struct list_head list
;
118 /* temporary list for RCU unlink procedure */
119 struct list_head tmp_list
;
121 /* lock for the following data structures */
124 unsigned int counter
;
125 enum carl9170_tid_state state
;
126 u8 tid
; /* TID number ( 0 - 15 ) */
127 u16 max
; /* max. AMPDU size */
129 u16 snx
; /* awaiting _next_ frame */
130 u16 hsn
; /* highest _queued_ sequence */
131 u16 bsn
; /* base of the tx/agg bitmap */
132 unsigned long bitmap
[CARL9170_BAW_SIZE
];
134 /* Preaggregation reorder queue */
135 struct sk_buff_head queue
;
138 #define CARL9170_QUEUE_TIMEOUT 256
139 #define CARL9170_BUMP_QUEUE 1000
140 #define CARL9170_TX_TIMEOUT 2500
141 #define CARL9170_JANITOR_DELAY 128
142 #define CARL9170_QUEUE_STUCK_TIMEOUT 5500
143 #define CARL9170_STAT_WORK 30000
145 #define CARL9170_NUM_TX_AGG_MAX 30
148 * Tradeoff between stability/latency and speed.
150 * AR9170_TXQ_DEPTH is devised by dividing the amount of available
151 * tx buffers with the size of a full ethernet frame + overhead.
153 * Naturally: The higher the limit, the faster the device CAN send.
154 * However, even a slight over-commitment at the wrong time and the
155 * hardware is doomed to send all already-queued frames at suboptimal
156 * rates. This in turn leads to an enormous amount of unsuccessful
157 * retries => Latency goes up, whereas the throughput goes down. CRASH!
159 #define CARL9170_NUM_TX_LIMIT_HARD ((AR9170_TXQ_DEPTH * 3) / 2)
160 #define CARL9170_NUM_TX_LIMIT_SOFT (AR9170_TXQ_DEPTH)
162 struct carl9170_tx_queue_stats
{
168 struct carl9170_vif
{
170 struct ieee80211_vif __rcu
*vif
;
173 struct carl9170_vif_info
{
174 struct list_head list
;
177 struct sk_buff
*beacon
;
181 #define AR9170_NUM_RX_URBS 16
182 #define AR9170_NUM_RX_URBS_MUL 2
183 #define AR9170_NUM_TX_URBS 8
184 #define AR9170_NUM_RX_URBS_POOL (AR9170_NUM_RX_URBS_MUL * AR9170_NUM_RX_URBS)
186 enum carl9170_device_features
{
187 CARL9170_WPS_BUTTON
= BIT(0),
188 CARL9170_ONE_LED
= BIT(1),
191 #ifdef CONFIG_CARL9170_LEDS
194 struct carl9170_led
{
196 struct led_classdev l
;
198 unsigned int toggled
;
202 #endif /* CONFIG_CARL9170_LEDS */
204 enum carl9170_restart_reasons
{
205 CARL9170_RR_NO_REASON
= 0,
206 CARL9170_RR_FATAL_FIRMWARE_ERROR
,
207 CARL9170_RR_TOO_MANY_FIRMWARE_ERRORS
,
208 CARL9170_RR_WATCHDOG
,
209 CARL9170_RR_STUCK_TX
,
210 CARL9170_RR_UNRESPONSIVE_DEVICE
,
211 CARL9170_RR_COMMAND_TIMEOUT
,
212 CARL9170_RR_TOO_MANY_PHY_ERRORS
,
213 CARL9170_RR_LOST_RSP
,
214 CARL9170_RR_INVALID_RSP
,
215 CARL9170_RR_USER_REQUEST
,
220 enum carl9170_erp_modes
{
221 CARL9170_ERP_INVALID
,
223 CARL9170_ERP_MAC80211
,
231 struct ath_common common
;
232 struct ieee80211_hw
*hw
;
234 enum carl9170_device_state state
;
235 spinlock_t state_lock
;
236 enum carl9170_restart_reasons last_reason
;
240 struct usb_device
*udev
;
241 struct usb_interface
*intf
;
242 struct usb_anchor rx_anch
;
243 struct usb_anchor rx_work
;
244 struct usb_anchor rx_pool
;
245 struct usb_anchor tx_wait
;
246 struct usb_anchor tx_anch
;
247 struct usb_anchor tx_cmd
;
248 struct usb_anchor tx_err
;
249 struct tasklet_struct usb_tasklet
;
250 atomic_t tx_cmd_urbs
;
251 atomic_t tx_anch_urbs
;
252 atomic_t rx_anch_urbs
;
253 atomic_t rx_work_urbs
;
254 atomic_t rx_pool_urbs
;
255 kernel_ulong_t features
;
256 bool usb_ep_cmd_is_bulk
;
258 /* firmware settings */
259 struct completion fw_load_wait
;
260 struct completion fw_boot_wait
;
262 const struct carl9170fw_desc_head
*desc
;
263 const struct firmware
*fw
;
265 unsigned int address
;
266 unsigned int cmd_bufs
;
267 unsigned int api_version
;
268 unsigned int vif_num
;
269 unsigned int err_counter
;
270 unsigned int bug_counter
;
272 unsigned int beacon_max_len
;
277 unsigned int mem_blocks
;
278 unsigned int mem_block_size
;
279 unsigned int rx_size
;
280 unsigned int tx_seq_table
;
282 bool disable_offload_fw
;
285 /* interface configuration combinations */
286 struct ieee80211_iface_limit if_comb_limits
[1];
287 struct ieee80211_iface_combination if_combs
[1];
289 /* reset / stuck frames/queue detection */
290 struct work_struct restart_work
;
291 struct work_struct ping_work
;
292 unsigned int restart_counter
;
293 unsigned long queue_stop_timeout
[__AR9170_NUM_TXQ
];
294 unsigned long max_queue_stop_timeout
[__AR9170_NUM_TXQ
];
295 bool needs_full_reset
;
296 bool force_usb_reset
;
297 atomic_t pending_restarts
;
299 /* interface mode settings */
300 struct list_head vif_list
;
301 unsigned long vif_bitmap
;
303 struct carl9170_vif vif_priv
[AR9170_MAX_VIRTUAL_MAC
];
306 spinlock_t beacon_lock
;
307 unsigned int global_pretbtt
;
308 unsigned int global_beacon_int
;
309 struct carl9170_vif_info __rcu
*beacon_iter
;
310 unsigned int beacon_enabled
;
312 /* cryptographic engine */
314 bool rx_software_decryption
;
315 bool disable_offload
;
317 /* filter settings */
320 unsigned int filter_state
;
321 unsigned int rx_filter_caps
;
322 bool sniffer_enabled
;
325 enum carl9170_erp_modes erp_mode
;
328 struct ieee80211_channel
*channel
;
329 unsigned int num_channels
;
331 unsigned int chan_fail
;
332 unsigned int total_chan_fail
;
336 u64 active
; /* usec */
338 u64 tx_time
; /* usec */
342 struct delayed_work stat_work
;
343 struct survey_info
*survey
;
345 /* power calibration data */
354 #ifdef CONFIG_CARL9170_LEDS
356 struct delayed_work led_work
;
357 struct carl9170_led leds
[AR9170_NUM_LEDS
];
358 #endif /* CONFIG_CARL9170_LEDS */
360 /* qos queue settings */
361 spinlock_t tx_stats_lock
;
362 struct carl9170_tx_queue_stats tx_stats
[__AR9170_NUM_TXQ
];
363 struct ieee80211_tx_queue_params edcf
[5];
364 struct completion tx_flush
;
371 struct completion cmd_wait
;
373 __le32 cmd_buf
[PAYLOAD_MAX
+ 1];
374 struct carl9170_cmd cmd
;
375 struct carl9170_rsp rsp
;
379 unsigned int tx_dropped
;
380 unsigned int tx_ack_failures
;
381 unsigned int tx_fcs_errors
;
382 unsigned int rx_dropped
;
385 struct ar9170_eeprom eeprom
;
388 struct sk_buff_head tx_pending
[__AR9170_NUM_TXQ
];
389 struct sk_buff_head tx_status
[__AR9170_NUM_TXQ
];
390 struct delayed_work tx_janitor
;
391 unsigned long tx_janitor_last_run
;
395 struct work_struct ampdu_work
;
396 spinlock_t tx_ampdu_list_lock
;
397 struct carl9170_sta_tid __rcu
*tx_ampdu_iter
;
398 struct list_head tx_ampdu_list
;
399 atomic_t tx_ampdu_upload
;
400 atomic_t tx_ampdu_scheduler
;
401 atomic_t tx_total_pending
;
402 atomic_t tx_total_queued
;
403 unsigned int tx_ampdu_list_len
;
406 bool tx_ampdu_schedule
;
408 /* internal memory management */
410 unsigned long *mem_bitmap
;
411 atomic_t mem_free_blocks
;
414 /* rxstream mpdu merge */
415 struct ar9170_rx_head rx_plcp
;
417 struct sk_buff
*rx_failover
;
418 int rx_failover_missing
;
421 /* FIFO for collecting outstanding BlockAckRequest */
422 struct list_head bar_list
[__AR9170_NUM_TXQ
];
423 spinlock_t bar_list_lock
[__AR9170_NUM_TXQ
];
425 #ifdef CONFIG_CARL9170_WPC
428 struct input_dev
*pbc
;
432 #endif /* CONFIG_CARL9170_WPC */
434 #ifdef CONFIG_CARL9170_DEBUGFS
435 struct carl9170_debug debug
;
436 struct dentry
*debug_dir
;
437 #endif /* CONFIG_CARL9170_DEBUGFS */
440 struct work_struct ps_work
;
442 unsigned int dtim_counter
;
443 unsigned long last_beacon
;
444 unsigned long last_action
;
445 unsigned long last_slept
;
446 unsigned int sleep_ms
;
447 unsigned int off_override
;
451 #ifdef CONFIG_CARL9170_HWRNG
452 # define CARL9170_HWRNG_CACHE_SIZE CARL9170_MAX_CMD_PAYLOAD_LEN
457 u16 cache
[CARL9170_HWRNG_CACHE_SIZE
/ sizeof(u16
)];
458 unsigned int cache_idx
;
460 #endif /* CONFIG_CARL9170_HWRNG */
463 enum carl9170_ps_off_override_reasons
{
468 struct carl9170_bar_list_entry
{
469 struct list_head list
;
470 struct rcu_head head
;
474 struct carl9170_ba_stats
{
481 struct carl9170_sta_info
{
484 atomic_t pending_frames
;
485 unsigned int ampdu_max_len
;
486 struct carl9170_sta_tid __rcu
*agg
[IEEE80211_NUM_TIDS
];
487 struct carl9170_ba_stats stats
[IEEE80211_NUM_TIDS
];
490 struct carl9170_tx_info
{
491 unsigned long timeout
;
496 #define CHK_DEV_STATE(a, s) (((struct ar9170 *)a)->state >= (s))
497 #define IS_INITIALIZED(a) (CHK_DEV_STATE(a, CARL9170_STOPPED))
498 #define IS_ACCEPTING_CMD(a) (CHK_DEV_STATE(a, CARL9170_IDLE))
499 #define IS_STARTED(a) (CHK_DEV_STATE(a, CARL9170_STARTED))
501 static inline void __carl9170_set_state(struct ar9170
*ar
,
502 enum carl9170_device_state newstate
)
504 ar
->state
= newstate
;
507 static inline void carl9170_set_state(struct ar9170
*ar
,
508 enum carl9170_device_state newstate
)
512 spin_lock_irqsave(&ar
->state_lock
, flags
);
513 __carl9170_set_state(ar
, newstate
);
514 spin_unlock_irqrestore(&ar
->state_lock
, flags
);
517 static inline void carl9170_set_state_when(struct ar9170
*ar
,
518 enum carl9170_device_state min
, enum carl9170_device_state newstate
)
522 spin_lock_irqsave(&ar
->state_lock
, flags
);
523 if (CHK_DEV_STATE(ar
, min
))
524 __carl9170_set_state(ar
, newstate
);
525 spin_unlock_irqrestore(&ar
->state_lock
, flags
);
528 /* exported interface */
529 void *carl9170_alloc(size_t priv_size
);
530 int carl9170_register(struct ar9170
*ar
);
531 void carl9170_unregister(struct ar9170
*ar
);
532 void carl9170_free(struct ar9170
*ar
);
533 void carl9170_restart(struct ar9170
*ar
, const enum carl9170_restart_reasons r
);
534 void carl9170_ps_check(struct ar9170
*ar
);
537 int carl9170_usb_open(struct ar9170
*ar
);
538 void carl9170_usb_stop(struct ar9170
*ar
);
539 void carl9170_usb_tx(struct ar9170
*ar
, struct sk_buff
*skb
);
540 void carl9170_usb_handle_tx_err(struct ar9170
*ar
);
541 int carl9170_exec_cmd(struct ar9170
*ar
, const enum carl9170_cmd_oids
,
542 u32 plen
, void *payload
, u32 rlen
, void *resp
);
543 int __carl9170_exec_cmd(struct ar9170
*ar
, struct carl9170_cmd
*cmd
,
544 const bool free_buf
);
545 int carl9170_usb_restart(struct ar9170
*ar
);
546 void carl9170_usb_reset(struct ar9170
*ar
);
549 int carl9170_init_mac(struct ar9170
*ar
);
550 int carl9170_set_qos(struct ar9170
*ar
);
551 int carl9170_update_multicast(struct ar9170
*ar
, const u64 mc_hast
);
552 int carl9170_mod_virtual_mac(struct ar9170
*ar
, const unsigned int id
,
554 int carl9170_set_operating_mode(struct ar9170
*ar
);
555 int carl9170_set_beacon_timers(struct ar9170
*ar
);
556 int carl9170_set_dyn_sifs_ack(struct ar9170
*ar
);
557 int carl9170_set_rts_cts_rate(struct ar9170
*ar
);
558 int carl9170_set_ampdu_settings(struct ar9170
*ar
);
559 int carl9170_set_slot_time(struct ar9170
*ar
);
560 int carl9170_set_mac_rates(struct ar9170
*ar
);
561 int carl9170_set_hwretry_limit(struct ar9170
*ar
, const u32 max_retry
);
562 int carl9170_upload_key(struct ar9170
*ar
, const u8 id
, const u8
*mac
,
563 const u8 ktype
, const u8 keyidx
, const u8
*keydata
, const int keylen
);
564 int carl9170_disable_key(struct ar9170
*ar
, const u8 id
);
565 int carl9170_set_mac_tpc(struct ar9170
*ar
, struct ieee80211_channel
*channel
);
568 void carl9170_rx(struct ar9170
*ar
, void *buf
, unsigned int len
);
569 void carl9170_handle_command_response(struct ar9170
*ar
, void *buf
, u32 len
);
572 void carl9170_op_tx(struct ieee80211_hw
*hw
,
573 struct ieee80211_tx_control
*control
,
574 struct sk_buff
*skb
);
575 void carl9170_tx_janitor(struct work_struct
*work
);
576 void carl9170_tx_process_status(struct ar9170
*ar
,
577 const struct carl9170_rsp
*cmd
);
578 void carl9170_tx_status(struct ar9170
*ar
, struct sk_buff
*skb
,
580 void carl9170_tx_callback(struct ar9170
*ar
, struct sk_buff
*skb
);
581 void carl9170_tx_drop(struct ar9170
*ar
, struct sk_buff
*skb
);
582 void carl9170_tx_scheduler(struct ar9170
*ar
);
583 void carl9170_tx_get_skb(struct sk_buff
*skb
);
584 int carl9170_tx_put_skb(struct sk_buff
*skb
);
585 int carl9170_update_beacon(struct ar9170
*ar
, const bool submit
);
588 #ifdef CONFIG_CARL9170_LEDS
589 int carl9170_led_register(struct ar9170
*ar
);
590 void carl9170_led_unregister(struct ar9170
*ar
);
591 #endif /* CONFIG_CARL9170_LEDS */
592 int carl9170_led_init(struct ar9170
*ar
);
593 int carl9170_led_set_state(struct ar9170
*ar
, const u32 led_state
);
596 int carl9170_set_channel(struct ar9170
*ar
, struct ieee80211_channel
*channel
,
597 enum nl80211_channel_type bw
);
598 int carl9170_get_noisefloor(struct ar9170
*ar
);
601 int carl9170_parse_firmware(struct ar9170
*ar
);
603 extern struct ieee80211_rate __carl9170_ratetable
[];
604 extern int modparam_noht
;
606 static inline struct ar9170
*carl9170_get_priv(struct carl9170_vif
*carl_vif
)
608 return container_of(carl_vif
, struct ar9170
,
609 vif_priv
[carl_vif
->id
]);
612 static inline struct ieee80211_hdr
*carl9170_get_hdr(struct sk_buff
*skb
)
614 return (void *)((struct _carl9170_tx_superframe
*)
615 skb
->data
)->frame_data
;
618 static inline u16
get_seq_h(struct ieee80211_hdr
*hdr
)
620 return le16_to_cpu(hdr
->seq_ctrl
) >> 4;
623 static inline u16
carl9170_get_seq(struct sk_buff
*skb
)
625 return get_seq_h(carl9170_get_hdr(skb
));
628 static inline u16
get_tid_h(struct ieee80211_hdr
*hdr
)
630 return (ieee80211_get_qos_ctl(hdr
))[0] & IEEE80211_QOS_CTL_TID_MASK
;
633 static inline u16
carl9170_get_tid(struct sk_buff
*skb
)
635 return get_tid_h(carl9170_get_hdr(skb
));
638 static inline struct ieee80211_vif
*
639 carl9170_get_vif(struct carl9170_vif_info
*priv
)
641 return container_of((void *)priv
, struct ieee80211_vif
, drv_priv
);
644 /* Protected by ar->mutex or RCU */
645 static inline struct ieee80211_vif
*carl9170_get_main_vif(struct ar9170
*ar
)
647 struct carl9170_vif_info
*cvif
;
649 list_for_each_entry_rcu(cvif
, &ar
->vif_list
, list
) {
651 return carl9170_get_vif(cvif
);
657 static inline bool is_main_vif(struct ar9170
*ar
, struct ieee80211_vif
*vif
)
662 ret
= (carl9170_get_main_vif(ar
) == vif
);
667 #endif /* __CARL9170_H */