begriffs open source - cmsis/blob - README.md

   1 # CMSIS Version 5
   2
   3 CMSIS Version 5.0.0 is scheduled for release in June 2016. Once completed it will be release in this GitHub project.
   4
   5 This repository gives our users and partners contiguous access to the CMSIS development.
   6 It allows you to review the work and provide feedback.
   7
   8 Please use GitHub to discuss and track issues or create pull requests for contributions.
   9
  10
  11 ## Planned Enhancements
  12  - Add support for ARMv8-M Architecture (Mainline and Baseline)
  13
  14  - Improvements for Cortex-A / M hybrid devices (focus on Cortex-M interaction)
  15
  16  - CMSIS-RTOS API and RTX reference implementation with several enhancements:
  17      - Dynamic object creation, Flag events, C and C++ API, additional thread and timer functions
  18      - Secure and Non-Secure support, multi-processor support
  19
  20  - CMSIS-Pack
  21      - Additions for generic example, project templates, multiple download portals
  22      - Adoption of IAR Flash Loader technology
  23
  24 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).
  25
  26 ## Directory Structure
  27
  28 *All CMSIS components will be available by end of March 2016*
  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 related files (template + include)        |
  37 | CMSIS/DoxyGen   | Source of the documentation                    |
  38 | CMSIS/Utilities | Utility programs                               |
  39
  40 ## Generate Documentation
  41
  42 The following tools are required to generate the documentation:
  43  - **doxygen.exe**  Version: 1.8.2 (Documentation Generator)
  44  - **mscgen.exe**   Version: 0.20  (Message Sequence Chart Converter)
  45
  46 Using these tools, documentation can be generated under Windows
  47 with the batch file **genDoc.bat** in directory CMSIS/DoxyGen/.
  48
  49 The file CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API
  50 documentation.
  51
  52 ## Generate CMSIS Software Pack
  53
  54 *coming soon*
  55
  56 ## License
  57
  58 ARM CMSIS is licensed under Apache-2.0.
  59
  60 ## Contributions and Pull Requests
  61
  62 Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.