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)
59 m_persistedConfiguration
.Clear();
62 cec_datapacket
CUSBCECAdapterCommands::RequestSetting(cec_adapter_messagecode msgCode
)
64 cec_datapacket retVal
;
67 CCECAdapterMessage params
;
68 CCECAdapterMessage
*message
= m_comm
->SendCommand(msgCode
, params
);
69 if (message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
)
71 retVal
= message
->response
;
72 retVal
.Shift(2); // shift out start and msgcode
73 retVal
.size
-= 1; // remove end
80 uint16_t CUSBCECAdapterCommands::RequestFirmwareVersion(void)
82 m_persistedConfiguration
.iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
83 unsigned int iFwVersionTry(0);
85 while (m_persistedConfiguration
.iFirmwareVersion
== CEC_FW_VERSION_UNKNOWN
&& iFwVersionTry
++ < 3)
87 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
88 cec_datapacket response
= RequestSetting(MSGCODE_FIRMWARE_VERSION
);
89 if (response
.size
== 2)
90 m_persistedConfiguration
.iFirmwareVersion
= (response
[0] << 8 | response
[1]);
93 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "the adapter did not respond with a correct firmware version (try %d)", iFwVersionTry
);
98 if (m_persistedConfiguration
.iFirmwareVersion
== CEC_FW_VERSION_UNKNOWN
)
100 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "defaulting to firmware version 1");
101 m_persistedConfiguration
.iFirmwareVersion
= 1;
104 return m_persistedConfiguration
.iFirmwareVersion
;
107 bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(void)
109 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting autonomous mode setting");
111 cec_datapacket response
= RequestSetting(MSGCODE_GET_AUTO_ENABLED
);
112 if (response
.size
== 1)
114 m_bSettingAutoEnabled
= response
[0] == 1;
115 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted autonomous mode setting: '%s'", m_bSettingAutoEnabled
? "enabled" : "disabled");
121 bool CUSBCECAdapterCommands::RequestSettingCECVersion(void)
123 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting CEC version setting");
125 cec_datapacket response
= RequestSetting(MSGCODE_GET_HDMI_VERSION
);
126 if (response
.size
== 1)
128 m_settingCecVersion
= (cec_version
)response
[0];
129 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted CEC version setting: '%s'", ToString(m_settingCecVersion
));
135 uint32_t CUSBCECAdapterCommands::RequestBuildDate(void)
137 if (m_iBuildDate
== CEC_FW_BUILD_UNKNOWN
)
139 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting firmware build date");
141 cec_datapacket response
= RequestSetting(MSGCODE_GET_BUILDDATE
);
142 if (response
.size
== 4)
143 m_iBuildDate
= (uint32_t)response
[0] << 24 | (uint32_t)response
[1] << 16 | (uint32_t)response
[2] << 8 | (uint32_t)response
[3];
148 bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(void)
150 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting default logical address setting");
152 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS
);
153 if (response
.size
== 1)
155 m_persistedConfiguration
.logicalAddresses
.primary
= (cec_logical_address
)response
[0];
156 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted logical address setting: '%s'", ToString(m_persistedConfiguration
.logicalAddresses
.primary
));
162 bool CUSBCECAdapterCommands::RequestSettingDeviceType(void)
164 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting device type setting");
165 m_persistedConfiguration
.deviceTypes
.Clear();
167 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEVICE_TYPE
);
168 if (response
.size
== 1)
170 m_persistedConfiguration
.deviceTypes
.Add((cec_device_type
)response
[0]);
171 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted device type setting: '%s'", ToString((cec_device_type
)response
[0]));
174 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted device type setting");
178 bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(void)
180 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting logical address mask setting");
182 cec_datapacket response
= RequestSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK
);
183 if (response
.size
== 2)
185 m_iSettingLAMask
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
186 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted logical address mask setting: '%x'", m_iSettingLAMask
);
192 bool CUSBCECAdapterCommands::RequestSettingOSDName(void)
194 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting OSD name setting");
196 memset(m_persistedConfiguration
.strDeviceName
, 0, 13);
197 cec_datapacket response
= RequestSetting(MSGCODE_GET_OSD_NAME
);
198 if (response
.size
== 0)
200 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted device name setting");
205 for (uint8_t iPtr
= 0; iPtr
< response
.size
&& iPtr
< 13; iPtr
++)
206 buf
[iPtr
] = (char)response
[iPtr
];
207 buf
[response
.size
] = 0;
209 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", buf
);
210 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted device name setting: '%s'", buf
);
214 bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(void)
216 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "requesting physical address setting");
218 cec_datapacket response
= RequestSetting(MSGCODE_GET_PHYSICAL_ADDRESS
);
219 if (response
.size
== 2)
221 m_persistedConfiguration
.iPhysicalAddress
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
222 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "using persisted physical address setting: '%4x'", m_persistedConfiguration
.iPhysicalAddress
);
225 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "no persisted physical address setting");
229 bool CUSBCECAdapterCommands::SetSettingAutoEnabled(bool enabled
)
233 /* check whether this value was changed */
235 CLockObject
lock(m_mutex
);
236 if (m_bSettingAutoEnabled
== enabled
)
238 m_bNeedsWrite
= true;
241 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "turning autonomous mode %s", enabled
? "on" : "off");
243 CCECAdapterMessage params
;
244 params
.PushEscaped(enabled
? 1 : 0);
245 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_AUTO_ENABLED
, params
);
246 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
251 CLockObject
lock(m_mutex
);
252 m_bSettingAutoEnabled
= enabled
;
258 bool CUSBCECAdapterCommands::SetSettingDeviceType(cec_device_type type
)
262 /* check whether this value was changed */
264 CLockObject
lock(m_mutex
);
265 if (m_persistedConfiguration
.deviceTypes
.types
[0] == type
)
267 m_bNeedsWrite
= true;
270 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the device type to %X (previous: %X)", (uint8_t)type
, (uint8_t)m_persistedConfiguration
.deviceTypes
.types
[0]);
272 CCECAdapterMessage params
;
273 params
.PushEscaped((uint8_t)type
);
274 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEVICE_TYPE
, params
);
275 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
280 CLockObject
lock(m_mutex
);
281 m_persistedConfiguration
.deviceTypes
.types
[0] = type
;
287 bool CUSBCECAdapterCommands::SetSettingDefaultLogicalAddress(cec_logical_address address
)
291 /* check whether this value was changed */
293 CLockObject
lock(m_mutex
);
294 if (m_persistedConfiguration
.logicalAddresses
.primary
== address
)
296 m_bNeedsWrite
= true;
299 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the default logical address to %X (previous: %X)", (uint8_t)address
, (uint8_t)m_persistedConfiguration
.logicalAddresses
.primary
);
301 CCECAdapterMessage params
;
302 params
.PushEscaped((uint8_t)address
);
303 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS
, params
);
304 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
309 CLockObject
lock(m_mutex
);
310 m_persistedConfiguration
.logicalAddresses
.primary
= address
;
316 bool CUSBCECAdapterCommands::SetSettingLogicalAddressMask(uint16_t iMask
)
320 /* check whether this value was changed */
322 CLockObject
lock(m_mutex
);
323 if (m_iSettingLAMask
== iMask
)
325 m_bNeedsWrite
= true;
328 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the logical address mask to %2X (previous: %2X)", iMask
, m_iSettingLAMask
);
330 CCECAdapterMessage params
;
331 params
.PushEscaped(iMask
>> 8);
332 params
.PushEscaped((uint8_t)iMask
);
333 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK
, params
);
334 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
339 CLockObject
lock(m_mutex
);
340 m_iSettingLAMask
= iMask
;
346 bool CUSBCECAdapterCommands::SetSettingPhysicalAddress(uint16_t iPhysicalAddress
)
350 /* check whether this value was changed */
352 CLockObject
lock(m_mutex
);
353 if (m_persistedConfiguration
.iPhysicalAddress
== iPhysicalAddress
)
355 m_bNeedsWrite
= true;
358 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the physical address to %04X (previous: %04X)", iPhysicalAddress
, m_persistedConfiguration
.iPhysicalAddress
);
360 CCECAdapterMessage params
;
361 params
.PushEscaped(iPhysicalAddress
>> 8);
362 params
.PushEscaped((uint8_t)iPhysicalAddress
);
363 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS
, params
);
364 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
369 CLockObject
lock(m_mutex
);
370 m_persistedConfiguration
.iPhysicalAddress
= iPhysicalAddress
;
376 bool CUSBCECAdapterCommands::SetSettingCECVersion(cec_version version
)
380 /* check whether this value was changed */
382 CLockObject
lock(m_mutex
);
383 if (m_settingCecVersion
== version
)
385 m_bNeedsWrite
= true;
388 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the CEC version to %s (previous: %s)", ToString(version
), ToString(m_settingCecVersion
));
390 CCECAdapterMessage params
;
391 params
.PushEscaped((uint8_t)version
);
392 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_HDMI_VERSION
, params
);
393 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
398 CLockObject
lock(m_mutex
);
399 m_settingCecVersion
= version
;
405 bool CUSBCECAdapterCommands::SetSettingOSDName(const char *strOSDName
)
409 /* check whether this value was changed */
410 if (!strcmp(m_persistedConfiguration
.strDeviceName
, strOSDName
))
413 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the OSD name to %s (previous: %s)", strOSDName
, m_persistedConfiguration
.strDeviceName
);
415 CCECAdapterMessage params
;
416 for (size_t iPtr
= 0; iPtr
< strlen(strOSDName
); iPtr
++)
417 params
.PushEscaped(strOSDName
[iPtr
]);
418 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_OSD_NAME
, params
);
419 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
423 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", strOSDName
);
428 bool CUSBCECAdapterCommands::WriteEEPROM(void)
431 CLockObject
lock(m_mutex
);
436 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "writing settings in the EEPROM");
438 CCECAdapterMessage params
;
439 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_WRITE_EEPROM
, params
);
440 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
445 CLockObject
lock(m_mutex
);
446 m_bNeedsWrite
= false;
452 bool CUSBCECAdapterCommands::PersistConfiguration(const libcec_configuration
&configuration
)
455 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
458 if (!RequestSettings())
461 bReturn
|= SetSettingAutoEnabled(true);
462 bReturn
|= SetSettingDeviceType(CLibCEC::GetType(configuration
.logicalAddresses
.primary
));
463 bReturn
|= SetSettingDefaultLogicalAddress(configuration
.logicalAddresses
.primary
);
464 bReturn
|= SetSettingLogicalAddressMask(CLibCEC::GetMaskForType(configuration
.logicalAddresses
.primary
));
465 bReturn
|= SetSettingPhysicalAddress(configuration
.iPhysicalAddress
);
466 bReturn
|= SetSettingCECVersion(configuration
.clientVersion
>= CEC_CLIENT_VERSION_1_8_0
? configuration
.cecVersion
: CEC_VERSION_1_4
);
467 bReturn
|= SetSettingOSDName(configuration
.strDeviceName
);
472 bool CUSBCECAdapterCommands::RequestSettings(void)
474 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
476 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - firmware version %d does not have any eeprom settings", __FUNCTION__
, m_persistedConfiguration
.iFirmwareVersion
);
477 // settings can only be persisted with firmware v2+
481 if (m_bSettingsRetrieved
)
485 bReturn
&= RequestSettingAutoEnabled();
486 bReturn
&= RequestSettingCECVersion();
487 bReturn
&= RequestSettingDefaultLogicalAddress();
488 bReturn
&= RequestSettingDeviceType();
489 bReturn
&= RequestSettingLogicalAddressMask();
490 bReturn
&= RequestSettingOSDName();
491 bReturn
&= RequestSettingPhysicalAddress();
493 // don't read the following settings:
494 // - auto enabled (always enabled)
495 // - default logical address (autodetected)
496 // - logical address mask (autodetected)
497 // - CEC version (1.3a)
499 // TODO to be added to the firmware:
500 // - base device (4 bits)
501 // - HDMI port number (4 bits)
502 // - TV vendor id (12 bits)
503 // - wake devices (8 bits)
504 // - standby devices (8 bits)
505 // - use TV menu language (1 bit)
506 // - activate source (1 bit)
507 // - power off screensaver (1 bit)
508 // - power off on standby (1 bit)
509 // - send inactive source (1 bit)
511 m_bSettingsRetrieved
= true;
516 bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration
&configuration
)
518 // get the settings from the eeprom if needed
519 if (!RequestSettings())
523 configuration
.iFirmwareVersion
= m_persistedConfiguration
.iFirmwareVersion
;
524 configuration
.deviceTypes
= m_persistedConfiguration
.deviceTypes
;
525 configuration
.iPhysicalAddress
= m_persistedConfiguration
.iPhysicalAddress
;
526 snprintf(configuration
.strDeviceName
, 13, "%s", m_persistedConfiguration
.strDeviceName
);
531 bool CUSBCECAdapterCommands::PingAdapter(void)
533 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "sending ping");
535 CCECAdapterMessage params
;
536 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_PING
, params
);
537 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
542 bool CUSBCECAdapterCommands::SetAckMask(uint16_t iMask
)
544 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
546 CCECAdapterMessage params
;
547 params
.PushEscaped(iMask
>> 8);
548 params
.PushEscaped((uint8_t)iMask
);
549 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_ACK_MASK
, params
);
550 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
555 bool CUSBCECAdapterCommands::StartBootloader(void)
557 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
559 CCECAdapterMessage params
;
560 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_START_BOOTLOADER
, params
);
561 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
566 bool CUSBCECAdapterCommands::SetLineTimeout(uint8_t iTimeout
)
568 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "setting the line timeout to %d", iTimeout
);
569 CCECAdapterMessage params
;
570 params
.PushEscaped(iTimeout
);
571 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_TRANSMIT_IDLETIME
, params
);
572 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
577 bool CUSBCECAdapterCommands::SetControlledMode(bool controlled
)
580 CLockObject
lock(m_mutex
);
581 if (m_bControlledMode
== controlled
)
585 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
587 CCECAdapterMessage params
;
588 params
.PushEscaped(controlled
? 1 : 0);
589 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_CONTROLLED
, params
);
590 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
595 CLockObject
lock(m_mutex
);
596 m_bControlledMode
= controlled
;