src/lib/platform/windows/serialport.cpp

   1 /*
   2  * This file is part of the libCEC(R) library.
   3  *
   4  * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
   5  * libCEC(R) is an original work, containing original code.
   6  *
   7  * libCEC(R) is a trademark of Pulse-Eight Limited.
   8  *
   9  * This program is dual-licensed; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  *
  23  *
  24  * Alternatively, you can license this library under a commercial license,
  25  * please contact Pulse-Eight Licensing for more information.
  26  *
  27  * For more information contact:
  28  * Pulse-Eight Licensing       <license@pulse-eight.com>
  29  *     http://www.pulse-eight.com/
  30  *     http://www.pulse-eight.net/
  31  */
  32
  33 #include "../sockets/serialport.h"
  34 #include "../util/baudrate.h"
  35 #include "../util/timeutils.h"
  36
  37 using namespace std;
  38 using namespace PLATFORM;
  39
  40 void FormatWindowsError(int iErrorCode, CStdString &strMessage)
  41 {
  42   if (iErrorCode != ERROR_SUCCESS)
  43   {
  44     char strAddMessage[1024];
  45     FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, iErrorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), strAddMessage, 1024, NULL);
  46     strMessage.append(": ");
  47     strMessage.append(strAddMessage);
  48   }
  49 }
  50
  51 bool SetTimeouts(serial_socket_t socket, int* iError, bool bBlocking)
  52 {
  53   if (socket == INVALID_HANDLE_VALUE)
  54           return false;
  55
  56   COMMTIMEOUTS cto;
  57   if (!GetCommTimeouts(socket, &cto))
  58   {
  59     *iError = GetLastError();
  60     return false;
  61   }
  62
  63   if (bBlocking)
  64   {
  65     cto.ReadIntervalTimeout         = 0;
  66     cto.ReadTotalTimeoutConstant    = 0;
  67     cto.ReadTotalTimeoutMultiplier  = 0;
  68   }
  69   else
  70   {
  71     cto.ReadIntervalTimeout         = MAXDWORD;
  72     cto.ReadTotalTimeoutConstant    = 0;
  73     cto.ReadTotalTimeoutMultiplier  = 0;
  74   }
  75
  76   if (!SetCommTimeouts(socket, &cto))
  77   {
  78     *iError = GetLastError();
  79     return false;
  80   }
  81
  82   return true;
  83 }
  84
  85 void CSerialSocket::Close(void)
  86 {
  87   if (IsOpen())
  88     SerialSocketClose(m_socket);
  89   m_socket = INVALID_SERIAL_SOCKET_VALUE;
  90 }
  91
  92 void CSerialSocket::Shutdown(void)
  93 {
  94   if (IsOpen())
  95     SerialSocketClose(m_socket);
  96   m_socket = INVALID_SERIAL_SOCKET_VALUE;
  97 }
  98
  99 ssize_t CSerialSocket::Write(void* data, size_t len)
 100 {
 101   return IsOpen() ? SerialSocketWrite(m_socket, &m_iError, data, len) : -1;
 102 }
 103
 104 ssize_t CSerialSocket::Read(void* data, size_t len, uint64_t iTimeoutMs /* = 0 */)
 105 {
 106   return IsOpen() ? SerialSocketRead(m_socket, &m_iError, data, len, iTimeoutMs) : -1;
 107 }
 108
 109 bool CSerialSocket::Open(uint64_t iTimeoutMs /* = 0 */)
 110 {
 111   iTimeoutMs = 0;
 112   if (IsOpen())
 113     return false;
 114
 115   CStdString strComPath = "\\\\.\\" + m_strName;
 116   CLockObject lock(m_mutex);
 117   m_socket = CreateFile(strComPath.c_str(), GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
 118   if (m_socket == INVALID_HANDLE_VALUE)
 119   {
 120     m_strError = "Unable to open COM port";
 121     FormatWindowsError(GetLastError(), m_strError);
 122     return false;
 123   }
 124
 125   COMMCONFIG commConfig = {0};
 126   DWORD dwSize = sizeof(commConfig);
 127   commConfig.dwSize = dwSize;
 128   if (GetDefaultCommConfig(strComPath.c_str(), &commConfig,&dwSize))
 129   {
 130     if (!SetCommConfig(m_socket, &commConfig,dwSize))
 131     {
 132       m_strError = "unable to set default config";
 133       FormatWindowsError(GetLastError(), m_strError);
 134     }
 135   }
 136   else
 137   {
 138     m_strError = "unable to get default config";
 139     FormatWindowsError(GetLastError(), m_strError);
 140   }
 141
 142   if (!SetupComm(m_socket, 64, 64))
 143   {
 144     m_strError = "unable to set up the com port";
 145     FormatWindowsError(GetLastError(), m_strError);
 146   }
 147
 148   if (!SetBaudRate(m_iBaudrate))
 149   {
 150     m_strError = "unable to set baud rate";
 151     FormatWindowsError(GetLastError(), m_strError);
 152     Close();
 153     return false;
 154   }
 155
 156   if (!SetTimeouts(m_socket, &m_iError, false))
 157   {
 158     m_strError = "unable to set timeouts";
 159     FormatWindowsError(GetLastError(), m_strError);
 160     Close();
 161     return false;
 162   }
 163
 164   m_bIsOpen = true;
 165   return m_bIsOpen;
 166 }
 167
 168 bool CSerialSocket::SetBaudRate(uint32_t baudrate)
 169 {
 170   int32_t rate = IntToBaudrate(baudrate);
 171   if (rate < 0)
 172     m_iBaudrate = baudrate > 0 ? baudrate : 0;
 173   else
 174     m_iBaudrate = rate;
 175
 176   DCB dcb;
 177   memset(&dcb,0,sizeof(dcb));
 178   dcb.DCBlength = sizeof(dcb);
 179   dcb.BaudRate      = IntToBaudrate(m_iBaudrate);
 180   dcb.fBinary       = true;
 181   dcb.fDtrControl   = DTR_CONTROL_DISABLE;
 182   dcb.fRtsControl   = RTS_CONTROL_DISABLE;
 183   dcb.fOutxCtsFlow  = false;
 184   dcb.fOutxDsrFlow  = false;
 185   dcb.fOutX         = false;
 186         dcb.fInX          = false;
 187   dcb.fAbortOnError = true;
 188
 189   if (m_iParity == SERIAL_PARITY_NONE)
 190     dcb.Parity = NOPARITY;
 191   else if (m_iParity == SERIAL_PARITY_EVEN)
 192     dcb.Parity = EVENPARITY;
 193   else
 194     dcb.Parity = ODDPARITY;
 195
 196   if (m_iStopbits == SERIAL_STOP_BITS_TWO)
 197     dcb.StopBits = TWOSTOPBITS;
 198   else
 199     dcb.StopBits = ONESTOPBIT;
 200
 201   dcb.ByteSize = (BYTE)m_iDatabits;
 202
 203   if(!SetCommState(m_socket,&dcb))
 204   {
 205     m_strError = "SetCommState failed";
 206     FormatWindowsError(GetLastError(), m_strError);
 207     return false;
 208   }
 209
 210   return true;
 211 }