Update some comments.

This commit is contained in:
Gregory Nutt 2017-02-20 12:46:22 -06:00
parent 4dfb8268f3
commit 59a189be74

View File

@ -72,6 +72,8 @@
* number of pulses. This might be used, for example to support a stepper * number of pulses. This might be used, for example to support a stepper
* motor. If the hardware will support a fixed pulse count, then this * motor. If the hardware will support a fixed pulse count, then this
* configuration should be set to enable the capability. * configuration should be set to enable the capability.
* CONFIG_PWM_MULTICHAN - Enables support for multiple output channels per
* timer
* CONFIG_DEBUG_PWM_INFO - This will generate output that can be use to * CONFIG_DEBUG_PWM_INFO - This will generate output that can be use to
* debug the PWM driver. * debug the PWM driver.
*/ */
@ -122,6 +124,10 @@
* Public Types * Public Types
****************************************************************************/ ****************************************************************************/
/* If the PWM peripheral supports multiple output channels, then this
* structure describes the output state on one channel.
*/
#ifdef CONFIG_PWM_MULTICHAN #ifdef CONFIG_PWM_MULTICHAN
struct pwm_chan_s struct pwm_chan_s
{ {
@ -135,8 +141,11 @@ struct pwm_chan_s
struct pwm_info_s struct pwm_info_s
{ {
uint32_t frequency; /* Frequency of the pulse train */ uint32_t frequency; /* Frequency of the pulse train */
#ifdef CONFIG_PWM_MULTICHAN #ifdef CONFIG_PWM_MULTICHAN
/* Per-channel output state */
struct pwm_chan_s channels[CONFIG_PWM_NCHANNELS]; struct pwm_chan_s channels[CONFIG_PWM_NCHANNELS];
#else #else
ub16_t duty; /* Duty of the pulse train, "1"-to-"0" duration. ub16_t duty; /* Duty of the pulse train, "1"-to-"0" duration.
* Maximum: 65535/65536 (0x0000ffff) * Maximum: 65535/65536 (0x0000ffff)
@ -145,7 +154,7 @@ struct pwm_info_s
uint32_t count; /* The number of pulse to generate. 0 means to uint32_t count; /* The number of pulse to generate. 0 means to
* generate an indefinite number of pulses */ * generate an indefinite number of pulses */
# endif # endif
#endif #endif /* CONFIG_PWM_MULTICHAN */
}; };
/* This structure is a set a callback functions used to call from the upper- /* This structure is a set a callback functions used to call from the upper-