xref: /freebsd/sys/dev/ath/ath_rate/sample/sample.h (revision 3ef51c5fb9163f2aafb1c14729e06a8bf0c4d113)
1 /*-
2  * Copyright (c) 2005 John Bicket
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  * 3. Neither the names of the above-listed copyright holders nor the names
16  *    of any contributors may be used to endorse or promote products derived
17  *    from this software without specific prior written permission.
18  *
19  * Alternatively, this software may be distributed under the terms of the
20  * GNU General Public License ("GPL") version 2 as published by the Free
21  * Software Foundation.
22  *
23  * NO WARRANTY
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
27  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
28  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
29  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
32  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
34  * THE POSSIBILITY OF SUCH DAMAGES.
35  *
36  * $FreeBSD$
37  */
38 
39 /*
40  * Defintions for the Atheros Wireless LAN controller driver.
41  */
42 #ifndef _DEV_ATH_RATE_SAMPLE_H
43 #define _DEV_ATH_RATE_SAMPLE_H
44 
45 /* per-device state */
46 struct sample_softc {
47 	struct ath_ratectrl arc;	/* base class */
48 	int	smoothing_rate;		/* ewma percentage [0..99] */
49 	int	smoothing_minpackets;
50 	int	sample_rate;		/* %time to try different tx rates */
51 	int	max_successive_failures;
52 	int	stale_failure_timeout;	/* how long to honor max_successive_failures */
53 	int	min_switch;		/* min time between rate changes */
54 	int	min_good_pct;		/* min good percentage for a rate to be considered */
55 };
56 #define	ATH_SOFTC_SAMPLE(sc)	((struct sample_softc *)sc->sc_rc)
57 
58 struct rate_stats {
59 	unsigned average_tx_time;
60 	int successive_failures;
61 	uint64_t tries;
62 	uint64_t total_packets;	/* pkts total since assoc */
63 	uint64_t packets_acked;	/* pkts acked since assoc */
64 	int ewma_pct;	/* EWMA percentage */
65 	unsigned perfect_tx_time; /* transmit time for 0 retries */
66 	int last_tx;
67 };
68 
69 struct txschedule {
70 	uint8_t	t0, r0;		/* series 0: tries, rate code */
71 	uint8_t	t1, r1;		/* series 1: tries, rate code */
72 	uint8_t	t2, r2;		/* series 2: tries, rate code */
73 	uint8_t	t3, r3;		/* series 3: tries, rate code */
74 };
75 
76 /*
77  * for now, we track performance for three different packet
78  * size buckets
79  */
80 #define NUM_PACKET_SIZE_BINS 2
81 
82 /* per-node state */
83 struct sample_node {
84 	int static_rix;			/* rate index of fixed tx rate */
85 #define	SAMPLE_MAXRATES	32		/* NB: corresponds to hal info[32] */
86 	uint32_t ratemask;		/* bit mask of valid rate indices */
87 	const struct txschedule *sched;	/* tx schedule table */
88 
89 	const HAL_RATE_TABLE *currates;
90 
91 	struct rate_stats stats[NUM_PACKET_SIZE_BINS][SAMPLE_MAXRATES];
92 	int last_sample_rix[NUM_PACKET_SIZE_BINS];
93 
94 	int current_sample_rix[NUM_PACKET_SIZE_BINS];
95 	int packets_sent[NUM_PACKET_SIZE_BINS];
96 
97 	int current_rix[NUM_PACKET_SIZE_BINS];
98 	int packets_since_switch[NUM_PACKET_SIZE_BINS];
99 	unsigned ticks_since_switch[NUM_PACKET_SIZE_BINS];
100 
101 	int packets_since_sample[NUM_PACKET_SIZE_BINS];
102 	unsigned sample_tt[NUM_PACKET_SIZE_BINS];
103 };
104 #define	ATH_NODE_SAMPLE(an)	((struct sample_node *)&(an)[1])
105 #define	IS_RATE_DEFINED(sn, rix)	(((sn)->ratemask & (1<<(rix))) != 0)
106 
107 #ifndef MIN
108 #define	MIN(a,b)	((a) < (b) ? (a) : (b))
109 #endif
110 #ifndef MAX
111 #define	MAX(a,b)	((a) > (b) ? (a) : (b))
112 #endif
113 
114 #define WIFI_CW_MIN 31
115 #define WIFI_CW_MAX 1023
116 
117 /*
118  * Calculate the transmit duration of a frame.
119  */
120 static unsigned calc_usecs_unicast_packet(struct ath_softc *sc,
121 				int length,
122 				int rix, int short_retries,
123 				int long_retries, int is_ht40)
124 {
125 	const HAL_RATE_TABLE *rt = sc->sc_currates;
126 	struct ifnet *ifp = sc->sc_ifp;
127 	struct ieee80211com *ic = ifp->if_l2com;
128 	int rts, cts;
129 
130 	unsigned t_slot = 20;
131 	unsigned t_difs = 50;
132 	unsigned t_sifs = 10;
133 	int tt = 0;
134 	int x = 0;
135 	int cw = WIFI_CW_MIN;
136 	int cix;
137 
138 	KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
139 
140 	if (rix >= rt->rateCount) {
141 		printf("bogus rix %d, max %u, mode %u\n",
142 		       rix, rt->rateCount, sc->sc_curmode);
143 		return 0;
144 	}
145 	cix = rt->info[rix].controlRate;
146 	/*
147 	 * XXX getting mac/phy level timings should be fixed for turbo
148 	 * rates, and there is probably a way to get this from the
149 	 * hal...
150 	 */
151 	switch (rt->info[rix].phy) {
152 	case IEEE80211_T_OFDM:
153 		t_slot = 9;
154 		t_sifs = 16;
155 		t_difs = 28;
156 		/* fall through */
157 	case IEEE80211_T_TURBO:
158 		t_slot = 9;
159 		t_sifs = 8;
160 		t_difs = 28;
161 		break;
162 	case IEEE80211_T_HT:
163 		t_slot = 9;
164 		t_sifs = 8;
165 		t_difs = 28;
166 		break;
167 	case IEEE80211_T_DS:
168 		/* fall through to default */
169 	default:
170 		/* pg 205 ieee.802.11.pdf */
171 		t_slot = 20;
172 		t_difs = 50;
173 		t_sifs = 10;
174 	}
175 
176 	rts = cts = 0;
177 
178 	if ((ic->ic_flags & IEEE80211_F_USEPROT) &&
179 	    rt->info[rix].phy == IEEE80211_T_OFDM) {
180 		if (ic->ic_protmode == IEEE80211_PROT_RTSCTS)
181 			rts = 1;
182 		else if (ic->ic_protmode == IEEE80211_PROT_CTSONLY)
183 			cts = 1;
184 
185 		cix = rt->info[sc->sc_protrix].controlRate;
186 	}
187 
188 	if (0 /*length > ic->ic_rtsthreshold */) {
189 		rts = 1;
190 	}
191 
192 	if (rts || cts) {
193 		int ctsrate;
194 		int ctsduration = 0;
195 
196 		/* NB: this is intentionally not a runtime check */
197 		KASSERT(cix < rt->rateCount,
198 		    ("bogus cix %d, max %u, mode %u\n", cix, rt->rateCount,
199 		     sc->sc_curmode));
200 
201 		ctsrate = rt->info[cix].rateCode | rt->info[cix].shortPreamble;
202 		if (rts)		/* SIFS + CTS */
203 			ctsduration += rt->info[cix].spAckDuration;
204 
205 		/* XXX assumes short preamble */
206 		ctsduration += ath_hal_pkt_txtime(sc->sc_ah, rt, length, rix,
207 		    is_ht40, 0);
208 
209 		if (cts)	/* SIFS + ACK */
210 			ctsduration += rt->info[cix].spAckDuration;
211 
212 		tt += (short_retries + 1) * ctsduration;
213 	}
214 	tt += t_difs;
215 
216 	/* XXX assumes short preamble */
217 	tt += (long_retries+1)*ath_hal_pkt_txtime(sc->sc_ah, rt, length, rix,
218 	    is_ht40, 0);
219 
220 	tt += (long_retries+1)*(t_sifs + rt->info[rix].spAckDuration);
221 
222 	for (x = 0; x <= short_retries + long_retries; x++) {
223 		cw = MIN(WIFI_CW_MAX, (cw + 1) * 2);
224 		tt += (t_slot * cw/2);
225 	}
226 	return tt;
227 }
228 #endif /* _DEV_ATH_RATE_SAMPLE_H */
229