mac80211: clean up rate control API
[safe/jmp/linux-2.6] / 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 ieee80211_supported_band *sband,
35                            struct sta_info *sta, struct sk_buff *skb,
36                            struct rate_selection *sel);
37 struct rate_control_ref *rate_control_get(struct rate_control_ref *ref);
38 void rate_control_put(struct rate_control_ref *ref);
39
40 static inline void rate_control_tx_status(struct ieee80211_local *local,
41                                           struct ieee80211_supported_band *sband,
42                                           struct sta_info *sta,
43                                           struct sk_buff *skb)
44 {
45         struct rate_control_ref *ref = local->rate_ctrl;
46         struct ieee80211_sta *ista = &sta->sta;
47         void *priv_sta = sta->rate_ctrl_priv;
48
49         ref->ops->tx_status(ref->priv, sband, ista, priv_sta, skb);
50 }
51
52
53 static inline void rate_control_rate_init(struct sta_info *sta)
54 {
55         struct ieee80211_local *local = sta->sdata->local;
56         struct rate_control_ref *ref = sta->rate_ctrl;
57         struct ieee80211_sta *ista = &sta->sta;
58         void *priv_sta = sta->rate_ctrl_priv;
59         struct ieee80211_supported_band *sband;
60
61         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
62
63         ref->ops->rate_init(ref->priv, sband, ista, priv_sta);
64 }
65
66
67 static inline void rate_control_clear(struct ieee80211_local *local)
68 {
69         struct rate_control_ref *ref = local->rate_ctrl;
70         ref->ops->clear(ref->priv);
71 }
72
73 static inline void *rate_control_alloc_sta(struct rate_control_ref *ref,
74                                            struct ieee80211_sta *sta,
75                                            gfp_t gfp)
76 {
77         return ref->ops->alloc_sta(ref->priv, sta, gfp);
78 }
79
80 static inline void rate_control_free_sta(struct sta_info *sta)
81 {
82         struct rate_control_ref *ref = sta->rate_ctrl;
83         struct ieee80211_sta *ista = &sta->sta;
84         void *priv_sta = sta->rate_ctrl_priv;
85
86         ref->ops->free_sta(ref->priv, ista, priv_sta);
87 }
88
89 static inline void rate_control_add_sta_debugfs(struct sta_info *sta)
90 {
91 #ifdef CONFIG_MAC80211_DEBUGFS
92         struct rate_control_ref *ref = sta->rate_ctrl;
93         if (sta->debugfs.dir && ref->ops->add_sta_debugfs)
94                 ref->ops->add_sta_debugfs(ref->priv, sta->rate_ctrl_priv,
95                                           sta->debugfs.dir);
96 #endif
97 }
98
99 static inline void rate_control_remove_sta_debugfs(struct sta_info *sta)
100 {
101 #ifdef CONFIG_MAC80211_DEBUGFS
102         struct rate_control_ref *ref = sta->rate_ctrl;
103         if (ref->ops->remove_sta_debugfs)
104                 ref->ops->remove_sta_debugfs(ref->priv, sta->rate_ctrl_priv);
105 #endif
106 }
107
108 /* functions for rate control related to a device */
109 int ieee80211_init_rate_ctrl_alg(struct ieee80211_local *local,
110                                  const char *name);
111 void rate_control_deinitialize(struct ieee80211_local *local);
112
113
114 /* Rate control algorithms */
115 #ifdef CONFIG_MAC80211_RC_PID
116 extern int rc80211_pid_init(void);
117 extern void rc80211_pid_exit(void);
118 #else
119 static inline int rc80211_pid_init(void)
120 {
121         return 0;
122 }
123 static inline void rc80211_pid_exit(void)
124 {
125 }
126 #endif
127
128 #endif /* IEEE80211_RATE_H */