USB2XXX 1.2
USB2XXX接口函数说明文档
载入中...
搜索中...
未找到
结构体 | 类型定义 | 函数
USB转UART

USB转UART接口函数和数据类型定义 更多...

结构体

struct  _UART_CONFIG
 UART初始化结构体 更多...
 

类型定义

typedef struct _UART_CONFIG UART_CONFIG
 UART初始化结构体
 
typedef struct _UART_CONFIG * PUART_CONFIG
 

函数

int WINAPI UART_Init (int DevHandle, unsigned char Channel, PUART_CONFIG pConfig)
 初始化UART，必须调用，否则后面的函数无法正常执行 更多...
 
int WINAPI UART_WriteBytes (int DevHandle, unsigned char Channel, unsigned char *pWriteData, int DataSize)
 发送UART数据，该函数为阻塞函数，数据发送完毕后函数才会返回 更多...
 
int WINAPI UART_WriteBytesWithBreak (int DevHandle, unsigned char Channel, unsigned char BreakLen, unsigned char *pWriteData, int DataSize)
 发送UART数据，发送数据前会发送同步间隔信号，该函数为阻塞函数，数据发送完毕后函数才会返回 更多...
 
int WINAPI UART_WriteBytesAsync (int DevHandle, unsigned char Channel, unsigned char *pWriteData, int DataSize)
 发送UART数据，该函数为非阻塞函数，调用后数据会先缓存到适配器，然后立即返回，适配器继续发送数据 更多...
 
int WINAPI UART_WriteBytesAsyncWithBreak (int DevHandle, unsigned char Channel, unsigned char BreakLen, unsigned char *pWriteData, int DataSize)
 发送UART数据，发送数据前会先发送同步间隔信号，该函数为非阻塞函数，调用后数据会先缓存到适配器，然后立即返回，适配器继续发送数据 更多...
 
int WINAPI UART_WriteReadBytesWithBreak (int DevHandle, unsigned char Channel, unsigned char BreakLen, unsigned char *pWriteData, int WriteSize, unsigned char *pReadData, int ReadSize, int TimeOutMs)
 发送读取UART数据，发送完数据后会按照设定读取指定字节数数据，除非超时为止 更多...
 
int WINAPI UART_WriteBytesInterval (int DevHandle, unsigned char Channel, unsigned char *pWriteData, int DataSize, unsigned char IntervalTimeMs)
 根据设定的字节间隔发送数据，该函数为阻塞函数，数据发送完毕后才会返回 更多...
 
int WINAPI UART_WriteBytesIntervalUs (int DevHandle, unsigned char Channel, unsigned char *pWriteData, int DataSize, unsigned char IntervalTimeUs)
 根据设定的字节间隔发送数据，该函数为阻塞函数，数据发送完毕后才会返回 更多...
 
int WINAPI UART_ReadBytes (int DevHandle, unsigned char Channel, unsigned char *pReadData, int TimeOutMs)
 获取适配器已经接收到的串口数据 更多...
 
int WINAPI UART_ClearData (int DevHandle, unsigned char Channel)
 清空数据接收缓冲区数据 更多...
 

函数返回错误值宏定义

函数调用出错后返回值定义

#define UART_SUCCESS   (0)
 函数执行成功
 
#define UART_ERR_NOT_SUPPORT   (-1)
 适配器不支持该函数
 
#define UART_ERR_USB_WRITE_FAIL   (-2)
 USB写数据失败
 
#define UART_ERR_USB_READ_FAIL   (-3)
 USB读数据失败
 
#define UART_ERR_CMD_FAIL   (-4)
 命令执行失败
 

数据位宽

数据位宽定义

#define UART_WORD_LENGTH_8BIT   0
 
#define UART_WORD_LENGTH_9BIT   1
 

停止位

停止位定义

#define UART_STOP_BITS_1   0
 
#define UART_STOP_BITS_05   1
 
#define UART_STOP_BITS_2   2
 
#define UART_STOP_BITS_15   3
 

奇偶校验位

奇偶校验位定义

#define UART_PARITY_NONE   0
 
#define UART_PARITY_EVEN   4
 
#define UART_PARITY_ODD   6
 

TE控制信号输出

TE控制信号输出定义

#define UART_TE_DISEN   0x00
 
#define UART_TE_EN_LOW   0x80
 
#define UART_TE_EN_HIGH   0x81
 

内部上拉电阻配置

内部上拉电阻使能定义

#define UART_PPR_DISABLE   0x40
 
#define UART_PPR_ENABLE   0x42
 

详细描述

USB转UART接口函数和数据类型定义

函数说明

◆ UART_Init()

int WINAPI UART_Init ( int  DevHandle,
unsigned char  Channel,
PUART_CONFIG  pConfig 
)

