Window API串口编程

时间：2016-07-25 10:35:24 阅读：416 评论：0 收藏：0 [点我收藏+]

标签：

虽然使用诸如 CSerialPort VC串口类，MSComm VC 串口控件等非常方便，但有时这些控件并不适合自己的特殊需求，所以有必要了解一下基于Windows API的串口编程方法，下面介绍一下API串口编程的一般步骤及相关串口API函数。
串口操作一般有四步，分别是：
1) 打开串口
2) 配置串口
3) 读写串口
4) 关闭串口
１、打开串口
　　在《VC 打开串口》一文中我们已经单独介绍过如果利用API打开串口的方法，打开串口是用API函数CreateFile来打开或创建的。该函数的原型为：
1. HANDLE CreateFile( LPCTSTR lpFileName,
2. DWORD dwDesiredAccess,
3. DWORD dwShareMode,
4. LPSECURITY_ATTRIBUTES lpSecurityAttributes,
5. DWORD dwCreationDistribution,
6. DWORD dwFlagsAndAttributes,
7. HANDLE hTemplateFile);

参数详解：
? lpFileName：将要打开的串口逻辑名，如“COM1”；
? dwDesiredAccess：指定串口访问的类型，可以是读取、写入或二者并列；
? dwShareMode：指定共享属性，由于串口不能共享，该参数必须置为0；
? lpSecurityAttributes：引用安全性属性结构，缺省值为NULL；
? dwCreationDistribution：创建标志，对串口操作该参数必须置为OPEN_EXISTING；
? dwFlagsAndAttributes：属性描述，用于指定该串口是否进行异步操作，该值为FILE_FLAG_OVERLAPPED，表示使用异步的I/O；该值为0，表示同步I/O操作；
? hTemplateFile：对串口而言该参数必须置为NULL；
　　串口的操作可以有两种操作方式：同步操作方式和重叠操作方式（也称为异步操作方式）。同步操作时，API函数会阻塞直到操作完成以后才能返回（在多线程方式中，虽然不会阻塞主线程，但是仍然会阻塞监听线程）；而重叠操作方式，API函数会立即返回，操作在后台进行，避免线程的阻塞。
同步I/O方式打开串口的示例：
1. HANDLE hCom; //全局变量，串口句柄
2. hCom=CreateFile("COM1",//COM1口
3. GENERIC_READ|GENERIC_WRITE, //允许读和写
4. 0, //独占方式
5. NULL,
6. OPEN_EXISTING, //打开而不是创建
7. 0, //同步方式
8. NULL);
9. if(hCom==(HANDLE)-1)
10. {
11. AfxMessageBox("打开COM失败!");
12. return FALSE;
13. }
14. return TRUE;
重叠I/O打开串口的示例：
1. HANDLE hCom; //全局变量，串口句柄
2. hCom =CreateFile("COM1", //COM1口
3. GENERIC_READ|GENERIC_WRITE, //允许读和写
4. 0, //独占方式
5. NULL,
6. OPEN_EXISTING, //打开而不是创建
7. FILE_ATTRIBUTE_NORMAL|FILE_FLAG_OVERLAPPED, //重叠方式
8. NULL);
9. if(hCom ==INVALID_HANDLE_VALUE)
10. {
11. AfxMessageBox("打开COM失败!");
12. return FALSE;
13. }
14. return TRUE;
2、配置串口
　　在打开通讯设备句柄后，常常需要对串口进行一些初始化配置工作。这需要通过一个DCB结构来进行。DCB结构包含了诸如波特率、数据位数、奇偶校验和停止位数等信息。在查询或配置串口的属性时，都要用DCB结构来作为缓冲区。
　　一般用CreateFile打开串口后，可以调用GetCommState函数来获取串口的初始配置。要修改串口的配置，应该先修改DCB结构，然后再调用SetCommState函数设置串口。
　　DCB结构包含了串口的各项参数设置，下面仅介绍几个该结构常用的变量：

