Update to RTOS page and Kernel namespace documentation #606

SenRamakri · 2018-06-22T21:16:18Z

This PR contains following docs changes:

Added Kernel page
Updated RTOS page

SenRamakri · 2018-06-22T21:17:05Z

@AnotherButler - Can you please add you, @sg- , @kegilbert as reviewers for this PR?

AnotherButler · 2018-06-22T21:56:16Z

Please complete the JIRA task by doing the following:

Remove all references to CMSIS-RTOS both on this page and throughout this folder.
Remove all reference to RTX both on this page and throughout this folder.
Ensure the error codes on this page are included in the Doxygen, and then delete them here.
Include RTOS design patterns and use cases.
Include two Mbed OS shared queues.

SenRamakri · 2018-06-26T22:00:42Z

@AnotherButler - Mbed OS shared queue is captured in https://os.mbed.com/docs/v5.9/reference/eventqueue.html
I don't think the shared queue example belongs in top-level RTOS page.

Also, can you please clarify on what it means by "Include RTOS design patterns and use cases."

AnotherButler · 2018-06-27T00:47:52Z

What are some general best practices or typical code patterns developers use when using these APIs? At a high level, when do developers use RTOS APIs? When don't they?

SenRamakri · 2018-06-27T20:39:04Z

@AnotherButler - I think we can possibly include that, I got confused by design pattern as it can mean using these on some software design perspective.

SenRamakri · 2018-06-27T20:58:41Z

@AnotherButler - I looked into this more. As of now, the RTOS page does have section "RTOS APIs" which lists all the objects under RTOS layer. And each of those takes the user to specific page explaining that object. And for each of those objects we have APIs examples/code snippets as required. The one which was missing before was Kernel APIs and I have added them as well. Please review if its not what you are looking for.

AnotherButler · 2018-06-29T20:20:23Z

docs/reference/api/rtos/Kernel.md

+The Kernel namespace implements functions to read RTOS information. It implements one function to read the current RTOS kernel millisecond tick count.
+
+### Kernel namespace reference
+


Note: This link doesn't work for me. Is there a code dependency?

kegilbert

LGTM

sg- · 2018-07-12T08:18:16Z

docs/reference/api/rtos/rtos.md

@@ -1,14 +1,16 @@
 <h2 id="rtos-api">RTOS overview</h2>

