OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity

pwm.h: add comment regarding possible channel numbers 

PWM drivers use channel numbers 0 and -1 to skip the channel and/or
all following channels. This situation is well established in the drivers
however it was not mentioned in pwm.h file. This commit adds a comment
mentioning it.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
This commit is contained in:
Michal Lenc 2023-03-10 20:59:47 +01:00 committed by Mateusz Szafoni
parent 40319b9c4c
commit c4d8bbd190
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/nuttx/timers/pwm.h
View File

@ -64,6 +64,14 @@
* debug the PWM driver.
*/
/* Channel Numbers **********************************************************/
/* PWM channels should use numbers from 1 to CONFIG_PWM_NCHANNELS. Channel
* number 0 indicates the channel not used and therefore is skipped by
* the driver (its output remains at the value defined by the peripheral),
* number -1 indicates the channel and all following channels are not used.
*/
/* IOCTL Commands ***********************************************************/
/* The PWM module uses a standard character driver framework. However, since