src/lib/adapter/USBCECAdapterCommunication.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 "USBCECAdapterCommunication.h"
  34 #include "../platform/sockets/serialport.h"
  35 #include "../platform/util/timeutils.h"
  36 #include "../LibCEC.h"
  37 #include "../CECProcessor.h"
  38
  39 using namespace std;
  40 using namespace CEC;
  41 using namespace PLATFORM;
  42
  43 #define CEC_ADAPTER_PING_TIMEOUT 15000
  44
  45 void *CUSBCECAdapterProcessor::Process(void)
  46 {
  47   cec_command command;
  48   while (!IsStopped())
  49   {
  50     if (m_inBuffer.Pop(command))
  51       m_callback->OnCommandReceived(command);
  52     Sleep(5);
  53   }
  54
  55   return NULL;
  56 }
  57
  58 void CUSBCECAdapterProcessor::AddCommand(cec_command command)
  59 {
  60   m_inBuffer.Push(command);
  61 }
  62
  63 CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(CCECProcessor *processor, const char *strPort, uint16_t iBaudRate /* = 38400 */) :
  64     m_port(NULL),
  65     m_processor(processor),
  66     m_bHasData(false),
  67     m_iLineTimeout(0),
  68     m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN),
  69     m_lastInitiator(CECDEVICE_UNKNOWN),
  70     m_bNextIsEscaped(false),
  71     m_bGotStart(false),
  72     m_messageProcessor(NULL),
  73     m_bInitialised(false)
  74 {
  75   m_port = new PLATFORM::CSerialPort(strPort, iBaudRate);
  76 }
  77
  78 CUSBCECAdapterCommunication::~CUSBCECAdapterCommunication(void)
  79 {
  80   Close();
  81 }
  82
  83 bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs /* = 10000 */)
  84 {
  85   bool bReturn(false);
  86   uint64_t iNow = GetTimeMs();
  87   uint64_t iTarget = iTimeoutMs > 0 ? iNow + iTimeoutMs : iNow + CEC_DEFAULT_TRANSMIT_WAIT;
  88
  89   /* try to ping the adapter */
  90   bool bPinged(false);
  91   unsigned iPingTry(0);
  92   while (iNow < iTarget && (bPinged = PingAdapter()) == false)
  93   {
  94     CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry);
  95     CEvent::Sleep(500);
  96     iNow = GetTimeMs();
  97   }
  98
  99   /* try to read the firmware version */
 100   m_iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
 101   unsigned iFwVersionTry(0);
 102   while (bPinged && iNow < iTarget && (m_iFirmwareVersion = GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN && iFwVersionTry < 3)
 103   {
 104     CLibCEC::AddLog(CEC_LOG_WARNING, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry);
 105     CEvent::Sleep(500);
 106     iNow = GetTimeMs();
 107   }
 108
 109   if (m_iFirmwareVersion == CEC_FW_VERSION_UNKNOWN)
 110   {
 111     CLibCEC::AddLog(CEC_LOG_DEBUG, "defaulting to firmware version 1");
 112     m_iFirmwareVersion = 1;
 113   }
 114
 115   if (m_iFirmwareVersion >= 2)
 116   {
 117     /* try to set controlled mode */
 118     unsigned iControlledTry(0);
 119     bool bControlled(false);
 120     while (iNow < iTarget && (bControlled = SetControlledMode(true)) == false)
 121     {
 122       CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry);
 123       CEvent::Sleep(500);
 124       iNow = GetTimeMs();
 125     }
 126     bReturn = bControlled;
 127   }
 128   else
 129     bReturn = true;
 130
 131   {
 132     CLockObject lock(m_mutex);
 133     m_bInitialised = bReturn;
 134   }
 135
 136   return bReturn;
 137 }
 138
 139 bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback *cb, uint32_t iTimeoutMs /* = 10000 */, bool bSkipChecks /* = false */)
 140 {
 141   uint64_t iNow = GetTimeMs();
 142   uint64_t iTimeout = iNow + iTimeoutMs;
 143
 144   {
 145     CLockObject lock(m_mutex);
 146
 147     if (!m_port)
 148     {
 149       CLibCEC::AddLog(CEC_LOG_ERROR, "port is NULL");
 150       return false;
 151     }
 152
 153     if (IsOpen())
 154     {
 155       CLibCEC::AddLog(CEC_LOG_ERROR, "port is already open");
 156       return true;
 157     }
 158
 159     m_callback = cb;
 160     CStdString strError;
 161     bool bConnected(false);
 162     while (!bConnected && iNow < iTimeout)
 163     {
 164       if ((bConnected = m_port->Open(iTimeout)) == false)
 165       {
 166         strError.Format("error opening serial port '%s': %s", m_port->GetName().c_str(), m_port->GetError().c_str());
 167         Sleep(250);
 168         iNow = GetTimeMs();
 169       }
 170     }
 171
 172     if (!bConnected)
 173     {
 174       CLibCEC::AddLog(CEC_LOG_ERROR, strError);
 175       return false;
 176     }
 177
 178     CLibCEC::AddLog(CEC_LOG_DEBUG, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
 179
 180     if (!bSkipChecks)
 181     {
 182       //clear any input bytes
 183       uint8_t buff[1024];
 184       while (m_port->Read(buff, 1024, 100) > 0)
 185       {
 186         CLibCEC::AddLog(CEC_LOG_DEBUG, "data received, clearing it");
 187         Sleep(250);
 188       }
 189     }
 190   }
 191
 192   if (!bSkipChecks && !CheckAdapter())
 193   {
 194     CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter failed to pass basic checks");
 195     return false;
 196   }
 197   else
 198   {
 199     if (CreateThread())
 200     {
 201       CLibCEC::AddLog(CEC_LOG_DEBUG, "communication thread started");
 202       return true;
 203     }
 204     else
 205     {
 206       CLibCEC::AddLog(CEC_LOG_ERROR, "could not create a communication thread");
 207     }
 208   }
 209
 210   return false;
 211 }
 212
 213 void CUSBCECAdapterCommunication::Close(void)
 214 {
 215   StopThread();
 216 }
 217
 218 void *CUSBCECAdapterCommunication::Process(void)
 219 {
 220   m_messageProcessor = new CUSBCECAdapterProcessor(m_callback);
 221   m_messageProcessor->CreateThread();
 222
 223   cec_command command;
 224   command.Clear();
 225   bool bCommandReceived(false);
 226   CTimeout pingTimeout(CEC_ADAPTER_PING_TIMEOUT);
 227   while (!IsStopped())
 228   {
 229     {
 230       CLockObject lock(m_mutex);
 231       ReadFromDevice(50);
 232       bCommandReceived = m_callback && Read(command, 0) && m_bInitialised;
 233     }
 234
 235     /* push the next command to the callback method if there is one */
 236     if (!IsStopped() && bCommandReceived)
 237       m_messageProcessor->AddCommand(command);
 238
 239     /* ping the adapter every 15 seconds */
 240     if (pingTimeout.TimeLeft() == 0)
 241     {
 242       pingTimeout.Init(CEC_ADAPTER_PING_TIMEOUT);
 243       PingAdapter();
 244     }
 245
 246     if (!IsStopped())
 247     {
 248       Sleep(5);
 249       WriteNextCommand();
 250     }
 251   }
 252
 253   /* stop the message processor */
 254   m_messageProcessor->StopThread();
 255   delete m_messageProcessor;
 256
 257   /* notify all threads that are waiting on messages to be sent */
 258   CCECAdapterMessage *msg(NULL);
 259   while (m_outBuffer.Pop(msg))
 260     msg->event.Broadcast();
 261
 262   /* set the ackmask to 0 before closing the connection */
 263   SetAckMaskInternal(0, true);
 264
 265   if (m_iFirmwareVersion >= 2)
 266     SetControlledMode(false);
 267
 268   if (m_port)
 269   {
 270     delete m_port;
 271     m_port = NULL;
 272   }
 273
 274   return NULL;
 275 }
 276
 277 cec_adapter_message_state CUSBCECAdapterCommunication::Write(const cec_command &data, uint8_t iMaxTries, uint8_t iLineTimeout /* = 3 */, uint8_t iRetryLineTimeout /* = 3 */)
 278 {
 279   cec_adapter_message_state retVal(ADAPTER_MESSAGE_STATE_UNKNOWN);
 280   if (!IsRunning())
 281     return retVal;
 282
 283   CCECAdapterMessage *output = new CCECAdapterMessage(data);
 284
 285   /* set the number of retries */
 286   if (data.opcode == CEC_OPCODE_NONE) //TODO
 287     output->maxTries = 1;
 288   else if (data.initiator != CECDEVICE_BROADCAST)
 289     output->maxTries = iMaxTries;
 290
 291   output->lineTimeout = iLineTimeout;
 292   output->retryTimeout = iRetryLineTimeout;
 293   output->tries = 0;
 294
 295   bool bRetry(true);
 296   while (bRetry && ++output->tries < output->maxTries)
 297   {
 298     bRetry = (!Write(output) || output->NeedsRetry()) && output->transmit_timeout > 0;
 299     if (bRetry)
 300       Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT);
 301   }
 302   retVal = output->state;
 303
 304   delete output;
 305   return retVal;
 306 }
 307
 308 bool CUSBCECAdapterCommunication::Write(CCECAdapterMessage *data)
 309 {
 310   data->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT;
 311   m_outBuffer.Push(data);
 312   data->event.Wait(5000);
 313
 314   if ((data->expectControllerAck && data->state != ADAPTER_MESSAGE_STATE_SENT_ACKED) ||
 315       (!data->expectControllerAck && data->state != ADAPTER_MESSAGE_STATE_SENT))
 316   {
 317     CLibCEC::AddLog(CEC_LOG_DEBUG, "command was not %s", data->state == ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED ? "acked" : "sent");
 318     return false;
 319   }
 320
 321   return true;
 322 }
 323
 324 bool CUSBCECAdapterCommunication::Read(cec_command &command, uint32_t iTimeout)
 325 {
 326   if (!IsRunning())
 327     return false;
 328
 329   CCECAdapterMessage msg;
 330   if (Read(msg, iTimeout))
 331   {
 332     if (ParseMessage(msg))
 333     {
 334       command = m_currentframe;
 335       m_currentframe.Clear();
 336       return true;
 337     }
 338   }
 339   return false;
 340 }
 341
 342 bool CUSBCECAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
 343 {
 344   CLockObject lock(m_mutex);
 345
 346   msg.Clear();
 347   CCECAdapterMessage *buf(NULL);
 348
 349   if (!m_inBuffer.Pop(buf))
 350   {
 351     if (iTimeout == 0 || !m_rcvCondition.Wait(m_mutex, m_bHasData, iTimeout))
 352       return false;
 353     m_inBuffer.Pop(buf);
 354     m_bHasData = !m_inBuffer.IsEmpty();
 355   }
 356
 357   if (buf)
 358   {
 359     msg.packet = buf->packet;
 360     msg.state = ADAPTER_MESSAGE_STATE_INCOMING;
 361     delete buf;
 362     return true;
 363   }
 364   return false;
 365 }
 366
 367 CStdString CUSBCECAdapterCommunication::GetError(void) const
 368 {
 369   CStdString strError;
 370   strError = m_port->GetError();
 371   return strError;
 372 }
 373
 374 bool CUSBCECAdapterCommunication::StartBootloader(void)
 375 {
 376   bool bReturn(false);
 377   if (!IsRunning())
 378     return bReturn;
 379
 380   CLibCEC::AddLog(CEC_LOG_DEBUG, "starting the bootloader");
 381   CCECAdapterMessage *output = new CCECAdapterMessage;
 382
 383   output->PushBack(MSGSTART);
 384   output->PushEscaped(MSGCODE_START_BOOTLOADER);
 385   output->PushBack(MSGEND);
 386   output->isTransmission = false;
 387   output->expectControllerAck = false;
 388
 389   if ((bReturn = Write(output)) == false)
 390     CLibCEC::AddLog(CEC_LOG_ERROR, "could not start the bootloader");
 391   delete output;
 392
 393   return bReturn;
 394 }
 395
 396 bool CUSBCECAdapterCommunication::PingAdapter(void)
 397 {
 398   CLockObject lock(m_mutex);
 399   CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");
 400
 401   CCECAdapterMessage *output = new CCECAdapterMessage;
 402
 403   output->PushBack(MSGSTART);
 404   output->PushEscaped(MSGCODE_PING);
 405   output->PushBack(MSGEND);
 406   output->isTransmission = false;
 407
 408   SendMessageToAdapter(output);
 409   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 410   delete output;
 411   if (!bWriteOk)
 412   {
 413     CLibCEC::AddLog(CEC_LOG_ERROR, "could not ping the adapter");
 414     return false;
 415   }
 416
 417   return true;
 418 }
 419
 420 bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage &msg)
 421 {
 422   bool bEom(false);
 423   bool bIsError(msg.IsError());
 424
 425   if (msg.IsEmpty())
 426     return bEom;
 427
 428   CLockObject adapterLock(m_mutex);
 429   switch(msg.Message())
 430   {
 431   case MSGCODE_FRAME_START:
 432     {
 433       m_currentframe.Clear();
 434       if (msg.Size() >= 2)
 435       {
 436         m_currentframe.initiator   = msg.Initiator();
 437         m_currentframe.destination = msg.Destination();
 438         m_currentframe.ack         = msg.IsACK();
 439         m_currentframe.eom         = msg.IsEOM();
 440       }
 441       if (m_currentframe.ack == 0x1)
 442       {
 443         m_lastInitiator = m_currentframe.initiator;
 444         m_processor->HandlePoll(m_currentframe.initiator, m_currentframe.destination);
 445       }
 446     }
 447     break;
 448   case MSGCODE_RECEIVE_FAILED:
 449     {
 450       m_currentframe.Clear();
 451       if (m_lastInitiator != CECDEVICE_UNKNOWN)
 452         bIsError = m_processor->HandleReceiveFailed(m_lastInitiator);
 453     }
 454     break;
 455   case MSGCODE_FRAME_DATA:
 456     {
 457       if (msg.Size() >= 2)
 458       {
 459         m_currentframe.PushBack(msg[1]);
 460         m_currentframe.eom = msg.IsEOM();
 461       }
 462     }
 463     break;
 464   default:
 465     break;
 466   }
 467
 468   CLibCEC::AddLog(bIsError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
 469   return msg.IsEOM();
 470 }
 471
 472 uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
 473 {
 474   uint16_t iReturn(m_iFirmwareVersion);
 475
 476   if (iReturn == CEC_FW_VERSION_UNKNOWN)
 477   {
 478     CLockObject lock(m_mutex);
 479     CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
 480     CCECAdapterMessage *output = new CCECAdapterMessage;
 481
 482     output->PushBack(MSGSTART);
 483     output->PushEscaped(MSGCODE_FIRMWARE_VERSION);
 484     output->PushBack(MSGEND);
 485     output->isTransmission = false;
 486     output->expectControllerAck = false;
 487
 488     SendMessageToAdapter(output);
 489     bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT;
 490     delete output;
 491     if (!bWriteOk)
 492     {
 493       CLibCEC::AddLog(CEC_LOG_ERROR, "could not request the firmware version");
 494       return iReturn;
 495     }
 496
 497     Sleep(250); // TODO ReadFromDevice() isn't waiting for the timeout to pass on win32
 498     ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT, 5 /* start + msgcode + 2 bytes for fw version + end */);
 499     CCECAdapterMessage input;
 500     if (Read(input, 0))
 501     {
 502       if (input.Message() != MSGCODE_FIRMWARE_VERSION || input.Size() != 3)
 503         CLibCEC::AddLog(CEC_LOG_ERROR, "invalid firmware version (size = %d, message = %d)", input.Size(), input.Message());
 504       else
 505       {
 506         m_iFirmwareVersion = (input[1] << 8 | input[2]);
 507         iReturn = m_iFirmwareVersion;
 508       }
 509     }
 510     else
 511     {
 512       CLibCEC::AddLog(CEC_LOG_ERROR, "no firmware version received");
 513     }
 514   }
 515
 516   return iReturn;
 517 }
 518
 519 bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout)
 520 {
 521   m_iLineTimeout = iTimeout;
 522   return true;
 523   //TODO
 524 //  bool bReturn(m_iLineTimeout != iTimeout);
 525 //
 526 //  if (!bReturn)
 527 //  {
 528 //    CCECAdapterMessage *output = new CCECAdapterMessage;
 529 //
 530 //    output->PushBack(MSGSTART);
 531 //    output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
 532 //    output->PushEscaped(iTimeout);
 533 //    output->PushBack(MSGEND);
 534 //    output->isTransmission = false;
 535 //
 536 //    if ((bReturn = Write(output)) == false)
 537 //      CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
 538 //    delete output;
 539 //  }
 540 //
 541 //  return bReturn;
 542 }
 543
 544 bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask)
 545 {
 546   return SetAckMaskInternal(iMask, false);
 547 }
 548
 549 bool CUSBCECAdapterCommunication::SetAckMaskInternal(uint16_t iMask, bool bWriteDirectly /* = false */)
 550 {
 551   bool bReturn(false);
 552   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting ackmask to %2x", iMask);
 553
 554   CCECAdapterMessage *output = new CCECAdapterMessage;
 555
 556   output->PushBack(MSGSTART);
 557   output->PushEscaped(MSGCODE_SET_ACK_MASK);
 558   output->PushEscaped(iMask >> 8);
 559   output->PushEscaped((uint8_t)iMask);
 560   output->PushBack(MSGEND);
 561   output->isTransmission = false;
 562
 563   if (bWriteDirectly)
 564     SendMessageToAdapter(output);
 565   else if ((bReturn = Write(output)) == false)
 566     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the ackmask");
 567   delete output;
 568
 569   return bReturn;
 570 }
 571
 572 bool CUSBCECAdapterCommunication::PersistConfiguration(libcec_configuration *configuration)
 573 {
 574   return SetAutoEnabled(true) &&
 575       SetDefaultLogicalAddress(configuration->logicalAddresses.primary) &&
 576       SetLogicalAddressMask(configuration->logicalAddresses.AckMask()) &&
 577       SetPhysicalAddress(configuration->iPhysicalAddress) &&
 578       SetCECVersion(CEC_VERSION_1_3A) &&
 579       SetOSDName(configuration->strDeviceName) &&
 580       WriteEEPROM();
 581 }
 582
 583 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
 584 {
 585   CLockObject lock(m_mutex);
 586   CLibCEC::AddLog(CEC_LOG_DEBUG, "turning controlled mode %s", controlled ? "on" : "off");
 587
 588   CCECAdapterMessage *output = new CCECAdapterMessage;
 589
 590   output->PushBack(MSGSTART);
 591   output->PushEscaped(MSGCODE_SET_CONTROLLED);
 592   output->PushEscaped(controlled);
 593   output->PushBack(MSGEND);
 594   output->isTransmission = false;
 595
 596   SendMessageToAdapter(output);
 597   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 598   delete output;
 599   if (!bWriteOk)
 600   {
 601     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set controlled mode");
 602     return false;
 603   }
 604
 605   return true;
 606 }
 607
 608 bool CUSBCECAdapterCommunication::SetAutoEnabled(bool enabled)
 609 {
 610   CLockObject lock(m_mutex);
 611   CLibCEC::AddLog(CEC_LOG_DEBUG, "turning autonomous mode %s", enabled ? "on" : "off");
 612
 613   CCECAdapterMessage *output = new CCECAdapterMessage;
 614
 615   output->PushBack(MSGSTART);
 616   output->PushEscaped(MSGCODE_SET_AUTO_ENABLED);
 617   output->PushEscaped(enabled);
 618   output->PushBack(MSGEND);
 619   output->isTransmission = false;
 620
 621   SendMessageToAdapter(output);
 622   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 623   delete output;
 624   if (!bWriteOk)
 625   {
 626     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set autonomous mode");
 627     return false;
 628   }
 629
 630   return true;
 631 }
 632
 633 bool CUSBCECAdapterCommunication::SetDefaultLogicalAddress(cec_logical_address address)
 634 {
 635   CLockObject lock(m_mutex);
 636   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the default logical address to %1X", address);
 637
 638   CCECAdapterMessage *output = new CCECAdapterMessage;
 639
 640   output->PushBack(MSGSTART);
 641   output->PushEscaped(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS);
 642   output->PushEscaped((uint8_t) address);
 643   output->PushBack(MSGEND);
 644   output->isTransmission = false;
 645
 646   SendMessageToAdapter(output);
 647   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 648   delete output;
 649   if (!bWriteOk)
 650   {
 651     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the default logical address");
 652     return false;
 653   }
 654
 655   return true;
 656 }
 657
 658 bool CUSBCECAdapterCommunication::SetLogicalAddressMask(uint16_t iMask)
 659 {
 660   CLockObject lock(m_mutex);
 661   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the logical address mask to %2X", iMask);
 662
 663   CCECAdapterMessage *output = new CCECAdapterMessage;
 664
 665   output->PushBack(MSGSTART);
 666   output->PushEscaped(MSGCODE_SET_LOGICAL_ADDRESS_MASK);
 667   output->PushEscaped(iMask >> 8);
 668   output->PushEscaped((uint8_t)iMask);
 669   output->PushBack(MSGEND);
 670   output->isTransmission = false;
 671
 672   SendMessageToAdapter(output);
 673   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 674   delete output;
 675   if (!bWriteOk)
 676   {
 677     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the logical address mask");
 678     return false;
 679   }
 680
 681   return true;
 682 }
 683
 684 bool CUSBCECAdapterCommunication::SetPhysicalAddress(uint16_t iPhysicalAddress)
 685 {
 686   CLockObject lock(m_mutex);
 687   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the physical address to %2X", iPhysicalAddress);
 688
 689   CCECAdapterMessage *output = new CCECAdapterMessage;
 690
 691   output->PushBack(MSGSTART);
 692   output->PushEscaped(MSGCODE_SET_PHYSICAL_ADDRESS);
 693   output->PushEscaped(iPhysicalAddress >> 8);
 694   output->PushEscaped((uint8_t)iPhysicalAddress);
 695   output->PushBack(MSGEND);
 696   output->isTransmission = false;
 697
 698   SendMessageToAdapter(output);
 699   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 700   delete output;
 701   if (!bWriteOk)
 702   {
 703     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the physical address");
 704     return false;
 705   }
 706
 707   return true;
 708 }
 709
 710 bool CUSBCECAdapterCommunication::SetCECVersion(cec_version version)
 711 {
 712   CLockObject lock(m_mutex);
 713   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the CEC version to %s", CLibCEC::GetInstance()->ToString(version));
 714
 715   CCECAdapterMessage *output = new CCECAdapterMessage;
 716
 717   output->PushBack(MSGSTART);
 718   output->PushEscaped(MSGCODE_SET_HDMI_VERSION);
 719   output->PushEscaped((uint8_t)version);
 720   output->PushBack(MSGEND);
 721   output->isTransmission = false;
 722
 723   SendMessageToAdapter(output);
 724   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 725   delete output;
 726   if (!bWriteOk)
 727   {
 728     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the CEC version");
 729     return false;
 730   }
 731
 732   return true;
 733 }
 734
 735 bool CUSBCECAdapterCommunication::SetOSDName(const char *strOSDName)
 736 {
 737   CLockObject lock(m_mutex);
 738   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the OSD name to %s", strOSDName);
 739
 740   CCECAdapterMessage *output = new CCECAdapterMessage;
 741
 742   output->PushBack(MSGSTART);
 743   output->PushEscaped(MSGCODE_SET_OSD_NAME);
 744   for (size_t iPtr = 0; iPtr < strlen(strOSDName); iPtr++)
 745     output->PushEscaped(strOSDName[iPtr]);
 746   output->PushBack(MSGEND);
 747   output->isTransmission = false;
 748
 749   SendMessageToAdapter(output);
 750   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 751   delete output;
 752   if (!bWriteOk)
 753   {
 754     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the OSD name");
 755     return false;
 756   }
 757
 758   return true;
 759 }
 760
 761 bool CUSBCECAdapterCommunication::WriteEEPROM(void)
 762 {
 763   CLockObject lock(m_mutex);
 764   CLibCEC::AddLog(CEC_LOG_DEBUG, "writing settings in the EEPROM");
 765
 766   CCECAdapterMessage *output = new CCECAdapterMessage;
 767
 768   output->PushBack(MSGSTART);
 769   output->PushEscaped(MSGCODE_WRITE_EEPROM);
 770   output->PushBack(MSGEND);
 771   output->isTransmission = false;
 772
 773   SendMessageToAdapter(output);
 774   bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
 775   delete output;
 776   if (!bWriteOk)
 777   {
 778     CLibCEC::AddLog(CEC_LOG_ERROR, "could not write the settings in the EEPROM");
 779     return false;
 780   }
 781
 782   return true;
 783 }
 784
 785 bool CUSBCECAdapterCommunication::IsOpen(void)
 786 {
 787   return !IsStopped() && m_port->IsOpen() && IsRunning();
 788 }
 789
 790 bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage &message)
 791 {
 792   bool bError(false);
 793   bool bTransmitSucceeded(false);
 794   uint8_t iPacketsLeft(message.Size() / 4);
 795
 796   int64_t iNow = GetTimeMs();
 797   int64_t iTargetTime = iNow + (message.transmit_timeout <= 5 ? CEC_DEFAULT_TRANSMIT_WAIT : message.transmit_timeout);
 798
 799   while (!bTransmitSucceeded && !bError && iNow < iTargetTime)
 800   {
 801     ReadFromDevice(50);
 802     CCECAdapterMessage msg;
 803     if (!Read(msg, 0))
 804     {
 805       iNow = GetTimeMs();
 806       continue;
 807     }
 808
 809     if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK())
 810     {
 811       m_processor->HandlePoll(msg.Initiator(), msg.Destination());
 812       m_lastInitiator = msg.Initiator();
 813       iNow = GetTimeMs();
 814       continue;
 815     }
 816
 817     if (msg.Message() == MSGCODE_RECEIVE_FAILED &&
 818         m_lastInitiator != CECDEVICE_UNKNOWN &&
 819         m_processor->HandleReceiveFailed(m_lastInitiator))
 820     {
 821       iNow = GetTimeMs();
 822       continue;
 823     }
 824
 825     bError = msg.IsError();
 826     if (bError)
 827     {
 828       message.reply = msg.Message();
 829       CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 830     }
 831     else
 832     {
 833       switch(msg.Message())
 834       {
 835       case MSGCODE_COMMAND_ACCEPTED:
 836         if (iPacketsLeft > 0)
 837           iPacketsLeft--;
 838         if (!message.isTransmission && iPacketsLeft == 0)
 839           bTransmitSucceeded = true;
 840         CLibCEC::AddLog(CEC_LOG_DEBUG, "%s - waiting for %d more", msg.ToString().c_str(), iPacketsLeft);
 841         break;
 842       case MSGCODE_TRANSMIT_SUCCEEDED:
 843         CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
 844         bTransmitSucceeded = (iPacketsLeft == 0);
 845         bError = !bTransmitSucceeded;
 846         message.reply = MSGCODE_TRANSMIT_SUCCEEDED;
 847         break;
 848       default:
 849         // ignore other data while waiting
 850         break;
 851       }
 852
 853       iNow = GetTimeMs();
 854     }
 855   }
 856
 857   message.state = bTransmitSucceeded && !bError ?
 858       ADAPTER_MESSAGE_STATE_SENT_ACKED :
 859       ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
 860
 861   return bTransmitSucceeded && !bError;
 862 }
 863
 864 void CUSBCECAdapterCommunication::AddData(uint8_t *data, size_t iLen)
 865 {
 866   CLockObject lock(m_mutex);
 867   for (size_t iPtr = 0; iPtr < iLen; iPtr++)
 868   {
 869     if (!m_bGotStart)
 870     {
 871       if (data[iPtr] == MSGSTART)
 872         m_bGotStart = true;
 873     }
 874     else if (data[iPtr] == MSGSTART) //we found a msgstart before msgend, this is not right, remove
 875     {
 876       if (m_currentAdapterMessage.Size() > 0)
 877         CLibCEC::AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents");
 878       m_currentAdapterMessage.Clear();
 879       m_bGotStart = true;
 880     }
 881     else if (data[iPtr] == MSGEND)
 882     {
 883       CCECAdapterMessage *newMessage = new CCECAdapterMessage;
 884       newMessage->packet = m_currentAdapterMessage.packet;
 885       m_inBuffer.Push(newMessage);
 886       m_currentAdapterMessage.Clear();
 887       m_bGotStart = false;
 888       m_bNextIsEscaped = false;
 889       m_bHasData = true;
 890       m_rcvCondition.Broadcast();
 891     }
 892     else if (m_bNextIsEscaped)
 893     {
 894       m_currentAdapterMessage.PushBack(data[iPtr] + (uint8_t)ESCOFFSET);
 895       m_bNextIsEscaped = false;
 896     }
 897     else if (data[iPtr] == MSGESC)
 898     {
 899       m_bNextIsEscaped = true;
 900     }
 901     else
 902     {
 903       m_currentAdapterMessage.PushBack(data[iPtr]);
 904     }
 905   }
 906 }
 907
 908 bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout, size_t iSize /* = 256 */)
 909 {
 910   ssize_t iBytesRead;
 911   uint8_t buff[256];
 912   if (!m_port)
 913     return false;
 914   if (iSize > 256)
 915     iSize = 256;
 916
 917   CLockObject lock(m_mutex);
 918   iBytesRead = m_port->Read(buff, sizeof(uint8_t) * iSize, iTimeout);
 919   if (iBytesRead < 0 || iBytesRead > 256)
 920   {
 921     CLibCEC::AddLog(CEC_LOG_ERROR, "error reading from serial port: %s", m_port->GetError().c_str());
 922     StopThread(false);
 923     return false;
 924   }
 925   else if (iBytesRead > 0)
 926   {
 927     AddData(buff, iBytesRead);
 928   }
 929
 930   return iBytesRead > 0;
 931 }
 932
 933 void CUSBCECAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg)
 934 {
 935   CLockObject adapterLock(m_mutex);
 936   if (!m_port->IsOpen())
 937   {
 938     CLibCEC::AddLog(CEC_LOG_ERROR, "error writing to serial port: the connection is closed");
 939     msg->state = ADAPTER_MESSAGE_STATE_ERROR;
 940     return;
 941   }
 942
 943   if (msg->tries == 1)
 944     SetLineTimeout(msg->lineTimeout);
 945   else
 946     SetLineTimeout(msg->retryTimeout);
 947
 948   if (m_port->Write(msg->packet.data, msg->Size()) != (ssize_t) msg->Size())
 949   {
 950     CLibCEC::AddLog(CEC_LOG_ERROR, "error writing to serial port: %s", m_port->GetError().c_str());
 951     msg->state = ADAPTER_MESSAGE_STATE_ERROR;
 952   }
 953   else
 954   {
 955     CLibCEC::AddLog(CEC_LOG_DEBUG, "command sent");
 956     msg->state = ADAPTER_MESSAGE_STATE_SENT;
 957
 958     if (msg->expectControllerAck)
 959     {
 960       if (!WaitForAck(*msg))
 961         CLibCEC::AddLog(CEC_LOG_DEBUG, "did not receive ack");
 962     }
 963   }
 964   msg->event.Signal();
 965 }
 966
 967 void CUSBCECAdapterCommunication::WriteNextCommand(void)
 968 {
 969   CCECAdapterMessage *msg(NULL);
 970   if (m_outBuffer.Pop(msg))
 971     SendMessageToAdapter(msg);
 972 }
 973
 974 CStdString CUSBCECAdapterCommunication::GetPortName(void)
 975 {
 976   CStdString strName;
 977   strName = m_port->GetName();
 978   return strName;
 979 }