2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
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/
33 #include "USBCECAdapterCommunication.h"
34 #include "../platform/sockets/serialport.h"
35 #include "../platform/util/timeutils.h"
36 #include "../LibCEC.h"
37 #include "../CECProcessor.h"
41 using namespace PLATFORM
;
43 CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(CCECProcessor
*processor
, const char *strPort
, uint16_t iBaudRate
/* = 38400 */) :
45 m_processor(processor
),
48 m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN
),
49 m_lastInitiator(CECDEVICE_UNKNOWN
),
50 m_bNextIsEscaped(false),
53 m_port
= new PLATFORM::CSerialPort(strPort
, iBaudRate
);
56 CUSBCECAdapterCommunication::~CUSBCECAdapterCommunication(void)
61 bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs
/* = 10000 */)
64 uint64_t iNow
= GetTimeMs();
65 uint64_t iTarget
= iTimeoutMs
> 0 ? iNow
+ iTimeoutMs
: iNow
+ CEC_DEFAULT_TRANSMIT_WAIT
;
67 /* try to ping the adapter */
70 while (iNow
< iTarget
&& (bPinged
= PingAdapter()) == false)
72 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry
);
77 /* try to read the firmware version */
78 m_iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
79 unsigned iFwVersionTry(0);
80 while (bPinged
&& iNow
< iTarget
&& (m_iFirmwareVersion
= GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN
)
82 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry
);
87 if (m_iFirmwareVersion
>= 2)
89 /* try to set controlled mode */
90 unsigned iControlledTry(0);
91 bool bControlled(false);
92 while (iNow
< iTarget
&& (bControlled
= SetControlledMode(true)) == false)
94 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry
);
98 bReturn
= bControlled
;
106 bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback
*cb
, uint32_t iTimeoutMs
/* = 10000 */)
108 uint64_t iNow
= GetTimeMs();
109 uint64_t iTimeout
= iNow
+ iTimeoutMs
;
112 CLockObject
lock(m_mutex
);
116 CLibCEC::AddLog(CEC_LOG_ERROR
, "port is NULL");
122 CLibCEC::AddLog(CEC_LOG_ERROR
, "port is already open");
128 bool bConnected(false);
129 while (!bConnected
&& iNow
< iTimeout
)
131 if ((bConnected
= m_port
->Open(iTimeout
)) == false)
133 strError
.Format("error opening serial port '%s': %s", m_port
->GetName().c_str(), m_port
->GetError().c_str());
141 CLibCEC::AddLog(CEC_LOG_ERROR
, strError
);
145 CLibCEC::AddLog(CEC_LOG_DEBUG
, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
147 //clear any input bytes
149 while (m_port
->Read(buff
, 1024, 100) > 0)
151 CLibCEC::AddLog(CEC_LOG_DEBUG
, "data received, clearing it");
161 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter failed to pass basic checks");
165 CLibCEC::AddLog(CEC_LOG_DEBUG
, "communication thread started");
169 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not create a communication thread");
174 void CUSBCECAdapterCommunication::Close(void)
179 void *CUSBCECAdapterCommunication::Process(void)
182 bool bCommandReceived(false);
186 CLockObject
lock(m_mutex
);
188 bCommandReceived
= m_callback
&& Read(command
, 0);
191 /* push the next command to the callback method if there is one */
192 if (!IsStopped() && bCommandReceived
)
193 m_callback
->OnCommandReceived(command
);
202 /* notify all threads that are waiting on messages to be sent */
203 CCECAdapterMessage
*msg(NULL
);
204 while (m_outBuffer
.Pop(msg
))
205 msg
->event
.Broadcast();
207 /* set the ackmask to 0 before closing the connection */
208 SetAckMaskInternal(0, true);
219 cec_adapter_message_state
CUSBCECAdapterCommunication::Write(const cec_command
&data
, uint8_t iMaxTries
, uint8_t iLineTimeout
/* = 3 */, uint8_t iRetryLineTimeout
/* = 3 */)
221 cec_adapter_message_state
retVal(ADAPTER_MESSAGE_STATE_UNKNOWN
);
225 CCECAdapterMessage
*output
= new CCECAdapterMessage(data
);
227 /* set the number of retries */
228 if (data
.opcode
== CEC_OPCODE_NONE
) //TODO
229 output
->maxTries
= 1;
230 else if (data
.initiator
!= CECDEVICE_BROADCAST
)
231 output
->maxTries
= iMaxTries
;
233 output
->lineTimeout
= iLineTimeout
;
234 output
->retryTimeout
= iRetryLineTimeout
;
238 while (bRetry
&& ++output
->tries
< output
->maxTries
)
240 bRetry
= (!Write(output
) || output
->NeedsRetry()) && output
->transmit_timeout
> 0;
242 Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT
);
244 retVal
= output
->state
;
250 bool CUSBCECAdapterCommunication::Write(CCECAdapterMessage
*data
)
252 data
->state
= ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
;
253 m_outBuffer
.Push(data
);
254 data
->event
.Wait(5000);
256 if ((data
->expectControllerAck
&& data
->state
!= ADAPTER_MESSAGE_STATE_SENT_ACKED
) ||
257 (!data
->expectControllerAck
&& data
->state
!= ADAPTER_MESSAGE_STATE_SENT
))
259 CLibCEC::AddLog(CEC_LOG_DEBUG
, "command was not %s", data
->state
== ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
? "acked" : "sent");
266 bool CUSBCECAdapterCommunication::Read(cec_command
&command
, uint32_t iTimeout
)
271 CCECAdapterMessage msg
;
272 if (Read(msg
, iTimeout
))
274 if (ParseMessage(msg
))
276 command
= m_currentframe
;
277 m_currentframe
.Clear();
284 bool CUSBCECAdapterCommunication::Read(CCECAdapterMessage
&msg
, uint32_t iTimeout
)
286 CLockObject
lock(m_mutex
);
289 CCECAdapterMessage
*buf(NULL
);
291 if (!m_inBuffer
.Pop(buf
))
293 if (iTimeout
== 0 || !m_rcvCondition
.Wait(m_mutex
, m_bHasData
, iTimeout
))
296 m_bHasData
= m_inBuffer
.Size() > 0;
301 msg
.packet
= buf
->packet
;
302 msg
.state
= ADAPTER_MESSAGE_STATE_INCOMING
;
309 CStdString
CUSBCECAdapterCommunication::GetError(void) const
312 strError
= m_port
->GetError();
316 bool CUSBCECAdapterCommunication::StartBootloader(void)
322 CLibCEC::AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
323 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
325 output
->PushBack(MSGSTART
);
326 output
->PushEscaped(MSGCODE_START_BOOTLOADER
);
327 output
->PushBack(MSGEND
);
328 output
->isTransmission
= false;
329 output
->expectControllerAck
= false;
331 if ((bReturn
= Write(output
)) == false)
332 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not start the bootloader");
338 bool CUSBCECAdapterCommunication::PingAdapter(void)
344 CLibCEC::AddLog(CEC_LOG_DEBUG
, "sending ping");
345 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
347 output
->PushBack(MSGSTART
);
348 output
->PushEscaped(MSGCODE_PING
);
349 output
->PushBack(MSGEND
);
350 output
->isTransmission
= false;
352 if ((bReturn
= Write(output
)) == false)
353 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not ping the adapter");
359 bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage
&msg
)
362 bool bIsError(msg
.IsError());
367 switch(msg
.Message())
369 case MSGCODE_FRAME_START
:
371 m_currentframe
.Clear();
374 m_currentframe
.initiator
= msg
.Initiator();
375 m_currentframe
.destination
= msg
.Destination();
376 m_currentframe
.ack
= msg
.IsACK();
377 m_currentframe
.eom
= msg
.IsEOM();
379 if (m_currentframe
.ack
== 0x1)
381 m_lastInitiator
= m_currentframe
.initiator
;
382 m_processor
->HandlePoll(m_currentframe
.initiator
, m_currentframe
.destination
);
386 case MSGCODE_RECEIVE_FAILED
:
388 m_currentframe
.Clear();
389 if (m_lastInitiator
!= CECDEVICE_UNKNOWN
)
390 bIsError
= m_processor
->HandleReceiveFailed(m_lastInitiator
);
393 case MSGCODE_FRAME_DATA
:
397 m_currentframe
.PushBack(msg
[1]);
398 m_currentframe
.eom
= msg
.IsEOM();
407 CLibCEC::AddLog(bIsError
? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
411 uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
413 uint16_t iReturn(m_iFirmwareVersion
);
417 if (iReturn
== CEC_FW_VERSION_UNKNOWN
)
419 CLockObject
lock(m_mutex
);
420 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
421 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
423 output
->PushBack(MSGSTART
);
424 output
->PushEscaped(MSGCODE_FIRMWARE_VERSION
);
425 output
->PushBack(MSGEND
);
426 output
->isTransmission
= false;
427 output
->expectControllerAck
= false;
429 SendMessageToAdapter(output
);
430 bool bWriteOk
= output
->state
== ADAPTER_MESSAGE_STATE_SENT
;
434 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not request the firmware version");
438 Sleep(250); // TODO ReadFromDevice() isn't waiting for the timeout to pass on win32
439 ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT
, 5 /* start + msgcode + 2 bytes for fw version + end */);
440 CCECAdapterMessage input
;
443 if (input
.Message() != MSGCODE_FIRMWARE_VERSION
|| input
.Size() != 3)
444 CLibCEC::AddLog(CEC_LOG_ERROR
, "invalid firmware version (size = %d, message = %d)", input
.Size(), input
.Message());
447 m_iFirmwareVersion
= (input
[1] << 8 | input
[2]);
448 iReturn
= m_iFirmwareVersion
;
453 CLibCEC::AddLog(CEC_LOG_ERROR
, "no firmware version received");
460 bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout
)
462 m_iLineTimeout
= iTimeout
;
465 // bool bReturn(m_iLineTimeout != iTimeout);
469 // CCECAdapterMessage *output = new CCECAdapterMessage;
471 // output->PushBack(MSGSTART);
472 // output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
473 // output->PushEscaped(iTimeout);
474 // output->PushBack(MSGEND);
475 // output->isTransmission = false;
477 // if ((bReturn = Write(output)) == false)
478 // CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
485 bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask
)
487 return SetAckMaskInternal(iMask
, false);
490 bool CUSBCECAdapterCommunication::SetAckMaskInternal(uint16_t iMask
, bool bWriteDirectly
/* = false */)
493 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
495 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
497 output
->PushBack(MSGSTART
);
498 output
->PushEscaped(MSGCODE_SET_ACK_MASK
);
499 output
->PushEscaped(iMask
>> 8);
500 output
->PushEscaped((uint8_t)iMask
);
501 output
->PushBack(MSGEND
);
502 output
->isTransmission
= false;
505 SendMessageToAdapter(output
);
506 else if ((bReturn
= Write(output
)) == false)
507 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not set the ackmask");
514 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled
)
517 CLibCEC::AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
519 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
521 output
->PushBack(MSGSTART
);
522 output
->PushEscaped(MSGCODE_SET_CONTROLLED
);
523 output
->PushEscaped(controlled
);
524 output
->PushBack(MSGEND
);
525 output
->isTransmission
= false;
527 if ((bReturn
= Write(output
)) == false)
528 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not set controlled mode");
534 bool CUSBCECAdapterCommunication::IsOpen(void)
536 return !IsStopped() && m_port
->IsOpen() && IsRunning();
539 bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage
&message
)
542 bool bTransmitSucceeded(false);
543 uint8_t iPacketsLeft(message
.Size() / 4);
545 int64_t iNow
= GetTimeMs();
546 int64_t iTargetTime
= iNow
+ (message
.transmit_timeout
<= 5 ? CEC_DEFAULT_TRANSMIT_WAIT
: message
.transmit_timeout
);
548 while (!bTransmitSucceeded
&& !bError
&& iNow
< iTargetTime
)
551 CCECAdapterMessage msg
;
558 if (msg
.Message() == MSGCODE_FRAME_START
&& msg
.IsACK())
560 m_processor
->HandlePoll(msg
.Initiator(), msg
.Destination());
561 m_lastInitiator
= msg
.Initiator();
566 if (msg
.Message() == MSGCODE_RECEIVE_FAILED
&&
567 m_lastInitiator
!= CECDEVICE_UNKNOWN
&&
568 m_processor
->HandleReceiveFailed(m_lastInitiator
))
574 bError
= msg
.IsError();
577 message
.reply
= msg
.Message();
578 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
582 switch(msg
.Message())
584 case MSGCODE_COMMAND_ACCEPTED
:
585 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
586 if (iPacketsLeft
> 0)
588 if (!message
.isTransmission
&& iPacketsLeft
== 0)
589 bTransmitSucceeded
= true;
591 case MSGCODE_TRANSMIT_SUCCEEDED
:
592 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
593 bTransmitSucceeded
= (iPacketsLeft
== 0);
594 bError
= !bTransmitSucceeded
;
595 message
.reply
= MSGCODE_TRANSMIT_SUCCEEDED
;
598 // ignore other data while waiting
606 message
.state
= bTransmitSucceeded
&& !bError
?
607 ADAPTER_MESSAGE_STATE_SENT_ACKED
:
608 ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
610 return bTransmitSucceeded
&& !bError
;
613 void CUSBCECAdapterCommunication::AddData(uint8_t *data
, size_t iLen
)
615 CLockObject
lock(m_mutex
);
616 for (size_t iPtr
= 0; iPtr
< iLen
; iPtr
++)
620 if (data
[iPtr
] == MSGSTART
)
623 else if (data
[iPtr
] == MSGSTART
) //we found a msgstart before msgend, this is not right, remove
625 if (m_currentAdapterMessage
.Size() > 0)
626 CLibCEC::AddLog(CEC_LOG_WARNING
, "received MSGSTART before MSGEND, removing previous buffer contents");
627 m_currentAdapterMessage
.Clear();
630 else if (data
[iPtr
] == MSGEND
)
632 CCECAdapterMessage
*newMessage
= new CCECAdapterMessage
;
633 newMessage
->packet
= m_currentAdapterMessage
.packet
;
634 m_inBuffer
.Push(newMessage
);
635 m_currentAdapterMessage
.Clear();
637 m_bNextIsEscaped
= false;
639 m_rcvCondition
.Signal();
641 else if (m_bNextIsEscaped
)
643 m_currentAdapterMessage
.PushBack(data
[iPtr
] + (uint8_t)ESCOFFSET
);
644 m_bNextIsEscaped
= false;
646 else if (data
[iPtr
] == MSGESC
)
648 m_bNextIsEscaped
= true;
652 m_currentAdapterMessage
.PushBack(data
[iPtr
]);
657 bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout
, size_t iSize
/* = 256 */)
666 CLockObject
lock(m_mutex
);
667 iBytesRead
= m_port
->Read(buff
, sizeof(uint8_t) * iSize
, iTimeout
);
668 if (iBytesRead
< 0 || iBytesRead
> 256)
670 CLibCEC::AddLog(CEC_LOG_ERROR
, "error reading from serial port: %s", m_port
->GetError().c_str());
674 else if (iBytesRead
> 0)
676 AddData(buff
, iBytesRead
);
679 return iBytesRead
> 0;
682 void CUSBCECAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage
*msg
)
684 CLockObject
adapterLock(m_mutex
);
685 if (!m_port
->IsOpen())
687 CLibCEC::AddLog(CEC_LOG_ERROR
, "error writing to serial port: the connection is closed");
688 msg
->state
= ADAPTER_MESSAGE_STATE_ERROR
;
693 SetLineTimeout(msg
->lineTimeout
);
695 SetLineTimeout(msg
->retryTimeout
);
697 if (m_port
->Write(msg
->packet
.data
, msg
->Size()) != (ssize_t
) msg
->Size())
699 CLibCEC::AddLog(CEC_LOG_ERROR
, "error writing to serial port: %s", m_port
->GetError().c_str());
700 msg
->state
= ADAPTER_MESSAGE_STATE_ERROR
;
704 CLibCEC::AddLog(CEC_LOG_DEBUG
, "command sent");
705 msg
->state
= ADAPTER_MESSAGE_STATE_SENT
;
707 if (msg
->expectControllerAck
)
709 if (!WaitForAck(*msg
))
710 CLibCEC::AddLog(CEC_LOG_DEBUG
, "did not receive ack");
716 void CUSBCECAdapterCommunication::WriteNextCommand(void)
718 CCECAdapterMessage
*msg(NULL
);
719 if (m_outBuffer
.Pop(msg
))
720 SendMessageToAdapter(msg
);
723 CStdString
CUSBCECAdapterCommunication::GetPortName(void)
726 strName
= m_port
->GetName();