SPI peripheral driver.
More...
|
#define | NRFX_SPI_INSTANCE(id) |
| Macro for creating an SPI master driver instance. More...
|
|
#define | NRFX_SPI_PIN_NOT_USED 0xFF |
| This value can be provided instead of a pin number for signals MOSI, MISO, and Slave Select to specify that the given signal is not used and therefore does not need to be connected to a pin.
|
|
#define | NRFX_SPI_DEFAULT_CONFIG |
| SPI master instance default configuration. More...
|
|
#define | NRFX_SPI_SINGLE_XFER(p_tx, tx_len, p_rx, rx_len) |
| Macro for setting up single transfer descriptor. More...
|
|
#define | NRFX_SPI_XFER_TRX(p_tx_buf, tx_length, p_rx_buf, rx_length) NRFX_SPI_SINGLE_XFER(p_tx_buf, tx_length, p_rx_buf, rx_length) |
| Macro for setting duplex TX RX transfer.
|
|
#define | NRFX_SPI_XFER_TX(p_buf, length) NRFX_SPI_SINGLE_XFER(p_buf, length, NULL, 0) |
| Macro for setting TX transfer.
|
|
#define | NRFX_SPI_XFER_RX(p_buf, length) NRFX_SPI_SINGLE_XFER(NULL, 0, p_buf, length) |
| Macro for setting RX transfer.
|
|
SPI peripheral driver.
#define NRFX_SPI_DEFAULT_CONFIG |
Value:
SPI master instance default configuration.
#define NRFX_SPI_INSTANCE |
( |
|
id | ) |
|
Value:
Macro for creating an SPI master driver instance.
#define NRFX_SPI_SINGLE_XFER |
( |
|
p_tx, |
|
|
|
tx_len, |
|
|
|
p_rx, |
|
|
|
rx_len |
|
) |
| |
Value:{ \
.p_tx_buffer = (uint8_t const *)(p_tx), \
.tx_length = (tx_len), \
.p_rx_buffer = (p_rx), \
.rx_length = (rx_len), \
}
Macro for setting up single transfer descriptor.
This macro is for internal use only.
SPI master driver event types, passed to the handler routine provided during initialization.
Enumerator |
---|
NRFX_SPI_EVENT_DONE |
Transfer done.
|
void nrfx_spi_abort |
( |
nrfx_spi_t const * |
p_instance | ) |
|
Function for aborting ongoing transfer.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
Function for initializing the SPI master driver instance.
This function configures and enables the specified peripheral.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_config | Pointer to the structure with initial configuration. |
| handler | Event handler provided by the user. If NULL, transfers will be performed in blocking mode. |
| p_context | Context passed to event handler. |
- Return values
-
NRFX_SUCCESS | If initialization was successful. |
NRFX_ERROR_INVALID_STATE | If the driver was already initialized. |
NRFX_ERROR_BUSY | If some other peripheral with the same instance ID is already in use. This is possible only if Peripheral Resource Sharing (PRS) module is enabled. |
void nrfx_spi_uninit |
( |
nrfx_spi_t const *const |
p_instance | ) |
|
Function for uninitializing the SPI master driver instance.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
Function for starting the SPI data transfer.
If an event handler was provided in the nrfx_spi_init call, this function returns immediately and the handler is called when the transfer is done. Otherwise, the transfer is performed in blocking mode, which means that this function returns when the transfer is finished.
- Parameters
-
p_instance | Pointer to the driver instance structure. |
p_xfer_desc | Pointer to the transfer descriptor. |
flags | Transfer options (0 for default settings). Currently, no additional flags are available. |
- Return values
-
NRFX_SUCCESS | If the procedure was successful. |
NRFX_ERROR_BUSY | If the driver is not ready for a new transfer. |
NRFX_ERROR_NOT_SUPPORTED | If the provided parameters are not supported. |