package/ath9k/src/drivers/net/wireless/ath9k/regd.h

   1 /*
   2  * Copyright (c) 2008 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef REGD_H
  18 #define REGD_H
  19
  20 #include "ath9k.h"
  21
  22 #define ATH9K_MODE_11A_TURBO  ATH9K_MODE_SEL_108A
  23 #define ATH9K_MODE_11G_TURBO  ATH9K_MODE_SEL_108G
  24
  25 #define BMLEN 2
  26 #define BMZERO {(u_int64_t) 0, (u_int64_t) 0}
  27
  28 #define BM(_fa, _fb, _fc, _fd, _fe, _ff, _fg, _fh, _fi, _fj, _fk, _fl) \
  29         {((((_fa >= 0) && (_fa < 64)) ? \
  30                 (((u_int64_t) 1) << _fa) : (u_int64_t) 0) | \
  31         (((_fb >= 0) && (_fb < 64)) ? \
  32                 (((u_int64_t) 1) << _fb) : (u_int64_t) 0) | \
  33         (((_fc >= 0) && (_fc < 64)) ? \
  34                 (((u_int64_t) 1) << _fc) : (u_int64_t) 0) | \
  35         (((_fd >= 0) && (_fd < 64)) ? \
  36                 (((u_int64_t) 1) << _fd) : (u_int64_t) 0) | \
  37         (((_fe >= 0) && (_fe < 64)) ? \
  38                 (((u_int64_t) 1) << _fe) : (u_int64_t) 0) | \
  39         (((_ff >= 0) && (_ff < 64)) ? \
  40                 (((u_int64_t) 1) << _ff) : (u_int64_t) 0) | \
  41         (((_fg >= 0) && (_fg < 64)) ? \
  42                 (((u_int64_t) 1) << _fg) : (u_int64_t) 0) | \
  43         (((_fh >= 0) && (_fh < 64)) ? \
  44                 (((u_int64_t) 1) << _fh) : (u_int64_t) 0) | \
  45         (((_fi >= 0) && (_fi < 64)) ? \
  46                 (((u_int64_t) 1) << _fi) : (u_int64_t) 0) | \
  47         (((_fj >= 0) && (_fj < 64)) ? \
  48                 (((u_int64_t) 1) << _fj) : (u_int64_t) 0) | \
  49         (((_fk >= 0) && (_fk < 64)) ? \
  50                 (((u_int64_t) 1) << _fk) : (u_int64_t) 0) | \
  51         (((_fl >= 0) && (_fl < 64)) ? \
  52                 (((u_int64_t) 1) << _fl) : (u_int64_t) 0) | \
  53                         ((((_fa > 63) && (_fa < 128)) ? \
  54                         (((u_int64_t) 1) << (_fa - 64)) : (u_int64_t) 0) | \
  55         (((_fb > 63) && (_fb < 128)) ? \
  56                 (((u_int64_t) 1) << (_fb - 64)) : (u_int64_t) 0) | \
  57         (((_fc > 63) && (_fc < 128)) ? \
  58                 (((u_int64_t) 1) << (_fc - 64)) : (u_int64_t) 0) | \
  59         (((_fd > 63) && (_fd < 128)) ? \
  60                 (((u_int64_t) 1) << (_fd - 64)) : (u_int64_t) 0) | \
  61         (((_fe > 63) && (_fe < 128)) ? \
  62                 (((u_int64_t) 1) << (_fe - 64)) : (u_int64_t) 0) | \
  63         (((_ff > 63) && (_ff < 128)) ? \
  64                 (((u_int64_t) 1) << (_ff - 64)) : (u_int64_t) 0) | \
  65         (((_fg > 63) && (_fg < 128)) ? \
  66                 (((u_int64_t) 1) << (_fg - 64)) : (u_int64_t) 0) | \
  67         (((_fh > 63) && (_fh < 128)) ? \
  68                 (((u_int64_t) 1) << (_fh - 64)) : (u_int64_t) 0) | \
  69         (((_fi > 63) && (_fi < 128)) ? \
  70                 (((u_int64_t) 1) << (_fi - 64)) : (u_int64_t) 0) | \
  71         (((_fj > 63) && (_fj < 128)) ? \
  72                 (((u_int64_t) 1) << (_fj - 64)) : (u_int64_t) 0) | \
  73         (((_fk > 63) && (_fk < 128)) ? \
  74                 (((u_int64_t) 1) << (_fk - 64)) : (u_int64_t) 0) | \
  75         (((_fl > 63) && (_fl < 128)) ? \
  76                 (((u_int64_t) 1) << (_fl - 64)) : (u_int64_t) 0)))}
  77
  78 #define DEF_REGDMN      FCC1_FCCA
  79 #define DEF_DMN_5       FCC1
  80 #define DEF_DMN_2       FCCA
  81 #define COUNTRY_ERD_FLAG        0x8000
  82 #define WORLDWIDE_ROAMING_FLAG  0x4000
  83 #define SUPER_DOMAIN_MASK   0x0fff
  84 #define COUNTRY_CODE_MASK   0x3fff
  85 #define CF_INTERFERENCE     (CHANNEL_CW_INT | CHANNEL_RADAR_INT)
  86 #define CHANNEL_14      (2484)
  87 #define IS_11G_CH14(_ch,_cf) \
  88     (((_ch) == CHANNEL_14) && ((_cf) == CHANNEL_G))
  89
  90 #define NO_PSCAN    0x0ULL
  91 #define PSCAN_FCC   0x0000000000000001ULL
  92 #define PSCAN_FCC_T 0x0000000000000002ULL
  93 #define PSCAN_ETSI  0x0000000000000004ULL
  94 #define PSCAN_MKK1  0x0000000000000008ULL
  95 #define PSCAN_MKK2  0x0000000000000010ULL
  96 #define PSCAN_MKKA  0x0000000000000020ULL
  97 #define PSCAN_MKKA_G    0x0000000000000040ULL
  98 #define PSCAN_ETSIA 0x0000000000000080ULL
  99 #define PSCAN_ETSIB 0x0000000000000100ULL
 100 #define PSCAN_ETSIC 0x0000000000000200ULL
 101 #define PSCAN_WWR   0x0000000000000400ULL
 102 #define PSCAN_MKKA1 0x0000000000000800ULL
 103 #define PSCAN_MKKA1_G   0x0000000000001000ULL
 104 #define PSCAN_MKKA2 0x0000000000002000ULL
 105 #define PSCAN_MKKA2_G   0x0000000000004000ULL
 106 #define PSCAN_MKK3  0x0000000000008000ULL
 107 #define PSCAN_DEFER 0x7FFFFFFFFFFFFFFFULL
 108 #define IS_ECM_CHAN 0x8000000000000000ULL
 109
 110 #define isWwrSKU(_ah) \
 111         (((ath9k_regd_get_eepromRD((_ah)) & WORLD_SKU_MASK) == \
 112                 WORLD_SKU_PREFIX) || \
 113                 (ath9k_regd_get_eepromRD(_ah) == WORLD))
 114
 115 #define isWwrSKU_NoMidband(_ah) \
 116         ((ath9k_regd_get_eepromRD((_ah)) == WOR3_WORLD) || \
 117         (ath9k_regd_get_eepromRD(_ah) == WOR4_WORLD) || \
 118         (ath9k_regd_get_eepromRD(_ah) == WOR5_ETSIC))
 119
 120 #define isUNII1OddChan(ch) \
 121         ((ch == 5170) || (ch == 5190) || (ch == 5210) || (ch == 5230))
 122
 123 #define IS_HT40_MODE(_mode)      \
 124         (((_mode == ATH9K_MODE_SEL_11NA_HT40PLUS  || \
 125         _mode == ATH9K_MODE_SEL_11NG_HT40PLUS    || \
 126         _mode == ATH9K_MODE_SEL_11NA_HT40MINUS   || \
 127         _mode == ATH9K_MODE_SEL_11NG_HT40MINUS) ? AH_TRUE : AH_FALSE))
 128
 129 #define CHAN_FLAGS      (CHANNEL_ALL|CHANNEL_HALF|CHANNEL_QUARTER)
 130
 131 #define swap(_a, _b, _size) {                   \
 132         u_int8_t *s = _b;                       \
 133         int i = _size;                          \
 134         do {                                    \
 135                 u_int8_t tmp = *_a;             \
 136                 *_a++ = *s;                     \
 137                 *s++ = tmp;                     \
 138         } while (--i);                          \
 139         _a -= _size;                            \
 140 }
 141
 142
 143 #define HALF_MAXCHANBW          10
 144
 145 #define MULTI_DOMAIN_MASK 0xFF00
 146
 147 #define WORLD_SKU_MASK          0x00F0
 148 #define WORLD_SKU_PREFIX        0x0060
 149
 150 #define CHANNEL_HALF_BW         10
 151 #define CHANNEL_QUARTER_BW      5
 152
 153 typedef int ath_hal_cmp_t(const void *, const void *);
 154
 155 struct reg_dmn_pair_mapping {
 156         u_int16_t regDmnEnum;
 157         u_int16_t regDmn5GHz;
 158         u_int16_t regDmn2GHz;
 159         u_int32_t flags5GHz;
 160         u_int32_t flags2GHz;
 161         u_int64_t pscanMask;
 162         u_int16_t singleCC;
 163 };
 164
 165 struct ccmap {
 166         char isoName[3];
 167         u_int16_t countryCode;
 168 };
 169
 170 struct country_code_to_enum_rd {
 171         u_int16_t countryCode;
 172         u_int16_t regDmnEnum;
 173         const char *isoName;
 174         const char *name;
 175         enum hal_bool allow11g;
 176         enum hal_bool allow11aTurbo;
 177         enum hal_bool allow11gTurbo;
 178         enum hal_bool allow11ng20;
 179         enum hal_bool allow11ng40;
 180         enum hal_bool allow11na20;
 181         enum hal_bool allow11na40;
 182         u_int16_t outdoorChanStart;
 183 };
 184
 185 struct RegDmnFreqBand {
 186         u_int16_t lowChannel;
 187         u_int16_t highChannel;
 188         u_int8_t powerDfs;
 189         u_int8_t antennaMax;
 190         u_int8_t channelBW;
 191         u_int8_t channelSep;
 192         u_int64_t useDfs;
 193         u_int64_t usePassScan;
 194         u_int8_t regClassId;
 195 };
 196
 197 struct regDomain {
 198         u_int16_t regDmnEnum;
 199         u_int8_t conformanceTestLimit;
 200         u_int64_t dfsMask;
 201         u_int64_t pscan;
 202         u_int32_t flags;
 203         u_int64_t chan11a[BMLEN];
 204         u_int64_t chan11a_turbo[BMLEN];
 205         u_int64_t chan11a_dyn_turbo[BMLEN];
 206         u_int64_t chan11b[BMLEN];
 207         u_int64_t chan11g[BMLEN];
 208         u_int64_t chan11g_turbo[BMLEN];
 209 };
 210
 211 struct cmode {
 212         u_int32_t mode;
 213         u_int32_t flags;
 214 };
 215
 216 #define YES AH_TRUE
 217 #define NO  AH_FALSE
 218
 219 struct japan_bandcheck {
 220         u_int16_t freqbandbit;
 221         u_int32_t eepromflagtocheck;
 222 };
 223
 224 struct common_mode_power {
 225         u_int16_t lchan;
 226         u_int16_t hchan;
 227         u_int8_t pwrlvl;
 228 };
 229
 230 enum CountryCode {
 231         CTRY_ALBANIA = 8,
 232         CTRY_ALGERIA = 12,
 233         CTRY_ARGENTINA = 32,
 234         CTRY_ARMENIA = 51,
 235         CTRY_AUSTRALIA = 36,
 236         CTRY_AUSTRIA = 40,
 237         CTRY_AZERBAIJAN = 31,
 238         CTRY_BAHRAIN = 48,
 239         CTRY_BELARUS = 112,
 240         CTRY_BELGIUM = 56,
 241         CTRY_BELIZE = 84,
 242         CTRY_BOLIVIA = 68,
 243         CTRY_BOSNIA_HERZ = 70,
 244         CTRY_BRAZIL = 76,
 245         CTRY_BRUNEI_DARUSSALAM = 96,
 246         CTRY_BULGARIA = 100,
 247         CTRY_CANADA = 124,
 248         CTRY_CHILE = 152,
 249         CTRY_CHINA = 156,
 250         CTRY_COLOMBIA = 170,
 251         CTRY_COSTA_RICA = 188,
 252         CTRY_CROATIA = 191,
 253         CTRY_CYPRUS = 196,
 254         CTRY_CZECH = 203,
 255         CTRY_DENMARK = 208,
 256         CTRY_DOMINICAN_REPUBLIC = 214,
 257         CTRY_ECUADOR = 218,
 258         CTRY_EGYPT = 818,
 259         CTRY_EL_SALVADOR = 222,
 260         CTRY_ESTONIA = 233,
 261         CTRY_FAEROE_ISLANDS = 234,
 262         CTRY_FINLAND = 246,
 263         CTRY_FRANCE = 250,
 264         CTRY_GEORGIA = 268,
 265         CTRY_GERMANY = 276,
 266         CTRY_GREECE = 300,
 267         CTRY_GUATEMALA = 320,
 268         CTRY_HONDURAS = 340,
 269         CTRY_HONG_KONG = 344,
 270         CTRY_HUNGARY = 348,
 271         CTRY_ICELAND = 352,
 272         CTRY_INDIA = 356,
 273         CTRY_INDONESIA = 360,
 274         CTRY_IRAN = 364,
 275         CTRY_IRAQ = 368,
 276         CTRY_IRELAND = 372,
 277         CTRY_ISRAEL = 376,
 278         CTRY_ITALY = 380,
 279         CTRY_JAMAICA = 388,
 280         CTRY_JAPAN = 392,
 281         CTRY_JORDAN = 400,
 282         CTRY_KAZAKHSTAN = 398,
 283         CTRY_KENYA = 404,
 284         CTRY_KOREA_NORTH = 408,
 285         CTRY_KOREA_ROC = 410,
 286         CTRY_KOREA_ROC2 = 411,
 287         CTRY_KOREA_ROC3 = 412,
 288         CTRY_KUWAIT = 414,
 289         CTRY_LATVIA = 428,
 290         CTRY_LEBANON = 422,
 291         CTRY_LIBYA = 434,
 292         CTRY_LIECHTENSTEIN = 438,
 293         CTRY_LITHUANIA = 440,
 294         CTRY_LUXEMBOURG = 442,
 295         CTRY_MACAU = 446,
 296         CTRY_MACEDONIA = 807,
 297         CTRY_MALAYSIA = 458,
 298         CTRY_MALTA = 470,
 299         CTRY_MEXICO = 484,
 300         CTRY_MONACO = 492,
 301         CTRY_MOROCCO = 504,
 302         CTRY_NEPAL = 524,
 303         CTRY_NETHERLANDS = 528,
 304         CTRY_NETHERLANDS_ANTILLES = 530,
 305         CTRY_NEW_ZEALAND = 554,
 306         CTRY_NICARAGUA = 558,
 307         CTRY_NORWAY = 578,
 308         CTRY_OMAN = 512,
 309         CTRY_PAKISTAN = 586,
 310         CTRY_PANAMA = 591,
 311         CTRY_PAPUA_NEW_GUINEA = 598,
 312         CTRY_PARAGUAY = 600,
 313         CTRY_PERU = 604,
 314         CTRY_PHILIPPINES = 608,
 315         CTRY_POLAND = 616,
 316         CTRY_PORTUGAL = 620,
 317         CTRY_PUERTO_RICO = 630,
 318         CTRY_QATAR = 634,
 319         CTRY_ROMANIA = 642,
 320         CTRY_RUSSIA = 643,
 321         CTRY_SAUDI_ARABIA = 682,
 322         CTRY_SERBIA_MONTENEGRO = 891,
 323         CTRY_SINGAPORE = 702,
 324         CTRY_SLOVAKIA = 703,
 325         CTRY_SLOVENIA = 705,
 326         CTRY_SOUTH_AFRICA = 710,
 327         CTRY_SPAIN = 724,
 328         CTRY_SRI_LANKA = 144,
 329         CTRY_SWEDEN = 752,
 330         CTRY_SWITZERLAND = 756,
 331         CTRY_SYRIA = 760,
 332         CTRY_TAIWAN = 158,
 333         CTRY_THAILAND = 764,
 334         CTRY_TRINIDAD_Y_TOBAGO = 780,
 335         CTRY_TUNISIA = 788,
 336         CTRY_TURKEY = 792,
 337         CTRY_UAE = 784,
 338         CTRY_UKRAINE = 804,
 339         CTRY_UNITED_KINGDOM = 826,
 340         CTRY_UNITED_STATES = 840,
 341         CTRY_UNITED_STATES_FCC49 = 842,
 342         CTRY_URUGUAY = 858,
 343         CTRY_UZBEKISTAN = 860,
 344         CTRY_VENEZUELA = 862,
 345         CTRY_VIET_NAM = 704,
 346         CTRY_YEMEN = 887,
 347         CTRY_ZIMBABWE = 716,
 348         CTRY_JAPAN1 = 393,
 349         CTRY_JAPAN2 = 394,
 350         CTRY_JAPAN3 = 395,
 351         CTRY_JAPAN4 = 396,
 352         CTRY_JAPAN5 = 397,
 353         CTRY_JAPAN6 = 4006,
 354         CTRY_JAPAN7 = 4007,
 355         CTRY_JAPAN8 = 4008,
 356         CTRY_JAPAN9 = 4009,
 357         CTRY_JAPAN10 = 4010,
 358         CTRY_JAPAN11 = 4011,
 359         CTRY_JAPAN12 = 4012,
 360         CTRY_JAPAN13 = 4013,
 361         CTRY_JAPAN14 = 4014,
 362         CTRY_JAPAN15 = 4015,
 363         CTRY_JAPAN16 = 4016,
 364         CTRY_JAPAN17 = 4017,
 365         CTRY_JAPAN18 = 4018,
 366         CTRY_JAPAN19 = 4019,
 367         CTRY_JAPAN20 = 4020,
 368         CTRY_JAPAN21 = 4021,
 369         CTRY_JAPAN22 = 4022,
 370         CTRY_JAPAN23 = 4023,
 371         CTRY_JAPAN24 = 4024,
 372         CTRY_JAPAN25 = 4025,
 373         CTRY_JAPAN26 = 4026,
 374         CTRY_JAPAN27 = 4027,
 375         CTRY_JAPAN28 = 4028,
 376         CTRY_JAPAN29 = 4029,
 377         CTRY_JAPAN30 = 4030,
 378         CTRY_JAPAN31 = 4031,
 379         CTRY_JAPAN32 = 4032,
 380         CTRY_JAPAN33 = 4033,
 381         CTRY_JAPAN34 = 4034,
 382         CTRY_JAPAN35 = 4035,
 383         CTRY_JAPAN36 = 4036,
 384         CTRY_JAPAN37 = 4037,
 385         CTRY_JAPAN38 = 4038,
 386         CTRY_JAPAN39 = 4039,
 387         CTRY_JAPAN40 = 4040,
 388         CTRY_JAPAN41 = 4041,
 389         CTRY_JAPAN42 = 4042,
 390         CTRY_JAPAN43 = 4043,
 391         CTRY_JAPAN44 = 4044,
 392         CTRY_JAPAN45 = 4045,
 393         CTRY_JAPAN46 = 4046,
 394         CTRY_JAPAN47 = 4047,
 395         CTRY_JAPAN48 = 4048,
 396         CTRY_JAPAN49 = 4049,
 397         CTRY_JAPAN50 = 4050,
 398         CTRY_JAPAN51 = 4051,
 399         CTRY_JAPAN52 = 4052,
 400         CTRY_JAPAN53 = 4053,
 401         CTRY_JAPAN54 = 4054,
 402         CTRY_JAPAN55 = 4055,
 403         CTRY_JAPAN56 = 4056,
 404         CTRY_JAPAN57 = 4057,
 405         CTRY_JAPAN58 = 4058,
 406         CTRY_JAPAN59 = 4059,
 407         CTRY_AUSTRALIA2 = 5000,
 408         CTRY_CANADA2 = 5001,
 409         CTRY_BELGIUM2 = 5002
 410 };
 411
 412 void ath9k_regd_get_current_country(struct ath_hal *ah,
 413                                     struct hal_country_entry *ctry);
 414
 415 #endif