2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
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/
34 #include "USBCECAdapterCommands.h"
36 #include "USBCECAdapterMessage.h"
37 #include "USBCECAdapterCommunication.h"
38 #include "lib/LibCEC.h"
39 #include "lib/CECProcessor.h"
40 #include "lib/CECTypeUtils.h"
44 using namespace PLATFORM
;
46 #define LIB_CEC m_comm->m_callback->GetLib()
47 #define ToString(p) CCECTypeUtils::ToString(p)
49 CUSBCECAdapterCommands::CUSBCECAdapterCommands(CUSBCECAdapterCommunication
*comm
) :
51 m_bSettingsRetrieved(false),
52 m_bSettingAutoEnabled(false),
53 m_settingCecVersion(CEC_VERSION_UNKNOWN
),
56 m_iBuildDate(CEC_FW_BUILD_UNKNOWN
),
57 m_bControlledMode(false),
58 m_adapterType(P8_ADAPTERTYPE_UNKNOWN
)
60 m_persistedConfiguration
.Clear();
63 cec_datapacket
CUSBCECAdapterCommands::RequestSetting(cec_adapter_messagecode msgCode
)
65 cec_datapacket retVal
;
68 CCECAdapterMessage params
;
69 CCECAdapterMessage
*message
= m_comm
->SendCommand(msgCode
, params
);
70 if (message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
)
72 retVal
= message
->response
;
73 retVal
.Shift(2); // shift out start and msgcode
74 retVal
.size
-= 1; // remove end
81 uint16_t CUSBCECAdapterCommands::RequestFirmwareVersion(void)
83 m_persistedConfiguration
.iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
84 unsigned int iFwVersionTry(0);
86 while (m_persistedConfiguration
.iFirmwareVersion
== CEC_FW_VERSION_UNKNOWN
&& iFwVersionTry
++ < 3)
89 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
91 cec_datapacket response
= RequestSetting(MSGCODE_FIRMWARE_VERSION
);
92 if (response
.size
== 2)
93 m_persistedConfiguration
.iFirmwareVersion
= (response
[0] << 8 | response
[1]);
96 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "the adapter did not respond with a correct firmware version (try %d, size = %d)", iFwVersionTry
, response
.size
);
101 if (m_persistedConfiguration
.iFirmwareVersion
== CEC_FW_VERSION_UNKNOWN
)
103 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "defaulting to firmware version 1");
104 m_persistedConfiguration
.iFirmwareVersion
= 1;
107 // firmware versions < 2 don't have an autonomous mode
108 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
109 m_bControlledMode
= true;
111 return m_persistedConfiguration
.iFirmwareVersion
;
114 bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(void)
117 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting autonomous mode setting");
120 cec_datapacket response
= RequestSetting(MSGCODE_GET_AUTO_ENABLED
);
121 if (response
.size
== 1)
123 m_bSettingAutoEnabled
= response
[0] == 1;
124 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted autonomous mode setting: '%s'", m_bSettingAutoEnabled
? "enabled" : "disabled");
130 bool CUSBCECAdapterCommands::RequestSettingCECVersion(void)
133 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting CEC version setting");
136 cec_datapacket response
= RequestSetting(MSGCODE_GET_HDMI_VERSION
);
137 if (response
.size
== 1)
139 m_settingCecVersion
= (cec_version
)response
[0];
140 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted CEC version setting: '%s'", ToString(m_settingCecVersion
));
146 p8_cec_adapter_type
CUSBCECAdapterCommands::RequestAdapterType(void)
148 if (m_adapterType
== P8_ADAPTERTYPE_UNKNOWN
)
151 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting adapter type");
154 cec_datapacket response
= RequestSetting(MSGCODE_GET_ADAPTER_TYPE
);
155 if (response
.size
== 1)
156 m_adapterType
= (p8_cec_adapter_type
)response
[0];
158 return m_adapterType
;
161 uint32_t CUSBCECAdapterCommands::RequestBuildDate(void)
163 if (m_iBuildDate
== CEC_FW_BUILD_UNKNOWN
)
166 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting firmware build date");
169 cec_datapacket response
= RequestSetting(MSGCODE_GET_BUILDDATE
);
170 if (response
.size
== 4)
171 m_iBuildDate
= (uint32_t)response
[0] << 24 | (uint32_t)response
[1] << 16 | (uint32_t)response
[2] << 8 | (uint32_t)response
[3];
176 bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(void)
179 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting default logical address setting");
182 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS
);
183 if (response
.size
== 1)
185 m_persistedConfiguration
.logicalAddresses
.primary
= (cec_logical_address
)response
[0];
186 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted logical address setting: '%s'", ToString(m_persistedConfiguration
.logicalAddresses
.primary
));
192 bool CUSBCECAdapterCommands::RequestSettingDeviceType(void)
195 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting device type setting");
197 m_persistedConfiguration
.deviceTypes
.Clear();
199 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEVICE_TYPE
);
200 if (response
.size
== 1)
202 m_persistedConfiguration
.deviceTypes
.Add((cec_device_type
)response
[0]);
203 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted device type setting: '%s'", ToString((cec_device_type
)response
[0]));
206 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted device type setting");
210 bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(void)
213 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting logical address mask setting");
216 cec_datapacket response
= RequestSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK
);
217 if (response
.size
== 2)
219 m_iSettingLAMask
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
220 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted logical address mask setting: '%x'", m_iSettingLAMask
);
226 bool CUSBCECAdapterCommands::RequestSettingOSDName(void)
229 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting OSD name setting");
232 memset(m_persistedConfiguration
.strDeviceName
, 0, 13);
233 cec_datapacket response
= RequestSetting(MSGCODE_GET_OSD_NAME
);
234 if (response
.size
== 0)
236 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted device name setting");
241 for (uint8_t iPtr
= 0; iPtr
< response
.size
&& iPtr
< 13; iPtr
++)
242 buf
[iPtr
] = (char)response
[iPtr
];
243 buf
[response
.size
] = 0;
245 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", buf
);
246 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted device name setting: '%s'", buf
);
250 bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(void)
253 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting physical address setting");
256 cec_datapacket response
= RequestSetting(MSGCODE_GET_PHYSICAL_ADDRESS
);
257 if (response
.size
== 2)
259 m_persistedConfiguration
.iPhysicalAddress
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
260 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted physical address setting: '%4x'", m_persistedConfiguration
.iPhysicalAddress
);
263 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted physical address setting");
267 bool CUSBCECAdapterCommands::SetSettingAutoEnabled(bool enabled
)
271 /* check whether this value was changed */
273 CLockObject
lock(m_mutex
);
274 if (m_bSettingAutoEnabled
== enabled
)
276 m_bNeedsWrite
= true;
279 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "turning autonomous mode %s", enabled
? "on" : "off");
281 CCECAdapterMessage params
;
282 params
.PushEscaped(enabled
? 1 : 0);
283 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_AUTO_ENABLED
, params
);
284 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
289 CLockObject
lock(m_mutex
);
290 m_bSettingAutoEnabled
= enabled
;
296 bool CUSBCECAdapterCommands::SetSettingDeviceType(cec_device_type type
)
300 /* check whether this value was changed */
302 CLockObject
lock(m_mutex
);
303 if (m_persistedConfiguration
.deviceTypes
.types
[0] == type
)
305 m_bNeedsWrite
= true;
308 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the device type to %X (previous: %X)", (uint8_t)type
, (uint8_t)m_persistedConfiguration
.deviceTypes
.types
[0]);
310 CCECAdapterMessage params
;
311 params
.PushEscaped((uint8_t)type
);
312 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEVICE_TYPE
, params
);
313 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
318 CLockObject
lock(m_mutex
);
319 m_persistedConfiguration
.deviceTypes
.types
[0] = type
;
325 bool CUSBCECAdapterCommands::SetSettingDefaultLogicalAddress(cec_logical_address address
)
329 /* check whether this value was changed */
331 CLockObject
lock(m_mutex
);
332 if (m_persistedConfiguration
.logicalAddresses
.primary
== address
)
334 m_bNeedsWrite
= true;
337 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the default logical address to %X (previous: %X)", (uint8_t)address
, (uint8_t)m_persistedConfiguration
.logicalAddresses
.primary
);
339 CCECAdapterMessage params
;
340 params
.PushEscaped((uint8_t)address
);
341 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS
, params
);
342 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
347 CLockObject
lock(m_mutex
);
348 m_persistedConfiguration
.logicalAddresses
.primary
= address
;
354 bool CUSBCECAdapterCommands::SetSettingLogicalAddressMask(uint16_t iMask
)
358 /* check whether this value was changed */
360 CLockObject
lock(m_mutex
);
361 if (m_iSettingLAMask
== iMask
)
363 m_bNeedsWrite
= true;
366 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the logical address mask to %2X (previous: %2X)", iMask
, m_iSettingLAMask
);
368 CCECAdapterMessage params
;
369 params
.PushEscaped(iMask
>> 8);
370 params
.PushEscaped((uint8_t)iMask
);
371 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK
, params
);
372 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
377 CLockObject
lock(m_mutex
);
378 m_iSettingLAMask
= iMask
;
384 bool CUSBCECAdapterCommands::SetSettingPhysicalAddress(uint16_t iPhysicalAddress
)
388 /* check whether this value was changed */
390 CLockObject
lock(m_mutex
);
391 if (m_persistedConfiguration
.iPhysicalAddress
== iPhysicalAddress
)
393 m_bNeedsWrite
= true;
396 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the physical address to %04X (previous: %04X)", iPhysicalAddress
, m_persistedConfiguration
.iPhysicalAddress
);
398 CCECAdapterMessage params
;
399 params
.PushEscaped(iPhysicalAddress
>> 8);
400 params
.PushEscaped((uint8_t)iPhysicalAddress
);
401 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS
, params
);
402 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
407 CLockObject
lock(m_mutex
);
408 m_persistedConfiguration
.iPhysicalAddress
= iPhysicalAddress
;
414 bool CUSBCECAdapterCommands::SetSettingCECVersion(cec_version version
)
418 /* check whether this value was changed */
420 CLockObject
lock(m_mutex
);
421 if (m_settingCecVersion
== version
)
423 m_bNeedsWrite
= true;
426 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the CEC version to %s (previous: %s)", ToString(version
), ToString(m_settingCecVersion
));
428 CCECAdapterMessage params
;
429 params
.PushEscaped((uint8_t)version
);
430 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_HDMI_VERSION
, params
);
431 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
436 CLockObject
lock(m_mutex
);
437 m_settingCecVersion
= version
;
443 bool CUSBCECAdapterCommands::SetSettingOSDName(const char *strOSDName
)
447 /* check whether this value was changed */
448 if (!strcmp(m_persistedConfiguration
.strDeviceName
, strOSDName
))
451 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the OSD name to %s (previous: %s)", strOSDName
, m_persistedConfiguration
.strDeviceName
);
453 CCECAdapterMessage params
;
454 for (size_t iPtr
= 0; iPtr
< strlen(strOSDName
); iPtr
++)
455 params
.PushEscaped(strOSDName
[iPtr
]);
456 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_OSD_NAME
, params
);
457 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
461 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", strOSDName
);
466 bool CUSBCECAdapterCommands::WriteEEPROM(void)
469 CLockObject
lock(m_mutex
);
474 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "writing settings in the EEPROM");
476 CCECAdapterMessage params
;
477 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_WRITE_EEPROM
, params
);
478 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
483 CLockObject
lock(m_mutex
);
484 m_bNeedsWrite
= false;
490 bool CUSBCECAdapterCommands::PersistConfiguration(const libcec_configuration
&configuration
)
493 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
496 if (!RequestSettings())
499 bReturn
|= SetSettingAutoEnabled(true);
500 bReturn
|= SetSettingDeviceType(CLibCEC::GetType(configuration
.logicalAddresses
.primary
));
501 bReturn
|= SetSettingDefaultLogicalAddress(configuration
.logicalAddresses
.primary
);
502 bReturn
|= SetSettingLogicalAddressMask(CLibCEC::GetMaskForType(configuration
.logicalAddresses
.primary
));
503 bReturn
|= SetSettingPhysicalAddress(configuration
.iPhysicalAddress
);
504 bReturn
|= SetSettingCECVersion(configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_8_0
? configuration
.cecVersion
: CEC_VERSION_1_4
);
505 bReturn
|= SetSettingOSDName(configuration
.strDeviceName
);
510 bool CUSBCECAdapterCommands::RequestSettings(void)
512 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
514 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - firmware version %d does not have any eeprom settings", __FUNCTION__
, m_persistedConfiguration
.iFirmwareVersion
);
515 // settings can only be persisted with firmware v2+
519 if (m_bSettingsRetrieved
)
523 bReturn
&= RequestSettingAutoEnabled();
524 bReturn
&= RequestSettingCECVersion();
525 bReturn
&= RequestSettingDefaultLogicalAddress();
526 bReturn
&= RequestSettingDeviceType();
527 bReturn
&= RequestSettingLogicalAddressMask();
528 bReturn
&= RequestSettingOSDName();
529 bReturn
&= RequestSettingPhysicalAddress();
531 // don't read the following settings:
532 // - auto enabled (always enabled)
533 // - default logical address (autodetected)
534 // - logical address mask (autodetected)
535 // - CEC version (1.3a)
537 // TODO to be added to the firmware:
538 // - base device (4 bits)
539 // - HDMI port number (4 bits)
540 // - TV vendor id (12 bits)
541 // - wake devices (8 bits)
542 // - standby devices (8 bits)
543 // - use TV menu language (1 bit)
544 // - activate source (1 bit)
545 // - power off screensaver (1 bit)
546 // - power off on standby (1 bit)
547 // - send inactive source (1 bit)
549 m_bSettingsRetrieved
= true;
554 bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration
&configuration
)
556 // get the settings from the eeprom if needed
557 if (!RequestSettings())
561 configuration
.iFirmwareVersion
= m_persistedConfiguration
.iFirmwareVersion
;
562 configuration
.deviceTypes
= m_persistedConfiguration
.deviceTypes
;
563 configuration
.iPhysicalAddress
= m_persistedConfiguration
.iPhysicalAddress
;
564 snprintf(configuration
.strDeviceName
, 13, "%s", m_persistedConfiguration
.strDeviceName
);
569 bool CUSBCECAdapterCommands::PingAdapter(void)
572 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "sending ping");
575 CCECAdapterMessage params
;
576 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_PING
, params
);
577 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
582 bool CUSBCECAdapterCommands::SetAckMask(uint16_t iMask
)
584 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
586 CCECAdapterMessage params
;
587 params
.PushEscaped(iMask
>> 8);
588 params
.PushEscaped((uint8_t)iMask
);
589 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_ACK_MASK
, params
);
590 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
595 void CUSBCECAdapterCommands::SetActiveSource(bool bSetTo
, bool bClientUnregistered
)
597 if (bClientUnregistered
) return;
598 if (m_persistedConfiguration
.iFirmwareVersion
>= 3)
600 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "marking the adapter as %s source", bSetTo
? "active" : "inactive");
601 CCECAdapterMessage params
;
602 params
.PushEscaped(bSetTo
? 1 : 0);
603 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_ACTIVE_SOURCE
, params
);
608 bool CUSBCECAdapterCommands::StartBootloader(void)
610 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
612 CCECAdapterMessage params
;
613 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_START_BOOTLOADER
, params
);
614 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
619 bool CUSBCECAdapterCommands::SetLineTimeout(uint8_t iTimeout
)
621 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the line timeout to %d", iTimeout
);
622 CCECAdapterMessage params
;
623 params
.PushEscaped(iTimeout
);
624 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_TRANSMIT_IDLETIME
, params
);
625 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
630 bool CUSBCECAdapterCommands::SetControlledMode(bool controlled
)
633 CLockObject
lock(m_mutex
);
634 if (m_bControlledMode
== controlled
)
638 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
640 CCECAdapterMessage params
;
641 params
.PushEscaped(controlled
? 1 : 0);
642 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_CONTROLLED
, params
);
643 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
648 CLockObject
lock(m_mutex
);
649 m_bControlledMode
= controlled
;