MRMCML Class Reference

#include <drvemCML.h>

Inheritance diagram for MRMCML:

Collaboration diagram for MRMCML:

Public Types
enum	outkind { typeCML, typeTG300, typeTG203 }
Public Types inherited from CML
enum	pattern {   patternWaveform, patternRise, patternHigh, patternFall,   patternLow }
Public Types inherited from mrf::Object
typedef m_obj_children_t::const_iterator	child_iterator
typedef std::map< std::string, std::string >	create_args_t
typedef Object *(*	create_factory_t) (const std::string &name, const std::string &klass, const create_args_t &args)

Public Member Functions
	MRMCML (const std::string &, unsigned char, EVRMRM &, outkind, formFactor)
virtual	~MRMCML ()
virtual void	lock () const OVERRIDE FINAL
virtual void	unlock () const OVERRIDE FINAL
virtual cmlMode	mode () const OVERRIDE FINAL
virtual void	setMode (cmlMode) OVERRIDE FINAL
virtual bool	enabled () const OVERRIDE FINAL
virtual void	enable (bool) OVERRIDE FINAL
virtual bool	inReset () const OVERRIDE FINAL
virtual void	reset (bool) OVERRIDE FINAL
virtual bool	powered () const OVERRIDE FINAL
virtual void	power (bool) OVERRIDE FINAL
virtual epicsUInt32	freqMultiple () const OVERRIDE FINAL
	Speed of CML clock as a multiple of the event clock. More...
virtual double	fineDelay () const OVERRIDE FINAL
	delay by fraction of one event clock period. Units of sec More...
virtual void	setFineDelay (double) OVERRIDE FINAL
virtual bool	polarityInvert () const OVERRIDE FINAL
	Trigger level. More...
virtual void	setPolarityInvert (bool) OVERRIDE FINAL
virtual epicsUInt32	countHigh () const OVERRIDE FINAL
virtual epicsUInt32	countLow () const OVERRIDE FINAL
virtual epicsUInt32	countInit () const OVERRIDE FINAL
virtual void	setCountHigh (epicsUInt32) OVERRIDE FINAL
virtual void	setCountLow (epicsUInt32) OVERRIDE FINAL
virtual void	setCountInit (epicsUInt32) OVERRIDE FINAL
virtual double	timeHigh () const OVERRIDE FINAL
virtual double	timeLow () const OVERRIDE FINAL
virtual double	timeInit () const OVERRIDE FINAL
virtual void	setTimeHigh (double) OVERRIDE FINAL
virtual void	setTimeLow (double) OVERRIDE FINAL
virtual void	setTimeInit (double) OVERRIDE FINAL
virtual bool	recyclePat () const OVERRIDE FINAL
virtual void	setRecyclePat (bool) OVERRIDE FINAL
virtual epicsUInt32	lenPattern (pattern) const OVERRIDE FINAL
virtual epicsUInt32	lenPatternMax (pattern) const OVERRIDE FINAL
virtual epicsUInt32	getPattern (pattern, unsigned char *, epicsUInt32) const OVERRIDE FINAL
virtual void	setPattern (pattern, const unsigned char *, epicsUInt32) OVERRIDE FINAL
Public Member Functions inherited from CML
	CML (const std::string &n)
virtual	~CML ()=0
template<pattern P>
epicsUInt32	lenPattern () const
template<pattern P>
epicsUInt32	lenPatternMax () const
template<pattern P>
epicsUInt32	getPattern (unsigned char *b, epicsUInt32 l) const
template<pattern P>
void	setPattern (const unsigned char *b, epicsUInt32 l)
void	setModRaw (epicsUInt16 r)
epicsUInt16	modeRaw () const
Public Member Functions inherited from mrf::ObjectInst< CML >
virtual propertyBase *	getPropertyBase (const char *pname, const std::type_info &ptype)
virtual void	visitProperties (bool(*cb)(propertyBase *, void *), void *arg)
Public Member Functions inherited from mrf::Object
const std::string &	name () const
const Object *	parent () const
child_iterator	beginChild () const
child_iterator	endChild () const
template<typename P >
mrf::auto_ptr< property< P > >	getProperty (const char *pname)

