net/mac80211/ieee80211_rate.h

   1 /*
   2  * Copyright 2002-2005, Instant802 Networks, Inc.
   3  * Copyright 2005, Devicescape Software, Inc.
   4  * Copyright (c) 2006 Jiri Benc <jbenc@suse.cz>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10
  11 #ifndef IEEE80211_RATE_H
  12 #define IEEE80211_RATE_H
  13
  14 #include <linux/netdevice.h>
  15 #include <linux/skbuff.h>
  16 #include <linux/types.h>
  17 #include <net/mac80211.h>
  18 #include "ieee80211_i.h"
  19 #include "sta_info.h"
  20
  21 /* TODO: kdoc */
  22 struct rate_selection {
  23         /* Selected transmission rate */
  24         struct ieee80211_rate *rate;
  25         /* Non-ERP rate to use if mac80211 decides it cannot use an ERP rate */
  26         struct ieee80211_rate *nonerp;
  27         /* probe with this rate, or NULL for no probing */
  28         struct ieee80211_rate *probe;
  29 };
  30
  31 struct rate_control_ops {
  32         struct module *module;
  33         const char *name;
  34         void (*tx_status)(void *priv, struct net_device *dev,
  35                           struct sk_buff *skb,
  36                           struct ieee80211_tx_status *status);
  37         void (*get_rate)(void *priv, struct net_device *dev,
  38                          struct ieee80211_supported_band *band,
  39                          struct sk_buff *skb,
  40                          struct rate_selection *sel);
  41         void (*rate_init)(void *priv, void *priv_sta,
  42                           struct ieee80211_local *local, struct sta_info *sta);
  43         void (*clear)(void *priv);
  44
  45         void *(*alloc)(struct ieee80211_local *local);
  46         void (*free)(void *priv);
  47         void *(*alloc_sta)(void *priv, gfp_t gfp);
  48         void (*free_sta)(void *priv, void *priv_sta);
  49
  50         int (*add_attrs)(void *priv, struct kobject *kobj);
  51         void (*remove_attrs)(void *priv, struct kobject *kobj);
  52         void (*add_sta_debugfs)(void *priv, void *priv_sta,
  53                                 struct dentry *dir);
  54         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
  55 };
  56
  57 struct rate_control_ref {
  58         struct rate_control_ops *ops;
  59         void *priv;
  60         struct kref kref;
  61 };
  62
  63 int ieee80211_rate_control_register(struct rate_control_ops *ops);
  64 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
  65
  66 /* Get a reference to the rate control algorithm. If `name' is NULL, get the
  67  * first available algorithm. */
  68 struct rate_control_ref *rate_control_alloc(const char *name,
  69                                             struct ieee80211_local *local);
  70 void rate_control_get_rate(struct net_device *dev,
  71                            struct ieee80211_supported_band *sband,
  72                            struct sk_buff *skb,
  73                            struct rate_selection *sel);
  74 struct rate_control_ref *rate_control_get(struct rate_control_ref *ref);
  75 void rate_control_put(struct rate_control_ref *ref);
  76
  77 static inline void rate_control_tx_status(struct net_device *dev,
  78                                           struct sk_buff *skb,
  79                                           struct ieee80211_tx_status *status)
  80 {
  81         struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
  82         struct rate_control_ref *ref = local->rate_ctrl;
  83
  84         ref->ops->tx_status(ref->priv, dev, skb, status);
  85 }
  86
  87
  88 static inline void rate_control_rate_init(struct sta_info *sta,
  89                                           struct ieee80211_local *local)
  90 {
  91         struct rate_control_ref *ref = sta->rate_ctrl;
  92         ref->ops->rate_init(ref->priv, sta->rate_ctrl_priv, local, sta);
  93 }
  94
  95
  96 static inline void rate_control_clear(struct ieee80211_local *local)
  97 {
  98         struct rate_control_ref *ref = local->rate_ctrl;
  99         ref->ops->clear(ref->priv);
 100 }
 101
 102 static inline void *rate_control_alloc_sta(struct rate_control_ref *ref,
 103                                            gfp_t gfp)
 104 {
 105         return ref->ops->alloc_sta(ref->priv, gfp);
 106 }
 107
 108 static inline void rate_control_free_sta(struct rate_control_ref *ref,
 109                                          void *priv)
 110 {
 111         ref->ops->free_sta(ref->priv, priv);
 112 }
 113
 114 static inline void rate_control_add_sta_debugfs(struct sta_info *sta)
 115 {
 116 #ifdef CONFIG_MAC80211_DEBUGFS
 117         struct rate_control_ref *ref = sta->rate_ctrl;
 118         if (sta->debugfs.dir && ref->ops->add_sta_debugfs)
 119                 ref->ops->add_sta_debugfs(ref->priv, sta->rate_ctrl_priv,
 120                                           sta->debugfs.dir);
 121 #endif
 122 }
 123
 124 static inline void rate_control_remove_sta_debugfs(struct sta_info *sta)
 125 {
 126 #ifdef CONFIG_MAC80211_DEBUGFS
 127         struct rate_control_ref *ref = sta->rate_ctrl;
 128         if (ref->ops->remove_sta_debugfs)
 129                 ref->ops->remove_sta_debugfs(ref->priv, sta->rate_ctrl_priv);
 130 #endif
 131 }
 132
 133 static inline int rate_supported(struct sta_info *sta,
 134                                  enum ieee80211_band band,
 135                                  int index)
 136 {
 137         return (sta == NULL || sta->supp_rates[band] & BIT(index));
 138 }
 139
 140 static inline int
 141 rate_lowest_index(struct ieee80211_local *local,
 142                   struct ieee80211_supported_band *sband,
 143                   struct sta_info *sta)
 144 {
 145         int i;
 146
 147         for (i = 0; i < sband->n_bitrates; i++)
 148                 if (rate_supported(sta, sband->band, i))
 149                         return i;
 150
 151         /* warn when we cannot find a rate. */
 152         WARN_ON(1);
 153
 154         return 0;
 155 }
 156
 157 static inline struct ieee80211_rate *
 158 rate_lowest(struct ieee80211_local *local,
 159             struct ieee80211_supported_band *sband,
 160             struct sta_info *sta)
 161 {
 162         return &sband->bitrates[rate_lowest_index(local, sband, sta)];
 163 }
 164
 165
 166 /* functions for rate control related to a device */
 167 int ieee80211_init_rate_ctrl_alg(struct ieee80211_local *local,
 168                                  const char *name);
 169 void rate_control_deinitialize(struct ieee80211_local *local);
 170
 171
 172 /* Rate control algorithms */
 173 #if defined(RC80211_SIMPLE_COMPILE) || \
 174         (defined(CONFIG_MAC80211_RC_SIMPLE) && \
 175          !defined(CONFIG_MAC80211_RC_SIMPLE_MODULE))
 176 extern int rc80211_simple_init(void);
 177 extern void rc80211_simple_exit(void);
 178 #else
 179 static inline int rc80211_simple_init(void)
 180 {
 181         return 0;
 182 }
 183 static inline void rc80211_simple_exit(void)
 184 {
 185 }
 186 #endif
 187
 188 #if defined(RC80211_PID_COMPILE) || \
 189         (defined(CONFIG_MAC80211_RC_PID) && \
 190          !defined(CONFIG_MAC80211_RC_PID_MODULE))
 191 extern int rc80211_pid_init(void);
 192 extern void rc80211_pid_exit(void);
 193 #else
 194 static inline int rc80211_pid_init(void)
 195 {
 196         return 0;
 197 }
 198 static inline void rc80211_pid_exit(void)
 199 {
 200 }
 201 #endif
 202
 203 #endif /* IEEE80211_RATE_H */