2 * Copyright 2002-2005, Instant802 Networks, Inc.
3 * Copyright 2005, Devicescape Software, Inc.
4 * Copyright (c) 2006 Jiri Benc <jbenc@suse.cz>
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.
11 #ifndef IEEE80211_RATE_H
12 #define IEEE80211_RATE_H
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"
21 struct rate_selection {
22 /* Selected transmission rate */
23 struct ieee80211_rate *rate;
24 /* Non-ERP rate to use if mac80211 decides it cannot use an ERP rate */
25 struct ieee80211_rate *nonerp;
26 /* probe with this rate, or NULL for no probing */
27 struct ieee80211_rate *probe;
30 struct rate_control_ops {
31 struct module *module;
33 void (*tx_status)(void *priv, struct net_device *dev,
35 struct ieee80211_tx_status *status);
36 void (*get_rate)(void *priv, struct net_device *dev,
37 struct ieee80211_hw_mode *mode, struct sk_buff *skb,
38 struct rate_selection *sel);
39 void (*rate_init)(void *priv, void *priv_sta,
40 struct ieee80211_local *local, struct sta_info *sta);
41 void (*clear)(void *priv);
43 void *(*alloc)(struct ieee80211_local *local);
44 void (*free)(void *priv);
45 void *(*alloc_sta)(void *priv, gfp_t gfp);
46 void (*free_sta)(void *priv, void *priv_sta);
48 int (*add_attrs)(void *priv, struct kobject *kobj);
49 void (*remove_attrs)(void *priv, struct kobject *kobj);
50 void (*add_sta_debugfs)(void *priv, void *priv_sta,
52 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
55 struct rate_control_ref {
56 struct rate_control_ops *ops;
61 /* default 'simple' algorithm */
62 extern struct rate_control_ops mac80211_rcsimple;
65 extern struct rate_control_ops mac80211_rcpid;
67 int ieee80211_rate_control_register(struct rate_control_ops *ops);
68 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
70 /* Get a reference to the rate control algorithm. If `name' is NULL, get the
71 * first available algorithm. */
72 struct rate_control_ref *rate_control_alloc(const char *name,
73 struct ieee80211_local *local);
74 void rate_control_get_rate(struct net_device *dev,
75 struct ieee80211_hw_mode *mode, struct sk_buff *skb,
76 struct rate_selection *sel);
77 struct rate_control_ref *rate_control_get(struct rate_control_ref *ref);
78 void rate_control_put(struct rate_control_ref *ref);
80 static inline void rate_control_tx_status(struct net_device *dev,
82 struct ieee80211_tx_status *status)
84 struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
85 struct rate_control_ref *ref = local->rate_ctrl;
87 ref->ops->tx_status(ref->priv, dev, skb, status);
91 static inline void rate_control_rate_init(struct sta_info *sta,
92 struct ieee80211_local *local)
94 struct rate_control_ref *ref = sta->rate_ctrl;
95 ref->ops->rate_init(ref->priv, sta->rate_ctrl_priv, local, sta);
99 static inline void rate_control_clear(struct ieee80211_local *local)
101 struct rate_control_ref *ref = local->rate_ctrl;
102 ref->ops->clear(ref->priv);
105 static inline void *rate_control_alloc_sta(struct rate_control_ref *ref,
108 return ref->ops->alloc_sta(ref->priv, gfp);
111 static inline void rate_control_free_sta(struct rate_control_ref *ref,
114 ref->ops->free_sta(ref->priv, priv);
117 static inline void rate_control_add_sta_debugfs(struct sta_info *sta)
119 #ifdef CONFIG_MAC80211_DEBUGFS
120 struct rate_control_ref *ref = sta->rate_ctrl;
121 if (sta->debugfs.dir && ref->ops->add_sta_debugfs)
122 ref->ops->add_sta_debugfs(ref->priv, sta->rate_ctrl_priv,
127 static inline void rate_control_remove_sta_debugfs(struct sta_info *sta)
129 #ifdef CONFIG_MAC80211_DEBUGFS
130 struct rate_control_ref *ref = sta->rate_ctrl;
131 if (ref->ops->remove_sta_debugfs)
132 ref->ops->remove_sta_debugfs(ref->priv, sta->rate_ctrl_priv);
137 rate_supported(struct sta_info *sta, struct ieee80211_hw_mode *mode, int index)
139 return (sta == NULL || sta->supp_rates & BIT(index)) &&
140 (mode->rates[index].flags & IEEE80211_RATE_SUPPORTED);
144 rate_lowest_index(struct ieee80211_local *local, struct ieee80211_hw_mode *mode,
145 struct sta_info *sta)
149 for (i = 0; i < mode->num_rates; i++) {
150 if (rate_supported(sta, mode, i))
154 /* warn when we cannot find a rate. */
160 static inline struct ieee80211_rate *
161 rate_lowest(struct ieee80211_local *local, struct ieee80211_hw_mode *mode,
162 struct sta_info *sta)
164 return &mode->rates[rate_lowest_index(local, mode, sta)];
168 /* functions for rate control related to a device */
169 int ieee80211_init_rate_ctrl_alg(struct ieee80211_local *local,
171 void rate_control_deinitialize(struct ieee80211_local *local);
173 #endif /* IEEE80211_RATE_H */