diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 1cab777e7ee..440487e3341 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@
Last Updated: February 27, 2015
+Last Updated: February 28, 2015
@@ -4087,17 +4087,32 @@ void board_led_off(int led);
void board_led_initialize(void) is called early in power-up initialization to initialize the LED hardware.
+
+ NOTE: In most architectures, board_led_initialize() is called from board-specific initialization logic.
+ But there are a few architectures where this initialization function is still called from common chip architecture logic.
+ This interface is nott, however, a common board interface in any event.
+
+
+ WARNING: This interface name will eventually be removed; do not use it in new board ports.
+ New implementations should not use the naming convention for common board interfaces, but should instted use the naming conventions for microprocessor-specific interfaces or the board-specific interfaces (such as stm32_led_initialize()).
+
board_led_on(int led) is called to instantiate the LED presentation of the event.
The led argument is one of the definitions provided in <board-name>/include/board.h.
+
board_led_off(int ledis called to terminate the LED presentation of the event.
The led argument is one of the definitions provided in <board-name>/include/board.h.
Note that only LED_INIRQ, LED_SIGNAL, LED_ASSERTION, and LED_PANIC
indications are terminated.
+