diff options
| author | Thierry Reding <thierry.reding@gmail.com> | 2015-07-27 11:58:32 +0200 |
|---|---|---|
| committer | Thierry Reding <thierry.reding@gmail.com> | 2015-08-17 15:40:20 +0200 |
| commit | 048838027667872a75d3af40c51a22088bafd968 (patch) | |
| tree | efe9587e6a7c8f261f502e8a3d6aa6d85db8b10d /include/linux/pwm.h | |
| parent | 6bc7064a69fc5b1f774771ea9e2c50e497311766 (diff) | |
pwm: Clean up kerneldoc
Clean up kerneldoc in preparation for including the PWM documentation in
DocBook.
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
Diffstat (limited to 'include/linux/pwm.h')
| -rw-r--r-- | include/linux/pwm.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/include/linux/pwm.h b/include/linux/pwm.h index 7c4b6f35241d..d681f6875aef 100644 --- a/include/linux/pwm.h +++ b/include/linux/pwm.h @@ -79,6 +79,18 @@ enum { PWMF_EXPORTED = 1 << 2, }; +/** + * struct pwm_device - PWM channel object + * @label: name of the PWM device + * @flags: flags associated with the PWM device + * @hwpwm: per-chip relative index of the PWM device + * @pwm: global index of the PWM device + * @chip: PWM chip providing this PWM device + * @chip_data: chip-private data associated with the PWM device + * @period: period of the PWM signal (in nanoseconds) + * @duty_cycle: duty cycle of the PWM signal (in nanoseconds) + * @polarity: polarity of the PWM signal + */ struct pwm_device { const char *label; unsigned long flags; @@ -163,6 +175,8 @@ struct pwm_ops { * @base: number of first PWM controlled by this chip * @npwm: number of PWMs controlled by this chip * @pwms: array of PWM devices allocated by the framework + * @of_xlate: request a PWM device given a device tree PWM specifier + * @of_pwm_n_cells: number of cells expected in the device tree PWM specifier * @can_sleep: must be true if the .config(), .enable() or .disable() * operations may sleep */ |