hal_uart_descriptor_t

nRF5 SDK v15.0.0

This structure defines the UART module operation. More...

#include <hal_uart.h>

Detailed Description

This structure defines the UART module operation.

If write_buffer_ptr is defined as NULL, then sending data will work in blocking way, that is call for hal_uart_write will be completed only after sending of the last byte passed as input parameter.

If read_buffer_ptr is defined as NULL, then driver will drop every received byte.

Field Documentation

hal_uart_error_handler_t hal_uart_descriptor_t::error_handler
     Callback function in case of something

goes wrong.

void* hal_uart_descriptor_t::read_buffer_ptr

User-side buffer for read operation.

size_t hal_uart_descriptor_t::read_buffer_size

Size of read operation buffer.

hal_uart_handler_t hal_uart_descriptor_t::read_handler

Callback function for read operation.

hal_uart_config_t hal_uart_descriptor_t::uart_config

UART settings struct.

void* hal_uart_descriptor_t::write_buffer_ptr

User-side buffer for write operation.

size_t hal_uart_descriptor_t::write_buffer_size

Size of write operation buffer.

hal_uart_handler_t hal_uart_descriptor_t::write_handler

Callback function for write operation.

  • components/802_15_4/api/HAL/hal_uart.h