doxygen/html/uart__emul_8h_source.html

/*

 * Copyright (c) 2023 Fabian Blatz

 *

 * SPDX-License-Identifier: Apache-2.0

 */


#ifndef ZEPHYR_INCLUDE_DRIVERS_SERIAL_UART_EMUL_H_

#define ZEPHYR_INCLUDE_DRIVERS_SERIAL_UART_EMUL_H_


#include <zephyr/device.h>

#include <zephyr/types.h>


#ifdef __cplusplus

extern "C" {

#endif


typedef void (*uart_emul_callback_tx_data_ready_t)(const struct device *dev, size_t size,

                                                   void *user_data);


void uart_emul_callback_tx_data_ready_set(const struct device *dev,

                                          uart_emul_callback_tx_data_ready_t cb, void *user_data);


uint32_t uart_emul_put_rx_data(const struct device *dev, const uint8_t *data, size_t size);


uint32_t uart_emul_get_tx_data(const struct device *dev, uint8_t *data, size_t size);


uint32_t uart_emul_flush_rx_data(const struct device *dev);


uint32_t uart_emul_flush_tx_data(const struct device *dev);


void uart_emul_set_errors(const struct device *dev, int errors);


void uart_emul_set_release_buffer_on_timeout(const struct device *dev, bool release_on_timeout);


#ifdef __cplusplus

}

#endif


#endif /* ZEPHYR_INCLUDE_DRIVERS_SERIAL_UART_EMUL_H_ */

device.h

types.h

uint32_t
__UINT32_TYPE__ uint32_t
Definition stdint.h:90

uint8_t
__UINT8_TYPE__ uint8_t
Definition stdint.h:88

device
Runtime device structure (in ROM) per driver instance.
Definition device.h:403

data
static fdata_t data[2]
Definition test_fifo_contexts.c:15

user_data
static const intptr_t user_data[5]
Definition main.c:588

uart_emul_flush_tx_data
uint32_t uart_emul_flush_tx_data(const struct device *dev)
Clear TX buffer content.

uart_emul_set_errors
void uart_emul_set_errors(const struct device *dev, int errors)
Sets one or more driver errors.

uart_emul_flush_rx_data
uint32_t uart_emul_flush_rx_data(const struct device *dev)
Clear RX buffer content.

uart_emul_put_rx_data
uint32_t uart_emul_put_rx_data(const struct device *dev, const uint8_t *data, size_t size)
Write (copy) data to RX buffer.

uart_emul_callback_tx_data_ready_t
void(* uart_emul_callback_tx_data_ready_t)(const struct device *dev, size_t size, void *user_data)
Define the application callback function signature for uart_emul_callback_tx_data_ready_set() functio...
Definition uart_emul.h:30

uart_emul_get_tx_data
uint32_t uart_emul_get_tx_data(const struct device *dev, uint8_t *data, size_t size)
Read data from TX buffer.

uart_emul_set_release_buffer_on_timeout
void uart_emul_set_release_buffer_on_timeout(const struct device *dev, bool release_on_timeout)
Configures if rx buffer should be released on timeout, even when only partially filled.

uart_emul_callback_tx_data_ready_set
void uart_emul_callback_tx_data_ready_set(const struct device *dev, uart_emul_callback_tx_data_ready_t cb, void *user_data)
Set the TX data ready callback.