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
;
294 /* interface configuration combinations */
295 struct ieee80211_iface_limit if_comb_limits
[1];
296 struct ieee80211_iface_combination if_combs
[1];
298 /* reset / stuck frames/queue detection */
299 struct work_struct restart_work
;
300 struct work_struct ping_work
;
301 unsigned int restart_counter
;
302 unsigned long queue_stop_timeout
[__AR9170_NUM_TXQ
];
303 unsigned long max_queue_stop_timeout
[__AR9170_NUM_TXQ
];
304 bool needs_full_reset
;
305 atomic_t pending_restarts
;
307 /* interface mode settings */
308 struct list_head vif_list
;
309 unsigned long vif_bitmap
;
311 struct carl9170_vif vif_priv
[AR9170_MAX_VIRTUAL_MAC
];
314 spinlock_t beacon_lock
;
315 unsigned int global_pretbtt
;
316 unsigned int global_beacon_int
;
317 struct carl9170_vif_info __rcu
*beacon_iter
;
318 unsigned int beacon_enabled
;
320 /* cryptographic engine */
322 bool rx_software_decryption
;
323 bool disable_offload
;
325 /* filter settings */
328 unsigned int filter_state
;
329 unsigned int rx_filter_caps
;
330 bool sniffer_enabled
;
333 enum carl9170_erp_modes erp_mode
;
336 struct ieee80211_channel
*channel
;
337 unsigned int num_channels
;
339 unsigned int chan_fail
;
340 unsigned int total_chan_fail
;
344 u64 active
; /* usec */
346 u64 tx_time
; /* usec */
350 struct delayed_work stat_work
;
351 struct survey_info
*survey
;
353 /* power calibration data */
362 #ifdef CONFIG_CARL9170_LEDS
364 struct delayed_work led_work
;
365 struct carl9170_led leds
[AR9170_NUM_LEDS
];
366 #endif /* CONFIG_CARL9170_LEDS */
368 /* qos queue settings */
369 spinlock_t tx_stats_lock
;
370 struct carl9170_tx_queue_stats tx_stats
[__AR9170_NUM_TXQ
];
371 struct ieee80211_tx_queue_params edcf
[5];
372 struct completion tx_flush
;
379 struct completion cmd_wait
;
381 __le32 cmd_buf
[PAYLOAD_MAX
+ 1];
382 struct carl9170_cmd cmd
;
383 struct carl9170_rsp rsp
;
387 unsigned int tx_dropped
;
388 unsigned int tx_ack_failures
;
389 unsigned int tx_fcs_errors
;
390 unsigned int rx_dropped
;
393 struct ar9170_eeprom eeprom
;
396 struct sk_buff_head tx_pending
[__AR9170_NUM_TXQ
];
397 struct sk_buff_head tx_status
[__AR9170_NUM_TXQ
];
398 struct delayed_work tx_janitor
;
399 unsigned long tx_janitor_last_run
;
403 struct work_struct ampdu_work
;
404 spinlock_t tx_ampdu_list_lock
;
405 struct carl9170_sta_tid __rcu
*tx_ampdu_iter
;
406 struct list_head tx_ampdu_list
;
407 atomic_t tx_ampdu_upload
;
408 atomic_t tx_ampdu_scheduler
;
409 atomic_t tx_total_pending
;
410 atomic_t tx_total_queued
;
411 unsigned int tx_ampdu_list_len
;
414 bool tx_ampdu_schedule
;
416 /* internal memory management */
418 unsigned long *mem_bitmap
;
419 atomic_t mem_free_blocks
;
422 /* rxstream mpdu merge */
423 struct ar9170_rx_head rx_plcp
;
425 struct sk_buff
*rx_failover
;
426 int rx_failover_missing
;
428 #ifdef CONFIG_CARL9170_WPC
431 struct input_dev
*pbc
;
435 #endif /* CONFIG_CARL9170_WPC */
437 #ifdef CONFIG_CARL9170_DEBUGFS
438 struct carl9170_debug debug
;
439 struct dentry
*debug_dir
;
440 #endif /* CONFIG_CARL9170_DEBUGFS */
443 struct work_struct ps_work
;
445 unsigned int dtim_counter
;
446 unsigned long last_beacon
;
447 unsigned long last_action
;
448 unsigned long last_slept
;
449 unsigned int sleep_ms
;
450 unsigned int off_override
;
454 #ifdef CONFIG_CARL9170_HWRNG
455 # define CARL9170_HWRNG_CACHE_SIZE CARL9170_MAX_CMD_PAYLOAD_LEN
460 u16 cache
[CARL9170_HWRNG_CACHE_SIZE
/ sizeof(u16
)];
461 unsigned int cache_idx
;
463 #endif /* CONFIG_CARL9170_HWRNG */
466 enum carl9170_ps_off_override_reasons
{
471 struct carl9170_ba_stats
{
478 struct carl9170_sta_info
{
481 atomic_t pending_frames
;
482 unsigned int ampdu_max_len
;
483 struct carl9170_sta_tid __rcu
*agg
[CARL9170_NUM_TID
];
484 struct carl9170_ba_stats stats
[CARL9170_NUM_TID
];
487 struct carl9170_tx_info
{
488 unsigned long timeout
;
493 #define CHK_DEV_STATE(a, s) (((struct ar9170 *)a)->state >= (s))
494 #define IS_INITIALIZED(a) (CHK_DEV_STATE(a, CARL9170_STOPPED))
495 #define IS_ACCEPTING_CMD(a) (CHK_DEV_STATE(a, CARL9170_IDLE))
496 #define IS_STARTED(a) (CHK_DEV_STATE(a, CARL9170_STARTED))
498 static inline void __carl9170_set_state(struct ar9170
*ar
,
499 enum carl9170_device_state newstate
)
501 ar
->state
= newstate
;
504 static inline void carl9170_set_state(struct ar9170
*ar
,
505 enum carl9170_device_state newstate
)
509 spin_lock_irqsave(&ar
->state_lock
, flags
);
510 __carl9170_set_state(ar
, newstate
);
511 spin_unlock_irqrestore(&ar
->state_lock
, flags
);
514 static inline void carl9170_set_state_when(struct ar9170
*ar
,
515 enum carl9170_device_state min
, enum carl9170_device_state newstate
)
519 spin_lock_irqsave(&ar
->state_lock
, flags
);
520 if (CHK_DEV_STATE(ar
, min
))
521 __carl9170_set_state(ar
, newstate
);
522 spin_unlock_irqrestore(&ar
->state_lock
, flags
);
525 /* exported interface */
526 void *carl9170_alloc(size_t priv_size
);
527 int carl9170_register(struct ar9170
*ar
);
528 void carl9170_unregister(struct ar9170
*ar
);
529 void carl9170_free(struct ar9170
*ar
);
530 void carl9170_restart(struct ar9170
*ar
, const enum carl9170_restart_reasons r
);
531 void carl9170_ps_check(struct ar9170
*ar
);
534 int carl9170_usb_open(struct ar9170
*ar
);
535 void carl9170_usb_stop(struct ar9170
*ar
);
536 void carl9170_usb_tx(struct ar9170
*ar
, struct sk_buff
*skb
);
537 void carl9170_usb_handle_tx_err(struct ar9170
*ar
);
538 int carl9170_exec_cmd(struct ar9170
*ar
, const enum carl9170_cmd_oids
,
539 u32 plen
, void *payload
, u32 rlen
, void *resp
);
540 int __carl9170_exec_cmd(struct ar9170
*ar
, struct carl9170_cmd
*cmd
,
541 const bool free_buf
);
542 int carl9170_usb_restart(struct ar9170
*ar
);
543 void carl9170_usb_reset(struct ar9170
*ar
);
546 int carl9170_init_mac(struct ar9170
*ar
);
547 int carl9170_set_qos(struct ar9170
*ar
);
548 int carl9170_update_multicast(struct ar9170
*ar
, const u64 mc_hast
);
549 int carl9170_mod_virtual_mac(struct ar9170
*ar
, const unsigned int id
,
551 int carl9170_set_operating_mode(struct ar9170
*ar
);
552 int carl9170_set_beacon_timers(struct ar9170
*ar
);
553 int carl9170_set_dyn_sifs_ack(struct ar9170
*ar
);
554 int carl9170_set_rts_cts_rate(struct ar9170
*ar
);
555 int carl9170_set_ampdu_settings(struct ar9170
*ar
);
556 int carl9170_set_slot_time(struct ar9170
*ar
);
557 int carl9170_set_mac_rates(struct ar9170
*ar
);
558 int carl9170_set_hwretry_limit(struct ar9170
*ar
, const u32 max_retry
);
559 int carl9170_upload_key(struct ar9170
*ar
, const u8 id
, const u8
*mac
,
560 const u8 ktype
, const u8 keyidx
, const u8
*keydata
, const int keylen
);
561 int carl9170_disable_key(struct ar9170
*ar
, const u8 id
);
564 void carl9170_rx(struct ar9170
*ar
, void *buf
, unsigned int len
);
565 void carl9170_handle_command_response(struct ar9170
*ar
, void *buf
, u32 len
);
568 void carl9170_op_tx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
569 void carl9170_tx_janitor(struct work_struct
*work
);
570 void carl9170_tx_process_status(struct ar9170
*ar
,
571 const struct carl9170_rsp
*cmd
);
572 void carl9170_tx_status(struct ar9170
*ar
, struct sk_buff
*skb
,
574 void carl9170_tx_callback(struct ar9170
*ar
, struct sk_buff
*skb
);
575 void carl9170_tx_drop(struct ar9170
*ar
, struct sk_buff
*skb
);
576 void carl9170_tx_scheduler(struct ar9170
*ar
);
577 void carl9170_tx_get_skb(struct sk_buff
*skb
);
578 int carl9170_tx_put_skb(struct sk_buff
*skb
);
579 int carl9170_update_beacon(struct ar9170
*ar
, const bool submit
);
582 #ifdef CONFIG_CARL9170_LEDS
583 int carl9170_led_register(struct ar9170
*ar
);
584 void carl9170_led_unregister(struct ar9170
*ar
);
585 #endif /* CONFIG_CARL9170_LEDS */
586 int carl9170_led_init(struct ar9170
*ar
);
587 int carl9170_led_set_state(struct ar9170
*ar
, const u32 led_state
);
590 int carl9170_set_channel(struct ar9170
*ar
, struct ieee80211_channel
*channel
,
591 enum nl80211_channel_type bw
, enum carl9170_rf_init_mode rfi
);
592 int carl9170_get_noisefloor(struct ar9170
*ar
);
595 int carl9170_parse_firmware(struct ar9170
*ar
);
596 int carl9170_fw_fix_eeprom(struct ar9170
*ar
);
598 extern struct ieee80211_rate __carl9170_ratetable
[];
599 extern int modparam_noht
;
601 static inline struct ar9170
*carl9170_get_priv(struct carl9170_vif
*carl_vif
)
603 return container_of(carl_vif
, struct ar9170
,
604 vif_priv
[carl_vif
->id
]);
607 static inline struct ieee80211_hdr
*carl9170_get_hdr(struct sk_buff
*skb
)
609 return (void *)((struct _carl9170_tx_superframe
*)
610 skb
->data
)->frame_data
;
613 static inline u16
get_seq_h(struct ieee80211_hdr
*hdr
)
615 return le16_to_cpu(hdr
->seq_ctrl
) >> 4;
618 static inline u16
carl9170_get_seq(struct sk_buff
*skb
)
620 return get_seq_h(carl9170_get_hdr(skb
));
623 static inline u16
get_tid_h(struct ieee80211_hdr
*hdr
)
625 return (ieee80211_get_qos_ctl(hdr
))[0] & IEEE80211_QOS_CTL_TID_MASK
;
628 static inline u16
carl9170_get_tid(struct sk_buff
*skb
)
630 return get_tid_h(carl9170_get_hdr(skb
));
633 static inline struct ieee80211_vif
*
634 carl9170_get_vif(struct carl9170_vif_info
*priv
)
636 return container_of((void *)priv
, struct ieee80211_vif
, drv_priv
);
639 /* Protected by ar->mutex or RCU */
640 static inline struct ieee80211_vif
*carl9170_get_main_vif(struct ar9170
*ar
)
642 struct carl9170_vif_info
*cvif
;
644 list_for_each_entry_rcu(cvif
, &ar
->vif_list
, list
) {
646 return carl9170_get_vif(cvif
);
652 static inline bool is_main_vif(struct ar9170
*ar
, struct ieee80211_vif
*vif
)
657 ret
= (carl9170_get_main_vif(ar
) == vif
);
662 #endif /* __CARL9170_H */