2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011 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 "AdapterCommunication.h"
35 #include "AdapterMessage.h"
36 #include "CECProcessor.h"
37 #include "platform/serialport/serialport.h"
41 using namespace PLATFORM
;
43 CAdapterCommunication::CAdapterCommunication(CCECProcessor
*processor
) :
45 m_processor(processor
),
47 m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN
)
49 m_port
= new PLATFORM::CSerialPort
;
52 CAdapterCommunication::~CAdapterCommunication(void)
63 bool CAdapterCommunication::Open(const char *strPort
, uint16_t iBaudRate
/* = 38400 */, uint32_t iTimeoutMs
/* = 10000 */)
65 uint64_t iNow
= GetTimeMs();
66 uint64_t iTimeout
= iNow
+ iTimeoutMs
;
68 CLockObject
lock(m_mutex
);
72 m_processor
->AddLog(CEC_LOG_ERROR
, "port is NULL");
78 m_processor
->AddLog(CEC_LOG_ERROR
, "port is already open");
83 bool bConnected(false);
84 while (!bConnected
&& iNow
< iTimeout
)
86 if ((bConnected
= m_port
->Open(strPort
, iBaudRate
)) == false)
88 strError
.Format("error opening serial port '%s': %s", strPort
, m_port
->GetError().c_str());
96 m_processor
->AddLog(CEC_LOG_ERROR
, strError
);
100 m_processor
->AddLog(CEC_LOG_DEBUG
, "connection opened");
102 //clear any input bytes
104 while (m_port
->Read(buff
, 1, 5) == 1) {}
108 m_processor
->AddLog(CEC_LOG_DEBUG
, "communication thread started");
113 m_processor
->AddLog(CEC_LOG_ERROR
, "could not create a communication thread");
119 void CAdapterCommunication::Close(void)
121 CLockObject
lock(m_mutex
);
122 m_rcvCondition
.Broadcast();
126 void *CAdapterCommunication::Process(void)
135 CCECAdapterMessage
*msg(NULL
);
136 if (m_outBuffer
.Pop(msg
))
137 msg
->condition
.Broadcast();
142 bool CAdapterCommunication::Write(CCECAdapterMessage
*data
)
146 CLockObject
lock(data
->mutex
);
147 data
->state
= ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
;
148 m_outBuffer
.Push(data
);
149 data
->condition
.Wait(data
->mutex
);
151 if (data
->state
!= ADAPTER_MESSAGE_STATE_SENT
)
153 m_processor
->AddLog(CEC_LOG_ERROR
, "command was not sent");
156 if (data
->expectControllerAck
)
158 bReturn
= WaitForTransmitSucceeded(data
);
161 if (data
->isTransmission
)
162 data
->state
= ADAPTER_MESSAGE_STATE_SENT_ACKED
;
166 data
->state
= ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
167 m_processor
->AddLog(CEC_LOG_DEBUG
, "did not receive ack");
178 bool CAdapterCommunication::Read(CCECAdapterMessage
&msg
, uint32_t iTimeout
)
180 CLockObject
lock(m_mutex
);
183 uint64_t iNow
= GetTimeMs();
184 uint64_t iTarget
= iNow
+ iTimeout
;
185 bool bGotFullMessage(false);
186 bool bNextIsEscaped(false);
187 bool bGotStart(false);
189 while(!bGotFullMessage
&& iNow
< iTarget
)
192 if (!m_inBuffer
.Pop(buf
))
194 if (!m_rcvCondition
.Wait(m_mutex
, (uint32_t) (iTarget
- iNow
)))
204 else if (buf
== MSGSTART
) //we found a msgstart before msgend, this is not right, remove
207 m_processor
->AddLog(CEC_LOG_WARNING
, "received MSGSTART before MSGEND, removing previous buffer contents");
214 bGotFullMessage
= true;
216 else if (bNextIsEscaped
)
218 msg
.PushBack(buf
+ (uint8_t)ESCOFFSET
);
219 bNextIsEscaped
= false;
221 else if (buf
== MSGESC
)
222 bNextIsEscaped
= true;
228 msg
.state
= ADAPTER_MESSAGE_STATE_INCOMING
;
230 return bGotFullMessage
;
233 std::string
CAdapterCommunication::GetError(void) const
235 return m_port
->GetError();
238 bool CAdapterCommunication::StartBootloader(void)
244 m_processor
->AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
245 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
247 output
->PushBack(MSGSTART
);
248 output
->PushEscaped(MSGCODE_START_BOOTLOADER
);
249 output
->PushBack(MSGEND
);
250 output
->isTransmission
= false;
251 output
->expectControllerAck
= false;
253 if ((bReturn
= Write(output
)) == false)
254 m_processor
->AddLog(CEC_LOG_ERROR
, "could not start the bootloader");
260 bool CAdapterCommunication::PingAdapter(void)
266 m_processor
->AddLog(CEC_LOG_DEBUG
, "sending ping");
267 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
269 output
->PushBack(MSGSTART
);
270 output
->PushEscaped(MSGCODE_PING
);
271 output
->PushBack(MSGEND
);
272 output
->isTransmission
= false;
274 if ((bReturn
= Write(output
)) == false)
275 m_processor
->AddLog(CEC_LOG_ERROR
, "could not ping the adapter");
281 uint16_t CAdapterCommunication::GetFirmwareVersion(void)
283 uint16_t iReturn(m_iFirmwareVersion
);
287 if (iReturn
== CEC_FW_VERSION_UNKNOWN
)
289 m_processor
->AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
290 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
292 output
->PushBack(MSGSTART
);
293 output
->PushEscaped(MSGCODE_FIRMWARE_VERSION
);
294 output
->PushBack(MSGEND
);
295 output
->isTransmission
= false;
296 output
->expectControllerAck
= false;
298 SendMessageToAdapter(output
);
301 CCECAdapterMessage input
;
302 if (!Read(input
, CEC_DEFAULT_TRANSMIT_WAIT
) || input
.Message() != MSGCODE_FIRMWARE_VERSION
|| input
.Size() != 3)
303 m_processor
->AddLog(CEC_LOG_ERROR
, "no or invalid firmware version");
306 m_iFirmwareVersion
= (input
[1] << 8 | input
[2]);
307 iReturn
= m_iFirmwareVersion
;
314 bool CAdapterCommunication::SetLineTimeout(uint8_t iTimeout
)
316 bool bReturn(m_iLineTimeout
!= iTimeout
);
320 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
322 output
->PushBack(MSGSTART
);
323 output
->PushEscaped(MSGCODE_TRANSMIT_IDLETIME
);
324 output
->PushEscaped(iTimeout
);
325 output
->PushBack(MSGEND
);
326 output
->isTransmission
= false;
328 if ((bReturn
= Write(output
)) == false)
329 m_processor
->AddLog(CEC_LOG_ERROR
, "could not set the idletime");
336 bool CAdapterCommunication::SetAckMask(uint16_t iMask
)
340 strLog
.Format("setting ackmask to %2x", iMask
);
341 m_processor
->AddLog(CEC_LOG_DEBUG
, strLog
.c_str());
343 CCECAdapterMessage
*output
= new CCECAdapterMessage
;
345 output
->PushBack(MSGSTART
);
346 output
->PushEscaped(MSGCODE_SET_ACK_MASK
);
347 output
->PushEscaped(iMask
>> 8);
348 output
->PushEscaped((uint8_t)iMask
);
349 output
->PushBack(MSGEND
);
350 output
->isTransmission
= false;
352 if ((bReturn
= Write(output
)) == false)
353 m_processor
->AddLog(CEC_LOG_ERROR
, "could not set the ackmask");
359 bool CAdapterCommunication::IsOpen(void)
361 return !IsStopped() && m_port
->IsOpen() && IsRunning();
364 bool CAdapterCommunication::WaitForTransmitSucceeded(CCECAdapterMessage
*message
)
367 bool bTransmitSucceeded(false);
368 uint8_t iPacketsLeft(message
->Size() / 4);
370 int64_t iNow
= GetTimeMs();
371 int64_t iTargetTime
= iNow
+ message
->transmit_timeout
;
373 while (!bTransmitSucceeded
&& !bError
&& (message
->transmit_timeout
== 0 || iNow
< iTargetTime
))
375 CCECAdapterMessage msg
;
377 if (!Read(msg
, message
->transmit_timeout
> 0 ? (int32_t)(iTargetTime
- iNow
) : 1000))
383 if (msg
.Message() == MSGCODE_FRAME_START
&& msg
.IsACK())
385 m_processor
->HandlePoll(msg
.Initiator(), msg
.Destination());
390 if (msg
.Message() == MSGCODE_RECEIVE_FAILED
&&
391 m_processor
->HandleReceiveFailed())
397 bError
= msg
.IsError();
400 message
->reply
= msg
.Message();
401 m_processor
->AddLog(CEC_LOG_DEBUG
, msg
.ToString());
405 switch(msg
.Message())
407 case MSGCODE_COMMAND_ACCEPTED
:
408 m_processor
->AddLog(CEC_LOG_DEBUG
, msg
.ToString());
409 if (iPacketsLeft
> 0)
411 if (!message
->isTransmission
&& iPacketsLeft
== 0)
412 bTransmitSucceeded
= true;
414 case MSGCODE_TRANSMIT_SUCCEEDED
:
415 m_processor
->AddLog(CEC_LOG_DEBUG
, msg
.ToString());
416 bTransmitSucceeded
= (iPacketsLeft
== 0);
417 bError
= !bTransmitSucceeded
;
418 message
->reply
= MSGCODE_TRANSMIT_SUCCEEDED
;
421 // ignore other data while waiting
429 return bTransmitSucceeded
&& !bError
;
432 void CAdapterCommunication::AddData(uint8_t *data
, uint8_t iLen
)
434 CLockObject
lock(m_mutex
);
435 for (uint8_t iPtr
= 0; iPtr
< iLen
; iPtr
++)
436 m_inBuffer
.Push(data
[iPtr
]);
438 m_rcvCondition
.Signal();
441 bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout
)
448 CLockObject
lock(m_mutex
);
449 iBytesRead
= m_port
->Read(buff
, sizeof(buff
), iTimeout
);
450 if (iBytesRead
< 0 || iBytesRead
> 256)
453 strError
.Format("error reading from serial port: %s", m_port
->GetError().c_str());
454 m_processor
->AddLog(CEC_LOG_ERROR
, strError
);
457 else if (iBytesRead
> 0)
458 AddData(buff
, (uint8_t) iBytesRead
);
460 return iBytesRead
> 0;
463 void CAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage
*msg
)
465 CLockObject
adapterLock(m_mutex
);
466 CLockObject
lock(msg
->mutex
);
467 if (m_port
->Write(msg
->packet
.data
, msg
->Size()) != (int32_t) msg
->Size())
470 strError
.Format("error writing to serial port: %s", m_port
->GetError().c_str());
471 m_processor
->AddLog(CEC_LOG_ERROR
, strError
);
472 msg
->state
= ADAPTER_MESSAGE_STATE_ERROR
;
476 m_processor
->AddLog(CEC_LOG_DEBUG
, "command sent");
477 msg
->state
= ADAPTER_MESSAGE_STATE_SENT
;
479 msg
->condition
.Signal();
482 void CAdapterCommunication::WriteNextCommand(void)
484 CCECAdapterMessage
*msg(NULL
);
485 if (m_outBuffer
.Pop(msg
))
486 SendMessageToAdapter(msg
);