begriffs open source - cmsis/blob - README.md

   1 # CMSIS Version 5
   2
   3 CMSIS Version 5.0.0 release is now available.
   4
   5 This GitHub repository development branch reflects our current state of development and is constantly updated.
   6
   7 The [pre-built documentation](http://arm-software.github.io/CMSIS_5/General/html/index.html) for the 5.0.0 release
   8 is available under http://arm-software.github.io/CMSIS_5/General/html/index.html
   9
  10 Use *Issues* to provide feedback and report problems for CMSIS Version 5. Note that this repository 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.
  11
  12 ## Implemented Enhancements
  13  - Support for ARMv8-M Architecture (Mainline and Baseline) as well as devices Cortex-M23 and Cortex-M33
  14
  15  - CMSIS-RTOS Version 2 API and RTX reference implementation with several enhancements:
  16      - Dynamic object creation, Flag events, C API, additional thread and timer functions
  17
  18  - CMSIS-RTOS API Secure and Non-Secure support, multi-processor support
  19
  20 ## Futher Planned Enhancements
  21  - Improvements for Cortex-A / M hybrid devices (focus on Cortex-M interaction)
  22
  23  - CMSIS-Pack
  24      - Additions for generic example, project templates, multiple download portals
  25      - Adoption of IAR Flash Loader technology
  26
  27 For further details see also the [Slides of the Embedded World CMSIS Partner Meeting](https://github.com/ARM-software/CMSIS_5/blob/master/CMSIS_EW2016.pdf).
  28
  29 ## Directory Structure
  30
  31 | Directory       | Content                                        |
  32 | --------------- | ---------------------------------------------- |
  33 | CMSIS/Core      | CMSIS-Core related files (for release)         |
  34 | CMSIS/DAP       | CMSIS-DAP related files and examples           |
  35 | CMSIS/Driver    | CMSIS-Driver API headers and template files    |
  36 | CMSIS/DSP       | CMSIS-DSP related files                        |
  37 | CMSIS/RTOS      | RTOS v1 related files (for Cortex-M)           |
  38 | CMSIS/RTOS2     | RTOS v2 related files (for Cortex-M & ARMv8-M) |
  39 | CMSIS/Pack      | CMSIS-Pack examples and tutorials              |
  40 | CMSIS/DoxyGen   | Source of the documentation                    |
  41 | CMSIS/Utilities | Utility programs                               |
  42
  43 ## Generate CMSIS Pack for Release
  44
  45 This GitHub development repository contains already pre-build libraries of various libraries (DSP, RTOS, RTOS2).
  46 These libraries are validated for release.
  47
  48 To build a complete CMSIS pack for installation the following additional tools are required:
  49  - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
  50  - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
  51  - **7z.exe (7-Zip)** Version: 16.02 (File Archiver)
  52
  53 Using these tools, you can generate on a Windows PC:
  54  - **CMSIS Software Pack** using the batch file **gen_pack.bat** (located in ./CMSIS/Utilities). This batch file also generates the documentation.
  55
  56  - **CMSIS Documentation** using the batch file **genDoc.bat** (located in ./CMSIS/Doxygen).
  57
  58 The file ./CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API documentation.
  59
  60 ## License
  61
  62 ARM CMSIS is licensed under Apache-2.0.
  63
  64 ## Contributions and Pull Requests
  65
  66 Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.