---

strapdv.h

Go to the documentation of this file.

#ifndef STRAPDV_H
#define STRAPDV_H
/******************************************************************************
* E.S.O. - VLT project
*
* "@(#) $Id: strapdv.h,v 3.4 2002/05/07 09:17:41 vltsccm Exp $"
*
* strap.h  -  This is the interface file for the LCU STRAP device driver which
*             forms a module of the VLT software. It contains the declarations
*             user available constants, data types and variables as well as the
*             function prototypes.
*
* who        when       what
* ---------  ---------- ----------------------------------------------
* microgate  29/07/98   created
*/

#include "lcudrv.h"    /* Include common driver literals */
#include "strapdvCommands.h" /* Include STRAP command definitions */

/*
 * Define mnemonics for driver errors
 */

#define strapdvOK                       0
#define strapdvERR_INV_TIMEOUT       -400  /* Timeout out of range */
#define strapdvERR_INV_IR_LEVEL      -405  /* Interrupt level out of range */
#define strapdvERR_INV_IR_NUMBER     -410  /* Interrupt number out of range */
#define strapdvERR_NO_EXCLUSIVE      -420  /* No channel opened in "exclusive" mode */
#define strapdvERR_INV_BOARD_CONFIG  -425  /* Board configuration mismatch between  */
             /* SW config. parameters and dip-switch  */
#define strapdvERR_IR_CONNECT        -430  /* Cannot connect to specific interrupt */
#define strapdvERR_ENABLE_IR_LEVEL   -435  /* Cannot enable interrupt level        */
#define strapdvERR_NO_DIAG           -440  /* Diagnostic data not yet available    */
#define strapdvERR_NO_DATA           -445  /* Real Time data not yet available     */
#define strapdvERR_INV_PARAMETER     -450  /* Configuration device parameter not valid */
#define strapdvERR_INV_SEM_ID        -455  /* Invalid semaphore identifier           */
#define strapdvERR_INV_RT_PTR        -460  /* Invalid Real Time data buffer pointer  */
#define strapdvERR_OVERFLOW          -465  /* Overflow in circular buffer. Data have */
                                           /* been overwritten */
/* 
 * Define indexes for status mask
 */
#define  strapMASK_CLOSED_LOOP      0
#define  strapMASK_HV_ON            1
#define  strapMASK_OVER_CURR        2
#define  strapMASK_OVER_COUNTS      3
#define  strapMASK_TEMP_CTRL        4
#define  strapMASK_OVER_TEMP        5
#define  strapMASK_DISTURB_MODE     6
#define  strapMASK_HV_FLAG          7
#define  strapMASK_RT_MODE          8
#define  strapMASK_INT_SIGNAL       9
#define  strapMASK_CIRC_BUFFER     10
#define  strapMASK_DATA_READY      11
#define  strapMASK_PROCESS_DIST    12
#define  strapMASK_E2PROM          13
#define  strapMASK_CBUF_OVERFLOW   14
#define  strapMASK_SIMULATION      15

#define  strapMASK_DIAG_MONITOR    16
#define  strapMASK_CHOPPING_MODE   17
#define  strapMASK_CHOP_ON         18

/*
 * TYPE OF STANDARD I/O BLOCKS
 */
#define TYPE_NR_BLOCK_0 0x00      /* command block */
#define TYPE_NR_BLOCK_1 0x01      /* setup block */
#define TYPE_NR_BLOCK_2 0x02      /* disturb block */
#define TYPE_NR_BLOCK_3 0x03      /* not used */
#define TYPE_NR_BLOCK_4 0x04      /* not used */ 
#define TYPE_NR_BLOCK_5 0x05      /* not used */ 
#define TYPE_NR_BLOCK_6 0x06      /* not used */
#define TYPE_NR_BLOCK_7 0x07      /* reply block !!! */
#define TYPE_NR_BLOCK_8 0x08      /* high voltage block */
#define TYPE_NR_BLOCK_9 0x09      /* static block */

/*
 * TYPE OF DOWNLOADING BLOCKS
 */
#define TYPE_DL_BLOCK_0 0x0000    /* command block */
#define TYPE_DL_BLOCK_1 0x0001    /* program memory block */
#define TYPE_DL_BLOCK_2 0x0002    /* data memory block */

/*
 * TYPE OF NOTIFY BY REAL-TIME INTERRUPT
 */
#define RT_NOTIFY       0x0001    /* real time notify */
#define DIAG_NOTIFY     0x0002    /* diagnostic notify */

/* length of setup block */
#define strapLENGTH_OF_SETUP_BLOCK       0x0016   /* in words */

/* length of static block */
#define strapLENGTH_OF_STATIC_BLOCK      0x0029   /* in words */

/* length of status block */
#define strapLENGTH_OF_STATUS_BLOCK      0x0009   /* in words */

/* length of diagnostic block */
#define strapLENGTH_OF_DIAGNOSTIC_BLOCK  0x002B   /* in words */

/* length of disturb sub-block */
#define strapLENGTH_OF_TMPDIST_BLOCK     0x0008   /* in words */

/* length of dspStrap software version */
#define strapLENGTH_OF_SOFTVERS_BLOCK    0x0020   /* in words */

/* maximum number of disturb and data records */
#define strapNUMBER_OF_RAM_RECORDS        58248

/* number of fields in a data records */
#define strapLENGTH_OF_DATA_RECORD            6

/* length of ram data block */
#define strapLENGTH_OF_RAM_BLOCK         0x0078   /* in word */

/* length of HV setu block */
#define strapLENGTH_OF_HV_BLOCK          0x0018   /* in words */

/*
 * Define positions in the array for the static setup fields
 */

#define dspCTRL_COEFF      0
#define dspCOUNT_LIMIT    32
#define dspHIGH_VOLT      33
#define dspGATE           37
#define dspTEMPERATURE    38
#define dspHOLDOFF        39
#define dspTIMEOUT        40

/*
 * Define positions in the array for the Dynamic setup fields
 */

#define dspINT_MATRIX      0
#define dspINT_TIME        4
#define dspDIAG_RATE       5
#define dspDATA_RECS       6
#define dspSPOT_OFFX       7
#define dspSPOT_OFFY       8
#define dspSKYBACKGND      9
#define dspFLUX_THRESHOLD 10
#define dspNUM_CHOP_POS   11
#define dspCHOP_X         12
#define dspCHOP_Y         17

/*
 * STRAP driver provided functions
 */
int strapdvDrv       (int devices, int channels, int timeout);
int strapdvDevCreate (char *devName, void *baseAddrA16, int intrNumber,
          int intrLevel, int boardId);

/*
 * STRAP driver tool functions
 */
int strapdvVersion      (void);
int strapdvDevShow      (void);
int strapdvPrintRegs    (int unit);
int strapdvSetRegs      (int unit, UINT16 value);
int strapdvPrintDevice  (int unit);
int strapdvPrintError   (int errorCode);
int strapdvPrintCmd     (int cmdCode);
int strapdvPrintChannel (int fd);

#endif /* !STRAPDV_H */

---