summaryrefslogtreecommitdiff
path: root/nuttx/drivers/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'nuttx/drivers/README.txt')
-rw-r--r--nuttx/drivers/README.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/nuttx/drivers/README.txt b/nuttx/drivers/README.txt
index e5a1483b2..0cddb9311 100644
--- a/nuttx/drivers/README.txt
+++ b/nuttx/drivers/README.txt
@@ -31,6 +31,19 @@ ramdisk.c
a block driver that can be mounted as a files system. See
include/nuttx/ramdisk.h.
+ramlog.c
+ This is a driver that was intended to support debugging output,
+ aka syslogging, when the normal serial output is not available.
+ For example, if you are using a telnet or USB serial console,
+ the debug output will get lost.
+
+ This driver is similar to a pipe in that it saves the debugging
+ output in a FIFO in RAM. It differs from a pipe in numerous
+ details as needed to support logging.
+
+ This driver is built when CONFIG_RAMLOG is defined in the Nuttx
+ configuration.
+
rwbuffer.c
A facility that can be use by any block driver in-order to add
writing buffering and read-ahead buffering.