michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Remove references to async pipe messages

Browse source 
Updates the documentation to remove references to asynchronous
pipe messages as they are no longer supported.

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
This commit is contained in:
Peter Mitsis 2021-10-01 11:58:27 -04:00 • committed by Anas Nashif
commit 452f57a55d
1 changed files with 5 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/reference/kernel/data_passing/pipes.rst
View file

@ -4,8 +4,8 @@ Pipes
##### #####
A :dfn:`pipe` is a kernel object that allows a thread to send a byte stream A :dfn:`pipe` is a kernel object that allows a thread to send a byte stream
to another thread. Pipes can be used to transfer chunks of data in whole to another thread. Pipes can be used to synchronously transfer chunks of data
or in part, and either synchronously or asynchronously. in whole or in part.
.. contents:: .. contents::
:local: :local:
@ -27,18 +27,14 @@ A pipe has the following key property:
A pipe must be initialized before it can be used. The pipe is initially empty. A pipe must be initialized before it can be used. The pipe is initially empty.
Data can be synchronously **sent** either in whole or in part to a pipe by a Data is synchronously **sent** either in whole or in part to a pipe by a
thread. If the specified minimum number of bytes can not be immediately thread. If the specified minimum number of bytes can not be immediately
satisfied, then the operation will either fail immediately or attempt to send satisfied, then the operation will either fail immediately or attempt to send
as many bytes as possible and then pend in the hope that the send can be as many bytes as possible and then pend in the hope that the send can be
completed later. Accepted data is either copied to the pipe's ring buffer completed later. Accepted data is either copied to the pipe's ring buffer
or directly to the waiting reader(s). or directly to the waiting reader(s).
Data can be asynchronously **sent** in whole using a memory block to a pipe by Data is synchronously **received** from a pipe by a thread. If the specified
a thread. Once the pipe has accepted all the bytes in the memory block, it will
free the memory block and may give a semaphore if one was specified.
Data can be synchronously **received** from a pipe by a thread. If the specified
minimum number of bytes can not be immediately satisfied, then the operation minimum number of bytes can not be immediately satisfied, then the operation
will either fail immediately or attempt to receive as many bytes as possible will either fail immediately or attempt to receive as many bytes as possible
and then pend in the hope that the receive can be completed later. Accepted and then pend in the hope that the receive can be completed later. Accepted
@ -171,7 +167,7 @@ Configuration Options
Related configuration options: Related configuration options:
* :kconfig:`CONFIG_NUM_PIPE_ASYNC_MSGS` * None.
API Reference API Reference
************* *************