Skip to content

Update Rtos.md - DO NOT MERGE (before mbed-os 5.7 release) #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 27, 2018
Merged

Update Rtos.md - DO NOT MERGE (before mbed-os 5.7 release) #340

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
94ddf60
Update Rtos.md - DO NOT MERGE (before mbed-os 5.7 release)
Nov 20, 2017
d827afd
Update rtos.md
Nov 21, 2017
99d3973
Closed review comments
Dec 4, 2017
d853226
Copy edit rtos.md
Dec 6, 2017
61809c8
Update config table as per master mbed_rtx_conf.h file
Jan 2, 2018
b52867b
Merge branch 'new_engine' into patch-1
Jan 2, 2018
b817f56
Merge branch 'new_engine' into patch-1
Jan 2, 2018
e827d13
Update rtos.md with suggested changes
Feb 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 3 additions & 46 deletions docs/reference/contributing/target/rtos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### RTOS

CMSIS/RTX code is imported from <a href="https://github.com/ARM-software/CMSIS_5/" target="_blank">the original CMSIS repository</a>.
CMSIS/RTX code is imported from <a href="https://github.com/ARM-software/CMSIS_5/" target="_blank">the original CMSIS repository</a> with the help of Python script in the `mbed-os` repository `mbed-os\tools\importer\importer.py`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

original should be 'upstream development'

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

further down there is generic system would should be 'platform operating system'


#### Memory considerations

Expand All @@ -25,51 +25,8 @@ Option | Value | Description |

#### Code structure

Due to differences in how the Mbed OS and CMSIS directory structures look, you can't import the original code directly. Some directory changes are necessary:

CMSIS5 | Mbed OS | Explanation |
-------|---------|-------------|
`CMSIS_5/CMSIS/Core/Include/core_*.h` | `mbed-os/cmsis/` | Core specific code |
`CMSIS_5/CMSIS/Core/Include/tz_context.h` | `mbed-os/cmsis/` | TrustZone code |
`CMSIS_5/CMSIS/Core/Include/cmsis_compiler.h` | `mbed-os/cmsis/` | Toolchain generic code |
`CMSIS_5/CMSIS/Core/Include/cmsis_{armcc,armclang,gcc}.h` | `mbed-os/cmsis/TOOLCHAIN_{ARM,GCC}/` | Toolchain specific code |
`CMSIS_5/CMSIS/RTOS2/Include/cmsis_os2.h` | `mbed-os/rtos/TARGET_CORTEX/rtx5/` | RTX main header |
`CMSIS_5/CMSIS/RTOS2/RTX/Config/` | `mbed-os/rtos/TARGET_CORTEX/rtx5` | RTX configuration files |
`CMSIS_5/CMSIS/RTOS2/RTX/Include1/` | `mbed-os/rtos/TARGET_CORTEX/rtx4` | RTOS1 compatibility layer |
`CMSIS_5/CMSIS/RTOS2/RTX/Include/` | `mbed-os/rtos/TARGET_CORTEX/rtx5` | RTX definitions |
`CMSIS_5/CMSIS/RTOS2/RTX/Source/rtx_*` | `mbed-os/rtos/TARGET_CORTEX/rtx5` | RTX sources |
`CMSIS_5/CMSIS/RTOS2/RTX/Source/svc_user.c` | `mbed-os/rtos/rtx2/TARGET_CORTEX_M/` | RTX SVC user table |
`CMSIS_5/CMSIS/RTOS2/RTX/Source/{ARM,GCC,IAR}/` | `mbed-os/rtos/TARGET_CORTEX/rtx5/TARGET_{M0,M0P,M3,RTOS_M4_M7,M23,M33}/TOOLCHAIN_{ARM,GCC,IAR}` | Toolchain and core specific exception handlers |
Due to differences in how the Mbed OS and CMSIS directory structures look, you can't import the original code directly using `importer.py` and configuration file `cmsis_importer.json`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence seems wrong, you cant import using a tool we created?


#### Modification

Due to different use cases between Mbed OS and CMSIS, we had to make some modifications to the source code. We've tried to upstream our changes to the CMSIS repository, but in cases where they aren't compatible with CMSIS requirements, we are forced to maintain a small set of changes.

##### CMSIS

Filename | Description |
---------|-------------|
`cmsis_compiler.h` | Added IAR missing __ALIGNED attribute for earlier (less than 7.8.4) versions |
`cmain.S` | custom IAR non-RTOS boot sequence for Mbed |

##### RTX

Filename | Description |
---------|-------------|
`cmsis_os2.h` | Doxygen added; added per-thread uVisor context |
`cmsis_os1.h` | Change `osThreadDef` to accept 3 parameters rather than 4 and be not static as expected by Mbed OS |
`core_cm.h` | Doxygen added; included headers changed to match Mbed OS core selection; deferred priority setting of SVCall to uVisor when uVisor is enabled |
`RTX_Config.h` | Doxygen added; Mbed OS RTX config included |
`rtx_evr.c` | CMSIS component definition include removed |
`rtx_evr.h` | Doxygen added |
`rtx_thread.c` | Added per-thread uVisor context; notify uVisor of OS events |
`rtx_kernel.c` | Added per-thread uVisor context; notify uVisor of OS events |
`rtx_lib.h` | Doxygen added; added per-thread uVisor context |
`rtx_os.h` | Doxygen added; added per-thread uVisor context |
`irq_cm4.s` | For all toolchains: added case for Cortex M4 cores without VFP |
`svc_user.c` | Removed as its template file and should not be in our code base |
`rt_OsEventObserver.{c,h}` | Added an interface for uVisor to be notified about certain events from privileged code |
`irq_armv8mbl.S` | IAR toolchain: added file for Cortex M23 core |
`irq_armv8mml.S` | IAR toolchain: added file for Cortex M33 core |

<span class="notes">**Note:** For all toolchains, Mbed OS uses `irq_cm0.s` for both M0 and M0P cores.</span>
Due to different use cases between Mbed OS and CMSIS, we modified the source code. We upstream our changes to the CMSIS repository, but in cases where they aren't compatible with CMSIS requirements, we maintain a small set of changes. We maintain changes as separate commits in `mbed-os`, and SHAs are in the `commit_sha` section of the `cmsis_importer.json` file.