cec: added GetSetting() to CUSBCECAdapterCommunication. bugzid: 543
[deb_libcec.git] / src / lib / adapter / USBCECAdapterCommunication.cpp
1 /*
2 * This file is part of the libCEC(R) library.
3 *
4 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
6 *
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
8 *
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.
13 *
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.
18 *
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.
22 *
23 *
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
26 *
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/
31 */
32
33 #include "USBCECAdapterCommunication.h"
34 #include "../platform/sockets/serialport.h"
35 #include "../platform/util/timeutils.h"
36 #include "../LibCEC.h"
37 #include "../CECProcessor.h"
38
39 using namespace std;
40 using namespace CEC;
41 using namespace PLATFORM;
42
43 #define CEC_ADAPTER_PING_TIMEOUT 15000
44
45 void *CUSBCECAdapterProcessor::Process(void)
46 {
47 cec_command command;
48 while (!IsStopped())
49 {
50 if (m_inBuffer.Pop(command))
51 m_callback->OnCommandReceived(command);
52 Sleep(5);
53 }
54
55 return NULL;
56 }
57
58 void CUSBCECAdapterProcessor::AddCommand(cec_command command)
59 {
60 m_inBuffer.Push(command);
61 }
62
63 CUSBCECAdapterCommunication::CUSBCECAdapterCommunication(CCECProcessor *processor, const char *strPort, uint16_t iBaudRate /* = 38400 */) :
64 m_port(NULL),
65 m_processor(processor),
66 m_bHasData(false),
67 m_iLineTimeout(0),
68 m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN),
69 m_lastInitiator(CECDEVICE_UNKNOWN),
70 m_bNextIsEscaped(false),
71 m_bGotStart(false),
72 m_messageProcessor(NULL),
73 m_bInitialised(false)
74 {
75 m_port = new CSerialPort(strPort, iBaudRate);
76 }
77
78 CUSBCECAdapterCommunication::~CUSBCECAdapterCommunication(void)
79 {
80 Close();
81 }
82
83 bool CUSBCECAdapterCommunication::CheckAdapter(uint32_t iTimeoutMs /* = 10000 */)
84 {
85 bool bReturn(false);
86 uint64_t iNow = GetTimeMs();
87 uint64_t iTarget = iTimeoutMs > 0 ? iNow + iTimeoutMs : iNow + CEC_DEFAULT_TRANSMIT_WAIT;
88
89 /* try to ping the adapter */
90 bool bPinged(false);
91 unsigned iPingTry(0);
92 while (iNow < iTarget && (bPinged = PingAdapter()) == false)
93 {
94 CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to a ping (try %d)", ++iPingTry);
95 CEvent::Sleep(500);
96 iNow = GetTimeMs();
97 }
98
99 /* try to read the firmware version */
100 m_iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
101 unsigned iFwVersionTry(0);
102 while (bPinged && iNow < iTarget && (m_iFirmwareVersion = GetFirmwareVersion()) == CEC_FW_VERSION_UNKNOWN && iFwVersionTry < 3)
103 {
104 CLibCEC::AddLog(CEC_LOG_WARNING, "the adapter did not respond with a correct firmware version (try %d)", ++iFwVersionTry);
105 CEvent::Sleep(500);
106 iNow = GetTimeMs();
107 }
108
109 if (m_iFirmwareVersion == CEC_FW_VERSION_UNKNOWN)
110 {
111 CLibCEC::AddLog(CEC_LOG_DEBUG, "defaulting to firmware version 1");
112 m_iFirmwareVersion = 1;
113 }
114
115 if (m_iFirmwareVersion >= 2)
116 {
117 /* try to set controlled mode */
118 unsigned iControlledTry(0);
119 bool bControlled(false);
120 while (iNow < iTarget && (bControlled = SetControlledMode(true)) == false)
121 {
122 CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter did not respond correctly to setting controlled mode (try %d)", ++iControlledTry);
123 CEvent::Sleep(500);
124 iNow = GetTimeMs();
125 }
126 bReturn = bControlled;
127 }
128 else
129 bReturn = true;
130
131 {
132 CLockObject lock(m_mutex);
133 m_bInitialised = bReturn;
134 }
135
136 return bReturn;
137 }
138
139 bool CUSBCECAdapterCommunication::Open(IAdapterCommunicationCallback *cb, uint32_t iTimeoutMs /* = 10000 */, bool bSkipChecks /* = false */)
140 {
141 uint64_t iNow = GetTimeMs();
142 uint64_t iTimeout = iNow + iTimeoutMs;
143
144 {
145 CLockObject lock(m_mutex);
146
147 if (!m_port)
148 {
149 CLibCEC::AddLog(CEC_LOG_ERROR, "port is NULL");
150 return false;
151 }
152
153 if (IsOpen())
154 {
155 CLibCEC::AddLog(CEC_LOG_ERROR, "port is already open");
156 return true;
157 }
158
159 m_callback = cb;
160 CStdString strError;
161 bool bConnected(false);
162 while (!bConnected && iNow < iTimeout)
163 {
164 if ((bConnected = m_port->Open(iTimeout)) == false)
165 {
166 strError.Format("error opening serial port '%s': %s", m_port->GetName().c_str(), m_port->GetError().c_str());
167 Sleep(250);
168 iNow = GetTimeMs();
169 }
170 }
171
172 if (!bConnected)
173 {
174 CLibCEC::AddLog(CEC_LOG_ERROR, strError);
175 return false;
176 }
177
178 CLibCEC::AddLog(CEC_LOG_DEBUG, "connection opened, clearing any previous input and waiting for active transmissions to end before starting");
179
180 if (!bSkipChecks)
181 {
182 //clear any input bytes
183 uint8_t buff[1024];
184 while (m_port->Read(buff, 1024, 100) > 0)
185 {
186 CLibCEC::AddLog(CEC_LOG_DEBUG, "data received, clearing it");
187 Sleep(250);
188 }
189 }
190 }
191
192 if (!bSkipChecks && !CheckAdapter())
193 {
194 CLibCEC::AddLog(CEC_LOG_ERROR, "the adapter failed to pass basic checks");
195 return false;
196 }
197 else
198 {
199 if (CreateThread())
200 {
201 CLibCEC::AddLog(CEC_LOG_DEBUG, "communication thread started");
202 return true;
203 }
204 else
205 {
206 CLibCEC::AddLog(CEC_LOG_ERROR, "could not create a communication thread");
207 }
208 }
209
210 return false;
211 }
212
213 void CUSBCECAdapterCommunication::Close(void)
214 {
215 StopThread();
216 }
217
218 void *CUSBCECAdapterCommunication::Process(void)
219 {
220 m_messageProcessor = new CUSBCECAdapterProcessor(m_callback);
221 m_messageProcessor->CreateThread();
222
223 cec_command command;
224 command.Clear();
225 bool bCommandReceived(false);
226 CTimeout pingTimeout(CEC_ADAPTER_PING_TIMEOUT);
227 while (!IsStopped())
228 {
229 {
230 CLockObject lock(m_mutex);
231 ReadFromDevice(50);
232 bCommandReceived = m_callback && Read(command, 0) && m_bInitialised;
233 }
234
235 /* push the next command to the callback method if there is one */
236 if (!IsStopped() && bCommandReceived)
237 m_messageProcessor->AddCommand(command);
238
239 /* ping the adapter every 15 seconds */
240 if (pingTimeout.TimeLeft() == 0)
241 {
242 pingTimeout.Init(CEC_ADAPTER_PING_TIMEOUT);
243 PingAdapter();
244 }
245
246 if (!IsStopped())
247 {
248 Sleep(5);
249 WriteNextCommand();
250 }
251 }
252
253 /* stop the message processor */
254 m_messageProcessor->StopThread();
255 delete m_messageProcessor;
256
257 /* notify all threads that are waiting on messages to be sent */
258 CCECAdapterMessage *msg(NULL);
259 while (m_outBuffer.Pop(msg))
260 msg->event.Broadcast();
261
262 /* set the ackmask to 0 before closing the connection */
263 SetAckMaskInternal(0, true);
264
265 if (m_iFirmwareVersion >= 2)
266 SetControlledMode(false);
267
268 if (m_port)
269 {
270 delete m_port;
271 m_port = NULL;
272 }
273
274 return NULL;
275 }
276
277 cec_adapter_message_state CUSBCECAdapterCommunication::Write(const cec_command &data, uint8_t iMaxTries, uint8_t iLineTimeout /* = 3 */, uint8_t iRetryLineTimeout /* = 3 */)
278 {
279 cec_adapter_message_state retVal(ADAPTER_MESSAGE_STATE_UNKNOWN);
280 if (!IsRunning())
281 return retVal;
282
283 CCECAdapterMessage *output = new CCECAdapterMessage(data);
284
285 /* set the number of retries */
286 if (data.opcode == CEC_OPCODE_NONE) //TODO
287 output->maxTries = 1;
288 else if (data.initiator != CECDEVICE_BROADCAST)
289 output->maxTries = iMaxTries;
290
291 output->lineTimeout = iLineTimeout;
292 output->retryTimeout = iRetryLineTimeout;
293 output->tries = 0;
294
295 bool bRetry(true);
296 while (bRetry && ++output->tries < output->maxTries)
297 {
298 bRetry = (!Write(output) || output->NeedsRetry()) && output->transmit_timeout > 0;
299 if (bRetry)
300 Sleep(CEC_DEFAULT_TRANSMIT_RETRY_WAIT);
301 }
302 retVal = output->state;
303
304 delete output;
305 return retVal;
306 }
307
308 bool CUSBCECAdapterCommunication::Write(CCECAdapterMessage *data)
309 {
310 data->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT;
311 m_outBuffer.Push(data);
312 data->event.Wait(5000);
313
314 if ((data->expectControllerAck && data->state != ADAPTER_MESSAGE_STATE_SENT_ACKED) ||
315 (!data->expectControllerAck && data->state != ADAPTER_MESSAGE_STATE_SENT))
316 {
317 CLibCEC::AddLog(CEC_LOG_DEBUG, "command was not %s", data->state == ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED ? "acked" : "sent");
318 return false;
319 }
320
321 return true;
322 }
323
324 bool CUSBCECAdapterCommunication::Read(cec_command &command, uint32_t iTimeout)
325 {
326 if (!IsRunning())
327 return false;
328
329 CCECAdapterMessage msg;
330 if (Read(msg, iTimeout))
331 {
332 if (ParseMessage(msg))
333 {
334 command = m_currentframe;
335 m_currentframe.Clear();
336 return true;
337 }
338 }
339 return false;
340 }
341
342 bool CUSBCECAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
343 {
344 CLockObject lock(m_mutex);
345
346 msg.Clear();
347 CCECAdapterMessage *buf(NULL);
348
349 if (!m_inBuffer.Pop(buf))
350 {
351 if (iTimeout == 0 || !m_rcvCondition.Wait(m_mutex, m_bHasData, iTimeout))
352 return false;
353 m_inBuffer.Pop(buf);
354 m_bHasData = !m_inBuffer.IsEmpty();
355 }
356
357 if (buf)
358 {
359 msg.packet = buf->packet;
360 msg.state = ADAPTER_MESSAGE_STATE_INCOMING;
361 delete buf;
362 return true;
363 }
364 return false;
365 }
366
367 CStdString CUSBCECAdapterCommunication::GetError(void) const
368 {
369 CStdString strError;
370 strError = m_port->GetError();
371 return strError;
372 }
373
374 bool CUSBCECAdapterCommunication::StartBootloader(void)
375 {
376 bool bReturn(false);
377 if (!IsRunning())
378 return bReturn;
379
380 CLibCEC::AddLog(CEC_LOG_DEBUG, "starting the bootloader");
381
382 CCECAdapterMessage params;
383 return SendCommand(MSGCODE_START_BOOTLOADER, params, false);
384 }
385
386 bool CUSBCECAdapterCommunication::PingAdapter(void)
387 {
388 CLockObject lock(m_mutex);
389 CLibCEC::AddLog(CEC_LOG_DEBUG, "sending ping");
390
391 CCECAdapterMessage params;
392 return SendCommand(MSGCODE_PING, params);
393 }
394
395 bool CUSBCECAdapterCommunication::ParseMessage(const CCECAdapterMessage &msg)
396 {
397 bool bEom(false);
398 bool bIsError(msg.IsError());
399
400 if (msg.IsEmpty())
401 return bEom;
402
403 CLockObject adapterLock(m_mutex);
404 switch(msg.Message())
405 {
406 case MSGCODE_FRAME_START:
407 {
408 m_currentframe.Clear();
409 if (msg.Size() >= 2)
410 {
411 m_currentframe.initiator = msg.Initiator();
412 m_currentframe.destination = msg.Destination();
413 m_currentframe.ack = msg.IsACK();
414 m_currentframe.eom = msg.IsEOM();
415 }
416 if (m_currentframe.ack == 0x1)
417 {
418 m_lastInitiator = m_currentframe.initiator;
419 m_processor->HandlePoll(m_currentframe.initiator, m_currentframe.destination);
420 }
421 }
422 break;
423 case MSGCODE_RECEIVE_FAILED:
424 {
425 m_currentframe.Clear();
426 if (m_lastInitiator != CECDEVICE_UNKNOWN)
427 bIsError = m_processor->HandleReceiveFailed(m_lastInitiator);
428 }
429 break;
430 case MSGCODE_FRAME_DATA:
431 {
432 if (msg.Size() >= 2)
433 {
434 m_currentframe.PushBack(msg[1]);
435 m_currentframe.eom = msg.IsEOM();
436 }
437 }
438 break;
439 default:
440 break;
441 }
442
443 CLibCEC::AddLog(bIsError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString());
444 return msg.IsEOM();
445 }
446
447 uint16_t CUSBCECAdapterCommunication::GetFirmwareVersion(void)
448 {
449 uint16_t iReturn(m_iFirmwareVersion);
450
451 if (iReturn == CEC_FW_VERSION_UNKNOWN)
452 {
453 CLockObject lock(m_mutex);
454 CLibCEC::AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
455 cec_datapacket response = GetSetting(MSGCODE_FIRMWARE_VERSION);
456 if (response.size == 2)
457 {
458 m_iFirmwareVersion = (response[0] << 8 | response[1]);
459 iReturn = m_iFirmwareVersion;
460 CLibCEC::AddLog(CEC_LOG_DEBUG, "firmware version %d", m_iFirmwareVersion);
461 }
462 }
463
464 return iReturn;
465 }
466
467 bool CUSBCECAdapterCommunication::SetLineTimeout(uint8_t iTimeout)
468 {
469 m_iLineTimeout = iTimeout;
470 bool bReturn(m_iLineTimeout != iTimeout);
471
472 if (!bReturn)
473 {
474 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the line timeout to %d", iTimeout);
475 CCECAdapterMessage params;
476 params.PushEscaped(iTimeout);
477 bReturn = SendCommand(MSGCODE_TRANSMIT_IDLETIME, params);
478 }
479
480 return bReturn;
481 }
482
483 bool CUSBCECAdapterCommunication::SetAckMask(uint16_t iMask)
484 {
485 return SetAckMaskInternal(iMask, IsRunning());
486 }
487
488 bool CUSBCECAdapterCommunication::SetAckMaskInternal(uint16_t iMask, bool bWriteDirectly /* = false */)
489 {
490 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting ackmask to %2x", iMask);
491
492 CCECAdapterMessage params;
493 params.PushEscaped(iMask >> 8);
494 params.PushEscaped((uint8_t)iMask);
495 return SendCommand(MSGCODE_SET_ACK_MASK, params, true, false, bWriteDirectly);
496 }
497
498 bool CUSBCECAdapterCommunication::PersistConfiguration(libcec_configuration *configuration)
499 {
500 if (m_iFirmwareVersion < 2)
501 return false;
502
503 bool bReturn(true);
504 bReturn &= SetAutoEnabled(true);
505 bReturn &= SetDeviceType(CLibCEC::GetType(configuration->logicalAddresses.primary));
506 bReturn &= SetDefaultLogicalAddress(configuration->logicalAddresses.primary);
507 bReturn &= SetLogicalAddressMask(CLibCEC::GetMaskForType(configuration->logicalAddresses.primary));
508 bReturn &= SetPhysicalAddress(configuration->iPhysicalAddress);
509 bReturn &= SetCECVersion(CEC_VERSION_1_3A);
510 bReturn &= SetOSDName(configuration->strDeviceName);
511 if (bReturn)
512 bReturn = WriteEEPROM();
513 return bReturn;
514 }
515
516 bool CUSBCECAdapterCommunication::SetControlledMode(bool controlled)
517 {
518 CLockObject lock(m_mutex);
519 CLibCEC::AddLog(CEC_LOG_DEBUG, "turning controlled mode %s", controlled ? "on" : "off");
520
521 CCECAdapterMessage params;
522 params.PushEscaped(controlled ? 1 : 0);
523 return SendCommand(MSGCODE_SET_CONTROLLED, params);
524 }
525
526 bool CUSBCECAdapterCommunication::SetAutoEnabled(bool enabled)
527 {
528 CLockObject lock(m_mutex);
529 CLibCEC::AddLog(CEC_LOG_DEBUG, "turning autonomous mode %s", enabled ? "on" : "off");
530
531 CCECAdapterMessage params;
532 params.PushEscaped(enabled ? 1 : 0);
533 return SendCommand(MSGCODE_SET_AUTO_ENABLED, params);
534 }
535
536 bool CUSBCECAdapterCommunication::SetDeviceType(cec_device_type type)
537 {
538 CLockObject lock(m_mutex);
539 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the device type to %1X", (uint8_t)type);
540
541 CCECAdapterMessage params;
542 params.PushEscaped((uint8_t)type);
543 return SendCommand(MSGCODE_SET_DEVICE_TYPE, params);
544 }
545
546 bool CUSBCECAdapterCommunication::SetDefaultLogicalAddress(cec_logical_address address)
547 {
548 CLockObject lock(m_mutex);
549 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the default logical address to %1X", address);
550
551 CCECAdapterMessage params;
552 params.PushEscaped((uint8_t)address);
553 return SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS, params);
554 }
555
556 bool CUSBCECAdapterCommunication::SetLogicalAddressMask(uint16_t iMask)
557 {
558 CLockObject lock(m_mutex);
559 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the logical address mask to %2X", iMask);
560
561 CCECAdapterMessage params;
562 params.PushEscaped(iMask >> 8);
563 params.PushEscaped((uint8_t)iMask);
564 return SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK, params);
565 }
566
567 bool CUSBCECAdapterCommunication::SetPhysicalAddress(uint16_t iPhysicalAddress)
568 {
569 CLockObject lock(m_mutex);
570 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the physical address to %2X", iPhysicalAddress);
571
572 CCECAdapterMessage params;
573 params.PushEscaped(iPhysicalAddress >> 8);
574 params.PushEscaped((uint8_t)iPhysicalAddress);
575 return SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS, params);
576 }
577
578 bool CUSBCECAdapterCommunication::SetCECVersion(cec_version version)
579 {
580 CLockObject lock(m_mutex);
581 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the CEC version to %s", CLibCEC::GetInstance()->ToString(version));
582
583 CCECAdapterMessage params;
584 params.PushEscaped((uint8_t)version);
585 return SendCommand(MSGCODE_SET_HDMI_VERSION, params);
586 }
587
588 bool CUSBCECAdapterCommunication::SetOSDName(const char *strOSDName)
589 {
590 CLockObject lock(m_mutex);
591 CLibCEC::AddLog(CEC_LOG_DEBUG, "setting the OSD name to %s", strOSDName);
592
593 CCECAdapterMessage params;
594 for (size_t iPtr = 0; iPtr < strlen(strOSDName); iPtr++)
595 params.PushEscaped(strOSDName[iPtr]);
596 return SendCommand(MSGCODE_SET_OSD_NAME, params);
597 }
598
599 bool CUSBCECAdapterCommunication::WriteEEPROM(void)
600 {
601 CLockObject lock(m_mutex);
602 CLibCEC::AddLog(CEC_LOG_DEBUG, "writing settings in the EEPROM");
603
604 CCECAdapterMessage params;
605 return SendCommand(MSGCODE_WRITE_EEPROM, params);
606 }
607
608 bool CUSBCECAdapterCommunication::IsOpen(void)
609 {
610 return !IsStopped() && m_port->IsOpen() && IsRunning();
611 }
612
613 bool CUSBCECAdapterCommunication::WaitForAck(CCECAdapterMessage &message)
614 {
615 bool bError(false);
616 bool bTransmitSucceeded(false);
617 uint8_t iPacketsLeft(message.isTransmission ? message.Size() / 4 : 1);
618
619 int64_t iNow = GetTimeMs();
620 int64_t iTargetTime = iNow + (message.transmit_timeout <= 5 ? CEC_DEFAULT_TRANSMIT_WAIT : message.transmit_timeout);
621
622 while (!bTransmitSucceeded && !bError && iNow < iTargetTime)
623 {
624 ReadFromDevice(50);
625 CCECAdapterMessage msg;
626 if (!Read(msg, 0))
627 {
628 iNow = GetTimeMs();
629 continue;
630 }
631
632 if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK())
633 {
634 m_processor->HandlePoll(msg.Initiator(), msg.Destination());
635 m_lastInitiator = msg.Initiator();
636 iNow = GetTimeMs();
637 continue;
638 }
639
640 if (msg.Message() == MSGCODE_RECEIVE_FAILED &&
641 m_lastInitiator != CECDEVICE_UNKNOWN &&
642 m_processor->HandleReceiveFailed(m_lastInitiator))
643 {
644 iNow = GetTimeMs();
645 continue;
646 }
647
648 bError = msg.IsError();
649 if (bError)
650 {
651 message.reply = msg.Message();
652 CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
653 }
654 else
655 {
656 switch(msg.Message())
657 {
658 case MSGCODE_COMMAND_ACCEPTED:
659 if (iPacketsLeft > 0)
660 iPacketsLeft--;
661 if (!message.isTransmission && iPacketsLeft == 0)
662 bTransmitSucceeded = true;
663 CLibCEC::AddLog(CEC_LOG_DEBUG, "%s - waiting for %d more", msg.ToString().c_str(), iPacketsLeft);
664 break;
665 case MSGCODE_TRANSMIT_SUCCEEDED:
666 CLibCEC::AddLog(CEC_LOG_DEBUG, msg.ToString());
667 bTransmitSucceeded = (iPacketsLeft == 0);
668 bError = !bTransmitSucceeded;
669 message.reply = MSGCODE_TRANSMIT_SUCCEEDED;
670 break;
671 default:
672 // ignore other data while waiting
673 break;
674 }
675
676 iNow = GetTimeMs();
677 }
678 }
679
680 message.state = bTransmitSucceeded && !bError ?
681 ADAPTER_MESSAGE_STATE_SENT_ACKED :
682 ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
683
684 return bTransmitSucceeded && !bError;
685 }
686
687 void CUSBCECAdapterCommunication::AddData(uint8_t *data, size_t iLen)
688 {
689 CLockObject lock(m_mutex);
690 for (size_t iPtr = 0; iPtr < iLen; iPtr++)
691 {
692 if (!m_bGotStart)
693 {
694 if (data[iPtr] == MSGSTART)
695 m_bGotStart = true;
696 }
697 else if (data[iPtr] == MSGSTART) //we found a msgstart before msgend, this is not right, remove
698 {
699 if (m_currentAdapterMessage.Size() > 0)
700 CLibCEC::AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents");
701 m_currentAdapterMessage.Clear();
702 m_bGotStart = true;
703 }
704 else if (data[iPtr] == MSGEND)
705 {
706 CCECAdapterMessage *newMessage = new CCECAdapterMessage;
707 newMessage->packet = m_currentAdapterMessage.packet;
708 m_inBuffer.Push(newMessage);
709 m_currentAdapterMessage.Clear();
710 m_bGotStart = false;
711 m_bNextIsEscaped = false;
712 m_bHasData = true;
713 m_rcvCondition.Broadcast();
714 }
715 else if (m_bNextIsEscaped)
716 {
717 m_currentAdapterMessage.PushBack(data[iPtr] + (uint8_t)ESCOFFSET);
718 m_bNextIsEscaped = false;
719 }
720 else if (data[iPtr] == MSGESC)
721 {
722 m_bNextIsEscaped = true;
723 }
724 else
725 {
726 m_currentAdapterMessage.PushBack(data[iPtr]);
727 }
728 }
729 }
730
731 bool CUSBCECAdapterCommunication::ReadFromDevice(uint32_t iTimeout, size_t iSize /* = 256 */)
732 {
733 ssize_t iBytesRead;
734 uint8_t buff[256];
735 if (!m_port)
736 return false;
737 if (iSize > 256)
738 iSize = 256;
739
740 CLockObject lock(m_mutex);
741 iBytesRead = m_port->Read(buff, sizeof(uint8_t) * iSize, iTimeout);
742 if (iBytesRead < 0 || iBytesRead > 256)
743 {
744 CLibCEC::AddLog(CEC_LOG_ERROR, "error reading from serial port: %s", m_port->GetError().c_str());
745 StopThread(false);
746 return false;
747 }
748 else if (iBytesRead > 0)
749 {
750 AddData(buff, iBytesRead);
751 }
752
753 return iBytesRead > 0;
754 }
755
756 void CUSBCECAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg)
757 {
758 CLockObject adapterLock(m_mutex);
759 if (!m_port->IsOpen())
760 {
761 CLibCEC::AddLog(CEC_LOG_ERROR, "error writing to serial port: the connection is closed");
762 msg->state = ADAPTER_MESSAGE_STATE_ERROR;
763 return;
764 }
765
766 if (msg->isTransmission && (msg->Size() < 2 || msg->At(1) != MSGCODE_TRANSMIT_IDLETIME))
767 {
768 if (msg->tries == 1)
769 SetLineTimeout(msg->lineTimeout);
770 else
771 SetLineTimeout(msg->retryTimeout);
772 }
773
774 if (m_port->Write(msg->packet.data, msg->Size()) != (ssize_t) msg->Size())
775 {
776 CLibCEC::AddLog(CEC_LOG_ERROR, "error writing to serial port: %s", m_port->GetError().c_str());
777 msg->state = ADAPTER_MESSAGE_STATE_ERROR;
778 }
779 else
780 {
781 CLibCEC::AddLog(CEC_LOG_DEBUG, "command sent");
782 msg->state = ADAPTER_MESSAGE_STATE_SENT;
783
784 if (msg->expectControllerAck)
785 {
786 if (!WaitForAck(*msg))
787 CLibCEC::AddLog(CEC_LOG_DEBUG, "did not receive ack");
788 }
789 }
790 msg->event.Signal();
791 }
792
793 void CUSBCECAdapterCommunication::WriteNextCommand(void)
794 {
795 CCECAdapterMessage *msg(NULL);
796 if (m_outBuffer.Pop(msg))
797 SendMessageToAdapter(msg);
798 }
799
800 CStdString CUSBCECAdapterCommunication::GetPortName(void)
801 {
802 CStdString strName;
803 strName = m_port->GetName();
804 return strName;
805 }
806
807 bool CUSBCECAdapterCommunication::SendCommand(cec_adapter_messagecode msgCode, CCECAdapterMessage &params, bool bExpectAck /* = true */, bool bIsTransmission /* = false */, bool bSendDirectly /* = true */)
808 {
809 CLockObject lock(m_mutex);
810
811 CCECAdapterMessage *output = new CCECAdapterMessage;
812
813 output->PushBack(MSGSTART);
814 output->PushEscaped(msgCode);
815 output->Append(params);
816 output->PushBack(MSGEND);
817 output->isTransmission = bIsTransmission;
818 output->expectControllerAck = bExpectAck;
819
820 if (bSendDirectly)
821 SendMessageToAdapter(output);
822 else
823 Write(output);
824
825 bool bWriteOk = output->state == (output->expectControllerAck ? ADAPTER_MESSAGE_STATE_SENT_ACKED : ADAPTER_MESSAGE_STATE_SENT);
826 if (!bWriteOk)
827 {
828 CLibCEC::AddLog(CEC_LOG_ERROR, "'%s' failed", CCECAdapterMessage::ToString(msgCode));
829 delete output;
830 return false;
831 }
832
833 delete output;
834 return true;
835 }
836
837 cec_datapacket CUSBCECAdapterCommunication::GetSetting(cec_adapter_messagecode msgCode)
838 {
839 cec_datapacket retVal;
840 retVal.Clear();
841
842 CCECAdapterMessage params;
843 if (!SendCommand(msgCode, params, false))
844 {
845 CLibCEC::AddLog(CEC_LOG_ERROR, "%s failed", CCECAdapterMessage::ToString(msgCode));
846 return retVal;
847 }
848
849 Sleep(250); // TODO ReadFromDevice() isn't waiting for the timeout to pass on win32
850 ReadFromDevice(CEC_DEFAULT_TRANSMIT_WAIT, 5 /* start + msgcode + 2 bytes for fw version + end */);
851 CCECAdapterMessage input;
852 if (Read(input, 0))
853 {
854 if (input.Message() != msgCode)
855 CLibCEC::AddLog(CEC_LOG_ERROR, "invalid response to %s received (%s)", CCECAdapterMessage::ToString(msgCode), CCECAdapterMessage::ToString(input.Message()));
856 else
857 {
858 for (uint8_t iPtr = 1; iPtr < input.Size(); iPtr++)
859 retVal.PushBack(input[iPtr]);
860 }
861 }
862 else
863 {
864 CLibCEC::AddLog(CEC_LOG_ERROR, "no response to %s received", CCECAdapterMessage::ToString(msgCode));
865 }
866
867 return retVal;
868 }