Merge tag 'tpm-030822' of https://source.denx.de/u-boot/custodians/u-boot-tpm
[platform/kernel/u-boot.git] / include / pwm.h
index f995970..bfdc1e3 100644 (file)
@@ -17,6 +17,10 @@ struct pwm_ops {
        /**
         * set_config() - Set the PWM configuration
         *
+        * Change both the PWM device's period and it's duty period if
+        * possible. Otherwise, set an appropriate duty period that best
+        * matches the given period_ns / duty_ns ratio for the device.
+        *
         * @dev:        PWM device to update
         * @channel:    PWM channel to update
         * @period_ns:  PWM period in nanoseconds
@@ -51,11 +55,15 @@ struct pwm_ops {
 /**
  * pwm_set_config() - Set the PWM configuration
  *
+ * Change both the PWM device's period and it's duty period if
+ * possible. Otherwise, set an appropriate duty period that best
+ * matches the given period_ns / duty_ns ratio for the device.
+ *
  * @dev:       PWM device to update
  * @channel:   PWM channel to update
  * @period_ns: PWM period in nanoseconds
  * @duty_ns:   PWM duty period in nanoseconds
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int pwm_set_config(struct udevice *dev, uint channel, uint period_ns,
                   uint duty_ns);
@@ -66,7 +74,7 @@ int pwm_set_config(struct udevice *dev, uint channel, uint period_ns,
  * @dev:       PWM device to update
  * @channel:   PWM channel to update
  * @enable:    true to enable, false to disable
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int pwm_set_enable(struct udevice *dev, uint channel, bool enable);
 
@@ -76,7 +84,7 @@ int pwm_set_enable(struct udevice *dev, uint channel, bool enable);
  * @dev:       PWM device to update
  * @channel:   PWM channel to update
  * @polarity:  true to invert, false to keep normal polarity
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int pwm_set_invert(struct udevice *dev, uint channel, bool polarity);