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