 |
xWRL684x MMWAVE-L-SDK
06.00.04
|
|
|
xWRL684x MMWAVE-L-SDK
06.00.04
|
|
Welcome to MMWAVE-L-SDK for xWRL684x. This SDK contains examples, libraries and tools to develop RTOS and no-RTOS based applications for ARM R5F CPUs and related peripherals.
This SDK also contains examples to interface these ARM R5F applications .
Given below is a block diagram of the SW modules in this SDK,
The main software components in the block diagram are described below
| Software Components | Documentation Page | Description |
|---|---|---|
| OS Kernel | ||
| No RTOS | NO RTOS | Contains modules which implement no-RTOS execution environment consisting of timers, ISR, main thread. Allows software on top to run in bare metal mode. |
| FreeRTOS Kernel | FreeRTOS | FreeRTOS Kernel, provides a execution environment consisting of tasks, semaphores, timers, see https://www.freertos.org/RTOS.html |
| FreeRTOS POSIX | FreeRTOS | Limited POSIX APIs with FreeRTOS underneath, provides pthreads, mqueue, semaphore, see https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/index.html |
| Driver Porting Layer (DPL) | Driver Porting Layer (DPL) | APIs used by drivers to abstract the OS environment. Example, Semaphore, HW interrupts, mutex, clock. |
| Device Drivers and HAL (Hardware Abstraction Layer) | ||
| SOC Peripheral Drivers | SOC Drivers | Device Drivers library and APIs for peripherals within the SOC. Example, I2C, GPIO, UART. |
| Board Peripheral Drivers | Board Peripheral Drivers | Device Drivers library and APIs for peripherals on the board or EVM. Example, Flash, EEPROM. |
| Datapath Modules | ||
| Datapath Modules | Datapath Modules | Datapath modules consisting of DPUs and related utilities. |
| Examples | ||
| Examples | Examples | Examples showing usage of different SW libraries and APIs |
| Tools (used on host machine) | ||
| Code Composer Studio (CCS) | Using SDK with CCS Projects | IDE used to build projects, debug programs, see |
| TI CLANG Compiler Toolchain | TI CLANG HOMEPAGE | CLANG based ARM compiler from TI for ARM R5F |
| SysConfig | Using SDK with SysConfig | System configuration tool, used to configure peripherals, pinmux, clocks and generate system initialization code |
| TI Resource Explorer (TIREX) (TBD) | Using SDK with TI Resource Explorer | Web broswer based tool to explore the SDK, select, import and run the examples |
| SDK Tools and Utilities | Tools and Utilities | Additional tools and utilities, like flashing tools, booting tools, CCS loading scripts used with the SDK development flow |
Given below is a overview of the directory structure to help you navigate the SDK and related tools.
| Folder/Files | Description |
|---|---|
| ${SDK_INSTALL_PATH}/ | |
| README_FIRST_xWRL684x.html | Open this file in a web browser to reach this user guide |
| makefile | Top level makefile to build the whole SDK using "make" |
| imports.mak | Top level makefile to list paths to dependant tools |
| docs/ | Offline browseable HTML documentation |
| examples/ | Example applications for xWRL684x, across multiple boards, CPUs, NO-RTOS, RTOS |
| firmware/ | Contains firmware code for xWRL684x front end |
| source/ | Device drivers, middleware libraries and APIs |
| tools/ | Tools and utilities like CCS loading scripts, initialization scripts. |
| ${SDK_INSTALL_PATH}/source/ | |
| control/ | Control path library for configuring radar front end |
| drivers/ | SOC peripheral device drivers |
| kernel/ | NO RTOS and RTOS kernel and Driver Porting layer (DPL) for these environments |
| board/ | Board peripheral device drivers |
| ${SDK_INSTALL_PATH}/examples/ | |
| control/ | Control path examples |
| datapath/ | Data Processing Units (DPU) examples |
| drivers/ | SOC and board level focused device drivers examples. The examples are based on both NO-RTOS and RTOS |
| kernel/ | NO RTOS and RTOS kernel focused examples |
| ${SDK_INSTALL_PATH}/tools/ | |
| visualizer/visualizer.exe | Tool to configure mmWave sensors and Visualize point cloud objects generated by the mmWave SDK |
| Flashing Tool | Tool to flash examples of the mmWave SDK |
| syscfg_deviceData/ | The device data information used by Sysconfig for pinmuxing |
| gelfile/ | This folder have xwrL684x.gel file. It is used in debugging. |
| MetaImageGen/ | Metaimage generation tool |
| CCS_SupportFiles/ | CCS support file xWRL68xx.xml for Target configuration |
Given below are the paths where the different tools needed outside the SDK, like CCS, SysConfig are installed by default in Windows. In Linux, the tools are installed by default in ${HOME}/ti.
| Folder/Files | Description |
|---|---|
| C:/ti/ccs2010 | Code composer studio |
| C:/ti/sysconfig_1.23.0_4000 | SysConfig. |
| C:/ti/ti-cgt-armllvm_4.0.2.LTS | TI ARM CLANG compiler tool chain |
The licensing information of this SDK, as well as any third-party components included which are made available under a number of other open-source licenses are enumerated as part of the manifest. A complete manifest along with export control information is detailed here [LINK]
For additional help and support, see https://e2e.ti.com/support/sensors-group/sensors/f/sensors-forum
This user guide is generated using doxygen, v1.8.20. See https://www.doxygen.nl/index.html
1.8.20