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
);
114 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
);
122 // translate into a VC_CEC_MESSAGE_T
123 VC_CEC_MESSAGE_T message
;
124 vc_cec_param2message(header
, p0
, p1
, p2
, p3
, &message
);
126 // translate to a cec_command
128 cec_command::Format(command
,
129 (cec_logical_address
)message
.initiator
,
130 (cec_logical_address
)message
.follower
,
131 (cec_opcode
)CEC_CB_OPCODE(p0
));
134 for (uint8_t iPtr
= 1; iPtr
< message
.length
; iPtr
++)
135 command
.PushBack(message
.payload
[iPtr
]);
138 m_callback
->OnCommandReceived(command
);
143 // handle response to a command that was sent earlier
144 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
));
147 case VC_CEC_BUTTON_PRESSED
:
148 case VC_CEC_REMOTE_PRESSED
:
150 // translate into a cec_command
152 cec_command::Format(command
,
153 (cec_logical_address
)CEC_CB_INITIATOR(p0
),
154 (cec_logical_address
)CEC_CB_FOLLOWER(p0
),
155 reason
== VC_CEC_BUTTON_PRESSED
? CEC_OPCODE_USER_CONTROL_PRESSED
: CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
);
156 command
.parameters
.PushBack((uint8_t)CEC_CB_OPERAND1(p0
));
159 m_callback
->OnCommandReceived(command
);
162 case VC_CEC_BUTTON_RELEASE
:
163 case VC_CEC_REMOTE_RELEASE
:
165 // translate into a cec_command
167 cec_command::Format(command
,
168 (cec_logical_address
)CEC_CB_INITIATOR(p0
),
169 (cec_logical_address
)CEC_CB_FOLLOWER(p0
),
170 reason
== VC_CEC_BUTTON_PRESSED
? CEC_OPCODE_USER_CONTROL_RELEASE
: CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
);
171 command
.parameters
.PushBack((uint8_t)CEC_CB_OPERAND1(p0
));
174 m_callback
->OnCommandReceived(command
);
177 case VC_CEC_LOGICAL_ADDR
:
179 CLockObject
lock(m_mutex
);
180 m_previousLogicalAddress
= m_logicalAddress
;
181 if (CEC_CB_RC(header
) == VCHIQ_SUCCESS
)
183 m_bLogicalAddressChanged
= true;
184 m_logicalAddress
= (cec_logical_address
)(p0
& 0xF);
185 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "logical address changed to %s (%x)", LIB_CEC
->ToString(m_logicalAddress
), m_logicalAddress
);
189 m_logicalAddress
= CECDEVICE_FREEUSE
;
190 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "failed to change the logical address, reset to %s (%x)", LIB_CEC
->ToString(m_logicalAddress
), m_logicalAddress
);
192 m_logicalAddressCondition
.Signal();
195 case VC_CEC_LOGICAL_ADDR_LOST
:
197 // the logical address was taken by another device
198 cec_logical_address previousAddress
= m_logicalAddress
== CECDEVICE_BROADCAST
? m_previousLogicalAddress
: m_logicalAddress
;
199 m_logicalAddress
= CECDEVICE_UNKNOWN
;
201 // notify libCEC that we lost our LA when the connection was initialised
203 m_callback
->HandleLogicalAddressLost(previousAddress
);
206 case VC_CEC_TOPOLOGY
:
209 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "ignoring unknown reason %x", reason
);
214 int CRPiCECAdapterCommunication::InitHostCEC(void)
216 VCHIQ_INSTANCE_T vchiq_instance
;
219 if ((iResult
= vchiq_initialise(&vchiq_instance
)) != VCHIQ_SUCCESS
)
221 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchiq_initialise failed (%d)", __FUNCTION__
, iResult
);
223 strError
.Format("%s - vchiq_initialise failed (%d)", __FUNCTION__
, iResult
);
224 m_strError
= strError
;
227 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchiq_initialise succeeded", __FUNCTION__
);
229 if ((iResult
= vchi_initialise(&m_vchi_instance
)) != VCHIQ_SUCCESS
)
231 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchi_initialise failed (%d)", __FUNCTION__
, iResult
);
233 strError
.Format("%s - vchi_initialise failed (%d)", __FUNCTION__
, iResult
);
234 m_strError
= strError
;
237 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchi_initialise succeeded", __FUNCTION__
);
239 vchiq_instance
= (VCHIQ_INSTANCE_T
)m_vchi_instance
;
241 m_vchi_connection
= vchi_create_connection(single_get_func_table(),
242 vchi_mphi_message_driver_func_table());
244 if ((iResult
= vchi_connect(&m_vchi_connection
, 1, m_vchi_instance
)) != VCHIQ_SUCCESS
)
246 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vchi_connect failed (%d)", __FUNCTION__
, iResult
);
248 strError
.Format("%s - vchi_connect failed (%d)", __FUNCTION__
, iResult
);
249 m_strError
= strError
;
252 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vchi_connect succeeded", __FUNCTION__
);
254 return VCHIQ_SUCCESS
;
257 bool CRPiCECAdapterCommunication::Open(uint32_t iTimeoutMs
/* = CEC_DEFAULT_CONNECT_TIMEOUT */, bool UNUSED(bSkipChecks
) /* = false */, bool bStartListening
)
261 if (InitHostCEC() != VCHIQ_SUCCESS
)
266 // enable passive mode
267 vc_cec_set_passive(true);
269 // register the callback
270 vc_cec_register_callback(((CECSERVICE_CALLBACK_T
)rpi_cec_callback
), (void*)this);
272 // release previous LA
273 vc_cec_release_logical_address();
274 if (!m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
, iTimeoutMs
))
276 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "failed to release the previous LA");
280 // register LA "freeuse"
281 if (RegisterLogicalAddress(CECDEVICE_FREEUSE
))
283 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - vc_cec initialised", __FUNCTION__
);
284 CLockObject
lock(m_mutex
);
285 m_bInitialised
= true;
288 LIB_CEC
->AddLog(CEC_LOG_ERROR
, "%s - vc_cec could not be initialised", __FUNCTION__
);
294 uint16_t CRPiCECAdapterCommunication::GetPhysicalAddress(void)
296 uint16_t iPA(CEC_INVALID_PHYSICAL_ADDRESS
);
297 if (!IsInitialised())
300 if (vc_cec_get_physical_address(&iPA
) == VCHIQ_SUCCESS
)
301 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - physical address = %04x", __FUNCTION__
, iPA
);
304 LIB_CEC
->AddLog(CEC_LOG_WARNING
, "%s - failed to get the physical address", __FUNCTION__
);
305 iPA
= CEC_INVALID_PHYSICAL_ADDRESS
;
311 void CRPiCECAdapterCommunication::Close(void)
314 CLockObject
lock(m_mutex
);
316 m_bInitialised
= false;
320 UnregisterLogicalAddress();
322 // disable passive mode
323 vc_cec_set_passive(false);
327 g_bHostInited
= false;
332 std::string
CRPiCECAdapterCommunication::GetError(void) const
334 std::string
strError(m_strError
);
338 cec_adapter_message_state
CRPiCECAdapterCommunication::Write(const cec_command
&data
, bool &UNUSED(bRetry
), uint8_t UNUSED(iLineTimeout
), bool bIsReply
)
340 // ensure that the source LA is registered
341 if (!RegisterLogicalAddress(data
.initiator
))
343 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "failed to register logical address %s (%X)", CCECTypeUtils::ToString(data
.initiator
), data
.initiator
);
344 return (data
.initiator
== data
.destination
) ? ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
: ADAPTER_MESSAGE_STATE_ERROR
;
347 if (!data
.opcode_set
&& data
.initiator
== data
.destination
)
349 // registration of the logical address would have failed
350 return ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
353 return m_queue
->Write(data
, bIsReply
) ? ADAPTER_MESSAGE_STATE_SENT_ACKED
: ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
;
356 uint16_t CRPiCECAdapterCommunication::GetFirmwareVersion(void)
358 return VC_CECSERVICE_VER
;
361 cec_logical_address
CRPiCECAdapterCommunication::GetLogicalAddress(void)
364 CLockObject
lock(m_mutex
);
365 if (m_logicalAddress
!= CECDEVICE_UNKNOWN
)
366 return m_logicalAddress
;
369 CEC_AllDevices_T address
;
370 return (vc_cec_get_logical_address(&address
) == VCHIQ_SUCCESS
) ?
371 (cec_logical_address
)address
: CECDEVICE_UNKNOWN
;
374 bool CRPiCECAdapterCommunication::UnregisterLogicalAddress(void)
376 CLockObject
lock(m_mutex
);
377 if (m_logicalAddress
== CECDEVICE_UNKNOWN
||
378 m_logicalAddress
== CECDEVICE_BROADCAST
)
381 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - releasing previous logical address", __FUNCTION__
);
382 m_bLogicalAddressChanged
= false;
384 vc_cec_release_logical_address();
386 return m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
);
389 bool CRPiCECAdapterCommunication::RegisterLogicalAddress(const cec_logical_address address
)
392 CLockObject
lock(m_mutex
);
393 if (m_logicalAddress
== address
)
397 if (!UnregisterLogicalAddress())
400 LIB_CEC
->AddLog(CEC_LOG_DEBUG
, "%s - registering address %x", __FUNCTION__
, address
);
402 CLockObject
lock(m_mutex
);
403 m_bLogicalAddressChanged
= false;
404 vc_cec_poll_address((CEC_AllDevices_T
)address
);
406 // register the new LA
407 int iRetval
= vc_cec_set_logical_address((CEC_AllDevices_T
)address
, (CEC_DEVICE_TYPE_T
)CCECTypeUtils::GetType(address
), CEC_VENDOR_ID_BROADCOM
);
408 if (iRetval
!= VCHIQ_SUCCESS
)
410 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
);
414 return m_logicalAddressCondition
.Wait(m_mutex
, m_bLogicalAddressChanged
);
417 cec_logical_addresses
CRPiCECAdapterCommunication::GetLogicalAddresses(void)
419 cec_logical_addresses addresses
; addresses
.Clear();
420 cec_logical_address current
= GetLogicalAddress();
421 if (current
!= CECDEVICE_UNKNOWN
)
422 addresses
.Set(current
);
427 bool CRPiCECAdapterCommunication::SetLogicalAddresses(const cec_logical_addresses
&addresses
)
429 // the current generation RPi only supports 1 LA, so just ensure that the primary address is registered
430 return SupportsSourceLogicalAddress(addresses
.primary
) &&
431 RegisterLogicalAddress(addresses
.primary
);
434 void CRPiCECAdapterCommunication::InitHost(void)
438 g_bHostInited
= true;