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