sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

arch/nrf52/gpiote: fix doc strings

Browse Source
This commit is contained in:
raiden00pl 2023-03-14 14:18:04 +01:00 committed by Alan Carvalho de Assis
parent 776e2d774f
commit bf531fa24a
2 changed files with 9 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
arch/arm/src/nrf52/nrf52_gpiote.c
View File

@ -246,10 +246,6 @@ static int nrf52_gpiote_isr(int irq, void *context, void *arg)
* - func: When non-NULL, generate interrupt
* - arg: Argument passed to the interrupt callback
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
*
****************************************************************************/
void nrf52_gpiote_set_pin_event(uint32_t pinset, xcpt_t func, void *arg)
@ -285,10 +281,6 @@ void nrf52_gpiote_set_pin_event(uint32_t pinset, xcpt_t func, void *arg)
* - func: When non-NULL, generate interrupt
* - arg: Argument passed to the interrupt callback
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
*
****************************************************************************/
void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func, void *arg)
@ -350,16 +342,12 @@ void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func, void *arg)
*
* Input Parameters:
* - pinset: GPIO pin configuration
* - channel: GPIOTE channel used to capture events
* - risingedge: Enables interrupt on rising edges
* - fallingedge: Enables interrupt on falling edges
* - event: Generate event when set
* - func: When non-NULL, generate interrupt
* - arg: Argument passed to the interrupt callback
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
*
****************************************************************************/
void nrf52_gpiote_set_ch_event(uint32_t pinset, int channel,
@ -456,14 +444,10 @@ void nrf52_gpiote_set_ch_event(uint32_t pinset, int channel,
* Finally, a given pin should only be assigned to a given channel.
*
* Input Parameters:
* - pinset: gpio pin configuration (only port + pin is important here)
* - channel: the GPIOTE channel used to control the given pin
* - pinset: gpio pin configuration (only port + pin is important here)
* - channel: the GPIOTE channel used to control the given pin
* - output_high: set pin initially to output HIGH or LOW.
* - outcfg: configure pin behavior one OUT task is triggered
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
* - outcfg: configure pin behavior one OUT task is triggered
*
****************************************************************************/

23
arch/arm/src/nrf52/nrf52_gpiote.h
View File

@ -57,16 +57,12 @@ enum nrf52_gpiote_outcfg_e
*
* Input Parameters:
* - pinset: GPIO pin configuration
* - channel: GPIOTE channel used to capture events
* - risingedge: Enables interrupt on rising edges
* - fallingedge: Enables interrupt on falling edges
* - event: Generate event when set
* - func: When non-NULL, generate interrupt
* - arg: Argument passed to the interrupt callback
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
*
****************************************************************************/
void nrf52_gpiote_set_ch_event(uint32_t pinset, int channel,
@ -115,14 +111,9 @@ void nrf52_gpiote_set_pin_event(uint32_t pinset, xcpt_t func, void *arg);
* - func: When non-NULL, generate interrupt
* - arg: Argument passed to the interrupt callback
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
*
****************************************************************************/
void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func,
void *arg);
void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func, void *arg);
#endif
@ -138,14 +129,10 @@ void nrf52_gpiote_set_port_event(uint32_t pinset, xcpt_t func,
* Finally, a given pin should only be assigned to a given channel.
*
* Input Parameters:
* - pinset: gpio pin configuration (only port + pin is important here)
* - channel: the GPIOTE channel used to control the given pin
* - pinset: gpio pin configuration (only port + pin is important here)
* - channel: the GPIOTE channel used to control the given pin
* - output_high: set pin initially to output HIGH or LOW.
* - outcfg: configure pin behavior one OUT task is triggered
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure indicating the
* nature of the failure.
* - outcfg: configure pin behavior one OUT task is triggered
*
****************************************************************************/