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

Go to the documentation of this file.

#ifndef __HardwareDeviceInterface
#define __HardwareDeviceInterface

#include <string>
#include <iostream>

#include "hal/AddressTableInterface.hh"
#include "hal/NoSuchItemException.hh"
#include "hal/IllegalOperationException.hh"
#include "hal/IllegalValueException.hh"
#include "hal/VerifyException.hh"
#include "hal/UnsupportedException.hh"
#include "hal/BusAdapterException.hh"
#include "hal/MaskBoundaryException.hh"
#include "hal/TimeoutException.hh"
#include "hal/AddressOutOfLimitsException.hh"

namespace HAL {

enum HalVerifyOption { HAL_NO_VERIFY, HAL_DO_VERIFY };

enum HalAddressIncrement { HAL_DO_INCREMENT, HAL_NO_INCREMENT };

enum HalPollMethod { HAL_POLL_UNTIL_EQUAL, HAL_POLL_UNTIL_DIFFERENT };
class HardwareDeviceInterface {
public:

  virtual ~HardwareDeviceInterface() {};

  virtual void unmaskedWrite( std::string item, 
                              uint32_t data,
                              HalVerifyOption verifyFlag = HAL_NO_VERIFY,
                              uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException, 
           VerifyException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;
  virtual void write( std::string item, 
                      uint32_t data, 
                      HalVerifyOption verifyFlag = HAL_NO_VERIFY,
                      uint32_t offset = 0 ) const
    throw ( NoSuchItemException, 
            IllegalOperationException, 
            VerifyException,
            BusAdapterException,
            MaskBoundaryException,
            AddressOutOfLimitsException ) = 0;
  virtual void writePulse( std::string item, 
                           uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;
  virtual void unmaskedRead( std::string item,
                             uint32_t* result,
                             uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;
  virtual void read( std::string item, 
                     uint32_t* result,
                     uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException,
           BusAdapterException,
           MaskBoundaryException,
           AddressOutOfLimitsException) = 0;
  virtual bool check( std::string item,
                      uint32_t expectation,
                      std::string faultMessage = "",
                      uint32_t offset = 0,
                      std::ostream& os = std::cout ) const
    throw( NoSuchItemException,
           IllegalOperationException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;

  virtual void readPulse( std::string item, 
                          uint32_t offset = 0 ) const
  throw (NoSuchItemException, 
         IllegalOperationException,
         BusAdapterException,
         AddressOutOfLimitsException) = 0;
  virtual void setBit( std::string item,
                       HalVerifyOption verifyFlag = HAL_NO_VERIFY,
                       uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException, 
           VerifyException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;
  virtual void resetBit( std::string item,
                         HalVerifyOption verifyFlag = HAL_NO_VERIFY,
                         uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException, 
           VerifyException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;
  virtual bool isSet( std::string item, 
                      uint32_t offset = 0 ) const
    throw (NoSuchItemException, 
           IllegalOperationException,
           BusAdapterException,
           AddressOutOfLimitsException) = 0;

  virtual void writeBlock( std::string startItem, 
                           uint32_t length,
                           char *buffer,
                           HalVerifyOption verifyFlag = HAL_NO_VERIFY,
                           HalAddressIncrement addressBehaviour = HAL_DO_INCREMENT,
                           uint32_t offset = 0 ) const
    throw ( NoSuchItemException,
            IllegalValueException, 
            UnsupportedException, 
            VerifyException,
            IllegalOperationException,
            BusAdapterException,
            AddressOutOfLimitsException ) = 0;

  virtual void readBlock( std::string startItem, 
                          uint32_t length,
                          char *buffer,
                          HalAddressIncrement addressBehaviour = HAL_DO_INCREMENT,
                          uint32_t offset = 0 ) const
    throw (NoSuchItemException,
           IllegalValueException, 
           UnsupportedException, 
           BusAdapterException,
           IllegalOperationException,
           AddressOutOfLimitsException) = 0;

  virtual void pollItem( std::string item,
                         uint32_t referenceValue,
                         uint32_t timeout,
                         uint32_t *result,
                         HalPollMethod pollMethod = HAL_POLL_UNTIL_EQUAL,
                         uint32_t offset = 0 ) const
    throw ( NoSuchItemException,
            IllegalOperationException,
            BusAdapterException,
            MaskBoundaryException,
            TimeoutException,
            AddressOutOfLimitsException ) = 0;


  virtual const AddressTableInterface& getAddressTableInterface() const = 0;

  virtual void printAddressTable() const = 0;

}; 
} /* namespace HAL */

#endif /*__HardwareDeviceInterface */