README.md 5.76 KB
Newer Older
Reinhard Keil's avatar
Reinhard Keil committed
1
# CMSIS Version 5
ReinhardKeil's avatar
ReinhardKeil committed
2

Reinhard Keil's avatar
Reinhard Keil committed
3
The branch *master* of this GitHub repository contains the CMSIS Version 5.0.1.  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
Reinhard Keil's avatar
Reinhard Keil committed
4

Reinhard Keil's avatar
Reinhard Keil committed
5
Use [Issues](https://github.com/ARM-software/CMSIS_5#issues-and-labels) to provide feedback and report problems for CMSIS Version 5. 
Reinhard Keil's avatar
Reinhard Keil committed
6

Reinhard Keil's avatar
Reinhard Keil committed
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.
ReinhardKeil's avatar
ReinhardKeil committed
8

Reinhard Keil's avatar
Reinhard Keil committed
9
A [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).
ReinhardKeil's avatar
ReinhardKeil committed
10

Reinhard Keil's avatar
Reinhard Keil committed
11
12
## What's Hot
 - CMSIS-RTOS2: RTX 5 is now available for IAR, GCC, ARM Compiler 5, ARM Compiler 6
Reinhard Keil's avatar
Reinhard Keil committed
13
 - CMSIS-RTOS2: FreeRTOS adoption (release) is available https://github.com/ARM-software/CMSIS-FreeRTOS
Reinhard Keil's avatar
Reinhard Keil committed
14
 - CMSIS-Core: compiler agonstic features extended to simplify transition on LLVM based front-end
Reinhard Keil's avatar
Reinhard Keil committed
15
16
 - CMSIS-Core-A: preview of the CMSIS-Core for Cortex-A
 - Coming soon: CMSIS-RTOS2 for Cortex-A
Reinhard Keil's avatar
Reinhard Keil committed
17

Reinhard Keil's avatar
Reinhard Keil committed
18
## Implemented Enhancements
Joachim Krech's avatar
Joachim Krech committed
19
 - Support for ARMv8-M Architecture (Mainline and Baseline) as well as devices Cortex-M23 and Cortex-M33
Reinhard Keil's avatar
Reinhard Keil committed
20

Joachim Krech's avatar
Joachim Krech committed
21
 - CMSIS-RTOS Version 2 API and RTX reference implementation with several enhancements:
Reinhard Keil's avatar
Reinhard Keil committed
22
     - Dynamic object creation, Flag events, C API, additional thread and timer functions
ReinhardKeil's avatar
ReinhardKeil committed
23

Reinhard Keil's avatar
Reinhard Keil committed
24
 - CMSIS-RTOS API Secure and Non-Secure support, multi-processor support
ReinhardKeil's avatar
ReinhardKeil committed
25

Christopher Seidl's avatar
Christopher Seidl committed
26
## Further Planned Enhancements
Reinhard Keil's avatar
Reinhard Keil committed
27
28
29
30
31
 - CMSIS-Core-A: Cortex-A processor support
 - CMSIS-RTOS: RTX5 for Cortex-A
 - CMSIS-DAP: extended trace support
 - CMSIS-Zone: management of complex system
     - Improvements for Cortex-A / M hybrid devices (focus on Cortex-M interaction)
ReinhardKeil's avatar
ReinhardKeil committed
32
 - CMSIS-Pack 
Reinhard Keil's avatar
Reinhard Keil committed
33
     - Additions for generic example and project templates
ReinhardKeil's avatar
typos    
ReinhardKeil committed
34
     - Adoption of IAR Flash Loader technology
35

Reinhard Keil's avatar
Reinhard Keil committed
36
For further details see also the [Slides of the Embedded World CMSIS Partner Meeting](https://github.com/ARM-software/CMSIS_5/blob/develop/CMSIS_EW2017.pdf).
37
38
39
40
41
42

## Directory Structure

| Directory       | Content                                        |                
| --------------- | ---------------------------------------------- |
| CMSIS/Core      | CMSIS-Core related files (for release)         |
Martin Günther's avatar
Martin Günther committed
43
| CMSIS/DAP       | CMSIS-DAP related files and examples           |
44
| CMSIS/Driver    | CMSIS-Driver API headers and template files    |
Martin Günther's avatar
Martin Günther committed
45
| CMSIS/DSP       | CMSIS-DSP related files                        |
Reinhard Keil's avatar
Reinhard Keil committed
46
47
| CMSIS/RTOS      | RTOS v1 related files (for Cortex-M)           |
| CMSIS/RTOS2     | RTOS v2 related files (for Cortex-M & ARMv8-M) |
Joachim Krech's avatar
Joachim Krech committed
48
| CMSIS/Pack      | CMSIS-Pack examples and tutorials              |
49
50
51
| CMSIS/DoxyGen   | Source of the documentation                    |
| CMSIS/Utilities | Utility programs                               |

Reinhard Keil's avatar
Reinhard Keil committed
52
53
## Generate CMSIS Pack for Release

Christopher Seidl's avatar
Christopher Seidl committed
54
This GitHub development repository contains already pre-built libraries of various software components (DSP, RTOS, RTOS2).
Reinhard Keil's avatar
Reinhard Keil committed
55
56
57
These libraries are validated for release.

To build a complete CMSIS pack for installation the following additional tools are required:
Reinhard Keil's avatar
Reinhard Keil committed
58
 - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
Reinhard Keil's avatar
Reinhard Keil committed
59
60
61
62
63
64
65
66
67
 - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
 - **7z.exe (7-Zip)** Version: 16.02 (File Archiver)
  
Using these tools, you can generate on a Windows PC:
 - **CMSIS Software Pack** using the batch file **gen_pack.bat** (located in ./CMSIS/Utilities). This batch file also generates the documentation.
  
 - **CMSIS Documentation** using the batch file **genDoc.bat** (located in ./CMSIS/Doxygen). 

The file ./CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API documentation.
68
69
70
71
72
73
74
75

## License

ARM CMSIS is licensed under Apache-2.0.

## Contributions and Pull Requests

Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.
76

77
### Issues and Labels
78
79

Please feel free to raise an [issue on GitHub](https://github.com/ARM-software/CMSIS_5/issues)
Christopher Seidl's avatar
Christopher Seidl committed
80
81
to report misbehavior (i.e. bugs) or start discussions about enhancements. This
is your best way to interact directly with the maintenance team and the community.
82
We encourage you to append implementation suggestions as this helps to decrease the
Christopher Seidl's avatar
Christopher Seidl committed
83
workload of the very limited maintenance team. 
84
85
86
87
88
89
90

We will be monitoring and responding to issues as best we can.
Please attempt to avoid filing duplicates of open or closed items when possible.
In the spirit of openness we will be tagging issues with the following:

- **bug** – We consider this issue to be a bug that will be investigated.

Christopher Seidl's avatar
Christopher Seidl committed
91
- **wontfix** - We appreciate this issue but decided not to change the current behavior.
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
	
- **enhancement** – Denotes something that will be implemented soon. 

- **future** - Denotes something not yet schedule for implementation.

- **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work.
	
- **question** – We have further questions to this issue. Please review and provide feedback.

- **documentation** - This issue is a documentation flaw that will be improved in future.

- **review** - This issue is under review. Please be patient.
	
- **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.

- **duplicate** - This issue is already addressed elsewhere, see comment with provided references.

- **Important Information** - We provide essential informations regarding planned or resolved major enhancements.