cec: fixed - frequency wasn't checked in GetTimeMs(), leading to incorrect wait times...
[deb_libcec.git] / src / lib / adapter / USBCECAdapterCommunication.cpp
index 360eff5d1fde41257d339f9b58a9b046c4f18884..49bd9ea5fa40521affe14746eedccff79d7d9fed 100644 (file)
@@ -66,12 +66,14 @@ CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(CCECProcessor *processo
     m_bHasData(false),
     m_iLineTimeout(0),
     m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN),
-    m_lastInitiator(CECDEVICE_UNKNOWN),
+    m_lastDestination(CECDEVICE_UNKNOWN),
     m_bNextIsEscaped(false),
     m_bGotStart(false),
     m_messageProcessor(NULL),
     m_bInitialised(false)
 {
+  for (unsigned int iPtr = 0; iPtr < 15; iPtr++)
+    m_bWaitingForAck[iPtr] = false;
   m_port = new CSerialPort(strPort, iBaudRate);
 }
 
@@ -181,9 +183,20 @@ bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback *cb, uint32
     {
       //clear any input bytes
       uint8_t buff[1024];
-      while (m_port->Read(buff, 1024, 100) > 0)
+      ssize_t iBytesRead(0);
+      bool bGotMsgStart(false), bGotMsgEnd(false);
+      while ((iBytesRead = m_port->Read(buff, 1024, 100)) > 0 || (bGotMsgStart && !bGotMsgEnd))
       {
-        CLibCEC::AddLog(CEC_LOG_DEBUG, "data received, clearing it");
+        if (!bGotMsgStart)
+          CLibCEC::AddLog(CEC_LOG_DEBUG, "data received, clearing it");
+        // if something was received, wait for MSGEND
+        for (ssize_t iPtr = 0; iPtr < iBytesRead; iPtr++)
+        {
+          if (buff[iPtr] == MSGSTART)
+            bGotMsgStart = true;
+          else if (buff[iPtr] == MSGEND)
+            bGotMsgEnd = true;
+        }
         Sleep(250);
       }
     }
@@ -292,6 +305,11 @@ cec_adapter_message_state CUSBCECAdapterCommunication::Write(const cec_command &
   output->retryTimeout = iRetryLineTimeout;
   output->tries = 0;
 
+  {
+    CLockObject lock(m_mutex);
+    m_bWaitingForAck[data.destination] = true;
+  }
+
   bool bRetry(true);
   while (bRetry && ++output->tries < output->maxTries)
   {
@@ -415,16 +433,19 @@ bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage &msg)
       }
       if (m_currentframe.ack == 0x1)
       {
-        m_lastInitiator = m_currentframe.initiator;
-        m_processor->HandlePoll(m_currentframe.initiator, m_currentframe.destination);
+        m_lastDestination    = m_currentframe.destination;
+        if (!m_bWaitingForAck[m_currentframe.destination])
+          m_processor->HandlePoll(m_currentframe.initiator, m_currentframe.destination);
+        else
+          m_bWaitingForAck[m_currentframe.destination] = false;
       }
     }
     break;
   case MSGCODE_RECEIVE_FAILED:
     {
       m_currentframe.Clear();
-      if (m_lastInitiator != CECDEVICE_UNKNOWN)
-        bIsError = m_processor->HandleReceiveFailed(m_lastInitiator);
+      if (m_lastDestination != CECDEVICE_UNKNOWN)
+        bIsError = m_processor->HandleReceiveFailed(m_lastDestination);
     }
     break;
   case MSGCODE_FRAME_DATA:
