xref: /openbmc/linux/net/wireless/reg.h (revision eb3fcf00)
1 #ifndef __NET_WIRELESS_REG_H
2 #define __NET_WIRELESS_REG_H
3 /*
4  * Copyright 2008-2011	Luis R. Rodriguez <mcgrof@qca.qualcomm.com>
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 enum ieee80211_regd_source {
20 	REGD_SOURCE_INTERNAL_DB,
21 	REGD_SOURCE_CRDA,
22 };
23 
24 extern const struct ieee80211_regdomain __rcu *cfg80211_regdomain;
25 
26 bool reg_is_valid_request(const char *alpha2);
27 bool is_world_regdom(const char *alpha2);
28 bool reg_supported_dfs_region(enum nl80211_dfs_regions dfs_region);
29 enum nl80211_dfs_regions reg_get_dfs_region(struct wiphy *wiphy);
30 
31 int regulatory_hint_user(const char *alpha2,
32 			 enum nl80211_user_reg_hint_type user_reg_hint_type);
33 
34 /**
35  * regulatory_hint_indoor - hint operation in indoor env. or not
36  * @is_indoor: if true indicates that user space thinks that the
37  * device is operating in an indoor environment.
38  * @portid: the netlink port ID on which the hint was given.
39  */
40 int regulatory_hint_indoor(bool is_indoor, u32 portid);
41 
42 /**
43  * regulatory_netlink_notify - notify on released netlink socket
44  * @portid: the netlink socket port ID
45  */
46 void regulatory_netlink_notify(u32 portid);
47 
48 void wiphy_regulatory_register(struct wiphy *wiphy);
49 void wiphy_regulatory_deregister(struct wiphy *wiphy);
50 
51 int __init regulatory_init(void);
52 void regulatory_exit(void);
53 
54 int set_regdom(const struct ieee80211_regdomain *rd,
55 	       enum ieee80211_regd_source regd_src);
56 
57 unsigned int reg_get_max_bandwidth(const struct ieee80211_regdomain *rd,
58 				   const struct ieee80211_reg_rule *rule);
59 
60 bool reg_last_request_cell_base(void);
61 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
62 
63 /**
64  * regulatory_hint_found_beacon - hints a beacon was found on a channel
65  * @wiphy: the wireless device where the beacon was found on
66  * @beacon_chan: the channel on which the beacon was found on
67  * @gfp: context flags
68  *
69  * This informs the wireless core that a beacon from an AP was found on
70  * the channel provided. This allows the wireless core to make educated
71  * guesses on regulatory to help with world roaming. This is only used for
72  * world roaming -- when we do not know our current location. This is
73  * only useful on channels 12, 13 and 14 on the 2 GHz band as channels
74  * 1-11 are already enabled by the world regulatory domain; and on
75  * non-radar 5 GHz channels.
76  *
77  * Drivers do not need to call this, cfg80211 will do it for after a scan
78  * on a newly found BSS. If you cannot make use of this feature you can
79  * set the wiphy->disable_beacon_hints to true.
80  */
81 int regulatory_hint_found_beacon(struct wiphy *wiphy,
82 				 struct ieee80211_channel *beacon_chan,
83 				 gfp_t gfp);
84 
85 /**
86  * regulatory_hint_country_ie - hints a country IE as a regulatory domain
87  * @wiphy: the wireless device giving the hint (used only for reporting
88  *	conflicts)
89  * @band: the band on which the country IE was received on. This determines
90  *	the band we'll process the country IE channel triplets for.
91  * @country_ie: pointer to the country IE
92  * @country_ie_len: length of the country IE
93  *
94  * We will intersect the rd with the what CRDA tells us should apply
95  * for the alpha2 this country IE belongs to, this prevents APs from
96  * sending us incorrect or outdated information against a country.
97  *
98  * The AP is expected to provide Country IE channel triplets for the
99  * band it is on. It is technically possible for APs to send channel
100  * country IE triplets even for channels outside of the band they are
101  * in but for that they would have to use the regulatory extension
102  * in combination with a triplet but this behaviour is currently
103  * not observed. For this reason if a triplet is seen with channel
104  * information for a band the BSS is not present in it will be ignored.
105  */
106 void regulatory_hint_country_ie(struct wiphy *wiphy,
107 			 enum ieee80211_band band,
108 			 const u8 *country_ie,
109 			 u8 country_ie_len);
110 
111 /**
112  * regulatory_hint_disconnect - informs all devices have been disconneted
113  *
114  * Regulotory rules can be enhanced further upon scanning and upon
115  * connection to an AP. These rules become stale if we disconnect
116  * and go to another country, whether or not we suspend and resume.
117  * If we suspend, go to another country and resume we'll automatically
118  * get disconnected shortly after resuming and things will be reset as well.
119  * This routine is a helper to restore regulatory settings to how they were
120  * prior to our first connect attempt. This includes ignoring country IE and
121  * beacon regulatory hints. The ieee80211_regdom module parameter will always
122  * be respected but if a user had set the regulatory domain that will take
123  * precedence.
124  *
125  * Must be called from process context.
126  */
127 void regulatory_hint_disconnect(void);
128 
129 /**
130  * cfg80211_get_unii - get the U-NII band for the frequency
131  * @freq: the frequency for which we want to get the UNII band.
132 
133  * Get a value specifying the U-NII band frequency belongs to.
134  * U-NII bands are defined by the FCC in C.F.R 47 part 15.
135  *
136  * Returns -EINVAL if freq is invalid, 0 for UNII-1, 1 for UNII-2A,
137  * 2 for UNII-2B, 3 for UNII-2C and 4 for UNII-3.
138  */
139 int cfg80211_get_unii(int freq);
140 
141 /**
142  * regulatory_indoor_allowed - is indoor operation allowed
143  */
144 bool regulatory_indoor_allowed(void);
145 
146 #endif  /* __NET_WIRELESS_REG_H */
147