Additional Inherited Members
Static Public Member Functions inherited from mrf::ObjectInst< CML >
static int	initObject ()
Static Public Member Functions inherited from mrf::Object
static Object *	getObject (const std::string &name)
static Object *	getCreateObject (const std::string &name, const std::string &klass, const create_args_t &args=create_args_t())
static void	addFactory (const std::string &klass, create_factory_t fn)
static void	visitObjects (bool(*)(Object *, void *), void *)
Protected Member Functions inherited from mrf::ObjectInst< CML >
	ObjectInst (const std::string &n)
	ObjectInst (const std::string &n, A &a)
virtual	~ObjectInst ()
Protected Member Functions inherited from mrf::Object
	Object (const std::string &n, const Object *par=0)
virtual	~Object ()=0

Detailed Description

Definition at line 20 of file drvemCML.h.

Member Enumeration Documentation

outkind

enum MRMCML::outkind

Enumerator
typeCML
typeTG300
typeTG203

Definition at line 23 of file drvemCML.h.

{ typeCML, typeTG300, typeTG203 };

Constructor & Destructor Documentation

MRMCML()

MRMCML::MRMCML	(	const std::string &	n,
		unsigned char	i,
		EVRMRM &	o,
		outkind	k,
		formFactor	f
	)

Definition at line 25 of file drvemCML.cpp.

  :CML(n)
  // CML word length
  ,mult(f==formFactor_CPCIFULL || f==formFactor_mTCA ? 40 : 20)
  // # of 32-bit dwords used to store 1 CML word
  // 40 bits fit in 2 dwords, 20 bits fit in 1
  ,wordlen(f==formFactor_CPCIFULL || f==formFactor_mTCA ? 2 : 1)
  ,base(o.base)
  ,N(i)
  ,owner(o)
  ,shadowEnable(0)
  ,shadowWaveformlength(0)
  ,kind(k)
{
    epicsUInt32 val=READ32(base, OutputCMLEna(N));

    val&=~OutputCMLEna_type_mask;

    switch(kind) {
    case typeCML: break;
    case typeTG203: val|=OutputCMLEna_type_203; break;
    case typeTG300: val|=OutputCMLEna_type_300; break;
    default:
        throw std::invalid_argument("Invalid CML kind");
    }

    for(size_t i=0; i<NELEMENTS(shadowPattern); i++) {
        epicsUInt32 L = wordlen * (lenPatternMax((pattern)i)/mult);
        shadowPattern[i] = new epicsUInt32[L];
        std::fill(shadowPattern[i], shadowPattern[i]+L, 0);
    }

    shadowEnable=val;
}

~MRMCML()

MRMCML::~MRMCML ( )

virtual

Definition at line 60 of file drvemCML.cpp.

{
    for(size_t i=0; i<NELEMENTS(shadowPattern); i++)
        delete[] shadowPattern[i];
}

Member Function Documentation

countHigh()

epicsUInt32 MRMCML::countHigh ( ) const

virtual

Implements CML.

Definition at line 210 of file drvemCML.cpp.

{
    epicsUInt32 val = READ32(base, OutputCMLCount(N));
    val >>= OutputCMLCount_high_shft;
    return val & OutputCMLCount_mask;
}

countInit()

epicsUInt32 MRMCML::countInit ( ) const

virtual

Implements CML.

Definition at line 227 of file drvemCML.cpp.

{
    epicsUInt32 v = shadowEnable & OutputCMLEna_ftrig_mask;
    return v >> OutputCMLEna_ftrig_shft;
}

countLow()

epicsUInt32 MRMCML::countLow ( ) const

virtual

Implements CML.

Definition at line 218 of file drvemCML.cpp.

{
    epicsUInt32 val = READ32(base, OutputCMLCount(N));
    val >>= OutputCMLCount_low_shft;
    return val & OutputCMLCount_mask;
}

enable()

void MRMCML::enable ( bool  s )

virtual

Implements CML.

