regulatory.h 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. #ifndef __NET_REGULATORY_H
  2. #define __NET_REGULATORY_H
  3. /*
  4. * regulatory support structures
  5. *
  6. * Copyright 2008-2009 Luis R. Rodriguez <[email protected]>
  7. * Copyright (C) 2018 Intel Corporation
  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. #include <linux/ieee80211.h>
  22. #include <linux/nl80211.h>
  23. #include <linux/rcupdate.h>
  24. /**
  25. * enum environment_cap - Environment parsed from country IE
  26. * @ENVIRON_ANY: indicates country IE applies to both indoor and
  27. * outdoor operation.
  28. * @ENVIRON_INDOOR: indicates country IE applies only to indoor operation
  29. * @ENVIRON_OUTDOOR: indicates country IE applies only to outdoor operation
  30. */
  31. enum environment_cap {
  32. ENVIRON_ANY,
  33. ENVIRON_INDOOR,
  34. ENVIRON_OUTDOOR,
  35. };
  36. /**
  37. * struct regulatory_request - used to keep track of regulatory requests
  38. *
  39. * @rcu_head: RCU head struct used to free the request
  40. * @wiphy_idx: this is set if this request's initiator is
  41. * %REGDOM_SET_BY_COUNTRY_IE or %REGDOM_SET_BY_DRIVER. This
  42. * can be used by the wireless core to deal with conflicts
  43. * and potentially inform users of which devices specifically
  44. * cased the conflicts.
  45. * @initiator: indicates who sent this request, could be any of
  46. * those set in nl80211_reg_initiator (%NL80211_REGDOM_SET_BY_*)
  47. * @alpha2: the ISO / IEC 3166 alpha2 country code of the requested
  48. * regulatory domain. We have a few special codes:
  49. * 00 - World regulatory domain
  50. * 99 - built by driver but a specific alpha2 cannot be determined
  51. * 98 - result of an intersection between two regulatory domains
  52. * 97 - regulatory domain has not yet been configured
  53. * @dfs_region: If CRDA responded with a regulatory domain that requires
  54. * DFS master operation on a known DFS region (NL80211_DFS_*),
  55. * dfs_region represents that region. Drivers can use this and the
  56. * @alpha2 to adjust their device's DFS parameters as required.
  57. * @user_reg_hint_type: if the @initiator was of type
  58. * %NL80211_REGDOM_SET_BY_USER, this classifies the type
  59. * of hint passed. This could be any of the %NL80211_USER_REG_HINT_*
  60. * types.
  61. * @intersect: indicates whether the wireless core should intersect
  62. * the requested regulatory domain with the presently set regulatory
  63. * domain.
  64. * @processed: indicates whether or not this requests has already been
  65. * processed. When the last request is processed it means that the
  66. * currently regulatory domain set on cfg80211 is updated from
  67. * CRDA and can be used by other regulatory requests. When a
  68. * the last request is not yet processed we must yield until it
  69. * is processed before processing any new requests.
  70. * @country_ie_checksum: checksum of the last processed and accepted
  71. * country IE
  72. * @country_ie_env: lets us know if the AP is telling us we are outdoor,
  73. * indoor, or if it doesn't matter
  74. * @list: used to insert into the reg_requests_list linked list
  75. */
  76. struct regulatory_request {
  77. struct rcu_head rcu_head;
  78. int wiphy_idx;
  79. enum nl80211_reg_initiator initiator;
  80. enum nl80211_user_reg_hint_type user_reg_hint_type;
  81. char alpha2[3];
  82. enum nl80211_dfs_regions dfs_region;
  83. bool intersect;
  84. bool processed;
  85. enum environment_cap country_ie_env;
  86. struct list_head list;
  87. };
  88. /**
  89. * enum ieee80211_regulatory_flags - device regulatory flags
  90. *
  91. * @REGULATORY_CUSTOM_REG: tells us the driver for this device
  92. * has its own custom regulatory domain and cannot identify the
  93. * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
  94. * we will disregard the first regulatory hint (when the
  95. * initiator is %REGDOM_SET_BY_CORE). Drivers that use
  96. * wiphy_apply_custom_regulatory() should have this flag set
  97. * or the regulatory core will set it for the wiphy.
  98. * If you use regulatory_hint() *after* using
  99. * wiphy_apply_custom_regulatory() the wireless core will
  100. * clear the REGULATORY_CUSTOM_REG for your wiphy as it would be
  101. * implied that the device somehow gained knowledge of its region.
  102. * @REGULATORY_STRICT_REG: tells us that the wiphy for this device
  103. * has regulatory domain that it wishes to be considered as the
  104. * superset for regulatory rules. After this device gets its regulatory
  105. * domain programmed further regulatory hints shall only be considered
  106. * for this device to enhance regulatory compliance, forcing the
  107. * device to only possibly use subsets of the original regulatory
  108. * rules. For example if channel 13 and 14 are disabled by this
  109. * device's regulatory domain no user specified regulatory hint which
  110. * has these channels enabled would enable them for this wiphy,
  111. * the device's original regulatory domain will be trusted as the
  112. * base. You can program the superset of regulatory rules for this
  113. * wiphy with regulatory_hint() for cards programmed with an
  114. * ISO3166-alpha2 country code. wiphys that use regulatory_hint()
  115. * will have their wiphy->regd programmed once the regulatory
  116. * domain is set, and all other regulatory hints will be ignored
  117. * until their own regulatory domain gets programmed.
  118. * @REGULATORY_DISABLE_BEACON_HINTS: enable this if your driver needs to
  119. * ensure that passive scan flags and beaconing flags may not be lifted by
  120. * cfg80211 due to regulatory beacon hints. For more information on beacon
  121. * hints read the documenation for regulatory_hint_found_beacon()
  122. * @REGULATORY_COUNTRY_IE_FOLLOW_POWER: for devices that have a preference
  123. * that even though they may have programmed their own custom power
  124. * setting prior to wiphy registration, they want to ensure their channel
  125. * power settings are updated for this connection with the power settings
  126. * derived from the regulatory domain. The regulatory domain used will be
  127. * based on the ISO3166-alpha2 from country IE provided through
  128. * regulatory_hint_country_ie()
  129. * @REGULATORY_COUNTRY_IE_IGNORE: for devices that have a preference to ignore
  130. * all country IE information processed by the regulatory core. This will
  131. * override %REGULATORY_COUNTRY_IE_FOLLOW_POWER as all country IEs will
  132. * be ignored.
  133. * @REGULATORY_ENABLE_RELAX_NO_IR: for devices that wish to allow the
  134. * NO_IR relaxation, which enables transmissions on channels on which
  135. * otherwise initiating radiation is not allowed. This will enable the
  136. * relaxations enabled under the CFG80211_REG_RELAX_NO_IR configuration
  137. * option
  138. * @REGULATORY_WIPHY_SELF_MANAGED: for devices that employ wiphy-specific
  139. * regdom management. These devices will ignore all regdom changes not
  140. * originating from their own wiphy.
  141. * A self-managed wiphys only employs regulatory information obtained from
  142. * the FW and driver and does not use other cfg80211 sources like
  143. * beacon-hints, country-code IEs and hints from other devices on the same
  144. * system. Conversely, a self-managed wiphy does not share its regulatory
  145. * hints with other devices in the system. If a system contains several
  146. * devices, one or more of which are self-managed, there might be
  147. * contradictory regulatory settings between them. Usage of flag is
  148. * generally discouraged. Only use it if the FW/driver is incompatible
  149. * with non-locally originated hints.
  150. * This flag is incompatible with the flags: %REGULATORY_CUSTOM_REG,
  151. * %REGULATORY_STRICT_REG, %REGULATORY_COUNTRY_IE_FOLLOW_POWER,
  152. * %REGULATORY_COUNTRY_IE_IGNORE and %REGULATORY_DISABLE_BEACON_HINTS.
  153. * Mixing any of the above flags with this flag will result in a failure
  154. * to register the wiphy. This flag implies
  155. * %REGULATORY_DISABLE_BEACON_HINTS and %REGULATORY_COUNTRY_IE_IGNORE.
  156. */
  157. enum ieee80211_regulatory_flags {
  158. REGULATORY_CUSTOM_REG = BIT(0),
  159. REGULATORY_STRICT_REG = BIT(1),
  160. REGULATORY_DISABLE_BEACON_HINTS = BIT(2),
  161. REGULATORY_COUNTRY_IE_FOLLOW_POWER = BIT(3),
  162. REGULATORY_COUNTRY_IE_IGNORE = BIT(4),
  163. REGULATORY_ENABLE_RELAX_NO_IR = BIT(5),
  164. /* reuse bit 6 next time */
  165. REGULATORY_WIPHY_SELF_MANAGED = BIT(7),
  166. };
  167. struct ieee80211_freq_range {
  168. u32 start_freq_khz;
  169. u32 end_freq_khz;
  170. u32 max_bandwidth_khz;
  171. };
  172. struct ieee80211_power_rule {
  173. u32 max_antenna_gain;
  174. u32 max_eirp;
  175. };
  176. /**
  177. * struct ieee80211_wmm_ac - used to store per ac wmm regulatory limitation
  178. *
  179. * The information provided in this structure is required for QoS
  180. * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
  181. *
  182. * @cw_min: minimum contention window [a value of the form
  183. * 2^n-1 in the range 1..32767]
  184. * @cw_max: maximum contention window [like @cw_min]
  185. * @cot: maximum burst time in units of 32 usecs, 0 meaning disabled
  186. * @aifsn: arbitration interframe space [0..255]
  187. *
  188. */
  189. struct ieee80211_wmm_ac {
  190. u16 cw_min;
  191. u16 cw_max;
  192. u16 cot;
  193. u8 aifsn;
  194. };
  195. struct ieee80211_wmm_rule {
  196. struct ieee80211_wmm_ac client[IEEE80211_NUM_ACS];
  197. struct ieee80211_wmm_ac ap[IEEE80211_NUM_ACS];
  198. };
  199. struct ieee80211_reg_rule {
  200. struct ieee80211_freq_range freq_range;
  201. struct ieee80211_power_rule power_rule;
  202. struct ieee80211_wmm_rule wmm_rule;
  203. u32 flags;
  204. u32 dfs_cac_ms;
  205. bool has_wmm;
  206. };
  207. struct ieee80211_regdomain {
  208. struct rcu_head rcu_head;
  209. u32 n_reg_rules;
  210. char alpha2[3];
  211. enum nl80211_dfs_regions dfs_region;
  212. struct ieee80211_reg_rule reg_rules[];
  213. };
  214. #define REG_RULE_EXT(start, end, bw, gain, eirp, dfs_cac, reg_flags) \
  215. { \
  216. .freq_range.start_freq_khz = MHZ_TO_KHZ(start), \
  217. .freq_range.end_freq_khz = MHZ_TO_KHZ(end), \
  218. .freq_range.max_bandwidth_khz = MHZ_TO_KHZ(bw), \
  219. .power_rule.max_antenna_gain = DBI_TO_MBI(gain), \
  220. .power_rule.max_eirp = DBM_TO_MBM(eirp), \
  221. .flags = reg_flags, \
  222. .dfs_cac_ms = dfs_cac, \
  223. }
  224. #define REG_RULE(start, end, bw, gain, eirp, reg_flags) \
  225. REG_RULE_EXT(start, end, bw, gain, eirp, 0, reg_flags)
  226. #endif