*/
#include "USBCECAdapterCommunication.h"
+#include "USBCECAdapterCommands.h"
+#include "USBCECAdapterMessageQueue.h"
#include "../platform/sockets/serialport.h"
#include "../platform/util/timeutils.h"
#include "../LibCEC.h"
using namespace CEC;
using namespace PLATFORM;
-CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(CCECProcessor *processor, const char *strPort, uint16_t iBaudRate /* = 38400 */) :
+#define CEC_ADAPTER_PING_TIMEOUT 15000
+
+// firmware version 2
+#define CEC_LATEST_ADAPTER_FW_VERSION 2
+// firmware date Thu Apr 26 20:14:49 2012 +0000
+#define CEC_LATEST_ADAPTER_FW_DATE 0x4F99ACB9
+
+#define LIB_CEC m_callback->GetLib()
+
+CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(IAdapterCommunicationCallback *callback, const char *strPort, uint16_t iBaudRate /* = CEC_SERIAL_DEFAULT_BAUDRATE */) :
+ IAdapterCommunication(callback),
m_port(NULL),
- m_processor(processor),
m_iLineTimeout(0),
- m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN),
- m_lastInitiator(CECDEVICE_UNKNOWN),
- m_bNextIsEscaped(false),
- m_bGotStart(false)
+ m_lastPollDestination(CECDEVICE_UNKNOWN),
+ m_bInitialised(false),
+ m_pingThread(NULL),
+ m_commands(NULL),
+ m_adapterMessageQueue(NULL),
+ m_iAckMask(0xFFFF)
{
- m_port = new PLATFORM::CSerialPort(strPort, iBaudRate);
+ for (unsigned int iPtr = CECDEVICE_TV; iPtr < CECDEVICE_BROADCAST; iPtr++)
+ m_bWaitingForAck[iPtr] = false;
+ m_port = new CSerialPort(strPort, iBaudRate);
}
CUSBCECAdapterCommunication::~CUSBCECAdapterCommunication(void)
{
Close();
-
- if (m_port)
- {
- delete m_port;
- m_port = NULL;
- }
+ delete m_commands;
+ delete m_adapterMessageQueue;
+ delete m_port;
}
-bool CUSBCECAdapterCommunication::Open(uint32_t iTimeoutMs /* = 10000 */)
+bool CUSBCECAdapterCommunication::Open(uint32_t iTimeoutMs /* = CEC_DEFAULT_CONNECT_TIMEOUT */, bool bSkipChecks /* = false */, bool bStartListening /* = true */)
{
- uint64_t iNow = GetTimeMs();
- uint64_t iTimeout = iNow + iTimeoutMs;
+ bool bConnectionOpened(false);
+ {
+ CLockObject lock(m_mutex);
- CLockObject lock(m_mutex);
+ /* we need the port settings here */
+ if (!m_port)
+ {
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "port is NULL");
+ return bConnectionOpened;
+ }
- if (!m_port)
- {
- CLibCEC::AddLog(CEC_LOG_ERROR, "port is NULL");
- return false;
- }
+ /* return true when the port is already open */
+ if (IsOpen())
+ {
+ LIB_CEC->AddLog(CEC_LOG_WARNING, "port is already open");
+ return true;
+ }
- if (IsOpen())
- {
- CLibCEC::AddLog(CEC_LOG_ERROR, "port is already open");
- return true;
- }
+ /* adapter commands */
+ if (!m_commands)
+ m_commands = new CUSBCECAdapterCommands(this);
- CStdString strError;
- bool bConnected(false);
- while (!bConnected && iNow < iTimeout)
- {
- if ((bConnected = m_port->Open(iTimeout)) == false)
+ if (!m_adapterMessageQueue)
{
- strError.Format("error opening serial port '%s': %s", m_port->GetName().c_str(), m_port->GetError().c_str());
- Sleep(250);
- iNow = GetTimeMs();
+ m_adapterMessageQueue = new CCECAdapterMessageQueue(this);
+ m_adapterMessageQueue->CreateThread();
}
- }
- if (!bConnected)
- {
- CLibCEC::AddLog(CEC_LOG_ERROR, strError);
- return false;
- }
+ /* try to open the connection */
+ CStdString strError;
+ CTimeout timeout(iTimeoutMs);
+ while (!bConnectionOpened && timeout.TimeLeft() > 0)
+ {
+ if ((bConnectionOpened = m_port->Open(timeout.TimeLeft())) == false)
+ {
+ strError.Format("error opening serial port '%s': %s", m_port->GetName().c_str(), m_port->GetError().c_str());
+ Sleep(250);
+ }
+ /* and retry every 250ms until the timeout passed */
+ }
- CLibCEC::AddLog(CEC_LOG_DEBUG, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
+ /* return false when we couldn't connect */
+ if (!bConnectionOpened)
+ {
+ LIB_CEC->AddLog(CEC_LOG_ERROR, strError);
- //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 (m_port->GetErrorNumber() == EACCES)
+ {
+ libcec_parameter param;
+ param.paramType = CEC_PARAMETER_TYPE_STRING;
+ param.paramData = (void*)"No permission to open the device";
+ LIB_CEC->Alert(CEC_ALERT_PERMISSION_ERROR, param);
+ }
+ else if (m_port->GetErrorNumber() == EBUSY)
+ {
+ libcec_parameter param;
+ param.paramType = CEC_PARAMETER_TYPE_STRING;
+ param.paramData = (void*)"The serial port is busy. Only one program can access the device directly.";
+ LIB_CEC->Alert(CEC_ALERT_PORT_BUSY, param);
+ }
+ return false;
+ }
+
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
+ ClearInputBytes();
}
- if (CreateThread())
+ if (!CreateThread())
{
- CLibCEC::AddLog(CEC_LOG_DEBUG, "communication thread started");
- return true;
+ bConnectionOpened = false;
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "could not create a communication thread");
}
- else
+ else if (!bSkipChecks && !CheckAdapter())
{
- CLibCEC::AddLog(CEC_LOG_ERROR, "could not create a communication thread");
+ bConnectionOpened = false;
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "the adapter failed to pass basic checks");
+ }
+ else if (bStartListening)
+ {
+ /* start a ping thread, that will ping the adapter every 15 seconds
+ if it doesn't receive any ping for 30 seconds, it'll switch to auto mode */
+ m_pingThread = new CAdapterPingThread(this, CEC_ADAPTER_PING_TIMEOUT);
+ if (m_pingThread->CreateThread())
+ {
+ bConnectionOpened = true;
+ }
+ else
+ {
+ bConnectionOpened = false;
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "could not create a ping thread");
+ }
}
- return false;
+ if (!bConnectionOpened || !bStartListening)
+ StopThread(0);
+
+ return bConnectionOpened;
}
void CUSBCECAdapterCommunication::Close(void)
{
+ /* stop the reader thread */
+ StopThread(0);
+
CLockObject lock(m_mutex);
- m_rcvCondition.Broadcast();
- StopThread();
-}
-void *CUSBCECAdapterCommunication::Process(void)
-{
- while (!IsStopped())
+ /* set the ackmask to 0 before closing the connection */
+ if (IsOpen() && m_port->GetErrorNumber() == 0)
{
- ReadFromDevice(50);
- Sleep(5);
- WriteNextCommand();
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - closing the connection", __FUNCTION__);
+ SetAckMask(0);
+ if (m_commands->GetFirmwareVersion() >= 2)
+ SetControlledMode(false);
}
- CCECAdapterMessage *msg(NULL);
- if (m_outBuffer.Pop(msg))
- msg->condition.Broadcast();
+ m_adapterMessageQueue->Clear();
- return NULL;
+ /* stop and delete the ping thread */
+ if (m_pingThread)
+ m_pingThread->StopThread(0);
+ delete m_pingThread;
+ m_pingThread = NULL;
+
+ /* close and delete the com port connection */
+ if (m_port)
+ m_port->Close();
}
-cec_adapter_message_state CUSBCECAdapterCommunication::Write(const cec_command &data, uint8_t iMaxTries, uint8_t iLineTimeout /* = 3 */, uint8_t iRetryLineTimeout /* = 3 */)
+cec_adapter_message_state CUSBCECAdapterCommunication::Write(const cec_command &data, bool &bRetry, uint8_t iLineTimeout)
{
cec_adapter_message_state retVal(ADAPTER_MESSAGE_STATE_UNKNOWN);
+ if (!IsRunning())
+ return retVal;
- CCECAdapterMessage *output = new CCECAdapterMessage(data);
-
- /* set the number of retries */
- if (data.opcode == CEC_OPCODE_NONE) //TODO
- output->maxTries = 1;
- else if (data.initiator != CECDEVICE_BROADCAST)
- output->maxTries = iMaxTries;
+ CCECAdapterMessage *output = new CCECAdapterMessage(data, iLineTimeout);
- output->lineTimeout = iLineTimeout;
- output->retryTimeout = iRetryLineTimeout;
- output->tries = 0;
+ /* mark as waiting for an ack from the destination */
+ MarkAsWaiting(data.destination);
- bool bRetry(true);
- while (bRetry && ++output->tries < output->maxTries)
- {
- bRetry = (!Write(output) || output->NeedsRetry()) && output->transmit_timeout > 0;
- if (bRetry)
- Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT);
- }
+ /* send the message */
+ bRetry = (!m_adapterMessageQueue->Write(output) || output->NeedsRetry()) && output->transmit_timeout > 0;
+ if (bRetry)
+ Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT);
retVal = output->state;
delete output;
return retVal;
}
-bool CUSBCECAdapterCommunication::Write(CCECAdapterMessage *data)
+void *CUSBCECAdapterCommunication::Process(void)
{
- bool bReturn(false);
-
- CLockObject lock(data->mutex);
- data->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT;
- m_outBuffer.Push(data);
- data->condition.Wait(data->mutex);
+ CCECAdapterMessage msg;
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "communication thread started");
- if (data->state != ADAPTER_MESSAGE_STATE_SENT)
- {
- CLibCEC::AddLog(CEC_LOG_ERROR, "command was not sent");
- }
- else if (data->expectControllerAck)
+ while (!IsStopped())
{
- bReturn = WaitForAck(*data);
- if (bReturn)
- {
- if (data->isTransmission)
- data->state = ADAPTER_MESSAGE_STATE_SENT_ACKED;
- }
- else
+ /* read from the serial port */
+ if (!ReadFromDevice(50, 5))
{
- data->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
- CLibCEC::AddLog(CEC_LOG_DEBUG, "did not receive ack");
+ libcec_parameter param;
+ param.paramData = NULL; param.paramType = CEC_PARAMETER_TYPE_UNKOWN;
+ LIB_CEC->Alert(CEC_ALERT_CONNECTION_LOST, param);
+
+ break;
}
- }
- else
- {
- bReturn = true;
+
+ /* TODO sleep 5 ms so other threads can get a lock */
+ Sleep(5);
}
- return bReturn;
+ m_adapterMessageQueue->Clear();
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "communication thread ended");
+ return NULL;
}
-bool CUSBCECAdapterCommunication::Read(cec_command &command, uint32_t iTimeout)
+bool CUSBCECAdapterCommunication::HandlePoll(const CCECAdapterMessage &msg)
{
- CCECAdapterMessage msg;
- if (Read(msg, iTimeout))
+ bool bIsError(msg.IsError());
+ cec_adapter_messagecode messageCode(msg.Message());
+ CLockObject lock(m_mutex);
+
+ if (messageCode == MSGCODE_FRAME_START && msg.IsACK())
{
- if (ParseMessage(msg))
+ m_lastPollDestination = msg.Destination();
+ if (msg.Destination() < CECDEVICE_BROADCAST)
{
- command = m_currentframe;
- m_currentframe.Clear();
- return true;
+ if (!m_bWaitingForAck[msg.Destination()] && !msg.IsEOM())
+ {
+ if (m_callback)
+ m_callback->HandlePoll(msg.Initiator(), msg.Destination());
+ }
+ else
+ m_bWaitingForAck[msg.Destination()] = false;
}
}
- return false;
-}
-
-bool CUSBCECAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
-{
- CLockObject lock(m_mutex);
-
- msg.Clear();
- CCECAdapterMessage *buf(NULL);
-
- if (!m_inBuffer.Pop(buf))
+ else if (messageCode == MSGCODE_RECEIVE_FAILED)
{
- if (!m_rcvCondition.Wait(m_mutex, iTimeout))
- return false;
- m_inBuffer.Pop(buf);
+ /* hack to suppress warnings when an LG is polling */
+ if (m_lastPollDestination != CECDEVICE_UNKNOWN)
+ bIsError = m_callback->HandleReceiveFailed(m_lastPollDestination);
}
- if (buf)
- {
- msg.packet = buf->packet;
- msg.state = msg.state = ADAPTER_MESSAGE_STATE_INCOMING;
- delete buf;
- return true;
- }
- return false;
+ return bIsError;
}
-CStdString CUSBCECAdapterCommunication::GetError(void) const
+void CUSBCECAdapterCommunication::MarkAsWaiting(const cec_logical_address dest)
{
- CStdString strError;
- strError = m_port->GetError();
- return strError;
+ /* mark as waiting for an ack from the destination */
+ if (dest < CECDEVICE_BROADCAST)
+ {
+ CLockObject lock(m_mutex);
+ m_bWaitingForAck[dest] = true;
+ }
}
-bool CUSBCECAdapterCommunication::StartBootloader(void)
+void CUSBCECAdapterCommunication::ClearInputBytes(uint32_t iTimeout /* = CEC_CLEAR_INPUT_DEFAULT_WAIT */)
{
- bool bReturn(false);
- if (!IsRunning())
- return bReturn;
-
- CLibCEC::AddLog(CEC_LOG_DEBUG, "starting the bootloader");
- CCECAdapterMessage *output = new CCECAdapterMessage;
-
- output->PushBack(MSGSTART);
- output->PushEscaped(MSGCODE_START_BOOTLOADER);
- output->PushBack(MSGEND);
- output->isTransmission = false;
- output->expectControllerAck = false;
-
- if ((bReturn = Write(output)) == false)
- CLibCEC::AddLog(CEC_LOG_ERROR, "could not start the bootloader");
- delete output;
+ CTimeout timeout(iTimeout);
+ uint8_t buff[1024];
+ ssize_t iBytesRead(0);
+ bool bGotMsgEnd(true);
- return bReturn;
+ while (timeout.TimeLeft() > 0 && ((iBytesRead = m_port->Read(buff, 1024, 5)) > 0 || !bGotMsgEnd))
+ {
+ bGotMsgEnd = false;
+ /* if something was received, wait for MSGEND */
+ for (ssize_t iPtr = 0; iPtr < iBytesRead; iPtr++)
+ bGotMsgEnd = buff[iPtr] == MSGEND;
+ }
}
-bool CUSBCECAdapterCommunication::PingAdapter(void)
+bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout)
{
- bool bReturn(false);
- if (!IsRunning())
- return bReturn;
-
- CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");
- CCECAdapterMessage *output = new CCECAdapterMessage;
+ bool bReturn(true);
+ bool bChanged(false);
- output->PushBack(MSGSTART);
- output->PushEscaped(MSGCODE_PING);
- output->PushBack(MSGEND);
- output->isTransmission = false;
+ /* only send the command if the timeout changed */
+ {
+ CLockObject lock(m_mutex);
+ bChanged = (m_iLineTimeout != iTimeout);
+ m_iLineTimeout = iTimeout;
+ }
- if ((bReturn = Write(output)) == false)
- CLibCEC::AddLog(CEC_LOG_ERROR, "could not ping the adapter");
- delete output;
+ if (bChanged)
+ bReturn = m_commands->SetLineTimeout(iTimeout);
return bReturn;
}
-bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage &msg)
+bool CUSBCECAdapterCommunication::WriteToDevice(CCECAdapterMessage *message)
{
- bool bEom(false);
- bool bIsError(msg.IsError());
-
- if (msg.IsEmpty())
- return bEom;
+ CLockObject adapterLock(m_mutex);
+ if (!IsOpen())
+ {
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "error writing command '%s' to serial port '%s': the connection is closed", CCECAdapterMessage::ToString(message->Message()), m_port->GetName().c_str());
+ message->state = ADAPTER_MESSAGE_STATE_ERROR;
+ return false;
+ }
- switch(msg.Message())
+ /* write the message */
+ if (m_port->Write(message->packet.data, message->Size()) != (ssize_t) message->Size())
{
- case MSGCODE_FRAME_START:
- {
- m_currentframe.Clear();
- if (msg.Size() >= 2)
- {
- m_currentframe.initiator = msg.Initiator();
- m_currentframe.destination = msg.Destination();
- m_currentframe.ack = msg.IsACK();
- m_currentframe.eom = msg.IsEOM();
- }
- if (m_currentframe.ack == 0x1)
- {
- m_lastInitiator = m_currentframe.initiator;
- m_processor->HandlePoll(m_currentframe.initiator, m_currentframe.destination);
- }
- }
- break;
- case MSGCODE_RECEIVE_FAILED:
- {
- m_currentframe.Clear();
- if (m_lastInitiator != CECDEVICE_UNKNOWN)
- bIsError = m_processor->HandleReceiveFailed(m_lastInitiator);
- }
- break;
- case MSGCODE_FRAME_DATA:
- {
- if (msg.Size() >= 2)
- {
- m_currentframe.PushBack(msg[1]);
- m_currentframe.eom = msg.IsEOM();
- }
- bEom = msg.IsEOM();
- }
- break;
- default:
- break;
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "error writing command '%s' to serial port '%s': %s", CCECAdapterMessage::ToString(message->Message()), m_port->GetName().c_str(), m_port->GetError().c_str());
+ message->state = ADAPTER_MESSAGE_STATE_ERROR;
+ // this will trigger an alert in the reader thread
+ m_port->Close();
+ return false;
}
- CLibCEC::AddLog(bIsError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
- return bEom;
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "command '%s' sent", message->IsTranmission() ? "CEC transmission" : CCECAdapterMessage::ToString(message->Message()));
+ message->state = ADAPTER_MESSAGE_STATE_SENT;
+ return true;
}
-uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
+bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout, size_t iSize /* = 256 */)
{
- uint16_t iReturn(m_iFirmwareVersion);
- if (!IsRunning())
- return iReturn;
+ ssize_t iBytesRead(0);
+ uint8_t buff[256];
+ if (iSize > 256)
+ iSize = 256;
- if (iReturn == CEC_FW_VERSION_UNKNOWN)
+ /* read from the serial port */
{
- CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
- CCECAdapterMessage *output = new CCECAdapterMessage;
-
- output->PushBack(MSGSTART);
- output->PushEscaped(MSGCODE_FIRMWARE_VERSION);
- output->PushBack(MSGEND);
- output->isTransmission = false;
- output->expectControllerAck = false;
+ CLockObject lock(m_mutex);
+ if (!IsOpen())
+ return false;
- SendMessageToAdapter(output);
- delete output;
+ iBytesRead = m_port->Read(buff, sizeof(uint8_t) * iSize, iTimeout);
- CCECAdapterMessage input;
- if (!Read(input, CEC_DEFAULT_TRANSMIT_WAIT) || input.Message() != MSGCODE_FIRMWARE_VERSION || input.Size() != 3)
- CLibCEC::AddLog(CEC_LOG_ERROR, "no or invalid firmware version (size = %d, message = %d)", input.Size(), input.Message());
- else
+ if (m_port->GetErrorNumber())
{
- m_iFirmwareVersion = (input[1] << 8 | input[2]);
- iReturn = m_iFirmwareVersion;
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "error reading from serial port: %s", m_port->GetError().c_str());
+ m_port->Close();
+ return false;
}
}
- return iReturn;
-}
+ if (iBytesRead < 0 || iBytesRead > 256)
+ return false;
+ else if (iBytesRead > 0)
+ {
+ /* add the data to the current frame */
+ m_adapterMessageQueue->AddData(buff, iBytesRead);
+ }
-bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout)
-{
- m_iLineTimeout = iTimeout;
return true;
- //TODO
-// bool bReturn(m_iLineTimeout != iTimeout);
-//
-// if (!bReturn)
-// {
-// CCECAdapterMessage *output = new CCECAdapterMessage;
-//
-// output->PushBack(MSGSTART);
-// output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
-// output->PushEscaped(iTimeout);
-// output->PushBack(MSGEND);
-// output->isTransmission = false;
-//
-// if ((bReturn = Write(output)) == false)
-// CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
-// delete output;
-// }
-//
-// return bReturn;
}
-bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask)
+CCECAdapterMessage *CUSBCECAdapterCommunication::SendCommand(cec_adapter_messagecode msgCode, CCECAdapterMessage ¶ms, bool bIsRetry /* = false */)
{
- bool bReturn(false);
- CStdString strLog;
- strLog.Format("setting ackmask to %2x", iMask);
- CLibCEC::AddLog(CEC_LOG_DEBUG, strLog.c_str());
+ if (!IsOpen() || !m_adapterMessageQueue)
+ return NULL;
+ /* create the adapter message for this command */
CCECAdapterMessage *output = new CCECAdapterMessage;
-
output->PushBack(MSGSTART);
- output->PushEscaped(MSGCODE_SET_ACK_MASK);
- output->PushEscaped(iMask >> 8);
- output->PushEscaped((uint8_t)iMask);
+ output->PushEscaped((uint8_t)msgCode);
+ output->Append(params);
output->PushBack(MSGEND);
- output->isTransmission = false;
- if ((bReturn = Write(output)) == false)
- CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the ackmask");
- delete output;
+ /* write the command */
+ if (!m_adapterMessageQueue->Write(output))
+ {
+ // this will trigger an alert in the reader thread
+ if (output->state == ADAPTER_MESSAGE_STATE_ERROR)
+ m_port->Close();
+ return output;
+ }
+ else
+ {
+ if (!bIsRetry && output->Reply() == MSGCODE_COMMAND_REJECTED && msgCode != MSGCODE_SET_CONTROLLED &&
+ msgCode != MSGCODE_GET_BUILDDATE /* same messagecode value had a different meaning in older fw builds */)
+ {
+ /* if the controller reported that the command was rejected, and we didn't send the command
+ to set controlled mode, then the controller probably switched to auto mode. set controlled
+ mode and retry */
+ LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting controlled mode and retrying");
+ delete output;
+ if (SetControlledMode(true))
+ return SendCommand(msgCode, params, true);
+ }
+ }
- return bReturn;
+ return output;
}
-
-bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
+bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs /* = CEC_DEFAULT_CONNECT_TIMEOUT */)
{
bool bReturn(false);
- CStdString strLog;
- strLog.Format("turning controlled mode %s", controlled ? "on" : "off");
- CLibCEC::AddLog(CEC_LOG_DEBUG, strLog.c_str());
+ CTimeout timeout(iTimeoutMs > 0 ? iTimeoutMs : CEC_DEFAULT_TRANSMIT_WAIT);
- CCECAdapterMessage *output = new CCECAdapterMessage;
+ /* try to ping the adapter */
+ bool bPinged(false);
+ unsigned iPingTry(0);
+ while (timeout.TimeLeft() > 0 && (bPinged = PingAdapter()) == false)
+ {
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry);
+ CEvent::Sleep(500);
+ }
- output->PushBack(MSGSTART);
- output->PushEscaped(MSGCODE_SET_CONTROLLED);
- output->PushEscaped(controlled);
- output->PushBack(MSGEND);
- output->isTransmission = false;
+ /* try to read the firmware version */
+ if (bPinged && timeout.TimeLeft() > 0 && m_commands->RequestFirmwareVersion() >= 2)
+ {
+ /* try to set controlled mode for v2+ firmwares */
+ unsigned iControlledTry(0);
+ bool bControlled(false);
+ while (timeout.TimeLeft() > 0 && (bControlled = SetControlledMode(true)) == false)
+ {
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry);
+ CEvent::Sleep(500);
+ }
+ bReturn = bControlled;
+ }
+ else
+ bReturn = true;
- if ((bReturn = Write(output)) == false)
- CLibCEC::AddLog(CEC_LOG_ERROR, "could not set controlled mode");
- delete output;
+ /* try to read the build date */
+ m_commands->RequestBuildDate();
+ SetInitialised(bReturn);
return bReturn;
}
bool CUSBCECAdapterCommunication::IsOpen(void)
{
+ /* thread is not being stopped, the port is open and the thread is running */
return !IsStopped() && m_port->IsOpen() && IsRunning();
}
-bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage &message)
+CStdString CUSBCECAdapterCommunication::GetError(void) const
+{
+ return m_port->GetError();
+}
+
+void CUSBCECAdapterCommunication::SetInitialised(bool bSetTo /* = true */)
{
- bool bError(false);
- bool bTransmitSucceeded(false);
- uint8_t iPacketsLeft(message.Size() / 4);
+ CLockObject lock(m_mutex);
+ m_bInitialised = bSetTo;
+}
- int64_t iNow = GetTimeMs();
- int64_t iTargetTime = iNow + message.transmit_timeout;
+bool CUSBCECAdapterCommunication::IsInitialised(void)
+{
+ CLockObject lock(m_mutex);
+ return m_bInitialised;
+}
- while (!bTransmitSucceeded && !bError && (message.transmit_timeout == 0 || iNow < iTargetTime))
+bool CUSBCECAdapterCommunication::StartBootloader(void)
+{
+ if (m_port->IsOpen() && m_commands->StartBootloader())
{
- CCECAdapterMessage msg;
- int32_t iWait = (int32_t)(iTargetTime - iNow);
- if (iWait <= 5 || message.transmit_timeout <= 5)
- iWait = CEC_DEFAULT_TRANSMIT_WAIT;
+ m_port->Close();
+ return true;
+ }
+ return false;
+}
- if (!Read(msg, iWait))
- {
- iNow = GetTimeMs();
- continue;
- }
+bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask)
+{
+ if (m_iAckMask == iMask)
+ return true;
- if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK())
- {
- m_processor->HandlePoll(msg.Initiator(), msg.Destination());
- m_lastInitiator = msg.Initiator();
- iNow = GetTimeMs();
- continue;
- }
+ if (IsOpen() && m_commands->SetAckMask(iMask))
+ {
+ m_iAckMask = iMask;
+ return true;
+ }
- if (msg.Message() == MSGCODE_RECEIVE_FAILED &&
- m_lastInitiator != CECDEVICE_UNKNOWN &&
- m_processor->HandleReceiveFailed(m_lastInitiator))
- {
- iNow = GetTimeMs();
- continue;
- }
+ LIB_CEC->AddLog(CEC_LOG_ERROR, "couldn't change the ackmask: the connection is closed");
+ return false;
+}
- bError = msg.IsError();
- if (bError)
- {
- message.reply = msg.Message();
- CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
- }
- else
- {
- 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;
- break;
- case MSGCODE_TRANSMIT_SUCCEEDED:
- CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
- bTransmitSucceeded = (iPacketsLeft == 0);
- bError = !bTransmitSucceeded;
- message.reply = MSGCODE_TRANSMIT_SUCCEEDED;
- break;
- default:
- // ignore other data while waiting
- break;
- }
+uint16_t CUSBCECAdapterCommunication::GetAckMask(void)
+{
+ return m_iAckMask;
+}
- iNow = GetTimeMs();
- }
- }
+bool CUSBCECAdapterCommunication::PingAdapter(void)
+{
+ return IsOpen() ? m_commands->PingAdapter() : false;
+}
- return bTransmitSucceeded && !bError;
+uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
+{
+ return IsOpen() ? m_commands->GetFirmwareVersion() : CEC_FW_VERSION_UNKNOWN;
}
-void CUSBCECAdapterCommunication::AddData(uint8_t *data, size_t iLen)
+uint32_t CUSBCECAdapterCommunication::GetFirmwareBuildDate(void)
{
- CLockObject lock(m_mutex);
- for (size_t iPtr = 0; iPtr < iLen; iPtr++)
- {
- if (!m_bGotStart)
- {
- if (data[iPtr] == MSGSTART)
- m_bGotStart = true;
- }
- else if (data[iPtr] == MSGSTART) //we found a msgstart before msgend, this is not right, remove
- {
- if (m_currentAdapterMessage.Size() > 0)
- CLibCEC::AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents");
- m_currentAdapterMessage.Clear();
- m_bGotStart = true;
- }
- else if (data[iPtr] == MSGEND)
- {
- CCECAdapterMessage *newMessage = new CCECAdapterMessage;
- newMessage->packet = m_currentAdapterMessage.packet;
- m_inBuffer.Push(newMessage);
- m_currentAdapterMessage.Clear();
- m_bGotStart = false;
- m_bNextIsEscaped = false;
- m_rcvCondition.Signal();
- }
- else if (m_bNextIsEscaped)
- {
- m_currentAdapterMessage.PushBack(data[iPtr] + (uint8_t)ESCOFFSET);
- m_bNextIsEscaped = false;
- }
- else if (data[iPtr] == MSGESC)
- {
- m_bNextIsEscaped = true;
- }
- else
- {
- m_currentAdapterMessage.PushBack(data[iPtr]);
- }
- }
+ return IsOpen() ? m_commands->RequestBuildDate() : 0;
}
-bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
+bool CUSBCECAdapterCommunication::IsRunningLatestFirmware(void)
{
- ssize_t iBytesRead;
- uint8_t buff[256];
- if (!m_port)
- return false;
+ return GetFirmwareVersion() >= CEC_LATEST_ADAPTER_FW_VERSION &&
+ GetFirmwareBuildDate() >= CEC_LATEST_ADAPTER_FW_DATE;
+}
- CLockObject lock(m_mutex);
- iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
- if (iBytesRead < 0 || iBytesRead > 256)
- {
- CLibCEC::AddLog(CEC_LOG_ERROR, "error reading from serial port: %s", m_port->GetError().c_str());
- return false;
- }
- else if (iBytesRead > 0)
- {
- AddData(buff, iBytesRead);
- }
+bool CUSBCECAdapterCommunication::PersistConfiguration(const libcec_configuration &configuration)
+{
+ return IsOpen() ? m_commands->PersistConfiguration(configuration) : false;
+}
- return iBytesRead > 0;
+bool CUSBCECAdapterCommunication::GetConfiguration(libcec_configuration &configuration)
+{
+ return IsOpen() ? m_commands->GetConfiguration(configuration) : false;
}
-void CUSBCECAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg)
+CStdString CUSBCECAdapterCommunication::GetPortName(void)
{
- CLockObject adapterLock(m_mutex);
- CLockObject lock(msg->mutex);
- if (msg->tries == 1)
- SetLineTimeout(msg->lineTimeout);
- else
- SetLineTimeout(msg->retryTimeout);
+ return m_port->GetName();
+}
- if (m_port->Write(msg->packet.data, msg->Size()) != (ssize_t) msg->Size())
- {
- CStdString strError;
- strError.Format("error writing to serial port: %s", m_port->GetError().c_str());
- CLibCEC::AddLog(CEC_LOG_ERROR, strError);
- msg->state = ADAPTER_MESSAGE_STATE_ERROR;
- }
- else
- {
- CLibCEC::AddLog(CEC_LOG_DEBUG, "command sent");
- msg->state = ADAPTER_MESSAGE_STATE_SENT;
- }
- msg->condition.Signal();
+bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
+{
+ return IsOpen() ? m_commands->SetControlledMode(controlled) : false;
}
-void CUSBCECAdapterCommunication::WriteNextCommand(void)
+void *CAdapterPingThread::Process(void)
{
- CCECAdapterMessage *msg(NULL);
- if (m_outBuffer.Pop(msg))
- SendMessageToAdapter(msg);
+ while (!IsStopped())
+ {
+ if (m_timeout.TimeLeft() == 0)
+ {
+ /* reinit the timeout */
+ m_timeout.Init(CEC_ADAPTER_PING_TIMEOUT);
+
+ /* send a ping to the adapter */
+ bool bPinged(false);
+ int iFailedCounter(0);
+ while (!bPinged && iFailedCounter < 3)
+ {
+ if (!m_com->PingAdapter())
+ {
+ /* sleep and retry */
+ Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT);
+ ++iFailedCounter;
+ }
+ else
+ {
+ bPinged = true;
+ }
+ }
+
+ if (iFailedCounter == 3)
+ {
+ /* failed to ping the adapter 3 times in a row. something must be wrong with the connection */
+ m_com->LIB_CEC->AddLog(CEC_LOG_ERROR, "failed to ping the adapter 3 times in a row. closing the connection.");
+ m_com->StopThread(false);
+ break;
+ }
+ }
+
+ Sleep(500);
+ }
+ return NULL;
}