Google
 

Trailing-Edge - PDP-10 Archives - ks10_8080_microcode - klinik.rv5
There are no other files named klinik.rv5 in the archive.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

					DATE:	19-APR-78
					FROM:	JOHN KIRCHOFF
					DEPT:	DIAGNOSTICS
					EXT:	6567
					LOC:	MR1-2 E68

SUBJ:	DECSYSTEM 2020 CONSOLE & KLINIK TTY IMPLEMENTATION

FIVE MODES
-----------

1.	MODE 1) 8080 CTY
	----------------

	IF KLINIK ENABLED VIA 8080 CTY COMMAND, THEN KLINIK INPUT
	CHARS ARE INPUT INTO THE SAME 8080 INPUT BUFFER AS CTY
	CHARS AND HANDLED BY THE 8080 CONSOLE COMMAND PROCESS.
	
	OUTPUT CHARS ARE SENT TO BOTH CTY & KLINIK LINES.

	NORMAL CTY MODE. THINGS TYPED ON THE CTY KEYBOARD ARE TREATED
	AS COMMANDS FOR THE 8080 TO PROCESS.. IE "EM" EXAMINE MEM,
	IF "ST 600" START AT 600, ETC..

	TO ENABLE THE KLINIK LINE, TYPE "KL 1".

	TO DISABLE KLINIK, TYPE "KL 0"

	TO SEE IF KLINIK IS ENABLED OR DISABLED, TYPE "KL"

	IF KLINIK ON, CHARS TYPED ON EITHER KLINIK TTY OR CTY ARE PUT IN
	THE SAME INPUT BUFFER, IN THE ORDER RECEIVED, OUTPUT TYPED TO
	BOTH.

	USES OF THIS FEATURE
	--------------------

	FIELD SERVICE "KLINIK" WITH REMOTE TTY AS PER KL-10 CONSOLE
	MODE KLINIK.  THE KLINIK LINE IN THIS MODE SHOULD APPEAR IN
	ALL RESPECTS TO LOOK LIKE THE 8080 CTY.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

2.	MODE 2) KS-10 PARALLEL CTY MODE
	-------------------------------

	ENTRY OF KLINIK INTO THIS MODE MUST HAVE BEEN ENABLED BY THE
	CTY IN MODE 1.

	IF KLINIK ENABLED VIA CTY COMMAND, THEN INPUT CHARS ARE PASSED
	TO THE THE KS-10 AS IF THEY ARE CTY CHARS.  OUTPUT CTY CHARS
	ARE OUTPUT TO BOTH THE CTY AND KLINIK LINES.  OUTPUT IS
	REPORTED DONE WHEN BOTH CTY AND KLINIK OUTPUT IS COMPLETED.

	ENABLED BY "TT" (TELETYPE COMMAND) --OR--
	A "ST XX" (START COMMAND) --OR--
	A "CO" (CONTINUE COMMAND)

	DISABLED BY "CNTRL-BACKSLASH" --OR--
	THE KS-10 HALTS --OR--
	ACTION IS REQUESTED BY THE KEEP-ALIVE WORD

	USES OF THIS FEATURE
	--------------------

	FIELD SERVICE "KLINIK" WITH REMOTE TTY AS PER KL-10 CTY
	MODE KLINIK.  THE KLINIK LINE IN THIS MODE SHOULD APPEAR IN
	ALL RESPECTS TO LOOK LIKE THE KS-10 CTY.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

