Mistake on this page?
Report an issue in GitHub or email us
Modules | Functions
GPIO IRQ HAL functions

Defined behavior

More...

Modules

 GPIO IRQ HAL tests
 The GPIO IRQ HAL tests ensure driver conformance to defined behaviour.
 

Functions

int gpio_irq_init (gpio_irq_t *obj, PinName pin, gpio_irq_handler handler, uintptr_t context)
 Initialize the GPIO IRQ pin. More...
 
void gpio_irq_free (gpio_irq_t *obj)
 Release the GPIO IRQ PIN. More...
 
void gpio_irq_set (gpio_irq_t *obj, gpio_irq_event event, uint32_t enable)
 Enable/disable pin IRQ event. More...
 
void gpio_irq_enable (gpio_irq_t *obj)
 Enable GPIO IRQ. More...
 
void gpio_irq_disable (gpio_irq_t *obj)
 Disable GPIO IRQ. More...
 
const PinMapgpio_irq_pinmap (void)
 Get the pins that support all GPIO IRQ tests. More...
 

Detailed Description

Defined behavior

Undefined behavior

Function Documentation

void gpio_irq_disable ( gpio_irq_t obj)

Disable GPIO IRQ.

This is target dependent, as it might disable the entire port or just a pin

Parameters
objThe GPIO object
void gpio_irq_enable ( gpio_irq_t obj)

Enable GPIO IRQ.

This is target dependent, as it might enable the entire port or just a pin

Parameters
objThe GPIO object
void gpio_irq_free ( gpio_irq_t obj)

Release the GPIO IRQ PIN.

Parameters
objThe gpio object
int gpio_irq_init ( gpio_irq_t obj,
PinName  pin,
gpio_irq_handler  handler,
uintptr_t  context 
)

Initialize the GPIO IRQ pin.

Parameters
objThe GPIO object to initialize
pinThe GPIO pin name
handlerThe handler to be attached to GPIO IRQ
contextThe context to be passed back to the handler (context != 0, 0 is reserved)
Returns
-1 if pin is NC, 0 otherwise
const PinMap* gpio_irq_pinmap ( void  )

Get the pins that support all GPIO IRQ tests.

Return a PinMap array of pins that support GPIO IRQ. The array is terminated with {NC, NC, 0}.

Targets should override the weak implementation of this function to provide the actual pinmap for GPIO IRQ testing.

Returns
PinMap array
void gpio_irq_set ( gpio_irq_t obj,
gpio_irq_event  event,
uint32_t  enable 
)

Enable/disable pin IRQ event.

Parameters
objThe GPIO object
eventThe GPIO IRQ event
enableThe enable flag
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.