blob: 54ae3e64c310f61026907905c3bd794a68dd48c7 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Donghwa Lee3f129282011-03-07 21:11:42 +00002/*
3 * header file for pwm driver.
4 *
Simon Glassfc760cb2016-01-21 19:44:54 -07005 * Copyright 2016 Google Inc.
Donghwa Lee3f129282011-03-07 21:11:42 +00006 * Copyright (c) 2011 samsung electronics
7 * Donghwa Lee <dh09.lee@samsung.com>
Donghwa Lee3f129282011-03-07 21:11:42 +00008 */
9
10#ifndef _pwm_h_
11#define _pwm_h_
12
Simon Glassfc760cb2016-01-21 19:44:54 -070013/* struct pwm_ops: Operations for the PWM uclass */
14struct pwm_ops {
15 /**
16 * set_config() - Set the PWM configuration
17 *
18 * @dev: PWM device to update
19 * @channel: PWM channel to update
20 * @period_ns: PWM period in nanoseconds
21 * @duty_ns: PWM duty period in nanoseconds
22 * @return 0 if OK, -ve on error
23 */
24 int (*set_config)(struct udevice *dev, uint channel, uint period_ns,
25 uint duty_ns);
26
27 /**
28 * set_enable() - Enable or disable the PWM
29 *
30 * @dev: PWM device to update
31 * @channel: PWM channel to update
32 * @enable: true to enable, false to disable
33 * @return 0 if OK, -ve on error
34 */
35 int (*set_enable)(struct udevice *dev, uint channel, bool enable);
Kever Yang0b601112017-04-24 10:27:49 +080036 /**
37 * set_invert() - Set the PWM invert
38 *
39 * @dev: PWM device to update
40 * @channel: PWM channel to update
41 * @polarity: true to invert, false to keep normal polarity
42 * @return 0 if OK, -ve on error
43 */
44 int (*set_invert)(struct udevice *dev, uint channel, bool polarity);
Simon Glassfc760cb2016-01-21 19:44:54 -070045};
46
47#define pwm_get_ops(dev) ((struct pwm_ops *)(dev)->driver->ops)
48
49/**
50 * pwm_set_config() - Set the PWM configuration
51 *
52 * @dev: PWM device to update
53 * @channel: PWM channel to update
54 * @period_ns: PWM period in nanoseconds
55 * @duty_ns: PWM duty period in nanoseconds
56 * @return 0 if OK, -ve on error
57 */
58int pwm_set_config(struct udevice *dev, uint channel, uint period_ns,
59 uint duty_ns);
60
61/**
62 * pwm_set_enable() - Enable or disable the PWM
63 *
64 * @dev: PWM device to update
65 * @channel: PWM channel to update
66 * @enable: true to enable, false to disable
67 * @return 0 if OK, -ve on error
68 */
69int pwm_set_enable(struct udevice *dev, uint channel, bool enable);
70
Kever Yang0b601112017-04-24 10:27:49 +080071/**
72 * pwm_set_invert() - Set pwm default polarity
73 *
74 * @dev: PWM device to update
75 * @channel: PWM channel to update
76 * @polarity: true to invert, false to keep normal polarity
77 * @return 0 if OK, -ve on error
78 */
79int pwm_set_invert(struct udevice *dev, uint channel, bool polarity);
80
Simon Glassfc760cb2016-01-21 19:44:54 -070081/* Legacy interface */
82#ifndef CONFIG_DM_PWM
Donghwa Lee3f129282011-03-07 21:11:42 +000083int pwm_init (int pwm_id, int div, int invert);
84int pwm_config (int pwm_id, int duty_ns, int period_ns);
85int pwm_enable (int pwm_id);
86void pwm_disable (int pwm_id);
Simon Glassfc760cb2016-01-21 19:44:54 -070087#endif
Donghwa Lee3f129282011-03-07 21:11:42 +000088
89#endif /* _pwm_h_ */