converter/nexus/NxPacketDecoder.h

   1 /*
   2  * Copyright (C) 2013 Freescale Semiconductor, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included
  12  * in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20  * IN THE SOFTWARE.
  21  */
  22
  23 #ifndef NXPACKETDECODER_H
  24 #define NXPACKETDECODER_H
  25
  26 #include "NxPacketSet.h"
  27 #include "NxMessage.h"
  28
  29 // The NxPacketDecoder is responsible for decoding packets into the
  30 // correct NXMessage based on the TCODE contained in the packet.
  31 // The NXMessage returned will contain all the appropriate fields for the type of
  32 // Nexus message.
  33 //
  34 class NxPacketDecoder
  35 {
  36 public:
  37
  38         NxPacketDecoder() :
  39                 verbose_(false)
  40         {
  41         }
  42         ~NxPacketDecoder()
  43         {
  44         }
  45         ;
  46
  47         // decode the packet set into a NxMessage
  48         bool decode(NxPacketSet &pkt_set, NxMessage* &msg);
  49
  50         // set the verbosity
  51         void verbose(bool verbose)
  52         {
  53                 verbose_ = verbose;
  54         }
  55
  56 private:
  57
  58         // further decode packet set by source id into a specific NxInCircuitTraceMessage
  59         void decodeICT_(uint32_t tcode, uint32_t source_id, NxMessage* &msg);
  60
  61         bool verbose_;
  62
  63 };
  64
  65 #endif // NXPACKETDECODER_H