src/lib/adapter/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 "AdapterMessage.h"
  36 #include "../CECProcessor.h"
  37 #include "../platform/serialport/serialport.h"
  38 #include "../LibCEC.h"
  39
  40 using namespace std;
  41 using namespace CEC;
  42 using namespace PLATFORM;
  43
  44 CAdapterCommunication::CAdapterCommunication(CCECProcessor *processor) :
  45     m_port(NULL),
  46     m_processor(processor),
  47     m_iLineTimeout(0),
  48     m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN)
  49 {
  50   m_port = new PLATFORM::CSerialPort;
  51 }
  52
  53 CAdapterCommunication::~CAdapterCommunication(void)
  54 {
  55   Close();
  56
  57   if (m_port)
  58   {
  59     delete m_port;
  60     m_port = NULL;
  61   }
  62 }
  63
  64 bool CAdapterCommunication::Open(const char *strPort, uint16_t iBaudRate /* = 38400 */, uint32_t iTimeoutMs /* = 10000 */)
  65 {
  66   uint64_t iNow = GetTimeMs();
  67   uint64_t iTimeout = iNow + iTimeoutMs;
  68
  69   CLockObject lock(m_mutex);
  70
  71   if (!m_port)
  72   {
  73     CLibCEC::AddLog(CEC_LOG_ERROR, "port is NULL");
  74     return false;
  75   }
  76
  77   if (IsOpen())
  78   {
  79     CLibCEC::AddLog(CEC_LOG_ERROR, "port is already open");
  80     return true;
  81   }
  82
  83   CStdString strError;
  84   bool bConnected(false);
  85   while (!bConnected && iNow < iTimeout)
  86   {
  87     if ((bConnected = m_port->Open(strPort, iBaudRate)) == false)
  88     {
  89       strError.Format("error opening serial port '%s': %s", strPort, m_port->GetError().c_str());
  90       Sleep(250);
  91       iNow = GetTimeMs();
  92     }
  93   }
  94
  95   if (!bConnected)
  96   {
  97     CLibCEC::AddLog(CEC_LOG_ERROR, strError);
  98     return false;
  99   }
 100
 101   CLibCEC::AddLog(CEC_LOG_DEBUG, "connection opened");
 102
 103   //clear any input bytes
 104   uint8_t buff[1];
 105   while (m_port->Read(buff, 1, 5) == 1) {}
 106
 107   if (CreateThread())
 108   {
 109     CLibCEC::AddLog(CEC_LOG_DEBUG, "communication thread started");
 110     return true;
 111   }
 112   else
 113   {
 114     CLibCEC::AddLog(CEC_LOG_ERROR, "could not create a communication thread");
 115   }
 116
 117   return false;
 118 }
 119
 120 void CAdapterCommunication::Close(void)
 121 {
 122   CLockObject lock(m_mutex);
 123   m_rcvCondition.Broadcast();
 124   StopThread();
 125 }
 126
 127 void *CAdapterCommunication::Process(void)
 128 {
 129   while (!IsStopped())
 130   {
 131     ReadFromDevice(50);
 132     Sleep(5);
 133     WriteNextCommand();
 134   }
 135
 136   CCECAdapterMessage *msg(NULL);
 137   if (m_outBuffer.Pop(msg))
 138     msg->condition.Broadcast();
 139
 140   return NULL;
 141 }
 142
 143 bool CAdapterCommunication::Write(CCECAdapterMessage *data)
 144 {
 145   bool bReturn(false);
 146
 147   CLockObject lock(data->mutex);
 148   data->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT;
 149   m_outBuffer.Push(data);
 150   data->condition.Wait(data->mutex);
 151
 152   if (data->state != ADAPTER_MESSAGE_STATE_SENT)
 153   {
 154     CLibCEC::AddLog(CEC_LOG_ERROR, "command was not sent");
 155   }
 156
 157   if (data->expectControllerAck)
 158   {
 159     bReturn = WaitForTransmitSucceeded(data);
 160     if (bReturn)
 161     {
 162       if (data->isTransmission)
 163         data->state = ADAPTER_MESSAGE_STATE_SENT_ACKED;
 164     }
 165     else
 166     {
 167       data->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
 168       CLibCEC::AddLog(CEC_LOG_DEBUG, "did not receive ack");
 169     }
 170   }
 171   else
 172   {
 173     bReturn = true;
 174   }
 175
 176   return bReturn;
 177 }
 178
 179 bool CAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
 180 {
 181   CLockObject lock(m_mutex);
 182
 183   msg.Clear();
 184   uint64_t iNow = GetTimeMs();
 185   uint64_t iTarget = iNow + iTimeout;
 186   bool bGotFullMessage(false);
 187   bool bNextIsEscaped(false);
 188   bool bGotStart(false);
 189
 190   while(!bGotFullMessage && iNow < iTarget)
 191   {
 192     uint8_t buf = 0;
 193     if (!m_inBuffer.Pop(buf))
 194     {
 195       if (!m_rcvCondition.Wait(m_mutex, (uint32_t) (iTarget - iNow)))
 196         return false;
 197     }
 198
 199     if (!bGotStart)
 200     {
 201       if (buf == MSGSTART)
 202         bGotStart = true;
 203       continue;
 204     }
 205     else if (buf == MSGSTART) //we found a msgstart before msgend, this is not right, remove
 206     {
 207       if (msg.Size() > 0)
 208         CLibCEC::AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents");
 209       msg.Clear();
 210       bGotStart = true;
 211     }
 212
 213     if (buf == MSGEND)
 214     {
 215       bGotFullMessage = true;
 216     }
 217     else if (bNextIsEscaped)
 218     {
 219       msg.PushBack(buf + (uint8_t)ESCOFFSET);
 220       bNextIsEscaped = false;
 221     }
 222     else if (buf == MSGESC)
 223       bNextIsEscaped = true;
 224     else
 225       msg.PushBack(buf);
 226   }
 227
 228   if (bGotFullMessage)
 229     msg.state = ADAPTER_MESSAGE_STATE_INCOMING;
 230
 231   return bGotFullMessage;
 232 }
 233
 234 std::string CAdapterCommunication::GetError(void) const
 235 {
 236   return m_port->GetError();
 237 }
 238
 239 bool CAdapterCommunication::StartBootloader(void)
 240 {
 241   bool bReturn(false);
 242   if (!IsRunning())
 243     return bReturn;
 244
 245   CLibCEC::AddLog(CEC_LOG_DEBUG, "starting the bootloader");
 246   CCECAdapterMessage *output = new CCECAdapterMessage;
 247
 248   output->PushBack(MSGSTART);
 249   output->PushEscaped(MSGCODE_START_BOOTLOADER);
 250   output->PushBack(MSGEND);
 251   output->isTransmission = false;
 252   output->expectControllerAck = false;
 253
 254   if ((bReturn = Write(output)) == false)
 255     CLibCEC::AddLog(CEC_LOG_ERROR, "could not start the bootloader");
 256   delete output;
 257
 258   return bReturn;
 259 }
 260
 261 bool CAdapterCommunication::PingAdapter(void)
 262 {
 263   bool bReturn(false);
 264   if (!IsRunning())
 265     return bReturn;
 266
 267   CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");
 268   CCECAdapterMessage *output = new CCECAdapterMessage;
 269
 270   output->PushBack(MSGSTART);
 271   output->PushEscaped(MSGCODE_PING);
 272   output->PushBack(MSGEND);
 273   output->isTransmission = false;
 274
 275   if ((bReturn = Write(output)) == false)
 276     CLibCEC::AddLog(CEC_LOG_ERROR, "could not ping the adapter");
 277   delete output;
 278
 279   return bReturn;
 280 }
 281
 282 uint16_t CAdapterCommunication::GetFirmwareVersion(void)
 283 {
 284   uint16_t iReturn(m_iFirmwareVersion);
 285   if (!IsRunning())
 286     return iReturn;
 287
 288   if (iReturn == CEC_FW_VERSION_UNKNOWN)
 289   {
 290     CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
 291     CCECAdapterMessage *output = new CCECAdapterMessage;
 292
 293     output->PushBack(MSGSTART);
 294     output->PushEscaped(MSGCODE_FIRMWARE_VERSION);
 295     output->PushBack(MSGEND);
 296     output->isTransmission = false;
 297     output->expectControllerAck = false;
 298
 299     SendMessageToAdapter(output);
 300     delete output;
 301
 302     CCECAdapterMessage input;
 303     if (!Read(input, CEC_DEFAULT_TRANSMIT_WAIT) || input.Message() != MSGCODE_FIRMWARE_VERSION || input.Size() != 3)
 304       CLibCEC::AddLog(CEC_LOG_ERROR, "no or invalid firmware version");
 305     else
 306     {
 307       m_iFirmwareVersion = (input[1] << 8 | input[2]);
 308       iReturn = m_iFirmwareVersion;
 309     }
 310   }
 311
 312   return iReturn;
 313 }
 314
 315 bool CAdapterCommunication::SetLineTimeout(uint8_t iTimeout)
 316 {
 317   bool bReturn(m_iLineTimeout != iTimeout);
 318
 319   if (!bReturn)
 320   {
 321     CCECAdapterMessage *output = new CCECAdapterMessage;
 322
 323     output->PushBack(MSGSTART);
 324     output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
 325     output->PushEscaped(iTimeout);
 326     output->PushBack(MSGEND);
 327     output->isTransmission = false;
 328
 329     if ((bReturn = Write(output)) == false)
 330       CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
 331     delete output;
 332   }
 333
 334   return bReturn;
 335 }
 336
 337 bool CAdapterCommunication::SetAckMask(uint16_t iMask)
 338 {
 339   bool bReturn(false);
 340   CStdString strLog;
 341   strLog.Format("setting ackmask to %2x", iMask);
 342   CLibCEC::AddLog(CEC_LOG_DEBUG, strLog.c_str());
 343
 344   CCECAdapterMessage *output = new CCECAdapterMessage;
 345
 346   output->PushBack(MSGSTART);
 347   output->PushEscaped(MSGCODE_SET_ACK_MASK);
 348   output->PushEscaped(iMask >> 8);
 349   output->PushEscaped((uint8_t)iMask);
 350   output->PushBack(MSGEND);
 351   output->isTransmission = false;
 352
 353   if ((bReturn = Write(output)) == false)
 354     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the ackmask");
 355   delete output;
 356
 357   return bReturn;
 358 }
 359
 360 bool CAdapterCommunication::IsOpen(void)
 361 {
 362   return !IsStopped() && m_port->IsOpen() && IsRunning();
 363 }
 364
 365 bool CAdapterCommunication::WaitForTransmitSucceeded(CCECAdapterMessage *message)
 366 {
 367   bool bError(false);
 368   bool bTransmitSucceeded(false);
 369   uint8_t iPacketsLeft(message->Size() / 4);
 370
 371   int64_t iNow = GetTimeMs();
 372   int64_t iTargetTime = iNow + message->transmit_timeout;
 373
 374   while (!bTransmitSucceeded && !bError && (message->transmit_timeout == 0 || iNow < iTargetTime))
 375   {
 376     CCECAdapterMessage msg;
 377     int32_t iWait = (int32_t)(iTargetTime - iNow);
 378     if (iWait <= 5 || message->transmit_timeout <= 5)
 379       iWait = CEC_DEFAULT_TRANSMIT_WAIT;
 380
 381     if (!Read(msg, iWait))
 382     {
 383       iNow = GetTimeMs();
 384       continue;
 385     }
 386
 387     if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK())
 388     {
 389       m_processor->HandlePoll(msg.Initiator(), msg.Destination());
 390       iNow = GetTimeMs();
 391       continue;
 392     }
 393
 394     if (msg.Message() == MSGCODE_RECEIVE_FAILED &&
 395         m_processor->HandleReceiveFailed())
 396     {
 397       iNow = GetTimeMs();
 398       continue;
 399     }
 400
 401     bError = msg.IsError();
 402     if (bError)
 403     {
 404       message->reply = msg.Message();
 405       CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 406     }
 407     else
 408     {
 409       switch(msg.Message())
 410       {
 411       case MSGCODE_COMMAND_ACCEPTED:
 412         CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 413         if (iPacketsLeft > 0)
 414           iPacketsLeft--;
 415         if (!message->isTransmission && iPacketsLeft == 0)
 416           bTransmitSucceeded = true;
 417         break;
 418       case MSGCODE_TRANSMIT_SUCCEEDED:
 419         CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 420         bTransmitSucceeded = (iPacketsLeft == 0);
 421         bError = !bTransmitSucceeded;
 422         message->reply = MSGCODE_TRANSMIT_SUCCEEDED;
 423         break;
 424       default:
 425         // ignore other data while waiting
 426         break;
 427       }
 428
 429       iNow = GetTimeMs();
 430     }
 431   }
 432
 433   return bTransmitSucceeded && !bError;
 434 }
 435
 436 void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen)
 437 {
 438   CLockObject lock(m_mutex);
 439   for (uint8_t iPtr = 0; iPtr < iLen; iPtr++)
 440     m_inBuffer.Push(data[iPtr]);
 441
 442   m_rcvCondition.Signal();
 443 }
 444
 445 bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
 446 {
 447   int32_t iBytesRead;
 448   uint8_t buff[1024];
 449   if (!m_port)
 450     return false;
 451
 452   CLockObject lock(m_mutex);
 453   iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
 454   if (iBytesRead < 0 || iBytesRead > 256)
 455   {
 456     CStdString strError;
 457     strError.Format("error reading from serial port: %s", m_port->GetError().c_str());
 458     CLibCEC::AddLog(CEC_LOG_ERROR, strError);
 459     return false;
 460   }
 461   else if (iBytesRead > 0)
 462     AddData(buff, (uint8_t) iBytesRead);
 463
 464   return iBytesRead > 0;
 465 }
 466
 467 void CAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg)
 468 {
 469   CLockObject adapterLock(m_mutex);
 470   CLockObject lock(msg->mutex);
 471   if (m_port->Write(msg->packet.data, msg->Size()) != (int32_t) msg->Size())
 472   {
 473     CStdString strError;
 474     strError.Format("error writing to serial port: %s", m_port->GetError().c_str());
 475     CLibCEC::AddLog(CEC_LOG_ERROR, strError);
 476     msg->state = ADAPTER_MESSAGE_STATE_ERROR;
 477   }
 478   else
 479   {
 480     CLibCEC::AddLog(CEC_LOG_DEBUG, "command sent");
 481     msg->state = ADAPTER_MESSAGE_STATE_SENT;
 482   }
 483   msg->condition.Signal();
 484 }
 485
 486 void CAdapterCommunication::WriteNextCommand(void)
 487 {
 488   CCECAdapterMessage *msg(NULL);
 489   if (m_outBuffer.Pop(msg))
 490     SendMessageToAdapter(msg);
 491 }