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 | ||
116 | bool CCECAdapterMessageQueueEntry::IsResponse(const CCECAdapterMessage &msg) | |
117 | { | |
118 | cec_adapter_messagecode msgCode = msg.Message(); | |
119 | return msgCode == MessageCode() || | |
7937b924 | 120 | (m_message->IsTranmission() && msgCode == MSGCODE_TIMEOUT_ERROR) || |
a75e3a5a LOK |
121 | msgCode == MSGCODE_COMMAND_ACCEPTED || |
122 | msgCode == MSGCODE_COMMAND_REJECTED || | |
123 | (m_message->IsTranmission() && msgCode == MSGCODE_HIGH_ERROR) || | |
124 | (m_message->IsTranmission() && msgCode == MSGCODE_LOW_ERROR) || | |
125 | (m_message->IsTranmission() && msgCode == MSGCODE_RECEIVE_FAILED) || | |
126 | (m_message->IsTranmission() && msgCode == MSGCODE_TRANSMIT_FAILED_LINE) || | |
127 | (m_message->IsTranmission() && msgCode == MSGCODE_TRANSMIT_FAILED_ACK) || | |
128 | (m_message->IsTranmission() && msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA) || | |
129 | (m_message->IsTranmission() && msgCode == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE) || | |
130 | (m_message->IsTranmission() && msgCode == MSGCODE_TRANSMIT_SUCCEEDED); | |
131 | } | |
132 | ||
133 | const char *CCECAdapterMessageQueueEntry::ToString(void) const | |
134 | { | |
135 | /* CEC transmissions got the 'set ack polarity' msgcode, which doesn't look nice */ | |
136 | if (m_message->IsTranmission()) | |
137 | return "CEC transmission"; | |
138 | else | |
139 | return CCECAdapterMessage::ToString(m_message->Message()); | |
140 | } | |
141 | ||
142 | bool CCECAdapterMessageQueueEntry::MessageReceivedCommandAccepted(const CCECAdapterMessage &message) | |
143 | { | |
144 | bool bSendSignal(false); | |
8cdaa059 | 145 | bool bHandled(false); |
a75e3a5a | 146 | { |
8cdaa059 | 147 | CLockObject lock(m_mutex); |
a75e3a5a | 148 | if (m_iPacketsLeft > 0) |
8cdaa059 LOK |
149 | { |
150 | /* decrease by 1 */ | |
a75e3a5a LOK |
151 | m_iPacketsLeft--; |
152 | ||
8cdaa059 LOK |
153 | /* log this message */ |
154 | CStdString strLog; | |
155 | strLog.Format("%s - command accepted", ToString()); | |
156 | if (m_iPacketsLeft > 0) | |
157 | strLog.AppendFormat(" - waiting for %d more", m_iPacketsLeft); | |
004b8382 | 158 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, strLog); |
8cdaa059 LOK |
159 | |
160 | /* no more packets left and not a transmission, so we're done */ | |
161 | if (!m_message->IsTranmission() && m_iPacketsLeft == 0) | |
162 | { | |
163 | m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; | |
164 | m_message->response = message.packet; | |
165 | bSendSignal = true; | |
166 | } | |
167 | bHandled = true; | |
a75e3a5a LOK |
168 | } |
169 | } | |
8cdaa059 LOK |
170 | |
171 | if (bSendSignal) | |
172 | Signal(); | |
173 | ||
174 | return bHandled; | |
a75e3a5a LOK |
175 | } |
176 | ||
177 | bool CCECAdapterMessageQueueEntry::MessageReceivedTransmitSucceeded(const CCECAdapterMessage &message) | |
178 | { | |
a75e3a5a | 179 | { |
8cdaa059 LOK |
180 | CLockObject lock(m_mutex); |
181 | if (m_iPacketsLeft == 0) | |
182 | { | |
183 | /* transmission succeeded, so we're done */ | |
004b8382 | 184 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "%s - transmit succeeded", ToString()); |
8cdaa059 LOK |
185 | m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; |
186 | m_message->response = message.packet; | |
187 | } | |
188 | else | |
189 | { | |
190 | /* error, we expected more acks | |
191 | since the messages are processed in order, this should not happen, so this is an error situation */ | |
004b8382 | 192 | 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 |
193 | m_message->state = ADAPTER_MESSAGE_STATE_ERROR; |
194 | } | |
a75e3a5a | 195 | } |
8cdaa059 LOK |
196 | |
197 | Signal(); | |
198 | ||
a75e3a5a LOK |
199 | return true; |
200 | } | |
201 | ||
202 | bool CCECAdapterMessageQueueEntry::MessageReceivedResponse(const CCECAdapterMessage &message) | |
203 | { | |
8cdaa059 LOK |
204 | { |
205 | CLockObject lock(m_mutex); | |
004b8382 | 206 | m_queue->m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "%s - received response - %s", ToString(), message.ToString().c_str()); |
8cdaa059 LOK |
207 | m_message->response = message.packet; |
208 | if (m_message->IsTranmission()) | |
209 | m_message->state = message.Message() == MSGCODE_TRANSMIT_SUCCEEDED ? ADAPTER_MESSAGE_STATE_SENT_ACKED : ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED; | |
210 | else | |
211 | m_message->state = ADAPTER_MESSAGE_STATE_SENT_ACKED; | |
212 | } | |
213 | ||
214 | Signal(); | |
215 | ||
a75e3a5a LOK |
216 | return true; |
217 | } | |
218 | ||
2b44051c LOK |
219 | CCECAdapterMessageQueue::CCECAdapterMessageQueue(CUSBCECAdapterCommunication *com) : |
220 | PLATFORM::CThread(), | |
221 | m_com(com), | |
222 | m_iNextMessage(0) | |
223 | { | |
224 | m_incomingAdapterMessage = new CCECAdapterMessage; | |
225 | m_currentCECFrame.Clear(); | |
226 | } | |
a75e3a5a LOK |
227 | |
228 | CCECAdapterMessageQueue::~CCECAdapterMessageQueue(void) | |
229 | { | |
230 | Clear(); | |
a8559e01 | 231 | StopThread(0); |
2b44051c | 232 | delete m_incomingAdapterMessage; |
a75e3a5a LOK |
233 | } |
234 | ||
235 | void CCECAdapterMessageQueue::Clear(void) | |
236 | { | |
a8559e01 | 237 | StopThread(5); |
a75e3a5a | 238 | CLockObject lock(m_mutex); |
a8559e01 | 239 | m_writeQueue.Clear(); |
8cdaa059 | 240 | m_messages.clear(); |
a75e3a5a LOK |
241 | } |
242 | ||
a8559e01 LOK |
243 | void *CCECAdapterMessageQueue::Process(void) |
244 | { | |
245 | CCECAdapterMessageQueueEntry *message(NULL); | |
246 | while (!IsStopped()) | |
247 | { | |
248 | /* wait for a new message */ | |
55c75e6e | 249 | if (m_writeQueue.Pop(message, MESSAGE_QUEUE_SIGNAL_WAIT_TIME) && message) |
a8559e01 LOK |
250 | { |
251 | /* write this message */ | |
55c75e6e LOK |
252 | { |
253 | CLockObject lock(m_mutex); | |
254 | m_com->WriteToDevice(message->m_message); | |
255 | } | |
256 | if (message->m_message->state == ADAPTER_MESSAGE_STATE_ERROR || | |
257 | message->m_message->Message() == MSGCODE_START_BOOTLOADER) | |
a8559e01 LOK |
258 | { |
259 | message->Signal(); | |
260 | Clear(); | |
261 | break; | |
262 | } | |
263 | } | |
264 | } | |
265 | return NULL; | |
266 | } | |
267 | ||
a75e3a5a LOK |
268 | void CCECAdapterMessageQueue::MessageReceived(const CCECAdapterMessage &msg) |
269 | { | |
8cdaa059 | 270 | bool bHandled(false); |
a75e3a5a | 271 | CLockObject lock(m_mutex); |
8cdaa059 LOK |
272 | /* send the received message to each entry in the queue until it is handled */ |
273 | for (map<uint64_t, CCECAdapterMessageQueueEntry *>::iterator it = m_messages.begin(); !bHandled && it != m_messages.end(); it++) | |
274 | bHandled = it->second->MessageReceived(msg); | |
a75e3a5a | 275 | |
8cdaa059 | 276 | if (!bHandled) |
a75e3a5a LOK |
277 | { |
278 | /* the message wasn't handled */ | |
279 | bool bIsError(m_com->HandlePoll(msg)); | |
2b44051c | 280 | m_com->m_callback->GetLib()->AddLog(bIsError ? CEC_LOG_WARNING : CEC_LOG_DEBUG, msg.ToString().c_str()); |
a75e3a5a LOK |
281 | |
282 | /* push this message to the current frame */ | |
283 | if (!bIsError && msg.PushToCecCommand(m_currentCECFrame)) | |
284 | { | |
285 | /* and push the current frame back over the callback method when a full command was received */ | |
286 | if (m_com->IsInitialised()) | |
287 | m_com->m_callback->OnCommandReceived(m_currentCECFrame); | |
288 | ||
289 | /* clear the current frame */ | |
290 | m_currentCECFrame.Clear(); | |
291 | } | |
292 | } | |
293 | } | |
294 | ||
295 | void CCECAdapterMessageQueue::AddData(uint8_t *data, size_t iLen) | |
296 | { | |
297 | for (size_t iPtr = 0; iPtr < iLen; iPtr++) | |
298 | { | |
299 | bool bFullMessage(false); | |
300 | { | |
301 | CLockObject lock(m_mutex); | |
2b44051c | 302 | bFullMessage = m_incomingAdapterMessage->PushReceivedByte(data[iPtr]); |
a75e3a5a LOK |
303 | } |
304 | ||
305 | if (bFullMessage) | |
306 | { | |
307 | /* a full message was received */ | |
308 | CCECAdapterMessage newMessage; | |
2b44051c | 309 | newMessage.packet = m_incomingAdapterMessage->packet; |
a75e3a5a LOK |
310 | MessageReceived(newMessage); |
311 | ||
312 | /* clear the current message */ | |
313 | CLockObject lock(m_mutex); | |
2b44051c | 314 | m_incomingAdapterMessage->Clear(); |
a75e3a5a LOK |
315 | } |
316 | } | |
317 | } | |
318 | ||
319 | bool CCECAdapterMessageQueue::Write(CCECAdapterMessage *msg) | |
320 | { | |
321 | msg->state = ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT; | |
322 | ||
323 | /* set the correct line timeout */ | |
324 | if (msg->IsTranmission()) | |
325 | { | |
33dd87a9 | 326 | m_com->SetLineTimeout(msg->lineTimeout); |
a75e3a5a LOK |
327 | } |
328 | ||
004b8382 | 329 | CCECAdapterMessageQueueEntry *entry = new CCECAdapterMessageQueueEntry(this, msg); |
8cdaa059 | 330 | uint64_t iEntryId(0); |
a75e3a5a LOK |
331 | /* add to the wait for ack queue */ |
332 | if (msg->Message() != MSGCODE_START_BOOTLOADER) | |
333 | { | |
8cdaa059 | 334 | CLockObject lock(m_mutex); |
8cdaa059 LOK |
335 | iEntryId = m_iNextMessage++; |
336 | m_messages.insert(make_pair(iEntryId, entry)); | |
a75e3a5a LOK |
337 | } |
338 | ||
a8559e01 LOK |
339 | /* add the message to the write queue */ |
340 | m_writeQueue.Push(entry); | |
a75e3a5a | 341 | |
8cdaa059 LOK |
342 | bool bReturn(true); |
343 | if (entry) | |
a75e3a5a | 344 | { |
8cdaa059 | 345 | if (!entry->Wait(msg->transmit_timeout <= 5 ? CEC_DEFAULT_TRANSMIT_WAIT : msg->transmit_timeout)) |
a75e3a5a | 346 | { |
004b8382 | 347 | m_com->m_callback->GetLib()->AddLog(CEC_LOG_DEBUG, "command '%s' was not acked by the controller", CCECAdapterMessage::ToString(msg->Message())); |
8cdaa059 LOK |
348 | msg->state = ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED; |
349 | bReturn = false; | |
a75e3a5a | 350 | } |
8cdaa059 | 351 | |
55c75e6e LOK |
352 | if (msg->Message() != MSGCODE_START_BOOTLOADER) |
353 | { | |
354 | CLockObject lock(m_mutex); | |
355 | m_messages.erase(iEntryId); | |
356 | } | |
4c2e665c | 357 | delete entry; |
a75e3a5a | 358 | } |
8cdaa059 LOK |
359 | |
360 | return bReturn; | |
a75e3a5a | 361 | } |