You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2021/04/25 21:46:35 UTC

[GitHub] [incubator-nuttx] Ouss4 commented on a change in pull request #3604: docs: Add initial board docs for Tiva arch

Ouss4 commented on a change in pull request #3604:
URL: https://github.com/apache/incubator-nuttx/pull/3604#discussion_r619882495



##########
File path: Documentation/platforms/arm/tiva/launchxl-cc1312r1/index.rst
##########
@@ -0,0 +1,138 @@
+====================
+TI LaunchXL-CC1312R1
+====================
+
+SimpleLink Sub-1 GHz CC1312R Wireless Microcontroller (MCU) LaunchPad Development Kit
+
+`LaunchXL-CC1312R1 <https://www.ti.com/tool/LAUNCHXL-CC1312R1>`_
+
+
+Serial Console
+==============
+
+The on-board XDS110 Debugger provide a USB virtual serial console using

Review comment:
       ```suggestion
   The on-board XDS110 Debugger provides a USB virtual serial console using
   ```

##########
File path: Documentation/platforms/arm/tiva/launchxl-cc1310/index.rst
##########
@@ -0,0 +1,94 @@
+====================
+TI LaunchXL-CC1310
+====================
+
+SimpleLink Sub-1 GHz CC1310 wireless MCU LaunchPad development kit
+
+`TI LaunchXL-CC1310 <https://www.ti.com/tool/LAUNCHXL-CC1310>`_
+
+
+Serial Console
+==============
+
+The on-board XDS110 Debugger provide a USB virtual serial console using

Review comment:
       ```suggestion
   The on-board XDS110 Debugger provides a USB virtual serial console using
   ```

##########
File path: Documentation/platforms/arm/tiva/launchxl-cc1312r1/index.rst
##########
@@ -0,0 +1,138 @@
+====================
+TI LaunchXL-CC1312R1
+====================
+
+SimpleLink Sub-1 GHz CC1312R Wireless Microcontroller (MCU) LaunchPad Development Kit
+
+`LaunchXL-CC1312R1 <https://www.ti.com/tool/LAUNCHXL-CC1312R1>`_
+
+
+Serial Console
+==============
+
+The on-board XDS110 Debugger provide a USB virtual serial console using
+UART0 (DIO2_RXD and DIO3_TXD).
+
+A J-Link debugger is used (see below), then the RXD/TXD jumper pins can
+be used to support a serial console through these same pins via an
+appropriate TTL level adapter (RS-232 or USB serial).
+
+LEDs and Buttons
+================
+
+LEDs
+----
+
+The LaunchXL-cc1312R1 has two LEDs controlled by software:  DIO7_GLED (CR1)
+and DIO6_RLED (CR2).  A high output value illuminates an LED.
+
+=========  ==== ========================
+DIO7_GLED  CR1  High output illuminates
+DIO6_RLED  CR2  High output illuminates
+=========  ==== ========================
+
+If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in
+any way.  The definitions provided in the board.h header file can be used
+to access individual LEDs.
+
+These LEDs are not used by the board port unless CONFIG_ARCH_LEDS is
+defined.  In that case, the usage by the board port is defined in
+include/board.h and src/cc1312_autoleds.c. The LEDs are used to encode
+OS-related events as follows:
+
+================== ======================== ====== ======
+SYMBOL              Meaning                 G-LED   R-LED
+================== ======================== ====== ======
+LED_STARTED        NuttX has been started   OFF    OFF
+LED_HEAPALLOCATE   Heap has been allocated  OFF    ON
+LED_IRQSENABLED    Interrupts enabled       OFF    ON
+LED_STACKCREATED   Idle stack created       ON     OFF
+LED_INIRQ          In an interrupt          N/C    GLOW
+LED_SIGNAL         In a signal handler      N/C    GLOW
+LED_ASSERTION      An assertion failed      N/C    GLOW
+LED_PANIC          The system has crashed   OFF    Blinking
+LED_IDLE           MCU is is sleep mode     N/A    N/A
+================== ======================== ====== ======
+
+Thus if GLED is statically on, NuttX has successfully booted and is,
+apparently, running normally.  A soft glow of the RLED means that the
+board is taking interrupts.   If GLED is off and GLED is flashing at
+approximately 2Hz, then a fatal error has been detected and the system
+has halted.
+
+Buttons
+-------
+
+The LaunchXL-CC1312R1 has two push-puttons:
+
+=========== ==== ===============================
+DIO13_BTN1  SW1  Low input sensed when depressed
+DIO14_BTN2  SW2  Low input sensed when depressed
+=========== ==== ===============================
+
+Version 1 or 2?
+===============
+
+Two versions of the CC1312R1 are supported selected by CONFIG_ARCH_CHIP_CC13XX_V1
+or CONFIG_ARCH_CHIP_CC13XX_V2.  It is not clear how to identify the chip version
+from markings on it.
+
+What you can do is enable CONFIG_DEBUG_ASSERTIONS.  The firmware can
+determine which version you have by looking at register contents.  The
+firmware will assert if you select the wrong version.  If that occurs,
+switch to the other version and the assertion should go away.
+
+Running from SRAM
+=================
+
+The LaunchXL-CC1312R1 port supports execution from RAM.  Execution from
+SRAM as a "safe" way to bring up a new board port without concern about
+borking the board because of a bad FLASH image.

Review comment:
       ```suggestion
   breaking the board because of a bad FLASH image.
   ```
   ```suggestion
   bricking the board because of a bad FLASH image.
   ```
   ?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org