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

deepikabhavnani · 2017-11-20T19:06:32Z

Removed all RTX mention and added reference to importer script

deepikabhavnani · 2017-11-20T19:09:46Z

@sg- RTX references are removed. As per jira: There is lots of good content for api/rtos/rtos (not relevant to porting). Please list what else should be covered in rtos.md page.

Make minor copy edits for active voice, brevity and tone.

AnotherButler · 2017-11-29T17:20:41Z

@deepikabhavnani We recently updated this, so the 5.6 branch is the live 5.6 docs on the web, and this new_engine branch is the working branch that we will create 5.7 from. Is it OK if I remove the "code dependency" label and merge this after @sg- reviews it?

deepikabhavnani · 2017-11-29T18:28:28Z

Yes @AnotherButler we can merge it after review.

sg-

Lots of comments and the table of config values doesnt even seem right, at least I hope its still not right.

sg- · 2017-12-04T17:46:48Z

docs/reference/contributing/target/rtos.md

@@ -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`.


original should be 'upstream development'

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

sg- · 2017-12-04T17:49:49Z

docs/reference/contributing/target/rtos.md

-`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`. 


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

Copy edit, mostly for active voice and inclusion of articles.

bulislaw · 2018-02-09T21:48:07Z

@deepikabhavnani I think that got forgotten.

deepikabhavnani · 2018-02-12T15:29:24Z

@bulislaw - Changes are done, waiting for @sg- to review and approve. ~~Adding you as reviewer~~ I cannot add reviewer. @AnotherButler Please added @bulislaw as reviewer.

bulislaw · 2018-02-14T15:56:21Z

docs/reference/contributing/target/rtos.md


 #### Memory considerations

-Please note that Arm Mbed OS doesn't use any of the RTX memory models, which are based on static carveouts (memory pools). This approach is not ideal for generic systems, such as Mbed OS, because calculating required numbers of RTOS objects is impossible. To avoid declaring arbitrary large buffers carved out at compile time, limiting the amount of available memory, Mbed OS shifts the responsibility of supplying the backing memory to CMSIS-RTOS2 users.
+Please note that Arm Mbed OS doesn't use any of the RTX memory models, which are based on static carveouts (memory pools). This approach is not ideal for platform operating systems, such as Mbed OS, because calculating required numbers of RTOS objects is impossible. To avoid declaring arbitrary large buffers carved out at compile time, limiting the amount of available memory, Mbed OS shifts the responsibility of supplying the backing memory to CMSIS-RTOS2 users.


I'm not sure what the platform operating systems are to be fair.

@bulislaw - That change was review comment by @sg- https://github.com/ARMmbed/Handbook/pull/340/files/d827afd63fab6edc4021eec3ddce567217a229d6#diff-d3a387b212d57c83382162e66ce314a0R3

Fair enough.

bulislaw · 2018-02-14T15:58:25Z

docs/reference/contributing/target/rtos.md

 `OS_TIMER_THREAD_STACK_SIZE` | 768B | Timer thread stack set to 768B that's necessary to support the C++ wrappers (4 instances), but it may require changing to support larger number of active timers. |
 `OS_IDLE_THREAD_STACK_SIZE` | 512B | Required to handle Mbed OS wrappers |
 `OS_DYNAMIC_MEM_SIZE` | 0 | RTX dynamic memory is disabled. |
-`OS_MUTEX_OBJ_MEM` | 1 or 0 | For ARMC, use 1; for other toolchains, it's 0. ARMC uses statically allocated mutexes internally. |
-`OS_MUTEX_NUM` | 6 or 0 | For ARMC, use 6; for other toolchains, it's 0. ARMC uses statically allocated mutexes internally. |
+`OS_TICK_FREQ` | 1000 | OS Tickrate must be 1000 for system timing. |


Can we change that note to something like: Mbed OS requires 1ms system tick?

bulislaw · 2018-02-14T15:59:02Z

docs/reference/contributing/target/rtos.md

-`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 the Mbed OS and CMSIS directory structure, you can't import the original code directly. You should use the `importer.py` and configuration file `cmsis_importer.json` to import upstream CMSIS code.


I think right now it's mostly down to build system.

bulislaw · 2018-02-14T16:04:01Z

docs/reference/contributing/target/rtos.md

-`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 when 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.


Due to different use cases between Mbed OS and CMSIS, we modified the source code

that's a bit vogue, which source code?

We upstream our changes to the CMSIS repository, but in cases when 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.

That is a bit confusing. @AnotherButler what do you think?

@bulislaw What part do you think is confusing?

Maybe confusing isn't the best word for that, but we repeat ourselves and it makes it feel like we talk about something else (?) we maintain a small set of changes. We maintain changes if I'm saying gibberish please ignore :)

Update content with suggested changes from engineering.

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

94ddf60

Removed all RTX mention and added reference to importer script

AnotherButler added code dependency wait to merge labels Nov 21, 2017

Update rtos.md

d827afd

Make minor copy edits for active voice, brevity and tone.

AnotherButler requested a review from sg- November 21, 2017 17:02

AnotherButler approved these changes Nov 27, 2017

View reviewed changes

AnotherButler removed code dependency wait to merge labels Nov 30, 2017

sg- suggested changes Dec 4, 2017

View reviewed changes

Deepika and others added 5 commits December 4, 2017 12:19

Closed review comments

99d3973

Copy edit rtos.md

d853226

Copy edit, mostly for active voice and inclusion of articles.

Update config table as per master mbed_rtx_conf.h file

61809c8

Merge branch 'new_engine' into patch-1

b52867b

Merge branch 'new_engine' into patch-1

b817f56

AnotherButler requested a review from bulislaw February 13, 2018 15:26

bulislaw reviewed Feb 14, 2018

View reviewed changes

sg- approved these changes Feb 19, 2018

View reviewed changes

Update rtos.md with suggested changes

e827d13

Update content with suggested changes from engineering.

AnotherButler merged commit d270c6a into ARMmbed:new_engine Feb 27, 2018

deepikabhavnani deleted the patch-1 branch February 27, 2018 15:47

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

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

Uh oh!

Conversation

deepikabhavnani commented Nov 20, 2017

Uh oh!

deepikabhavnani commented Nov 20, 2017

Uh oh!

AnotherButler commented Nov 29, 2017

Uh oh!

deepikabhavnani commented Nov 29, 2017

Uh oh!

sg- left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bulislaw commented Feb 9, 2018

Uh oh!

deepikabhavnani commented Feb 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

deepikabhavnani commented Feb 12, 2018 •

edited

Loading