Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-28 20:08:15 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Additional documentation/README updates

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4519 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo
2012-03-24 22:39:52 +00:00
parent 767057428a
commit f58011c8bf
4 changed files with 103 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/README.html
+2
View File
@@ -210,6 +210,8 @@
| |- drivers/ | |- drivers/
| | |- lcd/ | | |- lcd/
| | | `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/lcd/README.txt?view=log"><b><i>README.txt</i></b></a> | | | `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/lcd/README.txt?view=log"><b><i>README.txt</i></b></a>
| | |- sercomm/
| | | `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/sercomm/README.txt?view=log">README.txt</a>
| | `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/README.txt?view=log"><b><i>README.txt</i></b></a> | | `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/README.txt?view=log"><b><i>README.txt</i></b></a>
| |- fs/ | |- fs/
| | |- mmap/ | | |- mmap/
README.txt
+2
View File
@@ -693,6 +693,8 @@ nuttx
|- drivers/ |- drivers/
| |- lcd/ | |- lcd/
| | `- README.txt | | `- README.txt
| |- sercomm/
| | `- README.txt
| `- README.txt | `- README.txt
|- fs/ |- fs/
| |- mmap/ | |- mmap/
drivers/README.txt
+80 -65
View File
@@ -13,109 +13,124 @@ Files in this directory
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
can.c can.c
An unfinished CAN driver. This is a CAN driver. See include/nuttx/can.h for usage information.
dev_null.c and dev_zero.c dev_null.c and dev_zero.c
These files provide the standard /dev/null and /dev/zero devices. These files provide the standard /dev/null and /dev/zero devices.
See include/nuttx/fs/fs.h for functions that should be called if you See include/nuttx/fs/fs.h for functions that should be called if you
want to register these devices (devnull_register() and want to register these devices (devnull_register() and
devzero_register()). devzero_register()).
loop.c loop.c
Supports the standard loop device that can be used to export a Supports the standard loop device that can be used to export a
file (or character device) as a block device. See losetup() and file (or character device) as a block device. See losetup() and
loteardown() in include/nuttx/fs/fs.h. loteardown() in include/nuttx/fs/fs.h.
pwm.c
Provides the "upper half" of a pulse width modulation (PWM) driver.
The "lower half" of the PWM driver is provided by device-specific
logic. See include/nuttx/pwm.h for usage information.
ramdisk.c ramdisk.c
Can be used to set up a block of memory or (read-only) FLASH as Can be used to set up a block of memory or (read-only) FLASH as
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/ramdisk.h. include/nuttx/ramdisk.h.
ramlog.c ramlog.c
This is a driver that was intended to support debugging output, This is a driver that was intended to support debugging output,
aka syslogging, when the normal serial output is not available. aka syslogging, when the normal serial output is not available.
For example, if you are using a telnet or USB serial console, For example, if you are using a telnet or USB serial console,
the debug output will get lost. the debug output will get lost.
This driver is similar to a pipe in that it saves the debugging 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 output in a FIFO in RAM. It differs from a pipe in numerous
details as needed to support logging. details as needed to support logging.
This driver is built when CONFIG_RAMLOG is defined in the Nuttx This driver is built when CONFIG_RAMLOG is defined in the Nuttx
configuration. 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.
Subdirectories of this directory: Subdirectories of this directory:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
analog/ analog/
This directory holds implementations of analog device drivers. This directory holds implementations of analog device drivers.
This includes drivers for Analog to Digital Conversion (ADC) as This includes drivers for Analog to Digital Conversion (ADC) as
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.
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.
analog/ input/
This directory holds implementations of input device drivers. This directory holds implementations of input device drivers.
This includes such things as touchscreen and keypad drivers. This includes such things as touchscreen and keypad drivers.
See include/nuttx/input/*.h for registration information. 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
drivers support interfaces as defined in include/nuttx/lcd/lcd.h drivers support interfaces as defined in include/nuttx/lcd/lcd.h
mmcsd/ mmcsd/
Support for MMC/SD block drivers. MMC/SD block drivers based on Support for MMC/SD block drivers. MMC/SD block drivers based on
SPI and SDIO/MCI interfaces are supported. See include/nuttx/mmcsd.h SPI and SDIO/MCI interfaces are supported. See include/nuttx/mmcsd.h
and include/nuttx/sdio.h for further information. and include/nuttx/sdio.h for further information.
mtd/ mtd/
Memory Technology Device (MTD) drivers. Some simple drivers for Memory Technology Device (MTD) drivers. Some simple drivers for
memory technologies like FLASH, EEPROM, NVRAM, etc. See memory technologies like FLASH, EEPROM, NVRAM, etc. See
include/nuttx/mtd.h include/nuttx/mtd.h
(Note: This is a simple memory interface and should not be (Note: This is a simple memory interface and should not be
confused with the "real" MTD developed at infradead.org. This confused with the "real" MTD developed at infradead.org. This
logic is unrelated; I just used the name MTD because I am not logic is unrelated; I just used the name MTD because I am not
aware of any other common way to refer to this class of devices). aware of any other common way to refer to this class of devices).
net/ net/
Network interface drivers. See also include/nuttx/net/net.h Network interface drivers. See also include/nuttx/net/net.h
pipes/ pipes/
FIFO and named pipe drivers. Standard interfaces are declared FIFO and named pipe drivers. Standard interfaces are declared
in include/unistd.h in include/unistd.h
pm/ power/
Power management (PM) driver interfaces. These interfaces are used Power management (PM) driver interfaces. These interfaces are used
to manage power usage of a platform by monitoring driver activity to manage power usage of a platform by monitoring driver activity
and by placing drivers into reduce power usage modes when the and by placing drivers into reduce power usage modes when the
drivers are not active. drivers are not active.
sensors/ sensors/
Drivers for various sensors Drivers for various sensors
sercomm/
Sercomm is the transport used by osmocom-bb that runs on top of serial.
See http://bb.osmocom.org/trac/wiki/nuttx-bb/run for detailed the usage
of nuttx with sercomm.
drivers/sercomm is only built if CONFIG_SERCOMM_CONSOLE in the NuttX
configuration file. If you attempt to build this driver without
osmocom-bb, you will get compilation errors because of header files
that are needed from the osmocom-bb.
serial/ serial/
Front-end character drivers for chip-specific UARTs. This provide Front-end character drivers for chip-specific UARTs. This provide
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
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
wireless/ wireless/
Drivers for various wireless devices. Drivers for various wireless devices.
Skeleton Files Skeleton Files
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
@@ -124,7 +139,7 @@ Skeleton files a "empty" frameworks for NuttX drivers. They are provided to
give you a good starting point if you want to create a new NuttX driver. give you a good starting point if you want to create a new NuttX driver.
The following skeleton files are available: The following skeleton files are available:
drivers/lcd/skeleton.c -- Skeleton LCD driver drivers/lcd/skeleton.c -- Skeleton LCD driver
drivers/mtd/skeleton.c -- Skeleton memory technology device drivers drivers/mtd/skeleton.c -- Skeleton memory technology device drivers
drivers/net/skeleton.c -- Skeleton network/Ethernet drivers drivers/net/skeleton.c -- Skeleton network/Ethernet drivers
drivers/usbhost/usbhost_skeleton.c -- Skeleton USB host class driver drivers/usbhost/usbhost_skeleton.c -- Skeleton USB host class driver
drivers/sercomm/README.txt
Executable
+19
View File
@@ -0,0 +1,19 @@
drivers/sercomm README
======================
If CONFIG_SERCOMM_CONSOLE is defined in the NuttX configuration file, NuttX
will attempt to use sercomm (HDLC protocol) to communicate with the
host system. Sercomm is the transport used by osmocom-bb that runs on top
of serial. See http://bb.osmocom.org/trac/wiki/nuttx-bb/run for detailed
the usage of nuttx with sercomm.
The drivers/sercomm build that you have the osmocom-bb project directory
at same level as the nuttx project:
|- nuttx
|- apps
`- osmocom-bb
If you attempt to build this driver without osmocom-bb, you will get
compilation errors because ofheader files that are needed from the
osmocom-bb directory.