core.c 21.4 KB
Newer Older
S
Sascha Hauer 已提交
1 2 3 4
/*
 * Generic pwmlib implementation
 *
 * Copyright (C) 2011 Sascha Hauer <s.hauer@pengutronix.de>
5
 * Copyright (C) 2011-2012 Avionic Design GmbH
S
Sascha Hauer 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/module.h>
#include <linux/pwm.h>
24
#include <linux/radix-tree.h>
S
Sascha Hauer 已提交
25 26 27 28 29
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/err.h>
#include <linux/slab.h>
#include <linux/device.h>
T
Thierry Reding 已提交
30 31
#include <linux/debugfs.h>
#include <linux/seq_file.h>
S
Sascha Hauer 已提交
32

33
#include <dt-bindings/pwm/pwm.h>
S
Sascha Hauer 已提交
34

35
#define MAX_PWMS 1024
36

37 38
static DEFINE_MUTEX(pwm_lookup_lock);
static LIST_HEAD(pwm_lookup_list);
S
Sascha Hauer 已提交
39
static DEFINE_MUTEX(pwm_lock);
40 41 42
static LIST_HEAD(pwm_chips);
static DECLARE_BITMAP(allocated_pwms, MAX_PWMS);
static RADIX_TREE(pwm_tree, GFP_KERNEL);
S
Sascha Hauer 已提交
43

44
static struct pwm_device *pwm_to_device(unsigned int pwm)
S
Sascha Hauer 已提交
45
{
46 47 48 49 50 51 52 53 54 55 56 57 58
	return radix_tree_lookup(&pwm_tree, pwm);
}

static int alloc_pwms(int pwm, unsigned int count)
{
	unsigned int from = 0;
	unsigned int start;

	if (pwm >= MAX_PWMS)
		return -EINVAL;

	if (pwm >= 0)
		from = pwm;
S
Sascha Hauer 已提交
59

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
	start = bitmap_find_next_zero_area(allocated_pwms, MAX_PWMS, from,
					   count, 0);

	if (pwm >= 0 && start != pwm)
		return -EEXIST;

	if (start + count > MAX_PWMS)
		return -ENOSPC;

	return start;
}

static void free_pwms(struct pwm_chip *chip)
{
	unsigned int i;

	for (i = 0; i < chip->npwm; i++) {
		struct pwm_device *pwm = &chip->pwms[i];
		radix_tree_delete(&pwm_tree, pwm->pwm);
S
Sascha Hauer 已提交
79 80
	}

81 82 83 84 85 86
	bitmap_clear(allocated_pwms, chip->base, chip->npwm);

	kfree(chip->pwms);
	chip->pwms = NULL;
}

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
static struct pwm_chip *pwmchip_find_by_name(const char *name)
{
	struct pwm_chip *chip;

	if (!name)
		return NULL;

	mutex_lock(&pwm_lock);

	list_for_each_entry(chip, &pwm_chips, list) {
		const char *chip_name = dev_name(chip->dev);

		if (chip_name && strcmp(chip_name, name) == 0) {
			mutex_unlock(&pwm_lock);
			return chip;
		}
	}

	mutex_unlock(&pwm_lock);

	return NULL;
}

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
static int pwm_device_request(struct pwm_device *pwm, const char *label)
{
	int err;

	if (test_bit(PWMF_REQUESTED, &pwm->flags))
		return -EBUSY;

	if (!try_module_get(pwm->chip->ops->owner))
		return -ENODEV;

	if (pwm->chip->ops->request) {
		err = pwm->chip->ops->request(pwm->chip, pwm);
		if (err) {
			module_put(pwm->chip->ops->owner);
			return err;
		}
	}

	set_bit(PWMF_REQUESTED, &pwm->flags);
	pwm->label = label;

	return 0;
}

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
struct pwm_device *
of_pwm_xlate_with_flags(struct pwm_chip *pc, const struct of_phandle_args *args)
{
	struct pwm_device *pwm;

	if (pc->of_pwm_n_cells < 3)
		return ERR_PTR(-EINVAL);

	if (args->args[0] >= pc->npwm)
		return ERR_PTR(-EINVAL);

	pwm = pwm_request_from_chip(pc, args->args[0], NULL);
	if (IS_ERR(pwm))
		return pwm;

	pwm_set_period(pwm, args->args[1]);

151
	if (args->args[2] & PWM_POLARITY_INVERTED)
152 153 154 155 156 157
		pwm_set_polarity(pwm, PWM_POLARITY_INVERSED);
	else
		pwm_set_polarity(pwm, PWM_POLARITY_NORMAL);

	return pwm;
}
158
EXPORT_SYMBOL_GPL(of_pwm_xlate_with_flags);
159

160 161
static struct pwm_device *
of_pwm_simple_xlate(struct pwm_chip *pc, const struct of_phandle_args *args)
T
Thierry Reding 已提交
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
{
	struct pwm_device *pwm;

	if (pc->of_pwm_n_cells < 2)
		return ERR_PTR(-EINVAL);

	if (args->args[0] >= pc->npwm)
		return ERR_PTR(-EINVAL);

	pwm = pwm_request_from_chip(pc, args->args[0], NULL);
	if (IS_ERR(pwm))
		return pwm;

	pwm_set_period(pwm, args->args[1]);

	return pwm;
}

180
static void of_pwmchip_add(struct pwm_chip *chip)
T
Thierry Reding 已提交
181 182 183 184 185 186 187 188 189 190 191 192
{
	if (!chip->dev || !chip->dev->of_node)
		return;

	if (!chip->of_xlate) {
		chip->of_xlate = of_pwm_simple_xlate;
		chip->of_pwm_n_cells = 2;
	}

	of_node_get(chip->dev->of_node);
}

193
static void of_pwmchip_remove(struct pwm_chip *chip)
T
Thierry Reding 已提交
194
{
195
	if (chip->dev)
T
Thierry Reding 已提交
196 197 198
		of_node_put(chip->dev->of_node);
}

199 200 201 202
/**
 * pwm_set_chip_data() - set private chip data for a PWM
 * @pwm: PWM device
 * @data: pointer to chip-specific data
T
Thierry Reding 已提交
203 204
 *
 * Returns: 0 on success or a negative error code on failure.
205 206 207 208 209 210 211 212 213 214
 */
