Commit | Line | Data |
---|---|---|
ef7696f5 LOK |
1 | #pragma once |
2 | /* | |
3 | * This file is part of the libCEC(R) library. | |
4 | * | |
b492c10e | 5 | * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved. |
ef7696f5 LOK |
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 | ||
2b44051c | 34 | #include "lib/adapter/AdapterCommunication.h" |
ba65909d | 35 | |
ef7696f5 LOK |
36 | namespace CEC |
37 | { | |
cb8feb41 LOK |
38 | typedef enum cec_adapter_messagecode |
39 | { | |
40 | MSGCODE_NOTHING = 0, | |
41 | MSGCODE_PING, | |
42 | MSGCODE_TIMEOUT_ERROR, | |
43 | MSGCODE_HIGH_ERROR, | |
44 | MSGCODE_LOW_ERROR, | |
45 | MSGCODE_FRAME_START, | |
46 | MSGCODE_FRAME_DATA, | |
47 | MSGCODE_RECEIVE_FAILED, | |
48 | MSGCODE_COMMAND_ACCEPTED, | |
49 | MSGCODE_COMMAND_REJECTED, | |
50 | MSGCODE_SET_ACK_MASK, | |
51 | MSGCODE_TRANSMIT, | |
52 | MSGCODE_TRANSMIT_EOM, | |
53 | MSGCODE_TRANSMIT_IDLETIME, | |
54 | MSGCODE_TRANSMIT_ACK_POLARITY, | |
55 | MSGCODE_TRANSMIT_LINE_TIMEOUT, | |
56 | MSGCODE_TRANSMIT_SUCCEEDED, | |
57 | MSGCODE_TRANSMIT_FAILED_LINE, | |
58 | MSGCODE_TRANSMIT_FAILED_ACK, | |
59 | MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA, | |
60 | MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE, | |
61 | MSGCODE_FIRMWARE_VERSION, | |
62 | MSGCODE_START_BOOTLOADER, | |
63 | MSGCODE_GET_BUILDDATE, | |
64 | MSGCODE_SET_CONTROLLED, | |
65 | MSGCODE_GET_AUTO_ENABLED, | |
66 | MSGCODE_SET_AUTO_ENABLED, | |
67 | MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS, | |
68 | MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS, | |
69 | MSGCODE_GET_LOGICAL_ADDRESS_MASK, | |
70 | MSGCODE_SET_LOGICAL_ADDRESS_MASK, | |
71 | MSGCODE_GET_PHYSICAL_ADDRESS, | |
72 | MSGCODE_SET_PHYSICAL_ADDRESS, | |
73 | MSGCODE_GET_DEVICE_TYPE, | |
74 | MSGCODE_SET_DEVICE_TYPE, | |
75 | MSGCODE_GET_HDMI_VERSION, | |
76 | MSGCODE_SET_HDMI_VERSION, | |
77 | MSGCODE_GET_OSD_NAME, | |
78 | MSGCODE_SET_OSD_NAME, | |
79 | MSGCODE_WRITE_EEPROM, | |
80 | MSGCODE_FRAME_EOM = 0x80, | |
81 | MSGCODE_FRAME_ACK = 0x40, | |
82 | } cec_adapter_messagecode; | |
83 | ||
ef7696f5 LOK |
84 | class CCECAdapterMessage |
85 | { | |
86 | public: | |
a75e3a5a LOK |
87 | /*! |
88 | * @brief Create an empty message. | |
89 | */ | |
90 | CCECAdapterMessage(void); | |
91 | ||
92 | /*! | |
93 | * @brief Create a message with a command that is to be transmitted over the CEC line. | |
94 | * @param command The command to transmit. | |
33dd87a9 | 95 | * @param iLineTimeout The line timeout to use when sending this message. |
a75e3a5a | 96 | */ |
33dd87a9 | 97 | CCECAdapterMessage(const cec_command &command, uint8_t iLineTimeout = 3); |
a75e3a5a LOK |
98 | |
99 | /*! | |
100 | * @return the message as human readable string. | |
101 | */ | |
2b44051c | 102 | std::string ToString(void) const; |
a75e3a5a LOK |
103 | |
104 | /*! | |
105 | * @brief Translate the messagecode into a human readable string. | |
106 | * @param msgCode The messagecode to translate. | |
107 | * @return The messagecode as string. | |
108 | */ | |
109 | static const char *ToString(cec_adapter_messagecode msgCode); | |
110 | ||
111 | /*! | |
112 | * @brief Get the byte at the given position. | |
113 | * @param pos The position to get. | |
114 | * @return The requested byte, or 0 when it's out of range. | |
115 | */ | |
116 | uint8_t At(uint8_t pos) const; | |
117 | uint8_t operator[](uint8_t pos) const; | |
118 | ||
119 | /*! | |
120 | * @return The size of the packet in bytes. | |
121 | */ | |
122 | uint8_t Size(void) const; | |
123 | ||
124 | /*! | |
125 | * @return True when empty, false otherwise. | |
126 | */ | |
127 | bool IsEmpty(void) const; | |
128 | ||
129 | /*! | |
130 | * @brief Clear this message and reset everything to the initial values. | |
131 | */ | |
132 | void Clear(void); | |
133 | ||
134 | /*! | |
135 | * @brief Shift the message by the given number of bytes. | |
136 | * @param iShiftBy The number of bytes to shift. | |
137 | */ | |
138 | void Shift(uint8_t iShiftBy); | |
139 | ||
140 | /*! | |
141 | * @brief Append the given message to this message. | |
142 | * @param data The message to append. | |
143 | */ | |
144 | void Append(CCECAdapterMessage &data); | |
145 | ||
146 | /*! | |
147 | * @brief Append the given datapacket to this message. | |
148 | * @param data The packet to add. | |
149 | */ | |
150 | void Append(cec_datapacket &data); | |
151 | ||
152 | /*! | |
153 | * @brief Adds a byte to this message. Does not escape the byte. | |
154 | * @param byte The byte to add. | |
155 | */ | |
156 | void PushBack(uint8_t byte); | |
157 | ||
158 | /*! | |
159 | * @brief Adds a byte to this message and escapes the byte if needed. | |
160 | * @param byte The byte to add. | |
161 | */ | |
162 | void PushEscaped(uint8_t byte); | |
163 | ||
164 | /*! | |
165 | * @brief Adds a byte to this message. | |
166 | * @param byte The byte to add. | |
167 | * @return True when a full message was received, false otherwise. | |
168 | */ | |
169 | bool PushReceivedByte(uint8_t byte); | |
170 | ||
171 | /*! | |
172 | * @return The messagecode inside this adapter message, or MSGCODE_NOTHING if there is none. | |
173 | */ | |
174 | cec_adapter_messagecode Message(void) const; | |
175 | ||
3ead056c LOK |
176 | /*! |
177 | * @return The messagecode (if provided) that this message is responding to | |
178 | */ | |
179 | cec_adapter_messagecode ResponseTo(void) const; | |
180 | ||
a75e3a5a LOK |
181 | /*! |
182 | * @return True when this message is a transmission, false otherwise. | |
183 | */ | |
184 | bool IsTranmission(void) const; | |
185 | ||
186 | /*! | |
187 | * @return True when the EOM bit is set, false otherwise. | |
188 | */ | |
189 | bool IsEOM(void) const; | |
190 | ||
191 | /*! | |
192 | * @return True when the ACK bit is set, false otherwise. | |
193 | */ | |
194 | bool IsACK(void) const; | |
195 | ||
196 | /*! | |
197 | * @return True when this message has been replied with an error code, false otherwise. | |
198 | */ | |
199 | bool IsError(void) const; | |
200 | ||
201 | /*! | |
202 | * @return True when this message has been replied with an error code and needs to be retried, false otherwise. | |
203 | */ | |
204 | bool NeedsRetry(void) const; | |
205 | ||
206 | /*! | |
207 | * @return The logical address of the initiator, or CECDEVICE_UNKNOWN if unknown. | |
208 | */ | |
209 | cec_logical_address Initiator(void) const; | |
210 | ||
211 | /*! | |
212 | * @return The logical address of the destination, or CECDEVICE_UNKNOWN if unknown. | |
213 | */ | |
214 | cec_logical_address Destination(void) const; | |
215 | ||
216 | /*! | |
217 | * @return True when this message contains a start message, false otherwise. | |
218 | */ | |
219 | bool HasStartMessage(void) const; | |
220 | ||
221 | /*! | |
222 | * @brief Push this adapter message to the end of the given cec_command. | |
223 | * @param command The command to push this message to. | |
224 | * @return True when a full CEC message was received, false otherwise. | |
225 | */ | |
226 | bool PushToCecCommand(cec_command &command) const; | |
227 | ||
228 | /*! | |
229 | * @return The response messagecode. | |
230 | */ | |
231 | cec_adapter_messagecode Reply(void) const; | |
232 | ||
233 | uint8_t maxTries; /**< the maximum number of times to try to send this message */ | |
a75e3a5a LOK |
234 | cec_datapacket response; /**< the response to this message */ |
235 | cec_datapacket packet; /**< the actual data */ | |
236 | cec_adapter_message_state state; /**< the current state of this message */ | |
237 | int32_t transmit_timeout; /**< the timeout to use when sending this message */ | |
238 | uint8_t lineTimeout; /**< the default CEC line timeout to use when sending this message */ | |
a75e3a5a LOK |
239 | |
240 | private: | |
241 | bool bNextByteIsEscaped; /**< true when the next byte that is added will be escaped, false otherwise */ | |
ef7696f5 LOK |
242 | }; |
243 | } |