drivers/pwm/core.c

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