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 return m_persistedConfiguration
.iFirmwareVersion
;
110 bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(void)
113 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting autonomous mode setting");
116 cec_datapacket response
= RequestSetting(MSGCODE_GET_AUTO_ENABLED
);
117 if (response
.size
== 1)
119 m_bSettingAutoEnabled
= response
[0] == 1;
120 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted autonomous mode setting: '%s'", m_bSettingAutoEnabled
? "enabled" : "disabled");
126 bool CUSBCECAdapterCommands::RequestSettingCECVersion(void)
129 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting CEC version setting");
132 cec_datapacket response
= RequestSetting(MSGCODE_GET_HDMI_VERSION
);
133 if (response
.size
== 1)
135 m_settingCecVersion
= (cec_version
)response
[0];
136 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted CEC version setting: '%s'", ToString(m_settingCecVersion
));
142 p8_cec_adapter_type
CUSBCECAdapterCommands::RequestAdapterType(void)
144 if (m_adapterType
== P8_ADAPTERTYPE_UNKNOWN
)
147 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting adapter type");
150 cec_datapacket response
= RequestSetting(MSGCODE_GET_ADAPTER_TYPE
);
151 if (response
.size
== 1)
152 m_adapterType
= (p8_cec_adapter_type
)response
[0];
154 return m_adapterType
;
157 uint32_t CUSBCECAdapterCommands::RequestBuildDate(void)
159 if (m_iBuildDate
== CEC_FW_BUILD_UNKNOWN
)
162 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting firmware build date");
165 cec_datapacket response
= RequestSetting(MSGCODE_GET_BUILDDATE
);
166 if (response
.size
== 4)
167 m_iBuildDate
= (uint32_t)response
[0] << 24 | (uint32_t)response
[1] << 16 | (uint32_t)response
[2] << 8 | (uint32_t)response
[3];
172 bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(void)
175 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting default logical address setting");
178 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS
);
179 if (response
.size
== 1)
181 m_persistedConfiguration
.logicalAddresses
.primary
= (cec_logical_address
)response
[0];
182 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted logical address setting: '%s'", ToString(m_persistedConfiguration
.logicalAddresses
.primary
));
188 bool CUSBCECAdapterCommands::RequestSettingDeviceType(void)
191 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting device type setting");
193 m_persistedConfiguration
.deviceTypes
.Clear();
195 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEVICE_TYPE
);
196 if (response
.size
== 1)
198 m_persistedConfiguration
.deviceTypes
.Add((cec_device_type
)response
[0]);
199 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted device type setting: '%s'", ToString((cec_device_type
)response
[0]));
202 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted device type setting");
206 bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(void)
209 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting logical address mask setting");
212 cec_datapacket response
= RequestSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK
);
213 if (response
.size
== 2)
215 m_iSettingLAMask
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
216 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted logical address mask setting: '%x'", m_iSettingLAMask
);
222 bool CUSBCECAdapterCommands::RequestSettingOSDName(void)
225 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting OSD name setting");
228 memset(m_persistedConfiguration
.strDeviceName
, 0, 13);
229 cec_datapacket response
= RequestSetting(MSGCODE_GET_OSD_NAME
);
230 if (response
.size
== 0)
232 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted device name setting");
237 for (uint8_t iPtr
= 0; iPtr
< response
.size
&& iPtr
< 13; iPtr
++)
238 buf
[iPtr
] = (char)response
[iPtr
];
239 buf
[response
.size
] = 0;
241 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", buf
);
242 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted device name setting: '%s'", buf
);
246 bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(void)
249 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting physical address setting");
252 cec_datapacket response
= RequestSetting(MSGCODE_GET_PHYSICAL_ADDRESS
);
253 if (response
.size
== 2)
255 m_persistedConfiguration
.iPhysicalAddress
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
256 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted physical address setting: '%4x'", m_persistedConfiguration
.iPhysicalAddress
);
259 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted physical address setting");
263 bool CUSBCECAdapterCommands::SetSettingAutoEnabled(bool enabled
)
267 /* check whether this value was changed */
269 CLockObject
lock(m_mutex
);
270 if (m_bSettingAutoEnabled
== enabled
)
272 m_bNeedsWrite
= true;
275 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "turning autonomous mode %s", enabled
? "on" : "off");
277 CCECAdapterMessage params
;
278 params
.PushEscaped(enabled
? 1 : 0);
279 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_AUTO_ENABLED
, params
);
280 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
285 CLockObject
lock(m_mutex
);
286 m_bSettingAutoEnabled
= enabled
;
292 bool CUSBCECAdapterCommands::SetSettingDeviceType(cec_device_type type
)
296 /* check whether this value was changed */
298 CLockObject
lock(m_mutex
);
299 if (m_persistedConfiguration
.deviceTypes
.types
[0] == type
)
301 m_bNeedsWrite
= true;
304 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the device type to %X (previous: %X)", (uint8_t)type
, (uint8_t)m_persistedConfiguration
.deviceTypes
.types
[0]);
306 CCECAdapterMessage params
;
307 params
.PushEscaped((uint8_t)type
);
308 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEVICE_TYPE
, params
);
309 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
314 CLockObject
lock(m_mutex
);
315 m_persistedConfiguration
.deviceTypes
.types
[0] = type
;
321 bool CUSBCECAdapterCommands::SetSettingDefaultLogicalAddress(cec_logical_address address
)
325 /* check whether this value was changed */
327 CLockObject
lock(m_mutex
);
328 if (m_persistedConfiguration
.logicalAddresses
.primary
== address
)
330 m_bNeedsWrite
= true;
333 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the default logical address to %X (previous: %X)", (uint8_t)address
, (uint8_t)m_persistedConfiguration
.logicalAddresses
.primary
);
335 CCECAdapterMessage params
;
336 params
.PushEscaped((uint8_t)address
);
337 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS
, params
);
338 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
343 CLockObject
lock(m_mutex
);
344 m_persistedConfiguration
.logicalAddresses
.primary
= address
;
350 bool CUSBCECAdapterCommands::SetSettingLogicalAddressMask(uint16_t iMask
)
354 /* check whether this value was changed */
356 CLockObject
lock(m_mutex
);
357 if (m_iSettingLAMask
== iMask
)
359 m_bNeedsWrite
= true;
362 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the logical address mask to %2X (previous: %2X)", iMask
, m_iSettingLAMask
);
364 CCECAdapterMessage params
;
365 params
.PushEscaped(iMask
>> 8);
366 params
.PushEscaped((uint8_t)iMask
);
367 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK
, params
);
368 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
373 CLockObject
lock(m_mutex
);
374 m_iSettingLAMask
= iMask
;
380 bool CUSBCECAdapterCommands::SetSettingPhysicalAddress(uint16_t iPhysicalAddress
)
384 /* check whether this value was changed */
386 CLockObject
lock(m_mutex
);
387 if (m_persistedConfiguration
.iPhysicalAddress
== iPhysicalAddress
)
389 m_bNeedsWrite
= true;
392 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the physical address to %04X (previous: %04X)", iPhysicalAddress
, m_persistedConfiguration
.iPhysicalAddress
);
394 CCECAdapterMessage params
;
395 params
.PushEscaped(iPhysicalAddress
>> 8);
396 params
.PushEscaped((uint8_t)iPhysicalAddress
);
397 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS
, params
);
398 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
403 CLockObject
lock(m_mutex
);
404 m_persistedConfiguration
.iPhysicalAddress
= iPhysicalAddress
;
410 bool CUSBCECAdapterCommands::SetSettingCECVersion(cec_version version
)
414 /* check whether this value was changed */
416 CLockObject
lock(m_mutex
);
417 if (m_settingCecVersion
== version
)
419 m_bNeedsWrite
= true;
422 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the CEC version to %s (previous: %s)", ToString(version
), ToString(m_settingCecVersion
));
424 CCECAdapterMessage params
;
425 params
.PushEscaped((uint8_t)version
);
426 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_HDMI_VERSION
, params
);
427 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
432 CLockObject
lock(m_mutex
);
433 m_settingCecVersion
= version
;
439 bool CUSBCECAdapterCommands::SetSettingOSDName(const char *strOSDName
)
443 /* check whether this value was changed */
444 if (!strcmp(m_persistedConfiguration
.strDeviceName
, strOSDName
))
447 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the OSD name to %s (previous: %s)", strOSDName
, m_persistedConfiguration
.strDeviceName
);
449 CCECAdapterMessage params
;
450 for (size_t iPtr
= 0; iPtr
< strlen(strOSDName
); iPtr
++)
451 params
.PushEscaped(strOSDName
[iPtr
]);
452 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_OSD_NAME
, params
);
453 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
457 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", strOSDName
);
462 bool CUSBCECAdapterCommands::WriteEEPROM(void)
465 CLockObject
lock(m_mutex
);
470 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "writing settings in the EEPROM");
472 CCECAdapterMessage params
;
473 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_WRITE_EEPROM
, params
);
474 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
479 CLockObject
lock(m_mutex
);
480 m_bNeedsWrite
= false;
486 bool CUSBCECAdapterCommands::PersistConfiguration(const libcec_configuration
&configuration
)
489 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
492 if (!RequestSettings())
495 bReturn
|= SetSettingAutoEnabled(true);
496 bReturn
|= SetSettingDeviceType(CLibCEC::GetType(configuration
.logicalAddresses
.primary
));
497 bReturn
|= SetSettingDefaultLogicalAddress(configuration
.logicalAddresses
.primary
);
498 bReturn
|= SetSettingLogicalAddressMask(CLibCEC::GetMaskForType(configuration
.logicalAddresses
.primary
));
499 bReturn
|= SetSettingPhysicalAddress(configuration
.iPhysicalAddress
);
500 bReturn
|= SetSettingCECVersion(configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_8_0
? configuration
.cecVersion
: CEC_VERSION_1_4
);
501 bReturn
|= SetSettingOSDName(configuration
.strDeviceName
);
506 bool CUSBCECAdapterCommands::RequestSettings(void)
508 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
510 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - firmware version %d does not have any eeprom settings", __FUNCTION__
, m_persistedConfiguration
.iFirmwareVersion
);
511 // settings can only be persisted with firmware v2+
515 if (m_bSettingsRetrieved
)
519 bReturn
&= RequestSettingAutoEnabled();
520 bReturn
&= RequestSettingCECVersion();
521 bReturn
&= RequestSettingDefaultLogicalAddress();
522 bReturn
&= RequestSettingDeviceType();
523 bReturn
&= RequestSettingLogicalAddressMask();
524 bReturn
&= RequestSettingOSDName();
525 bReturn
&= RequestSettingPhysicalAddress();
527 // don't read the following settings:
528 // - auto enabled (always enabled)
529 // - default logical address (autodetected)
530 // - logical address mask (autodetected)
531 // - CEC version (1.3a)
533 // TODO to be added to the firmware:
534 // - base device (4 bits)
535 // - HDMI port number (4 bits)
536 // - TV vendor id (12 bits)
537 // - wake devices (8 bits)
538 // - standby devices (8 bits)
539 // - use TV menu language (1 bit)
540 // - activate source (1 bit)
541 // - power off screensaver (1 bit)
542 // - power off on standby (1 bit)
543 // - send inactive source (1 bit)
545 m_bSettingsRetrieved
= true;
550 bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration
&configuration
)
552 // get the settings from the eeprom if needed
553 if (!RequestSettings())
557 configuration
.iFirmwareVersion
= m_persistedConfiguration
.iFirmwareVersion
;
558 configuration
.deviceTypes
= m_persistedConfiguration
.deviceTypes
;
559 configuration
.iPhysicalAddress
= m_persistedConfiguration
.iPhysicalAddress
;
560 snprintf(configuration
.strDeviceName
, 13, "%s", m_persistedConfiguration
.strDeviceName
);
565 bool CUSBCECAdapterCommands::PingAdapter(void)
568 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "sending ping");
571 CCECAdapterMessage params
;
572 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_PING
, params
);
573 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
578 bool CUSBCECAdapterCommands::SetAckMask(uint16_t iMask
)
580 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
582 CCECAdapterMessage params
;
583 params
.PushEscaped(iMask
>> 8);
584 params
.PushEscaped((uint8_t)iMask
);
585 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_ACK_MASK
, params
);
586 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
591 bool CUSBCECAdapterCommands::StartBootloader(void)
593 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
595 CCECAdapterMessage params
;
596 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_START_BOOTLOADER
, params
);
597 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
602 bool CUSBCECAdapterCommands::SetLineTimeout(uint8_t iTimeout
)
604 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the line timeout to %d", iTimeout
);
605 CCECAdapterMessage params
;
606 params
.PushEscaped(iTimeout
);
607 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_TRANSMIT_IDLETIME
, params
);
608 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
613 bool CUSBCECAdapterCommands::SetControlledMode(bool controlled
)
616 CLockObject
lock(m_mutex
);
617 if (m_bControlledMode
== controlled
)
621 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
623 CCECAdapterMessage params
;
624 params
.PushEscaped(controlled
? 1 : 0);
625 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_CONTROLLED
, params
);
626 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
631 CLockObject
lock(m_mutex
);
632 m_bControlledMode
= controlled
;