Separate BAR functionality from DMA Channels

Author: kostorr

CMakeLists.txt

@@ -200,9 +200,9 @@ add_subdirectory(doc)
 enable_testing()
 
 set(TEST_SRCS
-  test/TestBarAccessor.cxx
   test/TestChannelFactoryUtils.cxx
   test/TestChannelPaths.cxx
+  test/TestCruBar.cxx
   test/TestCruDataFormat.cxx
   test/TestEnums.cxx
   test/TestInterprocessLock.cxx

include/ReadoutCard/BarInterface.h

@@ -10,6 +10,7 @@
 #include "ReadoutCard/CardType.h"
 #include "ReadoutCard/RegisterReadWriteInterface.h"
 #include "ReadoutCard/Parameters.h"
+#include "boost/optional.hpp"
 
 namespace AliceO2 {
 namespace roc {
@@ -38,6 +39,15 @@ class BarInterface: public virtual RegisterReadWriteInterface
     /// Returns the type of the card
     /// \return The card type
     virtual CardType::type getCardType() = 0;
+
+    virtual boost::optional<int32_t> getSerial() = 0;
+
+    virtual boost::optional<float> getTemperature() = 0;
+
+    virtual boost::optional<std::string> getFirmwareInfo() = 0;
+
+    virtual boost::optional<std::string> getCardId() = 0;
+
 };
 
 } // namespace roc

src/BarInterfaceBase.cxx

@@ -2,6 +2,7 @@
 /// \brief Implementation of the BarInterfaceBase class.
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #include "BarInterfaceBase.h"
 #include "Utilities/SmartPointer.h"
@@ -21,6 +22,12 @@ BarInterfaceBase::BarInterfaceBase(const Parameters& parameters)
   Utilities::resetSmartPtr(mPdaBar, mRocPciDevice->getPciDevice(), mBarIndex);
 }
 
+BarInterfaceBase::BarInterfaceBase(std::shared_ptr<Pda::PdaBar> bar)
+{
+  mPdaBar = std::move(bar);
+}
+
+
 BarInterfaceBase::~BarInterfaceBase()
 {
 }

src/BarInterfaceBase.h

@@ -2,6 +2,7 @@
 /// \brief Definition of the BarInterfaceBase class.
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #ifndef ALICEO2_SRC_READOUTCARD_BARINTERFACEBASE_H_
 #define ALICEO2_SRC_READOUTCARD_BARINTERFACEBASE_H_
@@ -21,6 +22,7 @@ class BarInterfaceBase: public BarInterface
   public:
 
     BarInterfaceBase(const Parameters& parameters);
+    BarInterfaceBase(std::shared_ptr<Pda::PdaBar> bar);
     virtual ~BarInterfaceBase();
 
     virtual uint32_t readRegister(int index) override;
@@ -36,15 +38,37 @@ class BarInterfaceBase: public BarInterface
       return mPdaBar->getSize();
     }
 
+    /// Default implementation for optional function
+    virtual boost::optional<float> getTemperature() override
+    {
+      return {};
+    }
+
+    /// Default implementation for optional function
+    virtual boost::optional<std::string> getFirmwareInfo() override
+    {
+      return {};
+    }
+
+    /// Default implementation for optional function
+    virtual boost::optional<std::string> getCardId() override
+    {
+      return {};
+    }
+
+
   protected:
     /// BAR index
     int mBarIndex;
 
     /// PDA device objects
     std::unique_ptr<RocPciDevice> mRocPciDevice;
 
-    /// PDA BAR object
-    std::unique_ptr<Pda::PdaBar> mPdaBar;
+    /// PDA BAR object ptr
+    std::shared_ptr<Pda::PdaBar> mPdaBar;
+
+    // PDA BAR object
+    Pda::PdaBar mlPdaBar;
 
   private:
     /// Inheriting classes must implement this to check whether a given read is safe.
