ath9k: Add PCI IDs for CUS217
[cascardo/linux.git] / drivers / net / wireless / ath / ath9k / ani.c
1 /*
2  * Copyright (c) 2008-2011 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/export.h>
19 #include "hw.h"
20 #include "hw-ops.h"
21
22 struct ani_ofdm_level_entry {
23         int spur_immunity_level;
24         int fir_step_level;
25         int ofdm_weak_signal_on;
26 };
27
28 /* values here are relative to the INI */
29
30 /*
31  * Legend:
32  *
33  * SI: Spur immunity
34  * FS: FIR Step
35  * WS: OFDM / CCK Weak Signal detection
36  * MRC-CCK: Maximal Ratio Combining for CCK
37  */
38
39 static const struct ani_ofdm_level_entry ofdm_level_table[] = {
40         /* SI  FS  WS */
41         {  0,  0,  1  }, /* lvl 0 */
42         {  1,  1,  1  }, /* lvl 1 */
43         {  2,  2,  1  }, /* lvl 2 */
44         {  3,  2,  1  }, /* lvl 3  (default) */
45         {  4,  3,  1  }, /* lvl 4 */
46         {  5,  4,  1  }, /* lvl 5 */
47         {  6,  5,  1  }, /* lvl 6 */
48         {  7,  6,  1  }, /* lvl 7 */
49         {  7,  7,  1  }, /* lvl 8 */
50         {  7,  8,  0  }  /* lvl 9 */
51 };
52 #define ATH9K_ANI_OFDM_NUM_LEVEL \
53         ARRAY_SIZE(ofdm_level_table)
54 #define ATH9K_ANI_OFDM_MAX_LEVEL \
55         (ATH9K_ANI_OFDM_NUM_LEVEL-1)
56 #define ATH9K_ANI_OFDM_DEF_LEVEL \
57         3 /* default level - matches the INI settings */
58
59 /*
60  * MRC (Maximal Ratio Combining) has always been used with multi-antenna ofdm.
61  * With OFDM for single stream you just add up all antenna inputs, you're
62  * only interested in what you get after FFT. Signal aligment is also not
63  * required for OFDM because any phase difference adds up in the frequency
64  * domain.
65  *
66  * MRC requires extra work for use with CCK. You need to align the antenna
67  * signals from the different antenna before you can add the signals together.
68  * You need aligment of signals as CCK is in time domain, so addition can cancel
69  * your signal completely if phase is 180 degrees (think of adding sine waves).
70  * You also need to remove noise before the addition and this is where ANI
71  * MRC CCK comes into play. One of the antenna inputs may be stronger but
72  * lower SNR, so just adding after alignment can be dangerous.
73  *
74  * Regardless of alignment in time, the antenna signals add constructively after
75  * FFT and improve your reception. For more information:
76  *
77  * http://en.wikipedia.org/wiki/Maximal-ratio_combining
78  */
79
80 struct ani_cck_level_entry {
81         int fir_step_level;
82         int mrc_cck_on;
83 };
84
85 static const struct ani_cck_level_entry cck_level_table[] = {
86         /* FS  MRC-CCK  */
87         {  0,  1  }, /* lvl 0 */
88         {  1,  1  }, /* lvl 1 */
89         {  2,  1  }, /* lvl 2  (default) */
90         {  3,  1  }, /* lvl 3 */
91         {  4,  0  }, /* lvl 4 */
92         {  5,  0  }, /* lvl 5 */
93         {  6,  0  }, /* lvl 6 */
94         {  7,  0  }, /* lvl 7 (only for high rssi) */
95         {  8,  0  }  /* lvl 8 (only for high rssi) */
96 };
97
98 #define ATH9K_ANI_CCK_NUM_LEVEL \
99         ARRAY_SIZE(cck_level_table)
100 #define ATH9K_ANI_CCK_MAX_LEVEL \
101         (ATH9K_ANI_CCK_NUM_LEVEL-1)
102 #define ATH9K_ANI_CCK_MAX_LEVEL_LOW_RSSI \
103         (ATH9K_ANI_CCK_NUM_LEVEL-3)
104 #define ATH9K_ANI_CCK_DEF_LEVEL \
105         2 /* default level - matches the INI settings */
106
107 static void ath9k_hw_update_mibstats(struct ath_hw *ah,
108                                      struct ath9k_mib_stats *stats)
109 {
110         stats->ackrcv_bad += REG_READ(ah, AR_ACK_FAIL);
111         stats->rts_bad += REG_READ(ah, AR_RTS_FAIL);
112         stats->fcs_bad += REG_READ(ah, AR_FCS_FAIL);
113         stats->rts_good += REG_READ(ah, AR_RTS_OK);
114         stats->beacons += REG_READ(ah, AR_BEACON_CNT);
115 }
116
117 static void ath9k_ani_restart(struct ath_hw *ah)
118 {
119         struct ar5416AniState *aniState;
120
121         if (!ah->curchan)
122                 return;
123
124         aniState = &ah->ani;
125         aniState->listenTime = 0;
126
127         ENABLE_REGWRITE_BUFFER(ah);
128
129         REG_WRITE(ah, AR_PHY_ERR_1, 0);
130         REG_WRITE(ah, AR_PHY_ERR_2, 0);
131         REG_WRITE(ah, AR_PHY_ERR_MASK_1, AR_PHY_ERR_OFDM_TIMING);
132         REG_WRITE(ah, AR_PHY_ERR_MASK_2, AR_PHY_ERR_CCK_TIMING);
133
134         REGWRITE_BUFFER_FLUSH(ah);
135
136         ath9k_hw_update_mibstats(ah, &ah->ah_mibStats);
137
138         aniState->ofdmPhyErrCount = 0;
139         aniState->cckPhyErrCount = 0;
140 }
141
142 /* Adjust the OFDM Noise Immunity Level */
143 static void ath9k_hw_set_ofdm_nil(struct ath_hw *ah, u8 immunityLevel,
144                                   bool scan)
145 {
146         struct ar5416AniState *aniState = &ah->ani;
147         struct ath_common *common = ath9k_hw_common(ah);
148         const struct ani_ofdm_level_entry *entry_ofdm;
149         const struct ani_cck_level_entry *entry_cck;
150         bool weak_sig;
151
152         ath_dbg(common, ANI, "**** ofdmlevel %d=>%d, rssi=%d[lo=%d hi=%d]\n",
153                 aniState->ofdmNoiseImmunityLevel,
154                 immunityLevel, BEACON_RSSI(ah),
155                 ATH9K_ANI_RSSI_THR_LOW,
156                 ATH9K_ANI_RSSI_THR_HIGH);
157
158         if (!scan)
159                 aniState->ofdmNoiseImmunityLevel = immunityLevel;
160
161         entry_ofdm = &ofdm_level_table[aniState->ofdmNoiseImmunityLevel];
162         entry_cck = &cck_level_table[aniState->cckNoiseImmunityLevel];
163
164         if (aniState->spurImmunityLevel != entry_ofdm->spur_immunity_level)
165                 ath9k_hw_ani_control(ah,
166                                      ATH9K_ANI_SPUR_IMMUNITY_LEVEL,
167                                      entry_ofdm->spur_immunity_level);
168
169         if (aniState->firstepLevel != entry_ofdm->fir_step_level &&
170             entry_ofdm->fir_step_level >= entry_cck->fir_step_level)
171                 ath9k_hw_ani_control(ah,
172                                      ATH9K_ANI_FIRSTEP_LEVEL,
173                                      entry_ofdm->fir_step_level);
174
175         weak_sig = entry_ofdm->ofdm_weak_signal_on;
176         if (ah->opmode == NL80211_IFTYPE_STATION &&
177             BEACON_RSSI(ah) <= ATH9K_ANI_RSSI_THR_HIGH)
178                 weak_sig = true;
179
180         /*
181          * OFDM Weak signal detection is always enabled for AP mode.
182          */
183         if (ah->opmode != NL80211_IFTYPE_AP &&
184             aniState->ofdmWeakSigDetect != weak_sig) {
185                 ath9k_hw_ani_control(ah,
186                                      ATH9K_ANI_OFDM_WEAK_SIGNAL_DETECTION,
187                                      entry_ofdm->ofdm_weak_signal_on);
188         }
189
190         if (aniState->ofdmNoiseImmunityLevel >= ATH9K_ANI_OFDM_DEF_LEVEL) {
191                 ah->config.ofdm_trig_high = ATH9K_ANI_OFDM_TRIG_HIGH;
192                 ah->config.ofdm_trig_low = ATH9K_ANI_OFDM_TRIG_LOW_ABOVE_INI;
193         } else {
194                 ah->config.ofdm_trig_high = ATH9K_ANI_OFDM_TRIG_HIGH_BELOW_INI;
195                 ah->config.ofdm_trig_low = ATH9K_ANI_OFDM_TRIG_LOW;
196         }
197 }
198
199 static void ath9k_hw_ani_ofdm_err_trigger(struct ath_hw *ah)
200 {
201         struct ar5416AniState *aniState;
202
203         if (!ah->curchan)
204                 return;
205
206         aniState = &ah->ani;
207
208         if (aniState->ofdmNoiseImmunityLevel < ATH9K_ANI_OFDM_MAX_LEVEL)
209                 ath9k_hw_set_ofdm_nil(ah, aniState->ofdmNoiseImmunityLevel + 1, false);
210 }
211
212 /*
213  * Set the ANI settings to match an CCK level.
214  */
215 static void ath9k_hw_set_cck_nil(struct ath_hw *ah, u_int8_t immunityLevel,
216                                  bool scan)
217 {
218         struct ar5416AniState *aniState = &ah->ani;
219         struct ath_common *common = ath9k_hw_common(ah);
220         const struct ani_ofdm_level_entry *entry_ofdm;
221         const struct ani_cck_level_entry *entry_cck;
222
223         ath_dbg(common, ANI, "**** ccklevel %d=>%d, rssi=%d[lo=%d hi=%d]\n",
224                 aniState->cckNoiseImmunityLevel, immunityLevel,
225                 BEACON_RSSI(ah), ATH9K_ANI_RSSI_THR_LOW,
226                 ATH9K_ANI_RSSI_THR_HIGH);
227
228         if (ah->opmode == NL80211_IFTYPE_STATION &&
229             BEACON_RSSI(ah) <= ATH9K_ANI_RSSI_THR_LOW &&
230             immunityLevel > ATH9K_ANI_CCK_MAX_LEVEL_LOW_RSSI)
231                 immunityLevel = ATH9K_ANI_CCK_MAX_LEVEL_LOW_RSSI;
232
233         if (!scan)
234                 aniState->cckNoiseImmunityLevel = immunityLevel;
235
236         entry_ofdm = &ofdm_level_table[aniState->ofdmNoiseImmunityLevel];
237         entry_cck = &cck_level_table[aniState->cckNoiseImmunityLevel];
238
239         if (aniState->firstepLevel != entry_cck->fir_step_level &&
240             entry_cck->fir_step_level >= entry_ofdm->fir_step_level)
241                 ath9k_hw_ani_control(ah,
242                                      ATH9K_ANI_FIRSTEP_LEVEL,
243                                      entry_cck->fir_step_level);
244
245         /* Skip MRC CCK for pre AR9003 families */
246         if (!AR_SREV_9300_20_OR_LATER(ah) || AR_SREV_9485(ah) || AR_SREV_9565(ah))
247                 return;
248
249         if (aniState->mrcCCK != entry_cck->mrc_cck_on)
250                 ath9k_hw_ani_control(ah,
251                                      ATH9K_ANI_MRC_CCK,
252                                      entry_cck->mrc_cck_on);
253 }
254
255 static void ath9k_hw_ani_cck_err_trigger(struct ath_hw *ah)
256 {
257         struct ar5416AniState *aniState;
258
259         if (!ah->curchan)
260                 return;
261
262         aniState = &ah->ani;
263
264         if (aniState->cckNoiseImmunityLevel < ATH9K_ANI_CCK_MAX_LEVEL)
265                 ath9k_hw_set_cck_nil(ah, aniState->cckNoiseImmunityLevel + 1,
266                                      false);
267 }
268
269 /*
270  * only lower either OFDM or CCK errors per turn
271  * we lower the other one next time
272  */
273 static void ath9k_hw_ani_lower_immunity(struct ath_hw *ah)
274 {
275         struct ar5416AniState *aniState;
276
277         aniState = &ah->ani;
278
279         /* lower OFDM noise immunity */
280         if (aniState->ofdmNoiseImmunityLevel > 0 &&
281             (aniState->ofdmsTurn || aniState->cckNoiseImmunityLevel == 0)) {
282                 ath9k_hw_set_ofdm_nil(ah, aniState->ofdmNoiseImmunityLevel - 1,
283                                       false);
284                 return;
285         }
286
287         /* lower CCK noise immunity */
288         if (aniState->cckNoiseImmunityLevel > 0)
289                 ath9k_hw_set_cck_nil(ah, aniState->cckNoiseImmunityLevel - 1,
290                                      false);
291 }
292
293 /*
294  * Restore the ANI parameters in the HAL and reset the statistics.
295  * This routine should be called for every hardware reset and for
296  * every channel change.
297  */
298 void ath9k_ani_reset(struct ath_hw *ah, bool is_scanning)
299 {
300         struct ar5416AniState *aniState = &ah->ani;
301         struct ath9k_channel *chan = ah->curchan;
302         struct ath_common *common = ath9k_hw_common(ah);
303         int ofdm_nil, cck_nil;
304
305         if (!ah->curchan)
306                 return;
307
308         BUG_ON(aniState == NULL);
309         ah->stats.ast_ani_reset++;
310
311         /* only allow a subset of functions in AP mode */
312         if (ah->opmode == NL80211_IFTYPE_AP) {
313                 if (IS_CHAN_2GHZ(chan)) {
314                         ah->ani_function = (ATH9K_ANI_SPUR_IMMUNITY_LEVEL |
315                                             ATH9K_ANI_FIRSTEP_LEVEL);
316                         if (AR_SREV_9300_20_OR_LATER(ah))
317                                 ah->ani_function |= ATH9K_ANI_MRC_CCK;
318                 } else
319                         ah->ani_function = 0;
320         }
321
322         /* always allow mode (on/off) to be controlled */
323         ah->ani_function |= ATH9K_ANI_MODE;
324
325         ofdm_nil = max_t(int, ATH9K_ANI_OFDM_DEF_LEVEL,
326                          aniState->ofdmNoiseImmunityLevel);
327         cck_nil = max_t(int, ATH9K_ANI_CCK_DEF_LEVEL,
328                          aniState->cckNoiseImmunityLevel);
329
330         if (is_scanning ||
331             (ah->opmode != NL80211_IFTYPE_STATION &&
332              ah->opmode != NL80211_IFTYPE_ADHOC)) {
333                 /*
334                  * If we're scanning or in AP mode, the defaults (ini)
335                  * should be in place. For an AP we assume the historical
336                  * levels for this channel are probably outdated so start
337                  * from defaults instead.
338                  */
339                 if (aniState->ofdmNoiseImmunityLevel !=
340                     ATH9K_ANI_OFDM_DEF_LEVEL ||
341                     aniState->cckNoiseImmunityLevel !=
342                     ATH9K_ANI_CCK_DEF_LEVEL) {
343                         ath_dbg(common, ANI,
344                                 "Restore defaults: opmode %u chan %d Mhz/0x%x is_scanning=%d ofdm:%d cck:%d\n",
345                                 ah->opmode,
346                                 chan->channel,
347                                 chan->channelFlags,
348                                 is_scanning,
349                                 aniState->ofdmNoiseImmunityLevel,
350                                 aniState->cckNoiseImmunityLevel);
351
352                         ofdm_nil = ATH9K_ANI_OFDM_DEF_LEVEL;
353                         cck_nil = ATH9K_ANI_CCK_DEF_LEVEL;
354                 }
355         } else {
356                 /*
357                  * restore historical levels for this channel
358                  */
359                 ath_dbg(common, ANI,
360                         "Restore history: opmode %u chan %d Mhz/0x%x is_scanning=%d ofdm:%d cck:%d\n",
361                         ah->opmode,
362                         chan->channel,
363                         chan->channelFlags,
364                         is_scanning,
365                         aniState->ofdmNoiseImmunityLevel,
366                         aniState->cckNoiseImmunityLevel);
367         }
368         ath9k_hw_set_ofdm_nil(ah, ofdm_nil, is_scanning);
369         ath9k_hw_set_cck_nil(ah, cck_nil, is_scanning);
370
371         ath9k_ani_restart(ah);
372 }
373
374 static bool ath9k_hw_ani_read_counters(struct ath_hw *ah)
375 {
376         struct ath_common *common = ath9k_hw_common(ah);
377         struct ar5416AniState *aniState = &ah->ani;
378         u32 phyCnt1, phyCnt2;
379         int32_t listenTime;
380
381         ath_hw_cycle_counters_update(common);
382         listenTime = ath_hw_get_listen_time(common);
383
384         if (listenTime <= 0) {
385                 ah->stats.ast_ani_lneg_or_lzero++;
386                 ath9k_ani_restart(ah);
387                 return false;
388         }
389
390         aniState->listenTime += listenTime;
391
392         ath9k_hw_update_mibstats(ah, &ah->ah_mibStats);
393
394         phyCnt1 = REG_READ(ah, AR_PHY_ERR_1);
395         phyCnt2 = REG_READ(ah, AR_PHY_ERR_2);
396
397         ah->stats.ast_ani_ofdmerrs += phyCnt1 - aniState->ofdmPhyErrCount;
398         aniState->ofdmPhyErrCount = phyCnt1;
399
400         ah->stats.ast_ani_cckerrs += phyCnt2 - aniState->cckPhyErrCount;
401         aniState->cckPhyErrCount = phyCnt2;
402
403         return true;
404 }
405
406 void ath9k_hw_ani_monitor(struct ath_hw *ah, struct ath9k_channel *chan)
407 {
408         struct ar5416AniState *aniState;
409         struct ath_common *common = ath9k_hw_common(ah);
410         u32 ofdmPhyErrRate, cckPhyErrRate;
411
412         if (!ah->curchan)
413                 return;
414
415         aniState = &ah->ani;
416         if (!ath9k_hw_ani_read_counters(ah))
417                 return;
418
419         ofdmPhyErrRate = aniState->ofdmPhyErrCount * 1000 /
420                          aniState->listenTime;
421         cckPhyErrRate =  aniState->cckPhyErrCount * 1000 /
422                          aniState->listenTime;
423
424         ath_dbg(common, ANI,
425                 "listenTime=%d OFDM:%d errs=%d/s CCK:%d errs=%d/s ofdm_turn=%d\n",
426                 aniState->listenTime,
427                 aniState->ofdmNoiseImmunityLevel,
428                 ofdmPhyErrRate, aniState->cckNoiseImmunityLevel,
429                 cckPhyErrRate, aniState->ofdmsTurn);
430
431         if (aniState->listenTime > ah->aniperiod) {
432                 if (cckPhyErrRate < ah->config.cck_trig_low &&
433                     ofdmPhyErrRate < ah->config.ofdm_trig_low) {
434                         ath9k_hw_ani_lower_immunity(ah);
435                         aniState->ofdmsTurn = !aniState->ofdmsTurn;
436                 } else if (ofdmPhyErrRate > ah->config.ofdm_trig_high) {
437                         ath9k_hw_ani_ofdm_err_trigger(ah);
438                         aniState->ofdmsTurn = false;
439                 } else if (cckPhyErrRate > ah->config.cck_trig_high) {
440                         ath9k_hw_ani_cck_err_trigger(ah);
441                         aniState->ofdmsTurn = true;
442                 }
443                 ath9k_ani_restart(ah);
444         }
445 }
446 EXPORT_SYMBOL(ath9k_hw_ani_monitor);
447
448 void ath9k_enable_mib_counters(struct ath_hw *ah)
449 {
450         struct ath_common *common = ath9k_hw_common(ah);
451
452         ath_dbg(common, ANI, "Enable MIB counters\n");
453
454         ath9k_hw_update_mibstats(ah, &ah->ah_mibStats);
455
456         ENABLE_REGWRITE_BUFFER(ah);
457
458         REG_WRITE(ah, AR_FILT_OFDM, 0);
459         REG_WRITE(ah, AR_FILT_CCK, 0);
460         REG_WRITE(ah, AR_MIBC,
461                   ~(AR_MIBC_COW | AR_MIBC_FMC | AR_MIBC_CMC | AR_MIBC_MCS)
462                   & 0x0f);
463         REG_WRITE(ah, AR_PHY_ERR_MASK_1, AR_PHY_ERR_OFDM_TIMING);
464         REG_WRITE(ah, AR_PHY_ERR_MASK_2, AR_PHY_ERR_CCK_TIMING);
465
466         REGWRITE_BUFFER_FLUSH(ah);
467 }
468
469 /* Freeze the MIB counters, get the stats and then clear them */
470 void ath9k_hw_disable_mib_counters(struct ath_hw *ah)
471 {
472         struct ath_common *common = ath9k_hw_common(ah);
473
474         ath_dbg(common, ANI, "Disable MIB counters\n");
475
476         REG_WRITE(ah, AR_MIBC, AR_MIBC_FMC);
477         ath9k_hw_update_mibstats(ah, &ah->ah_mibStats);
478         REG_WRITE(ah, AR_MIBC, AR_MIBC_CMC);
479         REG_WRITE(ah, AR_FILT_OFDM, 0);
480         REG_WRITE(ah, AR_FILT_CCK, 0);
481 }
482 EXPORT_SYMBOL(ath9k_hw_disable_mib_counters);
483
484 void ath9k_hw_ani_init(struct ath_hw *ah)
485 {
486         struct ath_common *common = ath9k_hw_common(ah);
487         struct ar5416AniState *ani = &ah->ani;
488
489         ath_dbg(common, ANI, "Initialize ANI\n");
490
491         ah->config.ofdm_trig_high = ATH9K_ANI_OFDM_TRIG_HIGH;
492         ah->config.ofdm_trig_low = ATH9K_ANI_OFDM_TRIG_LOW;
493         ah->config.cck_trig_high = ATH9K_ANI_CCK_TRIG_HIGH;
494         ah->config.cck_trig_low = ATH9K_ANI_CCK_TRIG_LOW;
495
496         ani->spurImmunityLevel = ATH9K_ANI_SPUR_IMMUNE_LVL;
497         ani->firstepLevel = ATH9K_ANI_FIRSTEP_LVL;
498         ani->mrcCCK = AR_SREV_9300_20_OR_LATER(ah) ? true : false;
499         ani->ofdmsTurn = true;
500         ani->ofdmWeakSigDetect = true;
501         ani->cckNoiseImmunityLevel = ATH9K_ANI_CCK_DEF_LEVEL;
502         ani->ofdmNoiseImmunityLevel = ATH9K_ANI_OFDM_DEF_LEVEL;
503
504         /*
505          * since we expect some ongoing maintenance on the tables, let's sanity
506          * check here default level should not modify INI setting.
507          */
508         ah->aniperiod = ATH9K_ANI_PERIOD;
509         ah->config.ani_poll_interval = ATH9K_ANI_POLLINTERVAL;
510
511         ath9k_ani_restart(ah);
512         ath9k_enable_mib_counters(ah);
513 }