u-boot/include/pwm.h
Tom Rini 83d290c56f SPDX: Convert all of our single license tags to Linux Kernel style
When U-Boot started using SPDX tags we were among the early adopters and
there weren't a lot of other examples to borrow from.  So we picked the
area of the file that usually had a full license text and replaced it
with an appropriate SPDX-License-Identifier: entry.  Since then, the
Linux Kernel has adopted SPDX tags and they place it as the very first
line in a file (except where shebangs are used, then it's second line)
and with slightly different comment styles than us.

In part due to community overlap, in part due to better tag visibility
and in part for other minor reasons, switch over to that style.

This commit changes all instances where we have a single declared
license in the tag as both the before and after are identical in tag
contents.  There's also a few places where I found we did not have a tag
and have introduced one.

Signed-off-by: Tom Rini <trini@konsulko.com>
2018-05-07 09:34:12 -04:00

90 lines
2.3 KiB
C

/* 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>
*/
#ifndef _pwm_h_
#define _pwm_h_
/* struct pwm_ops: Operations for the PWM uclass */
struct pwm_ops {
/**
* set_config() - Set the PWM configuration
*
* @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
*/
int (*set_config)(struct udevice *dev, uint channel, uint period_ns,
uint duty_ns);
/**
* set_enable() - Enable or disable the PWM
*
* @dev: PWM device to update
* @channel: PWM channel to update
* @enable: true to enable, false to disable
* @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)
/**
* pwm_set_config() - Set the PWM configuration
*
* @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
*/
int pwm_set_config(struct udevice *dev, uint channel, uint period_ns,
uint duty_ns);
/**
* pwm_set_enable() - Enable or disable the PWM
*
* @dev: PWM device to update
* @channel: PWM channel to update
* @enable: true to enable, false to disable
* @return 0 if OK, -ve on error
*/
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);
int pwm_config (int pwm_id, int duty_ns, int period_ns);
int pwm_enable (int pwm_id);
void pwm_disable (int pwm_id);
#endif
#endif /* _pwm_h_ */