begriffs open source - cmsis/blob - README.md

   1 # CMSIS Version 5
   2
   3 CMSIS Version 5.0.1 release is now available.  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
   4
   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.
   6
   7 This GitHub repository development branch reflects our current state of development and is constantly updated.
   8 A [pre-built documentation](http://www.keil.com/pack/doc/CMSIS_Dev/index.html) is updated from time to time, but may be generated also using the instructions published under [Generate CMSIS Pack for Release](https://github.com/ARM-software/CMSIS_5#generate-cmsis-pack-for-release).
   9
  10 Use [Issues]https://github.com/ARM-software/CMSIS_5#issues-and-labels to provide feedback and report problems for CMSIS Version 5.
  11
  12 ## What's Hot
  13  - CMSIS-RTOS2: RTX 5 is now available for IAR, GCC, ARM Compiler 5, ARM Compiler 6
  14  - CMSIS-RTOS2: FreeRTOS adoption (release) is available https://github.com/ARM-software/CMSIS-FreeRTOS
  15  - CMSIS-Core: compiler agonstic features extended to simplify transition on LLVM based front-end
  16  - CMSIS-Core-A: preview of the CMSIS-Core for Cortex-A
  17  - Coming soon: CMSIS-RTOS2 for Cortex-A
  18
  19 ## Implemented Enhancements
  20  - Support for ARMv8-M Architecture (Mainline and Baseline) as well as devices Cortex-M23 and Cortex-M33
  21
  22  - CMSIS-RTOS Version 2 API and RTX reference implementation with several enhancements:
  23      - Dynamic object creation, Flag events, C API, additional thread and timer functions
  24
  25  - CMSIS-RTOS API Secure and Non-Secure support, multi-processor support
  26
  27 ## Futher Planned Enhancements
  28  - Improvements for Cortex-A / M hybrid devices (focus on Cortex-M interaction)
  29
  30  - CMSIS-Pack
  31      - Additions for generic example, project templates, multiple download portals
  32      - Adoption of IAR Flash Loader technology
  33
  34 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).
  35
  36 ## Directory Structure
  37
  38 | Directory       | Content                                        |
  39 | --------------- | ---------------------------------------------- |
  40 | CMSIS/Core      | CMSIS-Core related files (for release)         |
  41 | CMSIS/DAP       | CMSIS-DAP related files and examples           |
  42 | CMSIS/Driver    | CMSIS-Driver API headers and template files    |
  43 | CMSIS/DSP       | CMSIS-DSP related files                        |
  44 | CMSIS/RTOS      | RTOS v1 related files (for Cortex-M)           |
  45 | CMSIS/RTOS2     | RTOS v2 related files (for Cortex-M & ARMv8-M) |
  46 | CMSIS/Pack      | CMSIS-Pack examples and tutorials              |
  47 | CMSIS/DoxyGen   | Source of the documentation                    |
  48 | CMSIS/Utilities | Utility programs                               |
  49
  50 ## Generate CMSIS Pack for Release
  51
  52 This GitHub development repository contains already pre-build libraries of various libraries (DSP, RTOS, RTOS2).
  53 These libraries are validated for release.
  54
  55 To build a complete CMSIS pack for installation the following additional tools are required:
  56  - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
  57  - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
  58  - **7z.exe (7-Zip)** Version: 16.02 (File Archiver)
  59
  60 Using these tools, you can generate on a Windows PC:
  61  - **CMSIS Software Pack** using the batch file **gen_pack.bat** (located in ./CMSIS/Utilities). This batch file also generates the documentation.
  62
  63  - **CMSIS Documentation** using the batch file **genDoc.bat** (located in ./CMSIS/Doxygen).
  64
  65 The file ./CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API documentation.
  66
  67 ## License
  68
  69 ARM CMSIS is licensed under Apache-2.0.
  70
  71 ## Contributions and Pull Requests
  72
  73 Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.
  74
  75 ###Issues and Labels
  76
  77 Please feel free to raise an [issue on GitHub](https://github.com/ARM-software/CMSIS_5/issues)
  78 to report misbehaviour (i.e. bugs) or start discussions about enhancements. This
  79 is your best way to interact directly with the maintainance team and the community.
  80 We encourage you to append implementation suggestions as this helps to decrease the
  81 workload of the very limited maintainance team.
  82
  83 We will be monitoring and responding to issues as best we can.
  84 Please attempt to avoid filing duplicates of open or closed items when possible.
  85 In the spirit of openness we will be tagging issues with the following:
  86
  87 - **bug** – We consider this issue to be a bug that will be investigated.
  88
  89 - **wontfix** - We appriciate this issue but decided not to change the current behaviour.
  90
  91 - **enhancement** – Denotes something that will be implemented soon.
  92
  93 - **future** - Denotes something not yet schedule for implementation.
  94
  95 - **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work.
  96
  97 - **question** – We have further questions to this issue. Please review and provide feedback.
  98
  99 - **documentation** - This issue is a documentation flaw that will be improved in future.
 100
 101 - **review** - This issue is under review. Please be patient.
 102
 103 - **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.
 104
 105 - **duplicate** - This issue is already addressed elsewhere, see comment with provided references.
 106
 107 - **Important Information** - We provide essential informations regarding planned or resolved major enhancements.
 108