Minor tweaks to the build tests to ensure that they will operate properly on all...

[pub/USBasp.git] / LUFA / Drivers / Peripheral / XMEGA / SPI_XMEGA.h

diff --git a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h
index 0fe7142..a21ac1c 100644 (file)
--- a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h
+++ b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -97,61 +97,61 @@
                /* Macros: */
                        /** \name SPI Prescaler Configuration Masks */
                        //@{
                /* 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
 
                        #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
 
                        #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 << SPI_PRESCALER_gp))
 
                        #define SPI_SPEED_FCPU_DIV_8           (SPI_USE_DOUBLESPEED | (1 << SPI_PRESCALER_gp))
 

-                       /** 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 << SPI_PRESCALER_gp)
 
                        #define SPI_SPEED_FCPU_DIV_16          (1 << SPI_PRESCALER_gp)
 

-                       /** 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 | (2 << SPI_PRESCALER_gp))
 
                        #define SPI_SPEED_FCPU_DIV_32          (SPI_USE_DOUBLESPEED | (2 << SPI_PRESCALER_gp))
 

-                       /** 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          (2 << SPI_PRESCALER_gp)
 
                        #define SPI_SPEED_FCPU_DIV_64          (2 << SPI_PRESCALER_gp)
 

-                       /** 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         (3 << SPI_PRESCALER_gp)
                        //@}
 
                        /** \name SPI SCK Polarity Configuration Masks */
                        //@{
                        #define SPI_SPEED_FCPU_DIV_128         (3 << SPI_PRESCALER_gp)
                        //@}
 
                        /** \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
 
                        #define SPI_SCK_LEAD_RISING            0
 

-                       /** 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           SPI_MODE1_bm
                        //@}
 
                        /** \name SPI Sample Edge Configuration Masks */
                        //@{
                        #define SPI_SCK_LEAD_FALLING           SPI_MODE1_bm
                        //@}
 
                        /** \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
 
                        #define SPI_SAMPLE_LEADING             0
 

-                       /** 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            SPI_MODE0_bm
                        //@}
 
                        /** \name SPI Data Ordering Configuration Masks */
                        //@{
                        #define SPI_SAMPLE_TRAILING            SPI_MODE0_bm
                        //@}
 
                        /** \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
 
                        #define SPI_ORDER_MSB_FIRST            0
 

-                       /** 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            SPI_DORD_bm
                        //@}
 
                        /** \name SPI Mode Configuration Masks */
                        //@{
                        #define SPI_ORDER_LSB_FIRST            SPI_DORD_bm
                        //@}
 
                        /** \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
 
                        #define SPI_MODE_SLAVE                 0
 

-                       /** 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                SPI_MASTER_bm
                        //@}
 
                        #define SPI_MODE_MASTER                SPI_MASTER_bm
                        //@}
 


@@ -159,11 +159,11 @@
                        /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other
                         *  SPI routines.
                         *
                        /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other
                         *  SPI routines.
                         *

-                        *  \param[in, out] SPI         Pointer to the base of the SPI peripheral within the device.
-                        *  \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,out] SPI         Pointer to the base of the SPI peripheral within the device.
+                        *  \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 SPI_t* SPI,
+                       static inline void SPI_Init(SPI_t* const SPI,

                                                    const uint8_t SPIOptions)
                        {
                                SPI->CTRL = (SPIOptions | SPI_ENABLE_bm);
                                                    const uint8_t SPIOptions)
                        {
                                SPI->CTRL = (SPIOptions | SPI_ENABLE_bm);


@@ -171,35 +171,35 @@
 
                        /** 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.
                         *

-                        *  \param[in, out] SPI Pointer to the base of the SPI peripheral within the device.
+                        *  \param[in,out] SPI   Pointer to the base of the SPI peripheral within the device.

                         */
                         */

-                       static inline void SPI_Disable(const SPI_t* SPI)
+                       static inline void SPI_Disable(SPI_t* const SPI)

                        {
                                SPI->CTRL &= ~SPI_ENABLE_bm;
                        }
 
                        /** Retrieves the currently selected SPI mode, once the SPI interface has been configured.
                         *
                        {
                                SPI->CTRL &= ~SPI_ENABLE_bm;
                        }
 
                        /** Retrieves the currently selected SPI mode, once the SPI interface has been configured.
                         *

-                        *  \param[in, out] SPI         Pointer to the base of the SPI peripheral within the device.
+                        *  \param[in,out] SPI  Pointer to the base of the SPI peripheral within the device.

                         *
                         *  \return \ref SPI_MODE_MASTER if the interface is currently in SPI Master mode, \ref SPI_MODE_SLAVE otherwise
                         */
                         *
                         *  \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(const SPI_t* SPI) ATTR_ALWAYS_INLINE;
