New upstream snapshot.
[debian/madwifi.git] / ath_rate / onoe / onoe.c
1 /*-
2  * Copyright (c) 2002-2005 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  * 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  * $Id: onoe.c 4162 2011-08-03 06:25:42Z proski $
37  */
38
39 /*
40  * Atsushi Onoe's rate control algorithm.
41  */
42 #if !defined(AUTOCONF_INCLUDED) && !defined(CONFIG_LOCALVERSION)
43 #include <linux/config.h>
44 #endif
45 #include <linux/version.h>
46 #include <linux/module.h>
47 #include <linux/init.h>
48 #include <linux/skbuff.h>
49 #include <linux/netdevice.h>
50 #include <linux/random.h>
51 #include <linux/delay.h>
52 #include <linux/cache.h>
53 #include <linux/sysctl.h>
54 #include <linux/proc_fs.h>
55 #include <linux/if_arp.h>
56
57 #include <asm/uaccess.h>
58
59 #include <net80211/if_media.h>
60 #include <net80211/ieee80211_var.h>
61 #include <net80211/ieee80211_rate.h>
62
63 #include "if_athvar.h"
64 #include "ah_desc.h"
65
66 #include "onoe.h"
67
68 #define ONOE_DEBUG
69 #ifdef ONOE_DEBUG
70 enum {
71         ATH_DEBUG_RATE  = 0x00000010,   /* rate control */
72 };
73 #define DPRINTF(sc, _fmt, ...) do {                             \
74         if (sc->sc_debug & ATH_DEBUG_RATE)                      \
75                 printk(_fmt, __VA_ARGS__);                      \
76 } while (0)
77 #else
78 #define DPRINTF(sc, _fmt, ...)
79 #endif
80
81 #include "release.h"
82 static char *version = "1.0 (" RELEASE_VERSION ")";
83 static char *dev_info = "ath_rate_onoe";
84
85 /*
86  * Default parameters for the rate control algorithm.  These are
87  * all tunable with sysctls.  The rate controller runs periodically
88  * (each ath_rateinterval ms) analyzing transmit statistics for each
89  * neighbor/station (when operating in station mode this is only the AP).
90  * If transmits look to be working well over a sampling period then
91  * it gives a "raise rate credit".  If transmits look to not be working
92  * well than it deducts a credit.  If the credits cross a threshold then
93  * the transmit rate is raised.  Various error conditions force the
94  * the transmit rate to be dropped.
95  *
96  * The decision to issue/deduct a credit is based on the errors and
97  * retries accumulated over the sampling period.  ath_rate_raise defines
98  * the percent of retransmits for which a credit is issued/deducted.
99  * ath_rate_raise_threshold defines the threshold on credits at which
100  * the transmit rate is increased.
101  *
102  * XXX this algorithm is flawed.
103  */
104 static int ath_rateinterval = 1000;             /* rate ctl interval (ms) */
105 static int ath_rate_raise = 10;                 /* add credit threshold */
106 static int ath_rate_raise_threshold = 10;       /* rate ctl raise threshold */
107
108 static void ath_rate_update(struct ath_softc *, struct ieee80211_node *, int);
109 static void ath_rate_ctl_start(struct ath_softc *, struct ieee80211_node *);
110 static void ath_rate_ctl(void *, struct ieee80211_node *);
111
112 static void
113 ath_rate_node_init(struct ath_softc *sc, struct ath_node *an)
114 {
115         /* NB: assumed to be zero'd by caller */
116         ath_rate_update(sc, &an->an_node, 0);
117 }
118
119 static void
120 ath_rate_node_cleanup(struct ath_softc *sc, struct ath_node *an)
121 {
122 }
123
124 static void
125 ath_rate_findrate(struct ath_softc *sc, struct ath_node *an,
126         int shortPreamble, size_t frameLen,
127         u_int8_t *rix, int *try0, u_int8_t *txrate)
128 {
129         struct onoe_node *on = ATH_NODE_ONOE(an);
130
131         *rix = on->on_tx_rix0;
132         *try0 = on->on_tx_try0;
133         if (shortPreamble)
134                 *txrate = on->on_tx_rate0sp;
135         else
136                 *txrate = on->on_tx_rate0;
137 }
138
139 static void
140 ath_rate_setupxtxdesc(struct ath_softc *sc, struct ath_node *an,
141         struct ath_desc *ds, int shortPreamble, size_t frame_size, u_int8_t rix)
142 {
143         struct onoe_node *on = ATH_NODE_ONOE(an);
144
145         ath_hal_setupxtxdesc(sc->sc_ah, ds
146                 , on->on_tx_rate1sp, 2  /* series 1 */
147                 , on->on_tx_rate2sp, 2  /* series 2 */
148                 , on->on_tx_rate3sp, 2  /* series 3 */
149         );
150 }
151
152 static void
153 ath_rate_tx_complete(struct ath_softc *sc,
154         struct ath_node *an, const struct ath_desc *ds)
155 {
156         struct onoe_node *on = ATH_NODE_ONOE(an);
157
158         if (ds->ds_txstat.ts_status == 0)
159                 on->on_tx_ok++;
160         else
161                 on->on_tx_err++;
162         on->on_tx_retr += ds->ds_txstat.ts_shortretry
163                         + ds->ds_txstat.ts_longretry;
164         if (jiffies >= on->on_nextcheck) {
165                 ath_rate_ctl(sc, &an->an_node);
166                 /* XXX halve rate for station mode */
167                 on->on_nextcheck = jiffies + (ath_rateinterval * HZ) / 1000;
168         }
169 }
170
171 static void
172 ath_rate_newassoc(struct ath_softc *sc, struct ath_node *an, int isnew)
173 {
174         if (isnew)
175                 ath_rate_ctl_start(sc, &an->an_node);
176 }
177
178 static void
179 ath_rate_update(struct ath_softc *sc, struct ieee80211_node *ni, int rate)
180 {
181         struct ath_node *an = ATH_NODE(ni);
182         struct onoe_node *on = ATH_NODE_ONOE(an);
183         const HAL_RATE_TABLE *rt = sc->sc_currates;
184         u_int8_t rix;
185
186         KASSERT(rt != NULL, ("no rate table, mode %u", sc->sc_curmode));
187
188         DPRINTF(sc, "%s: set xmit rate for %s to %dM\n",
189                 __func__, ether_sprintf(ni->ni_macaddr),
190                 ni->ni_rates.rs_nrates > 0 ?
191                         (ni->ni_rates.rs_rates[rate] & IEEE80211_RATE_VAL) / 2 : 0);
192
193         ni->ni_txrate = rate;
194         /*
195          * Before associating a node has no rate set setup
196          * so we can't calculate any transmit codes to use.
197          * This is ok since we should never be sending anything
198          * but management frames and those always go at the
199          * lowest hardware rate.
200          */
201         if (ni->ni_rates.rs_nrates == 0)
202                 goto done;
203         on->on_tx_rix0 = sc->sc_rixmap[ni->ni_rates.rs_rates[rate] & IEEE80211_RATE_VAL];
204         on->on_tx_rate0 = rt->info[on->on_tx_rix0].rateCode;
205         
206         on->on_tx_rate0sp = on->on_tx_rate0 |
207                 rt->info[on->on_tx_rix0].shortPreamble;
208         if (sc->sc_mrretry) {
209                 /*
210                  * Hardware supports multi-rate retry; setup two
211                  * step-down retry rates and make the lowest rate
212                  * be the ``last chance''.  We use 4, 2, 2, 2 tries
213                  * respectively (4 is set here, the rest are fixed
214                  * in the xmit routine).
215                  */
216                 on->on_tx_try0 = 1 + 3;         /* 4 tries at rate 0 */
217                 if (--rate >= 0) {
218                         rix = sc->sc_rixmap[ni->ni_rates.rs_rates[rate]&IEEE80211_RATE_VAL];
219                         on->on_tx_rate1 = rt->info[rix].rateCode;
220                         on->on_tx_rate1sp = on->on_tx_rate1 |
221                                 rt->info[rix].shortPreamble;
222                 } else
223                         on->on_tx_rate1 = on->on_tx_rate1sp = 0;
224                 if (--rate >= 0) {
225                         rix = sc->sc_rixmap[ni->ni_rates.rs_rates[rate]&IEEE80211_RATE_VAL];
226                         on->on_tx_rate2 = rt->info[rix].rateCode;
227                         on->on_tx_rate2sp = on->on_tx_rate2 |
228                                 rt->info[rix].shortPreamble;
229                 } else
230                         on->on_tx_rate2 = on->on_tx_rate2sp = 0;
231                 if (rate > 0) {
232                         /* NB: only do this if we didn't already do it above */
233                         on->on_tx_rate3 = rt->info[0].rateCode;
234                         on->on_tx_rate3sp =
235                                 on->on_tx_rate3 | rt->info[0].shortPreamble;
236                 } else
237                         on->on_tx_rate3 = on->on_tx_rate3sp = 0;
238         } else {
239                 on->on_tx_try0 = ATH_TXMAXTRY;  /* max tries at rate 0 */
240                 on->on_tx_rate1 = on->on_tx_rate1sp = 0;
241                 on->on_tx_rate2 = on->on_tx_rate2sp = 0;
242                 on->on_tx_rate3 = on->on_tx_rate3sp = 0;
243         }
244 done:
245         on->on_tx_ok = on->on_tx_err = on->on_tx_retr = on->on_tx_upper = 0;
246 }
247
248 /*
249  * Set the starting transmit rate for a node.
250  */
251 static void
252 ath_rate_ctl_start(struct ath_softc *sc, struct ieee80211_node *ni)
253 {
254 #define RATE(_ix)       (ni->ni_rates.rs_rates[(_ix)] & IEEE80211_RATE_VAL)
255         struct ieee80211vap *vap = ni->ni_vap;
256         int srate;
257
258         KASSERT(ni->ni_rates.rs_nrates > 0, ("no rates"));
259
260         if (vap->iv_fixed_rate != IEEE80211_FIXED_RATE_NONE) {
261                 /*
262                  * A fixed rate is to be used.  Find the corresponding
263                  * index in the rate table.
264                  */
265                 for (srate = 0; srate < ni->ni_rates.rs_nrates; srate++)
266                         if (vap->iv_fixed_rate ==
267                             (ni->ni_rates.rs_rates[srate] & IEEE80211_RATE_VAL)) {
268                                 ath_rate_update(sc, ni, srate);
269                                 return;
270                         }
271
272                 printk(KERN_WARNING "%s: %s: fixed rate %u%sMbps is not "
273                        "available and will be ignored\n", vap->iv_dev->name,
274                        dev_info, vap->iv_fixed_rate / 2,
275                        (vap->iv_fixed_rate & 1) ? ".5" : "");
276         }
277
278         /*
279          * No fixed rate is requested. For 11b start with
280          * the highest negotiated rate; otherwise, for 11g
281          * and 11a, we start "in the middle" at 24Mb or 36Mb.
282          */
283         srate = ni->ni_rates.rs_nrates - 1;
284         if (sc->sc_curmode != IEEE80211_MODE_11B) {
285                 /*
286                  * Scan the negotiated rate set to find the
287                  * closest rate.
288                  */
289                 /* NB: the rate set is assumed sorted */
290                 for (; srate >= 0 && RATE(srate) > 72; srate--);
291                 KASSERT(srate >= 0, ("bogus rate set"));
292         }
293
294         ath_rate_update(sc, ni, srate);
295 #undef RATE
296 }
297
298 static void
299 ath_rate_cb(void *arg, struct ieee80211_node *ni)
300 {
301         ath_rate_update(netdev_priv(ni->ni_ic->ic_dev), ni, (long) arg);
302 }
303
304 /*
305  * Reset the rate control state for each 802.11 state transition.
306  */
307 static void
308 ath_rate_newstate(struct ieee80211vap *vap, enum ieee80211_state state)
309 {
310         struct ieee80211com *ic = vap->iv_ic;
311         struct ath_softc *sc = netdev_priv(ic->ic_dev);
312         struct ieee80211_node *ni;
313
314         if (state == IEEE80211_S_INIT)
315                 return;
316         if (vap->iv_opmode == IEEE80211_M_STA) {
317                 /*
318                  * Reset local xmit state; this is really only
319                  * meaningful when operating in station mode.
320                  */
321                 ni = vap->iv_bss;
322                 if (state == IEEE80211_S_RUN) {
323                         ath_rate_ctl_start(sc, ni);
324                 } else {
325                         ath_rate_update(sc, ni, 0);
326                 }
327         } else {
328                 /*
329                  * When operating as a station the node table holds
330                  * the AP's that were discovered during scanning.
331                  * For any other operating mode we want to reset the
332                  * tx rate state of each node.
333                  */
334                 ieee80211_iterate_nodes(&ic->ic_sta, ath_rate_cb, NULL);
335                 ath_rate_update(sc, vap->iv_bss, 0);
336         }
337 }
338
339 /* 
340  * Examine and potentially adjust the transmit rate.
341  */
342 static void
343 ath_rate_ctl(void *arg, struct ieee80211_node *ni)
344 {
345         struct ath_softc *sc = arg;
346         struct onoe_node *on = ATH_NODE_ONOE(ATH_NODE(ni));
347         struct ieee80211_rateset *rs = &ni->ni_rates;
348         int dir = 0, nrate, enough;
349
350         sc->sc_stats.ast_rate_calls++;
351
352         /*
353          * Rate control
354          * XXX: very primitive version.
355          */
356         enough = (on->on_tx_ok + on->on_tx_err >= 10);
357
358         /* no packet reached -> down */
359         if (on->on_tx_err > 0 && on->on_tx_ok == 0)
360                 dir = -1;
361
362         /* all packets needs retry in average -> down */
363         if (enough && on->on_tx_ok < on->on_tx_retr)
364                 dir = -1;
365
366         /* no error and less than rate_raise% of packets need retry -> up */
367         if (enough && on->on_tx_err == 0 &&
368             on->on_tx_retr < (on->on_tx_ok * ath_rate_raise) / 100)
369                 dir = 1;
370
371         DPRINTF(sc, "%s: ok %d err %d retr %d upper %d dir %d\n",
372                 ether_sprintf(ni->ni_macaddr),
373                 on->on_tx_ok, on->on_tx_err, on->on_tx_retr,
374                 on->on_tx_upper, dir);
375
376         nrate = ni->ni_txrate;
377         switch (dir) {
378         case 0:
379                 if (enough && on->on_tx_upper > 0)
380                         on->on_tx_upper--;
381                 break;
382         case -1:
383                 if (nrate > 0) {
384                         nrate--;
385                         sc->sc_stats.ast_rate_drop++;
386                 }
387                 on->on_tx_upper = 0;
388                 break;
389         case 1:
390                 /* raise rate if we hit rate_raise_threshold */
391                 if (++on->on_tx_upper < ath_rate_raise_threshold)
392                         break;
393                 on->on_tx_upper = 0;
394                 if (nrate + 1 < rs->rs_nrates) {
395                         nrate++;
396                         sc->sc_stats.ast_rate_raise++;
397                 }
398                 break;
399         }
400
401         if (nrate != ni->ni_txrate) {
402                 DPRINTF(sc, "%s: %dM -> %dM (%d ok, %d err, %d retr)\n",
403                     __func__,
404                     (rs->rs_rates[ni->ni_txrate] & IEEE80211_RATE_VAL) / 2,
405                     (rs->rs_rates[nrate] & IEEE80211_RATE_VAL) / 2,
406                     on->on_tx_ok, on->on_tx_err, on->on_tx_retr);
407                 ath_rate_update(sc, ni, nrate);
408         } else if (enough)
409                 on->on_tx_ok = on->on_tx_err = on->on_tx_retr = 0;
410 }
411
412 static struct ath_ratectrl *
413 ath_rate_attach(struct ath_softc *sc)
414 {
415         struct onoe_softc *osc;
416
417         _MOD_INC_USE(THIS_MODULE, return NULL);
418         osc = kmalloc(sizeof(struct onoe_softc), GFP_ATOMIC);
419         if (osc == NULL) {
420                 _MOD_DEC_USE(THIS_MODULE);
421                 return NULL;
422         }
423         osc->arc.arc_space = sizeof(struct onoe_node);
424         osc->arc.arc_vap_space = 0;
425
426         return &osc->arc;
427 }
428
429 static void
430 ath_rate_detach(struct ath_ratectrl *arc)
431 {
432         struct onoe_softc *osc = (struct onoe_softc *) arc;
433
434         kfree(osc);
435         _MOD_DEC_USE(THIS_MODULE);
436 }
437
438 static int minrateinterval = 500;       /* 500ms */
439 static int maxpercent = 100;            /* 100% */
440 static int minpercent = 0;              /* 0% */
441 static int maxint = 0x7fffffff;         /* 32-bit big */
442
443 /*
444  * Static (i.e. global) sysctls.
445  */
446 static ctl_table ath_rate_static_sysctls[] = {
447         { ATH_INIT_CTL_NAME(CTL_AUTO)
448           .procname     = "interval",
449           .mode         = 0644,
450           .data         = &ath_rateinterval,
451           .maxlen       = sizeof(ath_rateinterval),
452           .extra1       = &minrateinterval,
453           .extra2       = &maxint,
454           .proc_handler = proc_dointvec_minmax
455         },
456         { ATH_INIT_CTL_NAME(CTL_AUTO)
457           .procname     = "raise",
458           .mode         = 0644,
459           .data         = &ath_rate_raise,
460           .maxlen       = sizeof(ath_rate_raise),
461           .extra1       = &minpercent,
462           .extra2       = &maxpercent,
463           .proc_handler = proc_dointvec_minmax
464         },
465         { ATH_INIT_CTL_NAME(CTL_AUTO)
466           .procname     = "raise_threshold",
467           .mode         = 0644,
468           .data         = &ath_rate_raise_threshold,
469           .maxlen       = sizeof(ath_rate_raise_threshold),
470           .proc_handler = proc_dointvec
471         },
472         { }
473 };
474 static ctl_table ath_rate_table[] = {
475         { ATH_INIT_CTL_NAME(CTL_AUTO)
476           .procname     = "rate",
477           .mode         = 0555,
478           .child        = ath_rate_static_sysctls
479         }, { }
480 };
481 static ctl_table ath_ath_table[] = {
482         { ATH_INIT_CTL_NAME(DEV_ATH)
483           .procname     = "ath",
484           .mode         = 0555,
485           .child        = ath_rate_table
486         }, { }
487 };
488 static ctl_table ath_root_table[] = {
489         { ATH_INIT_CTL_NAME(CTL_DEV)
490           .procname     = "dev",
491           .mode         = 0555,
492           .child        = ath_ath_table
493         }, { }
494 };
495 static struct ctl_table_header *ath_sysctl_header;
496
497 static struct ieee80211_rate_ops ath_rate_ops = {
498         .ratectl_id = IEEE80211_RATE_ONOE,
499         .node_init = ath_rate_node_init,
500         .node_cleanup = ath_rate_node_cleanup,
501         .findrate = ath_rate_findrate,
502         .setupxtxdesc = ath_rate_setupxtxdesc,
503         .tx_complete = ath_rate_tx_complete,
504         .newassoc = ath_rate_newassoc,
505         .newstate = ath_rate_newstate,
506         .attach = ath_rate_attach,
507         .detach = ath_rate_detach,
508 };
509
510 MODULE_AUTHOR("Errno Consulting, Sam Leffler");
511 MODULE_DESCRIPTION("Atsushi Onoe's rate control algorithm for Atheros devices");
512 #ifdef MODULE_VERSION
513 MODULE_VERSION(RELEASE_VERSION);
514 #endif
515 #ifdef MODULE_LICENSE
516 MODULE_LICENSE("Dual BSD/GPL");
517 #endif
518
519 static int __init
520 init_ath_rate_onoe(void)
521 {
522         int ret;
523         printk(KERN_INFO "%s: %s\n", dev_info, version);
524
525         ret = ieee80211_rate_register(&ath_rate_ops);
526         if (ret)
527                 return ret;
528
529         ath_sysctl_header = ATH_REGISTER_SYSCTL_TABLE(ath_root_table);
530         return (0);
531 }
532 module_init(init_ath_rate_onoe);
533
534 static void __exit
535 exit_ath_rate_onoe(void)
536 {
537         if (ath_sysctl_header != NULL)
538                 unregister_sysctl_table(ath_sysctl_header);
539         ieee80211_rate_unregister(&ath_rate_ops);
540
541         printk(KERN_INFO "%s: unloaded\n", dev_info);
542 }
543 module_exit(exit_ath_rate_onoe);