Make twi capitalization match.

[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVR8 / SPI_AVR8.h

diff --git a/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h
index be5434e..1b8f53e 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2013.
+     Copyright (C) Dean Camera, 2014.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -40,7 +40,7 @@
 /** \ingroup Group_SPI
  *  \defgroup Group_SPI_AVR8 SPI Peripheral Driver (AVR8)
  *
 /** \ingroup Group_SPI
  *  \defgroup Group_SPI_AVR8 SPI Peripheral Driver (AVR8)
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_SPI_AVR8_ModDescription Module Description

  *  Driver for the hardware SPI port available on most 8-bit AVR microcontroller models. This
  *  module provides an easy to use driver for the setup and transfer of data over the
  *  AVR's SPI port.
  *  Driver for the hardware SPI port available on most 8-bit AVR microcontroller models. This
  *  module provides an easy to use driver for the setup and transfer of data over the
  *  AVR's SPI port.


@@ -48,7 +48,7 @@
  *  \note This file should not be included directly. It is automatically included as needed by the SPI driver
  *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.
  *
  *  \note This file should not be included directly. It is automatically included as needed by the SPI driver
  *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.
  *

- *  \section Sec_ExampleUsage Example Usage
+ *  \section Sec_SPI_AVR8_ExampleUsage Example Usage

  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *


@@ -56,17 +56,17 @@
  *      // Initialize the SPI driver before first use
  *      SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
  *               SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
  *      // Initialize the SPI driver before first use
  *      SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
  *               SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);

- *      
+ *

  *      // Send several bytes, ignoring the returned data
  *      SPI_SendByte(0x01);
  *      SPI_SendByte(0x02);
  *      SPI_SendByte(0x03);
  *      // Send several bytes, ignoring the returned data
  *      SPI_SendByte(0x01);
  *      SPI_SendByte(0x02);
  *      SPI_SendByte(0x03);

- *      
+ *

  *      // Receive several bytes, sending a dummy 0x00 byte each time
  *      uint8_t Byte1 = SPI_ReceiveByte();
  *      uint8_t Byte2 = SPI_ReceiveByte();
  *      uint8_t Byte3 = SPI_ReceiveByte();
  *      // Receive several bytes, sending a dummy 0x00 byte each time
  *      uint8_t Byte1 = SPI_ReceiveByte();
  *      uint8_t Byte2 = SPI_ReceiveByte();
  *      uint8_t Byte3 = SPI_ReceiveByte();

- *      
+ *

  *      // Send a byte, and store the received byte from the same transaction
  *      uint8_t ResponseByte = SPI_TransferByte(0xDC);
  *  \endcode
  *      // Send a byte, and store the received byte from the same transaction
  *      uint8_t ResponseByte = SPI_TransferByte(0xDC);
  *  \endcode


@@ -165,6 +165,7 @@
                         *  \param[in] SPIOptions  SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*,
                         *                         \c SPI_SCK_*, \c SPI_SAMPLE_*, \c SPI_ORDER_* and \c SPI_MODE_* masks.
                         */
                         *  \param[in] SPIOptions  SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*,
                         *                         \c SPI_SCK_*, \c SPI_SAMPLE_*, \c SPI_ORDER_* and \c SPI_MODE_* masks.
                         */

+                       static inline void SPI_Init(const uint8_t SPIOptions);

                        static inline void SPI_Init(const uint8_t SPIOptions)
                        {
                                /* Prevent high rise times on PB.0 (/SS) from forcing a change to SPI slave mode */
                        static inline void SPI_Init(const uint8_t SPIOptions)
                        {
                                /* Prevent high rise times on PB.0 (/SS) from forcing a change to SPI slave mode */


@@ -187,6 +188,7 @@
                        }
 
                        /** Turns off the SPI driver, disabling and returning used hardware to their default configuration. */
                        }
 
                        /** Turns off the SPI driver, disabling and returning used hardware to their default configuration. */

+                       static inline void SPI_Disable(void);

                        static inline void SPI_Disable(void)
                        {
                                DDRB  &= ~((1 << 1) | (1 << 2));
                        static inline void SPI_Disable(void)
                        {
                                DDRB  &= ~((1 << 1) | (1 << 2));