Two Wire Interface Slave with EasyDMA (TWIS) peripheral driver. More...
Modules | |
TWIS peripheral driver configuration | |
Data Structures | |
struct | nrfx_twis_t |
TWIS driver instance data structure. More... | |
struct | nrfx_twis_evt_t |
TWIS driver event structure. More... | |
struct | nrfx_twis_config_t |
Structure for TWIS configuration. More... | |
Macros | |
#define | NRFX_TWIS_INSTANCE(id) |
Macro for creating a TWIS driver instance. | |
#define | NRFX_TWIS_DEFAULT_CONFIG(_pin_scl, _pin_sda, _addr) |
TWIS driver default configuration. | |
#define | NRFX_TWIS_INST_HANDLER_GET(idx) NRFX_CONCAT_3(nrfx_twis_, idx, _irq_handler) |
Macro returning TWIS interrupt handler. | |
Typedefs | |
typedef void(* | nrfx_twis_event_handler_t) (nrfx_twis_evt_t const *p_event) |
TWI slave event callback function type. | |
Enumerations | |
enum | nrfx_twis_evt_type_t { NRFX_TWIS_EVT_READ_REQ , NRFX_TWIS_EVT_READ_DONE , NRFX_TWIS_EVT_READ_ERROR , NRFX_TWIS_EVT_WRITE_REQ , NRFX_TWIS_EVT_WRITE_DONE , NRFX_TWIS_EVT_WRITE_ERROR , NRFX_TWIS_EVT_GENERAL_ERROR } |
Event callback function event definitions. More... | |
enum | nrfx_twis_error_t { NRFX_TWIS_ERROR_OVERFLOW = NRF_TWIS_ERROR_OVERFLOW , NRFX_TWIS_ERROR_DATA_NACK = NRF_TWIS_ERROR_DATA_NACK , NRFX_TWIS_ERROR_OVERREAD = NRF_TWIS_ERROR_OVERREAD , NRFX_TWIS_ERROR_UNEXPECTED_EVENT = 1 << 8 } |
Possible error sources. More... | |
Functions | |
nrfx_err_t | nrfx_twis_init (nrfx_twis_t const *p_instance, nrfx_twis_config_t const *p_config, nrfx_twis_event_handler_t event_handler) |
Function for initializing the TWIS driver instance. | |
nrfx_err_t | nrfx_twis_reconfigure (nrfx_twis_t const *p_instance, nrfx_twis_config_t const *p_config) |
Function for reconfiguring the TWIS driver instance. | |
void | nrfx_twis_uninit (nrfx_twis_t const *p_instance) |
Function for uninitializing the TWIS driver instance. | |
bool | nrfx_twis_init_check (nrfx_twis_t const *p_instance) |
Function for checking if the TWIS driver instance is initialized. | |
void | nrfx_twis_enable (nrfx_twis_t const *p_instance) |
Function for enabling the TWIS instance. | |
void | nrfx_twis_disable (nrfx_twis_t const *p_instance) |
Function for disabling the TWIS instance. | |
uint32_t | nrfx_twis_error_get_and_clear (nrfx_twis_t const *p_instance) |
Function for getting and clearing the last error flags. | |
nrfx_err_t | nrfx_twis_tx_prepare (nrfx_twis_t const *p_instance, void const *p_buf, size_t size) |
Function for preparing the data for sending. | |
NRFX_STATIC_INLINE size_t | nrfx_twis_tx_amount (nrfx_twis_t const *p_instance) |
Function for getting the number of transmitted bytes. | |
nrfx_err_t | nrfx_twis_rx_prepare (nrfx_twis_t const *p_instance, void *p_buf, size_t size) |
Function for preparing the data for receiving. | |
NRFX_STATIC_INLINE size_t | nrfx_twis_rx_amount (nrfx_twis_t const *p_instance) |
Function for getting the number of received bytes. | |
bool | nrfx_twis_is_busy (nrfx_twis_t const *p_instance) |
Function for checking if the driver is busy right now. | |
bool | nrfx_twis_is_waiting_tx_buff (nrfx_twis_t const *p_instance) |
Function for checking if the driver is waiting for a TX buffer. | |
bool | nrfx_twis_is_waiting_rx_buff (nrfx_twis_t const *p_instance) |
Function for checking if the driver is waiting for an RX buffer. | |
bool | nrfx_twis_is_pending_tx (nrfx_twis_t const *p_instance) |
Function for checking if the driver is sending data. | |
bool | nrfx_twis_is_pending_rx (nrfx_twis_t const *p_instance) |
Function for checking if the driver is receiving data. | |
Two Wire Interface Slave with EasyDMA (TWIS) peripheral driver.
#define NRFX_TWIS_DEFAULT_CONFIG | ( | _pin_scl, | |
_pin_sda, | |||
_addr | |||
) |
TWIS driver default configuration.
This configuration sets up TWIS with the following options:
[in] | _pin_scl | SCL pin. |
[in] | _pin_sda | SDA pin. |
[in] | _addr | Slave address on TWI bus. |
#define NRFX_TWIS_INST_HANDLER_GET | ( | idx | ) | NRFX_CONCAT_3(nrfx_twis_, idx, _irq_handler) |
Macro returning TWIS interrupt handler.
param[in] idx TWIS index.
#define NRFX_TWIS_INSTANCE | ( | id | ) |
Macro for creating a TWIS driver instance.
typedef void(* nrfx_twis_event_handler_t) (nrfx_twis_evt_t const *p_event) |
TWI slave event callback function type.
[in] | p_event | Event information structure. |
enum nrfx_twis_error_t |
Possible error sources.
This is flag enum - values from this enum can be connected using logical or operator.
enum nrfx_twis_evt_type_t |
Event callback function event definitions.
Enumerator | |
---|---|
NRFX_TWIS_EVT_READ_REQ | Read request detected. If there is no buffer prepared, buf_req flag in the even will be set. Call then nrfx_twis_tx_prepare to give parameters for buffer. |
NRFX_TWIS_EVT_READ_DONE | Read request finished - free any data. |
NRFX_TWIS_EVT_READ_ERROR | Read request finished with error. |
NRFX_TWIS_EVT_WRITE_REQ | Write request detected. If there is no buffer prepared, buf_req flag in the even will be set. Call then nrfx_twis_rx_prepare to give parameters for buffer. |
NRFX_TWIS_EVT_WRITE_DONE | Write request finished - process data. |
NRFX_TWIS_EVT_WRITE_ERROR | Write request finished with error. |
NRFX_TWIS_EVT_GENERAL_ERROR | Error that happens not inside WRITE or READ transaction. |
void nrfx_twis_disable | ( | nrfx_twis_t const * | p_instance | ) |
Function for disabling the TWIS instance.
This function disables the TWIS instance, which gives possibility to turn off the TWIS while holding configuration done by nrfx_twis_init.
p_instance | Pointer to the driver instance structure. |
void nrfx_twis_enable | ( | nrfx_twis_t const * | p_instance | ) |
Function for enabling the TWIS instance.
This function enables the TWIS instance. Function defined if there is need for dynamically enabling and disabling the peripheral. Use nrfx_twis_enable and nrfx_twis_disable functions. They do not change any configuration registers.
p_instance | Pointer to the driver instance structure. |
uint32_t nrfx_twis_error_get_and_clear | ( | nrfx_twis_t const * | p_instance | ) |
Function for getting and clearing the last error flags.
This function gets the information about errors. This is also the only possibility to exit from the error substate of the internal state machine.
[in] | p_instance | Pointer to the driver instance structure. |
nrfx_err_t nrfx_twis_init | ( | nrfx_twis_t const * | p_instance, |
nrfx_twis_config_t const * | p_config, | ||
nrfx_twis_event_handler_t | event_handler | ||
) |
Function for initializing the TWIS driver instance.
Function initializes and enables the TWIS driver.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_config | Pointer to the structure with the initial configuration. |
[in] | event_handler | Event handler provided by the user. If NULL, blocking mode is enabled. |
NRFX_SUCCESS | Initialization is 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_BUSY | Some other peripheral with the same instance ID is already in use. This is possible only if NRFX_PRS_ENABLED is set to a value other than zero. |
bool nrfx_twis_init_check | ( | nrfx_twis_t const * | p_instance | ) |
Function for checking if the TWIS driver instance is initialized.
[in] | p_instance | Pointer to the driver instance structure. |
true | Instance is already initialized. |
false | Instance is not initialized. |
bool nrfx_twis_is_busy | ( | nrfx_twis_t const * | p_instance | ) |
Function for checking if the driver is busy right now.
This function tests the actual driver substate. If the driver is in any other state than IDLE or ERROR, this function returns true.
[in] | p_instance | Pointer to the driver instance structure. |
true | The driver is in state other than ERROR or IDLE. |
false | There is no transmission pending. |
bool nrfx_twis_is_pending_rx | ( | nrfx_twis_t const * | p_instance | ) |
Function for checking if the driver is receiving data.
If this function returns true, there is an ongoing input transmission.
[in] | p_instance | Pointer to the driver instance structure. |
true | There is an ongoing input transmission. |
false | The driver is in other state. |
bool nrfx_twis_is_pending_tx | ( | nrfx_twis_t const * | p_instance | ) |
Function for checking if the driver is sending data.
If this function returns true, there is an ongoing output transmission.
[in] | p_instance | Pointer to the driver instance structure. |
true | There is an ongoing output transmission. |
false | The driver is in other state. |
bool nrfx_twis_is_waiting_rx_buff | ( | nrfx_twis_t const * | p_instance | ) |
Function for checking if the driver is waiting for an RX buffer.
If this function returns true, the driver is stalled expecting of the nrfx_twis_rx_prepare function call.
[in] | p_instance | Pointer to the driver instance structure. |
true | The driver is waiting for nrfx_twis_rx_prepare. |
false | The driver is not in the state where it is waiting for preparing an RX buffer. |
bool nrfx_twis_is_waiting_tx_buff | ( | nrfx_twis_t const * | p_instance | ) |
Function for checking if the driver is waiting for a TX buffer.
If this function returns true, the driver is stalled expecting of the nrfx_twis_tx_prepare function call.
[in] | p_instance | Pointer to the driver instance structure. |
true | The driver is waiting for nrfx_twis_tx_prepare. |
false | The driver is not in the state where it is waiting for preparing a TX buffer. |
nrfx_err_t nrfx_twis_reconfigure | ( | nrfx_twis_t const * | p_instance, |
nrfx_twis_config_t const * | p_config | ||
) |
Function for reconfiguring the TWIS driver instance.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_config | Pointer to the structure with the configuration. |
NRFX_SUCCESS | Reconfiguration was successful. |
NRFX_ERROR_BUSY | The driver is during transaction. |
NRFX_ERROR_INVALID_STATE | The driver is uninitialized. |
NRFX_STATIC_INLINE size_t nrfx_twis_rx_amount | ( | nrfx_twis_t const * | p_instance | ) |
Function for getting the number of received bytes.
This function returns number of bytes received. It can be called after NRFX_TWIS_EVT_WRITE_DONE or NRFX_TWIS_EVT_WRITE_ERROR events.
[in] | p_instance | Pointer to the driver instance structure. |
nrfx_err_t nrfx_twis_rx_prepare | ( | nrfx_twis_t const * | p_instance, |
void * | p_buf, | ||
size_t | size | ||
) |
Function for preparing the data for receiving.
This function must be used in response to the NRFX_TWIS_EVT_WRITE_REQ event.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_buf | Buffer that is to be filled with received data. |
[in] | size | Size of the buffer (maximum amount of data to receive). |
NRFX_SUCCESS | The preparation finished properly. |
NRFX_ERROR_INVALID_ADDR | The given p_buf is not placed inside the RAM. |
NRFX_ERROR_INVALID_LENGTH | There is a wrong value in the size parameter. |
NRFX_ERROR_INVALID_STATE | The module is not initialized or not enabled. |
NRFX_STATIC_INLINE size_t nrfx_twis_tx_amount | ( | nrfx_twis_t const * | p_instance | ) |
Function for getting the number of transmitted bytes.
This function returns the number of bytes sent. This function can be called after NRFX_TWIS_EVT_READ_DONE or NRFX_TWIS_EVT_READ_ERROR events.
[in] | p_instance | Pointer to the driver instance structure. |
nrfx_err_t nrfx_twis_tx_prepare | ( | nrfx_twis_t const * | p_instance, |
void const * | p_buf, | ||
size_t | size | ||
) |
Function for preparing the data for sending.
This function is to be used in response to the NRFX_TWIS_EVT_READ_REQ event.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_buf | Transmission buffer. |
[in] | size | Maximum number of bytes that master may read from buffer given. |
NRFX_SUCCESS | The preparation finished properly. |
NRFX_ERROR_INVALID_ADDR | The given p_buf is not placed inside the RAM. |
NRFX_ERROR_INVALID_LENGTH | There is a wrong value in the size parameter. |
NRFX_ERROR_INVALID_STATE | The module is not initialized or not enabled. |
void nrfx_twis_uninit | ( | nrfx_twis_t const * | p_instance | ) |
Function for uninitializing the TWIS driver instance.
Function uninitializes the peripheral and resets all registers to default values.
[in] | p_instance | Pointer to the driver instance structure. |