Make SPI and USART peripheral dispatch driver headers in preparation for a set of...

[pub/lufa.git] / LUFA / Drivers / Peripheral / AVRU4U6U7 / SPI.h

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
index 25503b6..3440cc9 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
@@ -30,29 +30,34 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

- *  Hardware SPI subsystem driver for the supported USB AVRs models.\r
+ *  SPI driver for the 8-bit AVRs.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the SPI driver\r
+ *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.\r

  */\r
  */\r

-\r
-/** \ingroup Group_PeripheralDrivers\r
- *  @defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h\r
+ \r
+/** \ingroup Group_SPI\r
+ *  @defgroup Group_SPI_AVR8 8-Bit AVR SPI Driver\r

  *\r
  *\r

- *  \section Sec_Dependencies Module Source Dependencies\r
- *  The following files must be built with any user project that uses this module:\r
- *    - None\r
+ *  SPI driver for the 8-bit AVRs.\r

  *\r
  *\r

- *  \section Module Description\r
- *  Driver for the hardware SPI port available on most AVR models. This module provides\r
- *  an easy to use driver for the setup of and transfer of data over the AVR's SPI port.\r
+ *  \note This file should not be included directly. It is automatically included as needed by the ADC driver\r
+ *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.\r

  *\r
  *  @{\r
  */\r
 \r
  *\r
  *  @{\r
  */\r
 \r

-#ifndef __SPI_H__\r
-#define __SPI_H__\r
+#ifndef __SPI_AVR8_H__\r
+#define __SPI_AVR8_H__\r

 \r
        /* Includes: */\r
                #include <stdbool.h>\r
 \r
 \r
        /* Includes: */\r
                #include <stdbool.h>\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_SPI_H)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Peripheral/SPI.h instead.\r
+               #endif\r
+\r

        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r