/home/cschwick/hal/generic/include/hal/VMEBusAdapterInterface.hh

Go to the documentation of this file.

#ifndef __VMEBusAdapterInterface
#define __VMEBusAdapterInterface

#include <string>
#include <vector>

#include "hal/IllegalValueException.hh"
#include "hal/VMEAddressTable.hh"
#include "hal/DeviceIdentifier.hh"
#include "hal/BusAdapterException.hh"
#include "hal/UnsupportedException.hh"
#include "hal/HardwareDeviceInterface.hh"

namespace HAL {

class VMEBusAdapterInterface {

public:

  virtual ~VMEBusAdapterInterface() {};

  virtual void openDevice( const VMEAddressTable& vmeAddressTable,
                           uint32_t vmeBaseaddress,
                           DeviceIdentifier** deviceIdentifierPtr,
                           uint32_t* baseAddressPtr,
                           bool doSwapping )
    throw (BusAdapterException,
           UnsupportedException) = 0;
  
  virtual void openDevice( const VMEAddressTable& vmeAddressTable,
                           std::vector<uint32_t> vmeBaseaddresses,
                           DeviceIdentifier** deviceIdentifierPtr,
                           std::vector<uint32_t>* baseAddressesPtr,
                           bool doSwapping )
    throw (BusAdapterException,
           UnsupportedException) {
    std::string text = "openDevice for VME64x modules not implemented.\n    (VMEBusAdapterInterface::openDevice)";
    throw (UnsupportedException( text, __FILE__, __LINE__, __FUNCTION__  ) );
  }
  
  virtual void closeDevice( DeviceIdentifier* deviceIdentifier )
    throw( BusAdapterException ) = 0;

  virtual void write( DeviceIdentifier* deviceIdentifierPtr,
                      uint32_t address,
                      uint32_t addressModifier,
                      uint32_t dataWidth,
                      uint32_t data)
    throw( IllegalValueException, BusAdapterException ) = 0;

  virtual void read( DeviceIdentifier* deviceIdentifierPtr,
                     uint32_t address,
                     uint32_t addressModifier,
                     uint32_t dataWidth,
                     uint32_t* result)
    throw( IllegalValueException, BusAdapterException ) = 0;
  
  virtual void readBlock( DeviceIdentifier* deviceIdentifierPtr,
                          uint32_t startAddress,
                          uint32_t length,      // in bytes
                          uint32_t addressModifier,
                          uint32_t dataWidth,
                          char *buffer,
                          HalAddressIncrement addressBehaviour = HAL_DO_INCREMENT )
    throw( UnsupportedException,
           BusAdapterException ) = 0;
  virtual void writeBlock( DeviceIdentifier* deviceIdentifierPtr,
                          uint32_t startAddress,
                          uint32_t length,      // in bytes
                          uint32_t addressModifier,
                          uint32_t dataWidth,
                          char *buffer,
                          HalAddressIncrement addressBehaviour = HAL_DO_INCREMENT )
    throw( UnsupportedException,
           BusAdapterException ) = 0;

  virtual void resetBus( )
    throw( BusAdapterException,
           UnsupportedException ) = 0; 
};

} /* namespace HAL */

#endif /* __VMEBusAdapterInterface */