1# MCUXpresso SDK: mcux-sdk 2 3[EN](./README.md)|[中文](./README_CN.md) 4[](https://github.com/NXPmicro/mcux-sdk/releases/latest) 5[](https://github.com/NXPmicro/mcux-sdk/graphs/contributors) 6[](https://github.com/NXPmicro/mcux-sdk/issues) 7[](https://github.com/NXPmicro/mcux-sdk/pulls) 8 9MCUXpresso SDK is a comprehensive software enablement package designed to simplify and accelerate application development with Arm® Cortex®-M-based devices from NXP, including its general purpose, crossover and Bluetooth™-enabled MCUs. This project provides an alternative way for user to achieve the source code of MCUXpresso SDK besides SDK builder and MCUXpresso IDE. 10 11The whole MCUXpresso SDK delivery is composed of separate project deliveries. The idea we split the whole SDK delivery to separate projects is inspired by [Zephyr](https://github.com/zephyrproject-rtos/zephyr), and the projects are planned as below: 12* Fundamental project for device/board enablement with shared drivers and components. 13* RTOS projects 14* Middleware projects 15* Examples project built on above deliveries 16 17In this way we want to benefit user from below aspects: 181. Avoid huge size in a single repository. 192. Provide flexibility for user to select needed projects to build their application. 203. Provide ability for user to fetch needed project version to build their application. 21 22To satisfy the expectation we leveraged [Zephyr west tool](https://docs.zephyrproject.org/latest/guides/west/index.html) which helps do multi-repository management and allow user to self create ```west.yml``` to select needed projects for downstream use. 23 24## Overview 25This project provides the fundamental support for all NXP hot parts: 26 27* Arm® CMSIS-CORE startup and device header files and CMSIS-DSP standard libraries 28* Open-source peripheral drivers that provide stateless, high-performance, easy-to-use APIs 29* Drivers for communication peripherals also include high-level transactional APIs for high-performance data transfers 30* High-quality software: all drivers and startup code are MISRA-C: 2012 compliant and checked with Coverity® static analysis tools 31 32**The project can work solely**, if you only want to get the fundamental support for SoC(s) or board(s), you just use the original Git way to clone and checkout the project. 33 34**The project is also the main repository to achieve the whole SDK delivery**, it contains the [west.yml](https://github.com/NXPmicro/mcux-sdk/blob/main/west.yml) which keeps description and revision for other projects in the overall MCUXpresso delivery. Currently available middleware sets are shown in below figure, user could click the middleware to navigate the middleware project repo. 35[](https://htmlpreview.github.io/?https://github.com/NXPmicro/mcux-sdk/blob/main/docs/sdk_graph.html) 36You need to have both Git and West installed in order to get a new delivery of the whole SDK or update the existing SDK deliveries. You could follow below guide according to your scenario: 37* Clone/check-out a new delivery of whole SDK 38 39 Execute below commands to achieve the whole SDK delivery at revision ```${revision}``` and place it in a folder named ```mcuxsdk``` 40 ``` 41 west init -m https://github.com/NXPmicro/mcux-sdk --mr ${revision} mcuxsdk 42 cd mcuxsdk 43 west update 44 ``` 45 Replace ```${revision}``` with any SDK revision(branch/tag/commit SHA) you wish to achieve. This can be ```main``` if you want the latest state, or any commit SHA or tag. 46 47* Update existing west cloned SDK whole delivery 48 49 Assume you have followed previous commands to clone/check-out whole SDK delivery to the west workspace mcuxsdk, then the main repository of SDK is located in mcuxsdk/core. If you would like to update/check-out to another revision, you need to first update the main repository to the expected revision, then update the west workspace: 50 51 When you would like to update SDK full delivery in the latest branch of main repository, follow below commands: 52 53 ``` 54 cd mcuxsdk/core 55 git fetch 56 git rebase 57 west update 58 ``` 59 60 If the ```${revision}``` is different revision from that used in main repository, such as different branch, different tag or different commit SHA, you could follow below commands: 61 ``` 62 cd mcuxsdk/core 63 git fetch 64 git checkout ${revision} 65 west update 66 ``` 67 68## Releases 69 70There are two types of release in the project. The MCUXpresso SDK release and GitHub Main SDK release. Below description uses **MCUX release** short for MCUXpresso SDK release, use **Main release** short for GitHub Main SDK release. 71 72### MCUX Release 73The MCUX release launches once a new release is available on [SDK Builder](http://mcuxpresso.nxp.com/). Users previously using [SDK Builder](http://mcuxpresso.nxp.com/) could easily find the exact same code base MCUX release with same 2.x.y version of SDK archive package, software examples build/run quality are guaranteed in the release. **MCUX releases will be prefixed with 'MCUX_'**, and every release will be merged into main branch to ensure main branch has all released boards/socs support. 74 75The "MCUX_" releases are categorized into mainline releases and NPI release. 76* For mainline releases, usually it's planned twice a year to do a global feature update for NXP hot parts. The x in 2.x.y version increments each time a mainline release goes out. 77* For NPI release, it aims to support a new soc product recently launched in the market. It is built with verified features in previous mainline release. The release name is suffixed with NPI name to identify it's an NPI release. 78 79Each MCUX release is made on previous mainline release tag/NPI release tag, thus user could easily check the difference between two releases using ````git diff```` command. 80 81### Main Release 82The Main release is a regular release made in main branch. It releases the latest code base and feature set on main branch, which is expected to include all the previous 'MCUX_' release content and new enablement on main branch for NXP hot parts. **Main releases will be prefixed with 'MAIN_'**. 83 84Below figure takes 2.9.0 and 2.10.0 release as an example to show the relationship between MCUX release and Main release. 85 86 87## Supported development tools and systems 88* Tools 89 * MCUXpresso IDE 90 * GCC ARM Embedded 91 92 For version of the tool used, please check the release notes in each release. 93* Systems 94 95 See [Supported development systems](docs/supported_development_systems.md) for the list of boards/socs currently support in this project. 96 97## Getting Started 98See [Getting Start Guide](docs/Getting_Started.md) to start explore the project. 99 100## License 101All SDK drivers, components, device support files, board support files in this project are under BSD-3-Clause license, license copy please check [COPYING_BSD-3](COPYING-BSD-3). The ARM CMSIS component is under Apache License 2.0, license copy check [Apache License 2.0](CMSIS/LICENSE.txt). License information for all components could be found in [SW-Content-Register.txt](SW-Content-Register.txt) 102 103## Contribution 104Contributions are greatly welcomed! For detail guideline of contribution please check [Contribution Guide](CONTRIBUTING.md). 105 106
){kind=link}
