nuttx/drivers
2015-02-15 08:19:23 -06:00
..
analog More fixes to problems noted by cppcheck. Some are kind of risky; some are real bugs. 2014-11-25 13:15:09 -06:00
audio Fix some warnings in audio code causing by fixing the prototypes of mq_send() and mq_receive() 2015-02-09 12:50:04 -06:00
bch Add support for seeking in BCH. From Sébastien Lorquet. 2014-11-13 09:04:42 -06:00
eeprom Add support for ST Micro EEPROM device geometries. From Sebastien Lorquet 2014-12-05 09:13:34 -06:00
input Nucleo-f4x1re: Fix some joystick pin definitions 2014-12-04 12:04:21 -06:00
lcd Update dates in all skeleton files 2015-02-13 06:13:34 -06:00
mmcsd drivers/mmcsd/Kconfig: ARCH_HAVE_SDIOWAIT_WRCOMPLETE should not depend on MMCSD_SDIO 2015-01-09 07:21:43 -06:00
mtd Update dates in all skeleton files 2015-02-13 06:13:34 -06:00
net Update dates in all skeleton files 2015-02-13 06:13:34 -06:00
pipes Added a forward reference to struct inode to avoid warning about mismatching types in assignemnt 2015-02-10 13:41:49 -06:00
power More fixes to problems noted by cppcheck. Some are kind of risky; some are real bugs. 2014-11-25 13:15:09 -06:00
sensors Cosmetic updates to comments 2015-02-12 13:44:22 -06:00
sercomm
serial STM32 SPI: The source clock for SPI 4,5, and 6 should be PCLK2, not PCLK1 (for F411, F427, and F429). Per David Sidrane. 2015-02-07 13:59:45 -06:00
spi
syslog SYSLOG: Add an option to use the syslog'ing device as the system consolution. This option enables a low-level, write-only console device at /dev/console (similar to the low-level UART console device). From Pierre-noel Bouteville. 2015-02-08 06:53:24 -06:00
timers RTC: A little more clean-up of the RTC driver 2015-02-15 08:19:23 -06:00
usbdev Fixes some issues found by the PX4 team using Coverity. From Pavel Krienko 2015-01-19 13:01:20 -06:00
usbhost Update dates in all skeleton files 2015-02-13 06:13:34 -06:00
video
wireless Backout use of named initializers. Not C99 2015-01-31 12:29:21 -06:00
.gitignore
can.c Fixes to avoid some hang conditions using STM32 CAN 2014-09-17 08:35:03 -06:00
dev_null.c
dev_zero.c
Kconfig Move timer-related drivers from drivers/ to drivers/timers. 2015-02-13 10:30:06 -06:00
loop.c Loop device should return -EINTR is interrupt by a signal 2014-11-27 09:12:15 -06:00
Makefile Move timer-related drivers from drivers/ to drivers/timers. 2015-02-13 10:30:06 -06:00
pwm.c Reanem kzalloc to kmm_zalloc for consistency 2014-08-31 17:34:44 -06:00
ramdisk.c RAM disk: Missed a few changes in the last commit 2015-02-01 08:20:30 -06:00
README.txt Minor clean-up associated with the ADX345 driver 2014-12-16 10:18:44 -06:00
rwbuffer.c rwbuffer, fix compiler error 2014-11-05 15:26:48 -06:00

README
^^^^^^

This directory contains various device drivers -- both block and
character drivers as well as other more specialized drivers.

Contents:
  - Files in this directory
  - Subdirectories of this directory
  - Skeleton files

Files in this directory
^^^^^^^^^^^^^^^^^^^^^^^

can.c
  This is a CAN driver.  See include/nuttx/can.h for usage information.

dev_null.c and dev_zero.c
  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
  want to register these devices (devnull_register() and
  devzero_register()).

loop.c
  Supports the standard loop device that can be used to export a
  file (or character device) as a block device.  See losetup() and
  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
  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
  include/nuttx/fs/ramdisk.h.

timer.c
  Provides the "upper half" for a generic timer driver.  See
  include/nuttx/timer.h for more information.

rwbuffer.c
  A facility that can be use by any block driver in-order to add
  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:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

analog/
  This directory holds implementations of analog device drivers.
  This includes drivers for Analog to Digital Conversion (ADC) as
  well as drivers for Digital to Analog Conversion (DAC).
  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/
  Contains logic that may be used to convert a block driver into
  a character driver.  This is the complementary conversion as that
  performed by loop.c.  See include/nuttx/fs/fs.h for registration
  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/
  This directory holds implementations of human input device (HID)
  drivers.  This includes such things as mouse, touchscreen, joystick,
  keyboard and keypad drivers.  See include/nuttx/input/*.h for
  registration information.

  Note that USB HID devices are treated differently.  These can be
  found under usbdev/ or usbhost/.

lcd/
  Drivers for parallel and serial LCD and OLED type devices.  These
  drivers support interfaces as defined in include/nuttx/lcd/lcd.h

mmcsd/
  Support for MMC/SD block drivers.  MMC/SD block drivers based on
  SPI and SDIO/MCI interfaces are supported.  See include/nuttx/mmcsd.h
  and include/nuttx/sdio.h for further information.

mtd/
  Memory Technology Device (MTD) drivers.  Some simple drivers for
  memory technologies like FLASH, EEPROM, NVRAM, etc.  See
  include/nuttx/mtd/mtd.h

  (Note: This is a simple memory interface and should not be
  confused with the "real" MTD developed at infradead.org.  This
  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).

net/
  Network interface drivers.  See also include/nuttx/net/net.h

pipes/
  FIFO and named pipe drivers.  Standard interfaces are declared
  in include/unistd.h

power/
  Power management (PM) driver interfaces.  These interfaces are used
  to manage power usage of a platform by monitoring driver activity
  and by placing drivers into reduce power usage modes when the
  drivers are not active.

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.

  DACs might fit this definition of a sensor driver as well since they
  measure and convert voltage levels.  DACs, however, are retained in
  the analog/ sub-directory.

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/
  Front-end character drivers for chip-specific UARTs.  This provide
  some TTY-like functionality and are commonly used (but not required for)
  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/
  USB device drivers.  See also include/nuttx/usb/usbdev.h

usbhost/
  USB host drivers.  See also include/nuttx/usb/usbhost.h

video/
  Video-related drivers.  See inlude/nuttx/video/.

wireless/
  Drivers for various wireless devices.

Skeleton Files
^^^^^^^^^^^^^^

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.
The following skeleton files are available:

  drivers/lcd/skeleton.c -- Skeleton LCD driver
  drivers/mtd/skeleton.c -- Skeleton memory technology device drivers
  drivers/net/skeleton.c -- Skeleton network/Ethernet drivers
  drivers/usbhost/usbhost_skeleton.c -- Skeleton USB host class driver