TPMC550-SW-12 OS-9 for PPC Device Driver 8 (4) Channels Isolated 12-bit D/A

TPMC550-SW-12 OS-9 for PPC Device Driver 8 (4) Channels Isolated 12-bit D/A Version 1.1 Issue 1.0 18. May 1999 TEWS DATENTECHNIK GmbH Am Bahnhof 7 D-25469 Halstenbek Germany Tel.: +49 (0)4101 4058-0 Fax.: +49 (0)4101 4058-19 E-Mail: Support@tews.com Web: http://www.tews.com

TPMC550-SW-12 8(4) Channel 12-bit I/O OS-9 for PPC Device Driver This document contains information, which is proprietary to TEWS DATENTECHNIK GmbH. Any reproduction without written permission is forbidden. TEWS DATENTECHNIK GmbH has made any effort to ensure that this manual is accurate and complete. However TEWS DATENTECHNIK GmbH reserves the right to change the product described in this document at any time without notice. This product has been designed to operate with PCI Mezzanine Card compatible carriers. Connection to incompatible hardware is likely to cause serious damage. TEWS DATENTECHNIK GmbH is not liable for any damage arising out of the application or use of the device described herein. 1999 by TEWS DATENTECHNIK GmbH Issue Description Date 1.0 First Issue 18. May 1999 TPMC550-SW-12 OS-9 for PPC Device Driver page 2

Table of Contents 1 INTRODUCTION.. 4 2 INSTALLATION. 5 2.1 Install the driver to the OS-9-System 5 2.2 Different Carriers. 5 3 I/O INTERFACE FUNCTIONS 6 3.1 Tp550_open(). 6 3.2 Tp550_close(). 7 3.3 tp550_write() 8 3.4 tp550_cntrl(). 10 3.4.1 SS_SEQ_ENABLE - (Setup and Enable Output Sequencer). 11 3.4.2 SS_SEQ_DISABLE - (Disable Output Sequencer). 12 3.4.3 SS_SEQ_WRITE - (Write new values to the sequencer). 13 4 DEVICE DESCRIPTOR.. 14 5 APPENDIX 15 5.1 Predefined Symbols 15 5.2 Status and Error Codes. 15 TPMC550-SW-12 OS-9 for PPC Device Driver page 3

1 Introduction The TPMC550-SW-12 OS-9 for PowerPC device driver software allows the operation of the TPMC550 modules with 8(4) analog outputs with a device-independent interface. After installation of the device driver in the I/O system, output voltage lines can be set and read by calling the 'tp550_write()' function. Special I/O operations that do not fit to the standard I/O calls will be performed by calling the 'tp550_cntrl()' function with a specific function code and an optional functiondependent argument. The TPMC550-SW-12 device driver includes the following functions:! writing new output values! start and configure the output sequencer! stop the output sequencer! synchronized write to update output values in sequencer mode TPMC550-SW-12 OS-9 for PPC Device Driver page 4

2 Installation The TPMC550-SW-12 OS-9 for PowerPC device driver software is delivered on a 3½ floppy disk (DOS-formatted). The floppy disk holds the following files: TP550DRV_MAIN.C Device Driver Main TP550DRV_INIT.C Device Driver Initialization Function TP550DRV_TERM.C Device Driver Termination Function TP550DRV_CTRL.C Device Driver GetStat and SetStat Function TP550DRV_INTR.C Device Driver Interrupt Function TP550_INTERFACE.C Application Interface TP550_EXAMPLE.C Example Application using TPMC550 Device Driver TP550DRV_DEFS.H Device Driver Definitions Include File TPMC550.H Device Driver and Application Include File TPMC550.DES TPMC550 Global Device Descriptor Structure TP550_X.DES TPMC550 Global Device Descriptor Initialization TP550_1.DES TPMC550 Device Descriptor OUTPUT\* Compiled Example 2.1 Install the driver to the OS-9-System After you have copied the files to your PC disk, you have to adapt the device descriptors for your system. After this the device driver can be build with the following command: os9make After generating the device driver and the device descriptors, these files have to be moved to your OS-9-system (for example: with FTP). The device driver and its corresponding device descriptors can be loaded into the running system with the command (see also IN in the output directory of your driver disk): load d tp550_1 tp550drv Now the devices can be initialized in your OS-9 system with the following command (see also IN in the output directory of your driver disk): iniz tp550_1 An example of uninstalling the driver is given in OUT in the output directory of your driver disk. After starting the device driver and initializing the device descriptors in your OS-9- system, you can run your application using the devices, if you have linked the application with the TPMC550 Device Driver Interface TP550_INTERFACE. 2.2 Different Carriers This device driver has been designed and tested on the local PMC-Slot of a MVME3604. If you are using PMC-Spans or other Carriers it may be necessary to adapt your PCIsetup to allow access to the module and to initialize the PCI-configuration-registers of the TPMC550. TPMC550-SW-12 OS-9 for PPC Device Driver page 5

