MSP430 USB Developers Package 5.20.06.03

Table of Contents

Introduction

This is version 5.20.06.03 of the MSP430 USB Developers Package.

The MSP430 USB Developers Package provides APIs that make it easy to implement a simple USB data connection between a MSP430 and an USB host. It includes support for these common USB device classes:

• Communications Device Class (CDC)
• Human Interface Device class (HID)
• Mass Storage Class (MSC)
• Personal Healthcare Device Class (PHDC)

Users must read the “Updating and Compatibility Information” below, and follow the instructions to port their application to this new release.

Package Contents

• MSP430_USB_API. (The MSP430 USB API and Application Examples):
  • Contains the MSP430 USB CDC/HID/MSC API. You can use this as the foundation of your MSP430 USB development.
  • Contains a version of driverlib that was used for development and testing
  • Contains examples for the various interfaces incuding an emptyExampleProject which can be used to start a new application.
• Documentation
  • Programmers_Guide_MSP430_USB_API. (The MSP430 USB API Programmer’s Guide). The complete reference for developing USB applications on MSP430, using the API stacks and Descriptor Tool. See it for information about:
    • Practical guidance on writing USB applications
    • How to use the Descriptor Tool
    • Links to other MSP430 USB information
  • Examples_Guide_MSP430_USB
    • Detailed information on how to run the examples
    • Implementation details for the examples
  • Release Notes. Contains information on new features, bugs fixed, compatibility, benchmarks and installation instrcutions.
• MSP430 USB DescriptorTool
  • Java based tool which can be used to easily generate USB descriptors specific to an application.
• Java based HID Demo application.
  • The demo app (“HID Demo App”) is similar to a terminal application (i.e., Hyperterminal), except it uses HID instead of CDC. Designed to interact with an MSP430 application implementing a HID-Datapipe interface.
  • Release Notes for the HID demo application
• Python Firmware Upgrader
  • Firmware upgrader application in the form of a python GUI
  • Release Notes for the firmware upgrader.

Documentation

• Programmers Guide MSP430 USB API
• Examples Guide MSP430 USB

Other Documentation

• API Function Reference
• Software Manifest

What’s New in 5.20.06.03

• USB stack code and examples
  • Function HidToBufferFromHost() updated to get Y buffer byte count from pEP2 instead of pEP1.
  • Implementation of auto detection of XT2 crystal frequencies for 4MHz, 8MHz, 12MHz, 16MHz and 24MHz.
  • Integration of TI’s AES128 Encryption and Decryption APIs in examples, H10_ReceiveData_EncryptDecrypt and H11_LedOnOff_EncryptDecrypt, added
• Descriptor Tool
  • Removed setting for selection of XT2 crystal frequency.
  • Custom interfaces are stored in the order they are created in xml file.
• Java HidDemo tool and Python Firmware Upgrader tools
  • Python Firmware Upgrader tool updated to download RAM_BSL.00.08.08.39.txt file
  • A new version of Java HidDemo tool created that integrates TI’s AES128 Encryption and Decryption APIs.
• USB_API changes
  • USB_init() has a routine to auto detect the XT2 frequency. This routine uses Timer A to compare the frequency of SMCLK=XT2 and ACLK=REFO. The timer A will only be used during the initialization of the USB stack. Therefore, it is recommended to initialize the USB stack before initializing the Timer A in an application. If this is not possible, or to disable the XT2 frequency auto detect feature, please see the Programmers_Guide_MSP430_USB_API.pdf for more information.

Revision History

MSP430 USB Developers Package 5_10_00_17 Release

• USB stack code and examples
  • USB stack code updated with bug fixes
  • CHM2_tasks and CHM3_SWIs IAR examples removed from examples directory. Please refer to TI-RTOS examples for USB working with TI-RTOS/SYSBIOS
  • USB examples verified on Windows 10
• Descriptor Tool
  • The maximum current drain drop down menu includes current from 0 to 500ma.
• Java HidDemo tool and Python Firmware Upgrader tools
  • No changes
• USB_API changes
  • usbSetIdle() function updated to reply to a SET_IDLE command with a zero packet length response
  • ifdef condition added as appropriate for include files in usb.c file based on device type
  • typedef instruction wrapped with cplusplus wrapper in usb.c file
  • Scsi_Cmd_Parser() function in UsbMscScsi.c file updated to support ‘Eject’ functionality

MSP430 USB Developers Package 5_00_01 Release

