sys/net80211/ieee80211_ratectl.h

   1 /*-
   2  * Copyright (c) 2010 Rui Paulo <rpaulo@FreeBSD.org>
   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  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 enum ieee80211_ratealgs {
  29         IEEE80211_RATECTL_AMRR          = 0,
  30         IEEE80211_RATECTL_RSSADAPT      = 1,
  31         IEEE80211_RATECTL_ONOE          = 2,
  32         IEEE80211_RATECTL_SAMPLE        = 3,
  33         IEEE80211_RATECTL_NONE          = 4,
  34         IEEE80211_RATECTL_MAX
  35 };
  36
  37 #define IEEE80211_RATECTL_TX_SUCCESS    1
  38 #define IEEE80211_RATECTL_TX_FAILURE    0
  39
  40 struct ieee80211_ratectl {
  41         const char *ir_name;
  42         int     (*ir_attach)(const struct ieee80211vap *);
  43         void    (*ir_detach)(const struct ieee80211vap *);
  44         void    (*ir_init)(struct ieee80211vap *);
  45         void    (*ir_deinit)(struct ieee80211vap *);
  46         void    (*ir_node_init)(struct ieee80211_node *);
  47         void    (*ir_node_deinit)(struct ieee80211_node *);
  48         int     (*ir_rate)(struct ieee80211_node *, void *, uint32_t);
  49         void    (*ir_tx_complete)(const struct ieee80211vap *,
  50                                   const struct ieee80211_node *, int,
  51                                   void *, void *);
  52         void    (*ir_tx_update)(const struct ieee80211vap *,
  53                                 const struct ieee80211_node *,
  54                                 void *, void *, void *);
  55         void    (*ir_setinterval)(const struct ieee80211vap *, int);
  56         void    (*ir_node_stats)(struct ieee80211_node *ni, struct sbuf *s);
  57 };
  58
  59 void    ieee80211_ratectl_register(int, const struct ieee80211_ratectl *);
  60 void    ieee80211_ratectl_unregister(int);
  61 void    ieee80211_ratectl_init(struct ieee80211vap *);
  62 void    ieee80211_ratectl_set(struct ieee80211vap *, int);
  63
  64 MALLOC_DECLARE(M_80211_RATECTL);
  65
  66 static __inline void
  67 ieee80211_ratectl_deinit(struct ieee80211vap *vap)
  68 {
  69         vap->iv_rate->ir_deinit(vap);
  70 }
  71
  72 static __inline void
  73 ieee80211_ratectl_node_init(struct ieee80211_node *ni)
  74 {
  75         const struct ieee80211vap *vap = ni->ni_vap;
  76
  77         vap->iv_rate->ir_node_init(ni);
  78 }
  79
  80 static __inline void
  81 ieee80211_ratectl_node_deinit(struct ieee80211_node *ni)
  82 {
  83         const struct ieee80211vap *vap = ni->ni_vap;
  84
  85         vap->iv_rate->ir_node_deinit(ni);
  86 }
  87
  88 static int __inline
  89 ieee80211_ratectl_rate(struct ieee80211_node *ni, void *arg, uint32_t iarg)
  90 {
  91         const struct ieee80211vap *vap = ni->ni_vap;
  92
  93         return vap->iv_rate->ir_rate(ni, arg, iarg);
  94 }
  95
  96 static __inline void
  97 ieee80211_ratectl_tx_complete(const struct ieee80211vap *vap,
  98     const struct ieee80211_node *ni, int status, void *arg1, void *arg2)
  99 {
 100         vap->iv_rate->ir_tx_complete(vap, ni, status, arg1, arg2);
 101 }
 102
 103 static __inline void
 104 ieee80211_ratectl_tx_update(const struct ieee80211vap *vap,
 105     const struct ieee80211_node *ni, void *arg1, void *arg2, void *arg3)
 106 {
 107         if (vap->iv_rate->ir_tx_update == NULL)
 108                 return;
 109         vap->iv_rate->ir_tx_update(vap, ni, arg1, arg2, arg3);
 110 }
 111
 112 static __inline void
 113 ieee80211_ratectl_setinterval(const struct ieee80211vap *vap, int msecs)
 114 {
 115         if (vap->iv_rate->ir_setinterval == NULL)
 116                 return;
 117         vap->iv_rate->ir_setinterval(vap, msecs);
 118 }
 119
 120 static __inline void
 121 ieee80211_ratectl_node_stats(struct ieee80211_node *ni, struct sbuf *s)
 122 {
 123         const struct ieee80211vap *vap = ni->ni_vap;
 124
 125         if (vap->iv_rate->ir_node_stats == NULL)
 126                 return;
 127         vap->iv_rate->ir_node_stats(ni, s);
 128 }