3 I/O Interface Functions This chapter describes the interface to the I/O system for handling the digital inputs and outputs. 3.1 Tp550_open() NAME tp550_open() - open a path to a TPMC550 device SYNOPSIS int tp550_open ( char *DeviceName, /* name of the device to open */ int *Path /* path number returned by this call */ ) DESCRIPTION Before I/O can be performed to the TPMC550 device, it must be opened by invoking the I/O function 'tp550_open()'. PARAMETER The argument DeviceName specifies the device. The argument Path is used to identify the device in subsequent service requests. EXAMPLE /*---------------------------------------------------------- open the device named "/tp550_1" for I/O -----------------------------------------------------------*/ result = tp550_open ( "/tp550_1", &path); RETURNS returns E_NOERR (0) if the device was successful opened, or an appropriate error code if the device does not exist. SEE ALSO I/O system call I$Open TPMC550-SW-12 OS-9 for PPC Device Driver page 6

3.2 Tp550_close() NAME tp550_close() - close a path to a TPMC550 device SYNOPSIS int tp550_close ( int ) Path DESCRIPTION Terminates the specified I/O path. PARAMETER The I/O path is specified by Path. RETURNS returns E_NOERR (0) if the device was successful closed, or an appropriate error code. SEE ALSO I/O system call I$Close TPMC550-SW-12 OS-9 for PPC Device Driver page 7

3.3 tp550_write() NAME tp550_write() write a new value to an output channel of the specified TPMC550. SYNOPSIS int tp550_write ( int Path, /* Path number */ TP550_IO_BUFFER *Buf /* Pointer to the Output buffer */ ) DESCRIPTION Once a TPMC550 device has been initialized the tasks can write values to a specified output channel of the device. PARAMETER The parameter Path Specifies the device. The parameter Buf is a pointer to the I/O structure (TP550_IO_BUFFER). Data structure 'TP550_IO_BUFFER' typedef struct { unsigned short Value; unsigned short Flags; unsigned short Channel; } TP550_IO_BUFFER; The parameter Value specifies the new output value. The parameter Flags specifies the mode how to convert the values. Allowed Flags are: TP550_LATCHED Load a new DAC value, but don t start the conversion. TP550_SIMULTANOUS Start a conversion for all DACs simultaneously TP550_CORR Correct the output value using the board specific calibration data The parameter Channel specifies the output channel. TPMC550-SW-12 OS-9 for PPC Device Driver page 8

EXAMPLE #include "tpmc550.h" tp550_io_buffer int int outbuf; result; path; /*--------------------------------------------------------- Write a new output value to the opened TPMC550 device. Change Channel 4 to 0x123 ---------------------------------------------------------*/ outbuf.channel = 4; outbuf.value = 0x123; outbuf.flags = 0; result = tp550_write (path, &outbuf); if (result!= E_NOERR) { /* handle the write error */ } RETURNS E_NOERR if read was successful or an appropriate error code INCLUDE FILES TPMC550.H TPMC550-SW-12 OS-9 for PPC Device Driver page 9

3.4 tp550_cntrl() NAME tp550_cntrl() - perform an I/O control function SYNOPSIS int tp550_cntrl ( int Path, /* Path number */ int function, /* function code */ int arg /* optional function-dependent argument */ ) DESCRIPTION Special I/O operations that do not fit to the standard I/O calls (read, write) will be performed by calling the 'tp550_cntrl()' function with a specific function code and an optional function-dependent argument. A description of the special functions follows after this function. PARAMETER The parameter Path specifies the device. The parameter function selects control function. The parameter arg is a function dependent argument, it point to the structure TP550_SEQ_BUFFER. Data structure 'TP550_SEQ_BUFFER' typedef struct { unsigned short Time; /* Sequencer Cycle Time */ TP550_SEQ_CHAN List[8]; /* Channel Configuration List for */ /* channel 1..8 */ } TP550_SEQ_BUFFER; Data structure 'TP550_SEQ_CHAN' typedef struct { unsigned short Value; /* Channels value */ unsigned short Flags; /* Channel setup Flags */ } TP550_SEQ_CHAN; RETURNS E_NOERR or an appropriate error code if the device does not exist or the function code is unknown INCLUDE FILES TPMC550.H TPMC550-SW-12 OS-9 for PPC Device Driver page 10

3.4.1 SS_SEQ_ENABLE - (Setup and Enable Output Sequencer) This I/O-function sets up and enables the output sequencer of the TPMC550. For this operation the function dependent argument is used with the following parameters. Structure TP550_SEQ_BUFFER : The parameter Time specifies the length of a sequencer cycle, the value is specified in 100µs steps. The array List[] holds information for each possible channel. List[0] Channel 1 List[1] Channel 2 List[2] Channel 3 Structure TP550_SEQ_CHAN : The parameter Value specifies the first output value of the specified channel. The parameter Flags specifies how to handle the channel. TP550_CORR Correct the output value using the board specific calibration data TP550_CHANENABLE If this flag is set the sequencer will handle this channel, otherwise this channel is not used in sequencer mode. EXAMPLE #include "tpmc550.h" int result; TP550_SEQ_BUFFER seq_buf; /*------------------------------------------------------- Enable Output Sequencer and setup startvalues Sequencer cycle of 1 sec Use channel 1 and channel 4(corrected) -------------------------------------------------------*/ seq_buf.time = 10000; /* Setup used channels */ seq_buf.list[0].value = 0x100; seq_buf.list[0].flags = TP550_CHANENABLE; seq_buf.list[3].value = 0x400; seq_buf.list[3].flags = TP550_CHANENABLE TP550_CORR; /* Setup unused channels */ seq_buf.list[1].flags = 0; seq_buf.list[2].flags = 0; seq_buf.list[4].flags = 0; seq_buf.list[5].flags = 0; seq_buf.list[6].flags = 0; seq_buf.list[7].flags = 0; result = tp550_cntrl(path, SS_SEQ_ENABLE, &seq_buf); TPMC550-SW-12 OS-9 for PPC Device Driver page 11

