Constants.h

// 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.

/// \file Constants.h
/// \brief Global TRD definitions and constants
/// \author ole.schmidt@cern.ch

#ifndef AliceO2_TRD_Constants_H
#define AliceO2_TRD_Constants_H

namespace o2
{
namespace trd
{
namespace constants
{
constexpr int NSECTOR = 18;          ///< the number of sectors
constexpr int NSTACK = 5;            ///< the number of stacks per sector
constexpr int NLAYER = 6;            ///< the number of layers
constexpr int NCHAMBERPERSEC = 30;   ///< the number of chambers per sector
constexpr int NHCPERSEC = 60;        ///< the number of half-chambers per sector
constexpr int MAXCHAMBER = 540;      ///< the maximum number of installed chambers
constexpr int MAXHALFCHAMBER = 1080; ///< the maximum number of installed half-chambers
constexpr int NCHAMBER = 521;        ///< the number of chambers actually installed
constexpr int NHALFCRU = 72;         ///< the number of half cru (link bundles)
constexpr int NLINKSPERHALFCRU = 15; ///< the number of links per half cru or cru end point.
constexpr int NLINKSPERCRU = 30;     ///< the number of links per CRU (two CRUs serve one supermodule)
constexpr int NCRU = 36;             ///< the number of CRU we have
constexpr int NFLP = 12;             ///< the number of FLP we have.
constexpr int NCRUPERFLP = 3;        ///< the number of CRU per FLP
constexpr int TRDLINKID = 15;        ///< hard coded link id, specific to TRD

constexpr int NCOLUMN = 144; ///< the number of pad columns for each chamber
constexpr int NROWC0 = 12;   ///< the number of pad rows for chambers of type C0 (installed in stack 2)
constexpr int NROWC1 = 16;   ///< the number of pad rows for chambers of type C1 (installed in stacks 0, 1, 3 and 4)
constexpr int FIRSTROW[NSTACK] = {0, 16, 32, 44, 60}; ///< first pad row for each stack

constexpr int NMCMROB = 16;     ///< the number of MCMs per ROB
constexpr int NMCMHCMAX = 64;   ///< the maximum number of MCMs for one half chamber (C1 type)
constexpr int NMCMROBINROW = 4; ///< the number of MCMs per ROB in row direction
constexpr int NMCMROBINCOL = 4; ///< the number of MCMs per ROB in column direction
constexpr int NROBC0 = 6;       ///< the number of ROBs per C0 chamber
constexpr int NROBC1 = 8;       ///< the number of ROBs per C1 chamber
constexpr int NADCMCM = 21;     ///< the number of ADC channels per MCM
constexpr int NCOLMCM = 18;     ///< the number of pads per MCM
constexpr int NCHANNELSPERROW = NMCMROBINCOL * 2 * NADCMCM;                                                    ///< the number of readout channels per pad row
constexpr int NCHANNELSC0 = NROWC0 * NCHANNELSPERROW;                                                          ///< the number of readout channels per C0 chamber
constexpr int NCHANNELSC1 = NROWC1 * NCHANNELSPERROW;                                                          ///< the number of readout channels per C1 chamber
constexpr int NCHANNELSTOTAL = NSECTOR * NLAYER * (NSTACK - 1) * NCHANNELSC1 + NSECTOR * NLAYER * NCHANNELSC0; ///< the total number of readout channels for TRD
constexpr int NCHANNELSPERSECTOR = NCHANNELSTOTAL / NSECTOR;                                                   ///< then number of readout channels per sector
constexpr int NCHANNELSPERLAYER = NCHANNELSPERSECTOR / NLAYER;                                                 ///< then number of readout channels per layer
constexpr int NCPU = 4;         ///< the number of CPUs inside the TRAP chip
constexpr int NCHARGES = 3;     ///< the number of charges per tracklet (Q0/1/2)

// the values below should come out of the TRAP config in the future
constexpr int NBITSTRKLPOS = 11;                                      ///< number of bits for position in tracklet64 word
constexpr int NBITSTRKLSLOPE = 8;                                     ///< number of bits for slope in tracklet64 word
constexpr int ADDBITSHIFTSLOPE = 1 << 3;                              ///< in the TRAP the slope is shifted by 3 additional bits compared to the position
constexpr int PADGRANULARITYTRKLPOS = 40;                             ///< tracklet position is stored in units of 1/40 pad
constexpr int PADGRANULARITYTRKLSLOPE = 128;                          ///< tracklet deflection is stored in units of 1/128 pad per time bin
constexpr float GRANULARITYTRKLPOS = 1.f / PADGRANULARITYTRKLPOS;     ///< granularity of position in tracklet64 word in pad-widths
constexpr float GRANULARITYTRKLSLOPE = 1.f / PADGRANULARITYTRKLSLOPE; ///< granularity of slope in tracklet64 word in pads/timebin
constexpr int ADCBASELINE = 10;                                       ///< baseline in ADC units

// OS: Should this not be flexible for example in case of Kr calib?
constexpr int TIMEBINS = 30;            ///< the number of time bins
constexpr float MAXIMPACTANGLE = 25.f;  ///< the maximum impact angle for tracks relative to the TRD detector plane to be considered for vDrift and ExB calibration
constexpr int NBINSANGLEDIFF = 25;      ///< the number of bins for the track angle used for the vDrift and ExB calibration based on the tracking
constexpr double VDRIFTDEFAULT = 1.546; ///< default value for vDrift
constexpr double VDRIFTMIN = 0.4;       ///< min value for vDrift
constexpr double VDRIFTMAX = 2.0;       ///< max value for vDrift
constexpr double EXBDEFAULT = 0.0;      ///< default value for LorentzAngle
constexpr double EXBMIN = -0.4;         ///< min value for LorentzAngle
constexpr double EXBMAX = 0.4;          ///< max value for LorentzAngle
constexpr int NBINSGAINCALIB = 320;     ///< number of bins in the charge (Q0+Q1+Q2) histogram for gain calibration
constexpr float MPVDEDXDEFAULT = 42.;   ///< default Most Probable Value of TRD dEdx
constexpr float T0DEFAULT = 1.2;        ///< default value for t0

// array size to store incoming half cru payload.
constexpr int HBFBUFFERMAX = 1048576;                 ///< max buffer size for data read from a half cru, (all events)
constexpr unsigned int CRUPADDING32 = 0xeeeeeeee;     ///< padding word used in the cru.
constexpr int CHANNELNRNOTRKLT = 23;                  ///< this marks channels in the ADC mask which don't contribute to a tracklet
constexpr int NOTRACKLETFIT = 31;                     ///< this value is assigned to the fit pointer in case no tracklet is available
constexpr int TRACKLETENDMARKER = 0x10001000;         ///< marker for the end of tracklets in raw data, 2 of these.
constexpr int PADDINGWORD = 0xeeeeeeee;               ///< half-CRU links will be padded with this words to get an even number of 256bit words
constexpr int DIGITENDMARKER = 0x0;                   ///< marker for the end of digits in raw data, 2 of these
constexpr int MAXDATAPERLINK32 = 13824;               ///< max number of 32 bit words per link ((21x12+2+4)*64) 64 mcm, 21 channels, 10 words per channel 2 header words(DigitMCMHeader DigitMCMADCmask) 4 words for tracklets.
constexpr int MAXDATAPERLINK256 = 1728;               ///< max number of linkwords per cru link. (256bit words)
constexpr int MAXEVENTCOUNTERSEPERATION = 200;        ///< how far apart can subsequent mcmheader event counters be before we flag for concern, used as a sanity check in rawreader.
constexpr int MAXMCMCOUNT = 69120;                    ///< at most mcm count maxchamber x nrobc1 nmcmrob
constexpr int MAXLINKERRORHISTOGRAMS = 10;            ///< size of the array holding the link error plots from the raw reader
constexpr int MAXPARSEERRORHISTOGRAMS = 60;           ///< size of the array holding the parsing error plots from the raw reader
constexpr unsigned int ETYPEPHYSICSTRIGGER = 0x2;     ///< CRU Half Chamber header eventtype definition
constexpr unsigned int ETYPECALIBRATIONTRIGGER = 0x3; ///< CRU Half Chamber header eventtype definition
constexpr int MAXCRUERRORVALUE = 0x2;                 ///< Max possible value for a CRU Halfchamber link error. As of may 2022, can only be 0x0, 0x1, and 0x2, at least that is all so far(may2022).
constexpr int INVALIDPRETRIGGERPHASE = 0xf;           ///< Invalid value for phase, used to signify there is no hcheader.

} // namespace constants
} // namespace trd
} // namespace o2

#endif