-The Arm Mbed RTOS is a C++ wrapper over the Keil RTX code. For more information about Keil RTX, check [the Keil CMSIS-RTOS tutorial](https://github.com/ARM-software/CMSIS/raw/master/CMSIS/Documentation/RTX/CMSIS_RTOS_Tutorial.pdf) and [the element14 introduction to Keil RTX](https://www.element14.com/community/docs/DOC-46650/l/arm-keil-rtx-real-time-operating-system-overview). You can use these resources as a general introduction to RTOS principles; it is important to be familiar with the concepts behind an RTOS in order to understand this guide.
+Arm Mbed OS provides C++ APIs to manage RTOS objects such as thread, synchronization objects and timer. It also provides interfaces for attaching an application-specific idle hook function and to read the tick count from OS. The Arm Mbed RTOS layer also handles RTOS errors and reports them into the Mbed OS error handling system.


Arm Mbed OS provides C++ APIs to manage

is the same as saying The Arm Mbed RTOS is a C++ wrapper over the Keil RTX code just in a different way. How about something like along the lines of the mbed os rtos capabilities include things such as ...

sg- · 2018-07-12T08:38:16Z

docs/reference/api/rtos/rtos.md

@@ -23,6 +25,8 @@ The RTOS APIs handle creation and destruction of threads in Arm Mbed OS 5, as we
 - [RtosTimer](/docs/development/reference/rtostimer.html): A deprecated class used to control timer functions in the system.
 - [EventFlags](/docs/development/reference/eventflags.html): An event channel that provides a generic way of notifying other threads about conditions or events.
 - [Event](/docs/development/reference/event.html): The queue to store events, extract them and excute them later.
+- [ConditionVariable](/docs/development/reference/conditionvariable.html): The ConditionVariable class provides a mechanism to safely wait for or signal state changes.


this sounds similar to how event flag is defined. How is it different?

sg- · 2018-07-12T08:40:08Z

docs/reference/api/rtos/rtos.md

- `osErrorOS`: unspecified RTOS error - runtime error but no other error message fits.
+##### Status and Error codes
+
+The Arm Mbed RTOS layer handles RTOS errors and report them using the Mbed OS error handling system. Please see the list of error codes in the [error handling](/docs/development/reference/error-handling.html) documentation for more information on RTOS errors reported.


dont describe layers, The RTOS errors codes are documented as part of OS errors...

SenRamakri · 2018-07-18T17:49:45Z

@sg-, @kegilbert - Please review as I have updated with review comments.

kegilbert · 2018-07-23T15:54:30Z

docs/reference/api/rtos/rtos.md

@@ -1,14 +1,18 @@
 <h2 id="rtos-api">RTOS overview</h2>

-The Arm Mbed RTOS is a C++ wrapper over the Keil RTX code. For more information about Keil RTX, check [the Keil CMSIS-RTOS tutorial](https://github.com/ARM-software/CMSIS/raw/master/CMSIS/Documentation/RTX/CMSIS_RTOS_Tutorial.pdf) and [the element14 introduction to Keil RTX](https://www.element14.com/community/docs/DOC-46650/l/arm-keil-rtx-real-time-operating-system-overview). You can use these resources as a general introduction to RTOS principles; it is important to be familiar with the concepts behind an RTOS in order to understand this guide.
+Mbed-OS RTOS provide C++ APIs to manage objects like thread, synchronization objects and timer. It also provides interfaces for attaching application


Minor nit:
Change to "The Mbed OS RTOS provides C++ APIs to manage objects like threads, synchronization objects, and timers."

@kegilbert - Change done, please review.

Copy edit file for consistent style across documents.

Copy edit file for minor grammar nits, such as sentence case in headings and precise language.

AnotherButler · 2018-07-27T19:24:32Z

@sg- It looks like @SenRamakri has addressed your comments. We'll go ahead and merge unless you have further improvements.

Update phrasing as requested.

AnotherButler requested review from AnotherButler, sg- and kegilbert June 22, 2018 21:17

Update to RTOS page and Kernel namespace documentation

f1f5a27

SenRamakri force-pushed the sen_RtosAPIsPage branch from 1fa0830 to f1f5a27 Compare June 27, 2018 20:54

AnotherButler reviewed Jun 29, 2018

View reviewed changes

kegilbert approved these changes Jul 6, 2018

View reviewed changes

sg- suggested changes Jul 12, 2018

View reviewed changes

Fix ConditionVariable docs and otehr changes

a320614

SenRamakri force-pushed the sen_RtosAPIsPage branch from f2ccd94 to a320614 Compare July 13, 2018 22:49

kegilbert reviewed Jul 23, 2018

View reviewed changes

Review comment fixes to update the introduction

4ac6341

kegilbert approved these changes Jul 23, 2018

View reviewed changes

0xc0170 mentioned this pull request Jul 24, 2018

requirement : a good API for get system timestamp ARMmbed/mbed-os#7575

Closed

Amanda Butler added 2 commits July 27, 2018 14:18

Copy edit kernel.md

bce1701

Copy edit file for consistent style across documents.

Copy edit rtos.md

1acfdba

Copy edit file for minor grammar nits, such as sentence case in headings and precise language.

Fix phrasing in rtos.md

6072ae3

Update phrasing as requested.

AnotherButler merged commit 7e1a5b1 into ARMmbed:development Aug 1, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update to RTOS page and Kernel namespace documentation #606

Update to RTOS page and Kernel namespace documentation #606

Uh oh!

SenRamakri commented Jun 22, 2018

Uh oh!

SenRamakri commented Jun 22, 2018

Uh oh!

AnotherButler commented Jun 22, 2018

Uh oh!

SenRamakri commented Jun 26, 2018

Uh oh!

AnotherButler commented Jun 27, 2018

Uh oh!

SenRamakri commented Jun 27, 2018

Uh oh!

SenRamakri commented Jun 27, 2018

Uh oh!

AnotherButler Jun 29, 2018

Uh oh!

kegilbert left a comment

Uh oh!

sg- Jul 12, 2018

Uh oh!

sg- Jul 12, 2018

Uh oh!

sg- Jul 12, 2018

Uh oh!

SenRamakri commented Jul 18, 2018

Uh oh!

kegilbert Jul 23, 2018

Uh oh!

SenRamakri Jul 23, 2018

Uh oh!

AnotherButler commented Jul 27, 2018

Uh oh!

Uh oh!

		The Kernel namespace implements functions to read RTOS information. It implements one function to read the current RTOS kernel millisecond tick count.

		### Kernel namespace reference

Update to RTOS page and Kernel namespace documentation #606

Update to RTOS page and Kernel namespace documentation #606

Uh oh!

Conversation

SenRamakri commented Jun 22, 2018

Uh oh!

SenRamakri commented Jun 22, 2018

Uh oh!

AnotherButler commented Jun 22, 2018

Uh oh!

SenRamakri commented Jun 26, 2018

Uh oh!

AnotherButler commented Jun 27, 2018

Uh oh!

SenRamakri commented Jun 27, 2018

Uh oh!

SenRamakri commented Jun 27, 2018

Uh oh!

AnotherButler Jun 29, 2018

Choose a reason for hiding this comment

Uh oh!

kegilbert left a comment

Choose a reason for hiding this comment

Uh oh!

sg- Jul 12, 2018

Choose a reason for hiding this comment

Uh oh!

sg- Jul 12, 2018

Choose a reason for hiding this comment

Uh oh!

sg- Jul 12, 2018

Choose a reason for hiding this comment

Uh oh!

SenRamakri commented Jul 18, 2018

Uh oh!

kegilbert Jul 23, 2018

Choose a reason for hiding this comment

Uh oh!

SenRamakri Jul 23, 2018

Choose a reason for hiding this comment

Uh oh!

AnotherButler commented Jul 27, 2018

Uh oh!

Uh oh!