summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAllan Stephens <allan.stephens@windriver.com>2016-10-19 10:26:56 -0500
committerBenjamin Walsh <benjamin.walsh@windriver.com>2016-10-21 15:33:31 +0000
commit11a1bb4125329c065720554fcaa23328f24997ba (patch)
tree65dfb2631bb87b0f78269209489b9a5d138061c8 /include
parentb9a4bd906c8b4d6edbc8cbd94668bde7fdcb71ca (diff)
unified/doc: Update ring buffers section of Kernel Primer
Ring buffer section now resides under "other" topic, since the ring buffer type is a general purpose type (like the singly and doubly linked list types), rather than a kernel-specific type. Enhances ring buffer section to improve content and improve consistency with the form used elsewhere in the Kernel Primer. Also corrects a minor error in the ring buffer API documentation. Change-Id: Icaa8661524f80e31f173adee859844cadb38967f Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Diffstat (limited to 'include')
-rw-r--r--include/misc/ring_buffer.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/misc/ring_buffer.h b/include/misc/ring_buffer.h
index b7a066bf4..d8ab59778 100644
--- a/include/misc/ring_buffer.h
+++ b/include/misc/ring_buffer.h
@@ -161,7 +161,7 @@ static inline int sys_ring_buf_space_get(struct ring_buf *buf)
* @param value Integral data to include, application specific
* @param data Pointer to a buffer containing data to enqueue
* @param size32 Size of data buffer, in 32-bit chunks (not bytes)
- * @return 0 on success, -ENOSPC if there isn't sufficient space
+ * @return 0 on success, -EMSGSIZE if there isn't sufficient space
*/
int sys_ring_buf_put(struct ring_buf *buf, uint16_t type, uint8_t value,
uint32_t *data, uint8_t size32);