Quick Start Guide for SimpleLink™ CC32xx SDK
Table of Contents
1. Introduction
This guide is intended to assist users in the initial setup and demonstration of running their first sample application. The guide explains how to install the SimpleLinkTM CC32xxTM SDK and lists the various other tools required to get started with the first application
2. Prerequisites
The user is expected to have the following:
- SimpleLink CC32xx LaunchPad
- A computer running Microsoft® Windows® 7,Linux or macOS.
- At least one of the following IDE supported by the SimpleLink CC32xx SDK:
- GNU ARM Embedded Toolchain, 7-2017-q4
- FreeRTOSv10.0.0 (Optional)
- The SimpleLink CC32xx SDK does not deliver FreeRTOS sources.
If the User wants to use FreeRTOS with the SDK, the user is expected to download the FreeRTOS sources from previous release link in www.freertos.org
- The SimpleLink CC32xx SDK does not deliver FreeRTOS sources.
- TI Uniflash
3 SDK - Download and Installation
3.1 Using the SDK Online
A quick and easy way to start working with the SDK is to use TI Resource Explorer on dev.ti.com.
This online tool lets you explore the contents of the SimpleLink CC32xx SDK. You can build the examples directly using the cloud version of Code Composer Studio.
If you choose to use the SDK online, there is no need to download anything to your local computer or install any tools.
3.2 Installing the SDK
You can also download the SimpleLink CC32xx SDK from TI Resource Explorer or the software product page on TI’s website.
4. Updating service-pack / system files in the CC32xx
It is recommended to update the service-pack to the latest service-pack available.
The service-pack file name is sp_
CC3220 Service pack - <SDK_INSTALL_DIR>/tools/cc32xx_tools/servicepack-cc3x20
CC3235 Service pack - <SDK_INSTALL_DIR>/tools/cc32xx_tools/servicepack-cc3x35
4.1 Uniflash Download
Download TI Uniflash and install it.
4.2 User guide for Uniflash ImageCreator and Programming Tool
Uniflash Image Creator user guide: Uniflash Image Creator
5. QuickStart for CCS IDE ( CCS or GCC Projects )
5.1 Download and Installation
During the installation, the following options are recommended
We recommend that you use the default installation folder
Make sure that SimpleLink Wi-Fi CC32xx Wireless MCUs is selected. You can select additional processor support options as needed.
To use a debug probe, select TI XDS Debug Probe Support and any other options you would like.
5.1.1 Installing the SimpleLink CC32xx SDK
- Install the SDK in the default location pointed to by the installer -
C:\ti
- CCS Re-start will be needed. CCS will automatically detect the latest install.
5.1.2 Add CCS Support for FreeRTOSv10.0.0
- Download FreeRTOS official version 10.0.0. Download Link in Prerequisites chapter
- Install the software under c:
- Run CCS
- Choose Window > Preferences > Code Composer Studio > Build > Variables > Add
- Fill the Variable name field with FREERTOS_INSTALL_DIR
- Change the type to directory
- Change the Value to the
<FREERTOS_INSTALL_PATH>
and then press OK
5.1.3 Products Settings Verification
Choose Window > Preferences > Code Composer Studio > products
- Check that the paths in Product Discovery Path include the paths of:
- SDK Install path
- XDCtools
- If not, choose Add, add the paths and then choose Rediscover, after the rediscover a Install Discovered Products windows may appear.
if the window appear it means that new products have been discovered, if the XDCTools product mentioned in Dependencies, choose them and choose install.
5.2 Execute your First Application
This section will show how to import/build/load an example
5.2.1 TI Resource Explorer
A quick and easy way to start working with the SDK is to use the TI Resource Explorer on dev.ti.com/tirex.
5.2.2 Import via CCS IDE
- Open CCS
- Choose Project → Import CCS Projects from the menu.
Select the Browse button in the Import CCS Projects dialog and select the the directory
<SDK_INSTALL_DIR>/examples
The SDK provides NoRTOS, TI-RTOS and FreeRTOS based examples. TI-RTOS and FreeRTOS examples have the word “tirtos” or “freertos” in the project name
CCS picks both CCS and GCC based examples.
Importing TI-RTOS and FreeRTOS examples will bring in (import) kernel projects too in the same workspace. The kernel project is a dependent project and will be automatically built when the example is built.
Importing a NoRTOS examples will bring in (import) only the example project to the workspace, this project will be linked to a pre-compiled nortos kernel library.
For more details and how change configurations look at the<SDK_INSTALL_DIR>/docs/simplelink_mcu_sdk/Users_Guide.html
document.Select any Code Example you would like to use. In this example, select network_terminal_CC3220SF_LAUNCHXL_freertos_ccs and choose finish.
Build and Download.
Plug in your launchpad, Click the Debug icon in CCS. The RTOS build for the first time takes a couple of minutes.
The XDS110 may require a firmware update. If a firmware update is requested click ok.
Note: the Emulation package may be defer.
5.3 Application User guide
Every example has a README.html that details the Example Application Design Details and how each example works
Other example application design details and how each example works can be found in content and documentation.
5.4 Create a new SDK based User Application
Do not use the New Project Creation Wizard
Start with one of the example projects as shown in Execute your First Application paragraph. Each software component and each variant of the CC32xx in the SDK comes with its own set of examples.
6. QuickStart for IAR IDE
6.1 Download and Installation
Download and install IAR Embedded Workbench for ARM. You can get IAR for ARM here:
Make sure to select TI XDS as one of the debug probe drivers. You may also select other drivers. The driver will be installed towards the end of the installation of IAR.
6.1.1 Configuring the environmental variables
Before starting to work with any of the projects in the SDK, you need to load a set of environment variables that will be set to your current workspace (Custom argvars)
The custom argvars can be found at
<SDK_INSTALL_PATH>/tools/iar/SIMPLELINK_cc32xx_SDK.custom_argvars
, if you need to modify the default path argument variables, edit the variables with the correct pathsChoose Tools -> Configure Custom Argument Variables
Click Global->Import
Browse to
<SDK_INSTALL_PATH>/tools/iar
, import the custom argvars from the SDK.
Restart IAR.
6.1.2 Download and install XDS Emulation Software Package
Download the latest XDS software Emulation package from here: Make sure IAR\CCS are closed during installation process.
6.2 Execute your First Application
This section will show how to import/build/load an example
6.2.1 Build your Kernel first, you can use a TI-RTOS, FreeRTOS or NoRTOS based example.
For this release of the SDK, the RTOS (FreeRTOS/TIRTOS) configurations are not pre-built. You will need to build the desired configurations.
Update your installation Paths
- Edit the imports.mak file and adjust the locations of XDCtools installation, FreeRTOS and compiler tools paths.
XDCTools installation is included in the CC32xx SDK.
The imports.mak is provided in the top-level directory of the SDK installation.
Build your Kernel Configuration
- In order to build the kernel, You can follow Build Kernel configuration paragraph which uses make files or continue with this paragraph which explains how to compile the Kernel project using IAR IDE.
Build your Core libs
- In order to build the Host Driver, MQTT and OTA libs, follow Build Core libs paragraph.
6.2.2 Importing your first project
This section will show how to import, build and load an example
6.2.2.1 Directly accessing workspace from example folder
All Code Examples that are shipped with the SDK come with an IAR workspace. Those examples are divided into three folders sysconfig_preview, rtos and nortos.
In order to work with sysconfig_preview examples, You can follow SysConfig Standalone User Guide.
In order to work with rtos and nortos examples Double-Click on the specific workspace allows you to open the project on disk and build it.
In order to Working with sysconfig
6.2.2.3 Browse the example list
In the IAR-IDE go to the
Help
tab and click onInformation Center
In the
IAR Information Center for ARM
window, click onIntegrated Solutions
Scroll down and choose Texas Instruments - Example projects
Click on the example applications link.
All the example projects in the SDK that available in IAR are listed in the html page.
Scroll through the page and click on the project you are interested in. In this example we choose to work with network_termianl for the CC3220S based on FreeRTOS.
- When prompted, click
Yes
to save a copy of the project workspace in a specific folder,No
will save the workspace in a default folder. After clicking
Yes
, browse to the location where you want to save this workspace. ClickChoose
When importing any example, the related kernel project will be imported automatically
- In order to create a binary image in addition to an .out file follow the next steps:
right click on the
project name --> options
On the output converter tab (Highlight in blue), mark the checkbox (in yellow), and change the output format to binary.
Now, hit OK, and later compile. The binary image should reside in:
<your_IAR_workspace>\<IAR_Project location>\Debug\Exe
.
In order to compile the example and the kernel projects, Choose Project > Make
Make/Build the Example Project Make [(Project->Make
) Shortcut F7
]. For RTOS based Projects - Note that the RTOS(kernel) build is a dependent project which is automatically pre-built before the example project builds.
For noRTOS Projects - There is not RTOS(kernel) build dependent project imported into the workspace
6.2.3 Run a debug session
- Select Project -> options from the menu, and select the Debugger category.
By default, the project Debug settings is configured for TI XDS110, but the user may change them as needed
In case you are working with the CC32xxSF device, check the Use flash loader(s) checkbox in the Debugger -> Download tab.
- Go to the TI XDS Category, the settings should be TI XDS110 Emulator as the emulator, and JTAG (4-pin) as the interface
You can override the path for code composer studio base according to the code composer installation path.
6.3 Application User guide
- Please refer Networking demo applications section in the following link for more details about each application - content and documentation.
7. Quick Start for Makefile Users
The kernel projects, core libs and SDK examples ship makefiles in addition to IDE specific projects.
7.1 Update imports.mak
- Update the top level
<SDK_INSTALL_DIR>/imports.mak
to point to actual install locations on the user’s machine
7.2 Build Kernel configuration
Building the Kernel can be done in different options according to the requirements.
The User’s Guide provides details about the various RTOS configuration options. Here is a quick summary in this section
Open a command prompt. Any Kernel configuration can be built by navigating to the desired directory and running gmake command which is a part of the XDC tools package.
To build all the NoRTOS, TIRTOS and FreeRTOS config projects
cd <SDK_INSTALL_PATH>\kernel
<XDCTOOLS_INSTALL_PATH>\gmake.exe
To build only TIRTOS config project
cd <SDK_INSTALL_PATH>\kernel
Debug:
<XDCTOOLS_INSTALL_PATH>\gmake.exe tirtos-debug
Release:
<XDCTOOLS_INSTALL_PATH>\gmake.exe tirtos-release
To build only FreeRTOS config project
cd <SDK_INSTALL_PATH>\kernel
Release:
<XDCTOOLS_INSTALL_PATH>\gmake.exe freertos-release
To build only NoRTOS config project
cd <SDK_INSTALL_PATH>\kernel
Release:
<XDCTOOLS_INSTALL_PATH>\gmake.exe nortos-release
To build only specific config project
cd <SDK_INSTALL_PATH>\kernel\<OS>\builds\<Board variant>\<release or debug>\<Compiler>
Example:cd C:\ti\simplelink_cc32xx_sdk_1_02_00_01_eng\kernel\freertos\builds\CC3220SF_LAUNCHXL\release\gcc
<XDCTOOLS_INSTALL_PATH>\gmake.exe
This link can be use in order to Return to Execute your First Application paragraph.
7.3 Build Core libs
The SDK include Host Driver, MQTT or OTA libs that can be compiled after changes.
To build Host Driver lib
cd <SDK_INSTALL_PATH>\source\ti\drivers\net\wifi
Release:
<XDCTOOLS_INSTALL_PATH>\gmake.exe
To build MQTT lib
cd <SDK_INSTALL_PATH>\source\ti\net\mqtt
Release:
<XDCTOOLS_INSTALL_PATH>\gmake.exe
To build OTA lib
cd <SDK_INSTALL_PATH>\source\ti\net\ota
Release:
<XDCTOOLS_INSTALL_PATH>\gmake.exe
This link can be use in order to Return to Execute your First Application paragraph.
7.4 Build the project
- Identify the makefile for the project and build it.
For Example<SDK_INSTALL_DIR>/examples/rtos/CC3220SF_LAUNCHXL/demos/network_terminal/freertos/gcc
8. Quick Start for Linux Users
When using Linux machine the installation steps for the SDK and IDE’s are the same as in windows.
Quick Start for CCS IDE can be found in QuickStart for CCS IDE paragraph.
Quick Start for Makefile Users can be found in Quick Start for Makefile Users paragraph.
Note: When using Makefile in Linux machine, instead of using the gmake command, just use make.
For Example:
9. Application User guide
- Please refer Networking demo applications section in the following link for more details about each application - content and documentation.