CS_3000_External_Reference_Specification_Dec1978 CS 3000 External Reference Specification Dec1978

User Manual: CS_3000_External_Reference_Specification_Dec1978

Open the PDF directly: View PDF PDF.
Page Count: 197

DownloadCS_3000_External_Reference_Specification_Dec1978 CS 3000 External Reference Specification Dec1978
Open PDF In BrowserView PDF
ecceeccecccccccccc
cccccccccecc,
ecce
ecce
ecce
ecce
ecce
ecc;c
ecce
ecce
ecce
ecce
ecce
ecce
ecce
ecce
ecce
ecce
ecce
ecce
ecce
eeecccccceee
eccccceeec
ccccccec

·.4~'

eSl3000

External Reference specification
December i8. 1978

---~~~--------_._-._-.-------_

.. --- ....

-~._-_.---._--- --------------.---

CONTENTS
I ("""
I
--/r---------------_·------------------_·_---------------------..-.---

Page
Section I
TERMINOLOGY AND ABBREVIATIONS
Terminology • • • • • • • • • • • • • • • 1-1
Data Communications system • • • • • • 1-1
Switched/Non-Switched • • • • • • • • • 1-1
Polnt-to-Polnt/Multl-Polnt • • • • • • 1-2
Duplex/Half-DuPlex/Simplex • • • • • • 1-2
Synchronous/Asynchronous
Transmission • • • • 1-4
Contention/Supervised Mode • • • • • • 1-4
Line Modes • • • • • • • • • • • • • • 1-4
Addressing • • • • • • • • • • • • • • • 1-5
Identification sequences • • • • • • • • 1-1
Concurrent vs. Non-Concurrent
Input/Output • • • • 1-1
Abbreviations • • • • • • • • • • • • • • 1-8

Page
Section II
INTRODUCING CS/3000
Intrinsics • • • • • • • • • • • • • • • 2-2
Capability • • • • • • • • • • • • • • • 2-2
CS/3000 Hardware Components • • • • • • • 2-3
HP 30360A Hardware. serial
Interface (HSI) • • • •
HP 3005~A Synchronous Single
Line Controller (SSLC) • • • • 2-3
HP 30010A (30020A) Single Channel
Communications Processor (SeCp) •• 2-4
Drivers and Line ProtocolS • • • • • • • 2-4
Supported Line Configurations • • • • • • . 2-4

Page
Section III
OPERATING CS/3000
Miscellaneous Command Extensions • • • • 3-1
User Commands • • • • • • • • • • • • • • 3-1
:CLINE Command • • • • • • • • • • • • 3-1
:CRESET Command • • • • • • • • • • • • 3-8
User Messages • • • • • • • • • • • • • • 3-B

Contents-l

Section IV

Page

USING CS/3000 INTRINSICS

General Description • • • • • • • • • ••
Openlno Lines • • • • • • • • • • • • ••
Closing Lines • • • • • • • • • • • • • •
Reading From Remote Devices • • • • • • •
Writing to. Remote Devices • • • • • • • •
Completion of Concurrent 110 Requests • •
Obtaining Line Information • • • • • • •
Obtaining MUltipoint Group
Information • • • • •
Obtaining Multipoint station
Information • • • • •
Obtaining Line Error and status
Information • • • • •
CCHECK Irrecoverable Error
Codes [ERRORCODE (8:8)] • • •
CCHECK Recoverable Error
Codes (ERRORCODE (0:8)J • • •
Displaying Line Information • • • • • • •
Directing Line Control Operations • • • •
CONTROLCODE Functions • • • • • • • • •
Modifying Poll Lists • • • • • • • • • •

4-1

o

4-3
4-24
4-25
4-28

4-32
4-34
4-38

4-40
4-42
4-44
4-49
4-50

4-53
4-54
4-63

Page
section V
EXAMPLE
Remoter1le Transfer Program
(COded In SPL/3000) • • • • • • • 5-1
Multipoint Transaction processing Program
(Coded in SPL/3000) • • • • • • • 5-5
Section VI
THE C5/3000 TRACE FACILITY
DefinlnQ the Tra~e File • • • • • • • ••
InvOking the Trace Facility • • • • • ••
The Trace File. • • • • • • • • • • • ••
Trace Dump Program • • • • • • • • • • •
List File • • • • • • • • • • • • • ••
Invoking the Trace Dump Program • • ••
Trace Listino Header Message • • • • •
"Begin Tracing" Message • • • • • • • •
"End of Trace" Message • • • • • • • •
Trace Record Header Message • • • • • •
"Missing Entries· Message • • • • • • •
Trace Entry Format • • • • • • • • • •
OPR (operation) Trace Entries • • • • •
Contents-2

Page
6-1
6-2
6-4

6-6
6-6
6~7

6-11

6-12

6-13
6-14
6-14

6-15
6-18

o

(\

(state Transition) Trace
t!:ntries • • • •
(Editor) Trace E:nt r ies • • • • • •
(Receive Control sequence)
Trace Entries • • • • •
(send Control Sequence)
Trace Entries • • • • •
(Send Polling Sequence)
Trace Entries • • • • •
(Send Selection Sequence)
Trace Entries • • • • •
(Receive Text) Trace Entries • • •
(send Text) Trace Entries • • • • •
(request completion) Trace Entries.

6-26
6.. 27

SECTION VII
CONFIGURING CS/3000
Configuration dialog. • • • • • • • • • •

7-1

SECTION VIII
CS/3000 LOGGING FACILITY
CS log records. • • • • •
Line disconnection record
Line close record • • • •
CS I/O Errors • • • • • •

• • • • • • ••
••••••••
• • • • • • ••
• • • • • • ••

8-1
8-2
8-3
8-4

CS/3000 OPERATOR MESSAGES
Dial message. • • • • • • • • • • • • • •

9-1

Error messaqe • • • • • • • • • • • • ••
System Failures • • • • • • • • • • • ••

9-1
9-1

5TN
EDT

ReT

SCT
POL
SEL

RTX
STX

CMP

b-19
6-20

6-21
b-22
6-23

6-24
b-25

SECTION IX

SECTION X
CS/1OOO SHOWCOM COMMAND
CS/3000 SHOWCOM Command • • • • • • • • • 10-1
SHOWCOM Command Syntax • • • • • • • • • 10-2
SHOWCOM Command Output • • • • • • • • • 10-3

c

Contents-3

o

APPENDIX A
'BSC OPERATION

CREAD
Contention Driver • • • • • • • • • • •
Multipoint Control Driver • • • • • • •
MRJE Driver • • • • • • • • • • • • • •
SSLC & SCCP BSC Driver Message Format
Word (MFW) • • • • • • • •
CWRITE
Contention Driver • • • • • • • • • • •
MUltipoint Control Driver • • • • • • •
MRJE Driver • • • • • • • • • • • • • •
SSLC & secp asc Driver Message Format
Word (MFW) • • • • • • •
Message Formatting • • • • • • • • • • •
User progra. CompatibilltY8~tween
SSLC~ seep and HSI • • • • • • • • • • •

A-5
A-7
A-8
A-9

A-It
A-12
A-12

(J'\,
•

Contents-4

o

--~-----~-------.---.-------_.~~.--

..

-------_.-------.----_._-----~-----

SECTION I

TERMINOLOGY AND AHBREVIATIONS
I {-\

I

I

- ". J------------------------------------------------------------------~-,/

1.1

TERMINOI,OG'i

1.2

Data Communications system

---.-------

_.~--~.-._._----.~-.--_._-

Viewed in its most elementary aspect, a data communications system
consists ot (1) a central computer (CPU) and associated transmission
control equipment, (2) remote stations, and (3) the communications
lines that connect the remote stations to the Cpu.
Typically, the transmission control equipment is called a transmission
control unit (TeU). TeU's are generally attached directly to a Channel
of the CPU. In the case of a 3000 CPU, examples of a TCUare the HSI,
SSLC, and SCCP boards (deScribed later).

~The equipment
(/another
CPU.
input/output
terminal.

constituting a remote station can be either a terminal or
A terminal consists of a control unit and one or more
devices, each of Which is called a component ot that

It 1s the method of connection to the CPU, rather than the distance
trom the CPU, that determines whether a station Is classified as
r~mote.
A station is considered remote If it is connected to the CPU
through a TeU. A station connected directly to a data channel of a CPU
Is termed a local station. In general, data communications software
concerns itself with remote stations only.

1.3

Switched/Non-Switched

._-----------------.-

."
C
)

A non-switChed (dedicated) line is one that continuously links the
stations associated with it, regardless of the amount ot time it is In
use. for message traffic. This type of line could connect a terminal
physically located near the CPU, but usually it 15 a line provided by a
common carrier on a contractual basis in order to service a distant
station. A switched line Is one in Which an electrical connection
between the CPU and a remote station is established by dlallnq. As in
the, PUblic telePhone network, the actual communication path for a given
.

1-1

transmission via a switched lIne is not fixed but is automatlcal,{\
selected from a variety of possible paths by common carrier sWltchl~
equipment.
Each remote, station on a switched line Is continuously connected to a
common carrier switchIng center (exchange) by an access line in the
same way as a telephone. Similarly, each Teu at the central computer
Is conne~ted to an exchange by access lines. Usually', a TCU has
several access I1nes, each with its own telephone number.
Common carriers usually charge for switched lines on a time·used
rather than a contractual basts.

1.4

basis

-.- -.

Point-to-Polnt/Multl-Point
~~.-.-

-

A line Is called polnt-to-point it it connects the computer to a single
remote station; it is multi-point if more than one remote station 15
connected to the lIne. (Multi·point Is otten called multi-drop.)
See Figure 1.1
configurations.

1.5

for

a

general

overview

of

line

and

station

c

Duplex/Half-Duplex/Simplex
w_ • • • • • • _ • • • • _ • • • • • • _ • • • • •

The term duplex (or full-duplex) 1s applied to a communications line
that can accommodate data transmission in both directions at once.
Half·duplex lines permit transmission In only one direction at a time:
the line may be used to both transmit and receive data, but not
simultaneously. To allow the direction of data flow to be reversed, all
traffic Is stopped for some period of time. This quiescent interval Is
called the turn-around time. Duplex and half-duplex lines accommodate
bidirectional communication; a simplex line is unidirectional.
switched lines which use a one phone connection are constrained to be
half duplex 1f they·re operating at line speeds in excess of 1200
bits/second because the lines are two-wire and do not have SUfficient
bandwidth to allow full duplex operation. Two phone connections allow
full duplex operation in a dial up mode. Nonswitched lines are usually
full duplex. "

1-2

o

FIGURE 1.1

Line and Station Configurations

C~
/

o

1-3

1.6

--_ ......•.•.•.•• -....•.....

--..._---

Synchronous/Asynchronous Transmission

o

Basically, there are two distinct methods by which data are transmitted
over communications lines:
a)

synchronous communication Is used for high-speed data transmission
between the CPU and another remote computer or high-speed terminat.

b)

asynchronous communication Is used for data transmission at lower
speeds between the CPU and remote terminals of various types.

Asynchronous transmission uses start and stop bits to separate, one
character
from
another.
Synchronous transmission does not· use
start-stop btts and thereby permits more information to be passed over
a circuit during a given time interval.
Although there are exceptions, a synchronous station Is generally
another CPU or a page-mode terminal whiCh may have high speed
components 11ke a card reader, printer, magnetiC tape drive, etC. On
the other hand, an asynChronous terminal is usually a low-speed device
with a keyboard.
1.1

._----

Two-Way Alternate/Two·way SimUltaneous

------_._-.----------------- .. __

o

A Two-way Alternate (TWA) protocol can only manage data transmission in
One direction at a time. A TWA protocol may be used on elth~ra half or

full ~uplex channel, but data w1ll never be sent and received
simultaneously. TWA protocol performance is better when used on a full
duplex Channel because the turn-around time is minimized.

A Two-Way Simultaneous (TWS) protocol
transmission and reception. A fUll duplex
necessary When using a TWS protocol.

manages simUltaneous data
communications Channel is

For two-way alternate operation, IBM defined a generalized transmission
teChnique called binary synchronous communication (BSC).
BSC
is
currently the de-facto industry standard for half-duplex synchronous
communication.
asc accomm'odates a variety of transmission codes
(EBCDIC, USAseII, Six-Bit Transcode) as well as a transparency feature
that allows ttansmissionof raw binary data which has no graphic or
control
significance. asc is pr~dicated on the a~sumPtion that
transmission errors can occur; hence, much of asc 15 concerned With
error detection and correction.

("\Ubl1C Data Networles· as app roved by CC ITT Onternationa 1 Telephone &
"-of e 1 e g rap h ConsultatIve CommIttee) • This basIs ~ a s Chosen since It Is an

approved standard by an international body, and is a subset at
ANSI·s current ADCCP recommendation and ISO HOLC recommendation •

•8

both

Modes
Any given
modes:

ASC line in a communications network operates in one of two

a) Contention Mode

-----------_.--

For point-to-point lines (switched and non-switched), the two
stations are otten symmetrical With neither having control of the
line or the other station. The two stations contend for the line by
bidding to become the transmitter. To provide tor the situation In
which both stations bid simultaneously, on~ of the stations is
denoted the primary while the other Is the secondary statiOn.
The
primary station will persist 1n bidding while the secondary relents.
Contention mode is never applicaDle to mUlti-point lines.

Mode
C\;) Supervised
---------------

This mode is required to operate on either switched or non-switched
mUlti-point lines. Un a line operating in supervised mOde, there is
always one control station: each of the remaining stations is d
tributarY station.
The control station (normally a CPU) is the
master, and the tributaries are slaves.
The control station "polls" the tributary to solicit input,
"selects" the tributary tor output.

c

and

it

HPDLC I makes use ot two-way simultaneous communications with
unbalanced, symmetrical stations operatlnQ In ~sYnchronous Response
Mode. "Symmetrical, unbalanced stations" is a term denoting the tact
that each station contains a primary function responsIble tor
sending data and control and a secondary function responsible for
receiving data and control. The secondary tunction also makes
positive and negative acknowledgements of the data received. The
primary function In one station transmits to the secondary function
1n the other station. "Asynchronous Response Mode" means that a
secondary function can transmit at the earliest opportunity without
any prompting by its corresponding primary function. Since this Is a
t~o-way simultaneous protocol, this opportunity. is always available.

1-5

1.9

o

Addressing

---------a)

Components.

----------

component
output·only,
components.
A

(I/O

or

device) of a
input/output.

station is
A station

either input-only,
may have multiple

On allcontentiorl lines and most modern multipoint line,s,
the
components of a mUlt'l-component station are unIquely identified via

component addresses within the transmitted text.
However
on
supervised lines containing relatively old tributaries, such as IBM
21ge RJE termlnals,the components are directly addressed in the
polling and selection sequences.
b)

Terminal Groups •
..........
--._---_.
Most modern multipoint tributary terminals are attached to the line
In groups. This enables a hardware cost savings since only one
modem and one set of polling/selection decodlng electronics are
needed per group. switched lines may have more than one group:
however, allot the members of any particular group must Share t~;1
same line. Nonswltched line may have an unlimited number.
j~
general polling or selecting tributary groups requires a three field
sequence:
1. group ID
2. station 10
3. component 10

CS logically assumes that all multipoint lines always use the full
three field sequence. However it is quite rare that this would
actually happen. Usually the line will fall into one of three
possible configurations. Their characteristics and CS conventions
are:
(1) OnlY station 105 are used.
All stations log1cally belong to one grou,p wh,osegroup ID is
null. Each· station has one componentwhoseID is nUll_.
(2) Only group and station IDs are used.
Ea~h station has one component whose IDls nUll.
() Only station and component IDs are used.
All statlonslogically belong to one group whose group ID Is
nUll.
An add1tional CS convention is that when configuring the line, the
station 10 Is not explicitly specified. It must be embedded into
each of ' the station·s component IDs.

o

(',)

There are ttfO addi tional advantages that terminal groups ofter:
1. General Poll.

------.-.---

The control station may
"qroup poll") by sending:
(a) group ID
(b) general pollIO

invoke general poll (sometimes called

This allows any or all terminals in the group, having data to
send, to respond. The electronics within the group insures that
the polling proceeds 1n an orderly manner; that Is, only one
tributary at a time actually sends text and after the last
tributary has finished, a special sequence 1s sent to the control
station notifying it that there are no more terminals haVing data
to send. Tributaries are required to place their station IDs at
the beginning Of their sent text so that the control station may
identify tne origin of the Incominq data.
The advantage ot general poll is that it eliminates the
and delay of haVing to sequentiallY poll each terminal.

overhead

2. General select.

-------------This facility, sometimes called "group broadcast", enables the
contrOl station to broadcast a text bloCk to all terminals
attached to a group. NO acknowledgement to the text 1s returned
by the group or any of its terminals. The HP 2645 terminal also
has line select which broadcasts text to ~ll terminal~ on the
line in a similar fashion.

l.10 Identification Sequences
~---._----_._-------~---

To provide validation and security for the use of both switChed and
nonswitcned lines, 10 sequence verification is u.sed. (This faCility is
not used by all protocdls; for example, it is used by the BSe protocol,
but not by the HPDLC I protocol.) To use this facility, eaCh remote
station that 1s permitted to access the computer over the line must
have an tD sequence that it automatically sends immediatelY after the
line connection has been established. The prograw compares the received
sequence against a list of permissible sequences. If a match is found,
message transmission can proceed. Otherwise, the connection will be
broken.

1-7

_--_. __ ..-_._-..--._.. _

.-.-

_--.--

1.11 Concurrent VI. Non-concurrent Input/Output

o

In data communications, there 15 a requirement for multiple lines to be
This requirement, in
controlled by a single application or process.
turn, dictates the need for I/O requests to return to the caller
without waiting for completion. To satisfy this requirement, CS
provides two basic forms Of I/O support:
1)

I/O requests with an implicit wait. This mode will be' called nonconcurrent input/output (NCIO), because I/O is not done concurrently
with the execution of the user's proqram.

2) I/O requests without wait, requiring the user to subsequentlY issue
an explicit walt request.
This mode will be called cOncurr~nt
input/output (CIO), because I/O is performed concurrently with the
execution of the user's program.

1.12 ABBREVIATIONS

.-.._--------

The following
document:

asc

abbreviations are used throughout the remainder of this

c

-

Binary Synchronous Communication
CIa
Concurrent Input/Output
CS
MPE Communications System (CS/3000)
DeE
Data Communications Equipment
The equipment installed at the user's site which (a) provides
all the functions required to establish, maintain, and terminate
a connection, (b) the signal conversion coding between the data
terminating equipment (OTE) and the common carrier's line, e.g.,
data set, modem. DCE Is also used to refer to the network side
of a network/terminal interface on a PACKET MODE PUBLIC DATA
NETWORK.
DTE - Data Terminating Equipment
Any piece of equipment at which a communications path begins or
ends, e.g., a terminal or computer. OTE Is also used to r,fer to
the terminal side of a network/terminal Interface on a PUBLIC'
MODE PUBLIC DATA NETWORK.
FS
- MPE File System
HPDLC I- HP Data Link Control ( a TWS protocol )
HSI - HP 30360A Hardwired Serial Interface
10
- ID sequence. Additionally it refers to a field of a pOlling or
selection sequence for a mUltipoint tributary.
MP
- Multi-point (also called multi-drop)
NCIO • Non-Concurrent Input/Output
NSW • Non-SWitched
1-8

o

~\

j>
( sccp

- Polnt-to-Point
-HP 30010A (or 30020A) Single Channel Communications Processor
SOLC • synchronous Data Link Control
SSLC - HP 10055A Synchronous Sinqle Line Controller
sw • S~ltched
Teu - Transmission Control Unit (an HSI, SSLC, or SCep)
TwA - Two way alternate transmission
TWS - Two way simultaneous transmission

c

o

o

o

.

~

~

. __.

.~_._._._w

..._. __

~

~._._---_._~

Section II

INTBODUCING CS/3000
,

I

;'"L"

-_-~---

•- (coo /':~ _. - - - - - - - - - - • _•• - •• - - • - - - - - - ••••• - .. • _. - - - - - - - - - - - - - - - - - - - - - *

I
_ ... - - - -

provides the MPE user with a basic and flexible set of tools
for the control of communications lines and terminals. The system Is
deslqned to satisfy the communications 1/0 requirements Of both the
ordinary user and the more sophisticated user. These requirements are
met bV providing d flexible set of user-callable intrinsics, eaCh ot
which performs a specific communications function.

C5/3000

If CS is installed and communication lines are configured, a minimum ot
words of main memory Is required. In addition, CS requires at
least one of the following hardware components:

64K

1) HP 30055A Synchronous Single Line Controller (SSLC)
2) HP 303601 Hardware Serial Interface (HSI)
3) HP 300101 (or 30020A) Single Channel Communications Processor (SeCp)

The SSLC is a control unit which accommodates one synchronous line and
is the meChanism for communication with other CPU~s or synchronous
terminals using the RSe or Conversational BSC protocol. The HSI Is a
-,I,ontrOI unit which provides a means of high speed communication between
P Cpus. The seep is a control unit which supports both synchronous and
asynchronous lines, and provides a variety ot user-specified protOCOls.

a

CS/3000 consists ot a set of drivers and user-callable Intrinslcs. As
SUCh, CS is not a runnable subsystem but rdther
a set of primitives
which facilitate the development of data communications applications.
CS will support SSLC, HSI, and seep lines; the MPE file system (~S)
supports all of the standard peripherals plus a special form of
asynchronous terminal support tor loa-on terminals. The device types
supported by CS are
type 17 - seep

type t 8 - SS[,C
type 19 - HSI

permanently allocated to C5
permanently allocated to CS
permanently allocated to CS

Allot the standard MPE peripherals will be permanently assigned to FS;
SSLC, HSI, and seep lines will be permanently assigned to CS.

c

2-1

2.1

INTRINSICS

----------

o

CS intrinsics begin with the letter "C" and, with few exceptions, are
analogous In both name and function to FS Intrlnsics.
The primary
distinction between FS and CS is that FS presents a device-lnde~endent
interface to the application program whereas the CS interface Is
device-dependent.
The same set of CS intrinsics applies to all device
types SQPported by CS.

Depending upon whether a device Is permanently assigned to CS or FS,
the method Of access 1s restricted to either the "C" or "F" intrinsics,
respectively, never a mixture.
FOPENparameters maybe supplied (or overridden) from an external
source at execution time via the :FILE command. CS provides the
analogous facility for the COPEN intrinsic with the :CLINE command.
Similarly, CS provides a :CRESET command which is analogous to the
:RESET command of the file system.
The FOPEN of FS returns to the caller a file number used to identify
the opened file in subsequent FS intrinsic calls. The COPEN ot CS
returns to the caller a line number used to identify the opened line 1n
subsequent CS intrinsic calls.
Within a single process, FS file
numbers and CS line numbers are unambiguous.
Unlike the FS, Which permits multiple FOPENs of a single file, CS
permit only one COPEN tor a given line.

2.2

CAPABILITY

----------

Due to the limited number of hardware resources supported by cs, the
user (not the program) must have a special capability in order to COPEN
aCS line. The user attribute ~CS" has been added to the :NEWACCT,
:ALTACCT, :NEWUSER, and :ALTUSER commands. This capability will be
reflected by a "1" In bit (13:1) of word 0 in the CAPABILITY parameter
of the WHO intrinsic.

o

.4

HP 303bOA Hardwired Serial Interface (HSI)
-----~.~-------.--_._-~._---_._._----_._-

One HSI boar~ occuplps on~ slot on the mUltiplex channel
HSI cannot be attached to d selector channel (30030).

(J0035).

An

Each HSI board can accommodate up to 4 distinct lines, only one of
which may be open at any given time. Physically, each of these tour
lines must be configured as hardwired point-to-point. The data transfer
rate Is a function of cable length; the maximum transter rate is 2.~
megabits per second for cables less than 1000 feet in length.
NOT~:

Although the HSJ is a high-speed device, it is actually an
asynchronous device because each data word is surrounded by
start-stop bits (20 bits are transmitted per data word).

The HSI requires a full-duplex line.

~.5

'
\
Cf

30055~

Synchronous Single Line Controller (SSLC)

~-~---------.-

.. -.--------.------~----.------------

One SSLC board occupies one slot on the mUltlpl~x channel
SSLC cannot be attached to a selector Channel (30030).

(30035).

An

EaCh SSLC board accommodates one synchronous line, which is configured
as a polnt-to-point contention station or as a a control station ot d
multipoint line.

Physically, the SSLC line can either be nardwired or be connected via a
modem. If a modem Is usea, the line may be either sWitched or
non-switched, and the data transter rate is limited by the mOdem. It
the S5 LeI i ne isha r d wire d., the ma x i munl da t a t ran s t e r r ate i s 19200
baud for cables less tndn 1000 feet in length.
The SSLC can operate on either" half-duplex or a tull-duplex line.

~.6

HP 30010A (or 30020A) Single Channel Communications Controller (SCep)
--~~----------_._-_._-----_._-------.--.-.-._---_._-~-

C

One HP 30010A seep board occupies two slots on
30035)

'on

the

HP

3000

:;er ies
2-3

the

multiplex

Channel

II; an SCCP cannot be at tached to a

selector channel (0030). The HP30020A SCCP board is

cOllpatible

the HP Interface Bus (HPIB), used on the Toothpick/Amigo systems.

WitO

Each seep board accommodates one synchronous or asynchronous line,
which may be configured as a BSC point-to-point contention station, a
control station Of a mUltipoint line, a conversational BSe station, or
as a network OTE or DCE In an HPDLC I environment.
Physically, the SCCP line can either b~ hardwired or be connected via a
mOdem. If a modem 15 used, the line may either be switched or
non-switched, and ~he data. transfer rate is limited by the mOdem, with
a maximum speed of 56 Kbaud. If the SCCPline is hardwired, the data
transfer rate Js 56 Kbaud for cables less than 4000 feet in length.
The seep board can operate on either a half-duplex or full-duplex line.

o

o

/

MAXIMUM DATA TRANSFER RATES
Component

Baud

.. ------.-------._-.-

.----------~-_._--_._--.-~_

seep

(xxxxx)

( 8 bits/byte)

(10 bits/byte)
(11 bits/byte)

*******

.... _-._---------------...
_--.... -.. --- ---_*******
HSI (30360)(10 M1ts/byte)
Hardwired

... -----

.-------~---_.~-._.-.-.-

SSLC (30055)(8 bits/byte)
Bell 201A Modem (SW)
Bell 201b Modem (NSW)
Bell 208A Modem (NSW)
Bell 208B Mod~m (Sw)
Bell 209A Modem (NSW)

-~--

2.7

2,500,000

--.- ... _-----2,000

2,400
4,800
4,800
9,600

.. ----.-------- .. _-.-._ ... ---------_.----._-

DRIVERS AND LINE PROTOCOLS

---------~---------.-----( "'\ a C h t YP e 0 f 1 t ne s uPP 0 r ted bye S r e qui res a d iff ere n t d rl ve r. The
~hardware board and the line protocol dictate how the driver is written.
·Lines using either the SSLC or the HSI ~ill employ the BSC protocol,
which Is widely used by the manufacturers otother CPUs and terminals.
Since the BSe protocol may dlso be used with the SCCP board, the user's
application program can be relatively independent ot whether a line is
SSLC, HSI, or SCCP~
A full enumeration of the protocol drivers provided by CS are:
BSe driver tor use with contention SSLC lines,
bSC driver for HSI contention lines,
sse driver for seep contention lines,
driver to enable the 3000 to control a multipoint SSLe line cOnsistinq
of ASC tributaries SUCh as the UP 2645.
A driver to enable the 3000 to emulate a HASP WorKstation (MRJE)
using
the SSLC or seep.
A driver to enable the 3000 to emUlate an IB~ 3270 workstation usinq th~

A
A
A
A

secp.

A driver to enable the 3000 to operate as a OTE or DeE In
mode, using the HPDLC I protocol on secp.

c

2-5

a

full-dUPlex

2.8

o

SUPPORT£D LINE CONFIGURATIONS

-------------------------_._.
For all CS line types (SSLC,
configurations will be supported:

HSI, and SeCp), the fOllowlng line

1) non-switChed, polnt-to-point lines
NOTE: Each of the four HSI ports may be Physically connected to a
dlffer_nt remotestatlon, but only one may be selected by any
given COPEN. In other words, no more than one HSI port should
be configured per logical device number for pOlnt-to-polnt
operation.
for the SSLC and scep line types the
will be supported:
t)

station.
switched,
station.

The seep

boa~d

multipoint

COnfigurations

mUltlpoint

in which the 3000 is the control

lines

lines

in

which

the

3000 is the control

0
will also support the followlng line conflqurations:

1) non-SWitched, multipoint
(secondary) station

lines

2) switched, multlpoint lines
(secondary) station

In

which

the

3000

J)

line

switched, polnt-to-point lines

2) non-switched,
3)

following

switched lines
enVironment

in

which

in which the 3000 Is a tributary
the

3000

is

a

tributary

Is acting as a OTE in a TWS

4) non-switched lines in which the 3000 is acting as

a DTE in

a

TWS

environment
5) switched

lines
environment

6)

In

whiCh

the

3000

15

actin as a DeE In a TWS

non-switched lines In which the 3000 is acting as a DeE In
enVironment

a

TWs

o

---~----------~--

.. ---.-------------_.~._--------------~---~---._------OPERATING

CS/3000

I

~~"\

Section III

I

(_J---------------.---.---.---.----------.--------------------.---------

3.1

MISCELLANEOUS COMMAND EXTENSIONS

-----------_ .... -_.- .... --------

The following standard MPE commands have been pxtended

to

accommodate

C5:

:NEWACCT
: ALTACC'f
:NEWUSER
:ALTUSER
The user attribute "CS" may be specified in the  of the
above commands.

USER COMMANDS

------------Two user commands are defined for CS, namelY :CLINE and :CRESE1. A user
must have CS capability to use these commands: a capability error will
result otherwise.

:CLINE Command

---------_ ... -..
The purpose of the :CLINE command is to:
1)

Enable programs to reference lines without knowledge of their actual
logical device numbers.

2) Enable a user to make detailed line specifications at run time, as
overrides to any corresponding specifications that may have been
made in COPEN intrinsic calls at compile time.
Within a program, a line may be referenced indirectly In a
intrinsic call Via a "formal lin~ designator" which is a
associated at run time With a specific :CLINE command.

3-1

COP~N

name

For user pre-defined lines:
:CLINE formaldeslgnator

=*formal~eslgnatorl

o

For new lines:
:CLINE formal designator
(;DEV=device]
(;BUF=[numbuffers][,buffslze])

n
asc
[;PROTO:

MRJE

J

HPDLCI
n
SENSE

[ ;CODE=

EBCDIC
ASCII

]

HIGH

[; DUAL=

)

LOW
R

0

W

(;DIAL=

RW
NO
n

[;LMODE=

PRI
SEC
MPCNT
MPSEC
DTE
DCE

[;DRIVER=drlvernameJ
r,DOPTIONS=n]
['SPEED: inspeed[,outspeedJ]
(;LOCID=idsequence]

[,REMID=ldsequence[,ldsequencel ••• ]
(;PHLIST=phonenumber(,Phonenumberl ••• J

o

(

~

\

.'

l;MISC=c,1[[,iJ ••• l,[c,1[[,11 ••• 1J, ••• ]

..

_/

£:DOWNFILE=filenameJ

,•
1

*****

not implemented yet

TRACE (=(ALLJ£,[mask][,(numentries][,WRAPJ )]
NOTRACE

****
]

10

NOlO
;

TIMEOUTS
NOTIMEOUTS

l;SUPLIST=

general suplist

J

f;POLLIST= pollentry [,pollentry] ••• )

**

not implemented **

*

not implemented *

where

*

C

A "strlnq"
E
id sequence=

,

/

o

(d(,dJ ••• )

H

··~

* string
*

- string of characters with "" representing ".
377

d - octal (or hexadecimal) specification of 1 byte (O<=d<=

FF

)

(A=ASCII, E=EBCDIC, O=octal, H=hexadec1mal)

*

"n" is an integer whose value 15 the encoded representation ot the
corresponding field 1n the AOPTIONS, COPTIONS,
or
DOPTIONS
parameter of COPEN.

* c,

1 - integers where
c is an integer defining the parameter type
1 15 an integer specifying the value ot the parameter.

see the COPEN intrinsic specification for the permissible values of
c.

*

c

Filename is the name of tne tile which contains the default
protocol driver information and the download records for the seep
protocol driver. This parameter is ignored for SSLC and HSI
devIces.

3-3

o

* "ALL"

will generate trace records for all CREAD, CWRITE, and
CCONTROL requests. If "ALL" is not specified, then trace records
will be written only when a CREAD, CWRITE or CCONTROL completes
with a transmission error.

*

Mask may be a decimal lnteoer or an octal
percent sign.

integer

preceded

by

a

* WRAP

specifies that succeeding trace entries may be written over
previous entries if there is no more space in the trace record. The
default Is NOWRAP.

*
*
•

Numentrles must be a decimal integer.
general supllst=mplinetype (,LSEL=ss) (,GRP=gdesc) [,GRP=gdesc) •••
~pllnetype Isa positive integer specifying the type of stations on
a mUltipoint line. If no other field appears in the SUPLIST
parameter, then "self-configuring" mode is assumed (see description
of byte 0 of the SUPLIST parameter in the COPEN Intrinsic for a
more detailed explanation).

LSEL Is the line's line selection sequence.
Gdesc describes the attributes of a multipoint terminal group.

o

ps
ps
gdese:(ID= ps,ss ,J [GEN= ps,ss ,1 STA=sdesc (,STA=sdese) •••
,ss
,ss
10 is the group polling/selecting 10.
GEN 1s the general poll/selection 10.
PS 1s the polling sequence 10.
55 1s the selection sequence 10.
ps
$5

=

A "string"
E

o

(d£,d) ••• )

H
5desc describes the attributes of a station attached
to a multipoint terminal group.
sdese=(type), [buffslzeJ, cdese (,edesel •••
3-4

o

Type is an integer whose value may be from 0
to 255.
Buffsize is the station·s output blocKsize. If
this parameter Is omitted, then the line·s buffsize
will be used.
Cdesc describes the polling and selection IDs of a
component attached to a mUltipoint tributary station.
cdesc=[ps)[,ss))
Note that CS assigns successive logical group numbers to each group
defined in the SUPLIST parameter, beQinning with one for the first
group defined.
In a similar manner, logical station numbers are
assigned to each station specified. Logical station numbers are
unique within the line. Logical component numbers are successively
assigned to each component on a station, beginning with zero for
the first component of a station. Logical component numbers are
unique only within a particular station.
Pollentry 15 either a terminal group or a station/component.
··~

C

~/

G=loglcal group number
Pollentry= logical station number
logical station number/logical component number

o
3-5

The various :CLINE parameters correspond to COPEN Intr tnsle call
parameters as follows:

O·
.

('

c

dr 1 vername

contents of array DRIVERNAME

DOPTIONS=n

DOPTIONS

TRACE= •••

CTRACEINFO

Inspeed

INSPEED

outspeed

OUTSPEED

LOCID=ldsequence

local 1d sequence 1n array IDLIST

REMID=ldsequence, •••

remote Id sequences 1n array IOLIST

PHLIST=pnonenumber, •••

phonenumbers 1n array PHONELIST

MISC=c,1,c,1, •••

c: MISCARRAY parameter type code
1: parameter value

DOwNFILE=fllename

Contents of the array DWNLOFILE.

SUPLIST= •••

SUPLIST parameter

POLLIST= •••

POLLIST parameter

3.4

o

:CRESET Command

.--------------

This command 1s the CS analog to the tile system :RESET command. It
allows the user to nullify any previous :CLINE command referenCing the
formal line des~gnator. The format of the :CRESET command Is
formaldeslgnator
:CRESET
formaldeslgnator - The formal line deJlgnator to

be

reset.

- An indication th~t the formal line destgnators
referenced In all prior :CLINE commands In the
jOb/session are to be reset.
(Either the formaldesignator or ,

3.5

~ust

be entered.)

USER MESSAGES

_._-_._---.-.

The :CLINE command may cause the following CS-speclflc errors:
Error •

Message

------800
801
802
803

805
806
807
808
809

810
812
813
814
815
816

817

818 .

-------

CLINE EQUATION TABLE FULL
aACK CLINE REFERENCE NOT FOUND
TOO MANY BACK CLINE REFERENCES
INVALID CLINE DESIGNATOR
NAME MISSING
EMBEDDED SPECIALS IN PROPER NAME
NAME BEGINS WITH NUMERIC
NAME LONGER THAN 8 CHARACTERS
EQUAL SIGN EXPECTED
VALUE NOT OPTIONAL
BINARY FAILED ON INTEGER
INTEGER EXCEEDS 377
COLON EXPECTED
KEYWORD EXPECTED
DEVICE NAME EXCEEDS 8 CHARACTERS
REDUNDANT KE¥WORD
INTEGER EXCEEDS 63
3-8

o

R19
820
821
822
823
824

INTEGER ~XCEEDS 15
DRIVER NAME LUNGER THAN 8 CHARACT~RS
INTEGER EXCEEDS 127
LINE NAME REQUIRED
ACTUAL LINE DESIGNATOR REQUIFED
BACK REFERENCE WITH PARAMETERS IS ILLEGAL

The following warning message may also appear In conjunction with the
:CRESET command:
804
401

c

CLINE EQUATION NOT FOUND
CRESET PARAMETER ERROR

3-9

o

o

o

---_ .. ~---------------------.--._.~

..... -------.-. __ .. ------------.----

USING CS/3000 INTRINSICS
I ('-'-\

Section IV
I

I

-/)-----------------------------------------------------------------4.1

GENERAL DESCRIPTION

------------------Within a user's program, the accessinQ of and communication with remote
devices Is accomplished through CS intrinsic calls. The remote/line
relationship is somewhat analogous to the file/device relationship
existing in the file system. The line is the primary link between the
user and CS; each line referenced is first opened through the COPEN
intrinsic call.
Then, other operations such as reading, writing, and
line control can be performed with other line intrinsic calls.
The
line is closed through the CCLOSE intrinsic call, issued by the user's
process or by MPE/3000 when the user's process terminates.
In the COPEN intrinsic call, the user references a particular line by
its formal line designator. When the COPEN intrinsic is executed, it
returns to the user's process a line number by Which the system
uniquely identifies the line.
This line number is also unique with
respect to file numbers as managed by the tile system. The line num~er,
rather than the line designator, 1s used by subsequent intrlnsics in
<=\referenCing the line.

)The condition codes returned to the user's program by the CS intrinsics
have the following general meanings. The specific meanings, of course,
depend on the intrinsic:
Condition Code

Meaning

-------

-------------ceE

The function requested by
completed successfully.

ceG
ceL

Variable, intrinsic-dependent.

the

intrinsic

call

was

The
function
requested
by the intrinsic call
terminated with an error or an abnormal condition;
corrective action may, in some cases, be taken. (By
issuing a CCHECK intrinsic call, the user can have a
more detailed error description returned to his
process.)

It should be noted that DB must point to the user·s process· staCK for
all COPEN and CGETINFO intrinsic calls.

4-1

For the Intrinsic descriptions to tollow, all parameters are required
unless otherwise noted: all bit fields marked for future use should be..
set to zero by the user.

..
O

o

o

4.('~'))PE:NING

LINES

The COPEN intrinsic opens a data communications line. Before a user's
process can communicate with a remote device, the process must initiate
access to the line, of which the remote device is a part, by opening it
through a COPEN intrinsic call. The intrinsic returns to the user's
process a line number which is used to identify the line in SUbsequent
CS intrinsic calls.
If the line is opened successfully (i.e., the CCE
condition code is
returned), the line number returned isa positive integer ranging from
t to 255.
If the line cannot be opened (i.e., the eCL condition code
is returned), the line number returned is ~ero.
In opening a line, COPEN establishes a communication link between the
line and the user's program by
1. Allocating exclusively to the user's process the desired line. Once
allocated, the line may not be opened or accessed by any other
process in the user's jOb/session or by any other program until the
opening process has issued a close request (CCLOSE intrinsic call).
ThUS, eXclusive access to the line is always assumed.
The process
causing the open must not attempt to open the line more than once
unless corresponding close requests have been issued.
c~)
~. Constructing the
contrOl blocks required by MPE/3000 for this
particular access to the line. The information in these blOCKS is
derived by merging specifications from the following sources, listed
below in descending order of precedence:
a. The non-overrldable
generated CS tables.
other source.

information contained in
This information overrides

CONFIGURATOR
that from any

b. The parameter list of a previous :CLINE command referencing the
same formal line designator name in the COPEN call, if SUCh a
command Was issued in this jOb or se~sion. This information
overrides that from the three sources below.
c. The

par~meter

list of the COPEN call.

d. The overridable information contained in CONFIGUFATORcs tables.

generated

When information in one· of these sources conflicts with that 1n
another, preempting ta~es place according to the order of precedence
shown above.
To determine the sp~ciflcations actually taking effect,
the user can call the CGETtNFO intrinsic described later In this
cection. '
4-3

The COPEN intrinsic declaration is as follows:
INTEGER PROCEDURE COPEN (FORMALDESIG, DEVICE, COPTIONS, AOPTIONS,
DOPTIONS~ NUMBUFFERS, BUFFSIZE, IOLIST, SUPLIST, POLLIST,
DwNLDFILE, XIY, PHONELIST, INSPEED, OUTSPEEO, MISCARRAY,
ORIVERNAME, CTRACEINFO);
VALUE COPTIONS, AOPTIONS, DOPTIONS, NUMBUFFERS, BUFFSIZE, YYY,
INSPEED, OUTSPEEO, CTRACEINFO;
HYTE ARRAY FORMAJ,.OESIG, DEVICE, IDLIs'r, SUPLIST, PHONELIST, DWNLDF ILE,
ORIVERNAME;
LOGICAL COPTIONS, AOPTIONS, DOPTIONS, CTRACEINFO;
.INTEGER NUMBUFFERS, BUFFSIZE, 'lYY;
LOGICAL ARRAY POLLIST, MISCARRAY:
DOUBLE INSPEEP, OUTSPEED;
OPTION VARIABLE, EXTERNAL;

o

This intrinsic returns (as the value of COPEN) an integer line number
used to idantify the opened line in other CS intrinsic calls. If the
line was not opened succassfully, a zero is returned.
It should be
noted that within a single process, CS line numbers and file system
file numbers are unique.
The condition codes for the COPEN intrinsic are as follows:
CCE - Request granted; the line was opened.
CeG - Not returned (reserved for future use).

o

CCL - Request denied.

The COPEN request will fall If the user does not have CS capability.
The COPEN intrinsic parameters specify the eJements shown below. Either
FORMALDESIG or DEVICE must be present (they may both be present); all
other parameters are optional.
FORMALDESIG

a byte array containing a string of ASCII ch~racters,
interpreted as a formal line designator. This string
must begin
with
a
letter,
contain
alphanumeric
Characters,
and terminate with any non-alphanumeric
char~cter.
Excluding the delimiter, the string must be
eiQht characters or less In length.
If present, this string Is used to search for the
corresponding FORMALDESIG in :CLINE commands.
If no
corresponding :CLINE command has been supplied, then the
DEVICE parameter is used to determine the device actually
open_d.
If. a corresponding :CLINE command Is found, its
DEV parameter (If specified) overrides the COPEN DEVICE
parameter.
This parameter may be omitted if the DEVICE
4-4

0

c

parameter is present.
If both FORMALDESIG and DEVICE are
present,
then
FORMALDESIG 15 first used to locate a corresponding
:CLINE command, which may override the COPEN DEVICE
parameter.
DEVICE

A byte array containing a string of ASCII characters
terminating with any non-alphanumeric character.
The
string may specify class name (up to eight alphanumeric
characters beginning with a letter) or a logical device
number (up to three numeric characters).
This parameter may be omitted if FORMALDESIG is present.
However, if it is omitted and no:CLINE command has been
suPPlied, the COPEN will fail.

COPTIONS

c

A word
with the
case the
included

describing the communications options associated
line. This parameter may be omitted, in which
default value for each field is zero. The fields
are:

Transmission code
Mode
Speed select
CLINE override
es trace
10 sequence verification
Inhibit timeouts

·.·.'~

~

/

These fields are described on page 4-10.
AOPTIONS

A word describing the access options associated With the
line. This parameter may be omitted, in WhiCh case the
default value for each field 1s zero. The fields included
are:
Wait/mode
CLINE buffer override
Dial type
Inhibit operator console error messages
Protocol
These fields are described on

DOPTIONS

c

pag~

4-12.

A word describing driver-related option~, With the
default value for each field being zero.
The format of DOPTIONS for the BSC SSLC driver and
the asc secp driver is described on page 4-13:
the fermat for the HSI driver is on page 4-15:
4-5

the format for the HPOLC I SCCP

driver

is

on

page

4-15.

NUMBUFFERS

<:)

This

Integer specifies the total number of butfers to be
to the line'or, if bUffering 15 not desired, the
number of outstanding read and write requests to be
queued. It this parameter is omitted, one buffer will be
used for lines not using HPDLC 1 protocol, and two
bUffers will be used for lines using HPDLC I protocol.
assiqn~d

A positive value speCifies the total number Of buffers to
be used. The maximum number of CS buffers allowed for a
line using the SSLC or the H51 driver Is twO) for a line
using the scep board it 15 fourteen, thus allowing ~ead
and write requests to be queued. For the SCCP board, the
maximum
number
of requests of either type to be
outstanding is seven, with the maximum total number being
fourteen.

A negative value specifies that no buffers are to be
assigned, bUt that read and write requests may be queued.
The depth of the queue is specified by the absolute value
of NOM~UFFERS. The maximum number of read requests or
write requests to be queued is seven; the ~aXimum number
of total requests to be queued is fourteen.
A value 'of zero specifies
Que4eing is to be done.
BUFFSIZE

that

no

buffering

and

no

o

This integer specifies the site of each bUffer. A
positive number denotes words; a negative number denotes
bytes.
This parameter represents the maximum data transfer size.
There exist three related default values in the CS
system:
(1) a system-defined upper bound of 4096 wordS on
any
transfer
(2) an HPDLC 1 protocol-defined upper bound of 512
words on any transfer
(3) a configured,' preferred butler size tor the line.
If BUFFSIZE exceeds the upper bound, the upper bound will
be used in place of BUFFSIZE.
If BUFFSIZE Is not
specified, the configured preferred bUffer size will be
u.ed as a default value.
For a line operating in multipoint control mode, a
non-zerO 8UFFSIZE specifies the maximum block size for a
slngle transmission. A request to send a block of data

o

(j

IDLIST

that exceeds the BUFFSIZE parameter will be reformatted
into a series of requests with data bloCks having length
not exceeding BUFFSIZE. If data 15 received In bloCKS, an
error will occur unless BUFf SIZE is non-zero, which
permits the reception of data in bloCkS. (Specification
that data may be read in blocks may also be made usinq
the bloCK size portion of the station field In the
SUPLIST parameter.)
A byte array containing ID sequences for both the local
and the remote stations. At most 255 10 sequences may be
specified.
Note:
If
no remote 10 sequences are
specified, then any received 10 sequence is ignored. This
array is described on page 4-16.

****

This
HPDLC I.
SUPLIST

C\
/

parameter is inapplicable to, and ignored by,

This is a byte array describing the maximum set of
groups, stations, and components Which will be recognized
on a multipoint line. For d line operating in mUltipoint
control mOde, this list describes th~ stations which will
bepolled/selected by the 3000. For a line operating In
mUltipoint
secondary mode, this list describes the
station or stations whiCh will b~ simulated by the 3000
when polled/selected by the control station.
This array is used to generate a default POLLIST if toe
POLLIST parameter is omitted. This array Is deScribed on
page 4-18.

****

This parameter is vdlid only for lines using
mUltipoint control or mUltipoint secondary mode and is
ignored for all other line modes.
POLLIST

c

A word array which defines the poll list for 8 mUltipoint
line. When the local station is the control station, this
list specifies whiCh stations shall be polled and their
order of polling. When the local station is a secondary
station, this list specifies the current set ot groups
and stations to be simulated by
the
3000.
(See
description of the POLLIST parameter of the CPOLLIST
intrinsic for the format of the pollist.)
CS will use
this lis~ whenever the STATION parameter of a CREAD 15
absent. if this parameter is omitted then a default list
will be generated consisting of component zero of each
station on the line. The default list will be optimized
to the extent that a logical group number entrY will be
used to poll terminal groups whiCh support general poll.,

4-1

•••• This parameter Is valid only tor lines operating In
and is ignored for all other
lines.

mUltipoint ,control' mode

DWNLDFILE

A byte array containing a string Of ASCII Characters,
interpreted as the formal tile designator of the file
containing the default protocol driver information and
the download records for the secp protocol driver. This
sttlng must begin with a letter, contain alphanumeric
characters, slasheSj or periods and terminate with any
non-alphanumeric character except a slash or a period.
If thiS parameter is omitted, then the default download
file name of SCCPLD01.PUB.SYS" 15 used. Thla parameter is
ignored for SSLC and HSI devices.

fYY

(Reserved for future use.)

PHONELIST

A byte array specifying one or more remote Phone numbers
for a switched line, and Is described on page 4-18. This
array is ignored for non-switched lines.

INSPEED

A dOUble-word integer specifying the line input speed in
characters per second. If the line·s hardware is such
that its output and input speeds are always the same,
then INSPEED will be used to specify both speeds.

OUTSPEED

A double-word integer specifying the line output speed in
characters per second.

MISCARRA¥

A logical array containing miscellaneous CS information.
The fieldS included are:

0

o

Receive timout
Local timeout
Connect timeout
Response timeout
Line bid timeout
Number of error retries
Clear·to-send delay
Data-set-ready delay
Transmission mode
MMSTAT trace facility
Poll loop delay
Number of poll repeats
Poll entry delay
This array is described on page 4-20.
DRIVERNAME

A byte array containing a string of ASCII alphanumeric
which are interpreted as the name of the

character~

4-8

o

desired driver for the line. The name consists Of up to
eight characters, beginning with a letter, and followed
by any alphanumeric Characters, and terminated by a
non-alphanumeric Character. (The delimiter is not counted
as one of the eight Characters.)
This parameter may be omitted, in which case the default
driver for the line will be used. When specified, the
driver must be one which was included at configuration
time in the set ot available CS drivers.
The protocol driver must be compatible with the line
configuration with respect to the following:
1.
2.
3.

4.

(~.'\

linetype (see CGETINFO).
local mode COPTIONS.(b:4).
protocol
AOPTIONS.(O:8).
transmission code. COPTIONS.(10:6).

The driver used tor the secp -board on the 3000 is
"IOSCCPX"; on Series 33 it is "TPDUMCS". If another
driver name beginning with the letters "CS" 15 specified
for the SCCP, the specified name is used to indicate the
protocol . driver to download, and not the mainframe
driver.

,/

CTRACEINFO

c

A word used to control
the CS trace facility.
This
parameter is ignored If the CS trace facility bit of the
COPTIONS word Is not set. See page 4-23 for the format of
CTRAC INFO.

DE~AILEO

DESCRIPTJONSOF VARIOUS COPEN PARAMETERS

o

COPT IONS

The fields of COPTIONS are defined as
(0:1)

Inhibit timeouts

=0
=1

.*••

( 1: I )

allow timeouts
disable all timeouts
(This field does not apply
Ignored by HPDLC I.>

~o

and Is

IO Sequence Verification

=0
=1
*•••
(2:1)

follow~:

allow the use of 10 sequences (both
user·supplied and configured defaults)
inhibit the use of 10 sequences. Any
user·supplied or configured default ID
sequences will be ignored (apPlies to
both local and remote ID sequences).
(This field does not apply to, and is
ignored by, HPDLC I.)

CS trace

=0
=1

do not invoke CS trace facility
invok~ cs trace facility.
( Refer to CTRACINFO parameter on page 4·21 )

(3:1)

:CLINE override

=0
=1
(4:2)

o

allow CLINE command override
prOhibit CLINE command override.

Speed

Select (European modems only)

=0

use configured default setting
set speed to 10- speed
set speed to high speed
= 3 reserved for future use. Specification
of this value will cause a COPEN error.

=1
=2

4-10

o

(~
: .....

/

(6:4)

Local mode ("local" means the station at
your end of the line)

=0
=1
=2
=3

use configured default setting
local 15 a primary contention station
local 1s a secondary contention station
local Is a control station on a
multipo1nt lIne.
= 4 local is a secondary station on a
multipoint line.
= 5 local is a HPOLe I system acting as OTE
= 6 local is a HPDLC I system acting as DeE
= 1-15 reserved for HP use
A COPEN error will result if local mode is not compatible with
either COPEN parameters or configured line values.
(10:6)

Transmission code

=0

c·.·\
/

use configured default setting

= 1 use automatic code sensing feature
of driver
= 2 ASCII
= 3 EBCDIC
= 4-63 reserved for HP use
**** (Data Is transparent to HPOLe I, and

this
field is ignored when using the HPDLC 1 protocol.)

c
4-11

o

AOPTIONS
The fields of AOPTIONS are defined as follows:
(0:8)

Protocol
0
-= 1

use
use
2 use
= ] use

--

configured default protocol
asc protocol
MRJE protocol
HPDLC I protocol
4-255 reseJ"ved for HP use

A COPEN error will result If protocol is not compatl~le with
configured line specifications or driver capabilities.
for future use.)

(8:3)

(~eserved

<11:1)

Inhlbit conSOle operator error message

=

0

=1
(12:2)

allow CS to print hardware error messages at the
operator console
InhlbitCS from printing hardware error messages
at the operator console

Dial type

o

=0

dial on write connect; answer on read
connect
1 answer on write connectJ dial on read
connect
= 2 dial on write connect; dial on read
connect
3 answer on write connect; answer on
read connect.

=
=
(14:1)

:CLINE buffer override

= 0 allow:CLINE override for NUMBUFFERS
and BUFFSIZE
= 1 disallow buffer information override.
(IS:I)

Wait mode

=0
=1

perform all 110 using NCIO.
perform all 110 using CIO.

Note: Only users executing In privileged mode may open a line
with CIa and no bUffering.
4-12

o

The meanlnQ of OQPTIONS is protocol driver-dependent.
For the SSLC drivers and the asc SCCP drivers, the format of DOPTIONS 1s
as follows:
(0:1)

Reserved for future use
Delay sequence wait
o Walt on received WACK/TTO sequences.
1 = 00 not wait on received WACK/TTO sequences.

(1:1)

=

Poll termination sequence
= Before switching between stations, an RVI 15 transmitted
to return the line to control mOde.
1 = Before switching between stations, an EQT 15 transmitted
to return the line to control mode.

( 2: 1 )

o

(3:1)

Control state listen mode
o = While in control state and between user requests the driver
will listen for any control sequ~nces from the remote.
Receipt of a line bid will cause the line to be Placed into
text state.
1 = While in control state and between user requests the driver
will ignore any control sequences from the remote.

(4:2)

Ending sequence:
o = use BSC default (NSW=send EOT;
SW=send OLE EDT)
1 = send OLE EDT'
2 = send EDT

(6:1)

0 = the remote will not send leading graphics
1 = expect leading graphics from the remote

(7:1)

Value of USASeII blOCK CheCk character (bcc)
o = VRC/LRC (non-transparent mode or transparent with header)
CRC-16 (transparent mode with no header)
1 = VRC/CRC-16 Cnon-transparent mode)
CRC-16 (tr~nsparent mode)

(8:1)

0
1

(9:1)

0
1

= automatic generation
= no WACK will be sent
= automatic generation
= no

of WACK
of TTO

TTO will be sent

4-13

(10:1) ITB Sequences

o

= DO

t

=

Q

not expect to receive ITB sequences from the remote
station
If an ITB sequence 15 received, the driver will
Note:
require a retransmission to properly receive the
message. The driver then sets this bit to a one.
Expect ITS sequence from the remote station.

(11:2) Message

Format Word (MFW).
Refer to Section 4.13 for a
description of the MFW.
G
MFW will not be pl~ced into received text or expected in
sent text. CS w1Iluse an implicit MFW of 000000 for sent
text.
1 = MFW will not be placed Into received text OZ expected In
s.nt~ext.
CS will use an Implic1tMFW of 100000 tor sent
text.
2 : MFW will be placed into received and expected in sent text.
3 ~ reserved for future use.

=

(13:1)

(14:2)

Reserved for future use.
Number of leading SYNs
= send four leading SYNs
1 = send eight leading SYNs
2 = send twelve leading SYNs
3 = send sixteen leading SYNs

o

o

o

FC:;the HSI driver, the format of
1s as follows:

DOPTIONS

(0:1)

Reserved for future use

(1:1)

Delay sequence wait

(2:1)

Ignored.

(3:1)

Control state listen mode
o = While in control state and between user requests the driver
will listen for any control sequences from the remote. Receipt
ot aline bid will cause the line to be placed into text state.
1 = While In control state and between user requests the driver
will ignore any control sequences from the remote.

(4:2)

Ending sequence:
= Use 8SC default (NSW=send EDT;
Sw=send DLE EDT)
1
send DLE EOT
2 = send EOT

o

=

(7:1)

C:

1l

(9:1)

ignored
Automatic generation of WACK sequences:
= enable
1 :::: disable

o

Automatic generation of lTD sequences:

() = enable
1

(10:3)

= disable

Ignored

(13:1) Reserved for future use

(14:2) Ignored

For the HPOLC r SC3 driver, the format of DOPTIONS is as follows:
(0:8)

Reserved for future use

(8:8)

Maximum number of outstanding frames. This Is parameter
K in the HPDLC I protocol. Valid values are one thrOugh
seven. The default Is seven.

o

4-15

o

IOLIST
IOLIST is a byte array with the following format:

byte 0

total number of 10 sequences
(including the zero-length IDs)
length of local 10 sequence in bytes (may be zero)
1
local 10 sequence (null if length =0)
2-n
length of remote 10 sequence in bytes (may be zero)
n+l
(nt2)-p remote 10 sequence (null if length =0).

Repeat the last two fields for each remote 10.
The length of an ID sequence may vary from zero (meaning a nUll 10
sequence) to sixteen bytes. If a remote station is not capable of sending
an 10 sequence, then the local 10 sequence length should be zero: If none
of the r~mote stations can transmit an 10 sequence, the remote 10 sequence
should be zero.

PHONELIST

Phonelist is a byte array with the following format:
byte 0
1

2-n

o

number of phone numbers (binary)
length of first phone number (binary)
first phone number (ASCII numeric with embedded "dashes")

Each successive phone number is specified by repeating the last two
fields.
A phone number consists of from 1 to 20 characters (ASCII
numerics with embedded "daShes").
This parameter 1s lqnored If the line Is non-switched. When operating in a
switched full-duplex environment, there may be two Phones. If there are
two Phones, CS will access the Phone list in pairs, i.e., two dial
messages will be issued When necessary. The specification of two Phones Is
done at system configuration time.

4-16

o

('\
LIST
LIST is a byte array with the following format:
leld one

=

Byte 0
Byte t

CRyte

2

Byte 3
Byte 4

Byte 5-n
'ield two ::

Byte 0

Byte 1
Byte 2

Line field.

This must be the first field/of the SUPLIST.

Multipoint Line Type
(This byte reserved for future use.)
Line Descriptor
(0:5) Reserved for future use.
(5:2) 10 Veritication
o = No 10 verification wl1l be performed.
1 = Initiate the sending of 10 sequences and,
when
the remote's 10 sequence has been successtully
verified, send an EDT sequence.
2 = Allow the remote to initiate the Sending of 10
sequences.
3 :: This value is undefined.
CS will reset the
field to a zero.
(1:1) Line selection
o = The configuration does not support line
selection.
i = The configuration has the
line
selection
facility.
This byte is ignored.
Number of remote groups.
Length of line selection sequence.
Note: This parameter and the next one should be present
If and only if bit (7:1) of the 11ne descriptor
specities line selection.
Line selection sequence (null It length=O).
Group field. Repeatea for each group attaChed to the 11ne.
COPEN assigns successive loqical group numbers to each
group defined for the line, beginning with 1 for the first
group specified.
Group descriptor
(0:6)
Reserved for future use.
(6:1) 0 = NO general select facility
1 = This group has the general select capability
(7:1) 0 = No general poll facility
1 = This group has the general poll facility
Number of stations ·in this group.
Length of the group ID portion Of the polling sequence.
A value of zero is valid.
Group ID portion of the polling sequence (null if
4-17

lengtn=O).
Length of the qroup 10 portion of the selection sequence.
A value of zero is valid.
Byte (k+2)-m Group 10 portion of the selection sequence (null if
length=O).
Byte (m+!)
Length of general poll portion of the polling sequence.
Note: This parameter and the next one shoUld be present
If and only if bit (7:1) of the group descrlptor
specifies general polling.
Byte (m+2)-n General poll sequence (null If length = 0).
Byte (n+!)
Length of general selectlon portlon of the selection
sequence.
Note: This parameter and the next one should be present
if and only if bit (6:1) of the group descriptor
specifies general selection.
Byte Cn+2)-p General selection sequence (null if length = 0).
Byte k+l

Field tnree

=

Byte 0

station f1eld. Repeated for each station in the group.
COPEN assigns successive logical station numbers to each
station defined for the line, beginning with 1 tor the
Note that a station number is
f1rst station specified.
unique for the line, not just for the station's group.
station type
(0:1)
(1:1) 0

Byte 1
Bytes 2-3

Field four

=

Byte 0

Byte t-k

o

=
l;nored.
= The
terminal·s

input blockslze value Shall
be the same as the line·s BUFFSIZE value.
1
= The terminal·s input blocksize value Is
contained In bytes 2-3 of this field.
(2:6) 0
= HP 2645 terminal
1-40 = Reserved for HP use.
41-63 = Reserved for user detined terminal types.
Number of components attached to this station.
Integer value of the terminal·s fixed-length block size.
This number specifies a word length if positive, and a
byte length If negative.
Note: This parameter should only be present if and only
If bit (1:1) of the station descriptor Is set to a
one.

0.'

Component field.
Repeated for each component of the
station. COPEN assigns logical component numbers for each
component defined tor the station, beginning with Zero for
the first component specified 1n the station.
Length of component ID portion of the polling Sequence.
May be set to zero.
Component's polling ID.
This field 1s omitted If the

o

(

...

length Is zero.
Length of the component 10 portion of the selection
sequence. May be set to zero.
Byte (k+2l-m Component·s selection. 10. This field Is omitted it the
length 1s zero.
Byte (k+ll

o
4-19

o

MISCARRAY

MISCARRAY is a word array with the following format:
word 0
1

2-0

number of words of parameter
information following this
word.
parameter type
parameter

Repeat the last two fields for each parameter
type to be specified.
Each parameter type will define the meaning and size of the parameter
which follows it.
Currently, the parameter associated with each
parameter type consists of a single word quantity.
The defined
parameter types are

o•

receive timeout 1n seconds.*
(default=20)
*.*. (This value is inapplIcable to, and ignored by, HPOLC I.)

1 - local timeout in seconds.*

(default=60)
.*** (This value Is inapplicable to, and ignored by, HPOLC

2 - connect timeout in seconds.*

(default=900)
3 - response timeout.*

(default=3)
**** For the HPDLC 1 protocol this is parameter T1.
Configured default values vary with the
transmission speed, as specified below.
SPEED(Cps)
. HPDLC I RESPONSE TIMEOUT (sec)

_-_------5600
5000
4080
1920
960
480
240

------------.------_ .. _-------

*.

to be defined

4 - line bid timeout.*
(default=60)
***. (This value is inapplicable to, and
HPDLe I.)
4·20

**

ignor~d

by,

o

(":~'".'i

5 - number of error recovery retries by driver.

(Default=6)
6 - = 0, Clear-to-send delay shall be the default (whiCh 1s
determined by the modem for the SSLC board).
<>0, Clear-to-send delay value in tenths of seconds.
IOn the seep, clear-to-send delay defines the amount of time
the driver will await the expected clear-to-send chanqe
before deciding that the modem 15 broken. The default value
is 300 msecs; a non-zero value wl1l override this default.
7 -

ij

-

= 0,
= 1,

No time will be allowed for the Data Set Ready slgnal
to stabilize.
Wait 100 milliseconds for the Data Set Ready slQnal
to stabilize after it first goes true.

= 0,
= 1,

Set the line·s transmission mode to full-duplex.
Set the 11ne·s transmission mode to half-duplex.
(This value is inapplicable to, and ignored by,

****

HPDLC I.)

9 -

e
m'."

"\

/

****

= 0,

Disable MMSTAT trace facility.
<>0, Enable MMSTAT trace facility to trace the drlver·s state
transitions. When using the SSLC or the HSI interfaces,
MMSTAT is used to trace the interface drlver·s state
transitlons~ When using the SC3 interface, MMSTAT is
*** yet to be defined ***
This facility is described in the MPE Memory Manager
documentation.

The following three parameters are used only for
multipoint control mode, and are otherwise ignored.

lines

in

10 - Poll

loop delay.
Parameter is the number of hundredthS of
seconds of delay between iterations through a wrap (Circular)
polling list.

11 - Poll

repeat.
Parameter specifies the maximum number of
iterations through the polling list. A value of zero implies
an unlimited number of passes through the list. A value other
than one makes the list a wrap (circular) list. Polling is
terminated when either of the following conditions OCcurS: a) a
station responds to a poll or b) the specified number Of passes
through the p~lling list has been made with no station
reSPOnding.'

c

12 - Poll entry delay.

between

pOlling

Parameter
each entry
4-21

Is
in

the
the

delay in milliseconds
polling list. If this

parameter Is omitted then the default value will be taken fromQ,
. ·.. · ....
a. the confi9uration dialogue for pre-configured lines
.
b. from the driver for all other cases.

•

A value of zero will disable the timeout.

o

4-22

o

CTRACEINFO
follows:

is

used

to

control

the

CS trace facility; its fields are as

(B:8) Number of trace entries.
This value represents the number of CS
trace entries which will be accumulated, for each 1/0 request,
before
wrap
around
occurs.
If
this
field
15 zero, a
driver-dependent default will be used.
(2:6) Cs trace mask.
This field is a mask which will indicate to the driver Which types
ot information are to be traced.
If this field Is zero, a
driver-dependent default will be used.

For the drivers using the Bisync protocol, the format
maSK is as follows:
bit 2 generate
3 generate
4 generate
5 generate
6 generate
7 generate

C)

STN entries
OPR and EDT entries
RCT entries
RTX entries
SCT, POL, SEL entries
STX entries

*
*
*

*

of

the trace

*

*

default
NOTE: eMP entries are automatically generated.
For the HPDLC I SCCP driver, the format of tne trace maSK Is as
follows:

***
( 1: 1)

to be defined

****

Trace entry fill type.
This value specifies the action to be taken
condition occurs.
setting the field to
entries to be overlayed, whereas a value of
entries to be discarded.

When the wrap-around
a one causes previous
zero will cause new

(0:1) CS trace type.

=0
=1

trace on transmission errors only
trace all CREAD, CWRITE, and CCONTROL requests.

See Chapter 6 for a detailed discussion ot the

4-2.3

CSTRAC~

facility.

4.3

o

CLOSING LINES

-----_._._---

To terminate access to a line, a user·s process must close the line
through a CCLOSE intrinsic call. This intrinsic de-allocates the line
and deletes the control blocks and CS supplied buffers (if any) thrOugh
which communication with the remote devices attached to the line was
accomplished.
If the user does not issue CCLOSE calls for all lines
open~d by hls process, the
system wlll issue suCh calls when the
process terminates. If this request is made to an seep device which
reports a RAM system failure, a dump of the secp RAM is attempted via a
CCONTROL 53 with a paramter of zero.
The CCLOSE intrinsic declaration is as follows:
PROCEDURE CCLOSE (LINENUMBER);
VALUE LINENUMBER;
INTEGER LINENUMBER;
OPTION EXTERNAL;

The CCLOSE intrinsic closes a CS line. If necessary, it
the line for disconnection and then disconnect it.
The condition codes for the CCLOSE intrinsic

ceE -

ar~

will

prepare

as follows:

The line was closed successtully.

eCG - (This condition code is not returned.)

o

eeL - The request was rejected because  is invalid.
The CCLOSE parameter is
LINENUMBER

An integer specifying the line number of the line to be
closed. This is a required parameter.
If the line was
opened with the CIa specificat10n and an I/O operation is
pending, CCLOSE will abort the 110 operation and close the
line in an orderly fashion.

o
4-24

4() READING FROM REMOTE DEVICES

--~--~--------------------To read from a remote device, a user process issues a CREAD intrinsic
call specifying the line to which the remote device is attached.
'rhe CREAD tntr insiccan perform two separate functions with respect to
data transfer, the choice of which is line dependent. If the line to
be accessed was opened with NerO, CREAD will return control to the user
process atter completion ot the data transfer from the remote station.
If the line waS opened with CIO, CREAD will cause the read operation to
be initiated and then immediately return control to the calling
process.
A SUbsequent IOWAIT intrinsic call will wait for the read
operation to be completed and data transferred into the user's stack.
All CREAD intrinsic calls to a line opened with CIO must be followed at
some point bV an IOWAIT intrinsic call. Reads may be issued until the
CREAD Is rejected due to a laCK of CS line buffers before It is
necessary to issue an IOWAIT. It is guaranteed that reads will complete
1n the order in whiCh they were requested.
An IOWAIT intrinsic c~ll must not be issued after a read request for a
line opened with NCID.
'\ I t buffering is not used, the data read will
(

~

be transterred directly
into the user's staCk causing the stack to be frozen until completion
ot the read. The use of buffering does not require that the stack be
frozen during the I/O transfer. ThUS, more efficient memory management
is obtained when buffering is used. This is particularly true for data
communications 110 whiCh 15 relatively slow and often depends on human
interaction at the remote site.
If this request is made to an SCCP device which reports a RAM system
failure, a dump of the secp RAM is attempted via a CCONTROL 53 with a
parameter of zero.

Within each data transfer function, the user can specify driver related
operations to alloW pim complete control of the communications link
between his program and the remote device.
The CREAD intrinsic declaration is as follows:
INTEGER PROCEDURE CREAD (LINENUMBER, INBUF, INCOUNT, STATION,
REAOSTATION);
VALUE LINENUMBER, INCOUNT, STATION;
INTEGER LINENUMBER, INCOUNT;
LOGICAL STATION, READSTATION;
ARRAY INBUf';
OPTION VARIABLE, EXTERNAL;

()
4-25

This intrinsic returns (as the value of CREAD) a non-zero integ..l"\
specifying the length of the received message for a line using NCIO ~
no transmission errors incurred; else zero Is returned.
A positive value is always returned for the message length.
If the
INCOUNT parameter was negative, the procedure value ~epresents bytes;
if INCOUNT was positive, the procedure value represents words.

The condition codes for the CREAD intrinsic are as fOllows:
a) AOPTIONS of COPEN specified CIO:

ceE • Read initiated.
eCG • (This condition code Is not returned.)
eeL ~ Read not inltiated# an error occurred.
NOTE: A eCL wtll be returned if CS has no line buffer for the
request (i.e., the line buffers were all allocated for
previous requests: an IOWAIT should be issued to Check for
completion of these requests).
b) AOPTIONS of COPEN specified NCIO:
CCE • Read completed.
(~";
CCG - End of Transmission sequence received.
.~
This condition code is never returned when using HPDLC I
eCL - An error or an abnormal condition occurred.

***

The CREAD parameters are
LINENUMBER

an integer specifying the line number of the lIne.
parameter is always required.

INBUF

a word pointer specifying the DB-relative address of the
user·s input buffer. This parameter 15 not required and
is ignored when performing CIO with buffering or if
INCOUNT has been set to zero or omitted.

INCOUNT

an integer specifying the length of the data to be
transferred. A positive value denotes words; "a negative
value denotes bytes. This value must not exceed the
resultant BUFFSIZE as determined by COPEN. If this
parameter 1s omitted, its value will be set to zero.

STATION

a

word

This

identifying the logical station or logical grout>
4-26

number of the remote tributarY
mode.
(0:4)

(4:4)
(8:8)

for

a

line

In

control

Station format
Set to zero.
Logical component number
Logical station number. A station number of
is invalid.

Group format
(0:1) Set to one.
(1:7) Set to zero.
(8:8) Logical group number.
invalid.

A group of zero or

zero

255

is

A value of minus one for STATION specifies the currently
accessed station. If STATION is absent or zero, the poll
list will be used to solicit input. If the STATION
parameter Is specified and nonzero, the poll list 15
circumvented~
Note: Logical group numbers may only be
used for gtoups that support general poll.
****This parameter is meaningful only when the local
station is a control station and is ignored for anY other
type of line mode.
QEADSTATION

If the local station is a control station, READSTATION is
a word to Which Is returned the logical station and
component numbers of the responding tributary station.
If STATION was specified, then READSTATION = STATION. The
REAOSTATION parameter format is identical to the .station
format of the STATION parameter.

**** This parameter is meaningful only for
operating in control mode, and is otherwJse zero.

()
4-27

lines

o

4.5
WRITING TO REMOTE DEVICES

--..--- --

_

.

To write to a remote device, a user process issues a CWRITE intrinsic
call specifying the line to which the remote device Is attached.
Under the BSC line protocol, a conversational mode of communication can
exist. This mode allows a transmission to be immediately fOllowed bY a
receive on the same remote device. A user process can request SUCh a
conversational write in the call to CWRITE by specifying an input
buffer.
If the line has been opened with CIa and buffering, then only
the INCOUNT parameter need be specified.
If the line to be written to has been opened with the CIO specification,
the user must eventually Issue an IOWAIT call to suspend his process and
await the completion of one of the pending requests. Writes may be
issued until the CWRITE is rejected due to a lack of line buffers before
it is necessary to issue an IOWAIT. It is guaranteed that outstanding
writes will complete in the order in which they were requested.

An

IOWAIT intrinsic
using NCIO.

call

must

not be issued after a write to a'line

If buffering is not used, the user·s,s,tack Wi1, 1 remain frozen in mem01)'~",'
until completion of the write request. Thus, in general, bufferi "
should be used to allow more efficient memory management. The use
should not attempt to access the write buffer specified in a CWRITE
intrinsic call to a line using CIa if buftering Is not used, data in the
buffer may be destroyed before completion of the request by IOWAIT.
If this request is made to an scep device which reports a RAM system
failure, a dump of the secp ~AM is attempted via a CCONTROL 53 with a
parameter of zero.

The CWRITE intrinsic declaration is as follows:
INTEGER PROCEDURE CWRITE (LINENUMBER, aUTBUF, OUTCOUNT, INBUF,
INcaUNT, STATION);
VALUE LINENUMBER, OUTCOUNT, INCOUNT, STATION;
INTEGER LINENUMBER, OUTCOUNT, INCOUNT;
LOGICAL STATION;
ARRAY aUTBUF, INBUF;
OPTION VARIABLE, EXTERNAL;
This intrinsic returns (as the value of CWRITE) a non-zero integer only
for requests doing NCIO which did not incur transmission error~. This
integer specifies the length of the sent message if the write request
did not specify an input bUffer; it specifies the length of the received
message for 'write requests which do specify an input buffer.

Q

4-28

~;~

positive value Is always returned for the message length.
If the
- INCOUNT parameter was negative, the procedure value represents bytes; if
INCOUNT was positive, the procedure value represents words.

c

o

The condition codes for the CWRITE intrinsic are as follows:
a) AOPTIONS of COPEN specified CIO:
CCE
CCG
CCL

Write initiated.
(This condltion code is not returned.)
Write not initiated, an error occurred.
NOTE: This condition code will be returned if CS has nO line
buffers for the request (i.e., the line buffers are all
allocated in previous requests; an IOWAIT should be issued
to check for completion of these requests.)

b)

AOPTIONS of COPEN specified NCIO:
CCE
eCG

eCL

Write completed.
End of Transmission sequence received.
This condition code Is never returned when using HPOLC I.
An error or abnormal condition occurred.

****

The CWRITE parameters are
This

LINENUMBER

an integer specifying the line number of the line.
parameter is always required.

OUTBUF

a word pointer specifying the DB-relative address of
user's
output buffer. This parameter is ignored
OUTCOUNT is omitted or set to zero.

OUTCOUNT

an integer specifying the length of the data to be output.
A positive value denotes words; a negative value denotes
bytes. This value must not exceed the reSUltant BUFFSIZE
as determined by COPEN. If this parameter is omitted, its
value will be set to zero.

INBUF

a word pointer specifying the DB-relative address Of the
user's input buffer. This parameter is not required and,
hence ignored when performing CIa with buffering.
It is
ignored 1f INCOUNT is omitted or set to zero.

th~
if

****

Conversational Bisync (i.e. MRJE HASP) requires both
INBUF and INCOUNT.

INCOUNT

an integer specifying the length of the data to be input.
A positive value denotes words; a negative value denotes
bytes. This value must not exceed the reSUltant BUFFSIZE
as determined by COPEN. If this parameter is omitted, its
value wIll be set to zero.

STATION

a word identifying the logical station
4-30

or

logical

grou4:)

c·.
u

."."

/

number of the remote tributary for a line in control mode.
Station format
(0:4) Set to zero.
(4:4) Logical component number
(8:8) Logical station number.
is invalid.
Group format
(0:1) set to one.
(1:7) Set to zero.
(8:8) Logical group
Is invalid.

number.

A station number of zero

A group number of 0 or 255

A value of minus one for STATION specifies the currently
accessed station. If STATION is absent or zero then all
stations on the line are specified (line select).
Notes: 1) Line select may only be used tor lines that
support line select.
2) Logical group numbers may only be used for
groups that support group select.

****

c

This parameter Is meaningful only when the local
station is a supervised control station and is ignored for
any other type of line mode.

4-31

4.6

_.. _----_ .... -.-._-_.- .... _--_ .. __

o

._-

COMPLETION OF CONCURRENT 1/0 REQUESTS

If a CS line has been opened or CCONTROLed with the CIO specification,
l.e., AOPTIONS.(15:1)=1, all read and write requests must be followed
oy an IOWAIT intrinsic call. This call initiates completion operations
for the associated 110 request including data transfer into the user·s
stack if necessary. MUltiple reads and writes to the same line may be
Issued before the IOWAIT call is made. This allows for maxlmuul line
utilization as well as 110 and processing overlap.
If thIs request 15 made to an SCCP device Which reports a RAM system
failure, a dump ot the SCCP RAM is attempted via a CCONTROL 53 with a
parameter of zero.

The IOWAIT intrinsic declaration is as follows:
INTEGER PROCEDURE IOWAIT (IONUMBER,INPUTBUFFER,RECORDLENGTH,CSINFO);
VALUE IONUMBER:
INTEGER IONUMBER, RECORDLENGTH;
LOGICAL CSINFO;
AR~AY INPUTBUFFER;
OPTION VARIABLE, EXTERNAL;
This intrinsic returns (as the value of IOWAIT) an integer representi~
the line number for Which the completion occurred. If no comPleti~
occurred, this number will be zero.
The IOWAIT intrinsic can return the following condition codes:
ceE - 110 completion occurred without errors (IOWAIT<>O).

CCG - End of Transmission sequence received
for
(IOWAIT(>O) •
This condition code is never returned when

•***

CS

device

using

HPDLC

I.

eCL - Normal I/O completion did not occur, because of an error or
abnormal complet10n.
1) no request(s) pending
(IOWAIT=O)
2) parameter error
(IOWAIT=O)
3) 110 error or abnormal condition CIOWAIT<>O)

The IOWAIT parameters are
IONUMBER

An

integer

specifying
4-32

a

CS

line

number,

an

FS

f114t)

number, or zero. (NOTE: within a single process, tile
numbers and line numbers are unambiguous.) If zero or not
specified, IOWAIT will wait tor the first 110 completion,
without distinguishIng between tile system and CS. If
IONUMBER is positive, then IOWAJT will wait for the
completion of that particular line or file number.

C;

~

INPUTBUFFER

word pointer specifying the DB-relative address of the
user·s input buffer area
to
which
the
received
message/record will be moved. This buffer area must be
large enough to contain the input message/record. This
parameter
Is required only if the COPEN specified
buffering and the completed request was a read or a
conversational write.

RECORDLENGTH

A
word
to
which Is returned a positive integer
representing the length of the record/message received or
transmitted.
If the origInal request speCified a byte
count, the integer represents bytes; if the request
specified wordS, the integer. represents words. This
parameter is required only for reads and conversational
writes; it is ignored for all other writes.

CSINFO

A word to which is returned information about the
completing request, with the following format:
(0:1) Group tlag
= 1 Logical group number is specified
= 0 Logical station and component number is
specified

A

(1:1)

Type of completed request
= 0 Read
= 1 Write or Write Conversational

(4:4) Logical component number when local station is
control station.
Zero otherwise
(8:8) Logical station number (If Group £lag=O) or
Loqical group number
(It Group flag=1) when
local station is control station.
Else zero.

c

4-33

4.7

o

OBTAINING LINE INFORMATION

--------------------------

_Once a user process opens a line, it can request information about that
line from the CGETINFO intrinsic.
The CGETINFO intrinsic provides Qeneral information about the line as
actually opened. The information returned includes 1) the parameters
of the COPEN call as modified by :CLINE commands and CS (configured)
default values, and 2) global information about the line SUCh as its
logical device number and line type.
The CGETINFO intrinsic declaration is as follows:
PROCEDURE CGETINFO (LINENUMBER, LDMUM, LINET~PE~ COPTIONS, AOPTIONS,
DOPTIONS, NUMBUFFERS, BUfFSIZE, IOLIST,
IOLISTLEN, SUPLIST, SUPLISTLEN, POLLIST,
POLLISTLEN, OWNLDFILE, YYYYY, PHONELIST,
PHONELISTLEN, INSPEED, OUTSPEED, MISCARRAY,
MISCARRAYLEN, DRIVERNAME, CTRACEINFO);
VALUE LINENUMBER, IOLISTLEN, SUPLISTLEN, POLLI~TLEN, PHONELISTLEN,
MISCARRAYLEN;
INTEGER LINENUMBER, NUMBUFFERS, BUFFSIZE, IOLISTLEN, SUPLISTLEN,
POLLISTLEN, YYYYY, PHONELISTLEN, MISCARRAYLEN;
LOGICAL ARRAY POLLIST, MISCARRAY;
LOGICAL LDNUM, LINETYPE, CaPTIONS, AOPTIONS, DOPTIONS,
CTRACEINFO;
DOUBLE INSPEED, OUTSPEED;
BYTE ARRAY IDLIST,SUPLIST, DWNLDFILE, PHONELIST, DRIVERNAME;
OPTION VARIABLE, EXTERNAL;
The condition codes for the CGETINFO intrinsic are as

c=J

follows~

. CCE - The request was granted.

cee - The driver was unable to return the information requested.

ceL •

The request was not granted because an error occurred.

All CGETINFO parameters are optional
parameters are defined as follows:

LINENUMBER.

The

LINENUMBER

An integer specifying the line number of the line.
is a required parameter.

This

LDNUM

A word to which is returned the logical device number
the line.
4-34

except

for

of

o

() LINETYPE

A word to which is returned three fields which define the
type of line.
(0:4) device sUbtype
(4:6) device type
(10:6) a number which provides a more succ1nct
description of the line:
1
2
3
4
5

SW
SCCP
= sccp
=
= HSI -NSW

-

NS~

COPTIONS

A word to which 1s returned a bit string representing the
communications options currently in effect.
The format
Is the same as that of the COPT IONS parameter of COPEN.

AOPTIONS

A word to which 1s returned a bit string representing the
access options currentlY In effett. The format is the
same as that of the AOPTIONS parameter of COPEN.

DOPTIONS

A word to which 15 returned abit string representing the
driver options currently in effect. The format is the
same as that of the DOPTIONS parameter of COPEN. Note
that certain CCONTROL functions can change the value of
DOPTIONS.

NUMBUFFERS

A word to which is returned an integer indicating the
number of bUffers currently assigned to the line 1f
positive, or the depth of the request queue If negative.
This is the same format as that of the NUMBUFFERS
parameter of COPEN.

BUFFSIZE

A word to which is returned
size of each buffer assigned to
be positive or negative in
BUFFSIZE parameter specified 1n

IOLIST

A byte array to which is returned an 10 sequence list.
The format is the same as that of the IDLIST parameter Of
COPEN. If IDLISTLEN is zero or omitted, then the entire
list 1s returned to IOLIST; otherwise, up to IDLISTLEN
bytes are returned to IOLIST. If no list was specified
In COPEN or at configuration time, one byte will be
returned (corresponding to the number of '10 sequences)
and its value will be zero.

IDLISTLEN

An integer specifying the length (in bytes) ot the byte
array IOLIST. If IDLISTLEN is zero or omitted, then it
is assumed that IOLIST is sufficiently large to contain

o

o

SSLC
SW
- SSLC
=
- NSW

4-35

an integer indicating thf
the line. BUFFSIZE will
correspondence With the
COPEN.

0

the entire ID sequence list specified in COPEN or
configuration t1me. This parameter is ignored if lOLl.·
i$ omitted.
SlJPLIST

byte array to which is returned the list describing a
supervised line. The format is the same as that of
format '2 of the SUPLIST parameter ot COPEN (exception byte 2 is set to the total number of stations).
If
SUPLISTLEN is zero or omitted, then the entire list is
returned to SUPLIST;otherwise, up to SUPLISTLEN bytes
are return~d to SUPLIST.
If no list was specified by
CLINE, COPEN, or at configuration time, then two bytes of
zero are returned to SUPLIST.

SUPLISTLEN

An integer specifying .thelength (In bytes) of the byte
array SUPLIST. It SUPLISTLEN is zero or omitted, then it
is assumed that SUPLIST is SUfficientlY large to contain
the entire list describing the supervised line (as
specified by the SUPLIST parameter of COPEN Or by the
configurator dialog).
This parameter is ignored If
SUPLIST is omitted.

POLLIST

A word array to whiCh is returned the polling list for
the line. The format 15 the same as that of the POLLIST
parameter of the CPOLLIST intrinsic.

A

If POLLISTLEN is zero or omitted, then the entire list ~.
returned to POLLIST; otherwise, up to POLLISTLEN wor~
are returned to POLLIST.
POLLISTLEN

An integer apeclfying the len9th (In words) of the word
array POLLIST. If POLLISTLEN is zero or omitted, then it
Is assumed that POLLIST is sUftici~ntly large to contain
the entire polling list for the line. This parameter is
ignored if POLLIST is omitted.

DWNLDFILE

A byte array to Which is returned the formal file
designator ot the down load file. The maximum length of
the £1 Ie name Is 28 bytes long. When the designator is
returned, unused bytes will be filled with blanks.
If
there Is no down load file then the whole array will be
blank filled.

yyyyy

(Reserved for future use.)

PHONELIST

A byte array to which is returned the list Of Phone
numbers for a switched line. The format Is the same as
that of the
PHONELIST
parameter
of
COPEN.
If
PHONELISTLEN is zero or omitted, then the entire list is
returned to PHONELIST; otherwise, up to PHONELISTLEN
bytes
are returned to PHONELIST.
If no list w~\
specified by COPEN or via configurator dialog, th~n o~
4-36

o

c

byte of zero will be returned to PHONELIST.
PHONELISTLEN

An integer specifying the length (In bytes) of the byte
array PHONELIST. If PHONELISTLEN is zero or omitted,
then it Is assumed that PHONELIST is sufficientlY large
to contain the entire phone list specified by COPEN or at
configuration
time.
This
parameter is ignored if
PHONELIST is omitted.

INSPEED

A double word to which is returned an integer specifying
the current input speed of the line in Characters per
second.

OUTSPEED

A double word to which Is returned an integer specifying
the current output speed of the line In Characters per
second.

MISCARRAY

A word array to which
is
returned
miscellaneous
information defined at the time the line was opened. If
MISCARRAY was not explicitly specified at COPEN time, it
nevertheless exists in the form of default values. The
format is the same as that of the MISCARRAY parameter of
COPEN. If MISCARRAYLEN is zero or omitted, then all Such
information is returned to MISCARRAY; otherwise, up to
MISCARRAYLEN
words
are
returned.
The
returned
information
is
ordered
according
to
increasing
parameter-type values.

MISCARRAYLEN

integer specifying the length (In words) ot the array
If MISCARRAYLEN is zero or omitted then it Is
assumed that MISCARRAY is sufficiently large to contain
all pertinent information.

An

MISCARRAY~

DRIVERNAME

A byte array to which 15 returned the name of the driver
for the line. The array must be at least 8 bytes long,
and the name Is left-justified with blank fill in the
unused byte positions.

CTRACEINFO

A word
to
wnich
15 returned CS trace facility
information. The format Is the same as that ot the
CTRACEINFO parameter of cnPEN~, A zero will be returned
If the CS trace facility 15 not invoked for this line.

o
4-31

4.8

------_ ..----_

o

_. __ ._._..--_ .. --

OBTAINING MULTIPOINT GROUP INFORMATION

This intrinsic supplies detailed
attached to a mUlti-poInt line.

*...

information

about

a remote group

This intrinsic is valid only for a multipoint line.

The CGROUPINFO intrinsic declaration is:
CGROUPINFOCLINENUMBER, LGNUM, GROUPDESC, FIRSTA, NUMSTA, POLLIO,
POLLIDLEN, SELIO, SELIDLEN, GPOLLIO, GPOLLIDLEN,
GSELID, GSELIDLEN);
VALUE LINENUMBER, LGNUM;
INTEGER LINENUMBER, LGNUM, FIRSTA, NUMSTA, POLLIDLEN, SELIDLEN,
GPOLLIDLEN, GSELIDLEN;
LOGICAL GROUPDESC:
.
BYT.E ARRAY POLLIO, SELID, GPOLLID, GSELID;
OPTION VARIABLE, EXTERNAL:

The condition codes for the CGROUPINFO intrinsic are as follows:

ceE eec eeL -

Request granted.

o

(This condition code is not returned.)
Request denied because an error occurred.

All CGROUPINFO parameters are optional
parameters are defined as follows:

except

tor LINENUMBER. Tne

LINENUMBER

An integer specifying the line
This is a required parameter.

LGNUM

An integer specifying the logical group number of the
remote group. If this parameter is omitted, its value
will be set to one.

GROUPDESC

A word to which is returned in bits (8:8) the group's
group descriptor. The format Is the same as the group
descriptor byte In the COPEN SUPLIST array.

FIRSTA

A word to which Is returned the logical station number
of the first station attached to the group.
The
remaining
stations
attached
to this group have
successive lOQical statton numbers.

NUMSTA

A word

number

to which 15 returned the
stations attached to this group.
4-38

of

total

the

line.

number

of

o

(:~:)POLLID

A byte array to which Is returned the group·s polling
10.
The byte array must be 8 bytes long. When the
actual 10 is returned, unused bytes in the array are
null-filled to the right.

POLLIDLEN

A word to which Is returned the length of the group·s
polling 10.

SELID

A byte array to whIch 15 returned the group·s selection
ID 10. The byte array must be 8 bytes long. When the
actual 10 is returned, unused bytes in the array are
null-filled to the right.

SELIOLEN

A word to which 15 returned the length of the group·s
selection 10.

GPOLLID

'A byte array to which Is returned the group~s general
pollIO.
The byte array must be 8 bytes long. When
the actual 10 is returned, unused bytes In the array
are null-filled to the right.

GPOLLIDLEN

A word to which is returned the length of the group·s
general pollIO.
A byte array to Which
selection 10.
The
When the actual 10 15
array are null-filled

GSELIDLEN

c

is returned the group·s general
byte array must be 8 bytes long.
returned, unused bytes in the
to the right.

A word to which Is returned the length of the group·s
general selection 10.

4-39

4.9

o

----.-_.- ..........•......... -.----.....

OBTAINING MULTIPOINT

STA~lON

INFORMATION

This Intrinsic supplies detailed information about a remote station
(terminal) attached to a multi-point line.
••••

This lntrlnslcls valid only for a multipoint line.

The CSTATIONINFO Intrinsic declaration Is:
PROCEDURE CSTATIONINFO(LINENUMBER, STANUM, COMPNUM, GROUPNUM,
STATIONDESC~
NUMCOMP, BLKSIZE, POLLIO, POLLEN, SELID,
SELEN);
VALUE LINENUMBER, STANUM, COMPNUM;
INTEGER LINENUMBER, STANUM, COMPNUM, GROUPNUM, NUMCOMP, BLKSIZE,
POLLEN, SELEN;
LOGICAL STATIONDESC;
BYTE ARRAY POLLIO, SELID;
OPTION VARIABLE, EXTERNAL;
The condition codes for the CSTATIONINFO intrinsic are as follows:
CCE • Request granted.

o

CCG - (This condition code Is not returned.)
eCL • Request denied because an error occurred.
All CSTATIONINFO parameters are
parameters are defined as follows:

optional except for LINENUMBER. The

LINENUMBER

An integer specifying the line
This is a required parameter.

STANUM

An integer specifying the logical station number of the
remote terminal. If this parameter 15 omitted, then
its value is set to one.

COMPNUM

An integer specifying the logical component number Of a
component attached to the terminal. If this parameter
is omitted, its value will be set to zero.

GROUPNUM

A word to Which is returned the logical Qroup number of
the group to which the station 15 attach~d.

STATIONDEse

A word to whiCh 15 returned In bits (8:8)
the
terminal·s station descriptor. The format 15 the same
as the station descriptor byte 1n format .2 of the
COPEN SUPLIST array.
4-40

number

of

the

line.

o

( ' : NUMCOI4P

A word to which is returned the
attached to the station.

number

of

components

BLKSIZE

A word to which is returned the maximum bloCK size
which can be sent to the station.

POLLIO

A byte array to which Is returned the polling 10 of the
logical component specified by COMP. The byte array
must be 8 bytes long. When the actual 10 is returned,
unused bytes in the array are null-filled to the right.

POLLEN

A
word to which Is
component's polling 10.

SELID

A byte array to which is returned the selection 10 of
the logical component specified by COMP. The byte array
must be 8 bytes long. wnen the actual 10 is returned,
unused bytes in the array are null-filled to the right.

SELEN

A
word to which Is returned
component's selection 10.

c
4-41

returned

the

the

length

length

of

of

tne

the

4.10 OBTAINING LINE ERROR AND STATUS INFORMATION

---------------

-._----.-------.---

o

.When a CS intrinsic returns a condition code indicating an error, the
programmer can requeat additional information about the error by
issuing a CCHECK intrinsic call.
This intrinsic accepts zero as a
legal line parameter value.- When zero is specified, the returned error
code reflects the status of the last COPEN or unsuccessful IOWAIT.
The CCHECK intrinsic provides error information as well as last-event
status information for the line. Under non-error conditions, a CCHECK
intrinsic call Will prOVide the user with additional line information
complementary to that provided byCGETINFO. This information reflects
the state of various lists as well aa message and error counters for
the last (completed) I/O operation on tne line.
The CCHECK intrinsic declaration Is:
PROCEDURE CCHECK (LINENUMBER, ERRORCODE, IDLISTINDEX, POLLISTINDEX,
PHONELISTINOEX, MSGSENT, MSGRECV, RECOVERRORS,
IRRECOVERRORS);
VALUE LINENUMBER;
INTEGER LINENUMBER, ERRORCODE, IDLISTINDEX, POLLISTINDEX,
PHONELISTINDEX, RECOVERRORS, IRRECOVERRORS;
DOUBLE MSGSENT, MSGRECV;
OPTION VARIABLE, EXTERNAL;

o

The condition codes for the CCHECK intrinsic are as follows:

CCE - Request granted.
CCG • (This condition code is not returned.)

eCL • Request denied because an error occurred.
All CCHECK parameters are optional except for LINENUMBER. for those
parameters returning an index, the index should be used as a subscript
to the corresponding array returned by CGETINFO.
The parameters are
defin~d as follows:

LINENUMBER

An integer specifying the line number of the line.
This parameter is required. If LINENUMBER has a value
of zero, the returned error code reflects the status of
the last COPEN or unsuccessful IOWAIT, whiChever Is the
most recent.

o
4-42

(:'\ ERRORCOOE

A word to which is returned a 16-bit code, speclfylng
the type of error that occurred.
If the previous
operation was successful, all bits are set to z~ro.
In the 16 bits returned to the word specified by the
ERRORCODE parameter, the low-order eight bits contain
the error-type code that shows What kind Of error
occurred.
The high-order eight bits specify the last
recoverable line-error that occurred on the last 110
access. Error codes are listed later in this section.

IDLISTINDEX

A word to wh1ch Is returned an integer whose value
denotes the (byte) subscript position Of the most
recentlY used entry in the list of 10 sequences. A
value of zero indicates that there is no "current"
entry.

POLLISTINDEX

A word to which is returned an integer Whose value
denotes the (word) subscript position of the most
recentlY used entry in the polling list. A value of
zero indicates that there is no "current" entrY.

PHONELISTINDEX

A word to which is returned an integer Whose value
denotes the (byte) subscript position of the current
entry in the list of phone numbers. A value of zero
indicates that there 1sno "current" entry.

MSGSENT

A
double
word to which is returned an integer
indicating the number of messages that have been sent
successfully over the line since the line was last
connected. Note that SSLC transmissions whiCh end In
ETB, as well as ETX, are counted as messages.

MSGRECV

A
double
word to Which is returned an integer
indicating the number of messages that have been
received successfully over the line since the line was
last connected. Note that SSLC transmissions Which end
in ETB, as well as ETX, are counted as messages.

RECOVERRORS

A word to whiCh is returned an integer indicating the
number of recoverable errors that have occurred on the
line since the line was last connected.

IRRECOVERRORS

A word
to whiCh is returned an integer indicating the
number of irrecoverable errors that have occurred on
the line since the line was last connected.

c:"

()
4-43

o

4.11 CCHECK Irrecoverable Error Codes (ERRORCODE (8:8»)
---------------_.-._-------.--._-------.----~------

The CCHECK irrecoverable error codes codes have been divided
SUbsets.
Range

----0
• 40
41 - 50
1

51

101

- 100

-

150
151 - 200

201 - 250

into

six

Description

----------request completed successfully
an error was found by the COPEN intrinsic
the request was not initiated because of
an error found by the CS Intrinsics (including COPEN)
the request was not initiated because of
an error found by the CS Intrinsics
(except COPEN)
a hardware error occurred
an error or exceptional condition which resulted
in the line's being disconnected (driver dependent)
an error or exceptional condition occurred whicn
Which did not result in the line's being disconnected
(driver-dependent)

The following tables describe the defined error codes.
NOTE: The heading "BSC pep" includes both conversational
and non-conversational BSC.

4-44

o

o

COPEN INTRINSIC - IRRECOVERABLE ERRORS
NUM

-.o
1

2
3
4
5
6
7
8

9

to
1t

12
13
14
15
17

.
C

18
19

~· \ 20
)21
23
24

25
26

27
28
29
31
32
33

DESCRIPTION

esc Bse HPDLC
p.p MP I

-----------

---

Request completely successfully
none or too many groups
none or too many stations
none or too many components
invalid poll/selection sequence length
not enough stacK space for COPEN to process
invalid driver name
driver not found
driver not compatible with line·s attributes
driver not changeable
undefined device
device not available
not cs device
cs device in use
invalid id sequence length
invalid buffer size
invalid phone number length
illegal Character in phone number
not compatible with line type
invalid information type in MISCARRAY
invalid information value in MISCARRAY
invalid entry in the poll list
could not open trace file, issue FCHECK(O) to find
specific File System error code
invalid trace entry size
invalid user capability
invalid line designator
no designator or device specified
too many files/lines
inSUfficient memory space
driver failed to open line
local mode was control station, but SUPLIST parameter
was not specified

()
4-45

X

---

X

x

X
X

X

X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X

x

X
X

X
X
X

x

X
X
X
X

X
X
X
X

X
X
X

X
X

X
X
X
X

X

X

X

X
X
X
X

X
X

X

X
X

X

X

x

x

X

X

X
X
X

X

X
X
X

X
X
X
X

ALL INTRINSICS • IRRECOVERABLE ERRORS
NUM

--.

48

49

8SC BSC HPDLC
p.p MP I

..- -.-

DESCRIPTION

.-----._---

no virtual memory available for trace and/or
buffering
db not pointing at stacK
NON-COPEN INTRINSICS - IRRECOVERABLE ERRORS

--NUM

51
52
53
54
55

56

57
58
59
60
61
63
64
65
66
67
13
76

71
18
19

ttS
116

.-_._..----

---

x

X

X

x

X

X

asc

pep

DESCRIPTION

BSC

MP

o

HPOLe
I

--- -. - ---

invalid line number - no such line
invalid parameter value
I/O error on trace file
not used
buffer or count not specified
invalid buffer count parameter
no answer to dial attempt
no phonellst for dial attempt
bad dial msg. • system problem
invalid array length parameter
bad ccontrol code
no 110 in progress for abort
abort ignored
logical group number Is invalid
logical station number Is invalid
logical component number is invalid
parameter bounds violation
buffer parameter required but not specified
maximum number of I/O requests are already
outstanding; must first issue IOWAIT
no 1/0·5 pending for any filelline
no I/O pending tor specified file/line
secp RAM system failure
Mainframe driver time-out error

4-46

x

x

x

X

X
X

X

X

x
X
X
X
X
X
X
X
X

X
X
X
X
X
X
X
X

X
X

X

x
X
X
X
X
X
X
X
X

o

X

X
X
X

X
X
X
X

x

x

x

X

X
X
X

X
X
X

X
X

X
X
X

o

(
•

".

HARDWARE RELATED IRRECUVERABLE ERRORS

'",'

83

85

81
88
89
90
91
92
93
94

95
96
97
98
99
101
102
103

(:.

104
105

asc BSC HPDLC
MP

._- .....

p .. p

DESCRIPTION

NUM

.----------

secp
scCP
scep
SCCP
secp
seep
sccP

system failure
parity error
received bad self-test control character
DMA self .. test error
microprocessor (MC2) failure
ROM faiure
RAM failure
SCCP USART transmitter overrun
scep USART parity error
scep USART self-test receive error
scep USYNRT self-test transmitter underrun
SCCP USYNRT self-test receive error
SCCP USYNRT self-test receive overrun
SCCP USYNRT self-test receive aborted
scep USART self-test received no data
Non-responding device
Transfer error
Data set not ready
Carrier loss
Data overrun

I

---

x x

x

X
X
X

X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X

X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X

X

X
X
X
X
X
X
X
X
X
X

X
X
X
X
X
X
X
X

DRIVER DEPENDENT IRRECOVERABLE ERRORS RESULTING IN DISCONNECTION
asc BSC HPDLC
NUM
DESCRIPTION
pep
MP I

--151
153

154
155
156
157
158
159
160

c

---

------_ .. ---

Connect timeout
Remote rejected the connection
Power failure occurred
Local timeout
An internal error was detected by the driver
Remote protocol error
Remote sent shutdown sequence and disconnected
Remote sent Shutdown sequence and disconnected
before the 110 request was issued.
An internal error was detected by MPE

4-47

x

X
X
X
X
X

-.- ._.
X

X

X

X
X
X
X

X

X

X

X

X

x

X

X

OTHER DRIVER DEPENDENT IRRECOVERABLE ERROPS

._.

NUM

201
202
203
204
205

206
207
208
209
210
211

212

213

214
215
216

217
218

219

220
221
222
223

.-_

BSC BSC HPDLC

.

... -.- --pep

DESCRIPTION

Operation aborted
Invalid user request
Remote is not ready to accept line bid
Remote rejected the 11ne bid
Remote primary station bid tor the line while local
user was also bidding
Remote has requested' to send (an RVI sequence was
received)
Retry count exhausted
Unexpected text was received
Receive timeout
Remote sent end-at-transmission
Remote sent end-of-transmission sequence and
disconnected before the I/O request was issued.
During the execution of a CWRITE conversational with
output buffer specified to also be the input buffer;
the remote requested a resend ot the output buffer but
its contents had been modified While receiving from
the remote.
Remote sent an ACK sequence in response to local
CREAD acknowledgement.
Remote sent a NAK sequence in response to local CREAD
acknowledgement.
Remote sent an RVI sequence in response to local
CREAD acknowledgement.
Remote requested a download sequence be initiated
No line bid was received from the remote, local timed
out
Remote sent a delay sequence instead of the expected
text/response
The entries in the pollist were polled the required
number of times, and no station responded
An EDT was received from the remote before the last
block of a mUltiblock transmission was sent
After an RVI was sent to the remote, the remote
responded with text instead of the (expected) EDT
pallentrv down or Poliist down
Too much data was transmitted by the remote;
part of the data was lost.

4-48

MP

I

X

x

x

X

X

X

x

x

X
X
X

X
X
X
X
X
X

X
X

X

o

X
X
X

X
X
X

x
X
X

x
X

o

( ) 2 CCHECK

Recoverable Error Codes lERRORCODE (0: B)]

-~----~------------._------_.--.-~--------------

The following table describes the defined recoverable
error codes.
RECOVERABLE ERRORS

--o
1
2
3
4

5
6
7
8

9
10

11
12

C0, a CeL
returned if any 110 requests are outstanding.

will

be

The CCONTROL parameters are
LINENUMBER

An integer specifying the line number of the line.

CONTROLCODE

An integer
performed.

PARAMETER

A
word Whose interpretation
particular CONTFOLCODE.

defining

4-53

the

specific
is

operation
a

function

to

be

of

the

The f 0 110 wing is the definition of t hey ar lou s control
corresponding parameters:

codes

and

the O.
.

-.----

4.15 CONTROLCODE Functions

-----.----_....

o

cancels an outstanding request (or requests) on a line.
A request that has not been physically initIated Is cancelled. A
request that has been physically initiated Is allowed to complete
~lth one exception:

If a polling operation 1s In progress and no affirmative response
is received from the polled component, then the request 15
cancelled without completing the polling list.
PARAMETER specifies Which request or requests to

abort all outstanding 1/0
request (1 being the oldest)
request

abort.
0
-n
• abort the n·th Oldest read
+m· abort the m·th oldest write

NOTE: This CONTROLCODE request is meaningful only for lines opened

with the CIa specification.
t

Reset the line from text state to control state.

o

An end-of-transmission sequence (EDT) is sent to the remote.
NOTE:

a.
b.

2

If the current state is control then an EDT
will still be sent.
If the current state Is unconnected then this
CCONTROL is ignored.

Disconnect the line
A disconnect sequence is sent to the remote and the connection is
brOken.
The type of disconnect sequence (EDT or OLE EOT) Is a
function of DOPTIONS.(4:2l or a previous CCONTROL w1th controlcode
of 258.

NOTE:
If the line is alreadyd1sconencted, then th1s CCONTROL 1s
ignored.

4-54

o

c

32 changes the index into the phone list to the value PARAMETER,
which is an integer denoting a byte subscript position into the
phone list array.
A condition code of eeL will be returned If
does not point to a valid phone list entry.
33

PHONELIST(PARAMETER)

inserts an entry into the poll list for a multi-point line.
PARAMETER Is the entry to b~ inserted at the bottom of the poll
list. PARAMETER has the same format as a pollist entry in in the
CPOLLIST intrinsic.
A condition code at eeL will be returned if the entry does not
have the correct format.

****
34

This control code is only valid for multi-point lines.

deletes an entry tram the poll list fora multi-point line. It the
entry appears more than once in the POLL1ST, then all instances
are deleted.
PARAMETER Is the entry to be deleted, and has the same
a pollist entry in the CPOLLIST intrinsic.

c

A condition code of CCIJ will be
deleted does not exist in the list.
valid for mUlti-point lines.

format

as

returned if the entry to be
This control code is only

*.**

35

Change POLLIST index.
changes the index into the poll list to the value PARAMETER which
is an integer denoting a word subscript position into the poll
list array.

****
36

This control code is only valid tor multi-point lines.

Change dialing convention.
PARAMETER

=0

dial on write connects; answer on read connects
answer on write connect: dial on read connect
dial on write connect; dial on read connect
3 answer on write connect; answer on read connect

=1
=2

=

o

A condition code
greater than 3.

of

eeL

1s returned if PAPAMETER is negative or

4-55

37

o

change the value of the receive time out.
If PARAMETER Is a positive, nonzero number then it wIll be the new
value of the receive timeout (seconds). A value of Zero will
cause the timeout to be disabled. setting parameter to a minus
one wIll set the timeout to the default value of 20 seconds. Any
other values of parameter are invalid.

****
38

This control code 15 not valid for lines using HPDLC I.

change the value of the local timeout.
It PARAMETER is a positIve, nonzero number then it wIll be the new
value of the local timeout (seconds). A value of zero wIll cause
the timeout to be disabled. Setting parameter to a minus one will
set the timeout to the default value of 60 seconds. AnY other
values of parameter are invalid.

****
39

This control code is not valid for lines using HPDLCI.

change the value of the connect timeout.
It PARAMETER Is a positive, nonzero number then it wIll be the new
value of the connect timeout (seconds). A value of Zero will
cause the timeout to be disabled. setting parameter to a minus
one will set the timeout to the default value ot 900 secondS. Any
other values of parameter are invalid.

40

change the number of error recovery retry attempts to be
the drIver.
The COPEN defaUlt
drIver-dependent.

value

(see

made

0' -

by

MISCARRAY parameter of COPEN) is

PARAMETER 1s the new number of retry attempts.
PARAMETER must be a positive integer.
41

chanQe local station mode for a contention line.
PARAMETER

=

1 set local station to a primary contention

station
set local
station
set local
3
=
set
4
local
=
set
local
= 56 set local
=

-2

station to a secondary contention
station
station
station
station

to a control station
to a 3270 secondary statiOn
to orE
to DCE

A condition code of eeL will be returned If
PARAMETER Is negative or greater than
4-56

o

42

read line state
PARAMETER is a word to which is returned the current state of
the line.
PARAMETER (0.8)
(8:8)

****
43

= reserved

= 0 = unconnected
= 1 = control
= 2 = text

This control code 15 not valid for lines using HPDLC I.

Disable Tracing
Parameter 15 ignored.
The core-resident trace area in deleted and if this is the only
line accessing the trace file, the trace file is closed. It the
line is not tracing thru this CCONTROL is ignored.

44

C

Enable Tracing
parameter(O) = same meaning as the CTRACEINFO
parameter of COPEN
PARAMETER(!) = first word of the array describing
the trace file. The type of array
is defined by PARAMETER(1).(O:8):
alpha
the array contains a formal tile
designator
numeric = the array contains an ASCII number
specifying the trace file's logical
device number
special = the array contains a device class
name starting in PARAMET~R(1).(8:8)

--

If the line already has a tracing it is first disabled (see
CCONTROL with OPCODE = 43). A maIn memory trace area is created
for this line and, if the trace tile is not currently beinq
accessed, the trace file is opened.
45

Return current remote 10 sequence
Parameter
returned:
word 0

c

-

word

address

of

a

nJne

word

array

to which Is

- length of current remote 10  0 THEN
BEGIN
FCLOSE(FILENUM,l,O);
IF <> THEN PRINT'FILE'INFO(FILENUM);
END;
ASCIICRECORDCNT,10,RECTRANSFERRED(22);
PRINT(RECTRANSFERRED,-27,O);
TERMINATE;
END;

C

/8ROUTINE CSPROBLEM;
,""/ BEGIN
IF > THEN
PRINT(REMOTEABORTED,-14,O);
ELSE
PRINT'LINE'INFO(LINENUM);
ENDOFJOB;
END;

SUBROUTINE FSPROBLEM;
BEGIN
PRINT'FILE'INFO(FILENUM);
ENDOFJOB;
END;
PRINTCGETFILENAME,-11,O);
READC~T:=-REAO(DESIG,-30);

IF > THEN ENDOFJOB;
IF READCNT = 0 THEN
BEGIN
«SEND EXISTING FILE»
LINENUM:=COPEN(CDESIG1,CDESIG1(8»;
IF <> THEN CSPROBLEM;
READCNT:=CREAD(LINENUM,DESIG,-28);

C

IF

<>

TH€N CSPROBLEM;

5-3

«GET FILE NAME FROM RECEIVER»

FILENU~:=FOPEN(DESIG,FSFOPTIONS1,FSAOPTIONS1);

IF <> THEN FSPROBLEM,
FGETINFO(FILENUM""RECSIZE);
RECSIZE:=IF RECSIZE > 0 THEN -2*RECSIZE ELSE RECSIZE;
CWRITE(LINENUM,RECSIZE,l);
«SEND FILE·S RECORD SIZE»
IF <> THEN CSPR08LEMJ

o

DO

BEGIN
«TRANSFER CONTENTS OF THE FILE TO THE REMOTE»
FREAD(FILENUM,BUFFER,RECSIZE);
IF < THEN FSPROBLEM;
IF ::: THEN
BEGIN
RECORDCNT:=RECORDCNT+l;
CWRITE(LINENUM,BUFFER,RECSIZE);
IF <> THEN CSPROBLEM;
END;
END UNTIL >;
«SENSED END-Of-FILE»
CCONTROLCLINENUM,SENDEOT,ANYTHING);
IF < THEN CSPROBLEM;
END
ELSE
BEGIN
«RECEIVE NEW FILE»
LINENUM:=COPEN(CDESIG2,CDESIG2(8)""""",PHONELIST);
IF <> THEN CSPROBLEM;
«SEND FILE NAME AND GET RECORD SIZE OF THE FILE»
CWRITE(LINENUM,DESIG,R~AOCNT-l,RECSIZE,l);

