Document SPI framework

Update #2776.
This commit is contained in:
Sebastian Huber 2016-12-20 11:07:29 +01:00
parent 45dc7c7ba5
commit 0cb2748a11
2 changed files with 20 additions and 0 deletions

View File

@ -47,6 +47,7 @@ to the Community Project hosted at http://www.rtems.org.
initilization_code initilization_code
console console
clock clock
spi
timer timer
real_time_clock real_time_clock
ata ata

19
bsp-howto/spi.rst Normal file
View File

@ -0,0 +1,19 @@
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
.. COMMENT: Copyright (c) 2016 embedded brains GmbH <rtems@embedded-brains.de>
.. COMMENT: All rights reserved.
SPI Driver
**********
The Serial Peripheral Interface (SPI) bus drivers should use the
`SPI bus framework
<https://git.rtems.org/rtems/tree/cpukit/dev/include/dev/spi/spi.h>`_.
For
example drivers see the
`Atmel SAM SPI driver <https://git.rtems.org/rtems/tree/c/src/lib/libbsp/arm/atsam/spi/atsam_spi_bus.c>`_
and the
`SPI framework test <https://git.rtems.org/rtems/tree/testsuites/libtests/spi01/init.c>`_.
The user API is compatible to the
`Linux SPI user-space API <https://www.kernel.org/doc/Documentation/spi/spidev>`_.