diff --git a/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt b/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt deleted file mode 100644 index 64f1ee8ba56..00000000000 --- a/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt +++ /dev/null @@ -1,34 +0,0 @@ -Teensy LC README -================ - - This is the README file for NuttX on the PJRC Teensy LC. The Teensy LC - is a DIP style breakout board for the MKL25Z64 and comes with a USB - based bootloader. Contributed by Michael Hope. - -Development Environment -======================= - - All testing was done with the GNU ARM Embedded 4.9 toolchain on - Linux. See https://developer.arm.com/open-source/gnu-toolchain/gnu-rm to download. - - Once you've configured and built NuttX, flash the resulting - nuttx.hex file to the board using the Teensy Loader Application. - -LEDs -==== - - The Teensy LC has a single LED. If CONFIG_ARCH_LEDS is defined, then - NuttX will update the LED as the board boots. The summary is: - - * LED off: board booting - * LED on: initial stack created - * LED flashing: panic. - - See `include/board.h` for details. - -Serial Console -============== - - The serial console is mapped to UART0 and appears on pins 0 (RX) and - 1 (TX). Consider using a 3.3 V USB to serial adapter such as the - Sparkfun #9717 FTDI cable. diff --git a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst index 74ed8fffd18..feb20e78284 100644 --- a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst +++ b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst @@ -2,6 +2,34 @@ teensy-lc ========= -This is the port of nuttx for the Teensy LC board. The Teensy LC -is a DIP style breakout board for the MKL25Z64 and comes with a USB -based bootloader. +This is the NuttX port for the PJRC Teensy LC board. The Teensy LC is a +DIP-style breakout board for the MKL25Z64 and includes a USB-based +bootloader. + +Development Environment +======================= + +Testing was done with the GNU ARM Embedded 4.9 toolchain on Linux. See +https://developer.arm.com/open-source/gnu-toolchain/gnu-rm for toolchain +downloads. + +Once you have configured and built NuttX, flash the resulting ``nuttx.hex`` +image to the board with the Teensy Loader application. + +LEDs +==== + +The Teensy LC provides a single LED. If ``CONFIG_ARCH_LEDS`` is enabled, NuttX +updates that LED during boot: + +* LED off: board booting +* LED on: initial stack created +* LED flashing: panic + +See ``include/board.h`` for the board-specific definitions. + +Serial Console +============== + +The serial console is mapped to UART0 and appears on pins 0 (RX) and 1 (TX). +Use a 3.3 V USB-to-serial adapter, such as the Sparkfun ``#9717`` FTDI cable.