From e5f3e42b3ccbb7fed91f552fece370a3afe020bd Mon Sep 17 00:00:00 2001 From: Allan Stephens Date: Mon, 31 Aug 2015 13:14:44 -0400 Subject: [PATCH] doc: Minor supplements to microkernel task services Adds in a couple of pieces of useful information which improve alignment between task documentation and fiber documentation. Change-Id: I04b65aa6d125842205de3dd6a65dbe2b8e6853d6 Signed-off-by: Allan Stephens --- doc/kernel/microkernel/microkernel_tasks.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/kernel/microkernel/microkernel_tasks.rst b/doc/kernel/microkernel/microkernel_tasks.rst index fb524cb554a..ad3aa86d569 100644 --- a/doc/kernel/microkernel/microkernel_tasks.rst +++ b/doc/kernel/microkernel/microkernel_tasks.rst @@ -11,14 +11,18 @@ an application's processing. It is is normally used to perform processing that is too lengthy or complex to be performed by a fiber or an ISR. A microkernel application can define any number of application tasks. Each -task has a name that uniquely identifies it. Other important task properties -that must be specified include: +task has a name that uniquely identifies it, allowing it to be directly +referenced by other tasks. Other properties that must be specified when a task +is defined include: * a memory region that is used for its stack and for other execution context information, * a function that is invoked when the task starts executing, and * a priority that is used by the microkernel scheduler. +A task's entry point function takes no arguments, so there is no need to +define any argument values for it. + The microkernel automatically defines a system task, known as the *idle task*, which has lowest priority. This task is used during system initialization, and subsequently executes only when there is no other work for the system to do. @@ -128,7 +132,8 @@ by the microkernel until one of the following occurs: * The task terminates itself by returning from its entry point function. -* The task aborts itself by performing an operation that causes a fatal error. +* The task aborts itself by performing an operation that causes a fatal error, + or by calling :c:func:`task_abort()`. Time Slicing ------------