rapidio: remove excess kernel-doc notation
[linux-2.6/mini2440.git] / net / mac80211 / rate.h
blob928da625e281557ccecc0f1923def7b9bfa72415
1 /*
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.
9 */
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 <linux/kref.h>
18 #include <net/mac80211.h>
19 #include "ieee80211_i.h"
20 #include "sta_info.h"
22 struct rate_control_ref {
23 struct ieee80211_local *local;
24 struct rate_control_ops *ops;
25 void *priv;
26 struct kref kref;
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);
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)
44 struct rate_control_ref *ref = local->rate_ctrl;
45 struct ieee80211_sta *ista = &sta->sta;
46 void *priv_sta = sta->rate_ctrl_priv;
48 ref->ops->tx_status(ref->priv, sband, ista, priv_sta, skb);
52 static inline void rate_control_rate_init(struct sta_info *sta)
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;
60 sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
62 ref->ops->rate_init(ref->priv, sband, ista, priv_sta);
66 static inline void *rate_control_alloc_sta(struct rate_control_ref *ref,
67 struct ieee80211_sta *sta,
68 gfp_t gfp)
70 return ref->ops->alloc_sta(ref->priv, sta, gfp);
73 static inline void rate_control_free_sta(struct sta_info *sta)
75 struct rate_control_ref *ref = sta->rate_ctrl;
76 struct ieee80211_sta *ista = &sta->sta;
77 void *priv_sta = sta->rate_ctrl_priv;
79 ref->ops->free_sta(ref->priv, ista, priv_sta);
82 static inline void rate_control_add_sta_debugfs(struct sta_info *sta)
84 #ifdef CONFIG_MAC80211_DEBUGFS
85 struct rate_control_ref *ref = sta->rate_ctrl;
86 if (sta->debugfs.dir && ref->ops->add_sta_debugfs)
87 ref->ops->add_sta_debugfs(ref->priv, sta->rate_ctrl_priv,
88 sta->debugfs.dir);
89 #endif
92 static inline void rate_control_remove_sta_debugfs(struct sta_info *sta)
94 #ifdef CONFIG_MAC80211_DEBUGFS
95 struct rate_control_ref *ref = sta->rate_ctrl;
96 if (ref->ops->remove_sta_debugfs)
97 ref->ops->remove_sta_debugfs(ref->priv, sta->rate_ctrl_priv);
98 #endif
101 /* functions for rate control related to a device */
102 int ieee80211_init_rate_ctrl_alg(struct ieee80211_local *local,
103 const char *name);
104 void rate_control_deinitialize(struct ieee80211_local *local);
107 /* Rate control algorithms */
108 #ifdef CONFIG_MAC80211_RC_PID
109 extern int rc80211_pid_init(void);
110 extern void rc80211_pid_exit(void);
111 #else
112 static inline int rc80211_pid_init(void)
114 return 0;
116 static inline void rc80211_pid_exit(void)
119 #endif
121 #ifdef CONFIG_MAC80211_RC_MINSTREL
122 extern int rc80211_minstrel_init(void);
123 extern void rc80211_minstrel_exit(void);
124 #else
125 static inline int rc80211_minstrel_init(void)
127 return 0;
129 static inline void rc80211_minstrel_exit(void)
132 #endif
135 #endif /* IEEE80211_RATE_H */