summaryrefslogtreecommitdiff
path: root/nuttx/lib/lib_meminstream.c
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2009-06-01 14:24:29 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2009-06-01 14:24:29 +0000
commit1429d1f9793ddcfcce42214a19a64042111b784d (patch)
treea93643d35ce4c2dced36b19511b19634f1c9fa0c /nuttx/lib/lib_meminstream.c
parent5ba94a97648150ab48ab40d443527706303b9519 (diff)
downloadpx4-nuttx-1429d1f9793ddcfcce42214a19a64042111b784d.tar.gz
px4-nuttx-1429d1f9793ddcfcce42214a19a64042111b784d.tar.bz2
px4-nuttx-1429d1f9793ddcfcce42214a19a64042111b784d.zip
update comments; add lib_zeroinstream
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@1842 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx/lib/lib_meminstream.c')
-rw-r--r--nuttx/lib/lib_meminstream.c13
1 files changed, 13 insertions, 0 deletions
diff --git a/nuttx/lib/lib_meminstream.c b/nuttx/lib/lib_meminstream.c
index 5453d2775..62260c639 100644
--- a/nuttx/lib/lib_meminstream.c
+++ b/nuttx/lib/lib_meminstream.c
@@ -70,6 +70,19 @@ static int meminstream_getc(FAR struct lib_instream_s *this)
/****************************************************************************
* Name: lib_meminstream
+ *
+ * Description:
+ * Initializes a stream for use with a fixed-size memory buffer.
+ *
+ * Input parameters:
+ * meminstream - User allocated, uninitialized instance of struct
+ * lib_meminstream_s to be initialized.
+ * bufstart - Address of the beginning of the fixed-size memory buffer
+ * buflen - Size of the fixed-sized memory buffer in bytes
+ *
+ * Returned Value:
+ * None (meminstream initialized).
+ *
****************************************************************************/
void lib_meminstream(FAR struct lib_meminstream_s *meminstream,