diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2015-02-28 06:46:19 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2015-02-28 06:46:19 -0600 |
commit | 87994b585685fb695310d6ef01fcd3d55c6798bc (patch) | |
tree | 7676a8a8fc7dad9bf5c0ae569834adf935df2d55 | |
parent | 06c1f6195d5dabf657a5038c26e27065e0fb7c68 (diff) | |
download | nuttx-87994b585685fb695310d6ef01fcd3d55c6798bc.tar.gz nuttx-87994b585685fb695310d6ef01fcd3d55c6798bc.tar.bz2 nuttx-87994b585685fb695310d6ef01fcd3d55c6798bc.zip |
Update comment and documentation for board interfaces
-rw-r--r-- | nuttx/Documentation/NuttxPortingGuide.html | 17 | ||||
-rw-r--r-- | nuttx/include/nuttx/board.h | 13 |
2 files changed, 26 insertions, 4 deletions
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html index 1cab777e7..440487e33 100644 --- a/nuttx/Documentation/NuttxPortingGuide.html +++ b/nuttx/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@ <h1><big><font color="#3c34ec"> <i>NuttX RTOS Porting Guide</i> </font></big></h1> - <p>Last Updated: February 27, 2015</p> + <p>Last Updated: February 28, 2015</p> </td> </tr> </table> @@ -4087,17 +4087,32 @@ void board_led_off(int led); <p> <ul> <li> + <p> <code>void board_led_initialize(void)</code> is called early in power-up initialization to initialize the LED hardware. + </p> + <small><blockquote> + <b>NOTE:</b> In most architectures, <code>board_led_initialize()</code> 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. + </blockquote> + <blockquote> + <b>WARNING:</b> 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 <code>stm32_led_initialize()</code>). + </blockquote></small> </li> <li> + <p> <code>board_led_on(int led)</code> is called to instantiate the LED presentation of the event. The <code>led</code> argument is one of the definitions provided in <code><i><board-name></i>/include/board.h</code>. + </p> </li> + <p> <li> <code>board_led_off(int led</code>is called to terminate the LED presentation of the event. The <code>led</code> argument is one of the definitions provided in <code><i><board-name></i>/include/board.h</code>. Note that only <code>LED_INIRQ</code>, <code>LED_SIGNAL</code>, <code>LED_ASSERTION</code>, and <code>LED_PANIC</code> indications are terminated. + </p> </li> </ul> diff --git a/nuttx/include/nuttx/board.h b/nuttx/include/nuttx/board.h index c923445ac..55aa85b60 100644 --- a/nuttx/include/nuttx/board.h +++ b/nuttx/include/nuttx/board.h @@ -139,9 +139,16 @@ void board_initialize(void); * things as, for example, configure GPIO pins to drive the LEDs and also * putting the LEDs in their correct initial state. * - * In most architectures, board_led_initialize() is called fromo board- - * specific initialization logic. But there are a few architectures where - * this initialization function is called from shared chip logic. + * 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 not, 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 use the naming + * conventions for "Microprocessor-Specific Interfaces" or the "Board- + * Specific Interfaces" as described above. * * Input Parameters: * None |