RAWDataHeader.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_HEADER_RAWDATAHEADER_H
#define ALICEO2_HEADER_RAWDATAHEADER_H
 
 
#ifndef GPUCA_GPUCODE_DEVICE
#include <cstdint>
#endif
 
namespace o2
{
namespace header
{
 
 
//
struct RAWDataHeaderV7 {
  union {
    // default value
    uint64_t word0 = 0x00000000ffff4007;
    //                       | |     | version 67
    //                       | |   | 8x64 bit words = 64 (0x40) byte
    //                       | | invalid FEE id
    //                       | priority bit 0
    struct {
      uint64_t version : 8;        
      uint64_t headerSize : 8;     
      uint64_t feeId : 16;         
      uint64_t priority : 8;       
      uint64_t sourceID : 8;       
      uint64_t zero0 : 16;         
    };                             
  };                               
  union {                          
    uint64_t word1 = 0x0;          
    struct {                       
      uint32_t offsetToNext : 16;  
      uint32_t memorySize : 16;    
      uint32_t linkID : 8;         
      uint32_t packetCounter : 8;  
      uint16_t cruID : 12;         
      uint32_t endPointID : 4;     
    };                             
  };                               
  union {                          
    uint64_t word2 = 0x0;          
    struct {                       
      uint32_t bunchCrossing : 12; 
      uint32_t reserved2 : 20;     
      uint32_t orbit;              
    };                             
  };                               
  union {                          
    uint64_t word3 = 0x0;          
    struct {                       
      uint32_t dataFormat : 8;     
      uint64_t zero3 : 56;         
    };                             
  };                               
  union {                          
    uint64_t word4 = 0x0;          
    struct {                       
      uint64_t triggerType : 32;   
      uint64_t pageCnt : 16;       
      uint64_t stop : 8;           
      uint64_t zero4 : 8;          
    };                             
  };                               
  union {                          
    uint64_t word5 = 0x0;          
  };                               
  union {                          
    uint64_t word6 = 0x0;          
    struct {                       
      uint64_t detectorField : 32; 
      uint64_t detectorPAR : 16;   
      uint64_t zero6 : 16;         
    };                             
  };                               
  union {                          
    uint64_t word7 = 0x0;          
  };
};
 
//
struct RAWDataHeaderV6 {
  union {
    // default value
    uint64_t word0 = 0x00000000ffff4006;
    //                       | |     | version 6
    //                       | |   | 8x64 bit words = 64 (0x40) byte
    //                       | | invalid FEE id
    //                       | priority bit 0
    struct {
      uint64_t version : 8;        
      uint64_t headerSize : 8;     
      uint64_t feeId : 16;         
      uint64_t priority : 8;       
      uint64_t sourceID : 8;       
      uint64_t zero0 : 16;         
    };                             
  };                               
  union {                          
    uint64_t word1 = 0x0;          
    struct {                       
      uint32_t offsetToNext : 16;  
      uint32_t memorySize : 16;    
      uint32_t linkID : 8;         
      uint32_t packetCounter : 8;  
      uint16_t cruID : 12;         
      uint32_t endPointID : 4;     
    };                             
  };                               
  union {                          
    uint64_t word2 = 0x0;          
    struct {                       
      uint32_t bunchCrossing : 12; 
      uint32_t reserved2 : 20;     
      uint32_t orbit;              
    };                             
  };                               
  union {                          
    uint64_t word3 = 0x0;          
  };                               
  union {                          
    uint64_t word4 = 0x0;          
    struct {                       
      uint64_t triggerType : 32;   
      uint64_t pageCnt : 16;       
      uint64_t stop : 8;           
      uint64_t zero4 : 8;          
    };                             
  };                               
  union {                          
    uint64_t word5 = 0x0;          
  };                               
  union {                          
    uint64_t word6 = 0x0;          
    struct {                       
      uint64_t detectorField : 32; 
      uint64_t detectorPAR : 16;   
      uint64_t zero6 : 16;         
    };                             
  };                               
  union {                          
    uint64_t word7 = 0x0;          
  };
};
 
struct RAWDataHeaderV5 {
  union {
    // default value
    uint64_t word0 = 0x00000000ffff4005;
    //                       | |     | version 5
    //                       | |   | 8x64 bit words = 64 (0x40) byte
    //                       | | invalid FEE id
    //                       | priority bit 0
    struct {
      uint64_t version : 8;        
      uint64_t headerSize : 8;     
      uint64_t feeId : 16;         
      uint64_t priority : 8;       
      uint64_t zero0 : 24;         
    };                             
  };                               
  union {                          
    uint64_t word1 = 0x0;          
    struct {                       
      uint32_t offsetToNext : 16;  
      uint32_t memorySize : 16;    
      uint32_t linkID : 8;         
      uint32_t packetCounter : 8;  
      uint16_t cruID : 12;         
      uint32_t endPointID : 4;     
    };                             
  };                               
  union {                          
    uint64_t word2 = 0x0;          
    struct {                       
      uint32_t bunchCrossing : 12; 
      uint32_t reserved2 : 20;     
      uint32_t orbit;              
    };                             
  };                               
  union {                          
    uint64_t word3 = 0x0;          
  };                               
  union {                          
    uint64_t word4 = 0x0;          
    struct {                       
      uint64_t triggerType : 32;   
      uint64_t pageCnt : 16;       
      uint64_t stop : 8;           
      uint64_t zero4 : 8;          
    };                             
  };                               
  union {                          
    uint64_t word5 = 0x0;          
  };                               
  union {                          
    uint64_t word6 = 0x0;          
    struct {                       
      uint64_t detectorField : 32; 
      uint64_t detectorPAR : 16;   
      uint64_t zero6 : 16;         
    };                             
  };                               
  union {                          
    uint64_t word7 = 0x0;          
  };
};
 
struct RAWDataHeaderV4 {
  union {
    // default value
    uint64_t word0 = 0x0000ffff00004004;
    //                   | | | |     | version 4
    //                   | | | |   | 8x64 bit words
    //                   | | | | block length 0
    //                   | | invalid FEE id
    //                   | priority bit 0
    struct {
      uint64_t version : 8;        
      uint64_t headerSize : 8;     
      uint64_t blockLength : 16;   
      uint64_t feeId : 16;         
      uint64_t priority : 8;       
      uint64_t zero0 : 8;          
    };                             
  };                               
  union {                          
    uint64_t word1 = 0x0;          
    struct {                       
      uint32_t offsetToNext : 16;  
      uint32_t memorySize : 16;    
      uint8_t linkID : 8;          
      uint8_t packetCounter : 8;   
      uint16_t cruID : 12;         
      uint8_t endPointID : 4;      
    };                             
  };                               
  union {                          
    uint64_t word2 = 0x0;          
    struct {                       
      uint32_t triggerOrbit;       
      uint32_t heartbeatOrbit;     
    };                             
  };                               
  union {                          
    uint64_t word3 = 0x0;          
  };                               
  union {                          
    uint64_t word4 = 0x0;          
    struct {                       
      uint64_t triggerBC : 12;     
      uint64_t zero41 : 4;         
      uint64_t heartbeatBC : 12;   
      uint64_t zero42 : 4;         
      uint64_t triggerType : 32;   
    };                             
  };                               
  union {                          
    uint64_t word5 = 0x0;          
  };                               
  union {                          
    uint64_t word6 = 0x0;          
    struct {                       
      uint64_t detectorField : 16; 
      uint64_t par : 16;           
      uint64_t stop : 8;           
      uint64_t pageCnt : 16;       
      uint64_t zero6 : 8;          
    };
  };
  union {
    uint64_t word7 = 0x0; 
  };
};
 
struct RAWDataHeaderV2 {
  union {
    // default value
    uint64_t word0 = 0x0004ffffff000002;
    //                   | | |   |   | version 2
    //                   | | |   | block length 0
    //                   | | | invalid FEE id
    //                   | | invalid link id
    //                   | header size 4 x 64 bit
    struct {
      uint64_t version : 8;      
      uint64_t blockLength : 16; 
      uint64_t feeId : 16;       
      uint64_t linkId : 8;       
      uint64_t headerSize : 8;   
      uint64_t zero0 : 8;        
    };
  };
  union {
    uint64_t word1 = 0x0;
    struct {
      uint32_t triggerOrbit;   
      uint32_t heartbeatOrbit; 
    };
  };
  union {
    uint64_t word2 = 0x0;
    struct {
      uint64_t triggerBC : 12;   
      uint64_t triggerType : 32; 
      uint64_t heartbeatBC : 12; 
      uint64_t zero2 : 8;        
    };
  };
  union {
    uint64_t word3 = 0x0;
    struct {
      uint64_t pageCnt : 16;       
      uint64_t stop : 8;           
      uint64_t detectorField : 16; 
      uint64_t par : 16;           
      uint64_t zero3 : 8;          
    };
  };
};
 
using RAWDataHeader = RAWDataHeaderV7; // default version
using RDHLowest = RAWDataHeaderV4;     // link this to lowest version
using RDHHighest = RAWDataHeaderV7;    // link this to highest version
 
} // namespace header
} // namespace o2
 
#endif // ALICEO2_HEADER_RAWDATAHEADER_H