core.c 21.6 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
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;

131 132 133 134 135 136 137
	/*
	 * FIXME: This should be removed once all PWM users properly make use
	 * of struct pwm_args to initialize the PWM device. As long as this is
	 * here, the PWM state and hardware state can get out of sync.
	 */
	pwm_apply_args(pwm);

138 139 140
	return 0;
}

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
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;

156
	pwm->args.period = args->args[1];
157

158
	if (args->args[2] & PWM_POLARITY_INVERTED)
159
		pwm->args.polarity = PWM_POLARITY_INVERSED;
160
	else
161
		pwm->args.polarity = PWM_POLARITY_NORMAL;
162 163 164

	return pwm;
}
165
EXPORT_SYMBOL_GPL(of_pwm_xlate_with_flags);
166

167 168
static struct pwm_device *
of_pwm_simple_xlate(struct pwm_chip *pc, const struct of_phandle_args *args)
T
Thierry Reding 已提交
169 170 171 172 173 174 175 176 177 178 179 180 181
{
	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;

182
	pwm->args.period = args->args[1];
T
Thierry Reding 已提交
183 184 185 186

	return pwm;
}

187
static void of_pwmchip_add(struct pwm_chip *chip)
T
Thierry Reding 已提交
188 189 190 191 192 193 194 195 196 197 198 199
{
	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);
}

200
static void of_pwmchip_remove(struct pwm_chip *chip)
T
Thierry Reding 已提交
201
{
202
	if (chip->dev)
T
Thierry Reding 已提交
203 204 205
		of_node_put(chip->dev->of_node);
}

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

	pwm->chip_data = data;

	return 0;
}
222
EXPORT_SYMBOL_GPL(pwm_set_chip_data);
223 224 225 226

/**
 * pwm_get_chip_data() - get private chip data for a PWM
 * @pwm: PWM device
T
Thierry Reding 已提交
227 228
 *
 * Returns: A pointer to the chip-private data for the PWM device.
229 230 231 232
 */
void *pwm_get_chip_data(struct pwm_device *pwm)
{
	return pwm ? pwm->chip_data : NULL;
S
Sascha Hauer 已提交
233
}
234
EXPORT_SYMBOL_GPL(pwm_get_chip_data);
S
Sascha Hauer 已提交
235 236

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

254
	if (!chip || !chip->dev || !chip->ops || !chip->ops->config ||
255
	    !chip->ops->enable || !chip->ops->disable || !chip->npwm)
256
		return -EINVAL;
S
Sascha Hauer 已提交
257 258 259

	mutex_lock(&pwm_lock);

260 261 262 263 264 265 266
	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 已提交
267 268 269
		goto out;
	}

270 271 272 273 274 275 276 277
	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;
278
		pwm->polarity = polarity;
279
		mutex_init(&pwm->lock);
S
Sascha Hauer 已提交
280

281 282 283 284 285 286 287
		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 已提交
288

289 290
	ret = 0;

T
Thierry Reding 已提交
291 292 293
	if (IS_ENABLED(CONFIG_OF))
		of_pwmchip_add(chip);

H
H Hartley Sweeten 已提交
294 295
	pwmchip_sysfs_export(chip);

296 297
out:
	mutex_unlock(&pwm_lock);
S
Sascha Hauer 已提交
298 299
	return ret;
}
300 301 302 303 304 305 306 307
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 已提交
308 309
 *
 * Returns: 0 on success or a negative error code on failure.
310 311 312 313 314
 */
int pwmchip_add(struct pwm_chip *chip)
{
	return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL);
}
S
Sascha Hauer 已提交
315 316 317 318 319 320 321 322
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 已提交
323 324
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
325 326 327
 */
int pwmchip_remove(struct pwm_chip *chip)
{
328
	unsigned int i;
S
Sascha Hauer 已提交
329 330 331 332
	int ret = 0;

	mutex_lock(&pwm_lock);

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

336 337 338 339
		if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
			ret = -EBUSY;
			goto out;
		}
S
Sascha Hauer 已提交
340 341
	}

342
	list_del_init(&chip->list);
T
Thierry Reding 已提交
343 344 345 346

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

