cec: persist the configuration before closing the connection. only try to persist...
[deb_libcec.git] / src / lib / adapter / USBCECAdapterCommunication.cpp
index 0f73bae0f958139e0a52a9535bae6f92d330ff6a..4e6189cee7aab847a54451082da7b2a4756598b7 100644 (file)
@@ -40,6 +40,8 @@ using namespace std;
 using namespace CEC;
 using namespace PLATFORM;
 
+#define CEC_ADAPTER_PING_TIMEOUT 15000
+
 void *CUSBCECAdapterProcessor::Process(void)
 {
   cec_command command;
@@ -90,20 +92,26 @@ bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs /* = 10000 */
   while (iNow < iTarget && (bPinged = PingAdapter()) == false)
   {
     CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry);
-    Sleep(500);
+    CEvent::Sleep(500);
     iNow = GetTimeMs();
   }
 
   /* try to read the firmware version */
   m_iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
   unsigned iFwVersionTry(0);
-  while (bPinged && iNow < iTarget && (m_iFirmwareVersion = GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN)
+  while (bPinged && iNow < iTarget && (m_iFirmwareVersion = GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN && iFwVersionTry < 3)
   {
-    CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry);
-    Sleep(500);
+    CLibCEC::AddLog(CEC_LOG_WARNING, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry);
+    CEvent::Sleep(500);
     iNow = GetTimeMs();
   }
 
+  if (m_iFirmwareVersion == CEC_FW_VERSION_UNKNOWN)
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "defaulting to firmware version 1");
+    m_iFirmwareVersion = 1;
+  }
+
   if (m_iFirmwareVersion >= 2)
   {
     /* try to set controlled mode */
@@ -112,7 +120,7 @@ bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs /* = 10000 */
     while (iNow < iTarget && (bControlled = SetControlledMode(true)) == false)
     {
       CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry);
-      Sleep(500);
+      CEvent::Sleep(500);
       iNow = GetTimeMs();
     }
     bReturn = bControlled;
@@ -128,7 +136,7 @@ bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs /* = 10000 */
   return bReturn;
 }
 
-bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback *cb, uint32_t iTimeoutMs /* = 10000 */)
+bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback *cb, uint32_t iTimeoutMs /* = 10000 */, bool bSkipChecks /* = false */)
 {
   uint64_t iNow = GetTimeMs();
   uint64_t iTimeout = iNow + iTimeoutMs;
@@ -169,29 +177,35 @@ bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback *cb, uint32
 
     CLibCEC::AddLog(CEC_LOG_DEBUG, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
 
-    //clear any input bytes
-    uint8_t buff[1024];
-    while (m_port->Read(buff, 1024, 100) > 0)
+    if (!bSkipChecks)
     {
-      CLibCEC::AddLog(CEC_LOG_DEBUG, "data received, clearing it");
-      Sleep(250);
+      //clear any input bytes
+      uint8_t buff[1024];
+      while (m_port->Read(buff, 1024, 100) > 0)
+      {
+        CLibCEC::AddLog(CEC_LOG_DEBUG, "data received, clearing it");
+        Sleep(250);
+      }
     }
   }
 
-  if (CreateThread())
+  if (!bSkipChecks && !CheckAdapter())
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter failed to pass basic checks");
+    return false;
+  }
+  else
   {
-    if (!CheckAdapter())
+    if (CreateThread())
     {
-      StopThread();
-      CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter failed to pass basic checks");
+      CLibCEC::AddLog(CEC_LOG_DEBUG, "communication thread started");
+      return true;
     }
     else
     {
-      CLibCEC::AddLog(CEC_LOG_DEBUG, "communication thread started");
-      return true;
+      CLibCEC::AddLog(CEC_LOG_ERROR, "could not create a communication thread");
     }
   }
-  CLibCEC::AddLog(CEC_LOG_ERROR, "could not create a communication thread");
 
   return false;
 }
@@ -209,6 +223,7 @@ void *CUSBCECAdapterCommunication::Process(void)
   cec_command command;
   command.Clear();
   bool bCommandReceived(false);
