blob: f3f91e716a429a0feced2ee2e34267d4cb6ebaf9 [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 Reding62099abf2012-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
273 radix_tree_insert(&pwm_tree, pwm->pwm, pwm);
274 }
275
276 bitmap_set(allocated_pwms, chip->base, chip->npwm);
277
278 INIT_LIST_HEAD(&chip->list);
279 list_add(&chip->list, &pwm_chips);
280
281 ret = 0;
282
Thierry Reding7299ab72011-12-14 11:10:32 +0100283 if (IS_ENABLED(CONFIG_OF))
284 of_pwmchip_add(chip);
285
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700286 pwmchip_sysfs_export(chip);
287
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100288out:
289 mutex_unlock(&pwm_lock);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100290 return ret;
291}
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700292EXPORT_SYMBOL_GPL(pwmchip_add_with_polarity);
293
294/**
295 * pwmchip_add() - register a new PWM chip
296 * @chip: the PWM chip to add
297 *
298 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
299 * will be used. The initial polarity for all channels is normal.
Thierry Reding04883802015-07-27 11:58:32 +0200300 *
301 * Returns: 0 on success or a negative error code on failure.
Tim Krygerb6a00fa2015-05-26 13:08:16 -0700302 */
303int pwmchip_add(struct pwm_chip *chip)
304{
305 return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL);
306}
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100307EXPORT_SYMBOL_GPL(pwmchip_add);
308
309/**
310 * pwmchip_remove() - remove a PWM chip
311 * @chip: the PWM chip to remove
312 *
313 * Removes a PWM chip. This function may return busy if the PWM chip provides
314 * a PWM device that is still requested.
Thierry Reding04883802015-07-27 11:58:32 +0200315 *
316 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100317 */
318int pwmchip_remove(struct pwm_chip *chip)
319{
Thierry Redingf051c462011-12-14 11:12:23 +0100320 unsigned int i;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100321 int ret = 0;
322
323 mutex_lock(&pwm_lock);
324
Thierry Redingf051c462011-12-14 11:12:23 +0100325 for (i = 0; i < chip->npwm; i++) {
326 struct pwm_device *pwm = &chip->pwms[i];
327
328 if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
329 ret = -EBUSY;
330 goto out;
331 }
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100332 }
333
Thierry Redingf051c462011-12-14 11:12:23 +0100334 list_del_init(&chip->list);
Thierry Reding7299ab72011-12-14 11:10:32 +0100335
336 if (IS_ENABLED(CONFIG_OF))
337 of_pwmchip_remove(chip);
338
Thierry Redingf051c462011-12-14 11:12:23 +0100339 free_pwms(chip);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100340
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700341 pwmchip_sysfs_unexport(chip);
342
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100343out:
344 mutex_unlock(&pwm_lock);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100345 return ret;
346}
347EXPORT_SYMBOL_GPL(pwmchip_remove);
348
349/**
350 * pwm_request() - request a PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200351 * @pwm: global PWM device index
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100352 * @label: PWM device label
Thierry Reding8138d2d2012-03-26 08:42:48 +0200353 *
354 * This function is deprecated, use pwm_get() instead.
Thierry Reding04883802015-07-27 11:58:32 +0200355 *
356 * Returns: A pointer to a PWM device or an ERR_PTR()-encoded error code on
357 * failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100358 */
Thierry Redingf051c462011-12-14 11:12:23 +0100359struct pwm_device *pwm_request(int pwm, const char *label)
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100360{
Thierry Redingf051c462011-12-14 11:12:23 +0100361 struct pwm_device *dev;
362 int err;
363
364 if (pwm < 0 || pwm >= MAX_PWMS)
365 return ERR_PTR(-EINVAL);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100366
367 mutex_lock(&pwm_lock);
368
Thierry Redingf051c462011-12-14 11:12:23 +0100369 dev = pwm_to_device(pwm);
370 if (!dev) {
371 dev = ERR_PTR(-EPROBE_DEFER);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100372 goto out;
373 }
374
Thierry Redingf051c462011-12-14 11:12:23 +0100375 err = pwm_device_request(dev, label);
376 if (err < 0)
377 dev = ERR_PTR(err);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100378
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100379out:
380 mutex_unlock(&pwm_lock);
381
Thierry Redingf051c462011-12-14 11:12:23 +0100382 return dev;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100383}
384EXPORT_SYMBOL_GPL(pwm_request);
385
386/**
Thierry Redingf051c462011-12-14 11:12:23 +0100387 * pwm_request_from_chip() - request a PWM device relative to a PWM chip
388 * @chip: PWM chip
389 * @index: per-chip index of the PWM to request
390 * @label: a literal description string of this PWM
391 *
Thierry Reding04883802015-07-27 11:58:32 +0200392 * Returns: A pointer to the PWM device at the given index of the given PWM
393 * chip. A negative error code is returned if the index is not valid for the
394 * specified PWM chip or if the PWM device cannot be requested.
Thierry Redingf051c462011-12-14 11:12:23 +0100395 */
396struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
397 unsigned int index,
398 const char *label)
399{
400 struct pwm_device *pwm;
401 int err;
402
403 if (!chip || index >= chip->npwm)
404 return ERR_PTR(-EINVAL);
405
406 mutex_lock(&pwm_lock);
407 pwm = &chip->pwms[index];
408
409 err = pwm_device_request(pwm, label);
410 if (err < 0)
411 pwm = ERR_PTR(err);
412
413 mutex_unlock(&pwm_lock);
414 return pwm;
415}
416EXPORT_SYMBOL_GPL(pwm_request_from_chip);
417
418/**
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100419 * pwm_free() - free a PWM device
420 * @pwm: PWM device
Thierry Reding8138d2d2012-03-26 08:42:48 +0200421 *
422 * This function is deprecated, use pwm_put() instead.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100423 */
424void pwm_free(struct pwm_device *pwm)
425{
Thierry Reding8138d2d2012-03-26 08:42:48 +0200426 pwm_put(pwm);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100427}
428EXPORT_SYMBOL_GPL(pwm_free);
429
430/**
431 * pwm_config() - change a PWM device configuration
432 * @pwm: PWM device
433 * @duty_ns: "on" time (in nanoseconds)
434 * @period_ns: duration (in nanoseconds) of one cycle
Thierry Reding04883802015-07-27 11:58:32 +0200435 *
436 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100437 */
438int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
439{
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700440 int err;
441
Thierry Redingc2d476a2012-09-02 22:13:40 +0200442 if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns)
Thierry Redingf051c462011-12-14 11:12:23 +0100443 return -EINVAL;
444
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700445 err = pwm->chip->ops->config(pwm->chip, pwm, duty_ns, period_ns);
446 if (err)
447 return err;
448
Boris Brezillon43a276b2016-04-14 21:17:38 +0200449 pwm->state.duty_cycle = duty_ns;
450 pwm->state.period = period_ns;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700451
452 return 0;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100453}
454EXPORT_SYMBOL_GPL(pwm_config);
455
456/**
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530457 * pwm_set_polarity() - configure the polarity of a PWM signal
458 * @pwm: PWM device
459 * @polarity: new polarity of the PWM signal
460 *
Thierry Reding04883802015-07-27 11:58:32 +0200461 * Note that the polarity cannot be configured while the PWM device is
462 * enabled.
463 *
464 * Returns: 0 on success or a negative error code on failure.
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530465 */
466int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity)
467{
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700468 int err;
469
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530470 if (!pwm || !pwm->chip->ops)
471 return -EINVAL;
472
473 if (!pwm->chip->ops->set_polarity)
474 return -ENOSYS;
475
Boris BREZILLON459a25a2016-03-30 22:03:27 +0200476 if (pwm_is_enabled(pwm))
477 return -EBUSY;
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530478
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700479 err = pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity);
480 if (err)
Boris BREZILLON459a25a2016-03-30 22:03:27 +0200481 return err;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700482
Boris Brezillon43a276b2016-04-14 21:17:38 +0200483 pwm->state.polarity = polarity;
H Hartley Sweeten76abbdde2013-06-11 10:38:59 -0700484
Boris BREZILLON459a25a2016-03-30 22:03:27 +0200485 return 0;
Philip, Avinash0aa0869c2012-07-24 19:35:32 +0530486}
487EXPORT_SYMBOL_GPL(pwm_set_polarity);
488
489/**
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100490 * pwm_enable() - start a PWM output toggling
491 * @pwm: PWM device
Thierry Reding04883802015-07-27 11:58:32 +0200492 *
493 * Returns: 0 on success or a negative error code on failure.
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100494 */
495int pwm_enable(struct pwm_device *pwm)
496{
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700497 int err = 0;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100498
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700499 if (!pwm)
500 return -EINVAL;
501
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700502 if (!test_and_set_bit(PWMF_ENABLED, &pwm->flags)) {
503 err = pwm->chip->ops->enable(pwm->chip, pwm);
504 if (err)
505 clear_bit(PWMF_ENABLED, &pwm->flags);
506 }
507
Jonathan Richardsond1cd2142015-10-16 17:40:58 -0700508 return err;
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100509}
510EXPORT_SYMBOL_GPL(pwm_enable);
511
512/**
513 * pwm_disable() - stop a PWM output toggling
514 * @pwm: PWM device
515 */
516void pwm_disable(struct pwm_device *pwm)
517{
Thierry Redingf051c462011-12-14 11:12:23 +0100518 if (pwm && test_and_clear_bit(PWMF_ENABLED, &pwm->flags))
519 pwm->chip->ops->disable(pwm->chip, pwm);
Sascha Hauer0c2498f2011-01-28 09:40:40 +0100520}
521EXPORT_SYMBOL_GPL(pwm_disable);
Thierry Reding62099abf2012-03-26 09:31:48 +0200522
Thierry Reding7299ab72011-12-14 11:10:32 +0100523static struct pwm_chip *of_node_to_pwmchip(struct device_node *np)
524{
525 struct pwm_chip *chip;
526
527 mutex_lock(&pwm_lock);
528
529 list_for_each_entry(chip, &pwm_chips, list)
530 if (chip->dev && chip->dev->of_node == np) {
531 mutex_unlock(&pwm_lock);
532 return chip;
533 }
534
535 mutex_unlock(&pwm_lock);
536
537 return ERR_PTR(-EPROBE_DEFER);
538}
539
540/**
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800541 * of_pwm_get() - request a PWM via the PWM framework
Thierry Reding7299ab72011-12-14 11:10:32 +0100542 * @np: device node to get the PWM from
543 * @con_id: consumer name
544 *
545 * Returns the PWM device parsed from the phandle and index specified in the
546 * "pwms" property of a device tree node or a negative error-code on failure.
547 * Values parsed from the device tree are stored in the returned PWM device
548 * object.
549 *
550 * If con_id is NULL, the first PWM device listed in the "pwms" property will
551 * be requested. Otherwise the "pwm-names" property is used to do a reverse
552 * lookup of the PWM index. This also means that the "pwm-names" property
553 * becomes mandatory for devices that look up the PWM device via the con_id
554 * parameter.
Thierry Reding04883802015-07-27 11:58:32 +0200555 *
556 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
557 * error code on failure.
Thierry Reding7299ab72011-12-14 11:10:32 +0100558 */
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800559struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
Thierry Reding7299ab72011-12-14 11:10:32 +0100560{
561 struct pwm_device *pwm = NULL;
562 struct of_phandle_args args;
563 struct pwm_chip *pc;
564 int index = 0;
565 int err;
566
567 if (con_id) {
568 index = of_property_match_string(np, "pwm-names", con_id);
569 if (index < 0)
570 return ERR_PTR(index);
571 }
572
573 err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index,
574 &args);
575 if (err) {
576 pr_debug("%s(): can't parse \"pwms\" property\n", __func__);
577 return ERR_PTR(err);
578 }
579
580 pc = of_node_to_pwmchip(args.np);
581 if (IS_ERR(pc)) {
582 pr_debug("%s(): PWM chip not found\n", __func__);
583 pwm = ERR_CAST(pc);
584 goto put;
585 }
586
587 if (args.args_count != pc->of_pwm_n_cells) {
588 pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name,
589 args.np->full_name);
590 pwm = ERR_PTR(-EINVAL);
591 goto put;
592 }
593
594 pwm = pc->of_xlate(pc, &args);
595 if (IS_ERR(pwm))
596 goto put;
597
598 /*
599 * If a consumer name was not given, try to look it up from the
600 * "pwm-names" property if it exists. Otherwise use the name of
601 * the user device node.
602 */
603 if (!con_id) {
604 err = of_property_read_string_index(np, "pwm-names", index,
605 &con_id);
606 if (err < 0)
607 con_id = np->name;
608 }
609
610 pwm->label = con_id;
611
612put:
613 of_node_put(args.np);
614
615 return pwm;
616}
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800617EXPORT_SYMBOL_GPL(of_pwm_get);
Thierry Reding7299ab72011-12-14 11:10:32 +0100618
Thierry Reding8138d2d2012-03-26 08:42:48 +0200619/**
620 * pwm_add_table() - register PWM device consumers
621 * @table: array of consumers to register
622 * @num: number of consumers in table
623 */
Shobhit Kumarc264f112015-03-12 22:01:31 +0530624void pwm_add_table(struct pwm_lookup *table, size_t num)
Thierry Reding8138d2d2012-03-26 08:42:48 +0200625{
626 mutex_lock(&pwm_lookup_lock);
627
628 while (num--) {
629 list_add_tail(&table->list, &pwm_lookup_list);
630 table++;
631 }
632
633 mutex_unlock(&pwm_lookup_lock);
634}
635
636/**
Shobhit Kumarefb0de52015-05-05 15:04:18 +0530637 * pwm_remove_table() - unregister PWM device consumers
638 * @table: array of consumers to unregister
639 * @num: number of consumers in table
640 */
641void pwm_remove_table(struct pwm_lookup *table, size_t num)
642{
643 mutex_lock(&pwm_lookup_lock);
644
645 while (num--) {
646 list_del(&table->list);
647 table++;
648 }
649
650 mutex_unlock(&pwm_lookup_lock);
651}
652
653/**
Thierry Reding8138d2d2012-03-26 08:42:48 +0200654 * pwm_get() - look up and request a PWM device
655 * @dev: device for PWM consumer
656 * @con_id: consumer name
657 *
Thierry Reding7299ab72011-12-14 11:10:32 +0100658 * Lookup is first attempted using DT. If the device was not instantiated from
659 * a device tree, a PWM chip and a relative index is looked up via a table
660 * supplied by board setup code (see pwm_add_table()).
Thierry Reding8138d2d2012-03-26 08:42:48 +0200661 *
662 * Once a PWM chip has been found the specified PWM device will be requested
663 * and is ready to be used.
Thierry Reding04883802015-07-27 11:58:32 +0200664 *
665 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
666 * error code on failure.
Thierry Reding8138d2d2012-03-26 08:42:48 +0200667 */
668struct pwm_device *pwm_get(struct device *dev, const char *con_id)
669{
670 struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
Sachin Kamate50d3522012-08-10 16:41:13 +0530671 const char *dev_id = dev ? dev_name(dev) : NULL;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200672 struct pwm_chip *chip = NULL;
673 unsigned int best = 0;
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200674 struct pwm_lookup *p, *chosen = NULL;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200675 unsigned int match;
676
Thierry Reding7299ab72011-12-14 11:10:32 +0100677 /* look up via DT first */
678 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
Peter Ujfalusi8eb96122012-12-21 01:43:58 -0800679 return of_pwm_get(dev->of_node, con_id);
Thierry Reding7299ab72011-12-14 11:10:32 +0100680
Thierry Reding8138d2d2012-03-26 08:42:48 +0200681 /*
682 * We look up the provider in the static table typically provided by
683 * board setup code. We first try to lookup the consumer device by
684 * name. If the consumer device was passed in as NULL or if no match
685 * was found, we try to find the consumer by directly looking it up
686 * by name.
687 *
688 * If a match is found, the provider PWM chip is looked up by name
689 * and a PWM device is requested using the PWM device per-chip index.
690 *
691 * The lookup algorithm was shamelessly taken from the clock
692 * framework:
693 *
694 * We do slightly fuzzy matching here:
695 * An entry with a NULL ID is assumed to be a wildcard.
696 * If an entry has a device ID, it must match
697 * If an entry has a connection ID, it must match
698 * Then we take the most specific entry - with the following order
699 * of precedence: dev+con > dev only > con only.
700 */
701 mutex_lock(&pwm_lookup_lock);
702
703 list_for_each_entry(p, &pwm_lookup_list, list) {
704 match = 0;
705
706 if (p->dev_id) {
707 if (!dev_id || strcmp(p->dev_id, dev_id))
708 continue;
709
710 match += 2;
711 }
712
713 if (p->con_id) {
714 if (!con_id || strcmp(p->con_id, con_id))
715 continue;
716
717 match += 1;
718 }
719
720 if (match > best) {
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200721 chosen = p;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200722
723 if (match != 3)
724 best = match;
725 else
726 break;
727 }
728 }
729
Thierry Reding655a0352015-10-05 14:38:32 +0200730 if (!chosen) {
731 pwm = ERR_PTR(-ENODEV);
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200732 goto out;
Thierry Reding655a0352015-10-05 14:38:32 +0200733 }
Alexandre Belloni3796ce12014-05-19 22:42:32 +0200734
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200735 chip = pwmchip_find_by_name(chosen->provider);
736 if (!chip)
737 goto out;
738
739 pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id);
Alexandre Belloni3796ce12014-05-19 22:42:32 +0200740 if (IS_ERR(pwm))
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200741 goto out;
Thierry Reding8138d2d2012-03-26 08:42:48 +0200742
Boris Brezillonfbd45a12016-05-17 14:27:25 +0200743 pwm->args.period = chosen->period;
744 pwm->args.polarity = chosen->polarity;
745
Geert Uytterhoeven70145f82014-08-28 11:03:14 +0200746out:
747 mutex_unlock(&pwm_lookup_lock);
Thierry Reding8138d2d2012-03-26 08:42:48 +0200748 return pwm;
749}
750EXPORT_SYMBOL_GPL(pwm_get);
751
752/**
753 * pwm_put() - release a PWM device
754 * @pwm: PWM device
755 */
756void pwm_put(struct pwm_device *pwm)
757{
758 if (!pwm)
759 return;
760
761 mutex_lock(&pwm_lock);
762
763 if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
Sachin Kamate50d3522012-08-10 16:41:13 +0530764 pr_warn("PWM device already freed\n");
Thierry Reding8138d2d2012-03-26 08:42:48 +0200765 goto out;
766 }
767
768 if (pwm->chip->ops->free)
769 pwm->chip->ops->free(pwm->chip, pwm);
770
771 pwm->label = NULL;
772
773 module_put(pwm->chip->ops->owner);
774out:
775 mutex_unlock(&pwm_lock);
776}
777EXPORT_SYMBOL_GPL(pwm_put);
778
Alexandre Courbot63543162012-08-01 19:20:58 +0900779static void devm_pwm_release(struct device *dev, void *res)
780{
781 pwm_put(*(struct pwm_device **)res);
782}
783
784/**
785 * devm_pwm_get() - resource managed pwm_get()
786 * @dev: device for PWM consumer
787 * @con_id: consumer name
788 *
789 * This function performs like pwm_get() but the acquired PWM device will
790 * automatically be released on driver detach.
Thierry Reding04883802015-07-27 11:58:32 +0200791 *
792 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
793 * error code on failure.
Alexandre Courbot63543162012-08-01 19:20:58 +0900794 */
795struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
796{
797 struct pwm_device **ptr, *pwm;
798
Wolfram Sang77f0b9d2013-06-03 22:27:17 +0200799 ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
Alexandre Courbot63543162012-08-01 19:20:58 +0900800 if (!ptr)
801 return ERR_PTR(-ENOMEM);
802
803 pwm = pwm_get(dev, con_id);
804 if (!IS_ERR(pwm)) {
805 *ptr = pwm;
806 devres_add(dev, ptr);
807 } else {
808 devres_free(ptr);
809 }
810
811 return pwm;
812}
813EXPORT_SYMBOL_GPL(devm_pwm_get);
814
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800815/**
816 * devm_of_pwm_get() - resource managed of_pwm_get()
817 * @dev: device for PWM consumer
818 * @np: device node to get the PWM from
819 * @con_id: consumer name
820 *
821 * This function performs like of_pwm_get() but the acquired PWM device will
822 * automatically be released on driver detach.
Thierry Reding04883802015-07-27 11:58:32 +0200823 *
824 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
825 * error code on failure.
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800826 */
827struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
828 const char *con_id)
829{
830 struct pwm_device **ptr, *pwm;
831
Wolfram Sang77f0b9d2013-06-03 22:27:17 +0200832 ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
Peter Ujfalusi261a5ed2012-12-21 01:43:59 -0800833 if (!ptr)
834 return ERR_PTR(-ENOMEM);
835
836 pwm = of_pwm_get(np, con_id);
837 if (!IS_ERR(pwm)) {
838 *ptr = pwm;
839 devres_add(dev, ptr);
840 } else {
841 devres_free(ptr);
842 }
843
844 return pwm;
845}
846EXPORT_SYMBOL_GPL(devm_of_pwm_get);
847
Alexandre Courbot63543162012-08-01 19:20:58 +0900848static int devm_pwm_match(struct device *dev, void *res, void *data)
849{
850 struct pwm_device **p = res;
851
852 if (WARN_ON(!p || !*p))
853 return 0;
854
855 return *p == data;
856}
857
858/**
859 * devm_pwm_put() - resource managed pwm_put()
860 * @dev: device for PWM consumer
861 * @pwm: PWM device
862 *
863 * Release a PWM previously allocated using devm_pwm_get(). Calling this
864 * function is usually not needed because devm-allocated resources are
865 * automatically released on driver detach.
866 */
867void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
868{
869 WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm));
870}
871EXPORT_SYMBOL_GPL(devm_pwm_put);
872
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100873/**
874 * pwm_can_sleep() - report whether PWM access will sleep
875 * @pwm: PWM device
876 *
Thierry Reding04883802015-07-27 11:58:32 +0200877 * Returns: True if accessing the PWM can sleep, false otherwise.
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100878 */
879bool pwm_can_sleep(struct pwm_device *pwm)
880{
Thierry Redingff01c942016-01-21 15:04:59 +0100881 return true;
Florian Vaussard6e69ab12013-01-28 15:00:57 +0100882}
883EXPORT_SYMBOL_GPL(pwm_can_sleep);
884
Thierry Reding62099abf2012-03-26 09:31:48 +0200885#ifdef CONFIG_DEBUG_FS
886static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s)
887{
888 unsigned int i;
889
890 for (i = 0; i < chip->npwm; i++) {
891 struct pwm_device *pwm = &chip->pwms[i];
892
893 seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label);
894
895 if (test_bit(PWMF_REQUESTED, &pwm->flags))
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900896 seq_puts(s, " requested");
Thierry Reding62099abf2012-03-26 09:31:48 +0200897
Boris Brezillon5c312522015-07-01 10:21:47 +0200898 if (pwm_is_enabled(pwm))
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900899 seq_puts(s, " enabled");
Thierry Reding62099abf2012-03-26 09:31:48 +0200900
Jingoo Hanadcba1e2013-12-19 13:31:24 +0900901 seq_puts(s, "\n");
Thierry Reding62099abf2012-03-26 09:31:48 +0200902 }
903}
904
905static void *pwm_seq_start(struct seq_file *s, loff_t *pos)
906{
907 mutex_lock(&pwm_lock);
908 s->private = "";
909
910 return seq_list_start(&pwm_chips, *pos);
911}
912
913static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos)
914{
915 s->private = "\n";
916
917 return seq_list_next(v, &pwm_chips, pos);
918}
919
920static void pwm_seq_stop(struct seq_file *s, void *v)
921{
922 mutex_unlock(&pwm_lock);
923}
924
925static int pwm_seq_show(struct seq_file *s, void *v)
926{
927 struct pwm_chip *chip = list_entry(v, struct pwm_chip, list);
928
929 seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private,
930 chip->dev->bus ? chip->dev->bus->name : "no-bus",
931 dev_name(chip->dev), chip->npwm,
932 (chip->npwm != 1) ? "s" : "");
933
934 if (chip->ops->dbg_show)
935 chip->ops->dbg_show(chip, s);
936 else
937 pwm_dbg_show(chip, s);
938
939 return 0;
940}
941
942static const struct seq_operations pwm_seq_ops = {
943 .start = pwm_seq_start,
944 .next = pwm_seq_next,
945 .stop = pwm_seq_stop,
946 .show = pwm_seq_show,
947};
948
949static int pwm_seq_open(struct inode *inode, struct file *file)
950{
951 return seq_open(file, &pwm_seq_ops);
952}
953
954static const struct file_operations pwm_debugfs_ops = {
955 .owner = THIS_MODULE,
956 .open = pwm_seq_open,
957 .read = seq_read,
958 .llseek = seq_lseek,
959 .release = seq_release,
960};
961
962static int __init pwm_debugfs_init(void)
963{
964 debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL,
965 &pwm_debugfs_ops);
966
967 return 0;
968}
Thierry Reding62099abf2012-03-26 09:31:48 +0200969subsys_initcall(pwm_debugfs_init);
970#endif /* CONFIG_DEBUG_FS */