Merge branch 'master' of /home/davem/src/GIT/linux-2.6/
[linux-2.6] / drivers / net / wireless / ath9k / regd.c
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 #include <linux/kernel.h>
18 #include <linux/slab.h>
19 #include "core.h"
20 #include "hw.h"
21 #include "regd.h"
22 #include "regd_common.h"
23
24 /*
25  * This is a set of common rules used by our world regulatory domains.
26  * We have 12 world regulatory domains. To save space we consolidate
27  * the regulatory domains in 5 structures by frequency and change
28  * the flags on our reg_notifier() on a case by case basis.
29  */
30
31 /* Only these channels all allow active scan on all world regulatory domains */
32 #define ATH9K_2GHZ_CH01_11      REG_RULE(2412-10, 2462+10, 40, 0, 20, 0)
33
34 /* We enable active scan on these a case by case basis by regulatory domain */
35 #define ATH9K_2GHZ_CH12_13      REG_RULE(2467-10, 2472+10, 40, 0, 20,\
36                                         NL80211_RRF_PASSIVE_SCAN)
37 #define ATH9K_2GHZ_CH14         REG_RULE(2484-10, 2484+10, 40, 0, 20,\
38                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_OFDM)
39
40 /* We allow IBSS on these on a case by case basis by regulatory domain */
41 #define ATH9K_5GHZ_5150_5350    REG_RULE(5150-10, 5350+10, 40, 0, 30,\
42                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
43 #define ATH9K_5GHZ_5470_5850    REG_RULE(5470-10, 5850+10, 40, 0, 30,\
44                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
45 #define ATH9K_5GHZ_5725_5850    REG_RULE(5725-10, 5850+10, 40, 0, 30,\
46                                 NL80211_RRF_PASSIVE_SCAN | NL80211_RRF_NO_IBSS)
47
48 #define ATH9K_2GHZ_ALL          ATH9K_2GHZ_CH01_11, \
49                                 ATH9K_2GHZ_CH12_13, \
50                                 ATH9K_2GHZ_CH14
51
52 #define ATH9K_5GHZ_ALL          ATH9K_5GHZ_5150_5350, \
53                                 ATH9K_5GHZ_5470_5850
54 /* This one skips what we call "mid band" */
55 #define ATH9K_5GHZ_NO_MIDBAND   ATH9K_5GHZ_5150_5350, \
56                                 ATH9K_5GHZ_5725_5850
57
58 /* Can be used for:
59  * 0x60, 0x61, 0x62 */
60 static const struct ieee80211_regdomain ath9k_world_regdom_60_61_62 = {
61         .n_reg_rules = 5,
62         .alpha2 =  "99",
63         .reg_rules = {
64                 ATH9K_2GHZ_ALL,
65                 ATH9K_5GHZ_ALL,
66         }
67 };
68
69 /* Can be used by 0x63 and 0x65 */
70 static const struct ieee80211_regdomain ath9k_world_regdom_63_65 = {
71         .n_reg_rules = 4,
72         .alpha2 =  "99",
73         .reg_rules = {
74                 ATH9K_2GHZ_CH01_11,
75                 ATH9K_2GHZ_CH12_13,
76                 ATH9K_5GHZ_NO_MIDBAND,
77         }
78 };
79
80 /* Can be used by 0x64 only */
81 static const struct ieee80211_regdomain ath9k_world_regdom_64 = {
82         .n_reg_rules = 3,
83         .alpha2 =  "99",
84         .reg_rules = {
85                 ATH9K_2GHZ_CH01_11,
86                 ATH9K_5GHZ_NO_MIDBAND,
87         }
88 };
89
90 /* Can be used by 0x66 and 0x69 */
91 static const struct ieee80211_regdomain ath9k_world_regdom_66_69 = {
92         .n_reg_rules = 3,
93         .alpha2 =  "99",
94         .reg_rules = {
95                 ATH9K_2GHZ_CH01_11,
96                 ATH9K_5GHZ_ALL,
97         }
98 };
99
100 /* Can be used by 0x67, 0x6A and 0x68 */
101 static const struct ieee80211_regdomain ath9k_world_regdom_67_68_6A = {
102         .n_reg_rules = 4,
103         .alpha2 =  "99",
104         .reg_rules = {
105                 ATH9K_2GHZ_CH01_11,
106                 ATH9K_2GHZ_CH12_13,
107                 ATH9K_5GHZ_ALL,
108         }
109 };
110
111 static u16 ath9k_regd_get_eepromRD(struct ath_hal *ah)
112 {
113         return ah->ah_currentRD & ~WORLDWIDE_ROAMING_FLAG;
114 }
115
116 u16 ath9k_regd_get_rd(struct ath_hal *ah)
117 {
118         return ath9k_regd_get_eepromRD(ah);
119 }
120
121 bool ath9k_is_world_regd(struct ath_hal *ah)
122 {
123         return isWwrSKU(ah);
124 }
125
126 const struct ieee80211_regdomain *ath9k_default_world_regdomain(void)
127 {
128         /* this is the most restrictive */
129         return &ath9k_world_regdom_64;
130 }
131
132 const struct ieee80211_regdomain *ath9k_world_regdomain(struct ath_hal *ah)
133 {
134         switch (ah->regpair->regDmnEnum) {
135         case 0x60:
136         case 0x61:
137         case 0x62:
138                 return &ath9k_world_regdom_60_61_62;
139         case 0x63:
140         case 0x65:
141                 return &ath9k_world_regdom_63_65;
142         case 0x64:
143                 return &ath9k_world_regdom_64;
144         case 0x66:
145         case 0x69:
146                 return &ath9k_world_regdom_66_69;
147         case 0x67:
148         case 0x68:
149         case 0x6A:
150                 return &ath9k_world_regdom_67_68_6A;
151         default:
152                 WARN_ON(1);
153                 return ath9k_default_world_regdomain();
154         }
155 }
156
157 /* Enable adhoc on 5 GHz if allowed by 11d */
158 static void ath9k_reg_apply_5ghz_adhoc_flags(struct wiphy *wiphy,
159                                              enum reg_set_by setby)
160 {
161         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
162         struct ath_softc *sc = hw->priv;
163         struct ieee80211_supported_band *sband;
164         const struct ieee80211_reg_rule *reg_rule;
165         struct ieee80211_channel *ch;
166         unsigned int i;
167         u32 bandwidth = 0;
168         int r;
169
170         if (setby != REGDOM_SET_BY_COUNTRY_IE)
171                 return;
172         if (!test_bit(ATH9K_MODE_11A,
173             sc->sc_ah->ah_caps.wireless_modes))
174                 return;
175
176         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
177         for (i = 0; i < sband->n_channels; i++) {
178                 ch = &sband->channels[i];
179                 r = freq_reg_info(wiphy, ch->center_freq,
180                         &bandwidth, &reg_rule);
181                 if (r)
182                         continue;
183                 /* If 11d had a rule for this channel ensure we enable adhoc
184                  * if it allows us to use it. Note that we would have disabled
185                  * it by applying our static world regdomain by default during
186                  * probe */
187                 if (!(reg_rule->flags & NL80211_RRF_NO_IBSS))
188                         ch->flags &= ~NL80211_RRF_NO_IBSS;
189         }
190 }
191
192 /* Allows active scan scan on Ch 12 and 13 */
193 static void ath9k_reg_apply_active_scan_flags(struct wiphy *wiphy,
194                                               enum reg_set_by setby)
195 {
196         struct ieee80211_supported_band *sband;
197         struct ieee80211_channel *ch;
198         const struct ieee80211_reg_rule *reg_rule;
199         u32 bandwidth = 0;
200         int r;
201
202         /* Force passive scan on Channels 12-13 */
203         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
204
205         /* If no country IE has been received always enable active scan
206          * on these channels */
207         if (setby != REGDOM_SET_BY_COUNTRY_IE) {
208                 ch = &sband->channels[11]; /* CH 12 */
209                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
210                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
211                 ch = &sband->channels[12]; /* CH 13 */
212                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
213                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
214                 return;
215         }
216
217         /* If a country IE has been recieved check its rule for this
218          * channel first before enabling active scan. The passive scan
219          * would have been enforced by the initial probe processing on
220          * our custom regulatory domain. */
221
222         ch = &sband->channels[11]; /* CH 12 */
223         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
224         if (!r) {
225                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
226                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
227                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
228         }
229
230         ch = &sband->channels[12]; /* CH 13 */
231         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
232         if (!r) {
233                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
234                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
235                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
236         }
237 }
238
239 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
240 void ath9k_reg_apply_radar_flags(struct wiphy *wiphy)
241 {
242         struct ieee80211_supported_band *sband;
243         struct ieee80211_channel *ch;
244         unsigned int i;
245
246         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
247                 return;
248
249         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
250
251         for (i = 0; i < sband->n_channels; i++) {
252                 ch = &sband->channels[i];
253                 if (ch->center_freq < 5260)
254                         continue;
255                 if (ch->center_freq > 5700)
256                         continue;
257                 /* We always enable radar detection/DFS on this
258                  * frequency range. Additionally we also apply on
259                  * this frequency range:
260                  * - If STA mode does not yet have DFS supports disable
261                  *   active scanning
262                  * - If adhoc mode does not support DFS yet then
263                  *   disable adhoc in the frequency.
264                  * - If AP mode does not yet support radar detection/DFS
265                  *   do not allow AP mode
266                  */
267                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
268                         ch->flags |= IEEE80211_CHAN_RADAR |
269                                      IEEE80211_CHAN_NO_IBSS |
270                                      IEEE80211_CHAN_PASSIVE_SCAN;
271         }
272 }
273
274 void ath9k_reg_apply_world_flags(struct wiphy *wiphy, enum reg_set_by setby)
275 {
276         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
277         struct ath_softc *sc = hw->priv;
278         struct ath_hal *ah = sc->sc_ah;
279
280         switch (ah->regpair->regDmnEnum) {
281         case 0x60:
282         case 0x63:
283         case 0x66:
284         case 0x67:
285                 ath9k_reg_apply_5ghz_adhoc_flags(wiphy, setby);
286                 break;
287         case 0x68:
288                 ath9k_reg_apply_5ghz_adhoc_flags(wiphy, setby);
289                 ath9k_reg_apply_active_scan_flags(wiphy, setby);
290                 break;
291         }
292         return;
293 }
294
295 int ath9k_reg_notifier(struct wiphy *wiphy, struct regulatory_request *request)
296 {
297         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
298         struct ath_softc *sc = hw->priv;
299
300         /* We always apply this */
301         ath9k_reg_apply_radar_flags(wiphy);
302
303         switch (request->initiator) {
304         case REGDOM_SET_BY_DRIVER:
305         case REGDOM_SET_BY_INIT:
306         case REGDOM_SET_BY_CORE:
307         case REGDOM_SET_BY_USER:
308                 break;
309         case REGDOM_SET_BY_COUNTRY_IE:
310                 if (ath9k_is_world_regd(sc->sc_ah))
311                         ath9k_reg_apply_world_flags(wiphy, request->initiator);
312                 break;
313         }
314
315         return 0;
316 }
317
318 bool ath9k_regd_is_eeprom_valid(struct ath_hal *ah)
319 {
320         u16 rd = ath9k_regd_get_eepromRD(ah);
321         int i;
322
323         if (rd & COUNTRY_ERD_FLAG) {
324                 /* EEPROM value is a country code */
325                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
326                 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
327                         if (allCountries[i].countryCode == cc)
328                                 return true;
329         } else {
330                 /* EEPROM value is a regpair value */
331                 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
332                         if (regDomainPairs[i].regDmnEnum == rd)
333                                 return true;
334         }
335         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
336                  "invalid regulatory domain/country code 0x%x\n", rd);
337         return false;
338 }
339
340 /* EEPROM country code to regpair mapping */
341 static struct country_code_to_enum_rd*
342 ath9k_regd_find_country(u16 countryCode)
343 {
344         int i;
345
346         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
347                 if (allCountries[i].countryCode == countryCode)
348                         return &allCountries[i];
349         }
350         return NULL;
351 }
352
353 /* EEPROM rd code to regpair mapping */
354 static struct country_code_to_enum_rd*
355 ath9k_regd_find_country_by_rd(int regdmn)
356 {
357         int i;
358
359         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
360                 if (allCountries[i].regDmnEnum == regdmn)
361                         return &allCountries[i];
362         }
363         return NULL;
364 }
365
366 /* Returns the map of the EEPROM set RD to a country code */
367 static u16 ath9k_regd_get_default_country(struct ath_hal *ah)
368 {
369         u16 rd;
370
371         rd = ath9k_regd_get_eepromRD(ah);
372         if (rd & COUNTRY_ERD_FLAG) {
373                 struct country_code_to_enum_rd *country = NULL;
374                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
375
376                 country = ath9k_regd_find_country(cc);
377                 if (country != NULL)
378                         return cc;
379         }
380
381         return CTRY_DEFAULT;
382 }
383
384 static struct reg_dmn_pair_mapping*
385 ath9k_get_regpair(int regdmn)
386 {
387         int i;
388
389         if (regdmn == NO_ENUMRD)
390                 return NULL;
391         for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
392                 if (regDomainPairs[i].regDmnEnum == regdmn)
393                         return &regDomainPairs[i];
394         }
395         return NULL;
396 }
397
398 int ath9k_regd_init(struct ath_hal *ah)
399 {
400         struct country_code_to_enum_rd *country = NULL;
401         int regdmn;
402
403         if (!ath9k_regd_is_eeprom_valid(ah)) {
404                 DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
405                         "Invalid EEPROM contents\n");
406                 return -EINVAL;
407         }
408
409         ah->ah_countryCode = ath9k_regd_get_default_country(ah);
410
411         if (ah->ah_countryCode == CTRY_DEFAULT &&
412             ath9k_regd_get_eepromRD(ah) == CTRY_DEFAULT)
413                 ah->ah_countryCode = CTRY_UNITED_STATES;
414
415         if (ah->ah_countryCode == CTRY_DEFAULT) {
416                 regdmn = ath9k_regd_get_eepromRD(ah);
417                 country = NULL;
418         } else {
419                 country = ath9k_regd_find_country(ah->ah_countryCode);
420                 if (country == NULL) {
421                         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
422                                 "Country is NULL!!!!, cc= %d\n",
423                                 ah->ah_countryCode);
424                         return -EINVAL;
425                 } else
426                         regdmn = country->regDmnEnum;
427         }
428
429         ah->ah_currentRDInUse = regdmn;
430         ah->regpair = ath9k_get_regpair(regdmn);
431
432         if (!ah->regpair) {
433                 DPRINTF(ah->ah_sc, ATH_DBG_FATAL,
434                         "No regulatory domain pair found, cannot continue\n");
435                 return -EINVAL;
436         }
437
438         if (!country)
439                 country = ath9k_regd_find_country_by_rd(regdmn);
440
441         if (country) {
442                 ah->alpha2[0] = country->isoName[0];
443                 ah->alpha2[1] = country->isoName[1];
444         } else {
445                 ah->alpha2[0] = '0';
446                 ah->alpha2[1] = '0';
447         }
448
449         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
450                 "Country alpha2 being used: %c%c\n"
451                 "Regpair detected: 0x%0x\n",
452                 ah->alpha2[0], ah->alpha2[1],
453                 ah->regpair->regDmnEnum);
454
455         return 0;
456 }
457
458 u32 ath9k_regd_get_ctl(struct ath_hal *ah, struct ath9k_channel *chan)
459 {
460         u32 ctl = NO_CTL;
461
462         if (!ah->regpair ||
463             (ah->ah_countryCode == CTRY_DEFAULT && isWwrSKU(ah))) {
464                 if (IS_CHAN_B(chan))
465                         ctl = SD_NO_CTL | CTL_11B;
466                 else if (IS_CHAN_G(chan))
467                         ctl = SD_NO_CTL | CTL_11G;
468                 else
469                         ctl = SD_NO_CTL | CTL_11A;
470                 return ctl;
471         }
472
473         if (IS_CHAN_B(chan))
474                 ctl = ah->regpair->reg_2ghz_ctl | CTL_11B;
475         else if (IS_CHAN_G(chan))
476                 ctl = ah->regpair->reg_5ghz_ctl | CTL_11G;
477         else
478                 ctl = ah->regpair->reg_5ghz_ctl | CTL_11A;
479
480         return ctl;
481 }