cec: store the status of a bus device: present, not present or handled by libcec
[deb_libcec.git] / src / lib / AdapterCommunication.cpp
CommitLineData
a8f0bd18
LOK
1/*
2 * This file is part of the libCEC(R) library.
3 *
4 * libCEC(R) is Copyright (C) 2011 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
828682d3 33#include "AdapterCommunication.h"
2abe74eb
LOK
34
35#include "LibCEC.h"
b9187cc6 36#include "platform/serialport.h"
a8f0bd18 37#include "util/StdString.h"
50aa01e6 38#include "platform/timeutils.h"
a8f0bd18
LOK
39
40using namespace std;
41using namespace CEC;
42
ad24cbaf
LOK
43CCECAdapterMessage::CCECAdapterMessage(const cec_command &command)
44{
45 clear();
46
47 //set ack polarity to high when transmitting to the broadcast address
48 //set ack polarity low when transmitting to any other address
49 push_back(MSGSTART);
50 push_escaped(MSGCODE_TRANSMIT_ACK_POLARITY);
51 if (command.destination == CECDEVICE_BROADCAST)
52 push_escaped(CEC_TRUE);
53 else
54 push_escaped(CEC_FALSE);
55 push_back(MSGEND);
56
57 // add source and destination
58 push_back(MSGSTART);
57f45e6c 59 push_escaped(command.opcode_set == 0 ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
ad24cbaf
LOK
60 push_back(((uint8_t)command.initiator << 4) + (uint8_t)command.destination);
61 push_back(MSGEND);
62
63 // add opcode
57f45e6c 64 if (command.opcode_set == 1)
ad24cbaf
LOK
65 {
66 push_back(MSGSTART);
ab1469a0 67 push_escaped(command.parameters.IsEmpty() ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
57f45e6c
LOK
68 push_back((uint8_t) command.opcode);
69 push_back(MSGEND);
ad24cbaf 70
57f45e6c
LOK
71 // add parameters
72 for (int8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
73 {
74 push_back(MSGSTART);
ad24cbaf 75
57f45e6c
LOK
76 if (iPtr == command.parameters.size - 1)
77 push_escaped( MSGCODE_TRANSMIT_EOM);
78 else
79 push_escaped(MSGCODE_TRANSMIT);
ad24cbaf 80
57f45e6c
LOK
81 push_escaped(command.parameters[iPtr]);
82
83 push_back(MSGEND);
84 }
ad24cbaf 85 }
06bfd4d7
LOK
86
87 // set timeout
88 transmit_timeout = command.transmit_timeout;
ad24cbaf
LOK
89}
90
91CCECAdapterMessage &CCECAdapterMessage::operator =(const CCECAdapterMessage &msg)
92{
93 packet = msg.packet;
88c43521 94 state = msg.state;
ad24cbaf
LOK
95 return *this;
96}
97
b8c91906 98CStdString CCECAdapterMessage::MessageCodeAsString(void) const
e41b06f9
LOK
99{
100 CStdString strMsg;
101 switch (message())
102 {
103 case MSGCODE_NOTHING:
104 strMsg = "NOTHING";
105 break;
106 case MSGCODE_PING:
107 strMsg = "PING";
108 break;
109 case MSGCODE_TIMEOUT_ERROR:
b8c91906
LOK
110 strMsg = "TIMEOUT";
111 break;
e41b06f9 112 case MSGCODE_HIGH_ERROR:
b8c91906
LOK
113 strMsg = "HIGH_ERROR";
114 break;
e41b06f9 115 case MSGCODE_LOW_ERROR:
b8c91906 116 strMsg = "LOW_ERROR";
e41b06f9
LOK
117 break;
118 case MSGCODE_FRAME_START:
119 strMsg = "FRAME_START";
e41b06f9
LOK
120 break;
121 case MSGCODE_FRAME_DATA:
122 strMsg = "FRAME_DATA";
e41b06f9
LOK
123 break;
124 case MSGCODE_RECEIVE_FAILED:
125 strMsg = "RECEIVE_FAILED";
126 break;
127 case MSGCODE_COMMAND_ACCEPTED:
128 strMsg = "COMMAND_ACCEPTED";
129 break;
130 case MSGCODE_COMMAND_REJECTED:
131 strMsg = "COMMAND_REJECTED";
132 break;
133 case MSGCODE_SET_ACK_MASK:
134 strMsg = "SET_ACK_MASK";
135 break;
136 case MSGCODE_TRANSMIT:
137 strMsg = "TRANSMIT";
138 break;
139 case MSGCODE_TRANSMIT_EOM:
140 strMsg = "TRANSMIT_EOM";
141 break;
142 case MSGCODE_TRANSMIT_IDLETIME:
143 strMsg = "TRANSMIT_IDLETIME";
144 break;
145 case MSGCODE_TRANSMIT_ACK_POLARITY:
146 strMsg = "TRANSMIT_ACK_POLARITY";
147 break;
148 case MSGCODE_TRANSMIT_LINE_TIMEOUT:
149 strMsg = "TRANSMIT_LINE_TIMEOUT";
150 break;
151 case MSGCODE_TRANSMIT_SUCCEEDED:
152 strMsg = "TRANSMIT_SUCCEEDED";
153 break;
154 case MSGCODE_TRANSMIT_FAILED_LINE:
155 strMsg = "TRANSMIT_FAILED_LINE";
156 break;
157 case MSGCODE_TRANSMIT_FAILED_ACK:
158 strMsg = "TRANSMIT_FAILED_ACK";
159 break;
160 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
161 strMsg = "TRANSMIT_FAILED_TIMEOUT_DATA";
162 break;
163 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
164 strMsg = "TRANSMIT_FAILED_TIMEOUT_LINE";
165 break;
166 case MSGCODE_FIRMWARE_VERSION:
167 strMsg = "FIRMWARE_VERSION";
168 break;
169 case MSGCODE_START_BOOTLOADER:
170 strMsg = "START_BOOTLOADER";
171 break;
172 case MSGCODE_FRAME_EOM:
173 strMsg = "FRAME_EOM";
174 break;
175 case MSGCODE_FRAME_ACK:
176 strMsg = "FRAME_ACK";
177 break;
178 }
179
180 return strMsg;
181}
182
b8c91906
LOK
183CStdString CCECAdapterMessage::ToString(void) const
184{
185 CStdString strMsg;
186 strMsg = MessageCodeAsString();
187
188 switch (message())
189 {
190 case MSGCODE_TIMEOUT_ERROR:
191 case MSGCODE_HIGH_ERROR:
192 case MSGCODE_LOW_ERROR:
193 {
194 int iLine = (size() >= 3) ? (at(1) << 8) | at(2) : 0;
195 uint32_t iTime = (size() >= 7) ? (at(3) << 24) | (at(4) << 16) | (at(5) << 8) | at(6) : 0;
196 strMsg.AppendFormat(" line:%i", iLine);
197 strMsg.AppendFormat(" time:%u", iTime);
198 }
199 break;
200 case MSGCODE_FRAME_START:
201 if (size() >= 2)
202 strMsg.AppendFormat(" initiator:%1x destination:%1x ack:%s %s", initiator(), destination(), ack() ? "high" : "low", eom() ? "eom" : "");
203 break;
204 case MSGCODE_FRAME_DATA:
205 if (size() >= 2)
206 strMsg.AppendFormat(" %02x %s", at(1), eom() ? "eom" : "");
207 break;
208 default:
209 break;
210 }
211
212 return strMsg;
213}
214
e41b06f9
LOK
215bool CCECAdapterMessage::is_error(void) const
216{
217 cec_adapter_messagecode code = message();
218 return (code == MSGCODE_TIMEOUT_ERROR ||
219 code == MSGCODE_HIGH_ERROR ||
220 code == MSGCODE_LOW_ERROR ||
221 code == MSGCODE_RECEIVE_FAILED ||
222 code == MSGCODE_COMMAND_REJECTED ||
223 code == MSGCODE_TRANSMIT_LINE_TIMEOUT ||
224 code == MSGCODE_TRANSMIT_FAILED_LINE ||
225 code == MSGCODE_TRANSMIT_FAILED_ACK ||
226 code == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
227 code == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE);
228}
229
c7903c02 230void CCECAdapterMessage::push_escaped(uint8_t byte)
ad24cbaf
LOK
231{
232 if (byte >= MSGESC && byte != MSGSTART)
233 {
234 push_back(MSGESC);
c7903c02 235 push_back(byte - ESCOFFSET);
ad24cbaf
LOK
236 }
237 else
c7903c02 238 push_back(byte);
ad24cbaf
LOK
239}
240
2abe74eb 241CAdapterCommunication::CAdapterCommunication(CLibCEC *controller) :
12027dbe 242 m_port(NULL),
50aa01e6 243 m_controller(controller)
a8f0bd18
LOK
244{
245 m_port = new CSerialPort;
246}
247
828682d3 248CAdapterCommunication::~CAdapterCommunication(void)
a8f0bd18 249{
12027dbe
LOK
250 Close();
251
252 if (m_port)
253 {
254 delete m_port;
255 m_port = NULL;
256 }
a8f0bd18
LOK
257}
258
25701fa6 259bool CAdapterCommunication::Open(const char *strPort, uint16_t iBaudRate /* = 38400 */, uint32_t iTimeoutMs /* = 10000 */)
a8f0bd18 260{
f077e8ed 261 CLockObject lock(&m_mutex);
13fd6a66
LOK
262 if (!m_port)
263 {
264 m_controller->AddLog(CEC_LOG_ERROR, "port is NULL");
a8f0bd18 265 return false;
13fd6a66
LOK
266 }
267
268 if (IsOpen())
269 {
270 m_controller->AddLog(CEC_LOG_ERROR, "port is already open");
271 }
a8f0bd18
LOK
272
273 if (!m_port->Open(strPort, iBaudRate))
274 {
275 CStdString strError;
276 strError.Format("error opening serial port '%s': %s", strPort, m_port->GetError().c_str());
2abe74eb 277 m_controller->AddLog(CEC_LOG_ERROR, strError);
a8f0bd18
LOK
278 return false;
279 }
280
2abe74eb 281 m_controller->AddLog(CEC_LOG_DEBUG, "connection opened");
a8f0bd18
LOK
282
283 //clear any input bytes
284 uint8_t buff[1024];
417aca83 285 while (m_port->Read(buff, sizeof(buff), 500) > 0) {}
a8f0bd18 286
828682d3 287 if (CreateThread())
a8f0bd18 288 {
b9eea66d
LOK
289 m_startCondition.Wait(&m_mutex);
290 m_controller->AddLog(CEC_LOG_DEBUG, "communication thread started");
a8f0bd18
LOK
291 return true;
292 }
293 else
294 {
13fd6a66 295 m_controller->AddLog(CEC_LOG_DEBUG, "could not create a communication thread");
a8f0bd18
LOK
296 }
297
298 return false;
299}
300
828682d3 301void CAdapterCommunication::Close(void)
a8f0bd18 302{
f077e8ed 303 CLockObject lock(&m_mutex);
b9eea66d 304 m_startCondition.Broadcast();
d5bffd3c 305 m_rcvCondition.Broadcast();
b9eea66d 306 StopThread();
a8f0bd18
LOK
307}
308
828682d3 309void *CAdapterCommunication::Process(void)
a8f0bd18 310{
b9eea66d
LOK
311 {
312 CLockObject lock(&m_mutex);
313 m_startCondition.Signal();
314 }
12027dbe 315
13fd6a66 316 while (!IsStopped())
a8f0bd18 317 {
b9abf920 318 ReadFromDevice(500);
c02980af 319 Sleep(5);
3c53ac93 320 WriteNextCommand();
a8f0bd18
LOK
321 }
322
a8f0bd18
LOK
323 return NULL;
324}
325
25701fa6 326bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
a8f0bd18 327{
25701fa6 328 int32_t iBytesRead;
13fd6a66
LOK
329 uint8_t buff[1024];
330 if (!m_port)
331 return false;
b6c82769 332
13fd6a66
LOK
333 iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
334 if (iBytesRead < 0 || iBytesRead > 256)
a8f0bd18 335 {
13fd6a66
LOK
336 CStdString strError;
337 strError.Format("error reading from serial port: %s", m_port->GetError().c_str());
338 m_controller->AddLog(CEC_LOG_ERROR, strError);
13fd6a66 339 return false;
a8f0bd18 340 }
13fd6a66
LOK
341 else if (iBytesRead > 0)
342 AddData(buff, (uint8_t) iBytesRead);
25701fa6 343
13fd6a66 344 return iBytesRead > 0;
a8f0bd18
LOK
345}
346
8bca69de 347void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen)
a8f0bd18 348{
f077e8ed 349 CLockObject lock(&m_mutex);
50aa01e6
LOK
350 for (unsigned int iPtr = 0; iPtr < iLen; iPtr++)
351 m_inBuffer.Push(data[iPtr]);
d5bffd3c
LOK
352
353 m_rcvCondition.Signal();
a8f0bd18
LOK
354}
355
3c53ac93 356void CAdapterCommunication::WriteNextCommand(void)
a8f0bd18 357{
28352a04 358 CCECAdapterMessage *msg;
3c53ac93 359 if (m_outBuffer.Pop(msg))
a8f0bd18 360 {
eb35e4ca 361 CLockObject lock(&msg->mutex);
0e31a62c 362 if (m_port->Write(msg) != (int32_t) msg->size())
3c53ac93
LOK
363 {
364 CStdString strError;
365 strError.Format("error writing to serial port: %s", m_port->GetError().c_str());
366 m_controller->AddLog(CEC_LOG_ERROR, strError);
0e31a62c 367 msg->state = ADAPTER_MESSAGE_STATE_ERROR;
3c53ac93
LOK
368 }
369 else
370 {
371 m_controller->AddLog(CEC_LOG_DEBUG, "command sent");
e0407d3d 372 CCondition::Sleep((uint32_t) msg->size() * 24 /*data*/ + 5 /*start bit (4.5 ms)*/ + 10);
0e31a62c 373 msg->state = ADAPTER_MESSAGE_STATE_SENT;
3c53ac93 374 }
eb35e4ca 375 msg->condition.Signal();
25701fa6 376 }
3c53ac93 377}
2abe74eb 378
28352a04 379bool CAdapterCommunication::Write(CCECAdapterMessage *data)
3c53ac93 380{
0e31a62c 381 data->state = ADAPTER_MESSAGE_STATE_WAITING;
3c53ac93 382 m_outBuffer.Push(data);
a8f0bd18
LOK
383 return true;
384}
385
220537f2 386bool CAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
a8f0bd18 387{
f077e8ed 388 CLockObject lock(&m_mutex);
a8f0bd18 389
50aa01e6
LOK
390 msg.clear();
391 uint64_t iNow = GetTimeMs();
392 uint64_t iTarget = iNow + iTimeout;
393 bool bGotFullMessage(false);
394 bool bNextIsEscaped(false);
395 bool bGotStart(false);
a8f0bd18 396
50aa01e6 397 while(!bGotFullMessage && iNow < iTarget)
a8f0bd18 398 {
50aa01e6
LOK
399 uint8_t buf = 0;
400 if (!m_inBuffer.Pop(buf))
a8f0bd18 401 {
56701628 402 if (!m_rcvCondition.Wait(&m_mutex, (uint32_t) (iTarget - iNow)))
50aa01e6 403 return false;
a8f0bd18 404 }
a8f0bd18 405
50aa01e6 406 if (!bGotStart)
a8f0bd18 407 {
50aa01e6
LOK
408 if (buf == MSGSTART)
409 bGotStart = true;
410 continue;
a8f0bd18 411 }
50aa01e6 412 else if (buf == MSGSTART) //we found a msgstart before msgend, this is not right, remove
a8f0bd18 413 {
50aa01e6
LOK
414 m_controller->AddLog(CEC_LOG_ERROR, "received MSGSTART before MSGEND");
415 msg.clear();
416 bGotStart = true;
a8f0bd18 417 }
a8f0bd18 418
50aa01e6 419 if (buf == MSGEND)
a8f0bd18 420 {
50aa01e6 421 bGotFullMessage = true;
a8f0bd18 422 }
50aa01e6
LOK
423 else if (bNextIsEscaped)
424 {
425 msg.push_back(buf + (uint8_t)ESCOFFSET);
426 bNextIsEscaped = false;
427 }
428 else if (buf == MSGESC)
429 bNextIsEscaped = true;
430 else
431 msg.push_back(buf);
a8f0bd18
LOK
432 }
433
0e31a62c
LOK
434 if (bGotFullMessage)
435 msg.state = ADAPTER_MESSAGE_STATE_RECEIVED;
436
50aa01e6 437 return bGotFullMessage;
a8f0bd18
LOK
438}
439
828682d3 440std::string CAdapterCommunication::GetError(void) const
a8f0bd18
LOK
441{
442 return m_port->GetError();
443}
2abe74eb
LOK
444
445bool CAdapterCommunication::StartBootloader(void)
446{
28352a04 447 bool bReturn(false);
2abe74eb 448 if (!IsRunning())
28352a04 449 return bReturn;
2abe74eb
LOK
450
451 m_controller->AddLog(CEC_LOG_DEBUG, "starting the bootloader");
28352a04 452 CCECAdapterMessage *output = new CCECAdapterMessage;
25701fa6 453
5a1e87c8
LOK
454 output->push_back(MSGSTART);
455 output->push_escaped(MSGCODE_START_BOOTLOADER);
456 output->push_back(MSGEND);
2abe74eb 457
28352a04 458 if ((bReturn = Write(output)) == false)
2abe74eb 459 m_controller->AddLog(CEC_LOG_ERROR, "could not start the bootloader");
28352a04
LOK
460
461 delete output;
462
463 return bReturn;
2abe74eb
LOK
464}
465
2abe74eb
LOK
466bool CAdapterCommunication::PingAdapter(void)
467{
28352a04 468 bool bReturn(false);
2abe74eb 469 if (!IsRunning())
28352a04 470 return bReturn;
2abe74eb
LOK
471
472 m_controller->AddLog(CEC_LOG_DEBUG, "sending ping");
28352a04 473 CCECAdapterMessage *output = new CCECAdapterMessage;
25701fa6 474
5a1e87c8
LOK
475 output->push_back(MSGSTART);
476 output->push_escaped(MSGCODE_PING);
477 output->push_back(MSGEND);
2abe74eb 478
28352a04 479 if ((bReturn = Write(output)) == false)
2abe74eb 480 m_controller->AddLog(CEC_LOG_ERROR, "could not send ping command");
2abe74eb
LOK
481
482 // TODO check for pong
28352a04
LOK
483 delete output;
484
485 return bReturn;
2abe74eb 486}
13fd6a66
LOK
487
488bool CAdapterCommunication::IsOpen(void) const
489{
b9eea66d 490 return !IsStopped() && m_port->IsOpen() && IsRunning();
13fd6a66 491}