[crorc] Update DMA interface (drops Ready & Free fifos)

Author: kostorr

CMakeLists.txt

@@ -296,7 +296,6 @@ set(TEST_SRCS
   test/TestPciAddress.cxx
   test/TestProgramOptions.cxx
   test/TestRorcException.cxx
-  test/TestSuperpageQueue.cxx
 )
 
 foreach (test ${TEST_SRCS})

src/ChannelPaths.cxx

@@ -43,9 +43,9 @@ std::string ChannelPaths::lock() const
   return makePath(".lock", DIR_SHAREDMEM);
 }
 
-std::string ChannelPaths::fifo() const
+std::string ChannelPaths::spInfo() const
 {
-  return makePath("_fifo", DIR_SHAREDMEM);
+  return makePath("_sp_info", DIR_SHAREDMEM);
 }
 
 std::string ChannelPaths::namedMutex() const

src/ChannelPaths.h

@@ -38,9 +38,9 @@ class ChannelPaths
   /// \return The path
   std::string lock() const;
 
-  /// Generates a path for the channel's shared memory FIFO object. It will be in hugetlbfs.
+  /// Generates a path for the CRORC channel's shared memory Superpage info object.
   /// \return The path
-  std::string fifo() const;
+  std::string spInfo() const;
 
   /// Generates a name for the channel's mutex
   /// \return The name

src/CommandLineUtilities/ProgramCleanup.cxx

@@ -55,7 +55,7 @@ class ProgramCleanup : public Program
     std::cout << std::endl;
     std::cout << "Execution of this tool will:" << std::endl;
     std::cout << "1. Free PDA DMA buffers" << std::endl;
