added HandleLogicalAddressLost() callback to IAdapterCommunication
[deb_libcec.git] / src / lib / adapter / RPi / RPiCECAdapterCommunication.cpp
CommitLineData
29104708
LOK
1/*
2 * This file is part of the libCEC(R) library.
3 *
4 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
6 *
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
8 *
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.
13 *
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.
18 *
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.
22 *
23 *
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
26 *
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/
31 */
32
33#include "env.h"
34
35#if defined(HAVE_RPI_API)
36#include "RPiCECAdapterCommunication.h"
37
38extern "C" {
39#include <bcm_host.h>
40}
41
42#include "lib/CECTypeUtils.h"
43#include "lib/LibCEC.h"
44#include "lib/platform/util/StdString.h"
45#include "RPiCECAdapterMessageQueue.h"
46
47using namespace CEC;
48using namespace PLATFORM;
49
50#define LIB_CEC m_callback->GetLib()
51
52static bool g_bHostInited = false;
53
54// callback for the RPi CEC service
55void rpi_cec_callback(void *callback_data, uint32_t p0, uint32_t p1, uint32_t p2, uint32_t p3, uint32_t p4)
56{
57 if (callback_data)
58 static_cast<CRPiCECAdapterCommunication *>(callback_data)->OnDataReceived(p0, p1, p2, p3, p4);
59}
60
61CRPiCECAdapterCommunication::CRPiCECAdapterCommunication(IAdapterCommunicationCallback *callback) :
62 IAdapterCommunication(callback),
63 m_logicalAddress(CECDEVICE_UNKNOWN),
64 m_bLogicalAddressChanged(false)
65{
66 m_queue = new CRPiCECAdapterMessageQueue(this);
67}
68
69CRPiCECAdapterCommunication::~CRPiCECAdapterCommunication(void)
70{
71 delete(m_queue);
72 Close();
73}
74
75const char *ToString(const VC_CEC_ERROR_T error)
76{
77 switch(error)
78 {
79 case VC_CEC_SUCCESS:
80 return "success";
81 case VC_CEC_ERROR_NO_ACK:
82 return "no ack";
83 case VC_CEC_ERROR_SHUTDOWN:
84 return "shutdown";
85 case VC_CEC_ERROR_BUSY:
86 return "device is busy";
87 case VC_CEC_ERROR_NO_LA:
88 return "no logical address";
89 case VC_CEC_ERROR_NO_PA:
90 return "no physical address";
91 case VC_CEC_ERROR_NO_TOPO:
92 return "no topology";
93 case VC_CEC_ERROR_INVALID_FOLLOWER:
94 return "invalid follower";
95 case VC_CEC_ERROR_INVALID_ARGUMENT:
96 return "invalid arg";
97 default:
98 return "unknown";
99 }
100}
101
102bool CRPiCECAdapterCommunication::IsInitialised(void)
103{
104 CLockObject lock(m_mutex);
105 return m_bInitialised;
106}
107
108void CRPiCECAdapterCommunication::OnDataReceived(uint32_t header, uint32_t p0, uint32_t p1, uint32_t p2, uint32_t p3)
109{
110 VC_CEC_NOTIFY_T reason = (VC_CEC_NOTIFY_T)CEC_CB_REASON(header);
111
112 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);
113
114 switch (reason)
115 {
116 case VC_CEC_RX:
117 // CEC data received
118 {
119 // translate into a VC_CEC_MESSAGE_T
120 VC_CEC_MESSAGE_T message;
121 vc_cec_param2message(header, p0, p1, p2, p3, &message);
122
123 // translate to a cec_command
124 cec_command command;
125 cec_command::Format(command,
126 (cec_logical_address)message.initiator,
127 (cec_logical_address)message.follower,
128 (cec_opcode)CEC_CB_OPCODE(p0));
129
130 // copy parameters
131 for (uint8_t iPtr = 1; iPtr < message.length; iPtr++)
132 command.PushBack(message.payload[iPtr]);
133
134 // send to libCEC
135 m_callback->OnCommandReceived(command);
136 }
137 break;
138 case VC_CEC_TX:
139 {
140 // handle response to a command that was sent earlier
141 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));
142 }
143 break;
144 case VC_CEC_BUTTON_PRESSED:
145 {
146 // translate into a cec_command
147 cec_command command;
148 cec_command::Format(command, (cec_logical_address)CEC_CB_INITIATOR(p0), (cec_logical_address)CEC_CB_FOLLOWER(p0), CEC_OPCODE_USER_CONTROL_PRESSED);
149 command.parameters.PushBack((uint8_t)CEC_CB_OPERAND1(p0));
150
151 // send to libCEC
152 m_callback->OnCommandReceived(command);
153 }
154 break;
155 case VC_CEC_BUTTON_RELEASE:
156 {
157 // translate into a cec_command
158 cec_command command;
159 cec_command::Format(command, (cec_logical_address)CEC_CB_INITIATOR(p0), (cec_logical_address)CEC_CB_FOLLOWER(p0), CEC_OPCODE_USER_CONTROL_RELEASE);
160 command.parameters.PushBack((uint8_t)CEC_CB_OPERAND1(p0));
161
162 // send to libCEC
163 m_callback->OnCommandReceived(command);
164 }
165 break;
166 case VC_CEC_LOGICAL_ADDR:
167 {
168 CLockObject lock(m_mutex);
169 if (CEC_CB_RC(header) == VCHIQ_SUCCESS)
170 {
171 m_bLogicalAddressChanged = true;
172 m_logicalAddress = (cec_logical_address)(p0 & 0xF);
173 LIB_CEC->AddLog(CEC_LOG_DEBUG, "logical address changed to %s (%x)", LIB_CEC->ToString(m_logicalAddress), m_logicalAddress);
174 }
175 else
176 {
177 m_logicalAddress = CECDEVICE_BROADCAST;
178 LIB_CEC->AddLog(CEC_LOG_DEBUG, "failed to change the logical address, reset to %s (%x)", LIB_CEC->ToString(m_logicalAddress), m_logicalAddress);
179 }
180 m_logicalAddressCondition.Signal();
181 }
182 break;
183 case VC_CEC_TOPOLOGY:
184 case VC_CEC_REMOTE_PRESSED:
185 case VC_CEC_REMOTE_RELEASE:
186 break;
187 default:
188 LIB_CEC->AddLog(CEC_LOG_DEBUG, "ignoring unknown reason %x", reason);
189 break;
190 }
191}
192
193int CRPiCECAdapterCommunication::InitHostCEC(void)
194{
195 VCHIQ_INSTANCE_T vchiq_instance;
196 int iResult;
197
198 if ((iResult = vchiq_initialise(&vchiq_instance)) != VCHIQ_SUCCESS)
199 {
200 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vchiq_initialise failed (%d)", __FUNCTION__, iResult);
201 CStdString strError;
202 strError.Format("%s - vchiq_initialise failed (%d)", __FUNCTION__, iResult);
203 m_strError = strError;
204 return iResult;
205 }
206 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vchiq_initialise succeeded", __FUNCTION__);
207
208 if ((iResult = vchi_initialise(&m_vchi_instance)) != VCHIQ_SUCCESS)
209 {
210 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vchi_initialise failed (%d)", __FUNCTION__, iResult);
211 CStdString strError;
212 strError.Format("%s - vchi_initialise failed (%d)", __FUNCTION__, iResult);
213 m_strError = strError;
214 return iResult;
215 }
216 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vchi_initialise succeeded", __FUNCTION__);
217
218 vchiq_instance = (VCHIQ_INSTANCE_T)m_vchi_instance;
219
220 m_vchi_connection = vchi_create_connection(single_get_func_table(),
221 vchi_mphi_message_driver_func_table());
222
223 if ((iResult = vchi_connect(&m_vchi_connection, 1, m_vchi_instance)) != VCHIQ_SUCCESS)
224 {
225 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vchi_connect failed (%d)", __FUNCTION__, iResult);
226 CStdString strError;
227 strError.Format("%s - vchi_connect failed (%d)", __FUNCTION__, iResult);
228 m_strError = strError;
229 return iResult;
230 }
231 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vchi_connect succeeded", __FUNCTION__);
232
233 return VCHIQ_SUCCESS;
234}
235
236bool CRPiCECAdapterCommunication::Open(uint32_t iTimeoutMs /* = CEC_DEFAULT_CONNECT_TIMEOUT */, bool UNUSED(bSkipChecks) /* = false */, bool bStartListening)
237{
238 Close();
239
240 if (InitHostCEC() != VCHIQ_SUCCESS)
241 return false;
242
243 if (bStartListening)
244 {
245 // enable passive mode
246 vc_cec_set_passive(true);
247
248 // register the callback
249 vc_cec_register_callback(((CECSERVICE_CALLBACK_T)rpi_cec_callback), (void*)this);
250
251 // release previous LA
252 vc_cec_release_logical_address();
253 if (!m_logicalAddressCondition.Wait(m_mutex, m_bLogicalAddressChanged, iTimeoutMs))
254 {
255 LIB_CEC->AddLog(CEC_LOG_ERROR, "failed to release the previous LA");
256 return false;
257 }
258
259 // register LA "freeuse"
260 if (RegisterLogicalAddress(CECDEVICE_FREEUSE))
261 {
262 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vc_cec initialised", __FUNCTION__);
263 CLockObject lock(m_mutex);
264 m_bInitialised = true;
265 }
266 else
267 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vc_cec could not be initialised", __FUNCTION__);
268 }
269
270 return true;
271}
272
273uint16_t CRPiCECAdapterCommunication::GetPhysicalAddress(void)
274{
275 uint16_t iPA(CEC_INVALID_PHYSICAL_ADDRESS);
276 if (!IsInitialised())
277 return iPA;
278
279 if (vc_cec_get_physical_address(&iPA) == VCHIQ_SUCCESS)
280 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - physical address = %04x", __FUNCTION__, iPA);
281 else
282 {
283 LIB_CEC->AddLog(CEC_LOG_WARNING, "%s - failed to get the physical address", __FUNCTION__);
284 iPA = CEC_INVALID_PHYSICAL_ADDRESS;
285 }
286
287 return iPA;
288}
289
290void CRPiCECAdapterCommunication::Close(void)
291{
292 {
293 CLockObject lock(m_mutex);
294 if (m_bInitialised)
295 m_bInitialised = false;
296 else
297 return;
298 }
299 UnregisterLogicalAddress();
300
301 // disable passive mode
302 vc_cec_set_passive(false);
303
304 if (!g_bHostInited)
305 {
306 g_bHostInited = false;
307 bcm_host_deinit();
308 }
309}
310
311std::string CRPiCECAdapterCommunication::GetError(void) const
312{
313 std::string strError(m_strError);
314 return strError;
315}
316
317cec_adapter_message_state CRPiCECAdapterCommunication::Write(const cec_command &data, bool &UNUSED(bRetry), uint8_t UNUSED(iLineTimeout), bool bIsReply)
318{
319 // ensure that the source LA is registered
320 if (!RegisterLogicalAddress(data.initiator))
321 {
322 LIB_CEC->AddLog(CEC_LOG_DEBUG, "failed to register logical address %s (%X)", CCECTypeUtils::ToString(data.initiator), data.initiator);
323 return (data.initiator == data.destination) ? ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED : ADAPTER_MESSAGE_STATE_ERROR;
324 }
325
326 if (!data.opcode_set && data.initiator == data.destination)
327 {
328 // registration of the logical address would have failed
329 return ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
330 }
331
332 return m_queue->Write(data, bIsReply) ? ADAPTER_MESSAGE_STATE_SENT_ACKED : ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
333}
334
335uint16_t CRPiCECAdapterCommunication::GetFirmwareVersion(void)
336{
337 return VC_CECSERVICE_VER;
338}
339
340cec_logical_address CRPiCECAdapterCommunication::GetLogicalAddress(void)
341{
342 {
343 CLockObject lock(m_mutex);
344 if (m_logicalAddress != CECDEVICE_UNKNOWN)
345 return m_logicalAddress;
346 }
347
348 CEC_AllDevices_T address;
349 return (vc_cec_get_logical_address(&address) == VCHIQ_SUCCESS) ?
350 (cec_logical_address)address : CECDEVICE_UNKNOWN;
351}
352
353bool CRPiCECAdapterCommunication::UnregisterLogicalAddress(void)
354{
355 CLockObject lock(m_mutex);
356 if (m_logicalAddress == CECDEVICE_UNKNOWN ||
357 m_logicalAddress == CECDEVICE_BROADCAST)
358 return true;
359
360 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - releasing previous logical address", __FUNCTION__);
361 m_bLogicalAddressChanged = false;
362
363 vc_cec_release_logical_address();
364
365 return m_logicalAddressCondition.Wait(m_mutex, m_bLogicalAddressChanged);
366}
367
368bool CRPiCECAdapterCommunication::RegisterLogicalAddress(const cec_logical_address address)
369{
370 {
371 CLockObject lock(m_mutex);
372 if (m_logicalAddress == address)
373 return true;
374 }
375
376 if (!UnregisterLogicalAddress())
377 return false;
378
379 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - registering address %x", __FUNCTION__, address);
380
381 CLockObject lock(m_mutex);
382 m_bLogicalAddressChanged = false;
383 vc_cec_poll_address((CEC_AllDevices_T)address);
384
385 // register the new LA
386 int iRetval = vc_cec_set_logical_address((CEC_AllDevices_T)address, (CEC_DEVICE_TYPE_T)CCECTypeUtils::GetType(address), CEC_VENDOR_ID_BROADCOM);
387 if (iRetval != VCHIQ_SUCCESS)
388 {
389 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);
390 return false;
391 }
392
393 return m_logicalAddressCondition.Wait(m_mutex, m_bLogicalAddressChanged);
394}
395
396cec_logical_addresses CRPiCECAdapterCommunication::GetLogicalAddresses(void)
397{
398 cec_logical_addresses addresses; addresses.Clear();
399 cec_logical_address current = GetLogicalAddress();
400 if (current != CECDEVICE_UNKNOWN)
401 addresses.Set(current);
402
403 return addresses;
404}
405
406bool CRPiCECAdapterCommunication::SetLogicalAddresses(const cec_logical_addresses &addresses)
407{
408 // the current generation RPi only supports 1 LA, so just ensure that the primary address is registered
409 return SupportsSourceLogicalAddress(addresses.primary) &&
410 RegisterLogicalAddress(addresses.primary);
411}
412
413void CRPiCECAdapterCommunication::InitHost(void)
414{
415 if (!g_bHostInited)
416 {
417 g_bHostInited = true;
418 bcm_host_init();
419 }
420}
421
422#endif