1. typedef struct _DCB{
2. ………
3. //波特率，指定通信设备的传输速率。这个成员可以是实际波特率值或者下面的常量值之一：
4. DWORD BaudRate;
5. CBR_110，CBR_300，CBR_600，CBR_1200，CBR_2400，CBR_4800，CBR_9600，CBR_19200， CBR_38400，
6. CBR_56000， CBR_57600， CBR_115200， CBR_128000， CBR_256000， CBR_14400
7.
8. DWORD fParity; // 指定奇偶校验使能。若此成员为1，允许奇偶校验检查
9. …
10. BYTE ByteSize; // 通信字节位数，4—8
11. BYTE Parity; //指定奇偶校验方法。此成员可以有下列值：
12. EVENPARITY 偶校验 NOPARITY 无校验
13. MARKPARITY 标记校验 ODDPARITY 奇校验
14. BYTE StopBits; //指定停止位的位数。此成员可以有下列值：
15. ONESTOPBIT 1位停止位 TWOSTOPBITS 2位停止位
16. ONE5STOPBITS 1.5位停止位
17. ………
18. } DCB;
19. winbase.h文件中定义了以上用到的常量。如下：
20. #define NOPARITY 0
21. #define ODDPARITY 1
22. #define EVENPARITY 2
23. #define ONESTOPBIT 0
24. #define ONE5STOPBITS 1
25. #define TWOSTOPBITS 2
26. #define CBR_110 110
27. #define CBR_300 300
28. #define CBR_600 600
29. #define CBR_1200 1200
30. #define CBR_2400 2400
31. #define CBR_4800 4800
32. #define CBR_9600 9600
33. #define CBR_14400 14400
34. #define CBR_19200 19200
35. #define CBR_38400 38400
36. #define CBR_56000 56000
37. #define CBR_57600 57600
38. #define CBR_115200 115200
39. #define CBR_128000 128000
40. #define CBR_256000 256000
GetCommState函数可以获得COM口的设备控制块，从而获得相关参数：
1. BOOL GetCommState(
2. HANDLE hFile, //标识通讯端口的句柄
3. LPDCB lpDCB //指向一个设备控制块（DCB结构）的指针
4. );
5. SetCommState函数设置COM口的设备控制块：
6. BOOL SetCommState(
7. HANDLE hFile,
8. LPDCB lpDCB
9. );
　　除了在BCD中的设置外，程序一般还需要设置I/O缓冲区的大小和超时。Windows用I/O缓冲区来暂存串口输入和输出的数据。如果通信的速率较高，则应该设置较大的缓冲区。调用SetupComm函数可以设置串行口的输入和输出缓冲区的大小。
1. BOOL SetupComm(
2.
3. HANDLE hFile, // 通信设备的句柄
4. DWORD dwInQueue, // 输入缓冲区的大小（字节数）
5. DWORD dwOutQueue // 输出缓冲区的大小（字节数）
6. );
　　在用ReadFile和WriteFile读写串行口时，需要考虑超时问题。超时的作用是在指定的时间内没有读入或发送指定数量的字符，ReadFile或WriteFile的操作仍然会结束。
　　要查询当前的超时设置应调用GetCommTimeouts函数，该函数会填充一个COMMTIMEOUTS结构。调用SetCommTimeouts可以用某一个COMMTIMEOUTS结构的内容来设置超时。
　　读写串口的超时有两种：间隔超时和总超时。间隔超时是指在接收时两个字符之间的最大时延。总超时是指读写操作总共花费的最大时间。写操作只支持总超时，而读操作两种超时均支持。用COMMTIMEOUTS结构可以规定读写操作的超时。
COMMTIMEOUTS结构的定义为：
1. typedef struct _COMMTIMEOUTS {
2. DWORD ReadIntervalTimeout; //读间隔超时
3. DWORD ReadTotalTimeoutMultiplier; //读时间系数
4. DWORD ReadTotalTimeoutConstant; //读时间常量
5. DWORD WriteTotalTimeoutMultiplier; // 写时间系数
6. DWORD WriteTotalTimeoutConstant; //写时间常量
7. } COMMTIMEOUTS,*LPCOMMTIMEOUTS;
COMMTIMEOUTS结构的成员都以毫秒为单位。总超时的计算公式是：
总超时＝时间系数×要求读/写的字符数＋时间常量
例如，要读入10个字符，那么读操作的总超时的计算公式为：
读总超时＝ReadTotalTimeoutMultiplier×10＋ReadTotalTimeoutConstant
可以看出：间隔超时和总超时的设置是不相关的，这可以方便通信程序灵活地设置各种超时。

如果所有写超时参数均为0，那么就不使用写超时。如果ReadIntervalTimeout为0，那么就不使用读间隔超时。如果ReadTotalTimeoutMultiplier 和 ReadTotalTimeoutConstant 都为0，则不使用读总超时。如果读间隔超时被设置成MAXDWORD并且读时间系数和读时间常量都为0，那么在读一次输入缓冲区的内容后读操作就立即返回，而不管是否读入了要求的字符。
　　在用重叠方式读写串口时，虽然ReadFile和WriteFile在完成操作以前就可能返回，但超时仍然是起作用的。在这种情况下，超时规定的是操作的完成时间，而不是ReadFile和WriteFile的返回时间。
配置串口的示例代码：