• USB Stack Code and Examples:
  • No changes
• MSP430 USB Firmware Upgrade Example tool:
  • Compiled for release version
• Descriptor Tool, Java HidDemo tool and Python Firmware Upgrader tools:
  • Works on Windows, Linux and MAC
• USB_API changes
  • No changes

Defects Fixed in 5_00_01:

MSP430 USB Developers Package 5_00_00 Release

• USB Stack Code and Examples:
  • Updated to conform to MCU coding standard
    
  • Macro definition DEPRECATED included in compiler option of all examples to remove deprecated functions and definitions from header files.
  • Old API function names and definitions mapped to new names.
  • Macro definition DRIVERLIB_LEGACY_MODE option removed.
• New look and feel to the Descriptor Tool.
  • Tool no longer uses RCP application.
  • New instructions on how to use the Descriptor Tool
  • Regenerated descriptor.c, descriptors.h and UsbIsr.c files
• USB_API changes
  • Function names and defination names changed to conform to MCU coding standard

Defects Fixed in 5_00_00:

MSP430 USB Developers Package 4_20_00 Release

• USB Stack Code and Examples:
  • Updated to include various bug fixes.
    
  • Remote Wakeup example included
  • MSP430FG6626 support included
• Java HIDDemo tool
  • Supports 32 bit and 64 bit Linux
  • See the Host_USB_Sofware folder for details.
• TI signed INF Files for CDC interfaces
  • Each CDC example contains a TI signed INF file along with a catalog file
  • INF file and catalog files are imported into CCS and IAR
  • Installation of the INF file can be done with the right-click method.
• Minor updates to Descriptor Tool.
• USB_API changes
  • Support for placing XT2 in bypass mode included
  • USB_determineFreq() updated to include more accurate determination of frequency
  • Support for MSP430FG6626 included.

Defects Fixed in 4_20_00:

MSP430 USB Developers Package 4_10_02 Release

• USB Stack Code and Examples:
  • Updated to provide backward compatibility with dirverlib through compiler define DRIVERLIB_LEGACY_MODE.
    
• Python based firmware upgrader tool updated with RAM_BSL.00.07.88.38.txt file.
  • Supports Windows and Linux
  • Developed using open source python-msp430-tools
  • See the Host_USB_Sofware folder for details.
• Better CCS integration
  • TI-REX integration. The examples and tools can be found under MSP430Ware in TI-REX.
  • Examples now use CCS project spec files instead of entire CCS projects. This makes import and build easier. NOTE: See information os project spec limitation on CCS v5.3 and CCSv5.4
• Minor updates to Descriptor Tool.
• MSP430 USB Firmware Upgrade Example
  • Updated with RAM_BSL.00.07.88.38.txt file
• USB_API changes
  • Removed structure definitions in deprecated types.h file.
  • Included DRIVERLIB_LEGACY_MODE option and function calls that use driverlib legacy mode code files.

Defects Fixed in 4_10_02:

MSP430 USB Developers Package 4_10_00 Release

• GCC Examples. USB stack now supports GCC
  • New HID, CDC and MSC examples using CCS RedHat GCC compiler
  • New HID, CDC and MSC examples using command line RedHat GCC compiler and gdb
  • Examples structured into CCS, CCS_GCC and GCC folders.
• USB stack code, Examples and Descriptor Tool ouput files support C99 types
  • All code converted to C99 types. The types.h file is included in the release for backward compatibiliity reasons only. This file has been deprecated with release v4.10
• Python based firmware upgrader tool updated to execute a BOR reset
  • Supports Windows and Linux
  • Developed using open source python-msp430-tools
  • See the Host_USB_Sofware folder for details.
• Updated Documentation
  • Examples Guide updated to include GCC examples
• Better CCS integration
  • TI-REX integration. The examples and tools can be found under MSP430Ware in TI-REX.
  • Examples now use CCS project spec files instead of entire CCS projects. This makes import and build easier. NOTE: See information os project spec limitation on CCS v5.3 and CCSv5.4
• Minor updates to Descriptor Tool.
• USB_API changes
  • If XT2 crystal is not selected to be disabled during USB suspend, then XT2 will be left running to enable fast intterupt latency.
    
  • Enumeration of the device when 3.3V LDO is turned OFF works on the MSP430F5529 launch pad
  • Interrupt latency functions now work during VBUS on events.
  • USB stack converted to use C99 types. Types.h file left in place for backward compatibility.
  • USB stack includes pre-processor GCC definitions.
  • Conditional statement added in USB_init() to prevent programs from hanging under certain conditions.

