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