src/lib/adapter/USBCECAdapterMessage.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011-2012 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 "../platform/util/StdString.h"
  35
  36 namespace CEC
  37 {
  38   class CCECAdapterMessage
  39   {
  40   public:
  41     CCECAdapterMessage(void) :
  42         event(false)
  43     {
  44       Clear();
  45     }
  46
  47     CCECAdapterMessage(const cec_command &command)
  48     {
  49       Clear();
  50
  51       //set ack polarity to high when transmitting to the broadcast address
  52       //set ack polarity low when transmitting to any other address
  53       PushBack(MSGSTART);
  54       PushEscaped(MSGCODE_TRANSMIT_ACK_POLARITY);
  55       if (command.destination == CECDEVICE_BROADCAST)
  56         PushEscaped(CEC_TRUE);
  57       else
  58         PushEscaped(CEC_FALSE);
  59       PushBack(MSGEND);
  60
  61       // add source and destination
  62       PushBack(MSGSTART);
  63       PushEscaped(command.opcode_set == 0 ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
  64       PushBack(((uint8_t)command.initiator << 4) + (uint8_t)command.destination);
  65       PushBack(MSGEND);
  66
  67       // add opcode
  68       if (command.opcode_set == 1)
  69       {
  70         PushBack(MSGSTART);
  71         PushEscaped(command.parameters.IsEmpty() ? (uint8_t)MSGCODE_TRANSMIT_EOM : (uint8_t)MSGCODE_TRANSMIT);
  72         PushBack((uint8_t) command.opcode);
  73         PushBack(MSGEND);
  74
  75         // add parameters
  76         for (int8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
  77         {
  78           PushBack(MSGSTART);
  79
  80           if (iPtr == command.parameters.size - 1)
  81             PushEscaped( MSGCODE_TRANSMIT_EOM);
  82           else
  83             PushEscaped(MSGCODE_TRANSMIT);
  84
  85           PushEscaped(command.parameters[iPtr]);
  86
  87           PushBack(MSGEND);
  88         }
  89       }
  90
  91       // set timeout
  92       transmit_timeout = command.transmit_timeout;
  93       //TODO
  94     }
  95
  96     CCECAdapterMessage &operator=(const CCECAdapterMessage &msg)
  97     {
  98       packet = msg.packet;
  99       state  = msg.state;
 100       return *this;
 101     }
 102
 103     CStdString ToString(void) const
 104     {
 105       CStdString strMsg;
 106       if (Size() == 0)
 107       {
 108         strMsg = "empty message";
 109       }
 110       else
 111       {
 112         strMsg = MessageCodeAsString();
 113
 114         switch (Message())
 115         {
 116         case MSGCODE_TIMEOUT_ERROR:
 117         case MSGCODE_HIGH_ERROR:
 118         case MSGCODE_LOW_ERROR:
 119           {
 120             uint32_t iLine = (Size() >= 3) ? (At(1) << 8) | At(2) : 0;
 121             uint32_t iTime = (Size() >= 7) ? (At(3) << 24) | (At(4) << 16) | (At(5) << 8) | At(6) : 0;
 122             strMsg.AppendFormat(" line:%u", iLine);
 123             strMsg.AppendFormat(" time:%u", iTime);
 124           }
 125           break;
 126         case MSGCODE_FRAME_START:
 127           if (Size() >= 2)
 128             strMsg.AppendFormat(" initiator:%1x destination:%1x ack:%s %s", Initiator(), Destination(), IsACK() ? "high" : "low", IsEOM() ? "eom" : "");
 129           break;
 130         case MSGCODE_FRAME_DATA:
 131           if (Size() >= 2)
 132             strMsg.AppendFormat(" %02x %s", At(1), IsEOM() ? "eom" : "");
 133           break;
 134         default:
 135           break;
 136         }
 137       }
 138
 139       return strMsg;
 140     }
 141
 142     CStdString MessageCodeAsString(void) const
 143     {
 144       CStdString strMsg;
 145       switch (Message())
 146       {
 147       case MSGCODE_NOTHING:
 148         strMsg = "NOTHING";
 149         break;
 150       case MSGCODE_PING:
 151         strMsg = "PING";
 152         break;
 153       case MSGCODE_TIMEOUT_ERROR:
 154         strMsg = "TIMEOUT";
 155         break;
 156       case MSGCODE_HIGH_ERROR:
 157         strMsg = "HIGH_ERROR";
 158         break;
 159       case MSGCODE_LOW_ERROR:
 160         strMsg = "LOW_ERROR";
 161         break;
 162       case MSGCODE_FRAME_START:
 163         strMsg = "FRAME_START";
 164         break;
 165       case MSGCODE_FRAME_DATA:
 166         strMsg = "FRAME_DATA";
 167         break;
 168       case MSGCODE_RECEIVE_FAILED:
 169         strMsg = "RECEIVE_FAILED";
 170         break;
 171       case MSGCODE_COMMAND_ACCEPTED:
 172         strMsg = "COMMAND_ACCEPTED";
 173         break;
 174       case MSGCODE_COMMAND_REJECTED:
 175         strMsg = "COMMAND_REJECTED";
 176         break;
 177       case MSGCODE_SET_ACK_MASK:
 178         strMsg = "SET_ACK_MASK";
 179         break;
 180       case MSGCODE_TRANSMIT:
 181         strMsg = "TRANSMIT";
 182         break;
 183       case MSGCODE_TRANSMIT_EOM:
 184         strMsg = "TRANSMIT_EOM";
 185         break;
 186       case MSGCODE_TRANSMIT_IDLETIME:
 187         strMsg = "TRANSMIT_IDLETIME";
 188         break;
 189       case MSGCODE_TRANSMIT_ACK_POLARITY:
 190         strMsg = "TRANSMIT_ACK_POLARITY";
 191         break;
 192       case MSGCODE_TRANSMIT_LINE_TIMEOUT:
 193         strMsg = "TRANSMIT_LINE_TIMEOUT";
 194         break;
 195       case MSGCODE_TRANSMIT_SUCCEEDED:
 196         strMsg = "TRANSMIT_SUCCEEDED";
 197         break;
 198       case MSGCODE_TRANSMIT_FAILED_LINE:
 199         strMsg = "TRANSMIT_FAILED_LINE";
 200         break;
 201       case MSGCODE_TRANSMIT_FAILED_ACK:
 202         strMsg = "TRANSMIT_FAILED_ACK";
 203         break;
 204       case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
 205         strMsg = "TRANSMIT_FAILED_TIMEOUT_DATA";
 206         break;
 207       case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
 208         strMsg = "TRANSMIT_FAILED_TIMEOUT_LINE";
 209         break;
 210       case MSGCODE_FIRMWARE_VERSION:
 211         strMsg = "FIRMWARE_VERSION";
 212         break;
 213       case MSGCODE_START_BOOTLOADER:
 214         strMsg = "START_BOOTLOADER";
 215         break;
 216       case MSGCODE_FRAME_EOM:
 217         strMsg = "FRAME_EOM";
 218         break;
 219       case MSGCODE_FRAME_ACK:
 220         strMsg = "FRAME_ACK";
 221         break;
 222       case MSGCODE_SET_POWERSTATE:
 223         strMsg = "SET_POWERSTATE";
 224         break;
 225       case MSGCODE_SET_CONTROLLED:
 226         strMsg = "SET_CONTROLLED";
 227         break;
 228       }
 229
 230       return strMsg;
 231     }
 232
 233     uint8_t operator[](uint8_t pos) const
 234     {
 235       return packet[pos];
 236     }
 237
 238     uint8_t At(uint8_t pos) const
 239     {
 240       return packet[pos];
 241     }
 242
 243     uint8_t Size(void) const
 244     {
 245       return packet.size;
 246     }
 247
 248     bool IsEmpty(void) const
 249     {
 250       return packet.IsEmpty();
 251     }
 252
 253     void Clear(void)
 254     {
 255       state               = ADAPTER_MESSAGE_STATE_UNKNOWN;
 256       transmit_timeout    = CEC_DEFAULT_TRANSMIT_TIMEOUT;
 257       packet.Clear();
 258       maxTries            = CEC_DEFAULT_TRANSMIT_RETRIES + 1;
 259       tries               = 0;
 260       reply               = MSGCODE_NOTHING;
 261       isTransmission      = true;
 262       expectControllerAck = true;
 263       lineTimeout         = 3;
 264       retryTimeout        = 3;
 265     }
 266
 267     void Shift(uint8_t iShiftBy)
 268     {
 269       packet.Shift(iShiftBy);
 270     }
 271
 272     void PushBack(uint8_t add)
 273     {
 274       packet.PushBack(add);
 275     }
 276
 277     void PushEscaped(uint8_t byte)
 278     {
 279       if (byte >= MSGESC)
 280       {
 281         PushBack(MSGESC);
 282         PushBack(byte - ESCOFFSET);
 283       }
 284       else
 285       {
 286         PushBack(byte);
 287       }
 288     }
 289
 290     cec_adapter_messagecode Message(void) const
 291     {
 292       return packet.size >= 1 ?
 293           (cec_adapter_messagecode) (packet.At(0) & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK)) :
 294           MSGCODE_NOTHING;
 295     }
 296
 297     bool IsEOM(void) const
 298     {
 299       return packet.size >= 1 ?
 300           (packet.At(0) & MSGCODE_FRAME_EOM) != 0 :
 301           false;
 302     }
 303
 304     bool IsACK(void) const
 305     {
 306       return packet.size >= 1 ?
 307           (packet.At(0) & MSGCODE_FRAME_ACK) != 0 :
 308           false;
 309     }
 310
 311     bool IsError(void) const
 312     {
 313       cec_adapter_messagecode code = Message();
 314       return (code == MSGCODE_HIGH_ERROR ||
 315               code == MSGCODE_LOW_ERROR ||
 316               code == MSGCODE_RECEIVE_FAILED ||
 317               code == MSGCODE_COMMAND_REJECTED ||
 318               code == MSGCODE_TRANSMIT_LINE_TIMEOUT ||
 319               code == MSGCODE_TRANSMIT_FAILED_LINE ||
 320               code == MSGCODE_TRANSMIT_FAILED_ACK ||
 321               code == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
 322               code == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE);
 323     }
 324
 325     bool NeedsRetry(void) const
 326     {
 327       return reply == MSGCODE_NOTHING ||
 328              reply == MSGCODE_RECEIVE_FAILED ||
 329              reply == MSGCODE_TIMEOUT_ERROR ||
 330              reply == MSGCODE_TRANSMIT_FAILED_LINE ||
 331              reply == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
 332              reply == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE ||
 333              reply == MSGCODE_TRANSMIT_LINE_TIMEOUT;
 334     }
 335
 336     cec_logical_address Initiator(void) const
 337     {
 338       return packet.size >= 2 ?
 339           (cec_logical_address) (packet.At(1) >> 4) :
 340           CECDEVICE_UNKNOWN;
 341     }
 342
 343     cec_logical_address Destination(void) const
 344     {
 345       return packet.size >= 2 ?
 346           (cec_logical_address) (packet.At(1) & 0xF) :
 347           CECDEVICE_UNKNOWN;
 348     }
 349
 350     uint8_t                               maxTries;
 351     uint8_t                               tries;
 352     cec_adapter_messagecode               reply;
 353     cec_datapacket                        packet;
 354     cec_adapter_message_state             state;
 355     int32_t                               transmit_timeout;
 356     bool                                  isTransmission;
 357     bool                                  expectControllerAck;
 358     uint8_t                               lineTimeout;
 359     uint8_t                               retryTimeout;
 360     PLATFORM::CEvent                      event;
 361   };
 362 }