blob: a909c64ee86352c1d42e2e27c200a85720eb943c [file] [log] [blame]
Sascha Hauer0c2498f2011-01-28 09:40:40 +01001/*
2 * Generic pwmlib implementation
3 *
4 * Copyright (C) 2011 Sascha Hauer <s.hauer@pengutronix.de>
Thierry Redingf051c462011-12-14 11:12:23 +01005 * Copyright (C) 2011-2012 Avionic Design GmbH
Sascha Hauer0c2498f2011-01-28 09:40:40 +01006 *
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>
Thierry Redingf051c462011-12-14 11:12:23 +010024#include <linux/radix-tree.h>
Sascha Hauer0c2498f2011-01-28 09:40:40 +010025#include <linux/list.h>
26#include <linux/mutex.h>
27#include <linux/err.h>
28#include <linux/slab.h>
29#include <linux/device.h>
Thierry Reding62099ab2012-03-26 09:31:48 +020030#include <linux/debugfs.h>
31#include <linux/seq_file.h>
Sascha Hauer0c2498f2011-01-28 09:40:40 +010032
Laurent Pinchart208be762013-07-18 00:54:22 +020033#include <dt-bindings/pwm/pwm.h>
Sascha Hauer0c2498f2011-01-28 09:40:40 +010034
Laurent Pinchart208be762013-07-18 00:54:22 +020035#define MAX_PWMS 1024
Philip, Avinash83af2402012-11-21 13:10:44 +053036
Thierry Reding8138d2d2012-03-26 08:42:48 +020037static DEFINE_MUTEX(pwm_lookup_lock);
38static LIST_HEAD(pwm_lookup_list);
Sascha Hauer0c2498f2011-01-28 09:40:40 +010039static DEFINE_MUTEX(pwm_lock);
Thierry Redingf051c462011-12-14 11:12:23 +010040static LIST_HEAD(pwm_chips);
41static DECLARE_BITMAP(allocated_pwms, MAX_PWMS);
42static RADIX_TREE(pwm_tree, GFP_KERNEL);
Sascha Hauer0c2498f2011-01-28 09:40:40 +010043
Thierry Redingf051c462011-12-14 11:12:23 +010044static struct pwm_device *pwm_to_device(unsigned int pwm)
Sascha Hauer0c2498f2011-01-28 09:40:40 +010045{
Thierry Redingf051c462011-12-14 11:12:23 +010046 return radix_tree_lookup(&pwm_tree, pwm);
47}
Sascha Hauer0c2498f2011-01-28 09:40:40 +010048
Thierry Redingf051c462011-12-14 11:12:23 +010049static 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
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];
78 radix_tree_delete(&pwm_tree, pwm->pwm);
Sascha Hauer0c2498f2011-01-28 09:40:40 +010079 }
80
Thierry Redingf051c462011-12-14 11:12:23 +010081 bitmap_clear(allocated_pwms, chip->base, chip->npwm);
82
83 kfree(chip->pwms);
84 chip->pwms = NULL;
85}
86
Thierry Reding8138d2d2012-03-26 08:42:48 +020087static 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
Thierry Redingf051c462011-12-14 11:12:23 +0100110static 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
Philip, Avinash83af2402012-11-21 13:10:44 +0530134struct pwm_device *
135of_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
Boris Brezillone39c0df2016-04-14 21:17:21 +0200149 pwm->args.period = args->args[1];
Philip, Avinash83af2402012-11-21 13:10:44 +0530150
Laurent Pinchart208be762013-07-18 00:54:22 +0200151 if (args->args[2] & PWM_POLARITY_INVERTED)
Boris Brezillone39c0df2016-04-14 21:17:21 +0200152 pwm->args.polarity = PWM_POLARITY_INVERSED;
Philip, Avinash83af2402012-11-21 13:10:44 +0530153 else
Boris Brezillone39c0df2016-04-14 21:17:21 +0200154 pwm->args.polarity = PWM_POLARITY_NORMAL;
Philip, Avinash83af2402012-11-21 13:10:44 +0530155
156 return pwm;
157}
Thierry Reding417328c2012-11-28 15:12:07 +0100158EXPORT_SYMBOL_GPL(of_pwm_xlate_with_flags);
Philip, Avinash83af2402012-11-21 13:10:44 +0530159
Sachin Kamate50d3522012-08-10 16:41:13 +0530160static struct pwm_device *
161of_pwm_simple_xlate(struct pwm_chip *pc, const struct of_phandle_args *args)
Thierry Reding7299ab72011-12-14 11:10:32 +0100162{
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
Boris Brezillone39c0df2016-04-14 21:17:21 +0200175 pwm->args.period = args->args[1];
Thierry Reding7299ab72011-12-14 11:10:32 +0100176
177 return pwm;
178}
179
Sachin Kamatdfeb86e2012-08-02 12:32:42 +0530180static void of_pwmchip_add(struct pwm_chip *chip)
Thierry Reding7299ab72011-12-14 11:10:32 +0100181{
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
Sachin Kamatdfeb86e2012-08-02 12:32:42 +0530193static void of_pwmchip_remove(struct pwm_chip *chip)
Thierry Reding7299ab72011-12-14 11:10:32 +0100194{
Markus Elfring8d6cc072015-02-03 11:54:28 +0100195 if (chip->dev)
Thierry Reding7299ab72011-12-14 11:10:32 +0100196 of_node_put(chip->dev->of_node);
197}
198
Thierry Redingf051c462011-12-14 11:12:23 +0100199/**
200 * pwm_set_chip_data() - set private chip data for a PWM
201 * @pwm: PWM device
202 * @data: pointer to chip-specific data
Thierry Reding04883802015-07-27 11:58:32 +0200203 *
204 * Returns: 0 on success or a negative error code on failure.
Thierry Redingf051c462011-12-14 11:12:23 +0100205 */
206int 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}
Thierry Reding928c4472013-01-30 09:22:24 +0100215EXPORT_SYMBOL_GPL(pwm_set_chip_data);
Thierry Redingf051c462011-12-14 11:12:23 +0100216
217/**
218 * pwm_get_chip_data() - get private chip data for a PWM
219 * @pwm: PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200220 *
221 * Returns: A pointer to the chip-private data for the PWM device.
Thierry Redingf051c462011-12-14 11:12:23 +0100222 */
223void *pwm_get_chip_data(struct pwm_device *pwm)
224{
225 return pwm ? pwm->chip_data : NULL;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100226}
Thierry Reding928c4472013-01-30 09:22:24 +0100227EXPORT_SYMBOL_GPL(pwm_get_chip_data);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100228
229/**
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700230 * pwmchip_add_with_polarity() - register a new PWM chip
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100231 * @chip: the PWM chip to add
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700232 * @polarity: initial polarity of PWM channels
Thierry Redingf051c462011-12-14 11:12:23 +0100233 *
234 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700235 * will be used. The initial polarity for all channels is specified by the
236 * @polarity parameter.
Thierry Reding04883802015-07-27 11:58:32 +0200237 *
238 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100239 */
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700240int pwmchip_add_with_polarity(struct pwm_chip *chip,
241 enum pwm_polarity polarity)
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100242{
243 struct pwm_device *pwm;
Thierry Redingf051c462011-12-14 11:12:23 +0100244 unsigned int i;
245 int ret;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100246
Thierry Redingf051c462011-12-14 11:12:23 +0100247 if (!chip || !chip->dev || !chip->ops || !chip->ops->config ||
Xiubo Li533acc02014-08-18 17:08:44 +0800248 !chip->ops->enable || !chip->ops->disable || !chip->npwm)
Thierry Redingf051c462011-12-14 11:12:23 +0100249 return -EINVAL;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100250
251 mutex_lock(&pwm_lock);
252
Thierry Redingf051c462011-12-14 11:12:23 +0100253 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;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100260 goto out;
261 }
262
Thierry Redingf051c462011-12-14 11:12:23 +0100263 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;
Boris Brezillon43a276b2016-04-14 21:17:38 +0200271 pwm->state.polarity = polarity;
Thierry Redingf051c462011-12-14 11:12:23 +0100272
Boris Brezillon15fa8a432016-04-14 21:17:40 +0200273 if (chip->ops->get_state)
274 chip->ops->get_state(chip, pwm, &pwm->state);
275
Thierry Redingf051c462011-12-14 11:12:23 +0100276 radix_tree_insert(&pwm_tree, pwm->pwm, pwm);
277 }
278
279 bitmap_set(allocated_pwms, chip->base, chip->npwm);
280
281 INIT_LIST_HEAD(&chip->list);
282 list_add(&chip->list, &pwm_chips);
283
284 ret = 0;
285
Thierry Reding7299ab72011-12-14 11:10:32 +0100286 if (IS_ENABLED(CONFIG_OF))
287 of_pwmchip_add(chip);
288
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700289 pwmchip_sysfs_export(chip);
290
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100291out:
292 mutex_unlock(&pwm_lock);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100293 return ret;
294}
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700295EXPORT_SYMBOL_GPL(pwmchip_add_with_polarity);
296
297/**
298 * pwmchip_add() - register a new PWM chip
299 * @chip: the PWM chip to add
300 *
301 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
302 * will be used. The initial polarity for all channels is normal.
Thierry Reding04883802015-07-27 11:58:32 +0200303 *
304 * Returns: 0 on success or a negative error code on failure.
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700305 */
306int pwmchip_add(struct pwm_chip *chip)
307{
308 return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL);
309}
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100310EXPORT_SYMBOL_GPL(pwmchip_add);
311
312/**
313 * pwmchip_remove() - remove a PWM chip
314 * @chip: the PWM chip to remove
315 *
316 * Removes a PWM chip. This function may return busy if the PWM chip provides
317 * a PWM device that is still requested.
Thierry Reding04883802015-07-27 11:58:32 +0200318 *
319 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100320 */
321int pwmchip_remove(struct pwm_chip *chip)
322{
Thierry Redingf051c462011-12-14 11:12:23 +0100323 unsigned int i;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100324 int ret = 0;
325
326 mutex_lock(&pwm_lock);
327
Thierry Redingf051c462011-12-14 11:12:23 +0100328 for (i = 0; i < chip->npwm; i++) {
329 struct pwm_device *pwm = &chip->pwms[i];
330
331 if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
332 ret = -EBUSY;
333 goto out;
334 }
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100335 }
336
Thierry Redingf051c462011-12-14 11:12:23 +0100337 list_del_init(&chip->list);
Thierry Reding7299ab72011-12-14 11:10:32 +0100338
339 if (IS_ENABLED(CONFIG_OF))
340 of_pwmchip_remove(chip);
341
Thierry Redingf051c462011-12-14 11:12:23 +0100342 free_pwms(chip);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100343
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700344 pwmchip_sysfs_unexport(chip);
345
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100346out:
347 mutex_unlock(&pwm_lock);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100348 return ret;
349}
350EXPORT_SYMBOL_GPL(pwmchip_remove);
351
352/**
353 * pwm_request() - request a PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200354 * @pwm: global PWM device index
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100355 * @label: PWM device label
Thierry Reding8138d2d2012-03-26 08:42:48 +0200356 *
357 * This function is deprecated, use pwm_get() instead.
Thierry Reding04883802015-07-27 11:58:32 +0200358 *
359 * Returns: A pointer to a PWM device or an ERR_PTR()-encoded error code on
360 * failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100361 */
Thierry Redingf051c462011-12-14 11:12:23 +0100362struct pwm_device *pwm_request(int pwm, const char *label)
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100363{
Thierry Redingf051c462011-12-14 11:12:23 +0100364 struct pwm_device *dev;
365 int err;
366
367 if (pwm < 0 || pwm >= MAX_PWMS)
368 return ERR_PTR(-EINVAL);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100369
370 mutex_lock(&pwm_lock);
371
Thierry Redingf051c462011-12-14 11:12:23 +0100372 dev = pwm_to_device(pwm);
373 if (!dev) {
374 dev = ERR_PTR(-EPROBE_DEFER);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100375 goto out;
376 }
377
Thierry Redingf051c462011-12-14 11:12:23 +0100378 err = pwm_device_request(dev, label);
379 if (err < 0)
380 dev = ERR_PTR(err);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100381
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100382out:
383 mutex_unlock(&pwm_lock);
384
Thierry Redingf051c462011-12-14 11:12:23 +0100385 return dev;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100386}
387EXPORT_SYMBOL_GPL(pwm_request);
388
389/**
Thierry Redingf051c462011-12-14 11:12:23 +0100390 * pwm_request_from_chip() - request a PWM device relative to a PWM chip
391 * @chip: PWM chip
392 * @index: per-chip index of the PWM to request
393 * @label: a literal description string of this PWM
394 *
Thierry Reding04883802015-07-27 11:58:32 +0200395 * Returns: A pointer to the PWM device at the given index of the given PWM
396 * chip. A negative error code is returned if the index is not valid for the
397 * specified PWM chip or if the PWM device cannot be requested.
Thierry Redingf051c462011-12-14 11:12:23 +0100398 */
399struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
400 unsigned int index,
401 const char *label)
402{
403 struct pwm_device *pwm;
404 int err;
405
406 if (!chip || index >= chip->npwm)
407 return ERR_PTR(-EINVAL);
408
409 mutex_lock(&pwm_lock);
410 pwm = &chip->pwms[index];
411
412 err = pwm_device_request(pwm, label);
413 if (err < 0)
414 pwm = ERR_PTR(err);
415
416 mutex_unlock(&pwm_lock);
417 return pwm;
418}
419EXPORT_SYMBOL_GPL(pwm_request_from_chip);
420
421/**
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100422 * pwm_free() - free a PWM device
423 * @pwm: PWM device
Thierry Reding8138d2d2012-03-26 08:42:48 +0200424 *
425 * This function is deprecated, use pwm_put() instead.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100426 */
427void pwm_free(struct pwm_device *pwm)
428{
Thierry Reding8138d2d2012-03-26 08:42:48 +0200429 pwm_put(pwm);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100430}
431EXPORT_SYMBOL_GPL(pwm_free);
432
433/**
434 * pwm_config() - change a PWM device configuration
435 * @pwm: PWM device
436 * @duty_ns: "on" time (in nanoseconds)
437 * @period_ns: duration (in nanoseconds) of one cycle
Thierry Reding04883802015-07-27 11:58:32 +0200438 *
439 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100440 */
441int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
442{
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700443 int err;
444
Thierry Redingc2d476a2012-09-02 22:13:40 +0200445 if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns)
Thierry Redingf051c462011-12-14 11:12:23 +0100446 return -EINVAL;
447
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700448 err = pwm->chip->ops->config(pwm->chip, pwm, duty_ns, period_ns);
449 if (err)
450 return err;
451
Boris Brezillon43a276b2016-04-14 21:17:38 +0200452 pwm->state.duty_cycle = duty_ns;
453 pwm->state.period = period_ns;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700454
455 return 0;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100456}
457EXPORT_SYMBOL_GPL(pwm_config);
458
459/**
Philip, Avinash0aa08692012-07-24 19:35:32 +0530460 * pwm_set_polarity() - configure the polarity of a PWM signal
461 * @pwm: PWM device
462 * @polarity: new polarity of the PWM signal
463 *
Thierry Reding04883802015-07-27 11:58:32 +0200464 * Note that the polarity cannot be configured while the PWM device is
465 * enabled.
466 *
467 * Returns: 0 on success or a negative error code on failure.
Philip, Avinash0aa08692012-07-24 19:35:32 +0530468 */
469int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity)
470{
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700471 int err;
472
Philip, Avinash0aa08692012-07-24 19:35:32 +0530473 if (!pwm || !pwm->chip->ops)
474 return -EINVAL;
475
476 if (!pwm->chip->ops->set_polarity)
477 return -ENOSYS;
478
Boris BREZILLON459a25a2016-03-30 22:03:27 +0200479 if (pwm_is_enabled(pwm))
480 return -EBUSY;
Philip, Avinash0aa08692012-07-24 19:35:32 +0530481
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700482 err = pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity);
483 if (err)
Boris BREZILLON459a25a2016-03-30 22:03:27 +0200484 return err;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700485
Boris Brezillon43a276b2016-04-14 21:17:38 +0200486 pwm->state.polarity = polarity;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700487
Boris BREZILLON459a25a2016-03-30 22:03:27 +0200488 return 0;
Philip, Avinash0aa08692012-07-24 19:35:32 +0530489}
490EXPORT_SYMBOL_GPL(pwm_set_polarity);
491
492/**
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100493 * pwm_enable() - start a PWM output toggling
494 * @pwm: PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200495 *
496 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100497 */
498int pwm_enable(struct pwm_device *pwm)
499{
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700500 int err = 0;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100501
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700502 if (!pwm)
503 return -EINVAL;
504
Boris Brezillon09a7e4a2016-04-14 21:17:39 +0200505 if (!pwm_is_enabled(pwm)) {
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700506 err = pwm->chip->ops->enable(pwm->chip, pwm);
Boris Brezillon09a7e4a2016-04-14 21:17:39 +0200507 if (!err)
508 pwm->state.enabled = true;
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700509 }
510
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700511 return err;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100512}
513EXPORT_SYMBOL_GPL(pwm_enable);
514
515/**
516 * pwm_disable() - stop a PWM output toggling
517 * @pwm: PWM device
518 */
519void pwm_disable(struct pwm_device *pwm)
520{
Boris Brezillon09a7e4a2016-04-14 21:17:39 +0200521 if (!pwm)
522 return;
523
524 if (pwm_is_enabled(pwm)) {
Thierry Redingf051c462011-12-14 11:12:23 +0100525 pwm->chip->ops->disable(pwm->chip, pwm);
Boris Brezillon09a7e4a2016-04-14 21:17:39 +0200526 pwm->state.enabled = false;
527 }
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100528}
529EXPORT_SYMBOL_GPL(pwm_disable);
Thierry Reding62099ab2012-03-26 09:31:48 +0200530
Thierry Reding7299ab72011-12-14 11:10:32 +0100531static struct pwm_chip *of_node_to_pwmchip(struct device_node *np)
532{
533 struct pwm_chip *chip;
534
535 mutex_lock(&pwm_lock);
536
537 list_for_each_entry(chip, &pwm_chips, list)
538 if (chip->dev && chip->dev->of_node == np) {
539 mutex_unlock(&pwm_lock);
540 return chip;
541 }
542
543 mutex_unlock(&pwm_lock);
544
545 return ERR_PTR(-EPROBE_DEFER);
546}
547
548/**
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800549 * of_pwm_get() - request a PWM via the PWM framework
Thierry Reding7299ab72011-12-14 11:10:32 +0100550 * @np: device node to get the PWM from
551 * @con_id: consumer name
552 *
553 * Returns the PWM device parsed from the phandle and index specified in the
554 * "pwms" property of a device tree node or a negative error-code on failure.
555 * Values parsed from the device tree are stored in the returned PWM device
556 * object.
557 *
558 * If con_id is NULL, the first PWM device listed in the "pwms" property will
559 * be requested. Otherwise the "pwm-names" property is used to do a reverse
560 * lookup of the PWM index. This also means that the "pwm-names" property
561 * becomes mandatory for devices that look up the PWM device via the con_id
562 * parameter.
Thierry Reding04883802015-07-27 11:58:32 +0200563 *
564 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
565 * error code on failure.
Thierry Reding7299ab72011-12-14 11:10:32 +0100566 */
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800567struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
Thierry Reding7299ab72011-12-14 11:10:32 +0100568{
569 struct pwm_device *pwm = NULL;
570 struct of_phandle_args args;
571 struct pwm_chip *pc;
572 int index = 0;
573 int err;
574
575 if (con_id) {
576 index = of_property_match_string(np, "pwm-names", con_id);
577 if (index < 0)
578 return ERR_PTR(index);
579 }
580
581 err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index,
582 &args);
583 if (err) {
584 pr_debug("%s(): can't parse \"pwms\" property\n", __func__);
585 return ERR_PTR(err);
586 }
587
588 pc = of_node_to_pwmchip(args.np);
589 if (IS_ERR(pc)) {
590 pr_debug("%s(): PWM chip not found\n", __func__);
591 pwm = ERR_CAST(pc);
592 goto put;
593 }
594
595 if (args.args_count != pc->of_pwm_n_cells) {
596 pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name,
597 args.np->full_name);
598 pwm = ERR_PTR(-EINVAL);
599 goto put;
600 }
601
602 pwm = pc->of_xlate(pc, &args);
603 if (IS_ERR(pwm))
604 goto put;
605
606 /*
607 * If a consumer name was not given, try to look it up from the
608 * "pwm-names" property if it exists. Otherwise use the name of
609 * the user device node.
610 */
611 if (!con_id) {
612 err = of_property_read_string_index(np, "pwm-names", index,
613 &con_id);
614 if (err < 0)
615 con_id = np->name;
616 }
617
618 pwm->label = con_id;
619
620put:
621 of_node_put(args.np);
622
623 return pwm;
624}
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800625EXPORT_SYMBOL_GPL(of_pwm_get);
Thierry Reding7299ab72011-12-14 11:10:32 +0100626
Thierry Reding8138d2d2012-03-26 08:42:48 +0200627/**
628 * pwm_add_table() - register PWM device consumers
629 * @table: array of consumers to register
630 * @num: number of consumers in table
631 */
Shobhit Kumarc264f112015-03-12 22:01:31 +0530632void pwm_add_table(struct pwm_lookup *table, size_t num)
Thierry Reding8138d2d2012-03-26 08:42:48 +0200633{
634 mutex_lock(&pwm_lookup_lock);
635
636 while (num--) {
637 list_add_tail(&table->list, &pwm_lookup_list);
638 table++;
639 }
640
641 mutex_unlock(&pwm_lookup_lock);
642}
643
644/**
Shobhit Kumarefb0de52015-05-05 15:04:18 +0530645 * pwm_remove_table() - unregister PWM device consumers
646 * @table: array of consumers to unregister
647 * @num: number of consumers in table
648 */
649void pwm_remove_table(struct pwm_lookup *table, size_t num)
650{
651 mutex_lock(&pwm_lookup_lock);
652
653 while (num--) {
654 list_del(&table->list);
655 table++;
656 }
657
658 mutex_unlock(&pwm_lookup_lock);
659}
660
661/**
Thierry Reding8138d2d2012-03-26 08:42:48 +0200662 * pwm_get() - look up and request a PWM device
663 * @dev: device for PWM consumer
664 * @con_id: consumer name
665 *
Thierry Reding7299ab72011-12-14 11:10:32 +0100666 * Lookup is first attempted using DT. If the device was not instantiated from
667 * a device tree, a PWM chip and a relative index is looked up via a table
668 * supplied by board setup code (see pwm_add_table()).
Thierry Reding8138d2d2012-03-26 08:42:48 +0200669 *
670 * Once a PWM chip has been found the specified PWM device will be requested
671 * and is ready to be used.
Thierry Reding04883802015-07-27 11:58:32 +0200672 *
673 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
674 * error code on failure.
Thierry Reding8138d2d2012-03-26 08:42:48 +0200675 */
676struct pwm_device *pwm_get(struct device *dev, const char *con_id)
677{
678 struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
Sachin Kamate50d3522012-08-10 16:41:13 +0530679 const char *dev_id = dev ? dev_name(dev) : NULL;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200680 struct pwm_chip *chip = NULL;
681 unsigned int best = 0;
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200682 struct pwm_lookup *p, *chosen = NULL;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200683 unsigned int match;
684
Thierry Reding7299ab72011-12-14 11:10:32 +0100685 /* look up via DT first */
686 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800687 return of_pwm_get(dev->of_node, con_id);
Thierry Reding7299ab72011-12-14 11:10:32 +0100688
Thierry Reding8138d2d2012-03-26 08:42:48 +0200689 /*
690 * We look up the provider in the static table typically provided by
691 * board setup code. We first try to lookup the consumer device by
692 * name. If the consumer device was passed in as NULL or if no match
693 * was found, we try to find the consumer by directly looking it up
694 * by name.
695 *
696 * If a match is found, the provider PWM chip is looked up by name
697 * and a PWM device is requested using the PWM device per-chip index.
698 *
699 * The lookup algorithm was shamelessly taken from the clock
700 * framework:
701 *
702 * We do slightly fuzzy matching here:
703 * An entry with a NULL ID is assumed to be a wildcard.
704 * If an entry has a device ID, it must match
705 * If an entry has a connection ID, it must match
706 * Then we take the most specific entry - with the following order
707 * of precedence: dev+con > dev only > con only.
708 */
709 mutex_lock(&pwm_lookup_lock);
710
711 list_for_each_entry(p, &pwm_lookup_list, list) {
712 match = 0;
713
714 if (p->dev_id) {
715 if (!dev_id || strcmp(p->dev_id, dev_id))
716 continue;
717
718 match += 2;
719 }
720
721 if (p->con_id) {
722 if (!con_id || strcmp(p->con_id, con_id))
723 continue;
724
725 match += 1;
726 }
727
728 if (match > best) {
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200729 chosen = p;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200730
731 if (match != 3)
732 best = match;
733 else
734 break;
735 }
736 }
737
Thierry Reding655a0352015-10-05 14:38:32 +0200738 if (!chosen) {
739 pwm = ERR_PTR(-ENODEV);
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200740 goto out;
Thierry Reding655a0352015-10-05 14:38:32 +0200741 }
Alexandre Belloni3796ce12014-05-19 22:42:32 +0200742
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200743 chip = pwmchip_find_by_name(chosen->provider);
744 if (!chip)
745 goto out;
746
747 pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id);
Alexandre Belloni3796ce12014-05-19 22:42:32 +0200748 if (IS_ERR(pwm))
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200749 goto out;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200750
Boris Brezillonfbd45a12016-05-17 14:27:25 +0200751 pwm->args.period = chosen->period;
752 pwm->args.polarity = chosen->polarity;
753
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200754out:
755 mutex_unlock(&pwm_lookup_lock);
Thierry Reding8138d2d2012-03-26 08:42:48 +0200756 return pwm;
757}
758EXPORT_SYMBOL_GPL(pwm_get);
759
760/**
761 * pwm_put() - release a PWM device
762 * @pwm: PWM device
763 */
764void pwm_put(struct pwm_device *pwm)
765{
766 if (!pwm)
767 return;
768
769 mutex_lock(&pwm_lock);
770
771 if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
Sachin Kamate50d3522012-08-10 16:41:13 +0530772 pr_warn("PWM device already freed\n");
Thierry Reding8138d2d2012-03-26 08:42:48 +0200773 goto out;
774 }
775
776 if (pwm->chip->ops->free)
777 pwm->chip->ops->free(pwm->chip, pwm);
778
779 pwm->label = NULL;
780
781 module_put(pwm->chip->ops->owner);
782out:
783 mutex_unlock(&pwm_lock);
784}
785EXPORT_SYMBOL_GPL(pwm_put);
786
Alexandre Courbot63543162012-08-01 19:20:58 +0900787static void devm_pwm_release(struct device *dev, void *res)
788{
789 pwm_put(*(struct pwm_device **)res);
790}
791
792/**
793 * devm_pwm_get() - resource managed pwm_get()
794 * @dev: device for PWM consumer
795 * @con_id: consumer name
796 *
797 * This function performs like pwm_get() but the acquired PWM device will
798 * automatically be released on driver detach.
Thierry Reding04883802015-07-27 11:58:32 +0200799 *
800 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
801 * error code on failure.
Alexandre Courbot63543162012-08-01 19:20:58 +0900802 */
803struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
804{
805 struct pwm_device **ptr, *pwm;
806
Wolfram Sang77f0b9d2013-06-03 22:27:17 +0200807 ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
Alexandre Courbot63543162012-08-01 19:20:58 +0900808 if (!ptr)
809 return ERR_PTR(-ENOMEM);
810
811 pwm = pwm_get(dev, con_id);
812 if (!IS_ERR(pwm)) {
813 *ptr = pwm;
814 devres_add(dev, ptr);
815 } else {
816 devres_free(ptr);
817 }
818
819 return pwm;
820}
821EXPORT_SYMBOL_GPL(devm_pwm_get);
822
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800823/**
824 * devm_of_pwm_get() - resource managed of_pwm_get()
825 * @dev: device for PWM consumer
826 * @np: device node to get the PWM from
827 * @con_id: consumer name
828 *
829 * This function performs like of_pwm_get() but the acquired PWM device will
830 * automatically be released on driver detach.
Thierry Reding04883802015-07-27 11:58:32 +0200831 *
832 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
833 * error code on failure.
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800834 */
835struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
836 const char *con_id)
837{
838 struct pwm_device **ptr, *pwm;
839
Wolfram Sang77f0b9d2013-06-03 22:27:17 +0200840 ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800841 if (!ptr)
842 return ERR_PTR(-ENOMEM);
843
844 pwm = of_pwm_get(np, con_id);
845 if (!IS_ERR(pwm)) {
846 *ptr = pwm;
847 devres_add(dev, ptr);
848 } else {
849 devres_free(ptr);
850 }
851
852 return pwm;
853}
854EXPORT_SYMBOL_GPL(devm_of_pwm_get);
855
Alexandre Courbot63543162012-08-01 19:20:58 +0900856static int devm_pwm_match(struct device *dev, void *res, void *data)
857{
858 struct pwm_device **p = res;
859
860 if (WARN_ON(!p || !*p))
861 return 0;
862
863 return *p == data;
864}
865
866/**
867 * devm_pwm_put() - resource managed pwm_put()
868 * @dev: device for PWM consumer
869 * @pwm: PWM device
870 *
871 * Release a PWM previously allocated using devm_pwm_get(). Calling this
872 * function is usually not needed because devm-allocated resources are
873 * automatically released on driver detach.
874 */
875void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
876{
877 WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm));
878}
879EXPORT_SYMBOL_GPL(devm_pwm_put);
880
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100881/**
882 * pwm_can_sleep() - report whether PWM access will sleep
883 * @pwm: PWM device
884 *
Thierry Reding04883802015-07-27 11:58:32 +0200885 * Returns: True if accessing the PWM can sleep, false otherwise.
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100886 */
887bool pwm_can_sleep(struct pwm_device *pwm)
888{
Thierry Redingff01c942016-01-21 15:04:59 +0100889 return true;
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100890}
891EXPORT_SYMBOL_GPL(pwm_can_sleep);
892
Thierry Reding62099ab2012-03-26 09:31:48 +0200893#ifdef CONFIG_DEBUG_FS
894static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s)
895{
896 unsigned int i;
897
898 for (i = 0; i < chip->npwm; i++) {
899 struct pwm_device *pwm = &chip->pwms[i];
900
901 seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label);
902
903 if (test_bit(PWMF_REQUESTED, &pwm->flags))
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900904 seq_puts(s, " requested");
Thierry Reding62099ab2012-03-26 09:31:48 +0200905
Boris Brezillon5c312522015-07-01 10:21:47 +0200906 if (pwm_is_enabled(pwm))
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900907 seq_puts(s, " enabled");
Thierry Reding62099ab2012-03-26 09:31:48 +0200908
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900909 seq_puts(s, "\n");
Thierry Reding62099ab2012-03-26 09:31:48 +0200910 }
911}
912
913static void *pwm_seq_start(struct seq_file *s, loff_t *pos)
914{
915 mutex_lock(&pwm_lock);
916 s->private = "";
917
918 return seq_list_start(&pwm_chips, *pos);
919}
920
921static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos)
922{
923 s->private = "\n";
924
925 return seq_list_next(v, &pwm_chips, pos);
926}
927
928static void pwm_seq_stop(struct seq_file *s, void *v)
929{
930 mutex_unlock(&pwm_lock);
931}
932
933static int pwm_seq_show(struct seq_file *s, void *v)
934{
935 struct pwm_chip *chip = list_entry(v, struct pwm_chip, list);
936
937 seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private,
938 chip->dev->bus ? chip->dev->bus->name : "no-bus",
939 dev_name(chip->dev), chip->npwm,
940 (chip->npwm != 1) ? "s" : "");
941
942 if (chip->ops->dbg_show)
943 chip->ops->dbg_show(chip, s);
944 else
945 pwm_dbg_show(chip, s);
946
947 return 0;
948}
949
950static const struct seq_operations pwm_seq_ops = {
951 .start = pwm_seq_start,
952 .next = pwm_seq_next,
953 .stop = pwm_seq_stop,
954 .show = pwm_seq_show,
955};
956
957static int pwm_seq_open(struct inode *inode, struct file *file)
958{
959 return seq_open(file, &pwm_seq_ops);
960}
961
962static const struct file_operations pwm_debugfs_ops = {
963 .owner = THIS_MODULE,
964 .open = pwm_seq_open,
965 .read = seq_read,
966 .llseek = seq_lseek,
967 .release = seq_release,
968};
969
970static int __init pwm_debugfs_init(void)
971{
972 debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL,
973 &pwm_debugfs_ops);
974
975 return 0;
976}
Thierry Reding62099ab2012-03-26 09:31:48 +0200977subsys_initcall(pwm_debugfs_init);
978#endif /* CONFIG_DEBUG_FS */