xf_hal_uart.h 文件参考

xf_hal 的 uart(通用异步收发器) 设备抽象。 更多...

#include "xf_hal_device_config.h"
#include "xf_hal_gpio.h"

xf_hal_uart.h 的引用(Include)关系图:

浏览源代码.

结构体
struct	_xf_hal_uart_config_t
	用于对接 uart 设置的参数。 更多...

类型定义
typedef uint32_t	xf_uart_num_t
	uart 序号。
typedef enum _xf_hal_uart_data_bits_t	xf_hal_uart_data_bits_t
	uart 的数据位。
typedef enum _xf_hal_uart_stop_bits_t	xf_hal_uart_stop_bits_t
	uart 的停止位。
typedef enum _xf_hal_uart_parity_bits_t	xf_hal_uart_parity_bits_t
	uart 校验位。
typedef enum _xf_hal_uart_flow_control_t	xf_hal_uart_flow_control_t
	uart 流控模式。
typedef enum _xf_hal_uart_cmd_t	xf_hal_uart_cmd_t
	用于对接 uart 设置的命令。
typedef struct _xf_hal_uart_config_t	xf_hal_uart_config_t
	用于对接 uart 设置的参数。

枚举
enum	_xf_hal_uart_data_bits_t {   _XF_HAL_UART_DATA_BIT_BASE = 0 , XF_HAL_UART_DATA_BIT_5 = _XF_HAL_UART_DATA_BIT_BASE , XF_HAL_UART_DATA_BIT_6 , XF_HAL_UART_DATA_BIT_7 ,   XF_HAL_UART_DATA_BIT_8 , XF_HAL_UART_DATA_BIT_9 , _XF_HAL_UART_DATA_BIT_MAX }
	uart 的数据位。 更多...
enum	_xf_hal_uart_stop_bits_t {   _XF_HAL_UART_STOP_BIT_BASE = 0 , XF_HAL_UART_STOP_BIT_1 = _XF_HAL_UART_STOP_BIT_BASE , XF_HAL_UART_STOP_BIT_1_5 , XF_HAL_UART_STOP_BIT_2 ,   _XF_HAL_UART_STOP_BIT_MAX }
	uart 的停止位。 更多...
enum	_xf_hal_uart_parity_bits_t {   _XF_HAL_UART_PARITY_BITS_BASE = 0 , XF_HAL_UART_PARITY_BITS_NONE = _XF_HAL_UART_PARITY_BITS_BASE , XF_HAL_UART_PARITY_BITS_EVEN , XF_HAL_UART_PARITY_BITS_ODD ,   XF_HAL_UART_PARITY_BITS_SPACE , XF_HAL_UART_PARITY_BITS_MARK , _XF_HAL_UART_PARITY_BITS_MAX }
	uart 校验位。 更多...
enum	_xf_hal_uart_flow_control_t {   _XF_HAL_UART_FLOW_CONTROL_BASE = 0 , XF_HAL_UART_FLOW_CONTROL_NONE = _XF_HAL_UART_FLOW_CONTROL_BASE , XF_HAL_UART_FLOW_CONTROL_RTS , XF_HAL_UART_FLOW_CONTROL_CTS ,   XF_HAL_UART_FLOW_CONTROL_RTS_CTS , _XF_HAL_UART_FLOW_CONTROL_MAX }
	uart 流控模式。 更多...
enum	_xf_hal_uart_cmd_t {   XF_HAL_UART_CMD_DEFAULT = 0x0 , XF_HAL_UART_CMD_ENABLE = 0x1 << 0 , XF_HAL_UART_CMD_DATA_BITS = 0x1 << 1 , XF_HAL_UART_CMD_STOP_BITS = 0x1 << 2 ,   XF_HAL_UART_CMD_PARITY_BITS = 0x1 << 3 , XF_HAL_UART_CMD_FLOW_CONTROL = 0x1 << 4 , XF_HAL_UART_CMD_BAUDRATE = 0x1 << 5 , XF_HAL_UART_CMD_TX_NUM = 0x1 << 6 ,   XF_HAL_UART_CMD_RX_NUM = 0x1 << 7 , XF_HAL_UART_CMD_RTS_NUM = 0x1 << 8 , XF_HAL_UART_CMD_CTS_NUM = 0x1 << 9 , XF_HAL_UART_CMD_ALL = 0x7FFFFFFF }
	用于对接 uart 设置的命令。 更多...

函数
xf_err_t	xf_hal_uart_init (xf_uart_num_t uart_num, uint32_t baudrate)
	uart 初始化。
xf_err_t	xf_hal_uart_deinit (xf_uart_num_t uart_num)
	uart 反初始化。
xf_err_t	xf_hal_uart_enable (xf_uart_num_t uart_num)
	uart 启用函数。
xf_err_t	xf_hal_uart_disable (xf_uart_num_t uart_num)
	uart 禁用函数。
xf_err_t	xf_hal_uart_set_gpio (xf_uart_num_t uart_num, xf_gpio_num_t tx_num, xf_gpio_num_t rx_num)
	uart 设置 uart 的通讯 io。
xf_err_t	xf_hal_uart_set_config (xf_uart_num_t uart_num, xf_hal_uart_data_bits_t data_bits, xf_hal_uart_stop_bits_t stop_bits, xf_hal_uart_parity_bits_t parity_bits)
	设置 uart 相关配置。
xf_err_t	xf_hal_uart_set_baudrate (xf_uart_num_t uart_num, uint32_t baudrate)
	设置 uart 的波特率。
uint32_t	xf_hal_uart_get_baudrate (xf_uart_num_t uart_num)
	获取当前 uart 的波特率。
xf_err_t	xf_hal_uart_set_flow_control (xf_uart_num_t uart_num, xf_hal_uart_flow_control_t flow_control, xf_gpio_num_t rts_num, xf_gpio_num_t cts_num)
	uart 流控 io 设置。
int	xf_hal_uart_read (xf_uart_num_t uart_num, uint8_t *data, uint32_t data_len)
	uart 读取函数。
int	xf_hal_uart_write (xf_uart_num_t uart_num, const uint8_t *data, uint32_t data_len)
	uart 写入函数。

详细描述

xf_hal 的 uart(通用异步收发器) 设备抽象。

作者

cangyu (sky.k.nosp@m.irto.nosp@m.@qq.c.nosp@m.om)

版本

0.1

日期

2024-05-15

版权所有

Copyright (c) 2024, CorAL. All rights reserved.

在文件 xf_hal_uart.h 中定义.