updated copyright messages for 2013

[deb_libcec.git] / src / lib / adapter / Pulse-Eight / USBCECAdapterMessage.h

diff --git a/src/lib/adapter/Pulse-Eight/USBCECAdapterMessage.h b/src/lib/adapter/Pulse-Eight/USBCECAdapterMessage.h
index e4fedce028cde4d1f93c05e52e76c4ff7266e124..b862fea5d116f84e828e13f71c89d715dcf53bea 100644 (file)
--- a/src/lib/adapter/Pulse-Eight/USBCECAdapterMessage.h
+++ b/src/lib/adapter/Pulse-Eight/USBCECAdapterMessage.h
@@ -2,7 +2,7 @@
 /*
  * This file is part of the libCEC(R) library.
  *
- * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
+ * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited.  All rights reserved.
  * libCEC(R) is an original work, containing original code.
  *
  * libCEC(R) is a trademark of Pulse-Eight Limited.
@@ -35,6 +35,62 @@
 
 namespace CEC
 {
+  typedef enum cec_adapter_messagecode
+  {
+    MSGCODE_NOTHING = 0,
+    MSGCODE_PING,
+    MSGCODE_TIMEOUT_ERROR,
+    MSGCODE_HIGH_ERROR,
+    MSGCODE_LOW_ERROR,
+    MSGCODE_FRAME_START,
+    MSGCODE_FRAME_DATA,
+    MSGCODE_RECEIVE_FAILED,
+    MSGCODE_COMMAND_ACCEPTED,
+    MSGCODE_COMMAND_REJECTED,
+    MSGCODE_SET_ACK_MASK,
+    MSGCODE_TRANSMIT,
+    MSGCODE_TRANSMIT_EOM,
+    MSGCODE_TRANSMIT_IDLETIME,
+    MSGCODE_TRANSMIT_ACK_POLARITY,
+    MSGCODE_TRANSMIT_LINE_TIMEOUT,
+    MSGCODE_TRANSMIT_SUCCEEDED,
+    MSGCODE_TRANSMIT_FAILED_LINE,
+    MSGCODE_TRANSMIT_FAILED_ACK,
+    MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA,
+    MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
+    MSGCODE_FIRMWARE_VERSION,
+    MSGCODE_START_BOOTLOADER,
+    MSGCODE_GET_BUILDDATE,
+    MSGCODE_SET_CONTROLLED,
+    MSGCODE_GET_AUTO_ENABLED,
+    MSGCODE_SET_AUTO_ENABLED,
+    MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS,
+    MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS,
+    MSGCODE_GET_LOGICAL_ADDRESS_MASK,
+    MSGCODE_SET_LOGICAL_ADDRESS_MASK,
+    MSGCODE_GET_PHYSICAL_ADDRESS,
+    MSGCODE_SET_PHYSICAL_ADDRESS,
+    MSGCODE_GET_DEVICE_TYPE,
+    MSGCODE_SET_DEVICE_TYPE,
+    MSGCODE_GET_HDMI_VERSION,
+    MSGCODE_SET_HDMI_VERSION,
+    MSGCODE_GET_OSD_NAME,
+    MSGCODE_SET_OSD_NAME,
+    MSGCODE_WRITE_EEPROM,
+    MSGCODE_GET_ADAPTER_TYPE,
+    MSGCODE_SET_ACTIVE_SOURCE,
+
+    MSGCODE_FRAME_EOM = 0x80,
+    MSGCODE_FRAME_ACK = 0x40,
+  } cec_adapter_messagecode;
+
+  typedef enum p8_cec_adapter_type
+  {
+    P8_ADAPTERTYPE_UNKNOWN = 0,
+    P8_ADAPTERTYPE_EXTERNAL,
+    P8_ADAPTERTYPE_DAUGHTERBOARD,
+  } p8_cec_adapter_type;
+
   class CCECAdapterMessage
   {
   public:
@@ -127,6 +183,11 @@ namespace CEC
      */
     cec_adapter_messagecode Message(void) const;
 
+    /*!
+     * @return The messagecode (if provided) that this message is responding to
+     */
+    cec_adapter_messagecode ResponseTo(void) const;
+
     /*!
      * @return True when this message is a transmission, false otherwise.
      */
@@ -143,10 +204,22 @@ namespace CEC
     bool IsACK(void) const;
 
     /*!
-     * @return True when this message has been replied with an error code, false otherwise.
+     * @brief Checks whether the given messagecode is an error message.
+     * @param code The code to check.
+     * @return True when it's an error, false otherwise.
+     */
+    static bool MessageCodeIsError(const cec_adapter_messagecode code);
+
+    /*!
+     * @return True when this message contains an error code, false otherwise.
      */
     bool IsError(void) const;
 
+    /*!
+     * @return True when this message has been replied with an error code, false otherwise.
+     */
+    bool ReplyIsError(void) const;
+
     /*!
      * @return True when this message has been replied with an error code and needs to be retried, false otherwise.
      */
@@ -179,12 +252,12 @@ namespace CEC
      */
     cec_adapter_messagecode Reply(void) const;
 
-    uint8_t                               maxTries;             /**< the maximum number of times to try to send this message */
     cec_datapacket                        response;             /**< the response to this message */
     cec_datapacket                        packet;               /**< the actual data */
     cec_adapter_message_state             state;                /**< the current state of this message */
     int32_t                               transmit_timeout;     /**< the timeout to use when sending this message */
     uint8_t                               lineTimeout;          /**< the default CEC line timeout to use when sending this message */
+    bool                                  bFireAndForget;       /**< true to auto delete, don't wait for a response */
 
   private:
     bool                                  bNextByteIsEscaped;   /**< true when the next byte that is added will be escaped, false otherwise */