Minor documentation adjustments to the demos, projects and bootloaders to ensure...
[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVR8 / SPI_AVR8.h
index fd42c50..2e396ed 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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
@@ -70,7 +70,7 @@
  *      // Send a byte, and store the received byte from the same transaction
  *      uint8_t ResponseByte = SPI_TransferByte(0xDC);
  *  \endcode
- * 
+ *
  *  @{
  */
 
                /* Macros: */
                        /** \name SPI Prescaler Configuration Masks */
                        //@{
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 2. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 2. */
                        #define SPI_SPEED_FCPU_DIV_2           SPI_USE_DOUBLESPEED
 
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 4. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 4. */
                        #define SPI_SPEED_FCPU_DIV_4           0
 
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 8. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 8. */
                        #define SPI_SPEED_FCPU_DIV_8           (SPI_USE_DOUBLESPEED | (1 << SPR0))
 
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 16. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 16. */
                        #define SPI_SPEED_FCPU_DIV_16          (1 << SPR0)
 
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 32. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 32. */
                        #define SPI_SPEED_FCPU_DIV_32          (SPI_USE_DOUBLESPEED | (1 << SPR1))
 
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 64. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 64. */
                        #define SPI_SPEED_FCPU_DIV_64          (SPI_USE_DOUBLESPEED | (1 << SPR1) | (1 << SPR0))
 
-                       /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 128. */
+                       /** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 128. */
                        #define SPI_SPEED_FCPU_DIV_128         ((1 << SPR1) | (1 << SPR0))
                        //@}
 
                        /** \name SPI SCK Polarity Configuration Masks */
                        //@{
-                       /** SPI clock polarity mask for \c SPI_Init(). Indicates that the SCK should lead on the rising edge. */
+                       /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the rising edge. */
                        #define SPI_SCK_LEAD_RISING            (0 << CPOL)
 
-                       /** SPI clock polarity mask for \c SPI_Init(). Indicates that the SCK should lead on the falling edge. */
+                       /** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the falling edge. */
                        #define SPI_SCK_LEAD_FALLING           (1 << CPOL)
                        //@}
 
                        /** \name SPI Sample Edge Configuration Masks */
                        //@{
-                       /** SPI data sample mode mask for \c SPI_Init(). Indicates that the data should sampled on the leading edge. */
+                       /** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should sampled on the leading edge. */
                        #define SPI_SAMPLE_LEADING             (0 << CPHA)
 
-                       /** SPI data sample mode mask for \c SPI_Init(). Indicates that the data should be sampled on the trailing edge. */
+                       /** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should be sampled on the trailing edge. */
                        #define SPI_SAMPLE_TRAILING            (1 << CPHA)
                        //@}
-                       
+
                        /** \name SPI Data Ordering Configuration Masks */
                        //@{
-                       /** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */
+                       /** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out MSB first. */
                        #define SPI_ORDER_MSB_FIRST            (0 << DORD)
 
-                       /** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out LSB first. */
+                       /** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out LSB first. */
                        #define SPI_ORDER_LSB_FIRST            (1 << DORD)
                        //@}
-                       
+
                        /** \name SPI Mode Configuration Masks */
                        //@{
-                       /** SPI mode mask for \c SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */
+                       /** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */
                        #define SPI_MODE_SLAVE                 (0 << MSTR)
 
-                       /** SPI mode mask for \c SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */
+                       /** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */
                        #define SPI_MODE_MASTER                (1 << MSTR)
                        //@}
-                       
+
                /* Inline Functions: */
                        /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other
                         *  SPI routines.
                                SPCR   = 0;
                                SPSR   = 0;
                        }
-                       
+
                        /** Retrieves the currently selected SPI mode, once the SPI interface has been configured.
                         *
                         *  \return \ref SPI_MODE_MASTER if the interface is currently in SPI Master mode, \ref SPI_MODE_SLAVE otherwise
                         */
+                       static inline uint8_t SPI_GetCurrentMode(void) ATTR_ALWAYS_INLINE;
                        static inline uint8_t SPI_GetCurrentMode(void)
                        {
                                return (SPCR & SPI_MODE_MASTER);