riovme.h

Go to the documentation of this file.

/*
 *  This file contains the RIO interface header file
 *  that is callable from FORTRAN
 *
 *  it hopes to simulate the good old RIO routines as part of DAE 1S
 *
 *  Author:   Freddie Akeroyd
 */


/*
 * Unix fortran compilers append an "_" to Fortran subroutine names
 *
 * OPEN_DAE is special in that it passes a string and so requires
 * a jacket FORTRAN routine
 */
#ifndef RIOVME_H
#define RIOVME_H

#include "isisvme_types.h"

#define RIOVME_SUCCESS          1
#define RIOVME_FAILED           0

#ifdef _WIN32
#       define CALLMECHANISM    __stdcall
#       ifdef IN_RIOVME_DLL
#               define DLLEXPORT                __declspec(dllexport)
#       else
#               define DLLEXPORT                __declspec(dllimport)
#       endif /* IN_RIOVME_DLL */
#endif /* _WIN32 */

#if defined(__unix)
#    define OPEN_DAE open_dae__
#    define CLOSE_DAE close_dae_
#    define RESET_DAE reset_dae_
#    define RIO rio_
#    define RIOD riod_
#    define RMEM rmem_
#    define RMEMD rmemd_
#    define WIO wio_
#    define WIOD wiod_
#    define WMEM wmem_
#    define WMEMD wmemd_
#    define RMEMVI rmemvi_
#    define READ_CRPT read_crpt_
#elif defined(__VMS)
#    define OPEN_DAE open_dae_
#    define CLOSE_DAE close_dae
#    define RESET_DAE reset_dae
#    define RIO rio
#    define RIOD riod
#    define RMEM rmem
#    define RMEMD rmemd
#    define WIO wio
#    define WIOD wiod
#    define WMEM wmem
#    define WMEMD wmemd
#    define RMEMVI rmemvi
#    define READ_CRPT read_crpt
#elif defined(_WIN32)
#   define OPEN_DAE OPEN_DAE_
#endif  /* ifdef unix */

/*
 * bus_addr     the multibus address
 * word         the transferred data word (16 bit)
 * device       a VMS channel number in DAE-I (ignored here, just for compatibility)
 * nwrds        the number of 16 bit words to transfer
 * wrd_length   word length of DAE memory. Could be 8, 16 or 32 bit
 *              for DAE-I, but only 32 bit allowed for DAE-II
 */
typedef char DAE_STRING;

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

    DLLEXPORT isis32_t CALLMECHANISM OPEN_DAE(DAE_STRING* dae_name);
    DLLEXPORT isis32_t CALLMECHANISM CLOSE_DAE();
    DLLEXPORT isis32_t CALLMECHANISM RESET_DAE(isis32_t* nn);
    DLLEXPORT isis32_t CALLMECHANISM RIO(isis32_t* bus_addr, isisU16_t* word, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM RIOD(isis32_t* bus_addr, isisU16_t* buffer, isis32_t* nwrds, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM RMEM(isis32_t* bus_addr, isisU16_t* word, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM RMEMD(isis32_t* bus_addr, isisU16_t* buffer, isis32_t* nwrds, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM WIO(isis32_t* bus_addr, isisU16_t* word, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM WIOD(isis32_t* bus_addr, isisU16_t* buffer, isis32_t* nwrds, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM WMEM(isis32_t* bus_addr, isisU16_t* word, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM WMEMD(isis32_t* bus_addr, isisU16_t* buffer, isis32_t* nwrds, isis16_t* device);
    DLLEXPORT isis32_t CALLMECHANISM RMEMVI(isis32_t* bus_addr, isisU32_t* buffer, isis32_t* length, isis16_t* device, isis32_t* wrd_len);
    DLLEXPORT isis32_t CALLMECHANISM READ_CRPT(isis32_t** start, isis32_t* crpt_section, isis32_t* size_in_words);

    DLLEXPORT isis32_t open_dae_c(const char* dae_name);
    DLLEXPORT isis32_t open_dae_cds(const char* dae_name);
    DLLEXPORT isis32_t rio_c(isis32_t bus_addr, isis16_t* word, isis16_t device);
    DLLEXPORT isis32_t rmemvi_c(isis32_t* bus_addr, isis32_t* buffer, isis32_t* length, isis16_t* device, isis32_t* wrd_len);
    DLLEXPORT isis32_t close_dae_c();
    DLLEXPORT isis32_t read_crpt_c(isis32_t** start, isis32_t* crpt_section, isis32_t* size_in_words);
/* 
 * dynamic versions 
 */
    DLLEXPORT isis32_t d_open_dae_cds(const char* dae_name);
    DLLEXPORT isis32_t d_rio(isis32_t bus_addr, isis16_t* word, isis16_t device);
    DLLEXPORT isis32_t d_close_dae();
    DLLEXPORT isis32_t d_rmemvi(isis32_t* bus_addr, isis32_t* buffer, isis32_t* length, isis16_t* device, isis32_t* wrd_len);
    DLLEXPORT isis32_t d_read_crpt(isis32_t** start, isis32_t* crpt_section, isis32_t* size_in_words);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif  /* RIOVME_H */