@@ -452,7 +473,7 @@ uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
   {
     CLockObject lock(m_mutex);
     CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
-    cec_datapacket response = GetSetting(MSGCODE_FIRMWARE_VERSION);
+    cec_datapacket response = GetSetting(MSGCODE_FIRMWARE_VERSION, 2);
     if (response.size == 2)
     {
       m_iFirmwareVersion = (response[0] << 8 | response[1]);
@@ -501,18 +522,79 @@ bool CUSBCECAdapterCommunication::PersistConfiguration(libcec_configuration *con
     return false;
 
   bool bReturn(true);
-  bReturn &= SetAutoEnabled(true);
-  bReturn &= SetDeviceType(CLibCEC::GetType(configuration->logicalAddresses.primary));
-  bReturn &= SetDefaultLogicalAddress(configuration->logicalAddresses.primary);
-  bReturn &= SetLogicalAddressMask(CLibCEC::GetMaskForType(configuration->logicalAddresses.primary));
-  bReturn &= SetPhysicalAddress(configuration->iPhysicalAddress);
-  bReturn &= SetCECVersion(CEC_VERSION_1_3A);
-  bReturn &= SetOSDName(configuration->strDeviceName);
+  bReturn &= SetSettingAutoEnabled(true);
+  bReturn &= SetSettingDeviceType(CLibCEC::GetType(configuration->logicalAddresses.primary));
+  bReturn &= SetSettingDefaultLogicalAddress(configuration->logicalAddresses.primary);
+  bReturn &= SetSettingLogicalAddressMask(CLibCEC::GetMaskForType(configuration->logicalAddresses.primary));
+  bReturn &= SetSettingPhysicalAddress(configuration->iPhysicalAddress);
+  bReturn &= SetSettingCECVersion(CEC_VERSION_1_3A);
+  bReturn &= SetSettingOSDName(configuration->strDeviceName);
   if (bReturn)
     bReturn = WriteEEPROM();
   return bReturn;
 }
 
+bool CUSBCECAdapterCommunication::GetConfiguration(libcec_configuration *configuration)
+{
+  if (m_iFirmwareVersion < 2)
+    return false;
+
+  bool bReturn(true);
+  cec_device_type type;
+  if (GetSettingDeviceType(type))
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted device type setting %s", m_processor->ToString(type));
+    configuration->deviceTypes.Clear();
+    configuration->deviceTypes.Add(type);
+  }
+  else
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted device type setting");
+    bReturn = false;
+  }
+
+  if (GetSettingPhysicalAddress(configuration->iPhysicalAddress))
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted physical address setting %4x", configuration->iPhysicalAddress);
+  }
+  else
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted physical address setting");
+    bReturn = false;
+  }
+
+  CStdString strDeviceName;
+  if (GetSettingOSDName(strDeviceName))
+  {
+    snprintf(configuration->strDeviceName, 13, "%s", strDeviceName.c_str());
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "using persisted device name setting %s", configuration->strDeviceName);
+  }
+  else
+  {
+    CLibCEC::AddLog(CEC_LOG_DEBUG, "no persisted device name setting");
+    bReturn = false;
+  }
+
+  // don't read the following settings:
+  // - auto enabled (always enabled)
+  // - default logical address (autodetected)
+  // - logical address mask (autodetected)
+  // - CEC version (1.3a)
+
+  // TODO to be added to the firmware:
+  // - base device (4 bits)
+  // - HDMI port number (4 bits)
+  // - TV vendor id (12 bits)
+  // - wake devices (8 bits)
+  // - standby devices (8 bits)
+  // - use TV menu language (1 bit)
+  // - activate source (1 bit)
+  // - power off screensaver (1 bit)
+  // - power off on standby (1 bit)
+  // - send inactive source (1 bit)
+  return bReturn;
+}
+
 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
 {
   CLockObject lock(m_mutex);
@@ -523,7 +605,7 @@ bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
   return SendCommand(MSGCODE_SET_CONTROLLED, params);
 }
 
-bool CUSBCECAdapterCommunication::SetAutoEnabled(bool enabled)
+bool CUSBCECAdapterCommunication::SetSettingAutoEnabled(bool enabled)
 {
   CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "turning autonomous mode %s", enabled ? "on" : "off");
@@ -533,7 +615,21 @@ bool CUSBCECAdapterCommunication::SetAutoEnabled(bool enabled)
   return SendCommand(MSGCODE_SET_AUTO_ENABLED, params);
 }
 
-bool CUSBCECAdapterCommunication::SetDeviceType(cec_device_type type)
+bool CUSBCECAdapterCommunication::GetSettingAutoEnabled(bool &enabled)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting autonomous mode setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_AUTO_ENABLED, 1);
+  if (response.size == 1)
+  {
+    enabled = response[0] == 1;
+    return true;
+  }
+  return false;
+}
+
+bool CUSBCECAdapterCommunication::SetSettingDeviceType(cec_device_type type)
 {
   CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the device type to %1X", (uint8_t)type);
@@ -543,7 +639,21 @@ bool CUSBCECAdapterCommunication::SetDeviceType(cec_device_type type)
   return SendCommand(MSGCODE_SET_DEVICE_TYPE, params);
 }
 
