[crorc + bench-dma] Support latest superpage-aware CRORC firmware

* [crorc] Updates to push whole superpages

* [crorc]s/READYFIFO_ENTRIES/MAX_SUPERPAGE_DESCRIPTORS

* [bench-dma] Error-checking according to RDH-reported event size

* [crorc] Get superpage size from FreeFifo

* [bench-dma] Common Data Format between CRORC and CRU

* [bench-dma + cru] Remove duplicate dwrapper datagen control register"

* [bench-dma] Strongly-typed loopback mode

* [bench-dma] Properly propagate exception information

* [clang] Format & remove stale TODOs

* [bench-dma] Update error-checking for new CRU internal loopback data format

Author: kostorr

src/CommandLineUtilities/ProgramDmaBench.cxx

@@ -21,6 +21,8 @@ namespace AliceO2
 namespace roc
 {
 
+static constexpr int MAX_SUPERPAGE_DESCRIPTORS = 128;
+
 namespace Rorc
 {
 constexpr int RCSR = 0;     ///< RORC Control and Status register

src/Crorc/Constants.h

@@ -138,6 +138,7 @@ void CrorcDmaChannel::deviceStartDma()
 
   log("DMA start deferred until enough superpages available");
 
+  mFreeFifoFront = 0;
   mFreeFifoBack = 0;
   mFreeFifoSize = 0;
   mReadyQueue.clear();
@@ -292,7 +293,7 @@ void CrorcDmaChannel::armDdl(ResetLevel::type resetLevel)
 void CrorcDmaChannel::startDataGenerator()
 {
   getCrorc().armDataGenerator(mGeneratorInitialValue, mGeneratorInitialWord, mGeneratorPattern, mGeneratorDataSize,
-                              mGeneratorSeed);
+                              mGeneratorSeed); //TODO: To be simplified
 
   if (LoopbackMode::Internal == mLoopbackMode) {
     getCrorc().setLoopbackOn();
@@ -343,26 +344,20 @@ void CrorcDmaChannel::pushSuperpage(Superpage superpage)
 {
   checkSuperpage(superpage);
 
-  if (superpage.getSize() != SUPERPAGE_SIZE) {
-    BOOST_THROW_EXCEPTION(CrorcException()
-                          << ErrorInfo::Message("Could not enqueue superpage, the C-RORC backend only supports superpage sizes of 1 MiB"));
-  }
-
   if (mTransferQueue.size() >= TRANSFER_QUEUE_CAPACITY) {
     BOOST_THROW_EXCEPTION(Exception() << ErrorInfo::Message("Could not push superpage, transfer queue was full"));
   }
 
-  if (mFreeFifoSize >= READYFIFO_ENTRIES) {
+  if (mFreeFifoSize >= MAX_SUPERPAGE_DESCRIPTORS) {
     BOOST_THROW_EXCEPTION(Exception()
                           << ErrorInfo::Message("Could not push superpage, firmware queue was full (this should never happen)"));
   }
 
-  for (int i = 0; i < READYFIFO_ENTRIES; i++) { // *always* push 128 FIFO entries
-    auto busAddress = getBusOffsetAddress(superpage.getOffset() + i * mPageSize);
-    pushFreeFifoPage(i, busAddress);
-  }
-  mFreeFifoSize = READYFIFO_ENTRIES;
-  ;
+  auto busAddress = getBusOffsetAddress(superpage.getOffset());
+  pushFreeFifoPage(mFreeFifoFront, busAddress, superpage.getSize());
+  mFreeFifoSize++;
+  mFreeFifoFront = (mFreeFifoFront + 1) % MAX_SUPERPAGE_DESCRIPTORS;
+
   mTransferQueue.push_back(superpage);
 }
 
@@ -388,39 +383,26 @@ void CrorcDmaChannel::fillSuperpages()
   }
 
   // Check for arrivals & handle them
-  if (!mTransferQueue.empty()) {
+  if (!mTransferQueue.empty()) { // i.e. If something is pushed to the CRORC
     auto isArrived = [&](int descriptorIndex) { return dataArrived(descriptorIndex) == DataArrivalStatus::WholeArrived; };
     auto resetDescriptor = [&](int descriptorIndex) { getReadyFifoUser()->entries[descriptorIndex].reset(); };
+    auto getLength = [&](int descriptorIndex) { return getReadyFifoUser()->entries[descriptorIndex].length * 4; }; // length in 4B words
 
     while (mFreeFifoSize > 0) {
       if (isArrived(mFreeFifoBack)) {
-        uint32_t length = getReadyFifoUser()->entries[mFreeFifoBack].getSize();
-
-        // Write length of the DMA page in the RDH
-        auto writeRdhLength = [](uintptr_t dmaPageAddress, uint32_t length) {
-          auto writeTo = reinterpret_cast<volatile uint32_t*>(dmaPageAddress + sizeof(uint32_t) * 2); //writeTo the 3rd word
-          uint32_t shiftedLength = (length << 16) & 0xffff0000;
-          *writeTo |= shiftedLength; //Only the 16 MSBs
-        };
-
-        // Write the length of the DMA page in its RDH
-        if ((mLoopbackMode == LoopbackMode::None) && mRDYRX) { //Don't write the header for STBRD
-          auto superpage = mTransferQueue.front();
-          auto dmaPageAddress = mDmaBufferUserspace + superpage.getOffset() + mFreeFifoBack * mPageSize;
-          writeRdhLength(dmaPageAddress, length);
-        }
+        //size_t superpageFilled = SUPERPAGE_SIZE; // Get the length before updating our descriptor index
+        size_t superpageFilled = getLength(mFreeFifoBack); // Get the length before updating our descriptor index
         resetDescriptor(mFreeFifoBack);
 
         mFreeFifoSize--;
-        mFreeFifoBack = (mFreeFifoBack + 1) % READYFIFO_ENTRIES;
-
-        if (mFreeFifoBack == 0) { // Push the superpage after all of the 128 fifo entries are pushed
-          auto superpage = mTransferQueue.front();
-          superpage.setReceived(mPageSize * READYFIFO_ENTRIES); // Always full Superpages
-          superpage.setReady(true);
-          mReadyQueue.push_back(superpage);
-          mTransferQueue.pop_front();
-        }
+        mFreeFifoBack = (mFreeFifoBack + 1) % MAX_SUPERPAGE_DESCRIPTORS;
+
+        // Push Superpage
+        auto superpage = mTransferQueue.front();
+        superpage.setReceived(superpageFilled);
+        superpage.setReady(true);
+        mReadyQueue.push_back(superpage);
+        mTransferQueue.pop_front();
       } else {
         // If the back one hasn't arrived yet, the next ones will certainly not have arrived either...
         break;
@@ -449,9 +431,9 @@ int32_t CrorcDmaChannel::getDroppedPackets()
   return -1;
 }
 
-void CrorcDmaChannel::pushFreeFifoPage(int readyFifoIndex, uintptr_t pageBusAddress)
+void CrorcDmaChannel::pushFreeFifoPage(int readyFifoIndex, uintptr_t pageBusAddress, int pageSize)
 {
-  size_t pageWords = mPageSize / 4; // Size in 32-bit words
+  size_t pageWords = pageSize / 4; // Size in 32-bit words
   getCrorc().pushRxFreeFifo(pageBusAddress, pageWords, readyFifoIndex);
 }
 

src/Crorc/CrorcDmaChannel.cxx

@@ -76,7 +76,7 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
   static constexpr size_t DMA_PAGE_SIZE = 8 * 1024;
 
   /// Max amount of superpages in the transfer queue (i.e. pending transfer).
-  static constexpr size_t TRANSFER_QUEUE_CAPACITY = SUPERPAGE_SIZE / (READYFIFO_ENTRIES * DMA_PAGE_SIZE);
+  static constexpr size_t TRANSFER_QUEUE_CAPACITY = MAX_SUPERPAGE_DESCRIPTORS;
 
   /// Max amount of superpages in the ready queue (i.e. finished transfer).
   /// This is an arbitrary size, can easily be increased if more headroom is needed.
@@ -117,7 +117,7 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
   /// Pushes a page to the CRORC's Free FIFO
   /// \param readyFifoIndex Index of the Ready FIFO to write the page's transfer status to
   /// \param pageBusAddress Address on the bus to push the page to
-  void pushFreeFifoPage(int readyFifoIndex, uintptr_t pageBusAddress);
+  void pushFreeFifoPage(int readyFifoIndex, uintptr_t pageBusAddress, int pageSize);
 
   /// Check if data has arrived
   DataArrivalStatus::type dataArrived(int index);
@@ -154,7 +154,10 @@ class CrorcDmaChannel final : public DmaChannelPdaBase
   /// Bus address of FIFO in DMA buffer
   uintptr_t mReadyFifoAddressBus;
 
-  /// Back index of the firmware FIFO
+  /// Front index of the firmware FIFO (WRITE)
+  int mFreeFifoFront = 0;
+
+  /// Back index of the firmware FIFO (READ)
   int mFreeFifoBack = 0;
 
   /// Amount of elements in the firmware FIFO

src/Crorc/CrorcDmaChannel.h

@@ -24,7 +24,7 @@ namespace AliceO2
 namespace roc
 {
 
-constexpr int READYFIFO_ENTRIES = 128;
+constexpr int READYFIFO_ENTRIES = MAX_SUPERPAGE_DESCRIPTORS;
 
 /// Class representing CRORC readyFifo
 /// This class is meant to be used as an aliased type, reinterpret_casted from a raw memory pointer

src/Crorc/ReadyFifo.h

@@ -259,9 +259,6 @@ static constexpr Register DWRAPPER_GREGS(0x00000000);
 /// Datapath Wrapper offset for "Enabled(?) Registers"
 static constexpr Register DWRAPPER_ENREG(0x00000000);
 
-/// Register to control the Datapath Wrapper multiplexer
-static constexpr Register DWRAPPER_MUX_CONTROL(0x00000004);
-
 /// Datapath Wrapper configuration registers
 static constexpr Register DATAPATHLINK_OFFSET(0x00040000);
 static constexpr Register DATALINK_OFFSET(0x00002000);

src/Cru/Constants.h

@@ -303,7 +303,7 @@ void CruDmaChannel::transferSuperpageFromLinkToReady(Link& link)
   }
 
   link.queue.front().setReady(true);
-  link.queue.front().setReceived(link.queue.front().getSize());
+  link.queue.front().setReceived(link.queue.front().getSize()); //TODO: Update this with the effective superpage size when available
   mReadyQueue.push_back(link.queue.front());
   link.queue.pop_front();
   link.superpageCounter++;

src/Cru/CruDmaChannel.cxx

@@ -96,7 +96,7 @@ void DatapathWrapper::setPacketArbitration(int wrapperCount, int arbitrationMode
   for (int i = 0; i < wrapperCount; i++) {
     uint32_t address = getDatapathWrapperBaseAddress(i) +
                        Cru::Registers::DWRAPPER_GREGS.address +
-                       Cru::Registers::DWRAPPER_MUX_CONTROL.address;
+                       Cru::Registers::DWRAPPER_DATAGEN_CONTROL.address;
 
     mPdaBar->writeRegister(address / 4, value);
   }

src/Cru/DatapathWrapper.cxx

@@ -65,7 +65,6 @@
 #'add_refgen2_offset':'I2C_COMMAND',
 'add_flowctrl_offset':'FLOW_CONTROL_OFFSET',
 'add_flowctrl_ctrlreg':'FLOW_CONTROL_REGISTER',
-'add_dwrapper_muxctrl':'DWRAPPER_MUX_CONTROL',
 'add_gbt_wrapper_atx_pll':'GBT_WRAPPER_ATX_PLL',
 'add_gbt_bank_fpll':'GBT_BANK_FPLL',
 'add_bsp_i2c_minipods':"BSP_I2C_MINIPODS",

src/Cru/cru_constants_populate.py

@@ -13,8 +13,8 @@
 ///
 /// \author Pascal Boeschoten ([email protected])
 
-#ifndef ALICEO2_READOUTCARD_CRU_DATAFORMAT_H_
-#define ALICEO2_READOUTCARD_CRU_DATAFORMAT_H_
+#ifndef ALICEO2_READOUTCARD_DATAFORMAT_H_
+#define ALICEO2_READOUTCARD_DATAFORMAT_H_
 
 #include <cstddef>
 #include <cstdint>
@@ -25,8 +25,6 @@ namespace AliceO2
 {
 namespace roc
 {
-namespace Cru
-{
 namespace DataFormat
 {
 namespace
@@ -44,7 +42,7 @@ uint32_t getLinkId(const char* data)
   return Utilities::getBits(getWord(data, 3), 0, 7); //bits #[96-103] from RDH
 }
 
-uint32_t getEventSize(const char* data)
+uint32_t getMemsize(const char* data)
 {
   return Utilities::getBits(getWord(data, 2), 16, 31); //bits #[80-95] from RDH
 }
@@ -54,7 +52,10 @@ uint32_t getPacketCounter(const char* data)
   return Utilities::getBits(getWord(data, 3), 8, 15); //bits #[104-111] from RDH
 }
 
-////TODO: Add getOffset (pointer to the beginning of the next dma page)
+uint32_t getOffset(const char* data)
+{
+  return Utilities::getBits(getWord(data, 2), 0, 15); //bits #[64-79] from RDH
+}
 
 /// Get header size in bytes
 constexpr size_t getHeaderSize()
@@ -70,8 +71,7 @@ constexpr size_t getHeaderSizeWords()
 }
 
 } // namespace DataFormat
-} // namespace Cru
 } // namespace roc
 } // namespace AliceO2
 
-#endif // ALICEO2_READOUTCARD_CRU_DATAFORMAT_H_
+#endif // ALICEO2_READOUTCARD_DATAFORMAT_H_