1 /*
2  * Copyright (c) 2008-2011 Atheros Communications Inc.
3  *
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.
7  *
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.
15  */
16 
17 #ifndef ATH9K_H
18 #define ATH9K_H
19 
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>
25 #include <linux/time.h>
26 #include <linux/hw_random.h>
27 
28 #include "common.h"
29 #include "debug.h"
30 #include "mci.h"
31 #include "dfs.h"
32 
33 struct ath_node;
34 struct ath_vif;
35 
36 extern struct ieee80211_ops ath9k_ops;
37 extern int ath9k_modparam_nohwcrypt;
38 extern int ath9k_led_blink;
39 extern bool is_ath9k_unloaded;
40 extern int ath9k_use_chanctx;
41 
42 /*************************/
43 /* Descriptor Management */
44 /*************************/
45 
46 #define ATH_TXSTATUS_RING_SIZE 512
47 
48 /* Macro to expand scalars to 64-bit objects */
49 #define	ito64(x) (sizeof(x) == 1) ?			\
50 	(((unsigned long long int)(x)) & (0xff)) :	\
51 	(sizeof(x) == 2) ?				\
52 	(((unsigned long long int)(x)) & 0xffff) :	\
53 	((sizeof(x) == 4) ?				\
54 	 (((unsigned long long int)(x)) & 0xffffffff) : \
55 	 (unsigned long long int)(x))
56 
57 #define ATH_TXBUF_RESET(_bf) do {				\
58 		(_bf)->bf_lastbf = NULL;			\
59 		(_bf)->bf_next = NULL;				\
60 		memset(&((_bf)->bf_state), 0,			\
61 		       sizeof(struct ath_buf_state));		\
62 	} while (0)
63 
64 #define	DS2PHYS(_dd, _ds)						\
65 	((_dd)->dd_desc_paddr + ((caddr_t)(_ds) - (caddr_t)(_dd)->dd_desc))
66 #define ATH_DESC_4KB_BOUND_CHECK(_daddr) ((((_daddr) & 0xFFF) > 0xF7F) ? 1 : 0)
67 #define ATH_DESC_4KB_BOUND_NUM_SKIPPED(_len) ((_len) / 4096)
68 
69 struct ath_descdma {
70 	void *dd_desc;
71 	dma_addr_t dd_desc_paddr;
72 	u32 dd_desc_len;
73 };
74 
75 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
76 		      struct list_head *head, const char *name,
77 		      int nbuf, int ndesc, bool is_tx);
78 
79 /***********/
80 /* RX / TX */
81 /***********/
82 
83 #define	ATH_TXQ_SETUP(sc, i) ((sc)->tx.txqsetup & (1<<i))
84 
85 /* increment with wrap-around */
86 #define INCR(_l, _sz)   do {			\
87 		(_l)++;				\
88 		(_l) &= ((_sz) - 1);		\
89 	} while (0)
90 
91 #define ATH_RXBUF               512
92 #define ATH_TXBUF               512
93 #define ATH_TXBUF_RESERVE       5
94 #define ATH_TXMAXTRY            13
95 #define ATH_MAX_SW_RETRIES      30
96 
97 #define TID_TO_WME_AC(_tid)				\
98 	((((_tid) == 0) || ((_tid) == 3)) ? IEEE80211_AC_BE :	\
99 	 (((_tid) == 1) || ((_tid) == 2)) ? IEEE80211_AC_BK :	\
100 	 (((_tid) == 4) || ((_tid) == 5)) ? IEEE80211_AC_VI :	\
101 	 IEEE80211_AC_VO)
102 
103 #define ATH_AGGR_DELIM_SZ          4
104 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
105 /* number of delimiters for encryption padding */
106 #define ATH_AGGR_ENCRYPTDELIM      10
107 /* minimum h/w qdepth to be sustained to maximize aggregation */
108 #define ATH_AGGR_MIN_QDEPTH        2
109 /* minimum h/w qdepth for non-aggregated traffic */
110 #define ATH_NON_AGGR_MIN_QDEPTH    8
111 #define ATH_HW_CHECK_POLL_INT      1000
112 #define ATH_TXFIFO_DEPTH           8
113 #define ATH_TX_ERROR               0x01
114 
115 /* Stop tx traffic 1ms before the GO goes away */
116 #define ATH_P2P_PS_STOP_TIME       1000
117 
118 #define IEEE80211_SEQ_SEQ_SHIFT    4
119 #define IEEE80211_SEQ_MAX          4096
120 #define IEEE80211_WEP_IVLEN        3
121 #define IEEE80211_WEP_KIDLEN       1
122 #define IEEE80211_WEP_CRCLEN       4
123 #define IEEE80211_MAX_MPDU_LEN     (3840 + FCS_LEN +		\
124 				    (IEEE80211_WEP_IVLEN +	\
125 				     IEEE80211_WEP_KIDLEN +	\
126 				     IEEE80211_WEP_CRCLEN))
127 
128 /* return whether a bit at index _n in bitmap _bm is set
129  * _sz is the size of the bitmap  */
130 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&		\
131 				((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
132 
133 /* return block-ack bitmap index given sequence and starting sequence */
134 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
135 
136 /* return the seqno for _start + _offset */
137 #define ATH_BA_INDEX2SEQ(_seq, _offset) (((_seq) + (_offset)) & (IEEE80211_SEQ_MAX - 1))
138 
139 /* returns delimiter padding required given the packet length */
140 #define ATH_AGGR_GET_NDELIM(_len)					\
141        (((_len) >= ATH_AGGR_MINPLEN) ? 0 :                             \
142         DIV_ROUND_UP(ATH_AGGR_MINPLEN - (_len), ATH_AGGR_DELIM_SZ))
143 
144 #define BAW_WITHIN(_start, _bawsz, _seqno) \
145 	((((_seqno) - (_start)) & 4095) < (_bawsz))
146 
147 #define ATH_AN_2_TID(_an, _tidno) ath_node_to_tid(_an, _tidno)
148 
149 #define IS_HT_RATE(rate)   (rate & 0x80)
150 #define IS_CCK_RATE(rate)  ((rate >= 0x18) && (rate <= 0x1e))
151 #define IS_OFDM_RATE(rate) ((rate >= 0x8) && (rate <= 0xf))
152 
153 enum {
154        WLAN_RC_PHY_OFDM,
155        WLAN_RC_PHY_CCK,
156 };
157 
158 struct ath_txq {
159 	int mac80211_qnum; /* mac80211 queue number, -1 means not mac80211 Q */
160 	u32 axq_qnum; /* ath9k hardware queue number */
161 	void *axq_link;
162 	struct list_head axq_q;
163 	spinlock_t axq_lock;
164 	u32 axq_depth;
165 	u32 axq_ampdu_depth;
166 	bool axq_tx_inprogress;
167 	struct list_head txq_fifo[ATH_TXFIFO_DEPTH];
168 	u8 txq_headidx;
169 	u8 txq_tailidx;
170 	int pending_frames;
171 	struct sk_buff_head complete_q;
172 };
173 
174 struct ath_frame_info {
175 	struct ath_buf *bf;
176 	u16 framelen;
177 	s8 txq;
178 	u8 keyix;
179 	u8 rtscts_rate;
180 	u8 retries : 6;
181 	u8 dyn_smps : 1;
182 	u8 baw_tracked : 1;
183 	u8 tx_power;
184 	enum ath9k_key_type keytype:2;
185 };
186 
187 struct ath_rxbuf {
188 	struct list_head list;
189 	struct sk_buff *bf_mpdu;
190 	void *bf_desc;
191 	dma_addr_t bf_daddr;
192 	dma_addr_t bf_buf_addr;
193 };
194 
195 /**
196  * enum buffer_type - Buffer type flags
197  *
198  * @BUF_AMPDU: This buffer is an ampdu, as part of an aggregate (during TX)
199  * @BUF_AGGR: Indicates whether the buffer can be aggregated
200  *	(used in aggregation scheduling)
201  */
202 enum buffer_type {
203 	BUF_AMPDU		= BIT(0),
204 	BUF_AGGR		= BIT(1),
205 };
206 
207 #define bf_isampdu(bf)		(bf->bf_state.bf_type & BUF_AMPDU)
208 #define bf_isaggr(bf)		(bf->bf_state.bf_type & BUF_AGGR)
209 
210 struct ath_buf_state {
211 	u8 bf_type;
212 	u8 bfs_paprd;
213 	u8 ndelim;
214 	bool stale;
215 	u16 seqno;
216 	unsigned long bfs_paprd_timestamp;
217 };
218 
219 struct ath_buf {
220 	struct list_head list;
221 	struct ath_buf *bf_lastbf;	/* last buf of this unit (a frame or
222 					   an aggregate) */
223 	struct ath_buf *bf_next;	/* next subframe in the aggregate */
224 	struct sk_buff *bf_mpdu;	/* enclosing frame structure */
225 	void *bf_desc;			/* virtual addr of desc */
226 	dma_addr_t bf_daddr;		/* physical addr of desc */
227 	dma_addr_t bf_buf_addr;	/* physical addr of data buffer, for DMA */
228 	struct ieee80211_tx_rate rates[4];
229 	struct ath_buf_state bf_state;
230 };
231 
232 struct ath_atx_tid {
233 	struct list_head list;
234 	struct sk_buff_head retry_q;
235 	struct ath_node *an;
236 	struct ath_txq *txq;
237 	unsigned long tx_buf[BITS_TO_LONGS(ATH_TID_MAX_BUFS)];
238 	u16 seq_start;
239 	u16 seq_next;
240 	u16 baw_size;
241 	u8 tidno;
242 	int baw_head;   /* first un-acked tx buffer */
243 	int baw_tail;   /* next unused tx buffer slot */
244 
245 	s8 bar_index;
246 	bool active;
247 	bool clear_ps_filter;
248 };
249 
250 void ath_tx_queue_tid(struct ath_softc *sc, struct ath_atx_tid *tid);
251 
252 struct ath_node {
253 	struct ath_softc *sc;
254 	struct ieee80211_sta *sta; /* station struct we're part of */
255 	struct ieee80211_vif *vif; /* interface with which we're associated */
256 
257 	u16 maxampdu;
258 	u8 mpdudensity;
259 	s8 ps_key;
260 
261 	bool sleeping;
262 	bool no_ps_filter;
263 
264 #ifdef CONFIG_ATH9K_STATION_STATISTICS
265 	struct ath_rx_rate_stats rx_rate_stats;
266 #endif
267 	u8 key_idx[4];
268 
269 	int ackto;
270 	struct list_head list;
271 };
272 
273 struct ath_tx_control {
274 	struct ath_txq *txq;
275 	struct ath_node *an;
276 	struct ieee80211_sta *sta;
277 	u8 paprd;
278 };
279 
280 
281 /**
282  * @txq_map:  Index is mac80211 queue number.  This is
283  *  not necessarily the same as the hardware queue number
284  *  (axq_qnum).
285  */
286 struct ath_tx {
287 	u32 txqsetup;
288 	spinlock_t txbuflock;
289 	struct list_head txbuf;
290 	struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
291 	struct ath_descdma txdma;
292 	struct ath_txq *txq_map[IEEE80211_NUM_ACS];
293 	struct ath_txq *uapsdq;
294 	u16 max_aggr_framelen[IEEE80211_NUM_ACS][4][32];
295 };
296 
297 struct ath_rx_edma {
298 	struct sk_buff_head rx_fifo;
299 	u32 rx_fifo_hwsize;
300 };
301 
302 struct ath_rx {
303 	u8 defant;
304 	u8 rxotherant;
305 	bool discard_next;
306 	u32 *rxlink;
307 	u32 num_pkts;
308 	struct list_head rxbuf;
309 	struct ath_descdma rxdma;
310 	struct ath_rx_edma rx_edma[ATH9K_RX_QUEUE_MAX];
311 
312 	struct ath_rxbuf *buf_hold;
313 	struct sk_buff *frag;
314 
315 	u32 ampdu_ref;
316 };
317 
318 /*******************/
319 /* Channel Context */
320 /*******************/
321 
322 struct ath_acq {
323 	struct list_head acq_new;
324 	struct list_head acq_old;
325 	spinlock_t lock;
326 };
327 
328 struct ath_chanctx {
329 	struct cfg80211_chan_def chandef;
330 	struct list_head vifs;
331 	struct ath_acq acq[IEEE80211_NUM_ACS];
332 	int hw_queue_base;
333 
334 	/* do not dereference, use for comparison only */
335 	struct ieee80211_vif *primary_sta;
336 
337 	struct ath_beacon_config beacon;
338 	struct ath9k_hw_cal_data caldata;
339 	struct timespec64 tsf_ts;
340 	u64 tsf_val;
341 	u32 last_beacon;
342 
343 	int flush_timeout;
344 	u16 txpower;
345 	u16 cur_txpower;
346 	bool offchannel;
347 	bool stopped;
348 	bool active;
349 	bool assigned;
350 	bool switch_after_beacon;
351 
352 	short nvifs;
353 	short nvifs_assigned;
354 	unsigned int rxfilter;
355 };
356 
357 enum ath_chanctx_event {
358 	ATH_CHANCTX_EVENT_BEACON_PREPARE,
359 	ATH_CHANCTX_EVENT_BEACON_SENT,
360 	ATH_CHANCTX_EVENT_TSF_TIMER,
361 	ATH_CHANCTX_EVENT_BEACON_RECEIVED,
362 	ATH_CHANCTX_EVENT_AUTHORIZED,
363 	ATH_CHANCTX_EVENT_SWITCH,
364 	ATH_CHANCTX_EVENT_ASSIGN,
365 	ATH_CHANCTX_EVENT_UNASSIGN,
366 	ATH_CHANCTX_EVENT_CHANGE,
367 	ATH_CHANCTX_EVENT_ENABLE_MULTICHANNEL,
368 };
369 
370 enum ath_chanctx_state {
371 	ATH_CHANCTX_STATE_IDLE,
372 	ATH_CHANCTX_STATE_WAIT_FOR_BEACON,
373 	ATH_CHANCTX_STATE_WAIT_FOR_TIMER,
374 	ATH_CHANCTX_STATE_SWITCH,
375 	ATH_CHANCTX_STATE_FORCE_ACTIVE,
376 };
377 
378 struct ath_chanctx_sched {
379 	bool beacon_pending;
380 	bool beacon_adjust;
381 	bool offchannel_pending;
382 	bool wait_switch;
383 	bool force_noa_update;
384 	bool extend_absence;
385 	bool mgd_prepare_tx;
386 	enum ath_chanctx_state state;
387 	u8 beacon_miss;
388 
389 	u32 next_tbtt;
390 	u32 switch_start_time;
391 	unsigned int offchannel_duration;
392 	unsigned int channel_switch_time;
393 
394 	/* backup, in case the hardware timer fails */
395 	struct timer_list timer;
396 };
397 
398 enum ath_offchannel_state {
399 	ATH_OFFCHANNEL_IDLE,
400 	ATH_OFFCHANNEL_PROBE_SEND,
401 	ATH_OFFCHANNEL_PROBE_WAIT,
402 	ATH_OFFCHANNEL_SUSPEND,
403 	ATH_OFFCHANNEL_ROC_START,
404 	ATH_OFFCHANNEL_ROC_WAIT,
405 	ATH_OFFCHANNEL_ROC_DONE,
406 };
407 
408 enum ath_roc_complete_reason {
409 	ATH_ROC_COMPLETE_EXPIRE,
410 	ATH_ROC_COMPLETE_ABORT,
411 	ATH_ROC_COMPLETE_CANCEL,
412 };
413 
414 struct ath_offchannel {
415 	struct ath_chanctx chan;
416 	struct timer_list timer;
417 	struct cfg80211_scan_request *scan_req;
418 	struct ieee80211_vif *scan_vif;
419 	int scan_idx;
420 	enum ath_offchannel_state state;
421 	struct ieee80211_channel *roc_chan;
422 	struct ieee80211_vif *roc_vif;
423 	int roc_duration;
424 	int duration;
425 };
426 
427 static inline struct ath_atx_tid *
428 ath_node_to_tid(struct ath_node *an, u8 tidno)
429 {
430 	struct ieee80211_sta *sta = an->sta;
431 	struct ieee80211_vif *vif = an->vif;
432 	struct ieee80211_txq *txq;
433 
434 	BUG_ON(!vif);
435 	if (sta)
436 		txq = sta->txq[tidno % ARRAY_SIZE(sta->txq)];
437 	else
438 		txq = vif->txq;
439 
440 	return (struct ath_atx_tid *) txq->drv_priv;
441 }
442 
443 #define case_rtn_string(val) case val: return #val
444 
445 #define ath_for_each_chanctx(_sc, _ctx)                             \
446 	for (ctx = &sc->chanctx[0];                                 \
447 	     ctx <= &sc->chanctx[ARRAY_SIZE(sc->chanctx) - 1];      \
448 	     ctx++)
449 
450 void ath_chanctx_init(struct ath_softc *sc);
451 void ath_chanctx_set_channel(struct ath_softc *sc, struct ath_chanctx *ctx,
452 			     struct cfg80211_chan_def *chandef);
453 
454 #ifdef CONFIG_ATH9K_CHANNEL_CONTEXT
455 
456 static inline struct ath_chanctx *
457 ath_chanctx_get(struct ieee80211_chanctx_conf *ctx)
458 {
459 	struct ath_chanctx **ptr = (void *) ctx->drv_priv;
460 	return *ptr;
461 }
462 
463 bool ath9k_is_chanctx_enabled(void);
464 void ath9k_fill_chanctx_ops(void);
465 void ath9k_init_channel_context(struct ath_softc *sc);
466 void ath9k_offchannel_init(struct ath_softc *sc);
467 void ath9k_deinit_channel_context(struct ath_softc *sc);
468 int ath9k_init_p2p(struct ath_softc *sc);
469 void ath9k_deinit_p2p(struct ath_softc *sc);
470 void ath9k_p2p_remove_vif(struct ath_softc *sc,
471 			  struct ieee80211_vif *vif);
472 void ath9k_p2p_beacon_sync(struct ath_softc *sc);
473 void ath9k_p2p_bss_info_changed(struct ath_softc *sc,
474 				struct ieee80211_vif *vif);
475 void ath9k_beacon_add_noa(struct ath_softc *sc, struct ath_vif *avp,
476 			  struct sk_buff *skb);
477 void ath9k_p2p_ps_timer(void *priv);
478 void ath9k_chanctx_wake_queues(struct ath_softc *sc, struct ath_chanctx *ctx);
479 void ath9k_chanctx_stop_queues(struct ath_softc *sc, struct ath_chanctx *ctx);
480 void ath_chanctx_check_active(struct ath_softc *sc, struct ath_chanctx *ctx);
481 
482 void ath_chanctx_beacon_recv_ev(struct ath_softc *sc,
483 				enum ath_chanctx_event ev);
484 void ath_chanctx_beacon_sent_ev(struct ath_softc *sc,
485 				enum ath_chanctx_event ev);
486 void ath_chanctx_event(struct ath_softc *sc, struct ieee80211_vif *vif,
487 		       enum ath_chanctx_event ev);
488 void ath_chanctx_set_next(struct ath_softc *sc, bool force);
489 void ath_offchannel_next(struct ath_softc *sc);
490 void ath_scan_complete(struct ath_softc *sc, bool abort);
491 void ath_roc_complete(struct ath_softc *sc,
492 		      enum ath_roc_complete_reason reason);
493 struct ath_chanctx* ath_is_go_chanctx_present(struct ath_softc *sc);
494 
495 #else
496 
497 static inline bool ath9k_is_chanctx_enabled(void)
498 {
499 	return false;
500 }
501 static inline void ath9k_fill_chanctx_ops(void)
502 {
503 }
504 static inline void ath9k_init_channel_context(struct ath_softc *sc)
505 {
506 }
507 static inline void ath9k_offchannel_init(struct ath_softc *sc)
508 {
509 }
510 static inline void ath9k_deinit_channel_context(struct ath_softc *sc)
511 {
512 }
513 static inline void ath_chanctx_beacon_recv_ev(struct ath_softc *sc,
514 					      enum ath_chanctx_event ev)
515 {
516 }
517 static inline void ath_chanctx_beacon_sent_ev(struct ath_softc *sc,
518 					      enum ath_chanctx_event ev)
519 {
520 }
521 static inline void ath_chanctx_event(struct ath_softc *sc,
522 				     struct ieee80211_vif *vif,
523 				     enum ath_chanctx_event ev)
524 {
525 }
526 static inline int ath9k_init_p2p(struct ath_softc *sc)
527 {
528 	return 0;
529 }
530 static inline void ath9k_deinit_p2p(struct ath_softc *sc)
531 {
532 }
533 static inline void ath9k_p2p_remove_vif(struct ath_softc *sc,
534 					struct ieee80211_vif *vif)
535 {
536 }
537 static inline void ath9k_p2p_beacon_sync(struct ath_softc *sc)
538 {
539 }
540 static inline void ath9k_p2p_bss_info_changed(struct ath_softc *sc,
541 					      struct ieee80211_vif *vif)
542 {
543 }
544 static inline void ath9k_beacon_add_noa(struct ath_softc *sc, struct ath_vif *avp,
545 					struct sk_buff *skb)
546 {
547 }
548 static inline void ath9k_p2p_ps_timer(struct ath_softc *sc)
549 {
550 }
551 static inline void ath9k_chanctx_wake_queues(struct ath_softc *sc,
552 					     struct ath_chanctx *ctx)
553 {
554 }
555 static inline void ath9k_chanctx_stop_queues(struct ath_softc *sc,
556 					     struct ath_chanctx *ctx)
557 {
558 }
559 static inline void ath_chanctx_check_active(struct ath_softc *sc,
560 					    struct ath_chanctx *ctx)
561 {
562 }
563 
564 #endif /* CONFIG_ATH9K_CHANNEL_CONTEXT */
565 
566 static inline void ath_txq_lock(struct ath_softc *sc, struct ath_txq *txq)
567 {
568 	spin_lock_bh(&txq->axq_lock);
569 }
570 static inline void ath_txq_unlock(struct ath_softc *sc, struct ath_txq *txq)
571 {
572 	spin_unlock_bh(&txq->axq_lock);
573 }
574 
575 void ath_startrecv(struct ath_softc *sc);
576 bool ath_stoprecv(struct ath_softc *sc);
577 u32 ath_calcrxfilter(struct ath_softc *sc);
578 int ath_rx_init(struct ath_softc *sc, int nbufs);
579 void ath_rx_cleanup(struct ath_softc *sc);
580 int ath_rx_tasklet(struct ath_softc *sc, int flush, bool hp);
581 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
582 void ath_txq_unlock_complete(struct ath_softc *sc, struct ath_txq *txq);
583 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
584 bool ath_drain_all_txq(struct ath_softc *sc);
585 void ath_draintxq(struct ath_softc *sc, struct ath_txq *txq);
586 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
587 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
588 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
589 void ath_txq_schedule_all(struct ath_softc *sc);
590 int ath_tx_init(struct ath_softc *sc, int nbufs);
591 int ath_txq_update(struct ath_softc *sc, int qnum,
592 		   struct ath9k_tx_queue_info *q);
593 u32 ath_pkt_duration(struct ath_softc *sc, u8 rix, int pktlen,
594 		     int width, int half_gi, bool shortPreamble);
595 void ath_update_max_aggr_framelen(struct ath_softc *sc, int queue, int txop);
596 void ath_assign_seq(struct ath_common *common, struct sk_buff *skb);
597 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
598 		 struct ath_tx_control *txctl);
599 void ath_tx_cabq(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
600 		 struct sk_buff *skb);
601 void ath_tx_tasklet(struct ath_softc *sc);
602 void ath_tx_edma_tasklet(struct ath_softc *sc);
603 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
604 		      u16 tid, u16 *ssn);
605 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
606 
607 void ath_tx_aggr_wakeup(struct ath_softc *sc, struct ath_node *an);
608 void ath_tx_aggr_sleep(struct ieee80211_sta *sta, struct ath_softc *sc,
609 		       struct ath_node *an);
610 void ath9k_release_buffered_frames(struct ieee80211_hw *hw,
611 				   struct ieee80211_sta *sta,
612 				   u16 tids, int nframes,
613 				   enum ieee80211_frame_release_type reason,
614 				   bool more_data);
615 void ath9k_wake_tx_queue(struct ieee80211_hw *hw, struct ieee80211_txq *queue);
616 
617 /********/
618 /* VIFs */
619 /********/
620 
621 #define P2P_DEFAULT_CTWIN 10
622 
623 struct ath_vif {
624 	struct list_head list;
625 
626 	u16 seq_no;
627 
628 	/* BSS info */
629 	u8 bssid[ETH_ALEN] __aligned(2);
630 	u16 aid;
631 	bool assoc;
632 
633 	struct ieee80211_vif *vif;
634 	struct ath_node mcast_node;
635 	int av_bslot;
636 	__le64 tsf_adjust; /* TSF adjustment for staggered beacons */
637 	struct ath_buf *av_bcbuf;
638 	struct ath_chanctx *chanctx;
639 
640 	/* P2P Client */
641 	struct ieee80211_noa_data noa;
642 
643 	/* P2P GO */
644 	u8 noa_index;
645 	u32 offchannel_start;
646 	u32 offchannel_duration;
647 
648 	/* These are used for both periodic and one-shot */
649 	u32 noa_start;
650 	u32 noa_duration;
651 	bool periodic_noa;
652 	bool oneshot_noa;
653 };
654 
655 struct ath9k_vif_iter_data {
656 	u8 hw_macaddr[ETH_ALEN]; /* address of the first vif */
657 	u8 mask[ETH_ALEN]; /* bssid mask */
658 	bool has_hw_macaddr;
659 	u8 slottime;
660 	bool beacons;
661 
662 	int naps;      /* number of AP vifs */
663 	int nmeshes;   /* number of mesh vifs */
664 	int nstations; /* number of station vifs */
665 	int nadhocs;   /* number of adhoc vifs */
666 	int nocbs;     /* number of OCB vifs */
667 	int nbcnvifs;  /* number of beaconing vifs */
668 	struct ieee80211_vif *primary_beacon_vif;
669 	struct ieee80211_vif *primary_sta;
670 };
671 
672 void ath9k_calculate_iter_data(struct ath_softc *sc,
673 			       struct ath_chanctx *ctx,
674 			       struct ath9k_vif_iter_data *iter_data);
675 void ath9k_calculate_summary_state(struct ath_softc *sc,
676 				   struct ath_chanctx *ctx);
677 void ath9k_set_txpower(struct ath_softc *sc, struct ieee80211_vif *vif);
678 
679 /*******************/
680 /* Beacon Handling */
681 /*******************/
682 
683 /*
684  * Regardless of the number of beacons we stagger, (i.e. regardless of the
685  * number of BSSIDs) if a given beacon does not go out even after waiting this
686  * number of beacon intervals, the game's up.
687  */
688 #define BSTUCK_THRESH           	9
689 #define	ATH_BCBUF               	8
690 #define ATH_DEFAULT_BINTVAL     	100 /* TU */
691 #define ATH_DEFAULT_BMISS_LIMIT 	10
692 
693 #define TSF_TO_TU(_h,_l) \
694 	((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
695 
696 struct ath_beacon {
697 	enum {
698 		OK,		/* no change needed */
699 		UPDATE,		/* update pending */
700 		COMMIT		/* beacon sent, commit change */
701 	} updateslot;		/* slot time update fsm */
702 
703 	u32 beaconq;
704 	u32 bmisscnt;
705 	struct ieee80211_vif *bslot[ATH_BCBUF];
706 	int slottime;
707 	int slotupdate;
708 	struct ath_descdma bdma;
709 	struct ath_txq *cabq;
710 	struct list_head bbuf;
711 
712 	bool tx_processed;
713 	bool tx_last;
714 };
715 
716 void ath9k_beacon_tasklet(struct tasklet_struct *t);
717 void ath9k_beacon_config(struct ath_softc *sc, struct ieee80211_vif *main_vif,
718 			 bool beacons);
719 void ath9k_beacon_assign_slot(struct ath_softc *sc, struct ieee80211_vif *vif);
720 void ath9k_beacon_remove_slot(struct ath_softc *sc, struct ieee80211_vif *vif);
721 void ath9k_beacon_ensure_primary_slot(struct ath_softc *sc);
722 void ath9k_set_beacon(struct ath_softc *sc);
723 bool ath9k_csa_is_finished(struct ath_softc *sc, struct ieee80211_vif *vif);
724 void ath9k_csa_update(struct ath_softc *sc);
725 
726 /*******************/
727 /* Link Monitoring */
728 /*******************/
729 
730 #define ATH_STA_SHORT_CALINTERVAL 1000    /* 1 second */
731 #define ATH_AP_SHORT_CALINTERVAL  100     /* 100 ms */
732 #define ATH_ANI_POLLINTERVAL_OLD  100     /* 100 ms */
733 #define ATH_ANI_POLLINTERVAL_NEW  1000    /* 1000 ms */
734 #define ATH_LONG_CALINTERVAL_INT  1000    /* 1000 ms */
735 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
736 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
737 #define ATH_ANI_MAX_SKIP_COUNT    10
738 #define ATH_PAPRD_TIMEOUT         100 /* msecs */
739 #define ATH_PLL_WORK_INTERVAL     100
740 
741 void ath_hw_check_work(struct work_struct *work);
742 void ath_reset_work(struct work_struct *work);
743 bool ath_hw_check(struct ath_softc *sc);
744 void ath_hw_pll_work(struct work_struct *work);
745 void ath_paprd_calibrate(struct work_struct *work);
746 void ath_ani_calibrate(struct timer_list *t);
747 void ath_start_ani(struct ath_softc *sc);
748 void ath_stop_ani(struct ath_softc *sc);
749 void ath_check_ani(struct ath_softc *sc);
750 int ath_update_survey_stats(struct ath_softc *sc);
751 void ath_update_survey_nf(struct ath_softc *sc, int channel);
752 void ath9k_queue_reset(struct ath_softc *sc, enum ath_reset_type type);
753 void ath_ps_full_sleep(struct timer_list *t);
754 void __ath9k_flush(struct ieee80211_hw *hw, u32 queues, bool drop,
755 		   bool sw_pending, bool timeout_override);
756 
757 /**********/
758 /* BTCOEX */
759 /**********/
760 
761 #define ATH_DUMP_BTCOEX(_s, _val)				\
762 	do {							\
763 		len += scnprintf(buf + len, size - len,		\
764 				 "%20s : %10d\n", _s, (_val));	\
765 	} while (0)
766 
767 enum bt_op_flags {
768 	BT_OP_PRIORITY_DETECTED,
769 	BT_OP_SCAN,
770 };
771 
772 struct ath_btcoex {
773 	spinlock_t btcoex_lock;
774 	struct timer_list period_timer; /* Timer for BT period */
775 	struct timer_list no_stomp_timer;
776 	u32 bt_priority_cnt;
777 	unsigned long bt_priority_time;
778 	unsigned long op_flags;
779 	int bt_stomp_type; /* Types of BT stomping */
780 	u32 btcoex_no_stomp; /* in msec */
781 	u32 btcoex_period; /* in msec */
782 	u32 btscan_no_stomp; /* in msec */
783 	u32 duty_cycle;
784 	u32 bt_wait_time;
785 	int rssi_count;
786 	struct ath_mci_profile mci;
787 	u8 stomp_audio;
788 };
789 
790 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
791 int ath9k_init_btcoex(struct ath_softc *sc);
792 void ath9k_deinit_btcoex(struct ath_softc *sc);
793 void ath9k_start_btcoex(struct ath_softc *sc);
794 void ath9k_stop_btcoex(struct ath_softc *sc);
795 void ath9k_btcoex_timer_resume(struct ath_softc *sc);
796 void ath9k_btcoex_timer_pause(struct ath_softc *sc);
797 void ath9k_btcoex_handle_interrupt(struct ath_softc *sc, u32 status);
798 u16 ath9k_btcoex_aggr_limit(struct ath_softc *sc, u32 max_4ms_framelen);
799 void ath9k_btcoex_stop_gen_timer(struct ath_softc *sc);
800 int ath9k_dump_btcoex(struct ath_softc *sc, u8 *buf, u32 size);
801 #else
802 static inline int ath9k_init_btcoex(struct ath_softc *sc)
803 {
804 	return 0;
805 }
806 static inline void ath9k_deinit_btcoex(struct ath_softc *sc)
807 {
808 }
809 static inline void ath9k_start_btcoex(struct ath_softc *sc)
810 {
811 }
812 static inline void ath9k_stop_btcoex(struct ath_softc *sc)
813 {
814 }
815 static inline void ath9k_btcoex_handle_interrupt(struct ath_softc *sc,
816 						 u32 status)
817 {
818 }
819 static inline u16 ath9k_btcoex_aggr_limit(struct ath_softc *sc,
820 					  u32 max_4ms_framelen)
821 {
822 	return 0;
823 }
824 static inline void ath9k_btcoex_stop_gen_timer(struct ath_softc *sc)
825 {
826 }
827 static inline int ath9k_dump_btcoex(struct ath_softc *sc, u8 *buf, u32 size)
828 {
829 	return 0;
830 }
831 #endif /* CONFIG_ATH9K_BTCOEX_SUPPORT */
832 
833 /********************/
834 /*   LED Control    */
835 /********************/
836 
837 #define ATH_LED_PIN_DEF 		1
838 #define ATH_LED_PIN_9287		8
839 #define ATH_LED_PIN_9300		10
840 #define ATH_LED_PIN_9485		6
841 #define ATH_LED_PIN_9462		4
842 
843 #ifdef CONFIG_MAC80211_LEDS
844 void ath_init_leds(struct ath_softc *sc);
845 void ath_deinit_leds(struct ath_softc *sc);
846 #else
847 static inline void ath_init_leds(struct ath_softc *sc)
848 {
849 }
850 
851 static inline void ath_deinit_leds(struct ath_softc *sc)
852 {
853 }
854 #endif
855 
856 /************************/
857 /* Wake on Wireless LAN */
858 /************************/
859 
860 #ifdef CONFIG_ATH9K_WOW
861 void ath9k_init_wow(struct ieee80211_hw *hw);
862 void ath9k_deinit_wow(struct ieee80211_hw *hw);
863 int ath9k_suspend(struct ieee80211_hw *hw,
864 		  struct cfg80211_wowlan *wowlan);
865 int ath9k_resume(struct ieee80211_hw *hw);
866 void ath9k_set_wakeup(struct ieee80211_hw *hw, bool enabled);
867 #else
868 static inline void ath9k_init_wow(struct ieee80211_hw *hw)
869 {
870 }
871 static inline void ath9k_deinit_wow(struct ieee80211_hw *hw)
872 {
873 }
874 static inline int ath9k_suspend(struct ieee80211_hw *hw,
875 				struct cfg80211_wowlan *wowlan)
876 {
877 	return 0;
878 }
879 static inline int ath9k_resume(struct ieee80211_hw *hw)
880 {
881 	return 0;
882 }
883 static inline void ath9k_set_wakeup(struct ieee80211_hw *hw, bool enabled)
884 {
885 }
886 #endif /* CONFIG_ATH9K_WOW */
887 
888 /*******************************/
889 /* Antenna diversity/combining */
890 /*******************************/
891 
892 #define ATH_ANT_RX_CURRENT_SHIFT 4
893 #define ATH_ANT_RX_MAIN_SHIFT 2
894 #define ATH_ANT_RX_MASK 0x3
895 
896 #define ATH_ANT_DIV_COMB_SHORT_SCAN_INTR 50
897 #define ATH_ANT_DIV_COMB_SHORT_SCAN_PKTCOUNT 0x100
898 #define ATH_ANT_DIV_COMB_MAX_PKTCOUNT 0x200
899 #define ATH_ANT_DIV_COMB_INIT_COUNT 95
900 #define ATH_ANT_DIV_COMB_MAX_COUNT 100
901 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO 30
902 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2 20
903 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO_LOW_RSSI 50
904 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2_LOW_RSSI 50
905 
906 #define ATH_ANT_DIV_COMB_LNA1_DELTA_HI -4
907 #define ATH_ANT_DIV_COMB_LNA1_DELTA_MID -2
908 #define ATH_ANT_DIV_COMB_LNA1_DELTA_LOW 2
909 
910 struct ath_ant_comb {
911 	u16 count;
912 	u16 total_pkt_count;
913 	bool scan;
914 	bool scan_not_start;
915 	int main_total_rssi;
916 	int alt_total_rssi;
917 	int alt_recv_cnt;
918 	int main_recv_cnt;
919 	int rssi_lna1;
920 	int rssi_lna2;
921 	int rssi_add;
922 	int rssi_sub;
923 	int rssi_first;
924 	int rssi_second;
925 	int rssi_third;
926 	int ant_ratio;
927 	int ant_ratio2;
928 	bool alt_good;
929 	int quick_scan_cnt;
930 	enum ath9k_ant_div_comb_lna_conf main_conf;
931 	enum ath9k_ant_div_comb_lna_conf first_quick_scan_conf;
932 	enum ath9k_ant_div_comb_lna_conf second_quick_scan_conf;
933 	bool first_ratio;
934 	bool second_ratio;
935 	unsigned long scan_start_time;
936 
937 	/*
938 	 * Card-specific config values.
939 	 */
940 	int low_rssi_thresh;
941 	int fast_div_bias;
942 };
943 
944 void ath_ant_comb_scan(struct ath_softc *sc, struct ath_rx_status *rs);
945 
946 /********************/
947 /* Main driver core */
948 /********************/
949 
950 #define ATH9K_PCI_CUS198          0x0001
951 #define ATH9K_PCI_CUS230          0x0002
952 #define ATH9K_PCI_CUS217          0x0004
953 #define ATH9K_PCI_CUS252          0x0008
954 #define ATH9K_PCI_WOW             0x0010
955 #define ATH9K_PCI_BT_ANT_DIV      0x0020
956 #define ATH9K_PCI_D3_L1_WAR       0x0040
957 #define ATH9K_PCI_AR9565_1ANT     0x0080
958 #define ATH9K_PCI_AR9565_2ANT     0x0100
959 #define ATH9K_PCI_NO_PLL_PWRSAVE  0x0200
960 #define ATH9K_PCI_KILLER          0x0400
961 #define ATH9K_PCI_LED_ACT_HI      0x0800
962 
963 /*
964  * Default cache line size, in bytes.
965  * Used when PCI device not fully initialized by bootrom/BIOS
966 */
967 #define DEFAULT_CACHELINE       32
968 #define ATH_CABQ_READY_TIME     80      /* % of beacon interval */
969 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
970 #define MAX_GTT_CNT             5
971 
972 /* Powersave flags */
973 #define PS_WAIT_FOR_BEACON        BIT(0)
974 #define PS_WAIT_FOR_CAB           BIT(1)
975 #define PS_WAIT_FOR_PSPOLL_DATA   BIT(2)
976 #define PS_WAIT_FOR_TX_ACK        BIT(3)
977 #define PS_BEACON_SYNC            BIT(4)
978 #define PS_WAIT_FOR_ANI           BIT(5)
979 
980 #define ATH9K_NUM_CHANCTX  2 /* supports 2 operating channels */
981 
982 struct ath_softc {
983 	struct ieee80211_hw *hw;
984 	struct device *dev;
985 
986 	struct survey_info *cur_survey;
987 	struct survey_info survey[ATH9K_NUM_CHANNELS];
988 
989 	spinlock_t intr_lock;
990 	struct tasklet_struct intr_tq;
991 	struct tasklet_struct bcon_tasklet;
992 	struct ath_hw *sc_ah;
993 	void __iomem *mem;
994 	int irq;
995 	spinlock_t sc_serial_rw;
996 	spinlock_t sc_pm_lock;
997 	spinlock_t sc_pcu_lock;
998 	struct mutex mutex;
999 	struct work_struct paprd_work;
1000 	struct work_struct hw_reset_work;
1001 	struct completion paprd_complete;
1002 	wait_queue_head_t tx_wait;
1003 
1004 #ifdef CONFIG_ATH9K_CHANNEL_CONTEXT
1005 	struct work_struct chanctx_work;
1006 	struct ath_gen_timer *p2p_ps_timer;
1007 	struct ath_vif *p2p_ps_vif;
1008 	struct ath_chanctx_sched sched;
1009 	struct ath_offchannel offchannel;
1010 	struct ath_chanctx *next_chan;
1011 	struct completion go_beacon;
1012 	struct timespec64 last_event_time;
1013 #endif
1014 
1015 	unsigned long driver_data;
1016 
1017 	u8 gtt_cnt;
1018 	u32 intrstatus;
1019 	u16 ps_flags; /* PS_* */
1020 	bool ps_enabled;
1021 	bool ps_idle;
1022 	short nbcnvifs;
1023 	unsigned long ps_usecount;
1024 
1025 	struct ath_rx rx;
1026 	struct ath_tx tx;
1027 	struct ath_beacon beacon;
1028 
1029 	struct cfg80211_chan_def cur_chandef;
1030 	struct ath_chanctx chanctx[ATH9K_NUM_CHANCTX];
1031 	struct ath_chanctx *cur_chan;
1032 	spinlock_t chan_lock;
1033 
1034 #ifdef CONFIG_MAC80211_LEDS
1035 	bool led_registered;
1036 	char led_name[32];
1037 	struct led_classdev led_cdev;
1038 #endif
1039 
1040 #ifdef CONFIG_ATH9K_DEBUGFS
1041 	struct ath9k_debug debug;
1042 #endif
1043 	struct delayed_work hw_check_work;
1044 	struct delayed_work hw_pll_work;
1045 	struct timer_list sleep_timer;
1046 
1047 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
1048 	struct ath_btcoex btcoex;
1049 	struct ath_mci_coex mci_coex;
1050 	struct work_struct mci_work;
1051 #endif
1052 
1053 	struct ath_descdma txsdma;
1054 
1055 	struct ath_ant_comb ant_comb;
1056 	u8 ant_tx, ant_rx;
1057 	struct dfs_pattern_detector *dfs_detector;
1058 	u64 dfs_prev_pulse_ts;
1059 	u32 wow_enabled;
1060 
1061 	struct ath_spec_scan_priv spec_priv;
1062 
1063 	struct ieee80211_vif *tx99_vif;
1064 	struct sk_buff *tx99_skb;
1065 	bool tx99_state;
1066 	s16 tx99_power;
1067 
1068 #ifdef CONFIG_ATH9K_WOW
1069 	u32 wow_intr_before_sleep;
1070 	bool force_wow;
1071 #endif
1072 
1073 #ifdef CONFIG_ATH9K_HWRNG
1074 	u32 rng_last;
1075 	struct task_struct *rng_task;
1076 #endif
1077 };
1078 
1079 /********/
1080 /* TX99 */
1081 /********/
1082 
1083 #ifdef CONFIG_ATH9K_TX99
1084 void ath9k_tx99_init_debug(struct ath_softc *sc);
1085 int ath9k_tx99_send(struct ath_softc *sc, struct sk_buff *skb,
1086 		    struct ath_tx_control *txctl);
1087 #else
1088 static inline void ath9k_tx99_init_debug(struct ath_softc *sc)
1089 {
1090 }
1091 static inline int ath9k_tx99_send(struct ath_softc *sc,
1092 				  struct sk_buff *skb,
1093 				  struct ath_tx_control *txctl)
1094 {
1095 	return 0;
1096 }
1097 #endif /* CONFIG_ATH9K_TX99 */
1098 
1099 /***************************/
1100 /* Random Number Generator */
1101 /***************************/
1102 #ifdef CONFIG_ATH9K_HWRNG
1103 void ath9k_rng_start(struct ath_softc *sc);
1104 void ath9k_rng_stop(struct ath_softc *sc);
1105 #else
1106 static inline void ath9k_rng_start(struct ath_softc *sc)
1107 {
1108 }
1109 
1110 static inline void ath9k_rng_stop(struct ath_softc *sc)
1111 {
1112 }
1113 #endif
1114 
1115 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
1116 {
1117 	common->bus_ops->read_cachesize(common, csz);
1118 }
1119 
1120 void ath9k_tasklet(struct tasklet_struct *t);
1121 int ath_cabq_update(struct ath_softc *);
1122 u8 ath9k_parse_mpdudensity(u8 mpdudensity);
1123 irqreturn_t ath_isr(int irq, void *dev);
1124 int ath_reset(struct ath_softc *sc, struct ath9k_channel *hchan);
1125 void ath_cancel_work(struct ath_softc *sc);
1126 void ath_restart_work(struct ath_softc *sc);
1127 int ath9k_init_device(u16 devid, struct ath_softc *sc,
1128 		    const struct ath_bus_ops *bus_ops);
1129 void ath9k_deinit_device(struct ath_softc *sc);
1130 void ath9k_reload_chainmask_settings(struct ath_softc *sc);
1131 u8 ath_txchainmask_reduction(struct ath_softc *sc, u8 chainmask, u32 rate);
1132 void ath_start_rfkill_poll(struct ath_softc *sc);
1133 void ath9k_rfkill_poll_state(struct ieee80211_hw *hw);
1134 void ath9k_ps_wakeup(struct ath_softc *sc);
1135 void ath9k_ps_restore(struct ath_softc *sc);
1136 
1137 #ifdef CONFIG_ATH9K_PCI
1138 int ath_pci_init(void);
1139 void ath_pci_exit(void);
1140 #else
1141 static inline int ath_pci_init(void) { return 0; };
1142 static inline void ath_pci_exit(void) {};
1143 #endif
1144 
1145 #ifdef CONFIG_ATH9K_AHB
1146 int ath_ahb_init(void);
1147 void ath_ahb_exit(void);
1148 #else
1149 static inline int ath_ahb_init(void) { return 0; };
1150 static inline void ath_ahb_exit(void) {};
1151 #endif
1152 
1153 #endif /* ATH9K_H */
1154