67405bb918
Adds the basic kernel objects' documentation describing the function of tasks, fiber and interrupt service routines. Adds the nanokernel objects' docuementation describing the function of the most important nanokernel objects. Adds the microkernel objects' documentation describing the function of the most important microkernel objects. Changes the index.rst file to include the Object Documentation. Change-Id: Ib35d973cc3575a7ecc32c4ab175e05cb298e3306 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
37 lines
1.9 KiB
ReStructuredText
37 lines
1.9 KiB
ReStructuredText
Object Documentation
|
|
####################
|
|
|
|
Use this information to understand how the different kernel objects of
|
|
Tiny Mountain function. The purpose of this section is to help you
|
|
understand the most important object of the operating system. In order
|
|
to help you navigate through the content, we have divided the objects
|
|
in :ref:`basicObjects`, :ref:`nanokernelObjects` and
|
|
:ref:`microkernelObjects` objects.
|
|
|
|
We strongly recommend that you start with the :ref:`basicObjects` before
|
|
moving on to the :ref:`nanokernelObjects` or the
|
|
:ref:`microkernelObjects`. Additionally, we have included some
|
|
:ref:`driverExamples` for better comprehension of the objects' function.
|
|
|
|
.. rubric:: Abbreviations
|
|
|
|
+---------------+-------------------------------------------------------------------+
|
|
| Abbreviations | Definition |
|
|
+===============+===================================================================+
|
|
| API | Application Program Interface: typically a defined set |
|
|
| | of routines and protocols for building software inputs and output |
|
|
| | mechanisms. |
|
|
+---------------+-------------------------------------------------------------------+
|
|
| ISR | Interrupt Service Routine |
|
|
+---------------+-------------------------------------------------------------------+
|
|
| IDT | Interrupt Descriptor Table |
|
|
+---------------+-------------------------------------------------------------------+
|
|
| XIP | eXecute In Place |
|
|
+---------------+-------------------------------------------------------------------+
|
|
|
|
.. toctree:: Table of Contents
|
|
:maxdepth: 2
|
|
|
|
object_basic.rst
|
|
object_microkernel.rst
|
|
object_nanokernel.rst |