2 * Copyright (c) 2008-2009 Atheros Communications Inc.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <linux/etherdevice.h>
21 #include <linux/device.h>
22 #include <linux/leds.h>
23 #include <linux/completion.h>
29 * Header for the ath9k.ko driver core *only* -- hw code nor any other driver
30 * should rely on this file or its contents.
35 /* Macro to expand scalars to 64-bit objects */
37 #define ito64(x) (sizeof(x) == 1) ? \
38 (((unsigned long long int)(x)) & (0xff)) : \
40 (((unsigned long long int)(x)) & 0xffff) : \
42 (((unsigned long long int)(x)) & 0xffffffff) : \
43 (unsigned long long int)(x))
45 /* increment with wrap-around */
46 #define INCR(_l, _sz) do { \
48 (_l) &= ((_sz) - 1); \
51 /* decrement with wrap-around */
52 #define DECR(_l, _sz) do { \
54 (_l) &= ((_sz) - 1); \
57 #define A_MAX(a, b) ((a) > (b) ? (a) : (b))
59 #define TSF_TO_TU(_h,_l) \
60 ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
62 #define ATH_TXQ_SETUP(sc, i) ((sc)->tx.txqsetup & (1<<i))
70 /*************************/
71 /* Descriptor Management */
72 /*************************/
74 #define ATH_TXBUF_RESET(_bf) do { \
75 (_bf)->bf_stale = false; \
76 (_bf)->bf_lastbf = NULL; \
77 (_bf)->bf_next = NULL; \
78 memset(&((_bf)->bf_state), 0, \
79 sizeof(struct ath_buf_state)); \
82 #define ATH_RXBUF_RESET(_bf) do { \
83 (_bf)->bf_stale = false; \
87 * enum buffer_type - Buffer type flags
89 * @BUF_AMPDU: This buffer is an ampdu, as part of an aggregate (during TX)
90 * @BUF_AGGR: Indicates whether the buffer can be aggregated
91 * (used in aggregation scheduling)
92 * @BUF_XRETRY: To denote excessive retries of the buffer
100 #define bf_isampdu(bf) (bf->bf_state.bf_type & BUF_AMPDU)
101 #define bf_isaggr(bf) (bf->bf_state.bf_type & BUF_AGGR)
102 #define bf_isxretried(bf) (bf->bf_state.bf_type & BUF_XRETRY)
104 #define ATH_TXSTATUS_RING_SIZE 64
108 dma_addr_t dd_desc_paddr;
110 struct ath_buf *dd_bufptr;
113 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
114 struct list_head *head, const char *name,
115 int nbuf, int ndesc, bool is_tx);
116 void ath_descdma_cleanup(struct ath_softc *sc, struct ath_descdma *dd,
117 struct list_head *head);
123 #define ATH_MAX_ANTENNA 3
124 #define ATH_RXBUF 512
125 #define ATH_TXBUF 512
126 #define ATH_TXBUF_RESERVE 5
127 #define ATH_MAX_QDEPTH (ATH_TXBUF / 4 - ATH_TXBUF_RESERVE)
128 #define ATH_TXMAXTRY 13
129 #define ATH_MGT_TXMAXTRY 4
131 #define TID_TO_WME_AC(_tid) \
132 ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
133 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
134 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
137 #define ADDBA_EXCHANGE_ATTEMPTS 10
138 #define ATH_AGGR_DELIM_SZ 4
139 #define ATH_AGGR_MINPLEN 256 /* in bytes, minimum packet length */
140 /* number of delimiters for encryption padding */
141 #define ATH_AGGR_ENCRYPTDELIM 10
142 /* minimum h/w qdepth to be sustained to maximize aggregation */
143 #define ATH_AGGR_MIN_QDEPTH 2
144 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
146 #define IEEE80211_SEQ_SEQ_SHIFT 4
147 #define IEEE80211_SEQ_MAX 4096
148 #define IEEE80211_WEP_IVLEN 3
149 #define IEEE80211_WEP_KIDLEN 1
150 #define IEEE80211_WEP_CRCLEN 4
151 #define IEEE80211_MAX_MPDU_LEN (3840 + FCS_LEN + \
152 (IEEE80211_WEP_IVLEN + \
153 IEEE80211_WEP_KIDLEN + \
154 IEEE80211_WEP_CRCLEN))
156 /* return whether a bit at index _n in bitmap _bm is set
157 * _sz is the size of the bitmap */
158 #define ATH_BA_ISSET(_bm, _n) (((_n) < (WME_BA_BMP_SIZE)) && \
159 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
161 /* return block-ack bitmap index given sequence and starting sequence */
162 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
164 /* returns delimiter padding required given the packet length */
165 #define ATH_AGGR_GET_NDELIM(_len) \
166 (((_len) >= ATH_AGGR_MINPLEN) ? 0 : \
167 DIV_ROUND_UP(ATH_AGGR_MINPLEN - (_len), ATH_AGGR_DELIM_SZ))
169 #define BAW_WITHIN(_start, _bawsz, _seqno) \
170 ((((_seqno) - (_start)) & 4095) < (_bawsz))
172 #define ATH_AN_2_TID(_an, _tidno) (&(_an)->tid[(_tidno)])
174 #define ATH_TX_COMPLETE_POLL_INT 1000
176 enum ATH_AGGR_STATUS {
182 #define ATH_TXFIFO_DEPTH 8
186 struct list_head axq_q;
190 bool axq_tx_inprogress;
191 struct list_head axq_acq;
192 struct list_head txq_fifo[ATH_TXFIFO_DEPTH];
193 struct list_head txq_fifo_pending;
202 struct list_head list;
203 struct list_head tid_q;
206 struct ath_frame_info {
209 enum ath9k_key_type keytype;
214 struct ath_buf_state {
217 enum ath9k_internal_frame_type bfs_ftype;
221 struct list_head list;
222 struct ath_buf *bf_lastbf; /* last buf of this unit (a frame or
224 struct ath_buf *bf_next; /* next subframe in the aggregate */
225 struct sk_buff *bf_mpdu; /* enclosing frame structure */
226 void *bf_desc; /* virtual addr of desc */
227 dma_addr_t bf_daddr; /* physical addr of desc */
228 dma_addr_t bf_buf_addr; /* physical addr of data buffer, for DMA */
231 struct ath_buf_state bf_state;
232 struct ath_wiphy *aphy;
236 struct list_head list;
237 struct list_head buf_q;
239 struct ath_atx_ac *ac;
240 unsigned long tx_buf[BITS_TO_LONGS(ATH_TID_MAX_BUFS)];
245 int baw_head; /* first un-acked tx buffer */
246 int baw_tail; /* next unused tx buffer slot */
253 struct ath_common *common;
254 struct ath_atx_tid tid[WME_NUM_TID];
255 struct ath_atx_ac ac[WME_NUM_AC];
260 #define AGGR_CLEANUP BIT(1)
261 #define AGGR_ADDBA_COMPLETE BIT(2)
262 #define AGGR_ADDBA_PROGRESS BIT(3)
264 struct ath_tx_control {
268 enum ath9k_internal_frame_type frame_type;
272 #define ATH_TX_ERROR 0x01
273 #define ATH_TX_XRETRY 0x02
274 #define ATH_TX_BAR 0x04
279 spinlock_t txbuflock;
280 struct list_head txbuf;
281 struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
282 struct ath_descdma txdma;
283 struct ath_txq *txq_map[WME_NUM_AC];
287 struct sk_buff_head rx_fifo;
288 struct sk_buff_head rx_buffers;
296 unsigned int rxfilter;
297 spinlock_t rxbuflock;
298 struct list_head rxbuf;
299 struct ath_descdma rxdma;
300 struct ath_buf *rx_bufptr;
301 struct ath_rx_edma rx_edma[ATH9K_RX_QUEUE_MAX];
304 int ath_startrecv(struct ath_softc *sc);
305 bool ath_stoprecv(struct ath_softc *sc);
306 void ath_flushrecv(struct ath_softc *sc);
307 u32 ath_calcrxfilter(struct ath_softc *sc);
308 int ath_rx_init(struct ath_softc *sc, int nbufs);
309 void ath_rx_cleanup(struct ath_softc *sc);
310 int ath_rx_tasklet(struct ath_softc *sc, int flush, bool hp);
311 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
312 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
313 void ath_drain_all_txq(struct ath_softc *sc, bool retry_tx);
314 void ath_draintxq(struct ath_softc *sc,
315 struct ath_txq *txq, bool retry_tx);
316 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
317 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
318 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
319 int ath_tx_init(struct ath_softc *sc, int nbufs);
320 void ath_tx_cleanup(struct ath_softc *sc);
321 int ath_txq_update(struct ath_softc *sc, int qnum,
322 struct ath9k_tx_queue_info *q);
323 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
324 struct ath_tx_control *txctl);
325 void ath_tx_tasklet(struct ath_softc *sc);
326 void ath_tx_edma_tasklet(struct ath_softc *sc);
327 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
329 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
330 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
338 __le64 tsf_adjust; /* TSF adjustment for staggered beacons */
339 enum nl80211_iftype av_opmode;
340 struct ath_buf *av_bcbuf;
341 struct ath_tx_control av_btxctl;
342 u8 bssid[ETH_ALEN]; /* current BSSID from config_interface */
345 /*******************/
346 /* Beacon Handling */
347 /*******************/
350 * Regardless of the number of beacons we stagger, (i.e. regardless of the
351 * number of BSSIDs) if a given beacon does not go out even after waiting this
352 * number of beacon intervals, the game's up.
354 #define BSTUCK_THRESH (9 * ATH_BCBUF)
356 #define ATH_DEFAULT_BINTVAL 100 /* TU */
357 #define ATH_DEFAULT_BMISS_LIMIT 10
358 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
360 struct ath_beacon_config {
370 OK, /* no change needed */
371 UPDATE, /* update pending */
372 COMMIT /* beacon sent, commit change */
373 } updateslot; /* slot time update fsm */
379 struct ieee80211_vif *bslot[ATH_BCBUF];
380 struct ath_wiphy *bslot_aphy[ATH_BCBUF];
383 struct ath9k_tx_queue_info beacon_qi;
384 struct ath_descdma bdma;
385 struct ath_txq *cabq;
386 struct list_head bbuf;
389 void ath_beacon_tasklet(unsigned long data);
390 void ath_beacon_config(struct ath_softc *sc, struct ieee80211_vif *vif);
391 int ath_beacon_alloc(struct ath_wiphy *aphy, struct ieee80211_vif *vif);
392 void ath_beacon_return(struct ath_softc *sc, struct ath_vif *avp);
393 int ath_beaconq_config(struct ath_softc *sc);
399 #define ATH_STA_SHORT_CALINTERVAL 1000 /* 1 second */
400 #define ATH_AP_SHORT_CALINTERVAL 100 /* 100 ms */
401 #define ATH_ANI_POLLINTERVAL_OLD 100 /* 100 ms */
402 #define ATH_ANI_POLLINTERVAL_NEW 1000 /* 1000 ms */
403 #define ATH_LONG_CALINTERVAL_INT 1000 /* 1000 ms */
404 #define ATH_LONG_CALINTERVAL 30000 /* 30 seconds */
405 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes */
407 #define ATH_PAPRD_TIMEOUT 100 /* msecs */
409 void ath_hw_check(struct work_struct *work);
410 void ath_paprd_calibrate(struct work_struct *work);
411 void ath_ani_calibrate(unsigned long data);
418 bool hw_timer_enabled;
419 spinlock_t btcoex_lock;
420 struct timer_list period_timer; /* Timer for BT period */
422 unsigned long bt_priority_time;
423 int bt_stomp_type; /* Types of BT stomping */
424 u32 btcoex_no_stomp; /* in usec */
425 u32 btcoex_period; /* in usec */
426 u32 btscan_no_stomp; /* in usec */
427 struct ath_gen_timer *no_stomp_timer; /* Timer for no BT stomping */
430 int ath_init_btcoex_timer(struct ath_softc *sc);
431 void ath9k_btcoex_timer_resume(struct ath_softc *sc);
432 void ath9k_btcoex_timer_pause(struct ath_softc *sc);
434 /********************/
436 /********************/
438 #define ATH_LED_PIN_DEF 1
439 #define ATH_LED_PIN_9287 8
440 #define ATH_LED_ON_DURATION_IDLE 350 /* in msecs */
441 #define ATH_LED_OFF_DURATION_IDLE 250 /* in msecs */
451 struct ath_softc *sc;
452 struct led_classdev led_cdev;
453 enum ath_led_type led_type;
458 void ath_init_leds(struct ath_softc *sc);
459 void ath_deinit_leds(struct ath_softc *sc);
461 /* Antenna diversity/combining */
462 #define ATH_ANT_RX_CURRENT_SHIFT 4
463 #define ATH_ANT_RX_MAIN_SHIFT 2
464 #define ATH_ANT_RX_MASK 0x3
466 #define ATH_ANT_DIV_COMB_SHORT_SCAN_INTR 50
467 #define ATH_ANT_DIV_COMB_SHORT_SCAN_PKTCOUNT 0x100
468 #define ATH_ANT_DIV_COMB_MAX_PKTCOUNT 0x200
469 #define ATH_ANT_DIV_COMB_INIT_COUNT 95
470 #define ATH_ANT_DIV_COMB_MAX_COUNT 100
471 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO 30
472 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2 20
474 #define ATH_ANT_DIV_COMB_LNA1_LNA2_DELTA -3
475 #define ATH_ANT_DIV_COMB_LNA1_LNA2_SWITCH_DELTA -1
476 #define ATH_ANT_DIV_COMB_LNA1_DELTA_HI -4
477 #define ATH_ANT_DIV_COMB_LNA1_DELTA_MID -2
478 #define ATH_ANT_DIV_COMB_LNA1_DELTA_LOW 2
480 enum ath9k_ant_div_comb_lna_conf {
481 ATH_ANT_DIV_COMB_LNA1_MINUS_LNA2,
482 ATH_ANT_DIV_COMB_LNA2,
483 ATH_ANT_DIV_COMB_LNA1,
484 ATH_ANT_DIV_COMB_LNA1_PLUS_LNA2,
487 struct ath_ant_comb {
506 enum ath9k_ant_div_comb_lna_conf first_quick_scan_conf;
507 enum ath9k_ant_div_comb_lna_conf second_quick_scan_conf;
512 unsigned long scan_start_time;
515 /********************/
516 /* Main driver core */
517 /********************/
520 * Default cache line size, in bytes.
521 * Used when PCI device not fully initialized by bootrom/BIOS
523 #define DEFAULT_CACHELINE 32
524 #define ATH_REGCLASSIDS_MAX 10
525 #define ATH_CABQ_READY_TIME 80 /* % of beacon interval */
526 #define ATH_MAX_SW_RETRIES 10
527 #define ATH_CHAN_MAX 255
528 #define IEEE80211_WEP_NKID 4 /* number of key ids */
530 #define ATH_TXPOWER_MAX 100 /* .5 dBm units */
531 #define ATH_RATE_DUMMY_MARKER 0
533 #define SC_OP_INVALID BIT(0)
534 #define SC_OP_BEACONS BIT(1)
535 #define SC_OP_RXAGGR BIT(2)
536 #define SC_OP_TXAGGR BIT(3)
537 #define SC_OP_OFFCHANNEL BIT(4)
538 #define SC_OP_PREAMBLE_SHORT BIT(5)
539 #define SC_OP_PROTECT_ENABLE BIT(6)
540 #define SC_OP_RXFLUSH BIT(7)
541 #define SC_OP_LED_ASSOCIATED BIT(8)
542 #define SC_OP_LED_ON BIT(9)
543 #define SC_OP_TSF_RESET BIT(11)
544 #define SC_OP_BT_PRIORITY_DETECTED BIT(12)
545 #define SC_OP_BT_SCAN BIT(13)
546 #define SC_OP_ANI_RUN BIT(14)
548 /* Powersave flags */
549 #define PS_WAIT_FOR_BEACON BIT(0)
550 #define PS_WAIT_FOR_CAB BIT(1)
551 #define PS_WAIT_FOR_PSPOLL_DATA BIT(2)
552 #define PS_WAIT_FOR_TX_ACK BIT(3)
553 #define PS_BEACON_SYNC BIT(4)
556 struct ath_rate_table;
559 struct ieee80211_hw *hw;
562 spinlock_t wiphy_lock; /* spinlock to protect ath_wiphy data */
563 struct ath_wiphy *pri_wiphy;
564 struct ath_wiphy **sec_wiphy; /* secondary wiphys (virtual radios); may
565 * have NULL entries */
566 int num_sec_wiphy; /* number of sec_wiphy pointers in the array */
569 struct ath_wiphy *next_wiphy;
570 struct work_struct chan_work;
571 int wiphy_select_failures;
572 unsigned long wiphy_select_first_fail;
573 struct delayed_work wiphy_work;
574 unsigned long wiphy_scheduler_int;
575 int wiphy_scheduler_index;
576 struct survey_info *cur_survey;
577 struct survey_info survey[ATH9K_NUM_CHANNELS];
579 struct tasklet_struct intr_tq;
580 struct tasklet_struct bcon_tasklet;
581 struct ath_hw *sc_ah;
584 spinlock_t sc_serial_rw;
585 spinlock_t sc_pm_lock;
586 spinlock_t sc_pcu_lock;
588 struct work_struct paprd_work;
589 struct work_struct hw_check_work;
590 struct completion paprd_complete;
594 u32 sc_flags; /* SC_OP_* */
595 u16 ps_flags; /* PS_* */
601 unsigned long ps_usecount;
603 struct ath_config config;
606 struct ath_beacon beacon;
607 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
609 struct ath_led radio_led;
610 struct ath_led assoc_led;
611 struct ath_led tx_led;
612 struct ath_led rx_led;
613 struct delayed_work ath_led_blink_work;
615 int led_off_duration;
621 #ifdef CONFIG_ATH9K_DEBUGFS
622 struct ath9k_debug debug;
624 struct ath_beacon_config cur_beacon_conf;
625 struct delayed_work tx_complete_work;
626 struct ath_btcoex btcoex;
628 struct ath_descdma txsdma;
630 struct ath_ant_comb ant_comb;
634 struct ath_softc *sc; /* shared for all virtual wiphys */
635 struct ieee80211_hw *hw;
636 struct ath9k_hw_cal_data caldata;
637 enum ath_wiphy_state {
650 void ath9k_tasklet(unsigned long data);
651 int ath_reset(struct ath_softc *sc, bool retry_tx);
652 int ath_cabq_update(struct ath_softc *);
654 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
656 common->bus_ops->read_cachesize(common, csz);
659 extern struct ieee80211_ops ath9k_ops;
660 extern struct pm_qos_request_list ath9k_pm_qos_req;
661 extern int modparam_nohwcrypt;
662 extern int led_blink;
664 irqreturn_t ath_isr(int irq, void *dev);
665 int ath9k_init_device(u16 devid, struct ath_softc *sc, u16 subsysid,
666 const struct ath_bus_ops *bus_ops);
667 void ath9k_deinit_device(struct ath_softc *sc);
668 void ath9k_set_hw_capab(struct ath_softc *sc, struct ieee80211_hw *hw);
669 void ath9k_update_ichannel(struct ath_softc *sc, struct ieee80211_hw *hw,
670 struct ath9k_channel *ichan);
671 void ath_update_chainmask(struct ath_softc *sc, int is_ht);
672 int ath_set_channel(struct ath_softc *sc, struct ieee80211_hw *hw,
673 struct ath9k_channel *hchan);
675 void ath_radio_enable(struct ath_softc *sc, struct ieee80211_hw *hw);
676 void ath_radio_disable(struct ath_softc *sc, struct ieee80211_hw *hw);
677 bool ath9k_setpower(struct ath_softc *sc, enum ath9k_power_mode mode);
680 int ath_pci_init(void);
681 void ath_pci_exit(void);
683 static inline int ath_pci_init(void) { return 0; };
684 static inline void ath_pci_exit(void) {};
687 #ifdef CONFIG_ATHEROS_AR71XX
688 int ath_ahb_init(void);
689 void ath_ahb_exit(void);
691 static inline int ath_ahb_init(void) { return 0; };
692 static inline void ath_ahb_exit(void) {};
695 void ath9k_ps_wakeup(struct ath_softc *sc);
696 void ath9k_ps_restore(struct ath_softc *sc);
698 void ath9k_set_bssid_mask(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
699 int ath9k_wiphy_add(struct ath_softc *sc);
700 int ath9k_wiphy_del(struct ath_wiphy *aphy);
701 void ath9k_tx_status(struct ieee80211_hw *hw, struct sk_buff *skb, int ftype);
702 int ath9k_wiphy_pause(struct ath_wiphy *aphy);
703 int ath9k_wiphy_unpause(struct ath_wiphy *aphy);
704 int ath9k_wiphy_select(struct ath_wiphy *aphy);
705 void ath9k_wiphy_set_scheduler(struct ath_softc *sc, unsigned int msec_int);
706 void ath9k_wiphy_chan_work(struct work_struct *work);
707 bool ath9k_wiphy_started(struct ath_softc *sc);
708 void ath9k_wiphy_pause_all_forced(struct ath_softc *sc,
709 struct ath_wiphy *selected);
710 bool ath9k_wiphy_scanning(struct ath_softc *sc);
711 void ath9k_wiphy_work(struct work_struct *work);
712 bool ath9k_all_wiphys_idle(struct ath_softc *sc);
713 void ath9k_set_wiphy_idle(struct ath_wiphy *aphy, bool idle);
715 void ath_mac80211_stop_queue(struct ath_softc *sc, u16 skb_queue);
716 bool ath_mac80211_start_queue(struct ath_softc *sc, u16 skb_queue);
718 void ath_start_rfkill_poll(struct ath_softc *sc);
719 extern void ath9k_rfkill_poll_state(struct ieee80211_hw *hw);