int pwm_set_chip_data(struct pwm_device *pwm, void *data)
{
	if (!pwm)
		return -EINVAL;

	pwm->chip_data = data;

	return 0;
}
215
EXPORT_SYMBOL_GPL(pwm_set_chip_data);
216 217 218 219

/**
 * pwm_get_chip_data() - get private chip data for a PWM
 * @pwm: PWM device
T
Thierry Reding 已提交
220 221
 *
 * Returns: A pointer to the chip-private data for the PWM device.
222 223 224 225
 */
void *pwm_get_chip_data(struct pwm_device *pwm)
{
	return pwm ? pwm->chip_data : NULL;
S
Sascha Hauer 已提交
226
}
227
EXPORT_SYMBOL_GPL(pwm_get_chip_data);
S
Sascha Hauer 已提交
228 229

/**
230
 * pwmchip_add_with_polarity() - register a new PWM chip
S
Sascha Hauer 已提交
231
 * @chip: the PWM chip to add
232
 * @polarity: initial polarity of PWM channels
233 234
 *
 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
235 236
 * will be used. The initial polarity for all channels is specified by the
 * @polarity parameter.
T
Thierry Reding 已提交
237 238
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
239
 */
240 241
int pwmchip_add_with_polarity(struct pwm_chip *chip,
			      enum pwm_polarity polarity)