-bool CUSBCECAdapterCommunication::SetDefaultLogicalAddress(cec_logical_address address)
+bool CUSBCECAdapterCommunication::GetSettingDeviceType(cec_device_type &value)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting device type setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_DEVICE_TYPE, 1);
+  if (response.size == 1)
+  {
+    value = (cec_device_type)response[0];
+    return true;
+  }
+  return false;
+}
+
+bool CUSBCECAdapterCommunication::SetSettingDefaultLogicalAddress(cec_logical_address address)
 {
   CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the default logical address to %1X", address);
@@ -553,7 +663,21 @@ bool CUSBCECAdapterCommunication::SetDefaultLogicalAddress(cec_logical_address a
   return SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS, params);
 }
 
-bool CUSBCECAdapterCommunication::SetLogicalAddressMask(uint16_t iMask)
+bool CUSBCECAdapterCommunication::GetSettingDefaultLogicalAddress(cec_logical_address &address)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting default logical address setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS, 1);
+  if (response.size == 1)
+  {
+    address = (cec_logical_address)response[0];
+    return true;
+  }
+  return false;
+}
+
+bool CUSBCECAdapterCommunication::SetSettingLogicalAddressMask(uint16_t iMask)
 {
   CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the logical address mask to %2X", iMask);
@@ -564,10 +688,24 @@ bool CUSBCECAdapterCommunication::SetLogicalAddressMask(uint16_t iMask)
   return SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK, params);
 }
 
-bool CUSBCECAdapterCommunication::SetPhysicalAddress(uint16_t iPhysicalAddress)
+bool CUSBCECAdapterCommunication::GetSettingLogicalAddressMask(uint16_t &iMask)
 {
   CLockObject lock(m_mutex);
-  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the physical address to %2X", iPhysicalAddress);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting logical address mask setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK, 2);
+  if (response.size == 2)
+  {
+    iMask = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
+    return true;
+  }
+  return false;
+}
+
+bool CUSBCECAdapterCommunication::SetSettingPhysicalAddress(uint16_t iPhysicalAddress)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the physical address to %04X", iPhysicalAddress);
 
   CCECAdapterMessage params;
   params.PushEscaped(iPhysicalAddress >> 8);
@@ -575,7 +713,21 @@ bool CUSBCECAdapterCommunication::SetPhysicalAddress(uint16_t iPhysicalAddress)
   return SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS, params);
 }
 
-bool CUSBCECAdapterCommunication::SetCECVersion(cec_version version)
+bool CUSBCECAdapterCommunication::GetSettingPhysicalAddress(uint16_t &iPhysicalAddress)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting physical address setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_PHYSICAL_ADDRESS, 2);
+  if (response.size == 2)
+  {
+    iPhysicalAddress = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
+    return true;
+  }
+  return false;
+}
+
+bool CUSBCECAdapterCommunication::SetSettingCECVersion(cec_version version)
 {
   CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the CEC version to %s", CLibCEC::GetInstance()->ToString(version));
@@ -585,7 +737,21 @@ bool CUSBCECAdapterCommunication::SetCECVersion(cec_version version)
   return SendCommand(MSGCODE_SET_HDMI_VERSION, params);
 }
 
-bool CUSBCECAdapterCommunication::SetOSDName(const char *strOSDName)
+bool CUSBCECAdapterCommunication::GetSettingCECVersion(cec_version &version)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting CEC version setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_HDMI_VERSION, 1);
+  if (response.size == 1)
+  {
+    version = (cec_version)response[0];
+    return true;
+  }
+  return false;
+}
+
+bool CUSBCECAdapterCommunication::SetSettingOSDName(const char *strOSDName)
 {
   CLockObject lock(m_mutex);
   CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the OSD name to %s", strOSDName);
@@ -596,6 +762,24 @@ bool CUSBCECAdapterCommunication::SetOSDName(const char *strOSDName)
   return SendCommand(MSGCODE_SET_OSD_NAME, params);
 }
 
