ngcdcsAO.hpp

Go to the documentation of this file.

#ifndef ngcdcsAO_H
#define ngcdcsAO_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/ngcdcsSENS.hpp>
#include <ngc/core/ngcdcsCLDC.hpp>
#include <ngc/core/ngcdcsSEQ.hpp>

#define ngcdcsAO_ALICE      0x00010000
#define ngcdcsAO_ALICE_REV0 0x00100000

#define ngcdcsAO_UNITY_GAIN  1

#define ngcdcsAO_MAX_GAIN    2000

#define ngcdcsAO_MAX_INITFILES 8

#define ngcdcsAO_OVRILLUM_MAXCNT 1

#define ngcdcsAO_SENS_TEMP     1  //< temperature sensor
#define ngcdcsAO_SENS_RHUM     2  //< humidity sensor
#define ngcdcsAO_SENS_PRESSURE 4  //< pressure sensor
#define ngcdcsAO_SENS_OVRILLUM 8  //< over-illumination

#define ngcdcsAO_SENS_ALL (ngcdcsAO_SENS_TEMP|ngcdcsAO_SENS_RHUM|ngcdcsAO_SENS_PRESSURE|ngcdcsAO_SENS_OVRILLUM)

struct ngcdcs_afe_chan_t {
  double gain; //< Amplifier gain (in dB)
  int clamp;   //< Clamp level 
  int input;   //< Input selection              

  ngcdcs_afe_chan_t() {
    gain = 0.0;
    clamp = 512;
    input = 0;
  }
};

struct ngcdcs_afe_t {
  int delay;   //< Serial i/o delay (ticks of 5 milliseconds)  
  int clampL;  //< Clamp enabled flag (left side)
  int clampR;  //< Clamp enabled flag (right side)
  int enabled; //< AFE enabled
  ngcdcs_afe_chan_t chan[8]; //< AFE channels

  ngcdcs_afe_t() {
    clampL = 1;
    clampR = 1;
    delay = 1;
    enabled = 1;
  }
};

struct ngcdcs_aocal_t {
  double hv1;      //< High voltage calibration point for unity gain
  double hv2;      //< High voltage 1st calibration point
  double hv3;      //< High voltage 2nd calibration point
  double hvsty1;   //< Sensitivity for unity gain calibration point (V/gain)
  double hvsty2;   //< Sensitivity for 1st gain calibration point (V/gain)
  double hvsty3;   //< Sensitivity for 2nd gain calibration point (V/gain)
  double hvprc1;   //< Precision of unity gain calibration point (%)
  double hvprc2;   //< Precision for 1st gain calibration point (%)
  double hvprc3;   //< Precision for 2nd gain calibration point (%)
  double eqOffset; //< High voltage calibration equation offset
  double eqSlope;  //< High voltage calibration equation slope
  
  ngcdcs_aocal_t() {
    hv1 = 0.0;
    hv2 = 0.0;
    hv3 = 0.0;
    hvsty1 = 1.0;
    hvsty2 = 0.1;
    hvsty3 = 0.0003;
    hvprc1 = 1.0;
    hvprc2 = 5.0;
    hvprc3 = 5.0;
    eqOffset = 20.0;
    eqSlope = 3.0;
  }
};

class ngcdcsAO_REGION {
public:
  int pol;      //< Polarity
  int yEnd;     //< End line
  int xStart;   //< Toggle start
  int xEnd;     //< Toggle end
  int tc;       //< Time constant
  
  ngcdcsAO_REGION() {pol = 1; yEnd = 0; xStart = 0; xEnd = 0; tc = 0x9;}

  virtual ~ngcdcsAO_REGION() {}
 
protected:
private:
};

class ngcdcsAO_MASK {
public:
  int pol;      //< Polarity
  int yStart;   //< Mask start
  int yEnd;     //< Mask end
  
  ngcdcsAO_MASK() {pol = 1; yStart = 0; yEnd = 0;}

  virtual ~ngcdcsAO_MASK() {}
 
protected:
private:
};

class ngcdcsAO_PAT {
public:
  int pol;      //< Polarity
  int xStart;   //< Toggle start
  int xEnd;     //< Toggle end
  
  ngcdcsAO_PAT() {pol = 1; xStart = 0; xEnd = 0;}

  virtual ~ngcdcsAO_PAT() {}
 
protected:
private:
};

class ngcdcsAO_RMP {
public:
  ngcdcsAO_REGION region[7];   //< Regions
  ngcdcsAO_MASK   mask[3];     //< Masks
  ngcdcsAO_PAT    pat;         //< Pattrn
  
  ngcdcsAO_RMP() {
    region[0].yEnd = 0x1fff;
    region[0].xEnd = 0xffff;
  }

  virtual ~ngcdcsAO_RMP() {}

  int MsbMask() {
    int i;
    int msb = 0x0;
    for (i=0;i<3;i++)
      {
      msb |= ((mask[i].yStart >> 12) & 0x1) << (i * 2);
      msb |= ((mask[i].yEnd >> 12) & 0x1) << ((i * 2) + 1);
      }
    return (msb);
  }

  int MsbPat() {
    int msb = 0x0;
    msb |= ((pat.xStart >> 12) & 0xf);
    msb |= ((pat.xEnd >> 12) & 0xf) << 4;
    return (msb);
  }

  int MsbY() {
    int i;
    int msb = 0x0;
    for (i=0;i<7;i++) msb |= ((region[i].yEnd >> 12) & 0x1) << i;
    return (msb);
  }

  int RegMsbX1(int idx) {
    if ((idx == 0) || (idx == 1)) return (0);
    else if (idx == 2) return (1);
    else if ((idx == 3) || (idx == 4)) return (2);
    else if (idx == 5) return (3);
    else if (idx == 6) return (4);
    else return (5);
  }
  
  int MsbX1(int idx) {return MsbX(RegMsbX1(idx));}

  int RegMsbX2(int idx) {
    if (idx == 0) return (0);
    else if ((idx == 1) || (idx == 2)) return (1);
    else if (idx == 3) return (2);
    else if ((idx == 4) || (idx == 5)) return (3);
    else if (idx == 6) return (4);
    else return (5);
  }
  
  int MsbX2(int idx) {return MsbX(RegMsbX2(idx));}

  int MsbX(int idx) {
    int msb = 0x0;
    if (idx == 0)
      {
      msb |= (region[0].xStart >> 12) & 0xf;
      msb |= ((region[0].xEnd >> 12) & 0xf) << 4;
      msb |= ((region[1].xStart >> 12) & 0xf) << 8;
      }
    else if (idx == 1)
      {
      msb |= (region[1].xEnd >> 12) & 0xf;
      msb |= ((region[2].xStart >> 12) & 0xf) << 4;
      msb |= ((region[2].xEnd >> 12) & 0xf) << 8;
      }
    else if (idx == 2)
      {
      msb |= (region[3].xStart >> 12) & 0xf;
      msb |= ((region[3].xEnd >> 12) & 0xf) << 4;
      msb |= ((region[4].xStart >> 12) & 0xf) << 8;
      }
    else if (idx == 3)
      {
      msb |= (region[4].xEnd >> 12) & 0xf;
      msb |= ((region[5].xStart >> 12) & 0xf) << 4;
      msb |= ((region[5].xEnd >> 12) & 0xf) << 8;
      }
    else if (idx == 4)
      {
      msb |= (region[6].xStart >> 12) & 0xf;
      msb |= ((region[6].xEnd >> 12) & 0xf) << 4;
      }
    return (msb);
  }

  int Pol() {
    int i;
    int pol = 1 << 7;
    for (i=0;i<7;i++) pol |= (region[i].pol & 0x1) << i;
    pol |= (pat.pol & 0x1) << 8;
    for (i=0;i<3;i++) pol |= (mask[i].pol & 0x1) << (i + 9);
    return (pol);
  }
  
protected:
private:
};

class ngcdcsAO: public ngcbMOD
{
public:
  explicit ngcdcsAO(const ngcb_route_t &r);

  ngcdcsAO(ngcbIFC *ifc, const ngcb_route_t &r);      

  virtual ~ngcdcsAO();
  