3.	MODE 3) KS-10 KLINIK USER MODE
	------------------------------

	TWO SEPARATE LOGICAL TTY LINES INTO AND FROM THE KS-10.

	(THE CTY IS IN MODE 2 WHILE THE KLINIK LINE IS IN THIS MODE.)

	CTY & KLINIK USER

		THE KS-10 CTY SERVICE HANDLES THE CTY INPUT AND OUTPUT
		TO THE CTY.

		THE KLINIK SERVICE HANDLES THE KLINIK INPUT AND OUTPUT
		AND ROUTES THE CHARS TO THE APPROPRIATE USER MODE JOB.

	IN THIS MODE THE 8080 RECOGNIZES "CNTRL-BACKSLASH" FROM THE
	CTY TO SWITCH BACK TO MODE 1.

	IF KLINIK ENABLE SWITCH IS SET THE 8080 WILL ALSO RECOGNIZE
	"CNTRL-BACKSLASH" FROM THE KLINIK LINE TO SWITCH TO MODE 2.

	IF KLINIK HAS NOT BEEN ENABLED BY THE CTY "KL 1" COMMAND, THEN
	KLINIK IS IGNORED IF THE CTY IS SWITCHED TO MODE 1 BUT PICKED
	BACK UP WHEN "TT" IS TYPED ON THE CTY.

	ALL OTHER CHARS TYPED ON CTY ARE PASSED TO KS-10 COMMUNICATION
	WORD 32.  ALL CHARS TYPED ON KLINIK (IF ENABLED) WILL BE PASSED
	TO KS-10 VIA COMMUNICATION WORD 34.
	
	(IF KLINIK WAS ENABLED BY CTY "KL 1" CMD ,THEN IF KLINIK
	LINE IN MODE 2, A "CNTRL-BACKSLASH" ON THE KLINIK LINE WILL
	ALSO FORCE CTY BACK INTO MODE 1)
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	BOTH MODES 1,2 & 3)
	-----------------

	THE 8080 NULL JOB WATCHES FOR:

	1) CRAM OR DP PARITY ERRORS WHICH HALT THE CPU CLOCK
	2) "MEMORY REFRESH ERROR"
	3) MICRO-CODE ENTERS THE HALT LOOP
	4) "KEEP-ALIVE" IF KEEP-ALIVE VALID BIT SET IN STATUS WORD
	5) FORCED RELOAD
	6) POWER FAIL

	THESE 6 EVENTS FORCE CONSOLE INTO MODE 1.

	7) SOMEONE PUSHES THE BOOT SWITCH ON THE FRONT PANEL
	THE SYSTEM WILL BE REBOOTED, IF FRONT PANEL CONSOLE ENABLE
	SWITCH IS ALSO ON.

	USES OF THIS FEATURE
	--------------------

	CTY & USER - CTY FOR LOCAL CONTROL AND USER MODE ON KLINIK FOR
		     RUNNING USER MODE DIAGNOSTICS, SYSERR, ETC.
		     THE KLINIK USER MODE SHOULD APPEAR TO BE A STANDARD
		     USER MODE TIME-SHARING TERMINAL.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

4.	MODE 4) 8080 MAINTENANCE MODE
	-----------------------------

	THE MAINTENANCE MODE ALLOWS THE 8080 CTY TO BE A REMOTE TTY BY
	USING THE KLINIK PORT AS A HIGH SPEED LINK TO A TIME-SHARING
	SYSTEM.  THIS PROVIDES FOR LOG-IN AND SYSTEM FEATURES AND
	ALLOWS A REMOTE MAINTENANCE PROGRAM TO BE STARTED WHICH WILL
	PROVIDE DOWN-LINE LOADING AND CONTROL CAPABILITY.

	CHARACTERS TO BE PRINTED ON THE CTY WILL REQUIRE SPEED BUFFERING
	TO CONVERT FROM THE KLINIK PORT AT 9600 BAUD TO THE CTY AT
	300 BAUD.

	MODE 4 TURNED ON BY TYPING "MM" WHILE IN MODE 1.
	THEREAFTER, THE 8080 CONSOLE PROGRAM WILL ONLY RECOGNIZE
	"CNTRL-Y", WHICH WILL PUT YOU BACK INTO MODE 1..

	ANY CHARACTERS TYPED ON THE CTY WILL BE SENT DIRECTLY, AS IS,
	TO THE KLINIK LINE. ALL CHARACTERS FROM THE KLINIK LINE (NOT
	IN PROTOCOL FORMAT) WILL BE TYPED DIRECTLY ON THE CTY.

	CHARACTERS IN "MAINTENANCE MODE PROTOCOL" WILL COME DOWN
	THE KLINIK LINE IN LOGICAL PACKETS OF UP TO 132 CHARS
	PLUS 5 OTHER CHARS, REPRESENTING 2 SYNCS, A MSG NUMBER,
	1 CHECK CHAR, AND 1 TERMINATING CHAR.

	THESE CHARS WILL BE PLACED IN THE 8080 RAM AND AT THE END OF
	A MAINTENANCE MODE PROTOCOL BLOCK, THESE CHARS WILL BE
	TREATED AS A CHAR INPUT STREAM FROM THE "LOGICAL CTY" AND
	THEY WILL BE EXECUTED BY THE 8080 AS IF THEY WERE A
	COMMAND STRING.

	DATA OUTPUT BY THE 8080 IN RESPONSE TO A COMMAND FROM THE HOST
	SYSTEM WILL BE TRANSMITTED IN "MAINTENANCE MODE PROTOCOL".
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	AFTER COMPLETION OF EXECUTION OF THIS COMMAND STRING BY THE
	8080, THE 8080 WILL SEND AN "ACKNOWLEDGE" TO THE HOST SYSTEM.

	IF UPON RECEIPT, THE CHECK CHAR PROCESS DETECTS AN ERROR THE
	COMMAND STRING WILL BE REJECTED AND A "NEGATIVE ACKNOWLEDGE"
	SENT TO THE HOST SYSTEM.

	IF A "CONTROL-Y" IS TYPED DURING THIS
	MODE THE "CONTROL-Y" WILL BE SENT TO THE HOST
	SYSTEM TO ABORT THE PRESENT SEQUENCE OF OPERATIONS.

	FOR THE HOST TO CAUSE PRINTING ON THE 8080 CTY IT WILL SEND
	COMMAND MESSAGES USING THE FOLLOWING FORMAT:

		"SYN SYN # CK ;  'CHARS'  LF CR"
