xref: /freebsd/sys/dev/ath/ath_rate/sample/sample.h (revision 10b59a9b4add0320d52c15ce057dd697261e7dfc)
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 	struct rate_stats stats[NUM_PACKET_SIZE_BINS][SAMPLE_MAXRATES];
90 	int last_sample_rix[NUM_PACKET_SIZE_BINS];
91 
92 	int current_sample_rix[NUM_PACKET_SIZE_BINS];
93 	int packets_sent[NUM_PACKET_SIZE_BINS];
94 
95 	int current_rix[NUM_PACKET_SIZE_BINS];
96 	int packets_since_switch[NUM_PACKET_SIZE_BINS];
97 	unsigned ticks_since_switch[NUM_PACKET_SIZE_BINS];
98 
99 	int packets_since_sample[NUM_PACKET_SIZE_BINS];
100 	unsigned sample_tt[NUM_PACKET_SIZE_BINS];
101 };
102 #define	ATH_NODE_SAMPLE(an)	((struct sample_node *)&(an)[1])
103 #define	IS_RATE_DEFINED(sn, rix)	(((sn)->ratemask & (1<<(rix))) != 0)
104 
105 #ifndef MIN
106 #define	MIN(a,b)	((a) < (b) ? (a) : (b))
107 #endif
108 #ifndef MAX
109 #define	MAX(a,b)	((a) > (b) ? (a) : (b))
110 #endif
111 
112 #define WIFI_CW_MIN 31
113 #define WIFI_CW_MAX 1023
114 
115 /*
116  * Calculate the transmit duration of a frame.
117  */
118 static unsigned calc_usecs_unicast_packet(struct ath_softc *sc,
119 				int length,
120 				int rix, int short_retries,
121 				int long_retries, int is_ht40)
122 {
123 	const HAL_RATE_TABLE *rt = sc->sc_currates;
124 	struct ifnet *ifp = sc->sc_ifp;
125 	struct ieee80211com *ic = ifp->if_l2com;
126 	int rts, cts;
127 
128 	unsigned t_slot = 20;
129 	unsigned t_difs = 50;
130 	unsigned t_sifs = 10;
131 	int tt = 0;
132 	int x = 0;
133 	int cw = WIFI_CW_MIN;
134 	int cix;
135 
136 	KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
137 
138 	if (rix >= rt->rateCount) {
139 		printf("bogus rix %d, max %u, mode %u\n",
140 		       rix, rt->rateCount, sc->sc_curmode);
141 		return 0;
142 	}
143 	cix = rt->info[rix].controlRate;
144 	/*
145 	 * XXX getting mac/phy level timings should be fixed for turbo
146 	 * rates, and there is probably a way to get this from the
147 	 * hal...
148 	 */
149 	switch (rt->info[rix].phy) {
150 	case IEEE80211_T_OFDM:
151 		t_slot = 9;
152 		t_sifs = 16;
153 		t_difs = 28;
154 		/* fall through */
155 	case IEEE80211_T_TURBO:
156 		t_slot = 9;
157 		t_sifs = 8;
158 		t_difs = 28;
159 		break;
160 	case IEEE80211_T_HT:
161 		t_slot = 9;
162 		t_sifs = 8;
163 		t_difs = 28;
164 		break;
165 	case IEEE80211_T_DS:
166 		/* fall through to default */
167 	default:
168 		/* pg 205 ieee.802.11.pdf */
169 		t_slot = 20;
170 		t_difs = 50;
171 		t_sifs = 10;
172 	}
173 
174 	rts = cts = 0;
175 
176 	if ((ic->ic_flags & IEEE80211_F_USEPROT) &&
177 	    rt->info[rix].phy == IEEE80211_T_OFDM) {
178 		if (ic->ic_protmode == IEEE80211_PROT_RTSCTS)
179 			rts = 1;
180 		else if (ic->ic_protmode == IEEE80211_PROT_CTSONLY)
181 			cts = 1;
182 
183 		cix = rt->info[sc->sc_protrix].controlRate;
184 	}
185 
186 	if (0 /*length > ic->ic_rtsthreshold */) {
187 		rts = 1;
188 	}
189 
190 	if (rts || cts) {
191 		int ctsrate;
192 		int ctsduration = 0;
193 
194 		/* NB: this is intentionally not a runtime check */
195 		KASSERT(cix < rt->rateCount,
196 		    ("bogus cix %d, max %u, mode %u\n", cix, rt->rateCount,
197 		     sc->sc_curmode));
198 
199 		ctsrate = rt->info[cix].rateCode | rt->info[cix].shortPreamble;
200 		if (rts)		/* SIFS + CTS */
201 			ctsduration += rt->info[cix].spAckDuration;
202 
203 		/* XXX assumes short preamble */
204 		ctsduration += ath_hal_pkt_txtime(sc->sc_ah, rt, length, rix,
205 		    is_ht40, 0);
206 
207 		if (cts)	/* SIFS + ACK */
208 			ctsduration += rt->info[cix].spAckDuration;
209 
210 		tt += (short_retries + 1) * ctsduration;
211 	}
212 	tt += t_difs;
213 
214 	/* XXX assumes short preamble */
215 	tt += (long_retries+1)*ath_hal_pkt_txtime(sc->sc_ah, rt, length, rix,
216 	    is_ht40, 0);
217 
218 	tt += (long_retries+1)*(t_sifs + rt->info[rix].spAckDuration);
219 
220 	for (x = 0; x <= short_retries + long_retries; x++) {
221 		cw = MIN(WIFI_CW_MAX, (cw + 1) * 2);
222 		tt += (t_slot * cw/2);
223 	}
224 	return tt;
225 }
226 #endif /* _DEV_ATH_RATE_SAMPLE_H */
227