@@ -58,4 +82,4 @@ class BarInterfaceBase: public BarInterface
 } // namespace roc
 } // namespace AliceO2
 
-#endif // ALICEO2_SRC_READOUTCARD_BARINTERFACEBASE_H_
+#endif // ALICEO2_SRC_READOUTCARD_BARINTERFACEBASE_H_

src/CommandLineUtilities/ProgramListCards.cxx

@@ -2,6 +2,7 @@
 /// \brief Utility that lists the ReadoutCard devices on the system
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #include <iostream>
 #include <sstream>
@@ -37,8 +38,8 @@ class ProgramListCards: public Program
 
       std::ostringstream table;
 
-      auto formatHeader = "  %-3s %-6s %-10s %-11s %-11s %-8s %-15s %-17s\n";
-      auto formatRow = "  %-3s %-6s %-10s 0x%-9s 0x%-9s %-8s %-15s %-17s\n";
+      auto formatHeader = "  %-3s %-6s %-10s %-11s %-11s %-8s %-25s %-17s\n";
+      auto formatRow = "  %-3s %-6s %-10s 0x%-9s 0x%-9s %-8s %-25s %-17s\n";
       auto header = (boost::format(formatHeader)
           % "#" % "Type" % "PCI Addr" % "Vendor ID" % "Device ID" % "Serial" % "FW Version" % "Card ID").str();
       auto lineFat = std::string(header.length(), '=') + '\n';
@@ -53,10 +54,10 @@ class ProgramListCards: public Program
         std::string firmware = na;
         std::string cardId = na;
         try {
-          Parameters params = Parameters::makeParameters(card.pciAddress, 0);
+          Parameters params = Parameters::makeParameters(card.pciAddress, 2);
           params.setBufferParameters(buffer_parameters::Null());
-          firmware = ChannelFactory().getDmaChannel(params)->getFirmwareInfo().value_or(na);
-          cardId = ChannelFactory().getDmaChannel(params)->getCardId().value_or(na);
+          firmware = ChannelFactory().getBar(params)->getFirmwareInfo().value_or(na);
+          cardId = ChannelFactory().getBar(params)->getCardId().value_or(na);
         }
         catch (const Exception& e) {
           if (isVerbose()) {

src/Crorc/CrorcBar.cxx

@@ -2,6 +2,7 @@
 /// \brief Implementation of the CrorcBar class.
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #include "Crorc/CrorcBar.h"
 
@@ -25,5 +26,45 @@ void CrorcBar::checkWriteSafe(int, uint32_t)
 {
 }
 
+boost::optional<int32_t> CrorcBar::getSerial()
+{
+  return Crorc::getSerial(*(mPdaBar.get()));
+}
+
+
+boost::optional<float> CrorcBar::getTemperature()
+{
+   return {};
+}
+
+boost::optional<std::string> CrorcBar::getFirmwareInfo()
+{
+  uint32_t version = mPdaBar->readRegister(Rorc::RFID);
+  auto bits = [&](int lsb, int msb) { return Utilities::getBits(version, lsb, msb); };
+
+  uint32_t reserved = bits(24, 31);
+  uint32_t major = bits(20, 23);
+  uint32_t minor = bits(13, 19);
+  uint32_t year = bits(9, 12) + 2000;
+  uint32_t month = bits(5, 8);
+  uint32_t day = bits(0, 4);
+
+  if (reserved != 0x2) {
+    BOOST_THROW_EXCEPTION(CrorcException()
+        << ErrorInfo::Message("Static field of version register did not equal 0x2"));
+  }
+
+  std::ostringstream stream;
+  stream << major << '.' << minor << ':' << year << '-' << month << '-' << day;
+  return stream.str();
+}
+
+boost::optional<std::string> CrorcBar::getCardId()
+{
+   return {};
+}
+
+
+
 } // namespace roc
 } // namespace AliceO2

src/Crorc/CrorcBar.h

