Commit | Line | Data |
---|---|---|
a75e3a5a LOK |
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 | ||
2b44051c | 33 | #include "env.h" |
a75e3a5a | 34 | #include "USBCECAdapterMessageQueue.h" |
2b44051c | 35 | |
a75e3a5a | 36 | #include "USBCECAdapterCommunication.h" |
2b44051c LOK |
37 | #include "USBCECAdapterMessage.h" |
38 | #include "lib/platform/sockets/socket.h" | |
39 | #include "lib/LibCEC.h" | |
40 | #include "lib/platform/util/StdString.h" | |
a75e3a5a LOK |
41 | |
42 | using namespace CEC; | |
43 | using namespace PLATFORM; | |
8cdaa059 | 44 | using namespace std; |
a75e3a5a | 45 | |
b32ffd87 LOK |
46 | #define MESSAGE_QUEUE_SIGNAL_WAIT_TIME 1000 |
47 | ||
004b8382 LOK |
48 | CCECAdapterMessageQueueEntry::CCECAdapterMessageQueueEntry(CCECAdapterMessageQueue *queue, CCECAdapterMessage *message) : |
49 | m_queue(queue), | |
a75e3a5a LOK |
50 | m_message(message), |
51 | m_iPacketsLeft(message->IsTranmission() ? message->Size() / 4 : 1), | |
52 | m_bSucceeded(false), | |
53 | m_bWaiting(true) {} | |
54 | ||
55 | CCECAdapterMessageQueueEntry::~CCECAdapterMessageQueueEntry(void) { } | |
56 | ||
57 | void CCECAdapterMessageQueueEntry::Broadcast(void) | |
58 | { | |
59 | CLockObject lock(m_mutex); | |
60 | m_condition.Broadcast(); | |
61 | } | |
62 | ||
63 | bool CCECAdapterMessageQueueEntry::MessageReceived(const CCECAdapterMessage &message) | |
64 | { | |
a75e3a5a LOK |
65 | bool bHandled(false); |
66 | ||
8cdaa059 | 67 | if (IsResponse(message)) |
a75e3a5a | 68 | { |
a75e3a5a LOK |
69 | switch (message.Message()) |
70 | { | |
71 | case MSGCODE_COMMAND_ACCEPTED: | |
8cdaa059 | 72 | bHandled = MessageReceivedCommandAccepted(message); |
a75e3a5a LOK |
73 | break; |
74 | case MSGCODE_TRANSMIT_SUCCEEDED: | |
8cdaa059 | 75 | bHandled = MessageReceivedTransmitSucceeded(message); |
a75e3a5a LOK |
76 | break; |
77 | default: | |
8cdaa059 | 78 | bHandled = MessageReceivedResponse(message); |
a75e3a5a LOK |
79 | break; |
80 | } | |
81 | } | |
82 | ||
a75e3a5a LOK |
83 | return bHandled; |
84 | } | |
85 | ||
8cdaa059 LOK |
86 | void CCECAdapterMessageQueueEntry::Signal(void) |
87 | { | |
88 | CLockObject lock(m_mutex); | |
89 | m_bSucceeded = true; | |
90 | m_condition.Signal(); | |
91 | } | |
92 | ||
a75e3a5a LOK |
93 | bool CCECAdapterMessageQueueEntry::Wait(uint32_t iTimeout) |
94 | { | |
95 | bool bReturn(false); | |
96 | /* wait until we receive a signal when the tranmission succeeded */ | |
97 | { | |
98 | CLockObject lock(m_mutex); | |
99 | bReturn = m_bSucceeded ? true : m_condition.Wait(m_mutex, m_bSucceeded, iTimeout); | |
100 | m_bWaiting = false; | |
101 | } | |
102 | return bReturn; | |
103 | } | |
104 | ||
105 | bool CCECAdapterMessageQueueEntry::IsWaiting(void) | |
106 | { | |
107 | CLockObject lock(m_mutex); | |
108 | return m_bWaiting; | |
109 | } | |
110 | ||
111 | cec_adapter_messagecode CCECAdapterMessageQueueEntry::MessageCode(void) | |
112 | { | |
113 | return m_message->Message(); | |
114 | } | |
115 | ||
3ead056c | 116 | bool CCECAdapterMessageQueueEntry::IsResponseOld(const CCECAdapterMessage &msg) |
a75e3a5a LOK |
117 | { |
118 | cec_adapter_messagecode msgCode = msg.Message(); | |
3ead056c | 119 | |
a75e3a5a | 120 | return msgCode == MessageCode() || |
a75e3a5a LOK |
121 | msgCode == MSGCODE_COMMAND_ACCEPTED || |
122 | msgCode == MSGCODE_COMMAND_REJECTED || | |
3ead056c LOK |
123 | (m_message->IsTranmission() && (msgCode == MSGCODE_TIMEOUT_ERROR || |
124 | msgCode == MSGCODE_HIGH_ERROR || | |
125 | msgCode == MSGCODE_LOW_ERROR || | |
126 | msgCode == MSGCODE_RECEIVE_FAILED || | |
127 | msgCode == MSGCODE_TRANSMIT_FAILED_LINE || | |
128 | msgCode == MSGCODE_TRANSMIT_FAILED_ACK || | |
129 | msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA || | |
130 | msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE || | |
131 | msgCode == MSGCODE_TRANSMIT_SUCCEEDED)); | |
132 | } | |
133 | ||
134 | bool CCECAdapterMessageQueueEntry::IsResponse(const CCECAdapterMessage &msg) | |
135 | { | |
136 | cec_adapter_messagecode thisMsgCode = m_message->Message(); | |
137 | cec_adapter_messagecode msgCode = msg.Message(); | |
138 | cec_adapter_messagecode msgResponse = msg.ResponseTo(); | |
139 | ||
140 | // msgcode matches, always a response | |
141 | if (msgCode == MessageCode()) | |
142 | return true; | |
143 | ||
144 | if (!ProvidesExtendedResponse()) | |
145 | return IsResponseOld(msg); | |
146 | ||
147 | // response without a msgcode | |
148 | if (msgResponse == MSGCODE_NOTHING) | |
149 | { | |
150 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_WARNING, "no response code received"); | |
151 | return true; | |
152 | } | |
153 | ||
154 | // commands that only repond with accepted/rejected | |
155 | if (thisMsgCode == MSGCODE_PING || | |
156 | thisMsgCode == MSGCODE_SET_ACK_MASK || | |
157 | thisMsgCode == MSGCODE_SET_CONTROLLED || | |
158 | thisMsgCode == MSGCODE_SET_AUTO_ENABLED || | |
159 | thisMsgCode == MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS || | |
160 | thisMsgCode == MSGCODE_SET_LOGICAL_ADDRESS_MASK || | |
161 | thisMsgCode == MSGCODE_SET_PHYSICAL_ADDRESS || | |
162 | thisMsgCode == MSGCODE_SET_DEVICE_TYPE || | |
163 | thisMsgCode == MSGCODE_SET_HDMI_VERSION || | |
164 | thisMsgCode == MSGCODE_SET_OSD_NAME || | |
165 | thisMsgCode == MSGCODE_WRITE_EEPROM || | |
166 | thisMsgCode == MSGCODE_TRANSMIT_IDLETIME) | |
167 | return thisMsgCode == msgResponse; | |
168 | ||
169 | if (!m_message->IsTranmission()) | |
170 | { | |
171 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_WARNING, "FIXME! not a transmission"); | |
172 | return false; | |
173 | } | |
174 | ||
175 | return ((msgCode == MSGCODE_COMMAND_ACCEPTED || msgCode == MSGCODE_COMMAND_REJECTED) && | |
176 | (msgResponse == MSGCODE_TRANSMIT_ACK_POLARITY || msgResponse == MSGCODE_TRANSMIT || msgResponse == MSGCODE_TRANSMIT_EOM)) || | |
177 | msgCode == MSGCODE_TIMEOUT_ERROR || | |
178 | msgCode == MSGCODE_HIGH_ERROR || | |
179 | msgCode == MSGCODE_LOW_ERROR || | |
180 | msgCode == MSGCODE_RECEIVE_FAILED || | |
181 | msgCode == MSGCODE_TRANSMIT_FAILED_LINE || | |
182 | msgCode == MSGCODE_TRANSMIT_FAILED_ACK || | |
183 | msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA || | |
184 | msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE || | |
185 | msgCode == MSGCODE_TRANSMIT_SUCCEEDED; | |
a75e3a5a LOK |
186 | } |
187 | ||
188 | const char *CCECAdapterMessageQueueEntry::ToString(void) const | |
189 | { | |
190 | /* CEC transmissions got the 'set ack polarity' msgcode, which doesn't look nice */ | |
191 | if (m_message->IsTranmission()) | |
192 | return "CEC transmission"; | |
193 | else | |
194 | return CCECAdapterMessage::ToString(m_message->Message()); | |
195 | } | |
196 | ||
197 | bool CCECAdapterMessageQueueEntry::MessageReceivedCommandAccepted(const CCECAdapterMessage &message) | |
198 | { | |
199 | bool bSendSignal(false); | |
8cdaa059 | 200 | bool bHandled(false); |
a75e3a5a | 201 | { |
8cdaa059 | 202 | CLockObject lock(m_mutex); |
a75e3a5a | 203 | if (m_iPacketsLeft > 0) |
8cdaa059 LOK |
204 | { |
205 | /* decrease by 1 */ | |
a75e3a5a LOK |
206 | m_iPacketsLeft--; |
207 | ||
8cdaa059 LOK |
208 | /* log this message */ |
209 | CStdString strLog; | |
210 | strLog.Format("%s - command accepted", ToString()); | |
211 | if (m_iPacketsLeft > 0) | |
212 | strLog.AppendFormat(" - waiting for %d more", m_iPacketsLeft); | |
004b8382 | 213 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, strLog); |
8cdaa059 LOK |
214 | |
215 | /* no more packets left and not a transmission, so we're done */ | |
216 | if (!m_message->IsTranmission() && m_iPacketsLeft == 0) | |
217 | { | |
218 | m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; | |
219 | m_message->response = message.packet; | |
220 | bSendSignal = true; | |
221 | } | |
222 | bHandled = true; | |
a75e3a5a LOK |
223 | } |
224 | } | |
8cdaa059 LOK |
225 | |
226 | if (bSendSignal) | |
227 | Signal(); | |
228 | ||
229 | return bHandled; | |
a75e3a5a LOK |
230 | } |
231 | ||
232 | bool CCECAdapterMessageQueueEntry::MessageReceivedTransmitSucceeded(const CCECAdapterMessage &message) | |
233 | { | |
a75e3a5a | 234 | { |
8cdaa059 LOK |
235 | CLockObject lock(m_mutex); |
236 | if (m_iPacketsLeft == 0) | |
237 | { | |
238 | /* transmission succeeded, so we're done */ | |
004b8382 | 239 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "%s - transmit succeeded", ToString()); |
8cdaa059 LOK |
240 | m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; |
241 | m_message->response = message.packet; | |
242 | } | |
243 | else | |
244 | { | |
245 | /* error, we expected more acks | |
246 | since the messages are processed in order, this should not happen, so this is an error situation */ | |
004b8382 | 247 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_WARNING, "%s - received 'transmit succeeded' but not enough 'command accepted' messages (%d left)", ToString(), m_iPacketsLeft); |
8cdaa059 LOK |
248 | m_message->state = ADAPTER_MESSAGE_STATE_ERROR; |
249 | } | |
a75e3a5a | 250 | } |
8cdaa059 LOK |
251 | |
252 | Signal(); | |
253 | ||
a75e3a5a LOK |
254 | return true; |
255 | } | |
256 | ||
257 | bool CCECAdapterMessageQueueEntry::MessageReceivedResponse(const CCECAdapterMessage &message) | |
258 | { | |
8cdaa059 LOK |
259 | { |
260 | CLockObject lock(m_mutex); | |
004b8382 | 261 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "%s - received response - %s", ToString(), message.ToString().c_str()); |
8cdaa059 LOK |
262 | m_message->response = message.packet; |
263 | if (m_message->IsTranmission()) | |
264 | m_message->state = message.Message() == MSGCODE_TRANSMIT_SUCCEEDED ? ADAPTER_MESSAGE_STATE_SENT_ACKED : ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED; | |
265 | else | |
266 | m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; | |
267 | } | |
268 | ||
269 | Signal(); | |
270 | ||
a75e3a5a LOK |
271 | return true; |
272 | } | |
273 | ||
3ead056c LOK |
274 | bool CCECAdapterMessageQueueEntry::ProvidesExtendedResponse(void) |
275 | { | |
276 | return m_queue && m_queue->ProvidesExtendedResponse(); | |
277 | } | |
278 | ||
2b44051c LOK |
279 | CCECAdapterMessageQueue::CCECAdapterMessageQueue(CUSBCECAdapterCommunication *com) : |
280 | PLATFORM::CThread(), | |
281 | m_com(com), | |
282 | m_iNextMessage(0) | |
283 | { | |
284 | m_incomingAdapterMessage = new CCECAdapterMessage; | |
285 | m_currentCECFrame.Clear(); | |
286 | } | |
a75e3a5a LOK |
287 | |
288 | CCECAdapterMessageQueue::~CCECAdapterMessageQueue(void) | |
289 | { | |
290 | Clear(); | |
a8559e01 | 291 | StopThread(0); |
2b44051c | 292 | delete m_incomingAdapterMessage; |
a75e3a5a LOK |
293 | } |
294 | ||
295 | void CCECAdapterMessageQueue::Clear(void) | |
296 | { | |
a8559e01 | 297 | StopThread(5); |
a75e3a5a | 298 | CLockObject lock(m_mutex); |
a8559e01 | 299 | m_writeQueue.Clear(); |
8cdaa059 | 300 | m_messages.clear(); |
a75e3a5a LOK |
301 | } |
302 | ||
a8559e01 LOK |
303 | void *CCECAdapterMessageQueue::Process(void) |
304 | { | |
305 | CCECAdapterMessageQueueEntry *message(NULL); | |
306 | while (!IsStopped()) | |
307 | { | |
308 | /* wait for a new message */ | |
55c75e6e | 309 | if (m_writeQueue.Pop(message, MESSAGE_QUEUE_SIGNAL_WAIT_TIME) && message) |
a8559e01 LOK |
310 | { |
311 | /* write this message */ | |
55c75e6e LOK |
312 | { |
313 | CLockObject lock(m_mutex); | |
314 | m_com->WriteToDevice(message->m_message); | |
315 | } | |
316 | if (message->m_message->state == ADAPTER_MESSAGE_STATE_ERROR || | |
317 | message->m_message->Message() == MSGCODE_START_BOOTLOADER) | |
a8559e01 LOK |
318 | { |
319 | message->Signal(); | |
320 | Clear(); | |
321 | break; | |
322 | } | |
323 | } | |
324 | } | |
325 | return NULL; | |
326 | } | |
327 | ||
a75e3a5a LOK |
328 | void CCECAdapterMessageQueue::MessageReceived(const CCECAdapterMessage &msg) |
329 | { | |
8cdaa059 | 330 | bool bHandled(false); |
a75e3a5a | 331 | CLockObject lock(m_mutex); |
8cdaa059 LOK |
332 | /* send the received message to each entry in the queue until it is handled */ |
333 | for (map<uint64_t, CCECAdapterMessageQueueEntry *>::iterator it = m_messages.begin(); !bHandled && it != m_messages.end(); it++) | |
334 | bHandled = it->second->MessageReceived(msg); | |
a75e3a5a | 335 | |
8cdaa059 | 336 | if (!bHandled) |
a75e3a5a LOK |
337 | { |
338 | /* the message wasn't handled */ | |
339 | bool bIsError(m_com->HandlePoll(msg)); | |
2b44051c | 340 | m_com->m_callback->GetLib()->AddLog(bIsError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString().c_str()); |
a75e3a5a LOK |
341 | |
342 | /* push this message to the current frame */ | |
343 | if (!bIsError && msg.PushToCecCommand(m_currentCECFrame)) | |
344 | { | |
345 | /* and push the current frame back over the callback method when a full command was received */ | |
346 | if (m_com->IsInitialised()) | |
347 | m_com->m_callback->OnCommandReceived(m_currentCECFrame); | |
348 | ||
349 | /* clear the current frame */ | |
350 | m_currentCECFrame.Clear(); | |
351 | } | |
352 | } | |
353 | } | |
354 | ||
355 | void CCECAdapterMessageQueue::AddData(uint8_t *data, size_t iLen) | |
356 | { | |
357 | for (size_t iPtr = 0; iPtr < iLen; iPtr++) | |
358 | { | |
359 | bool bFullMessage(false); | |
360 | { | |
361 | CLockObject lock(m_mutex); | |
2b44051c | 362 | bFullMessage = m_incomingAdapterMessage->PushReceivedByte(data[iPtr]); |
a75e3a5a LOK |
363 | } |
364 | ||
365 | if (bFullMessage) | |
366 | { | |
367 | /* a full message was received */ | |
368 | CCECAdapterMessage newMessage; | |
2b44051c | 369 | newMessage.packet = m_incomingAdapterMessage->packet; |
a75e3a5a LOK |
370 | MessageReceived(newMessage); |
371 | ||
372 | /* clear the current message */ | |
373 | CLockObject lock(m_mutex); | |
2b44051c | 374 | m_incomingAdapterMessage->Clear(); |
a75e3a5a LOK |
375 | } |
376 | } | |
377 | } | |
378 | ||
379 | bool CCECAdapterMessageQueue::Write(CCECAdapterMessage *msg) | |
380 | { | |
381 | msg->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT; | |
382 | ||
383 | /* set the correct line timeout */ | |
384 | if (msg->IsTranmission()) | |
385 | { | |
33dd87a9 | 386 | m_com->SetLineTimeout(msg->lineTimeout); |
a75e3a5a LOK |
387 | } |
388 | ||
004b8382 | 389 | CCECAdapterMessageQueueEntry *entry = new CCECAdapterMessageQueueEntry(this, msg); |
8cdaa059 | 390 | uint64_t iEntryId(0); |
a75e3a5a LOK |
391 | /* add to the wait for ack queue */ |
392 | if (msg->Message() != MSGCODE_START_BOOTLOADER) | |
393 | { | |
8cdaa059 | 394 | CLockObject lock(m_mutex); |
8cdaa059 LOK |
395 | iEntryId = m_iNextMessage++; |
396 | m_messages.insert(make_pair(iEntryId, entry)); | |
a75e3a5a LOK |
397 | } |
398 | ||
a8559e01 LOK |
399 | /* add the message to the write queue */ |
400 | m_writeQueue.Push(entry); | |
a75e3a5a | 401 | |
8cdaa059 LOK |
402 | bool bReturn(true); |
403 | if (entry) | |
a75e3a5a | 404 | { |
8cdaa059 | 405 | if (!entry->Wait(msg->transmit_timeout <= 5 ? CEC_DEFAULT_TRANSMIT_WAIT : msg->transmit_timeout)) |
a75e3a5a | 406 | { |
004b8382 | 407 | m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "command '%s' was not acked by the controller", CCECAdapterMessage::ToString(msg->Message())); |
8cdaa059 LOK |
408 | msg->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED; |
409 | bReturn = false; | |
a75e3a5a | 410 | } |
8cdaa059 | 411 | |
55c75e6e LOK |
412 | if (msg->Message() != MSGCODE_START_BOOTLOADER) |
413 | { | |
414 | CLockObject lock(m_mutex); | |
415 | m_messages.erase(iEntryId); | |
416 | } | |
4c2e665c | 417 | delete entry; |
a75e3a5a | 418 | } |
8cdaa059 LOK |
419 | |
420 | return bReturn; | |
a75e3a5a | 421 | } |
3ead056c LOK |
422 | |
423 | bool CCECAdapterMessageQueue::ProvidesExtendedResponse(void) | |
424 | { | |
425 | return m_com && m_com->ProvidesExtendedResponse(); | |
426 | } |