boards/cc1352-launchpad: add documentation

Signed-off-by: Jean Pierre Dudey <me@jeandudey.tech>
2024-12-29 04:50:03 +01:00 · 2021-02-17 11:03:46 +01:00 · 2021-02-17 11:03:46 +01:00 · 89a1afb4a1
commit 89a1afb4a1
parent e222e19299
1 changed files with 69 additions and 4 deletions
--- a/boards/cc1352-launchpad/doc.txt
+++ b/boards/cc1352-launchpad/doc.txt
@ -1,5 +1,70 @@
 /**
- * @defgroup        boards_cc1352_launchpad TI CC1352 LaunchPad
- * @ingroup         boards
- * @brief           Texas Instruments SimpleLink(TM) CC1352 Wireless MCU LaunchPad(TM) Kit
- */
+@defgroup        boards_cc1352_launchpad TI CC1352 LaunchPad
+@ingroup         boards
+@brief           Texas Instruments SimpleLink(TM) CC1352 Wireless MCU LaunchPad(TM) Kit
+
+## <a name="cc1352_launchpad_toc"> Table of Contents </a> &nbsp;[[TOC]](#cc1352_launchpad_toc)
+
+1. [Overview](#cc1352_launchpad_overview)
+2. [Hardware](#cc1352_launchpad_hardware)
+3. [Board pinout](#cc1352_launcpad_pinout)
+4. [Flashing the Device](#cc1352_launchpad_flashing)
+
+## <a name="cc1352_launchpad_overview"> Overview </a> &nbsp;[[TOC]](#cc1352_launchpad_toc)
+
+The [LAUNCHXL-CC1352R1](https://www.ti.com/tool/LAUNCHXL-CC1352R1) is a Texas
+Instrument's development kit for the CC1352R1 SoC MCU which combines a
+Cortex-M4F microcontroller alongside a dedicated Cortex-M0 to control radio.
+
+## <a name="cc1352_launchpad_hardware"> Hardware </a> &nbsp;[[TOC]](#cc1352_launchpad_toc)
+
+![LAUNCHXL-CC1352R1](https://www.ti.com/diagrams/launchxl-cc1352r1_launchxl-cc1352r1-angled.jpg)
+
+| MCU               | CC1352R1              |
+|:----------------- |:--------------------- |
+| Family            | ARM Cortex-M4F        |
+| Vendor            | Texas Instruments     |
+| RAM               | 80KiB                 |
+| Flash             | 352KiB                |
+| Frequency         | 48MHz                 |
+| FPU               | yes                   |
+| Timers            | 4                     |
+| ADCs              | 1x 12-bit (channels)  |
+| UARTs             | 2                     |
+| SPIs              | 2                     |
+| I2Cs              | 1                     |
+| Vcc               | 1.8V - 3.8V           |
+| Datasheet         | [Datasheet](http://www.ti.com/lit/ds/symlink/cc1352r.pdf) (pdf file) |
+| Reference Manual  | [Reference Manual](http://www.ti.com/lit/ug/swcu185d/swcu185d.pdf) |
+
+## <a name="cc1352_launcpad_pinout"> Board pinout </a> &nbsp;[[TOC]](#cc1352_launchpad_toc)
+
+The [LAUNCHXL-CC1352R1 Quick Start Guide](https://www.ti.com/lit/ml/swru525e/swru525e.pdf)
+provides the default pinout for the board.
+
+## <a name="cc1352_launchpad_flashing"> Flashing the Device </a> &nbsp;[[TOC]](#cc1352_launchpad_toc)
+
+Flashing RIOT is quite straight forward. The board comes with an XDS110 on-board
+debug probe that provides programming, flashing and debugging capabilities
+through the USB Micro-USB connector. Once either TI Uniflash or OpenOCD are
+installed just connect the board using the Micro-USB port to your computer and
+type:
+
+```
+make flash BOARD=cc1352-launchpad
+```
+
+To use OpenOCD instead of uniflash we need to set the `PROGRAMMER` environment
+variable, this is to enable OpenOCD instead of Uniflash.
+
+```
+export PROGRAMMER=openocd
+```
+
+Now we can just do `make flash` and `make debug`, this all using OpenOCD.
+
+For detailed information about CC1352R1 MCUs as well as configuring, compiling
+RIOT and installation of flashing tools for CC1352R1 boards,
+see \ref cc26xx_cc13xx_riot.
+
+*/