Diff: hal/gpio_irq_api.h

Revision:

1:9db0e321a9f4

Parent:

0:5b88d5760320

--- a/hal/gpio_irq_api.h	Tue Dec 17 23:23:45 2019 +0000
+++ b/hal/gpio_irq_api.h	Tue Dec 31 06:02:27 2019 +0000
@@ -21,6 +21,7 @@
 #define MBED_GPIO_IRQ_API_H
 
 #include "device.h"
+#include "pinmap.h"
 
 #if DEVICE_INTERRUPTIN
 
@@ -44,9 +45,31 @@
 
 /**
  * \defgroup hal_gpioirq GPIO IRQ HAL functions
+ *
+ * # 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
+ *
  * @{
  */
 
+/**
+ * \defgroup hal_gpioirq_tests GPIO IRQ HAL tests
+ * The GPIO IRQ HAL tests ensure driver conformance to defined behaviour.
+ *
+ * To run the GPIO IRQ hal tests use the command:
+ *
+ *     mbed test -t <toolchain> -m <target> -n tests-mbed_hal_fpga_ci_test_shield-gpio_irq
+ *
+ */
+
 /** Initialize the GPIO IRQ pin
  *
  * @param obj     The GPIO object to initialize
@@ -85,6 +108,18 @@
  */
 void gpio_irq_disable(gpio_irq_t *obj);
 
+/** 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.
+ *
+ * @return PinMap array
+ */
+const PinMap *gpio_irq_pinmap(void);
+
 /**@}*/
 
 #ifdef __cplusplus