pit_driver_optinBoard.cpp

Go to the documentation of this file.

#include "pit_driver_optinBoard.h"
#include "pit_driver_opticalLink.h"
#include <iostream>
#include <fstream>
#include <sstream>
#include <exception>
#include <stdexcept>
//_________________________________________________________________________________
pit_driver_optinBoard::pit_driver_optinBoard(unsigned int p_boardNumber, pit_comm *comm_engine)
{
unsigned int i;

    logDriverOptin = &(log4cpp::Category::getInstance("pitLog.driver")); 
    //logDriverOptin->info("(pit_driver_optinBoard::pit_driver_optinBoard()): constructor of optinBoard object number %d",p_boardNumber);
      // initialize boardNumber
    boardNumber = p_boardNumber;
      // intitialize baseAddress
    baseAddress = OPTIN_BOARDS_BASE_ADDRESS + boardNumber*OPTIN_BOARDS_OFFSET;
      // initialize pointer to communication engine
     commFEE = comm_engine;
      // check if optin board is plugged
    checkBoardPlugged();

        // create 12 instances of pit_driver_opticalLink to model the twelve links on the OPTIN board.
        // these ojects are like "child" object of the optinBoard instance
        for (i = 0; i < NUMBER_OPTICAL_LINKS; i++) {
            // instantiating child objects
           opticalLink[i] = new pit_driver_opticalLink( i, commFEE , this);  //[1]. passing pointer to this (parent) object
        }/* end for */
    
}// end of pit_driver_optinBoard
//_________________________________________________________________________________
pit_driver_optinBoard::~pit_driver_optinBoard(void)
{
unsigned int i;
      // reminder: destructor must release momory allocated for instances created and belonging to this object
      // in other words it has to call destructors of child objects instantied at moment of construction. 
      // This should be done like stg like the following
 
    for (i=0; i < NUMBER_OPTICAL_LINKS; i++) {
          // calling destructors for all child objects and realeasing memory destructors of children are called and in their turn they call destructors of their children
        delete opticalLink[i];
    }/* end for */
   
}// end of pit_driver_optinBoard
//_________________________________________________________________________________
/******************************************************************************
* Name : checkBoardPlugged                                                    *
* Function : check if optin board is plugged and update class data member :   *
*            fpgaVersion                                                      *
* Input : optinCard: optin card number <0;9>                                  *
* Output : none                                                               *
* Revisions:  cesar 22/01/2008  added the try catch block after changes           *
* in the comm layer                                                                                               *
*  DATE     AUTHOR            NOTES                                           *
* 20071123  Gianluca Aglieri  creation                                        *
******************************************************************************/
void pit_driver_optinBoard::checkBoardPlugged(void)// returns SUCCESS in case of an answer from a given OPTIN board, this is then 
{
        
        UInt32 version;
        UInt28 address = baseAddress + OPTIN_BOARDS_FWVERSION_OFFSET;
                        
        try {
                                                // it will read the optin board firmware version
                commFEE->PITReadWord(address,&version);
                logDriverOptin->info("(pit_driver_optinBoard::checkBoardPlugged()): Optin board %d, base address 0x%x, correctly answered with version %d", boardNumber, address, version);
                fpgaVersion = version;
                this->boardPlugged=true;
                
        }
        
        catch(exception& except){
                logDriverOptin->error("(pit_driver_optinBoard::checkBoardPlugged()): Failed to access optin board %d, base address 0x%x, board marked as not plugged", boardNumber, address);
                fpgaVersion = -1;
                this->boardPlugged= false;
                
                // calling method to reset and refresh communication status and services
                commFEE->PITCheckCommStatus();
                                
        }
}
//_________________________________________________________________________________
// function to refresh all menbers and services of one optin board
int pit_driver_optinBoard::refresh(){
        //this->checkBoardPlugged();
        this->refreshOptinStatus();
        this->refreshOptinSetting();
        this->refreshStatusServices();
        return 0;
}