347
	free_pwms(chip);
S
Sascha Hauer 已提交
348

H
H Hartley Sweeten 已提交
349 350
	pwmchip_sysfs_unexport(chip);

S
Sascha Hauer 已提交
351 352 353 354 355 356 357 358
out:
	mutex_unlock(&pwm_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(pwmchip_remove);

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

	if (pwm < 0 || pwm >= MAX_PWMS)
		return ERR_PTR(-EINVAL);
S
Sascha Hauer 已提交
374 375 376

	mutex_lock(&pwm_lock);

377 378 379
	dev = pwm_to_device(pwm);
	if (!dev) {
		dev = ERR_PTR(-EPROBE_DEFER);
S
Sascha Hauer 已提交
380 381 382
		goto out;
	}

383 384 385
	err = pwm_device_request(dev, label);
	if (err < 0)
		dev = ERR_PTR(err);
S
Sascha Hauer 已提交
386

387 388
out:
	mutex_unlock(&pwm_lock);
S
Sascha Hauer 已提交
389

390 391 392
	return dev;
}
EXPORT_SYMBOL_GPL(pwm_request);
S
Sascha Hauer 已提交
393

394 395 396 397 398 399
/**
 * 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 已提交
400 401 402
 * 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.
403 404 405 406 407 408 409
 */
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 已提交
410

411 412
	if (!chip || index >= chip->npwm)
		return ERR_PTR(-EINVAL);
S
Sascha Hauer 已提交
413

414 415
	mutex_lock(&pwm_lock);
	pwm = &chip->pwms[index];
S
Sascha Hauer 已提交
416

417 418 419 420 421
	err = pwm_device_request(pwm, label);
	if (err < 0)
		pwm = ERR_PTR(err);

	mutex_unlock(&pwm_lock);
S
Sascha Hauer 已提交
422 423
	return pwm;
}
424
EXPORT_SYMBOL_GPL(pwm_request_from_chip);
S
Sascha Hauer 已提交
425 426 427 428

/**
 * pwm_free() - free a PWM device
 * @pwm: PWM device
429 430
 *
 * This function is deprecated, use pwm_put() instead.
S
Sascha Hauer 已提交
431 432 433
 */
void pwm_free(struct pwm_device *pwm)
{
434
	pwm_put(pwm);
S
Sascha Hauer 已提交
435 436 437 438 439 440 441 442
}
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 已提交
443 444
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
445 446 447
 */
int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
{
H
H Hartley Sweeten 已提交
448 449
	int err;

450
	if (!pwm || duty_ns < 0 || period_ns <= 0 || duty_ns > period_ns)
451 452
		return -EINVAL;

H
H Hartley Sweeten 已提交
453 454 455 456 457 458 459 460
	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 已提交
461 462 463
}
EXPORT_SYMBOL_GPL(pwm_config);

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

478 479 480 481 482 483
	if (!pwm || !pwm->chip->ops)
		return -EINVAL;

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

484 485 486 487 488 489
	mutex_lock(&pwm->lock);

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

H
H Hartley Sweeten 已提交
491 492
	err = pwm->chip->ops->set_polarity(pwm->chip, pwm, polarity);
	if (err)
493
		goto unlock;
H
H Hartley Sweeten 已提交
494 495 496

	pwm->polarity = polarity;

497 498 499
unlock:
	mutex_unlock(&pwm->lock);
	return err;
500 501 502
}
EXPORT_SYMBOL_GPL(pwm_set_polarity);

S
Sascha Hauer 已提交
503 504 505
/**
 * pwm_enable() - start a PWM output toggling
 * @pwm: PWM device
T
Thierry Reding 已提交
506 507
 *
 * Returns: 0 on success or a negative error code on failure.
S
Sascha Hauer 已提交
508 509 510
 */
int pwm_enable(struct pwm_device *pwm)
{
511 512 513 514 515 516 517 518 519 520 521 522 523 524
	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 已提交
525

526
	return err;
S
Sascha Hauer 已提交
527 528 529 530 531 532 533 534 535
}
EXPORT_SYMBOL_GPL(pwm_enable);

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