1. SetupComm(hCom,1024,1024); //输入缓冲区和输出缓冲区的大小都是1024
2.
3. COMMTIMEOUTS TimeOuts;
4. //设定读超时
5. TimeOuts.ReadIntervalTimeout=1000;
6. TimeOuts.ReadTotalTimeoutMultiplier=500;
7. TimeOuts.ReadTotalTimeoutConstant=5000;
8. //设定写超时
9. TimeOuts.WriteTotalTimeoutMultiplier=500;
10. TimeOuts.WriteTotalTimeoutConstant=2000;
11. SetCommTimeouts(hCom,&TimeOuts); //设置超时
12.
13. DCB dcb;
14. GetCommState(hCom,&dcb);
15. dcb.BaudRate=9600; //波特率为9600
16. dcb.ByteSize=8; //每个字节有8位
17. dcb.Parity=NOPARITY; //无奇偶校验位
18. dcb.StopBits=TWOSTOPBITS; //两个停止位
19. SetCommState(hCom,&dcb);
20.
21. PurgeComm(hCom,PURGE_TXCLEAR|PURGE_RXCLEAR);
在读写串口之前，还要用PurgeComm()函数清空缓冲区，该函数原型：

1. BOOL PurgeComm(
2.
3. HANDLE hFile, //串口句柄
4. DWORD dwFlags // 需要完成的操作
5. );
参数dwFlags指定要完成的操作，可以是下列值的组合：
1. PURGE_TXABORT 中断所有写操作并立即返回，即使写操作还没有完成。
2. PURGE_RXABORT 中断所有读操作并立即返回，即使读操作还没有完成。
3. PURGE_TXCLEAR 清除输出缓冲区
4. PURGE_RXCLEAR 清除输入缓冲区
3、读写串口
我们使用ReadFile和WriteFile读写串口，下面是两个函数的声明：

1. BOOL ReadFile(
2.
3. HANDLE hFile, //串口的句柄
4.
5. // 读入的数据存储的地址，
6. // 即读入的数据将存储在以该指针的值为首地址的一片内存区
7. LPVOID lpBuffer,
8. DWORD nNumberOfBytesToRead, // 要读入的数据的字节数
9.
10. // 指向一个DWORD数值，该数值返回读操作实际读入的字节数
11. LPDWORD lpNumberOfBytesRead,
12.
13. // 重叠操作时，该参数指向一个OVERLAPPED结构，同步操作时，该参数为NULL。
14. LPOVERLAPPED lpOverlapped
15. );
16. BOOL WriteFile(
17.
18. HANDLE hFile, //串口的句柄
19.
20. // 写入的数据存储的地址，
21. // 即以该指针的值为首地址的nNumberOfBytesToWrite
22. // 个字节的数据将要写入串口的发送数据缓冲区。
23. LPCVOID lpBuffer,
24.
25. DWORD nNumberOfBytesToWrite, //要写入的数据的字节数
26.
27. // 指向指向一个DWORD数值，该数值返回实际写入的字节数
28. LPDWORD lpNumberOfBytesWritten,
29.
30. // 重叠操作时，该参数指向一个OVERLAPPED结构，
31. // 同步操作时，该参数为NULL。
32. LPOVERLAPPED lpOverlapped
33. );
　　在用ReadFile和WriteFile读写串口时，既可以同步执行，也可以重叠执行。在同步执行时，函数直到操作完成后才返回。这意味着同步执行时线程会被阻塞，从而导致效率下降。在重叠执行时，即使操作还未完成，这两个函数也会立即返回，费时的I/O操作在后台进行。
　　ReadFile和WriteFile函数是同步还是异步由CreateFile函数决定，如果在调用CreateFile创建句柄时指定了FILE_FLAG_OVERLAPPED标志，那么调用ReadFile和WriteFile对该句柄进行的操作就应该是重叠的；如果未指定重叠标志，则读写操作应该是同步的。ReadFile和WriteFile函数的同步或者异步应该和CreateFile函数相一致。
　　ReadFile函数只要在串口输入缓冲区中读入指定数量的字符，就算完成操作。而WriteFile函数不但要把指定数量的字符拷入到输出缓冲区，而且要等这些字符从串行口送出去后才算完成操作。
　　如果操作成功，这两个函数都返回TRUE。需要注意的是，当ReadFile和WriteFile返回FALSE时，不一定就是操作失败，线程应该调用GetLastError函数分析返回的结果。例如，在重叠操作时如果操作还未完成函数就返回，那么函数就返回FALSE，而且GetLastError函数返回ERROR_IO_PENDING。这说明重叠操作还未完成。

