FECInfo.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef AliceO2_TPC_FECInfo_H
#define AliceO2_TPC_FECInfo_H
 
#include <iosfwd>
 
namespace o2
{
namespace tpc
{
 
class FECInfo
{
 public:
  static constexpr int ChannelsPerSAMPA = 32;
  static constexpr int SAMPAsPerFEC = 5;
  static constexpr int ChannelsPerFEC = ChannelsPerSAMPA * SAMPAsPerFEC;
  static constexpr int FECsPerSector = 91;
  static constexpr int FECsTotal = FECsPerSector * 36;
 
  FECInfo() = default;
  FECInfo(unsigned char index,
          // unsigned char connector,
          // unsigned char channel,
          unsigned char sampaChip,
          unsigned char sampaChannel)
    : mIndex(index), /*mConnector(connector), mChannel(channel),*/ mSampaChip(sampaChip), mSampaChannel(sampaChannel)
  {
  }
 
  unsigned char getIndex() const { return mIndex; }
  // const unsigned char getConnector()    const { return mConnector;   } // -> can be calculated from mSampaChannel and mSampaChip
  unsigned char getFECChannel() const { return mSampaChip * ChannelsPerSAMPA + mSampaChannel; } // -> can be calculated from mSampaChannel and mSampaChip
  unsigned char getSampaChip() const { return mSampaChip; }
  unsigned char getSampaChannel() const { return mSampaChannel; }
 
  bool operator==(const FECInfo& other) const
  {
    return mIndex == other.mIndex &&
           (mSampaChip == other.mSampaChip && mSampaChannel == other.mSampaChannel);
    //( (mConnector==other.mConnector && mChannel==other.mChannel)
    //|| (mSampaChip==other.mSampaChip && mSampaChannel==other.mSampaChannel) );
  }
 
  static constexpr int globalSAMPAId(const int fecInSector, const int sampaOnFEC, const int channelOnSAMPA)
  {
    // channelOnSAMPA 0-31, 5 bits
    // sampaOnFEC     0- 4, 3 bits
    // fecInSector    0-90, 7 bits
    return (fecInSector << 8) + (sampaOnFEC << 5) + channelOnSAMPA;
  }
 
  static constexpr int fecInSector(const int globalSAMPAId) { return globalSAMPAId >> 8; }
  static constexpr int sampaOnFEC(const int globalSAMPAId) { return (globalSAMPAId >> 5) & 7; }
  static constexpr int channelOnSAMPA(const int globalSAMPAId) { return globalSAMPAId & 31; }
 
  static constexpr int sampaFromFECChannel(const int fecChannel) { return fecChannel / ChannelsPerSAMPA; }
 
  static constexpr int channelFromFECChannel(const int fecChannel) { return fecChannel % ChannelsPerSAMPA; }
 
  static void sampaInfo(const int globalSAMPAId, int& fecInSector, int& sampaOnFEC, int& channelOnSAMPA)
  {
    fecInSector = (globalSAMPAId >> 8);
    sampaOnFEC = (globalSAMPAId >> 5) & 7;
    channelOnSAMPA = (globalSAMPAId & 31);
  }
 
  bool operator<(const FECInfo& other) const
  {
    if (mIndex < other.mIndex) {
      return true;
    }
    if (mSampaChip < other.mSampaChip) {
      return true;
    }
    if (mSampaChip == other.mSampaChip && mSampaChannel < other.mSampaChannel) {
      return true;
    }
    return false;
  }
 
 private:
  std::ostream& print(std::ostream& out) const;
  friend std::ostream& operator<<(std::ostream& out, const FECInfo& fec);
  unsigned char mIndex{0};        
  unsigned char mSampaChip{0};    
  unsigned char mSampaChannel{0}; 
 
  // unsigned char mConnector    {0};   ///< Connector on the FEC -> Can be deduced from mSampaChip and mSampaChannel
  // unsigned char mChannel      {0};   ///< Channel on the FEC -> Can be deduced from mSampaChip and mSampaChannel
};
 
} // namespace tpc
} // namespace o2
 
#endif