S
Sascha Hauer 已提交
242 243
{
	struct pwm_device *pwm;
244 245
	unsigned int i;
	int ret;
S
Sascha Hauer 已提交
246

247
	if (!chip || !chip->dev || !chip->ops || !chip->ops->config ||
248
	    !chip->ops->enable || !chip->ops->disable || !chip->npwm)
249
		return -EINVAL;
S
Sascha Hauer 已提交
250 251 252

	mutex_lock(&pwm_lock);

253 254 255 256 257 258 259
	ret = alloc_pwms(chip->base, chip->npwm);
	if (ret < 0)
		goto out;

	chip->pwms = kzalloc(chip->npwm * sizeof(*pwm), GFP_KERNEL);
	if (!chip->pwms) {
		ret = -ENOMEM;
S
Sascha Hauer 已提交
260 261 262
		goto out;
	}

263 264 265 266 267 268 269 270
	chip->base = ret;

	for (i = 0; i < chip->npwm; i++) {
		pwm = &chip->pwms[i];

		pwm->chip = chip;
		pwm->pwm = chip->base + i;
		pwm->hwpwm = i;
271
		pwm->polarity = polarity;
272
		mutex_init(&pwm->lock);
S
Sascha Hauer 已提交
273

274 275 276 277 278 279 280
		radix_tree_insert(&pwm_tree, pwm->pwm, pwm);
	}

	bitmap_set(allocated_pwms, chip->base, chip->npwm);

	INIT_LIST_HEAD(&chip->list);
	list_add(&chip->list, &pwm_chips);
S
Sascha Hauer 已提交
281

282 283
	ret = 0;

T
Thierry Reding 已提交
284 285 286
	if (IS_ENABLED(CONFIG_OF))
		of_pwmchip_add(chip);

H
H Hartley Sweeten 已提交
287 288
	pwmchip_sysfs_export(chip);

289 290
out:
	mutex_unlock(&pwm_lock);
S
Sascha Hauer 已提交
291 292
	return ret;
}
293 294 295 296 297 298 299 300
EXPORT_SYMBOL_GPL(pwmchip_add_with_polarity);

/**
 * pwmchip_add() - register a new PWM chip
 * @chip: the PWM chip to add
 *
 * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
 * will be used. The initial polarity for all channels is normal.
T
Thierry Reding 已提交
301 302
 *
 * Returns: 0 on success or a negative error code on failure.
303 304 305 306 307
 */
int pwmchip_add(struct pwm_chip *chip)
{
	return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL);
}
S
Sascha Hauer 已提交
308 309 310 311 312 313 314 315
EXPORT_SYMBOL_GPL(pwmchip_add);

/**
 * pwmchip_remove() - remove a PWM chip
 * @chip: the PWM chip to remove
 *
 * Removes a PWM chip. This function may return busy if the PWM chip provides
 * a PWM device that is still requested.
T
Thierry Reding 已提交
316 317
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
318 319 320
 */
int pwmchip_remove(struct pwm_chip *chip)
{
321
	unsigned int i;
S
Sascha Hauer 已提交
322 323 324 325
	int ret = 0;

	mutex_lock(&pwm_lock);

326 327
	for (i = 0; i < chip->npwm; i++) {
		struct pwm_device *pwm = &chip->pwms[i];
S
Sascha Hauer 已提交
328

329 330 331 332
		if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
			ret = -EBUSY;
			goto out;
		}
S
Sascha Hauer 已提交
333 334
	}

335
	list_del_init(&chip->list);
T
Thierry Reding 已提交
336 337 338 339

	if (IS_ENABLED(CONFIG_OF))
		of_pwmchip_remove(chip);

340
	free_pwms(chip);
S
Sascha Hauer 已提交
341

H
H Hartley Sweeten 已提交
342 343
	pwmchip_sysfs_unexport(chip);

