Digital PDFs

EK-1VAXD-TM-001

August 1979

466 pages

Original

23MB

view download

OCR Version

20MB

view download

Document:	VAX Diagnostic Design Guide
Order Number:	EK-1VAXD-TM
Revision:	001
Pages:	466
Original Filename:

OCR Text

EK-1TVAXD-TM-001

- VAX Diagnostic Design Guide

digital equipment corporation - maynard, massachusetts

First Edition, August 1979

The material in this manual is for informational
purposes and is subject to change without notice..

Digital Equipment Corporation assumes no responsibility for any errors which may appear in

this manual.

Printed in U.S.A.

The following are trademarks of Digital Equipment Corporation,
Maynard, Massachusetts:

DIGITAL

DECsystem-10

MASSBUS

DEC

DECSYSTEM-20

PDP

OMNIBUS

DIBOL

DECUS

0S/8

EDUSYSTEM

UNIBUS

VAX

VMS

RSTS

RSX

IAS

CONTENTS
Page

VAX DIAGNOSTIC ENGINEERING DESIGN PHILOSOPHY

APT-RD

DIAGNOSTIC PROGRAM METRICS
COVERAGE

=
N

o
.

Fault

Troubleshooting
DIAGNOSTIC
DIAGNOSTIC

Isolation

Support

PROGRAM SIZE
EXECUTION TIME

OPERATIONAL FUNCTIONALITY AND DOCUMENTATION

VAX DIAGNOSTIC SYSTEM:

=
N

System

-3

for

the Use of

Environment

System/User

=
N

Level

Environment

System
3

3-1
3-5
3-5
3-8
3-8
3-8

3-10
3-10

Level

(Level 2R)

The VAX System Diagnostic Program

(ESXBB)

3-10
3-11

3-11

DIAGNOSTIC DEVELOPMENT PROCESS
CONSULTATION PHASE
PLANNING PHASE

the

Diagnostics
System Exerciser Tests

>
&
N

|]
[]

—

OB GRS
I

STRUCTURE AND STRATEGY

VAX FAMILY DIAGNOSTIC STRATEGY
Console Environment
CPU Cluster Environment
System and User Environments
System Environment
User Environment
Guidelines

Test Mode Diagnostic Functionality
Troubleshooting and Repair
Diagnostic Functionality

and User Environments

[]

BwWwwWwwh
-

WWwWwwwwww

L]
®
[
®
[]
[]
L]
el
o
|]
[]

w w

SUPPORT

FAULT ISOLATION AND TROUBLESHOOTING

CHAPTER

|
1
B WW NN

=
N

Applications

APT

Diagnostics

I
T

Engineers

|
|
|
N BWWNON
-

o
o
e

wN
-

Automated

FAULT DETECTION

U eWwWwNDNOND
-

NONDN

o
¢
[]

Service

Local Operator Application

o
e

o
o
o
o
o
o
e

Field

DIAGNOSTIC APPLICATIONS

CHAPTER 3

USERS

Computer Design Engineers
Manufacturing Technicians

CHAPTER

DIAGNOSTIC USERS AND APPLICATIONS
DIAGNOSTIC

et
s

CHAPTER 1

Diagnostic Project Plan
Diagnostic Functional Specification
iii

4-1
4-1

4-2
4-2

Diagnostic
IMPLEMENTATION

Program Design
Breadboard

> W

Final

Diagnostic

PART

SYSTEM-WIDE

DIAGNOSTIC

WK
=

mdWwWh
=

COMMANDS

Control

Command File
Execution Control

SUPERVISOR

FUNCTIONAL

DIAGNOSTIC

PROGRAM

OVERALL

PROGRAM

HEADER

Program

Module

Nesting

Functions
DESCRIPTION

DESIGN

STRUCTURE

MODULE

Header Section (Module
Declarations Section

Initialization

TEST

Script

the Script
Format

STRUCTURE AND

Preface)

Routine

Cleanup Routine
Summary Routine
Initialization,

Cleanup,

and

Documentation

SUBROUTINES

AND

THE

GLOBAL

MODULE

ROUTINES

GUIDELINES

Commands

Command

Interrupting

GLOBAL

DW=

[]
o
e
[}

Macros

Sequence

Scripting

L
=3
o
o
o
o
o
o

[]

WNNMNDNDNDN
-

[}

(SO RS N, R NN

o
o
o
o
o
o
e

NN
-

(e )W) We WMo We Wer o W e))

o)}

OYOYON

e
@
*

DIAGNOSTIC

@ Command Processing
Buffer Allocation and

Summary

oo
o b

SUPERVISOR

Program/Test
Scripting

SUBROUTINE

THE

LIBRARY

Utility Macros
Supervisor Service
VMS Service Macros
DIAGNOSTIC

SUPERVISOR

BASICS

SUPERVISOR FUNCTIONS FOR
ENGINEER AND THE USER
MACRO

PHASE

GUIDELINES

($))

SUPERVISOR

Prototype

Implementation

RELEASE

NN, NS NN NS,

AND

B_WWWwWwWwwwwwwpooNon

CHAPTER

and

AND

FOR

TEST MODULES

Guidelines

for

1, 2,
Writing

Guidelines
Guidelines

for
for
for

Writing

Level

Writing
Writing

Level
Level

2R Programs
3 Diagnostic

Guidelines

LEVELS

Programs

2R, 3, 4
Level 1 Programs

Programs

U1'~.|J'|U1U|U'!U1U'l

Engineering

DIAGNOSTIC

Specification

PHASE

Support

(Cont)

R WWND NN

—

L
*

.3
*

o
-

wwN

CONTENTS

(Cont)

Guidelines for Writing

6.5.5

Level 4

UTILITY

MACROS

Header

Directive

Dispatch

Table

Macro

Initialization

Data Section Directives
Device Register Storage

dbdwhHFER

Area
Statistics Table Directives
Section Definition Table

Directives

Quadword Descriptor Directive
Initialization Code Directives
Cleanup Code Directives
Summary Code Directives
Interrupt Service Routine Directives
Test Routine Directives
Message Routine Directives
Numeric Error Header Information

HEWOOJOUMT
b WN Ll -~

PROGRAM

CONTROL

7-13
UTILITY

MACROS

Pass Control Macros
Quick Flag Macros

Operator Flag Macros
Program Subtest Control
Loop Control
Escape

Macros

Control

Macro

Exit from Program Phase Macro
Break in Diagnostic Program Macro
Break on Complete Utility Macros
Branch on Error Utility Macros
Aborting the Test Sequence Macro

$DS CLI

COMMAND LINE

INTERPRETER TREE MACRO

P-TABLE CONTROL MACROS
o
o
¢
&
o
e

[]
e
[}

OWROJAAUNWN
|-

P-Table

e
o
S

NSNNSNNSNNSNNSNNNNSNSNSNNNCNNNNNaNNN

OO LLLTUTOTUBWWWWWWWWWwwww

Directive

[ RVOROIJAAAAD
WD
-

FORMAT

PROGRAM

MACROS

LA
L U s T D R T A

UTILITY

Program Module Directive Macros
Subtitle Directives

R HEREEREFEOONOAUTES
WN -

[]

CODING

UTILITY MACROS

NN
|
Pl

CHAPTER 7
NN DODNDNODNDNDODNODNDNODNODNDNODN
-

GUIDELINES FOR REGISTER TESTING

NN SNSNNNNSNNNNNNNGNONGN

6.6

NN NN

Diagnostics

Descriptor

Macros

$DS SINITIALIZE

$DS $DECIMAL
$DS_$OCTAL
IMAL
$DS_$HEXADEC

$DS_$STRING
$DS_SLITERAL
$DS_$SFETCH
$DS $STORE

$DS $END

Structure Definition Macros

7-13
7-13
7-14
7-15
7-16
7-16
7-18
7-19
7-19
71-20
7-20
7-21
7-21

7-23
7-23
7-23
7-24
7-24
7-24
7-24
7-25
7-25
7-25

7-25
7-25

CONTENTS

SDEFINI
$DEF

7.5.2.1
7.5.2.2

$DEFEND

7.5.2.3
7.5.3

P-Table Control Macro Examples
SYMBOL DEFINITION UTILITY MACROS

7.6

$DS_BITDEF
$DS CFDEF

7.6.1

7.6.2
7.6.3
7.6.4

$DS CHCDEF
$DS_CHIDEF
$DS_CHMDEF

7.6.5

$DS_CHSDEF
$DS_CHDEF
$DS_CLIDEF

7.6.6

7.6.7
7.6.8

$DS DEVTYP

7.6.9
7.6.10
7.6.11
7.6.12
7.6.13
7.6.14
7.6.15
7.6.16
7.6.17
7.6.18
7.6.19
7.6.20

8.3
8.3.1

$DS DSDEF

$DS_DSSDEF

$DS ENVDEF

$DSTM ERRDEF
$DS HDRDEF
$DS HPODEF
$DS PARDEF
$DS_SCBDEF
$DS SECDEF
$DS_DEFDEL

SUPERVISOR
CODING

SERVICE

MACROS

name G

STATUS

PROGRAM

CODES

CONTROL

SERVICE

MACROS

$DS_CNTRLC_x
$DS_INLOOP_x
x
$SDS_SUMMARY

$DS_ENDPASS_x

CHANNEL

SERVICE

MACROS

$DS_CHANNEL_x
x
$DS_SETMAP

8.4.2
8.4.3

_x
$DS_SHOWCHAN

MEMORY

MANAGEMENT

SERVICE

$DS_MMON_x

_x
$DS_MMOFF

8.5.2
8.5.3
8.5.4

8.6
8.6.1
8.6.2
8.6.3

MACROS

$DS_name_S
RETURN

8.3.2

8.5
8.5.1

SUPERVISOR

$DS

8.3.3
8.3.4
8.4
8.4.1

SERVICE

_x
$DS_GETBUF

$DS RELBUF x

DELAY

SERVICE

MACROS

$DS_WAITUS x

x
$DS_WAITMS
x
T
ANWAI
$DS_C

8.1

8.1.1
8.1.2
8.2

$DS_DSADEF

Q0 00 00 00 G0 00 OO0 0o OO0 O QO
|
I
L
DWW
J~JJO0O BN

CHAPTER

(Cont)

MACROS

CONTENTS

(Cont)

[]

D W
-

[]
o
o
o

B WN

o
o
o
o
o
o
o
o
o

WHNMNDNNDNDNE
WN -

$DS_ASKSTR_x

x
$DS_ASKDATA
$DS_ASKVLD_ x

x
$DS_ASKLGCL
AU

$DS_ASKADR_x

$DS_PARSE_x

SERVICE MACROS

$DS_INITSCB_

HARDWARE P-TABLE ACCESS

'u
-3

$DS_GPHARD_x

VMS SERVICE MACROS
CODING

VMS

SERVICE

$name G
$Sname_S

e o
(S

BB WWWWWWWWWWWN
et

CONTROL

x
$DS_CLRVEC

MACROS

RETURN

=
W N
B

o
¢
e

aAanMbdbwwwwwn
-

I/0

STATUS CODES
SERVICE MACROS

x
$ASSIGN
x
SDASSGN
$QI0 x
T QIO Service Diagnostic Functions
Function Encoding
Synchronizing I/0 Completion
I/0 Completion Status
SQIOW
x

SGETCHAN

SCANCEL
x

EVENT FLAG
N
W
=

o
o
*

®
o

°
0

o
o

x
$DS_PRINTS

$DS_CVTREG_x

¢
o

o
¢

6
&
6
8
©
o
o
¢

x
$DS__PRINTX
x
$DS_PRINTF

_
$DS_SETIPLx
$DS_SETVEC_x

BB BB

Information Message Macros

$DS_ERRSYS_x
$DS_ERRDEV_x
$DS_ERRHARD_x
$DS_ERRSOFT x
Information Print Macros
$DS_PRINTB_x

SYSTEM

OCOWOWOOVOWOWOOWOWOWOWOWWYWOWOYWLOW

Header

PROGRAM-OPERATOR DIALOGUE SERVICE MACROS

ERROR MESSAGE SERVICE MACROS

HEWYOWOVUWOVWOVWOWOOOWOOOMWONOMINNNNNNNNNNIN

00 00 00 00 00 00 00 00 00 00 00 O CO 00 CO OO 0O OO CO0 00 00 00 CO 0o O €O

Page

SERVICE

SSETEF x

_x
SCLREF

SREADEF
x

x
SWAITFR
x
SWFLAND

vii

MACROS

8-23
8-24
8-24
8-26
8-27
8-28
8-28
8-33
8-34
8-35
8-35
8-36
8-40
8-42
8-43
8-43
8-46
8-46
8-48
8-53
8-53
8-54
8-54
8-54
8-55

8-55

CONTENTS

(Cont)

SERVICE

(@)

wNn
-

SGETTIM x

(o) T, I -3

Specifying

9-38

9-38
9-49
9-41
9-42
9-42
9-44
9-44

$CANTIM

Use

Timer

Services

ASCII

OUTPUT

SERVICE

10.6
10.7
10.8

10.9

MACROS

x
$FAO_
x
$FAOL

B wN
-

190.5

of the

FAO

Directives
String
Processing

FAO

Control

MANAGEMENT

HIBERNATE

190.1

Time Values at Assembly

X
SSETIMR

MEMORY

16.2
16.3
1.4

Delta

AND

WAKE

and

SERVICE

Parameter

MACROS

x
SHIBER
X
SWAKE
UNWIND

SERVICE

DIAGNOSTIC

MACRO

SYSTEM MACRO

SASSIGN x

9-45
9-48
9-49
9-50
9-51
9-52

DICTIONARY
19-1
19-4
19-5

x
SBINTIM
x
SCANCEL
x
SCANTIM

190-6

SCLREF
x

19-7

SDASSGN
_x
SDEF
$DEFEND

19-8
19-9
19-9

SDEFINI

10-9

ABORT

19.11

$DS_ASKADR_x

16-9
10-10

19.12

A
$SDS_ASKDATx

10-11

10.10

10.13

10.14
19.15
10.16

19.17
19.18

190.19
10.20
190.21
10.22
19.23

10.24
10.25
10.26

10. 27

$DS

9-33
9-34
9-35
9-35

Time

FORMATTED

CHAPTER

MACROS

SBINTIM
x

o
o
e

o
o

o
e

o
o
«

o
e

Weor R e e T, O, NS,

WO WY WILWYWWOWYWOWY

()

O O O WY

$SWFLOR_x
TIMER

\O© 00 00 00 ~J

(SIS0
BN O -

O WO WYY
Y

Page

$DS_ASKLGCL
x
$DS_ASKSTR
X
$DS ASKVLD

10-14

$DS BERROR

10-15
10-16

19-12
19-13

$DS_BCOMPLETE
$DS_BGNCLEAN
$SDS BGNDATA

190-16
10-16

$DS BGNINIT
$DSBGNMESSAGE
$DS BGNMOD

10-17
19-17
19-17

$DS_BGNREG
$DS_BGNSERV
$DS BGNSTAT

19-18
19-18
19-18
190-18
19-18

$DS BGNSUB
$DS_BGNSUMMARY

viii

CONTENTS

(Cont)
Page

10.28
19.29
10.30
19.31
10.32
19.33
10.34
10.35
14.36
18.37
19.38
19. 39
10.40
19.41
10.42
19.43

10.44
19.45
10.46
10.47
10.48
10. 49
19.580

18.51
16.52

19.53

16-19
16-19
10-20

$DS BGNTEST

$DS BITDEF

$DS BNCOMPLETE
$DS_BNERROR

10-20
10-290
190-2¢0

$DS_BNOPER

$DS_BNPASS@
$DS_BNQUICK

$DS BOPER
$DS BPASS@
$DS_BQUICK
$DS_BREAK

$DS CANWAIT

$SDS”_CFDEF

19-21
19-21
19-21
19-21
19-22

19-22
19-22
19-22
10-26

$DS CHANNEL x

$DS__CHCDEF
$DS CHDEF

10-26
10-26
19-27
19-27

$DS_CKLOOP
$DS_CLI
$DS _CLIDEF
$DS_CLRVEC_x

10-27

$DS CHIDEF
$DS CHMDEF
$DF__CHSDEF

10-28
16-29
19-29

x
$DS CNTRLC
$DS_CVTREG_x
$DS_DEFDEL

10-30
16-390

19-31

16.54
16.55

$DS DEVTYP

10-31
19-32

19.56

$DS_DSADEF
$DS DSDEF

19-32

196.57
16.58

10.59
19.690
18.61
10.62

190.63
190.64
18.65
10.66
16.67
16.68
19.69
10.70

10.71
19.72
10.73

$DS _DISPATCH

$DS ENDDATA

$DS_ENDINIT
$DS_ENDMESSAGE
$DS ENDMOD

$DS ENDPASS x
$DS_ENDREG
$DS

ENDSERV

$DS

ENDSUB

$DS_ENDSTAT

$DSENDSUMMARY
$DS ENDTEST
$DS ENVDEF
$DS_ERRDEF
$DS ERRDEV x

10.74

D
$DS_ERRHARx

19.75
16.76

$DS_ERRSOFT

18.77

19-33
19-34
190-35
19-36
16-36
10-36
19-36
18-36
16-37
10-37
16-37
10-37
19-37
10-38
19-38
19-38
19-39
16-39
10-40
10-41
19-41

$DS DSSDEF
$DSENDCLEAN

$DS ERRNUM

$DS_ERRSYS_x

CONTENTS

(Cont)
Page

10.78

$DS_ESCAPE

14.79
10-8¢
16.81
10.82
10.83

$DS_EXIT

19-43
19-43

$DS_GPHARD
x

19-43
10-44

10.84
14.85
10.86
10.87

19.88
16.89
16.99
16.91
10.92
16.93
10.94
10.95
10.96
16.97
16.98
14.99
10.100

16.101
10.102
16.103
19.104
16.105
10.106
10.107
1¢.108

10.189
16.110
14.111
10.112
16.113
19.114
10.115
10.116
16.117

16.118
18.119
14.119.1
19.119.2

10.120
190.121
10.122
16.123
10.124

$DS_GETBUF_x

$DS_HDRDEF

$DS_HEADER
$DS_HPODEF
$DS INITSCB x

10-44
10-45

19-45

x
$DS_INLOOP

19-46
10-46

$DS_MMON_x

19-47

$DS_MMOFF_x

$DS_PAGE
$DS_PARDEF
$DS_PARSE_x
$DS_PRINTB_x
x
$DS_PRINTF
$DS_PRINTS
x
x
$DS_PRINTX
$DS_PSLDEF
$DS_RELBUF_x
$DS_SBTTL
$DS_SCBDEF

$DS_SECDEF

$DS_SECTION
$DS_SETIPL

$DS_SETMAP_x
$DS_SETVEC_x

$DS_SHOWCHAN_x
$DS_STRING

19-46
19-47
10-47
10-48

10-48
10-50

18-50
19-51
16-51
10-52
16-52
10-53
10-54
19-54
10-54
19-54

19-56
19-57
18-57

x
$DS_SUMMARY_
x
$DS_WAITMS_

10-58

$DS_$DECIMAL
$DS_SEND
SDS_SFETCH
$DS_SHEXADECIMAL

19-59

$DS_WAITUS
x

19-58
190-58
19-59

10-59

$DS_$INITIALIZE

190-60
10-60

$DS_S$OCTAL

10-60
19-60

$DS_SLITERAL

$DS_$STORE

$DS_$STRING

$FAO
x
FAO Directives
FAO Control String and
Parameter Processing
SFAOL_x

SGETCHN_x
x
SGETTIM
SHIBER S

$QI0
x

19-61

19-61
19-61
10-62
190-63
10-66

190-67

10-69
19-79
10-70

CONTENTS

(Cont)
Page

CHAPTER

10-74

SQIOW
x
SREADEF _x 18-75

16.125
10.126
19.127
16.128
10.129
16.130
190.131
16.132
16.133
19.134

SSETEF
x
x
$SETIMR
X
$SETPRT
x
SUNWIND
SWAITFR x

10-75
10-76
19-78
10-80

10-80
19-81
19-82
16-83

SWAKE x
x
SWFLAND

$SWFLOR_x

11.1

DIAGNOSTIC

PROGRAM

FILE
Documentation

DOCUMENTATION

11-1

DOCUMENTATION

11.1.1

Cover

Sheet

Program Abstract
Hardware Requirements
Software Requirements
Prerequisites
Operating Instructions
Program Functional Description

11.1.2

11.1.3
11.1.4
11.1.5
11.1.6
11.1.7
11.2

MODULE

Directives

Environment Statement
Program and Module Version Numbers
Module Maintenance History
Module Functional Description

11.2.4
11.2.5

11.2.6
11.3
11.3.1

ROUTINE

Parameters

Completion Codes
Side Effects
Register Usage

2.4
2.5
2.6
COMMENTS

Block
Group

Line
CHAPTER

12.1
12.2
12.3
12,4

11-5

11-7
11-7

11-7

11-8
11-9
11-19

11-10

PREFACE

Routine Functional Description
Routine Interface Sequence
Calling
Input and Output Parameters
Implicit Input and Output

11.3.2
11.3. 2. 1
11.3. 2.2
2.3

11-4
11-4
11-6

PREFACE

Linker and Assembler
Copyright Statement

11.2.1
11.2.2
11.2.3

11-2
11-3
11-3
11-4

Comments
Comments

Comments

11-12

11-13
11-13

11-13

11-14
11-14
11-14
11-14
11-14
11-15
11-16
11-17

CODING CONVENTIONS AND PROCEDURES
GUIDELINES FOR EXECUTABLE CODES
SUBROUTINE GUIDELINES

GLOBAL

ERROR

MESSAGE

HANDLING

ROUTINES

INTERRUPTS

12-1
12-2
12-2
12-4

CONTENTS

(Cont)
Page

12.5
12.6

ASYNCHRONOUS

12.7
12.7.1
12.7.2
12.7.3
12.8

USER-DEFINED

EXCEPTION
Data

Macro
SYMBOL

12-6

CONDITION

HANDLERS

MACROS

that Build
Libraries

NAMING

13.1
13.2

EXTERNAL

Executable

Code

CONVENTIONS

PROGRAM

INTERFACE

12-15
12-16
12-16
12-16
12-16
12-18
12-19

DIAGNOSTIC

CONSIDERATIONS

SETUP

AUTOMATED

12-19

12-14
12-14

Macros

Public Symbols
Private Symbols
Object Data Types
ASSEMBLY AND LINK PROCEDURES

12.9
CHAPTER

TRAPS

AND

Structure

Macros

12.8.1
12.8.2
12.8.3

SYSTEM

HANDLERS

13-1

PRODUCT

TEST

(APT)

CONSTRAINTS

13-1
13-2
13-2
13-2

13.3

SCRIPTING

CONSTRAINTS

13.4

RUN-TIME

CONSIDERATIONS

13.5

PARALLEL

13.6
13.7

LOOPING

CONSTRAINTS

13-3

VOLUME

VERIFICATION

13.8

LONG

13-3
13-3

CHAPTER

14.1

VERSUS

COMMON

TEST

CODING

Endless

14.1.3

14.1.4
14.1.5

DESIGN

ERRORS

AND

THEIR

SYMPTOMS

Loops

14-1
14-2
14-2

Improper

14-2

Forgetting

14.1.8

Stack
QUALITY

Context

the

I/0

Number

Underflow

ASSURANCE

for
and

References

Sign

(#)

14-3
14-3

14.2.2
14.2.3
14.2.4

Conventions Check
Load and Execution Check
Fault Detection and Reporting
Operational Checks
User Mode Checks
DEBUG

AND

UTILITY

DIAGNOSTIC

14.3.1
14.3.2
14.3.3
14.3.4
14.3.5
14.3.6

14-3

PROCEDURES

Specifications

14.2.6
14.3

Check

COMMANDS

SUPERVISOR

Set

Base

Command

Set

Breakpoint

Command

Clear Breakpoint Command
Show Breakpoints Command
Set Default Command
Example Command

xii

14-2
14-3

Overflow

14.2.1

14.2.5

14-1

Forgetting Initialization
Forgetting Return Status
Neglecting to Save Registers
Forgetting the Context or Properties
of an Instruction

14.1.6
14.1.7
14.2

TESTING

SILENCES

DEBUGGING

14.1.1
14.1.2

SERIAL

14-3
14-4

Check

14-4
14-5

14-6

THE

14-6

14-6
14-6
14-7
14-7
14-7
14-8

CONTENTS

(Cont)
Page

14-9
14-9

Deposit Command
Next Command

14.3.7
14.3.8
APPENDIX A

A SAMPLE DIAGNOSTIC PROGRAM

APPENDIX B

GLOSSARY OF DIAGNOSTIC SOFTWARE TERMS

FIGURES

Figure No.

Title

3-1

VAX Diagnostic

T’Q

\O\D\D\?\O
|

O 00il

W
N

o wm[

W
N

()]

H o

|
L{n»ww
|

e w

)

Environments

12-2

12-3
12-4
12-5
12-6

The

Building

System:

and

Program Levels,

Operating

Modes

Block Structure of

the

Diagnostic Environments
Console Environment
CPU Cluster Environment
System Environment
Diagnostic Supervisor Functional Block
Diagram
Diagnostic Supervisor and Diagnostic
Program Interaction
Diagnostic System Memory Allocation
Memory Format for RELBUF Supervisor
Service Macro Arguments
Operator Dialogue Flowchart
Command Interpreter Tree Structure
Memory Format for the ASSIGN VMS
Service Macro Arguments
Queue I/0 Diagnostic Buffer Format
I/0 Function Format
Function Modifier Format
I/0 Status Block Format
Buffer Layout Supplied by the GETCHAN
System Service
Diagnostic Buffer Format
Printing and Error Message, Program Flow
Handling Interrupts

Coordination of

I/0 Transfer with an AST

Data Structures that Support the AST
Condition Handler Flowchart
Condition Handler Argument List and
Associated Arrays

xiii

TABLES

=
|

\D\D\O&O\D\O\?\D\D\D@O\U‘l

HOOJOAUNDWN
R

Table No.

Title

Page

Device

5-6
6-9
8-31
9-15
9-17
9-18
9-19
9-20
9-20
9-2¢0
9-21

Naming Conventions
Symbolic Offsets
Summary of FAO Directives
Read and Write I/0 Functions
Terminal I/0 Driver Functions
Disk I/0 Driver Functions
Magnetic Tape I/O Driver Functions
Line Printer I/0 Driver Functions
Card Reader I/0 Driver Functions
Mailbox I/0 Driver Functions
P-Table

DMC-11

I/0

Driver

Functions

ACP

Interface Driver Functions
Field Function for ASCII Absolute

or Delta Time Values
Summary of FAO Directives
Summary

12-1

FAO

Object

Data

14-1

Examine

9-37
9-46
19-64

Directives

Types

Command

9-21

12-18

Qualifier

Descriptions

14-8

—

(%]

e M) e ) Wer e ) WS, T, NS,
|
|
[
I
OO
& WN = (RPRRERA
e
192N

Command
Command

Load

Attach

Run

Select

Commands

Command
Select Command
Deselect Command
Show Device and Show
Start Command
Command

Use of Control C,
Continue Commands

Summary,

and

Use

Summary,

and
'

Control

Commands

Typical
Execution

Command File
of a Typical

Command

File

Use of the Flag Control Commands
Event Flags Control Commands
A Program Header Module Preface
Declarations Section
Program Header Data Block
Dispatch Table Psect
P-Table

Global

Program
Error

Format

Data

Text

Report

Section

Section
Statement

Xiv

HFROIIIUTdL
D

U'IU'|U1(f1U1U'|U'I
L
N

Load

Abort
5-12

Command

Load

Show

Set

Title

U1U10'IU1U'I({|U1U1U1U1
I
T
I
B
[
I
I

HOONOUL
s WN -

Example No.

EXAMPLES

(Cont)
Page

6-9

Initialization
Device Testing

Routine

for

Parallel

6-19

Initialization

Routine

for

Serial

6-14

Device
6-15

Testing

6-16

for a

Routine

6-18

The Passing of Parameters from a Calling
Routine to a Global Subroutine
Arrangement of Arguments on the Stack
Use of Structural Macros to Define Test
and Subtest Boundaries
Typical

Test

and

32-Bit

Header

Macro

Subtest

Test

Documentation

Patterns

Format

Name

Use of Begin and End Module Macros
Subtitle Directives
Expansion of the $DS_HEADER Macro in the
DZ11 Diagnostic Program (ESDAA)
Use of the $DS_DISPATCH Macro
Test Argument Table Directives
Device Register Storage Area Directives
Statistics Table Directives
Use of the $DS_SECTION and $DS_SECDEF Macros
Quadword Descriptor Directive
Initialization Code Directive
Cleanup Code Directives
Summary

Code Directives
Interrupt Service Routine Directives
Test Directives
Message Routine Directives
Pass Control in Initialization Code
Quick Flag Macros
Operator Flag Macros
Program Subtest Control Macros
Loop Control Macro Use
Escape Control Macro
Branch on Complete Utility Macro
Program Abort Macro
Building a Data Structure
P-Table Offsets

for

Use

the

Building a P-Table Descriptor
Use of the $DS name L Macro Format

6-20
6-22
6-26
7-1

Specification of Arguments by Position
Specification of Arguments by Keyword Names
Specification of Arguments by Position and
Keyword

6-19
6-19

RH780

Data

6-15

B W N

Received

S|EMOOOIJoU;m

and

for

Level

<N~

Expected

Typical Design Specification
Summary Report Routine
Typical Design Specification

for

Design Specification
Cleanup Routine

Typical
Program

NNNNNNY
i
|
I

6-11

Macro

=
o 0

B wWwHS

Format

Macro
Status
Code

$DS CNTRLC x Macro Usage
Use of the$DS_INLOOP
x Macro
Use

the

$DS_ENDPASS
the

Unibus

Macro

Call

Channel

with

=00~ Ww

wn
o

00 o

Use of the $DS SETMAP x Macro
of

the

$DS

SHOWCHAN x

Macro

Use of the $DS WAITUS xMacro
Coordination of the $DS_WAITMS x
$DS_CANWAIT

and

x Macros

Error Message Header Format

Sample

Use
Use

Error Message Header Printout
the $DS_ERRSYS
x Macro
the $DSERRHARD x Macro

of
of

Standard

Use

for

Basic

$DSPRINTB x

$DS_CVTREGx

Error

Messages

Macro

Error Message

Prompting and Parsing
Use of the $DS GPHARD

Command

Macro

Vo)

(o]

Use of the $name Macro Format to
Build an Argument List
Calling a VMS Service with the $name
G
> W

O O

the

Sample

Macro

Format

Modification

Uses

%))

o)
= O o0

Macro

O WYY

Formats

the

$name
G,

Argument

S$name,

and

List

S$SnameDEF

Formats

Checking the Return Status
Error Condition
Checking the Return Status
Determine the Nature of an
Use of the SASSIGN
x Macro

Code

the

Absolute

$BINTIM x

Time Value to

xvi

for

Code to
Error

Use of the $DASSGN x Macro
Synchronizing I/0 Completion,
Use

www

the

$DS_CHANNEL
x Macro

Use

1911

with Arguments

Position

Expansion of the $DS RELBUF_S
Testing for Successful Return
Identifying the Return Status

Resetting

0 oo
o o]

Format

Three Methods

Convert

System

OCoOJanhoMhuo,m

$DS_name S

$DS_name DEF Macro Formats
Use of the $DS nameS Macro
with Keywords

Form

0 0o 00 00 00 0o TM
L

o)
~

Expansion of $DS _name G Macro

the

with

Build an Argument List
Calling a Supervisor Service
$DS_name
G Macro Format

Specified by
Q0 CO 00 €0 00 GO CO

(Cont)

Modification of an Argument List
Uses of $DS_name G, $DS nameL, and

0 0

10.¢)

EXAMPLES

Format

EXAMPLES

(Cont)
Page

Use

Value

SBINTIM x

Convert a

to System Format

Create

Use of the SETIMR Service
at an Absolute Time

Call

Second

SETIMR

Time
9-38

Service

the

Delta

a
9-41

Delay

AST
-9-42

Documentation Cover Sheet
Program Abstract
Hardware Requirements Documentation
Software Requirements Documentation
Prerequisites
Operating Instructions
Test Description
Linker and Assembler Directives in
the Module Preface
and Link Commands Shown
in the Environment Statement
Module History
Sample Routine Preface
Standard Calling Sequence

11-3
11-3
11-4

11-4
11-4
11-5
11-6
11-7

Assemble

Input

11-8

11-10
- 11-12

11-13
11-13
11-14

Parameters

Output

Parameters

Implicit

Inputs
Completion Codes

11-14

Block

11-14
11-15

Comment

11-16
11-18

Group Comments
Line Comments

Declaration of a Condition Handler
Continue from a Condition Handler
Resignal and Return from a
Condition Handler
A Table of Addresses and Strings
A

Data

A Macro

Structure
that

Macro

Definition

Generates

Executable

12-190
12-13

12-13
12-14
12-15
Code

Creating a Library
Include Files
Assembly and Link Commands
A Special Prompt Message for the
$DS_ASKxxX
_x Macro
A Special Prompt Message that Causes
Rejection of Scripted Responses
Set Base Command
Set Breakpoint Command
Clear Breakpoint Command
Show Breakpoints Command
Set Default Command
Example Command
Deposit Command
Next Command

xvii

12-15

12-16
12-16
12-19

13-2
13-2
14-6

14-7
14-7
14-7
14-8
14-8
14-9
14-9

PREFACE

This manual presents an overview of the VAX diagnostic philosophy
and procedures and an explanation of how to write diagnostic
It is written for diagnostic
programs for VAX Family computers.
engineers who are familiar with the VAX-11l Macro assembly
language, VAX hardware, the VAX/VMS operating system, and the
You can use the manual as a
hardware device to be tested.
tutorial guide to diagnostic program development or as a reference
for specific features of the diagnostic supervisor and diagnostic

macro

library.

manual

consists

standards.

The

two

Part

parts.

the

describes

VAX

It deals with diagnostic
diagnostic engineering philosophy.
goals, functions, methods, and the structure of the VAX diagnostic
It tells you how
system. Part II presents system-wide guidelines.
with the
interface
to write a diagnostic program that will
ng
engineeri
diagnostic supervisor and that will conform to DIGITAL
’

category

(assertion)

(CHSSM| SYSERR, CHSS$M| CHNERR,
CHSSM| DEVERR, CHSSM PGMERR)

Interrupt Status Definitions
CHISM CHNINT
CHI$M DEVINT
CHI$M IPL

When

CHCS$

header
A

ENINT

module

complete

list

DS$ NORMAL:

DS$_PROGERR:

Channel

Device

interrupt

Interrupt

$DS_CHIDEF

used,

define

(Status 2)

the

return

Service
Program

status

should

codes

successfully
error

used

returned

for

level

the

completed.

program

STSADR.

$DS_CHANNEL
x

encountered.

8-12

priority

follows:

Supervisor Service Macros

The adapter
Initial hardware error encountered.
DS$ IHWE:
hardware status was found to be in error before performance

requested

the

performed.

function

The

function.

will

not

DS$ FHWE: Final hardware error status encountered. The
adapter hardware status was found to be 1in error after
performance of the requested function. The capability of the
adapter to correctly operate is in question.
DS$ LOGIC: An adapter function that sets or clears an adapter
The capability of the adapter to
status bit has failed.
correctly operate

DS$ IVVECT:

is in question.

An invalid vector has been given as an argument.

DS$ IVADDR: An

invalid address has been given as an argument.

DS$ ERROR: An

error

shows

how

has been

found

trying to associate a

hardware P-table with the logical unit argument.

Example

8-14

reset the Unibus channel
L SBTTL

the

$DS_CHANNEL_x

(DW780).

macro

can

test

used

INITIALIZATION CODE

(error

Reset

UBA.

Branch

;

Failure,

%N
W0

UNIT,

FUNC = #CHCS$_INITA
$DS_BNERROR 10%
;

channel call
device under

S $DS_CHANNEL
UNIT = LOG

$DS BGNINIT

message)

$DS_ABORT PROGRAM

Example 8-14
with

Resetting

successful.

abort program.

the Unibus Channel

the $DS_CHANNEL
x Macro

8-13

VAX Diagnostic

8.4.2
This

Design Guide

$DS_SETMAP
x Set Channel Adapter Mapping

macro

adapter

enables

mapping

$DS_SETMAP
x
unit

the

func

the
to

phyadr

for

unit,

the

transfers.

func,

phyadr,

logical

function
be

the

diagnostic

I/O

unit

physical
will
be

code

symbol
See

adapter

the
two

[bytcnt],

channel

[datpth]

specifying

the

listed

1longword

array

type

describing

addresses.
addresses

Normally
returned

the

these
by
a

select.

corresponds

mapping

below.

call.

map register

parameter

set

symbols

buffer start and end
the
start
and
end

$DS_GETBUF_
x macro
mapbas

[mapbas],

number.

performed.

address

engineer

the

For

the

upper

UBA

bits

(DW788)
of

the

this

Unibus

address (bits 17:09)
to be used in the base address (BA)
registers of the desired device. The number supplied for
the MAPBAS parameter to the UBA should be in the range

For

to 495
the

MBA

(decimal).
(RH780)

the

MAPBAS

current map register through
map register. The default for

bytcnt

the

positive

byte

count

parameter

bits

16:89 of the
MAPBAS is zero.

(used

for

This
field
is
ignored
when
the
However, the field is checked for
the adapter type to be used.

datpth=

UBA

(DW780)

ignored
Function

Argument

Symbol

CHMS FORWARD

when

data
the

path

MBA

number

(RH780)

the

UBA

(DW780)

(8-15).

virtual

(RH780)

validity

only).

1is

used.

regardless

This

used.

the

field

Symbols
Function

Prime

the

operation.

CHMS REVERSE

selects

Prime

the

operation.

CHMS INVALIDATE

Invalidate

CHMS MAP

Set

CHM$ OFFSET

Mapping

adapter

for

forward

adapter

for

reverse

all

requested

map

entries.

mapping.

with byte offset.

Supervisor

CHMS_MFWDV

Service Macros

Invalidate all map entries,
set requested mapping,
for
adapter
the
prime

forward

operation.

CHM$_MFWDN

not

invalidate any map entries,

set requested mapping,

prime
the
operation.
CHM$ NFWDN

CHMS MREVV

not

adapter

for

forward

invalidate any map entries,

do not set mapping,
adapter
the
prime
operation.

for

forward

reverse

Invalidate all map entries,

set requested mapping,
adapter
the
prime

for

operation.

CHM$_MREVN

‘CHM$ _NREVN

CHM$_MFWDVO

Do not invalidate any map entries,
set requested mapping,
adapter
the
prime
operation.

Do not

for

Invalidate all map entries,
set requested mapping with byte
adapter
the
(UBA only), prime

reverse

offset,
a
for

operation.

Do not invalidate any map entries,
set requested mapping with byte offset,
a
for
adapter
the
(UBA only), prime
forward

CHM$ _MREVVO

reverse

invalidate any map entries,

do not set mapping,
adapter
the
prime
operation.

forward

CHM$ _MFWDNO

for

operation.

Invalidate

all map entries,

set requested mapping with byte offset,
a
for
adapter
the
(UBA only), prime
reverse operation.

VNO
CHM$_MRE

Do not invalidate any map entries,
set requested mapping with byte
adapter
the
(UBA only), prime
reverse

operation.

offset,
a
for

VAX Diagnostic Design Guide

Return

Status

DS$_NORMAL:

Codes

Service

DS$ PROGERR:

successfully completed.

Program

error.

The

buffer

address

out

the base address is out of range
(9
through 255-MBA,
495-UBA), or the specified byte count is too large.

range,

through

DS$_IHWE: Adapter hardware error status was encountered before the

mapping
the

was

performed.

mapping

DSS ERROR:

will

P-table

with

Example

8-15

error
the

The

error

condition

has

been

found

logical

unit

argument.

the

set

shows

must

cleared

before

performed.

how

trying

map

associate

service

can

hardware

be set

and

executed.

SECTOR

W
W

CLRL

#256,

WORD COUNT

cyl

=1
track = 0
sector = @

Specify word count for
compare.

Initialize

disk

drive.

R3,

;

disk

address

and

CYLN,

MOVB
MOVB

TRACK, RKDA+1 (R2)
SECTOR, RKDA(R2)

map

RKDCYL(R2)

RKWC(R2)

#701000

WMo

MOW

RKBA (R2)

SDS _SETMAPS "UNIT =LSUNIT, FUNC = #CHM$ MFWDV,-

PHYADR

= WRITE

MAPBAS = #1,
DATPTH = #1

Load

WME

#256,

Load cylinder.
Load track.

BUFFER,

sector.

Word count = 256.
Set transfer address
(8).

BA.

MNEGW

done.

buffers.
N

MOV

CLRW

Loop until

25%

#64,

Load

Clear index.
Fill write buffer
indexed by R3.

AOBLSS

1000

CLRL

MOVQ # “XFFFF00QOFFFFO008,
@WRITE BUFFER[R3]

205:

“e

wmo

MOVZWL

CYLN

WMe

TRACK

WMe

#1,

CLRL

MOVZBL

Clear

;
;
;
;
;

device
Invalidate all map
entries, set requested
mapping, prime adapter
for a forward operation.

;
;

Unibus page 1
direct data path

Supervisor Service Macros

$DS BNERROR 30%
$DSZERRSYS_S, LSUNIT, UBAMAP, -

to disk.

MOWW #WRITE,

HOLD CSl1

“o

;

JSB @START XFER
409

error

reporting code

$DS_§BORT TEST
; Initiate NPR transfer,
; read from memory, write
wme

308$:

UBA

DUMP

Define command
to be executed.
Execute command.

BLBS R#, 40$
; (error message)
[4

;

(compare expected and received data)

Example 8-15

Use of the $DS_SETMAP_x Macro

In Example 8-15 the $DS SETMAP_x macro enables the program to set

a failure of
up map registers on the channel adapter. Notice that to
be fatal.
ered
consid
is
and
error
system
a
this function is
drive
disk
the
up,
set
sfully
succes
been
After the transfer has
the
from
data
ve
retrie
to
ers
transf
will perform NPR read
WRITE BUFFER in memory through the direct data path.

disk drive
After successful completion of the NPR transfer, the upt
service
interr
The
upt.
interr
an
m
under test should perfor
routine can then return control to the program.

8.4.3

$DS SHOWCHAN x Show Channel Registers

This macro <calls a supervisor

routine

(DSX$SHOWCHAN)

which

the configuration register
displays on the operator
ts for the channel adapter
conten
er
regist
contents and the status
require the display of
that
errors
tes
indica
in use. If the status
terminal

additional registers, those registers will also be displayed. For
the
example, if the status register indicates an invaliyd map,
each
for
displa
The
ed.
display
be
will
‘relevant map register

al address of
register contains the register mnemonics, the physic
ption of
descri
ic
mnemon
a
and
ts,
conten
er
the register, the regist
the register contents.

$DS_SHOWCHAN_x unit

unit =

logical unit number.

Return Status Codes

DSS$_NORMAL: Service successfully completed.

DS$_PROGERR: An error has been found while trying to associate a
hardware P-table with the logical unit argument.

»Example 8-16 shows how the $DS_SHOWCHAN_Xx macro should be used to
display channel

information.

VAX Diagnostic

Design Guide

CSRERR:

.ASCIC \ERROR

MSG_TAG:

$DS_BGNMESSAGE

CSR\

$DS_PRINTB S...
=

LOG_UNIT

Wmg

UNIT

$DS_SHOWCHAN -

$DS_PRINTB S...
$DS_PRINTB_S...

error

description

Display channel
information.
Display device CSR.
Display device SR status
register.

$DS_ENDMESSAGE

;

TEST

SDS_BNERROR 182$

;

S$DS ERRHARD
S “UNIT = LOG_UNIT,
MSGADR
PRLINK

19$:

;

this

example,

subroutine

8.5

there an

Yes,

print.

error?

= MSG_TAG

8-16
the

test
Use

the

$DS_SHOWCHAN
x Macro

$DS_SHOWCHAN
x

called

SDS_ERRHARD_x macro

= CSRERR,

continue with
Example

;

through

in Test N

macro

the

PRLINK

incorporated

parameter

(refer to Paragraph 8.7.1.3).

the

MEMORY MANAGEMENT SERVICE MACROS
management
for the diagnostic system is provided by
supervisor
or VMS.
These memory management services

All
memory
either
the
ensure

system

various

operating

integrity

and

operational

environments

and

consistency

processor

types.

across

the

stand-

alone environment, memory management is normally off.
In the WS
environment, memory management is totally controlled
by WS and is
always on.

The supervisor provides
services
that allocate memory,
both
virtual and physical. Physical memory allocation
is restricted to
level 3 diagnostic programs.
8.5.1
$DS_MMON_x Turn Memory Management On
This macro calls a supervisor routine (DSX$MMON)
management

on.

$DS_MMON_x

(no arguments)

Return

Status

Use

this

Codes:

macro

None.

level

programs

that

turns memory

only.

Supervisor Service Macros

$DS_MMOFF_x Turn Memory Management off
8.5.2
calls a supervisor routine (DSXSMMOFF)
macro
This

that turns
only.
ms
progra
3
level
in
memory management off. Use this macro
$DS_MMOFF_x

(no arguments)

Return Status Codes:

8.5.3

None.

$DS_GETBUF_x Get Virtual Memory Space

This macro

calls

supervisor

service

(DSXSGETBUF)

routine

obtain memory space for buffer areas. The service allocates memory

In the
space at the logical end of the program (Figure 5-3).
is
tion
alloca
memory
l
standalone environment, the physica
Control
for
check
to
AK
DSSBRE
contiguous. The routine also calls

$DS_GETBUF_x pagcnt, [retadr]l, [phyadr], [region]
pagcnt =

the number of pages of memory desired.

retadr

the address of a 2 longword array to receive the virtual

phyadr =
region =

.
limits.

buffer

the address of a 2 longword array to receive physical
’

start and end addresses.

that

part

allocated.
system

memory

(default)

which

the

space.

buffer
=

space.

be
=

space.

Return Status Codes

SS$ NORMAL: Service successfuly completed.
SS$_ILLPAGCNT: Page count is less than 1
SS$ VASFULL: Virtual address space full.

x, together with $DS_RELBUF_x, to obtain
You should use $DS_GETBUF
memory as it is needed for specific tests. When large buffers are
needed, this service enables the programmer to avoid loading a
large block of zeros at the time that the program is loaded into
memory.

8.5.4

$DS_RELBUF_x Release Buffer Space

This macro calls a supervisor routine to release a buffer area in

virtual memory from program control.

$DS_RELBUF_x pagcnt,

[retadr],

pagcnt =

the number of pages.

retadr

the

address

[region]

1longword

de-allocated buffer limits.

array

receive

VAX Diagnostic

region =

Return

Design Guide

the space from which the buffer is to be released.
(default) P@ space. 1 = Pl space. 2 = system space.

Status

Codes

SS$_NORMAL:

Service

DS$S_FRAGBUF:

Buffer

successfully completed.
was

not

contiguous.

SSS_ILLPAGCNT:

Page

count

less

SSS_PAGOWNVIO:

Page

owned

a more

than

privileged

access

mode.

8.6
DELAY SERVICE MACROS
diagnostic
program
can
delay
itself
a
specified
number
of
microseconds or milliseconds through the use of a delay service
call. For example, if your program is testing a Unibus device and

you

suspect

delay

the

service

possibility

macro.

You

Unibus

timeout,

you

can

use

should

specify the greatest allowable
time as an argument. When the return from the call is made, the
service returns the increment of the time delay not used via the
optional RETTIM argument.
You

can

abort

the

operation

SDS_CANWAIT
x macro.

the

delay

macros

with

the

8.6.1

$DS_WAITUS
x Microsecond Delay
This
macro
calls
a
supervisor
routine
that
operation
for
a
number
of
microseconds
equal
number specified.

SDS_WAITUS
x time,
time

the

rettim

the

[rettim]

number

Status

Service

DS$_ICERR:

Interval

address

units.

receive

unused

time

units.

successfully completed.
clock

Negative

specified.

SSS_QUOTA:

microsecond

Codes

DS$ NORMAL:

DS$_PROGERR:

longword

microsecond
Return

suspends
program
to
ten
times
the

Multiple

time

error.

(or

less

than

function

error.

overhead)

time

interval

Example 8-17
shows how you can set up a delay with SDS_WAITUS x
while waiting for completion of a Unibus read function.

Supervisor Service Macros

MOVL BASE ADR, R2

MOVW R3, (R2)
MOVZWL (R2), R3

Example 8-17

S #10
$DS_WAITUS

Get RKCS1 address.
Write RKCS1.
Read RKCS1.
Stall for 100
to

for

event

occur.

_ Macro
Use of the $DS_WAITUSx
NOTE

Because of overhead,

the minimum delay is

about 108 microseconds.

x Millisecond Delay
$DS_WAITMS

8.6.2

routine that
supervisor
calls a
This macro
equal
milliseconds
of
number
a
for
execution
number

specified.

$DS_WAITMS_x time,
time

rettim

[rettim]

the number of 18 ms units.
the

longword

address

receive

unused

units.

Return Status Codes

Service successfully completed.

$DS_NORMAL:

DS$ ICERR:

suspends program
to ten times the

Interval clock error.

DS$_PROGERR:

Negative time interval specified.

- SS$_EXQUOTA: Multiple time function error.

8-21

time

VAX Diagnostic

Design Guide

8.6.3
$DS_CANWAIT
x Cancel Wait
This macro calls a
routine
in the

|
that

supervisor

cancels

effect
of
a
previous
$DS_WAITMS_x
or
$DS_WAITUS
x
invoking the SWAKE
x system service macro.

the

macro

$DS_CANWAIT
x (no arguments)
Return

Status

DS$_NORMAL:

Codes

Service

successfully completed.
NOTE

This

macro
normally
occurs
interrupt service routine.

You

should

delay

coordinate

service

occurred.
program

occur.

the

macros

For

example,

could

delay

When

the

$DS

CANWAIT

determine
in

interrupt

than

required

interrupt

does

occur,

routine could
set a
flag bit and
Control would then return to
return

flag

bit

would

know

control

were

upon
interrupt

Notice

actual

time

This

that the
requested.

programs,

resources
Example

since

8-18

the

cleared

that

the

VMS

shows

$DS_CANWAII_X.

Test

routine.

with

the

has

service

routine,

the

for

interrupt

the

not

interrupt

execute the $DS CANTIM X macro
supervisor, which would, in
program.

return

the

timeout

had

may

However,

program,
occurred.

time achieved may be
especially true of level

you

service

the

environment.

how

the

diagnostic

programs

one

timeout

delay

other

with

macro

whether

longer

call.
turn,

coordinate

the

program

longer

than

the

level

competing

the

and

for

system

$DS_WAITMS
X

macro

START XFER: :

PUSHR

#"M<R3,

MOVZWL

DRVTYP,

MOVB

HOLD CS1,

MOVW

R4,

H
[4

RKCS1 (R2)

$DS WAITMS S

Interrupt

’

#1,

BLBS DN_FLG,
10$:

R4>

MOVZBL

#10

$DS_ERRHARD...
;

Yes,

interrupt

service

BBC

Load

transfer.

UBASTATUSS$W 2,20$

8-22

command

and

start

Wait 100 ms.
Did an interrupt occur?
No,
timeout.
H
chec k data transferred.

routine.

#CHNINT,

Set up drive type.
OR in command.

;
i

occurred,

registers.
Initialize return status
for optimistic start.

H
i

10%

Save

;

Branch

;

interrupt.

Set

TMo
~e

Branch if not
interrupt.

Supervisor Service Macros
a

UBA

$DS_ERRSYS...
$DS ABORT PROGRAM

20S:

BBS DEVINT, UBASTATUSSW_2,309$

30$:

$DS_ERRSYS_S...
SDS_ABORT PROGRAM
$DS_CANWAIT_S
#1,

MOVB

DN FILG

if device

interrupt done

flag.

REI

Example 8-18
~

x
Coordination of the $DS_WAITMS_

x Macros
and $DS_CANWAIT

In Example 8-18, the test routine starts a non-processor request
(NPR) transfer. The $DS _WAITMS macro then causes the program to

delay

100

for

ms.

When the device completes the transfer required, it causes an
interrupt. The interrupt service routine fields the interrupt. The
interrupt service routine then cancels what remains of the delay,
sets a flag to indicate that the interrupt occurred, and then

returns control to the test routine. The test routine, in turn,
checks the flag to determine whether or not the interrupt did
.
occur

ERROR MESSAGE SERVICE MACROS

8.7

The VAX diagnostic system provides three categories of error
information. These correspond to the three inhibit error message
flags (IE1, IE2, IE3) in the supervisor command language.
First, both the supervisor and the diagnostic program provide the
header. The header includes the program name, version and update;
the test, subtest, and error numbers; the error type; the device
under

and a brief message.

test;

Second, the diagnostic program provides basic information. The
basic information includes a description of the error, the
contents of the device registers, and expected and received data
patterns.

Third, the diagnostic program provides extended error information
to describe certain program conditions and/or hardware conditions.
The type of information printed varies with the program, but might
include statistics such as the number of bytes transferred.

the Bell

each error

flag

is set,

that the

the supervisor will

program encounters.

ring

the bell

for

VAX

Diagnostic

In addition,
print

Design Guide

a convert register

subroutines.

mnemonics

This

failing

information macro

enables

the

is available to

programmer

bits.

specify

8.7.1
'Header Information Message Macros
You
can
use
four
macros
to
request
the
printing
information. These macros are identical in format, but
use each to report a particular type of error. Each of
calls

supervisor

service

routine.

line error message for the
title and version number,
error

number,

and

prints

message

Example

brief
8-19

time

shows

kkkkkk**
PASS

TEST

ERRTYP

format

addition,

the

for

the

8-20

-- VER.UPD.,

SUBTEST

the

header

shows

information

typical

Message Header Format

each

message

daytim

message

77 _ESRCA
FATAL

for

****xx%xxx

Error

DEVICE

three

routine

error

Example 8-19

TEST

service

should
macros

programmer.

ERROR

header

produces

UUT

*x%kk***
PASS

stamp.

Example

DPROGNAME

routine

of
you
the

operator. The message shows the program
pass number,
test and subtest numbers,

specified

the

of
these
macros.
header printout.

The

the

RPOX/DCL

SUBTEST

WHILE

DIAGNOSTIC

©#

ERROR

TESTING

4,1

*k#kkkk#

10-MAR-1978

DBA®:

CONTROL

@8:26:
20. 26

BUS

PARITY

ERROR

DETECTED

Example

The

programmer

PRLINK

must
no

8-20

must

parameter

printed.

error

message

will

that

the

basic

Note

also

that

the

8.7.1.1

use

IE1l

use

the

unique

the

Printout

routine

supplemental

operator

has

set

information

the

Halt

flag,

when

error

set,

System

after

[unit],

macro

within

the

routine

Patal

detecting

[msgadr],
number

the

inhibits

default

$SDS_ERRSOFT_x,

Error
a

within

messages.

Header

Information

system

[prlink},
the

$DS BGNTEST

header

fatal

error.

[pl--6]

current

and

subtest.

$DS_BGNSUB

wuses

the

and $DS_ERRDEV_x.
8-24

macros

$DS

NUM

macros

and
automatically
sequenced
when
not
specified.
automatic sequencing of this parameter also includes

its

the

information.

flag,

initialized

address

Header

printed.

thismacro

[num],

Message

8.7.1.1)

extended

$DS_ERRSYS x

should

$DS_BRRSYS_x
num

should

Error

the

Otherwise,

You

specify

(Paragraph

Note

you

Sample

The
all

ERRHARD

unit

the

msgadr =

logical

unit

number

the

Supervisor

Service Macros

unit

test.

under

the address of a counted ASCII string. This message is
included in the third line of the error header message.
It
should
be
a
brief
description of
the
error
or
a
module call out message.

prlink =

the

address

error

reporting

routine.

This

the

address
of
a
closed
routine
to
print
supplemental
information about the error that has occurred. The error
reporting code at
this address must be surrounded by

$DS_BGNMESSAGE
section

code

and

$DS_ENDMESSAGE.

not

contingent

Execution
the

Halt

this

Error

flag.

pl--6

_one to six optional parameters that may be passed to the
error

routine.

specified,

they must be

used

sequence.

Return

Status

Codes:

None.
NOTES

R2 through R11l are preserved within
this service by the supervisor and
are

intact

executed.

when

the

$DS_ERRSYS
x
may
between subtests.

call

PRLINK

not

used

The failure of a channel call is a system fatal error. You should
follow
it
with
a
$DS_ERRSYS
x macro
call
and,
generally,
a
$DS_ABORT macro

call,

as shown

in Example 8-21.

.SBTTL INIT

$DS _BGNINIT

SDS CHANNEL_S

#CHC$_INITA

—-we

$DS_BNERR 10$

$DS_ERRSYS_S

wmy

Initialize the UBA.

Is there an error?
Yes, a system fatal

10$:

;

Continue

with

Example 8-21

-y

$DS_ABORT PROGRAM
program.
Use

0,= UBA_INIT_ERR,
POINTER = DUMP_UBA

error.

UNIT =
MSGADR

the

message

error reporting code
Terminate program
execution.

$DS _ERRSYS x Macro

VAX Diagnostic Design Guide

8.7.1.2

$DS_ERRDEV_x

You should

use

$DS_ERRDEV
x
num

Print Device

this macro

[num],

after

[unit],

Fatal

Error

Header

[prlink],

[pl--6]

detecting

[msgadr],

a device

Information

fatal

error.

the unique error number within the current subtest. NUM
is initialized by the $DS BGNTEST and $DS_BGNSUB macros
and
automatically
sequenced
when
not
specified.
The
automatic sequencing of this parameter also includes all
its
default
wuses
1in
the
macros
$DS ERRHARD x,

$DS_ERRSOFT x,

and $DS_ERRSYS Xx.

unit

the

logical

unit

msgadr

the

address

number

counted

the

unit

ASCII

under

string.

test.

This

message

included in the third line of the error header message.
It
should be
a
brief
description of
the
error
or
a
module call out message.
prlink

the address of an error reporting routine.
This is the
address of a
closed
routine
to
print
supplemental
information about the error that has occurred. The error
reporting
code at this address must be surrounded by

$DS BGNMESSAGE

code

one

optional

flag.

pl--6

and

section of
to

error

six

$DS _ENDMESSAGE.

not

contingent on

parameters

routine.

that

specified,

Execution

the

may

Halt

passed

they must

this

Error
to

the

used

the

sequence.

Return

Status Codes: Noné.
NOTES

R2 through R1l1 are preserved within
this service by the supervisor and
are intact when the call to PRLINK
is

fatal

device

executed.

$DS_ERRDEV_x
may
between subtests.
error

one

that

not

prevents

used

further

testing

device.
Following the error detection and message, the programmer
may want to drop the testing of the device under test and proceed
to
the next device
to be
tested,
or
the programmer may want
to
abort the program.

Supervisor Service Macros

8.7.1.3 $DS_ERRHARD_x Print Hardware Error Header Information You should use this macro after detecting a hardware error.
$DS_ERRHARD_x [num), [unit],
num

([msgadr], [prlink],

[pl--6]

the unique error number within the current subtest. NUM
is initialized by the $DS BGNTEST and $DS_BGNSUB macros
and automatically sequenced when not specified. The
automatic sequencing of this parameter also includes all
§$DS_ERRDEV_x,
macros
the
in
wuses
default
its
$DS_ERRSOFT_x, and $DS_ERRSYS_x.

unit

msgadr =

the logical unit number of the unit under test.

the address of a counted ASCII string. This message is

included in the third line of the error header message.
It should be a brief description of the error or a

module

call

out message.

This is the
the address of an error reporting routine.
address of a closed routine to print supplemental
information about the error that has occurred. The error
reporting code at this address must be surrounded by

prlink

and

$DS_BGNMESSAGE

$DS_ENDMESSAGE.

Execution

this

is not contingent on the Halt On Error

section of code
flag.

pl--6

one to six optional parameters that may be passed to the
error print routine. If specified, they must be used in
sequence.

Return Status Codes:

None.
NOTES

R2 through R1l1l are preserved within
this service by the supervisor and
are

intact when the call

to PRLINK

is executed.

$DS_ERRHARD_x

may

between subtests.

not

used

x macro is the error messageé macro most commonly
The $DS_ERRHARD
used upon error detection. Example 8-22 is typical.
10$:

; Write to CSR.

MOVW #"X5068, @DZCSR

MOVW @DZCSR, CSRW

;

Read CSR.

BEQL 28$
S
$DS_ERRHARD

;

success

XORW3 #7°X5068, CSRW, XORW
-

UNIT = LOG_UNIT, MSGADR = REGERR

20S:

; Check data.

; device under test
; message address

$DS_CKLOOP

Example 8-22

x Macro
Use of the $DS _ERRHARD
8-27

VAX Diagnostic Design Guide

8.7.1.4

$DS_ERRSOFT
x

fails

test

should

use

Soft

but

Error

works

Header

the

[num],

[unit],

unique

error

initialized

and

[msgadr],

number

the

automatically

automatic

its

when

default

unit

the

logical

msgadr

the

address

included

within

the

- When

retried,

vyou

and

when

this

the

address

reporting

not

the

number

the

counted

third

specified.

also

macros

unit

ASCII

error

The

includes

$DS

all

ERRHARD

the

line

NUM

macros

under

string.

the

reporting

test.

This

error

message

header
the

error

routine.

message.

This

the

a
closed
routine
to
print
supplemental
about the error that has occurred. The error

code

and

subtest.

BGNSUB

and $DS_ERRSYS
x.

$DS BGNMESSAGE

section

$DS

parameter

It
should
be
a
brief
description
module call out message.

address
of
information

[pl--6]

current

$DS_BGNTEST

uses

unit

[prlink],

sequenced

sequencing

$DS_ERRDEV_x,

prlink

Information

correctly

this macro.

$DS_ERRSOFT
x
num

initially

code

this

address

must

$DS_ENDMESSAGE.

not

contingent on

surrounded

Execution

the

Halt

this

Error

flag.

one

pl--6

error

six

optional

parameters

routine.

that

specified,

may

passed

they must

the

used

sequence.

Return

Status

Codes:

None.
NOTES

through R1l1l

8.7.2
same

preserved

the
the

call

supervisor
to

$DS_ERRSOFT_x

may

not

wused

format.

macros

Each

and

PRLINK

subtests.

Information Print Macros
basic and extended information

four

within

this service by
are intact when
is executed.

between

The

are

calls

the

extended

all

use

the

routine

the

supervisor to check a different set of the
inhibit
flags before printing the message, as follows:

Flags

$DS_PRINTB x

IE1l,

IE2

IEl,

IE2,

IES

$DS_PRINTF x
Example

8-23

shows

message

checked

$SDS_PRINTX x
$DS_PRINTS x

error

IE3

none
the

three

standard

messages.

8-28

formats

for

basic

error

Supervisor Service Macros

GOOD:

<EXPECTED-VALUE>

XOR :

<XOR-VALUE>

BAD

<ACTUAL-VALUE>

; <XMNEMONICS OF XOR BITS>

<REGISTER-0>

<REGISTER-VALUE><RADIX>

; XMNEMONICS OF SET BITS>

<REGISTER-N>

<REGISTER-VALUE><RADIX>

; (MNEMONICS OF SET BITS><SEE NOTE 1>

DATA COMPARE ERROR IN BUFFER

DEVICE STARTING ADDRESS:

MEMORY BUFFER ADDRESS
RECORD

WORDS

<MEMORY ADDRESS>
<LENGTH OF

SIZE

TRANSFER>

IN ERROR

ADDRESS

GOOD

XOR

BAD

<ACTUAL DATA>
Example 8-23

for Basic

Standard

Formats

Error Messages

NOTES

All mnemonics must be identical to the ones in the hardware engineering specification for

A maximum of eight memory locations will be dumped.

the unit under test.

8-29

VAX Diagnostic Design Guide

The extended
print routine uses formatted ASCII output
(FAO)
to
compile
a
string
and
then
print
it.
You
should
use
the
$DS_PRINTB_x and $DS_PRINTX
x macros in the print routine (PRLINK
argument),
rather than in the test routines.
In this way only one
macro
call
(e.g.,
SDS ERRHARD
x)
must
be
made
for
each
error

detected

Program

data

test

routine,

shown

Example 8-24.

section:

MSG5:
:

.ASCIC

\CSR

ERROR\

MSG6:
:

.ASCIC

subroutine

ROUTINE::

\TRANSMIT

containing

READY

CLEAR,

SHOULD

SET\

address

basic

$DS_PRINTB
X macro:

$DS_BGNMESSAGE REGMASK

MOVL

<R2,

ERRS P1(AP),

R3,

R4>

;

Save

;

error

message.

;

basic

$DS_PRINTB
S FORMAT

(R2)

message.

$DS_ENDMESSAGE
Test

routine

which

calls

the

data

and

compare.

subroutine:

19$:

= MSG5,

PRLINK

Is
yes

error?

device

under

test

header

message

20$:

$DS_CKLOOP

= MSG6

text

basic
print

error information
routine

basic

print message

wme

PRINT ROUTINE,

there

MSGADR

$DS_BNERROR 20§
$DS ERRHARD S ~ UNIT = LOG_UNIT,

transfer

;

$DS_BGNSUB

10$

Example 8-24

Use

the

$DS PRINTB_x

Macro

Supervisor Service Macros

Example

8-24

ROUTINE,

the
and

$DS_ERRHARD
S
MSG6.

The

macro

takes

first

arguments

calls

MSGS5,

supervisor

routine to produce a three-line error header message. The MSGADR
argument (MSGS5) points to an ASCII string that makes up a part of
the header message. The PRLINK argument identifies the basic print
routine, to which control passes from the supervisor routine. The
print routine saves the Pl argument from the $DS ERRHARD S macro

call in R2. The $DS PRINTB
S macro
causes MSG6 to be printed.

the

print subroutine

then

However,
you will generally need
to print a message
containing
information which varies, such as the value in a register or the
mnemonic of a bit in error. In this case, instead of providing a
complete message in the data section, you must provide a control
string that includes FAO directives. Variable data and character
strings
can
be
represented
with
the
FAO directives.
Table 8-1
gives a summary of these directives.
Table 8-1

Character

Summary of FAO Directives

String Substitution

Directive | Function

1AC

Parameter(s)
*

Insert a
string.

counted

ASCII

Address of the string;
the first byte must
contain

!AD
! AF

1AS

Insert an ASCII string.

Replace all
ASCII codes
Insert

Numeric Conversion

nonprintable
with periods

ASCII

length.

Length of string

Address

string

Length of string

Address

string

(.).

string.

Address of quadword
character string
descriptor pointing
to the string.

(zero—-filled)

10B

Convert a byte

10L

Convert

1XB

Convert a byte to

IXW

Convert a word

10W

the

to octal.

Convert a word to octal.
a

longword

hexadecimal.
hexadecimal.

to octal.

Value

to be converted

to ASCII representation.
For byte or word

conversion,

FAO uses

only the low-order byte
or

word

the

longword

VAX Diagnostic Design Guide

Summary of

Table 8-1

Convert a longword
hexadecimal.

Convert

FAO Directives

(Cont)

parameter.

unsigned

decimal

Convert
word.

unsigned

decimal

Convert

unsigned

decimal

byte.

longword.

Numeric Conversion

(blank-filled)

'UB

unsigned

decimal

unsigned

decimal

unsigned

decimal

IUW

Convert
byte.
Convert

Value
ASCII

to be converted
representation.

word.

Convert

longword.

! SB

Convert

! SW

byte.
Convert

signed

decimal

For

conversion, FAO uses
only the low-order byte

signed

decimal

signed

decimal

parameter.

(CR/LF).

None

Convert

word.

ISL

byte

word

the

longword

longword.

Output String Formatting

Insert new line

Insert

tab.

Insert a

form

Insert

!3S

exclamation
if

converted
not 1.
13T
13D

Insert
Insert

feed.

the
the

mark.

most

recently

numeric

value

system

time.

Address

date

time value to be
converted to ASCII.

system

and

time.

Define output field width of
n characters. Format all
data and directives within
delimiters,<and>,
and

blank-filled

None

left-justified,
within

8-32

the

f}eld.

quadword

specified,

current
used.

I n<
1>

system

the
time

Supervisor

Table 8-1

In*c

Repeat
the

Parameter

Summary of

the

character

output

string

FAO

Directives

Service

Macros

(Cont)

None

times.

Interpretation

Reuse the
the list.

last

Skip the next
the list.

parameter

None

*If a variable repeat count and/or a variable output field length
is
specified with
a
directive,
parameters
indicating
the count
and/or
length
must
precede
other
parameters
required
by
the
directive.
Example

8-25

control

string

the

shows

and

$DS_ERRxxx
x

how

the

how

the

and

$DS_CVTREG_x macros.

8.7.2.1

$DS_PRINTB_x

macro

basic

explanatory

Print
error

data

received

data

Typically,

Basic

Error

information,

Information

for

explanatory message,

XOR

data.

The

message

Use

will

the

expected

inhibited

data,

the

received

either

the

IEl

one
line.
print the

data,

the

IE2

set.

$DS_PRINTB
x
format =

format,

[arg],

the address of
consists of the
conversion

arg

this

data

one
$DS PRINTB x
macro
is
used
to
print
four
$D§lPRINT§;x macros would be used to

Therefore,

example:

message

expected

XOR

FAO directives should be built into the
print macros should be coordinated with

directive

[arg]l,

and

the

flag

...

the control string.
The
fixed text of the output

control

string

and

the

directives.

parameters contained in longwords. A parameter
be a value that is to be converted, the address of
string
that
is
to
be
inserted,
a
1length,
or
an
argument
count,
depending
on
the
directive.
For
each
directive
in
the
<control
string
there
may
be
corresponding
parameters.
Up
to
16
arguments
may
be

may
the

VAX Diagnostic Design Guide

None.

Return Status Codes:

Refer
this

Chapter

NOTE

the

and

manual

Paragraph

Services Reference Manual

9.6

VAX/VMS System
for

FAO

information.

8.7.2.2 $DS PRINTX x
macro should be used
basic error

Print Extended Error Information - This
to print information that supplements the

information,

failing

such as:

addresses

device register contents
channel register contents

additional

The service will
is

explanations

IE2,

or IE3

The control

string

not print the message if either IEl,

set.

x format,
$DS_PRINTX

format =

the

[arg],

address of

[arg]l,

...

the control

string.

consists of the fixed text of the output string and the
conversion directives.

- arg

directive parameters contained in longwords. A parameter

may be a value that is to be converted, the address of
the

string

that

or an
each
For
.
the directive
Dbe
may
there
string
be
may
to 16 arguments

inserted,

argument count, depending on
control
the
in
directive
Up
corresponding parameters.

length,

supplied.

Return Status Codes:

None.

Refer to Chapter
and
this manual

NOTE

9, Paragraph 9.6 of
VAX/VMS System
the

Services Reference Manual
'
information.

for

FAO

Supervisor

Service

Macros

8.7.2.3
$DS_PRINTF_x Print a Forced Message - Use this macro when
the
inhibit
error
control
flags
(IEl1,
IE2,
1IE3)
must
be
overridden. Messages which should be forced are those which alert
the operator
to
significant
events or
notify the operator
that
some

action on his
in main-line code.

part

$DS_PRINTF
x format,
format =

the

required.

[arg]l,

address

[argl,

the

control

of the fixed text
conversion directives.

macro

normally

used

...

consists

arg

This

string.
of

the

The

output

control
string

string
and

the

directive parameters contained in longwords. A parameter
may be a value that is to be converted, the address of
the
string
that
is
to
be
inserted,
a
1length,
or
an
argument
count,
depending
on
the
directive.
For
each

directive

corresponding

the

control

parameters.

string

there

may

arguments

may

supplied.
Return

Status

Codes:

None.
NOTE

Refer
to
Chapter
9,
Paragraph
9.6
of
this
manual
and
the
VAX/VMS System
Services Reference Manual
for
more
FAO
information.

8.7.2.4

$DS_PRINTS_x

macro
should
be
used
summary
message.
The
control flag is set.

$DS_PRINTF
x format,
format =

arg

[argl,

Report
summary
not
be

The

routine
printed

directive

parameters

be a value that
string
that
is

argument

count,

directive

corresponding
supplied.
Status

Codes:

contained

is
to

control

parameters.

the

there
arguments

9,
Paragraph
9.6
of
the
VAX/VMS System

Services Reference Manual
information.
8-35

a
IES

for

A parameter

directive.

string

None.

to
Chapter
manual
and

print
the

the address
length,
or

NOTE

Refer
this

to
if

control string
string and the

longwords.

to be converted,
be
inserted,
a

depending

the

$DS PRINTS x

...

the
address of
the control string.
The
consists of the fixed text of the output
conversion directives.

may
the

Return

Summary

only
in
the
message
will

FAO

For

of
an

each

may
may

be
be

VAX Diagnostic Design Guide

$DS_CVTREG_x Convert Register
8.7.3
This macro calls a supervisor routine that converts the contents
of a register to a counted ASCII string of mnemonics for inclusion
in an error message. For every bit set in the register, the
corresponding mnemonic is included in the ASCII string. Several
bits in a register may make up a function. In this case, the

corresponding mnemonic

should

registers mnemonics

the device

followed

list,

where:

"=n"R"

"=n@"

the number of bit positions that make up the field.

n =
R =

the

radix

printed.

in which the value of the

function field

should

in a print routine in
The $DS CVTREG_x macro can be used
conjunction with one of the PRINT macros. Since the routine will
be called through one of the $DS _ERRxXX_ X macros, all information
necessary to the routine must be “specified with arguments to that
X macro.
$DS_ERRXXX_

$DS_CVTREG_x msb, data, mneadr, strbuf, maxlen,

[V1--6]

msb

the most significant bit

data

the address of the

mneadr

strbuf

the address of a buffer where the counted ASCII string

maxlen

the

address

the

ASCII

counted

string

bit

mnemonics.

returned.

to be

length

the

buffer.

= pointers to counted 1lists pointing to the ASCII
function values specified with a
strings defining

vVl -- V6

in the

mnemonic
Return

position.

form xxxxxx=n@.

Status Codes

$DS_NORMAL:

Service

$DS_PROGERR:

This

following

successfully completed.

status

code

returned

indicate any of the

conditions:

is greater

than

11,

the number of arguments

the MSB

the mnemonic string is exhausted and an = sign
encountered with nothing to the right of it,

a negative digit was encountered

is greater

than 32,

8-36

has

been

in the mnemonic string,

Supervisor Service Macros

some

character

was

character

other

separate

mnemonics

the ASCII

format

the

Notice
output
that

bad

caller's

encountered

than
the

from

this

routine.

contains the full length of the
string plus the count byte. This is
true even if the buffer size is too
short or the string is longer than

8-25

shows

The
are

related
shown as

Global

Data

and

bytes.
print

subroutine

global
well.

data

containing the $DS_CVTREG_x
section
and
the
calling
test

buffers

PROGRAM

GLOBAL

DATA

SECTION.

Description:

All dynamically modified data should be placed in this
section. This is the only section which will normally be
write enabled.

NOTES

Example

WMy

used

is
returned,
16(AP),
the
zero
in 16 (AP)
indicates

The
first
mnemonic
1is
associated
with the bit position MSB.

macro.
routine

Functional

been

255

.SBTTL

has

string,

overflowed.

comma

mnemonic

overflowed,

buffer

output

the

string,

that when
the code DS$ PROGERR
buffer
address,
is cleared.
The

there

LOG_UNITSL::
DZSCSR::
DEV REG::

CSRSW: :

XORSW: :

. LONG
-ADDRESS

;
;

LUN
CSR address

.ADDRESS

;

.WORD

HDW PTBLESA::

.LONG

CHAR_BUF::

.BLKB

CSRREGSC: :

;

XOR of exp and

;
;

data
address

;

132

;

buffer

;

132

8-37

to P-table

.ASCIC /TRDY,TIE,SA,SAE,NUM,
//MSE,CLR,MAINT,NU,NU,NU/

pointer

; CSR buffer

rec

pointer

character

1/0

VAX Diagnostic Design Guide

Subroutine
.SAVE

. PSECT

PRINT,

LONG

.ASCIC \!/EXPECTED:!XW(X)\

;

RCV_FMTSC::

.ASCIC \!/RECEIVED:!XW(X)\

;

XOR FMTSC::

.ASCIC \!/XOR:!

EXP FMTS$C::
-

IXW(X);!AC!/\

WMy

MOVL ERRS$

P1(AP),R2

REGMASK =

FORMAT =
R4,

Wy
e

(R2)

R5,

$DS_CVTREG_S MSB = #15, DATA = R2, MNEADR = CSR REG $C

MAXLEN

$DS

#132,

$DS_PRINTx S

FORMAT = RCV_FMTSC,
P@ = R5

$DS_PRINTX_S FORMAT

P8
Pl

XOR_FMT$C,

= R2, = #CHAR_BUF

8-38

R5,

R6>

address of

expected data
received data

print message
exclusive OR

;
;
;

16-bit register
bits in error
address of counted

ASCII

string

;
;

address of string
buffer

;

buffer

;
;

Print message
expected data

;

print message

;

received data

;

PRINTX S FORMAT = EXP FMTS$SC,
PO = R4
-

R4,

name of

;

added.
line feed

;

STRBUF = CHAR BUF,
o

hex.

converted to hex.
The string of
bit mnemonics is

R3,
we

MOVL ERR$
P2 (AP),R3

MOVZWL ERRS$ P3(AP),R4
MOVZWL ERR$
P4 (AP) ,R5
S
$SDS PRINTB
XORL3

<R2,

ERRORSA::

$DS _BGNMESSAGE

XOR data is

length

(CVTREG)

REG

LASCIC \!/\

Received data

converted

TMo

FMTCR: :

Expected data is
converted to hex.

XOR data

message

bits

error

Routine

MOW

#°X5068,

@DZS$CSR

error

;

extended

;
;

extended message
address of CSRREGSC

;
;

expected data
received data

MOVL #°X5068, CSRSW
MOW @DZS$CSR, CSR$W
XORW3 #°X5068, CSR$W,
BEQL

Write to CSR.
expected data
read CSR
check

“

Test

Calling

w-e

Supervisor Service Macros

XORSW

10$

$DS_ERRHARD
S UNIT

= LOG_UNITSL,

MSGADR = REGERR,
PRLINK

= REG

ERRORSA,

Pl
P2

= #MSG CSRERRSC,
= REGISTERSA, -

P3
P4

= #°X5068,
= CSRSW

;

-e

10$:
Example
In this
call in

8-25

Use

message

the

routine

(continue

$DS _CVTREG_ x

test)

Macro

example,
the PRLINK parameter in the $DS_ERRHARD_S
the calling test routine specifies the name of the

subroutine.
Pl
through
P4
specify
the
address containing
bit mnemonics
for
the
received

data.

The

CVTREG

macro

the

mnemonics

$DS

corresponding

the

CHAR_BUF.

The

third

extended
CSR,
and

message,
expected

the
and

subroutine

places

the

failing

$DS PRINTX
S

macro
print

macro

bits

the

buffer

call

following

the

$DS_CVTREG_S macro causes the failing bit mnemonics to be printed.
Example

8-26

Example

8-25.

khkkkkkk*k

shows

PROGNAME

PASS

HARD

ERROR

the

message

Vl.fl

produced

the

code

shown

kkkkkkkk

TEST 1
SUBTEST 1
ERROR 3
10-APR-1979
15:37:50.47
WHILE TESTING TTA:
DEVICE REGISTER ERROR

CSR IN ERROR
EXPECTED:
5068 (X)

RECEIVED:
XOR:

0000 (X)
5068 (X); TIE, SAE,RIE,MSE,MAINT

Example 8-26

Sample

Error

Message

Printout

1in

VAX Diagnostic Design Guide

8.8
PROGRAM-OPERATOR DIALOGUE SERVICE MACROS
Some diagnostic programs require operator-supplied

information for
the execution of certain tests. These tests should be placed in a
separate section named Manual Intervention.
The following service
call macros are useful in organizing the dialogue and adapting the
program

flow to

the

operator

response:

$DS_ASKxXX macros
$DS_PARSE_X
$DS_CLI.
You

can

use

operator

specified

The

with

any

the

with a message.
buffer.

$DS PARSE

a syntax

macro

tree.

five

$DSASKxxX x

macros

The operator's response is

can

then

each

used

node

parse

the

tree

prompt

returned
command

(created

the

in a
line

$DS_CLI macro) control passes to a CASE instruction. Control then
Figure
passes to the code that executes the operator's command.
8-2

shows

program.

the

flow of

typical

operator

dialogue
'

portion

Supervisor

C START

’

Y
PROMT THE OPER.
BUFFER<STRING

'
PARSE THE
INPUT LINE

ERROR

YES

NO
FINAL
COMMAND
PROCESSING

'
EXECUTE
THE

COMMAND
TK-1883

Figure 8-2

Operator

Dialogue

Flowchart

Service

Macros

VAX Diagnostic Design Guide

should
If the operator has typed in an improper command, the code d.
If
comman
r
anothe
for
or
operat
detect the error and prompt the
the command
there is no error, the code should complete processing

and

then execute

it.

$DS_ASKSTR_x Ask the Operator for a String

8.8.1

This macro calls a supervisor routine that prompts the operator
for a string response. It accepts an ASCII string that it checks
1is

against a list of possible responses.

placed

in a caller-specified buffer.

If valid,

the string

$DS_ASKSTR_x msgadr, bufadr, [maxlen], [valtab], [defadr]
msgadr =

the address of a counted ASCII string used as a prompt.

bufadr =

the address of a counted ASCII buffer.

maxlen =

the maximum

valtab =

the

defadr =

length of

include count byte).

address

the

counted

not

response

string

(does

string

pointers.

Default = 72.

1list

Default = @, meaning no validation table.

the address of a counted ASCII string to be used if the

operator gives a null

response.

that there is no default string.

Default = @, meaning

Return Status Codes

DS$ NORMAL: Service successfully completed.

DS$ PROGERR: The number of arguments supplied is incorrect.

DS$ TRUNCATE: The string supplied by the operator has been
truncated because it will not fit into the buffer supplied by the
program.

NOTES

Execution of this macro will cause

program

flag

abort

is clear.

the

Operator

If the Prompt flag is set, ranges
and default values will be printed

with the prompt message.

If VALTAB = @,

any string will be

accepted without qualification.

If VALTAB # @, Rl will return with
an index value into the validation
table.

If DEFADR is specified and
8-42

Supervisor Service Macros
the operator selects
return only, Rl will
containing @.

not

prompt

use

PFAO

string.

ensure

that

a carriage
be returned

directives

the

you

prompt

the

want

message

always starts on a new line, place
CR and LF before the first message
delimiter. For example:

<13><16>\PLEASE TYPE A COMMAND\.

$DS_ASKDATAx Ask the Operator for a Numeric Value
8.8.2
This macro calls a superv1sor service routine that prompts the
operator for a numeric value and ensures that it is within an

acceptable range. The service converts the ASCII numeric string to
and stores it 1in a
it if necessary,
truncates
binary data,
field

(mask).

x msgadr,
$DS_ASKDATA

datadr,

caller-specified

[exword]

[radix],

[mask],

[lolim],

[hilim],

[defalt],

[unused],

msgadr =

the address of a counted ASCII string used as a prompt.

datadr =

the

address

1longword

that

will

the

receive

the

response.

default

radix

PARS$ BIN,

PARS$ OCT,

PARS$_HEX,

mask

a bit mask

indicating

the

lolim

the minimum acgfptable numeric response. Default value =

hilim

PAR$_DEC.

maximum,

field

-(277).

the maximum agfeptable numeric
+ maximum,

position and size.

response. Default value =

-1).

(27

use

if the operator gives a null

response.

defalt =

the value

unused =

reserved

for

exword =

the

mask. PARS$ NODEF means that there is no
PARS ATDEF, PAR§—ATLO, and PARS ATHI cause the

expansion.

exception

default.

parameters DEFALT, LOLIM, ~and HILIM to be interpreted as
containing the addresses where the corresponding values
instead of containing their literal
mag be found,
values.

Return Status Codes
DS$ NORMAL: Service

successfully completed.

VAX Diagnostic Design Guide

DSS PROGERR:
DS$ TRUNCATE:
fit

The

number
value

arguments
by

the

incorrect.
to

$DS_ASKVLD
x Ask the Operator for a Numeric Value
the
$DS_ASKDATA
macro,
the
$DS_ASKVLD
macro
calls

specified

supplied

large

the

The

operator

too

buffer.
NOTES

Execution of this macro will cause
a
program
abort
if
the
Operator
flag is clear.

set,

ranges

and default values will be
with the prompt message.

the

Prompt

flag

printed

Truncation of left-most bits occurs
if a response
is larger than the

mask.

The

radix

and

arguments

$DS_PARDEF.
5.

contains

value,

8.8.3
Like

supervisor

not

the

not use
FAO
prompt string.

that

mask

defined

converted

truncated,

routine

exception

are

prompts

binary

return.

directives

the

operator

for

the

numeric

value.

It accepts an ASCII numeric string as input, converts the string
to
binary
format,
and
truncates
the
string
if
necessary.
The
supervisor routine then checks to determine whether the value is
within
an
acceptable
range
and
stores
the
value
1in
a
caller-specified variable field.
This
field
is specified by
position

and

$DS_ASKVLD
x
fhilim],
msgadr =

datadr =

size,

rather

msgadr,

[defalt]l,

the
the

then

with

datadr,

[unused],

address

mask.

[radix],

[pos],

[size],

[lolim],

[exword]

a counted
of

ASCII

string

used

that

will

receive

1longword

prompt.
the

response.

radix

pos

PARS$S BIN,

PAR$_DEC.
the

right-most

Default =

size

the

PARS$

number

OCT,

PARS HEX,

Range

bit

the

field.

bits

the

field.

8-44

the

default

radix

through

31l.

Supervisor Service Macros

lolim

the minimum acgfptable numeric response.
-

hilim

-(2

maxXximum,

the maximum
+ maximum,

value

Default value

agfeptable numeric
(277

response.

Default value

-1).

defalt

the

unused

reserved

exword

the exception mask. PARS NODEF means that there is no
default. PAR$ ATDEF, PARS$ ATLO, and PAR$ ATHI cause the
parameters DEFALT, LOLIM, and HILIM to be interpreted as
containing the addresses where the corresponding values
may be found,
instead of containing
their
1literal

for

use

the

operator gives

null

response.

expansion.

values.

Return Status Codes
DS$ NORMAL: Service

DS$

PROGERR:

The

successfully completed.

number of

arguments

DS$ TRUNCATE: The value supplied
fit in the specified buffer.

supplied

the

incorrect.

operator

Execution of this macro will cause
a
program
abort
if
the
Operator
flag is clear.
If

the

Prompt

and

default

with

the

flag

values

set,

ranges

will

printed

prompt message.

The
radix
arguments
$DS_PARDEF.

and
are

FAO

not

use

prompt string.

large

to
|

NOTES

too

exception
defined

directives

mask
by

the

VAX Diagnostic

8.8.4

Design Guide

$DS_ASKLGCL
x Ask the

Operator

for

Logical

Response

This macro
calls
a
supervisor
service
routine
that
prompts
operator
for
a
1logical
response
to
a
specified
question.

the
It

accepts
an
ASCII
"yes"
or
"no"
string
and
converts
this
to
single bit (flag). The supervisor routine then stores the bit in
caller-specified bit position within a caller-specified byte.

$DS_ASKLGCL_x msgadr,

datadr,

msgadr =

the

address

counted

datadr =

the

address

byte

pos

bit

Default
yexfer =

noxfer =

defalt =

Return

position
=

ASCII

that

within

[yexfer],

[noxfer],

string

will

used

receive

the

DATADR.

Range

positive

response.

[defalt]
a

prompt.

response.

through

the branch
meaning no

address
branch.

branch

address

meaning

for

negative

response.

Default

the

branch.

PARS YES or

Status

[pos],

PARS NO.

Codes

DS$ NORMAL:

Service

DSS PROGERR:

The

caller is too
is incorrect.

successfully completed.

bit

large

position

argument

number

the

(POS)

number

specified
arguments

supplied

NOTES

Execution of this macro will cause
a
program
abort
1if
the
Operator
flag is clear.

If the Prompt flag is set, ranges
and default values will be printed
with the prompt message.

not

1in

the

8.8.5
$DS_ASKADR
x Ask Operator for an Address
'This macro
calls a
supervisor
service
routine

that

prompt

the

prompt

message

address.

The

the

FAO

operator's

service

and checks whether
service then stores

use

directives

string.

accepts

terminal,

asking

numeric

ASCII

displays
operator

address

for

string

or not it is within an acceptable range.
the address in a user-specified longword.

The

Supervisor

[radix],

x msgadr, datadr,
$DS_ASKADR

Service Macros

[hilim],

[lolim],

[defalt],

[unused],

[exword]

msgadf =

the address of a counted ASCII string used as a prompt.

datadr

the

address

receive

will

that

1longword

the

response.

radix

PAR$ BIN,

PARS _OCT,

PARS HEX.

the minimum

lolim

PARS$_DEC,

the

default

radix

acceptable numeric

response.

Default value

thgzmaximum acceptable numeric

response.

Default value

hilim

(277-1).

defalt

the

value

use

Default value =
unused
exword

reserved

the

for

the

operator

gives

null

response.

expansion.

exception

mask.

PARS

NODEF

means

there

default. PAR$ ATDEF, PAR$_ATLO, and PARS_ATHI cause the
parameters DEFALT, LOLIM, and HILIM to be interpreted as
containing the addresses where the corresponding values
may be found, instead of containing their literal
values.

Return Status Codes
DS$ NORMAL: Service

DS$ PROGERR:

successfully completed.

The number of

arguments supplied

incorrect.

NOTES

Execution of this macro will cause
a
program
abort
if
the
Operator
flag

is clear.

If the Prompt flag is set, ranges
and default values will be printed
with

the prompt message.

The

radix

and

exception

mask

are

defined

arguments

$DS_PARDEF.

not

use

FAO

prompt string.

directives

the

VAX Diagnostic Design Guide

|
$DS_PARSE_x Parse
8.8.6
This macro calls a
supervisor
routine
(DSXSPARSE)
to
parse
an
ASCII
string
in
the
buffer
described,
using
a
caller-supplied
parse tree. When a match in the tree is found, the routine calls a
caller-supplied
action routine.
Upon a mismatch,
the supervisor
routine branches to another point in the parse tree.
$DS_PARSE
x bufadr,

tree,

bufadr =

the

tree

the address of the tree structure to be used

action =

address

the

address

Return Status Codes
DS$ NORMAL: Service

DS$ ERROR:

action

quadword

the

action

for

the

buffer.

in parsing.

routine.

successfully completed.

Error match code

DFS$ OVERFLOW:

descriptor

Numeric

input

encountered

overflow

the

parse

tree.

quadword

descriptor,

BUFADR.
NOTES

The

repeated

use

The ASCII

string

that

$DS_CLI_x.
2.

be generated
The simplest

defined

structure

tree

the

macro

parsed may

in a number of ways.
way to generate
the

use
to
is
string
X Macros.
$DS_ASKxXXX_

one

the

Example 8-27 shows how the $DS_ASKSTR
x, $DS_PARSE_x, and $DS_CLI
macros can be coordinated to solicit and act on information from
the

operator.

flowchart

The code

shown

this

example corresponds

roughly

the

Figure 8-2.

;‘Header module
NULL=0

SUB1=1
SUB2=2
STOP =3
INIT=4

CHAR BUF::
CMD BUF::
TOKEN BLOCK::

.BLKB 132
. QUAD
.ADDRESS 0

;
;
;

132 character I/0 buffer
quadword descriptor
buffer for action routine

Supervisor

Service Macros

. PAGE
Interpreter

tree

commands:

This

SUB1l

NWE

Command

s ++

SUB2

for

the

interpretation of

three

STOP

M
Mo

nodes

An
be

ambiguous or invalid command
notified to that effect.

will

cause

the

operator

-e

Are

Operator
Is

still
Is

e
“s
e

not

“e

MISS=110$
$DS CLI“CHAR=CLIS$K_STRING,
ACTION=STOP,

Clear token block.
Is the first character

-e

20$

TCHAR=<"A"S">,
ACTION=NULL,

30S:

INIT

$DS CLI CLISK BR,

$DS CLI-

10$:
208$:

FIRTREE:
:

Tree

provides

enough
the

information

characters

TOP?

ASCII=<\TOP\>

705

MISS=110$
$DS CLI-

ACTION=NULL,

TCHAR=<"A"1">,
ACTION=SUB1l,
MISS=98$

$DS CLI-

9@S:

"CHAR=CLISK EXIT
$DS CLITCHAR=<"A"2">, -

100$:

MISS=1108$
$DS CLICHAR=CLIS$K EXIT

ACTION=SUB2,

110$:

$DS_CLI-

the

enough

not

character

information

character

enough

information

character

808$:

CHAR=<"A"B">,

$DS _CLI-

not

STOP.

Operator
the

has

typed

SUBI.

“Ne

60S:

typed

“

ACTION=NULL,

MISS=110$

the

has

Operator

has

typed

SUB2.

50S$:

$DS CLI“CHAR=CLIS$K_EXIT
$DS CLIT CHAR=<"A"U">, -

Operator

has

typed

40$:

character

improper

command.

CHAR=CLI$K ERROR

8-49

VAX Diagnostic Design Guide
.SBTTL

PROGRAM

SUBROUTINES

ACT_ENTRY::

CASEL

RO, #0,#4

.WORD

ACT NULL

ACT:SUBl

-10$

;

SuUBl

.WORD
.WORD
.WORD

ACT SUB2
ACT_STOP
ACT INIT

-10$
-10$
-10$

;
:

If
If

SUB2
STOP

;

fatal

error

;

Abort

program.

;

Load

command

routine

;

Load

command

routine

;

Load

command

routine

;

ADR.

168S:

WORD

20$:

$DS_ERRSYS
S
. PAGE
$DS ABORT

ACT INIT:
-

CLRL
RSB

ACT SUB1l:

MOVAL

PROGRAM

TOKEN BLOCK
SUB1 ADR, TOKEN BLOCK

RSB

ACT SUB2:

ACT NULL:

null

; ADR.

MOVAL SUB2 ADR, TOKEN BLOCK
RSB

ACT STOP:

;

; ADR.

MOVAL STOP_ADR,
TOKEN BLOCK

RSB

GETLINE:
:

.ASCIC

<13><10>\PLEASE

TYPE

A COMMAND\
;

FAO directives

;

permitted

not

here.

AMBICMD::

.ASCIC \!/AMBIGUOUS

COMMAND\

INVCMD:
:

.ASCIC \!/INVALID COMMAND\

;

Test

Module

$DS BGNTEST
:
WHATNEXT:
198:

$DS ASKSTR S

ALIGN=LONG
-

MSGADR=GETLINE,
BUFADR=CHAR
BUF,
DEFADR=0

;

;
-

;
;

Ask operator

command.
Prompt

for

line.

command storage
There is no default.

CMDBUF

CMDBUF+4

CHAR BUF+l1,

MOVAL

if at

succeed...

WME

MOVZBL CHAR _BUF,

10%

$DS_BNCOMPLETE

Supervisor Service Macros

-y

S
$DS_PARSE

BUFADR=CMDBUF, TREE=FIRTREE, ACTION=ACT ENTRY
o

20$

$DS_BCOMPLETE
$DS

20$:

PRINTF S

FORMAT=INVCMD

;

BRB 10$
TSTL TOKEN_BLOCK
BNEQ 30$

S $DS_PRINTF
FORMAT=AMBICMD
39$

BRW
JSB
BRW

@TOKEN BLOCK

SUB1 ADR::

command string length
Build quadword
descriptor.
Parse the command.

The command has been
parsed.

"INVALID COMMAND"

Get another command.
Is TOKEN_BLOCK empty?
No, a valid command was

;

typed.

;
;
;

10$

you don't

;
;
;

18§

first

"AMBIGUOUS COMMAND"

Get another command.
Execute command.
Last command executed,
get another.

;

exit

RSB

SUB2_ADR::

RSB

STOP_ADR::

$DS_ENDTEST

Example 8-27

Prompting

and

Parsing

Command

The service called by $DS ASKSTR
S prompts the operator with a
message at GETLINE. When the operator responds,
the service places
the
response
string
in
the response buffer,
CHAR BUF.
If
the
service does not complete these tasks successfully, the macro is
called

again.

successful

the

$DS

return

PARSE
S macro.

from

the

This

string

In CHAR BUF according

Figure

8-3

the $DS_CLI macro.
shows

the

ASKSTR

macro

service,

calls

the

configuration

control

service

the

tree.

tree created
of

that

by the
The

passes

parses

the

repetition

parse

macro

checks one letter at a time against the tree. At 20$ the first
character is checked. If the character is not an S, control passes
to the label specified by the MISS argument, 110$. A miss at this
point shows that the operator has typed an improper command. If

the

first character is an S,

control
8-51

passes to the ACT NULL label.

Z81-M1

cansyav

Hav—ians
34000

VAX Diagnostic Design Guide

30 0

HOH43

2an3onig

p21u9e3r91wWd]iO,eDjul
8-52

Supervisor Service Macros

Control

then

returns

30$,

where

the

three

characters

are

checked
against
TOP.
T
or
TO
or
TOP
will
match.
Any
other
character combination
is
a miss.
If
there
is
a match,
control
passes to 49$, an exit from the tree back to the parse service. If
there is a miss, the character checked may or may not be an error.

Control
The

passes

tree

50$ which checks

provides
40S

for

seven

for

the

operator

ACT ENTRY

and

on.

exits:

STOP

80$ for SUB1
100$ for SUB2
110$ for an improper command
20S$, 50$, and 60$, for ambiguous
If

commands

has

typed

STOP,

SUB1l,

label.

The

CASEL

instruction

SUB2,

control

selects

passes

ACT STOP

for

STOP,
and
so on.
Each of these
brief
action
routines
places a
different address in TOKEN BLOCK, after ACT_INIT has cleared it.
The JSB @TOKEN BLOCK following the $DS PARSE S macro then passes
control to the appropriate test code:
SUB1 ADR
SUB2

ADR

STOP_ADR

the

operator

has

typed

ambiguous

command,

such

SU,

SUB, the token block is left empty. The instruction at 26$ in the
test
code
detects
this
condition.
The
code
then
notifies
the
operator of an ambiguous command and returns control to 10$ in
order

get

another

command.

8.9
SYSTEM CONTROL SERVICE MACROS
The programmer should not try to modify the system control block
(SCB)
directly,
since doing
so
would
probably cause
supervisor
errors. Therefore, four supervisor service macros are provided to
enable
indirect
control
of
the
system
control
block
by
the
diagnostic program.
They should be used
in level 3 diagnostic
programs only.

8.9.1

This
from

$DS_SETIPL
x Set Interrupt Priority Level
macro should be used to raise the IPL to block
the device under test.

x level
$DS_SETIPL
level

interrupt

priority

level.

Return Status Codes

DS$ NORMAL:

Service

successfully completed.

interrupts

VAX Diagnostic Design Guide

8.9.2
$DS_SETVEC_x Set System Control Block Vector
This macro calls a supervisor routine
(DSXSSETVEC)
to
address
control

of
an
block,

exception
or
interrupt
setting a system control

routine
into
block vector

load

the

the
system
for program

control.

$DS_SETVEC_x vector,
vector

[code]

the

absolute

vector

isradr

the

virtual

address

code

Return

DS$

isradr,

Status

NORMAL:

DS$ IVADDR:

the

set,

the

kernel

service

stack;

routine.

interrupt

stack.

Codes

Service address bits <@1:88> are not zero.
Invalid vector.
Interval clock busy.

$DS

interrupts

Vector modified.

DS$_IVVECT:
DS$_ICBUSY:
Use

address.

SETVEC

macro

exceptions

vector

points

when

you

the most

directly

want

direct

your

program

possible manner.

service

routine

field

When

specified

programmer.

8.9.3
$DS_CLRVEC_x Clear a System Control Block Vector
This macro calls a supervisor routine that sets the system control
block vector for supervisor handling. The routine loads the vector
in
the
system
control
block
(SCB)
with
the
contents
of
the
corresponding
vector
in
the
SCB IMAGE
(a
page
that
holds
the
initial contents of each vector).

$DS_CLRVEC_x vector
vector

absolute

Return

Status

DS$_NORMAL:

vector

address.

Codes

Service

completed

successfully.

The $DS CLRVEC x macro may be palred with the
keep the system control block in good order.

$DS SETVEC macro

8.9.4
$DS_INITSCB x Initialize System Control Block
This macro calls a supervisor routine (DSX$SINITSCB)
that
vectors

the

system

routine

copies

control

block.

512

control

byte

$DS_INITSCB
x

(no arguments)

Return

Codes

Status

DS$S _NORMAL:

Service

block

image

for

supervisor

(SCB_IMAGE)

successfully completed.

8-54

sets

the

handling.

The

1into

the

system

Supervisor

Service Macros

You
should
use
the $DS _INITSCB x macro
to
clear
up the system
control block if several elements of the system control block have
been altered.
8.10
When

the

started,

HARDWARE P-TABLE
supervisor
is
the

supervisor

ACCESS
running

builds

and

hardware

diagnostic

program

P-table

each

for

device

selected by the operator for testing. The format for the hardware
P-table is shown in Example 6-5. The programmer can gain access to
the
hardware
P-table
for
the
device
under
test
with
the

SDS_GPHARD
x macro. In this way,
of
the
device
and
calculate
registers.
8.14.1

he can determine
offsets
to
all

the
of

$DS_GPHARD
x unit,

retadr

address
device

$DS_GPHARD x Get Hardware P-Table Base Address

This
macro calls
a superv1sor
routine (RGPHARD)
address
of
the
entry
in
the
P-table
associated
logical unit number.

unit

base
the

to
obtain
the
with
the
given

retadr

the

logical

unit

number.

the

longword

receive

the

base

address

the

P-table

entry.

Return Status Codes
DS$ NORMAL: Service

DS$S ERROR:
The
elements, or the
Example

successfully completed.

argument
1list
does
not
contain
exactly
logical unit number specified is too large.

8-28 shows a
initialization code.

typical

use

the

$DS GPHARD

macro

two

the

VAX Diagnostic Design Guide

$DS_BGNINIT
INITIALIZE:

CSRSW

-e

LOG _UNITSL

CLRL

CLRW

DEVNUM

ADRLOC

= HDW PTPBLES$A

S
$DS_GPHARD

We M

16$:

“M<O
198

. WORD
$DS_BPASS#
G
$DS_ENDPASS

LOG_UNITSL,
-

$DS_BERROR
MOVL
HDW PTBLESA, R2
MOVL
HPS$A DEVICE (R2),
Example 8-28

DZSCSR

Use

the

;
;

entry mask

logical

unit

Clear CSR Buffer
Get hardware P-table
address.

logical

unit

P-table offset to R2
CSR address to DZSCSR

$DS _GPHARD x

Notice that the P-table base address is returned
This address is then moved to R2. After this, the
P-table are easily accessible.

Macro

in HDW PTBLESA.
contents of the

CHAPTER
VMS

small

subset

diagnostic
level

codes.

VMS

programs.

diagnostic

services

Some

are

available

these

services

programs.

These

services

Furthermore,

they

return

control

the instruction that called the VMS service.
change the flow of the program. Seven types
are available.

I/0

service

Memory management

service

a VMS

system

may

DEF

generate

blank

generate an argument list
supervisor service macros)

-. call

the

service

with

the

service

with CALLG

call

Consider
macros

the

are

return

location

status

following

They do not generally
of VMS service macros

any

four

symbols

ASSIGN

the

this

form

The x

$xxxx

The

suffix shows

prefix,

that

the

ways:

and

(Assign
to

macros

service.

macro

end

the

macros

Coding VMS Service Macros
system service macros take

signifies

always

and

available

macros

Hibernate and Wake service
Unwind service macro

VMS

level

also

MACROS

macros

Event flag service macros
Timer service macros
Formatted ASCII output service

9.1
The

are

SERVICE

offsets

(this

corresponds

the

CALLS

Channel)

service.

The

four

following

service:

SASSIGNDEF
SASSIGN
G
SASSIGN
S
$ASSIGN

This

chapter

available
format

for

and

VMS

the

following

services.

chapter

Paragraph

ASSIGN service.

provide

9.3.1

explanations

gives

the

service

may

the

following

$ASSIGN X devnam,chan,[acmode] , [mbxnam]
The

suffix

called

show the

with

following

G or

positional

$ASSIGN

shows

suffixes.

dependence

and

that

The

the

ASSIGN

arguments

that

keyword names of each argument.

VAX Diagnostic Design Guide

The arguments enclosed in square brackets are optional and may be
When you do not specify an optional argument, the macro
omitted.
supplies a default value.
The
service must have a format in

argument list supplied to any VMS
memory like that shown in Figure

9-1.

| 4
DEVNAM

CHAN

ACMODE

MBXNAM

TK-1897

Figure 9-1

Memory Format for the
Service Macro Arguments

ASSIGN VMS

All arguments are longwords.
However, you should code them as
symbols.
The symbols must specify addresses or data.
When the
macro is assembled, the first longword will always contain, in its
low-order byte, the number of arguments in the remainder of the
list.

9.1.1
$name
G Macro Call Format
Use the S$name
G macro call format when you wish to call a VMS
service repeatedly with the same or nearly the same argument list.
This
macro
generates
a
CALLG
instruction.
It
requires
the
programmer to construct an argument list elsewhere in the program.

You

should

specify

$name
G macro

call,

the
as

address

follows:

the

list

argument

the

G label
$name
Use

the

$name

referenced

macro

the

format

label.

Again,

generate

the

S$name

1list

macro

arguments

format

for

VMS

services corresponds to the $DS name L macro format for supervisor
services (refer to Chapter 8, Paragraph 8.1.1).
In general, you
should use the $name macro format to define argument lists in the
data
section of
the
program
in
the
first module,
as
shown
in
Example

9-1.

VMS

LIST::

SASSIGN -

DEVNAM=DISK,

CHAN=CHANNEL_NO

Example 9-1

arglist for assign
device name
string descriptor
address
channel

for
number

the S$Sname Macro Format

Use of

Build

Service Macros

Argument

List

You can then call the VMS service associated with that argument
list with a $name
G macro format, as shown in Example 9-2.

The
the

being

Sometimes

VMS

LIST.

Calling a VMS Service with the $name
G Macro Format

argument, LIST,
LIST label
in

service

ASSIGN

service with the
arguments specified

Example 9-2

Call

LIST

$ASSIGN G

enables the macro to
the data section of

pass the items following
the program to the VMS

called.

you

may want

alter

one

the

arguments

the list to be passed, leaving the rest unchanged.
For example,
you may need to use
the $ASSIGN
G macro again with a DEVNAM
argument of TAPE.
Several steps are required.
First, use the
$SnameDEF macro format in the data section of the test module that
contains the VMS service call.
This macro defines a set of
symbols
that
describe
offsets
from
the
base
address
of
the
argument list.
The $ASSIGNDEF macro creates the following symbols
and

offsets.

TAPE,ASSIGN$_DEVNAM(R2)

Example 9-3

LIST,R2

argument

base

address

arglist

MOVL

the

'name

with

tape.

Modification of an

whole

process.
9-3

list

Argument

Third, you can then call the VMS service with
format.
The macro will pass the argument list.
the

list with a

Replace the device

Wmy

MOVAL

Second, you must replace the o0ld value
new value, as shown in Example 9-3.

WMy

ASSIGNS NARGS
=
4
ASSIGN$ DEVNAM =
4
ASSIGNS CHAN
=
8
ASSIGN$ ACMODE = 12
ASSIGNS MBXNAM = 16

List

the $name
G macro
Example 9-4 shows

VAX DiagnoStic'Design Guide
;

Header

Module

LIST::
W

SASSIGN -

DEVNAM=DISK,

«e

o
“e

for

CALL ASSIGN VMS service with
unmodified

TAPE,

ASSIGNS_DEVNAM(RZ)

the

device

with

tape.

wme

“

G LIST
$ASSIGN

Example 9-4

list

name

Call ASSIGN VMS service
with modified argument
list.

VUses of S$Sname
G, Sname,

and $nameDEF Macro

9.1.2
$name
S Macro Call Format
The $name S macro call format is useful

VMS service infrequently.
a VMS service repeatedly,

list.

Replace

MOVL

LIST,R2

argument

argument
list.
base address of argument
for ASSIGN

MOVAL

ASSIGN

WMo

$ASSIGN
G LIST

Create offset symbols

SASSIGNDEF

Module

Test

CHAN=CHANNEL
NO

arglist for ASSIGN
device name string descriptor
address for channel number

when

you

wish

Formats

call

It is also useful when you wish to call
but with a different argument list each

time.
This format generates a CALLS instruction.
It requires the
programmer to specify the argument list as a part of the macro
call.
create

The
code

assembler
(at
assembly
time)
expands
the
macro
to
that pushes the argument 1list on the stack during

program

execution.

You can specify
of two ways:
1.
2.

The

arguments

the

$name
S

macro

format

either

Keywords

Position.

$name
S macro

macro

for

call

further

call

format.

details.

service macros.

format
Refer

sure

functions
to

just

Chapter

omit

the

$DS

prefix

the

Paragraph
when

$DS name_S
8.1.2

for

coding

VMS

9.2

RETURN STATUS CODES

service

return
return

example,

the

two

the

codes

status

codes

status

CLREF

after

for

the supervisor services, the
provide
useful
information.

codes

(Clear

Event

successful

Service Macros

flag)

service

may

return

For
of

completion:

SS$ _WASCLR

the

event

flag

was

previously

SS$_WASSET

the

event

flag

was

previously

Warning
returns,
service may have
functions.

either

WMS

and
some error
returns,
performed
some,
but not

indicate
all,
of

that
the VMS
the requested

In general,
the programmer should check the low-order bit of R#
following the completion of a WS service call.
If bit 8 is set,
it indicates success.
The programmer can cause a branch to
an
checking

routine

BLBC

R@,

The

error

example,

checking

event
flag
service.

the

clear

routine may
error

check

9-6

error

condition

SS$ _ILLEFC,

for

Example

shown

low

Checking

the

Return

Nature

specific
9-6

8-5.

clear

Code

codes
for

call

values.

illegal

the

CLREF

Is the event
flag number
illegal?

Status

Example

bit

checks

following

Example

Checking the Return Status
for an Error Condition

CMPW

;

instruction

number

LABEL

Example 9-5

For

bit

error

Code

Determine

the

Error

Notice that the instruction checks the low-order word in R@®.
This
is possible because the high-order word of the longword returned

9.3

the

same

for

all

status

codes.

1/0 SERVICE MACROS

Direct access
to
peripheral
device
registers
is
unavailable
to
level
2 and
2R diagnostic programs.
Furthermore,
some of the
supervisor
services,
including
the
channel
services,
cannot
be
called
from
available to

access

and

these
programs.
The
WS
1I/0
services
that
are
the diagnostic system handle all
peripheral device

all

channel

control

for

1level

and

diagnostic

programs.

9.3.1

SASSIGN
x Assign I/0 Channel

A level
2
peripheral

or 2R diagnostic program must assign a
device before
the
program
can
perform

channel
to
a
any
input
or

output operation on the device.
The $ASSIGN_x macro calls a WS
service that assigns a channel and a channel number to a device.

9-5

VAX Diagnostic Design Guide

This channel provides a path between the program and the device.
In

addition,

logical

you

link with a

remote

node

in a network

$ASSIGN devnam, chan, [acmode],
devnam =
|

[mbxnam]

the address of a character string descriptor that points
to the device name string.
The string may be either a
physical device name or a logical name.
If the first
character
in
the
string
1is
an
underscore ( ),
the

service

acmode

in level 2R programs.

treats

the

name

physical

Otherwise,
the
service performs a
logical name translation and uses the
|
if there is any.

chan

establish

macro

S$ASSIGN_x

the

use

can

device

name.

single level of
equivalence name,

the address of a word to receive the channel number that

the

service

assigns

to the device.

the access mode to be associated with the channel.
The
service maximizes
the
specified
access mode
with the
access mode of the caller. I/0O operations on the channel

can

access

performed

only

from

equal

and

modes.

Kernel mode = 0
Executive mode =

privileged

Supervisor = 2
User mode = 3

mbxnam =

the address of the character string descriptor pointing
to
the
1logical
name
string
for
the mailbox
to
be
associated with the device, if there is a mailbox.
The
mailbox
receives
status
information
from
the
device
driver.

Return

Status Codes

SS$ NORMAL:

Service

successfully completed.

SS$ REMOTE:

Service

successfully

established

with

target

the

completed.
remote

logical

1link

was

mode.

SS$ ACCVIO: The device or mailbox name string or string descriptor
cannot be read, or the channel number cannot be written, by the
caller

(access violation).

SS$ DEVALLOC:

Warning.

The

device

1is

allocated

another

process.

SS$ DEVNOTMBX: A mailbox name has been specified
for a device that
is

not

a mailbox.

VMS Service Macros

SS$ EXQUOTA: The target of the assignment is on a remote node and
the process has insufficient buffer quota to allocate a network
control

block.

SS$ INSFMEM: The target
there
1is
insufficient

of the assignment is on a remote node
system
dynamic memory
to
complete

and
the

request.

SS$ IVDEVNAM:
No device name was
specified,
or
the device or
mailbox name string contains invalid characters.
Or, the Network
Connect Block has an invalid format.

SS$ IVLOGNAM: The device or mailbox name
or has more than 63 characters.

string

SS$ NOIOCHAN:

for

SS$ NOPRIV:

I/0 channel

The

process

network operations.

SS$ NOSUCHDEV:
Additional

The

return

SS$ NOLINKS:

SS$ NOSUCHNODE:

does

available

not

have

the

has

length of

assignment.
privilege

perform
:

specified device or mailbox does not exist.
status codes

logical

The

for

network

network operations:

links

specified

are

network

available.

node

1is

nonexistent

unavailable.

SS$ REJECT:
The network connect was
rejected
by NSP
(network
services protocol)
or the partner on the remote node; or the
target image exited before the connect confirm could be issued.
NOTES

Channels can be assigned to devices
For details on
on remote systems.
how

with

use

network

Assign

conjunction

operations,

see

the

VAX-11 DECnet User's Guide.

Only
the owner of
a device can
associate a mailbox with the device
(the owner is the process that has
allocated
the
device,
either
implicitly or explicitly).
Then the
device

driver

can

send

messages

containing status information to the
mailbox, as in the following cases:

the

message

hangup,

device
may

unsolicited

the

input.

9-7

terminal,

indicate

dialup,

reception

VAX Diagnostic Design Guide

If the target is on a network,
the message may
indicate
the
network connect or initiate.
Or
it may indicate whether the line
is down.
If
the
the

the device is a line printer,
message
may
indicate
that
printer is off-line.

For

details

and

the

the VAX/VMS
3.

Channels

the

information

message

format

returned,

see

1/0 User's Guide.

remain

assigned

until

they

are
explicitly deassigned with the
Deassign I/0 Channel (DASSGN) system
service,
or
until
the
image
that
assigned
4.

The

the

ASSIGN

channel

exits.

service

establishes

path to a device, but does not check
whether
the
caller
can
actually
perform
I/0
operations
to
the

device.
Privilege
and
protection
restrictions may be applied to the
device drivers.
For details on how
the
system
controls
access
to
devices,
see the VAX/VMS I/0 User's
Guide.

The
Assign
Channel
system
service
1is
basic
to
communication
between a program and a device, because the QIO system service
will function only on an assigned channel.
The access mode of the
process calling the QIO system service must be equal to or more
privileged
than the access mode from which the original channel
assignment was made.

9-8

VMS Service Macros

Example 9-7 shows the assignment of an I/0
TTA2.
The Assign Channel service returns
the

word

channel to the device
the channel number in

TTCHAN.

TTNAME:

.ASCID

terminal name
descriptor

string

terminal
number

Assign

.BLKW

TTCHAN:

channel.

CHAN =TTCHAN

string desciptor
terminal channel
number

name

TMo

terminal

DE VNAM=TTNAME,

WTMe

N
SSASSIG

channel

Example 9-7

Use

the

x
$ASSIGN

Macro

VAX Diagnostic Design Guide

9.3.2
$DASSGN_x Deassign I/0 Channel
This
macro
calls
a
VMS
service
that

acquired

for

I/O

operations

with

service.

the

releases
Assign

be deassigned.

an
I/0
Channel

channel
system

$DASSGN_x chan
chan =

the

number

Return

Status

I/O channel

Codes

SS$ NORMAL:

Service

SSS_IVCHAN:

channel number
available.

SS$_NOPRIV:
from a more

the

successfully completed.

invalid
of

channel

number

was

specified;

that

number

larger

than

the

channels

was

assigned

The specified channel is
privileged access mode.

Privilege Restrictions
An I/O0 channel can be deassigned
or

more
privileged
than
the
channel assignment was made.

not

only

access

number

assigned,

from

mode

an
from

access

mode

which

the

NOTES

When

channel

deassigned,

any

outstanding
I/0
requests
on
the
channel are canceled.
If a file has
been
opened
on
the
specified
channel, the file is closed.

If a mailbox was associated with the
device
when
the
channel
was
assigned,
and
there
are
not
more
channels
assigned
to
the
mailbox,
the
1linkage
to
the
mailbox
is
cleared.
If

the

network

I/O

channel

was

operation,

link
1is
disconnected.
information on channel
and
desassignment
operations,
see the
User's Guide.

assigned
the

for

network

For
more
assignment

for
network
VAX-11 DECnet

If the specified channel is the
channel
assigned
to
a
device

last
that

has been marked for dismounting,
device is dismounted.

the

I/0
channels
are
automatically
deassigned at image exit.

9-10

is,

equal

original

VMS

Service Macros

You
should
use
the
Deassign
Channel
service
in
a
diagnostic
program when the program no longer needs access to the device.
The
service
is
normally
used
in
the
cleanup
code
and
the
initialization code, as shown in Example 9-8.
CLEANUP:
:

$DASSGN_S

;

Release

TTCHAN.

CHAN=TTCHAN

Example 9-8

9.3.3

Use

the

$DASSGN
x

Macro

$0I0
x Queue I/O0 Request

This macro
operation.

calls a VMS
The service

service
that
begins
an
input
queues a request to a channel

or
output
associated

with
a
specific
device.
Control
returns
1immediately
to
the
calling
program.
The
program can synchronize I/0 completion
in
any of three ways.
1.

Specify the address of an AST
when the I/0 is completed.

Wait

for

Poll

the

specified

event

specified

I/0

routine

flag

status

that

execute

completion

set.

block

for

status.

The service clears
they are specified,

the event flag and the I/0 status
before it queues the I/0 request.

$QI0
x efn, chan, func,
(p3]1, [p4l, [p5], [p6]
efn

the

number

[iosb],

the

[astadr],

event

flag

request completion.
If the
specified, the default value
in the supervisor.
chan

the

number

directed.
number.
func

the

function

operation

the

code

symbolically.
codes

channel

the

address

receive

modifier

which

bits

The

reference

the

final

the

service

performed.
For

listed

notes

(p2],

set

event flag number is not
of @ will cause an error
|

ASSIGN

and

that

([pl]l,

the

that

code

purposes,

quadword

completion
9-11

below.

request

obtain

specify

1is

this

the

expressed

the

I/0

Details

function

valid
I/0 function codes and parameters required by each are
documented in the VAX/VMS I/0 User's Guide.

iosb

are

I/O

Use

[astprm],

block,

status

status.

block

that

VAX Diagnostic

Design Guide

astadr

the
entry
point
address
of
the
AST
routine
to
be
executed
when
the
I/0O
function
is
completed.
1If
specified, the AST routine executes at the access mode
from which the QIO service was requested.

astprm

the
AST
routine.

parameter

optional

device-

and

passed

the

AST

service

function-specific

I/0

request

parameters.

The

first

parameter

whether
the
respectively.
is, the first

may

specified

P1lV,

depending

function
code
requires
an
address
If the keyword is not used, Pl is the
argument is considered an address.

P2 through P6 are always interpreted as values.
used as addresses, preface the number with #.
Return Status Codes
SS$ NORMAL: Service successfully
was successfully queued.

completed.

The

or
a
value,
default, that

they are

I/O

request

packet

SS$ ACCVIO: The I/0 status block cannot be written by the caller.
This
status
code
may
also
be
returned
if
parameters
for
device~dependent function codes are incorrectly specified (access
violation).

SS$ EXQUOTA:

direct

The

process

has

exceeded

I/0 quota and has disabled

its

buffered

I/0O

Resource Wait Mode (SETRWM) system service.
Or, the
exceeded its AST limit quota or buffer space quota.
SS$ ILLEFC:

illegal

event

flag

quota

resource wait mode with the Set

number

was

process

has

specified.

SS$ INSFMEM:
Insufficient system dynamic memory is available to
complete the service, and the process has disabled resource wait
mode with the Set Resource Wait Mode (SETRWM) system service.
SS$ _IVCHAN: An invalid channel number was specified.
That is, a
channel number of @ or a number larger than the number of channels
available.
SS$ NOPRIV:
from a more

The specified channel does
privileged access mode.

SS$ UNASEFC:
The
process
1is
containing the specified event
SS$ ABORT:

A network

logical

not

exist,

not
associated
flag.

link was

9-12

broken.

was

assigned

with

the

cluster

VMS Service Macros

Privilege Restrictions
The QIO Request system service can be performed only on assigned
I/0 channels and only from access modes that are equal to or more
privileged than the access mode from which the original channel
assignment

was made.

Resources Required/Returned
l.
Queued I/0 requests

)

°
°

the

use

process's quota

three

quotas:

for buffered

I/0 or direct I/O

the process's quota for buffer space
the
process's AST limit quota,
if
routine is specified.

AST

service

System
dynamic memory
is
required
to
construct a data
base to queue the I/0 request.
Additional memory may be
required on a device-dependent basis.
'
NOTES

The specified event flag is set even
if
the
service
terminates
without
queuing an I/0 request.

See
Paragraph
information on the

9.3.3.4
I/0 status

for
block

format.

Many
services
return
character
string data, and write the length of
the data returned in a word provided
by the caller.
Function codes for
the
QIO
system
service
require
length specifications in longwvords.
If
1lengths
returned
by
other
services
are
to
be
used
as
input
parameters
for
QIO
requests,
a
longword
should
be
reserved
to
ensure that no error occurs when QIO
reads the length.

4.,

PFor information on performing input
and output operations on a network,
see the VAX-11l DECnet User's Guide.

The QIO
features

service provides special
for diagnostic functions.

QIO Service Diagnostic Functions - Diagnostic operations
performed via physical I/0 functions that specify a diagnostic
buffer.
The diagnostic buffer must be large enough to receive the
final device register contents at the end of the operation.
9.3.3.1

are

9-13

VAX Diagnostic

Design Guide

diagnostic buffer is specified by parameter 6 for all physical
I/0 functions.
If this parameter
is nonzero,
then a diagnostic
buffer
is
specified
and
the
1issuing
process
must
have
the
diagnostic privilege.

Specification

diagnostic

buffer

address

causes

the

QIO system

service to allocate a buffer and store the address of the buffer
in the I/O packet
(IRPSL DIAGBUF).
The virtual
address of the
requester's buffer bit is set in the I/0 packet status word.
When
the I/0 operation is completed, the final device register contents
are stored in the buffer.
The I/0 packet is submitted to the I/0
posting
routine.
The
I/O
posting
routine
determines
that
the
diagnostic buffer bit is
requester's buffer.
The
dynamic
storage
pool.
requester's

buffer

has

set and transfers the information to
allocated buffer is then returned to
The
information
transferred
to

the

format

shown

Figure

9-2.

OPERATION START TIME
IN 64 BIT FORMAT

OPERATION COMPLETION TIME
IN 64 BIT FORMAT

FINAL ERROR COUNTER CONTENTS

NUMBER OF DEVICE REGISTERS

DEVICE REGISTERS,

ONE PER LONGWORD

TK-3002

Figure

9-2

Queue

I/0

Diagnostic

9-14

Buffer

Format

the
the
the

VMS Service Macros

I1/0 Function Encoding - I/0 functions fall into three
9.3.3.2
groups that correspond to the three I/0 transfer modes (physical,
logical,

and

Depending

can be

I/0

virtual).

the

device

expressed

which

two,

functions

are

described

performed

and

any optional

symbolically expressed.
shows

in one,

the

format of

the

all

directed,
an

three

I/0

transfer modes.

16-bit

wvalues

function

that

are

Figure

9-3

They specify the particular I/0 operation

16-bit

function

modifiers.

function value.

I
|
—~—

FUNCTION MODIFIERS

CODE
TK-1899

Figure

Symbolic names

9-3

1I/0

Function

Format

are described by the SIODEF macro.

See

System Services Reference Manual.

the VAX/VMS

Function Codes - The low-order six bits of the function value make
up a code that specifies the particular operation to be performed.
For
example,
the code
for
read
1logical
block 1is
expressed
as
I0$ READLBLK.
Table 9-1 1lists the symbolic wvalues for read and

write I1/0 functions

Physical

in the

Table 9-1

Read and Write I/0 Functions

1/0

Logical

IO$_READPBLK

1/0

Virtual

I0S READLBLK

I10$ WRITEPBLK

The

three transfer modes.

I/0

IOS_BEADVBLK

I10$ WRITELBLK

I0$ WRITEVBLK

set mode I/0 function has a code of

I0$_SETMODE.

Function codes are defined for all supported devices.
Although
some
of
the
function
codes
(for
example,
IO$ READVBLK
and
I0$S WRITEVBLK)
are used with several types of devices, most are

device-dependent.

particular
types
device-dependent
file-structured

That

is,

they

perform

of
devices.
For
function
code.

devices

such

as disks

9-15

functions

example,
It
1is

and

specific

IO$ CREATE
used
only

magnetic

tapes.

1is
a
with

VAX

Diagnostic

Design Guide

Function Modifiers - The
are function modifiers.
basic
operation
to
be

high-order 10 bits of the function value
These are individual bits that alter the
performed.
For
example,
the
function

modifier
IO$M NOECHO
can
be
specified
with
the function
IO$ READPBLK to a terminal.
When used together, the two values
are written as IOS_READPBLK!IOS$M NOECHO.
This means that data
typed at the terminal keyboard
not
echoed
(displayed)
at
the
format of function modifiers.
15

is entered
terminal.

13 12

in the user buffer
Figure 9-4
shows

but
the

DEVICE/FUNCTION

)

INDEPENDENT

DEVICE/FUNCTION
DEPENDENT
TK-1900

Figure

9-4

Function

Modifier

Format

shown, bits 13 through 15 are device/function independent bits,
and
bits
6
through
12
are
device/function
dependent
bits.
However,
device/function dependent bits have the same function,
whenever possible, for different device classes.
For example, the

function
tape

modifier

devices

IO$M ACCESS
cause

file

used
to

with

both

accessed

disk

and magnetic

during

a
create
operation.
Device/function dependent bits always have the same
function within the same device class.
Most function modifiers
are device/function dependent.
There
are
two
device/function
independent
modifier
Dbits:
IOSM_INHRETRY and IOSM_DATACHECK.
IO$M_INHRETRY
is used to
inhibit
all
error
recovery.
If
any
error
occurs,
and
this
modifier bit is specified, the operation is immediately terminated
and
a
failure
status
1is
returned
in
the
I/0
status
block.

IO$SM DATACHECK

disk

magnetic

list

function

9-2

through

codes

and

used

9-9.

modifiers

that
the
arguments
function specified.
details.

tape.

codes
The

are

compare

and

function

data

in memory

Tables
These

for
the
QIO service depend
VAX/VMS I/0 User's Guide for

on
the
further

(P1-P6)

according

9-16

are

follows

that

grouped

modifiers

with

listed.

arguments

required
See the

the

also

device

types.

Note

VMS

Table

Function

9-2

Terminal

I/0

Driver

PFunctions

Parameters

Modifiers

I0$ READVBLK

Pl=buffer

IO$_READLBLK
I0$ READPROMPT
IO$_READPBLK

P2=buffer size
P3=time-out
P4=read terminator

address

IOSM CVTLO

block

addresi

PS5=prompt

string

buffer

addrfss

P6=prompt

string

buffer

size

I0$S WRITEVBLK
I0$ WRITELBLK

Pl=buffer
P2=buffer

IO$_WRITEPBLK

P3=(ignored)

Pl=address
buffer

IOSM _CANCTRLO
IOSM_ENABLMBX
specifier

characteristics

P2=(ignored)
P3=speed specifier

P4=fill specifier
P5=parity flags

IO$_SETMODE!IO$M_HANGUP
I0S$S SETCHAR!IOSM HANGUP

(none)

10$ _SETMODE!
I0$M _CTRLCAST
P1=AST service routine address
I10$
I0$

SETMODE!IOSM_CTRLYAST

P2=AST parameter

SETCHAR!IOSM CTRLYAST
~ P3=access

2Only for I0$_READPROMPT.
Only for

I0$ WRITEBLK and

mode

I0$SM_PURGE

IO$M:TRMNOECHO

5
control

IO$M_DISABLMBX
IO$M_NOECHO
IOS$SM NOFILTR
IOSM TIMED

address
size

P4=carriage

I0$ SETCHAR
I0S SETMODE

Service Macros

to deliver

I0$ WRITEVBLK.

AST

IO$M_NOFORMAT

VAX Diagnostic Design Guide

Table

9-3

Disk

I/0 Driver

Functions

Function

Parameters

Modifiers

10$ READVBLK
I0$_READLBLK
I0$_READPBLK

Pl=buffer address
P2=byte count
P3=disk address

I0$M_ DATACHECK
IO$M_INHRETRY
I0$M_INHSEEK

I0$_ WRITEVBLK
I0$ WRITELBLK
I0$ WRITEPBLK
Pl=characteristic

P1=FIB descriptor address
P2=file name string
address
P3=result string
address

length

P4=result string descriptor
address
P5=attribute list address

lOnly
for I0S READPBLK and IO$_WRITEPBLK.
2
3Only for

I0$

I0$ INHRETRY

CREATE

and

I0$ ACCESS.

Only for IO$ CREATE and IO$ DELETE.

9-18

IOS$M_CREATE
I0$M_ACCESS
I0$M DELETE

I0$ CREATE
I10$ ACCESS
105 DEACCESS
10$ MODIFY
I0$ DELETE

buffer

address

10$_ SETMODE
I10$ SETCHAR

VMS Service Macros

Table 9-4

‘Magnetic Tape I/0 Driver

Functions

Function

Parameters

Modifiers

I0$ READVBLK
I0$ READLBLK

Pl=buffer address
P2=byte count

I0$M_DATACHECK
I0$M_INHRETRY
10$M REVERSE
I0$M_INHEXTGAP2

10$ READPBLK

I0$ WRITEVBLK
I0$ WRITELBLK
I0$ WRITEPBLK
I0$ SETMODE

I0$ SETCHAR

address

I0$ CREATE

P1=FIB

10$ ACCESS
I0$ DEACCESS
10$ MODIFY

P2=file

I0$_ACPCONTROL

buffer

Pl=characteristics

descriptor

name

address

P3=result

address

P4=result

address

string

length

string

descriptor

P5=attribute

list

I0$M_INHRETRY
I0$M_INHEXTGAP

TOSM_CREATE

I0$M_ACCESS)
IO$M_DMOUNT

address

I0$ SKIPFILE

Pl=skip n

tape marks

I0$M_INHRETRY

I0$ SKIPRECORD

Pl=skip n

records

IO$M_INHRETRY

I0$_ MOUNT

(none)

I0$ REWIND
I0$_REWINDOFF

(none)

I0$ WRITEOF

(none)

I0$_ SENSEMODE

(none

Only for read functions.
Only for write functions.
Only for IO$ CREATE and IO$ ACCESS.

Only for IO$ ACPCONTROL.

IO$M INHRETRY
IO$M NOWAIT
IOSM_INHEXTGAP

IO$M INHRETRY

I0$ INHRETRY

VAX Diagnostic Design Guide
Table 9-5

Line Printer

Function

Parameters

I0$ WRITEVBLK
I0$ WRITELBLK

Pl=buffer
P2=buffer

I0S$S _WRITEPBLK

P3=ignored

Only for

address
size

Table 9-6

(none)

1
control

specifier

Parameters

I0$ READLBLK

Pl=buffer

I0$S READVBLK

10$ READPBLK

(none)

IOS WRITELBLK

Modifiers

address

P2=byte count

I0S_SETMODE
I0$ SETCHAR

Pl=characteristics
buffer address

IOS_SENSEMODE

(none)
Table 9-7

Mailbox

Parameters

IO$_READVBLK

Pl=buffer address
P2=buffer

size

none

P1=AST

IO$_SETMODE!IO$M WRTATTN

P1=AST

IO$M BINARY

I0O$M_PACKED
(none)

Functions

Modifiers

I0$ WRITEVBLK
T0$ WRITELBLK
10$ WRITEPBLK

IO$_SETMODE!IO$M READATTN

I/O Driver

Function

I0$ READLBLK
I10$READPBLK

address

Card Reader I/0 Driver Functions

Functions

I0$ WRITEOF

Pl=characteristics buffer

IO$ WRITEVBLK and

Functions
Modifiers

P4d=carriage

I0$ SETMODE
I0$ SETCHAR

I/O Driver

address
parameter

IO$M_NOW

VMS Service Macros

Table 9-8

DMC-11 I/0 Driver Functions
Modifiers

Function

Parameters

I0$ READLBLK
I0$ READPBLK
I0$ READVBLK
I0$ WRITELBLK

Pl=buffer size
P2=message size
P6=optional diagnostic

IOSM DISQBLMBX2

buffer

|TO$M_NOW

I0$M_ENABLMBX

I0$ WRITEPBLK
I0$ WRITEVBLK

I0$ SETMODE

Pl=characteristics
buffer

10$ SETCHAR

address

IO$ SETMODE'IOSM_ATTNAST
P1=AST service
IO$_§ETCHAR!IO$M_ATTNAST
P2=(ignored)
P3=AST

access

routine

address

mode

I0$ SETMODE!IOSM SHUTDOWN

Pl=characteristics

block

address

block

address

10$. SETCHAR'IO$M SHUTDOWN

I10$ SETMODE'IOSM STARTUP

Pl=characteristics

I0$ SETCHAR'IO$M_STARTUP

P2= (1gnored)
P3=receive message

blocks

Only for I0$ READPBLK and IO$ WRITEPBLK.
’2 Oonly
for IOSREADLBLK and IO$READPBLK.
3

Only for

IO$WRITELBLK and I0$5WRITEPBLK.

Table 9-9

ACP Interface Driver Functions

Function .

Parameters

Modifiers

I0$ CREATE
I0O$ ACCESS

P1=FIB descriptor address
P2=file name string

I0$M_CREATE.
IOSM ACCESS%

I0$ DEACCESS
I0$ MODIFY
IOS DELETE

address
P3=result string length
address

I0$ ACPCONTROL

P4=result

I0$_MOUNT

P5=address
(none)

address

string descriptor
of

attribute

Used only with IO$ACCESS and IO$_CREATE.
3Used only with I0$ CREATE and IO$ DELETE.
Used with I0$ACPCONTROL.

list

IO$M DELETE
3
-

I0$M_DMOUNT

VAX Diagnostic Design Guide

9.3.3.3
returns

Synchronizing I/0 Completion - The QIO system service
control to the calling program as soon as the I/0 request
is queued.
The status code returned in R@ indicates whether or
not the request was queued successfully.
The program must perform
the following two steps to ensure proper synchronization of the
I1/0 operation with

Test

respect

whether

the

program.

the

1I/0

operation

has

been

queued

successfully.

Test whether the
successfully.

Optional

arguments

I/0

the

operation

QIO

itself

service

has

provide

been

techniques

synchronizing I/0 completion.
There are three methods
to test for the completion of an I/O request:
Specify the number of an event
I/0 operation is completed.

Specify the address of an AST routine to be executed when

Example

I/0

Specify

when

9-9

unrelated

the

operation

the

operation

shows how

you

The

set

when

the

completed.

address

I/0

programs.

for

you can use

the

flag

completed

can

use

following

I/0

status

block

these

three

techniques

completed.

notes

are

keyed

the

posted

three

example.

When you code an event flag number as an argument, QIO
clears the event flag when it queues
the
I/0
request.
When the I/0 operation is completed, the flag is set.

In this example, the program issues two I/0 requests.
different event flag is specified for each request.

The

Wait

service

for

operations

the

Logical

places

event

indicates

are

complete.

flags
the

AND

the process

Event

in
The

Flags

(WFLAND)

system

a wait state

until

EFN

indicates

argument

are

both

cluster

the MASK

flags

that

the

service

wait

both

I/O
that

argument
for.

When
you
code
the
ASTADR
argument
to
the
QIO
system
service, the system interrupts the process when the I/O
operation
1is
completed
and
passes
control
to
the
specified AST service routine.

The
AST

When the

QIO system service call specifies the address of the
routine,
TTAST,
and
a
parameter
to
pass
as
an
argument to the AST service routine.
When QIO returns
control, the process continues execution.

called,

I/0 operation
and

responds

9-22

completed,
the

I/0

the

routine TTAST is

completion.

VMS Service Macros

When this routine has finished'executing, control returns
to

the

For

process at

the

point .at which

it was

interrupted.

how

code

AST

An
I/0 status block
is a quadword structure that
system uses to post the status of an I/0 operation.
quadword area must be defined in your program.

the
The

TTIOSB defines

I/0

service

information

routine,

refer

ASTs

and

Paragraph

3.2

the

VAX/VMS

System Services Reference Manual.

operation.
refers

The

this

the

IOSB

I/0O

status

argument

quadword.

block

the

QIO

for

this

system

service

QIO clears the quadword when it queues the
When
the
request
1is
successfully queued,
continues execution.

10.

The process polls the I/0 status block.
1If the low-order
word
still
contains
@,
it
indicates
that
the
1I/0
operation

has

not

yet

been

completed.

I/0 request.
the
program

program

program loops until the request is complete.

Program A: Using Event Flags
W

RJ,ERROR

‘

Using An AST

Routine

@ @ $QI0 S

...,ASTADR=TTAST,ASTPRM=#1,...
;

I/0 with AST

Queued successfully?
Continue.

AST
mask

service

routine entry
-

Handle

I/0 completion.

end of

service

23]

L ]

|
R@,ERROR
" BLBC

Program B:

SWFLANDS EFN=#32,MASK="Bll

BLBC

(:)

R®,ERROR

$QI0_S EFN=#33,...

BLBC

Issue lst I/0 request.
Queued successfully?
Issue 2nd I/0 request.
Queued successfully?
Wait till both are done.

(:)

$QI0S EFN=#32,...

(:)

routine

the

VAX Diagnostic Design Guide

z;logram C: USING THE I/0 STATUS BLOCK
7

I/0

R@,ERROR

Issue

TTIOSB

10§
TTIOSB,#5S$ NORMAL

BNEQ

ERROR

Example

9.3.3.4

9-9

I/0

Completion

I/0

Status

request.

successful?

No, error.
Yes, handle

WMe

Synchronizing

I/0

Three Methods

I/0

When

format

for

the

I/0 status

16 15

BYTE COUNT

operation

1is

status
in
the
1I/0
completion
status
actually completed

successfully,
the
number
of
bytes
that
were
additional device-dependent return information.

the

it.

Completion,

completed,
the
system
posts
the
completion
status
block,
if
one
1is
specified.
The
indicates whether
or
not
the
operation
was

Figure 9-5 shows

block

Is 1/0 done yet?
No, loop till done.

TSTW

BEQL
CMPW

- 16$:

status

Queued successfully?
Continue.

$QI0O S ...,IOSB=TTIOSB,...

BLBC

(:)

.BLKQ

TTIOSB:

transferred,

and

block.

STATUS

DEVICE-DEPENDENT INFORMATION
TK-1901

Figure 9-5

1I/0

Status

Block

Format

The
first
word
contains
a
system
status
code
indicating
the
success or failure of the operation.
The status codes used are
the same as for all
returns
from system services; for example,
SS$ NORMAL indicates successful completion.
The second word contains the number
transferred in the I/O operation.

9-24

bytes

that

were

actually

VMS

The

second

longword

ensure

successful

I/0

the

should

transfers,

contains

IOSB

device-dependent

completion
be

and

checked

Service Macros

return

the

information.

integrity

following

I/0

data

requests,

particularly for
device-dependent
I/0
functions.
For
complete
details on how to use the I/O status block, refer to the VAX/VMS
I1/0 User's Guide.

9.3.4
$QIOW_x Queue I/0O Request and Wait for Event Flag
This macro calls a VMS service that combines the Queue I/0 Request
and the Wait for Event Flag system services.
You should use this

macro when

your

proceeding.

program

takes

the

same

$QIOW
x efn, chan, func,
(p31, [p4]1, [p5], [p6]
efn

the

number

[iosb],
|

iosb

astadr

astprm

I/0O

channel

the function

code

and

modifier

operation
to
symbolically.

the

QIO

entry

about

a
of

performed.

which

bits

The

the

that

code

point

address

the

QIOW

executes at the
access
service was requested.

the

AST

the

I/0

completed.

routine

parameter

passed

device-specific

request

parameters.

status

codes,
in

and

privilege

notes,

Paragraph

device

which

information

The

may

[p2],

refer

specify

the

routine

specified,

the

AST

from

channel

has

requested:

primary

device characteristics,
secondary device characteristics.

9-25

which

returns

1I/0

resources

description

been

completion

9. 3. 3.

I/O

the

expressed

that

restrictions,

block

mode

the

request

function-specific

$SGETCHN Get I/0 Channel Information
I/0 Channel Information system service

AST

AST
the

service

[pl],

that is to be set at I/0
You must specify the event flag number.
value of @ will cause supervisor errors.

when

returned,

before

flag

executed

optional

and

system

9.3.5
The Get
sets

return

required

[astprm],

the

routine.

For

[astadrl},

number

completion

$Q10 x.

the address of the quadword I/O status
to receive final completion status.

Pl - p6

I/O

event

the

for

the

directed.
func

wait

arguments

completion.
The default
chan

must

the

information

assigned.

Two

VAX Diagnostic Design Guide

In most cases, the two sets of characteristic information are
However, the two sets prov1de different information in
identical.

the

following

»If

cases:

the

associated

has

device

primary

the

mailbox,

characteristics are those of the assigned device and the
secondary characteristics are those of the associated

mailbox.

the

device

1is

spooled

device,

the

primary

characteristics are those of the intermediate device and
the secondary characteristics are those of the spooled

device.

If the device represents a logical link on the network,
the secondary characteristics contain information about

link.

the

$GETCHN chan ,[prilen]

chan

service,

prilen =

pribuf =

the

address

secbuf =

I/0

word

primary characteristics.

(ASSIGN)

Channel

receive

the

1length

system

the

the address of the character string descriptor pointing
to the buffer that is to receive the primary device
An address of @ (the default) implies
characteristics.
that no buffer

seclen =

Assign

the

,[secbuf]

The channel number of a device is

the channel number.
returned

,[seclen]

,[pribuf]

is specified.

the address of the word to receive the length of the

secondary characteristics.

the address of the character string descriptor pointing
to the buffer that is to receive the secondary device
An address of # (the default) implies
characteristics.
that no buffer

is specified.

Return Status Codes

The device
SS$ BUFFEROVF: Service successfully completed.
information returned overflowed the buffers provided and has been
truncated.

SS$ NORMAL:

Service successfully completed.

SS$ ACCVIO:

A buffer

buffer

descriptor

length cannot be written,

cannot

read,

buffer or

by the caller.

An invalid
SS$ IVCHAN: An invalid channel number was specified.
channel number is @ or a number larger than the number of channels
available.

9-26

VMS Service Macros

SS$ NOPRIV:

The

from a more

specified

pr1v1leged

channel

not

access mode.

assigned

was

assigned

Privilege Restrictions
The Get I/O Channel information service can be performed
assigned channels and from access modes that are equal to

privileged
assignment

than the
was made.

access

mode

from

Format of Device Information
The GETCHN system service returns

53-byte
buffer.
represent offsets
The

field

offset

which

information

Symbolic
names
defined
from the beginning of the
names,

lengths,

the

and

original

in
the
buffer.

contents

are

only on
or more

channel

user-supplied
S$DIBDEF

listed

macro

below.

Length

Field Name

(bytes) | Contents

DIBSL DEVCHAR
DIB$B_DEVCLASS

4
1

DIBSB_TYPE
DIBSW DEVBUFSIZ

1
2

DIBSL DEVDEPEND
DIBSW UNIT

Device characteristics
Device class
:

Device type
Device buffer

4
2

DIBSW DEVNAMOFF

DIBSL PID

DIB$SW VPROT
DIBS$W ERRCNT
DIBSL OPCNT

2
2
4

DIBSL OWNUIC

Of fset

Process

DIB$W VOLNAMOFF

size

Device dependent
Unit number

information

device name

string

identification of device owner

UIC of device owner

Volume protection mask
Hard error count for device
Operation count
'

- Offset to volume label string

The device name string and volume label string are returned
in the

buffer
as
counted
offset values.

ASCII

strings

and

must

located

their

Figure 9-6 shows the buffer layout.
The offsets are displacements
from the front
of the buffer.
Offsets of 0@ show missing fields.
Both the device name and the volume label are stored as counted
strings.

You

service

returns

length

9.3.6

The

must

locate

both

through

label

the

and a

offset

device

values.

name,

I/0

requests

that

the

1/0

Channel

specific
are

the buffer

bytes.

SCANCEL
x Cancel

Cancel

them

volume

on Channel

system

channel.

queued,

service
1In

cancels all

general,

well

the

this

includes

request

pending I/0
all

1/0

currently

progress.

$CANCEL_x chan
chan

the

number

which

the

I/0

I/0 operation

channel

9-27

assigned

cancelled.

the

device

for

VAX Diagnostic Design Guide

16 15

08 07

DEVICE CHARACTERISTICS

BUFFER SIZE

TYPE

CLASS

DEVICE DEPENDENT INFORMATION

OFFSET TO DEVICE NAME

UNIT NUMBER

OWNER PROCESS PID

OWNER PROCESS UIC

ERROR COUNT

VOLUME PROTECTION
MASK

OPERATION COUNT

OFFSET TO

VOLUME LABEL
TK-1902

Figure 9-6

Buffer Layout Supplied by the GETCHN System Service

Return

Status Codes
SS$ NORMAL: Service

successfully completed

SS$ _EXQUOTA: The process has exceeded its quota for direct
this context, direct I/0 refers to use of the direct data
the Unibus interface.

I/0. In
path on

SS$ INSFMEM:
Insufficient system dynamic memory is available to
cancel the ‘I/0, and the process has disabled resource wait mode
with the Set Resource Wait Mode (SETRWM) system service.

SS$ IVCHAN:
number

available.

SS$ NOPRIV:
from

a more

An invalid channel was specified, that is, a channel
or

The

number

specified

privileged

1larger

channel

access

than

the

number

is not a551gned,

mode.

9-28

channels

or was a551gned
-

VMS Service Macros

Privilege Restrictions
»
I/0 can be canceled only from an access mode equal
to
privileged than the access mode from which the original
assignment was made.
NOTES

When a request currently in progress
is canceled, the driver is notified
immediately.
Actual cancellation
may or
may
not
occur
immediately
depending
on
the
1logical
state of
the driver.
When cancellation does
occur, the same action as that taken
for queued requests is performed:

The specified event flag is set.

The

first

word

the

block,
if specified,
SS$ CANCEL.

The

AST,

queued.

Proper

I/0

status

set

specified,

synchronization

between

1is
this

service and the actual canceling of
I/0
requests
requires
the
issuing
process to wait for I/O completion
in
the
normal
manner
and
to
then
note that the I/0 has been canceled.
2.

If the
I/0 operation is a wvirtual
I/0 operation
involving
a disk or
tape ancillary control process, the
I/0
operation
cannot
be
canceled.
In
the
case
of
a
magnetic
tape,
however,
cancellation may occur
if
the device driver is hung.

Outstanding

automatically
exit.

1/0

requests

canceled

9-29

are

image

or more
channel

VAX Diagnostic Design Guide
9.4
EVENT FLAG SERVICE MACROS
Event flags are status postlng bits
can require some system services to

maintained by VAX/VMS
You
set specific event flags in

order

occurrence

program
the QIO

indicate

the

completion

that calls the
system service

service
sets an

event.

or output operation has been completed.
You can use the
flag services to perform any of the following functions.

The

can test these flags.
For example,
event flag when the requested input
event

)

Set or clear specific flaQs.

Test the current status of flags.

Place a process
in a wait state pending the setting of a
specific

supervisor

However,

event

the

program

for

use

and

flag

or group

provides

two

flags 1-23
the

This

flags.

event

are

operator,

by VAX/A/MS.

flag

clusters,

restricted

0-31

and

event

flags

24-31

leaves

flags

32-63

for

the diagnostic program developer.
is reserved for the supervisor.

not

and

communication

use

are

32-63.

between

restricted

exclusive

event

flag

use

This

‘

9.4.1
$SETEF_x Set Event Flag
This macro calls a service that sets the event flag specified.
Any processes waiting for the event flag are made executable.

$SETEF efn
efn

the number
flag @.

the

event

flag

set.

not

use

event

Return Status Codes'
SS$_WASCLR:
Service successfully
flag was previously #@.

completed.

The

specified

event

SS$_WASSET:
Service successfully
flag was previously 1.

completed.

The

specified

event

SS$ ILLEFC: An illegal event flag number'was_speCified.
SSS UNASEFC:
The
process
is
containing the specified event

not
associated
flag.

with

the

cluster

VMS Service Macros

9.4.2
This

$CLREF_x Clear Event Flag
macro

calls a

service

that

clears

event

flag.

cleared.

x efn
$CLREF
efn =

the

number

Return Status Codes
SS$S WASCLR:
Service

flag was

flag

was

Service

previously

SS$_ILLEFC:
An

SS$ UNASEFC:
containing
9.4.3

The

flag

completed.

o
The

specified

successfully completed.

The

specified event

event

illegal

the

event

|
successfully
0.

previously

SS$_WASSET:

the

event

process

specified

$READEF X Read

flag

number was specified.

not

event

associated

flag.

with

the

cluster

Event Flags

This macro calls a service that returns the
32 event flags in an event flag cluster.

current

status

all

$READEF
X efn, state
efn

the number of any event

flag

number of

@ through

31 specifies

cluster

flag

number

cluster

and

the

address

all

event

Return Status Codes
SS$ WASCLR:
Service
flag is clear.

SS$ WASSET:
Service
flag is set.
SS$ ACCVIO:
all

event

The

flags

SS$ ILLEFC:

SS$ UNASEFC:
containing

the cluster

state

flag within

read.

the

through

receive

specifies

the

current

status

cluster.

successfully

completed.

The

specified

event

successfully

completed.

The

specified

event

the

illegal

The

longword

flags

longword
in

that

cluster

event

process

specified

flag

1is

event

receive

cannot

number

not

the

written

was

current
by

the

state

caller.

specified.

associated

with

the

cluster

flag.

9.4.4
SWAITFRx Wait for Single Event Flag
This macro calls a service that tests a specific event flag.
If
the
flag
is
set,
control
returns
to
the
calling
program
immediately.
1If the flag is cleared, the process is placed in a
wait state until the event flag is set.

9-31

VAX Diagnostic Design Guide

x efn
$WAITFR

efn

the number of the event flag

for which to wait.

Return Status Codes

SS$ NORMAL:

Service successfully completed.

SS$ ILLEFC:

An illegal

event flag number was specified.

The process is not
SS$_ UNASEFC:
containing the specified event flag.

associated

with

NOTE

The wait state caused by this service
can be interrupted by an asynchronous
the access
(1)
if
system trap (AST),
mode at which the AST executes is less

than or equal to the access mode from
which the wait was issued and (2) the
process is enabled for ASTs at that
access mode.

When the AST service routine completes
the
repeats
system
the
execution,

If the event flag has
WAITFR request.
been set, the process resumes execution.

the

cluster

VMS Service Macros

9.4.5
SWFLAN
x Wait
D for Logical AND of Event Flags
This macro calls a service that allows the program to specify a
mask of event flags for which it wishes to wait.
If all of the
flags
indicated by the mask are set, control returns immediately
to
the calling
program.
Otherwise,
the program
is
placed
in a
wait state until the flags are all set.

SWFLAND_x efn, mask
efn

mask

the
number
used.
the

any

32-bit

flags
Return

Status

mask in
interest.

event

which

flag

bits

within

set

cluster

indicate

the

being

event

Codes

SS$ NORMAL:

Service successfully completed.

SS$ ILLEFC:

SS$_UNASEFC:

the

illegal
The

containing
the

event

process

specified

flag

number

was

specified.

not associated

event

with

the

flag.

‘

cluster

NOTE

The wait state caused by this service
can be interrupted by an AST, if (1) the
access mode at which the AST executes is
less than or equal to the access mode
from which the wait was issued and
(2)
the process is enabled for ASTs at that
access mode.
When the AST service
routine completes
execution,
the
system
repeats
the
WAITFR request.
If the event flag has
been set, the process resumes execution.

9.4.6

$WFLOR_x Wait

for

Logical

OR of

Event Flags

This macro calls a service that tests the event flags specified by
a mask within a specified cluster.
The service returns control to
the calling
program
immediately
if any of
the
flags are
set.
Otherwise, the service places the program in a wait state until
one

the

selected

event

flags

set.

x efn, mask
SWFLOR
efn

the

number

any

event

flag

within

the

cluster

being

used.

mask =

a 32-bit mask
of

Return

Status

SS$ NORMAL:

in which

bits set

interest.
Codes

Service

successfully completed.
9-33

show the

event

flags

VAX Diagnostic

Design Guide

SS$_ILLEFC:

illegal event

SS$_UNASEFC:
containing

The

the

process

specified

flag

event

number

not

was specified.

associated with

flag.

the

cluster

NOTE

The wait state caused by this service
can be interrupted by an AST, if (1) the
access mode at which the AST executes is
less
from

than or equal
to
the access mode
which the wait was issued and
(2)
the process is enabled for ASTs at that
access mode.
When

the AST service routine completes
execution,
the
system
repeats
the
WAITFR request.
1If the event flag has
been set, the process resumes execution.

9.5
The

TIMER SERVICE MACROS
timer
and
time
conversion

services

enable

the

program

schedule
program
activity
according
to
clock
time.
They
are
available
to
1level
2,
2R,
and
3
diagnostic
programs.
You
may
schedule events according to the time of day or the passage of a
time
interval.
The
timer
services
enable you to
schedule
the
setting of an event flag or the queueing of an asynchronous system
trap for
the program.
The
timer
services also
enable you to
cancel
a
pendlng
request
that has not yet been honored.
These
services
require
you
to
specify
the
time
in
a
64
bit
system
format.
'
You

can

use

the

time

conversion

Obtain the time

Convert

an ASCII

services

the

system

string

into

perform

two

functions.

format
the

system

format.

VAX/VMS maintains
the current date
and
time
(using
a 24
hour
clock)
in 64
bit
format.
The
time value
is
a binary number
representing 100 ns offsets
from the system base date and time.
This is 00:00 o'clock, November 17, 1858.
All time values passed
to the timer services must also be expressed in the 64 bit system
format.

time

value

may

time,

expressed

which

three

ways.

An absolute

is a specific date and time of

A delta time, which is a future offset (number of days,
hours,
minutes,
seconds,
and
so
on)
from
the current
time.
Delta
times
are
always
expressed
as
negative

day.
Absolute
times are
standalone supervisor does

values.

always
positive values.
The
not support absolute times.

‘

9-34

- VMS Service Macros

which

indicates

that

the

system service

the
current date
and
time. The
does not support this function.

9.5.1
$GETTIMx Get Time
This macro calls a service that
in

the

(SETIMR)

bit

system

format

furnlshes

suitable

standalone

the

for

should

supervisor

current

system

receive

the

input

use

the

Set

time

Timer

service.

x timadr
SGETTIM
timadr =

Return

the

address

time

in 64

Status

of
bit

a quadword
format.

that

current

Codes

SS$ NORMAL:

Service

SS$_ACCVIO:

The

successfully completed.

quadword

receive

the

time

cannot

written

the caller.

9.5.2
This

$BINTIM x Convert ASCII String
macro

calls

service

that

to Binary Time

converts

ASCII

absolute or delta time value in the 64 bit system
for input to the Set Timer (SETIMR) service.

$BINTIM
x
timbuf

timbuf,
the

address

the

absolute

address

converted

Return Status Codes
SSS NORMAL: Service
SSS$S IVTIME:
or the time

character

delta

string

time

quadword
bit

format

suitable

descriptor

pointing

value

that

format.

one

converted.

the

formats

receive

the

successfully completed.

The syntax of the specified
component is out of range.

ASCII

string

NOTES

timadr

The ASCII
string value must
be
shown in Note 1, which follows.

timadr =

string

The

requ1red

have

the

ASCII

following

input strings

formats:

Absolute Time:
dd-mmm-yyyy hh:mm:ss.cc
Delta Time:
dddd

hh:mm:ss.cc

Table
9-18
each string

shows

the

format.

the

9-35

function

invaliaqd,

" VAX Diagnostic Design Guide

The following syntax rules apply to
the
coding
of
the
ASCII
input
string:
®

Any of the fields of the
and time can be omitted.

For

absolute

time

date

values,

the

BINTIM
service
supplies
the
current system date and time for
nonspecified
fields.
Trailing
fields
can
be
truncated.
If
leading fields are omitted, the
punctuation
(hyphens,
blanks,
colons,
periods)
must
be
specified.
For
example,
the
string
--12:00:00.00

~results in an absolute time
12:00 on the current day.

For ‘delta

time

values,

the

periods) must be specified.

For

BINTIM
service
defaults
g.
to
fields
nonspecified
be
can
fields
Trailing
fields
leading
If
truncated.
are omitted from the time value,
the punctuation (blanks, colons,
example,

the string

B::10

results

delta

time

160

seconds.

For both absolute and delta time
values, there can be any number
of
1leading
blanks,
and
any
number of blanks between fields
normally delimited by blanks.
However,
there
may
be
no

embedded

blanks

within

the date or time fields.

either

VMS
Table 9-10

Field

Punction

or Delta

Field

(Bytes)|

Range
1

day

mmm

hyphen

month

blank

Absolute

Values

Contents

- YYYY

for ASCII

month

of Values

Required

FEB,

MAR,

MAY,

JUN,

JUL,

AUG,

SEP,

OCT,

NOV,

DEC

hyphen

Required

year

g -

blank

Required
more

hour

colon

Required

minutes

syntax

(one

blanks)

syntax

-59

colon

Required

seconds

syntax

period

Required

hundredths

9999

APR,

-23

syntax

JAN,

dddd

Macros

Length

Time

Service

syntax

seconds

number of days|
(in 24- hour
units)

.BLKQ

$BINTIM S TIMBUF=ANOON, TIMADR'BNOON
Example

9-10

Use

$BINTIM X

to System

When
64

the

bit

ASCII

buffer
noon

Convert time.

noon

for

Absolute

time

binary

Time

Format

Value

program calls

value

The
value
service.

Convert

BNOON:

absolute

DESCRIPTOR <-- 12:00:00.
88>

| ANOON:

ASCII

Example 9-10 shows how you can
translate
valu
to the
e 64-bit system format.

the BINTIM service, the service returns a
representing noon
today
in
the
quadword at BNOON.
BNOON

may

then

serve

input

the

SETIMR

Example 9-11 shows how .to use the BINTIM service
to
translate a
time interval
(delta
time)
given in ASCII
format to the 64 bit

system format.

9-37

VAX Diagnostic Design Guide
DESCRIPTOR

00:10:00.00>

ASCII

ten minutes

$BINTIM
S TIMBUF=ATENMIN, TIMADR=BTENMIN
Example 9-11

buffer for
minutes

;

Convert time.

. BLKQ

BTENMIN:

ATENMIN:

Use of

$BINTIM
x to

Value

System

Convert a Delta

binary ten

Time

Format

This code returns the delta time of ten minutes to BTENMIN in 64

bit

system

format.

9.5.3
Specifying Delta Time Values at Assembly Time
You can also specify delta time values at assembly time (instead
of run time)
using a MACRO .LONG directive.
You can code an
arithmetic expression to represent a time value in terms of 100
ns units.
The arithmetic is based on the following formula.

1 second = 10 million *100 ns
For example,
5 seconds in

FIVESEC:

the following statement defines
the 64-bit system format:

.LONG

-10*1000*1000*5,-1

;

five

delta

time value

seconds

The value 10 million is expressed as 10*1000*1000 for readability.

Note that the delta time value
longword, extends the sign bit.

negative.

The

-1

the

second

If you use this notation, however, you are limited to the max imum

number of
is

100

somewhat

units

than 7

that can be
minutes.

expressed

longword.
:

This

9.5.4
$SETIMR
x Set Timer
This macro calls a service that allows a program to schedule the
setting of an event flag and/or the queueing of an asynchronous
system trap (AST) at some future time.- You can specify the time
for the event as an absolute time or as a delta time.

$SETIMR_x efn, daytim, [astadr], [regidt]
efn

daytim

the number
of
the
event
flag
to
set when
the
time
interval expires.
You must specify the EFN, since the
default value is @ and will cause supervisor errors.
the address of the quadword containing the expiration
time value.
A positive time value indicates an absolute
time at which the timer is to expire.
A negative time
value indicates an offset (delta time) from the current
time.
The
time value
should
be coded
in
the 64-bit
system

format.

9-38

- VMS

astadr =

the

address

argument

reqidt =

called
is

the

entry mask

when
not

for an AST service routine
time interval expires.
If this

the

specified,

supplied.

request

identification

You

specify

shows

can

Service Macros

that

the

AST

default

number.

The

value

queued.

default

1is

value

unique

request
identification
number in each Set Timer request. Or, you can give the
same request
identification number to related Set Timer
requests.

You

can

later
to
cancel
argument
is
also
number

passed

use

the

Set

Timer

request

identification

requests.

supplied,
the
request
to the AST routine.

number

ASTADR

identification

Return Status Codes
SSS_NORMAL:

Service

SS$_ACCVIO:

The

expiration

SSS$ EXQUOTA:

The

exceeded,

the

Set

and

Resource

SS$_IVTIME:

already

Mode

illegal

passed, or

the

quota

has

event

Insufficient

SS$ UNASEFC:

The

flag

was

read by the caller.

timer

entries

resource

system

has

wait mode

been

with

the

specified

has

service.

number was

expiration

time

SS$_INSFMEM:

for

disabled

(SETRWM)

absolute

completed.

time cannot be

process
process

Wait

SS$ ILLEFC:

successfully

time

specified.

that

specified

was

dynamic memory is available to allocate
a timer queue entry,
and
the process has disabled resource wait
mode with the Set Resource Wait Mode (SETRWM)
system service.

containing
Resources

the

process

specified

1is

not

event

Required/Returned

The

Set

Timer

associated

system service

Set Timer system
timer queue entries.

with

The

access

service

mode

access
mode
the AST.

dynamic

uses

process's

the

caller

request

the

and

Use
the
Convert
ASCII
String
to
Binary Time (BINTIM) system service
to

convert

the

input

specified

quadword

cluster

1
requires

NOTES

the

flag.

the

time

ASCII

format

string

required

SETIMR service.

memory.
quota

for

VAX Diagnostic Design Guide

x Cancel Timer Request
$CANTIM

9.5.5

The Cancel Timer Request system service cancels all, or a selected

subset, of the Set Timer requests previously issued by the current
Cancellation 1is based on the
image executing in a process.
the Set Timer (SETIMR) system
in
specified
request identification
has been given the same
request
timer
one
If more than
service.
canceled.
all
are
they
request identification,

Macro

Format

[acmode]

x
$CANTIM

([reqidt],

reqidt =

timer
the
of
number
identification
request
the
default)
(the
§
of
value
A
canceled.
be
request(s) to
indicates that all timer requests are to be canceled.

acmode =

the access mode of the request(s)

to be canceled.

The

access mode is maximized with the access mode of the
Only those timer requests issued from an access
caller.
mode equal to or less privileged than the resultant
access mode are canceled.

Return Status Codes

SS$ NORMAL:

Service successfully completed.

Privilege Restrictions

Timer requests can be canceled only from access modes equal to or

more privileged than the access mode from which the requests were
issued.

Resources Required/Returned

Canceled timer requests are restored to the process's quota for
timer queue entries.

NOTE

Outstanding

timer

requests

automatically canceled at image exit.

9-49

are

VMS

Service

Macros

9.5.6

Use of the Timer Services
Timer requests made with the Set Timer service are queued.
That
is, they are ordered for processing according to their expiration
times.
The number of entries a process can have pending in this
timer queue is controlled by a quota.
Example

9-12

shows

how

second

delay

can

coded.

WAITIME:

. LONG

-10*1000*1000*309,-1

$SETIMR;S
BLBC

;

EFN=#36, DAYTIM=WAITIME

R@, ERROR

SWAITFR
S EFN=#36
BLBC

R@, ERROR

Example 9-12
the

delta

The

$SETIMR

service

The

SWAITFR

service

Control

then

Absolute

time

returns
is

DESCRIPTOR

BNOON:

.BLKQ

time

Second

Set

Branch

;

Wait

;

Branch

wait

time

timer.
if

error.

30 seconds.
if

error.

Delay

given

through

event
flag
number 36
delays
the
program until

<-—-

the

program.

Example

12:00:00.00>

TIMBUF=ANOON, TIMADR=BNOON

R@, ERROR

$SETIMR_S

the

MACRO

after 30
the
flag

.LONG

seconds.
is
set.

9-13.

$BINTIM_S
BLBC

;
;

sets

used

ANOON:

second

Use of the SETIMR Service to Create
a

Notice
that
directive.

;

ASCII

;

binary

noon
noon

;

Convert

;

Branch

;

entry mask

;
;

Check AST parameter.
Go to noon routine.

time.
if

error.

BLBC

DAYTIM=BNOON, ASTADR=ASTSERV, REQIDT=$#12
Rd3, ERROR
; Branch if error.

.WORD
CMPL
BEQL

)
#12,4 (AP)
10$

ASTSERV:

10$:

Service

VAX Diagnostic Design Guide

request.

noon

RET

Example 9-13

Use of the SETIMR Service to Call

an AST at an Absolute Time

In this example, the call to BINTIM converts the ASCII string
The value returned in
representing 12:00 noon to system format.
BNOON is used as input to the SETIMR system service.

The AST routine specified in the SETIMR request will be called
The REQIDT
when the timer expires, that is, at 12:00 noon.
The process continues
argument identifies the timer request.
execution. When the timer expires, it 1is interrupted by the
delivery of the AST. Note that if the current time of day is past
noon, the timer expires immediately.

This AST service routine checks the parameter passed by the REQIDT
argument and determines, in this example, that it must service the

When the AST service routine
12:00 noon timer request.
completed, the process continues execution at the point

|is
of

with

the

interruption.

You

could

following

cancel

code.

the

request

shown

Example

9-13

$SCANTIM S REQIDT=#12

FORMATTED ASCII OUTPUT SERVICE MACROS

9.6

wWwhen you wish to send a message to the operator from the
diagnostic program, some of the information in the message may be
variable strings or numerics. The formatted ASCII output system
services enable level 2, 2R, and 3 diagnostic programs to assemble
the complete message in the test code and place the text in a
buffer, before calling one of the print macros. This procedure may
be easier, in some cases, than assembling the message with the
print macro in the print routine. See the VAX/VMS System Services
Reference Manual for examples.
9.6.1

x Formatted ASCII Output
$FAO

The Formatted ASCII Output system service converts binary values
into ASCII characters and returns the converted characters in an
output string.

®
[

Insert

It can be used to:

example)

variable

character

string

into an output string.

data

(filename,

for

Convert binary values into the ASCII representations of
their decimal, hexadecimal, or octal equivalents and
substitute the results into an output string.

9-42

VMS

$FAO_xctrstr,
ctrstr

[outlen],

the

address

outbuf,
of

[pl],

character

[p2]...,

string

Service Macros

[pn]

descriptor

pointing

the control string.
The control string consists of
fixed text of the output string and FAO directives.

outlen

= the
the

outbuf

pn =

string

returned

the

that

count.

word

receive

the

actual

length of

returned.

this

Each

buffer.

parameters

the

directive,

inserted,

directive

corresponding

Status

SS$ NORMAL:

directive

Depending

Return

the address of a character string descriptor pointing
to the output buffer. The fully formatted output string

is
Pl

address
output

to
the

contained

may

the

parameter

length,

control

1longwords.

string

may

parameters.

value

argument
require

Codes

Service

successfully completed.

SS$ BUFFEROVF:

Service

output

overflowed

string

successfully
the

completed.

output

buffer,

The

formatted

and

has

been

truncated.

SS$ BADPARAM:
An
control string.

invalid

directive

was

specified

NOTES

The

$FAO
S macro

form

uses

PUSHL

instruction for all
parameters
(Pl
through
Pn)
coded
in
the
macro
instruction.
If
a
1literal
is
specified, it must be preceded with
a
number
sign
(#)
character
or
loaded into a register.

A maximum
specified

of 20 parameters
in
the
$FAO x

instruction.

parameters

are

The

FAO

system

service

can be
macro

than

required,

$FAOL
x macro.
3.

use

executes

20
the

the access mode of the caller and
does
not
check
whether
address
arguments are accessible before
it
executes.
Therefore,
an
access
violation
<causing
an
exception
condition occurs if an input field
cannot be read or, in some cases, if
an invalid length is specified.

the

FAO

VAX Diagnostic Design Guide

x Formatted ASCII Output with List Parameter
$FAOL
9.6.2
The Formatted ASCII Output with List Parameter macro provides an
system

input

specify

way

alternate

for

parameters

the

FAO

pointing

call

service.

x ctrstr,
$FAOL
the

control

text

fixed

string.

directives.

outlen =

character

address of

the

ctrstr =

[outlen], outbuf, prmlst

address of

the

the output string

The

string descriptor

control

the

output

word

returned.

string

receive

the

consists

the

and

conversion

actual

length of

the address of a character string descriptor pointing to
the output buffer. The fully formatted output string is

outbuf =

returned

the

prmlst =

used

in this buffer.

address

the

parameter

list

longwords

as Pl through Pn.

The parameter list may be a data structure that already
exists in a program and from which certain values are to
extracted.

Return Status

Same as for the FAO system service.

FAO Directives
9.6.3
An FAO directive has the format:
I1DD

(exclamation mark) indicates that the following character or
characters are to be interpreted as an FAO directive.

is a 1 character or 2 character code indicating the action
that FAO is to perform. Each directive may require one or
more input parameters on the call to FAO. Directives must be
specified

optionally,
A

using

uppercase letters.

a directive may include:
repeat

An output

count

field

length

VMS
A

repeat

count

coded

Service

Macros

follows:

In(DD)
where

n is a
directive for
An

output

decimal value indicating that FAO is
the specified number of parameters.

field

length

specified

repeat

the

place

the

follows:

!lengthDD
where

length

output

resulting

characters

the

A directive may
as shown below:

decimal

wvalue

from

directive

output

instructing
into

string.

contain

both

repeat

FAO

count

field

and

may

length

output

length,

In(lengthDD)
Repeat

counts

and

output

variables,

using

numeric

by
value.

parameter

passed

a
to

variable

will

only

have

output

one

the

place

the

field

1length,

the

1length

specified

an
count,

repeat

contain

parameter

specified

must

field

length

1lengths

sign)
specified
for

FAO

specified
for
an
output
contain the length value.

count,

field

(number

count.

length.

absolute
the

next
#

parameter

specified

required.

with

Each

must

repeat

output

string

9.6.4
An FAO

FAO Control String and Parameter Processing
control string may be any length and may contain any number
of FAO directives.
The only restriction
is on the use of the
!
character (ASCII code X'21')
in the control string. If a literal !
is required in the output string, the directive !! provides it.

When

FAO

processes

part

control

directive

string,

each

character

is
written
into
the output
encountered,
it is validated.
If it

FAO

consecutive
reads

number

parameters

past

call

the

parameters

from

arguments

has

the

argument

coded

end

the

list.

the

not

When
a
is not a valid
returns an error status code. If the
requires one or more parameters, the
specified are analyzed and processed.

directive is
directive, FAO terminates and
directive is valid, and if it
next

that

buffer.

argument

been
is

list.

passed.
list,

If
FAO

does

there
will

not

are

check

not

continue

your

responsibility,

FAO

directives

when

the

enough
reading

coding

a
FAO, to ensure that there are enough parameters to satisfy
requirements of all the directives in the control string.

Table

9-11

parameters

summarizes

required

the

each

directive.

and

1lists

the

VAX Diagnostic Design Guide

Table 9-11

Summary of FAO Directives

Character String Substitution

Directive|

Function

Parameters¥*

1AC

Insert a counted ASCII

Address of the string;

string.

the first byte must

contain

'AD

Insert an ASCII string.

! AF

Insert an ASCII string.

Replace all nonprintable

ASCII codes with periods

the

length.

1. Length of string

Address of

string

1. Length of string

2. Address of string

(O)o

'AS

Insert an ASCII string.

Address of quadword
character string
descriptor pointing
the string.

Numeric Conversion (zero—filled)

10B
1 OW

Convert a byte to octal.
Convert a word to octal.

Value to be converted to
ASCII representation.

Directive|

PFunction

Parameters¥*

10L

Convert a longword to octal.

I1XB

Convert a byte to
hexadecimal.
Convert a word to

LXW
XL

hexadecimal.
Convert a longword to

1ZB

" Convert an unsigned decimal

1ZW

Convert an unsigned decimal

1ZL

hexadecimal.

For byte or word
conversion, FAO uses only
the low-order byte or

word of the longword
parameter.

byte.

word.

Convert an unsigned decimal
longword.

Numeric Conversion (blank-filled)

1UB

Convert an unsigned decimal

1UW

Convert an unsigned decimal

byte.

word.

Convert an unsigned decimal
longword.

9-46

Value to be converted to
ASCII representation.

VMS

Table 9-11

Summary of

FAO

Directives

Directive | Function
1SB

Convert
byte.
Convert
word.

ISW
!SL

Output
'/
!

Parameters*
a

signed

decimal

For byte or
conversion,

word
FAO uses only
the low-order byte or
word of the longword

|
signed

decimal

Convert a
longword.

signed

decimal

parameter.

(CR/LF)

None

Formatting

Insert

new

line

Insert

an exclamation mark.

1%S

Insert 'S' if most recently
converted numeric value is
not

'$T

tab.

form feed.

Insert

the

system

time.

Address

value

13D

Macros

(Cont)

String

Service

Insert
time.

the

system date

and

ASCII. 1f 0
the current
is

Directive | Function

quadword

converted

to
is specified,
system time

used.

- Parameters*

' n<

Define

output

field

width

of "n" characters. Format
all data and directives

None

within delimiters, <and>,
left-justified and blankfilled within the field.
In*c

Repeat

the
Parameter

string

None

times

Interpretation

Skip

the

list.

variable

last

parameter

in
None

repeat

is
specified
with
a
and/or
length
must

directive.

character

output

Reuse the
the list.

the

parameter

count

and/or

directive,
precede

None

variable output

parameters

other

field

indicating

parameters

length

the

required

count

the

VAX Diagnostic Design Guide
MEMORY MANAGEMENT SERVICE MACROS

9.7

The Set Protection on Pages system service allows an image running
in a process to change the protection on a page or range of pages.

x inadr, [retadr], [acmode], prot, [prvprt]
$SETPRT
inadr

address

the

array

2-longword

containing

the

starting and ending virtual addresses of the pages on
1If the starting and
which protection is to be changed.

ending virtual addresses are the same, a single page is
Only the virtual page number portion of the
changed.
The 1low-order 9 bits are
virtual address is used.
ignored.

retadr =

the address of a 2-longword array to receive the
starting and ending virtual addresses of the pages that

have had their protection changed.

acmode =

the access mode on behalf of which the request is being

The specified access mode is maximized with the
made.
The resultant access mode
access mode of the caller.
must be equal to or more privileged than the access mode
of the owner of each page in order to change the
protection.

prot

the new protection specified in bits @ through 3 in the
The high-order
format of the hardware page protection.
defining the
names
Symbolic
28 bits are ignored.
specified as
If
protection codes are listed in Note 2.
the default access of kernel read-only is used.

prvprt =

the

address

byte

receive

the

protection

previously assigned to the last page whose protection
This argument is useful only when
was changed.

protection for a single page is being changed.
Return Status Codes

SS$ NORMAL:

Service successfully completed.

SS$ ACCVIO: 1. The input address array cannot be read by the
2. The output address array or the byte to receive the
caller.
3. An
previous protection cannot be written by the caller.
page.
ent
nonexist
a
of
attempt was made to change the protection

SS$ EXQUOTA: The process exceeded its paging file gquota while
changing a page in a read-only private section to a read/write
page.

SS$ IVPROTECT:

of T or

The specified protection code has a numeric value

is greater than 15

(decimal).

SS$ LENVIO: A page in the specified range is beyond the end of the
program or control

region.

VMS

SSS_NOPRIVE:
address

SS$ PAGOWNVIO:
change

page

the

specified

space.

the

Page

protection

owner
on a

Restrictions

For

pages

global

the accessibility of
owner of the page.

the

Macros

system

violation.
An
attempt
was
made
to
owned by a more privileged access

page

mode.

Privilege

range

Service

sections,

the

new

the

for

modes

page

protection

less

can

alter

privileged

than

only

the

NOTES
If
an
error
occurs
while
changing
page
protection,
the
return
array,

if
requested,
indicates
the
pages
that
were
successfully
changed

before

the

pages

have

longwords
array

error
1in

contain

Hardware

occurred.

been

the
a

affected,

return

both

address

-1.

protection

code

symbols:

Symbol

Meaning

PRTSC_NA
PRTSC_KR
PRTSC_KW
PRT$C_ER
PRT$C_EW
PRTSC_SR
PRT$C_SW
PRTSC_UR

No access
Kernel read only
Kernel write
Executive read only
Executive write
Supervisor read only
Supervisor write
User read only

PRT$SC_UW

User write

PRTSC_ERKW
PRTSC SRKW

Executive read; kernel write
Supervisor read; kernel write

Supervisor

PRTSC_URKW
PRTSC_UREW
PRT$C_URSW

read;

User
User
User

kernel write
executive write
supervisor write

PRT$C_SREW

These

symbols

are

read;
read;
read;

defined

executive write

by $PRTDEF.

9.8
HIBERNATE AND WAKE SERVICE MACROS
A diagnostic program can place itself in a

Hibernate

system service.

This

useful

programs

that

magnetic

media

simultaneously
started,

the

test

the

(in parallel).
After
program can hibernate.

the

wait state with the
feature for diagnostic
on

several

transfers

have

devices
all

been

VAX Diagnostic Design Guide

The

wait

state

can

(asynchronous

system

wake

itself

execution,

however,

the

program

interrupted

When

trap).

continues

AST

the

for

the

delivery

hibernation.

The

routine

service

AST

program

may,

routine

AST

completes

calling

Wake process system service.
Then, after the AST service
is completed, the program continues execution.
9.8.1.
$HIBER
x Hibernate
The Hibernate system service

allows

hibernating

Wake

process

the

routine

make

itself

the

process

inactive but to remain known to the system so that it can be
interrupted, for example, to receive ASTs.
A hibernate request is
a
wait-for-wake-event
request.
When a wake 1is
issued for
a
continues

process

execution

with

the

system

instruction

service,

following

the

call.

SHIBER
s

(no arguments)

Return Status Codes
SS$ NORMAL: Service successfully completed.
NOTES

A hibernating process can be swapped out
of the balance set if it is not locked
into

the

balance

set.

The
wait
state
caused
by
this
system
service can be interrupted by an AST if
(1) the access mode at which the AST is
to
execute
is
equal
to
or
more
privileged than the access mode from
which the hibernate
request was
issued
and (2) the process is enabled for ASTs
at

that

access

mode.

When the AST service routine completes
execution,
the system reexecutes the
HIBER system service
on
the
process's
behalf.
If
a
wakeup
request
has
been
issued

for

execution

the

process

AST

during

service

the

routine

(either
by itself or
another
process),
the process resumes execution. Otherwise,
it continues

to hibernate.

If one or more wakeup requests are issued
for
the
process
while
it
is
not
hibernating,
the
next
hibernate
call
returns

does

immediately.

not

maintained

That

hibernate.
of

is,

the

outstanding

requests.

9-59

process

count

1is

wakeup

Hibernate

VMS

9.8.2.

Service Macros

Only the _S macro
form is provided
the Hibernate system service.

for

SWAKE
x Wake

The Wake system service activates a process that has placed
in
a
state
of
hibernation
with
the
Hibernate
(HIBER)
service.
|

SWAKE
x

[pidadr],

pidadr

the

[prcnam]

address

the

identification
the

prcnam

address

the

neither

Return

wake

longword

the

containing

process

character

name

process

the

Status

process

qualified
wake.

specified,

itself
system

string

string.

group

number

for

the

process

awakened.

descriptor

The

identification

request

name

the

nor

process

pointing

implicitly

issuing

process

the

name

caller.

Codes

SS$ NORMAL:

Service

SS$ ACCVIO:

The process name string or string descriptor cannot
be
read,
or
the
process
identification cannot
be
written, by the caller.

SS$_IVLOGNAM:

The
or

SS$ _NONEXPR:

SS$ NOPRIV:

)

process

than

The

name

does

string

has

length

process

does

identification

not

have

process.

the

was

not

exist,

required

privilege

wake

wake:

Other processes in the same group (GROUP privilege)
Any other process in the system (WORLD privilege).
NOTE

one

wake

requests are issued
for
a
process
that
is
not
currently
hibernating,
a
subsequent
hibernate
request
will
be
completed
immediately.
That is, the process will not hibernate.
No
count
is
maintained
of
outstanding

wakeup

requests.

specified.

Restrictions

are

characters.

specified

process

specified

privileges
®

invalid

The

Privilege

specified
has

Warning.
an

User

successfully completed.

the

VAX Diagnostic Design Guide

UNWIND SERVICE MACRO

9.9

stack to change
A condition handler routine may unwind the call
problem. The
the flow of execution, if it cannot handle a given to
be removed
handler may specify a depth to which call frames are
s
from the stack. In addition, it may specify a new return addres
has
frame
to alter the flow of execution when the topmost call
been unwound.

[newpc]

x [depadr],
SUNWIND

depadr

the address of a longword indicating the depth to which

the stack is to be unwound. A depth of @ indicates the
call frame that was active when the condition occurred,
1 indicates the caller of that frame, 2 indicates the
caller of the caller of the frame, and so on. If depth
is specified as @ or less, no unwind occurs. If no
address is specified, the unwind is performed to the
caller of the frame that established the condition
handler.

newpc

the

address

complete.

to be given

control

when

the

unwind

Return Status Codes

SS$ NORMAL:

SS$ ACCVIO:

Service successfully completed.

The call stack is not accessible to the caller.

This condition is detected when the call stack is
scanned to modify the return address.

SSS_INSFRAME:
SS$ NOSIGNAL:

There are insufficient call frames to unwind to the

specified depth.

signal

condition.

for

1is currently active

SS$_UNWINDING: An unwind is already in progress.

The

actual

immediately.

NOTE

unwind

Rather,

not

the

performed

return

addresses in the call stack are modified
so that when the condition handler
returns, the unwind procedure is called
from each frame that is being unwound.

9-52

exception

DIAGNOSTIC

This chapter

diagnostic

lists all

programs,

the

macros

are

available to one or

can

the

descriptions.

the macros available to

in alphabetical order.

used

all

program

CHAPTER 190
DICTIONARY

SYSTEM MACRO

levels.

level

However,
Those

two program levels only are

2R,

and

not all of

macros

that

identified

For example, most of the VMS system service macros are available
only to level 2 and 2R diagnostic programs, and the supervisor
channel

service

macros

are

available

only

level

diagnostic

programs.

The

supervisor

service macros

take

the

form $DS xxxx x.

The

$DS

prefix signifies the diagnostic supervisor. The suffix,
x, shows
that the macro may end in any of four ways, depending on the
function

required.
_L -- generate an argument list
_DEF -- generate symbols and offsets
S -- call the service with CALLS
G -- call the service with CALLG

The utility macros

supervisor

diagnostic

take

service

supervisor.

the

form $DS xxxx.

The

lack

macros,

the

3$DS_
a

in the case of

prefix

suffix

signifies

indicates

that

the

the
the

macro is a utility macro. Some of the utility macros call routines
in the supervisor, while others merely generate in-line code.
Status codes,

however,

are never

returned.

The VMS system service macros take the

signifies

macro may end

a WS system service.
in any of

four ways.

form $xxxx. The prefix,

The _x suffix shows that the
(this corresponds to _L in

blank -

generate an argument list

_DEF -

generate symbols and offsets

S -

call the service with CALLS

G -

call the service with CALLG

the

supervisor

service macros)

Most of the supervisor services and the WS system services return
status codes in R@. The program should check the contents of R0
following one of these macros calls, in order to determine whether
the

service was completed

successfully.

Arguments enclosed in square brackets are optional.

For detailed background information on the macros and for
explanations of how to code the macros, refer to Chapters 7, 8,
and 9 of

this manual.

VAX Diagnostic Design Guide
x Assign I/0 Channel
$ASSIGN

10.1

x is a VMS system service macro available only to level 2
$ASSIGN
and 2R diagnostic programs. A level 2 or 2R program must assign a
channel to a peripheral device before the program can perform any
input or output operation on the device. The SASSIGN_x macro calls
a VMS service that assigns a channel and a channel number to a
device. This channel provides a path between the program and the
device. In addition, you can use the $SASSIGN x macro to establish
a logical 1link with a remote node in a network in 1level 2R
|

programs.

x devnam, chan,
$ASSIGN

the

devnam

address

the

points

[mbxnam]

[acmode],

a character string descriptor that
device name string. The string may be

either a physical device name or a logical name.

If the

first character in the string is an underscore ( ), the
service treats the name as a physical device name.
of
level
the service performs a single
Otherwise,
logical name translation and uses the equivalence name,
there

chan

acmode

any.

the

address

the

access mode

word

receive

the

that the service assigns to the device.
to be associated with

channel
the

number

channel.

The

service maximizes the specified access mode with the
I/0 operations on the
access mode of the caller.
from equal and more
only
channel can be performed
privileged

access

modes.

Kernel mode = @
Executive mode = 1
Supervisor mode = 2
User mode = 3

mbxnam =

the address of the character string descriptor pointing
to the 1logical name string for the mailbox to be
associated with the device, if there is a mailbox. The
mailbox receives status information from the device
driver.

Return

Status Codes

SS$ NORMAL:

Service successfully completed.

SS$ REMOTE:

Service

established with

the

successfully

completed.

target on a

remote node.

logical

1link

was

SS$ ACCVIO: The device or mailbox name string or string descriptor
cannot be read, or the channel number cannot be written, by the
caller

(access violation).

19-2

Diagnostic

SS$_DEVALLOC:

Warning:

the

SSS_DEVNOTMBX: A mailbox
is not a mailbox.
SS$_EXQUOTA:

device

name

has

System Macro Dictionary

allocated

been

specified

another

for

process.

device

that

The
process has
control block.

target of the assignment is on a remote node and
insufficient buffer quota to allocate a network

SSS_INSFMEM:

target

the

there

The

insufficient

the

assignment

system

dynamic

memory

request.

remote
to

node,

and

complete

the

SS$ _IVDEVNAM:
mailbox
Connect

No
device
name
was
specified,
or
the
device
or
name string contains invalid characters.
Or,
the Network
Block has an invalid format.

SS$_IVLOGNAM: The device or mailbox
has more than 63 characters.

SS$_NOIOCHAN:

I/O

channel

SS$ NOPRIV:
The
process
network operations.
SS$ NOSUCHDEV:

SS$_NOLINKS:

SS$ NOSUCHNODE:
unavailable.

The

does

specified

logical

The

name

string

available

for

have

the

device

mailbox

links

specified

are

The
network
connect
was
Services
Protocol)
or
the
partner on
target image exited before the connect

privilege

does

not

node

Channels
on

can

remote

For

devices

details

how
to
use
ASSIGN
in
conjunction
with
network operations,
see
the
VAX-11
2.

Only

DECnet User's Guide.
the

owner

device

can

associate a mailbox with the device
(the owner is the process that has
allocated
the
device,
either
implicitly or explicitly). Then the
device
driver
can
send
messages
containing status information to the
mailbox, as in the following cases:
@

the

message

device
may

19-3

perform

exist.

rejected
by
NSP
(Network
the
remote node.
Or,
the
confirm could be issued.

assigned

systems.

nonexistent

NOTES

length

available.

network

SS$_REJECT:

assignment.

not

network

has

terminal,

indicate

dialup,

VAX Diagnostic Design Guide
the
or
hangup,
unsolicited input.

reception

If the target is on a network,
the
message
may
indicate
the
network connect or initiate,
or
whether the line is down.

If the device is a line printer,
the message may indicate that the
printer is off-line.

For
and

details on the message
format
the information returned, refer

to the VAX/VMS I/0 User's Guide.

Channels remain assigned until they
are explicitly deassigned with the

deassign I/0 channel (DASSGN) system
that
image
the
until
or
service,
assigned the channel exits.

The ASSIGN service establishes a
path to a device, but does not check

actually
can
caller
the
whether
perform
1I/0
operations
to
the
device. Privilege and protection
restrictions may be applied by the
device drivers. For details on how
the
system
controls
access
to

refer

devices,

User's Guide.
19.2

VAX/VMS 1I/0

the

$BINTIM
x Convert an ASCII String to Binary Time

It calls a service that
SBINTIM x is a VMS system service macro.
converts an ASCII string to an absolute time value or a delta time
value in 64-bit system format. This format is suitable for input
to

(SETTIMR)

the Set Timer

x timbuf,
$BINTIM

system service.

timadr

timbuf

the address of the character string descriptor pointing
to the absolute or delta time value to be converted. The
ASCII string value must be in one of the formats shown
in the following note.

timadr

the
address
of
a
quadword
that
converted time in 64-bit format.

Return

Status

SS$ NORMAL:

receive

the

successfully completed.

SS$ IVTIME:

The

component

time

Codes

Service

the

1is

syntax

the

out

specified
range.

10-4

ASCII

string

invalid,

Diagnostic

Dictionary

NOTE

The
the

required ASCII
input
strings
have
following
formats:
Absolute
Time:

dd-mm-yyyy hh:mm:ss.cc,
dddd hh:mm:ss.cc.

16.3

System Macro

$CANCEL
x Cancel

Delta

Time:

I/0 on Channel

SCANCEL
_x is a VMS system service macro

available only to

and 2R diagnostic programs.
It calls a
cancels
all
pending
I/O
requests
on
general,
this includes all I/O requests
as those that are currently in progress.

WS service routine that
a
specific
channel.
1In
that are queued, as well

level

$CANCEL_x chan
chan

the

number

which
Return

I/0

Status

Service

SS$_EXQUOTA:

The

this

the

context,
Unibus

SS$_INSFMEM:
cancel

with

the

I/O

channel
canceled.

the

device

for

successfully completed.

process
direct

channel

has

I/0

and

exceeded

refers

the

system

invalid

channel

has

was

of
available.

SS$ _NOPRIV:
from a more

The specified channel is
privileged access mode.

quota
of

the

number

larger

memory

disabled

(SETRWM)

number

its
use

dynamic

process

Set Resource Wait Mode

for

direct

data

I/0.
path

adapter.

Insufficient
I/0,

SS$_IVCHAN:

assigned

Codes

SS$_NORMAL:

the

system

specified,
than

the

available

resource

wait

mode

service.

that
number

is,

channel

channels

or was

assigned

Restrictions
I/0 can be canceled only from an access mode equal to
privileged than the access mode from which the original

or more
channel

not assigned,

Privilege

assignment

was

made.

NOTES

When a request currently in progress
is canceled, the driver is notified
immediately. Actual cancellation may
or

may

not

occur

depending
on
the
the driver.
When
occur,

for
a.

the
queued

The

immediately,

1logical
state of
cancellation does
same action as that taken
requests is performed.

specified

event

19-5

flag

set.

VAX Diagnostic Design Guide
b.

The first word of the
if specified,
block,
SS$ CANCEL.

I/O status
is set to

The AST,

is queued.

Proper

if specified,

between

synchronization

this

service and the actual canceling of
issuing
I/0 requests requires the
process to wait for I/O completion
in the normal manner and then to
note that the I/0 has been canceled.

I1/0

the

I/0

operation

involving

tape ancillary control

virtual

disk

process,

the

I/0 cannot be canceled. In the case
however,
tape,
magnetic
a
of
cancellation may occur if the device
driver

is hung.

are
requests
I1/0
Outstanding
image
at
canceled
automatically
exit.

x Cancel Timer Request
SCANTIM

10.4

It calls a VMS service
x is a VMS system service macro.
$CANTIM
that cancels all or a selected subset of the Set Timer requests
previously issued by the current image executing in a process.

Cancellation is based on the request identification specified in
Timer

the

Set

all

canceled.

(SETIMR)

system

service.

than

request has been given the same request identification,

one

timer

they are

[acmode]

x
$CANTIM

[reqidt],

reqidt =

the request identification of the timer request(s) to be
canceled. A value of @ (the default) indicates that all
timer requests are to be canceled.

acmode =

the access mode of the

request(s)

to be canceled.

The

access mode is maximized with the access mode of the
caller. Only those timer requests issued from an access
mode equal to or less privileged than the resultant
access mode are canceled.

Return Status Codes

SS$ NORMAL: Service successfully completed.

Privilege Restrictions

Timer requests can be canceled only from access modes equal to or
more privileged than the access mode from which the requests were
issued.

10-6

Diagnostic

Resources

Required/Returned

Canceled

timer

requests
entries.

queue

are

restored

System Macro Dictionary

the

process's

quota

for

NOTE

Outstanding

timer

requests
are
at image exit.

automatically canceled
16.5

$CLREF
x Clear

$CLREF
_x

that

clears

VMS

Event

system

event

flag.

Flag

service

macro.

calls

VMS

service

$CLREF_x efn
efn

Return

the

number

Status

the

event

flag

cleared.

Codes

SS$_WASCLR:
Service
successfully
flag was previously #@.

completed.

The

specified

event

SS$_WASSET:

completed.

The

specified

event

flag

was

Service

previously

SS$_ILLEFC:

SSS_UNASEFC:
containing

the

successfully

illegal
The

event

process

specified

flag
1is

event

number

not
flag.

19-7

was

specified.

associated

with

the

cluster

VAX Diagnostic Design Guide

10.6

$DASSGN_x Deassign I/O Channel

_x is a VMS system service macro available only to level 2
SDASSGN

and 2R diagnostic programs. It calls a VMS service that releases
an I/0 channel acquired for I/O with the Assign Channel system
service.

x chan
$DASSGN

chan =

the number of the I/0 channel to be deassigned.

Return Status Codes

SS$ NORMAL: Service successfully completed.

SS$ IVCHAN: An invalid channel number was specified; that is, a
channel number of @ or a number larger than the number of channels
available.

SSS_NOPRIV: The specified channel is not assigned, or was assigned
from a more privileged access mode.

Privilege Restrictions

to
An I/0 channel can be deassigned only from an access mode equal al

or more privileged than the access mode from which the origin
channel assignment was made.

When

NOTES

the file is closed.

1If a mailbox was associated with the
was
channel
the
when
device
assigned,

channels

the

and

there

assigned

1linkage

cleared.

any

outstanding I/0 requests on the
channel are canceled. If a file has
specified
the
on
opened
been
channel,

deassigned,

channel

the

are

the

mailbox,

mailbox

If the I/O channel was assigned for
a network operation, the network
link

disconnected.

For

information on channel assignment
network
for
deassignment
and
operations, refer to the VAX-11

DECnet User's Guide.

1If the specified channel is the last
channel assigned to a device that
has been marked for dismounting, the
device is dismounted.

I/0

channels

are

automatically

deassigned at image exit.
10-8

Diagnostic System Macro

16.7
S$SDEF
Define Some
SDEF sym, alloc, siz

Sym

Field Within a Data

Dictionary

Structure

the name of the symbol.to be defined.

alloc

an
be

assembler
used:

directive

1nd1cat1ng
:

blocks

the

block

size

.BLKB

. BLKW
.BLKL

siz

Return

Use

the

Status

number

Codes:

Not

allocated.

Applicable.

this structure definition utility macro to generate
the symbols given in a P-table data structure.

for

190.8

offset

SDEFEND Finish Definitions

$DEFEND struc, gbl
struc

the

gbl

GLOBAL or

Return

Status

Use

this

structure

for

structure

the

19.9

definition

stucture

S$DEFINI

the

name

the

Ptable)

clean

Not Applicable.

structure

data

(e.g.,

LOCAL

Codes:

P-table

name

utility

macro

after

all

definition

have

been

process
defined.

Start a

Data

Structure

$DEFINI struc, gbl,

dot

the

struc

the structure name (e.g., the name of the P-table).

gbl

GLOBAL or

LOCAL.

dot

the value

Return Status Codes:
Use
this
structure

definition

10.10

the

first

P-table

data

$DS_ABORT Abort

the argument
an

abort

the

supplied

macro

message

the

program's cleanup code,
and
routine in the supervisor.

the

RET,

be generated.

macro

start

the

structure.

Program

calls

Not Applicable.
definition
utility

$DS_ABORT is a utility macro.

PROGRAM,

symbol

the

symbols

Test

The function of the macro depends on

the

programmer.

routine

operator's
then

the

supervisor

terminal,

transfers

control

argument
that

executes
to

argument is TEST, the macro merely clears R@# and
to call the dispatcher and start the next test.

18-9

1is

prints

the

then

the
BEGIN

does

VAX Diagnostic Design Guide
$DS_ABORT

[arg]

arg

the level of abort

PROGRAM

Execute clean up code and return to command mode.

(PROGRAM or TEST).

Terminate current test and proceed to the next test.

TEST

Default

Return Status Codes:
18.11

NOTE
arg = PROGRAM.

Not Applicable.

$DS_ASKADR_x Ask Operator for an Address

It calls a supervisor

_x is a supervisor service macro.
$DS ASKADR

routine that displays a prompt message on the operator's terminal,
asking the operator for an address. The service accepts an ASCII

numeric address string, checks whether or not it is within an
acceptable range, and stores the address in a user-specified
'

longword.

$DS_ASKADR
x msgadr,

datadr,

[radix],

[lolim],

[hilim],

[defalt],

[unused],

[exword]

msgadr =

the address of a counted ASCII string used as a prompt.

datadr =

the

longword

that

PAR$_OCT,

PAR$ _DEC,

address

the

receive

will

response.

radix

PAR$ BIN,

lolim

the minimum acceptable numeric response. Default value =

PARS_HEX.

the

default

radix,

hilim

defalt =
unused =

exword =

the maximum agfeptable numeric

+maximum, + (2

the value

response.

to use if the operator gives a

Default value =

reserved

-1).

Default value

null

response.

for expansion.

the

exception mask.

may

PARS NODEF means

that

there

default. PARS ATDEF, PAR$ ALTO, and PARS$ ATHI cause the
parameters DEFALT, LOLIM, and HILIM to beinterpreted as
containing the addresses where the corresponding values
found,

instead

values.

10-10

containing

their

literal

Diagnostic System Macro Dictionary

Return

Status

DS$S NORMAL:

Codes

Service

successfully completed.

DSS;PROGERR: The number of arguments supplied is incorrect.
NOTES

Execution
program

this macro

abort

clear.

the

Prompt

the

flag

will

set,

ranges

printed

the prompt message.

radix

not

and

are

exception

defined

use
FAO
string.

prompt

flag

with

arguments

will

default

values

cause

Operator

and

The

mask

by $DS_PARDEF.

directives

the

10.12
$DS_ASKDATAx Ask the Operator for a Numeric Value
$DS_ASKDATA x is a superv1sor service macro. It calls a supervisor
service

routine

ensures

that

the

numeric string
if
necessary,
(mask)
.

prompts

value

the

operator

within

for a numeric
acceptable
range.

value
The

and

ASCII

that the operator returns is converted,
truncated
and
stored
in
a
caller-specified
variable
field

$DS_ASKDATA x

[defalt],

[unused],

msgadr,

datadr,

msgadr

the

address

datadr

the

[exword]

address

[radix],

counted

([mask],

ASCII

[lolim],

([hilim],

string

used

1longword

that

will

receive

PAR$ DEC,

prompt.

the

response.

radix

PAR$ _BIN,

mask

the

lolim

bit

mask

the minimum

-max1mum,
hilim

defalt =

unused

PAR$_OCT,

PARS_HEX.

the

indicating

agfeptable

field

the

position

default

and

radix,

size.

numeric

response.

Default value

numeric

response.

Default

-(277).

maximum

agfeptable

+maximum,

+(2°"-1).

the

value

Default

value

reserved

for

use
=

the

operator

expansion.

10-11

gives

null

value

response.

VAX Diagnostic Design Guide
exword =

the

exception

default.

mask.

PAR$ NODEF

means

PARS ATDEF,

PARS_ALTO,

and

parameters DEFALT,

containing

may

values.

Return Status Codes
DS$ NORMAL: Service

DS$ PROGERR:
DS$ _TRUNCATE:
fit

the

found,

addresses

instead

PARS ATHI

value

where

the

cause

the

corresponding

containing

supplied

the

operator

NOTES

their

values

literal

invalid.
is

too

large

clear.

ranges
If the Prompt flag is set,
and default values will be printed
with

Execution of this macro will cause a
program abort if the Operator flag
is

1is

successfully completed.

specified buffer.

there

LOLIM, and HILIM to beinterpreted as

The value supplied by the operator
The

that

the prompt message.,

Truncation of left-most bits occurs
if a response is 1larger than the

mask.

mask
exception
and
radix
The
arguments are defined by $DS_PARDEF.

General

truncated,

19.13

not

converted

binary

value,

the

not

return.

use

contains

FAO

prompt string.

directives

the

$DS_ASKLGCL_x Ask the Operator for a Logical Response

$DS ASKLGCL X is a supervisor service macro. It calls a supervisor
service routine that prompts the operator for a logical response
to a specified gquestion. The service accepts an ASCII "yes" or
"ho" string, converts this to a single bit (flag), and stores the
information in a caller-specified bit within a caller-specified

byte.

x msgadr, datadr, [pos], [yexfer], [noxfer}), [defalt]
$DS_ASKLGCL
msgadr

the address of a counted ASCII string used as a prompt.

datadr

the address of a byte that will

19-12

receive the response.

Diagnostic

pos

the

bit

position

Default =

within

System Macro

DATADR.

Range

Dictionary

through

yexfer

the branch
meaning no

address
branch.

for

positive

response.

Default

3,
:

noxfer

the branch
meaning no

address
branch.

for

negative

response.

Default

defalt

PAR$_YES

Return

Status

Service

DS$_PROGERR:

The

PAR$ NO.

Codes

DS$_NORMAL:

caller,

too
incorrect.

successfully completed.

bit

large

position

number,

argument,
or

the

POS,

number

NOTES

Execution
of
program

is
2.

clear.

not

prompt

routine

accepts

strings.

the

use
FAO
string.

$DS_ASKSTR _x Ask

$DS_ASKSTR
x is a
service

the

supplied

cause

Operator

flag

If
the Prompt
flag
is
set,
ranges
and default values will be printed
with the prompt message.

16.14

arguments

this macro will

abort

specified

the

supervisor

directives

Operator

service

that

prompts

the

ASCII

string,

which

valid,

the

buffer.

string

in
o

for a

macro.

operator
is

String

It calls
for

checked

placed

the

against

supervisor

string

response.
a

1list

caller-specified

$DS_ASKSTR_x msgadr,

bufadr,

[maxlen],

[valtab]l,

msgadr

the

address

counted

ASCII

string

bufadr

the

address

counted

ASCII

buffer.

maxlen =
valtab =

[defadr]
used

prompt.

the maximum length of response string (does not.include
the
the

count

byte)
. Default

address

Default

meaning

72,

counted
that

19-13

1list

there

of
no

string
pointers.
validation table.

VAX Diagnostic Design Guide

defadr =

the address of a counted ASCII string to be used if the

operator

response.

null

gives

that there is no default string.

Default =

meaning

Return Status Codes

DS$ NORMAL: Service successfully completed.

DS$ PROGERR: The number of arguments supplied is incorrect.
DS$_TRUNCATE:

The

string

supplied

the

operator

been

has

truncated because it will not fit into the buffer supplied by the

program.

NOTES

Execution of this macro will cause a
program abort if the Operator flag
is clear.

and

the

flag

Prompt

values

default

will

with the prompt message.

set,

ranges

printed

If VALTAB = @, any string will
accepted without qualification.

If VALTAB not = @, Rl will return
the
into
value
1index
an
with
If the
validation table. Warning:

default

uses

program

the

and

operator selects <CR> only (a null
response), Rl will contain @.

not

FAO

use

prompt string.

directives

the

x Ask the Operator for a Numeric Value
$DS_ASKVLD

19.15

$DS_ASKVLD_x is a supervisor service macro. It calls a supervisor
service routine that prompts the operator for a numeric value. The
routine accepts an ASCII numeric string as input, converts the
determine
string, truncates the string if necessary, checks to stores
the
whether the value is within an acceptable range, and
value in a caller-specified variable field (position and size).
$DS ASKVLDx msgadr, datadr, [radix], [posl, I[sizel, ([lolim],
[hiTim], [defalt], [unused], [exword]

msgadr =

the address of a counted ASCII string used as a prompt,

datadr =

the

radix

longword

that

will

PARS$ OCT,

PARS_HEX,

the

address

receive

the

response.

PAR$ BIN,

PARS _DEC.

19-14

default

radix,

Diagnostic System Macro Dictionary

pos

the right-most
Default = 0.

size

the

lolim

number

the minimum

-maximum,
hilim

the

bit

the

bits

the

agfeptable

max1mum

agfeptable

+(2°7-1).

defalt

the

unused

reserved

value

the

for

numeric

response.

Default

value

the

operator

DS$

TRUNCATE:

PARS$ NODEF

means

PARS _ALTO,

and

null

response.

LOLIM, “and

HILIM

where

instead

the

that

there

PARS _ATHI
to

cause

be interpreted

corresponding

containing

their

the
as

values
1literal

successfully completed.

invalid

The

expansion.

found,

because

gives

mask.

Service
An

field.

PAR$_ATDEF,

Return Status Codes
PROGERR:

31.

value

the addresses

DS$

through

Default

DEFALT,

DSS NORMAL:

response.

parameters

be
values.

numeric

containing
may

truncated

use

exception

default.

range

-(277).

+maximum,

exword

field,

value

string
will

was

supplied

supplied
not

fit

into

the

operator

the

operator.

buffer

has

supplied

been
the

program.

NOTES

Execution of this macro will cause a
program abort if the Operator £flag
is clear.
If

the

Prompt

flag

and default values will
with the prompt message.

set,

ranges

printed

The
radix
and
exception
mask
arguments are defined by $DS_PARDEF.

not

prompt

use

FAO

directives

1in

the

string.

$DS_BCOMPLETE Branch on Complete
$DS BCOMPLETE is a utility macro. It generates

10.16

The program

low bit
previous

will

branch

the

address

of
RO is
set,
indicating
supervisor call.

10-15

code

specified

successful

that

tests

R0O.

LABEL,

the

completion

the

VAX Diagnostic Design Guide

$DS_BCOMPLETE label

the address

label =

Return Status Codes:
10.17

for

transfer of program control.

Not Applicable.

$DS_BERROR Branch on Error

$DS_BERROR is a utility macro. It generates code that causes a
branch to the address specified by LABEL, if the low bit of R@ is

clear,

indicating

error

condition

preceding

supervisor

call.

$DS_BERROR label

the address

label =

Return Status Codes:

for transfer of program control.

Not Applicable.

$DSBGNCLEAN Begin Cleanup Code Section

10.18

$DS |BGNCLEAN is a utility macro. This macro should be the first
statement in the cleanup code section of a diagnostic program. It
does not call a supervisor routine. It simply provides an entry
point to the cleanup code section.

$DS_BGNCLEAN [regmask],

the entry point register save mask.

regmask =

psect

[psect]

any legal arguments for the .PSECT directive.

Return Status Codes:

Not Applicable.
NOTE

Default

PSECT

arguments

<CLEANUP,

LONG>.

10.19

$DSBGNDATA Begin Data Section

$DS_BGNDATA is a utility macro. Use this macro at the beginning of

a test data section to provide a label. The macro does not call a

supervisor

routine.

$DS_BGNDATA

[align]

align =

the psect alignment.

Return Status Codes:

Not Applicable.
NOTE

The default ALIGN argument is PAGE.

10-16

Diagnostic System Macro Dictionary

10.20
$DS_BGNINIT Begin Initialize Code Section
$DS_BGNINIT is a utility macro. Use this macro at the

the initialization

in the diagnostic program to
routine. The macro does not call a

entry

point
routine,.

$DS_BGNINIT

[regmask],

the

entry

point

psect

any

legal

arguments

Status

provide

an
supervisor

[psect]

regmask

Return

beginning

routine

Codes:

Not

Default
LONG>.

PSECT

save

for

the

mask.

.PSECT

directive.

Applicable.
NOTE

arquments

<INITIALIZE,

190.21
$DS BGNMESSAGE Begin a Message
$DS_BGNMESSAGE is a utility macro. Use this macro
of

global

entry

mask.

error
It

does

message

not

call

routine.

supervisor

$DS_BGNMESSAGE

[regmask]

regmask =

entry

point

Codes:

Not

Applicable.

Return

the

Status

The

source

beginning
routine.

module

diagnostic

source

module.

$DS_BGNMOD env,

[test],

[subtest]

env

CEP_FUNCTIONAL,

program.

does

The

not

CEP_REPAIR,

test

the

number

the

first

test

subtest

the

number

the

first

subtest

Return

Status

Not

the

macro

call

this

module.

NOTES

Default

10-17

SUBTEST

the

supervisor

module.

this

$DSBGNMOD is absolutely required
every module.
Default

defines

SEP_FUNCTIONAL

beginning

Applicable.

TEST =
argument = 1.

beglnnlng

creates

save mask.

SEP_REPAIR.

Codes:

the

routine.

16.22
$DS_BGNMOD Begin a Program Module
$DS_BGNMOD is a Utlllty macro. Use this macro
each

macro

VAX Diagnostic Design Guide
$DS_BGNREG Begin a Device Register Storage Area

10.23

$DS_BGNREG is a utility macro. You should use the macro to define
an area in memory where information from device registers may be
stored and kept up to date. The macro provides a label, DEV_REG,

which identifies the first location in the area. It also defines
this

label

for

the $DS_HEADER macro.

supervisor

routine.

$DS_BGNREG

(no arguments)

Return Status Codes:

$DS_BGNREG does not call a

Not Applicable.

$DS_BGNSERV Begin Interrupt Service Routine
10.24
$DS BGNSERV is a utility macro. Use this macro to define an entry
point for an interrupt service routine. The macro also ensures
longword alignment, and pushes registers RO and R1 on the stack.
It does not call a supervisor routine.

$DS_BGNSERV label

label =

an identifying label for this routine.

Return Status Codes:

Not Applicable.

$DS BGNSTAT Begin Statistics Section
10.25
a utility macro. Use this macro to define an area
STAT'TS
$DS_BGN
in memory for each logical unit (LUN) being tested. The hardware

and software errors may be tabulated in this area. The macro does

not call a supervisor routine.

$DS_BGNSTAT (no arguments)
Return Status Codes:
16.26

Not Applicable.

$DS_BGNSUB Begin a Subtest

$DS BGNSUB is a utility macro. It calls a supervisor routine that
marks the beginning of a subtest. The routine ensures that the
diagnostic program is sequencing through its subtests in numerical
order. If the routine detects a sequencing error, it notifies the
operator and then returns control to the command mode.
$DS_BGNSUB (no arguments)

Return Status Codes:

10.27

Not Applicable.

$DS BGNSUMMARY Begin Summary Report Section

$DS BGNSUMMARY is a utility macro. Use this macro at the beginning
of the summary code section of a program to produce an entry mask
and a label (SUMMARY). The summary report routine can be called to

print a report based on information in the data and statistics
areas of the program. This macro does not call a supervisor
routine.

10-18

Diagnostic

$DS_BGNSUMMARY [regmask],

[psect]

regmask
~&egm
asx

the

entry

point

psect

any

legal

arguments

Return

Status

Codes:

Not

Default

$DS
a

test

notifies
macro

$DS_BGNTEST
section

supervisor

not

call

test

section

belongs

to
in

two

names

the

entry

align

the

boundary

and

$DS_BITDEF
gbl

Return

the

with

Not

This

SECTION

This

sections,
<

save

the

mask

and

routine.

The

name

test.

place

and

the

test

section

Separate

the

mask.

argument

macro also generates
the dispatch table.

Define

Bit Value

Mnemonics

#4.

PAGE.
entry

It defines the symbols BIT® through

corresponding

[gbl]
LOCAL.
Not

test

the

argument

utility macro.

Codes:

entry

NOTES

Status

beginning

Applicable.

default ALIGN

the

alignment.

The

GLOBAL

includes

masks

commas.

default

$DS_BITDEF

[align]

The

SDS_BITDEF is a

<SUMMARY,

macro

brackets,

directive.

produces

name(s).

point

this
It

that

single

Codes:

routine.

section

Status

.PSECT

beginning

the

regmask

BIT31

the

Program

__section

16.29

supervisor

[regmask],

names

Return

Use

Program.

[section],

mask.

Begin
a Test

utility macro.

diagnostic

the

does

the

NOTE
argquments

PSECT

$DS_BGNTEST

BGNTEST is

for

save

Applicable.

LONG>.

10.28

System Macro Dictionary

Applicable.

18-19

each

bit.

VAX Diagnostic Design Guide

16.39

$DS_BNCOMPLETE Branch on not Complete

$DS_BNCOMPLETE is a utility macro. It generates code to check the
low—-order bit of RO, in order to test for a failure in a previous
call to the supervisor. If bit @ is clear, a branch occurs. The

macro does not call a supervisor routine.
$DS_BNCOMPLETE label

label =

the address for transfer of program control.
Not Applicable.

Return Status Codes:
19.31

$DS_BNERROR Branch on not in Error

$DS_BNERROR 1is a utility macro.
low-order bit of RO, in order

It generates code to check the
to test for the success of a

previous call to the supervisor. If bit @ is set, a branch occurs.

The macro does not call a supervisor routine.
$DS_BNERROR label

label =

the address for transfer of program control.
Not Applicable.

Return Status Codes:

10.32

$DS_BNOPER Branch if no Operator Present

$DS BNOPER is a utility macro. It generates code that checks the
t,
status of the Operator control flag. If no operator is presen
the
by
ied
specif
s
addres
the
to
the macro causes a branch
programmer. No supervisor routine is called by this macro.
$DS_BNOPER label

label =

the address for transfer of program control.

Return Status Codes:

10.33

Not Applicable.

$DS_BNPASS@ Branch if not in Pass Zero

the
$DS BNPASS@# is a utility macro. It generates code that tests
the
in
on
lizati
initia
m
progra
status of a one-time switch used for
the
ted,
comple
been
y
alread
has
initialization section. If pass @

macro causes a branch to the address specified by the programmer.
No supervisor routine is called by the macro.
$DS_BNPASS@# label

label =

the address for transfer of program control.

Return Status Codes:

This

Not Applicable.

macro

NOTE

valid

initialization section.

10-20

only

the

Diagnostic System Macro Dictionary

10.34
$DS_BNQUICK Branch if not in Quick Mode
|
$DS BNQUICK is a
utility macro.
The
macro
generates
code
that
checks the status of the Quick control flag. If the flag is not
set, control passes to the address specified
supervisor routine is called by the macro.

the

programmer.

$DS_BNQUICK label
label

the

address

Return

Status

Codes:

16.35

$DS

$DS BOPER

status
passes

not

call

the
the

transfer

Not

utility

program

control.

Applicable.

BOPER Branch

is
a

of
to

for

Operator

macro.

Present

generates

code

Operator control flag.
If the flag
address specified by the operator.

supervisor

that

checks

the

is set, control
This macro does

routine.

$DS_BOPER 1label
label

Return

19.36

the

address

Status

Codes:

for

transfer

Not

program

control.

Applicable.

SDS BPASS@ Branch

$DS BPASS@

in Pass

utility macro.

Zero

generates

code

that

checks

the

status of a one-time switch used for program initialization in the
initialization
section.
If
pass
0
has
not
been completed,
the
macro causes a branch to the address specified by the programmer.
No supervisor routine is called by the macro.

$DS_BPASS# label
label

the

address

Return Status Codes:

for

transfer

program

control.

Not Applicable.
NOTE

This
macro
1is
wvalid
initialization section.
10.37

$DS_BQUICK Branch

$DS BQUICK

utility

checks the
the
macro

status of
causes
a

programmer.

the

supervisor

address

Return Status Codes:

the

Quick Mode

The

macro

generates

code

the Quick control flag.
If the flag
branch
to
the
address
specified

$DS_BQUICK label
label

macro.

only

routine

called

transfer

program

the macro.

|
for

Not

Applicable.

19-21

control.

that

is set,
by
the

VAX Diagnostic Design Guide

$DS_BREAK Break in Diagnostic Program

19.38

a utility macro. It calls the DS$BREAK routine in the
$DS_BREAK is
supervisor. The DS$BREAK routine, in turn, checks the status of
the Control C flag. If the operator has typed Control C, setting
the flag, the routine inserts a breakpoint and passes control to
the command mode

$DS BREAK
priority

in the CLI.

used

loops.

primarily

call

no-op

for

tight,

high-

$DS_BREAK (no arguments)

Return Status Codes:
10.39

Not Applicable.

x Cancel Wait
$DS_CANWAIT

$DS CANWAIT X is a supervisor service macro. It calls a routine in
x
the supervisor that cancels the effect of a previous $DS_WAITMS

x macro
$DSWAITUS

invoking

the

x
S$WAKE

system

service

macro.

x (no arguments)
$DS_CANWAIT
Return Status Code

DS$ NORMAL: Service successfully completed.
NOTE

In general, you should use this macro in
interrupt service routines.

$DS_CFDEF Call Frame Definitions

10.490

$DS_CFDEF is a utility macro. It provides symbolic definitions for
call frame offsets from the frame pointer. It does not call a
routine in the supervisor.

$DS_CFDEF
gbl

[gbl]

GLOBAL or

LOCAL.

Return Status Codes:

Not Applicable.
NOTE

The defined symbols are:

CFSL ONCOND
CF$W_PSW
CFSW_MASK
CF$SL AP

Condition Handler
Processor Status Word
Register Mask
01d Argument Pointer

CFSL_PC

Return PC

CFS$L_FP

CF$L_REG

16.41

01d Frame Pointer
Saved Registers

x Channel Service
$DS_CHANNEL_

$DS CHANNEL_x is a supervisor service macro available to level 3
diagnostic programs only. It calls a supervisor routine that
10-22

Diagnostic

System Macro Dictionary

provides a channel adapter interface service. The service enables
a diagnostic program to exercise general control over the hardware
status of the channel adapter.

$DS_CHANNEL
x unit,
unit

func

func,

the

logical

the

function

[vecadr],

unit

[stsadr]

number.

code

specifying

performed.
The
code
1is
function argument should

the

operation

expressed
symbolically.
be preceded by a number

The
sign

(#)
.
vecadr

the

entry

point

interrupt
stsadr

address

occurs.

the

address

the

CHCS_STATUS

This

argument

CHCS ENINT

for

Required

interrupt

for

the

service

CHC$

ENINT

quadword

store

function

the

CHC$

ENINT

for

the

CHC$ STATUS

required

adapter

when

functions.

function.

status

for

function.
and

$DS_CHANNEL Functions
CHCS INITA
Return

Status

DS$ _NORMAL:

Initialize Channel Adapter

Code:

Service

successfully completed.

CHCS INITB
Return

Status

DS$_NORMAL:

Initialize device bus

Code:

Service

successfully completed.

CHCS_ABORT
Return

Status

Service

DS$ LOGIC:

Bit

ABORT did

CHCS$

Adapter

Codes:

DS$_NORMAL:

not

set/clear

clear

NORMAL:

the

failure.

Purge

Service

data

(MBA only)

DTABT

did

data

successfully

path specified

path

completed.

the

CHCS$ ENINT

(MBA).

last

This

function

$DS_SETMAP
X macro

Enable interrupts
Status

DS$ NORMAL:
DS$_IHWE:
was

set

(UBA only)

call.

Return

not

(MBA).

PURGE

DS$

abort

successfully completed.

Return Status Code:
purges

(UBA only)

found

Codes:

Service
Initial

before

DS$_LOGIC:

Bit

successfully completed.
hardware

the

error.

function was

set/clear

failure.

DS$_IVVECT:

Invalid

vector was

DS$_IVADDR:

Invalid

address

Enable

found

was

190-23

Adapter

error

condition

performed.

found

bit

failed

by $DS_SETVEC_x.
by

$DS_SETVEC
x.

set.

VAX Diagnostic Design Guide

DS$ NORMAL:
DS$S

Service successfully completed.

Initial

IHWE:

interrupts

Disable

CHCSDSINT
Return Status Codes:

error.

hardware

Adapter

was found before the function was performed.
DS$_LOGIC:
to

Bit

set/clear

error

condition

Interrupt enable bit failed

failure.

clear.

DS$_IVVECT:

Invalid vector was found by $DS_CLRVEC_X.
Clear

CHCS CLEAR

adapter

status

Return Status Codes:
DS$ NORMAL:

Service successfully completed.

Bit
DS$ LOGIC:
failed to clear.

set/clear

CHCS$ STATUS

failure.

One

Request

adapter

the

status

Return Status Code:
DS$ NORMAL:

Service successfully completed.
Set defeat parity

CHC$_ SETDFT
Return

Status

DS$ NORMAL:

(UBA only)

Code:

Service successfully completed.
Clear defeat parity (UBA only)

CHCS$ CLRDFT

Return Status Code:
DS$ NORMAL: Service successfully completed.
l.

The

NOTES

interrupt

(CHC$ ENINT)

enable

will

enable

function
adapter

interrupts and, in the case of the
After
interrupts.
device
UBA,
UBA
or
initialization
Unibus
perform a clear
initialization,
function before enabling interrupts.
Adapter status, returned in response

to the CHC$_STATUS function, is
stored in location spec1f1ed by the
argument STSADR, as shown in Note 3.
Returned status description: Two
longwords of status are returned for
function
status
request
each
(CHC$STATUS) of the CHANNEL service

with
along
status,
call. This
ainform
upt
interr
ic
specif
n
certai
all
on
ed
suppli
also
is
tion,
interrupts that are to be passed to

19-24

bits

Diagnostic

System Macro

Dictionary

program
which
has
a
enabled
interrupt
processing.
The
two
longwords
returned
have
the
following format.

status

STATUS

adapter

=
=
.

RVR

status

one

word

Note

receive

vector

interrupt
4.

Adapter

status

defined

interrupt

through
Status

the

Definition

CHS$M SYSERR
CHS$M_CHNERR

Channel

System

CHS$M DEVBUS
CHSS$M DEVTO
CHS$M_CHNDPE
CHS$M_CHNMPE
CHS$M_CHPFOT
CHS$M SYSMEM
CHS$M SYSSBI
CHS$M_MBAEXC
CHS$M MBANED
CHS$M_MBADTB
CHS$M_MBADTC
CHSSM_MBACPE
CHSSM MBAWCK

error
error

those

(STATUS

that

(category)
(category)

Program

error

Program

(category)

error

(hardware

error

Channel

detected)

Channel

error
memory parity error
power fail/overtemp

System memory error
SBI error
Massbus exception
MBA nonexistent drive
System

MBA

data

transfer

busy

MBA

data

transfer

complete

MBA

control

MBA

write

Bus
Bus

init clear (deassertion)
init (assertion)
power down

Any

error

Bus

parity

category

includes

Supervisor

Software Requirements Documentation

all

requirements

must

that

satisfied

brief

before the diagnostic program will yield valid results. For example, a level 3 Unibus device diagnostic program will provide a
useful test of that device only if the operator has verified the
correct operation of the central processor and the Unibus channel

adapter.

The

sufficient.

information

shown

Example

11-5

but

PREREQUISITES:

Functional VAX-11 Central Processor and Memory
Functional Unibus Channel
Example 11-5

11.1.6

Adapter

Prerequisities

Operating Instructions

Include in this category all instructions for loading and executing the diagnostic program. If the program can be loaded and run

on-line (under VMS) as well as off-line (standalone), show both
methods. Example 11-6 shows the operating instructions for the
disk

reliability

program.

11-4

Diagnostic Program Documentation

P
>>>BOOT

Type Control P.
Load and start
the diagnostic supervisor

SX@

DS>

ATTACH

DW780

SBI

DWg®

DS>

ATTACH

RK611

DW@

DMA

DS>

SELECT

DMA

DS>

RUN

from the floppy
disk drive.
4
! Attach the
777440 210 5

UBA,

link.

Attach the RK611.
Select the RK611.
Run the disk

ESRAA

reliability

program.

NOTE

Operator

Example

input

11-6

underlined.

Operating

11.1.7
Program Functional Description
This
section
of
the
documentation

following

information

Program

file

categories.

should

overview

Program

purpose

and

transportability
Program

Instructions.

strategy

size

.EXE file size
Program run timer

quick

verify
default
other modes
Run-time dynamics
e.g.

memory

allocation

other restrictions
Event flags used

Fault

requirements

detection
error

resolution

error

message

percentage

Performance

formats

possible

faults

during

hardware

failures

unsuspected

detected

traps

power failure
Sequence of testing

Program

on multiple

applications
field service

units

manufacturing
customers

How

engineering

Program

set

test

and

run

(and

subtest)

with

11-5

APT

and

APT-RD

descriptions

include

the

VAX Diagnostic Design Guide

n the functions
For each test (and subtest, if appropriate) explai
or should
operat
the
that
s
action
and
tested, possible failures,
of the
ption
descri
the
shows
11-7
e
Exampl
ion.
take on error detect
profirst test in the RK611-RK#6/RKP7 drive functional diagnostic

gram

(ESREF).

TEST

TEST DESCRIPTION:

This test will read the RKCS1 register and then test the UBA
status to verify that an error did not result from the read. If an
error is detected, the diagnostic will be aborted. This test's
primary function is to verify that the RK611 registers can be
accessed, without detection of an error on the UBA, before further
testing.

STEPS:

Issue adapter

init.

Report error and abort if init failed.
Clear

UBA

status.

Test for stuck UBA status error - abort if error.

[]

OO
N bW+

TEST

Read RKCS1.

Wait (stall execution)
Get

UBA

for approx. 70 microseconds.

status.

Test for UBA error - abort if error.

)

DEBUG:

If this test fails, the user should run the appropriate RK611 or

UBA diagnostic.

Example 11-7

Test Description

Notice that the test steps are listed in order. You should be able
to use material from the functional and design specifications when
you write the test descriptions for the documentation file.
E

MODULE PREFAC
11.2
The module preface is a documenting comment that should be placed
at the beginning of the source file of a module. Each line in the
should,
preface (except for 1linker and assembler directives)
in the
"!",
or
";"
ter,
therefore, begin with a comment delimi
es
provid
e
prefac
module
leftmost character position. The
in
certa
ins
conta
It
.
information for the program maintainer
and
control items (without a comment delimiter) that the 1linker
ght
copyri
L
DIGITA
rd
standa
the
assembler need, and it contains
ownership
statement needed for the protection of DIGITAL'S legal
have a
must
m
progra
stic
diagno
rights. While each module in a

preface, the preface for the first module is the most important.

11-6

Diagnostic

Program Documentation

contains

some
information
that
describes
the
program
as
a
as well as information specific to the first module.
Five
sections make up a module preface. Build the module prefaces from

whole,

the
diagnostic
Chapter 6.

program

templates

Linker

Assembler

Directives

and

shown

Example

6-1

statement
Environment statement
History
Module functional description
11.2.1
Linker and Assembler Directives
This section of the module preface contains four items as shown
in
Example
11-8.
Refer
to
Paragraph
6.2.1
of
Chapter
6
for
more
details.
.SBTTL

DZ11

LINE

ASYNC

MUX

TEST

.TITLE

DZ11

. IDENT

LINE

ASYNC

/V2.1-7/
HEADER, PAGE,

MUX

TEST

. PSECT

Example

11-8

Linker

in
11.2.2
The

statement

NOWRT

the

and Assembler
Module Preface

Directives

Statement

statement

furnished

should

the

identical

documentation

11.2.3
Environment Statement
The
environment
statement
1lists
assumptions that a module may make.

the

file.

any

special

environmental

For

level
2,
2R,
and
3
diagnostic
programs,
for
example,
the
run-time environment includes the diagnostic supervisor. A module
in a level 2R diagnostic program also assumes that
it
runs only

on-line
system

(under

traps

anything
out
environment.
The

VMS).

(ASTs)

are

the

module

disabled.

ordinary

might
In

that

the

first

module in a program should
(or
compile)
and
1ink
the
modules
given the source modules.
Example
sample

11-9

shows

diagnostic

the

commands

program

assume

general,

that

you

module

asynchronous

should

assumes

document

about

its

also

explain

assemble

into

executable

program,

required

assemble

written

language.

11-7

the

VAX-11

how

and

Macro

1link

assembly

VAX Diagnostic Design Guide

Assemble module 1 (header)

$ MACRO/LIS TESTM1

creating an OBJ file
and a LIS file.
Assemble module 2.

$ MACRO/LIS TESTM2

! Assemble the last module.

$ MACRO/LIS TESTMN

LINK/EXE:SAMPLE/CONTIGUOUS/MAP/FULL/SYSTEM:2@@ TESTM1,

TESTMZ,

... TESTMN

Link

the

assembled

modules creating an

EXE file called SAMPLE in
contiguous memory locations
starting

Example 11-9

at address

200.

Assemble and Link Commands Shown

in the Environment Statement

11.2.4

Program and Module Version Numbers

provides a unique
The VAX-11 standard version number softw
are. Whenever you
use
in-ho
AL
identification for all DIGIT
on number of the
versi
the
am,
progr
make a change to a completed
d reflect the
shoul
e
modul
ted
header module and of each affec
change.

The version number is a compound string constructed as follows:
<support><version>.<update>—<edit>

<support> is a single capital letter (or null) identifying the

support level of the program.

special customer version

field test version

\'/

released or frozen version

unsupported experimental version

Normally you can omit this letter from the modul.e identification,
since the letter reflects the program as a whole

Increment this number
<version> refers to major changes.bili
ty of the program.

if you change a function or capa
essed number. It
<version> is a decimal leading zero-supprment
at a time.
incre
one
starts with @ and progresses
release. 1
first
the
e
befor
Never skip a number. Use @
designates the first release, and so on.

11-8

Diagnostic

)

period
digit.

minor

changes.

present,

followed by a single decimal digit. Never skip
Null designates a major
change,
because <updat

cleared

first
°

refers

Program Documentation

when

update,

<edit>

and

identifies

but

any

may

changed.

designates

on.
alteration

is never
reset.
<edit>
is
decimal maintenance number,
be
skipped
number.

a
e>

never

a hyphen
starting

lower

the

source

the

code

and

sign
followed by a
with 1. Numbers may
than a previous edit

There

may be several edits in one release. For example
,
if three
software
problem
reports
(SPRs)
are
handled,
the
edit
number
should be increased by 3. The three changes should
then be identified
in
the maintenance histories of the affected modules.
Use
these edit numbers in the module maintenance history
.

The

preface

tion

NOTE
number given

version
is

the

module

the

program

identifica-

used

the

number

statement

also

shown

Example

.IDENT

11-8.

11.2.5
Module Maintenance History
When you modify an existing program module, assign
to
each
problem
addressed
(each
logical
unit
of

an edit number
modification).

After a release you may bump the edit number to a round number,
but this number should never be reset. Add a maintenance comment,
derived from the edit number, to each line of source code that is
affected. There are two good reasons for using edit comments.
1.

The

modifications

may

well

module.
The
the
places

maintenance comment
where
a
correction

problem

made.

was

This

distributed

All

too
often
it
innocently modify

over

the

you to find all
single
functional

of
a
especially useful

rection has to be further corrected
the original modifier and/or
if
it
by the field service engineer.
2.

all

enables

by someone
has to be

happens
that
as we
an instruction that

correct

was

the

cor-

other than
understood

bug
B,
we
correction

for a previous bug, A. Bug B is fixed at the expense of
the reappearance of bug A (or one of its relatives).
If
modification of a program leads you to the modification
of a line that already has a maintenance comment,
then
find
out
(from
the
detailed
current
history)
who
the
modifier was,
consult that person,
and exercise extreme
caution in effecting your modification.
In many

cases the edit numbers may be assigned consistently across
modules
in a program.
In this case,
the module defining
the
program's version number
should
have a
full maintenance history
and the others should include only module specific changes.
all

11-9

VAX Diagnostic Design Guide

Periodically,

old, detailed, current history log entries may be

deleted, together with their corresponding documenting comments
(and lines marked for deletion). Do not make the deletion until
the program has proven itself in the field.

Keep a history of the changes to each module in the module preface. the header module preface must reflect the history of the
Example 11-10 shows how a program history might
entire program.
look as documented in the preface to the header module.
First release,

me
N
Ne

bytes

in Test 5

CHAR BUF

31-DEC-83,

Jim Skunk

Major change,

vV2.1-4

Minor change, 12-JAN-84, Jim Skunk
-4 changed Test 46 Subtest 5 Error print out from

-3 added conversation mode

WS
we

added 2

Ted Bear

vV2.0-3

wme

22-MAR-79,

-1 fixed Unibus timeout
-2

Ted Bear

21-FEB-79,

First minor change,

vi.1l-2

; V1.0

"CSR"

"TCR"

Example 11-10

11.2.6

Module History

Module Functional Description

Group the routines and data structures that make up a diagnostic
program in modules according to their functions. For example, the
header module should contain global data, program/supervisor

interface

structures

such

the

header

macro,

and

the

initialization, cleanup, and summary routines. Global subroutines,
if they are large or many, should make up one or more separate
modules. The test routines should be grouped in modules according
to

common

elements.

Write the module functional description so that it describes the
common elements and the general purpose of the module. For
example, if module 3 of a program contains tests that check the
interface between the Massbus and a tape formatter, you should
explain this fact in the module functional description.
11.3

ROUTINE

PREFACE

Like the module preface, the routine preface is a documenting
comment included in a module source file. Begin the routine
preface with a begin sentinel, of the form ".++", Use an end
sentinel, of the form ";--" as the last line. Begin each line in
the text of the routine preface with a comment delimiter in the
leftmost character

position.

11-10

Diagnostic

Write

routine

preface

nostic program.
al subroutines,

For
and

for

each

example,
the test

routine

Program Documentation

each

module

diag-

the initialization routine, the globroutines should each be preceded with

a routine preface.
Example 11-11 shows a sample routine preface.
Paragraphs 11.3.1 and 11.3.2 provide a detailed discussion of the
different elements that make up the routine preface. Notice that
each
section
of
the
routine
preface
should
be
1labeled
with
a
keyword,

whether

not

and

write

contains

We
Wy WMo VI

any

text.

None

**"

there
on

logical

unit

Note
that
no
byte
determines the byte
then 528 bytes are

number

header and
is passed

count
is
specified;
count.
If the drive
transferred for each

number

cylinder

sectors

number

track

:
:

sector wvalue
logical unit

PUSHL

BUFFER_ADR

:
:

address which
header and

CALLS

#4 , READ

:
:

data
call

WO WE

WY W

WY Ve

NO_BLOCKS

CYLINDER,- (SP)

We W

PUSHL

MOVW

SECTORS,- (SP)
LUN

that

the drive
sequence.

drive under test is an RK@6, then 12 bytes per block are
transferred.
1If the drive under test is an RKO6 then only
headers in each block are read.
Calling Sequence:

TRACK, - (SP)

Input

The

HEADER

argument
of those

Implicit

* %

symbol

lists.
blocks.

QIOLIST

The

LUN

the

Inputs:
* %

Parameters:

None

Implicit

Outputs:
**

WS N N N

None

% %

Completion
RO=1 if no

WMe

RP=0

any

Codes:
errors
errors

are
are

base

creates
an

None

Output
* %

the

read

use

value
number

receive

information
routine

Parameters:

global

text,

the
number
of
blocks
under test is an RP#X,
block number.
If the

MOVB

VY N

1line

data command to
in the calling

MOVB
PUSHL

WMy MF

the

W WE

whose

WS Wy

Functional Description:
This routine issues a read

WE W

keyword

leave
the
follows.

detected.
detected.

11-11

address

implied

block

association

QIO

with

one

Side

Effects:
* %

None

Registers Used:
R@P=byte

count

Debug:

program.

If this routine fails,

run

the appropriate level 3 diagnostic

WNe

MNP

WE
Mg

block number

R4=DSKDC address
R8=sector
R9=track
Rl@=cylinder

R3=logical

We WMe

% %

VAX Diagnostic Design Guide

Example 11-11

11.3.1

Sample Routine Preface

Routine Functional Description

The routine functional description should explain the purpose of
the routine, necessary run-time conditions, and debug or test
procedures.

Explain the purpose of the routine according to what it does, not
how it does it. Describe the routine as if it were a large scale
instruction. Make the explanation clear and logical, so that the
casual reader can get a fairly accurate idea of what the routine
accomplishes

(Example 11-11).

If there are run-time conditions necessary to proper operation of
the routine, they will often involve assumptions that you should
state explicitly. Diagnostic programs should be designed to
operate in a hostile environment. Therefore, the programmer must
explain how the routine will behave if the required conditions are
not met, and he must provide debug or test instructions in the
routine

preface.

These

program maintainer

how

instructions

verify

will

the

tell

correct

the

operator

behavior

routine under a variety of possible circumstances.

the

For example, a test routine may require that a loopback cable be
installed on the device under test. The test routine should check
for the presence of this cable and abort if it is missing. This
point should be explained in the routine preface, together with
instructions for verifying whether or not the routine does abort

when the cable is not connected.

Of course, the debug instructions in the routine preface should
also explain how to verify correct operation of the routine when
run—time conditions are normal.

11-12

Diagnostic

11,3.2

Program Documentation

Routine Interface

Global
subroutines
perform generalized
always

called

global

subroutines

are
generally
called
from
within
functions. Unlike the test routines,

the

dispatch

can

routine

called

the

Calling
Input

supervisor,

different

variety of reasons. The routine preface for a
therefore, should specify the following items:

tests
to
which are

ways

global

and

the

for

a
subroutine,

sequence

parameters

Implicit
Output

inputs

parameters

Implicit

outputs

Completion codes
Side effects
Registers

11.3.2.1

Calling

used.

Sequence

the

routine
11-12.

routine
can

follows
called

the

with

standard
CALLS

sequence:
CALLS

Calling

“e

call
procedure,
then
the
CALLG, as shown 1in Example

CALLG

ENTRY NAME

(formal

parameters)

ENTRY NAME

(formal

parameter

Example
11.3.2.2

Input

and

11-12

Standard

Output

Calling

Parameters

The

list

name)

Sequence
input

parameters

that

the routine expects may be items in a table (a list) or items on
the stack. The input parameters statement should declare what the
parameters are. The argument pointer should p01nt to the longword
preceding the first parameter. Example 11-13 is taken from a print
routine preface.

ASCII

string

address

ASCII

name

address

4 (AP)=

-e

parameters:

8 (AP)=

Input

12 (AP)=

expected

data.

“e

;

16 (AP)=

received

data.

Example
If

the

called

calling

parameters.

buffer,

routine

routine,
For

you

the

1Input

values,

should

example,

should

11-13

returns

you

the

state

the

extended

addresses,

these

routine

address

11-13

message.

converted.

Parameters

document
called

error

strings

items

returns

(label)

and

as
a

string

size

the

output
of

the

VAX Diagnostic Design Guide

buffer. Then it should be clear that the calling routine should
access the buffer after the call
is completed. Notice that the
general registers (R1-R1ll) may be used for output parameters, as
shown

Example

11-14,

;

Output

parameters:

;

R2= Binary parameter

retrieved

Example

11-14

from operator,
Output

successful.

Parameters

11.3.2.3 Implicit Input and Output Parameters - In these sections
of the routine preface you should include all locations in global
or own (local) storage that are accessed by the routine. Implicit
inputs are locations that the routine reads. Implicit outputs are
locations that the routine writes. Be sure not to confuse these
items

input

and

output

parameters.

example:

Implicit

inputs:

DSSGA PBASE:

P-table base address,
P=direct addressing

«e

;
wg

For

with

Example 11-15

Implicit

Inputs

11.3.2.4 Completion Codes - Your routine preface should specify
all of the completion codes that the routine may return in RO to
the code's
indicate
each code
Opposite
program.
calling
the

meaning,
;

shown

Completion

RO=0

RP=1

any

[

11-16.

codes:

[

Example

errors are detected.
errors

Example

are detected.

11-16

Completion

Codes

11.3.2.5 Side Effects - Document here anything out of the ordinary

that the routine does to its environment. For example, the routine

some
situation under
strange
in a
hardware
the
leave
may
circumstances, jeopardizing the integrity of the operating system.

11.3.2.6 Register Usage - Under this heading, list the registers
used by the routine and the function to which each is applied.
11.4

COMMENTS

Use comments to make your program understandable to any reader.
The reader should be able to read the comments alone and get a
good understanding of what the program does.

11-14

Diagnostic

sense

there

are

two

programs

Program Documentation

written:

one

consisting

code, and one consisting of comments. Write the comment program to
describe the intent and algorithm of the code. That is, comments
are not simply rewordings of the code.
They are explanations of
the overall logical meaning of the code.
A

comment

any

text

embedded

between a comment delimiter on the
left and the end of the source line on the right.
In addition to
the module and routine prefaces, your program should provide three
types
of
comments:
block
comments,
group
comments,
and
1line

comments.

11.4.1
Block Comments
Use a block comment
to
strategy
allow

the

each

reader

The

block

page

comment

entered,

character

the

code

1left

The first line of the block
of the form ";+" or ";++".

The

body

the

block.

by
°

line

the

form

the

block

Separate

consisting

comment

;

This

—

’

block

and

should

without

block

text

comment

hav-

begin

(;

first

sentinel,

consists

text

describing

from

comment

delimiter

with

describes

the

matching

end

blank

line.

The

code

should

the

blank

Block

11-15

1line's

number

—

11-17

comment.

Example

delimiter

the

<skip>
++

";--",.

comment

the

comment

";-"

line.

;

function

code.

follows

tab.

that

the

The

aligned,

last

the

that

paragraph

lines.

position.

sentinel

describe

grouping

code. Notice that the code may be assembler
executable code. The following
rules apply

comment

wide

and

distinct

understand

ing to read the actual
directives as well as
to block comments:
°

introduce

logically

Comment

VAX Diagnostic Design Guide
11.4.2

Group Comments

Use a group comment whenever the attention of the reader should be
called to a particular sequence of code as shown in Example 11-18.
When several paths join, note the conditions which cause
the flow to reach this point.

wmy

All exceptions converge at
this point with:
...{register and stack status>

a loop.

looking for a handler to call

At the top of

When some data

base

has been built,

such as a

complex

At this point the stack has
the following format:
g0 (SP) = saved R2

g4 (SP)

= number of bytes...

WMo

sequence on the stack.

Example 11-18

Group Comments

The following rules apply to group comments:

The group comment consists of a number of page wide
comment lines: the comment delimiter is entered left
aligned, in the line's first character position.

The first and last lines of the group comment are comment
delimiters and are set off from surrounding code by a
blank line before and after the group. Both the blank
comment lines and the blank lines are mandatory and help
the reader to distinguish the comments and code visually.

The body of the group comment consists of descriptive
text, separated from the comment delimiter by a space.

Tabular

information

delimiter by a tab.

11-16

separated

from

the

comment

Diagnostic

Program Documentation

11.4.3
Use line
being

Line Comments
comments to explain the meaning and function
commented. For example, the instruction
MOVAL

should
area."
of

be
or
thumb,

comment

the

lines

A,B

commented ";
Initialize pointer to first buffer in free
such, not "; Move the address of A into B."
As a rule
symbols should not appear
in a comment.
Instead,
the

should

say

what

each

symbol

means.

Line comments can be connected so that they show the function of a
section of several lines of code. When they are used in this
way,
the
1line
comments
help
the
reader
to
follow
the
flow of
the

program.

Several

lines

one

lines

successive
connection

lines
by

<space>...".

comment

attached

All

which

case

lines

with

rules

apply

placed

statement.

may

follow-on

following

comment

comments

code,

tagging
The

The

may

the

one

line

code.

attached

several

you

can

comments
line

indicate
of

the

right-hand

side

language
comments
are
aligned
with
delimiter
in
column 41
of
the
text
(five
left margin).

the

statement

would

comments:

assembly

field,
line.

the

form

comment

from

normally

overflow

long

contained

comment

delimiter

and

the

into

the

the
tabs

comment

then it can be broken and continued on the next
Place
the
comment
on
the
second
1line
of
the

statement.

)

the

comment

too

single

line, or if the statement is too long to be commented on
the
same
1line,
then
the
comment
may
be
placed
(or
continued)
on
the
following
1line.
Place
the
comment
delimiter in column 41, as before.
®

Leave

the

space

between

the

comment.

11-17

text

VAX Diagnostic Design Guide

shows

some

uses of

STATEMENT
STATEMENT

the

LONG

LONGER

STATEMENT
STATEMENT

SOMEWHAT

A SOMEWHAT

wNe

Wme

STATEMENT

comment.

Compute multiple-line

function

Here we do something new
and extend the comment to
next two lines.

VERY VERY VERY
And

LONG STATEMENT
its comment on next

FRAGMENTED

STATEMENT

Example

11-19

the

And its comment
And its long comment
which continues on
additional line(s).

A VERY VERY VERY VERY
A

line

STATEMENT

11-19

Example

the

statement's

Line

11- 18

Comments

comment

line

CODING

Diagnostic

engineers

CHAPTER

CONVENTIONS

AND

12
PROCEDURES

should

organize all diagnostic programs in a
main-line code
in
the
test
routines
should
proceed
in functionally distinct steps. Many of
the functions can
be
broken
out
from
the
main
routine
and
coded
as
subroutines.
Proper
use
of
subroutines
should
reduce
the
size
of
the
object
code.
And,
if
you
make
all
subroutines
global,
they
can
be
assembled in a separate module. They can
then be made available to
other
modules
within
the
program
and
to
other
programs.
modular

fashion.

Asynchronous

interrupt

The

system

service

trap

(AST)

routines

routines,

should

also

condition

handlers,

global.

and

In addition,
proper organization of the program into functi
onally
distinct
steps
requires
that
error
reports
be
made
from
the
highest level
(the main-line code).
Error
reports
should not be
made
from subroutines,
interrupt service
routines,
AST
routines,
or condition handlers. Two important reason
s for restricting error
reports

the

highest

all

user

error

will

number

the

find

easily

the

test,

and

main-line

code,

subtest,

and

error

the

error

directly

subroutine

from

has

detected

user

error

message,

the

code

that

tests

failing

performs

useful

functions.

from

the

that

globally

come

failing

code

the

routine

the

However,

delivered

never

follow.

reports

find

message.

and

level

than

one
a

the

distinct

routine

may

fact

function.

function

that

the

only

performs

several

Subroutines

should deal with errors as the system and
supervisor
services do, by returning appropriate status
codes. The main-line
code should check return status codes
following
all
calls to
the
supervisor and VMS services and to routines within
the program.

12.1

GUIDELINES

Arrange

each

flows

from

the

top

necessary,

should

Use

branches

Each

upward

FOR

segment
go

EXECUTABLE

CODE

executable

code

down.

All

branches,

down

the

page,

implement

and

except

that

the

jumps

when

the

case

procedure

they
of

are

loops.

segment

of
executable code
should
have one entry point and
point,
ideally.
This
simplifies
program
debugging.
It
also
increases the diagnostic value of a program for the
user, by
making
it easy for
him
to
retrace
the
steps
that have
led
to
a
failure.
one

exit

12-1

VAX Diagnostic Design Guide

ge, pointers, and base
Use the general registers for local storathat
your comments are
addresses, when possible, making sure
ter, make certain that
adequate. However, before you use a regis
register save mask at
you are not destroying important data. Use aregis
ter that the code
the beginning of each routine to save each
uses.

not destroy
Make your code efficient, so long as efficiency does
BSBW instruction

le, a
the readability of the program. For examp
JSB instruction, and
a
uses memory more economically than more
than
efficient
is
addressing
word-PC-relative
longword-PC-relative addressing.

GLOBAL SUBROUTINE GUIDELINES

12.2

like a high level
Each subroutine should function independently,
is totally closed,
instruction. Design each subroutine so that it clean
and precise.
making its interface to the main-line code
between branches,
Programmers should be aware of the trade-offs stand
ard interface
jumps, and calls. The call procedure is the
r, 1if no
between the main-line code and subroutines.d andHoweve
the routine is
parameters (or few parameters) are to be passe

because branches
short, branches may be more efficient than calls, branch
es may be

require

less overhead.

the other

hand,

cumbersome if you use them with more than a few parameters.

, data
When you use standard call procedures (CALLS or CALLG)
ned
retur
s,
passed should consist entirely of received value
as
codes
s
values, and returned status codes. Make the statu

accurate as necessary to describe all possible conditions.
In most cases you should not mix functions within subroutines. For

test
example, a subroutine that handles I/0 to the device under
should handle only I/0. In all cases, be sure to avoid nesting
print

12.3

routines.

ERROR MESSAGE PRINT ROUTINES

e header
Call error message print routines through the error messagcode,
as
ine
macros (for example, $DS_ERRHARD_x) from the main-l
message header
shown in Example 8-24. Coordination of the error
the formatted
and
x),
INTB
$DS_PR
(e.g.,
macros, the print macros
print any
ASCII output (FA0) directives should enable you to
for each
e
priat
appro
as
ble,
varia
information, fixed and
detectable error. Figure 12-1 shows the steps involved.

12-2

Coding

(TEST

Conventions

and

Procedures

PERFORM 1/0
FUNCTION ON
DEVICE UNDER
TEST

CALL $DS_ERRHARD_S

MACRO, PASSING

YES

ERROR

MESSAGE PARA-

METERS AND
PRINT ROUTINE

PARAMETERS

NO
y

ERRHARD

ANOTHER 1/0

FUNCTION ON

MESSAGE
A

HEADER

DEVICE UNDER
TEST

C RET

ERRHARD

SUPERVISOR SERVICE

)

CALLS REQUESTED

PRINT ROUTINE

PRINT ROUTINE
BUILDS MESSAGES
AND USES THE

DS_PRINTB_S
MACRO TO CALL THE
PRINT SUPERVISOR
ERVICE ROUTINE AND
PRINT THE MESSAGE

RET

TK-3005

Figure

12-1

Printing

Error

Message,

Program

Flow

VAX Diagnostic Design Guide
HANDLING INTERRUPTS

12.4

Interrupt service routines enable level 3 diagnostic programs to
Use interrupt
field device interrupts directly, as they occur.
service routines only toward the end of the program, after all
hardware logic on the unit under test has been verified. Through
routines diagnostic programs can field
interrupt service

interrupts,

necessary,

the

capture

return

and

unit and

the

status of

main-line

the

control

the channel,

some

code.

routine may initiate other
1interrupt service
the
cases,
operations. Figure 12-2 shows the flow of control and interaction
between main-line code (test n) and an interrupt service routine
in a typical level 3 diagnostic program. The circled numbers
the paragraphs that follow are keyed to the flowchart.

The

channel

x)
($DS_CHANNEL

macro

services

test

the

used

routine

(:)

To clear the channel.

(g)

Then to enable channel interrupts. In addition, the test

(§>

The

routine clears the unit and enables device interrupts.

routine

test

starts

and

transfer

than

allow more

transfer required

(:)

then
a

enough

for

the

1I/0

the

I/0

sets

buffers

time

for

completion

watchdog

(worst case).

timer.

The

timer

should

Then the test code starts a transfer on the unit. When
the

sets

unit
an

finishes

interrupt

its

bit.

transfer or detects
The

central

an error,

processor

fields

interrupt and calls the interrupt service routine

(E)
(:)

the

With the vector supplied to the channel service in step
1.

The interrupt service routine analyzes the vector

To determine whether it can handle the interrupt.

If it

cannot, it prints an error message (note that an error
message is permissible in the case of a fatal error) and

terminates the program.

can handle the

interrupt

If the interrupt service routine
(the vector

is valid),

it takes

appropriate action

(:)

Sets a done flag, and
to the main-line test code.

Returns control

(:)

The test code is at this point in a loop checking
done

flag

the loop
expires.

cancels

and

checking

until

the

timer.

The

program

the

executes

timer
the
finished or
unit has
the
the code
transfer has been completed,

timer,

and

12-4

Coding

CLEAR
CHANNEL

CANCEL

Conventions

and

Procedures

ANALYZE AND

TIMER

REPORT TIMEOUT

ERROR

MESSAGE

SYS. FATAL

CLEAR UNIT

SET DONE FLAG

ROt

PROGRAM

UNDER TEST

ERROR

ENABLE DEVICE

YES

FLAG

AND CHANNEL

INTERRUPTS

SET UP

TRANSFER

ERROR
SYS.FATAL

ABO

ERROR

ABORT

DEV-FATAL

PROGRAM

MESSAGE

PROGRAM

ANALYZE AND

MESSAGE

TIMER

TRANSFER
START

CHECK DONE FLAG

RET

)

/O TRANSFER

)

REPORT TRANSFER
ERROR STATUS

START

REI

ERROR
MESSAGE

DEV-FATAL

ABORT

PROGRAM

| :)

TRANSMIT

i
OUTPUT

RECEIVE

TRANSFER ERROR

i
INPUT

y
‘

CAPTURE STATUS

QPBGSET ERROR

TK-3013

Figure
Handling

12-2

Interrupts

12-5

VAX Diagnostic Design Guide

e
Checks the error flag. If the interrupt service routin
es
analyz
e
routin
has detected a transfer error, the test
and reports the error. If the timer expires, one or more
errors have occurred, and they must be analyzed and
reported.

(:) Notice that the

interrupt service routine captures the

status of the device when it detects a transfer error
vector. In this way error reporting is 1left to the

main-line code.

12.5 ASYNCHRONOUS SYSTEM TRAPS

several devices in
If a level 2 or 2R diagnostic program must test
d coordinate the
shoul
you
parallel, as in reliability testing,
es
various 1/0 transfers with asynchronous system trapresroutin
three
requi
12-3
(ASTs). The approach shown in Figure
components of

code

a main-line test routine

an I/0 routine
an AST routine.

The

circled

12-3.

OO0

Figure

numbers

the
‘

The main-line code

following
(test n)

for each unit to be tested.

paragraphs

are

keyed

calls the I/0 routine once

The I/0 routine reads the command buffer for a given
unit. It then sets up the parameters for the queue 1/0
system service, queues the request, and returns control
to the main-line code.

The I/0 transfers are started by the device driver code

When queue 1/0 requests for all the units have been made,

in WS (or the supervisor) asynchronously.

The driver routine calls the AST routine at the
completion of each I/0 transfer. For example, when the
first transfer has been completed on the first unit, the
AST routine identifies the device that has completed the

the main-line code hibernates.

transfer and

checks for errors.

If the AST routine finds that an error has occurred, it
captures the status of the device and the diagnostic
buffer in an error buffer for the failing unit. It then
sets an error flag to signal the main-line code that an
error has occurred. The AST routine does not report

errors to the operator directly.

12-6

® 9O

Coding Conventions

the

been

The

required

number

transfers

for

and Procedures

the

unit have not

completed,

I/0

routine

called

If all transfers for
AST sets a unit flag,

the

again.

given

unit

have

been

made,

the

Wakes the main-line code, and returns. When the main-1line
code wakes up,
it checks the error flag for each unit,

and

Prints a message for each error on each failing
test then checks to see whether all of the I/0
have been done on all units.

@2)

so,

the

Buffers

and

flags

Figure

12-4.

test

finished.

hibernates
until
the AST
routine
transfers on another unit have been
are

necessary

support

not,

the

program

shown

wakes
1it,
completed.
the

AST

unit. The
transfers

after

all

AST

routines
are
necessary
in
all
diagnostic
programs
that
hibernate. A timer can be set to call an AST routine after the
expiration of a delta time or at a specified absolute time. The
AST routine can, in turn, wake the hibernating program, as it does
in

Figure

Notice

12-3.

that

the

AST

mechanism,

together

with

the

Hibernate

and

Wake
system
services,
enables
you
to make
level
2
and 2R
diagnostic programs highly efficient. When the program hibernates,
it frees the system resources for use by other processes.

12-7

VAX Diagnostic Design Guide

)
START

(I/O ROUTINE)@

MAIN-LINE CODE

I/0

TRANSFER

CLEAR FLAGS
READ CMD BUFFER
SET UP QIO FOR LUN

SET
LUN=0

fiinwej><:>
EXECUTE QIO
WITH AST

AP => CONTROL
PARAMETER

CALL
1/0 ROUTINE

CHECK STATUS
AND DIAGNOSTIC
BUFFERS

=
)

INCREMENT
LUN
4

DONE
ALL UNITS

ERROR

YES

LOAD ERROR STATUS IN
ERROR BUFFER AND SET
ERROR FLAG FORUNIT

YES

HIBERNATE

UNIT

TRANSFERS

YES

DONE

NO
A

INCREMENT
PASS NUMBER

PRINT MESSAGE
FOR EACH ERROR

YES

e
)

SET UNIT FLAG

170 ROUTINE

WAKE MAIN-LINE

(TESTN)

e
)
TK-3011

Figure

I/0

12-3

Coordination of

Transfers

12-8

with

an AST

Coding Conventions and Procedures

UNIT DONE FLAGS

UNIT ERROR FLAGS

COMMAND POINTERS

COMMAND BUFFER

UNIT ERROR BUFFERS

TK-3010

Figure

12-4

Data

Structures

12-9

that

Support

the AST

VAX Diagnostic Design Guide

12.6

EXCEPTION

HANDLERS AND CONDITION

HANDLERS

Use of a handler routine
increases the ability of a diagnostic
program to deal with a hostile environment. It enables the program
to detect, and in some cases recover from, exceptions (including
machine

checks)

that

would

otherwise

cause

the

program

abort.

If your program may generate exceptions under some conditions, you
should design a handler with those specific exceptions in mind.
All
conditions
not
handled
by
the
program
are
reported
by
the
supervisor.

There are two ways to deal with exceptions in the
system: exception handlers and condition handlers.

First,
should

level 3
use the

implement

address

diagnostic

programs that test processor specific functions
Set Vector supervisor service
($DS SETVEC x)
to

exception

(SCB). When

VAX

handlers.

The

Set

the

exception

handler

the

exception

condition

is entered directly. Use exception
system control block mechanism.

into

Vector
the

occurs,

handlers

service

system

the

loads

control

exception

primarily

the

block

handler

test

the

Level 2 and 2R diagnostic programs, and level 3 programs that are
not processor specific, should use condition handlers to deal with
exceptions.
Those
routines
in
a
program which
may generate

exceptions
should
begin
with
instructions
that declare
the
condition handler mechanism. You should move the address of the
condition handler
routine
to the stack 1location that the frame
pointer points to, as shown in Example 12-1,
MOVAL

Example

12-1

COND HANDLER,

Declaration

(FP)

Condition

Handler

This declaration enables the exception dispatcher routine in VMS
or the supervisor to search the stack until it finds this address.
The dispatcher
routine
then
calls
the condition handler.
The
condition handler is treated as a called procedure.
As such it
must end with an RET instruction.
Figure

12-5

flowchart

showing

the

organization

typical

condition handler.
It could be used in conjunction with the test
routine shown in Figure 12-2.,
In that case, exceptions might be
expected while the I/O transfers are in progress and the test code
is

looping

step 9.

12-10

Coding Conventions and Procedures

CONDITION
HANDLER
A

GET POINTER TO
SIGNAL ARRAY

GET CONDITION
NAME CODE FROM

SIGNAL ARRAY

EXPE%TED

EXCEPTION

ggfiitfiffigfi?w

SET ERROR FLAGS

RESIGNAL

(TO RETURN TO

SUPERVISOR)

SUNWIND_S

SET ERROR FLAGS

(TO RETURN TO

MAIN - LINE)

CONTINUE

(TO RETURN TO

NEXT INSTRUCTION)

=
)
TK-3006

Figure

12-5

Condition Handler

12-11

Flowchart

VAX Diagnostic

Design Guide

When
the
dispatcher

fault
causing
routine
in VMS

which

violation

dispatcher

the

examines

the

stack and vectors
occurred,
in
order

handler.
register
longword

The
dispatcher
images backward
in each frame to

When

dispatcher

the

the
exception
occurs,
an
exception
or the supervisor gains control.
The
for the access mode in
to
1locate
a
condition

follows
the
saved
frame
pointer
(FP)
through the stack.
It checks the first
determine whether it is non-zero.

locates

the

address

the

condition

handler

loaded previously,
it constructs an argument list and calls the
handler. The argument list consists of two addresses that point to
longword arrays, as shown in Figure 12-6.

N
ARGUMENT LIST

CONDITION NAME
2

SIGNAL ARRAY ADR

ADDITIONAL

ARGUMENTS,

IF ANY

SIGNAL

_ | ARRAY

MECHANISM ARRAY ADR
PC

PSL

ESTABLISHER FRAME

MECHANISM

EPT

ARRAY

DEPTH

RO
R1
TK-3008

Figure 12-6

Condition Handler
and

Associated

12-12

Argument

Arrays

List

Coding

The

first

address

the

argument

list

Conventions and

Procedures

points to the signal array.
the mechanism arguments.
the
number
of
longword

The second points to an array containing
The
first
longword
of each array shows
arguments in the array.

The condition handler routine should get the pointer to the signal
array (Figure 12-5)
and then find the condition name code.
The
handler
can
then
check
the
<condition
code
name
and
take
appropriate action.
The

condition

shown

handler

Figure

can

handle

exceptions

any

three

ways,

12-5.

Continue

Unwind
Resignal
If

the

condition

required

Example

handler

function,

12-2,

and

can

executes

MOVZWL

deal

moves

the

with

RET

#SS$_CONTINUE,

the

continue

exception,

code

R@,

performs

shown

instruction.

RET

Example

12-2

Continue

from

Condition

Handler

The
continue
code
return control
to

is a
signal
to
the exception dispatcher to
the
instruction
that was
executing
when
the
exception occurred.
Since the same exception will probably occur
again unless the condition causing the exception has been fixed,
care should be used with the continue function.
For example,
if
the program is polling devices to determine what devices are on
the system, or if the program is sizing memory, access violations
will probably result, causing exceptions.
The condition handler
may
have
to
<change
the
address
to
be
accessed
next
before
returning control to the program.
When

the

resignal
If

the

handler

cannot

unwind,

deal

program

must

should

resignal,

MOVZWL

with

the

depending
abort,

#SSS$

giving

shown

RESIGNAL,

given

condition,

control

can

condition.
to

Example

either

'
the

supervisor,

the

12-3.

RET

Example

If
the

program

exception

routine
require
the

12-3

Resignal

executing

may

have

and

Return

from

subroutine

occurred

can

corrected.

12-13

the

Condition

when

because

failure.
Such an exception, while
return from the subroutine to the

problem

the

Handler

exception

error

such

occurs,
an

AST

not catastrophic, may
main-line code before

subroutine

has

declared

the

VAX Diagnostic Design Guide

condition

handler,

the

handler

should

call

the

Unwind

system

service
(SUNWIND x),
generally without
arguments.
The
Unwind
system
service
1iIs
available
to
1level
2,
2R,
and
3
diagnostic
programs.
Refer
to
the VAX/VMS System Services Reference Manual
for details on UNWIND.
However, the unwind operation is complex,
and should be used with care.
The stack is then unwound to the
next higher
1level
and control is
returned to the return PC for
that procedure (the location to which control would have returned
following
normal
completion
of
the
routine
that
caused
the
exception), as shown in Figure
information
to
the
test code
test
code
should,
of
course,
messages as appropriate.

12.7
Macros

12-5. The handler should pass error
via
flags
and
status buffers.
The
check
these
flags
and
print
error

USER-DEFINED MACROS
defined
by
the
user

contribution

any

user-defined

macros

than it would
categories:

(programmer)

diagnostic

should

otherwise.

program.

Most

make

readable

user-defined

macros

that

build

data

macros

that

build

executable

program

and

important

that

easier

uses

code

fall

into

two

developed

for

one

macros

structures
code

12.7.1
Data Structure Macros
Most data structures are repetitive.

pattern

item is
repeated continuously to
form a table.
If the table
is
long,
building
it
and
making
changes
to
it
can
be
tedious.
Consider
the
table of
addresses
and
labeled
strings
in
Example
1.2'-4:0
<STAR, SUN,MOON, ROCK>

.ADDRESS

TSUN

MOON

TROCK

.ASCIC /STAR/
.ASCIC /SUN/

Example

12-4

user-defined

Table

macro

STRSET

arguments STAR, SUN, MOON,
definition for STRSET.
«MACRO

.ASCIC /MOON/
.ASCIC /ROCK/

T _MOON:
T ROCK:

The

T_STAR

.ADDRESS

T STAR:
T SUN:

$$ T1

.ADDRESS

.LONG

WTMy

STRSET

and

$SST1=$S$T1+1

address
address

builds

ROCK.

of
of

string
string

Generate ASCIC
Generate ASCIC

Addresses

and

this

Example

string.
string.

Strings

table,

12-5

given

shows

the

macro

STRINGS

$ST1=0
. IRP

Insert count of strings.
address of string
address of string

;
X ,<STRINGS>

12-14

counter

; Count

the

number

Coding Conventions and

. ENDR

T_'x:

. LONG

$ST1

. IRP

X,<STRINGS>

. ADDRESS

T 'X'

. ENDR
. IRP

X,<STRINGS>

.AscIc

strings.

;

Insert count of

strings.

; address of string

/X/

. ENDR

;

Procedures

; Generate ASCIC string.

. ENDM

Example

12-5

A Data

Structure Macro

Definition

Three indefinite repeat macros
definition.
After
the counter

(IRP)
$$T1

make up most of
is initialized,

pointer

generated.

the

table

you

can

produce

this macro
the
first

indefinite repeat macro C) counts the number of strings to be set
up. The second indefinite repeat macro () sets up an address
for

each

ASCIC

string

adds

ASCIC

However,

with

"T_"

prefix to each string, making labels and pointers to the

labels.

for

The

third

indefinite

repeat

each

string

given.

that

you

define

for

with

formats

macro

may

12.7.2

not

The

useful
your

macro

format

every

program,

generates

program.

produced
data

string

this

macros

structures

that are appropriate.

Macros

that Build

Executable Code

You can deal
in two ways with functions that must be repeated
often:
building
macros
or
building
subroutines.
Consider
the
trade-offs
before
choosing
either.
Macros
require more memory
space than subroutines but execute more efficiently. Subroutines
save on memory space but require a greater overhead in execution

time.
In
general,
you
should
use
macros
for
repeated
short
segments of code. Subroutines are useful for implementing longer
or
more
complex
coding
sequences.
Be
sure
that
user-defined
macros are expanded in the listing.
Use the listing directives,
.LIST and .NLIST, to control the listing of the macro expansion,
as
shown
in
Example
12-6
(refer
to
the
VAX-11] Macro Language
Reference Manual for more details).

error.

.MACRO

VERIFY

.NLIST

argument
to check

DEVADR,FUNC, TEST, CMP
Wy

MEB
PUSHL CMP

PUSHL

WNe

PUSHL TEST
PUSHL FUNC

WMy

.LIST

DEVADR

CALLS
MEB

#4,

Example

12-6

Expand macro.
Save expected
Save
Save

pattern.

test pattern.
function.

for

example shows a user-defined macro that builds an
from test data and calls a subroutine
(CK VERIFY)

Save address of device

This
list

;

Disable macro

CK_VERIFY

expansion.

« ENDM
A Macro

that

Generates

12-15

Executable

Code

VAX Diagnostic Design Guide
12.7.3

Build

Macro Libraries

a separate

diagnostic

1library file

program.

for

user-defined

macros

for

each

In this way, the macros are available globally and available to
other programs as well. Create a library from the file with a DCL
command, as shown in Example 12-7.

$ LIB<name_ofi_1ibrary>/CREATE::::MAC/—SZ=<source—name>
Example 12~7 Creating a Library

List all of the required macro libraries (user-defined and VAX
family libraries) in the include files section of each program

module, as shown in Example 12-8.

Include

Files:

“Ne¢

.SBTTL DECLARATIONS

. LIBRARY
. LIBRARY

: VAX family diagnostic library
; DZ unique macro library

\LB:DIAG.MLB\
\ESDAA.MLB\
Example 12-8

1Include Files

SYMBOL NAMING CONVENTIONS

12.8

Two types of global symbols are used in the VAX diagnostic system:
public symbols and private symbols.
12.8.1.

Public Symbols

The diagnostic supervisor, the VMS operating system, and other
DIGITAL software facilities use public symbols throughout.rs All
and
DIGITAL public symbols contain a currency sign ($). Custome
cy
curren
t
withou
diagnostic engineers are advised to use symbols
signs in order to avoid future conflicts.
Private Symbols

12.8.2
Diagnostic engineers should apply the following conventions to
produce useful private symbols that convey as much information as
possible about the entities they name.

A private symbol is an alphanumeric string of up to 15
It consists of letters a through
characters in length.

z and A through Z, digits @ through 9, and the special

Characters underline (), and dot (.).
distinguish
not
does
assembler
The
°

between

uppercase and lowercase alphabetic characters
Thus "symbol", "SYMBOL",
constituting a symbol.
"SyMbOl", etc., are all interpreted as equivalent.

12-16

Coding

minimize

reader

Conventions

confusion,

symbols.
Lowercase should
and in text strings.

°®

The

underline

character

never

use

used

only

()

used

lowercase

comments

separate

the

name.

wunderline
when
constructing
readability and comprehension.

Freely

use

names

compound

(or

the

Procedures

qualified)

parts

and

Make

sure

general,

placing
an
would go.

that

your

the

underscore

symbols
rules

(

)

are

for

unique.

DIGITAL

public

where

the

use

descriptive

currency

macros

simply

names,

sign

User-defined

improve

and

($)

unique

name.

Global
of the

entry
form:

point

names

that

have

are

not

nonstandard

calls

are

entryname
Rn

where

preserved.

Note

that

least

the caller of such an entry point must include
registers R2 through Rn in its own entry mask.

Global

variable

names

are

the

form:

Gt_variablename
The letter G stands for global variable and the t is a
letter representing the type of the variable as defined
in Paragraph 12.8.3.
Addressable
the

global

letter G)

and

arrays
are

use

the

letter

(instead

form:

Atarrayname

The

letter

A stands

for

letters
representing
according to the list
Structure

offset

global

array

and t

one

the
type
of
the
array
in Paragraph 12.8.3.

names

are

the

element

form:

structure
t fieldname
The

t
is
a
letter
representing
the
data
type
of
the
field as defined in the next section.
The value of the
symbol is the byte offset to the start of the datum in
the structure.

12-17

VAX Diagnostic Design Guide

the

field offset

bit

Structure

and

single bit names are of

form:

structure_V_fieldname

The value of the symbol is the bit offset from the start
(not from the start of the
of the containing field
control

block).

Structure bit field size names are of the form:
e
S fieldname
structur

The

value

the

symbol

the

number

bits

the

field.
10.

names

Structure mask

are of

the

form:

ure
M fieldname
struct

The value of the symbol is a mask with bits set for each
bit in the field.
This mask is not right Jjustified.
Rather, it has structure
V fieldname zero bits on the
right.

11.

Structure constant value

names are of

the

form:

me
e
constantna
Kctur
stru

Object Data Types

12.8.3

Use the letters listed
and

types

in Table 12-1 to

indicated.

functions

OZRrRUuHIOTMEUOLY TM

1)
cr
tr
O

Table 12-1

represent the various data

Object Data Types

Data Type or Usage
address
byte integer
single character

double-precision

floating

single-precision

floating

DIGITAL

reserved

general

value

integer value for counters
reserved for integer extensions
reserved to customers for escape

to other codes

constant

longword
field

integer

mask

numeric string (all byte forms)
reserved to DEC as an escape to

12-18

other

codes

Coding

Table
Letter

Data

NKXE<CHNITOW

12-1

packed

Object Data Types
Or

and

Procedures

(Cont)

Usage

string
quadword integer
reserved

field

for

records

size

text (character)
smallest unit of

field position
word integer

and

dependent

(generic)

strings

character

count

I/0O

are

reference

(BLISS)

nonstandard

typically

records

storage

field

they

variable

contain

length.

Frequently

byte-sized

digit

preceding
the
string.
If
so,
the
location
to the count.
Counted strings cannot be passed
Instead, a string descriptor is generated.

points

12.9
Assemble

file

(assembler);

dependent

offset
CALLs.

string

addressable

context

unspecified
P,

(structure)

context

structures

for

Type

Conventions

ASSEMBLY AND LINK
each module in a

(.0OBJ)
all

and

listing

or
in

PROCEDURES
program

file

separately,

(.LIS).

Then

creating

1link

the

object

files

the modules together to produce an executable file (.EXE)
and a map (.MAP). Use the CONTIGUOUS and SYSTEM switches with the
Link command. Example 12-9 shows the assembly and linking of three

modules.

$MACRO/LIS
HEADER
SMACRO/LIS
TESTA
SMACRO/LIS
TESTB
SLINK/EXE:SAMPLE/MAP/FULL/CONTIGUOUS/SYSTEM: 200
Example

12-9

Assembly

12-19

and

Link

HEADER, TESTA, TESTB

Commands

CHAPTER
EXTERNAL

Diagnostic
run,

and

program

programs
they

that

breaks

or comes to a
considerations

Program

APT

should

run

down

INTERFACE

DIAGNOSTIC

reliable,

simple

under

easily

variety

under

automated

set

up,

easy

circumstances.
product

test

(APT)

stop in a
script file is limited in value.
of this type are especially important:

set

CONSIDERATIONS

Eight

constraints

Scripting constraints
Run-time consideration
Parallel versus serial
Looping constraints
Volume

Long
13.1

testing

verification

silences

PROGRAM

SET

general,

diagnostic

modifications

the

programs

hardware.

should

However,

not

require

special

some

devices

abnormal

jumper configurations or loop-back cables are necessary in
enable the program to test specific logic or functions.

order

Keep set
up requirements of
this
tests that
require special
set up

sort
in a

to a minimum.
Place all
separate program section.

In this way,
the operator may run a quick verification check on
the device without making changes to the hardware.
Then,
1if he
suspects
a
problem
in
the
area
left
untested,
he
can
make
the
special
for

13.2
All

hardware

set

and

select

the

appropriate

program

section

execution.

AUTOMATED PRODUCT TEST (APT) CONSTRAINTS
diagnostic
programs
should
be
executable

VAX

environment.
First,

APT
the

imposes

three

constraints.

program

must

able

yield

the

APT

the

control

processor within 3 seconds at any time, following the typing
of
Control
C
by
the
operator.
This
means
that
any
potentially
1long
1loops
or
operations
must
contain
the

$DS_BREAK macro at
Second,

the

overlays,
program

the
at

APT

since

must

environment

load

microcode
assembly

appropriate

must

cannot

will

open

microcode

points.

built

not

files.

into

the

This

program

means

that

microprogrammable

diagnostic

image

device,

program

file

time.

Third, any tests that prompt the operator for a response must
be
placed
in
a
separate,
manual
intervention
section
that
will not be executed under APT.
The program will fail if it
executes

instruction

that

13-1

prompts

the

operator

under

APT.

VAX Diagnostic Design Guide

SCRIPTING CONSTRAINTS

13.3

When diagnostic programs run under the control of a script file,
no operator is present to answer questions or perform other tasks.

Therefore,
placed in

all functions that require operator
intervention section that
a manual

message) .

However,

action should be
is not executed

x macros will normally
$DS_ASKxxx
unless explicitly selected.
the
1if
the operator,
not
the script,
from
responses
solicit
prompt
the
for
13-1
Example
(see
program is running under a script

macros

prompt

program,

diagnostic
as

the

programmer

the

volume

for

disk ~or

tape

prompt string with a null

code the

should

Example 13-2 shows the

first character.

$DS ASKxXX X

the

using

verification

prompt message

be used with a $DS ASKxxx x macro to prompt the operator for
response, even when the program is running under a script file.

.ASCIC \ DO YOU WANT TO CONTINUE?\

A Normal Prompt Message for the $DS_ASKxxx_x Macro

Example 13-1

.ASCIC (9) \ DO YOU WANT TO CONTINUE?\
A Special Prompt Message that Causes

Example 13-2

Scripted

Rejection of

For

details

further

Responses

verification,

volume

Paragraph

refér

13.7.

RUN-TIME CONSIDERATIONS

13.4

In general, diagnostic programs should execute in as little time
Programmers should be especially careful to optimize
as possible.
Three considerations are
execution time on 1long programs.
important.

particularly

First,

design,

where

make

exhaustive

tests

are

run optional.

a quick

essential

For

example,

program

the

a given

test repeats a function with a large number of data patterns,
choose basic patterns for the quick run and make the extra
patterns optional.

make

Second,

message

tends

your

information

time

and

than

nothing.

messages

error

efficient,

conveyed,

than

efficient.

terms

several

small

One

execution

And you can improve the value of your messages if
Unnecessary information
only pertinent registers.
Third,

make the

possible.

13.5

Most

scope

A long

loops

for

level

are designed

test

type.
13-2

several

messages.

you dump
1is worse

3 programs as short

scope loop is generally hard

PARALLEL VERSUS SERIAL TESTING

programs

device

large

units of a

use.

particular

External

Interface

Diagnostic

Considerations

Serial

testing
is useful
for basic programs that test logic and
provide scope loops.
Therefore, all level 3 programs should test
units
serially.
In
serial
testing,
the
initialization
routine
normally determines which unit is to be tested next.
The entire
program is run on the unit selected.
Then, control returns to the
initialization
routine,
and
the
next
unit
is
selected.
The

program
completes
one
pass
only when
it
has
Alternatively, each test in a program may test
before passing control to the next test.

Parallel

testing

magnetic

media

example,

and

useful

for

devices

that

then
required

functions

processor

than

serial

Parallel

testing

13.6
Avoid

LOOPING

CONSTRAINTS

making

tight

some

supervisor

program

hangs

operator

will

that

loop

that

13.7
VOLUME VERIFICATION
Diagnostic
programs that
use

destroying
the

fail-safe

the

volume

possible

scratch

unknown

the

program

the

media

the

13.8
LONG
Diagnostic

for

$DS_BREAK
Control

not

check

for

the

Control

system.

write on magnetic media
(disk or
tape)
that prevents them from accidentally

customer.

identifies

does

program

macro

the

These
media

programs

under

should

test

for

three

test

the

volume

should

not

respond

should

abort

make

prompt

"scratch"
the

(time-out)
testing

or
the

assumptions

should

operator

before

types
unit

about

carriage
question.

the

volume

SILENCES
programs

with
long
execution
times
should
avoid
long
order
to assure
the operator
that the program is
properly,
the
program
should
type a message
(a summary,

silences.
for
AST

include

programs.

The
program
should
identification.

running

diagnostic

1is

approach

Otherwise,

operator

verify

without

therefore,

control

continuing.

return,

access.

cases:

proceed.

that

memory

independently

checks

does

regain

identification

unrecognizable
If

not

that
call

programs

For
transfers on several
units
under test may perform the

and

media

loops

direct

testing,

for

service
unable

and

long
units

simultaneously

intervention.

efficient

perform

program can
initiate
hibernate.
All of the

and

must

level

tested
all
units.
all units serially

example)
at least once every five
routine to perform this function.

13-3

minutes.

You

can

set

DEBUGGING

CHAPTER 14
TEST DESIGN

If you fail to design and code your diagnostic program carefully,
the debugging phase may require more effort than the development
phase.
However, even in the most carefully constructed program, a
wide variety of errors may develop.
Many of the coding
errors
will
appear
during
initial
program
assembly,
1linking,
and
execution.
Some
types
of
design
errors,
however,
may
dgo
undetected until you make a thorough quality assurance (QA) check.
The

debug

features

necessary
an

error

set

tools at
1is

connected

breakpoint

Deposit,

this

and

the

with

supervisor

point.
a

specific

get

provide

1In general,

there.

commands

when

area

Then

proceed

locate

the

you

with

the

you suspect that
program,

you

with

can

Examine,

problem

and

¢try

solutions.
14,1

COMMON

Some

coding

programs.

CODING

errors

Others

ERRORS

are

unique

wide

methods.

obvious,
The list

which

the

applications

diagnostic

errors are catastrophic and
identify or unpredictable.

some

specific

variety

And while some programming
others may be difficult to

explains

follows

are

AND THEIR SYMPTOMS

common

most

common

errors

and

their

symptoms.

14.1.1

Endless

Sometime

sleep

after

Loops

the

program

(silent death).

started,

the

symptoms

even be

computer

unresponsive

appears

the

Control

command.

endless

loop

program

checks

never

set.

You

can

avoid

loops

until

force
time

the

will

bit

this

(perhaps

kind

status

error

set,

seconds).

14.1.2

Forgetting

the

produce

endless

program to branch out of

condition

has

It may

the

program

initialization

For example,
device, test

The

code

this

the

example,

and

then

up a

watchdog

timer

loop will

setting

result

the

bit

the loop at the end of a given
that

follows

should

report

the

operator.
Initialization

behaves

in an

cleanup

erratic

failure.

when the program
B may initialize

way,

performs a
conditions

necessary both to test B and to test C.
the device

as well,

program

loop on

test

Make

sure

that

each

stand

alone.

initialization

type.

for

and

error may

result

it may be because

sequence of tests on a
on the device that are

Unless test C initializes

the operator

program

causes the

test

cleanup

within

functions

14-1

necessary

performs

enable

the

VAX Diagnostic Design Guide

14.1.3

Forgetting

Return Status

If interrupts occur when they are unexpected, or the program
indicates a hardware failure where none exists, the problem may be
return status codes.

test

step A involves a

that

may

steps,

sequential

involves

that

successful execution of step B depends on prior completion of step

subroutine,

proceeding
and

take other

and

loose

successfully,

control

Step

the

check

the

appropriate

interrupts.

disables

supervisor service or a call

should

step B.

executed

not

was

code

the

return status

if,

in which step A

unexpected

B may encounter
in

error

the

report

Consider a case

supervisor

before

indicates that step A

program can

the

steps.

to a program

status

return

fact,

interrupts

have

not been disabled.

14.1.4

Neglecting

to Save Registers

Erratic

(clobbering).

of the contents of a register

Make

from

program behavior may result

general

your

that

sure

inadvertent destruction

previous contents of the

program

saves

the

save

the

contents of

registers when control passes from the main-line code to a

You

subroutine.

should

registers

all

(RO

through R1l1l) which the subroutine uses, whether or not you think
Failure to do this may
that they all contain useful data.
introduce

bugs that are very difficult

isolate.

Use of the register save mask procedure is the most efficient way

preserve

the

contents.

14.1.5

Forgetting the Context or Properties of an Instruction

though

it makes no direct reference to that register or location,

Your

program

may

you forget

For

example,

contexts

clobber

the context or

MOVC3

through

references

memory

properties of an

R5.

instruction

too

slow

For

and

it may cause

Instead,

you

should

(Branch on Bit Set)

slow or

instruction.

unreliable

destroys

the

if they make

I/0

operate

efficiently

problems.

the

BIT

the

unreliable

(Bit

Test)

Field)

(Extract

EXTV

example,

instruction

use

even

program may be

incorrectly.

location,

instruction

Character)

(Move

Improper Context for I/0 References

14.1.6

Portions of a

branch

same

the

I/O

device

BBS

way,

the

I/O

context.

then

instruction and

conditionally.

addition,

references.

sure

Unibus

use

device

the

correct

registers

data

require

types

word

references.
Massbus device registers, RH780 registers,
registers require longword (32-bit) references.

14-2

for

1I/0

(16-bit)
and

DW780

Debugging

14.1.7

Forgetting

not

the Number Sign

forget to put the number

front of literals in

statements when appropriate or required.
Stack

may

supervisor

instructions

Underflow and

overflow
memory

instructions make

keep

the

straight

where

there

passing

wiping

you

use

potential

Use

for

stack

diagnostic

program

the

program

the

development

standard

process,

release.

quality

the

This

program.

a diagnostic

assembly

and

simple,

and

the

pop

The CALLS

CALLS

and

they

CALLG,

problems.

last

stage

a vital

1leads

check

process.

push

stage

and

Five distinct

assurance

portions

the

parameters

automatically.
a

out

subroutines.

QUALITY ASSURANCE PROCEDURES
14.2
The
quality assurance
process
forms

development

operands

Overflow

when calling

stack

therefore,

literal

underflow,

buffers,

incorrectly

CALLG

and

language

stack

calls

(#)

lists

The

macro

(#)

argument

14.1.8

for

sign

Test Design

the

part

formal

procedures make

specification check
conventions

check

fault detection and
operational check
user

mode

reporting

check

diagnostic

program

1is

complete

until

these

checks

have

been

made.

14.2.1

After

Specification Check

you

have

completed

program,

you must

ensure

manual) .

Make

design

and

operational

all

functional

this

concerned

phase of
14.2.2

check
in

groups
and

training

with

Conventions

documenting

(e.g.,

use of

(refer

the

the diagnostic

the

VAX-11l

Software Engineering Manual.

the

six

questions

listed

analyze

11,

below are

program

understanding
to

must

(refer to Chapters 6,

the

diagnostic

test

Include

content
people

field

review

the

this

and

from

service,

the

initial

program.

Check

program

implemented

Chapter

engineering,
Treat

diagnostic

review.

The

this manual

regard

formal

training).

and

specifications

requirements,

manufacturing,

coding

that you have completely

the

conventions

12 and 13

test

code?

14-3

Positive

particularly

documentation

each

set

answers

and

important.

sufficient

without

forth

in particular)

requiring

the

convey

reader

VAX Diagnostic Design Guide

all

the
3.

bit

and

relevant

Does

the

program

supervisor
4,

formats

agree

error

Chapter

this

manual.

all

error

from

reporting

error

Load

and

that

the

names

from

the

diagnostic

with

the

except

subtest

from

the

standards

See

Example

system

bodies

cleanup

fatal

set

for

8-23

messages

(main-line code)?
code

avoided?

Execution Check

the

commands

the

test or

features

messages?

messages

reported

services)?

basic

sure

sequence

channel

and

14.2.3

Check

correctly use

(e.g.

error

mnemonics

specification?

header

Are

Make

the

hardware

diagnostic

ability

the

program

diagnostic

executes

supervisor

the

1load

without

and

errors.

the

program

perform

the

following

pass

beginning

with

load

and

functions.
1.

error

free

normal

start

procedure.

Multiple error

free passes.

trace of

program with

loop

Multiple

loop on

test.

Infinite

loop on

test.

Error

in
14.2.4
Verify

the
test

free

Fault

and

program.

Introduce

inserting

incorrect

data.

failures.

Use

this

for

the

program
1.

All

error

procedure
following

reports

Loop-on—-error
properly

for

all

test,

flag

with

program

Reporting

detection

diagnostic

the

each

Trace

set.

sections

errors.

not

included

section.

Detection

fault

for

execution

the default

the

check

the

will

check

capability

setting

produce

each

the

breakpoints

and

data

unique

comparison

test

case

features.

function

and

each

faults

This

Check

reporting

properly.

halt-on-error

detectable

14-4

error.

facilities

function

Debugging Test Design

The

four

unique
5.3.3.

error
report.
of this manual.

Error

reports

with

IE3,

IES)

flags

should

Refer

accurately

the

error

reports

properly

under

adverse

fault

insertion.

When

the
a

wunit

functions

under

meaningful

test

message

and then returns
interpreter.

For

capable

write

faults

powered

the problem,
command line
devices

each
Paragraph

callout

physical

gives

Chapter

reports
for

module

verify

Checks
program

inhibit

properly

reflect

must

Operational
that
the

that

function

You

sure
Make
conditions.
1.

control

IE2,

report.

14.2.5

execution

(IE1,

the

off,

the

operator,

control

protection

that

the

which

they

program

explaining
supervisor

are

write

protected,
the
program
reports
the
problem
with
a
meaningful
message
(without
bad
side
effects).
The
program
then
returns
control
to
the
supervisor
command
line interpreter.
For

devices

capable

being

placed

off-line,

unit under test is placed off-line, the
an
appropriate
message
and
returns
supervisor command line interpreter.
The

program

runs

under

APT-VAX

when

the

program types
control
to

out
the

control.

The
program
runs
in
the minimum
system
stated in the functional specification.

configuration

The
program
runs
in
the maximum system
stated in the functional specification.

configuration

The program runs with each appropriate module extended on
a module extension board.
(Perform this check one module
at a time, making one complete pass per module.)
If

the

program

requirements
VAX

transportable,

Paragraphs

Family computer

14.2.1

through

satisfies
14.2.4

the
all

types.

14.2.6
User Mode Checks
Make sure that level 2 and level 2R diagnostic programs run in the
user mode with the latest version of VMS.
The program should run
multiple
passes
without
encountering
software
problems.
When
program execution is aborted, the unit under test should be left
in the state in which the program found it.

14-5

VAX Diagnostic Design Guide

14.3
DEBUG AND UTILITY COMMANDS IN THE DIAGNOSTIC SUPERVISOR
This group of commands provides the operator with the ability to
isolate
errors and
to
alter diagnostic program code.
The
supervisor allows up to 15 simultaneous breakpoints within the
program.
The operator can also examine and/or modify the program
image

in memory.

14.3.1

Set

Base Command

Syntax:

SET

BASE

This

command

loads

the

address

specified

into

software

This number is then used as a base to which the address specified
in

the

Set

Breakpoint,

added.

commands

1is

should be

set

referencing

code

the

section

program

the

Clear

Breakpoint,

The

diagnostic

program

(see

address

the base

referenced.

Examine,

command

Base

Set

Then

the

and

Deposit

useful

when

1listings.

The

base

numbers

provided

program link map)

of
in

the listings can be used directly in referencing locations in the

program

For

sections.

example:

DS> SET BASE

E@0

Set the base
address to the
beginning of the psect of
the routine under
examination.

DS>

Example

14-1

Set

Base

Command

NOTE

Virtual

address

when

(normally)

turned
See

Example 14-7
14.3.2

Set

command

execution

command.
within

address

management

further clarification.

Breakpoint Command

causes

control

encounters
A

©physical

off.

SET BREAKPOINT

Syntax:
This

for

memory

maximum

the diagnostic

the
of

pass

the

simultaneous

program.

14-6

supervisor

when

breakpoints

can

previously

specified

program

this

set

Debugging

For

example:

DS>

SET

BREAKPOINT

Set

base

command

location

clears

specified

specified
argument

the

address,
of

ALL

For

example:

DS>

CLEAR

<address>.

clears

error
all

BREAKPOINT

memory

Command
<address>

previously

the

Command

ALL<KCR>

set

breakpoint

existed

message

previously

given.

defined

the

optional

breakpoints.

gom

This

Breakpoint
BREAKPOINT

Breakpoint

Clear

Clear
CLEAR

Set

address.

the

gum

14.3.3
Syntax:

14-2

offset

Example

Design

breakpoint

an offset
from the

Test

breakpoint

the base address.

location

3¢

which

from

DS>

Example

14-3

Clear

14.3.4

Show

Breakpoints

Syntax:

SHOW

BREAKPOINTS<CR>

This

command

For

example:

DS>

SHOW BREAKPOINTS

CURRENT

displays

all

Breakpoint

Command

currently

defined

Display

currently

breakpoints.

breakpoints

set.

BREAKPOINTS:

PPOBOE30
(x)
DS>

Example

14-4

Show

Breakpoints

14.3.5

Set

Default

Command

Syntax:

SET

DEFAULT

<argument-1list><CR>

This

command

and Deposit
data
1length
qualifiers

causes

setting

commands.
The
default
and/or

are

present,

default

Data

Length:

qualifiers

for

the

Examine

<argument-list>
argument consists
of
radix
default
qualifiers.
If
both

they

are

separated

one default qualifier is specified,
Initial defaults are HEX and LONG.

Radix:

Command

Byte,

Hexadecimal,

Word,

Long

Decimal,
14-7

comma.

only

the other one is not affected.
Default qualifiers are:

Octal

VAX Diagnostic Design Guide

For

example:

DS> SET DEFAULT BYTE,

DECIMAL

Set

the default data
length qualifier as
byte and the default
radix qualifier as
decimal.

DS>

Example

14-5 Set Default Command

Examine Command

14.3.6

EXAMINE

Syntax:

[<address>]

[<qualifiers>]

<CR>

The Examine command displays the contents of memory in the format
1If no qualifiers are specified, the
described by the qualifiers.
default qualifiers set by a previous set Default command are used.
The applicable qualifiers are described in Table 14-1.

Examine Command Qualifier Descriptions

Table 14-1

When

Qualifier

Description

/B
/W
/L
/H

Address points to a byte
Address points to a word
Address points to a longword
Display in hexadecimal radix

Display

/0
/A

Display
Display

in octal radix
in ASCII bytes

specified,

the

decimal

argument

radix

accepted

hexadecimal

format unless some other radix has been set with the set default
command.
Optionally,
<address>
may be
specified
in decimal,
octal,
or hexadecimal, by immediately preceding the address
argument with %D, %0, or %X, respectively.
<Address> may also be
one

the

following:

R@-R1l1l,

AP,

FP,

SP,

PC,

PSL.

For example:
DS> EXAMINE

Display the
of
is
the

08000E30:

contents

the longword which
offset 30 from
base

address.

DO513DO1

DS>

Example

14-6

Examine

Command

Debugging

14.3.7

Deposit

Command

Syntax:

DEPOSIT

[<qualifiers>]

Test

Design

This command accepts data and writes it into the memory location
specified by <address> in the format described by the qualifiers.
If no qualifiers are specified,
the default qualifiers are used.
The
applicable qualifiers
are
identical
to
those of
the
Examine
command

and

described

Table

14-1.

The <address>
argument
some
other
radix
has

is accepted
in hexadecimal
format
unless
been
set
with
the
Set
Default
command.
<address>
may
be
specified
as
decimal,
octal,
or
by immediately preceding <address> with 3D, %0, or %X,

Optionally,
hexadecimal
respectively.
For

example:

DS>

DEPOSIT/W/H

0001

Deposit

the

offset

the
PO000BE30:

@801

(hex)

word
30

base

from

address.

0001

DS>
Example

See

Example

14.3.8

14-1,

14-7

Deposit

Command

preceding.

Next Command
[number-of-instructions]<CR>

Syntax:

This

command causes the supervisor to execute one machine language
instruction.
If you specify a number (decimal)
after NEXT, the
supervisor
will
execute
that
number
of
machine
1language
instructions.
The
supervisor
displays
the
PC
of
the
next
instruction
and
the
contents
of
the
next
four
bytes,
after
execution

Use

command

this

suspect
stopped

instruction.
to

problem.

the

For

example:

DS>

g80@BE31:

each

step
Do

program

Execute

the

through

not

use

the

area
Next

of a program where you
command
unless you have

breakpoint.

D@513D71

instruction.

DS>
Example

14-8

14-9

Command

APPENDIX A
A

SAMPLE

DIAGNOSTIC

PROGRAM

VAX Diagnostic Design Guide

VAXK/VTMMY

S1APLES

VAX/VMS
VAX/VMS

STAPLES
STAPLES

VAX/VMS
VAX/VMS
VAX/V*S

STAPLES
STAPLES
STAPLES

EEEEEEEEEE
EEEEEEEEEE
EE
EE
EE
EE
EEEEEEEE
EEEEEEEE
EE
EE
EE
EE
EEEEEFEEEE
EEEEEEEEEE

[ Y/Y
BeAllGe

1D31D

EVPRG

8eApG-1979

16215

LPAG:

EVPRG

1379 16215
BeAUGS

LPAGS

EVPRG

B=sAjG~1979

16315

LPARR

BeAUG=1479

16215

LPARy

EvPRG

EVPRG

PPPPPPPP

PPPPPPPE
PP
PP
PP
PP

&R
&R

\A)

Vv
vV

vy
Vv
A"

PP
PPPPPPRP

PPPPPPPP

RRRRFARK
RRRRRRRR

KRR

Vv
vv

vy
Vv
vy

AAAAAA

MMMM
MMMM

AA
AA

1323

$13s

PPPPPPPP

119

PPPPPPOP

1133

AAAAAAALAR

AAAAAAAAAA

PP
PP

111
1313

AA
AR

STAPLES
STAPLES
STAPLES

EVPRSG
EVPRG
EVPRG

8=AUG=1979
Qe AG=1979
B=aPGe1979

O3 1Y

MArS DY
DB ILDTIAMLESJEVFRL

B8=AUG=1979

8=AUG=1979

16315
1611

DRVWE (STAPLES)EVPRG,MAP
33

VAX/VMS
VAX/VMS§

BeAhGe1979

10115

EeaAUG=197Y

16215

DR4: [STAPLESIEVPRG,MAP3
DR [STAPLES}EVPRG,MAP)3
DB [STAPLESIEVPRG,MAP)3

VAX/VMY
VAX/YMS
VAX/VMS

16115

DBE [STAPLES)EVPRG,MAPS3

VAX/VM
VAX/VYM!

8=AliG=1979

16:15

3
DR (STAPLES)JEVPRG,MAP

VAR

VMY

GGEGEGLG6
GEHGGGGE6
]
66
GG
GG
GG

GGGGGE
GGGGRG
GG
GG

GG
6G
GG
G6

GGGGGG
GG6GGG

AR
1333

de=llUbelY/v

PPPPPPPF
PpPPPPPP

AA
AA

LPAL?

RRRRRNRA
QIRRRRRKA

VAX/VMS
VAX/VMS
VAX/VMS

LMAVE

EVP R

16315
16315
16115

333333

33
33
33

313
33

333333
333333

LPAB:

8=AlGe=1979

LPABg

BR=AUG~=1979

LPav:

BehdijG=1979

16115
16115

MAP} 3
DBt [STAPLES)EVPRG
DB [STAPLESIEVPRG,MAP)3

VAX/ VM

! L1J3rEQ 3NQ0W SsISdONAS !

j
o
n
s
c
s
a
c
s
c
s
c
s
a
s
n
a
s
e
s
u
v
s
e
a
n
é
I1S39¥TudNA3OdWINYN PvieONT3A0I S3l2A1LdnoT$SIrP8A.0O}3°1*T91u4Y98YdYaAY3T(Y$(36Y7Y3a1YvPaLviSiP]SI1LtIYna0dLQIX 6L6N1OL=9VNY3IVNa)gD36201i8v13a91Tlemx¥0YA1v3O¥Jd3OueNlPRE°280A

OesNdeAnZccsaugsseasa YTysmsan 6L61=9nVel£191PyYTTH3IYNTILTIP2°1eXssensas 39vdt
A Sample
Diagnostic Program

QIHONIW
aIyorvw

¥4318N71271Nv430 3 n

39vd

VAX Diagnostic Design Guide

§3¥d496Av0l1d9

""..'..'..'.."'..-..'l.."'.....".'.*’OYNHSON‘TITVINOI‘UENYIT3IX3
ON3

8906000 neugavde

9¥dA3

S¥dA3

*ouN*yIe
INOT
NG
ONOT
ONO
ONOT
DL e
9NOT

9eM0T

2 e

2 2 2

e 2

el2dvouy ¢levanay

ndvoedna 32009 6npQeoRe 43v00¢
yvecorwy
dvEvnaen
2qiunade vali:anew
Jvedoe Jvedune n32000a Ngvenese w69d4K0g NulABAL

QudAd 9¥dA3

|LEPLY
e 2

2 )

9Mm07 oMo INO" INOT

INOT

30ve39v¢ 66

4 2

39vd
39vd

4 e

I9NOT

INOT

ddd‘TdUd4'3X3ON33OOOOOONENHNNNNHHDTTSI/DBDIDSIOTT1ONOOXSH‘’SU'XNEISS‘NNN’ON‘NUO3'7TYSIIIN¢'/NIH1NI2OE7’03OTNIJ8VT/‘‘1N3/13N83O2TPT1I7UNSON/‘1171‘33NH1¥334O/34SU8V0II7’YYHIN2THOE4SSS5INONONOfff‘N333NxxX333
‘0¥ lym

‘ay Ly
LEMON‘QY

‘0¥ L¥4

l‘yow L‘uqMOyN

18v"

Jd920v08@

LyMON‘Qy l‘¥Q8u LY¥MON‘QY lumoN‘QY

9udAl

O¥dA3

t194dA3

3148 3

9NOT 2
31lA6 6P
3lA8
9NO 22
9N01

L‘UM0ON

dNNY3IN

194dA3

hoenovao
36200090 d92upeae gldpoenve
ni20vb0e foepedue
reQvLALy
wo2oneoe
d
u
e
3Vl
n2voBe2Y
n62oUpGYL TAT-BUT.T \ Lloovgee
npevY2ee
hJI2udde gae7enee 8tnscone
hQeaeedd
wELOVBYE neYvavoe
0
0
8
¢
2399
nne3l9o2v0e0s Llaoveweéy
“i:d0a0ew
AT
TLTI
T guvanden Aondenve
vpdeue G crvdaeed PA0BVERY

39NOM39vdg¢ 626

6$L61=9n9Ve1g

v
L
2
0
Q
0
0
0
n
y
o
e
n
18179uY
¢Ll)2eLTvion £62 0 06%
HJIlves1a 198dA3
Xg9THIviLvVQadTSM1a
6
l
u
o
d
v
e
dLIXvTiuTnae
1x347g9
3aN2IIlvnIo¥LsIaNnIs n3924040 @de390
AHVWWNE
12071834 194¢A3 ypave M

1403308VeadNSINYN ($)37nqow asva
Ia22Te44vene
ACdr

d
P
O
N
D
I
T
‘
X
4
8
N
I
4
A
0
O
‘
1
N
9
7
1
H
3
8
H
E
O
N
ened Vv oe l2canbuy d‘OHNTBON‘T1I71 38/NOINSN 3X3
0d1‘ONHN3NSOOIX‘NH‘EITNI*OTT31NM01N‘1O3DU8‘HHENISTO3Nx3

t£a4g3ax3°9¥dA3([83dV18) wWYE90ud NOILJIS SISHONAS 1 dIONXDT13I8'NOI¥*3NHHENI'?TYBUT2°V1H@xEON
A Sample
Diagnostic

CYATL

94dA3

Program

LYQUMYON

VAX Diagnostic Design Guide

119984ddAA33

e L8 03INIFNIL4TY

193dA3

1948dA3 198a8A3 198cA3 19udA3

19udAS

GA3NTt430 JudA3 BET-LY] 94dA3 9udA3

9udA3

198dA3

9ydAl SudA3d 94dA3 194dA3 198dA3 19¥dA3 198dA3

N4I4N3O8LT97T1Q7919 94dA3
192dSXS13L4lAwAIdITTL74TiLLvTY1e
LH2D8O1XI7W1n7d4T9LT
Ldd0IOLNNSITTTHMXYX""SD LTI
OX180TN170H19e8733191833871

SudAl LET-LE 9¥dA3

198dA3

39vd

M
287t
€674

1ensTyvY

QHOXTMT
9

AdELwdTMLTLY

LaONVA7sWDITPLUE)TE INGNEITLTLO 19¥3iwd¥1V INIL39TLTLS H3ONTLTL1SH¥393947L7 2ENSTMHTY

19nv430MCAT1Y) QZISARYITNT2185187570QD9N T T Q9¥SITMT

AN3S

202000800

1£24630X3°9udA3(637dY18)

LQQ140X90I8447VVvAVNINIT Ah0eo2R0R2V00

42Y0a0?08aepBEOLOER

0v5I5S000000o1:9uynzYqIcN»EuI»ATaLIcT

80000 QYZISAWITHNT

2T310nLt»i403932Id22S020Tg0000)e200000038a0L0000 LAA1990Y9eL1OyyyIWIsNn¥¥RLIv3TvSSE4TI@IAG3N1NWAP6qTMIN8LYTTA1IELdNTILTE 1deOnNsTHyT"Y9
v2aS90000900 1L09%e=yyd!oLc1MYacYXs3I=ciinsnWgndYdcIvoMvancacansd!

anva

¢donvsencsvacsdosasand
* °8708mWAS

aL2€024030ax030*9udA3(2A8aN3n3sSdTvMxi"sy] do18TMN'9
Y)29C9g1T2R0t343))I2s22TL0o00LTTcT02o00IToIIT0e00T g9A41LLQ99=9%09G=N~MyyyYyy=yLBMLNNIMLT1 TT¥9IIANYAOTNNTXLIOA0JWTTATLTEYXIVSTTILILTTILOYT~
8724P]6891LT03635229-9980LT60000o03S0800o000gT00e00 =1L12H19IiYY68I8=Ve313L7y=y101Yy01BLN7yV2iYAyTLM 178ASUXII710dITS18NtX¥NH93ToiT=ypnLYTdaT
11}} ==- =¥ « 3I03V7IS8NuvIi4Av3IiA0N13y 1!
A Samplé Diagnostic Program

9vd

pNI2NtaINx

TYILI]Y

2Oa18N09YW=0TOY0I 1BL6H590IOV0yN0T

€1

gt’entoutze

enawd

gt*tetontae

°2n

YXT
=4

-t

Guide
Desig n

VAX Diagnostic

3ovd

=12 6§vd

1S108WAS V8019 40 HIEWNN

pwue]uUbeod}IN)3NZ0J}QNE8pSo83y

A Sample Diagnostic

6312
22¢

o|qef30$3U03U0)DLYACL]LYSLERL

suojeae|38Q )G#nPauOleAP1v4B0uON8nyg

aen non

(91)
s

9¥dAl

1 Sé

ct) (st)

Program

wapw 9¢ i
Ve

6A{AtyY

¢ L2

Jiregdt ‘g

VAX Diagnostic Design Guide

9¥dAd
vy e beue

B¢B9U14RORJQ)USO|)OIQJUeASSOWPOODBuyO,JBOUS)IAPJUORLNWEO/DuOJJB8OIJ8OJCI0O3IUU)|00'004044)
IVE)VS

wern

ey ¢C

2hed Gaey 2iand Cirei

9y L9 w9 69 a4

viduid

[1d'ad

PRfoA0vvdeYneraca1eT Waey

TYMEL

'd [

aperod

S6EL616=09N1V9a1y

°1 169 {20 3040 BUC

A(e JQOIdWLvNSyOOsENaBOlTV*BIUQS\OIVM<IyICIvGvwIdAaAUnNVTVHdNE3BBIIIsTT>IE+S2A°SSA8IN"OVIAuw(nlS)
4LT LR d1288S$aOGu003nNS$%¢8$0sTKT4XN4MI1IH333y74TN00x0uvYS7I4"14o0Y8NvYa037dQT8”=z72x430W217 ¢¢¢¢§J3o|8(SJXIeu3dsejBOU9ajuJBj8(ddUoY|3u;oreAudw2o5ey9See)J,duJaO0(wde09Oe9DeaNu88USj4}3d(|)a8jiQnpAJLBoOdogDudeVj)S[d/qsoAOUJnuQ8Odswu1{v)OSAu00J3BSeQis 2Q)jud4uUAATJISS$8OU3ASSPN0lS8R,4J804XO30Q)3|9L8IAOW

J}380UBE}Qui.0ud91duex3 ¢peepine|nabu3dLl0I4N(|8I0}Q"TyuNHAt7'SeYOso18=x28€h ¢Xva0xoyW%OJ9)09UO|uBoUjRaAeUzCjDie)OPaOjUuWp
A Sample Diagnostic

AD0xjdJIRsvOJouIWbAQeN)jTq J‘(IWVAO0IUSOD9AJ

eoeueRad

1%<v}S.-

Program

9NOT°*82 !alqeagyaBuUe|JO4GR°nhLpQuaoduwonA

VAX Diagnostic Design Guide

AJLdvbQadn‘=SL §dJOfUojwUAOR)SjOAIDSJ

sa0L¢j&3Jqx=u)I!eidjNueD(wenNs

tovisvT

1
1)

BALQBR0QyVA0 Itavpyeodesae B0veORvABYnLY nL,Be80VvCRdLER JQD9C0NeRA2YD

gsuy

G¢6bL34€i§1£02ehl9L3

1O‘93ILN¥X3YJ8OALIMS4TO0L°EN

B2eENd

IRy

,40000V0002LON0Y, 0,V3209

node2agvh

L,J080 0 3 ne n

+*
+

13‘i93Sv8I¢d1’T

Sdued

9¥dA3

Avaet )Ay PIAl'AY @Vv

A-12

Nty

(ALTAS
IRR U

§Ui

di P3RS
S6

+4¢

¥dAl

jSMaIlsLulsv’dSIuadQoiTeasig olqel
A Sample Diagnostic

gvl S¢l

YI]15 cuFroLey

A-13

Program

glenCIq

%iqeimg03JOJU|Od4Osdupe T IVTP nel navn 80BL0eR
A|LvgRd §R1 am!

3148274709 21 gAPR

13gLa” 9709 §21

w4ey!

A-14

VAX Diagnostic Design Guide

9¥dA3B°1A
nSs
961

861

#S1

V60 povy -I

291

491

el
St
LL
6l

141

nyi)

Yoy

tans

24nS d0ls

L1 Sit

1737849 %812 LIX3

w9‘1sL1u3I7Na5It3¢VTGYs

641

lLel

evé

gne

2349

P4 L
¥ien

A-15
4

viné

re6l
TR
9ol
Bb61

lel

r4-}

LRI

éul tel

tel
9%
Lol
861
16%
bl

Iul

¢
,
8
y
|
0
3
P
p
a
m
M
O
|
A
Q
d
u
B
N
,
)iedv1

1e1

051

Ny TIONYW OITLYAY

LThyedpbyAPyutLdA

|9(€Q0®IRQUo}3238g PUWO)wa39JdJdIJUl83J)
|180204p8mO117|1337A7sQ8a0s81,.L‘d¢I0ulxNu3u7Vwe§e>]10‘804JOITdROJNRTUHOTYPOCAL*.d0s1a8nu
1$5¢ 17137803‘eu2uVe® "9126N8 sen

D}380UBR}QwRuBOWdd|Uw¥x3 146L8E1]HNEO.Y311117|7729033037788P8784UI080°}3M088O|J‘‘8‘‘C¢A<IvuQuuJiftSvEiuuaJ®uvvTUVeeIeY$®>?AD,92,YUYEONiLO1uTSuY8""‘30%dd94XOO3NN0TTfJNNY1OT"gIY9NReJIAOPOCA11$L1o)4n*w28N8u
A Sample Diagnostic Program

<\d0i\>»

L1IX39%7se1a9s

O?N

VAX Diagnostic Design Guide

nie

1te

vg1eil2

212

Ai ad uward

2°1A

A-16

VeLeYRY

+4!

222 g2

nQgy

nQun

ABAL

née
s2e
922
Leée
6e
age
1g2
2¢e
£€2

naes ..h

ol2
Jee

L
1
8
S
°
[
9
Q
O
0
1
9
d
I
X
I
L
)
A
2
9
5
W
O
NSN§SIn97SMN«CKWDNl
LTIV

A Sample Diagnostic

94NDY*

vee

INOTLI3S

cLauod)

Program

VAX Diagnostic Design Guide

LayyTl
913.7¢

NLNIN

<liNL?oTILILaNNICONNndN>

BE°2OA 043K TTaXVA

nte

\9TILN

\9@ad\

L90dyTMLfona" L niTMy

13 8¢"
+

une
gt1
3%

n4Sh28oey0

2 1A

94dA3

9¢ 131

itv 08 NS SN

Afp

niee

WO }300g Ixel (PQOLY

[}

131

9¢ 11

e
ige

[

A-18

gns6n vole

ryopeoRe,1810830,5081000,VY81000

A-19

ns 11

J2 18 ns

113

t602ven§rs n&N2ancSy a6neyashr J162aehSnd 82&13ehS"n

NS |1 4

I26€1nNA

143+8610@4
992

s92

292 §92

192

662

gse

962

nse

2se

$%2

S nS 6n 2S LS S40 2v6el1e0

31
o
141 ns

CRL

L
$
S
1
G
T
L
A
D
T
L
T
nS 6n 2n 9nid

6he

131 hs
ig hs

1€

162

Zne tne sne Lne 82
wse

L19463LA0T1IT
TN

1€ ns

3
Je

E
/0T1TTRAN
11116723120 ¢TLIEPTLITIHISTL
e \GLIQ’6L18

I6
IR /RTLIOISTLIAN
8%3T4
‘T I02TLITIACT
« \gllQ’6Ll1

‘92
1062118 0ELT0TELIAN
T 211082i18
= \h2iI0¢c

SE363:91 6L61=9NV=9

Q¥dAd

A Sample Diagnostic Program

1ti9s8yTVy

£S1t

4.1 6l

LA
"l

an
ve
ni €L

92L0

g31a 319

9.
ne 4

GERL

nee
182

g6e £82 nee 562 i8e 682

ee
2L

Sum

982
gee

ne ni €4
22 ne
ni

S¢

tvle
41YY
Qe

WLYI0A L038l gnQlo

el
2l

89 2L

o929

B 2s

¢lS9

89 82

8°tA

§i19

£n

£S

F19

9L
al

4¢

F11

£9

)CYPTY

gL¢ 6l

9L Lie

as S 98

A(IW0®XOSQ9L

eLe §L2
Qs

9610 9014

Jod
1X-Y4

1J03s4*

LA
b3¢
wLa
142

RETENT ML)

PIyda0ONTLTLY

LT L9
120A08WYT

PIyu303NT4TLY

383INTILIAOTLTID

ON\83jA8pvairsiBau\¥OJO

VAX Diagnostic Design Guide

2lez 49a2l

:B0yJRuJO)SIUPWOIRIESyPISNO3928UyJO[ewPO'3908S)0

61499689%n2l6w9230892§628N2NwL22S3262530122442211V22g00N9Sn9LSg2é2uy% A%13 AR sdox(X)mxt &\/t1avt
€9S98LS9@2593969nLSL492l 2gen

H¢L93SO96029Sn9l3S9L6492nlLwSL23S9v2iL602909lq1v8d2i9d ¢¢PPRRIICRLLJIISOOOSSy}}OI8J8e0EW|UOII;NNAOIISNNIOOUI*L‘SISIIULUPIPWEWRAIIGENAIIJSSESBY)JOUJEIBESBIUW'BUPINOIQANS
Vet
et

nt vaévs

Lo
vee2
662

]JPw4ie3J08dw0bluOBdxOl

df neey g2t

42 12 .0 ei20

Jiev

heg

Ticg

2Lewn

sgLe2n (TY-Y4-'

ve y+20

61§
141

17I1A9XIANYW AST

13x3aNv3I7LTL9

vgew

L1s
ule

8424
Slawu elg
siea
[B81
Siay
431
sien nig
£
qlen 91¢
sig

$3IXILINITLTLS

nt 4528 LPYIMOXLIWdTLT

vaen

-Y-Y4
962

72 020 y

R¢9°tAnL9 S9 OL 9L|9s(n0Q0€2I@x2al42v0)1238.09 V2w $$I18Aa2dMXLIILNWEdT2TJLIlTToLLsSYv* I\ tpe3deax3 \N(X)MX)
S@g¢8926@26&2288£9§9S8S8224L2(L2S5S188¥92%S1&102@nI923n21vv2gg©2n,vL98Z a2J29n5e2gé89dw LPSENILWAT1L3TSV° /t 1at®den wx!
I
1
I
0
8
V
°
*
/
I
\
(
®
}
p
3
p
u
l
B
2
S
U
)
A
n
0
d
4@g2/2431L192913Q3929486nQ299ItShSi29Ll3€£2n4S2lL5nS¢41299L2£3Sv32992l3SS"3n29L92844S§2L2LL9S1€A1n2299L2JS64S90L2d96tQ9VuH3e9e2E2edY14t JJIJJsSVv° *°*/I1\dANJUOWRwEN|gYOuuw})I3Ni0JOoJdos\/1)°I\Np/0P1OO°Y3P9NOy3OIX\N®/J1O°XPdO3INJOX®

)CETTY

A Sample Diagnostic
Program

2o1A VW]o@j}ae2}89P0 |OWO)VS5Ou1yB8D2°$4839P8U00OoYujbIee2)JjOeB)}aAvJ]RTN8Spo)8|95Bj4dBUINOJ)mY3@TVSUOHIINUABU)
8¢

9J2w)N,IlBJdOuUBSAeORx)3J(gQ
s3en X417
2
nes
£32v
g3 92¢
CET4Y
L2¢
g3aev Y41
HeL
§32u I8¢
I€¢€
e3ew £4¢
441

$3en g3z

g3e¢ S3e £329 $32n g

g32n e3¢ 93en

Lrg
ere
vSe
18¢
25¢
nSt
1317

131
tng
nng
Srs

sJuUoONN

dduuUoOyN

J$snvdouwube]a

§324

S3en
§329
g32v
S$32v
$324
g3ev

Sidéh
§3ev
S3en

YUON

0BYSP3OeUIa8uLUoN}JINUyDYOB®X3NIJDOS

nes
St
9¢¢
Lss
e¢¢
¢6%
A

VAX Diagnostic
Design Guide

duON

22
Sa

s32n

£6¢

144

4lve6loe
nig

Yie
LLs

s$ig Sle

44
64
vd
na

vig

i9%
95¢%
69%

vt L€
el

6eunw
LAY

2u d

vL2ewn 9t

LS§

S9¢

810 10 0 46

F1.)
ad

J0e9

43,J¢340 0

w32y

vAoe

§32¢

|@pI N]) 9p0J)vaneevd
UOjIeZ

Si1s0.29S0A7§SgS8TGvuaYHdNEDITT -!IUOWIJOU)S8edIUNO
tx7a21vI1IND

QIVAONW‘NUAOMI®TITO9<OWTey, ¢¢ATMnIjNeIsW4EOYWJUONDOJ,0ByOUBJO
$71 v ‘2% QUVHd9$SAme

1$7D13v8)d° “ONNEOSTHYIQZIINWIINLdISNIAne

PE 20N Sdde, TTlaxVA

J¥dA3

A Sample Diagnostic Program

@u©3Re3|

S9‘Yd(O7NdISSVQH)e 8310=4:74V0TVA9

84S01600

IN1OTJ4a3N8Y3¢TI°D

SudA3
A-24

Lin gin

eln
nin
9ln

Iin

19 %4 ol

§32wn

g3en s32v 632

uen 1an ean gAn

§3¢ewn
§32w

66¢

177
6et
06%16%
26%¢

ney
94¢

$6% S6¢ Los

Im Sa Sh Sa Sa On St OSn Mn Ba

nen
Quity

Gu Sa Ga S4 Ou Gu GL Sn Sa Sa Sa N4 G4 Sum S5 0% Sa fu ¢u

11321 s8¢ Lee

g32¢

q3en
CET4E

6lLE
wig

Sn %6 Sm B4 Sk Gn

nét
96¢
86%

glr

£329

§324

IMVBgdod

2en

1#8p30}$9

UON
ddUUOONN
duoy

dWON

IXxTaNTNY3IND

auom*®17/'3

41Ys’ cnaued|) #p0)

¢ A¥LIND NEVYW

VAX Diagnostic Design Guide

oln

§£2h nen

9en
veén

€32v

6320

§32¢

Lan 6en vEn

SEn LEn

g3av

§3ed

St Lny gnn enn ulh

1Sh

ésn
nSn
9Sn

n b
enn
]19:1
ehn
ghn
ntn

Juoy

duoN
SUON

¢h

2°tA

A-25
fe

'.“
LABVHWNS

SuUON

I$8N49G30uUbu]Ra (31G8;3un90)w}] o31u843n0awI}NC]

t£an

SANVWOISNUET

wV3d At42e $XTANYRWNS

¢32¢
§324

s32@
§3zu

§32u

QUON

1£%]

4%}
3%/}
nin
n9t

SUON

¢30 10 0 46

2en

1
J
3
6
¢
°
O
N
O
T
P
A
Y
V
H
K
R
N
S
q
u
o
m
"
*
S
k
,
¢
A
N
L
I
N
G
W
E
V
W
g
y
M
S
N
e
I
X
I
A
Y
V
W
M
N
E
T
L
T
L
D
nd siac 917vD ‘(dS) HVIUES GH®

§d2v

AvBuwuwngYJy4OUIWROC) §TRININGT§SIO1SVDIX‘FNASNYHWN8SiTNLITNLdOSaRe2843Bu}aINOYUO)INJEX®
el

9¥dA3

A Sample
Diagnostic

2ANYnAKISOgNET

6Sh

ear

JBVg0eY v0udn0de

CRIdY

94S06120

Program

auon

SUON

312)lowIslUuOoHNt83ncu}

1418S° weubOJdg $9u)INCJIQNE

VAX Diagnostic Design Guide

SUON

suoy

§3¢

Son

9320

1114

16h ebn Sen

9t¥dA3A 8

g3eén

nEn

E9n iin ein nin 9iln

nén
Soen
1Y

98n

§3en
$322
S3ev
Er4S

932w
S3év

§3¢er
S9dv
3e¢ g

99y

68h

L 4

A-26

$32v g3év §32v

OudAl

8°tA
«2 0 «820 B30

34
§¢¢
nes
8¢S

Jevi

envn

91vJ‘(dv).hxom<amono
SsT0SASHYIT ¢(®3@;JOJ4®

JgpuP}UpaBRIWONe|YD
I4H3S¢NRd S‘ASWHYiIVSsUENe T9N‘IXMOieLsTnyTC9

névo

LY$1INIT NINOLTITQO
AAOW

|BPOSDIUQWRI}S}NYOUIOENDST

44
|

4@ldoe6loe

92¢

1ansvLav 12oenVsT tLd04y8T

43,nlo000
nes

Les

1§86

TAOKW

asy

slg
61§

neéni

T4
628

Qiua

ngei

¢2s
2es
t2%
n2s
82S

nis
s1S
91s
L1S

118

Stav tls

320

Sved

Qq
Qa
Ga

80
62¢
618

19§

43,n1h0 0 0

R
E

1]PY-14

138V ‘@Y ¢ap bE
H
S
N
e
9
%
H
S
N
e
e
®
H
S
h
e
g
%
4! TvE09 ¥ON¥3 1

LPAMYINAT

2s
he

eng
n2s
Sus

1473

A Sample
Diagnostic

& n

Jevid

aey

Program

L9%

OSn

élLs €LS

LLS gLS

28s L85

S8s

nes

6L5
1
18s

31 LSS

69S
vlS

$6¢
965

09s
29s
£6¢

1hg

rss
9SS
8898
65§

14
eSS
vh§
ers
£$nS

S Oa S S o
Sa Sa Sk Sa4 0n Su Su On Su 6a Sn G G4 S. Sa Ofa Fa Ga Se S 4 Su ¢n OL SN 6%

vl
SLS
9LS

1Ls

L d

JLUO2N

2 14

e 2d

lou] PdQ9UUOONNisandu}

ouom® COBSYINE‘CU'2WIN,.

VAX Diagnostic Design Guide

CE!

J¥dAS
0°1A

A-28

£s

J¢

Jie

£d
a0

SSa

°tA

€4

dq
Qa

83valoce

]¥

43.v27060d9

38A

g3de1aee

voeve

vedad

46
1YY
Qa4d
84

3g9.1 L

ag
ad
1]
Qq

n9davo e 48

a0
aa
oe

ae 17

evian

viv¥

83001000

6L61=9NVe8NEIRI9T2080SudAI[S31dVLiS]niuvN(02)

]2)380ubEweJdBOJugP(ouEXx3 HAVINK=91A0TL1T.I9a&SBjuujddwiasvw4O838)3Q}QU}SoJjOUJdoJud®OLW
168
41
fes

18%
489S
695
265

ILyNwEaN0dd B28¥IiwdATLTLO $

blol=9nVY=8 SEL6L19T
H1YHHeNgHES88NNNddde Ae¢0¢¥o%88
MSeNg 24
LI$1Hy7EwvNd2dO3d =S‘yNAENSLHIWXdiTNLITuLdYsSaone§

S80INSUdNIBJP09

gWRJBOUS$9uU}NOJIGNE gM4GvnSSNWENEAdNL&dS‘S3l62Yy¢‘1t4I®nAIaVyLiIETTLI9TODo-¢¢S9B0u3P)qPRJ49O38)B0UHJISJO4NG
$g$Hy7y1Ek1wNevavNG2)0ndd =L A‘h‘JyN1LNE1L7Sn4WH9AOTX43LIg8IxNY13LIAYiN2wd¢dS80Q%owee§ JJujUu)jJuad sebBeesseoouw
SOTXININ8HQl1yGS9HNTwvSua)N0e =L dH‘0NN1X§ey1S¥olhixwisdwTX1dLI7TTNUILT9M1Rd9S Oo-Ne{ JJuOXjuaeieeples ou
TAOW S‘118IvYry ‘NES XIN]¥dSQameJNANLIMOLJILSONOVIQY0SIAN3dNS
aa

268401000
e3e01000

OddAl

p0PO3I8FIPXS epa3AjedepN

L6S
86S
66%

N1YJI2oi¢y=bX4uVTnshgm| oAOnvgMysLNTnLdTEY STAXI-NISN4T h2=¢Yd @dvx3HlSwdNTd1VLY S8TXI-0NINSGT So8Y¢d¥ 41na=y8¢4TM1Taox §TXINI-HLTSAS gWvILHWEANTLaTLO

hes
SesS

LHyno

F1.)

8119

ve9 279

999

Sample

46
84
©d

A
Diagnostic

839vS48S3INASN3IT

Program

geb2eg

VAX Diagnostic Design Guide

(12)

any’

0OWONITSUS

PE 20N 0490y Tl=xVA

9¥dA3

sadojan;odaOngLm
30

A Sample Diagnostic Program

000022080

pLOR100

peoniepe

9800VA0

etoetedn agentleon

AHWLaIWVCSaAWSTTAASSSHH)YID
XTanTnv3ITN)

Q
U
O
M
A
T
I
N
T
H
S
I
T
D
WESKI NLYEW

tveroe0

9ITSEIND

NvLIIETS AM98NdT ININHITWEINDWINISAIDOeWI m INIAQTASIND TQSrymky04 SOuACwMAhWdTSNWAIHKWT AKNIDYWT NAZENTSWHI LINISNETWESKDNGdSNATHWESHD
ao

(<4

puRduned

Xxoroorxoaoox

1Yd0L8T
e.

o11ite21418ttil1e8
SLiite9tilegtiretite
1aite
a9sn2iyel2eallrtt1ee
g i1
62l1e
gi 10

A-31

gel e

sel1869i18il1e1e

n6ttiigtee

1188

rI'H
Wes

ows i6$ NiS

NOdSNETASHD

Lite

0veAvnaY

LYdALA3QTiLL19oYyYyyALTt2eeMIInnNINssINTTTTIMMT
ozuo<u:h<

(AoNq3uSAg oaey
S¥dA3

NES 88

BlUVEHTWESHIT2W1E¢SvHaIn

nCoRBVOR LYT povpoLvel )BT vRBVILALS @8dv0RAn

eo0RVARL

d4d444 greenan

gleanan LPD

g1si1nlitei1e6
2gL10

(L]

2118
eei1e

neRvLYidyY venovivey XA)TYId 7PenAguerod davaeon

poenonuvd

Pudrvue

NCMANTSWHI hveRnvre

PNEvAGKED

NArBtIngd AT Aecand pebovete

Tevowoen Jluvaden 1000 naernero teovavne veQoeave HB0ur0aL

nodVNoeY

d
W
I
N
0
S
A
S
e
T
W
R
E
S
H
u
D
n
k
o
d
dITl4FT3lvyY)P)v30N3d78LOi9vEN7TIST$LRdIIN3MENdDMNST Sl1sneded

vivodouy
¢
a
k
e
r
n
i
g
l
QANYEWTWESHI

Seuenved

IXIVAWTASHI

l04dHITASHI H¥3AIATASHI JlavawTASH) I188ASTASHI WONTIYTXSITDVXHSEINYD LIx3TMys17>XIHTHEIND 12078172 ONINLETHSID 14I3N0V HAVHEVSESQ YIVANSYESQ LIvMNYI8SQ 23A872804N3J7IS9Q 8NEANISU

VAX Diagnostic Design Guide

8¢

vacdvound

6EenoLvRY

NIVWOTS8ANG

1Ad3v1sd7 $3ITA$VSG ¥I01TABYSA vEBYdTALYSA

N$dANIT

BidvRrved VeI

J1C¢0REA

Pe sueny

TME!

ONYE3T198VEQ $9vI147198veQ $38veT198V60 ONLBNETI98YSQa WYNAZQTL198YSO 23d48N3TKWSYSQAQLIvRTWSYe0 $3ITWSYSO LdHONTWEYEQ43d40TWSYSa

W8Q3vIW08l118I3N90I¢S60Q

6139840 d0INISE0 NOW$SA AHJAOWSA 3suvasead diININESEQ XINIY¥ES8Q AIWT3NE80 dvYWi3880 J3AL3680 AdvWnNesa SNiIVMEsQ

¥d3001TT"WWSEYVSeUa

asvdTWEveQ

als1W23rdSL1sYII7ETTvNwQ1HWNe9Ss1vTY8s98vge38QeQ8Vd7ga

N3TA3AT198Vved

48N4LY0NHWIINHOEdH8S0SQEASA

SudAD
|oqu g eLqe3

BIVAUBOY

BovaANGY

NOIS VYS AS
OWNWILWNNSSAS
0v4EIHVlI4iLS3388AS99A88S8AAE8
QIDSEB
AS
mOIOS
EAS
430v3488A8

plyevuy pev2vnen n2eopry edasnvou 206080 enLNene

lYGH4NLdIIlLMV3INYM8BNEESE6SAASS

4ON3V1I38M%S8AA8S

AS
TNOSSYQ2WIINIES
VWIINYI43873880 vQsEE4SSSAS848ESASAS

L Y2610
Y]

ANYW
HNS
01VSE

FIESRlM L3w n"1aOn UvInviLunyTMl fhu'L LinTe
9Cexn"4

dDXWILISYENJEEEMTT3TOYAL8INNB1YIO3WLINI8HVLSASLNISSMN ST PUBEANLY

ONTS¥
S¥vd 1vd307

6Gonean L6T=9NVeE hEiO0tol
144l

40Xy
cOuY
%edy

9134

9w)|W3J8eu0LBb¥OexU|]d(

E12SSSdOxdXXVUXVIIEYEANNXNXNiITAIISNNNNXGdIGIINNn2LNGde4a]NINdG eJULNCRTLTBORR.TNU0e
ESSSXLN$XINIXdXILSINXNITINdINNGNdNIdd9NY886L4d4ddTa
N4SSFGdXXdVII7SNNXEiIIXINYANddINQNdIde MMorsaBe

QudAI

43G0NTASHYd

[SLSNsOyyYuIQvvWvguddHdTAOSX3gS3euTi0HVSA7"0dX1IQe3
A
Sample
Diagnostic

eSevtepu pIeatonen

8N y

Program

XXX
Y o

reCcBONLo 8S0VALD 1elaney vivonved elepopd

ooo

eanvtpon p2ruten

IX3ON MHSON 127
3AX30N ¥WSON 1T

13y
ekl

DD
NOID

i
asn

140N
140N

(%9
(°L

) we
) Le

$93Nqjdaay *oOn 12394

(*2'2
(°he

)
)

haeonenl
glavepre

uyojaedofly

susuy 1J38d

ANYH AS
oy
Qy

GELHvi9l 6l61=9NVe8B

XTHI1vdS810 INILlnowens

O¥dAS

gdn9NNvYi3v1adT

VAX Diagnostic Design Guide
114

A-34

J})380UBE}QWeJBOUddL0wex3

3ANTIVA

NiS

¥=Jfuyeane Y=2ho008 de=hioR0dv0 Y=n20u008 y=62000 20uangvon

y3s 88

A-35

£lile ni le

helle

hovuQoeon

(et)
(el)
n

(st1)
(st)

91n

aen
910

nESe¥

eti
1111le9

rt)
(02)

one

(st)
(61)

#llll!lll.lllll.# ¢oancswnsastonavasassennd 410Q3TININI 2(1est (/31)1 L(nts)(Lt8nt¢) (9e%t) l(ev1s)

ALY1o¥yINT1IeInTNs1T9TMY
3al2AIQTY SUAkepuoR
¥=J200p0ne
€
a
s
(
a
t
)
d1110aN3avau®y
Y=BS0euveo
lenvnovos
eRrvoenos 19 (2)
alite VLT
ouvos
P00t
si1i1eeliletile8 YsdPaunooves
dbpvueetaTveooess
9141LARYY
0
v
v
e
d
u
a2i1e
ooednvnupuevnpepve2lnooosses
es12i1eoeli1etaaalliilee dwdYgeovnAnape
9el1sLallei1e sdol
R
B
o
B
N
A
R
d0eaneueoe
6nite1€410ogile2i1e dJdVloonovds
vRosu0o2v0rn080200oa9rnnnegssn 19 (2)
s

AN3S

NSS
$¢8
1i¢8

s
Hes

M068WAS

11200400
2Ltst (tertl) nen
444444442
8ncAud00s
Sonveo0as
1enenones
PegBuBLRE
Y=00B0oes £aS (a1)

804102.UBJO, 430NOTLINT
2
0
3
0
0
L1YYLdI04NiI8T7 nes (el)
BYuenouds

O¥dA3d
92

A Sample Diagnostic Program

(12)

(61)

(62%)

1(29)

£1 8

SKMIQUYMY0IT ABILHANEs

ILSSSIlHNOEVIIAAASININUTNEWTTEEWSWEKHSHDHDD AAAsvnrp1eh9Lhp0ovna6ss
JQiI0NVBEWNTWESHDI BeYnNuYdEeVeA

dT6i3Yl)1N8OILINGTnAEceoArRbvEeodsr

P8T1R9

NS2NWOIAHM8dIANSNENTTBASHTZWEEWHSNEIHTSDHI nRAvZeeBoNa0evBErngYAgriLdouVseE
YHA IATWESHI neAvgbage

VAX Diagnostic Design Guide

A-36

cY
¢a

(2)
co

(¢)

wihINpINiHrITpArSIaNDe 9SNu2AHBTVRHNBDWET FAdrAoNaHrITuHnEdIsSHD wJAEWUNdHVILTiWgEeSHD wOeLsArFnApTWnEySsEHI 2NL0IvYnVEoBTRnTeWSsEHD aIdXIuVdATNnTgWeEHI AHWgoYEvuIrSTnAHnNsIDV30oHgNhIaAvTAW0IESHI

]@2w)le3oy8u0BluOUxubdY

glagnnos

nliveoids tluviduvos 1ldbunpos tdnvnpdne 8uRvAve Yvoiyl L8vbuvros f8vbuvn ehvrecas TPR

[}

O4AL333N0I0TWH490L3NIS8Ty7TANEENIADND Ahleeendwdvdoumrnnpivitioyosee
HyvOiIvvlYavExdVsSSvIeOOa AgeBrUnAtTvRdgYd
q¢MeQdNIi9ESAg9nNHTNsS%o-vYS8EeSsYsEdUsa gCdLEeARuEPTR BAIHEuToeIY]

A-37

vee

w12
rle

(2)
(¢)

(<) (e)

®)

hen (s1)

9¢1
tee

(s)

(%)

(s1)

gee

(52)

Diagnostic

el
(é)
(S)

(2)

S9 1] S9 S9 89

ALINPYNAE eLR gvactoep
()

uel
Vil

(9)

6L61=9Nnveg nEtaniol
gue

té)

rol

tve

(9)

(2)

nie
el

SHTASNGD TR AL
la06avssg

(1)

120"%S8I9)
IVdSTHSINI

(2)

(&)

BAdJ8uovLRdEYU28
IR
QWANTXE1EOMAIT9)NEIN)

i2)

330TMNSIT)

(é)

WkLCEEEM)IAXNS3TTI "YnTeH1S7IDY)

FJSWNHITASEND
AANHITASEHD OVHVAS IR
S0NNA1AYAV33E0AHTTAASSSHHIDD Us 28200
IIXIVENT
Stenionds
BJQINVERTVAS
LdAIVPAUNNTTAASSHDASSESOHDHHIID Alorndeos
HnHAWmYYGwIIHWmSNnADImEEdB4TTnAA“SSwEEuNHNwDII Tgvikirdus
oRuneonvos

OudA3

Y1OIH8dNINSSEAATSSATTTSWAWESSHBDHHHDIID vLT1oaarangslnvosryuvTosx
W2NLINISNETACSH)

1HdL4OYUSdIIANAMIHSIOITTTHAAASSSEESHHHIDII Auvduvupe

xHYaLuSTzA<SuN4Du tauevguos

8wmu“0xuDaz~a4H09uJ40UUeud,
A Sample
Program

geb2ey
gee

twe

(%)

Q4Q83dy0uN93vv%8SKI¢1hJdNQ3yIaI99dNWSs83Ii8$Sk8¢slQaQA ePIginCLtuvlpl1uttoeuveneADg
aSSALN3AMQOSivUOduNoAvIWDsd1AOa¥NOsdSWas8Sa6S0Q g6lutave
N
d
c
e
T
a
v
e
1XCJNdASSvN3WiYSTyLi8ANHYwIlLIRWWIvi63NOv3Em0y8aNR8MMSLESTsE8¢Edes0E0QlSQQaT gk9evnVt9aounteT
IQOSOKNOOOxN031NNNViLJT8LSHIlJA7B4a331NVATv809SdTIT7N%TTi911IvI1v9899e99s88V8d88vvYsVVYeSeQsaS80dQqdQQ ]E24J7vCA08HPS33d3E440TvdT00rnILAneB10Lun6yee09L)
SVl1V1OYS9NSO8LvIQ387SYNWW38dESLQTwIW1Y90N8AVv3ISeIQ0QT vdRvJ4sa88gG33lu44ea0¢hv2nyE0gse

T9J3ASaT3nI33sUAN04vE¥SN¥iaI7Y¥eAN3nH3aI88N8IS¢s3sS8s0CC0deAd wdB18Y9lhel1vuuuvo0vdpitltluuaootivtuudJiednye

sDw}|lIJaBOduUbeLOExd}]Qy

Ld00INIssa
IVYMNYI8 Q

9¥dA3

THI§EVd3lNS9Id1Y59IA4EvV3S80dVTHHITTI d190AL89L%V8OvSEV8QEK0YTaQ

08VUd4yJI),
(e)

14050983980SASHNITSC 3dY283s$sO
(2)

govntefe gGudtove yetvluve

¢Steing gnlvtavy unluloun A30et10en BTARP¥ eLTelued ERVACIT) d9teteny

40WKSQ

4iNTIHdES0 SININdS8Q

A-38

te) (e)
(¢)

(2)

Mnadnvio gn3qnuvs
G981

ALY

ldyTHeEveq

(<)

§(£s6eav02e9%)

¥3n4304C90 N80¢
713420 0

(rt)

(41)

(2)

§6S

(42) (rt1)

£9¢

VAX Diagnostic Design Guide

(nt)

(é)

340¢20 Y3nos

wmsmmuaHwm“uu>zm>aau<<rmm“ao<ma

cNANLOvos

1IAIT ASAND

LRSI
SCWSdHAOA0NNNuIDYTNS0H4TT¥AnSYYaH3INSGIWITZIYNVTYhOeiydIevhunLopwIvnopNtoaAss

tdvgave

Jonunhuas
ErdveS
4l
VAYRaneAns
Jivvnydve
HNT33IIdVANA3EOITQTWTSSEASANANSNST Tavenidngs
N¥NdIT$I3VaYNWSOANITQATSAASNAGNT teaanados
Wdprepae
aRr@Ivoes
YW¥33LdSNASsSTTSSAANNID Teovdenone
P
O
2
B
v
A
G
e
n
l
d
u
e
n
v
s
gledvaceos
ITE T

LICTE]MEA
(2)

ASVSQ

Vdndugrds

vAdevycon
idevv os=

td)
(e)

()

(2,

(é)

(<) (2)

AmuI«mN»E4TuHmEaVEmQw
4le0nynes

Buudrogne
tunvvvnoe=
vldboprios
Ag0nneuds

JT3IdAsInTT3WISTAANSIYDSO JdJdtuidvnns

BHd£8Jd38I3l10047JT18vw)TNHWseWH3vETu0VeVwsVQ0SEvaQVUed0aI0hevugnos
n1AAWLSS0ElYVVIYSSdevgQ8QHT1TH1AE13SV8YE77-E]QkQ wedVdtNneedevluyGvruoeceetnngpnoauBaeevrvgudoadoessssEa
$#d¥3LL4£1§030d3dII31¥0wv874O1QN¥NTAdNT¥OiS8TAdTAYTASTRAeVASvAYSSaYSeESYQSYEQdYSEaEQEQAQ
NIVWOUTWSANI

O¥dA3

(2)

A-39

(e)
(2)

id)

(2)
(2)

(2)
(%)
(2

(nl)

A Sample Diagnostic Program

(2) 2) e2)

ALY LuvvuvosRT]CIAkL glvsuvios Jigduweads bdBuBNS 20duwvinas levsrpane

43dNSTESANT
(61) (61)

PESed

2) ()

Jesveae Jlnangs

TdVsu 32d7S¥N3

131

VAX Diagnostic Design Guide

(12)

obed

A-49

(gnLdI29iNvluI)ot"naXs"Y

¥9n82N0t1a0ce

HedPANRA0 HeJNPUnene NL=BANVLYVO

NIQTsuve

Suvd 2307

LIAINTI8NIDNLELTIATMS"TT H=214uavee
W4300NT
EN01LvTHSuYd
dYdYWdS 4301V cvvunRacus
ASYYE 0LV lovendvas

J¥dAd

4N£0SSsSLdduYO3XNTywU0I7SVdHYN$SN0N1XXT4T2XIATS0IN3dS7SXINHXI2NTYINdGdNIINNGGndg1il0naVveeOovvNneaBvnrRaeAYnsSE

81IP1HM884LO9TiO0TvI3N4TNiIwvC3TS39Edd1oYLOndETuVIBHJT,

SXININNIG8Pd LIS AR
X3JLIadONW7YYISSNXXGIINSINy0Gd nrdanBvudunbsze
4WTIINVISSASWNOISSWIANVISAJdT3IaIM1Y8LsYLiNWIs¥NOHlSIINiVESASVIvGSEaLiS3IeA¥NST ST ynseeguattaneew
ANOSSYQS2L01vaSASs vw3dvlv wy

43G1vTASYHYd

eRNonuRYs VOoALagLvos

tuvugnonge
n
R
A
r
v
a
s
N$XING I " Ta
S86LSdddXX"TTSII$SSXNNXXIAIIIN¥NNIdIdINNNV9ddde¢ n2Qpdnys
Jlui2cuos
Jevpngess
NG i

Jerunupue

§34A7SdYd

A-41

(%)
(%)

(2)
{2)

PEERFETFY

1Y) )
69

Sample

tvovoNGs LNAvunuos R]P I0Y1MKoA0 fevRvnga 8E2niung

ALY
V
U
L
Y
=
l
d
e
r
l
o
u
n
u
d
XTANYH
WWNS
0
u
d
=4I
01vEsAS

(2)

(¢)

NOILI3S

e)
(2)

(é) 1¢)

L0MY
904y

(2) (¢)

4dTSXININd

()

(41)

(%)

A
Diagnostic
Program

(%)

{s1) (2)
t2)
2 ey

B62utave sdevinae

111

VAX Diagnostic Design Guide

(atl)
wne ane 192 Ane 192

(1)

(ef)

ene

90d¥*L

.“wp

Lind dON*L

MOIOESAS

nne

ene

A-42

A-43

((o8t21)) h$0e9s

(9%) Li1oz

n(9ets)

nt2 W)

S8B8S4S$§4A03G88T3q90OB0T08Xs8ASSVSYQeVI8ASLTXJ3WN4uNvYiOII3dIiN0YWSH7TAN188TNHGE¥Ava8SI0TEQEdNQT"88ASRSTIOGTN7VS83IQ08T7S 2"24I14 19 ;1 68L29n062S$6i16§9sg0¢1. 2(9(62srn011):)lt2e)) L8Y09n8762tSi01s]¢g9n¢t (i((2e2s9en)12)2t)) 8g6t5n (¢s21) o189

6
%
(
e
2
)
£
0
9
(
2
)
1
)
A8qU¢YW43N06E8N90E7TM8aS 43 "g9sh 2(9)1) "g6stt ((%9)1) pae (o) te2

6
L
6
1
=
9
N
V
e
g
S
E
1
6
0
1
9
T
7
6
L
6
1
=
9
N
V
e
8
N
E
L
A
B
I
S
T
dfeoancescavcasevsencssnnoanscaonasd

SN4dQQ8Ss8N442d1LNFd4IlMaSWO8Y3qAa700O03vg383sNu0hU¥I9YYsWlS88sQ80a0010aS8LIdNIvvAS321Nv84gg1VA3l819ILs4SH4a1dv$eN83NV32¢9eCqI0LN3T3Q6T0iT%OIET3HlVT7A77e87~0sIWOB¢NM0vINe808a8eaIHNqTM8GddKO0sg0IasOI9A7TN8sTs8N8SN1ETMa7QGDaTS0EYTJ)2€132141I2332-3t31131a28v10a8UsBE|QweJBOJaL"o8€22S18ninL6£9n"g16£2NXUie9n§99ayLie9SI1S1Od¢}sSeltgssn%sy3g2TLIdXI|YNdIXu2t((SeP(i(lt2((tie(hs5n2¢2n239nseIx89)))t2()t)t1)1Gt]X))))|80LsngT£o2S2n£86Ln1gL"962f*T49en990£esi915StS0eSV¢g1ghe1t3ssn8¢g2¢X,SY3IY8NYs2(I(2((Y20(2e((nr699Yn2s4n81)")t))t)2t))1It1t)Y))))LIIT09LYyIUeJpg€95gO8att,n1((t9s2s)1)t)) 29o8991h1n0l8yQvw'O¥dAI[831dVL6]

8 049 0o8¢UsJB
002

965

(e2)

(12)

A Sample
Diagnostic Program

(9)

(e2)

OOudeKAJ®JQj|JUBU udewAJRUQ}|80438)303a8]

VAX Diagnostic Design Guide

8S0¥4dIA/831/

A-44

8|qey40$3U0TE43U0D|31S80)3318B01UTuOp)IeUR0ANwLeOJ)dYbOVugO3e0|au1e8x33

194dA3

6L6%=9NVe=g 90121 91

)

45
Sample
Diagnostic
Program

VAX Diagnostic Design Guide

Pool

¢ Q¢

LIS

3AQ PO ipON ¢ 9%

anpe

! [§ LA

$93Q Yt Ujewad ! 1l

Aid

COVD

A-46

80$ 39vd <1>

L1les’ 230BuUC}eue

A Sample Diagnostic Program

Py
s

dT]UGnR
A1aA
A

189°u1dAA3

APt

VAR

114

BurgA

l1lEs®1631BTjesudALO)VO3803

VAX Diagnostic Design Guide

SduuUUOONN

QUON

dsUuOoNN

QUON

Ld
Gn

e Sa

o6 Sm Sum 66 G4 Sa B4 So 04 A% S

G4 Su Sn Gn Sa

LA')

LAY

nian

A-48

& Sa Su Ba fa Ca G

On Sn Oa an

42.,00010/]41Kq 38JayjouwpuUSWOd

O)380uBR}(UOW}e3JUB8O4J0dAUGCu)wEX3130|03 SS§3S§888)0T00TS1SS3H3sL74¥EwvNWdTS¥HQ90¥vQuQNYTIaoHvVOvNTmE4OTg*EN3Sn*®TdeQW=y =nI$<2NY80O4I1/nTy3aNILNnITWOIdTLTL31T9TL7aY197Ls-9-{$‘§@ {¢‘PPeNUUBdREoRPyWW)WJWOOO)DI8)ROJouEObjAURd0JaOesIpJSO)AyjIho§eueP|URUWOD

bahekakal

6L0e

41 4

u90d

Ed31.00y00

A-49

621

L21

et s2t

040 10 0 46

NN
I N O

£0 84

g1t
611
et
121
el
nét
921

‘T4

If1

¥‘4O=nVNafI¥LNSTEL709 yANWgsulNeTnLdT09 ANawd¥Liva9 NALO=NTILNOVY3T aOvWIHAENINTdLTL9

AUINI ANBYW

P8UsSJWyeOd)

0sl

o§T4INI¥dTvSyMAHSeNned A4NYBWGWOITLLAT9d9 -{
vivd3 1 0 118871831

06L561T2=9n1V¢=€801

vipe

nina

T12]0 aadaQd
s 63

0000

edoe0 0202

aty

8duwo)y|d

d43i,.n00000000

183l '1

6L61=9NV=8 90121391 LS3L INIWNONY 370YL SOLVYNIWY3L
vipe
H
S
N
d
8
%
2
I
M
S
N
d
o
®
s
n
d
e
v
a
n
e
4
8
a
H
S
N
d
L
¥
9
2
u
v
e
oveotoese 46 4433..00 00 00 8000 v4é VYgA2OAW0W 23184N7a16NNaL8e1T8I‘7To1AuT9A$9at == {{
A
n
9
+
L
V
4
N
8
A
W
A
T
3
u
1
L
=3
O
N
Y
W
O
I
T
L
T
O
9
o
4veoteoe 46 1433..,008000000a0600s #144i334lQ4 g3u1e374w020§LY$3§7oy01y7t8w1THVa4yVe)s0)N4d &$8‘‘L‘o2NSOy»SWIAA#$3YN05I2dTNULIvINdTIs1Y8Ida9S¥eONef$

2°tA

1OudAS

A Sample Diagnostic Program

|PU®GAL}WUOD

43.006800

netl
S€1
9t

te1
81

t1ins

15ue

1msuT8g4tiNINdTN'SI)ANLYOLTITUS=¢!¢0sn8onuedJxjOnqyouIyeOU%E2p0u(sPqwUBoWldAOrdDue
VAX Diagnostic Design Guide

J$‘IN7IN1dESvardeH

6t!

A-50

1831TUO}IeSUBALO)31803 w¥xuwL49[})dNg0UO}B3IICU|YJuOY8O0}p4BOUINYOOEREJLSOBY1B0s‘8yee0BnsdLejO98dmM(]iPQ[eI®)8yBd83)YN87o|d0)Y0"vdS1)jIS9r|U8xN4eOdWOJA,,IU3NSCM¥TOe*lUy;Pu0YBWIO0S40IyOPB¥ 9)
gye xT18v1IL J
int
R LA
9t

in
eni

ent int

ant

S60

431,080900804810980 01¢8 vdRveoYe M1u0g38 x30T81s71l

01
vs1
181
ast
nst
§S81
951
8s1
6§81

4
L
6
1
a
9
N
n
V
a
g
9
0
1
2
1
9
1
3803GNE 1u0}3d)J4o80p

£S1

16nqeg

4Q83v0

A-51

830 dlen

2Lt gLt

niy
SL1
91
Lit

6L1

nd = ¥83TMTas
SN ¥3s#

8TauvVHYEITSGS

19L201 8d1at4q 21g64deevs

291 £91

891
aLt
173

a8NaSNs98~

HOXTNMTAS

434d.,0348080Q0

pdeeteen 46

LSt

AR
991

191

291

JOu d o0es du

J}3Is0UBEe|QweJBOJd9(duex3 t3esJed30aunds3gwwuxnk1asd}4eRIiI)sNuYf6PULOO6|1I=MT9O}N}UVD=BgJOEP9O65YO32DJ1BO¢Uy1|m3I8U33'0238u0a3NQbNE8S"¥EuXx04Dsxy
43.,0 0 0 01 1€@3 agvey 1s0g EMTMAdOEWWOdX ‘‘9IgQN1I99N0aVOSG)LXXTe.I®HT(‘Q$UuYS68ISIT1TH8IMMNTTSAEQYTNYH9TGOE%SaNe npNeoeS3eN0IyddyoOeLaOpxPsU)p BeW3e3Op0D 4P0O
L
I
N
=
I
N
T
I
T
G
9
H
Q
V
I
S
E
W
=
u
N
3
9
3
8
T
L
T
L
9
N
I
T
N
G
=W
t
u
y
3
0
I
N
T
O
S
W
p
e
p
u
U
G
I
X
S
}
J
T
U
A
N
0
J
d
U
1
4
=
1
I
4
O
Y
y
A
N
G
T
L
e
I
x
e
s
f
e
s
s
a
u
4
82
A
O
K
‘
4
8
T
€
d
&
¥
9
0
8
X
p
e
l
d
e
d
x
e
e
i
e
p
A
j
l
9d444339.0..S,00P0820000080000408 Q44QQ@qga tdL18S343aQ0eeva00ead MHyIYT“HHHYNSEESSHsNeNSNNNddNdddd dN8Y¥N¥4y9H8a80IA3I2S9T¥T7X3AM8MeNTITa#TQTQSO9L9E®TWLI9OF
¢4 L183f 1 L1S316©8N1n7eV)‘1 ¥O‘NWE¥3*1QUYHY ICEON®djxs aN0
4%

o49s,e0ot0o0e 00406
vd Seey 1811871y
4433..,00800 00000 4133..,,00999§¢000000408 18 6828ngee 491€91 MYT) A9 USITHT
1 £} Q9 691 1038 son

8°1A

10u¥dAR

A sample Diagnostic Program

go9be

g40

vd
b4
aaq

44 qa
aa

- eToNVHANITSOS
9Rt21891 6l61=9nV=8

! MN3ONTLTLY9 = MOVOSW
RE°20A 04Oy TlexvA

43,90040406

ebed

VAX Diagnostic Design Guide

7a?

2°tA

A-52

0°1A
B61 Y]

9214

9214
¢U
4
Sa

1 4 $3287

que

6216 ONuS
it1

144

1y
ae

49,80000

A-53

44 Qg

RRN

ELARY

%1
)
SQ1b
vd

LE]

HSNa 28

¢12

rie

1XxvTesTiL

MAC3JEUO¢=0JLd®JeEy)

Shia

31840ud LTS

9gNSNIevsas E‘NE7N39Bv8eS3O4Re

TdwdNINGITITA992%gneTyN&Xo0ydpuBWWODopOY
H$¢183y‘T1S3Ll8$9NQ1n7VsIvVS)‘K2WH=ho‘Su2W§SySiLITTtL7G1LNQVSULOV9NH3NESIHSRQen¢eebesOW00Jo3uU
Gn

I1e
21e

it
Gq

L2
sue
vwi2

L1grPR
ign

3210
921

2ue
gve
&

961

921t

n&l
561

0t0 610 0 46

1948dA3
0olofit161

L9l
g9t

A Sample

4]13

84101600

Diagnostic
Program

19¥8dA3

1S3L $1
oa

X nweld #910 RB
ox

8¢

¥4 3

e txvEsTIL

97V) ‘88 gNSON3¢50%e

E9“NS§ND1B8EvS9ON3Se

LAY 91w

leCang1LxTe ¢pueA)¥s3INC3}30U398403
(e
Sa

wite
LT
vl
vl

hee
je2
eee
22
nee
g2¢
9ee
Lee
g2
Y-£4 L
14
182
ese
tge

iv9iAuQ

Yy A

] A (L

gl
612

512

VAX Diagnostic Design Guide

aensan3Tscs

B°TA

A-54

she

iheIne

XF(L It Sai4

wyg1lawal3oTM¢J8e|PURWWODRpaINDOXd10WOYIOUD

1A8Svotlonen46s 183}1] 3e8940AU0@v)d4Osiy3l18e93 L833IXTIsOarsT0wan39a1~7D6n31Lo5v6*4I1°=9NV‘N‘UeL(ISgdNSD)I9L0S1L’S2v133Y“8e39Xs13c0qNse‘LHMON“HADONOT

19¥dA3

Idl)

O39wI1e8u30BUu}OBeJRxg)ydQ

8919

BbGLH1T2I=N3V8e1g Ls3lan3Tsas

£he

ILT2‘YnI¢w04X1HOw3N L¥1oN3uI6N¢n38NLlB3I1yS

ane

A Sample Diagnostic Program

lpoapcove

A-55

VAX Diagnostic Design Guide

NIVWOGTASAND 810080722

4SNEAICTWESHD 0004 QENYAIYNNOOILLTOINTATSANTAYR0T2ARyeR

Sgw9ildiavtmniesqY TPI0A=IT02ARS0ANS NQSe=0AaevNedRS o*0=0*70809NENNTREXINTGY 0UNYVWK9TOILT

NLYVEHWTALSHI

SY0 t¥b

GIAXSYEST

XIHTNEITD #$W1wiN3T

Lu08YT$IMD

SNLVLISTSINIDININHITWSIND 1dITSINDANINMITASIND 14ITASIND FLVAINVANITSWHDdYWTSHKID

A-56

SWHISWHHMDD OONAOQMSAWT
Q
M
I
N
T
SSWWHHII ONNAAMSIENWTT

NiS

TdITWSIHID

NS 111} AN3S

INIAOTASIND

INISGTSIMD

198dA3
s113Wes

3YA¥iBI8L3vvITaeN1i1II¥0TT'LE7dII3YNdD

9{01Q9u0A3S

§VENBAN0 208nVove

218NE8TWESHD

IV$GILNLNIIIIDNNANTIZ3ITQ9TSSTUSIIWINNSdMDDI"IND
SWHD ST
QNVYMYO
SSWWHHMHIDDONAAGAMJTIAEBWUNTTWT SVRAONR0
SILWCIHUNIIIASNINANESTTNSWWETHSIHD
NQdSNETWESHI

¥¥3SASTAISHI

TAwNaYSEKDT

Pl1ovbnve wIABEn vIveuaw

HL1Y0IdNHHIITTWWEESSHHO)
tdudo er

ruakveae

HAA5vuVeAIBnnee

cuietae ALCETCIA PE2Vnaed IAXRl Livdrvey 9TLYuid 92¢ArYed

ABNBLIVY

§£0

AdANHITWEBHI JdWNHITHESHI

)

J}3I80LBR,QweJBOJdS|owex3

a Y

EYYYIL)
TR
)nsaNXTYIEY2y[
sYYYTTLL
T
RTRX [

d
I

Y
I

YTTI YRXY X(2Y YT)

v92ateve 862910230 gueniang vaedtven

A-57

66Lib66T1==99NnVYe=g4 8905118221338911
Sample

€871l

11"

43138 848

TYNQ &

£2

dWNOISS30711VH3Il1svLaIIaLSVESASyISSASVTNdN34As~S TR
T438732WW03I7IL1NINIvVG8848aIBLS8AASS 89201000
NOSSY
ONWIlL39
vTHOIV4L4IS8E9AASEAS88ASASSEAS £gStntoun
L
S
E
2
1
0
0
gInATa0n
WILWN
01088
MY430VIUE
OWII1DlSIS46NSSAS8ASEAS8AS LaCEIUALTT)
d
2
u
v
l
a
v
e
]
A
L
A
GENBTAGY
O¥A4014Malw4NYNdlVdIiIlM3VA3NoE8ASMSTESSM8tAALSS GATaonalavd
ihnlewAe
Y1L¥382871lxTesvi4-xTesT2 8 La B£ 92130000
vilnondea
L110883741X9T3140 7 lnvree

YtensT
d0L8TMXN
"9¢yn 12ansT207MivyM

OgN Y4038

198dA3

L1WD43974IBWY
LT 719T EYYPYYYILY
FRNERENY

(1Lg1Y¥2H¥499099¥83I30Q319AUXuO3NAE"N7g4IIMT17TTLT7Q4LLTyP73TTL)
A
Diagnostic

8IEAT0 otnAvte sihyian vieaono SénuvuIY v9lvuae gtaveny

Program

STou0yW*1948dA(S3TdAVLE]

VAX Diagnostic Design Guide

LYMON L¥MON

¥sQ1NauJHO3eSxd¥vnJ73N N¥1OQAHX43eS2¥0OnyD7N ¥318QNJ¥HXl3ASId¥O0oyTnN

1JI41d0oNu¥seNnNOJ13y17329H¥HSEON3Xax3QayY
drosacanensnd bPeceasncacsnsnsd

1J384d *ON

|
3
%
0
8
¢
g
s
)
s
d
O
u
A
s
{
LHs1IIN0aJlvL7VsS1dL88S3110 ho0dVy2vg0ooocjdneaetnveceanhaeeoo| S83NQdI Y

96L063T=291NVY9=81

o lalelalalatal

d)e )leo

MMITINL

)Se

(*9¢

) ) ) ) ) ) )

* JNYIE *

194dA3

30848)8A0UAS

heeaond

A-58

X¥g1SSs31tsN¥N3YTISLTN¥0L8YYL"STdd2LevJB=pddX8e0lnBddXL0rREFoCdd0NdnUmssN0e

“iNWAOu1sSSn03s6SWAS 1tnfL]oo3eoLdNponEIoaLoVcvacVAoaRaLconTaecLssss
i4t3T¥N1¢ISl83IeIiNYYgvDvN0SN3I8Ndd)7NEA3OIY1I1a8VT4IIN2y0SSN0ITL87ITSd7IHQ31NIITd27ST¥lQ2T9Sn0o8e8LURodgnc0ALXnvo0Rou0Y=oeeEn0UT0enos0eTDco0oaE0Oondu2o00oaYYP sn8E3ss0P0
V3IS1TIT9LLNdaNdUNIIIIIINANTTNATdWIHEMSA17TSOISIQS4$SITTI0IHMWAH1NNDSSD3IDDII87HNIDD dLJ18t2SE12]Aveolve000unvudooL0Q0oneruUd6agodoA0R0LpeannU0oooadeV0ss0snsE
QNSdSHHYHWAKKKSWHHMIIDDTUHSWTS AONOWTQLONAJHSYMQ4DHQAMTUIWSASITWHVTAINT1fSILt2o00oTvnrpeo0ueRBcbIvoVee0nvuRoaoe\eOedn8T0Eoe3YRRnss
SOHNWAIDINAWNTSEWHTNI Jloeveproa0nEoeos
(®)

(6) (6) )

(v1)
102

hge

nge
)

s(0h1e)

(1)

SHIOAIEWT 400008

tne

212

NOMANTSHMI 208 0

$Y=8l¢oocaoe
8Lt

19¥dA3

A Sample Diagnostic Program

sne

(6)

ate

(L
19

(2)

(08295)
(2)

nee

A-59

()

29 89
@9
29

VAX Diagnostic Design Guide

(2)

0ANYEKWTWESHI

A0SHTWOI vHdIYTHSTID 23¢T%8$19) QEOMAINTHSIND 1307%8179

LXWI3AXHN3"TTHYMES%$I1D)

0
9
2
0
3
0
SANNVBEAU3IGTTWWSSEESHHID
SWHD NASYNT

804)0942UNJO,

voeanacas vEIuAGKAS

WIAWSASTASSHD

vlQveevvoe

Bovoevuos 20006 ponpnvons

a9 29

JdWNHITHESHD HU3AIATHESHI NLYVEBWTWSESHI3dIVENTHESHI 210vENTWSHIIXAVENTWESHD HE3SASTWSHD LINISNBTASEHD F4WNHITASEHD YEIAQTASEHD

FdANHITWSSHID

198dA3

9lsvvdcos

noovagos nov3oands0V0O8N ¥R10vd0es

09 L]

(2)

u0uHITHSIND

@09

HWAYNITSIAYSTTXHASSISTHDI

29 29

NQdSNATAS HI 980 vor0e

418"%$11)
FEMTIGE

(2) (2) (e)

(e)

NIVWOATASANZ ToePonos 8s (2) 8s

Y4T13I3dAdAN3N3ETST7AE8SSAANNIS lePPVBo0ava0evao2nn0dssE= 889ssS ((¢2)) 8‘( s

6L6l=9AVeq 9N¥21891

o
l
6
l
=
9
v
e
p
8
5
3
2
8
5
1
tSgaJ§9dLTa¥8n¥0a3AIlIVnTvNvsASA¥V3aEd7N¥Hay1M~a%VEsynTANav2YS¥3I3YsNin8YH3ssIev3¢SsISeSoas8eSeaa0aQaQA 2dg8AaTDgaS0ElE498L8Av3nan01tGnaP36dbaoEudI11tT1tIt1ED00oaunaRuaYI0evAev00VgwneDye1ALRl 2222221999999 (((((2(2222én)))))) sG9hlT1e ()a an)t)
$834LANG8dQ13lYIis¥H4OAv034n¥YSNuvgW098Hy2TIv8AnI11dY3%¥dOWS$NIE8¥e0sKgN93IgQSI¢SW8%S8a3Ss80iQQaQ0nQQ g1ea)EegvP283)nTnl1ETZ3QvtTv81t0ueouaEo0oLTIRtt1i1RCeaev0Ap0ECLRne0aT6CIdaIe09SRY 222999 1(2((2¢22&)))) 9g2t1
SHTNASNJdW1XA33VwdIMN3aYlLAidHgVAKW4TIlIN1WLi,VITO3SWON1YvM4yHT3N8MWH¥d%WTSsSS8sSEWEeg¢84AS0QSoQAqa0NANQSSND J1I2i0P032gv8#8g0W9o926LsSe4d1040utnl0e00gpIvAaoo2u008ad1tT1t1onv02eNu0o00oa00vn0nxs0dey0 18F28222L%%9999) (((((¢22e2¢2))3))) eT

DA#3NQeuNd9¥83s8aQ 3TA}2UI0Ys120O88U09B90E}(We22J99BOJ4§9((122))3wl16S(9) Qa2(9) nge.(s)t1olE=dxvLAS)O(d8O301K4B1E9°82dBA3TyvW edeg(a91)

3NHVLO8¥Ni0sIvV0v8Na4dvsIn9Es$eSsYT8QvSN089YsQE7yNQI3SaU9NIDPT)J0,gFg)Tw9EHéenauve]YaRnlioA2PP auL8vo0nds4 2199 ((2¢2))

1O8dA2

A-61

Sample
Diagnostic
Program

(o1)

VAX Diagnostic Design Guide

(9)

@ (8) "

=z 99 (r)

(9)

t2t
(9)

(2)

(%)

sQ2e1080 2TOGR0P BLr21ABYTLA TlHNeAB8NY LSTILSY)[H0erdR9d

W1I0LVIvN4$I6EASSAS 0S261Une
WIL 398 AS
n
2
n
l
o
n
o
A
L
B
T
O
N
M4LIVMS AS Y

LQNOI3NXNOSTLSTAINSTLAYRIYNOIBNV
SAN3 T VAPA0RN0E
NeI

10nyove

(¢)

(r)

(<)

911

(2)

CIYTAEL N926t140

NHIL398AS 430YV34848 ONVIMESAS 1lawd13sTM

9gN 1207

WILOSVSSAS
13INVI88AS
WFEEREFEITY
IL S
N9S VASS8AS
WMO1888AS
IOLIWONSANAESSAS
¥WI13688AS
AHOV4M3SAS
NIMN S AS
xx£871L187142sT1LvTaI2ss"7v11L4

985U0J04,09V ¥3dNETSANDW3LSASTSANS LaONYWTdHOI L)MO INITLIOTLTLY 1y¥393Y87L7 1ensTN"S2"an9sTM dIlvday“d3s2071v$SAS
@9HOXTMT

19udA3

Ho=Htd

lLhe=2

1
85

gLt

89S

(s)

(2)

1811X988T3380E4ld4sA9TXS1eTaL0t9T4Me0aUvRJe, l1HeO6VN2JLR043IRL0sNA0NEueRUHYBEo0e
21 (n) L§2=1

=b6ylL661aT9ej91VNeVy O8SC:L22133%911

gweJdpbOu3dy wex 21096uQdA3[S31dVLIS]TiHYW
A Sample

et)

(6) (r) (6)

I(n&)e S(enle)

A-63

Diagnostic
Program

VAX Diagnostic Design Guide

(23)

(2) 2)

(whi)l

BSO8u0eJ4)
A-64

(Lun1e)

112

in2

nte

6ne at1)

g8l

hee

nt2

ete

sne

ete
tn2

nge

[}

@9 29 e9

(8e%)

bupeassnencuasanssnanasi +'.'..."...'..'."

OJdOBY AJRJIQ}| WOy

§SuvBiyo|lBdLBiM®)OU(sBoU)uOeJdgDilJO‘SEUIEM Lg sn

(NP¥2o@[(ApsDBSYuO0}§OopytuTOLo0vLq?ledeR2jS8LudXyUsTVIBYyIAy)WeLeB3UgBABO2zUIeE)JIj$x0N(di)2#0NIdJO(e8|8Ja*MOS{;lAq1sIMO0ea0803UjVPS32Au(O38I0SlE9UAU1A4)8N|NSN49(ISA0YIU8IBBNIJO))NRGSNjuI$AeY1IJGw3TN3jOI)8|0NMA,3BG0AJ81OB)PESWOR83|]MLIT0OUJW3a“Q°S8bPUhABGeUeSyJ)gaAsM*B9|a(s8ntQa0Pea1qbde,O260e2£seS)]2t918ndN[3s23O0B0u8BnSngS gN2gedu2dieculN(}%P'*cuo0,ptrsugOR0eeivi|dLtIJtpwsedx%nnTiEeaeOs9uihpadpdr90Jlnuts¢i1tO]oe2aune|wrcgd‘83P1ZOA0J}3J928®[0eJQ3P5Icp§oLspfw01qnsS(heEOa)*aS't*eyt|ss02gelnSadeLaudPatsRsJt1vgced2eOeo2eo)}ddoaant3Ottds8Yeoyo|ue}psnen8Bj62O5nlu3lU0)9bO|31E~88,=u.90N!6 9uPVOeUn*P2I3U@tRoINP§Lt2(1®8J90T|‘S|OTolqeQuXUVAASCudOy20AP obegdg2

18J999ol¥%|p8qld§puAlle33s9esyeS34AuIQnJMyITp(1P92I|)J3J)I0(NI3BDsaEYbOeuaObE4OSUWL(e4OJONPBIDnOJéJ}8SdAn3*Aw8Je0OJux4w30Sdw2|w°9F1uta2euantPsnIayBnNs0n3snaeYcgBa*LceIsaNntGsnvAatoc4ns)npaOwsWyIGIU}239'8pP0

s1ei6l2*e°n2LgPitEpyTaRnseyR

8 0¥3/61 / 198dA3

A Sample

A-65

Diagnostic

facsensusesssenassasansd

Program

APPENDIX B
GLOSSARY

DIAGNOSTIC

SOFTWARE

TERMS

absolute (ABS) —-- A program section (psect) attribute. An absolute
psect
contains
only
symbol
definitions.
It
does
not
contribute

binary

code

memory

allocation.

the

image.

The

Therefore,

converse

must

have

relocatable

=zero-length

(REL).

access mode -- Any of the
four
processor
access modes
in which
software executes. Processor access modes are, in order, from most

least

(mode

1),

When

the

privileged

and

protected:

supervisor

(mode

2),

processor

complete

control

processor

and

kernel

user

mode,

(mode

the

executing

of,

and

any

other

mode,

process.

For

example,

the

and

1is

protected.

responsibility

@),

the

executive

3).

for,

the

processor

software

system.

has

When

the

inhibited

from

executing privileged
instructions.
The processor
status longword
contains the current access mode field. The operating system uses
access modes to define protection levels for software executing in
the

context

kernel

and

executive

modes

interpreter
is
less
protected
and
debugger runs
in
user mode and
is
user

most

runs
in
no more

executive

runs

The

command

supervisor
mode.
The
protected than normal

programs.

access

type ——

The

way

operands.
branch.

Access

types

alignment

—--

address

The

which

are:

the

processor

read,

write,

accesses

modify,

boundary

which

reserve

particular

instruction

address,

program

and

section

based.
allocate

unit

for

exclusive
device is

use. A user process can allocate a device only when
not allocated by any other process.

that

allocation
program

device

a--z2),

ancillary

interface

functions
file

The

section

alphanumeric

and

number
a

sign

control

bytes

particular

character

dollar

-- An

($),

process

between user

supplemental

memory

contributed

module.

upper

lower

process

underscore

(ACP)

software

those

directory management.

device

( ),

case

the

decimal

that

and an I/0 driver.

performed

1et§er

acts

(Af4g,

digit

such

An ACP provides

driver,

VAX Diagnostic Design Guide

automated

APT

DIGITAL manufacturing.

with down-line diagnostic

remote

employs

APT

load.

throughout

used

application

test

product

scripting

diagnostic

APT-RD -- An automated diagnostic control application used by
DIGITAL field service to provide contract customers with quick
response and effective on-site repair action.
--

address,

data).

specifies

where,

what,

contains
the
address
of
procedures initiated using

channel

the

will

operate

the
base
of
the
argument
the CALL instructions.

establish

the

necessary

(e.g.,

convention,

(R12).

that

statement

command

argument pointer -- General

assign

within

independent value

argument

1list

software

AP
€for

linkage

between a user process and a device unit before a user process can
transfer any data to or from that device. A user process requests
the system to assign a channel and the system returns a channel
number.

assembler —— A program that translates source language code, whose
operations correspond directly to machine op codes, into object
code.

language

asynchronous
to

system

user-defined

notified

AST

routine

occurrence

for

the

routine

exits,

was

(AST)

asynchronously,

executes
it

trap

service

specific

AST

the

interrupted.

event,

routine

system

-—-

routine.

with

event.

the

when

software-simulated

ASTs

enable

respect to

its

user

process

that

event

occurs.

system

resumes

the

has

defined

the

process

the

point

When

the

assigned

the

and

AST

where
by

contain the address
data structure.

1.
The
smallest
addressable
unit
of
device can transfer in an I/0 operation

for most disk devices).

interrupts

base register -- A general register used to
the entry in a list, table, array, or other

bytes

interrupt

process

execution,

attributes —- Various characteristics that can be
programmer to each psect in a module (e.g., ABS).

block
-specified

user

the

data
that
the
(512 contiguous

An arbitrary number of contiguous

bytes used to store logically related status, control,
processing information (i.e., process control block).

other

breakpoint -- In diagnostics,
an address assigned through
diagnostic
supervisor.
When
the
PC
equals
the
value
of
breakpoint, control returns to the diagnostic supervisor.

the
the

Glossary of

boot

Diagnostic

(bootstrap) -- A program that loads another
into memory from a peripheral device.

(usually

program

buffer
call
a

temporary

frame

—--

procedure

data

standard

call,

storage

data

Software

Terms

larger)

area.

structure

built

the

stack

during

starting

from the location addressed by the FP
to lower addresses, and popped off during a return from procedure
(also called stack frame).

channel

device

unit.

command

file

—- A

logical

path

connecting a user process to a physical
process
requests
the
operating
system
to
assign a channel to a device so that the process can transfer data
to or from that device.
user

file

containing

command

strings.

command
interpreter
-Procedure-based
code
to
receive,
syntax
check,
and
parse
commands
typed
by
the
user
at
a
terminal
or
submitted in a command file.
command

line

interpreter

(CLI)

supervisor

that handles
the diagnostic

terminal,
The CLI interprets

The

command

line,

string

terminated

typing

command,

and

complete

command

portion

diagnostic

operator's
to be
run.

typed

positional

file

The

the

commands

command parameter —by spaces, such as a

communication between the
supervisor,
and the program
the

operator's

operand

specification,

option,

command

a set of continued
lines,
normally
carriage
return
key,
containing
a

optionally,

information
modifying
the
command.
consists of a command; its qualifiers,

string

for

concatenate

attribute.

(CON)

concatenated,

are

delimited

constant.

the

any; its parameter (file specifications,
their qualifiers, if any.

modules

terminal.

all

program

psects

assigned

section

the

same

contiguous

example),

name

yet

addresses

address space.
Each module can specify an
The
linker performs the necessary padding
contributions.
The
base
alignment of
the

from

A
if

any;

and

psect

different

the

virtual

independent alignment.
of zero bytes between

resulting
concatenated
psects is according to the greatest alignment granularity of all
the
contributions
to
the
psect.
For
example,
if
the
greatest
alignment granularity of all contributors is a page, the psect is
page-aligned;
although,
some
contributors
may
be
byte-aligned,

others

word—-aligned,

etc.

VAX Diagnostic Design Guide

condition

—--

exception

condition

detected

and

declared

software.

condition codes —-- Four bits in the processor status word
indicate the results of the previously executed instruction.

that

condition handler -- A procedure that a process wants the system
to execute when an exception condition occurs. When an exception
condition does
occur,
the
operating
system
searches
for
a
condition
handler.
When
it
finds
the
condition
handler,
the
operating system initiates the handler immediately. The condition
handler may perform some act to change the situation that caused
the exception condition and then continue execution of the process
that incurred the exception condition. Condition handlers execute
in the context of the process at the access mode of the code that
incurred

the

console

level

the

exception

—--

console-based

standalone

context

mode

switching

condition.

another

diagnostic

program

that

can

run

only.

Interrupting
activity.

the

activity

Context

switching

progress
occurs

and

one

using

the

process

for

process after another is scheduled for execution. The operating
system saves the interrupted process's hardware context in its
hardware PCB using the save process context instruction,
loads
another

load

process's

process

execution.

cylinder

surfaces

hardware

context
The

tracks

disk

pack.

PCB

into

instruction,
at

the

hardware

context

and

the

schedules

that

same

radius

all

recording

default -- Assumed value supplied when
not
specifically
override
the
normal

a command qualifier does
command
function;
also,

fields

system

specification

file
is

not

complete.

default

disk

The

system

files that
whenever a
name

specification

that

disk

to which

the operator creates, by
file specification in a

device.

the

string.

system

when

the

writes

all

default. The default is used
command does not explicitly

delimiter —— A character or symbol used to
within a command or data string. However,

member

the

fills

separate or limit items
the delimiter is not a

Glossary of

device

connected

The
to

general

the

name

processor

for

that

any

Diagnostic

physical

capable

Software

terminus

Terms

receiving,

1link

storing,

or transmitting data. Card readers, line printers, and terminals
are examples of record-oriented devices. Magnetic tape devices and
disk devices are examples of mass storage devices.
Terminal 1line
interfaces

and

interprocessor

links

are

examples

communications

devices.

device

interrupt -- An

levels

devices,

through

23.

controllers,

interrupt
Device

and

received

interrupts

can

interrupt

priority

requested

only

memories.

device name -- The field in a file specification that identifies
the device
unit
on which a
file
is
stored.
Device
names
also
include

data

the

mnemonics

transfer

followed

that

request.

controller

followed by a unit number
it from following fields.
diagnostic

provide
a
programs.

identify

device

name

I/0

identification

(if

peripheral

consists
letter

applicable).

(if

colon

device

mnemonic

(:)

separates

applicable),

supervisor

-- A program
that
is
loaded
in memory to
framework
for
control
and
execution
of
diagnostic
It
provides
nondiagnostic
services
to
diagnostic

programs.

direct

I/0

program

drive

mode

addresses

support
--

from
The

the

access

device

operating

peripheral

registers

system

electro-mechanical

The

set

system

code

devices

directly,

which

without

the

relying

drivers.

unit

system on which a recording medium
magnetic tape reel) is mounted.
driver

(disk

that

mass

storage

cartridge,

handles

disk

physical

device

pack,

I/O0

device.

entry mask -- A word

(1)

whose bits

represent the

régisters

to be

saved or restored on a subroutine or procedure call using the call
and return instructions, and (2) which includes trap enable bits.

entry point -- A location that can be specified as the object of a
call.
entry
event

It contains
point mask.

entry mask

and

exception

enables

known

the

-A
change
in
process
status
or
an
indication
of
the
occurrence of some activity that concerns an individual process or
cooperating processes. An incident reported to the scheduler that
affects a process's ability to execute. Events can be synchronous
with
the
process's
execution
(a
wait
request,
or
they
can
be
asynchronous (I/0O completion). Some examples of events: swapping,
wake request, page fault.

VAX Diagnostic Design Guide

event

flag

that

flag.

Event

cleared

process

bit

the

indicate

among

flags

event

flag

cluster

are

used

synchronize

occurrence

the

normal

with

associated

event

set

activities

hardware
(other than an
instruction) that changes

execution.

instruction

flow of

can

processes.

many

exception -- An event detected by the
interrupt or jump, branch, case, or call

the

that

exception

always

caused by the execution of an instruction or set of instructions,
while
an
interrupt
is
caused
by
an
activity
in
the
system
independent of the current instruction. There are three types of

hardware

exceptions:

traps,

faults,

and

aborts.

Examples

are:

underflow,

and

attempts to execute a privileged or reserved instruction; trace
traps;
compatibility
mode
faults;
breakpoint
instruction

arithmetic

execution;

and

exception

condition

such

hardware-

traps

overflow,

divide-by-zero.

(other
than
instruction)

an
interrupt
that
changes

execution.

exception

dispatcher

condition,

the

software-detected

or
Jjump,
branch,
the
normal
flow
operating

system

event

case,
or
call
of
instruction
procedure

that

searches
for an exception handler when an exception condition
occurs.
If no exception handler is found for an exception or
image

that

incurred

the

exception

terminated.

executable
(EXE)
-- A program section attribute.
The psect
contains only instructions. This attribute provides the capability
to separate instructions from read-only and read/write data. The
linker
uses
this attribute
in gathering psects and
in the
verification of the transfer address that must be present in an
executable

psect.

executable image -- An image that is capable of being
process. When run, an executable image is read from a
execution

run in a
file for

process.

executive -- The generic name for the collection of procedures
included in the operating system software that provides the basic
control and monitor functions of the operating system.

field replaceable
modules, or one or
in

the

field.

file -physical
as disk
assigned
logical

-- A subassembly, one or a few
(FRU)
unit
a few integrated circuits that may be replaced

A logically related collection of
data
treated as
a
entity that occupies one or more blocks on a volume such
or magnetic tape. A file can be referenced by a name
by the user. A file normally consists of one or more
records.

Glossary of Diagnostic Software Terms

file

specification

unique

name

for

file

mass

storage

medium.
frame

pointer -- General
the
base
address

contains

(R13).
recent

By
convention,
FP
call
frame on the

stack.
global symbol -- A symbol defined in
available
for
reference by
another

(matches
references
with local symbol.

a module that is potentially
module.
The
linker
resolves
definitions)
global
symbols.
Contrast

with

granularity

boundary.

-- The alignment of a contribution to
a
psect on a
The alignment granularity may be byte, word,
longword,

quadword,

page.

home block -- A block in the index file that contains
identification, such as volume label and protection.
image

—--

image

consists

procedures

bound
together by
the
1linker.
There
executable, sharable, and system.

and

are

data

three

that

types

the

volume

have
of

been

images:

index file —- The
access
information

file on
for
all

a
FILES-11
wvolume
that
contains
files on
the
volume
and enables

operating

system

identify

and

interrupt

event

(other

access

than

the

volume.

exception

case,
or
call
instruction)
that
changes
the
instruction
execution.
Interrupts are generally
process

executing

when

the

interrupt

the
the

branch,

jump,

normal
flow
of
external
to
the

occurs.

interrupt priority level (IPL) —-- The interrupt level at which the
processor executes when an interrupt is generated.
There are 31
possible interrupt priority levels.
IPL 1 is lowest, 31 highest.
The

levels

arbitrate

contention

for

processor

service.

For

example, a device cannot interrupt the processor if the processor
is currently executing at an interrupt priority level greater than

the

interrupt

priority

level

the

device's

interrupt

service

routine.
interrupt

stack -- The

interrupt

service

process

kernel

with

context

mode;

kernel

system-wide

context.

executing
system-wide

privileges,

current
mode
bits
context-switched.

the

stack

used

when

any

time,

the

user,

supervisor,

interrupt

indicated
PSL.

The

executing

processor

service

the

an
in

executive,

context

interrupt

either

operating

stack

1is

and

not

VAX Diagnostic Design Guide

I/0 function code -- A 6-bit value specified in a Queue 1/0
request system service that describes the particular I/0O operation
(e.g.,

to be performed

read, write,

level 1 -- Operating system
logical

Diagnostic

level

using

physical

level

2R —--

can

QIO.

or virtual

run

either

QIO.

under

(VMS)

rewind).

based diagnostic programs using
programs

that

standalone

mode,

supervisor-based

diagnostic

supervisor-based

diagnostic

VMS

(on-line)

the

programs

that

level 3 -- Diagnostic supervisor-based diagnostic programs
can be run in standalone mode only, using direct I/O0.

that

Diagnostic

can be run only under VMS,

level
the

Standalone

using physical

macrodiagnostic

QIO.

programs

that

run

without

supervisor.

library

file

modules

the

—--

same

direct

module

access

type.

linked
commands —-- A group
together
(linked)
so
as
to

file

containing

of
independent
form a
single

one

commands connected
executable
1list of

commands. Once initiated, the entire linked command
executed without further operator intervention.

list

may

Glossary of

linker

—— A

program

that

by language processors
sharable image file, or
The

reads

one

Diagnostic

object

Software

modules

and produces an executable
a system image file.

resolution

external

created

image

references

Terms

file,

between

linking

—--

modules
library
and the

used to create an image;
the acquisition of
referenced
routines,
service entry points,
and data for the
image;
assignment of virtual addresses to components of an image.

object

link map -- A link map shows the virtual memory allocation of the
total program image. The link map is found in a program listing in

the

program

literal

section

translated

An
to

allocation

operand
some

synopsis.

which

other value.

used

immediately,

An operand

literal
argument
-An
independent
statement that specifies itself.
local

symbol

that

which

value

meaningful

without

specifies

within

only

being

itself.
command

the

module

that defines it. Symbols not identified to a language processor as
global
symbols are considered
to
be
1local
symbols.
A language
processor
resolves
(matches
references
with
definitions)
1local

symbols.

to another object module. They can, however, be passed through
linker to the symbolic debugger. Contrast with global symbol.

They are

known

the

logical

block

using

the

block

(device-oriented)

address

comprise

blocks

logical
@-7) of
macro

and

mass

storage

device

rather

than

are

labeled

that

with

logical

address

block

the

unit number
(LUN) -a device under test.
—--

generate
memory

statement

predefined

management

hardware's
image

linker

volume-relative

The

starting

the

that

set of

virtual

volume

The

cannot be made available

(file-relative)

numerical

requests

The

system

and

protection and

and

address.

sequentially

designation

language

physical

(normally

processor

include

the

instructions.

page mapping

activator

identified

the

functions

that

the operating

system's

pager.

module -- A part of
a
program
assembled
as
a
unit.
Modular
programming allows
the development of large programs in which
separate parts share data and routines.

mount a
physical

volume -- To
1logically associate a wvolume
with
the
unit on which it is loaded (an activity accomplished by

system

software

on-line

(an activity accomplished by a

place a magnetic

the

request

operator).

Or,

load

tape or disk pack on a drive and place the drive
system operator).

VAX Diagnostic Design Guide

-- The logical link control layer

(NSP)

network service protocol
of DECNET architecture.

object module -- The binary output of a language processor such as
the assembler or a compiler, which is used as input to the linker.
on disk structure

(ODS1, ODS2)

-- A files-11 disk format used by

VMS.

operand —- a value (address or data)
instruction.

by an

that is operated on, or with,

overlay (OVR) -- A program section attribute. If a psect is
overlayed, all contributions to the psect have the same base
address. The 1length of the psect is the size of the largest
contribution. All contributions to an overlayed psect must have
the

same

alignment.

page —— A set of 512 contiguous byte locations used as the unit of
memory mapping and protection. Also, the data between the
beginning of

file

and

page marker,

between a marker and the end of a file.

between

two

markers,

page frame number (PFN) -- The address of the first byte of a page
in physical memory. The high-order 21 bits of the physical address
of the base of a page make

up the PFN.

page table entry (PTE) -- The data structure that identifies the
location and status of a page of virtual address space. When a
virtual page is in memory, the PTE contains the page frame number
needed to map the virtual page to a physical page. When it is not
in memory, the PTE contains the information needed to locate the
page on secondary storage

(disk).

parameter —- A parameter is the object of a command. It can be a
file specification, a keyword option, or a symbol value passed to
a command procedure. In diagnostics, parameters are usually
operator-supplied answers to questions asked by a program
tested.

concerning

devices to be

parameter

switch -- A command

preceded by a

slash

(/).

qualifier.

diagnostics,

parser —— A procedure that breaks down the components of a command
into

structural

forms.

physical address -- The address used by hardware to identify a
location in physical memory or on directly addressable secondary
storage devices such as disks. A physical memory address consists
of a page frame number and the number of a byte within the page. A
physical
sector

disk

number.

block

address

consists

cylinder

track

and

Glossary of Diagnostic

Software Terms

physical block -- A block on a mass storage device referred to by
its
physical
(device-oriented)
address
rather
than
a
1logical
(volume-relative)
or virtual (file-relative)
address.
position
The

independent

contents

virtual
(NOPIC) .

memory.

Priority

level

code

(PIC)

program

section

attribute.

the

psect do not depend on a specific location in
The
converse
is
nonposition
independent
code

The

rank

assigned

activity

that

determines

service.

For

example,

when

several

jobs

system

resources,

the

Jjob

the

highest

priority

service

first.

Program

with

its

contend

for

receives

interface

(PGI)
-The
portion
of
the
diagnostic
that handles
communication between
the diagnostic
program and the supervisor.
The PGI implements services requested
by diagnostic programs.

supervisor

Program
number

section
of

directives
precedes

program

the

the
first

program

section

Through

program

A portion of a module. The assembler creates a
sections
(psect)
within a module,
according to
program developer.
In addition,
any code
that

defined program
the assembler.

sectioning

the

section

program

placed

developer

the

BLANK

controls

the

virtual memory allocation of
a
program.
Any
program
attributes
established by the program section directive are passed on to the
linker.
Thus,
program
sections
can
be
declared
as
read
only,
nonexecutable,

etc. See the VAX-11 MACRO Language Reference Manual
an
explanation
of
the
various
program
section
attribute
functions.

for

diagnostic

programs,

each

test

given

separate

program

section.
prompt

—--

operator

program's

typed

out

response

and/or

request

for

action.

qualifier —— A

portion

command

string

that

modifies

command

verb or command parameter by selecting one of several options. A
qualifier,
if present,
follows
the
command verb or parameter
to

which

applies

example,

COPIES

the

and

qualifier

file

printed.

queue

-- A

list

queue

I/O0

system

calls
or

the

commands

mode

driver

diagnostic

the

string

indicates

given

program

command

that

access

format:

"PRINT

the

jobs

routines
supervisor

/qualifier:option.

user

wants

waiting

peripheral
provided
to

transfer

/COPIES:3",

three

copies

For
the

which

processed.

devices
the

VMS

data.

operating

VAX Diagnostic Design Guide

radix -- The base of the number system currently in use.

readable (RD) -- A program section attribute. The contents of the
psect can be read at the execute time. The converse is nonreadable
.
(NORD)

record -- A collection of adjacent items of data treated as a
unit. A logical record can be of any length whose significance is

physical

record

section

attribute.

The

programmer.

the

determined

device-dependent collection of contiguous bytes such as a block on
a disk, or a collection of bytes sent to or received from a
record-oriented device.

relocatable

(REL)

and/or

data.

-- A

program

be assigned a base address by the linker.
code

psect must

This psect can contain

script file —— A line-oriented ASCII file that contains a list of
commands.

section -- A group
selected

sector

VAX-11

the

—-

tests

diagnostic

program

that may

disk.

track

the

surface

interpretation

and

relation

between

portion

system,

operator.

each

track

a disk

normally divided

into

sectors.

semantics -or

command

The

commands

symbols.

sharable image —- An

image that has all of

its internal references

resolved, but which must be linked with an object module(s) to
produce an executable image. A sharable image cannot be executed.
to contain a library of
image file can be used
A sharable
as a global section by
installed
be
can
image
routines. A sharable
the

system manager.

spooling —- Output Spooling:

The method by which output to a low-

speed peripheral device (such as a line printer) is placed into
queues maintained on a high-speed device (such as disk) to await

The method
Input Spooling:
transmission to the low-speed device.
the card
as
(such
peripheral
low-speed
a
from
input
by which
device
high-speed
a
on
maintained
queues
into
reader) is placed

(such

input.

disk)

await

transmission

Job

processing

that

stack -- An area of memory set aside for temporary storage, or for
procedure and interrupt service 1linkages. A stack uses the
last-in, first-out concept. As items are added to (pushed on) the
stack, the stack pointer decrements. As items are retrieved from
(popped off) the stack, the stack pointer increments.

Glossary of

stack
a

frame

procedure

standard

call,

to lower addresses, and
Also called call frame.
stack

pointer

address

the

data

starting

structure

from

popped

Diagnostic

the

off

built

location

during

Software

the

stack

addressed

return

Terms

during

the

FP
procedure.

from

General

top

register
14
(Rl14).
SP
contains
the
(lowest
address)
of
the
processor-defined
SP will access one of the five possible stack

stack. Reference to
pointers:
kernel,
executive,
supervisor,
user,
or
interrupt,
depending on the value
in
the
current mode and
interrupt
stack
bits in the Processor Status Longword (PSL).
standalone
program

mode

and

the

diagnostic

program environment
in which
supervisor run
without
the

the
VMS

operating

system. The operator must use the console terminal when
running
diagnostics
in
the
standalone mode,
and
no
other
users
have access to the system.
status

code

failure
of
a
always return
symbolic
another

1longword

value

that

indicates

the

success

argument

within

command

that

services

refers

value.

syntax

way

specific
function.
For
example,
system
a status code in R@ upon completion.

The

rules

which

governing

command

symbols

command

are

language

ordered

within

structure.

The

form

meaningful

command

statement

statements.

syntactic

(e.g.,

unit -- An
item
contained
argument, a qualifier).

system image
storage when

-- The image that is read
the system is started up.

into

memory

switch

parameter

from

command

line

that

checks

specific

that

passed

from

secondary

program.

test

——

function

time

unit

portion

stamp --

event

occurred.

track

recording
trap

diagnostic

the

statement

collection

surface
An

exception

the

been

executed.

time

blocks

condition

that caused the
address of the next

trap conditions

the

day

single

which

radius

one

the

disk.

instruction
is

program

hardware.

that

occurs

All

software

can

with

instruction.

single

the

end

exception. The PC saved on the stack
instruction that would normally have
enable

and

disable

some

the

VAX Diagnostic Design Guide

record device —-- A device

unit

such

card

reader

line

printer.

unwind the call stack -- To remove call frames from the stack by
tracing

back

through

nested

procedure

using

the

current

portion of

the

computer

calls

content of the FP register and FP register content stored on the
stack

UUT

for

frame.

each call

(unit under test)

-- The device or

hardware being tested by a diagnostic program.

virtual block number -- A

number

used

identify a

block on a

mass Storage device. The number is a file-relative address rather

than a logical (volume-oriented) or physical (device-oriented)
address. The first block in a file is always virtual block number

one.

writable (WRT) -- A program section attribute. The content of the
psect can be modified at execute time. The converse is nonwritable
.
(NOWRT)

INDEX

Automated

Product

Test

Automated
Automated

Product
Product

Test Constraints, 13-1
Test-Remote Diagnosis (APT-RD),

Assembly and
Asynchronous

(APT),

1-3

Link Procedures, 12-19
System Trap (AST), 12-6

Channel Services Macros, 8-9
Cleanup Routine, 6-15
Coding Conventions and Procedures,

Coding

Utility

Coding VMS

Command

Macros,

Service

Line

Condition
Console

Cluster

Debug,

Phase,

5-20

1-1

12-10

Environment,

Consultation

9-1

(CLI),

Engineers,

Handlers,

13-1

8-1

7-1

Macros,

Interpreter

Comments, 11-14
Computer Design

CPU

Service Macros,

Supervisor

Coding

3-5

4-1

Environment,

3-5

14-1

Debug and Utility Commands, 14-6
Delay Service Macros, 8-24
Design Engineer, 1-1
Diagnostic Applications, 1-2
Diagnostic Execution Time, 2-4
Diagnostic Program Size, 2-3
Diagnostic Program Structure, 6-1
Diagnostic Supervisor, 5-1
Documentation, 11-1
Documentation File, 11-1
Error

Error

Message
Message

Formats, 8-29
Print Routines,

12-2

Error

Message

Service

8-23

Macros,

Event Flag Service Macros, 9-30
Exception Handlers, 12-10
Execution Control Commands, 5-16
Fault Detection Coverage, 2-1
Field
Field

Service,

1-3
Replaceable Unit

Formatted

ASCII

Global

Subroutines,

Header

Module,

Hibernate,

(FRU),

Output,

2-2

9-42

6-17

6-3

9-49

Implementation

Phase,

4-3

Initialization Routine, 6-13
Input/Output (I/0) Service Macros,

9-5

Interrupts, 12-4
Level 1, 3-1, 6-22
Level

Level

2R,

Level

3-1,

6-23

3-2,

6-24

Level
Link

3-1,

6-23

Procedures,

12-19
INDEX-1

1-4

Long Silences, 13-3
Looping Constraints,13-3

Macros - Alphabetical List, 16-1
Manufacturing Technicians, 1-1

Memory Management Service Macros, 8-18, 9-48
Module Preface,

11-6

Operational Functionality, 2-4
13-2

Parallel Testing,
Planning

4-1

Phase,

Program Control Commands, 5-4

Program Control Utility Macros, 7-13
Program Format Utility Macros, 7-2
Program Interface

(PGI),

Program Structure,

6-1

5-20

Program/Operator Dialogue Service Macros, 8-40
P-Table Control Macros, 7-23

P-Table Format,

6-9

Quality Assurance Procedures, 4-5
Queue I1/0

(QIO),

9-11

6-25

Return Status Codes, 9-5
Routine Preface, 11-190

Run-Time Considerations, 2-4, 13-2
Scripting Control, 5-14
Scripting Constraints, 13-2
Serial Testing, 13-2
Summary Routine,

6-16

Supervisor Service Macros, 8-1
Symbol Naming Conventions, 12-16
System Control Service Macros, 8-9
System Environment,
Test

Timer

Routine,

6-20

3-8

Service Macros,

User Defined Macros,
Utility Macros,

7-1

9-34

12-14

VMS Service Macros, 9-1
Volume Verification, 13-3

INDEX-2

VAX DIAGNOSTIC DESIGN GUIDE

Reader’s Comments

EK-1VAXD-TM-001

Your comments and suggestions will help us in our continuous effort to improve the quality and usefulness of our
publications.

What is your general reaction to this manual? In your judgment is it complete, accurate, well organized, well
written, etc.? Is it easy to use?

What features are most useful?

What faults or errors have you found in the manual?

Does this manual satisfy the need you think it was intended to satisfy?

Does it satisfy your needs?

Why?

Please send me the current copy of the Technical Documentation Catalog, which contains information on

the remainder of DIGITAL’s technical documentation.
Name

Street

Title

City

Company

State/Country

Department

Zip

Additional copies of this document are available from:
Digital Equipment Corporation
444 Whitney Street
Northboro, Ma 01532
Attention: Communications Services (NR2/M15)
Customer Services Section
Order No.

EK-1VAXD-TM-001

Enanan

No Postage
Necessary

if Mailed in the

United States

BUSINESS REPLY MAIL
FIRST CLASS

PERMIT NO.33

MAYNARD, MA.

POSTAGE WILL BE PAID BY ADDRESSEE

Digital Equipment Corporation

Educational Services Development and Publishing
1925 Andover Street
Tewksbury, Massachusetts 01876