LSDelayChipV1.h

Go to the documentation of this file.

//$Id: LSDelayChipV1.cpp,v 1.0 2013/11/11 13:11:24 jmauricio Exp $
//------------------------------------------------------------------------------
//
//  Package    : LSDelayChipV1
//
//  Description:
//
//  Author(s)  : Joan Mauricio
//  Date       : 2013/11/11
//
//------------------------------------------------------------------------------

#ifndef __LSDelayChipV1_H_
#define __LSDelayChipV1_H_

#include "Element.h"
#include "Register.h"
#include <stdlib.h> 

//Delay Line (standalone) SPI @ mapping.
//Integrator + Track & Hold Clock configuration registers.
#define INT_TH_0_CONFREG_ADDR   0x00
#define INT_TH_1_CONFREG_ADDR   0x02
#define INT_TH_2_CONFREG_ADDR   0x10
#define INT_TH_3_CONFREG_ADDR   0x12
//ADC Clock configuration registers.
#define ADC_0_CONFREG_ADDR      0x01
#define ADC_1_CONFREG_ADDR      0x03
#define ADC_2_CONFREG_ADDR      0x11
#define ADC_3_CONFREG_ADDR      0x13
//DLL channel status registers.
#define DLL_0_STATREG_ADDR      0xA0
#define DLL_1_STATREG_ADDR      0xA1
#define DLL_2_STATREG_ADDR      0xB0
#define DLL_3_STATREG_ADDR      0xB1

//SPI commands.
#define CHARGEPUMP_SOFT_RST     0x40
#define SC_MOSI_MISO_BYPASS     0xFF

    typedef unsigned long  U32;
    typedef unsigned short U16;
    typedef unsigned char  U8;

    struct confRegData{
        bool lvdsOutEn;
        bool nVControlEn;
        bool padDebug;
        U8   phaseInt;
        U8   phaseTaHAdc;
        U8 locus;
    };

    struct statRegData{
        bool dllLocked;
        bool warningDllFast;
        bool errorDllSlow;
    };

    typedef enum 
      {
        LOCUS_3000_UA = 0,            // 3.0 mA
        LOCUS_1400_UA = 1,            // 1.4 mA
        LOCUS_2300_UA = 2,            // 2.3 mA
        LOCUS_0350_UA = 3            // .35 mA
      } LVDS_OUTPUT_CURRENT_SELECTOR;

class LSDelayChipV1 : public Element {
public:

    LSDelayChipV1(){
        setType("LSDelayChipV1");
        setId(0);

        add(Attrib::ELEMENT); add (Attrib::HARDWARE);
        debug("LSDelayChipV1 built.","LSDelayChipV1::LSDelayChipV1");

        m_regConfig=new Register();
        m_regStatus=new Register();

        m_regConfig->setName("ConfigRegister");
        m_regStatus->setName("StatusRegister");

        m_regConfig->io()->setSubAddress(9);    
        m_regStatus->io()->setSubAddress(19);

        m_regConfig->io()->defDataU8(3);    
        m_regStatus->io()->defDataU8(2);

        m_regConfig->io()->setWordSize(IOdata::Byte);
        m_regStatus->io()->setWordSize(IOdata::Byte);

        addChild(m_regConfig);
        addChild(m_regStatus);
        m_configAddr = 0xEE;
    }
    
    //Core functions: access to configuration registers.
    //Bulk R/W      : 'naked' bits.
    //Set / Get     : confRegData struct is used to store values.
    void configRegBulkRead          (U8 confRegAddr);
    void configRegBulkWrite         (U8 confRegAddr, U16 confRegData);
    void getConfigReg               (U8 confRegAddr);
    void setConfigReg               (U8 confRegAddr, confRegData d);
 
    //Safe way to write single data within the registers.
    void setConfigRegPhaseADC       (U8 confRegAddr, U8 phaseADC);
    void setConfigRegPhaseTH        (U8 confRegAddr, U8 phaseTH );
    void setConfigRegPhaseINT       (U8 confRegAddr, U8 phaseINT); 
    void setConfigRegLVDSOutEn      (U8 confRegAddr, bool en);
    void setConfigRegDebugMode      (U8 confRegAddr, bool en);
    void setConfigRegVControlOutEn  (U8 confRegAddr, bool en);
    void setConfigRegLOCUS          (U8 confRegAddr, U8 locus);        

    //Commands:
    void resetPumps();
    void bypassMisoMosi(U16 writeData); 
 
    //FER (Frame Error Rate) Test.
    void spiBERTest(U8 confRegAddr, long nFrames);    
 
    //Shows the content of the last polled configuration register.
    void showConfig();

  ~LSDelayChipV1(){
  }

  void help() { info("LSDelayChipV1 "+name()+". No help.","LSDelayChipV1::help"); };

  StatusCode init() {
    return StatusCode::SUCCESS;
  };
  
  void reset();

  void update () {
    
  };

  void setAddress(U8 address){
    m_address=address;
    m_regConfig->setAddress(m_address);
    m_regStatus->setAddress(m_address);
  }

private:

  Register*         m_regConfig;
  Register*         m_regStatus;
  U8                m_address;
  
  U16               m_rxConfigBits;
  confRegData       m_rxConfig;
  U8                m_configAddr;
  
  long              m_nBad;
  double            m_fer;
  
    bool checkConfigAddr(U8 addr)
    {
         bool ok = false;
         ok |= (addr == INT_TH_0_CONFREG_ADDR); 
         ok |= (addr == INT_TH_1_CONFREG_ADDR);
         ok |= (addr == INT_TH_2_CONFREG_ADDR);
         ok |= (addr == INT_TH_3_CONFREG_ADDR);     
         ok |= (addr == ADC_0_CONFREG_ADDR); 
         ok |= (addr == ADC_1_CONFREG_ADDR);
         ok |= (addr == ADC_2_CONFREG_ADDR);
         ok |= (addr == ADC_3_CONFREG_ADDR);
         if(ok) debug("The address @" + itos(addr) + " is valid.");
         else   debug("The address @" + itos(addr) + " is not valid.");
         return ok;           
    }

    bool checkStatusAddr(U8 addr)
    {
         bool ok = false;  
         ok |= (addr == DLL_0_STATREG_ADDR); 
         ok |= (addr == DLL_1_STATREG_ADDR);
         ok |= (addr == DLL_2_STATREG_ADDR);
         ok |= (addr == DLL_3_STATREG_ADDR);  
         if(ok) debug("The address @" + itos(addr) + " is valid.");
         else   debug("The address @" + itos(addr) + " is not valid.");      
         return ok;           
    }
    
    std::string itohs(U16 value)
    {
        char buff[32];
        sprintf(buff,"%04X",value);
        return std::string(buff);
    }
};

#endif