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