ath5k: Cleanups v2 + add kerneldoc on all hw functions (c47faa36) · Commits · e / devices / android_kernel_fairphone_FP3

drivers/net/wireless/ath/ath5k/ani.c

+56 −30

Original line number	Diff line number	Diff line
		@@ -27,15 +27,21 @@
		* or reducing sensitivity as necessary.
		*
		* The parameters are:
		*
		* - "noise immunity"
		*
		* - "spur immunity"
		*
		* - "firstep level"
		*
		* - "OFDM weak signal detection"
		*
		* - "CCK weak signal detection"
		*
		* Basically we look at the amount of ODFM and CCK timing errors we get and then
		* raise or lower immunity accordingly by setting one or more of these
		* parameters.
		*
		* Newer chipsets have PHY error counters in hardware which will generate a MIB
		* interrupt when they overflow. Older hardware has too enable PHY error frames
		* by setting a RX flag and then count every single PHY error. When a specified
		@@ -45,11 +51,13 @@
		*/


		/* ANI parameter control */
		/***********************\
		* ANI parameter control *
		\***********************/

		/**
		* ath5k_ani_set_noise_immunity_level() - Set noise immunity level
		*
		* @ah: The &struct ath5k_hw
		* @level: level between 0 and @ATH5K_ANI_MAX_NOISE_IMM_LVL
		*/
		void
		@@ -91,10 +99,9 @@ ath5k_ani_set_noise_immunity_level(struct ath5k_hw *ah, int level)
		ATH5K_DBG_UNLIMIT(ah, ATH5K_DEBUG_ANI, "new level %d", level);
		}


		/**
		* ath5k_ani_set_spur_immunity_level() - Set spur immunity level
		*
		* @ah: The &struct ath5k_hw
		* @level: level between 0 and @max_spur_level (the maximum level is dependent
		* on the chip revision).
		*/
		@@ -117,10 +124,9 @@ ath5k_ani_set_spur_immunity_level(struct ath5k_hw *ah, int level)
		ATH5K_DBG_UNLIMIT(ah, ATH5K_DEBUG_ANI, "new level %d", level);
		}


		/**
		* ath5k_ani_set_firstep_level() - Set "firstep" level
		*
		* @ah: The &struct ath5k_hw
		* @level: level between 0 and @ATH5K_ANI_MAX_FIRSTEP_LVL
		*/
		void
		@@ -140,11 +146,9 @@ ath5k_ani_set_firstep_level(struct ath5k_hw *ah, int level)
		ATH5K_DBG_UNLIMIT(ah, ATH5K_DEBUG_ANI, "new level %d", level);
		}


		/**
		* ath5k_ani_set_ofdm_weak_signal_detection() - Control OFDM weak signal
		* detection
		*
		* ath5k_ani_set_ofdm_weak_signal_detection() - Set OFDM weak signal detection
		* @ah: The &struct ath5k_hw
		* @on: turn on or off
		*/
		void
		@@ -182,10 +186,9 @@ ath5k_ani_set_ofdm_weak_signal_detection(struct ath5k_hw *ah, bool on)
		on ? "on" : "off");
		}


		/**
		* ath5k_ani_set_cck_weak_signal_detection() - control CCK weak signal detection
		*
		* ath5k_ani_set_cck_weak_signal_detection() - Set CCK weak signal detection
		* @ah: The &struct ath5k_hw
		* @on: turn on or off
		*/
		void
		@@ -200,11 +203,14 @@ ath5k_ani_set_cck_weak_signal_detection(struct ath5k_hw *ah, bool on)
		}


		/* ANI algorithm */
		/***************\
		* ANI algorithm *
		\***************/

		/**
		* ath5k_ani_raise_immunity() - Increase noise immunity
		*
		* @ah: The &struct ath5k_hw
		* @as: The &struct ath5k_ani_state
		* @ofdm_trigger: If this is true we are called because of too many OFDM errors,
		* the algorithm will tune more parameters then.
		*
		@@ -290,9 +296,10 @@ ath5k_ani_raise_immunity(struct ath5k_hw ah, struct ath5k_ani_state as,
		*/
		}


		/**
		* ath5k_ani_lower_immunity() - Decrease noise immunity
		* @ah: The &struct ath5k_hw
		* @as: The &struct ath5k_ani_state
		*
		* Try to lower noise immunity (=increase sensitivity) in several steps
		* depending on the average RSSI of the beacons we received.
		@@ -352,9 +359,10 @@ ath5k_ani_lower_immunity(struct ath5k_hw ah, struct ath5k_ani_state as)
		}
		}


		/**
		* ath5k_hw_ani_get_listen_time() - Update counters and return listening time
		* @ah: The &struct ath5k_hw
		* @as: The &struct ath5k_ani_state
		*
		* Return an approximation of the time spent "listening" in milliseconds (ms)
		* since the last call of this function.
		@@ -379,9 +387,10 @@ ath5k_hw_ani_get_listen_time(struct ath5k_hw ah, struct ath5k_ani_state as)
		return listen;
		}


		/**
		* ath5k_ani_save_and_clear_phy_errors() - Clear and save PHY error counters
		* @ah: The &struct ath5k_hw
		* @as: The &struct ath5k_ani_state
		*
		* Clear the PHY error counters as soon as possible, since this might be called
		* from a MIB interrupt and we want to make sure we don't get interrupted again.
		@@ -429,9 +438,10 @@ ath5k_ani_save_and_clear_phy_errors(struct ath5k_hw *ah,
		return 1;
		}


		/**
		* ath5k_ani_period_restart() - Restart ANI period
		* @ah: The &struct ath5k_hw
		* @as: The &struct ath5k_ani_state
		*
		* Just reset counters, so they are clear for the next "ani period".
		*/
		@@ -448,9 +458,9 @@ ath5k_ani_period_restart(struct ath5k_hw ah, struct ath5k_ani_state as)
		as->listen_time = 0;
		}


		/**
		* ath5k_ani_calibration() - The main ANI calibration function
		* @ah: The &struct ath5k_hw
		*
		* We count OFDM and CCK errors relative to the time where we did not send or
		* receive ("listen" time) and raise or lower immunity accordingly.
		@@ -509,10 +519,13 @@ ath5k_ani_calibration(struct ath5k_hw *ah)
		}


		/* INTERRUPT HANDLER */
		/*******************\
		* Interrupt handler *
		\*******************/

		/**
		* ath5k_ani_mib_intr() - Interrupt handler for ANI MIB counters
		* @ah: The &struct ath5k_hw
		*
		* Just read & reset the registers quickly, so they don't generate more
		* interrupts, save the counters and schedule the tasklet to decide whether
		@@ -549,9 +562,11 @@ ath5k_ani_mib_intr(struct ath5k_hw *ah)
		tasklet_schedule(&ah->ani_tasklet);
		}


		/**
		* ath5k_ani_phy_error_report() - Used by older HW to report PHY errors
		* ath5k_ani_phy_error_report - Used by older HW to report PHY errors
		*
		* @ah: The &struct ath5k_hw
		* @phyerr: One of enum ath5k_phy_error_code
		*
		* This is used by hardware without PHY error counters to report PHY errors
		* on a frame-by-frame basis, instead of the interrupt.
		@@ -574,10 +589,13 @@ ath5k_ani_phy_error_report(struct ath5k_hw *ah,
		}


		/* INIT */
		/****************\
		* Initialization *
		\****************/

		/**
		* ath5k_enable_phy_err_counters() - Enable PHY error counters
		* @ah: The &struct ath5k_hw
		*
		* Enable PHY error counters for OFDM and CCK timing errors.
		*/
		@@ -596,9 +614,9 @@ ath5k_enable_phy_err_counters(struct ath5k_hw *ah)
		ath5k_hw_reg_write(ah, 0, AR5K_CCK_FIL_CNT);
		}


		/**
		* ath5k_disable_phy_err_counters() - Disable PHY error counters
		* @ah: The &struct ath5k_hw
		*
		* Disable PHY error counters for OFDM and CCK timing errors.
		*/
		@@ -615,10 +633,10 @@ ath5k_disable_phy_err_counters(struct ath5k_hw *ah)
		ath5k_hw_reg_write(ah, 0, AR5K_CCK_FIL_CNT);
		}


		/**
		* ath5k_ani_init() - Initialize ANI
		* @mode: Which mode to use (auto, manual high, manual low, off)
		* @ah: The &struct ath5k_hw
		* @mode: One of enum ath5k_ani_mode
		*
		* Initialize ANI according to mode.
		*/
		@@ -695,10 +713,18 @@ ath5k_ani_init(struct ath5k_hw *ah, enum ath5k_ani_mode mode)
		}


		/* DEBUG */
		/**************\
		* Debug output *
		\**************/

		#ifdef CONFIG_ATH5K_DEBUG

		/**
		* ath5k_ani_print_counters() - Print ANI counters
		* @ah: The &struct ath5k_hw
		*
		* Used for debugging ANI
		*/
		void
		ath5k_ani_print_counters(struct ath5k_hw *ah)
		{

drivers/net/wireless/ath/ath5k/ani.h

+23 −9

Original line number	Diff line number	Diff line
		@@ -41,11 +41,11 @@ enum ath5k_phy_error_code;
		*
		* @ATH5K_ANI_MODE_OFF: Turn ANI off. This can be useful to just stop the ANI
		* algorithm after it has been on auto mode.
		* ATH5K_ANI_MODE_MANUAL_LOW: Manually set all immunity parameters to low,
		* @ATH5K_ANI_MODE_MANUAL_LOW: Manually set all immunity parameters to low,
		* maximizing sensitivity. ANI will not run.
		* ATH5K_ANI_MODE_MANUAL_HIGH: Manually set all immunity parameters to high,
		* @ATH5K_ANI_MODE_MANUAL_HIGH: Manually set all immunity parameters to high,
		* minimizing sensitivity. ANI will not run.
		* ATH5K_ANI_MODE_AUTO: Automatically control immunity parameters based on the
		* @ATH5K_ANI_MODE_AUTO: Automatically control immunity parameters based on the
		* amount of OFDM and CCK frame errors (default).
		*/
		enum ath5k_ani_mode {
		@@ -58,8 +58,22 @@ enum ath5k_ani_mode {

		/**
		* struct ath5k_ani_state - ANI state and associated counters
		*
		* @max_spur_level: the maximum spur level is chip dependent
		* @ani_mode: One of enum ath5k_ani_mode
		* @noise_imm_level: Noise immunity level
		* @spur_level: Spur immunity level
		* @firstep_level: FIRstep level
		* @ofdm_weak_sig: OFDM weak signal detection state (on/off)
		* @cck_weak_sig: CCK weak signal detection state (on/off)
		* @max_spur_level: Max spur immunity level (chip specific)
		* @listen_time: Listen time
		* @ofdm_errors: OFDM timing error count
		* @cck_errors: CCK timing error count
		* @last_cc: The &struct ath_cycle_counters (for stats)
		* @last_listen: Listen time from previous run (for stats)
		* @last_ofdm_errors: OFDM timing error count from previous run (for tats)
		* @last_cck_errors: CCK timing error count from previous run (for stats)
		* @sum_ofdm_errors: Sum of OFDM timing errors (for stats)
		* @sum_cck_errors: Sum of all CCK timing errors (for stats)
		*/
		struct ath5k_ani_state {
		enum ath5k_ani_mode ani_mode;

drivers/net/wireless/ath/ath5k/ath5k.h

+366 −165

File changed.

Preview size limit exceeded, changes collapsed.

drivers/net/wireless/ath/ath5k/attach.c

+3 −6

Original line number	Diff line number	Diff line
		@@ -27,8 +27,7 @@
		#include "debug.h"

		/**
		* ath5k_hw_post - Power On Self Test helper function
		*
		* ath5k_hw_post() - Power On Self Test helper function
		* @ah: The &struct ath5k_hw
		*/
		static int ath5k_hw_post(struct ath5k_hw *ah)
		@@ -92,8 +91,7 @@ static int ath5k_hw_post(struct ath5k_hw *ah)
		}

		/**
		* ath5k_hw_init - Check if hw is supported and init the needed structs
		*
		* ath5k_hw_init() - Check if hw is supported and init the needed structs
		* @ah: The &struct ath5k_hw associated with the device
		*
		* Check if the device is supported, perform a POST and initialize the needed
		@@ -349,8 +347,7 @@ int ath5k_hw_init(struct ath5k_hw *ah)
		}

		/**
		* ath5k_hw_deinit - Free the ath5k_hw struct
		*
		* ath5k_hw_deinit() - Free the &struct ath5k_hw
		* @ah: The &struct ath5k_hw
		*/
		void ath5k_hw_deinit(struct ath5k_hw *ah)

drivers/net/wireless/ath/ath5k/base.c

+1 −2

Original line number	Diff line number	Diff line
		@@ -183,7 +183,6 @@ static const struct ieee80211_rate ath5k_rates[] = {
		{ .bitrate = 540,
		.hw_value = ATH5K_RATE_CODE_54M,
		.flags = 0 },
		/* XR missing */
		};

		static inline u64 ath5k_extend_tsf(struct ath5k_hw *ah, u32 rstamp)
		@@ -2005,7 +2004,7 @@ ath5k_beacon_update_timers(struct ath5k_hw *ah, u64 bc_tsf)
		ah->nexttbtt = nexttbtt;

		intval \|= AR5K_BEACON_ENA;
		ath5k_hw_init_beacon(ah, nexttbtt, intval);
		ath5k_hw_init_beacon_timers(ah, nexttbtt, intval);

		/*
		* debugging output last in order to preserve the time critical aspect