xref: /freebsd/sys/dev/ath/if_ath_tx.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
15  *    redistribution must be conditioned upon including a substantially
16  *    similar Disclaimer requirement for further binary redistribution.
17  *
18  * NO WARRANTY
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
22  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
24  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29  * THE POSSIBILITY OF SUCH DAMAGES.
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 /* extracting the seqno from buffer seqno */
73 #define	SEQNO(_a)	((_a) >> IEEE80211_SEQ_SEQ_SHIFT)
74 
75 /*
76  * Whether the current sequence number is within the
77  * BAW.
78  */
79 #define	BAW_WITHIN(_start, _bawsz, _seqno)	\
80 	    ((((_seqno) - (_start)) & 4095) < (_bawsz))
81 
82 /*
83  * Maximum aggregate size
84  */
85 #define	ATH_AGGR_MAXSIZE	65530
86 
87 extern void ath_tx_node_flush(struct ath_softc *sc, struct ath_node *an);
88 extern void ath_tx_txq_drain(struct ath_softc *sc, struct ath_txq *txq);
89 extern void ath_txfrag_cleanup(struct ath_softc *sc, ath_bufhead *frags,
90     struct ieee80211_node *ni);
91 extern int ath_txfrag_setup(struct ath_softc *sc, ath_bufhead *frags,
92     struct mbuf *m0, struct ieee80211_node *ni);
93 extern int ath_tx_start(struct ath_softc *sc, struct ieee80211_node *ni,
94     struct ath_buf *bf, struct mbuf *m0);
95 extern int ath_raw_xmit(struct ieee80211_node *ni, struct mbuf *m,
96     const struct ieee80211_bpf_params *params);
97 
98 /* software queue stuff */
99 extern void ath_tx_swq(struct ath_softc *sc, struct ieee80211_node *ni,
100     struct ath_txq *txq, int queue_to_head, struct ath_buf *bf);
101 extern void ath_tx_tid_init(struct ath_softc *sc, struct ath_node *an);
102 extern void ath_tx_tid_hw_queue_aggr(struct ath_softc *sc, struct ath_node *an,
103     struct ath_tid *tid);
104 extern void ath_tx_tid_hw_queue_norm(struct ath_softc *sc, struct ath_node *an,
105     struct ath_tid *tid);
106 extern void ath_txq_sched(struct ath_softc *sc, struct ath_txq *txq);
107 extern void ath_tx_normal_comp(struct ath_softc *sc, struct ath_buf *bf,
108     int fail);
109 extern void ath_tx_aggr_comp(struct ath_softc *sc, struct ath_buf *bf,
110     int fail);
111 extern void ath_tx_addto_baw(struct ath_softc *sc, struct ath_node *an,
112     struct ath_tid *tid, struct ath_buf *bf);
113 extern struct ieee80211_tx_ampdu * ath_tx_get_tx_tid(struct ath_node *an,
114     int tid);
115 extern void ath_tx_tid_sched(struct ath_softc *sc, struct ath_tid *tid);
116 
117 /* TX addba handling */
118 extern	int ath_addba_request(struct ieee80211_node *ni,
119     struct ieee80211_tx_ampdu *tap, int dialogtoken,
120     int baparamset, int batimeout);
121 extern	int ath_addba_response(struct ieee80211_node *ni,
122     struct ieee80211_tx_ampdu *tap, int dialogtoken,
123     int code, int batimeout);
124 extern	void ath_addba_stop(struct ieee80211_node *ni,
125     struct ieee80211_tx_ampdu *tap);
126 extern	void ath_bar_response(struct ieee80211_node *ni,
127      struct ieee80211_tx_ampdu *tap, int status);
128 extern	void ath_addba_response_timeout(struct ieee80211_node *ni,
129     struct ieee80211_tx_ampdu *tap);
130 
131 /*
132  * AP mode power save handling (of stations)
133  */
134 extern	void ath_tx_node_sleep(struct ath_softc *sc, struct ath_node *an);
135 extern	void ath_tx_node_wakeup(struct ath_softc *sc, struct ath_node *an);
136 extern	int ath_tx_node_is_asleep(struct ath_softc *sc, struct ath_node *an);
137 extern	void ath_tx_node_reassoc(struct ath_softc *sc, struct ath_node *an);
138 
139 /*
140  * Hardware queue stuff
141  */
142 extern	void ath_tx_push_pending(struct ath_softc *sc, struct ath_txq *txq);
143 
144 /*
145  * Misc debugging stuff
146  */
147 #ifdef	ATH_DEBUG_ALQ
148 extern	void ath_tx_alq_post(struct ath_softc *sc, struct ath_buf *bf_first);
149 #endif	/* ATH_DEBUG_ALQ */
150 
151 /*
152  * Setup path
153  */
154 #define	ath_txdma_setup(_sc)			\
155 	(_sc)->sc_tx.xmit_setup(_sc)
156 #define	ath_txdma_teardown(_sc)			\
157 	(_sc)->sc_tx.xmit_teardown(_sc)
158 #define	ath_txq_restart_dma(_sc, _txq)		\
159 	(_sc)->sc_tx.xmit_dma_restart((_sc), (_txq))
160 #define	ath_tx_handoff(_sc, _txq, _bf)		\
161 	(_sc)->sc_tx.xmit_handoff((_sc), (_txq), (_bf))
162 #define	ath_draintxq(_sc, _rtype)		\
163 	(_sc)->sc_tx.xmit_drain((_sc), (_rtype))
164 
165 extern	void ath_xmit_setup_legacy(struct ath_softc *sc);
166 
167 #endif
168