diff options
| author | Peter Mitsis <peter.mitsis@windriver.com> | 2016-10-14 14:44:57 -0400 |
|---|---|---|
| committer | Benjamin Walsh <benjamin.walsh@windriver.com> | 2016-10-15 07:09:58 +0000 |
| commit | e5d9c583013bfee238ebb454b83ed8efaa02c7c1 (patch) | |
| tree | 546712bfc3ae530ac01c364913e7796473aba058 /doc | |
| parent | 59f59088eaa902a79a076b17967c7cb3c760d5af (diff) | |
unified: Tweak pipe API parameters
- Reorders parameters where necessary
- Adds alignment parameter to K_PIPE_DEFINE()
- Renames parameters where necessary so they are sync'd
between header and source files
Change-Id: I4f2367abc28aff646cc90beb9f08bb266e143b0c
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/kernel_v2/data_passing/pipes.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/kernel_v2/data_passing/pipes.rst b/doc/kernel_v2/data_passing/pipes.rst index 848f4074c..ac9336e43 100644 --- a/doc/kernel_v2/data_passing/pipes.rst +++ b/doc/kernel_v2/data_passing/pipes.rst @@ -57,12 +57,12 @@ optional character buffer of type :c:type:`unsigned char`. It must then be initialized by calling :c:func:`k_pipe_init()`. The following code defines and initializes an empty pipe that has a ring -buffer capable of holding 100 bytes. +buffer capable of holding 100 bytes and is aligned to a 4-byte boundary. .. code-block:: c - unsigned char my_ring_buffer[100]; + unsigned char __aligned(4) my_ring_buffer[100]; struct k_pipe my_pipe; k_pipe_init(&my_pipe, my_ring_buffer, sizeof(my_ring_buffer)); @@ -75,7 +75,7 @@ that that macro defines both the pipe and its ring buffer. .. code-block:: c - K_PIPE_DEFINE(my_pipe, 100); + K_PIPE_DEFINE(my_pipe, 100, 4); Writing to a Pipe ================= |