cec: handle bus scan from LG TVs
[deb_libcec.git] / src / lib / AdapterCommunication.cpp
index 3a403068811a0dfee97d077bbf62f70f057f735a..32ceeafc02e5835be628af9a2d8e140056c838b0 100644 (file)
 #include "LibCEC.h"
 #include "platform/serialport.h"
 #include "util/StdString.h"
+#include "platform/timeutils.h"
 
 using namespace std;
 using namespace CEC;
 
+CCECAdapterMessage::CCECAdapterMessage(const cec_command &command)
+{
+  clear();
+
+  //set ack polarity to high when transmitting to the broadcast address
+  //set ack polarity low when transmitting to any other address
+  push_back(MSGSTART);
+  push_escaped(MSGCODE_TRANSMIT_ACK_POLARITY);
+  if (command.destination == CECDEVICE_BROADCAST)
+    push_escaped(CEC_TRUE);
+  else
+    push_escaped(CEC_FALSE);
+  push_back(MSGEND);
+
+  // add source and destination
+  push_back(MSGSTART);
+  push_escaped(command.opcode_set == 0 ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
+  push_back(((uint8_t)command.initiator << 4) + (uint8_t)command.destination);
+  push_back(MSGEND);
+
+  // add opcode
+  if (command.opcode_set == 1)
+  {
+    push_back(MSGSTART);
+    push_escaped(command.parameters.IsEmpty() ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
+    push_back((uint8_t) command.opcode);
+    push_back(MSGEND);
+
+    // add parameters
+    for (int8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
+    {
+      push_back(MSGSTART);
+
+      if (iPtr == command.parameters.size - 1)
+        push_escaped( MSGCODE_TRANSMIT_EOM);
+      else
+        push_escaped(MSGCODE_TRANSMIT);
+
+      push_escaped(command.parameters[iPtr]);
+
+      push_back(MSGEND);
+    }
+  }
+
+  // set timeout
+  transmit_timeout = command.transmit_timeout;
+}
+
+CCECAdapterMessage &CCECAdapterMessage::operator =(const CCECAdapterMessage &msg)
+{
+  packet = msg.packet;
+  state  = msg.state;
+  return *this;
+}
+
+CStdString CCECAdapterMessage::MessageCodeAsString(void) const
+{
+  CStdString strMsg;
+  switch (message())
+  {
+  case MSGCODE_NOTHING:
+    strMsg = "NOTHING";
+    break;
+  case MSGCODE_PING:
+    strMsg = "PING";
+    break;
+  case MSGCODE_TIMEOUT_ERROR:
+    strMsg = "TIMEOUT";
+    break;
+  case MSGCODE_HIGH_ERROR:
+    strMsg = "HIGH_ERROR";
+    break;
+  case MSGCODE_LOW_ERROR:
+    strMsg = "LOW_ERROR";
+    break;
+  case MSGCODE_FRAME_START:
+    strMsg = "FRAME_START";
+    break;
+  case MSGCODE_FRAME_DATA:
+    strMsg = "FRAME_DATA";
+    break;
+  case MSGCODE_RECEIVE_FAILED:
+    strMsg = "RECEIVE_FAILED";
+    break;
+  case MSGCODE_COMMAND_ACCEPTED:
+    strMsg = "COMMAND_ACCEPTED";
+    break;
+  case MSGCODE_COMMAND_REJECTED:
+    strMsg = "COMMAND_REJECTED";
+    break;
+  case MSGCODE_SET_ACK_MASK:
+    strMsg = "SET_ACK_MASK";
+    break;
+  case MSGCODE_TRANSMIT:
+    strMsg = "TRANSMIT";
+    break;
+  case MSGCODE_TRANSMIT_EOM:
+    strMsg = "TRANSMIT_EOM";
+    break;
+  case MSGCODE_TRANSMIT_IDLETIME:
+    strMsg = "TRANSMIT_IDLETIME";
+    break;
+  case MSGCODE_TRANSMIT_ACK_POLARITY:
+    strMsg = "TRANSMIT_ACK_POLARITY";
+    break;
+  case MSGCODE_TRANSMIT_LINE_TIMEOUT:
+    strMsg = "TRANSMIT_LINE_TIMEOUT";
+    break;
+  case MSGCODE_TRANSMIT_SUCCEEDED:
+    strMsg = "TRANSMIT_SUCCEEDED";
+    break;
+  case MSGCODE_TRANSMIT_FAILED_LINE:
+    strMsg = "TRANSMIT_FAILED_LINE";
+    break;
+  case MSGCODE_TRANSMIT_FAILED_ACK:
+    strMsg = "TRANSMIT_FAILED_ACK";
+    break;
+  case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
+    strMsg = "TRANSMIT_FAILED_TIMEOUT_DATA";
+    break;
+  case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
+    strMsg = "TRANSMIT_FAILED_TIMEOUT_LINE";
+    break;
+  case MSGCODE_FIRMWARE_VERSION:
+    strMsg = "FIRMWARE_VERSION";
+    break;
+  case MSGCODE_START_BOOTLOADER:
+    strMsg = "START_BOOTLOADER";
+    break;
+  case MSGCODE_FRAME_EOM:
+    strMsg = "FRAME_EOM";
+    break;
+  case MSGCODE_FRAME_ACK:
+    strMsg = "FRAME_ACK";
+    break;
+  }
+
+  return strMsg;
+}
+
+CStdString CCECAdapterMessage::ToString(void) const
+{
+  CStdString strMsg;
+  strMsg = MessageCodeAsString();
+
+  switch (message())
+  {
+  case MSGCODE_TIMEOUT_ERROR:
+  case MSGCODE_HIGH_ERROR:
+  case MSGCODE_LOW_ERROR:
+    {
+      int iLine      = (size() >= 3) ? (at(1) << 8) | at(2) : 0;
+      uint32_t iTime = (size() >= 7) ? (at(3) << 24) | (at(4) << 16) | (at(5) << 8) | at(6) : 0;
+      strMsg.AppendFormat(" line:%i", iLine);
+      strMsg.AppendFormat(" time:%u", iTime);
+    }
+    break;
+  case MSGCODE_FRAME_START:
+    if (size() >= 2)
+      strMsg.AppendFormat(" initiator:%1x destination:%1x ack:%s %s", initiator(), destination(), ack() ? "high" : "low", eom() ? "eom" : "");
+    break;
+  case MSGCODE_FRAME_DATA:
+    if (size() >= 2)
+      strMsg.AppendFormat(" %02x %s", at(1), eom() ? "eom" : "");
+    break;
+  default:
+    break;
+  }
+
+  return strMsg;
+}
+
+bool CCECAdapterMessage::is_error(void) const
+{
+  cec_adapter_messagecode code = message();
+  return (code == MSGCODE_HIGH_ERROR ||
+    code == MSGCODE_LOW_ERROR ||
+    code == MSGCODE_RECEIVE_FAILED ||
+    code == MSGCODE_COMMAND_REJECTED ||
+    code ==  MSGCODE_TRANSMIT_LINE_TIMEOUT ||
+    code == MSGCODE_TRANSMIT_FAILED_LINE ||
+    code ==  MSGCODE_TRANSMIT_FAILED_ACK ||
+    code == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
+    code == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE);
+}
+
+void CCECAdapterMessage::push_escaped(uint8_t byte)
+{
+  if (byte >= MSGESC)
+  {
+    push_back(MSGESC);
+    push_back(byte - ESCOFFSET);
+  }
+  else
+    push_back(byte);
+}
+
 CAdapterCommunication::CAdapterCommunication(CLibCEC *controller) :
-    m_controller(controller),
-    m_inbuf(NULL),
-    m_iInbufSize(0),
-    m_iInbufUsed(0),
-    m_bStarted(false),
-    m_bStop(false)
+    m_port(NULL),
+    m_controller(controller)
 {
   m_port = new CSerialPort;
 }
 
 CAdapterCommunication::~CAdapterCommunication(void)
 {
-  m_port->Close();
-  m_port = NULL;
+  Close();
+
+  if (m_port)
+  {
+    delete m_port;
+    m_port = NULL;
+  }
 }
 
-bool CAdapterCommunication::Open(const char *strPort, int iBaudRate /* = 38400 */, int iTimeoutMs /* = 10000 */)
+bool CAdapterCommunication::Open(const char *strPort, uint16_t iBaudRate /* = 38400 */, uint32_t iTimeoutMs /* = 10000 */)
 {
-  CLockObject lock(&m_commMutex);
-  if (m_bStarted)
+  CLockObject lock(&m_mutex);
+  if (!m_port)
+  {
+    m_controller->AddLog(CEC_LOG_ERROR, "port is NULL");
     return false;
+  }
+
+  if (IsOpen())
+  {
+    m_controller->AddLog(CEC_LOG_ERROR, "port is already open");
+  }
 
   if (!m_port->Open(strPort, iBaudRate))
   {
@@ -74,21 +281,17 @@ bool CAdapterCommunication::Open(const char *strPort, int iBaudRate /* = 38400 *
 
   //clear any input bytes
   uint8_t buff[1024];
-  m_port->Read(buff, sizeof(buff), 50);
-
-  CCondition::Sleep(CEC_SETTLE_DOWN_TIME);
-
-  m_bStop = false;
-  m_bStarted = true;
+  while (m_port->Read(buff, sizeof(buff), 500) > 0) {}
 
   if (CreateThread())
   {
-    m_controller->AddLog(CEC_LOG_DEBUG, "reader thread created");
+    m_startCondition.Wait(&m_mutex);
+    m_controller->AddLog(CEC_LOG_DEBUG, "communication thread started");
     return true;
   }
   else
   {
-    m_controller->AddLog(CEC_LOG_DEBUG, "could not create a reader thread");
+    m_controller->AddLog(CEC_LOG_DEBUG, "could not create a communication thread");
   }
 
   return false;
@@ -96,38 +299,38 @@ bool CAdapterCommunication::Open(const char *strPort, int iBaudRate /* = 38400 *
 
 void CAdapterCommunication::Close(void)
 {
+  CLockObject lock(&m_mutex);
+  m_startCondition.Broadcast();
+  m_rcvCondition.Broadcast();
   StopThread();
-  m_port->Close();
 }
 
 void *CAdapterCommunication::Process(void)
 {
-  while (!m_bStop)
   {
-    if (!ReadFromDevice(250))
-    {
-      m_bStarted = false;
-      break;
-    }
-
-    if (!m_bStop)
-      CCondition::Sleep(50);
+    CLockObject lock(&m_mutex);
+    m_startCondition.Signal();
   }
 
-  m_controller->AddLog(CEC_LOG_DEBUG, "reader thread terminated");
+  while (!IsStopped())
+  {
+    ReadFromDevice(500);
+    Sleep(5);
+    WriteNextCommand();
+  }
 
-  CLockObject lock(&m_commMutex);
-  m_bStarted = false;
   return NULL;
 }
 
-bool CAdapterCommunication::ReadFromDevice(int iTimeout)
+bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
 {
+  int32_t iBytesRead;
   uint8_t buff[1024];
-  CLockObject lock(&m_commMutex);
-  int iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
-  lock.Leave();
-  if (iBytesRead < 0)
+  if (!m_port)
+    return false;
+
+  iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
+  if (iBytesRead < 0 || iBytesRead > 256)
   {
     CStdString strError;
     strError.Format("error reading from serial port: %s", m_port->GetError().c_str());
@@ -135,134 +338,106 @@ bool CAdapterCommunication::ReadFromDevice(int iTimeout)
     return false;
   }
   else if (iBytesRead > 0)
-    AddData(buff, iBytesRead);
+    AddData(buff, (uint8_t) iBytesRead);
 
-  return true;
+  return iBytesRead > 0;
 }
 
-void CAdapterCommunication::AddData(uint8_t *data, int iLen)
+void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen)
 {
-  CLockObject lock(&m_bufferMutex);
-  if (iLen + m_iInbufUsed > m_iInbufSize)
-  {
-    m_iInbufSize = iLen + m_iInbufUsed;
-    m_inbuf = (uint8_t*)realloc(m_inbuf, m_iInbufSize);
-  }
+  CLockObject lock(&m_mutex);
+  for (unsigned int iPtr = 0; iPtr < iLen; iPtr++)
+    m_inBuffer.Push(data[iPtr]);
 
-  memcpy(m_inbuf + m_iInbufUsed, data, iLen);
-  m_iInbufUsed += iLen;
-  lock.Leave();
-  m_condition.Signal();
+  m_rcvCondition.Signal();
 }
 
-bool CAdapterCommunication::Write(const cec_frame &data)
+void CAdapterCommunication::WriteNextCommand(void)
 {
-  CLockObject lock(&m_commMutex);
+  CCECAdapterMessage *msg;
+  if (m_outBuffer.Pop(msg))
+    SendMessageToAdapter(msg);
+}
 
-  if (m_port->Write(data) != data.size())
+void CAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg)
+{
+  CLockObject lock(&msg->mutex);
+  if (m_port->Write(msg) != (int32_t) msg->size())
   {
     CStdString strError;
     strError.Format("error writing to serial port: %s", m_port->GetError().c_str());
     m_controller->AddLog(CEC_LOG_ERROR, strError);
-    return false;
+    msg->state = ADAPTER_MESSAGE_STATE_ERROR;
   }
+  else
+  {
+    m_controller->AddLog(CEC_LOG_DEBUG, "command sent");
+    CCondition::Sleep((uint32_t) msg->size() * 24 /*data*/ + 5 /*start bit (4.5 ms)*/);
+    msg->state = ADAPTER_MESSAGE_STATE_SENT;
+  }
+  msg->condition.Signal();
+}
 
-  m_controller->AddLog(CEC_LOG_DEBUG, "command sent");
-
-  CCondition::Sleep((int) data.size() * 24 /*data*/ + 5 /*start bit (4.5 ms)*/ + 50 /* to be on the safe side */);
-
+bool CAdapterCommunication::Write(CCECAdapterMessage *data)
+{
+  data->state = ADAPTER_MESSAGE_STATE_WAITING;
+  m_outBuffer.Push(data);
   return true;
 }
 
-bool CAdapterCommunication::Read(cec_frame &msg, int iTimeout)
+bool CAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
 {
-  CLockObject lock(&m_bufferMutex);
+  CLockObject lock(&m_mutex);
 
-  if (m_iInbufUsed < 1)
-    m_condition.Wait(&m_bufferMutex, iTimeout);
-
-  if (m_iInbufUsed < 1)
-    return false;
+  msg.clear();
+  uint64_t iNow = GetTimeMs();
+  uint64_t iTarget = iNow + iTimeout;
+  bool bGotFullMessage(false);
+  bool bNextIsEscaped(false);
+  bool bGotStart(false);
 
-  //search for first start of message
-  int startpos = -1;
-  for (int i = 0; i < m_iInbufUsed; i++)
+  while(!bGotFullMessage && iNow < iTarget)
   {
-    if (m_inbuf[i] == MSGSTART)
+    uint8_t buf = 0;
+    if (!m_inBuffer.Pop(buf))
     {
-      startpos = i;
-      break;
+      if (!m_rcvCondition.Wait(&m_mutex, (uint32_t) (iTarget - iNow)))
+        return false;
     }
-  }
-
-  if (startpos == -1)
-    return false;
-
-  //move anything from the first start of message to the beginning of the buffer
-  if (startpos > 0)
-  {
-    memmove(m_inbuf, m_inbuf + startpos, m_iInbufUsed - startpos);
-    m_iInbufUsed -= startpos;
-  }
-
-  if (m_iInbufUsed < 2)
-    return false;
 
-  //look for end of message
-  startpos = -1;
-  int endpos = -1;
-  for (int i = 1; i < m_iInbufUsed; i++)
-  {
-    if (m_inbuf[i] == MSGEND)
+    if (!bGotStart)
     {
-      endpos = i;
-      break;
+      if (buf == MSGSTART)
+        bGotStart = true;
+      continue;
     }
-    else if (m_inbuf[i] == MSGSTART)
+    else if (buf == MSGSTART) //we found a msgstart before msgend, this is not right, remove
     {
-      startpos = i;
-      break;
+      if (msg.size() > 0)
+        m_controller->AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents");
+      msg.clear();
+      bGotStart = true;
     }
-  }
-
-  if (startpos > 0) //we found a msgstart before msgend, this is not right, remove
-  {
-    m_controller->AddLog(CEC_LOG_ERROR, "received MSGSTART before MSGEND");
-    memmove(m_inbuf, m_inbuf + startpos, m_iInbufUsed - startpos);
-    m_iInbufUsed -= startpos;
-    return false;
-  }
 
-  if (endpos > 0) //found a MSGEND
-  {
-    msg.clear();
-    bool isesc = false;
-    for (int i = 1; i < endpos; i++)
+    if (buf == MSGEND)
     {
-      if (isesc)
-      {
-        msg.push_back(m_inbuf[i] + (uint8_t)ESCOFFSET);
-        isesc = false;
-      }
-      else if (m_inbuf[i] == MSGESC)
-      {
-        isesc = true;
-      }
-      else
-      {
-        msg.push_back(m_inbuf[i]);
-      }
+      bGotFullMessage = true;
     }
-
-    if (endpos + 1 < m_iInbufUsed)
-      memmove(m_inbuf, m_inbuf + endpos + 1, m_iInbufUsed - endpos - 1);
-
-    m_iInbufUsed -= endpos + 1;
-
-    return true;
+    else if (bNextIsEscaped)
+    {
+      msg.push_back(buf + (uint8_t)ESCOFFSET);
+      bNextIsEscaped = false;
+    }
+    else if (buf == MSGESC)
+      bNextIsEscaped = true;
+    else
+      msg.push_back(buf);
   }
 
-  return false;
+  if (bGotFullMessage)
+    msg.state = ADAPTER_MESSAGE_STATE_RECEIVED;
+
+  return bGotFullMessage;
 }
 
 std::string CAdapterCommunication::GetError(void) const
@@ -272,82 +447,45 @@ std::string CAdapterCommunication::GetError(void) const
 
 bool CAdapterCommunication::StartBootloader(void)
 {
+  bool bReturn(false);
   if (!IsRunning())
-    return false;
+    return bReturn;
 
   m_controller->AddLog(CEC_LOG_DEBUG, "starting the bootloader");
-  cec_frame output;
-  output.push_back(MSGSTART);
-  PushEscaped(output, MSGCODE_START_BOOTLOADER);
-  output.push_back(MSGEND);
+  CCECAdapterMessage *output = new CCECAdapterMessage;
 
-  if (!Write(output))
-  {
-    m_controller->AddLog(CEC_LOG_ERROR, "could not start the bootloader");
-    return false;
-  }
-  m_controller->AddLog(CEC_LOG_DEBUG, "bootloader start command transmitted");
-  return true;
-}
+  output->push_back(MSGSTART);
+  output->push_escaped(MSGCODE_START_BOOTLOADER);
+  output->push_back(MSGEND);
 
-void CAdapterCommunication::PushEscaped(cec_frame &vec, uint8_t byte)
-{
-  if (byte >= MSGESC && byte != MSGSTART)
-  {
-    vec.push_back(MSGESC);
-    vec.push_back(byte - ESCOFFSET);
-  }
-  else
-  {
-    vec.push_back(byte);
-  }
-}
-
-bool CAdapterCommunication::SetAckMask(uint16_t iMask)
-{
-  if (!IsRunning())
-    return false;
+  SendMessageToAdapter(output);
+  bReturn = output->state == ADAPTER_MESSAGE_STATE_SENT;
+  delete output;
 
-  CStdString strLog;
-  strLog.Format("setting ackmask to %2x", iMask);
-  m_controller->AddLog(CEC_LOG_DEBUG, strLog.c_str());
-
-  cec_frame output;
-
-  output.push_back(MSGSTART);
-  PushEscaped(output, MSGCODE_SET_ACK_MASK);
-  PushEscaped(output, iMask >> 8);
-  PushEscaped(output, (uint8_t)iMask);
-  output.push_back(MSGEND);
-
-  if (!Write(output))
-  {
-    m_controller->AddLog(CEC_LOG_ERROR, "could not set the ackmask");
-    return false;
-  }
-
-  return true;
+  return bReturn;
 }
 
 bool CAdapterCommunication::PingAdapter(void)
 {
+  bool bReturn(false);
   if (!IsRunning())
-    return false;
+    return bReturn;
 
   m_controller->AddLog(CEC_LOG_DEBUG, "sending ping");
-  cec_frame output;
-  output.push_back(MSGSTART);
-  PushEscaped(output, MSGCODE_PING);
-  output.push_back(MSGEND);
+  CCECAdapterMessage *output = new CCECAdapterMessage;
 
-  if (!Write(output))
-  {
-    m_controller->AddLog(CEC_LOG_ERROR, "could not send ping command");
-    return false;
-  }
+  output->push_back(MSGSTART);
+  output->push_escaped(MSGCODE_PING);
+  output->push_back(MSGEND);
 
-  m_controller->AddLog(CEC_LOG_DEBUG, "ping tranmitted");
+  SendMessageToAdapter(output);
+  bReturn = output->state == ADAPTER_MESSAGE_STATE_SENT;
+  delete output;
 
-  // TODO check for pong
-  return true;
+  return bReturn;
+}
+
+bool CAdapterCommunication::IsOpen(void) const
+{
+  return !IsStopped() && m_port->IsOpen() && IsRunning();
 }