cec: add GetDevicePhysicalAddress()/cec_get_device_physical_address()
[deb_libcec.git] / src / lib / AdapterCommunication.h
... / ...
CommitLineData
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
32 */
33
34#include <cectypes.h>
35#include "platform/threads.h"
36#include "util/buffer.h"
37#include "util/StdString.h"
38#include <string>
39
40namespace CEC
41{
42 typedef enum cec_adapter_message_state
43 {
44 ADAPTER_MESSAGE_STATE_UNKNOWN = 0,
45 ADAPTER_MESSAGE_STATE_WAITING,
46 ADAPTER_MESSAGE_STATE_SENT,
47 ADAPTER_MESSAGE_STATE_RECEIVED,
48 ADAPTER_MESSAGE_STATE_ERROR
49 } cec_adapter_message_state;
50
51
52 class CCECAdapterMessage
53 {
54 public:
55 CCECAdapterMessage(void) { clear(); }
56 CCECAdapterMessage(const cec_command &command);
57 CCECAdapterMessage &operator =(const CCECAdapterMessage &msg);
58 CStdString ToString(void) const;
59 CStdString MessageCodeAsString(void) const;
60
61 bool empty(void) const { return packet.IsEmpty(); }
62 uint8_t operator[](uint8_t pos) const { return packet[pos]; }
63 uint8_t at(uint8_t pos) const { return packet[pos]; }
64 uint8_t size(void) const { return packet.size; }
65 void clear(void) { state = ADAPTER_MESSAGE_STATE_UNKNOWN; transmit_timeout = 0; packet.Clear(); maxTries = CEC_DEFAULT_TRANSMIT_RETRIES + 1; tries = 0; reply = MSGCODE_NOTHING; }
66 void shift(uint8_t iShiftBy) { packet.Shift(iShiftBy); }
67 void push_back(uint8_t add) { packet.PushBack(add); }
68 cec_adapter_messagecode message(void) const { return packet.size >= 1 ? (cec_adapter_messagecode) (packet.At(0) & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK)) : MSGCODE_NOTHING; }
69 bool eom(void) const { return packet.size >= 1 ? (packet.At(0) & MSGCODE_FRAME_EOM) != 0 : false; }
70 bool ack(void) const { return packet.size >= 1 ? (packet.At(0) & MSGCODE_FRAME_ACK) != 0 : false; }
71 cec_logical_address initiator(void) const { return packet.size >= 2 ? (cec_logical_address) (packet.At(1) >> 4) : CECDEVICE_UNKNOWN; };
72 cec_logical_address destination(void) const { return packet.size >= 2 ? (cec_logical_address) (packet.At(1) & 0xF) : CECDEVICE_UNKNOWN; };
73 bool is_error(void) const;
74 void push_escaped(uint8_t byte);
75 bool needs_retry(void) const { return reply == MSGCODE_NOTHING ||
76 reply == MSGCODE_RECEIVE_FAILED ||
77 reply == MSGCODE_TIMEOUT_ERROR ||
78 reply == MSGCODE_TRANSMIT_FAILED_LINE ||
79 reply == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
80 reply == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE ||
81 reply == MSGCODE_TRANSMIT_LINE_TIMEOUT; }
82
83 uint8_t maxTries;
84 uint8_t tries;
85 cec_adapter_messagecode reply;
86 cec_datapacket packet;
87 cec_adapter_message_state state;
88 int32_t transmit_timeout;
89 CMutex mutex;
90 CCondition condition;
91 };
92
93 class CSerialPort;
94 class CCECProcessor;
95
96 class CAdapterCommunication : private CThread
97 {
98 public:
99 CAdapterCommunication(CCECProcessor *processor);
100 virtual ~CAdapterCommunication();
101
102 bool Open(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
103 bool Read(CCECAdapterMessage &msg, uint32_t iTimeout = 1000);
104 bool Write(CCECAdapterMessage *data);
105 bool PingAdapter(void);
106 void Close(void);
107 bool IsOpen(void) const;
108 std::string GetError(void) const;
109
110 void *Process(void);
111
112 bool SetLineTimeout(uint8_t iTimeout);
113 bool StartBootloader(void);
114
115 private:
116 void SendMessageToAdapter(CCECAdapterMessage *msg);
117 void WriteNextCommand(void);
118 void AddData(uint8_t *data, uint8_t iLen);
119 bool ReadFromDevice(uint32_t iTimeout);
120
121 CSerialPort * m_port;
122 CCECProcessor * m_processor;
123 CecBuffer<uint8_t> m_inBuffer;
124 CecBuffer<CCECAdapterMessage *> m_outBuffer;
125 CMutex m_mutex;
126 CCondition m_rcvCondition;
127 CCondition m_startCondition;
128 uint8_t m_iLineTimeout;
129 };
130};