AMC13 C++ Classes

FUN TASK FOR DAVID: write a script that works like Doxygen to keep this documentation up to date, using the source code's comments.

AMC13 C++ Class

Identification

    rv t1SerialNo()
    rv t2SerialNo()
    rv t1FirmVer()
    rv t2FirmVer()
    rv t1DNA()
    rv t2DNA()
    rv t1HardwareRev()
    rv t2HardwareRev()
    rv firmFlavor()
   

General read/write

   rv read(int chip, const std::string& reg)
   rv readAddress(int chip, uint32_t add)
   std::vector<rv> readBlockAddress(int chip, uint32_t add, size_t nWords)
   size_t readBlockAddress(int chip, uint32_t add, size_t nWords, uint32_t* buffer, size_t bufMax)
   std::vector<rv> readFifoAddress(int, uint32_t, size_t)
   std::map<std::string, uint32_t> readAllReadable(int chip)
   void write(int chip, const std::string& reg, rv value)
   void writeAddress(int chip, rv add, rv value)
   void writeBlockAddress(int chip, uint32_t add, std::vector<uint32_t> data, size_t nWords)
   void writeFifoAddress(int, uint32_t, std::vector<uint32_t>)
   void writeQueueAddress(int chip, uint32_t add, std::vector<uint32_t> data, size_t nWords)
   void writeTest(int chip)
   

Initialization

   uint32_t parseInputEnableList(std::string list)
   void AMCInputEnable(std::string list)
   daqLinkEnable(bool b)
   void fakeDataEnable(bool b)
   void ttcRxEnable(bool b)
   void monBufBackPressEnable(bool b)
   

   void reset(int chip)
   void sendLocalEvnOrnReset(uint32_t a, uint32_t b)
   void genInternalPeriodicL1As(bool b)
   void enableDaqLinkSenderReceiver()
   void saveReceivedDaqData(bool b)
   megaMonitorScale(bool b)
   setPreScaleFactor(uint32_t noZos)
   genInternalSingleL1A(uint32_t n)
   setTrigType(uint32_t type)
   setLocalL1APeriod(uint32_t n)
   setFEDid(uint32_t id)
   void startRun()
   void endRun()
   

   uint32_t nextEventSize() 
   uint32_t readNextEvent(uint32_t *buffer, uint32_t max_buf)
   uint32_t readNextEventNoAdvance(uint32_t *buffer, uint32_t max_buf)
   

• uint32_t parseInputEnableList(string list);
• void AMCInputEnable(string list);
• daqLinkEnable(bool b);
• void fakeDataEnable(bool b);
• void ttcRxEnable(bool b);
• void monBufBackPress(bool b);
• void startRun();
• void endRun();

DAQ

• uint32_t nextEventSize();
• uint32_t readNextEvent( uint32_t *buffer, uint32_t max_buf);
• uint32_t readNextEventNoAdvance( uint32_t *buffer, uint32_t max_buf);

• size_t readBlockAddress(int chip, uint32_t add, size_t nWords, uint32_t* buffer, size_t bufMax);
• std::map<std::string, uint32_t> readAllReadable(int chip);
• void write(int chip, const std::string& reg, rv value);
• void writeAddress(int chip, rv add, rv value);

• void writeTest(int chip);

Control

• void reset(int chip);
• void enableTTC();
• void flashDoCommand(int length);
• void enableFlashWrite();
• void waitForWriteDone();
• void eraseFlashSector(uint32_t s);

Special reads

• rv firmware(int chip);
  • get firmware versions of both FPGSs
• void ttcErrorCounts(int chip, rv& singleBit, rv& multiBit, rv& bunchCount);
  • get TTC error counts
• void ttcBcnEvnOrn(int chip, rv& bunchNumber, rv& eventNumber, rv& orbitNumber);
  • get TTC bunch, event, and orbit numbers

General read/write

• rv read(int chip, const std::string& reg);
  • single word read by register name
• rv readAddress(int chip, uint32_t add);
  • single word read by address
• void write(int chip, const std::string& reg, rv value);
  • single word write by register name
• void writeAddress(int chip, rv add, rv value);
  • single word write by address
• std::map<std::string, uint32_t> readAllReadable(int chip);
  • read all readable registers in address table
• std::vector readBlock(int chip, const std::string& reg, size_t nWords);
  • block read by register name
• std::vector readBlockAddress(int chip, uint32_t add, size_t nWords);
  • block read by address
• void writeBlockAddress(int chip, uint32_t add, std::vector data, size_t nWords);
  • block write by address
• void writeQueueAddress(int chip, uint32_t add, std::vector data, size_t nWords);
  • queued write by address

Flash read/write

• std::vector readFlashPage(uint32_t add);
  • read one page (0x100 bytes) from the flash memory
• void programFlash(const std::string& mcsFileName, uint32_t add);
  • program the flash memory from an mcs file to specified byte address
• void writeFlashPage(uint32_t wadd, std::vector data);
  • write one page of data to the flash
• void verifyFlash(const std::string& mcsFileName, uint32_t add);
  • verify the contents of the flash memory at byte address against an mcs file
• std::vector firmwareFromFlash(uint32_t add, int pages);
  • read specified number of pages from the flash at specified address into a vector
• std::vector firmwareFromMcs(const std::string& mcsFileName);
  • read contenst of an mcs file (data bytes) into vector

Printing

• void printTtcErrorCounts();
• void printTtcBcnEvnOrn(int chip, int nTimes);
• void printRegisterValues(int chip);
• void printFlashPage(uint32_t add);

-- JimRohlf - 27 May 2012