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