incubator-nuttx/drivers
ligd 5de150160f syslog: add CPU id to system when open CONFIG_SMP
Change-Id: Ie8aaf44583ff4146b79b1392d1410b31806a81e8
Signed-off-by: ligd <liguiding1@xiaomi.com>
2021-07-02 08:45:43 +09:00
..
1wire Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
analog Update drivers/analog/adc.c 2021-06-16 04:58:06 -07:00
audio Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
bch drivers/bch/bchlib_cache.c: Fix build with CONFIG_BCH_ENCRYPTION 2021-03-17 01:25:16 -07:00
can Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
contactless Don't include debug.h from public header file 2021-06-01 06:42:02 +09:00
crypto nuttx: Author David S. Alessio: update licenses to Apache 2021-03-22 19:28:38 -07:00
dummy build: Remove the dummy drivers folder under boards 2020-05-24 20:20:12 +01:00
eeprom Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
efuse Add generic efuse driver for NuttX 2021-01-15 10:34:12 -06:00
i2c Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
i2s Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
input Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
ioexpander drivers/ioexpander/gpio_lower_half.c: add missing debug.h 2021-06-23 11:07:47 -05:00
lcd Fix ht16k33 driver to support multi-modules 2021-06-07 01:08:11 -05:00
leds Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
loop Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
mmcsd Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
modem Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
motor Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
mtd mtd: Add MTDIOC_FLUSH IOCTL like MTDIOC_XIPBASE 2021-06-15 13:26:45 -03:00
net net/telnet: fix a potential busyloop if rxbuffer writes faster than read 2021-06-13 05:06:54 -05:00
note libc/assert: Reference the expression in all case 2021-04-03 21:00:41 +01:00
pipes Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
power Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
rc Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
rf Include assert.h in necessary place 2021-06-08 13:06:08 -07:00
rptun drivers/rptun: Adapter to openamp 2020.10.0 release 2021-05-13 18:43:19 +01:00
sensors drivers/sensors/hyt271: Fix typos in comments and identifier 2021-07-01 12:43:18 -05:00
serial serial/pty: Initialize the terminal setting as a console 2021-06-12 09:52:05 +09:00
spi spi: Refactor SPI Slave interface prefix to sync with I2C Slave 2021-06-05 04:50:34 -07:00
syslog syslog: add CPU id to system when open CONFIG_SMP 2021-07-02 08:45:43 +09:00
timers Replace mktime with timegm in rtc and fs driver 2021-06-23 13:43:32 -03:00
usbdev usbmsc: Add USBMSC_NOT_STALL_BULKEP for RP2040 workaround 2021-06-14 09:05:19 -03:00
usbhost Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
usbmisc drivers: nxstyle fixes 2021-04-05 07:31:45 -05:00
usbmonitor Don't include debug.h from public header file 2021-06-01 06:42:02 +09:00
video Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
wireless drivers: wireless: Fix error handling in gs2200m_ioctl_send() 2021-06-28 21:48:47 -05:00
.gitignore build: Remve the unnecessary .gitignore 2020-05-23 18:00:40 +01:00
Kconfig drivers: add generic upper-half driver for Field Oriented Control (FOC) 2021-03-30 21:54:39 -03:00
Makefile drivers: add generic upper-half driver for Field Oriented Control (FOC) 2021-03-30 21:54:39 -03:00
README.txt support for SAMA5D27 SDMMC peripheral 2020-07-16 23:39:37 +01:00
addrenv.c sim_addrenv: support add addrenv dynamically multiple times. 2021-05-30 23:28:40 -05:00
dev_null.c drivers: Author Gregory Nutt: update licenses to Apache 2021-03-04 18:32:27 -08:00
dev_zero.c drivers: Author Gregory Nutt: update licenses to Apache 2021-03-04 18:32:27 -08:00
lwl_console.c sourcefiles: Fix relative path in file header 2021-03-09 23:18:28 +08:00
mkrd.c drivers/mkrd.c 2020-08-04 13:00:53 -05:00
ramdisk.c Don't include assert.h from public header file 2021-06-03 08:36:03 -07:00
rwbuffer.c Integration of pysimCoder with NUTTX 2021-03-29 21:38:58 -03:00

README.txt

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
^^^^^^^^^^^^^^^^^^^^^^^

dev_null.c and dev_zero.c
  These files provide the standard /dev/null and /dev/zero devices.  See
  include/nuttx/drivers/drivers.h for prototypes of functions that should
  be called if you want to register these devices (devnull_register()
  and devzero_register()).

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 file system.  See
  include/nuttx/drivers/ramdisk.h.

rwbuffer.c
  A facility that can be used 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.

can/
  This is the CAN drivers and logic support.  See include/nuttx/can/can.h
  for usage information.

contactless/
  Contactless devices are related to wireless devices.  They are not
  communication devices with other similar peers, but couplers/interfaces
  to contactless cards and tags.

crypto/
  Contains crypto drivers and support logic, including the /dev/urandom
  device.

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

i2s/
  I2S drivers and support logic.  See include/nuttx/audio/i2s.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.

pwm/
  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/timers/pwm.h for usage information.

sensors/
  Drivers for various sensors.  A sensor driver differs little from
  other types of drivers other than they are use to provide measurements
  of things in environment like temperature, 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.

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 include/nuttx/video/.

wireless/
  Drivers for various wireless devices.

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

Skeleton files are "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