mvmestd.h

Go to the documentation of this file.

/*********************************************************************
 
  Name:         mvmestd.h
  Created by:   Stefan Ritt
 
  Cotents:      Midas VME standard routines (MVMESTD) supplying an
                abstract layer to all supported VME interfaces.
                
  $Id$
 
*********************************************************************/
 
#ifndef MVMESTD_H
#define MVMESTD_H
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
/*---- replacements if not running under MIDAS ---------------------*/
 
#ifndef MIDAS_TYPE_DEFINED
#define MIDAS_TYPE_DEFINED
 
typedef unsigned short int WORD;
 
#ifndef _MSC_VER
typedef unsigned int DWORD;
#endif
 
#define SUCCESS  1
 
#endif                          /* MIDAS_TYPE_DEFINED */
 
/* make functions under WinNT dll exportable */
#if defined(_MSC_VER) && defined(MIDAS_DLL)
#define EXPRT __declspec(dllexport)
#else
#define EXPRT
#endif
 
#endif                          /* DOXYGEN_SHOULD_SKIP_THIS */
 
/*---- status codes ------------------------------------------------*/
 
#define MVME_SUCCESS                  1
#define MVME_NO_INTERFACE             2
#define MVME_NO_CRATE                 3
#define MVME_UNSUPPORTED              4
#define MVME_INVALID_PARAM            5
#define MVME_NO_MEM                   6
#define MVME_ACCESS_ERROR             7
 
/*---- types -------------------------------------------------------*/
 
typedef unsigned int mvme_addr_t;
typedef unsigned int mvme_locaddr_t;
typedef unsigned int mvme_size_t;
 
/*---- constants ---------------------------------------------------*/
 
#define MVME_DMODE_D8                 1   
#define MVME_DMODE_D16                2   
#define MVME_DMODE_D32                3   
#define MVME_DMODE_D64                4   
#define MVME_DMODE_RAMD16             5   
#define MVME_DMODE_RAMD32             6   
#define MVME_DMODE_LM                 7   
#define MVME_DMODE_DEFAULT MVME_DMODE_D32
 
/* block transfer modes */
 
#define MVME_BLT_NONE                 1   
#define MVME_BLT_BLT32                2   
#define MVME_BLT_MBLT64               3   
#define MVME_BLT_2EVME                4   
#define MVME_BLT_2ESST                5   
#define MVME_BLT_BLT32FIFO            6   
#define MVME_BLT_MBLT64FIFO           7   
#define MVME_BLT_2EVMEFIFO            8   
/* vme bus address modifiers */
 
#define MVME_AM_A32_SB     (0x0F)      
#define MVME_AM_A32_SP     (0x0E)      
#define MVME_AM_A32_SD     (0x0D)      
#define MVME_AM_A32_NB     (0x0B)      
#define MVME_AM_A32_NP     (0x0A)      
#define MVME_AM_A32_ND     (0x09)      
#define MVME_AM_A32_SMBLT  (0x0C)      
#define MVME_AM_A32_NMBLT  (0x08)      
#define MVME_AM_A32     MVME_AM_A32_SD
#define MVME_AM_A32_D64 MVME_AM_A32_SMBLT
 
#define MVME_AM_A24_SB     (0x3F)      
#define MVME_AM_A24_SP     (0x3E)      
#define MVME_AM_A24_SD     (0x3D)      
#define MVME_AM_A24_NB     (0x3B)      
#define MVME_AM_A24_NP     (0x3A)      
#define MVME_AM_A24_ND     (0x39)      
#define MVME_AM_A24_SMBLT  (0x3C)      
#define MVME_AM_A24_NMBLT  (0x38)      
#define MVME_AM_A24     MVME_AM_A24_SD
#define MVME_AM_A24_D64 MVME_AM_A24_SMBLT
 
#define MVME_AM_A16_SD  (0x2D) 
#define MVME_AM_A16_ND  (0x29) 
#define MVME_AM_A16     MVME_AM_A16_SD
 
#define MVME_AM_DEFAULT MVME_AM_A32
 
/*---- interface structure -----------------------------------------*/
typedef struct {
   int  initialized;         
   int  handle;              
   int  index;               
   void *info;               
   int  am;                  
   int  dmode;               
   int  blt_mode;            
   void *table;              
} MVME_INTERFACE;
 
/*---- function declarations ---------------------------------------*/
 
/* make functions callable from a C++ program */
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************/
int EXPRT mvme_open(MVME_INTERFACE **vme, int idx);
 
/********************************************************************/
int EXPRT mvme_close(MVME_INTERFACE *vme);
 
/********************************************************************/
int EXPRT mvme_sysreset(MVME_INTERFACE *vme);
 
/********************************************************************/
int EXPRT mvme_read(MVME_INTERFACE *vme, void *dst, mvme_addr_t vme_addr, mvme_size_t n_bytes);
 
/********************************************************************/
unsigned int EXPRT mvme_read_value(MVME_INTERFACE *vme, mvme_addr_t vme_addr);
 
/********************************************************************/
int EXPRT mvme_write(MVME_INTERFACE *vme, mvme_addr_t vme_addr, void *src, mvme_size_t n_bytes);
 
/********************************************************************/
int EXPRT mvme_write_value(MVME_INTERFACE *vme, mvme_addr_t vme_addr, unsigned int value);
 
/********************************************************************/
int EXPRT mvme_set_am(MVME_INTERFACE *vme, int am);
 
/********************************************************************/
int EXPRT mvme_get_am(MVME_INTERFACE *vme, int *am);
 
/********************************************************************/
int EXPRT mvme_set_dmode(MVME_INTERFACE *vme, int dmode);
 
/********************************************************************/
int EXPRT mvme_get_dmode(MVME_INTERFACE *vme, int *dmode);
 
/********************************************************************/
int EXPRT mvme_set_blt(MVME_INTERFACE *vme, int mode);
 
/********************************************************************/
  int EXPRT mvme_get_blt(MVME_INTERFACE *vme, int *mode);
  int EXPRT mvme_interrupt_generate(MVME_INTERFACE *mvme, int level, int vector, void *info);
  int EXPRT mvme_interrupt_attach(MVME_INTERFACE *mvme, int level, int vector,
                                  void (*isr)(int, void*, void *), void *info);
  int EXPRT mvme_interrupt_detach(MVME_INTERFACE *mvme, int level, int vector, void *info);
  int EXPRT mvme_interrupt_enable(MVME_INTERFACE *mvme, int level, int vector, void *info);
  int EXPRT mvme_interrupt_disable(MVME_INTERFACE *mvme, int level, int vector, void *info);
  
#ifdef __cplusplus
}
#endif
 
 
#endif // MVMESTD_H