---

globmem.hh

Go to the documentation of this file.

/*************************************************************************
* File: globmem.hh                                                       *
* Authors: Fred Proctor, Will Shackleford                                *
* Purpose: C++ Header file for the Communication Management System(CMS). *
* Includes:                                                              *
*          1. class GLOBMEM.                                             *
* Note: GLOBMEM is used for communication between multiple VxWorks       *
* boards in a single backplane.                                          *
*************************************************************************/

#ifndef GLOBMEM_HH
#define GLOBMEM_HH

/* Include Files */

#ifdef VXWORKS
extern "C"
{
#include <vxWorks.h>            /* NULL */
#include <stddef.h>             /* size_t */
}

#else /* !VXWORKS */
extern "C"
{
#include <stdio.h>              /* NULL */
#include <stddef.h>             /* size_t */
}

#endif                          /* !VXWORKS */

#include "cms.hh"

#if defined(WIN32) && defined(USE_BIT3)
#include "btapi.h"
#endif



/* default base address of most of our VME memory boards, which run from
   0x04E00000 to 0x04FFFFFF */
#define GLOBMEM_DEFAULT_ADDRESS ((void *) 0x04E00000)
#define GLOBMEM_DEFAULT_LOCK    ((void *) 0x04FFFF00)
#define GLOBMEM_MASTER 1        /* exactly one process, the first to connect */
#define GLOBMEM_NOMASTER 0      /* all other processes */


enum GLOBMEM_ADDRESS_TYPE
{
  INVALID_ADDRESS_TYPE,
  PROCESS_SPECIFIC_ADDRESS,
  HOST_SPECIFIC_ADDRESS,
  VME_ADDRESS,
  EISA_ADDRESS,
  GENERIC_ADDRESS,
  ISA_ADDRESS,
  PCI_ADDRESS
};

struct BL_ADDR_INFO;
struct DMA_ADDR_INFO;

class GLOBMEM:public CMS
{
public:
  GLOBMEM (char *bufline, char *procline, int set_to_server = 0,
           int set_to_master = 0);
    virtual ~ GLOBMEM ();

  CMS_STATUS main_access (void *user_data);
  GLOBMEM_ADDRESS_TYPE address_type;
  char address_string[CMS_CONFIG_LINELEN];
  unsigned long physical_address;
  virtual unsigned long get_physical_address (char *);
  PHYSMEM_HANDLE *physmem_handle;
  int get_access ();
  int release_access ();
#ifdef VXWORKS
  CMS_STATUS write (void *user_data);
  CMS_STATUS write_if_read (void *user_data);
  int check_if_transfers_complete ();   /* Has DMA completed */
  CMS_STATUS read ();
  CMS_STATUS blocking_read (double);
  CMS_STATUS peek ();
#endif
private:
  int I_locked_the_task;        /* BOOLEAN: Was this globmem object the one */
  /* that locked the task if it is locked? */

  /* data buffer stuff */
  char address_type_name[CMS_CONFIG_LINELEN];   /* name of address space */
  /* or ascii code */
  char *local_locks;            /* address of short int for TAS mutex */
  double sem_delay;             /* Time to wait between polling the semaphore. */
  int read_only;
  BL_ADDR_INFO *bl_info;
  DMA_ADDR_INFO *dma_info;
#ifdef VXWORKS
  char *my_lock;
  char *toggle_bit_address;
  char *was_read_address;
  SEM_ID bsem;
  int board_type;
#endif
  int lock_bus;
  int use_dma;

#if defined(USE_BIT3) && defined(WIN32)
  int unit;                     /* Which board to use */
  bt_desc_t btd;                /* Unit descriptor */
  char devname[BT_MAX_DEV_NAME];        /* Device name string */
  bt_error_t bt_status;         /* Mirror API return value */
  bt_dev_t bt_type;
  int bt_use_mmap;
  unsigned long remote_address;
  void *remote_p;               /* holds pointer to a memory region */
#endif
#ifdef VXWORKS
  int lock_task;
  int use_test_and_set;
#endif
};

extern unsigned long (*get_physical_address_func) (char *);

#endif /* !defined(GLOBMEM_HH) */

---