Hardware access layer for managing the UARTE peripheral. More...
Data Structures | |
struct | nrf_uarte_config_t |
Structure for UARTE transmission configuration. More... | |
Enumerations | |
enum | nrf_uarte_task_t { NRF_UARTE_TASK_STARTRX = offsetof(NRF_UARTE_Type, TASKS_STARTRX), NRF_UARTE_TASK_STOPRX = offsetof(NRF_UARTE_Type, TASKS_STOPRX), NRF_UARTE_TASK_STARTTX = offsetof(NRF_UARTE_Type, TASKS_STARTTX), NRF_UARTE_TASK_STOPTX = offsetof(NRF_UARTE_Type, TASKS_STOPTX), NRF_UARTE_TASK_FLUSHRX = offsetof(NRF_UARTE_Type, TASKS_FLUSHRX) } |
UARTE tasks. More... | |
enum | nrf_uarte_event_t { NRF_UARTE_EVENT_CTS = offsetof(NRF_UARTE_Type, EVENTS_CTS), NRF_UARTE_EVENT_NCTS = offsetof(NRF_UARTE_Type, EVENTS_NCTS), NRF_UARTE_EVENT_RXDRDY = offsetof(NRF_UARTE_Type, EVENTS_RXDRDY), NRF_UARTE_EVENT_ENDRX = offsetof(NRF_UARTE_Type, EVENTS_ENDRX), NRF_UARTE_EVENT_TXDRDY = offsetof(NRF_UARTE_Type, EVENTS_TXDRDY), NRF_UARTE_EVENT_ENDTX = offsetof(NRF_UARTE_Type, EVENTS_ENDTX), NRF_UARTE_EVENT_ERROR = offsetof(NRF_UARTE_Type, EVENTS_ERROR), NRF_UARTE_EVENT_RXTO = offsetof(NRF_UARTE_Type, EVENTS_RXTO), NRF_UARTE_EVENT_RXSTARTED = offsetof(NRF_UARTE_Type, EVENTS_RXSTARTED), NRF_UARTE_EVENT_TXSTARTED = offsetof(NRF_UARTE_Type, EVENTS_TXSTARTED), NRF_UARTE_EVENT_TXSTOPPED = offsetof(NRF_UARTE_Type, EVENTS_TXSTOPPED) } |
UARTE events. More... | |
enum | nrf_uarte_short_t { NRF_UARTE_SHORT_ENDRX_STARTRX = UARTE_SHORTS_ENDRX_STARTRX_Msk, NRF_UARTE_SHORT_ENDRX_STOPRX = UARTE_SHORTS_ENDRX_STOPRX_Msk } |
Types of UARTE shortcuts. More... | |
enum | nrf_uarte_int_mask_t { NRF_UARTE_INT_CTS_MASK = UARTE_INTENSET_CTS_Msk, NRF_UARTE_INT_NCTS_MASK = UARTE_INTENSET_NCTS_Msk, NRF_UARTE_INT_RXDRDY_MASK = UARTE_INTENSET_RXDRDY_Msk, NRF_UARTE_INT_ENDRX_MASK = UARTE_INTENSET_ENDRX_Msk, NRF_UARTE_INT_TXDRDY_MASK = UARTE_INTENSET_TXDRDY_Msk, NRF_UARTE_INT_ENDTX_MASK = UARTE_INTENSET_ENDTX_Msk, NRF_UARTE_INT_ERROR_MASK = UARTE_INTENSET_ERROR_Msk, NRF_UARTE_INT_RXTO_MASK = UARTE_INTENSET_RXTO_Msk, NRF_UARTE_INT_RXSTARTED_MASK = UARTE_INTENSET_RXSTARTED_Msk, NRF_UARTE_INT_TXSTARTED_MASK = UARTE_INTENSET_TXSTARTED_Msk, NRF_UARTE_INT_TXSTOPPED_MASK = UARTE_INTENSET_TXSTOPPED_Msk } |
UARTE interrupts. More... | |
enum | nrf_uarte_baudrate_t { NRF_UARTE_BAUDRATE_1200 = UARTE_BAUDRATE_BAUDRATE_Baud1200, NRF_UARTE_BAUDRATE_2400 = UARTE_BAUDRATE_BAUDRATE_Baud2400, NRF_UARTE_BAUDRATE_4800 = UARTE_BAUDRATE_BAUDRATE_Baud4800, NRF_UARTE_BAUDRATE_9600 = UARTE_BAUDRATE_BAUDRATE_Baud9600, NRF_UARTE_BAUDRATE_14400 = UARTE_BAUDRATE_BAUDRATE_Baud14400, NRF_UARTE_BAUDRATE_19200 = UARTE_BAUDRATE_BAUDRATE_Baud19200, NRF_UARTE_BAUDRATE_28800 = UARTE_BAUDRATE_BAUDRATE_Baud28800, NRF_UARTE_BAUDRATE_31250 = UARTE_BAUDRATE_BAUDRATE_Baud31250, NRF_UARTE_BAUDRATE_38400 = UARTE_BAUDRATE_BAUDRATE_Baud38400, NRF_UARTE_BAUDRATE_56000 = UARTE_BAUDRATE_BAUDRATE_Baud56000, NRF_UARTE_BAUDRATE_57600 = UARTE_BAUDRATE_BAUDRATE_Baud57600, NRF_UARTE_BAUDRATE_76800 = UARTE_BAUDRATE_BAUDRATE_Baud76800, NRF_UARTE_BAUDRATE_115200 = UARTE_BAUDRATE_BAUDRATE_Baud115200, NRF_UARTE_BAUDRATE_230400 = UARTE_BAUDRATE_BAUDRATE_Baud230400, NRF_UARTE_BAUDRATE_250000 = UARTE_BAUDRATE_BAUDRATE_Baud250000, NRF_UARTE_BAUDRATE_460800 = UARTE_BAUDRATE_BAUDRATE_Baud460800, NRF_UARTE_BAUDRATE_921600 = UARTE_BAUDRATE_BAUDRATE_Baud921600, NRF_UARTE_BAUDRATE_1000000 = UARTE_BAUDRATE_BAUDRATE_Baud1M } |
Baudrates supported by UARTE. More... | |
enum | nrf_uarte_error_mask_t { NRF_UARTE_ERROR_OVERRUN_MASK = UARTE_ERRORSRC_OVERRUN_Msk, NRF_UARTE_ERROR_PARITY_MASK = UARTE_ERRORSRC_PARITY_Msk, NRF_UARTE_ERROR_FRAMING_MASK = UARTE_ERRORSRC_FRAMING_Msk, NRF_UARTE_ERROR_BREAK_MASK = UARTE_ERRORSRC_BREAK_Msk } |
Types of UARTE error masks. More... | |
enum | nrf_uarte_parity_t { NRF_UARTE_PARITY_EXCLUDED = UARTE_CONFIG_PARITY_Excluded << UARTE_CONFIG_PARITY_Pos, NRF_UARTE_PARITY_INCLUDED = UARTE_CONFIG_PARITY_Included << UARTE_CONFIG_PARITY_Pos } |
Types of UARTE parity modes. More... | |
enum | nrf_uarte_hwfc_t { NRF_UARTE_HWFC_DISABLED = UARTE_CONFIG_HWFC_Disabled << UARTE_CONFIG_HWFC_Pos, NRF_UARTE_HWFC_ENABLED = UARTE_CONFIG_HWFC_Enabled << UARTE_CONFIG_HWFC_Pos } |
Types of UARTE flow control modes. More... | |
enum | nrf_uarte_stop_t { NRF_UARTE_STOP_ONE = UARTE_CONFIG_STOP_One << UARTE_CONFIG_STOP_Pos, NRF_UARTE_STOP_TWO = UARTE_CONFIG_STOP_Two << UARTE_CONFIG_STOP_Pos } |
Types of UARTE stop bit modes. More... | |
enum | nrf_uarte_paritytype_t { NRF_UARTE_PARITYTYPE_EVEN = UARTE_CONFIG_PARITYTYPE_Even << UARTE_CONFIG_PARITYTYPE_Pos, NRF_UARTE_PARITYTYPE_ODD = UARTE_CONFIG_PARITYTYPE_Odd << UARTE_CONFIG_PARITYTYPE_Pos } |
Types of UARTE parity types. More... | |
Functions | |
NRF_STATIC_INLINE void | nrf_uarte_event_clear (NRF_UARTE_Type *p_reg, nrf_uarte_event_t event) |
Function for clearing a specific UARTE event. More... | |
NRF_STATIC_INLINE bool | nrf_uarte_event_check (NRF_UARTE_Type const *p_reg, nrf_uarte_event_t event) |
Function for retrieving the state of the UARTE event. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_event_address_get (NRF_UARTE_Type const *p_reg, nrf_uarte_event_t event) |
Function for returning the address of the specified UARTE event register. More... | |
NRF_STATIC_INLINE void | nrf_uarte_shorts_enable (NRF_UARTE_Type *p_reg, uint32_t mask) |
Function for enabling UARTE shortcuts. More... | |
NRF_STATIC_INLINE void | nrf_uarte_shorts_disable (NRF_UARTE_Type *p_reg, uint32_t mask) |
Function for disabling UARTE shortcuts. More... | |
NRF_STATIC_INLINE void | nrf_uarte_int_enable (NRF_UARTE_Type *p_reg, uint32_t mask) |
Function for enabling UARTE interrupts. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_int_enable_check (NRF_UARTE_Type const *p_reg, uint32_t mask) |
Function for checking if the specified interrupts are enabled. More... | |
NRF_STATIC_INLINE void | nrf_uarte_int_disable (NRF_UARTE_Type *p_reg, uint32_t mask) |
Function for disabling the specified interrupts. More... | |
NRF_STATIC_INLINE void | nrf_uarte_subscribe_set (NRF_UARTE_Type *p_reg, nrf_uarte_task_t task, uint8_t channel) |
Function for setting the subscribe configuration for a given UARTE task. More... | |
NRF_STATIC_INLINE void | nrf_uarte_subscribe_clear (NRF_UARTE_Type *p_reg, nrf_uarte_task_t task) |
Function for clearing the subscribe configuration for a given UARTE task. More... | |
NRF_STATIC_INLINE void | nrf_uarte_publish_set (NRF_UARTE_Type *p_reg, nrf_uarte_event_t event, uint8_t channel) |
Function for setting the publish configuration for a given UARTE event. More... | |
NRF_STATIC_INLINE void | nrf_uarte_publish_clear (NRF_UARTE_Type *p_reg, nrf_uarte_event_t event) |
Function for clearing the publish configuration for a given UARTE event. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_errorsrc_get_and_clear (NRF_UARTE_Type *p_reg) |
Function for getting error source mask. Function is clearing error source flags after reading. More... | |
NRF_STATIC_INLINE void | nrf_uarte_enable (NRF_UARTE_Type *p_reg) |
Function for enabling UARTE. More... | |
NRF_STATIC_INLINE void | nrf_uarte_disable (NRF_UARTE_Type *p_reg) |
Function for disabling UARTE. More... | |
NRF_STATIC_INLINE void | nrf_uarte_txrx_pins_set (NRF_UARTE_Type *p_reg, uint32_t pseltxd, uint32_t pselrxd) |
Function for configuring TX/RX pins. More... | |
NRF_STATIC_INLINE void | nrf_uarte_txrx_pins_disconnect (NRF_UARTE_Type *p_reg) |
Function for disconnecting TX/RX pins. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_tx_pin_get (NRF_UARTE_Type const *p_reg) |
Function for getting TX pin selection. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_rx_pin_get (NRF_UARTE_Type const *p_reg) |
Function for getting RX pin selection. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_rts_pin_get (NRF_UARTE_Type const *p_reg) |
Function for getting RTS pin selection. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_cts_pin_get (NRF_UARTE_Type const *p_reg) |
Function for getting CTS pin selection. More... | |
NRF_STATIC_INLINE void | nrf_uarte_hwfc_pins_set (NRF_UARTE_Type *p_reg, uint32_t pselrts, uint32_t pselcts) |
Function for configuring flow control pins. More... | |
NRF_STATIC_INLINE void | nrf_uarte_hwfc_pins_disconnect (NRF_UARTE_Type *p_reg) |
Function for disconnecting flow control pins. More... | |
NRF_STATIC_INLINE void | nrf_uarte_task_trigger (NRF_UARTE_Type *p_reg, nrf_uarte_task_t task) |
Function for starting an UARTE task. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_task_address_get (NRF_UARTE_Type const *p_reg, nrf_uarte_task_t task) |
Function for returning the address of the specified task register. More... | |
NRF_STATIC_INLINE void | nrf_uarte_configure (NRF_UARTE_Type *p_reg, nrf_uarte_config_t const *p_cfg) |
Function for configuring UARTE. More... | |
NRF_STATIC_INLINE void | nrf_uarte_baudrate_set (NRF_UARTE_Type *p_reg, nrf_uarte_baudrate_t baudrate) |
Function for setting UARTE baud rate. More... | |
NRF_STATIC_INLINE void | nrf_uarte_tx_buffer_set (NRF_UARTE_Type *p_reg, uint8_t const *p_buffer, size_t length) |
Function for setting the transmit buffer. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_tx_amount_get (NRF_UARTE_Type const *p_reg) |
Function for getting number of bytes transmitted in the last transaction. More... | |
NRF_STATIC_INLINE void | nrf_uarte_rx_buffer_set (NRF_UARTE_Type *p_reg, uint8_t *p_buffer, size_t length) |
Function for setting the receive buffer. More... | |
NRF_STATIC_INLINE uint32_t | nrf_uarte_rx_amount_get (NRF_UARTE_Type const *p_reg) |
Function for getting number of bytes received in the last transaction. More... | |
Hardware access layer for managing the UARTE peripheral.
enum nrf_uarte_baudrate_t |
Baudrates supported by UARTE.
enum nrf_uarte_event_t |
UARTE events.
enum nrf_uarte_hwfc_t |
enum nrf_uarte_int_mask_t |
UARTE interrupts.
enum nrf_uarte_parity_t |
enum nrf_uarte_short_t |
enum nrf_uarte_stop_t |
enum nrf_uarte_task_t |
NRF_STATIC_INLINE void nrf_uarte_baudrate_set | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_baudrate_t | baudrate | ||
) |
Function for setting UARTE baud rate.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | baudrate | Baud rate. |
NRF_STATIC_INLINE void nrf_uarte_configure | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_config_t const * | p_cfg | ||
) |
Function for configuring UARTE.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | p_cfg | Pointer to UARTE settings structure. |
NRF_STATIC_INLINE uint32_t nrf_uarte_cts_pin_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting CTS pin selection.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_uarte_disable | ( | NRF_UARTE_Type * | p_reg | ) |
Function for disabling UARTE.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_uarte_enable | ( | NRF_UARTE_Type * | p_reg | ) |
Function for enabling UARTE.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE uint32_t nrf_uarte_errorsrc_get_and_clear | ( | NRF_UARTE_Type * | p_reg | ) |
Function for getting error source mask. Function is clearing error source flags after reading.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE uint32_t nrf_uarte_event_address_get | ( | NRF_UARTE_Type const * | p_reg, |
nrf_uarte_event_t | event | ||
) |
Function for returning the address of the specified UARTE event register.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | The specified event. |
NRF_STATIC_INLINE bool nrf_uarte_event_check | ( | NRF_UARTE_Type const * | p_reg, |
nrf_uarte_event_t | event | ||
) |
Function for retrieving the state of the UARTE event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to be checked. |
true | The event has been generated. |
false | The event has not been generated. |
NRF_STATIC_INLINE void nrf_uarte_event_clear | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_event_t | event | ||
) |
Function for clearing a specific UARTE event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to clear. |
NRF_STATIC_INLINE void nrf_uarte_hwfc_pins_disconnect | ( | NRF_UARTE_Type * | p_reg | ) |
Function for disconnecting flow control pins.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_uarte_hwfc_pins_set | ( | NRF_UARTE_Type * | p_reg, |
uint32_t | pselrts, | ||
uint32_t | pselcts | ||
) |
Function for configuring flow control pins.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | pselrts | RTS pin number. |
[in] | pselcts | CTS pin number. |
NRF_STATIC_INLINE void nrf_uarte_int_disable | ( | NRF_UARTE_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for disabling the specified interrupts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be disabled. |
NRF_STATIC_INLINE void nrf_uarte_int_enable | ( | NRF_UARTE_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for enabling UARTE interrupts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be enabled. |
NRF_STATIC_INLINE uint32_t nrf_uarte_int_enable_check | ( | NRF_UARTE_Type const * | p_reg, |
uint32_t | mask | ||
) |
Function for checking if the specified interrupts are enabled.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be checked. |
NRF_STATIC_INLINE void nrf_uarte_publish_clear | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_event_t | event | ||
) |
Function for clearing the publish configuration for a given UARTE event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event for which to clear the configuration. |
NRF_STATIC_INLINE void nrf_uarte_publish_set | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_event_t | event, | ||
uint8_t | channel | ||
) |
Function for setting the publish configuration for a given UARTE event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event for which to set the configuration. |
[in] | channel | Channel through which to publish the event. |
NRF_STATIC_INLINE uint32_t nrf_uarte_rts_pin_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting RTS pin selection.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE uint32_t nrf_uarte_rx_amount_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting number of bytes received in the last transaction.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
Amount | of bytes received. |
NRF_STATIC_INLINE void nrf_uarte_rx_buffer_set | ( | NRF_UARTE_Type * | p_reg, |
uint8_t * | p_buffer, | ||
size_t | length | ||
) |
Function for setting the receive buffer.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | p_buffer | Pointer to the buffer for received data. |
[in] | length | Maximum number of data bytes to receive. |
NRF_STATIC_INLINE uint32_t nrf_uarte_rx_pin_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting RX pin selection.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_uarte_shorts_disable | ( | NRF_UARTE_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for disabling UARTE shortcuts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Shortcuts to be disabled. |
NRF_STATIC_INLINE void nrf_uarte_shorts_enable | ( | NRF_UARTE_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for enabling UARTE shortcuts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Shortcuts to be enabled. |
NRF_STATIC_INLINE void nrf_uarte_subscribe_clear | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_task_t | task | ||
) |
Function for clearing the subscribe configuration for a given UARTE task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task for which to clear the configuration. |
NRF_STATIC_INLINE void nrf_uarte_subscribe_set | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_task_t | task, | ||
uint8_t | channel | ||
) |
Function for setting the subscribe configuration for a given UARTE task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task for which to set the configuration. |
[in] | channel | Channel through which to subscribe events. |
NRF_STATIC_INLINE uint32_t nrf_uarte_task_address_get | ( | NRF_UARTE_Type const * | p_reg, |
nrf_uarte_task_t | task | ||
) |
Function for returning the address of the specified task register.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task. |
NRF_STATIC_INLINE void nrf_uarte_task_trigger | ( | NRF_UARTE_Type * | p_reg, |
nrf_uarte_task_t | task | ||
) |
Function for starting an UARTE task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task. |
NRF_STATIC_INLINE uint32_t nrf_uarte_tx_amount_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting number of bytes transmitted in the last transaction.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
Amount | of bytes transmitted. |
NRF_STATIC_INLINE void nrf_uarte_tx_buffer_set | ( | NRF_UARTE_Type * | p_reg, |
uint8_t const * | p_buffer, | ||
size_t | length | ||
) |
Function for setting the transmit buffer.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | p_buffer | Pointer to the buffer with data to send. |
[in] | length | Maximum number of data bytes to transmit. |
NRF_STATIC_INLINE uint32_t nrf_uarte_tx_pin_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting TX pin selection.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_uarte_txrx_pins_disconnect | ( | NRF_UARTE_Type * | p_reg | ) |
Function for disconnecting TX/RX pins.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_uarte_txrx_pins_set | ( | NRF_UARTE_Type * | p_reg, |
uint32_t | pseltxd, | ||
uint32_t | pselrxd | ||
) |
Function for configuring TX/RX pins.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | pseltxd | TXD pin number. |
[in] | pselrxd | RXD pin number. |