diff options
| author | Stefano Brivio <stefano.brivio@polimi.it> | 2007-12-23 04:40:32 +0100 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2008-01-29 00:00:51 +0100 |
| commit | ca5fbca924b845863ab9da00ac90b3384445f497 (patch) | |
| tree | 86fb83992615bb2175c16777668de9474c83f324 /net/mac80211 | |
| parent | rc80211-pid: export human-readable target_pf value to debugfs (diff) | |
| download | linux-ca5fbca924b845863ab9da00ac90b3384445f497.tar.xz linux-ca5fbca924b845863ab9da00ac90b3384445f497.zip | |
rc80211-pid: add kerneldoc for tunable parameters
Add a kerneldoc description for parameters which are tunable through debugfs.
Signed-off-by: Stefano Brivio <stefano.brivio@polimi.it>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/mac80211')
| -rw-r--r-- | net/mac80211/rc80211_pid.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/net/mac80211/rc80211_pid.h b/net/mac80211/rc80211_pid.h index 81aa4ea19958..6afd3cebdeca 100644 --- a/net/mac80211/rc80211_pid.h +++ b/net/mac80211/rc80211_pid.h @@ -1,5 +1,6 @@ /* * Copyright 2007, Mattias Nissler <mattias.nissler@gmx.de> + * Copyright 2007, Stefano Brivio <stefano.brivio@polimi.it> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as @@ -119,6 +120,29 @@ struct rc_pid_events_file_info { unsigned int next_entry; }; +/** + * struct rc_pid_debugfs_entries - tunable parameters + * + * Algorithm parameters, tunable via debugfs. + * @dir: the debugfs directory for a specific phy + * @target: target percentage for failed frames + * @sampling_period: error sampling interval in milliseconds + * @coeff_p: absolute value of the proportional coefficient + * @coeff_i: absolute value of the integral coefficient + * @coeff_d: absolute value of the derivative coefficient + * @smoothing_shift: absolute value of the integral smoothing factor (i.e. + * amount of smoothing introduced by the exponential moving average) + * @sharpen_factor: absolute value of the derivative sharpening factor (i.e. + * amount of emphasis given to the derivative term after low activity + * events) + * @sharpen_duration: duration of the sharpening effect after the detected low + * activity event, relative to sampling_period + * @norm_offset: amount of normalization periodically performed on the learnt + * rate behaviour values (lower means we should trust more what we learnt + * about behaviour of rates, higher means we should trust more the natural + * ordering of rates) + * @fast_start: if Y, push high rates right after initialization + */ struct rc_pid_debugfs_entries { struct dentry *dir; struct dentry *target; |