TI-RTOS 1.10.00.23 Release Notes

This release note is divided into the following sections:

Introduction, Documentation, Products Included, What's New, Upgrade & Compatibility Information, Host Support, Dependencies, Device Support, Validation Info, Known Issues, Examples, Version Information, Technical Support.

Introduction

This is the General Availability (GA) release of TI-RTOS (previously called MCU SDK). This version ot TI-RTOS requires CCS 5.4.

The TI-RTOS delivers components that enable engineers to develop applications on Texas Instruments micro-controller devices. The product is comprised of multiple software components and examples of how to use these components together.

The TI-RTOS gives developers a one-stop RTOS solution for developing applications for TI embedded microcontrollers. It provides an OS kernel, communications support, drivers, and more. It is tightly integrated with TI’s Code Composer Studio development environment. In addition, examples are provided to demonstrate the use of each functional area and each supported device and as a starting point for your own projects.

Documentation

The following documentation is available:

Release notes from previous releases are also available in the release notes archive directory.

Products Included

The following is a list of all the products bundled into the TI-RTOS installation. Note these products only support ARM and C2xxx devices (this was done to reduce installer and installation size).

SYS/BIOS 6.35.01.29
IPC 1.25.03.15
UIA 1.03.00.02
NDK 2.22.03.20
MWare v200a (refer to <TIRTOS_Install_dir>\products\MWare_v200a\TI-RTOS.README for more details)
TivaWare_C_Series-1.0
XDCtools 3.25.00.48*
Drivers and examples for TMDXDOCKH52C1, TMDXDOCK28M36, EKS-LM4F232, and EK_TM4C123GXL (previously called EK_LM4F120XL).

* XDCtools is installed at the same level at TI-RTOS. If the 3.25.00.48 version is already present at that location, that version is used.

What's New

1.10.00.23

Moved from StellarisWare to TivaWare
New versions of SYS/BIOS, IPC, UIA, NDK MWare and XDCtools
SPI driver and examples were added
SPIMessageQTransport to allow MessageQ of SPI between discrete processors
WiFi driver and examples (requires CC3000 adapter board)
Requires CCS 5.4
Support for LM3 devices has been discontinued. If required a patch release off the 1.01 release can be made.

Defects Fixed since 1.01.00.25

ID	Headline
SDOCM00101095	I2C Driver bitRate needed for the I2C_Params_init()
SDOCM00100493	USBMSCHFatFs driver doesn't notify the FatFs module correctly of removed media
SDOCM00100492	USBMSCHFatFs doesn't remove its Hwi on a _close() call
SDOCM00098845	deprecate SysFlex and use SysCallback instead
SDOCM00098844	add subcomponent cdoc to the master TI-RTOS cdoc, release notes docs should point to subcomponent docs
SDOCM00098821	Add Watchdog_open parameter to specify whether to or not to stall the timer when a breakpoint is hit
SDOCM00097460	No ROV view for USBMSCHFatFs
SDOCM00095218	Available products should show BIOS, NDK and UIA
SDOCM00094100	Concerto demo fails when using chrome to enable SD card

Upgrade and Compatibility Information

When migrating an application that uses TI-RTOS 1.01.00.25 to TI-RTOS 1.10.00.23, the following steps must be taken:

New MWare: This version of TI-RTOS has a new version of MWare The following changes must be made to existing TI-RTOS applications that are based on MWare

Libraries: The MWare libraries (e.g. "${COM_TI_RTSC_MCUSDK_INSTALL_DIR}/products/MWare_v140x/MWare/driverlib/ccs/Debug/driverlib.lib") must be changed to reflect the new version (e.g. "${COM_TI_RTSC_TIRTOS_INSTALL_DIR}/products/MWare_v200a/MWare/driverlib/ccs/Debug/driverlib.lib")
Include Paths: The MWare include paths (e.g. "${COM_TI_RTSC_MCUSDK_INSTALL_DIR}/products/MWare_v140x/MWare") must be changed to reflect the new version (e.g. "${COM_TI_RTSC_TIRTOS_INSTALL_DIR}/products/MWare_v200a/MWare").

TivaWare: This version of TI-RTOS has TivaWare instead of StellarisWare. The following changes must be made to existing TI-RTOS applications that used StellarisWare

Libraries: The StellarisWare libraries (e.g. "${COM_TI_RTSC_TIRTOS_INSTALL_DIR}/products/StellarisWare_9885a/driverlib/ccs-cm4f/Debug/driverlib-cm4f.lib") must be changed to point to the TivaWare libraries (e.g. "${COM_TI_RTSC_TIRTOS_INSTALL_DIR}/products/TivaWare_C_Series-1.0/driverlib/ccs/Debug/driverlib.lib")
Include Paths: The StellarisWare include paths (e.g. "${COM_TI_RTSC_TIRTOS_INSTALL_DIR}/products/StellarisWare_9885a") must be changed to point to the TivaWare path (e.g. "${COM_TI_RTSC_TIRTOS_INSTALL_DIR}/products/TivaWare_C_Series-1.0").
Defines: In Project Properties->Arm Compiler->Advanced Options->Prefined Symbols, the following must be changed

PART_LM4F120H5QR->PART_TM4C123GH6PM
PART_LM4F232H5QD->PART_TM4C123GH6PGE
Additionally "TIVAWARE" must be defined for the TM4C boards.

USB reference modules: Please refer to the new USB examples for any differences.
ti.platform names: In Project Properties->General->RTSC