Defects Fixed in 4_10_00:

MSP430 USB Developers Package 4_00_02 Release

• New Python based firmware upgrader
  • Supports Windows and Linux
  • Developed using open source python-msp430-tools
  • See the Host_USB_Sofware folder for details.
• Improved Examples
  • New Simple Rx/Tx examples for CDC and HID
  • New example That shows how to use a timer to reduce interrupt latency
  • Examples better structured to work on various boards/devices.
  • Examples now use driverlib.
• Improved Documentation
  • Programmers Guide re-worked
  • Documentation of examples moved into Examples Guide
  • API Documentation is now in html format using doxygen.
• Better CCS integration
  • TI-REX integration. The examples and tools can be found under MSP430Ware in TI-REX.
  • Examples now use CCS project spec files instead of entire CCS projects. This makes import and build easier. NOTE: See information os project spec limitation on CCS v5.3 and CCSv5.4
• Improved Directory Structure
  • Directories renamed to better describe their contents
  • Examples renamed to better describe their functionality.
• Improved Descriptor Tool
  • Icons bigger and better
  • Interface views improved to reflect functionality
  • Help text bigger and better
  • Manipulation of views simplified
  • MSC structs generated. Less work for application.
• USB_API changes
  • New USB API USB_setup() simplifies USB initialization
  • USB10 workaround can be enabled by defining USB10_WORKAROUND on the compiler command line
  • Resume interrupt latency can be reduced by defining USE_TIMER_FOR_RESUME on the compiler command line.
  • USB API now computes MCLK value at runtime to compute accurate delays when required.

Defects Fixed in 4_00_02:

MSP430 USB Developers Package 4_00_00 Release

• New Python based firmware upgrader
  • Supports Windows and Linux
  • Developed using open source python-msp430-tools
  • See the Host_USB_Sofware folder for details.
• Improved Examples
  • New Simple Rx/Tx examples for CDC and HID
  • New example That shows how to use a timer to reduce interrupt latency
  • Examples better structured to work on various boards/devices.
  • Examples now use driverlib.
• Improved Documentation
  • Programmers Guide re-worked
  • Documentation of examples moved into Examples Guide
  • API Documentation is now in html format using doxygen.
• Better CCS integration
  • TI-REX integration. The examples and tools can be found under MSP430Ware in TI-REX.
  • Examples now use CCS project spec files instead of entire CCS projects. This makes import and build easier. NOTE: See information os project spec limitation on CCS v5.3 and CCSv5.4
• Improved Directory Structure
  • Directories renamed to better describe their contents
  • Examples renamed to better describe their functionality.
• Improved Descriptor Tool
  • Icons bigger and better
  • Interface views improved to reflect functionality
  • Help text bigger and better
  • Manipulation of views simplified
  • MSC structs generated. Less work for application.
• USB_API changes
  • New USB API USB_setup() simplifies USB initialization
  • USB10 workaround can be enabled by defining USB10_WORKAROUND on the compiler commnad line
  • Resume interruptllatency can be reduced by defining USE_TIMER_FOR_RESUME on the compiler command line.
  • USB API now computes MCLK value at runtime to compute accurate delays when required.

Defects Fixed in 4_00_00:

Known Issues

There are some known issues with importing and building USB examples with older/newer versions of CCS and IAR.

• CCS
  • Build Errors
    • Upon importing an example, lnk_msp430f5529.cmd file is missing from the project. To resolve this issue, browse to <INSTALL_DIR>/ccsv5/ccs_base/msp430/include and add lnk_msp430f5529.cmd file to your project.
    • Some USB examples also include an application specific header file. In such cases add lnk_msp430f5529.cmd as well as msp430usb.cmd from MSP430USBDevelopersPackage_5.20.06.03\MSP430_SW_Development\MSP430_USB_API .
    • Currently SYSBIOS does not support MSP430FG6626 devices so a build error of ‘target not supported’ will be seen.
    • Upon importing earlier versions of GCC examples, into newer versions of CCS 6.0/CCS 6.1, CCS might throw an error of not being able to find the main function. To fix this issue de-select the compiler option ‘-ffunction-sections’ from Properties->Build->GNU Compiler->Optimization configuration section of CCS
    • CHM2_tasks and CHM3_SWIs examples require SYSBIOS and XDCTOOLS to be included as part of the build
  • Build Warnings
    • The following warning will appear on older versions of CCS. This has been fixed in CCS5.5.
      “#303-D typedef name has already been declared (with same type) gpio.c /C0_SimpleSend/driverlib/MSP430F5xx_6xx line 70, external location: C:/ti/CCS5_3_0_00090/ccsv5/ccs_base/msp430/include/msp430f5529.h C/C++ Problem”
  • MSP430 GCC
    • Only available in CCS 6.0 and greater.
    • SYSBIOS does not support GCC
    • MSP430 GCC does not support Large Memory Model.