S
Sascha Hauer 已提交
344 345 346 347 348 349 350 351
out:
	mutex_unlock(&pwm_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(pwmchip_remove);

/**
 * pwm_request() - request a PWM device
T
Thierry Reding 已提交
352
 * @pwm: global PWM device index
S
Sascha Hauer 已提交
353
 * @label: PWM device label
354 355
 *
 * This function is deprecated, use pwm_get() instead.
T
Thierry Reding 已提交
356 357 358
 *
 * Returns: A pointer to a PWM device or an ERR_PTR()-encoded error code on
 * failure.
S
Sascha Hauer 已提交
359
 */
360
struct pwm_device *pwm_request(int pwm, const char *label)
S
Sascha Hauer 已提交
361
{
362 363 364 365 366
	struct pwm_device *dev;
	int err;

	if (pwm < 0 || pwm >= MAX_PWMS)
		return ERR_PTR(-EINVAL);
S
Sascha Hauer 已提交
367 368 369

	mutex_lock(&pwm_lock);

370 371 372
	dev = pwm_to_device(pwm);
	if (!dev) {
		dev = ERR_PTR(-EPROBE_DEFER);
S
Sascha Hauer 已提交
373 374 375
		goto out;
	}

376 377 378
	err = pwm_device_request(dev, label);
	if (err < 0)
		dev = ERR_PTR(err);
S
Sascha Hauer 已提交
379

380 381
out:
	mutex_unlock(&pwm_lock);
S
Sascha Hauer 已提交
382

383 384 385
	return dev;
}
EXPORT_SYMBOL_GPL(pwm_request);
S
Sascha Hauer 已提交
386

387 388 389 390 391 392
/**
 * pwm_request_from_chip() - request a PWM device relative to a PWM chip
 * @chip: PWM chip
 * @index: per-chip index of the PWM to request
 * @label: a literal description string of this PWM
 *
T
Thierry Reding 已提交
393 394 395
 * Returns: A pointer to the PWM device at the given index of the given PWM
 * chip. A negative error code is returned if the index is not valid for the
 * specified PWM chip or if the PWM device cannot be requested.
396 397 398 399 400 401 402
 */
struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
					 unsigned int index,
					 const char *label)
{
	struct pwm_device *pwm;
	int err;
S
Sascha Hauer 已提交
403

404 405
	if (!chip || index >= chip->npwm)
		return ERR_PTR(-EINVAL);
S
Sascha Hauer 已提交
406

407 408
	mutex_lock(&pwm_lock);
	pwm = &chip->pwms[index];
S
Sascha Hauer 已提交
409

410 411 412 413 414
	err = pwm_device_request(pwm, label);
	if (err < 0)
		pwm = ERR_PTR(err);

	mutex_unlock(&pwm_lock);
S
Sascha Hauer 已提交
415 416
	return pwm;
}
417
EXPORT_SYMBOL_GPL(pwm_request_from_chip);
S
Sascha Hauer 已提交
418 419 420 421

/**
 * pwm_free() - free a PWM device
 * @pwm: PWM device
422 423
 *
 * This function is deprecated, use pwm_put() instead.
S
Sascha Hauer 已提交
424 425 426
 */
void pwm_free(struct pwm_device *pwm)
{
427
	pwm_put(pwm);
S
Sascha Hauer 已提交
428 429 430 431 432 433 434 435
}
EXPORT_SYMBOL_GPL(pwm_free);

/**
 * pwm_config() - change a PWM device configuration
 * @pwm: PWM device
 * @duty_ns: "on" time (in nanoseconds)
 * @period_ns: duration (in nanoseconds) of one cycle
T
Thierry Reding 已提交
436 437
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
438 439 440
 */
int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
{
H
H Hartley Sweeten 已提交
441 442
	int err;

443
	if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns)
444 445
		return -EINVAL;

H
H Hartley Sweeten 已提交
446 447 448 449 450 451 452 453
	err = pwm->chip->ops->config(pwm->chip, pwm, duty_ns, period_ns);
	if (err)
		return err;

	pwm->duty_cycle = duty_ns;
	pwm->period = period_ns;

	return 0;
