michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Clarify requirements for referencing microkernel objects

Browse source 
Revises microkernel object sections to make it clear that objects
are referenced by name. (e.g. MY_TASK) Also adds text to make it
clear that task groups are named entities.

Change-Id: I3480f3526293dae7a0bab2006250c97334e04dfb
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens 2015-09-01 12:39:22 -04:00 • committed by Anas Nashif
commit 945ed24597
9 changed files with 25 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/kernel/microkernel/microkernel_events.rst
View file

@ -104,7 +104,7 @@ as follows:
EVENT KEYPRESS validate_keypress
EVENT BUTTONPRESS NULL
A public event can be referenced from any source file that includes
A public event can be referenced by name from any source file that includes
the file :file:`zephyr.h`.
.. note::

2
doc/kernel/microkernel/microkernel_fifos.rst
View file

@ -98,7 +98,7 @@ that holds up to 10 items that are each 12 bytes long as follows:
% =============================
FIFO SIGNAL_FIFO 10 12
A public FIFO can be referenced from any source file that includes
A public FIFO can be referenced by name from any source file that includes
the file :file:`zephyr.h`.

4
doc/kernel/microkernel/microkernel_mailboxes.rst
View file

@ -57,8 +57,8 @@ For example, the file :file:`projName.mdef` defines a mailbox as follows:
% ==========================
MAILBOX REQUEST_BOX
A public mailbox can be referenced from any source file that includes
the file :file:`zephyr.h`.
A public mailbox can be referenced by name from any source file that
includes the file :file:`zephyr.h`.
Private Mailbox

4
doc/kernel/microkernel/microkernel_memory_maps.rst
View file

@ -79,8 +79,8 @@ as follows:
MAP MYMAP 4 1024
MAP YOURMAP 6 200
A public memory map can be referenced from any source file that includes
the file :file:`zephyr.h`.
A public memory map can be referenced by name from any source file that
includes the file :file:`zephyr.h`.
Private Memory Map

4
doc/kernel/microkernel/microkernel_memory_pools.rst
View file

@ -111,8 +111,8 @@ as follows:
POOL MY_POOL 32 8192 1
POOL SECOND_POOL_ID 64 1024 5
A public memory pool can be referenced from any source file that includes
the file :file:`zephyr.h`.
A public memory pool can be referenced by name from any source file that
includes the file :file:`zephyr.h`.
.. note::
Private memory pools are not supported by the Zephyr kernel.

2
doc/kernel/microkernel/microkernel_mutexes.rst
View file

@ -103,7 +103,7 @@ For example, the file :file:`projName.mdef` defines a single mutex as follows:
% ===============
MUTEX DEVICE_X
A public mutex can be referenced from any source file that includes
A public mutex can be referenced by name from any source file that includes
the file :file:`zephyr.h`.

2
doc/kernel/microkernel/microkernel_pipes.rst
View file

@ -71,7 +71,7 @@ buffer as follows:
% ===============================
PIPE DATA_PIPE 1024
A public pipe can be referenced from any source file that includes
A public pipe can be referenced by name from any source file that includes
the file :file:`zephyr.h`.

4
doc/kernel/microkernel/microkernel_semaphores.rst
View file

@ -103,8 +103,8 @@ For example, the file :file:`projName.mdef` defines two semaphores as follows:
SEMA INPUT_DATA
SEMA WORK_DONE
A public semaphore can be referenced from any source file that includes
the file :file:`zephyr.h`.
A public semaphore can be referenced by name from any source file that
includes the file :file:`zephyr.h`.
Private Semaphore

22
doc/kernel/microkernel/microkernel_tasks.rst
View file

@ -196,13 +196,17 @@ manipulated as a single unit, rather than individually. This simplifies
the work required to start related tasks, to suspend and resume them, or
to abort them.
A task can be defined so that it initially belongs to a single task group,
multiple task groups, or no task group. A task's group memberships can
also be changed dynamically while the application is running.
The kernel supports a maximum of 32 distinct task groups. Each task group
has a name that uniquely identifies it, allowing it to be directly referenced
by tasks.
The kernel supports a maximum of 32 distinct task groups. The task groups
listed below are pre-defined by the kernel; additional task groups can
be defined by the application.
The task groups a task belong to are specified when the task is defined.
A task may belong to a single task group, to multiple task groups, or to
no task group. A task's group memberships can also be changed dynamically
while the application is running.
The task groups listed below are pre-defined by the kernel; additional
task groups can be defined by the application.
:c:macro:`EXE`
The set of tasks which are started automatically by the kernel
@ -283,7 +287,7 @@ of six tasks as follows:
TASK SPEAKER1_TASK 10 speaker_1_main 1024 [AUDIO_TASKS]
TASK SPEAKER2_TASK 10 speaker_2_main 1024 [AUDIO_TASKS]
A public task can be referenced from any source file that includes
A public task can be referenced by name from any source file that includes
the file :file:`zephyr.h`.
@ -343,8 +347,8 @@ as follows:
TASKGROUP AUDIO_TASKS
TASKGROUP KEYPAD_TASKS
A public task group can be referenced from any source file that includes
the file :file:`zephyr.h`.
A public task group can be referenced by name from any source file that
includes the file :file:`zephyr.h`.
.. note::
Private task groups are not supported by the Zephyr kernel.