• Command Line GCC
  • Build Errors
    • Examples will fail to build if any of the path names listed in the examples’ Makefiles are longer than 160 characters.
• IAR
  • Older versions of IAR cannot import the USB examples. You will have to re-create the IAR projects manually

Upgrading from a Previous Version

5.20.06.03 release of USB Developers Package has been compiled to work with with version 2.70.00.08 driverlib library. (See driverlib release_notes.html file for changes).

If existing users want to update to 5.20.06.03, then the following should be done:

• Copy/Replace stack files.
  • Browse to MSP430USBDevelopersPackage_5.20.06.03\MSP430_SW_Development\MSP430_USB_API
  • Copy over the driverlib folder (see MSP430Ware release notes for upgrade information)
  • Completely replace the USB_API folder. (delete old folder).
• Re-generate Descriptor Tool Output
  • Launch the new Descriptor Tool from MSP430USBDevelopersPackage_5.20.06.03\MSP430_SW_Development\MSP430_USB_DescriptorTool.
  • Follow the instructions in the programmers guide to create your USB device again or bring up the old descriptor tool and open the DAT file (.DAT files prior to MSP430USBDevelopersPackage version 5_00_00) for your project and copy all the fields to the new tool.
  • If you have a MSC interface in your application re-visit the MSC Interface to add Logical Unit Configuration.
  • Delete the existing descriptors.c, descriptors.h and UsbIsr.c files in the USB_config folder of your old project.
  • Click the “Generate” button and save all files into the USB_config folder of your old project. The XML file now replaces the old DAT configuration file. The DAT file can be deleted.
  • You can now close the Descriptor Tool.
• Replace deprecated driverlib APIs in all other files with their equivalent as listed in the driverlib release_notes.html file and APIS_REMOVED.html file.

Updating driverlib to a New Version

Simply replace the entire dirverlib folder with the new version.

Command Line GCC and Makefile

To run the GCC examples from the command line, two variables in the each example makefile has to be updated. See the Examples Guide for more details

Benchmarks

The USB stack code metrics were performed with the CCS 4.3.3 compiler, and IAR 6.30 compiler with different optimization settings. Users may see different code sizes depending on their project settings so it is best to perform the benchmarks within the project itself. Code metrics for the USB stack code can be viewed here:

• Metrics

Performance

MSC PERFORMANCE (Single Buffering)

MSC PERFORMANCE (Double Buffering)

VDBENCH application used for MSC benchmarking. No validation of transfer done. Measured in Mega Bytes/sec.

CDC PERFORMANCE

Tranfer size for CDC benchmarks is 2048 arrays with 1024bytes/array. The MSP430 application used calls USBCDC_rejectData() for any data it receives. The is to nearly eliminate the device application from being a factor. If the application rejects the data, it doesn’t use any time to move the data. In contrast, any real application must handle the data, and thus will get considerably less, probably closer to the 200-500KB/sec range.

INTERRUPT LATENCY

Special benchmark applications were used with code inserted to measure latency using a timer. Applications made use new USE_TIMER_FOR_RESUME to reduce interrupt latency for resume interrupt. Without the use of USE_TIMER_FOR_RESUME resume interrupt can take arounbd 13000 cycles.

Host Support

Supported Operating Systems:

• Windows 7 and Windows 10
• MAC Yosemite and El Capitan
• Linux

Dependencies

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

• Code Composer Studio Version: 6.0.190
• IAR Embedded Workbench for MSP430 6.30
• SYSBIOS v6_37_01_24 and XDCTOOLS v3_25_05_94.

Versioning

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. msp_connectivity_library_5_10_00_01.

Technical Support and Product Updates

• Visit the MSP E2E Forum for support.

Additional Resources

For more information about Texas Instruments, MSP430 or MSP432 visit www.ti.com and www.msp430.com.