xref: /freebsd/sys/dev/ath/if_ath_tx.h (revision ca987d4641cdcd7f27e153db17c5bf064934faf5)
1 /*-
2  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	__IF_ATH_TX_H__
32 #define	__IF_ATH_TX_H__
33 
34 /*
35  * some general macros
36  */
37 #define	INCR(_l, _sz)		(_l) ++; (_l) &= ((_sz) - 1)
38 /*
39  * return block-ack bitmap index given sequence and starting sequence
40  */
41 #define	ATH_BA_INDEX(_st, _seq)	(((_seq) - (_st)) & (IEEE80211_SEQ_RANGE - 1))
42 
43 #define	WME_BA_BMP_SIZE	64
44 #define	WME_MAX_BA	WME_BA_BMP_SIZE
45 
46 /*
47  * How 'busy' to try and keep the hardware txq
48  */
49 #define	ATH_AGGR_MIN_QDEPTH		2
50 #define	ATH_NONAGGR_MIN_QDEPTH		32
51 
52 /*
53  * Watermark for scheduling TIDs in order to maximise aggregation.
54  *
55  * If hwq_depth is greater than this, don't schedule the TID
56  * for packet scheduling - the hardware is already busy servicing
57  * this TID.
58  *
59  * If hwq_depth is less than this, schedule the TID for packet
60  * scheduling in the completion handler.
61  */
62 #define	ATH_AGGR_SCHED_HIGH		4
63 #define	ATH_AGGR_SCHED_LOW		2
64 
65 /*
66  * return whether a bit at index _n in bitmap _bm is set
67  * _sz is the size of the bitmap
68  */
69 #define	ATH_BA_ISSET(_bm, _n)	(((_n) < (WME_BA_BMP_SIZE)) &&		\
70 	    ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
71 
72 
73 /* extracting the seqno from buffer seqno */
74 #define	SEQNO(_a)	((_a) >> IEEE80211_SEQ_SEQ_SHIFT)
75 
76 /*
77  * Whether the current sequence number is within the
78  * BAW.
79  */
80 #define	BAW_WITHIN(_start, _bawsz, _seqno)	\
81 	    ((((_seqno) - (_start)) & 4095) < (_bawsz))
82 
83 /*
84  * Maximum aggregate size
85  */
86 #define	ATH_AGGR_MAXSIZE	65530
87 
88 extern void ath_tx_node_flush(struct ath_softc *sc, struct ath_node *an);
89 extern void ath_tx_txq_drain(struct ath_softc *sc, struct ath_txq *txq);
90 extern void ath_txfrag_cleanup(struct ath_softc *sc, ath_bufhead *frags,
91     struct ieee80211_node *ni);
92 extern int ath_txfrag_setup(struct ath_softc *sc, ath_bufhead *frags,
93     struct mbuf *m0, struct ieee80211_node *ni);
94 extern int ath_tx_start(struct ath_softc *sc, struct ieee80211_node *ni,
95     struct ath_buf *bf, struct mbuf *m0);
96 extern int ath_raw_xmit(struct ieee80211_node *ni, struct mbuf *m,
97     const struct ieee80211_bpf_params *params);
98 
99 /* software queue stuff */
100 extern void ath_tx_swq(struct ath_softc *sc, struct ieee80211_node *ni,
101     struct ath_txq *txq, int queue_to_head, struct ath_buf *bf);
102 extern void ath_tx_tid_init(struct ath_softc *sc, struct ath_node *an);
103 extern void ath_tx_tid_hw_queue_aggr(struct ath_softc *sc, struct ath_node *an,
104     struct ath_tid *tid);
105 extern void ath_tx_tid_hw_queue_norm(struct ath_softc *sc, struct ath_node *an,
106     struct ath_tid *tid);
107 extern void ath_txq_sched(struct ath_softc *sc, struct ath_txq *txq);
108 extern void ath_tx_normal_comp(struct ath_softc *sc, struct ath_buf *bf,
109     int fail);
110 extern void ath_tx_aggr_comp(struct ath_softc *sc, struct ath_buf *bf,
111     int fail);
112 extern void ath_tx_addto_baw(struct ath_softc *sc, struct ath_node *an,
113     struct ath_tid *tid, struct ath_buf *bf);
114 extern struct ieee80211_tx_ampdu * ath_tx_get_tx_tid(struct ath_node *an,
115     int tid);
116 extern void ath_tx_tid_sched(struct ath_softc *sc, struct ath_tid *tid);
117 
118 /* TX addba handling */
119 extern	int ath_addba_request(struct ieee80211_node *ni,
120     struct ieee80211_tx_ampdu *tap, int dialogtoken,
121     int baparamset, int batimeout);
122 extern	int ath_addba_response(struct ieee80211_node *ni,
123     struct ieee80211_tx_ampdu *tap, int dialogtoken,
124     int code, int batimeout);
125 extern	void ath_addba_stop(struct ieee80211_node *ni,
126     struct ieee80211_tx_ampdu *tap);
127 extern	void ath_bar_response(struct ieee80211_node *ni,
128      struct ieee80211_tx_ampdu *tap, int status);
129 extern	void ath_addba_response_timeout(struct ieee80211_node *ni,
130     struct ieee80211_tx_ampdu *tap);
131 
132 /*
133  * AP mode power save handling (of stations)
134  */
135 extern	void ath_tx_node_sleep(struct ath_softc *sc, struct ath_node *an);
136 extern	void ath_tx_node_wakeup(struct ath_softc *sc, struct ath_node *an);
137 extern	int ath_tx_node_is_asleep(struct ath_softc *sc, struct ath_node *an);
138 extern	void ath_tx_node_reassoc(struct ath_softc *sc, struct ath_node *an);
139 
140 /*
141  * Hardware queue stuff
142  */
143 extern	void ath_tx_push_pending(struct ath_softc *sc, struct ath_txq *txq);
144 
145 /*
146  * Misc debugging stuff
147  */
148 #ifdef	ATH_DEBUG_ALQ
149 extern	void ath_tx_alq_post(struct ath_softc *sc, struct ath_buf *bf_first);
150 #endif	/* ATH_DEBUG_ALQ */
151 
152 /*
153  * Setup path
154  */
155 #define	ath_txdma_setup(_sc)			\
156 	(_sc)->sc_tx.xmit_setup(_sc)
157 #define	ath_txdma_teardown(_sc)			\
158 	(_sc)->sc_tx.xmit_teardown(_sc)
159 #define	ath_txq_restart_dma(_sc, _txq)		\
160 	(_sc)->sc_tx.xmit_dma_restart((_sc), (_txq))
161 #define	ath_tx_handoff(_sc, _txq, _bf)		\
162 	(_sc)->sc_tx.xmit_handoff((_sc), (_txq), (_bf))
163 #define	ath_draintxq(_sc, _rtype)		\
164 	(_sc)->sc_tx.xmit_drain((_sc), (_rtype))
165 
166 extern	void ath_xmit_setup_legacy(struct ath_softc *sc);
167 
168 #endif
169