Diff: README.md

Revision:

3:2f8e3fcbdd7e

Child:

4:a4b47a6be229

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Mon Nov 14 10:45:36 2016 +0800
@@ -0,0 +1,51 @@
+# Example for GPIO IRQ
+
+This is an example for GPIO IRQ with de-bounce enabled.
+
+## Enable GPIO IRQ de-bounce
+
+Add a file *mbed_app.json* with the following configuration
+
+- gpio-irq-debounce-enable. Enable/disable GPIO IRQ de-bounce
+    - 0: disable de-bounce
+    - 1: enable de-bounce
+- gpio-irq-debounce-clock-source. Select clock source as GPIO IRQ de-bounce is enabled.
+    - GPIO_DBCTL_DBCLKSRC_IRC10K (NuMaker-PFM-NUC472)
+    - GPIO_DBCTL_DBCLKSRC_HCLK (NuMaker-PFM-NUC472/M453)
+    - GPIO_DBCTL_DBCLKSRC_LIRC (NuMaker-PFM-M453)
+- gpio-irq-debounce-sample-rate. Select delay as GPIO IRQ de-bounce is enabled.
+    - GPIO_DBCTL_DBCLKSEL_1
+    - GPIO_DBCTL_DBCLKSEL_2
+    - GPIO_DBCTL_DBCLKSEL_4
+    - ...
+    - GPIO_DBCTL_DBCLKSEL_32768
+    
+### Example: enable GPIO IRQ de-bounce for NuMaker-PFM-NUC472 target
+```
+{
+    "target_overrides": {
+        "NUMAKER_PFM_NUC472": {
+            "NUC472.gpio-irq-debounce-enable": 1,
+            "NUC472.gpio-irq-debounce-clock-source": "GPIO_DBCTL_DBCLKSRC_IRC10K",
+            "NUC472.gpio-irq-debounce-sample-rate": "GPIO_DBCTL_DBCLKSEL_16"
+        }
+    }
+}
+```
+
+### Example: enable GPIO IRQ de-bounce for NuMaker-PFM-M453 target
+```
+{
+    "target_overrides": {
+        "NUMAKER_PFM_M453": {
+            "M451.gpio-irq-debounce-enable": 1,
+            "M451.gpio-irq-debounce-clock-source": "GPIO_DBCTL_DBCLKSRC_LIRC",
+            "M451.gpio-irq-debounce-sample-rate": "GPIO_DBCTL_DBCLKSEL_16"
+        }
+    }
+}
+```
+
+## Known issues
+- GPIO IRQ de-bounce defaults to disabled. If enabled, communication with GPIO pin as interrupt pin won't fit 
+or even fail due to the de-bounce delay.
\ No newline at end of file