Generic hardware access library
Public Member Functions
HAL::VMEConfigurationSpaceDevice Class Reference

A VME Device with customized hardware read- and write-methods in order to access the VME64x configuration space. More...

#include <VMEConfigurationSpaceDevice.hh>

Inheritance diagram for HAL::VMEConfigurationSpaceDevice:
HAL::VMEDevice HAL::HardwareDevice HAL::HardwareDeviceInterface

List of all members.

Public Member Functions

 VMEConfigurationSpaceDevice (VMEAddressTable &vmeAddressTable, VMEBusAdapterInterface &vmeBusAdapter)
 The vmeAddresstable must be given in the constructor since this class inherits from VMEDevice which in the constructor already needs the table.
virtual ~VMEConfigurationSpaceDevice ()
void hardwareRead (const GeneralHardwareAddress &vmeAddress, uint32_t *result, uint32_t offset=0) const throw (BusAdapterException)
 Overwrites the corresponding function of the VMEDevice.
void hardwareWrite (const GeneralHardwareAddress &vmeAddress, uint32_t data, uint32_t offset=0) const throw (BusAdapterException)
 Overwrites the corresponding function of the VMEDevice.
void hardwareReadBlock (const GeneralHardwareAddress &vmeAddress, uint32_t length, char *buffer, HalAddressIncrement addressBehaviour=HAL_DO_INCREMENT, uint32_t offset=0) const throw (UnsupportedException)
 Block transfers are not supported in configuration space.
void hardwareWriteBlock (const GeneralHardwareAddress &vmeAddress, uint32_t length, char *buffer, HalAddressIncrement addressBehaviour=HAL_DO_INCREMENT, uint32_t offset=0) const throw (UnsupportedException)
 Block transfers are not supported in configuration space.

Detailed Description

A VME Device with customized hardware read- and write-methods in order to access the VME64x configuration space.

This class overwrites the methods hardwareRead and hardwareWrite of the VMEDevice in order to re-interpret the width parameter of the GeneralHardwareAddress. Since in the predefined configuration space of VME64x only every 4th byte is used, the methods read or write only every fourth byte for items which are longer than 1 byte.

This approach may deem dirty but may be tolerable since this class is thought to be used only internally by the HAL.

See also:
Author:
Christoph Schwick
Revision:
1.1
Date:
2007/03/05 18:02:10

Definition at line 36 of file VMEConfigurationSpaceDevice.hh.

Constructor & Destructor Documentation

HAL::VMEConfigurationSpaceDevice::VMEConfigurationSpaceDevice ( HAL::VMEAddressTable &  vmeAddressTable,
HAL::VMEBusAdapterInterface &  vmeBusAdapter 
)

The vmeAddresstable must be given in the constructor since this class inherits from VMEDevice which in the constructor already needs the table.

This Table should a and VMEAddressTable which has been generated with the VMEConfigurationSpaceAddressReader.

Definition at line 4 of file VMEConfigurationSpaceDevice.cc.

HAL::VMEConfigurationSpaceDevice::~VMEConfigurationSpaceDevice ( ) [virtual]

Definition at line 10 of file VMEConfigurationSpaceDevice.cc.

Member Function Documentation

void HAL::VMEConfigurationSpaceDevice::hardwareRead ( const GeneralHardwareAddress &  vmeAddress,
uint32_t *  result,
uint32_t  offset = 0 
) const throw (BusAdapterException) [virtual]

Overwrites the corresponding function of the VMEDevice.

For the VMEConfigurationSpaceDevice the parameters of the AddressTable are slightly reinterpreted: Data in the configuration space of VME64x, is contained at address locations 4*n+3, where n=0,1,2,...,0x3ff. This function reads out the bytes at the correct addresses and composes the result in usigned long words (4 bytes wide). When the data width is larger than 1 byte (i.e. 2 to 4 bytes), all bytes are read out via single byte accesses and they are concatenated in a way that the most significant byte of the item is put at the higher bit numbers of the uint32_t.

Reimplemented from HAL::VMEDevice.

Definition at line 15 of file VMEConfigurationSpaceDevice.cc.

void HAL::VMEConfigurationSpaceDevice::hardwareReadBlock ( const GeneralHardwareAddress &  vmeAddress,
uint32_t  length,
char *  buffer,
HalAddressIncrement  addressBehaviour = HAL_DO_INCREMENT,
uint32_t  offset = 0 
) const throw (UnsupportedException) [virtual]

Block transfers are not supported in configuration space.

This method merely throws the UnsupportedException.

Reimplemented from HAL::VMEDevice.

Definition at line 50 of file VMEConfigurationSpaceDevice.cc.

void HAL::VMEConfigurationSpaceDevice::hardwareWrite ( const GeneralHardwareAddress &  vmeAddress,
uint32_t  data,
uint32_t  offset = 0 
) const throw (BusAdapterException) [virtual]

Overwrites the corresponding function of the VMEDevice.

For the VMEConfigurationSpaceDevice the parameters of the are slightly reinterpreted: Data in the configuration space of VME64x, is contained at address locations 4*n+3, where n=0,1,2,...,0x3ff. This function writes as many bytes as indicated by the datawidth contained in the address. The addresses of the single bytes are obtained from the address-parameter and the formula mentioned above.

Reimplemented from HAL::VMEDevice.

Definition at line 34 of file VMEConfigurationSpaceDevice.cc.

void HAL::VMEConfigurationSpaceDevice::hardwareWriteBlock ( const GeneralHardwareAddress &  vmeAddress,
uint32_t  length,
char *  buffer,
HalAddressIncrement  addressBehaviour = HAL_DO_INCREMENT,
uint32_t  offset = 0 
) const throw (UnsupportedException) [virtual]

Block transfers are not supported in configuration space.

This method merely throws the UnsupportedException.

Reimplemented from HAL::VMEDevice.

Definition at line 63 of file VMEConfigurationSpaceDevice.cc.

The documentation for this class was generated from the following files: