Serial Peripheral Interface Slave with EasyDMA (SPIS) driver.
More...
Serial Peripheral Interface Slave with EasyDMA (SPIS) driver.
◆ NRFX_SPIS_DEFAULT_CONFIG
#define NRFX_SPIS_DEFAULT_CONFIG |
( |
|
_pin_sck, |
|
|
|
_pin_mosi, |
|
|
|
_pin_miso, |
|
|
|
_pin_csn |
|
) |
| |
Value:{ \
.miso_pin = _pin_miso, \
.mosi_pin = _pin_mosi, \
.sck_pin = _pin_sck, \
.csn_pin = _pin_csn, \
.def = 0xFF, \
.orc = 0xFE, \
.skip_gpio_cfg = false, \
.skip_psel_cfg = false, \
}
@ NRF_GPIO_PIN_NOPULL
Pin pull-up resistor disabled.
Definition: nrf_gpio.h:161
@ NRF_GPIO_PIN_S0S1
Standard '0', standard '1'.
Definition: nrf_gpio.h:170
@ NRF_SPIS_BIT_ORDER_MSB_FIRST
Most significant bit shifted out first.
Definition: nrf_spis.h:168
@ NRF_SPIS_MODE_0
SCK active high, sample on leading edge of clock.
Definition: nrf_spis.h:159
#define NRFX_SPIS_DEFAULT_CONFIG_IRQ_PRIORITY
Interrupt priority.
Definition: nrfx_spis_dox_config.h:53
SPIS driver default configuration.
This configuration sets up SPIS with the following options:
- mode: 0 (SCK active high, sample on leading edge of the clock signal)
- MSB shifted out first
- CSN pull-up disabled
- MISO pin drive set to standard '0' and standard '1'
- default character set to 0xFF
- over-read character set to 0xFE
- Parameters
-
[in] | _pin_sck | SCK pin. |
[in] | _pin_mosi | MOSI pin. |
[in] | _pin_miso | MISO pin. |
[in] | _pin_csn | CSN pin. |
◆ NRFX_SPIS_INST_HANDLER_GET
#define NRFX_SPIS_INST_HANDLER_GET |
( |
|
idx | ) |
NRFX_CONCAT_3(nrfx_spis_, idx, _irq_handler) |
Macro returning SPIS interrupt handler.
param[in] idx SPIS index.
- Returns
- Interrupt handler.
◆ NRFX_SPIS_INSTANCE
#define NRFX_SPIS_INSTANCE |
( |
|
id | ) |
|
Value:{ \
}
#define NRFX_CONCAT_2(p1, p2)
Macro for concatenating two tokens in macro expansion.
Definition: nrfx_common.h:134
#define NRFX_CONCAT_3(p1, p2, p3)
Macro for concatenating three tokens in macro expansion.
Definition: nrfx_common.h:155
Macro for creating an instance of the SPI slave driver.
◆ nrfx_spis_event_handler_t
typedef void(* nrfx_spis_event_handler_t) (nrfx_spis_evt_t const *p_event, void *p_context) |
SPI slave driver event handler type.
- Parameters
-
[in] | p_event | Pointer to the event structure. The structure is allocated on the stack so it is valid only until the event handler returns. |
[in] | p_context | Context set on initialization. |
◆ nrfx_spis_evt_type_t
SPI slave driver event types.
Enumerator |
---|
NRFX_SPIS_BUFFERS_SET_DONE | Memory buffer set event. Memory buffers have been set successfully to the SPI slave device, and SPI transaction can be done.
|
NRFX_SPIS_XFER_DONE | SPI transaction event. SPI transaction has been completed.
|
NRFX_SPIS_EVT_TYPE_MAX | Enumeration upper bound.
|
◆ nrfx_spis_buffers_set()
nrfx_err_t nrfx_spis_buffers_set |
( |
nrfx_spis_t const * |
p_instance, |
|
|
uint8_t const * |
p_tx_buffer, |
|
|
size_t |
tx_buffer_length, |
|
|
uint8_t * |
p_rx_buffer, |
|
|
size_t |
rx_buffer_length |
|
) |
| |
Function for preparing the SPI slave instance for a single SPI transaction.
This function prepares the SPI slave device to be ready for a single SPI transaction. It configures the SPI slave device to use the memory supplied with the function call in SPI transactions.
When either the memory buffer configuration or the SPI transaction has been completed, the event callback function will be called with the appropriate event nrfx_spis_evt_type_t. The callback function can be called before returning from this function, because it is called from the SPI slave interrupt context.
- Note
- This function can be called from the callback function context.
-
Client applications must call this function after every NRFX_SPIS_XFER_DONE event if the SPI slave driver must be prepared for a possible new SPI transaction.
-
Peripherals using EasyDMA (including SPIS) require the transfer buffers to be placed in the Data RAM region. If this condition is not met, this function will fail with the error code NRFX_ERROR_INVALID_ADDR.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_tx_buffer | Pointer to the TX buffer. Can be NULL when the buffer length is zero. |
[in] | p_rx_buffer | Pointer to the RX buffer. Can be NULL when the buffer length is zero. |
[in] | tx_buffer_length | Length of the TX buffer in bytes. |
[in] | rx_buffer_length | Length of the RX buffer in bytes. |
- Return values
-
NRFX_SUCCESS | The operation was successful. |
NRFX_ERROR_INVALID_STATE | The operation failed because the SPI slave device is in an incorrect state. |
NRFX_ERROR_INVALID_ADDR | The provided buffers are not placed in the Data RAM region. |
NRFX_ERROR_INVALID_LENGTH | Provided lengths exceed the EasyDMA limits for the peripheral. |
NRFX_ERROR_INTERNAL | The operation failed because of an internal error. |
◆ nrfx_spis_init()
Function for initializing the SPI slave driver instance.
- Note
- When the nRF52 Anomaly 109 workaround for SPIS is enabled, this function initializes the GPIOTE driver as well, and uses one of GPIOTE channels to detect falling edges on CSN pin.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_config | Pointer to the structure with the initial configuration. |
[in] | event_handler | Function to be called by the SPI slave driver upon event. Must not be NULL. |
[in] | p_context | Context passed to the event handler. |
- Return values
-
NRFX_SUCCESS | The initialization was successful. |
NRFX_ERROR_ALREADY | The driver is already initialized. |
NRFX_ERROR_INVALID_STATE | The driver is already initialized. Deprecated - use NRFX_ERROR_ALREADY instead. |
NRFX_ERROR_INVALID_PARAM | Invalid parameter is supplied. |
NRFX_ERROR_BUSY | Some other peripheral with the same instance ID is already in use. This is possible only if Peripheral Resource Sharing (PRS) module is enabled. |
NRFX_ERROR_INTERNAL | GPIOTE channel for detecting falling edges on CSN pin cannot be initialized. Possible only when using nRF52 Anomaly 109 workaround. |
◆ nrfx_spis_init_check()
bool nrfx_spis_init_check |
( |
nrfx_spis_t const * |
p_instance | ) |
|
Function for checking if the SPIS driver instance is initialized.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
- Return values
-
true | Instance is already initialized. |
false | Instance is not initialized. |
◆ nrfx_spis_reconfigure()
Function for reconfiguring the SPI slave driver instance.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_config | Pointer to the structure with the configuration. |
- Return values
-
NRFX_SUCCESS | Reconfiguration was successful. |
NRFX_ERROR_BUSY | The driver is during transfer. |
NRFX_ERROR_INVALID_STATE | The driver is uninitialized. |
◆ nrfx_spis_uninit()
void nrfx_spis_uninit |
( |
nrfx_spis_t const * |
p_instance | ) |
|
Function for uninitializing the SPI slave driver instance.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |