ngcdcsSCA.hpp

Go to the documentation of this file.

#ifndef ngcdcsSCA_H
#define ngcdcsSCA_H
 
 
#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif
 
#include <ngc/core/ngcbAddr.h>
#include <ngc/core/ngcbMOD.hpp>
#include <ngc/core/ngcbPARAM.hpp>
 
#include <ngc/core/ngcdcsSEQ.hpp>
#include <ngc/core/ngcdcsCLDC.hpp>

struct ngcdcs_mc_block_t {
  int addr;  //< Start address
  int *data; //< Register data  
  int len;   //< Block length             
 
  ngcdcs_mc_block_t &operator=(const ngcdcs_mc_block_t &other) {
    if (this != &other)
      {
      addr = other.addr;
      len = other.len;
      data = (int *)malloc(len * sizeof(int));
      if (data != NULL) memcpy(data, other.data, len * sizeof(int));
      else len = 0;
      }
    return (*this);
  }

  ngcdcs_mc_block_t(const ngcdcs_mc_block_t &other) {
    addr = other.addr;
    len = other.len;
    data = (int *)malloc(len * sizeof(int));
    if (data != NULL) memcpy(data, other.data, len * sizeof(int));
    else len = 0;
  }

  ngcdcs_mc_block_t(int a, int n) {
    addr = a;
    data = (int *)malloc(n * sizeof(int));
    if (data != NULL) len = n;
    else len = 0;
  }

  ~ngcdcs_mc_block_t() {
    if (data != NULL) free(data);
  }
};
 

#define ngcdcsSCA_NUM_EXT_BIAS 20

#define ngcdcsSCA_NUM_INT_BIAS 8

#define ngcdcsSCA_NUM_BIAS (ngcdcsSCA_NUM_EXT_BIAS + ngcdcsSCA_NUM_INT_BIAS)
 
/*
 * Exposure modes
 */
#define ngcdcsSCA_MODE_RAMP    0x0  //< up-the-ramp
#define ngcdcsSCA_MODE_FOWLER  0x1  //< fowler-mode
 
/*
 * Idle modes
 */
#define ngcdcsSCA_IDLE_SKIP    0x0  //< skip
#define ngcdcsSCA_IDLE_RST     0x1  //< reset
#define ngcdcsSCA_IDLE_RSTRD   0x2  //< reset-read

struct ngcdcs_sca_exp_t {
  int nrst;                //< Number of reset-frames (0x4000)
  int nrd;                 //< Number of read-frames per group (0x4001)
  int nrmp;                //< Number of exposure ramps (0x4003)
  int ngrp;                //< Number of groups per ramp (0x4004)
  int ndrop;               //< Number of drop frames per group (0x4005)
  int rowEndDelay;         //< Extra pixels at end of row (0x4006)
  int frameEndDelay;       //< Extra rows at end of frame (0x4007) 
  int rstOut;              //< Enable reset-frame data output (0x4002 bit0)
  int clkDrop;             //< Clock ASIC in drop-frames (0x4002 bit2) 
  int idleMode;            //< Idle mode (None, Rst, RstRd) (0x4002 bit3-4) 
  int expMode;             //< Fowler or up-the-ramp (0x4018)
  unsigned int tFowlerExp; //< Fowler exposure time (0x400a + 65536 * 0x400b)
  int enhancedClk;         //< Enhanced clocking (0x4017 bit 0)
  int globalReset;         //< Global reset (0x4017 bit 1)
  int nexp;                //< Number of exposure ramps used               
  int nrst_x;              //< Number of reset-frames changed
  int nrd_x;               //< Number of read-frames per group changed
  int nrmp_x;              //< Number of exposure ramps changed
  int ngrp_x;              //< Number of groups per ramp changed
  int ndrop_x;             //< Number of drop frames per group changed
  int rowEndDelay_x;       //< Extra pixels at end of row changed
  int frameEndDelay_x;     //< Extra rows at end of frame changed
  int rstOut_x;            //< Enable reset-frame data output changed
  int clkDrop_x;           //< Clock ASIC in drop-frames changed
  int idleMode_x;          //< Idle mode changed
  int expMode_x;           //< Fowler or up-the-ramp changed
  int tFowlerExp_x;        //< Fowler exposure time changed
  int enhancedClk_x;       //< Enhanced clocking changed
  int globalReset_x;       //< Global reset changed

  ngcdcs_sca_exp_t() {
    nrst = 1;
    nrd = 2;
    nrmp = 1;
    ngrp = 1;
    ndrop = 0;
    rowEndDelay = 2;
    frameEndDelay = 0;
    idleMode = ngcdcsSCA_IDLE_RST;
    clkDrop = 1;
    rstOut = 0;
    expMode = ngcdcsSCA_MODE_RAMP;
    tFowlerExp = 0;
    nexp = nrmp;
    enhancedClk = 0;
    globalReset = 0;
    
    nrst_x = 0; nrd_x = 0; nrmp_x = 0; ngrp_x = 0;  ndrop_x = 0; 
    rowEndDelay_x = 0; frameEndDelay_x = 0;
    rstOut_x = 0; clkDrop_x = 0; idleMode_x = 0;    
    expMode_x = 0; tFowlerExp_x = 0;
    enhancedClk_x = 0;  globalReset_x = 0;    
  }
};

struct ngcdcs_sca_pa_t {
  int cold;        //< Detector is cold (0x4015)
  int kTCRemove;   //< Remove preamplifier kTC noise (0x4016 bit0)
  int rowReset;    //< Reset preamplifier once per row (0x4016 bit1)
  int gain;        //< Preamplifier gain (0x401a)  
  int cold_x;      //< Detector is cold flag changed
  int kTCRemove_x; //< Remove preamplifier kTC noise flag changed
  int rowReset_x;  //< Reset preamplifier once per row flag changed
  int gain_x;      //< Preamplifier gain changed  

  ngcdcs_sca_pa_t() {
    cold = 0;
    kTCRemove = 1;
    rowReset = 1;
    gain = 12;
    cold_x = 0; kTCRemove_x = 0; rowReset_x = 0; gain_x = 0;
  }
};

class ngcdcsSCA: public ngcdcsSEQ0
{
public:
  explicit ngcdcsSCA(const ngcb_route_t &r);

  ngcdcsSCA(ngcbIFC *ifc, const ngcb_route_t &r);
      
  ngcdcsSCA(const ngcb_route_t &r, ngcbPARAM_LIST *p);

  ngcdcsSCA(ngcbIFC *ifc, const ngcb_route_t &r, ngcbPARAM_LIST *p);

  virtual ~ngcdcsSCA();     

  int id;

  int flags;

  char mcFile[256]; 
 
  int packetSize; 

  int rxDelay;                     

  ngcdcs_sca_exp_t expParam;          

  ngcdcs_sca_pa_t paParam;          
 

  void Reset(); 
               
  int Enable(int check = 1);

  int Disable();

  int Selftest();                  
 
  
  /*
   * ASIC register I/O
   */
  
  int Read(int addr, int *buffer, int size, int lw = -1);

  int RdReg(int addr, int *value, int lw = -1);
 
  int Write(int addr, int *buffer, int size);

  int WrReg(int addr, int value);                 
 
 
  /*
   * Configuration and parameters
   */

  int UploadMcFile(const char *fileName);

  int Reconfigure(); 

  int PacketSize(int n); 

  int Delay(int n);

  int Update();   

  int Window(ngcdcs_win_t w);        

  int ScaSetup(const char *key, const int *idx, const char *value, int *update,
           int *handled = NULL);

  int ScaStatus(const char *key, const int *idx, char *value, 
        int *handled = NULL); 
 
  /*
   * Run-control
   */
  
  // Start clocking
  int Start(); 
 
  // Stop clocking
  int Stop(int align, int force = 0);           
 
  /*
   * Status
   */

  char *StatusString(); 

  int Status(int *hwStat); 

  void NewStatus(int newStatus);             

  int RunningState() {
    return ((status != ngcdcsSEQ_STAT_IDLE) && 
        (status != ngcdcsSEQ_STAT_FAILURE));
    }

  int FailureState() {return (status == ngcdcsSEQ_STAT_FAILURE);}
  
  virtual int LookupCB(const char *name, char *value); 
 
 
  /*
   * Sequencer setup
   */

  int LoadPrgFile(const char *name = NULL);

  int ClearPrgFile();

  int Preset(const char *key, const char *value, int *handled=NULL);

  int Setup(); 

  int NewSetup();                             
 
 
  /*
   * CLDC setup
   */

  int OutputEnable();

  int OutputDisable();

  int Snapshot();

  int VoltageDC(int num, double volt, int rangeCheck=1);

  int TelDC(int chan, double *volt);

  int VSetup(int autoCtrl = 0);

  char *VStatusString();

  int LoadCfgFile(const char *fileName = NULL);

  int SaveCfgFile(const char *fileName);

  int Restore(const char *keyWord);
 
protected: 
 
private:
  void Init_(); 

  int Initialize_();            

  char statStr_[32]; 

  int online_;                  
 
 
  /*
   * Parameter list
   */

  ngcbPARAM_LIST *paramList_;

  void UpdateParamList_();

  void DetachParamList_();

  int paramAttached_;           

  int dataIfc_;
 
 
  /*
   * Microcode
   */

  int LdCode_(const char *fileName);

  int CodeLevel_();

  int noReConf_;                
 
 
  /*
   * Sequencer setup
   */

  ngcdcs_sca_exp_t expParam_;

  int RdExp_();

  int UploadSetup_();

  int Setup_(ngcbPARAM_LIST *list);

  void AddSeqIdx_(char *keyWord);

  void DelSeqIdx_(char *keyWord);

  void AddScaIdx_(char *keyWord);

  void DelScaIdx_(char *keyWord); 

  int Lookup_(const char *, char *);

  int LoadPrg_(const char *); 

  int Script_(const char *shell, const char *script, FILE *dbg,
          ngcdcs_key_assign_t *defParam, int numDefParam,
          ngcdcs_key_assign_t *newParam, int *numNewParam);

  int GetFrameTime_();

  void UpdateExpTime_();

  double pixTime_;  

  double tRead_;

  double tReset_; 

  int frameMode_;                     
 
 
  /*
   * CLDC setup
   */

  char vstatStr_[32];

  int fileBufferLen_;

  char fileBuffer_[ngcdcsCLDC_BUFSIZE];

  int LoadCfg_(const char *restoreKey, const char *tmpFile);

  void DefaultVoltages_(); 
                  
  int RdVolt_();

  int Reg2Volt_(int chan, double *v, int force = 1);

  int Volt2Reg_(int chan, double v);

  double dcSave_[ngcbCLDC_MAX_DC];

  void Mirror_(int addr, int *buffer, int size);
             
  int useRegMirror_;                         
 
 
  /*
   * Preamplifier setup
   */

  ngcdcs_sca_pa_t paParam_;

  int RdPreAmp_();                    
  
};
 
 
#endif