Skip to content

Commit e0a27c4

Browse files
Merge pull request zephyrproject-rtos#13 from TexasInstruments/mspm33_documentation
Add README.md and boards index.rst file for MSPM33
2 parents 212edd9 + 29bd1bd commit e0a27c4

File tree

2 files changed

+120
-39
lines changed

2 files changed

+120
-39
lines changed

README.md

Lines changed: 20 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
<div align="left">
99

10-
# MSP Downstream Support For Zephyr
11-
This repository contains early Zephyr Support for MSP-class devices
10+
# MSPM33 Downstream Support For Zephyr
11+
This repository contains early Zephyr Support for MSPM33-class devices
1212

1313
The Texas Instruments Zephyr GitHub repository is the starting point for Zephyr
1414
development on supported Texas Instruments devices. TI's Zephyr solution is
@@ -25,49 +25,42 @@ The Zephyr OS is based on a small-footprint kernel designed for use on
2525
resource-constrained systems: from simple embedded environmental sensors and
2626
LED wearables to sophisticated smart watches and IoT wireless gateways.
2727

28-
This downstream repository of TI Zephyr is based on the current upstream and
29-
advance features concerning specific MSP MCUs.
28+
This downstream repository of TI Zephyr is based on the current upstream and
29+
advance features concerning specific MSPM33 MCUs.
3030

31-
This release contains
32-
support for the `MSPM0G3507`, `MSPM0L2228`, and `MSPM0G3519` devices.
31+
This release contains support for the `MSPM33C321A` device.
32+
33+
## Release Information
34+
35+
| Version | v4.2.0-ti-1.00.00.00_EA (pre-APL) |
36+
|---------|--------------------------|
37+
| Zephyr RTOS | <br>• Zephyr Base Device Support<br>• Board Configuration, DTS, Interrupts, Timers, Clock (Fix Clocked), Pinmux, GPIO<br>• HS-ADC (Basic)<br>• Blinky Example |
3338

3439
### Devices
3540

3641
Supported:
3742

