1*4882a593Smuzhiyun /* 2*4882a593Smuzhiyun * Copyright (C) 2010 Bruno Randolf <br1@einfach.org> 3*4882a593Smuzhiyun * 4*4882a593Smuzhiyun * Permission to use, copy, modify, and/or distribute this software for any 5*4882a593Smuzhiyun * purpose with or without fee is hereby granted, provided that the above 6*4882a593Smuzhiyun * copyright notice and this permission notice appear in all copies. 7*4882a593Smuzhiyun * 8*4882a593Smuzhiyun * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9*4882a593Smuzhiyun * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10*4882a593Smuzhiyun * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11*4882a593Smuzhiyun * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12*4882a593Smuzhiyun * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13*4882a593Smuzhiyun * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14*4882a593Smuzhiyun * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15*4882a593Smuzhiyun */ 16*4882a593Smuzhiyun #ifndef ANI_H 17*4882a593Smuzhiyun #define ANI_H 18*4882a593Smuzhiyun 19*4882a593Smuzhiyun #include "../ath.h" 20*4882a593Smuzhiyun 21*4882a593Smuzhiyun enum ath5k_phy_error_code; 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun /* these thresholds are relative to the ATH5K_ANI_LISTEN_PERIOD */ 24*4882a593Smuzhiyun #define ATH5K_ANI_LISTEN_PERIOD 100 25*4882a593Smuzhiyun #define ATH5K_ANI_OFDM_TRIG_HIGH 500 26*4882a593Smuzhiyun #define ATH5K_ANI_OFDM_TRIG_LOW 200 27*4882a593Smuzhiyun #define ATH5K_ANI_CCK_TRIG_HIGH 200 28*4882a593Smuzhiyun #define ATH5K_ANI_CCK_TRIG_LOW 100 29*4882a593Smuzhiyun 30*4882a593Smuzhiyun /* average beacon RSSI thresholds */ 31*4882a593Smuzhiyun #define ATH5K_ANI_RSSI_THR_HIGH 40 32*4882a593Smuzhiyun #define ATH5K_ANI_RSSI_THR_LOW 7 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun /* maximum available levels */ 35*4882a593Smuzhiyun #define ATH5K_ANI_MAX_FIRSTEP_LVL 2 36*4882a593Smuzhiyun #define ATH5K_ANI_MAX_NOISE_IMM_LVL 1 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun /** 40*4882a593Smuzhiyun * enum ath5k_ani_mode - mode for ANI / noise sensitivity 41*4882a593Smuzhiyun * 42*4882a593Smuzhiyun * @ATH5K_ANI_MODE_OFF: Turn ANI off. This can be useful to just stop the ANI 43*4882a593Smuzhiyun * algorithm after it has been on auto mode. 44*4882a593Smuzhiyun * @ATH5K_ANI_MODE_MANUAL_LOW: Manually set all immunity parameters to low, 45*4882a593Smuzhiyun * maximizing sensitivity. ANI will not run. 46*4882a593Smuzhiyun * @ATH5K_ANI_MODE_MANUAL_HIGH: Manually set all immunity parameters to high, 47*4882a593Smuzhiyun * minimizing sensitivity. ANI will not run. 48*4882a593Smuzhiyun * @ATH5K_ANI_MODE_AUTO: Automatically control immunity parameters based on the 49*4882a593Smuzhiyun * amount of OFDM and CCK frame errors (default). 50*4882a593Smuzhiyun */ 51*4882a593Smuzhiyun enum ath5k_ani_mode { 52*4882a593Smuzhiyun ATH5K_ANI_MODE_OFF = 0, 53*4882a593Smuzhiyun ATH5K_ANI_MODE_MANUAL_LOW = 1, 54*4882a593Smuzhiyun ATH5K_ANI_MODE_MANUAL_HIGH = 2, 55*4882a593Smuzhiyun ATH5K_ANI_MODE_AUTO = 3 56*4882a593Smuzhiyun }; 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun /** 60*4882a593Smuzhiyun * struct ath5k_ani_state - ANI state and associated counters 61*4882a593Smuzhiyun * @ani_mode: One of enum ath5k_ani_mode 62*4882a593Smuzhiyun * @noise_imm_level: Noise immunity level 63*4882a593Smuzhiyun * @spur_level: Spur immunity level 64*4882a593Smuzhiyun * @firstep_level: FIRstep level 65*4882a593Smuzhiyun * @ofdm_weak_sig: OFDM weak signal detection state (on/off) 66*4882a593Smuzhiyun * @cck_weak_sig: CCK weak signal detection state (on/off) 67*4882a593Smuzhiyun * @max_spur_level: Max spur immunity level (chip specific) 68*4882a593Smuzhiyun * @listen_time: Listen time 69*4882a593Smuzhiyun * @ofdm_errors: OFDM timing error count 70*4882a593Smuzhiyun * @cck_errors: CCK timing error count 71*4882a593Smuzhiyun * @last_cc: The &struct ath_cycle_counters (for stats) 72*4882a593Smuzhiyun * @last_listen: Listen time from previous run (for stats) 73*4882a593Smuzhiyun * @last_ofdm_errors: OFDM timing error count from previous run (for tats) 74*4882a593Smuzhiyun * @last_cck_errors: CCK timing error count from previous run (for stats) 75*4882a593Smuzhiyun * @sum_ofdm_errors: Sum of OFDM timing errors (for stats) 76*4882a593Smuzhiyun * @sum_cck_errors: Sum of all CCK timing errors (for stats) 77*4882a593Smuzhiyun */ 78*4882a593Smuzhiyun struct ath5k_ani_state { 79*4882a593Smuzhiyun enum ath5k_ani_mode ani_mode; 80*4882a593Smuzhiyun 81*4882a593Smuzhiyun /* state */ 82*4882a593Smuzhiyun int noise_imm_level; 83*4882a593Smuzhiyun int spur_level; 84*4882a593Smuzhiyun int firstep_level; 85*4882a593Smuzhiyun bool ofdm_weak_sig; 86*4882a593Smuzhiyun bool cck_weak_sig; 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun int max_spur_level; 89*4882a593Smuzhiyun 90*4882a593Smuzhiyun /* used by the algorithm */ 91*4882a593Smuzhiyun unsigned int listen_time; 92*4882a593Smuzhiyun unsigned int ofdm_errors; 93*4882a593Smuzhiyun unsigned int cck_errors; 94*4882a593Smuzhiyun 95*4882a593Smuzhiyun /* debug/statistics only: numbers from last ANI calibration */ 96*4882a593Smuzhiyun struct ath_cycle_counters last_cc; 97*4882a593Smuzhiyun unsigned int last_listen; 98*4882a593Smuzhiyun unsigned int last_ofdm_errors; 99*4882a593Smuzhiyun unsigned int last_cck_errors; 100*4882a593Smuzhiyun unsigned int sum_ofdm_errors; 101*4882a593Smuzhiyun unsigned int sum_cck_errors; 102*4882a593Smuzhiyun }; 103*4882a593Smuzhiyun 104*4882a593Smuzhiyun void ath5k_ani_init(struct ath5k_hw *ah, enum ath5k_ani_mode mode); 105*4882a593Smuzhiyun void ath5k_ani_mib_intr(struct ath5k_hw *ah); 106*4882a593Smuzhiyun void ath5k_ani_calibration(struct ath5k_hw *ah); 107*4882a593Smuzhiyun void ath5k_ani_phy_error_report(struct ath5k_hw *ah, 108*4882a593Smuzhiyun enum ath5k_phy_error_code phyerr); 109*4882a593Smuzhiyun 110*4882a593Smuzhiyun /* for manual control */ 111*4882a593Smuzhiyun void ath5k_ani_set_noise_immunity_level(struct ath5k_hw *ah, int level); 112*4882a593Smuzhiyun void ath5k_ani_set_spur_immunity_level(struct ath5k_hw *ah, int level); 113*4882a593Smuzhiyun void ath5k_ani_set_firstep_level(struct ath5k_hw *ah, int level); 114*4882a593Smuzhiyun void ath5k_ani_set_ofdm_weak_signal_detection(struct ath5k_hw *ah, bool on); 115*4882a593Smuzhiyun void ath5k_ani_set_cck_weak_signal_detection(struct ath5k_hw *ah, bool on); 116*4882a593Smuzhiyun 117*4882a593Smuzhiyun void ath5k_ani_print_counters(struct ath5k_hw *ah); 118*4882a593Smuzhiyun 119*4882a593Smuzhiyun #endif /* ANI_H */ 120