cec: store the status of a bus device: present, not present or handled by libcec
[deb_libcec.git] / src / lib / AdapterCommunication.cpp
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
33 #include "AdapterCommunication.h"
34
35 #include "LibCEC.h"
36 #include "platform/serialport.h"
37 #include "util/StdString.h"
38 #include "platform/timeutils.h"
39
40 using namespace std;
41 using namespace CEC;
42
43 CCECAdapterMessage::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);
59 push_escaped(command.opcode_set == 0 ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
60 push_back(((uint8_t)command.initiator << 4) + (uint8_t)command.destination);
61 push_back(MSGEND);
62
63 // add opcode
64 if (command.opcode_set == 1)
65 {
66 push_back(MSGSTART);
67 push_escaped(command.parameters.IsEmpty() ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
68 push_back((uint8_t) command.opcode);
69 push_back(MSGEND);
70
71 // add parameters
72 for (int8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
73 {
74 push_back(MSGSTART);
75
76 if (iPtr == command.parameters.size - 1)
77 push_escaped( MSGCODE_TRANSMIT_EOM);
78 else
79 push_escaped(MSGCODE_TRANSMIT);
80
81 push_escaped(command.parameters[iPtr]);
82
83 push_back(MSGEND);
84 }
85 }
86
87 // set timeout
88 transmit_timeout = command.transmit_timeout;
89 }
90
91 CCECAdapterMessage &CCECAdapterMessage::operator =(const CCECAdapterMessage &msg)
92 {
93 packet = msg.packet;
94 state = msg.state;
95 return *this;
96 }
97
98 CStdString CCECAdapterMessage::MessageCodeAsString(void) const
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:
110 strMsg = "TIMEOUT";
111 break;
112 case MSGCODE_HIGH_ERROR:
113 strMsg = "HIGH_ERROR";
114 break;
115 case MSGCODE_LOW_ERROR:
116 strMsg = "LOW_ERROR";
117 break;
118 case MSGCODE_FRAME_START:
119 strMsg = "FRAME_START";
120 break;
121 case MSGCODE_FRAME_DATA:
122 strMsg = "FRAME_DATA";
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
183 CStdString 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
215 bool 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
230 void CCECAdapterMessage::push_escaped(uint8_t byte)
231 {
232 if (byte >= MSGESC && byte != MSGSTART)
233 {
234 push_back(MSGESC);
235 push_back(byte - ESCOFFSET);
236 }
237 else
238 push_back(byte);
239 }
240
241 CAdapterCommunication::CAdapterCommunication(CLibCEC *controller) :
242 m_port(NULL),
243 m_controller(controller)
244 {
245 m_port = new CSerialPort;
246 }
247
248 CAdapterCommunication::~CAdapterCommunication(void)
249 {
250 Close();
251
252 if (m_port)
253 {
254 delete m_port;
255 m_port = NULL;
256 }
257 }
258
259 bool CAdapterCommunication::Open(const char *strPort, uint16_t iBaudRate /* = 38400 */, uint32_t iTimeoutMs /* = 10000 */)
260 {
261 CLockObject lock(&m_mutex);
262 if (!m_port)
263 {
264 m_controller->AddLog(CEC_LOG_ERROR, "port is NULL");
265 return false;
266 }
267
268 if (IsOpen())
269 {
270 m_controller->AddLog(CEC_LOG_ERROR, "port is already open");
271 }
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());
277 m_controller->AddLog(CEC_LOG_ERROR, strError);
278 return false;
279 }
280
281 m_controller->AddLog(CEC_LOG_DEBUG, "connection opened");
282
283 //clear any input bytes
284 uint8_t buff[1024];
285 while (m_port->Read(buff, sizeof(buff), 500) > 0) {}
286
287 if (CreateThread())
288 {
289 m_startCondition.Wait(&m_mutex);
290 m_controller->AddLog(CEC_LOG_DEBUG, "communication thread started");
291 return true;
292 }
293 else
294 {
295 m_controller->AddLog(CEC_LOG_DEBUG, "could not create a communication thread");
296 }
297
298 return false;
299 }
300
301 void CAdapterCommunication::Close(void)
302 {
303 CLockObject lock(&m_mutex);
304 m_startCondition.Broadcast();
305 m_rcvCondition.Broadcast();
306 StopThread();
307 }
308
309 void *CAdapterCommunication::Process(void)
310 {
311 {
312 CLockObject lock(&m_mutex);
313 m_startCondition.Signal();
314 }
315
316 while (!IsStopped())
317 {
318 ReadFromDevice(500);
319 Sleep(5);
320 WriteNextCommand();
321 }
322
323 return NULL;
324 }
325
326 bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout)
327 {
328 int32_t iBytesRead;
329 uint8_t buff[1024];
330 if (!m_port)
331 return false;
332
333 iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout);
334 if (iBytesRead < 0 || iBytesRead > 256)
335 {
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);
339 return false;
340 }
341 else if (iBytesRead > 0)
342 AddData(buff, (uint8_t) iBytesRead);
343
344 return iBytesRead > 0;
345 }
346
347 void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen)
348 {
349 CLockObject lock(&m_mutex);
350 for (unsigned int iPtr = 0; iPtr < iLen; iPtr++)
351 m_inBuffer.Push(data[iPtr]);
352
353 m_rcvCondition.Signal();
354 }
355
356 void CAdapterCommunication::WriteNextCommand(void)
357 {
358 CCECAdapterMessage *msg;
359 if (m_outBuffer.Pop(msg))
360 {
361 CLockObject lock(&msg->mutex);
362 if (m_port->Write(msg) != (int32_t) msg->size())
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);
367 msg->state = ADAPTER_MESSAGE_STATE_ERROR;
368 }
369 else
370 {
371 m_controller->AddLog(CEC_LOG_DEBUG, "command sent");
372 CCondition::Sleep((uint32_t) msg->size() * 24 /*data*/ + 5 /*start bit (4.5 ms)*/ + 10);
373 msg->state = ADAPTER_MESSAGE_STATE_SENT;
374 }
375 msg->condition.Signal();
376 }
377 }
378
379 bool CAdapterCommunication::Write(CCECAdapterMessage *data)
380 {
381 data->state = ADAPTER_MESSAGE_STATE_WAITING;
382 m_outBuffer.Push(data);
383 return true;
384 }
385
386 bool CAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout)
387 {
388 CLockObject lock(&m_mutex);
389
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);
396
397 while(!bGotFullMessage && iNow < iTarget)
398 {
399 uint8_t buf = 0;
400 if (!m_inBuffer.Pop(buf))
401 {
402 if (!m_rcvCondition.Wait(&m_mutex, (uint32_t) (iTarget - iNow)))
403 return false;
404 }
405
406 if (!bGotStart)
407 {
408 if (buf == MSGSTART)
409 bGotStart = true;
410 continue;
411 }
412 else if (buf == MSGSTART) //we found a msgstart before msgend, this is not right, remove
413 {
414 m_controller->AddLog(CEC_LOG_ERROR, "received MSGSTART before MSGEND");
415 msg.clear();
416 bGotStart = true;
417 }
418
419 if (buf == MSGEND)
420 {
421 bGotFullMessage = true;
422 }
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);
432 }
433
434 if (bGotFullMessage)
435 msg.state = ADAPTER_MESSAGE_STATE_RECEIVED;
436
437 return bGotFullMessage;
438 }
439
440 std::string CAdapterCommunication::GetError(void) const
441 {
442 return m_port->GetError();
443 }
444
445 bool CAdapterCommunication::StartBootloader(void)
446 {
447 bool bReturn(false);
448 if (!IsRunning())
449 return bReturn;
450
451 m_controller->AddLog(CEC_LOG_DEBUG, "starting the bootloader");
452 CCECAdapterMessage *output = new CCECAdapterMessage;
453
454 output->push_back(MSGSTART);
455 output->push_escaped(MSGCODE_START_BOOTLOADER);
456 output->push_back(MSGEND);
457
458 if ((bReturn = Write(output)) == false)
459 m_controller->AddLog(CEC_LOG_ERROR, "could not start the bootloader");
460
461 delete output;
462
463 return bReturn;
464 }
465
466 bool CAdapterCommunication::PingAdapter(void)
467 {
468 bool bReturn(false);
469 if (!IsRunning())
470 return bReturn;
471
472 m_controller->AddLog(CEC_LOG_DEBUG, "sending ping");
473 CCECAdapterMessage *output = new CCECAdapterMessage;
474
475 output->push_back(MSGSTART);
476 output->push_escaped(MSGCODE_PING);
477 output->push_back(MSGEND);
478
479 if ((bReturn = Write(output)) == false)
480 m_controller->AddLog(CEC_LOG_ERROR, "could not send ping command");
481
482 // TODO check for pong
483 delete output;
484
485 return bReturn;
486 }
487
488 bool CAdapterCommunication::IsOpen(void) const
489 {
490 return !IsStopped() && m_port->IsOpen() && IsRunning();
491 }