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/
33 #include "USBCECAdapterCommands.h"
34 #include "../LibCEC.h"
35 #include "../CECProcessor.h"
38 using namespace PLATFORM
;
40 CUSBCECAdapterCommands::CUSBCECAdapterCommands(CUSBCECAdapterCommunication
*comm
) :
42 m_bSettingsRetrieved(false),
43 m_bSettingAutoEnabled(false),
44 m_settingCecVersion(CEC_VERSION_UNKNOWN
),
48 m_persistedConfiguration
.Clear();
51 cec_datapacket
CUSBCECAdapterCommands::RequestSetting(cec_adapter_messagecode msgCode
)
53 cec_datapacket retVal
;
56 CCECAdapterMessage params
;
57 CCECAdapterMessage
*message
= m_comm
->SendCommand(msgCode
, params
);
58 if (message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
)
60 retVal
= message
->response
;
61 retVal
.Shift(2); // shift out start and msgcode
62 retVal
.size
-= 1; // remove end
68 uint16_t CUSBCECAdapterCommands::RequestFirmwareVersion(void)
70 m_persistedConfiguration
.iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
71 unsigned int iFwVersionTry(0);
73 while (m_persistedConfiguration
.iFirmwareVersion
== CEC_FW_VERSION_UNKNOWN
&& iFwVersionTry
++ < 3)
75 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting the firmware version");
76 cec_datapacket response
= RequestSetting(MSGCODE_FIRMWARE_VERSION
);
77 if (response
.size
== 2)
78 m_persistedConfiguration
.iFirmwareVersion
= (response
[0] << 8 | response
[1]);
81 CLibCEC::AddLog(CEC_LOG_WARNING
, "the adapter did not respond with a correct firmware version (try %d)", iFwVersionTry
);
86 if (m_persistedConfiguration
.iFirmwareVersion
== CEC_FW_VERSION_UNKNOWN
)
88 CLibCEC::AddLog(CEC_LOG_DEBUG
, "defaulting to firmware version 1");
89 m_persistedConfiguration
.iFirmwareVersion
= 1;
92 return m_persistedConfiguration
.iFirmwareVersion
;
95 bool CUSBCECAdapterCommands::RequestSettingAutoEnabled(void)
97 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting autonomous mode setting");
99 cec_datapacket response
= RequestSetting(MSGCODE_GET_AUTO_ENABLED
);
100 if (response
.size
== 1)
102 m_bSettingAutoEnabled
= response
[0] == 1;
108 bool CUSBCECAdapterCommands::RequestSettingCECVersion(void)
110 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting CEC version setting");
112 cec_datapacket response
= RequestSetting(MSGCODE_GET_HDMI_VERSION
);
113 if (response
.size
== 1)
115 m_settingCecVersion
= (cec_version
)response
[0];
121 bool CUSBCECAdapterCommands::RequestSettingDefaultLogicalAddress(void)
123 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting default logical address setting");
125 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS
);
126 if (response
.size
== 1)
128 m_persistedConfiguration
.logicalAddresses
.primary
= (cec_logical_address
)response
[0];
134 bool CUSBCECAdapterCommands::RequestSettingDeviceType(void)
136 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting device type setting");
137 m_persistedConfiguration
.deviceTypes
.Clear();
139 cec_datapacket response
= RequestSetting(MSGCODE_GET_DEVICE_TYPE
);
140 if (response
.size
== 1)
142 m_persistedConfiguration
.deviceTypes
.Add((cec_device_type
)response
[0]);
143 CLibCEC::AddLog(CEC_LOG_DEBUG
, "using persisted device type setting %s", CLibCEC::GetInstance()->ToString((cec_device_type
)response
[0]));
146 CLibCEC::AddLog(CEC_LOG_DEBUG
, "no persisted device type setting");
150 bool CUSBCECAdapterCommands::RequestSettingLogicalAddressMask(void)
152 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting logical address mask setting");
154 cec_datapacket response
= RequestSetting(MSGCODE_GET_LOGICAL_ADDRESS_MASK
);
155 if (response
.size
== 2)
157 m_iSettingLAMask
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
163 bool CUSBCECAdapterCommands::RequestSettingOSDName(void)
165 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting OSD name setting");
167 memset(m_persistedConfiguration
.strDeviceName
, 0, 13);
168 cec_datapacket response
= RequestSetting(MSGCODE_GET_OSD_NAME
);
169 if (response
.size
== 0)
171 CLibCEC::AddLog(CEC_LOG_DEBUG
, "no persisted device name setting");
176 for (uint8_t iPtr
= 0; iPtr
< response
.size
&& iPtr
< 13; iPtr
++)
177 buf
[iPtr
] = (char)response
[iPtr
];
178 buf
[response
.size
] = 0;
180 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", buf
);
181 CLibCEC::AddLog(CEC_LOG_DEBUG
, "using persisted device name setting %s", buf
);
185 bool CUSBCECAdapterCommands::RequestSettingPhysicalAddress(void)
187 CLibCEC::AddLog(CEC_LOG_DEBUG
, "requesting physical address setting");
189 cec_datapacket response
= RequestSetting(MSGCODE_GET_PHYSICAL_ADDRESS
);
190 if (response
.size
== 2)
192 m_persistedConfiguration
.iPhysicalAddress
= ((uint16_t)response
[0] << 8) | ((uint16_t)response
[1]);
193 CLibCEC::AddLog(CEC_LOG_DEBUG
, "using persisted physical address setting %4x", m_persistedConfiguration
.iPhysicalAddress
);
196 CLibCEC::AddLog(CEC_LOG_DEBUG
, "no persisted physical address setting");
200 bool CUSBCECAdapterCommands::SetSettingAutoEnabled(bool enabled
)
204 /* check whether this value was changed */
205 if (m_bSettingAutoEnabled
== enabled
)
207 CLibCEC::AddLog(CEC_LOG_DEBUG
, "autonomous mode setting unchanged (%s)", enabled
? "on" : "off");
211 m_bNeedsWrite
= true;
212 CLibCEC::AddLog(CEC_LOG_DEBUG
, "turning autonomous mode %s", enabled
? "on" : "off");
214 CCECAdapterMessage params
;
215 params
.PushEscaped(enabled
? 1 : 0);
216 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_AUTO_ENABLED
, params
);
217 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
221 m_bSettingAutoEnabled
= enabled
;
226 bool CUSBCECAdapterCommands::SetSettingDeviceType(cec_device_type type
)
230 /* check whether this value was changed */
231 if (m_persistedConfiguration
.deviceTypes
.types
[0] == type
)
233 CLibCEC::AddLog(CEC_LOG_DEBUG
, "device type setting unchanged (%X)", (uint8_t)type
);
237 m_bNeedsWrite
= true;
238 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the device type to %X", (uint8_t)type
);
240 CCECAdapterMessage params
;
241 params
.PushEscaped((uint8_t)type
);
242 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEVICE_TYPE
, params
);
243 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
249 bool CUSBCECAdapterCommands::SetSettingDefaultLogicalAddress(cec_logical_address address
)
253 /* check whether this value was changed */
254 if (m_persistedConfiguration
.logicalAddresses
.primary
== address
)
256 CLibCEC::AddLog(CEC_LOG_DEBUG
, "logical address setting unchanged (%X)", (uint8_t)address
);
260 m_bNeedsWrite
= true;
261 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the default logical address to %X", (uint8_t)address
);
263 CCECAdapterMessage params
;
264 params
.PushEscaped((uint8_t)address
);
265 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS
, params
);
266 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
270 m_persistedConfiguration
.logicalAddresses
.primary
= address
;
275 bool CUSBCECAdapterCommands::SetSettingLogicalAddressMask(uint16_t iMask
)
279 /* check whether this value was changed */
280 if (m_iSettingLAMask
== iMask
)
282 CLibCEC::AddLog(CEC_LOG_DEBUG
, "logical address mask setting unchanged (%2X)", iMask
);
286 m_bNeedsWrite
= true;
287 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the logical address mask to %2X", iMask
);
289 CCECAdapterMessage params
;
290 params
.PushEscaped(iMask
>> 8);
291 params
.PushEscaped((uint8_t)iMask
);
292 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_LOGICAL_ADDRESS_MASK
, params
);
293 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
297 m_iSettingLAMask
= iMask
;
302 bool CUSBCECAdapterCommands::SetSettingPhysicalAddress(uint16_t iPhysicalAddress
)
306 /* check whether this value was changed */
307 if (m_persistedConfiguration
.iPhysicalAddress
== iPhysicalAddress
)
309 CLibCEC::AddLog(CEC_LOG_DEBUG
, "physical address setting unchanged (%04X)", iPhysicalAddress
);
313 m_bNeedsWrite
= true;
314 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the physical address to %04X", iPhysicalAddress
);
316 CCECAdapterMessage params
;
317 params
.PushEscaped(iPhysicalAddress
>> 8);
318 params
.PushEscaped((uint8_t)iPhysicalAddress
);
319 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_PHYSICAL_ADDRESS
, params
);
320 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
324 m_persistedConfiguration
.iPhysicalAddress
= iPhysicalAddress
;
329 bool CUSBCECAdapterCommands::SetSettingCECVersion(cec_version version
)
333 /* check whether this value was changed */
334 if (m_settingCecVersion
== version
)
336 CLibCEC::AddLog(CEC_LOG_DEBUG
, "CEC version setting unchanged (%s)", CLibCEC::GetInstance()->ToString(version
));
340 m_bNeedsWrite
= true;
341 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the CEC version to %s", CLibCEC::GetInstance()->ToString(version
));
343 CCECAdapterMessage params
;
344 params
.PushEscaped((uint8_t)version
);
345 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_HDMI_VERSION
, params
);
346 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
350 m_settingCecVersion
= version
;
355 bool CUSBCECAdapterCommands::SetSettingOSDName(const char *strOSDName
)
359 /* check whether this value was changed */
360 if (!strcmp(m_persistedConfiguration
.strDeviceName
, strOSDName
))
362 CLibCEC::AddLog(CEC_LOG_DEBUG
, "OSD name setting unchanged (%s)", strOSDName
);
366 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the OSD name to %s", strOSDName
);
368 CCECAdapterMessage params
;
369 for (size_t iPtr
= 0; iPtr
< strlen(strOSDName
); iPtr
++)
370 params
.PushEscaped(strOSDName
[iPtr
]);
371 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_OSD_NAME
, params
);
372 bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
376 snprintf(m_persistedConfiguration
.strDeviceName
, 13, "%s", strOSDName
);
381 bool CUSBCECAdapterCommands::WriteEEPROM(void)
386 CLibCEC::AddLog(CEC_LOG_DEBUG
, "writing settings in the EEPROM");
388 CCECAdapterMessage params
;
389 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_WRITE_EEPROM
, params
);
390 m_bNeedsWrite
= !(message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
);
392 return m_bNeedsWrite
;
395 bool CUSBCECAdapterCommands::PersistConfiguration(libcec_configuration
*configuration
)
397 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
400 if (!RequestSettings())
404 bReturn
&= SetSettingAutoEnabled(true);
405 bReturn
&= SetSettingDeviceType(CLibCEC::GetType(configuration
->logicalAddresses
.primary
));
406 bReturn
&= SetSettingDefaultLogicalAddress(configuration
->logicalAddresses
.primary
);
407 bReturn
&= SetSettingLogicalAddressMask(CLibCEC::GetMaskForType(configuration
->logicalAddresses
.primary
));
408 bReturn
&= SetSettingPhysicalAddress(configuration
->iPhysicalAddress
);
409 bReturn
&= SetSettingCECVersion(CEC_VERSION_1_3A
);
410 bReturn
&= SetSettingOSDName(configuration
->strDeviceName
);
411 bReturn
&= WriteEEPROM();
415 bool CUSBCECAdapterCommands::RequestSettings(void)
417 if (m_persistedConfiguration
.iFirmwareVersion
< 2)
419 CLibCEC::AddLog(CEC_LOG_DEBUG
, "%s - firmware version %d does not have any eeprom settings", __FUNCTION__
, m_persistedConfiguration
.iFirmwareVersion
);
420 // settings can only be persisted with firmware v2+
424 if (m_bSettingsRetrieved
)
428 bReturn
&= RequestSettingAutoEnabled();
429 bReturn
&= RequestSettingCECVersion();
430 bReturn
&= RequestSettingDefaultLogicalAddress();
431 bReturn
&= RequestSettingDeviceType();
432 bReturn
&= RequestSettingLogicalAddressMask();
433 bReturn
&= RequestSettingOSDName();
434 bReturn
&= RequestSettingPhysicalAddress();
436 // don't read the following settings:
437 // - auto enabled (always enabled)
438 // - default logical address (autodetected)
439 // - logical address mask (autodetected)
440 // - CEC version (1.3a)
442 // TODO to be added to the firmware:
443 // - base device (4 bits)
444 // - HDMI port number (4 bits)
445 // - TV vendor id (12 bits)
446 // - wake devices (8 bits)
447 // - standby devices (8 bits)
448 // - use TV menu language (1 bit)
449 // - activate source (1 bit)
450 // - power off screensaver (1 bit)
451 // - power off on standby (1 bit)
452 // - send inactive source (1 bit)
454 m_bSettingsRetrieved
= true;
459 bool CUSBCECAdapterCommands::GetConfiguration(libcec_configuration
*configuration
)
461 // get the settings from the eeprom if needed
462 if (!RequestSettings())
466 configuration
->iFirmwareVersion
= m_persistedConfiguration
.iFirmwareVersion
;
467 configuration
->deviceTypes
= m_persistedConfiguration
.deviceTypes
;
468 configuration
->iPhysicalAddress
= m_persistedConfiguration
.iPhysicalAddress
;
469 snprintf(configuration
->strDeviceName
, 13, "%s", m_persistedConfiguration
.strDeviceName
);
474 bool CUSBCECAdapterCommands::PingAdapter(void)
476 CLibCEC::AddLog(CEC_LOG_DEBUG
, "sending ping");
478 CCECAdapterMessage params
;
479 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_PING
, params
);
480 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
485 bool CUSBCECAdapterCommands::SetAckMask(uint16_t iMask
)
487 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting ackmask to %2x", iMask
);
489 CCECAdapterMessage params
;
490 params
.PushEscaped(iMask
>> 8);
491 params
.PushEscaped((uint8_t)iMask
);
492 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_ACK_MASK
, params
);
493 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
498 bool CUSBCECAdapterCommands::StartBootloader(void)
500 CLibCEC::AddLog(CEC_LOG_DEBUG
, "starting the bootloader");
502 CCECAdapterMessage params
;
503 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_START_BOOTLOADER
, params
);
504 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
509 bool CUSBCECAdapterCommands::SetLineTimeout(uint8_t iTimeout
)
511 CLibCEC::AddLog(CEC_LOG_DEBUG
, "setting the line timeout to %d", iTimeout
);
512 CCECAdapterMessage params
;
513 params
.PushEscaped(iTimeout
);
514 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_TRANSMIT_IDLETIME
, params
);
515 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;
520 bool CUSBCECAdapterCommands::SetControlledMode(bool controlled
)
522 CLibCEC::AddLog(CEC_LOG_DEBUG
, "turning controlled mode %s", controlled
? "on" : "off");
524 CCECAdapterMessage params
;
525 params
.PushEscaped(controlled
? 1 : 0);
526 CCECAdapterMessage
*message
= m_comm
->SendCommand(MSGCODE_SET_CONTROLLED
, params
);
527 bool bReturn
= message
->state
== ADAPTER_MESSAGE_STATE_SENT_ACKED
;