src/lib/AdapterCommunication.cpp

   1 /*
   2  * This file is part of the libCEC(R) library.
   3  *
   4  * libCEC(R) is Copyright (C) 2011 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 "AdapterCommunication.h"
  34
  35 #include "LibCEC.h"
  36 #include "platform/serialport.h"
  37 #include "util/StdString.h"
  38
  39 using namespace std;
  40 using namespace CEC;
  41
  42 CAdapterCommunication::CAdapterCommunication(CLibCEC *controller) :
  43     m_port(NULL),
  44     m_controller(controller),
  45     m_inbuf(NULL),
  46     m_iInbufSize(0),
  47     m_iInbufUsed(0)
  48 {
  49   m_port = new CSerialPort;
  50 }
  51
  52 CAdapterCommunication::~CAdapterCommunication(void)
  53 {
  54   Close();
  55
  56   if (m_port)
  57   {
  58     delete m_port;
  59     m_port = NULL;
  60   }
  61
  62   if (m_inbuf)
  63     free(m_inbuf);
  64 }
  65
  66 bool CAdapterCommunication::Open(const char *strPort, uint16_t iBaudRate /* = 38400 */, uint32_t iTimeoutMs /* = 10000 */)
  67 {
  68   CLockObject lock(&m_mutex);
  69   if (!m_port)
  70   {
  71     m_controller->AddLog(CEC_LOG_ERROR, "port is NULL");
  72     return false;
  73   }
  74
  75   if (IsOpen())
  76   {
  77     m_controller->AddLog(CEC_LOG_ERROR, "port is already open");
  78   }
  79
  80   if (!m_port->Open(strPort, iBaudRate))
  81   {
  82     CStdString strError;
  83     strError.Format("error opening serial port '%s': %s", strPort, m_port->GetError().c_str());
  84     m_controller->AddLog(CEC_LOG_ERROR, strError);
  85     return false;
  86   }
  87
  88   m_controller->AddLog(CEC_LOG_DEBUG, "connection opened");
  89
  90   //clear any input bytes
  91   uint8_t buff[1024];
  92   m_port->Read(buff, sizeof(buff), 50);
  93
  94   Sleep(CEC_SETTLE_DOWN_TIME);
  95
  96   if (CreateThread())
  97   {
  98     m_controller->AddLog(CEC_LOG_DEBUG, "communication thread created");
  99     return true;
 100   }
 101   else
 102   {
 103     m_controller->AddLog(CEC_LOG_DEBUG, "could not create a communication thread");
 104   }
 105
 106   return false;
 107 }
 108
 109 void CAdapterCommunication::Close(void)
 110 {
 111   m_rcvCondition.Broadcast();
 112
 113   CLockObject lock(&m_mutex);
 114   StopThread();
 115
 116   if (m_inbuf)
 117   {
 118     free(m_inbuf);
 119     m_inbuf = NULL;
 120     m_iInbufSize = 0;
 121     m_iInbufUsed = 0;
 122   }
 123 }
 124
 125 void *CAdapterCommunication::Process(void)
 126 {
 127   m_controller->AddLog(CEC_LOG_DEBUG, "communication thread started");
 128
 129   while (!IsStopped())
 130   {
 131     {
 132       CLockObject lock(&m_mutex);
 133       if (ReadFromDevice(50))
 134         m_rcvCondition.Signal();
 135     }
 136
 137     if (!IsStopped())
 138       Sleep(50);
 139   }
 140
 141   return NULL;
 142 }
 143
 144 bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
 145 {
 146   int32_t iBytesRead;
 147   uint8_t buff[1024];
 148   if (!m_port)
 149     return false;
 150
 151   iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
 152   if (iBytesRead < 0 || iBytesRead > 256)
 153   {
 154     CStdString strError;
 155     strError.Format("error reading from serial port: %s", m_port->GetError().c_str());
 156     m_controller->AddLog(CEC_LOG_ERROR, strError);
 157     StopThread(false);
 158     return false;
 159   }
 160   else if (iBytesRead > 0)
 161     AddData(buff, (uint8_t) iBytesRead);
 162
 163   return iBytesRead > 0;
 164 }
 165
 166 void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen)
 167 {
 168   if (m_iInbufUsed + iLen > m_iInbufSize)
 169   {
 170     m_iInbufSize = m_iInbufUsed + iLen;
 171     m_inbuf = (uint8_t*)realloc(m_inbuf, m_iInbufSize);
 172   }
 173
 174   memcpy(m_inbuf + m_iInbufUsed, data, iLen);
 175   m_iInbufUsed += iLen;
 176 }
 177
 178 bool CAdapterCommunication::Write(const cec_frame &data)
 179 {
 180   {
 181     CLockObject lock(&m_mutex);
 182     if (m_port->Write(data) != (int32_t) data.size)
 183     {
 184       CStdString strError;
 185       strError.Format("error writing to serial port: %s", m_port->GetError().c_str());
 186       m_controller->AddLog(CEC_LOG_ERROR, strError);
 187       return false;
 188     }
 189
 190     m_controller->AddLog(CEC_LOG_DEBUG, "command sent");
 191
 192     CCondition::Sleep((uint32_t) data.size * (uint32_t)24 /*data*/ + (uint32_t)5 /*start bit (4.5 ms)*/);
 193   }
 194
 195   return true;
 196 }
 197
 198 bool CAdapterCommunication::Read(cec_frame &msg, uint32_t iTimeout)
 199 {
 200   CLockObject lock(&m_mutex);
 201
 202   if (m_iInbufUsed < 1)
 203   {
 204     if (!m_rcvCondition.Wait(&m_mutex, iTimeout))
 205       return false;
 206   }
 207
 208   if (m_iInbufUsed < 1 || IsStopped())
 209     return false;
 210
 211   //search for first start of message
 212   int16_t startpos = -1;
 213   for (int16_t iPtr = 0; iPtr < m_iInbufUsed; iPtr++)
 214   {
 215     if (m_inbuf[iPtr] == MSGSTART)
 216     {
 217       startpos = iPtr;
 218       break;
 219     }
 220   }
 221
 222   if (startpos == -1)
 223     return false;
 224
 225   //move anything from the first start of message to the beginning of the buffer
 226   if (startpos > 0)
 227   {
 228     memmove(m_inbuf, m_inbuf + startpos, m_iInbufUsed - startpos);
 229     m_iInbufUsed -= startpos;
 230   }
 231
 232   if (m_iInbufUsed < 2)
 233     return false;
 234
 235   //look for end of message
 236   startpos = -1;
 237   int16_t endpos = -1;
 238   for (int16_t iPtr = 1; iPtr < m_iInbufUsed; iPtr++)
 239   {
 240     if (m_inbuf[iPtr] == MSGEND)
 241     {
 242       endpos = iPtr;
 243       break;
 244     }
 245     else if (m_inbuf[iPtr] == MSGSTART)
 246     {
 247       startpos = iPtr;
 248       break;
 249     }
 250   }
 251
 252   if (startpos > 0) //we found a msgstart before msgend, this is not right, remove
 253   {
 254     m_controller->AddLog(CEC_LOG_ERROR, "received MSGSTART before MSGEND");
 255     memmove(m_inbuf, m_inbuf + startpos, m_iInbufUsed - startpos);
 256     m_iInbufUsed -= startpos;
 257     return false;
 258   }
 259
 260   if (endpos > 0) //found a MSGEND
 261   {
 262     msg.clear();
 263     bool isesc = false;
 264     for (int16_t iPtr = 1; iPtr < endpos; iPtr++)
 265     {
 266       if (isesc)
 267       {
 268         msg.push_back(m_inbuf[iPtr] + (uint8_t)ESCOFFSET);
 269         isesc = false;
 270       }
 271       else if (m_inbuf[iPtr] == MSGESC)
 272       {
 273         isesc = true;
 274       }
 275       else
 276       {
 277         msg.push_back(m_inbuf[iPtr]);
 278       }
 279     }
 280
 281     if (endpos + 1 < m_iInbufUsed)
 282       memmove(m_inbuf, m_inbuf + endpos + 1, m_iInbufUsed - endpos - 1);
 283
 284     m_iInbufUsed -= endpos + 1;
 285
 286     return true;
 287   }
 288
 289   return false;
 290 }
 291
 292 std::string CAdapterCommunication::GetError(void) const
 293 {
 294   return m_port->GetError();
 295 }
 296
 297 bool CAdapterCommunication::StartBootloader(void)
 298 {
 299   if (!IsRunning())
 300     return false;
 301
 302   m_controller->AddLog(CEC_LOG_DEBUG, "starting the bootloader");
 303   cec_frame output;
 304   output.clear();
 305
 306   output.push_back(MSGSTART);
 307   PushEscaped(output, MSGCODE_START_BOOTLOADER);
 308   output.push_back(MSGEND);
 309
 310   if (!Write(output))
 311   {
 312     m_controller->AddLog(CEC_LOG_ERROR, "could not start the bootloader");
 313     return false;
 314   }
 315   m_controller->AddLog(CEC_LOG_DEBUG, "bootloader start command transmitted");
 316   return true;
 317 }
 318
 319 void CAdapterCommunication::PushEscaped(cec_frame &vec, uint8_t byte)
 320 {
 321   if (byte >= MSGESC && byte != MSGSTART)
 322   {
 323     vec.push_back(MSGESC);
 324     vec.push_back(byte - ESCOFFSET);
 325   }
 326   else
 327   {
 328     vec.push_back(byte);
 329   }
 330 }
 331
 332 bool CAdapterCommunication::SetAckMask(uint16_t iMask)
 333 {
 334   if (!IsRunning())
 335     return false;
 336
 337   CStdString strLog;
 338   strLog.Format("setting ackmask to %2x", iMask);
 339   m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
 340
 341   cec_frame output;
 342   output.clear();
 343
 344   output.push_back(MSGSTART);
 345   PushEscaped(output, MSGCODE_SET_ACK_MASK);
 346   PushEscaped(output, iMask >> 8);
 347   PushEscaped(output, (uint8_t)iMask);
 348   output.push_back(MSGEND);
 349
 350   if (!Write(output))
 351   {
 352     m_controller->AddLog(CEC_LOG_ERROR, "could not set the ackmask");
 353     return false;
 354   }
 355
 356   return true;
 357 }
 358
 359 bool CAdapterCommunication::PingAdapter(void)
 360 {
 361   if (!IsRunning())
 362     return false;
 363
 364   m_controller->AddLog(CEC_LOG_DEBUG, "sending ping");
 365   cec_frame output;
 366   output.clear();
 367
 368   output.push_back(MSGSTART);
 369   PushEscaped(output, MSGCODE_PING);
 370   output.push_back(MSGEND);
 371
 372   if (!Write(output))
 373   {
 374     m_controller->AddLog(CEC_LOG_ERROR, "could not send ping command");
 375     return false;
 376   }
 377
 378   m_controller->AddLog(CEC_LOG_DEBUG, "ping tranmitted");
 379
 380   // TODO check for pong
 381   return true;
 382 }
 383
 384 bool CAdapterCommunication::IsOpen(void) const
 385 {
 386   return !IsStopped() && m_port->IsOpen();
 387 }