Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.atnf.csiro.au/research/electronics/docs/lba/s2_RT_manual.pdf Дата изменения: Mon Nov 16 08:01:10 1998 Дата индексирования: Tue Dec 25 23:57:08 2007 Кодировка:

The Centre for Research in Earth and Space Technology
A Centre of Excellence funded by a grant from the Ontario Technology Fund and other private, industrial, federal and international sources.

S2-RT User's Manual

Version 3.2 (133XT), September 1998

CRESTech-SGL-TR98-043
Centre for Research Earth and Space Technology Space Geodynamics Laboratory
4850 Keele Street North York, Ontario, Canada M3J 3K1 TEL: (416) 665-5470 FAX: (416) 665-1815 Email: s2support@sgl.crestech.ca Web: http://www.sgl.crestech.ca


S2-RT User's Manual

Table of Contents
1 INTRODUCTION
1.1 S2-RT User Documentation 1.2 S2 Physical Description

1-1
1-1 1-1

1.2.1 Transport Array Module (TAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 1.2.2 Data, Signal and Control Module (DSCM) . . . . . . . . . . . . . . . . . . . . . . . . 1-2

2

INSTALLATION
2.1 Introduction 2.2 Identifying Cable Ports

2-1
2-1 2-3

2.2.1 DSCM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 2.2.2 TAM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

2.3 Cables

2-5

2.3.1 S2 User Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 2.3.2 S2 System Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6

2.4 Power Requirements 2.5 Power cables: 120 Volt Operation 2.6 Power cables: 240 Volt Operation 2.7 External Transformer 2.8 Post-installation Checkout Tests

2-6 2-7 2-7 2-7 2-8

2.8.1 Sy stem Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 2.8.2 Sy stem Signal and Electrical Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 2.8.3 Record/Playback Performance Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8

3 4

OPERATING ENVIRONMENT OPERATION
4.1 Overview 4.2 Console Operation
4.2.1 Connecting the Console . . . . 4.2.2 Display Organization . . . . . . 4.2.3 Console Command Entry . . . 4.2.3.1 Soft-key s . . . . . . . . . . . 4.2.3.2 Command Editing and 4.2.3.3 Batch Files . . . . . . . . . 4.2.4 Basic Procedures . . . . . . . . 4.2.4.1 Recording Tapes . . . . . 4.2.4.2 Playing Back Tapes . . 4.2.5 Sy stem Bootup . . . . . . . . . 4.2.6 ROS Bootup . . . . . . . . . . . 4.2.7 ROS Configuration . . . . . . . ..... ..... ..... ........ History . ........ ..... ........ ........ ..... ..... ..... . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . . . . . .. .. .. . .. .. . . . . . . . . . . . . . . .

3-1 4-1
4-1 4-4
. 4-4 . 4-4 . 4-5 4-5 4-7 4-7 . 4-8 4-8 4-12 4-14 4-14 4-16

4.1.1 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

. . . .

-i-


S2-RT User's Manual

4.2.8 Console 4.2.8.1 4.2.8.2 4.2.8.3 4.2.8.4 4.2.8.5 4.2.8.6 4.2.8.7 4.2.9 Console

Screen Descriptions . . . . . . . . . . . . . . . . . Crucial Parms Window (upper right, Figure 4-1) Status Window (middle right, Figure 4-6) . . . . . . User Parms Window (upper middle, Figure 4-1) . State Window (middle, Figure 4-1) . . . . . . . . . . . . Transport Window (middle left, Figure 4-1). . . . . User I/O Window (upper middle, Figure 4-7) . . . Mark III Window (upper middle, Figure 4-8) . . . Command Descriptions . . . . . . . . . . . . . . .

. . . . . . . . .

. .. .. .. .. .. .. .. .

. . . . . . . . .

. . . . . . .

. . . . . . . . .

. . . . . . . . .

. .. .. .. .. .. .. .. .

. . . . . . . . .

. . . . . . .

. . . . . . . . .

. . . . . . . . .

. .. .. .. .. .. .. .. .

. . . . . . . . .

. . . . . . .

. . . . . . . . .

. . . . . . . . .

. .. .. .. .. .. .. .. .

. . . . . . . . .

4-18 4-18 4-22 4-23 4-24 4-24 4-25 4-27 4-29

4.3 RCL Operation 4.4 Ethernet Usage
4.4.1 Configuring Network Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.4.2 Console access via rlogin/telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.4.3 RCL access via Internet sockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4-58 4-58
4-58 4-60 4-61

4.5 Status Codes and Interpretations 4.6 Power-on Self Test

4-62 4-80

5

TAPE
5.1 Choice of Tape and Tape Speed 5.2 Tape Shipping and Storage

5-1
5-1 5-2

6

MAINTENANCE AND SERVICING
6.1 Troubleshooting Hints 6.2 Software Reloads/Upgrades 6.3 DSCM Electronics Replacement and Servicing 6.4 TAM Servicing
6 6 6 6 6 6 .4 .4 .4 .4 .4 .4 .1 .2 .3 .4 .5 .6 Transport Replacement And Servicing Sy stem Service Calls . . . . . . . . . . Transport Setup For Off-Line Tests . . Transport Write Current Optimization Transport Temperature Calibration . . Transport Tape Guide Adjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6-1
6-1 6-1 6-3 6-5
6-5 6-8 6-8 6-9 6-10 6-12

7

SHIPPING
7.1 Packaging 7.2 Shipping Environment

7-1
7-1 7-2

8

S2 SPECIFICATIONS SUMMARY

8-1 A-1
A-1 A-1

A S2 RCL SERIAL COMMUNICATIONS PROTOCOL
A.1 Overview A.2 General Packet Format

- ii -


S2-RT User's Manual

A.3 Command/Response Summary A.4 Command/Response Formats

A-3 A-5

B S2 SIGNAL AND CONTROL INTERFACE SPECIFICATIONS
B.1 Overview

B-1
B-1

B.1.1 S2 Signal Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1 B.1.2 S2 Control Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

B.2 S2 Signal Interface
B.2.1 Signal B.2.1.1 B.2.1.2 B.2.1.3 B.2.1.4 Assignments . . . . . . . . . . . Signal Characteristics . . . . . . . . Electrical Characteristics . . . . . . Phy sical Characteristics . . . . . . . Input/Output Cable Connection ... .... .... .... Test .... ...... ...... ...... Modes . .. .. .. . . . . . . . . . . . . . . . . . . . . . .. .. .. .. . . . . . . . . . . . . . . . . . . . . .. .. .. .. . . . . . . . . . . . . . . . . . . . . .. .. .. .. . . . . . . . . . . . . . . . . . . . . .. .. .. .. . . . . . . . . .

B-1
. BBBBB1 2 2 2 2

B.3 S2 Control Interface

B-3

B.3.1 RCL Serial Link (C6 Cable) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3 B.3.2 RCC Console Cable (C7 Cable) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3

C SAMPLE ROS DEFAULTS FILE D UNIX TERMCAP FILE FORMAT
D.1 Overview D.2 Types of Capabilities
D.2 D.2 D.2 D.2 D.2 .1 .2 .3 .4 .5 Comments . . . . . . . . Escape Sequence Codes Parameterized Strings . Delays . . . . . . . . . . Similar Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C-1 D-1
D-1 D-2
DDDDD3 3 3 4 5

D.3 Capabilities

D-5

E GLOSSARY BIBLIOGRAPHY INDEX

E-1

- iii -


S2-RT User's Manual

List of Figures
Figure 1-1: Transport Array Module (TAM) Figure 1-2: Data, Signal and Control Module (DSCM) Figure 2-1: S2-RT Configuration, 120VAC Operation Figure 2-2: S2-RT Configuration, 240VAC Operation Figure 2-3: DSCM Ports Figure 2-4: TAM Rack Connector Placement Figure 2-5: DSCM Shipping Box with Cable Assemblies Figure 2-6: 240V to 120V Transformer Figure 2-7: ROS Normal Display on Bootup (RT) Figure 4-1: Sample ROS Screen, User (stopped) Figure 4-2: Sample ROS Screen, User (record) Figure 4-3: Transport Selection based on Mode & Group Figure 4-4: Sample ROS Screen, User (playback) Figure 4-5: S2 Diagnostic Loopback Paths Figure 4-6: Sample ROS Screen, Bad Status Figure 4-7: Sample ROS Screen, User I/O Figure 4-8: Sample ROS Screen, Mark III Figure 6-1: DSCM PC Board Configuration Figure 6-2: Transport/Tape Diagnostics Figure 6-3: Location of Guide Posts Figure 6-4: Proper tape guide adjustment Figure 6-5: End-of-frame distortion example1 Figure 6-6: End-of-frame distortion example2 Figure 6-7: Beginning-of-frame distortion example Figure 6-8: Proper tape guide adjustment, no scope Figure 6-9: End-of-frame distortion example1, no scope Figure 6-10: End-of-frame distortion example2, no scope Figure 6-11: Beginning-of-frame dist. example, no scope Figure 7-1: TAM Shipping Box Figure 7-2: DSCM Shipping Box with Cable Assemblies Figure B-1: C1/C2 Test Vector Generator Logical Circuit Figure B-2: C1 Input Timing Interface (32 MHz clk) Figure B-3: C1 Input Timing Interface (clk = data rate) 1-1 1-2 2-1 2-2 2-3 2-4 2-5 2-7 2-8 4-4 4-8 4-10 4-13 4-19 4-22 4-26 4-28 6-4 6-8 6-13 6-14 6-14 6-14 6-14 6-16 6-16 6-16 6-16 7-1 7-1 B-10 B-11 B-11

- iv -


S2-RT User's Manual

Figure B-4: C2 Output Timing Interface (32 MHz clk) Figure B-5: C2 Output Timing Interface (clk=data rate) Figure B-6: C2 Output Timing Interface (MkIII format) Figure B-7: C1 & C2 Electrical Specifications

B-12 B-12 B-13 B-13

-v-


S2-RT User's Manual

List of Tables
Table 4-1: Console Special Function Keys Table 4-2: Terminal Types Supported by ROS Table 5-1: S2 Approved Tape Types Table 6-1: Maintenance Chart for AG2520 Transports Table B-1: C1 Input Cable Signal Assignments Table B-2: S2 C2a Output Cable Signal Assignments Table B-3: S2 C2b/c Output Cable Signal Assignments Table B-4: MkIII C2a Output Cable Signal Assignments Table B-5: S2 Modes with active C1/C2 signal channels Table B-6: C6 (RCL) Cable Signal Assignments Table B-5: S2 Modes with active C1/C2 signal channels Table B-7: C2a Cable Test Vector Sequence Table B-8: C2b/C2c Cable Test Vector Sequence 4-6 4-15 5-2 6-5 B-4 B-5 B-6 B-7 B-8 B-9 B-9 B-10 B-10

- vi -


S2-RT User's Manual

INTRODUCTION

1. INTRO DUCTION

1.1 S2-RT User Documentation
T he S2-RT User's Manual contains information required by users of the S2 Record Terminal for installation, operation, mai ntena nce a nd servicing of t he sy stem. This ma nual is for S2-RT systems which use a n MVME133XT Recorder Cont rol Computer board. Please note the version number on t he front cover. T his ma nual is accurate only for S2-RT systems running t he matching Recorder Operati ng Sy stem (ROS) softwa re version number. To check which softwa re version you a re using, type version at t he S2 console. For systems runni ng older softwa re (lower version numbers) you should use the appropriate older User's Manual, or upgrade the software. For systems runni ng newer software (higher version numbers) you should check to see if a newer version of t he User's Manual has been issued by CRESTech/SGL. If not, refer to t he release notes for the softwa re version y ou are using; t hey will contai n documentation on additional features. If you have any problems or questions related to t he S2 please call CRESTech/SGL i n Ca nada at (416) 665-5470 or send email to s2support@sgl.crestech.ca . We can be found on t he World Wide Web at http://www.sgl.crestech.ca/ . Up-to-date versions of t his User's Manual a re available at ftp://ftp.sgl.crestech.ca/pub/s2/doc/userman/ for all four S2 sy stem combinations (S2-RT & 162 CPU, S2-PT & 162 CPU, S2-RT & 133XT CPU, S2-PT & 133XT CPU). Note that the t he name CRESTech was formerly ISTS (Institute for Space and Terrestrial Science) until it was cha nged i n late 1997.

1.2 S2 Physical Description

T he S2 consists of up to three Transport Array Modules (TAMs) tape t ransports each, and one Dat Module (DSCM) contai ni ng most of

1.2.1 Transport Array Module (TAM)
T he TAM, shown i n Figure 1-1, consists of one to four S2 tape transports mounted i n a custom rack which is designed either for tabletop operation or which may be mounted i n a 19" rack. T he tra nsports a re supported on sliders which a re mounted to infill brackets within t he rack. T he sliders allow easy removal of each transport, and, with t he use of extension cables, t he operation of t he transport i n an easily-accessible position outside the rack. To lock t he sliders in place for shipping a nd normal operation, a single removable ``slider block'' is used on the left-ha nd side infill bracket.

Part 1: /home/s2/doc/userman/working/txt/intro.txt x modules: one or two contai ning up to four a, Signal a nd Control t he sy stem electronics.
Figure 1-1: Transport Array Module (TAM) 1-1


S2-RT User's Manual

INTRODUCTION

T he TAM racks have two user-removable panels. The front panel is held i n place with four thumbscrews a nd is removed during normal operation. The rear vented cover is also secured by ha nd-removable t humbscrews, but is normally in place when t he unit is operati ng. A fixed rear plate holds all power a nd signal connectors. TAM Dimensions and Weight Each TAM is approximately 40 (H) x 44 (W) x 46 (D) cm a nd weighs about 36 kg wit h four t ra nsports. 10 rack units a re requi red for rack mounti ng.

1.2.2 Data, Signal and Control Module (DSCM)
T he DSCM, shown i n Figure 1-2, contai ns custom S2 electronics required to manage t he sy stem, format and control t he data on record, recover the data on playback and control the transports. T he DSCM is a semicustom VME cage with three standard VME-compatible slots for the sy stem Recorder Cont rol Computer (RCC), Static RAM board (SRAM) and optional Et hernet board, a nd six slots for electronics required to ma nage the data flow, format the data on record, decode the data on playback a nd i nterface to the user's hardware. T hese boards consist of an eight-cha nnel Formatter (FORM) boa rd, single-channel decoder or Data Recovery a nd Deformatter (DRDr) board, a nd a User Interface (UI) board.

Figure 1-2: Data, Signal and Control Module (DSCM)

T he DSCM is designed for tabletop or 19" rack mounting. Rack mounti ng may be made easier by removal of t he two leg mounts screwed to the outside of the enclosure (replace t he screws as they also hold on the fan tray). DSCM Dimensions and Weight T he DSCM is 33 (H) x 44 (W) x 33 (D) cm a nd weighs approximately 15 kg. 7 rack units are requi red for rack mounti ng.

1-2


S2-RT User's Manual

INSTALLATION

2. INS TALLATION

2.1 Introduction
T he S2 recorder normally consists of t hree units requiring intermodule cable hookup as well as connection to external equipment for operation. Figures 2-1 and 2-2 illustrate t he sy stem with all signal a nd power cables connected. To i nstall t he system, please follow t hese steps: 1. Configure the TAMs and DSCM in a 19" rack or on a bench in the desired arra ngement. Please refer to Chapter 3 of this manual to establish envi ronmental constrai nts on system configuration a nd operation. 2. Identify the cables and cable ports (described in t he next two sections).

Part 1: /home/s2/doc/userman/working/txt/install.txt x
Figure 2-1: S2-RT Configuration, 120VAC Operation 2-1


S2-RT User's Manual

INSTALLATION

Figure 2-2: S2-RT Configuration, 240VAC Operation

3. Connect the cables as shown in Figure 2-1 for 120 VAC operation a nd Figure 2-2 for 240 VAC operation. Note that the DSCM power input port accepts either 120 VAC or 240 VAC, but t he TAM power inputs accept 120VAC only. Operation of t he TAMs from a 240 VAC power source t herefore requires 240 VAC to 120 VAC voltage conversion, shown in Figure 2-2 as a sepa rate t ransformer. 4. Connect a console terminal such as DEC VT100 to t he console port (C7). T he termi nal should be configured for 9600 baud, 8 data bits, one stop bit, no parity. An IBM PC or compatible computer can be used as a console by runni ng t he ROSCO terminal emulator program supplied with t he S2 (see Section 6.2 for more i nformation on ROSCO). 5. Power on t he sy stem a nd a nswer t he i nstallation questions which appear on the console (fi rst time sy stem turned on only). See Section 4.2.6 for more i nformation on t he i nstallation questions. 6. Perform t he post-i nstallation checkout tests as described i n Section 2.8.

2-2


S2-RT User's Manual

INSTALLATION

2.2 Identifying Cable Ports
2.2.1 DSCM Ports
Figure 2-3 illustrates the cable ports on the front panels of the DSCM circuit boa rds. T hese a re: RCC Console Port: Ethernet Port: T his port connects the RCC to a console terminal via t he C7 serial cable. It is a female DB-25 connector configured as RS-232C DCE (Data Communications Equipment). (Optional) BNC connector for thin Et hernet, or female DB-15 connector for Ethernet transceiver. These ports a re not both active simulta neously; t he chip i n socket U4 of the Ethernet board must be moved to the adjacent socket U3, or vice versa, to enable the ot her Ethernet connector. The factory default setti ng is for the BNC (coaxial) connector to be enabled. T his DB-9 pi n port is t he DSCM input for the C5 Tra nsport Cont rol Link (TCL) connecti ng t he DSCM and TAM. T his port is the DSCM i nput for the C6 Radioastronomy Cont rol Link (RCL). It is a male DB-25 connector configured as RS-232C DTE (Data Termi nal Equipment).
Formatter: FORM TCL (C5) port RCC: MVM E 133X T SRA M Data Recov ery /Deformatter: DRDr User Interface: UI C2b port

TCL Port: RCL Port:

Ethernet: ENP-10TL

C2a port

Ethernet port Console (C7) port RCL (C6) port

C3 port C4 port

C1 port

Figure 2-3: DSCM Ports

2-3


S2-RT User's Manual

INSTALLATION

C1 Port: C2a Port:

T his port originates the C1 cable from the data source to t he DSCM, bringing clock, data a nd 1 Hz to the User Interface. T his port origi nates the C2a cable from the DSCM, bringing clock, data a nd 1 Hz from t he User Interface to the user data destination; it also carries optional clock a nd 1Hz from t he user data desti nation to the User Interface. T his port origi nates the C2b cable from t he DSCM, bringing data validity from t he User Interface to the user data destination; this cable carries validity appropriate for 8-cha nnel 1 or 2-bit quantized data from t he S2 to the user. T his port origi nates t he C2c cable from t he DSCM, bri nging data validity from t he User Interface to the user data desti nation; this cable carries validity appropriate to the odd channels of 16 independent 1-bit quantized baseba nd channels. Note t hat the C2c port is not accessible from t he UI front panel, but is available from a straight dual-row header near the front a nd center of t he UI board itself. T his port originates t he C3 cable from t he DSCM, bri ngi ng clock a nd data from t he DSCM Formatter to t he TAMs. T his port originates the C4 cable from the DSCM, returni ng signal from t he TAMs to t he DSCM Data Recovery module a nd bringing ±5 V from the DSCM to the custom transport electronics.

C2b Port:

C2c Port:

C3 Port: C4 Port:

C5 port

C3 port

C4 port

120VAC OUTPUT

TAM RA CK POWER S WITCH

120VAC INPUT

Figure 2-4: TAM Rack Connector Placement

2.2.2 TAM Ports
Figure 2-4 illustrates the cable ports on the fixed back pa nel of t he TAM. T hese a re: C3 Port: T his port termi nates t he C3 cable from t he DSCM, bri nging clock and data from the DSCM Formatter to t he TAM.

2-4


S2-RT User's Manual

INSTALLATION

Figure 2-5: DSCM Shipping Box with Cable Assemblies

C4 Port:

T his port termi nates the C4 cable from the DSCM, returni ng signal from t he TAM to t he DSCM Data Recovery module a nd supplyi ng ±5 V from the DSCM to the TAM custom electronics. T his port termi nates the serial Tra nsport Cont rol Link (TCL) cable from the DSCM. T his port supplies power to t he TAM, and i ncludes a connector for feed t hrough power to a second TAM. T his port is rated for 120 volts (50-60 Hz) only.

C5 Port: Power In/Out:

2.3 Cables
Figure 2-5 shows t he S2 cable assemblies as shipped i n the DSCM container. They consist of S2-to-user I/O cables for tra nsfer of signals a nd power to a nd from t he user and S2 sy stem cables linking S2 modules. Connect t he cable assemblies as shown in Figure 2-1 or 2-2. See Appendix B for detailed pin assignments, timi ng a nd electrical specifications.

2.3.1 S2 User Cables
C1: T his cable consists of a 50 conductor twisted pai r ribbon cable (maximum length = 10 m) carrying user data, clock a nd 1 Hz signals from t he user data source to the S2.

2-5


S2-RT User's Manual

INSTALLATION

C2a: C2b:

T his cable consists of a 50 conductor twisted pai r ribbon cable (maximum length = 10 m) carrying recovered data, clock and 1 Hz from the S2 to t he user. T his cable consists of a 20 conductor twisted pai r ribbon cable (maximum length = 10 m) carrying recovered data validity for 1 or 2-bit qua ntized data (carries only even user channels for 1-bit data). T his cable consists of a 20 conductor twisted pai r ribbon cable (maximum length = 10 m) carrying recovered data validity for t he odd user channels in t he case of 1-bit quantized data. It is needed only for 1-bit qua ntized modes that use odd user data cha nnels. Note that t he C2c cable is not accessible from the UI front panel, but is available from a straight dual-row header near t he front a nd center of the UI board itself (this header is unlabeled). T he C2c header is pola rized to accept only the wider end of the physical C2c cable assembly. T he blank panel on the right-hand side of the UI must be removed to i nstall t his cable. T his cable, also known as the Radioastronomy Cont rol Link (RCL), is a serial cable connecti ng t he S2 to a n external control computer. The S2 RCL port is configured for DTE operation, so the C6 cable needs to be a null cable (excha nge pins 2 and 3) if the external computer is also acti ng as DTE. T his is t he case for IBM PCs a nd compatibles. The external computer should be configured for 19200 baud, 8 data bits, one stop bit, no parity. T he RCL baud rate can be set up to 57,600 by editi ng the sy stem defaults file (see Section 4.2.7). T his cable is a serial cable connecti ng t he S2 is configured for DCE operation. The terminal bits, one stop bit, no parity. T he console baud defaults file, but the maximum allowed rate is to a console termi nal. The S2 console port should be configured for 9600 baud, 8 data rate can be changed by editing t he system 9600 baud.

C2c:

C6:

C7:

2.3.2 S2 System Cables
C3: C3 is a 50 ohm ribbon cable transporti ng clock a nd formatted data from the DSCM to t he TAMs. The cable is terminated via a single connector at t he DSCM FORM board, a nd is split i n t he middle to allow the cable to service two TAMs. C4 is a 50 ohm ribbon cable t ransporting return signal from t he TAMs to the DSCM. T he cable is terminated via a single connector at the DSCM DRD board, and is split i n t he middle to allow the signals to come from two TAMs. C5, the Transport Cont rol Link (TCL), is a serial cable connecting t he TAMs and t he DSCM.

C4:

C5:

N O TE: Insertion key s are present on the C3 and C4 cables to prev ent accidental interchange as this may result in damage. It i s recommended that the C3 and C4 cables be inserted with the power off if poss ible. If power must remain on ex erc ise care and do not force the connectors.

2.4 Power Requirements
Total S2-RT power requirements a re 440 W: 160 W for the DSCM and 140 W for each of t he TAMs. At least 700 VA should be available in order to supply sufficient current when the tra nsports are most active, which normally occurs when tape is loaded onto t he t ransport scanner.

2-6


S2-RT User's Manual

INSTALLATION

2.5 Power cables: 120 Volt Operation
T he S2 units may be powered from a ny standard 120VAC wall outlet capable of supplyi ng t he total current requirements of the S2. T he sy stem is supplied with t hree power cords; t he recommended power cord a rra ngement is shown i n Figure 2-1.

2.6 Power cables: 240 Volt Operation
For operation from a 240 VAC power source, an external 2:1 t ra nsformer must be used to supply the TAMs with 120 VAC, as i ndicated i n Figure 2-2. T he DSCM contains a n auto-ra ngi ng power supply and may be powered directly wit h 240V as shown. The DSCM is supplied with a n incomplete power cable to which a suitable plug can be attached. Colour coding of these cables is as follows: Brown (or Black) - AC Line Blue (or White) - AC Neutral Green - Chassis Ground

2.7 External Transformer
A schematic for a 240/120 VAC t ransformer circuit is shown i n Figure 2-6. It consists of a 500 VA 2:1 t ransformer. T he 240 volt supply current is limited by a 3 A slow-blow fuse. The 120 volt output current is limited by a 4 A fuse.

Note: Transformer should be used to power one S2 ( i.e. two TAM racks) only. Both TAM racks together require a supply of about 400 VA peak.

Figure 2-6: 240V to 120V Transformer

2-7


S2-RT User's Manual

INSTALLATION

Figure 2-7: ROS Nor mal Display on Bootup (RT)

2.8 Post-installation Checkout Tests
Following transportation of the S2, built-in test facilities may be used to verify t he functionality of the system prior to connection wit h any external ha rdwa re other t han a console termi nal.

2.8.1 System Setup
Before testi ng, the sy stem should be set up according to the installation i nstructions earlier in t his chapter. No cables a re to be connected to t he C1 or C2 signal ports. The console termi nal should be configured for 9600 baud, 8 data bits, one stop bit, no parity.

2.8.2 System Signal and Electrical Test
Power up the sy stem. A self-test executes as part of t he bootup and should take about one minute to complete (y ou may fi rst be asked to enter your console terminal type and baud rate). Verify that the console display followi ng t he self-test is as shown in Figure 2-7 (there may be mi nor differences, such as ``no tape'' in the Transport wi ndow). Verify that the time in t he upper right corner of the screen is i ncrementi ng and t hat t here are no detected faults displayed in the status wi ndow (middle right). Failure of the power-on self-test causes the test to terminate a nd print a descriptive message to t he console interaction wi ndow. T he status wi ndow will indicate ``Diagnostic test failed'' with a positive numeric diagnostic code or negative error code.

2.8.3 Record/Playback Performance Test
T his test allows users to verify t hat t he S2 is functioning as specified, i.e. t hat data is recorded and reproduced at a specified bit-error rate of less than 1 x 10-4 (speed LP) or 1 x 10-3 (speed SLP, average) on i ntercha nge.

2-8


S2-RT User's Manual

INSTALLATION

For speed SLP (which must be used on sy stems with AG2550 transports) users should check that the record/play back performance test gives a bit-error rate of less than 1 x 10-3 averaged across eight t ra nsports, or 3 x 10-3 i ndividually. Success of this test verifies t hat t he record a nd playback signal sy stems a re operati ng according to specification a nd t hat the mecha nical alignment of the tra nsports has not been disturbed during shipping. The time required to complete t he test is about 90 mi nutes. Before sta rting t he record/playback test, i nsert writable tapes into all eight kind of tape can be used in t he S2 please refer to Chapter 5. You should correct and matches t he type of tape you a re using for the test by enteri ng tapetype N default where N is one of the tape type codes given in Chapter 5. T hen run t he berslp.tst for speed SLP by ty pi ng one of t he following commands batch berlp.tst batch berslp.tst T he batch file sets up the sy stem as follows: · S2 mo de set to 16x8-1
· ·

t ransports. For i nformation on what ensure that t he tape type setti ng is the comma nd batch file berlp.tst for speed LP or

Sy stem Clock PLL mode set to xtal formatter diagnostic sequence on

T he batch file then records a pseudo-ra ndom test data sequence for 30 minutes. Following the recordi ng the tapes a re rewound and played back, a nd bit-error rate measurements are made on each of the eight tape cha nnels. These measurements along wit h any detected status errors are recorded i n the S2 internal log file. When play back is complete, any status errors recorded in the log file duri ng t he record or playback phases a re display ed. You will be prompted to press return, then the accumulated bit-error rates for three mi nutes per cha nnel of playback data a re displayed. T here will be 8 li nes of output of t he form 0022 E 189-12:15:23 174-10:51:31 1.23e-5 0 0 11520 T he fourt h column from the right shows the bit-error rate, followed by t he data channel nu number. Verify t hat t he error rate is less tha n 1.0e-4 for each transport if LP speed was us file). If SLP speed was used (berslp.tst batch file) verify that t he error rate is less t ha n 3.0e-3 t ra nsport and that the average over all 8 transports is less tha n 1.0e-3. Not all 8 output lines once so you will have to press return. It is a good idea to write down t hese bit-error rate reference. mber a nd transport ed (berlp.tst batch for each individual fit on t he screen at numbers for future

In order to test tape i nterchange, eject the tapes a nd rotate them by one position, i.e. the tape recorded in transport 0 is i nserted i nto t ransport 1, the tape recorded in t ransport 1 is inserted into tra nsport 2, and so on (the tape recorded i n tra nsport 7 is i nserted i nto t ransport 0). T hen run t he batch file inter.tst by typing the comma nd batch inter.tst. T his batch file rewinds the tapes and repeats the playback phase of the berlp.tst/berslp.tst batch file. As above, verify that the error rate displayed for each channel a nd/or average is less tha n the specified value. Failure to achieve specified performance may call for particular t ransports or other system components to be serviced; see Chapter 6 for maintenance information. In particular, poor performa nce in this test may i ndicate a misalignment of t he t ransport tape guide posts (Section 6.4.6).

2-9


S2-RT User's Manual

OPERATING ENVIRONMENT

3. OPERATING ENVIRONMENT
Temperature and Humidity

Temperature Range: For tra nsport operation in TAM rack: For specified performance: Rate of Temperature Variation: Relative Humidity: +10 degrees to +30 degrees Celsius +15 degrees to +25 degrees Celsius
1 1

Particulate Contamination

1

This refers to the ambient temperature around the TAM rack. If the TAMs are mounted in a 19" rack or other enclosed space, ventilation must be provided to ensure that this condition is met. Temperature around each transport should be within +10 to +40 deg. C. Temperature inside each transport must be within +5 to +60 deg. C or else thermal shutdown software will be triggered.

Part 1: /home/s2/doc/userman/working/txt/environ.txt x Not more than 1 degree Celsius per minute, a nd not more t han 10 degrees Celsius per 30 mi nutes 35% to 80% non-condensing Particle size, µm < 1.0 1.0 to 1.5 1.5 to 5.0 5.0 to 10 > 10 Particle count/m3 4 x 107 4 x 106 4 x 105 4 x 10 4 x 10
4 3

3-1


S2-RT User's Manual

OPERATION

4. OPERATIO N

4.1 Overview
T his chapter describes how to operate a summary of basic operational proce console comma nds follow i n Sections i nformation is in Section 4.4, a nd all the S2 Record Terminal. After some preliminary i nformation and definitions, dures is given i n Section 4.2.4. Detailed descriptions of screen displays a nd 4.2.8 a nd 4.2.9, using more of a reference-ma nual format. Ethernet network S2 status codes a re listed a nd described i n detail in Section 4.5.

T he S2 Recorder can be operated using either one of two alternative i nterfaces: t he console termi nal, or t he Radioastronomy Cont rol Link (RCL). Bot h of t hese can use RS-232C serial li nks, but t he RCL can operate as an RS-485 multi-drop li nk with the addition of a n external conversion box, allowi ng more than one device to be cont rolled from the same serial port. On S2 sy stems equipped wit h an Et hernet board, console and RCL connections can be made using network rlogin/telnet a nd socket protocols, elimi nating the need for serial cables. T he console a nd t he RCL may be used at t he same time as long as operations don't i nterfere -- for example the console display can be used to monitor what is happening when the S2 is under automatic control via t he RCL. T he console allows high-level ma nual cont rol of t he S2 for regula r operation, plus low-level access for testi ng a nd other unusual operati ng conditions. Any cursor-addressable terminal or terminal emulator, such as DEC VT100, can be used as a console (a VT100 emulator program for IBM PCs a nd compatibles called ROSCO is supplied with t he S2). T he console display is divided i nto multiple windows which are conti nuously updated. Comma nd ent ry is aided by a soft-key sy stem which uses function key s a nd command completion to make comma nds faster to type a nd easier to remember. T here are approximately 50 console comma nds, of which only about 10 a re needed for everyday operation. All of Section 4.2 is written from t he poi nt of view of console operation (the bulk of t his chapter), but most of t he pri nciples described can be applied to RCL operation as well. T he Radioastronomy Cont rol Link (RCL) is intended for automatic control of devices by a n external computer. It can be used for unattended automatic operation following a n observing schedule runni ng on the external computer. For example, the Mark IV Field System (PCFS) version 9.3.7 a nd later incorporates full support for cont rolli ng a n S2 recorder over t he RCL i n conjunction with Mark III, Mark IV, or VLBA data acquisition systems. Future versions of PCFS will also be able to cont rol S2 Data Acquisition Sy stems over the RCL. The RCL uses a reliable bina ry packet protocol to communicate requests from t he external computer to the S2 a nd return responses. Source code for t he packet assembly a nd disassembly routi nes needed to run on the external computer is provided with t he S2 sy stem, so the application programmer deals only wit h a simple function-call interface, a nd does not need to worry about t he details of t he RCL protocol. T he RCL interface libra ry routi nes are written i n ANSI C a nd should be easy to port to many different types of computers. As shipped t hey work on IBM PCs and compatibles, or on t he followi ng flavours of Unix: SunOS, Sola ris, a nd Linux. The commands available over the RCL a re a subset of t he console commands, a nd a re intended mainly for high-level control during automated operation. T he RCL t ries to present a view of t he S2 as a single tape recorder -- not 8 i ndividual transports. Consequently, most comma nds a nd responses make no mention of i ndividual t ra nsports. Section 4.3 gives some additional general i nformation on RCL operation, but most of the detailed information is in Appendix A, t he RCL protocol specification.

4.1.1 Terminology
Because so ma ny different ki nds of cont rol a nd status information a re processed by t he S2 software and ha rdwa re, it is necessary to use very precise termi nology when describing thi ngs. Words t hat a re normally used imprecisely a nd interchangeably have been given concrete definitions i n t he context of t he S2 Recorder.

Part 1: /home/s2/doc/userman/working/txt/op.txt x
4-1


S2-RT User's Manual

OPERATION

``Cha nnel''

Channels a re signal pat hs carryi ng sampled data. An important distinction is made between user channels and internal S2 channels. User cha nnels carry data as supplied by t he user at one of several different data rates, wit h up to 16 user channels available depending on t he current S2 mode. 2-bit qua ntized data occupies 2 user channels (bit streams), a nd is generally treated like two channels of 1-bit quantized data except that during playback only one Data Validity signal is used for both sign and magnitude. Internal S2 channels carry data at a fixed rate of 16 Mbits/s (or slightly higher when t he data includes format overhead). There a re 8 i nternal channels (one per t ra nsport) for a total of 128 Mbits/s. T he mode describes t he current user data rate and cha nnel allocation of t he S2. It is sometimes called ``observi ng mode'' or ``recorder mode''. Each mode has a specific number a nd a rra ngement of active user data channels at a data rate of 4, 8, 16, or 32 Mbits/s per cha nnel. The product of t he number of channels a nd t he cha nnel data rate gives t he total system data rate, which can be anywhere from 16 to 128 Mbits/s i n multiples of 16 Mbits/s. Dividing t he total data rate by 16 gives t he number of transports needed for operation i n a particular mode. In addition to regular observing modes, there are a number of test modes for checki ng C1/C2 cable connectivity and general sy stem operation. In modes that require less t han 8 t ransports, the active t ra nsports a re normally selected i n order sta rting at 0. For example, i n a mode requiring 4 t ra nsports, transports 0­3 would be selected. T his group of t ra nsports is called ``group 0''. Other group numbers can be specified, t hus selecti ng a different set of t ra nsports. For example, group 1 would be t ransports 4­7. In this case t here a re just two groups (0 and 1), but in modes wit h lower total data rates t here may be 4 or even 8 groups (see Figure 4-3, Page 4-10). Together t he mode and group number determine which t ra nsports a re selected for use. T his refers to the tape motion state of the S2. T here are 11 states, the first 7 of which will be commonly encountered i n everyday use: Record, Play, Position, Rewind, Fast-Forward, Stop, No-Tape (tapes ejected), Play -Pause, Record-Pause, Cue, Review. T he S2's overall tape motion state is derived from the individual states of the currently selected tra nsports. Under unusual circumsta nces it is possible t hat the i ndividual transport states cannot be clearly summarized, i n which case t he overall state is considered inconsistent. T his describes the current internal diagnostic signal pat h configuration of t he S2 Recorder. The setup is normally selected automatically by t he S2 softwa re, but can be ma nually specified using t he console setup command when the S2 is i n ma nual playback or record. T he setup determines which of several i nternal diagnostic loopback pat hs is currently active (play, record, bypass, ahook, or dhook -- see Figure 4-5 on Page 4-19), and which of the 8 transports is selected for diagnostic monitoring. In a n S2-RT only one decoder (Data-Recovery Deformatter) is available so t his must be switched among the active transports for complete diagnostic coverage. Even in a n S2-PT wit h 8 decoders there is only one diagnostic signal path because of ot her ha rdwa re a nd softwa re design factors. The setup also cont rols whether the sy stem timing is set for playback or record. Playback timi ng is used when playback data from t he transports is being decoded (play), a nd record timing is used at all other times (bypass, record, ahook, dhook). The setup used when t he S2 is stopped (or rewi ndi ng, etc.) is known as the stop setup and is t reated specially in that it is va riable. The stop setup is normally bypass on an S2-RT and play on an S2-PT. T his ensures t hat the sy stem timi ng does not get disturbed unnecessarily when going between play/ record a nd stop, which may be desirable if external sy stems a re locked to the output 1 Hz tick. T his term refers to all other hardware switch settings (and most softwa re switch setti ngs) besides setup.

``Mode''

``Group''

``State''

``Setup''

``Configuration''

4-2


S2-RT User's Manual

OPERATION

``Error''

All commands and actions have a n associated error return code which describes t he success or failure of t he pa rticula r operation. E rror codes a re negative numbers i n t he range -1 to -128, each associated wit h a mnemonic a nd a one-li ne text description. Normally only t he text description is shown, but in certai n cases where t here is not enough room to display the message the numeric code is used. Error codes can be manually tra nslated to t he appropriate message wit h the console error decode command, or t he RCL ERROR_DECODE command. For a complete list of error codes see Page A-32. T he S2 softwa re continuously gathers and reports status i nformation which describes the overall health and operational condition of the sy stem. On the console, t his information is displayed i n the 3-line status wi ndow to t he right of the center of the screen. Over the RCL, it is obtained via t he STATUS comma nd and is t he pri ncipal method of monitori ng sy stem activity. Status is distinct from errors i n that it represents conditions that arise after a comma nd has executed or result from interactions between multiple comma nds, so that error returns cannot be used to convey t he necessary i nformation. It is sometimes called ``onli ne status'' to emphasize t hat it is gat hered continuously and not t he result of a specific diagnostic test or procedure. Status codes are positive numbers in t he range 1 to 127, each associated wit h a m nemonic a nd a text description. T he console status decode command or RCL STATUS_DECODE command can be used to translate a status code to its correspondi ng text message. Three status severity levels a re defi ned: informational, error, a nd fatal error. In addition, status codes representing t ra nsient or instanta neous conditions a re classified as clear-on-read, meani ng t hat t hey a re no longer relevant after they have been read. Each status code has a ``short'' a nd a ``long'' version of t he message. The short message is limited to 34 characters a nd is typically used on t he console. The long message is limited to 399 characters (but is usually shorter) and is typically used on the RCL. For a complete listi ng a nd expla nation of all status codes see Section 4.5. T he S2 software has certai n diagnostic sequences, such as t he power-on self-test, which evaluate sy stem functionality and whose primary result is a single numeric code. T his code either i ndicates that the diagnostic test passed (DIAG_OK) or that it failed, wit h t he code number indicating t he type of failure. Diagnostic codes a re positive numbers in the range 1 to 255 and each is associated wit h a m nemonic a nd a text description. The console diag decode command can be used to translate a code to its corresponding text message. When a diagnostic code appears as pa rt of a status message, the diagnostic message is i ncluded in the long-form status message from status decode.

``Status''

``Diagnostic''

4-3


S2-RT User's Manual

OPERATION

Figure 4-1: Sample ROS Screen, User (stopped)

4.2 Console Operation
T he followi ng sections describe operation of the S2 Recorder using the console. General information and procedures a re given first, and should be read carefully when first learni ng about the S2. Detailed descriptions of screen displays and console comma nds follow in Sections 4.2.8 and 4.2.9.

4.2.1 Connecting the Console
T he S2 console port is wired as a DCE (Data Communication Equipment) device a nd should be connected to a DTE (Data Terminal Equipment) device. Any cursor-addressable terminal or termi nal emulator, such as DEC VT100, can be used. For i nformation on setting the terminal type a nd baud rate when fi rst getti ng sta rted, see Section 4.2.6. On S2 sy stems that have a n Et hernet board it is possible to connect to the console over t he network using rlogin or telnet, alt hough a regula r terminal is still required for i nitial configuration t he first time you turn on the S2 (see Section 4.4.2).

4.2.2 Display Organization
T he console display is normally divided into 8 different regions or windows (see Figure 4-1). The large a rea at t he bottom of t he display is t he interaction window, which shows user commands as t hey are being typed. T he wi ndow contents scroll up a nd off t he top in t he usual manner. T he line at the very bottom of the screen contains eight soft-keys. T hese correspond to function key s f1 t hrough f8 on terminals which have function keys, and show t he current comma nd a nd pa rameter alternatives at any time when typing a command. The remaini ng console wi ndows contain information in various categories and are continuously updated at a rate of once per second. T hese wi ndows are described in general here -- for detailed i nformation refer to Section 4.2.8. At the upper right-hand corner of t he display is the Crucial Parms wi ndow. It contai ns important parameters such as t he sy stem time a nd channelization mode, a nd va rious results from the decoder (DRD). Below the Crucial Parms wi ndow, to the right of t he middle of the screen, is the Status window. It contai ns one-line messages describi ng overall sy stem healt h. T he word FAIL appears highlighted on t he bottom window boundary if any fatal error conditions exist, providing a single OK/FAIL indication for the enti re sy stem (the green front-pa nel LED also

4-4


S2-RT User's Manual

OPERATION

acts as a n overall OK/FAIL indicator when set to OK mode, i.e. when not bli nki ng). Alt hough t here is room for only 3 messages i n t he wi ndow, status conditions a re ra nked by importa nce so t hat t he most relevant i nformation is usually at t he top. If necessary, you can page t hrough t he status i nformation wit h the status pagedn and status pageup commands, or use t he entire screen for the status display with status display fullscreen. T he wi ndow at t he upper middle of the screen is the User Parms wi ndow. It shows user-specified operational parameters such as the tape speed, t he tape ID, the current tape position, a nd other tape information. All of these parameters except tape position cha nge dependi ng on whether t he S2 is in record or playback. During record (or when t he S2 is stopped), t he information shown describes what is being (or would be) recorded on tape. Duri ng play back, t he User Parms window shows information as ext racted from tape. The a rea of the screen normally occupied by t he User Parms window can be switched to show several other display s, mostly contai ning diagnostic i nformation. T he alternate display of most interest to regula r users is the User I/O window, selected by typing userio. It gives details about the current input/output interface configuration, includi ng exactly which user data cha nnels a re active a nd what sy stem clocking options a re currently in effect. Below the User Parms window, i n t he middle of the screen, is a small wi ndow which i ndicates the current overall tape motion state of the S2. Highlighted sy mbols a re used to indicate whether t he S2 is stopped, recordi ng, rewinding, etc. This state i ndication is a summa ry of the states of the i ndividual transports shown in t he tra nsport wi ndow to t he left of the middle of the screen. Duri ng tape positioning t he word ``POSITIONING'' will appear on t he bottom boundary of the state wi ndow. If the state is play back a nd the tapes are aligned, t he word ``ALIGNED'' will appear. The Transport wi ndow shows the state of each t ransport i n t he system. An asterisk (`*') ma rks t hose t ransports selected for use under t he current mode a nd group setti ngs. Duri ng record and playback, a n `L' i ndicates t hat t he t ra nsport head drum servo is properly locked to t he sy stem timing reference. If a transport is playi ng a nd locked, a nd the decoder has been able to extract play back tape time, t hen t he tape time is shown. If the decoder is switched away to some other t ransport, t he tape time will fly wheel indefi nitely as long as servo lock a nd certain other conditions a re maintai ned. To ensure that t he time shown is correct a nd up-to-date, all active tra nsports are continuously scanned during regular (automatic) playback. In addition to t ra nsport state and tape time, the Transport wi ndow can be switched to show ma ny other parameters related to t he transports or extracted from tape duri ng play back (see Page 4-24). If t he system status i ndicates one or more t ra nsport failure conditions, affected t ransports a re marked wit h a highlighted `F' on t he right-ha nd boundary of t he Tra nsport window. T he last window is a small one cha nges each time the screen is t he console terminal is properly below t he activity i ndicator (set in t he top-left corner of the screen . Its main feature is a n activity indicator that updated. This can be used to check that t he S2 softwa re is still running a nd that connected. The station number, when non-zero, is shown i n t his wi ndow just it with the station command).

4.2.3 Console Command Entry
S2 console commands follow the conventional format of a comma nd word followed by parameters. However, several productivity enhancement features are provided to make commands quicker a nd easier to enter. These features i nclude soft-key s, comma nd completion, i nput-line editi ng, comma nd history, a nd batch files.

4.2.3.1 Soft-keys
At a ny poi nt while typing a command, the current key word a nd pa rameter alternatives are shown in the 8 soft-key labels at the bottom of t he display. Key words a re shown i n lower-case, a nd can be entered i n one step simply by pressing t he function key (f1­f8) corresponding to t he soft-key position. If you choose to type t he keyword, after each letter only t hose key words which match what has been typed so far will remain on t he display. When only one remains, pressing t he space bar or tab key will complete it. In addition to keywords, numeric and stri ng

4-5


S2-RT User's Manual

OPERATION

parameters appear i n the soft-key display as ``NUM'' a nd ``STR'' (or sometimes ``NNN'' and ``SSS''). Most such parameters i nclude a word i n a ngle brackets that describes the qua ntity to be entered, e.g. ``NUM'' i ndicates a year number. Whenever there are more t ha n 8 possibilities, soft-key 8 will show ``--ETC--'', indicating that furt her alternatives can be obtai ned by pressing function key f8. If there is a sy ntax error a nywhere i n t he command t he soft-key display will show ``**ERR**''. When a comma nd is potentially fi nished, ``-DONE-'' will be shown in one of t he soft-keys. Unless ``-DONE-'' appears, it is not possible to press return to execute the comma nd. Because of the command completion feature provided by t he soft-key sy stem, it has not been necessary to shorten or abbreviate commands to make t hem easier to type. In fact, commands a re often longer t ha n necessary to make t hem more descriptive. The soft-key labels are limited to 7 cha racters so occasionally a keyword will be truncated to fit on t he display. To see t he hidden part, press function key f10 (or Cntl-G) repeatedly a nd all over-length soft-key s will scroll to t he left. On some terminals there may be too few function key s, or t he function keys may not work. In this case a simple work-around is provided: press escape followed by a number from 0 to 9 to simulate pressing t he corresponding function key (esc-0 is function key f10). If desired, almost all commands can be entered using function key s a nd numbers alone. When expert mode is off (expert off), non-essential a nd diagnostic comma nds not needed for regular S2 operation do not appear i n t he softkey display and cannot be entered. This is useful to reduce confusion when first learni ng about the S2 or to prevent i nappropriate commands from being used duri ng regular operation.

Key
Backspace Cntl-H or Del f1 ­ f8 f9 or Cntl-X f10 or Cntl-G Esc 1­9, 0 Tab or Space Cntl-P Cntl-N Cntl-B Cntl-F Esc Esc Cntl-A Cntl-E Cntl- W Cntl-T Cntl-L Cntl-C Cntl-_

Operation
Delete character to the left of cursor Enter softkey Delete previous word Scroll long softkeys to the left Simulate pressing f1­f9, f10 Complete command Cursor up (Previous history) Cursor down (Next history) Cursor left (Backward) Cursor right (Forward) Clear entire line Move to beginning of line Move to end of line Delete to beginning of line Toggle insert mode Re-draw entire screen Interrupt current operation Re-boot the system

termcap code
kb k1 ­ k8 k9 k0

ku kd kl kr kD

Delete or Cntl-D Delete character under cursor

Table 4-1: Console Special Function Keys

4-6


S2-RT User's Manual

OPERATION

4.2.3.2 Command Editing and History
T he S2 comma nd-line editi ng a nd history features a re similar to the Unix tcsh a nd MSDOS 4DOS programs. Commands can be edited as you type t hem, or you can recall any of the last 100 commands a nd edit or re-enter t hem. Use the left/right cursor keys to move a round wit hin a command, a nd the up/down cursor key s to move a round wit hi n the comma nd history. Characters ty ped are inserted at the current cursor position, and t he backspace key removes t he character to t he left of t he cursor. The f9 key (or Cntl-X) deletes the previous word, and pressing escape twice i n a row clears t he entire li ne. You can search for specific comma nds by typing t he first few letters of the command and then moving up or down in the history. The Cntl-B/Cntl-F and Cntl-P/Cntl-N key s are alternate cursor cont rols for terminals wit hout proper cursor key s. Refer to Table 4-1 for a complete list of special function key s. Re-drawing the Screen Sometimes the display may become garbled because of lost characters or other problems wit h the terminal. Since only screen a reas t hat change are normally updated, this condition will not fix itself, so press Cntl-L to re-draw t he enti re screen.

4.2.3.3 Batch Files
Batch files a re lists of console commands prepared i n advance and then executed using t he batch command. T hey can be created by capturing a sequence of console comma nds (batch log) or from scratch using a built-in full-screen editor similar to t he Unix vi editor (batch edit). T he S2 stores batch files i n non-volatile SRAM memory, so they will not be lost when the power is turned off. Some console commands a re meant exclusively for use wit hin batch files, such as sleep which performs absolute or relative time delays and echo which writes messages to t he screen or waits for the user to press return (echo prompt). Batch files can be chai ned (but not nested) simply by executing one from wit hi n another. A variation on t his is to make a batch file loop conti nuously by calling itself. Batch files can be interrupted at any time by pressing Cntl-C once. For more information, see t he description of t he batch comma nd on page 4-31.

4-7


S2-RT User's Manual

OPERATION

Figure 4-2: Sample ROS Screen, User (record)

4.2.4 Basic Procedures
Although t here a re many possible commands, only a few of t hem a re actually needed for everyday S2 operation. T his section outlines the comma nds a nd procedures that will ty pically be used during regular operation of a n S2 Record Termi nal to record a nd/or play back tapes. It is written from t he poi nt of view of the console, but can easily be applied to the RCL as well. When fi rst learni ng to use the S2 we recommended that you turn off ``expert'' mode by typing expert off. T his hides low-level diagnostic commands that may cause confusion. To see an actual demonstration of a record a nd playback procedure, run the S2-RT demo batch file as follows: First place 8 scratch tapes in t he t ransports, then ty pe batch demo.rt. T he demo will not work on S2 systems wit h fewer than 8 transports.

4.2.4.1 Recording Tapes
Maki ng a recording i nvolves the followi ng basic steps: 1. Set t he time 2. Set t he recorder mode and group 3. E nter t he Tape ID and other user-defined i nformation fields 4. Set t he tape speed (if different from t he default, AG2530 a nd earlier only) 5. Set t he tape type (if different from the default) 6. Start recording Each of the above steps is described in detail below. Figure 4-2 shows what the console display might look like duri ng record. For information on what kind of tape can be used i n the S2 please refer to Chapter 5.

4-8


S2-RT User's Manual

OPERATION

Time Setting Before making a recording, the S2 sy stem time must be set, typically to UTC time. Only the seconds and higher-order digits need to be set since the fractional seconds portion of the time is precisely determi ned by the S-1 Hz ha rdwa re sy nc signal (S1HZ_REC i nput on t he C1 cable). At power-up, the initial system time is taken from a battery backed-up clock on the RCC, and will usually be correct to withi n a few seconds. However, the time is not considered ``validated'' until it has been set or approved by the user. As long as the time is not validated, two highlighted question marks appear beside t he time on the console display a nd a warning is issued when the S2 is commanded to record. When setti ng the time the station delay measurement displayed in t he upper right of t he console screen should be 0, otherwise the time setting may be inaccurate. If some value other tha n 0 is shown, type delay 0 to zero t he station delay. T he console time command can be used to enter a n absolute time as in t he following example: time 093-23:18:00 Here 093 is the day number (from 001 to 365, 366 for leap years) a nd t he followi ng fields a re hours, minutes, a nd seconds. T he day number can be omitted, i n which case t he current day is assumed. Absolute time commands such as t his one should alway s be issued immediately after t he 1 Hz tick t hey represent, i.e. above you would press return just after the reference clock's seconds digits flipped to 00. Setting t he year requi res a separate comma nd as follows: time y 1996 T his will almost never be necessary since t he year should al ready be correct. It is possible to individually set a ny time field, not just t he year, in bot h absolute a nd relative terms. For example, to i ncrement t he seconds by 2: time s+2 T his form of time setting will probably be common since, as already mentioned, the default time at boot-up should be correct to within a few seconds. If t he default time happens to be perfectly correct, or you are not particularly i nterested in setti ng t he exact time, t he time can be approved wit hout changing it by typing time validate. If the S2 sy stem is connected to a network, t he time can be obtai ned from one of the ot her hosts on t he network using time setremote. T his can also be set to occur automatically every time the sy stem is turned on (see t he description of t he time comma nd on Page 4-50 for more details). The time command also has a useful facility for converting between day numbers as used by t he S2 and t he more usual month/day representation. Enter time convert to display t he current time and date i n mont h/day format, or specify a date in one format a nd it will be converted to t he ot her format. Mode and Group Setting T he S2 recorder mode is set using t he mode command. T he correct mode to use depends on the number of user data cha nnels and data rate required for your particular application. The S2 is capable of i ndividual cha nnel data rates of 4, 8, 16, or 32 Mbits/s at 1 or 2 bit quantization, wit h eit her 1, 2, 4, 8, or 16 active data channels, subject to the restriction t hat the total data rate must be from 16 to 128 Mbits/s i n multiples of 16. Under the S2 mode naming scheme, t he most straightforward modes have names of t he form bxu-q where b is t he user cha nnel bit-rate i n Mbits/s and u is t he number of user data cha nnels. T he q indicates either 1 or 2-bit qua ntization1. By convention two S2 user data channels are occupied by each 2-bit-quantized sampler channel, i.e. sign a nd magnitude a re counted separately. For example, mode 16x8-1 is 8 cha nnels of 16 Mbits/s data at one-bit quantization. Mode 4x16-2 is 16 cha nnels of 4 Mbits/s data at two-bit quantization (a nd t herefore represents 8 2-bit sampler channels). Wit h regular S2 modes (`x' letter code), active user data channels a re allocated sequentially sta rting at cha nnel 0. Other modes exist in which t he active cha nnels follow different patterns -- for example the `i' a nd `p' modes, i nitially added to support RadioAstron. To see exactly which user data cha nnels are active, switch to t he user I/O

1

The quantization setting currently only affects the data validity signals during playback on a PT, and has no effect in any other situation.

4-9


S2-RT User's Manual

OPERATION

Figure 4-3: Transport Selection based on Mode & Group

screen by ty pi ng userio (repeat t he comma nd to switch back). Table B-5 also shows t he active user channels for each mode. Note t hat some modes have the same active user data channels a nd data rate as other modes but differ i n the way cha nnels are mapped i nternally (e.g. 16x8-2 and 16v8-2). Setting t he mode implicitly selects how many transports will be used for subsequent operations. Tra nsports a re normally selected i n order starti ng at address 0, i ncluding as ma ny as is necessary to accommodate t he total data rate. For modes which do not require all available t ra nsports, it is further possible to specify which group of t ra nsports will be used. For example, in mode 16x2-1 (which requires 2 transports), tra nsports 0­1 are ``group 0'', t ra nsports 2­3 are ``group 1'', a nd so on (Figure 4-3). T he console group command or RCL GROUP_SET comma nd is used to set the group number. Together the mode and group settings determine exactly which transports will be used. Group switching can be used to extend unattended recording time i n low-bandwidth modes, a nd will typically be performed using the RCL GROUP_SET command as part of an automated schedule running on an external control computer. Note t hat group switching is not allowed duri ng regula r (automatic) play or record -- t he S2 must be stopped and t hen resta rted.

4 - 10


S2-RT User's Manual

OPERATION

See t he description of the mode comma nd on page 4-40 for additional i nformation, includi ng a complete list of valid mode designators, and t he group command on page 4-37. Tape ID and User Info The tape ID and user info a re user-assignable text fields that get recorded on tape as part of the S2 auxilia ry data. All 8 transports receive the same auxilia ry data, so t his information is common to all tapes in a set. T he tape ID is a text string up to 20 cha racters long assigned using the tapeid console command. It should be chosen so that it uniquely identifies the set of tapes being recorded, a nd should remai n t he same for the enti re duration of the tapes. Information contai ned i n the tape ID is enti rely up to the user, however CRESTech a nd t he Canadia n correlator group have defined an S2 tape labeling convention wit h tape IDs of t he form XX-TYYYYYZZ, where XX is the count ry code, T is t he tape type code, YYYYY is the tape set i ndex number, a nd ZZ is a checksum. Example: CA-3-0012307 T he physical tape label i ncludes a n extra suffix which i ndicates t he tape number wit hin t he set from 0 to 7. More i nformation on t he Ca nadia n tape labeli ng and user i nfo conventions can be found i n the document DRAO-RPCS3001, available at http://www.drao.nrc.ca/web/vlbi/docs/doc3001.ps.gz . User info consists of 4 arbit ra ry text fields of va ryi ng lengths, each wit h a 16-character user-assignable label. T he field label should describe t he contents of the user info field. For example, the label might be ``Source Name'' a nd t he contents of the field might be ``3C273''. T he console commands to set i nfo field 2 as just described would be as follows: user info 2 label Source Name user info 2 3C273 After setting t he field label for t he fi rst time, it does not need to be set agai n for the rest of t he session. User i nfo can be cha nged at a ny time (but should not be changed more often tha n every few seconds). The Canadian convention is to put the name of the recording station in info field 1, and t he source name i n field 2 (fields 3 a nd 4 a re not specified). The maximum lengths of t he four fields are 16, 16, 32, and 48 cha racters respectively.

T he tape ID and the first t hree user i nfo fields are displayed i n t he User Parms window located in t he upper middle of the console screen, which switches automatically to display i nformation extracted from tape duri ng play back. To display t he value of t he fourt h (and longest) user i nfo field, ty pe user info 4. Tape Speed On S2 sy stems with AG2530 and earlier model t ransports, either of two available tape speeds may be selected using t he console speed command. For LP (long play ), enter speed lp, a nd for SLP (super long play ) enter speed slp. LP should be used when optimum bit-error rate performance is desired. SLP gives 50% longer recording times at somewhat higher bit-error rates (for more i nformation see Chapter 5). SLP is sometimes also called EP. Wit h AG2550 and later model t ransports only the SLP speed is supported for record (tapes recorded i n LP can still be played back). In ma ny applications the tape speed will always be t he same, so a default value can be set i n the sy stem defaults file using the recordspeed parameter. As shipped t he default tape speed is SLP. T he defaults file is described in Section 4.2.7. Tape Type Several different types of tapes being used due to differences i A to Z. For a complete list see will always be t he same due to using the tapetype parameter. are approved for use in the S2, and the S2 needs to be informed which type is n magnetic properties. Tape type codes a re numbers from 1 to 9 or letters from Chapter 5 or type tapetype typecodes. In many applications the tape type an established tape pool, so a default value can be set in t he sy stem defaults file

4 - 11


S2-RT User's Manual

OPERATION

Enabling Test Vector Data (If you a re not recordi ng test tapes, skip a head to ``Starting the Recording''.) Two types of pseudo-ra ndom test vectors can be produced by t he S2 to record test tapes: the Formatter test vector and t he UI test vector. Facilities for using t he Formatter vector are slightly more versatile so it is usually preferred. T he Formatter test vector is enabled by ty pi ng form diag on before making a recording. T hen use form berc during playback to take bit-error rate measurements. See Page 4-37 for more i nformation on these comma nds. T he UI test vector is different from the one produced by the Formatter. It is used for t he C1 and C2 cable test modes, as well as t he UI diag modes. To make a recording wit h the UI test vector attach an appropriate external test data generator to t he C1 cable or switch to one of the UI diag modes (e.g. mode diag8). T hen use uic berc duri ng playback to take bit-error rate measurements. See Page 4-54 for more i nformation. Starting the Recording Once all of the above parameters have been set, starti ng t he recording is easy: just ty pe record. During record, t he S2 automatically scans t he t ransports and monitors t he data being recorded, including tests for proper signal level, recovery of sy nc, a nd correct ext raction of auxiliary data. Alt hough t he transports a re not capable of readafter-write, t he loopback signals being monitored a re tapped off as close to t he record heads as possible. Any unusual conditions will be reported immediately i n t he console status wi ndow. When the recording is complete, type stop to stop the tapes. If any of the tapes should reach the end (EOT), t he S2 will stop all tapes automatically. Type rewind to wi nd the tapes to the beginni ng if desired, and then type eject to ext ract them.

4.2.4.2 Playing Back Tapes
An S2 Record Termi nal is capable of playi ng back tapes for verification purposes. Most playback functions a re supported, except that the total output data rate is limited to 16 Mbits/s because there is only one decoder module i n an RT. T hat means only 1 channel of user data is available i n mode 16x8-1, or 4 cha nnels in mode 4x16-1, etc. No user data is available when playi ng back 32 Mbit modes such as mode 32x4-2 on an RT, but playback can still be useful to check estimated error rates a nd auxilia ry data. In order to actually make use of the play back data being output on t he C2 cable, the recording must have been made wit h barrel-roll off and t he S2-RT must be put into manual playback to defeat the automatic cha nnel scanni ng that normally takes place. Then you can select which user data cha nnel(s) you wa nt wit h the setup comma nd (see ``Using the C2 cable output on an RT'', below). Assuming we simply wa nt to verify the recorded tapes, only a few steps are required for playback: 1. Select a mode with t he correct number of tra nsports. 2. Select the desired group number. 3. Position t he tapes to the appropriate place wit h the position comma nd. 4. Start playback by typing play. Figure 4-4 shows what t he console display might is automatically set to the same mode as was mode cannot be determi ned until the t ransports t ra nsports to use. Any mode can be chosen in s for recording. The same group number as used look like duri ng playback. Although the recorder mode used during record, step 1 is still necessary because a re put into motion, a nd for that the S2 must be told tep 1 as long as it has t he same total data rate as t he at record time should be selected. at play back the correct how ma ny mode used

The position comma nd is used to move the tapes to t he correct location before starting playback. Tape position is expressed as t he number of hours/mi nutes/seconds of recorded data since the beginning of tape (BOT), e.g.

4 - 12


S2-RT User's Manual

OPERATION

Figure 4-4: Sample ROS Screen, User (playback)

position 2:58:00 for 2 hours a nd 58 minutes into t he tape. You may also give the position as a n i nteger number of seconds, in t his case 10680. T he requi red position is normally obtained from a log written at record time. Usually all tapes i n a group will remai n close enough to the same position so that a single value can be used, but it is also possible to enter individual positions for each tape (and to display t hem wit h transport display position). T he tape counters on t he t ransport front-panel display s should not be used since t hey do not show the correct tape position (t hey have a 64/60 multiplicative error, as well as other uncertai nties). Treat them simply as unitless quantities. For more i nformation on positioning see the description of t he position comma nd on Page 4-41. To see the estimated error rate for each t ransport during play back ty pe transport display esterr. You should allow t hese values to settle for at least 5 minutes when playi ng back on at RT. Using the C2 cable output on an S2-RT To make use of the output data on t he C2 cable duri ng playback on a n S2-RT, ma nual playback must be selected to defeat the automatic channel scanni ng -- type play manual T his should be done after automatic play has had a cha nce to align t he tapes. Different i nternal data channels can t hen be selected using setup N where N is t he desired cha nnel number. Internal cha nnels do not necessarily correspond to user data channels -- to see which user data cha nnels are actually active on the C2 cable, switch to t he user I/O screen by ty pi ng userio. Note t hat barrel roll must be turned off duri ng both record a nd play back or t he user data will be scrambled (type barrelroll off before making t he recording). Tape Alignment Some play back tape alignment features can be demonstrated with the align command. T his would normally be used at a correlator to sy nchronize two or more S2 Playback Termi nals. For example, align -00:01:27.089301 will move the tapes backward in time by 1 mi nute, 27 seconds, a nd 89.301 milliseconds. When finished with play back, type stop to stop the tapes. If any of the tapes should reach t he end (EOT), the S2 will stop all tapes automatically. Type rewind to wind the tapes to t he beginning if desired, and t hen ty pe eject to extract them.

4 - 13


S2-RT User's Manual

OPERATION

``Eject-All'' Feature A special convenience feature allows all of t he tapes to be manually ejected without using the console: press a nd hold any tra nsport's eject button for two seconds (or more) a nd all t he tapes will eject. This feature should preferably be used only when all transports a re stopped. No ot her t ransport front-panel switches or buttons should be touched. The ejectalldisable defaults file option can be used to disable t he eject-all feature.

4.2.5 System Bootup
T he S2 sy stem goes through a boot procedure approximately 90 seconds long every time t he power is applied or t he sy stem is reset. The boot procedure loads a nd initializes the softwa re, configures the hardware, a nd performs a number of integrity checks to ensure correct sy stem functionality. This section may be a bit technical for some users, so you may wish to skip a head to ``ROS Bootup''. T he fi rst code to run is part of what's called t he boot monitor, which resides in EPROMs located on the RCC (MVME133XT CPU board, VME slot 1). T his performs phase 1 of t he boot sequence. T he boot monitor fi rst displays the followi ng message: Press space bar to enter boot monitor, 'n' for network boot... It then enters a short (4-second) count-down sequence. Normally, t he count-down is allowed to expire a nd t he boot procedure conti nues to phase 2, VxWorks2 i nitialization. If however you hit t he space ba r, t he boot sequence is i nterrupted a nd t he CPU enters the boot monitor, whose comma nd prompt is ``[S2 Boot]:''. The monitor supports a small number of low-level commands used only for CPU/SRAM diagnostics and maintenance functions. T he boot sequence will also drop into the boot monitor if it detects data corruption i n certain critical portions of t he SRAM (`VxWorks' a nd `root' partitions). See Section 6.2 for information on how to re-load a corrupted SRAM. Type go to continue t he boot sequence from i nside the boot monitor. Back at t he count-down sequence, you can type `n' to cause a network boot. This is only for mai ntena nce operations at CRESTech/SGL. Phase 2 in a normal boot sequence is VxWorks sy stem i nitialization and Static RAM checkout. The boot monitor first copies t he VxWorks sy stem code from SRAM into the DRAM on t he CPU board a nd t hen begi ns executi ng it. A series of messages like t he following accompanies the creation a nd checkout of SRAM pa rtitions: Creating SRAM disk /sram/bin/ at 0x4012c00, length 819200 bytes Next, ROS a nd related softwa re is loaded from SRAM i nto DRAM. If any problems a re encountered, t he console will beep and display a n error message, and t he CPU will drop i nto the VxWorks shell at t he end of phase 2. T he VxWorks shell (prompt ``->'') is used for softwa re checkout a nd debugging by technical personnel. You can also force the shell to sta rt up by pressing the space ba r duri ng t he software load portion of the bootup, but t his is not normally done. If no problems a re encountered i n phase 2, the boot procedure conti nues on to phase 3, ROS bootup.

4.2.6 ROS Bootup
T he Recorder Operati ng Sy stem (ROS) boot procedure comes after t he VxWorks sy stem portions of the bootup, a nd i ncludes software initialization, ha rdwa re configuration and i nitialization, a nd the power-up self-test (known as self-test 1).

2

VxWorksTM software was developed by Wind River Systems, Inc. Curses software was developed by the University of California, Berkeley.

4 - 14


S2-RT User's Manual

OPERATION

Code
adm31a adm3a ampex210 ansi d80 0 dm1520 dm3025 go140 hp150a hp2640a hp264 8a ibmpc IS C8001 macin to sh re ge nt100 re ge nt25 re ge nt40 st sun1 te k4105 te k4404 tv i925 vc404 vis20 0 vt1 00 vt125 vt200 vt5 2 wyse 75 wyse 925 yte rm10 z50

Terminal Description
LSI adm31a LSI adm3a Ampex a210 A nsi Direct 80 0/A Da ta me dia 15 20 Da ta me dia 30 25a Gra phon go-1 40 HP 150a HP 2640a HP 264 8a graphics terminal IBM PC PC/IX ISC 8001 Macinto sh with Mac Term inal Adds Re gent 100 Adds Re gent 25 Adds Re gent 40 Atari ST S un1 (old S un Worksta tio n co nso le) Tektronix 4105 Tektronix 4404 TeleVideo Mode l 925 Volke r-Cra ig 40 4 Visu al 20 0 DE C vt1 00 (o r ROSCO) DEC vt125 DEC vt200 DE C vt5 2 Wyse -75 Wyse -50 emula ting tv i925 yte rm 1.0 UCB ascii.kbd Zephy r 50

Code
adm3 amiga ansi25 apollo dm2500 dm3045 h19a hp2621a hp2645 ibm3101 ibmpcx kaypro2 regent20 regent40+ regent60 sun-cmd sun tek4115 tvi924 v3220 vc6220 vt102 vt132 vt220 wyse50 wyse85 xterm yterm11

Ter minal Description
LSI adm3 Amiga ANSI IBM PC/NANSI.SYS Apo llo Data media 2500 Data media 3045a Heathk it h19 ansi mo de HP 2621a HP 2645 IBM 3101-10 IBM PC xenix co nsole display Kaypro II Adds Re ge nt 20 Adds Re ge nt 40+ Adds Re ge nt 60 Sun Workstation cmdto ol Sun Workstation Tektronix 4115 Tele vide o Mo de l 924 LANPAR Visio n II mo de l 3220/3221/3222 Volk er-Cra ig 6220, DEC vt102 DEC vt132 DEC vt220 Wyse-50 in Wyse mode Wyse-85 X windows term inal emulator yterm 1.1 UCB ascii.kbd

dialogue80 Am pe x dialo gue 80

masscomp Ma s sco mp

vision1000 Vision 1000 (dim reg sta ndout)

Table 4-2: Terminal Types Supported by ROS If this is t he first time you are running t his S2 system, ROS will first ask some i nstallation questions, i ncluding t he termi nal type and baud rate you wish to use. T he default terminal type is VT100 a nd t he default baud rate is 9600, but these can be cha nged at t his time. Enter your console terminal ty pe a nd baud rate (max. 9600). If your terminal type is not one of t hose recognized by t he S2, you will be given the opportunity to add a terminal defi nition to t he terminal capability database, but to do this you must understand t he Berkeley Unix termcap file format (see Appendix D). Table 4-2 shows some popular termi nal types recognized by t he S2 softwa re as shipped. After you have a nswered t he installation questions, they will not appear agai n. If you ever wish to re-run t he i nstallation procedure, press space duri ng phase 2 of t he boot sequence to enter t he VxWorks shell, a nd then type install at t he shell prompt (``->''). All i nstallation options can also be set by editing the system defaults file, or by using the default command (see Section 4.2.7).

4 - 15


S2-RT User's Manual

OPERATION

Most ROS hardware and softwa re i nitialization happens before the main display screen appears. Each major step outputs a message to t he console. These messages can usually be ignored, but a re useful for debugging if problems a rise. Any serious problems will result i n status messages following the boot phase, so t here is no particular need to pay attention to the bootup messages. T he ROS power-on self-test sta rts just after t he main console display appears. T he self-test requi res all necessary t ra nsports and other sy stem hardware modules to be present and connected. Normally all 8 t ra nsports are tested, but the diagnumtran option i n t he sy stem defaults file can be cha nged to reduce t he number of tra nsports to test (1, 2, 4 or 8). T his is useful for scaled-down S2-RTs with fewer t han 8 transports (the defaults file is described i n Section 4.2.7). No console comma nds can be ty ped while the self-test executes (about 45 seconds), but you may choose to interrupt t he test by ty pi ng Cntl-C once. Most RCL comma nds which affect tape motion or system switch setti ngs are also not allowed during the self-test. Any faults detected a re reported in the i nteraction window, as well as an overall diagnostic failure i ndication in t he status wi ndow. For more i nformation on t he self-test see Section 4.6. After the self-test completes (successfully or not), t he sy stem automatically begins executing the batch file called `autoexec', if such a file exists. This can be used to perform any actions t hat a re requi red every time t he S2 is turned on. For example, you might put some comma nds in t he autoexec file to set the user i nfo field labels to standard values used by your site, or to set other conditions or switches as desired. However, please don't set switches i n the autoexec file for which t here is a provision i n t he sy stem defaults file, otherwise t he ROS boot procedure may not work properly. When t he autoexec batch file is finished, t he ROS console prompt appears (``>'') and t he sy stem is ready for you to sta rt typing comma nds or to start issuing cont rol requests over the RCL. If the system is functioni ng properly a nd no serious problems were discovered by t he self-test or online status, the green ``OK'' LED on the front of t he VME card cage will be lit (ledmode defaults-file pa rameter must be set to `ok'). T he LED on t he Formatter board has t he same function. Any failure conditions indicated by LEDs will also be shown i n the console Status wi ndow.

4.2.7 ROS Configuration
Two configuration files used by the Recorder Operati ng Sy stem can be edited by t he user: t he defaults file a nd the termcap file. T he defaults file contains default boot-up parameters such as the console termi nal type, tape type, serial port baud rates, and input/output clock rates a nd modes. It also contai ns the S2 station number and ``nickname'', and ma ny other operational pa rameters you may wish to set. Appendix C contains a n example defaults file. Each default parameter is documented right in t he file and should be self-explanatory. The defaults file can be edited using the edit comma nd (see below), or i ndividual parameters may be displayed a nd updated directly using t he default comma nd (described on Page 4-32). Note t hat changes to t he defaults file take effect only after the next system boot. A few pa rameters such as t he termi nal type, station number and nickname are cha nged as side-effects of other console commands, and will automatically be updated in t he file. T he termcap file is the terminal capabilities database in standard Berkeley Unix termcap format. It may be necessary to edit t his file to add new termi nal types or fix t he behaviour of existing termi nals, particula rly wit h respect to function key s. This requires knowledge of t he Berkeley termcap format, so an ext ract of t he Unix reference ma nual on t he subject of termcaps has been i ncluded in Appendix D. To help define termcap ent ries for special key s such as function and cursor key s, a useful utility is provided to decode ASCII cha racter sequences. Type shell to enter the VxWorks shell and then ty pe showkey. All subsequent cha racters typed will be display ed in hex format. Hit return twice to get back to the normal shell prompt. To modify eit her of the above files, use the console edit command a nd give the file's name. This starts a full-screen editor which is very simila r to the Unix vi editor. For those unfamilia r wit h vi, onli ne help can be obtained from

4 - 16


S2-RT User's Manual

OPERATION

within t he editor by typing ``:help'' a nd pressing return. Briefly, vi has two modes: a command mode where letter a nd number key s have special functions, a nd a n insert mode where text is i nserted i nto the file. You are normally i n comma nd mode, a nd can use t he cursor keys to position t he cursor to the point where you would like to make a cha nge (the `h',`j',`k', a nd `l' keys also function as cursor keys). To start inserting text, press `i'. T hen press t he escape key when you are done to return to comma nd mode. Use `x' to delete characters while i n comma nd mode. When you are finished editing, hit the upper-case `Z' twice to save the file and exit the editor. Type ``:q!'' a nd press return to quit wit hout making a ny cha nges. If t he termi nal type is not set correctly, it may be difficult or impossible to edit. In term comma nd to set the correct termi nal ty pe. If the terminal you a re using is not will need to add a definition for it to the termcap file without using the editor. This can procedure, which is invoked from the VxWorks shell by typing install. You can use t he or press t he space ba r at t he appropriate part of t he bootup to enter t he shell. t his case use the console supported by the S2 you be done via t he S2 install console shell comma nd

4 - 17


S2-RT User's Manual

OPERATION

4.2.8 Console Screen Descriptions
T his section describes each console display parameter, orga nized by window. Some low-level and diagnostic display parameters a re not fully documented. More important display parameters are ma rked wit h ``*''. Those that a re important only for record applications are marked ``*R'', and for playback applications ``*P''.

4.2.8.1 Crucial Parms Window (upper right, Figure 4-1)
(Top li ne, left): T he sy stem nickname. T his is the conventional name assigned to this S2 sy stem, up to 8 cha racters long. The nickname is stored i n the system defaults file, a nd can be set using the station command, or by editing t he defaults file (edit defaults). This space will be bla nk if no nickname is defi ned. The sy stem time. This is t he current reference time, written on tape during record. The time is sy nchronized to the S-1/C-1 Hz sy nc input (S1HZ_REC on C1 cable or C1HZ on C2a cable), possibly with a delay offset (see ``Station delay'' below). Time is usually set to UTC using t he time command. T he display format is ``YYYY DDD-HH:MM:SS'' where YYYY is t he year, DDD is the day number (1­365, 366 for leap years), and HH:MM:SS is t he 24-hour time. The display will be highlighted i n t he event of a severe failure of S2 internal sy stem timi ng (and t he clock will stop). T here is a very short delay between t he actual 1 Hz tick and t he screen time display update, but it should be short enough so as not to cause problems. Most other display parameters have a somewhat longer delay (1/4 of a second or less), since it's not possible to update everything on the screen at t he same time.

(Top li ne, right)*:

Recorder mode:* T his shows the current S2 cha nnelization mode, also called recorder mode or observing mode. The mode determi nes t he user data rate and the number of active user data channels, and is set using the mode comma nd. If the barrel roller is on, ``(br)'' is shown beside t he mode. Station delay:
*

Shows the amount of clock offset between t he externally supplied 1 Hz reference (S1HZ_REC on C1 cable or C1HZ on C2 cable) and the S2's i nternal 1 Hz tick. T his is a true measurement of t he difference, with positive numbers i ndicati ng t hat t he i nternal 1 Hz tick is later tha n the external reference, and negative numbers i ndicati ng that the internal tick is earlier. During record, the station delay determi nes t he offset between the user's 1 Hz reference and the time used to label the bits on tape. Duri ng playback, t he station delay determines the offset between the user's 1 Hz timing reference a nd when t he corresponding data bit is output on the C2 cable. The displayed station delay can range from -0.5 seconds to +0.5 seconds less 31.25 nanoseconds. Display may be i n units of seconds (s), milliseconds (ms), microseconds (us), nanoseconds (ns), or user data bits (bits), dependi ng on t he units used when t he delay was set (the display units can also be changed without changing t he delay). When the System Clock PLL is in refclk mode (used for recording or fixed-rate playback), the delay measurement should exactly match t he delay setti ng from t he last delay comma nd. Glitches on t he high-rate reference clock, or a shift i n t he external or internal 1 Hz timi ng can cause a mismatch, in which case the delay measurement display will be highlighted a nd the status message ``Stn delay measurement != setting'' (STAT_BADSTNDELAY) will appear. Corrections should be made ma nually by resetting the appropriate delay value. The S2 can also be i nstructed to automatically ``fix'' station delay mismatches by setti ng the defaults-file parameter scpllrefclkfix to 1. In t his case a ny station delay mismatch t hat a rises while i n SC PLL refclk mode and remai ns stable for 2 seconds will be auto-

4 - 18


S2-RT User's Manual

OPERATION

Figure 4-5: S2 Diagnostic Loopback Paths

matically corrected by re-asserti ng the last entered station delay setting. T he i nformational status message STAT_DELAYFIX will appear, givi ng a count of t he total number of such station delay auto resets since the last status reset. Bewa re t hat this momentarily disturbs the enti re sy stem timi ng, a nd may cause a significant glitch duri ng both recording and playback, resulting in loss of several seconds of data. Users should decide whether station delay mismatches should be corrected at record time, wit h t he possibility of glitchi ng, or simply logged a nd t hen corrected at correlation (playback) time. To make it easier to establish later what the actual station delay was at record time, the delay measurement is continuously recorded in the tape auxiliary data channel and is one of t he quantities available at playback time via the tapeinfo command. In System Clock PLL 1hz mode (used for playback), t he delay measurement will only be approximately the same as t he delay setting (withi n a few hundred bits). The display will be highlighted whenever the delay error is greater t ha n about 60 microseconds (1000 bits at a data rate of 16 Mbits/s) a nd status message STAT_SCPLLUNLOCK will appear, indicating t hat the System Clock Phase-Lock Loop is not locked. If no user 1 Hz reference tick is present, ``[no 1 Hz in]'' will be displayed. In Sy stem Clock PLL errmes mode (used for playback), t he user 1 Hz reference is not used so there will normally be no delay measurement. However should a 1 Hz tick be supplied t he delay measurement will still appear even t hough it is used for nothing except display. Decoder input: Describes the current source of decoded data. The decoder (DRD) has 5 possible i nput sources correspondi ng to 5 of the 6 diagnostic data paths (Figure 4-5): play (tra nsport play back), rec (tra nsport record), byp (transport by pass), ahook (a nalog direct-hookup), and dhook (digital direct-hookup). For each path it is possible to select a channel number (0 to 7) and a transport number (0 to 7). T he cha nnel
4 - 19


S2-RT User's Manual

OPERATION

number identifies which S2 internal data channel is being decoded a nd sent on to the UI for output. The channel number is normally t he same as t he transport number except when a t ransport other t ha n the one corresponding directly to that channel is being used, e.g. during play back when t he tapes a re i nserted in t he t ransports out of sequence, or a ny time a group number higher t ha n 0 is selected. Note that t he transport number is only shown when it is different from the cha nnel number. T he decoder input source is sy nonymous with t he current recorder setup, as cont rolled by t he console setup comma nd (see page 4-45). Most of t he time t he setup is automatically cha nged as required, e.g. record selects t he record path and play selects the play pat h. The stop, rewind, and ff commands select the stop setup, which is normally bypass on a n RT and play on a PT. T he stop setup can be changed by using the setup comma nd while t he S2 is stopped. The stopsetup defaults-file parameter determi nes t he default stop setup to use at bootup. Decoded time: T his shows t he time extracted from t he decoded auxilia ry data. T his will be t he same as t he current sy stem time duri ng record or when the S2 is stopped, since t he decoder i n this case is fed with diagnostic loopback data. During playback, t his will be the tape time from t he t ransport currently selected for decoding. If time could not be decoded for the particular frame at t he moment of display, ``XXX-XX:XX:XX.XX'' is shown. T he time display update is sy nchronized to t he system i nternal 1 Hz tick, wit h a very short delay between the actual 1 Hz tick a nd t he display update. Most ot her display parameters, in particula r the play back tape times i n the tra nsport window, have a somewhat longer delay (about 1/4 of a second or less). T his shows t he percentage of L2 sy nc achieved by the decoder over t he previous one-second period. It is computed by counting the number of data blocks with valid L2 sync (there are 250 data blocks per frame). L2 (level 2) sy nc is acquired at the beginni ng of each frame upon the detection of two consecutive sy nc words followed by 3 consecutive block IDs. The amount of sy nc is displayed as an integer percentage with fractions rounded down, so that only perfect sync over a 1 second period will show up as 100%. Remember t hat t his value comes from a single decoder, so it represents only one internal data cha nnel of 16 Mbits/s. T he word ``(uncalib)'' appears beside the percentage if data-recovery calibration has not yet reached a sufficiently stable state where it is considered calibrated. ``(t rack cal)'' during playback i ndicates t hat phase-2 tracking calibration is in progress3. In some cases when the system is having difficulty playi ng back a particular tape, a special phase-1b algorithm may be triggered by ROS t hat performs la rge tracking jumps of 20 units or more. T his gives an estimate of the raw bit-error rate (BER) of the data being decoded, averaged over the last 6 seconds. The estimate is based on a single i nternal data channel of 16 Mbits/s, so the error rate shown does not apply directly to user data unless t he user channel data rate is also 16 Mbits/s. The error rate estimate is valid not only duri ng playback but also duri ng record a nd while the recorder is stopped. When not in play back, t he decoder is fed wit h diagnostic loopback data so t he estimated error rate will typically be negligible. If automatic transport scanni ng is being performed (as is normal during playback or record), t he error rate value represents a n average across several internal data cha nnels (to see i n-

Decoder sy nc:

Est error rate:*

3

There are two tracking algorithms: phase-1 is performed by the transport (green DIGITAL TRACKING light flashes, if present), and phase-2 is performed by ROS (track cal message appears)

4 - 20


S2-RT User's Manual

OPERATION

dividual cha nnel error estimates type transport display esterr). T he estimated error rate is obtained by counting the number of incorrect 16-bit sync words found when decoding t he data, a nd extrapolati ng to encompass all data bits using an empirically derived formula. We assume that t he error rate is low, so if a sy nc word is incorrect it is likely that i n fact only a single bit is i n error. We also assume a uniform distribution of ra ndom errors. T hese assumptions break down for very low and very high error rates, and for extended burst errors. In practice, however, t he estimate has been found to be quite close to t he t rue bit-error rate i n most cases. Because sy nc words represent only a small proportion of the data, a relatively long integration period is needed to obtai n a useful estimate. The integration period used (6 seconds) gives a minimum measurement resolution of a round 1.0 x 10-6. T here is also a n artificial upper limit of 1.0 x 10-2, imposed to avoid the inaccurate upper estimation ra nge. Sy stem performance may be acceptable even with relatively high error rates (e.g. up to 3.0 x 10-3) since much of the bad data would likely be flagged as i nvalid. T his could, for example, be caused by a longitudinal tape scratch t hat destroy s a particula r sy nc word in each frame. Nonetheless, investigative action should probably be taken -- see Section 6.4, ``TAM Tra nsport Replacement and Servicing''. % data valid:
*

T his shows t he percentage of valid decoded data over t he previous one-second period, obtai ned by i ntegrating the data validity (DV) signal of t he i nternal data channel currently being decoded. Since it is based on a single i nternal S2 data channel, the % DV applies only to t hose user data cha nnels which a re currently active, as shown in t he user-I/O window ``C2 data out'' display. % DV is computed not only during play back but also during record and while the recorder is stopped. When not i n playback, t he decoder is fed with diagnostic loopback data so t he percentage of valid data will usually be 100%. To see i ndividual cha nnel % DV measurements ty pe transport display dv. T he % DV measurement normally recognizes the user DV flag, so it will drop to zero whenever user DV is set to false (user dv no). Type user dv playback disable to ignore t he user DV flag. T his shows t he current mapping of decoder outputs onto S2 internal data channels. In general, there a re up to 8 decoders i n a n S2 system. Although a Record Terminal has only one, logically the crossba r switch is still treated as if all 8 decoders were present, since the one decoder can be switched among all 8 t ransports a nd effectively assumes t he roles of the others, one at a time. T he crossbar switch at t he decoder outputs allows tapes to be i nserted i n any order and allows switchi ng between different groups of transports duri ng playback. Setting of t he crossbar is normally totally automatic, so the display is for reference only. The crossbar setti ng is represented by an 8-digit stri ng where each digit position represents an i nternal data cha nnel from 0 to 7. The value of t he digit in a pa rticula r position i ndicates which decoder/transport is outputting on that channel (`x' indicates no output). For example, in t he crossbar stri ng ``51234760'' decoder/transport 5 is outputti ng data on internal channel 0, a nd decoder/transport 7 is outputti ng on cha nnel 5. T he string ``01234567'' represents the identity mapping, which means the tapes a re in the right order. T he crossbar can be set manually using t he def xbar command, but t his should not normally be necessary. T he display shows ``(ft hru)'' beside t he crossbar setti ng if UI feed-through mode is on to emphasize the fact t hat the outputs of t he decoder(s) are not being used. If the Mark III formatter is enabled, ``(Mk3)'' is shown to indicated that decoded output is being reformatted. If both feed-through and the Mark III formatter are on, ``(Mk3ft hru)'' is shown.

Decoder Xbar:

4 - 21


S2-RT User's Manual

OPERATION

Figure 4-6: Sample ROS Screen, Bad Status

4.2.8.2 Status Window (middle right, Figure 4-6)
(Body of window)*: Contains one-li ne status messages summarizing t he health of the sy stem. ``Error'' and ``fatal error'' messages a re highlighted, but ``informational'' messages a re not. Transient status ent ries (known as clear-on-read conditions) stay on t he display until you ty pe status reset. Refer to t he list of status codes in Section 4.5 for the meani ng and possible causes of each status message. If t here are more tha n 3 status conditions, the status window can be paged down a nd back up using status pagedn and status pageup. To show all current status conditions at once with slightly more verbose descriptions use status display fullscreen. T his in pa rticula r includes the status code numbers, not shown i n the status wi ndow, which a re useful to quickly fi nd t he right ent ry in the list of status codes i n Section 4.5. You can also dump the current status information to the S2 i nternal log file by typing status display tolog. This provides an easy way to save a status snapshot for later exami nation. (Bottom boundary li ne)*: T he current status page number is shown on the left side of t he bottom wi ndow boundary, a nd t he word ``MORE'' is displayed on the right side if there is another page below t his one. If a ny fatal status errors exist, t he word ``FAIL'' appears highlighted i n t he middle. Fatal errors indicate t hat t he current operation is probably not proceeding successfully, and corrective action should be taken. The green ``OK'' LED on the front of t he VME card cage will go out when FAIL appears i n t he status wi ndow, provided the ledmode defaults-file parameter is set to `ok'. Note that fatal clear-on-read status errors cause the FAIL condition to persist until status is ma nually reset using status reset, even if t he fatal condition is no longer t rue. The ``OK'' LED reacts to clear-on-read errors slightly differently. It will go back on eit her when status reset is typed or when t he RCL status is read (implicitly clearing clear-on-read conditions), while t he console FAIL indicator is unaffected by t he RCL.

4 - 22


S2-RT User's Manual

OPERATION

4.2.8.3 User Parms Window (upper middle, Figure 4-1)
(Top li ne): Gives the name of the window, since t his a rea of the display can also show other wi ndows (ty pe user to switch to t he User Parms window if it is not currently displayed). If the word ``record'' appears on the top line i n brackets, the rest of t he wi ndow shows information that is being (or would be) recorded on tape. If t he word ``playback'' appears in brackets, the rest of the wi ndow shows information being ext racted from tape, specifically t he tape in t he t ra nsport currently selected for decoding. When the S2 is stopped (or rewinding/fast-forwa rd winding/positioning) the stop setup determi nes whether record or playback pa rameters a re shown. If the stop setup is play play back parameters are shown, otherwise record parameters are shown. T he stop setup is normally bypass on a n RT a nd play on a PT, but can be cha nged in t he defaults file or by using t he setup command while t he S2 is stopped. Shows the tape identifier string, up to 20 cha racters long, as set by t he tapeid command. Shows user i nfo field 1. T he label (text to the left of the colon) can be changed by the user. Dependi ng on the length of t he label, t he enti re 16-character i nfo field may not fit on t he display. If so, it will be t runcated on t he right. User i nfo is set with the user info comma nd. Shows user i nfo field 2, similar to user i nfo 1. Shows user i nfo is 32 characters not shown. Type N is from 1 to
*

Tape ID:

*

(User i nfo 1)*:

(User i nfo 2)*: (User i nfo 3)*:

field 3, similar to user i nfo 1 except that t he maximum length so t his field is more likely to be truncated. User info field 4 is user info N to display a ny user info field i n its entirety, where 4.

User data valid:

Shows t he setting of t he user data valid flag. T he user DV flag is recorded on tape as part of t he auxiliary data and recovered at playback time, where it is used to i nvalidate data (if false) by lowering t he data validity signals on the C2b/c cable. T his facility provides a way to i ndicate at record time that invalid data is being recorded, e.g. the telescope is slewing or off-source (see t he user dv comma nd on page 4-55). Duri ng play back, t he display shows what the user DV flag was set to during record. T he user DV flag can be ignored at playback by enteri ng user dv playback disable, indicated by the word ``(ignored)'' on the display. T hen data marked i nvalid by t he user at record time will be t reated as valid. Indicates t he record or playback tape speed. Legal speeds for recording a re lp a nd slp on AG2530 or earlier model t ra nsports, and slp only on AG2550 a nd later transports4. All tra nsport types can play back at eit her speed, but playi ng slp tapes on AG2510 t ra nsports is not recommended due to poor performance. During playback, the unused speed sp may sometimes appear for blank spots on t he tape -- this is normal. All active tra nsports must report the same speed duri ng playback or this display will be blank.

Tape speed:

*

Tape position:

*

Indicates the current overall tape position. Position is measured as the number of seconds of recorded data since t he beginni ng of tape, a nd is normally displayed as hours:minutes:seconds, e.g. 3:18:57. T his format is similar to a tape time except that t he hours portion is shown with only a single digit. Alternately, t he

4

The SLP speed is sometimes also called EP

4 - 23


S2-RT User's Manual

OPERATION

position may be shown as a n i nteger number of seconds by cha nging the posdisformat defaults file pa rameter. Although there may be up to 8 tapes a nd t herefore 8 different positions, it is usually sufficient to deal wit h a single position value since the group of currently active t ra nsports will ty pically be in almost t he same position. T he overall position is defined as t he mid-point of the individual transport positions, a nd i ncludes a li near varia nce value t hat i ndicates the maximum absolute deviation of a ny individual position from the mid-point, e.g. +-12 s means that t he latest t ransport is 12 seconds ahead and the earliest transport is 12 seconds behi nd t he overall position. If the varia nce exceeds 60 seconds it is shown in hours a nd minutes, e.g. +-1h29 means one hour and twenty-nine mi nutes. To show each t ra nsport's individual position use transport display position. Positions are normally positive but can take on small negative values due to anomalies a round BOT. If a ny i ndividual position is unknown, the overall position is also considered unknown. See t he position comma nd on Page 4-41 for more i nformation.

4.2.8.4 State Window (middle, Figure 4-1)
(Body of window)*: Contains highlighted symbols to represent the overall S2 tape motion state based on t he states of the individual tra nsports. Only the states of currently selected transports (t hose marked with `*') are used in determi ning the overall state. The sy mbol meani ngs are as follows: << -- rewind > -- play >> -- fast-forwa rd [] -- stop || -- pause REC -- record Sometimes the symbols will light in combination to indicate states such as cue and review. An `M' after the record or play sy mbol indicates ma nual record/play. In some unusual situations no consistent overall tape motion state can be derived, e.g. after certai n tra nsport errors or low-level console commands. In t his case no state is indicated. (Bottom boundary li ne)*: T he T he T he not word ``POSITIONING'' i ndicates that tape positioni ng is in progress. word ``ALIGNED'' indicates that all tapes are aligned during playback. words ``NO TAPE'' i ndicate that one or more required tapes have yet been inserted.

4.2.8.5 Transport Window (middle left, Figure 4-1)
(Top li ne): Indicates what tra nsport-re shows the t ra nsport state be extracted. In t his case display parameters, more lated parameter is being display ed. Normally, the wi ndow and switches to tape time duri ng playback if time can the window is simply labeled ``Transports''. For other specific labels a re used.

(Body of window:) For each t ransport (0­7) shows one of several parameters as selected wit h t he transport display comma nd. Transports which do not respond to communication attempts are shown as ``--''. Currently selected transports are marked `*', a nd tra nsports for which system status contains failure conditions a re marked wit h a highlighted `F'. A list of possible display parameters is given below. T he word in square brackets is the tra nsport display command code t hat selects t he

4 - 24


S2-RT User's Manual

OPERATION

parameter. Note t hat when playback tape times are shown t he displayed values a re typically delayed by about 1/4 of a second due to display update latencies (use t he ``Decoded time'' display for a more instanta neous tape time value). State/Tape time: Shows t he transport state, or playback tape time if available (hours/mi ns/secs/frames). Includes servo lock indicator (`L'). T his is t he parameter normally displayed. [time] State/Tape day: Like the first display above, but the tape time includes day#/hours/mins. [day] State/Tape year: Like the first display above, but the tape time includes year/day#. [year] Tape position: Gives t he individual t ransport tape positions i n hours:mi nutes:seconds of recorded data since BOT, or as an integer number of seconds depending on the posdisformat defaults file parameter. [position] Est error rate: Shows t he estimated bit-error rate for each t ransport signal path (includes all t ra nsports i n auto record/play only). [esterr] % data valid: Shows the % data valid for each transport signal path (includes all t ransports in auto record/play only ). [dv] AGC level: Indicates t he play back/record/bypass signal strength. [agclevel] Tape channel ID: Shows t he channel ID extracted from tape duri ng playback. T his corresponds to the address of t he transport used to record t he tape. [chanid] Transport temp: Shows t he temperature inside the transports i n degrees Celsius. [temp] In-service time: Shows the total number of hours t he t ra nsport has spent in play, record, pause, cue, or review states since t he last service event (as recorded using transport N service lastserv). Also shows t he total i n-service time since manufacture. [servtime] Head-use time: Shows t he total number of hours t he tra nsport has spent in play, record, pause, cue, or review states since the last head replacement (as recorded using transport N service lasthead). Also shows the total head-use time since ma nufacture. [headtime] On time: Shows the total amount of time t he t ra nsport has had power applied since manufacture in hours a nd mi nutes. [ontime] Transport tracking: Displays the current tra nsport t racking control value, relative to the internal (phase-1) optimized position. Includes manual and pending flags. [tracking] TCP serial #: Shows the t ra nsport (TCP) serial number. [serial] Playback TCP serial #: Shows t he transport serial number extracted from tape. This corresponds to the serial number of the t ransport (TCP) used to record the tape. [serialpb] Transport state: Shows t he transport state, but does not switch to tape time. [state]

4.2.8.6 User I/O Window (upper middle, Figure 4-7)
T his window summarizes t he current input/output configuration. It replaces the User Parms window when you type userio. Most of t he parameters shown in t he User I/O window a re cont rolled using t he userio a nd scpll console commands. (Top li ne): Data rate: Gives the name of this wi ndow, ``User I/O''. Shows the user cha nnel data rate in Mbits/s, and the number of active user channels. T hese a re determi ned by the current recorder mode setting (see t he mode command). T he product gives t he total sy stem data rate.

4 - 25


S2-RT User's Manual

OPERATION

Figure 4-7: Sample ROS Screen, User I/O
*R

C1 data i n:

Indicates which of the 16 user data i nput channels on t he C1 cable are active i n t he current mode. User data channels a re numbered from 0 to 15, corresponding to t he i nput signal names IN 0 to IN 15 listed in Table B-1. Certain sequences of cha nnels are abbreviated to fit on the screen, e.g. 0,2...14 means 0,2,4,6,8,10,12,14. Refer to Table B-5 for a list of which user cha nnels are active i n each recorder mode. If the S2 is i n C1-cable test mode, ``(C1test)'' is shown. A switch can be set to disable the C1 data i nputs for diagnostics, in which case t he display shows ``(disabled)''. Indicates which of t he 16 user data output channels on the C2a cable are active i n the current mode a nd setup. The numbers shown correspond to t he output signal names OUT 0 to OUT 15 listed in Table B-2. Since t here is only one decoder i n a n RT, only a subset of the potential C2 outputs are active at any one time, dependi ng on the setup. An exception is when the UI is set to feed-through mode, i n which case all potential C2 data outputs are active a nd contai n feed-through data from the C1 input cable. When t he Mark III formatter is enabled (mk3 form enable), t he C2a cable switches to Mark III-compatible mode and ``(Mk3)'' is displayed. The cable pin-outs are as shown in Table B-4, but in this case the cha nnel numbers shown in t he display do not correspond directly to the TRACK numbers shown in the table but rather should be multiplied by 2 a nd then incremented by either 1 or 2 dependi ng on whether the odd or even Mark III t rack number convention is being used. When t he S2 is i n a C2-cable test mode ``(C2test)'' is shown (or ``(C2tMk3)'' if t he Mark III formatter is also on). A switch can be set to disable t he C2 data a nd validity outputs for diagnostic purposes, i n which case t he display shows ``(disabled)''. See the userio command on Page 4-55 for more i nformation. Indicates which of the 16 user data validity outputs on t he C2b a nd C2c cables a re active i n t he current mode a nd setup. The numbers shown correspond to t he output signal names DV OUT 0 to DV OUT 15 listed in Table B-3. Note that even channel numbers (0, 2, 4 etc.) appear on C2b and odd channel numbers (1, 3, 5 etc.) appear on C2c. The C2c cable is needed only for 1-bit quantized modes with names of the form bxu-1, since all other modes use only even validity cha nnels. To avoid t he need for t he C2c cable substitute equivalent ``interleaved'' 1-bit modes for regula r S2 modes, e.g. use 16i8-1 instead of 16x8-1. Since there is only one decoder i n an RT, only a subset of the potential C2 DV outputs is active

C2 data out:

*P

C2 DV out:*P

4 - 26


S2-RT User's Manual

OPERATION

at a ny one time, depending on the setup. When t he UI is set to feed-through mode all C2 DV outputs are forced high. SC PLL lock mode:* T his shows t he current System Clock PLL lock mode, one of refclk, 1hz, errmes, xtal, or manual i ndicati ng t he SC PLL lock reference source. T his is normally refclk for a Record Terminal and 1hz or errmes for a Play back Terminal. The scpllmode defaults-file parameter determi nes the default SC PLL mode to use at bootup. See the description of t he scpll mode comma nd on Page 4-44 for further details. Ref clk/1 Hz i n: Shows t he source of the high-rate a nd 1 Hz input reference clocks, which can come eit her from t he C1 or C2 cable. T he C1 cable is normally s elected on a Record Terminal, a nd t he C2 cable on a Playback Termi nal. In Sy stem Clock PLL modes ot her tha n refclk and 1hz t he clock inputs are not used, so this display shows ``(unused)''. In Sy stem Clock PLL xtal mode, this display shows ``(int Xtal)'' i ndicati ng t hat the high-rate reference is an internal crystal oscillator located on t he UI board. The clkinsrc defaults file parameter determi nes t he default input clock source to use at bootup. Ref clk i n rate:
*R

Shows the expected frequency of the high-rate i nput reference clock i n MHz. T his can be set to 4, 8, 16, or 32 MHz using t he userio clkin command. It can also be set to follow the user channel data rate (``followdata''), in which case the display shows ``(fd)'' and the expected input frequency t racks t he user data rate on mode cha nges. T he i nput ref clock is used only i n Sy stem Clock PLL refclk mode, otherwise ``(unused)'' is displayed. In SC PLL xtal mode, 32 MHz is shown because t his is t he frequency of the i nternal crystal oscillator. The clkinrate defaults file parameter determines the default i nput clock frequency to use at bootup.

Ref clk out rate:*P Shows the frequency of the high-rate reference clock output on the C2 cable. This can be set to 4, 8, 16, or 32 MHz (i ndependent of the i nput clock rate) using t he userio clkout comma nd. It can also be set to follow t he user cha nnel data rate (``followdata''), i n which case t he display shows ``(fd)'' and the output clock rate t racks t he user data rate on mode cha nges. If t he Mark III formatter is active t he output clock rate i ncreases by a factor of 9/8 due to parity insertion, and always follows the user data rate rega rdless of t he output rate setti ng. T he clkoutrate defaults-file parameter determines t he default output clock frequency to use at bootup.

4.2.8.7 Mark III Window (upper middle, Figure 4-8)
T his wi ndow summarizes Mark III/IV related activity and switch setti ngs. It replaces t he User Parms wi ndow when you ty pe mk3. Note that entries i n t his window a re only active when t he Mark III formatter is enabled (mk3 form enable). (Top li ne): Form time: Gives the name of this wi ndow, ``Diagnostic Parms (Mk3)''. Shows the Mark display. T he Ma i n playback (or will be used if data. III time being encoded, simila r to a Mark III decoder's front-panel rk III time is based on t he time decoded by the S2 decoder when set up for play), or the current sy stem time otherwise. All 0's t he S2 decoder cannot extract time from the play back auxilia ry

Form aux:

Shows the Mark III auxiliary data being encoded, simila r to a Mark III decoder's front-pa nel display. T he auxilia ry data consists of 12 user-specified BCD digits, followed by two BCD zeroes, followed by a two-digit hex ha rdwa re ID code. T he

4 - 27


S2-RT User's Manual

OPERATION

Figure 4-8: Sample ROS Screen, Mark III

12 user digits a re taken from the first 12 characters of user i nfo field 1. Only digits from 0 to 9 are allowed, any other character is mapped to hex b. It is advisable to avoid too ma ny zeroes in a row i n t he auxilia ry data. T he hardware ID code at the end of the auxilia ry data stri ng is set at record time using the mk3 hwid command. The default value can be set i n t he defaults file using the mk3hwid parameter (initially set to 52 for ``S2''). The Mark III auxiliary data will be all 0's if t he S2 decoder cannot properly extract playback auxilia ry data. Form CRC: Form output: Shows t he Mark III 12-bit cyclical redundancy check being encoded, similar to a Mark III decoder's front-panel display. Shows which S2 user data cha nnels are active at t he Mark III formatter output. T his is similar to the ``C2 data out'' display in the User I/O window. Because t here is only one decoder i n a n RT, this may be a subset of the potentially active channels. Also i ndicates whether playback or record (feed-t hrough) data is being used. Shows t he Mark III/IV formatter frame rate, which depends on the S2 user cha nnel data rate: 200 Hz for 4 Mbit/s data (Mark III), 400 Hz for 8 Mbit/s data, a nd 800 Hz for 16 Mbit/s data (Mark IV). Shows t he number of deliberately incorrect CRCs generated since the last status reset comma nd. The S2 softwa re deliberately generates an invalid CRC whenever t he S2 decoder is not able to properly extract playback time or auxilia ry data. (The S2 hardware also automatically invalidates t he Mark III parity bits whenever t he data valid signal is low.) T his is the user data cha nnel currently being tested by t he Mark III sy nc detector (next line) and data extractor. Only one cha nnel is tested at a time. Shows t he percentage of valid sy nc detected over the previous one-second by a special Mark III sy nc detect circuit. T his circuit counts valid sy ncs i n one output cha nnel of the Mark III formatter. T he number display ed i n brackets gives a cumulative count of the number of Mark III frames with i ng/excess sy nc since the last status reset command. period found squa re miss-

Frame rate:

Bad CRCs:

Test cha n: Sy nc detect:

4 - 28


S2-RT User's Manual

OPERATION

4.2.9 Console Command Descriptions
T his section explai ns each console command and its parameters. Comma nds a re listed alphabetically, or to fi nd a specific comma nd use the i ndex. Vi rtually all commands that set some kind of switch, register, or mode follow a general convention that the command wit h pa rameters sets the value of the switch, a nd t he same comma nd without pa rameters displays its value wit hout cha ngi ng it. For example, t he time comma nd wit h parameters sets or adjusts t he time, while without parameters it displays t he current time. Of course, the time is also shown on t he console display. Command sy ntax is indicated by listing key words in lower-case, a nd numeric/stri ng parameters in upper-case (NUM/STR) wit h a descriptive word in a ngle brackets. T his is the same as t he conventions used by the soft-key display. Optional parameters a re enclosed in square brackets `[]' a nd lists of alternatives a re separated by vertical bars `|'. Alternatives where exactly one must be chosen a re enclosed in brace-brackets `{}'. An ellipsis `...' means t hat a portion of t he sy ntax description has been omitted. Note that a number of low-level and diagnostic commands a re not fully documented. Many console commands are not needed for regular S2 operation. Most of the ``extra'' commands are for system configuration, testing, and unusual operation modes. Importa nt commands are marked wit h ``*'' below. T hose that a re importa nt only for record applications a re marked ``*R'', and for play back applications ``*P''.

Command: align Sy ntax: align {[+|-|NNN-]NN:NN:NN[.NUM]|realign|selfalign} Description: T his is used during playback to align tapes to a n absolute time or shift by some relative amount. Tape alignment works by slewi ng t he tra nsports and (if necessary) adjusting the station delay setting. Unlike positioni ng, tape alignment is a precise operation, accurate down to t he data bit. Alignment is performed relative to a movi ng reference frame (play back), whereas positioni ng is performed relative to a stationary reference frame (stop). A fractional-seconds portion can be specified as part of the alignment time, and will be rounded to the nearest bit (sample). When playback first begins, a form of alignment called self-alignment is performed automatically. In self-alignment all transports are aligned to each ot her by choosing eit her the earliest, latest, or middle tape time as a reference -- which method to use is determined by t he selfaligntarg defaults file parameter. All t ransports must be wit hi n a limited distance of the ta rget time chosen, where t he maximum allowed time difference is given by t he selfaligntime defaults-file parameter (normally 30 mi nutes), ot herwise the alignment operation is aborted and status code STAT_ALIGNFAIL with error ERR_ALBADTIME appears. Self-alignment can also be initiated manually using the selfalign command option (in which case t he time restriction does not apply ). To skip the automatic self-alignment step, manually issue an absolute alignment or self-alignment request immediately after sta rting playback. In absolute tape alignment, t he user specifies a time to which t he S2 should align its tapes, e.g. align 14:59:02.173 T his tape time is referenced to the second it is received by the S2, i.e. it is t he tape time that would appear if the procedure was instantaneous, but in fact alignment may take several seconds or minutes, depending on t he distance to slew. Because of t he asy nchronous nature of the console, t he user should issue the absolute align command immediately followi ng a 1 Hz (output) clock tick, a nd t hat tick is taken as the reference for the absolute time contai ned in t he command. While alignment is in progress the current tape time is undefined and play back data should be considered invalid. If it takes 20 seconds to align, t hen the fi rst valid data will be

*P

4 - 29


S2-RT User's Manual

OPERATION

tagged wit h t he requested alignment time plus 20 seconds. If a fractional-seconds portion is included i n the time, t he 1 Hz output tick (S1HZ_PB on C2a cable) will shift backwa rds by the i ndicated amount, e.g. in t he above example t he S1HZ_PB tick would sta rt comi ng out 173 ms earlier. Relative tape alignment applies a signed relative offset to t he current tape time. Unlike absolute alignment, there are no special sy nchronization requirements for the command itself. However t he tapes must al ready be aligned to the same tape time or relative alignment is not allowed (if necessary type align selfalign first). For example, to shift t he tapes ahead by 29.1795453 seconds, use: align +00:00:29.1795453 The realign option can be used to re-align the tapes to t he reference time chosen during the previous alignment operation should one or more tra nsports become un-aligned, but t his form of alignment normally happens automatically. T he most common reason for a tape alignment operation to fail is t hat t he data for t he time being aligned to does not actually exist on one or more tapes. In this case the affected tra nsports might encounter bla nk tape, or an old or different recordi ng, or t hey might run i nto t he beginning or end of tape. In each case status code STAT_ALIGNFAIL will appear wit h an appropriate error code (see Page 473). Bla nk tape encountered while aligning will result i n an E nd of Data (EOD) i ndication, a nd play back will stop. EOD is defi ned as approximately 30 seconds or more of bla nk tape encountered during positioni ng or alignment (slewi ng) in t he forwa rd direction. T he affected tra nsports will be left positioned a few seconds before the actual end of data. The align command should not be used to implement delay a nd delay-rate corrections at a VLBI correlator, as this may i nterfere with the ROS automatic playback monitoring -- use t he delay comma nd i nstead. delay should be used for a ny regula r delay adjustments that fall wit hi n t he delay-rate and acceleration limits given on Page 4-33.

Command: barrelroll Sy ntax: barrelroll [on|off] Description: T his comma nd is used to turn barrel-roll on a nd off. When on, barrel-roll rotates user data over all available t ransports, and un-rotates on playback, so that the possible effect of a ma rginal t ra nsport is averaged over all cha nnels. Barrel roll has no effect a nd is considered i nactive in any modes which requi re only one t ransport, e.g. 16x1-1, 8x2-2. Barrel roll must be turned off for both record and play back to obtain correct output data when playing back tapes on a n RT, since a n RT has only one decoder a nd therefore cannot reconstruct barrel-rolled data. Duri ng auto playback, barrel roll is automatically set to t he same condition as at record, but during manual playback it must be set ma nually (use tapeinfo to show t he required barrel roll setti ng). The barrelroll defaults-file parameter gives t he default ba rrel roll setti ng to use at bootup.

Command: tapetype Sy ntax: tapetype [STR [default]|typecodes] Description: T his command is used to set which ty pe of tape is being used. Several different ty pes of tapes a re approved for use i n t he S2, and t he S2 needs to be informed which tape is being used due to differences i n magnetic properties. Tape type codes a re numbers from 1 to 9, and if additional codes are necessary t he letters from A to Z will be used. See Chapter 5 for a complete list of tape ty pes a nd t heir codes. You can get t he most up-to-date list of ty pe codes di rectly from t he S2 by typing tapetype typecodes (assuming you have the latest software version). The tapetype pa rameter in the sy stem defaults file gives the default tape type

4 - 30


S2-RT User's Manual

OPERATION

setti ng to use at bootup. Note t hat t he tape ty pe will revert to its default value as in the defaults file next time the sy stem is rebooted unless y ou specify default, which causes the defaults file to be automatically updated.

Command: batch Sy ntax: batch [[verify] STR|edit {STR|autoexec}|delete STR|log {STR|end}|ls [long]] Description: Begi ns execution of a batch file, or i nitiates other functions such as batch file editing or verification. e.g. batch myfile executes t he batch file ``myfile''. Use batch ls to obtai n a list of available batch files. If long is specified t he listing includes file sizes and modify dates. The edit option calls up a full-screen editor similar to Unix `vi' for creating new files or editi ng existi ng batch files. See Section 4.2.7 for more information on the editor. Use t he verify option after editing to quickly check t he sy ntax of the entire batch file. An alternative to editing is t he log option, e.g. batch log common T his copies all subsequent console comma nds to the file ``common'', until you ty pe batch log end. Then t he same sequence of commands can be re-executed a ny time later using batch common. T he delete option is used to erase batch files. Batch files can be chained (but not nested) simply by executing one from withi n another. To make an endless loop, have a batch file call itself. To i nterrupt a batch file, press Cntl-C once.

Command: beep Sy ntax: beep [NUM|on|off] Description: Causes the console terminal to beep, or turns beeping on a nd off. May be useful i n batch files.

Command: boxmode Sy ntax: boxmode [s2|c16|bita NUM|STR] Description: For diagnostic use only. Downloads a Xili nx device connected to t he UI boa rd external download port.

Command: clear Sy ntax: clear Description: Clears t he console interaction window.

Command: config Sy ntax: config {{save|restore|verify|delete} STR|ls [long]} Description: Saves or restores the current S2 configuration, which i ncludes most sy stem switch setti ngs except the tra nsport tape motion state. This is useful to take a ``snapshot'' of the sy stem so that it can be restored later. Configurations can be named, or if no name is given the name `default' is used. The verify option can be used to test t he integrity of a saved configuration. Softwa re updates, in particular, may render existi ng configurations i nvalid. Use t he ls option to list existi ng configu-

4 - 31


S2-RT User's Manual

OPERATION

rations, with long to include file sizes figurations. The configuration save a rea i ncludes mation that were dumped using the tofile command, or automatically by

a nd dates. Use delete to erase confiles contai ning transport service infortransport service dumpmem t he system (see Section 4.).

Command: cue Sy ntax: cue Description: Puts t he currently selected tra nsports into a forward movement state that is about 9 times faster tha n play back, but slower t ha n fast-forwa rd. This command serves no significant purpose in normal operation a nd should be avoided. Use t he position command i nstead to perform tape positioning. The S2 must currently be i n playback otherwise cue is not allowed. Also must not currently be aligni ng or positioni ng. Use uncue to stop cueing a nd return to normal play.

Command: def Sy ntax: def {auxsnap|statsnap|accumulate|syncerrlocate [histogram [NUM NUM [NUM {s|m}]] [cumulative [NUM]] [log10]|enable|disable|errtrigger [NUM|off]]|xbar [SSSSSSSS]|{drand|dhook|dprec|usrdv} [on|off]|reset} Description: Sets/displays low-level deformatter cont rol options a nd switches. Strictly for diagnostic use only. T he auxsnap, statsnap, and accumulate options display raw auxiliary data and deformatter status in various formats. T he syncerrlocate option is a data gat hering and graphi ng facility which shows how errors a re dist ributed across tape frames. It must first be enabled, then error location histograms can be displayed. Note: You should use ma nual playback a nd be setup to t he transport i n question when using the sy ncerrlocate facility. T he histogram has various options such as display ra nge limits, running time limit, cumulative display, exponential averaging, and loga rit hmic display. Cumulative values are reset each time t he histogram is displayed except when cumulative is used alone without exponential averagi ng or a time limit, allowi ng data accumulation i n t he ``background''. See Section 6.4.6 for an example use of the sy ncerrlocate histogram. drand and dprec cont rol the de-randomizer and de-precoder. xbar sets t he DRD crossba r, which determines t he mapping of transports onto i nternal S2 data channels 0­7. The dhook option can be used to select digital direct-hookup, but use setup dhook i nstead. usrdv cont rols the low-level switch used to implement user data-valid (see user dv).

Command: default Sy ntax: default {STR [STRA|blank] | fromfile STR|tofile STR} Description: T his comma nd can be used in place of the edit defaults comma nd to directly view or modify parameters i n the sy stem defaults file. T his may be desirable if you don't feel comfortable using t he editor (which is similar to Unix vi). T he defaults file contains ma ny sy stem startup options a nd parameters which allow users to customize S2 behaviour for t heir environment. Appendix C contai ns an example defaults file. Each default pa rameter is documented right i n t he file a nd should be self-explanatory. Entering the name of a default parameter wit hout a nyt hing after it displays its current value, e.g. default tapetype Specify i ng a new value for a parameter updates t he defaults file accordingly, e.g. default tapetype 3 To clear a parameter's value, use t he word blank. Note that you cannot add new

4 - 32


S2-RT User's Manual

OPERATION

parameters or delete existi ng pa rameters in t his way (use edit defaults for that). The fromfile and tofile options allow you to transfer t he entire defaults file from, or to, a remote host over the network by specify i ng an appropriate remote file name. The remote host must be configured to accept RSH requests (or FTP logi ns) from t he S2 sy stem, a nd the host name/address a nd RSH userid (or FTP userid & passwd) must be entered in the S2 boot parameters (see Section 4.4.1). Changes to the defaults file take effect only after the next sy stem boot.
*

Command: delay Sy ntax: delay [NUM] [s|ms|us|ns|bits] [relative] Description: Sets t he station delay i n absolute or relative terms. In absolute terms, t his provides a positive or negative offset of up to 1/2 second between the external 1 Hz reference a nd t he S2 i nternal 1 Hz timing. Relative delay setting is i ndicated by adding t he word ``relative'', a nd does not require the presence of an external 1 Hz reference, whereas absolute setti ng does. Duri ng recording, t he station delay determines the offset between the user's 1 Hz reference (S1HZ_REC on C1 cable or C1HZ on C2 cable) and t he time used to label the bits on tape. During playback, t he station delay determi nes t he offset between t he user's 1 Hz reference a nd when t he corresponding data bit is output on the C2 cable. BNC jacks labeled 1Hz-REC a nd 1Hz-PB are provided on the S2 DSCM front panel for user measurement of t he S2 internal 1 Hz tick (the appropriate jack should be used whether i n record or playback). The S2 performs its own measurement of the station delay, which is display ed i n t he Crucial Parms window. T he delay amount can be expressed i n units of seconds, milliseconds, microseconds, nanoseconds, or bits (samples) at t he current user data rate, a nd can be entered as a floati ng-point number. T he exact delay range limits are from -0.5 seconds to one bit short of +0.5 seconds for absolute delays, a nd one bit short of -1.0 second to one bit short of +1.0 second for relative delays. All delay settings a re rounded off to t he nearest bit. T he value displayed by the delay comma nd i ndicates the actual absolute delay implemented, after rounding. Since t he station delay value shown i n t he Crucial Parms window is a measurement, it may not match the latest delay setti ng in the event of a timi ng glitch or other similar event (see ``Station delay'', Page 4-18). The two values also will not match in System Clock PLL 1hz lock mode, but should be within a few hundred sample times. To show the latest delay setting, use the delay command wit hout a ny parameters. Non-zero station delays can be used duri ng record operation to implement clock offsets a nd corrections. T he Sy stem Clock PLL mode must be refclk (lock to external high-rate clock). Delay offsets should be entered prior to sta rti ng recording, since changing t he station delay while recording has a de-stabilizing effect on t he enti re sy stem timi ng, a nd may result in several seconds of lost data. Duri ng playback the delay comma nd (or its RCL equivalent DELAY_SET) can be used to implement delay a nd delay-rate tracking if t he Sy stem Clock PLL is set to 1hz mode (lock to external 1 Hz). Small delay changes will result in a smooth, gradual movement to t he new value with all sy stem timing and data remaining conti nuously valid. A typical application would be to have several S2-PTs at a correlation center fed by a common fixed 1 Hz reference, with DELAY_SET commands sent over t he RCL to each PT for delay t racking. System timing a nd data remai ns valid provided that the followi ng limits are met: Max. delay rate: ± 1 x 10-3 s/s Max. delay acceleration: ± 1 x 10-6 s/s2 Max. delay step at 0 delay rate: ± 1 x 10-5 s You should use the align comma nd i nstead of delay for large delay cha nges t hat would exceed t hese limits. Exceeding t he limits may cause STAT_SCPLLSLIP a nd/or STAT_SCPLLUNLOCK status messages indicating that t he SC PLL is con-

4 - 33


S2-RT User's Manual

OPERATION

sidered unlocked (difference between delay setting a nd delay measurement greater t han about 6 x 10-5 s). Smooth delay tracking is still attempted, alt hough i nternal timing problems resulti ng in loss of playback data become more likely i n this situation. Smoot h delay t racki ng is suspended for delay errors or steps greater than about 3 x 10-3 s, at which time phase-offsetti ng is used to adjust the delay (hence t here will definitely be a glitch in t he play back data). Phase-offsetting can be disabled by setting t he SC PLL type to purephase. For detailed information on S2 timi ng a nd playback rate control facilities please refer to the followi ng document: ISTS-SGL-TR94-030, ``Timi ng and Sy nchronization in S2 Record and Play back Terminals'' (available at ftp://ftp.sgl.crestech.ca/pub/s2/doc/timing/timing.ps.Z). See also the ERRMES RCL command for a n alternate delay tracking method (Page A22), a nd the description of t he STAT_SCPLLSLIP status message on Page 4-68.

Command: diag Sy ntax: diag {{self1|syncaux|formberc|uicberc|dcbias|drdxbar|mk3sync} [verbose]|pgstress|decode NUM} Description: Initiates S2 diagnostic sequences or decodes diagnostic result codes. The decode option can be used to translate numeric diagnostic codes, sometimes found in t he status wi ndow followi ng t he power-on self-test. The remaining options initiate specific diagnostic sequences. T he self1 option can be used to ma nually re-execute t he power-on self-test (ty pe diag self1 verbose). Wit hout the verbose option, diagnostic sequences display a formal diagnostic result message (single-fault only). Wit h verbose, different output is produced that is more suitable for i nteractive use. Most diagnostic sequences a re not allowed during automatic record or playback. All of t he sequences except dcbias and mk3sync run as part of t he power-on self test. T he syncaux test checks for the presence of sync and auxilia ry data i n all channels of the current diagnostic loopback pat h. It tests i nternal 16 Mbit/s data channels, not user data channels, and works in a ny of the following setups: dhook, ahook, bypass, record. In paths that go through t he t ra nsports, channels for which t he transport is not currently selected a re not tested. This test is roughly equivalent to ma nually entering setup N and group M for each available channel and group, a nd checking t he ``Decoded time'' a nd ``Decoder sy nc'' displays. T he formberc test uses the Formatter diagnostic test vector (form diag mode) a nd bit-error counter to check t hat all channels of t he current diagnostic loopback path contai n (near-) perfect data. It tests internal 16 Mbit/s data channels, not user channels, a nd works in any of the followi ng setups: dhook, ahook, bypass, record. In paths t hat go t hrough t he transports, channels for which the t ransport is not currently selected are not tested. This test assumes that diag syncaux has al ready been run successfully. diag formberc is roughly equivalent to ma nually enteri ng setup N and group M for each available cha nnel a nd group, a nd checki ng t he bit-error rate with form berc. However, it is not able to spend enough time on each cha nnel to detect a nyt hing except gross failures. The uicberc test uses the UI bit-error counter to check t hat all active or potentially active user data channels contai n (near-) perfect data. It requires that t he S2 is currently being fed and/or is outputting t he UI diagnostic test vector. To inject the UI test vector, attach a n appropriate external test data generator or switch to one of the UI diagnostic modes (e.g. mode diag8) or one of t he C2 cable test modes. diag uicberc tests user data channels on the UI board, not just internal data cha nnels, and works in any of the followi ng setups: dhook, ahook, bypass. The UI feedt hru switch may be on or off -- if on, t he current setup doesn't matter. The Mk3 formatter must not be active. Note t hat no 32 Mbit/s modes will work unless feedthru is on because each 32 Mbit/s cha nnel requires two i nternal 16 Mbit/s cha nnels, and t here is always only a single internal diagnostic path (even i n PTs), hence it is not possible to reconstruct 32 Mbit/s data. For similar reasons,

4 - 34


S2-RT User's Manual

OPERATION

t his test also won't work with ba rrel roll on. diag uicberc is roughly equivalent to manually checki ng the bit-error rate with uic berc N for each potentially active user data channel, switching the setup using setup N if necessary to adjust t he coverage of user output cha nnels. Like diag formberc, diag uicberc is not able to spend enough time on each channel to detect a nyt hi ng except gross failures. T he dcbias test uses the UI DC bias counter to check t hat all active or potentially active user data channels contain approximately random data (between 40% and 60% DC bias). In other ways, t his test is simila r to diag uicberc except t hat it also works wit h the Mk3 formatter enabled. It is roughly equivalent to manually checki ng the DC bias wit h uic dcbias N for each potentially active user data channel, switching the setup using setup N if necessary to adjust t he coverage of user output cha nnels. T he drdxbar test checks all combinations of t he (distributed) DRD crossbar switch to ensure that each DRD is capable of driving all 8 i nternal data channels (DDP). T his test detects problems t hat would otherwise be discovered only when tapes are i nserted i n a certai n unusual order. The drdxbar diagnostic is valid only on a PT (on an RT diag formberc covers t his test, so it is unnecessary). The mk3sync test checks all 14 Mark III output channels for valid sy nc using t he Mark III sy nc detector. The Mark III formatter must be enabled (mk3 form enable). T he pgstress test is a special diagnostic which plays back reference tapes a nd determines the allowable range of playback PGSHIFT offsets. Before runni ng t his test you should select the desired transports a nd i nsert official PGSHIFT reference tape(s).

Command: dnld Sy ntax: dnld {{form|drd|uictxdc|uicdddv|uicdqa|box} STR|ls [long]} Description: Explicitly downloads t he indicated Xili nx chip chai n. Strictly for diagnostic use only.

Command: dr Sy ntax: dr [cal...|reset [all] [flat]|setdefault... |pbsel [NUM]|emulin [NUM|off] | fdbkout [NUM|off]|decsel [mlsd|bitbybit]|vco|tdacsel [eye|error]|...] Description: Sets/displays low-level analog data-recovery cont rol options a nd switches. For diagnostic use only. Most of these switches a re set automatically as a result of other commands duri ng regula r operation. dr reset flat is sometimes useful to help stabilize t he data-recovery if it is having trouble calibrati ng. This can happen after updating software or re-loading t he Static RAM. The tdacsel switch selects one of two alternative output signals for t he ERRDAC test point (SMA jack) on t he DRD board front panel: eye selects the ey e pattern (decoded filtered data) while error selects a n error signal showi ng deviation from the ideal ey e pattern. T he default is eye.

Command: echo Sy ntax: echo {off|on|prompt|[STR]} Description: Writes a text message to t he console i nteraction window, useful from batch files. Also cont rols the echoing of commands from a batch file wit h the on/off options. For example, to make a batch file execute wit hout echoing, add echo off as t he fi rst command. T his will suppress bot h the pri nting of commands a nd t heir output, so if you wa nt to see a particular comma nd's output you will have to turn echoing back on. Exceptions a re the echo comma nd itself, log display, a nd

4 - 35


S2-RT User's Manual

OPERATION

status display, whose output always appears. The prompt option of echo writes out ``[Hit return to continue]'' and waits for the user to press return. For examples of how to use t he echo command, examine t he supplied demo.rt batch file. See also t he wait comma nd.

Command: edit Sy ntax: edit {defaults|termcap|startup.cmd} Description: Use this to edit one of three sy stem configuration files: defaults, termcap, a nd startup.cmd. The defaults file contai ns ma ny sy stem startup options which allow users to customize S2 behaviour for t heir envi ronment. T he termcap file contains terminal capability defi nitions in Berkeley termcap format, allowi ng users to add support for their console termi nal type if it does not al ready exist. See Section 4.2.7 for more information on these two files. T he startup.cmd file contai ns VxWorks shell comma nds to execute at boot time a nd might be used occasionally for adva nced network operation or to implement bina ry software patches. You must use only VxWorks shell comma nds (not ROS console commands), one per line. Do not use the exit shell command a nywhere i n t he startup.cmd file. T he editor invoked by the edit command is a full-screen editor similar to Unix vi (for online help type :help while in t he editor). In t he event that your terminal type is not set correctly, it may be difficult or impossible to edit. In t his case use the console term command to set the correct terminal type before editing.
*

Command: eject Sy ntax: eject Description: Ejects t he tapes from all currently selected t ransports. Stops t he S2 first if it is not al ready stopped. The S2 must not be recording or record-paused. Another way to eject all the tapes is to press and hold any tra nsport's eject button for two seconds (or more). This feature may be convenient if the console terminal is not located near the TAM racks, or the S2 is under computer (RCL) cont rol. Eject-all should preferably be used only when all t ra nsports are stopped. No other tra nsport frontpanel buttons or switches should be touched. The ejectalldisable defaults file option can be used t he disable the eject-all feature.

Command: encrypt Sy ntax: encrypt STR Description: T his command encodes a password to be used when connecting to the console using rlogi n or telnet. Type t he desired password and t he encrypted version of t he password will be displayed. T hen enter t he encrypted stri ng as the value of the loginpasswd pa rameter in t he defaults file. Along with loginuserid, this defines t he user-ID and password that must be entered when connecting via rlogin or telnet.

Command: error Sy ntax: error decode NUM Description: Used to tra nslate numeric error codes which may occasionally appear in t he status wi ndow to their correspondi ng text message. For a complete list of error codes see Page A-32. All ROS error codes a re negative numbers. Positive numbers a re not error codes, but may be status codes or diagnostic codes -- see also status decode a nd diag decode.

4 - 36


S2-RT User's Manual

OPERATION

Command: expert Sy ntax: expert [on|off] Description: Sets expert mode which cont rols whether or not non-essential and diagnostic console comma nds are suppressed. When expert mode is off (expert off), commands a nd options not needed for regular S2 operation do not appear in the console softkey display a nd may not be entered. This is useful when fi rst learning to operate t he S2 or to prevent inappropriate commands from being entered duri ng regular use. When expert mode is on, all S2 console commands and options a re available. Expert mode does not affect batch files or the RCL. The expert defaults-file parameter determi nes the default expert mode setting to use at bootup.

Command: ff Sy ntax: ff Description: Fast-forward winds the tapes. Stops playback first if necessary and automatically switches to t he stop setup (normally bypass). T he S2 must be in stop, play, playpause, or rewind state ot herwise fast-forward is not allowed. Also must not currently be aligni ng or positioni ng.

Command: form Sy ntax: form [diag [on|off]|berc [NUM|rotate] [NUM { frms|s|m|h}] [undetected] [log]|rand [on|off]|prec [on|off]|insw [1|2|4|8]|outdis [{NUM|all} {enable|disable}]|stuck ...|ddpsel [NUM]|frdsel [NUM]|rclk [on|off]|fdbksel [transpt| form]|fsync [rec|pb]|...] Description: Controls t he Formatter Test Vector Generator a nd Test Vector Receiver, a nd sets ot her low-level Formatter control options a nd switches. T he form comma nd by itself switches to the Formatter display wi ndow (replaces User Parms wi ndow, repeat t he command to switch back). The diag option selects Formatter ``diag'' mode which causes user data to be replaced by a pseudo-random noise sequence produced by a Test Vector Generator on t he Formatter board. T he test vector sequence can be verified wit h t he form berc comma nd which uses the Formatter Test Vector Receiver to perform a t rue bit-error rate measurement on one 16 Mbit/s i nternal S2 data cha nnel. T he Formatter test vector is a 127 bit maximal-length pseudo-ra ndom sequence that gets reset synchronous to t he sy stem 1 Hz tick, a nd like all data it is randomized before being written to tape. It can be used directly to check S2 internal data loopback paths or to record a nd verify test tapes. Note t hat form berc will automatically turn on Formatter diag mode for the duration of the measurement unless t he S2 is in record or playback, so the form diag comma nd is really only needed i n preparation for recording test tapes. The Formatter test vector tests only i nternal S2 data pat hs from the Formatter to t he DRD outputs, in particular it does not test UI functionality. A second type of test sequence is available on t he UI boa rd which can perform bit-error rate measurements of either user-supplied or i nternally generated UI test vector data (see t he uic berc comma nd). T he rclk option activates a crystal oscillator on the Formatter, t hus allowi ng t he sy stem to run without a UI boa rd. T his should never be used for regula r operation.

Command: group Sy ntax: group [NUM] Description: Selects which group of tra nsports should be used in modes that don't require all 8 transports. For example, in mode 16x2-1 (which requires only 2 t ransports) t here a re 4 groups. Transports 0­1 are ``group 0'', t ra nsports 2­3 are ``group 1'', a nd
4 - 37


S2-RT User's Manual

OPERATION

so on (Figure 4-3). Together t he mode and group settings determi ne which transports will be used for subsequent operations. Group switching allows the unattended recordi ng time to be increased at lower bandwidths, e.g. wit h ST-182 tape i n mode 16x2-1 (32 Mbits/s) at speed LP t he unattended recording time is 22.8 hours. T he group command is not allowed to cha nge t he group number duri ng regular (automatic) playback or record (stop the S2 between group cha nges). T his comma nd is typically used followi ng a mode command.

Command: help Sy ntax: help [STR] Description: Lists all available console comma nds, or provides a brief one-line description of a specific comma nd.

Command: log Sy ntax: log [clear|stop|start|echo [STR]|display {[STR] [NUM|tail] [fullscreen|tofile STR]|typecodes}|auto {dv|timing} [enable|disable] |entry veri fier] Description: Controls t he ROS internal log facility. T he log is a time-stamped list of status changes and other events accumulated duri ng all modes of operation. It is a circular list so that when t he log is full t he oldest ent ries are gradually overwritten. When using the console, t he log is useful to keep a concrete record of unusual events without t he need for conti nuous operator vigilance. It is a diagnostic facility only a nd does not replace the normal VLBI observation log. Logging would typically be used as follows. First, before starting a new sequence of S2 operations, t he log may optionally be cleared using log clear If you don't clear the log you may have to look t hrough a lot of old log entries later. At any time during or after a sequence of operations use log display to show t he contents of t he log in time order. Entries a re coded using upper-case letters, and t hese type codes can be used for filteri ng the display, e.g. use log display S to show only messages derived from sy stem status, or log display ^ST to show everything except status and timi ng-related messages. Enter log display typecodes for a list of the different log ty pe codes. T he tail option is useful to show just t he most recent part of the log, or you can enter a li ne number at which to start displayi ng the log. Wit h the fullscreen option t he log display occupies t he enti re console screen instead of just the interaction window. T his can be used to capture t he log to a file if your termi nal emulator has that capability (e.g. i n ROSCO press shift-F9 followed by F2 to begin capturing incoming cha racters to a file). It is also possible to t ra nsfer log files over t he network (see t he tofile option, below). Use t he stop and start options to temporarily halt a nd conti nue logging. The log comma nd by itself shows whether logging is active a nd gives t he current size of the log file. The maximum log file size is 350K or roughly 6000 average-size log entries. If this limit is exceeded the oldest log entries will be overwritten i n a circular fashion. T he log file is kept i n battery backed-up SRAM, so it will survive crashes and power failures. Note t hat log clear automatically restarts logging if it is stopped. T he tofile option can be used to transfer log files (or parts thereof) over the network to a remote host by specifyi ng an appropriate desti nation file name if your S2 sy stem is equipped with an Et hernet board. The remote host must be configured to accept RSH requests (or FTP logins) from t he S2 sy stem, and t he host name/address a nd RSH userid (or FTP userid & passwd) must be entered in t he S2 boot parameters (see Sec-

4 - 38


S2-RT User's Manual

OPERATION

tion 4.4.1). A command to transfer the log file might look something like this: log display tofile host.name:/local/s2/logs/log941214 T he host name with a colon is VxWorks' sy ntax for remote files.

Command: logou t Sy ntax: logout Description: Closes t he connection when accessing the console via t he optional ethernet boa rd using rlogin or telnet. S2 operation is not disturbed i n a ny way, and display output reverts to the console serial port. A typical use of this is to monitor one or more S2 sy stems from a networked workstation, calling up t heir console displays only when needed using rlogin or telnet. You can force an rlogin or telnet connection to be closed from the serial console by typing cntl-C cntl-C cntl-] i n quick succession (do not use this cont rol sequence at any other time).
*P

Command: mk3 Sy ntax: mk3 [form [enable|disable|errinduce {sync|crc} NUM NUM|showframe [NUM]|clkin v [posmidcell|negmidcell]]|hwid [SS]|dataextract [synctrig|1hztrig] NUM NUM|dcbias NUM [NUM {s|m|h} [NUM]] [le vel|edge]|testchan [NUM]|nrzm [on|off]] Description: Sets/displays Mark III cont rol options and switches. The S2 UI board includes a Mark III/IV formatter which provides the capability to output S2 data in Mark III format, allowi ng di rect playback of S2 tapes at Mark III/IV compatible correlators. Note t hat this only reformats data as it is output, i.e. the recorded data does not contai n Mark III format. The comma nd mk3 form enable turns on the Mark III formatter a nd switches the C2a cable output to Mark III/IV compatible mode. Depending on the current S2 mode t he cha nnel data rate will eit her be 4.5, 9, or 18 Mbits/s, wit h correspondi ng Mark III/IV frame rates of 200, 400, a nd 800 Hz. T he output data is NRZM encoded just like a real Mark III playback termi nal. The mk3 comma nd by itself switches to t he Mark III formatter display wi ndow (replaces t he User Parms wi ndow, repeat t he command to switch back). The form clkinv option can be used to switch t he phase of t he output clock to have eit her the positive clock edge or the negative clock edge appear at data mid-cell, depending on the requirements of t he destination equipment (default is positive edge at mid-cell). T he hwid option is used to set t he two-hex-digit Mark III hardware-ID code encoded on tape and to display its value on play back. The hardware-ID facility is provided for compatibility wit h Mark III VLBI operations and should be used at record time to label the tapes with t he correct ha rdwa re ID, even though t he Mark III formatter itself may be off, so t hat the correct ha rdwa re ID gets used at playback. The default ha rdwa re ID is 52, for ``S2'', but may be set as desired i n t he system defaults file. When fi nished, use mk3 form disable to turn off the Mark III formatter a nd return to regula r S2 operation. T he remaining comma nd options a re for low-level diagnostic use. The dcbias a nd dataextract options a re similar to the same options of t he uic command, except they examine formatted Mark III/IV data. The errinduce option is useful when testing the interface to external Mark III/IV equipment such as a correlator or decoder. A given number of conse cutive frames wit h sync-word or CRC errors can be i ntroduced, sta rti ng at a particular frame number. Wit h errinduce sync t he usual Mark III sync word 0xffff ffff is replaced by t he invalid sy nc word 0x55555555, a nd with errinduce crc the 12-bit CRC field is replaced by an

4 - 39


S2-RT User's Manual

OPERATION

i nvalid CRC value. Note that the S2 also invalidates t he Mark III CRC field duri ng playback whenever the auxiliary data extracted from S2 tapes is i nvalid.
*

Command: mode Sy ntax: mode [32x4-1|...|4x4-2|c1test16|c2test8|diag4|...] Description: Sets t he S2 recorder mode, which cont rols t he user data cha nnelization and bit rate (sample rate). The S2 supports up to 16 cha nnels of user data at 4, 8, 16, or 32 Mbits/s with a maximum total data rate of 128 Mbits/s. The mode setting, i n conjunction wit h the group setti ng, determi nes which t ransports will be active. T he mode should be set prior to recording or play back. For playback, any mode can be chosen as long as it has t he same total data rate as the mode used for recordi ng, so that the correct number of t ransports is selected. T he precise mode will be set automatically after playback starts. T here are 51 modes i n total, 12 of which a re test modes. T he complete list is as follows: S2 modes: 4x4-1, 4x8-1, 4x16-1, 4x4-2, 4x8-2, 4x16-2, 8x2-1, 8x4-1, 8x8-1, 8x16-1, 8x2-2, 8x4-2, 8x8-2, 8x16-2, 16x1-1, 16x2-1, 16x4-1, 16x8-1, 16x2-2, 16x4-2, 16x8-2, 32x1-1, 32x2-1, 32x4-1, 32x2-2, 32x4-2, 4i8-1, 8i4-1, 8i8-1, 16i4-1, 16i8-1, 4p8-2, 8p8-2, 16p8-2, 8d16-2, 8n16-2, 16v8-2, 32a4-2, 32b4-2 Test modes: c1test4, c1test8, c1test16, c1test32, c2test4, c2test8, c2test16, c2test32, diag4, diag8, diag16, diag32 S2 mode designators are a string of t he form btu-q where b is t he user cha nnel bit-rate i n Mbits/s, u is the number of user data channels, and q is the qua ntization (1 or 2 bit). The designator t is a letter such as `x', `i', `p', `a', or others. `x' i ndicates a regula r S2 mode wit h user cha nnels assigned consecutively sta rti ng at 0. `i' stands for interleaved (every second channel used), and `p' stands for partitioned (channels divided into 2 groups: 0-7 and 8-15). Other letters have other i nterpretations. Table B-5 shows which user channels are active i n each S2 mode. Some S2 modes exist specifically to support certai n VLBI equipment combinations, i ncluding the VSOP a nd RadioAstron Space VLBI missions. Additional documentation on modes for specific applications is available upon request from CRESTech/SGL, and from our FTP site ftp://ftp.sgl.crestech.ca/ . In addition to t he numerous regular operational modes, t here are 3 types of test modes, each available at various data rates. The c1test modes a re used in record applications to verify proper connection of t he C1 cable. The user's external equipment must be capable of generating the prescribed UI test vector sequence. T he presence of STAT_UICVERFAIL status errors while in C1 test mode i ndicates a C1 cable fault. T he c2test modes are used in playback applications to verify proper connection of t he C2 cable. T he user's external equipment must be capable of verifying t he UI test vector sequence generated by t he S2. Finally, the diag modes inject the UI test vector at the UI data inputs for S2 internal testing purposes, replacing a ny user C1 data. (This is similar to the form diag on command, but uses a different test sequence). Use t he uic berc command to verify t he UI test vector. Unlike regular modes, the test modes do not have a firm notion of total bandwidth, so t he defaults file parameter diagnumtran is used to control t he associated bandwidth, i.e. how ma ny t ransports to test. diagnumtran should be set to the number of tra nsports being used wit h a pa rticula r S2 sy stem (nor-

4 - 40


S2-RT User's Manual

OPERATION

mally 8). T he mode comma nd is not allowed during regular (automatic) play back, a nd can only be used to cha nge to modes wit h the same total data rate during automatic record. For any other mode cha nges, the S2 must be stopped fi rst. T he dfltmode defaults-file parameter determines t he i nitial recorder mode to use at bootup.

Command: pause Sy ntax: pause Description: Puts the S2 recorder into play-pause or record-pause state. For normal operation t his provides no appreciable benefits a nd should not be used -- use stop instead. T he S2 must currently be recording or play ing (and must not be aligning or positioning). Unlike stop, time spent in pause counts agai nst head lifetime. To prevent excessive head and tape wear, t he t ra nsports automatically stop after pausing for more t ha n about 3 minutes.
*

Command: play Sy ntax: play [ manual] Description: Starts playback. T he recorder must be stopped, rewinding, or fast-forwarding, ot herwise t he play command is not allowed. Tape alignment (self-alignment) is performed automatically to align the i ndividual t ransports to each other and to obtain a single, coherent tape time. After t his the user may issue align comma nds to further align the recorder to a desired epoch, or delay commands (or RCL ERRMES commands) to perform VLBI delay tracking. During playback the softwa re monitors active t ra nsports and scans for abnormal conditions. Anythi ng unusual is reported i n the console Status window. Some of t he diagnostic checks i nclude: ­ Playback sync a nd auxilia ry data valid, i ncluding tape time ­ Tape alignment mai ntained (automatically re-align if alignment lost) ­ Auxiliary data consistent, no missing/duplicate channel IDs ­ Current mode matches mode at record time (if not, switch) ­ Current barrel roll setting matches record setting (if not, switch) As indicated by t he last two items above, duri ng playback the correct mode a nd ba rrel roll setti ngs a re selected automatically. In special circumstances it may be desirable to play back using a mode that is different from the mode used at record time. The playmodemap defaults-file parameter provides t his capability, wit h t he restriction that both the origi nal and the new playback mode must have the same total data rate. The manual option suppresses most of the regular play back monitoring a nd scanni ng, including automatic actions such as tape alignment a nd mode setting. It is useful to ma nually examine particular play back channels, but should not be used for regula r operation. Note: When automatic playback first starts, one of t he fi rst steps is to scan all t ransports for auxilia ry data. If for any reason auxiliary data cannot be obtained from one or more t ra nsports, automatic tape-alignment will not be attempted. To force tape alignment issue a manual alignment request, e.g. align selfalign. See also t he general description of how to play back tapes i n Section 4.2.4.2.

Command: position Sy ntax: position [[+|-]NUM:NN:NN ...|reestablish] Description: T his comma nd is used before playback or record to position the tapes to a specific location. Tape position is measured as the number of seconds of recorded data since t he beginning of tape, a nd is normally specified as hours:mi nutes:seconds,

4 - 41


S2-RT User's Manual

OPERATION

e.g. position 3:18:57 T his format is simila r to a tape time except that the hours portion normally includes only a single digit. Alternately, t he position may be entered as a n i nteger number of seconds (rega rdless of t he setti ng of the posdisformat defaults file parameter), e.g. position 11937 T he current position is considered unknown after a tape is inserted or after t he t ransports a re fi rst turned on. The position becomes known when a transport encounters begi nni ng-of-tape (BOT), where the position is defined to be 0 (i.e. 0:00:00)5. Positions are normally positive for purposes of the position command, but the current position readi ng can take on small negative values due to a nomalies a round BOT. It is important to realize that sections of blank tape do not count in position determination. For example, on a tape which has only one hour of data recorded on it, the position 2:00:00 (2 hours) does not exist. An attempt to reach that position will result in a n End of Data (EOD) indication, a nd t he actual position will be left a few seconds before t he end of data (around 1:00:00 for this example). EOD is defined as approximately 30 seconds or more of bla nk tape encountered during positioni ng or alignment (slewi ng) in the forwa rd direction. Duri ng positioni ng the State window shows POSITIONING. Alt hough t here may be up to 8 tapes a nd t herefore 8 different positions, we try to work with a single position value whenever possible since t he group of currently active transports will usually be i n almost the same location. If it becomes necessary to specify different positions for i ndividual transports, more than one position value can be given on t he comma nd line. Each successive position applies to t he next selected t ransport, a nd if not enough positions are given the fi rst value is re-used. e.g. In mode 16x4-1, group 1 (tra nsports 4 t hrough 7 selected) if t hree position values a re given t hey apply to tra nsports 4, 5 and 6 respectively, and transport 7 re-uses t he first value. T here a re two ways to perform positioning: absolute a nd relative. In addition, t here are two special positioning functions reestablish and preset6. Absolute positioning moves t he tapes to a specific position regardless of t heir current location. If the current position is not known, the tapes are fi rst automatically rewound to t he begi nni ng. Relative positioni ng moves the tapes a given amount relative to t heir current position, a nd is indicated by a plus or mi nus sign. The current position does not need to be known for relative positioning to proceed. Positive position values (``+'') move forward, a nd negative values (``-'') move backwa rd. Relative positioni ng may not work for small values (5 seconds or less), and repeated relative offsets may i ntroduce cumulative errors and thus not add up exactly to the expected total. The position reestablish option allows an unknown position to be determined wit hout moving t he tapes to a specific absolute location. The tapes a re rewound and then automatically returned to their original position, as computed from the distance covered during rewind, a nd the position is again considered known. This may be useful following a power failure when t he S2 has lost t rack of the current tape position, or when non-rewound tapes are i nserted. It can also be used to accurately re-determine the current position if cumulative errors have built up in the position measurement after a long period of repetitive tape activity.

5 6

The position ``preset'' feature will also make the position known. The preset function is not available with this command, see transport position.

4 - 42


S2-RT User's Manual

OPERATION

Command: powerm on Sy ntax: powermon Description: Display s measurements of t he VME DC power supply voltages, nominally +5 V, -5.2 V, +12 V, and -12 V. The measurements are made using a n A/D converter on t he Formatter board. If a ny of these voltages should ever exceed ±5% of nominal, status code STAT_VMEPOWFAIL will appear (```VME xxx power supply bad'').
*R

Command: record Sy ntax: record [ manual] Description: Starts recordi ng. T he S2 must currently be stopped otherwise the record comma nd is not allowed. The physical write-protect tabs on t he VHS cassettes must be intact for recording to be possible. If a ny tabs a re broken, t he write-protected tapes will be automatically ejected by t he transports (model AG2510) or t he t ransports will beep 7 times and refuse to go i nto record (models AG2520 and AG2530) or t he t ransport tape display will flash a nd they will refuse to go into record (model AG2550). In all cases t he S2 status will i ndicate STAT_RPMONILSTATE, ``Unexpected t ra nsport state cha nge during play/record''. Since breaking the record tabs will not normally be part of VLBI operational procedures, an alternate way to prevent accidental erasure of tapes is provided by setti ng t he writeprotect option i n t he system defaults file to ``on''. While recording the S2 monitors t he active tra nsports a nd scans for abnormal conditions. Anythi ng unusual is reported i n t he system Status window. Some of t he diagnostic checks include: ­ Tra nsport servos locked ­ Tra nsport record signal levels wit hin allowed ra nge ­ Record loopback data contains valid sy nc and auxiliary data, i ncl. time The manual option suppresses most of the automatic monitori ng a nd scanning, allowing ma nual examination of particular record channels. See also t he general description of how to record tapes in Section 4.2.4.1.

Command: review Sy ntax: review Description: Puts the currently selected t ransports i nto a reverse movement state t hat is about 9 times faster than playback, but slower t ha n rewi nd. This comma nd serves no significant purpose i n normal operation and should be avoided. Use t he position command instead to perform tape positioni ng. The S2 must currently be in play back ot herwise review is not allowed. Also must not currently be aligning or positioning. Use unreview to stop reviewing a nd return to normal play.
*

Command: rewind Sy ntax: rewind Description: Rewinds t he tapes. Stops playback first if necessary and automatically switches to t he stop setup (normally bypass). The S2 must be in stop, play, play-pause, or fast-forwa rd state otherwise rewind is not allowed. Also must not currently be aligni ng or positioni ng.

Command: scan Sy ntax: scan [aux [nomap]|time] Description: T his command is for use during ma nual playback only. It scans all active t ransports to acquire valid tape time a nd/or auxiliary data. If no options a re specified, aux

4 - 43


S2-RT User's Manual

OPERATION

is the default, which means to scan for complete time and auxilia ry data. aux nomap is similar but doesn't try to establish the DRD crossba r mappi ng and may work better in difficult situations. T he time option means just scan for tape time, which is easier to acqui re than complete auxilia ry data.

Command: scpll Sy ntax: scpll {mode [refclk|1hz|errmes|xtal|manual]|type [phase|purephase|freq]|dac [NUM]|div [NUM< freq>]} Description: Sets/displays pa rameters associated wit h the System Clock Phase-Lock Loop (SC PLL). This phase-lock loop is located on the UI board and drives all S2 system timing based one of several possible types of user lock-reference signals. Only the mode option of t he scpll command should be used in regula r operation -- t he ot hers a re for testi ng a nd diagnostics. T he Sy stem Clock PLL mode cont rols t he PLL's lock reference, which can be one of refclk, 1hz, errmes, xtal, or manual. T he SC PLL is normally locked to an external high-rate reference clock duri ng record (refclk), or to a 1 Hz or softwa re reference for playback rate cont rol at a correlator (1hz or errmes). T he PLL can also run independently based on an i nternal crystal oscillator (xtal) or be controlled ma nually for testi ng (manual). T he SC PLL mode should be set as needed wit h t he system defaults file scpllmode parameter and t hereafter should not normally need to be cha nged. Alt hough it is not an option of t his comma nd, auto can be used in the defaults file to automatically select refclk mode if an external high-rate reference clock is present at bootup a nd xtal otherwise. See also userio clkin, which selects t he source of t he high-rate and 1 Hz i nput reference clocks (C1 or C2 cable) and sets t he expected frequency of the high-rate clock (4, 8, 16, 32 MHz, or followdata). Note: t he high-rate reference is used only in SC PLL refclk mode. For detailed i nformation on S2 timi ng a nd play back rate cont rol facilities please refer to t he document ISTSSGL-TR94-030, ``Timing a nd Synchronization in S2 Record and Play back Terminals'' (available at ftp://ftp.sgl.crestech.ca/pub/s2/doc/timing/timing.ps.Z). The type option controls t he behaviour of the SC PLL when i n 1hz mode only. Normally the ty pe is phase which indicates phase-locki ng wit h ``phaseoffsetting'' enabled. Phase offsetti ng is simply a sudden jump i n the PLL phase implemented via a station delay setti ng sequence when t he difference between t he current and desired phase is large (greater tha n about 3 x 10-3 s). This improves i nitial locking times dramatically, but causes a timi ng glitch and possible loss of data a round the phase jump. Setti ng t he SC PLL type to purephase disables phase-offsetti ng, turni ng the PLL i nto a conventional phase-lock loop. freq turns t he SC PLL i nto a frequency-lock loop (FLL), which locks very quickly but can drift and have a rbitrary phase errors. Frequency locking is employed automatically as a prelimi na ry stage in the phase-offsetting sequence described above, a nd should not be used for regula r operation. The dac option of the scpll comma nd allows ma nual setti ng of the PLL VCO control voltage when in manual mode. It can also be used to read t he current cont rol voltage setting i n 1hz and errmes modes (but not refclk mode). div gives low-level access to the high-rate reference clock divisor, active only in refclk mode. This should normally be controlled using userio clkin instead. See also t he delay comma nd and t he RCL ERRMES comma nd.

Command: serial Sy ntax: serial Description: Display s the s to keep t rack were recorded cording -- to

erial number assigned of S2 systems i n the on. Each S2 encodes see t he serial number

to this S2 sy stem. This number can be used field, and to match tapes to t he sy stem they its system serial number onto tape when reextracted from tape during playback use t he

4 - 44


S2-RT User's Manual

OPERATION

tapeinfo comma nd. If you need to check a specific tape (e.g. you suspect not all tapes have the same sy stem serial number), make sure you are in manual playback (play manual), select the desired t ra nsport using setup transport N, a nd then ty pe tapeinfo. Note t hat each transport has its own serial number, which is also encoded on tape. You can display t ra nsport serial numbers using transport display serial to show the serial numbers for your S2 sy stem, or transport display serialpb to show the serial numbers of the transports used to record t he currently play ing tapes. Thus you can trace tapes not only to specific S2 sy stems but also to i ndividual transports. The S2 system serial number is stored in the sy stem defaults file, serialnum parameter, and on ra re occasions may become incorrect. For example, if t he Static RAM board is replaced (since t hat's where the defaults file is stored), or if you perform a complete SRAM reload from external media. After such an operation, alway s check t hat the serial number matches the number labeled on t he VME card cage, a nd if not edit t he defaults file accordingly.

Command: setup Sy ntax: setup [play|record|bypass|ahook|dhook] [NUM] [transport NUM] Description: Configures t he flow of data through the S2 recorder. During normal operation, t he setup is cont rolled automatically as part of commands such as play, record, a nd stop, so t here is no need to use t his command. setup controls internal data channels, not user data cha nnels. It is for diagnostic a nd manual operation only. T here are 6 diagnostic data pat hs i n the S2 recorder (Figure 4-5), 5 of which can be ma nually selected using setup (t he remaini ng one is selected wit h uic feedthru). In each path there a re 8 channels numbered 0 to 7. However, duri ng record data cha nnels can map onto several tra nsports, a nd during playback each t ransport can potentially map onto any data channel. T herefore t he setup i ncorporates separate concepts of transport number a nd channel number. T he cha nnel number is t he i nternal data cha nnel on which t he data belongs, from which t here is a di rect mapping onto one or more user channels. T he t ransport number is t he t ransport which the data happens to be going to or coming from. T he cha nnel a nd t ransport chosen i n the current setup are referred to as the diagnostic channel a nd diagnostic transport. In a record terminal, the effect of changing t he setup is to cha nge t he source of t he data currently being decoded. Thus the ``Decoder i nput'' display i n t he Crucial Parms wi ndow shows what the current setup is. T he setup also controls whether the sy stem timi ng is set for playback or record. Play back timing is used when playback data from the transports is being decoded, a nd record timing is used at all other times. There are four typical ways t he setup comma nd might be used. First, you can change the diagnostic loopback pat h, e.g. setup ahook for ``analog direct-hookup'' or setup bypass for ``transport by pass'' pat h. Other options are dhook, record, a nd play. If t he S2 is stopped, setting bypass, record, or play also selects the stop setup. T he stop setup is the setup used when the S2 is stopped (or rewinding, etc.) a nd is treated specially i n t hat it is variable. T he stop setup is normally bypass on a n S2-RT and play on an S2-PT. This ensures t hat the sy stem timing does not get disturbed unnecessarily when going between play/ record a nd stop, which may be desirable if external systems are locked to t he output 1 Hz tick (S1HZ_PB on C2a cable). Another way to use setup is to cha nge t he current diagnostic cha nnel or t ransport. For example, during manual play back, setup 3

4 - 45


S2-RT User's Manual

OPERATION

selects cha nnel 3, automatically locating t he correct t ra nsport. Simila rly, setup transport 1 selects tra nsport 1, automatically choosing t he correct channel. T he active range of cha nnel and tra nsport numbers is cont rolled by the mode and group commands. Finally, you can specify bot h t he cha nnel a nd t ransport, effectively forcing a particula r decoder output mapping, e.g. setup 5 transport 2 T he above comma nd may generate status messages such as ``Tape cha nnel ID does not match setup'', i ndicati ng that t he setup is not correct for the data currently being decoded. This is considered an i nconsistent setup, and can be remedied by ty pi ng setup wit h no parameters. Besides displayi ng t he current setup, t his will fix it if it's i nconsistent. T he setup command is not allowed during automatic record or playback.

Command: sh ell Sy ntax: shell Description: Escape to t he VxWorks shell without i nterrupti ng S2 operation. This is strictly for diagnostic use only and requires knowledge of t he VxWorks shell sy ntax. Type exit when fi nished to return to ROS.

Command: sh utdown Sy ntax: shutdown [reboot|rcl] Description: Terminates t he execution of ROS and enters t he VxWorks shell, or with t he reboot option causes a n immediate reboot. This should be used for diagnostic and debuggi ng purposes only, or as t he last command before turning off power to t he system. Wa rni ng: this instantly disables the S2 recorder, halting any record, playback or other operation t hat may be i n progress. T he only recommended way to resta rt t he sy stem following shutdown (wit hout the reboot option) is a full system reset. There are several ways to do this: turn the power off and on, press t he small red ``reset'' button on the RCC board, or type Cntl-_ on t he console (cont rol-underscore, may require shift as well). Typing reboot i n t he VxWorks shell will also work. Use t he shell command i nstead of shutdown if you just wa nt to issue a few VxWorks shell commands and then return to ROS (for experts only!). T he rcl option closes a ny currently active network RCL connection, useful to clean up hung RCL connections. It does not shut down t he rest of ROS.

Command: sleep Sy ntax: sleep {NUM|[+][NNN-]NN:NN:NN} Description: Delay s for a certain amount of time or waits until a specific time. This is useful i n batch files to i ntroduce delays a nd make commands execute in a precisely scheduled ma nner. There are 3 general formats of the sleep comma nd. The simplest is to give a number of seconds to delay, e.g. sleep 5 causes a delay of 5 seconds. There is also a long-form relative format, e.g. sleep +03:45:30 delays for 3 hours, 45 mi nutes, and 30 seconds. T he thi rd format is a long-form absolute sleep command, e.g. sleep 189-23:00:00 which waits until 11:00 pm on day number 189. T he time to wait is not allowed to exceed 30 days, a nd a warning is printed if it is more than 1 day. T he day number can be omitted, so just sleep 23:00:00

4 - 46


S2-RT User's Manual

OPERATION

will wait until 11:00 pm today (or tomorrow if the current time is between 11:00 a nd midnight). See also t he wait comma nd.

Tape ST-126/SE-180 (258m) ST-182/SE-260 (371m)
*R

LP

SLP

4 h 01 m 6 h 02 m 5 h 47 m 8 h 41 m

Command: speed Sy ntax: speed [lp|slp] Description: Selects t he tape speed to use for recording (playback tape speed is determined automatically ). S2 sy stems wit h AG2530 and earlier model t ra nsports support two speeds: lp and slp, corresponding to the sta nda rd VHS tape speeds of t he same name (but sped-up by a factor of 64/60). Sy stems wit h AG2550 and later model transports can record in slp only, but will play back tapes recorded i n eit her speed. If lp is selected on a system wit h one or more AG2550 tra nsports it is automatically mapped to slp. Note that alt hough AG2510 transports can record at eit her speed, using AG2510s to play back slp tapes is not recommended due to poor performance. T he total recording time per tape is given above for both speeds a nd two different available tape lengths. Refer to Chapter 5 for additional i nformation.

Command: station Sy ntax: station [NUM [STR8|blank]] Description: Sets the station number and nickname of this S2 sy stem. T he station number is a n i nteger from 0 to 255 which serves to identify different S2 sy stems i n applications where more t ha n one S2 is used. Non-zero station numbers are displayed on t he console screen just above t he Tra nsport window and below the activity i ndicator, a nd on the tra nsport front-panels beside the tra nsport address (values 1 to 6 only). The station number is encoded on tape so t hat it can be recovered during playback (see the tapeinfo command). The number is remembered across power-downs since it is stored i n t he sy stem defaults file (this comma nd automatically updates t he defaults file). Select t he value 0 if you do not wish to assign a station number (no number will be displayed). In addition to t he station number, each sy stem can also be assigned a ``nickname'' of up to 8 characters. It appears in the console wi ndow to the left of t he system time. Like the station number, t he nickname is automatically updated in t he sy stem defaults file and thus persists across power-downs, but it is not encoded onto tape. Enter t he word blank to clear t he nickname. Both the station number a nd nickname can also be set by editi ng t he station and nickname entries in the defaults file (see Section 4.2.7).

Command: status Sy ntax: status {reset|pagedn|pageup|decode NUM [short]|display [ fullscreen|tofile STR] [short]} Description: Provides several options for cont rolli ng t he console status display. status reset is the form of this comma nd you will probably use most often. It clears ``transient'' (clear-on-read) conditions from the console status window and zeroes all miscellaneous error counters. Note that status reset affects only the console status i ndications, not t he RCL status (for the RCL, clear-on-read status conditions a re cleared each time status is read). T he pagedn and pageup options allow you to page t hrough t he status messages i n case t here a re more t han 3 of them, although t he most important conditions will usually be shown first. As a convenience feature,

4 - 47


S2-RT User's Manual

OPERATION

when runni ng the ROSCO termi nal emulator program the PgUp and PgDn keyboa rd keys automatically generate the comma nds status pageup and status pagedn. Another way to show all status information is with the display option, which writes all current status conditions to the i nteraction wi ndow (or to the log with tolog). Normally the ``long'' (RCL) version of the status messages is given, but short can be specified to see t he ``short'' form which is the form used in t he console status window. T he numeric status code a nd m nemonic a re both shown, making it easy to look up the code i n the status descriptions (Section 4.5). By specifyi ng fullscreen, the i nformation can occupy t he enti re termi nal screen to get around size limitations of t he interaction window. This can be used to capture status information to a file if your termi nal emulator has that capability (e.g. in ROSCO press shift-F9 followed by F2 to begin capturing i ncomi ng cha racters to a file). The tolog option writes t he current status information to t he S2 i nternal log file for later examination. Alternatively with t he tofile option you can write status information over t he network directly to a file on a remote computer if your S2 sy stem is equipped with an Ethernet boa rd and t he remote host has been configured appropriately (see the description of t he tofile option under the log command for more information). The decode option is used to translate numeric status codes to their corresponding text message, eit her long or short format. This may occasionally be useful if a status code appears i n numeric form due to space limitations, but status display is normally preferred as long as the status condition is still active since status decode does not show occurrence-specific i nformation such as channel or t ransport numbers which may be inserted i nto the message. Places where such i nformation gets i nserted are marked by ``xxx''. For a complete listi ng a nd expla nation of all status codes see Section 4.5.
*

Command: stop Sy ntax: stop Description: Stops t he S2 if it is currently i n record, playback, rewind, fast-forwa rd, or a ny ot her tape motion state including alignment and positioni ng. Automatically switches to t he stop setup, which is normally bypass on an RT and play on a PT. T he stop setup can be changed simply by selecting a new diagnostic signal path with the setup command while t he S2 is stopped. The stopsetup defaults-file parameter can be used to define t he stop setup to use at bootup.
*

Command: tapeid Sy ntax: tapeid [STR20|blank] Description: Sets t he Tape ID, shown at the top of the console User Parms window. Duri ng record the Tape ID is written conti nuously to t he S2 auxilia ry data channel, a nd during playback it is recovered a nd displayed along wit h ot her pa rameters such as User Info. T he Tape ID should be chosen so that it uniquely identifies the set of tapes being recorded, a nd should not exceed 20 characters. For example, t he Canadia n tape labeli ng convention defines the Tape ID to contai n a two-letter count ry code, the tape type code, and a tape set index number with checksum as follows: CA-3-0012307 (More i nformation on t he Canadia n tape labeling conventions can be found i n t he document DRAO-RPCS3001, available at http://www.drao.nrc.ca/w eb/vlbi/docs/doc3001.ps.gz). Specify blank to enter an empty Tape ID (the tapeid comma nd wit h no parameters displays its current value). The Tape ID should be entered prior to the start of recording and t hereafter should not be cha nged for the remai nder of the tape. Following t his rule will make it easy to determi ne if all tapes belong to t he same set at playback, regardless of their current positions. If t his rule is not followed, status code STAT_INTAPEID

4 - 48


S2-RT User's Manual

OPERATION

may appear during playback i ndicati ng t hat two t ra nsports have different tape IDs, but this will have no adverse effect on system operation.

Command: tapeinfo Sy ntax: tapeinfo Description: During playback, tapeinfo displays information ext racted from tape auxilia ry data describi ng various conditions in effect at record time. The i nformation applies to t he tape in the t ransport currently selected for decoding, as shown in the ``Decoder i nput'' display. Most of the tape i nfo applies equally to all tapes assumi ng t hat t hey were all recorded together a nd are currently aligned. The followi ng items a re display ed: 1. T he Tape ID (also shown i n the User Parms window). 2. The channel ID, which is the address of the transport the tape was recorded on. 3. T he recorder mode at record time. 4. T he S2 sy stem serial number, station number, a nd t ransport serial number where t he tape was recorded. Useful for t racing tapes back to the sy stems t hey were recorded on. 5. T he current tape time, a nd an i ndicator showing if time was not validated during record. 6. T he tape ty pe setting in effect at t he time of recording (ty pe codes 1-9 a nd A-Z only, no extended digit stri ngs). 7. T he elapsed time since t he sta rt of recording. 8. T he record start time. 9. T he record stop time, if known (not implemented). 10. T he measured station delay at that poi nt in the recordi ng (shown as ``unknown'' if t here was no 1 Hz i nput at record time). 11. T he barrel roll setting (on/off). 12. T he Formatter randomizer and precoder settings (both normally always on). 13. T he Formatter diagnostic mode setting (on/off). On only for test tapes, i ndicates tape contai ns Formatter TVG pseudo-random noise sequence.

Command: term Sy ntax: term [STR [default]] Description: Sets t he console termi nal type. If t he terminal ty pe is not set correctly the console display may appear garbled, and editi ng with the edit or batch edit commands may be almost impossible. Note that the terminal type will revert to its default value as entered i n the sy stem defaults file next time the sy stem is rebooted unless you specify default, which causes t he defaults file to be automatically updated. Termi nal types entered with t his command must appear i n the terminal capability (termcap) file or they will not be recognized. Table 4-2 shows some popular terminal types recognized by the S2 software as shipped. T he termcap file can be edited by typing edit termcap, but if t he terminal you a re using is not supported by t he S2 you will need to add a definition for it to t he termcap file without using the editor. T his can be done via t he S2 i nstall procedure, which is invoked from the VxWorks shell by typing install (use t he console shell command or press the space bar at t he appropriate part of the bootup to enter t he shell). See Section 4.2.7 a nd Appendix D for more i nformation on termcaps.

4 - 49


S2-RT User's Manual

OPERATION

Command: tim e Sy ntax: time [[NNN-]NN:NN:NN |{s|m|h|d|y}[+|-]NUM|validate |convert [NUM [NUM] |{jan|feb|...|dec} NUM [NUM]]|setremote [STR]] Description: Sets and displays t he S2 sy stem time. The system time is used to time-tag data recorded on tape, and is normally set precisely to UTC before recording. For playback the time need not be set precisely, however setti ng the time is still recommended since it is used by t he sleep comma nd and the ROS i nternal log facility. Without pa rameters time display s the current sy stem time as well as t he total elapsed time since the S2 was booted (the ``uptime''). If tapes a re currently playi ng a nd aligned the complete playback tape time is shown also (this provides a quick way to check the year of the recording, which is not normally shown on the display). By specifyi ng parameters the time can be set to a specific value, e.g. time 159-11:47:00 Here 159 is t he day number (where day 1 is Jan 1), 11 is t he hours, 47 is t he minutes, and 00 is the seconds. When setting absolute times i n this way the command should be issued immediately after t he S-1/C-1 Hz input tick (S1HZ_REC on C1 cable or C1HZ on C2a cable). For t he above example you would press return just after t he reference clock's seconds digits flipped to 00. The year must be set sepa rately as follows (but t his should rarely be necessary): time y 1996 Each time field can also be adjusted in absolute or relative terms, e.g. time m 23 sets t he mi nutes field to 23, or time s+1 i ncrements t he time by one second. While t he S2 power is off time is mai ntained by a battery backed-up clock chip (MK48T02) on the RCC boa rd, so it should usually remain correct wit hi n a few seconds. Following sy stem bootup (and remote time setting a nd certai n severe sy stem timing glitches) two question-ma rks ``??'' a re shown beside the sy stem time indicating that it may not be accurate. Use t he time comma nd to set it, or ty pe time validate if it is actually correct. T he convert option is useful to convert between day numbers and t he more familiar mont h/day representation. T he setremote option can be used to set the time from a remote network host using the internet RDATE protocol (IP port number 37). Your S2 sy stem must be equipped wit h an Ethernet board and connected to a network from which the host to obtai n the time from is accessible. T he name or i nternet address of the time host can be specified i n the command, or if no name is given t he value entered for t he timehost pa rameter in the sy stem defaults file will be used. If t he timehost defaults pa rameter is missing or blank, t he host name and address from t he boot pa rameters will be used i nstead. When specify i ng t he time host it will usually be necessary to use the i nternet address and not t he host name since t he required name t ra nslation i nformation will not be present (unless you have taken steps to add it). See the general description of time setti ng on Page 4-9 for more i nformation.

*

4 - 50


S2-RT User's Manual

OPERATION

Command: transport Sy ntax: transport [[{all|autoselect|NUM}[{+|-}NUM...[{+|}NUM]]] [status { version|serial|state|position|time|volt|recsig|pgshift|wrle v} [log]|stop|play|...|position {[+|-]NUM:NN:NN|preset {NUM:NN:NN|unknown}|reestablish}|tracking [NUM|center|recalibrate [phase2only]|{auto|manual} [phase1|phase2]]|wrle v [NUM|optimize ...]|program {[alternate] STR|ls [long]}|caltemp NUM|pgshift {recval|playval} NUM|wrle voffset NUM|options {takeupsense [enable|disable]|wrlevoffset [{enable|disable} [default]]}|service {lastserv|lasthead|edithist|dumpmem {tofile|...}|loadmem NUM|cleartimes}]|display [time|day|year |position|esterr|dv|agcle vel|chanid|temp|servtime|headtime|ontime|tracking|serial|serialpb|state]|assignaddr NUM NUM] Description: Sets/displays low-level t ra nsport control options a nd switches. Most of these a re for diagnostic and system configuration use. Many functions provided here a re low-level versions of regular operational commands a nd should never be used for regular operation. T he comma nd transport play (for example) is not the same as play, and should never be used in its place. T he followi ng descriptions include only the most commonly used command options. T he display option selects what to display i n the Transport wi ndow. Possibilities i nclude i ndividual positions, estimated error rate, AGC signal level, tape channel ID, t ra nsport temperature, and head use time. For a complete list see t he description of t he transport window on Page 4-24. Another function of t he transport comma nd is to select sets of t ransports t hat are different from the automatic selections normally made by t he mode and group commands. For example, transport 3+6+7 selects only t ra nsports 3, 6, a nd 7, a nd transport all-7 selects all tra nsports that are not dead or off, except number 7. After such a command, type transport autoselect to return to t he set of t ransports that were automatically selected. T he status option shows i nternal i nformation about the transports. For example, transport status volt shows measurements of t he ±5 V supplies from the C4 cable, plus t he current temperature a nd AGC (signal) level. transport status version shows the current softwa re version running on the 8051 custom processor inside t he t ransports. Most ot her status information is a duplicate of i nformation available i n t he Tra nsport window via transport display. T he assignaddr option is used to set or cha nge a t ransport's address, which must be done every time a transport or TCP board is replaced. The address is what distinguishes control messages to different transports, a nd must match t he C3/C4 cable cha nnel the transport is connected to (depends on its position i n t he TAM racks). The tra nsport's TCP serial number must be known to assign its address. For example, transport assignaddr 2053 3 assigns the address 3 to the transport with serial number tcp2053. The serial number is printed on a label attached to t he back of t he tra nsport. See Section 6.4 for more i nformation on how to assign addresses. The program option is used to re-load t he softwa re which runs on t he 8051 processor inside the tra nsports. This software is stored in electrically-erasable mem-

4 - 51


S2-RT User's Manual

OPERATION

ory (EEPROM) and may need to be re-loaded followi ng a sy stem softwa re update (Section 6.2). T he normal comma nd to re-load t he software of all t ra nsports is transport all program T his will first display the version number and date of the softwa re currently loaded i n the t ransports, followed by t he version number a nd date of t he new transport software about to be loaded, and prompt for confirmation. If the response is ``y es'', t he tra nsports will be re-loaded one after the other. Each is first placed in a special programming mode where it recognizes not hi ng but program data, then t he data is t ransferred. After t he last data record is sent the transport reboots itself. If a ny t ransport fails to respond within 30 seconds of being programmed t he entire operation will abort with a n error message. In t his case some t ra nsports may not yet have been re-loaded, a nd one tra nsport may be dead or only pa rtially programmed. After successfully programming all eight tra nsports you should see t his message: ``Transports 0-7: Programmed prog & all''. T he t ransport softwa re is actually broken down i nto a number of different modules, and it is po ssible to give t he name of a specific module to re-load. T his should be done by expert service personnel only. A combination of all the modules is called all.ag25x0, a different version of which exists for each tra nsport ty pe. Two identical programming modules a re used for downloading the EEPROM, with one being used to download the other when t he programming modules t hemselves need to be updated; their names a re prog.tcp a nd progalt.tcp for t he ``standard'' a nd ``alternate'' programmi ng modules, respectively. Two other modules exist, main.ag25x0 and xil.ag25x0. These two modules and progalt.tcp are not normally i ncluded in S2 softwa re distributions to save space (i n any case t hey are part of all.ag25x0). Care must be taken when programmi ng i ndividual t ransport modules, especially when using all.ag25x0, because it is possible to make a mistake a nd kill a t ra nsport. Only use all.ag25x0 if you are sure the old and new programmi ng modules a re exactly identical. If not, you must download one of the programmi ng modules first. Of course you can avoid these problems by using the sta ndard programmi ng sequence transport N program described above, since this automatically loads the standard programmi ng module a nd then loads all.ag25x0. In t he event that the EEPROM is corrupted a t ra nsport may appear dead (will not beep a nd set its front panel address display a few seconds after power-on), making it impossible to issue the transport program command to repair the damage. In this case it is sometimes possible to recover using a special ``emergency recovery'' feature: Hold the eject button on the front panel while applying power to the tra nsport. This will force it into program mode (sta ndard programmi ng module), after which you should use transport N program all.ag25x0. You will get a warning (``assuming t ra nsport already in program mode''), but t his is normal. T he position option is a low-level version of t he position command, a nd should not normally be used. However, it does support t he position preset feature which is i ntentionally left out of the regular position comma nd. Normally position preset will be done via the RCL. T he tracking option can be used to ma nually adjust t he t racki ng control on t he transports. Each i nteger tracking unit is equivalent to pressing a t racking button once. Tracking adjustments a re always relative, but t he absolute ra nge is approximately -50 to +50. Use t he recalibrate sub-option to trigger automatic t racki ng calibration. T here are two automatic t racking algorit hms: phase-1 is performed by the t ra nsport (green DIGITAL TRACKING light flashes, if present), a nd phase-2 is performed by ROS (``t rack cal'' message appears in Decoder sy nc display). Each phase can be i ndividually enabled a nd disabled for particular transports using transport tracking auto a nd transport tracking manual. There is also a special phase-1b algorit hm which performs la rge t racking jumps of 20 units or more t hat may be t riggered by ROS when the sy stem is having difficulty wit h a particula r tape. Phase-1b can be globally disabled using transport tracking phase1b disable. Note: The tracking center option

4 - 52


S2-RT User's Manual

OPERATION

will not actually center the t racking, but rather acts as a low-level t rigger for t he phase-1 t racki ng algorithm. It is equivalent to pressing t he two t racki ng buttons simulta neously, a nd should not normally be used. The caltemp option is used to calibrate t he temperature sensors inside t he t ransports. This is normally done only once duri ng manufacture, but in some circumstances might need to be done again i n the field. T he current correct transport i nternal temperature i n degrees Celsius must be specified (the measured ambient temperature can be used immediately after turni ng on the S2 system, before t he t ransports have had a cha nce to warm up; for the complete temperature calibration procedure see Section 6.4.5). T he value 0 has a special meani ng: it clears the temperature calibration factor so that t he raw, uncalibrated temperature reading is shown. Type transport display temp to display the t ra nsport temperatures. T he tra nsports automatically turn off above 60 degrees or below 5 degrees C. In ra re cases if a transport has shut itself off but is known not to exceed the temperature a nd condensation limits, it could be that the temperature calibration factor has been corrupted and needs to be re-entered. The wrlev option allows you to explicitly set the write current level used during record, however t he write current is normally set according to the tape type a nd should not be changed. By using the word `optimize' (transport wrlev optimize) you can run a special optimization routi ne that automatically determines t he best i ndividual write current offset for each t ransport. T his can significantly improve bit-error rates compa red to operati ng without offsets. You can also set t he offset ma nually using t he wrlevoffset option, but t his is not recommended. To display t he write current value a nd offset for one or more t ransports use transport status wrlev. See Section 6.4.4 for more information on write current optimization. T he options option allows you to turn on and off specific software features of t he transport. This should not normally be necessary except in ra re cases to work around unusual problems. Under options, t he takeupsense option switch lets you turn off t he TCP takeup reel sensing softwa re and prevent tape motion fail errors (status code STAT_TRANTPMOTFAIL) i n t he event that these errors a re occurri ng erroneously. T he wrlevoffset option switch lets you turn off per-t ransport write current offsets, effectively maki ng the per-t ransport offset zero. The defaults file wrlevoffoption parameter cont rols t he state of t he wrlevoffset option switches at bootup. T he service option has a number of sub-options to be used by service personnel for various tasks related to mai ntaining a nd repai ring t ra nsports. They will be described briefly here; for more i nformation see Section 6.4.1. transport N service lastserv transport N service lasthead T hese two commands zero t he time since last service (in-service time) a nd time since last head replacement (head-use time), respectively, which a re stored in t he EEPROM i nside each t ransport. A service is defined as any time the transport case is opened for i nspection or mai ntena nce such as cleani ng/greasing, and should be indicated by typing transport N service lastserv as soon as the transport is back in operation. A head replacement is defi ned as a ny time t he upper head cy li nder is replaced, and by definition also implies a service. It should be i ndicated by typing transport N service lasthead after t he tra nsport is back i n operation. Both the in-service a nd head-use times a re measured in hours a nd minutes of active head use, and can be display ed by ty pi ng transport N status time. In addition to t he i n-service and head-use times, this also shows t he total cumulative head use a nd total on time since manufacture. transport N service T his command allows you to edit a text fi t hat is stored inside each t ransport (in the each time a transport is serviced, cleaned, edithist le contai ning service history i nformation EEPROM). T his file should be updated repai red, etc. Follow the existing format

4 - 53


S2-RT User's Manual

OPERATION

a nd include t he current total head time and nominal service hours as shown. T he maximum allowed file size is about 2 kiloby tes. transport N service dumpmem tofile transport N service loadmem NNNN T hese two commands should be used when replacing or swappi ng a tra nsport's TCP board. They allow all of t he service and calibration i nformation stored in t he EEPROM to be tra nsferred from t he old TCP board to the new boa rd (t he TCP board holds the EEPROM itself). Otherwise important information such as head use time, service history, and pgshift and write current calibrations would be lost. The transport N service dumpmem tofile comma nd should be issued before replacing the TCP, and t he transport N service loadmem NNNN command should be issued after replacing the TCP a nd reassigning its address, where NNNN is t he old TCP serial number (swapping t he TCP means that t he serial number cha nges!). Note that if a TCP board has failed a nd it is not possible to carry out t he i nitial dumpmem step, you can still transfer recent values for t he EEPROM pa rameters since the S2 performs a dumpmem for each transport on every sy stem boot (just in case). transport N service cleartimes T his comma nd can be used to zero all head use and service time counters, including t he totals. This should only be done if a n older TCP is installed in a brand new t ransport, or the counter values have become corrupted for some reason.

Command: uic Sy ntax: uic [dcbias NUM [NUM {s|m|h} [NUM]] [le vel|edge]|berc NUM [NUM {s|m|h} [NUM]] [undetected] [log]|{dataextract| validityextract} NUM NUM| feedthru [on|off]|quant [1|2]|...] Description: Sets/displays low-level UI (User-Interface) boa rd cont rol options and switches. Most of these a re for testi ng a nd diagnostics, but a few may be useful during regular operation. T he dcbias option performs a DC bias measurement on a specific user data cha nnel, and t he berc option performs a t rue bit-error rate measurement, provided that t he current user output data contains t he UI diagnostic test vector. T he UI test vector is a 32767 bit maximal-lengt h pseudo-ra ndom sequence that gets reset sy nchronous to t he sy stem 1 Hz tick. It is not t he same as the Formatter test vector tested by form berc. To inject t he UI test vector i n place of user i nput data, attach a n appropriate external test data generator or switch to one of t he UI diag modes (e.g. mode diag8) or one of the C2 cable test modes. Note t hat unlike form berc, uic berc will not automatically enable UI diag mode. The dataextract and validityextract options take actual 24-bit snapshots of the user data or validity signals. Extractions a re sy nchronous to t he 1 Hz tick (frame 0), wit h an optional positive offset of up to 255 bits. The data extractor can be used to check proper connection to a data acquisition sy stem before recording. For example, the data acquisition hardware could be configured to generate a sine wave of appropriate frequency at t he sampler i nputs, which should appear as a squa re wave in the S2 data extractor display (UI feed-t hrough, described next, should be turned on). The feedthru option selects t he UI feed-through diagnostic path, which results in all C1-cable i nput data being duplicated on the C2 cable. In feed-through mode, the DC bias, UI BERC, and data-ext ract facilities exami ne feed-through data instead of data from t he decoder (DRD). This ensures t hat all user data channels are accessible and provides the most di rect way to exami ne data from t he C1 cable.

4 - 54


S2-RT User's Manual

OPERATION

Command: uncue Sy ntax: uncue Description: Returns to regular playback from cue or review. Currently selected tra nsports must be cueing or reviewi ng. Should not be used for regula r operation.

Command: unpause Sy ntax: unpause Description: Returns to regula r playback or record from pause. Currently selected t ransports must be i n play -pause or record-pause. Should not be used for regula r operation.

Command: unreview Sy ntax: unreview Description: Returns to regular playback from cue or review. Currently selected tra nsports must be cueing or reviewi ng. Should not be used for regula r operation.
*

Command: user Sy ntax: user [info {1 [STR16|blank|label {STR16|blank}]|2 [STR16|blank|label {STR16|blank}]|3 [STR32|blank|label {STR16|blank}]|4 [STR48|blank|label {STR16|blank}]}|dv {[yes|no]|playback [enable|disable]}] Description: Sets/displays the value of one of 4 user-defined i nformation fields a nd labels, or t he user data-valid flag. User i nfo is shown i n t he console User Parms wi ndow (except field 4). During record t his i nformation is written conti nuously to the S2 auxiliary data channel. Duri ng play back it may be recovered at any position on t he tape. The format of the user info fields is totally up to the user as long as t he overall lengt h does not exceed 16, 16, 32, 48 cha racters for fields 1 t hrough 4 respectively, a nd 16 cha racters for each label. Spe cify blank to clear an i nfo field or label (the command with no parameters display s its current value). User i nfo should be entered prior to t he sta rt of recordi ng and t hereafter may be changed at any time, but should not be cha nged more often t ha n every few seconds. See ``Tape ID a nd User Info'' on page 4-11 for more i nformation, includi ng some examples. T he dv option of the user command is used at record time to set a boolean flag which i ndicates whether data is valid or i nvalid. Then at playback time t he ha rdwa re data valid (DV) signals will ma rk the data invalid whenever the user DV flag was false. User DV is just one of the factors cont ributi ng to t he final playback data validity decision. T his feature can be used whenever it is known t hat bad data is being recorded, e.g. the telescope is slewi ng or off-source. To use the so-called bad data anyway, the user DV flag can be ignored during play back by ty pi ng user dv playback disable. T his may be useful if data was erroneously marked i nvalid at record time. The playback enable/disable function has no effect duri ng record.
*

Command: userio Sy ntax: userio [clkin [c1|c2] [32|16|8|4|followdata]|clkout [32|16|8|4|followdata|syncerrinduce [on|off]]|{c1in|c2out} [on|off]] Description: Without any parameters, this command switches to the User I/O window, which replaces the User Parms window in t he upper middle of t he screen. It gives useful i nformation about the current User Interface i nput/output configuration, i ncluding exactly which user data channels a re active a nd what clocking options a re currently i n effect. See Section 4.2.8.6 for a description of t he User I/O wi ndow.

4 - 55


S2-RT User's Manual

OPERATION

The parameters of t he userio comma nd set/display various i nput/output options. clkin selects the source of the high-rate a nd 1 Hz i nput reference clocks (C1 or C2 cable) a nd sets t he expected frequency of t he high-rate i nput reference. T his can be fixed at 4, 8, 16, or 32 MHz, or set to followdata which means t rack t he user cha nnel data rate. These input clocki ng parameters are normally set as desired in the sy stem defaults file using the clkinsrc and clkinrate options. Note that t he high-rate reference clock is used only in Sy stem Clock PLL refclk mode, and t he 1 Hz reference is used only in SC PLL modes refclk a nd 1hz. The clkout option sets the frequency of t he high-rate reference clock output on t he C2 cable (SCLK_PB), eit her 4, 8, 16, or 32 MHz, or followdata. If t he Mark III/IV formatter is active, t he output clock can't be set to anything except followdata, a nd the output clock rate increases by a factor of 9/8 due to parity i nsertion. The default output clock rate is set by the clkoutrate defaults file parameter. T he c1in option is used to enable a nd disable the C1-cable data inputs, while c2out enables and disables the C2-cable data and validity outputs. T hese may be useful when testi ng the i nterface between the S2 a nd a correlator or between t he S2 a nd a data acquisition system. Note that in bot h cases the timing signals (clock and 1 Hz) a re unaffected. T he syncerrinduce option may be used to test the correlator timi ng i nterface. Turni ng sy ncerri nduce on introduces a timi ng offset error in the 1 Hz output (S1HZ_PB on C2a cable) relative to the data (unlike t he delay comma nd which shifts data a nd clock together when i n play back). The amount of error offset is 250 ns i n 4, 8, and 16 Mbit/s modes a nd 62.5 ns i n 32 Mbit/s modes. Don't forget to turn it off when you a re done. For ot her comma nds which affect t he S2's input/output configuration, see t he mode command, which sets the user data rate and cha nnelization, a nd t he scpll mode comma nd, which selects the Sy stem Clock PLL lock reference.

Command: verbose Sy ntax: verbose [NUM|countall [on|off]] Description: Sets/displays the verbose level, which cont rols t he amount of information displayed i n t he console status wi ndow by filteri ng out certai n messages. T he valid range of verbose levels is from 0 to 3, where 3 gives the most information and 0 t he least. Level 1 is appropriate for normal operation. Level 0 eliminates some importa nt status messages, a nd t herefore is not recommended. T he verbose level also filters a small number of RCL status conditions, but in general has less effect on t he RCL t ha n on t he console. T he verbose level should be set to 1 for normal RCL operation. T he initial verbose level is defi ned in t he system defaults file by the verbose parameter.

Command: version Sy ntax: version Description: Display s t he Recorder Operati ng Sy stem software version number, includi ng CPU ty pe a nd compilation date/time. T his can be used along wit h the boot-EPROM a nd VxWorks version numbers (displayed duri ng bootup) and the tra nsport softwa re version (displayed wit h transport all status version) to build a complete picture of t he software revision status.

4 - 56


S2-RT User's Manual

OPERATION

Command: wait Sy ntax: wait {stop|aligndone|drcal} Description: Waits until a specified condition is t rue. T his command is useful in batch files where sleep commands of uncertain length would otherwise be required. Currently the followi ng options a re supported: stop, aligndone, drcal. wait stop waits until the overall tape motion state cha nges to stop. T his can be used i n a number of different situations, e.g. -- Wait for rewinding to complete. -- Wait for positioni ng to complete. -- Wait for playback or record to hit end-of-tape. -- If there a re no tapes i n t he t ransports, wait for user to i nsert tapes. wait aligndone waits until tape alignment completes duri ng automatic play (successfully or not). It is needed because in automatic play tape alignment happens i n t he ``background'', i.e. the alignment comma nd returns immediately. In ma nual play alignment comma nds do not return until alignment is complete, so wait aligndone is not needed (but no ha rm is done, it will just return immediately). Sometimes wait aligndone may not work as desired immediately after a play command: since no alignment operation has started yet, it returns right away. T he solution is to issue a n align selfalign command fi rst. wait drcal waits until the data recovery parameters of t he current diagnostic t ransport/DRD have been calibrated, i ncluding phase-2 tracking if applicable. Intended for use i n manual play. Should be avoided i n automatic play/ record. Note: Use echo prompt to wait for t he user to hit return.

4 - 57


S2-RT User's Manual

OPERATION

4.3 RCL Operation
T he basic approach to RCL operation is simila r to console operation except t hat t here is no console display to ``look'' at. Instead, desired display qua ntities must be requested using specific RCL commands. T he only request t hat needs to be made regularly (about every 1 to 5 seconds) is the STATUS comma nd, which is the RCL equivalent of t he console status wi ndow. Other qua ntities can be requested whenever desired to verify current operation, e.g. STATE_READ to read t he recorder state, or TIME_READ to verify t he sy stem time (TIME_READ_PB for play back tape time). The RCL is not meant to be used when performing sy stem configuration or de bugging, since it deliberately has a somewhat simplified i nterface. It t ries to present t he view of a single recorder, with little mention of t he fact that t here a re actually 8 i ndividual transports. In ra re i nsta nces this may be too restrictive, so there is a special RCL facility to execute single console comma nd strings, thus allowi ng low-level access. Refer to t he RCL protocol specification, given in Appendix A, for more i nformation. T he S2 RCL port is wi red as a n RS-232C DTE device and should be connected to a DCE device (this is t he opposite of t he console port). Some computers, such as IBM PCs, have only DTE serial ports and will requi re a null modem cable. Multi-drop RS-485 connection is possible wit h the use of an external conversion box. On S2 sy stems that have an Ethernet board a n equivalent RCL connection can be made over the network using i nternet sockets (see Section 4.4.3). T he RCL can be tested using t he RCLCO program, provided wit h t he S2 on floppy disks i n ANSI C source code format. RCLCO supports both serial and network operation a nd can serve as t he basis for user application programs that control t he S2. It i ncludes the RCL interface libra ry, a set of function calls which provide t he programmer's interface to t he RCL. As shipped RCLCO runs either on IBM PC or compatible computers (serial port version) or under Unix (network version). Read the file called ``1README'' on t he fi rst floppy disk for further instructions.

4.4 Ether net Usage
T he optional S2 Et hernet board allows access to t he console and RCL ports over t he network using rlogin/telnet for t he console a nd i nternet TCP sockets for the RCL. T he Et hernet board can also be used to upgrade S2 softwa re or restore the 3 MB SRAM from data files on a remote host, but for this t he host computer must have the necessary files available and be configured to recognize the S2 target sy stem. More i nformation on network software reloads is available from CRESTech/SGL upon request. Note t hat when addi ng a n Et hernet board to a n S2 sy stem you must remove the VME IACK (interrupt acknowledge) backpla ne jumper for that slot (VME slot 2). When removi ng t he Ethernet boa rd the IACK jumper must be put back in place.

4.4.1 Configuring Network Parameters
Before using the S2 on a network you must set boot parameters that defi ne network-related i nformation. These parameters are stored in a small (2K) battery backed-up Static RAM located on the RCC MK48T02 SRAM/clock chip (not t he 3 MB SRAM board), and are retained while the power is off. You must obtain an internet address a nd name for each S2 sy stem connected to t he network. To do t his contact your local network admi nistrator. T hen set the S2 boot pa rameters as follows: Enter t he boot monitor by resetting the S2 and hitti ng the space bar before t he countdown completes (to reset turn t he power off a nd on, or press the small red ``reset'' button on t he RCC board). T hen type ``c'' < return>, a nd a series of prompts will appear: boot device: E nter the type of Ethernet interface being used. You must alway s enter ``enp'' here.

processor number: Alway s enter 0 for this field. host name: E nter the i nternet name of your remote host computer sy stem, e.g. sgl.crestech.ca. The remote host may be used for tra nsferri ng files to a nd

4 - 58


S2-RT User's Manual

OPERATION

from the S2, software upgrades, or for VxWorks network boots. T his field is not required if you will only be using the Ethernet for console rlogin/telnet or RCL socket connections, but must not be left blank. E nter x if you do not wish to supply a n actual host name. For more i nformation on configuring a remote host for special operations like software upgrades a nd file transfers see: ftp://ftp.sgl.crestech.ca/pub/s2/doc/appnotes/HostSetup . file name: T his is only required if you pla n to perform software upgrades over the Ethernet. If not, enter x here since this field also must not be left blank. Users pla nni ng to perform network software upgrades should enter the absolute pathname of t he VxWorks boot file on t heir host computer system, e.g. /local/s2/vxWorks. Even if this file does not actually exist, enteri ng its name establishes a root directory for S2-related files a nd data. For the above example, t he files used for network software upgrades would be placed in t he directory /local/s2/ros/data/.

i net on ethernet (e): E nter t he internet address assigned to this S2 sy stem, e.g. 132.251.42.94. T his field is required. It is also possible to i nclude a subnet mask, which you may need to do if t he default mask (ffff0000) doesn't work. Specify t he subnet mask after t he address sepa rated by a colon, e.g. 132.251.42.94:ffffff00. Note t hat t he internet address and name a re a property of t he ethernet board, not the RCC or t he S2 sy stem itself, so if you swap ethernet boards you must enter a new address here. i net on backplane (b): Always enter ``.'' to clear t his field. It is not used, a nd should always be bla nk. host i net (h): If you have entered the name of a remote host computer at the ``host name'' prompt above, enter its internet address here, e.g. 132.251.42.1. Otherwise enter ``.'' to clear t his field.

gateway i net (g): Normally the S2 sy stem is accessible only on the local subnet where it is connected. To allow network access from distant network sites separated by one or more gateway s, enter the i nternet address of the local gateway connecti ng your network to t he outside world. Only one gateway can be chosen, a nd t his becomes t he default route for the S2, e.g. 130.155.192.2. The correct netmask must be specified at t he ``inet on ethernet'' prompt for this to work. To allow access only from t he local network, enter ``.'' to clear this field. If you wish to use more t ha n one gateway, or you do not wish to establish a default route for security reasons but still wa nt to enable outside access from certai n places, you must leave t his pa rameter blank (``.'') a nd ma nually add entries to t he routi ng tables by typing routeAdd "DESTINATION","GATEWAY" in t he VxWorks shell, where DESTINATION is t he i nternet address of t he destination host or network, a nd GATEWAY is t he i nternet address of the gateway. Note: Execution of t he routeAdd commands can be automated to occur each time t he system boots up by adding them to t he startup.cmd file using t he edit startup.cmd console command (see Page 4-36). user (u): T his is only required if you pla n to perform software upgrades over t he network, or to transfer log files across the network via RSH (or FTP) using log display tofile, or to boot VxWorks over t he network. Otherwise enter ``.'' to clear t his field. Users who wish to do so should enter the user name wit h which t he S2 will access t he remote host computer. The named user should have read access to t he VxWorks boot file specified at the ``file name'' prompt above, and that user's account should allow access to the S2 system by placing appropriate entries in the .rhosts or /etc/hosts.equiv files.

4 - 59


S2-RT User's Manual

OPERATION

ftp password (pw): E nter ``.'' to clear this field. It should normally be bla nk. Adva nced network users who wish to use FTP instead of RSH for remote file copy operations (e.g. log and batch files) may enter the password corresponding to t he userid chosen above. flags (f): Always enter 0 for t his field.

target name (t n): E nter the i nternet name assigned to the S2 sy stem. T his field is optional. If you do not wish to set it enter ``.'' to clear t his field. sta rtup script (s): E nter ``.'' to clear t his field. It is only relevant when booting VxWorks over t he network. ot her (o): T his field is not used. E nter ``.'' to clear it. of the above i nformation useful if you are al ready changing any pa rameters to log in agai n).

To exit t he boot monitor a nd continue the boot type go, or simply reset t he S2. All can also be entered from t he VxWorks shell by typing bootChange. This is especially logged on using rlogin or telnet and t herefore cannot access the boot monitor. After type reboot to reboot t he sy stem (your connection will be broken a nd you will have

4.4.2 Console access via rlogin/telnet
To access t he console display over the network, use either rlogin or telnet depending on which is available or which one you prefer. Give t he i nternet name or address assigned to t he target S2 sy stem, e.g. telnet 132.251.42.94 If console password protection is enabled you will have to enter a user-ID and password (see below for more i nformation). Otherwise you will be connected immediately. While t he network console connection is active t he S2 will no longer output information to or accept commands from t he console serial port. Only one simultaneous network console connection is allowed -- additional rlogi n or telnet requests will be rejected. Type logout to close t he rlogin/telnet connection a nd return cont rol to t he serial port. You can also force control to revert to t he serial port by typing cntl-C cntl-C cntl-] i n quick succession on the serial console's key board (do not use t his cont rol sequence at a ny other time). After connecti ng using rlogin or telnet you may need to cha nge the terminal type if it is not correct. To do so use t he term console command, e.g. term xterm. To cha nge t he default termi nal type used by the S2 at bootup include t he word default, or edit the defaults file and set the term parameter as appropriate. Console rlogin/telnet access may be protected by a user-ID and password prompt, although t hese are not enabled when the S2 is shipped. To enable password protection, set t he desired user-ID and password usi ng the loginuserid and loginpasswd pa rameters i n t he defaults file. You must first encrypt t he password using t he encrypt console comma nd, t hen use t he encrypted version of t he password i n the defaults file (see Page 4-36). Additional userid/password pai rs can be defi ned by adding more li nes in the same format (each new userid li ne must be followed by a passwd line). If desired, network console connections can be disabled completely by setting t he consolelock defaults parameter to 1. This prevents unwa nted rlogi n/telnet connections from interrupting serial console operation.

Note t hat in rare cases you may find yourself i n the VxWorks shell after connecti ng with usually means that the previous user logged out while in the shell, or that an error occurred prevented ROS from sta rti ng. If a n error occurred you should see a brief error message every time you press return (in fact it is part of t he prompt to be sure you don't miss it). i n this case is to connect t he serial console and reboot the sy stem, watching for any error

rlogin or telnet. T his duri ng bootup which which gets repri nted T he best thing to do messages.

4 - 60


S2-RT User's Manual

OPERATION

4.4.3 RCL access via Internet sockets
User software can access the RCL over t he network using i nternet T he underlyi ng RCL packet format is exactly t he same as when a nd RCL i nterface libra ry softwa re supplied wit h the S2 support (preprocessor macro UNIX defined). You can use these programs as RCL control code. TCP sockets a nd spe cify using serial connections. network operation when an example of how to wri i ng port number 1025. T he RCLCO program compiled under Unix te your own networked

Before RCL comma nds can be sent to a pa rticula r S2 sy stem a network connection must be opened by calli ng rcl_open() (RCLCO open command), specifying the desired internet name or address. T he open operation returns a reference address which is an integer used to subsequently refer to t hat connection. The reference address should be substituted for the RCL device address when issui ng RCL commands. In network operation t he RCL device address is not used since internet addresses a re sufficient to identify different S2 sy stems -- in fact network RCL packets contain the broadcast address to be sure to be accepted by the target S2 sy stem. More t ha n one network connection can be opened simulta neously to cont rol multiple S2 sy stems. While a connection is open the target S2 sy stem will not respond to RCL commands sent over t he regular RCL serial li nk. If desired, the rcllock defaults-file parameter can be used to prevent unwanted network connections from i nterrupting serial RCL operation. When you a re finished, use rcl_close() (RCLCO close comma nd) to close each active network connection. For more i nformation refer to t he RCLCO and RCL Interface Libra ry source code and 1README files.

4 - 61


S2-RT User's Manual

OPERATION

4.5 Status Codes and Inter pretations
T he S2 recorder has approximately 80 different status codes t hat describe its current state of well-being. These a re ra nked and divided i nto 3 severity categories: informational, error, and fatal error. Each status code may additionally be designated clear-on-read, which means it is a tra nsient indication t hat persists only long enough to be read. On t he RCL, clear-on-read conditions a re cleared followi ng each status read request, but on t he console t here is no way to tell when the operator has read the message so status must be cleared ma nually using status reset. Status i nformation is gat hered continuously and is not the result of any specific diagnostic test or procedure (it is sometimes called ``online status'' to emphasize this fact). Each status code is associated with a n expla natory text message, a nd there is both a ``short'' a nd a ``long'' version of t he message. T he short messages are limited to 34 characters a nd are typically used on the console. The long messages a re limited to 399 characters (but a re usually much shorter) a nd a re typically used wit h t he RCL. In t he list of status codes below only t he short (console) messages a re shown; for a list of the long (RCL) messages see t he table starti ng on page A-40. Many status messages have occurrence-specific fields where i nformation such as t ransport or channel numbers may appear. Places where such information gets inserted are ma rked by ``xxx'' or ``nnn''. Status can be summarized by checking if any error or fatal error conditions exist. On the console display, t he presence of any highlighted messages i n t he Status wi ndow indicates a n error, a nd the word FAIL i ndicates a fatal error. Simila r summa ries a re provided for t he RCL. Overall sy stem status can be considered perfect if t here a re no errors of either ki nd. Non-fatal errors should be noted by the user and probably i nvestigated, but usually pose no threat to sy stem operation. If any fatal errors appear, there is a good cha nce t hat t he sy stem is not operati ng correctly, a nd immediate corrective action should be taken. Informational messages (non-highlighted) a re of course always benign. The green front-panel LED on the VME card cage remains lit as long as no fatal status conditions exist (must be set to OK mode, i.e. not bli nki ng). Note that the S2 will not automatically abort any operation, even in the presence of fatal errors, unless t here is no possible way to continue or t here is immi nent danger of hardware damage. T he S2 status codes are listed on the followi ng pages, each with an expla nation of action might be necessary. T hey a re ra nked by code number in rough order of t he console status wi ndow. To help locate a status code quickly, use the status its code number (the numbers a re not shown in the status wi ndow due to spac what it means and what corrective severity as they would appear in display comma nd to determi ne e limitations).

0)

Mnemonic: Type: Console Msg: Interpretation: Mnemonic: Type: Console Msg: Interpretation: Mnemonic: Type: Console Msg: Interpretation:

STAT_OK Informational (none) Indicates sy stem status OK, no other status conditions exist. STAT_DIAGIP Informational

1)

``Diagn ostic test xxx in progress''
A sy stem diagnostic test, such as the power-on self-test (self1), is currently running. Upon completion, either STAT_DIAGDONE or STAT_DIAGFAIL will appear. STAT_DIAGDONE Informational (clear-on-read)

2)

``Diagn ostic test com pleted OK''
A sy stem diagnostic test, such as the power-on self-test, has completed successfully. Requires verbose level 3 to appear on the console.

4 - 62


S2-RT User's Manual

OPERATION

3)

Mnemonic: Type: Console Msg: Interpretation:

STAT_DIAGFAIL Fatal error (clear-on-read)

``Diagn ostic test failed: code nnn''
A system diagnostic test, such as the power-on self-test, has detected a problem. Due to space limitations, t he console status window shows only a numeric diagnostic code. This can be expanded using status display or status display fullscreen. It is also possible to perform a direct t ranslation of t he status code using status decode, but occurrence-specific message fields such as cha nnel and transport numbers will be filled with ``xxx'' instead of real information. To confirm t he results of t he power-on self test, the test can be re-run using diag self1 verbose. STAT_VMEPOWFAIL Fatal error

4)

Mnemonic: Type: Console Msg: Interpretation:

``VME xxx power supply bad''
One or more VME power supplies are outside t he acceptable range (±5% of nominal), as measured by an A/D converter on the Formatter boa rd. The exact measured voltages can be display ed by typing powermon. See also STAT_TRANBADVOLT. STAT_NOFORM Fatal error

5)

Mnemonic: Type: Console Msg: Interpretation: Mnemonic: Type: Console Msg: Interpretation:

``Form atter board marked not presen t''
T he Formatter board cannot be accessed by t he Recorder Cont rol Computer (VME read attempt gives bus error). It is eit her not present or has failed. STAT_NODRD Fatal error

6)

``DRD board mark ed not present''
T he Data-Recovery/Deformatter boa rd cannot be accessed by t he Recorder Control Computer (VME read attempt gives bus error). It is eit her not present or has failed. STAT_NOUIC Fatal error

7)

Mnemonic: Type: Console Msg: Interpretation: Mnemonic: Type: Console Msg: Interpretation:

``UI board mark ed not presen t''
T he User Interface boa rd cannot be accessed by the Recorder Cont rol Computer (VME read attempt gives bus error). It is either not present or has failed. STAT_FORMFAIL Fatal error

8)

``Form atter failu re (reason follows)''
T he Formatter board is operati ng i ncorrectly, probably due to a ha rdwa re failure. T his is a general OK/FAIL indicator for t he Formatter board, and is a summa ry of ot her status conditions which appear later i n t he display.

9)

Mnemonic Type Console Msg: Interpretation

: STAT_DRDFAIL : Fatal error

``DRD failure (reason follows)''
: T he Data-Recovery/Deformatter board is operati ng incorrectly, probably due to a ha rdwa re failure. This is a general OK/FAIL indicator for t he DRD board, a nd is a summary of other status conditions which appear later i n the display.

4 - 63


S2-RT User's Manual

OPERATION

11)

Mnemonic: Type: Console Msg: Interpretation:

STAT_UICFAIL Fatal error

``UI board failu re (reason follows)''
T he User Interface boa rd is operati ng incorrectly, probably due to a ha rdwa re failure. T his is a general OK/FAIL indicator for the UI board, a nd is a summa ry of ot her status conditions which appear later i n t he display. STAT_TRANFAIL Fatal error

12)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn failure (reason follows)''
One or more t ransports a re operating or ha rdwa re failure. T his is a general is a summa ry of other status conditio failed transport listed here will also be port window. STAT_ROSSWFAIL Fatal error incorrectly, probably due to a cable fault OK/FAIL indicator for the tra nsports, a nd ns which appear later in the display. Each marked with a highlighted `F' i n the Trans-

13)

Mnemonic: Type: Console Msg: Interpretation:

``ROS s/w failure (reason follows)''
T he Recorder Operati ng Sy stem softwa re is operati ng incorrectly. This is a general OK/FAIL i ndicator for the S2 software, a nd is a summary of other status conditions which appear later in the display. STAT_SRAMCHKSUM Fatal error

15)

Mnemonic: Type: Console Msg: Interpretation:

``SRAM board bad ch eck sum (xxx)''
One or more partitions of the 3 MB SRAM boa rd have become corrupted a re faili ng a checksum comparison test. Try rebooting t he S2 sy stem to see results of simila r checksum tests performed duri ng bootup. The corrupted partit or the enti re 3 MB SRAM, probably needs to be reloaded. See Section 6.2 i nformation on how to re-load a corrupted SRAM. STAT_NOSRSYR Fatal error a nd t he ion, for

16)

Mnemonic: Type: Console Msg: Interpretation:

``64 Hz frame sync is absent!''
T he Formatter 64 Hz frame sy nc signal (SRSYR), which normally drives most of the S2 i nternal hardware and software, is absent. T his is a severe i nternal timi ng fault, and causes t he S2 sy stem clock to stop. It can be caused by a failure of t he timi ng or i nterrupt generation circuit ry on t he Formatter board, or a failure of t he System Clock PLL on the UI board. This does not i ndicate t he absence or presence of user-supplied clock signals -- see STAT_NOREFCLK a nd STAT_NOREF1HZ. STAT_NOFG1 Fatal error

17)

Mnemonic: Type: Console Msg: Interpretation:

``System 1 Hz tick is absent!''
T he Formatter 1 Hz reference tick (FG1) is absent. This is a severe i nternal timi ng fault. It can be caused by a failure of the timing circuit ry on the Formatter board. This does not indicate the absence or presence of user-supplied clock signals -- see STAT_NOREF1HZ.

4 - 64


S2-RT User's Manual

OPERATION

18)

Mnemonic: Type: Console Msg: Interpretation:

STAT_TASKFAIL Fatal error

``Task not ru nnin g: xxx''
One or more required ROS software tasks are not running. A task may die if it encounters a severe error condition or detects a n i nternal inconsistency, resulti ng i n this message. The S2 sy stem should be rebooted by cycling the power or pressing t he RCC ``reset'' button. STAT_TRANSWFAIL Fatal error

19)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn s/w fail: xxx''
One or more t ransport internal processors have detected a softwa re-related failure. T he possible ty pes of failure a re as follows: EEPROM chksum bad: T he tra nsport i nternal EEPROM has been corrupted. T his contains the TCP program code and TCB Xilinx configuration, plus calibration parameters and service history information. T he transport must be completely reprogrammed using transport N program. stack overflow: The t ra nsport softwa re stack has grown past a predefined limit. This indicates a software bug a nd should be reported to CRESTech. T he t ransport may conti nue to operate normally since there is a built-in safety ma rgin before the stack actually overflows. speed set fail: T he t ransport could not set its speed or sense the correct speed. T his indicates a probable hardware failure in t he speed sensing circuitry. STAT_TRANTPMOTFAIL Fatal error (clear-on-read)

20)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn tape motion fail''
A t ra nsport has detected that the tape motion state is not as required via a sensor on t he takeup reel. The tra nsport automatically issues a stop command to itself (without affecting other t ra nsports) to return to a consistent state. T his situation can arise when a t ra nsport fails to respond to a tape motion command (``missed remote cont rol code''), or if t he tape jams or t here is some mecha nical failure. T here can be a delay of up to 30 seconds before t he t ra nsport recognizes a tape motion failure. For example, suppose a rewind comma nd is issued for all 8 transports but one of them, transport 2, fails to respond due to a missed remote control code. Initially t he console display for tra nsport 2 will i ndicate t hat it is rewi nding alt hough it is in fact stopped, having never physically started rewinding. After approximately 30 seconds a tape motion fail status message will appear a nd transport 2 will be instructed to stop, after which t he display will correctly show that it is stopped. Users should react to the STAT_TRANTPMOTFAIL condition by stoppi ng the current operation and restarting it from t he beginni ng. Repeated occurrences of STAT_TRANTPMOTFAIL indicate a tape jam or hardware failure withi n t he transport. In t he rare event that a tra nsport repeatedly stops on erroneous tape motion fail conditions, yet appears to be worki ng properly, you can disable t he tape motion fail behaviour using t he command transport N options takeupsense disable. T his command may be put i n t he autoexec batch file to remai n effective even after rebooting. STAT_TRANBADTEMP Fatal error

22)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn temp out of range!''
One or more t ra nsport i nternal temperatur perature (greater t han 60 or less t ha n 5 turns itself off and cannot be turned on level. Check the TAM rack fans a nd air e sensors show an unsafe operating temdegrees C). T he transport automatically until the temperature returns to a safe filters for proper operation. To display

4 - 65


S2-RT User's Manual

OPERATION

t he temperature measurements, ty pe transport display temp or transport status volt. If a tra nsport's temperature reads out of range but it is known not to actually exceed the temperature limits, t he temperature sensor may need to be recalibrated (see the caltemp option of the transport command on Page 4-53). 23) Mnemonic: Type: Console Msg: Interpretation: STAT_TRANWARNTEMP E rror

``Tran nnn temp almost ou t of range''
One or more tra nsport i nternal temperature sensors show a temperature greater t han 55 or less t han 8 degrees C, which is close to t he unsafe operating limits. T he t ransport will conti nue to operate normally unless the temperature rises or falls past the limits defined for safe operation i n STAT_TRANBADTEMP, above. Check t he TAM rack fans a nd ai r filters for proper operation. To display the actual temperature measurements, ty pe transport display temp or transport status volt. STAT_TRANDEAD Fatal error

24)

Mnemonic: Type: Console Msg: Interpretation:

``Req'd transpts nnn are off/dead''
One or more currently selected t ra nsports are off or dead. Dead tra nsports show up as ``--'' in the t ransport display. This means that the Recorder Control Computer is unable to communicate with t he tra nsport, possibly due to breaks in the TCL serial cable or failure of the Transport Control Processor. Transports which a re off show up as ``off '' i n the Tra nsport window. Some reasons for a t ra nsport to turn itself off i nclude excessive condensation, temperature out of ra nge (see STAT_TRANBADTEMP), and i nternal ha rdwa re failures. You can try turning it on agai n using transport N power on or the front-panel power button (labeled ``operate'' on AG2530s). STAT_TRANBADVOLT Fatal error

25)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn +5V/-5V supply bad (C4)''
One or more tra nsports a re not receiving proper ±5 V supplies over the C4 cable. T he acceptable voltage ra nges are +4.1 to +5.5 V for t he +5 V supply and -4.1 to -5.5 V for t he -5 V supply. Check t he C4 cable connections and t he interface circuits on eit her side (t ransport, DRD board). In particular, t he t ransport ±5 V supplies pass t hrough chokes on t he DRD board which tend to act as fuses a nd can blow. To display the actual supply voltage measurements, type transport N status volt. STAT_TRANBADRECSIG Fatal error

26)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn record clk /data bad (C3)''
One or more t ra nsports a re not receiving proper clock and data signals from t he C3 cable. Check t he C3 cable connections and the i nterface circuits on eit her side (tra nsport, Formatter board). To determi ne which of t he clock/data signals a re missi ng, type transport status recsig.

4 - 66


S2-RT User's Manual

OPERATION

27)

Mnemonic: Type: Console Msg: Interpretation:

STAT_ILMODE Fatal error

``Recorder mode is illegal''
T he recorder mode is not properly set. Caused by a failure i n setti ng the mode, a nd indicates a probable hardware fault on t he UI board (DDDV Xili nx chip download chai n). STAT_NOREFCLK Fatal error

28)

Mnemonic: Type: Console Msg: Interpretation:

``User referen ce S-Clk /C-Clk/X-tal is absen t''
T he System Clock PLL is currently set to lock mode), but no clock is being supplied over the (CCLK). If t he Sy stem Clock PLL mode is a failure of t he UI boa rd on-board 32 MHz STAT_NOREF1HZ Fatal error to an external high-rate clock (refclk C1 cable (SCLK_REC) or C2 cable set to xtal, this message i ndicates crystal oscillator (X-tal).

29)

Mnemonic: Type: Console Msg: Interpretation:

``User ref S-1/C-1 Hz syn c is absen t''
T he System Clock PLL is currently set to lock to an external high-rate clock (refclk) a nd/or 1 Hz tick (1hz), but no 1 Hz tick is being supplied over the C1 cable (S1HZ_REC) or C2 cable (C1HZ). STAT_BADSTNDELAY E rror

32)

Mnemonic: Type: Console Msg: Interpretation:

``Stn delay measurem en t != setting''
T he station delay measurement does not match the setti ng from the last delay command (Sy stem Clock PLL refclk mode only). T his is most likely to be caused by a glitch i n t he user's high-rate reference clock. For example, if t he clock rate is 32 MHz, a glitch might cause more t han (or fewer tha n) 32,000,000 clock cycles to be registered over a one-second period, resulti ng i n a shift of t he S2's i nternal 1 Hz tick with respect to the external 1 Hz reference. A station delay mismatch can also be caused by an actual shift i n t he external or internal 1 Hz timi ng, or by instability of the Sy stem Clock Phase-Lock Loop. Delay mismatches may persist once they have arisen because the S2 i nternal 1 Hz tick is not automatically resynchronized unless scpllrefclkfix is set to 1 i n t he defaults file (see below). Delay corrections can be made ma nually by resetti ng the appropriate delay value (usually 0) with t he delay command. If t he condition persists, check the i nput clock frequency selection (userio clkin). E nsure that the external clock a nd 1 Hz sy nc signals conform to S2 interface specifications given in Appendix B. If after t his t he delay still cannot be set, t here is probably a hardware fault i n the UI timi ng circuitry. T he S2 can be i nstructed to automatically ``fix'' station delay mismatches by setti ng the defaults-file parameter scpllrefclkfix to 1. In this case a ny station delay mismatch t hat a rises and remains stable for 2 seconds will be corrected by reasserti ng t he last entered station delay value. See the station delay measurement description on page 4-18 for more information. STAT_UICVERFAIL E rror (clear-on-read)

33)

Mnemonic: Type: Console Msg: Interpretation:

``UI verifier errors: nnn''
Indicates one or more UI board verifier errors have occurred since t he last status read (RCL)/reset (console). In C1 cable test mode, this shows a C1 cable connection fault. During record, this i ndicates a failure of the distributor or de-distributor on

4 - 67


S2-RT User's Manual

OPERATION

t he UI board. Note: UI verify errors a re not considered fatal because conti nuous verifier errors activate STAT_UICFAIL, which is fatal. 34) Mnemonic: Type: Console Msg: Interpretation: STAT_SYNCERR1HZ E rror (clear-on-read)

``1 Hz syn c errors: nnn''
Indicates one or more i nternal 1 Hz sy nc errors have oc read (RCL)/reset (console). A 1 Hz sy nc error is defi ned i nternal FG-1 Hz ticks that are not exactly 64 frames a errors can indicate a failure of the Formatter or User STAT_NESTFRINT E rror (clear-on-read) curred since the last status as two consecutive system part. Excessive 1 Hz sy nc Interface boards.

35)

Mnemonic: Type: Console Msg: Interpretation:

``Nested frame in terrupts: nnn''
Indicates one or more nested frame-sy nc i nterrupts have occurred since the last status read (RCL)/reset (console). This can be caused by frame sy ncs (SR SYR) occurri ng too close together, such as might happen during an internal timing glitch. STAT_LATEFRINT E rror (clear-on-read)

36)

Mnemonic: Type: Console Msg: Interpretation:

``Late frame in terrupts: nnn''
Indicates one or more frame sync i nterrupts have been late or missed since t he last status read (RCL)/reset (console). A late frame interrupt is defined as a period longer t han 1/60th of a second wit hout the occurrence of a frame sy nc i nterrupt. T his can be caused by a sy stem i nternal timing glitch or absent SRSYR signal (see STAT_NOSRSYR). STAT_SCPLLBADMODE E rror

37)

Mnemonic: Type: Console Msg: Interpretation:

``Bad SC PLL mode (sh ould be xxx)''
Appears during record if t he System Clock PLL mode is not refclk and external i nput data is being recorded. The S2 must lock to an external high-rate reference clock for correct record operation, t herefore the SC PLL mode must be refclk. T he SC PLL mode can be set using the scpll mode comma nd or by cha nging the scpllmode parameter in t he defaults file (edit defaults). STAT_SCPLLUNLOCK Fatal error

38)

Mnemonic: Type: Console Msg: Interpretation:

``System clk PLL is unlocked''
Indicates t hat t he System Clock PLL is not locked. This message is t riggered by continuous SC PLL sy nc errors (see STAT_SCPLLSLIP). It is normal when lock is first being acquired i n SC PLL 1hz and errmes modes. If the SC PLL mode is refclk, check t he i nput clock frequency selection (userio clkin) and ensure t hat the external clock signal conforms to S2 i nterface specifications given in Appendix B. If problems persist, there may be a fault in t he Sy stem Clock PLL ha rdwa re on t he UI board. If the SC PLL mode is xtal, there may be a problem with t he UI on-board 32 MHz crystal oscillator. STAT_SCPLLSLIP E rror (clear-on-read)

39)

Mnemonic: Type: Console Msg: Interpretation:

``System clk PLL syn c errors: nnn''
Indicates that t he Sy stem Clock PLL is not locked, or is having difficulty locking to its reference. Occurrence of t his message is normal when lock is first being

4 - 68


S2-RT User's Manual

OPERATION

acquired, particularly in SC PLL 1hz and errmes modes. Conti nuous sy nc errors mean the SC PLL is unlocked, a nd will activate t he STAT_SCPLLUNLOCK status message. If t he SC PLL mode is refclk, ensure t hat the external clock signal conforms to S2 i nterface specifications given i n Appendix B. If problems persist, t here may be a fault in the Sy stem Clock PLL hardware on t he UI board. If t he SC PLL mode is xtal, there may be a problem wit h t he UI on-board 32 MHz crystal oscillator. In SC PLL 1hz mode t he SC PLL is considered unlocked whenever t he difference between the external and internal 1 Hz ticks is more t ha n about about 60 microseconds from its i ntended value. This is equivalent to the difference between t he current station delay setting a nd t he delay measurement shown on t he console display. A similar definition of lock applies i n SC PLL errmes mode, except that t he user-supplied error measurement is used. T his lock definition has been chosen somewhat a rbitra rily based on the requirements of space VLBI a nd t he capabilities of t he S2 hardware. T he occurrence of STAT_SCPLLSLIP or STAT_SCPLLUNLOCK status errors does not in itself indicate a problem with S2 internal timi ng, only that t he synchronization wit h the external reference has exceeded t he 60 us t hreshold. However internal timi ng problems resulti ng i n loss of data become more likely i n this situation. See the description of the delay command for more information. 40) Mnemonic: Type: Console Msg: Interpretation: STAT_DRDMISSIG E rror (clear-on-read)

``DRD missed/extra sigs: nnn/nnn''
Indicates one or more missed or ext ra DRD signatures were detected s last status read (RCL)/reset (console). T he Recorder Control Computer DRD 8051 control processor sy nchronize by exchanging signature codes, missing or extra signatures mean a problem wit h that sy nchronization. missed sigs can be caused by timing glitches, but continuous missed sigs a probable failure of the DRD cont rol processor. STAT_FORMDFIFOTERR E rror (clear-on-read) ince t he a nd t he and a ny Isolated indicate

41)

Mnemonic: Type: Console Msg: Interpretation:

``Form d-FIFO tim in g errs: nnnnnnnn''
Indicates i nternal timi ng errors i n one or more S2 Formatter channels, specifically t he data FIFOs. Isolated Formatter data-FIFO errors can be caused by glitches in system timing, such as Sy stem Clock PLL sy nc errors (STAT_SCPLLSLIP) -- check your external timing reference. Continuous data-FIFO errors probably mean a hardware fault on the Formatter board. The error condition is sampled only once per second so t here can be at most one data-FIFO error reported per second, but i n actual fact there may have been more. T he display shows t he number of errors i n one of two formats: if t here have been fewer than 10 errors i n all 8 Formatter channels, a string of 8 digits is shown where each gives t he number of errors i n t he correspondi ng Formatter channel (0­7). If any channel has had 10 or more errors, only the cha nnel with the most errors is shown. T he impact of a Formatter data-FIFO error event duri ng record is that at least one frame of data will be lost i n all cha nnels, even if only one channel registered an error (there a re 64 frames per second). During playback t here should be no adverse effect since t he formatter is not used, assumi ng no other timi ng-related problems occurred. STAT_MK3PLLSLIP E rror (clear-on-read)

42)

Mnemonic: Type: Console Msg: Interpretation:

``Mk3 PLL syn c errors: nnn''
During Mark III/IV-compatible operation, indicates the Mark III PLL on t he UI board is having difficulty locking. Isolated Mark III PLL errors can be caused

4 - 69


S2-RT User's Manual

OPERATION

by cha nges i n sy stem timi ng, such as when the a nd bypass/record, or when the recorder mode is when switchi ng t he Mark III formatter on or off stable, t his message i ndicates a probable failure of 43) Mnemonic: Type: Console Msg: Interpretation: STAT_MK3MISSYNC E rror (clear-on-read)

setup is cha nged between play cha nged. T hey can also appear . If sy stem timing is otherwise t he UI Mark III timi ng circuitry.

``Mk3 sync detect misses: nnn''
During Mark III/IV-compatible operation, indicates t hat t he Mark III formatted data contai ns missing or excess sy ncs, as determi ned by t he Mark III sy nc detector. T he sy nc detector is a diagnostic circuit i ntended to help verify correct Mark III formatter operation by checking for t he sy nc word pattern. Spurious sy nc misses can be caused by changes in sy stem timi ng, such as when t he setup is changed between play and bypass/record, or when the recorder mode is cha nged. They can also appear when switchi ng the Mark III formatter on or off. If sy stem timi ng is otherwise stable, t his message may i ndicate a failure of the Mark III formatter on t he UI board. STAT_MK3DFIFOTERR E rror (clear-on-read)

44)

Mnemonic: Type: Console Msg: Interpretation:

``Mk3 d-FIFO timing errs: nnn''
Indicates internal timi ng errors i n one or more Mark III formatter cha nnels, specifically t he data FIFOs. Spurious Mark III data-FIFO errors can be caused by changes i n sy stem timi ng, such as when t he setup is changed between play and bypass/record, or when the recorder mode is cha nged. They can also appear when switching the Mark III formatter on or off. Continuous Mark III data-FIFO errors probably mean a hardware fault on the UI board. STAT_TRANSYNCERR32 E rror (clear-on-read)

45)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn 32 Hz sync errs (n nn)''
Indicates one or more t ransports have detected 32 Hz sy nc errors since t he last status read (RCL)/reset (console). A sy nc error is decla red whenever t he 32 Hz sync signal from the Formatter appears more then 5 microseconds from its expected location, or is missing. T he 32 Hz sy nc is carried on t he C3 cable multiplexed with t he tape clock signal. T he number in brackets shows the highest number of sync errors of all t he affected tra nsports. Isolated 32 Hz sync errors can be caused by glitches in sy stem timing such as Sy stem Clock PLL sy nc errors (STAT_SCPLLSLIP), a nd are usually not serious as long as no other status errors exist. Conti nuous 32 Hz sync errors probably mean a C3/C4 cable connection fault or a ha rdwa re fault in the tra nsport or the Formatter. STAT_REFCLKOUTLOW Fatal error

46)

Mnemonic: Type: Console Msg: Interpretation:

``C2 ou tpu t ref clock rate too low''
T he C2 output reference clock rate is set to a value lower tha n t he current user channel data rate. Set t he correct clock rate using the userio clkout console command.

4 - 70


S2-RT User's Manual

OPERATION

47)

Mnemonic: Type: Console Msg: Interpretation:

STAT_ERRRCL Fatal error (clear-on-read)

``RCL error nnn: xxxxxx''
T he RCL task encountered an i nternal softwa re error. T his should not normally appear. If t he complete error message does not fit i n t he status wi ndow, error decode can be used to tra nslate t he numeric error code to t he full text message. STAT_ERRRPMON Fatal error (clear-on-read)

48)

Mnemonic: Type: Console Msg: Interpretation:

``RpMon error nnn: xxxxxx''
T he record/playback monitor task encountered a n unexpected softwa re error. T his can happen if conditions a re not correct for automatic record or play back, i n which case this message will be accompanied by other more descriptive status messages. If t he complete error message does not fit in the status window, error decode can be used to tra nslate t he numeric error code to the full text message. STAT_ERRMK3SW Fatal error (clear-on-read)

49)

Mnemonic: Type: Console Msg: Interpretation:

``Mk3 form s/w error nnn: xxxxxx''
T he Mark III/IV related software encountered an internal error. This should not normally happen. If t he complete error message does not fit in the status window, error decode can be used to tra nslate t he numeric error code to t he full text message. STAT_RPMONBOTEOT Fatal error (clear-on-read)

51)

Mnemonic: Type: Console Msg: Interpretation:

``Hit BOT/EOT/EOD du ring auto play/record''
One of the active t ra nsports encountered t he beginning of tape (BOT) or end of tape (EOT) duri ng automatic record or playback. The S2 has automatically stopped t he remaini ng transports. This message will also appear when a transport encounters t he end of recorded data (EOD) during playback tape alignment. EOD is defined as approximately 30 seconds or more of blank tape encountered during positioni ng or alignment (slewi ng) i n t he forward direction. STAT_RPMONILSTATE Fatal error (clear-on-read)

52)

Mnemonic: Type: Console Msg: Interpretation:

``Unexp tran state ch g during play/record''
T he current overall tape motion state unexpectedly changed to somethi ng other t han play/record duri ng automatic play back/record. T his can happen if t he transport front-pa nel buttons are pressed, or if certai n comma nds such as pause or cue a re used -- t hese comma nds should be avoided duri ng automatic playback a nd record. This message will also appear if a n attempt is made to record on tapes with the write-protect tabs broken, since write-protected tapes will be automatically ejected by the tra nsports (model AG2510) or t he t ra nsports will beep 7 times a nd refuse to go i nto record (models AG2520 and AG2530). STAT_TRANLKFAIL Fatal error

53)

Mnemonic: Type: Console Msg: Interpretation:

``Tran xxx servo failed to lock ''
One or more t ra nsport head-drum servos matic record or playback. This usually t ransport PLL performa nce, or problems on t he C3 cable. T his status code will remai n unlocked after 13 seconds in autoindicates a tra nsport failure or ma rginal wit h t he 32 Hz servo sy nc reference signal not appear during manual record/play.

4 - 71


S2-RT User's Manual

OPERATION

54)

Mnemonic: Type: Console Msg: Interpretation:

STAT_TRANLKLOSS E rror (clear-on-read)

``Tran nnn servo lock loss (glitch)''
One or more transport head-drum servos momenta rily became unlocked in automatic record or playback, and have (probably) regained lock. If t he servo is unable to regai n lock after 13 seconds, STAT_TRANLKFAIL will appear. When more t han one tra nsport loses lock around t he same time, some of t hem may not be listed i n t his status message. STAT_TRANLKLOSS appears only during automatic record/play (i.e. not during ma nual record/play, but the event will alway s be recorded i n t he ROS i nternal log). Servo lock glitches can be caused by damaged tapes or system timi ng glitches such as STAT_TRANSYNCERR32, or by i rregularities in t he movement of tape past t he heads. For example, in t he erase-gap between two different recordings the transport may momenta rily switch speeds, which can cause loss of lock. Transports with repeated unexplained loss of lock problems on different tapes should be serviced and checked for ha rdwa re faults. STAT_TRANTRK1FAIL E rror (clear-on-read)

55)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn stu ck in ph ase1 trk cal''
T he phase-1 tracking algorithm performed by the tra nsports is taking too long. T his message indicates a possible hardware fault or softwa re bug i n the Transport Control Processor. It may be caused by a broken t ransport cont rol t rack sensor which is erroneously reporti ng blank tape. STAT_ILSETUP E rror

56)

Mnemonic: Type: Console Msg: Interpretation:

``Bad setu p: xxxx''
T he current i nternal diagnostic signal path configuration is illegal or i nconsistent. T his normally appears only duri ng ma nual operation, a nd indicates t hat somethi ng is wrong wit h t he switch settings that define the setup. T he specific problem is given i n place of t he x's i n t he message, e.g. ``ch filt on, shld be off '': T he cha nnel emulation filter is being used when it shouldn't be ``ch filt off, shld be on'': T he cha nnel emulation filter is not being used when it should be ``decoded tra nspt is dead'': The tra nsport selected for decodi ng is dead ``decoded tra nspt is off '': T he t ransport selected for decoding is off ``DRD is dead'': T he DRD is marked not present STAT_INSTATE Fatal error

57)

Mnemonic: Type: Console Msg: Interpretation:

``Tape motion state is inconsisten t''
T he overall tape motion state cannot be consistently determined based on t he states of currently selected transports. For example, some t ransports are recordi ng a nd some are stopped. T his can also a rise if some or all t ra nsports a re i n a state that is not legal for sy stem operation, such as ``off '' or ``dead''. This status message is usually accompanied by other messages which clarify the problem. STAT_BADTRANSEL Fatal error

58)

Mnemonic: Type: Console Msg: Interpretation:

``Bad tran selection for mode/grou p''
T he set of selected tra nsports (ma rked with `*') is not correct for the current mode a nd group setti ngs. Normally the mode and group comma nds automatically select

4 - 72


S2-RT User's Manual

OPERATION

t he active t ransports as required. T his status message appears if a different selection is in effect during automatic record or playback. Stop t he S2 a nd select t he correct t ransports by (re)setti ng t he correct mode or group, or by typing transport autoselect. 59) Mnemonic: Type: Console Msg: Interpretation: STAT_CHIDDUP Fatal error

``Tran N & N tapes have same ch an ID''
During playback, (at least) two different tapes have t he same cha nnel ID, which means t hey were recorded on t ra nsports with t he same address. T he tapes probably come from different tape sets. Stop t he S2, insert the correct tapes, and resta rt playback. STAT_ALIGNFAIL Fatal error

60)

Mnemonic: Type: Console Msg: Interpretation:

``Unable to align tapes: error nnn''
A playback tape alignment operation has failed under circumsta nces for which alignment will not be automatically retried. This includes any user-initiated alignment operation as well as automatically i nitiated alignment operations that fail for certai n reasons as outli ned below. The reason is given by t he error code (nnn) embedded i n the message -- use error decode to t ra nslate t he numeric error code to a text message. Alignment must be explicitly re-i nitiated using the align command, or by stoppi ng and re-sta rting play back. Causes of STAT_ALIGNFAIL i nclude: ERR_ALCRSBOUND -- Crossed a boundary from one recording i nto another. Tape alignment can only be performed wit hin a single continuous recording. ERR_ALBADTIME -- Requested alignment time is out of ra nge. It is either more t ha n 10 hours away from t he current tape time, or in t he case of automatic self-alignment the difference between some transport's tape time and t he target time exceeds the value given for t he selfaligntime defaults-file parameter, normally 30 minutes. ERR_BOTEOT -- One or more transports ra n into beginning/end of tape duri ng alignment. All tra nsports have been stopped. ERR_EOD -- One or more tra nsports encountered EOD, the end of recorded data, during alignment. All transports have been stopped. STAT_ERRALIGN E rror (clear-on-read)

61)

Mnemonic: Type: Console Msg: Interpretation:

``Err aligning tapes: nnn (retrying)''
A playback tape alignment operation has failed under circumsta nces for which alignment will be automatically retried. The reason is given by the error code (nnn) embedded i n the message -- use error decode to t ra nslate t he numeric error code to a text message. The user may wish to take action if t his condition persists for a long time. Some causes of STAT_ERRALIGN i nclude: ERR_NOPBAUX -- Couldn't decode time from one or more transports (possibly ra n past end of recorded material). ERR_TRANLKFAIL -- Transport head-drum servo failed to lock. STAT_CHIDMISS Fatal error

62)

Mnemonic: Type: Console Msg: Interpretation:

``Tape with ch annel ID N is missin g''
During playback one or more of t he requi red tapes is missing. T his status condition is usually accompanied by STAT_BADTRANSEL or STAT_CHIDDUP. If one or more tapes in a set a re ever lost, it is still possible to play back t he remaini ng tapes but this status message will appear. You should manually de-select the unused

4 - 73


S2-RT User's Manual

OPERATION

t ransport before sta rting play back by typing transport autoselect-N where N is t he address of the unused t ra nsport. 63) Mnemonic: Type: Console Msg: Interpretation: STAT_BADGROUP Fatal error

``Tran N tape/data not part of cu rr grou p''
One or more of t he group of currently playi ng t ransports contains a tape t hat is not part of the current group. For example, suppose the mode is 16x4-1 a nd we have chosen group 0 (transports 0­3). If during play back the tape in t ransport 3 is found to contain channel 7 data (i.e. cha nnel ID 7), t he message ``Tra n 3 tape not pa rt of curr group'' will appear, since t hat tape (channel ID 7) was actually recorded as part of group 1. The same group setting as used at record time must be used for playback. T his status message can also appear wit h non-play back data, e.g. suppose t he situation is as above but the S2 is stopped a nd bypass path is selected. If we enter setup 3 transport 7, we will get t he message ``Tran 7 data not pa rt of curr group'' since bypass data from t ransport 7 is part of group 1, not 0. Duri ng automatic record or playback, this message usually appears along with other status conditions such as bad tra nsport selection (STAT_BADTRANSEL) or missing tapes (STAT_CHIDMISS). STAT_CHIDMISMATCH E rror

64)

Mnemonic: Type: Console Msg: Interpretation:

``Tape/Decoded chan ID does not match setup''
T he decoded cha nnel ID does not match the diagnostic channel selected in t he current setup. In other words, decoded data is being mapped onto the wrong internal S2 channel. Alt hough the decoder (DRD) is capable of outputting data onto a ny i nternal data channel leadi ng to the UI, t he ``right'' channel is t he one which matches t he channel used at record time. For example, if transport 4 bypass data is being mapped to channel 5 (setup 5 transport 4), t his status message will appear. However, if we are in play back a nd transport 4 contai ns t he tape with channel 5 data, then mapping it onto internal channel 5 is correct. Duri ng automatic record or playback, this status message usually appears along with other status conditions such as bad t ra nsport selection (STAT_BADTRANSEL) or tape not pa rt of current group (STAT_BADGROUP). STAT_NOPBAUX E rror

65)

Mnemonic: Type: Console Msg: Interpretation:

``Can't decode aux data/time from tran N''
During playback, auxilia ry data or time could not be decoded from t he indicated t ransport after t ryi ng for 15 seconds. Alt hough time is part of t he auxiliary data, it is easier to decode since it is treated specially and has its own CRC. Only one t ransport is listed, but the condition may apply to ot hers as well. The tape could be bla nk, or t here may be a problem wit h the transport or t he DRD. This message appears only duri ng automatic playback. STAT_BADPBTRANSEL Fatal error

66)

Mnemonic: Type: Console Msg: Interpretation:

``Can't set mode xxx, wrong # tran''
During automatic playback, t he S2 is unable to switch to t he mode t hat t he tapes were recorded i n because t he wrong number of t ransports is currently active. T his means t hat t he current mode has a total data rate that is different from the mode used for recordi ng. You must always select a mode with t he same total data rate as used at record time before sta rti ng play back. Stop t he S2, select an appropriate mode, a nd resta rt play back. T he simplest way to choose a mode is to use 16xN-1

4 - 74


S2-RT User's Manual

OPERATION

where N is t he same number of t ra nsports as used at record time. T he S2 will automatically switch to the correct mode after playback starts. 67) Mnemonic: Type: Console Msg: Interpretation: STAT_INTAPEID E rror

``Tran N & N have dif ferent tape IDs''
During automatic playback, (at least) two tapes have different Tape ID strings. T his could mean t hey come from different tape sets. If so, stop the S2, insert t he correct tapes, and resta rt play back. This message may appear momentarily if t he recorded Tape ID changes, but its presence will have no adverse effects on system operation. Nonetheless we recommend t hat the same Tape ID be used t hroughout the entire length of t he tape. STAT_BADPBESTERR E rror

68)

Mnemonic: Type: Console Msg: Interpretation:

``Tran N estimated err rate >n nn''
During automatic playback this i ndicates that the estimated error rate for one or more transports is above a certain ``acceptable'' threshold. The t hreshold is currently 5.0 x 10-4 for speed LP a nd 3.0 x 10-3 for SLP. This message should just be t reated as a warning, any more severe conditions will cause additional status messages to appear. To see t he actual estimated error rates for each t ra nsport type transport display esterr. STAT_RECBADSYNC Fatal error

69)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn rec data has bad sync''
T he diagnostic loopback data from one or more transports has missing or ma rginal sync duri ng automatic record. T his may mean that the data is not being recorded properly, and should be investigated immediately. Possible causes include Formatter failure, t ra nsport failure, or ma rginal C3/C4 cable connections. If the problem applies to all t ra nsports, it is also possible that t here is a fault in t he DRD. STAT_RECBADAUX Fatal error

70)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn rec data has bad aux''
T he diagnostic loopback data from one or more t ransports has excessive errors i n the decoded auxilia ry data duri ng automatic record. This may mean that data is not being recorded properly, and should be investigated immediately. Possible causes include Formatter failure, transport failure, DRD failure, or ma rginal C3/C4 cable connections. STAT_RECBADCHID Fatal error

71)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn rec data has wron g ch id''
T he diagnostic loopback data from one or more tra nsports contai ns the wrong cha nnel ID duri ng automatic record. T his i ndicates i ncorrect wiring of t he C3 or C4 cables, a nd should have been caught by t he power-on self-test. STAT_BADAGCLEV Fatal error

72)

Mnemonic: Type: Console Msg: Interpretation:

``Tran nnn AGC levels out of range''
One or more t ransport AGC levels a re outside t he ``acceptable'' ra nge during automatic record or play (the AGC level i ndicates record or playback signal strength).

4 - 75


S2-RT User's Manual

OPERATION

During record t his probably means that the data is not being recorded properly, a nd could be due to a Formatter failure, tra nsport failure, or C3 cable connection fault. Duri ng playback t his may mean t hat data cannot be properly decoded, a nd is probably due to a failure in the indicated tra nsport(s). The acceptable AGC ra nges a re from 100 to 254 for record a nd 1 to 254 for playback. 73) Mnemonic: Type: Console Msg: Interpretation: STAT_MARGAGCLEV Informational

``Tran nnn AGC levels are marginal''
One or more t ra nsport AGC levels are outside the ``ideal'' range during automatic record or play (the AGC level i ndicates record or playback signal strength). T his will probably not affect operation, but should eventually be investigated. Check t he i ndicated t ransports. If recording also check the Formatter board and C3 cable. T he ideal AGC ra nges a re from 150 to 249 for record a nd 6 to 249 for playback. STAT_ERRLOG E rror (clear-on-read)

74)

Mnemonic: Type: Console Msg: Interpretation:

``Log file error nnn: xxxxxx''
An error was encountered mai ntaining the ROS internal log. To re-i nitialize t he log you may ma nually clear it using log clear. STAT_ERRDRCONFIG E rror (clear-on-read)

75)

Mnemonic: Type: Console Msg: Interpretation: Mnemonic: Type: Console Msg: Interpretation:

``Error in DRD DR config: nnn''
T he data-recovery calibration software encountered a n internal error. T his should not normally happen, a nd can usually be ignored. STAT_ERRDRTRACK E rror (clear-on-read)

76)

``Error in tran nnn tracking cal: nnn''
T he data-recovery phase-2 t racking calibration software encountered an i nternal error. This is display ed only at verbose level 3 for bot h t he console a nd t he RCL, a nd can usually be ignored. STAT_DELAYFIX Informational (clear-on-read)

77)

Mnemonic: Type: Console Msg: Interpretation:

``Station delay auto resets: nnn''
Gives a count of how ma ny times the station delay has been automatically corrected after becomi ng i ncorrect (glitchi ng) in SC PLL refclk mode. This correction can only happen if the scpllrefclkfix defaults-file parameter is set to 1. See also t he explanation of the STAT_BADSTNDELAY status code. STAT_NOALIGN E rror

81)

Mnemonic: Type: Console Msg: Interpretation:

``Tapes playing bu t not align ed''
T his message appears during playback when t he i ndividual tapes are not aligned to each other. In pa rticula r, it always appears when playback sta rts and then goes away once the automatic self-alignment procedure has aligned the tapes. While t his status condition exists playback data should be treated as i nvalid. Since t here is no single coherent tape time no ``overall'' tape time can be defi ned (t he RCL TIME_READ_PB command will return a n error, and relative tape alignment is not allowed). If for some reason alignment is lost duri ng playback, STAT_NOALIGN will reappear a nd t he S2 will attempt to re-align to t he current

4 - 76


S2-RT User's Manual

OPERATION

runni ng aligned-tape time. Certain errors such as ERR_ALCRSBOUND (``Tape alignment crossed recordi ng boundary'') will result i n t he fatal status code STAT_ALIGNFAIL which means t hat no furt her attempts will be made to realign. Other less-severe errors produce STAT_ERRALIGN, which means that alignment encountered an error but is being re-attempted. 84) Mnemonic: Type: Console Msg: Interpretation: STAT_ALIGNIP Informational

``Tape alignment in progress''
A playback tape alignment operation is i n progress, i nitiated eit her automatically or by request from the user. Upon completion, eit her STAT_ALIGNDONE or STAT_ALIGNFAIL will appear, a nd STAT_ALIGNIP will disappear. During alignment, STAT_ERRALIGN may appear but in t his case attempts to align will continue. STAT_ALIGNDONE Informational (clear-on-read)

85)

Mnemonic: Type: Console Msg: Interpretation:

``Tape alignment com pleted OK''
Playback tape alignment has completed successfully and t he overall tape time is now coherent a nd valid. Requires verbose level 3 to appear on the console, verbose level 1 or greater on the RCL. STAT_TAPESYNCERR E rror (clear-on-read)

89)

Mnemonic: Type: Console Msg: Interpretation:

``Tape-time sync errors: nnnnnnnn''
T he time decoded from tape was not as expected. In each successive frame t he time should adva nce by exactly one unit. This message i ndicates a n unexpected timing shift of one or more frames by the t ransport, such as might be caused by a tape jam. Tape-time sy nc errors can also occur duri ng transitions between tape motion states, and during pause, so normally they a re counted only if t he tapes a re currently aligned. Another possible cause is a t ra nsition between two different recordi ngs. Any significant tape-time sy nc error is alway s accompanied by other status conditions such as STAT_NOALIGN, so STAT_TAPESYNCERR is not shown on t he console or the RCL unless t he verbose level is 2 or higher (1 is t he level for normal operation). The display shows the number of errors in one of two formats: if there have been fewer t ha n 10 sy nc errors i n all 8 t ra nsports, a string of 8 digits is shown where each gives t he number of errors i n the corresponding t ra nsport (0­7). If any t ra nsport has had 10 or more errors, only t he one wit h t he most errors is shown. STAT_SCPLLDACRAIL Informational

92)

Mnemonic: Type: Console Msg: Interpretation:

``System clk PLL DAC at/n ear rail''
T he Sy stem Clock PLL softwa re-controlled DAC mum limits. T his can occur only in SC PLL modes a nd is normal during i nitial lock acquisition. At t hat t he S2 is operating at or near the bounds of cont rol ra nge. STAT_SCPLLACCRAIL Informational value is wit hin 5% of its maxi1hz and errmes (i.e. play back), a ny time afterwa rds, it means its play back speed (delay rate)

93)

Mnemonic: Type: Console Msg: Interpretation:

``System clk PLL accu m at/near rail''
T he Sy stem Clock PLL softwa re accumulator value is within 5% of its maximum limits. T his can occur only in SC PLL modes 1hz and errmes (i.e. play back),

4 - 77


S2-RT User's Manual

OPERATION

a nd is normal during i nitial lock acquisition. At a ny time afterwa rds, it means t hat the S2 is operating at or near the bounds of its playback acceleration control ra nge. 94) Mnemonic Type Console Msg: Interpretation : STAT_DRTAPRAIL : Informational.

``DR taps at/n ear rail [n nn]''
: One or more data-recovery FIR filter tap T his could indicate poor or degenerate DR components on the DRD board, but can also accompa nied by poor signal channel flat to reset the filter taps. STAT_DREQSETRAIL Informational. s a re at or near their maximum limits. calibration, possibly caused by ma rginal usually be ignored. If t his condition is performance, you might t ry dr reset

95)

Mnemonic: Type: Console Msg: Interpretation:

``DR EqSet valu e at/near rail''
T he data-recovery equalization value is at or near its maximum limits. This could i ndicate poor or degenerate DR calibration, but can usually be ignored. Requires verbose level 2 or higher to appear on both t he console a nd the RCL. STAT_DRFSETRAIL Informational.

96)

Mnemonic: Type: Console Msg: Interpretation:

``DR FSet valu e at/near rail''
T he DR clock-recovery PLL center frequency (FSet) is at or near its maximum limits. This could i ndicate poor or degenerate DR calibration. Requi res verbose level 2 or higher to appear on both the console a nd the RCL. STAT_TRANDIEDBORN E rror (clear-on-read)

97)

Mnemonic: Type: Console Msg: Interpretation:

``Transports died/born : nnn/nnn''
Shows t he number of t ransports which have been declared ``dead'' and/or subsequently come back to life since the last status read (RCL)/ reset (console). A t ransport is declared dead after 3 unsuccessful communication attempts (2 retries). A dead tra nsport is i ndicated by ``--'' in t he console Transport window. T his message will appear when transports a re swapped while t he S2 is powered on, or when t ransports a re programmed. When you a re finished programmi ng, or have connected t he new transport a nd assigned its address, type status reset to clear the status message. STAT_TRANPKTRETRY Informational (clear-on-read)

98)

Mnemonic: Type: Console Msg: Interpretation:

``Transport packet retries: nnn''
Shows the number of Tra nsport Cont rol Link communications retries since t he last status read (RCL)/reset (console). This is a measure of the rate of communication errors over t he TCL link. A non-zero retry rate is not normally a problem unless it leads to consecutive retries and t ransports being decla red ``dead''. Excessive ret ries could i ndicate a problem wit h t he TCL cable, or a partial failure of the RS-485 bala nced line driver/ receiver on the Formatter or one of the transports. This message requires verbose level 3 to appear on both the console a nd the RCL. To see a debugging message on each retry showi ng which t ransport was being addressed, set t he verbose level to 1 a nd type transport debug on.

4 - 78


S2-RT User's Manual

OPERATION

99)

Mnemonic: Type: Console Msg: Interpretation:

STAT_DRFSETFADJ Informational (clear-on-read)

``DR Fine FSet adju stm en ts: nnn''
Counts t he number of i ncremental FSet adjustments followi ng clock-recovery lock acquisition. Excessive counts coupled with unstable data-recovery calibration i ndicate a possible failure on the DRD board related to t he VCO read-back ADC. Requires verbose level 3 to appear on both t he console and t he RCL.

4 - 79


S2-RT User's Manual

OPERATION

4.6 Power-on Self Test
T he power-on self-test procedure, self-test 1, is a comprehensive diagnostic designed to report a single fault or fault class, with the limitation that it will not initiate tape motion and t herefore does not perform a complete record/playback test (see Section 2.8 if you wish to test record and play back). Multiple faults will correctly cause self-test 1 to fail but may not be completely reported (typically only one of t he faults is shown). The test makes no assumptions about user inputs on the C1/C2 cables except when t he default System Clock PLL mode is refclk, i n which case t he user reference clock and 1 Hz signals must be present. Self-test 1 runs automatically as pa rt of the S2 startup procedure, unless t he skipselftest1 defaults file pa rameter is set to 1. If desired t he self-test may be executed ma nually from the console by typing diag self1 verbose. While the test is running most RCL commands which affect tape motion or sy stem switch setti ngs are prohibited. T he following checks a re performed by self-test 1: 1. Prerequisite Checks E nsures UI, FORM, and DRD boards are present a nd successfully downloaded. E nsures the requi red number of tra nsports is present, as given by t he diagnumtran defaults-file parameter (usually 8). If the Sy stem Clock PLL is i n refclk mode, checks t hat t he PLL is properly locked (i.e. no SC PLL sy nc errors detected). If in any other SC PLL mode, self-test 1 switches to xtal mode for t he duration of the test. Failure at any of the above steps causes self-test 1 to termi nate and pri nt a descriptive message to t he console interaction wi ndow. T he status window will i ndicate ``Diagnostic test failed'' with a negative numeric error code. 2. On-li ne Status Check At this point t he on-li ne status is checked for any fatal non-clear-on-read conditions. T he on-line status operates continuously rega rdless of what operation the S2 is currently performing (even duri ng the self-test). Some of t he releva nt status conditions i nclude: VME +5/-5.2/+12/-12 V power supply bad Sy stem internal 64 Hz frame sy nc (SRSYR) absent T ra nsport softwa re failure (i ncluding TCP EEPROM checksum test) T ra nsport +5V/-5V supply bad T ra nsport record clk/data bad UI verifier shows failure condition (indicates distributor/de-distributor failure) If any fatal non-clear-on-read status conditions a re found the self-test termi nates. T he status wi ndow will indicate ``Diagnostic test failed'' wit h diagnostic code DIAG_ONLINEFAIL. 3. Signal Path Checks T his series of tests verifies t he i ntegrity of S2 internal data pat hs. Checks tra nsport AGC levels are between 100 a nd 254 in bypass. Checks all N by pass channels have correct sy nc & auxiliary data, and show acceptable FORM BERC error rates (using MLSD decoding). N is determined by the diagnumtran defaults-file parameter (usually 8). Checks all N bypass channels show acceptable FORM BERC error rates using bit-by-bit decoding (reduced signal margin test, produces warning message only , does not fail self-test). Checks tra nsport addresses correspond to C3/C4 cable channel numbers. Using mode diag8 (or diag4 if fewer than 8 transports are present) to inject the UI diagnostic sequence, checks that all 16 user data channels show acceptable UI BERC error rates (by pass pat h). Failure at a ny of t he above steps causes the self-test to terminate a nd print a descriptive message to t he console interaction wi ndow. T he status window will i ndicate ``Diagnostic test failed'' with a positive numeric diagnostic code.

4 - 80


S2-RT User's Manual

OPERATION

In addition to self-test 1, some batch files are supplied with the S2 to test record and play back operation: berlp.tst records 30 mi nutes of FORM test vector data at speed LP a nd play s it back, measuri ng the bit-error rates obtained. berslp.tst records 30 mi nutes of FORM test vector data at speed SLP and play s it back, measuri ng the bit-error rates obtained. inter.tst repeats t he playback portion of eit her of t he above tests after t he tapes have been interchanged. T hese batch files a re intended to verify correct S2 operation followi ng shipment. See Section 2.8 for further details.

4 - 81


S2-RT User's Manual

TAPE

5. TAPE

5.1 Choice of Tape and Tape Speed
T he followi ng types of tape a re approved for use i n the S2-RT and S2-PT. Other ty pes of tape should be avoided. Type 1. Scotch® ST-120/SE-180 (20 micron) SVHS tape ma nufactured by 3M, now no longer in production. T his was available in North America as ST-120 and i n Europe/Australia as SE-180 (about 5% longer t ha n ST-120). 2. Maxell ST-182/SE-260 (13 micron) SVHS tape. Also available as t he very slightly shorter Maxell ST-180. May be designated ``XR-S Black'' or ``Professional Broadcast Quality ''. Note: T hese thin tapes will not work i n sy stems with AG2510 t ransports. 3. Ampex 289 ST-126/SE-180 (20 micron) SVHS tape. Some cassettes may be labeled ST-120 but are actually the same lengt h as the ST-126. 4. Fuji H471S ST-120/SE-180 (20 micron) SVHS tape. Available i n Nort h America as ST-120 and in Europe/Australia as SE-180 (about 5% longer t ha n ST-120). Refer to Table 5-1 for a summary of tape types a nd recording times. T he ``fast'' S2 tape speed is LP (29 micron t rack pitch), and gives 4 hours 1 minute total recording time per ST-126/SE-180 tape at a specified bit-error rate of less than 1 x 10-4. Typical bit-error rates of a round 1 x 10-5 can be expected i n LP. Note that AG2550 transports cannot record i n LP, but can play back LP tapes recorded using other tra nsports. Operating the sy stem at t he slower SLP speed (20 micron track pitch) gives 50% longer recording times, or 6 hours 2 mi nutes on ST-126/SE-180 tapes. SLP bit-error rate is specified at less tha n 1 x 10-3 averaged across 8 tra nsports, with typical bit-error rates a round 2 x 10-4. Note t hat AG2510 t ra nsports can record in SLP but should not be used for SLP playback due to inadequate performa nce. Wit h Maxell ST-182/SE-260 ``thi n'' tapes t he SLP recording time is extended to 8 hours 41 minutes, and although t hi n tapes have not been formally specified BER performance should be simila r to thick tape. Note t hat thi n tapes (those longer than ST-126/SE-180) do not work i n AG2510 tra nsports, but a re fine i n AG2520 and later model t ra nsports. T he type of tape being used in the S2 must be indicated using t he tapetype console comma nd or TAPETYPE_SET RCL command. A default setting to use at bootup can be defined using t he tapetype parameter i n the system defaults file (the defaults file is described i n Section 4.2.7). T he tape type is a one-digit code i ndicati ng one of several approved varieties of tape as listed above and in Table 5-1. The tape type code is used by the S2 to determine t ra nsport write-current levels, so technically it does not need to be set for play back but setting t he correct tape type is still recommended. For unlisted tape ty pes it is possible to enter digits NNNMMM where NNN is t he write current for LP a nd MMM is t he write current for SLP. T hese numbers must be determined empirically and will typically be supplied by CRESTech/SGL when a new tape type is approved for use i n t he i nterim until t he next offical software release (which will recognize the new type).

Part 1: /home/s2/doc/userman/working/txt/tape.txt x
5-1


S2-RT User's Manual

TAPE

Tape Type

Des cription

Length (meters)

Thick/ Thin

LP Time

SLP Time

Notes discontinued discontinued no t for AG2510s no t for AG2510s re comme nded

1 1 2 2 3 4 4

3M Scotch ST-120 3M Scotch SE-180 Maxell ST-182/SE-260 Maxell ST-180 Ampex 289 ST-120/ST-126/SE-180 Fuji H471S ST-120 Fuji H471S SE-180

246 258 371 367 258 246 258

thick thick thin thin thick thick thick

3h 50m 4h 01m 5h 47m 5h 43m 4h 01m 3h 50m 4h 01m

5h 45m 6h 02m 8h 41m 8h 35m 6h 02m 5h 45m 6h 02m

Table 5-1: S2 Approved Tape Types

5.2 Tape Shipping and Stor age
Tapes must be shipped a nd stored in closed contai ners. Canadian Space Agenc sleeve designed to hold a set of 8 tapes, a nd a padded cardboa rd shipping tapes total. Whenever tapes are not i n the tra nsports they should always be or equivalent tape contai ners are available sta ndard VHS dust jackets may y (CSA) tapes use a low-cost cardboa rd container that holds 4 tape sets or 32 placed in t heir contai ners. If no CSA be used.

For maximum data integrity, tapes should be stored vertically in the fully rewound position. Tapes should be fully rewound when shipped. Tape Shipping Environment T he ideal shipping environment for tape is 19­22 degrees Celsius, at a relative humidity of 45% to 55%. Environmental limits a re to be determined.

5-2


S2-RT User's Manual

MAINTENANCE AND SERVICING

6. MAINTENANCE AND SERVICING
T his chapter provides information a nd procedures for servicing a nd maintaini ng the S2-RT. For additional or updated service procedures please see t he following directory on our web site: ftp://ftp.sgl.crestech.ca/pub/s2/doc/service/

6.1 Troubleshooting Hints
T he following a re explanations for some commonly encountered problems. 1. Q: When issuing a record command, one or more tapes are ejected (model AG2510 tra nsports) or t he t ra nsports beep several times and refuse to go into record (model AG2520 or AG2530 transports) or t he t ra nsport tape display flashes a nd they refuse to go i nto record (model AG2550 transports). A: The write-protect tab on the edge of the tapes is broken off. See t he record comma nd on Page 4-43. 2. Q: The AG2520 t ra nsports make unexpected clicking noises after they have been stopped for about 5 minutes. A: Don't worry, t his is just the sound of t he tapes automatically unwrapping. It is normal. 3. Q: T he system reports spurious interrupt errors after adding or removing the Et hernet boa rd. A: The IACK backplane jumper for t he Ethernet board's VME slot (slot 2) must be put i n place when t he Ethernet board is removed, and taken out when the board is inserted. See Section 4.4. 4. Q: One or more t ransports a re off and refuse to turn on. A: T he t ransports automatically shut off when t he internal temperature is above 60 or below 5 degrees Celsius. They can also shut down if excessive i nternal condensation is detected. In t his case the console display will show ``off'' for the affected t ransports. First unplug t he t ransport power cords a nd wait for conditions to stabilize. If a transport still refuses to turn on, it could be t hat the temperature calibration factor has been corrupted and needs to be re-entered (see Section 6.4.5). If this is not the problem or t he tra nsport appears dead (shows ``--'' on the console display), the t ra nsport EEPROM could be corrupted. You might be able to reload it using the eject-button emergency procedure outlined at the end of Section 6.2. 5. Q: During bootup the S2 reports ``Error: Checksum incorrect -- SRAM corrupted''. A: Somethi ng has caused t he contents of t he 3 MB Static RAM boa rd to be corrupted. You will need to reload the affected pa rtitions or t he enti re SRAM. See Section 6.2 for details. 6. Q: I can't log on using rlogin/telnet or connect a n RCL socket from outside the local network. A: You must specify a gateway inet address i n the S2 boot parameters. Also the subnet mask must be correct in the ``i net on ethernet'' field of the boot parameters for gateway s to work. See Section 4.4.1 for more i nformation.

6.2 Software Reloads/Upgrades
T he S2 Recorder Operati ng Sy stem softwa re resides on t he battery backed-up Static RAM boa rd, and can be reloaded via t he console serial port in order to upgrade software or recover from a n SRAM failure. To do so you must operate the S2 from t he ROSCO termi nal emulator program. ROSCO runs on IBM PC a nd compatible computers, a nd also on PCFS Linux computers using the `dosemu' DOS emulator. T he data file for reloading t he S2 SRAM as well as the ROSCO program and other utilities a re supplied wit h the S2 on floppy diskettes. These files a re also available from the followi ng FTP di rectory: ftp://ftp.sgl.crestech.ca/pub/s2/sw load/ T his is the distribution directory for the latest S2 ROS software versions. Check t he README file i n this directory for downloading i nstructions. Also read the release notes supplied with each new softwa re version. For i nformation

Part 1: /home/s2/doc/userman/working/txt/maint.txt x
6-1


S2-RT User's Manual

MAINTENANCE AND SERVICING

a nd files necessary to run ROSCO on PCFS Linux computers using `dosemu', see: ftp://ftp.sgl.crestech.ca/pub/s2/pcfs/dosemu/ To reload t he S2 softwa re follow t hese basic steps: · Co nnect a se rial cable betw ee n the S2 console port (C7) and COM po rt 1 of your PC. Note: COM 2 can be used if necessary by changing t he port selection i n ROSCO (press shift-f5 then f1).
· · ·

While running ROSCO reboot t he S2 (one way is to turn t he power off and on). Immediately enter t he boot monitor by hitti ng the space bar during t he i nitial boot countdown. In t he boot monitor type restore Select t he ROSCO file menu by pressing shift-f9. If desired press f3 to spe cify a pa rtition name, then press f5 to transfer data to t he Static RAM. You will be prompted for t he file name of the SRAM image to t ransfer; enter the name of t he .bxo file for t he appropriate software version, e.g. b970207.bxo

T he transfer should sta rt immediately, a nd will show its progress by displayi ng t he number of bytes t ra nsmitted so far. Reloading the enti re 3-Megabyte Static RAM takes about one hour at the default console baud rate of 9600 baud. Reloadi ng using PCFS and `dosemu' takes longer, up to 3 hours, due to the slow speed of t he emulator. Note that a full SRAM reload will delete any batch files and configuration changes you may have made. It is sometimes possible to avoid t his problem by reloading only specific parts of t he SRAM: Before pressing f5 to start the t ransfer, press f3 to select a particula r partition (root, bin, exo, dr_config, tcpbin, vxworks etc.) or all for t he enti re SRAM. For some software upgrades, only a few of the partitions may need to be updated (which ones will be indicated in t he release notes supplied wit h the upgrade), a nd for certai n SRAM failures, only a single pa rtition may need to be reloaded. Importa nt batch or configuration files can also be saved a nd reloaded i ndividually over t he network to a suitably configured remote host (use the full remote pathname sy ntax in t he editor's :w or :e commands, e.g. :w boot.host:/s2dir/file.bat, or in t he VxWorks shell's copy comma nd). SRAM reloads a re possible, a nd i ndeed much faster, using the network instead of the serial port, but this requires a properly configured host computer and a different version of the SRAM data file. For more information see ftp://ftp.sgl.crestech.ca/pub/s2/doc/appnotes/HostSetup . Transport Programming Following a ROS softwa re upgrade, it may be necessary to perform an extra step to upgrade the softwa re which runs on the custom 8051 processor inside the tra nsports. T his softwa re is stored in electrically-erasable memory (EEPROM) and can only be changed wit h the S2 booted and runni ng normally. Reboot the S2 after completi ng t he SRAM reload and verify t hat all 8 tra nsports a re respondi ng properly 1 (the tra nsport wi ndow should show all t ra nsports a re stopped). T hen ty pe t he following console comma nd: transport all program T his will first display the version number a nd date of t he software currently loaded i n t he transports, followed by the version number and date of the new transport softwa re about to be loaded. The S2 will then wait for user confirmation by asking ``Are you sure (yes/no)?''. If t he version dates match perfectly there is no need to upgrade the transport software, so type no. Otherwise if the version dates are different ty pe yes and wait for transport programmi ng to complete (about 5 mi nutes). If everyt hing is successful t he S2 will report ``Transports 0-7: Programmed prog & all''. You should ignore most status messages which come up during programmi ng such as

1

If your S2 system has fewer than 8 transports, all transports present should be responding

6-2


S2-RT User's Manual

MAINTENANCE AND SERVICING

``Tra n N failure'', ``Req'd transpts N are off/dead'', ``Tape motion state is inconsistent'', and ``Tra nsports died/born: N/N''. Note t hat if your S2 sy stem has a mixture of transport types you will need to program t ransports of each type separately. For example, if your TAM `A' contains 4 AG2520 t ra nsports while TAM `B' contains 4 AG2530 t ra nsports, you must ty pe t he following: transport 0+1+2+3 program transport 4+5+6+7 program If a ny transport fails to respond withi n 30 seconds of being programmed the entire operation will abort wit h an error message. In t his case some tra nsports may not yet have been reprogrammed, a nd one t ransport may be dead or only partially programmed. If you have a t ra nsport t hat is apparently dead (does not beep and set its front panel address display a few seconds after power-on), it is sometimes possible to recover using a special ``emergency recovery'' feature: Hold t he eject button on t he front panel while applying power to t he transport. T his will force it i nto program mode, after which you can t ry to re-program it using transport N program all.ag25x0 where ag25x0 is the ty pe of t ransport. T his method works only for problems related to a (partially ) corrupted EEPROM -- use it only when all other possibilities, such as a bad TCL cable, have been thoroughly checked. For more i nformation on programming t ransports see t he transport comma nd on page 4-51.

6.3 DSCM Electronics Replacement and Servicing
T he DSCM electronics have no manual adjustments a nd should require servicing only to replace long-life lit hium batteries located on the SRAM and RCC boards (see below). Removing DSCM PC boa rds should otherwise only be required in t he event of a fault in t he electronics which requires substitution of a boa rd. DSCM PC boa rds are to be positioned as shown i n Figure 6-1. 1. T he RCC (MVME133XT) must be positioned in slot 1. 2. T he ETHERNET board, if present, should be positioned in slot 2. If no Ethernet board is being used, t he IACK (interrupt acknowledge) backpla ne jumper for slot 2 must be in place. If an Ethernet boa rd is present t he IACK jumper must be removed. 3. T he 3MB SRAM board should occupy slot 3. 4. Slot 4 should be empty , with t he IACK jumper in place. 5. T he Formatter (FORM) must be positioned in slot 5. 6. T he DRD a nd UI boards may occupy any of slots 6-9. SRAM and RCC Battery Replacement T he SRAM board uses two lithium batteries (type LTC-7PN, 3.5 V, 750 mAH) to retai n memory contents while t he power is off. T hese have a rated lifetime of 10 years a nd should be replaced when t he red FAIL LEDs on t he SRAM board come on. The MVME133XT RCC uses a n SGS-Thomson MK48T02 2K SRAM/clock chip with built-i n battery, lifetime 3 to 6 years. It should be replaced when t he RCC no longer retains t he sy stem time or network boot pa rameters while the power is off. Note that the S2 may be operated normally after t he SRAM/clock chip battery dies, except that the sy stem time will not be retained while the power is off and users requi ring t he network facilities will have to re-enter the boot parameters each time they turn on the sy stem (see Section 4.4.1).

6-3


S2-RT User's Manual

MAINTENANCE AND SERVICING

Data Recov ery /Deformatter: DRDr RCC E THERNE T SRAM FORM UI

TCL

C2a

RCL C2b

C3 Ethernet

C4

C1

SLOT #

1

2

3

4

5

6

7

8

9

WARNI NG! PC boards should only be remov ed or inserted when DSCM power is off. Be careful not to snag components on either side of the board against adjacent boards or panels. Where there is a blank panel to the left of the board being remov ed, the b lank panel should be remov ed first. The VME boards (RCC, Ethernet and SRAM ) must not be positioned in slot 4 or higher for any reason. The S2 custom boards (FORM , DRD and UI ) must not be positioned in s lots 1-3 for any reason. Failure to follow this directiv e will result in damage to the sy stem.

Figure 6-1: DSCM PC Board Configuration

DSCM FORM and DRD Replacement Followi ng i nsertion of a new FORM or DRD board or re-loading/replacement of the SRAM boa rd, t he self-test may fail or take unusually long on first power-on due to softwa re recalibration lead time. If t he self-test fails with high error rate or bad sync messages, re-run t he test one or two times by typing diag self1 verbose on t he console. If t he test still fails, try t he following: 1. Select bypass signal pat h: setup bypass 2. Wait until the display indicates Decoder sync: 100% and Est error rate: <1.0e-6. If t his does not occur withi n one minute, try enteri ng the comma nd dr reset flat. If t his still does not help t here may be a real hardware failure. 3. Reset t he S2 by turni ng it off and on or typing shutdown reboot on the console. T he self-test should now pass.

6-4


S2-RT User's Manual

MAINTENANCE AND SERVICING

Ref. No. IN P/L 7 (1) 6 (1) 34 (1) 17 (1) 45 (1) 14 (1) 71 (1)

Parts Nam e

Hour
500 1000 1500 2000 2500 3000 3500 4000 4500 5000

Ref. No . IN P/L 24 (1) 27 (1) 55 (1)

Parts Nam e

Hour
500 1000 1500 2000 2500 3000 3500 4000 4500 5000

Upper Cylinder U Cy linder U A/C Head FE Head Pressure Roller U Supply Reel Table U Takeup Reel Table U Supply Reel Shaft Takeup Reel Shaft



Supply Main Brake U Takeup Main Brake U Mode S witch Tape Transport Loading Base Cam Gear Section







132 (2) Timing Belt 25 (1) 13 (1) 70 (1) 92 (1) Supply Soft Brake (1) U Tension Band U Main Brake Spring Cleaner Roller U

133 (2)

Capstan Rotor U Capstan Shaft

* Note:
Symb ol Maintenance
Cleaning

Requirement
Ethy l -alcohol or Cleaning Liquid (purchased locally) Wipe dirt from the parts using Note: When cleaning rubber it may accelerate deterioration wipe the alcohol quickly and

Remark
soft c loth impregnated with Ethy l -Alcohol. parts, av oid using ex cessiv e alcohol since of these parts. After c leaning with alcohol, thoroughly.



Replacement Lubrication Greasing High Quality Spindle O il (purchased locally) Moly tone Grease (MOR265) Supply one or two drops of oil. Wipe the old grease and apply new grease.

Table 6-1: Maintenance Chart for AG2520 Transports

6.4 TAM Servicing
Other t ha n t he t ransports themselves, t he TAMs have no mechanical components requiring servicing except t he fan filters. T hese filters a re accessible via the back panel of t he TAMs a nd should be replaced every three months of continuous operation or if the S2 issues a t ransport temperature wa rni ng (transport internal temperature over 55 degrees Celsius).

6.4.1 Transport Replacement And Servicing
T he mechanics of the TAM t ra nsports a re to be serviced according to t he recommendations of t he ma nufacturer as defined i n t he AG2510/AG2520/AG2530/AG2550 service manual and summa rized in Table 6-1. T he service manual is available from CRESTech/SGL as part of the optional Transport Servicing Kit. Service intervals can be identified using t he service and head-use time counters built i nto the tra nsport software and available for readout using S2 console commands. Two measured time i ntervals are available: t he time since last service, also known as in-service time, a nd the time since last head replacement, also known as head-use time. A service is defined as any time t he tra nsport shell is opened for inspection or mai ntena nce such as cleaning/greasing, a nd should be i ndicated by typing t he following console comma nd after t he t ransport is back in operation: transport N service lastserv

6-5


S2-RT User's Manual

MAINTENANCE AND SERVICING

A head replacement is defined as a ny time the upper head cyli nder is replaced, and by defi nition also implies a service. It should be i ndicated by typing the followi ng console comma nd after the tra nsport is back i n operation: transport N service lasthead T hese two commands clear t he time since last service a nd the time since last head replacement, respectively, which are stored in EEPROM i nside each t ra nsport. Both of these times a re measured in hours and mi nutes of active head use, a nd can be display ed by ty pi ng transport N status time In addition to the i n-service and head-use times, t his also shows the total cumulative head use and total on time since manufacture, as in the followi ng example: Transport 2: On 5764h 51m, Head use 518h 44m/1662h, Serv 178h 02m/1662h T his indicates that ­The t ra nsport has been powered on for 5764 hours and 51 minutes since manufacture. ­There have been 518 hours and 44 minutes of active head use since t he last head replacement. ­There have been 178 hours and 2 mi nutes of active head use since the last service. ­There have been 1662 hours of active head use since manufacture. T hese values can also be displayed i n the t ra nsport wi ndow using the followi ng three console comma nds: transport display ontime transport display headtime transport display servtime

Transport Service History Each transport stores a text file withi n its EEPROM memory which lists details of service steps performed on t hat t ra nsport i n t he past. This file is useful for record-keeping by service personnel a nd should be updated each time a transport is serviced, cleaned, repai red, etc. Type the following command to bring up the service history file in the editor: transport N service edithist An example service history file is shown below. Service history Currently instal Date -----Jul 15, 1998 Jan 21, 1999 for AG2550 t ra nsport led TCP is tcp4102. Name TotHead* ---------------ROS 0019 P. Newby 0627 [s/n K7KD00164]. Work Description** ---------------------Service history sta rted. S0500 Cleaned tape path.

------------------------------------------------------------------* Actual total head time (hours). ** Include service code S[NNNN], where NNNN = nomi nal service hours (as per AG25X0 service cha rt), plus additional notes.

Transport Replacement Replacement or servicing of a transport requi res the removal of the t ra nsport from t he TAM rack, as follows: a) Transport Removal 1. Power down the system. T his is a precautionary step only. If operational requirements make it necessa ry to do so, the tra nsports can be removed while the power is on. 2. Unscrew a nd remove t he slider block from the rack infill brackets on t he front of t he rack. Remove the TAM back panel. Unplug the ribbon 50 ohm cable, serial and power cables from t he back of the transport to be removed. 3. Slide t he transport forwa rd until the slider catch is encountered. Remove the transport by depressing t he catches on bot h sides of the extended sliders while pulling forwa rd on t he t ra nsport. The transport

6-6


S2-RT User's Manual

MAINTENANCE AND SERVICING

will slide free of t he rack. AG2550 t ra nsports have no sliders and a re removed by pulli ng t hem forward from the front. In some cases it may first be necessary to push t he tra nsport forwa rd a few i nches from t he back of the TAM. b) Transport Insertion 1. Power down the system. T his is a precautionary step only. If operational requirements make it necessa ry to do so, tra nsports can be i nserted while the power is on. 2. Make a note of t he TCP serial number of the tra nsport(s) being inserted (number is printed on a label on the back of t he t ransport). T his will be needed later. 3. E ngage t he sliders and slide the t ransport backwa rds until the slider catch catches on both sides of the extended sliders while pushing backward on will slide i nto the rack. Some pressure may need to be applied to the front resistance of t he extended sliders. AG2550 transports have no sliders and ar t hem into t he appropriate slot as far as t hey will go. is encountered. Depress t he the transport. The transport of the rack to overcome t he e inserted by simply pushi ng

4. Screw in the slider block to the rack infill brackets on the front of the rack. The slider block does not need to be tightened excessively. Plug in the ribbon 50 ohm cable, serial a nd power cables into t he back of t h e t r a n s p o r t . S c re w o n t h e T A M ba c k pa ne l . N o t e t h a t t hum bs c r e w s s h o u l d be FINGER-TIGHTENED ONLY when securing S2 tra nsports and other TAM ha rdwa re. c) Tra nsport Address Assignment Replacement of a t ra nsport in t he TAM rack, or replacement of t he TCP board wit hin the transport, may requi re reassignment of the transport address. T he address is what disti nguishes cont rol messages to different t ra nsports a nd must match the C3/C4 cable cha nnel the t ra nsport is connected to, which depends on its position i n t he TAM racks. Address reassignment will normally be accomplished through the console. On the comma nd line, enter transport assignaddr [SERIAL NUMBER] [ADDRESS] where SERIAL NUMBER is the four-digit serial number found on a label on t he back of t he tra nsport of t he form TCP[SERIAL NUMBER] , a nd ADDRESS is t he cha nnel number of the transport (0 - 7). If at any time two (or more) tra nsports have t he same address, both will appear ``dead'' in the tra nsport display. However, t he transport assignaddr comma nd should still work properly provided the serial number used is correct. If for some reason a t ransport's serial number label is lost or becomes unreadable, t he number can be obtai ned using transport N status serial where N is t he tra nsport's address. If at the same time the t ransport's address is invalid (front pa nel display shows 69) or conflicts wit h ot her transports, proceed as follows: Disconnect the TCL serial cable (C5) from all transports except the one in question, t hen issue t he console comma nd transport 255 status serial. Re-label the t ransport serial number immediately. Transport TCP Board Replacement Occasionally it may be necessary to replace or swap t he TCP board i nside a tra nsport due to failures. Users a nd service personnel must be careful when replacing t he TCP board since t his board contai ns the EEPROM which holds important information such as head use time, service history, and pgshift and write current calibration parameters. T his service information must be t ra nsferred to the new TCP board. Therefore before you remove t he original TCP board ty pe t he following console comma nd: transport N service dumpmem tofile After replacing t he TCP board a nd reassigning t he correct address as explained under ``Transport Replacement'' type t his second command: transport N service loadmem NNNN Here NNNN is the old TCP serial number, since the new board will have a different serial number. Be sure to update t he label on the back of t he t ransport to show the new TCP serial number, a nd update t he service history file. If a TCP board is being replaced because it has failed you may not be able to carry out the i nitial dumpmem step. To guard agai nst t his problem t he S2 performs a dumpmem for each transport on every system boot, so

6-7


S2-RT User's Manual

MAINTENANCE AND SERVICING

Figure 6-2: Transport/Tape Diagnostics

you should still be able to t ra nsfer recent values for t he EEPROM parameters just by carryi ng out the second step. T he command config ls long can be used to check the date of the latest service info dump for a particular t ra nsport (look for a dump file name contai ning t he old TCP serial number). In the event that the configuration save area becomes full you may start to see error messages when dumping service info; if so you should type config delete all to erase all dump files and sta rt fresh.

6.4.2 System Service Calls
T he S2 console displays an estimate of bit error rate (BER) duri ng playback (see operation this will i ndicate an estimated BER of 1 x 10-4 or less (tape speed LP), or SLP). Although t hese values may occasionally be exceeded for short periods, i n the of BER estimates over spec i nvestigation of t he cause should be initiated. This i nves i ndicated in Figure 6-2. Section 4.2.8.1). In normal 1 x 10-3 or less (tape speed event of regula r occurrence tigation consists of t he steps

6.4.3 Transport Setup For Off-Line Tests
Normal operation of the t ra nsport requires that it be supplied with clock and synchronization signals from t he C3C4 cable connection on the back of t he t ra nsport. In a test configuration, these signals are supplied by t he DSCM via C3C4/C5 extender cables, available from CRESTech/SGL as part of the Tra nsport Servicing Kit or Tape Guide Adjustment Kit.

6-8


S2-RT User's Manual

MAINTENANCE AND SERVICING

6.4.4 Transport Write Current Optimization
Write current optimization is the process where t he best write current level for recording is determi ned individually for each t ra nsport. Any differences from t he nomi nal write current setti ng a re entered as an offset (wrlevoffset) stored i n t he tra nsport EEPROM. A significant improvement i n bit-error rates -- up to a factor of two or more on average -- can be obtained as compared to operati ng wit h a single global write current setting (all offsets zero). As of ROS version 3.2 a new fully automatic procedure is provided to optimize write currents a nd set the per-transport offsets. Users should run t he procedure each time t he rotary heads are replaced (1000 hour service interval). We also recommend running it at the 500 hour service i nterval due to possible effects of head wear. It's a good idea to run t he post-installation record/playback test (Section 2.8) before a nd after optimizi ng write currents to ensure t hat t here is no unexpected degradation in system performa nce; bit-error rates should improve or stay roughly t he same. T he steps required to perform write current optimization a re as follows: 1. Using the S2 console, select which tra nsports you wa nt to optimize by ty pi ng transport N+M+... To optimize write currents on all t ransports ty pe transport all 2. Insert writable tapes i n t he selected t ra nsports. You should use the type of tapes you use most often in your S2 system. 3. Rewi nd the tapes, or position t hem to a point at least half a n hour away from the end. 4. Set t he tape type which corresponds to the tapes you a re using a nd select speed SLP: tapetype N speed slp 5. E nter t he following comma nd to begin t he optimization procedure: transport wrlev optimize T his will iteratively record and play back tape, and may take several hours to complete (more than 5 hours when doing all eight t ra nsports), so you may wish to let t he procedure run overnight. Here is an example of t he output you will see i n the interaction wi ndow:
No tr Si (P It Wr Tr Wr Wr Wr Wr It Tr w performing write current optimization: ansports 0-7, speed 'slp', min # of iter=10, step size=10/6, tape type=3 t back. This will take about 5 hours and 15 minutes, possibly a bit longer. ress Cntl-C at any time to quit and display results up to that point) eration 1: Record phase. ite currents: 0: 70 1: 70 2: 70 3: 70 4: 70 5: 70 6: 70 7: 70 ansport temp: 0: 37 1: 38 2: 37 3: 35 4: 38 5: 37 6: 36 7: 38 ite currents: 0: 55 1: 55 2: 55 3: 55 4: 55 5: 55 6: 55 7: 55 ite currents: 0: 65 1: 65 2: 65 3: 65 4: 65 5: 65 6: 65 7: 65 ite currents: 0: 75 1: 75 2: 75 3: 75 4: 75 5: 75 6: 75 7: 75 ite currents: 0: 85 1: 85 2: 85 3: 85 4: 85 5: 85 6: 85 7: 85 eration 1: Record phase complete, now repositioning & playing back. iggering phase-1 tracking calibration (will also do phase-2) -- Raw Bit-Err an 0: wrlev 55: an 1: wrlev 55: . an 7: wrlev 55: eration 2: Recor ite currents: 0: or Rates For Iteration 1 -354 65: 721 75: 528 2999 65: 3409 75: 3893 555 65: 705 75: 766 d phase. 65 1: 55 2: 55 3: 55

tr tr .. tr It Wr

85: 825 85: 4430 85: 1057 4: 65

new new new

wrlev: 65 wrlev: 55 wrlev: 55 6: 75 7: 55

5: 65

T he procedure will continue for ten iterations, possibly more if t he write current hasn't converged yet for some tra nsports. When done, it will display the final write current from the last iteration, and the
6-9


S2-RT User's Manual

MAINTENANCE AND SERVICING

``best'' write current for each transport. T he best write current is a n average of t he results from iterations followi ng convergence (the number of iterations included in the average is shown on the second-last line, after t he slash).
Wr tr #i be [H ite an 0 ter st 0 it r current opti : 60 1: 72 10/3 10/6 : 61 1: 71 eturn to con miza 2: 10 2: tinu tion 48 /3 49 e] end 3: 3 10/ 3: 4 ed, 84 3 04 final & "best" a : 78 5: 72 6: 10/6 10/5 10 : 81 5: 73 6: vera 70 /4 72 ge w 7: 5 10/ 7: 5 rite currents: 4 5 4

At this poi nt y ou should press return. After confirmi ng the tape type, the new optimum per-transport write current offsets a re calculated a nd t hen you will be asked to confirm before the new offsets a re actually written into t he t ransport EEPROMs:
Ta Is He Ol Ne En th Tr pe type is 3: Ampex 289 ST-126/SE-180 (70/70) this the correct tape type for the tapes now in use (y/n/q)? y re are the old and new optimum per-transport write current offsets: d: 0:-12 1:-4 2: 33 3: 25 4:-22 5:-10 6: 4 7: 0 w: 0:-21 1:-3 2: 12 3:-5 4:-11 5:-7 6: 6 7:-16 ter "y" or "yes" to write the new per-transport write current offsets into e transport EEPROMs, "no" to skip: y ansport 0-7 write current offsets updated to new optimum values.

All displayed information is also written to the S2 internal log and can be reviewed later by typing log display E fullscreen . Offset values should not normally be larger than about 40 or 50, alt hough almost any value can be fine if t he t ra nsport performs well. If you suspect a problem wit h t he resulti ng write-current offsets you should not write them into the t ransport EEPROMs (answer ``no''). T ry repeating t he optimization, or contact s2support for advice (i nclude a copy of t he log output). Note that if you have AG2550 t ra nsports you should try to perform write current optimization under the same temperature conditions as your normal record operations, since AG2550 write currents are somewhat temperature dependent.

6.4.5 Transport Temperature Calibration
Calibration of t he transport temperature sensors should be performed if there is reason to suspect that one or more of t he sensors a re out of calibration. It may be convenient to do this whenever the TAM fan filters a re replaced. The calibration procedure is as follows: 1. Power down the sy stem for eight hours i n a temperature-stable environment so that the transports can cool to room temperature. 2. While the system is off, measure t he ambient temperature near the TAMs in degrees Celsius. If t he TAMs are not exposed to localized temperature or ai r flow conditions, the temperature of the room should be adequate for calibration. 3. Disconnect t he C3 a nd C4 cables between t he TAMs and DSCM a nd turn on the power of the DSCM only so as not to disturb the temperature of t he t ra nsports. 4. Following the power-on self-test (which has failed owing to t he disconnected cables), comma nd t he sy stem to display tra nsport temperatures on t he console: transport display temp (The temperatures will not be shown yet since the TAMs are still off.) 5. Reconnect the C3 and C4 cables and t hen turn on the power to the TAMs. As soon as all the t ransports a re responding (as observed in t he console transport wi ndow), calibrate the temperature as follows: transport all caltemp [REF] where [REF] is the temperature i n degrees Celsius measured i n step 2 above. If any t ransports are off due to (erroneous) under- or over-temperature conditions you should use ``0+1+2+3+4+5+6+7'' i nstead of ``all'' in the command above.

6 - 10


S2-RT User's Manual

MAINTENANCE AND SERVICING

6. If any t ra nsports a re off due to previous under- or over-temperature conditions, type transport 0+1+2+3+4+5+6+7 power on to turn them back on. For additional information see the description of the caltemp option of t he transport comma nd on Page 4-53.

6 - 11


S2-RT User's Manual

MAINTENANCE AND SERVICING

6.4.6 Transport Tape Guide Adjustment
Poor transport performa nce (as shown by high estimated error rates or error rates above spec i n the post-installation record/playback test, Section 2.8) may i ndicate that t he tra nsport P2 a nd P3 tape guide posts require adjustment. In particular, t his adjustment has sometimes been found necessary followi ng shipment of S2 sy stems. Required Tools T he tools requi red to perform tape guide adjustment a re supplied as part of the Transport Tape Guide Adjustment Kit. They are also pa rt of the la rger Tra nsport Servicing Kit. T he requi red tools are as follows: · Po st adjustment sc rew d river, Matsushita/Panaso nic part# VFK0329
· · · ·

Transport C3C4/C5 extender cable (TRXTNDR) SMB-to-BNC converters (2) Matsushita/Panasonic NTSC alignment tape, pa rt# VFM8080HQFP ``S2 alignment tape'' (best tape recorded during post-i nstallation test, not supplied, see below)

Basic Steps Stripped to its essentials, the procedure is described by the following sequence. Detailed i nstructions a re given later below. A. Measure baseli ne performa nce using t he ``S2 alignment tape''. Record t he baseline data reported by t he S2 console display. B. Adjust the tape guide posts using a n oscilloscope and t he Matsushita/Panasonic NTSC alignment tape. T he guide posts a re adjusted by determi ni ng the adjustment range which produces an acceptable waveform and setting each post to the mid-point of t his ra nge. If no oscilloscope is available, the adjustment may be carried out using S2 console screen displays instead. C. Re-evaluate the performance using the ``S2 alignment tape'' as i n part A. Hopefully t he adjustment results i n improved performance. Users with access to t he appropriate Matsushita/Panasonic service ma nual may wish to read over t he section on tape guide post adjustment for reference only (AG2510 Service Manual section 3-4-2, AG2520 Service Manual section 3-4-2-4, AG2530 Service Manual section 2-2-4, or K-Mecha nism Service Manual sections 3-1 and 3-2 for AG2550). Part A: Measure Baseline Performance 1. Insert a n ``S2 alignment tape''. T his is a tape recorded by a n S2 t ransport known to be i n good calibration. A good way to obtain a n ``S2 alignment tape'' is to use t he tape from t he post-installation checkout record/play back test (Section 2.8) which had the best overall performa nce (lowest combined i ntercha nge and non-intercha nge bit-error rates). You should use a tape recorded by t he same ty pe of t ra nsport as the one being adjusted. For AG2510 transports only ST-126/SE-180 or shorter tapes may be used, a nd the record speed should not be SLP. 2. T he t ra nsport under test should be t he only t ra nsport selected, ty pe: transport N Here N is t he number of t he t ransport to be adjusted. 3. Put the transport i nto manual play, rewi nding fi rst if necessary: rewind play manual align selfalign

6 - 12


S2-RT User's Manual

MAINTENANCE AND SERVICING

4. Wait for tracking calibration to complete (about 45 seconds; watch for ``track cal'' cha ngi ng to ``uncalib'', finally disappearing): wait drcal 5. Measure bit-error rate: setup transport N form berc 0 30 s Write down t he average bit-error rate obtai ned after 30 seconds. 6. Measure the flat ness profile: def syncerrlocate enable def syncerrlocate histogram 0 249 30 s cumulative T his measures the tape error distribution across the frame for 30 seconds. Write down t he flat ness and scale values obtained. 7. Stop a nd eject t he tape: stop eject Part B: Adjust Posts An oscilloscope is normally required to carry out the guide post adjustment. If no oscilloscope is available, t he adjustment may be carried out using the alternate ``no-scope'' method given later below. Setup Remove t he t ra nsport to be adjusted from its TAM as described on Page 6-6 and position it i n an accessible location. Take off the top cover by removing t he four black screws (two on each side) and lifting t he cover sta rti ng at t he back of t he transport. T he slider brackets do not need to be removed. Reconnect the t ransport using t he t ra nsport extender cable (TRXTNDR) a nd a spare power cable. Connect t he EQOUT test port on the DRD board to oscilloscope CH1. Connect t he FSYNC test port on t he Formatter board to oscilloscope CH2. SMB-to-BNC converters will likely be requi red (insert carefully). Set oscilloscope CH1 to 50 ohm coupling, 2ms/div. Trigger on CH2 rising edge, also 50 ohm coupled. If 50 ohm couplers a re not available regular high-impedance inputs may be used.

A special alignment tool is required to adjust the tape guide posts, Matsushita/Panasonic part# VFK0329. (In a pinch, a flat screwdriver can be modified for the task by fili ng or gri ndi ng a notch into the middle of the blade, and reducing t he screwdriver blade thickness as required to fit t he guide posts.) The two posts which move, wrappi ng t he tape a round t he head drum when t he tape is played, are designated P2 and P3. The P2 post is the one on the supply-reel side; P3 is on the takeup-reel side -- see Figure 6-3. In general, problems at the beginni ng of a frame a re corrected by adjusti ng P2, while end-of-frame problems are corrected by adjusti ng P3.

tak eup reel supply reel

Figure 6-3: Location of Guide Posts

Using some kind of ink pen, place one dot on t he perimeter of each tape guide post to serve as a reference.

6 - 13


S2-RT User's Manual

MAINTENANCE AND SERVICING

Figure 6-4: Proper tape guide adjustment

Figure 6-5: End-of-fra me distortion example1

Figure 6-6: End-of-fra me distortion exa mple2

Figure 6-7: Beginning-of-frame distortion example

Procedure 1. Place t he NTSC alignment tape (Matsushita/Panasonic pa rt# VFM8080HQFP) in the transport a nd rewi nd it. T he portion of tape which is relevant to this adjustment is the first section, ``Envelope Interchange''. Note that this is a special tape; it will auto-stop at t he end of the first section, about 9 minutes. If you need more time you should rewi nd t he tape and then repeat steps 2 and 3. Should you find t he alignment tape is i n the wrong section it will need to be ma nually advanced between sections (in either di rection). Mark the spine label to i ndicate the number of uses. Replace t he tape after 25 uses, or i f it s uf fers edge damage as c oul d be ca us ed by a severely misaligne d t ra nsport. If no Matsushita/Panasonic alignment tape is available a nd it would take too long to obtai n one, you may use the ``S2 alignment tape'' from part A. 2. Put the transport i nto manual play: transport N play manual 3. Turn off gai n controls a nd t racki ng calibration by runni ng t he agcoff batch file, supplied wit h ROS softwa re version 3.1 and later. If you do not have this batch file, refer to the listings of batch files at t he end of t his section a nd type it in. batch agcoff 4. Adjust the P3 post. Turn the post slowly clockwise until the end-of-frame portion of t he displayed waveform is visibly distorted (see Figures 6-5 and 6-6). Note the position of the P3 post. Then, turn t he post counter-clockwise until the waveform first improves and then shows distortion to a similar degree. Note the position of t he P3 post, and turn the post clockwise agai n to the midpoi nt of t he previous two adjustment positions. Always turn the post slowly, and try not to press down with the tool while observing the waveform. At t he midpoint position t he end-of-frame portion of t he waveform should be relatively flat and look somethi ng like Figure 6-4.

6 - 14


S2-RT User's Manual

MAINTENANCE AND SERVICING

5. Adjust the P2 post, using the same procedure as for P3. Figure 6-7 shows t he beginni ng-of-frame distortion you might see at t he extreme adjustment positions. After adjusting to t he midpoint position t he begi nni ng-of-frame portion should be relatively flat and look somethi ng like Figure 6-4. In cases of extreme i nitial misadjustment it may be beneficial to repeat t he adjustment of the P3 post. 6. Eject the alignment tape and restore software switch setti ngs: stop eject batch agcon (Instead of running t he agcon batch file you may simply wish to reboot.) Alternate ``No-Scope'' Adjustment Method It is possible to align t he tape guide posts wit hout a n oscilloscope using S2 console display s, however this is slightly more difficult. T he Matsushita/Panasonic alignment tape cannot be used, you must use t he ``S2 alignment tape'' as described i n part A. 1. Place the ``S2 alignment tape'' in the tra nsport and rewind it. If you need to rewind the tape again in t he middle of the procedure do so and t hen repeat steps 2 and 3. 2. Put the transport i nto manual play: transport N play manual 3. Set gai n controls a nd t racki ng calibration as required by runni ng the agc_noscope batch file, supplied with ROS softwa re version 3.1 and later. If you do not have this batch file, refer to the listi ngs of batch files at t he end of t his section a nd type it in. It takes about 45 seconds to complete. batch agc_noscope 4. Bring up the error distribution histogram with t he following comma nd: def syncerrlocate histogram 0 249 cumulative 2 Here exponential averaging is used wit h decay time `2'. 5. Adjust t he P3 post. You should turn t he post very slowly in small steps, waiting a few seconds between steps for the histogram to settle. Also keep an ey e on the estimated error rate value ``Est err rate'' in t he Crucial Parms wi ndow. Do not press down wit h the tool while observing the histogram. Turn t he post clockwise until the end-of-frame portion of the histogram display shows significant errors (see Figures 6-9 a nd 6-10). T he estimated error rate should be a round 2e-4 or higher for LP, or around 2e-3 for SLP. Note t he position of the P3 post. T hen, turn t he post counter-clockwise until the histogram first improves and then shows errors to a similar degree. Note the position of the P3 post, and turn t he post clockwise again to the midpoint of t he previous two adjustment positions. At the midpoi nt position t he end-of-frame portion of t he histogram should have relatively few errors with no significant bumps or peaks, somethi ng like Figure 6-8. 6. Adjust the P2 post, using the same errors you might see at t he extreme beginni ng-of-frame portion should somethi ng like Figure 6-8. In cases adjustment of the P3 post. procedure as for P3. Figure 6-11 shows the beginni ng-of-frame adjustment positions. After adjusti ng to t he midpoint position the have relatively few errors wit h no significant bumps or peaks, of extreme i nitial misadjustment it may be beneficial to repeat t he

7. Type `q' to quit the error histogram display, t hen eject the tape a nd restore softwa re switch settings: stop eject batch agcon (Instead of running t he agcon batch file you may simply wish to reboot.)

Part C: Re-evaluate Performance 1. Reboot t he S2 to clear any previous diagnostic switch settings: shutdown reboot 2. Re-insert t he ``S2 alignment tape'' from part A and initiate ma nual playback, rewinding fi rst if necessary:

6 - 15


S2-RT User's Manual

MAINTENANCE AND SERVICING

Figure 6-8: Proper tape guide adjustment, no scope

Figure 6-9: End-of-frame distortion example1, no scope

Figure 6-10: End-of-frame distortion exa mple2, no scope

Figure 6-11: Beginning-of-frame dist. example, no scope

transport N rewind play manual align selfalign 3. Wait for data-recovery a nd t racki ng calibration to complete (about 45 seconds) wait drcal 4. Measure bit-error rate: setup transport N form berc 0 30 s Write down t he average bit-error rate obtai ned. 5. Measure the flat ness profile: def syncerrlocate enable def syncerrlocate histogram 0 249 30 s cumulative Write down the flat ness and scale values obtained. Compare these values, as well as t he bit-error rate, to the values obtained i n part A. In all cases lower numbers a re ``better''. 6. Stop a nd eject t he tape: stop eject To verify overall system performa nce we recommend you repeat the post-installation checkout record/play back test (Section 2.8). Required Batch Files T he following t hree batch files a re used for tape guide adjustment: agcoff agcon agc_noscope T hese come sta ndard with ROS software version 3.1 a nd later, but users with older softwa re can easily type them

6 - 16


S2-RT User's Manual

MAINTENANCE AND SERVICING

i n. This can be done using t he batch edit command. Alternatively they may simply be typed li ne for li ne wherever t he batch file is called. · agcoff # Set conditions for tape guide post adjustment (scope method) transport tracking manual phase2 transport tracking auto phase1 dr cal all hold transport tracking recalibrate transport agc off dr agc all disable dr agc all gainset 25
·

agcon # Undo settings made by agoff or agc_noscope transport all tracking auto transport all agc on dr agc all enable dr cal all continue def syncerrlocate disable agc_noscope # Set conditions for tape guide post adjustment (no-scope method) dr agc all enable dr cal all continue transport agc on transport tracking auto transport tracking recalibrate def syncerrlocate enable # Wait while tracking recalibrates wait drcal dr cal all hold

·

6 - 17


S2-RT User's Manual

SHIPPING

7. SHIPPING

7.1 Packaging
Recommended shipping containers T he recommended method of shipping t he S2 sy stem employs a set of three boxes, one for each TAM rack (Figure 7-1) a nd one for t he DSCM (Figure 2-5). T hese are semi-custom contai ners manufactured by Tita n Case Industries (Scarborough, Ontario). TAM rack boxes are ma nufactured from basic part number 1883; DSCM cases are based on number 1882. Both ty pes of cases a re constructed from roto-moulded poly ethylene and a re lined with polyethylene foam. T he DSCM foam lini ng is of a n a nti-static variety. A sta ndard feature of these cases is their interlocking prot rusions which make it possible to stack multiple cases.
Figure 7-1: TAM Shipping Box

Preparation for shipping To prepare t he S2 for shippi ng, t he user should: · remo ve tape s from transpo rts
· · · · ·

power down t he system disconnect all external cable assemblies i nstall a nd secure TAM slider blocks ensure t hat all internal TAM connectors are secure ensure t hat t he removable front a nd back pa nels of the TAMs a re i n place

Packing and unpacking TAM rack boxes are of a ``reverse-removable'' lid design. This facilitates packi ng and unpacking, as the TAM rack is placed in t he shallow base, and t he la rge lid is lowered over it. The lid should slide over t he rack wit h little or no resista nce. If it does not, the TAM rack is likely misplaced. The i nterior foam has cutouts to accommodate t he rear panel connectors. Also, note that t he handles on the front of the rack must be reversed for shippi ng; a suitable hex wrench is enclosed for the purposes of re-attachment. Each TAM rack box is manufactured with matchi ng arrows for lid-base orientation, as well as ``UP'' i ndicators.

Part 1: /home/s2/doc/userman/working/txt/shipping.txt x
Figure 7-2: DSCM Shipping Box with Cable Assemblies 7-1


S2-RT User's Manual

SHIPPING

T he DSCM box has a hi nged lid; t he DSCM is lowered upright i nto it. Correct orientation is with t he boards facing the front of the box. Directly beneath t he lid is t he cable assemblies compartment where the power a nd i nterconnect cables a re stored. These boxes also have ``UP'' i ndicated. Shipping Weights T he weight of a DSCM packed in a shipping container is approximately 30 kg. T he weight of a TAM packed i n a shipping contai ner is approximately 55 kg.

7.2 Shipping Envir onment
Both TAM a nd DSCM boxes have been designed by Tita n Case Industries to provide a maximum i nstrument acceleration of 40G when subjected to a drop of 4 feet. We do not recommend a 4-foot drop as part of a sta ndard shipping procedure. The cases are fitted with a rubber seal, which makes them resistant to rai n and general moisture. T hey a re not gas-tight. Both ty pes of boxes are designed to be ha ndled manually. T he TAM rack box, when loaded, requi res two people to carry it, while t he DSCM box can be safely ma naged by one person. The shipping envi ronment is specified as follows: Temperature Ra nge: Relative Humidity: Altitude: -20 to +60 degrees Celsius 10% to 90% non-condensing -300 to +12,000 meters

7-2


S2-RT User's Manual

S2 SPECIFICATIONS SUMMARY

8. S2 SPECIFICATIONS SUMMARY
Operation
Format: User data rates: LP Bit-error rate: SLP Bit-error rate: Tape: Record/Play Ti me at 128 Mbits/s: Non-data-replacement 16 to 128 Mbits/s (16 Mbits/s per transport) 1 x 10-4 (maxi mum), 1 x 10-5 (typical) 1 x 10-3 (maxi mum), 2 x 10-4 (typical) SVHS Cobalt Iron O xide, approved types only 3 4 6 5 8 hrs 50 min (ST-120 tape, LP) hrs 1 min (ST-126/SE-180 tape, hrs 2 min (ST-126/SE-180 tape, hrs 47 min (ST-182/SE-260 tape, hrs 41 min (ST-182/SE-260 tape,

Total Data Capacity: User Data Density: Data Shipping Weight: Timebase Deviation Tolerance:

Physical

Configuration:

Dimensions in cm: Weights: Power Consumption:

Av eraged across eight transports

Part 1: /home/s2/doc/userman/working/txt/specsum.txt x LP) SLP) LP) SLP) 1.85 Tbits (ST-126 tape, LP) 3.94 Tbits (ST-182 tape, SLP) 675 Tbits/m3 (ST-126 tape, LP) 1440 Tbits/m3 (ST-182 tape, SLP) 1.1 Kg/Tbit (ST-126 tape, LP) 0.6 Kg/Tbit (ST-182 tape, SLP) Max. delay rate of external reference clock: ±10-3 s/s (corresponds to input frequency deviation of ±0.1%) Max. delay acceleration of external ref. clock: ±10-6 s/s2 Max. delay step at 0 delay rate: ±10-5 s 1 or 2 Transport Array Modules (TAMs) 1 Data, Signal and Control Module (DSCM) 19" rack-mount or table-top operation TAM: 40 H x 44 W x 46 D (10 U) DSCM: 33 H x 44 W x 33 D (7 U) 1 TAM: 36 Kg DSCM: 15 Kg 1 TAM: 140 W DSCM: 160 W
8-1


S2-RT User's Manual

APPENDIX A

S2 RCL SERI AL COMMUNI CAT IONS PROTOCOL

A.1 Overview
T his section describes t he communications protocol of the S2 Radioastronomy Control Link (RCL), a serial communications link used for computerized cont rol of t he S2 recorder, a nd other devices such as the S2 Data Acquisition Sy stem. Here a nd in the rest of this section t he word ``recorder'' refers to both S2 Record Terminals (RTs) a nd Playback Termi nals (PTs). These specifications a re subject to cha nge at a ny time. All numbers are decimal unless preceded by 0x which indicates hexadecimal. T he S2 RCL port is a male DB25 connector wi red as an RS-232C DTE (Data Termi nal Equipment) device. It should be connected to a DCE (Data Communication Equipment) device (this is t he opposite of the console port). Some computers, such as IBM PCs, have only DTE serial ports a nd will require a null modem cable which excha nges t he receive and tra nsmit data lines (pi ns 2 & 3). The normal RCL communications parameters a re 19200 baud, no parity, 8 data bits, 1 stop bit. On S2 sy stems t hat have a n Et hernet connection equivalent RCL access can be performed over the network using Internet TCP sockets (port number 1025). T he RCL uses a bina ry request-response packet protocol. In this scheme, the external control computer issues requests using a specific command format, a nd waits for a response from the S2. Only one request may be active at a ny time, a nd for each request there is exactly one response. Responses a re immediate or almost immediate. T hose operations for which there would be a significant delay return a n immediate acknowledgement and then i ndicate t heir progress in the S2 sy stem status information (STATUS command). Each S2 or ot her RCL device is assigned an address for communication, and each RCL packet contains a desti nation address, allowi ng multiple devices to be connected together a nd controlled simultaneo usly. When t here is more tha n one non-networked RCL device, RS-485 multi-drop serial connections may be used. In t his case the S2 requi res a n external RS-232C to RS-485 conversion box. T his box should switch on its RS-485 tri-state line drivers only when t he RTS (RequestTo-Send) signal from t he S2 is high (TRUE). The S2 sets the RTS signal high just before each RCL message is t ra nsmitted, and t hen sets RTS low (FALSE) following t he t ransmission. Please note that CRESTech/SGL will provide t he source code required to implement packet assembly/disassembly for all RCL commands a nd responses described here to all S2 users. T his comes in t he form of a n interface library written in ANSI C. T herefore it is not necessary for users to understand or implement t he detailed packet protocol, only how to use t he i ndividual RCL commands.

A.2 General Packet Format
pkt
16

SOT
bits 8

MSB | LS B 8 8 8

SOT

``Sta rt of Tra nsmission'', 01 decimal. Defines the start of t he packet. When a by te with t he same code as the SOT character appears elsewhere i n the message body, it is repeated to disti nguish it from a true SOT. When the receiver detects two consecutive SOTs it i nterprets

Part 2: /home/s2/doc/userman/working/txt/rcl_prot.txt x
len addr cmd/resp.code seq# ...data... checksum
MSB | LSB 16 8

Part 1: /home/s2/doc/userman/working/txt/appa.txt x

APPENDIX A

EOT

A-1


S2-RT User's Manual

APPENDIX A

t hem as a single byte wit h value 1. If a single SOT is detected in t he middle of an i ncomi ng packet t hen a new packet has started a nd previously received bytes a re discarded. pkt len T he total number of bytes in t he packet i ncluding everyt hing except the SOT a nd EOT cha racters, offset by adding 505. Each packet is at least 7 bytes long, so t he minimum length code value is 512. Doubled SOT data by tes wit hi n the message body are counted as 1 byte, not 2. Length is a 16-bit (2-byte) quantity with the most significant byte (MSB) t ra nsmitted fi rst. The offset of 505 is added to ensure that t he MSB of the length cannot be a n SOT. Lengths between 0 a nd 511 (0 a nd 0x01FF) are illegal a nd will cause the receiver to discard t he packet. T he maximum packet length is a rtificially set at 2054 bytes (before offsetti ng) to limit t ra nsmission times and buffer sizes. T he address of t he device for which t he packet is i ntended. When using RS-485 multi-drop operation wit h more t han one RCL device cont rolled by a single master, each de vice must be assigned a unique address from 0 to 253. If there is only one RCL device, regular RS-232C can be used a nd the address assigned to the device should be 0. Address 254 (RCL_ADDR_MASTER) i ndicates t he cont rolli ng computer or master. Address 255 (RCL_ADDR_BROADCAST) is a special broadcast code intended for diagnostic and configuration use only. All RCL slave devices will respond to code 255. A comma nd or response code, as described i n Section A.4 below. Codes in t he ra nge 0 to 99 decimal are for comma nds sent from t he external cont rol computer (master) to t he S2 (slave), a nd codes 100 to 199 decimal are for responses sent from the S2 to t he external computer. 255 is a n expansion code to allow the number of comma nds to exceed t he 8-bit limit if necessary. T he remaining codes are reserved. Generic RCL comma nds and responses should use the same code numbers in all types of RCL devices, but comma nds which a re specific to a particular de vice ty pe may use any legal code numbers. An 8-bit sequence number t hat is incremented for every new comma nd sent by the external computer to the S2 recorder. If t he external computer re-transmits a comma nd because no response was detected then the re-transmitted packet has the same seq# as t he previous (identical) packet. Whenever the S2 receives a comma nd with t he same sequence number as t he previous command it repeats the last response wit hout re-executi ng t he comma nd. Responses use t he same sequence number as the comma nd which the response is for. Example: 1. External computer S2: "stop" command (...S2 executes "stop"...) 2. S2 seq# 101 seq# 101 seq# 102 seq# 102

addr

cmd/resp

seq#

4. S2 External computer: "ERR_NONE" response (...response gets garbled or lost i n t ra nsmission...) (...external computer times out...) 5. External computer 6. S2 data

3. External computer S2: "rewi nd" comma nd (...S2 executes "rewind"...)



External computer: "ERR_NONE" response





S2: "rewind" command

seq# 102 seq# 102

External computer: "ERR_NONE" response

Some number of data bytes. T he t heoretical maximum number of data bytes that may be t ransmitted is 65535-512 = 65023, however in practice packets are never t hat long because t ransmission time would be excessive (over 30 sec at 19200 baud) and too much memory would be required for buffering. In practice we limit t he data portion to 2047 bytes, a nd t he enti re packet to 2054 bytes (not i ncluding SOT and EOT). A 16-bit unsigned bi na ry checksum (MSB fi rst). Calculated by taking t he 16 least-significant bits of the sum of all bytes except: SOT, EOT, and the checksum itself. Doubled SOT bytes i n t he message body are counted only once, not twice. Received packets whose checksum does not match the calculated checksum a re discarded. ``End of Tra nsmission'', 04 decimal. Defines the end of the packet. T he receiver only checks to see if it is there, since the length field determi nes how ma ny bytes a re i n t he packet. If EOT is not found at t he end of t he packet t hen t he enti re packet is discarded.
A-2

chksum

EOT


S2-RT User's Manual

APPENDIX A

T he external control computer must use timeouts when waiti ng for replies from the S2. Incorrect packets received by eit her end are always discarded, causing t he external computer (master) to time out a nd re-send t he command. T he repeated packet must use the same sequence number as t he previous packet. After a certain number of retries (2 recommended, for a total of 3 failed tra nsmissions), t he external computer should flag a communication error a nd decla re t hat t he S2 recorder is ``dead'' (not functioning/power off/RCL cable disconnected). T he external computer can use `ping' comma nds (described below) to detect when communications resume.

A.3 Command/Response Summar y
Commands a re numbered in t he range 0 to 99 decimal. T hey are always sent from the external cont rol computer (master) to t he RCL device (slave). Most comma nds listed below a re specific to the S2 recorder, but a few of t he commands a re generic and must be implemented i n the same way by all types of RCL devices. Examples of generic RCL comma nds: PING, VERSION, a nd IDENT. Except for the generic comma nds, other types of RCL devices can have different command sets by defi ni ng the same command code numbers differently.
Code
00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 STOP PLAY RECORD R E WIND FF PAUSE UNPAUSE EJECT STATE_READ SPEED_SE T SPEED_READ SPEED_READ_PB TIME_SET TIM E_ READ TIME_READ_PB

Cmd Name
Sto p tra nspo rts.

Function
Sta rt pla yba ck (use STATUS to monit or pro gre ss). Sta rt re co rding (use STATUS to monit or pro gre ss). Rewind ta pe s (use `state _re ad' to te st completion, recorder will auto -stop). Fa st-forward ta pe s (use `sta te _re ad' to test compl eti on, re corder will auto -stop). Tempo ra rily pause re cording or pla yback (not re comme nded, use STOP). Resu me re cording or pla yback afte r pause. Eje ct tapes. Re ad curre nt ta pe motion sta te (sto p, reco rd, play, re wind, ff, no _ta pe etc). Se t re co rd ta pe speed lp or slp (lp not suppo rted on AG2550 transpo rts). Read reco rd tape spe ed. Read playba ck ta pe spe ed. Se t sy stem tim e; must be se nt right after S-1/C-1 Hz input tick (S1HZ_ REC on C1 ca ble or C1HZ on C2a cable ) if SC PLL lock ed to refclk . Re ad curre nt syste m time ; reply re turned right afte r next S-1/C-1 Hz input tick . Read playba ck ta pe time ; reply re turned right afte r next S-1 Hz output tick (S1 HZ_PB on C2a ca ble ). Tape s must be aligne d. This co mm and can be use d to te st if tapes are aligned, or use STATUS. Se t re corder mo de (S2 mo de string, or c1test16 for C1 cable te st mode (te st seque nce che ck), c2te st16 for C2 cabl e test mode (test seque nce ge ne rate). Read curre nt reco rde r mode. Se t Tape ID (reco rd), ASCI I string up to 20 chars. Read Tape ID (re cord). Read playba ck Tape ID. Value must be consistent across all ta pe s. Se t u Fie ld Fie ld Fie ld Fie ld All 4 ser-define 1: A SCII 2: A SCII 3: A SCII 4: A SCII fields: 16 d auxilia ry or bi na ry or bi na ry or bi na ry or bi na ry cha racte r da ta fields & la be ls (re cord) string up to 16 cha rs string up to 16 cha rs string up to 32 cha rs string up to 48 cha rs ASCII user-define d la be l

15 16 17 18 19

MODE_SET MODE _REA D TAPEI D_SE T TAPEI D_REA D TAPEID_REA D_PB

20

USER_ INFO_SET

21 22 23

USER_ INFO_READ USER_INFO_READ_PB USER_ DV_S ET

Read use r-de fined aux iliary data fie lds & labels (record). Re ad playba ck use r-de fined aux data fie lds & labels. Value s must be consiste nt acro ss all ta pe s. Se t use r da ta-v alid flag, boole an (re cord).
(continued on nex t page)

A-3


S2-RT User's Manual

APPENDIX A

Code
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 42 43 44 45 50 51 55 60 70 71

Cmd Name
USER_DV_READ USER_DV_READ_PB GROUP_S ET GROUP_READ TAPEINFO_READ_P B DELAY _SE T DELAY _REA D DELAY M_READ BARRELROLL_S ET BARRELROLL_RE AD ALIGN POSITION_S ET POSITION_RE AD ERRM ES ESTE RR_REA D PDV_READ SCPLL_ MODE _SE T SCPLL_ MODE _REA D TAPETY PE_SET TAPETYPE_READ MK 3_ FORM_SE T MK 3_FORM_READ TRANSPORT_TIMES STATION_ INFO_READ CONSOLE CMD POSTIME_REA D Read use r data -v alid fla g (record).

Function

(continued)

Re ad use r data -v ali d fla g. Value must be co nsiste nt acro ss all ta pe s. Se t tra nsport group number. Read tra nspo rt gro up numbe r (a lso gives numbe r of gro ups). Return ta pe -relate d inform atio n du ring pla yback for all 8 individual tra nspo rts. Se t the sta tio n de lay offset. Read the current station dela y off set setting. Read th e current station dela y off set me asurement. Turn ba rre l roll on or off. Read the current ba rrel roll se tting. Align ta pe s (pb) (use STATUS to test comple tio n). Po sitio n tapes (use STATE_READ to test comple tio n). Re ad the current tape po sitio n. Su pply error me asurement for playba ck rate cont rol in SCPLL mode errmes. Re ad estima te d erro r ra tes for all transports. Read % data valid value s for all transpo rts. Se t the Sy ste m Clo ck PLL mode . Read the current Sy stem Clock PLL mode. Se t the ta pe type. Read the current tape ty pe se tting. En able/ disa ble Mark III formatter and Ma rk III output on C2a ca ble . Read curre nt Mark III formatte r ena ble /disable state. Fo r all 8 transpo rts re ad head-use tim e, to tal power-on ti me etc. Re ad sta tion-relate d inform atio n assigned to S2 sy ste m including station num be r. Ex ecute an arbitrary conso le command (caution re quire d !). This is a ge ne ric cm d. Return s bo th the playba ck ta pe time and tape po sitio n for a pa rticular tra nspo rt. Fo r SGL inte rna l use only. Return brief sta tus report, suitable for polling. Conta ins overa ll ``erro r '' summary bit and overa ll ``fatal erro r '' summ ary bi t. Also contains co unt of activ e sta tus conditio ns and li st of sta tus code numbers in appro xim ate orde r of prio rity. Ea ch sta tus co de includes ``erro r '', ``fata l'', and ``clear-on-read'' ty pe indicato r bits. Cle aron-re ad status entries are auto matically cleared by the STATUS command. This is a generi c command. Return deta ile d te xt descript ions for one or all acti ve sta tus condit ions, suita ble for lo gg ing. Includes only condit ions in effect at the tim e of the la st STATUS co mmand. Opt ionally, re -reads current co nditio ns (i.e . imp licit ly performs STATUS ). This is a generic comma nd Tra nsla te numeric status code to te xt messa ge . Suit able for buil ding tra nsla tio n ta ble of status codes and mnemonics/m essages. This is a ge ne ric command. Tra nsla te ne ga tiv e numeric erro r co de to text me s sage . This is a generic cmd . In itia te in te rna l dia gnostic self-t est 1 (use STATUS to check completion). Note th at most other RCL commands which affect tape mo tio n or sy ste m sw itch sett ing s are no t allo wed during the self-test. This is a ge ne ric co mmand. Pe rform a bit-erro r ra te measurement using one of two test sequences (FORM or UI), or pe rform a DC-bi as measure ment on use r data . Ex tra ct and re turn thre e by te s of data or validity from a part icula r user da ta cha nnel in S2 or Mark-III format. Re turn device-t ype inform atio n string. This is a generic command Pe rform no action, just return an ``ERR_NONE'' re sponse. Useful for po lling a de ad S 2 to te ll whe n it comes aliv e. This is a generic comma nd. Re turn ROS software versio n informatio n string. This is a generic command.

80

STATUS

81

STATUS_ DETAI L

82 83 90

STATUS_ DECODE ERROR_DE CODE DIAG

91 92 97 98 99

BERDCB DATA_E XTRACT_READ IDENT PING VERSION

A-4


S2-RT User's Manual

APPENDIX A

Responses a re numbered from 100 to 199 decimal, a nd are usually derived by addi ng 100 to the request comma nd code. Where more than one request returns t he same response ty pe, t he lowest numbered request has been used to derive the response code. Responses are always sent from the S2 recorder (slave) to t he external control computer. Simila r to generic comma nds, certai n responses a re generic a nd should be implemented i n t he same way by all types of RCL devices.

Code
100

Resp Name
RESP _ERR

Function
Genera l error condit ion/OK response, cont ains error code , 0 if no error. Use ERROR_DECODE comma nd to translate erro r code into de s criptive text me s sage . This is a generic respo nse . Tape motio n state Transpo rt re cord or playback ta pe speed Sy stem UTC time or pla yback tape time Recorder mode (record or pla yback) Tape ID (re cord or playba ck) User-de fined aux iliary da ta fie lds (reco rd or pla yba ck) User data-v alid fla g (reco rd or pla yba ck) current transpo rt group numbe r (re cord or pl ayba ck) tape-re la ted inform ation for all 8 indiv idua l transpo rts (pla yba ck only ) Sta tio n de lay (setting or measure me nt) Barre l roll setting Tape position Estim ated erro r-ra te fro m all transports Perce nt da ta valid fro m all transport s Curre nt Sy stem Clock PLL mode Curre nt ta pe ty pe setting Curre nt Mark III form atte r ena ble /disable state Head-use and in-serv ice ti me s fro m all transpo rts Sta tio n number, sy stem seria l number, nickname Pla yback tape tim e and ta pe positi on. For SGL internal use only. Sy stem sta tus summary. This is a generic respo nse . Deta ile d syste m sta tus. This is a ge ne ric re sponse. Translated te xt sta tus message. This is a ge ne ric re sponse. Translated te xt error message. This is a ge ne ric re sponse. Bit-e rror rate or DC-bia s measure me nt re sult 3-byte da ta extra ct or validity extract result RCL de vice type string. This is a ge ne ric re sponse. ROS so ftw are version information. This is a generic respo nse .

108 110 113 116 118 121 124 127 128 130 133 136 138 139 143 145 151 155 160 171 180 181 182 183 191 192 197 199

RESP _STATE RESP_SPEED RESP _TIME RESP _MODE RESP_TAPEID RESP _USER_INFO RESP _USER_DV RESP_GROUP RESP _TAP EINFO RESP _DEL AY RESP _BA RRELROLL RESP _POS ITION RESP _ES TERR RESP_PDV RESP_SCP LL_MODE RESP_TAPETYPE RESP _M K3 _FORM RESP _TRA NSPORT_TIMES RESP _STATION_INFO RESP _POS TIME RESP _STATUS RESP _STATUS_DE TAIL RESP _STATUS_DE CODE RESP _ERR_DECODE RESP _BE RDCB RESP _DATA_EX TRACT RESP _IDE N T RESP _VE RSION

A.4 Command/Response Formats
T his section contains detailed format descriptions of each comma nd a nd response. Each format description has t he following ent ries:

A-5


S2-RT User's Manual

APPENDIX A

Command: T he name of t he command or response. The ent ry is labeled ``Response'' for responses. The word ``generic'' is included in brackets if t his is a generic comma nd or response. Msg Code: T he hex comma nd/ response code. Data: T he contents of the packet data field. Expected Resp: (comma nds only) T he proper response if t he command is successful (unsuccessful commands return RESP_ERR). Timer Duration: (comma nds only ) The time in which t he sender of t he message should get a reply. If a reply is not received after t his duration then the message should be re-sent. T his i nformation is for setti ng timeout i ntervals only -- in practice most commands will complete much faster than the time i ndicated. T he RCL Interface Library i ncorporates t he timer duration values documented here a nd performs timeouts a nd retries as required. Therefore users calling the RCL Interface Libra ry functions (in rcl_cmd.c) do not usually need to retry commands. T he typical response time when calling RCL Interface Libra ry functions will be less than the timer duration value, but the maximum response time is 3 times the timer duration value since up to 2 retries are automatically performed for most commands. The followi ng commands a re special and will not be automatically retried, so t heir maximum response time is t he timer duration value: rcl_ping() rcl_time_set() rcl_time_read() rcl_time_read_pb() rcl_align_abs() User software should perform retries for t hese commands as needed. Eq Console Cmd: (comma nds only) The equivalent console command used to ma nually implement t he same function. Description: T he purpose and function of the comma nd or respo nse. Commands Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 1) 0) STOP 00 none RESP_ERR [ERR_NONE] 1.5 sec stop Stops t he t ransports and/or associated system operation. This includes stopping playback, recording, rewi nding, fast-forwa rding, as well as alignment a nd positioning. PLAY 01 none RESP_ERR [ERR_NONE] 1.5 sec play Starts playback. Automatically i nitiates a tape alignment operation (self-align) to align the individual transports to each ot her a nd to obtain a single, coherent tape time. After reading t his tape time, t he user may issue a n RCL ALIGN comma nd to further align t he recorder to a desired epoch. The S2 must be currently stopped, rewi nding, or fast-forwarding, otherwise the PLAY command is not allowed. Also must not currently be positioning. The PLAY command is normally issued after the recorder has been positioned using PO-

A-6


S2-RT User's Manual

APPENDIX A

SITION_SET. In an S2-RT, playback is restricted to 16 Mbit/s total bit rate (out of either 1, 2 or 4 channels) i nstead of the usual 128 Mbit/s. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 3) 2) RECORD 02 none RESP_ERR [ERR_NONE] 1.5 sec record Starts recordi ng. Recorder must currently be stopped. REWIND 03 none RESP_ERR [ERR_NONE] 1.5 sec rewind Rewinds t he tapes. Stops the recorder first if necessary (except when recording). Recorder must be i n stop, play, play-pause, or fast-forwa rd state, ot herwise REWIND is not allowed. Also must not currently be aligning or positioni ng. FF 04 none RESP_ERR [ERR_NONE] 1.5 sec ff Fast-forward winds the tapes. Stops the recorder first if necessary (except when recordi ng). Recorder must be i n stop, play, play -pause, or rewi nd state, otherwise FF is not allowed. Also must not currently be aligning or positioni ng. PAUSE 05 none RESP_ERR [ERR_NONE] 1.5 sec pause Puts t he S2 recorder into play-pause or record-pause state. Recorder must currently be recordi ng or playi ng (and must not be aligning or positioni ng). This differs from STOP i n t hat PAUSE is sometimes able to re-enter play or record more quickly. Unlike STOP, time spent in PAUSE counts agai nst head lifetime. To prevent excessive head a nd tape wear, the recorder automatically stops after pausing for more t han about 3 minutes. For normal record or playback operation, PAUSE provides no significant benefits a nd should not be used -- use STOP instead. UNPAUSE 06 none RESP_ERR [ERR_NONE] 1.5 sec

Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

4)

Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

5)

6)

Command: Msg Code: Data: Expected Resp: Timer Duration:

A-7


S2-RT User's Manual

APPENDIX A

Eq Console Cmd: unpause Description: Un-pauses the S2 recorder after a PAUSE comma nd a nd resumes play back or recording, as t he case may be. The recorder must currently be in play -pause or record-pause state. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 7) EJECT 07 none RESP_ERR [ERR_NONE] 1.5 sec eject Ejects the tapes from all currently selected tra nsports. Stops t he S2 recorder fi rst if it is not al ready stopped. T he recorder must not be recording or record-paused. T he recorder state cha nges to STATE_NOTAPE. STATE_READ 08 none RESP_STATE 0.5 sec (none, state displayed on console screen) Reads t he current recorder state, which refers to the status of the recorder with respect to tape motion (e.g. stop, record, play, rewind, ff, notape etc.)

Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 9)

8)

Command: SPEED_SET Msg Code: 09 Data: byte1: Speed code 0x01 LP 0x02 SLP (total data bytes = 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 1.5 sec Eq Console Cmd: speed {lp|slp} Description: Sets t he record tape speed. On systems wit h AG2530 and earlier model t ra nsports the two allowed speeds a re LP (long play) a nd SLP (super-long play). Sy stems wit h AG2550 a nd later t ra nsports support recordi ng in SLP speed only, alt hough they will play back tapes recorded in LP. SLP is sometimes also called EP. T he speed SP is not used. Recording times a re 50% longer i n SLP t ha n LP, wit h some degradation i n bit error-rate. T he SPEED_SET command is not allowed duri ng record. It is not possible to set t he playback speed (playback speed is automatically determined). Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 10) SPEED_READ 10 none RESP_SPEED 0.5 sec speed (also displayed on console screen) Reads the currently selected record tape speed, eit her LP or SLP. If t he S2 is not currently recordi ng, t his is the speed t hat would be used if a

A-8


S2-RT User's Manual

APPENDIX A

RECORD command was sent. T he SPEED_READ comma nd may be sent at a ny time. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 11) SPEED_READ_PB 11 none RESP_SPEED 0.5 sec (none, playback speed displayed on console screen) Reads the current playback tape speed. This may be LP, SLP, SP, or `unknown' (see RESP_SPEED). The S2 must currently be playi ng back tapes. T he unused speed SP may appear for bla nk tapes or when tapes were not recorded by an S2. An `unknown' response may appear when playback speed has not yet been determined or when tapes recorded at different speeds are played at t he same time.

Command: TIME_SET Msg Code: 12 Data: byte1, byte2: Absolute UT year number (1901­2099), by te1=MSB byte3, byte4: UT day number (1 to 365/366), byte3 = MSB byte5: UT hours (0 to 23) byte6: UT mi nutes (0 to 59) byte7: UT seconds (0 to 59) (total data bytes = 7) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: time {[NNN-]NN:NN:NN|{s|m|h|d|y}[+|-]NUM|validate} Description: Sets t he S2 sy stem time, which is the time encoded onto tape during record. It is also used for ot her miscella neous functions such as time-tagging i nternal log ent ries a nd implementing absolute time delay s i n batch files. If the Sy stem Clock PLL is in refclk mode, then the TIME_SET comma nd must be synchronized to t he S-1/C-1 Hz i nput tick (S1HZ_REC on C1 cable or C1HZ on C2a cable) by sending it immediately followi ng a particular tick. T he data field should contai n the time of the tick that just passed. This protocol is necessary because it is not possible to communicate exact times using the RCL alone. With the SC PLL in refclk mode, the station delay must be set to 0 duri ng time setti ng and t he external S-1/C-1 Hz i nput signal must be present otherwise an error is returned. In other SC PLL modes no errors a re returned since only refclk mode can be used for recording, and for anyt hing else t he sy stem time only needs to be approximate. Note: Unlike most other comma nds, TIME_SET is not subject to automatic communications retries wit hi n t he RCL interface libra ry, otherwise t he wrong time might be set. The rcl_time_set() function call should be re-issued with a n updated time if a communications timeout occurs. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 13) TIME_READ 13 none RESP_TIME 1.25 sec time (also display ed on console screen) Reads the current S2 sy stem time (this is not the play back tape time, see next command). If t he external S-1 Hz or C-1 Hz i nput is being used

12)

A-9


S2-RT User's Manual

APPENDIX A

(S1HZ_REC on C1 cable or C1HZ on C2a cable is connected a nd Sy stem Clock PLL mode is refclk or 1hz), t hen t he response (RESP_TIME) is sent immediately followi ng the next S-1/C-1 Hz input tick, a nd gives t he time of t he tick t hat just passed. If t he 1 Hz input tick is not present then the error ERR_NOU1HZ will be returned. This protocol is necessary because it is not possible to communicate exact times using t he RCL alone. Note that if t he S2 station delay is non-zero it will not be reflected i n the returned time, even t hough it affects t he time encoded on tape. T his is done on purpose to make time reading sy mmetrical wit h time setti ng. T he external control computer should obtain the station delay using DELAYM_READ and add it to t he time returned by TIME_READ to obtai n t he correct S2 system time with respect to t he input S-1/C-1 Hz. In Sy stem Clock PLL modes other than refclk a nd 1hz, the RESP_TIME response is sent immediately followi ng the next S-1 Hz output tick (S1HZ_PB on C2a cable) since the 1 Hz i nput is not used. The response gives t he time of t he tick t hat just passed, a nd should not be adjusted by addi ng the station delay. T he TIME_READ response includes a ``time validated'' flag. T his flag is always FALSE followi ng sy stem bootup (and certain severe system timi ng glitches), a nd is set to TRUE following a TIME_SET command. T hus it gives an i ndication of whether t he time is likely to be correct. Note: Unlike most other comma nds, TIME_READ is not subject to automatic communications retries within the RCL i nterface library, otherwise the time returned would be uncertain. The rcl_time_read() function call should be re-issued if a communications timeout occurs. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 14) TIME_READ_PB 14 none RESP_TIME 1.25 sec (none, tape time displayed on console screen) Reads the playback tape time. The S2 must currently be playi ng back properly recorded tapes a nd the tapes must be aligned. T he response (RESP_TIME) is sent immediately following t he next S-1 Hz output tick (S1HZ_PB on C2a cable), a nd gives the time of the tick that just passed. T he external control computer may requi re special ha rdwa re to measure the S1 Hz output tick against its own reference. T his is necessary because it is not possible to communicate exact times using the RCL alone1. If the tapes a re playi ng but not (yet) aligned, response RESP_ERR wit h error code ERR_NOALIGN will be returned (should it be nece ssary, you can use t he TAPEINFO_READ_PB comma nd to read t he different i ndividual tape times). T he TIME_READ_PB response i ncludes a ``time validated'' indicator which shows the state of the time validated flag at the time the tapes were recorded. It will be TRUE if the time was set before making t he recording. Note: Unlike most other comma nds, TIME_READ_PB is not subject to automatic communications retries wit hi n t he RCL interface libra ry, otherwise t he time returned would be uncertai n. T he rcl_time_read_pb() function call should be re-issued if a communications timeout occurs.

1

Precise playback tape time reading is a requirement in a PT, but not in an RT when playback capability is used for diagnostic purposes only.

A - 10


S2-RT User's Manual

APPENDIX A

Command: MODE_SET Msg Code: 15 Data: byte1 ... : Mode designator i n t he form of an ASCII string termi nated by a NULL (0) cha racter. See t he description for a list of possible modes. (total data bytes = length of stri ng + 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 3.0 sec Eq Console Cmd: mode ... Description: Sets t he recorder mode, which cont rols data channelization a nd bit rate (sample rate). T he S2 supports up to 16 cha nnels of data at 4, 8, 16, a nd 32 Mbits/s wit h a maximum total data rate of 128 Mbits/s. T here are 51 modes i n total, 12 of which are for diagnostics. T he complete list is as follows: S2 modes: 4x4-1, 4x8-1, 4x16-1, 4x4-2, 4x8-2, 4x16-2, 8x2-1, 8x4-1, 8x8-1, 8x16-1, 8x2-2, 8x4-2, 8x8-2, 8x16-2, 16x1-1, 16x2-1, 16x4-1, 16x8-1, 16x2-2, 16x4-2, 16x8-2, 32x1-1, 32x2-1, 32x4-1, 32x2-2, 32x4-2, 4i8-1, 8i4-1, 8i8-1, 16i4-1, 16i8-1, 4p8-2, 8p8-2, 16p8-2, 8d16-2, 8n16-2, 16v8-2, 32a4-2, 32b4-2 Test modes: c1test4, c1test8, c1test16, c1test32, c2test4, c2test8, c2test16, c2test32, diag4, diag8, diag16, diag32 Note that mode names alway s use lower-case letters -- the S2 will map any upper-case letters to lower-case if necessary. The mode should be set prior to recording or playback. For play back, any mode can be chosen as long as it has t he same total data rate as t he mode used for recording, so that t he correct number of transports is selected. The precise mode will be set automatically after play back starts. In addition to t he numerous regular operational modes, t here are several test modes used to verify proper connection of the C1 or C2 cable, and to perform other system diagnostics. Under certain conditions t he playback mode may be different from the record mode as specified by t he playmodemap defaults file parameter. T he MODE_SET comma nd is not allowed during playback, a nd can only be used to change to modes wit h t he same total data rate duri ng record. For a ny other mode changes, the S2 must be stopped first. See also the GROUP_SET comma nd which should be used after MODE_SET to select t he appropriate group of t ransports to use i n low-bandwidth modes. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: 16) MODE_READ 16 none RESP_MODE 0.5 sec mode (also displayed on console screen)

15)

A - 11


S2-RT User's Manual

APPENDIX A

Description: Reads t he currently selected recorder mode. Duri ng (auto) play back t he correct mode is set automatically based on i nformation encoded on the tape. However, t he initial mode in effect when playback starts must have t he same total data rate as the mode used to record the tape, otherwise t he mode will not be changed a nd MODE_READ will continue to read the old mode. T he fatal status message STAT_BADPBTRANSEL will appear. To correct t his situation, stop playback, set a mode with t he correct total data rate using MODE_SET, t hen restart play back (y ou will probably have to reposition). You can determine what mode the tapes w e r e r e c o r d e d in ei th er b y p a r s in g t h e mo d e s t r i n g f r o m th e d e t a i l e d STAT_BADPBTRANSEL status message, or by using the TAPEINFO_READ_PB command. Command: TAPEID_SET Msg Code: 17 Data: byte1 ... : ASCII Tape ID stri ng termi nated by a NULL (0) cha racter, maximum 20 characters (not incl. NULL). Avoid using unprintable characters. (total data bytes = length of stri ng + 1, max. 21) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: tapeid [STR|blank] Description: Sets t he Tape ID. This i nformation is recorded conti nuously as part of t he S2 auxilia ry data (which is t he same for all individual tapes i n t he tape set). At playback, t he Tape ID can be recovered at a ny position on t he tape. It should be chosen so that it uniquely identifies the set of tapes being recorded. It may i nclude an experiment number, site code, tape set i ndex number, or other useful i nformation. T he format is totally up to t he user as long as the overall length does not exceed 20 cha racters. T he Tape ID should be set prior to the start of recording and t hereafter should not be cha nged for t he remainder of the tape. Followi ng this rule will make it easy to determi ne if all tapes belong to t he same set at play back, regardless of their current positions. If this rule is not followed, status code STAT_INTAPEID may appear during play back indicating t hat two transports have different tape IDs, but it will have no adverse effect on system operation. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 19) 18) TAPEID_READ 18 none RESP_TAPEID 0.5 sec tapeid (also displayed on console screen) Reads the current Tape ID setti ng from t he last TAPEID_SET command. This is t he Tape ID to be recorded, not the play back tape ID. TAPEID_READ_PB 19 none RESP_TAPEID 0.5 sec tapeid (also displayed on console screen) Reads the playback Tape ID. The S2 must currently be playi ng back properly recorded tapes a nd all of them must indicate the same Tape ID value (this should automatically be t rue if t he tapes a re aligned, and may or may not be true if t hey a re not). Since the Tape ID can be changed at any time 17)

A - 12


S2-RT User's Manual

APPENDIX A

during record, the value returned by TAPEID_READ_PB reflects its i nsta ntaneous value a round t he current tape time. If the tapes a re playing but not ``sufficiently'' aligned so that all tape IDs are the same, response RESP_ERR with error code ERR_INPBAUX will be returned (should it be necessary, you can use t he TAPEINFO_READ_PB comma nd to read the different individual tape IDs). If auxilia ry data cannot be extracted from one or more of t he tapes, ERR_NOPBAUX will be returned (this error can be expected to occur duri ng tape alignment a nd just after playback has started). Command: USER_INFO_SET Msg Code: 20 Data: byte1: Info field number (1 to 4) byte2: Boolean, 0x00 Set field value 0x01 Set field label byte3 ... : ASCII i nfo field or label string termi nated by a NULL (0) character. Avoid using unpri ntable cha racters. Maximum field sizes (not i ncl. NULL) are as follows: Field 1: 16 cha rs Field 2: 16 cha rs Field 3: 32 cha rs Field 4: 48 cha rs Label 1-4: 16 cha rs (total data bytes = length of stri ng + 3, max. 51) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: user i nfo {1|2|3|4} {STR|bla nk|label {STR|blank}} Description: Sets t he value of one of 4 user-defined information fields or its label. For example, two separate commands could set field 1 label to ``Source Name'' a nd field 1 to ``3C273''. This i nformation is recorded conti nuously as part of t he S2 auxilia ry data (which is the same for all tapes) and recovered at playback time. T he user i nfo format is totally up to t he user as long as the overall length does not exceed the limits given above. T he user i nfo fields a nd labels should be entered prior to t he sta rt of recording a nd thereafter may be changed at any time, but should not be cha nged more often tha n every few seconds (ot herwise some user info may be lost at playback). Command: USER_INFO_READ Msg Code: 21 Data: byte1: Info field number (1 to 4) byte2: Boolean, 0x00 Read field value 0x01 Read field label (total data bytes = 2) Expected Resp: RESP_USER_INFO Timer Duration: 0.5 sec Eq Console Cmd: user i nfo {1|2|3|4} (also displayed on console screen) Description: Reads the current setti ng of one of t he user information fields or labels, as set using USER_INFO_SET. T his is the user i nfo to be recorded, not the play back user i nfo. 21) 22) Command: USER_INFO_READ_PB Msg Code: 22 20)

A - 13


S2-RT User's Manual

APPENDIX A

Data: byte1: Info field number (1 to 4) byte2: Boolean, 0x00 Read field value 0x01 Read field label (total data bytes = 2) Expected Resp: RESP_USER_INFO Timer Duration: 0.5 sec Eq Console Cmd: user i nfo {1|2|3|4} (also displayed on console screen) Description: Reads one of t he playback user info fields or labels. T he S2 must currently be play ing back properly recorded tapes and all of t hem must indicate the same user i nfo value (this should automatically be t rue if the tapes a re aligned, a nd may or may not be true if t hey a re not). Since the user info can be changed at any time duri ng record, t he value returned by USER_INFO_READ_PB reflects its instanta neous value around the current tape time. If the tapes a re playing but not ``sufficiently'' aligned so that all user i nfo is the same, response RESP_ERR wit h error code ERR_INPBAUX will be returned. If auxiliary data cannot be extracted from one or more of t he tapes, ERR_NOPBAUX will be returned (this error can be expected to occur duri ng tape alignment a nd just after playback has started). Command: USER_DV_SET Msg Code: 23 Data: byte1: Boolean user DV value (record only), 0x00 Set record user data-valid FALSE 0x01 Set record user data-valid TRUE byte2: Boolean playback-user-DV-enable value (playback only ), 0x00 Ignore user data validity flag duri ng playback 0x01 Recognize user data validity flag duri ng playback (total data bytes = 2) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: user dv {y es|no|playback {enable|disable}} Description: Sets t he value of the record user data-valid (DV) flag. T his flag is recorded continuously on t he S2 auxilia ry data channel (which is t he same for all tapes) a nd recovered at playback time, where it is used to invalidate data (if FALSE) by loweri ng the data validity signals on the C2b/c cable. T his facility provides a way to indicate at record time t hat invalid data is being recorded, e.g. t he telescope is slewi ng or off-source. The user DV value should be set as desired prior to t he sta rt of recording a nd thereafter may be changed at any time, but should not be cha nged more often tha n every few seconds. The user DV setti ng (fi rst data byte) is only relevant duri ng record, a nd is not used during play back. T he second data byte cont rols a playback option to ignore the user DV, so that data i ncorrectly ma rked invalid at record time can still be processed. T his second byte is only relevant during playback, a nd is not used duri ng record (pass 0x01 if just setti ng the user DV). Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: 24) USER_DV_READ 24 none RESP_USER_DV 0.5 sec user dv [playback] (user DV also displayed on console screen) 23)

A - 14


S2-RT User's Manual

APPENDIX A

Description: Reads t he current setting of the record user data-valid (DV) flag a nd play back DV-enable flag, as set using USER_DV_SET. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 25) USER_DV_READ_PB 25 none RESP_USER_DV 0.5 sec user dv [playback] (user DV also displayed on console screen) Reads the playback user data-valid (DV) flag, as set by the user at record time. Like USER_DV_READ, the reply contains 2 bytes, but the second byte is always 0. T he S2 must currently be play ing back properly recorded tapes a nd all of them must i ndicate t he same user DV value (this should automatically be true if the tapes are aligned, a nd may or may not be t rue if t hey a re not). Since the user DV value can be cha nged at a ny time during record, t he value returned by USER_DV_READ_PB reflects its i nsta nta neous value a round t he current tape time. If the tapes a re playing but not ``sufficiently'' aligned so that all user DV flags are t he same, response RESP_ERR with error code ERR_INPBAUX will be returned. It is not usually necessary to read t he user DV flag at playback since the S2 will automatically set the hardwa re data validity signals accordi ngly, combi ned with ot her sources of playback data validity. If the play back DV-enable flag is set to FALSE, the playback user DV flag will not be used as a factor in determini ng data validity.

Command: GROUP_SET Msg Code: 26 Data: byte1: transport group number, 0­7 (total data bytes = 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 1.5 sec Eq Console Cmd: group NUM Description: Selects which group of tra nsports should be used in modes that don't require all 8 transports. T here can be from 1 to 8 different groups, depending on t he total data rate of t he current mode. Groups a re numbered sta rting at 0. For example, i n mode 16x2-1 there a re 4 groups numbered 0 to 3. Tra nsports 0­ 1 are group 0, transports 2­3 are group 1, and so on. The GROUP_SET command is not allowed to change the group number duri ng (automatic) playback or record -- t he S2 must be stopped and t hen resta rted to change groups. GROUP_SET is ty pically used followi ng a MODE_SET command. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 27) GROUP_READ 27 none RESP_GROUP 0.5 sec group Reads the current tra nsport group number (0­7), as set using GROUP_SET. T he reply also includes t he total number of groups available (1­8), since t his cha nges dependi ng on the current mode. See RESP_GROUP for the reply format.

26)

28)

Command: TAPEINFO_READ_PB Msg Code: 28

A - 15


S2-RT User's Manual

APPENDIX A

Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

none RESP_TAPEINFO 0.5 sec tapeinfo Returns tape-related information duri ng playback for each of the 8 i ndividual t ransports. This i nformation is ext racted from t he auxiliary data cha nnel and i ncludes t he following for each tape: Transport address: T he number of the t ra nsport contai ni ng the tape, 0­7. Channel ID: T he S2 internal cha nnel number of t he tape's data, which is equivalent to the t ra nsport address at record time. Can be used to determine t he ordering of tapes i n t ra nsports. If auxilia ry data could not be ext racted (or tape is not play ing, ejected, etc.) the cha nnel ID will be given as 0xFF. In t his case all other fields will appear as zeroes except possibly the tape time since it can be i ndependently extracted (has its own CRC). Note t han if auxiliary data cannot be extracted for a particula r tra nsport (channel ID is 0xFF), other transports may also show bad auxiliary data even t hough t heir data is in fact good, particularly those with higher tra nsport addresses. T his is because t he S2 ``looks'' at the t ra nsports i n order a nd may not scan past the bad one. T his does not affect the tape time field. Tape ID: The max. 20-character tape identifier stri ng as returned by the TAPEID_READ_PB comma nd. Useful to determi ne individual tape IDs in case the tape IDs a re not all the same, causing TAPEID_READ_PB to return error ERR_INPBAUX. Recorder Mode: The max. 9-cha racter recorder mode stri ng indicating what mode was in effect when the tape was recorded. Tape time: The play back tape time as returned by the TIME_READ_PB command. Useful to determine i ndividual tape times i n case t he tapes are not aligned, causing TIME_READ_PB to return error ERR_NOALIGN. Note that times obtained here may be ambiguous to withi n 1 to 3 seconds since special response sy nchronization is not performed as with TIME_READ_PB. However, relative time differences between tapes will be accurate. The year value 0 i ndicates t hat time could not be extracted from aux data (remaini ng time bytes will be 0). In general, t he time field is much more likely to be valid when playback is marginal because it is decoded sepa rately (i.e. channel ID may be 0xFF while the tape time is valid). Record start time: T he tape time at which t his recording sta rted (time RECORD command was issued). Record S2 serial num: The serial number of t he S2 sy stem used to record this tape. Useful for problem t racing. Record transport serial num: T he serial number of the tra nsport (TCP) used to record t his tape. Useful for problem tracing. Record station delay: T he measured station delay at record time. Useful to determine if uncorrected delay glitches or a ny other unreported delay offsets existed at record time. T he above i nformation may not be valid duri ng tape alignment or immediately after playback starts (cha nnel ID will be 0xFF). See RESP_TAPEINFO for detailed field information.

29)

Command: DELAY_SET Msg Code: 29 Data: byte1: type, 0 = absolute setting, 1 = relative setting byte2 ... byte5: 32-bit signed 2's complement delay value i n nanoseconds, byte2 = MSB. Range: -500000000 to +(500000000-1bit) (abs), -(1000000000-1bit) to +(1000000000-1bit) (rel). (total data bytes = 5)

A - 16


S2-RT User's Manual

APPENDIX A

Expected Resp: Timer Duration: Eq Console Cmd: Description:

RESP_ERR [ERR_NONE] 4.0 sec delay NUM [s|ms|us|ns|bits] [relative] Sets t he station delay. This provides a positive or negative offset of up to 1/2 second between the external 1 Hz reference and t he S2 internal timi ng. T his can be used during record to implement clock offsets a nd corrections, or during play back to implement smoot h delay a nd delay-rate corrections if the sy stem-clock PLL is in 1hz mode. Delay setting can be performed in either absolute or relative terms. For absolute delay setting, t he external 1 Hz sy nc signal (S1HZ_REC on C1 cable or C1HZ on C2a cable) is used as the reference a nd must be present, ot herwise error code ERR_NOU1HZ is returned. Relative delay changes do not require the 1 Hz signal. All delay setti ngs are rounded off to the nearest bit (sample). Use DELAY_READ to obtai n the actual delay value implemented, after rounding, and DELAYM_READ to obtai n the current t rue station delay measurement. The allowed absolute delay ra nge is -0.5 sec to one bit-time less t han of +0.5 sec, where t he bit time is one over t he current user cha nnel data rate (e.g. 62.5 ns in mode 16x8-1). The allowed relative delay ra nge is one bit-time short of -1.0 sec to one bit-time short of +1.0 sec. See also ALIGN (below), and t he descriptions of the delay, align, a nd scpll console comma nds. If t he System-Clock PLL mode is 1hz (used for playback), small station delay cha nges i nvolve a smooth, gradual movement to the new delay value (in any ot her SC PLL mode besides 1hz, delay changes glitch the output clocks a nd data). A typical application would be to have several S2-PTs at a correlation center fed by a common fixed 1 Hz reference, wit h DELAY_SET commands sent over t he RCL to each PT for delay tracking. All sy stem timi ng and data remai ns continuously valid provided that the followi ng limits a re met: max. delay rate ±1 x 10-3 s/s, max. delay acceleration ±1 x 10-6 s/s2, max. delay step at 0 delay rate ±1 x 10-5 s. You should use the ALIGN comma nd instead of DELAY_SET for large delay cha nges t hat would exceed these limits. Exceeding t he limits may cause STAT_SCPLLSLIP and/or STAT_SCPLLUNLOCK status messages i ndicati ng t hat t he SC PLL is considered unlocked (difference between delay setting a nd delay measurement greater than about 6 x 10-5 s). Smooth delay tracking is still attempted, alt hough internal timing problems resulting i n loss of play back data become more likely i n this situation. Smoot h delay t racki ng is suspended for delay errors or steps greater tha n about 3 x 10-3 s, at which time phase-offsetti ng is used to adjust t he delay. DELAY_READ 30 none RESP_DELAY 0.5 sec delay Returns t he current station delay setting, from the last DELAY_SET command. For various reasons includi ng movement or glitching of t he 1 Hz reference or finite sy stem-clock PLL VCO precision when not in refclk mode, t his may not be t he same as t he t rue measured delay value (see next command). T he station delay is expressed i n absolute terms, even if the last DELAY_SET command was relative, and will be in the range -0.5 sec to one bit-time short of +0.5 sec. See RESP_DELAY for the exact reply format.

Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

30)

31)

Command: DELAYM_READ

A - 17


S2-RT User's Manual

APPENDIX A

Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

31 none RESP_DELAY 0.5 sec (none, delay measurement display ed on console screen) Returns the latest station delay measurement. This is the true clock offset between t he externally supplied 1 Hz reference and the S2's internal 1 Hz tick, which should match the current delay setti ng if t he sy stem-clock PLL is i n refclk mode, or be withi n a few hundred bits of it when in 1hz mode. The station delay measurement is always in the range -.5 sec to one bit-time short of +.5 sec. See RESP_DELAY for t he exact reply format. If t he user external 1 Hz reference is not present, RESP_ERR wit h code ERR_NOU1HZ will be returned.

Command: BARRELROLL_SET Msg Code: 32 Data: byte1: Boolean barrel roll setting, 0x00 Turn barrel roll OFF 0x01 Turn barrel roll ON (total data bytes = 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: ba rrelroll {on|off} Description: Turns ba rrel-roll on or off. When on, ba rrel-roll rotates user data over all active t ra nsports, and un-rotates on playback, so that the possible effect of a margi nal t ra nsport is averaged over all cha nnels. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 33) BARRELROLL_READ 33 none RESP_BARRELROLL 0.5 sec ba rrelroll Reads t he current barrel-roll setting, as set using BARRELROLL_SET. Duri ng (auto) playback t he barrel roll is automatically set to t he same condition as at record time based on information encoded on t he tape.

32)

34)

Command: ALIGN Msg Code: 34 Data: byte1: alignment ty pe code: 0x00: align to absolute tape time byte2, byte3: tape UT absolute year (1901­2099), byte2= MSB If 0, correct year a nd day will be inferred. If 1, just correct year will be i nferred. byte4, byte5: tape UT days (1-365/366), byte4= MSB Ignored if year is 0 (correct day will be inferred). byte6: tape UT hours (0-23) byte7: tape UT minutes (0-59) byte8: tape UT seconds (0-59) byte9 ... byte12: tape UT ns (0-999999999), byte9 = MSB (32-bit unsigned integer) 0x01: relative alignment byte2: sign,

A - 18


S2-RT User's Manual

APPENDIX A

Expected Resp: Timer Duration: Eq Console Cmd: Description:

0 = positive (forward i n time) 1 = negative (backwa rd in time) byte3: hours (0-23) byte4: mi nutes (0-59) byte5: seconds (0-59) byte6 ... byte9: na noseconds (0-999999999), byte6 = MSB (32-bit unsigned integer) 0x02: ``re-align'': Re-align to latest alignment reference time (no additional data bytes) 0x03: ``self-align'': Align t he t ransports to each other using t he earliest, latest, or middle tape time as t he reference, as per t he selfaligntarg defaults file option (no additional data bytes) (total data bytes = 12 max.) RESP_ERR [ERR_NONE] 0.5 sec align [[+|-]NN:NN:NN[.NNNNNNNNN]] T his is used duri ng automatic play back to align tapes to an absolute time or by some relative amount. It works by slewi ng the t ra nsports a nd (if necessary) adjusti ng the station delay setti ng. Alignment is normally done after positioning is complete. Unlike positioning, tape alignment is a precise operation, accurate down to t he bit. All alignment times a re rounded off to t he nearest bit (sample) time at t he current user cha nnel data rate. Any ALIGN comma nd where the nanoseconds portion is non-zero implicitly performs a relative station delay adjustment in t he same way as the DELAY_SET comma nd. However, ALIGN should not be used to implement delay and delay-rate tracking, as this may interfere wit h the automatic playback monitoring -- use DELAY_SET i nstead. DELAY_SET (or ERRMES) should be used i n place of ALIGN for any regula r delay adjustments that fall within the delay-rate a nd acceleration limits given i n the description of DELAY_SET. Two kinds of tape alignment a re supported: absolute and relative. In absolute alignment, t he external control computer specifies a time to which t he S2 should align its tapes. T his time is referenced to t he second it is received by t he S2, i.e. it is the tape time t hat would appear if t he procedure was i nsta ntaneous, but in fact alignment may take several seconds or minutes, depending on the distance to slew. Because of the asy nchronous nature of t he Radioastronomy Control Link, t he external computer must issue t he absolute align comma nd immediately followi ng an S-1 Hz output tick (S1HZ_PB on C2a cable), a nd that tick is taken as t he reference for t he absolute time contai ned i n t he command. If it takes 20 seconds to align, then the first valid data will be for the requested alignment time plus 20 seconds. When it is not convenient to i nclude t he year a nd/or day number in the absolute alignment time, these can be automatically inferred based on the year and day number extracted from tape: pass t he year as 0 to infer bot h the year a nd day, or 1 to i nfer just the year. Relative alignment is performed by applyi ng a signed relative offset to t he current tape time. Unlike absolute alignment, there a re no special synchronization requi rements for the comma nd itself. However t he tapes must already be aligned to t he same tape time or error code ERR_NOALIGN will be returned (if necessary use the self-align option first, see below). The external control computer may read t he tape time wit h TIME_READ_PB in order to calculate t he requi red relative offset. Two special alignment options are provided t hat may be useful in certai n cases. ``re-align'' (ty pe code 2) causes the tapes to re-align to the previously chosen reference time should one or more transports ever become un-aligned.

A - 19


S2-RT User's Manual

APPENDIX A

T his is normally done automatically by the S2's regula r playback monitoring, but a way to i nitiate t his ma nually may sometimes be useful following a ``fatal'' align error (STAT_ALIGNFAIL), where no furt her automatic attempts a re made to re-align. The ``re-align'' option should not be used unless some ot her type of alignment has al ready been performed for the current set of tapes. T he ``self-align'' option (type code 3) causes t he transports to align to each other by chosing a ta rget reference time based on the current tape times. T hree selection methods are available according to t he defaults file option selfaligntarg: the ``fi rst'' tape time, the ``last'' tape time, or the ``middle'' tape time half-way between t he two. Self-alignment is t he ty pe of alignment normally performed automatically each time play back sta rts. However, t he user may explicitly initiate self-alignment to force tape alignment following certain status conditions such as STAT_ALIGNFAIL (a fatal error i n t he previous alignment attempt, see below). To prevent the automatic selfalignment at the start of playback, issue a relative ALIGN comma nd wit h a zero offset (i.e. hours, mi nutes, seconds, nsec all 0) immediately after play back sta rts. This will result i n a STAT_ALIGNFAIL message wit h error code ERR_NOALIGN, which can be ignored, but no tape slewi ng will take place. While alignment is i n progress t he current tape time is undefined and playback data, including auxiliary data, is i nvalid. T he STATUS command should be used to monitor the progress of t he alignment procedure. STAT_ALIGNIP indicates t hat tape alignment is in progress, and STAT_ALIGNDONE will appear momenta rily when alignment successfully completes. STAT_ALIGNFAIL indicates t hat the alignment operation aborted due to a fatal error and will persist until another alignment operation is explicitly sta rted or playback is terminated. STAT_ERRALIGN appears momentarily to i ndicate non-fatal errors which cause the alignment operation to be automatically resta rted. Finally, STAT_NOALIGN appears whenever tapes are not aligned and play back data should be considered invalid. It will disappear following a successful alignment operation and will re-appear if a ny unusual condition causes the tapes to go out of alignment. Note that absolute ALIGN comma nds (but not any ot her type) are not subject to automatic communications retries wit hi n t he RCL interface libra ry, ot herwise t he wrong alignment time might be sent. T he rcl_align_abs() function call should be re-issued with an updated time if a communications timeout occurs. See also t he DELAY_SET comma nd. 35) Command: POSITION_SET Msg Code: 35 Data: byte1: positioni ng type code: 0x00: absolute tape positioning byte2: number of positions being specified (1 or 8). Use 1 when comma nding all currently selected t ransports to t he same position, 8 when comma ndi ng tra nsports to different positions. byte3 ... : List of positions. Each ent ry is a signed 32-bit i nteger representi ng the absolute position i n seconds since BOT, MSB first. Values should be restricted to t he ra nge 0­43199, or 0x7FFFFFFF if by te2==8 a nd transport not selected (up to 32 bytes total) 0x01: relative tape positioning byte2: number of positions being specified (1 or 8) byte3 ... : List of positions. Each ent ry is a signed 32-bit i nteger representi ng the relative number of seconds to move, MSB first. Values should be restricted to the range -43199­43199, or 0x7FFFFFFF if by te2==8 a nd transport

A - 20


S2-RT User's Manual

APPENDIX A

Expected Resp: Timer Duration: Eq Console Cmd: Description:

not selected (up to 32 bytes total) 0x02: position preset byte2: number of positions being specified (1 or 8) byte3 ... : List of positions. Each ent ry is a signed 32-bit i nteger representi ng the absolute position i n seconds since BOT, MSB first. Values should be restricted to t he ra nge 0­43199, or -0x80000000 to ma rk a position as unknown, or 0x7FFFFFFF if byte2==8 and t ra nsport not selected (up to 32 bytes total) 0x03: ``re-establish'': for all currently selected t ransports, rewinds t he tape to t he begi nni ng and t hen returns to t he origi nal position, which is then known (no additional data by tes). (total data bytes = 34 max.) RESP_ERR [ERR_NONE] 1.5 sec position T he position comma nd is used before play back or record to position t he tapes to a specific location. Position is measured as t he number of seconds of recorded data since the beginni ng of tape, and is normally displayed as hours/minutes/seconds, e.g. 3:18:57. This format is similar to a tape time except t hat the hours portion is normally shown wit h only a single digit. Sections of blank tape do not count i n position determination. Duri ng positioning t he recorder state cha nges to RSTATE_POSITION (use STATE_READ to test). Alt hough there may be up to 8 tapes a nd therefore 8 different positions, we try to work wit h a single position value whenever possible since t he group of currently active tra nsports will usually be i n almost the same location. The current position is considered unknown after a tape is inserted, or following application of power to t he t ransports. The position becomes known when a t ransport encounters beginning-of-tape (BOT), where t he position is defined to be 0 (i.e. 0:00:00)2. Although positions are normally positive for purposes of POSITION_SET, the current position reading can take on small negative values due to a nomalies around BOT. T here are two ways to perform positioning: absolute and relative. In addition, there a re two special positioning functions preset and re-establish. Absolute positioning moves the tapes to a specific position regardless of their current location. If the current position is not known, the tapes a re fi rst automatically rewound to t he begi nni ng to determi ne t he position. Eit her 1 or 8 i ndividual position values may be specified. If only 1 is specified (``number of positions'' = 1), all transports are moved to the same position. When 8 values a re specified, each corresponds to a tra nsport in order from 0 t hrough 7. Transports which are not selected under the current recorder mode and group setti ngs will ignore the position comma nd. When 8 position values a re given t he entries for unselected t ransports should be filled in as 0x7FFFFFFF (the maximum 32-bit signed i nteger value). To determi ne which t ransports are currently unselected, use POSITION_READ a nd check for position entries with the value 0x7FFFFFFF. Note t hat using 0x7FFFFFFF for t ra nsports which are currently selected is not allowed, and will result in an error. Relative positioni ng moves the tapes a given amount relative to their current position. The current position does not need to be known for relative positioni ng to work. Positive position values move forward, and negative val-

2

The position ``preset'' feature will also make the position known.

A - 21


S2-RT User's Manual

APPENDIX A

ues move backward. T he position re-establish feature allows an unknown position to be determined wit hout movi ng the tapes to a specific absolute location. The tapes a re rewound a nd then automatically returned to t heir origi nal position, as computed from t he distance covered during rewi nd, a nd the position is agai n considered known. This may be useful followi ng a power failure when t he S2 has lost track of t he current tape position, or when non-rewound tapes a re i nserted. It can also be used to accurately re-determine t he current position if cumulative errors have built up i n t he position measurement after a long period of repetitive tape activity. T he position preset feature allows users to set the current position without actually moving t he tapes. This should only be used when the current position is considered unknown by t he S2 and t he user has detailed knowledge of what t he position should be, a nd there is not enough time to rewind t he tapes to determine the position i n t he normal way. Position preset can also be used to explicitly ma rk the position as unknown by using the ``unknown'' position -0x80000000 (the minimum 32-bit signed i nteger value). Command: POSITION_READ Msg Code: 36 Data: byte1: type of request, 0x00 return overall (mid-point) position and linear variance 0x01 return 8 i ndividual tra nsport positions (total data bytes = 1) Expected Resp: RESP_POSITION Timer Duration: 0.5 sec Eq Console Cmd: t ransport display position (also displayed on console screen) Description: Reads t he current S2 tape position in one of two formats, overall or individual. T he overall position is a single position value defined as the mid-point (middle) of the i ndividual t ra nsport positions, a nd i ncludes a li near varia nce value which i ndicates the maximum absolute deviation of a ny i ndividual tape position from t he mid-point. Only the tra nsports selected under the current mode a nd group settings are counted i n the overall position. If t he va riance is small enough (depending on the user's application) t hen it will be possible to later return to t he same position using only the overall position value. If for some reason the varia nce is large, it may be necessary to obtai n t he i ndividual t ra nsport tape positions to be able to return to exactly the same position. T he individual position i nformation obtained should be t reated as a unit for purposes of subsequently commanding the S2 to return to that position with POSITION_SET. Any i ndividual position value that is unknown will be returned as -0x80000000 (the minimum 32-bit signed integer value). Transports which are not selected for use under t he current recorder mode a nd group setti ngs will return their positions as 0x7FFFFFFF. Alt hough normally positive, position readings can take on small negative values due to a nomalies a round BOT. See t he description of the response RESP_POSITION for more i nformation. Command: ERRMES Msg Code: 37 Data: byte1 ... byte4: 32-bit signed 2's complement i nteger i ndicati ng the FIFO error i n samples at t he current user cha nnel data rate. (total data bytes = 4) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: (none) 37) 36)

A - 22


S2-RT User's Manual

APPENDIX A

Description: Used to sy nchronize t he S2 recorder's playback rate when the Sy stem-Clock PLL is i n errmes mode. The parameter indicates the difference between t he actual play back tape position and t he desired position as a number of bits (data samples) at the current user cha nnel data rate. In practice, this is t he relative dista nce between t he center of t he correlator's internal data FIFO and t he read poi nter. If the sign is positive then the FIFO read pointer is between center a nd overflow. If t he sign is negative then the pointer is between center a nd underflow. When using errmes mode, a n ERRMES command should be sent by the external cont rol computer about once per second (occasionally missing one is not serious). The time between taking the FIFO error measurement a nd transmitti ng the comma nd should be kept as short as possible for optimum SC PLL performance. The followi ng limits should be observed: Max. delay rate: ±1 x 10-3 s/s Max. delay acceleration: ±1 x 10-6 s/s2 Max. delay step at 0 delay rate: ±1 x 10-5 s Exceeding t hese limits may cause STAT_SCPLLSLIP a nd/or STAT_SCPLLUNLOCK status messages i ndicati ng that the SC PLL is considered unlocked (FIFO error greater t ha n about 6 x 10-5 s). In this situation, i.e. ERRMES values greater tha n 6 x 10-5 s, smooth delay tracking continues as well as possible, alt hough i nternal timing problems resulting i n loss of playback data become more likely i n ext reme cases where t he SCPLL VCO is pushed near its rail values. Command: ESTERR_READ Msg Code: 38 Data: byte1: orderi ng of returned list, 0x00 i n order of t ra nsports (0..7) 0x01 i n order of i nternal recorder cha nnels (0..7) (total data bytes = 1) Expected Resp: RESP_ESTERR Timer Duration: 0.5 sec Eq Console Cmd: t ransport display esterr Description: Returns a list of estimated bit error rates. Each entry i n t he list corresponds to a t ra nsport a nd/or S2 internal data cha nnel number, although this fact can be ignored. The number of entries in t he list depends on how ma ny channels/tra nsports a re currently active, as determi ned by t he current mode. The list can be further processed externally to compute a n average or select t he highest & lowest ent ries. T he orderi ng of the list can be eit her by t ra nsport or by i nternal recorder channel. If by t ransport, the order corresponds to the physical t ransports and t he tapes t hey contai n. If by channel, t he order is independent of playback tape orderi ng and corresponds to t he orderi ng of transports and tapes at record time. T he default should usually be orderi ng by t ransport (data byte1 = 0x00). Estimated error rates a re encoded as ASCII strings instead of as bina ry floating-point quantities to avoid problems wit h i ncompatible floating-point representations. E rror rates a re estimated by counting t he number of missed sync words i n t he formatted i nternal data channels a nd extrapolating to encompass all data bits. We assume t hat the error rate is low, so if a sy nc word is i ncorrect we presume that i n fact only a single bit is i n error. T hese assumptions break down for high error rates and for extended burst errors, but i n practice t he estimate has been found to be very close to the true bit error-rate i n almost all cases. Because sy nc words represent only a small proportion of the data, a relatively long integration is needed to measure useful error rates. T he integration period used is 6 seconds, givi ng a mi nimum measurement resolution of around 1.0 x 10-6. T here is also a n a rtificial upper limit of 38)

A - 23


S2-RT User's Manual

APPENDIX A

1.0 x 10-2, imposed to avoid the i naccurate upper estimation range. T he strings returned i n t he two boundary cases are ``<1.0e-6'' and ``>1.0e-2'', alt hough t he exact numbers may vary (external softwa re should check only for t he initial ``<'' or ``>'' sign). Estimated error rates a re available i n both record and play back states. In record, t he error rate reflects the results of decodi ng data from the ``record'' diagnostic loopback path, and will usually be below t he mi nimum resolution t hreshold. Because it has only one decoder, an S2-RT may take between 1 a nd 3 minutes to build up a complete list of error rate estimates when first sta rting playback or record. Until t hen error estimates are considered unknown, a nd appear as empty stri ngs. T he same is true when recordi ng on a PT (because t here is only one diagnostic pat h) but not duri ng playback. T his also means that at a ny time i ndividual estimates might be several mi nutes old. In addition, certain status conditions can i nterfere with automatic play back/record scanning a nd prevent estimates from being computed or cause t hem to stop being updated. Also remember that the error rates are calculated for i nternal recorder cha nnels a nd do not apply directly to user data channels unless the user data rate is 16 Mbits/s (e.g. mode 16x8-1). The estimated error rate values are for operator reference only, a nd do not by t hemselves indicate correct sy stem functionality (sy stem status is used for t hat). Command: PDV_READ Msg Code: 39 Data: byte1: orderi ng of returned list, 0x00 i n order of t ra nsports (0..7) 0x01 i n order of i nternal recorder cha nnels (0..7) (total data bytes = 1) Expected Resp: RESP_PDV Timer Duration: 0.5 sec Eq Console Cmd: t ransport display dv Description: Returns a list of percent data valid. Each entry i n the list corresponds to a t ransport a nd/or S2 i nternal data cha nnel number, alt hough this fact can be ignored. The number of entries in t he list depends on how ma ny channels/transports are currently active, as determi ned by t he current mode. The list can be furt her processed externally to compute an average or select the highest & lowest entries. The ordering of t he list can be either by transport or by internal recorder cha nnel. If by t ra nsport, t he order corresponds to the physical t ransports and t he tapes t hey contai n. If by channel, t he order is independent of playback tape orderi ng and corresponds to t he ordering of t ransports and tapes at record time. T he default should usually be orderi ng by transport (data byte1 = 0x00). Percent data valid is encoded as ASCII stri ngs instead of as binary floati ng-point quantities to avoid problems with incompatible floati ng-point representations. T he % DV value is obtained by integrati ng a cha nnel's data validity signal over a one second period, where 100.00% i ndicates all data was valid a nd 0.00% indicates no data was valid. % DV is available i n both record a nd playback states. In record, t he value reflects the results of decodi ng data from the ``record'' diagnostic loopback path, and will usually be 100.00%. Because it has only one decoder, a n S2-RT may take between 8 a nd 90 seconds to build up a complete % data valid list when first sta rting playback or record. Until then ent ries a re considered unknown, a nd appear as empty strings. The same is true when recording on a PT (because there is only one diagnostic path) but not during play back. This also means that at a ny time i ndividual values might be up to 90 seconds old. In addition, certai n status conditions can i nterfere with automatic playback/record scanning a nd prevent % data valid from being computed or cause it to stop being updated. Remem39)

A - 24


S2-RT User's Manual

APPENDIX A

ber that % data valid is calculated for i nternal recorder cha nnels a nd does not apply di rectly to user data cha nnels unless the user data rate is 16 Mbits/s (e.g. mode 16x8-1). The % data valid values a re for operator reference only, and do not by themselves i ndicate correct sy stem functionality (sy stem status is used for t hat). Command: SCPLL_MODE_SET Msg Code: 42 Data: byte1: SC PLL mode code 0x00 xtal 0x01 manual 0x02 refclk 0x03 1hz 0x04 errmes (total data bytes = 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: scpll mode {refclk|1hz|errmes|xtal|ma nual} Description: Sets t he Sy stem Clock Phase-Lock Loop mode. T he SC PLL, located on t he UI boa rd, drives all of the S2 system timi ng. Its mode determi nes what t he PLL uses as its lock reference. T he SC PLL is normally locked to a n external high-rate reference clock during record (refclk), or to a 1 Hz or softwa re reference for play back rate cont rol at a correlator (1hz or errmes). The PLL can also run independently based on an internal crystal oscillator (xtal) or be cont rolled manually for testing (manual). T he initial SC PLL mode is determined by the scpllmode option of the sy stem defaults file. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 44) 43) SCPLL_MODE_READ 43 none RESP_SCPLL_MODE 0.5 sec scpll mode (also displayed on console `userio' screen) Reads the current Sy stem Clock Phase-Lock Loop mode, which determi nes what is being used as the sy stem timing reference. 42)

Command: TAPETYPE_SET Msg Code: 44 Data: byte1 ... : ASCII tape type string terminated by a NULL (0) character, maximum 6 characters (not incl. NULL). Note that all normal tape ty pe codes are one cha racter l ong (0­9, A­Z ) but ``un li st e d'' t a pe t ype s are si x di gi ts lo ng of t he for m NNNMMM where NNN is the write current for LP a nd MMM is t he write current for SLP. (total data bytes = length of stri ng + 1, max. 7) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: tapetype [STR] Description: Sets t he tape type. T his indicates what ty pe of tape is loaded in t he S2 usi ng the type codes 0­9 a nd A­Z as listed i n Chapter 5. T he tape ty pe cont rols how much write current should be used when recording. As new tape ty pes are approved softwa re upgrades will be provided to allow recognition of t he new ty pe codes. For unlisted tape types it is also possible to specify a 6-digit numeric string which i ndicates t he LP and SLP write-current levels

A - 25


S2-RT User's Manual

APPENDIX A

explicitly. For example, `100070' sets LP write current to 100 and SLP write current to 70. T he requi red 6-digit tape type strings will be supplied by CRESTech/SGL when new tape ty pes are approved. Note t hat t he tape type reverts to the default value given in the defaults file when t he S2 reboots. T he TAPETYPE_SET command is not allowed duri ng record. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 50) 45) TAPETYPE_READ 45 none RESP_TAPETYPE 0.5 sec tapetype Reads the current tape type setti ng. See the description of RESP_TAPETYPE for more i nformation.

Command: MK3_FORM_SET Msg Code: 50 Data: byte1: Boolean value, 0x00 Disable Mark III formatter 0x01 E nable Mark III formatter (total data bytes = 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 5.0 sec Eq Console Cmd: mk3 form {enable|disable} Description: Turns t he S2 i nternal Mk3 format generator on and off. When turned on, t he C2a cable output switches to Mk3-compatible mode. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 55) 51) MK3_FORM_READ 51 none RESP_MK3_FORM 0.5 sec mk3 form Reads the current Mark III formatter enable/disable state, as set with MK3_FORM_SET. TRANSPORT_TIMES 55 none RESP_TRANSPORT_TIMES 0.5 sec t ransport status time For all t ransports reads the total power-on time since manufacture, total headuse time since ma nufacture, time since last head replacement (head-use), and time since last service (in-service). T he head-use and i n-service times give t he amount of active head use since the last head replacement or service operation was performed, respectively, as entered using t he transport N service console command. The reply includes TCP serial numbers for identification. See RESP_TRANSPORT_TIMES for more i nformation.

60)

Command: STATION_INFO_READ Msg Code: 60

A - 26


S2-RT User's Manual

APPENDIX A

Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

none RESP_STATION_INFO 0.5 sec station, serial Reads information which identifies t he S2 sy stem, i ncluding its station number, serial number, a nd nickname. All three of t hese values come from t he system defaults file (station, nickname, a nd serialnum options). See RESP_STATION_INFO for more i nformation.

Command: CONSOLECMD (generic) Msg Code: 70 Data: byte1 ... : ASCII console comma nd stri ng termi nated by a NULL (0) cha racter, maximum 255 characters (not incl. NULL). (total data bytes = length of stri ng + 1, max. 256) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 3.0 sec Eq Console Cmd: -- Description: Executes a n arbit rary console command. There a re some severe limitations. First, no comma nd output is returned except t he error return code, so commands which just display information a re of no use. Second, it is up to t he caller to ensure that the chosen comma nd is guaranteed to complete i n less t han 3 seconds. For example, duri ng playback, setup 0 transport 5 is fine but setup transport 5 is bad because it can take more t han 3 seconds to decode cha nnel information from t ransport 5. Comma nds such as form berc a re way out -- you will perma nently hang t he RCL and probably eventually crash t he S2 software. Any command already supported by t he RCL should not be executed wit h CONSOLECMD, even appa rently i nnocuous commands such as record or stop. Remember: use this feature at your own risk. Command: POSTIME_READ Msg Code: 71 Data: byte1: Tra nsport number (0­7) (total data bytes = 1) Expected Resp: RESP_POSTIME Timer Duration: 0.5 sec Eq Console Cmd: (none) Description: T his comma nd is for SGL internal use when runni ng tests to check and calibrate the internal transport positioning software. The response RESP_POSTIME includes bot h the play back tape time and tape position for a particula r tra nsport. When test tapes a re recorded i n such a way t hat t he tape time matches the tape position, t his can be used to determine cumulative position sensing errors. T he response from the S2 recorder is sent immediately (unlike TIME_READ_PB where the response is sy nchronized to the 1 Hz tick). If t he playback tape time is unknown or i nvalid, t he 'year', 'day ', 'hour ', 'mi n', 'sec', a nd 'frame' fields will all be 0. If the t ra nsport position is unknown, 'position' will be -0x80000000. 80) Command: Msg Code: Data: Expected Resp: Timer Duration: STATUS (generic) 80 none RESP_STATUS 0.5 sec 71)

70)

A - 27


S2-RT User's Manual

APPENDIX A

Eq Console Cmd: (displayed on console screen) Description: Reads t he S2 recorder brief status report. T he brief report i ncludes only numeric status codes, no text messages. For a detailed description of all status codes see Section 4.5. This comma nd should be sent approximately every 1 to 5 seconds since status conditions accumulate i n-between reads and will come out all at once on t he next read. Status entries a re returned in order of severity from most to least severe, which means i n order of increasing status code number, not in order of occurrence. Reading S2 status with t he RCL STATUS comma nd causes all clearon-read status ent ries to be cleared for t he RCL, simila r to typing 'status reset' on t he console for the console status. T hese entries will not appear in the next STATUS request unless the condition t hey represent has occurred agai n. Non-clearon-read status ent ries will persist until the condition they represent has gone away. Note that RCL status is not necessarily t he same as the console status window, a nd is not affected by console commands such as 'status reset'. Similarly, reading t he RCL status will not affect the console status wi ndow. Use STATUS_DETAIL to obtain detailed i nformation messages for status conditions returned here. See RESP_STATUS for more information. Command: STATUS_DETAIL (generic) Msg Code: 81 Data: byte1: status code to return detailed i nformation for, 0 = all active status codes byte2: Boolean, ``re-read'' flag: 0x00 Don't re-read status, use conditions from last STATUS request 0x01 Re-read status (implicitly performs STATUS first) byte3: Boolean, ``short'' option: 0x00 Use regula r long-form messages (one or more lines, up to 399 cha racters, but often less t han 80 chars) 0x01 Use shortened messages (like console, max. 34 cha rs) (total data bytes = 3) Expected Resp: RESP_STATUS_DETAIL Timer Duration: 0.5 sec Eq Console Cmd: status display Description: Reads S2 recorder detailed status report for 1 or all active status conditions. If t he ``re-read'' flag (data byte 2) is not set, this lists only conditions i n effect at the time of t he last STATUS command. Thus you can obtain detailed i nformation after detecting a n unusual status condition i n the brief status response (RESP_STATUS), wit hout having t he active status conditions cha nge. T he detailed status messages are suitable for loggi ng or other error reporting purposes. If the ``re-read'' flag is set, t his comma nd lists new status conditions, i.e. implicitly performs STATUS first. The ``short'' option allows access to shorter versions of the detailed status messages, useful to save space when displaying status. However the regula r (long) form should still be used whenever possible since t he short messages are i ntended for t he console a nd a re not as accurate or complete. The reason that two versions of t he status command (STATUS and STATUS_DETAIL) a re provided is for efficiency so t hat you can use t he ``fast'' one for polling a nd the slower one (STATUS_DETAIL) after problems a re found if you need t he text messages. If you always ask for the text messages regardless, you can skip sending STATUS a nd send STATUS_DETAIL directly with t he ``re-read'' flag TRUE. See RESP_STATUS and RESP_STATUS_DETAIL for more i nformation. 82) Command: STATUS_DECODE (generic) Msg Code: 82 81)

A - 28


S2-RT User's Manual

APPENDIX A

Data: byte1: numeric status code from 1 to 127 (RCL_STATCODE_MAX) byte2: Boolean, ``short'' option: 0x00 Return regular long-form message (one or more lines, up to 399 cha racters) 0x01 Return shortened message (like console, max. 34 cha rs) (total data bytes = 2) Expected Resp: RESP_STATUS_DECODE Timer Duration: 0.5 sec Eq Console Cmd: status decode Description: Tra nslates a numeric status code to its corresponding mnemonic/text message. T his is useful for building a run-time table of status codes and m nemonics so t hat t he m nemonics, and not t he changeable codes themselves, can be used easily i n softwa re condition tests. For error reporting or logging purposes use STATUS_DETAIL i nstead since that includes occurrence-specific information such as channel numbers i n the returned messages, while STATUS_DECODE fills in such va riable information with ``xxx''. Command: ERROR_DECODE (generic) Msg Code: 83 Data: byte1: 8-bit signed 2's complement error code (total data bytes = 1) Expected Resp: RESP_ERROR_DECODE Timer Duration: 0.5 sec Eq Console Cmd: error decode Description: Tra nslates a negative numeric error code (ERR_*) to the corresponding text message (i ncludes m nemonic). See also RESP_ERR and t he list of S2 error codes on Page A-32. Command: DIAG (generic) Msg Code: 90 Data: byte1: Diagnostic type: 0x01 Perform self-test 1 (total data bytes = 1) Expected Resp: RESP_ERR [ERR_NONE] Timer Duration: 0.5 sec Eq Console Cmd: diag self1 Description: Initiates S2 i nternal diagnostic sequences. Currently the only diagnostic sequence which can be run here is self-test 1 (t he power-on self test). While self-test 1 is runni ng most RCL comma nds which affect tape motion or system switch settings a re not allowed (t hey will return ERR_SELF1INPROG). Users should poll S2 status to determine when t he diagnostic test completes: STAT_DIAGIP indicates that t he test is in progress, STAT_DIAGDONE i ndicates t hat the test completed successfully, a nd STAT_DIAGFAIL indicates t hat t he test has found a system fault or aborted due to an error. 91) Command: BERDCB Msg Code: 91 90) 83)

A - 29


S2-RT User's Manual

APPENDIX A

Data: byte1: Desired operation type: 0x01 Perform Formatter bit-error rate measurement 0x02 Perform UI bit-error rate measurement 0x03 Perform UI DC-bias measurement byte2: Cha nnel number to use (internal data channel 0 t hrough 7 for FORM BER, or user data cha nnel 0 through 15 for UI BER and UI DC-bias). byte3: Measurement time in seconds (1­255). This directly affects the length of time for this command to execute and thus determines the required timer duration value (see below). Recommended ty pical value: 1 sec, recommended maximum value: 10 sec. (total data bytes = 3) Expected Resp: RESP_BERDCB Timer Duration: Measurement time + 1 sec Eq Console Cmd: form berc, uic berc, uic dcbias Description: Performs one of 3 ty pes of statistical measurements on a given data channel: Formatter bit-error rate, UI bit-error rate, or UI DC-bias. All of these measurements can only be done on one channel at a time. The FORM BER measurement performs a t rue bit-error rate measurement on one 16 Mbit/s i nternal S2 data cha nnel (0­7) by comparing against the Formatter test vector sequence. The UI BER measurement performs a t rue bit-error rate measurement on one user data cha nnel (0­15) by compari ng agai nst t he UI test vector sequence. Bot h BER measurements always count both detected a nd undetected errors (i.e. data validity is ignored). In t he case of FORM BER t he formatter Test Vector Generator is automatically turned on for t he duration of t he measurement if requi red. The UI DC-bias measurement counts t he number of bits wit h value 1 in t he specified user data channel (0­15). This is useful to determine the ratio of 1-bits to 0-bits to check if data is reasonable. Note that both t he UI DC-bias a nd UI BER measurements a re made on UI output data (similar to t he data at the C2a cable port). To make measurements of UI i nput data (similar to t he data at t he C1 cable port) you should turn UI feed-through mode on. Since t here is currently no RCL comma nd to set UI feed-through, you will have to use t he RCL CONSOLECMD feature with the console command strings ``uic feedthru on'' or ``uic feedthru off ''. The typical recommended measurement time is 1 second to keep RCL response times quick. It is importa nt to understand that while the BERDCB command is i n progress no other RCL commands a re allowed, t herefore t he maximum recommended measurement time is 10 seconds. In t he case of FORM BER times of up to 255 seconds are actually possible, but for UI BER and DC-bias times a re limited to a few seconds because of limited resolution in t he i nternal counters. Command: DATA_EXTRACT_READ Msg Code: 92 Data: byte 1: type of ext raction (0 to 3), 0 - extract S2 user data (format-less) 1 - extract S2 data validity 2 - extract MkIII-format data (trigger on sy nc detect) 3 - extract MkIII-format data (trigger on 1 Hz tick) byte 2: bit offset (0 to 255, must be 0 for 32 Mbit modes 32xU-Q) byte 3: user channel number (range 0-15 for S2 data/validity or 0-13 for MkIII data) (total data bytes = 3) Expected Resp: RESP_DATA_EXTRACT Timer Duration: 1.25 sec Eq Console Cmd: uic dataextract, uic validity extract, mk3 dataext ract 92)

A - 30


S2-RT User's Manual

APPENDIX A

Description: Extracts a small ``snapshot'' of data, consisti ng of 24 consecutive bits or t hree bytes of data, from a particular S2 user data cha nnel. Can also be used to ext ract S2 data validity, or Mark III formatted data when t he Mark III formatter is enabled. T he ext racted data ``snapshot'' starts sy nchronous to t he next 1 Hz tick, or optionally sy nchronous to t he next detected sy nc word for Mark III format data (ext raction type code 2). A bit offset may be specified to delay the sta rt of ext raction for up to 255 bits relative to t he 1 Hz tick (or sy nc word trigger). Bit off sets a re not supported i n 32 Mbit modes (offset value must be 0). For Mark III dataextract t he t hree least-significant bits of t he fourth response byte i ndicate parity errors for each of t he 3 data bytes. The contents of the data or validity cha nnel used for extraction depends on the current data pat h configuration as set by other RCL commands such as PLAY, STOP, MK3_FORM_SET, and console commands s u ch as setup, uic feedthru, mk3 form, a n d ot he r s . T h e DATA_EXTRACT_READ comma nd is intended for diagnostic and test purposes. It can be used, for exampled, to help verify the correct connection of the data acquisition sy stem or sampler supplyi ng data to t he S2 recorder. Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description: 97) IDENT (generic) 97 none RESP_IDENT 0.5 sec (none) Returns t he RCL device type as a stri ng, which determi nes what it responds to. All RCL devices should implement t his comma nd. defined so far are ``S2-RT'', ``S2-PT'', a nd ``S2-DAS'' for t he S2 Da Sy stem. To ob tain ad ditional inf o r mation fro m S2-RTs and S2 STATION_INFO_READ a nd TRANSPORT_TIMES comma nds.

comma nd set Device ty pes ta Acquisition -PTs us e the

Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

98)

PING (generic) 98 none RESP_ERR [ERR_NONE] 0.5 sec (none) Performs no action, just returns an ``ERR_NONE'' response. All RCL devices should implement t his command. PING is useful for polli ng a device to test if it is alive or to tell when it comes up. Unlike most other commands, PING is not subject to automatic communications retries within the RCL interface libra ry (rcl_ping()), so response will be quick even if t he device is currently dead. VERSION (generic) 99 none RESP_VERSION 0.5 sec version Returns ROS (Recorder Operating Sy stem) softwa re version i nformation as a string, includi ng the version number, CPU ty pe, and compilation date/time. Example response: 3.0d [133] (compiled Fri May 16 12:59:08 EDT 1997) See also RESP_VERSION.

Command: Msg Code: Data: Expected Resp: Timer Duration: Eq Console Cmd: Description:

99)

A - 31


S2-RT User's Manual

APPENDIX A

Responses 100) Response: RESP_ERR (generic) Msg Code: 100 Data: byte1: 8-bit signed 2's complement error code (see description). (total data bytes = 1) Description: Response code RESP_ERR is returned any time a request cannot be completed. The data portion of this response contai ns a n error code byte which can be t ranslated i nto a descriptive error message using t he ERROR_DECODE comma nd. Requests which complete successfully and don't need to return any additional information (e.g. PLAY) respond with RESP_ERR error code ERR_NONE. T hose successful requests which provide specific information return the appropriate response packet (e.g. the TIME_READ comma nd returns RESP_TIME packet). ROS error codes and messages a re shown below. Note t hat error codes a re negative decimal numbers, encoded as 8-bit 2's complement i ntegers. T his list is subject to cha nge at any time, typically for t he purpose of adding new error codes. All efforts will be made to avoid changing existing error code numbers, but such changes cannot be ruled out. The mnemonics a re unlikely to cha nge. If possible, user software should not rely on the numeric error codes, but use t he error mnemonic instead. To i nterpret a n error code, user software should decode it using ERROR_DECODE, a nd then take action based on the error mnemonic (a stri ng of the form ERR_*). T he mnemonic appears at t he sta rt of the error message and can be ext racted by readi ng all characters up to but not i ncluding t he first colon. The message which follows can be written to t he screen or recorded in a log file.

ROS Error Return Codes
0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -1 0 -11 -1 2 -1 3 -1 4 -1 5 -1 6 -1 7 -1 8 -2 4 -2 5 -2 6 ERR_ NONE ERR_OPFAIL ERR_ ILCMD ERR_NUNIQ ERR_BADPARM ERR_BADL EN ERR_BADVAL ERR_TIM EOUT ERR_CHKSUM ERR_DPTOOSOON ERR_DPNOTHI ERR_BADFORM ERR_VXIO ERR_ VX SY S ERR_ DEVNP ERR_ ILMODE ERR_ILCONFIG ERR_TOLEXCD ERR_MISSIG ERR_NOTIMP ERR_H WCONFIG ERR_ CNTLC No erro r has oc curred Ope ration faile d (no n-specific erro r) Unre cogniz ed co mmand Non-unique ite ms Inco rrect pa rameter format Inco rrect or ille ga l length Value is ille ga l or out of ra nge Ope ration time d out Che cksum was bad Xilinx D/P pin went high to o soon Xili nx D/ P pin did no t go high Bad format encountere d in opera tio n Vx Work s I/ O error Vx Work s sy stem error Require d de vice no t prese nt Recorder mode is illegal for re queste d opera tio n Recorder configura tio n is illegal for re queste d opera tio n Me asurement erro r to le rance exceeded Ope ration encountere d misse d DRD signa ture s Ope ration not yet implemente d Not po s sible with this hardware configura tio n Ope rati on inte rrupted by cnt l-C
(continued on nex t page)

A - 32


S2-RT User's Manual

APPENDIX A

ROS Error Return Codes
-2 8 -2 9 -3 0 -3 1 -3 2 -3 3 -3 4 -3 5 -3 6 -3 7 -3 8 -3 9 -4 0 -4 1 -4 2 -4 3 -4 4 -4 5 -4 6 -4 7 -4 8 -4 9 -5 0 -5 1 -5 2 -5 3 -5 4 -5 5 -5 6 -5 7 -5 8 -5 9 -6 0 -6 1 -6 2 -6 3 -9 0 -9 1 -9 2 -9 3 -9 4 -10 1 -10 4 -10 5 -10 6 ERR_ILS ETUP ERR_INSETUP ERR_ILS TATE ERR_NOPBAUX ERR_CHIDMISS ERR_ CHIDDUP ERR_ BADCRC ERR_DRNOTINIT ERR_MK 3SY NC ERR_LOGBADLEN ERR_ LOGCLOSED ERR_NOU1HZ ERR_ ECHOOFF ERR_ NOALIGN ERR_ INPBA UX ERR_CURSWIN ERR_ BOTEOT ERR_ALBADTIME ERR_ALCRSBOUND ERR_ ILF NAM E ERR_ DELNONZER ERR_RPMONPRMT ERR_ BADGROUP ERR_OPINPROG ERR_ TRANL KFA IL ERR_TRANNOSEL ERR_ TRANBADSEL ERR_ ILAU TORP ERR_ INSTATE ERR_SCPLLBADMODE ERR_ NOTAUTORP ERR_ DRDBADRTPT ERR_ WRITEPROT ERR_ALS L E WMANY ERR_EOD ERR_SELF1INPROG ERR_TCPUNEX ERR_TCPBADLEN ERR_ TCPTIMEOUT ERR_ TCPDEA D ERR_ TCPOFF ERR_TCPOPFAIL ERR_TCPILCM D ERR_TCPNOTIMP ERR_TCPILSTATE

(continued)

Recorder setup is ille ga l for reque sted ope ration Recorder setup is inconsistent across se lecte d tra nspo rts Recorder state is invalid for reque sted ope ration Could no t de code pla yback aux iliary da ta Tape with required cha nnel ID is missing Two ta pe s have the same channe l ID! Ope rati on faile d due to bad CRC DR configura tio n is not initialize d Mk 3 fra me sync erro r Lo g file full, logging aborted Lo g file is close d User 1 Hz sync signal not pre sent Intera ctiv e comma nd echo ing must not be turned off Tape s playing but no t aligne d Tape s have inconsiste nt aux data Error returned by curses windowing ro utine s Enco untere d be ginning/e nd of tape (BOT/EO T) Tape -alignment target time is out of range Tape alignm ent crossed re cordi ng boundary Ille ga l file name (max. le ngth 6-dot-3, alphanum only) Sta tio n de lay is non-ze ro, must be zero for this ope ration Ope ration preempte d due to rpmon state change Transpo rt is no t pa rt of current gro up Reque sted ope rati on is alre ady in progress Transpo rt se rv o failed to lock No transpo rts selecte d Transpo rt se lection incorre ct for current mode & gro up Ope ration not allowed during automatic re cord/play Recorder state is inconsistent or ille ga l Sy stem-clock PLL is set to the wrong mo de Ope rati on valid only duri ng auto mati c reco rd/pla y Inv alid address/combina tio n of DRD board(s) Software write-protect is on, canno t re cord (e dit defaults & reboot) Too many slewing itera tio ns performed -- che ck transpo rts Enco untere d end of data (EOD) Ope ration not allowed while se lf-test1 in pro gre ss Une xpecte d response co de fro m tra nsport(s) Wrong returne d pa cke t lengt h from transpo rt(s) Transpo rt re ad atte mpt tim ed out One or more transports are dead One or more transports are off Transpo rt co mm and faile d (no n-specific erro r) Command no t re cogniz ed by transport (s)?! Command no t yet imple me nted by tra nspo rt(s) Transpo rt(s) in ille ga l sta te for this opera tio n
(continued on nex t page)

A - 33


S2-RT User's Manual

APPENDIX A

ROS Error Return Codes
-110 -111 ERR_ TCPPGCHK SUM ERR_TCPPGFORMAT

(continued)

Transpo rt re po rte d check sum error in program mode Transpo rt re po rte d format error in program mode

108)

Response: RESP_STATE Msg Code: 108 Data: byte1: recorder state code, one of: 0x01 RSTATE_PLAY 0x02 RSTATE_RECORD 0x03 RSTATE_REWIND 0x04 RSTATE_FF 0x05 RSTATE_STOP 0x06 RSTATE_PPAUSE (play-pause) 0x07 RSTATE_RPAUSE (record-pause) 0x08 RSTATE_CUE 0x09 RSTATE_REVIEW 0x0A RSTATE_NOTAPE 0x0B RSTATE_POSITION (total data bytes = 1) Description: Indicates the current recorder state, which describes t he S2's status with respect to tape motion. Not to be confused with t he STATUS response. Response: RESP_SPEED Msg Code: 110 Data: byte1: Speed code, one of: 0x00 SP 0x01 LP 0x02 SLP 0xFF unknown (total data bytes = 1) Description: Indicates tra nsport record or playback tape speed. Response: RESP_TIME Msg Code: 113 Data: byte1, byte2: Absolute year number, byte1 = MSB byte3, byte4: Day number (1 to 365/366), byte3 = MSB byte5: Hours (0 to 23) byte6: Minutes (0 to 59) byte7: Seconds (0 to 59) byte8: Time validated flag 0x00 time not validated/set 0x01 time set (total data bytes = 8) Description: Sy stem or tape time and time validated flag (see TIME_READ, TIME_READ_PB commands). Response: RESP_MODE Msg Code: 116 Data: byte1 ... : Mode designator i n t he form of an ASCII string termi nated by a NULL (0) character, maximum 20 characters (not incl. NULL). (total data bytes = length of stri ng + 1, max. 21) Description: Recorder mode designator (see MODE_SET, MODE_READ comma nds).

110)

113)

116)

A - 34


S2-RT User's Manual

APPENDIX A

118)

Response: RESP_TAPEID Msg Code: 118 Data: byte1 ... : ASCII Tape ID string terminated by a NULL (0) cha racter, maximum 20 characters (not incl. NULL). (total data bytes = length of stri ng + 1, max. 21) Description: Tape ID value (see TAPEID_SET, TAPEID_READ, TAPEID_READ_PB commands). Response: RESP_USER_INFO Msg Code: 121 Data: byte1 ... : ASCII i nfo field or label string termi nated by a NULL (0) character, maximum sizes (not incl. NULL) as follows: Field 1: 16 chars Field 2: 16 chars Field 3: 32 chars Field 4: 48 chars Label 1-4: 16 chars (total data bytes = length of stri ng + 1, max. 49) Description: U s e r i n fo fi e l d or l a be l (s e e U S E R_IN F O _ S E T, U S E R_IN F O _RE A D , USER_INFO_READ_PB comma nds). Response: RESP_USER_DV Msg Code: 124 Data: byte1: Boolean value, 0x00 Record/playback user data-valid FALSE 0x01 Record/playback user data-valid TRUE byte2: Boolean value (always 0 for USER_DV_READ_PB), 0x00 User data-valid flag ignored at playback 0x01 User data-valid flag recognized at play back (total data bytes = 2) Description: See USER_DV_READ a nd USER_DV_READ_PB comma nds. Response: RESP_GROUP Msg Code: 127 Data: byte1: Tra nsport group number (0­7) byte2: Number of valid groups i n current mode (1­8) (total data bytes = 2) Description: See GROUP_READ comma nd. Response: RESP_TAPEINFO Msg Code: 128 Data: byte1 ... byte416: Table of information values for 8 tapes, with 52 bytes (= 1 row) per tape. For each tape (row of the table) t he following i nformation is given: rbyte1: address of transport containing tape, ra nge 0­7 (numbers will be consecutive) rbyte2: channel ID (S2 i nternal channel number) of the tape's data, ra nge 0­7. Equivalent to t he transport address used at record time. If auxiliary data could not be ext racted for this tape the cha nnel ID will be 0xFF a nd all followi ng fields (except possibly play back tape time) will contain zeroes. rbyte3 ... rbyte23: 20-cha racter tape ID stri ng, termi nated by a null for 21 bytes total. Tape IDs shorter t ha n 20 cha racters will leave t raili ng bytes unused (set to null) but will still occupy 21 by tes total.

121)

124)

127)

128)

A - 35


S2-RT User's Manual

APPENDIX A

rbyte24 ... rby te33: 9-cha racter recorder mode stri ng, termi nated by a for 10 bytes total. Indicates what mode was in effect when the tape was rded. Modes shorter tha n 9 cha racters will leave t raili ng by tes unused to null) but will still occupy 10 bytes total. In the rare case of a n illemode at record time t he mode string will be empty. rbyte34 ... rby te41: Playback tape time, 8 bytes total as follows (may be present even if channel ID is 0xFF): rbyte34, rby te35: Absolute year number (1901 to 2099), rby te34 = MSB. A year value of 0 indicates time could not be extracted from aux data (remai ning time by tes will be 0). rbyte36, rby te37: Day number (1 to 365/366), rbyte36 = MSB rbyte38: Hours (0 to 23) rbyte39: Minutes (0 to 59) rbyte40: Seconds (0 to 59) rbyte41: Frames (0 to 63, each frame is 1/64t h of a second) rbyte42 ... rby te44: Record start time, 3 bytes total as follows: rbyte42: Hours (0 to 23) rbyte43: Minutes (0 to 59) rbyte44: Seconds (0 to 59) rbyte45, rby te46: Record S2 serial number (0 to 65535, 0 = undefi ned), rbyte45 = MSB rbyte47, rby te48: Record t ra nsport serial number (1 to 65535), rbyte47 = MSB rbyte49 ... rby te52: 32-bit signed 2's complement measured record station delay value in na noseconds, rbyte49 = MSB. Ra nge: -500000000 to +(500000000-1bit), or 0x7FFFFFFF if unknown (no 1 Hz input). (total data bytes = 416) Description: Gives tape-related i nformation duri ng playback for each of the 8 i ndividual transports. See the TAPEINFO_READ_PB command for furt her description. null reco (set gal 130) Response: RESP_DELAY Msg Code: 130 Data: byte1 ... byte4: 32-bit signed 2's complement delay value i n nanoseconds, byte1 = MSB. Ra nge: -500000000 to +(500000000-1bit) (total data bytes = 4) Description: See DELAY_SET/DELAY_READ/DELAYM_READ. Response: RESP_BARRELROLL Msg Code: 133 Data: byte1: Boolean value, 0x00 Ba rrel roll is OFF 0x00 Ba rrel roll is ON (total data bytes = 1) Description: See BARRELROLL_READ command. Response: RESP_POSITION Msg Code: 136 Data: byte1: type of response, 0x00 overall (mid-point) position a nd li near varia nce byte2 ... byte5: overall absolute position as a 32-bit signed integer number of seconds since BOT (MSB first, range -99­43199, -0x80000000 if unknown)

133)

136)

A - 36


S2-RT User's Manual

APPENDIX A

byte6 ... byte9: li near varia nce as a 32-bit signed integer number of seconds (MSB first, range 0­43199, -0x80000000 if unknown) 0x01 i ndividual t ra nsport positions byte2: number of positions being returned (normally 8) byte3 ... byte34: List of positions. For each t ra nsport t here is a 32-bit signed integer representing t he absolute position in seconds since BOT (MSB fi rst, range -99­43199, -0x80000000 if unknown, 0x7FFFFFFF if t ra nsport not selected) (total data bytes = 9 (overall), 34 (individual)) Description: T his is the response to t he POSITION_READ command. There are two formats as indicated by t he first data by te: ``overall'' position, or ``individual'' positions. See also POSITION_READ, POSITION_SET, ALIGN. 138) Response: RESP_ESTERR Msg Code: 138 Data: byte1: number of strings i n list (always 8 depending on recorder mode if ordere byte2 ...: list of up to 8 variable-length next string following immediately. Each (total data bytes = va riable, max. 97) Description: See ESTERR_READ command. Response: RESP_PDV Msg Code: 139 Data: byte1: number of strings i n list (always 8 depending on recorder mode if ordere byte2 ...: list of up to 8 variable-length next string following immediately. Each (total data bytes = va riable, max. 97) Description: See PDV_READ command.

8 if ordered by t ransport, 1, 2, 4, or d by cha nnel) stri ngs, each termi nated by null, wit h stri ng max. 12 bytes (i ncl. null).

139)

8 if ordered by t ransport, 1, 2, 4, or d by cha nnel) stri ngs, each termi nated by null, wit h stri ng max. 12 bytes (i ncl. null).

143)

Response: RESP_SCPLL_MODE Msg Code: 143 Data: byte1: SC PLL mode code 0x00 xtal 0x01 manual 0x02 refclk 0x03 1hz 0x04 errmes (total data bytes = 1) Description: Indicates the current Sy stem Clock PLL mode. Response: RESP_TAPETYPE Msg Code: 145 Data: byte1 ... : ASCII tape type string terminated by a NULL (0) character, maximum 6 characters (not incl. NULL). Note that all normal tape ty pe codes are one cha racter lo ng (0­9 or A­Z) but ``unlisted'' tape ty pes a re six digits long of the form NNNMMM where NNN is the write current for LP a nd MMM is t he write current for SLP. (total data bytes = length of stri ng + 1, max. 7) Description: Indicates the current tape type setting. Response: RESP_MK3_FORM

145)

151)

A - 37


S2-RT User's Manual

APPENDIX A

Msg Code: 151 Data: byte1: Boolean value, 0x00 Mark III formatter disabled 0x01 Mark III formatter enabled (total data bytes = 1) Description: Indicates whether the S2's internal Mark III format generator is turned on or off. See also MK3_FORM_SET, MK3_FORM_READ. 155) Response: RESP_TRANSPORT_TIMES Msg Code: 155 Data: byte1: number of t ra nsports i ncluded in list (always 8). byte2 ...: Table of t ransport times corresponding to tra nsports 0 t hrough 7 respectively. The set of times for each t ra nsport consists of 18 bytes and i ncludes one 16-bit unsigned integer a nd four 32-bit unsigned i ntegers as follows: byte1 ... byte2: 16-bit unsigned transport serial number. A value of zero i ndicates the tra nsport is dead or off or t he serial number is unknown. byte3 ... byte6: 32-bit unsigned total on-time since ma nufacture in minutes. A value of zero indicates unknown. byte7 ... byte10: 32-bit unsigned total head-use time i n minutes since manufacture. A value of zero indicates unknown. byte11 ... by te14: 32-bit unsigned active head use time in mi nutes since t he last head replacement. A value of zero indicates unknown. byte15 ... byte18: 32-bit unsigned active head use time i n minutes since t he last service operation. A value of zero indicates unknown. (total data bytes = 145) Description: Response from TRANSPORT_TIMES command. Response: RESP_STATION_INFO Msg Code: 160 Data: byte1: Station number, 0 to 255 byte2, byte3: System serial number (0 to 65535), by te2 = MSB byte4 ... : ASCII nickname string terminated by a NULL (0) cha racter, maximum 8 cha racters (not i ncl. NULL). (total data bytes = length of stri ng + 4, max. 12) Description: Provides i nformation which identifies the S2 sy stem. Response: RESP_POSTIME Msg Code: 171 Data: byte1, byte2: Absolute year number, byte1 = MSB byte3, byte4: Day number (1 to 365/366), byte3 = MSB byte5: Hours (0 to 23) byte6: Minutes (0 to 59) byte7: Seconds (0 to 59) byte8: Frame number (0 to 63) byte9 ... byte12: absolute tape position as a 32-bit signed integer number of seconds since BOT (MSB first, range -99­43199, -0x80000000 if unknown) (total data bytes = 12) Description: Response from POSTIME_READ comma nd. Includes play back tape time and tape position of a pa rticula r t ra nsport. Response: RESP_STATUS (generic) Msg Code: 180

160)

171)

180)

A - 38


S2-RT User's Manual

APPENDIX A

Data: byte1: Summa ry byte, bit0: 1 = one or more error conditions i n report (always set if bit 1 is set) 0 = no error conditions in report bit1: 1 = one or more fatal error conditions i n report, recommend abort current operation 0 = no fatal error conditions in report bit2: 1 = one or more clear-on-read conditions in report 0 = no clear-on-read conditions i n report bit3 ... 7: reserved byte2: Number of status entries (max. 32) byte3 ... : List of status ent ries. For each ent ry there a re 2 bytes, as follows: 1st byte: Status code number from 1 to 127 (RCL_STATCODE_MAX), as defi ned i n table below. 2nd byte: Status type, bit0: 1 = error condition (``E'' i n table), 0 = non-error condition (always set if bit 1 is set) bit1: 1 = fatal error condition (``F'' in table), 0 = non-fatal condition bit2: 1 = clear-on-read condition (``C'' i n table), 0 = non-clear-on-read. bit3 ... 7: reserved (total data bytes = # of status ent ries * 2 + 2, max. 130) Description: Brief status report from t he STATUS comma nd. T his lists t he currently active S2 status conditions by t heir numeric codes. To obtain additional information such as text messages you should send a STATUS_DETAIL RCL comma nd. T here are 3 ty pes of status codes: informational, error, a nd fatal error. Each of t hese may additionally be designated clear-on-read, which means t hey a re automatically cleared immediately followi ng the status request. Conditions of a ny type which appear a nd disappear between status requests a re not lost; t hey a re latched until the next status request. Status should be read regula rly (every 1 to 5 seconds) to ensure that information is up to date. T he status summary byte i ndicates whether any errors or fatal errors exist. Overall system status can be considered ``OK'' if the summary error bit is clear, ``cautiona ry'' if t he error bit is set but t he fatal-error bit is clear, a nd ``failed'' if the fatal-error bit is set (fatal errors imply t hat t he error bit is set too). If any fatal error conditions appear at any time (includi ng clearon-read conditions), t here is a good chance t hat t he system is not operati ng correctly, and immediate corrective action should be taken. Note t hat the S2 will not automatically abort a ny operation, even i n t he presence of fatal errors, unless t here is no possible way to continue or there is imminent danger of ha rdwa re damage. Status codes, mnemonics, and messages a re given i n the table below. Code numbers ra nge from 1 to 127 (RCL_STATCODE_MAX). T he text message shown is t he ``long'' (RCL) version of t he status message as would be returned by STATUS_DETAIL (or STATUS_DECODE) without the `short' option. For a list of the short (console) messages see Section 4.5 of the User's Manual. T his information is subject to change at a ny time, ty pically for the purpose of addi ng new status ent ries. All efforts will be made to avoid cha ngi ng existi ng status code numbers, but such changes cannot be ruled out, especially since status codes are ranked by priority a nd some renumberi ng may be necessary when new codes are added. T he m nemonics are unlikely to change. If possible, user software should not rely on the numeric status codes, but use t he status mnemonic i nstead. To interpret a status code, user software should decode it using STATUS_DETAIL or STATUS_DECODE, a nd then take action based on the m nemonic (a string of t he form STAT_*). T he mnemonic appears at the start of t he status message a nd can be ex-

A - 39


S2-RT User's Manual

APPENDIX A

t racted by readi ng all cha racters up to but not includi ng the first colon. T he message which follows can be written to the screen or recorded in a log file. To avoid havi ng to issue ext ra RCL comma nds whenever testing status code m nemonics, user softwa re should build a t ranslation table i n adva nce using repeated calls to STATUS_DECODE.

Status Response Codes (``E'' indicates error, ``F'' indicates fatal error, ``C'' indicates clear-on-read)
1 2 3 4 5 6 7 8 9 11 12 13 15 16 17 18 19 20 22 S TAT_DIAGIP S TAT_DI AGDONE S TAT_DI AGFA IL STAT_VME P O WFAIL S TAT_NOF ORM S TAT_NODRD S TAT_NOUIC S TAT_FORMFAIL STAT_DRDFAIL S TAT_UI CFAI L S TAT_TRANFA IL S TAT_ROS S WFAIL STAT_SRAMCHKSUM S TAT_NOS RSY R S TAT_NOF G1 S TAT_TA SKFAIL S TAT_TRANSWFAIL S TAT_TRANTPMO TFAIL S TAT_TRANBADTEMP ----C EFC EFEF EFEFEFEFEFEFEFEFEFEF EFEFEFC EFDiagno stic te st 'xxx' is in progress. Di agno stic te st co mple ted succe ss fully. Di agno stic te st failed, dia g/e rror code xxx: xxx VME xxx po wer supply volta ge out of ra nge. Form atter bo ard marke d no t pre sent . DRD xxx ma rked not pre sent. UI board ma rked not pre sent. Form atter bo ard fail ure (re ason foll ows). DRDx xx failure (reason follo ws). UI board failure (re aso n follows). Transport xxx failure (reason follo ws). ROS software failure (re ason follows). S RAM board ba d checksum for pa rtition xxx. S yste m inte rna l 64 Hz fra me sync (SRSY R) is absent ! S yste m inte rna l 1 Hz tick (FG1) is absent ! Foll owing requi red softw are task s are not running: xxx Transport xxx software failure: xxx Tra nsport xxx ta pe motion sa nit y che ck failed Transport xxx internal te mpe rature is too high or too lo w for safe ope ration. Transpo rt has shut down. Warning: Tra nspo rt xxx inte rna l tempera ture is almo st too high or too lo w for safe ope ration, will shut down abo ve 60/ be low 5 de g C (check TAM fans and filters). Re quire d transpo rts xxx are off or dead. Transport xxx +5V/-5V supply is ba d (che ck C4 cable). Tra nsport xxx reco rd clk/ da ta is bad (check C3 cable ). Re corder mo de is illegal, probably due to error during last mode change . Use r re fere nce high-rate clock (x xx) is abse nt. Use r re fere nce xxx sy nc is absent . S tation delay measure ment does not match setting. UI verifie r sho ws failure condit ion. In c1te st mode , this indicates C1 ca ble co nnectio n fault . 1 Hz sync erro r has occurre d. Ne sted frame interrupt has oc curred. Late frame inte rrupt has occurre d. S yste m-clock PLL is se t to the wro ng mode (curre nt ly 'x xx', should be 'xxx'). S yste m-clock PLL is unlocked. S yste m-clock PLL sy nc error ha s occurre d. DRDx xx one or more missed/e xtra signatures de tecte d. Formatter da ta -FIFO timing erro r has occurre d.
(continued on nex t page)

23 24 25 26 27 28 29 32 33 34 35 36 37 38 39 40 41

S TAT_TRANWARNTEMP S TAT_TRANDEAD S TAT_TRANBADVOLT S TAT_TRANBADRE CSIG S TAT_ILM ODE S TAT_NOREFCLK S TAT_NORE F1HZ S TAT_B ADSTNDE LAY S TAT_UICVERFAIL S TAT_SYNCERR1HZ S TAT_NE STFRI N T STAT_L ATEFRINT S TAT_S CPLL BADMODE S TAT_S CPLL UNLOCK S TAT_SCPLL SLIP STAT_DRDMISSIG S TAT_F ORMDFIFOTE RR

E-EFEFEFEF EFEFE-E-C E-C E-C E-C E-EF E-C E-C E-C

A - 40


S2-RT User's Manual

APPENDIX A

(continued) Status Response Codes (``E'' indicates error, ``F'' indicates fatal error, ``C'' indicates clear-on-read)

42 43 44 45 46 47 48 49 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 81 84 85 89 92 93 94

S TAT_MK3 PLLSLIP S TAT_MK3 MISSY NC S TAT_MK3DFIFO TERR S TAT_TRANSYNCERR32 S TAT_RE FCLK OUTL O W S TAT_ERRRCL S TAT_ERRRPMON S TAT_E RRMK 3 S W S TAT_RP MONB O TEOT S TAT_RP MONI LSTATE S TAT_TRANLKFAIL S TAT_TRANLKLOSS STAT_TRANTRK1FA IL S TAT_I LSE TUP S TAT_I NSTATE S TAT_B ADTRANS EL S TAT_CHIDDUP S TAT_A LIGNFAIL S TAT_ERRALIGN S TAT_CHI DMI SS S TAT_BADGROUP S TAT_CHIDMISMATCH S TAT_NOP BAUX S TAT_B ADPBTRANSEL S TAT_I N TAPEID S TAT_B ADPBE STERR S TAT_RE CBADSY NC S TAT_RE CBADAUX S TAT_RE CBADCHID S TAT_B ADAGCL EV S TAT_MARGA GCLEV S TAT_E RRLOG S TAT_ERRDRCONFIG S TAT_ERRDRTRACK S TAT_DE LAYFIX S TAT_NOALIGN S TAT_ALIGNIP S TAT_A LIGNDONE S TAT_TA PESY NCERR S TAT_SCPLLDACRAIL S TAT_SCPLL ACCRAIL S TAT_DRTAPRA IL

E-C E-C E-C E-C EFEFC EFC EF C EF C EF C EFE-C EFE-EFEFEFEFE-C EFEFE-E-EFE-E-EFEFEFEF--E-C E-C E-C --C E-----C E-C -------

Mk3 PLL sync erro r has occurre d. Mk3 sync-de tect miss ha s occurred. Mk3 da ta -FIFO tim ing erro r has occurre d. Transport (s) xxx ha ve had 32 Hz sy nc errors. C2 output re f clock ra te is too lo w for current mo de . RCL error xxx: xxx Re cord /Pla yba ck mo nitor erro r xxx: xxx Mk3 forma tte r so ftware erro r xxx: xxx Encount ere d xxx during auto matic xxx (transpo rt xxx). All tapes ha ve been sto pped. E ncount ere d unexpe cted transport sta te cha nge during aut omatic xxx (sta te : xxx). Tra nsport xxx he ad-drum serv o faile d to lo ck. Transport xxx serv o lo st lo ck or gl itche d momenta rily. Transport xxx stuck in phase-1 tracking ca libration. B ad setup: xxx Tape motion sta te is inco nsiste nt or ill egal. Transport selectio n is incorre ct for current mo de & group. Tra nsport xxx and xxx tapes bo th ha ve the sa me channe l ID (x xx). Tapes are probably from different ta pe sets. Unable to align ta pe s, fata l error xxx: xxx E rror aligning tapes, code xxx: xxx\n Try ing alignme nt aga in. Tape with channe l ID xxx is mi ssing. xxxxxxxxx is not pa rt of curre nt gro up. xxx cha nnel ID do es no t match current setup. Ca n't deco de xxx fro m tra nspo rt xxx. Ca n't switch to require d playba ck mode xxx, wrong # of tra nspo rts se lecte d. Tra nsport s xxx and xxx have differe nt ta pe IDs. Transport xxx estima te d erro r ra te gre ater tha n xxx. Transport xxx reco rd da ta ha s bad sy nc. Transport xxx reco rd da ta ha s bad aux iliary data. Tra nsport xxx reco rd da ta ha s wro ng cha nnel ID. Transport xxx AGC levels are ou tside acceptable range . Transport xxx AGC levels are ma rgina l but still within acceptable ra ng e. Log file error xxx: xxx E rror xxx in DRDx xx data-re covery co nfig: xxx Error xxx in tran xxx DR track ing calibration: xxx S tation delay aut o resets: xxx Tape s playing but not aligne d (pla yba ck da ta no t valid). Tape alignm ent opera tio n in pro gre s s. Tape alignment opera tio n comple te d successfully. Tape -tim e sy nc error ha s occurre d. S yste m clo ck PLL DAC at or near ra il value. S yste m clo ck PLL ac cumula to r at or near ra il value. DRDx xx data -reco very ta ps at or ne ar rail value [xxx].
(continued on nex t page)

A - 41


S2-RT User's Manual

APPENDIX A

(continued) Status Response Codes (``E'' indicates error, ``F'' indicates fatal error, ``C'' indicates clear-on-read)

95 96 97 98 99

S TAT_DRE QSETRAIL S TAT_DRFSETRA IL S TAT_TRANDIEDB ORN STAT_TRANPKTRETRY S TAT_DRFSETFADJ

----E-C --C --C

DRDx xx data -reco very EqSe t at or ne ar rail value . DRDx xx data -reco very FSet at or near ra il value. Tra nsport s di ed/bo rn (x xx/x xx) Transport packet retries (xxx) DRDx xx data -reco very fine FSet adjustme nts (x xx)

181)

Response: RESP_STATUS_DETAIL (generic) Msg Code: 181 Data: byte1: Summa ry byte, bit0: 1 = one or more error conditions i n report (always set if bit 1 is set) 0 = no error conditions in report bit1: 1 = one or more fatal error conditions i n report, recommend abort current operation 0 = no fatal error conditions in report bit2: 1 = one or more clear-on-read conditions in report 0 = no clear-on-read conditions i n report bit3 ... 7: reserved byte2: Number of status entries (max. 32) byte3 ... : List of status ent ries. For each ent ry there a re 2 bytes followed by a va riable-lengt h string, as follows: byte1: Status code number from 1 to 127 (RCL_STATCODE_MAX). byte2: Status type, bit0: 1 = error condition (``E'' i n table), 0 = non-error condition (always set if bit 1 is set) bit1: 1 = fatal error condition (``F'' in table), 0 = non-fatal condition bit2: 1 = clear-on-read condition (``C'' i n table), 0 = non-clear-on-read. bit3 ... 7: reserved byte3 ... : Status message i n the form of a n ASCII stri ng terminated by a NULL (0) cha racter, maximum 399 cha rs (not incl. NULL, may contain ``\n'' to i ndicate line breaks), or maximum 34 chars with ``short'' option. (total data bytes = va riable, max. 2000) Description: Returns a detailed status description. This is like RESP_STATUS, but includes a text message for each status entry. Unlike RESP_STATUS_DECODE, t his message may include information specific to this particular occurrence of t he status condition, such as a list of affected t ra nsports or a n error code. If the ``short'' option was used in the comma nd, all messages are shortened to a single li ne of max. 34 cha racters (not i ncl. NULL). See RESP_STATUS response a nd STATUS_DETAIL comma nd for more information. Response: RESP_STATUS_DECODE (generic) Msg Code: 182

182)

A - 42


S2-RT User's Manual

APPENDIX A

Data: byte1 ... : Status message in t he form of an ASCII stri ng terminated by a NULL (0) cha racter, maximum 399 cha racters (not incl. NULL), or max 34 characters for ``short'' option. Occurrence-specific string substitution i nformation is marked by ``xxx''. May contai n ``\n'' to i ndicate line breaks (long version only ). (total data bytes = length of stri ng + 1, max. 400 (35 with short option)) Description: Returns a message describing a status code. For currently active status codes, STATUS_DETAIL should be used instead since it gives more specific i nformation. 183) Response: RESP_ERROR_DECODE (generic) Msg Code: 183 Data: byte1 ... : Error message in t he form of a n ASCII string termi nated by a NULL (0) cha racter, maximum 100 cha racters (not i ncl. NULL). (total data bytes = length of stri ng + 1, max. 101) Description: Returns a message describing a n error code. Response: RESP_BERDCB Msg Code: 191 Data: byte1 ... byte4: Number of incorrect bits during the measurement interval i n t he case of FORM BER a nd UI BER, or number of 1-bits in the case of UI DC-bias. T his is a 32-bit unsigned i nteger value (MSB fi rst). byte5 ... byte8: Total number of bits measured i n t he time i nterval as a 32-bit unsigned integer (MSB first). (total data bytes = 8) Description: Gives t he results of a measurement performed by t he BERDCB command. To calculate the bit-error rate or t he DC-bias ratio, divide t he first 32-bit i nteger by t he second 32-bit integer. Response: RESP_DATA_EXTRACT Msg Code: 192 Data: byte1 ... byte3: Extracted data or validity bytes. byte4: Parity i nformation for MkIII data extract only, where bit value 0 means NO parity error, value 1 means that a parity error occurred. bit 0: parity bit for by te1 bit 1: parity bit for by te2 bit 2: parity bit for by te3 For S2 data/validity ext ract by te4 is always 0. (total data bytes = 4) Description: Returns three by tes of extracted data or validity from a DATA_EXTRACT_READ command. A fourt h byte gives the pa rity bit for each of t he three data bytes in its lowest three bits (Mark III data extract only). The time ordering of the extracted data or validity bits is from t he most-significant bit of byte1 (bit 7), to t he leastsignificant bit of byte1 (bit 0), followed by t he most-significant bit of byte2 (bit 7), to the least-significant bit of byte2 (bit 0), followed by the most-significant bit of by te3 (bit 7), to t he least-significant bit of by te3 (bit 0). Response: RESP_IDENT (generic) Msg Code: 197 Data: byte1 ... : RCL device type identifier string terminated by a NULL (0) cha racter, maximum 10 cha racters (not i ncl. NULL). (total data bytes = length of stri ng + 1, max. 11) Description: Gives the RCL device type, which determines what set of commands it responds to (see the IDENT comma nd).

191)

192)

197)

A - 43


S2-RT User's Manual

APPENDIX A

199)

Response: RESP_VERSION (generic) Msg Code: 199 Data: byte1 ... : ROS software version information string, terminated by a NULL (0) cha racter, maximum 60 cha racters (not i ncl. NULL). (total data bytes = length of stri ng + 1, max. 61) Description: Gives ROS softwa re version i nformation. Includes CPU type i n square brackets. Example stri ng: 3.0d [162] (compiled Fri May 16 12:51:58 EDT 1997) See the description of t he VERSION comma nd for more i nformation.

A - 44


S2-RT User's Manual

APPENDIX B

S2 SIGNAL AND CONTROL I NTE RFACE SPE CIFICATI ONS

B.1 Overview
T his appendix describes the physical, electrical, and timi ng cha racteristics of t he signal and control cables connecti ng t he S2 record a nd playback sy stem to t he user's ha rdwa re.

B.1.1 S2 Signal Interface
T he S2 record a nd playback signal interface consists of up to four cables connecting to ports on the UI board: 1. C1: Input user data on 16 signal lines, i nput clock and 1Hz. 2. C2a: Output user data on 16 signal lines, output clock and 1Hz; a nd (optional) i nput clock and 1Hz for play back timing cont rol. 3. C2b: 8 signals of output data validity representi ng t he even user data cha nnels (0,2,4,6,8,10,12,14) in modes wit h 1-bit quantization or pairs of user cha nnels in modes with 2-bit quantization. In the case of 2-bit qua ntization, each signal represents combined data validity for bot h sign a nd amplitude cha nnels of the same and next higher channel number, e.g. DV OUT 4 contai ns combined data validity for bot h user data channels 4 a nd 5. 4. C2c: 8 signals of output data validity representi ng the odd user channels (1,3,5,7,9,11,13,15) i n modes with 1-bit qua ntization. Requi red only for 1-bit modes t hat use odd user data cha nnels, which includes only S2 modes of the form bxu-1 where u is greater t ha n 1. Note t hat the C2c port is not located on t he UI board's front pa nel, i nstead it is a 20-pin header located on the PC boa rd just behind the C2b port.

B.1.2 S2 Control Interface
T he S2 control interface consists of two cables: 1. C6: RS-232C RCL serial control cable, connecti ng to a port on t he Formatter board. 2. C7: RS-232C console terminal cable, connecting to a port on t he RCC. Equivalent control connections can be made over the Et hernet port using network rlogin/telnet and socket protocols, elimi nati ng the need for serial cables (see Section 4.4).

B.2 S2 Signal Interface
B.2.1 Signal Assignments
T he i nput signal i nterface consists of a single multiconductor twisted pai r cable C1 termi nating in a connector P1 at the data source. T he C1 cable carries input data a nd clock signals as listed i n Table B-1. Table B-5 shows which of t he 16 available input data channels IN 0 through IN 15 are active in each S2 mode.

Part 2: /home/s2/doc/userman/working/txt/intface.txt x
B-1

Part 1: /home/s2/doc/userman/working/txt/appb.txt x

APPENDIX B


S2-RT User's Manual

APPENDIX B

T he output signal i nterface consists of three multiconductor twisted-pair equal-length cables C2a, C2b, a nd C2c (joi ntly designated as cable C2) termi nati ng i n connectors P2a, P2b, and P2c at t he data destination. T he C2 cable carries signals listed in Tables B-2 and B-3. Cable C2a (Table B-2) carries the output clock and 1Hz, and reproduced data, while cables C2b a nd C2c (Table B-3) carry output data-validity (DV) signals. In the S2's ``Mark III/IV compatible'' mode, t he C2a cable delivers NRZM-encoded signals compatible with Mark III/IV equipment (Table B-4). Use the mk3 form enable command to switch the C2a cable into Mark III/IV compatible mode. Table B-5 shows which of t he 16 available output data/DV cha nnels OUT 0 through OUT 15 and DV OUT 0 t hrough DV OUT 15 a re active i n each S2 mode. In Mark III/IV compatible operation the same C2a data output pins a re active, but channels 14 and 15 a re not available.

B.2.1.1 Signal Characteristics
T he timi ng of signals on cable C1 as measured at the signal destination (S2 i nput) wit h appropriate termination is shown i n Figures B-2 a nd B-3 for fixed 32 MHz clock a nd data-rate clock cases, respectively. Timing of signals on cable C2 as measured at t he signal destination (Correlator input) with appropriate termination is shown in Figures B-4, B-5, a nd B-6 for fixed 32 MHz clock, data-rate clock, a nd MkIII/IV output mode cases, respectively. Note that in the MkIII/IV output case t he phase of the generated clock (S-CLK_PB) can be selected using t he mk3 form clkinv console comma nd depending on t he requirements of the desti nation equipment.

B.2.1.2 Electrical Characteristics
All signals a re to be sourced by termi nated ECL drivers; i.e. all signals listed in Tables B-1 t hrough B-4 a re to be t ra nsmitted through C1 and C2 in both t rue a nd inverted pola rity along twisted pai rs. In the rec eiver, each twisted pair is termi nated differentially in 100 ohms as shown i n Figure B-7.

B.2.1.3 Physical Characteristics
T he C1 cable is to be Belden ty pe 9V28050 50-conductor twisted pair cable or equivalent, a nd connector P1 is to be 50-pin Scotch header part number 3433-5302; socket part number 3425-6600 wit h strai n relief clips pa rt number 3448-3050 or equivalent. T he C2a cable is to be Belden type 9V28050 50-conductor twisted pai r cable or equivalent, a nd connector P2a is to be 50-pin Scotch header part number 3433-5302; socket part number 3425-6600 with strai n relief clips pa rt number 3448-3050 or equivalent. The C2b a nd C2c cables a re to be Belden ty pe 9V28020 20-conductor twisted pai r cable or equivalent and connectors P2b a nd P2c are to be 20-pin Scotch header part number 3428-5302; socket part number 3421-6600 wit h strain relief clips pa rt number 3448-3020 or equivalent. Signal pin assignments a re shown in Table B-2. The conductors in C2 not used for signal a re to be grounded near t he signal source. T he length of the cable should not exceed 10 meters.

B.2.1.4 Input/Output Cable Connection Test Modes
In C1 and C2 test modes, cables C1 and C2 carry test data generated by t he test vector generator circuit illustrated i n Figure B-1. T he C1 test data is to be sourced by ha rdwa re resident i n the user's sy stem and should be substituted for normal record data during C1 test. The user should select S2 mode c1test16 (16 Mbit/s data over all 16 input signal

B-2


S2-RT User's Manual

APPENDIX B

lines) a nd exami ne sy stem status to ensure that message STAT_UICVERFAIL is not present. T he C1 test modes a re available at various data rates (4, 8, 16, 32 Mbits/s). T he (identical) C2 test data is substituted by the S2 for normal play back data when t he S2 mode is set to c2test16 (16 Mbit/s data over all 16 output signal li nes). T he C2 test modes are available at various data rates (4, 8, 16, 32 Mbits/s). T he test vector generator is driven by t he data rate clock a nd initialized i nternally by a signal. Table B-7 shows t he first 20 words of test vector data following a sy nchronous 1Hz period t = 0. Although the S2 supports C1 and C2 test modes at data rates of 4, 8, 16, line, normally only t he 16 Mb/s data rate test modes will be used. Figures B-2 a nd B-4 t he test vectors relative to the other signals on the C1 a nd C2 cables. (data rate widt h) 1Hz preset at sample clock and 32 Mb/s per data illustrate the timing of

B.3 S2 Control Interface
B.3.1 RCL Serial Link (C6 Cable)
T he RCL serial i nterface is sta nda rd RS-232C. The link between t he S2 and t he external control computer may be eit her RS-232C, or multi-drop RS-485 wit h t he addition of a n RS-232C to RS-485 conversion box (supplied by the user) external to the S2. Use of RS-232C requires a dedicated serial port on t he external control computer for each S2 cont rolled, while multi-drop RS-485 operation allows many S2's to be controlled from a single external cont rol computer serial port. Alternatively Internet socket connections can be used i nstead of serial cables if t he S2 is connected to a n Ethernet network. T he S2 RCL port is a male DB-25 connector configured for DTE (Data Termi nal Equipment) operation. T he baud rate is selectable at sta nda rd values between 2400 a nd 57600 baud (default 19200 baud). The maximum dista nce between the S2 and t he external cont rol computer should not exceed 15 meters. Table B-6 shows t he pin assignments for t he DB-25 connector. Note that t he RTS signal is asserted high (TRUE) just before each response message tra nsmitted by t he S2 and asserted low followi ng t he t ra nsmission. T hus t he RTS signal can be used in multi-drop RS-485 interfacing to switch on and off the RS-485 t ri-state line drivers. T he CTS, DCD a nd DTR signals a re not used.

B.3.2 RCC Console Cable (C7 Cable)
C7 is a standard RS-232C serial cable which connects to a female DB-25 connector on t he RCC configured as DCE (Data Communications Equipment). Refer to the MVME133XT User's Manual for pin assignments.

B-3


S2-RT User's Manual

APPENDIX B

PIN # 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

SIG. NAME GND GND IN 0 IN 0 IN 1 IN 1 IN 2 IN 2 IN 3 IN 3 GND GND IN 4 IN 4 IN 5 IN 5 IN 6 IN 6 IN 7 IN 7 GND GND IN 8 IN 8 IN 9

I/O

DE SCRIPTION Gro un d Gro un d

PIN # 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

SIG. NAME IN 9 IN 10 IN 10 IN 11 IN 11 GND GND IN 12 IN 12 IN 13 IN 13 IN 14 IN 14 IN 15 IN 15 GND GND SCLK_REC SCLK_REC GND GND S1HZ_REC S1HZ_REC GND GND

I/ O I I I I I

DESCRIPTION S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) Gro und Gro und

I I I I I I I I

S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Input Data (ECL) S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Input Data (ECL) S2 Inp ut Da ta (ECL) Gro un d Gro und

I I I I I I I I

S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) S2 Input Data (ECL) Gro und Gro und Input Reference Clock (ECL) Input Reference Clock (ECL) Gro und Gro und

I I I I I I I I

S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Input Data (ECL) S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Input Data (ECL) S2 Inp ut Da ta (ECL) Gro und Gro un d

I I

I I

Input 1Hz Re ference (E CL) Input 1Hz Re ference (E CL) Gro und Gro und

I I I

S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL) S2 Inp ut Da ta (ECL)

Table B-1: C1 Input Cable Signal Assignments

B-4


S2-RT User's Manual

APPENDIX B

PIN# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

SIGN AL NAME GND GND OUT 0 OUT 0 OUT 1 OUT 1 OUT 2 OUT 2 OUT 3 OUT 3 OUT 4 OUT 4 OUT 5 OUT 5 OUT 6 OUT 6 S CLK_PB S CLK_PB OUT 7 OUT 7 OUT 8 OUT 8 OUT 9 OUT 9 OUT 10 OUT 10 OUT 11 OUT 11 OUT 12 OUT 12 OUT 13 OUT 13 NC NC OUT 14 OUT 14 OUT 15 OUT 15 GND GND GND GND CCLK CCLK C1 HZ C1 HZ S 1HZ_PB S 1HZ_PB NC NC

I/O Gro und Gro und O O O O O O O O O O O O O O O O O O O O O O O O O O O O O O

DESCRI PTION

S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) Playba ck Sa mple 32 MHz Clock (ECL) Playba ck Sa mple 32 MHz Clock (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) No Co nnectio n No Co nnectio n

O O O O

S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) S2 Output Data (ECL) Gro und Gro und Gro und Gro und

I I I I O O

Co rrela to r 32 MHz Reference Clock (ECL) Co rrela to r 32 MHz Reference Clock (ECL) Co rrela to r 1Hz Refere nce (ECL) Co rrela to r 1Hz Refere nce (ECL) Playba ck 1Hz Reference (ECL) Playba ck 1Hz Reference (ECL) No Co nnectio n No Co nnectio n

Table B-2: S2 C2a Output Cable Signal Assignments

B-5


S2-RT User's Manual

APPENDIX B

PIN# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

SIGNAL NAME GND GND DV OUT 0 DV OUT 0 DV OUT 2 DV OUT 2 DV OUT 4 DV OUT 4 DV OUT 6 DV OUT 6 GND GND DV OUT 8 DV OUT 8 DV OUT 10 DV OUT 10 DV OUT 12 DV OUT 12 DV OUT 14 DV OUT 14

I/O Ground Ground O O O O O O O O

DESCRIPTION

S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) Ground Ground

O O O O O O O O

S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL) S2 Output Data Validity (ECL)

(a) C2b

PIN# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

S IGNAL NAME GND GND DV OUT 1 DV OUT 1 DV OUT 3 DV OUT 3 DV OUT 5 DV OUT 5 DV OUT 7 DV OUT 7 GND GND DV OUT 9 DV OUT 9 DV OUT 11 DV OUT 11 DV OUT 13 DV OUT 13 DV OUT 15 DV OUT 15

I/O Ground Ground O O O O O O O O

DESCRIPTION

S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) Ground Ground

O O O O O O O O

S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL) S2 Out put Da ta Validity (ECL)

(b) C2c

Table B-3: S2 C2b/c Output Cable Signal Assignments

B-6


S2-RT User's Manual

APPENDIX B

PIN# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

SIGNAL NAME ODD EVEN TRACKS TRACKS GND GND GND GND TRACK 1 TRACK 2 TRACK 1 TRACK 2 TRACK 3 TRACK 4 TRACK 3 TRACK 4 TRACK 5 TRACK 6 TRACK 5 TRACK 6 TRACK 7 TRACK 8 TRACK 7 TRACK 8 TRACK 9 TRACK 10 TRACK 9 TRACK 10 TRACK 11 TRACK 12 TRACK 11 TRACK 12 TRACK 13 TRACK 14 TRACK 13 TRACK 14 Clock Ou t Clock Out Clock Ou t Clock Out TRACK 15 TRACK 16 TRACK 15 TRACK 16 TRACK 17 TRACK 18 TRACK 17 TRACK 18 TRACK 19 TRACK 20 TRACK 19 TRACK 20 TRACK 21 TRACK 22 TRACK 21 TRACK 22 TRACK 23 TRACK 24 TRACK 23 TRACK 24 TRACK 25 TRACK 26 TRACK 25 TRACK 26 TRACK 27 TRACK 28 TRACK 27 TRACK 28 NC NC NC NC HIGH HIGH LO W LO W HIGH HIGH LO W LO W GND GND GND GND GND GND GND GND NC NC NC NC NC NC NC NC HIGH HIGH LO W LO W NC NC NC NC

I/O

DESCRIPTION Gro und Gro und MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Tape clock (ECL) MK III Tape clock (ECL) MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data MK III Fo rma t NRZM data No Co nnectio n, +read after No Co nnectio n, -re ad afte r HIGH (ECL) LO W (ECL) HIGH (ECL) LO W (ECL) Gro und Gro und Gro und Gro und No Co nnectio n, ECL 100 No Co nnectio n, ECL 100 No Co nnectio n, ECL 100 No Co nnectio n, ECL 100 HIGH (ECL) LO W (ECL) No Co nnectio n, +read after No Co nnectio n, -re ad afte r

O O O O O O O O O O O O O O O O O O O O O O O O O O O O O O

o o o o o o o o o o o o o o

ut ut ut ut ut ut ut ut ut ut ut ut ut ut

pu pu pu pu pu pu pu pu pu pu pu pu pu pu

t t t t t t t t t t t t t t

(E (E (E (E (E (E (E (E (E (E (E (E (E (E

CL) CL) CL) CL) CL) CL) CL) CL) CL) CL) CL) CL) CL) CL)

outpu outpu outpu outpu outpu outpu outpu outpu outpu outpu outpu outpu outpu outpu write write

t t t t t t t t t t t t t t

(ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) (ECL) Ch. A (M KII I) Ch. A (MKIII)

O O O O

I I I I O O

oh oh oh oh

m m m m

in in in in

pu pu pu pu

t t t t

te te te te

rm rm rm rm

in in in in

at at at at

io io io io

n n n n

write clo ck Ch. A (MKIII) write clock Ch. A (MKIII)

Table B-4: MkIII C2a Output Cable Signal Assignments

B-7


S2-RT User's Manual

APPENDIX B

S2 Mode 32x1-1 32x2-1 32x2-2 32x4-1 32x4-2 32a4-2 32b4-2 16x1-1 16x2-1 16x2-2 16x4-1 16x4-2 16i4-1 16x8-1 16x8-2 16i8-1 16p8-2 16v8-2 8x2-1 8x2-2 8x4-1 8x4-2 8i4-1 8x8-1 8x8-2 8i8-1 8p8-2 8x16-1 8x16-2 8d16-2 8n16-2 4x4-1 4x4-2 4x8-1 4x8-2
D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV D DV 0 x x x x x x x x x x x x

Active User Data and Validity Channels (D=C1/C2a, DV=C2b/C2c)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

x x x 0 x x x 0 x 0

x x x x

x x x 0 x x x 0 x x x 0

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 0

x x x 0 x x x 0

x x x 0

x 0 x 0 x x x 0 x x x 0

x x x x x x x x x x x x x x x x

x x x 0 x x x x x 0 x x x x x x x x x 0 x x x x x x x x x 0 x x x x x 0 x x x x x x x 0 x x x x

x 0 x 0

x 0

x x

x 0

x x

x x x 0

x 0 x x x 0 x 0 x 0 x x x 0 x x x 0

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 0 x x x x x 0 x x x x x x x x x 0 x x x x x x x x x 0 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 0 x x x 0 x 0 x 0 x x x x

x 0 x x x 0 x 0 x 0 x x x 0 x x x 0

x x x x x x x x

x x x 0 x 0 x 0

x x x x x x x x

x x x 0 x 0 x 0

x 0 x x x 0 x 0 x 0

x x x x x x x x

x x x 0 x 0 x 0

x x x x x x x x

x x x 0 x 0 x 0

x x x x

x x x 0

x x x x

x x x 0

Table B-5: S2 Modes with acti ve C1/C2 signal channels (Continued on next page)

B-8


S2-RT User's Manual

APPENDIX B

S2 Mode 4i8-1 4p8-2 4x16-1 4x16-2
D DV D DV D DV D DV 0 x x x x x x x x

Active User Data and Validity Channels (D=C1/C2a, DV=C2b/C2c)
1 2 x x x x x x x x 3 4 x x 5 6 x x 7 8 x x x x x x x x 9 10 x x xx 0x xx xx xx 0x 11 12 x x x 0 xx xx xx 0x 13 14 15 x x

x 0 x x x 0

x 0 x x x 0

x x x x

x x x 0

x x x x

x x x 0

x x x 0

x x x x

x x x 0

Note: x = active signal, 0 = driven low, blank = floating Table B-5: S2 Modes with acti ve C1/C2 signal channels (Continued from previous page)

P IN# 2 3 4 5 7 8 20

SIG. NAME TxD RxD R TS C TS GND DCD D TR

I/O O I O I

DESCRIPTION Tra nsmit Data Rece iv e Data Reque st to Send Cle ar to Se nd Signa l Ground

I O

Data Carrie r De te ct Data Term ina l Ready

Table B-6: C6 (RCL) Cable Signal Assignments

B-9


S2-RT User's Manual

APPENDIX B

Table B-7: C2a Cable Test Vector Sequence

Table B-8: C2b/C2c Cable Test Vector Sequence

Figure B-1: C1/C2 Test Vector Generator Logical Circuit

B - 10


S2-RT User's Manual

APPENDIX B

Figure B-2: C1 Input Timing Interface (32 MHz clk)

Figure B-3: C1 Input Timing Interface (clk = data rate)

B - 11


S2-RT User's Manual

APPENDIX B

Figure B-4: C2 Output Timing Interface (32 MHz clk)

Figure B-5: C2 Output Timing Interface (clk=data rate)

B - 12


S2-RT User's Manual

APPENDIX B

Figure B-6: C2 Output Timing Interface (MkIII format)

Figure B-7: C1 & C2 Electrical Specifications

B - 13


S2-RT User's Manual

APPENDIX C

################################################### # S2 Recorder Operati ng Sy stem startup defaults file v2.3 # ################################################### # Console termi nal type (e.g. vt100). term = vt100 # Console baud rate (normally 9600, max. 38400). baud = 9600 # Default recorder mode. dfltmode = 16x8-1 # Default ba rrel roll setti ng ('on' or 'off ', normally 'on'). Should be # off to record data that can be usefully played back on an S2-RT. barrelroll = on # Default record speed ('lp' or 'slp'). recordspeed = slp # Tape ty pe code, one of: # 1 == Scotch ST-120/SE-180 # 2 == Maxell ST-180/ST-182/SE-260 # 3 == Ampex 289 ST-120/ST-126/SE-180 # ...or additional typecodes as listed by t he 'tapetype typecodes' command. # Used to determine write current levels. For unlisted tape types enter # digits NNNMMM where NNN is write current for LP and MMM is current for SLP. tapety pe = 3 # Number of t ra nsports connected to t his S2 sy stem (1, 2, 4, or 8, normally 8). # T his determi nes the number of transports to check duri ng general diagnostics # a nd self-test. T his also determines t he number of tra nsports to select a nd # use i n t he test modes c1testXX, c2testXX, a nd diagXX. # In a PT determines t he mi nimum number of DRD boards t hat must be present. diagnumtran = 8 # # # sc Default system clock PLL lock mode, one of: refclk, 1hz, errmes, xtal, auto, or manual. Normally 'refclk' for record terminal. 'auto' selects 'refclk' if user ref clock present, 'xtal' otherwise (on bot h RT a nd PT). pllmode = auto nals, 'c1' for C1 (record) means select C1 on a n S2-RT

# Source selection for i nput ref clock and 1 Hz sig # cable and 'c2' for C2 (playback) cable. 'default' # a nd C2 on an S2-PT. clkinsrc = c1 # Default i nput ref clock rate in MHz, one of: 4, 8 clkinrate = 32 # Default output ref clock rate in MHz, one of: 4, clkout rate = 32

# Disable the ability to record tapes ('on' or 'off ', normally 'off ' to allow

Part 1: /home/s2/doc/userman/working/txt/defaults.txt x

APPENDIX C

SAMP LE ROS DE FAULTS FI LE

, 16, 32, or followdata. 8, 16, 32, or followdata.

C-1


S2-RT User's Manual

APPENDIX C

# recordi ng). Useful i n a PT to ensure that no data is accidentally destroyed. writeprotect = off # Station # 0 mean station = # Sy stem nickname # Sy stem serialnum number from 0 to 255 (only 1-6 display ed by t ransports). s "undefi ned", don't display on console. 0 "nickname", what it's commonly known as (up to 8 characters). = serial number from 1 to 65535 (must match s/n label on DSCM card cage). =

# Userid(s) a nd encrypted password(s) for rlogin/telnet access to console. # If eit her of t hese a re blank or omitted, no userid or password prompt will # appear. The password entered here must be encrypted using t he console # 'encrypt' comma nd. The default password is 'security ' (encrypted RdebRSdzRc). # Multiple userid/password pairs can be defined by adding more lines i n the # same format (each new userid line must be followed by a passwd line). loginuserid = vxworks #loginpasswd = RdebRSdzRc # Default status verbose level (1-3) (normally 1) # Higher values show some additional non-essential status messages. verbose = 1 # Default "expert" mode setti ng ('on' or 'off '). # Suppresses some non-essential console commands if off, otherwise all # commands available. expert = on # Select whether the VME cage front-panel LED (and formatter LED) should act # as an overall sy stem OK/FAIL light ('ok') or show t he formatter ha rdwa re # 1 Hz signal ('1hz'). ledmode = ok # Recorder setup to use when S2 is stopped (or in rewind, ff etc.), eit her # 'bypass' or 'play'. 'default' means select bypass on an S2-RT a nd play # on a n S2-PT. Record applications will typically use 'bypass', while playback # applications will use 'play' which ensures a consistent S1HZ_PB output tick # on t he C2 cable (except during mode changes). stopsetup = default # # # # se # # # # # se Ta rget-time selection method i n automatic playback self-alignment. 'first' chooses t he earliest t ra nsport's tape time, 'last' chooses t he latest transport's tape time, and 'middle' chooses t he time half-way between t he two. lfaligntarg = first Maximum time difference allowed duri ng automatic playback self-alignment, i n minutes from 1 to 600 (default 30 mi n, 0 means no limit). If the difference between a ny tra nsport tape time a nd the selected target time exceeds this value, status code STAT_ALIGNFAIL with error ERR_ALBADTIME will appear. T his limit does not apply to user 'align selfalign' requests. lfaligntime = 30

# SC PLL 'refclk' glitch fix flag. Automatically resets correct station delay # after a clock glitch i n refclk mode (1) or does nothing (0) (normally 1). # Delay measurement must be different from setting a nd stable for two seconds.

C-2


S2-RT User's Manual

APPENDIX C

scpll refclkfix = 1 # Position display format. S2 tape positions a re normally displayed as # hours/minutes/seconds of recorded data since BOT, e.g. 5:47:29 (format 1). # Tape positions may also be displayed as a n i nteger number of seconds, # e.g. 20849 (format 2). Note t hat console commands such as 'position' alway s # accept both position formats. posdisformat = 1 # # # # # p Mappi ng for mode selection on playback. This is used i n special situations where t he mode selected on play back should be different from the mode used at record time. Give pairs of modes in brackets, maximum 230 cha racters total. Both modes in a pair must have t he same total data rate. e.g. (16x8-1 16i8-1) (8x16-1 8i16-1) lay modemap =

# Default setti ng for per-tra nsport write current offset option switch, # as set by t he 'tra nsport options wrlevoffset' console comma nd (offset set # by 'transport wrlevoffset' command). # 0 means disable per-transport write current offsets at bootup. # 1 means enable per-t ransport write current offsets at bootup. # 'default' means enable offsets at bootup for AG2550 and later transports only wrlevoffoption = 1 # Disable the "eject all" feature (1) or eject all tapes as usual when any # t ransport eject button is held longer than 2 seconds (0) (normally 0). ejectalldisable = 0 # Disable the console "reboot" key (1) or reboot the S2 software and ha rdwa re # as usual when cntl-_ (cont rol-underscore) is ty ped (0) (normally 0). rebootkey disable = 0 # Skip self-test 1 at bootup (1) or run the self test as usual (0) (normally 0). skipselftest1 = 0 # RCL baud rate (normally 19200, max. 57600). rclbaud = 19200 # T his S2's RCL address, 0-253. Use 0 unless connecting multiple RCL devices # using RS485. Address is ignored duri ng RCL connection via network sockets. rcladdr = 0 # Mark III ha rdwa re-ID code, identifies recordi ng station i n Mark III header. # Two hex digits, FF not allowed. mk3hwid = 52 # Backspace cha racter for VxWorks shell (ASCII code, normally 8 or 127). backspace = 127 # T he following parameter supplies stevie (vi) editor startup options. # Use 'nobackup' to prevent use of backups, recommended when editing # large files ( remai ning SRAM partition space), e.g. termcap file. exi nit = set nobackup showmode # # T he following parameters a re used for network operation only. #

C-3


S2-RT User's Manual

APPENDIX C

# Lock t he console against access by rlogin and telnet (1), or allow access # as usual (0). As a special case, 2 allows access during t he boot sequence # but not after ROS starts runni ng. consolelock = 0 # Lock t he RCL against access by network sockets (1), or allow access # as usual (0). rcllock = 0 # During bootup set sy stem time from remote network host using RDATE # protocol (1) or from built-in battery backed-up clock (0) (normally 0). remtime = 0 # Internet name or address of host to use for network time setting. # If omitted or bla nk will use host name a nd inet address from boot parameters. # Host names entered here must appear in the VxWorks hosts table, so it may be # easier to use the inet address. timehost = # # T he following parameters a re for diagnostics only. # # Boot wit h the formatter RCLK enabled (1) or disabled (0) (normally 0). form rclk = 0 # E nable automatic data-recovery defaults saves (1) or disable (0) (normally 1). drsetdefaultauto = 1 # Flag used by i nstall procedure, "done" i ndicates install done. i nstall = not done

C-4


S2-RT User's Manual

APPENDIX D

D.1 Overview
Termcap is a data base describing t he capabilities of terminals. Terminals a re described in termcap source descriptions by giving a set of capabilities which t hey have, by describing how operations a re performed, by describi ng paddi ng requirements, a nd by specifying i nitialization sequences. T his database is used by applications programs such as vi(1), and libraries such as curses(3X), so t hey can work with a variety of terminals wit hout cha nges to t he programs. Each termcap ent ry consist of a number of colon-separated (:) fields. The fi rst field for each termi nal lists the various names by which it is known, sepa rated by ba r ( | ) characters. The first name is always two characters long, and is used by older (version 6) systems (which store t he terminal type in a 16-bit word in a system-wide database). The second name given is the most common abbreviation for the termi nal (this is t he one to which the envi ronment variable TERM would normally be set). T he last name should fully identify the terminal's make and model. All other names are taken as sy nonyms for the initial terminal name. All names but the first a nd last should be in lower case and contain no blanks; the last name may well contai n upper case and bla nks for added readability. Termi nal names (except for t he last, verbose entry) should be chosen using the followi ng conventions: + T he particula r piece of hardware making up the terminal should have a root name chosen; for example, for the Hewlett-Packard 2621, hp2621. T his name should not contai n hyphens. + Modes that the hardware can be i n or user preferences should be indicated by appendi ng a hyphen and a n indicator of the mode. Thus, a vt100 in 132-column mode would be given as: vt100-w. T he following suffixes should be used where possible: Suffix -w -am -nam -n -na Meaning Example wide mode (more t han 80 columns) vt100-w with automatic margins (usually default) vt100-am wit hout automatic margi ns vt100-nam number of lines on t he screen aaa-60 no arrow key s (leave them i n local) concept100-na

Part 1: /home/s2/doc/userman/working/txt/termcap.txt x

APPENDIX D

UNIX TE RMCAP FI LE FORMAT

D-1


S2-RT User's Manual

APPENDIX D

-np -rv

number of pages of memory reverse video

concept100-4p concept100-rv

Termi nal ent ries may continue onto multiple lines by giving a \ as the last character of a line, a nd empty fields may be included for readability (here between the last field on a li ne and the first field on t he next). Comments may be included on lines beginni ng wit h #.

D.2 Types of Capabilities
Termi nal capabilities each have a two-letter code, and are of three types: boolean These indicate pa rticula r features of t he terminal. For instance, an entry for a termi nal that has automatic margins (an automatic RETURN a nd LINEFEED when t he end of a li ne is reached) would contain a field with t he boolean capability am. T hese give t he size of the display of some other attribute. Numeric capabilities are followed by the cha racter `#', and a number. An entry for a terminal with a n 80-column display would have a field contai ni ng co#80. T hese i ndicate t he character sequences used to perform particula r terminal operations. String-valued capabilities, such as ce (clearto-end-of-li ne sequence) a re given by t he twoletter code, followed by the cha racter `=', and a string (which ends at t he following : field delimiter).

numeric

stri ng

A delay factor, in milliseconds may appear after t he `='. Padding cha racters a re supplied by tputs after t he remainder of the stri ng is sent. T he delay can be eit her a number, or a number followed by t he character `*', which i ndicates t hat the proportional padding is required, in which case t he number given is t he amount of paddi ng for each line affected by an operation using t hat capability. (In the case of a n insert-character operation, the factor is still t he n umber of li nes affected; this is always 1 unless t he terminal has in a nd the softwa re uses it.) When a * is specified, it is sometimes useful to give a delay of the form 3.5 to specify a delay per li ne to tenths of milliseconds. (Only one decimal place is allowed.)

D-2


S2-RT User's Manual

APPENDIX D

D.2.1 Comments
To comment-out a capability field, insert a `.' (period) as the first cha racter in that field (following t he :).

D.2.2 Escape Sequence Codes
A number of escape sequences a re provided in the stri ngvalued capabilities for easy encoding of characters there: \E ^X \n \r \t \b \f maps to ESC maps to CTRL-X for any appropriate cha racter X maps to LINEFEED maps to RETURN maps to TAB maps to BACKSPACE maps to FORMFEED

Finally, cha racters may be given as t hree octal digits after a backslash (for example, \123), and the characters ^ (caret) a nd \ (backslash) may be given as \^ a nd \\ respectively. If it is necessary to place a : in a capability it must be escaped in octal as \072. If it is necessary to place a NUL character in a stri ng capability it must be encoded as \200. (The routines t hat deal with termcap use C strings and strip t he high bits of the output very late, so that a \200 comes out as a \000 would.)

D.2.3 Parameterized Strings
Cursor addressing a nd other stri ngs requiring parameters a re described by a parameterized string capability, with pri ntf(3S)-like escapes (%x) in it; ot her characters a re passed through unchanged. For example, to address t he cursor, the cm capability is given, using two pa rameters: the row a nd column to move to. (Rows and columns are numbered from zero and refer to the physical screen visible to t he user, not to any unseen memory. If the terminal has memory-relative cursor addressing, that can be indicated by an a nalogous CM capability.) The % % % % % % escapes have the % produce t he d output value 2 output value 3 output value . output value followi ng meani ngs: character % as i n printf %d as i n printf %2d as i n printf %3d as in pri ntf %c

D-3


S2-RT User's Manual

APPENDIX D

%+x add x to value, t hen do `%.' %>xy if value > x then add y, no output %r reverse order of two parameters, no output %i increment by one, no output %n exclusive-or all parameters wit h 0140 (Datamedia 2500) %B BCD (16*(value/10)) + (value%10), no output %D Reverse coding (value - 2*(value%16)), no output (Delta Data) Consider t he Hewlett-Packa rd 2645, which, to get to row 3 and column 12, needs to be sent \E&a12c03Y padded for 6 milliseconds. Note: the order of t he row a nd colum n coordinates is reversed here and t hat the row a nd column are sent as two-digit i ntegers. Thus its cm capability is `:cm=6\E&%r%2c%2Y:'. Termi nals that use `%.' need to be able to backspace the cursor (le) a nd to move t he cursor up one li ne on the screen (up). T his is necessary because it is not alway s safe to transmit \n, ^D, and \r, as the sy stem may change or discard t hem. (Programs using termcap must set terminal modes so t hat TAB characters a re not expanded, maki ng \t safe to send. This turns out to be essential for the Ann Arbor 4080.) A final example is t he Lear Siegler ADM-3a, which offsets row a nd column by a bla nk cha racter, t hus it requires `:cm=\E=%+ %+:'. Row or column absolute cursor addressing can be given as single-pa rameter capabilities ch (horizontal position absolute) a nd cv (vertical position absolute). Sometimes these are shorter than the more general two-pa rameter sequence (as wit h the Hewlett-Packard 2645) and can be used i n preference to cm. If t here are parameterized local motions (for example, move n positions to the right) t hese can be given as DO, LE, RI, and UP wit h a single parameter indicating how ma ny positions to move. These are prima rily useful if the terminal does not have cm, such as the Tektronix 4025.

D.2.4 Delays
Certain capabilities cont rol padding i n t he terminal driver. These a re prima rily needed by hardcopy termi nals a nd are used by t he tset (1) program to set termi nal driver modes appropriately. Delays embedded i n t he capabilities cr, sf, le, ff, a nd ta will set the appropriate delay bits in the terminal driver. If pb (padding baud rate) is given, t hese values can be ignored at baud rates below t he value of pb. For 4.2BSD tset, t he delays a re given as numeric capabilities dC, dN, dB, dF, a nd dT i nstead.

D-4


S2-RT User's Manual

APPENDIX D

D.2.5 Sim ilar Terminals
If there a re two very similar terminals, one can be defined as being just like the other wit h certain exceptions. The stri ng capability tc can be given with t he name of t he simila r terminal. This capability must be last, and t he combined length of the ent ries must not exceed 1024. T he capabilities given before tc override those in the termi nal type invoked by tc. A capability can be canceled by placing xx@ to the left of t he tc i nvocation, where xx is t he capability. For example, the ent ry hn|2621-nl:ks@:ke@:tc=2621: defines a 2621-nl that does not have the ks or ke capabilities, hence does not turn on t he function key labels when in visual mode. T his is useful for different modes for a termi nal, or for different user preferences.

D.3 Capabilities
The cha racters in the Notes field in the next table have t he following meani ngs (more than one may apply to a capability): N P * o i ndicates i ndicates indicates indicates numeric parameter(s) t hat padding may be specified t hat padding may be based on t he number of lines affected capability is obsolete

Obsolete capabilities have no termi nfo equivalents, since they were considered useless, or a re subsumed by ot her capabilities. New softwa re should not rely on t hem. Name !1 !2 !3 #1 #2 #3 #4 %0 %1 %2 %3 %4 %5 %6 %7 %8 %9 Type str str str str str str str str str str str str str str str str str Notes Description sent by shifted save key sent by shifted suspend key sent by shifted undo key sent by shifted help key sent by shifted home key sent by shifted i nput key sent by shifted left-arrow key sent by redo key sent by help key sent by ma rk key sent by message key sent by move key sent by next-object key sent by open key sent by options key sent by previous-object key sent by pri nt or copy key

D-5


S2-RT User's Manual

APPENDIX D

%a %b %c %d %e %f %g %h %i %j &0 &1 &2 &3 &4 &5 &6 &7 &8 &9 *0 *1 *2 *3 *4 *5 *6 *7 *8 *9 5i @0 @1 @2 @3 @4 @5 @6 @7 @8 @9 AL CC CM DC DL DO EP F1-F9 FA-FZ Fa-Fr HC HD IC K1 K2

str str str str str str str str str str str str str str str str str str str str str str str str str str str str str str bool str str str str str str str str str str str str str str str str bool str str str bool bool str str str

sent by shifted message key sent by shifted move key sent by shifted next-object key sent by shifted options key sent by shifted previous-object key sent by shifted print or copy key sent by shifted redo key sent by shifted replace key sent by shifted right-arrow key sent by shifted resume key sent by shifted cancel key sent by ref(erence) key sent by refresh key sent by replace key sent by resta rt key sent by resume key sent by save key sent by suspend key sent by undo key sent by shifted beg(inning) key sent by shifted find key sent by shifted cmd (comma nd) key sent by shifted copy key sent by shifted create key sent by shifted delete-cha r key sent by shifted delete-line key sent by select key sent by shifted end key sent by shifted clear-li ne key sent by shifted exit key pri nter will not echo on screen sent by find key sent by beg(inning) key sent by cancel key sent by close key sent by cmd (comma nd) key sent by copy key sent by create key sent by end key sent by enter/send key (unreliable) sent by exit key add n new blank lines termi nal settable command char i n prototype memory-relative cursor motion to row m, col n delete n cha racters delete n li nes move cursor down n li nes even pa rity sent by function keys 11-19 sent by function keys 20-45 sent by function keys 46-63 cursor is ha rd to see half-duplex insert n bla nk characters sent by key pad upper left sent by key pad center

(NP*) (NP) (NP*) (NP*) (NP*) (o)

(o) (NP*)

D-6


S2-RT User's Manual

APPENDIX D

K3 K4 K5 LC LE LF LO MC ML MR NL NP NR Nl OP RA RF RI RX SA SF SR SX UC UP XF XN ac ae al am as bc bl bs bt bw cb cd ce ch cl cm co cr cs ct cv dB dC dF dN dT dV da db

str str str bool str str str str str str bool bool bool num bool str str str str str str str str bool str str str str str str bool str str str bool str bool str str str str str str num str str str str num num num num num num bool bool (o) (NP) (P) (P) (P) (P) (P) (o)

sent by key pad upper right sent by key pad lower left sent by key pad lower right lower-case only move cursor left n positions turn off soft labels turn on soft labels clear left a nd right soft margi ns set soft left margi n set soft right ma rgin \n is NEWLINE, not LINEFEED pad cha racter does not exist ti does not reverse te number of labels on screen (start at 1) odd parity turn off automatic margi ns send next i nput cha racter (for ptys) move cursor right n positions turn off xoff/xon ha ndshaking turn on automatic margi ns scroll forwa rd n lines scroll backwa rd n lines turn on xoff/xon ha ndshaking upper-case only move cursor up n li nes x-off character (default DC3) x-on cha racter (default DC1) graphic character set pai rs aAbBcC - def=VT100 end alternate character set add new bla nk li ne terminal has automatic ma rgins sta rt alternate cha racter set backspace if not ^H audible signal (bell) termi nal can backspace wit h ^H back-tab le (backspace) wraps from column 0 to last col clear to beginning of line, i nclusive clear to end of display clear to end of line set cursor column (horizontal position) clear screen and home cursor screen-relative cursor motion to row m, col n number of colum ns i n a line RETURN cha nge scrolli ng region to lines m t hru n clear all tab stops set cursor row (vertical position) milliseconds of bs delay needed (default 0) milliseconds of cr delay needed (default 0) milliseconds of ff delay needed (default 0) milliseconds of nl delay needed (default 0) ms of horizontal tab delay needed (default 0) ms of vertical tab delay needed (default 0) display may be retai ned above t he screen display may be retained below the screen

(o) (P) (NP) (P) (P) (NP*) (NP*) (P) (o) (NP*)

(P) (P*) (P) (o) (P) (o) (P) (P) (P*) (P) (NP) (P*) (NP) (P*) (NP) (P) (NP) (o) (o) (o) (o) (o) (o)

D-7


S2-RT User's Manual

APPENDIX D

dc dl dm do

str str str str

(P*) (P*)

delete delete enter down

cha racter li ne delete mode one line

ds str eA str ec str ed str ei str eo bool es bool ff str fs str gn bool hc bool hd str ho str hs bool hu str hz bool i1 str i3 str iP str ic str if str im str in bool ip str is str it num k0-k9 str k; str kA str kB str kC str kD str kE str kF str kH str kI str kL str kM str kN str kP str kR str kS str kT str ka str kb str kd str ke str kh str kl str km bool kn num ko str

disable status line enable graphic cha racter set erase n characters end delete mode end i nsert mode can erase overstrikes wit h a bla nk escape can be used on t he status li ne (P*) hardcopy termi nal page eject return from status li ne generic li ne ty pe (for example dialup, switch) ha rdcopy terminal half-line down (forward 1/2 li nefeed) (P) home cursor has extra status line half-line up (reverse 1/2 li nefeed) cannot pri nt ~s (Hazelti ne) termi nal initialization string (termi nfo only) termi nal initialization string (termi nfo only) pat hname of program for i nit (termi nfo only) (P*) insert character name of file contai ning i nitialization string enter i nsert mode insert mode disti nguishes nulls (P*) i nsert pad after cha racter inserted terminal i nitialization stri ng tab stops i nitially every n positions sent by function key s 0-9 sent by function key 10 sent by insert-li ne key sent by back-tab key sent by clear-screen or erase key sent by delete-cha racter key sent by clear-to-end-of-li ne key sent by scroll-forwa rd/down key sent by home-down key sent by insert-char or enter-i nsert-mode key sent by delete-line key sent by insert key while in insert mode sent by next-page key sent by previous-page key sent by scroll-backwa rd/up key sent by clear-to-end-of-screen key sent by set-tab key sent by clear-all-tabs key sent by backspace key sent by down-arrow key out of keypad tra nsmit mode sent by home key sent by left-a rrow key has a meta key (shift, sets parity bit) (o) number of function (k0-k9) keys (default 0) (o) termcap entries for ot her non-function key s (P) (NP)

D-8


S2-RT User's Manual

APPENDIX D

kr ks kt ku l0-l9 la le lh li ll lm lw ma mb md me mh mi mk ml mm mo mp mr ms mu nc nd nl ns nw nx os pO pb pc pf pk pl pn po ps pt px r1 r2 r3 rP rc rf ri rp rs sa sc se

str str str str str str str num num str num num str str str str str bool str str str str str str bool str bool str str bool str bool bool str num str str str str str str str bool str str str str str str str ? str str str str str

sent by right-arrow key put termi nal i n key pad t ransmit mode sent by clear-tab key sent by up-arrow key labels on function keys 0-9 if not f0-f9 label on function key 10 if not f10 move cursor left one position number of rows i n each label number of li nes on screen or page last li ne, first column lines of memory if > li (0 means varies) number of columns in each label a rrow key map (used by vi version 2 only) turn on bli nki ng attribute turn on bold (ext ra bright) attribute turn off all att ributes turn on half-bright attribute safe to move while i n i nsert mode turn on bla nk attribute (characters i nvisible) memory lock on above cursor turn on meta mode (8th bit) turn off meta mode turn on protected att ribute turn on reverse-video attribute safe to move i n standout modes memory unlock (turn off memory lock) no correctly-working cr (Datamedia 2500) non-destructive space (cursor right) NEWLINE character if not termi nal is a CRT but does not scroll NEWLINE (behaves like cr followed by do) padding will not work, xoff/xon required terminal overstrikes turn on the pri nter for n bytes lowest baud where delays are required pad character (default NUL) turn off the pri nter function key n to ty pe string s (termi nfo only) function key n to exec stri ng s (terminfo only ) label n to show string s (terminfo only) turn on t he pri nter pri nt contents of t he screen has ha rdwa re tabs (may need to be set with is) function key n to t ransmit string s (terminfo) reset termi nal to sane modes (terminfo only ) reset termi nal to sane modes (terminfo only ) reset termi nal to sane modes (terminfo only ) like ip but when in replace mode restore cursor to position of last sc name of file containing reset string unkown at present repeat cha racter c n times reset terminal completely to sane modes define t he video att ributes (9 parameters) save cursor position end standout mode

(P)

(o)

(o)

(o) (o) (o) (o) (P)

(N)

(NP)

(o)

(P) (P)

(NP*) (NP) (P)

D-9


S2-RT User's Manual

APPENDIX D

sf sg so sr st ta tc te ti ts uc ue ug ul up us vb ve vi vs vt wi ws xb xn xo xr xs xt xx

str num str str str str

(P)

(P) (P)

scroll text up # of garbage chars left by so or se (default 0) begin sta ndout mode scroll text down set a tab stop i n all rows, current column move cursor to next 8-position ha rdwa re tab

str entry of similar terminal - must be last str stri ng to end programs t hat use termcap str stri ng to begi n programs that use termcap str (N) go to status line, column n str underscore one cha racter and move past it str end underscore mode num # of garbage cha rs left by us or ue (default 0) bool underline cha racter overstrikes str upli ne (cursor up) str sta rt underscore mode str visible bell (must not move cursor) str make cursor appear normal (undo vs/vi) str make cursor invisible str make cursor very visible num vi rtual termi nal number str (N) set curr wi ndow to line i thru j, col m thru n num number of colum ns i n status line bool Beehive (f1=ESC, f2=^C) bool NEWLINE ignored after 80 cols (Concept) bool termi nal uses xoff/xon handshaking bool (o) RETURN acts like ce cr nl (Delta Data) bool sta ndout not erased by overwriti ng (HP) bool TAB cha rs destructive, magic so cha r (Teleray) bool (o) Tektronix 4025 insert-li ne

D - 10


S2-RT User's Manual

APPENDIX E

ADC: AGC: AHOOK: BER: BERC: BOT: BYP: CRC: DAC: DEF: DHOOK: DR: DRAM: DRD: DSCM: DV: EOD: EOT: EP: ERRMES: FF: FIFO: FORM: LAN: LP: PB: PCFS: PLL: PT: RCC: RCL: RCLCO: REFCLK: ROS: ROSCO: RPMON: RT: SCPLL: SLP: SP: SRAM: SRSYR: SVHS: TAM: TCL: TCB: TCP: TRAN: TVG: TVR: UI: UIC: UTC: VCO: VLBI: VSOP:

Analog to Digital Converter Automatic Gain Cont rol Analog Direct-Hookup Bit-Error Rate Bit-Error Rate Counter Begi nni ng Of Tape Bypass Cy clical Redunda ncy Check Digital to Analog Converter Deformatter Digital Direct-Hookup Data Recovery Dy namic Random Access Memory Data Recovery/Deformatter Data, Signal, and Cont rol Module Data Validity E nd Of Data E nd Of Tape Extended Play (same as SLP) E rror Measurement Fast-Forward First-In-First-Out memory Formatter Local-Area Network Long Play Playback Personal Computer Field System (NASA Goddard Space Flight Center) Phase-Lock Loop Playback Termi nal Recorder Cont rol Computer Radioastronomy Control Link (formerly Recorder Cont rol Link) Radioastronomy Control Link Communications program Reference Clock Recorder Operating Sy stem Recorder Operating Sy stem Communications program Record-Playback Monitor Record Terminal Sy stem Clock Phase-Lock Loop Super-Long Play Short Play Static Random Access Memory Servo-Sy nc (Record) Super VHS T ransport Array Module T ransport Cont rol Link T ransport Cont rol Board T ransport Cont rol Processor T ransport Test Vector Generator Test Vector Receiver User Interface User Interface Card Co-ordinated Universal Time Voltage-Controlled Oscillator Very Long Baseli ne Interferometry VLBI Space Observatory Programme

Part 1: /home/s2/doc/userman/working/txt/glossary.txt x

APPENDIX E

GL OSSARY

E-1


[1] Brent Carlson, ``S2 VLBI `Tape ID' and `User Info Field' Format Requirements for Canadian (S2) Correlator Operational Compatibility'', DRAO-RPCS3001 Rev. 1.1, Dominion Radio Astrophysical Observatory, July 30, 1996 http://www.drao.nrc.ca/web/vlbi/docs/doc3001.ps.gz [2] Georg Feil, ``Timing and Sy nchronization i n S2 Record a nd Playback Termi nals'', ISTS-SGL-TR94-030, Institute for Space and Terrestrial Science, Space Geody namics Laboratory, June 1994 ftp://ftp.sgl.crestech.ca/pub/s2/doc/timing/timing.ps.Z [3] ISTS/SGL, ``VLBI Sy stem Interface Adapter (VIA) User's Manual'', ver 1.3, Institute for Space a nd Terrestrial Science, Space Geody namics Laboratory, October 1996 ftp://ftp.sgl.crestech.ca/pub/s2/doc/svlbi/via_1.3.ps.Z [4] Rick Wietfeldt, ``Compatibility of S2 a nd VSOPT Recordi ngs at S2 a nd VSOP Correlators'', ver 1.1, Institute for Space and Terrestrial Science, Space Geody namics Laboratory, June 18, 1996 ftp://ftp.sgl.crestech.ca/pub/s2/svlbi/s2vsop_compat_memo_v1.1.ps.Z [5] NASA/GSFC, ``Mark IV Field System'', volume 1 & 2 plus supplements, ver 9.3, Space Geodesy Program NASA/Godda rd Space Flight Center, Janua ry, 1997 ftp://gemini.gsfc.nasa.gov/pub/fs/ [6] Motorola Inc., ``MVME133XT VMEmodule 32 Bit Monoboa rd Microcomputer User's Manual'', MVME133XT/D1, April 1988 [7] Georg Feil, ``S2 GRT Operations Overview for VSOP'', Version 1.5, CRESTech-SGL-TR98-040, Cent re for Research i n Ea rth a nd Space Technology, Space Geody namics Laboratory, March 22, 1998 ftp://ftp.sgl.crestech.ca/pub/s2/svlbi/grtop.ps.Z

Bibliography - 1

Part 1: /home/s2/doc/userman/working/txt/biblio.txt x

Bibliography


Index
!
1Hz-PB BNC output, 4-33 1Hz-REC BNC output, 4-33 C2c cable, 2-6, B-1 C3 cable, 2-6 C4 cable, 2-6 C5 cable, 2-6 C6 (RCL) cable, 2-6 C6 cable, B-1 C7 (console) cable, 2-6 C7 cable, B-1 power cables, 2-7 caltemp, 4-53 Channel, 4-2 Channel ID, 4-25, 4-49, 4-73 clear, 4-31 clkinrate, 4-27, 4-56 clkinsrc, 4-27, 4-56 clkoutrate, 4-27, 4-56 config, 4-31 Configuration, 4-2 See also ROS configuration Console, 4-4 command entry, 4-5 command history, 4-7 commands, 4-29 display, 4-4, 4-18 re-drawing the screen, 4-7 soft-keys, 4-5 consolelock, 4-60 Crossbar, 4-21, 4-32, 4-35 cue, 4-32

A
Ahook, 4-19 align, 4-29 Alignment See Tape alignment assignaddr, 4-51 Autoexec file See Batch files Auxiliary data, 4-11, 4-19 - 4-20, 4-32, 4-34, 4-41, 449, 4-74 - 4-75 Mark III, 4-27

B
barrelroll, 4-30 Basic procedures, 4-8 batch, 4-31 Batch files, 4-7, 4-31 agc_noscope, 6-17 agcoff, 6-17 agcon, 6-17 autoexec, 4-16 batch command, 4-31 batch edit, 4-7, 4-31 batch log, 4-7, 4-31 batch verify, 4-31 berlp.tst, 2-9, 4-81 berslp.tst, 2-9, 4-81 inter.tst, 2-9, 4-81 Battery replacement, 6-3 beep, 4-31 berlp.tst batch file, 2-9, 4-81 berslp.tst batch file, 2-9, 4-81 Bit-error rate (BER), 4-20, 4-25, 4-37, 4-54, A-30 Bootup, 4-14 BOT, 4-42, 4-71, 4-73 boxmode, 4-31

D
Data Acquisition System, 4-1, 4-54, 4-56, A-31 Data extract, 4-39, 4-54 Data Recovery and Deformatter See DRD Data Signal and Control Module See DSCM Day numbers, 4-9 DC bias, 4-35, 4-39, 4-54 def, 4-32 default, 4-32 Defaults file, 4-16, 4-32, C-1 delay, 4-33 See also Station delay Delay tracking, 4-30, 4-33 dfltmode, 4-41 Dhook, 4-19 diag, 4-34 Diagnostics, 4-3 diagnumtran, 4-16, 4-40, 4-80 Disable C1/C2 data, 4-56

C
Cables, C1 c C2a C2b 2-5 able, 2-5, B-1 cable, 2-6, B-1 cable, 2-6, B-1

Index - 1


Display s, 4-4 dnld, 4-35 dr, 4-35 DRD (Data Recovery and Deformatter), 1-2, 6-3 replacement, 6-4 DSCM (Data Signal and Control Module), 1-2

I
In-service time, 4-25, 4-53, 6-5 Installation, 2-1 - 2-9 basic steps, 2-1 cables, 2-5 checkout tests, 2-8 inter.tst batch file, 2-9, 4-81

E
echo, 4-7, 4-35 prompt, 4-36 edit, 4-36 eject, 4-36 Eject-all feature, 4-14 ejectalldisable, 4-14, 4-36 Electrical Characteristics, B-2 C1 and C2, B-2 encry pt, 4-36 Environment temperature and humidity, 3-1 EOD, 4-30, 4-42, 4-71, 4-73 EOT, 4-12 - 4-13, 4-71, 4-73 errmes, 4-27, 4-41, 4-44, 4-68, A-22 Error, 4-3, 4-36 codes, 4-36, A-32 Error rate See Bit-error rate Error-induce, 4-39, 4-56 ervice info See Transport Ethernet port, 2-3, 4-1, 4-4, 4-58, 6-3 expert, 4-37

L
ledmode, 4-16, 4-22 log, 4-38 Log facility, 4-38, 4-76 login, 4-60 loginpasswd, 4-36, 4-60 loginuserid, 4-36, 4-60 logout, 4-39

M
Maintenance, 6-1 Manual playback, 4-13, 4-41 recording, 4-43 Mark III/IV, 4-39 CRC, 4-28, 4-39 data acquisition system, 4-1 sy nc word, 4-39 See also Window, Mark III Mark IV Field Sy stem, 4-1 mk3, 4-39 mk3hwid, 4-28 Mode, 4-2, 4-9, 4-18, 4-40

F
ff, 4-37 Files See ROS configuration form, 4-37 Formatter (FORM), 1-2, 6-3 replacement, 6-4 Function keys (console), 4-7

N
Network Configuration, 4-58 Nickname, 4-47

P G
Glossary, E-1 Group, 4-2, 4-9, 4-37, 4-74 password, 4-36, 4-60 pause, 4-41 PCFS, 4-1 play, 4-41 Play back, 4-12, 4-41 manual, 4-13, 4-41 tape alignment, 4-13, 4-29 tape positioning, 4-41 play modemap, 4-41, A-11 Ports, DSCM RCL Port, 2-3 TCL Port, 2-3 C1 Port, 2-4

H
Head-use time, 4-25, 4-53, 6-5 help, 4-38

Index - 2


C2a Port, 2-4 C2b Port, 2-4 C2c Port, 2-4 C3 Port, 2-4 C4 Port, 2-4 Ethernet Port, 2-3 RCC Serial Port, 2-3 Ports, TAM C3 Port, 2-4 C4 Port, 2-5 C5 Port, 2-5 Power in/out, 2-5 posdisformat, 4-24 - 4-25 position, 4-41 Positioning See Tape positioning Power Requirements DSCM, 2-6 TAM, 2-6 powermon, 4-43 Programming See Transport Prompt See echo

ROS, 1-1, 4-14 ROS Configuration defaults file, 4-16, 4-32 editing, 4-16, 4-36 network, 4-58 startup.cmd file, 4-36, 4-59 termcap file, 4-16 ROSCO, 4-1, 4-48, 6-1 software reloads/upgrades, 6-1 RS-232C serial links, 4-1

S
scan, 4-43 scpll (System Clock PLL), 4-44 scpllmode, 4-27, 4-44 scpllrefclkfix, 4-18, 4-67, 4-76 Self-test, 4-16, 4-34, 4-62 - 4-63, 4-80 selfaligntarg, 4-29 selfaligntime, 4-29 serial, 4-44 serialnum, 4-45 Service History, 4-53, 6-6 Service Manual for AG25x0, 6-5, 6-12 Servicing, 6-3 setremote, 4-9, 4-50 Setup, 4-2, 4-20, 4-45, 4-72 Shell, 4-14, 4-17, 4-36, 4-46, 4-59 - 4-60 Shipping, 7-1 - 7-2 containers, 7-1 environment, 7-2 shutdown, 4-46 skipselftest1, 4-80 sleep, 4-46 Sockets, 4-61 Soft-keys, 4-5 Software Reloads/Upgrades, 4-58, 6-1 Specifications interface, B-1 summary, 8-1 Speed, 4-11, 4-47 See also Tape SRAM (Static RAM board), 1-2, 6-1 State, 4-2, 4-5, 4-24, 4-72 Static RAM board See SRAM station, 4-47 Station delay, 4-18, 4-33, 4-67, 4-76 See also align Status, 4-3, 4-22, 4-47, 4-62 codes, 4-22, 4-48, 4-62 stop, 4-48 Stop setup, 4-2, 4-20, 4-23, 4-45, 4-48 stopsetup, 4-20 syncerrlocate, 4-32 Sy stem Bootup, 4-14 autoexec file, 4-16

R
RCC (Recorder Control Computer), 1-2 RCL, 4-1 command formats, A-5 command/response summary, A-3 interface library, 4-1, 4-58, A-1 operation, 4-58 packet format, A-1 RCLCO test program, 4-58, 4-61 response formats, A-32 rcllock, 4-61 RDATE, 4-50 Rebooting, 4-14, 4-46 record, 4-43 Record/play back monitor task, 4-41, 4-71 Recorder Control Computer See RCC Recording, 4-8, 4-43 group setting, 4-9 manual, 4-43 mode setting, 4-9 speed setting, 4-11 starting the recording, 4-12 tape ID and User Info, 4-11 tape ty pe, 4-11 test vector, 4-12 time setting, 4-9 recordspeed, 4-11 review, 4-43 rewind, 4-43 rlogin, 4-36, 4-39, 4-60

Index - 3


boot monitor, 4-14 initial baud rate, 4-15 ROS bootup, 4-14 self-test, 4-16, 4-80 Sy stem Clock PLL, 4-18, 4-27, 4-33, 4-44, 4-68, 4-77

T
TAM servicing, 6-5 TAM (Transport Array Module), 1-1 Tape choice of, 5-1 guides, 6-12 shipping, 5-2 storage, 5-2 tape speeds, 4-47, 5-1 ty pe, 4-11, 4-30, 5-1 Tape alignment, 4-13, 4-29, 4-76 - 4-77 absolute, 4-29 preventing self-alignment, A-20 relative, 4-30 self-alignment, 4-29, 4-41, A-20 Tape ID, 4-11, 4-23, 4-48, 4-75 Tape positioning, 4-23, 4-25, 4-41 Tape type, 4-11, 4-30 tapeid, 4-48 tapeinfo, 4-49 tapetype, 4-11, 4-30, 5-1 TCP, 4-25, 4-54, 6-7 telnet, 4-36, 4-39, 4-60 Temperature See Transport term, 4-49, 4-60 termcap file, 4-16 Termcap file format, D-1 Terminal type, 4-15 - 4-16, 4-36, 4-49, 4-60 Test sequence See Test vector Test vector FORM, 4-12, 4-34, 4-37 UI , 4-12, 4-34, 4-40, 4-54, B-2 Time, 4-18, 4-50 conversion, 4-9, 4-50 setting, 4-9, 4-50 uptime, 4-50 timehost, 4-50 Timing Interface, B-2 MkIII/IV Output (C2), B-2 S2 Data Input (C1), B-2 S2 Data Output (C2), B-2 Tracking See Transport Transformer (external), 2-7 Transport, 4-24, 4-51 address assignment, 6-7 dead, 4-52, 4-66, 4-78, 6-1, 6-3, 6-7

number of, 4-16, 4-80 programming, 4-51, 6-2 replacement, 6-6 service history, 6-6 service info, 4-54, 6-7 servicing, 6-5 servicing kit, 6-8 tape guide adjustment, 6-12 TCP board, 6-7 temperature cal, 4-53, 6-10 tracking, 4-25, 4-52 write current, 4-53 write current optimization, 6-9 Transport Array Module See TAM Transport Array Module (TAM) rack, 1-1 Transport option switch takeupsense, 4-53 wrlevoffset, 4-53 Transport Servicing Kit, 6-5 Troubleshooting Hints, 6-1

U
UI (User Interface), 1-2, 6-3 uic, 4-54 uncue, 4-55 unpause, 4-55 unreview, 4-55 Upgrades See Software Uptime, 4-50 user, 4-55 User info, 4-11, 4-23, 4-55 User Interface See UI userid, 4-60 userio, 4-55

V
Validity extract, 4-54 verbose, 4-56 version, 4-56 vi editor, 4-7, 4-16, 4-31, 4-36 VLBA, 4-1 Voltage (supply) 120VAC, 2-2 240VAC, 2-2 VxWorks shell, 4-14, 4-17, 4-36, 4-46, 4-59 - 4-60

Index - 4


W
wait, 4-57 Window, Activity Indicator, 4-5 Window, Crucial Parms, 4-4, 4-18 decoded time, 4-20 decoder input, 4-19 decoder sync, 4-20 decoder Xbar, 4-21 est error rate, 4-20 percent data valid, 4-21 recorder mode, 4-18 station delay, 4-18 Window, Interaction, 4-4 Window, Mark III, 4-27 bad CRCs, 4-28 form aux, 4-27 form CRC, 4-28 form output, 4-28 form time, 4-27 frame rate, 4-28 sy nc detect, 4-28 test channel, 4-28 Window, State, 4-5, 4-24 Window, Status, 4-4, 4-22 Window, Transport, 4-5 AGC level, 4-25 head-use time, 4-25 in-service time, 4-25 on time, 4-25 playback TCP serial number, 4-25 state/tape time, 4-24 tape position, 4-25 transport state, 4-25 transport temp, 4-25 transport tracking, 4-25 Window, User I/O, 4-25 C1 data in, 4-26 C2 data out, 4-26 C2 DV out, 4-26 data rate, 4-25 Ref clk in rate, 4-27 Ref clk out rate, 4-27 Ref clk/1 Hz in, 4-27 SC PLL lock mode, 4-27 Window, User Parms, 4-5, 4-23 tape ID, 4-23 tape position, 4-23 tape speed, 4-23 user data valid, 4-23 user info, 4-23 Write Current, 4-53 optimization, 6-9 writeprotect, 4-43 wrlevoffoption, 4-53

X
Xbar See Crossbar

Index - 5