orinoco: Move WEXT handlers into a separate file
[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 /* Frequency is one where radar detection is required */
158 static bool ath9k_is_radar_freq(u16 center_freq)
159 {
160         return (center_freq >= 5260 && center_freq <= 5700);
161 }
162
163 /*
164  * Enable adhoc on 5 GHz if allowed by 11d.
165  * Remove passive scan if channel is allowed by 11d,
166  * except when on radar frequencies.
167  */
168 static void ath9k_reg_apply_5ghz_beaconing_flags(struct wiphy *wiphy,
169                                              enum reg_set_by setby)
170 {
171         struct ieee80211_supported_band *sband;
172         const struct ieee80211_reg_rule *reg_rule;
173         struct ieee80211_channel *ch;
174         unsigned int i;
175         u32 bandwidth = 0;
176         int r;
177
178         if (setby != REGDOM_SET_BY_COUNTRY_IE)
179                 return;
180         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
181                 return;
182
183         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
184         for (i = 0; i < sband->n_channels; i++) {
185                 ch = &sband->channels[i];
186                 r = freq_reg_info(wiphy, ch->center_freq,
187                         &bandwidth, &reg_rule);
188                 if (r)
189                         continue;
190                 /* If 11d had a rule for this channel ensure we enable adhoc
191                  * if it allows us to use it. Note that we would have disabled
192                  * it by applying our static world regdomain by default during
193                  * probe */
194                 if (!(reg_rule->flags & NL80211_RRF_NO_IBSS))
195                         ch->flags &= ~IEEE80211_CHAN_NO_IBSS;
196                 if (!ath9k_is_radar_freq(ch->center_freq))
197                         continue;
198                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
199                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
200         }
201 }
202
203 /* Allows active scan scan on Ch 12 and 13 */
204 static void ath9k_reg_apply_active_scan_flags(struct wiphy *wiphy,
205                                               enum reg_set_by setby)
206 {
207         struct ieee80211_supported_band *sband;
208         struct ieee80211_channel *ch;
209         const struct ieee80211_reg_rule *reg_rule;
210         u32 bandwidth = 0;
211         int r;
212
213         /* Force passive scan on Channels 12-13 */
214         sband = wiphy->bands[IEEE80211_BAND_2GHZ];
215
216         /* If no country IE has been received always enable active scan
217          * on these channels */
218         if (setby != REGDOM_SET_BY_COUNTRY_IE) {
219                 ch = &sband->channels[11]; /* CH 12 */
220                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
221                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
222                 ch = &sband->channels[12]; /* CH 13 */
223                 if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
224                         ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
225                 return;
226         }
227
228         /* If a country IE has been recieved check its rule for this
229          * channel first before enabling active scan. The passive scan
230          * would have been enforced by the initial probe processing on
231          * our custom regulatory domain. */
232
233         ch = &sband->channels[11]; /* CH 12 */
234         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
235         if (!r) {
236                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
237                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
238                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
239         }
240
241         ch = &sband->channels[12]; /* CH 13 */
242         r = freq_reg_info(wiphy, ch->center_freq, &bandwidth, &reg_rule);
243         if (!r) {
244                 if (!(reg_rule->flags & NL80211_RRF_PASSIVE_SCAN))
245                         if (ch->flags & IEEE80211_CHAN_PASSIVE_SCAN)
246                                 ch->flags &= ~IEEE80211_CHAN_PASSIVE_SCAN;
247         }
248 }
249
250 /* Always apply Radar/DFS rules on freq range 5260 MHz - 5700 MHz */
251 void ath9k_reg_apply_radar_flags(struct wiphy *wiphy)
252 {
253         struct ieee80211_supported_band *sband;
254         struct ieee80211_channel *ch;
255         unsigned int i;
256
257         if (!wiphy->bands[IEEE80211_BAND_5GHZ])
258                 return;
259
260         sband = wiphy->bands[IEEE80211_BAND_5GHZ];
261
262         for (i = 0; i < sband->n_channels; i++) {
263                 ch = &sband->channels[i];
264                 if (!ath9k_is_radar_freq(ch->center_freq))
265                         continue;
266                 /* We always enable radar detection/DFS on this
267                  * frequency range. Additionally we also apply on
268                  * this frequency range:
269                  * - If STA mode does not yet have DFS supports disable
270                  *   active scanning
271                  * - If adhoc mode does not support DFS yet then
272                  *   disable adhoc in the frequency.
273                  * - If AP mode does not yet support radar detection/DFS
274                  *   do not allow AP mode
275                  */
276                 if (!(ch->flags & IEEE80211_CHAN_DISABLED))
277                         ch->flags |= IEEE80211_CHAN_RADAR |
278                                      IEEE80211_CHAN_NO_IBSS |
279                                      IEEE80211_CHAN_PASSIVE_SCAN;
280         }
281 }
282
283 void ath9k_reg_apply_world_flags(struct wiphy *wiphy, enum reg_set_by setby)
284 {
285         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
286         struct ath_softc *sc = hw->priv;
287         struct ath_hal *ah = sc->sc_ah;
288
289         switch (ah->regpair->regDmnEnum) {
290         case 0x60:
291         case 0x63:
292         case 0x66:
293         case 0x67:
294                 ath9k_reg_apply_5ghz_beaconing_flags(wiphy, setby);
295                 break;
296         case 0x68:
297                 ath9k_reg_apply_5ghz_beaconing_flags(wiphy, setby);
298                 ath9k_reg_apply_active_scan_flags(wiphy, setby);
299                 break;
300         }
301         return;
302 }
303
304 int ath9k_reg_notifier(struct wiphy *wiphy, struct regulatory_request *request)
305 {
306         struct ieee80211_hw *hw = wiphy_to_ieee80211_hw(wiphy);
307         struct ath_softc *sc = hw->priv;
308
309         /* We always apply this */
310         ath9k_reg_apply_radar_flags(wiphy);
311
312         switch (request->initiator) {
313         case REGDOM_SET_BY_DRIVER:
314         case REGDOM_SET_BY_INIT:
315         case REGDOM_SET_BY_CORE:
316         case REGDOM_SET_BY_USER:
317                 break;
318         case REGDOM_SET_BY_COUNTRY_IE:
319                 if (ath9k_is_world_regd(sc->sc_ah))
320                         ath9k_reg_apply_world_flags(wiphy, request->initiator);
321                 break;
322         }
323
324         return 0;
325 }
326
327 bool ath9k_regd_is_eeprom_valid(struct ath_hal *ah)
328 {
329         u16 rd = ath9k_regd_get_eepromRD(ah);
330         int i;
331
332         if (rd & COUNTRY_ERD_FLAG) {
333                 /* EEPROM value is a country code */
334                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
335                 for (i = 0; i < ARRAY_SIZE(allCountries); i++)
336                         if (allCountries[i].countryCode == cc)
337                                 return true;
338         } else {
339                 /* EEPROM value is a regpair value */
340                 for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++)
341                         if (regDomainPairs[i].regDmnEnum == rd)
342                                 return true;
343         }
344         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
345                  "invalid regulatory domain/country code 0x%x\n", rd);
346         return false;
347 }
348
349 /* EEPROM country code to regpair mapping */
350 static struct country_code_to_enum_rd*
351 ath9k_regd_find_country(u16 countryCode)
352 {
353         int i;
354
355         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
356                 if (allCountries[i].countryCode == countryCode)
357                         return &allCountries[i];
358         }
359         return NULL;
360 }
361
362 /* EEPROM rd code to regpair mapping */
363 static struct country_code_to_enum_rd*
364 ath9k_regd_find_country_by_rd(int regdmn)
365 {
366         int i;
367
368         for (i = 0; i < ARRAY_SIZE(allCountries); i++) {
369                 if (allCountries[i].regDmnEnum == regdmn)
370                         return &allCountries[i];
371         }
372         return NULL;
373 }
374
375 /* Returns the map of the EEPROM set RD to a country code */
376 static u16 ath9k_regd_get_default_country(struct ath_hal *ah)
377 {
378         u16 rd;
379
380         rd = ath9k_regd_get_eepromRD(ah);
381         if (rd & COUNTRY_ERD_FLAG) {
382                 struct country_code_to_enum_rd *country = NULL;
383                 u16 cc = rd & ~COUNTRY_ERD_FLAG;
384
385                 country = ath9k_regd_find_country(cc);
386                 if (country != NULL)
387                         return cc;
388         }
389
390         return CTRY_DEFAULT;
391 }
392
393 static struct reg_dmn_pair_mapping*
394 ath9k_get_regpair(int regdmn)
395 {
396         int i;
397
398         if (regdmn == NO_ENUMRD)
399                 return NULL;
400         for (i = 0; i < ARRAY_SIZE(regDomainPairs); i++) {
401                 if (regDomainPairs[i].regDmnEnum == regdmn)
402                         return &regDomainPairs[i];
403         }
404         return NULL;
405 }
406
407 int ath9k_regd_init(struct ath_hal *ah)
408 {
409         struct country_code_to_enum_rd *country = NULL;
410         int regdmn;
411
412         if (!ath9k_regd_is_eeprom_valid(ah)) {
413                 DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
414                         "Invalid EEPROM contents\n");
415                 return -EINVAL;
416         }
417
418         ah->ah_countryCode = ath9k_regd_get_default_country(ah);
419
420         if (ah->ah_countryCode == CTRY_DEFAULT &&
421             ath9k_regd_get_eepromRD(ah) == CTRY_DEFAULT)
422                 ah->ah_countryCode = CTRY_UNITED_STATES;
423
424         if (ah->ah_countryCode == CTRY_DEFAULT) {
425                 regdmn = ath9k_regd_get_eepromRD(ah);
426                 country = NULL;
427         } else {
428                 country = ath9k_regd_find_country(ah->ah_countryCode);
429                 if (country == NULL) {
430                         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
431                                 "Country is NULL!!!!, cc= %d\n",
432                                 ah->ah_countryCode);
433                         return -EINVAL;
434                 } else
435                         regdmn = country->regDmnEnum;
436         }
437
438         ah->ah_currentRDInUse = regdmn;
439         ah->regpair = ath9k_get_regpair(regdmn);
440
441         if (!ah->regpair) {
442                 DPRINTF(ah->ah_sc, ATH_DBG_FATAL,
443                         "No regulatory domain pair found, cannot continue\n");
444                 return -EINVAL;
445         }
446
447         if (!country)
448                 country = ath9k_regd_find_country_by_rd(regdmn);
449
450         if (country) {
451                 ah->alpha2[0] = country->isoName[0];
452                 ah->alpha2[1] = country->isoName[1];
453         } else {
454                 ah->alpha2[0] = '0';
455                 ah->alpha2[1] = '0';
456         }
457
458         DPRINTF(ah->ah_sc, ATH_DBG_REGULATORY,
459                 "Country alpha2 being used: %c%c\n"
460                 "Regpair detected: 0x%0x\n",
461                 ah->alpha2[0], ah->alpha2[1],
462                 ah->regpair->regDmnEnum);
463
464         return 0;
465 }
466
467 u32 ath9k_regd_get_ctl(struct ath_hal *ah, struct ath9k_channel *chan)
468 {
469         u32 ctl = NO_CTL;
470
471         if (!ah->regpair ||
472             (ah->ah_countryCode == CTRY_DEFAULT && isWwrSKU(ah))) {
473                 if (IS_CHAN_B(chan))
474                         ctl = SD_NO_CTL | CTL_11B;
475                 else if (IS_CHAN_G(chan))
476                         ctl = SD_NO_CTL | CTL_11G;
477                 else
478                         ctl = SD_NO_CTL | CTL_11A;
479                 return ctl;
480         }
481
482         if (IS_CHAN_B(chan))
483                 ctl = ah->regpair->reg_2ghz_ctl | CTL_11B;
484         else if (IS_CHAN_G(chan))
485                 ctl = ah->regpair->reg_5ghz_ctl | CTL_11G;
486         else
487                 ctl = ah->regpair->reg_5ghz_ctl | CTL_11A;
488
489         return ctl;
490 }