From: Nathael Pajani <nathael.pajani@ed3l.fr>
Date: Sun, 8 Jun 2014 22:00:47 +0000 (+0200)
Subject: Adding some comments about the "status" led used on the demo module.
X-Git-Url: http://git.techno-innov.fr/?a=commitdiff_plain;h=4a1eb4a06860e00ffa19c224003086592f5b8782;p=soft%2Flpc122x%2Fcore

Adding some comments about the "status" led used on the demo module.
---

diff --git a/drivers/status_led.c b/drivers/status_led.c
index e55efd4..e499524 100644
--- a/drivers/status_led.c
+++ b/drivers/status_led.c
@@ -33,6 +33,18 @@
 /***************************************************************************** */
 /* Status LED is the bicolors red/green led on the GPIO Demo module */
 
+/* This code configures the status led and enables it's use as a debug helper
+ * or visual watchdog.
+ * Calls to chenillard() with a value of about 25ms or more will trigger a
+ * defined sequence to be displayed by the status led.
+ * This sequence implies a big delay in your code (eleven times the value used
+ * as argument in ms.
+ *
+ * If you want to use this led in a more application friendly way (with no sleep)
+ * you must use a timer to call a "stepping" routine (either systick timer or any
+ * of the other four timers).
+ */
+
 /* The status LED is on GPIO Port 1, pin 4 (PIO1_4) and Port 1, pin 5 (PIO1_5) */
 #define LED_RED    5
 #define LED_GREEN  4