@@ -2,16 +2,19 @@
 /// \brief Definition of the CrorcBar class.
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #ifndef ALICEO2_SRC_READOUTCARD_CRORC_CRORCBAR_H_
 #define ALICEO2_SRC_READOUTCARD_CRORC_CRORCBAR_H_
 
 #include "BarInterfaceBase.h"
+#include "Crorc.h"
+#include "Crorc/Constants.h"
+#include "Utilities/Util.h"
 
 namespace AliceO2 {
 namespace roc {
 
-/// TODO Currently a placeholder
 class CrorcBar final : public BarInterfaceBase
 {
   public:
@@ -24,9 +27,14 @@ class CrorcBar final : public BarInterfaceBase
     {
       return CardType::Crorc;
     }
+
+    virtual boost::optional<int32_t> getSerial() override;
+    virtual boost::optional<float> getTemperature() override;
+    virtual boost::optional<std::string> getFirmwareInfo() override;
+    virtual boost::optional<std::string> getCardId() override;
 };
 
 } // namespace roc
 } // namespace AliceO2
 
-#endif // ALICEO2_SRC_READOUTCARD_CRORC_CRORCBAR_H_
+#endif // ALICEO2_SRC_READOUTCARD_CRORC_CRORCBAR_H_

src/Crorc/CrorcDmaChannel.cxx

@@ -2,6 +2,7 @@
 /// \brief Implementation of the CrorcDmaChannel class.
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #include "CrorcDmaChannel.h"
 #include <iostream>
@@ -13,6 +14,7 @@
 #include <boost/format.hpp>
 #include "ChannelPaths.h"
 #include "Crorc/Constants.h"
+#include "ReadoutCard/ChannelFactory.h"
 #include "Utilities/SmartPointer.h"
 
 namespace b = boost;