38-
- [MSPM0G3507](https://www.ti.com/product/MSPM0G3507)
39-
- [MSPM0L2228](https://www.ti.com/product/MSPM0L2228)
40-
- [MSPM0G3519](https://www.ti.com/product/MSPM0G3519)
43+
- [MSPM33C321A]
4144

4245
### Boards
4346

4447
Supported:
4548

46-
- [lp_mspm0g3507](https://www.ti.com/tool/LP-MSPM0G3507)
47-
- [lp_mspm0l2228](https://www.ti.com/tool/LP-MSPM0L2228)
48-
- [lp_mspm0g3519](https://www.ti.com/tool/LP-MSPM0G3519)
49+
- [lp_mspm33c321a]
4950

5051
## Getting Started
5152

52-
For getting started, please refer to the [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html) and
53-
[SimpleLink Academy Trainings](https://dev.ti.com/tirex/explore/node?node=A__ABCS5JT7BlsTcu2NNH3HBg__SIMPLELINK-ACADEMY-CC23XX__gsUPh5j__LATEST),
54-
it has guidance for setting up the Zephyr environment and building your first application.
53+
For getting started, please refer to the [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html).
54+
55+
For detailed board-specific information, building instructions, flashing procedures, and required development tools, please refer to the board documentation in `boards/ti/lp_mspm33c321a/doc/index.rst`.
5556

5657
> **_NOTE:_** When running `west init` in the getting-started guide it's
57-
> important to instead run `west init -m https://github.com/TexasInstruments/msp-zephyr zephyrproject`
58+
> important to instead run `west init -m https://github.com/TexasInstruments/msp-zephyr --mr v4.2.0-ti-1.00.00.00_ea zephyrproject`
5859
> in order to use the TI Zephyr repository.
59-
> The `{tag-name}` changes with each release from TI.
60+
> Replace `zephyrproject` with your desired project directory name.
61+
> The `v4.2.0-ti-1.00.00.00_ea` tag changes with each release from TI and zephyr .
6062
>
61-
> You can look up the latest tag from the following link:
62-
> https://github.com/TexasInstruments/simplelink-zephyr/tags
63-
64-
## Tools support
6563
66-
Currently the XDS110 debugger supplied with TI Launchpads is not natively
67-
supported in the `west` Zephyr tool using OpenOCD. Note that it is also possible
68-
to build an application in Zephyr, flash using `west`, and use
69-
[Code Composer Studio](https://www.ti.com/tool/CCSTUDIO) to debug the
70-
application using the XDS110 debugger.
7164

7265
## Versioning
7366

@@ -82,24 +75,12 @@ This tag can be broken down into 4 components:
8275
version. The version scheme is explained below.
8376
- Qualifier. The qualifier keyword is described below.
8477

85-
### TI Versioning Scheme
86-
87-
The TI version follows a version format, M.mm.pp, where:
88-
89-
- M is a 1 digit major number,
90-
- mm is a 2 digit minor number,
91-
- pp is a 2 digit patch number.
92-
93-
M.mm will follow TI's SimpleLink SDK version and is an indicator that the TI
94-
added content is based on the SimpleLink SDK with matching M.mm.
9578

9679
## Releases
9780

9881
All releases will be tagged using the version format above. Release notes are
99-
provided in the form of GitHub's release notices. Read the release notes for
100-
your selected version here:
82+
provided in the form of GitHub's release notices.
10183

102-
https://github.com/TexasInstruments/simplelink-zephyr/releases/
10384

10485
### Disclaimer
10586

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
.. zephyr:board:: lp_mspm33c321a
2+
3+
Overview
4+
********
5+
6+
MSPM33C321A microcontrollers (MCUs) are part of the MSP highly integrated, ultra-low-power 32-bit MCU
7+
family based on the Arm® Cortex®-M33 32-bit core platform operating at up to 160-MHz frequency.
8+
These MCUs offer high-performance analog peripheral integration, support extended temperature
9+
ranges, and operate with supply voltages ranging from 1.62 V to 3.6 V.
10+
11+
The MSPM33C321A devices provide 1MB embedded flash program memory with built-in error correction
12+
code (ECC) and 256KB SRAM with hardware parity option. These MCUs also incorporate a
13+
memory protection unit, DMA, and a variety of peripherals including GPIO, ADC, timers, and
14+
communication interfaces.
15+
16+
Hardware
17+
********
18+
19+
Zephyr uses the ``lp_mspm33c321a`` board for building LP_MSPM33C321A
20+
21+
Supported Features
22+
=================
23+
24+
.. zephyr:board-supported-hw::
25+
26+
27+
Development Environment
28+
======================
29+
30+
The following development environment was used while developing and testing:
31+
32+
* TI Code Composer Studio (CCS) version 20.3.0 (`Download Link <https://www.ti.com/tool/download/CCSTUDIO/20.3.0>`_)
33+
* Zephyr SDK version 0.17.4
34+
* Zephyr version v4.2.0 (v4.2.0-4346-g212edd9ebef)
35+
36+
37+
Release Information
38+
******************
39+
40+
.. list-table::
41+
:header-rows: 1
42+
43+
* - Version
44+
- v4.2.0-ti-1.00.00.00_EA (pre-APL)
45+
* - Zephyr RTOS
46+
- | • Zephyr Base Device Support
47+
| • Board Configuration, DTS, Interrupts, Timers, Clock (Fix Clocked), Pinmux, GPIO
48+
| • HS-ADC (Basic)
49+
| • Blinky Example
50+
51+
52+
Building and Flashing
53+
*********************
54+
55+
Building
56+
========
57+
58+
Follow the :ref:`getting_started` instructions for Zephyr application development.
59+
60+
For example, to build the basic/blinky application for the MSPM33C321A LaunchPad:
61+
62+
.. zephyr-app-commands::
63+
:zephyr-app: samples/basic/blinky
64+
:board: lp_mspm33c321a
65+
:goals: build
66+
67+
The resulting ``zephyr.elf`` binary in the build directory can be loaded onto
68+
MSPM33C321A LaunchPad using the steps mentioned below.
69+
70+
Flashing
71+
========
72+
73+
Currently, the MSPM33C321A board does not support the west flashing tool or OpenOCD support currently.
74+
Instead, we use SRAM-based loading where we build the samples and load the zephyr.elf file
75+
from the build directory to the TI Code Composer Studio (CCS) IDE in debugger mode.
76+
77+
To flash the board:
78+
79+
1. Build your Zephyr application as described above
80+
2. Open TI Code Composer Studio IDE
81+
3. Create a new project or import an existing CCS project for the MSPM33C321A
82+
4. Start project less debug using MSPM33 target configuration(CCXML) file
83+
5. Connect to the MSPM33 core
84+
6. In the debugger, select "Run" > "Load" > "Load Program..."
85+
7. Browse to your Zephyr build directory and select the ``zephyr.elf`` file
86+
8. The program will be loaded into the SRAM of the device
87+
9. Click "Resume" to start the program execution
88+
89+
Future updates to the Zephyr support for this board will include flash-based programming.
90+
91+
Debugging
92+
=========
93+
94+
You can debug an application using TI Code Composer Studio IDE as described in the flashing
95+
section above. The debugger provides full visibility into the device state, registers,
96+
memory, and supports common debugging features like breakpoints, watchpoints, and step-by-step
97+
execution.
98+
99+
References
100+
**********

0 commit comments

Comments
 (0)