hal_uart.h 文件参考

#include <stdint.h>
#include <stdbool.h>
#include "common_def.h"
#include "errcode.h"
#include "uart_porting.h"

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

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

结构体
struct	hal_uart_pin_config_t
	UART的PIN配置数据结构定义 更多...
struct	uart_attr
	UART基础配置参数定义 更多...
struct	uart_extra_attr
	UART扩展配置参数定义 更多...
struct	hal_uart_funcs_t
	Driver层UART和HAL层UART的接口 更多...

类型定义
typedef enum hal_uart_data_bit	hal_uart_data_bit_t
	UART数据位定义
typedef enum hal_uart_parity	hal_uart_parity_t
	UART奇偶校验位定义
typedef enum hal_uart_stop_bit	hal_uart_stop_bit_t
	UART停止位定义
typedef enum hal_uart_ctrl_id	hal_uart_ctrl_id_t
	UART控制ID定义
typedef enum hal_uart_evt_id	hal_uart_evt_id_t
	HAL层UART事件ID的定义
typedef struct uart_attr	hal_uart_attr_t
	UART基础配置参数定义
typedef struct uart_extra_attr	hal_uart_extra_attr_t
	UART扩展配置参数定义
typedef errcode_t(*	hal_uart_callback_t) (uart_bus_t bus, hal_uart_evt_id_t evt, uintptr_t param)
	UART的回调函数
typedef errcode_t(*	hal_uart_init_t) (uart_bus_t bus, hal_uart_callback_t callback, const hal_uart_pin_config_t *pins, const hal_uart_attr_t *attr, hal_uart_flow_ctrl_t flow_ctrl, hal_uart_extra_attr_t *extra_attr)
	HAL层UART的初始化接口
typedef errcode_t(*	hal_uart_deinit_t) (uart_bus_t bus)
	HAL层UART去初始化接口
typedef errcode_t(*	hal_uart_ctrl_t) (uart_bus_t bus, hal_uart_ctrl_id_t id, uintptr_t param)
	HAL层UART控制接口
typedef errcode_t(*	hal_uart_write_t) (uart_bus_t bus, const uint8_t *data, uint16_t len)
	HAL层UART发送数据接口
typedef int32_t(*	hal_uart_read_t) (uart_bus_t bus, const uint8_t *data, uint16_t len)
	HAL层UART读取数据接口
typedef void(*	hal_uart_dma_cfg_t) (uart_bus_t bus, const hal_uart_extra_attr_t *extra_attr)
	HAL层配置DMA传输接口

枚举
enum	hal_uart_data_bit { UART_DATA_BIT_5 , UART_DATA_BIT_6 , UART_DATA_BIT_7 , UART_DATA_BIT_8 }
	UART数据位定义 更多...
enum	hal_uart_parity { UART_PARITY_NONE , UART_PARITY_ODD , UART_PARITY_EVEN }
	UART奇偶校验位定义 更多...
enum	hal_uart_stop_bit { UART_STOP_BIT_1 , UART_STOP_BIT_2 }
	UART停止位定义 更多...
enum	uart_fifo_rx_int_lvl_t {   UART_FIFO_INT_RX_LEVEL_1_CHARACTER = 0 , UART_FIFO_INT_RX_LEVEL_1_8 = 0 , UART_FIFO_INT_RX_LEVEL_1_4 = 1 , UART_FIFO_INT_RX_LEVEL_1_2 = 2 ,   UART_FIFO_INT_RX_LEVEL_2_LESS_THAN_FULL = 3 , UART_FIFO_INT_RX_LEVEL_3_4 = 3 , UART_FIFO_INT_RX_LEVEL_7_8 = 4 }
	HAL层UART触发RX中断水线定义 更多...
enum	uart_fifo_tx_int_lvl_t {   UART_FIFO_INT_TX_LEVEL_EQ_0_CHARACTER = 0 , UART_FIFO_INT_TX_LEVEL_1_8 = 0 , UART_FIFO_INT_TX_LEVEL_EQ_2_CHARACTER = 1 , UART_FIFO_INT_TX_LEVEL_1_4 = 2 ,   UART_FIFO_INT_TX_LEVEL_1_2 = 3 , UART_FIFO_INT_TX_LEVEL_3_4 = 4 , UART_FIFO_INT_TX_LEVEL_7_8 = 5 }
	HAL层UART触发TX中断水线定义 更多...
