src/lib/adapter/Pulse-Eight/USBCECAdapterMessageQueue.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 "env.h"
  34 #include "USBCECAdapterMessageQueue.h"
  35
  36 #include "USBCECAdapterCommunication.h"
  37 #include "USBCECAdapterMessage.h"
  38 #include "lib/platform/sockets/socket.h"
  39 #include "lib/LibCEC.h"
  40 #include "lib/platform/util/StdString.h"
  41
  42 using namespace CEC;
  43 using namespace PLATFORM;
  44 using namespace std;
  45
  46 #define MESSAGE_QUEUE_SIGNAL_WAIT_TIME 1000
  47
  48 CCECAdapterMessageQueueEntry::CCECAdapterMessageQueueEntry(CCECAdapterMessageQueue *queue, CCECAdapterMessage *message) :
  49     m_queue(queue),
  50     m_message(message),
  51     m_iPacketsLeft(message->IsTranmission() ? message->Size() / 4 : 1),
  52     m_bSucceeded(false),
  53     m_bWaiting(true) {}
  54
  55 CCECAdapterMessageQueueEntry::~CCECAdapterMessageQueueEntry(void) { }
  56
  57 void CCECAdapterMessageQueueEntry::Broadcast(void)
  58 {
  59   CLockObject lock(m_mutex);
  60   m_condition.Broadcast();
  61 }
  62
  63 bool CCECAdapterMessageQueueEntry::MessageReceived(const CCECAdapterMessage &message)
  64 {
  65   bool bHandled(false);
  66
  67   if (IsResponse(message))
  68   {
  69     switch (message.Message())
  70     {
  71     case MSGCODE_COMMAND_ACCEPTED:
  72       bHandled = MessageReceivedCommandAccepted(message);
  73       break;
  74     case MSGCODE_TRANSMIT_SUCCEEDED:
  75       bHandled = MessageReceivedTransmitSucceeded(message);
  76       break;
  77     default:
  78       bHandled = MessageReceivedResponse(message);
  79       break;
  80     }
  81   }
  82
  83   return bHandled;
  84 }
  85
  86 void CCECAdapterMessageQueueEntry::Signal(void)
  87 {
  88   CLockObject lock(m_mutex);
  89   m_bSucceeded = true;
  90   m_condition.Signal();
  91 }
  92
  93 bool CCECAdapterMessageQueueEntry::Wait(uint32_t iTimeout)
  94 {
  95   bool bReturn(false);
  96   /* wait until we receive a signal when the tranmission succeeded */
  97   {
  98     CLockObject lock(m_mutex);
  99     bReturn = m_bSucceeded ? true : m_condition.Wait(m_mutex, m_bSucceeded, iTimeout);
 100     m_bWaiting = false;
 101   }
 102   return bReturn;
 103 }
 104
 105 bool CCECAdapterMessageQueueEntry::IsWaiting(void)
 106 {
 107   CLockObject lock(m_mutex);
 108   return m_bWaiting;
 109 }
 110
 111 cec_adapter_messagecode CCECAdapterMessageQueueEntry::MessageCode(void)
 112 {
 113   return m_message->Message();
 114 }
 115
 116 bool CCECAdapterMessageQueueEntry::IsResponseOld(const CCECAdapterMessage &msg)
 117 {
 118   cec_adapter_messagecode msgCode = msg.Message();
 119
 120   return msgCode == MessageCode() ||
 121          msgCode == MSGCODE_COMMAND_ACCEPTED ||
 122          msgCode == MSGCODE_COMMAND_REJECTED ||
 123          (m_message->IsTranmission() && (msgCode == MSGCODE_TIMEOUT_ERROR ||
 124              msgCode == MSGCODE_HIGH_ERROR ||
 125              msgCode == MSGCODE_LOW_ERROR ||
 126              msgCode == MSGCODE_RECEIVE_FAILED ||
 127              msgCode == MSGCODE_TRANSMIT_FAILED_LINE ||
 128              msgCode == MSGCODE_TRANSMIT_FAILED_ACK ||
 129              msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
 130              msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE ||
 131              msgCode == MSGCODE_TRANSMIT_SUCCEEDED));
 132 }
 133
 134 bool CCECAdapterMessageQueueEntry::IsResponse(const CCECAdapterMessage &msg)
 135 {
 136   cec_adapter_messagecode thisMsgCode = m_message->Message();
 137   cec_adapter_messagecode msgCode = msg.Message();
 138   cec_adapter_messagecode msgResponse = msg.ResponseTo();
 139
 140   // msgcode matches, always a response
 141   if (msgCode == MessageCode())
 142     return true;
 143
 144   if (!ProvidesExtendedResponse())
 145     return IsResponseOld(msg);
 146
 147   // response without a msgcode
 148   if (msgResponse == MSGCODE_NOTHING)
 149   {
 150     m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_WARNING, "no response code received");
 151     return true;
 152   }
 153
 154   // commands that only repond with accepted/rejected
 155   if (thisMsgCode == MSGCODE_PING ||
 156       thisMsgCode == MSGCODE_SET_ACK_MASK ||
 157       thisMsgCode == MSGCODE_SET_CONTROLLED ||
 158       thisMsgCode == MSGCODE_SET_AUTO_ENABLED ||
 159       thisMsgCode == MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS ||
 160       thisMsgCode == MSGCODE_SET_LOGICAL_ADDRESS_MASK ||
 161       thisMsgCode == MSGCODE_SET_PHYSICAL_ADDRESS ||
 162       thisMsgCode == MSGCODE_SET_DEVICE_TYPE ||
 163       thisMsgCode == MSGCODE_SET_HDMI_VERSION ||
 164       thisMsgCode == MSGCODE_SET_OSD_NAME ||
 165       thisMsgCode == MSGCODE_WRITE_EEPROM ||
 166       thisMsgCode == MSGCODE_TRANSMIT_IDLETIME)
 167     return thisMsgCode == msgResponse;
 168
 169   if (!m_message->IsTranmission())
 170   {
 171     m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_WARNING, "FIXME! not a transmission");
 172     return false;
 173   }
 174
 175   return ((msgCode == MSGCODE_COMMAND_ACCEPTED || msgCode == MSGCODE_COMMAND_REJECTED) &&
 176       (msgResponse == MSGCODE_TRANSMIT_ACK_POLARITY || msgResponse == MSGCODE_TRANSMIT || msgResponse == MSGCODE_TRANSMIT_EOM)) ||
 177       msgCode == MSGCODE_TIMEOUT_ERROR ||
 178       msgCode == MSGCODE_HIGH_ERROR ||
 179       msgCode == MSGCODE_LOW_ERROR ||
 180       msgCode == MSGCODE_RECEIVE_FAILED ||
 181       msgCode == MSGCODE_TRANSMIT_FAILED_LINE ||
 182       msgCode == MSGCODE_TRANSMIT_FAILED_ACK ||
 183       msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
 184       msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE ||
 185       msgCode == MSGCODE_TRANSMIT_SUCCEEDED;
 186 }
 187
 188 const char *CCECAdapterMessageQueueEntry::ToString(void) const
 189 {
 190   /* CEC transmissions got the 'set ack polarity' msgcode, which doesn't look nice */
 191   if (m_message->IsTranmission())
 192     return "CEC transmission";
 193   else
 194     return CCECAdapterMessage::ToString(m_message->Message());
 195 }
 196
 197 bool CCECAdapterMessageQueueEntry::MessageReceivedCommandAccepted(const CCECAdapterMessage &message)
 198 {
 199   bool bSendSignal(false);
 200   bool bHandled(false);
 201   {
 202     CLockObject lock(m_mutex);
 203     if (m_iPacketsLeft > 0)
 204     {
 205       /* decrease by 1 */
 206       m_iPacketsLeft--;
 207
 208       /* log this message */
 209       CStdString strLog;
 210       strLog.Format("%s - command accepted", ToString());
 211       if (m_iPacketsLeft > 0)
 212         strLog.AppendFormat(" - waiting for %d more", m_iPacketsLeft);
 213       m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, strLog);
 214
 215       /* no more packets left and not a transmission, so we're done */
 216       if (!m_message->IsTranmission() && m_iPacketsLeft == 0)
 217       {
 218         m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED;
 219         m_message->response = message.packet;
 220         bSendSignal = true;
 221       }
 222       bHandled = true;
 223     }
 224   }
 225
 226   if (bSendSignal)
 227     Signal();
 228
 229   return bHandled;
 230 }
 231
 232 bool CCECAdapterMessageQueueEntry::MessageReceivedTransmitSucceeded(const CCECAdapterMessage &message)
 233 {
 234   {
 235     CLockObject lock(m_mutex);
 236     if (m_iPacketsLeft == 0)
 237     {
 238       /* transmission succeeded, so we're done */
 239       m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "%s - transmit succeeded", ToString());
 240       m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED;
 241       m_message->response = message.packet;
 242     }
 243     else
 244     {
 245       /* error, we expected more acks
 246          since the messages are processed in order, this should not happen, so this is an error situation */
 247       m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_WARNING, "%s - received 'transmit succeeded' but not enough 'command accepted' messages (%d left)", ToString(), m_iPacketsLeft);
 248       m_message->state = ADAPTER_MESSAGE_STATE_ERROR;
 249     }
 250   }
 251
 252   Signal();
 253
 254   return true;
 255 }
 256
 257 bool CCECAdapterMessageQueueEntry::MessageReceivedResponse(const CCECAdapterMessage &message)
 258 {
 259   {
 260     CLockObject lock(m_mutex);
 261     m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "%s - received response - %s", ToString(), message.ToString().c_str());
 262     m_message->response = message.packet;
 263     if (m_message->IsTranmission())
 264       m_message->state = message.Message() == MSGCODE_TRANSMIT_SUCCEEDED ? ADAPTER_MESSAGE_STATE_SENT_ACKED : ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
 265     else
 266       m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED;
 267   }
 268
 269   Signal();
 270
 271   return true;
 272 }
 273
 274 bool CCECAdapterMessageQueueEntry::ProvidesExtendedResponse(void)
 275 {
 276   return m_queue && m_queue->ProvidesExtendedResponse();
 277 }
 278
 279 CCECAdapterMessageQueue::CCECAdapterMessageQueue(CUSBCECAdapterCommunication *com) :
 280   PLATFORM::CThread(),
 281   m_com(com),
 282   m_iNextMessage(0)
 283 {
 284   m_incomingAdapterMessage = new CCECAdapterMessage;
 285   m_currentCECFrame.Clear();
 286 }
 287
 288 CCECAdapterMessageQueue::~CCECAdapterMessageQueue(void)
 289 {
 290   Clear();
 291   StopThread(0);
 292   delete m_incomingAdapterMessage;
 293 }
 294
 295 void CCECAdapterMessageQueue::Clear(void)
 296 {
 297   StopThread(5);
 298   CLockObject lock(m_mutex);
 299   m_writeQueue.Clear();
 300   m_messages.clear();
 301 }
 302
 303 void *CCECAdapterMessageQueue::Process(void)
 304 {
 305   CCECAdapterMessageQueueEntry *message(NULL);
 306   while (!IsStopped())
 307   {
 308     /* wait for a new message */
 309     if (m_writeQueue.Pop(message, MESSAGE_QUEUE_SIGNAL_WAIT_TIME) && message)
 310     {
 311       /* write this message */
 312       {
 313         CLockObject lock(m_mutex);
 314         m_com->WriteToDevice(message->m_message);
 315       }
 316       if (message->m_message->state == ADAPTER_MESSAGE_STATE_ERROR ||
 317           message->m_message->Message() == MSGCODE_START_BOOTLOADER)
 318       {
 319         message->Signal();
 320         Clear();
 321         break;
 322       }
 323     }
 324   }
 325   return NULL;
 326 }
 327
 328 void CCECAdapterMessageQueue::MessageReceived(const CCECAdapterMessage &msg)
 329 {
 330   bool bHandled(false);
 331   CLockObject lock(m_mutex);
 332   /* send the received message to each entry in the queue until it is handled */
 333   for (map<uint64_t, CCECAdapterMessageQueueEntry *>::iterator it = m_messages.begin(); !bHandled && it != m_messages.end(); it++)
 334     bHandled = it->second->MessageReceived(msg);
 335
 336   if (!bHandled)
 337   {
 338     /* the message wasn't handled */
 339     bool bIsError(m_com->HandlePoll(msg));
 340     m_com->m_callback->GetLib()->AddLog(bIsError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString().c_str());
 341
 342     /* push this message to the current frame */
 343     if (!bIsError && msg.PushToCecCommand(m_currentCECFrame))
 344     {
 345       /* and push the current frame back over the callback method when a full command was received */
 346       if (m_com->IsInitialised())
 347         m_com->m_callback->OnCommandReceived(m_currentCECFrame);
 348
 349       /* clear the current frame */
 350       m_currentCECFrame.Clear();
 351     }
 352   }
 353 }
 354
 355 void CCECAdapterMessageQueue::AddData(uint8_t *data, size_t iLen)
 356 {
 357   for (size_t iPtr = 0; iPtr < iLen; iPtr++)
 358   {
 359     bool bFullMessage(false);
 360     {
 361       CLockObject lock(m_mutex);
 362       bFullMessage = m_incomingAdapterMessage->PushReceivedByte(data[iPtr]);
 363     }
 364
 365     if (bFullMessage)
 366     {
 367       /* a full message was received */
 368       CCECAdapterMessage newMessage;
 369       newMessage.packet = m_incomingAdapterMessage->packet;
 370       MessageReceived(newMessage);
 371
 372       /* clear the current message */
 373       CLockObject lock(m_mutex);
 374       m_incomingAdapterMessage->Clear();
 375     }
 376   }
 377 }
 378
 379 bool CCECAdapterMessageQueue::Write(CCECAdapterMessage *msg)
 380 {
 381   msg->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT;
 382
 383   /* set the correct line timeout */
 384   if (msg->IsTranmission())
 385   {
 386     m_com->SetLineTimeout(msg->lineTimeout);
 387   }
 388
 389   CCECAdapterMessageQueueEntry *entry = new CCECAdapterMessageQueueEntry(this, msg);
 390   uint64_t iEntryId(0);
 391   /* add to the wait for ack queue */
 392   if (msg->Message() != MSGCODE_START_BOOTLOADER)
 393   {
 394     CLockObject lock(m_mutex);
 395     iEntryId = m_iNextMessage++;
 396     m_messages.insert(make_pair(iEntryId, entry));
 397   }
 398
 399   /* add the message to the write queue */
 400   m_writeQueue.Push(entry);
 401
 402   bool bReturn(true);
 403   if (entry)
 404   {
 405     if (!entry->Wait(msg->transmit_timeout <= 5 ? CEC_DEFAULT_TRANSMIT_WAIT : msg->transmit_timeout))
 406     {
 407       m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "command '%s' was not acked by the controller", CCECAdapterMessage::ToString(msg->Message()));
 408       msg->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
 409       bReturn = false;
 410     }
 411
 412     if (msg->Message() != MSGCODE_START_BOOTLOADER)
 413     {
 414       CLockObject lock(m_mutex);
 415       m_messages.erase(iEntryId);
 416     }
 417     delete entry;
 418   }
 419
 420   return bReturn;
 421 }
 422
 423 bool CCECAdapterMessageQueue::ProvidesExtendedResponse(void)
 424 {
 425   return m_com && m_com->ProvidesExtendedResponse();
 426 }