IF <> THEN CSPROBLEM;
FILENUM:=FOPEN(DESIG,FSFOPTIONS2,FSAOPTIONS2,RECSIZE);
IF <> THEN FSPROBLEM:

o

00

BEGIN
«RECEIVE CONTENTS OF THE FILE»
READCNT:=CREAD(LINENUM,BUFFER,RECSIZE);
IF < THEN CSPROBLEM:
IF
THEN
BEGIN
RECORDCNT:=RECORDCNT+l:
FWRITE(FILENUM,BUFFER,-READCNT,O);
IF <> THEN FSPROBLEM:
END;
END UNTIL >;
«EDT RECEIVED»
END:
ENDOFJOB;

=

END.

5-4

o

5.2

MULTIPOINT TRANSACfION PROCESSING PROGRAM (CODED IN SPL/3000)

-------------------._.---------.- .. -.--- ... --------._.-------

This example shows a transaction processing program that accepts data
from HP 2645 terminals on one multipoint line.
Normally the line·s
terminal configuration would already have been specified via SYSDUMP or
INITIAL. However in this example both the CLINE SUPLIST and the COPEN
SUPLIST array have been specified to illustrate their use. In this
example the mUltipoint line type of 64 was arbitrarily chosen to
indicate a line composed entirely of HP 2645 terminals.

