blob: 22cf3959041c1e9f5f8bc9cdbe6144b94e492f31 [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;
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700271 pwm->polarity = polarity;
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700272 mutex_init(&pwm->lock);
Thierry Redingf051c462011-12-14 11:12:23 +0100273
274 radix_tree_insert(&pwm_tree, pwm->pwm, pwm);
275 }
276
277 bitmap_set(allocated_pwms, chip->base, chip->npwm);
278
279 INIT_LIST_HEAD(&chip->list);
280 list_add(&chip->list, &pwm_chips);
281
282 ret = 0;
283
Thierry Reding7299ab72011-12-14 11:10:32 +0100284 if (IS_ENABLED(CONFIG_OF))
285 of_pwmchip_add(chip);
286
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700287 pwmchip_sysfs_export(chip);
288
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100289out:
290 mutex_unlock(&pwm_lock);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100291 return ret;
292}
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700293EXPORT_SYMBOL_GPL(pwmchip_add_with_polarity);
294
295/**
296 * pwmchip_add() - register a new PWM chip
297 * @chip: the PWM chip to add
298 *
299 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
300 * will be used. The initial polarity for all channels is normal.
Thierry Reding04883802015-07-27 11:58:32 +0200301 *
302 * Returns: 0 on success or a negative error code on failure.
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700303 */
304int pwmchip_add(struct pwm_chip *chip)
305{
306 return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL);
307}
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100308EXPORT_SYMBOL_GPL(pwmchip_add);
309
310/**
311 * pwmchip_remove() - remove a PWM chip
312 * @chip: the PWM chip to remove
313 *
314 * Removes a PWM chip. This function may return busy if the PWM chip provides
315 * a PWM device that is still requested.
Thierry Reding04883802015-07-27 11:58:32 +0200316 *
317 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100318 */
319int pwmchip_remove(struct pwm_chip *chip)
320{
Thierry Redingf051c462011-12-14 11:12:23 +0100321 unsigned int i;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100322 int ret = 0;
323
324 mutex_lock(&pwm_lock);
325
Thierry Redingf051c462011-12-14 11:12:23 +0100326 for (i = 0; i < chip->npwm; i++) {
327 struct pwm_device *pwm = &chip->pwms[i];
328
329 if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
330 ret = -EBUSY;
331 goto out;
332 }
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100333 }
334
Thierry Redingf051c462011-12-14 11:12:23 +0100335 list_del_init(&chip->list);
Thierry Reding7299ab72011-12-14 11:10:32 +0100336
337 if (IS_ENABLED(CONFIG_OF))
338 of_pwmchip_remove(chip);
339
Thierry Redingf051c462011-12-14 11:12:23 +0100340 free_pwms(chip);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100341
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700342 pwmchip_sysfs_unexport(chip);
343
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100344out:
345 mutex_unlock(&pwm_lock);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100346 return ret;
347}
348EXPORT_SYMBOL_GPL(pwmchip_remove);
349
350/**
351 * pwm_request() - request a PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200352 * @pwm: global PWM device index
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100353 * @label: PWM device label
Thierry Reding8138d2d2012-03-26 08:42:48 +0200354 *
355 * This function is deprecated, use pwm_get() instead.
Thierry Reding04883802015-07-27 11:58:32 +0200356 *
357 * Returns: A pointer to a PWM device or an ERR_PTR()-encoded error code on
358 * failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100359 */
Thierry Redingf051c462011-12-14 11:12:23 +0100360struct pwm_device *pwm_request(int pwm, const char *label)
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100361{
Thierry Redingf051c462011-12-14 11:12:23 +0100362 struct pwm_device *dev;
363 int err;
364
365 if (pwm < 0 || pwm >= MAX_PWMS)
366 return ERR_PTR(-EINVAL);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100367
368 mutex_lock(&pwm_lock);
369
Thierry Redingf051c462011-12-14 11:12:23 +0100370 dev = pwm_to_device(pwm);
371 if (!dev) {
372 dev = ERR_PTR(-EPROBE_DEFER);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100373 goto out;
374 }
375
Thierry Redingf051c462011-12-14 11:12:23 +0100376 err = pwm_device_request(dev, label);
377 if (err < 0)
378 dev = ERR_PTR(err);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100379
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100380out:
381 mutex_unlock(&pwm_lock);
382
Thierry Redingf051c462011-12-14 11:12:23 +0100383 return dev;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100384}
385EXPORT_SYMBOL_GPL(pwm_request);
386
387/**
Thierry Redingf051c462011-12-14 11:12:23 +0100388 * pwm_request_from_chip() - request a PWM device relative to a PWM chip
389 * @chip: PWM chip
390 * @index: per-chip index of the PWM to request
391 * @label: a literal description string of this PWM
392 *
Thierry Reding04883802015-07-27 11:58:32 +0200393 * Returns: A pointer to the PWM device at the given index of the given PWM
394 * chip. A negative error code is returned if the index is not valid for the
395 * specified PWM chip or if the PWM device cannot be requested.
Thierry Redingf051c462011-12-14 11:12:23 +0100396 */
397struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
398 unsigned int index,
399 const char *label)
400{
401 struct pwm_device *pwm;
402 int err;
403
404 if (!chip || index >= chip->npwm)
405 return ERR_PTR(-EINVAL);
406
407 mutex_lock(&pwm_lock);
408 pwm = &chip->pwms[index];
409
410 err = pwm_device_request(pwm, label);
411 if (err < 0)
412 pwm = ERR_PTR(err);
413
414 mutex_unlock(&pwm_lock);
415 return pwm;
416}
417EXPORT_SYMBOL_GPL(pwm_request_from_chip);
418
419/**
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100420 * pwm_free() - free a PWM device
421 * @pwm: PWM device
Thierry Reding8138d2d2012-03-26 08:42:48 +0200422 *
423 * This function is deprecated, use pwm_put() instead.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100424 */
425void pwm_free(struct pwm_device *pwm)
426{
Thierry Reding8138d2d2012-03-26 08:42:48 +0200427 pwm_put(pwm);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100428}
429EXPORT_SYMBOL_GPL(pwm_free);
430
431/**
432 * pwm_config() - change a PWM device configuration
433 * @pwm: PWM device
434 * @duty_ns: "on" time (in nanoseconds)
435 * @period_ns: duration (in nanoseconds) of one cycle
Thierry Reding04883802015-07-27 11:58:32 +0200436 *
437 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100438 */
439int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
440{
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700441 int err;
442
Thierry Redingc2d476a2012-09-02 22:13:40 +0200443 if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns)
Thierry Redingf051c462011-12-14 11:12:23 +0100444 return -EINVAL;
445
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700446 err = pwm->chip->ops->config(pwm->chip, pwm, duty_ns, period_ns);
447 if (err)
448 return err;
449
450 pwm->duty_cycle = duty_ns;
451 pwm->period = period_ns;
452
453 return 0;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100454}
455EXPORT_SYMBOL_GPL(pwm_config);
456
457/**
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530458 * pwm_set_polarity() - configure the polarity of a PWM signal
459 * @pwm: PWM device
460 * @polarity: new polarity of the PWM signal
461 *
Thierry Reding04883802015-07-27 11:58:32 +0200462 * Note that the polarity cannot be configured while the PWM device is
463 * enabled.
464 *
465 * Returns: 0 on success or a negative error code on failure.
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530466 */
467int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity)
468{
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700469 int err;
470
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530471 if (!pwm || !pwm->chip->ops)
472 return -EINVAL;
473
474 if (!pwm->chip->ops->set_polarity)
475 return -ENOSYS;
476
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700477 mutex_lock(&pwm->lock);
478
479 if (pwm_is_enabled(pwm)) {
480 err = -EBUSY;
481 goto unlock;
482 }
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530483
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700484 err = pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity);
485 if (err)
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700486 goto unlock;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700487
488 pwm->polarity = polarity;
489
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700490unlock:
491 mutex_unlock(&pwm->lock);
492 return err;
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530493}
494EXPORT_SYMBOL_GPL(pwm_set_polarity);
495
496/**
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100497 * pwm_enable() - start a PWM output toggling
498 * @pwm: PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200499 *
500 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100501 */
502int pwm_enable(struct pwm_device *pwm)
503{
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700504 int err = 0;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100505
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700506 if (!pwm)
507 return -EINVAL;
508
509 mutex_lock(&pwm->lock);
510
511 if (!test_and_set_bit(PWMF_ENABLED, &pwm->flags)) {
512 err = pwm->chip->ops->enable(pwm->chip, pwm);
513 if (err)
514 clear_bit(PWMF_ENABLED, &pwm->flags);
515 }
516
517 mutex_unlock(&pwm->lock);
518
519 return err;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100520}
521EXPORT_SYMBOL_GPL(pwm_enable);
522
523/**
524 * pwm_disable() - stop a PWM output toggling
525 * @pwm: PWM device
526 */
527void pwm_disable(struct pwm_device *pwm)
528{
Thierry Redingf051c462011-12-14 11:12:23 +0100529 if (pwm && test_and_clear_bit(PWMF_ENABLED, &pwm->flags))
530 pwm->chip->ops->disable(pwm->chip, pwm);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100531}
532EXPORT_SYMBOL_GPL(pwm_disable);
Thierry Reding62099ab2012-03-26 09:31:48 +0200533
Thierry Reding7299ab72011-12-14 11:10:32 +0100534static struct pwm_chip *of_node_to_pwmchip(struct device_node *np)
535{
536 struct pwm_chip *chip;
537
538 mutex_lock(&pwm_lock);
539
540 list_for_each_entry(chip, &pwm_chips, list)
541 if (chip->dev && chip->dev->of_node == np) {
542 mutex_unlock(&pwm_lock);
543 return chip;
544 }
545
546 mutex_unlock(&pwm_lock);
547
548 return ERR_PTR(-EPROBE_DEFER);
549}
550
551/**
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800552 * of_pwm_get() - request a PWM via the PWM framework
Thierry Reding7299ab72011-12-14 11:10:32 +0100553 * @np: device node to get the PWM from
554 * @con_id: consumer name
555 *
556 * Returns the PWM device parsed from the phandle and index specified in the
557 * "pwms" property of a device tree node or a negative error-code on failure.
558 * Values parsed from the device tree are stored in the returned PWM device
559 * object.
560 *
561 * If con_id is NULL, the first PWM device listed in the "pwms" property will
562 * be requested. Otherwise the "pwm-names" property is used to do a reverse
563 * lookup of the PWM index. This also means that the "pwm-names" property
564 * becomes mandatory for devices that look up the PWM device via the con_id
565 * parameter.
Thierry Reding04883802015-07-27 11:58:32 +0200566 *
567 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
568 * error code on failure.
Thierry Reding7299ab72011-12-14 11:10:32 +0100569 */
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800570struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
Thierry Reding7299ab72011-12-14 11:10:32 +0100571{
572 struct pwm_device *pwm = NULL;
573 struct of_phandle_args args;
574 struct pwm_chip *pc;
575 int index = 0;
576 int err;
577
578 if (con_id) {
579 index = of_property_match_string(np, "pwm-names", con_id);
580 if (index < 0)
581 return ERR_PTR(index);
582 }
583
584 err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index,
585 &args);
586 if (err) {
587 pr_debug("%s(): can't parse \"pwms\" property\n", __func__);
588 return ERR_PTR(err);
589 }
590
591 pc = of_node_to_pwmchip(args.np);
592 if (IS_ERR(pc)) {
593 pr_debug("%s(): PWM chip not found\n", __func__);
594 pwm = ERR_CAST(pc);
595 goto put;
596 }
597
598 if (args.args_count != pc->of_pwm_n_cells) {
599 pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name,
600 args.np->full_name);
601 pwm = ERR_PTR(-EINVAL);
602 goto put;
603 }
604
605 pwm = pc->of_xlate(pc, &args);
606 if (IS_ERR(pwm))
607 goto put;
608
609 /*
610 * If a consumer name was not given, try to look it up from the
611 * "pwm-names" property if it exists. Otherwise use the name of
612 * the user device node.
613 */
614 if (!con_id) {
615 err = of_property_read_string_index(np, "pwm-names", index,
616 &con_id);
617 if (err < 0)
618 con_id = np->name;
619 }
620
621 pwm->label = con_id;
622
Boris Brezillonfbd45a12016-05-17 14:27:25 +0200623 /*
624 * FIXME: This should be removed once all PWM users properly make use
625 * of struct pwm_args to initialize the PWM device. As long as this is
626 * here, the PWM state and hardware state can get out of sync.
627 */
628 pwm_apply_args(pwm);
629
Thierry Reding7299ab72011-12-14 11:10:32 +0100630put:
631 of_node_put(args.np);
632
633 return pwm;
634}
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800635EXPORT_SYMBOL_GPL(of_pwm_get);
Thierry Reding7299ab72011-12-14 11:10:32 +0100636
Thierry Reding8138d2d2012-03-26 08:42:48 +0200637/**
638 * pwm_add_table() - register PWM device consumers
639 * @table: array of consumers to register
640 * @num: number of consumers in table
641 */
Shobhit Kumarc264f112015-03-12 22:01:31 +0530642void pwm_add_table(struct pwm_lookup *table, size_t num)
Thierry Reding8138d2d2012-03-26 08:42:48 +0200643{
644 mutex_lock(&pwm_lookup_lock);
645
646 while (num--) {
647 list_add_tail(&table->list, &pwm_lookup_list);
648 table++;
649 }
650
651 mutex_unlock(&pwm_lookup_lock);
652}
653
654/**
Shobhit Kumarefb0de52015-05-05 15:04:18 +0530655 * pwm_remove_table() - unregister PWM device consumers
656 * @table: array of consumers to unregister
657 * @num: number of consumers in table
658 */
659void pwm_remove_table(struct pwm_lookup *table, size_t num)
660{
661 mutex_lock(&pwm_lookup_lock);
662
663 while (num--) {
664 list_del(&table->list);
665 table++;
666 }
667
668 mutex_unlock(&pwm_lookup_lock);
669}
670
671/**
Thierry Reding8138d2d2012-03-26 08:42:48 +0200672 * pwm_get() - look up and request a PWM device
673 * @dev: device for PWM consumer
674 * @con_id: consumer name
675 *
Thierry Reding7299ab72011-12-14 11:10:32 +0100676 * Lookup is first attempted using DT. If the device was not instantiated from
677 * a device tree, a PWM chip and a relative index is looked up via a table
678 * supplied by board setup code (see pwm_add_table()).
Thierry Reding8138d2d2012-03-26 08:42:48 +0200679 *
680 * Once a PWM chip has been found the specified PWM device will be requested
681 * and is ready to be used.
Thierry Reding04883802015-07-27 11:58:32 +0200682 *
683 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
684 * error code on failure.
Thierry Reding8138d2d2012-03-26 08:42:48 +0200685 */
686struct pwm_device *pwm_get(struct device *dev, const char *con_id)
687{
688 struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
Sachin Kamate50d3522012-08-10 16:41:13 +0530689 const char *dev_id = dev ? dev_name(dev) : NULL;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200690 struct pwm_chip *chip = NULL;
691 unsigned int best = 0;
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200692 struct pwm_lookup *p, *chosen = NULL;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200693 unsigned int match;
694
Thierry Reding7299ab72011-12-14 11:10:32 +0100695 /* look up via DT first */
696 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800697 return of_pwm_get(dev->of_node, con_id);
Thierry Reding7299ab72011-12-14 11:10:32 +0100698
Thierry Reding8138d2d2012-03-26 08:42:48 +0200699 /*
700 * We look up the provider in the static table typically provided by
701 * board setup code. We first try to lookup the consumer device by
702 * name. If the consumer device was passed in as NULL or if no match
703 * was found, we try to find the consumer by directly looking it up
704 * by name.
705 *
706 * If a match is found, the provider PWM chip is looked up by name
707 * and a PWM device is requested using the PWM device per-chip index.
708 *
709 * The lookup algorithm was shamelessly taken from the clock
710 * framework:
711 *
712 * We do slightly fuzzy matching here:
713 * An entry with a NULL ID is assumed to be a wildcard.
714 * If an entry has a device ID, it must match
715 * If an entry has a connection ID, it must match
716 * Then we take the most specific entry - with the following order
717 * of precedence: dev+con > dev only > con only.
718 */
719 mutex_lock(&pwm_lookup_lock);
720
721 list_for_each_entry(p, &pwm_lookup_list, list) {
722 match = 0;
723
724 if (p->dev_id) {
725 if (!dev_id || strcmp(p->dev_id, dev_id))
726 continue;
727
728 match += 2;
729 }
730
731 if (p->con_id) {
732 if (!con_id || strcmp(p->con_id, con_id))
733 continue;
734
735 match += 1;
736 }
737
738 if (match > best) {
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200739 chosen = p;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200740
741 if (match != 3)
742 best = match;
743 else
744 break;
745 }
746 }
747
Thierry Reding655a0352015-10-05 14:38:32 +0200748 if (!chosen) {
749 pwm = ERR_PTR(-ENODEV);
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200750 goto out;
Thierry Reding655a0352015-10-05 14:38:32 +0200751 }
Alexandre Belloni3796ce12014-05-19 22:42:32 +0200752
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200753 chip = pwmchip_find_by_name(chosen->provider);
754 if (!chip)
755 goto out;
756
757 pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id);
Alexandre Belloni3796ce12014-05-19 22:42:32 +0200758 if (IS_ERR(pwm))
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200759 goto out;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200760
Boris Brezillonfbd45a12016-05-17 14:27:25 +0200761 pwm->args.period = chosen->period;
762 pwm->args.polarity = chosen->polarity;
763
764 /*
765 * FIXME: This should be removed once all PWM users properly make use
766 * of struct pwm_args to initialize the PWM device. As long as this is
767 * here, the PWM state and hardware state can get out of sync.
768 */
769 pwm_apply_args(pwm);
770
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200771out:
772 mutex_unlock(&pwm_lookup_lock);
Thierry Reding8138d2d2012-03-26 08:42:48 +0200773 return pwm;
774}
775EXPORT_SYMBOL_GPL(pwm_get);
776
777/**
778 * pwm_put() - release a PWM device
779 * @pwm: PWM device
780 */
781void pwm_put(struct pwm_device *pwm)
782{
783 if (!pwm)
784 return;
785
786 mutex_lock(&pwm_lock);
787
788 if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
Sachin Kamate50d3522012-08-10 16:41:13 +0530789 pr_warn("PWM device already freed\n");
Thierry Reding8138d2d2012-03-26 08:42:48 +0200790 goto out;
791 }
792
793 if (pwm->chip->ops->free)
794 pwm->chip->ops->free(pwm->chip, pwm);
795
796 pwm->label = NULL;
797
798 module_put(pwm->chip->ops->owner);
799out:
800 mutex_unlock(&pwm_lock);
801}
802EXPORT_SYMBOL_GPL(pwm_put);
803
Alexandre Courbot63543162012-08-01 19:20:58 +0900804static void devm_pwm_release(struct device *dev, void *res)
805{
806 pwm_put(*(struct pwm_device **)res);
807}
808
809/**
810 * devm_pwm_get() - resource managed pwm_get()
811 * @dev: device for PWM consumer
812 * @con_id: consumer name
813 *
814 * This function performs like pwm_get() but the acquired PWM device will
815 * automatically be released on driver detach.
Thierry Reding04883802015-07-27 11:58:32 +0200816 *
817 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
818 * error code on failure.
Alexandre Courbot63543162012-08-01 19:20:58 +0900819 */
820struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
821{
822 struct pwm_device **ptr, *pwm;
823
Wolfram Sang77f0b9d2013-06-03 22:27:17 +0200824 ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
Alexandre Courbot63543162012-08-01 19:20:58 +0900825 if (!ptr)
826 return ERR_PTR(-ENOMEM);
827
828 pwm = pwm_get(dev, con_id);
829 if (!IS_ERR(pwm)) {
830 *ptr = pwm;
831 devres_add(dev, ptr);
832 } else {
833 devres_free(ptr);
834 }
835
836 return pwm;
837}
838EXPORT_SYMBOL_GPL(devm_pwm_get);
839
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800840/**
841 * devm_of_pwm_get() - resource managed of_pwm_get()
842 * @dev: device for PWM consumer
843 * @np: device node to get the PWM from
844 * @con_id: consumer name
845 *
846 * This function performs like of_pwm_get() but the acquired PWM device will
847 * automatically be released on driver detach.
Thierry Reding04883802015-07-27 11:58:32 +0200848 *
849 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
850 * error code on failure.
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800851 */
852struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
853 const char *con_id)
854{
855 struct pwm_device **ptr, *pwm;
856
Wolfram Sang77f0b9d2013-06-03 22:27:17 +0200857 ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800858 if (!ptr)
859 return ERR_PTR(-ENOMEM);
860
861 pwm = of_pwm_get(np, con_id);
862 if (!IS_ERR(pwm)) {
863 *ptr = pwm;
864 devres_add(dev, ptr);
865 } else {
866 devres_free(ptr);
867 }
868
869 return pwm;
870}
871EXPORT_SYMBOL_GPL(devm_of_pwm_get);
872
Alexandre Courbot63543162012-08-01 19:20:58 +0900873static int devm_pwm_match(struct device *dev, void *res, void *data)
874{
875 struct pwm_device **p = res;
876
877 if (WARN_ON(!p || !*p))
878 return 0;
879
880 return *p == data;
881}
882
883/**
884 * devm_pwm_put() - resource managed pwm_put()
885 * @dev: device for PWM consumer
886 * @pwm: PWM device
887 *
888 * Release a PWM previously allocated using devm_pwm_get(). Calling this
889 * function is usually not needed because devm-allocated resources are
890 * automatically released on driver detach.
891 */
892void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
893{
894 WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm));
895}
896EXPORT_SYMBOL_GPL(devm_pwm_put);
897
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100898/**
899 * pwm_can_sleep() - report whether PWM access will sleep
900 * @pwm: PWM device
901 *
Thierry Reding04883802015-07-27 11:58:32 +0200902 * Returns: True if accessing the PWM can sleep, false otherwise.
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100903 */
904bool pwm_can_sleep(struct pwm_device *pwm)
905{
Thierry Redingff01c942016-01-21 15:04:59 +0100906 return true;
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100907}
908EXPORT_SYMBOL_GPL(pwm_can_sleep);
909
Thierry Reding62099ab2012-03-26 09:31:48 +0200910#ifdef CONFIG_DEBUG_FS
911static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s)
912{
913 unsigned int i;
914
915 for (i = 0; i < chip->npwm; i++) {
916 struct pwm_device *pwm = &chip->pwms[i];
917
918 seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label);
919
920 if (test_bit(PWMF_REQUESTED, &pwm->flags))
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900921 seq_puts(s, " requested");
Thierry Reding62099ab2012-03-26 09:31:48 +0200922
Boris Brezillon5c312522015-07-01 10:21:47 +0200923 if (pwm_is_enabled(pwm))
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900924 seq_puts(s, " enabled");
Thierry Reding62099ab2012-03-26 09:31:48 +0200925
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900926 seq_puts(s, "\n");
Thierry Reding62099ab2012-03-26 09:31:48 +0200927 }
928}
929
930static void *pwm_seq_start(struct seq_file *s, loff_t *pos)
931{
932 mutex_lock(&pwm_lock);
933 s->private = "";
934
935 return seq_list_start(&pwm_chips, *pos);
936}
937
938static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos)
939{
940 s->private = "\n";
941
942 return seq_list_next(v, &pwm_chips, pos);
943}
944
945static void pwm_seq_stop(struct seq_file *s, void *v)
946{
947 mutex_unlock(&pwm_lock);
948}
949
950static int pwm_seq_show(struct seq_file *s, void *v)
951{
952 struct pwm_chip *chip = list_entry(v, struct pwm_chip, list);
953
954 seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private,
955 chip->dev->bus ? chip->dev->bus->name : "no-bus",
956 dev_name(chip->dev), chip->npwm,
957 (chip->npwm != 1) ? "s" : "");
958
959 if (chip->ops->dbg_show)
960 chip->ops->dbg_show(chip, s);
961 else
962 pwm_dbg_show(chip, s);
963
964 return 0;
965}
966
967static const struct seq_operations pwm_seq_ops = {
968 .start = pwm_seq_start,
969 .next = pwm_seq_next,
970 .stop = pwm_seq_stop,
971 .show = pwm_seq_show,
972};
973
974static int pwm_seq_open(struct inode *inode, struct file *file)
975{
976 return seq_open(file, &pwm_seq_ops);
977}
978
979static const struct file_operations pwm_debugfs_ops = {
980 .owner = THIS_MODULE,
981 .open = pwm_seq_open,
982 .read = seq_read,
983 .llseek = seq_lseek,
984 .release = seq_release,
985};
986
987static int __init pwm_debugfs_init(void)
988{
989 debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL,
990 &pwm_debugfs_ops);
991
992 return 0;
993}
Thierry Reding62099ab2012-03-26 09:31:48 +0200994subsys_initcall(pwm_debugfs_init);
995#endif /* CONFIG_DEBUG_FS */