enum	hal_uart_ctrl_id {   UART_CTRL_SET_ATTR = 0 , UART_CTRL_GET_ATTR , UART_CTRL_EN_TX_INT , UART_CTRL_EN_RX_INT ,   UART_CTRL_EN_IDLE_INT , UART_CTRL_EN_PARITY_ERR_INT , UART_CTRL_EN_FRAME_ERR_INT , UART_CTRL_CHECK_TX_FIFO_FULL ,   UART_CTRL_CHECK_TX_BUSY , UART_CTRL_CHECK_RX_FIFO_EMPTY , UART_CTRL_FIFO_ENABLE , UART_CTRL_SET_RX_FIFO_LEVEL ,   UART_CTRL_SET_TX_FIFO_LEVEL , UART_CTRL_GET_REG_ADDRS , UART_CTRL_TX_DMA_PROCESS , UART_CTRL_FLOW_CTRL ,   UART_CTRL_RESTORE , UART_CTRL_CHECK_UART_BUSY , UART_CTRL_GET_RX_FIFO_PASSNUM , UART_CTRL_SUSPEND ,   UART_CTRL_RESUME , UART_CTRL_GET_DMA_DATA_ADDR , UART_CTRL_GET_RX_FIFO_THRESHOLD , UART_CTRL_MAX ,   UART_CTRL_ID_INVALID = 0xFF }
	UART控制ID定义 更多...
enum	hal_uart_evt_id {   UART_EVT_RX_ISR = 1 , UART_EVT_TX_ISR , UART_EVT_IDLE_ISR , UART_EVT_PARITY_ERR_ISR ,   UART_EVT_FRAME_ERR_ISR , UART_EVT_BREAK_ERR_ISR , UART_EVT_OVERRUN_ERR_ISR }
	HAL层UART事件ID的定义 更多...
enum	hal_uart_dma_process_t { UART_DMA_PROCESS_PREPARE , UART_DMA_PROCESS_FINISH , UART_DMA_PROCESS_INVALID = 0xFF }
	DMA处理类型定义 更多...
enum	hal_uart_flow_ctrl_t {   UART_FLOW_CTRL_NONE = 0x0 , UART_FLOW_CTS = 0x1 , UART_FLOW_RTS = 0x2 , UART_FLOW_CTRL_RTS_CTS = UART_FLOW_CTS | UART_FLOW_RTS ,   UART_FLOW_CTRL_SOFT = 0x4 }
	Definition of UART Flow Control. 更多...

函数
errcode_t	hal_uart_register_funcs (uart_bus_t bus, hal_uart_funcs_t *funcs)
	注册 hal_uart_funcs_t 到 g_hal_uarts_funcs
errcode_t	hal_uart_unregister_funcs (uart_bus_t bus)
	从g_hal_uarts_funcs注销 hal_uart_funcs_t
uintptr_t	hal_uart_base_addrs_get (uart_bus_t bus)
	获取指定UART的基地址。
errcode_t	hal_uart_regs_init (uart_bus_t bus)
	初始化UART，设置寄存器的基地址
hal_uart_funcs_t *	hal_uart_get_funcs (uart_bus_t bus)
	获取Driver层UART和HAL层UART的接口实例，参考 hal_uart_funcs_t.
errcode_t	hal_uart_set_tx_fifo_int_level (uart_bus_t bus, uart_fifo_tx_int_lvl_t level)
	设置uart触发中断的发送fifo阈值
errcode_t	hal_uart_set_rx_fifo_int_level (uart_bus_t bus, uart_fifo_rx_int_lvl_t level)
	设置uart触发接收中断的接收fifo阈值
errcode_t	hal_uart_init (uart_bus_t bus, hal_uart_callback_t callback, const hal_uart_pin_config_t *pins, const hal_uart_attr_t *attr, hal_uart_flow_ctrl_t flow_ctrl, hal_uart_extra_attr_t *extra_attr)
	HAL层UART的初始化接口
errcode_t	hal_uart_deinit (uart_bus_t bus)
	HAL层UART去初始化接口
errcode_t	hal_uart_ctrl (uart_bus_t bus, hal_uart_ctrl_id_t id, uintptr_t param)
	HAL层UART控制接口
errcode_t	hal_uart_write (uart_bus_t bus, const uint8_t *data, uint16_t len)
	HAL层UART发送数据接口
int32_t	hal_uart_read (uart_bus_t bus, const uint8_t *data, uint16_t len)
	HAL层UART读取数据接口
void	hal_uart_set_dma_config (uart_bus_t bus, const hal_uart_extra_attr_t *extra_attr)
	HAL层配置DMA传输接口