Commit | Line | Data |
---|---|---|
1a189b97 RK |
1 | #ifndef __LINUX_PWM_H |
2 | #define __LINUX_PWM_H | |
3 | ||
0bcf168b | 4 | #include <linux/err.h> |
d1cd2142 | 5 | #include <linux/mutex.h> |
7299ab70 TR |
6 | #include <linux/of.h> |
7 | ||
1a189b97 | 8 | struct pwm_device; |
62099abf | 9 | struct seq_file; |
1a189b97 | 10 | |
557fe99d | 11 | #if IS_ENABLED(CONFIG_PWM) |
1a189b97 RK |
12 | /* |
13 | * pwm_request - request a PWM device | |
14 | */ | |
15 | struct pwm_device *pwm_request(int pwm_id, const char *label); | |
16 | ||
17 | /* | |
18 | * pwm_free - free a PWM device | |
19 | */ | |
20 | void pwm_free(struct pwm_device *pwm); | |
21 | ||
22 | /* | |
23 | * pwm_config - change a PWM device configuration | |
24 | */ | |
25 | int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns); | |
26 | ||
27 | /* | |
28 | * pwm_enable - start a PWM output toggling | |
29 | */ | |
30 | int pwm_enable(struct pwm_device *pwm); | |
31 | ||
32 | /* | |
33 | * pwm_disable - stop a PWM output toggling | |
34 | */ | |
35 | void pwm_disable(struct pwm_device *pwm); | |
0bcf168b TB |
36 | #else |
37 | static inline struct pwm_device *pwm_request(int pwm_id, const char *label) | |
38 | { | |
39 | return ERR_PTR(-ENODEV); | |
40 | } | |
41 | ||
42 | static inline void pwm_free(struct pwm_device *pwm) | |
43 | { | |
44 | } | |
45 | ||
46 | static inline int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns) | |
47 | { | |
48 | return -EINVAL; | |
49 | } | |
50 | ||
51 | static inline int pwm_enable(struct pwm_device *pwm) | |
52 | { | |
53 | return -EINVAL; | |
54 | } | |
55 | ||
56 | static inline void pwm_disable(struct pwm_device *pwm) | |
57 | { | |
58 | } | |
59 | #endif | |
1a189b97 | 60 | |
0c2498f1 SH |
61 | struct pwm_chip; |
62 | ||
0aa0869c PA |
63 | /** |
64 | * enum pwm_polarity - polarity of a PWM signal | |
65 | * @PWM_POLARITY_NORMAL: a high signal for the duration of the duty- | |
66 | * cycle, followed by a low signal for the remainder of the pulse | |
67 | * period | |
68 | * @PWM_POLARITY_INVERSED: a low signal for the duration of the duty- | |
69 | * cycle, followed by a high signal for the remainder of the pulse | |
70 | * period | |
71 | */ | |
72 | enum pwm_polarity { | |
73 | PWM_POLARITY_NORMAL, | |
74 | PWM_POLARITY_INVERSED, | |
75 | }; | |
76 | ||
e39c0df1 BB |
77 | /** |
78 | * struct pwm_args - board-dependent PWM arguments | |
79 | * @period: reference period | |
80 | * @polarity: reference polarity | |
81 | * | |
82 | * This structure describes board-dependent arguments attached to a PWM | |
83 | * device. These arguments are usually retrieved from the PWM lookup table or | |
84 | * device tree. | |
85 | * | |
86 | * Do not confuse this with the PWM state: PWM arguments represent the initial | |
87 | * configuration that users want to use on this PWM device rather than the | |
88 | * current PWM hardware state. | |
89 | */ | |
90 | struct pwm_args { | |
91 | unsigned int period; | |
92 | enum pwm_polarity polarity; | |
93 | }; | |
94 | ||
f051c466 TR |
95 | enum { |
96 | PWMF_REQUESTED = 1 << 0, | |
97 | PWMF_ENABLED = 1 << 1, | |
76abbdde | 98 | PWMF_EXPORTED = 1 << 2, |
f051c466 TR |
99 | }; |
100 | ||
04883802 TR |
101 | /** |
102 | * struct pwm_device - PWM channel object | |
103 | * @label: name of the PWM device | |
104 | * @flags: flags associated with the PWM device | |
105 | * @hwpwm: per-chip relative index of the PWM device | |
106 | * @pwm: global index of the PWM device | |
107 | * @chip: PWM chip providing this PWM device | |
108 | * @chip_data: chip-private data associated with the PWM device | |
109 | * @period: period of the PWM signal (in nanoseconds) | |
110 | * @duty_cycle: duty cycle of the PWM signal (in nanoseconds) | |
111 | * @polarity: polarity of the PWM signal | |
e39c0df1 | 112 | * @args: PWM arguments |
04883802 | 113 | */ |
f051c466 | 114 | struct pwm_device { |
6bc7064a TR |
115 | const char *label; |
116 | unsigned long flags; | |
117 | unsigned int hwpwm; | |
118 | unsigned int pwm; | |
119 | struct pwm_chip *chip; | |
120 | void *chip_data; | |
121 | ||
122 | unsigned int period; | |
123 | unsigned int duty_cycle; | |
124 | enum pwm_polarity polarity; | |
e39c0df1 BB |
125 | |
126 | struct pwm_args args; | |
f051c466 TR |
127 | }; |
128 | ||
5c31252c BB |
129 | static inline bool pwm_is_enabled(const struct pwm_device *pwm) |
130 | { | |
131 | return test_bit(PWMF_ENABLED, &pwm->flags); | |
132 | } | |
133 | ||
f051c466 TR |
134 | static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period) |
135 | { | |
136 | if (pwm) | |
137 | pwm->period = period; | |
138 | } | |
139 | ||
a1cf4217 | 140 | static inline unsigned int pwm_get_period(const struct pwm_device *pwm) |
f051c466 TR |
141 | { |
142 | return pwm ? pwm->period : 0; | |
143 | } | |
144 | ||
76abbdde HS |
145 | static inline void pwm_set_duty_cycle(struct pwm_device *pwm, unsigned int duty) |
146 | { | |
147 | if (pwm) | |
148 | pwm->duty_cycle = duty; | |
149 | } | |
150 | ||
a1cf4217 | 151 | static inline unsigned int pwm_get_duty_cycle(const struct pwm_device *pwm) |
76abbdde HS |
152 | { |
153 | return pwm ? pwm->duty_cycle : 0; | |
154 | } | |
155 | ||
0aa0869c PA |
156 | /* |
157 | * pwm_set_polarity - configure the polarity of a PWM signal | |
158 | */ | |
159 | int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity); | |
160 | ||
011e7631 BB |
161 | static inline enum pwm_polarity pwm_get_polarity(const struct pwm_device *pwm) |
162 | { | |
163 | return pwm ? pwm->polarity : PWM_POLARITY_NORMAL; | |
164 | } | |
165 | ||
e39c0df1 BB |
166 | static inline void pwm_get_args(const struct pwm_device *pwm, |
167 | struct pwm_args *args) | |
168 | { | |
169 | *args = pwm->args; | |
170 | } | |
171 | ||
172 | static inline void pwm_apply_args(struct pwm_device *pwm) | |
173 | { | |
e39c0df1 BB |
174 | pwm_set_polarity(pwm, pwm->args.polarity); |
175 | } | |
176 | ||
0c2498f1 SH |
177 | /** |
178 | * struct pwm_ops - PWM controller operations | |
179 | * @request: optional hook for requesting a PWM | |
180 | * @free: optional hook for freeing a PWM | |
181 | * @config: configure duty cycles and period length for this PWM | |
0aa0869c | 182 | * @set_polarity: configure the polarity of this PWM |
0c2498f1 SH |
183 | * @enable: enable PWM output toggling |
184 | * @disable: disable PWM output toggling | |
62099abf | 185 | * @dbg_show: optional routine to show contents in debugfs |
0c2498f1 SH |
186 | * @owner: helps prevent removal of modules exporting active PWMs |
187 | */ | |
188 | struct pwm_ops { | |
6bc7064a TR |
189 | int (*request)(struct pwm_chip *chip, struct pwm_device *pwm); |
190 | void (*free)(struct pwm_chip *chip, struct pwm_device *pwm); | |
191 | int (*config)(struct pwm_chip *chip, struct pwm_device *pwm, | |
192 | int duty_ns, int period_ns); | |
193 | int (*set_polarity)(struct pwm_chip *chip, struct pwm_device *pwm, | |
194 | enum pwm_polarity polarity); | |
195 | int (*enable)(struct pwm_chip *chip, struct pwm_device *pwm); | |
196 | void (*disable)(struct pwm_chip *chip, struct pwm_device *pwm); | |
62099abf | 197 | #ifdef CONFIG_DEBUG_FS |
6bc7064a | 198 | void (*dbg_show)(struct pwm_chip *chip, struct seq_file *s); |
62099abf | 199 | #endif |
6bc7064a | 200 | struct module *owner; |
0c2498f1 SH |
201 | }; |
202 | ||
203 | /** | |
f051c466 TR |
204 | * struct pwm_chip - abstract a PWM controller |
205 | * @dev: device providing the PWMs | |
206 | * @list: list node for internal use | |
207 | * @ops: callbacks for this PWM controller | |
208 | * @base: number of first PWM controlled by this chip | |
209 | * @npwm: number of PWMs controlled by this chip | |
210 | * @pwms: array of PWM devices allocated by the framework | |
04883802 TR |
211 | * @of_xlate: request a PWM device given a device tree PWM specifier |
212 | * @of_pwm_n_cells: number of cells expected in the device tree PWM specifier | |
6e69ab13 FV |
213 | * @can_sleep: must be true if the .config(), .enable() or .disable() |
214 | * operations may sleep | |
0c2498f1 SH |
215 | */ |
216 | struct pwm_chip { | |
6bc7064a TR |
217 | struct device *dev; |
218 | struct list_head list; | |
219 | const struct pwm_ops *ops; | |
220 | int base; | |
221 | unsigned int npwm; | |
222 | ||
223 | struct pwm_device *pwms; | |
224 | ||
225 | struct pwm_device * (*of_xlate)(struct pwm_chip *pc, | |
226 | const struct of_phandle_args *args); | |
227 | unsigned int of_pwm_n_cells; | |
228 | bool can_sleep; | |
0c2498f1 SH |
229 | }; |
230 | ||
0bcf168b | 231 | #if IS_ENABLED(CONFIG_PWM) |
f051c466 TR |
232 | int pwm_set_chip_data(struct pwm_device *pwm, void *data); |
233 | void *pwm_get_chip_data(struct pwm_device *pwm); | |
234 | ||
b6a00fae TK |
235 | int pwmchip_add_with_polarity(struct pwm_chip *chip, |
236 | enum pwm_polarity polarity); | |
0c2498f1 SH |
237 | int pwmchip_add(struct pwm_chip *chip); |
238 | int pwmchip_remove(struct pwm_chip *chip); | |
f051c466 TR |
239 | struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip, |
240 | unsigned int index, | |
241 | const char *label); | |
8138d2dd | 242 | |
83af2402 PA |
243 | struct pwm_device *of_pwm_xlate_with_flags(struct pwm_chip *pc, |
244 | const struct of_phandle_args *args); | |
245 | ||
d4c0c470 | 246 | struct pwm_device *pwm_get(struct device *dev, const char *con_id); |
8eb96127 | 247 | struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id); |
8138d2dd TR |
248 | void pwm_put(struct pwm_device *pwm); |
249 | ||
d4c0c470 | 250 | struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id); |
261a5edd PU |
251 | struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np, |
252 | const char *con_id); | |
6354316d | 253 | void devm_pwm_put(struct device *dev, struct pwm_device *pwm); |
6e69ab13 FV |
254 | |
255 | bool pwm_can_sleep(struct pwm_device *pwm); | |
0bcf168b TB |
256 | #else |
257 | static inline int pwm_set_chip_data(struct pwm_device *pwm, void *data) | |
258 | { | |
259 | return -EINVAL; | |
260 | } | |
261 | ||
262 | static inline void *pwm_get_chip_data(struct pwm_device *pwm) | |
263 | { | |
264 | return NULL; | |
265 | } | |
266 | ||
267 | static inline int pwmchip_add(struct pwm_chip *chip) | |
268 | { | |
269 | return -EINVAL; | |
270 | } | |
271 | ||
b6a00fae TK |
272 | static inline int pwmchip_add_inversed(struct pwm_chip *chip) |
273 | { | |
274 | return -EINVAL; | |
275 | } | |
276 | ||
0bcf168b TB |
277 | static inline int pwmchip_remove(struct pwm_chip *chip) |
278 | { | |
279 | return -EINVAL; | |
280 | } | |
281 | ||
282 | static inline struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip, | |
283 | unsigned int index, | |
284 | const char *label) | |
285 | { | |
286 | return ERR_PTR(-ENODEV); | |
287 | } | |
288 | ||
289 | static inline struct pwm_device *pwm_get(struct device *dev, | |
290 | const char *consumer) | |
291 | { | |
292 | return ERR_PTR(-ENODEV); | |
293 | } | |
294 | ||
8eb96127 PU |
295 | static inline struct pwm_device *of_pwm_get(struct device_node *np, |
296 | const char *con_id) | |
297 | { | |
298 | return ERR_PTR(-ENODEV); | |
299 | } | |
300 | ||
0bcf168b TB |
301 | static inline void pwm_put(struct pwm_device *pwm) |
302 | { | |
303 | } | |
304 | ||
305 | static inline struct pwm_device *devm_pwm_get(struct device *dev, | |
306 | const char *consumer) | |
307 | { | |
308 | return ERR_PTR(-ENODEV); | |
309 | } | |
310 | ||
261a5edd PU |
311 | static inline struct pwm_device *devm_of_pwm_get(struct device *dev, |
312 | struct device_node *np, | |
313 | const char *con_id) | |
314 | { | |
315 | return ERR_PTR(-ENODEV); | |
316 | } | |
317 | ||
0bcf168b TB |
318 | static inline void devm_pwm_put(struct device *dev, struct pwm_device *pwm) |
319 | { | |
320 | } | |
6e69ab13 FV |
321 | |
322 | static inline bool pwm_can_sleep(struct pwm_device *pwm) | |
323 | { | |
324 | return false; | |
325 | } | |
0bcf168b | 326 | #endif |
6354316d | 327 | |
8138d2dd TR |
328 | struct pwm_lookup { |
329 | struct list_head list; | |
330 | const char *provider; | |
331 | unsigned int index; | |
332 | const char *dev_id; | |
333 | const char *con_id; | |
3796ce1d AB |
334 | unsigned int period; |
335 | enum pwm_polarity polarity; | |
8138d2dd TR |
336 | }; |
337 | ||
42844029 | 338 | #define PWM_LOOKUP(_provider, _index, _dev_id, _con_id, _period, _polarity) \ |
8138d2dd TR |
339 | { \ |
340 | .provider = _provider, \ | |
341 | .index = _index, \ | |
342 | .dev_id = _dev_id, \ | |
343 | .con_id = _con_id, \ | |
42844029 AB |
344 | .period = _period, \ |
345 | .polarity = _polarity \ | |
8138d2dd TR |
346 | } |
347 | ||
0bcf168b | 348 | #if IS_ENABLED(CONFIG_PWM) |
8138d2dd | 349 | void pwm_add_table(struct pwm_lookup *table, size_t num); |
efb0de55 | 350 | void pwm_remove_table(struct pwm_lookup *table, size_t num); |
0bcf168b TB |
351 | #else |
352 | static inline void pwm_add_table(struct pwm_lookup *table, size_t num) | |
353 | { | |
354 | } | |
efb0de55 SK |
355 | |
356 | static inline void pwm_remove_table(struct pwm_lookup *table, size_t num) | |
357 | { | |
358 | } | |
0c2498f1 SH |
359 | #endif |
360 | ||
76abbdde HS |
361 | #ifdef CONFIG_PWM_SYSFS |
362 | void pwmchip_sysfs_export(struct pwm_chip *chip); | |
363 | void pwmchip_sysfs_unexport(struct pwm_chip *chip); | |
364 | #else | |
365 | static inline void pwmchip_sysfs_export(struct pwm_chip *chip) | |
366 | { | |
367 | } | |
368 | ||
369 | static inline void pwmchip_sysfs_unexport(struct pwm_chip *chip) | |
370 | { | |
371 | } | |
372 | #endif /* CONFIG_PWM_SYSFS */ | |
373 | ||
5243ef8b | 374 | #endif /* __LINUX_PWM_H */ |