Skip to content

Commit 00a8d67

Browse files
author
Jan Kamidra
committed
Readme update
1 parent ab2299f commit 00a8d67

File tree

1 file changed

+37
-27
lines changed

1 file changed

+37
-27
lines changed

‎cmsis/README.md‎

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,53 @@
11

2-
# CMSIS Version 5
2+
# CMSIS Version 6
33

4-
This directory contains a ported version of the upstream repository for [CMSIS_5](http://arm-software.github.io/CMSIS_5/General/html/index.html) as well as Mbed specific RTX configuration and RTOS boot source files.
4+
This directory contains
5+
- submodule [CMSIS 6.2.0](https://arm-software.github.io/CMSIS_6/v6.2.0/General/index.html)
6+
- submodule [CMSIS RTX 5.9](https://arm-software.github.io/CMSIS-RTX/v5.9.0/index.html)
7+
- Mbed specific configuration and boot source files for RTOS.
58

6-
The upstream source code is imported using the Python script located at [`tools/importer/importer.py`](../tools/importer/importer.py) when passed the [`tools/importer/cmsis_importer.json`](../tools/importer/cmsis_importer.json) configuration file.
7-
For more information on the importer script please read [`tools/importer/README.md`](../tools/importer/README.md).
9+
None: All submodules are without any intervention for future update
810

911
The directory is organised as follows:
1012

1113
```
12-
+--cmsis
13-
| +-- README.md # The present mardown file
14+
+-- cmsis
15+
| +-- README.md # The present mardown file
1416
| +-- device/
15-
| +-- mbed_cmsis_conf.h # Process stack configuration
17+
| +-- mbed_cmsis_conf.h # Process stack configuration
1618
| +-- RTE/
1719
| +-- include/
18-
| +-- RTE_Components.h # Run-Time-Environment Component Configuration File
20+
| +-- RTE_Components.h # Run-Time-Environment Component Configuration File
1921
| +-- rtos/
20-
| +-- mbed_lib.json # Mbed library configuration file
22+
| +-- mbed_lib.json # Mbed library configuration file
2123
| +-- include/
22-
| +-- mbed_boot.h # Declares the functions that run before main()
23-
| +-- mbed_rtx_conf.h # Changes to RTX configuration
24-
| +-- mbed_rtx_storage.h # Declares the primitives storage types for RTX
24+
| +-- mbed_boot.h # Declares the functions that run before main()
25+
| +-- cmsis_os.h # Declares old cmsis_os header
26+
| +-- RTX/
27+
| +-- mbed_rtx_conf.h # Changes to RTX configuration
28+
| +-- mbed_rtx_storage.h # Declares the primitives storage types for RTX
29+
| +-- RTX_Config.h # RTX configuration file for CMSIS-RTX
2530
| +-- source/
26-
| +-- mbed_boot.c # Implements some of the functions that run before main()
27-
| +-- mbed_rtos_rtx.c # Implements some of the functions that run before main()
28-
| +-- mbed_rtx_handlers.c # Implements RTX handlers
29-
| +-- mbed_rtx_idle.cpp # Implements RTX idle loop
30-
| +-- TOOLCHAIN_ARM_MICRO/
31-
| +-- mbed_boot_arm_micro.c # Mbed entry point for the uARM toolchain
32-
| +-- TOOLCHAIN_ARM_STD/
33-
| +-- mbed_boot_arm_std.c # Mbed entry point for the ARM toolchain
31+
| +-- cmsis_os1.c # Implements old cmsis_os functions
32+
| +-- mbed_boot.c # Implements some of the functions that run before main()
33+
| +-- mbed_tz_context.c # Implements of cmsis-core tz context functions
34+
| +-- RTX/
35+
| +-- mbed_rtos_rtx.c # Implements some of the functions that run before main()
36+
| +-- mbed_rtx_handlers.c # Implements RTX handlers
37+
| +-- mbed_rtx_idle.cpp # Implements RTX idle loop
3438
| +-- TOOLCHAIN_GCC_ARM/
35-
| +-- mbed_boot_gcc_arm.c # Mbed entry point for the GCC_ARM toolchain
36-
| +-- TOOLCHAIN_IAR/
37-
| +-- mbed_boot_iar.c # Mbed entry point for the IAR toolchain
38-
| +-- CMSIS_5/ # Imported from the upstream repository as described in the importer script configuration file (cmsis_importer.json)
39+
| +-- mbed_boot_gcc_arm.c # Mbed entry point for the GCC_ARM toolchain
40+
| +-- CMSIS_cmake/
41+
| +-- CMakeLists.txt
42+
| +-- cmsis_core.cmake # CMake script that includes CMSIS Core from CMSIS_6 submodule
43+
| +-- cmsis_rtos_api.cmake # CMake script that includes CMSIS RTOS2 API from CMSIS_6 submodule
44+
| +-- cmsis_rtos_backend.cmake # CMake script that select RTOS backend RTX (default), FreeRTOS (future)
45+
| +-- cmsis_rtos_rtx.cmake # CMake script that includes CMSIS-RTX submodule
46+
| +-- CMSIS_6/ # Imported from the upstream
47+
| +-- CMSIS-RTX/ # Imported from the upstream
3948
```
4049

41-
Two Mbed libraries live within this directory:
42-
* `rtos` from `device/rtos`
43-
* `cmsis-cmsis5-rtos2` from `CMSIS_5/CMSIS/RTOS2`
50+
Three Mbed libraries live within this directory:
51+
* `mbed-core-flags` that includes RTOS headers what are necessry for full and also bare-metal profiles
52+
* `mbed-rtos-flags` that includes RTOS header for full profile only
53+
* `mbed-rtos-sources` that brings all source files for full profile only

0 commit comments

Comments
 (0)