ProtocolPCIe.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

      Tom Williams, Rutherford Appleton Laboratory, Oxfordshire
      email: tom.williams <AT> cern.ch

---------------------------------------------------------------------------
*/

#ifndef _uhal_ProtocolPCIe_hpp_
#define _uhal_ProtocolPCIe_hpp_

#include <deque>                           // for deque
#include <stddef.h>                        // for size_t
#include <stdint.h>                        // for uint32_t, uint8_t
#include <string>                          // for string
#include <utility>                         // for pair
#include <vector>                          // for vector

#include <boost/chrono/system_clocks.hpp>  // for steady_clock
#include <boost/function.hpp>              // for function

#include "uhal/ClientInterface.hpp"
#include "uhal/log/exception.hpp"
#include "uhal/ProtocolIPbus.hpp"


namespace boost
{
  template <class Y> class shared_ptr;
}

namespace uhal
{
  class Buffers;
  struct URI;

  namespace exception
  {
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( PCIeTimeout , ClientTimeout , "Exception class to handle the case in which the PCIe connection timed out." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( PCIeInitialisationError , TransportLayerError , "Exception class to handle a failure to read from the specified device files during initialisation." )
    UHAL_DEFINE_DERIVED_EXCEPTION_CLASS ( PCIeCommunicationError , TransportLayerError , "Exception class to handle a low-level seek/read/write error after initialisation." )
  }

  class PCIe : public IPbus< 2 , 0 >
  {
    public:
      class PacketFmt {
      public:
        PacketFmt(const uint8_t* const, const size_t);
        PacketFmt(const std::vector< std::pair<const uint8_t*, size_t> >& aData);
        ~PacketFmt();

        const std::vector< std::pair<const uint8_t*, size_t> > mData;
      };

    // private:
      class File {
      public:
        File(const std::string& aPath, int aFlags);
        ~File();

        const std::string& getPath() const;
        void setPath(const std::string& aPath);

        void open();
        void close();

        void createBuffer(const size_t aNrBytes);

        void read(const uint32_t aAddr, const uint32_t aNrWords, std::vector<uint32_t>& aValues);

        void write(const uint32_t aAddr, const std::vector<uint32_t>& aValues);

        void write(const uint32_t aAddr, const uint8_t* const aPtr, const size_t aNrBytes);

        void write(const uint32_t aAddr, const std::vector<std::pair<const uint8_t*, size_t> >& aData);

      private:
        std::string mPath;
        int mFd;
        int mFlags;
        size_t mBufferSize;
        char* mBuffer;
      };

      PCIe ( const PCIe& aPCIe );

      PCIe& operator= ( const PCIe& aPCIe );

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

      virtual ~PCIe();

    private:

      void implementDispatch ( boost::shared_ptr< Buffers > aBuffers );

      virtual void Flush( );


      virtual void dispatchExceptionHandler();


      typedef IPbus< 2 , 0 > InnerProtocol;

      typedef boost::chrono::steady_clock SteadyClock_t;

      uint32_t getMaxSendSize();

      uint32_t getMaxReplySize();

      void connect();

      void disconnect();

      void write(const boost::shared_ptr<Buffers>& aBuffers);

      void read();

      bool mConnected;

      File mDeviceFileHostToFPGA;
      File mDeviceFileFPGAToHost;
      File mDeviceFileFPGAEvent;

      bool mXdma7seriesWorkaround;

      bool mUseInterrupt;

      boost::chrono::microseconds mSleepDuration;

      uint32_t mNumberOfPages, mMaxInFlight, mPageSize, mMaxPacketSize, mIndexNextPage, mPublishedReplyPageCount, mReadReplyPageCount;

      std::deque < boost::shared_ptr< Buffers > > mReplyQueue;

      uhal::exception::exception* mAsynchronousException;
  };

  std::ostream& operator<<(std::ostream& aStream, const PCIe::PacketFmt& aPacket);

}


#endif