:CLINE CSLINE

&.

: SUPLIST=64,LSEL=O(125,125,125,125),

&

:
:
:
:
:
:
:

&
&.
&.
&
&.

GRP =ID=A"AA",A"aa",GEN=O(42,42),O(42,42l,
STA=O,512,A"AA",A"aa",
STA=0,512,A"BB","bb",
GRP =ID=A"BB","bb",
STA=O,512,A"AA",A"aa",
STA=0,512,A"BB",A"bb",
STA=O,512,A"CC",A"cc";

6.

C

"/i

/

EQUATE
HP2645
OUTLENGTH
INLENGTH

= 0,
= 100,

= 100;

BEGIN

BYTE ARRAl SUPLIST(O:b3l:=
64,
1,
0,2,

«HP 2645 STATIONS»
«LINE SELECT FACILITY»
«TWO GROUPS»
4, 125, 125, 125, 125,
«LINE SELECTION SEQUENCE»
7,2,
«LOGICAL GROUP 1, NUMBER OF STATIONS»
2,"AA",2,"aa",
«GROUP 1.0.»
2, 42, 42,2, 125, 125,
«SUFFIXES FOR GENERAL POLL/SELECT»
HP2645,512,1,2,"AAfl,2,"aa",«LOGICAL STATION I»
HP2645,512,1,2,"BB",2,"bb",«LOGICAL STATION 2»
7,3
«LOGICAL GROUP 2, NUMBER OF STATIONS»
2,"BB",2,"bb",
«GROUP 1.0.»
2, 42, 42,2, 125, 125,
«SUFFIXES FOR GENERAL PULL/SELECT»
HP2b45,512,1,2,"AA",2,"aa",«LOGICAL STATION 3»
HP2645,512,1,2,"BB",2,"bb",«LOGICAL STATION 4»
HP2645,512,1,2,"CC",2,"cc";«LOGICAL STATION 5»

5-5

o

JNBUF(O:99),OUTBUF(O:99)1
B YTEA.RRA J .
.....
LINEDESIG(O:6):="CSLINE "I
BYTE ARRAY...

.

PARTIALSUPLIST(O:3);
INTEGER
r~ I NE NUM, I NLE NGT H, 0 UTLEN GTH;
LOGICAL
STATION,FATALERROR;
DEFINE
NUMSTATIONS
= INTEGER(PARTIALSUPLIST(2).;
PROCEDURE INITIALIZEINUMSTATIONS);
VALUE NUM~TATIONS;
INTEGER NUMSTATIONS;
OPTION EXTERNAL;

LOGICAL PROCEDURE ANALYZECSERROR(LINENUM);
VALUE LINENUM;
INTEGER LINENUM;
OPTION EXTERNAL;
INTEGER PROCEDURE PROCESSTRANSACTION(INBUF,INLENGTH,
OUTBUF,STATION);
VALUE INLENGTH,STATION;
ARRAY INBUF,OUTBUF;
INTEGER INLENGTH;
LOGICAL STATION;
OPTION EXTERNAL;

o

INTRINSIC
COPEN,CREAD,CWRITE,QUIT,CGETINFO,PRINT·LINE·INFO;
LINENUM:=COPEN(LINEDESIG/""",SUPLIST);
If' <> THEN
BEGIN
PRfN~·LINE~INFO;

QUIT(O);
END:
CGETINFO(LINENUM"",J""PARTIALSUPLIST,4);
IN··ITIALI·ZEC·NUMSTATIONS) ;
DO

BEGIN «READ AND PROCESS ONE: 'lflANSACTION»
INIJENGTH:=CREAD(LINENUM,INBUF,INBUFLEN"STATION);
IF = THEN
BEGIN
OUTLEN:=PROCESSTANSACTION(INBUF,INLENGTH,DUTBUF,STATION);
IFOUTLEN <) 0 THEN
5-6

o

(

BEGIN
CWRITE(LINENUM,OUT8UF,OUTLEN",-l);
IF <> THEN FATALERROR:=ANALYZECSERRORCLINENUM);
END;
ENOl
ELSE
FATALERROR:=AHALYZECSERROR(LINENUMl;
END UNTIL FATALERRORI
END;
~-\

,

",.,

, ..••

-'

o

o

-----------------.-.-----------._---_._._
.. _-----------------_
.. _---.---1
1
1
THE CS/3000 TRACE

1

fACILIT~

1

section VI

1

--C"':..' ------.. -.. ----------_.. _.. --_.. --.-.... -.. _.. ---------------------.. ----_..
1

'

...

1

~;~-

1

Each C5/3000 intrinsic call, when performed by the driver, consists ofa
series of actions, operations, and events.
An action or operation is
something that the driver does and an event is something that the driver
must react to. If you write an application program that includes C5/3000
intrlnsics and the program doesn't wor~ as it 15 supposed to, it can be
extremely difficult to pinpoint the problem without a record of the
actions, operations, and events that occurred. The C5/3000 trace facility
provides such a record.
The trace facility is invoked only at the user's request. Tracing can be
invoked for any or all communications lines that your program uses. The
trace request is made either in the COPEN intrinsic call at the time a line
is opened, in a :CLINE command prior to running your apPlication program,
or -ith a CCONTROL.
Once it has been invoked for a particular communications line, the trace
facility continues to record line activity until the line 1s closed or a
CCONTROL with CONTROLCODE of 43 is executed.
The trace facility keeps
rack of, actions, operations, and events In the torm of trace entries. The
trace entries are grouped into trace records, each composed eXClusively of
CS/3000 intrinsic entries, protocol driver entries, or interconnect driver
entries. The trace records are storfd permanently in a file known as tne
trace file.
The contents of a C5/3000 trace file can be formatted and
printed through the use Of a trace dump utility program that 1s described
later in this section.

O

DEFINING THE TRACE FILE

).1

----------------------The Trace Facility uses the file "C5TRAldn" as the trace file if no
alternate file is specified by the user, where ldn is the logical device
number of the line to be traced.
PAPAMETER(l) of CCONTROL 44 is used to specify an alternate trace file
designator. This trace file designator will have the logical device number
ot the line appended to it to ensure a unique trace file for each line.
The Idn Is appended after the last character in the designator name If the
name is less than five characters in lenqth. If the designator name 1s

c

6-1

greater than or equal to five characters In length, the device number
replace characters 6 tnrough n of the designator name.
As an example, if the trace file designator "CSTRACE" is specified for
line with Idn of 148, th.n the ~eslgnator used wl11 be "CSTRA148".

6.2

will
~
~

INVOKING THE TRACE FACILITY

._----------.----_._--_.. -To invoke theCS/lOOO trace facility for
do one of the following:

d

particular communications line,

A.

set bit (2:1) of COPT IONS to "1" in the COPEN intrinsic call
opens the line.

B.

Include the TRACE= parameter in a :CLINE command tor the line
prior to running your application program.

C.

execute a CCONTROL with CCONTROLCODE of 44.

The trace facl11tywl11 then be invoked for the
opened for either steps A or B of the above).
N.ote:

In

line

(when

the

line

that

Is

I t a COPEN call in your appllcat ion program requests tracing a,nd you
wish to suppress tracing for that line at run time, inClUde!).,
NOTRACE parameter In a :CLI Nt: command for that line pr lor, .torunn...... .
your application program. Conversely, i f a COPEN. call .In yo
application program does not request tracing and you wiSh to request
tracing for that line at run time, include the TRACE= parameter in a
:CLINE command for that line prior to running your application
program.

addition

to inVOking the trace facility, you can specify other
information by using the CTRACEINFO parameter of the COPEN
and CCONTROL intrinslc call. The format of the CTRACEINFO parameter is as
follows:
trace-rel~ted

(0:1)

(1:1)

(2:6)

1

= trace
= trace

0

=

1

=

o

0
>0

I/O errors only
all actiVities

if the trace table is fUll, succeeding entries will be
flushed.
If the trace table Is fUll, succeeding entries will
overlay the prior entries.

= use driver
= trace mask

default trace maSK
indicating wh~ttypes of trace entries
are to be generated. The format of the trace mask for
the esc and MRJE protocols Is as follows:

o

(',
'

',',",'"

bit 2

= generate
= generate

STN entries
OPR and EDT entries *
= generate RCT entries
= generate RTX entries *
= generate SCT, POL, 5EL entries *
7 = generate STX entries
Note: CMP entries are automatically generated

/

3
4
5
6

*
(10:1)

0
1

(11:5)

0

>0

*

*

default

= do not generate SCCP interconnect
= generate SCCP intereonnect driver

driver entries.
entries.

driver default maximum number of trace entries per
- use
record
number of trace entries per trace record
-- maXimum
(ie: to specify
entries/record, use
I

8

8

1)

The CTRACEINFO parameters shown above can be specified Instead (or altered)
at run time by includinQ the TRACE= parameter in a : C~INE command for the
particular 11ne prior to running your application program.
The trace facility prOduces a series of trace records, each consisting of a
e r i e S 0 f t r ac e en t r i e s. I f you s pec i f Y th a t on lY I 10 err 0 r 5 are' to be
,'}raced, 'the trace facility will deposit In the trace file only those
records in which an I/O error occurred.

C

The types of trace entries mentioned under the CTRACEINFO parameter above
(STN, CMP, OPR, inte~connect,etc.) are described in detail later in this
section. At this point it is SUfficient to say that you can suppress the
variOUS types of trace entries, if yoU so desir~.
Trace entries are deposited In a trace record in a circular manner. For
example, if you specify that there be a maximum ot 35 trace entries per
trace record, trace entries beyond the 35th will overlay the first, second,
third, etc., trace entries In the record. If this happens, trace entries
that have been overlayed will be missing from the listing and a warning
message will appear at the start of the record in the listing telling you
that the particular number of entries are missing.
If the CTRACEINFO parameter Is omitted from the COPEN intrinsic call, and
It the corresponding parameters are not supplied.in a :CLINE command, the
drivers use the following default speclflc~tlons:
o
o

o

o

o

trace 110 errors only
flush overflow trace entries
generate all entry-types except STN
do not generate seep interconnect driver entries
6-3

o

6.3

o

maximum of 25 trace entrIes per trace record

THE TRACE FILE

-------------Each line opened by your process that requires tracing will have their
trace Information written to the trace file specified, or to "CSTRAldn" 1f
no name was specified.
If tracing has been requested and the trace file is not yet open, the
CS/3000 trace facility issues an FOP EN intrinsic call with the following

parameters:

------.-..
Parameter

formal file designator
FOPTIONS (14:2)

(13:1)
(10:3)
(8:2)

(7:1)
(6:1)
(5:1)
(0:5)
AOPTIONS (12:4)
(11:1)

(10:1)
(8:2)
(0:8)

blockfactor

Value

-----

CSTRACE

o

11 (old file)

o
o

(binary file)
(use actual file designator)
o (fixed length records)
o (no carriage control)

o
1 (disallow file equation)
o

4 (input/output access)
(no multi-recoTd option)
(disallow dynamic
locking/unlocking)
(exclusive access)

o
o
o
o
1

If the trace file cannot be opened because it does not exist,
file will be opened in the system domain.

then

a

new

If an error occurs when trying to open the trace file, the particular COPEN
intrinsic call will fall.

o

o

When the line is closed,

the CS/3000 trace
intrinsic call with the tOllowinq parameters:
Parameter

issues

an

FeLDS

Value

-----

---------

6.4

facility

filenum

trace file number

disposition

1 (save)

seccode

o (unrestricted access)

TRACE DUMP PROGRAM

-----------------There Is a CS/3000 trace dump utility program (CSDUMP) in the svste
library that will format and print the contents of trace flies generated b
the CS/3000 trace facility. The trace dump program requires a trace til
and a list file.

c~

6.5

List File

--------The formal file designator ot the list file is LIST. The list file may b
defined as a CRT terminal, a line printer, or an old disc file. To detin
the list file, enter an MPE :FILE command prior to inVOKing the trace dum
program. Some typical examples are as follows:

o

:FILE LIST;OEV=LP

(LP is assumed to be the deviCe class nam
for one or more line printers)

:FILE LIST;DEV=tilename

(filename Is assumed to be the name of an 01
jOb or system disc tile)

6-5

i

If a list file is not defined by a :FILE command, the trace dump progO
;.
uses SSTDLIST as the list file. If a :FILE command Is used to define
.
list file, the file Is opened as an old file. Should the file not exist,
then it is opened as a new flle in the system domain. After the dump
program has run, the file is closed as a permanent tile with unlimited
access. The contents of this file may be examined by the HP/lOOO editor,
EDIT/3000.

6.6

InvOking the Trace Dump Program

---------_._._----------------After the
command:

trace

and

list

files have been defined , enter the following

:RUN CSDUMP.PUB.SYS;PARM=x
The trace dump proQram uses the trace file as input and produces a
formatted trace listing on the list file. The format of the trace file
listing is specified by the PARM parameter of the RUN command;
PARM
0,1

2

3

Format
List all trace file entries by
time of occuranc~.
List all CS/3000 intrinsic entries
by time, with driver entries listed
by time under their associated
intrinsic entry.
List all CS/3000 intrinsic entries
by time.

()

The default for PARM 15 O. A sample trace listing Is shown in Figure 6-1.

6-6

o

Figure 6-1. Sample Trace Listing.
CS

T~ACE

ANALYZER (A.02.00)

MON, MAR

6, 1978, 12:45 AM

...X~ACE FILE IS CSTRACE.PUB.MP
( ~L ENTRIES DUMPED BY TIME
,

..... ';~

LAST OPENED ON MON, MAR

6, 1918, 12:01 AM

SYSTEM 10=32.11

***.*••••••••••••••••• *•••••*••
* BEGIN TRACING FOR DEVICE 32 •
** ••••••••••••• *••••••••••••• **
**.*.*.*.*••••• *••• *•••• *.*.*••• **.***.*.*.***.**.
*-L-I-N-E---!-N-F-O-R-M-A-T-I-O-N---D-I-S-P-L-A-Y*

•••••••••*.*••*••••••••••••••• *•• ** ••••• *•••••**••
•

*
*
*
*
*
*

*
*
*

' ' ,,'.',' i

(

v

*
*
*
*
*
*
*
*
*
•
*
*
*

LINE NUMBER: 4
DEV. TYPE: 19

LOGICALDEV. NUMBER: 32
•
SUBTYPE: 1 VER: A.02.00 •
01234561~901l345
•
COPTIONS: 0010000010000001
•
AOPTIONS: 0000000100001100
•
DOPTIONS: 0000000000000000
*
NUMBUFFERS: 1
BUFFSIZE: 512 (WORDS)
INSPEED: 300
OUTSPEED: 300
*
MISCARRAY:
RECEIVE TIMEOUT: 7200 SECS.
LOCAL TIMEOUT- 7200 SECS • •
CONNECT TIMEOUT 7200 SECS • •
RESPONSE TIMEOUT 3
SECS ••
LINE BID TIMEOUT 60
SECS ••
NO. ERROR,RETRIES 7
•
CLEAR-TO-SENDDELAY 00.0 SEeS. *
DATA-SET-READY DELAY DISABLED
TRANSMISSION MODE HAI,F DUPLEX ••
MMSTAT TRACE FACILITY DISABLED.
'.
DRIVERNAME: CSSBSCO
LINESTATE UNCONNECTED
CTRACEINFO:
ENTRIES=25
MASK=011111
TYPE OF TRACE = ALL, NOW RAP
•
PHONELIST:
ENTRIES=O
INDEX=O
•
IOLIST:
ENTRIES=O
INDEX=O
ERRORCODE: RECOVERABLE=O
IRRECOVERABLE=O
•
MSGSENT: 0
MSGRECV: 0
RECOVERRORS: 0
IRRECOVERRORS: 0

*
*

*

*

*

*

*
*

********************.*******.****.**************.*

o

6-7

Figure 6-1. Sample Trace Listing.

*****************.**••• ****••**•• *******.~.***••*******••**.*•• *•••, •••

*

* CREAD
* CALLER:
• STATE:
* INPUT:

REQUEST 10 :: 000505
SEGMENT=PRG 000
ADDRESS= 000122
•
LINE STATE=DISCONNECT
COPTIONS= 020201 OOPTIONS= 000000'
IN BUF= 000016 LENGTH::-28
STATION'::O
COMPONENT '=0
•
• OUTPUT: TRANSMISSION LOG=-4
STATIOK'=O
COMPONENT '=0
•

o·
.

•**.*** ••••••••••*.**•••••• *•• *.******••*****•••••••*.'*'*'***""*"**
o
1.722 POPR REQUEST 10:: 000505(!0145)
WAIT FOR CONNECTION THEN RECEIVE CONTROL SEQ
TIMEOUT= 1200.000
IN BUFR=O.021145 LENGTH=-16

1

6.611 PRCT REQUEST 10= 00Q505(!0145)
205.317 377.377

2

6.612 PEDT REQUEST ID= 000505(10145)
RECV ENQUIRY
XLOG=O

J

6.616 POPR REQUEST ID= 000505(10145)
SEND CONTROL SEQ THEN RECEIVE TEXT
SEND SEQ=ID ACK
TIMEOUT= 7200.000
OUT BFR= 0.000000 LENGTH=O
IN BUFR=1.000044 LENGTH=-28

4

6.611 PSCT REQUEST 10= 000505(10145)
020.260

o

o

5

6.725 PRTX REQUEST ID= 000505(10145)
020.002 120.060 016.040 020.203 026.240 377.000
P

0

8

377.377
6

6.727 RED! REQUEST ID= 000505(!0145)
RECV TEXT
XLOG=-6
200.000 1.20.060 070.040
P

7

0

8

6.730 PCMP REQUEST ID= 000505(10145)

ERROR CODE=O
LAST RECOVERABLE ERROR CODE: 0
.MSG SENT=O
.MSG RECV=l
STATE=TEXT
., RECOVERABLE ERR=O
• IRRECOVERABLEERR=O

*******.******.***.*******•• ******.~*.**** •• ***********.****••*.*.*****

* CCLOSE

* STATE:

LINE

REQUEST 1D= 000777
DOPTIONS= 000000

STATE=TEXTCOPTIONS~020201

*
*

****.*.*.*•••**••***••*•• **•••••• **••••••••• *.*.****.***•••••••••*•••••
6-8

o

figure 6·1.

o

Trace Dump Listing

8.912 POPR REQUEST 10= 000777(101FF)
UNCONDITIONAL CLEAR OF ANY CURRENT OPERATION
8.914 POPR REQUEST 10= 000777(101FF)

SEND CONTROL SEQ THEN DISCONNECT
SEND SEQ=EOT
TIMEOUT=
3.000
2

8.915 PSCT REQUEST ID= 000777(!0IFF)
026.004

3

8.975 PCMP REQUEST 10= 000777(!01FFl
ERROR CODE=O
LAST RECOVERABLE ERROR CODE= 0
.MSG SENT=O
.MSG RECV=l
STATE=D1SCONNECT
# RECOVERABLE ERR=O
# IRRECOVERABLE ERR=O

********************************
32 •
************.****.**************
.**.***.***.**.*••••• *••*.*****•• *••• **.** ••***.*.
*-L-I-N-E---I·N-F-O·R·M-A~T·I-O-N---D-I-S-P-L-A·Y*
*••*.******.**••*••••••• ***.**.**.**********••••,*
• END OF TRACE FOR DEVICE

*

*
*

LINE NUMBER: 4
LOGICAL DEV. NUMBER: 32
DEV. TYPE: 19
SUBTYPE: 3 VER: A.02.00
0123456789012345
•
~.
COPTIONS: 0010000010000010
•
AOPTIONS: 0000000100001100
•
/ * DOPTIONS: 0000000000000000
*
• NUMBUFFERS: 1
BUFFSIZE: 512 (WORDS)'
• INSPEED: 300
OUTSPEED: 300
•
* MISCARRAY:
RECEIVE TIMEOUT 1200 SEeS.
LOCAL TIMEOUT 7200 SEes.
CONNECT TIMEOUT 1200 SECS. *
*
RESPONSE TIMEOUT 3
SECS ••
",
LINE BID TIMEOUT 60
SECS.
NO. ERROR RETRIES. 7
*
CLEAR-TO-SEND DELAY: 00.0 SEes.'
DATA-SET-READY DELAY: DISABLED
TRANSMISSION MODE; HALF DUPLEX.'
• '
MMSTAT TRACE FACILITY: DISABLED.
•
• DRIVERNAME: CSSBSCO
LINESTATE: UNCONNECTED
• CTRACEINFO:
ENTRIES=25
MASK=011111
*
TYPE OF TRACE
ALL,NOWRAP
•
PHONELIST:
ENTRIES=O.
INDEX=O
*
IOLIST:
ENTRIES=O."
INDEX=O
ERRORCODE: RECOVERABLE=O
IRRECOVERABLE=O
*
MSGSENT: 0
MSGRECV: 1
RECOVERRORS: 0
IRRECOVERRORS: 0
•

(

*
*

I.

*
*

*
*

*

*
*
*
*

*
*
*
*
*

*

=

*
*

*
*

•********.****.****.******.***.***••******••***••*

c

figure 6·1.

Trace Dump Listing

END OF JOB.

o

o

o

6.7

('~\

Trace Llstlng Header Message

---..------------_._._------

CS TRACE ANALYZER (A. 02.00)

~ON,

MAR

6, 1918, 12:32 AM

TRACE FILE IS CSTRACE.PUB.MP
ALL ENTRIES DUMPED BY TIME
LAST OPENED ON MON, MAR

6, 1918, 12:01 AM

SYSTEM 10=02.66

At the start of the trace listing is a header message telling the date and
time-af-day when the listing was printed, the fully-qualified name of the
trace file being used, and the fOTmat of the trace listing. The mean:ngs
ot the two remaining items in the header message are as follows:

c

LAST OPENED ON etc.

This tells you the date and time-at-day
trace was performed.

SYSTEM ID=xx.yy

This tells you the version number (xx) and tix
level (yy) of the MPE/lOOO operating system that
was being used when the trace was performed.

6-11

when

the

6.8

"Begin Tracing" Message

-------------------_.-.
*******••******.****.**.***.**.
BEGIN TRACING FOR DEVICE 32 *
**************.********.*******
*.*******••••••*************.****************** •••
*-L-I-N-E---I-N-F-O-R-M-A-T-I-O-N---D-I-S-P-L-A-Y*
**•••• *•• **••****.*••**••••*••••••••••••••••••••*.

*

•
•
•
•

*

•
•

*
*
•
*
•

*
•

*
*
*
*
*
*
*
*
*

*
*
*

LINE NUMBER: 4
LOGICAL DEV. NUMBER: 32
*
DEV. TYPE: 19
SUBTYPE: 3 VER: A.02.00 *
0123456789012345
COPTIONS: 0010000010000001
•
AOPTIONS: 0000000100001100
•
DOPTIONS: 0000000000000000
•
NUMBUFFERS: 1
8UFfSrZE: 512 (WORDS)'
INSPEEO: 300
OUTSPEED: 300
•
MISCARRAY:
RECEIVE TIMEOUT: 7200 SEeS. *
LOCAL TIMEOUT: 7200 SECS. *
CONNECT TIMEOUT: 1200 SECS.
RESPONSE TIMEOUT: 3
SECS. *
LINE BID TIMEOUT: 60
SEes. *
NO. ERROR RETRIES: 7
*
CLEAR-TO-SEND DELAY: 00.0 SEes.
DATA-SET-READY DELAY: DISABLED
•
TRANSMISSION MODE: HALF DUPLEX.*
MMSTAT TRACE FACILITY: DISABLED.
•
DRIVERNAME: CSSBSCO
LINESTATE: UNCONNECTED *
CTRACEINFO:
ENTRIES=25
MASK=011111
TYPE OF TRACE = ALL, WRAP
PHONELIST:
ENTRIES=O
INDEX=O
*
IDLIST:
ENTRIES=O
INDEX=O
*
ERRORCODE: RECOVERABLE=O
IRRECOVERABLE=O
*
MSGSENT: 0
MSGRECV: 0
*
RECOVERRORS: 0
IRRECOVERRORS: 0
•

o

*

*

*
*
*

o

**********************.**********.****************

The message MBEGIN TRACING FOR DEVICE etc." appears at each pOint in thE
listing where a line to be traced Is opened. The message tells you thE
decimal logical device number of the line (32 in the above example). It
indicates that the particular line's activities are now being monitored b~
the trace facility. It Is followed by the PRINT'LINE'INFO -tombstone'
describing the line's state when tracing started.

o

6.9

"End of Trace" Message

-.--------.--.-.--- .. *********************************
END OF TRACE FOR DEVICE 32 *

****.*****•• *.***••******.******
**.*.**.**••*••••*••***••**** ••***•••*************
*-L-I-N-E---I-N-F-Q-R-M-A-T-I-O-N---D-I-S-P-L-A-Y*
***.***.*••**•••••••*.**•• *.**••••• **.***.*•• *.**.

*

* LINE NUMBER: 4

*

*

*
*

*

*

*
*

•

*

.*
/ *
')'1.\.'

(

*
*
*
*
*
*

*
*
*
*
*
*

*

LOGICAL DEV. NUMBER: 32
19
SUBTYPE: 3 VER: A.02.00 *
0123456789012345
*
COPTIONS: 0010000010000010
*
AOPTIONS: 0000000100001100
DOPTIONS: 0000000000000000
NUMBUFFERS: 1
BUFFSIZE: 512 (WORDS)'
INSPEED: 300
OUTSPEED: 300
MISCARRAY:
RECEIVE TIMEOUT: 7200 SECS.'
LOCAL TIMEOUT: 1200 SEeS.
CONNECT TIMEOUT: 7200 SECS.
RESPONSE TIMEOUT: 3
SECS • •
LINE BID TIMEOUT: 60
SEes.
NO. ERROR RETRIES: 7
•
CLEAR-TO-SEND DELAY: 00.0 SECS.'
DATA-SET-READY DELA~: DISABLED
DEV. TYPE:

*
*
*
*

*

*

TRAN 8M I S5 I () N MUD E: HALF 0 UPLE X •

MMSTAT TRACE FACILITY: DISABLED.
DRIVERNAME: CSSBSCO
LINESTATE: UNCONNECTED
CTRACEINFO:
ENTRIE5=25
MASK=000101
TtPE OF TRACE
ERROR, NOWRAP
PHONELIST:
ENTRIES=O
INDEX=O
IDLIST:
ENTRIES=O
INDEX=O
ERRORCOOE: RECOVERABLE=O
IRRECOV~RABLE=O
MSGSENT: 0
MSGRECV: 1
RECOVERRORS: 0
IRRECOVERRORS: 0

=

*
*

*
*

*
*
*
*
*
*

*

**************************.************** ••*******

The message "END OF· TRACE FOR DEVICE etc." appears at eaCh point in the
listing where a line that is being traced is closed. The message tells you
the decimal logical device number of the line (32 in the above example) and
indicates that the particular line's activities are no longer beinq
monitored by the trace facility. It 15 followed by the PRINT'LINE'INFO
"tombstone" showing the line's state just before tracing was stopped.

6-13

-------.._-

----._.. _----

6.10 CS/3000 Intrinsic Entry Header Message

.*********************************************************•••••***••***
• CREAO
REQUEST 10= 000505
•
• CALLER:
* STATE:
* INPUT:
* OUTPUT:

SEGMENT=PRG 000
ADDRESS: 000122
LINE STATE=DISCONNECT
COPTIONS= 020201 DOPTIONS= 000000
IN BUF= 000076 LENGTH=-28
STATION '=0
COMPONENT .=0
TRANSMISSION LOG=-4
STATION f=O
COMPONENT f=O

0

*
•
•

*

•••*•••*.***••****•••***•••••*•••••••*.****.*******••**••••••••••••****

The trace listing Is organized into a series of CS/3000 intrinsic entries,
and driver entries related to each intrinsic entry. The format of tne
listing is specified when the dump program is invoked(see section 6.6).
The trace record header message specifies a request id used to identifY
driver entries related to the intrinsic call, the type of intrinsic, the
location of the user·s program where the intrinsic was invoked, the line·s
state, and the user·s calling parameters.

6.11 "Missing Entries" Message

-----------

-

-

o

MISSING PROTOCOL ENTRIES
MISSING INTERCONNECT ENTRIES

If the messaQe "MISSING PROTOCOL ENTRIES" or "MISSING INTERCONNECT ENTRIES"
appears in the listing it means that the specified record was not large
enough to accomodate all of the trace entries and some entries were lost.
If the tracing was performed with NOWRAP then the mlssinq ent1res were at
the end just before the PCMP entry or the IDX entry. Otherwise tney are
missing at the beginn1ng. If the m1ss1nq entries are crUCial, do as
follows:
a.

Purge the, trace file.

b.

Change the "number of entries per record" specification by way of
the TRACE="numentries parameter 1n a :CLINE command for the
part1cular line.

c.

Re-run the application program.

6-14

o

6.12 Driver Trace Entry Format

----.--~--------------.-~~852 POPR REQUEST 10= OOOS05(!0145)
SEND CONTROL SEQ THEN RECEIVE CONTROL SEQ
SEND SEQ=WACK
TIMEOUT= 1200.000
IN BUFR= 0.021145 LENGTH=1
All ~rlver
fields:

entries in a trace listing contain a prefix consisting of four

1.

an entry number (8 in the above example)

2.

a "time stamp" in secondS and thousandths of secondS (8.852 in the
above example)

3.

an entry-type mnemonic (POPR In the above example)

4.

a request id

The first entry of each trace record is numbered "0" and successive entries
in the particular trace record are numbered consecutively In ascending
order.

o

The "time stamp" makes it possible for you to determine the elapsed time in
seconds and milliseconds between one trace entry and another. Note: time
stamp resolution for entries generated by an seep associated protocol
driver Is one hundredth of a second.

The entry-type mnemonic tells you what type Of trace entry you are
examining. There are ten types of protocol driver trace entries and
seventeen types of interconnect driver trace entries; they are summarized
in Tables 6-1 and 6-2.
The body of eaCh trace entry tells you the pertinent information tor the
particular activity that nas happened or is about to happen. This part of
the trace entry 1s desc~lbed In detail for each entry-type on the remaining
pages of this section.

c

6-15

Table 6-1.
MNEMONIC

Protocol Driver Trace Entry Type Mnemonic Definitions
ENTRY TYPE

DEFINITION

POPR

Operation

This type of trace entry 15 generated
eaCh time the physical driver is called
upon to perform an operation. The POPR
trace entry tells what operation Is to
be performed.

PSTN

State Transition
Entry

This type ot trace entry is
generated
each
time
the
driver'
transfers from one internal state to
another. The PSTN trace entry tells
what event just happened and What action
is about to be performed.

PEDt'

Editor Entry

This type of trace entry is generated
each time a text message or control
character sequence Is received from the
remote station.
In the case of a text
message, the PEDT trace entry shows the
first 13 (for H5I) or 14 (for SSLC)
words of the user's buffer;
control
characters,
pad characters, and CRe
parity sequences ar.e omitte. d.
In ~t
e
case of a control character seque, ,
the PEDT trace entry supplies a mnemo
phrase telling what was received.

PRCT

Receive Control
Sequence Entry

fhis type of trace entry is
generated each time a control Character
sequence is received' from tne remote
station. The PRCT trace entrY shows (in
octal) byte-tar-byte exactlY what was
received.

PSCT

send Control
sequence Entry

This type of trace entry is
generated each time the driver sends a
control character sequence to the remote
station. The PSCT trace entrY Shows (in
octal) byte-for-byte exactly what was
sent.

6-16

o

Table b-l.

Protocol Drlver Trace Entry Type Mnemonic Definitions
ENTRY TYPE

DEFINITION

PPOL

Send Polling
Sequence Entry

This type of trace entrY is
generated each time the driver sends a
polling sequence.
The PPQL sequence
shows
byte-for-byte
the
polling
sequence.
All BSC control characters
(such as SYNs, EDT, and ENQ) are not
shown.

PSEL

Send Selection
sequence Entry

This type of trace entrY is
generated each time the driver sends a
selection sequence.
The PSEL sequence
shows
byte-for-byte
the
selection
sequence.
All BSC control characters
(such as SYNs, EDT, and ENQ) are not
shown.

PRTX

Receive Text Entry

This type of trace entry is generated
each time a text message is received
from the remote station. The PRTX trace
entry shows (in octal) byte-for-byte
exactly what was received.

Send Text Entry

This type of trace entry is generated
each time the driver sends a
text
message to the remote station. The PSTX
entry shows (In octal) byte-for-byte
exactly what was sent.

PCMP

c

user Request
Completed

This type of trace entry is generated
each time a user request (i.e., a CREAD,
CwRITE, driver-performed CCONTROL, or
CCLOSE intrinsic call) 1S completed.
The PCMP trace entry summarizes the
number
of
text
messages sent and
received, the number of errorS that have
occurred, etc.

6-17

Table 6-2
MNEMONIC

Interconnect Driver Trace Entry Mnemonic Definitions

o

DEFINITION

ENTRY TYPE

is generated
called
to

whenever the
perform
an

IDe

Driver Called

This entry
driver
is
operation.

lOX

Driver Exited

This entry is generated whenever the
driver completes an execution of the
main control routine.

IADQ

Add to Queue

This entry Is generated
driver adds a request to
internal queues.

IRFQ

Remove from Queue

This entry Is generated whenever the
driver removes a request from one of its
internal queues.

IOF

Data Frozen

Tnis entry is generated whenever the
driver requests a tarQet data segment to
be frozen in memory or to check if a
previous request to freeze
a
data
segment has been completed.

IUNF

Unfreeze Data

Tnis entry Is generated whenever
driver wishes to unfreeze a previou .
frozen data segment or to insure that a
data segment associated with a request
15 not frozen by the driver.
~

INR

New Request

This entry is generated each time the
driver begins processing a new request.

IPR

Process Request

This entry is generated Whenever the
driver processes a request which may be
completed Immedlately(le: requires no
110 to SeCP) or whenever a request
requires some preprocessing before 110
15 to be done.

JAR

Abort Request

This
entry is generated whenever
request Is to be hard aborted.

whenever the
one of its

0

6-18

a

o

Table 6-2

Interconnect Driver Trace Entry

~nemonie

Definitions

start Timeout

This entry is
driver starts
request.

ISS

set status

Inis entry is generated Whenever
request completion status is set.

ICR

Complete Request

This
entry is generated whenever a
request has been fully completed by the
driver and is released to the request
initiator.

ICC

Chec~

Completion

Tnis entry is generated Whenever the
driver calls the physical driver to
cheCK 110 completion status and to cheCK
for soft~are timeout completions.

IPM

Process MesSage

This entry is generated whenever the
driver receives a message from secp.

IPFf?

power Fail Recovery

This entrY.is generated eaCh time the
power fail recovery routi~e 15 called.

leo

Call Driver

This entry 15 generated each time the
physical driver 15 called to pertorm an
operation.

1010

Do 110

This entry is generated each time the
driver wishes to do an operation which
sends a message to secp or moves data
tolfrom secp or moves data
between
requests.

IRB

Illogical Condition

This entry is generated whenever the
driver detects an illogical 1nternal
condition or receives an erroneous or
illogical message from scep.

'
\
C
)"

o

6-19

generated whenever the
a sottware timeout on a
the

6.13 paPR (Operand) Trace Entries

-----------_._. __ ._._-----3

o

6.616 POPR REQUEST ID= 000505(10145)
SEND CONTROL SEQ THEN R~CEIVE TEXT
SEND SEQ=ID ACK
TIMEOUT=
30.000
OUT BFR= 0.000000 LENGTH=O
IN BUFF= 1.000044 LENGTH=-28

A POPR trace entry 15 qenerated each time the physical driver Is called
upon to perform an operation.
The meanings of the various items are as follows:
tells

This item
performed.

SEND SEQ=

This
item
tells
you what control character
sequence, if any, is about to be sent to the remote
station (10 ACK 1n the above example).

TIMEOUT= etc.

Th1s item tells you the starting value of the
applicable timeout timer. In the above example the
driver sends an 10 ACK to the remote station and
then walts for a character response.
"TIMEOUT=
30.000" specifies that the response timeout timer
will be activated and set to 30 secondS.

OUT BFR=x.xxxxxx

This item specifies bank and
user/CS output buffer.

IN BFR=x.xxxxxx

This item specifies the bank and bank offset of the
user/CS input bufter.

LENGTH=Y

These two items specify the size (+=words;-=bytes)
of the CS output and input Duffers, respectively.

6-20

you

what

operation

being

SEND CONTROL SEQ etc.

bank

15

Offset

of

o

o

... --_.- .....•.............. -.. Entries
_---.--

).14 PSTN (state Transition) Trace

3.167 PSTN REQUEST 10= 00050S{!0145)
EVENT IS RECEIVED WACK SEQUENCE
ACTION IS SEND ENQ, GET TEXT/RESPONSE ( 033)
RETRY COUNTER=O
STATE= 0640
PENDING EVENT= 000000 EVENT MASK= 024000

An PSrN trace entry 15 generated each time the driver transfers from one
internal state to another.
The meanings of the various items are as follows:
EVENT IS etc.

Thls line tells you what event just occurred. LOOK
up the event phrase (RECEIVED WACK SEQUENCE in the
above example) In Table 6-2 for
a
detailed
description.

ACTION IS

This line tells you what action the driver 15 about
to perform. The action number (033 in the above
example) 15 of no concern to you and Should be
ignored. Look up the action phrase (SEND ENO, GET
TEXT/RESPONSE In the above example) In Table 6-3
for a detailed description.

etc~

c:J ETRY :
STATE=
PENDING EVENT:

This item tells you the current value Of the retry
counter.
For certaIn error conditions, the driver
increments the retry counter and then re-executes
the operation in which the error occurred.
This item tells
entered next.

you

wnat

driver state Is to be

This item tells you the current

contents

of

bits

0-7 of the word EXTERNAL·EVENT in the driver.
EVENT MASK:

This

item

tells

you the current contents of bits

8·15 of the word EXTERNAL·EVENT in the driver.

c

6.15 PEDT (Editor) Trace Entries

--_

b

-.-._--._-------

o

6.721 PEDT REQUEST 10= 000505(10145)
RECV TEXT
XLOG=-6
200.000 120.060 070.040
P

0

8

PEDT trace entries are genera~ed in conjunction with received text messages
and received control cnaracter sequences.
In the case of a received text message, the body of an EDT trace entry
shows in octal the first 13 (for HSI) or14 (for SSLC) words Of the text
message.
Regardleas of how long the text message Is, only one PEDT trace
entry will be generated per received text message. The text message Is
shown as it appears In the user·s buffer: control characters, pad
characters, and CRC parity sequences are omitted. XLOG spectfies the total
number of words or bytes (+=words;-=bytes) deposited tnto the user·s
buffer. If the MFW (1 word or 2 bytes) is used then it 15 also
included
In XLOG.
In the case of a received control character sequence, the PEDT trace entry
includes a mnemonic phrase telling What control Character sequence was
received.
If the control character sequence was accompanied by an 10
sequence, the IC sequence is shown in octal below the mnemonic phrase.
XLOG will normally be zero, exc~pt in the case when an ID sequence was also
received. In the latter case, XLOG specifies the length of the 10 sequence
(+=words;-:byteS).

c=>

Wherever possible, the trace dump program converts the received octal codes
to a Character and displays the character beneath its code.
The
translation from code to Character is performed properly for EBCDIC
transmissions as well as ASCII transmissions.
In the example above (RECV TEXT), the body
interpreted as follows:

of

the

PEDT

A text message was received from the remote station.
of data characters received was 4 (XLOG=-4). The 4
received are
120
010

=p
=8

060

trace

entry

is

The total number
data characters

=0

040 = space

6-22

o

----- .. ---.._._--.-_ .. _-.-._ .. _--------------

6.16 PReT (Receive Control Sequence) Trace Entries

( .>'6
~'

'\

'.'..

1.026 PReT REQUEST 10= 000505(10145)

020.260 377.317
o

An PRCT trace entry IS generated each time a control character sequence Is
received from the remote station. The body ot an PRCT trace entry Shows
you byte-for-byte exactly what was received (i.e., the actual contents ot
the driver's internal buffer).
control character sequences are terminated by a trailing pad character (377
octal). When interpreting tne body of an PReT trace entry, lqnore anything
following the 377 code.

In the above example, an ACKO control Character sequence was received. The
octal codes are interpreted as follows:
020

= OLE

2bO

= 0 (060 with parity bit
= trailing pad Character

377
~herever

possible,

the

trace

ACKO sequence
set)

dump program converts the octal codes to a

",character and dlspl;lYS the character beneath. its code.
The translation
( )ffom code to character 15 performed properly for EBCDIC transmissions as

well as ASCII transmissions.
Note:

c

The trace facility will not generate PReT trace entries it the HSI
driver is being used. In such a C4se, to trace received control
character sequences PEDT trace entries must be generated.

6-23

6.11 PSCT (send Control Sequence) Trace Entries

--------------------_._----------_.-.----5

o

0.956 PSCT REQUEST 10= 000771(!0IFF)
205.371

An PSCT trace entry 15 generated each time the driver sends a contro
character sequence to the remote station. The body of an PSCT trace entr
shows you byte-for-byte exactly what was sent to the remote station (i.e.
the actual contents of the driver·s internal buffer).
In the above example, an ENQ control character was sent.
are interpreted as follows:
205

377

= ENQ
= PAD

The

octal

code

(005 with parity bit set)

(This is the trailing pad character)

Wherever possible, the trace dump program converts the octal codes to
character and displays the character beneath its code. The translatio1
from code to character is performed properly for EBCDIC transmissions a.
well as ASCII transmissions.

o

6-24

o

6.18 PPOL (Send

Sequence) Trace Entries
.. _------_. __ ....•.....
_-----------_ .. _.. Pollln~

].807 PPOL REQUEST 10= 000777(!OlFF)
301.301 302.302

A

A

B

B

A PPOL trace entry is generated each time the driver sends a polling
sequence to the remote group/station. The body of a PPOL trace entry shows
you byte-for-byte the polling sequence sent on the lIne. It does not show
tne asc control characters that accompany the polling sequence such as SYN,
EDT, and F.NQ.

In the

abov~

example, the pOlling sequence was the ascii string, AABB.

Wherever possible, the trace dump program converts the octal codes to a
character and displays the Character beneath its code. The translation
from code to character is performed properly for EBCDIC transmissions as
well as ASCII transmissions.

c

6-25

------_

-.-.•..•.•.. -..-

3

4.096 PSEL REQUEST ID= 000777(!OlFfl

---

6.19 PSEL (send Selection Sequence) Trace Entries

---_

103.• 103 304.304

C

C

D

0

A PSEL trace entrY is generated each time the driver sends a selection
sequence to the remote orouplstation. The bOdy ot a PSEL trace entry shows
you byte-for-bytethe selectlonsequence sent on the line. It does not show
the BSC control characters that accompany the selection sequence such as
SiN, EOT, and ENQ.
In the above example, the selection sequence was the ascii string, CCDD.
Wherever possible, the trace dump proqram converts the octal codes to a
Character and displays the Character beneath its code. The translation
from code to Character Is performed properly tor EBCDIC transmissions as
well as ASCII transmissions.

o

-

6.20 PRTX (Receive Text) Trace Entries

---------_

-_ .. -_._--

6.125 PRTX REQUEST 10= 000111(!01FF)
020.002 120.060 070.040 020.203 026.240 377
P
0
8

PRTX trace entries are generated each time a text message is received from
the remote station.
The body of an PRTX trace entry
shows
you
byte-for-byte exactly What was received (i.e., the actual contents of the
driver's internal buffer).
Text message. afe terminated by a tWO-byte CRe (cyclic redundancy cheek)
parity sequence follo~ed by a trailing pad character (317 octal). When
interpreting the body of an PRTX trace entry, ignore anything following the
377 code.
In the above example, the octal codes are interpreted as follo-s:
020

= OLE

002

120

-P

- STX

060

=

010

=8

040

= space

020

- OLE

203

= ETX

026

=

240

-

317

0

(003 with parity bit set)

eRC parity sequence

= trailing

pad Character

Each PRTX trace entry can show a maximum of 32 bytes. If
exceeds this length, as many successive PRTX trace
generated as are necessary.

a text
entries

message
will be

wherever possible, tne trace dump program converts the, octal codes to a
character and displays the character beneath its code. The translation
from code to Character 1s performed properlY for EBCDIC transmissions as
well as ASCII transmissions.
Note:

o

The trace facility will not generate PRTX entries if the H51 driver
1s being u$ed. In SUch a case, to trace received text messages PEDT
trace entries must be generated.

6-27

.21 PSTX (Send Text) Trace Entries

-_..------..-......'---_..--------13

1.037 PSTX REQUEST 10= OOQS05(!0145)
020.002 120.060 070.040 020.203
P

0

026~240

o

377

8

PST X trace entries are generated each time the driver sends a text message
to the remote station.
The body of an PSTX trace entrY shows you
byte-for-byte exactly what was sent to the r~mote station (i.e., the actual
contents of the driver's internal buffer).
In the above example, the octal codes are interpreted as fo!!ows:
020

= OLE

122 =R

002

- STX

040

= space

120

=P

060

-

070

=8

040

= space

0

020

- OLE

203

= ETX

(003 with parity bit set)

026

=

240

- eRe

parity sequence

Each PSTX trace entry can show a maximum of 32 bytes. If a text message
exceeds this length, as many successive PST X trace entries are generated as
are necessary.
The above example is such a case and was continued into
another PSTX trace entry.
Wherever possible, the trace dump program converts the octa! codes to a
character and displays the cnaracter beneath its code. The translation
from code to character is performed properly for EBCDIC transmissions as
well as ASCII transmissions.
Note:

The Trace Facility will only trace the first 32 bytes of
if the HSI driver is being used.

6-26

sent

text

o

6.22 PCMP (110 completion)

Tra~e

Entries

------------. __ ._-._._-.-._---.-

J.Jl2 PCMP REQUEST ID= 000505(!0145)
ERROR CODE=210
LAST RECOVERABLE ERROR CODE= 0
#MSG SENT:O
.MSG RECV=O
STATE~CONTROL
# RECOVgRABLE ERR=O
• IRRECOVERABLE ERR=O
A PCMP trace entry is generated each time a user request (i.e., a CREAD,
CWRITE, driver-performed CCONTROL, or CCLOSE intrinsic call) is completed.
The meanings of the various items are as tallows:

C'

Error code=X

xxx 15 the error code of the request·s most
recent recoverable error. See Section 4.12
of this manual.

Last Recoverable ErrarCode:X

If a recoverable
error code.
See
manual.

#MSG Sfo;NT::X

x
specifies
the total number of text
messages that have so far been sent for tnis
connection.

#MSG RECV=X

x
specifies
the total number of text
messages that have been received so far for
tnls connection.

'RECOVERABLE ERR::X

x specifies tne total number of recoverable
errors that have occurred so far tor this
connection •

• IRRECOVERABLE ERR=X

x
specifies
the
total
irrecoverable errors that have
far tor this connection.

STATE=

This item specifies what l1ne state the line
is in after the completion Of the user
request
(CONTROL
state
in
the above
example).

error occurred, x Is its
section 4.13 of
this

number
occurred

of
so

,..

o

6-27

,XX

IADQ (Add Request to Queue) Trace Entries

-._.-..-

-------------3

-.----._--

7.075 IADO REQUEST ID= 000505(10145)
FUNCTION=READ

QUEUE=ACTIVE
ERRORCODE=O

QUEUE LEN=5

o

An IADO trace entry 1s generated whenever the driver adds a request to one
of its internal queues.
The meanings of the various items are as follows:

etc.

REQUEST 10::

QUEUE:
QUf~UE

etc.

ERRORCODE=X

This item tells you
~equest 15 added.

the

This item specifies the
queued to the above queue.

LF.N=y

FUNCTION=

This ~tem tells you the Id of the. request
responsible for this driver action. Id values
are given In octal and hex.

etc.

queue
number

to

which
of

This item tells you the seep function
1n the request.

the

requests
specified

Tnis item specifies an irrecoverable error code
as defined 1n Chapter 4.

c

6-28

o

x.xx JRfU (Remove ReQ4est From Queue) Trace

Entr1~s

-----------------------.--_._.-_._------------

f::

7~075

4

IRFQ REQuEST 10= 000505(10145)
FUNC'fION=READ

QUt;UE=ACTIVE
ERRORCODE=O

QUEUE LEN=5

An IRFO trace entry is generated whenever the driver removes a request from
one of its internal queues.
The meaninqs of the various items are as follows:
REQUEST 10=

QUEUE=

etc.

etc.

ERRORCODE=X

This item tells you
request is removed.

etc.

queue
number

to

Which
of

This item tells you the SCCPfunctlon
1n the request.

the

requests
specified

This item specifies an irrecoverable error code
as defined in Chapter 4.

c\

c

the

Tnis item specifies the
queued to the above queue.

QUEUE LEN=y
FUNCTION:

This item tells you the Id of the request
responsible for this driver action. Id values
are given 1n octal and hex.

6-29

,xx INR (New Request) Trace Entries

._--------------.-_
7

1.OJ4 INR

_--.-

REQUEST 10= 000777(!OlFF)

QMISC= 000001

PCB.= 013

FUNCTION=INFO TRANSFER
An INR trace
new request.

o

entry is generated each time the driver beQins processing a

The meaning of the various items are as follows:
etc.

REQUEST 10=

This item tells you the id of the request
responsible for this driver action. Id values
are given in octal and hex.

QMISC= xxxxxx

This item tells you the miscellaneous
associated with the r~quest.

PCB'= xxx

This item specifies the
originator of the request.

FUNCTION=

etc.

PCB

number

This item tells you the seep function
1n the request.

parameter
ot

the

specified

o

6-30

o

x.xx IPR (Process Request> Trace Entries

------.----- .. ----.-._-- ... _._.-_.3.034 IPR

REQUEST 10= 000777(!OlFF)

QMISC= 000000

PCB#= 013

FUNCTION=INFO fRANSFER

An IPR trace entry 1s generated whenever the driver processes a request
which may be completed immediately(ie requires no 110 to SCep) or whenever
a request requires some preprocessing before 1/0 is to be done.
The meaning of the various items are as follows:
REQUEST 10=

QMISC=

etc.

xxxxxx

etc.

the request
Id values

This item tells you the miscellaneous parameter
associated with the req~est.
This item specifies the
originator of the request.

PCB'= xxx
FUNCTION:

This 1tem tellS you the id of
responsible for this driver action.
are given In octal and hex.

PCB

number

ot

the

This item tells you the SCCP function specified
in the request.

6-31

.xx JAR (Abort Request) Trace Entries

.... __ .-----....-- .. -.----.-----9

8.113 IAR

REQUEST 10= 000505(10145)
FUNCTION=READ

o

ERRORCOOE=102

AnIAR trace entry is generated whenever a request 1s to be hard aborted.
The meanings of the various items are as follows:
REQUEST 10=

FUNCTION:

ERRORCODE=X

etc.

etc.

This item tells you the id of
responsible for this driver act1on.
are given 1s octal and hex.

the request
Id values

This item tells you the scep function specified
1n the request.
This item specifies the irrecoverable error code
as defined in Chapter 4.

o

X.XX

15TO (start Timeout) Trace Entries

---------.--_._--------_ ... _------

(';, 10

FUNC1' ION=WRI TE

8.113 ISTO REQUEST 10= 000111(!OlFF)

An 15TO trace entry 1s generated whenever
timeout on a request.

the

driver

starts

a

software

The meanings Of the various ttems are as follows:
REQUEST

10=

etc.

tellS you the Id of
for this driver action.
are given in octal and hex.
This

ttem

responslbl~

FUNCTION=

C·.']
/

etc.

the request
Id values

This item tells you the seep function specified
in the request.

-------------. __ .--_._ .. ------_._--._.-

,xx IRB (Illogical Condition) Trace Entries
18

6.543 IRB

REQUEST ID=NONE

LOGICAL DRVR ERRORCODE=O

PHYSICAL DRIVER ERRORCODE=3

0

An IRB trace entry Is generated whenever the driver detects an illogical
internal condition Or receives an erroneous or illogical message from seep.
Tne meanings of the various items are as follows:
LOGICAL DRVR

ERRO~CODE=X

PHYSICAL DRVR ERRORCODE=X

ThiS item tells you the code of the catastrophic
er ror det(!cted by the log ical dr 1 ver •
This item tells you the code ot the catastroPhic
error detected by the physical driver.

o

6-34

o

Trace Entry EVfNT Definitions
DEFINITION

EVENT

CORT CURRENT USER REQUEST

The current intrinsic call must be aborted.
ALL STATIONS DOWN No stations or groups can
be polled or selected because errors have
occurred on every station or group listed in
the polling sequence or for the selected
station.

BROADCAST TO ALL STATIONS

Broadcast text to either all stations on the
line or all stations In a particular group
(see STATION parameter
in
the
CWRITE
heading).

CARRIER LOSS

The communications link
station has been broken.

CCLOSE

A CCLOSE
intrinsic
call
has
been
encountered. The driver i& to be closed.

CCONTROL

A CeONTROL intrinsic has been encountered.
The driver Is to perform the specified
control function.

CONNECT TIMEOUT EXPIRED

The line was not physically connected within
the maximum time allowed.

eTA OVERRUN OCCURRED

DATASET

the

remote

Before a received data word
could
be
transfered from the TeU to main memory, it
was overrwritten by the next received data
word.
The "Data Set Feady" (Ce) signal from the
MODEM changed from "set" to "clear".

NOT ROY

HARDWARE fAILURE

with

OCCUR~ED

A hardware error was detected. The failure
occurred 1n the local station, not the
remote.

INITIALIZE

A COPEN intrinsic call has been encountered.
The driver is to be initialized.

INTERNAL TIMEOUT EXPIRED

The driver must transmit a WACK or TTO.

LAST ACTION WAS

The action speclfied in the previous STN
trace entry was performed successfully.

c

SUCC~SSFUL

6-35

Table 6-2.

Trace Entry EVENT Definitions (Cont.)

LAST ACTION WAS UNSUCCESSFUL·
LOCAL TIMEOUT EXPIRED

A CREAD or CWRITE intrinsic call waS not
issued
within the maximum time allowed
following a previous
CREAD
or
CWRITE
intrinsic call.

NO 10 VgRIFICATION

No ID verification is to be performed.

NON RESP DEVICE

Non-responding
SSLC).

POWER FAIIJ OCCURRED

A power failure was detected.

PUT REMOTE IN CONTROL STATE

Return station to control state so that
another station can be polled or selected.

READ INTERRUPT

ACREAD is to be performed. An RVI 1s to be
sent to the remote rather than an ACK.

READ (INPUT BUFFER)

A

PEAD (NO BUFFER)

A CREAD with
performed.

READ REPEAT

A CREAD Is to be performed. A NAK Is to be
sent to the remote instead ot an ACK.

RECEIVE 10 THEN SEND ID

10 verification is to be performed on this
line. The local station Is to first receive
and verify the remote's 10. It then sends
its 10 to the remote.

RECEIVE TIMEOUT EXPIRED

Nothing (inCluding TTD) was received from
the remote station within the maximum time
allowed during a read operation. Note that
a TTD always resets the timer.

RECEIVED ACKO SEQUENCE

An ACKO control character sequence (positive
acknowledgement)
was
received from the
remote station.

local

TeU

(I.e.,

H51

or

CREAO is to be performed.
no

input

buffer

1s

to

o

'fable b-2.

Trace Entry EVENT Definitions (Cont.)
DEFINITION

EVENT

~CEIVED

ACKl SEQUENCE

An ACKl control character sequence (positive
aCknowledgement) was received
from
the
remote station.

RECEIVED DLE EDT SEQUENCE

A OLE
EDT
control character sequence
(disconnect sequence) was received from the
remote statton.

RECEIVED ENO

An ENQ control character was received from
the remote station.

RE,CEI VED EOT

An EDT control character was
the remote station.

RECEIVED GARBAGE CHARACTERS

Data was received from the remote station
but wasunrecognlzable.

RECEIVED NAK

A NAK control character
acknowledgement)
was
remote statton.

S~QUENCE

RECEIVED RVI SEQUENCE

received

sequence
received

from

(negative
from the

An RVI control character sequence ("reverse
interrupt" positive acknowl- edgement) was
receIved from the remote statIon.
A text message (with no errors) was received
from the remote station.

RECEIVED TEXT BLOCK

message, ending with an end-of-text
character was received
from
the
remote. The remote wants to send more text.

A

text

blOCK

IN ERROR

A text message was received from the remote
station.
However, a parity
error
was
detected.

RECEIVED TEXT OVERFLOW

A text message was received from the remote
station.
However,
the
message
length
exceeded
that specified by the INCOUNT
parameter of the CREAD intrinsic call and
overflow occurred. Note that in such cases
the driver cannot perform parity
error
ChecKing.
The received text should be
considered unreliable.

RECEIVED

c

T~XT

6-37

Table 6-2.

Trace Entry

EVEN1' Def in1 t

Ions (Cant.)

EVENT
RECEIVED TTD SEQUENCE

RECEIVED WACK SEQUENCE

A WACK control Character sequence ("wait
before
transmitting"
positive
acknowledgement)
was received trom the remote
station dUring a write operation.

RESPONSE TIMEOUT EXPIRED

No aCKnowledgement was received from the
remote
station within the maximum time
allowed. Note that a WACK control character
always resets the timer.

SAME STATION AS BEFORE

Transmit data to or receive data from the
sam~ station as the last request.

SELECT

Select a particular station on a
line.

SEND

THE

STATION

DISCONNECT

multipoint

A CCONTROL intrinsic call with CONTROLCODE=2
has been encountered. The driver is to
perform a "Send Disconnect" operation.

SEND IO THEN RECEIVE 10

IO verification is to be performed on thi~:
line. The local station Is to first sen~~
its 10 to the remote and then receive the
remote·s 10.

SEND RESET

A CCONTROL intrinsic call with CONTROLCODE=l
has been encountered. The driver is to
perform a "send Reset" operation.

SEND TO DIFFERENT STATION

The station specif1ed by the
request's
STATION parameter is different trom the
currently polled/selected station.

SYSTEM CONTROL REQUEST

A request tor a START TRACE, STOp TRACE, or
STOP FLUSH function has been encountered.
The driver 1s to perform the
specific
function.

6-38

o
·,1

Table 6-2.

Trace Entry EVENT Definitions (Cont.)

EVENT

~i~TEM

INFORMATION TRANSFER

TRANSFER

~RROR

DEFINITION
A request for a CGETINFO, CCHECK, or SHOWCOM
information transfer to/from the mainframe
has been encountered. The driver is to
perform the specific transfer.

A local TeU (i.e., HSI
error was detected.

or

SSLC)

tranSfer

WRITE (CONVERSATIONAL)

A CWRITE is to be performed having an input
and an output Dutter.

WRITE (NO BUFFER)

A CWRITE is to be performed having no
or ouput buffer.

wRITE (OUT SUFFER)

A CWRITE is to be performed having on output
buffer but no input buffer. operation.

c·.\·

\

b-39

input

Table 6-3.

'IraceEntry ACTION Definitions

DEFINITION

ACTION

o

AAORT THE REQUEST

The driver Is to abort the current intrinsic
call and process the next user request.

BID FOR THE LINE

The driver is to bid for the line (i.e.,
send an ENQ to the remote station and then
receive a response; the expected positive
response Is an ACKO sequence).

BREAK CONNECTION

A
CCLOSE
intrinsic
call
has
been
encountered.
If the communications link
with the remote station currentlY exists,
the driver Is to send either a OLE EDT
sequence
(switched
line)
or
an
EDT
(non-switched line) to the remote station
and then disconnect the line.

BROADCAST TO ALL TRIBUTARIES

send text to all stations on the line.

DISCONNECT

Initiate disconnect sequence.

~XECLAST

REQ,RE=EOT IN CNTL

An
EDT
was detected in a control Characte()"
sequence received from the remote station -'
The driver is to re-execute the latest
physical driver request (i.e., the OPERATION
specified 1n the previous aPR trace entry).

EXEC LAST REQ,RE=INVALID 10

An invalid ID sequence was received from the
remote station. The driver is to re-execute
the latest physical driver request (i.e.,
the OPERATION specified in the previous DVR
trace entry).

EXEC LAST REQ,RE=RECV GARBGE

An unrecognizable text message or control
character sequence was received from the
remote station. The driver is to re-execute
the latest physical driver request (i.e.,
the OPERATION specified in the previous DVR
trace entry).

6-40

o

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

DEFINITION

EXEC LAST REQ,RE=REQ RSP RSNO

The remote station has asked the local
station to resend its latest response.
The
driver is to re-execute the latest physical
driver
request
(i.e.,
the
OPERATION
specified in the previous aPR trace entry).

EXECUTE CCONTROL REQUEST

has
been
A eeONTROL
intrinsic
call
encountered. The driver is to perform the
specified control function.

EXEC SYSTEM CONTROL REQUEST

A request for a START TRACE, STOP TRACE, or
STOP FLUSH has been encountered. The driver
will perform the specific function.

EXEC SYSTEM INFORMATION TRANSFER A request for a CGETINFO, CCHECK, or SHOWCOM
information transfer to/from the mainframe
has
been
enc9untered. The driver will
perform the specific transfer.
FREEZE 1.0. LIST

Tne driver is to freeze the line'S Mise Data
Segment which contains the 1.0. List.

OEEZE THE BUFFER

The driver 1s to freeze the user's stack
(NUMBUFFERS=O) or freeze the CS
buffer
(NUMBUFFERS>O) In preparation for a data
transfer operation.

GENERATE CURRENT USER REQ

The driver is -to
intrinsic call.

GENERATE CURRENT WRITE REQ

The driver 1s to recall the current
intrinsic call.

GENEPATE REQUEST OR ABORT

The driver is to
recall
the
current
intrinsic call, unless a soft' abort was
receIved, in which case an abort. should be
performed.

GET TIPE OF 10 CHECKING

Test the kind of 10 Checking to be performed
- read, write, or no cnecking.

o

6-41

recall

the

current
CW~ITE

Table 0-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

DEit"INITION

o

INC RETRY CTtRE=ATTMPT LBiD

The local station is the primary station and
has received an ENQ 1n response to its line
bid.
The driver Is to increment the retry
counter and then either retry the line bid
(it the allowable number of retries has not
been exceeded) or perform the ·POST LINE BID
PREEMPTED" action described later in this
table.

INC RETRY CT,RE=BAD ACK

The local station has received the wrong
positive acknowledgement (i.e., ACKO when
ACKl was expected, or vice versa).
The
driver is to increment the retry counter and
then either resend the latest text message
(if the allowable number of retries has not
been exceeded) or perform the "POST MAX
RETRIES" action described later in this
table.

INC RETRY CT,RE=ENQ TO TEXT

The local station received an ENQ as the
response to a text message. The driver Is
to increment the retry counter and then
either resend the latest text message
the allowable number of retrleShas not bee
exceeded) or perform the "POST MAX RETRIES"
action described later In this table.

(10

INC RETRY CT,RE=GARBGE TO TX

I

...

The local station
received
a
garbled
response to a text message. The driver 1s
to increment the retry counter and then
either resend the latest text message (if
the allowable number of retries has not been
exceeded) or perform the "POST MAX RETRIES"
action described later in this table.

6-42

o
.·1

Table 6-3.

(

Trace Entry ACTION Definitions (Cont.)
DEFINITION

ACTION
INC RETRY CT,RE=INVALID 10

An invalid 10 sequence was recelvedfrom the
remote station. The driver is to increment
the retry counter and then either retry the
line bid (it the allowable number of retries
has not been exceeded) or perform the "POST
MAX RETRIES" action described later in this
table.

INC RETPY CT,RE=NO RESP TO ENQ

The remote did not respond to the ENQ sent
by the local.

INC

RETR~

CT,RE:RECV ENQ

Tne remote sent an ENQ.

INC RETRY CT,RE=RECV GARBAGE

A garbled text message or control character
response
was
received from the remote
station. The driver Is to increment the
retry counter and then either aSk the remote
station to resend the message or response
(if the allowable number of retries has not
been exceeded) or perform the "POST MAX
RETRIES" action described later in this
table.

«:)C RETRY CT,RE=REQ TXT RSND

The remote station has asked the local
station to resend its latest text message.
The driver is to increment the retry counter
and then either resend the latest text
message (if the allowable number of retries
has not been exceeded) or perform the "POST
MAX RETRIES" action described later in
this
table.

INC RETRY

CT,RE=R~SP

TIMEOUT

No acknowledgement was received from the
remote station ~ithin the maximum
time
allowed.
The driver 1s to increment the
retry counter and then either ask the remote
station to resend its latest response (if
the allowable number of retries has not been
exceeded) or perform the "POST MAX RETRIES"
action describedl later In this table.

6-43

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION
INC

~ETRY

CT~RE=TEXT

o

DEf"INITION
ERROR

The text received from the remote has a bad
check character and the local must reject.

INC RETRY CT,RE=TXT OVERFLOW

Either the remote station sent text which
was larger then the input buffer or the
ETl/ETB delimiter was garbled.
The driver
Is to increment the retrY counter and then
either ask the remote station ~o resend its
text (if the allowable number of retries has
not been exceeded) or perform the "POST MAX
RETRIES· action described later in this
table.

INITIALIZE THE DRIVER

A COPEN intrinsic call has been encountered.
The driver is to be initialized.

LAST TRIBUTARY SENT TEXT

Text was received from the current station
even though an attempt was made to put it
back into control mode by sending it an RVI.

MRJE READ CONTINUE

Reset the ACK counters. (MRJE protocol uses
only ACKO·s.) Continue the last operation
(Read).

NO

OPERATION

POLL

No action Is to be performed.
Poll the
the CREAD

requested

.
O
.

station(s) to complete

r~quest.

POLL (START WITH CURRENT STA)

Poll the requested station(s) starting
the current station.

POST ALL STATIONS DOWN

An attempt has been made to read from the
list of stations or groups specified In tne
current CREAD intrinsic or an attempt has
been made to write to the station or to
broadcast to the line as specified in the
current CWRITE intrinsic. However, because
all appropriate stations have been marked
down in previous reads and writes, this
request cannot be satisfied.

with

o

Table 6·3.

c

Trace Entry ACTION Definitions (Cont.)

ACTION

DEFINITION

POST BROADCAST DONE

The request to send text to all stations has
been completed successfully.

POST EXHAUSTED POLLING

No stations have had data to send and the
requested number of iterations through the
poll list have been completed.

POST HARDWARE FAILURE

A hardware failure has occurred with the
modem or TeU. The driver is to disconnect
the line, report the specific
hardware
problem to the user program, and process the
next user request.

POST INVALID REQUEST

The current intrinsic call is invalid.

POST LINE BID PREEMPTED

If the local station is the primary station,
this
means
that
the
remote
station
continually responded with an ENQ when the
local station was bidding for the line
(i.e., the retry counter overflowed).
If the local station is the
secondary
station, this means that the remote station
responded with an ENQ when the local station
tried to bid for the line.
In either case, the driver is to process the
next user request.

POST

MAX

RETRIES, DISCONNECT

The maximum number of allowable retries has
been exceeded. The driver is to disconnect
the line, post the error, and then process
the next user request.

POST MAX RETRIES, SEND EDT

The maXimum number
been exceeded. The
control Charac~er
post the error, and
user request.

POST NO LINE BID RECEIVED

The local expected to receive a line bid but
none were received from the remote.

c

6-45

of allowable retries has
driver is to send an EDT
to the remote station,
tnen process the next

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

o

ACTION

DEFINITION

POST OPERATION FINISHED

current
intrinsic
The
completed. The driver i&
next user request.

POST READ BUFFER OVERFLOWED

text message was received from the remote
station.
However,
the
message
length
exceeded
that specified bY the INCOUNT
parameter of the CREAD intrinsic call and
overflow occurred. Note that 1n such cases
the driver CANNOT perform parity
error
checking.
The
received text should be
considered unreliable.
The driver 1s to
process the next user request.

POST READ REQUEST SUCCESSFUL

The
current
CREAD
intrinsic
performed successfully.

POST RECEIVE TIMEOUT

Nothing (including TTO) was received from
the remote station within the maximum time
allowed
during
execution
Of
a
read
operation. Note that a TTO sequence always
resets the timer. The driver 15 to process
the next user request.

call
has been
to process tne

A

call

was

POST RECEIVED UNEXPECTED RVI

An RVI was received trom the remote although
the local 15 sending text in blocks and not
all of the blocks have been sent.

POST RECEIVE UNEXPECTED TEXT

The remote sent text and the local user did
not provide an input buffer to receive it.
The driver is to process the next request.

6-46

C:>'.

o

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

DEFINITION

POST RECV UNEXPECTED EOT

An EDT was received although the local has
not yet sent all of its text.

POST REMOTE NOT READY

The remote station sent a NAK when it was
being selected or when sending ID sequences.

POST REM PROTCL ERR, DISCNeT

The remote station contempuously violated
the esc protocol conventions. The driver is
to disconnect the line, post the error, and
process the next user request.

POST REM PROTCL ERR, SND EDT

A protocol error was
remote - send an EOT.

POST REMOTE REJCTD CONNECTN

The
remote
station rejected the local
station's attempt to establish a connection.
The driver is to disconnect the line, post
the error, and process the
next
user
request.

POST REMOTE REJECTD LINE BID

The remote station responded with a NAK or
EDT when the local station tried to bid for
the line. The driver is to process the next
user request.

POST REMOTE SENT DELAY SEQ

The remote sentTTD or WACK but it Is not
permitted 1n this context
(see DOPTIONS

o

received

from

the

*******)
EDT

An EDT
was received from
the
remote
station.
The driver is to proCess the next
user request.

POST REQUEST ABORTED

The current intrins1c call has been aborted.
The driver is to process the next user
request.

POST RETRY OVERFLOW

The number of retries allowed has been
performed. Return to the calling program
without taking any further action.

POST REMOTE

c

SENT

6-41

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

DEFINITION

o

POST RVIRECEIVED

The remote station sent an RVI sequence
("reverse
interrupt"
positive
aCKnowledgement)
in response to a text
message. The driver is to process the next
user request.

POST SENT ACK, RECEIVED ACK

The remote sent an ACK inresponsetb our
ACK. The driver is to process tne next user
request.

POST

ACK, RECE1VED NAK

The remote sent an HAl In response to our
ACK. The driver is to process the next user
request.

POST SENT ACK, RECEIVED RVI

The remote sent an RVI in response to our
ACK. The driver is to process the next user
request.

POST SYSTEM ERROR

While
performing some function for the
driver, MPE detected an internal error. The
driver is to process the next user request.

POST WRITE 0 BUFF SUCCESSFUL

The cu.rrent "Write 0 buf f "request (CWRITO..
intrinsic call with no input or outpu
buffer
specified)
was
performed
successfully. The driver is to process the
next user request.

POST WRITE REO SUCCESSFUL

The
current
CWRITE intrinsic call was
performed successfully. The drIver is to
process the next user request.

READ CTRL SEQ,RE=RECV GARBGE

An unrecogniZable control Character sequence
was received from the remote station.
The
driver
Is to retry the "read control"
operation.

READ 0 BF: POST READ SUCCESS

The current "Read 0 bUf" request (CREAD
intrinsic call with no buffer specified) was
performed successfully. The driver is to
process the next user request.

SE~T

o
.• j

Table 6·3.

(

Trace Entry ACTION Definitions (Cont.)
DEFINITION

ACTION
READ TEXT, RE=RECV GARBAGE

During
a
"read
text"
operation,
an
unrecognizable text message was received
from the remote station. The driver is to
retry the "read text" operation.

READ TEXT, RE=TEXT OVERFLOW

Either the remote sent a text block Which
was too large for our input buffer or the
ETX/ETB character was garbled.
The driver
is to process the next request.

RECEIVE REMOTE'S LINE BID

The driver 15 to receive a line bid (ENQ)
from the remote station.

RECORD CONKECT TIMEOUT

The line was not physically connected within
the allowed time. The drlver is to post the
error and process the next user request.

RECORD LATENT OLE EOT

A DLE EOT sequence was received tram tne
remote station in response to a WACK or TTD.
Tne driver is to disconnect the line, post
the error, and await the next user request.

C::;ORD LAtENT EOT

An EOT was received from the remote station
In response to a WACK or TTD. The driver Is
to post the error and await the next user
request.

RECORD LATENT RECV TIMEOUT

NO response was received from the remote
station to a WACK or TTO Within the allowed
time. The driver is to post the error and
await the next user request.

RECORD LOCAL TID, DISCONNECT

A CREAD or CWRITE intrinslc call was not
issued within the maximum time
allowed
following
a
previous
CREAD or CWRITE
intrinsic call. The driver Is to disconnect
tne line, post the error, and await the next
user request.

RECORD POWER FAIL, DISCNCT

A power failure occurred. The driver is to
disconnect the line, post the error, and
await the next user request.

c
6-49

'fable 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

o

DEFINITION

RECORD RECV TID, DISCONNECT

Nothing (including TTO) was received
the remote station within the maximum
allowed
during
execution
Of
a
operation. The driver is to disconnect
line, post the error, and await the
user request.

RECRD OUT BFR DIRTY, SNU EDT

During execution of a "Write Conversational"
request, the remote station aSKed the driver
to resend its latest text message. However,
the driver found that the text message In
its buffer had been overlayed by a garbled
response
from the remote station.
The
driver 15 to send an EDT to the remote
station.

REMOTE REQUESTED DOWNLOAD

While executing a CREAD from unconnected or
control state, the remote sent
a
NAK
(instead of an ENQ) Which requests the local
use~ to send the download file.
The driver
is to process the next request.

REMOTE SENT OLE EDT

A.

REPEAT LAST

The driver 1s to repeat the latest Physical
driver
request
(i.e.,
the
OPERATION
specified in the previous OPR trace entry).

PH~S

OVR REQUEST

from
time
read
the
next

OLE EDT sequence was received trom the (~
remote station. The driver is to disconnect..!
tne line, post the error, and process the
next user request.

OF LAST ACK

The driver is to send an ENQ to the remote
station. This asks the remote station to
res end its latest acknowledgement.

REQUEST RESEND OF TEXT

The text message received trom the remote
station (in conjunction with a "read text"
or "write conversational" operation) was
either garbled or contained parity errors
and the local station Is asking for it to be
resent.

REQ

RESEND

o
6-50

Table 6-3.

c

Trace Entry ACfION Definitions (Cont.)
DEFINITION

ACTION

RESET TRIBUTARY

The remote multipoint station must be put
into control mode so that it will properly
act upon the next select or pOll request.

RESPOND ENQ TO WACK

A WACK sequence was received trom the remote
station.
The driver is to respond
by
sending an ENQ.

RESPOND NAK TO TTD

A Tl0
sequence has been received trom the
remote station. The driver is to respond bY
sending a NAK.

SELECT TRIBUTARY

Select the requested station so that the
user·s CWRITE request can be completed.

SEND ACK, RECEIVE TEXT

The driver Is to send either an ACKO or ACKl
sequence (whichever is proper) to the remote
station and then receIve a text message.

S~ND

DELAY SEQ, GET RESPONSE

Send either a WACK or a TTD depending on
wnether reading or writing, respectively.
Wait for a response from the remote. WACK 1s
sent if the local is not ready to receive
more data.TTD is sent if the local is not
ready to transmit data.

SEND DISCONNECT SEQUENCE

Tne driver is to send either a OLE EOT
sequence (switched line) or an EDT to the
remote station, disconnect the line, and
then process the next user request.

SEND ENQ, GET RESPONSE

Tne driver Is to send an ENQ to the r~mote
station and then receive a control Character
response.

SEND ENO, GET TEXT/RESPONSE

The driver is to send an ENQ to the remote
station and then receive either a text
message or a control character response.

SEND EDT

The driver Is to send an EDT to the remote
station and then process the next user
request.

6-51

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

o

DEFINITION

SEND IO-ACK, RECEIVE TEXT

The driver 1s to send an 10 ACKO sequence to
the remote station and then receive a text
message.

SEND IO-ENQ, RECEIVE ID-ACK

The driver is to send an 10 ENQ sequence to
tne remote station and then receive an 10
ACKO sequence.

SNO MRJE DELAY,RECV TXT/RESP

The
driver is to send a special text
message, with the MRJE wait'a'bit set. After
the Resp/Text is received in reply, no
further text will be transmitted until the
next intrinsic call (CREAD, CWRITE). The
handshaking ACKO send by the C~EAO/CWRITE
clears this condition at the Host. The CHECK
TEXT FLAG action clears this
condition
locally. This is sent only when an internal
timeout occurs.

SEND

NAK AND RECEIVE TEXT

ASK the remote to resend its text.

SEND RVI AND RECEIVE TEXT

The drl ver 1s to send an RVI seQu. ence to the ("\
remote station and then receive a text ~
meSsage.

SEND TEXT AND RECV RESPONSE

The driver 1s to send a text message to the
remote station and then receive a control
Character response.

SEND TEXT, RECV TEXT/RESP

The driver is to send a text message to the
remote station and then receive either a
text message
or
a
control
character
response.

SET STATtON DOWN

The station or group beino addressed does
not respond, or responds with unacceptable
data. Note that this stat10n or group 1s
"down" and refuse to reference it unless the
station is marked "up" by the intrinsics.

o
6-52

Table 6-3.

c

Trace Entry ACTION Definitions (Cont.)
DEFINITION

ACTION

SET TIMEOUT FOR NXT WACK/TTD

The
driver
is to reset the "WACK/TTD
generator timer" to its starting value.

TEST FOR TEXT RECEIVED

Test the Text flag. This WOuld have been set
if text was received in response to the MRJE
DELAY action.

TEST IF BLOCKING INPUT

An ETB was received at the end Of this blocK
of text • determine Whether the user expects
data to be blocked.

TEST IF IN DOWNLOAD MODE

While awaiting a line bid a NAK has been
received instead of the expected ENQ. If the
driver has been configured for download then
the NAK indicates that the remote 1s now
ready to be downloaded.

TFST IF LOCAL IS PRIOR SEeN

The driver is to test Whether the local
station Is the primary or secondary station.

IF OUTPUT BUFR IS DIRTY

During execution of a "Write Conversational"
request, the remote station asked the driver
to resend its latest text message. The
driver is to examine the contents of its
buffer to see it the text message qot
overlayed by a garbled response from the
remote station.

3

T~ST

C)·
y

o
6-53

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION
T~ST

IF

PROPE~

o

DEFINITION
ACK RECEIVED

Tne driver is to test the ACKO or ACKI
sequence received from the remote station to
make sure it 15 the one expected.

TEST IF RSP TID JUST OCCURRD

The wrong ACK sequence was received from the
remote In response to a text message.
The
driver is to test to see if a response
timeout also occurred in conjunction wIth
the "lost" text bloCK.

TeST IF SELECTION OR BRDCAST

CheCK the intrinsic call to see whether the
user wants to talk to an Individual station
or to the entire line.

TEST IF

Determine whether any more data
current CwRITE remains to be sent.

SENT

LAST BLOCK

for the

TEST IF STATION IS NEW

A read or
wrIte is to
be
performed.
Determine if the station referenced is the
same as the previously referenced station.

TEST IF WILL WAIT FOR REMOTE

Determine If a delay request from the remote
15 allowed.
()

T~ST

RECEIVED. 10 SEQUENCE

TEST SOFT ABORT FLAG
TEXTRECEIVED~

NO REQUEST

Test to
valid.

see if the 10 sequence received Is

Test to see if a sott abort
requested by the intrinsics.

has

been

Text has been received in response to the
MRJE DELAY action - the Text flag has been
set.

TRANSFER TEXT TO READ

Text was received in response to a prevIous
SEND MRJE DELAY action - transfer this text
instead of reading from the ~lne.

TRANSFER TEXT TO WRITE

Text was received In response to a previous
SEND MRJE DELAY action - transfer this text
instead of reading from the line tor tne
write conversational.

o
6-54
·'·1

Table 6-3.

Trace Entry ACTION Definitions (Cont.)

ACTION

DEFINITION

UNEXPECTED EVENT, DISCONNECT

Somethinq unexpected happened. The driver
Is to post toe error and then await the next
user request.
If the communications link
With the remote station currently eXists,
the
driver will first send a OLE EOT
sequence
(switched
line)
or
an
EDT
(non-switched line) to the remote station
and disconnect the line.

WAIT FOR LINE RID

Tne current intrinsic call is either "Read
Connect" or "Read Connect, Enquiry" (CREAD
With OPCODE=O or 2) and the driver 1s
waiting for the communications link to be
established and a line Did (ENQl to be
received trom the remote station.

WAIT FOR PHYSICAL CONNECTION

The driver is waiting for the communications
linK to be established.

WAIT FOR RESENO OF RESPONSE

The control character response from the
remote statton (in conjunction With a "write
text" operation) was either garbled or lost
and the local station has asked for it to be
resent.
The local station is currently
waiting
for
the retransmission of the
control Character response.

WRITE CONVR: TEXT ERROR

Te x teo n t a i n in g par 1 t y err 0 r s waS r e c e i ve.d
trom the remote station as the response to/a
text message dur Ing execution Of a "wr.1/te
Conversational" request (CWRITE with oQ'tput
and input buffer specified). The driver has
asked the remote station to resend its
response.

WRTE CONY: POST READ SUCCSFL

The current "Write Conversational" request
(CWRITE
with", output
and input buffer
specified) was performed succeSSfully.

•. ,\

( "'"
/

I

c
6-55

o

o

o

-.-----....----_.. _-_ ... _--.-----_ ..-.-_._- ..-.-.-.--.-----..---.-_.... CONFIGURING

CS/3000

Section VII

---_ .... __ ._._._.... _------_._-._-_. __ .. _--_ .. _-_ .. -.-_._-----------.---

7.1

~onfigurator

Dialog

... _---

-~---------/

A number of extensions have been made to the MPE confiqurator to
accommodate CS.
These extensions, concerned exclusively with 110
configuration changes, are necessary to add CS to a system or to
alter an eXisting CS configuration.
The extensions are of one of two forms: t) modified control paths
through the dialog steps resulting from responses to eXisting (i.e.,
file·system related) questions, and 2) new dlaloQsteps pertaining
to CS. Both torms are described In the dialog changes given below.
Two step numbers are given for each interrogation. The first refers
to :SYSDlJMP command dialog steps and the second (parenthesized)
refers to the initiator dialog steps; both of Which are taken from
the MPE Version C ERS. Where existing dialog steps are discussed,
only changes and extensions are described.
3.1(8)

LIST 110 DEVICES?

-----_ ... _-------

If YESls entered, a list of all input/output devices will
be printed. This list will include CS devices.
For CS
devices, onlY that information common to CS and FS will be
printed.
If CS is KnOWn to exist on the system, the next step will
be 3.1.1(8.1). Otherwise, the next step wIll be 3.2(9).
3.1.l(8.llLIST CS DEVICES?

._----_._-_.---To print a list of CS device characteristics, enter YES.

To suppress the listing, enter NO.
The next step will be 3.2(9).

c

7-1

3.3(10)

LOGICAL DEVICE #1

.---------------If a zero or carriage return is entered, the dialog will
Skip either to 3.3.13(22.1) if CSexists or has been added
to the system or 3.4{23l otherwise.

0•...

3.3.1(11) ORT #1

------

To add a device, enter its DRT number. To remove a devIce
and return to step 3.3(10), enter zero.
3.3.2(12) UNIT .1

-------

Enter a zero for CS device types 17, 18, or 19.

CHANNEL '1

---.-----.Enter a zero for CS device types 17, 18, or 19.

---.-

3.3.3(13) TYPE?

The following

d~vlce

types have been allocated to CS:

o

17 - Single Channel Communications Processor (SCCP)
18 • Synchronous Single Line Controller (SSLC)
19 - High speed Serial Interface (HSI)

3.3.4(14) SUB-TYPE?

,

--------If TYPE is 19, then SUB-TVPE must be 0
If TYPE is 17 or 18, then the

are defined:

o
1
3

7

-

following

SUB·T~PE

values

Synchronous/SwItched/Modem
Synchronous/Non-switched/Modem
Synchronous/Non-switched
Asynchronous/Non-switched

If TYPE and SUB-TYPE indicate this 1s not a CS deVice, the
next step will be 3.3.4.0(15). If TYPE=19, the next step
will be 3.3.4.0(14.0).
If TYPE=17 or 18, the next step
will be 3.3.4.1(14.1>.

o

3.3.4.0{14.0l PORT MASK?

---------This value will form a maSK indicating which H51 channel
will be used by this line. Permissable values are
8 - HSI
4 - HSI
2 - HSI
1 - HSI

channel
channel
channel
channel

0
1
2

3.

3.3.4.1(14.1) PROTOCOL?

--------The protocol numner for the device should be entered.
Allowable values are 1-255. currently the only defined
values are
1

2
3

= Bisync
= MRJE
= HPDLC I

3.3.4.2(14.2) LOCAL MODE?

.---------The
local mode for the statton should be entered.
Allowable values are 1-15. Currently defin~d values are:
1

2
3
4
5
6

= local is primary contention station

-- local
local

Is
= local is
Is
= local is
= local Is

-

secondary contention station
multipoint control station.
secondary station on a mUltipoint line
an HPDLC I system acting as DTE
an HPDLC I system acting as DeE

The next step is 3.3.4.3(14.3).
3.3.4.3(14.3) TRANSMISSION CODE?

---------.---_._--

The transmission code for the deVIce Should be entered.
Allowable values are 1-63; the currently defined values
are
1 - automatic code sensing if the connection is

accomplished by a CREAD, ASCII it the connection
Is done With a CWRITE.
2 - ASCII
3 - EBCDIC

c

3.3.4.4(14.4> RECEIVE TIMEOUT?

--------- .. ---_.

The recei ve timeout value should be entered. Thi s is the
length oftlme that the local station will wait for a text
block to be sent by the remote. If a carriage return is
entered, a 20-second default will be provided.

0··.

......-_.-.---

3.3.4.5(14.5) LOCAL TIMEOUT?

The local timeout value should be

ent~red.
This Is the
time that CS will allow between the completion
of the previous 1/0 request and the initiation of the next
one.
Note that this only applies when the line 1s
connected. If a carriage return Is entered, a 60-second
default will be provided. The next step is 3.3.4.7(14.7).

amoun~

of

3.3.4.1<14.1> CONNECT TIMEOUT?

.-..-----------The connect timeout value Should be entered. If a carriage
return is entered, a 900-second default will be provided.
For non-switched lines, If SUB-TYPE implies connection via
a modem, the next dialog step will be 3.3.4.11(14.11>. If
SUB-TYPE implies a hardwlre connection the next dialog
step will be 3.3.4.13(14.13).
If SUB-TYPE imPlies a
switChed line, the dialog w1l1 proceed in sequence.

0)
~

= .

DIAL FACILITY?
....
_
--.

3.3.4.8(1~.8)

A YES response will indicate that the line has the ability
to dial out (either manually or automatically).
3.3.4.9(t4~9)

ANSWER FACILITY?

---_.. _---------

To specifY that this device has an answerinQ capability
enter YES. If the response is NO, the dialog will SKip to
step 3.3.4.11(14.11>.

---.---_.. ----_..

4.9.1<14.9.1) AUTOMATIC ANSWER?

To· specify
that
this device has automatic answer
capabilities enter YES.
A NO response will Indicate
. manual answering is required.

o

3.3.4.11(14.11) DUAL SPEED?

----------the modem is dual speed, enter YES. If
NO, the dialo9 will sKip to
step

To specifY that
the response 1s
3.3.4.13(14.13).

.--._..-.--

3.3.4.12(14.12) HALF SPEED?

If the modem Is to operate at half-speed enter YES. To
specify that the modem Is to operate at full speed enter
NO or a carriage return. The next dialog step will be
3.3.4.14{14.14).
3.3.4.13(14.13) SPEED CHANGEABLE?

---------.---.-.If the speed of the line is Changeable, enter ¥ES.
3.3.4.14(14.14) TRANSMISSION SPEED?

--------------_ .. _-

Enter the transmission speed of the line in characters per
second.

C'.

3 • 4 • l5 ( 14 • 15) TRAN S MIS S ION MODE?

--------._-------.
One of the tOllowing transmission modes should be entered:
0
1
2
J

full duplex
= half
duplex
= simplex
only
= simplex • write
read
only.
=

-

The HSI hardware requires full duplex. When uSing the
Bisync protocol, the SSLC interface may require either
half or full duplex, depending on the type of line and
modems.
3.3.4.16(14.16) PREFERRED BUFFER SIZE?

.. _------_.--.--------

c

Enter the butfer size (in words) most sUitable to the
device being configured. When using the RSI or SSLC
boards, this value must be less than or equal to 4095.
This value becomes the default COPEN BUFFSIZE.

7-5

3.3.4.11(14.17) DRIVER CHANGEABLE?

-_._-----.--_.- ...
If

a

user program can change the driver tor this device,

enter YES.

c:>

3.3.4.18(14.18) DRIVER OPTIONS?
-~._.-_

.. _-----

Enter the appropriate driver options value for the default
driver. The next dialog step will be 3.3.11(21).
3.3.11(21) DRIVER NAME?

-----------Enter the name of the default driver tor this line.
If the device is not a Cs d~vice (i.e., TYPE <> 18-xx),
tne dialog will skip to step 3.3.12(22). Otherwise, If
SU8-TYPElmplles a non-switched line then:
a. If the line is point to point the dialogue will
return to step 3.3.11.4(21.4).
b. if tne line is multipoint the dialog will Skip to
3.3.11.6(21.&). If the line 15 switChed, the dialog
will proceed with step 3.3.11.2(21.2).
3.3.11.2(21.2) PHONELIST?

---------To provide a default Phone number list, enter YES. If the
step
response is NO,
the
dialog
will
skip
to
3.3.11.4<21.4).
3.3.11.3(21.3)

o

PHONE NUMBER?

---.------_ ..
A phonenumber can be
specified by entering a string
composed of numeric characters and hyphens.
The total
string length must not exceed 20 characters. This dialog
step will be repeated until a carriage return is entered.

3.3.11.4(21.4>

LOCAL ID SEQUENCE?
--_._._._._._---_.

The local ID sequence can
fOllowing two forms:

1.

be

specified

In

one

of

the

A
E

"string"

o

2.

0

(d,l,dJ ••• )
H

These are tne same sequence specifications as those
described for those of the :CLINE command (Section III). A
maximum of 16 bytes Is allowed.
If a carriage return Is entered, a null local to
will be assumed.
3.3.t1.5(21.5)

sequence

-----.-_...-----.. REMOTE 10 SEQUENCE?

A remote ID sequence 15 specified in the same format as
the local lU sequence.
This dialog step will be repeated until a carriage return
is entered. It Local mode indicates a control station in
supervised mode then the next dialogue step will be
3.3.11.6 (21.6).
Otherwise the dialog returns to step
3.3(10).
3.3.11.6(21.6)

POLL ENTRY DELAY?

-_._------------Enter the number ot milliseconds between polling each
entry 1n the POLLIST. If a carriage return Is entered, a
200 millisecond default will be provided.

3.3.11.7(21.7)

NUMBER Of POLL REPEATS?

----------------------Enter the number of times the poll 11st is to be scanned
per 110 operation. If this number is zero the poll list
ilfl11 be repeated until a terminal responds afflrrnltively.
If a carriage return Is entered, a value of zero will oe
used.
3.3.11.8(21.8)

CIRCULAR POLL DELAY?

.. __ ... _------------

Enter the length of time, In hundredths ~t seconds,
between successive passes through the poll list. If a
carriage return Is entered, a value of zero will be used.

c
7-7

1.3.11.9{21.9)

MULTIPOINT LINE TYPE?
...
_._- ... -.---_._-_.

This 1s reserved for future use - enter a carriage return.
,3.11.11(21.11) ID VERIFICATION?

o

---.-----_._-._.

If no 10 verification 1s to be performed then enter NO or
carriage return. Otherwise type SEND it the local station
Is to initiate sending of IDs or RECV if the remote staton
is to wait for trie r~mote to initiate ID sending.

._---._.. -._._.-...._.-.

,3.11.12(21.12> LINE SELECTION SEQUENCE?

The -llneselectlon sequence is specified in the same
~ormat
as the local 10 sequence. A maximum of 8 bytes is
allowed. If the line does not support this facility, a
carriage return Should be entered.

-.--

3.11.13(21.13) NUMBER OF GROUPS?

_-----

Enter the total number of terminal groups attached to the
line. The permissable range 1s from 1 to 254.
This
number will determIne the number of t1mes the dialog step
sequence 3.3.11.14 - 3.3.11.24 will be repeated. FollOWlng-)
this the dialog returns to step 3.3(10).

C'

3.11.14C21.14) GROUP 9 POLLING ID?

----------_.--_.-.-

The polling ID is specified in the same format as the line
selection sequence. A maximum of 8 bytes is allowed. If
the qroup has no polling 10 then a carriage zeturn should
be entered.
3.t1.15(21.15) GROUP 9 SELECTION ID1

-_._._.---_.---------

The selection 10 1s specified 1n the same format as the
line selection sequence. A maXimum Of 8 bytes Is allowed.
If th~ group has no selection 10 then a carriage return
should be entered.

o
,I

3.J.lt~16(21.t6)

( •· .... /1
,/
-'.. .. "

GROUP g GENERAL POLL 101

----_ .. _----------------

The general poll ID 1s specified 1n the same format as the
line selection sequence. Note that this is appended to
the qroup polling 10 to form the general POll Sequence.
The maximum length of the concatenated sequence 15 8
bytes. If the group does not support this facility, then a
carriage return should be entered.

3.3.11.17<21.17) GROUP 9 GENERAL SELECTION SEQUENCE?

---------_ .. -.... -. __ .. -._-.---_.-.

The general selection ID 1s specified In the same format
as the line selection sequence.
Note that this is
appended to the 9roup selection 10 to form the general
selection
sequence.
The
maximum
length
of
the
concatenated sequence Is 8 bytes. If the group does not
support tnis facility, then a carriage return Should be
entered.
3.3.11.19(21.19) NUMBER OF STATIONS IN GROUP g1

---------.--------.. -----.--_.

c

Enter the total number of stations (terminalS) attached to
the group. This number will determine the number of times
the dialog step sequence 3.3.11.22 - 3.3.11.24 will be
repeated. The maximum number of statons permitted on the
line is 254.

3.3.11.20(21.20) STATION TYPE?

------------.
The allowable values are:
o
='Hp 2&45
1 -40
Reserved for future use
41-63 = user defined station type.

=

---.-..-.----

3.3.11.21(21.21) STATON INPUT BLOCKSIZE1

--------- ..

the value is different from the line·s PREFERED BUFFER
proper value.
Otherw1se enter a
carriage return.
If

SIZE, then enter the

3.3.11.22(21.32) NUMBER OF COMPONENTS ON STATION s1

C\
"

---------.---.---_ .. _----._.------

Enter

the"

total

number

of

component,

attaChed to the

station. This number will determine the number Of times
the dialog step sequence 3.3.11.23· 3.3.11.24 will be
repeated. The permissable number of components Is from
one to sixteen.
,3.tl.23(21.2J) COMPONENT c POLL ID?

.....--

o

_-----

The polling 10 is specified in the same format as the line
selection format. Note that this lOis appended to the
group polling 10 to form the component's pollino sequence.
The max!mumlength of the concatenated sequence is 8
bytes.
If this component does not support pOlling then a
carriage return should be entered.

.-----.._-._-.- .....------

,3.11.24(21.24) COMPONENT c SELECTION 10?

The selection 10 is specified In the same format as the
line selection format. Note that this 10 is appended to
the group selection ID to form the component's selection
sequence. The maximum length of the concatenated sequence
Is 8 bytes. If this component does not support selection
then a carriage return should be entered.
3.3.12(22)CLASS NAME?

----------Enter a list containing at least one device class name (up
to eight alphanumeric characters, beginning
with
a
letter).
Class names are separated from each other by
commas.

o

LIST 110 DEVICES?

-------_.-------If es is not present in the system, then the
skip to step 3.5(23.1).

dialog

will

LIST C5 DEVICES?

---------------To print a list of CS device characteristics, enter YES.

To suppress the listing, enter NO.
If

CS

Is not present on the system, then the dialog will

skip to step 4(24).

7-10

o

].6(23.8)

~DDITIONAL

CS DRIVER CHANGES?

.-._--------- ... ------------Enter YES to add or delete drivers from the list of CS
drivers which may be used but may not be attached to
particular devices. Enter NO to skip these Changes and
proceed to step 4(24).

3.6.1(23.8.t> LIST

ADDI~IONAL

DRIVERS?

--------------------.-.Enter YES to list the additional driver names.
3.6.2(23.8.2) DELETE DRIVER?

_._.-.-.------

To delete one or more drivers, enter a
enter NO to skip to step 3.6.4(23.8.4).

YES.

Otherwise

.-.. _._.- .. -

3.6.3(23.8.3) DRIVER NAME?

Enter the name of the driver to be deleted. This question
Is repeated until a carriaqe return IS entered.

C")
'-"'~

3.6.4(23.8.4) ADD DRIVER?

--_.-._-- ..
To add one or more drivers, enter a YES.

Otherwise

enter

NO to Skip to step 3.6.6(23.8.6).

3.6.5(23.8.5) DRIVER NAME?

Enter
the name of the program file containing the
alternate driver.
This question is repeated until a
carriage return 15 entered.
3.6.6(23.8.6) LIST ADDITIONAL OPIVERS?

------_.-.---_._----_._-

Enter YES to list the additional driver names.

c
7-11

o

()

o

-------~----~-----.--------._~-.--~.-.----._---.-.-.-~-----.----_._-

1

1

CS/3000 LOGGING FACILITY

1

1

..

_~

1

Section VIII 1

· 1 1

(~/\_---------------------------------_._-----------------------------.--~

CS Log Records

8.

-------------There are three different types of CS log records:
1)

Line disconnection record (type

9)

2) Line close record (type iD)
3) Line errors detected by the driver (type 11)

Each of these record
configuration time.

(~.\

types

may

I

/

c

8-1

be

selected/suppressed

at

system

.1

----------_._ .... __ .----Line Disconnection Record

This record type provides accounting information for the duration of
the connection.

0·.

Record format:

----------_.word
displacement

number of
words

-.-----_.--- .-------o

tt
13

1
1
3
1
1
2
2
2
1

14

1

15
24

9
9

33

10

1
2
5
6

7
9

--.---_.

contents

record type = 9
record length = 43
time stamp of disconnect or close
jo~ type,
job number
logical device number
duration of the connection In milliseconds
number of output data transfers
number of input data transfers
number of recoverable line errors
modulo 2**16
number of irrecoverable line errors
modulo 2**16
local 10 sequence
remote 10 sequence
phone number of remote

NOTES: 1) time stamps are in CHRONOS/CLOCK format
2) ID sequences are significant for both SW and N5~ lines. The
first byte is the length of the sequence. The remainder is
the actual 10 sequence (up to 16 bytes, left-justified).
3) The phone number is significant only if the local
3000
performed the dialing for an outgoing call. The phone
number Is represented in ASCII (up to 20 Characters,
left-justified with trailing blanks).
4) CCLOSE of a connected line will emit one line disconnect log
record followed by one line close log record.

8-2

o

8.2

Line Close Record
.---~.---.-------

()

This record type provides accounting information about the allocation
of a line (logical device).
Record format:

----------_ ...

word
displacement

.----------o
t
2
5

number of
words

._ .... _--1
1

6

3
1
1

1
10

3
4

----_.--

Contents
record type = 10
record length = 14
time stamp ot close
job type, jOb number
logical device number
time stamp of open
driver name

NOTES: 1) time stamps are in CHRONOS/CLOCK format.
2) the driver name may be up to eight A5CII characters in
length, lett-justified witn trailing blanks.

c

()
8-3

8.3

CSI/O Errors

---------_ ...

~~~:/~~o~: ~i~: :~~~~=~s information about instances of the following
1)
2)

0

Any hardware error (CCHECK error code values of 101-149)
retry count exhausted due to any of the following recoverable
errors:
CCHECK
Recoverable
Error code

--_.-....--.--.---._-------_._...---_._------------_..--2

3

5
8 .

9

11
13

14
15

Description

received unintelligible sequence
bloCK check character error
received incorrectac1<.nowledgement
received unintelligible sequence after sending
text
received enquiry character after sending text
remote requested resend of last text block
received text overflow
data overrun occurred on the SID multiplexor
channel
transfer error occurred on the SID mUltiplexor
channel

The record type and format 15 the same as an 110 Error (type=11l.
Please reter to the System Supervisor Capabilities Manual for the
record's format. Within the format, the following data items have
special meaning:
110 Record
Format Name

-----._----

0.

, ._J

.

Interpretation for
CS device

--------------------------

HARDWARE STATUS

Same as ERRORCODE parameter of CCHECK
intrinsic

DRIVER DEFINED
PARAMETER #1

Current number of recoverable errors
during this connection

DRIVER DEFINED
PARAMETER .2

Number of retries while executing the
current 110 request

o
8-4

~---_._--------_.

__ .. ------.---.----.-_._------.-----. ----._ ... -.-.-.- ..
C5/3000

(

Section IX

OPERATOR MESSAGES

... --------- .. __ ..... _._----_ ... _------.--_ .. _..-----

\,

I

~/-----------------_
'I

I

9.1 Dial Message

-----------This message informs the operator that a manual dialing operation is
required In order to physically connect a switched line. A reply to the
message is required to inform the appropriate C5 intrinsic if the phone
number specified was successfully dialed.
The message has a format
number of 2; tne  portion 1s
LDEV' ldn DIAL phonenumber. ANSWER(Y/N)?
where Idn

= logical

device number of the CS line

If the number 15 successfully dialed then a
typed, else type "N".

4[;.2

"~"

should be

Error Message

------------This message informs the operator when an irrecoverable error occurs on
a line; no reply is required.

LDEV' Idn CS 110 ERROR: errorcode
where ldn
errorcode

= logical device number of the CS line
= 1s a CCHECK hardware error number.

This error message may be suppressed
1n the COPEN parameters.

by

setting AOPTIONS.(11:1) to "1"

---.. -...... .. _..----

9.3 System Failures
-

The following System Failures are generated by CS:
900

c

902
903

110 request no longer associated with the user's process
Unable to freeze segment In main memory
Unable to lOCK segment in main memory
9-1

909

Unable to increase data segment size
Unable to decrease data segment size
Unable to unfreeze segment in main memory
Unable to unlock segment in maIn memory
Invalid pointer to pollist area

secp

RAM Dumps

904

905
906
907

~.4

o

-----------_.~hen
an secp system failure is detected, es attempts to dump the
contents of the SCCP RAM to a disc file by issuing a CCONTROL call with
the controlcode = 53 and a parameter value ot 0 (zero). Upon initiating
the seep RAM dump, the following message is printed on the operator
console:

secp RAM DUMP - LDEVnnn
where nnn is the logical device number for the seep.
If the dump is successfully completed, the message

secp RAM DUMP COMPLETED

****

will appear. A dump file may have the information from the seep RAM even
though the entire dump operation was not successfully completed.
More information concerning the seep RAM dump facility is inCluded in
the description of eCONTROL 53.

o

o

------.---------._---~_.----.--_._----.-.-.~---.-------~---_.-_._--------

CS/3000 SHOWCOM COMMAND

-

( :;' ------------------ ------------- -- ------- --- -------l.

to.l

Section X

--------- ----------

' t

CS/3000 SHOWCOM Command

------_.-.--_._._---.--

C5/3000 provides for the monitoring of communication system device
status via the SHOWCOM operator·s console command.
The status
information can be used to determine communications line activity and
quality.
Communications
includes:

device

status

provided

via

the

SHOwCOM

command

Number of messages sent and received.
Last recoverable and irrecoverable errors.
Number of recoverable and irrecoverable errors.
Number of retransmissions, response timeouts,
clear to send losses, and underruns.
- Number of BCC/CRe errors, receive timeouts,
carrier losses, and overruns.
- Line state(cloSed, connected, or disconnected).
•

note:

Clear to send losses and carrier losses will
only be valid for comunication lines configured
as full duplex.
underruns will occur only when the communication
line uses the HPDLC protocol.
Receive timeouts will not occur on communication
lines using the HPDLC protocol.

When the line is In tne open state, either connected or disconnected,
the status 5HOWCOM reports is a snapshot of the statistics generated
from the last open of the line to the point in time the SHOWCOM
command is invoked. When the line state 1s closed, SHOWCOM reports
status obtained at the closure of the line reflecting the statistics
generated over the last open/close sequence.

c

10-1

10.2

SHOWCOM Command Syntax

-----------_ .... _-----

The tormat of the SHOWCOM operator·s console command Is
=SHOWCOM Idn£;ERRORS] {;RESETl
PARAMETERS

o

DESCRIPTION

ldn

Log!cal device number of a communicat1ons system
device.

ERRORS

A request for the full status list. If not
specified an abbreviated list is reported(see 10.3).

RESET

A request to reset all status information to
zero after reporting.

()

10-2

o

to.3
. -.'.. . '.
(

SHOWCOM Command Output

--------------------_.

SHOvJCOM
i

specifed.

produces

the

tOllowinq report if

the ERROPS

parameter is not

LON - XXX
MESSAGES SENT
XXXXX
MESSAGES RECEIVED
LAST RECOVERABLE ERROR
XXX
LAST IRRECOVERABLE ERROR XXX
LINE IS LLLLLLLLLL

XXXXX

When the ERRORS parameter is specified, SHOWCOM provides the
report.

c

TRANSMIT
LON • XXX
RECEIVE
MESSAGES SENT
XXXXX
MESSAGES RECEIVED
RETRANSMISSIONS
XXXXX
BCCICRC ERRD~S
RESPONSE TIMEOUTS XXXIX
RECEIVE TIMEOUTS
UNDERRUNS
XXXXX
OVERRUNS
CLR TO SEND LOSSES XXXXX
CARRIER LOSSES
# OF RECOVERABLE ERRORS
XXX
LAST RECOVERABLE ERROR
XXX
# OF IRRECOVERABLE ERRORS XXX
LAST IRRECOVERABLE ERROR XXX
LINE IS LLLLLLLLLL

tollo~lng

XXXXX
XXXXX
XXXXX
XXXXX
XXXXX

In the above examples, XXXXX indicates a positive integer, and
LLLLLLLLL specifies either the closed, connected, or dlsconnect~d line
state.
The last irrecoverable and recoverable error cOdes are
specified in sections 4.12 and 4.13.
SHOWCOM command syntax errors or parameter errors will produce one
the following error messages.
- TOO MANY PARAMETERS

• .LDN MISSING
- ILLEGAL LDN
- NOT A CS DEVICE
- INVALID DELIMITER
• ILLEGAL OPTION
• CS I/O ERROR XXX

c

: the Idn specified 1s ) 255.
: the Idn specified does not represent a
communications system dev1ce.
a parameter other than ERRORS or RESET
was specified.
in processing the SHOwCOMrequest, 110
error XXX was encountered.

10-3

of

o

o

o

_.-.-------------_ .... -.-_. __ .--_.-._ ... -..

_-------~-.-~-~-------------.

BSC OPF;RATION

(~j-~c'J

-----------_-_-----_-----._-_.-._-.------------

t
, Appendix A

I

-__

I
e

__ - _ - - -

CREAD

-----

The execution of a CREAD will differ SUbstantially depending upon protocol
driver, line mode and line state.
A.l

CONTENTION DRIVER.

Unconnected line state
~--~~------~---~-----.

Line State:

unconnected

Function:

c.

we_ewe)

text

establish physical connection
receive the remote#s line bid (optionally with ID
verification)
send an aCknowledgement to the remote's line bid
(optionally with an 10)
receive the remote's first text bloCK

If INCOUNT is omitted or set to zero, tnen only steps a and bare
executed.
If
there is a local 10 sequence then it will be sent on
the next CREAD request. The next 110 request should be a CR~AU.
Control line state
-----_._~---------

Line state:
Function: a.
b.

c.
Note:

o

control----------) text
receive the remote's line old
acknowledge the remote's line bid
read the remote's text blOCK

t. If INCOUNT Is omitted or set to zero, then only step a is
executed. The next 110 request should be a CREAD.
2. While the line Is in control state the CS driver listens for a
line bid from the remote. It the line bid occurrsthen the line
is automatically placed into text state. If bit 3 of the DOPTIONS
is set to a one, then the driver will 19nore remote line bids
between requests.

A-l

Text line state

--------------Line state:
Function:

text----------) text
a.

aCknowledge last text block
read the remote·s next text bloCK

b.

A.2

'0

MULTIPOINT CONTROL DRIVER.

Unconnected line state

---------------------Line state:

unconnected --._._----) text
or
unconnected
control

---------->

Function:

Establish physical connection.
Optionally perform 10 verification as specified by the
Line Descriptor in SUPLIST.
If the STATION parameter specified a station then:
1) poll that station
2) If the station responds neQatively then post the
request finished (line state = Control)
3) else receive the text from the remote (line state =
Text)
Else if the STATION parameter specifies the POLLIST
then starting with the current entry in the POLLIST:
1) poll the station (or group)
2) if the station r~sponds affirmatively then
receive its text (line state = Text>
3) else if this is the last entry In the POLLIST and
the required number of passes through the list have
been done, then post the request done (line state =
Control).
Else index to the next entry In the list and go
baCK to step 1.

a.
b.

c.

d.

NOTE:

o

If data can be received In blocks, then several blocks of
data may be received with an acknowledgement to each
block. Conceptually, however, a buffer of data 1s received
as described above.

Control line state

-----------------L1ne state:

Function:

control
or
control

---------->
---------->

text
control

same as steps c - d of the unconnected line state.

o

Text line state
-------_
.. _- .. ---.,

(J'le state:

~"'unct

ion:

text ----------) text
or
text ----------) control
a.

b.

c.

If the STATION parameter specifies the current station
then:
1) send an acknowledgement of the remote·s last text
bloCK
2) receive the next text bloCK from the station (line
state=Text)
Else if the STATION parameter specifies another station
then:
1) if DOPTIONS.(2:1) specifies that the previous
station must be reset by sending it an RVI, then
send an RV! sequence and receive an ~OT sequence.
(see COPEN for description of DOPTIONS)
2) poll the station
3) receive either a negative response to the pOll (line
state=Conlrol) or the remote·s text block (line
stale=Text)
Else if the STATION parameter specifies the FOLLIST
then:
1) if current POLLIST entry is a logical station
entry
(a) if DOPTIONS.(2:1l specifies that the previous
station must be reset bY sending it an RVI,
then send an RVI sequence and receive an
EDT sequence. (See COPEN for description of
DOPTIONS)
(b) starting with the next entry In the POLLIST:
(1) poll the station (or group)
(2) if the stat10n responds affirmatively
then receive Its text (state=Text)
() if this 1s the last entry in the POLLIST and
the required number of passes through the
list have been done, then post the request
done 

text

Establish physical connection
Receive line bid
(receive SOH,ENQ; send ACKO)
While waiting for the text block, answer
remote's ACKO's with ACKO's
Read the remote's text block

Control line state (not defined for MRJE)

-----------------Text line state

----- ... _------Line state:

Function:

text-··-------> text
a.
b.
c.

acknowledge last text block with ACKO
while waiting for next text blOCK, answer
with ACKOs
read the remote's next text block

A-4

remote's

ACKOs

0

o

A.4

scep and SSLC BSC Driver Message Format word (MFW)
~~----~~._.--.---.-._-_.---~

... _.------.-----_ .. -.

All BSC control characters are deleted from the incoming text stream by
the driver.
If DOPTIONS.(11:2) Is set to two then The driver describes the received
text's format via the message format word (MFW) which is contained in
word 0 of the user's buffer. Any other value ot DOPTIONS.(11:2) will
cause the MFW to be omitted from the user's text and, hence,
unavailable to the user. The MFW fields have the same meaning as in
sent text.
MFW (0:1) -- 0= the
received text was transparent.
If the text
contained IT8s then this bit means that at least one
intermediate text blOCK was transparent.
1= the received text was non-transparent.
MFW (1:1) -- 0= the received text contained no intermediate
text blOCKS 

text

establish Physical connection
bid for the line (optionally with 110 verification)
send contents of output buffer
receive either an acknowledgement of the sent
text bloCK or a text bloCK trom the remote.

If the input buffer 1s omitted then only an
aCKnowledgement 1s expected from the remote
in step d.
If both the input and output buffers are not
specified then only steps a and b will be
performed.

Control line state
~---------_.-.----

Line state:

-~------>

text

Function:

a.
b.
c.

Note:

If the input butfer is omitted then only an
acknowledgement Is expected from the :emote
in step c.
If both the input and output buffers are not
specified then only step a is executed.
While the line is In control state the CS driver listens
for a line bid from the remote. If the line bid occurrs
then the line is automatically placed into text state.
If bit 3 of the DOPTIONS is set to a one, then the
driver will ignore remote line bids between requests.

1.
2.
3.

c

control

bid for the line
send contents of output buffer
receive either an aCKnowledgement of the sent
text bloCK or a text bloCK from the remote.

A-7

Text 11ne state

-----_.-------Line state:
Function:

text
a.
b.

Note:

6

-------->

o

text

send contents of output buffer
receive either an acknolwedqement Of the
sent text block or a text block from the
remote.

If the input buffer is omitted then only an acknowledgement
expected from the remote.

Is

MULTIPOINT CONTROL DRIVER.
NOTE:

If the text Is to be sent In blOCKS, each bloCk is aCknowledged
by
the
receiving
station.
Conceptually,
however, the
transmission of the entire buffer ot data may be described as
follows below.

Unconnected line state

---------------------L1ne state:

Function:

._-------->
------->

unconnected
or
unconnected - ••

a.

b.

c.

d.

text
control

EstabliSh Physical connection.
Optionally perform 10 verification as specified bY the
Line Descriptor in SUPLIST.
If the STATION parameter specified only one station
then:
1) select that station and receive acknowledgement
2) send the contents of the output buffer
3) receive an acknowledgement of the sent text
4) final line state
Text
Else if the STATION parameter specifies general select
or line select then send the contents of the output
buffer. The f1nal line state 1s Control.

O"'"'~".·".

_

=

Control line state

._-------------_ ..
Line state:

Function:

control
or
control

---------->
aGee_e)

text
control

Same as steps c - d of the unconnected I1ne state.

A-a

o

Text line state

-------- ... _-----

(

..

,.

"~.i',\.,.

Line state:

text
or
text

··-·1

... ,./

Function:

a.

b.

C.

c.

c
A.1

._-------->
---------->

text
control

If the STATION parameter specifies the current station
and the previous operation was also a write then:
1) send the contents of the output butfer to the station
2) receive an acknowledgement of the sent text block
3) final line state = Text
Else if the STATION parameter specifies another station
and the previous operation was also a write then:
1) select the station (includes sending an EDT sequence)
2) send the contents of the output bufter
3) receive an acknowledgement of the sent text block
5) final line state = Text
Else if the STATION parameter specifies a station
and the previous operation was a read and
DOPTIONS.(2:1) specifies that an PVI should be
issued before changing stations, then:
1) send an RVI and receive an EOT response
2) perform the steps outlIned in "b." above
Else if-the STATION parameter specifies general or line
select then:
1) send an EDT sequence
2) send the group or line select sequence followed by
the contents of the output buffer
3) final line state = Control

Note: With this one exception the pollist index remains unchanged:
1) text state has been previously entered through a CREAD
specifying the POLLIST,
2) the STATION parameter specifies the current station,
3) and the remote terminal responds ~ith an EOT instead of an
aCKnowledgement or text.

MRJE DRIVER
Unconnected line state:
-----~--~-_.--------.--

Line state:
Function:

unconnected
a.
b.

c.
d.

c

-------->

text

establish phsyical connection
bid tor the line using MRJE line bid (send SOH ENQ,
receive ACKO)
send contents of output buffer
receive either an aCKnowledgement of the sent text blOCK
(always ACKO) or a blOCK from the remote.

A-9

Note:

CWRITE defined only for MRJE when specifying both input and
output buffers.

--

Control line state: (not defined for MRJE)

._------_._-. __ ..

o

-. __ ._-----_.-..

Text line state:
Line state:

Function:

Note:

text -----_._) text

a.
b.

send contents of output buffer
receive either an acknolwedgement of the
sent text block (always ACKO) or a text
block from the remote.

CWRITE is defined for MRJE only when
specifying both input and output buffers.

o

o
A-tO

A.8

seep and SSLC BSe Driver Message Format Word (MfW)
-~~--~.-------.-.-_._-._------~-.--~--------------

(~

~

~/

I

All

BSC control characters are inserted lnto the outgoing data stream
the driver. SYN and block check character (bee) sequences are
always generated.
However, the remaining message format Is specitied
by toe message format word (MFW). The value of
MFW 1s determined by
DOPTIONS.(11:2).
kefer
to the DOPTIONS parameter In the COPEN
description (section 4.2).

by

MFW (O:t) -- 0= the text block is to be sent in BSC's transparent made.
I:

the text block is to be sent in non-transparent mode.
NOTE: It is the user's responsibility to enSure that
his text block contains no BSC control characters.

MFW (1:1) -- 0: there are no intermediate text blocks Citb's) contained
within the text block.
1= the text blOCK contains itb's. The length Of each 1tb
(in t bytes) must precede its block. The length Is a
16-bit quantity and mU5t begin on a word boundarY. The
last itb must be followed bY a delimiter word set to
all ones.
MFW (2:1) --

c

This field is significant only it intermediate text
blOCkS are to be sent In non-transparent mode.
0: no SOH/STX Character will be inserted after everY

ito.

Exception: The STX character Is always inserted atter
the header, even if this coincides with tne end of an
itb.
1= an SOH/STX Character will be
stream after every itb.

injected

into

the

text

MFW (3:1) -- 0= the text block shall end With an ETX character.
1= the text ClOCK shall end with an ETB character.
MFW (4:4) --

Reserved tor future use; Should be set to zero.

MFW (8:8) --

Length of the header portion of the text blpck (in +
bytes). It this field 1s zero, then there 1s no header
portion.
NOTE: it is the user's responsibility to ensure that
there are no BSC control characters within the
header.

Note that the MFW, Itb lengths, and itb delimiter are tor the driver's
information and are not actually transmitted. The buffer·s tcount
parameter must include the MFW and the itb lengths and delimiter.

C
A-11

A.9

MesSage Formatting

----------------_.
As was previously mentioned, the HP-supplied CS drivers CSSBSCO and
CSSBSCI (SSLC), and CSHBSCO (HSI) employ the BSC protocol.
Associated
with the use of any protocol are the concepts ot line control and
message formatting. The HP drivers assume the burden of line control,
but the user is responsible for message formatting.

c:>

In many communications systems (e.g., IBM'S BTAM), the jOb of message
formatting requires the user to insert the proper asc
control
characters ,at the appropriate points in his text stream prior to
issuing a write request, and he must remove them from the text received
from a read request. This Is not true of C5/3000.
The SCCP and SSLC drivers have adopted the convention Of using a
message format word (MFW) which the user optionally supplies as the
first word of his output buffer on write requests and which governs the
automatic insertion of the appropriate esc control characters by the
driver.
On read requests, the driver automatically removes the BSC
control characters from the text stream and constructs the appropriate
MFW which optionally becomes the first word of the user's input buffer.
The INCOUNT and OUTCOUNT parameters of CREAD/CWRITE always includ@ the
MFW, but the MFW is never actually transmitted across the line.
The HSI drIver, on the other hand, does not use an MFW; all data in the
output buffer is transmitted across the line.
Because the user 1s
guaranteed that he Is communicating with another HP computer (3000 or
2100) When he uses the H51, there 1s no need for drivers to
insert/remove special BSC control Characters in/from the text stream.
Hence, there is no MFW interpretation or construction by the HSl
drivers on the 3000 or 2100. Therefore, if the H51 user wants to send
BSC headers or intermediate text blOCKS, he may do it using any
convention that is agreeable to both sender and receiver.
~.10

.-.-_._

C·-~

User Program Compatibility Between SCCP, 5SLC and HSI
~~~-----._------_.

__

---_ .. _-------------

The use of sse as the protocol for both types ot boards means that the
line control mechanism (i.e., state transition) is identical fOr these
devIces.
However, from the above discussion on message formatting, it
is clear that there eXists different message formatting requirements.
If line control and message formatting were identical for both the SSLC
and the H5!, then a given C5 apPlication program could use either
device interchangeably (without even recompiling) by simply Supplying
different :CLINE commands with each execution ot the program.
The desirability of this capability suggests that 3000 users either:
1. Adopt the secp and SSLC asc MFW convention for use With theHSI even
though the HSI drivers on HP 3000 and HP 2100 do not even recognize

an

MFW~

A-12

o

2. Always use an implicit MFW with the SCCP
OOPTIONS in section 4.2).

(

...-..

~

-~

SSLC

asc

(reter

to

If users adopt either of these conventions, their programs will achieve
a higher degree of flexibility.

c

o

and

A-13

o

o



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.6
Linearized                      : No
XMP Toolkit                     : Adobe XMP Core 4.0-c321 44.398116, Tue Aug 04 2009 14:24:30
Modify Date                     : 2013:06:30 22:16:13-07:00
Create Date                     : 2013:06:30 21:52-07:00
Metadata Date                   : 2013:06:30 22:16:13-07:00
Creator Tool                    : Adobe Acrobat 8.3 Combine Files
Format                          : application/pdf
Document ID                     : uuid:05991456-af1c-d443-9e69-b32b71e99e27
Instance ID                     : uuid:414f924a-37e2-4749-a395-c5a5e000b664
Producer                        : Adobe Acrobat 8.31 Paper Capture Plug-in
Page Count                      : 197
Creator                         : Adobe Acrobat 8.3 Combine Files
EXIF Metadata provided by EXIF.tools

Navigation menu