begriffs open source - cmsis/blob - README.md

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