1 INTRODUCTION

1.1 Purpose

This document is the User Manual of the driver for the VMIVME-5576 Reflective Memory Board. This VMEbus card is produced by VMIC - VME Microsystems International Corporation, and has been standardized by ESO for high-speed low-latency data communication among LCUs, particularly for the VLTI Fast Link, used within the fringe tracking control loop [10].

The VMIVME-5576 driver consists of a module that belongs to the CCS-LCU package. It contains the interface to be used by higher level software to access the VMIVME-5576 Reflective Memory Board.

The module name of the driver is rmn (reflective memory network).

This document provides all the necessary information for the development of applications using the rmn driver.

The manual assumes that the reader has a good knowledge of UNIX, C-language, the VxWorks operating system and is familiar with VxWorks development environment.

In addition to the Introduction section, this manual contains the following sections:

· User's Guide - Consists of the chapters 2, 3 and 4. It gives an overview of the driver and describes its functions and ioctl-commands in detail.

· Error Messages and Recovery - Provides a list of error and diagnostic messages and possible recovery actions.

· Code Examples - Provides some code templates which show the way to use the driver.

· Diagnostics - Shows the diagnostics facilities of the driver.

· Installation - Describes how to install and configure the driver and how to verify a successfull installation.

· Reference - Describes all the functions available as man-pages.

1.2 Scope

This manual describes the software module rmn in its version 1.0.

· rmn - VMIVME-5576 Reflective Memory Board Driver

The following hardware and software environment is required to run the software described:

· 2 VMEbus chassis with bus backplanes¹ and power supplies

· at least 2 VMIVME-5576 Reflective Memory Boards, one inside each chassis

· 2 Motorola MVME167 or MVME2604 CPU boards, any version, one inside each chassis

· VxWorks version 5.2 operating system or higher

· software module lculog for internal logging, version 1.11 or later

· software module lcudrv for common driver functions, version 1.25 or later

1.3 Applicable Documents

The following documents, of the exact issue shown, form a part of this document to the extent specified herein. In the event of conflict between the documents referenced herein and the contents of this document, the contents of this document shall be considered as a superseding requirement.

[1] VLTI Software - VMIVME-5576 Reflective Memory Board Driver Specification
VLT-SPE-ESO-15400-1374, Issue 1.0, 25/08/1997

[2] Local Control Unit Software Specification
VLT-SPE-ESO-17210-0002, Issue 2.2, 26/10/1993

1.4 Reference Documents

The following documents contain additional information and are referenced in the text.

[3] VMIVME-5576 Reflective Memory Board - Instruction Manual
500-005576-000 E, 4/11/1993
VME Microsystems International Corporation

[4] VxWorks Version 5.2 Programmer's Guide
Part #:DOC-10802-ZD-01, March 1995
Wind River Systems

[5] VxWorks Version 5.2 Reference Manual
Part #:DOC-10870-ND-00, March 1995
Wind River Systems, Mar. 1995

[6] VLT Software Programming Standards
VLT-PRO-ESO-10000-0228, Issue 1.0, 10/03/1993

[7] VLT Software - CCS-LCU/Driver Development Guide and User Manual
VLT-MAN-ESO-17210-0375, Issue 2.2, 11/06/1996

[8] VLT Software - CCS-LCU/Configuration of VLT Standard VME Boards
VLT-MAN-ESO-17210-1358, Issue 1.0, 05/05/1997

[9] VLT Common Software - Installation Manual
VLT-MAN-ESO-17200-0642, Issue 1.8, 31/05/1997

[10] VLTI Fast Link - Technical Report
VLT-TRE-ESO-15400-1373, Issue 1.0, 25/07/1997

1.5 Abbreviations and Acronyms

6U VME double height board

A16 VME Short I/O address mode

A24 VME Standard address mode

A32 VME Extended address mode

BERR Bus Error

CCS Central Control Software

CPU Central Processing Unit

CSR Control and Status Register

D08(O) VME 8-bit data transfer at odd addresses

D08(EO) VME 8-bit data transfer at even or odd addresses

D16 VME 16-bit data transfer

D32 VME 32-bit data transfer

DPRAM Dual Port RAM

FIFO First-In First-Out

HW Hardware

ICR Interrupt Control Register

INT Interrupt

ISR Interrupt Service Routine

LCU Local Control Unit

LED Light Emitting Diode

RAM Random Access (read/write) Memory

R/W Read/Write

SW Software

VLT Very Large Telescope

VLTI VLT Interferometer

VLTICS VLTI Control Software

VME Versa Module Eurocard

1.6 Usage of Terms

byte 8 bits value

word 16 bits value

long word 32 bits value

integer 32 bits signed integer value

double 64 bits floating-point value according to IEEE-754

1.7 Stylistic Conventions

The following styles are used:

bold
in the text, for commands, filenames, prefixes/suffixes as they have to be typed.

italic
in the text, for parts that have to be substituted with the real content before typing.

teletype
for examples.

<name>
in the examples, for parts that have to be substituted with the real content before typing.

bold and italic are also used to highlight words.

1.8 Naming Conventions

This implementation follows the naming conventions as outlined in the VLT Programming Standards [6].

1.9 Problem Reporting/Change Request

In order to:

· report a problem/error encountered using the software and/or the documentation,

· suggest changes in the software or documentation

fill an SPR-form (shown in the following page) and send it with any other additional material that you think could be helpful, to ESO:

· by mail or fax for the attention of:
VLT/ELE- SOFTWARE GROUP/Software Configuration Control Manager

· by e-mail to: vltsccm@eso.org

Your request will be checked-in the SPR data base and processed according to ESO change control procedure. The registration number will be communicated to you for further reference and you will be kept informed of the outcome of your SPR.

==============================================================================
E. S. O. ---- VERY LARGE TELESCOPE PROJECT ----
------------------------------------------------------------------------------
SOFTWARE PROBLEM REPORT/CHANGE REQUEST FORM DATE: <dd/mm/yy>
------------------------------------------------------------------------------
From:
<contract number>
<consortium name>
<institute name/company name>
<address>

<name of the submitter with its e-mail adress/fax number/phone number>
------------------------------------------------------------------------------
Subject: < module name / document title + version number >

Title: < problem short description >

------------------------------------------------------------------------------
Please mark one of the following categories

_ software error
_ error in the documentation
_ change request
------------------------------------------------------------------------------
Description:

>>>>> Please delete these lines and provide:
>>>>> for software errors:
>>>>> - the description of the anomaly, uncluding outputs,
>>>>> - how to reproduce it,
>>>>> - if existing, the temporary solution,
>>>>> - if known, the reference to where it was specified correctly
>>>>> - if known, the way to fix it.
>>>>>
>>>>> for errors in the documentation:
>>>>> - the exact location of the error (DocNr, issue, page, etc.)
>>>>> - the text that is wrong
>>>>> - if known, to what should it be changed.
>>>>>
>>>>> for change request
>>>>> - the description of what you would like to have
>>>>> - if available, possible implementation hints.
>>>>>
>>>>>

==============================================================================

Only P1/J1 backplane, if the board is configured in the A24 address space; both P1/J1 and P2/J2 backplanes if the board is configured in the A32 address space.