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