From 3d4691e9bdc5a55acf1fe7435ccd6405de1eb4f2 Mon Sep 17 00:00:00 2001
From: TomCh <tomcw@users.noreply.github.com>
Date: Sat, 2 Nov 2019 19:53:00 +0000
Subject: [PATCH] ADTPro not working (#707) (PR #714)

. Wrap m_vbTxEmpty in a mutex
. Check WriteFile() result & log error
---
 source/SerialComms.cpp | 51 +++++++++++++++++++++++++++++++++++-------
 source/SerialComms.h   |  2 +-
 2 files changed, 44 insertions(+), 9 deletions(-)

diff --git a/source/SerialComms.cpp b/source/SerialComms.cpp
index 20958242..21d7a05c 100644
--- a/source/SerialComms.cpp
+++ b/source/SerialComms.cpp
@@ -181,7 +181,11 @@ void CSuperSerialCard::UpdateCommState()
 	dcb.ByteSize = m_uByteSize;
 	dcb.Parity   = m_uParity;
 	dcb.StopBits = m_uStopBits;
+
+	// Specifies the DTR (data-terminal-ready) input flow control (use dcb.fOutxCtsFlow for output)
 	dcb.fDtrControl = m_uDTR;	// GH#386
+
+	// Specifies the RTS (request-to-send) input flow control (use dcb.fOutxDsrFlow for output)
 	dcb.fRtsControl = m_uRTS;	// GH#311
 
 	SetCommState(m_hCommHandle,&dcb);
@@ -687,7 +691,21 @@ BYTE __stdcall CSuperSerialCard::CommReceive(WORD, WORD, BYTE, BYTE, ULONG)
 
 void CSuperSerialCard::TransmitDone(void)
 {
-	m_vbTxEmpty = true;	// Transmit done
+	if (m_hCommHandle != INVALID_HANDLE_VALUE)
+	{
+		// Use CriticalSection to ensure that write to m_vbTxEmpty is atomic w.r.t CommTransmit() (GH#707)
+		EnterCriticalSection(&m_CriticalSection);
+
+		_ASSERT(m_vbTxEmpty == false);
+		m_vbTxEmpty = true;	// Transmit done (COM)
+
+		LeaveCriticalSection(&m_CriticalSection);
+	}
+	else
+	{
+		_ASSERT(m_vbTxEmpty == false);
+		m_vbTxEmpty = true;	// Transmit done (TCP)
+	}
 
 	if (m_bTxIrqEnabled)	// GH#522
 	{
@@ -713,6 +731,7 @@ BYTE __stdcall CSuperSerialCard::CommTransmit(WORD, WORD, BYTE, BYTE value, ULON
 			data &= ~(1 << m_uByteSize);
 		}
 		int sent = send(m_hCommAcceptSocket, (const char*)&data, 1, 0);
+		_ASSERT(sent == 1);
 		if (sent == 1)
 		{
 			m_vbTxEmpty = false;
@@ -722,10 +741,30 @@ BYTE __stdcall CSuperSerialCard::CommTransmit(WORD, WORD, BYTE, BYTE value, ULON
 	}
 	else if (m_hCommHandle != INVALID_HANDLE_VALUE)
 	{
+		BOOL res = false;
+		DWORD error = 0;
+
+		// Use CriticalSection to keep WriteFile() & m_vbTxEmpty in sync (GH#707)
+		EnterCriticalSection(&m_CriticalSection);
+
+		_ASSERT(m_vbTxEmpty == true);
 		DWORD uBytesWritten;
-		WriteFile(m_hCommHandle, &value, 1, &uBytesWritten, &m_o);
-		m_vbTxEmpty = false;
-		// NB. Now CommThread() determines when transmit buffer is empty and calls TransmitDone()
+		res = WriteFile(m_hCommHandle, &value, 1, &uBytesWritten, &m_o);
+		_ASSERT(res);
+		if (res)
+		{
+			m_vbTxEmpty = false;
+			// NB. Now CommThread() determines when transmit buffer is empty and calls TransmitDone()
+		}
+		else
+		{
+			error = GetLastError();
+		}
+
+		LeaveCriticalSection(&m_CriticalSection);
+
+		if (!res)
+			LogFileOutput("SSC: CommTransmit(): WriteFile() failed: 0x%08X\n", error);
 	}
 
 	return 0;
@@ -999,8 +1038,6 @@ void CSuperSerialCard::CommSetSerialPort(HWND hWindow, DWORD dwNewSerialPortItem
 // . COMSTAT::InQueue = 0x1000
 //
 
-static UINT g_uDbgTotalCOMRx = 0;
-
 void CSuperSerialCard::CheckCommEvent(DWORD dwEvtMask)
 {
 	if (dwEvtMask & EV_RXCHAR)
@@ -1016,8 +1053,6 @@ void CSuperSerialCard::CheckCommEvent(DWORD dwEvtMask)
 			if (!ReadFile(m_hCommHandle, Data, sizeof(Data), &dwReceived, &m_o) || !dwReceived)
 				break;
 
-			g_uDbgTotalCOMRx += dwReceived;
-
 			bGotData = true;
 
 			EnterCriticalSection(&m_CriticalSection);
diff --git a/source/SerialComms.h b/source/SerialComms.h
index 5925eb87..71d698b0 100644
--- a/source/SerialComms.h
+++ b/source/SerialComms.h
@@ -115,7 +115,7 @@ private:
 
 	//
 
-	CRITICAL_SECTION	m_CriticalSection;	// To guard /g_vRecvBytes/
+	CRITICAL_SECTION	m_CriticalSection;	// To guard /m_vuRxCurrBuffer/ and /m_vbTxEmpty/
 	std::deque<BYTE>	m_qComSerialBuffer[2];
 	volatile UINT		m_vuRxCurrBuffer;	// Written to on COM recv. SSC reads from other one
 	std::deque<BYTE>	m_qTcpSerialBuffer;