Merge branch 'master' of git://git.denx.de/u-boot
[platform/kernel/u-boot.git] / include / pwm.h
index 851915e..668551e 100644 (file)
@@ -1,21 +1,26 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * header file for pwm driver.
  *
  * Copyright 2016 Google Inc.
  * Copyright (c) 2011 samsung electronics
  * Donghwa Lee <dh09.lee@samsung.com>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef _pwm_h_
 #define _pwm_h_
 
+struct udevice;
+
 /* struct pwm_ops: Operations for the PWM uclass */
 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
@@ -34,6 +39,15 @@ struct pwm_ops {
         * @return 0 if OK, -ve on error
         */
        int (*set_enable)(struct udevice *dev, uint channel, bool enable);
+       /**
+        * set_invert() - Set the PWM invert
+        *
+        * @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
+        */
+       int (*set_invert)(struct udevice *dev, uint channel, bool polarity);
 };
 
 #define pwm_get_ops(dev)       ((struct pwm_ops *)(dev)->driver->ops)
@@ -41,6 +55,10 @@ 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
@@ -60,6 +78,16 @@ int pwm_set_config(struct udevice *dev, uint channel, uint period_ns,
  */
 int pwm_set_enable(struct udevice *dev, uint channel, bool enable);
 
+/**
+ * pwm_set_invert() - Set pwm default polarity
+ *
+ * @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
+ */
+int pwm_set_invert(struct udevice *dev, uint channel, bool polarity);
+
 /* Legacy interface */
 #ifndef CONFIG_DM_PWM
 int    pwm_init                (int pwm_id, int div, int invert);