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