+/* 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
/**
* 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);
* @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);
* @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);