File tree Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Original file line number Diff line number Diff line change @@ -45,9 +45,31 @@ typedef void (*gpio_irq_handler)(uint32_t id, gpio_irq_event event);
4545
4646/**
4747 * \defgroup hal_gpioirq GPIO IRQ HAL functions
48+ *
49+ * # Defined behavior
50+ * * ::gpio_irq_init initializes the GPIO IRQ pin
51+ * * ::gpio_irq_init attaches the interrupt handler
52+ * * ::gpio_irq_free releases the GPIO IRQ pin
53+ * * ::gpio_irq_set enables/disables pin IRQ event
54+ * * ::gpio_irq_enable enables GPIO IRQ
55+ * * ::gpio_irq_disable disables GPIO IRQ
56+ *
57+ * # Undefined behavior
58+ * * Calling other function before ::gpio_irq_init
59+ *
4860 * @{
4961 */
5062
63+ /**
64+ * \defgroup hal_gpioirq_tests GPIO IRQ HAL tests
65+ * The GPIO IRQ HAL tests ensure driver conformance to defined behaviour.
66+ *
67+ * To run the GPIO IRQ hal tests use the command:
68+ *
69+ * mbed test -t <toolchain> -m <target> -n tests-mbed_hal_fpga_ci_test_shield-gpio_irq
70+ *
71+ */
72+
5173/** Initialize the GPIO IRQ pin
5274 *
5375 * @param obj The GPIO object to initialize
You can’t perform that action at this time.
0 commit comments