+  CTimeout pingTimeout(CEC_ADAPTER_PING_TIMEOUT);
   while (!IsStopped())
   {
     {
@@ -221,6 +236,13 @@ void *CUSBCECAdapterCommunication::Process(void)
     if (!IsStopped() && bCommandReceived)
       m_messageProcessor->AddCommand(command);
 
+    /* ping the adapter every 15 seconds */
+    if (pingTimeout.TimeLeft() == 0)
+    {
+      pingTimeout.Init(CEC_ADAPTER_PING_TIMEOUT);
+      PingAdapter();
+    }
+
     if (!IsStopped())
     {
       Sleep(5);
@@ -240,6 +262,9 @@ void *CUSBCECAdapterCommunication::Process(void)
   /* set the ackmask to 0 before closing the connection */
   SetAckMaskInternal(0, true);
 
+  if (m_iFirmwareVersion >= 2)
+    SetControlledMode(false);
+
   if (m_port)
   {
     delete m_port;
@@ -370,11 +395,9 @@ bool CUSBCECAdapterCommunication::StartBootloader(void)
 
 bool CUSBCECAdapterCommunication::PingAdapter(void)
 {
-  bool bReturn(false);
-  if (!IsRunning())
-    return bReturn;
-
+  CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");
+
   CCECAdapterMessage *output = new CCECAdapterMessage;
 
   output->PushBack(MSGSTART);
@@ -382,11 +405,16 @@ bool CUSBCECAdapterCommunication::PingAdapter(void)
   output->PushBack(MSGEND);
   output->isTransmission = false;
 
-  if ((bReturn = Write(output)) == false)
-    CLibCEC::AddLog(CEC_LOG_ERROR, "could not ping the adapter");
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not ping the adapter");
+    return false;
+  }
 
-  return bReturn;
+  return true;
 }
 
 bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage &msg)
@@ -444,8 +472,6 @@ bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage &msg)
 uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
 {
   uint16_t iReturn(m_iFirmwareVersion);
-  if (!IsRunning())
-    return iReturn;
 
   if (iReturn == CEC_FW_VERSION_UNKNOWN)
   {
@@ -543,10 +569,23 @@ bool CUSBCECAdapterCommunication::SetAckMaskInternal(uint16_t iMask, bool bWrite
   return bReturn;
 }
 
+bool CUSBCECAdapterCommunication::PersistConfiguration(libcec_configuration *configuration)
+{
+  if (m_iFirmwareVersion < 2)
+    return false;
+
+  return SetAutoEnabled(true) &&
+      SetDefaultLogicalAddress(configuration->logicalAddresses.primary) &&
+      SetLogicalAddressMask(configuration->logicalAddresses.AckMask()) &&
+      SetPhysicalAddress(configuration->iPhysicalAddress) &&
+      SetCECVersion(CEC_VERSION_1_3A) &&
+      SetOSDName(configuration->strDeviceName) &&
+      WriteEEPROM();
+}
 
 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
 {
-  bool bReturn(false);
+  CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "turning controlled mode %s", controlled ? "on" : "off");
 
   CCECAdapterMessage *output = new CCECAdapterMessage;
@@ -557,11 +596,193 @@ bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
   output->PushBack(MSGEND);
   output->isTransmission = false;
 
-  if ((bReturn = Write(output)) == false)
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
     CLibCEC::AddLog(CEC_LOG_ERROR, "could not set controlled mode");
+    return false;
+  }
+
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::SetAutoEnabled(bool enabled)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "turning autonomous mode %s", enabled ? "on" : "off");
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_SET_AUTO_ENABLED);
+  output->PushEscaped(enabled);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
   delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not set autonomous mode");
+    return false;
+  }
 
-  return bReturn;
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::SetDefaultLogicalAddress(cec_logical_address address)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the default logical address to %1X", address);
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS);
+  output->PushEscaped((uint8_t) address);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the default logical address");
+    return false;
+  }
+
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::SetLogicalAddressMask(uint16_t iMask)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the logical address mask to %2X", iMask);
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_SET_LOGICAL_ADDRESS_MASK);
+  output->PushEscaped(iMask >> 8);
+  output->PushEscaped((uint8_t)iMask);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the logical address mask");
+    return false;
+  }
+
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::SetPhysicalAddress(uint16_t iPhysicalAddress)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the physical address to %2X", iPhysicalAddress);
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_SET_PHYSICAL_ADDRESS);
+  output->PushEscaped(iPhysicalAddress >> 8);
+  output->PushEscaped((uint8_t)iPhysicalAddress);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the physical address");
+    return false;
+  }
+
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::SetCECVersion(cec_version version)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the CEC version to %s", CLibCEC::GetInstance()->ToString(version));
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_SET_HDMI_VERSION);
+  output->PushEscaped((uint8_t)version);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the CEC version");
+    return false;
+  }
+
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::SetOSDName(const char *strOSDName)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the OSD name to %s", strOSDName);
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_SET_OSD_NAME);
+  for (size_t iPtr = 0; iPtr < strlen(strOSDName); iPtr++)
+    output->PushEscaped(strOSDName[iPtr]);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the OSD name");
+    return false;
+  }
+
+  return true;
+}
+
+bool CUSBCECAdapterCommunication::WriteEEPROM(void)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "writing settings in the EEPROM");
+
+  CCECAdapterMessage *output = new CCECAdapterMessage;
+
+  output->PushBack(MSGSTART);
+  output->PushEscaped(MSGCODE_WRITE_EEPROM);
+  output->PushBack(MSGEND);
+  output->isTransmission = false;
+
+  SendMessageToAdapter(output);
+  bool bWriteOk = output->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
+  delete output;
+  if (!bWriteOk)
+  {
+    CLibCEC::AddLog(CEC_LOG_ERROR, "could not write the settings in the EEPROM");
+    return false;
+  }
+
+  return true;
 }
 
 bool CUSBCECAdapterCommunication::IsOpen(void)
@@ -615,11 +836,11 @@ bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage &message)
       switch(msg.Message())
       {
       case MSGCODE_COMMAND_ACCEPTED:
-        CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
         if (iPacketsLeft > 0)
           iPacketsLeft--;
         if (!message.isTransmission && iPacketsLeft == 0)
           bTransmitSucceeded = true;
+        CLibCEC::AddLog(CEC_LOG_DEBUG, "%s - waiting for %d more", msg.ToString().c_str(), iPacketsLeft);
         break;
       case MSGCODE_TRANSMIT_SUCCEEDED:
         CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());