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 <net/cfg80211.h>
47 #include <net/mac80211.h>
48 #include <linux/usb.h>
49 #ifdef CONFIG_CARL9170_LEDS
50 #include <linux/leds.h>
51 #endif /* CONFIG_CARL9170_LEDS */
52 #ifdef CONFIG_CARL9170_WPC
53 #include <linux/input.h>
54 #endif /* CONFIG_CARL9170_WPC */
62 #ifdef CONFIG_CARL9170_DEBUGFS
64 #endif /* CONFIG_CARL9170_DEBUGFS */
66 #define CARL9170FW_NAME "carl9170-1.fw"
68 #define PAYLOAD_MAX (CARL9170_MAX_CMD_LEN / 4 - 1)
70 enum carl9170_rf_init_mode
{
76 #define CARL9170_MAX_RX_BUFFER_SIZE 8192
78 enum carl9170_device_state
{
79 CARL9170_UNKNOWN_STATE
,
85 #define CARL9170_NUM_TID 16
86 #define WME_BA_BMP_SIZE 64
87 #define CARL9170_TX_USER_RATE_TRIES 3
94 #define TID_TO_WME_AC(_tid) \
95 ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
96 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
97 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
100 #define SEQ_DIFF(_start, _seq) \
101 (((_start) - (_seq)) & 0x0fff)
102 #define SEQ_PREV(_seq) \
103 (((_seq) - 1) & 0x0fff)
104 #define SEQ_NEXT(_seq) \
105 (((_seq) + 1) & 0x0fff)
106 #define BAW_WITHIN(_start, _bawsz, _seqno) \
107 ((((_seqno) - (_start)) & 0xfff) < (_bawsz))
109 enum carl9170_tid_state
{
110 CARL9170_TID_STATE_INVALID
,
111 CARL9170_TID_STATE_KILLED
,
112 CARL9170_TID_STATE_SHUTDOWN
,
113 CARL9170_TID_STATE_SUSPEND
,
114 CARL9170_TID_STATE_PROGRESS
,
115 CARL9170_TID_STATE_IDLE
,
116 CARL9170_TID_STATE_XMIT
,
119 #define CARL9170_BAW_BITS (2 * WME_BA_BMP_SIZE)
120 #define CARL9170_BAW_SIZE (BITS_TO_LONGS(CARL9170_BAW_BITS))
121 #define CARL9170_BAW_LEN (DIV_ROUND_UP(CARL9170_BAW_BITS, BITS_PER_BYTE))
123 struct carl9170_sta_tid
{
124 /* must be the first entry! */
125 struct list_head list
;
127 /* temporary list for RCU unlink procedure */
128 struct list_head tmp_list
;
130 /* lock for the following data structures */
133 unsigned int counter
;
134 enum carl9170_tid_state state
;
135 u8 tid
; /* TID number ( 0 - 15 ) */
136 u16 max
; /* max. AMPDU size */
138 u16 snx
; /* awaiting _next_ frame */
139 u16 hsn
; /* highest _queued_ sequence */
140 u16 bsn
; /* base of the tx/agg bitmap */
141 unsigned long bitmap
[CARL9170_BAW_SIZE
];
143 /* Preaggregation reorder queue */
144 struct sk_buff_head queue
;
147 #define CARL9170_QUEUE_TIMEOUT 256
148 #define CARL9170_BUMP_QUEUE 1000
149 #define CARL9170_TX_TIMEOUT 2500
150 #define CARL9170_JANITOR_DELAY 128
151 #define CARL9170_QUEUE_STUCK_TIMEOUT 5500
153 #define CARL9170_NUM_TX_AGG_MAX 30
156 * Tradeoff between stability/latency and speed.
158 * AR9170_TXQ_DEPTH is devised by dividing the amount of available
159 * tx buffers with the size of a full ethernet frame + overhead.
161 * Naturally: The higher the limit, the faster the device CAN send.
162 * However, even a slight over-commitment at the wrong time and the
163 * hardware is doomed to send all already-queued frames at suboptimal
164 * rates. This in turn leads to an enourmous amount of unsuccessful
165 * retries => Latency goes up, whereas the throughput goes down. CRASH!
167 #define CARL9170_NUM_TX_LIMIT_HARD ((AR9170_TXQ_DEPTH * 3) / 2)
168 #define CARL9170_NUM_TX_LIMIT_SOFT (AR9170_TXQ_DEPTH)
170 struct carl9170_tx_queue_stats
{
176 struct carl9170_vif
{
178 struct ieee80211_vif
*vif
;
181 struct carl9170_vif_info
{
182 struct list_head list
;
185 struct sk_buff
*beacon
;
189 #define AR9170_NUM_RX_URBS 16
190 #define AR9170_NUM_RX_URBS_MUL 2
191 #define AR9170_NUM_TX_URBS 8
192 #define AR9170_NUM_RX_URBS_POOL (AR9170_NUM_RX_URBS_MUL * AR9170_NUM_RX_URBS)
194 enum carl9170_device_features
{
195 CARL9170_WPS_BUTTON
= BIT(0),
196 CARL9170_ONE_LED
= BIT(1),
199 #ifdef CONFIG_CARL9170_LEDS
202 struct carl9170_led
{
204 struct led_classdev l
;
206 unsigned int toggled
;
210 #endif /* CONFIG_CARL9170_LEDS */
212 enum carl9170_restart_reasons
{
213 CARL9170_RR_NO_REASON
= 0,
214 CARL9170_RR_FATAL_FIRMWARE_ERROR
,
215 CARL9170_RR_TOO_MANY_FIRMWARE_ERRORS
,
216 CARL9170_RR_WATCHDOG
,
217 CARL9170_RR_STUCK_TX
,
218 CARL9170_RR_UNRESPONSIVE_DEVICE
,
219 CARL9170_RR_COMMAND_TIMEOUT
,
220 CARL9170_RR_TOO_MANY_PHY_ERRORS
,
221 CARL9170_RR_LOST_RSP
,
222 CARL9170_RR_INVALID_RSP
,
223 CARL9170_RR_USER_REQUEST
,
228 enum carl9170_erp_modes
{
229 CARL9170_ERP_INVALID
,
231 CARL9170_ERP_MAC80211
,
239 struct ath_common common
;
240 struct ieee80211_hw
*hw
;
242 enum carl9170_device_state state
;
243 spinlock_t state_lock
;
244 enum carl9170_restart_reasons last_reason
;
248 struct usb_device
*udev
;
249 struct usb_interface
*intf
;
250 struct usb_anchor rx_anch
;
251 struct usb_anchor rx_work
;
252 struct usb_anchor rx_pool
;
253 struct usb_anchor tx_wait
;
254 struct usb_anchor tx_anch
;
255 struct usb_anchor tx_cmd
;
256 struct usb_anchor tx_err
;
257 struct tasklet_struct usb_tasklet
;
258 atomic_t tx_cmd_urbs
;
259 atomic_t tx_anch_urbs
;
260 atomic_t rx_anch_urbs
;
261 atomic_t rx_work_urbs
;
262 atomic_t rx_pool_urbs
;
263 kernel_ulong_t features
;
265 /* firmware settings */
266 struct completion fw_load_wait
;
267 struct completion fw_boot_wait
;
269 const struct carl9170fw_desc_head
*desc
;
270 const struct firmware
*fw
;
272 unsigned int address
;
273 unsigned int cmd_bufs
;
274 unsigned int api_version
;
275 unsigned int vif_num
;
276 unsigned int err_counter
;
277 unsigned int bug_counter
;
279 unsigned int beacon_max_len
;
283 unsigned int mem_blocks
;
284 unsigned int mem_block_size
;
285 unsigned int rx_size
;
288 /* reset / stuck frames/queue detection */
289 struct work_struct restart_work
;
290 struct work_struct ping_work
;
291 unsigned int restart_counter
;
292 unsigned long queue_stop_timeout
[__AR9170_NUM_TXQ
];
293 unsigned long max_queue_stop_timeout
[__AR9170_NUM_TXQ
];
294 bool needs_full_reset
;
295 atomic_t pending_restarts
;
297 /* interface mode settings */
298 struct list_head vif_list
;
299 unsigned long vif_bitmap
;
301 struct carl9170_vif vif_priv
[AR9170_MAX_VIRTUAL_MAC
];
304 spinlock_t beacon_lock
;
305 unsigned int global_pretbtt
;
306 unsigned int global_beacon_int
;
307 struct carl9170_vif_info
*beacon_iter
;
308 unsigned int beacon_enabled
;
310 /* cryptographic engine */
312 bool rx_software_decryption
;
313 bool disable_offload
;
315 /* filter settings */
318 unsigned int filter_state
;
319 unsigned int rx_filter_caps
;
320 bool sniffer_enabled
;
323 enum carl9170_erp_modes erp_mode
;
326 struct ieee80211_channel
*channel
;
328 unsigned int chan_fail
;
329 unsigned int total_chan_fail
;
333 /* power calibration data */
342 #ifdef CONFIG_CARL9170_LEDS
344 struct delayed_work led_work
;
345 struct carl9170_led leds
[AR9170_NUM_LEDS
];
346 #endif /* CONFIG_CARL9170_LEDS */
348 /* qos queue settings */
349 spinlock_t tx_stats_lock
;
350 struct carl9170_tx_queue_stats tx_stats
[__AR9170_NUM_TXQ
];
351 struct ieee80211_tx_queue_params edcf
[5];
352 struct completion tx_flush
;
359 struct completion cmd_wait
;
361 __le32 cmd_buf
[PAYLOAD_MAX
+ 1];
362 struct carl9170_cmd cmd
;
363 struct carl9170_rsp rsp
;
367 unsigned int tx_dropped
;
368 unsigned int tx_ack_failures
;
369 unsigned int tx_fcs_errors
;
370 unsigned int rx_dropped
;
373 struct ar9170_eeprom eeprom
;
376 struct sk_buff_head tx_pending
[__AR9170_NUM_TXQ
];
377 struct sk_buff_head tx_status
[__AR9170_NUM_TXQ
];
378 struct delayed_work tx_janitor
;
379 unsigned long tx_janitor_last_run
;
383 struct work_struct ampdu_work
;
384 spinlock_t tx_ampdu_list_lock
;
385 struct carl9170_sta_tid
*tx_ampdu_iter
;
386 struct list_head tx_ampdu_list
;
387 atomic_t tx_ampdu_upload
;
388 atomic_t tx_ampdu_scheduler
;
389 atomic_t tx_total_pending
;
390 atomic_t tx_total_queued
;
391 unsigned int tx_ampdu_list_len
;
394 bool tx_ampdu_schedule
;
396 /* internal memory management */
398 unsigned long *mem_bitmap
;
399 atomic_t mem_free_blocks
;
402 /* rxstream mpdu merge */
403 struct ar9170_rx_head rx_plcp
;
405 struct sk_buff
*rx_failover
;
406 int rx_failover_missing
;
408 #ifdef CONFIG_CARL9170_WPC
411 struct input_dev
*pbc
;
415 #endif /* CONFIG_CARL9170_WPC */
417 #ifdef CONFIG_CARL9170_DEBUGFS
418 struct carl9170_debug debug
;
419 struct dentry
*debug_dir
;
420 #endif /* CONFIG_CARL9170_DEBUGFS */
423 struct work_struct ps_work
;
425 unsigned int dtim_counter
;
426 unsigned long last_beacon
;
427 unsigned long last_action
;
428 unsigned long last_slept
;
429 unsigned int sleep_ms
;
430 unsigned int off_override
;
435 enum carl9170_ps_off_override_reasons
{
438 PS_OFF_5GHZ
= BIT(2),
441 struct carl9170_ba_stats
{
447 struct carl9170_sta_info
{
449 unsigned int ampdu_max_len
;
450 struct carl9170_sta_tid
*agg
[CARL9170_NUM_TID
];
451 struct carl9170_ba_stats stats
[CARL9170_NUM_TID
];
454 struct carl9170_tx_info
{
455 unsigned long timeout
;
460 #define CHK_DEV_STATE(a, s) (((struct ar9170 *)a)->state >= (s))
461 #define IS_INITIALIZED(a) (CHK_DEV_STATE(a, CARL9170_STOPPED))
462 #define IS_ACCEPTING_CMD(a) (CHK_DEV_STATE(a, CARL9170_IDLE))
463 #define IS_STARTED(a) (CHK_DEV_STATE(a, CARL9170_STARTED))
465 static inline void __carl9170_set_state(struct ar9170
*ar
,
466 enum carl9170_device_state newstate
)
468 ar
->state
= newstate
;
471 static inline void carl9170_set_state(struct ar9170
*ar
,
472 enum carl9170_device_state newstate
)
476 spin_lock_irqsave(&ar
->state_lock
, flags
);
477 __carl9170_set_state(ar
, newstate
);
478 spin_unlock_irqrestore(&ar
->state_lock
, flags
);
481 static inline void carl9170_set_state_when(struct ar9170
*ar
,
482 enum carl9170_device_state min
, enum carl9170_device_state newstate
)
486 spin_lock_irqsave(&ar
->state_lock
, flags
);
487 if (CHK_DEV_STATE(ar
, min
))
488 __carl9170_set_state(ar
, newstate
);
489 spin_unlock_irqrestore(&ar
->state_lock
, flags
);
492 /* exported interface */
493 void *carl9170_alloc(size_t priv_size
);
494 int carl9170_register(struct ar9170
*ar
);
495 void carl9170_unregister(struct ar9170
*ar
);
496 void carl9170_free(struct ar9170
*ar
);
497 void carl9170_restart(struct ar9170
*ar
, const enum carl9170_restart_reasons r
);
498 void carl9170_ps_check(struct ar9170
*ar
);
501 int carl9170_usb_open(struct ar9170
*ar
);
502 void carl9170_usb_stop(struct ar9170
*ar
);
503 void carl9170_usb_tx(struct ar9170
*ar
, struct sk_buff
*skb
);
504 void carl9170_usb_handle_tx_err(struct ar9170
*ar
);
505 int carl9170_exec_cmd(struct ar9170
*ar
, const enum carl9170_cmd_oids
,
506 u32 plen
, void *payload
, u32 rlen
, void *resp
);
507 int __carl9170_exec_cmd(struct ar9170
*ar
, struct carl9170_cmd
*cmd
,
508 const bool free_buf
);
509 int carl9170_usb_restart(struct ar9170
*ar
);
510 void carl9170_usb_reset(struct ar9170
*ar
);
513 int carl9170_init_mac(struct ar9170
*ar
);
514 int carl9170_set_qos(struct ar9170
*ar
);
515 int carl9170_update_multicast(struct ar9170
*ar
, const u64 mc_hast
);
516 int carl9170_mod_virtual_mac(struct ar9170
*ar
, const unsigned int id
,
518 int carl9170_set_operating_mode(struct ar9170
*ar
);
519 int carl9170_set_beacon_timers(struct ar9170
*ar
);
520 int carl9170_set_dyn_sifs_ack(struct ar9170
*ar
);
521 int carl9170_set_rts_cts_rate(struct ar9170
*ar
);
522 int carl9170_set_ampdu_settings(struct ar9170
*ar
);
523 int carl9170_set_slot_time(struct ar9170
*ar
);
524 int carl9170_set_mac_rates(struct ar9170
*ar
);
525 int carl9170_set_hwretry_limit(struct ar9170
*ar
, const u32 max_retry
);
526 int carl9170_update_beacon(struct ar9170
*ar
, const bool submit
);
527 int carl9170_upload_key(struct ar9170
*ar
, const u8 id
, const u8
*mac
,
528 const u8 ktype
, const u8 keyidx
, const u8
*keydata
, const int keylen
);
529 int carl9170_disable_key(struct ar9170
*ar
, const u8 id
);
532 void carl9170_rx(struct ar9170
*ar
, void *buf
, unsigned int len
);
533 void carl9170_handle_command_response(struct ar9170
*ar
, void *buf
, u32 len
);
536 int carl9170_op_tx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
537 void carl9170_tx_janitor(struct work_struct
*work
);
538 void carl9170_tx_process_status(struct ar9170
*ar
,
539 const struct carl9170_rsp
*cmd
);
540 void carl9170_tx_status(struct ar9170
*ar
, struct sk_buff
*skb
,
542 void carl9170_tx_callback(struct ar9170
*ar
, struct sk_buff
*skb
);
543 void carl9170_tx_drop(struct ar9170
*ar
, struct sk_buff
*skb
);
544 void carl9170_tx_scheduler(struct ar9170
*ar
);
545 void carl9170_tx_get_skb(struct sk_buff
*skb
);
546 int carl9170_tx_put_skb(struct sk_buff
*skb
);
549 #ifdef CONFIG_CARL9170_LEDS
550 int carl9170_led_register(struct ar9170
*ar
);
551 void carl9170_led_unregister(struct ar9170
*ar
);
552 #endif /* CONFIG_CARL9170_LEDS */
553 int carl9170_led_init(struct ar9170
*ar
);
554 int carl9170_led_set_state(struct ar9170
*ar
, const u32 led_state
);
557 int carl9170_set_channel(struct ar9170
*ar
, struct ieee80211_channel
*channel
,
558 enum nl80211_channel_type bw
, enum carl9170_rf_init_mode rfi
);
559 int carl9170_get_noisefloor(struct ar9170
*ar
);
562 int carl9170_parse_firmware(struct ar9170
*ar
);
563 int carl9170_fw_fix_eeprom(struct ar9170
*ar
);
565 extern struct ieee80211_rate __carl9170_ratetable
[];
566 extern int modparam_noht
;
568 static inline struct ar9170
*carl9170_get_priv(struct carl9170_vif
*carl_vif
)
570 return container_of(carl_vif
, struct ar9170
,
571 vif_priv
[carl_vif
->id
]);
574 static inline struct ieee80211_hdr
*carl9170_get_hdr(struct sk_buff
*skb
)
576 return (void *)((struct _carl9170_tx_superframe
*)
577 skb
->data
)->frame_data
;
580 static inline u16
get_seq_h(struct ieee80211_hdr
*hdr
)
582 return le16_to_cpu(hdr
->seq_ctrl
) >> 4;
585 static inline u16
carl9170_get_seq(struct sk_buff
*skb
)
587 return get_seq_h(carl9170_get_hdr(skb
));
590 static inline u16
get_tid_h(struct ieee80211_hdr
*hdr
)
592 return (ieee80211_get_qos_ctl(hdr
))[0] & IEEE80211_QOS_CTL_TID_MASK
;
595 static inline u16
carl9170_get_tid(struct sk_buff
*skb
)
597 return get_tid_h(carl9170_get_hdr(skb
));
600 static inline struct ieee80211_vif
*
601 carl9170_get_vif(struct carl9170_vif_info
*priv
)
603 return container_of((void *)priv
, struct ieee80211_vif
, drv_priv
);
606 /* Protected by ar->mutex or RCU */
607 static inline struct ieee80211_vif
*carl9170_get_main_vif(struct ar9170
*ar
)
609 struct carl9170_vif_info
*cvif
;
611 list_for_each_entry_rcu(cvif
, &ar
->vif_list
, list
) {
613 return carl9170_get_vif(cvif
);
619 static inline bool is_main_vif(struct ar9170
*ar
, struct ieee80211_vif
*vif
)
624 ret
= (carl9170_get_main_vif(ar
) == vif
);
629 #endif /* __CARL9170_H */