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 void *CUSBCECAdapterProcessor::Process(void)
48 if (m_inBuffer
.Pop(command
))
49 m_callback
->OnCommandReceived(command
);
56 void CUSBCECAdapterProcessor::AddCommand(cec_command command
)
58 m_inBuffer
.Push(command
);
61 CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(CCECProcessor
*processor
, const char *strPort
, uint16_t iBaudRate
/* = 38400 */) :
63 m_processor(processor
),
66 m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN
),
67 m_lastInitiator(CECDEVICE_UNKNOWN
),
68 m_bNextIsEscaped(false),
70 m_messageProcessor(NULL
),
73 m_port
= new PLATFORM::CSerialPort(strPort
, iBaudRate
);
76 CUSBCECAdapterCommunication::~CUSBCECAdapterCommunication(void)
81 bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs
/* = 10000 */)
84 uint64_t iNow
= GetTimeMs();
85 uint64_t iTarget
= iTimeoutMs
> 0 ? iNow
+ iTimeoutMs
: iNow
+ CEC_DEFAULT_TRANSMIT_WAIT
;
87 /* try to ping the adapter */
90 while (iNow
< iTarget
&& (bPinged
= PingAdapter()) == false)
92 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry
);
97 /* try to read the firmware version */
98 m_iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
99 unsigned iFwVersionTry(0);
100 while (bPinged
&& iNow
< iTarget
&& (m_iFirmwareVersion
= GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN
)
102 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry
);
107 if (m_iFirmwareVersion
>= 2)
109 /* try to set controlled mode */
110 unsigned iControlledTry(0);
111 bool bControlled(false);
112 while (iNow
< iTarget
&& (bControlled
= SetControlledMode(true)) == false)
114 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry
);
118 bReturn
= bControlled
;
124 CLockObject
lock(m_mutex
);
125 m_bInitialised
= bReturn
;
131 bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback
*cb
, uint32_t iTimeoutMs
/* = 10000 */)
133 uint64_t iNow
= GetTimeMs();
134 uint64_t iTimeout
= iNow
+ iTimeoutMs
;
137 CLockObject
lock(m_mutex
);
141 CLibCEC::AddLog(CEC_LOG_ERROR
, "port is NULL");
147 CLibCEC::AddLog(CEC_LOG_ERROR
, "port is already open");
153 bool bConnected(false);
154 while (!bConnected
&& iNow
< iTimeout
)
156 if ((bConnected
= m_port
->Open(iTimeout
)) == false)
158 strError
.Format("error opening serial port '%s': %s", m_port
->GetName().c_str(), m_port
->GetError().c_str());
166 CLibCEC::AddLog(CEC_LOG_ERROR
, strError
);
170 CLibCEC::AddLog(CEC_LOG_DEBUG
, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
172 //clear any input bytes
174 while (m_port
->Read(buff
, 1024, 100) > 0)
176 CLibCEC::AddLog(CEC_LOG_DEBUG
, "data received, clearing it");
186 CLibCEC::AddLog(CEC_LOG_ERROR
, "the adapter failed to pass basic checks");
190 CLibCEC::AddLog(CEC_LOG_DEBUG
, "communication thread started");
194 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not create a communication thread");
199 void CUSBCECAdapterCommunication::Close(void)
204 void *CUSBCECAdapterCommunication::Process(void)
206 m_messageProcessor
= new CUSBCECAdapterProcessor(m_callback
);
207 m_messageProcessor
->CreateThread();
211 bool bCommandReceived(false);
215 CLockObject
lock(m_mutex
);
217 bCommandReceived
= m_callback
&& Read(command
, 0) && m_bInitialised
;
220 /* push the next command to the callback method if there is one */
221 if (!IsStopped() && bCommandReceived
)
222 m_messageProcessor
->AddCommand(command
);
231 /* stop the message processor */
232 m_messageProcessor
->StopThread();
233 delete m_messageProcessor
;
235 /* notify all threads that are waiting on messages to be sent */
236 CCECAdapterMessage
*msg(NULL
);
237 while (m_outBuffer
.Pop(msg
))
238 msg
->event
.Broadcast();
240 /* set the ackmask to 0 before closing the connection */
241 SetAckMaskInternal(0, true);
252 cec_adapter_message_state
CUSBCECAdapterCommunication::Write(const cec_command
&data
, uint8_t iMaxTries
, uint8_t iLineTimeout
/* = 3 */, uint8_t iRetryLineTimeout
/* = 3 */)
254 cec_adapter_message_state
retVal(ADAPTER_MESSAGE_STATE_UNKNOWN
);
258 CCECAdapterMessage
*output
= new CCECAdapterMessage(data
);
260 /* set the number of retries */
261 if (data
.opcode
== CEC_OPCODE_NONE
) //TODO
262 output
->maxTries
= 1;
263 else if (data
.initiator
!= CECDEVICE_BROADCAST
)
264 output
->maxTries
= iMaxTries
;
266 output
->lineTimeout
= iLineTimeout
;
267 output
->retryTimeout
= iRetryLineTimeout
;
271 while (bRetry
&& ++output
->tries
< output
->maxTries
)
273 bRetry
= (!Write(output
) || output
->NeedsRetry()) && output
->transmit_timeout
> 0;
275 Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT
);
277 retVal
= output
->state
;
283 bool CUSBCECAdapterCommunication::Write(CCECAdapterMessage
*data
)
285 data
->state
= ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
;
286 m_outBuffer
.Push(data
);
287 data
->event
.Wait(5000);
289 if ((data
->expectControllerAck
&& data
->state
!= ADAPTER_MESSAGE_STATE_SENT_ACKED
) ||
290 (!data
->expectControllerAck
&& data
->state
!= ADAPTER_MESSAGE_STATE_SENT
))
292 CLibCEC::AddLog(CEC_LOG_DEBUG
, "command was not %s", data
->state
== ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
? "acked" : "sent");
299 bool CUSBCECAdapterCommunication::Read(cec_command
&command
, uint32_t iTimeout
)
304 CCECAdapterMessage msg
;
305 if (Read(msg
, iTimeout
))
307 if (ParseMessage(msg
))
309 command
= m_currentframe
;
310 m_currentframe
.Clear();
317 bool CUSBCECAdapterCommunication::Read(CCECAdapterMessage
&msg
, uint32_t iTimeout
)
319 CLockObject
lock(m_mutex
);
322 CCECAdapterMessage
*buf(NULL
);
324 if (!m_inBuffer
.Pop(buf
))
326 if (iTimeout
== 0 || !m_rcvCondition
.Wait(m_mutex
, m_bHasData
, iTimeout
))
329 m_bHasData
= !m_inBuffer
.IsEmpty();
334 msg
.packet
= buf
->packet
;
335 msg
.state
= ADAPTER_MESSAGE_STATE_INCOMING
;
342 CStdString
CUSBCECAdapterCommunication::GetError(void) const
345 strError
= m_port
->GetError();
349 bool CUSBCECAdapterCommunication::StartBootloader(void)
355 CLibCEC::AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
356 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
358 output
->PushBack(MSGSTART
);
359 output
->PushEscaped(MSGCODE_START_BOOTLOADER
);
360 output
->PushBack(MSGEND
);
361 output
->isTransmission
= false;
362 output
->expectControllerAck
= false;
364 if ((bReturn
= Write(output
)) == false)
365 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not start the bootloader");
371 bool CUSBCECAdapterCommunication::PingAdapter(void)
377 CLibCEC::AddLog(CEC_LOG_DEBUG
, "sending ping");
378 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
380 output
->PushBack(MSGSTART
);
381 output
->PushEscaped(MSGCODE_PING
);
382 output
->PushBack(MSGEND
);
383 output
->isTransmission
= false;
385 if ((bReturn
= Write(output
)) == false)
386 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not ping the adapter");
392 bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage
&msg
)
395 bool bIsError(msg
.IsError());
400 CLockObject
adapterLock(m_mutex
);
401 switch(msg
.Message())
403 case MSGCODE_FRAME_START
:
405 m_currentframe
.Clear();
408 m_currentframe
.initiator
= msg
.Initiator();
409 m_currentframe
.destination
= msg
.Destination();
410 m_currentframe
.ack
= msg
.IsACK();
411 m_currentframe
.eom
= msg
.IsEOM();
413 if (m_currentframe
.ack
== 0x1)
415 m_lastInitiator
= m_currentframe
.initiator
;
416 m_processor
->HandlePoll(m_currentframe
.initiator
, m_currentframe
.destination
);
420 case MSGCODE_RECEIVE_FAILED
:
422 m_currentframe
.Clear();
423 if (m_lastInitiator
!= CECDEVICE_UNKNOWN
)
424 bIsError
= m_processor
->HandleReceiveFailed(m_lastInitiator
);
427 case MSGCODE_FRAME_DATA
:
431 m_currentframe
.PushBack(msg
[1]);
432 m_currentframe
.eom
= msg
.IsEOM();
440 CLibCEC::AddLog(bIsError
? CEC_LOG_WARNING
: CEC_LOG_DEBUG
, msg
.ToString());
444 uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
446 uint16_t iReturn(m_iFirmwareVersion
);
450 if (iReturn
== CEC_FW_VERSION_UNKNOWN
)
452 CLockObject
lock(m_mutex
);
453 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
454 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
456 output
->PushBack(MSGSTART
);
457 output
->PushEscaped(MSGCODE_FIRMWARE_VERSION
);
458 output
->PushBack(MSGEND
);
459 output
->isTransmission
= false;
460 output
->expectControllerAck
= false;
462 SendMessageToAdapter(output
);
463 bool bWriteOk
= output
->state
== ADAPTER_MESSAGE_STATE_SENT
;
467 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not request the firmware version");
471 Sleep(250); // TODO ReadFromDevice() isn't waiting for the timeout to pass on win32
472 ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT
, 5 /* start + msgcode + 2 bytes for fw version + end */);
473 CCECAdapterMessage input
;
476 if (input
.Message() != MSGCODE_FIRMWARE_VERSION
|| input
.Size() != 3)
477 CLibCEC::AddLog(CEC_LOG_ERROR
, "invalid firmware version (size = %d, message = %d)", input
.Size(), input
.Message());
480 m_iFirmwareVersion
= (input
[1] << 8 | input
[2]);
481 iReturn
= m_iFirmwareVersion
;
486 CLibCEC::AddLog(CEC_LOG_ERROR
, "no firmware version received");
493 bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout
)
495 m_iLineTimeout
= iTimeout
;
498 // bool bReturn(m_iLineTimeout != iTimeout);
502 // CCECAdapterMessage *output = new CCECAdapterMessage;
504 // output->PushBack(MSGSTART);
505 // output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME);
506 // output->PushEscaped(iTimeout);
507 // output->PushBack(MSGEND);
508 // output->isTransmission = false;
510 // if ((bReturn = Write(output)) == false)
511 // CLibCEC::AddLog(CEC_LOG_ERROR, "could not set the idletime");
518 bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask
)
520 return SetAckMaskInternal(iMask
, false);
523 bool CUSBCECAdapterCommunication::SetAckMaskInternal(uint16_t iMask
, bool bWriteDirectly
/* = false */)
526 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
528 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
530 output
->PushBack(MSGSTART
);
531 output
->PushEscaped(MSGCODE_SET_ACK_MASK
);
532 output
->PushEscaped(iMask
>> 8);
533 output
->PushEscaped((uint8_t)iMask
);
534 output
->PushBack(MSGEND
);
535 output
->isTransmission
= false;
538 SendMessageToAdapter(output
);
539 else if ((bReturn
= Write(output
)) == false)
540 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not set the ackmask");
547 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled
)
550 CLibCEC::AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
552 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
554 output
->PushBack(MSGSTART
);
555 output
->PushEscaped(MSGCODE_SET_CONTROLLED
);
556 output
->PushEscaped(controlled
);
557 output
->PushBack(MSGEND
);
558 output
->isTransmission
= false;
560 if ((bReturn
= Write(output
)) == false)
561 CLibCEC::AddLog(CEC_LOG_ERROR
, "could not set controlled mode");
567 bool CUSBCECAdapterCommunication::IsOpen(void)
569 return !IsStopped() && m_port
->IsOpen() && IsRunning();
572 bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage
&message
)
575 bool bTransmitSucceeded(false);
576 uint8_t iPacketsLeft(message
.Size() / 4);
578 int64_t iNow
= GetTimeMs();
579 int64_t iTargetTime
= iNow
+ (message
.transmit_timeout
<= 5 ? CEC_DEFAULT_TRANSMIT_WAIT
: message
.transmit_timeout
);
581 while (!bTransmitSucceeded
&& !bError
&& iNow
< iTargetTime
)
584 CCECAdapterMessage msg
;
591 if (msg
.Message() == MSGCODE_FRAME_START
&& msg
.IsACK())
593 m_processor
->HandlePoll(msg
.Initiator(), msg
.Destination());
594 m_lastInitiator
= msg
.Initiator();
599 if (msg
.Message() == MSGCODE_RECEIVE_FAILED
&&
600 m_lastInitiator
!= CECDEVICE_UNKNOWN
&&
601 m_processor
->HandleReceiveFailed(m_lastInitiator
))
607 bError
= msg
.IsError();
610 message
.reply
= msg
.Message();
611 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
615 switch(msg
.Message())
617 case MSGCODE_COMMAND_ACCEPTED
:
618 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
619 if (iPacketsLeft
> 0)
621 if (!message
.isTransmission
&& iPacketsLeft
== 0)
622 bTransmitSucceeded
= true;
624 case MSGCODE_TRANSMIT_SUCCEEDED
:
625 CLibCEC::AddLog(CEC_LOG_DEBUG
, msg
.ToString());
626 bTransmitSucceeded
= (iPacketsLeft
== 0);
627 bError
= !bTransmitSucceeded
;
628 message
.reply
= MSGCODE_TRANSMIT_SUCCEEDED
;
631 // ignore other data while waiting
639 message
.state
= bTransmitSucceeded
&& !bError
?
640 ADAPTER_MESSAGE_STATE_SENT_ACKED
:
641 ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
643 return bTransmitSucceeded
&& !bError
;
646 void CUSBCECAdapterCommunication::AddData(uint8_t *data
, size_t iLen
)
648 CLockObject
lock(m_mutex
);
649 for (size_t iPtr
= 0; iPtr
< iLen
; iPtr
++)
653 if (data
[iPtr
] == MSGSTART
)
656 else if (data
[iPtr
] == MSGSTART
) //we found a msgstart before msgend, this is not right, remove
658 if (m_currentAdapterMessage
.Size() > 0)
659 CLibCEC::AddLog(CEC_LOG_WARNING
, "received MSGSTART before MSGEND, removing previous buffer contents");
660 m_currentAdapterMessage
.Clear();
663 else if (data
[iPtr
] == MSGEND
)
665 CCECAdapterMessage
*newMessage
= new CCECAdapterMessage
;
666 newMessage
->packet
= m_currentAdapterMessage
.packet
;
667 m_inBuffer
.Push(newMessage
);
668 m_currentAdapterMessage
.Clear();
670 m_bNextIsEscaped
= false;
672 m_rcvCondition
.Broadcast();
674 else if (m_bNextIsEscaped
)
676 m_currentAdapterMessage
.PushBack(data
[iPtr
] + (uint8_t)ESCOFFSET
);
677 m_bNextIsEscaped
= false;
679 else if (data
[iPtr
] == MSGESC
)
681 m_bNextIsEscaped
= true;
685 m_currentAdapterMessage
.PushBack(data
[iPtr
]);
690 bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout
, size_t iSize
/* = 256 */)
699 CLockObject
lock(m_mutex
);
700 iBytesRead
= m_port
->Read(buff
, sizeof(uint8_t) * iSize
, iTimeout
);
701 if (iBytesRead
< 0 || iBytesRead
> 256)
703 CLibCEC::AddLog(CEC_LOG_ERROR
, "error reading from serial port: %s", m_port
->GetError().c_str());
707 else if (iBytesRead
> 0)
709 AddData(buff
, iBytesRead
);
712 return iBytesRead
> 0;
715 void CUSBCECAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage
*msg
)
717 CLockObject
adapterLock(m_mutex
);
718 if (!m_port
->IsOpen())
720 CLibCEC::AddLog(CEC_LOG_ERROR
, "error writing to serial port: the connection is closed");
721 msg
->state
= ADAPTER_MESSAGE_STATE_ERROR
;
726 SetLineTimeout(msg
->lineTimeout
);
728 SetLineTimeout(msg
->retryTimeout
);
730 if (m_port
->Write(msg
->packet
.data
, msg
->Size()) != (ssize_t
) msg
->Size())
732 CLibCEC::AddLog(CEC_LOG_ERROR
, "error writing to serial port: %s", m_port
->GetError().c_str());
733 msg
->state
= ADAPTER_MESSAGE_STATE_ERROR
;
737 CLibCEC::AddLog(CEC_LOG_DEBUG
, "command sent");
738 msg
->state
= ADAPTER_MESSAGE_STATE_SENT
;
740 if (msg
->expectControllerAck
)
742 if (!WaitForAck(*msg
))
743 CLibCEC::AddLog(CEC_LOG_DEBUG
, "did not receive ack");
749 void CUSBCECAdapterCommunication::WriteNextCommand(void)
751 CCECAdapterMessage
*msg(NULL
);
752 if (m_outBuffer
.Pop(msg
))
753 SendMessageToAdapter(msg
);
756 CStdString
CUSBCECAdapterCommunication::GetPortName(void)
759 strName
= m_port
->GetName();