2 * Generic pwmlib implementation
4 * Copyright (C) 2011 Sascha Hauer <s.hauer@pengutronix.de>
5 * Copyright (C) 2011-2012 Avionic Design GmbH
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)
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.
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.
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>
35 /* flags in the third cell of the DT PWM specifier */
36 #define PWM_SPEC_POLARITY (1 << 0)
38 static DEFINE_MUTEX(pwm_lookup_lock);
39 static LIST_HEAD(pwm_lookup_list);
40 static DEFINE_MUTEX(pwm_lock);
41 static LIST_HEAD(pwm_chips);
42 static DECLARE_BITMAP(allocated_pwms, MAX_PWMS);
43 static RADIX_TREE(pwm_tree, GFP_KERNEL);
45 static struct pwm_device *pwm_to_device(unsigned int pwm)
47 return radix_tree_lookup(&pwm_tree, pwm);
50 static int alloc_pwms(int pwm, unsigned int count)
52 unsigned int from = 0;
61 start = bitmap_find_next_zero_area(allocated_pwms, MAX_PWMS, from,
64 if (pwm >= 0 && start != pwm)
67 if (start + count > MAX_PWMS)
73 static void free_pwms(struct pwm_chip *chip)
77 for (i = 0; i < chip->npwm; i++) {
78 struct pwm_device *pwm = &chip->pwms[i];
79 radix_tree_delete(&pwm_tree, pwm->pwm);
82 bitmap_clear(allocated_pwms, chip->base, chip->npwm);
88 static struct pwm_chip *pwmchip_find_by_name(const char *name)
90 struct pwm_chip *chip;
95 mutex_lock(&pwm_lock);
97 list_for_each_entry(chip, &pwm_chips, list) {
98 const char *chip_name = dev_name(chip->dev);
100 if (chip_name && strcmp(chip_name, name) == 0) {
101 mutex_unlock(&pwm_lock);
106 mutex_unlock(&pwm_lock);
111 static int pwm_device_request(struct pwm_device *pwm, const char *label)
115 if (test_bit(PWMF_REQUESTED, &pwm->flags))
118 if (!try_module_get(pwm->chip->ops->owner))
121 if (pwm->chip->ops->request) {
122 err = pwm->chip->ops->request(pwm->chip, pwm);
124 module_put(pwm->chip->ops->owner);
129 set_bit(PWMF_REQUESTED, &pwm->flags);
136 of_pwm_xlate_with_flags(struct pwm_chip *pc, const struct of_phandle_args *args)
138 struct pwm_device *pwm;
140 if (pc->of_pwm_n_cells < 3)
141 return ERR_PTR(-EINVAL);
143 if (args->args[0] >= pc->npwm)
144 return ERR_PTR(-EINVAL);
146 pwm = pwm_request_from_chip(pc, args->args[0], NULL);
150 pwm_set_period(pwm, args->args[1]);
152 if (args->args[2] & PWM_SPEC_POLARITY)
153 pwm_set_polarity(pwm, PWM_POLARITY_INVERSED);
155 pwm_set_polarity(pwm, PWM_POLARITY_NORMAL);
159 EXPORT_SYMBOL_GPL(of_pwm_xlate_with_flags);
161 static struct pwm_device *
162 of_pwm_simple_xlate(struct pwm_chip *pc, const struct of_phandle_args *args)
164 struct pwm_device *pwm;
166 if (pc->of_pwm_n_cells < 2)
167 return ERR_PTR(-EINVAL);
169 if (args->args[0] >= pc->npwm)
170 return ERR_PTR(-EINVAL);
172 pwm = pwm_request_from_chip(pc, args->args[0], NULL);
176 pwm_set_period(pwm, args->args[1]);
181 static void of_pwmchip_add(struct pwm_chip *chip)
183 if (!chip->dev || !chip->dev->of_node)
186 if (!chip->of_xlate) {
187 chip->of_xlate = of_pwm_simple_xlate;
188 chip->of_pwm_n_cells = 2;
191 of_node_get(chip->dev->of_node);
194 static void of_pwmchip_remove(struct pwm_chip *chip)
196 if (chip->dev && chip->dev->of_node)
197 of_node_put(chip->dev->of_node);
201 * pwm_set_chip_data() - set private chip data for a PWM
203 * @data: pointer to chip-specific data
205 int pwm_set_chip_data(struct pwm_device *pwm, void *data)
210 pwm->chip_data = data;
214 EXPORT_SYMBOL_GPL(pwm_set_chip_data);
217 * pwm_get_chip_data() - get private chip data for a PWM
220 void *pwm_get_chip_data(struct pwm_device *pwm)
222 return pwm ? pwm->chip_data : NULL;
224 EXPORT_SYMBOL_GPL(pwm_get_chip_data);
227 * pwmchip_add() - register a new PWM chip
228 * @chip: the PWM chip to add
230 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
233 int pwmchip_add(struct pwm_chip *chip)
235 struct pwm_device *pwm;
239 if (!chip || !chip->dev || !chip->ops || !chip->ops->config ||
240 !chip->ops->enable || !chip->ops->disable)
243 mutex_lock(&pwm_lock);
245 ret = alloc_pwms(chip->base, chip->npwm);
249 chip->pwms = kzalloc(chip->npwm * sizeof(*pwm), GFP_KERNEL);
257 for (i = 0; i < chip->npwm; i++) {
258 pwm = &chip->pwms[i];
261 pwm->pwm = chip->base + i;
264 radix_tree_insert(&pwm_tree, pwm->pwm, pwm);
267 bitmap_set(allocated_pwms, chip->base, chip->npwm);
269 INIT_LIST_HEAD(&chip->list);
270 list_add(&chip->list, &pwm_chips);
274 if (IS_ENABLED(CONFIG_OF))
275 of_pwmchip_add(chip);
278 mutex_unlock(&pwm_lock);
281 EXPORT_SYMBOL_GPL(pwmchip_add);
284 * pwmchip_remove() - remove a PWM chip
285 * @chip: the PWM chip to remove
287 * Removes a PWM chip. This function may return busy if the PWM chip provides
288 * a PWM device that is still requested.
290 int pwmchip_remove(struct pwm_chip *chip)
295 mutex_lock(&pwm_lock);
297 for (i = 0; i < chip->npwm; i++) {
298 struct pwm_device *pwm = &chip->pwms[i];
300 if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
306 list_del_init(&chip->list);
308 if (IS_ENABLED(CONFIG_OF))
309 of_pwmchip_remove(chip);
314 mutex_unlock(&pwm_lock);
317 EXPORT_SYMBOL_GPL(pwmchip_remove);
320 * pwm_request() - request a PWM device
321 * @pwm_id: global PWM device index
322 * @label: PWM device label
324 * This function is deprecated, use pwm_get() instead.
326 struct pwm_device *pwm_request(int pwm, const char *label)
328 struct pwm_device *dev;
331 if (pwm < 0 || pwm >= MAX_PWMS)
332 return ERR_PTR(-EINVAL);
334 mutex_lock(&pwm_lock);
336 dev = pwm_to_device(pwm);
338 dev = ERR_PTR(-EPROBE_DEFER);
342 err = pwm_device_request(dev, label);
347 mutex_unlock(&pwm_lock);
351 EXPORT_SYMBOL_GPL(pwm_request);
354 * pwm_request_from_chip() - request a PWM device relative to a PWM chip
356 * @index: per-chip index of the PWM to request
357 * @label: a literal description string of this PWM
359 * Returns the PWM at the given index of the given PWM chip. A negative error
360 * code is returned if the index is not valid for the specified PWM chip or
361 * if the PWM device cannot be requested.
363 struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
367 struct pwm_device *pwm;
370 if (!chip || index >= chip->npwm)
371 return ERR_PTR(-EINVAL);
373 mutex_lock(&pwm_lock);
374 pwm = &chip->pwms[index];
376 err = pwm_device_request(pwm, label);
380 mutex_unlock(&pwm_lock);
383 EXPORT_SYMBOL_GPL(pwm_request_from_chip);
386 * pwm_free() - free a PWM device
389 * This function is deprecated, use pwm_put() instead.
391 void pwm_free(struct pwm_device *pwm)
395 EXPORT_SYMBOL_GPL(pwm_free);
398 * pwm_config() - change a PWM device configuration
400 * @duty_ns: "on" time (in nanoseconds)
401 * @period_ns: duration (in nanoseconds) of one cycle
403 int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
405 if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns)
408 return pwm->chip->ops->config(pwm->chip, pwm, duty_ns, period_ns);
410 EXPORT_SYMBOL_GPL(pwm_config);
413 * pwm_set_polarity() - configure the polarity of a PWM signal
415 * @polarity: new polarity of the PWM signal
417 * Note that the polarity cannot be configured while the PWM device is enabled
419 int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity)
421 if (!pwm || !pwm->chip->ops)
424 if (!pwm->chip->ops->set_polarity)
427 if (test_bit(PWMF_ENABLED, &pwm->flags))
430 return pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity);
432 EXPORT_SYMBOL_GPL(pwm_set_polarity);
435 * pwm_enable() - start a PWM output toggling
438 int pwm_enable(struct pwm_device *pwm)
440 if (pwm && !test_and_set_bit(PWMF_ENABLED, &pwm->flags))
441 return pwm->chip->ops->enable(pwm->chip, pwm);
443 return pwm ? 0 : -EINVAL;
445 EXPORT_SYMBOL_GPL(pwm_enable);
448 * pwm_disable() - stop a PWM output toggling
451 void pwm_disable(struct pwm_device *pwm)
453 if (pwm && test_and_clear_bit(PWMF_ENABLED, &pwm->flags))
454 pwm->chip->ops->disable(pwm->chip, pwm);
456 EXPORT_SYMBOL_GPL(pwm_disable);
458 static struct pwm_chip *of_node_to_pwmchip(struct device_node *np)
460 struct pwm_chip *chip;
462 mutex_lock(&pwm_lock);
464 list_for_each_entry(chip, &pwm_chips, list)
465 if (chip->dev && chip->dev->of_node == np) {
466 mutex_unlock(&pwm_lock);
470 mutex_unlock(&pwm_lock);
472 return ERR_PTR(-EPROBE_DEFER);
476 * of_pwm_get() - request a PWM via the PWM framework
477 * @np: device node to get the PWM from
478 * @con_id: consumer name
480 * Returns the PWM device parsed from the phandle and index specified in the
481 * "pwms" property of a device tree node or a negative error-code on failure.
482 * Values parsed from the device tree are stored in the returned PWM device
485 * If con_id is NULL, the first PWM device listed in the "pwms" property will
486 * be requested. Otherwise the "pwm-names" property is used to do a reverse
487 * lookup of the PWM index. This also means that the "pwm-names" property
488 * becomes mandatory for devices that look up the PWM device via the con_id
491 struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
493 struct pwm_device *pwm = NULL;
494 struct of_phandle_args args;
500 index = of_property_match_string(np, "pwm-names", con_id);
502 return ERR_PTR(index);
505 err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index,
508 pr_debug("%s(): can't parse \"pwms\" property\n", __func__);
512 pc = of_node_to_pwmchip(args.np);
514 pr_debug("%s(): PWM chip not found\n", __func__);
519 if (args.args_count != pc->of_pwm_n_cells) {
520 pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name,
522 pwm = ERR_PTR(-EINVAL);
526 pwm = pc->of_xlate(pc, &args);
531 * If a consumer name was not given, try to look it up from the
532 * "pwm-names" property if it exists. Otherwise use the name of
533 * the user device node.
536 err = of_property_read_string_index(np, "pwm-names", index,
545 of_node_put(args.np);
549 EXPORT_SYMBOL_GPL(of_pwm_get);
552 * pwm_add_table() - register PWM device consumers
553 * @table: array of consumers to register
554 * @num: number of consumers in table
556 void __init pwm_add_table(struct pwm_lookup *table, size_t num)
558 mutex_lock(&pwm_lookup_lock);
561 list_add_tail(&table->list, &pwm_lookup_list);
565 mutex_unlock(&pwm_lookup_lock);
569 * pwm_get() - look up and request a PWM device
570 * @dev: device for PWM consumer
571 * @con_id: consumer name
573 * Lookup is first attempted using DT. If the device was not instantiated from
574 * a device tree, a PWM chip and a relative index is looked up via a table
575 * supplied by board setup code (see pwm_add_table()).
577 * Once a PWM chip has been found the specified PWM device will be requested
578 * and is ready to be used.
580 struct pwm_device *pwm_get(struct device *dev, const char *con_id)
582 struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
583 const char *dev_id = dev ? dev_name(dev) : NULL;
584 struct pwm_chip *chip = NULL;
585 unsigned int index = 0;
586 unsigned int best = 0;
587 struct pwm_lookup *p;
590 /* look up via DT first */
591 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
592 return of_pwm_get(dev->of_node, con_id);
595 * We look up the provider in the static table typically provided by
596 * board setup code. We first try to lookup the consumer device by
597 * name. If the consumer device was passed in as NULL or if no match
598 * was found, we try to find the consumer by directly looking it up
601 * If a match is found, the provider PWM chip is looked up by name
602 * and a PWM device is requested using the PWM device per-chip index.
604 * The lookup algorithm was shamelessly taken from the clock
607 * We do slightly fuzzy matching here:
608 * An entry with a NULL ID is assumed to be a wildcard.
609 * If an entry has a device ID, it must match
610 * If an entry has a connection ID, it must match
611 * Then we take the most specific entry - with the following order
612 * of precedence: dev+con > dev only > con only.
614 mutex_lock(&pwm_lookup_lock);
616 list_for_each_entry(p, &pwm_lookup_list, list) {
620 if (!dev_id || strcmp(p->dev_id, dev_id))
627 if (!con_id || strcmp(p->con_id, con_id))
634 chip = pwmchip_find_by_name(p->provider);
645 pwm = pwm_request_from_chip(chip, index, con_id ?: dev_id);
647 mutex_unlock(&pwm_lookup_lock);
651 EXPORT_SYMBOL_GPL(pwm_get);
654 * pwm_put() - release a PWM device
657 void pwm_put(struct pwm_device *pwm)
662 mutex_lock(&pwm_lock);
664 if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
665 pr_warn("PWM device already freed\n");
669 if (pwm->chip->ops->free)
670 pwm->chip->ops->free(pwm->chip, pwm);
674 module_put(pwm->chip->ops->owner);
676 mutex_unlock(&pwm_lock);
678 EXPORT_SYMBOL_GPL(pwm_put);
680 static void devm_pwm_release(struct device *dev, void *res)
682 pwm_put(*(struct pwm_device **)res);
686 * devm_pwm_get() - resource managed pwm_get()
687 * @dev: device for PWM consumer
688 * @con_id: consumer name
690 * This function performs like pwm_get() but the acquired PWM device will
691 * automatically be released on driver detach.
693 struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
695 struct pwm_device **ptr, *pwm;
697 ptr = devres_alloc(devm_pwm_release, sizeof(**ptr), GFP_KERNEL);
699 return ERR_PTR(-ENOMEM);
701 pwm = pwm_get(dev, con_id);
704 devres_add(dev, ptr);
711 EXPORT_SYMBOL_GPL(devm_pwm_get);
714 * devm_of_pwm_get() - resource managed of_pwm_get()
715 * @dev: device for PWM consumer
716 * @np: device node to get the PWM from
717 * @con_id: consumer name
719 * This function performs like of_pwm_get() but the acquired PWM device will
720 * automatically be released on driver detach.
722 struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
725 struct pwm_device **ptr, *pwm;
727 ptr = devres_alloc(devm_pwm_release, sizeof(**ptr), GFP_KERNEL);
729 return ERR_PTR(-ENOMEM);
731 pwm = of_pwm_get(np, con_id);
734 devres_add(dev, ptr);
741 EXPORT_SYMBOL_GPL(devm_of_pwm_get);
743 static int devm_pwm_match(struct device *dev, void *res, void *data)
745 struct pwm_device **p = res;
747 if (WARN_ON(!p || !*p))
754 * devm_pwm_put() - resource managed pwm_put()
755 * @dev: device for PWM consumer
758 * Release a PWM previously allocated using devm_pwm_get(). Calling this
759 * function is usually not needed because devm-allocated resources are
760 * automatically released on driver detach.
762 void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
764 WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm));
766 EXPORT_SYMBOL_GPL(devm_pwm_put);
769 * pwm_can_sleep() - report whether PWM access will sleep
772 * It returns true if accessing the PWM can sleep, false otherwise.
774 bool pwm_can_sleep(struct pwm_device *pwm)
776 return pwm->chip->can_sleep;
778 EXPORT_SYMBOL_GPL(pwm_can_sleep);
780 #ifdef CONFIG_DEBUG_FS
781 static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s)
785 for (i = 0; i < chip->npwm; i++) {
786 struct pwm_device *pwm = &chip->pwms[i];
788 seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label);
790 if (test_bit(PWMF_REQUESTED, &pwm->flags))
791 seq_printf(s, " requested");
793 if (test_bit(PWMF_ENABLED, &pwm->flags))
794 seq_printf(s, " enabled");
800 static void *pwm_seq_start(struct seq_file *s, loff_t *pos)
802 mutex_lock(&pwm_lock);
805 return seq_list_start(&pwm_chips, *pos);
808 static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos)
812 return seq_list_next(v, &pwm_chips, pos);
815 static void pwm_seq_stop(struct seq_file *s, void *v)
817 mutex_unlock(&pwm_lock);
820 static int pwm_seq_show(struct seq_file *s, void *v)
822 struct pwm_chip *chip = list_entry(v, struct pwm_chip, list);
824 seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private,
825 chip->dev->bus ? chip->dev->bus->name : "no-bus",
826 dev_name(chip->dev), chip->npwm,
827 (chip->npwm != 1) ? "s" : "");
829 if (chip->ops->dbg_show)
830 chip->ops->dbg_show(chip, s);
832 pwm_dbg_show(chip, s);
837 static const struct seq_operations pwm_seq_ops = {
838 .start = pwm_seq_start,
839 .next = pwm_seq_next,
840 .stop = pwm_seq_stop,
841 .show = pwm_seq_show,
844 static int pwm_seq_open(struct inode *inode, struct file *file)
846 return seq_open(file, &pwm_seq_ops);
849 static const struct file_operations pwm_debugfs_ops = {
850 .owner = THIS_MODULE,
851 .open = pwm_seq_open,
854 .release = seq_release,
857 static int __init pwm_debugfs_init(void)
859 debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL,
865 subsys_initcall(pwm_debugfs_init);
866 #endif /* CONFIG_DEBUG_FS */