初始化UART，必须调用，否则后面的函数无法正常执行

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
pConfig初始化结构体指针
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_WriteBytes()

int WINAPI UART_WriteBytes ( int  DevHandle,
unsigned char  Channel,
unsigned char *  pWriteData,
int  DataSize 
)

发送UART数据，该函数为阻塞函数，数据发送完毕后函数才会返回

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
pWriteData待发送的数据字节数组指针
DataSize待发送的数据字节数
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_WriteBytesWithBreak()

int WINAPI UART_WriteBytesWithBreak ( int  DevHandle,
unsigned char  Channel,
unsigned char  BreakLen,
unsigned char *  pWriteData,
int  DataSize 
)

发送UART数据，发送数据前会发送同步间隔信号，该函数为阻塞函数，数据发送完毕后函数才会返回

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
BreakLen同步间隔宽度，0-不发送，10~26-发送指定位宽同步间隔
pWriteData待发送的数据字节数组指针
DataSize待发送的数据字节数
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_WriteBytesAsync()

int WINAPI UART_WriteBytesAsync ( int  DevHandle,
unsigned char  Channel,
unsigned char *  pWriteData,
int  DataSize 
)

发送UART数据，该函数为非阻塞函数，调用后数据会先缓存到适配器，然后立即返回，适配器继续发送数据

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
pWriteData待发送的数据字节数组指针
DataSize待发送的数据字节数
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_WriteBytesAsyncWithBreak()

int WINAPI UART_WriteBytesAsyncWithBreak ( int  DevHandle,
unsigned char  Channel,
unsigned char  BreakLen,
unsigned char *  pWriteData,
int  DataSize 
)

发送UART数据，发送数据前会先发送同步间隔信号，该函数为非阻塞函数，调用后数据会先缓存到适配器，然后立即返回，适配器继续发送数据

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
BreakLen同步间隔宽度，0-不发送，10~26-发送指定位宽同步间隔
pWriteData待发送的数据字节数组指针
DataSize待发送的数据字节数
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_WriteReadBytesWithBreak()

int WINAPI UART_WriteReadBytesWithBreak ( int  DevHandle,
unsigned char  Channel,
unsigned char  BreakLen,
unsigned char *  pWriteData,
int  WriteSize,
unsigned char *  pReadData,
int  ReadSize,
int  TimeOutMs 
)

发送读取UART数据，发送完数据后会按照设定读取指定字节数数据，除非超时为止

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
BreakLen同步间隔宽度，0-不发送，10~26-发送指定位宽同步间隔
pWriteData待发送的数据字节数组指针
WriteSize待发送的数据字节数
pReadData存储读取数据的字节数组指针
ReadSize待读取的数据字节数
TimeOutMs等待读取数据的超时时间，单位为毫秒
返回
函数执行状态
返回值
>=0函数执行成功,大于0表示实际读到的有效数据字节数
<0函数调用失败

◆ UART_WriteBytesInterval()

int WINAPI UART_WriteBytesInterval ( int  DevHandle,
unsigned char  Channel,
unsigned char *  pWriteData,
int  DataSize,
unsigned char  IntervalTimeMs 
)

根据设定的字节间隔发送数据，该函数为阻塞函数，数据发送完毕后才会返回

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
pWriteData待发送的数据字节数组指针
DataSize待发送的数据字节数
IntervalTimeMs发送数据间隔时间，单位为毫秒
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_WriteBytesIntervalUs()

int WINAPI UART_WriteBytesIntervalUs ( int  DevHandle,
unsigned char  Channel,
unsigned char *  pWriteData,
int  DataSize,
unsigned char  IntervalTimeUs 
)

根据设定的字节间隔发送数据，该函数为阻塞函数，数据发送完毕后才会返回

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
pWriteData待发送的数据字节数组指针
DataSize待发送的数据字节数
IntervalTimeUs发送数据间隔时间，单位为微秒
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败

◆ UART_ReadBytes()

int WINAPI UART_ReadBytes ( int  DevHandle,
unsigned char  Channel,
unsigned char *  pReadData,
int  TimeOutMs 
)

获取适配器已经接收到的串口数据

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
pReadData待存储数据的数据缓冲区，注意缓冲区大小设置，太小了可能会到之后缓冲区溢出，程序崩溃
TimeOutMs等待数据超时时间，超时时间内若读取到数据则立即返回，否则等到超时时间到之后才返回
返回
函数执行状态
返回值
>=0成功读到的数据字节数
<0函数调用失败

◆ UART_ClearData()

int WINAPI UART_ClearData ( int  DevHandle,
unsigned char  Channel 
)

清空数据接收缓冲区数据

参数
DevHandle设备号，通过调用 USB_ScanDevice 获取
ChannelUART通道号，从0开始编号
返回
函数执行状态
返回值
=0函数执行成功
<0函数调用失败
制作者 doxygen 1.9.5