diff options
| author | Bill Richardson <wfrichar@chromium.org> | 2013-10-30 11:32:48 -0700 |
|---|---|---|
| committer | chrome-internal-fetch <chrome-internal-fetch@google.com> | 2013-10-30 23:10:02 +0000 |
| commit | 9dff30d466c5dfa0e90990d3106ffefe23e8d979 (patch) | |
| tree | 9724feaad88265cba0b2335f28539a0c6f000265 | |
| parent | c7b930606b479d4747da224f6cf62fd8061e6af0 (diff) | |
| download | chrome-ec-9dff30d466c5dfa0e90990d3106ffefe23e8d979.tar.gz | |
Add more descriptive comments to include/fan.h
Just adding some comments.
BUG=chrome-os-partner:23530
BRANCH=none
TEST=none
Change-Id: Ib3955e9d97ad8aa642e6fe298c17e34d2c66fb1c
Signed-off-by: Bill Richardson <wfrichar@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/175139
| -rw-r--r-- | include/fan.h | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/include/fan.h b/include/fan.h index acae150fc0..781bfc9951 100644 --- a/include/fan.h +++ b/include/fan.h @@ -31,17 +31,27 @@ int fan_percent_to_rpm(int pct); * These functions require chip-specific implementations. */ +/* Enable/Disable the fan controller */ void fan_set_enabled(int ch, int enabled); int fan_get_enabled(int ch); + +/* Fixed pwm duty cycle (0-100%) */ void fan_set_duty(int ch, int percent); int fan_get_duty(int ch); + +/* Enable/Disable automatic RPM control using tach feedback */ void fan_set_rpm_mode(int ch, int rpm_mode); int fan_get_rpm_mode(int ch); + +/* Set the target for the automatic RPM control */ void fan_set_rpm_target(int ch, int rpm); int fan_get_rpm_actual(int ch); int fan_get_rpm_target(int ch); + +/* Is the fan stalled when it shouldn't be? */ int fan_is_stalled(int ch); +/* How is the automatic RPM control doing? */ enum fan_status { FAN_STATUS_STOPPED = 0, FAN_STATUS_CHANGING = 1, @@ -50,8 +60,10 @@ enum fan_status { }; enum fan_status fan_get_status(int ch); -/* Maintain target RPM using tach input */ +/* Flag to enable automatic RPM control using tach input */ #define FAN_USE_RPM_MODE (1 << 0) + +/* Initialize the HW according to the desired flags */ void fan_channel_setup(int ch, unsigned int flags); #endif /* __CROS_EC_FAN_H */ |