drivers/pwm/core.c

   1 /*
   2  * Generic pwmlib implementation
   3  *
   4  * Copyright (C) 2011 Sascha Hauer <s.hauer@pengutronix.de>
   5  * Copyright (C) 2011-2012 Avionic Design GmbH
   6  *
   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>
  24 #include <linux/radix-tree.h>
  25 #include <linux/list.h>
  26 #include <linux/mutex.h>
  27 #include <linux/err.h>
  28 #include <linux/slab.h>
  29 #include <linux/device.h>
  30 #include <linux/debugfs.h>
  31 #include <linux/seq_file.h>
  32
  33 #include <dt-bindings/pwm/pwm.h>
  34
  35 #define MAX_PWMS 1024
  36
  37 static DEFINE_MUTEX(pwm_lookup_lock);
  38 static LIST_HEAD(pwm_lookup_list);
  39 static DEFINE_MUTEX(pwm_lock);
  40 static LIST_HEAD(pwm_chips);
  41 static DECLARE_BITMAP(allocated_pwms, MAX_PWMS);
  42 static RADIX_TREE(pwm_tree, GFP_KERNEL);
  43
  44 static struct pwm_device *pwm_to_device(unsigned int pwm)
  45 {
  46         return radix_tree_lookup(&pwm_tree, pwm);
  47 }
  48
  49 static 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
  72 static 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
  79                 radix_tree_delete(&pwm_tree, pwm->pwm);
  80         }
  81
  82         bitmap_clear(allocated_pwms, chip->base, chip->npwm);
  83
  84         kfree(chip->pwms);
  85         chip->pwms = NULL;
  86 }
  87
  88 static struct pwm_chip *pwmchip_find_by_name(const char *name)
  89 {
  90         struct pwm_chip *chip;
  91
  92         if (!name)
  93                 return NULL;
  94
  95         mutex_lock(&pwm_lock);
  96
  97         list_for_each_entry(chip, &pwm_chips, list) {
  98                 const char *chip_name = dev_name(chip->dev);
  99
 100                 if (chip_name && strcmp(chip_name, name) == 0) {
 101                         mutex_unlock(&pwm_lock);
 102                         return chip;
 103                 }
 104         }
 105
 106         mutex_unlock(&pwm_lock);
 107
 108         return NULL;
 109 }
 110
 111 static int pwm_device_request(struct pwm_device *pwm, const char *label)
 112 {
 113         int err;
 114
 115         if (test_bit(PWMF_REQUESTED, &pwm->flags))
 116                 return -EBUSY;
 117
 118         if (!try_module_get(pwm->chip->ops->owner))
 119                 return -ENODEV;
 120
 121         if (pwm->chip->ops->request) {
 122                 err = pwm->chip->ops->request(pwm->chip, pwm);
 123                 if (err) {
 124                         module_put(pwm->chip->ops->owner);
 125                         return err;
 126                 }
 127         }
 128
 129         set_bit(PWMF_REQUESTED, &pwm->flags);
 130         pwm->label = label;
 131
 132         return 0;
 133 }
 134
 135 struct pwm_device *
 136 of_pwm_xlate_with_flags(struct pwm_chip *pc, const struct of_phandle_args *args)
 137 {
 138         struct pwm_device *pwm;
 139
 140         if (pc->of_pwm_n_cells < 3)
 141                 return ERR_PTR(-EINVAL);
 142
 143         if (args->args[0] >= pc->npwm)
 144                 return ERR_PTR(-EINVAL);
 145
 146         pwm = pwm_request_from_chip(pc, args->args[0], NULL);
 147         if (IS_ERR(pwm))
 148                 return pwm;
 149
 150         pwm->args.period = args->args[1];
 151
 152         if (args->args[2] & PWM_POLARITY_INVERTED)
 153                 pwm->args.polarity = PWM_POLARITY_INVERSED;
 154         else
 155                 pwm->args.polarity = PWM_POLARITY_NORMAL;
 156
 157         return pwm;
 158 }
 159 EXPORT_SYMBOL_GPL(of_pwm_xlate_with_flags);
 160
 161 static struct pwm_device *
 162 of_pwm_simple_xlate(struct pwm_chip *pc, const struct of_phandle_args *args)
 163 {
 164         struct pwm_device *pwm;
 165
 166         if (pc->of_pwm_n_cells < 2)
 167                 return ERR_PTR(-EINVAL);
 168
 169         if (args->args[0] >= pc->npwm)
 170                 return ERR_PTR(-EINVAL);
 171
 172         pwm = pwm_request_from_chip(pc, args->args[0], NULL);
 173         if (IS_ERR(pwm))
 174                 return pwm;
 175
 176         pwm->args.period = args->args[1];
 177
 178         return pwm;
 179 }
 180
 181 static void of_pwmchip_add(struct pwm_chip *chip)
 182 {
 183         if (!chip->dev || !chip->dev->of_node)
 184                 return;
 185
 186         if (!chip->of_xlate) {
 187                 chip->of_xlate = of_pwm_simple_xlate;
 188                 chip->of_pwm_n_cells = 2;
 189         }
 190
 191         of_node_get(chip->dev->of_node);
 192 }
 193
 194 static void of_pwmchip_remove(struct pwm_chip *chip)
 195 {
 196         if (chip->dev)
 197                 of_node_put(chip->dev->of_node);
 198 }
 199
 200 /**
 201  * pwm_set_chip_data() - set private chip data for a PWM
 202  * @pwm: PWM device
 203  * @data: pointer to chip-specific data
 204  *
 205  * Returns: 0 on success or a negative error code on failure.
 206  */
 207 int pwm_set_chip_data(struct pwm_device *pwm, void *data)
 208 {
 209         if (!pwm)
 210                 return -EINVAL;
 211
 212         pwm->chip_data = data;
 213
 214         return 0;
 215 }
 216 EXPORT_SYMBOL_GPL(pwm_set_chip_data);
 217
 218 /**
 219  * pwm_get_chip_data() - get private chip data for a PWM
 220  * @pwm: PWM device
 221  *
 222  * Returns: A pointer to the chip-private data for the PWM device.
 223  */
 224 void *pwm_get_chip_data(struct pwm_device *pwm)
 225 {
 226         return pwm ? pwm->chip_data : NULL;
 227 }
 228 EXPORT_SYMBOL_GPL(pwm_get_chip_data);
 229
 230 static bool pwm_ops_check(const struct pwm_ops *ops)
 231 {
 232         /* driver supports legacy, non-atomic operation */
 233         if (ops->config && ops->enable && ops->disable)
 234                 return true;
 235
 236         /* driver supports atomic operation */
 237         if (ops->apply)
 238                 return true;
 239
 240         return false;
 241 }
 242
 243 /**
 244  * pwmchip_add_with_polarity() - register a new PWM chip
 245  * @chip: the PWM chip to add
 246  * @polarity: initial polarity of PWM channels
 247  *
 248  * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
 249  * will be used. The initial polarity for all channels is specified by the
 250  * @polarity parameter.
 251  *
 252  * Returns: 0 on success or a negative error code on failure.
 253  */
 254 int pwmchip_add_with_polarity(struct pwm_chip *chip,
 255                               enum pwm_polarity polarity)
 256 {
 257         struct pwm_device *pwm;
 258         unsigned int i;
 259         int ret;
 260
 261         if (!chip || !chip->dev || !chip->ops || !chip->npwm)
 262                 return -EINVAL;
 263
 264         if (!pwm_ops_check(chip->ops))
 265                 return -EINVAL;
 266
 267         mutex_lock(&pwm_lock);
 268
 269         ret = alloc_pwms(chip->base, chip->npwm);
 270         if (ret < 0)
 271                 goto out;
 272
 273         chip->pwms = kcalloc(chip->npwm, sizeof(*pwm), GFP_KERNEL);
 274         if (!chip->pwms) {
 275                 ret = -ENOMEM;
 276                 goto out;
 277         }
 278
 279         chip->base = ret;
 280
 281         for (i = 0; i < chip->npwm; i++) {
 282                 pwm = &chip->pwms[i];
 283
 284                 pwm->chip = chip;
 285                 pwm->pwm = chip->base + i;
 286                 pwm->hwpwm = i;
 287                 pwm->state.polarity = polarity;
 288
 289                 if (chip->ops->get_state)
 290                         chip->ops->get_state(chip, pwm, &pwm->state);
 291
 292                 radix_tree_insert(&pwm_tree, pwm->pwm, pwm);
 293         }
 294
 295         bitmap_set(allocated_pwms, chip->base, chip->npwm);
 296
 297         INIT_LIST_HEAD(&chip->list);
 298         list_add(&chip->list, &pwm_chips);
 299
 300         ret = 0;
 301
 302         if (IS_ENABLED(CONFIG_OF))
 303                 of_pwmchip_add(chip);
 304
 305         pwmchip_sysfs_export(chip);
 306
 307 out:
 308         mutex_unlock(&pwm_lock);
 309         return ret;
 310 }
 311 EXPORT_SYMBOL_GPL(pwmchip_add_with_polarity);
 312
 313 /**
 314  * pwmchip_add() - register a new PWM chip
 315  * @chip: the PWM chip to add
 316  *
 317  * Register a new PWM chip. If chip->base < 0 then a dynamically assigned base
 318  * will be used. The initial polarity for all channels is normal.
 319  *
 320  * Returns: 0 on success or a negative error code on failure.
 321  */
 322 int pwmchip_add(struct pwm_chip *chip)
 323 {
 324         return pwmchip_add_with_polarity(chip, PWM_POLARITY_NORMAL);
 325 }
 326 EXPORT_SYMBOL_GPL(pwmchip_add);
 327
 328 /**
 329  * pwmchip_remove() - remove a PWM chip
 330  * @chip: the PWM chip to remove
 331  *
 332  * Removes a PWM chip. This function may return busy if the PWM chip provides
 333  * a PWM device that is still requested.
 334  *
 335  * Returns: 0 on success or a negative error code on failure.
 336  */
 337 int pwmchip_remove(struct pwm_chip *chip)
 338 {
 339         unsigned int i;
 340         int ret = 0;
 341
 342         pwmchip_sysfs_unexport_children(chip);
 343
 344         mutex_lock(&pwm_lock);
 345
 346         for (i = 0; i < chip->npwm; i++) {
 347                 struct pwm_device *pwm = &chip->pwms[i];
 348
 349                 if (test_bit(PWMF_REQUESTED, &pwm->flags)) {
 350                         ret = -EBUSY;
 351                         goto out;
 352                 }
 353         }
 354
 355         list_del_init(&chip->list);
 356
 357         if (IS_ENABLED(CONFIG_OF))
 358                 of_pwmchip_remove(chip);
 359
 360         free_pwms(chip);
 361
 362         pwmchip_sysfs_unexport(chip);
 363
 364 out:
 365         mutex_unlock(&pwm_lock);
 366         return ret;
 367 }
 368 EXPORT_SYMBOL_GPL(pwmchip_remove);
 369
 370 /**
 371  * pwm_request() - request a PWM device
 372  * @pwm: global PWM device index
 373  * @label: PWM device label
 374  *
 375  * This function is deprecated, use pwm_get() instead.
 376  *
 377  * Returns: A pointer to a PWM device or an ERR_PTR()-encoded error code on
 378  * failure.
 379  */
 380 struct pwm_device *pwm_request(int pwm, const char *label)
 381 {
 382         struct pwm_device *dev;
 383         int err;
 384
 385         if (pwm < 0 || pwm >= MAX_PWMS)
 386                 return ERR_PTR(-EINVAL);
 387
 388         mutex_lock(&pwm_lock);
 389
 390         dev = pwm_to_device(pwm);
 391         if (!dev) {
 392                 dev = ERR_PTR(-EPROBE_DEFER);
 393                 goto out;
 394         }
 395
 396         err = pwm_device_request(dev, label);
 397         if (err < 0)
 398                 dev = ERR_PTR(err);
 399
 400 out:
 401         mutex_unlock(&pwm_lock);
 402
 403         return dev;
 404 }
 405 EXPORT_SYMBOL_GPL(pwm_request);
 406
 407 /**
 408  * pwm_request_from_chip() - request a PWM device relative to a PWM chip
 409  * @chip: PWM chip
 410  * @index: per-chip index of the PWM to request
 411  * @label: a literal description string of this PWM
 412  *
 413  * Returns: A pointer to the PWM device at the given index of the given PWM
 414  * chip. A negative error code is returned if the index is not valid for the
 415  * specified PWM chip or if the PWM device cannot be requested.
 416  */
 417 struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
 418                                          unsigned int index,
 419                                          const char *label)
 420 {
 421         struct pwm_device *pwm;
 422         int err;
 423
 424         if (!chip || index >= chip->npwm)
 425                 return ERR_PTR(-EINVAL);
 426
 427         mutex_lock(&pwm_lock);
 428         pwm = &chip->pwms[index];
 429
 430         err = pwm_device_request(pwm, label);
 431         if (err < 0)
 432                 pwm = ERR_PTR(err);
 433
 434         mutex_unlock(&pwm_lock);
 435         return pwm;
 436 }
 437 EXPORT_SYMBOL_GPL(pwm_request_from_chip);
 438
 439 /**
 440  * pwm_free() - free a PWM device
 441  * @pwm: PWM device
 442  *
 443  * This function is deprecated, use pwm_put() instead.
 444  */
 445 void pwm_free(struct pwm_device *pwm)
 446 {
 447         pwm_put(pwm);
 448 }
 449 EXPORT_SYMBOL_GPL(pwm_free);
 450
 451 /**
 452  * pwm_apply_state() - atomically apply a new state to a PWM device
 453  * @pwm: PWM device
 454  * @state: new state to apply. This can be adjusted by the PWM driver
 455  *         if the requested config is not achievable, for example,
 456  *         ->duty_cycle and ->period might be approximated.
 457  */
 458 int pwm_apply_state(struct pwm_device *pwm, struct pwm_state *state)
 459 {
 460         int err;
 461
 462         if (!pwm)
 463                 return -EINVAL;
 464
 465         if (!memcmp(state, &pwm->state, sizeof(*state)))
 466                 return 0;
 467
 468         if (pwm->chip->ops->apply) {
 469                 err = pwm->chip->ops->apply(pwm->chip, pwm, state);
 470                 if (err)
 471                         return err;
 472
 473                 pwm->state = *state;
 474         } else {
 475                 /*
 476                  * FIXME: restore the initial state in case of error.
 477                  */
 478                 if (state->polarity != pwm->state.polarity) {
 479                         if (!pwm->chip->ops->set_polarity)
 480                                 return -ENOTSUPP;
 481
 482                         /*
 483                          * Changing the polarity of a running PWM is
 484                          * only allowed when the PWM driver implements
 485                          * ->apply().
 486                          */
 487                         if (pwm->state.enabled) {
 488                                 pwm->chip->ops->disable(pwm->chip, pwm);
 489                                 pwm->state.enabled = false;
 490                         }
 491
 492                         err = pwm->chip->ops->set_polarity(pwm->chip, pwm,
 493                                                            state->polarity);
 494                         if (err)
 495                                 return err;
 496
 497                         pwm->state.polarity = state->polarity;
 498                 }
 499
 500                 if (state->period != pwm->state.period ||
 501                     state->duty_cycle != pwm->state.duty_cycle) {
 502                         err = pwm->chip->ops->config(pwm->chip, pwm,
 503                                                      state->duty_cycle,
 504                                                      state->period);
 505                         if (err)
 506                                 return err;
 507
 508                         pwm->state.duty_cycle = state->duty_cycle;
 509                         pwm->state.period = state->period;
 510                 }
 511
 512                 if (state->enabled != pwm->state.enabled) {
 513                         if (state->enabled) {
 514                                 err = pwm->chip->ops->enable(pwm->chip, pwm);
 515                                 if (err)
 516                                         return err;
 517                         } else {
 518                                 pwm->chip->ops->disable(pwm->chip, pwm);
 519                         }
 520
 521                         pwm->state.enabled = state->enabled;
 522                 }
 523         }
 524
 525         return 0;
 526 }
 527 EXPORT_SYMBOL_GPL(pwm_apply_state);
 528
 529 /**
 530  * pwm_adjust_config() - adjust the current PWM config to the PWM arguments
 531  * @pwm: PWM device
 532  *
 533  * This function will adjust the PWM config to the PWM arguments provided
 534  * by the DT or PWM lookup table. This is particularly useful to adapt
 535  * the bootloader config to the Linux one.
 536  */
 537 int pwm_adjust_config(struct pwm_device *pwm)
 538 {
 539         struct pwm_state state;
 540         struct pwm_args pargs;
 541
 542         pwm_get_args(pwm, &pargs);
 543         pwm_get_state(pwm, &state);
 544
 545         /*
 546          * If the current period is zero it means that either the PWM driver
 547          * does not support initial state retrieval or the PWM has not yet
 548          * been configured.
 549          *
 550          * In either case, we setup the new period and polarity, and assign a
 551          * duty cycle of 0.
 552          */
 553         if (!state.period) {
 554                 state.duty_cycle = 0;
 555                 state.period = pargs.period;
 556                 state.polarity = pargs.polarity;
 557
 558                 return pwm_apply_state(pwm, &state);
 559         }
 560
 561         /*
 562          * Adjust the PWM duty cycle/period based on the period value provided
 563          * in PWM args.
 564          */
 565         if (pargs.period != state.period) {
 566                 u64 dutycycle = (u64)state.duty_cycle * pargs.period;
 567
 568                 do_div(dutycycle, state.period);
 569                 state.duty_cycle = dutycycle;
 570                 state.period = pargs.period;
 571         }
 572
 573         /*
 574          * If the polarity changed, we should also change the duty cycle.
 575          */
 576         if (pargs.polarity != state.polarity) {
 577                 state.polarity = pargs.polarity;
 578                 state.duty_cycle = state.period - state.duty_cycle;
 579         }
 580
 581         return pwm_apply_state(pwm, &state);
 582 }
 583 EXPORT_SYMBOL_GPL(pwm_adjust_config);
 584
 585 static struct pwm_chip *of_node_to_pwmchip(struct device_node *np)
 586 {
 587         struct pwm_chip *chip;
 588
 589         mutex_lock(&pwm_lock);
 590
 591         list_for_each_entry(chip, &pwm_chips, list)
 592                 if (chip->dev && chip->dev->of_node == np) {
 593                         mutex_unlock(&pwm_lock);
 594                         return chip;
 595                 }
 596
 597         mutex_unlock(&pwm_lock);
 598
 599         return ERR_PTR(-EPROBE_DEFER);
 600 }
 601
 602 /**
 603  * of_pwm_get() - request a PWM via the PWM framework
 604  * @np: device node to get the PWM from
 605  * @con_id: consumer name
 606  *
 607  * Returns the PWM device parsed from the phandle and index specified in the
 608  * "pwms" property of a device tree node or a negative error-code on failure.
 609  * Values parsed from the device tree are stored in the returned PWM device
 610  * object.
 611  *
 612  * If con_id is NULL, the first PWM device listed in the "pwms" property will
 613  * be requested. Otherwise the "pwm-names" property is used to do a reverse
 614  * lookup of the PWM index. This also means that the "pwm-names" property
 615  * becomes mandatory for devices that look up the PWM device via the con_id
 616  * parameter.
 617  *
 618  * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 619  * error code on failure.
 620  */
 621 struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id)
 622 {
 623         struct pwm_device *pwm = NULL;
 624         struct of_phandle_args args;
 625         struct pwm_chip *pc;
 626         int index = 0;
 627         int err;
 628
 629         if (con_id) {
 630                 index = of_property_match_string(np, "pwm-names", con_id);
 631                 if (index < 0)
 632                         return ERR_PTR(index);
 633         }
 634
 635         err = of_parse_phandle_with_args(np, "pwms", "#pwm-cells", index,
 636                                          &args);
 637         if (err) {
 638                 pr_debug("%s(): can't parse \"pwms\" property\n", __func__);
 639                 return ERR_PTR(err);
 640         }
 641
 642         pc = of_node_to_pwmchip(args.np);
 643         if (IS_ERR(pc)) {
 644                 pr_debug("%s(): PWM chip not found\n", __func__);
 645                 pwm = ERR_CAST(pc);
 646                 goto put;
 647         }
 648
 649         if (args.args_count != pc->of_pwm_n_cells) {
 650                 pr_debug("%s: wrong #pwm-cells for %s\n", np->full_name,
 651                          args.np->full_name);
 652                 pwm = ERR_PTR(-EINVAL);
 653                 goto put;
 654         }
 655
 656         pwm = pc->of_xlate(pc, &args);
 657         if (IS_ERR(pwm))
 658                 goto put;
 659
 660         /*
 661          * If a consumer name was not given, try to look it up from the
 662          * "pwm-names" property if it exists. Otherwise use the name of
 663          * the user device node.
 664          */
 665         if (!con_id) {
 666                 err = of_property_read_string_index(np, "pwm-names", index,
 667                                                     &con_id);
 668                 if (err < 0)
 669                         con_id = np->name;
 670         }
 671
 672         pwm->label = con_id;
 673
 674 put:
 675         of_node_put(args.np);
 676
 677         return pwm;
 678 }
 679 EXPORT_SYMBOL_GPL(of_pwm_get);
 680
 681 /**
 682  * pwm_add_table() - register PWM device consumers
 683  * @table: array of consumers to register
 684  * @num: number of consumers in table
 685  */
 686 void pwm_add_table(struct pwm_lookup *table, size_t num)
 687 {
 688         mutex_lock(&pwm_lookup_lock);
 689
 690         while (num--) {
 691                 list_add_tail(&table->list, &pwm_lookup_list);
 692                 table++;
 693         }
 694
 695         mutex_unlock(&pwm_lookup_lock);
 696 }
 697
 698 /**
 699  * pwm_remove_table() - unregister PWM device consumers
 700  * @table: array of consumers to unregister
 701  * @num: number of consumers in table
 702  */
 703 void pwm_remove_table(struct pwm_lookup *table, size_t num)
 704 {
 705         mutex_lock(&pwm_lookup_lock);
 706
 707         while (num--) {
 708                 list_del(&table->list);
 709                 table++;
 710         }
 711
 712         mutex_unlock(&pwm_lookup_lock);
 713 }
 714
 715 /**
 716  * pwm_get() - look up and request a PWM device
 717  * @dev: device for PWM consumer
 718  * @con_id: consumer name
 719  *
 720  * Lookup is first attempted using DT. If the device was not instantiated from
 721  * a device tree, a PWM chip and a relative index is looked up via a table
 722  * supplied by board setup code (see pwm_add_table()).
 723  *
 724  * Once a PWM chip has been found the specified PWM device will be requested
 725  * and is ready to be used.
 726  *
 727  * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 728  * error code on failure.
 729  */
 730 struct pwm_device *pwm_get(struct device *dev, const char *con_id)
 731 {
 732         struct pwm_device *pwm = ERR_PTR(-EPROBE_DEFER);
 733         const char *dev_id = dev ? dev_name(dev) : NULL;
 734         struct pwm_chip *chip = NULL;
 735         unsigned int best = 0;
 736         struct pwm_lookup *p, *chosen = NULL;
 737         unsigned int match;
 738
 739         /* look up via DT first */
 740         if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
 741                 return of_pwm_get(dev->of_node, con_id);
 742
 743         /*
 744          * We look up the provider in the static table typically provided by
 745          * board setup code. We first try to lookup the consumer device by
 746          * name. If the consumer device was passed in as NULL or if no match
 747          * was found, we try to find the consumer by directly looking it up
 748          * by name.
 749          *
 750          * If a match is found, the provider PWM chip is looked up by name
 751          * and a PWM device is requested using the PWM device per-chip index.
 752          *
 753          * The lookup algorithm was shamelessly taken from the clock
 754          * framework:
 755          *
 756          * We do slightly fuzzy matching here:
 757          *  An entry with a NULL ID is assumed to be a wildcard.
 758          *  If an entry has a device ID, it must match
 759          *  If an entry has a connection ID, it must match
 760          * Then we take the most specific entry - with the following order
 761          * of precedence: dev+con > dev only > con only.
 762          */
 763         mutex_lock(&pwm_lookup_lock);
 764
 765         list_for_each_entry(p, &pwm_lookup_list, list) {
 766                 match = 0;
 767
 768                 if (p->dev_id) {
 769                         if (!dev_id || strcmp(p->dev_id, dev_id))
 770                                 continue;
 771
 772                         match += 2;
 773                 }
 774
 775                 if (p->con_id) {
 776                         if (!con_id || strcmp(p->con_id, con_id))
 777                                 continue;
 778
 779                         match += 1;
 780                 }
 781
 782                 if (match > best) {
 783                         chosen = p;
 784
 785                         if (match != 3)
 786                                 best = match;
 787                         else
 788                                 break;
 789                 }
 790         }
 791
 792         if (!chosen) {
 793                 pwm = ERR_PTR(-ENODEV);
 794                 goto out;
 795         }
 796
 797         chip = pwmchip_find_by_name(chosen->provider);
 798         if (!chip)
 799                 goto out;
 800
 801         pwm = pwm_request_from_chip(chip, chosen->index, con_id ?: dev_id);
 802         if (IS_ERR(pwm))
 803                 goto out;
 804
 805         pwm->args.period = chosen->period;
 806         pwm->args.polarity = chosen->polarity;
 807
 808 out:
 809         mutex_unlock(&pwm_lookup_lock);
 810         return pwm;
 811 }
 812 EXPORT_SYMBOL_GPL(pwm_get);
 813
 814 /**
 815  * pwm_put() - release a PWM device
 816  * @pwm: PWM device
 817  */
 818 void pwm_put(struct pwm_device *pwm)
 819 {
 820         if (!pwm)
 821                 return;
 822
 823         mutex_lock(&pwm_lock);
 824
 825         if (!test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
 826                 pr_warn("PWM device already freed\n");
 827                 goto out;
 828         }
 829
 830         if (pwm->chip->ops->free)
 831                 pwm->chip->ops->free(pwm->chip, pwm);
 832
 833         pwm->label = NULL;
 834
 835         module_put(pwm->chip->ops->owner);
 836 out:
 837         mutex_unlock(&pwm_lock);
 838 }
 839 EXPORT_SYMBOL_GPL(pwm_put);
 840
 841 static void devm_pwm_release(struct device *dev, void *res)
 842 {
 843         pwm_put(*(struct pwm_device **)res);
 844 }
 845
 846 /**
 847  * devm_pwm_get() - resource managed pwm_get()
 848  * @dev: device for PWM consumer
 849  * @con_id: consumer name
 850  *
 851  * This function performs like pwm_get() but the acquired PWM device will
 852  * automatically be released on driver detach.
 853  *
 854  * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 855  * error code on failure.
 856  */
 857 struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id)
 858 {
 859         struct pwm_device **ptr, *pwm;
 860
 861         ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
 862         if (!ptr)
 863                 return ERR_PTR(-ENOMEM);
 864
 865         pwm = pwm_get(dev, con_id);
 866         if (!IS_ERR(pwm)) {
 867                 *ptr = pwm;
 868                 devres_add(dev, ptr);
 869         } else {
 870                 devres_free(ptr);
 871         }
 872
 873         return pwm;
 874 }
 875 EXPORT_SYMBOL_GPL(devm_pwm_get);
 876
 877 /**
 878  * devm_of_pwm_get() - resource managed of_pwm_get()
 879  * @dev: device for PWM consumer
 880  * @np: device node to get the PWM from
 881  * @con_id: consumer name
 882  *
 883  * This function performs like of_pwm_get() but the acquired PWM device will
 884  * automatically be released on driver detach.
 885  *
 886  * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded
 887  * error code on failure.
 888  */
 889 struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
 890                                    const char *con_id)
 891 {
 892         struct pwm_device **ptr, *pwm;
 893
 894         ptr = devres_alloc(devm_pwm_release, sizeof(*ptr), GFP_KERNEL);
 895         if (!ptr)
 896                 return ERR_PTR(-ENOMEM);
 897
 898         pwm = of_pwm_get(np, con_id);
 899         if (!IS_ERR(pwm)) {
 900                 *ptr = pwm;
 901                 devres_add(dev, ptr);
 902         } else {
 903                 devres_free(ptr);
 904         }
 905
 906         return pwm;
 907 }
 908 EXPORT_SYMBOL_GPL(devm_of_pwm_get);
 909
 910 static int devm_pwm_match(struct device *dev, void *res, void *data)
 911 {
 912         struct pwm_device **p = res;
 913
 914         if (WARN_ON(!p || !*p))
 915                 return 0;
 916
 917         return *p == data;
 918 }
 919
 920 /**
 921  * devm_pwm_put() - resource managed pwm_put()
 922  * @dev: device for PWM consumer
 923  * @pwm: PWM device
 924  *
 925  * Release a PWM previously allocated using devm_pwm_get(). Calling this
 926  * function is usually not needed because devm-allocated resources are
 927  * automatically released on driver detach.
 928  */
 929 void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
 930 {
 931         WARN_ON(devres_release(dev, devm_pwm_release, devm_pwm_match, pwm));
 932 }
 933 EXPORT_SYMBOL_GPL(devm_pwm_put);
 934
 935 /**
 936   * pwm_can_sleep() - report whether PWM access will sleep
 937   * @pwm: PWM device
 938   *
 939   * Returns: True if accessing the PWM can sleep, false otherwise.
 940   */
 941 bool pwm_can_sleep(struct pwm_device *pwm)
 942 {
 943         return true;
 944 }
 945 EXPORT_SYMBOL_GPL(pwm_can_sleep);
 946
 947 #ifdef CONFIG_DEBUG_FS
 948 static void pwm_dbg_show(struct pwm_chip *chip, struct seq_file *s)
 949 {
 950         unsigned int i;
 951
 952         for (i = 0; i < chip->npwm; i++) {
 953                 struct pwm_device *pwm = &chip->pwms[i];
 954                 struct pwm_state state;
 955
 956                 pwm_get_state(pwm, &state);
 957
 958                 seq_printf(s, " pwm-%-3d (%-20.20s):", i, pwm->label);
 959
 960                 if (test_bit(PWMF_REQUESTED, &pwm->flags))
 961                         seq_puts(s, " requested");
 962
 963                 if (state.enabled)
 964                         seq_puts(s, " enabled");
 965
 966                 seq_puts(s, "\n");
 967         }
 968 }
 969
 970 static void *pwm_seq_start(struct seq_file *s, loff_t *pos)
 971 {
 972         mutex_lock(&pwm_lock);
 973         s->private = "";
 974
 975         return seq_list_start(&pwm_chips, *pos);
 976 }
 977
 978 static void *pwm_seq_next(struct seq_file *s, void *v, loff_t *pos)
 979 {
 980         s->private = "\n";
 981
 982         return seq_list_next(v, &pwm_chips, pos);
 983 }
 984
 985 static void pwm_seq_stop(struct seq_file *s, void *v)
 986 {
 987         mutex_unlock(&pwm_lock);
 988 }
 989
 990 static int pwm_seq_show(struct seq_file *s, void *v)
 991 {
 992         struct pwm_chip *chip = list_entry(v, struct pwm_chip, list);
 993
 994         seq_printf(s, "%s%s/%s, %d PWM device%s\n", (char *)s->private,
 995                    chip->dev->bus ? chip->dev->bus->name : "no-bus",
 996                    dev_name(chip->dev), chip->npwm,
 997                    (chip->npwm != 1) ? "s" : "");
 998
 999         if (chip->ops->dbg_show)
1000                 chip->ops->dbg_show(chip, s);
1001         else
1002                 pwm_dbg_show(chip, s);
1003
1004         return 0;
1005 }
1006
1007 static const struct seq_operations pwm_seq_ops = {
1008         .start = pwm_seq_start,
1009         .next = pwm_seq_next,
1010         .stop = pwm_seq_stop,
1011         .show = pwm_seq_show,
1012 };
1013
1014 static int pwm_seq_open(struct inode *inode, struct file *file)
1015 {
1016         return seq_open(file, &pwm_seq_ops);
1017 }
1018
1019 static const struct file_operations pwm_debugfs_ops = {
1020         .owner = THIS_MODULE,
1021         .open = pwm_seq_open,
1022         .read = seq_read,
1023         .llseek = seq_lseek,
1024         .release = seq_release,
1025 };
1026
1027 static int __init pwm_debugfs_init(void)
1028 {
1029         debugfs_create_file("pwm", S_IFREG | S_IRUGO, NULL, NULL,
1030                             &pwm_debugfs_ops);
1031
1032         return 0;
1033 }
1034 subsys_initcall(pwm_debugfs_init);
1035 #endif /* CONFIG_DEBUG_FS */