同步方式读写串口比较简单，下面先例举同步方式读写串口的代码：

1. //同步读串口
2. char str[100];
3. DWORD wCount;//读取的字节数
4. BOOL bReadStat;
5. bReadStat=ReadFile(hCom,str,100,&wCount,NULL);
6. if(!bReadStat)
7. {
8. AfxMessageBox("读串口失败!");
9. return FALSE;
10. }
11. return TRUE;
12.
13. //同步写串口
14.
15. char lpOutBuffer[100];
16. DWORD dwBytesWrite=100;
17. COMSTAT ComStat;
18. DWORD dwErrorFlags;
19. BOOL bWriteStat;
20. ClearCommError(hCom,&dwErrorFlags,&ComStat);
21. bWriteStat=WriteFile(hCom,lpOutBuffer,dwBytesWrite,& dwBytesWrite,NULL);
22. if(!bWriteStat)
23. {
24. AfxMessageBox("写串口失败!");
25. }
26. PurgeComm(hCom, PURGE_TXABORT|
27. PURGE_RXABORT|PURGE_TXCLEAR|PURGE_RXCLEAR);
在重叠操作时,操作还未完成函数就返回。

　　重叠I/O非常灵活，它也可以实现阻塞（例如我们可以设置一定要读取到一个数据才能进行到下一步操作）。有两种方法可以等待操作完成：一种方法是用象WaitForSingleObject这样的等待函数来等待OVERLAPPED结构的hEvent成员；另一种方法是调用GetOverlappedResult函数等待，后面将演示说明。
下面我们先简单说一下OVERLAPPED结构和GetOverlappedResult函数：
OVERLAPPED结构
OVERLAPPED结构包含了重叠I/O的一些信息，定义如下：
1. typedef struct _OVERLAPPED { // o
2. DWORD Internal;
3. DWORD InternalHigh;
4. DWORD Offset;
5. DWORD OffsetHigh;
6. HANDLE hEvent;
7. } OVERLAPPED;
　　在使用ReadFile和WriteFile重叠操作时，线程需要创建OVERLAPPED结构以供这两个函数使用。线程通过OVERLAPPED结构获得当前的操作状态，该结构最重要的成员是hEvent。hEvent是读写事件。当串口使用异步通讯时，函数返回时操作可能还没有完成，程序可以通过检查该事件得知是否读写完毕。
　　当调用ReadFile, WriteFile 函数的时候，该成员会自动被置为无信号状态；当重叠操作完成后，该成员变量会自动被置为有信号状态。

1. GetOverlappedResult函数
2. BOOL GetOverlappedResult(
3. HANDLE hFile, // 串口的句柄
4.
5. // 指向重叠操作开始时指定的OVERLAPPED结构
6. LPOVERLAPPED lpOverlapped,
7.
8. // 指向一个32位变量，该变量的值返回实际读写操作传输的字节数。
9. LPDWORD lpNumberOfBytesTransferred,
10.
11. // 该参数用于指定函数是否一直等到重叠操作结束。
12. // 如果该参数为TRUE，函数直到操作结束才返回。
13. // 如果该参数为FALSE，函数直接返回，这时如果操作没有完成，
14. // 通过调用GetLastError()函数会返回ERROR_IO_INCOMPLETE。
15. BOOL bWait
16. );
该函数返回重叠操作的结果，用来判断异步操作是否完成，它是通过判断OVERLAPPED结构中的hEvent是否被置位来实现的。

异步读串口的示例代码：

1. char lpInBuffer[1024];
2. DWORD dwBytesRead=1024;
3. COMSTAT ComStat;
4. DWORD dwErrorFlags;
5. OVERLAPPED m_osRead;
6. memset(&m_osRead,0,sizeof(OVERLAPPED));
7. m_osRead.hEvent=CreateEvent(NULL,TRUE,FALSE,NULL);
8.
9. ClearCommError(hCom,&dwErrorFlags,&ComStat);
10. dwBytesRead=min(dwBytesRead,(DWORD)ComStat.cbInQue);
11. if(!dwBytesRead)
12. return FALSE;
13. BOOL bReadStatus;
14. bReadStatus=ReadFile(hCom,lpInBuffer,
15. dwBytesRead,&dwBytesRead,&m_osRead);
16.
17. if(!bReadStatus) //如果ReadFile函数返回FALSE
18. {
19. if(GetLastError()==ERROR_IO_PENDING)
20. //GetLastError()函数返回ERROR_IO_PENDING,表明串口正在进行读操作
21. {
22. WaitForSingleObject(m_osRead.hEvent,2000);
23. //使用WaitForSingleObject函数等待，直到读操作完成或延时已达到2秒钟
24. //当串口读操作进行完毕后，m_osRead的hEvent事件会变为有信号
25. PurgeComm(hCom, PURGE_TXABORT|
26. PURGE_RXABORT|PURGE_TXCLEAR|PURGE_RXCLEAR);
27. return dwBytesRead;
28. }
29. return 0;
30. }
31. PurgeComm(hCom, PURGE_TXABORT|
32. PURGE_RXABORT|PURGE_TXCLEAR|PURGE_RXCLEAR);
33. return dwBytesRead;
　　对以上代码再作简要说明：在使用ReadFile 函数进行读操作前，应先使用ClearCommError函数清除错误。ClearCommError函数的原型如下：
1. BOOL ClearCommError(
2.
3. HANDLE hFile, // 串口句柄
4. LPDWORD lpErrors, // 指向接收错误码的变量
5. LPCOMSTAT lpStat // 指向通讯状态缓冲区
6. );
该函数获得通信错误并报告串口的当前状态，同时，该函数清除串口的错误标志以便继续输入、输出操作。
参数lpStat指向一个COMSTAT结构，该结构返回串口状态信息。 COMSTAT结构 COMSTAT结构包含串口的信息，结构定义如下：
1. typedef struct _COMSTAT { // cst
2. DWORD fCtsHold : 1; // Tx waiting for CTS signal
3. DWORD fDsrHold : 1; // Tx waiting for DSR signal
4. DWORD fRlsdHold : 1; // Tx waiting for RLSD signal
5. DWORD fXoffHold : 1; // Tx waiting, XOFF char rec‘‘d
6. DWORD fXoffSent : 1; // Tx waiting, XOFF char sent
7. DWORD fEof : 1; // EOF character sent
8. DWORD fTxim : 1; // character waiting for Tx
9. DWORD fReserved : 25; // reserved
10. DWORD cbInQue; // bytes in input buffer
11. DWORD cbOutQue; // bytes in output buffer
12. } COMSTAT, *LPCOMSTAT;
这里只用到了cbInQue成员变量，该成员变量的值代表输入缓冲区的字节数。

　　最后用PurgeComm函数清空串口的输入输出缓冲区。
　　这段代码用WaitForSingleObject函数来等待OVERLAPPED结构的hEvent成员，下面我们再演示一段调用GetOverlappedResult函数等待的异步读串口示例代码：

1. char lpInBuffer[1024];
2. DWORD dwBytesRead=1024;
3. BOOL bReadStatus;
4. DWORD dwErrorFlags;
5. COMSTAT ComStat;
6. OVERLAPPED m_osRead;
7.
8. ClearCommError(hCom,&dwErrorFlags,&ComStat);
9. if(!ComStat.cbInQue)
10. return 0;
11. dwBytesRead=min(dwBytesRead,(DWORD)ComStat.cbInQue);
12. bReadStatus=ReadFile(hCom, lpInBuffer,dwBytesRead,
13. &dwBytesRead,&m_osRead);
14. if(!bReadStatus) //如果ReadFile函数返回FALSE
15. {
16. if(GetLastError()==ERROR_IO_PENDING)
17. {
18. GetOverlappedResult(hCom,
19. &m_osRead,&dwBytesRead,TRUE);
20. // GetOverlappedResult函数的最后一个参数设为TRUE，
21. //函数会一直等待，直到读操作完成或由于错误而返回。
22.
23. return dwBytesRead;
24. }
25. return 0;
26. }
27. return dwBytesRead;
异步写串口的示例代码：

1. char buffer[1024];
2. DWORD dwBytesWritten=1024;
3. DWORD dwErrorFlags;
4. COMSTAT ComStat;
5. OVERLAPPED m_osWrite;
6. BOOL bWriteStat;
7.
8. bWriteStat=WriteFile(hCom,buffer,dwBytesWritten,
9. &dwBytesWritten,&m_OsWrite);
10. if(!bWriteStat)
11. {
12. if(GetLastError()==ERROR_IO_PENDING)
13. {
14. WaitForSingleObject(m_osWrite.hEvent,1000);
15. return dwBytesWritten;
16. }
17. return 0;
18. }
19. return dwBytesWritten;
4、关闭串口
　　利用API函数关闭串口非常简单，只需使用CreateFile函数返回的句柄作为参数调用CloseHandle即可：
1. BOOL CloseHandle(
2. HANDLE hObject; //handle to object to close
3. );

Window API串口编程

标签：

原文地址：http://blog.csdn.net/qq_16149777/article/details/52020521

踩

(0)

评论一句话评论（0）

分享档案

更多>

2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)

周排行