---

SctApi.idl

Go to the documentation of this file.

#ifndef IPC_IDL
#include "ipc/ipc.idl"
#define IPC_IDL
#endif

#include "sctConf/configuration.idl"

module Sct_SctApi {
  typedef sequence <long> DataBlock;
  typedef sequence <short> CharBlock;

  enum BankType {PHYICS_CONFIG, CALIBRATION_CONFIG, SCAN_CONFIG};

  interface Trigger : ipc::freeable {
    void print();

    void singleL1A();
    void doubleL1A(in unsigned short delay);
    void calL1A(in unsigned short delay);
    void pulseL1A(in unsigned short delay);
    void softL1A(in unsigned short delay);
    void softCalL1A(in unsigned short delay, in unsigned short delay2);
    void softPulseL1A(in unsigned short delay, in unsigned short delay2);
    void bcL1A(in unsigned short delay);
    void bcCalL1A(in unsigned short delay, in unsigned short delay2);
    void bcPulseL1A(in unsigned short delay, in unsigned short delay2);

    void setCommIncr(in unsigned short command, in unsigned short incr);
    void getCommIncr(out unsigned short command, out unsigned short incr);
  };

  typedef sequence <double> ScanPoints;

  interface Scan : ipc::freeable {
    enum ScanOptions {format, full, bits32, loopCalLine, distSlave, debug};

    void print();

    void configure(in unsigned short type, in double start, in double stop, in double step);
    void configure2(in unsigned short type, in double start, in double stop, in double step);

    Trigger getTrigger1();
    Trigger getTrigger2();

    void setTrigger1(in Trigger trig);
    void setTrigger2(in Trigger trig);

    void setScanVariable1(in unsigned short var);
    void setScanVariable2(in unsigned short var);
    unsigned short getScanVariable1();
    unsigned short getScanVariable2();

    void setNTrigs(in unsigned long nTrigs);
    unsigned short getNTrigs();

    ScanPoints getScanPoints1();
    ScanPoints getScanPoints2();
    void setScanPoints1(in ScanPoints scans);
    void setScanPoints2(in ScanPoints scans);

    long getOption(in ScanOptions opt);
    void setOption(in ScanOptions opt, in long val);

    unsigned long getScanNumber();
    void setScanNumber(in unsigned long scan);

    unsigned long getRunNumber();
    void setRunNumber(in unsigned long run);

    sctConf::ModuleList getModuleList(in unsigned long group);
    unsigned long getNGroups();
  };

  typedef sequence <Scan> ScanList;

  interface SctApi : ipc::freeable {
    void initialiseAll(in unsigned long runNumber);

    void shutdownAll();

    void status();
    void setRunNumber(in unsigned long newRun);
    void setScanNumber(in unsigned long newScan);

    void awaitResponse(in unsigned long partition, in unsigned long crate, in unsigned long rod);
    DataBlock getResponse(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                          out unsigned long length);


    void flashLED(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                  in unsigned short slaveNumber, in unsigned long period, in unsigned long flashes);
    void echo(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
              in unsigned long length, in DataBlock data); 

    void createDebugPrimList();
    void addDebugPrimList(in unsigned long length, in long index, in long id, in long version,
                          in DataBlock body);
    void sendDebugPrimList(in unsigned long partition, in unsigned long crate, in unsigned long rod);
    void sendDebugSlavePrimList(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                                in unsigned long slave, in boolean await, in boolean response);


    // Configuration 
    //    void loadConfiguration();
    void loadConfiguration(in string filename);
    void storeModuleConfigurations();

    void configureAllModules();


    sctConf::ABCDModule retrieveModule(in unsigned long mid);

    /***************** Direct ROD access (Debug only) ********************/
    short dspBlockDump(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                     in long dspStart, in long numWords, in long dspNumber);
    DataBlock dspBlockRead(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                           in long dspStart, in long numWords, in long dspNumber, out long length);
    short dspBlockWrite(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                      in DataBlock buffer, in unsigned long dspAddress, in long numWords, in long dspNumber);
    unsigned long dspSingleRead(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                                in unsigned long dspAddr, in long dspNumber);
    void dspSingleWrite(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                        in unsigned long dspAddr, in unsigned long val, in long dspNumber);

