summaryrefslogtreecommitdiff
path: root/include/pwm.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/pwm.h')
-rw-r--r--include/pwm.h51
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 */