5.	MODE 5) KS-10 MAINTENANCE MODE
	------------------------------

	IN THIS MODE ALL DATA FROM THE KLINIK LINE WILL BE PASSED TO
	THE KS-10 VIA WORD 34 (KLINIK USER INPUT WORD).
	DATA OUTPUT FROM THE KS-10 INTENDED FOR THE KLINIK LINE WILL
	BE VIA WORD 35 (KLINIK USER OUTPUT WORD).

	DATA TYPED ON THE CTY WILL BE PASSED TO THE KLINIK LINE WITHOUT
	ANY ACTION BY THE 8080.

	IF CHAR TYPED ON CTY, THE 8080 WILL SEND THE CHAR OUT THE KLINIK
	LINE TO THE HOST, THE HOST WILL ECHO THE CHAR BACK ON THE KLINIK
	LINE, THE 8080 WILL SEND THE CHAR TO THE KS-10 IN THE KLINIK
	INPUT WORD, THE KS-10 WILL THEN PRINT THE CHAR ON THE CTY.

	CHARS FROM THE KLINIK LINE IN NON-PROTOCOL MODE WILL BE SENT TO
	THE KS-10 VIA THE KLINIK INPUT WORD, THE KS-10 WILL THEN PRINT
	THE CHAR ON THE CTY.

	CHARS FROM THE KLINIK LINE IN PROTOCOL MODE WILL BE SENT TO THE
	KS-10 VIA THE KLINIK INPUT WORD, THE KS-10 WILL DO THE REQUIRED
	ACTION AND THEN ACKNOWLEDGE THE COMMAND VIA THE KLINIK LINE.

	THIS MODE WILL BE ENABLED FROM MODE 4 (8080 MAINTENANCE MODE)
	BY:

	A "control-z" --OR--
	A "ST XX" (START COMMAND) --OR--
	A "CO" (CONTINUE COMMAND)

	ANY COMMAND THAT CAUSES THE 8080 TO ENTER KS-10 MAINTENANCE
	MODE (USER MODE) WILL BE ACK'ED BEFORE BEING DONE.

	DISABLED BY "CONTROL-BACKSLASH" --OR--
	THE KS-10 HALTS --OR--
	ACTION IS REQUESTED BY THE KEEP-ALIVE WORD

	USES OF THE MAINTENANCE FEATURES
	--------------------------------

	"TTY" FOR CONNECTION TO A TIME-SHARING SYSTEM.
	"CSL" - ENHANCED HOST DIAGNOSTIC CONSOLE
	"APT" MANUFACTURING - DOWN LINE LOADING.
	"REMOTE" FIELD DIAGNOSIS - DOWN LINE LOADING.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------
	INTERPROCESSOR COMMUNICATIONS AREA
	----------------------------------

	WORD 31	- KEEP ALIVE AND STATUS WORD
	WORD 32 - KS-10 CTY INPUT WORD (FROM 8080)
	WORD 33 - KS-10 CTY OUTPUT WORD (TO 8080)
	WORD 34 - KS-10 KLINIK USER INPUT WORD (FROM 8080)
	WORD 35 - KS-10 KLINIK USER OUTPUT WORD (TO 8080)
	WORD 36 - BOOT RH-11 BASE ADDRESS
	WORD 37 - BOOT DRIVE NUMBER
	WORD 40 - MAGTAPE BOOT FORMAT & SLAVE #

	WORD 31 - KEEP ALIVE AND STATUS WORD
	-------

		BIT 4 - RELOAD
		BIT 5 - EXAMINE KEEP ALIVE
		BIT 6 - KLINIK ACTIVE
		BIT 7 - PARITY ERROR DETECT ENABLED
		BIT 8 - CRAM PAR ERR DETECT ENABLED
		BIT 9 - DP PAR ERR DETECT ENABLED
		BIT 10 - CACHE ENABLED
		BIT 11 - 1 MSEC ENABLED
		BIT 12 - TRAPS ENABLED
		BIT 13 - MAINTENANCE MODE

		BITS 20-27 - KEEP ALIVE

		RELOADS
		-------

		BIT 32 - BOOT SWITCH BOOT
		BIT 33 - POWER FAIL
		BIT 34 - FORCED RELOAD
		BIT 35 - KEEP ALIVE FAILED TO CHANGE
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	WORD 32 - KS-10 CTY INPUT WORD
	------------------------------

		BITS 20-27 = 0, NO ACTION
			   = 1, CTY CHAR

		BITS 28-35 = CTY CHAR

	WORD 33 - KS-10 CTY OUTPUT WORD
	-------------------------------

		BITS 20-27 = 0, NO ACTION
			   = 1, CTY CHAR

		BITS 28-35 = CTY CHAR

	WORD 34 - KS-10 KLINIK USER INPUT WORD
	--------------------------------------

		BITS 20-27 = 0, NO ACTION
			   = 1, KLINIK CHAR
			   = 2, KLINIK ACTIVE
			   = 3, CARRIER LOSS

		BITS 28-35 = KLINIK CHAR

	WORD 35 - KS-10 KLINIK USER OUTPUT WORD
	---------------------------------------

		BITS 20-27 = 0, NO ACTION
			   = 1, KLINIK CHAR
			   = 2, HANGUP REQUEST

		BITS 28-35 = KLINIK CHAR
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	OUTPUT PROCESS FROM KS-10 TO 8080
	---------------------------------

	1. KS-10, LOAD CHAR AND FLAG INTO OUTPUT WORD
	2. KS-10, SET 8080 INTERRUPT
	3. 8080, EXAMINES OUTPUT WORD TO GET CHAR
	4. 8080, CLEARS INTERRUPT
	5. 8080, SENDS CHAR TO OUTPUT HARDWARE
	6. 8080, WHEN OUTPUT HARDWARE READY AGAIN, CLEAR OUTPUT WORD
	7. 8080, SETS KS-10 INTERRUPT

	INPUT PROCESS FROM 8080 TO KS-10
	--------------------------------

	1. 8080, INTERRUPTED BY TTY CHAR AVAILABLE
	2. 8080, GET CHAR, SET FLAG PORTION OF WORD
	3. 8080, DEPOSIT INTO INPUT WORD
	4. 8080, SET KS-10 INTERRUPT

	CONTROL OF KLINIK LINE BY KS-10
	-------------------------------

	1. CLEAR DTR, I.E. HANG UP LINE

	KLINIK NOTIFICATION FROM 8080 TO KS-10
	--------------------------------------

	1. CARRIER LOSS
	2. STATUS ON START-UP, I.E. KLINIK ACTIVE (IN KEEP ALIVE WORD)

	CTY TO/FROM USER MODE SWITCHING
	-------------------------------

	1. CONTROL BACKSLASH - REVERT TO 8080 CTY MODE AND IGNORE 10.
	2. TT - RETURN TO USER MODE

	IF CONTROL BACKSLASH TYPED ON CTY & KLINIK NOT ENABLED BY 8080,
	KLINIK IS IGNORED BUT PICKED BACK UP WHEN "TT" TYPED.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	CONSOLE COMMANDS
	----------------

	1. ENABLE KLINIK (KL 1)

		ALLOWS CTY AND KLINIK TO BE OR'D TOGETHER CTY.

	2. DISABLE KLINIK (KL 0)

		DISABLES KLINIK CTY CAPABILITY.

	3. PASSWORD (PW)

		TO IMPROVE THE SECURITY OF THE KLINIK LINE IT IS
		NECESSARY TO HAVE A PASSWORD COMMAND AND VERIFICATION BY
		THE 8080. THIS FACILITY SHOULD BE AS SIMPLE AS POSSIBLE.

		WHEN THE KLINIK USER DIALS THE KLINIK LINE THE 8080 WILL
		TYPE ONE OF THE TWO FOLLOWING MESSAGES:

			A. ?NA
			B. PW:

		IF THE PASSWORD IS NOT CORRECTLY TYPED THE 8080 WILL
		TYPE "PW:" AGAIN AND ALLOW FOR THREE TRIES.
		ONCE THE PASSWORD HAS BEEN CORRECTLY TYPED THE KLINIK
		LINE WILL ENTER MODE 3 (KLINIK USER).

		THE 8080 WILL THEN SET THE "KLINIK ACTIVE" BIT IN THE
		STATUS WORD (WORD 31) AND NOTIFY THE KS-10 BY SETTING
		THE APPROPRIATE COMMAND CODE IN THE KLINIK INPUT
		WORD AND SETTING THE KS-10 INTERRUPT.

		TO GET TO MODE 2 (PARALLEL CTY) THE PROPER CTY
		ENABLE COMMAND MUST HAVE BEEN DONE AND THE KLINIK
		USER TYPES "CONTRL-BACKSLASH".

		THE "PW AAAAAA" COMMAND PERMITS THE PASSWORD TO BE
		SET TO ENABLE KLINIK.
		THE KLINIK USER WILL BE REQUIRED TO CORRECTLY TYPE
		IN THE PASSWORD (THREE TRIES) BEFORE MODE 1 OR MODE 2
		PRIVILEDGES WILL BE ALLOWED OVER THE KLINIK LINE.
		THE PASSWORD WILL BE UP TO 6 CHARS.

	4. MAINTENANCE MODE (MM)

		ALLOWS CTY TO USE KLINIK LINE TO CONNECT TO REMOTE
		SYSTEM.

		CTY PROVIDES COMMANDS TO THE REMOTE HOST SYSTEM TO
		CAUSE IT TO PERFORM MAINTENANCE OPERATIONS.

		"CONTROL-Y" TYPED ON CTY WILL PUT CTY BACK INTO
		NORMAL CTY MODE.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	NOTES:
	------

	DUE TO THE SINGLE INTERRUPT CAPABILITY OF THE 8080 TO/FROM
	KS-10, IT IS UP TO THE KS-10 TO PROCESS INTERRUPTS AT THE
	HIGHEST PRIORITY AND FOR THE KS-10 INTERRUPT PROCESS TO HAVE
	SUFFICIENT SPEED SO THAT INTERRUPT OVERRUNS DO NOT OCCUR.

	INTERRUPTS TO THE 8080 FROM THE KS-10 ARE NO PROBLEM AS THE 8080
	MUST ACCEPT OUTPUT AND NOTIFY THE KS-10 WHEN IT CAN PROCEED TO
	THE NEXT OPERATION.

	CTY & USER KLINIK MODES WHEN THE KS-10 IS RUNNING WILL BE
	HANDLED BY CODE IN THE KS-10.
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

	8080 MAINTENANCE MODE PROTOCOLLED OPERATION
	-------------------------------------------

