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