  char initFile[ngcdcsAO_MAX_INITFILES][256];
  
  char resetFile[ngcdcsAO_MAX_INITFILES][256];
  
  int hwRev;

  int autoStart; 

  ngcdcsSHTx_TEMP temp;
  
  ngcdcsSHTx_RHUM rhum;

  ngcdcsMPL115A pressure;

  int master;

  int dataLink;

  int serialLink;

  int gain;

  int maxGain;

  int overIllumination;

  int rstStart;

  int expAbort;

  int sensEnabled;

  int sensPrefill;

  double sensSettleTime;

  int shpWidth;

  int delay[42]; 

  double reDelay[8];

  double feDelay[8];

  double vsph[4];

  double viph[4];

  int nx;

  int ny;

  ngcdcsAO_RMP rmp;
  
  int hvChan[4];

  ngcdcs_aocal_t calib[4];

  char pixMask[256];

  ngcdcs_afe_t afe;

  ngcdcsCLDC *cldc;            

  ngcdcsSEQ *seq;
  
  void Reset(); 

  int Enable(int check = 1);

  int Disable();

  int Selftest();

  virtual int AtStop(); 

  virtual int AfterStop(); 

  virtual int AtStart(); 

  virtual int AutoStart(); 

  int CkAddrCB(int addr, const int *buffer, int size);

  void WrAddrCB(int addr, const int *buffer, int size);

  virtual int Update(int sensor, int force = 0);

  int CheckOvrIllum();

  int ResetHead(); 

  int ResetSensors(int errFlag = 0); 

  int ResetRHum();

  int ResetTemp();

  int ResetPressure();

  int ResetOvrIllum(); 

  int SensorError(int sensor);

  int ResetAfe(int update = 1);

  int Master(int flag);

  int DataLink(int flag);

  int SerialLink(int flag);

  int Gain(int value); 

  int Gain(int quadrant, int value);

  int Delay(int idx, int ticks); 

  int VoltageIPhase(int idx, double volt);
  
  int VoltageSPhase(int idx, double volt);  

  int Dim(int x, int y);

  int DimX(int x);

  int DimY(int y);

  unsigned int FrameCnt();

  double FrameRate();
  
  int Shift(int clkNum, int shift, int edge, int force = 0);

  int GetClk(int clkNum, int patNum, char *clkString);

  int AmpGain(int channel, double value);

  int Clamp(int channel, int level);

  int ClampOn(int side, int flag);

  int Input(int channel, int input);

  int CtrlReg() {return (ctrlReg_);}

  int SetupKey(const char *key, const int *idx, const char *value, 
           int *status = NULL);

  int StatusKey(const char *key, const int *idx, char *value, 
        int *status = NULL);
 
protected: 
 
private:
  struct timeval timeReset_;

  int aliceCtrl_;

  int ctrlReg_;               

  int delayReg1_;               

  int delayReg2_;               

  int delayReg3_;               

  int delayReg4_;               

  int delayReg5_;               

  int phCtrlReg_;               

  int levelIPhaseReg_; 

  int levelSPhaseReg_;

  int overIlluminationCnt_;

  unsigned int aliceAdc_[4];

  ngcbALARM *overIlluminationAlarm_;

  void Init_();                

  void Log_(const char *msg);

  int LvlIPhase2Reg_(double volt);

  int LvlSPhase2Reg_(double volt);

  double Reg2LvlIPhase_(int value);
      
  double Reg2LvlSPhase_(int value);

  int UpdateSensors_(int sensor, int force);

  int WrAdc_(int adc, int chan, int addr, int value);

  int WrAdc_(int addr, int value);

  int AlInitRMP_();
  
  int RcpEndY_(int idx, int value);

  int RcpStartX_(int idx, int value);

  int RcpEndX_(int idx, int value);

  int RcpTC_(int idx, int value);

  int RcpPol_(int idx, int value);\
  
  int MaskStartY_(int idx, int value);

  int MaskEndY_(int idx, int value);

  int MaskPol_(int idx, int value);
  
  int PatStartX_(int value);

  int PatEndX_(int value);

  int PatPol_(int value);

  int CalibDelays_();
};
 
#endif