diff options
| author | Randall Spangler <rspangler@chromium.org> | 2012-10-25 13:30:51 -0700 |
|---|---|---|
| committer | Gerrit <chrome-bot@google.com> | 2012-10-25 17:03:44 -0700 |
| commit | 2df9ba881493f80db154de756e61b426380dded6 (patch) | |
| tree | c89a23742f589d2d9e3224283360f9e0ed9b84c9 /include/pwm.h | |
| parent | 00b344ddbb570a5dae9b27f8441202dcecba9a4a (diff) | |
| download | chrome-ec-2df9ba881493f80db154de756e61b426380dded6.tar.gz | |
Clean up pwm module
No functional changes. But hey, I'm having lots of fun reformatting comments.
BUG=chrome-os-partner:15579
BRANCH=none
TEST=fanset -1; fanset 0; fanset 4000
Change-Id: Iddcea5b8e59fa6668cdd347b6d31155c28991521
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/36585
Reviewed-by: Bill Richardson <wfrichar@chromium.org>
Diffstat (limited to 'include/pwm.h')
| -rw-r--r-- | include/pwm.h | 51 |
1 files changed, 36 insertions, 15 deletions
diff --git a/include/pwm.h b/include/pwm.h index 1def4f6172..62faadea5b 100644 --- a/include/pwm.h +++ b/include/pwm.h @@ -10,9 +10,12 @@ #include "common.h" -/* Enable/disable the fan. This should be called by whatever function - * enables the power supply to the fan. */ -int pwm_enable_fan(int enable); +/** + * Enable/disable the fan. + * + * Should be called by whatever function enables the power supply to the fan. + */ +void pwm_enable_fan(int enable); /** * Enable/disable fan RPM control logic. @@ -22,28 +25,46 @@ int pwm_enable_fan(int enable); */ void pwm_set_rpm_mode(int enable); -/* Get the current fan RPM. */ +/** + * Get the current fan RPM. + */ int pwm_get_fan_rpm(void); -/* Get the target fan RPM. */ +/** + * Get the target fan RPM. + */ int pwm_get_fan_target_rpm(void); -/* Set the target fan RPM. Pass -1 to set fan to maximum. */ -int pwm_set_fan_target_rpm(int rpm); +/** + * Set the target fan RPM. + * + * @param rpm Target RPM; pass -1 to set fan to maximum. + */ +void pwm_set_fan_target_rpm(int rpm); -/* Set the fan PWM duty cycle (0-100), disabling the automatic control. */ -int pwm_set_fan_duty(int percent); +/** + * Set the fan PWM duty cycle (0-100), disabling the automatic control. + */ +void pwm_set_fan_duty(int percent); -/* Enable/disable the keyboard backlight. */ -int pwm_enable_keyboard_backlight(int enable); +/** + * Enable/disable the keyboard backlight. + */ +void pwm_enable_keyboard_backlight(int enable); -/* Get the keyboard backlight enable/disable status (1=enabled, 0=disabled). */ +/** + * Get the keyboard backlight enable/disable status (1=enabled, 0=disabled). + */ int pwm_get_keyboard_backlight_enabled(void); -/* Get the keyboard backlight percentage (0=off, 100=max). */ +/** + * Get the keyboard backlight percentage (0=off, 100=max). + */ int pwm_get_keyboard_backlight(void); -/* Set the keyboard backlight percentage (0=off, 100=max). */ -int pwm_set_keyboard_backlight(int percent); +/** + * Set the keyboard backlight percentage (0=off, 100=max). + */ +void pwm_set_keyboard_backlight(int percent); #endif /* __CROS_EC_PWM_H */ |