cfg80211: move all regulatory hints to workqueue
[linux-3.10.git] / include / net / wireless.h
1 #ifndef __NET_WIRELESS_H
2 #define __NET_WIRELESS_H
3
4 /*
5  * 802.11 device management
6  *
7  * Copyright 2007       Johannes Berg <johannes@sipsolutions.net>
8  */
9
10 #include <linux/netdevice.h>
11 #include <linux/debugfs.h>
12 #include <linux/list.h>
13 #include <linux/ieee80211.h>
14 #include <net/cfg80211.h>
15
16 /**
17  * enum ieee80211_band - supported frequency bands
18  *
19  * The bands are assigned this way because the supported
20  * bitrates differ in these bands.
21  *
22  * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
23  * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
24  */
25 enum ieee80211_band {
26         IEEE80211_BAND_2GHZ,
27         IEEE80211_BAND_5GHZ,
28
29         /* keep last */
30         IEEE80211_NUM_BANDS
31 };
32
33 /**
34  * enum ieee80211_channel_flags - channel flags
35  *
36  * Channel flags set by the regulatory control code.
37  *
38  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
39  * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
40  *      on this channel.
41  * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
42  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
43  * @IEEE80211_CHAN_NO_FAT_ABOVE: extension channel above this channel
44  *      is not permitted.
45  * @IEEE80211_CHAN_NO_FAT_BELOW: extension channel below this channel
46  *      is not permitted.
47  */
48 enum ieee80211_channel_flags {
49         IEEE80211_CHAN_DISABLED         = 1<<0,
50         IEEE80211_CHAN_PASSIVE_SCAN     = 1<<1,
51         IEEE80211_CHAN_NO_IBSS          = 1<<2,
52         IEEE80211_CHAN_RADAR            = 1<<3,
53         IEEE80211_CHAN_NO_FAT_ABOVE     = 1<<4,
54         IEEE80211_CHAN_NO_FAT_BELOW     = 1<<5,
55 };
56
57 /**
58  * struct ieee80211_channel - channel definition
59  *
60  * This structure describes a single channel for use
61  * with cfg80211.
62  *
63  * @center_freq: center frequency in MHz
64  * @max_bandwidth: maximum allowed bandwidth for this channel, in MHz
65  * @hw_value: hardware-specific value for the channel
66  * @flags: channel flags from &enum ieee80211_channel_flags.
67  * @orig_flags: channel flags at registration time, used by regulatory
68  *      code to support devices with additional restrictions
69  * @band: band this channel belongs to.
70  * @max_antenna_gain: maximum antenna gain in dBi
71  * @max_power: maximum transmission power (in dBm)
72  * @orig_mag: internal use
73  * @orig_mpwr: internal use
74  */
75 struct ieee80211_channel {
76         enum ieee80211_band band;
77         u16 center_freq;
78         u8 max_bandwidth;
79         u16 hw_value;
80         u32 flags;
81         int max_antenna_gain;
82         int max_power;
83         u32 orig_flags;
84         int orig_mag, orig_mpwr;
85 };
86
87 /**
88  * enum ieee80211_rate_flags - rate flags
89  *
90  * Hardware/specification flags for rates. These are structured
91  * in a way that allows using the same bitrate structure for
92  * different bands/PHY modes.
93  *
94  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
95  *      preamble on this bitrate; only relevant in 2.4GHz band and
96  *      with CCK rates.
97  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
98  *      when used with 802.11a (on the 5 GHz band); filled by the
99  *      core code when registering the wiphy.
100  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
101  *      when used with 802.11b (on the 2.4 GHz band); filled by the
102  *      core code when registering the wiphy.
103  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
104  *      when used with 802.11g (on the 2.4 GHz band); filled by the
105  *      core code when registering the wiphy.
106  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
107  */
108 enum ieee80211_rate_flags {
109         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
110         IEEE80211_RATE_MANDATORY_A      = 1<<1,
111         IEEE80211_RATE_MANDATORY_B      = 1<<2,
112         IEEE80211_RATE_MANDATORY_G      = 1<<3,
113         IEEE80211_RATE_ERP_G            = 1<<4,
114 };
115
116 /**
117  * struct ieee80211_rate - bitrate definition
118  *
119  * This structure describes a bitrate that an 802.11 PHY can
120  * operate with. The two values @hw_value and @hw_value_short
121  * are only for driver use when pointers to this structure are
122  * passed around.
123  *
124  * @flags: rate-specific flags
125  * @bitrate: bitrate in units of 100 Kbps
126  * @hw_value: driver/hardware value for this rate
127  * @hw_value_short: driver/hardware value for this rate when
128  *      short preamble is used
129  */
130 struct ieee80211_rate {
131         u32 flags;
132         u16 bitrate;
133         u16 hw_value, hw_value_short;
134 };
135
136 /**
137  * struct ieee80211_sta_ht_cap - STA's HT capabilities
138  *
139  * This structure describes most essential parameters needed
140  * to describe 802.11n HT capabilities for an STA.
141  *
142  * @ht_supported: is HT supported by the STA
143  * @cap: HT capabilities map as described in 802.11n spec
144  * @ampdu_factor: Maximum A-MPDU length factor
145  * @ampdu_density: Minimum A-MPDU spacing
146  * @mcs: Supported MCS rates
147  */
148 struct ieee80211_sta_ht_cap {
149         u16 cap; /* use IEEE80211_HT_CAP_ */
150         bool ht_supported;
151         u8 ampdu_factor;
152         u8 ampdu_density;
153         struct ieee80211_mcs_info mcs;
154 };
155
156 /**
157  * struct ieee80211_supported_band - frequency band definition
158  *
159  * This structure describes a frequency band a wiphy
160  * is able to operate in.
161  *
162  * @channels: Array of channels the hardware can operate in
163  *      in this band.
164  * @band: the band this structure represents
165  * @n_channels: Number of channels in @channels
166  * @bitrates: Array of bitrates the hardware can operate with
167  *      in this band. Must be sorted to give a valid "supported
168  *      rates" IE, i.e. CCK rates first, then OFDM.
169  * @n_bitrates: Number of bitrates in @bitrates
170  */
171 struct ieee80211_supported_band {
172         struct ieee80211_channel *channels;
173         struct ieee80211_rate *bitrates;
174         enum ieee80211_band band;
175         int n_channels;
176         int n_bitrates;
177         struct ieee80211_sta_ht_cap ht_cap;
178 };
179
180 /**
181  * struct wiphy - wireless hardware description
182  * @idx: the wiphy index assigned to this item
183  * @class_dev: the class device representing /sys/class/ieee80211/<wiphy-name>
184  * @custom_regulatory: tells us the driver for this device
185  *      has its own custom regulatory domain and cannot identify the
186  *      ISO / IEC 3166 alpha2 it belongs to. When this is enabled
187  *      we will disregard the first regulatory hint (when the
188  *      initiator is %REGDOM_SET_BY_CORE).
189  * @strict_regulatory: tells us the driver for this device will ignore
190  *      regulatory domain settings until it gets its own regulatory domain
191  *      via its regulatory_hint(). After its gets its own regulatory domain
192  *      it will only allow further regulatory domain settings to further
193  *      enhance compliance. For example if channel 13 and 14 are disabled
194  *      by this regulatory domain no user regulatory domain can enable these
195  *      channels at a later time. This can be used for devices which do not
196  *      have calibration information gauranteed for frequencies or settings
197  *      outside of its regulatory domain.
198  * @reg_notifier: the driver's regulatory notification callback
199  * @regd: the driver's regulatory domain, if one was requested via
200  *      the regulatory_hint() API. This can be used by the driver
201  *      on the reg_notifier() if it chooses to ignore future
202  *      regulatory domain changes caused by other drivers.
203  * @signal_type: signal type reported in &struct cfg80211_bss.
204  */
205 struct wiphy {
206         /* assign these fields before you register the wiphy */
207
208         /* permanent MAC address */
209         u8 perm_addr[ETH_ALEN];
210
211         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
212         u16 interface_modes;
213
214         bool custom_regulatory;
215         bool strict_regulatory;
216
217         enum cfg80211_signal_type signal_type;
218
219         int bss_priv_size;
220         u8 max_scan_ssids;
221
222         /* If multiple wiphys are registered and you're handed e.g.
223          * a regular netdev with assigned ieee80211_ptr, you won't
224          * know whether it points to a wiphy your driver has registered
225          * or not. Assign this to something global to your driver to
226          * help determine whether you own this wiphy or not. */
227         void *privid;
228
229         struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
230
231         /* Lets us get back the wiphy on the callback */
232         int (*reg_notifier)(struct wiphy *wiphy,
233                             struct regulatory_request *request);
234
235         /* fields below are read-only, assigned by cfg80211 */
236
237         const struct ieee80211_regdomain *regd;
238
239         /* the item in /sys/class/ieee80211/ points to this,
240          * you need use set_wiphy_dev() (see below) */
241         struct device dev;
242
243         /* dir in debugfs: ieee80211/<wiphyname> */
244         struct dentry *debugfsdir;
245
246         char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
247 };
248
249 /** struct wireless_dev - wireless per-netdev state
250  *
251  * This structure must be allocated by the driver/stack
252  * that uses the ieee80211_ptr field in struct net_device
253  * (this is intentional so it can be allocated along with
254  * the netdev.)
255  *
256  * @wiphy: pointer to hardware description
257  * @iftype: interface type
258  */
259 struct wireless_dev {
260         struct wiphy *wiphy;
261         enum nl80211_iftype iftype;
262
263         /* private to the generic wireless code */
264         struct list_head list;
265         struct net_device *netdev;
266 };
267
268 /**
269  * wiphy_priv - return priv from wiphy
270  */
271 static inline void *wiphy_priv(struct wiphy *wiphy)
272 {
273         BUG_ON(!wiphy);
274         return &wiphy->priv;
275 }
276
277 /**
278  * set_wiphy_dev - set device pointer for wiphy
279  */
280 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
281 {
282         wiphy->dev.parent = dev;
283 }
284
285 /**
286  * wiphy_dev - get wiphy dev pointer
287  */
288 static inline struct device *wiphy_dev(struct wiphy *wiphy)
289 {
290         return wiphy->dev.parent;
291 }
292
293 /**
294  * wiphy_name - get wiphy name
295  */
296 static inline const char *wiphy_name(struct wiphy *wiphy)
297 {
298         return dev_name(&wiphy->dev);
299 }
300
301 /**
302  * wdev_priv - return wiphy priv from wireless_dev
303  */
304 static inline void *wdev_priv(struct wireless_dev *wdev)
305 {
306         BUG_ON(!wdev);
307         return wiphy_priv(wdev->wiphy);
308 }
309
310 /**
311  * wiphy_new - create a new wiphy for use with cfg80211
312  *
313  * create a new wiphy and associate the given operations with it.
314  * @sizeof_priv bytes are allocated for private use.
315  *
316  * the returned pointer must be assigned to each netdev's
317  * ieee80211_ptr for proper operation.
318  */
319 struct wiphy *wiphy_new(struct cfg80211_ops *ops, int sizeof_priv);
320
321 /**
322  * wiphy_register - register a wiphy with cfg80211
323  *
324  * register the given wiphy
325  *
326  * Returns a non-negative wiphy index or a negative error code.
327  */
328 extern int wiphy_register(struct wiphy *wiphy);
329
330 /**
331  * wiphy_unregister - deregister a wiphy from cfg80211
332  *
333  * unregister a device with the given priv pointer.
334  * After this call, no more requests can be made with this priv
335  * pointer, but the call may sleep to wait for an outstanding
336  * request that is being handled.
337  */
338 extern void wiphy_unregister(struct wiphy *wiphy);
339
340 /**
341  * wiphy_free - free wiphy
342  */
343 extern void wiphy_free(struct wiphy *wiphy);
344
345 /**
346  * ieee80211_channel_to_frequency - convert channel number to frequency
347  */
348 extern int ieee80211_channel_to_frequency(int chan);
349
350 /**
351  * ieee80211_frequency_to_channel - convert frequency to channel number
352  */
353 extern int ieee80211_frequency_to_channel(int freq);
354
355 /*
356  * Name indirection necessary because the ieee80211 code also has
357  * a function named "ieee80211_get_channel", so if you include
358  * cfg80211's header file you get cfg80211's version, if you try
359  * to include both header files you'll (rightfully!) get a symbol
360  * clash.
361  */
362 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
363                                                          int freq);
364 /**
365  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
366  */
367 static inline struct ieee80211_channel *
368 ieee80211_get_channel(struct wiphy *wiphy, int freq)
369 {
370         return __ieee80211_get_channel(wiphy, freq);
371 }
372
373 /**
374  * ieee80211_get_response_rate - get basic rate for a given rate
375  *
376  * @sband: the band to look for rates in
377  * @basic_rates: bitmap of basic rates
378  * @bitrate: the bitrate for which to find the basic rate
379  *
380  * This function returns the basic rate corresponding to a given
381  * bitrate, that is the next lower bitrate contained in the basic
382  * rate map, which is, for this function, given as a bitmap of
383  * indices of rates in the band's bitrate table.
384  */
385 struct ieee80211_rate *
386 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
387                             u32 basic_rates, int bitrate);
388
389 /**
390  * regulatory_hint - driver hint to the wireless core a regulatory domain
391  * @wiphy: the wireless device giving the hint (used only for reporting
392  *      conflicts)
393  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
394  *      should be in. If @rd is set this should be NULL. Note that if you
395  *      set this to NULL you should still set rd->alpha2 to some accepted
396  *      alpha2.
397  *
398  * Wireless drivers can use this function to hint to the wireless core
399  * what it believes should be the current regulatory domain by
400  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
401  * domain should be in or by providing a completely build regulatory domain.
402  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
403  * for a regulatory domain structure for the respective country.
404  *
405  * The wiphy must have been registered to cfg80211 prior to this call.
406  * For cfg80211 drivers this means you must first use wiphy_register(),
407  * for mac80211 drivers you must first use ieee80211_register_hw().
408  *
409  * Drivers should check the return value, its possible you can get
410  * an -ENOMEM.
411  */
412 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
413
414 /**
415  * regulatory_hint_11d - hints a country IE as a regulatory domain
416  * @wiphy: the wireless device giving the hint (used only for reporting
417  *      conflicts)
418  * @country_ie: pointer to the country IE
419  * @country_ie_len: length of the country IE
420  *
421  * We will intersect the rd with the what CRDA tells us should apply
422  * for the alpha2 this country IE belongs to, this prevents APs from
423  * sending us incorrect or outdated information against a country.
424  */
425 extern void regulatory_hint_11d(struct wiphy *wiphy,
426                                 u8 *country_ie,
427                                 u8 country_ie_len);
428
429 /**
430  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
431  * @wiphy: the wireless device we want to process the regulatory domain on
432  * @regd: the custom regulatory domain to use for this wiphy
433  *
434  * Drivers can sometimes have custom regulatory domains which do not apply
435  * to a specific country. Drivers can use this to apply such custom regulatory
436  * domains. This routine must be called prior to wiphy registration. The
437  * custom regulatory domain will be trusted completely and as such previous
438  * default channel settings will be disregarded. If no rule is found for a
439  * channel on the regulatory domain the channel will be disabled.
440  */
441 extern void wiphy_apply_custom_regulatory(
442         struct wiphy *wiphy,
443         const struct ieee80211_regdomain *regd);
444
445 /**
446  * freq_reg_info - get regulatory information for the given frequency
447  * @wiphy: the wiphy for which we want to process this rule for
448  * @center_freq: Frequency in KHz for which we want regulatory information for
449  * @bandwidth: the bandwidth requirement you have in KHz, if you do not have one
450  *      you can set this to 0. If this frequency is allowed we then set
451  *      this value to the maximum allowed bandwidth.
452  * @reg_rule: the regulatory rule which we have for this frequency
453  *
454  * Use this function to get the regulatory rule for a specific frequency on
455  * a given wireless device. If the device has a specific regulatory domain
456  * it wants to follow we respect that unless a country IE has been received
457  * and processed already.
458  *
459  * Returns 0 if it was able to find a valid regulatory rule which does
460  * apply to the given center_freq otherwise it returns non-zero. It will
461  * also return -ERANGE if we determine the given center_freq does not even have
462  * a regulatory rule for a frequency range in the center_freq's band. See
463  * freq_in_rule_band() for our current definition of a band -- this is purely
464  * subjective and right now its 802.11 specific.
465  */
466 extern int freq_reg_info(struct wiphy *wiphy, u32 center_freq, u32 *bandwidth,
467                          const struct ieee80211_reg_rule **reg_rule);
468
469 #endif /* __NET_WIRELESS_H */