cec: send a feature abort again for all unhandled commands, removed statics, refactor...
[deb_libcec.git] / src / lib / adapter / USBCECAdapterCommands.cpp
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
33 #include "USBCECAdapterCommands.h"
34 #include "../LibCEC.h"
35 #include "../CECProcessor.h"
36
37 using namespace CEC;
38 using namespace PLATFORM;
39
40 #define LIB_CEC m_comm->m_callback->GetLib()
41 #define ToString(p) LIB_CEC->ToString(p)
42
43 CUSBCECAdapterCommands::CUSBCECAdapterCommands(CUSBCECAdapterCommunication *comm) :
44 m_comm(comm),
45 m_bSettingsRetrieved(false),
46 m_bSettingAutoEnabled(false),
47 m_settingCecVersion(CEC_VERSION_UNKNOWN),
48 m_iSettingLAMask(0),
49 m_bNeedsWrite(false),
50 m_iBuildDate(CEC_FW_BUILD_UNKNOWN)
51 {
52 m_persistedConfiguration.Clear();
53 }
54
55 cec_datapacket CUSBCECAdapterCommands::RequestSetting(cec_adapter_messagecode msgCode)
56 {
57 cec_datapacket retVal;
58 retVal.Clear();
59
60 CCECAdapterMessage params;
61 CCECAdapterMessage *message = m_comm->SendCommand(msgCode, params);
62 if (message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED)
63 {
64 retVal = message->response;
65 retVal.Shift(2); // shift out start and msgcode
66 retVal.size -= 1; // remove end
67 }
68 delete message;
69 return retVal;
70 }
71
72 uint16_t CUSBCECAdapterCommands::RequestFirmwareVersion(void)
73 {
74 m_persistedConfiguration.iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
75 unsigned int iFwVersionTry(0);
76
77 while (m_persistedConfiguration.iFirmwareVersion == CEC_FW_VERSION_UNKNOWN && iFwVersionTry++ < 3)
78 {
79 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting the firmware version");
80 cec_datapacket response = RequestSetting(MSGCODE_FIRMWARE_VERSION);
81 if (response.size == 2)
82 m_persistedConfiguration.iFirmwareVersion = (response[0] << 8 | response[1]);
83 else
84 {
85 LIB_CEC->AddLog(CEC_LOG_WARNING, "the adapter did not respond with a correct firmware version (try %d)", iFwVersionTry);
86 CEvent::Sleep(500);
87 }
88 }
89
90 if (m_persistedConfiguration.iFirmwareVersion == CEC_FW_VERSION_UNKNOWN)
91 {
92 LIB_CEC->AddLog(CEC_LOG_DEBUG, "defaulting to firmware version 1");
93 m_persistedConfiguration.iFirmwareVersion = 1;
94 }
95
96 return m_persistedConfiguration.iFirmwareVersion;
97 }
98
99 bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(void)
100 {
101 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting autonomous mode setting");
102
103 cec_datapacket response = RequestSetting(MSGCODE_GET_AUTO_ENABLED);
104 if (response.size == 1)
105 {
106 m_bSettingAutoEnabled = response[0] == 1;
107 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted autonomous mode setting: '%s'", m_bSettingAutoEnabled ? "enabled" : "disabled");
108 return true;
109 }
110 return false;
111 }
112
113 bool CUSBCECAdapterCommands::RequestSettingCECVersion(void)
114 {
115 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting CEC version setting");
116
117 cec_datapacket response = RequestSetting(MSGCODE_GET_HDMI_VERSION);
118 if (response.size == 1)
119 {
120 m_settingCecVersion = (cec_version)response[0];
121 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted CEC version setting: '%s'", ToString(m_settingCecVersion));
122 return true;
123 }
124 return false;
125 }
126
127 uint32_t CUSBCECAdapterCommands::RequestBuildDate(void)
128 {
129 if (m_iBuildDate == CEC_FW_BUILD_UNKNOWN)
130 {
131 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting firmware build date");
132
133 cec_datapacket response = RequestSetting(MSGCODE_GET_BUILDDATE);
134 if (response.size == 4)
135 m_iBuildDate = (uint32_t)response[0] << 24 | (uint32_t)response[1] << 16 | (uint32_t)response[2] << 8 | (uint32_t)response[3];
136 }
137 return m_iBuildDate;
138 }
139
140 bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(void)
141 {
142 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting default logical address setting");
143
144 cec_datapacket response = RequestSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS);
145 if (response.size == 1)
146 {
147 m_persistedConfiguration.logicalAddresses.primary = (cec_logical_address)response[0];
148 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted logical address setting: '%s'", ToString(m_persistedConfiguration.logicalAddresses.primary));
149 return true;
150 }
151 return false;
152 }
153
154 bool CUSBCECAdapterCommands::RequestSettingDeviceType(void)
155 {
156 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting device type setting");
157 m_persistedConfiguration.deviceTypes.Clear();
158
159 cec_datapacket response = RequestSetting(MSGCODE_GET_DEVICE_TYPE);
160 if (response.size == 1)
161 {
162 m_persistedConfiguration.deviceTypes.Add((cec_device_type)response[0]);
163 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted device type setting: '%s'", ToString((cec_device_type)response[0]));
164 return true;
165 }
166 LIB_CEC->AddLog(CEC_LOG_DEBUG, "no persisted device type setting");
167 return false;
168 }
169
170 bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(void)
171 {
172 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting logical address mask setting");
173
174 cec_datapacket response = RequestSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK);
175 if (response.size == 2)
176 {
177 m_iSettingLAMask = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
178 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted logical address mask setting: '%x'", m_iSettingLAMask);
179 return true;
180 }
181 return false;
182 }
183
184 bool CUSBCECAdapterCommands::RequestSettingOSDName(void)
185 {
186 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting OSD name setting");
187
188 memset(m_persistedConfiguration.strDeviceName, 0, 13);
189 cec_datapacket response = RequestSetting(MSGCODE_GET_OSD_NAME);
190 if (response.size == 0)
191 {
192 LIB_CEC->AddLog(CEC_LOG_DEBUG, "no persisted device name setting");
193 return false;
194 }
195
196 char buf[14];
197 for (uint8_t iPtr = 0; iPtr < response.size && iPtr < 13; iPtr++)
198 buf[iPtr] = (char)response[iPtr];
199 buf[response.size] = 0;
200
201 snprintf(m_persistedConfiguration.strDeviceName, 13, "%s", buf);
202 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted device name setting: '%s'", buf);
203 return true;
204 }
205
206 bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(void)
207 {
208 LIB_CEC->AddLog(CEC_LOG_DEBUG, "requesting physical address setting");
209
210 cec_datapacket response = RequestSetting(MSGCODE_GET_PHYSICAL_ADDRESS);
211 if (response.size == 2)
212 {
213 m_persistedConfiguration.iPhysicalAddress = ((uint16_t)response[0] << 8) | ((uint16_t)response[1]);
214 LIB_CEC->AddLog(CEC_LOG_DEBUG, "using persisted physical address setting: '%4x'", m_persistedConfiguration.iPhysicalAddress);
215 return true;
216 }
217 LIB_CEC->AddLog(CEC_LOG_DEBUG, "no persisted physical address setting");
218 return false;
219 }
220
221 bool CUSBCECAdapterCommands::SetSettingAutoEnabled(bool enabled)
222 {
223 bool bReturn(true);
224
225 /* check whether this value was changed */
226 if (m_bSettingAutoEnabled == enabled)
227 {
228 LIB_CEC->AddLog(CEC_LOG_DEBUG, "autonomous mode setting unchanged (%s)", enabled ? "on" : "off");
229 return bReturn;
230 }
231
232 m_bNeedsWrite = true;
233 LIB_CEC->AddLog(CEC_LOG_DEBUG, "turning autonomous mode %s", enabled ? "on" : "off");
234
235 CCECAdapterMessage params;
236 params.PushEscaped(enabled ? 1 : 0);
237 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_AUTO_ENABLED, params);
238 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
239 delete message;
240
241 if (bReturn)
242 m_bSettingAutoEnabled = enabled;
243
244 return bReturn;
245 }
246
247 bool CUSBCECAdapterCommands::SetSettingDeviceType(cec_device_type type)
248 {
249 bool bReturn(true);
250
251 /* check whether this value was changed */
252 if (m_persistedConfiguration.deviceTypes.types[0] == type)
253 {
254 LIB_CEC->AddLog(CEC_LOG_DEBUG, "device type setting unchanged (%X)", (uint8_t)type);
255 return bReturn;
256 }
257
258 m_bNeedsWrite = true;
259 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the device type to %X (previous: %X)", (uint8_t)type, (uint8_t)m_persistedConfiguration.deviceTypes.types[0]);
260
261 CCECAdapterMessage params;
262 params.PushEscaped((uint8_t)type);
263 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_DEVICE_TYPE, params);
264 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
265 delete message;
266
267 return bReturn;
268 }
269
270 bool CUSBCECAdapterCommands::SetSettingDefaultLogicalAddress(cec_logical_address address)
271 {
272 bool bReturn(true);
273
274 /* check whether this value was changed */
275 if (m_persistedConfiguration.logicalAddresses.primary == address)
276 {
277 LIB_CEC->AddLog(CEC_LOG_DEBUG, "logical address setting unchanged (%X)", (uint8_t)address);
278 return bReturn;
279 }
280
281 m_bNeedsWrite = true;
282 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the default logical address to %X (previous: %X)", (uint8_t)address, (uint8_t)m_persistedConfiguration.logicalAddresses.primary);
283
284 CCECAdapterMessage params;
285 params.PushEscaped((uint8_t)address);
286 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS, params);
287 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
288 delete message;
289
290 if (bReturn)
291 m_persistedConfiguration.logicalAddresses.primary = address;
292
293 return bReturn;
294 }
295
296 bool CUSBCECAdapterCommands::SetSettingLogicalAddressMask(uint16_t iMask)
297 {
298 bool bReturn(true);
299
300 /* check whether this value was changed */
301 if (m_iSettingLAMask == iMask)
302 {
303 LIB_CEC->AddLog(CEC_LOG_DEBUG, "logical address mask setting unchanged (%2X)", iMask);
304 return bReturn;
305 }
306
307 m_bNeedsWrite = true;
308 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the logical address mask to %2X (previous: %2X)", iMask, m_iSettingLAMask);
309
310 CCECAdapterMessage params;
311 params.PushEscaped(iMask >> 8);
312 params.PushEscaped((uint8_t)iMask);
313 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK, params);
314 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
315 delete message;
316
317 if (bReturn)
318 m_iSettingLAMask = iMask;
319
320 return bReturn;
321 }
322
323 bool CUSBCECAdapterCommands::SetSettingPhysicalAddress(uint16_t iPhysicalAddress)
324 {
325 bool bReturn(true);
326
327 /* check whether this value was changed */
328 if (m_persistedConfiguration.iPhysicalAddress == iPhysicalAddress)
329 {
330 LIB_CEC->AddLog(CEC_LOG_DEBUG, "physical address setting unchanged (%04X)", iPhysicalAddress);
331 return bReturn;
332 }
333
334 m_bNeedsWrite = true;
335 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the physical address to %04X (previous: %04X)", iPhysicalAddress, m_persistedConfiguration.iPhysicalAddress);
336
337 CCECAdapterMessage params;
338 params.PushEscaped(iPhysicalAddress >> 8);
339 params.PushEscaped((uint8_t)iPhysicalAddress);
340 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS, params);
341 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
342 delete message;
343
344 if (bReturn)
345 m_persistedConfiguration.iPhysicalAddress = iPhysicalAddress;
346
347 return bReturn;
348 }
349
350 bool CUSBCECAdapterCommands::SetSettingCECVersion(cec_version version)
351 {
352 bool bReturn(true);
353
354 /* check whether this value was changed */
355 if (m_settingCecVersion == version)
356 {
357 LIB_CEC->AddLog(CEC_LOG_DEBUG, "CEC version setting unchanged (%s)", ToString(version));
358 return bReturn;
359 }
360
361 m_bNeedsWrite = true;
362 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the CEC version to %s (previous: %s)", ToString(version), ToString(m_settingCecVersion));
363
364 CCECAdapterMessage params;
365 params.PushEscaped((uint8_t)version);
366 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_HDMI_VERSION, params);
367 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
368 delete message;
369
370 if (bReturn)
371 m_settingCecVersion = version;
372
373 return bReturn;
374 }
375
376 bool CUSBCECAdapterCommands::SetSettingOSDName(const char *strOSDName)
377 {
378 bool bReturn(true);
379
380 /* check whether this value was changed */
381 if (!strcmp(m_persistedConfiguration.strDeviceName, strOSDName))
382 {
383 LIB_CEC->AddLog(CEC_LOG_DEBUG, "OSD name setting unchanged (%s)", strOSDName);
384 return bReturn;
385 }
386
387 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the OSD name to %s (previous: %s)", strOSDName, m_persistedConfiguration.strDeviceName);
388
389 CCECAdapterMessage params;
390 for (size_t iPtr = 0; iPtr < strlen(strOSDName); iPtr++)
391 params.PushEscaped(strOSDName[iPtr]);
392 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_OSD_NAME, params);
393 bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
394 delete message;
395
396 if (bReturn)
397 snprintf(m_persistedConfiguration.strDeviceName, 13, "%s", strOSDName);
398
399 return bReturn;
400 }
401
402 bool CUSBCECAdapterCommands::WriteEEPROM(void)
403 {
404 if (!m_bNeedsWrite)
405 return true;
406
407 LIB_CEC->AddLog(CEC_LOG_DEBUG, "writing settings in the EEPROM");
408
409 CCECAdapterMessage params;
410 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_WRITE_EEPROM, params);
411 m_bNeedsWrite = !(message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED);
412 delete message;
413 return m_bNeedsWrite;
414 }
415
416 bool CUSBCECAdapterCommands::PersistConfiguration(libcec_configuration *configuration)
417 {
418 if (m_persistedConfiguration.iFirmwareVersion < 2)
419 return false;
420
421 if (!RequestSettings())
422 return false;
423
424 bool bReturn(true);
425 bReturn &= SetSettingAutoEnabled(true);
426 bReturn &= SetSettingDeviceType(CLibCEC::GetType(configuration->logicalAddresses.primary));
427 bReturn &= SetSettingDefaultLogicalAddress(configuration->logicalAddresses.primary);
428 bReturn &= SetSettingLogicalAddressMask(CLibCEC::GetMaskForType(configuration->logicalAddresses.primary));
429 bReturn &= SetSettingPhysicalAddress(configuration->iPhysicalAddress);
430 bReturn &= SetSettingCECVersion(CEC_VERSION_1_3A);
431 bReturn &= SetSettingOSDName(configuration->strDeviceName);
432 bReturn &= WriteEEPROM();
433 return bReturn;
434 }
435
436 bool CUSBCECAdapterCommands::RequestSettings(void)
437 {
438 if (m_persistedConfiguration.iFirmwareVersion < 2)
439 {
440 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - firmware version %d does not have any eeprom settings", __FUNCTION__, m_persistedConfiguration.iFirmwareVersion);
441 // settings can only be persisted with firmware v2+
442 return false;
443 }
444
445 if (m_bSettingsRetrieved)
446 return true;
447
448 bool bReturn(true);
449 bReturn &= RequestSettingAutoEnabled();
450 bReturn &= RequestSettingCECVersion();
451 bReturn &= RequestSettingDefaultLogicalAddress();
452 bReturn &= RequestSettingDeviceType();
453 bReturn &= RequestSettingLogicalAddressMask();
454 bReturn &= RequestSettingOSDName();
455 bReturn &= RequestSettingPhysicalAddress();
456
457 // don't read the following settings:
458 // - auto enabled (always enabled)
459 // - default logical address (autodetected)
460 // - logical address mask (autodetected)
461 // - CEC version (1.3a)
462
463 // TODO to be added to the firmware:
464 // - base device (4 bits)
465 // - HDMI port number (4 bits)
466 // - TV vendor id (12 bits)
467 // - wake devices (8 bits)
468 // - standby devices (8 bits)
469 // - use TV menu language (1 bit)
470 // - activate source (1 bit)
471 // - power off screensaver (1 bit)
472 // - power off on standby (1 bit)
473 // - send inactive source (1 bit)
474
475 m_bSettingsRetrieved = true;
476
477 return bReturn;
478 }
479
480 bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration *configuration)
481 {
482 // get the settings from the eeprom if needed
483 if (!RequestSettings())
484 return false;
485
486 // copy the settings
487 configuration->iFirmwareVersion = m_persistedConfiguration.iFirmwareVersion;
488 configuration->deviceTypes = m_persistedConfiguration.deviceTypes;
489 configuration->iPhysicalAddress = m_persistedConfiguration.iPhysicalAddress;
490 snprintf(configuration->strDeviceName, 13, "%s", m_persistedConfiguration.strDeviceName);
491
492 return true;
493 }
494
495 bool CUSBCECAdapterCommands::PingAdapter(void)
496 {
497 LIB_CEC->AddLog(CEC_LOG_DEBUG, "sending ping");
498
499 CCECAdapterMessage params;
500 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_PING, params);
501 bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
502 delete message;
503 return bReturn;
504 }
505
506 bool CUSBCECAdapterCommands::SetAckMask(uint16_t iMask)
507 {
508 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting ackmask to %2x", iMask);
509
510 CCECAdapterMessage params;
511 params.PushEscaped(iMask >> 8);
512 params.PushEscaped((uint8_t)iMask);
513 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_ACK_MASK, params);
514 bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
515 delete message;
516 return bReturn;
517 }
518
519 bool CUSBCECAdapterCommands::StartBootloader(void)
520 {
521 LIB_CEC->AddLog(CEC_LOG_DEBUG, "starting the bootloader");
522
523 CCECAdapterMessage params;
524 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_START_BOOTLOADER, params);
525 bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
526 delete message;
527 return bReturn;
528 }
529
530 bool CUSBCECAdapterCommands::SetLineTimeout(uint8_t iTimeout)
531 {
532 LIB_CEC->AddLog(CEC_LOG_DEBUG, "setting the line timeout to %d", iTimeout);
533 CCECAdapterMessage params;
534 params.PushEscaped(iTimeout);
535 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_TRANSMIT_IDLETIME, params);
536 bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
537 delete message;
538 return bReturn;
539 }
540
541 bool CUSBCECAdapterCommands::SetControlledMode(bool controlled)
542 {
543 LIB_CEC->AddLog(CEC_LOG_DEBUG, "turning controlled mode %s", controlled ? "on" : "off");
544
545 CCECAdapterMessage params;
546 params.PushEscaped(controlled ? 1 : 0);
547 CCECAdapterMessage *message = m_comm->SendCommand(MSGCODE_SET_CONTROLLED, params);
548 bool bReturn = message->state == ADAPTER_MESSAGE_STATE_SENT_ACKED;
549 delete message;
550 return bReturn;
551 }