CbmFsdAddress.h

Go to the documentation of this file.

/* Copyright (C) 2023 Physikalisches Institut, Eberhard Karls Universitaet Tuebingen, Tuebingen
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Volker Friese, Andrey Lebedev, Lukas Chlad [committer] */
 
#ifndef CBMFSDADDRESS_H
#define CBMFSDADDRESS_H 1
 
#include "CbmDefs.h"  // for ECbmModuleId
 
#include <cassert>  // for assert
#include <cstdint>  // for uint32_t
#include <sstream>  // for string
 
namespace CbmFsdAddress
{
  enum class Level
  {
    System,
    Unit,
    Module,
    PhotoDet,
    NumLevels
  };
 
  inline constexpr uint32_t kCurrentVersion = 0;
 
  // --- These values are not to be changed if backward compatibility
  // --- shall be maintained.
  inline constexpr int32_t kVersionSize  = 4;   // Bits for version number
  inline constexpr int32_t kVersionShift = 28;  // First bit for version number
  inline constexpr int32_t kVersionMask  = (1 << kVersionSize) - 1;
 
  namespace Detail
  {
    // clang-format off
    // -----    Definition of address bit field   ------------------------------
    inline constexpr uint16_t kBits[kCurrentVersion + 1][static_cast<uint32_t>(CbmFsdAddress::Level::NumLevels)] = {
 
      // Version 0
      {
        4,  // system
        4,  // unit 
       15,  // module
        2   // photodet
      }
 
    };
    // -------------------------------------------------------------------------
 
    // -----    Bit shifts -----------------------------------------------------
    inline constexpr int32_t kShift[kCurrentVersion + 1][static_cast<uint32_t>(CbmFsdAddress::Level::NumLevels)] = {
      {0, kShift[0][0] + kBits[0][0], kShift[0][1] + kBits[0][1], kShift[0][2] + kBits[0][2]}
    };
    // -------------------------------------------------------------------------
 
    // -----    Bit masks  -----------------------------------------------------
    inline constexpr int32_t kMask[kCurrentVersion + 1][static_cast<uint32_t>(CbmFsdAddress::Level::NumLevels)] = {
      {(1 << kBits[0][0]) - 1, (1 << kBits[0][1]) - 1, (1 << kBits[0][2]) - 1, (1 << kBits[0][3]) - 1}
    };
    // -------------------------------------------------------------------------
    // clang-format on
  }  // Namespace Detail
 
 
  int32_t GetAddress(uint32_t Unit = 0, uint32_t Module = 0, uint32_t PhotoDet = 0, uint32_t Version = kCurrentVersion);
 
 
  int32_t GetMotherAddress(int32_t address, int32_t level);
 
 
  uint32_t GetElementId(int32_t address, int32_t level);
 
 
  uint32_t GetSystemId(int32_t address);
 
 
  uint32_t GetVersion(int32_t address);
 
 
  int32_t SetElementId(int32_t address, int32_t level, uint32_t newId);
 
  std::string ToString(int32_t address);
 
}  // Namespace CbmFsdAddress
 
 
#endif  // CBMFSDADDRESS_H