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>
28 * Header for the ath9k.ko driver core *only* -- hw code nor any other driver
29 * should rely on this file or its contents.
34 /* Macro to expand scalars to 64-bit objects */
36 #define ito64(x) (sizeof(x) == 1) ? \
37 (((unsigned long long int)(x)) & (0xff)) : \
39 (((unsigned long long int)(x)) & 0xffff) : \
41 (((unsigned long long int)(x)) & 0xffffffff) : \
42 (unsigned long long int)(x))
44 /* increment with wrap-around */
45 #define INCR(_l, _sz) do { \
47 (_l) &= ((_sz) - 1); \
50 /* decrement with wrap-around */
51 #define DECR(_l, _sz) do { \
53 (_l) &= ((_sz) - 1); \
56 #define A_MAX(a, b) ((a) > (b) ? (a) : (b))
58 #define TSF_TO_TU(_h,_l) \
59 ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
61 #define ATH_TXQ_SETUP(sc, i) ((sc)->tx.txqsetup & (1<<i))
69 /*************************/
70 /* Descriptor Management */
71 /*************************/
73 #define ATH_TXBUF_RESET(_bf) do { \
74 (_bf)->bf_stale = false; \
75 (_bf)->bf_lastbf = NULL; \
76 (_bf)->bf_next = NULL; \
77 memset(&((_bf)->bf_state), 0, \
78 sizeof(struct ath_buf_state)); \
81 #define ATH_RXBUF_RESET(_bf) do { \
82 (_bf)->bf_stale = false; \
86 * enum buffer_type - Buffer type flags
88 * @BUF_HT: Send this buffer using HT capabilities
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_RETRY: Indicates whether the buffer is retried
93 * @BUF_XRETRY: To denote excessive retries of the buffer
103 #define bf_nframes bf_state.bfs_nframes
104 #define bf_al bf_state.bfs_al
105 #define bf_frmlen bf_state.bfs_frmlen
106 #define bf_retries bf_state.bfs_retries
107 #define bf_seqno bf_state.bfs_seqno
108 #define bf_tidno bf_state.bfs_tidno
109 #define bf_keyix bf_state.bfs_keyix
110 #define bf_keytype bf_state.bfs_keytype
111 #define bf_isht(bf) (bf->bf_state.bf_type & BUF_HT)
112 #define bf_isampdu(bf) (bf->bf_state.bf_type & BUF_AMPDU)
113 #define bf_isaggr(bf) (bf->bf_state.bf_type & BUF_AGGR)
114 #define bf_isretried(bf) (bf->bf_state.bf_type & BUF_RETRY)
115 #define bf_isxretried(bf) (bf->bf_state.bf_type & BUF_XRETRY)
117 #define ATH_TXSTATUS_RING_SIZE 64
121 dma_addr_t dd_desc_paddr;
123 struct ath_buf *dd_bufptr;
126 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
127 struct list_head *head, const char *name,
128 int nbuf, int ndesc, bool is_tx);
129 void ath_descdma_cleanup(struct ath_softc *sc, struct ath_descdma *dd,
130 struct list_head *head);
136 #define ATH_MAX_ANTENNA 3
137 #define ATH_RXBUF 512
138 #define ATH_TXBUF 512
139 #define ATH_TXBUF_RESERVE 5
140 #define ATH_MAX_QDEPTH (ATH_TXBUF / 4 - ATH_TXBUF_RESERVE)
141 #define ATH_TXMAXTRY 13
142 #define ATH_MGT_TXMAXTRY 4
144 #define TID_TO_WME_AC(_tid) \
145 ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
146 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
147 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
150 #define ADDBA_EXCHANGE_ATTEMPTS 10
151 #define ATH_AGGR_DELIM_SZ 4
152 #define ATH_AGGR_MINPLEN 256 /* in bytes, minimum packet length */
153 /* number of delimiters for encryption padding */
154 #define ATH_AGGR_ENCRYPTDELIM 10
155 /* minimum h/w qdepth to be sustained to maximize aggregation */
156 #define ATH_AGGR_MIN_QDEPTH 2
157 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
159 #define IEEE80211_SEQ_SEQ_SHIFT 4
160 #define IEEE80211_SEQ_MAX 4096
161 #define IEEE80211_WEP_IVLEN 3
162 #define IEEE80211_WEP_KIDLEN 1
163 #define IEEE80211_WEP_CRCLEN 4
164 #define IEEE80211_MAX_MPDU_LEN (3840 + FCS_LEN + \
165 (IEEE80211_WEP_IVLEN + \
166 IEEE80211_WEP_KIDLEN + \
167 IEEE80211_WEP_CRCLEN))
169 /* return whether a bit at index _n in bitmap _bm is set
170 * _sz is the size of the bitmap */
171 #define ATH_BA_ISSET(_bm, _n) (((_n) < (WME_BA_BMP_SIZE)) && \
172 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
174 /* return block-ack bitmap index given sequence and starting sequence */
175 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
177 /* returns delimiter padding required given the packet length */
178 #define ATH_AGGR_GET_NDELIM(_len) \
179 (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ? \
180 (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
182 #define BAW_WITHIN(_start, _bawsz, _seqno) \
183 ((((_seqno) - (_start)) & 4095) < (_bawsz))
185 #define ATH_AN_2_TID(_an, _tidno) (&(_an)->tid[(_tidno)])
187 #define ATH_TX_COMPLETE_POLL_INT 1000
189 enum ATH_AGGR_STATUS {
195 #define ATH_TXFIFO_DEPTH 8
199 struct list_head axq_q;
203 bool axq_tx_inprogress;
204 struct list_head axq_acq;
205 struct list_head txq_fifo[ATH_TXFIFO_DEPTH];
206 struct list_head txq_fifo_pending;
215 struct list_head list;
216 struct list_head tid_q;
219 struct ath_buf_state {
228 enum ath9k_key_type bfs_keytype;
232 struct list_head list;
233 struct ath_buf *bf_lastbf; /* last buf of this unit (a frame or
235 struct ath_buf *bf_next; /* next subframe in the aggregate */
236 struct sk_buff *bf_mpdu; /* enclosing frame structure */
237 void *bf_desc; /* virtual addr of desc */
238 dma_addr_t bf_daddr; /* physical addr of desc */
239 dma_addr_t bf_buf_addr; /* physical addr of data buffer */
244 struct ath_buf_state bf_state;
245 dma_addr_t bf_dmacontext;
246 struct ath_wiphy *aphy;
251 struct list_head list;
252 struct list_head buf_q;
254 struct ath_atx_ac *ac;
255 struct ath_buf *tx_buf[ATH_TID_MAX_BUFS];
260 int baw_head; /* first un-acked tx buffer */
261 int baw_tail; /* next unused tx buffer slot */
268 struct ath_common *common;
269 struct ath_atx_tid tid[WME_NUM_TID];
270 struct ath_atx_ac ac[WME_NUM_AC];
276 #define AGGR_CLEANUP BIT(1)
277 #define AGGR_ADDBA_COMPLETE BIT(2)
278 #define AGGR_ADDBA_PROGRESS BIT(3)
280 struct ath_tx_control {
283 enum ath9k_internal_frame_type frame_type;
286 #define ATH_TX_ERROR 0x01
287 #define ATH_TX_XRETRY 0x02
288 #define ATH_TX_BAR 0x04
293 int hwq_map[ATH9K_WME_AC_VO+1];
294 spinlock_t txbuflock;
295 struct list_head txbuf;
296 struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
297 struct ath_descdma txdma;
301 struct sk_buff_head rx_fifo;
302 struct sk_buff_head rx_buffers;
310 unsigned int rxfilter;
311 spinlock_t rxflushlock;
312 spinlock_t rxbuflock;
313 struct list_head rxbuf;
314 struct ath_descdma rxdma;
315 struct ath_buf *rx_bufptr;
316 struct ath_rx_edma rx_edma[ATH9K_RX_QUEUE_MAX];
319 int ath_startrecv(struct ath_softc *sc);
320 bool ath_stoprecv(struct ath_softc *sc);
321 void ath_flushrecv(struct ath_softc *sc);
322 u32 ath_calcrxfilter(struct ath_softc *sc);
323 int ath_rx_init(struct ath_softc *sc, int nbufs);
324 void ath_rx_cleanup(struct ath_softc *sc);
325 int ath_rx_tasklet(struct ath_softc *sc, int flush, bool hp);
326 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
327 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
328 int ath_tx_setup(struct ath_softc *sc, int haltype);
329 void ath_drain_all_txq(struct ath_softc *sc, bool retry_tx);
330 void ath_draintxq(struct ath_softc *sc,
331 struct ath_txq *txq, bool retry_tx);
332 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
333 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
334 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
335 int ath_tx_init(struct ath_softc *sc, int nbufs);
336 void ath_tx_cleanup(struct ath_softc *sc);
337 int ath_txq_update(struct ath_softc *sc, int qnum,
338 struct ath9k_tx_queue_info *q);
339 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
340 struct ath_tx_control *txctl);
341 void ath_tx_tasklet(struct ath_softc *sc);
342 void ath_tx_edma_tasklet(struct ath_softc *sc);
343 void ath_tx_cabq(struct ieee80211_hw *hw, struct sk_buff *skb);
344 bool ath_tx_aggr_check(struct ath_softc *sc, struct ath_node *an, u8 tidno);
345 void ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
347 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
348 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
349 void ath9k_enable_ps(struct ath_softc *sc);
357 __le64 tsf_adjust; /* TSF adjustment for staggered beacons */
358 enum nl80211_iftype av_opmode;
359 struct ath_buf *av_bcbuf;
360 struct ath_tx_control av_btxctl;
361 u8 bssid[ETH_ALEN]; /* current BSSID from config_interface */
364 /*******************/
365 /* Beacon Handling */
366 /*******************/
369 * Regardless of the number of beacons we stagger, (i.e. regardless of the
370 * number of BSSIDs) if a given beacon does not go out even after waiting this
371 * number of beacon intervals, the game's up.
373 #define BSTUCK_THRESH (9 * ATH_BCBUF)
375 #define ATH_DEFAULT_BINTVAL 100 /* TU */
376 #define ATH_DEFAULT_BMISS_LIMIT 10
377 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
379 struct ath_beacon_config {
389 OK, /* no change needed */
390 UPDATE, /* update pending */
391 COMMIT /* beacon sent, commit change */
392 } updateslot; /* slot time update fsm */
398 struct ieee80211_vif *bslot[ATH_BCBUF];
399 struct ath_wiphy *bslot_aphy[ATH_BCBUF];
402 struct ath9k_tx_queue_info beacon_qi;
403 struct ath_descdma bdma;
404 struct ath_txq *cabq;
405 struct list_head bbuf;
408 void ath_beacon_tasklet(unsigned long data);
409 void ath_beacon_config(struct ath_softc *sc, struct ieee80211_vif *vif);
410 int ath_beacon_alloc(struct ath_wiphy *aphy, struct ieee80211_vif *vif);
411 void ath_beacon_return(struct ath_softc *sc, struct ath_vif *avp);
412 int ath_beaconq_config(struct ath_softc *sc);
418 #define ATH_STA_SHORT_CALINTERVAL 1000 /* 1 second */
419 #define ATH_AP_SHORT_CALINTERVAL 100 /* 100 ms */
420 #define ATH_ANI_POLLINTERVAL 100 /* 100 ms */
421 #define ATH_LONG_CALINTERVAL 30000 /* 30 seconds */
422 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes */
424 void ath_ani_calibrate(unsigned long data);
430 /* Defines the BT AR_BT_COEX_WGHT used */
431 enum ath_stomp_type {
433 ATH_BTCOEX_STOMP_ALL,
434 ATH_BTCOEX_STOMP_LOW,
435 ATH_BTCOEX_STOMP_NONE
439 bool hw_timer_enabled;
440 spinlock_t btcoex_lock;
441 struct timer_list period_timer; /* Timer for BT period */
443 unsigned long bt_priority_time;
444 int bt_stomp_type; /* Types of BT stomping */
445 u32 btcoex_no_stomp; /* in usec */
446 u32 btcoex_period; /* in usec */
447 u32 btscan_no_stomp; /* in usec */
448 struct ath_gen_timer *no_stomp_timer; /* Timer for no BT stomping */
451 int ath_init_btcoex_timer(struct ath_softc *sc);
452 void ath9k_btcoex_timer_resume(struct ath_softc *sc);
453 void ath9k_btcoex_timer_pause(struct ath_softc *sc);
455 /********************/
457 /********************/
459 #define ATH_LED_PIN_DEF 1
460 #define ATH_LED_PIN_9287 8
461 #define ATH_LED_ON_DURATION_IDLE 350 /* in msecs */
462 #define ATH_LED_OFF_DURATION_IDLE 250 /* in msecs */
472 struct ath_softc *sc;
473 struct led_classdev led_cdev;
474 enum ath_led_type led_type;
479 void ath_init_leds(struct ath_softc *sc);
480 void ath_deinit_leds(struct ath_softc *sc);
482 /********************/
483 /* Main driver core */
484 /********************/
487 * Default cache line size, in bytes.
488 * Used when PCI device not fully initialized by bootrom/BIOS
490 #define DEFAULT_CACHELINE 32
491 #define ATH_REGCLASSIDS_MAX 10
492 #define ATH_CABQ_READY_TIME 80 /* % of beacon interval */
493 #define ATH_MAX_SW_RETRIES 10
494 #define ATH_CHAN_MAX 255
495 #define IEEE80211_WEP_NKID 4 /* number of key ids */
497 #define ATH_TXPOWER_MAX 100 /* .5 dBm units */
498 #define ATH_RATE_DUMMY_MARKER 0
500 #define SC_OP_INVALID BIT(0)
501 #define SC_OP_BEACONS BIT(1)
502 #define SC_OP_RXAGGR BIT(2)
503 #define SC_OP_TXAGGR BIT(3)
504 #define SC_OP_FULL_RESET BIT(4)
505 #define SC_OP_PREAMBLE_SHORT BIT(5)
506 #define SC_OP_PROTECT_ENABLE BIT(6)
507 #define SC_OP_RXFLUSH BIT(7)
508 #define SC_OP_LED_ASSOCIATED BIT(8)
509 #define SC_OP_LED_ON BIT(9)
510 #define SC_OP_SCANNING BIT(10)
511 #define SC_OP_TSF_RESET BIT(11)
512 #define SC_OP_BT_PRIORITY_DETECTED BIT(12)
513 #define SC_OP_BT_SCAN BIT(13)
515 /* Powersave flags */
516 #define PS_WAIT_FOR_BEACON BIT(0)
517 #define PS_WAIT_FOR_CAB BIT(1)
518 #define PS_WAIT_FOR_PSPOLL_DATA BIT(2)
519 #define PS_WAIT_FOR_TX_ACK BIT(3)
520 #define PS_BEACON_SYNC BIT(4)
521 #define PS_NULLFUNC_COMPLETED BIT(5)
522 #define PS_ENABLED BIT(6)
525 struct ath_rate_table;
528 struct ieee80211_hw *hw;
531 spinlock_t wiphy_lock; /* spinlock to protect ath_wiphy data */
532 struct ath_wiphy *pri_wiphy;
533 struct ath_wiphy **sec_wiphy; /* secondary wiphys (virtual radios); may
534 * have NULL entries */
535 int num_sec_wiphy; /* number of sec_wiphy pointers in the array */
538 struct ath_wiphy *next_wiphy;
539 struct work_struct chan_work;
540 int wiphy_select_failures;
541 unsigned long wiphy_select_first_fail;
542 struct delayed_work wiphy_work;
543 unsigned long wiphy_scheduler_int;
544 int wiphy_scheduler_index;
546 struct tasklet_struct intr_tq;
547 struct tasklet_struct bcon_tasklet;
548 struct ath_hw *sc_ah;
551 spinlock_t sc_resetlock;
552 spinlock_t sc_serial_rw;
553 spinlock_t sc_pm_lock;
557 u32 sc_flags; /* SC_OP_* */
558 u16 ps_flags; /* PS_* */
564 unsigned long ps_usecount;
566 struct ath_config config;
569 struct ath_beacon beacon;
570 const struct ath_rate_table *cur_rate_table;
571 enum wireless_mode cur_rate_mode;
572 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
574 struct ath_led radio_led;
575 struct ath_led assoc_led;
576 struct ath_led tx_led;
577 struct ath_led rx_led;
578 struct delayed_work ath_led_blink_work;
580 int led_off_duration;
586 #ifdef CONFIG_ATH9K_DEBUGFS
587 struct ath9k_debug debug;
589 struct ath_beacon_config cur_beacon_conf;
590 struct delayed_work tx_complete_work;
591 struct ath_btcoex btcoex;
593 struct ath_descdma txsdma;
597 struct ath_softc *sc; /* shared for all virtual wiphys */
598 struct ieee80211_hw *hw;
599 enum ath_wiphy_state {
611 void ath9k_tasklet(unsigned long data);
612 int ath_reset(struct ath_softc *sc, bool retry_tx);
613 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
614 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
615 int ath_cabq_update(struct ath_softc *);
617 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
619 common->bus_ops->read_cachesize(common, csz);
622 extern struct ieee80211_ops ath9k_ops;
623 extern int modparam_nohwcrypt;
625 irqreturn_t ath_isr(int irq, void *dev);
626 int ath9k_init_device(u16 devid, struct ath_softc *sc, u16 subsysid,
627 const struct ath_bus_ops *bus_ops);
628 void ath9k_deinit_device(struct ath_softc *sc);
629 const char *ath_mac_bb_name(u32 mac_bb_version);
630 const char *ath_rf_name(u16 rf_version);
631 void ath9k_set_hw_capab(struct ath_softc *sc, struct ieee80211_hw *hw);
632 void ath9k_update_ichannel(struct ath_softc *sc, struct ieee80211_hw *hw,
633 struct ath9k_channel *ichan);
634 void ath_update_chainmask(struct ath_softc *sc, int is_ht);
635 int ath_set_channel(struct ath_softc *sc, struct ieee80211_hw *hw,
636 struct ath9k_channel *hchan);
638 void ath_radio_enable(struct ath_softc *sc, struct ieee80211_hw *hw);
639 void ath_radio_disable(struct ath_softc *sc, struct ieee80211_hw *hw);
640 bool ath9k_setpower(struct ath_softc *sc, enum ath9k_power_mode mode);
643 int ath_pci_init(void);
644 void ath_pci_exit(void);
646 static inline int ath_pci_init(void) { return 0; };
647 static inline void ath_pci_exit(void) {};
650 #ifdef CONFIG_ATHEROS_AR71XX
651 int ath_ahb_init(void);
652 void ath_ahb_exit(void);
654 static inline int ath_ahb_init(void) { return 0; };
655 static inline void ath_ahb_exit(void) {};
658 void ath9k_ps_wakeup(struct ath_softc *sc);
659 void ath9k_ps_restore(struct ath_softc *sc);
661 void ath9k_set_bssid_mask(struct ieee80211_hw *hw);
662 int ath9k_wiphy_add(struct ath_softc *sc);
663 int ath9k_wiphy_del(struct ath_wiphy *aphy);
664 void ath9k_tx_status(struct ieee80211_hw *hw, struct sk_buff *skb);
665 int ath9k_wiphy_pause(struct ath_wiphy *aphy);
666 int ath9k_wiphy_unpause(struct ath_wiphy *aphy);
667 int ath9k_wiphy_select(struct ath_wiphy *aphy);
668 void ath9k_wiphy_set_scheduler(struct ath_softc *sc, unsigned int msec_int);
669 void ath9k_wiphy_chan_work(struct work_struct *work);
670 bool ath9k_wiphy_started(struct ath_softc *sc);
671 void ath9k_wiphy_pause_all_forced(struct ath_softc *sc,
672 struct ath_wiphy *selected);
673 bool ath9k_wiphy_scanning(struct ath_softc *sc);
674 void ath9k_wiphy_work(struct work_struct *work);
675 bool ath9k_all_wiphys_idle(struct ath_softc *sc);
676 void ath9k_set_wiphy_idle(struct ath_wiphy *aphy, bool idle);
678 void ath_mac80211_stop_queue(struct ath_softc *sc, u16 skb_queue);
679 void ath_mac80211_start_queue(struct ath_softc *sc, u16 skb_queue);
681 int ath_tx_get_qnum(struct ath_softc *sc, int qtype, int haltype);
683 void ath_start_rfkill_poll(struct ath_softc *sc);
684 extern void ath9k_rfkill_poll_state(struct ieee80211_hw *hw);