ProtocolIPbus.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_ProtocolIPbus_hpp_
#define _uhal_ProtocolIPbus_hpp_


#include <deque>
#include <iosfwd>
#include <stdint.h>
#include <string>
#include <utility>

#include <boost/function.hpp>                    // for function
#include <boost/thread/mutex.hpp>                // for mutex

#include "uhal/log/exception.hpp"
#include "uhal/ClientInterface.hpp"              // for PacketLevelError
#include "uhal/ProtocolIPbusCore.hpp"


// Forward declarations
namespace boost { template <class Y> class shared_ptr; }


namespace uhal
{
  class Buffers;
  struct URI;


  template< uint8_t IPbus_major , uint8_t IPbus_minor >
  class IPbus;


  template< uint8_t IPbus_minor >
  class IPbus < 1 , IPbus_minor > : public IPbusCore
  {

    public:
      IPbus ( const std::string& aId, const URI& aUri );

      virtual ~IPbus();

    protected:
      virtual void preamble ( boost::shared_ptr< Buffers > aBuffers );

      virtual uint32_t getPreambleSize();

      virtual void predispatch ( boost::shared_ptr< Buffers > aBuffers );

    public:
      static uint32_t CalculateHeader ( const eIPbusTransactionType& aType , const uint32_t& aWordCount , const uint32_t& aTransactionId , const uint8_t& aInfoCode = 0 );

      static uint32_t ExpectedHeader ( const eIPbusTransactionType& aType , const uint32_t& aWordCount , const uint32_t& aTransactionId , const uint8_t& aInfoCode = 0 );

      static bool ExtractHeader ( const uint32_t& aHeader , eIPbusTransactionType& aType , uint32_t& aWordCount , uint32_t& aTransactionId , uint8_t& aInfoCode );


    protected:

      uint32_t implementCalculateHeader ( const eIPbusTransactionType& aType , const uint32_t& aWordCount , const uint32_t& aTransactionId , const uint8_t& aInfoCode );

      bool implementExtractHeader ( const uint32_t& aHeader , eIPbusTransactionType& aType , uint32_t& aWordCount , uint32_t& aTransactionId , uint8_t& aInfoCode );

      uint8_t requestTransactionInfoCode () const
      {
        return 0;
      }

      uint32_t getMaxTransactionWordCount() const
      {
        return 0x1ff;
      }

      virtual uint32_t getMaxNumberOfBuffers()
      {
        return 1;
      }

      virtual void dispatchExceptionHandler();

  private:
      boost::function<void (std::ostream&, const uint8_t&)> getInfoCodeTranslator() { return translateInfoCode; }

      static void translateInfoCode(std::ostream& aStream, const uint8_t& aErrorCode);
      // std::vector< uint32_t > mSendPadding;
      // std::vector< uint32_t > mReplyPadding;

  };



  namespace exception
  {
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( IPbus2PacketHeaderMismatch, PacketLevelError, "Exception class to handle the case where the IPbus 2.0 packet header does not match that sent." )
  }


  template< uint8_t IPbus_minor >
  class IPbus < 2 , IPbus_minor > : public IPbusCore
  {

    public:
      IPbus ( const std::string& aId, const URI& aUri );

      virtual ~IPbus();

    protected:
      virtual void preamble ( boost::shared_ptr< Buffers > aBuffers );

      virtual uint32_t getPreambleSize();

      virtual void predispatch ( boost::shared_ptr< Buffers > aBuffers );

    public:
      static uint32_t CalculateHeader ( const eIPbusTransactionType& aType , const uint32_t& aWordCount , const uint32_t& aTransactionId , const uint8_t& aInfoCode = 0 );

      static uint32_t ExpectedHeader ( const eIPbusTransactionType& aType , const uint32_t& aWordCount , const uint32_t& aTransactionId , const uint8_t& aInfoCode = 0 );

      static bool ExtractHeader ( const uint32_t& aHeader , eIPbusTransactionType& aType , uint32_t& aWordCount , uint32_t& aTransactionId , uint8_t& aInfoCode );



    protected:

      virtual  exception::exception* validate ( uint8_t* aSendBufferStart ,
          uint8_t* aSendBufferEnd ,
          std::deque< std::pair< uint8_t* , uint32_t > >::iterator aReplyStartIt ,
          std::deque< std::pair< uint8_t* , uint32_t > >::iterator aReplyEndIt );

      uint32_t implementCalculateHeader ( const eIPbusTransactionType& aType , const uint32_t& aWordCount , const uint32_t& aTransactionId , const uint8_t& aInfoCode );

      bool implementExtractHeader ( const uint32_t& aHeader , eIPbusTransactionType& aType , uint32_t& aWordCount , uint32_t& aTransactionId , uint8_t& aInfoCode );

      uint8_t requestTransactionInfoCode () const
      {
        return 0xF;
      }

      uint32_t getMaxTransactionWordCount() const
      {
        return 0xff;
      }

      virtual uint32_t getMaxNumberOfBuffers()
      {
        return 16;
      }

      virtual void dispatchExceptionHandler();

    private:
      boost::function<void (std::ostream&, const uint8_t&)> getInfoCodeTranslator() { return translateInfoCode; }

      static void translateInfoCode(std::ostream& aStream, const uint8_t& aErrorCode);

      uint16_t mPacketCounter;

      boost::mutex mReceivePacketMutex;
      std::deque< uint32_t > mReceivePacketHeader;

  };


}


#endif