include/linux/pwm.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __LINUX_PWM_H
   3 #define __LINUX_PWM_H
   4
   5 #include <linux/err.h>
   6 #include <linux/mutex.h>
   7 #include <linux/of.h>
   8
   9 struct pwm_capture;
  10 struct seq_file;
  11
  12 struct pwm_chip;
  13
  14 /**
  15  * enum pwm_polarity - polarity of a PWM signal
  16  * @PWM_POLARITY_NORMAL: a high signal for the duration of the duty-
  17  * cycle, followed by a low signal for the remainder of the pulse
  18  * period
  19  * @PWM_POLARITY_INVERSED: a low signal for the duration of the duty-
  20  * cycle, followed by a high signal for the remainder of the pulse
  21  * period
  22  */
  23 enum pwm_polarity {
  24         PWM_POLARITY_NORMAL,
  25         PWM_POLARITY_INVERSED,
  26 };
  27
  28 /**
  29  * struct pwm_args - board-dependent PWM arguments
  30  * @period: reference period
  31  * @polarity: reference polarity
  32  *
  33  * This structure describes board-dependent arguments attached to a PWM
  34  * device. These arguments are usually retrieved from the PWM lookup table or
  35  * device tree.
  36  *
  37  * Do not confuse this with the PWM state: PWM arguments represent the initial
  38  * configuration that users want to use on this PWM device rather than the
  39  * current PWM hardware state.
  40  */
  41 struct pwm_args {
  42         unsigned int period;
  43         enum pwm_polarity polarity;
  44 };
  45
  46 enum {
  47         PWMF_REQUESTED = 1 << 0,
  48         PWMF_EXPORTED = 1 << 1,
  49 };
  50
  51 /*
  52  * struct pwm_state - state of a PWM channel
  53  * @period: PWM period (in nanoseconds)
  54  * @duty_cycle: PWM duty cycle (in nanoseconds)
  55  * @polarity: PWM polarity
  56  * @enabled: PWM enabled status
  57  */
  58 struct pwm_state {
  59         unsigned int period;
  60         unsigned int duty_cycle;
  61         enum pwm_polarity polarity;
  62         bool enabled;
  63 };
  64
  65 /**
  66  * struct pwm_device - PWM channel object
  67  * @label: name of the PWM device
  68  * @flags: flags associated with the PWM device
  69  * @hwpwm: per-chip relative index of the PWM device
  70  * @pwm: global index of the PWM device
  71  * @chip: PWM chip providing this PWM device
  72  * @chip_data: chip-private data associated with the PWM device
  73  * @args: PWM arguments
  74  * @state: curent PWM channel state
  75  */
  76 struct pwm_device {
  77         const char *label;
  78         unsigned long flags;
  79         unsigned int hwpwm;
  80         unsigned int pwm;
  81         struct pwm_chip *chip;
  82         void *chip_data;
  83
  84         struct pwm_args args;
  85         struct pwm_state state;
  86 };
  87
  88 /**
  89  * pwm_get_state() - retrieve the current PWM state
  90  * @pwm: PWM device
  91  * @state: state to fill with the current PWM state
  92  */
  93 static inline void pwm_get_state(const struct pwm_device *pwm,
  94                                  struct pwm_state *state)
  95 {
  96         *state = pwm->state;
  97 }
  98
  99 static inline bool pwm_is_enabled(const struct pwm_device *pwm)
 100 {
 101         struct pwm_state state;
 102
 103         pwm_get_state(pwm, &state);
 104
 105         return state.enabled;
 106 }
 107
 108 static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period)
 109 {
 110         if (pwm)
 111                 pwm->state.period = period;
 112 }
 113
 114 static inline unsigned int pwm_get_period(const struct pwm_device *pwm)
 115 {
 116         struct pwm_state state;
 117
 118         pwm_get_state(pwm, &state);
 119
 120         return state.period;
 121 }
 122
 123 static inline void pwm_set_duty_cycle(struct pwm_device *pwm, unsigned int duty)
 124 {
 125         if (pwm)
 126                 pwm->state.duty_cycle = duty;
 127 }
 128
 129 static inline unsigned int pwm_get_duty_cycle(const struct pwm_device *pwm)
 130 {
 131         struct pwm_state state;
 132
 133         pwm_get_state(pwm, &state);
 134
 135         return state.duty_cycle;
 136 }
 137
 138 static inline enum pwm_polarity pwm_get_polarity(const struct pwm_device *pwm)
 139 {
 140         struct pwm_state state;
 141
 142         pwm_get_state(pwm, &state);
 143
 144         return state.polarity;
 145 }
 146
 147 static inline void pwm_get_args(const struct pwm_device *pwm,
 148                                 struct pwm_args *args)
 149 {
 150         *args = pwm->args;
 151 }
 152
 153 /**
 154  * pwm_init_state() - prepare a new state to be applied with pwm_apply_state()
 155  * @pwm: PWM device
 156  * @state: state to fill with the prepared PWM state
 157  *
 158  * This functions prepares a state that can later be tweaked and applied
 159  * to the PWM device with pwm_apply_state(). This is a convenient function
 160  * that first retrieves the current PWM state and the replaces the period
 161  * and polarity fields with the reference values defined in pwm->args.
 162  * Once the function returns, you can adjust the ->enabled and ->duty_cycle
 163  * fields according to your needs before calling pwm_apply_state().
 164  *
 165  * ->duty_cycle is initially set to zero to avoid cases where the current
 166  * ->duty_cycle value exceed the pwm_args->period one, which would trigger
 167  * an error if the user calls pwm_apply_state() without adjusting ->duty_cycle
 168  * first.
 169  */
 170 static inline void pwm_init_state(const struct pwm_device *pwm,
 171                                   struct pwm_state *state)
 172 {
 173         struct pwm_args args;
 174
 175         /* First get the current state. */
 176         pwm_get_state(pwm, state);
 177
 178         /* Then fill it with the reference config */
 179         pwm_get_args(pwm, &args);
 180
 181         state->period = args.period;
 182         state->polarity = args.polarity;
 183         state->duty_cycle = 0;
 184 }
 185
 186 /**
 187  * pwm_get_relative_duty_cycle() - Get a relative duty cycle value
 188  * @state: PWM state to extract the duty cycle from
 189  * @scale: target scale of the relative duty cycle
 190  *
 191  * This functions converts the absolute duty cycle stored in @state (expressed
 192  * in nanosecond) into a value relative to the period.
 193  *
 194  * For example if you want to get the duty_cycle expressed in percent, call:
 195  *
 196  * pwm_get_state(pwm, &state);
 197  * duty = pwm_get_relative_duty_cycle(&state, 100);
 198  */
 199 static inline unsigned int
 200 pwm_get_relative_duty_cycle(const struct pwm_state *state, unsigned int scale)
 201 {
 202         if (!state->period)
 203                 return 0;
 204
 205         return DIV_ROUND_CLOSEST_ULL((u64)state->duty_cycle * scale,
 206                                      state->period);
 207 }
 208
 209 /**
 210  * pwm_set_relative_duty_cycle() - Set a relative duty cycle value
 211  * @state: PWM state to fill
 212  * @duty_cycle: relative duty cycle value
 213  * @scale: scale in which @duty_cycle is expressed
 214  *
 215  * This functions converts a relative into an absolute duty cycle (expressed
 216  * in nanoseconds), and puts the result in state->duty_cycle.
 217  *
 218  * For example if you want to configure a 50% duty cycle, call:
 219  *
 220  * pwm_init_state(pwm, &state);
 221  * pwm_set_relative_duty_cycle(&state, 50, 100);
 222  * pwm_apply_state(pwm, &state);
 223  *
 224  * This functions returns -EINVAL if @duty_cycle and/or @scale are
 225  * inconsistent (@scale == 0 or @duty_cycle > @scale).
 226  */
 227 static inline int
 228 pwm_set_relative_duty_cycle(struct pwm_state *state, unsigned int duty_cycle,
 229                             unsigned int scale)
 230 {
 231         if (!scale || duty_cycle > scale)
 232                 return -EINVAL;
 233
 234         state->duty_cycle = DIV_ROUND_CLOSEST_ULL((u64)duty_cycle *
 235                                                   state->period,
 236                                                   scale);
 237
 238         return 0;
 239 }
 240
 241 /**
 242  * struct pwm_ops - PWM controller operations
 243  * @request: optional hook for requesting a PWM
 244  * @free: optional hook for freeing a PWM
 245  * @capture: capture and report PWM signal
 246  * @apply: atomically apply a new PWM config
 247  * @get_state: get the current PWM state. This function is only
 248  *             called once per PWM device when the PWM chip is
 249  *             registered.
 250  * @owner: helps prevent removal of modules exporting active PWMs
 251  * @config: configure duty cycles and period length for this PWM
 252  * @set_polarity: configure the polarity of this PWM
 253  * @enable: enable PWM output toggling
 254  * @disable: disable PWM output toggling
 255  */
 256 struct pwm_ops {
 257         int (*request)(struct pwm_chip *chip, struct pwm_device *pwm);
 258         void (*free)(struct pwm_chip *chip, struct pwm_device *pwm);
 259         int (*capture)(struct pwm_chip *chip, struct pwm_device *pwm,
 260                        struct pwm_capture *result, unsigned long timeout);
 261         int (*apply)(struct pwm_chip *chip, struct pwm_device *pwm,
 262                      const struct pwm_state *state);
 263         void (*get_state)(struct pwm_chip *chip, struct pwm_device *pwm,
 264                           struct pwm_state *state);
 265         struct module *owner;
 266
 267         /* Only used by legacy drivers */
 268         int (*config)(struct pwm_chip *chip, struct pwm_device *pwm,
 269                       int duty_ns, int period_ns);
 270         int (*set_polarity)(struct pwm_chip *chip, struct pwm_device *pwm,
 271                             enum pwm_polarity polarity);
 272         int (*enable)(struct pwm_chip *chip, struct pwm_device *pwm);
 273         void (*disable)(struct pwm_chip *chip, struct pwm_device *pwm);
 274 };
 275
 276 /**
 277  * struct pwm_chip - abstract a PWM controller
 278  * @dev: device providing the PWMs
 279  * @ops: callbacks for this PWM controller
 280  * @base: number of first PWM controlled by this chip
 281  * @npwm: number of PWMs controlled by this chip
 282  * @of_xlate: request a PWM device given a device tree PWM specifier
 283  * @of_pwm_n_cells: number of cells expected in the device tree PWM specifier
 284  * @list: list node for internal use
 285  * @pwms: array of PWM devices allocated by the framework
 286  */
 287 struct pwm_chip {
 288         struct device *dev;
 289         const struct pwm_ops *ops;
 290         int base;
 291         unsigned int npwm;
 292
 293         struct pwm_device * (*of_xlate)(struct pwm_chip *pc,
 294                                         const struct of_phandle_args *args);
 295         unsigned int of_pwm_n_cells;
 296
 297         /* only used internally by the PWM framework */
 298         struct list_head list;
 299         struct pwm_device *pwms;
 300 };
 301
 302 /**
 303  * struct pwm_capture - PWM capture data
 304  * @period: period of the PWM signal (in nanoseconds)
 305  * @duty_cycle: duty cycle of the PWM signal (in nanoseconds)
 306  */
 307 struct pwm_capture {
 308         unsigned int period;
 309         unsigned int duty_cycle;
 310 };
 311
 312 #if IS_ENABLED(CONFIG_PWM)
 313 /* PWM user APIs */
 314 struct pwm_device *pwm_request(int pwm_id, const char *label);
 315 void pwm_free(struct pwm_device *pwm);
 316 int pwm_apply_state(struct pwm_device *pwm, const struct pwm_state *state);
 317 int pwm_adjust_config(struct pwm_device *pwm);
 318
 319 /**
 320  * pwm_config() - change a PWM device configuration
 321  * @pwm: PWM device
 322  * @duty_ns: "on" time (in nanoseconds)
 323  * @period_ns: duration (in nanoseconds) of one cycle
 324  *
 325  * Returns: 0 on success or a negative error code on failure.
 326  */
 327 static inline int pwm_config(struct pwm_device *pwm, int duty_ns,
 328                              int period_ns)
 329 {
 330         struct pwm_state state;
 331
 332         if (!pwm)
 333                 return -EINVAL;
 334
 335         if (duty_ns < 0 || period_ns < 0)
 336                 return -EINVAL;
 337
 338         pwm_get_state(pwm, &state);
 339         if (state.duty_cycle == duty_ns && state.period == period_ns)
 340                 return 0;
 341
 342         state.duty_cycle = duty_ns;
 343         state.period = period_ns;
 344         return pwm_apply_state(pwm, &state);
 345 }
 346
 347 /**
 348  * pwm_enable() - start a PWM output toggling
 349  * @pwm: PWM device
 350  *
 351  * Returns: 0 on success or a negative error code on failure.
 352  */
 353 static inline int pwm_enable(struct pwm_device *pwm)
 354 {
 355         struct pwm_state state;
 356
 357         if (!pwm)
 358                 return -EINVAL;
 359
 360         pwm_get_state(pwm, &state);
 361         if (state.enabled)
 362                 return 0;
 363
 364         state.enabled = true;
 365         return pwm_apply_state(pwm, &state);
 366 }
 367
 368 /**
 369  * pwm_disable() - stop a PWM output toggling
 370  * @pwm: PWM device
 371  */
 372 static inline void pwm_disable(struct pwm_device *pwm)
 373 {
 374         struct pwm_state state;
 375
 376         if (!pwm)
 377                 return;
 378
 379         pwm_get_state(pwm, &state);
 380         if (!state.enabled)
 381                 return;
 382
 383         state.enabled = false;
 384         pwm_apply_state(pwm, &state);
 385 }
 386
 387 /* PWM provider APIs */
 388 int pwm_capture(struct pwm_device *pwm, struct pwm_capture *result,
 389                 unsigned long timeout);
 390 int pwm_set_chip_data(struct pwm_device *pwm, void *data);
 391 void *pwm_get_chip_data(struct pwm_device *pwm);
 392
 393 int pwmchip_add_with_polarity(struct pwm_chip *chip,
 394                               enum pwm_polarity polarity);
 395 int pwmchip_add(struct pwm_chip *chip);
 396 int pwmchip_remove(struct pwm_chip *chip);
 397 struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
 398                                          unsigned int index,
 399                                          const char *label);
 400
 401 struct pwm_device *of_pwm_xlate_with_flags(struct pwm_chip *pc,
 402                 const struct of_phandle_args *args);
 403
 404 struct pwm_device *pwm_get(struct device *dev, const char *con_id);
 405 struct pwm_device *of_pwm_get(struct device *dev, struct device_node *np,
 406                               const char *con_id);
 407 void pwm_put(struct pwm_device *pwm);
 408
 409 struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id);
 410 struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
 411                                    const char *con_id);
 412 struct pwm_device *devm_fwnode_pwm_get(struct device *dev,
 413                                        struct fwnode_handle *fwnode,
 414                                        const char *con_id);
 415 void devm_pwm_put(struct device *dev, struct pwm_device *pwm);
 416 #else
 417 static inline struct pwm_device *pwm_request(int pwm_id, const char *label)
 418 {
 419         return ERR_PTR(-ENODEV);
 420 }
 421
 422 static inline void pwm_free(struct pwm_device *pwm)
 423 {
 424 }
 425
 426 static inline int pwm_apply_state(struct pwm_device *pwm,
 427                                   const struct pwm_state *state)
 428 {
 429         return -ENOTSUPP;
 430 }
 431
 432 static inline int pwm_adjust_config(struct pwm_device *pwm)
 433 {
 434         return -ENOTSUPP;
 435 }
 436
 437 static inline int pwm_config(struct pwm_device *pwm, int duty_ns,
 438                              int period_ns)
 439 {
 440         return -EINVAL;
 441 }
 442
 443 static inline int pwm_capture(struct pwm_device *pwm,
 444                               struct pwm_capture *result,
 445                               unsigned long timeout)
 446 {
 447         return -EINVAL;
 448 }
 449
 450 static inline int pwm_enable(struct pwm_device *pwm)
 451 {
 452         return -EINVAL;
 453 }
 454
 455 static inline void pwm_disable(struct pwm_device *pwm)
 456 {
 457 }
 458
 459 static inline int pwm_set_chip_data(struct pwm_device *pwm, void *data)
 460 {
 461         return -EINVAL;
 462 }
 463
 464 static inline void *pwm_get_chip_data(struct pwm_device *pwm)
 465 {
 466         return NULL;
 467 }
 468
 469 static inline int pwmchip_add(struct pwm_chip *chip)
 470 {
 471         return -EINVAL;
 472 }
 473
 474 static inline int pwmchip_add_inversed(struct pwm_chip *chip)
 475 {
 476         return -EINVAL;
 477 }
 478
 479 static inline int pwmchip_remove(struct pwm_chip *chip)
 480 {
 481         return -EINVAL;
 482 }
 483
 484 static inline struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
 485                                                        unsigned int index,
 486                                                        const char *label)
 487 {
 488         return ERR_PTR(-ENODEV);
 489 }
 490
 491 static inline struct pwm_device *pwm_get(struct device *dev,
 492                                          const char *consumer)
 493 {
 494         return ERR_PTR(-ENODEV);
 495 }
 496
 497 static inline struct pwm_device *of_pwm_get(struct device *dev,
 498                                             struct device_node *np,
 499                                             const char *con_id)
 500 {
 501         return ERR_PTR(-ENODEV);
 502 }
 503
 504 static inline void pwm_put(struct pwm_device *pwm)
 505 {
 506 }
 507
 508 static inline struct pwm_device *devm_pwm_get(struct device *dev,
 509                                               const char *consumer)
 510 {
 511         return ERR_PTR(-ENODEV);
 512 }
 513
 514 static inline struct pwm_device *devm_of_pwm_get(struct device *dev,
 515                                                  struct device_node *np,
 516                                                  const char *con_id)
 517 {
 518         return ERR_PTR(-ENODEV);
 519 }
 520
 521 static inline struct pwm_device *
 522 devm_fwnode_pwm_get(struct device *dev, struct fwnode_handle *fwnode,
 523                     const char *con_id)
 524 {
 525         return ERR_PTR(-ENODEV);
 526 }
 527
 528 static inline void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
 529 {
 530 }
 531 #endif
 532
 533 static inline void pwm_apply_args(struct pwm_device *pwm)
 534 {
 535         struct pwm_state state = { };
 536
 537         /*
 538          * PWM users calling pwm_apply_args() expect to have a fresh config
 539          * where the polarity and period are set according to pwm_args info.
 540          * The problem is, polarity can only be changed when the PWM is
 541          * disabled.
 542          *
 543          * PWM drivers supporting hardware readout may declare the PWM device
 544          * as enabled, and prevent polarity setting, which changes from the
 545          * existing behavior, where all PWM devices are declared as disabled
 546          * at startup (even if they are actually enabled), thus authorizing
 547          * polarity setting.
 548          *
 549          * To fulfill this requirement, we apply a new state which disables
 550          * the PWM device and set the reference period and polarity config.
 551          *
 552          * Note that PWM users requiring a smooth handover between the
 553          * bootloader and the kernel (like critical regulators controlled by
 554          * PWM devices) will have to switch to the atomic API and avoid calling
 555          * pwm_apply_args().
 556          */
 557
 558         state.enabled = false;
 559         state.polarity = pwm->args.polarity;
 560         state.period = pwm->args.period;
 561
 562         pwm_apply_state(pwm, &state);
 563 }
 564
 565 struct pwm_lookup {
 566         struct list_head list;
 567         const char *provider;
 568         unsigned int index;
 569         const char *dev_id;
 570         const char *con_id;
 571         unsigned int period;
 572         enum pwm_polarity polarity;
 573         const char *module; /* optional, may be NULL */
 574 };
 575
 576 #define PWM_LOOKUP_WITH_MODULE(_provider, _index, _dev_id, _con_id,     \
 577                                _period, _polarity, _module)             \
 578         {                                                               \
 579                 .provider = _provider,                                  \
 580                 .index = _index,                                        \
 581                 .dev_id = _dev_id,                                      \
 582                 .con_id = _con_id,                                      \
 583                 .period = _period,                                      \
 584                 .polarity = _polarity,                                  \
 585                 .module = _module,                                      \
 586         }
 587
 588 #define PWM_LOOKUP(_provider, _index, _dev_id, _con_id, _period, _polarity) \
 589         PWM_LOOKUP_WITH_MODULE(_provider, _index, _dev_id, _con_id, _period, \
 590                                _polarity, NULL)
 591
 592 #if IS_ENABLED(CONFIG_PWM)
 593 void pwm_add_table(struct pwm_lookup *table, size_t num);
 594 void pwm_remove_table(struct pwm_lookup *table, size_t num);
 595 #else
 596 static inline void pwm_add_table(struct pwm_lookup *table, size_t num)
 597 {
 598 }
 599
 600 static inline void pwm_remove_table(struct pwm_lookup *table, size_t num)
 601 {
 602 }
 603 #endif
 604
 605 #ifdef CONFIG_PWM_SYSFS
 606 void pwmchip_sysfs_export(struct pwm_chip *chip);
 607 void pwmchip_sysfs_unexport(struct pwm_chip *chip);
 608 #else
 609 static inline void pwmchip_sysfs_export(struct pwm_chip *chip)
 610 {
 611 }
 612
 613 static inline void pwmchip_sysfs_unexport(struct pwm_chip *chip)
 614 {
 615 }
 616 #endif /* CONFIG_PWM_SYSFS */
 617
 618 #endif /* __LINUX_PWM_H */