T
Thierry Reding 已提交
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
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);
}

/**
559
 * of_pwm_get() - request a PWM via the PWM framework
T
Thierry Reding 已提交
560 561 562 563 564 565 566 567 568 569 570 571 572
 * @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 已提交
573 574 575
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
T
Thierry Reding 已提交
576
 */
577
struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
T
Thierry Reding 已提交
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 628 629 630 631 632 633 634
{
	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;
}
635
EXPORT_SYMBOL_GPL(of_pwm_get);
T
Thierry Reding 已提交
636

637 638 639 640 641
/**
 * pwm_add_table() - register PWM device consumers
 * @table: array of consumers to register
 * @num: number of consumers in table
 */
642
void pwm_add_table(struct pwm_lookup *table, size_t num)
643 644 645 646 647 648 649 650 651 652 653
{
	mutex_lock(&pwm_lookup_lock);

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

	mutex_unlock(&pwm_lookup_lock);
}

654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
/**
 * 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);
}

671 672 673 674 675
/**
 * pwm_get() - look up and request a PWM device
 * @dev: device for PWM consumer
 * @con_id: consumer name
 *
T
Thierry Reding 已提交
676 677 678
 * 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()).
679 680 681
 *
 * Once a PWM chip has been found the specified PWM device will be requested
 * and is ready to be used.
T
Thierry Reding 已提交
682 683 684
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
685 686 687 688
 */
struct pwm_device *pwm_get(struct device *dev, const char *con_id)
{
	struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
689
	const char *dev_id = dev ? dev_name(dev) : NULL;
690 691
	struct pwm_chip *chip = NULL;
	unsigned int best = 0;
692
	struct pwm_lookup *p, *chosen = NULL;
693 694
	unsigned int match;

T
Thierry Reding 已提交
695 696
	/* look up via DT first */
	if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
697
		return of_pwm_get(dev->of_node, con_id);
T
Thierry Reding 已提交
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 732 733 734 735 736 737 738
	/*
	 * 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) {
739
			chosen = p;
740 741 742 743 744 745 746 747

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

748 749
	if (!chosen) {
		pwm = ERR_PTR(-ENODEV);
750
		goto out;
751
	}
752

753 754 755
	chip = pwmchip_find_by_name(chosen->provider);
	if (!chip)
		goto out;
756

757 758 759
	pwm->args.period = chosen->period;
	pwm->args.polarity = chosen->polarity;

760 761 762
	pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id);
	if (IS_ERR(pwm))
		goto out;
763

764 765
out:
	mutex_unlock(&pwm_lookup_lock);
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
	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)) {
782
		pr_warn("PWM device already freed\n");
783 784 785 786 787 788 789 790 791 792 793 794 795 796
		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);

797 798 799 800 801 802 803 804 805 806 807 808
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 已提交
809 810 811
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
812 813 814 815 816
 */
struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
{
	struct pwm_device **ptr, *pwm;

817
	ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
	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);

833 834 835 836 837 838 839 840
/**
 * 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 已提交
841 842 843
 *
 * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 * error code on failure.
844 845 846 847 848 849
 */
struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
				   const char *con_id)
{
	struct pwm_device **ptr, *pwm;

850
	ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
	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);

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
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);

891 892 893 894
/**
  * pwm_can_sleep() - report whether PWM access will sleep
  * @pwm: PWM device
  *
T
Thierry Reding 已提交
895
  * Returns: True if accessing the PWM can sleep, false otherwise.
896 897 898
  */
bool pwm_can_sleep(struct pwm_device *pwm)
{
899
	return true;
900 901 902
}
EXPORT_SYMBOL_GPL(pwm_can_sleep);

T
Thierry Reding 已提交
903 904 905 906 907 908 909 910 911 912 913
#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))
914
			seq_puts(s, " requested");
T
Thierry Reding 已提交
915

916
		if (pwm_is_enabled(pwm))
917
			seq_puts(s, " enabled");
T
Thierry Reding 已提交
918

919
		seq_puts(s, "\n");
T
Thierry Reding 已提交
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 982 983 984 985 986 987 988
	}
}

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 */