S
Sascha Hauer 已提交
454 455 456
}
EXPORT_SYMBOL_GPL(pwm_config);

457 458 459 460 461
/**
 * pwm_set_polarity() - configure the polarity of a PWM signal
 * @pwm: PWM device
 * @polarity: new polarity of the PWM signal
 *
T
Thierry Reding 已提交
462 463 464 465
 * Note that the polarity cannot be configured while the PWM device is
 * enabled.
 *
 * Returns: 0 on success or a negative error code on failure.
466 467 468
 */
int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity)
{
H
H Hartley Sweeten 已提交
469 470
	int err;

471 472 473 474 475 476
	if (!pwm || !pwm->chip->ops)
		return -EINVAL;

	if (!pwm->chip->ops->set_polarity)
		return -ENOSYS;

477 478 479 480 481 482
	mutex_lock(&pwm->lock);

	if (pwm_is_enabled(pwm)) {
		err = -EBUSY;
		goto unlock;
	}
483

H
H Hartley Sweeten 已提交
484 485
	err = pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity);
	if (err)
486
		goto unlock;
H
H Hartley Sweeten 已提交
487 488 489

	pwm->polarity = polarity;

490 491 492
unlock:
	mutex_unlock(&pwm->lock);
	return err;
493 494 495
}
EXPORT_SYMBOL_GPL(pwm_set_polarity);

S
Sascha Hauer 已提交
496 497 498
/**
 * pwm_enable() - start a PWM output toggling
 * @pwm: PWM device
T
Thierry Reding 已提交
499 500
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
501 502 503
 */
int pwm_enable(struct pwm_device *pwm)
{
504 505 506 507 508 509 510 511 512 513 514 515 516 517
	int err = 0;

	if (!pwm)
		return -EINVAL;

	mutex_lock(&pwm->lock);

	if (!test_and_set_bit(PWMF_ENABLED, &pwm->flags)) {
		err = pwm->chip->ops->enable(pwm->chip, pwm);
		if (err)
			clear_bit(PWMF_ENABLED, &pwm->flags);
	}

	mutex_unlock(&pwm->lock);
S
Sascha Hauer 已提交
518

519
	return err;
S
Sascha Hauer 已提交
520 521 522 523 524 525 526 527 528
}
EXPORT_SYMBOL_GPL(pwm_enable);

/**
 * pwm_disable() - stop a PWM output toggling
 * @pwm: PWM device
 */
void pwm_disable(struct pwm_device *pwm)
{
529 530
	if (pwm && test_and_clear_bit(PWMF_ENABLED, &pwm->flags))
		pwm->chip->ops->disable(pwm->chip, pwm);
S
Sascha Hauer 已提交
531 532
}
EXPORT_SYMBOL_GPL(pwm_disable);
T
Thierry Reding 已提交
533

T
Thierry Reding 已提交
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
static struct pwm_chip *of_node_to_pwmchip(struct device_node *np)
{
	struct pwm_chip *chip;

	mutex_lock(&pwm_lock);

	list_for_each_entry(chip, &pwm_chips, list)
		if (chip->dev && chip->dev->of_node == np) {
			mutex_unlock(&pwm_lock);
			return chip;
		}

	mutex_unlock(&pwm_lock);

	return ERR_PTR(-EPROBE_DEFER);
}

/**
552
 * of_pwm_get() - request a PWM via the PWM framework
T
Thierry Reding 已提交
553 554 555 556 557 558 559 560 561 562 563 564 565
 * @np: device node to get the PWM from
 * @con_id: consumer name
 *
 * Returns the PWM device parsed from the phandle and index specified in the
 * "pwms" property of a device tree node or a negative error-code on failure.
 * Values parsed from the device tree are stored in the returned PWM device
 * object.
 *
 * If con_id is NULL, the first PWM device listed in the "pwms" property will
 * be requested. Otherwise the "pwm-names" property is used to do a reverse
 * lookup of the PWM index. This also means that the "pwm-names" property
 * becomes mandatory for devices that look up the PWM device via the con_id
 * parameter.
T
Thierry Reding 已提交
566 567 568
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
T
Thierry Reding 已提交
569
 */
