Module Description
Driver for the hardware SPI port(s) available on XMEGA AVR microcontroller models. This module provides an easy to use driver for the setup and transfer of data over the AVR's SPI ports.
- 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.
#define SPI_ORDER_MSB_FIRST
Definition: SPI_AVR8.h:146
static void SPI_Init(const uint8_t SPIOptions)
Definition: SPI_AVR8.h:169
static void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE
Definition: SPI_AVR8.h:231
#define SPI_SAMPLE_TRAILING
Definition: SPI_AVR8.h:140
static uint8_t SPI_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT
Definition: SPI_AVR8.h:243
#define SPI_MODE_MASTER
Definition: SPI_AVR8.h:158
#define SPI_SPEED_FCPU_DIV_2
Definition: SPI_AVR8.h:104
#define SPI_SCK_LEAD_FALLING
Definition: SPI_AVR8.h:131
static uint8_t SPI_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE
Definition: SPI_AVR8.h:218
◆ SPI_MODE_MASTER
#define SPI_MODE_MASTER SPI_MASTER_bm |
SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into master mode.
◆ SPI_MODE_SLAVE
SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into slave mode.
◆ SPI_ORDER_LSB_FIRST
#define SPI_ORDER_LSB_FIRST SPI_DORD_bm |
SPI data order mask for SPI_Init(). Indicates that data should be shifted out LSB first.
◆ SPI_ORDER_MSB_FIRST
#define SPI_ORDER_MSB_FIRST 0 |
SPI data order mask for SPI_Init(). Indicates that data should be shifted out MSB first.
◆ SPI_SAMPLE_LEADING
#define SPI_SAMPLE_LEADING 0 |
SPI data sample mode mask for SPI_Init(). Indicates that the data should sampled on the leading edge.
◆ SPI_SAMPLE_TRAILING
#define SPI_SAMPLE_TRAILING SPI_MODE0_bm |
SPI data sample mode mask for SPI_Init(). Indicates that the data should be sampled on the trailing edge.
◆ SPI_SCK_LEAD_FALLING
#define SPI_SCK_LEAD_FALLING SPI_MODE1_bm |
SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the falling edge.
◆ SPI_SCK_LEAD_RISING
#define SPI_SCK_LEAD_RISING 0 |
SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the rising edge.
◆ SPI_SPEED_FCPU_DIV_128
#define SPI_SPEED_FCPU_DIV_128 (3 << SPI_PRESCALER_gp) |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 128.
◆ SPI_SPEED_FCPU_DIV_16
#define SPI_SPEED_FCPU_DIV_16 (1 << SPI_PRESCALER_gp) |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 16.
◆ SPI_SPEED_FCPU_DIV_2
#define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 2.
◆ SPI_SPEED_FCPU_DIV_32
#define SPI_SPEED_FCPU_DIV_32 (SPI_USE_DOUBLESPEED | (2 << SPI_PRESCALER_gp)) |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 32.
◆ SPI_SPEED_FCPU_DIV_4
#define SPI_SPEED_FCPU_DIV_4 0 |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 4.
◆ SPI_SPEED_FCPU_DIV_64
#define SPI_SPEED_FCPU_DIV_64 (2 << SPI_PRESCALER_gp) |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 64.
◆ SPI_SPEED_FCPU_DIV_8
#define SPI_SPEED_FCPU_DIV_8 (SPI_USE_DOUBLESPEED | (1 << SPI_PRESCALER_gp)) |
SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 8.
◆ SPI_Disable()
static void SPI_Disable |
( |
SPI_t *const |
SPI | ) |
|
|
inlinestatic |
Turns off the SPI driver, disabling and returning used hardware to their default configuration.
- Parameters
-
[in,out] | SPI | Pointer to the base of the SPI peripheral within the device. |
◆ SPI_GetCurrentMode()
static uint8_t SPI_GetCurrentMode |
( |
SPI_t *const |
SPI | ) |
|
|
inlinestatic |
Retrieves the currently selected SPI mode, once the SPI interface has been configured.
- Parameters
-
[in,out] | SPI | Pointer to the base of the SPI peripheral within the device. |
- Returns
- SPI_MODE_MASTER if the interface is currently in SPI Master mode, SPI_MODE_SLAVE otherwise
◆ SPI_Init()
static void SPI_Init |
( |
SPI_t *const |
SPI, |
|
|
const uint8_t |
SPIOptions |
|
) |
| |
|
inlinestatic |
Initializes the SPI subsystem, ready for transfers. Must be called before calling any other SPI routines.
- Parameters
-
[in,out] | SPI | Pointer to the base of the SPI peripheral within the device. |
[in] | SPIOptions | SPI Options, a mask consisting of one of each of the SPI_SPEED_* , SPI_SCK_* , SPI_SAMPLE_* , SPI_ORDER_* and SPI_MODE_* masks. |
◆ SPI_ReceiveByte()
static uint8_t SPI_ReceiveByte |
( |
SPI_t *const |
SPI | ) |
|
|
inlinestatic |
Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response byte from the attached SPI device is returned.
- Parameters
-
[in,out] | SPI | Pointer to the base of the SPI peripheral within the device. |
- Returns
- The response byte from the attached SPI device.
◆ SPI_SendByte()
static void SPI_SendByte |
( |
SPI_t *const |
SPI, |
|
|
const uint8_t |
Byte |
|
) |
| |
|
inlinestatic |
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.
- Parameters
-
[in,out] | SPI | Pointer to the base of the SPI peripheral within the device. |
[in] | Byte | Byte to send through the SPI interface. |
◆ SPI_TransferByte()
static uint8_t SPI_TransferByte |
( |
SPI_t *const |
SPI, |
|
|
const uint8_t |
Byte |
|
) |
| |
|
inlinestatic |
Sends and receives a byte through the SPI interface, blocking until the transfer is complete.
- Parameters
-
[in,out] | SPI | Pointer to the base of the SPI peripheral within the device. |
[in] | Byte | Byte to send through the SPI interface. |
- Returns
- Response byte from the attached SPI device.