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