570
struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
T
Thierry Reding 已提交
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
{
	struct pwm_device *pwm = NULL;
	struct of_phandle_args args;
	struct pwm_chip *pc;
	int index = 0;
	int err;

	if (con_id) {
		index = of_property_match_string(np, "pwm-names", con_id);
		if (index < 0)
			return ERR_PTR(index);
	}

	err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index,
					 &args);
	if (err) {
		pr_debug("%s(): can't parse \"pwms\" property\n", __func__);
		return ERR_PTR(err);
	}

	pc = of_node_to_pwmchip(args.np);
	if (IS_ERR(pc)) {
		pr_debug("%s(): PWM chip not found\n", __func__);
		pwm = ERR_CAST(pc);
		goto put;
	}

	if (args.args_count != pc->of_pwm_n_cells) {
		pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name,
			 args.np->full_name);
		pwm = ERR_PTR(-EINVAL);
		goto put;
	}

	pwm = pc->of_xlate(pc, &args);
	if (IS_ERR(pwm))
		goto put;

	/*
	 * If a consumer name was not given, try to look it up from the
	 * "pwm-names" property if it exists. Otherwise use the name of
	 * the user device node.
	 */
	if (!con_id) {
		err = of_property_read_string_index(np, "pwm-names", index,
						    &con_id);
		if (err < 0)
			con_id = np->name;
	}

	pwm->label = con_id;

put:
	of_node_put(args.np);

	return pwm;
}
628
EXPORT_SYMBOL_GPL(of_pwm_get);
T
Thierry Reding 已提交
629

630 631 632 633 634
/**
 * pwm_add_table() - register PWM device consumers
 * @table: array of consumers to register
 * @num: number of consumers in table
 */
635
void pwm_add_table(struct pwm_lookup *table, size_t num)
636 637 638 639 640 641 642 643 644 645 646
{
	mutex_lock(&pwm_lookup_lock);

	while (num--) {
		list_add_tail(&table->list, &pwm_lookup_list);
		table++;
	}

	mutex_unlock(&pwm_lookup_lock);
}

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/**
 * pwm_remove_table() - unregister PWM device consumers
 * @table: array of consumers to unregister
 * @num: number of consumers in table
 */
void pwm_remove_table(struct pwm_lookup *table, size_t num)
{
	mutex_lock(&pwm_lookup_lock);

	while (num--) {
		list_del(&table->list);
		table++;
	}

	mutex_unlock(&pwm_lookup_lock);
}

664 665 666 667 668
/**
 * pwm_get() - look up and request a PWM device
 * @dev: device for PWM consumer
 * @con_id: consumer name
 *
T
Thierry Reding 已提交
669 670 671
 * Lookup is first attempted using DT. If the device was not instantiated from
 * a device tree, a PWM chip and a relative index is looked up via a table
 * supplied by board setup code (see pwm_add_table()).
672 673 674
 *
 * Once a PWM chip has been found the specified PWM device will be requested
 * and is ready to be used.
T
Thierry Reding 已提交
675 676 677
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
678 679 680 681
 */
