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   else if (data->expectControllerAck)
 157   {
 158     bReturn = WaitForAck(*data);
 159     if (bReturn)
 160     {
 161       if (data->isTransmission)
 162         data->state = ADAPTER_MESSAGE_STATE_SENT_ACKED;
 163     }
 164     else
 165     {
 166       data->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
 167       CLibCEC::AddLog(CEC_LOG_DEBUG, "did not receive ack");
 168     }
 169   }
 170   else
 171   {
 172     bReturn = true;
 173   }
 174
 175   return bReturn;
 176 }
 177
 178 bool CAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
 179 {
 180   CLockObject lock(m_mutex);
 181
 182   msg.Clear();
 183   uint64_t iNow = GetTimeMs();
 184   uint64_t iTarget = iNow + iTimeout;
 185   bool bGotFullMessage(false);
 186   bool bNextIsEscaped(false);
 187   bool bGotStart(false);
 188
 189   while(!bGotFullMessage && iNow < iTarget)
 190   {
 191     uint8_t buf = 0;
 192     if (!m_inBuffer.Pop(buf))
 193     {
 194       if (!m_rcvCondition.Wait(m_mutex, (uint32_t) (iTarget - iNow)))
 195         return false;
 196     }
 197
 198     if (!bGotStart)
 199     {
 200       if (buf == MSGSTART)
 201         bGotStart = true;
 202       continue;
 203     }
 204     else if (buf == MSGSTART) //we found a msgstart before msgend, this is not right, remove
 205     {
 206       if (msg.Size() > 0)
 207         CLibCEC::AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents");
 208       msg.Clear();
 209       bGotStart = true;
 210     }
 211
 212     if (buf == MSGEND)
 213     {
 214       bGotFullMessage = true;
 215     }
 216     else if (bNextIsEscaped)
 217     {
 218       msg.PushBack(buf + (uint8_t)ESCOFFSET);
 219       bNextIsEscaped = false;
 220     }
 221     else if (buf == MSGESC)
 222       bNextIsEscaped = true;
 223     else
 224       msg.PushBack(buf);
 225   }
 226
 227   if (bGotFullMessage)
 228     msg.state = ADAPTER_MESSAGE_STATE_INCOMING;
 229
 230   return bGotFullMessage;
 231 }
 232
 233 std::string CAdapterCommunication::GetError(void) const
 234 {
 235   return m_port->GetError();
 236 }
 237
 238 bool CAdapterCommunication::StartBootloader(void)
 239 {
 240   bool bReturn(false);
 241   if (!IsRunning())
 242     return bReturn;
 243
 244   CLibCEC::AddLog(CEC_LOG_DEBUG, "starting the bootloader");
 245   CCECAdapterMessage *output = new CCECAdapterMessage;
 246
 247   output->PushBack(MSGSTART);
 248   output->PushEscaped(MSGCODE_START_BOOTLOADER);
 249   output->PushBack(MSGEND);
 250   output->isTransmission = false;
 251   output->expectControllerAck = false;
 252
 253   if ((bReturn = Write(output)) == false)
 254     CLibCEC::AddLog(CEC_LOG_ERROR, "could not start the bootloader");
 255   delete output;
 256
 257   return bReturn;
 258 }
 259
 260 bool CAdapterCommunication::PingAdapter(void)
 261 {
 262   bool bReturn(false);
 263   if (!IsRunning())
 264     return bReturn;
 265
 266   CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");
 267   CCECAdapterMessage *output = new CCECAdapterMessage;
 268
 269   output->PushBack(MSGSTART);
 270   output->PushEscaped(MSGCODE_PING);
 271   output->PushBack(MSGEND);
 272   output->isTransmission = false;
 273
 274   if ((bReturn = Write(output)) == false)
 275     CLibCEC::AddLog(CEC_LOG_ERROR, "could not ping the adapter");
 276   delete output;
 277
 278   return bReturn;
 279 }
 280
 281 uint16_t CAdapterCommunication::GetFirmwareVersion(void)
 282 {
 283   uint16_t iReturn(m_iFirmwareVersion);
 284   if (!IsRunning())
 285     return iReturn;
 286
 287   if (iReturn == CEC_FW_VERSION_UNKNOWN)
 288   {
 289     CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
 290     CCECAdapterMessage *output = new CCECAdapterMessage;
 291
 292     output->PushBack(MSGSTART);
 293     output->PushEscaped(MSGCODE_FIRMWARE_VERSION);
 294     output->PushBack(MSGEND);
 295     output->isTransmission = false;
 296     output->expectControllerAck = false;
 297
 298     SendMessageToAdapter(output);
 299     delete output;
 300
 301     CCECAdapterMessage input;
 302     if (!Read(input, CEC_DEFAULT_TRANSMIT_WAIT) || input.Message() != MSGCODE_FIRMWARE_VERSION || input.Size() != 3)
 303       CLibCEC::AddLog(CEC_LOG_ERROR, "no or invalid firmware version");
 304     else
 305     {
 306       m_iFirmwareVersion = (input[1] << 8 | input[2]);
 307       iReturn = m_iFirmwareVersion;
 308     }
 309   }
 310
 311   return iReturn;
 312 }
 313
 314 bool CAdapterCommunication::SetLineTimeout(uint8_t iTimeout)
 315 {
 316   bool bReturn(m_iLineTimeout != iTimeout);
 317
 318   if (!bReturn)
 319   {
 320     CCECAdapterMessage *output = new CCECAdapterMessage;
 321
 322     output->PushBack(MSGSTART);
 323     output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
 324     output->PushEscaped(iTimeout);
 325     output->PushBack(MSGEND);
 326     output->isTransmission = false;
 327
 328     if ((bReturn = Write(output)) == false)
 329       CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
 330     delete output;
 331   }
 332
 333   return bReturn;
 334 }
 335
 336 bool CAdapterCommunication::SetAckMask(uint16_t iMask)
 337 {
 338   bool bReturn(false);
 339   CStdString strLog;
 340   strLog.Format("setting ackmask to %2x", iMask);
 341   CLibCEC::AddLog(CEC_LOG_DEBUG, strLog.c_str());
 342
 343   CCECAdapterMessage *output = new CCECAdapterMessage;
 344
 345   output->PushBack(MSGSTART);
 346   output->PushEscaped(MSGCODE_SET_ACK_MASK);
 347   output->PushEscaped(iMask >> 8);
 348   output->PushEscaped((uint8_t)iMask);
 349   output->PushBack(MSGEND);
 350   output->isTransmission = false;
 351
 352   if ((bReturn = Write(output)) == false)
 353     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the ackmask");
 354   delete output;
 355
 356   return bReturn;
 357 }
 358
 359 bool CAdapterCommunication::IsOpen(void)
 360 {
 361   return !IsStopped() && m_port->IsOpen() && IsRunning();
 362 }
 363
 364 bool CAdapterCommunication::WaitForAck(CCECAdapterMessage &message)
 365 {
 366   bool bError(false);
 367   bool bTransmitSucceeded(false);
 368   uint8_t iPacketsLeft(message.Size() / 4);
 369
 370   int64_t iNow = GetTimeMs();
 371   int64_t iTargetTime = iNow + message.transmit_timeout;
 372
 373   while (!bTransmitSucceeded && !bError && (message.transmit_timeout == 0 || iNow < iTargetTime))
 374   {
 375     CCECAdapterMessage msg;
 376     int32_t iWait = (int32_t)(iTargetTime - iNow);
 377     if (iWait <= 5 || message.transmit_timeout <= 5)
 378       iWait = CEC_DEFAULT_TRANSMIT_WAIT;
 379
 380     if (!Read(msg, iWait))
 381     {
 382       iNow = GetTimeMs();
 383       continue;
 384     }
 385
 386     if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK())
 387     {
 388       m_processor->HandlePoll(msg.Initiator(), msg.Destination());
 389       iNow = GetTimeMs();
 390       continue;
 391     }
 392
 393     if (msg.Message() == MSGCODE_RECEIVE_FAILED &&
 394         m_processor->HandleReceiveFailed())
 395     {
 396       iNow = GetTimeMs();
 397       continue;
 398     }
 399
 400     bError = msg.IsError();
 401     if (bError)
 402     {
 403       message.reply = msg.Message();
 404       CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 405     }
 406     else
 407     {
 408       switch(msg.Message())
 409       {
 410       case MSGCODE_COMMAND_ACCEPTED:
 411         CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 412         if (iPacketsLeft > 0)
 413           iPacketsLeft--;
 414         if (!message.isTransmission && iPacketsLeft == 0)
 415           bTransmitSucceeded = true;
 416         break;
 417       case MSGCODE_TRANSMIT_SUCCEEDED:
 418         CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 419         bTransmitSucceeded = (iPacketsLeft == 0);
 420         bError = !bTransmitSucceeded;
 421         message.reply = MSGCODE_TRANSMIT_SUCCEEDED;
 422         break;
 423       default:
 424         // ignore other data while waiting
 425         break;
 426       }
 427
 428       iNow = GetTimeMs();
 429     }
 430   }
 431
 432   return bTransmitSucceeded && !bError;
 433 }
 434
 435 void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen)
 436 {
 437   CLockObject lock(m_mutex);
 438   for (uint8_t iPtr = 0; iPtr < iLen; iPtr++)
 439     m_inBuffer.Push(data[iPtr]);
 440
 441   m_rcvCondition.Signal();
 442 }
 443
 444 bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
 445 {
 446   int32_t iBytesRead;
 447   uint8_t buff[1024];
 448   if (!m_port)
 449     return false;
 450
 451   CLockObject lock(m_mutex);
 452   iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
 453   if (iBytesRead < 0 || iBytesRead > 256)
 454   {
 455     CStdString strError;
 456     strError.Format("error reading from serial port: %s", m_port->GetError().c_str());
 457     CLibCEC::AddLog(CEC_LOG_ERROR, strError);
 458     return false;
 459   }
 460   else if (iBytesRead > 0)
 461     AddData(buff, (uint8_t) iBytesRead);
 462
 463   return iBytesRead > 0;
 464 }
 465
 466 void CAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg)
 467 {
 468   CLockObject adapterLock(m_mutex);
 469   CLockObject lock(msg->mutex);
 470   if (m_port->Write(msg->packet.data, msg->Size()) != (int32_t) msg->Size())
 471   {
 472     CStdString strError;
 473     strError.Format("error writing to serial port: %s", m_port->GetError().c_str());
 474     CLibCEC::AddLog(CEC_LOG_ERROR, strError);
 475     msg->state = ADAPTER_MESSAGE_STATE_ERROR;
 476   }
 477   else
 478   {
 479     CLibCEC::AddLog(CEC_LOG_DEBUG, "command sent");
 480     msg->state = ADAPTER_MESSAGE_STATE_SENT;
 481   }
 482   msg->condition.Signal();
 483 }
 484
 485 void CAdapterCommunication::WriteNextCommand(void)
 486 {
 487   CCECAdapterMessage *msg(NULL);
 488   if (m_outBuffer.Pop(msg))
 489     SendMessageToAdapter(msg);
 490 }