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