Home | History | Annotate | Line # | Download | only in ic
athrate-sample.h revision 1.1
      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: src/sys/dev/ath/ath_rate/sample/sample.h,v 1.3 2005/03/20 01:27:33 sam Exp $
     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 state */
     48 	int	ath_smoothing_rate;	/* ewma percentage (out of 100) */
     49 	int	ath_sample_rate;	/* send a different bit-rate 1/X packets */
     50 };
     51 #define	ATH_SOFTC_SAMPLE(sc)	((struct sample_softc *)sc->sc_rc)
     52 
     53 struct rate_info {
     54 	int rate;
     55 	int rix;
     56 	int rateCode;
     57 	int shortPreambleRateCode;
     58 };
     59 
     60 
     61 struct rate_stats {
     62 	unsigned average_tx_time;
     63 	int successive_failures;
     64 	int tries;
     65 	int total_packets;
     66 	int packets_acked;
     67 	unsigned perfect_tx_time; /* transmit time for 0 retries */
     68 	int last_tx;
     69 };
     70 
     71 /*
     72  * for now, we track performance for three different packet
     73  * size buckets
     74  */
     75 #define NUM_PACKET_SIZE_BINS 3
     76 static int packet_size_bins[NUM_PACKET_SIZE_BINS] = {250, 1600, 3000};
     77 
     78 /* per-node state */
     79 struct sample_node {
     80 	int static_rate_ndx;
     81 	int num_rates;
     82 
     83 	struct rate_info rates[IEEE80211_RATE_MAXSIZE];
     84 
     85 	struct rate_stats stats[NUM_PACKET_SIZE_BINS][IEEE80211_RATE_MAXSIZE];
     86 	int last_sample_ndx[NUM_PACKET_SIZE_BINS];
     87 
     88 	int current_sample_ndx[NUM_PACKET_SIZE_BINS];
     89 	int packets_sent[NUM_PACKET_SIZE_BINS];
     90 
     91 	int current_rate[NUM_PACKET_SIZE_BINS];
     92 	int packets_since_switch[NUM_PACKET_SIZE_BINS];
     93 	unsigned jiffies_since_switch[NUM_PACKET_SIZE_BINS];
     94 
     95 	int packets_since_sample[NUM_PACKET_SIZE_BINS];
     96 	unsigned sample_tt[NUM_PACKET_SIZE_BINS];
     97 };
     98 #define	ATH_NODE_SAMPLE(an)	((struct sample_node *)&an[1])
     99 
    100 #ifndef MIN
    101 #define	MIN(a,b)	((a) < (b) ? (a) : (b))
    102 #endif
    103 #ifndef MAX
    104 #define	MAX(a,b)	((a) > (b) ? (a) : (b))
    105 #endif
    106 
    107 #define WIFI_CW_MIN 31
    108 #define WIFI_CW_MAX 1023
    109 
    110 struct ar5212_desc {
    111 	/*
    112 	 * tx_control_0
    113 	 */
    114 	u_int32_t	frame_len:12;
    115 	u_int32_t	reserved_12_15:4;
    116 	u_int32_t	xmit_power:6;
    117 	u_int32_t	rts_cts_enable:1;
    118 	u_int32_t	veol:1;
    119 	u_int32_t	clear_dest_mask:1;
    120 	u_int32_t	ant_mode_xmit:4;
    121 	u_int32_t	inter_req:1;
    122 	u_int32_t	encrypt_key_valid:1;
    123 	u_int32_t	cts_enable:1;
    124 
    125 	/*
    126 	 * tx_control_1
    127 	 */
    128 	u_int32_t	buf_len:12;
    129 	u_int32_t	more:1;
    130 	u_int32_t	encrypt_key_index:7;
    131 	u_int32_t	frame_type:4;
    132 	u_int32_t	no_ack:1;
    133 	u_int32_t	comp_proc:2;
    134 	u_int32_t	comp_iv_len:2;
    135 	u_int32_t	comp_icv_len:2;
    136 	u_int32_t	reserved_31:1;
    137 
    138 	/*
    139 	 * tx_control_2
    140 	 */
    141 	u_int32_t	rts_duration:15;
    142 	u_int32_t	duration_update_enable:1;
    143 	u_int32_t	xmit_tries0:4;
    144 	u_int32_t	xmit_tries1:4;
    145 	u_int32_t	xmit_tries2:4;
    146 	u_int32_t	xmit_tries3:4;
    147 
    148 	/*
    149 	 * tx_control_3
    150 	 */
    151 	u_int32_t	xmit_rate0:5;
    152 	u_int32_t	xmit_rate1:5;
    153 	u_int32_t	xmit_rate2:5;
    154 	u_int32_t	xmit_rate3:5;
    155 	u_int32_t	rts_cts_rate:5;
    156 	u_int32_t	reserved_25_31:7;
    157 
    158 	/*
    159 	 * tx_status_0
    160 	 */
    161 	u_int32_t	frame_xmit_ok:1;
    162 	u_int32_t	excessive_retries:1;
    163 	u_int32_t	fifo_underrun:1;
    164 	u_int32_t	filtered:1;
    165 	u_int32_t	rts_fail_count:4;
    166 	u_int32_t	data_fail_count:4;
    167 	u_int32_t	virt_coll_count:4;
    168 	u_int32_t	send_timestamp:16;
    169 
    170 	/*
    171 	 * tx_status_1
    172 	 */
    173 	u_int32_t	done:1;
    174 	u_int32_t	seq_num:12;
    175 	u_int32_t	ack_sig_strength:8;
    176 	u_int32_t	final_ts_index:2;
    177 	u_int32_t	comp_success:1;
    178 	u_int32_t	xmit_antenna:1;
    179 	u_int32_t	reserved_25_31_x:7;
    180 } __packed;
    181 
    182 /*
    183  * Calculate the transmit duration of a frame.
    184  */
    185 static unsigned calc_usecs_unicast_packet(struct ath_softc *sc,
    186 				int length,
    187 				int rix, int short_retries, int long_retries) {
    188 	const HAL_RATE_TABLE *rt = sc->sc_currates;
    189 
    190 	/* pg 205 ieee.802.11.pdf */
    191 	unsigned t_slot = 20;
    192 	unsigned t_difs = 50;
    193 	unsigned t_sifs = 10;
    194 	struct ieee80211com *ic = &sc->sc_ic;
    195 	int tt = 0;
    196 	int x = 0;
    197 	int cw = WIFI_CW_MIN;
    198 	int cix = rt->info[rix].controlRate;
    199 	int rts = 0;
    200 	int cts = 0;
    201 
    202 	KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
    203 
    204 	if (rt->info[rix].phy == IEEE80211_T_OFDM) {
    205 		t_slot = 9;
    206 		t_sifs = 9;
    207 		t_difs = 28;
    208 	}
    209 
    210 	if ((ic->ic_flags & IEEE80211_F_USEPROT) &&
    211 	    rt->info[rix].phy == IEEE80211_T_OFDM) {
    212 		if (ic->ic_protmode == IEEE80211_PROT_RTSCTS)
    213 			rts = 1;
    214 		else if (ic->ic_protmode == IEEE80211_PROT_CTSONLY)
    215 			cts = 1;
    216 
    217 		cix = rt->info[sc->sc_protrix].controlRate;
    218 
    219 	}
    220 
    221 	if (length > ic->ic_rtsthreshold) {
    222 		rts = 1;
    223 	}
    224 
    225 	if (rts || cts) {
    226 		int ctsrate = rt->info[cix].rateCode;
    227 		int ctsduration = 0;
    228 		ctsrate |= rt->info[cix].shortPreamble;
    229 		if (rts)		/* SIFS + CTS */
    230 			ctsduration += rt->info[cix].spAckDuration;
    231 
    232 		ctsduration += ath_hal_computetxtime(sc->sc_ah,
    233 						     rt, length, rix, AH_TRUE);
    234 
    235 		if (cts)	/* SIFS + ACK */
    236 			ctsduration += rt->info[cix].spAckDuration;
    237 
    238 		tt += (short_retries + 1) * ctsduration;
    239 	}
    240 	tt += t_difs;
    241 	tt += (long_retries+1)*(t_sifs + rt->info[cix].spAckDuration);
    242 	tt += (long_retries+1)*ath_hal_computetxtime(sc->sc_ah, rt, length,
    243 						rix, AH_TRUE);
    244 	for (x = 0; x <= short_retries + long_retries; x++) {
    245 		cw = MIN(WIFI_CW_MAX, (cw + 1) * 2);
    246 		tt += (t_slot * cw/2);
    247 	}
    248 	return tt;
    249 }
    250 #endif /* _DEV_ATH_RATE_SAMPLE_H */
    251