]>
Commit | Line | Data |
---|---|---|
0c2498f1 SH |
1 | /* |
2 | * Generic pwmlib implementation | |
3 | * | |
4 | * Copyright (C) 2011 Sascha Hauer <[email protected]> | |
f051c466 | 5 | * Copyright (C) 2011-2012 Avionic Design GmbH |
0c2498f1 SH |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2, or (at your option) | |
10 | * any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; see the file COPYING. If not, write to | |
19 | * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
20 | */ | |
21 | ||
22 | #include <linux/module.h> | |
23 | #include <linux/pwm.h> | |
f051c466 | 24 | #include <linux/radix-tree.h> |
0c2498f1 SH |
25 | #include <linux/list.h> |
26 | #include <linux/mutex.h> | |
27 | #include <linux/err.h> | |
28 | #include <linux/slab.h> | |
29 | #include <linux/device.h> | |
62099abf TR |
30 | #include <linux/debugfs.h> |
31 | #include <linux/seq_file.h> | |
0c2498f1 | 32 | |
208be769 | 33 | #include <dt-bindings/pwm/pwm.h> |
0c2498f1 | 34 | |
208be769 | 35 | #define MAX_PWMS 1024 |
83af2402 | 36 | |
8138d2dd TR |
37 | static DEFINE_MUTEX(pwm_lookup_lock); |
38 | static LIST_HEAD(pwm_lookup_list); | |
0c2498f1 | 39 | static DEFINE_MUTEX(pwm_lock); |
f051c466 TR |
40 | static LIST_HEAD(pwm_chips); |
41 | static DECLARE_BITMAP(allocated_pwms, MAX_PWMS); | |
42 | static RADIX_TREE(pwm_tree, GFP_KERNEL); | |
0c2498f1 | 43 | |
f051c466 | 44 | static struct pwm_device *pwm_to_device(unsigned int pwm) |
0c2498f1 | 45 | { |
f051c466 TR |
46 | return radix_tree_lookup(&pwm_tree, pwm); |
47 | } | |
48 | ||
49 | static int alloc_pwms(int pwm, unsigned int count) | |
50 | { | |
51 | unsigned int from = 0; | |
52 | unsigned int start; | |
53 | ||
54 | if (pwm >= MAX_PWMS) | |
55 | return -EINVAL; | |
56 | ||
57 | if (pwm >= 0) | |
58 | from = pwm; | |
0c2498f1 | 59 | |
f051c466 TR |
60 | start = bitmap_find_next_zero_area(allocated_pwms, MAX_PWMS, from, |
61 | count, 0); | |
62 | ||
63 | if (pwm >= 0 && start != pwm) | |
64 | return -EEXIST; | |
65 | ||
66 | if (start + count > MAX_PWMS) | |
67 | return -ENOSPC; | |
68 | ||
69 | return start; | |
70 | } | |
71 | ||
72 | static void free_pwms(struct pwm_chip *chip) | |
73 | { | |
74 | unsigned int i; | |
75 | ||
76 | for (i = 0; i < chip->npwm; i++) { | |
77 | struct pwm_device *pwm = &chip->pwms[i]; | |
78 | radix_tree_delete(&pwm_tree, pwm->pwm); | |
0c2498f1 SH |
79 | } |
80 | ||
f051c466 TR |
81 | bitmap_clear(allocated_pwms, chip->base, chip->npwm); |
82 | ||
83 | kfree(chip->pwms); | |
84 | chip->pwms = NULL; | |
85 | } | |
86 | ||
8138d2dd TR |
87 | static struct pwm_chip *pwmchip_find_by_name(const char *name) |
88 | { | |
89 | struct pwm_chip *chip; | |
90 | ||
91 | if (!name) | |
92 | return NULL; | |
93 | ||
94 | mutex_lock(&pwm_lock); | |
95 | ||
96 | list_for_each_entry(chip, &pwm_chips, list) { | |
97 | const char *chip_name = dev_name(chip->dev); | |
98 | ||
99 | if (chip_name && strcmp(chip_name, name) == 0) { | |
100 | mutex_unlock(&pwm_lock); | |
101 | return chip; | |
102 | } | |
103 | } | |
104 | ||
105 | mutex_unlock(&pwm_lock); | |
106 | ||
107 | return NULL; | |
108 | } | |
109 | ||
f051c466 TR |
110 | static int pwm_device_request(struct pwm_device *pwm, const char *label) |
111 | { | |
112 | int err; | |
113 | ||
114 | if (test_bit(PWMF_REQUESTED, &pwm->flags)) | |
115 | return -EBUSY; | |
116 | ||
117 | if (!try_module_get(pwm->chip->ops->owner)) | |
118 | return -ENODEV; | |
119 | ||
120 | if (pwm->chip->ops->request) { | |
121 | err = pwm->chip->ops->request(pwm->chip, pwm); | |
122 | if (err) { | |
123 | module_put(pwm->chip->ops->owner); | |
124 | return err; | |
125 | } | |
126 | } | |
127 | ||
128 | set_bit(PWMF_REQUESTED, &pwm->flags); | |
129 | pwm->label = label; | |
130 | ||
131 | return 0; | |
132 | } | |
133 | ||
83af2402 PA |
134 | struct pwm_device * |
135 | of_pwm_xlate_with_flags(struct pwm_chip *pc, const struct of_phandle_args *args) | |
136 | { | |
137 | struct pwm_device *pwm; | |
138 | ||
139 | if (pc->of_pwm_n_cells < 3) | |
140 | return ERR_PTR(-EINVAL); | |
141 | ||
142 | if (args->args[0] >= pc->npwm) | |
143 | return ERR_PTR(-EINVAL); | |
144 | ||
145 | pwm = pwm_request_from_chip(pc, args->args[0], NULL); | |
146 | if (IS_ERR(pwm)) | |
147 | return pwm; | |
148 | ||
e39c0df1 | 149 | pwm->args.period = args->args[1]; |
83af2402 | 150 | |
208be769 | 151 | if (args->args[2] & PWM_POLARITY_INVERTED) |
e39c0df1 | 152 | pwm->args.polarity = PWM_POLARITY_INVERSED; |
83af2402 | 153 | else |
e39c0df1 | 154 | pwm->args.polarity = PWM_POLARITY_NORMAL; |
83af2402 PA |
155 | |
156 | return pwm; | |
157 | } | |
417328c3 | 158 | EXPORT_SYMBOL_GPL(of_pwm_xlate_with_flags); |
83af2402 | 159 | |
e50d3523 SK |
160 | static struct pwm_device * |
161 | of_pwm_simple_xlate(struct pwm_chip *pc, const struct of_phandle_args *args) | |
7299ab70 TR |
162 | { |
163 | struct pwm_device *pwm; | |
164 | ||
165 | if (pc->of_pwm_n_cells < 2) | |
166 | return ERR_PTR(-EINVAL); | |
167 | ||
168 | if (args->args[0] >= pc->npwm) | |
169 | return ERR_PTR(-EINVAL); | |
170 | ||
171 | pwm = pwm_request_from_chip(pc, args->args[0], NULL); | |
172 | if (IS_ERR(pwm)) | |
173 | return pwm; | |
174 | ||
e39c0df1 | 175 | pwm->args.period = args->args[1]; |
7299ab70 TR |
176 | |
177 | return pwm; | |
178 | } | |
179 | ||
dfeb86ec | 180 | static void of_pwmchip_add(struct pwm_chip *chip) |
7299ab70 TR |
181 | { |
182 | if (!chip->dev || !chip->dev->of_node) | |
183 | return; | |
184 | ||
185 | if (!chip->of_xlate) { | |
186 | chip->of_xlate = of_pwm_simple_xlate; | |
187 | chip->of_pwm_n_cells = 2; | |
188 | } | |
189 | ||
190 | of_node_get(chip->dev->of_node); | |
191 | } | |
192 | ||
dfeb86ec | 193 | static void of_pwmchip_remove(struct pwm_chip *chip) |
7299ab70 | 194 | { |
8d6cc073 | 195 | if (chip->dev) |
7299ab70 TR |
196 | of_node_put(chip->dev->of_node); |
197 | } | |
198 | ||
f051c466 TR |
199 | /** |
200 | * pwm_set_chip_data() - set private chip data for a PWM | |
201 | * @pwm: PWM device | |
202 | * @data: pointer to chip-specific data | |
04883802 TR |
203 | * |
204 | * Returns: 0 on success or a negative error code on failure. | |
f051c466 TR |
205 | */ |
206 | int pwm_set_chip_data(struct pwm_device *pwm, void *data) | |
207 | { | |
208 | if (!pwm) | |
209 | return -EINVAL; | |
210 | ||
211 | pwm->chip_data = data; | |
212 | ||
213 | return 0; | |
214 | } | |
928c4477 | 215 | EXPORT_SYMBOL_GPL(pwm_set_chip_data); |
f051c466 TR |
216 | |
217 | /** | |
218 | * pwm_get_chip_data() - get private chip data for a PWM | |
219 | * @pwm: PWM device | |
04883802 TR |
220 | * |
221 | * Returns: A pointer to the chip-private data for the PWM device. | |
f051c466 TR |
222 | */ |
223 | void *pwm_get_chip_data(struct pwm_device *pwm) | |
224 | { | |
225 | return pwm ? pwm->chip_data : NULL; | |
0c2498f1 | 226 | } |
928c4477 | 227 | EXPORT_SYMBOL_GPL(pwm_get_chip_data); |
0c2498f1 SH |
228 | |
229 | /** | |
b6a00fae | 230 | * pwmchip_add_with_polarity() - register a new PWM chip |
0c2498f1 | 231 | * @chip: the PWM chip to add |
b6a00fae | 232 | * @polarity: initial polarity of PWM channels |
f051c466 TR |
233 | * |
234 | * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base | |
b6a00fae TK |
235 | * will be used. The initial polarity for all channels is specified by the |
236 | * @polarity parameter. | |
04883802 TR |
237 | * |
238 | * Returns: 0 on success or a negative error code on failure. | |
0c2498f1 | 239 | */ |
b6a00fae TK |
240 | int pwmchip_add_with_polarity(struct pwm_chip *chip, |
241 | enum pwm_polarity polarity) | |
0c2498f1 SH |
242 | { |
243 | struct pwm_device *pwm; | |
f051c466 TR |
244 | unsigned int i; |
245 | int ret; | |
0c2498f1 | 246 | |
f051c466 | 247 | if (!chip || !chip->dev || !chip->ops || !chip->ops->config || |
533acc0e | 248 | !chip->ops->enable || !chip->ops->disable || !chip->npwm) |
f051c466 | 249 | return -EINVAL; |
0c2498f1 SH |
250 | |
251 | mutex_lock(&pwm_lock); | |
252 | ||
f051c466 TR |
253 | ret = alloc_pwms(chip->base, chip->npwm); |
254 | if (ret < 0) | |
255 | goto out; | |
256 | ||
257 | chip->pwms = kzalloc(chip->npwm * sizeof(*pwm), GFP_KERNEL); | |
258 | if (!chip->pwms) { | |
259 | ret = -ENOMEM; | |
0c2498f1 SH |
260 | goto out; |
261 | } | |
262 | ||
f051c466 TR |
263 | chip->base = ret; |
264 | ||
265 | for (i = 0; i < chip->npwm; i++) { | |
266 | pwm = &chip->pwms[i]; | |
267 | ||
268 | pwm->chip = chip; | |
269 | pwm->pwm = chip->base + i; | |
270 | pwm->hwpwm = i; | |
43a276b0 | 271 | pwm->state.polarity = polarity; |
0c2498f1 | 272 | |
15fa8a43 BB |
273 | if (chip->ops->get_state) |
274 | chip->ops->get_state(chip, pwm, &pwm->state); | |
275 | ||
f051c466 TR |
276 | radix_tree_insert(&pwm_tree, pwm->pwm, pwm); |
277 | } | |
278 | ||
279 | bitmap_set(allocated_pwms, chip->base, chip->npwm); | |
280 | ||
281 | INIT_LIST_HEAD(&chip->list); | |
282 | list_add(&chip->list, &pwm_chips); | |
0c2498f1 | 283 | |
f051c466 TR |
284 | ret = 0; |
285 | ||
7299ab70 TR |
286 | if (IS_ENABLED(CONFIG_OF)) |
287 | of_pwmchip_add(chip); | |
288 | ||
76abbdde HS |
289 | pwmchip_sysfs_export(chip); |
290 | ||
f051c466 TR |
291 | out: |
292 | mutex_unlock(&pwm_lock); | |
0c2498f1 SH |
293 | return ret; |
294 | } | |
b6a00fae TK |
295 | EXPORT_SYMBOL_GPL(pwmchip_add_with_polarity); |
296 | ||
297 | /** | |
298 | * pwmchip_add() - register a new PWM chip | |
299 | * @chip: the PWM chip to add | |
300 | * | |
301 | * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base | |
302 | * will be used. The initial polarity for all channels is normal. | |
04883802 TR |
303 | * |
304 | * Returns: 0 on success or a negative error code on failure. | |
b6a00fae TK |
305 | */ |
306 | int pwmchip_add(struct pwm_chip *chip) | |
307 | { | |
308 | return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL); | |
309 | } | |
0c2498f1 SH |
310 | EXPORT_SYMBOL_GPL(pwmchip_add); |
311 | ||
312 | /** | |
313 | * pwmchip_remove() - remove a PWM chip | |
314 | * @chip: the PWM chip to remove | |
315 | * | |
316 | * Removes a PWM chip. This function may return busy if the PWM chip provides | |
317 | * a PWM device that is still requested. | |
04883802 TR |
318 | * |
319 | * Returns: 0 on success or a negative error code on failure. | |
0c2498f1 SH |
320 | */ |
321 | int pwmchip_remove(struct pwm_chip *chip) | |
322 | { | |
f051c466 | 323 | unsigned int i; |
0c2498f1 SH |
324 | int ret = 0; |
325 | ||
326 | mutex_lock(&pwm_lock); | |
327 | ||
f051c466 TR |
328 | for (i = 0; i < chip->npwm; i++) { |
329 | struct pwm_device *pwm = &chip->pwms[i]; | |
0c2498f1 | 330 | |
f051c466 TR |
331 | if (test_bit(PWMF_REQUESTED, &pwm->flags)) { |
332 | ret = -EBUSY; | |
333 | goto out; | |
334 | } | |
0c2498f1 SH |
335 | } |
336 | ||
f051c466 | 337 | list_del_init(&chip->list); |
7299ab70 TR |
338 | |
339 | if (IS_ENABLED(CONFIG_OF)) | |
340 | of_pwmchip_remove(chip); | |
341 | ||
f051c466 | 342 | free_pwms(chip); |
0c2498f1 | 343 | |
76abbdde HS |
344 | pwmchip_sysfs_unexport(chip); |
345 | ||
0c2498f1 SH |
346 | out: |
347 | mutex_unlock(&pwm_lock); | |
0c2498f1 SH |
348 | return ret; |
349 | } | |
350 | EXPORT_SYMBOL_GPL(pwmchip_remove); | |
351 | ||
352 | /** | |
353 | * pwm_request() - request a PWM device | |
04883802 | 354 | * @pwm: global PWM device index |
0c2498f1 | 355 | * @label: PWM device label |
8138d2dd TR |
356 | * |
357 | * This function is deprecated, use pwm_get() instead. | |
04883802 TR |
358 | * |
359 | * Returns: A pointer to a PWM device or an ERR_PTR()-encoded error code on | |
360 | * failure. | |
0c2498f1 | 361 | */ |
f051c466 | 362 | struct pwm_device *pwm_request(int pwm, const char *label) |
0c2498f1 | 363 | { |
f051c466 TR |
364 | struct pwm_device *dev; |
365 | int err; | |
366 | ||
367 | if (pwm < 0 || pwm >= MAX_PWMS) | |
368 | return ERR_PTR(-EINVAL); | |
0c2498f1 SH |
369 | |
370 | mutex_lock(&pwm_lock); | |
371 | ||
f051c466 TR |
372 | dev = pwm_to_device(pwm); |
373 | if (!dev) { | |
374 | dev = ERR_PTR(-EPROBE_DEFER); | |
0c2498f1 SH |
375 | goto out; |
376 | } | |
377 | ||
f051c466 TR |
378 | err = pwm_device_request(dev, label); |
379 | if (err < 0) | |
380 | dev = ERR_PTR(err); | |
0c2498f1 | 381 | |
f051c466 TR |
382 | out: |
383 | mutex_unlock(&pwm_lock); | |
0c2498f1 | 384 | |
f051c466 TR |
385 | return dev; |
386 | } | |
387 | EXPORT_SYMBOL_GPL(pwm_request); | |
0c2498f1 | 388 | |
f051c466 TR |
389 | /** |
390 | * pwm_request_from_chip() - request a PWM device relative to a PWM chip | |
391 | * @chip: PWM chip | |
392 | * @index: per-chip index of the PWM to request | |
393 | * @label: a literal description string of this PWM | |
394 | * | |
04883802 TR |
395 | * Returns: A pointer to the PWM device at the given index of the given PWM |
396 | * chip. A negative error code is returned if the index is not valid for the | |
397 | * specified PWM chip or if the PWM device cannot be requested. | |
f051c466 TR |
398 | */ |
399 | struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip, | |
400 | unsigned int index, | |
401 | const char *label) | |
402 | { | |
403 | struct pwm_device *pwm; | |
404 | int err; | |
0c2498f1 | 405 | |
f051c466 TR |
406 | if (!chip || index >= chip->npwm) |
407 | return ERR_PTR(-EINVAL); | |
0c2498f1 | 408 | |
f051c466 TR |
409 | mutex_lock(&pwm_lock); |
410 | pwm = &chip->pwms[index]; | |
0c2498f1 | 411 | |
f051c466 TR |
412 | err = pwm_device_request(pwm, label); |
413 | if (err < 0) | |
414 | pwm = ERR_PTR(err); | |
415 | ||
416 | mutex_unlock(&pwm_lock); | |
0c2498f1 SH |
417 | return pwm; |
418 | } | |
f051c466 | 419 | EXPORT_SYMBOL_GPL(pwm_request_from_chip); |
0c2498f1 SH |
420 | |
421 | /** | |
422 | * pwm_free() - free a PWM device | |
423 | * @pwm: PWM device | |
8138d2dd TR |
424 | * |
425 | * This function is deprecated, use pwm_put() instead. | |
0c2498f1 SH |
426 | */ |
427 | void pwm_free(struct pwm_device *pwm) | |
428 | { | |
8138d2dd | 429 | pwm_put(pwm); |
0c2498f1 SH |
430 | } |
431 | EXPORT_SYMBOL_GPL(pwm_free); | |
432 | ||
433 | /** | |
434 | * pwm_config() - change a PWM device configuration | |
435 | * @pwm: PWM device | |
436 | * @duty_ns: "on" time (in nanoseconds) | |
437 | * @period_ns: duration (in nanoseconds) of one cycle | |
04883802 TR |
438 | * |
439 | * Returns: 0 on success or a negative error code on failure. | |
0c2498f1 SH |
440 | */ |
441 | int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns) | |
442 | { | |
76abbdde HS |
443 | int err; |
444 | ||
c2d476a9 | 445 | if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns) |
f051c466 TR |
446 | return -EINVAL; |
447 | ||
76abbdde HS |
448 | err = pwm->chip->ops->config(pwm->chip, pwm, duty_ns, period_ns); |
449 | if (err) | |
450 | return err; | |
451 | ||
43a276b0 BB |
452 | pwm->state.duty_cycle = duty_ns; |
453 | pwm->state.period = period_ns; | |
76abbdde HS |
454 | |
455 | return 0; | |
0c2498f1 SH |
456 | } |
457 | EXPORT_SYMBOL_GPL(pwm_config); | |
458 | ||
0aa0869c PA |
459 | /** |
460 | * pwm_set_polarity() - configure the polarity of a PWM signal | |
461 | * @pwm: PWM device | |
462 | * @polarity: new polarity of the PWM signal | |
463 | * | |
04883802 TR |
464 | * Note that the polarity cannot be configured while the PWM device is |
465 | * enabled. | |
466 | * | |
467 | * Returns: 0 on success or a negative error code on failure. | |
0aa0869c PA |
468 | */ |
469 | int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity) | |
470 | { | |
76abbdde HS |
471 | int err; |
472 | ||
0aa0869c PA |
473 | if (!pwm || !pwm->chip->ops) |
474 | return -EINVAL; | |
475 | ||
476 | if (!pwm->chip->ops->set_polarity) | |
477 | return -ENOSYS; | |
478 | ||
459a25af BB |
479 | if (pwm_is_enabled(pwm)) |
480 | return -EBUSY; | |
0aa0869c | 481 | |
76abbdde HS |
482 | err = pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity); |
483 | if (err) | |
459a25af | 484 | return err; |
76abbdde | 485 | |
43a276b0 | 486 | pwm->state.polarity = polarity; |
76abbdde | 487 | |
459a25af | 488 | return 0; |
0aa0869c PA |
489 | } |
490 | EXPORT_SYMBOL_GPL(pwm_set_polarity); | |
491 | ||
0c2498f1 SH |
492 | /** |
493 | * pwm_enable() - start a PWM output toggling | |
494 | * @pwm: PWM device | |
04883802 TR |
495 | * |
496 | * Returns: 0 on success or a negative error code on failure. | |
0c2498f1 SH |
497 | */ |
498 | int pwm_enable(struct pwm_device *pwm) | |
499 | { | |
d1cd2142 JR |
500 | int err = 0; |
501 | ||
502 | if (!pwm) | |
503 | return -EINVAL; | |
504 | ||
09a7e4a3 | 505 | if (!pwm_is_enabled(pwm)) { |
d1cd2142 | 506 | err = pwm->chip->ops->enable(pwm->chip, pwm); |
09a7e4a3 BB |
507 | if (!err) |
508 | pwm->state.enabled = true; | |
d1cd2142 JR |
509 | } |
510 | ||
d1cd2142 | 511 | return err; |
0c2498f1 SH |
512 | } |
513 | EXPORT_SYMBOL_GPL(pwm_enable); | |
514 | ||
515 | /** | |
516 | * pwm_disable() - stop a PWM output toggling | |
517 | * @pwm: PWM device | |
518 | */ | |
519 | void pwm_disable(struct pwm_device *pwm) | |
520 | { | |
09a7e4a3 BB |
521 | if (!pwm) |
522 | return; | |
523 | ||
524 | if (pwm_is_enabled(pwm)) { | |
f051c466 | 525 | pwm->chip->ops->disable(pwm->chip, pwm); |
09a7e4a3 BB |
526 | pwm->state.enabled = false; |
527 | } | |
0c2498f1 SH |
528 | } |
529 | EXPORT_SYMBOL_GPL(pwm_disable); | |
62099abf | 530 | |
7299ab70 TR |
531 | static struct pwm_chip *of_node_to_pwmchip(struct device_node *np) |
532 | { | |
533 | struct pwm_chip *chip; | |
534 | ||
535 | mutex_lock(&pwm_lock); | |
536 | ||
537 | list_for_each_entry(chip, &pwm_chips, list) | |
538 | if (chip->dev && chip->dev->of_node == np) { | |
539 | mutex_unlock(&pwm_lock); | |
540 | return chip; | |
541 | } | |
542 | ||
543 | mutex_unlock(&pwm_lock); | |
544 | ||
545 | return ERR_PTR(-EPROBE_DEFER); | |
546 | } | |
547 | ||
548 | /** | |
8eb96127 | 549 | * of_pwm_get() - request a PWM via the PWM framework |
7299ab70 TR |
550 | * @np: device node to get the PWM from |
551 | * @con_id: consumer name | |
552 | * | |
553 | * Returns the PWM device parsed from the phandle and index specified in the | |
554 | * "pwms" property of a device tree node or a negative error-code on failure. | |
555 | * Values parsed from the device tree are stored in the returned PWM device | |
556 | * object. | |
557 | * | |
558 | * If con_id is NULL, the first PWM device listed in the "pwms" property will | |
559 | * be requested. Otherwise the "pwm-names" property is used to do a reverse | |
560 | * lookup of the PWM index. This also means that the "pwm-names" property | |
561 | * becomes mandatory for devices that look up the PWM device via the con_id | |
562 | * parameter. | |
04883802 TR |
563 | * |
564 | * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded | |
565 | * error code on failure. | |
7299ab70 | 566 | */ |
8eb96127 | 567 | struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id) |
7299ab70 TR |
568 | { |
569 | struct pwm_device *pwm = NULL; | |
570 | struct of_phandle_args args; | |
571 | struct pwm_chip *pc; | |
572 | int index = 0; | |
573 | int err; | |
574 | ||
575 | if (con_id) { | |
576 | index = of_property_match_string(np, "pwm-names", con_id); | |
577 | if (index < 0) | |
578 | return ERR_PTR(index); | |
579 | } | |
580 | ||
581 | err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index, | |
582 | &args); | |
583 | if (err) { | |
584 | pr_debug("%s(): can't parse \"pwms\" property\n", __func__); | |
585 | return ERR_PTR(err); | |
586 | } | |
587 | ||
588 | pc = of_node_to_pwmchip(args.np); | |
589 | if (IS_ERR(pc)) { | |
590 | pr_debug("%s(): PWM chip not found\n", __func__); | |
591 | pwm = ERR_CAST(pc); | |
592 | goto put; | |
593 | } | |
594 | ||
595 | if (args.args_count != pc->of_pwm_n_cells) { | |
596 | pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name, | |
597 | args.np->full_name); | |
598 | pwm = ERR_PTR(-EINVAL); | |
599 | goto put; | |
600 | } | |
601 | ||
602 | pwm = pc->of_xlate(pc, &args); | |
603 | if (IS_ERR(pwm)) | |
604 | goto put; | |
605 | ||
606 | /* | |
607 | * If a consumer name was not given, try to look it up from the | |
608 | * "pwm-names" property if it exists. Otherwise use the name of | |
609 | * the user device node. | |
610 | */ | |
611 | if (!con_id) { | |
612 | err = of_property_read_string_index(np, "pwm-names", index, | |
613 | &con_id); | |
614 | if (err < 0) | |
615 | con_id = np->name; | |
616 | } | |
617 | ||
618 | pwm->label = con_id; | |
619 | ||
620 | put: | |
621 | of_node_put(args.np); | |
622 | ||
623 | return pwm; | |
624 | } | |
8eb96127 | 625 | EXPORT_SYMBOL_GPL(of_pwm_get); |
7299ab70 | 626 | |
8138d2dd TR |
627 | /** |
628 | * pwm_add_table() - register PWM device consumers | |
629 | * @table: array of consumers to register | |
630 | * @num: number of consumers in table | |
631 | */ | |
c264f111 | 632 | void pwm_add_table(struct pwm_lookup *table, size_t num) |
8138d2dd TR |
633 | { |
634 | mutex_lock(&pwm_lookup_lock); | |
635 | ||
636 | while (num--) { | |
637 | list_add_tail(&table->list, &pwm_lookup_list); | |
638 | table++; | |
639 | } | |
640 | ||
641 | mutex_unlock(&pwm_lookup_lock); | |
642 | } | |
643 | ||
efb0de55 SK |
644 | /** |
645 | * pwm_remove_table() - unregister PWM device consumers | |
646 | * @table: array of consumers to unregister | |
647 | * @num: number of consumers in table | |
648 | */ | |
649 | void pwm_remove_table(struct pwm_lookup *table, size_t num) | |
650 | { | |
651 | mutex_lock(&pwm_lookup_lock); | |
652 | ||
653 | while (num--) { | |
654 | list_del(&table->list); | |
655 | table++; | |
656 | } | |
657 | ||
658 | mutex_unlock(&pwm_lookup_lock); | |
659 | } | |
660 | ||
8138d2dd TR |
661 | /** |
662 | * pwm_get() - look up and request a PWM device | |
663 | * @dev: device for PWM consumer | |
664 | * @con_id: consumer name | |
665 | * | |
7299ab70 TR |
666 | * Lookup is first attempted using DT. If the device was not instantiated from |
667 | * a device tree, a PWM chip and a relative index is looked up via a table | |
668 | * supplied by board setup code (see pwm_add_table()). | |
8138d2dd TR |
669 | * |
670 | * Once a PWM chip has been found the specified PWM device will be requested | |
671 | * and is ready to be used. | |
04883802 TR |
672 | * |
673 | * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded | |
674 | * error code on failure. | |
8138d2dd TR |
675 | */ |
676 | struct pwm_device *pwm_get(struct device *dev, const char *con_id) | |
677 | { | |
678 | struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER); | |
e50d3523 | 679 | const char *dev_id = dev ? dev_name(dev) : NULL; |
8138d2dd TR |
680 | struct pwm_chip *chip = NULL; |
681 | unsigned int best = 0; | |
70145f87 | 682 | struct pwm_lookup *p, *chosen = NULL; |
8138d2dd TR |
683 | unsigned int match; |
684 | ||
7299ab70 TR |
685 | /* look up via DT first */ |
686 | if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node) | |
8eb96127 | 687 | return of_pwm_get(dev->of_node, con_id); |
7299ab70 | 688 | |
8138d2dd TR |
689 | /* |
690 | * We look up the provider in the static table typically provided by | |
691 | * board setup code. We first try to lookup the consumer device by | |
692 | * name. If the consumer device was passed in as NULL or if no match | |
693 | * was found, we try to find the consumer by directly looking it up | |
694 | * by name. | |
695 | * | |
696 | * If a match is found, the provider PWM chip is looked up by name | |
697 | * and a PWM device is requested using the PWM device per-chip index. | |
698 | * | |
699 | * The lookup algorithm was shamelessly taken from the clock | |
700 | * framework: | |
701 | * | |
702 | * We do slightly fuzzy matching here: | |
703 | * An entry with a NULL ID is assumed to be a wildcard. | |
704 | * If an entry has a device ID, it must match | |
705 | * If an entry has a connection ID, it must match | |
706 | * Then we take the most specific entry - with the following order | |
707 | * of precedence: dev+con > dev only > con only. | |
708 | */ | |
709 | mutex_lock(&pwm_lookup_lock); | |
710 | ||
711 | list_for_each_entry(p, &pwm_lookup_list, list) { | |
712 | match = 0; | |
713 | ||
714 | if (p->dev_id) { | |
715 | if (!dev_id || strcmp(p->dev_id, dev_id)) | |
716 | continue; | |
717 | ||
718 | match += 2; | |
719 | } | |
720 | ||
721 | if (p->con_id) { | |
722 | if (!con_id || strcmp(p->con_id, con_id)) | |
723 | continue; | |
724 | ||
725 | match += 1; | |
726 | } | |
727 | ||
728 | if (match > best) { | |
70145f87 | 729 | chosen = p; |
8138d2dd TR |
730 | |
731 | if (match != 3) | |
732 | best = match; | |
733 | else | |
734 | break; | |
735 | } | |
736 | } | |
737 | ||
655a0355 TR |
738 | if (!chosen) { |
739 | pwm = ERR_PTR(-ENODEV); | |
70145f87 | 740 | goto out; |
655a0355 | 741 | } |
3796ce1d | 742 | |
70145f87 GU |
743 | chip = pwmchip_find_by_name(chosen->provider); |
744 | if (!chip) | |
745 | goto out; | |
3796ce1d | 746 | |
70145f87 GU |
747 | pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id); |
748 | if (IS_ERR(pwm)) | |
749 | goto out; | |
8138d2dd | 750 | |
fbd45a12 BB |
751 | pwm->args.period = chosen->period; |
752 | pwm->args.polarity = chosen->polarity; | |
753 | ||
70145f87 GU |
754 | out: |
755 | mutex_unlock(&pwm_lookup_lock); | |
8138d2dd TR |
756 | return pwm; |
757 | } | |
758 | EXPORT_SYMBOL_GPL(pwm_get); | |
759 | ||
760 | /** | |
761 | * pwm_put() - release a PWM device | |
762 | * @pwm: PWM device | |
763 | */ | |
764 | void pwm_put(struct pwm_device *pwm) | |
765 | { | |
766 | if (!pwm) | |
767 | return; | |
768 | ||
769 | mutex_lock(&pwm_lock); | |
770 | ||
771 | if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) { | |
e50d3523 | 772 | pr_warn("PWM device already freed\n"); |
8138d2dd TR |
773 | goto out; |
774 | } | |
775 | ||
776 | if (pwm->chip->ops->free) | |
777 | pwm->chip->ops->free(pwm->chip, pwm); | |
778 | ||
779 | pwm->label = NULL; | |
780 | ||
781 | module_put(pwm->chip->ops->owner); | |
782 | out: | |
783 | mutex_unlock(&pwm_lock); | |
784 | } | |
785 | EXPORT_SYMBOL_GPL(pwm_put); | |
786 | ||
6354316d AC |
787 | static void devm_pwm_release(struct device *dev, void *res) |
788 | { | |
789 | pwm_put(*(struct pwm_device **)res); | |
790 | } | |
791 | ||
792 | /** | |
793 | * devm_pwm_get() - resource managed pwm_get() | |
794 | * @dev: device for PWM consumer | |
795 | * @con_id: consumer name | |
796 | * | |
797 | * This function performs like pwm_get() but the acquired PWM device will | |
798 | * automatically be released on driver detach. | |
04883802 TR |
799 | * |
800 | * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded | |
801 | * error code on failure. | |
6354316d AC |
802 | */ |
803 | struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id) | |
804 | { | |
805 | struct pwm_device **ptr, *pwm; | |
806 | ||
77f0b9d2 | 807 | ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL); |
6354316d AC |
808 | if (!ptr) |
809 | return ERR_PTR(-ENOMEM); | |
810 | ||
811 | pwm = pwm_get(dev, con_id); | |
812 | if (!IS_ERR(pwm)) { | |
813 | *ptr = pwm; | |
814 | devres_add(dev, ptr); | |
815 | } else { | |
816 | devres_free(ptr); | |
817 | } | |
818 | ||
819 | return pwm; | |
820 | } | |
821 | EXPORT_SYMBOL_GPL(devm_pwm_get); | |
822 | ||
261a5edd PU |
823 | /** |
824 | * devm_of_pwm_get() - resource managed of_pwm_get() | |
825 | * @dev: device for PWM consumer | |
826 | * @np: device node to get the PWM from | |
827 | * @con_id: consumer name | |
828 | * | |
829 | * This function performs like of_pwm_get() but the acquired PWM device will | |
830 | * automatically be released on driver detach. | |
04883802 TR |
831 | * |
832 | * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded | |
833 | * error code on failure. | |
261a5edd PU |
834 | */ |
835 | struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np, | |
836 | const char *con_id) | |
837 | { | |
838 | struct pwm_device **ptr, *pwm; | |
839 | ||
77f0b9d2 | 840 | ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL); |
261a5edd PU |
841 | if (!ptr) |
842 | return ERR_PTR(-ENOMEM); | |
843 | ||
844 | pwm = of_pwm_get(np, con_id); | |
845 | if (!IS_ERR(pwm)) { | |
846 | *ptr = pwm; | |
847 | devres_add(dev, ptr); | |
848 | } else { | |
849 | devres_free(ptr); | |
850 | } | |
851 | ||
852 | return pwm; | |
853 | } | |
854 | EXPORT_SYMBOL_GPL(devm_of_pwm_get); | |
855 | ||
6354316d AC |
856 | static int devm_pwm_match(struct device *dev, void *res, void *data) |
857 | { | |
858 | struct pwm_device **p = res; | |
859 | ||
860 | if (WARN_ON(!p || !*p)) | |
861 | return 0; | |
862 | ||
863 | return *p == data; | |
864 | } | |
865 | ||
866 | /** | |
867 | * devm_pwm_put() - resource managed pwm_put() | |
868 | * @dev: device for PWM consumer | |
869 | * @pwm: PWM device | |
870 | * | |
871 | * Release a PWM previously allocated using devm_pwm_get(). Calling this | |
872 | * function is usually not needed because devm-allocated resources are | |
873 | * automatically released on driver detach. | |
874 | */ | |
875 | void devm_pwm_put(struct device *dev, struct pwm_device *pwm) | |
876 | { | |
877 | WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm)); | |
878 | } | |
879 | EXPORT_SYMBOL_GPL(devm_pwm_put); | |
880 | ||
6e69ab13 FV |
881 | /** |
882 | * pwm_can_sleep() - report whether PWM access will sleep | |
883 | * @pwm: PWM device | |
884 | * | |
04883802 | 885 | * Returns: True if accessing the PWM can sleep, false otherwise. |
6e69ab13 FV |
886 | */ |
887 | bool pwm_can_sleep(struct pwm_device *pwm) | |
888 | { | |
ff01c944 | 889 | return true; |
6e69ab13 FV |
890 | } |
891 | EXPORT_SYMBOL_GPL(pwm_can_sleep); | |
892 | ||
62099abf TR |
893 | #ifdef CONFIG_DEBUG_FS |
894 | static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s) | |
895 | { | |
896 | unsigned int i; | |
897 | ||
898 | for (i = 0; i < chip->npwm; i++) { | |
899 | struct pwm_device *pwm = &chip->pwms[i]; | |
900 | ||
901 | seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label); | |
902 | ||
903 | if (test_bit(PWMF_REQUESTED, &pwm->flags)) | |
adcba1e3 | 904 | seq_puts(s, " requested"); |
62099abf | 905 | |
5c31252c | 906 | if (pwm_is_enabled(pwm)) |
adcba1e3 | 907 | seq_puts(s, " enabled"); |
62099abf | 908 | |
adcba1e3 | 909 | seq_puts(s, "\n"); |
62099abf TR |
910 | } |
911 | } | |
912 | ||
913 | static void *pwm_seq_start(struct seq_file *s, loff_t *pos) | |
914 | { | |
915 | mutex_lock(&pwm_lock); | |
916 | s->private = ""; | |
917 | ||
918 | return seq_list_start(&pwm_chips, *pos); | |
919 | } | |
920 | ||
921 | static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos) | |
922 | { | |
923 | s->private = "\n"; | |
924 | ||
925 | return seq_list_next(v, &pwm_chips, pos); | |
926 | } | |
927 | ||
928 | static void pwm_seq_stop(struct seq_file *s, void *v) | |
929 | { | |
930 | mutex_unlock(&pwm_lock); | |
931 | } | |
932 | ||
933 | static int pwm_seq_show(struct seq_file *s, void *v) | |
934 | { | |
935 | struct pwm_chip *chip = list_entry(v, struct pwm_chip, list); | |
936 | ||
937 | seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private, | |
938 | chip->dev->bus ? chip->dev->bus->name : "no-bus", | |
939 | dev_name(chip->dev), chip->npwm, | |
940 | (chip->npwm != 1) ? "s" : ""); | |
941 | ||
942 | if (chip->ops->dbg_show) | |
943 | chip->ops->dbg_show(chip, s); | |
944 | else | |
945 | pwm_dbg_show(chip, s); | |
946 | ||
947 | return 0; | |
948 | } | |
949 | ||
950 | static const struct seq_operations pwm_seq_ops = { | |
951 | .start = pwm_seq_start, | |
952 | .next = pwm_seq_next, | |
953 | .stop = pwm_seq_stop, | |
954 | .show = pwm_seq_show, | |
955 | }; | |
956 | ||
957 | static int pwm_seq_open(struct inode *inode, struct file *file) | |
958 | { | |
959 | return seq_open(file, &pwm_seq_ops); | |
960 | } | |
961 | ||
962 | static const struct file_operations pwm_debugfs_ops = { | |
963 | .owner = THIS_MODULE, | |
964 | .open = pwm_seq_open, | |
965 | .read = seq_read, | |
966 | .llseek = seq_lseek, | |
967 | .release = seq_release, | |
968 | }; | |
969 | ||
970 | static int __init pwm_debugfs_init(void) | |
971 | { | |
972 | debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL, | |
973 | &pwm_debugfs_ops); | |
974 | ||
975 | return 0; | |
976 | } | |
62099abf TR |
977 | subsys_initcall(pwm_debugfs_init); |
978 | #endif /* CONFIG_DEBUG_FS */ |