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/
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 CRPiCECAdapterCommunication::CRPiCECAdapterCommunication(IAdapterCommunicationCallback
*callback
) :
62 IAdapterCommunication(callback
),
63 m_logicalAddress(CECDEVICE_UNKNOWN
),
64 m_bLogicalAddressChanged(false),
65 m_previousLogicalAddress(CECDEVICE_FREEUSE
)
67 m_queue
= new CRPiCECAdapterMessageQueue(this);
70 CRPiCECAdapterCommunication::~CRPiCECAdapterCommunication(void)
76 const char *ToString(const VC_CEC_ERROR_T error
)
82 case VC_CEC_ERROR_NO_ACK
:
84 case VC_CEC_ERROR_SHUTDOWN
:
86 case VC_CEC_ERROR_BUSY
:
87 return "device is busy";
88 case VC_CEC_ERROR_NO_LA
:
89 return "no logical address";
90 case VC_CEC_ERROR_NO_PA
:
91 return "no physical address";
92 case VC_CEC_ERROR_NO_TOPO
:
94 case VC_CEC_ERROR_INVALID_FOLLOWER
:
95 return "invalid follower";
96 case VC_CEC_ERROR_INVALID_ARGUMENT
:
103 bool CRPiCECAdapterCommunication::IsInitialised(void)
105 CLockObject
lock(m_mutex
);
106 return m_bInitialised
;
109 void CRPiCECAdapterCommunication::OnDataReceived(uint32_t header
, uint32_t p0
, uint32_t p1
, uint32_t p2
, uint32_t p3
)
111 VC_CEC_NOTIFY_T reason
= (VC_CEC_NOTIFY_T
)CEC_CB_REASON(header
);
113 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
);
120 // translate into a VC_CEC_MESSAGE_T
121 VC_CEC_MESSAGE_T message
;
122 vc_cec_param2message(header
, p0
, p1
, p2
, p3
, &message
);
124 // translate to a cec_command
126 cec_command::Format(command
,
127 (cec_logical_address
)message
.initiator
,
128 (cec_logical_address
)message
.follower
,
129 (cec_opcode
)CEC_CB_OPCODE(p0
));
132 for (uint8_t iPtr
= 1; iPtr
< message
.length
; iPtr
++)
133 command
.PushBack(message
.payload
[iPtr
]);
136 m_callback
->OnCommandReceived(command
);
141 // handle response to a command that was sent earlier
142 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
));
145 case VC_CEC_BUTTON_PRESSED
:
146 case VC_CEC_REMOTE_PRESSED
:
148 // translate into a cec_command
150 cec_command::Format(command
,
151 (cec_logical_address
)CEC_CB_INITIATOR(p0
),
152 (cec_logical_address
)CEC_CB_FOLLOWER(p0
),
153 reason
== VC_CEC_BUTTON_PRESSED
? CEC_OPCODE_USER_CONTROL_PRESSED
: CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
);
154 command
.parameters
.PushBack((uint8_t)CEC_CB_OPERAND1(p0
));
157 m_callback
->OnCommandReceived(command
);
160 case VC_CEC_BUTTON_RELEASE
:
161 case VC_CEC_REMOTE_RELEASE
:
163 // translate into a cec_command
165 cec_command::Format(command
,
166 (cec_logical_address
)CEC_CB_INITIATOR(p0
),
167 (cec_logical_address
)CEC_CB_FOLLOWER(p0
),
168 reason
== VC_CEC_BUTTON_PRESSED
? CEC_OPCODE_USER_CONTROL_RELEASE
: CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
);
169 command
.parameters
.PushBack((uint8_t)CEC_CB_OPERAND1(p0
));
172 m_callback
->OnCommandReceived(command
);
175 case VC_CEC_LOGICAL_ADDR
:
177 CLockObject
lock(m_mutex
);
178 m_previousLogicalAddress
= m_logicalAddress
;
179 if (CEC_CB_RC(header
) == VCHIQ_SUCCESS
)
181 m_bLogicalAddressChanged
= true;
182 m_logicalAddress
= (cec_logical_address
)(p0
& 0xF);
183 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "logical address changed to %s (%x)", LIB_CEC
->ToString(m_logicalAddress
), m_logicalAddress
);
187 m_logicalAddress
= CECDEVICE_FREEUSE
;
188 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "failed to change the logical address, reset to %s (%x)", LIB_CEC
->ToString(m_logicalAddress
), m_logicalAddress
);
190 m_logicalAddressCondition
.Signal();
193 case VC_CEC_LOGICAL_ADDR_LOST
:
195 // the logical address was taken by another device
196 cec_logical_address previousAddress
= m_logicalAddress
== CECDEVICE_BROADCAST
? m_previousLogicalAddress
: m_logicalAddress
;
197 m_logicalAddress
= CECDEVICE_UNKNOWN
;
199 // notify libCEC that we lost our LA when the connection was initialised
201 m_callback
->HandleLogicalAddressLost(previousAddress
);
204 case VC_CEC_TOPOLOGY
:
207 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "ignoring unknown reason %x", reason
);
212 int CRPiCECAdapterCommunication::InitHostCEC(void)
214 VCHIQ_INSTANCE_T vchiq_instance
;
217 if ((iResult
= vchiq_initialise(&vchiq_instance
)) != VCHIQ_SUCCESS
)
219 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchiq_initialise failed (%d)", __FUNCTION__
, iResult
);
221 strError
.Format("%s - vchiq_initialise failed (%d)", __FUNCTION__
, iResult
);
222 m_strError
= strError
;
225 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchiq_initialise succeeded", __FUNCTION__
);
227 if ((iResult
= vchi_initialise(&m_vchi_instance
)) != VCHIQ_SUCCESS
)
229 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchi_initialise failed (%d)", __FUNCTION__
, iResult
);
231 strError
.Format("%s - vchi_initialise failed (%d)", __FUNCTION__
, iResult
);
232 m_strError
= strError
;
235 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchi_initialise succeeded", __FUNCTION__
);
237 vchiq_instance
= (VCHIQ_INSTANCE_T
)m_vchi_instance
;
239 m_vchi_connection
= vchi_create_connection(single_get_func_table(),
240 vchi_mphi_message_driver_func_table());
242 if ((iResult
= vchi_connect(&m_vchi_connection
, 1, m_vchi_instance
)) != VCHIQ_SUCCESS
)
244 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchi_connect failed (%d)", __FUNCTION__
, iResult
);
246 strError
.Format("%s - vchi_connect failed (%d)", __FUNCTION__
, iResult
);
247 m_strError
= strError
;
250 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchi_connect succeeded", __FUNCTION__
);
252 return VCHIQ_SUCCESS
;
255 bool CRPiCECAdapterCommunication::Open(uint32_t iTimeoutMs
/* = CEC_DEFAULT_CONNECT_TIMEOUT */, bool UNUSED(bSkipChecks
) /* = false */, bool bStartListening
)
259 if (InitHostCEC() != VCHIQ_SUCCESS
)
264 // enable passive mode
265 vc_cec_set_passive(true);
267 // register the callback
268 vc_cec_register_callback(((CECSERVICE_CALLBACK_T
)rpi_cec_callback
), (void*)this);
270 // release previous LA
271 vc_cec_release_logical_address();
272 if (!m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
, iTimeoutMs
))
274 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "failed to release the previous LA");
278 // register LA "freeuse"
279 if (RegisterLogicalAddress(CECDEVICE_FREEUSE
))
281 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vc_cec initialised", __FUNCTION__
);
282 CLockObject
lock(m_mutex
);
283 m_bInitialised
= true;
286 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vc_cec could not be initialised", __FUNCTION__
);
292 uint16_t CRPiCECAdapterCommunication::GetPhysicalAddress(void)
294 uint16_t iPA(CEC_INVALID_PHYSICAL_ADDRESS
);
295 if (!IsInitialised())
298 if (vc_cec_get_physical_address(&iPA
) == VCHIQ_SUCCESS
)
299 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - physical address = %04x", __FUNCTION__
, iPA
);
302 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "%s - failed to get the physical address", __FUNCTION__
);
303 iPA
= CEC_INVALID_PHYSICAL_ADDRESS
;
309 void CRPiCECAdapterCommunication::Close(void)
312 CLockObject
lock(m_mutex
);
314 m_bInitialised
= false;
318 UnregisterLogicalAddress();
320 // disable passive mode
321 vc_cec_set_passive(false);
325 g_bHostInited
= false;
330 std::string
CRPiCECAdapterCommunication::GetError(void) const
332 std::string
strError(m_strError
);
336 cec_adapter_message_state
CRPiCECAdapterCommunication::Write(const cec_command
&data
, bool &UNUSED(bRetry
), uint8_t UNUSED(iLineTimeout
), bool bIsReply
)
338 // ensure that the source LA is registered
339 if (!RegisterLogicalAddress(data
.initiator
))
341 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "failed to register logical address %s (%X)", CCECTypeUtils::ToString(data
.initiator
), data
.initiator
);
342 return (data
.initiator
== data
.destination
) ? ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
: ADAPTER_MESSAGE_STATE_ERROR
;
345 if (!data
.opcode_set
&& data
.initiator
== data
.destination
)
347 // registration of the logical address would have failed
348 return ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
351 return m_queue
->Write(data
, bIsReply
) ? ADAPTER_MESSAGE_STATE_SENT_ACKED
: ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
354 uint16_t CRPiCECAdapterCommunication::GetFirmwareVersion(void)
356 return VC_CECSERVICE_VER
;
359 cec_logical_address
CRPiCECAdapterCommunication::GetLogicalAddress(void)
362 CLockObject
lock(m_mutex
);
363 if (m_logicalAddress
!= CECDEVICE_UNKNOWN
)
364 return m_logicalAddress
;
367 CEC_AllDevices_T address
;
368 return (vc_cec_get_logical_address(&address
) == VCHIQ_SUCCESS
) ?
369 (cec_logical_address
)address
: CECDEVICE_UNKNOWN
;
372 bool CRPiCECAdapterCommunication::UnregisterLogicalAddress(void)
374 CLockObject
lock(m_mutex
);
375 if (m_logicalAddress
== CECDEVICE_UNKNOWN
||
376 m_logicalAddress
== CECDEVICE_BROADCAST
)
379 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - releasing previous logical address", __FUNCTION__
);
380 m_bLogicalAddressChanged
= false;
382 vc_cec_release_logical_address();
384 return m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
);
387 bool CRPiCECAdapterCommunication::RegisterLogicalAddress(const cec_logical_address address
)
390 CLockObject
lock(m_mutex
);
391 if (m_logicalAddress
== address
)
395 if (!UnregisterLogicalAddress())
398 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - registering address %x", __FUNCTION__
, address
);
400 CLockObject
lock(m_mutex
);
401 m_bLogicalAddressChanged
= false;
402 vc_cec_poll_address((CEC_AllDevices_T
)address
);
404 // register the new LA
405 int iRetval
= vc_cec_set_logical_address((CEC_AllDevices_T
)address
, (CEC_DEVICE_TYPE_T
)CCECTypeUtils::GetType(address
), CEC_VENDOR_ID_BROADCOM
);
406 if (iRetval
!= VCHIQ_SUCCESS
)
408 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
);
412 return m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
);
415 cec_logical_addresses
CRPiCECAdapterCommunication::GetLogicalAddresses(void)
417 cec_logical_addresses addresses
; addresses
.Clear();
418 cec_logical_address current
= GetLogicalAddress();
419 if (current
!= CECDEVICE_UNKNOWN
)
420 addresses
.Set(current
);
425 bool CRPiCECAdapterCommunication::SetLogicalAddresses(const cec_logical_addresses
&addresses
)
427 // the current generation RPi only supports 1 LA, so just ensure that the primary address is registered
428 return SupportsSourceLogicalAddress(addresses
.primary
) &&
429 RegisterLogicalAddress(addresses
.primary
);
432 void CRPiCECAdapterCommunication::InitHost(void)
436 g_bHostInited
= true;