README.md
1# CMSIS Version 5
2
3The branch *master* of this GitHub repository contains the CMSIS Version 5.8.0. The [documentation](http://arm-software.github.io/CMSIS_5/General/html/index.html) is available under http://arm-software.github.io/CMSIS_5/General/html/index.html
4
5Use [Issues](https://github.com/ARM-software/CMSIS_5#issues-and-labels) to provide feedback and report problems for CMSIS Version 5.
6
7**Note:** The branch *develop* of this GitHub repository reflects our current state of development and is constantly updated. It gives our users and partners contiguous access to the CMSIS development. It allows you to review the work and provide feedback or create pull requests for contributions.
8
9A [pre-built documentation](http://www.keil.com/pack/doc/CMSIS_Dev/index.html) is updated from time to time, but may be also generated using the instructions under [Generate CMSIS Pack for Release](https://github.com/ARM-software/CMSIS_5#generate-cmsis-pack-for-release).
10
11## Overview of CMSIS Components
12
13The following is an list of all CMSIS components that are available.
14
15| CMSIS-... | Target Processors | Description |
16|:----------|:--------------------|:-------------|
17|[Core(M)](http://arm-software.github.io/CMSIS_5/Core/html/index.html) | All Cortex-M, SecurCore | Standardized API for the Cortex-M processor core and peripherals. Includes intrinsic functions for Cortex-M4/M7/M33/M35P SIMD instructions.|
18|[Core(A)](http://arm-software.github.io/CMSIS_5/Core_A/html/index.html)| Cortex-A5/A7/A9 | API and basic run-time system for the Cortex-A5/A7/A9 processor core and peripherals.|
19|[Driver](http://arm-software.github.io/CMSIS_5/Driver/html/index.html) | All Cortex-M, SecurCore | Generic peripheral driver interfaces for middleware. Connects microcontroller peripherals with middleware that implements for example communication stacks, file systems, or graphic user interfaces.|
20|[DSP](http://arm-software.github.io/CMSIS_5/DSP/html/index.html) | All Cortex-M | DSP library collection with over 60 Functions for various data types: fixed-point (fractional q7, q15, q31) and single precision floating-point (32-bit). Implementations optimized for the SIMD instruction set are available for Cortex-M4/M7/M33/M35P.|
21|[NN](http://arm-software.github.io/CMSIS_5/NN/html/index.html) | All Cortex-M | Collection of efficient neural network kernels developed to maximize the performance and minimize the memory footprint on Cortex-M processor cores.|
22|[RTOS v1](http://arm-software.github.io/CMSIS_5/RTOS/html/index.html) | Cortex-M0/M0+/M3/M4/M7 | Common API for real-time operating systems along with a reference implementation based on RTX. It enables software components that can work across multiple RTOS systems.|
23|[RTOS v2](http://arm-software.github.io/CMSIS_5/RTOS2/html/index.html)| All Cortex-M, Cortex-A5/A7/A9 | Extends CMSIS-RTOS v1 with Armv8-M support, dynamic object creation, provisions for multi-core systems, binary compatible interface. |
24|[Pack](http://arm-software.github.io/CMSIS_5/Pack/html/index.html) | All Cortex-M, SecurCore, Cortex-A5/A7/A9 | Describes a delivery mechanism for software components, device parameters, and evaluation board support. It simplifies software re-use and product life-cycle management (PLM). |
25|[SVD](http://arm-software.github.io/CMSIS_5/SVD/html/index.html) | All Cortex-M, SecurCore | Peripheral description of a device that can be used to create peripheral awareness in debuggers or CMSIS-Core header files.|
26|[DAP](http://arm-software.github.io/CMSIS_5/DAP/html/index.html) | All Cortex | Firmware for a debug unit that interfaces to the CoreSight Debug Access Port. |
27|[Zone](http://arm-software.github.io/CMSIS_5/Zone/html/index.html) | All Cortex-M | Defines methods to describe system resources and to partition these resources into multiple projects and execution areas. |
28
29## Implemented Enhancements
30 - CMSIS-Pack generation with [shell script template](https://arm-software.github.io/CMSIS_5/Pack/html/bash_script.html) for Windows and Linux
31 - CMSIS-Pack: [Git workflow](https://arm-software.github.io/CMSIS_5/Pack/html/element_repository.html) via Eclipse menu *Window - Preferences - CMSIS Packs - Manage Local Repositories* and [MDK](http://www.keil.com/support/man/docs/uv4/uv4_ca_packinst_repo.htm)
32 - [CMSIS-Zone release 1.0](https://arm-software.github.io/CMSIS_5/Zone/html/index.html) with support for multi-processor, TrustZone, and MPU configuration
33 - Support for Armv8.1M Architecture and Cortex-M55 (release in March 2020)
34 - CMSIS-DSP is fully ported to SIMD for Cortex-M family (Armv8.1-M) and Cortex-A & Cortex-R with NEON, using the same APIs.
35
36## Further Planned Enhancements
37 - CMSIS-Pack:
38 - System Description SDF Format: describe more complex debug topologies than with a Debug Description in a tool agnostic way
39 - CPDSC project file format: allows project templates that are agnostic of an IDE
40 - Minimize need for IDE specific settings: CMSIS-Pack supports IDE specific parameters. Analyze and minimize
41 - CMSIS-Build: command-line driven make system for CMSIS-Pack based projects (to support CI tests)
42
43For further details see also the [Slides of the Embedded World CMSIS Partner Meeting](https://github.com/ARM-software/CMSIS_5/blob/develop/CMSIS_Review_Meeting_2020.pdf).
44
45## Other related GitHub repositories
46
47| Repository | Description |
48|:--------------------------- |:--------------------------------------------------------- |
49| [cmsis-pack-eclipse](https://github.com/ARM-software/cmsis-pack-eclipse) | CMSIS-Pack Management for Eclipse reference implementation Pack support |
50| [CMSIS-FreeRTOS](https://github.com/arm-software/CMSIS-FreeRTOS) | CMSIS-RTOS adoption of FreeRTOS |
51| [CMSIS-Driver](https://github.com/arm-software/CMSIS-Driver) | Generic MCU driver implementations and templates for Ethernet MAC/PHY and Flash. |
52| [CMSIS-Driver_Validation](https://github.com/ARM-software/CMSIS-Driver_Validation) | CMSIS-Driver Validation can be used to verify CMSIS-Driver in a user system |
53| [CMSIS-Zone](https://github.com/ARM-software/CMSIS-Zone) | CMSIS-Zone Utility along with example projects and FreeMarker templates |
54| [NXP_LPC](https://github.com/ARM-software/NXP_LPC) | CMSIS Driver Implementations for the NXP LPC Microcontroller Series |
55| [mdk-packs](https://github.com/mdk-packs) | IoT cloud connectors as trail implementations for MDK (help us to make it generic)|
56| [trustedfirmware.org](https://www.trustedfirmware.org/) | Arm Trusted Firmware provides a reference implementation of secure world software for Armv8-A and Armv8-M.|
57
58
59## Directory Structure
60
61| Directory | Content |
62|:-------------------- |:--------------------------------------------------------- |
63| CMSIS/Core | CMSIS-Core(M) related files (for release) |
64| CMSIS/Core_A | CMSIS-Core(A) related files (for release) |
65| CMSIS/CoreValidation | Validation for Core(M) and Core(A) (NOT part of release) |
66| CMSIS/DAP | CMSIS-DAP related files and examples |
67| CMSIS/Driver | CMSIS-Driver API headers and template files |
68| CMSIS/DSP | CMSIS-DSP related files |
69| CMSIS/NN | CMSIS-NN related files |
70| CMSIS/RTOS | RTOS v1 related files (for Cortex-M) |
71| CMSIS/RTOS2 | RTOS v2 related files (for Cortex-M & Armv8-M) |
72| CMSIS/Pack | CMSIS-Pack examples and tutorials |
73| CMSIS/DoxyGen | Source of the documentation |
74| CMSIS/Utilities | Utility programs |
75
76## Generate CMSIS Pack for Release
77
78This GitHub development repository contains already pre-built libraries (stored in Git-LFS) of various software components (DSP, RTOS, RTOS2).
79These libraries are validated for release. Git-LFS needs to be installed to retrieve the actual binary files, please see https://git-lfs.github.com/.
80
81To build a complete CMSIS pack for installation the following additional tools are required:
82 - **doxygen.exe** Version: 1.8.6 (Documentation Generator)
83 - **mscgen.exe** Version: 0.20 (Message Sequence Chart Converter)
84 - **7z.exe (7-Zip)** Version: 16.02 (File Archiver)
85
86Using these tools, you can generate on a Windows PC:
87 - **CMSIS Documentation** using the batch file **gen_doc.sh** (located in ./CMSIS/Doxygen).
88 - **CMSIS Software Pack** using the batch file **gen_pack.sh** (located in ./CMSIS/Utilities).
89 The bash script does not generate the documentation. The pre-built libraries for RTX4 and RTX5
90 are not included within this repository.
91
92The file ./CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API documentation.
93
94## License
95
96Arm CMSIS is licensed under Apache 2.0.
97
98## Contributions and Pull Requests
99
100Contributions are accepted under Apache 2.0. Only submit contributions where you have authored all of the code.
101
102### Issues and Labels
103
104Please feel free to raise an [issue on GitHub](https://github.com/ARM-software/CMSIS_5/issues)
105to report misbehavior (i.e. bugs) or start discussions about enhancements. This
106is your best way to interact directly with the maintenance team and the community.
107We encourage you to append implementation suggestions as this helps to decrease the
108workload of the very limited maintenance team.
109
110We will be monitoring and responding to issues as best we can.
111Please attempt to avoid filing duplicates of open or closed items when possible.
112In the spirit of openness we will be tagging issues with the following:
113
114- **bug** – We consider this issue to be a bug that will be investigated.
115
116- **wontfix** - We appreciate this issue but decided not to change the current behavior.
117
118- **enhancement** – Denotes something that will be implemented soon.
119
120- **future** - Denotes something not yet schedule for implementation.
121
122- **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work.
123
124- **question** – We have further questions to this issue. Please review and provide feedback.
125
126- **documentation** - This issue is a documentation flaw that will be improved in future.
127
128- **review** - This issue is under review. Please be patient.
129
130- **DONE** - We consider this issue as resolved - please review and close it. In case of no further activity this issues will be closed after a week.
131
132- **duplicate** - This issue is already addressed elsewhere, see comment with provided references.
133
134- **Important Information** - We provide essential informations regarding planned or resolved major enhancements.
135
136
