![]() |
nrfx 4.5.0
|
Hardware access layer for managing the UARTE peripheral. More...
Data Structures | |
| struct | nrf_uarte_config_t |
| Structure for UARTE transmission configuration. More... | |
Macros | |
| #define | NRF_UARTE_INST_GET(idx) |
| Macro getting pointer to the structure of registers of the UARTE peripheral. | |
| #define | NRF_UARTE_HAS_DMA_REG 1 |
| Symbol indicating whether dedicated DMA register is present. | |
| #define | NRF_UARTE_HAS_DMA_TASKS_EVENTS 1 |
| Symbol indicating whether UARTE DMA tasks and events are present. | |
| #define | NRF_UARTE_HAS_DMA_SHORTS 1 |
| Symbol indicating whether UARTE DMA shortcuts are present. | |
| #define | NRF_UARTE_HAS_ENDTX_STOPTX_SHORT 1 |
| Symbol indicating whether UARTE ENDTX_STOPTX shortcut is present. | |
| #define | NRF_UARTE_HAS_FRAME_TIMEOUT 1 |
| Symbol indicating whether UARTE FRAMETIMEOUT event is present. | |
| #define | NRF_UARTE_HAS_PARITY_TYPES 1 |
| Symbol indicating whether UARTE parity types are present. | |
| #define | NRF_UARTE_HAS_STOP_MODES 1 |
| Symbol indicating whether UARTE STOP modes are present. | |
| #define | NRF_UARTE_HAS_FRAME_SIZE 1 |
| Symbol indicating whether UARTE supports variable frame size. | |
| #define | NRF_UARTE_HAS_DMAEND_TASK 1 |
| Symbol indicating whether DMAEND TASK is present. | |
| #define | NRF_UARTE_HAS_FRAMETIMEOUT_DMAEND_SHORT 1 |
| Symbol indicating whether FRAMETIMEOUT_DMAEND short is present. | |
| #define | NRF_UARTE_BASE_FREQUENCY_320MHZ (NRFX_MHZ_TO_HZ(320UL)) |
| Base frequency value 320 MHz for UARTE. | |
| #define | NRF_UARTE_BASE_FREQUENCY_128MHZ (NRFX_MHZ_TO_HZ(128UL)) |
| Base frequency value 128 MHz for UARTE. | |
| #define | NRF_UARTE_BASE_FREQUENCY_64MHZ (NRFX_MHZ_TO_HZ(64UL)) |
| Base frequency value 64 MHz for UARTE. | |
| #define | NRF_UARTE_BASE_FREQUENCY_16MHZ (NRFX_MHZ_TO_HZ(16UL)) |
| Base frequency value 16 MHz for UARTE. | |
| #define | NRF_UARTE_IS_320MHZ_UARTE(p_reg) |
| Macro for checking whether the base frequency for the specified UARTE is 320 MHz. | |
| #define | NRF_UARTE_IS_128MHZ_UARTE(p_reg) |
| Macro for checking whether the base frequency for the specified UARTE is 128 MHz. | |
| #define | NRF_UARTE_IS_64MHZ_UARTE(p_reg) |
| Macro for checking whether the base frequency for the specified UARTE is 64 MHz. | |
| #define | NRF_UARTE_BASE_FREQUENCY_GET(p_reg) |
| Macro for getting base frequency value in Hz for the specified UARTE. | |
Enumerations | |
| enum | nrf_uarte_task_t { NRF_UARTE_TASK_STARTRX = offsetof(NRF_UARTE_Type, TASKS_DMA.RX.START) , NRF_UARTE_TASK_STOPRX = offsetof(NRF_UARTE_Type, TASKS_DMA.RX.STOP) , NRF_UARTE_TASK_STARTTX = offsetof(NRF_UARTE_Type, TASKS_DMA.TX.START) , NRF_UARTE_TASK_STOPTX = offsetof(NRF_UARTE_Type, TASKS_DMA.TX.STOP) , NRF_UARTE_TASK_FLUSHRX = offsetof(NRF_UARTE_Type, TASKS_FLUSHRX) , NRF_UARTE_TASK_DMAEND = offsetof(NRF_UARTE_Type, TASKS_DMAEND) } |
| 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_TXDRDY = offsetof(NRF_UARTE_Type, EVENTS_TXDRDY) , NRF_UARTE_EVENT_ERROR = offsetof(NRF_UARTE_Type, EVENTS_ERROR) , NRF_UARTE_EVENT_RXTO = offsetof(NRF_UARTE_Type, EVENTS_RXTO) , NRF_UARTE_EVENT_TXSTOPPED = offsetof(NRF_UARTE_Type, EVENTS_TXSTOPPED) , NRF_UARTE_EVENT_ENDRX = offsetof(NRF_UARTE_Type, EVENTS_DMA.RX.END) , NRF_UARTE_EVENT_ENDTX = offsetof(NRF_UARTE_Type, EVENTS_DMA.TX.END) , NRF_UARTE_EVENT_RXSTARTED = offsetof(NRF_UARTE_Type, EVENTS_DMA.RX.READY) , NRF_UARTE_EVENT_TXSTARTED = offsetof(NRF_UARTE_Type, EVENTS_DMA.TX.READY) , NRF_UARTE_EVENT_FRAME_TIMEOUT = offsetof(NRF_UARTE_Type, EVENTS_FRAMETIMEOUT) } |
| UARTE events. More... | |
| enum | nrf_uarte_short_t { NRF_UARTE_SHORT_ENDRX_STARTRX = UARTE_SHORTS_DMA_RX_END_DMA_RX_START_Msk , NRF_UARTE_SHORT_ENDRX_STOPRX = UARTE_SHORTS_DMA_RX_END_DMA_RX_STOP_Msk , NRF_UARTE_SHORT_ENDTX_STOPTX = UARTE_SHORTS_DMA_TX_END_DMA_TX_STOP_Msk , NRF_UARTE_SHORT_FRAME_TIMEOUT_STOPRX = UARTE_SHORTS_FRAMETIMEOUT_DMA_RX_STOP_Msk , NRF_UARTE_SHORT_FRAMETIMEOUT_DMAEND = UARTE_SHORTS_FRAMETIMEOUT_DMAEND_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_TXDRDY_MASK = UARTE_INTENSET_TXDRDY_Msk , NRF_UARTE_INT_ERROR_MASK = UARTE_INTENSET_ERROR_Msk , NRF_UARTE_INT_RXTO_MASK = UARTE_INTENSET_RXTO_Msk , NRF_UARTE_INT_TXSTOPPED_MASK = UARTE_INTENSET_TXSTOPPED_Msk , NRF_UARTE_INT_ENDRX_MASK = UARTE_INTENSET_DMARXEND_Msk , NRF_UARTE_INT_ENDTX_MASK = UARTE_INTENSET_DMATXEND_Msk , NRF_UARTE_INT_RXSTARTED_MASK = UARTE_INTENSET_DMARXREADY_Msk , NRF_UARTE_INT_TXSTARTED_MASK = UARTE_INTENSET_DMATXREADY_Msk , NRF_UARTE_INT_FRAME_TIMEOUT_MASK = UARTE_INTENSET_FRAMETIMEOUT_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... | |
| enum | nrf_uarte_frame_timeout_t { NRF_UARTE_FRAME_TIMEOUT_EN = UARTE_CONFIG_FRAMETIMEOUT_ENABLED << UARTE_CONFIG_FRAMETIMEOUT_Pos , NRF_UARTE_FRAME_TIMEOUT_DIS = UARTE_CONFIG_FRAMETIMEOUT_DISABLED << UARTE_CONFIG_FRAMETIMEOUT_Pos } |
| Types of UARTE Frame timeout. More... | |
| enum | nrf_uarte_frame_size_t { NRF_UARTE_FRAME_SIZE_4_BIT = UARTE_CONFIG_FRAMESIZE_4bit << UARTE_CONFIG_FRAMESIZE_Pos , NRF_UARTE_FRAME_SIZE_5_BIT = UARTE_CONFIG_FRAMESIZE_5bit << UARTE_CONFIG_FRAMESIZE_Pos , NRF_UARTE_FRAME_SIZE_6_BIT = UARTE_CONFIG_FRAMESIZE_6bit << UARTE_CONFIG_FRAMESIZE_Pos , NRF_UARTE_FRAME_SIZE_7_BIT = UARTE_CONFIG_FRAMESIZE_7bit << UARTE_CONFIG_FRAMESIZE_Pos , NRF_UARTE_FRAME_SIZE_8_BIT = UARTE_CONFIG_FRAMESIZE_8bit << UARTE_CONFIG_FRAMESIZE_Pos , NRF_UARTE_FRAME_SIZE_9_BIT = UARTE_CONFIG_FRAMESIZE_9bit << UARTE_CONFIG_FRAMESIZE_Pos } |
| Types of UARTE Frame size. More... | |
| enum | nrf_uarte_endian_t { NRF_UARTE_ENDIAN_MSB = UARTE_CONFIG_ENDIAN_MSB << UARTE_CONFIG_ENDIAN_Pos , NRF_UARTE_ENDIAN_LSB = UARTE_CONFIG_ENDIAN_LSB << UARTE_CONFIG_ENDIAN_Pos } |
| Types of UARTE Frame trimming endianness when frame size is less than 8. 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. | |
| 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. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_shorts_set (NRF_UARTE_Type *p_reg, uint32_t mask) |
| Function for configuring UARTE shortcuts. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_shorts_get (NRF_UARTE_Type *p_reg, uint32_t mask) |
| Function for getting UARTE shortcuts. | |
| NRF_STATIC_INLINE void | nrf_uarte_shorts_enable (NRF_UARTE_Type *p_reg, uint32_t mask) |
| Function for enabling UARTE shortcuts. | |
| NRF_STATIC_INLINE void | nrf_uarte_shorts_disable (NRF_UARTE_Type *p_reg, uint32_t mask) |
| Function for disabling UARTE shortcuts. | |
| NRF_STATIC_INLINE void | nrf_uarte_int_enable (NRF_UARTE_Type *p_reg, uint32_t mask) |
| Function for enabling UARTE interrupts. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_int_disable (NRF_UARTE_Type *p_reg, uint32_t mask) |
| Function for disabling the specified interrupts. | |
| 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. | |
| 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. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_subscribe_get (NRF_UARTE_Type const *p_reg, nrf_uarte_task_t task) |
| Function for getting the subscribe configuration for a given UARTE task. | |
| 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. | |
| 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. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_publish_get (NRF_UARTE_Type const *p_reg, nrf_uarte_event_t event) |
| Function for getting the publish configuration for a given UARTE event. | |
| 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. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_errorsrc_get (NRF_UARTE_Type *p_reg) |
| Function for getting error source mask. | |
| NRF_STATIC_INLINE void | nrf_uarte_errorsrc_clear (NRF_UARTE_Type *p_reg, uint32_t errsrc_mask) |
| Function for clearing error source flags after reading. | |
| NRF_STATIC_INLINE void | nrf_uarte_enable (NRF_UARTE_Type *p_reg) |
| Function for enabling UARTE. | |
| NRF_STATIC_INLINE void | nrf_uarte_disable (NRF_UARTE_Type *p_reg) |
| Function for disabling UARTE. | |
| NRF_STATIC_INLINE bool | nrf_uarte_enable_check (NRF_UARTE_Type const *p_reg) |
| Function for checking if the UARTE is enabled. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_txrx_pins_disconnect (NRF_UARTE_Type *p_reg) |
| Function for disconnecting TX/RX pins. | |
| NRF_STATIC_INLINE void | nrf_uarte_tx_pin_set (NRF_UARTE_Type *p_reg, uint32_t pseltxd) |
| Function for configuring TX pin. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_tx_pin_get (NRF_UARTE_Type const *p_reg) |
| Function for getting TX pin selection. | |
| NRF_STATIC_INLINE void | nrf_uarte_rx_pin_set (NRF_UARTE_Type *p_reg, uint32_t pselrxd) |
| Function for configuring RX pin. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_rx_pin_get (NRF_UARTE_Type const *p_reg) |
| Function for getting RX pin selection. | |
| NRF_STATIC_INLINE void | nrf_uarte_rts_pin_set (NRF_UARTE_Type *p_reg, uint32_t pselrts) |
| Function for configuring RTS pin. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_rts_pin_get (NRF_UARTE_Type const *p_reg) |
| Function for getting RTS pin selection. | |
| NRF_STATIC_INLINE void | nrf_uarte_cts_pin_set (NRF_UARTE_Type *p_reg, uint32_t pselcts) |
| Function for configuring CTS pin. | |
| NRF_STATIC_INLINE uint32_t | nrf_uarte_cts_pin_get (NRF_UARTE_Type const *p_reg) |
| Function for getting CTS pin selection. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_hwfc_pins_disconnect (NRF_UARTE_Type *p_reg) |
| Function for disconnecting flow control pins. | |
| NRF_STATIC_INLINE void | nrf_uarte_task_trigger (NRF_UARTE_Type *p_reg, nrf_uarte_task_t task) |
| Function for starting an UARTE task. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_configure (NRF_UARTE_Type *p_reg, nrf_uarte_config_t const *p_cfg) |
| Function for configuring UARTE. | |
| NRF_STATIC_INLINE void | nrf_uarte_baudrate_set (NRF_UARTE_Type *p_reg, nrf_uarte_baudrate_t baudrate) |
| Function for setting UARTE baud rate. | |
| NRF_STATIC_INLINE void | nrf_uarte_tx_maxcnt_set (NRF_UARTE_Type *p_reg, size_t length) |
| Function for setting the transmit buffer length. | |
| NRF_STATIC_INLINE void | nrf_uarte_tx_ptr_set (NRF_UARTE_Type *p_reg, uint8_t const *p_buffer) |
| Function for setting the transmit buffer pointer. | |
| 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. | |
| NRF_STATIC_INLINE uint8_t const * | nrf_uarte_tx_buffer_get (NRF_UARTE_Type *p_reg) |
| Function for getting the transmit buffer address. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_rx_maxcnt_set (NRF_UARTE_Type *p_reg, size_t length) |
| Function for setting the receive buffer length. | |
| NRF_STATIC_INLINE void | nrf_uarte_rx_ptr_set (NRF_UARTE_Type *p_reg, uint8_t *p_buffer) |
| Function for setting the receive buffer pointer. | |
| 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. | |
| NRF_STATIC_INLINE uint8_t * | nrf_uarte_rx_buffer_get (NRF_UARTE_Type *p_reg) |
| Function for getting the reception buffer address. | |
| 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. | |
| NRF_STATIC_INLINE void | nrf_uarte_frame_timeout_set (NRF_UARTE_Type *p_reg, uint32_t timeout) |
| Function for setting frame timeout. | |
| NRF_STATIC_INLINE void | nrf_uarte_address_set (NRF_UARTE_Type *p_reg, uint8_t address) |
| Function for setting address register. | |
| NRF_STATIC_INLINE uint8_t | nrf_uarte_address_get (NRF_UARTE_Type const *p_reg) |
| Function for getting address. | |
Hardware access layer for managing the UARTE peripheral.
| #define NRF_UARTE_BASE_FREQUENCY_GET | ( | p_reg | ) |
Macro for getting base frequency value in Hz for the specified UARTE.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| #define NRF_UARTE_INST_GET | ( | idx | ) |
Macro getting pointer to the structure of registers of the UARTE peripheral.
| [in] | idx | UARTE instance index. |
| #define NRF_UARTE_IS_128MHZ_UARTE | ( | p_reg | ) |
Macro for checking whether the base frequency for the specified UARTE is 128 MHz.
| #define NRF_UARTE_IS_320MHZ_UARTE | ( | p_reg | ) |
Macro for checking whether the base frequency for the specified UARTE is 320 MHz.
| #define NRF_UARTE_IS_64MHZ_UARTE | ( | p_reg | ) |
Macro for checking whether the base frequency for the specified UARTE is 64 MHz.
| enum nrf_uarte_baudrate_t |
Baudrates supported by UARTE.
| enum nrf_uarte_endian_t |
| enum nrf_uarte_event_t |
UARTE events.
Types of UARTE Frame size.
| enum nrf_uarte_hwfc_t |
| enum nrf_uarte_int_mask_t |
UARTE interrupts.
| enum nrf_uarte_parity_t |
| enum nrf_uarte_short_t |
Types of UARTE shortcuts.
| enum nrf_uarte_stop_t |
| enum nrf_uarte_task_t |
UARTE tasks.
| NRF_STATIC_INLINE uint8_t nrf_uarte_address_get | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for getting address.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| Address | value. |
| NRF_STATIC_INLINE void nrf_uarte_address_set | ( | NRF_UARTE_Type * | p_reg, |
| uint8_t | address ) |
Function for setting address register.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | address | Address. |
| 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_cts_pin_set | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | pselcts ) |
Function for configuring CTS pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pselcts | CTS pin number. |
| 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 bool nrf_uarte_enable_check | ( | NRF_UARTE_Type const * | p_reg | ) |
Function for checking if the UARTE is enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| true | The UARTE is enabled. |
| false | The UARTE is not enabled. |
| NRF_STATIC_INLINE void nrf_uarte_errorsrc_clear | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | errsrc_mask ) |
Function for clearing error source flags after reading.
| p_reg | Pointer to the structure of registers of the peripheral. |
| errsrc_mask | Mask with error sources to be cleared. |
| NRF_STATIC_INLINE uint32_t nrf_uarte_errorsrc_get | ( | NRF_UARTE_Type * | p_reg | ) |
Function for getting error source mask.
| 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_frame_timeout_set | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | timeout ) |
Function for setting frame timeout.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | timeout | Frame timeout in bits. |
| 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. Use nrf_uarte_int_mask_t values for bit masking. |
| 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. Use nrf_uarte_int_mask_t values for bit masking. |
| 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. Use nrf_uarte_int_mask_t values for bit masking. |
| 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 uint32_t nrf_uarte_publish_get | ( | NRF_UARTE_Type const * | p_reg, |
| nrf_uarte_event_t | event ) |
Function for getting 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 read 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 void nrf_uarte_rts_pin_set | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | pselrts ) |
Function for configuring RTS pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pselrts | RTS pin number. |
| 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 uint8_t * nrf_uarte_rx_buffer_get | ( | NRF_UARTE_Type * | p_reg | ) |
Function for getting the reception buffer address.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| 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 void nrf_uarte_rx_maxcnt_set | ( | NRF_UARTE_Type * | p_reg, |
| size_t | length ) |
Function for setting the receive buffer length.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [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_rx_pin_set | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | pselrxd ) |
Function for configuring RX pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pselrxd | RXD pin number. |
| NRF_STATIC_INLINE void nrf_uarte_rx_ptr_set | ( | NRF_UARTE_Type * | p_reg, |
| uint8_t * | p_buffer ) |
Function for setting the receive buffer pointer.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | p_buffer | Pointer to the buffer for received data. |
| 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 uint32_t nrf_uarte_shorts_get | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | mask ) |
Function for getting UARTE shortcuts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Shortcuts to be checked. |
| NRF_STATIC_INLINE void nrf_uarte_shorts_set | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | mask ) |
Function for configuring UARTE shortcuts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Shortcuts to be set. |
| 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 uint32_t nrf_uarte_subscribe_get | ( | NRF_UARTE_Type const * | p_reg, |
| nrf_uarte_task_t | task ) |
Function for getting 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 read 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 uint8_t const * nrf_uarte_tx_buffer_get | ( | NRF_UARTE_Type * | p_reg | ) |
Function for getting the transmit buffer address.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| 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 void nrf_uarte_tx_maxcnt_set | ( | NRF_UARTE_Type * | p_reg, |
| size_t | length ) |
Function for setting the transmit buffer length.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | length | Maximum number of data bytes to receive. |
| 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_tx_pin_set | ( | NRF_UARTE_Type * | p_reg, |
| uint32_t | pseltxd ) |
Function for configuring TX pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pseltxd | TXD pin number. |
| NRF_STATIC_INLINE void nrf_uarte_tx_ptr_set | ( | NRF_UARTE_Type * | p_reg, |
| uint8_t const * | p_buffer ) |
Function for setting the transmit buffer pointer.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | p_buffer | Pointer to the buffer for received data. |
| 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. |