doc: Edit redundant use of file
Removed the word "file" after all the MDEF to avoid redundancy Edited single line under overview folder in order to gramatically correct the use of "file". Change-Id: Ie785aa8c620f095fcd4171ef4efd2d056d6fa04b Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
575c1ba172
commit
30a04a2250
11 changed files with 19 additions and 18 deletions
|
@ -88,7 +88,7 @@ The following parameters must be defined:
|
||||||
Public Event
|
Public Event
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Define the event in the application's .MDEF file using the following syntax:
|
Define the event in the application's MDEF using the following syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -43,7 +43,7 @@ The following parameters must be defined:
|
||||||
Public Mailbox
|
Public Mailbox
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
Define the mailbox in the application's .MDEF file using the following syntax:
|
Define the mailbox in the application's MDEF using the following syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
@ -77,7 +77,7 @@ For example, the following code defines a private mailbox named ``PRIV_MBX``.
|
||||||
DEFINE_MAILBOX(PRIV_MBX);
|
DEFINE_MAILBOX(PRIV_MBX);
|
||||||
|
|
||||||
The mailbox ``PRIV_MBX`` can be used in the same style as those
|
The mailbox ``PRIV_MBX`` can be used in the same style as those
|
||||||
defined in MDEF file.
|
defined in the MDEF.
|
||||||
|
|
||||||
To utilize this mailbox from a different source file use the following syntax:
|
To utilize this mailbox from a different source file use the following syntax:
|
||||||
|
|
||||||
|
|
|
@ -62,7 +62,7 @@ The following parameters must be defined:
|
||||||
Public Memory Map
|
Public Memory Map
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
Define the memory map in the application's .MDEF file using the following
|
Define the memory map in the application's MDEF using the following
|
||||||
syntax:
|
syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
|
@ -34,11 +34,12 @@ when a memory block becomes available it is given to the highest
|
||||||
priority task that has waited the longest.
|
priority task that has waited the longest.
|
||||||
|
|
||||||
When a request for memory is sufficiently smaller than an available
|
When a request for memory is sufficiently smaller than an available
|
||||||
memory pool block, the memory pool will automatically split the block
|
memory pool block, the memory pool will automatically split the
|
||||||
block into 4 smaller blocks. The resulting smaller
|
block into 4 smaller blocks. The resulting smaller
|
||||||
blocks can also be split repeatedly, until a block just larger
|
blocks can also be split repeatedly, until a block just larger
|
||||||
than the needed size is available, or the minimum block size
|
than the needed size is available, or the minimum block size,
|
||||||
(as specified in the MDEF file) is reached.
|
as specified in the MDEF, is reached.
|
||||||
|
|
||||||
If the memory pool is unable to find an available block
|
If the memory pool is unable to find an available block
|
||||||
that is at least the requested size, it will attempt to create
|
that is at least the requested size, it will attempt to create
|
||||||
one by merging adjacent free blocks; if it is unable to create
|
one by merging adjacent free blocks; if it is unable to create
|
||||||
|
@ -94,7 +95,7 @@ The following parameters must be defined:
|
||||||
Public Memory Pool
|
Public Memory Pool
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Define the memory pool in the application's .MDEF file using the following
|
Define the memory pool in the application's MDEF using the following
|
||||||
syntax:
|
syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
|
@ -89,7 +89,7 @@ The following parameters must be defined:
|
||||||
Public Mutex
|
Public Mutex
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Define the mutex in the application's .MDEF file using the following syntax:
|
Define the mutex in the application's MDEF using the following syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -178,7 +178,7 @@ The following parameters must be defined:
|
||||||
Public Pipe
|
Public Pipe
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Define the pipe in the application's .MDEF file using the following syntax:
|
Define the pipe in the application's MDEF using the following syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -88,7 +88,7 @@ The following parameters must be defined:
|
||||||
Public Semaphore
|
Public Semaphore
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
Define the semaphore in the application's .MDEF file using the following syntax:
|
Define the semaphore in the application's MDEF using the following syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -62,7 +62,7 @@ The default value of zero for this option disables task IRQs.
|
||||||
.. note::
|
.. note::
|
||||||
Unlike most other microkernel object types, task-level IRQs are defined
|
Unlike most other microkernel object types, task-level IRQs are defined
|
||||||
as a group using a configuration option, rather than as individual
|
as a group using a configuration option, rather than as individual
|
||||||
public objects in an .MDEF file or private objects in a source file.
|
public objects in an MDEF or private objects in a source file.
|
||||||
|
|
||||||
|
|
||||||
Example: Allocating a Task IRQ
|
Example: Allocating a Task IRQ
|
||||||
|
|
|
@ -263,7 +263,7 @@ The following parameters must be defined:
|
||||||
Public Task
|
Public Task
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Define the task in the application's .MDEF file using the following syntax:
|
Define the task in the application's MDEF using the following syntax:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -90,7 +90,7 @@ the sum of the following quantities:
|
||||||
.. note::
|
.. note::
|
||||||
Unlike most other microkernel object types, microkernel timers are defined
|
Unlike most other microkernel object types, microkernel timers are defined
|
||||||
as a group using a configuration option, rather than as individual
|
as a group using a configuration option, rather than as individual
|
||||||
public objects in an .MDEF file or private objects in a source file.
|
public objects in an MDEF or private objects in a source file.
|
||||||
|
|
||||||
|
|
||||||
Example: Allocating a Microkernel Timer
|
Example: Allocating a Microkernel Timer
|
||||||
|
|
|
@ -20,10 +20,10 @@ following files.
|
||||||
are used; if no existing values are provided, the kernel's default
|
are used; if no existing values are provided, the kernel's default
|
||||||
configuration values are used.
|
configuration values are used.
|
||||||
|
|
||||||
A microkernel application typically provides an additional microkernel
|
A microkernel application typically provides an additional :abbr:`MDEF (Microkernel
|
||||||
definitions (MDEF) file (:file:`.mdef`) that defines all of the system's
|
Definitions File)` under the extension :file:`.mdef`. This file defines
|
||||||
public microkernel objects. This file is not used with a nanokernel-only
|
all of the system's public microkernel objects. This file is not used with a
|
||||||
application.
|
nanokernel-only application.
|
||||||
|
|
||||||
* Makefile
|
* Makefile
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue