michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Edit microkernel API links

Browse source 
Edited the microkernel API sections to get the proper linakage.

Change-Id: I1bc95c6e21ed996c4c5d72188c5f018038e3e958
Signed-off-by: Gerardo Aceves <gerardo.aceves@intel.com>
This commit is contained in:
Gerardo Aceves 2016-03-28 12:02:06 -06:00
commit 46e5fc6330
4 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -177,11 +177,11 @@ APIs
FIFO APIs provided by :file:`microkernel.h`
===========================================
:c:func:`task_fifo_put()`
:cpp:func:`task_fifo_put()`
Write item to a FIFO, or wait for a specified time period if the FIFO is
full.
:c:func:`task_fifo_get()`
:cpp:func:`task_fifo_get()`
Read item from a FIFO, or wait for a specified time period if the FIFO is
empty.

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

@ -628,17 +628,17 @@ APIs
The following APIs for mailbox operations are provided by the kernel:
:c:func:`task_mbox_put()`
:cpp:func:`task_mbox_put()`
Send synchronous message to a receiving task, with time limited waiting.
:c:func:`task_mbox_block_put()`
Send asynchronous message to a receiving task, or to a mailbox queue.
:c:func:`task_mbox_get()`
:cpp:func:`task_mbox_get()`
Get message from a mailbox, with time limited waiting.
:c:func:`task_mbox_data_get()`
Retrieve message data into a buffer.
:c:func:`task_mbox_data_block_get()`
:cpp:func:`task_mbox_data_block_get()`
Retrieve message data into a block, with time limited waiting.

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

@ -310,11 +310,11 @@ APIs
Pipe APIs provided by :file:`microkernel.h`
===========================================
:c:func:`task_pipe_put()`
:cpp:func:`task_pipe_put()`
Write data to a pipe, with time limited waiting.
:c:func:`task_pipe_block_put()`
Write data to a pipe from a memory pool block.
:c:func:`task_pipe_get()`
:cpp:func:`task_pipe_get()`
Read data from a pipe, or fails and continues if data isn't there.

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

@ -111,5 +111,5 @@ Task IRQ APIs provided by :file:`microkernel.h`
:cpp:func:`task_irq_ack()`
Acknowledge an interrupt and re-enable the interrupt.
:c:func:`task_irq_wait()`
:cpp:func:`task_irq_wait()`
Wait for an interrupt to occur within a specified time period.