UART peripheral driver. More...
Modules | |
UART peripheral driver configuration | |
Data Structures | |
struct | nrfx_uart_t |
Data structure of the UART driver instance. More... | |
struct | nrfx_uart_config_t |
Structure for the UART configuration. More... | |
struct | nrfx_uart_xfer_evt_t |
Structure for the UART transfer completion event. More... | |
struct | nrfx_uart_error_evt_t |
Structure for the UART error event. More... | |
struct | nrfx_uart_event_t |
Structure for the UART event. More... | |
Macros | |
#define | NRFX_UART_INSTANCE(id) |
Macro for creating a UART driver instance. | |
#define | NRFX_UART_DEFAULT_EXTENDED_STOP_CONFIG .stop = NRF_UART_STOP_ONE, |
UART additional stop bits configuration. | |
#define | NRFX_UART_DEFAULT_EXTENDED_PARITYTYPE_CONFIG .paritytype = NRF_UART_PARITYTYPE_EVEN, |
UART additional parity type configuration. | |
#define | NRFX_UART_DEFAULT_CONFIG(_pin_tx, _pin_rx) |
UART driver default configuration. | |
#define | NRFX_UART_INST_HANDLER_GET(idx) NRFX_CONCAT_3(nrfx_uart_, idx, _irq_handler) |
Macro returning UART interrupt handler. | |
Typedefs | |
typedef void(* | nrfx_uart_event_handler_t) (nrfx_uart_event_t const *p_event, void *p_context) |
UART interrupt event handler. | |
Enumerations | |
enum | nrfx_uart_evt_type_t { NRFX_UART_EVT_TX_DONE , NRFX_UART_EVT_RX_DONE , NRFX_UART_EVT_ERROR } |
Types of UART driver events. More... | |
Functions | |
nrfx_err_t | nrfx_uart_init (nrfx_uart_t const *p_instance, nrfx_uart_config_t const *p_config, nrfx_uart_event_handler_t event_handler) |
Function for initializing the UART driver. | |
nrfx_err_t | nrfx_uart_reconfigure (nrfx_uart_t const *p_instance, nrfx_uart_config_t const *p_config) |
Function for reconfiguring the UART driver. | |
void | nrfx_uart_uninit (nrfx_uart_t const *p_instance) |
Function for uninitializing the UART driver. | |
bool | nrfx_uart_init_check (nrfx_uart_t const *p_instance) |
Function for checking if the UART driver instance is initialized. | |
NRFX_STATIC_INLINE uint32_t | nrfx_uart_task_address_get (nrfx_uart_t const *p_instance, nrf_uart_task_t task) |
Function for getting the address of the specified UART task. | |
NRFX_STATIC_INLINE uint32_t | nrfx_uart_event_address_get (nrfx_uart_t const *p_instance, nrf_uart_event_t event) |
Function for getting the address of the specified UART event. | |
nrfx_err_t | nrfx_uart_tx (nrfx_uart_t const *p_instance, uint8_t const *p_data, size_t length) |
Function for sending data over UART. | |
bool | nrfx_uart_tx_in_progress (nrfx_uart_t const *p_instance) |
Function for checking if UART is currently transmitting. | |
void | nrfx_uart_tx_abort (nrfx_uart_t const *p_instance) |
Function for aborting any ongoing transmission. | |
nrfx_err_t | nrfx_uart_rx (nrfx_uart_t const *p_instance, uint8_t *p_data, size_t length) |
Function for receiving data over UART. | |
bool | nrfx_uart_rx_ready (nrfx_uart_t const *p_instance) |
Function for testing the receiver state in blocking mode. | |
void | nrfx_uart_rx_enable (nrfx_uart_t const *p_instance) |
Function for enabling the receiver. | |
void | nrfx_uart_rx_disable (nrfx_uart_t const *p_instance) |
Function for disabling the receiver. | |
void | nrfx_uart_rx_abort (nrfx_uart_t const *p_instance) |
Function for aborting any ongoing reception. | |
uint32_t | nrfx_uart_errorsrc_get (nrfx_uart_t const *p_instance) |
Function for reading error source mask. Mask contains values from nrf_uart_error_mask_t. | |
UART peripheral driver.
#define NRFX_UART_DEFAULT_CONFIG | ( | _pin_tx, | |
_pin_rx | |||
) |
UART driver default configuration.
This configuration sets up UART with the following options:
[in] | _pin_tx | TX pin. |
[in] | _pin_rx | RX pin. |
#define NRFX_UART_INST_HANDLER_GET | ( | idx | ) | NRFX_CONCAT_3(nrfx_uart_, idx, _irq_handler) |
Macro returning UART interrupt handler.
param[in] idx UART index.
#define NRFX_UART_INSTANCE | ( | id | ) |
Macro for creating a UART driver instance.
typedef void(* nrfx_uart_event_handler_t) (nrfx_uart_event_t const *p_event, void *p_context) |
UART interrupt event handler.
[in] | p_event | Pointer to event structure. Event is allocated on the stack so it is available only within the context of the event handler. |
[in] | p_context | Context passed to the interrupt handler, set on initialization. |
enum nrfx_uart_evt_type_t |
uint32_t nrfx_uart_errorsrc_get | ( | nrfx_uart_t const * | p_instance | ) |
Function for reading error source mask. Mask contains values from nrf_uart_error_mask_t.
[in] | p_instance | Pointer to the driver instance structure. |
NRFX_STATIC_INLINE uint32_t nrfx_uart_event_address_get | ( | nrfx_uart_t const * | p_instance, |
nrf_uart_event_t | event | ||
) |
Function for getting the address of the specified UART event.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | event | Event. |
nrfx_err_t nrfx_uart_init | ( | nrfx_uart_t const * | p_instance, |
nrfx_uart_config_t const * | p_config, | ||
nrfx_uart_event_handler_t | event_handler | ||
) |
Function for initializing the UART driver.
This function configures and enables UART. After this function GPIO pins are controlled by UART.
[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 not provided, the driver works in blocking mode. |
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 Peripheral Resource Sharing (PRS) module is enabled. |
bool nrfx_uart_init_check | ( | nrfx_uart_t const * | p_instance | ) |
Function for checking if the UART driver instance is initialized.
[in] | p_instance | Pointer to the driver instance structure. |
true | Instance is already initialized. |
false | Instance is not initialized. |
nrfx_err_t nrfx_uart_reconfigure | ( | nrfx_uart_t const * | p_instance, |
nrfx_uart_config_t const * | p_config | ||
) |
Function for reconfiguring the UART driver.
[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 transfer. |
NRFX_ERROR_INVALID_STATE | The driver is uninitialized. |
nrfx_err_t nrfx_uart_rx | ( | nrfx_uart_t const * | p_instance, |
uint8_t * | p_data, | ||
size_t | length | ||
) |
Function for receiving data over UART.
If an event handler is provided in the nrfx_uart_init() call, this function returns immediately and the handler is called when the transfer is done. Otherwise, the transfer is performed in blocking mode, that is this function returns when the transfer is finished. Blocking mode is not using interrupt so there is no context switching inside the function. The receive buffer pointer is double-buffered in non-blocking mode. The secondary buffer can be set immediately after starting the transfer and will be filled when the primary buffer is full. The double-buffering feature allows receiving data continuously.
If this function is used without a previous call to nrfx_uart_rx_enable, the reception will be stopped on error or when the supplied buffer fills up. In both cases, RX FIFO gets disabled. This means that, in case of error, the bytes that follow are lost. If this nrfx_uart_rx() function is used with the previous call to nrfx_uart_rx_enable, the reception is stopped in case of error, but FIFO is still ongoing. The receiver is still working, so after handling the error, an immediate repeated call to this nrfx_uart_rx() function with fresh data buffer will re-establish reception. To disable the receiver, you must call nrfx_uart_rx_disable explicitly.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_data | Pointer to data. |
[in] | length | Number of bytes to receive. |
NRFX_SUCCESS | Reception is complete (in case of blocking mode) or it is successfully started (in case of non-blocking mode). |
NRFX_ERROR_BUSY | The driver is already receiving (and the secondary buffer has already been set in non-blocking mode). |
NRFX_ERROR_FORBIDDEN | The transfer was aborted from a different context (blocking mode only, also see nrfx_uart_rx_disable). |
NRFX_ERROR_INTERNAL | The UART peripheral reported an error. |
void nrfx_uart_rx_abort | ( | nrfx_uart_t const * | p_instance | ) |
Function for aborting any ongoing reception.
[in] | p_instance | Pointer to the driver instance structure. |
void nrfx_uart_rx_disable | ( | nrfx_uart_t const * | p_instance | ) |
Function for disabling the receiver.
This function must be called to close the receiver after it has been explicitly enabled by
[in] | p_instance | Pointer to the driver instance structure. |
void nrfx_uart_rx_enable | ( | nrfx_uart_t const * | p_instance | ) |
Function for enabling the receiver.
UART has a 6-byte-long RX FIFO and it is used to store incoming data. If a user does not call the UART receive function before the FIFO is filled, an overrun error will appear. The receiver must be explicitly closed by the user
[in] | p_instance | Pointer to the driver instance structure. |
bool nrfx_uart_rx_ready | ( | nrfx_uart_t const * | p_instance | ) |
Function for testing the receiver state in blocking mode.
[in] | p_instance | Pointer to the driver instance structure. |
true | The receiver has at least one byte of data to get. |
false | The receiver is empty. |
NRFX_STATIC_INLINE uint32_t nrfx_uart_task_address_get | ( | nrfx_uart_t const * | p_instance, |
nrf_uart_task_t | task | ||
) |
Function for getting the address of the specified UART task.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | task | Task. |
nrfx_err_t nrfx_uart_tx | ( | nrfx_uart_t const * | p_instance, |
uint8_t const * | p_data, | ||
size_t | length | ||
) |
Function for sending data over UART.
If an event handler was provided in nrfx_uart_init() call, this function returns immediately and the handler is called when the transfer is done. Otherwise, the transfer is performed in blocking mode, that is this function returns when the transfer is finished. Blocking mode is not using interrupt so there is no context switching inside the function.
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_data | Pointer to data. |
[in] | length | Number of bytes to send. |
NRFX_SUCCESS | Initialization was successful. |
NRFX_ERROR_BUSY | Driver is already transferring. |
NRFX_ERROR_FORBIDDEN | The transfer was aborted from a different context (blocking mode only). |
void nrfx_uart_tx_abort | ( | nrfx_uart_t const * | p_instance | ) |
Function for aborting any ongoing transmission.
[in] | p_instance | Pointer to the driver instance structure. |
bool nrfx_uart_tx_in_progress | ( | nrfx_uart_t const * | p_instance | ) |
Function for checking if UART is currently transmitting.
[in] | p_instance | Pointer to the driver instance structure. |
true | The UART is transmitting. |
false | The UART is not transmitting. |
void nrfx_uart_uninit | ( | nrfx_uart_t const * | p_instance | ) |
Function for uninitializing the UART driver.
[in] | p_instance | Pointer to the driver instance structure. |