converter/nexus/NxMessageDecoder.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 NXMESSAGEDECODER_H
  24 #define NXMESSAGEDECODER_H
  25
  26 #include <inttypes.h>
  27
  28 class NxMessage;
  29 class AUXMessageProtocol;
  30 class NxPacketDecoder;
  31 class NxPacketSet;
  32
  33 // The NxMessageDecoder is responsible for accepting MDO/MSEO data beats
  34 // and determining when a NXMessage can be decoded from the data.
  35 // The NXMessage returned will contain all the appropriate data for the type of
  36 // Nexus message.
  37 //
  38 class NxMessageDecoder
  39 {
  40 public:
  41
  42         NxMessageDecoder();
  43         ~NxMessageDecoder();
  44
  45         // input data - the MDO/MSEO for each data beat
  46         // output msg - pointer will be set if NxMessage is available
  47         // return true if no error
  48         bool accept(uint32_t data, NxMessage* &msg);
  49
  50         // set the verbosity
  51         void verbose(bool verbose);
  52
  53 private:
  54
  55         bool verbose_;
  56
  57         // delegate for handling MSE data
  58         AUXMessageProtocol *protocol_;
  59
  60         // delegate to decode the packets into a NxMessage
  61         NxPacketDecoder *packet_decoder_;
  62
  63         // a container for the packet data
  64         NxPacketSet *packet_set_;
  65
  66 };
  67
  68 #endif // NXMESSAGEDECODER_H