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 14:45:36 UTC
[GitHub] [incubator-nuttx] v01d commented on a change in pull request #3604: docs: Add initial board docs for Tiva arch
v01d commented on a change in pull request #3604:
URL: https://github.com/apache/incubator-nuttx/pull/3604#discussion_r619826394
##########
File path: Documentation/platforms/arm/tiva/index.rst
##########
@@ -0,0 +1,74 @@
+===================================================
+Texas Instruments Tiva C / Luminary Micro Stellaris
+===================================================
+
+The Tiva architecture is a combination of the Luminary Micro Stellaris chips
+and the TI Tiva variants. There are both M3 and M4 Arm cores in this family.
+
+Supported MCUs
+=============
+
+The following list includes MCUs from Tiva C series supported in NuttX
+
+============= ============== ======= =================
+MCU Core Radio Frequency
+============= ============== ======= =================
+LM3S6918 Cortex-M3 No 50 MHz
+LM3S9B92 Cortex-M3 No 50 MHz
+LM3S9B96 Cortex-M3 No 50 MHz
+LM3S6432 Cortex-M3 No 50 MHz
+LM3S6965 Cortex-M3 No 50 MHz
+LM3S8962 Cortex-M3 No 50 MHz
+LM4F120 Cortex-M4 No 80 MHz
+TM4C123AH6PM Cortex-M4 No 120 MHz
+TM4C123GH6ZRB Cortex-M4 No 120 MHz
+TM4C123GH6PM Cortex-M4 No 120 MHz
+TM4C123GH6PZ Cortex-M4 No 120 MHz
+TM4C123GH6PGE Cortex-M4 No 120 MHz
+TM4C1294NCPDT Cortex-M4 No 120 MHz
+TM4C129ENCPDT Cortex-M4 No 120 MHz
+TM4C129ENCZAD Cortex-M4 No 120 MHz
+TM4C129XNCZAD Cortex-M4 No 120 MHz
+CC1310 Cortex-M3 Yes 24 MHz
+CC1312R1 Cortex-M4 Yes 48 MHz
+CC1352R1 Cortex-M4 Yes 48 MHz
+============= ============== ======= =================
+
+Peripheral Support
+==================
+
+The following list indicates peripherals supported in NuttX:
+
+==========
+Peripheral
+==========
+GPIO
+ADC
+EEPROM
+FLASH
+HCIUART
+I2C
+MPU
+PWM
+QENCODER
+SERIAL
+SSI
+TIMER
+ETHERNET
+WDT
+I2S
+USB
+==========
Review comment:
For other platforms this is a table with two more columns indicating support and any notes. It is better if we maintain format across documents, even if in this case everything is supported.
##########
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
+UART0 (PA0/U0RX and PA1/U0TX).
+
+A J-Link debugger is used (see below), then the RXD/TXD jumper pins can
+be used to support a serial console through 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/cc1310_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-CC1310 has two push-puttons:
+
+=========== ==== ===============================
+DIO13_BTN1 SW1 Low input sensed when depressed
+DIO14_BTN2 SW2 Low input sensed when depressed
+=========== ==== ===============================
Review comment:
same as above
##########
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
+UART0 (PA0/U0RX and PA1/U0TX).
+
+A J-Link debugger is used (see below), then the RXD/TXD jumper pins can
+be used to support a serial console through 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
+========= ==== ========================
Review comment:
Add a header to indicate what the columns are?
##########
File path: Documentation/platforms/arm/tiva/index.rst
##########
@@ -0,0 +1,74 @@
+===================================================
+Texas Instruments Tiva C / Luminary Micro Stellaris
+===================================================
+
+The Tiva architecture is a combination of the Luminary Micro Stellaris chips
+and the TI Tiva variants. There are both M3 and M4 Arm cores in this family.
+
+Supported MCUs
+=============
Review comment:
```suggestion
==============
```
##########
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>`_
Review comment:
Integrate link in previous line. If you have a board picture, it would be good to add.
##########
File path: Documentation/platforms/arm/tiva/index.rst
##########
@@ -0,0 +1,74 @@
+===================================================
+Texas Instruments Tiva C / Luminary Micro Stellaris
+===================================================
+
+The Tiva architecture is a combination of the Luminary Micro Stellaris chips
+and the TI Tiva variants. There are both M3 and M4 Arm cores in this family.
+
+Supported MCUs
+=============
+
+The following list includes MCUs from Tiva C series supported in NuttX
+
+============= ============== ======= =================
+MCU Core Radio Frequency
+============= ============== ======= =================
+LM3S6918 Cortex-M3 No 50 MHz
+LM3S9B92 Cortex-M3 No 50 MHz
+LM3S9B96 Cortex-M3 No 50 MHz
+LM3S6432 Cortex-M3 No 50 MHz
+LM3S6965 Cortex-M3 No 50 MHz
+LM3S8962 Cortex-M3 No 50 MHz
+LM4F120 Cortex-M4 No 80 MHz
+TM4C123AH6PM Cortex-M4 No 120 MHz
+TM4C123GH6ZRB Cortex-M4 No 120 MHz
+TM4C123GH6PM Cortex-M4 No 120 MHz
+TM4C123GH6PZ Cortex-M4 No 120 MHz
+TM4C123GH6PGE Cortex-M4 No 120 MHz
+TM4C1294NCPDT Cortex-M4 No 120 MHz
+TM4C129ENCPDT Cortex-M4 No 120 MHz
+TM4C129ENCZAD Cortex-M4 No 120 MHz
+TM4C129XNCZAD Cortex-M4 No 120 MHz
+CC1310 Cortex-M3 Yes 24 MHz
+CC1312R1 Cortex-M4 Yes 48 MHz
+CC1352R1 Cortex-M4 Yes 48 MHz
+============= ============== ======= =================
+
+Peripheral Support
+==================
+
+The following list indicates peripherals supported in NuttX:
+
+==========
+Peripheral
+==========
+GPIO
+ADC
+EEPROM
+FLASH
+HCIUART
+I2C
+MPU
+PWM
+QENCODER
+SERIAL
+SSI
+TIMER
+ETHERNET
+WDT
+I2S
+USB
+==========
+
+GPIO
+-----------
Review comment:
?
##########
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
+UART0 (PA0/U0RX and PA1/U0TX).
+
+A J-Link debugger is used (see below), then the RXD/TXD jumper pins can
+be used to support a serial console through 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
Review comment:
use backticks for config terms and filenames.
--
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