1.	THIS CONSISTS OF TWO TYPES OF MESSAGES, ONE - COMMAND LINES AND
	TWO - CONTROL SEQUENCES.

2.	COMMAND LINES
	-------------

	A COMMAND LINE CONSISTS OF UP TO 132 CHARS OF MESSAGE WITH THE
	FOLLOWING PROTOCOL INFORMATION.

	SYNC		;TO SYNC LINE AND ELIMINATE INTER-LINE NOISE
	SYNC		;CHAR 001 USED IN APT-10

	MESSAGE #	;A SIMPLE CHAR TO DIFFERENTIATE MSG LINES
			;CHARS 041 & 136 USED IN APT-10
			;CHAR 136 = EVEN MESSAGES, FIRST MSG = EVEN
			;CHAR 041 = ODD MESSAGES

	CHECK CHAR	;A NEGATED 6 BIT ASCIIZED CHAR WHICH PRODUCES
			;A ZERO LO 6 BIT SUM WHEN ADDED TO CHARS 1-132
	CHAR 1
	  -
	  -
	CHAR 132	;A MAXIMUM OF 132 CHARS PER LINE

	CARRIAGE RETURN	;SIGNIFIES COMMAND MESSAGE SEGMENT
			; & MESSAGE TERMINATOR
		DECSYSTEM 2020 KLINIK SPECIFICATION
		-----------------------------------

3.	CONTROL SEQUENCE
	-----------------

	A CONTROL SEQUENCE IS USED FOR COMMUNICATION CONTROL AND
	CONSISTS OF A CONTROL CHAR AND AN ALTMODE.

	A.	ACKNOWLEDGE
		-----------

		A	;A CHAR
		$	;ALTMODE

		USED TO SIGNIFY CORRECT RECEPTION AND COMPLETION OF
		COMMAND MESSAGE LINE.

	B.	NEGATIVE ACKNOWLEDGE
		--------------------

		N	;N CHAR
		$	;ALTMODE

		USED TO SIGNIFY COMMAND MESSAGE CHECKSUM ERROR, HOST
		SYSTEM WILL RETRANSMIT COMMAND LINE.