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
),
47 m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN
),
48 m_lastInitiator(CECDEVICE_UNKNOWN
),
49 m_bNextIsEscaped(false),
52 m_port
= new PLATFORM::CSerialPort(strPort
, iBaudRate
);
55 CUSBCECAdapterCommunication::~CUSBCECAdapterCommunication(void)
60 bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs
/* = 10000 */)
63 uint64_t iNow
= GetTimeMs();
64 uint64_t iTarget
= iTimeoutMs
> 0 ? iNow
+ iTimeoutMs
: iNow
+ CEC_DEFAULT_TRANSMIT_WAIT
;
66 /* try to ping the adapter */
69 while (iNow
< iTarget
&& (bPinged
= PingAdapter()) == false)
71 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry
);
76 /* try to read the firmware version */
77 m_iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
78 unsigned iFwVersionTry(0);
79 while (bPinged
&& iNow
< iTarget
&& (m_iFirmwareVersion
= GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN
)
81 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry
);
86 if (m_iFirmwareVersion
>= 2)
88 /* try to set controlled mode */
89 unsigned iControlledTry(0);
90 bool bControlled(false);
91 while (iNow
< iTarget
&& (bControlled
= SetControlledMode(true)) == false)
93 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry
);
97 bReturn
= bControlled
;
105 bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback
*cb
, uint32_t iTimeoutMs
/* = 10000 */)
107 uint64_t iNow
= GetTimeMs();
108 uint64_t iTimeout
= iNow
+ iTimeoutMs
;
111 CLockObject
lock(m_mutex
);
115 CLibCEC::AddLog(CEC_LOG_ERROR
, "port is NULL");
121 CLibCEC::AddLog(CEC_LOG_ERROR
, "port is already open");
127 bool bConnected(false);
128 while (!bConnected
&& iNow
< iTimeout
)
130 if ((bConnected
= m_port
->Open(iTimeout
)) == false)
132 strError
.Format("error opening serial port '%s': %s", m_port
->GetName().c_str(), m_port
->GetError().c_str());
140 CLibCEC::AddLog(CEC_LOG_ERROR
, strError
);
144 CLibCEC::AddLog(CEC_LOG_DEBUG
, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
146 //clear any input bytes
148 while (m_port
->Read(buff
, 1024, 100) > 0)
150 CLibCEC::AddLog(CEC_LOG_DEBUG
, "data received, clearing it");
160 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter failed to pass basic checks");
164 CLibCEC::AddLog(CEC_LOG_DEBUG
, "communication thread started");
168 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not create a communication thread");
173 void CUSBCECAdapterCommunication::Close(void)
175 CLockObject
lock(m_mutex
);
176 m_rcvCondition
.Broadcast();
180 void *CUSBCECAdapterCommunication::Process(void)
183 bool bCommandReceived(false);
187 CLockObject
lock(m_mutex
);
189 bCommandReceived
= m_callback
&& Read(command
, 0);
192 /* push the next command to the callback method if there is one */
193 if (!IsStopped() && bCommandReceived
)
194 m_callback
->OnCommandReceived(command
);
203 CCECAdapterMessage
*msg(NULL
);
204 if (m_outBuffer
.Pop(msg
))
205 msg
->condition
.Broadcast();
216 cec_adapter_message_state
CUSBCECAdapterCommunication::Write(const cec_command
&data
, uint8_t iMaxTries
, uint8_t iLineTimeout
/* = 3 */, uint8_t iRetryLineTimeout
/* = 3 */)
218 cec_adapter_message_state
retVal(ADAPTER_MESSAGE_STATE_UNKNOWN
);
220 CCECAdapterMessage
*output
= new CCECAdapterMessage(data
);
222 /* set the number of retries */
223 if (data
.opcode
== CEC_OPCODE_NONE
) //TODO
224 output
->maxTries
= 1;
225 else if (data
.initiator
!= CECDEVICE_BROADCAST
)
226 output
->maxTries
= iMaxTries
;
228 output
->lineTimeout
= iLineTimeout
;
229 output
->retryTimeout
= iRetryLineTimeout
;
233 while (bRetry
&& ++output
->tries
< output
->maxTries
)
235 bRetry
= (!Write(output
) || output
->NeedsRetry()) && output
->transmit_timeout
> 0;
237 Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT
);
239 retVal
= output
->state
;
245 bool CUSBCECAdapterCommunication::Write(CCECAdapterMessage
*data
)
247 CLockObject
lock(data
->mutex
);
248 data
->state
= ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
;
249 m_outBuffer
.Push(data
);
250 data
->condition
.Wait(data
->mutex
);
252 if ((data
->expectControllerAck
&& data
->state
!= ADAPTER_MESSAGE_STATE_SENT_ACKED
) ||
253 (!data
->expectControllerAck
&& data
->state
!= ADAPTER_MESSAGE_STATE_SENT
))
255 CLibCEC::AddLog(CEC_LOG_DEBUG
, "command was not %s", data
->state
== ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
? "acked" : "sent");
262 bool CUSBCECAdapterCommunication::Read(cec_command
&command
, uint32_t iTimeout
)
264 CCECAdapterMessage msg
;
265 if (Read(msg
, iTimeout
))
267 if (ParseMessage(msg
))
269 command
= m_currentframe
;
270 m_currentframe
.Clear();
277 bool CUSBCECAdapterCommunication::Read(CCECAdapterMessage
&msg
, uint32_t iTimeout
)
279 CLockObject
lock(m_mutex
);
282 CCECAdapterMessage
*buf(NULL
);
284 if (!m_inBuffer
.Pop(buf
))
286 if (iTimeout
== 0 || !m_rcvCondition
.Wait(m_mutex
, iTimeout
))
293 msg
.packet
= buf
->packet
;
294 msg
.state
= ADAPTER_MESSAGE_STATE_INCOMING
;
301 CStdString
CUSBCECAdapterCommunication::GetError(void) const
304 strError
= m_port
->GetError();
308 bool CUSBCECAdapterCommunication::StartBootloader(void)
314 CLibCEC::AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
315 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
317 output
->PushBack(MSGSTART
);
318 output
->PushEscaped(MSGCODE_START_BOOTLOADER
);
319 output
->PushBack(MSGEND
);
320 output
->isTransmission
= false;
321 output
->expectControllerAck
= false;
323 if ((bReturn
= Write(output
)) == false)
324 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not start the bootloader");
330 bool CUSBCECAdapterCommunication::PingAdapter(void)
336 CLibCEC::AddLog(CEC_LOG_DEBUG
, "sending ping");
337 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
339 output
->PushBack(MSGSTART
);
340 output
->PushEscaped(MSGCODE_PING
);
341 output
->PushBack(MSGEND
);
342 output
->isTransmission
= false;
344 if ((bReturn
= Write(output
)) == false)
345 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not ping the adapter");
351 bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage
&msg
)
354 bool bIsError(msg
.IsError());
359 switch(msg
.Message())
361 case MSGCODE_FRAME_START
:
363 m_currentframe
.Clear();
366 m_currentframe
.initiator
= msg
.Initiator();
367 m_currentframe
.destination
= msg
.Destination();
368 m_currentframe
.ack
= msg
.IsACK();
369 m_currentframe
.eom
= msg
.IsEOM();
371 if (m_currentframe
.ack
== 0x1)
373 m_lastInitiator
= m_currentframe
.initiator
;
374 m_processor
->HandlePoll(m_currentframe
.initiator
, m_currentframe
.destination
);
378 case MSGCODE_RECEIVE_FAILED
:
380 m_currentframe
.Clear();
381 if (m_lastInitiator
!= CECDEVICE_UNKNOWN
)
382 bIsError
= m_processor
->HandleReceiveFailed(m_lastInitiator
);
385 case MSGCODE_FRAME_DATA
:
389 m_currentframe
.PushBack(msg
[1]);
390 m_currentframe
.eom
= msg
.IsEOM();
399 CLibCEC::AddLog(bIsError
? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
403 uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
405 CLockObject
lock(m_mutex
);
406 uint16_t iReturn(m_iFirmwareVersion
);
410 if (iReturn
== CEC_FW_VERSION_UNKNOWN
)
412 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
413 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
415 output
->PushBack(MSGSTART
);
416 output
->PushEscaped(MSGCODE_FIRMWARE_VERSION
);
417 output
->PushBack(MSGEND
);
418 output
->isTransmission
= false;
419 output
->expectControllerAck
= false;
421 SendMessageToAdapter(output
);
422 bool bWriteOk
= output
->state
== ADAPTER_MESSAGE_STATE_SENT
;
426 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not request the firmware version");
430 Sleep(250); // TODO ReadFromDevice() isn't waiting for the timeout to pass on win32
431 ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT
, 5 /* start + msgcode + 2 bytes for fw version + end */);
432 CCECAdapterMessage input
;
435 if (input
.Message() != MSGCODE_FIRMWARE_VERSION
|| input
.Size() != 3)
436 CLibCEC::AddLog(CEC_LOG_ERROR
, "invalid firmware version (size = %d, message = %d)", input
.Size(), input
.Message());
439 m_iFirmwareVersion
= (input
[1] << 8 | input
[2]);
440 iReturn
= m_iFirmwareVersion
;
445 CLibCEC::AddLog(CEC_LOG_ERROR
, "no firmware version received");
452 bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout
)
454 m_iLineTimeout
= iTimeout
;
457 // bool bReturn(m_iLineTimeout != iTimeout);
461 // CCECAdapterMessage *output = new CCECAdapterMessage;
463 // output->PushBack(MSGSTART);
464 // output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
465 // output->PushEscaped(iTimeout);
466 // output->PushBack(MSGEND);
467 // output->isTransmission = false;
469 // if ((bReturn = Write(output)) == false)
470 // CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
477 bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask
)
480 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
482 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
484 output
->PushBack(MSGSTART
);
485 output
->PushEscaped(MSGCODE_SET_ACK_MASK
);
486 output
->PushEscaped(iMask
>> 8);
487 output
->PushEscaped((uint8_t)iMask
);
488 output
->PushBack(MSGEND
);
489 output
->isTransmission
= false;
491 if ((bReturn
= Write(output
)) == false)
492 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not set the ackmask");
499 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled
)
502 CLibCEC::AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
504 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
506 output
->PushBack(MSGSTART
);
507 output
->PushEscaped(MSGCODE_SET_CONTROLLED
);
508 output
->PushEscaped(controlled
);
509 output
->PushBack(MSGEND
);
510 output
->isTransmission
= false;
512 if ((bReturn
= Write(output
)) == false)
513 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not set controlled mode");
519 bool CUSBCECAdapterCommunication::IsOpen(void)
521 return !IsStopped() && m_port
->IsOpen() && IsRunning();
524 bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage
&message
)
527 bool bTransmitSucceeded(false);
528 uint8_t iPacketsLeft(message
.Size() / 4);
530 int64_t iNow
= GetTimeMs();
531 int64_t iTargetTime
= iNow
+ (message
.transmit_timeout
<= 5 ? CEC_DEFAULT_TRANSMIT_WAIT
: message
.transmit_timeout
);
533 while (!bTransmitSucceeded
&& !bError
&& iNow
< iTargetTime
)
536 CCECAdapterMessage msg
;
543 if (msg
.Message() == MSGCODE_FRAME_START
&& msg
.IsACK())
545 m_processor
->HandlePoll(msg
.Initiator(), msg
.Destination());
546 m_lastInitiator
= msg
.Initiator();
551 if (msg
.Message() == MSGCODE_RECEIVE_FAILED
&&
552 m_lastInitiator
!= CECDEVICE_UNKNOWN
&&
553 m_processor
->HandleReceiveFailed(m_lastInitiator
))
559 bError
= msg
.IsError();
562 message
.reply
= msg
.Message();
563 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
567 switch(msg
.Message())
569 case MSGCODE_COMMAND_ACCEPTED
:
570 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
571 if (iPacketsLeft
> 0)
573 if (!message
.isTransmission
&& iPacketsLeft
== 0)
574 bTransmitSucceeded
= true;
576 case MSGCODE_TRANSMIT_SUCCEEDED
:
577 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
578 bTransmitSucceeded
= (iPacketsLeft
== 0);
579 bError
= !bTransmitSucceeded
;
580 message
.reply
= MSGCODE_TRANSMIT_SUCCEEDED
;
583 // ignore other data while waiting
591 message
.state
= bTransmitSucceeded
&& !bError
?
592 ADAPTER_MESSAGE_STATE_SENT_ACKED
:
593 ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
595 return bTransmitSucceeded
&& !bError
;
598 void CUSBCECAdapterCommunication::AddData(uint8_t *data
, size_t iLen
)
600 CLockObject
lock(m_mutex
);
601 for (size_t iPtr
= 0; iPtr
< iLen
; iPtr
++)
605 if (data
[iPtr
] == MSGSTART
)
608 else if (data
[iPtr
] == MSGSTART
) //we found a msgstart before msgend, this is not right, remove
610 if (m_currentAdapterMessage
.Size() > 0)
611 CLibCEC::AddLog(CEC_LOG_WARNING
, "received MSGSTART before MSGEND, removing previous buffer contents");
612 m_currentAdapterMessage
.Clear();
615 else if (data
[iPtr
] == MSGEND
)
617 CCECAdapterMessage
*newMessage
= new CCECAdapterMessage
;
618 newMessage
->packet
= m_currentAdapterMessage
.packet
;
619 m_inBuffer
.Push(newMessage
);
620 m_currentAdapterMessage
.Clear();
622 m_bNextIsEscaped
= false;
623 m_rcvCondition
.Signal();
625 else if (m_bNextIsEscaped
)
627 m_currentAdapterMessage
.PushBack(data
[iPtr
] + (uint8_t)ESCOFFSET
);
628 m_bNextIsEscaped
= false;
630 else if (data
[iPtr
] == MSGESC
)
632 m_bNextIsEscaped
= true;
636 m_currentAdapterMessage
.PushBack(data
[iPtr
]);
641 bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout
, size_t iSize
/* = 256 */)
650 CLockObject
lock(m_mutex
);
651 iBytesRead
= m_port
->Read(buff
, sizeof(uint8_t) * iSize
, iTimeout
);
652 if (iBytesRead
< 0 || iBytesRead
> 256)
654 CLibCEC::AddLog(CEC_LOG_ERROR
, "error reading from serial port: %s", m_port
->GetError().c_str());
657 else if (iBytesRead
> 0)
659 AddData(buff
, iBytesRead
);
662 return iBytesRead
> 0;
665 void CUSBCECAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage
*msg
)
667 CLockObject
adapterLock(m_mutex
);
668 CLockObject
lock(msg
->mutex
);
670 SetLineTimeout(msg
->lineTimeout
);
672 SetLineTimeout(msg
->retryTimeout
);
674 if (m_port
->Write(msg
->packet
.data
, msg
->Size()) != (ssize_t
) msg
->Size())
676 CLibCEC::AddLog(CEC_LOG_ERROR
, "error writing to serial port: %s", m_port
->GetError().c_str());
677 msg
->state
= ADAPTER_MESSAGE_STATE_ERROR
;
681 CLibCEC::AddLog(CEC_LOG_DEBUG
, "command sent");
682 msg
->state
= ADAPTER_MESSAGE_STATE_SENT
;
684 if (msg
->expectControllerAck
)
686 if (!WaitForAck(*msg
))
687 CLibCEC::AddLog(CEC_LOG_DEBUG
, "did not receive ack");
690 msg
->condition
.Signal();
693 void CUSBCECAdapterCommunication::WriteNextCommand(void)
695 CCECAdapterMessage
*msg(NULL
);
696 if (m_outBuffer
.Pop(msg
))
697 SendMessageToAdapter(msg
);