2 * Copyright (c) 2008-2011 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/interrupt.h>
23 #include <linux/leds.h>
24 #include <linux/completion.h>
30 * Header for the ath9k.ko driver core *only* -- hw code nor any other driver
31 * should rely on this file or its contents.
36 /* Macro to expand scalars to 64-bit objects */
38 #define ito64(x) (sizeof(x) == 1) ? \
39 (((unsigned long long int)(x)) & (0xff)) : \
41 (((unsigned long long int)(x)) & 0xffff) : \
43 (((unsigned long long int)(x)) & 0xffffffff) : \
44 (unsigned long long int)(x))
46 /* increment with wrap-around */
47 #define INCR(_l, _sz) do { \
49 (_l) &= ((_sz) - 1); \
52 /* decrement with wrap-around */
53 #define DECR(_l, _sz) do { \
55 (_l) &= ((_sz) - 1); \
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))
68 /*************************/
69 /* Descriptor Management */
70 /*************************/
72 #define ATH_TXBUF_RESET(_bf) do { \
73 (_bf)->bf_stale = false; \
74 (_bf)->bf_lastbf = NULL; \
75 (_bf)->bf_next = NULL; \
76 memset(&((_bf)->bf_state), 0, \
77 sizeof(struct ath_buf_state)); \
80 #define ATH_RXBUF_RESET(_bf) do { \
81 (_bf)->bf_stale = false; \
85 * enum buffer_type - Buffer type flags
87 * @BUF_AMPDU: This buffer is an ampdu, as part of an aggregate (during TX)
88 * @BUF_AGGR: Indicates whether the buffer can be aggregated
89 * (used in aggregation scheduling)
96 #define bf_isampdu(bf) (bf->bf_state.bf_type & BUF_AMPDU)
97 #define bf_isaggr(bf) (bf->bf_state.bf_type & BUF_AGGR)
99 #define ATH_TXSTATUS_RING_SIZE 64
101 #define DS2PHYS(_dd, _ds) \
102 ((_dd)->dd_desc_paddr + ((caddr_t)(_ds) - (caddr_t)(_dd)->dd_desc))
103 #define ATH_DESC_4KB_BOUND_CHECK(_daddr) ((((_daddr) & 0xFFF) > 0xF7F) ? 1 : 0)
104 #define ATH_DESC_4KB_BOUND_NUM_SKIPPED(_len) ((_len) / 4096)
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_RXBUF 512
124 #define ATH_TXBUF 512
125 #define ATH_TXBUF_RESERVE 5
126 #define ATH_MAX_QDEPTH (ATH_TXBUF / 4 - ATH_TXBUF_RESERVE)
127 #define ATH_TXMAXTRY 13
129 #define TID_TO_WME_AC(_tid) \
130 ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
131 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
132 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
135 #define ATH_AGGR_DELIM_SZ 4
136 #define ATH_AGGR_MINPLEN 256 /* in bytes, minimum packet length */
137 /* number of delimiters for encryption padding */
138 #define ATH_AGGR_ENCRYPTDELIM 10
139 /* minimum h/w qdepth to be sustained to maximize aggregation */
140 #define ATH_AGGR_MIN_QDEPTH 2
141 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
143 #define IEEE80211_SEQ_SEQ_SHIFT 4
144 #define IEEE80211_SEQ_MAX 4096
145 #define IEEE80211_WEP_IVLEN 3
146 #define IEEE80211_WEP_KIDLEN 1
147 #define IEEE80211_WEP_CRCLEN 4
148 #define IEEE80211_MAX_MPDU_LEN (3840 + FCS_LEN + \
149 (IEEE80211_WEP_IVLEN + \
150 IEEE80211_WEP_KIDLEN + \
151 IEEE80211_WEP_CRCLEN))
153 /* return whether a bit at index _n in bitmap _bm is set
154 * _sz is the size of the bitmap */
155 #define ATH_BA_ISSET(_bm, _n) (((_n) < (WME_BA_BMP_SIZE)) && \
156 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
158 /* return block-ack bitmap index given sequence and starting sequence */
159 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
161 /* returns delimiter padding required given the packet length */
162 #define ATH_AGGR_GET_NDELIM(_len) \
163 (((_len) >= ATH_AGGR_MINPLEN) ? 0 : \
164 DIV_ROUND_UP(ATH_AGGR_MINPLEN - (_len), ATH_AGGR_DELIM_SZ))
166 #define BAW_WITHIN(_start, _bawsz, _seqno) \
167 ((((_seqno) - (_start)) & 4095) < (_bawsz))
169 #define ATH_AN_2_TID(_an, _tidno) (&(_an)->tid[(_tidno)])
171 #define ATH_TX_COMPLETE_POLL_INT 1000
173 enum ATH_AGGR_STATUS
{
179 #define ATH_TXFIFO_DEPTH 8
181 int mac80211_qnum
; /* mac80211 queue number, -1 means not mac80211 Q */
182 u32 axq_qnum
; /* ath9k hardware queue number */
184 struct list_head axq_q
;
189 bool axq_tx_inprogress
;
190 struct list_head axq_acq
;
191 struct list_head txq_fifo
[ATH_TXFIFO_DEPTH
];
200 struct list_head list
;
201 struct list_head tid_q
;
202 bool clear_ps_filter
;
205 struct ath_frame_info
{
208 enum ath9k_key_type keytype
;
213 struct ath_buf_state
{
218 unsigned long bfs_paprd_timestamp
;
222 struct list_head list
;
223 struct ath_buf
*bf_lastbf
; /* last buf of this unit (a frame or
225 struct ath_buf
*bf_next
; /* next subframe in the aggregate */
226 struct sk_buff
*bf_mpdu
; /* enclosing frame structure */
227 void *bf_desc
; /* virtual addr of desc */
228 dma_addr_t bf_daddr
; /* physical addr of desc */
229 dma_addr_t bf_buf_addr
; /* physical addr of data buffer, for DMA */
231 struct ath_buf_state bf_state
;
235 struct list_head list
;
236 struct sk_buff_head buf_q
;
238 struct ath_atx_ac
*ac
;
239 unsigned long tx_buf
[BITS_TO_LONGS(ATH_TID_MAX_BUFS
)];
244 int baw_head
; /* first un-acked tx buffer */
245 int baw_tail
; /* next unused tx buffer slot */
252 #ifdef CONFIG_ATH9K_DEBUGFS
253 struct list_head list
; /* for sc->nodes */
254 struct ieee80211_sta
*sta
; /* station struct we're part of */
256 struct ath_atx_tid tid
[WME_NUM_TID
];
257 struct ath_atx_ac ac
[WME_NUM_AC
];
266 #define AGGR_CLEANUP BIT(1)
267 #define AGGR_ADDBA_COMPLETE BIT(2)
268 #define AGGR_ADDBA_PROGRESS BIT(3)
270 struct ath_tx_control
{
276 #define ATH_TX_ERROR 0x01
277 #define ATH_TX_BAR 0x02
280 * @txq_map: Index is mac80211 queue number. This is
281 * not necessarily the same as the hardware queue number
287 spinlock_t txbuflock
;
288 struct list_head txbuf
;
289 struct ath_txq txq
[ATH9K_NUM_TX_QUEUES
];
290 struct ath_descdma txdma
;
291 struct ath_txq
*txq_map
[WME_NUM_AC
];
295 struct sk_buff_head rx_fifo
;
296 struct sk_buff_head rx_buffers
;
304 unsigned int rxfilter
;
305 spinlock_t rxbuflock
;
306 struct list_head rxbuf
;
307 struct ath_descdma rxdma
;
308 struct ath_buf
*rx_bufptr
;
309 struct ath_rx_edma rx_edma
[ATH9K_RX_QUEUE_MAX
];
311 struct sk_buff
*frag
;
314 int ath_startrecv(struct ath_softc
*sc
);
315 bool ath_stoprecv(struct ath_softc
*sc
);
316 void ath_flushrecv(struct ath_softc
*sc
);
317 u32
ath_calcrxfilter(struct ath_softc
*sc
);
318 int ath_rx_init(struct ath_softc
*sc
, int nbufs
);
319 void ath_rx_cleanup(struct ath_softc
*sc
);
320 int ath_rx_tasklet(struct ath_softc
*sc
, int flush
, bool hp
);
321 struct ath_txq
*ath_txq_setup(struct ath_softc
*sc
, int qtype
, int subtype
);
322 void ath_tx_cleanupq(struct ath_softc
*sc
, struct ath_txq
*txq
);
323 bool ath_drain_all_txq(struct ath_softc
*sc
, bool retry_tx
);
324 void ath_draintxq(struct ath_softc
*sc
,
325 struct ath_txq
*txq
, bool retry_tx
);
326 void ath_tx_node_init(struct ath_softc
*sc
, struct ath_node
*an
);
327 void ath_tx_node_cleanup(struct ath_softc
*sc
, struct ath_node
*an
);
328 void ath_txq_schedule(struct ath_softc
*sc
, struct ath_txq
*txq
);
329 int ath_tx_init(struct ath_softc
*sc
, int nbufs
);
330 void ath_tx_cleanup(struct ath_softc
*sc
);
331 int ath_txq_update(struct ath_softc
*sc
, int qnum
,
332 struct ath9k_tx_queue_info
*q
);
333 int ath_tx_start(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
334 struct ath_tx_control
*txctl
);
335 void ath_tx_tasklet(struct ath_softc
*sc
);
336 void ath_tx_edma_tasklet(struct ath_softc
*sc
);
337 int ath_tx_aggr_start(struct ath_softc
*sc
, struct ieee80211_sta
*sta
,
339 void ath_tx_aggr_stop(struct ath_softc
*sc
, struct ieee80211_sta
*sta
, u16 tid
);
340 void ath_tx_aggr_resume(struct ath_softc
*sc
, struct ieee80211_sta
*sta
, u16 tid
);
342 void ath_tx_aggr_wakeup(struct ath_softc
*sc
, struct ath_node
*an
);
343 void ath_tx_aggr_sleep(struct ieee80211_sta
*sta
, struct ath_softc
*sc
,
344 struct ath_node
*an
);
352 bool is_bslot_active
, primary_sta_vif
;
353 __le64 tsf_adjust
; /* TSF adjustment for staggered beacons */
354 struct ath_buf
*av_bcbuf
;
357 /*******************/
358 /* Beacon Handling */
359 /*******************/
362 * Regardless of the number of beacons we stagger, (i.e. regardless of the
363 * number of BSSIDs) if a given beacon does not go out even after waiting this
364 * number of beacon intervals, the game's up.
366 #define BSTUCK_THRESH 9
368 #define ATH_DEFAULT_BINTVAL 100 /* TU */
369 #define ATH_DEFAULT_BMISS_LIMIT 10
370 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
372 struct ath_beacon_config
{
382 OK
, /* no change needed */
383 UPDATE
, /* update pending */
384 COMMIT
/* beacon sent, commit change */
385 } updateslot
; /* slot time update fsm */
391 struct ieee80211_vif
*bslot
[ATH_BCBUF
];
394 struct ath9k_tx_queue_info beacon_qi
;
395 struct ath_descdma bdma
;
396 struct ath_txq
*cabq
;
397 struct list_head bbuf
;
403 void ath_beacon_tasklet(unsigned long data
);
404 void ath_beacon_config(struct ath_softc
*sc
, struct ieee80211_vif
*vif
);
405 int ath_beacon_alloc(struct ath_softc
*sc
, struct ieee80211_vif
*vif
);
406 void ath_beacon_return(struct ath_softc
*sc
, struct ath_vif
*avp
);
407 int ath_beaconq_config(struct ath_softc
*sc
);
408 void ath_set_beacon(struct ath_softc
*sc
);
409 void ath9k_set_beaconing_status(struct ath_softc
*sc
, bool status
);
415 #define ATH_STA_SHORT_CALINTERVAL 1000 /* 1 second */
416 #define ATH_AP_SHORT_CALINTERVAL 100 /* 100 ms */
417 #define ATH_ANI_POLLINTERVAL_OLD 100 /* 100 ms */
418 #define ATH_ANI_POLLINTERVAL_NEW 1000 /* 1000 ms */
419 #define ATH_LONG_CALINTERVAL_INT 1000 /* 1000 ms */
420 #define ATH_LONG_CALINTERVAL 30000 /* 30 seconds */
421 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes */
423 #define ATH_PAPRD_TIMEOUT 100 /* msecs */
425 void ath_reset_work(struct work_struct
*work
);
426 void ath_hw_check(struct work_struct
*work
);
427 void ath_hw_pll_work(struct work_struct
*work
);
428 void ath_paprd_calibrate(struct work_struct
*work
);
429 void ath_ani_calibrate(unsigned long data
);
430 void ath_start_ani(struct ath_common
*common
);
437 bool hw_timer_enabled
;
438 spinlock_t btcoex_lock
;
439 struct timer_list period_timer
; /* Timer for BT period */
441 unsigned long bt_priority_time
;
442 int bt_stomp_type
; /* Types of BT stomping */
443 u32 btcoex_no_stomp
; /* in usec */
444 u32 btcoex_period
; /* in usec */
445 u32 btscan_no_stomp
; /* in usec */
446 struct ath_gen_timer
*no_stomp_timer
; /* Timer for no BT stomping */
449 int ath_init_btcoex_timer(struct ath_softc
*sc
);
450 void ath9k_btcoex_timer_resume(struct ath_softc
*sc
);
451 void ath9k_btcoex_timer_pause(struct ath_softc
*sc
);
453 /********************/
455 /********************/
457 #define ATH_LED_PIN_DEF 1
458 #define ATH_LED_PIN_9287 8
459 #define ATH_LED_PIN_9300 10
460 #define ATH_LED_PIN_9485 6
461 #define ATH_LED_PIN_9462 0
463 #ifdef CONFIG_MAC80211_LEDS
464 void ath_init_leds(struct ath_softc
*sc
);
465 void ath_deinit_leds(struct ath_softc
*sc
);
467 static inline void ath_init_leds(struct ath_softc
*sc
)
471 static inline void ath_deinit_leds(struct ath_softc
*sc
)
477 /* Antenna diversity/combining */
478 #define ATH_ANT_RX_CURRENT_SHIFT 4
479 #define ATH_ANT_RX_MAIN_SHIFT 2
480 #define ATH_ANT_RX_MASK 0x3
482 #define ATH_ANT_DIV_COMB_SHORT_SCAN_INTR 50
483 #define ATH_ANT_DIV_COMB_SHORT_SCAN_PKTCOUNT 0x100
484 #define ATH_ANT_DIV_COMB_MAX_PKTCOUNT 0x200
485 #define ATH_ANT_DIV_COMB_INIT_COUNT 95
486 #define ATH_ANT_DIV_COMB_MAX_COUNT 100
487 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO 30
488 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2 20
490 #define ATH_ANT_DIV_COMB_LNA1_LNA2_SWITCH_DELTA -1
491 #define ATH_ANT_DIV_COMB_LNA1_DELTA_HI -4
492 #define ATH_ANT_DIV_COMB_LNA1_DELTA_MID -2
493 #define ATH_ANT_DIV_COMB_LNA1_DELTA_LOW 2
495 enum ath9k_ant_div_comb_lna_conf
{
496 ATH_ANT_DIV_COMB_LNA1_MINUS_LNA2
,
497 ATH_ANT_DIV_COMB_LNA2
,
498 ATH_ANT_DIV_COMB_LNA1
,
499 ATH_ANT_DIV_COMB_LNA1_PLUS_LNA2
,
502 struct ath_ant_comb
{
521 enum ath9k_ant_div_comb_lna_conf first_quick_scan_conf
;
522 enum ath9k_ant_div_comb_lna_conf second_quick_scan_conf
;
527 unsigned long scan_start_time
;
530 /********************/
531 /* Main driver core */
532 /********************/
535 * Default cache line size, in bytes.
536 * Used when PCI device not fully initialized by bootrom/BIOS
538 #define DEFAULT_CACHELINE 32
539 #define ATH_REGCLASSIDS_MAX 10
540 #define ATH_CABQ_READY_TIME 80 /* % of beacon interval */
541 #define ATH_MAX_SW_RETRIES 10
542 #define ATH_CHAN_MAX 255
544 #define ATH_TXPOWER_MAX 100 /* .5 dBm units */
545 #define ATH_RATE_DUMMY_MARKER 0
547 #define SC_OP_INVALID BIT(0)
548 #define SC_OP_BEACONS BIT(1)
549 #define SC_OP_RXAGGR BIT(2)
550 #define SC_OP_TXAGGR BIT(3)
551 #define SC_OP_OFFCHANNEL BIT(4)
552 #define SC_OP_PREAMBLE_SHORT BIT(5)
553 #define SC_OP_PROTECT_ENABLE BIT(6)
554 #define SC_OP_RXFLUSH BIT(7)
555 #define SC_OP_LED_ASSOCIATED BIT(8)
556 #define SC_OP_LED_ON BIT(9)
557 #define SC_OP_TSF_RESET BIT(11)
558 #define SC_OP_BT_PRIORITY_DETECTED BIT(12)
559 #define SC_OP_BT_SCAN BIT(13)
560 #define SC_OP_ANI_RUN BIT(14)
561 #define SC_OP_PRIM_STA_VIF BIT(15)
563 /* Powersave flags */
564 #define PS_WAIT_FOR_BEACON BIT(0)
565 #define PS_WAIT_FOR_CAB BIT(1)
566 #define PS_WAIT_FOR_PSPOLL_DATA BIT(2)
567 #define PS_WAIT_FOR_TX_ACK BIT(3)
568 #define PS_BEACON_SYNC BIT(4)
570 struct ath_rate_table
;
572 struct ath9k_vif_iter_data
{
573 const u8
*hw_macaddr
; /* phy's hardware address, set
574 * before starting iteration for
577 u8 mask
[ETH_ALEN
]; /* bssid mask */
578 int naps
; /* number of AP vifs */
579 int nmeshes
; /* number of mesh vifs */
580 int nstations
; /* number of station vifs */
581 int nwds
; /* number of WDS vifs */
582 int nadhocs
; /* number of adhoc vifs */
583 int nothers
; /* number of vifs not specified above. */
587 struct ieee80211_hw
*hw
;
592 struct survey_info
*cur_survey
;
593 struct survey_info survey
[ATH9K_NUM_CHANNELS
];
595 struct tasklet_struct intr_tq
;
596 struct tasklet_struct bcon_tasklet
;
597 struct ath_hw
*sc_ah
;
600 spinlock_t sc_serial_rw
;
601 spinlock_t sc_pm_lock
;
602 spinlock_t sc_pcu_lock
;
604 struct work_struct paprd_work
;
605 struct work_struct hw_check_work
;
606 struct work_struct hw_reset_work
;
607 struct completion paprd_complete
;
609 unsigned int hw_busy_count
;
612 u32 sc_flags
; /* SC_OP_* */
613 u16 ps_flags
; /* PS_* */
619 unsigned long ps_usecount
;
621 struct ath_config config
;
624 struct ath_beacon beacon
;
625 struct ieee80211_supported_band sbands
[IEEE80211_NUM_BANDS
];
627 #ifdef CONFIG_MAC80211_LEDS
630 struct led_classdev led_cdev
;
633 struct ath9k_hw_cal_data caldata
;
636 #ifdef CONFIG_ATH9K_DEBUGFS
637 struct ath9k_debug debug
;
638 spinlock_t nodes_lock
;
639 struct list_head nodes
; /* basically, stations */
640 unsigned int tx_complete_poll_work_seen
;
642 struct ath_beacon_config cur_beacon_conf
;
643 struct delayed_work tx_complete_work
;
644 struct delayed_work hw_pll_work
;
645 struct ath_btcoex btcoex
;
647 struct ath_descdma txsdma
;
649 struct ath_ant_comb ant_comb
;
653 void ath9k_tasklet(unsigned long data
);
654 int ath_cabq_update(struct ath_softc
*);
656 static inline void ath_read_cachesize(struct ath_common
*common
, int *csz
)
658 common
->bus_ops
->read_cachesize(common
, csz
);
661 extern struct ieee80211_ops ath9k_ops
;
662 extern int ath9k_modparam_nohwcrypt
;
663 extern int led_blink
;
664 extern bool is_ath9k_unloaded
;
666 irqreturn_t
ath_isr(int irq
, void *dev
);
667 int ath9k_init_device(u16 devid
, struct ath_softc
*sc
,
668 const struct ath_bus_ops
*bus_ops
);
669 void ath9k_deinit_device(struct ath_softc
*sc
);
670 void ath9k_set_hw_capab(struct ath_softc
*sc
, struct ieee80211_hw
*hw
);
671 void ath9k_reload_chainmask_settings(struct ath_softc
*sc
);
673 void ath_radio_disable(struct ath_softc
*sc
, struct ieee80211_hw
*hw
);
674 bool ath9k_uses_beacons(int type
);
676 #ifdef CONFIG_ATH9K_PCI
677 int ath_pci_init(void);
678 void ath_pci_exit(void);
680 static inline int ath_pci_init(void) { return 0; };
681 static inline void ath_pci_exit(void) {};
684 #ifdef CONFIG_ATH9K_AHB
685 int ath_ahb_init(void);
686 void ath_ahb_exit(void);
688 static inline int ath_ahb_init(void) { return 0; };
689 static inline void ath_ahb_exit(void) {};
692 void ath9k_ps_wakeup(struct ath_softc
*sc
);
693 void ath9k_ps_restore(struct ath_softc
*sc
);
695 u8
ath_txchainmask_reduction(struct ath_softc
*sc
, u8 chainmask
, u32 rate
);
697 void ath_start_rfkill_poll(struct ath_softc
*sc
);
698 extern void ath9k_rfkill_poll_state(struct ieee80211_hw
*hw
);
699 void ath9k_calculate_iter_data(struct ieee80211_hw
*hw
,
700 struct ieee80211_vif
*vif
,
701 struct ath9k_vif_iter_data
*iter_data
);