-    std::cout << "2. Clean CRORC FIFO shared memory files under /dev/shm which match AliceO2_ROC_*" << std::endl;
+    std::cout << "2. Clean CRORC shared memory files under /dev/shm which match *_sp_info" << std::endl;
     std::cout << "3. Clean all hugepage resources under /var/lib/hugetlbfs/global/pagesize-{2MB, 1GB}/ which match readout* and o2-roc-bench-dma*" << std::endl;
     if (!mOptions.light) {
       std::cout << "4. Remove and reinsert the uio_pci_dma kernel module" << std::endl;
@@ -110,7 +110,7 @@ class ProgramCleanup : public Program
     Pda::freePdaDmaBuffers();
 
     Logger::get() << "Removing CRORC FIFO shared memory files" << LogDebugDevel << endm;
-    sysCheckRet("rm /dev/shm/AliceO2_RoC_*");
+    sysCheckRet("rm /dev/shm/*_sp_info");
     Logger::get() << "Removing readout 2MB hugepage mappings" << LogDebugDevel << endm;
     sysCheckRet("rm /var/lib/hugetlbfs/global/pagesize-2MB/readout*");
     Logger::get() << "Removing readout 1GB hugepage mappings" << LogDebugDevel << endm;

src/CommandLineUtilities/ProgramDmaBench.cxx

@@ -508,13 +508,13 @@ class ProgramDmaBench : public Program
           size_t readoutBytes = 0;
           auto superpageAddress = mBufferBaseAddress + superpageInfo.bufferOffset;
 
-          fetchAddSuperpagesReadOut();
+          auto superpageCount = fetchAddSuperpagesReadOut();
 
           bool atStartOfSuperpage = true;
           while ((readoutBytes < superpageInfo.effectiveSize) && !isStopDma()) {
             auto pageAddress = superpageAddress + readoutBytes;
             auto readoutCount = fetchAddDmaPagesReadOut();
-            size_t pageSize = readoutPage(pageAddress, readoutCount, atStartOfSuperpage);
+            size_t pageSize = readoutPage(pageAddress, readoutCount, superpageCount, atStartOfSuperpage);
 
             atStartOfSuperpage = false; //Update the boolean value as soon as we move...
 
@@ -558,15 +558,15 @@ class ProgramDmaBench : public Program
       auto size = mChannel->getReadyQueueSize();
       for (int i = 0; i < size; ++i) {
         auto superpage = mChannel->popSuperpage();
-        fetchAddSuperpagesReadOut();
+        auto superpageCount = fetchAddSuperpagesReadOut();
         if ((mDataSource == DataSource::Fee) || (mDataSource == DataSource::Ddg)) {
           auto superpageAddress = mBufferBaseAddress + superpage.getOffset();
           size_t readoutBytes = 0;
           bool atStartOfSuperpage = true;
           while ((readoutBytes < superpage.getReceived())) { // At least one more dma page fits in the superpage
             auto pageAddress = superpageAddress + readoutBytes;
             auto readoutCount = fetchAddDmaPagesReadOut();
-            size_t pageSize = readoutPage(pageAddress, readoutCount, atStartOfSuperpage);
+            size_t pageSize = readoutPage(pageAddress, readoutCount, superpageCount, atStartOfSuperpage);
             atStartOfSuperpage = false; // Update the boolean value as soon as we move...
             readoutBytes += pageSize;
           }
@@ -588,12 +588,23 @@ class ProgramDmaBench : public Program
     return payload[0];
   };
 
-  size_t readoutPage(uintptr_t pageAddress, int64_t readoutCount, bool atStartOfSuperpage)
+  size_t readoutPage(uintptr_t pageAddress, int64_t readoutCount, int64_t superpageCount, bool atStartOfSuperpage)
   {
     size_t pageSize = (mDataSource == DataSource::Internal) ? mPageSize : DataFormat::getOffset(reinterpret_cast<const char*>(pageAddress));
 
+    bool isEmpty = false;
+    if (pageSize != mPageSize) {
+      pageSize = mPageSize;
+      isEmpty = true;
+      // write to file
+      uint32_t emptySP = 0x0badf00d;
+      for (int i = 0; i < 4; i++) { // Marker is 128bits long
+        mReadoutStream.write(reinterpret_cast<const char*>(&emptySP), sizeof(emptySP));
+      }
+    }
+
     // Read out to file
-    printToFile(pageAddress, pageSize, readoutCount, atStartOfSuperpage);
+    printToFile(pageAddress, pageSize, readoutCount, superpageCount, atStartOfSuperpage, isEmpty);
 
     // Data error checking
     if (!mOptions.noErrorCheck) {
@@ -848,7 +859,7 @@ class ProgramDmaBench : public Program
       mPacketCounters[linkId] = packetCounter;
     }
 
-    if (!checkTimeFrameAlignment(pageAddress, atStartOfSuperpage)) {
+    if (false && !checkTimeFrameAlignment(pageAddress, atStartOfSuperpage)) {
       // log TF not at the beginning of the superpage error
       mErrorCount++;
       if (mErrorCount < MAX_RECORDED_ERRORS) {
@@ -1015,26 +1026,38 @@ class ProgramDmaBench : public Program
   }
 
   /// Prints the page to a file in ASCII or binary format if such output is enabled
-  void printToFile(uintptr_t pageAddress, size_t pageSize, int64_t pageNumber, bool atStartOfSuperpage)
+  void printToFile(uintptr_t pageAddress, size_t pageSize, int64_t pageNumber, int64_t superpageNumber, bool atStartOfSuperpage, bool isEmpty = false)
   {
     auto page = reinterpret_cast<const volatile uint32_t*>(pageAddress);
     auto pageSize32 = pageSize / sizeof(uint32_t);
 
     if (mOptions.fileOutputAscii) {
       if (atStartOfSuperpage && mOptions.printSuperpageChange) {
-        mReadoutStream << "New Superpage\n";
+        mReadoutStream << "Superpage #" << std::hex << "0x" << superpageNumber << '\n';
       }
-      mReadoutStream << "Event #" << pageNumber << '\n';
+      // TODO: for debugging: maybe add an option here?
+      if (isEmpty) {
+        mReadoutStream << "!!EMPTY DMA PAGE!!\n";
+      }
+      mReadoutStream << "Event #" << std::hex << "0x" << pageNumber << '\n';
       uint32_t perLine = 8;
 
       for (uint32_t i = 0; i < pageSize32; i += perLine) {
         for (uint32_t j = 0; j < perLine; ++j) {
-          mReadoutStream << page[i + j] << ' ';
+          mReadoutStream << std::hex << "0x" << std::setw(8) << page[i + j] << ' ';
+          mReadoutStream << '\t';
         }
         mReadoutStream << '\n';
       }
       mReadoutStream << '\n';
     } else if (mOptions.fileOutputBin) {
+      // TODO: for debugging
+      if (isEmpty) {
+        uint32_t emptySP = 0xdeadbeef;
+        for (int i = 0; i < 4; i++) { // Marker is 128bits long
+          mReadoutStream.write(reinterpret_cast<const char*>(&emptySP), sizeof(emptySP));
+        }
+      }
       if (atStartOfSuperpage && mOptions.printSuperpageChange) {
         uint32_t newSP = 0x0badf00d;
         for (int i = 0; i < 4; i++) { // Marker is 128bits long

src/Crorc/Constants.h

@@ -385,10 +385,9 @@ static constexpr uint32_t DATA_RX_ON_OFF_BIT(0x9);
 static constexpr uint32_t RXSTAT_NOT_EMPTY(0x00800000);
 static constexpr uint32_t LOOPBACK_ON_OFF(0x00001000);
 
-// Channel Receive Report Base Address
-static constexpr Register CHANNEL_RRBAR(0x00000034);
-// Channel Receive Report Base Address Extension
-static constexpr Register CHANNEL_RRBARX(0x00000084);
+// Addresses to push the DMA buffer address for SP size + count info
+static constexpr Register SPINFO_LOW(0x00000040);
+static constexpr Register SPINFO_HIGH(0x00000044);
 
 // Registers to send DDL commands
 static constexpr Register DDL_COMMAND(0x00000018);
@@ -412,10 +411,10 @@ static constexpr Register OPT_POWER_QSFP10(0x00000144);
 static constexpr Register OPT_POWER_QSFP32(0x00000148);
 static constexpr Register OPT_POWER_QSFP54(0x00000154);
 
-// Registers for RX FIFO configuration
-static constexpr Register RX_FIFO_ADDR_LOW(0x00000038);
-static constexpr Register RX_FIFO_ADDR_HIGH(0x0000003c);
-static constexpr Register RX_FIFO_ADDR_EXT(0x00000080);
+// Registers for pushing a Superpage to the CRORC
+static constexpr Register SP_WR_SIZE(0x00000028);
+static constexpr Register SP_WR_ADDR_HIGH(0x00000030);
+static constexpr Register SP_WR_ADDR_LOW(0x0000002c);
 
 // Data transmission status word
 static constexpr uint32_t DTSW(0x00000082);

src/Crorc/Crorc.cxx

@@ -802,31 +802,6 @@ void Crorc::diuCommand(int command)
   ddlReadDiu(command, Ddl::RESPONSE_TIME);
 }
 
-RxFreeFifoState Crorc::getRxFreeFifoState()
-{
-  uint32_t st = read(Rorc::C_CSR);
-  if (st & Rorc::CcsrStatus::RXAFF_FULL) {
-    return (RxFreeFifoState::FULL);
-  } else if (st & Rorc::CcsrStatus::RXAFF_EMPTY) {
-    return (RxFreeFifoState::EMPTY);
-  } else {
-    return (RxFreeFifoState::NOT_EMPTY);
-  }
-}
-
-bool Crorc::isFreeFifoEmpty()
-{
-  return getRxFreeFifoState() == RxFreeFifoState::EMPTY;
-}
-
-void Crorc::assertFreeFifoEmpty()
-{
-  if (!isFreeFifoEmpty()) {
-    BOOST_THROW_EXCEPTION(CrorcFreeFifoException() << ErrorInfo::Message("Free FIFO not empty")
-                                                   << ErrorInfo::PossibleCauses({ "Previous DMA did not get/free all received pages" }));
-  }
-}
-
 void Crorc::startDataReceiver(uintptr_t readyFifoBusAddress)
 {
   write(Rorc::C_RRBAR, (readyFifoBusAddress & 0xffffffff));

src/Crorc/Crorc.h

@@ -23,7 +23,6 @@
 #include <vector>
 #include <boost/optional.hpp>
 #include "ReadoutCard/RegisterReadWriteInterface.h"
-#include "RxFreeFifoState.h"
 #include "StWord.h"
 
 namespace o2
@@ -104,12 +103,6 @@ class Crorc
   ///   the header ddl_def.h
   void diuCommand(int command);
 
-  /// Checks if the C-RORC's Free FIFO is empty
-  bool isFreeFifoEmpty();
-
-  /// Checks if the C-RORC's Free FIFO is empty
-  void assertFreeFifoEmpty();
-
   /// Starts the trigger (RDYRX or STBRD)
   void startTrigger(const DiuConfig& diuConfig, uint32_t command);
   //void startTrigger(uint32_t command);
@@ -149,8 +142,6 @@ class Crorc
 
   void pushRxFreeFifo(uintptr_t blockAddress, uint32_t blockLength, uint32_t readyFifoIndex);
 
-  RxFreeFifoState getRxFreeFifoState();
-
   static void scaInit(RegisterReadWriteInterface& bar2);
 
   struct ScaWriteCommand {

src/Crorc/CrorcBar.cxx

@@ -340,15 +340,17 @@ void CrorcBar::resetDevice(bool withSiu)
   }
 }
 
-void CrorcBar::startDataReceiver(uintptr_t readyFifoBusAddress)
+void CrorcBar::startDataReceiver(uintptr_t superpageInfoBusAddress)
 {
-  writeRegister(Crorc::Registers::CHANNEL_RRBAR.index, (readyFifoBusAddress & 0xffffffff));
+  // Send the address of the DMA buffer used for writing the Superpage Info (size + count)
+  writeRegister(Crorc::Registers::SPINFO_LOW.index, (superpageInfoBusAddress & 0xffffffff));
   if (sizeof(uintptr_t) > 4) {
-    writeRegister(Crorc::Registers::CHANNEL_RRBARX.index, (readyFifoBusAddress >> 32));
+    writeRegister(Crorc::Registers::SPINFO_HIGH.index, (superpageInfoBusAddress >> 32));
   } else {
-    writeRegister(Crorc::Registers::CHANNEL_RRBARX.index, 0x0);
+    writeRegister(Crorc::Registers::SPINFO_HIGH.index, 0x0);
   }
 
+  // Set DMA ON
   uint32_t CSRRegister = readRegister(Crorc::Registers::CHANNEL_CSR.index);
   if (!Utilities::getBit(CSRRegister, Crorc::Registers::DATA_RX_ON_OFF_BIT)) {
     Utilities::setBit(CSRRegister, Crorc::Registers::DATA_RX_ON_OFF_BIT, true);
@@ -366,11 +368,11 @@ void CrorcBar::stopDataReceiver()
   }
 }
 
-void CrorcBar::pushRxFreeFifo(uintptr_t blockAddress, uint32_t blockLength, uint32_t readyFifoIndex)
+void CrorcBar::pushSuperpageAddressAndSize(uintptr_t blockAddress, uint32_t blockLength)
 {
-  writeRegister(Crorc::Registers::RX_FIFO_ADDR_EXT.index, arch64() ? (blockAddress >> 32) : 0x0);
-  writeRegister(Crorc::Registers::RX_FIFO_ADDR_HIGH.index, blockAddress & 0xffffffff);
-  writeRegister(Crorc::Registers::RX_FIFO_ADDR_LOW.index, (blockLength << 8) | readyFifoIndex);
+  writeRegister(Crorc::Registers::SP_WR_ADDR_HIGH.index, arch64() ? (blockAddress >> 32) : 0x0);
+  writeRegister(Crorc::Registers::SP_WR_ADDR_LOW.index, blockAddress & 0xffffffff);
+  writeRegister(Crorc::Registers::SP_WR_SIZE.index, blockLength);
 }
 
 void CrorcBar::startDataGenerator()
@@ -409,21 +411,5 @@ Crorc::PacketMonitoringInfo CrorcBar::monitorPackets()
   return { acquisitionRate, packetsReceived };
 }
 
-bool CrorcBar::isASuperpageAvailable()
-{
-  static uint32_t previousAvailable = 0x0;
-  uint32_t currentAvailable = readRegister(0x30 / 4);
-  uint32_t diff;
-  if (currentAvailable < previousAvailable) { // warped
-    diff = (0x100000000 - 0xffffffff) + currentAvailable;
-  } else {
-    diff = currentAvailable - previousAvailable;
-  }
-
-  previousAvailable = currentAvailable;
-
-  return diff > 0;
-}
-
 } // namespace roc
 } // namespace o2

src/Crorc/CrorcBar.h

@@ -23,6 +23,9 @@
 #include "Crorc/Constants.h"
 #include "Utilities/Util.h"
 
+#include <fstream>
+#include <iostream>
+
 namespace o2
 {
 namespace roc
@@ -54,7 +57,7 @@ class CrorcBar final : public BarInterfaceBase
 
   void resetDevice(bool withSiu);
   void flushSuperpages();
-  void startDataReceiver(uintptr_t readyFifoBusAddress);
+  void startDataReceiver(uintptr_t superpageInfoBusAddress);
   void stopDataReceiver();
   void startDataGenerator();
   void stopDataGenerator();
@@ -63,14 +66,12 @@ class CrorcBar final : public BarInterfaceBase
   bool isLinkUp(int barIndex);
   bool checkLinkUp();
   void assertLinkUp();
-  void pushRxFreeFifo(uintptr_t blockAddress, uint32_t blockLength, uint32_t readyFifoIndex);
+  void pushSuperpageAddressAndSize(uintptr_t blockAddress, uint32_t blockLength);
   void setLoopback();
   void setDiuLoopback();
   void setSiuLoopback();
   Crorc::PacketMonitoringInfo monitorPackets();
 
-  bool isASuperpageAvailable();
-
  private:
   std::map<int, Crorc::Link> initializeLinkMap();