-                       static inline uint8_t SPI_GetCurrentMode(const SPI_t* SPI)
+                       static inline uint8_t SPI_GetCurrentMode(SPI_t* const SPI) ATTR_ALWAYS_INLINE;
+                       static inline uint8_t SPI_GetCurrentMode(SPI_t* const SPI)

                        {
                                return (SPI->CTRL & SPI_MASTER_bm);
                        }
 
                        /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.
                         *
                        {
                                return (SPI->CTRL & SPI_MASTER_bm);
                        }
 
                        /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.
                         *

-                        *  \param[in, out] SPI   Pointer to the base of the SPI peripheral within the device.
-                        *  \param[in]      Byte  Byte to send through the SPI interface.
+                        *  \param[in,out] SPI   Pointer to the base of the SPI peripheral within the device.
+                        *  \param[in]     Byte  Byte to send through the SPI interface.

                         *
                         *  \return Response byte from the attached SPI device.
                         */
                         *
                         *  \return Response byte from the attached SPI device.
                         */

-                       static inline uint8_t SPI_TransferByte(const SPI_t* SPI,
+                       static inline uint8_t SPI_TransferByte(SPI_t* const SPI,

                                                               const uint8_t Byte) ATTR_ALWAYS_INLINE;
                                                               const uint8_t Byte) ATTR_ALWAYS_INLINE;

-                       static inline uint8_t SPI_TransferByte(const SPI_t* SPI,
+                       static inline uint8_t SPI_TransferByte(SPI_t* const SPI,

                                                               const uint8_t Byte)
                        {
                                SPI->DATA = Byte;
                                                               const uint8_t Byte)
                        {
                                SPI->DATA = Byte;


@@ -210,12 +210,12 @@
                        /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response
                         *  byte sent to from the attached SPI device is ignored.
                         *
                        /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response
                         *  byte sent to from the attached SPI device is ignored.
                         *

-                        *  \param[in, out] SPI   Pointer to the base of the SPI peripheral within the device.
-                        *  \param[in]      Byte  Byte to send through the SPI interface.
+                        *  \param[in,out] SPI   Pointer to the base of the SPI peripheral within the device.
+                        *  \param[in]     Byte  Byte to send through the SPI interface.

                         */
                         */

-                       static inline void SPI_SendByte(const SPI_t* SPI,
+                       static inline void SPI_SendByte(SPI_t* const SPI,

                                                        const uint8_t Byte) ATTR_ALWAYS_INLINE;
                                                        const uint8_t Byte) ATTR_ALWAYS_INLINE;

-                       static inline void SPI_SendByte(const SPI_t* SPI,
+                       static inline void SPI_SendByte(SPI_t* const SPI,

                                                        const uint8_t Byte)
                        {
                                SPI->DATA = Byte;
                                                        const uint8_t Byte)
                        {
                                SPI->DATA = Byte;


@@ -225,12 +225,12 @@
                        /** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response
                         *  byte from the attached SPI device is returned.
                         *
                        /** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response
                         *  byte from the attached SPI device is returned.
                         *

-                        *  \param[in, out] SPI  Pointer to the base of the SPI peripheral within the device.
+                        *  \param[in,out] SPI  Pointer to the base of the SPI peripheral within the device.

                         *
                         *  \return The response byte from the attached SPI device.
                         */
                         *
                         *  \return The response byte from the attached SPI device.
                         */

-                       static inline uint8_t SPI_ReceiveByte(const SPI_t* SPI) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
-                       static inline uint8_t SPI_ReceiveByte(const SPI_t* SPI)
+                       static inline uint8_t SPI_ReceiveByte(SPI_t* const SPI) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
+                       static inline uint8_t SPI_ReceiveByte(SPI_t* const SPI)

                        {
                                SPI->DATA = 0;
                                while (!(SPI->STATUS & SPI_IF_bm));
                        {
                                SPI->DATA = 0;
                                while (!(SPI->STATUS & SPI_IF_bm));