VmeInterface.h

//  8/11/2001  V 1.0 PM - Session management and error handling 
// 29/11/2001  V 1.1 PM - ATLAS coding rules compliance 
// 20/02/2002  V 2.0 PM - First implementation after the splitting
//                        VmeInterface/VmePort 
// 25/03/2002  V 2.1 TM - Data types unsigned, addr_mod->AddrMod, 
//                        namespace added            
//  4/04/2002  V 2.2 PM - Modification in the error handling methods
// 18/04/2002  V 2.3 PM - Modifications in the interrupt handling
//                        and in the error reporting methods
// 22/04/2002  V 2.4 PM - New methods for blocking and resuming 
//                        interrupt notification and for reading and
//                        setting an interrupt data word           
// 19/02/2004  V 2.5 PM - Safe single word R/W methods added            
//

#ifndef SCTPIXELROD_VMEINTERFACE_H
#define SCTPIXELROD_VMEINTERFACE_H

#include <vector>
#include <string>

#include "BaseException.h"

namespace SctPixelRod {

class VmePort;
class VmeInterruptHandler;

#define VMEADD_MISALIGNED      11001
#define PCIADD_MISALIGNED      11002
#define PCI_VME_MISALIGNED     11003
#define DMAMEM_ALLOC_ERROR     11004
#define BT_READ_ERROR          12000
#define BT_WRITE_ERROR         13000

class VmeException : public BaseException {
public:
  enum ErrorClass {OK, INIT_ERROR, BUS_ERROR, MAP_ERROR, DMA_ERROR};
  VmeException(ErrorClass ec, long ecod, VmePort *port=NULL) : 
     BaseException("VME Error"), m_errorClass(ec), m_errorCode(ecod), m_port(port) {}; 

  ErrorClass getErrorClass() { return m_errorClass; };
  long getErrorCode() { return m_errorCode; };
  VmePort *getPort() { return m_port; };
private:
  ErrorClass m_errorClass;
  int m_errorCode;
  VmePort *m_port;
};

class VmeInterface {
public:
  enum AddrMod { A16, A24, A32 };

  VmeInterface() {};
  virtual ~VmeInterface() {};                                                                  

  virtual void declareInterruptHandler(VmeInterruptHandler &handler) = 0;
  virtual void cleanInterruptHandlers() = 0;
  virtual void removeInterruptHandler(VmeInterruptHandler &handler) = 0;
  virtual void activateSoftVector(unsigned char vect, unsigned char subvect) = 0; 
  virtual void reEnableInterrupt() = 0; 
  virtual void blockInterruptNotification() = 0; 
  virtual void resumeInterruptNotification() = 0; 
  virtual void setInterruptData(long data) = 0;
  virtual long getInterruptData() = 0;
  
  virtual long getBusErrors() = 0;
  virtual void busErrorReport() = 0;
  virtual void busErrorReport(const unsigned long handle) = 0;
  virtual void busErrorReport(VmePort &port) = 0;
  virtual long getLastErrcode() = 0;
  virtual std::string getErrorMessage(const long errcode) = 0;

  virtual unsigned char read8  (const unsigned long handle, const unsigned long offset) = 0;  
  virtual unsigned char readS8  (const unsigned long handle, const unsigned long offset) = 0;  
  // Word read (automatic mapping)
  virtual unsigned short read16 (const unsigned long handle, const unsigned long offset) = 0;  
  virtual unsigned short readS16 (const unsigned long handle, const unsigned long offset) = 0;  
  virtual unsigned long read32 (const unsigned long handle, const unsigned long offset) = 0;  
  virtual unsigned long readS32 (const unsigned long handle, const unsigned long offset) = 0;  
  virtual void write8 (const unsigned long handle, const unsigned long offset, const unsigned char value) = 0;   
  virtual void writeS8 (const unsigned long handle, const unsigned long offset, const unsigned char value) = 0;   
  virtual void write16(const unsigned long handle, const unsigned long offset, const unsigned short value)= 0;    
  virtual void writeS16(const unsigned long handle, const unsigned long offset, const unsigned short value)= 0;    
  virtual void write32(const unsigned long handle, const unsigned long offset, const unsigned long value) = 0;   
  virtual void writeS32(const unsigned long handle, const unsigned long offset, const unsigned long value) = 0;   

  virtual void blockRead32 (VmePort &port, const unsigned long offset, unsigned long *buf, const long len) = 0;  
  virtual void blockRead64 (VmePort &port, const unsigned long offset, unsigned long *buf, const long len) = 0;   
  virtual void blockWrite32(VmePort &port, const unsigned long offset, const unsigned long *buf, const long len) = 0;  
  virtual void blockWrite64(VmePort &port, const unsigned long offset, const unsigned long *buf, const long len) = 0;   

  virtual unsigned long registerPort(VmePort &port) = 0;         
  virtual void deletePort(VmePort &port) = 0;
  virtual void *getPortMap(const unsigned long handle) = 0;

};                                             // End of VmeInterface declaration

} // End namespace SctPixelRod

#endif // SCTPIXELROD_VMEINTERFACE_H

---