X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fpwm.h;h=bfdc1e3f30778b0a492c2653ef9cb30c7627295a;hb=46b5c8ed017958fc387ab86c71ae6c90abb6793c;hp=f9959706ceb696536af9bfeb1cc3748e2dd6b28a;hpb=401d1c4f5d2d29c4bc4beaec95402ca23eb63295;p=platform%2Fkernel%2Fu-boot.git

diff --git a/include/pwm.h b/include/pwm.h
index f995970..bfdc1e3 100644
--- a/include/pwm.h
+++ b/include/pwm.h
@@ -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);