src/lib/platform/posix/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 "env.h"
  34 #include <stdio.h>
  35 #include <fcntl.h>
  36 #include "lib/platform/sockets/serialport.h"
  37 #include "lib/platform/util/baudrate.h"
  38 #include "lib/platform/posix/os-socket.h"
  39
  40 #if defined(__APPLE__) || defined(__FreeBSD__)
  41 #ifndef XCASE
  42 #define XCASE   0
  43 #endif
  44 #ifndef OLCUC
  45 #define OLCUC   0
  46 #endif
  47 #ifndef IUCLC
  48 #define IUCLC   0
  49 #endif
  50 #else
  51 #include <lockdev.h>
  52 #endif
  53
  54 using namespace std;
  55 using namespace PLATFORM;
  56
  57 inline bool RemoveLock(const char *strDeviceName)
  58 {
  59   #if !defined(__APPLE__) && !defined(__FreeBSD__)
  60   return dev_unlock(strDeviceName, 0) == 0;
  61   #else
  62   void *tmp = (void*)strDeviceName; // silence unused warning
  63   tmp = NULL;
  64   return true;
  65   #endif
  66 }
  67
  68 void CSerialSocket::Close(void)
  69 {
  70   if (IsOpen())
  71   {
  72     SocketClose(m_socket);
  73     RemoveLock(m_strName.c_str());
  74   }
  75 }
  76
  77 void CSerialSocket::Shutdown(void)
  78 {
  79   if (IsOpen())
  80   {
  81     SocketClose(m_socket);
  82     RemoveLock(m_strName.c_str());
  83   }
  84 }
  85
  86 ssize_t CSerialSocket::Write(void* data, size_t len)
  87 {
  88   return IsOpen() ? SocketWrite(m_socket, &m_iError, data, len) : -1;
  89 }
  90
  91 ssize_t CSerialSocket::Read(void* data, size_t len, uint64_t iTimeoutMs /* = 0 */)
  92 {
  93   return IsOpen() ? SocketRead(m_socket, &m_iError, data, len, iTimeoutMs) : -1;
  94 }
  95
  96 //setting all this stuff up is a pain in the ass
  97 bool CSerialSocket::Open(uint64_t iTimeoutMs /* = 0 */)
  98 {
  99   iTimeoutMs = 0; if (!iTimeoutMs){} // silence unused warning
 100   if (IsOpen())
 101   {
 102     m_iError = EINVAL;
 103     return false;
 104   }
 105
 106   if (m_iDatabits != SERIAL_DATA_BITS_FIVE && m_iDatabits != SERIAL_DATA_BITS_SIX &&
 107       m_iDatabits != SERIAL_DATA_BITS_SEVEN && m_iDatabits != SERIAL_DATA_BITS_EIGHT)
 108   {
 109     m_strError = "Databits has to be between 5 and 8";
 110     m_iError = EINVAL;
 111     return false;
 112   }
 113
 114   if (m_iStopbits != SERIAL_STOP_BITS_ONE && m_iStopbits != SERIAL_STOP_BITS_TWO)
 115   {
 116     m_strError = "Stopbits has to be 1 or 2";
 117     m_iError = EINVAL;
 118     return false;
 119   }
 120
 121   if (m_iParity != SERIAL_PARITY_NONE && m_iParity != SERIAL_PARITY_EVEN && m_iParity != SERIAL_PARITY_ODD)
 122   {
 123     m_strError = "Parity has to be none, even or odd";
 124     m_iError = EINVAL;
 125     return false;
 126   }
 127
 128   #if !defined(__APPLE__) && !defined(__FreeBSD__)
 129   if (dev_lock(m_strName.c_str()) != 0)
 130   {
 131     m_strError = "Couldn't lock the serial port";
 132     m_iError = EBUSY;
 133     return false;
 134   }
 135   #endif
 136
 137   m_socket = open(m_strName.c_str(), O_RDWR | O_NOCTTY | O_NDELAY);
 138
 139   if (m_socket == INVALID_SERIAL_SOCKET_VALUE)
 140   {
 141     m_strError = strerror(errno);
 142     RemoveLock(m_strName.c_str());
 143     return false;
 144   }
 145
 146   SocketSetBlocking(m_socket, false);
 147
 148   if (!SetBaudRate(m_iBaudrate))
 149     return false;
 150
 151   m_options.c_cflag |= (CLOCAL | CREAD);
 152   m_options.c_cflag &= ~HUPCL;
 153
 154   m_options.c_cflag &= ~CSIZE;
 155   if (m_iDatabits == SERIAL_DATA_BITS_FIVE)  m_options.c_cflag |= CS5;
 156   if (m_iDatabits == SERIAL_DATA_BITS_SIX)   m_options.c_cflag |= CS6;
 157   if (m_iDatabits == SERIAL_DATA_BITS_SEVEN) m_options.c_cflag |= CS7;
 158   if (m_iDatabits == SERIAL_DATA_BITS_EIGHT) m_options.c_cflag |= CS8;
 159
 160   m_options.c_cflag &= ~PARENB;
 161   if (m_iParity == SERIAL_PARITY_EVEN || m_iParity == SERIAL_PARITY_ODD)
 162     m_options.c_cflag |= PARENB;
 163   if (m_iParity == SERIAL_PARITY_ODD)
 164     m_options.c_cflag |= PARODD;
 165
 166 #ifdef CRTSCTS
 167   m_options.c_cflag &= ~CRTSCTS;
 168 #elif defined(CNEW_RTSCTS)
 169   m_options.c_cflag &= ~CNEW_RTSCTS;
 170 #endif
 171
 172   if (m_iStopbits == SERIAL_STOP_BITS_ONE) m_options.c_cflag &= ~CSTOPB;
 173   else m_options.c_cflag |= CSTOPB;
 174
 175   //I guessed a little here
 176   m_options.c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG | XCASE | ECHOK | ECHONL | ECHOCTL | ECHOPRT | ECHOKE | TOSTOP);
 177
 178   if (m_iParity == SERIAL_PARITY_NONE)
 179     m_options.c_iflag &= ~INPCK;
 180   else
 181     m_options.c_iflag |= INPCK | ISTRIP;
 182
 183   m_options.c_iflag &= ~(IXON | IXOFF | IXANY | BRKINT | INLCR | IGNCR | ICRNL | IUCLC | IMAXBEL);
 184   m_options.c_oflag &= ~(OPOST | ONLCR | OCRNL);
 185
 186   if (tcsetattr(m_socket, TCSANOW, &m_options) != 0)
 187   {
 188     m_strError = strerror(errno);
 189     RemoveLock(m_strName.c_str());
 190     return false;
 191   }
 192
 193   SocketSetBlocking(m_socket, true);
 194   m_bIsOpen = true;
 195
 196   return true;
 197 }
 198
 199 bool CSerialSocket::SetBaudRate(uint32_t baudrate)
 200 {
 201   int rate = IntToBaudrate(baudrate);
 202   if (rate == -1)
 203   {
 204     char buff[255];
 205     sprintf(buff, "%i is not a valid baudrate", baudrate);
 206     m_strError = buff;
 207     return false;
 208   }
 209
 210   //get the current port attributes
 211   if (tcgetattr(m_socket, &m_options) != 0)
 212   {
 213     m_strError = strerror(errno);
 214     return false;
 215   }
 216
 217   if (cfsetispeed(&m_options, rate) != 0)
 218   {
 219     m_strError = strerror(errno);
 220     return false;
 221   }
 222
 223   if (cfsetospeed(&m_options, rate) != 0)
 224   {
 225     m_strError = strerror(errno);
 226     return false;
 227   }
 228
 229   return true;
 230 }