This repository contains TI's MSP-CMSIS-DRIVER package.
Summary | Features | Background | Related Repos | Setup Instructions | Build Instructions | Supported Devices | Specification | Known Issues | Licensing | Contributions | Developer Resources
This package provides a CMSIS-DRIVER inteface to peripherals on TI MSPM0 microcontrollers based on Arm® Cortex®-M0+ processors.
This package currently supports the following CMSIS-Driver modules:
- Driver_USART (configurable with DMA or interrupt driven I/O)
The following additional CMSIS-Driver modules are planned for future versions of this package:
- Driver_I2C (configurable with DMA or interrupt driven I/O)
- Driver_SPI (configurable with DMA or interrupt driven I/O)
- Driver_GPIO (configurable with DMA or interrupt driven I/O)
The package is developed to be compatible with CMSIS-DRIVER 2.10.0.
This package is currently released to TI's GitHub sandbox for evaluation.
MSPM0-SDK repository (software development kit for MSPM0 microcontrollers)
This software package was developed & tested against the following dependent components:
- TI Code Composer Studio v20 IDE or greater (view on TI.com)
- TI Arm Clang 4.0.x (or greater), included in Code Composer Studio or available from TI separately (view on TI.com)
- TI MSPM0-SDK 2.04.00.06 (or greater) (view on TI.com or view on GitHub)
Currently, CMSIS-Pack delivery is not supported. This is planned to be added in future verions of this package to ease integration.
The repository contains the following directories:
- /source
- /CMSIS/Drivers (These are the Arm standard interface files)
- Driver_Common.h
- Driver_USART.h
- /Drivers (These are the TI implementation back end source files)
- /V0
- Driver_USART_MSP_Priv.h
- Driver_USART_MSP_Priv.c
- /V0
- /Drivers_Interface (These are the TI implementation front end source files)
- Driver_Common_MSP.h
- Driver_USART_MSP.h
- Driver_USART_MSP.c
- /CMSIS/Drivers (These are the Arm standard interface files)
- /examples (These are the code examples for the LaunchPad EVMs and Code Composer Studio)
- /nortos
- /LP_MSPM0G3507
- /cmsis_driver_uart
- /cmsis-driver-usart-echo (This is the USART echo code example for MSPM0G3507)
- /cmsis-driver-usart-loopback-dma (This is the USART dual-driver / DMA code example for MSPM0G3507)
- /cmsis_driver_uart
- /LP_MSPM0G3519
- /cmsis_driver_uart
- /cmsis-driver-usart-echo (This is the USART echo code example for MSPM0G3507)
- /cmsis-driver-usart-loopback-dma (This is the USART dual-driver / DMA code example for MSPM0G3519)
- /cmsis_driver_uart
- /LP_MSPM0G3507
- /nortos
Follow the steps below to set up an environment to import, build, and run one of the included code examples.
- Download and install TI Code Composer Studio with support for MSPM0 microcontrollers.
- Download and install (or clone from GitHub) the MSPM0-SDK (software development kit for MSPM0 microcontrollers).
- In TI Code Composer Studio, import a code example such as the CMSIS-DRIVER USART Echo code example by selecting "File -> Import Project" in Code Composer Studio and browsing to the example project for the desired target hardware platform.
- Build the code example in Code Composer Studio.
- Connect a serial terminal to the LaunchPad XDS-110 UART back channel COM port. The device will communicate with the host computer using its UART0 peripheral on PA10/PA11, which by default connects to the TI XDS-110 emulator (virtual COM port). A configuration of 115200B 8N1 is used.
- Launch a debug session in Code Composer Studio.
- The device will send a welcome banner string to the serial communication terminal. It will then echo characters received in the terminal back to the terminal (in the case of the USART echo example).
Quick start guides for using MSPM0 with Code Composer Studio are available on TI.com.
The MSP-CMSIS-DRIVER package is delivered as source only. Build of the drivers takes place as a part of the targeted project build overall. A static configuration file is required to be set up to define static parameters. All other parameters are configured through the CMSIS-DRIVER application programming interface.
The MSP-CMSIS-DRIVER modules (at this time, the USART module) do not require any configuration in the SysConfig visual configuration tool. The following static properties of each driver instance must be configured in a file named Driver_Config_MSP.h"* and subsequently included in the build include path.
The Driver_USART module requires the definitions below to be placed in the Driver_Config_MSP.h file for each instance. The code examples already include this file. These definitions specify the static driver configuration parameters which are not exposed through runtime APIs.
- TX pin mux index and port function selection (set unused functions to DRIVER_IO_MSP_NONE value).
- RX pin mux index and port function selection (set unused functions to DRIVER_IO_MSP_NONE value)
- RTS pin mux index and port function selection (set unused functions to DRIVER_IO_MSP_NONE value)
- CTS pin mux index and port function selection (set unused functions to DRIVER_IO_MSP_NONE value)
- Clock selection and frequency
- TX DMA hardware controller instance, channel, trigger (optional)
- RX DMA hardware controller instance, channel, trigger (optional)
Two configurations are shown in an example Driver_Config_MSP.h below, one for USART0 and a second for USART1. The USART0 configuration does not configure DMA channels for TX/RX (Note that the TX_DMA_xx and RX_DMA_xx values are set to NONE labels). As such, USART0 will use interrupt driven input/output. The USART1 configuration is configured to use the DMA for TX/RX (note that the TX_DMA_xx and RX_DMA_xx values are set to valid parameters). As such, USART1 will use DMA driven input/output. The code examples only send data on USART0, but USART1 static configuration is also included and the code examples can be easily modified to initialize and use USART1 without needing to modify the static configuration.
To add more instances, simply copy and past the configuration block and update it for the parameters used by USART2, USART3, and so forth as required. The device datasheet may be referred to for identifying pin configurations (IOMUX PINCM, PF). If the peripheral clock sources/frequencies are updated, note that the CLOCK_FREQ parameter must too be updated to ensure correct baud rate calculations.
#include <ti/devices/msp/msp.h>
#include <Driver_USART_MSP.h>
/* USART Driver Configuration Options */
/* Driver_USART0 Configuration (Maps to MSP hardware UART0 peripheral) */
#define DRIVER_CONFIG_HAS_USART0 (1)
#if (DRIVER_CONFIG_HAS_USART0==1) && defined(UART0_BASE)
#define DRIVER_USART0_TX_PINCM (IOMUX_PINCM21)
#define DRIVER_USART0_TX_PF (IOMUX_PINCM21_PF_UART0_TX)
#define DRIVER_USART0_RX_PINCM (IOMUX_PINCM22)
#define DRIVER_USART0_RX_PF (IOMUX_PINCM22_PF_UART0_RX)
#define DRIVER_USART0_RTS_PINCM (IOMUX_PINCM19)
#define DRIVER_USART0_RTS_PF (IOMUX_PINCM19_PF_UART0_RTS)
#define DRIVER_USART0_CTS_PINCM (IOMUX_PINCM20)
#define DRIVER_USART0_CTS_PF (IOMUX_PINCM20_PF_UART0_CTS)
#define DRIVER_USART0_CLOCK_SEL (DRIVER_CLK_MSP_BUSCLK)
#define DRIVER_USART0_CLOCK_FREQ (32000000)
#define DRIVER_USART0_TX_DMA_HW (DRIVER_DMA_HW_NONE)
#define DRIVER_USART0_TX_DMA_CH (DRIVER_DMA_CH_NONE)
#define DRIVER_USART0_TX_DMA_TRIG (DRIVER_DMA_TRIG_NONE)
#define DRIVER_USART0_RX_DMA_HW (DRIVER_DMA_HW_NONE)
#define DRIVER_USART0_RX_DMA_CH (DRIVER_DMA_CH_NONE)
#define DRIVER_USART0_RX_DMA_TRIG (DRIVER_DMA_TRIG_NONE)
#endif
/* Driver_USART1 Configuration (Maps to MSP hardware UART1 peripheral) */
#define DRIVER_CONFIG_HAS_USART1 (1)
#if (DRIVER_CONFIG_HAS_USART1==1) && defined(UART1_BASE)
#define DRIVER_USART1_TX_PINCM (IOMUX_PINCM23)
#define DRIVER_USART1_TX_PF (IOMUX_PINCM23_PF_UART1_TX)
#define DRIVER_USART1_RX_PINCM (IOMUX_PINCM24)
#define DRIVER_USART1_RX_PF (IOMUX_PINCM24_PF_UART1_RX)
#define DRIVER_USART1_RTS_PINCM (IOMUX_PINCM16)
#define DRIVER_USART1_RTS_PF (IOMUX_PINCM16_PF_UART1_RTS)
#define DRIVER_USART1_CTS_PINCM (IOMUX_PINCM15)
#define DRIVER_USART1_CTS_PF (IOMUX_PINCM15_PF_UART1_CTS)
#define DRIVER_USART1_CLOCK_SEL (DRIVER_CLK_MSP_BUSCLK)
#define DRIVER_USART1_CLOCK_FREQ (32000000)
#define DRIVER_USART1_TX_DMA_HW (DMA)
#define DRIVER_USART1_TX_DMA_CH (0U)
#define DRIVER_USART1_TX_DMA_TRIG (DMA_UART1_TX_TRIG)
#define DRIVER_USART1_RX_DMA_HW (DMA)
#define DRIVER_USART1_RX_DMA_CH (1U)
#define DRIVER_USART1_RX_DMA_TRIG (DMA_UART1_RX_TRIG)
#endif
To include MSP-CMSIS-DRIVER software in another project, all that is required is to bring in the /msp-cmsis-driver directory to the project, and the corresponding include paths, and add a Driver_Config_MSP.h to the project (example shown above) to provide the static configurations for the driver instances.
The following LaunchPad evaluation kits are currently supported with code examples in this package:
- LP-MSPM0G3507 LaunchPad Evaluation Kit (view on TI.com)
- Uses the MSPM0G3507 80MHz Arm® Cortex®-M0+ MCU with 128KB flash 32KB SRAM 2x4Msps ADC, DAC, 3xCOMP, 2xOPA, CAN-FD, MATHA
- LP-MSPM0G3519 LaunchPad Evaluation Kit (view on TI.com)
- Uses the MSPM0G3519 80 MHz ARM® Cortex®-M0+ MCU with dual-bank 512kB flash, 128kB SRAM, 2xCAN-FD, 2xADC, DAC, COMP
The following LaunchPad evaluation kits are planned to be supported with code examples in future versions of this package:
- LP-MSPM0L1117 LaunchPad Evaluation Kit (view on TI.com)
- Uses the MSPM0L1117 32MHz Arm® Cortex®-M0+ MCU with 128KB dual-bank flash, 16KB SRAM, 12-bit 1.68Msps ADC
- LP-MSPM0L2228 LaunchPad Evaluation Kit (view on TI.com)
- Uses the MSPM0L2228 32MHz Arm® Cortex®-M0+ MCU with 256KB dual-bank flash, 32KB SRAM, 12bit ADC, COMP, LCD, VBAT, PSA
The software is currently tested against the following device variants:
- MSPM0G110x, MSPM0G150x, MSPM0G310x, MSPM0G350x, MSPM0G151x, MSPM0G351x 80MHz Arm® Cortex®-M0+ MCUs
The drivers are expected to work without major modifications on additional MSPM0 devices.
The MSP-CMSIS-DRIVER package specifications are provided below for reference.
The overall package supports the following capabilities:
| Req ID | Description | Summary | Status |
|---|---|---|---|
| MSPSWSDK-5132 | [SPS] CMSIS-Driver peripheral access structure | The MSP-CMSIS-DRIVER modules shall provide a CMSIS-Driver access structure for each hardware instance of the supported peripheral type. | Implemented |
| MSPSWSDK-5133 | [SPS] CMSIS-Driver CMSIS headers | The MSP-CMSIS-DRIVER modules shall use the CMSIS-Driver defined interface header files for the respective modules (ex: Driver_USART.h) as-is without modification. | Implemented |
| MSPSWSDK-5134 | [SPS] CMSIS-Driver peripheral instance pin selection and configuration | The MSP-CMSIS-DRIVER modules shall support configuration of the MSP IOMUX during driver init/deinit. | Implemented |
| MSPSWSDK-5135 | [SPS] CMSIS-Driver peripheral instance clock configuration | The MSP-CMSIS-DRIVER modules shall support configuration of the peripheral module functional clock during driver power control configuration. | Implemented |
| MSPSWSDK-5136 | [SPS] CMSIS-Driver dependencies | The MSP-CMSIS-DRIVER modules shall be based upon DriverLib and not have other dependencies outside of DriverLib, Arm CMSIS includes, and MSP MCU header support files. | Implemented |
The Driver_USART module supports the following capabilities:
| Req ID | Description | Summary | Status |
|---|---|---|---|
| MSPSWSDK-5137 | [SPS] CMSIS-Driver UART module interface | The MSP-CMSIS-DRIVER UART module shall implement the USART application interface defined in the CMSIS-Driver USART interface specification. | Implemented |
| MSPSWSDK-5138 | [SPS] CMSIS-Driver USART module feature: CTS | The MSP-CMSIS-DRIVER UART module shall provide an option for using a clear-to-send (CTS) line with CMSIS-Driver defined functionality. | Implemented |
| MSPSWSDK-5139 | [SPS] CMSIS-Driver USART module feature: RTS | The MSP-CMSIS-DRIVER UART module shall provide an option for using a ready-to-send (RTS) line with CMSIS-Driver defined functionality. | Implemented |
| MSPSWSDK-5140 | [SPS] CMSIS-Driver USART module feature: baud rate configuration | The MSP-CMSIS-DRIVER UART module shall support baud rate configuration taking a desired baud rate and functional clock frequency as inputs. | Implemented |
| MSPSWSDK-5141 | [SPS] CMSIS-Driver USART module feature: word length configuration | The MSP-CMSIS-DRIVER UART module shall support configurable word lengths of 5, 6, 7, or 8 data bits. Other bit configurations shall return an error. | Implemented |
| MSPSWSDK-5142 | [SPS] CMSIS-Driver USART module feature: parity bits | The MSP-CMSIS-DRIVER UART module shall support configurable parity: no parity, even parity, or odd parity. | Implemented |
| MSPSWSDK-5143 | [SPS] CMSIS-Driver USART module feature: stop bits | The MSP-CMSIS-DRIVER UART module shall support configurable stop bits: one or two stop bits. Other conditions shall return an error. | Implemented |
| MSPSWSDK-5144 | [SPS] CMSIS-Driver USART module feature: transmit completed event | The MSP-CMSIS-DRIVER UART module shall support generation of a transmit completed event which indicates when data has completed transmission on the line. | Implemented |
| MSPSWSDK-5145 | [SPS] CMSIS-Driver USART module feature: receive timeout error event | The MSP-CMSIS-DRIVER UART module shall support generation of a receive error timeout event, using the maximum available hardware timeout interval by default (as a hard coded value). | Implemented |
| MSPSWSDK-5146 | [SPS] CMSIS-Driver USART module feature: framing error event | The MSP-CMSIS-DRIVER UART module shall support generation of a framing error event. | Implemented |
| MSPSWSDK-5147 | [SPS] CMSIS-Driver USART module feature: parity error event | The MSP-CMSIS-DRIVER UART module shall support generation of a parity error event. | Implemented |
| MSPSWSDK-5148 | [SPS] CMSIS-Driver USART module feature: receive overflow error event | The MSP-CMSIS-DRIVER UART module shall support generation of a receive overflow error event. | Implemented |
| MSPSWSDK-5149 | [SPS] CMSIS-Driver USART module feature: receive complete event | The MSP-CMSIS-DRIVER UART module shall support generation of a receive complete event, indicating when the requested number of words has been received. | Implemented |
| MSPSWSDK-5150 | [SPS] CMSIS-Driver USART module feature: send complete event | The MSP-CMSIS-DRIVER UART module shall support generation of a transmit complete event, indicating when the requested number of words has been loaded to the UART hardware for subsequent transmission. | Implemented |
| MSPSWSDK-5151 | [SPS] CMSIS-Driver UART module feature: asynchronous mode | The MSP-CMSIS-DRIVER UART module shall support asynchronous serial communication in RX, TX, or RX/TX modes. | Implemented |
| MSPSWSDK-5152 | [SPS] CMSIS-Driver UART module interrupt driven I/O | The MSP-CMSIS-DRIVER UART module shall provide an option for using interrupt driven non-blocking input/output for transmit and receive operations, configured statically on a per-instance basis. | Implemented |
| MSPSWSDK-5153 | [SPS] CMSIS-Driver USART module DMA driven I/O | The MSP-CMSIS-DRIVER UART module shall provide an option for using DMA driven non-blocking input/output for transmit and receive operations, configured statically on a per-instance basis. | Implemented |
| MSPSWSDK-5154 | [SPS] CMSIS-Driver USART module loopback code example with DMA | The MSP-CMSIS-Driver product shall include a code example demonstrating USART in a loopback configuration with an external wire for loopback, demonstrating setup and teardown of the driver and use of DMA. | Implemented |
| MSPSWSDK-5245 | [SPS] CMSIS-Driver USART module back channel UART example | The MSP-CMSIS-DRIVER product shall include a code example for USART transmit / receive in a back channel configuration with the XDS-110. | Implemented |
| Bug ID | Description | Summary | Status |
|---|---|---|---|
| MSPSWSDK-5252 | [BUG] MSP-CMSIS-DRIVER USART Baud rate calculation error | During baud rate unit test, the following errors were seen:150B FBRD 1 less than expected, 4800B FBRD 1 less than expected, 19200B FBRD 1 less than expected. No issue seen with other baud rates and impact is minor. | Accepted |
This repository is not currently accepting community contributions.
TI E2E™ design support forums | Learn about software development at TI | Training Academies | TI Developer Zone