rpi: handle VC_CEC_LOGICAL_ADDR_LOST. re-register the client when this happens, so...
[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;
7d27bafc
LOK
183 case VC_CEC_LOGICAL_ADDR_LOST:
184 {
185 // the logical address was taken by another device
186 cec_logical_address previousAddress = m_logicalAddress;
187 m_logicalAddress = CECDEVICE_UNKNOWN;
188 m_callback->HandleLogicalAddressLost(previousAddress);
189 }
190 break;
29104708
LOK
191 case VC_CEC_TOPOLOGY:
192 case VC_CEC_REMOTE_PRESSED:
193 case VC_CEC_REMOTE_RELEASE:
194 break;
195 default:
196 LIB_CEC->AddLog(CEC_LOG_DEBUG, "ignoring unknown reason %x", reason);
197 break;
198 }
199}
200
201int CRPiCECAdapterCommunication::InitHostCEC(void)
202{
203 VCHIQ_INSTANCE_T vchiq_instance;
204 int iResult;
205
206 if ((iResult = vchiq_initialise(&vchiq_instance)) != VCHIQ_SUCCESS)
207 {
208 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vchiq_initialise failed (%d)", __FUNCTION__, iResult);
209 CStdString strError;
210 strError.Format("%s - vchiq_initialise failed (%d)", __FUNCTION__, iResult);
211 m_strError = strError;
212 return iResult;
213 }
214 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vchiq_initialise succeeded", __FUNCTION__);
215
216 if ((iResult = vchi_initialise(&m_vchi_instance)) != VCHIQ_SUCCESS)
217 {
218 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vchi_initialise failed (%d)", __FUNCTION__, iResult);
219 CStdString strError;
220 strError.Format("%s - vchi_initialise failed (%d)", __FUNCTION__, iResult);
221 m_strError = strError;
222 return iResult;
223 }
224 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vchi_initialise succeeded", __FUNCTION__);
225
226 vchiq_instance = (VCHIQ_INSTANCE_T)m_vchi_instance;
227
228 m_vchi_connection = vchi_create_connection(single_get_func_table(),
229 vchi_mphi_message_driver_func_table());
230
231 if ((iResult = vchi_connect(&m_vchi_connection, 1, m_vchi_instance)) != VCHIQ_SUCCESS)
232 {
233 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vchi_connect failed (%d)", __FUNCTION__, iResult);
234 CStdString strError;
235 strError.Format("%s - vchi_connect failed (%d)", __FUNCTION__, iResult);
236 m_strError = strError;
237 return iResult;
238 }
239 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vchi_connect succeeded", __FUNCTION__);
240
241 return VCHIQ_SUCCESS;
242}
243
244bool CRPiCECAdapterCommunication::Open(uint32_t iTimeoutMs /* = CEC_DEFAULT_CONNECT_TIMEOUT */, bool UNUSED(bSkipChecks) /* = false */, bool bStartListening)
245{
246 Close();
247
248 if (InitHostCEC() != VCHIQ_SUCCESS)
249 return false;
250
251 if (bStartListening)
252 {
253 // enable passive mode
254 vc_cec_set_passive(true);
255
256 // register the callback
257 vc_cec_register_callback(((CECSERVICE_CALLBACK_T)rpi_cec_callback), (void*)this);
258
259 // release previous LA
260 vc_cec_release_logical_address();
261 if (!m_logicalAddressCondition.Wait(m_mutex, m_bLogicalAddressChanged, iTimeoutMs))
262 {
263 LIB_CEC->AddLog(CEC_LOG_ERROR, "failed to release the previous LA");
264 return false;
265 }
266
267 // register LA "freeuse"
268 if (RegisterLogicalAddress(CECDEVICE_FREEUSE))
269 {
270 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - vc_cec initialised", __FUNCTION__);
271 CLockObject lock(m_mutex);
272 m_bInitialised = true;
273 }
274 else
275 LIB_CEC->AddLog(CEC_LOG_ERROR, "%s - vc_cec could not be initialised", __FUNCTION__);
276 }
277
278 return true;
279}
280
281uint16_t CRPiCECAdapterCommunication::GetPhysicalAddress(void)
282{
283 uint16_t iPA(CEC_INVALID_PHYSICAL_ADDRESS);
284 if (!IsInitialised())
285 return iPA;
286
287 if (vc_cec_get_physical_address(&iPA) == VCHIQ_SUCCESS)
288 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - physical address = %04x", __FUNCTION__, iPA);
289 else
290 {
291 LIB_CEC->AddLog(CEC_LOG_WARNING, "%s - failed to get the physical address", __FUNCTION__);
292 iPA = CEC_INVALID_PHYSICAL_ADDRESS;
293 }
294
295 return iPA;
296}
297
298void CRPiCECAdapterCommunication::Close(void)
299{
300 {
301 CLockObject lock(m_mutex);
302 if (m_bInitialised)
303 m_bInitialised = false;
304 else
305 return;
306 }
307 UnregisterLogicalAddress();
308
309 // disable passive mode
310 vc_cec_set_passive(false);
311
312 if (!g_bHostInited)
313 {
314 g_bHostInited = false;
315 bcm_host_deinit();
316 }
317}
318
319std::string CRPiCECAdapterCommunication::GetError(void) const
320{
321 std::string strError(m_strError);
322 return strError;
323}
324
325cec_adapter_message_state CRPiCECAdapterCommunication::Write(const cec_command &data, bool &UNUSED(bRetry), uint8_t UNUSED(iLineTimeout), bool bIsReply)
326{
327 // ensure that the source LA is registered
328 if (!RegisterLogicalAddress(data.initiator))
329 {
330 LIB_CEC->AddLog(CEC_LOG_DEBUG, "failed to register logical address %s (%X)", CCECTypeUtils::ToString(data.initiator), data.initiator);
331 return (data.initiator == data.destination) ? ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED : ADAPTER_MESSAGE_STATE_ERROR;
332 }
333
334 if (!data.opcode_set && data.initiator == data.destination)
335 {
336 // registration of the logical address would have failed
337 return ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
338 }
339
340 return m_queue->Write(data, bIsReply) ? ADAPTER_MESSAGE_STATE_SENT_ACKED : ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED;
341}
342
343uint16_t CRPiCECAdapterCommunication::GetFirmwareVersion(void)
344{
345 return VC_CECSERVICE_VER;
346}
347
348cec_logical_address CRPiCECAdapterCommunication::GetLogicalAddress(void)
349{
350 {
351 CLockObject lock(m_mutex);
352 if (m_logicalAddress != CECDEVICE_UNKNOWN)
353 return m_logicalAddress;
354 }
355
356 CEC_AllDevices_T address;
357 return (vc_cec_get_logical_address(&address) == VCHIQ_SUCCESS) ?
358 (cec_logical_address)address : CECDEVICE_UNKNOWN;
359}
360
361bool CRPiCECAdapterCommunication::UnregisterLogicalAddress(void)
362{
363 CLockObject lock(m_mutex);
364 if (m_logicalAddress == CECDEVICE_UNKNOWN ||
365 m_logicalAddress == CECDEVICE_BROADCAST)
366 return true;
367
368 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - releasing previous logical address", __FUNCTION__);
369 m_bLogicalAddressChanged = false;
370
371 vc_cec_release_logical_address();
372
373 return m_logicalAddressCondition.Wait(m_mutex, m_bLogicalAddressChanged);
374}
375
376bool CRPiCECAdapterCommunication::RegisterLogicalAddress(const cec_logical_address address)
377{
378 {
379 CLockObject lock(m_mutex);
380 if (m_logicalAddress == address)
381 return true;
382 }
383
384 if (!UnregisterLogicalAddress())
385 return false;
386
387 LIB_CEC->AddLog(CEC_LOG_DEBUG, "%s - registering address %x", __FUNCTION__, address);
388
389 CLockObject lock(m_mutex);
390 m_bLogicalAddressChanged = false;
391 vc_cec_poll_address((CEC_AllDevices_T)address);
392
393 // register the new LA
394 int iRetval = vc_cec_set_logical_address((CEC_AllDevices_T)address, (CEC_DEVICE_TYPE_T)CCECTypeUtils::GetType(address), CEC_VENDOR_ID_BROADCOM);
395 if (iRetval != VCHIQ_SUCCESS)
396 {
397 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);
398 return false;
399 }
400
401 return m_logicalAddressCondition.Wait(m_mutex, m_bLogicalAddressChanged);
402}
403
404cec_logical_addresses CRPiCECAdapterCommunication::GetLogicalAddresses(void)
405{
406 cec_logical_addresses addresses; addresses.Clear();
407 cec_logical_address current = GetLogicalAddress();
408 if (current != CECDEVICE_UNKNOWN)
409 addresses.Set(current);
410
411 return addresses;
412}
413
414bool CRPiCECAdapterCommunication::SetLogicalAddresses(const cec_logical_addresses &addresses)
415{
416 // the current generation RPi only supports 1 LA, so just ensure that the primary address is registered
417 return SupportsSourceLogicalAddress(addresses.primary) &&
418 RegisterLogicalAddress(addresses.primary);
419}
420
421void CRPiCECAdapterCommunication::InitHost(void)
422{
423 if (!g_bHostInited)
424 {
425 g_bHostInited = true;
426 bcm_host_init();
427 }
428}
429
430#endif