mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
cpu/cc26xx_cc13xx: add CPU documentation
Signed-off-by: Jean Pierre Dudey <me@jeandudey.tech>
This commit is contained in:
Jean Pierre Dudey
parent
093272c562
commit
5a17e1335f
@ -1,15 +1,162 @@
|
||||
/**
|
||||
* @defgroup cpu_cc26xx_cc13xx CC26xx_CC13xx common
|
||||
* @ingroup cpu
|
||||
* @brief Common code for TI cc26xx/cc13xx family
|
||||
*
|
||||
* This module contains code common to all cc26xx/cc13xx cpus
|
||||
* supported by RIOT: @ref cpu_cc26x0_cc13x0, @ref cpu_cc26x2_cc13x2
|
||||
*
|
||||
*/
|
||||
@defgroup cpu_cc26xx_cc13xx CC26xx/CC13xx common
|
||||
@ingroup cpu
|
||||
@brief Common code for TI cc26xx/cc13xx family
|
||||
|
||||
This module contains code common to all cc26xx/cc13xx cpus
|
||||
supported by RIOT: @ref cpu_cc26x0_cc13x0, @ref cpu_cc26x2_cc13x2
|
||||
|
||||
\section cc26xx_cc13xx_riot RIOT-OS on CC26xx/CC13xx boards
|
||||
|
||||
## <a name="cc26xx_cc13xx_toc"> Table of Contents </a> [[TOC]](#cc26xx_cc13xx_toc)
|
||||
|
||||
1. [Overview](#cc26xx_cc13xx_overview)
|
||||
2. [Flashing the CCFG](#cc26xx_cc13xx_ccfg)
|
||||
3. [Debugging](#cc26xx_cc13xx_debugging)
|
||||
1. [Using OpenOCD](#cc26xx_cc13xx_openocd)
|
||||
1. [Using Uniflash](#cc26xx_cc13xx_uniflash)
|
||||
|
||||
# <a name="cc26xx_cc13xx_overview"> Overview </a> [[TOC]](#cc26xx_cc13xx_toc)
|
||||
|
||||
The CC26xx/C13xx is a family of micro controllers fabricated by Texas Instruments
|
||||
for low-power communications, using protocols such as BLE, IEEE 802.15.4g-2012,
|
||||
and proprietary radio protocols.
|
||||
|
||||
These family of MCUs is divided in two generations, the cc26x0/cc13x0, and the
|
||||
cc26x2/cc13x2 family. The difference is that the later provides more ROM and RAM
|
||||
and improvements on various peripherals.
|
||||
|
||||
MCU family | RAM | Flash
|
||||
:--------------|:-----|:------
|
||||
CC26x0/CC13x0 | 20 K | 128 K
|
||||
CC26x2/CC13x2 | 80 K | 352 K
|
||||
|
||||
@note The actual flash size is the flash size minus 88 bytes, these 88 bytes are
|
||||
reserved for the CCFG, see also [Flashing the CCFG](#cc26xx_cc13xx_ccfg).
|
||||
|
||||
# <a name="cc26xx_cc13xx_ccfg"> Flashing the CCFG </a> [[TOC]](#cc26xx_cc13xx_toc)
|
||||
|
||||
@warning Setting an incorrect CCFG configuration may lock out yourself
|
||||
out of the device.
|
||||
|
||||
@note Blank chips from Texas Instruments come without a CCFG flashed, so any
|
||||
firmware flashed won't boot until the configuration is flashed. As this might be
|
||||
the case for custom boards remember flashing it.
|
||||
|
||||
RIOT provides built-in support to flash the Customer Configuration on the
|
||||
CC26xx/CC13xx MCUs. It can be done through Kconfig using `make menuconfig`.
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
make -C examples/hello-world menuconfig BOARD=cc1350-launchpad
|
||||
```
|
||||
|
||||
It will open the Kconfig terminal configuration utility, you may see the
|
||||
`Update CCFG` option, selecting it will include the default configuration that
|
||||
Texas Instruments provides from their own SDK. You may change any further
|
||||
options available through Kconfig.
|
||||
|
||||
Once configuration is saved you may compile a new binary and flash it onto the
|
||||
device.
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
make -C examples/hello-world flash BOARD=cc1350-launchpad
|
||||
```
|
||||
|
||||
@note Once flashed, there's no need to flash it again, unless the configuration
|
||||
needs to be changed.
|
||||
|
||||
# <a name="cc26xx_cc13xx_debugging"> Debuggging </a> [[TOC]](#cc26xx_cc13xx_toc)
|
||||
|
||||
Development kits from Texas Instruments come with an XDS110 on-board debug probe
|
||||
that provides programming, flashing and debugging capabilities.
|
||||
|
||||
It can either use proprietary Texas Instruments tools for programming, or OpenOCD.
|
||||
|
||||
### <a name="cc26xx_cc13xx_openocd"> Using OpenOCD </a> [[TOC]](#cc26xx_cc13xx_toc)
|
||||
|
||||
To use OpenOCD with the XDS110 you need to use the an special version of
|
||||
OpenOCD made by TI (upstream version is not _yet_ compatible). You can
|
||||
clone and compile it from source:
|
||||
|
||||
```
|
||||
# Clone into the openocd-ti folder
|
||||
git clone https://git.ti.com/cgit/sdo-emu/openocd openocd-ti
|
||||
|
||||
# Change directory to the openocd source code
|
||||
cd openocd-ti/openocd
|
||||
|
||||
# Configure, build, install
|
||||
./configure
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
||||
@note Sometimes OpenOCD may stop working when the firmware on the XDS110
|
||||
is updated (when using Uniflash, happens without user intervention). With that
|
||||
in mind, it's encouraged to either enable the ROM bootloader backdoor to enable
|
||||
serial programming or the installation of TI Uniflash as a fallback. See
|
||||
[Using Uniflash](#cc26xx_cc13xx_uniflash)
|
||||
|
||||
#### Setting up the environment
|
||||
|
||||
To flash a board using OpenOCD you can use do it so by setting the `PROGRAMMER`
|
||||
environment variable directly in the make command line or in your shell
|
||||
nitialization
|
||||
|
||||
### <a name="cc26xx_cc13xx_uniflash"> Using Uniflash </a> [[TOC]](#cc26xx_cc13xx_toc)
|
||||
|
||||
The TI's Code Composer Studio provides the necessary tools to use the debug
|
||||
features of the XDS110; Uniflash provides flashing tools. Both programs can
|
||||
be found here:
|
||||
|
||||
- [Code Composer Studio (CCS) Integrated Development Environment (IDE)](http://www.ti.com/tool/CCSTUDIO).
|
||||
- [Uniflash Standalone Flash Tool for TI Microcontrollers (MCU), Sitara Processors & SimpleLink devices](http://www.ti.com/tool/UNIFLASH).
|
||||
|
||||
Before using the XDS110 with the latest CCS/Uniflash versions the firmware for
|
||||
it needs to be updated. Texas Instruments has a guide to correctly update it
|
||||
[here](http://software-dl.ti.com/ccs/esd/documents/xdsdebugprobes/emu_xds110.html#updating-the-xds110-firmware).
|
||||
|
||||
#### Setting up the environment
|
||||
|
||||
In order to make use of the programming and debugging capabilities of the XDS110
|
||||
some environment variable needs to be set:
|
||||
|
||||
```
|
||||
export CCS_PATH=<path to ti install folder>/ti/ccs930
|
||||
export UNIFLASH_PATH<path to ti install folder>/ti/uniflash_5.2.0
|
||||
```
|
||||
|
||||
That assumes you have CCS 9.3.0 (for the path name) and Uniflash 5.2.0, adjust
|
||||
accordingly.
|
||||
|
||||
After that you can flash using the RIOT `make flash` command on your application
|
||||
or to debug you first start the debug server:
|
||||
|
||||
```
|
||||
make debug-server
|
||||
```
|
||||
|
||||
And then on another terminal you can run:
|
||||
|
||||
```
|
||||
make debug
|
||||
```
|
||||
|
||||
It will open GDB and connect to the debug server automatically.
|
||||
|
||||
@note By default LaunchPad boards on RIOT use uniflash as the default
|
||||
programmer, if it's not the case for an external board, you can always use
|
||||
uniflash by setting this environment variable `PROGRAMMER=uniflash` to change
|
||||
the default programmer.
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup cpu_cc26xx_cc13xx_definitions CC26xx_CC13xx common
|
||||
* @defgroup cpu_cc26xx_cc13xx_definitions CC26xx/CC13xx common
|
||||
* @ingroup cpu
|
||||
* @brief Common definitions for TI cc26xx/cc13xx family
|
||||
*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user