RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #9978 from haukepetersen/fix_periph_gpiofeaturescopeanddoc

Browse Source 
periph/gpio: fix doc of `periph_gpio_irq` submodule
This commit is contained in:
Joakim Nohlgård 2018-09-21 13:15:19 +02:00 committed by GitHub
commit c4016fcf3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
drivers/include/periph/gpio.h
View File

@ -148,7 +148,7 @@ typedef struct {
*/ */
int gpio_init(gpio_t pin, gpio_mode_t mode); int gpio_init(gpio_t pin, gpio_mode_t mode);
#ifdef MODULE_PERIPH_GPIO_IRQ #if defined(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN)
/** /**
* @brief Initialize a GPIO pin for external interrupt usage * @brief Initialize a GPIO pin for external interrupt usage
* *
@ -157,6 +157,9 @@ int gpio_init(gpio_t pin, gpio_mode_t mode);
* *
* The interrupt is activated automatically after the initialization. * The interrupt is activated automatically after the initialization.
* *
* @note You have to add the module `periph_gpio_irq` to your project to
* enable this function
*
* @param[in] pin pin to initialize * @param[in] pin pin to initialize
* @param[in] mode mode of the pin, see @c gpio_mode_t * @param[in] mode mode of the pin, see @c gpio_mode_t
* @param[in] flank define the active flank(s) * @param[in] flank define the active flank(s)
@ -174,6 +177,9 @@ int gpio_init_int(gpio_t pin, gpio_mode_t mode, gpio_flank_t flank,
/** /**
* @brief Enable pin interrupt if configured as interrupt source * @brief Enable pin interrupt if configured as interrupt source
* *
* @note You have to add the module `periph_gpio_irq` to your project to
* enable this function
*
* @param[in] pin the pin to enable the interrupt for * @param[in] pin the pin to enable the interrupt for
*/ */
void gpio_irq_enable(gpio_t pin); void gpio_irq_enable(gpio_t pin);
@ -181,6 +187,9 @@ void gpio_irq_enable(gpio_t pin);
/** /**
* @brief Disable the pin interrupt if configured as interrupt source * @brief Disable the pin interrupt if configured as interrupt source
* *
* @note You have to add the module `periph_gpio_irq` to your project to
* enable this function
*
* @param[in] pin the pin to disable the interrupt for * @param[in] pin the pin to disable the interrupt for
*/ */
void gpio_irq_disable(gpio_t pin); void gpio_irq_disable(gpio_t pin);