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