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)
118 struct ath_desc *dd_desc;
119 dma_addr_t dd_desc_paddr;
121 struct ath_buf *dd_bufptr;
124 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
125 struct list_head *head, const char *name,
126 int nbuf, int ndesc);
127 void ath_descdma_cleanup(struct ath_softc *sc, struct ath_descdma *dd,
128 struct list_head *head);
134 #define ATH_MAX_ANTENNA 3
135 #define ATH_RXBUF 512
136 #define ATH_TXBUF 512
137 #define ATH_TXMAXTRY 13
138 #define ATH_MGT_TXMAXTRY 4
140 #define TID_TO_WME_AC(_tid) \
141 ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
142 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
143 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
146 #define ADDBA_EXCHANGE_ATTEMPTS 10
147 #define ATH_AGGR_DELIM_SZ 4
148 #define ATH_AGGR_MINPLEN 256 /* in bytes, minimum packet length */
149 /* number of delimiters for encryption padding */
150 #define ATH_AGGR_ENCRYPTDELIM 10
151 /* minimum h/w qdepth to be sustained to maximize aggregation */
152 #define ATH_AGGR_MIN_QDEPTH 2
153 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
155 #define IEEE80211_SEQ_SEQ_SHIFT 4
156 #define IEEE80211_SEQ_MAX 4096
157 #define IEEE80211_WEP_IVLEN 3
158 #define IEEE80211_WEP_KIDLEN 1
159 #define IEEE80211_WEP_CRCLEN 4
160 #define IEEE80211_MAX_MPDU_LEN (3840 + FCS_LEN + \
161 (IEEE80211_WEP_IVLEN + \
162 IEEE80211_WEP_KIDLEN + \
163 IEEE80211_WEP_CRCLEN))
165 /* return whether a bit at index _n in bitmap _bm is set
166 * _sz is the size of the bitmap */
167 #define ATH_BA_ISSET(_bm, _n) (((_n) < (WME_BA_BMP_SIZE)) && \
168 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
170 /* return block-ack bitmap index given sequence and starting sequence */
171 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
173 /* returns delimiter padding required given the packet length */
174 #define ATH_AGGR_GET_NDELIM(_len) \
175 (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ? \
176 (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
178 #define BAW_WITHIN(_start, _bawsz, _seqno) \
179 ((((_seqno) - (_start)) & 4095) < (_bawsz))
181 #define ATH_AN_2_TID(_an, _tidno) (&(_an)->tid[(_tidno)])
183 #define ATH_TX_COMPLETE_POLL_INT 1000
185 enum ATH_AGGR_STATUS {
194 struct list_head axq_q;
198 bool axq_tx_inprogress;
199 struct list_head axq_acq;
202 #define AGGR_CLEANUP BIT(1)
203 #define AGGR_ADDBA_COMPLETE BIT(2)
204 #define AGGR_ADDBA_PROGRESS BIT(3)
206 struct ath_tx_control {
209 enum ath9k_internal_frame_type frame_type;
212 #define ATH_TX_ERROR 0x01
213 #define ATH_TX_XRETRY 0x02
214 #define ATH_TX_BAR 0x04
219 int hwq_map[ATH9K_WME_AC_VO+1];
220 spinlock_t txbuflock;
221 struct list_head txbuf;
222 struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
223 struct ath_descdma txdma;
230 unsigned int rxfilter;
231 spinlock_t rxflushlock;
232 spinlock_t rxbuflock;
233 struct list_head rxbuf;
234 struct ath_descdma rxdma;
237 int ath_startrecv(struct ath_softc *sc);
238 bool ath_stoprecv(struct ath_softc *sc);
239 void ath_flushrecv(struct ath_softc *sc);
240 u32 ath_calcrxfilter(struct ath_softc *sc);
241 int ath_rx_init(struct ath_softc *sc, int nbufs);
242 void ath_rx_cleanup(struct ath_softc *sc);
243 int ath_rx_tasklet(struct ath_softc *sc, int flush);
244 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
245 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
246 int ath_tx_setup(struct ath_softc *sc, int haltype);
247 void ath_drain_all_txq(struct ath_softc *sc, bool retry_tx);
248 void ath_draintxq(struct ath_softc *sc,
249 struct ath_txq *txq, bool retry_tx);
250 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
251 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
252 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
253 int ath_tx_init(struct ath_softc *sc, int nbufs);
254 void ath_tx_cleanup(struct ath_softc *sc);
255 struct ath_txq *ath_test_get_txq(struct ath_softc *sc, struct sk_buff *skb);
256 int ath_txq_update(struct ath_softc *sc, int qnum,
257 struct ath9k_tx_queue_info *q);
258 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
259 struct ath_tx_control *txctl);
260 void ath_tx_tasklet(struct ath_softc *sc);
261 void ath_tx_cabq(struct ieee80211_hw *hw, struct sk_buff *skb);
262 bool ath_tx_aggr_check(struct ath_softc *sc, struct ath_node *an, u8 tidno);
263 void ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
265 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
266 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
267 void ath9k_enable_ps(struct ath_softc *sc);
275 __le64 tsf_adjust; /* TSF adjustment for staggered beacons */
276 enum nl80211_iftype av_opmode;
277 struct ath_buf *av_bcbuf;
278 struct ath_tx_control av_btxctl;
279 u8 bssid[ETH_ALEN]; /* current BSSID from config_interface */
282 /*******************/
283 /* Beacon Handling */
284 /*******************/
287 * Regardless of the number of beacons we stagger, (i.e. regardless of the
288 * number of BSSIDs) if a given beacon does not go out even after waiting this
289 * number of beacon intervals, the game's up.
291 #define BSTUCK_THRESH (9 * ATH_BCBUF)
293 #define ATH_DEFAULT_BINTVAL 100 /* TU */
294 #define ATH_DEFAULT_BMISS_LIMIT 10
295 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
297 struct ath_beacon_config {
307 OK, /* no change needed */
308 UPDATE, /* update pending */
309 COMMIT /* beacon sent, commit change */
310 } updateslot; /* slot time update fsm */
316 struct ieee80211_vif *bslot[ATH_BCBUF];
317 struct ath_wiphy *bslot_aphy[ATH_BCBUF];
320 struct ath9k_tx_queue_info beacon_qi;
321 struct ath_descdma bdma;
322 struct ath_txq *cabq;
323 struct list_head bbuf;
326 void ath_beacon_tasklet(unsigned long data);
327 void ath_beacon_config(struct ath_softc *sc, struct ieee80211_vif *vif);
328 int ath_beacon_alloc(struct ath_wiphy *aphy, struct ieee80211_vif *vif);
329 void ath_beacon_return(struct ath_softc *sc, struct ath_vif *avp);
330 int ath_beaconq_config(struct ath_softc *sc);
336 #define ATH_STA_SHORT_CALINTERVAL 1000 /* 1 second */
337 #define ATH_AP_SHORT_CALINTERVAL 100 /* 100 ms */
338 #define ATH_ANI_POLLINTERVAL 100 /* 100 ms */
339 #define ATH_LONG_CALINTERVAL 30000 /* 30 seconds */
340 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes */
342 void ath_ani_calibrate(unsigned long data);
348 /* Defines the BT AR_BT_COEX_WGHT used */
349 enum ath_stomp_type {
351 ATH_BTCOEX_STOMP_ALL,
352 ATH_BTCOEX_STOMP_LOW,
353 ATH_BTCOEX_STOMP_NONE
357 bool hw_timer_enabled;
358 spinlock_t btcoex_lock;
359 struct timer_list period_timer; /* Timer for BT period */
361 unsigned long bt_priority_time;
362 int bt_stomp_type; /* Types of BT stomping */
363 u32 btcoex_no_stomp; /* in usec */
364 u32 btcoex_period; /* in usec */
365 u32 btscan_no_stomp; /* in usec */
366 struct ath_gen_timer *no_stomp_timer; /* Timer for no BT stomping */
369 int ath_init_btcoex_timer(struct ath_softc *sc);
370 void ath9k_btcoex_timer_resume(struct ath_softc *sc);
371 void ath9k_btcoex_timer_pause(struct ath_softc *sc);
373 /********************/
375 /********************/
377 #define ATH_LED_PIN_DEF 1
378 #define ATH_LED_PIN_9287 8
379 #define ATH_LED_ON_DURATION_IDLE 350 /* in msecs */
380 #define ATH_LED_OFF_DURATION_IDLE 250 /* in msecs */
390 struct ath_softc *sc;
391 struct led_classdev led_cdev;
392 enum ath_led_type led_type;
397 void ath_init_leds(struct ath_softc *sc);
398 void ath_deinit_leds(struct ath_softc *sc);
400 /********************/
401 /* Main driver core */
402 /********************/
405 * Default cache line size, in bytes.
406 * Used when PCI device not fully initialized by bootrom/BIOS
408 #define DEFAULT_CACHELINE 32
409 #define ATH_REGCLASSIDS_MAX 10
410 #define ATH_CABQ_READY_TIME 80 /* % of beacon interval */
411 #define ATH_MAX_SW_RETRIES 10
412 #define ATH_CHAN_MAX 255
413 #define IEEE80211_WEP_NKID 4 /* number of key ids */
415 #define ATH_TXPOWER_MAX 100 /* .5 dBm units */
416 #define ATH_RATE_DUMMY_MARKER 0
418 #define SC_OP_INVALID BIT(0)
419 #define SC_OP_BEACONS BIT(1)
420 #define SC_OP_RXAGGR BIT(2)
421 #define SC_OP_TXAGGR BIT(3)
422 #define SC_OP_FULL_RESET BIT(4)
423 #define SC_OP_PREAMBLE_SHORT BIT(5)
424 #define SC_OP_PROTECT_ENABLE BIT(6)
425 #define SC_OP_RXFLUSH BIT(7)
426 #define SC_OP_LED_ASSOCIATED BIT(8)
427 #define SC_OP_LED_ON BIT(9)
428 #define SC_OP_SCANNING BIT(10)
429 #define SC_OP_TSF_RESET BIT(11)
430 #define SC_OP_BT_PRIORITY_DETECTED BIT(12)
431 #define SC_OP_BT_SCAN BIT(13)
433 /* Powersave flags */
434 #define PS_WAIT_FOR_BEACON BIT(0)
435 #define PS_WAIT_FOR_CAB BIT(1)
436 #define PS_WAIT_FOR_PSPOLL_DATA BIT(2)
437 #define PS_WAIT_FOR_TX_ACK BIT(3)
438 #define PS_BEACON_SYNC BIT(4)
439 #define PS_NULLFUNC_COMPLETED BIT(5)
440 #define PS_ENABLED BIT(6)
443 struct ath_rate_table;
446 struct ieee80211_hw *hw;
449 spinlock_t wiphy_lock; /* spinlock to protect ath_wiphy data */
450 struct ath_wiphy *pri_wiphy;
451 struct ath_wiphy **sec_wiphy; /* secondary wiphys (virtual radios); may
452 * have NULL entries */
453 int num_sec_wiphy; /* number of sec_wiphy pointers in the array */
456 struct ath_wiphy *next_wiphy;
457 struct work_struct chan_work;
458 int wiphy_select_failures;
459 unsigned long wiphy_select_first_fail;
460 struct delayed_work wiphy_work;
461 unsigned long wiphy_scheduler_int;
462 int wiphy_scheduler_index;
464 struct tasklet_struct intr_tq;
465 struct tasklet_struct bcon_tasklet;
466 struct ath_hw *sc_ah;
469 spinlock_t sc_resetlock;
470 spinlock_t sc_serial_rw;
471 spinlock_t sc_pm_lock;
475 u32 sc_flags; /* SC_OP_* */
476 u16 ps_flags; /* PS_* */
482 unsigned long ps_usecount;
484 struct ath_config config;
487 struct ath_beacon beacon;
488 const struct ath_rate_table *cur_rate_table;
489 enum wireless_mode cur_rate_mode;
490 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
492 struct ath_led radio_led;
493 struct ath_led assoc_led;
494 struct ath_led tx_led;
495 struct ath_led rx_led;
496 struct delayed_work ath_led_blink_work;
498 int led_off_duration;
504 #ifdef CONFIG_ATH9K_DEBUGFS
505 struct ath9k_debug debug;
507 struct ath_beacon_config cur_beacon_conf;
508 struct delayed_work tx_complete_work;
509 struct ath_btcoex btcoex;
513 struct ath_softc *sc; /* shared for all virtual wiphys */
514 struct ieee80211_hw *hw;
515 enum ath_wiphy_state {
527 void ath9k_tasklet(unsigned long data);
528 int ath_reset(struct ath_softc *sc, bool retry_tx);
529 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
530 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
531 int ath_cabq_update(struct ath_softc *);
533 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
535 common->bus_ops->read_cachesize(common, csz);
538 extern struct ieee80211_ops ath9k_ops;
539 extern int modparam_nohwcrypt;
541 irqreturn_t ath_isr(int irq, void *dev);
542 int ath9k_init_device(u16 devid, struct ath_softc *sc, u16 subsysid,
543 const struct ath_bus_ops *bus_ops);
544 void ath9k_deinit_device(struct ath_softc *sc);
545 const char *ath_mac_bb_name(u32 mac_bb_version);
546 const char *ath_rf_name(u16 rf_version);
547 void ath9k_set_hw_capab(struct ath_softc *sc, struct ieee80211_hw *hw);
548 void ath9k_update_ichannel(struct ath_softc *sc, struct ieee80211_hw *hw,
549 struct ath9k_channel *ichan);
550 void ath_update_chainmask(struct ath_softc *sc, int is_ht);
551 int ath_set_channel(struct ath_softc *sc, struct ieee80211_hw *hw,
552 struct ath9k_channel *hchan);
554 void ath_radio_enable(struct ath_softc *sc, struct ieee80211_hw *hw);
555 void ath_radio_disable(struct ath_softc *sc, struct ieee80211_hw *hw);
556 bool ath9k_setpower(struct ath_softc *sc, enum ath9k_power_mode mode);
559 int ath_pci_init(void);
560 void ath_pci_exit(void);
562 static inline int ath_pci_init(void) { return 0; };
563 static inline void ath_pci_exit(void) {};
566 #ifdef CONFIG_ATHEROS_AR71XX
567 int ath_ahb_init(void);
568 void ath_ahb_exit(void);
570 static inline int ath_ahb_init(void) { return 0; };
571 static inline void ath_ahb_exit(void) {};
574 void ath9k_ps_wakeup(struct ath_softc *sc);
575 void ath9k_ps_restore(struct ath_softc *sc);
577 void ath9k_set_bssid_mask(struct ieee80211_hw *hw);
578 int ath9k_wiphy_add(struct ath_softc *sc);
579 int ath9k_wiphy_del(struct ath_wiphy *aphy);
580 void ath9k_tx_status(struct ieee80211_hw *hw, struct sk_buff *skb);
581 int ath9k_wiphy_pause(struct ath_wiphy *aphy);
582 int ath9k_wiphy_unpause(struct ath_wiphy *aphy);
583 int ath9k_wiphy_select(struct ath_wiphy *aphy);
584 void ath9k_wiphy_set_scheduler(struct ath_softc *sc, unsigned int msec_int);
585 void ath9k_wiphy_chan_work(struct work_struct *work);
586 bool ath9k_wiphy_started(struct ath_softc *sc);
587 void ath9k_wiphy_pause_all_forced(struct ath_softc *sc,
588 struct ath_wiphy *selected);
589 bool ath9k_wiphy_scanning(struct ath_softc *sc);
590 void ath9k_wiphy_work(struct work_struct *work);
591 bool ath9k_all_wiphys_idle(struct ath_softc *sc);
592 void ath9k_set_wiphy_idle(struct ath_wiphy *aphy, bool idle);
594 void ath_mac80211_stop_queue(struct ath_softc *sc, u16 skb_queue);
595 void ath_mac80211_start_queue(struct ath_softc *sc, u16 skb_queue);
597 int ath_tx_get_qnum(struct ath_softc *sc, int qtype, int haltype);
599 void ath_start_rfkill_poll(struct ath_softc *sc);
600 extern void ath9k_rfkill_poll_state(struct ieee80211_hw *hw);