//_________________________________________________________________________________
pit_driver_opticalLink& pit_driver_optinBoard::getOpticalLink(unsigned int linkNum)  { 
  if (linkNum >= NUMBER_OPTICAL_LINKS ){
    logDriverOptin->error("(pit_driver_optinBoard::getOpticalLink): opticalLink %d out of range, board %d", linkNum, boardNumber);
    throw out_of_range("Exception from (pit_driver_optinBoard::getOpticalLink), linkNum out of range");
  }
  else{
    return *opticalLink[linkNum];
  }
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::readOptinStatus()  {
  UInt32 status;
  UInt28 address= baseAddress + OPTIN_BOARDS_STATUS_OFFSET;
  commFEE->PITReadWord( address,&status);
  return status;
}
//_________________________________________________________________________________
void pit_driver_optinBoard::refreshStatusServices(void) {
  // updates services
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::readOptinSetting()  {
  UInt32 setting;
  UInt28 address = baseAddress + OPTIN_BOARDS_SETTING_OFFSET;
  commFEE->PITReadWord(address,&setting);
  return setting;
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::writeOptinSetting(UInt32 p_optinSetting) {
  UInt28 address = baseAddress + OPTIN_BOARDS_SETTING_OFFSET;
  return commFEE->PITWriteWord(address,p_optinSetting);
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::writeOptinCommand(UInt32 p_optinCommand) {
  UInt28 address = baseAddress + OPTIN_BOARDS_COMMAND_OFFSET;
  return commFEE->PITWriteWord(address,p_optinCommand);
}
//_________________________________________________________________________________
// SHOULD THIS REALLY BE HERE???
UInt12 pit_driver_optinBoard::refreshLinkStatus(void) {
  return 0;
}
//_________________________________________________________________________________
inline unsigned int pit_driver_optinBoard::getOptinFirmwareVersion() {
  return fpgaVersion;
}
//_________________________________________________________________________________
unsigned int pit_driver_optinBoard::readOptinFirmwareVersion() {
  UInt32 version;
  UInt28 address = baseAddress + OPTIN_BOARDS_FWVERSION_OFFSET;
  commFEE->PITReadWord(address,&version);
  return version;
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::refreshOptinStatus(void) {
  UInt32 status = readOptinStatus();
  return status;
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::refreshOptinSetting(void) {
  UInt32 setting = readOptinSetting();
  return setting;
}
//_________________________________________________________________________________
UInt32 pit_driver_optinBoard::readTimeStamp(int p_timeStampNumber)  {
  if (p_timeStampNumber>2) {
    logDriverOptin->error("(pit_driver_optinBoard::readTimeStamp()) for OPTIN board number %i, readTimeStamp(%d) out of range", boardNumber, p_timeStampNumber);
    return 0;
  }
  else {
    UInt32 timeStamp;
    UInt28 address = baseAddress + OPTIN_BOARDS_TIMESTAMP_OFFSET + p_timeStampNumber;
    commFEE->PITReadWord(address,&timeStamp);
    return timeStamp;
  }
}
//_________________________________________________________________________________
int pit_driver_optinBoard::readMinFastorCounts(int layer, int chip)  {
  if (layer<0 || layer>1 || chip<0 || chip>9) {
    logDriverOptin->error("(pit_driver_optinBoard::readMinFastorCounts(int layer, int chip)): for OPTIN board number %i, layer=%d chip=%d out of range", boardNumber, layer, chip);
    return 0;
  }
  else {
    UInt32 counts;
    UInt28 address = baseAddress + OPTIN_BOARDS_MINFOCOUNTS_OFFSET + layer*20 + chip;
    commFEE->PITReadWord(address,&counts);
    return counts;
  }
}
//_________________________________________________________________________________
int pit_driver_optinBoard::writeMinFastorCounts(int layer, int chip, unsigned int minCounts)  {
  if (layer<0 || layer>1 || chip<0 || chip>9) {
    logDriverOptin->error("(pit_driver_optinBoard::writeMinFastorCounts(int layer, int chip, unsigned int minCounts)): for OPTIN board number %i, layer=%d, chip=%d out of range", boardNumber, layer, chip);
    return 0;
  }
  else {
    UInt28 address = baseAddress + OPTIN_BOARDS_MINFOCOUNTS_OFFSET + layer*20 + chip;
    return commFEE->PITWriteWord(address,minCounts);
  }
}
//_________________________________________________________________________________
int pit_driver_optinBoard::readMaxFastorCounts(int layer, int chip)  {
  if (layer<0 || layer>1 || chip<0 || chip>9) {
    logDriverOptin->error("(pit_driver_optinBoard:readMaxFastorCounts(int layer, int chip)): for OPTIN board number %i, layer=%d, chip=%d out of range", boardNumber, layer, chip);
    return 0;
  }
  else {
    UInt32 counts;
    UInt28 address = baseAddress + OPTIN_BOARDS_MINFOCOUNTS_OFFSET + 10 + layer*20 + chip;
    commFEE->PITReadWord(address,&counts);
    return counts;
  }
}
//_________________________________________________________________________________
int pit_driver_optinBoard::writeMaxFastorCounts(int layer, int chip, unsigned int maxCounts)  {
  if (layer<0 || layer>1 || chip<0 || chip>9) {
    logDriverOptin->error("(pit_driver_optinBoard::writeMaxFastorCounts(int layer, int chip, unsigned int maxCounts)): for OPTIN board number %i, layer=%d, chip=%d out of range", boardNumber, layer, chip);
    return 0;
  }
  else {
    UInt28 address = baseAddress + OPTIN_BOARDS_MINFOCOUNTS_OFFSET + 10 + layer*20 + chip;
    return commFEE->PITWriteWord(address,maxCounts);
  }
}

---