IPbusInspector.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------
 
    This file is part of uHAL.
 
    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.
 
    uHAL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    uHAL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with uHAL.  If not, see <http://www.gnu.org/licenses/>.
 
 
      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk
 
      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch
 
---------------------------------------------------------------------------
*/
 
#ifndef _uhal_IPbusInspector_hpp_
#define _uhal_IPbusInspector_hpp_
 
 
#include <stdint.h>
#include <vector>
 
#include "uhal/ProtocolIPbusCore.hpp"
 
 
namespace uhal
{
 
  template< uint8_t IPbus_major , uint8_t IPbus_minor >
  class HostToTargetInspector
  {
    public:
      HostToTargetInspector( );
 
      virtual ~HostToTargetInspector( );
 
    protected:
      uint32_t mHeader;
      IPbusTransactionType mType;
      uint32_t mWordCounter;
      uint32_t mTransactionId;
      uint8_t mResponseGood;
 
      uint32_t mPacketHeader;
      uint32_t mPacketCounter;
      uint32_t mPacketType;
 
    public:
      bool analyze ( std::vector<uint32_t>::const_iterator& aIt , const std::vector<uint32_t>::const_iterator& aEnd , const bool& aContinueOnError = true );
 
    protected:
      virtual void bot();
 
      virtual void ni_read ( const uint32_t& aAddress );
 
      virtual void read ( const uint32_t& aAddress );
 
      virtual void readConfigurationSpace ( const uint32_t& aAddress );
 
      virtual void ni_write ( const uint32_t& aAddress , std::vector<uint32_t>::const_iterator& aIt , const std::vector<uint32_t>::const_iterator& aEnd );
 
      virtual void write ( const uint32_t& aAddress , std::vector<uint32_t>::const_iterator& aIt , const std::vector<uint32_t>::const_iterator& aEnd );
 
      virtual void rmw_sum ( const uint32_t& aAddress , const uint32_t& aAddend );
 
      virtual void rmw_bits ( const uint32_t& aAddress , const uint32_t& aAndTerm , const uint32_t& aOrTerm );
 
      virtual void unknown_type();
 
      virtual bool control_packet_header ();
 
      virtual void status_packet_header();
 
      virtual void resend_packet_header();
 
      virtual void unknown_packet_header();
  };
 
 
 
  template< uint8_t IPbus_major , uint8_t IPbus_minor >
  class TargetToHostInspector
  {
    public:
      TargetToHostInspector( );
      virtual ~TargetToHostInspector( );
 
    protected:
      uint32_t mHeader;
      IPbusTransactionType mType;
      uint32_t mWordCounter;
      uint32_t mTransactionId;
      uint8_t mResponseGood;
 
      uint32_t mPacketHeader;
      uint32_t mPacketCounter;
      uint32_t mPacketType;
 
    public:
 
      bool analyze ( std::vector<uint32_t>::const_iterator& aIt , const std::vector<uint32_t>::const_iterator& aEnd , const bool& aContinueOnError = true );
 
    protected:
      virtual void bot();
 
      virtual void ni_read ( std::vector<uint32_t>::const_iterator& aIt , const std::vector<uint32_t>::const_iterator& aEnd );
 
      virtual void read ( std::vector<uint32_t>::const_iterator& aIt , const std::vector<uint32_t>::const_iterator& aEnd );
 
      virtual void ni_write ( );
 
      virtual void write ( );
 
      virtual void rmw_sum ( const uint32_t& aNewValue );
 
      virtual void rmw_bits ( const uint32_t& aNewValue );
 
      virtual void unknown_type();
 
      virtual bool control_packet_header ();
 
      virtual void status_packet_header();
 
      virtual void unknown_packet_header();
  };
 
}
 
 
#endif