Layer providing compatibility with the former API.
More...
Layer providing compatibility with the former API.
#define NRF_DRV_UART_DEFAULT_CONFIG |
Value:{ \
.pseltxd = NRF_UART_PSEL_DISCONNECTED, \
.pselrxd = NRF_UART_PSEL_DISCONNECTED, \
.pselcts = NRF_UART_PSEL_DISCONNECTED, \
.pselrts = NRF_UART_PSEL_DISCONNECTED, \
.p_context = NULL, \
NRF_DRV_UART_DEFAULT_CONFIG_USE_EASY_DMA \
}
UART default configuration.
#define NRF_DRV_UART_INSTANCE |
( |
|
id | ) |
|
Value:{ \
.inst_idx = id, \
NRF_DRV_UART_CREATE_UARTE(id) \
NRF_DRV_UART_CREATE_UART(id) \
}
Macro for creating an UART driver instance.
UART interrupt event handler.
- Parameters
-
[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 interrupt handler, set on initialization. |
Types of UART driver events.
Enumerator |
---|
NRF_DRV_UART_EVT_TX_DONE |
Requested TX transfer completed.
|
NRF_DRV_UART_EVT_RX_DONE |
Requested RX transfer completed.
|
NRF_DRV_UART_EVT_ERROR |
Error reported by UART peripheral.
|
__STATIC_INLINE uint32_t nrf_drv_uart_errorsrc_get |
( |
nrf_drv_uart_t const * |
p_instance | ) |
|
Function for reading error source mask. Mask contains values from nrf_uart_error_mask_t.
- Note
- Function should be used in blocking mode only. In case of non-blocking mode, an error event is generated. Function clears error sources after reading.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
- Return values
-
Function for getting the address of a specific UART event.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | event | Event. |
- Returns
- Event address.
Function for initializing the UART driver.
This function configures and enables UART. After this function GPIO pins are controlled by UART.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_config | Initial configuration. |
[in] | event_handler | Event handler provided by the user. If not provided driver works in blocking mode. |
- Return values
-
NRFX_SUCCESS | If initialization was successful. |
NRFX_ERROR_INVALID_STATE | If driver is already initialized. |
Function for receiving data over UART.
If an event handler was provided in the nrf_drv_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, i.e. 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.
- Note
- Peripherals using EasyDMA (i.e. UARTE) require that the transfer buffers are placed in the Data RAM region. If they are not and UARTE driver instance is used, this function will fail with error code NRFX_ERROR_INVALID_ADDR.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_data | Pointer to data. |
[in] | length | Number of bytes to receive. |
- Return values
-
NRFX_SUCCESS | If initialization was successful. |
NRFX_ERROR_BUSY | If the driver is already receiving (and the secondary buffer has already been set in non-blocking mode). |
NRFX_ERROR_FORBIDDEN | If the transfer was aborted from a different context (blocking mode only, also see nrf_drv_uart_rx_disable). |
NRFX_ERROR_INTERNAL | If UART peripheral reported an error. |
NRFX_ERROR_INVALID_ADDR | If p_data does not point to RAM buffer (UARTE only). |
__STATIC_INLINE void nrf_drv_uart_rx_abort |
( |
nrf_drv_uart_t const * |
p_instance | ) |
|
Function for aborting any ongoing reception.
- Note
- NRF_DRV_UART_EVT_RX_DONE event will be generated in non-blocking mode. The event will contain the number of bytes received until abort was called. The event is called from UART interrupt context.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
__STATIC_INLINE void nrf_drv_uart_rx_disable |
( |
nrf_drv_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
- See Also
- nrf_drv_uart_rx_enable. The feature is supported only in UART mode (without Easy DMA). The function asserts if mode is wrong.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
__STATIC_INLINE void nrf_drv_uart_rx_enable |
( |
nrf_drv_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. Enabling the receiver without specifying an RX buffer is supported only in UART mode (without Easy DMA). The receiver must be explicitly closed by the user
- See Also
- nrf_drv_uart_rx_disable. This function asserts if the mode is wrong.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
__STATIC_INLINE bool nrf_drv_uart_rx_ready |
( |
nrf_drv_uart_t const * |
p_instance | ) |
|
Function for testing the receiver state in blocking mode.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
- Return values
-
true | If the receiver has at least one byte of data to get. |
false | If the receiver is empty. |
Function for getting the address of a specific UART task.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | task | Task. |
- Returns
- Task address.
__STATIC_INLINE ret_code_t nrf_drv_uart_tx |
( |
nrf_drv_uart_t const * |
p_instance, |
|
|
uint8_t const *const |
p_data, |
|
|
uint8_t |
length |
|
) |
| |
Function for sending data over UART.
If an event handler was provided in nrf_drv_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, i.e. this function returns when the transfer is finished. Blocking mode is not using interrupt so there is no context switching inside the function.
- Note
- Peripherals using EasyDMA (i.e. UARTE) require that the transfer buffers are placed in the Data RAM region. If they are not and UARTE instance is used, this function will fail with error code NRFX_ERROR_INVALID_ADDR.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
[in] | p_data | Pointer to data. |
[in] | length | Number of bytes to send. |
- Return values
-
NRFX_SUCCESS | If initialization was successful. |
NRFX_ERROR_BUSY | If driver is already transferring. |
NRFX_ERROR_FORBIDDEN | If the transfer was aborted from a different context (blocking mode only, also see nrf_drv_uart_rx_disable). |
NRFX_ERROR_INVALID_ADDR | If p_data does not point to RAM buffer (UARTE only). |
__STATIC_INLINE void nrf_drv_uart_tx_abort |
( |
nrf_drv_uart_t const * |
p_instance | ) |
|
Function for aborting any ongoing transmission.
- Note
- NRF_DRV_UART_EVT_TX_DONE event will be generated in non-blocking mode. Event will contain number of bytes sent until abort was called. If Easy DMA is not used event will be called from the function context. If Easy DMA is used it will be called from UART interrupt context.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
__STATIC_INLINE bool nrf_drv_uart_tx_in_progress |
( |
nrf_drv_uart_t const * |
p_instance | ) |
|
Function for checking if UART is currently transmitting.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |
- Return values
-
true | If UART is transmitting. |
false | If UART is not transmitting. |
__STATIC_INLINE void nrf_drv_uart_uninit |
( |
nrf_drv_uart_t const * |
p_instance | ) |
|
Function for uninitializing the UART driver.
- Parameters
-
[in] | p_instance | Pointer to the driver instance structure. |