net/wireless/reg.h

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