ti.platforms.stellaris:LM4F120H5QR -> ti.platforms.stellaris:TM4C123GH6PM
ti.platforms.stellaris:LM4F232H5QD-> ti.platforms.stellaris:TM4C123GH6PGE

<Driver>_config: To allow different types of a peripheral, each driver's config structure changed (e.g. UART_Config). The structure now has a function table, device specific objects and device specific hwAttrs. Please refer to the "Board.c" files (e.g. TMDXDOCKH52C1.c) to see an example.
Board.c file layout: The Board.c files (e.g. TMDXDOCKH52C1.c) layout has changed. It now uses defines to determine which peripherals are being used. For example, if UART is used in the configuration file, a TI_DRIVERS_UART_INCLUDED constant is defined. There is a #if TI_DRIVERS_UART_INCLUDED around the UART code in the board.c file.
I2C bitrate: This was initialized in the "Board.c" files (e.g. TMDXDOCKH52C1.c), but now is a field in the I2C_Params structure. Existing code must be re-compiled against the updated I2C.h header.
Watchdog_open API change: The reloadValue value was removed from the Watchdog_open() API. It is now part of the hwAttrs structure in Watchdog_config.
NIMUDeviceTable: The NIMUDeviceTable was in the EMAC library. It is now in the "Board.c" files (e.g. TMDXDOCKH52C1.c).
CCS 5.4: CCS 5.4 is required.
XDCtools location: The XDCtools product is no longer under the <TIRTOS_Install_dir>\products directory. If the exact version of XDCtools is not installed, the installer will install it in the same directory as TI-RTOS.
LM3 devices are no longer supported: Also, StellarisWare is no longer included in the installed product.
SysFlex deprecation: While still included in the product, the SysFlex module is being deprecated. Please use xdc.runtime.SysCallback instead.

Host Support

Supported Operating Systems
- Windows 7, Windows XP, Windows Vista
- Linux [RH4], Ubuntu [10.04]

Dependencies

This release requires the following other software components and tools versions to successfully function:

CCSv5.4 or higher

Device Support

TMDXDOCKH52C1
TMDXDOCK28M36
EKS-LM4F232
EK_TM4C123GXL

Validation Information

This release was validated using the following components:

CCSv5.4

Known Issues

There are several know issues with this release.

ID	Headline
SDOCM00101254	TI-RTOS release notes should have pointers to sub-component docs (or release notes which point to docs)
SDOCM00101243	Document that SysFlex is deprecated (use xdc.runtime.SysCallback instead)
SDOCM00101240	Coverity for WiFi driver reports several defects in the CC3000 Host Driver
SDOCM00101229	HTTP demo doesn't show the current SD Card logging state
SDOCM00101185	Coverity gives an error about stdbool.h for Tiva devices
SDOCM00101176	SPIMessageQTransport does not support static creates
SDOCM00101156	LM4F Application occasionally doesn't run to main() after it has been loaded via CCS
SDOCM00101155	Intermittent spin lock in USB library's USBHCDPipeRead() for LM4F232
SDOCM00100865	TI-RTOS drivers should have top-level enable and disable APIs
SDOCM00100864	Use multithreaded CC3000 Host Driver with WiFi driver when available
SDOCM00100711	select() should be removed from WiFi example when CC3000 is patched
SDOCM00100494	SPI driver was not tested in Slave Open Drain mode
SDOCM00099858	Stellaris launchpad doesn't detect a USB disconnect event
SDOCM00099460	ping flood causes Concerto board to stop receiving interrupts
SDOCM00099017	TI-RTOS needs to make sub-products examples accessible
SDOCM00098844	add subcomponent cdoc to the master TI-RTOS cdoc, release notes docs should point to subcomponent docs
SDOCM00097626	Giving Priorities to Hwis from TI-RTOS Drivers
SDOCM00094054	tcpEcho does not handle more than two connections well
SDOCM00094053	TI-RTOS sub-products (e.g. UIA, IPC) are not linked into CCS Help
SDOCM00093967	TI-RTOS Windows install will fail if installed in multiple or single directory that contains more than 38 characters in path
SDOCM00093268	Add parity and error checking for UART driver
SDOCM00088081	SD Card driver lacks CRC support

Examples

There are for TMDXDOCKH52C1, TMDXDOCK28M36, EKS-LM4F232, and EK_TM4C123GXL. Please refer to the Getting Started Guide for more details.

Version Information

All releases have 4 digits (M.mm.pp.bb). This includes GA and pre-releases (engineering, EA, beta, etc.). Pre-releases are denoted with a suffix (e.g. 1.01.00.15_eng or 1.01.00.21-beta).

This product's version follows a version format, M.mm.pp.bb, where M is a single digit Major number, mm is 2 digit minor number, pp is a 2 digit patch number, and b is an unrestricted set of digits used as an incrementing build counter.

To support multiple side-by-side installations of the product, the product version is encoded in the top level directory, ex. tirtos_1_00_01_11.

Subsequent releases of patch upgrades will be identified by the patch number, ex. TI-RTOS 1.00.00.68 with directory tirtos_1_00_01_70. Typically, these patches only include critical bug fixes.

Please note that version numbers and compatibility keys are NOT the same. For an explanation of compatibility keys, please refer to the 'Upgrade and Compatibility Information' section.

Technical Support

For technical support, please refer to the Texas Instrument’s E2E BIOS Support Forum http://e2e.ti.com/support/embedded/bios/default.aspx or other forums in http://e2e.ti.com/ as needed.

Last updated: May 10, 2013