Definition at line 132 of file drvemCML.cpp.

{
    if(s)
        shadowEnable |= OutputCMLEna_ena;
    else
        shadowEnable &= ~OutputCMLEna_ena;
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

enabled()

bool MRMCML::enabled ( ) const

virtual

Implements CML.

Definition at line 126 of file drvemCML.cpp.

{
    return shadowEnable&OutputCMLEna_ena;
}

fineDelay()

double MRMCML::fineDelay ( ) const

virtual

delay by fraction of one event clock period. Units of sec

Implements CML.

Definition at line 174 of file drvemCML.cpp.

{
    // The GTX output fine delay is an external chip
    // and not related to the clock frequency.
    // So just scale it to [0, 1) and use ESLO for the
    // actual calibration
    return READ32(base, GTXDelay(N))/1024.0;
}

freqMultiple()

virtual epicsUInt32 MRMCML::freqMultiple ( ) const

inlinevirtual

Speed of CML clock as a multiple of the event clock.

Implements CML.

Definition at line 43 of file drvemCML.h.

{return mult;}

getPattern()

epicsUInt32 MRMCML::getPattern ( pattern  p, unsigned char *  buf, epicsUInt32  blen  ) const

virtual

Implements CML.

Definition at line 351 of file drvemCML.cpp.

{
    epicsUInt32 plen=lenPattern(p);

    // number of bytes of 'buf' to fill
    blen = std::min(plen, blen);

    epicsUInt32 val=0;
    for(epicsUInt32 i=0; i<blen; i++) {
        size_t cmlword = (i/mult);
        size_t cmlbit  = (i%mult);

        size_t cpuword, cpubit;
        bool first; // first bit in CPU word

        if(mult<32) {
            first = cmlbit==0;
            cpuword = cmlword;
            cpubit = 19 - cmlbit;
        } else {
            first = cmlbit==0 || cmlbit==8;
            cpuword = 2*cmlword + (cmlbit<8 ? 0 : 1);
            cpubit  = cmlbit<8 ? 7-cmlbit : 31-(cmlbit-8);
        }

        if(first) {
            val=shadowPattern[p][cpuword];
        }

        buf[i]=val>>cpubit;
        buf[i]&=0x1;

    }
    return blen;
}

inReset()

bool MRMCML::inReset ( ) const

virtual

Implements CML.

Definition at line 142 of file drvemCML.cpp.

{
    return (shadowEnable & OutputCMLEna_rst) != 0;
}

lenPattern()

epicsUInt32 MRMCML::lenPattern ( pattern  p ) const

virtual

Implements CML.

Definition at line 333 of file drvemCML.cpp.

{
    if(p==patternWaveform)
        return mult*shadowWaveformlength;
    else
        return mult;
}

lenPatternMax()

epicsUInt32 MRMCML::lenPatternMax ( pattern  p ) const

virtual

Implements CML.

Definition at line 342 of file drvemCML.cpp.

{
    if(p==patternWaveform)
        return mult*OutputCMLPatLengthMax;
    else
        return mult;
}

lock()

void MRMCML::lock ( ) const

virtual

Implements mrf::Object.

Definition at line 66 of file drvemCML.cpp.

{owner.lock();};

mode()

cmlMode MRMCML::mode ( ) const

virtual

Implements CML.

Definition at line 70 of file drvemCML.cpp.

{
    switch(shadowEnable&OutputCMLEna_mode_mask) {
    case OutputCMLEna_mode_orig:
        return cmlModeOrig;
    case OutputCMLEna_mode_freq:
        return cmlModeFreq;
    case OutputCMLEna_mode_patt:
        return cmlModePattern;
    default:
        return cmlModeInvalid;
    }
}

polarityInvert()

bool MRMCML::polarityInvert ( ) const

virtual

Trigger level.

Implements CML.

Definition at line 204 of file drvemCML.cpp.

{
    return (shadowEnable & OutputCMLEna_ftrg) != 0;
}

power()

void MRMCML::power ( bool  s )

virtual

Implements CML.

Definition at line 164 of file drvemCML.cpp.

{
    if(!s)
        shadowEnable |= OutputCMLEna_pow;
    else
        shadowEnable &= ~OutputCMLEna_pow;
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

powered()

bool MRMCML::powered ( ) const

virtual

Implements CML.

Definition at line 158 of file drvemCML.cpp.

{
    return !(shadowEnable & OutputCMLEna_pow);
}

recyclePat()

bool MRMCML::recyclePat ( ) const

virtual

Implements CML.

Definition at line 317 of file drvemCML.cpp.

{
    return (shadowEnable & OutputCMLEna_cycl) != 0;
}

reset()

void MRMCML::reset ( bool  s )

virtual

Implements CML.

Definition at line 148 of file drvemCML.cpp.

{
    if(s)
        shadowEnable |= OutputCMLEna_rst;
    else
        shadowEnable &= ~OutputCMLEna_rst;
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

setCountHigh()

void MRMCML::setCountHigh ( epicsUInt32  v )

virtual

Implements CML.

Definition at line 234 of file drvemCML.cpp.

{
    v = std::max(kind==typeTG300?40u:20u, std::min(v, 65535u));

    epicsUInt32 val = READ32(base, OutputCMLCount(N));
    val &= ~(OutputCMLCount_mask << OutputCMLCount_high_shft);
    val |= v << OutputCMLCount_high_shft;
    WRITE32(base, OutputCMLCount(N), val);
}

setCountInit()

void MRMCML::setCountInit ( epicsUInt32  v )

virtual

Implements CML.

Definition at line 256 of file drvemCML.cpp.

{
    v = std::min(v, 65535u);

    v <<= OutputCMLEna_ftrig_shft;
    shadowEnable &= ~OutputCMLEna_ftrig_mask;
    shadowEnable |= v;
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

setCountLow()

void MRMCML::setCountLow ( epicsUInt32  v )

virtual

Implements CML.

Definition at line 245 of file drvemCML.cpp.

{
    v = std::max(kind==typeTG300?40u:20u, std::min(v, 65535u));

    epicsUInt32 val = READ32(base, OutputCMLCount(N));
    val &= ~(OutputCMLCount_mask << OutputCMLCount_low_shft);
    val |= v << OutputCMLCount_low_shft;
    WRITE32(base, OutputCMLCount(N), val);
}

setFineDelay()

void MRMCML::setFineDelay ( double  v )

virtual

Implements CML.

Definition at line 184 of file drvemCML.cpp.

{
    if(v>1024.0){
        printf("Delay will be set to 1024 instead of %f\n", v);
        v=1024.0;
    }
    WRITE32(base, GTXDelay(N), roundToUInt(v*1024.0));
}

setMode()

void MRMCML::setMode ( cmlMode  m )

virtual

Implements CML.

Definition at line 85 of file drvemCML.cpp.

{
    epicsUInt32 mask=0;
    switch(m) {
    case cmlModeOrig:    mask |= OutputCMLEna_mode_orig; break;
    case cmlModeFreq:    mask |= OutputCMLEna_mode_freq; break;
    case cmlModePattern: mask |= OutputCMLEna_mode_patt; break;
    default:
        throw std::out_of_range("Invalid CML Mode");
    }
    bool wasenabled = enabled();
    shadowEnable &= ~OutputCMLEna_ena; // disable while syncing
    shadowEnable &= ~OutputCMLEna_mode_mask;
    shadowEnable |= mask;
    WRITE32(base, OutputCMLEna(N), shadowEnable);


    switch(m) {
    case cmlModeOrig:
        WRITE32(base, OutputCMLPatLength(N), 0);
        syncPattern(patternFall);
        syncPattern(patternHigh);
        syncPattern(patternLow);
        syncPattern(patternRise);
        break;

    case cmlModePattern:
        WRITE32(base, OutputCMLPatLength(N), shadowWaveformlength-1);
        syncPattern(patternWaveform);
        break;

    default:
        break;
    }

    if(wasenabled)
        shadowEnable |= OutputCMLEna_ena; // enable after syncing
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

setPattern()

void MRMCML::setPattern ( pattern  p, const unsigned char *  buf, epicsUInt32  blen  )

virtual

Implements CML.

Definition at line 388 of file drvemCML.cpp.

{
    // If we are given a length that is not a multiple of CML word size
    // then truncate.
    if(blen%mult){
        printf("Given length is not a multiple of %u (CML word size). Truncating...\n", mult);
        blen-=blen%mult;
    }

    if(blen>lenPatternMax(p))
        throw std::out_of_range("Pattern is too long");


    epicsUInt32 val=0;
    for(epicsUInt32 i=0; i<blen; i++) {
        size_t cmlword = (i/mult);
        size_t cmlbit  = (i%mult);
        size_t cpuword, cpubit;
        if(mult<32) {
            cpuword = cmlword;
            cpubit = 19 - cmlbit;
        } else {
            cpuword = 2*cmlword + (cmlbit<8 ? 0 : 1);
            cpubit  = cmlbit<8 ? 7-cmlbit : 31-(cmlbit-8);
        }

        val|=(!!buf[i])<<cpubit;

        // cpubit is counting down.
        // write complete dword after the last bit is set
        if(cpubit==0) {
            shadowPattern[p][cpuword] = val;
            val=0;
        }
    }

    if(p==patternWaveform)
        shadowWaveformlength = blen/mult;

    // temporarly disable when changing multi dword patterns
    // to prevent output of incomplete patterns
    bool active=enabled();
    if(active)
        enable(false);

    if(mode()==cmlModePattern)
        WRITE32(base, OutputCMLPatLength(N), shadowWaveformlength-1);

    syncPattern(p);

    if(active)
        enable(true);
}

setPolarityInvert()

void MRMCML::setPolarityInvert ( bool  s )

virtual

Implements CML.

Definition at line 194 of file drvemCML.cpp.

{
    if(s)
        shadowEnable |= OutputCMLEna_ftrg;
    else
        shadowEnable &= ~OutputCMLEna_ftrg;
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

setRecyclePat()

void MRMCML::setRecyclePat ( bool  s )

virtual

Implements CML.

Definition at line 323 of file drvemCML.cpp.

{
    if(s)
        shadowEnable |= OutputCMLEna_cycl;
    else
        shadowEnable &= ~OutputCMLEna_cycl;
    WRITE32(base, OutputCMLEna(N), shadowEnable);
}

setTimeHigh()

void MRMCML::setTimeHigh ( double  v )

virtual

Implements CML.

Definition at line 291 of file drvemCML.cpp.

{
    double period=1.0/(mult*owner.clock());

    setCountHigh(roundToUInt(v/period));
}

setTimeInit()

void MRMCML::setTimeInit ( double  v )

virtual

Implements CML.

Definition at line 307 of file drvemCML.cpp.

{
    double period=1.0/(mult*owner.clock());

    setCountInit(roundToUInt(v/period));
}

setTimeLow()

void MRMCML::setTimeLow ( double  v )

virtual

Implements CML.

Definition at line 299 of file drvemCML.cpp.

{
    double period=1.0/(mult*owner.clock());

    setCountLow(roundToUInt(v/period));
}

timeHigh()

double MRMCML::timeHigh ( ) const

virtual

Implements CML.

Definition at line 267 of file drvemCML.cpp.

{
    double period=1.0/(mult*owner.clock());

    return countHigh()*period;
}

timeInit()

double MRMCML::timeInit ( ) const

virtual

Implements CML.

Definition at line 283 of file drvemCML.cpp.

{
    double period=1.0/(mult*owner.clock());

    return countInit()*period;
}

timeLow()

double MRMCML::timeLow ( ) const

virtual

Implements CML.

Definition at line 275 of file drvemCML.cpp.

{
    double period=1.0/(mult*owner.clock());

    return countLow()*period;
}

unlock()

void MRMCML::unlock ( ) const

virtual

Implements mrf::Object.

Definition at line 67 of file drvemCML.cpp.

{owner.unlock();};

---

The documentation for this class was generated from the following files:

• drvemCML.h
• drvemCML.cpp