    DataBlock readSlaveDsp(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                           in short s, in unsigned long add, in unsigned long words);
//      unsigned long readRodStatusReg(in unsigned long partition, in unsigned long crate, in unsigned long rod,
//                                     in long regNumber);
//      unsigned long readRodCommandReg(in unsigned long partition, in unsigned long crate, in unsigned long rod,
//                                      in long regNumber);

    // Translation
    unsigned long findModuleSerial(in string sn);
    string convertToString(in unsigned long mid);
    unsigned long findModule(in unsigned short mur, in unsigned short number);

    //  pair<INT32, INT32> convertToMUR(in unsigned long mid);

    unsigned long findBarrelModule(in unsigned long barrel, in unsigned long row, in short number);
    void convertToBarrelModule(in unsigned long mid, out unsigned long barrel, out unsigned long row, out short number);

    unsigned long findEndcapModule(in long disk, in long ring, in long number);
    void convertToEndcapModule(in unsigned long mid, out unsigned long disk, out unsigned long ring, out unsigned long number);

    void getABCDModules(in unsigned long bank);
    void getABCDModule(in unsigned long mid, in unsigned long bank);

    void setABCDModule(in unsigned long mid, in unsigned long bank);
    void setABCDModules(in unsigned long bank);

    void sendABCDModule(in unsigned long mid, in unsigned long bank, in unsigned long type);
    void sendABCDModules(in unsigned long bank);

    void modifyABCDMask(in unsigned long mid, in DataBlock mask);
    void modifyABCDTrims(in unsigned long mid, in CharBlock trims);
    void modifyABCDRC(in unsigned long mid, in unsigned long chip, in unsigned short index, in double p0, in double p1, in double p2 );

    // XXX must be different prototypes
    void modifyABCDVar(in unsigned long typ, in double var);
    void modifyABCDModuleVar(in unsigned long mid, in unsigned long typ, in double var);
    void modifyABCDChipVar(in unsigned long mid, in unsigned long chip, in unsigned long typ, in double var);

    void modifyBOCParam(in unsigned long partition, in unsigned long crate, in unsigned long rod,
                        in unsigned long channel, in unsigned long type, in unsigned long val);

    void lasersOff();

    /* *************  TIM functs **************/
    void freeTriggers(in unsigned long partition, in unsigned long crate,
                      in double freq);
    void stopTriggers(in unsigned long partition, in unsigned long crate);
    void timL1A(in unsigned long partition, in unsigned long crate);
    void timCalL1A(in unsigned long partition, in unsigned long crate, in short delay);
    void sendTriggerAll(in Trigger trig);
    void sendTrigger(in unsigned long partition, in unsigned long crate, in unsigned long rod, in Trigger trig);

    // Scans
    oneway void doScan(in Scan thisScan);
    void doRawScan(in Scan thisScan, in long delay);

    void printBOCSetup(in unsigned long partition, in unsigned long crate, in unsigned long rod);
    void printABCDModule(in unsigned long mid);
    void printABCDRodModule(in unsigned long mid, in short bank);

    void decodeEvent(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                     in short sl, in short index, in boolean extFlag, in boolean errorType);

    void rawData(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                 in long delay, in long units, in boolean setMask);
    void rawDataWithTrigger(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                in long delay, in long units, in boolean setMask, in Trigger trig);
    void sendL1A(in unsigned long partition, in unsigned long crate, in unsigned long rod);

    CharBlock probe(in unsigned long partition, in unsigned long crate, in unsigned long rod);
    CharBlock probeHarness(in unsigned long partition, in unsigned long crate, in unsigned long rod, in unsigned long harness);

    CharBlock probeWithTrigger(in unsigned long partition, in unsigned long crate, in unsigned long rod, in Trigger trig);
    CharBlock probeHarnessWithTrigger(in unsigned long partition, in unsigned long crate, in unsigned long rod, 
                      in Trigger trig, in unsigned long harness);

    void requestHardReset(in unsigned long mid);
    void requestIVCurve(in unsigned long mid, in float start, in float stop, in float step, 
                        in unsigned short delay, in float currentLim);
    void setSelect(in unsigned long mid, in boolean value); 
    void changeRunState(in long state);
    void ddcGetChannelParameter(in long crate, in long channel, in string dpeName,
                                out long dpeValue, in long timeout);

    Scan defaultScan();
    Trigger defaultTrigger();

    ScanList knownScans();
  };

};

---