SerialPort.cpp
上传用户:guqin_vip
上传日期:2022-06-17
资源大小:1993k
文件大小:18k
源码类别:

串口编程

开发平台:

C/C++

  1. #include "stdafx.h"
  2. #include "SerialPort.h"
  3. #include <assert.h>
  4.  
  5. //
  6. // Constructor
  7. //
  8. CSerialPort::CSerialPort()
  9. {
  10. m_hComm = NULL;
  11. // initialize overlapped structure members to zero
  12. m_ov.Offset = 0;
  13. m_ov.OffsetHigh = 0;
  14. // create events
  15. m_ov.hEvent = NULL;
  16. m_hWriteEvent = NULL;
  17. m_hShutdownEvent = NULL;
  18. m_szWriteBuffer = NULL;
  19. m_nWriteSize=1;
  20. m_bThreadAlive = FALSE;
  21. }
  22. //
  23. // Delete dynamic memory
  24. //
  25. CSerialPort::~CSerialPort()
  26. {
  27. do
  28. {
  29. SetEvent(m_hShutdownEvent);
  30. } while (m_bThreadAlive);
  31. TRACE("Thread endedn");
  32. delete [] m_szWriteBuffer;
  33. }
  34. //
  35. // Initialize the port. This can be port 1 to 4.
  36. //
  37. BOOL CSerialPort::InitPort(CWnd* pPortOwner, // the owner (CWnd) of the port (receives message)
  38.    UINT  portnr, // portnumber (1..4)
  39.    UINT  baud, // baudrate
  40.    char  parity, // parity 
  41.    UINT  databits, // databits 
  42.    UINT  stopbits, // stopbits 
  43.    DWORD dwCommEvents, // EV_RXCHAR, EV_CTS etc
  44.    UINT  writebuffersize) // size to the writebuffer
  45. {
  46. assert(portnr > 0 && portnr < 5);
  47. assert(pPortOwner != NULL);
  48. // if the thread is alive: Kill
  49. if (m_bThreadAlive)
  50. {
  51. do
  52. {
  53. SetEvent(m_hShutdownEvent);
  54. } while (m_bThreadAlive);
  55. TRACE("Thread endedn");
  56. }
  57. // create events
  58. if (m_ov.hEvent != NULL)
  59. ResetEvent(m_ov.hEvent);
  60. m_ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
  61. if (m_hWriteEvent != NULL)
  62. ResetEvent(m_hWriteEvent);
  63. m_hWriteEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
  64. if (m_hShutdownEvent != NULL)
  65. ResetEvent(m_hShutdownEvent);
  66. m_hShutdownEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
  67. // initialize the event objects
  68. m_hEventArray[0] = m_hShutdownEvent; // highest priority
  69. m_hEventArray[1] = m_ov.hEvent;
  70. m_hEventArray[2] = m_hWriteEvent;
  71. // initialize critical section
  72. InitializeCriticalSection(&m_csCommunicationSync);
  73. // set buffersize for writing and save the owner
  74. m_pOwner = pPortOwner;
  75. if (m_szWriteBuffer != NULL)
  76. delete [] m_szWriteBuffer;
  77. m_szWriteBuffer = new char[writebuffersize];
  78. m_nPortNr = portnr;
  79. m_nWriteBufferSize = writebuffersize;
  80. m_dwCommEvents = dwCommEvents;
  81. BOOL bResult = FALSE;
  82. char *szPort = new char[50];
  83. char *szBaud = new char[50];
  84. // now it critical!
  85. EnterCriticalSection(&m_csCommunicationSync);
  86. // if the port is already opened: close it
  87. if (m_hComm != NULL)
  88. {
  89. CloseHandle(m_hComm);
  90. m_hComm = NULL;
  91. }
  92. // prepare port strings
  93. sprintf(szPort, "COM%d", portnr);
  94. sprintf(szBaud, "baud=%d parity=%c data=%d stop=%d", baud, parity, databits, stopbits);
  95. // get a handle to the port
  96. m_hComm = CreateFile(szPort, // communication port string (COMX)
  97.      GENERIC_READ | GENERIC_WRITE, // read/write types
  98.      0, // comm devices must be opened with exclusive access
  99.      NULL, // no security attributes
  100.      OPEN_EXISTING, // comm devices must use OPEN_EXISTING
  101.      FILE_FLAG_OVERLAPPED, // Async I/O
  102.      0); // template must be 0 for comm devices
  103. if (m_hComm == INVALID_HANDLE_VALUE)
  104. {
  105. // port not found
  106. delete [] szPort;
  107. delete [] szBaud;
  108. return FALSE;
  109. }
  110. // set the timeout values
  111. m_CommTimeouts.ReadIntervalTimeout = 1000;
  112. m_CommTimeouts.ReadTotalTimeoutMultiplier = 1000;
  113. m_CommTimeouts.ReadTotalTimeoutConstant = 1000;
  114. m_CommTimeouts.WriteTotalTimeoutMultiplier = 1000;
  115. m_CommTimeouts.WriteTotalTimeoutConstant = 1000;
  116. // configure
  117. if (SetCommTimeouts(m_hComm, &m_CommTimeouts))
  118. {    
  119. if (SetCommMask(m_hComm, dwCommEvents))
  120. {
  121. if (GetCommState(m_hComm, &m_dcb))
  122. {
  123. m_dcb.EvtChar = 'q';
  124. m_dcb.fRtsControl = RTS_CONTROL_ENABLE; // set RTS bit high!
  125. if (BuildCommDCB(szBaud, &m_dcb))
  126. {
  127. if (SetCommState(m_hComm, &m_dcb))
  128. ; // normal operation... continue
  129. else
  130. ProcessErrorMessage("SetCommState()");
  131. }
  132. else
  133. ProcessErrorMessage("BuildCommDCB()");
  134. }
  135. else
  136. ProcessErrorMessage("GetCommState()");
  137. }
  138. else
  139. ProcessErrorMessage("SetCommMask()");
  140. }
  141. else
  142. ProcessErrorMessage("SetCommTimeouts()");
  143. delete [] szPort;
  144. delete [] szBaud;
  145. // flush the port
  146. PurgeComm(m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);
  147. // release critical section
  148. LeaveCriticalSection(&m_csCommunicationSync);
  149. TRACE("Initialisation for communicationport %d completed.nUse Startmonitor to communicate.n", portnr);
  150. return TRUE;
  151. }
  152. //
  153. //  The CommThread Function.
  154. //
  155. UINT CSerialPort::CommThread(LPVOID pParam)
  156. {
  157. // Cast the void pointer passed to the thread back to
  158. // a pointer of CSerialPort class
  159. CSerialPort *port = (CSerialPort*)pParam;
  160. // Set the status variable in the dialog class to
  161. // TRUE to indicate the thread is running.
  162. port->m_bThreadAlive = TRUE;
  163. // Misc. variables
  164. DWORD BytesTransfered = 0; 
  165. DWORD Event = 0;
  166. DWORD CommEvent = 0;
  167. DWORD dwError = 0;
  168. COMSTAT comstat;
  169. BOOL  bResult = TRUE;
  170. // Clear comm buffers at startup
  171. if (port->m_hComm) // check if the port is opened
  172. PurgeComm(port->m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);
  173. // begin forever loop.  This loop will run as long as the thread is alive.
  174. for (;;) 
  175. // Make a call to WaitCommEvent().  This call will return immediatly
  176. // because our port was created as an async port (FILE_FLAG_OVERLAPPED
  177. // and an m_OverlappedStructerlapped structure specified).  This call will cause the 
  178. // m_OverlappedStructerlapped element m_OverlappedStruct.hEvent, which is part of the m_hEventArray to 
  179. // be placed in a non-signeled state if there are no bytes available to be read,
  180. // or to a signeled state if there are bytes available.  If this event handle 
  181. // is set to the non-signeled state, it will be set to signeled when a 
  182. // character arrives at the port.
  183. // we do this for each port!
  184. bResult = WaitCommEvent(port->m_hComm, &Event, &port->m_ov);
  185. if (!bResult)  
  186. // If WaitCommEvent() returns FALSE, process the last error to determin
  187. // the reason..
  188. switch (dwError = GetLastError()) 
  189. case ERROR_IO_PENDING: 
  190. // This is a normal return value if there are no bytes
  191. // to read at the port.
  192. // Do nothing and continue
  193. break;
  194. }
  195. case 87:
  196. {
  197. // Under Windows NT, this value is returned for some reason.
  198. // I have not investigated why, but it is also a valid reply
  199. // Also do nothing and continue.
  200. break;
  201. }
  202. default:
  203. {
  204. // All other error codes indicate a serious error has
  205. // occured.  Process this error.
  206. port->ProcessErrorMessage("WaitCommEvent()");
  207. break;
  208. }
  209. }
  210. }
  211. else
  212. {
  213. // If WaitCommEvent() returns TRUE, check to be sure there are
  214. // actually bytes in the buffer to read.  
  215. //
  216. // If you are reading more than one byte at a time from the buffer 
  217. // (which this program does not do) you will have the situation occur 
  218. // where the first byte to arrive will cause the WaitForMultipleObjects() 
  219. // function to stop waiting.  The WaitForMultipleObjects() function 
  220. // resets the event handle in m_OverlappedStruct.hEvent to the non-signelead state
  221. // as it returns.  
  222. //
  223. // If in the time between the reset of this event and the call to 
  224. // ReadFile() more bytes arrive, the m_OverlappedStruct.hEvent handle will be set again
  225. // to the signeled state. When the call to ReadFile() occurs, it will 
  226. // read all of the bytes from the buffer, and the program will
  227. // loop back around to WaitCommEvent().
  228. // 
  229. // At this point you will be in the situation where m_OverlappedStruct.hEvent is set,
  230. // but there are no bytes available to read.  If you proceed and call
  231. // ReadFile(), it will return immediatly due to the async port setup, but
  232. // GetOverlappedResults() will not return until the next character arrives.
  233. //
  234. // It is not desirable for the GetOverlappedResults() function to be in 
  235. // this state.  The thread shutdown event (event 0) and the WriteFile()
  236. // event (Event2) will not work if the thread is blocked by GetOverlappedResults().
  237. //
  238. // The solution to this is to check the buffer with a call to ClearCommError().
  239. // This call will reset the event handle, and if there are no bytes to read
  240. // we can loop back through WaitCommEvent() again, then proceed.
  241. // If there are really bytes to read, do nothing and proceed.
  242. bResult = ClearCommError(port->m_hComm, &dwError, &comstat);
  243. if (comstat.cbInQue == 0)
  244. continue;
  245. } // end if bResult
  246. // Main wait function.  This function will normally block the thread
  247. // until one of nine events occur that require action.
  248. Event = WaitForMultipleObjects(3, port->m_hEventArray, FALSE, INFINITE);
  249. switch (Event)
  250. {
  251. case 0:
  252. {
  253. // Shutdown event.  This is event zero so it will be
  254. // the higest priority and be serviced first.
  255. CloseHandle(port->m_hComm);
  256. port->m_hComm=NULL;
  257. port->m_bThreadAlive = FALSE;
  258. // Kill this thread.  break is not needed, but makes me feel better.
  259. AfxEndThread(100);
  260. break;
  261. }
  262. case 1: // read event
  263. {
  264. GetCommMask(port->m_hComm, &CommEvent);
  265. if (CommEvent & EV_RXCHAR)
  266. // Receive character event from port.
  267. ReceiveChar(port, comstat);
  268. if (CommEvent & EV_CTS)
  269. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_CTS_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
  270. if (CommEvent & EV_BREAK)
  271. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_BREAK_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
  272. if (CommEvent & EV_ERR)
  273. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_ERR_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
  274. if (CommEvent & EV_RING)
  275. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_RING_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
  276. if (CommEvent & EV_RXFLAG)
  277. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_RXFLAG_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
  278. break;
  279. }  
  280. case 2: // write event
  281. {
  282. // Write character event from port
  283. WriteChar(port);
  284. break;
  285. }
  286. } // end switch
  287. } // close forever loop
  288. return 0;
  289. }
  290. //
  291. // start comm watching
  292. //
  293. BOOL CSerialPort::StartMonitoring()
  294. {
  295. if (!(m_Thread = AfxBeginThread(CommThread, this)))
  296. return FALSE;
  297. TRACE("Thread startedn");
  298. return TRUE;
  299. }
  300. //
  301. // Restart the comm thread
  302. //
  303. BOOL CSerialPort::RestartMonitoring()
  304. {
  305. TRACE("Thread resumedn");
  306. m_Thread->ResumeThread();
  307. return TRUE;
  308. }
  309. //
  310. // Suspend the comm thread
  311. //
  312. BOOL CSerialPort::StopMonitoring()
  313. {
  314. TRACE("Thread suspendedn");
  315. m_Thread->SuspendThread(); 
  316. return TRUE;
  317. }
  318. //
  319. // If there is a error, give the right message
  320. //
  321. void CSerialPort::ProcessErrorMessage(char* ErrorText)
  322. {
  323. char *Temp = new char[200];
  324. LPVOID lpMsgBuf;
  325. FormatMessage( 
  326. FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
  327. NULL,
  328. GetLastError(),
  329. MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
  330. (LPTSTR) &lpMsgBuf,
  331. 0,
  332. NULL 
  333. );
  334. sprintf(Temp, "WARNING:  %s Failed with the following error: n%snPort: %dn", (char*)ErrorText, lpMsgBuf, m_nPortNr); 
  335. MessageBox(NULL, Temp, "Application Error", MB_ICONSTOP);
  336. LocalFree(lpMsgBuf);
  337. delete [] Temp;
  338. }
  339. //
  340. // Write a character.
  341. //
  342. void CSerialPort::WriteChar(CSerialPort* port)
  343. {
  344. BOOL bWrite = TRUE;
  345. BOOL bResult = TRUE;
  346. DWORD BytesSent = 0;
  347. ResetEvent(port->m_hWriteEvent);
  348. // Gain ownership of the critical section
  349. EnterCriticalSection(&port->m_csCommunicationSync);
  350. if (bWrite)
  351. {
  352. // Initailize variables
  353. port->m_ov.Offset = 0;
  354. port->m_ov.OffsetHigh = 0;
  355. // Clear buffer
  356. PurgeComm(port->m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);
  357. bResult = WriteFile(port->m_hComm, // Handle to COMM Port
  358. port->m_szWriteBuffer, // Pointer to message buffer in calling finction
  359. // strlen((char*)port->m_szWriteBuffer), // Length of message to send
  360. port->m_nWriteSize, // Length of message to send
  361. &BytesSent, // Where to store the number of bytes sent
  362. &port->m_ov); // Overlapped structure
  363. // deal with any error codes
  364. if (!bResult)  
  365. {
  366. DWORD dwError = GetLastError();
  367. switch (dwError)
  368. {
  369. case ERROR_IO_PENDING:
  370. {
  371. // continue to GetOverlappedResults()
  372. BytesSent = 0;
  373. bWrite = FALSE;
  374. break;
  375. }
  376. default:
  377. {
  378. // all other error codes
  379. port->ProcessErrorMessage("WriteFile()");
  380. }
  381. }
  382. else
  383. {
  384. LeaveCriticalSection(&port->m_csCommunicationSync);
  385. }
  386. } // end if(bWrite)
  387. if (!bWrite)
  388. {
  389. bWrite = TRUE;
  390. bResult = GetOverlappedResult(port->m_hComm, // Handle to COMM port 
  391.   &port->m_ov, // Overlapped structure
  392.   &BytesSent, // Stores number of bytes sent
  393.   TRUE);  // Wait flag
  394. LeaveCriticalSection(&port->m_csCommunicationSync);
  395. // deal with the error code 
  396. // if (!bResult)  
  397. {
  398. // port->ProcessErrorMessage("GetOverlappedResults() in WriteFile()");
  399. }
  400. } // end if (!bWrite)
  401. // Verify that the data size send equals what we tried to send
  402. // if (BytesSent != strlen((char*)port->m_szWriteBuffer))
  403. {
  404. // TRACE("WARNING: WriteFile() error.. Bytes Sent: %d; Message Length: %dn", BytesSent, strlen((char*)port->m_szWriteBuffer));
  405. }
  406. // ::SendMessage((port->m_pOwner)->m_hWnd, WM_COMM_TXEMPTY_DETECTED, (WPARAM) RXBuff, (LPARAM) port->m_nPortNr);
  407. ::SendMessage((port->m_pOwner)->m_hWnd, WM_COMM_TXEMPTY_DETECTED,0,(LPARAM) port->m_nPortNr);
  408. }
  409. //
  410. // Character received. Inform the owner
  411. //
  412. void CSerialPort::ReceiveChar(CSerialPort* port, COMSTAT comstat)
  413. {
  414. BOOL  bRead = TRUE; 
  415. BOOL  bResult = TRUE;
  416. DWORD dwError = 0;
  417. DWORD BytesRead = 0;
  418. unsigned char RXBuff;
  419. for (;;) 
  420. // Gain ownership of the comm port critical section.
  421. // This process guarantees no other part of this program 
  422. // is using the port object. 
  423. EnterCriticalSection(&port->m_csCommunicationSync);
  424. // ClearCommError() will update the COMSTAT structure and
  425. // clear any other errors.
  426. bResult = ClearCommError(port->m_hComm, &dwError, &comstat);
  427. LeaveCriticalSection(&port->m_csCommunicationSync);
  428. // start forever loop.  I use this type of loop because I
  429. // do not know at runtime how many loops this will have to
  430. // run. My solution is to start a forever loop and to
  431. // break out of it when I have processed all of the
  432. // data available.  Be careful with this approach and
  433. // be sure your loop will exit.
  434. // My reasons for this are not as clear in this sample 
  435. // as it is in my production code, but I have found this 
  436. // solutiion to be the most efficient way to do this.
  437. if (comstat.cbInQue == 0)
  438. {
  439. // break out when all bytes have been read
  440. break;
  441. }
  442. EnterCriticalSection(&port->m_csCommunicationSync);
  443. if (bRead)
  444. {
  445. bResult = ReadFile(port->m_hComm, // Handle to COMM port 
  446.    &RXBuff, // RX Buffer Pointer
  447.    1, // Read one byte
  448.    &BytesRead, // Stores number of bytes read
  449.    &port->m_ov); // pointer to the m_ov structure
  450. // deal with the error code 
  451. if (!bResult)  
  452. switch (dwError = GetLastError()) 
  453. case ERROR_IO_PENDING: 
  454. // asynchronous i/o is still in progress 
  455. // Proceed on to GetOverlappedResults();
  456. bRead = FALSE;
  457. break;
  458. }
  459. default:
  460. {
  461. // Another error has occured.  Process this error.
  462. port->ProcessErrorMessage("ReadFile()");
  463. break;
  464. }
  465. }
  466. else
  467. {
  468. // ReadFile() returned complete. It is not necessary to call GetOverlappedResults()
  469. bRead = TRUE;
  470. }
  471. }  // close if (bRead)
  472. if (!bRead)
  473. {
  474. bRead = TRUE;
  475. bResult = GetOverlappedResult(port->m_hComm, // Handle to COMM port 
  476.   &port->m_ov, // Overlapped structure
  477.   &BytesRead, // Stores number of bytes read
  478.   TRUE);  // Wait flag
  479. // deal with the error code 
  480. if (!bResult)  
  481. {
  482. port->ProcessErrorMessage("GetOverlappedResults() in ReadFile()");
  483. }
  484. }  // close if (!bRead)
  485. LeaveCriticalSection(&port->m_csCommunicationSync);
  486. // notify parent that a byte was received
  487. ::SendMessage((port->m_pOwner)->m_hWnd, WM_COMM_RXCHAR, (WPARAM) RXBuff, (LPARAM) port->m_nPortNr);
  488. } // end forever loop
  489. }
  490. //
  491. // Write a string to the port
  492. //
  493. void CSerialPort::WriteToPort(char* string)
  494. {
  495. assert(m_hComm != 0);
  496. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
  497. strcpy(m_szWriteBuffer, string);
  498. m_nWriteSize=strlen(string);
  499. // set event for write
  500. SetEvent(m_hWriteEvent);
  501. }
  502. void CSerialPort::WriteToPort(char* string,int n)
  503. {
  504. assert(m_hComm != 0);
  505. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
  506. // memset(m_szWriteBuffer, 0, n);
  507. // strncpy(m_szWriteBuffer, string, n);
  508. memcpy(m_szWriteBuffer, string, n);
  509. m_nWriteSize=n;
  510. // set event for write
  511. SetEvent(m_hWriteEvent);
  512. }
  513. void CSerialPort::WriteToPort(unsigned char* string,int n)
  514. {
  515. assert(m_hComm != 0);
  516. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
  517. memcpy(m_szWriteBuffer, string, n);
  518. m_nWriteSize=n;
  519. // set event for write
  520. SetEvent(m_hWriteEvent);
  521. }
  522. void CSerialPort::WriteToPort(LPCTSTR string)
  523. {
  524. assert(m_hComm != 0);
  525. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
  526. strcpy(m_szWriteBuffer, string);
  527. m_nWriteSize=strlen(string);
  528. // set event for write
  529. SetEvent(m_hWriteEvent);
  530. }
  531. void CSerialPort::WriteToPort(LPCTSTR string,int n)
  532. {
  533. assert(m_hComm != 0);
  534. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
  535. // strncpy(m_szWriteBuffer, string, n);
  536. memcpy(m_szWriteBuffer, string, n);
  537. m_nWriteSize=n;
  538. // set event for write
  539. SetEvent(m_hWriteEvent);
  540. }
  541. //
  542. // Return the device control block
  543. //
  544. DCB CSerialPort::GetDCB()
  545. {
  546. return m_dcb;
  547. }
  548. //
  549. // Return the communication event masks
  550. //
  551. DWORD CSerialPort::GetCommEvents()
  552. {
  553. return m_dwCommEvents;
  554. }
  555. //
  556. // Return the output buffer size
  557. //
  558. DWORD CSerialPort::GetWriteBufferSize()
  559. {
  560. return m_nWriteBufferSize;
  561. }
  562. void CSerialPort::ClosePort()
  563. {
  564. SetEvent(m_hShutdownEvent);
  565. }