begriffs open source - cmsis/blob - README.md

   1 # CMSIS Version 5
   2
   3 The branch *master* of this GitHub repository contains the CMSIS Version 5.3.0.  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
   4
   5 Use [Issues](https://github.com/ARM-software/CMSIS_5#issues-and-labels) to provide feedback and report problems for CMSIS Version 5.
   6
   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.
   8
   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).
  10
  11 ## Implemented Enhancements
  12  - CMSIS-Core-A, RTX5: implementation for Cortex-A5/A7/A9
  13  - Support for Armv8-M Architecture (Mainline and Baseline) as well as devices Cortex-M23 and Cortex-M33
  14  - CMSIS-RTOS2: RTX 5 is now available for IAR, GCC, Arm Compiler 5, Arm Compiler 6
  15  - CMSIS-RTOS2: FreeRTOS adoption (release) is available https://github.com/ARM-software/CMSIS-FreeRTOS
  16  - CMSIS-NN: Bare metal Neural Network function library.
  17  - CMSIS-DAP v2: with WinUSB for faster communication and separate pipe for SWO support
  18  - Config Wizard extension: access enum’s for configuration information
  19
  20 ## Further Planned Enhancements
  21  - CMSIS-Zone: management of complex system
  22  - CMSIS-Pack:
  23    - System Description SDF Format: describe more complex debug topologies than with a Debug Description in a tool agnostic way
  24    - Github based workflow: allows to develop software packs using github infra-structure
  25    - Flash algorithm via debugger: Some TurstZone enable devices cannot execute RAM. Commands that allow flash programming will be added to Debug Description.
  26    - CPDSC project file format: allows project templates that are agnostic of an IDE
  27    - Minimize need for IDE specific settings: CMSIS-Pack supports IDE specific parameters. Analyze and minimize
  28
  29 For further details see also the [Slides of the Embedded World CMSIS Partner Meeting](https://github.com/ARM-software/CMSIS_5/blob/develop/CMSIS_EW2018.pdf).
  30
  31 ## Directory Structure
  32
  33 | Directory       | Content                                        |
  34 | --------------- | ---------------------------------------------- |
  35 | CMSIS/Core      | CMSIS-Core related files (for release)         |
  36 | CMSIS/DAP       | CMSIS-DAP related files and examples           |
  37 | CMSIS/Driver    | CMSIS-Driver API headers and template files    |
  38 | CMSIS/DSP       | CMSIS-DSP related files                        |
  39 | CMSIS/NN        | CMSIS-NN related files                         |
  40 | CMSIS/RTOS      | RTOS v1 related files (for Cortex-M)           |
  41 | CMSIS/RTOS2     | RTOS v2 related files (for Cortex-M & Armv8-M) |
  42 | CMSIS/Pack      | CMSIS-Pack examples and tutorials              |
  43 | CMSIS/DoxyGen   | Source of the documentation                    |
  44 | CMSIS/Utilities | Utility programs                               |
  45
  46 ## Generate CMSIS Pack for Release
  47
  48 This GitHub development repository contains already pre-built libraries of various software components (DSP, RTOS, RTOS2).
  49 These libraries are validated for release.
  50
  51 To build a complete CMSIS pack for installation the following additional tools are required:
  52  - **doxygen.exe**    Version: 1.8.6 (Documentation Generator)
  53  - **mscgen.exe**     Version: 0.20  (Message Sequence Chart Converter)
  54  - **7z.exe (7-Zip)** Version: 16.02 (File Archiver)
  55
  56 Using these tools, you can generate on a Windows PC:
  57  - **CMSIS Software Pack** using the batch file **gen_pack.bat** (located in ./CMSIS/Utilities). This batch file also generates the documentation.
  58
  59  - **CMSIS Documentation** using the batch file **genDoc.bat** (located in ./CMSIS/Doxygen).
  60
  61 The file ./CMSIS/DoxyGen/How2Doc.txt describes the rules for creating API documentation.
  62
  63 ## License
  64
  65 Arm CMSIS is licensed under Apache-2.0.
  66
  67 ## Contributions and Pull Requests
  68
  69 Contributions are accepted under Apache-2.0. Only submit contributions where you have authored all of the code.
  70
  71 ### Issues and Labels
  72
  73 Please feel free to raise an [issue on GitHub](https://github.com/ARM-software/CMSIS_5/issues)
  74 to report misbehavior (i.e. bugs) or start discussions about enhancements. This
  75 is your best way to interact directly with the maintenance team and the community.
  76 We encourage you to append implementation suggestions as this helps to decrease the
  77 workload of the very limited maintenance team.
  78
  79 We will be monitoring and responding to issues as best we can.
  80 Please attempt to avoid filing duplicates of open or closed items when possible.
  81 In the spirit of openness we will be tagging issues with the following:
  82
  83 - **bug** – We consider this issue to be a bug that will be investigated.
  84
  85 - **wontfix** - We appreciate this issue but decided not to change the current behavior.
  86
  87 - **enhancement** – Denotes something that will be implemented soon.
  88
  89 - **future** - Denotes something not yet schedule for implementation.
  90
  91 - **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work.
  92
  93 - **question** – We have further questions to this issue. Please review and provide feedback.
  94
  95 - **documentation** - This issue is a documentation flaw that will be improved in future.
  96
  97 - **review** - This issue is under review. Please be patient.
  98
  99 - **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.
 100
 101 - **duplicate** - This issue is already addressed elsewhere, see comment with provided references.
 102
 103 - **Important Information** - We provide essential informations regarding planned or resolved major enhancements.
 104