struct pwm_device *pwm_get(struct device *dev, const char *con_id)
{
	struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
682
	const char *dev_id = dev ? dev_name(dev) : NULL;
683 684
	struct pwm_chip *chip = NULL;
	unsigned int best = 0;
685
	struct pwm_lookup *p, *chosen = NULL;
686 687
	unsigned int match;

T
Thierry Reding 已提交
688 689
	/* look up via DT first */
	if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
690
		return of_pwm_get(dev->of_node, con_id);
T
Thierry Reding 已提交
691

692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
	/*
	 * We look up the provider in the static table typically provided by
	 * board setup code. We first try to lookup the consumer device by
	 * name. If the consumer device was passed in as NULL or if no match
	 * was found, we try to find the consumer by directly looking it up
	 * by name.
	 *
	 * If a match is found, the provider PWM chip is looked up by name
	 * and a PWM device is requested using the PWM device per-chip index.
	 *
	 * The lookup algorithm was shamelessly taken from the clock
	 * framework:
	 *
	 * We do slightly fuzzy matching here:
	 *  An entry with a NULL ID is assumed to be a wildcard.
	 *  If an entry has a device ID, it must match
	 *  If an entry has a connection ID, it must match
	 * Then we take the most specific entry - with the following order
	 * of precedence: dev+con > dev only > con only.
	 */
	mutex_lock(&pwm_lookup_lock);

	list_for_each_entry(p, &pwm_lookup_list, list) {
		match = 0;

		if (p->dev_id) {
			if (!dev_id || strcmp(p->dev_id, dev_id))
				continue;

			match += 2;
		}

		if (p->con_id) {
			if (!con_id || strcmp(p->con_id, con_id))
				continue;

			match += 1;
		}

		if (match > best) {
732
			chosen = p;
733 734 735 736 737 738 739 740

			if (match != 3)
				best = match;
			else
				break;
		}
	}

741 742
	if (!chosen) {
		pwm = ERR_PTR(-ENODEV);
743
		goto out;
744
	}
745

746 747 748
	chip = pwmchip_find_by_name(chosen->provider);
	if (!chip)
		goto out;
749

750 751 752
	pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id);
	if (IS_ERR(pwm))
		goto out;
753

754 755
	pwm_set_period(pwm, chosen->period);
	pwm_set_polarity(pwm, chosen->polarity);
756

757 758
out:
	mutex_unlock(&pwm_lookup_lock);
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
	return pwm;
}
EXPORT_SYMBOL_GPL(pwm_get);

/**
 * pwm_put() - release a PWM device
 * @pwm: PWM device
 */
void pwm_put(struct pwm_device *pwm)
{
	if (!pwm)
		return;

	mutex_lock(&pwm_lock);

	if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
775
		pr_warn("PWM device already freed\n");
776 777 778 779 780 781 782 783 784 785 786 787 788 789
		goto out;
	}

	if (pwm->chip->ops->free)
		pwm->chip->ops->free(pwm->chip, pwm);

	pwm->label = NULL;

	module_put(pwm->chip->ops->owner);
out:
	mutex_unlock(&pwm_lock);
}
EXPORT_SYMBOL_GPL(pwm_put);

790 791 792 793 794 795 796 797 798 799 800 801
static void devm_pwm_release(struct device *dev, void *res)
{
	pwm_put(*(struct pwm_device **)res);
}

/**
 * devm_pwm_get() - resource managed pwm_get()
 * @dev: device for PWM consumer
 * @con_id: consumer name
 *
 * This function performs like pwm_get() but the acquired PWM device will
 * automatically be released on driver detach.
T
Thierry Reding 已提交
802 803 804
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
805 806 807 808 809
 */
struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
{
	struct pwm_device **ptr, *pwm;

810
	ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
	if (!ptr)
		return ERR_PTR(-ENOMEM);

	pwm = pwm_get(dev, con_id);
	if (!IS_ERR(pwm)) {
		*ptr = pwm;
		devres_add(dev, ptr);
	} else {
		devres_free(ptr);
	}

	return pwm;
}
EXPORT_SYMBOL_GPL(devm_pwm_get);

826 827 828 829 830 831 832 833
/**
 * devm_of_pwm_get() - resource managed of_pwm_get()
 * @dev: device for PWM consumer
 * @np: device node to get the PWM from
 * @con_id: consumer name
 *
 * This function performs like of_pwm_get() but the acquired PWM device will
 * automatically be released on driver detach.
T
Thierry Reding 已提交
834 835 836
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
837 838 839 840 841 842
 */
struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
				   const char *con_id)
{
	struct pwm_device **ptr, *pwm;

843
	ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
	if (!ptr)
		return ERR_PTR(-ENOMEM);

	pwm = of_pwm_get(np, con_id);
	if (!IS_ERR(pwm)) {
		*ptr = pwm;
		devres_add(dev, ptr);
	} else {
		devres_free(ptr);
	}

	return pwm;
}
EXPORT_SYMBOL_GPL(devm_of_pwm_get);

859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
static int devm_pwm_match(struct device *dev, void *res, void *data)
{
	struct pwm_device **p = res;

	if (WARN_ON(!p || !*p))
		return 0;

	return *p == data;
}

/**
 * devm_pwm_put() - resource managed pwm_put()
 * @dev: device for PWM consumer
 * @pwm: PWM device
 *
 * Release a PWM previously allocated using devm_pwm_get(). Calling this
 * function is usually not needed because devm-allocated resources are
 * automatically released on driver detach.
 */
void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
{
	WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm));
}
EXPORT_SYMBOL_GPL(devm_pwm_put);

884 885 886 887
/**
  * pwm_can_sleep() - report whether PWM access will sleep
  * @pwm: PWM device
  *
T
Thierry Reding 已提交
888
  * Returns: True if accessing the PWM can sleep, false otherwise.
889 890 891
  */
bool pwm_can_sleep(struct pwm_device *pwm)
{
892
	return true;
893 894 895
}
EXPORT_SYMBOL_GPL(pwm_can_sleep);

T
Thierry Reding 已提交
896 897 898 899 900 901 902 903 904 905 906
#ifdef CONFIG_DEBUG_FS
static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s)
{
	unsigned int i;

	for (i = 0; i < chip->npwm; i++) {
		struct pwm_device *pwm = &chip->pwms[i];

		seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label);

		if (test_bit(PWMF_REQUESTED, &pwm->flags))
907
			seq_puts(s, " requested");
T
Thierry Reding 已提交
908

909
		if (pwm_is_enabled(pwm))
910
			seq_puts(s, " enabled");
T
Thierry Reding 已提交
911

912
		seq_puts(s, "\n");
T
Thierry Reding 已提交
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
	}
}

static void *pwm_seq_start(struct seq_file *s, loff_t *pos)
{
	mutex_lock(&pwm_lock);
	s->private = "";

	return seq_list_start(&pwm_chips, *pos);
}

static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos)
{
	s->private = "\n";

	return seq_list_next(v, &pwm_chips, pos);
}

static void pwm_seq_stop(struct seq_file *s, void *v)
{
	mutex_unlock(&pwm_lock);
}

static int pwm_seq_show(struct seq_file *s, void *v)
{
	struct pwm_chip *chip = list_entry(v, struct pwm_chip, list);

	seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private,
		   chip->dev->bus ? chip->dev->bus->name : "no-bus",
		   dev_name(chip->dev), chip->npwm,
		   (chip->npwm != 1) ? "s" : "");

	if (chip->ops->dbg_show)
		chip->ops->dbg_show(chip, s);
	else
		pwm_dbg_show(chip, s);

	return 0;
}

static const struct seq_operations pwm_seq_ops = {
	.start = pwm_seq_start,
	.next = pwm_seq_next,
	.stop = pwm_seq_stop,
	.show = pwm_seq_show,
};

static int pwm_seq_open(struct inode *inode, struct file *file)
{
	return seq_open(file, &pwm_seq_ops);
}

static const struct file_operations pwm_debugfs_ops = {
	.owner = THIS_MODULE,
	.open = pwm_seq_open,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = seq_release,
};

static int __init pwm_debugfs_init(void)
{
	debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL,
			    &pwm_debugfs_ops);

	return 0;
}
subsys_initcall(pwm_debugfs_init);
#endif /* CONFIG_DEBUG_FS */