1、API描述
在WIN32 API中,串口使用文件方式進行訪問,其操作的API基本上與文件操作的API一致。
打開串口
Win32 中用於打開串口的API 函數爲CreateFile,其原型爲:
HANDLE CreateFile (
LPCTSTR lpFileName, //將要打開的串口邏輯名,如COM1 或COM2
DWORD dwAccess, //指定串口訪問的類型,可以是讀取、寫入或兩者並列
DWORD dwShareMode, //指定共享屬性,由於串口不能共享,該參數必須置爲0
LPSECURITY_ATTRIBUTES lpsa, //引用安全性屬性結構,缺省值爲NULL
DWORD dwCreate, //創建標誌,對串口操作該參數必須置爲OPEN EXISTING
DWORD dwAttrsAndFlags, //屬性描述,用於指定該串口是否可進行異步操作,
//FILE_FLAG_OVERLAPPED:可使用異步的I/O
HANDLE hTemplateFile //指向模板文件的句柄,對串口而言該參數必須置爲NULL
);
例如,以下程序用於以同步讀寫方式打開串口COM1:
HANDLE hCom;
DWORD dwError;
hCon = CreateFile("COM1", GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
if (hCom == (HANDLE)0xFFFFFFFF)
{
dwError = GetLastError();
MessageBox(dwError);
}
對於dwAttrsAndFlags參數及FILE_FLAG_OVERLAPPED標誌的由來,可解釋如下:Windows文件操作分爲同步I/O和重疊I/O(Overlapped I/ O)兩種方式,在同步I/O方式中,API會阻塞直到操作完成以後才能返回(在多線程方式中,雖然不會阻塞主線程,但是仍然會阻塞監聽線程);而在重疊I/O方式中,API會立即返回,操作在後臺進行,避免線程的阻塞。重疊I/O非常靈活,它也可以實現阻塞(例如我們可以設置一定要讀取到一個數據才能進行到下一步操作)。如果進行I/O操作的API 在沒有完成操作的情況下返回,我們可以通過調用GetOverLappedResult()函數阻塞到I/O操作完成後返回。
配置串口
配置串口是通過改變設備控制塊DCB(Device Control Block) 的成員變量值來實現的,接收緩衝區和發送緩衝區的大小可通過SetupComm函數來設置。
DCB結構體定義爲:
typedef struct _DCB { // dcb
DWORD DCBlength; // sizeof(DCB)
DWORD BaudRate; // current baud rate
DWORD fBinary: 1; // binary mode, no EOF check
DWORD fParity: 1; // enable parity checking
DWORD fOutxCtsFlow:1; // CTS output flow control
DWORD fOutxDsrFlow:1; // DSR output flow control
DWORD fDtrControl:2; // DTR flow control type
DWORD fDsrSensitivity:1; // DSR sensitivity
DWORD fTXContinueOnXoff:1; // XOFF continues Tx
DWORD fOutX: 1; // XON/XOFF out flow control
DWORD fInX: 1; // XON/XOFF in flow control
DWORD fErrorChar: 1; // enable error replacement
DWORD fNull: 1; // enable null stripping
DWORD fRtsControl:2; // RTS flow control
DWORD fAbortOnError:1; // abort reads/writes on error
DWORD fDummy2:17; // reserved
WORD wReserved; // not currently used
WORD XonLim; // transmit XON threshold
WORD XoffLim; // transmit XOFF threshold
BYTE ByteSize; // number of bits/byte, 4-8
BYTE Parity; // 0-4=no,odd,even,mark,space
BYTE StopBits; // 0,1,2 = 1, 1.5, 2
char XonChar; // Tx and Rx XON character
char XoffChar; // Tx and Rx XOFF character
char ErrorChar; // error replacement character
char EofChar; // end of input character
char EvtChar; // received event character
WORD wReserved1; // reserved; do not use
} DCB;
而SetupComm函數的原型則爲:
BOOL SetupComm(
HANDLE hFile, // handle to communications device
DWORD dwInQueue, // size of input buffer
DWORD dwOutQueue // size of output buffer
);
以下程序將串口設置爲:波特率爲9600,數據位數爲7位,停止位爲2 位,偶校驗,接收緩衝區和發送緩衝區大小均爲1024個字節,最後用PurgeComm函數終止所有的後臺讀寫操作並清空接收緩衝區和發送緩衝區:
DCB dcb;
dcb.BaudRate = 9600; //波特率爲9600
dcb.ByteSize = 7; //數據位數爲7位
dcb.Parity = EVENPARITY; //偶校驗
dcb.StopBits = 2; //兩個停止位
dcb.fBinary = TRUE;
dcb.fParity = TRUE;
if (!SetCommState(hCom, &dcb))
{
MessageBox("串口設置出錯!");
}
SetupComm(hCom, 1024, 1024);
PurgeComm(hCom, PURCE_TXABORT | PURGE_RXABORT | PURGE_TXCLEAR | PURGE_RXCLEAR);
超時設置
超時設置是通過改變COMMTIMEOUTS結構體的成員變量值來實現的,COMMTIMEOUTS的原型爲:
typedef struct _COMMTIMEOUTS
{
DWORD ReadIntervalTimeout; //定義兩個字符到達的最大時間間隔,單位:毫秒
//當讀取完一個字符後,超過了ReadIntervalTimeout,仍未讀取到下一個字符,就會
//發生超時
DWORD ReadTotalTimeoutMultiplier;
DWORD ReadTotalTimeoutConstant;
//其中各時間所滿足的關係如下:
//ReadTotalTimeout = ReadTotalTimeOutMultiplier* BytesToRead + ReadTotalTimeoutConstant
DWORD WriteTotalTimeoutMultiplier;
DWORD WriteTotalTimeoutConstant;
} COMMTIMEOUTS, *LPCOMMTIMEOUTS;
設置超時的函數爲SetCommTimeouts,其原型中接收COMMTIMEOUTS的指針爲參數:
BOOL SetCommTimeouts(
HANDLE hFile, // handle to communications device
LPCOMMTIMEOUTS lpCommTimeouts // pointer to comm time-out structure
);
以下程序將串口讀操作的超時設定爲10 毫秒:
COMMTIMEOUTS to;
memset(&to, 0, sizeof(to));
to.ReadIntervalTimeout = 10;
SetCommTimeouts(hCom, &to);
與SetCommTimeouts對應的GetCommTimeouts()函數的原型爲:
BOOL GetCommTimeouts(
HANDLE hFile, // handle of communications device
LPCOMMTIMEOUTS lpCommTimeouts // pointer to comm time-out structure
);
事件設置
在讀寫串口之前,需要用SetCommMask ()函數設置事件掩模來監視指定通信端口上的事件,其原型爲:
BOOL SetCommMask(
HANDLE hFile, //標識通信端口的句柄
DWORD dwEvtMask //能夠使能的通信事件
);
有了Set當然還會有Get,與SetCommMask對應的GetCommMask()函數的原型爲:
BOOL GetCommMask(
HANDLE hFile, //標識通信端口的句柄
LPDWORD lpEvtMask // address of variable to get event mask
);
串口上可以發生的事件可以是如下事件列表中的一個或任意組合:EV_BREAK、EV_CTS、EV_DSR、EV_ERR、EV_RING、EV_RLSD、EV_RXCHAR、EV_RXFLAG、EV_TXEMPTY。
我們可以用WaitCommEvent()函數來等待串口上我們利用SetCommMask ()函數設置的事件:
BOOL WaitCommEvent(
HANDLE hFile, //標識通信端口的句柄
LPDWORD lpEvtMask, // address of variable for event that occurred
LPOVERLAPPED lpOverlapped, // address of overlapped structure
);
WaitCommEvent()函數一直阻塞,直到串口上發生我們用所SetCommMask ()函數設置的通信事件爲止。一般而言,當WaitCommEvent()返回時,程序員可以由分析*lpEvtMask而獲得發生事件的類別,再進行相應的處理。
讀串口
對串口進行讀取所用的函數和對文件進行讀取所用的函數相同,讀函數原型如下:
BOOL ReadFile(
HANDLE hFile, // handle of file to read
LPVOID lpBuffer, // pointer to buffer that receives data
DWORD nNumberOfBytesToRead, // number of bytes to read
LPDWORD lpNumberOfBytesRead, // pointer to number of bytes read
LPOVERLAPPED lpOverlapped // pointer to structure for overlapped I/O
);
寫串口
對串口進行寫入所用的函數和對文件進行寫入所用的函數相同,寫函數原型如下:
BOOL WriteFile(
HANDLE hFile, // handle to file to write to
LPCVOID lpBuffer, // pointer to data to write to file
DWORD nNumberOfBytesToWrite, // number of bytes to write
LPDWORD lpNumberOfBytesWritten, // pointer to number of bytes written
LPOVERLAPPED lpOverlapped // pointer to structure for overlapped I/O
);
關閉串口
利用API 函數實現串口通信時關閉串口非常簡單,只需使用CreateFile 函數返回的句柄作爲參數調用CloseHandle 即可:
BOOL CloseHandle(
HANDLE hObject // handle to object to close
);