@@ -27,8 +29,8 @@ namespace roc {
 
 CrorcDmaChannel::CrorcDmaChannel(const Parameters& parameters)
     : DmaChannelPdaBase(parameters, allowedChannels()), //
-    mPdaBar(getRocPciDevice().getPciDevice(), getChannelNumber()), // Initialize main DMA channel BAR
-    mPdaBar2(getRocPciDevice().getPciDevice(), 2), // Initialize BAR 2
+    //mPdaBar(getRocPciDevice().getPciDevice(), getChannelNumber()), // Initialize main DMA channel BAR
+    //mPdaBar2(getRocPciDevice().getPciDevice(), 2), // Initialize BAR 2
     mPageSize(parameters.getDmaPageSize().get_value_or(8*1024)), // 8 kB default for uniformity with CRU
     mInitialResetLevel(ResetLevel::Internal), // It's good to reset at least the card channel in general
     mNoRDYRX(true), // Not sure
@@ -44,6 +46,14 @@ CrorcDmaChannel::CrorcDmaChannel(const Parameters& parameters)
     mUseContinuousReadout(parameters.getReadoutMode().is_initialized() ?
             parameters.getReadoutModeRequired() == ReadoutMode::Continuous : false)
 {
+  // Prep for BARs
+  auto parameters2 = parameters;
+  parameters2.setChannelNumber(2);
+  auto bar = ChannelFactory().getBar(parameters);
+  auto bar2 = ChannelFactory().getBar(parameters2);
+  crorcBar = std::move(std::dynamic_pointer_cast<CrorcBar> (bar)); // Initialize bar0
+  crorcBar2 = std::move(std::dynamic_pointer_cast<CrorcBar> (bar2)); // Initalize bar2
+
   // Create and register our ReadyFIFO buffer
   log("Initializing ReadyFIFO DMA buffer", InfoLogger::InfoLogger::Debug);
   {
@@ -101,7 +111,7 @@ void CrorcDmaChannel::startPendingDma(SuperpageQueueEntry& entry)
 
   if (mUseContinuousReadout) {
     log("Initializing continuous readout");
-    Crorc::Crorc::initReadoutContinuous(mPdaBar2);
+    Crorc::Crorc::initReadoutContinuous(*(getBar2()));
   }
 
   // Find DIU version, required for armDdl()
@@ -165,7 +175,7 @@ void CrorcDmaChannel::startPendingDma(SuperpageQueueEntry& entry)
 
   if (mUseContinuousReadout) {
     log("Starting continuous readout");
-    Crorc::Crorc::startReadoutContinuous(mPdaBar2);
+    Crorc::Crorc::startReadoutContinuous(*(getBar2()));
   }
 }
 
@@ -437,29 +447,12 @@ CardType::type CrorcDmaChannel::getCardType()
 
 boost::optional<int32_t> CrorcDmaChannel::getSerial()
 {
-  return Crorc::getSerial(mPdaBar);
+  return getBar2()->getSerial();
 }
 
 boost::optional<std::string> CrorcDmaChannel::getFirmwareInfo()
 {
-  uint32_t version = mPdaBar.readRegister(Rorc::RFID);
-  auto bits = [&](int lsb, int msb) { return Utilities::getBits(version, lsb, msb); };
-
-  uint32_t reserved = bits(24, 31);
-  uint32_t major = bits(20, 23);
-  uint32_t minor = bits(13, 19);
-  uint32_t year = bits(9, 12) + 2000;
-  uint32_t month = bits(5, 8);
-  uint32_t day = bits(0, 4);
-
-  if (reserved != 0x2) {
-    BOOST_THROW_EXCEPTION(CrorcException()
-        << ErrorInfo::Message("Static field of version register did not equal 0x2"));
-  }
-
-  std::ostringstream stream;
-  stream << major << '.' << minor << ':' << year << '-' << month << '-' << day;
-  return stream.str();
+  return getBar2()->getFirmwareInfo();
 }
 
 } // namespace roc

src/Crorc/CrorcDmaChannel.h

@@ -2,6 +2,7 @@
 /// \brief Definition of the CrorcDmaChannel class.
 ///
 /// \author Pascal Boeschoten ([email protected])
+/// \author Kostas Alexopoulos ([email protected])
 
 #ifndef ALICEO2_SRC_READOUTCARD_CRORC_CRORCDMACHANNEL_H_
 #define ALICEO2_SRC_READOUTCARD_CRORC_CRORCDMACHANNEL_H_
@@ -12,6 +13,7 @@
 #include <boost/scoped_ptr.hpp>
 #include "DmaChannelPdaBase.h"
 #include "Crorc.h"
+#include "CrorcBar.h"
 #include "ReadoutCard/Parameters.h"
 #include "ReadyFifo.h"
 #include "SuperpageQueue.h"
@@ -80,7 +82,7 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
     /// C-RORC function helper
     Crorc::Crorc getCrorc()
     {
-      return {mPdaBar};
+      return {*(getBar())};
     }
 
     ReadyFifo* getReadyFifoUser()
@@ -119,11 +121,21 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
       return (mFifoBack + mFifoSize) % READYFIFO_ENTRIES;
     };
 
+    CrorcBar* getBar()
+    {
+      return crorcBar.get();
+    }
+
+    CrorcBar* getBar2()
+    { 
+      return crorcBar2.get();
+    }
+
     /// BAR 0 is needed for DMA engine interaction and various other functions
-    Pda::PdaBar mPdaBar;
+    std::shared_ptr<CrorcBar> crorcBar;
 
     /// BAR 2 is needed for configuration
-    Pda::PdaBar mPdaBar2;
+    std::shared_ptr<CrorcBar> crorcBar2;
 
     /// Memory mapped file for the ReadyFIFO
     boost::scoped_ptr<MemoryMappedFile> mBufferFifoFile;
@@ -203,4 +215,4 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
 } // namespace roc
 } // namespace AliceO2
 
-#endif // ALICEO2_SRC_READOUTCARD_CRORC_CRORCDMACHANNEL_H_
+#endif // ALICEO2_SRC_READOUTCARD_CRORC_CRORCDMACHANNEL_H_