forked from nuttx/nuttx-update
Update README files
This commit is contained in:
parent
df30780f37
commit
4aa9320da9
3 changed files with 55 additions and 22 deletions
|
@ -12,9 +12,6 @@ README.txt
|
||||||
LEDs and Buttons
|
LEDs and Buttons
|
||||||
================
|
================
|
||||||
|
|
||||||
Serial Console
|
|
||||||
==============
|
|
||||||
|
|
||||||
Serial Console
|
Serial Console
|
||||||
==============
|
==============
|
||||||
|
|
||||||
|
|
|
@ -36,23 +36,18 @@ ramdisk.c
|
||||||
a block driver that can be mounted as a files system. See
|
a block driver that can be mounted as a files system. See
|
||||||
include/nuttx/fs/ramdisk.h.
|
include/nuttx/fs/ramdisk.h.
|
||||||
|
|
||||||
ramlog.c
|
timer.c
|
||||||
This is a driver that was intended to support debugging output,
|
Provides the "upper half" for a generic timer driver. See
|
||||||
aka syslogging, when the normal serial output is not available.
|
include/nuttx/timer.h for more information.
|
||||||
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
|
rwbuffer.c
|
||||||
A facility that can be use by any block driver in-order to add
|
A facility that can be use by any block driver in-order to add
|
||||||
writing buffering and read-ahead buffering.
|
writing buffering and read-ahead buffering.
|
||||||
|
|
||||||
|
watchdog.c
|
||||||
|
Provides the "upper half" for a generic watchdog driver. See
|
||||||
|
include/nuttx/watchdog.h for more information.
|
||||||
|
|
||||||
Subdirectories of this directory:
|
Subdirectories of this directory:
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
@ -62,16 +57,35 @@ analog/
|
||||||
well as drivers for Digital to Analog Conversion (DAC).
|
well as drivers for Digital to Analog Conversion (DAC).
|
||||||
See include/nuttx/analog/*.h for registration information.
|
See include/nuttx/analog/*.h for registration information.
|
||||||
|
|
||||||
|
audio/
|
||||||
|
Audio device drivers. See include/nuttx/audio/audio.h for interface
|
||||||
|
definitions. See also the audio subsystem at nuttx/audio/.
|
||||||
|
|
||||||
bch/
|
bch/
|
||||||
Contains logic that may be used to convert a block driver into
|
Contains logic that may be used to convert a block driver into
|
||||||
a character driver. This is the complementary conversion as that
|
a character driver. This is the complementary conversion as that
|
||||||
performed by loop.c. See include/nuttx/fs/fs.h for registration
|
performed by loop.c. See include/nuttx/fs/fs.h for registration
|
||||||
information.
|
information.
|
||||||
|
|
||||||
|
eeprom/
|
||||||
|
An EEPROM is a form of Memory Technology Device (see drivers/mtd).
|
||||||
|
EEPROMs are non-volatile memory like FLASH, but differ in underlying
|
||||||
|
memory technology and differ in usage in many respects: They may not
|
||||||
|
be organized into blocks (at least from the standpoint of the user)
|
||||||
|
and it is not necessary to erase the EEPROM memory before re-writing
|
||||||
|
it. In addition, EEPROMs tend to be much smaller than FLASH parts,
|
||||||
|
usually only a few kilobytes vs megabytes for FLASH. EEPROM tends to
|
||||||
|
be used to retain a small amount of device configuration information;
|
||||||
|
FLASH tends to be used for program or massive data storage. For these
|
||||||
|
reasons, it may not be convenient to use the more complex MTD
|
||||||
|
interface but instead use the simple character interface provided by
|
||||||
|
the EEPROM drivers.
|
||||||
|
|
||||||
input/
|
input/
|
||||||
This directory holds implementations of input device drivers.
|
This directory holds implementations of human input device drivers.
|
||||||
This includes such things as touchscreen and keypad drivers.
|
This includes such things as mouse, touchscreen, joystick, keyboard
|
||||||
See include/nuttx/input/*.h for registration information.
|
and keypad drivers. See include/nuttx/input/*.h for registration
|
||||||
|
information.
|
||||||
|
|
||||||
lcd/
|
lcd/
|
||||||
Drivers for parallel and serial LCD and OLED type devices. These
|
Drivers for parallel and serial LCD and OLED type devices. These
|
||||||
|
@ -106,7 +120,10 @@ power/
|
||||||
drivers are not active.
|
drivers are not active.
|
||||||
|
|
||||||
sensors/
|
sensors/
|
||||||
Drivers for various sensors
|
Drivers for various sensors. A sensor driver differs little from
|
||||||
|
other types of drivers other than they are use to provide measuresments
|
||||||
|
of things in envionment like temperatore, orientation, acceleration,
|
||||||
|
altitude, direction, position, etc.
|
||||||
|
|
||||||
sercomm/
|
sercomm/
|
||||||
Sercomm is the transport used by osmocom-bb that runs on top of serial.
|
Sercomm is the transport used by osmocom-bb that runs on top of serial.
|
||||||
|
@ -123,12 +140,21 @@ serial/
|
||||||
some TTY-like functionality and are commonly used (but not required for)
|
some TTY-like functionality and are commonly used (but not required for)
|
||||||
the NuttX system console. See also include/nuttx/serial/serial.h
|
the NuttX system console. See also include/nuttx/serial/serial.h
|
||||||
|
|
||||||
|
spi/
|
||||||
|
SPI drivers. See include/nuttx/spi.h
|
||||||
|
|
||||||
|
syslog/
|
||||||
|
System logging devices. See include/syslog.h and include/nuttx/syslog/syslog.h
|
||||||
|
|
||||||
usbdev/
|
usbdev/
|
||||||
USB device drivers. See also include/nuttx/usb/usbdev.h
|
USB device drivers. See also include/nuttx/usb/usbdev.h
|
||||||
|
|
||||||
usbhost/
|
usbhost/
|
||||||
USB host drivers. See also include/nuttx/usb/usbhost.h
|
USB host drivers. See also include/nuttx/usb/usbhost.h
|
||||||
|
|
||||||
|
video/
|
||||||
|
Video-related drivers. See inlude/nuttx/video/.
|
||||||
|
|
||||||
wireless/
|
wireless/
|
||||||
Drivers for various wireless devices.
|
Drivers for various wireless devices.
|
||||||
|
|
||||||
|
|
|
@ -29,9 +29,19 @@ Those custom SYSLOG drivers reside in this directory.
|
||||||
ramlog.c
|
ramlog.c
|
||||||
--------
|
--------
|
||||||
The RAM logging driver is a driver that was intended to support debugging
|
The RAM logging driver is a driver that was intended to support debugging
|
||||||
output (syslogging) when the normal serial output is not available. For
|
output (aka, syslogging). It might be used when the normal serial output
|
||||||
example, if you are using a telnet or USB serial console, the debug
|
is not available. For example, if you are using a Telnet or USB serial
|
||||||
output will get lost.
|
console, the debug output will get lost since the USB Telnet session does
|
||||||
|
not use the serial console.
|
||||||
|
|
||||||
|
The RAM logginc driver is also useful when debug output on the serial
|
||||||
|
console would interfere with performance or with usability. The debug
|
||||||
|
output is write to RAM very quickly and so interferes less with realtime
|
||||||
|
performance. And since the output does not appear on the serial console
|
||||||
|
until you want it to, it does not interfere with the usability of the
|
||||||
|
serial console. The NuttShell (NSH), for eample, supports a 'dmesg'
|
||||||
|
command that can be used to dump the buffered output when you want to
|
||||||
|
see it.
|
||||||
|
|
||||||
The RAM logging driver is similar to a pipe in that it saves the
|
The RAM logging 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
|
debugging output in a FIFO in RAM. It differs from a pipe in numerous
|
||||||
|
|
Loading…
Reference in a new issue