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 #define RATE_CONTROL_NUM_DOWN 20
  22 #define RATE_CONTROL_NUM_UP   15
  23
  24
  25 struct rate_control_extra {
  26         /* values from rate_control_get_rate() to the caller: */
  27         struct ieee80211_rate *probe; /* probe with this rate, or NULL for no
  28                                        * probing */
  29         struct ieee80211_rate *nonerp;
  30
  31         /* parameters from the caller to rate_control_get_rate(): */
  32         struct ieee80211_hw_mode *mode;
  33         u16 ethertype;
  34 };
  35
  36
  37 struct rate_control_ops {
  38         struct module *module;
  39         const char *name;
  40         void (*tx_status)(void *priv, struct net_device *dev,
  41                           struct sk_buff *skb,
  42                           struct ieee80211_tx_status *status);
  43         struct ieee80211_rate *(*get_rate)(void *priv, struct net_device *dev,
  44                                            struct sk_buff *skb,
  45                                            struct rate_control_extra *extra);
  46         void (*rate_init)(void *priv, void *priv_sta,
  47                           struct ieee80211_local *local, struct sta_info *sta);
  48         void (*clear)(void *priv);
  49
  50         void *(*alloc)(struct ieee80211_local *local);
  51         void (*free)(void *priv);
  52         void *(*alloc_sta)(void *priv, gfp_t gfp);
  53         void (*free_sta)(void *priv, void *priv_sta);
  54
  55         int (*add_attrs)(void *priv, struct kobject *kobj);
  56         void (*remove_attrs)(void *priv, struct kobject *kobj);
  57         void (*add_sta_debugfs)(void *priv, void *priv_sta,
  58                                 struct dentry *dir);
  59         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
  60 };
  61
  62 struct rate_control_ref {
  63         struct rate_control_ops *ops;
  64         void *priv;
  65         struct kref kref;
  66 };
  67
  68 int ieee80211_rate_control_register(struct rate_control_ops *ops);
  69 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
  70
  71 /* Get a reference to the rate control algorithm. If `name' is NULL, get the
  72  * first available algorithm. */
  73 struct rate_control_ref *rate_control_alloc(const char *name,
  74                                             struct ieee80211_local *local);
  75 struct rate_control_ref *rate_control_get(struct rate_control_ref *ref);
  76 void rate_control_put(struct rate_control_ref *ref);
  77
  78 static inline void rate_control_tx_status(struct ieee80211_local *local,
  79                                           struct net_device *dev,
  80                                           struct sk_buff *skb,
  81                                           struct ieee80211_tx_status *status)
  82 {
  83         struct rate_control_ref *ref = local->rate_ctrl;
  84         ref->ops->tx_status(ref->priv, dev, skb, status);
  85 }
  86
  87
  88 static inline struct ieee80211_rate *
  89 rate_control_get_rate(struct ieee80211_local *local, struct net_device *dev,
  90                       struct sk_buff *skb, struct rate_control_extra *extra)
  91 {
  92         struct rate_control_ref *ref = local->rate_ctrl;
  93         return ref->ops->get_rate(ref->priv, dev, skb, extra);
  94 }
  95
  96
  97 static inline void rate_control_rate_init(struct sta_info *sta,
  98                                           struct ieee80211_local *local)
  99 {
 100         struct rate_control_ref *ref = sta->rate_ctrl;
 101         ref->ops->rate_init(ref->priv, sta->rate_ctrl_priv, local, sta);
 102 }
 103
 104
 105 static inline void rate_control_clear(struct ieee80211_local *local)
 106 {
 107         struct rate_control_ref *ref = local->rate_ctrl;
 108         ref->ops->clear(ref->priv);
 109 }
 110
 111 static inline void *rate_control_alloc_sta(struct rate_control_ref *ref,
 112                                            gfp_t gfp)
 113 {
 114         return ref->ops->alloc_sta(ref->priv, gfp);
 115 }
 116
 117 static inline void rate_control_free_sta(struct rate_control_ref *ref,
 118                                          void *priv)
 119 {
 120         ref->ops->free_sta(ref->priv, priv);
 121 }
 122
 123 static inline void rate_control_add_sta_debugfs(struct sta_info *sta)
 124 {
 125 #ifdef CONFIG_MAC80211_DEBUGFS
 126         struct rate_control_ref *ref = sta->rate_ctrl;
 127         if (sta->debugfs.dir && ref->ops->add_sta_debugfs)
 128                 ref->ops->add_sta_debugfs(ref->priv, sta->rate_ctrl_priv,
 129                                           sta->debugfs.dir);
 130 #endif
 131 }
 132
 133 static inline void rate_control_remove_sta_debugfs(struct sta_info *sta)
 134 {
 135 #ifdef CONFIG_MAC80211_DEBUGFS
 136         struct rate_control_ref *ref = sta->rate_ctrl;
 137         if (ref->ops->remove_sta_debugfs)
 138                 ref->ops->remove_sta_debugfs(ref->priv, sta->rate_ctrl_priv);
 139 #endif
 140 }
 141
 142
 143 /* functions for rate control related to a device */
 144 int ieee80211_init_rate_ctrl_alg(struct ieee80211_local *local,
 145                                  const char *name);
 146 void rate_control_deinitialize(struct ieee80211_local *local);
 147
 148 #endif /* IEEE80211_RATE_H */