nuttx/drivers
2016-06-20 07:35:38 -06:00
..
analog Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
audio Centralize definitions associated with CONFIG_DEBUG_I2S 2016-06-15 16:54:01 -06:00
bch Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
eeprom Replace all occurrences of vdbg with vinfo 2016-06-11 11:59:51 -06:00
i2c Centralize definitions associated with CONFIG_DEBUG_I2C 2016-06-15 16:30:12 -06:00
input Kconfig files: Fix some dependencies that have CONFIG_ in the variable name 2016-06-17 19:30:19 -06:00
ioexpander PCA9555: Fix condition where GPIO interrupt is not re-enabled. 2016-04-20 09:59:16 -06:00
lcd Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
leds Cosmetic, fix alignment 2016-06-15 14:13:18 -06:00
loop Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
mmcsd drivers/: Change some nerr() ERRORS to nwarn() WARNINGS. Anomolous network evernts are not errors. 2016-06-12 08:31:22 -06:00
modem Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
mtd Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
net Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
pipes Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
power Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
sensors Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
sercomm Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
serial There is now one-and-only-one copy of syslog_putc. It is in the SYSLOG channel logic and can redirect syslog output as needed. All former syslog_putc versions were renamed and the corresponding SYSLOG device initializaiton now calls syslog_channel() 2016-06-19 13:03:20 -06:00
spi Centralize definitions associated with CONFIG_DEBUG_SPI 2016-06-15 10:41:13 -06:00
syslog SYSLOG: Debug output from the IDLE task should be forced like interrupt level output 2016-06-20 07:35:38 -06:00
timers Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
usbdev Rename CONFIG_DEBUG to CONFIG_DEBUG_FEATURES 2016-06-11 14:14:08 -06:00
usbhost drivers/: Change some nerr() ERRORS to nwarn() WARNINGS. Anomolous network evernts are not errors. 2016-06-12 08:31:22 -06:00
video Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
wireless Add _ to the beginning of all debug macros to avoid name collisions 2016-06-16 12:33:32 -06:00
.gitignore .dSYM only needs to be in the same .gitignore files as .exe 2013-05-30 15:02:04 -06:00
can.c Centralize definitions associated with CONFIG_DEBUG_CAN 2016-06-15 15:45:27 -06:00
dev_null.c Silence some warnings 2016-05-26 14:06:13 -04:00
dev_zero.c Silence some warnings 2016-05-26 14:06:13 -04:00
Kconfig Some higher level SYSLOG features are disabled if the architecture-specific logic provides its own SYSLOG functionality 2016-06-19 09:21:52 -06:00
Makefile Several Makefiles: Add .PHONY definitions to prevent 'clean up to date' message weirdness. 2016-05-10 15:44:06 -06:00
pwm.c Centralize definitions associated with CONFIG_DEBUG_PWM 2016-06-15 17:23:56 -06:00
ramdisk.c Add CONFIG_DEBUG_ERROR. Change names of *dbg() * *err() 2016-06-11 15:50:49 -06:00
README.txt Move include/nuttx/i2c.h to include/nuttx/i2c/i2c_master.h 2016-01-30 08:00:16 -06:00
rwbuffer.c Add CONFIG_DEBUG_ERROR. Change names of *dbg() * *err() 2016-06-11 15:50:49 -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()).

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.

rwbuffer.c
  A facility that can be use by any block driver in-order to add
  writing buffering and read-ahead buffering.

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.

i2c/
  I2C drivers and support logic.  See include/nuttx/i2c/i2c_master.h

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

leds/
  Various LED-related drivers including discrete as well as PWM-
  driven LEDs.

loop/
  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.

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 and support logic.  See include/nuttx/spi/spi.h

syslog/
  System logging devices. See include/syslog.h and include/nuttx/syslog/syslog.h

timers/
  Includes support for various timer devices including:

  - An "upper half" for a generic timer driver.  See
    include/nuttx/timers/timer.h for more information.

  - An "upper half" for a generic watchdog driver.  See
    include/nuttx/timers/watchdog.h for more information.

  - RTC drivers

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