+bool CUSBCECAdapterCommunication::GetSettingOSDName(CStdString &strOSDName)
+{
+  CLockObject lock(m_mutex);
+  CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting OSD name setting");
+
+  cec_datapacket response = GetSetting(MSGCODE_GET_OSD_NAME, 13);
+  if (response.size == 0)
+    return false;
+
+  char buf[14];
+  for (uint8_t iPtr = 0; iPtr < response.size && iPtr < 13; iPtr++)
+    buf[iPtr] = (char)response[iPtr];
+  buf[response.size] = 0;
+
+  strOSDName.Format("%s", buf);
+  return true;
+}
+
 bool CUSBCECAdapterCommunication::WriteEEPROM(void)
 {
   CLockObject lock(m_mutex);
@@ -631,15 +815,20 @@ bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage &message)
 
     if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK())
     {
-      m_processor->HandlePoll(msg.Initiator(), msg.Destination());
-      m_lastInitiator = msg.Initiator();
+      if (m_bWaitingForAck[msg.Initiator()])
+        m_bWaitingForAck[msg.Initiator()] = false;
+      else
+      {
+        m_processor->HandlePoll(msg.Initiator(), msg.Destination());
+        m_lastDestination = msg.Initiator();
+      }
       iNow = GetTimeMs();
       continue;
     }
 
     if (msg.Message() == MSGCODE_RECEIVE_FAILED &&
-        m_lastInitiator != CECDEVICE_UNKNOWN &&
-        m_processor->HandleReceiveFailed(m_lastInitiator))
+        m_lastDestination != CECDEVICE_UNKNOWN &&
+        m_processor->HandleReceiveFailed(m_lastDestination))
     {
       iNow = GetTimeMs();
       continue;
@@ -804,14 +993,14 @@ CStdString CUSBCECAdapterCommunication::GetPortName(void)
   return strName;
 }
 
-bool CUSBCECAdapterCommunication::SendCommand(cec_adapter_messagecode msgCode, CCECAdapterMessage &params, bool bExpectAck /* = true */, bool bIsTransmission /* = false */, bool bSendDirectly /* = true */)
+bool CUSBCECAdapterCommunication::SendCommand(cec_adapter_messagecode msgCode, CCECAdapterMessage &params, bool bExpectAck /* = true */, bool bIsTransmission /* = false */, bool bSendDirectly /* = true */, bool bIsRetry /* = false */)
 {
   CLockObject lock(m_mutex);
 
   CCECAdapterMessage *output = new CCECAdapterMessage;
 
   output->PushBack(MSGSTART);
-  output->PushEscaped(msgCode);
+  output->PushEscaped((uint8_t)msgCode);
   output->Append(params);
   output->PushBack(MSGEND);
   output->isTransmission = bIsTransmission;
@@ -827,6 +1016,13 @@ bool CUSBCECAdapterCommunication::SendCommand(cec_adapter_messagecode msgCode, C
   {
     CLibCEC::AddLog(CEC_LOG_ERROR, "'%s' failed", CCECAdapterMessage::ToString(msgCode));
     delete output;
+
+    if (!bIsRetry && output->reply == MSGCODE_COMMAND_REJECTED && msgCode != MSGCODE_SET_CONTROLLED)
+    {
+      CLibCEC::AddLog(CEC_LOG_DEBUG, "setting controlled mode and retrying");
+      if (SetControlledMode(true))
+        return SendCommand(msgCode, params, bExpectAck, bIsTransmission, bSendDirectly, true);
+    }
     return false;
   }
 
@@ -834,7 +1030,7 @@ bool CUSBCECAdapterCommunication::SendCommand(cec_adapter_messagecode msgCode, C
   return true;
 }
 
-cec_datapacket CUSBCECAdapterCommunication::GetSetting(cec_adapter_messagecode msgCode)
+cec_datapacket CUSBCECAdapterCommunication::GetSetting(cec_adapter_messagecode msgCode, uint8_t iResponseLength)
 {
   cec_datapacket retVal;
   retVal.Clear();
@@ -847,7 +1043,7 @@ cec_datapacket CUSBCECAdapterCommunication::GetSetting(cec_adapter_messagecode m
   }
 
   Sleep(250); // TODO ReadFromDevice() isn't waiting for the timeout to pass on win32
-  ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT, 5 /* start + msgcode + 2 bytes for fw version + end */);
+  ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT, iResponseLength + 3 /* start + msgcode + iResponseLength + end */);
   CCECAdapterMessage input;
   if (Read(input, 0))
   {