summaryrefslogtreecommitdiffstats
path: root/bsp-howto
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2016-12-20 11:07:29 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2016-12-21 11:34:13 +0100
commit0cb2748a11ecdbeb96a40a60a3039dad99da2937 (patch)
tree8fd25eacc24556af50713134ecdd6ef0d95276fc /bsp-howto
parent45dc7c7ba57afec2a4f73fdd5453cacc5e7a8560 (diff)
downloadrtems-docs-0cb2748a11ecdbeb96a40a60a3039dad99da2937.tar.bz2
Document SPI framework
Update #2776.
Diffstat (limited to 'bsp-howto')
-rw-r--r--bsp-howto/index.rst1
-rw-r--r--bsp-howto/spi.rst19
2 files changed, 20 insertions, 0 deletions
diff --git a/bsp-howto/index.rst b/bsp-howto/index.rst
index 71c5e1b..f1c3a4e 100644
--- a/bsp-howto/index.rst
+++ b/bsp-howto/index.rst
@@ -47,6 +47,7 @@ to the Community Project hosted at http://www.rtems.org.
initilization_code
console
clock
+ spi
timer
real_time_clock
ata
diff --git a/bsp-howto/spi.rst b/bsp-howto/spi.rst
new file mode 100644
index 0000000..5a6d931
--- /dev/null
+++ b/bsp-howto/spi.rst
@@ -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>`_.