fan: Clarify hardware_pwm and allow cycle_time to be set on software pwm

Specify hardware pwm cycle times using the same method as software pwm
(in seconds, not clock ticks).  Allow the fan code to be configured
with an explicit cycle time even when using software pwm.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>

1 files changed, 7 insertions, 8 deletions

diff --git a/config/example-extras.cfg b/config/example-extras.cfg
index 37a3ca0b..787a4a29 100644
--- a/config/example-extras.cfg
+++ b/config/example-extras.cfg
@@ -209,14 +209,13 @@
 #shutdown_value:
 #   The value to set the pin to on an MCU shutdown event. The default
 #   is 0.
-#hard_pwm:
-#   Set this value to force hardware PWM instead of software PWM. Set
-#   to 1 to force a hardware PWM at the fastest rate; set to a higher
-#   number to force hardware PWM with the given cycle time in clock
-#   ticks. The default is to use software PWM.
 #cycle_time: 0.100
-#   The amount of time (in seconds) per PWM cycle when using software
-#   based PWM. The default is 0.100 seconds.
+#   The amount of time (in seconds) per PWM cycle. It is recommended
+#   this be 10 milliseconds or greater when using software based
+#   PWM. The default is 0.100 seconds.
+#hardware_pwm: False
+#   Enable this to use hardware PWM instead of software PWM. The
+#   default is False.
 #scale:
 #   This parameter can be used to alter how the 'value' and
 #   'shutdown_value' parameters are interpreted. If provided, then the
@@ -234,8 +233,8 @@
 #[static_pwm_output my_output_pwm]
 #pin:
 #value:
-#hard_pwm:
 #cycle_time:
+#hardware_pwm:
 #scale:
 #    See the 'pwm_output' section for details on these parameters.