include/net/regulatory.h

   1 #ifndef __NET_REGULATORY_H
   2 #define __NET_REGULATORY_H
   3 /*
   4  * regulatory support structures
   5  *
   6  * Copyright 2008-2009  Luis R. Rodriguez <mcgrof@qca.qualcomm.com>
   7  *
   8  * Permission to use, copy, modify, and/or distribute this software for any
   9  * purpose with or without fee is hereby granted, provided that the above
  10  * copyright notice and this permission notice appear in all copies.
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  19  */
  20
  21
  22 /**
  23  * enum environment_cap - Environment parsed from country IE
  24  * @ENVIRON_ANY: indicates country IE applies to both indoor and
  25  *      outdoor operation.
  26  * @ENVIRON_INDOOR: indicates country IE applies only to indoor operation
  27  * @ENVIRON_OUTDOOR: indicates country IE applies only to outdoor operation
  28  */
  29 enum environment_cap {
  30         ENVIRON_ANY,
  31         ENVIRON_INDOOR,
  32         ENVIRON_OUTDOOR,
  33 };
  34
  35 /**
  36  * struct regulatory_request - used to keep track of regulatory requests
  37  *
  38  * @wiphy_idx: this is set if this request's initiator is
  39  *      %REGDOM_SET_BY_COUNTRY_IE or %REGDOM_SET_BY_DRIVER. This
  40  *      can be used by the wireless core to deal with conflicts
  41  *      and potentially inform users of which devices specifically
  42  *      cased the conflicts.
  43  * @initiator: indicates who sent this request, could be any of
  44  *      of those set in nl80211_reg_initiator (%NL80211_REGDOM_SET_BY_*)
  45  * @alpha2: the ISO / IEC 3166 alpha2 country code of the requested
  46  *      regulatory domain. We have a few special codes:
  47  *      00 - World regulatory domain
  48  *      99 - built by driver but a specific alpha2 cannot be determined
  49  *      98 - result of an intersection between two regulatory domains
  50  *      97 - regulatory domain has not yet been configured
  51  * @dfs_region: If CRDA responded with a regulatory domain that requires
  52  *      DFS master operation on a known DFS region (NL80211_DFS_*),
  53  *      dfs_region represents that region. Drivers can use this and the
  54  *      @alpha2 to adjust their device's DFS parameters as required.
  55  * @user_reg_hint_type: if the @initiator was of type
  56  *      %NL80211_REGDOM_SET_BY_USER, this classifies the type
  57  *      of hint passed. This could be any of the %NL80211_USER_REG_HINT_*
  58  *      types.
  59  * @intersect: indicates whether the wireless core should intersect
  60  *      the requested regulatory domain with the presently set regulatory
  61  *      domain.
  62  * @processed: indicates whether or not this requests has already been
  63  *      processed. When the last request is processed it means that the
  64  *      currently regulatory domain set on cfg80211 is updated from
  65  *      CRDA and can be used by other regulatory requests. When a
  66  *      the last request is not yet processed we must yield until it
  67  *      is processed before processing any new requests.
  68  * @country_ie_checksum: checksum of the last processed and accepted
  69  *      country IE
  70  * @country_ie_env: lets us know if the AP is telling us we are outdoor,
  71  *      indoor, or if it doesn't matter
  72  * @list: used to insert into the reg_requests_list linked list
  73  */
  74 struct regulatory_request {
  75         int wiphy_idx;
  76         enum nl80211_reg_initiator initiator;
  77         enum nl80211_user_reg_hint_type user_reg_hint_type;
  78         char alpha2[2];
  79         u8 dfs_region;
  80         bool intersect;
  81         bool processed;
  82         enum environment_cap country_ie_env;
  83         struct list_head list;
  84 };
  85
  86 struct ieee80211_freq_range {
  87         u32 start_freq_khz;
  88         u32 end_freq_khz;
  89         u32 max_bandwidth_khz;
  90 };
  91
  92 struct ieee80211_power_rule {
  93         u32 max_antenna_gain;
  94         u32 max_eirp;
  95 };
  96
  97 struct ieee80211_reg_rule {
  98         struct ieee80211_freq_range freq_range;
  99         struct ieee80211_power_rule power_rule;
 100         u32 flags;
 101 };
 102
 103 struct ieee80211_regdomain {
 104         u32 n_reg_rules;
 105         char alpha2[2];
 106         u8 dfs_region;
 107         struct ieee80211_reg_rule reg_rules[];
 108 };
 109
 110 #define MHZ_TO_KHZ(freq) ((freq) * 1000)
 111 #define KHZ_TO_MHZ(freq) ((freq) / 1000)
 112 #define DBI_TO_MBI(gain) ((gain) * 100)
 113 #define MBI_TO_DBI(gain) ((gain) / 100)
 114 #define DBM_TO_MBM(gain) ((gain) * 100)
 115 #define MBM_TO_DBM(gain) ((gain) / 100)
 116
 117 #define REG_RULE(start, end, bw, gain, eirp, reg_flags) \
 118 {                                                       \
 119         .freq_range.start_freq_khz = MHZ_TO_KHZ(start), \
 120         .freq_range.end_freq_khz = MHZ_TO_KHZ(end),     \
 121         .freq_range.max_bandwidth_khz = MHZ_TO_KHZ(bw), \
 122         .power_rule.max_antenna_gain = DBI_TO_MBI(gain),\
 123         .power_rule.max_eirp = DBM_TO_MBM(eirp),        \
 124         .flags = reg_flags,                             \
 125 }
 126
 127 #endif