GPIO IRQ HAL functions

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 PinMap *	gpio_irq_pinmap (void)
	Get the pins that support all GPIO IRQ tests. More...

Detailed Description

Defined behavior

• gpio_irq_init initializes the GPIO IRQ pin
• gpio_irq_init attaches the interrupt handler
• gpio_irq_free releases the GPIO IRQ pin
• gpio_irq_set enables/disables pin IRQ event
• gpio_irq_enable enables GPIO IRQ
• gpio_irq_disable disables GPIO IRQ

Undefined behavior

• Calling other function before gpio_irq_init

Function Documentation

gpio_irq_init()

int gpio_irq_init	(	gpio_irq_t *	obj,
		PinName	pin,
		gpio_irq_handler	handler,
		uintptr_t	context
	)

Initialize the GPIO IRQ pin.

Parameters

obj	The GPIO object to initialize
pin	The GPIO pin name
handler	The handler to be attached to GPIO IRQ
context	The context to be passed back to the handler (context != 0, 0 is reserved)

Returns

-1 if pin is NC, 0 otherwise

gpio_irq_free()

void gpio_irq_free

(

gpio_irq_t *

obj

)

Release the GPIO IRQ PIN.

Parameters

obj	The gpio object

gpio_irq_set()

void gpio_irq_set	(	gpio_irq_t *	obj,
		gpio_irq_event	event,
		uint32_t	enable
	)

Enable/disable pin IRQ event.

Parameters

obj	The GPIO object
event	The GPIO IRQ event
enable	The enable flag

gpio_irq_enable()

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

obj	The GPIO object

gpio_irq_disable()

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

obj	The GPIO object

gpio_irq_pinmap()

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