1 INTRODUCTION

7 This document contains practical methods for driver development,
and the user manual for common modules used by all drivers.

1.1 Purpose

The purpose of this document is to make the development of new LCU drivers for the ESO VLT- project easier. It covers design, implementation and test of drivers. It can also be helpful for maintenance, for instance the addition of new commands to existing drivers.

This document contains also the User Manual for the software modules and test tools representing the common driver part (abbreviated with lcudrv and lculog). Functions and macros defined in these modules can be used by any driver, likewise are the tools described here not driver-specific and can therefore be used during development and test of any new or existing driver.

The user manual part is intended to provide all the necessary information to develop drivers which make use of the modules lcudrv and lculog.

The document 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 major sections:

· General Driver Structure - Gives an overview of how to organize a driver.

· Files and Directories - Provides a complete list of necessary files and directories for a driver and what they should contain.

· The LCU Driver Common Modules - Describes all the functions available in the modules lcudrv and lculog and how to use them in drivers.

· Test Tools - Describes the utility lcudrvTk which can be used during driver development and installation.

· Reference - with all man-pages of the described modules in alphabetical order.

1.2 Scope

The User Manual part of this document describes the following VLT software modules:

· lcudrv version 1.17, incl. lcudrvTk

· lculog version 1.9

The following hardware and software environment is recommended for the software described:

· A UNIX host system for development

· VxWorks version 5.2 development system

· The VLT Common SW (CCS/LCC) installed

· A target LCU

· a VMEbus chassis with bus backplane and power supply

· one Motorola MVME167 CPU board, any version

· VxWorks version 5.2 operating system installed

1.3 Reference Documents

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

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

[2] VLT SW Rel1 - Overview and Installation
VLT-MAN-ESO-17200-0642

[3] VxWorks Version 5.2 Programmer's Guide
Wind River Systems

[4] VxWorks Version 5.2 Reference Manual
Wind River Systems

[5] J.K.Ousterhout: Tcl and the Tk Toolkit
Addison-Wesley, 1994

[6] VLT Software Problem Report Change Request User Manual
VLT-MAN-ESO-17200-0981, 1.0 15/01/96

[7] Environments Common Configuration User Manual
VLT-MAN-ESO-17210-0855, 1.0

1.4 Abbreviations And Acronyms

The following abbreviations and acronyms are used in this document:¹

CCS Central Control Software

DCT Driver Channel Table

HW Hardware

I/O Input/Output

ISR Interrupt Service Routine

LAN Local Area Network

LCC LCU Common Software

LCU Local Control Unit

N/A Not Applicable

OS Operating System

SW Software

TBD To Be Defined

VLT Very Large Telescope

WS Workstation

1.5 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.

Items which are subject to change in future versions are marked in this way (AuthorRemark).

7 Very important items are marked in this way (Warning).

1.6 Naming Conventions

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

All directories, files and variables belonging to a specific driver are identified by some `xxx' characters as prefix to their names. Example code in this document uses "xxx" literally (like xxx.h, xxxCommands.h, xxxErrors.h), for real drivers this must be changed to the driver's module name, e.g. "mcon", "tim" etc.

1.7 Problem Reporting/Change Request

See [6] for instructions.

¹

The abbreviation CDT for "Command Descriptor Table" has been removed in issue 2.0 to avoid confusion with "Command Definition Table" in CCS/LCC terminology.

Quadralay Corporation http://www.webworks.com Voice: (512) 719-3399 Fax: (512) 719-3606 sales@webworks.com