3.4.2 SS_SEQ_DISABLE - (Disable Output Sequencer) This I/O-function disables the output sequencer of the TPMC550. For this operation the function dependent argument is unused. EXAMPLE #include int "tpmc550.h" result; /*------------------------------------------------------- Disable Output Sequencer -------------------------------------------------------*/ result = tp550_cntrl(path, SS_SEQ_DISABLE, 0); TPMC550-SW-12 OS-9 for PPC Device Driver page 12

3.4.3 SS_SEQ_WRITE - (Write new values to the sequencer) This I/O-function writes new values the output sequencer of the TPMC550. This function will wait until the sequencer allows writing new values to the TPMC550. For this operation the function dependent argument is used with the following parameters. Structure TP550_SEQ_BUFFER : The parameter Time is not used. The array List[] holds information for each possible channel. List[0] Channel 1 List[1] Channel 2 List[2] Channel 3 Structure TP550_SEQ_CHAN : The parameter Value specifies the new output value of the specified channel. The parameter Flags specifies how to handle the channel. TP550_CORR Correct the output value using the board specific calibration data TP550_CHANENABLE If this flag is set the sequencer will write the new value to the channel, but it will only have any effect if the channel has been enabled with the SS_SEQ_ENABLE function. EXAMPLE #include "tpmc550.h" int result; TP550_SEQ_BUFFER seq_buf; /*------------------------------------------------------- Write new output values to the active channels -------------------------------------------------------*/ /* Setup new values for the used channels */ seq_buf.list[0].value = 0x80; seq_buf.list[0].flags = TP550_CHANENABLE; seq_buf.list[3].value = 0x200; seq_buf.list[3].flags = TP550_CHANENABLE TP550_CORR; result = tp550_cntrl(path, SS_SEQ_WRITE, &seq_buf); TPMC550-SW-12 OS-9 for PPC Device Driver page 13

4 Device Descriptor This chapter will describe the device dependent part of the device descriptor. This part of the descriptor is located in the files named TP550_n. This files define some values which must be adapted to your system and requirements. The following three defines are selecting the device. TPBUSNUM The PCI-bus number the TPMC550 is mounted to. TPDEVNUM The PCI-device number of the slot where your TPMC550 is mounted to. The other defines are used to setup the device descriptor and some OS-9 specific settings. (Value settings which are not described here must be left unchanged). PRIORITY VECTOR IRQLEVEL NAME LLNAME MODULETYP SIGNALNUM Specifies the interrupt polling priority (see OS-9 manuals) Specifies the interrupt vector of your device, this value depends on your carrier and the OS-9 BSP for it. This specifies the interrupt level, normally this value can be left to 1, because there is only one interrupt level. This specifies the name of the device descriptor Must be set to NAME Moduletyp specifies which type of TPMC550 is mounted to the system. The value depends on the modules name. for Example.: TPMC550-10 # ModuleTyp 10 TPMC550-21 # ModuleTyp 21 The signal number defines the signal which will be used for this device. You must set this value to an allowed signal number. TPMC550-SW-12 OS-9 for PPC Device Driver page 14

5 Appendix 5.1 Predefined Symbols The following symbols are predefined in the include file 'TPMC550.H'. tp550drv_cntrl() function codes SS_READ 200 This value is used by the read function SS_WRITE 201 This value is used by the write function SS_SEQ_ENABLE 210 Using this function code will setup and enable the output sequencer SS_SEQ_DISABLE 211 Using this function code will disable the output sequencer SS_SEQ_WRITE 212 This function code allows updating the output values in sequencer mode Channel Flags TP550_LATCHED (1 << 0) Write to the specified channel and use latched mode TP550_SIMULTANOUS (1 << 1) Write to the specified channel and start conversion for all channels TP550_CORR (1 << 8) Use the board specific Calibration data to correct the output TP550_CHANENABLE (1 << 9) Enable channel when starting the sequencer or allow updating the data value when writing new sequencer data 5.2 Status and Error Codes E_NOERR 0x000 No error E_NXIO 0x200 No TPMC550 module found at the specified base address E_HWTIMEOUT 0x201 Hardware timed out (busy active) E_ISBUSY 0x202 Hardware (sequencer) is active E_ILLCHAN 0x203 Illegal channel number specified E_DATAUNDERRUN 0x204 Data underrun E_SEQDISABLED 0x205 Sequencer is disabled TPMC550-SW-12 OS-9 for PPC Device Driver page 15