Commit | Line | Data |
---|---|---|
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 | 34 | |
ef7696f5 | 35 | #include "AdapterMessage.h" |
1113cb7d | 36 | #include "CECProcessor.h" |
f00ff009 | 37 | #include "platform/serialport/serialport.h" |
a8f0bd18 LOK |
38 | |
39 | using namespace std; | |
40 | using namespace CEC; | |
f00ff009 | 41 | using namespace PLATFORM; |
a8f0bd18 | 42 | |
1113cb7d | 43 | CAdapterCommunication::CAdapterCommunication(CCECProcessor *processor) : |
12027dbe | 44 | m_port(NULL), |
a171d2fd | 45 | m_processor(processor), |
1fc16cfd LOK |
46 | m_iLineTimeout(0), |
47 | m_iFirmwareVersion(CEC_FW_VERSION_UNKNOWN) | |
a8f0bd18 | 48 | { |
f00ff009 | 49 | m_port = new PLATFORM::CSerialPort; |
a8f0bd18 LOK |
50 | } |
51 | ||
828682d3 | 52 | CAdapterCommunication::~CAdapterCommunication(void) |
a8f0bd18 | 53 | { |
12027dbe LOK |
54 | Close(); |
55 | ||
56 | if (m_port) | |
57 | { | |
58 | delete m_port; | |
59 | m_port = NULL; | |
60 | } | |
a8f0bd18 LOK |
61 | } |
62 | ||
25701fa6 | 63 | bool CAdapterCommunication::Open(const char *strPort, uint16_t iBaudRate /* = 38400 */, uint32_t iTimeoutMs /* = 10000 */) |
a8f0bd18 | 64 | { |
7b494bea LOK |
65 | uint64_t iNow = GetTimeMs(); |
66 | uint64_t iTimeout = iNow + iTimeoutMs; | |
67 | ||
f00ff009 | 68 | CLockObject lock(m_mutex); |
7b494bea | 69 | |
13fd6a66 LOK |
70 | if (!m_port) |
71 | { | |
1113cb7d | 72 | m_processor->AddLog(CEC_LOG_ERROR, "port is NULL"); |
a8f0bd18 | 73 | return false; |
13fd6a66 LOK |
74 | } |
75 | ||
76 | if (IsOpen()) | |
77 | { | |
1113cb7d | 78 | m_processor->AddLog(CEC_LOG_ERROR, "port is already open"); |
7b494bea | 79 | return true; |
13fd6a66 | 80 | } |
a8f0bd18 | 81 | |
7b494bea LOK |
82 | CStdString strError; |
83 | bool bConnected(false); | |
84 | while (!bConnected && iNow < iTimeout) | |
85 | { | |
d956c02e | 86 | if ((bConnected = m_port->Open(strPort, iBaudRate)) == false) |
7b494bea LOK |
87 | { |
88 | strError.Format("error opening serial port '%s': %s", strPort, m_port->GetError().c_str()); | |
89 | Sleep(250); | |
90 | iNow = GetTimeMs(); | |
91 | } | |
92 | } | |
93 | ||
94 | if (!bConnected) | |
a8f0bd18 | 95 | { |
1113cb7d | 96 | m_processor->AddLog(CEC_LOG_ERROR, strError); |
a8f0bd18 LOK |
97 | return false; |
98 | } | |
99 | ||
1113cb7d | 100 | m_processor->AddLog(CEC_LOG_DEBUG, "connection opened"); |
a8f0bd18 LOK |
101 | |
102 | //clear any input bytes | |
aee82ba0 LOK |
103 | uint8_t buff[1]; |
104 | while (m_port->Read(buff, 1, 5) == 1) {} | |
a8f0bd18 | 105 | |
828682d3 | 106 | if (CreateThread()) |
a8f0bd18 | 107 | { |
1113cb7d | 108 | m_processor->AddLog(CEC_LOG_DEBUG, "communication thread started"); |
a8f0bd18 LOK |
109 | return true; |
110 | } | |
111 | else | |
112 | { | |
ef7696f5 | 113 | m_processor->AddLog(CEC_LOG_ERROR, "could not create a communication thread"); |
a8f0bd18 LOK |
114 | } |
115 | ||
116 | return false; | |
117 | } | |
118 | ||
828682d3 | 119 | void CAdapterCommunication::Close(void) |
a8f0bd18 | 120 | { |
f00ff009 | 121 | CLockObject lock(m_mutex); |
d5bffd3c | 122 | m_rcvCondition.Broadcast(); |
b9eea66d | 123 | StopThread(); |
a8f0bd18 LOK |
124 | } |
125 | ||
828682d3 | 126 | void *CAdapterCommunication::Process(void) |
a8f0bd18 | 127 | { |
13fd6a66 | 128 | while (!IsStopped()) |
a8f0bd18 | 129 | { |
9e1cfa5c | 130 | ReadFromDevice(50); |
c02980af | 131 | Sleep(5); |
3c53ac93 | 132 | WriteNextCommand(); |
a8f0bd18 LOK |
133 | } |
134 | ||
ef7696f5 | 135 | CCECAdapterMessage *msg(NULL); |
a0878ee3 LOK |
136 | if (m_outBuffer.Pop(msg)) |
137 | msg->condition.Broadcast(); | |
138 | ||
a8f0bd18 LOK |
139 | return NULL; |
140 | } | |
141 | ||
28352a04 | 142 | bool CAdapterCommunication::Write(CCECAdapterMessage *data) |
3c53ac93 | 143 | { |
5dcf9f25 LOK |
144 | bool bReturn(false); |
145 | ||
146 | CLockObject lock(data->mutex); | |
147 | data->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT; | |
3c53ac93 | 148 | m_outBuffer.Push(data); |
5dcf9f25 LOK |
149 | data->condition.Wait(data->mutex); |
150 | ||
151 | if (data->state != ADAPTER_MESSAGE_STATE_SENT) | |
152 | { | |
153 | m_processor->AddLog(CEC_LOG_ERROR, "command was not sent"); | |
154 | } | |
4060d525 LOK |
155 | |
156 | if (data->expectControllerAck) | |
5dcf9f25 | 157 | { |
4060d525 LOK |
158 | bReturn = WaitForTransmitSucceeded(data); |
159 | if (bReturn) | |
160 | { | |
161 | if (data->isTransmission) | |
162 | data->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; | |
163 | } | |
164 | else | |
165 | { | |
166 | data->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED; | |
167 | m_processor->AddLog(CEC_LOG_DEBUG, "did not receive ack"); | |
168 | } | |
5dcf9f25 LOK |
169 | } |
170 | else | |
171 | { | |
4060d525 | 172 | bReturn = true; |
5dcf9f25 LOK |
173 | } |
174 | ||
175 | return bReturn; | |
a8f0bd18 LOK |
176 | } |
177 | ||
220537f2 | 178 | bool CAdapterCommunication::Read(CCECAdapterMessage &msg, uint32_t iTimeout) |
a8f0bd18 | 179 | { |
f00ff009 | 180 | CLockObject lock(m_mutex); |
a8f0bd18 | 181 | |
ef7696f5 | 182 | msg.Clear(); |
50aa01e6 LOK |
183 | uint64_t iNow = GetTimeMs(); |
184 | uint64_t iTarget = iNow + iTimeout; | |
185 | bool bGotFullMessage(false); | |
186 | bool bNextIsEscaped(false); | |
187 | bool bGotStart(false); | |
a8f0bd18 | 188 | |
50aa01e6 | 189 | while(!bGotFullMessage && iNow < iTarget) |
a8f0bd18 | 190 | { |
50aa01e6 LOK |
191 | uint8_t buf = 0; |
192 | if (!m_inBuffer.Pop(buf)) | |
a8f0bd18 | 193 | { |
f00ff009 | 194 | if (!m_rcvCondition.Wait(m_mutex, (uint32_t) (iTarget - iNow))) |
50aa01e6 | 195 | return false; |
a8f0bd18 | 196 | } |
a8f0bd18 | 197 | |
50aa01e6 | 198 | if (!bGotStart) |
a8f0bd18 | 199 | { |
50aa01e6 LOK |
200 | if (buf == MSGSTART) |
201 | bGotStart = true; | |
202 | continue; | |
a8f0bd18 | 203 | } |
50aa01e6 | 204 | else if (buf == MSGSTART) //we found a msgstart before msgend, this is not right, remove |
a8f0bd18 | 205 | { |
ef7696f5 | 206 | if (msg.Size() > 0) |
1113cb7d | 207 | m_processor->AddLog(CEC_LOG_WARNING, "received MSGSTART before MSGEND, removing previous buffer contents"); |
ef7696f5 | 208 | msg.Clear(); |
50aa01e6 | 209 | bGotStart = true; |
a8f0bd18 | 210 | } |
a8f0bd18 | 211 | |
50aa01e6 | 212 | if (buf == MSGEND) |
a8f0bd18 | 213 | { |
50aa01e6 | 214 | bGotFullMessage = true; |
a8f0bd18 | 215 | } |
50aa01e6 LOK |
216 | else if (bNextIsEscaped) |
217 | { | |
ef7696f5 | 218 | msg.PushBack(buf + (uint8_t)ESCOFFSET); |
50aa01e6 LOK |
219 | bNextIsEscaped = false; |
220 | } | |
221 | else if (buf == MSGESC) | |
222 | bNextIsEscaped = true; | |
223 | else | |
ef7696f5 | 224 | msg.PushBack(buf); |
a8f0bd18 LOK |
225 | } |
226 | ||
0e31a62c | 227 | if (bGotFullMessage) |
5dcf9f25 | 228 | msg.state = ADAPTER_MESSAGE_STATE_INCOMING; |
0e31a62c | 229 | |
50aa01e6 | 230 | return bGotFullMessage; |
a8f0bd18 LOK |
231 | } |
232 | ||
828682d3 | 233 | std::string CAdapterCommunication::GetError(void) const |
a8f0bd18 LOK |
234 | { |
235 | return m_port->GetError(); | |
236 | } | |
2abe74eb LOK |
237 | |
238 | bool CAdapterCommunication::StartBootloader(void) | |
239 | { | |
28352a04 | 240 | bool bReturn(false); |
2abe74eb | 241 | if (!IsRunning()) |
28352a04 | 242 | return bReturn; |
2abe74eb | 243 | |
1113cb7d | 244 | m_processor->AddLog(CEC_LOG_DEBUG, "starting the bootloader"); |
28352a04 | 245 | CCECAdapterMessage *output = new CCECAdapterMessage; |
25701fa6 | 246 | |
ef7696f5 LOK |
247 | output->PushBack(MSGSTART); |
248 | output->PushEscaped(MSGCODE_START_BOOTLOADER); | |
249 | output->PushBack(MSGEND); | |
5dcf9f25 | 250 | output->isTransmission = false; |
71c4a2f5 | 251 | output->expectControllerAck = false; |
2abe74eb | 252 | |
5dcf9f25 LOK |
253 | if ((bReturn = Write(output)) == false) |
254 | m_processor->AddLog(CEC_LOG_ERROR, "could not start the bootloader"); | |
28352a04 LOK |
255 | delete output; |
256 | ||
257 | return bReturn; | |
2abe74eb LOK |
258 | } |
259 | ||
2abe74eb LOK |
260 | bool CAdapterCommunication::PingAdapter(void) |
261 | { | |
28352a04 | 262 | bool bReturn(false); |
2abe74eb | 263 | if (!IsRunning()) |
28352a04 | 264 | return bReturn; |
2abe74eb | 265 | |
1113cb7d | 266 | m_processor->AddLog(CEC_LOG_DEBUG, "sending ping"); |
28352a04 | 267 | CCECAdapterMessage *output = new CCECAdapterMessage; |
25701fa6 | 268 | |
ef7696f5 LOK |
269 | output->PushBack(MSGSTART); |
270 | output->PushEscaped(MSGCODE_PING); | |
271 | output->PushBack(MSGEND); | |
5dcf9f25 | 272 | output->isTransmission = false; |
2abe74eb | 273 | |
5dcf9f25 LOK |
274 | if ((bReturn = Write(output)) == false) |
275 | m_processor->AddLog(CEC_LOG_ERROR, "could not ping the adapter"); | |
28352a04 LOK |
276 | delete output; |
277 | ||
278 | return bReturn; | |
2abe74eb | 279 | } |
13fd6a66 | 280 | |
1fc16cfd LOK |
281 | uint16_t CAdapterCommunication::GetFirmwareVersion(void) |
282 | { | |
283 | uint16_t iReturn(m_iFirmwareVersion); | |
284 | if (!IsRunning()) | |
285 | return iReturn; | |
286 | ||
287 | if (iReturn == CEC_FW_VERSION_UNKNOWN) | |
288 | { | |
289 | m_processor->AddLog(CEC_LOG_DEBUG, "requesting the firmware version"); | |
290 | CCECAdapterMessage *output = new CCECAdapterMessage; | |
291 | ||
292 | output->PushBack(MSGSTART); | |
293 | output->PushEscaped(MSGCODE_FIRMWARE_VERSION); | |
294 | output->PushBack(MSGEND); | |
295 | output->isTransmission = false; | |
296 | output->expectControllerAck = false; | |
297 | ||
298 | SendMessageToAdapter(output); | |
299 | delete output; | |
300 | ||
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"); | |
304 | else | |
305 | { | |
306 | m_iFirmwareVersion = (input[1] << 8 | input[2]); | |
307 | iReturn = m_iFirmwareVersion; | |
308 | } | |
309 | } | |
310 | ||
311 | return iReturn; | |
312 | } | |
313 | ||
a171d2fd LOK |
314 | bool CAdapterCommunication::SetLineTimeout(uint8_t iTimeout) |
315 | { | |
316 | bool bReturn(m_iLineTimeout != iTimeout); | |
317 | ||
318 | if (!bReturn) | |
319 | { | |
320 | CCECAdapterMessage *output = new CCECAdapterMessage; | |
321 | ||
ef7696f5 LOK |
322 | output->PushBack(MSGSTART); |
323 | output->PushEscaped(MSGCODE_TRANSMIT_IDLETIME); | |
324 | output->PushEscaped(iTimeout); | |
325 | output->PushBack(MSGEND); | |
5dcf9f25 | 326 | output->isTransmission = false; |
a171d2fd LOK |
327 | |
328 | if ((bReturn = Write(output)) == false) | |
329 | m_processor->AddLog(CEC_LOG_ERROR, "could not set the idletime"); | |
330 | delete output; | |
331 | } | |
332 | ||
333 | return bReturn; | |
334 | } | |
335 | ||
5dcf9f25 LOK |
336 | bool CAdapterCommunication::SetAckMask(uint16_t iMask) |
337 | { | |
338 | bool bReturn(false); | |
339 | CStdString strLog; | |
340 | strLog.Format("setting ackmask to %2x", iMask); | |
341 | m_processor->AddLog(CEC_LOG_DEBUG, strLog.c_str()); | |
342 | ||
343 | CCECAdapterMessage *output = new CCECAdapterMessage; | |
344 | ||
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; | |
351 | ||
352 | if ((bReturn = Write(output)) == false) | |
353 | m_processor->AddLog(CEC_LOG_ERROR, "could not set the ackmask"); | |
354 | delete output; | |
355 | ||
356 | return bReturn; | |
357 | } | |
358 | ||
f00ff009 | 359 | bool CAdapterCommunication::IsOpen(void) |
13fd6a66 | 360 | { |
b9eea66d | 361 | return !IsStopped() && m_port->IsOpen() && IsRunning(); |
13fd6a66 | 362 | } |
ef7696f5 | 363 | |
6729ac71 LOK |
364 | bool CAdapterCommunication::WaitForTransmitSucceeded(CCECAdapterMessage *message) |
365 | { | |
366 | bool bError(false); | |
367 | bool bTransmitSucceeded(false); | |
368 | uint8_t iPacketsLeft(message->Size() / 4); | |
369 | ||
370 | int64_t iNow = GetTimeMs(); | |
371 | int64_t iTargetTime = iNow + message->transmit_timeout; | |
372 | ||
373 | while (!bTransmitSucceeded && !bError && (message->transmit_timeout == 0 || iNow < iTargetTime)) | |
374 | { | |
375 | CCECAdapterMessage msg; | |
376 | ||
377 | if (!Read(msg, message->transmit_timeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000)) | |
378 | { | |
379 | iNow = GetTimeMs(); | |
380 | continue; | |
381 | } | |
382 | ||
383 | if (msg.Message() == MSGCODE_FRAME_START && msg.IsACK()) | |
384 | { | |
385 | m_processor->HandlePoll(msg.Initiator(), msg.Destination()); | |
386 | iNow = GetTimeMs(); | |
387 | continue; | |
388 | } | |
389 | ||
390 | if (msg.Message() == MSGCODE_RECEIVE_FAILED && | |
391 | m_processor->HandleReceiveFailed()) | |
392 | { | |
393 | iNow = GetTimeMs(); | |
394 | continue; | |
395 | } | |
396 | ||
397 | bError = msg.IsError(); | |
398 | if (bError) | |
399 | { | |
400 | message->reply = msg.Message(); | |
401 | m_processor->AddLog(CEC_LOG_DEBUG, msg.ToString()); | |
402 | } | |
403 | else | |
404 | { | |
405 | switch(msg.Message()) | |
406 | { | |
407 | case MSGCODE_COMMAND_ACCEPTED: | |
408 | m_processor->AddLog(CEC_LOG_DEBUG, msg.ToString()); | |
409 | if (iPacketsLeft > 0) | |
410 | iPacketsLeft--; | |
5dcf9f25 LOK |
411 | if (!message->isTransmission && iPacketsLeft == 0) |
412 | bTransmitSucceeded = true; | |
6729ac71 LOK |
413 | break; |
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; | |
419 | break; | |
420 | default: | |
421 | // ignore other data while waiting | |
422 | break; | |
423 | } | |
424 | ||
425 | iNow = GetTimeMs(); | |
426 | } | |
427 | } | |
428 | ||
429 | return bTransmitSucceeded && !bError; | |
430 | } | |
431 | ||
ef7696f5 LOK |
432 | void CAdapterCommunication::AddData(uint8_t *data, uint8_t iLen) |
433 | { | |
434 | CLockObject lock(m_mutex); | |
435 | for (uint8_t iPtr = 0; iPtr < iLen; iPtr++) | |
436 | m_inBuffer.Push(data[iPtr]); | |
437 | ||
438 | m_rcvCondition.Signal(); | |
439 | } | |
440 | ||
441 | bool CAdapterCommunication::ReadFromDevice(uint32_t iTimeout) | |
442 | { | |
443 | int32_t iBytesRead; | |
444 | uint8_t buff[1024]; | |
445 | if (!m_port) | |
446 | return false; | |
447 | ||
1fc16cfd | 448 | CLockObject lock(m_mutex); |
ef7696f5 LOK |
449 | iBytesRead = m_port->Read(buff, sizeof(buff), iTimeout); |
450 | if (iBytesRead < 0 || iBytesRead > 256) | |
451 | { | |
452 | CStdString strError; | |
453 | strError.Format("error reading from serial port: %s", m_port->GetError().c_str()); | |
454 | m_processor->AddLog(CEC_LOG_ERROR, strError); | |
455 | return false; | |
456 | } | |
457 | else if (iBytesRead > 0) | |
458 | AddData(buff, (uint8_t) iBytesRead); | |
459 | ||
460 | return iBytesRead > 0; | |
461 | } | |
462 | ||
463 | void CAdapterCommunication::SendMessageToAdapter(CCECAdapterMessage *msg) | |
464 | { | |
1fc16cfd | 465 | CLockObject adapterLock(m_mutex); |
ef7696f5 LOK |
466 | CLockObject lock(msg->mutex); |
467 | if (m_port->Write(msg->packet.data, msg->Size()) != (int32_t) msg->Size()) | |
468 | { | |
469 | CStdString strError; | |
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; | |
473 | } | |
474 | else | |
475 | { | |
476 | m_processor->AddLog(CEC_LOG_DEBUG, "command sent"); | |
477 | msg->state = ADAPTER_MESSAGE_STATE_SENT; | |
478 | } | |
479 | msg->condition.Signal(); | |
480 | } | |
481 | ||
482 | void CAdapterCommunication::WriteNextCommand(void) | |
483 | { | |
484 | CCECAdapterMessage *msg(NULL); | |
485 | if (m_outBuffer.Pop(msg)) | |
486 | SendMessageToAdapter(msg); | |
487 | } |