From 0cb2748a11ecdbeb96a40a60a3039dad99da2937 Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Tue, 20 Dec 2016 11:07:29 +0100
Subject: Document SPI framework

Update #2776.
---
 bsp-howto/index.rst |  1 +
 bsp-howto/spi.rst   | 19 +++++++++++++++++++
 2 files changed, 20 insertions(+)
 create mode 100644 bsp-howto/spi.rst

(limited to 'bsp-howto')

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>`_.
-- 
cgit v1.2.3