2 * This file is part of the libCEC(R) library.
4 * libCEC(R) is Copyright (C) 2011-2013 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/
35 #if defined(HAVE_RPI_API)
36 #include "RPiCECAdapterCommunication.h"
42 #include "lib/CECTypeUtils.h"
43 #include "lib/LibCEC.h"
44 #include "lib/platform/util/StdString.h"
45 #include "RPiCECAdapterMessageQueue.h"
48 using namespace PLATFORM
;
50 #define LIB_CEC m_callback->GetLib()
52 static bool g_bHostInited
= false;
54 // callback for the RPi CEC service
55 void rpi_cec_callback(void *callback_data
, uint32_t p0
, uint32_t p1
, uint32_t p2
, uint32_t p3
, uint32_t p4
)
58 static_cast<CRPiCECAdapterCommunication
*>(callback_data
)->OnDataReceived(p0
, p1
, p2
, p3
, p4
);
61 // callback for the TV service
62 void rpi_tv_callback(void *callback_data
, uint32_t reason
, uint32_t p0
, uint32_t p1
)
65 static_cast<CRPiCECAdapterCommunication
*>(callback_data
)->OnTVServiceCallback(reason
, p0
, p1
);
68 CRPiCECAdapterCommunication::CRPiCECAdapterCommunication(IAdapterCommunicationCallback
*callback
) :
69 IAdapterCommunication(callback
),
70 m_logicalAddress(CECDEVICE_UNKNOWN
),
71 m_bLogicalAddressChanged(false),
72 m_previousLogicalAddress(CECDEVICE_FREEUSE
),
73 m_bLogicalAddressRegistered(false)
75 m_queue
= new CRPiCECAdapterMessageQueue(this);
78 CRPiCECAdapterCommunication::~CRPiCECAdapterCommunication(void)
84 const char *ToString(const VC_CEC_ERROR_T error
)
90 case VC_CEC_ERROR_NO_ACK
:
92 case VC_CEC_ERROR_SHUTDOWN
:
94 case VC_CEC_ERROR_BUSY
:
95 return "device is busy";
96 case VC_CEC_ERROR_NO_LA
:
97 return "no logical address";
98 case VC_CEC_ERROR_NO_PA
:
99 return "no physical address";
100 case VC_CEC_ERROR_NO_TOPO
:
101 return "no topology";
102 case VC_CEC_ERROR_INVALID_FOLLOWER
:
103 return "invalid follower";
104 case VC_CEC_ERROR_INVALID_ARGUMENT
:
105 return "invalid arg";
111 bool CRPiCECAdapterCommunication::IsInitialised(void)
113 CLockObject
lock(m_mutex
);
114 return m_bInitialised
;
117 void CRPiCECAdapterCommunication::OnTVServiceCallback(uint32_t reason
, uint32_t UNUSED(p0
), uint32_t UNUSED(p1
))
121 case VC_HDMI_UNPLUGGED
:
123 m_callback
->HandlePhysicalAddressChanged(0x1000);
126 case VC_HDMI_ATTACHED
:
128 uint16_t iNewAddress
= GetPhysicalAddress();
129 m_callback
->HandlePhysicalAddressChanged(iNewAddress
);
134 case VC_HDMI_HDCP_UNAUTH
:
135 case VC_HDMI_HDCP_AUTH
:
136 case VC_HDMI_HDCP_KEY_DOWNLOAD
:
137 case VC_HDMI_HDCP_SRM_DOWNLOAD
:
143 void CRPiCECAdapterCommunication::OnDataReceived(uint32_t header
, uint32_t p0
, uint32_t p1
, uint32_t p2
, uint32_t p3
)
145 VC_CEC_NOTIFY_T reason
= (VC_CEC_NOTIFY_T
)CEC_CB_REASON(header
);
148 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "received data: header:%08X p0:%08X p1:%08X p2:%08X p3:%08X reason:%x", header
, p0
, p1
, p2
, p3
, reason
);
156 // translate into a VC_CEC_MESSAGE_T
157 VC_CEC_MESSAGE_T message
;
158 vc_cec_param2message(header
, p0
, p1
, p2
, p3
, &message
);
160 // translate to a cec_command
162 cec_command::Format(command
,
163 (cec_logical_address
)message
.initiator
,
164 (cec_logical_address
)message
.follower
,
165 (cec_opcode
)CEC_CB_OPCODE(p0
));
168 for (uint8_t iPtr
= 1; iPtr
< message
.length
; iPtr
++)
169 command
.PushBack(message
.payload
[iPtr
]);
172 m_callback
->OnCommandReceived(command
);
177 // handle response to a command that was sent earlier
178 m_queue
->MessageReceived((cec_opcode
)CEC_CB_OPCODE(p0
), (cec_logical_address
)CEC_CB_INITIATOR(p0
), (cec_logical_address
)CEC_CB_FOLLOWER(p0
), CEC_CB_RC(header
));
181 case VC_CEC_BUTTON_PRESSED
:
182 case VC_CEC_REMOTE_PRESSED
:
184 // translate into a cec_command
186 cec_command::Format(command
,
187 (cec_logical_address
)CEC_CB_INITIATOR(p0
),
188 (cec_logical_address
)CEC_CB_FOLLOWER(p0
),
189 reason
== VC_CEC_BUTTON_PRESSED
? CEC_OPCODE_USER_CONTROL_PRESSED
: CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
);
190 command
.parameters
.PushBack((uint8_t)CEC_CB_OPERAND1(p0
));
193 m_callback
->OnCommandReceived(command
);
196 case VC_CEC_BUTTON_RELEASE
:
197 case VC_CEC_REMOTE_RELEASE
:
199 // translate into a cec_command
201 cec_command::Format(command
,
202 (cec_logical_address
)CEC_CB_INITIATOR(p0
),
203 (cec_logical_address
)CEC_CB_FOLLOWER(p0
),
204 reason
== VC_CEC_BUTTON_PRESSED
? CEC_OPCODE_USER_CONTROL_RELEASE
: CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
);
205 command
.parameters
.PushBack((uint8_t)CEC_CB_OPERAND1(p0
));
208 m_callback
->OnCommandReceived(command
);
211 case VC_CEC_LOGICAL_ADDR
:
213 CLockObject
lock(m_mutex
);
214 m_previousLogicalAddress
= m_logicalAddress
;
215 if (CEC_CB_RC(header
) == VCHIQ_SUCCESS
)
217 m_bLogicalAddressChanged
= true;
218 m_logicalAddress
= (cec_logical_address
)(p0
& 0xF);
219 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "logical address changed to %s (%x)", LIB_CEC
->ToString(m_logicalAddress
), m_logicalAddress
);
223 m_logicalAddress
= CECDEVICE_FREEUSE
;
224 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "failed to change the logical address, reset to %s (%x)", LIB_CEC
->ToString(m_logicalAddress
), m_logicalAddress
);
226 m_logicalAddressCondition
.Signal();
229 case VC_CEC_LOGICAL_ADDR_LOST
:
231 // the logical address was taken by another device
232 cec_logical_address previousAddress
= m_logicalAddress
== CECDEVICE_BROADCAST
? m_previousLogicalAddress
: m_logicalAddress
;
233 m_logicalAddress
= CECDEVICE_UNKNOWN
;
235 // notify libCEC that we lost our LA when the connection was initialised
238 CLockObject
lock(m_mutex
);
239 bNotify
= m_bInitialised
&& m_bLogicalAddressRegistered
;
242 m_callback
->HandleLogicalAddressLost(previousAddress
);
245 case VC_CEC_TOPOLOGY
:
248 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "ignoring unknown reason %x", reason
);
253 int CRPiCECAdapterCommunication::InitHostCEC(void)
255 VCHIQ_INSTANCE_T vchiq_instance
;
258 if ((iResult
= vchiq_initialise(&vchiq_instance
)) != VCHIQ_SUCCESS
)
260 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchiq_initialise failed (%d)", __FUNCTION__
, iResult
);
262 strError
.Format("%s - vchiq_initialise failed (%d)", __FUNCTION__
, iResult
);
263 m_strError
= strError
;
266 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchiq_initialise succeeded", __FUNCTION__
);
268 if ((iResult
= vchi_initialise(&m_vchi_instance
)) != VCHIQ_SUCCESS
)
270 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchi_initialise failed (%d)", __FUNCTION__
, iResult
);
272 strError
.Format("%s - vchi_initialise failed (%d)", __FUNCTION__
, iResult
);
273 m_strError
= strError
;
276 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchi_initialise succeeded", __FUNCTION__
);
278 vchiq_instance
= (VCHIQ_INSTANCE_T
)m_vchi_instance
;
280 m_vchi_connection
= vchi_create_connection(single_get_func_table(),
281 vchi_mphi_message_driver_func_table());
283 if ((iResult
= vchi_connect(&m_vchi_connection
, 1, m_vchi_instance
)) != VCHIQ_SUCCESS
)
285 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchi_connect failed (%d)", __FUNCTION__
, iResult
);
287 strError
.Format("%s - vchi_connect failed (%d)", __FUNCTION__
, iResult
);
288 m_strError
= strError
;
291 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchi_connect succeeded", __FUNCTION__
);
293 return VCHIQ_SUCCESS
;
296 bool CRPiCECAdapterCommunication::Open(uint32_t iTimeoutMs
/* = CEC_DEFAULT_CONNECT_TIMEOUT */, bool UNUSED(bSkipChecks
) /* = false */, bool bStartListening
)
300 if (InitHostCEC() != VCHIQ_SUCCESS
)
305 // enable passive mode
306 vc_cec_set_passive(true);
308 // register the callbacks
309 vc_cec_register_callback(rpi_cec_callback
, (void*)this);
310 vc_tv_register_callback(rpi_tv_callback
, (void*)this);
312 // release previous LA
313 vc_cec_release_logical_address();
314 if (!m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
, iTimeoutMs
))
316 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "failed to release the previous LA");
320 // register LA "freeuse"
321 if (RegisterLogicalAddress(CECDEVICE_FREEUSE
))
323 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vc_cec initialised", __FUNCTION__
);
324 CLockObject
lock(m_mutex
);
325 m_bInitialised
= true;
328 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vc_cec could not be initialised", __FUNCTION__
);
334 uint16_t CRPiCECAdapterCommunication::GetPhysicalAddress(void)
336 uint16_t iPA(CEC_INVALID_PHYSICAL_ADDRESS
);
337 if (!IsInitialised())
340 if (vc_cec_get_physical_address(&iPA
) == VCHIQ_SUCCESS
)
341 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - physical address = %04x", __FUNCTION__
, iPA
);
344 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "%s - failed to get the physical address", __FUNCTION__
);
345 iPA
= CEC_INVALID_PHYSICAL_ADDRESS
;
351 void CRPiCECAdapterCommunication::Close(void)
354 CLockObject
lock(m_mutex
);
356 m_bInitialised
= false;
360 vc_tv_unregister_callback(rpi_tv_callback
);
362 UnregisterLogicalAddress();
364 // disable passive mode
365 vc_cec_set_passive(false);
369 g_bHostInited
= false;
374 std::string
CRPiCECAdapterCommunication::GetError(void) const
376 std::string
strError(m_strError
);
380 cec_adapter_message_state
CRPiCECAdapterCommunication::Write(const cec_command
&data
, bool &UNUSED(bRetry
), uint8_t UNUSED(iLineTimeout
), bool bIsReply
)
382 // ensure that the source LA is registered
383 if (!RegisterLogicalAddress(data
.initiator
))
385 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "failed to register logical address %s (%X)", CCECTypeUtils::ToString(data
.initiator
), data
.initiator
);
386 return (data
.initiator
== data
.destination
) ? ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
: ADAPTER_MESSAGE_STATE_ERROR
;
389 if (!data
.opcode_set
&& data
.initiator
== data
.destination
)
391 // registration of the logical address would have failed
392 return ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
395 return m_queue
->Write(data
, bIsReply
) ? ADAPTER_MESSAGE_STATE_SENT_ACKED
: ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
398 uint16_t CRPiCECAdapterCommunication::GetFirmwareVersion(void)
400 return VC_CECSERVICE_VER
;
403 cec_logical_address
CRPiCECAdapterCommunication::GetLogicalAddress(void)
406 CLockObject
lock(m_mutex
);
407 if (m_logicalAddress
!= CECDEVICE_UNKNOWN
)
408 return m_logicalAddress
;
411 CEC_AllDevices_T address
;
412 return (vc_cec_get_logical_address(&address
) == VCHIQ_SUCCESS
) ?
413 (cec_logical_address
)address
: CECDEVICE_UNKNOWN
;
416 bool CRPiCECAdapterCommunication::UnregisterLogicalAddress(void)
418 CLockObject
lock(m_mutex
);
419 if (m_logicalAddress
== CECDEVICE_UNKNOWN
||
420 m_logicalAddress
== CECDEVICE_BROADCAST
)
423 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - releasing previous logical address", __FUNCTION__
);
425 CLockObject
lock(m_mutex
);
426 m_bLogicalAddressRegistered
= false;
427 m_bLogicalAddressChanged
= false;
430 vc_cec_release_logical_address();
432 return m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
);
435 bool CRPiCECAdapterCommunication::RegisterLogicalAddress(const cec_logical_address address
)
438 CLockObject
lock(m_mutex
);
439 if (m_logicalAddress
== address
)
443 if (!UnregisterLogicalAddress())
446 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - registering address %x", __FUNCTION__
, address
);
448 CLockObject
lock(m_mutex
);
449 m_bLogicalAddressChanged
= false;
450 vc_cec_poll_address((CEC_AllDevices_T
)address
);
452 // register the new LA
453 int iRetval
= vc_cec_set_logical_address((CEC_AllDevices_T
)address
, (CEC_DEVICE_TYPE_T
)CCECTypeUtils::GetType(address
), CEC_VENDOR_ID_BROADCOM
);
454 if (iRetval
!= VCHIQ_SUCCESS
)
456 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vc_cec_set_logical_address(%X) returned %s (%d)", __FUNCTION__
, address
, ToString((VC_CEC_ERROR_T
)iRetval
), iRetval
);
460 if (m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
))
462 m_bLogicalAddressRegistered
= true;
468 cec_logical_addresses
CRPiCECAdapterCommunication::GetLogicalAddresses(void)
470 cec_logical_addresses addresses
; addresses
.Clear();
471 cec_logical_address current
= GetLogicalAddress();
472 if (current
!= CECDEVICE_UNKNOWN
)
473 addresses
.Set(current
);
478 bool CRPiCECAdapterCommunication::SetLogicalAddresses(const cec_logical_addresses
&addresses
)
480 // the current generation RPi only supports 1 LA, so just ensure that the primary address is registered
481 return SupportsSourceLogicalAddress(addresses
.primary
) &&
482 RegisterLogicalAddress(addresses
.primary
);
485 void CRPiCECAdapterCommunication::InitHost(void)
489 g_bHostInited
= true;