X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/f45d60f768f438502910fd9fe7cac094c05bca74..0a00ee403732be3925bf68c755823b93dfb3169d:/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 1d28d309d..a21ac1ca8 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h @@ -97,61 +97,61 @@ /* 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 << 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) - /** 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)) - /** 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) - /** 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 */ //@{ - /** 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 - /** 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 */ //@{ - /** 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 - /** 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 */ //@{ - /** 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 - /** 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 */ //@{ - /** 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 - /** 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 //@} @@ -159,9 +159,9 @@ /** 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(SPI_t* const SPI, const uint8_t SPIOptions) @@ -171,7 +171,7 @@ /** 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(SPI_t* const SPI) { @@ -180,7 +180,7 @@ /** 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 */ @@ -192,8 +192,8 @@ /** 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. */ @@ -210,8 +210,8 @@ /** 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(SPI_t* const SPI, const uint8_t Byte) ATTR_ALWAYS_INLINE; @@ -225,7 +225,7 @@ /** 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. */