mac80211/drivers: rewrite the rate control API
[linux-2.6.git] / net / mac80211 / 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 <linux/kref.h>
18 #include <net/mac80211.h>
19 #include "ieee80211_i.h"
20 #include "sta_info.h"
21
22 struct rate_control_ref {
23         struct ieee80211_local *local;
24         struct rate_control_ops *ops;
25         void *priv;
26         struct kref kref;
27 };
28
29 /* Get a reference to the rate control algorithm. If `name' is NULL, get the
30  * first available algorithm. */
31 struct rate_control_ref *rate_control_alloc(const char *name,
32                                             struct ieee80211_local *local);
33 void rate_control_get_rate(struct ieee80211_sub_if_data *sdata,
34                            struct sta_info *sta,
35                            struct ieee80211_tx_rate_control *txrc);
36 struct rate_control_ref *rate_control_get(struct rate_control_ref *ref);
37 void rate_control_put(struct rate_control_ref *ref);
38
39 static inline void rate_control_tx_status(struct ieee80211_local *local,
40                                           struct ieee80211_supported_band *sband,
41                                           struct sta_info *sta,
42                                           struct sk_buff *skb)
43 {
44         struct rate_control_ref *ref = local->rate_ctrl;
45         struct ieee80211_sta *ista = &sta->sta;
46         void *priv_sta = sta->rate_ctrl_priv;
47
48         ref->ops->tx_status(ref->priv, sband, ista, priv_sta, skb);
49 }
50
51
52 static inline void rate_control_rate_init(struct sta_info *sta)
53 {
54         struct ieee80211_local *local = sta->sdata->local;
55         struct rate_control_ref *ref = sta->rate_ctrl;
56         struct ieee80211_sta *ista = &sta->sta;
57         void *priv_sta = sta->rate_ctrl_priv;
58         struct ieee80211_supported_band *sband;
59
60         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
61
62         ref->ops->rate_init(ref->priv, sband, ista, priv_sta);
63 }
64
65
66 static inline void rate_control_clear(struct ieee80211_local *local)
67 {
68         struct rate_control_ref *ref = local->rate_ctrl;
69         ref->ops->clear(ref->priv);
70 }
71
72 static inline void *rate_control_alloc_sta(struct rate_control_ref *ref,
73                                            struct ieee80211_sta *sta,
74                                            gfp_t gfp)
75 {
76         return ref->ops->alloc_sta(ref->priv, sta, gfp);
77 }
78
79 static inline void rate_control_free_sta(struct sta_info *sta)
80 {
81         struct rate_control_ref *ref = sta->rate_ctrl;
82         struct ieee80211_sta *ista = &sta->sta;
83         void *priv_sta = sta->rate_ctrl_priv;
84
85         ref->ops->free_sta(ref->priv, ista, priv_sta);
86 }
87
88 static inline void rate_control_add_sta_debugfs(struct sta_info *sta)
89 {
90 #ifdef CONFIG_MAC80211_DEBUGFS
91         struct rate_control_ref *ref = sta->rate_ctrl;
92         if (sta->debugfs.dir && ref->ops->add_sta_debugfs)
93                 ref->ops->add_sta_debugfs(ref->priv, sta->rate_ctrl_priv,
94                                           sta->debugfs.dir);
95 #endif
96 }
97
98 static inline void rate_control_remove_sta_debugfs(struct sta_info *sta)
99 {
100 #ifdef CONFIG_MAC80211_DEBUGFS
101         struct rate_control_ref *ref = sta->rate_ctrl;
102         if (ref->ops->remove_sta_debugfs)
103                 ref->ops->remove_sta_debugfs(ref->priv, sta->rate_ctrl_priv);
104 #endif
105 }
106
107 /* functions for rate control related to a device */
108 int ieee80211_init_rate_ctrl_alg(struct ieee80211_local *local,
109                                  const char *name);
110 void rate_control_deinitialize(struct ieee80211_local *local);
111
112
113 /* Rate control algorithms */
114 #ifdef CONFIG_MAC80211_RC_PID
115 extern int rc80211_pid_init(void);
116 extern void rc80211_pid_exit(void);
117 #else
118 static inline int rc80211_pid_init(void)
119 {
120         return 0;
121 }
122 static inline void rc80211_pid_exit(void)
123 {
124 }
125 #endif
126
127 #ifdef CONFIG_MAC80211_RC_MINSTREL
128 extern int rc80211_minstrel_init(void);
129 extern void rc80211_minstrel_exit(void);
130 #else
131 static inline int rc80211_minstrel_init(void)
132 {
133         return 0;
134 }
135 static inline void rc80211_minstrel_exit(void)
136 {
137 }
138 #endif
139
140
141 #endif /* IEEE80211_RATE_H */