函数列表¶
Function gx_uart_async_recv_buffer¶
-
int gx_uart_async_recv_buffer(int port, unsigned char *buffer, int length, UART_RECV_DONE_CALLBACK callback, void *priv)
异步接收串口数据
- 参数
port -- 端口
buffer -- 接收数据 buffer， buffer 和 buffer 的实际长度需要 CACHE LINE 对齐
length -- 接收数据的长度
callback -- 数据接收完成回调
priv -- 回调参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_recv_buffer_intr¶
-
int gx_uart_async_recv_buffer_intr(int port, unsigned char *buffer, int length, UART_RECV_DONE_CALLBACK callback, void *priv)
异步接收串口数据
- 参数
port -- 端口
buffer -- 接收数据 buffer
length -- 接收数据的长度
callback -- 数据接收完成回调
priv -- 回调参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_recv_buffer_stop¶
-
int gx_uart_async_recv_buffer_stop(int port)
停止串口异步接收接口
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_recv_buffer_stop_intr¶
-
int gx_uart_async_recv_buffer_stop_intr(int port)
停止串口异步接收接口
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_recv_buffer_unlimited¶
-
int gx_uart_async_recv_buffer_unlimited(int port, unsigned char *buffer, int length, UART_RECV_UNLIMITED_DONE_CALLBACK callback, void *priv)
异步无限接收串口数据，callback 中将会通知当前已经接收的数据存放位置和长度
- 参数
port -- 端口
buffer -- 接收数据 buffer， buffer 和 buffer 的实际长度需要 CACHE LINE 对齐
length -- 接收数据的长度
callback -- 数据接收完成回调
priv -- 回调参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_send_buffer¶
-
int gx_uart_async_send_buffer(int port, unsigned char *buffer, int length, UART_SEND_DONE_CALLBACK callback, void *priv)
异步发送串口数据
- 参数
port -- 端口
buffer -- 需要发送的数据, buffer 和 buffer 的实际长度需要 CACHE LINE 对齐
length -- 数据长度
callback -- 数据发送完成回调
priv -- 回调参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_send_buffer_intr¶
-
int gx_uart_async_send_buffer_intr(int port, unsigned char *buffer, int length, UART_SEND_DONE_CALLBACK callback, void *priv)
异步发送串口数据
- 参数
port -- 端口
buffer -- 需要发送的数据
length -- 数据长度
callback -- 数据发送完成回调
priv -- 回调参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_send_buffer_stop¶
-
int gx_uart_async_send_buffer_stop(int port)
停止串口异步发送接口
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_async_send_buffer_stop_intr¶
-
int gx_uart_async_send_buffer_stop_intr(int port)
停止串口异步发送接口
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_can_read¶
-
int gx_uart_can_read(int port)
判断 fifo 中是否有数据
- 参数
port -- 端口
- Returns 0
没有数据
- Returns 1
有数据
- 返回
int 结果
Function gx_uart_compatible_putc¶
-
void gx_uart_compatible_putc(int port, int ch)
输出一个字符, 如果是换行,转换成回车输出
- 参数
port -- 端口
ch -- 要输出的字符
Function gx_uart_exit¶
-
int gx_uart_exit(int port)
串口退出
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_flow_off¶
-
int gx_uart_flow_off(int port)
关闭串口流控
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_flow_on¶
-
int gx_uart_flow_on(int port)
开启串口流控
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_init¶
-
int gx_uart_init(int port, uint32_t baudrate)
串口初始化 只需要调用一次，且串口在时候过程中不能调用
- 参数
port -- 端口
baudrate -- 波特率, 支持标准波特率， 一般为 115200
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_read¶
-
int gx_uart_read(int port, unsigned char *buf, int len)
同步读取指定长度的数据 如果没有读到指定的数据，会一直等待
- 参数
port -- 端口
buf -- 读取到的数据保存buf
len -- 数据长度
- 返回
int 实际读取到的数据长度
Function gx_uart_read_fifo¶
-
int gx_uart_read_fifo(int port, unsigned char *buf, int len)
直接读取 rx fifo 数据，可用于 gx_uart_start_async_recv 回调函数中，获取到有效数据量后，直接读取数据
- 参数
port -- 端口
buf -- 读取到的数据保存buf
len -- 数据长度
- 返回
int 实际读取到的数据长度
Function gx_uart_read_non_block¶
-
int gx_uart_read_non_block(int port, unsigned char *buf, int len, unsigned int timeout_ms)
读取指定长度的数据, 指定时间内没有读到指定长度的数据，立即返回
- 参数
port -- 端口
buf -- 读取到的数据保存buf
len -- 数据长度
timeout_ms -- 超时时间
- 返回
int 实际读取到的数据长度
Function gx_uart_recv_buffer¶
-
int gx_uart_recv_buffer(int port, unsigned char *buffer, int length)
接收串口数据， 但是不检查 fifo 中是否有数据 和 gx_uart_start_async_recv 函数配合使用
- 参数
port -- 端口
buffer -- 接收数据 buffer
length -- 数据长度
- 返回
int 实际接收数据长度
Function gx_uart_resume¶
-
int gx_uart_resume(int port)
串口恢复
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_send_buffer¶
-
int gx_uart_send_buffer(int port, unsigned char *buffer, int length)
发送串口数据， 但是不检查 fifo 是否满， 和 gx_uart_start_async_send 配合使用
- 参数
port -- 端口
buffer -- 要发送的数据
length -- 数据长度
- 返回
int 实际发送数据长度
Function gx_uart_set_freq¶
-
int gx_uart_set_freq(int port, int freq)
设置串口工作频率 设置串口的输入频率，调用该接口后要调用gx_uart_init重新初始化串口
- 参数
port -- 端口
freq -- 频率
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_set_recv_fifo_threshold¶
-
int gx_uart_set_recv_fifo_threshold(int port, GX_UART_FIFO_RECV_THRESHOLD threshold)
设置接收 fio 中断触发门限
- 参数
port -- 端口
threshold -- 门限值, 详细说明请参考 GX_UART_FIFO_RECV_THRESHOLD
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_set_send_fifo_threshold¶
-
int gx_uart_set_send_fifo_threshold(int port, GX_UART_FIFO_SEND_THRESHOLD threshold)
设置串口发送 fifo 中断触发门限
- 参数
port -- 端口
threshold -- 门限值, 详细说明请参考 GX_UART_FIFO_SEND_THRESHOLD
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_start_async_recv¶
-
int gx_uart_start_async_recv(int port, UART_CAN_RECV_CALLBACK callback, void *priv)
开始异步发送串口数据
- 参数
port -- 端口
callback -- 可以发送串口数据回调函数
priv -- 回调函数参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_start_async_send¶
-
int gx_uart_start_async_send(int port, UART_CAN_SEND_CALLBACK callback, void *priv)
开始异步接收串口数据
- 参数
port -- 端口
callback -- 串口有数据可以接收回调函数
priv -- 回调函数参数
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_stop_async_recv¶
-
int gx_uart_stop_async_recv(int port)
停止异步发送串口数据
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_stop_async_send¶
-
int gx_uart_stop_async_send(int port)
停止异步接收串口数据
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 函数是否执行成功
Function gx_uart_suspend¶
-
int gx_uart_suspend(int port)
串口暂停
- 参数
port -- 端口
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_try_getc¶
-
int gx_uart_try_getc(int port, char *c)
尝试获取一个字符，如果没有获取到字符，立马返回
- 参数
port -- 端口
c -- 获取到的字符
- Returns 0
成功
- Returns -1
失败
- 返回
int 是否成功
Function gx_uart_write¶
-
int gx_uart_write(int port, const unsigned char *buf, int len)
同步写指定长度的数据 以阻塞的方式写入 len
- 参数
port -- 端口
buf -- 需要写出的数据buf
len -- 数据长度
- 返回
int 实际写出数据长度