diff defs/scfdefs @ 1200:0a678473d5cf

Major overhaul of headers to 'new' style
author boisy
date Mon, 02 Jun 2003 20:42:40 +0000
parents 903ccb6c06cf
children cfc38fcd72d7
line wrap: on
line diff
--- a/defs/scfdefs	Mon Jun 02 19:56:05 2003 +0000
+++ b/defs/scfdefs	Mon Jun 02 20:42:40 2003 +0000
@@ -2,27 +2,53 @@
 
 SCFDEFS  set   1
 
-         nam   SCFDefs
-         ttl   Sequential File Manager (SCF) Definitions
-
-*****************
-* Edition History
+********************************************************************
+* SCFDefs - Sequential Character File Manager Definitions
+*
+* $Id$
+*
+* SCF stands for 'Sequential Character Filemanager' and is a package of subroutines
+* that define the logical structure of a serial device.
+*
+* The data structures in this file give SCF its 'personality' and are used
+* by SCF itself, as well as applications that will require disk I/O.
+*
+* Edt/Rev  YYYY/MM/DD  Modified by
+* Comment
+* ------------------------------------------------------------------
+*          1984/01/11  YO
+* Added V.KANJI, V.KBUF, V.MODADR for new kanji input process.
 *
-* Date     Changes Made                                                 by
-* -------- ------------------------------------------------------------ ---
-* 84/01/11 Added V.KANJI, V.KBUF, V.MODADR for new kanji input process  Y.O
-* 85/04/20 Added V.PDLHd Path Descriptor List Head                      MGH
-* 85/04/21 Added PD.PLP and PD.PST for modem handling                   MGH
-* 87/06/23 Updated with Dev Desc info                                   KKD
-* 98/10/03 Consolidated L1/L2 scfdefs                                   BGP
-* 03/01/21 Added symbolics for enhanced SCF line editing                BGP
+*          1985/04/20  Mark G. Hawkins
+* Added V.PDLHd Path Descriptor List Head.
+*
+*          1985/04/21  Mark G. Hawkins
+* Added PD.PLP and PD.PST for modem handling.
+*
+*          1987/06/23  Kevin K. Darling
+* Updated with Dev Desc info.
+*
+*          1998/10/03  Boisy G. Pitre
+* Consolidated L1/L2 scfdefs.
+*
+*          2003/01/21  Boisy G. Pitre
+* Added symbolics for enhanced SCF line editing.
+*
+*          2003/06/02  Boisy G. Pitre
+* Updated comments for clarity.
+
+         nam   SCFDefs
+         ttl   Sequential File Manager Definitions
 
 
+         pag
 *******************************
 * SCF Device Descriptor Offsets
 *
+* These definitions are for SCF device descriptors.
+
          org   M$DTyp
-IT.DVC   rmb   1          Device class
+IT.DVC   rmb   1          Device type (DT.SCF)
 IT.UPC   rmb   1          Uppercase flag
 IT.BSO   rmb   1          Backspace behavior
 IT.DLO   rmb   1          Delete behavior
@@ -65,10 +91,12 @@
 IT.BDC   rmb   1          Border color default
          ENDC
 
+
          pag
-************************************************************
-* Static storage requirements
-* SCF Devices must reserve this space for SCF
+********************
+* SCF Static Storage
+*
+* SCF devices must reserve this space for SCF
 *
          org   V.USER
 V.TYPE   rmb   1          Device type or parity
@@ -88,16 +116,18 @@
 V.RSV    rmb   5          Reserve bytes for future expansion
 V.SCF    equ   .          Total SCF manager static overhead
 
+
+         pag
 ***********************
 * Character Definitions
 *
 C$NULL   set   0          Null char
-C$RPET   set   $01        (ctl A - SOH) Repeat last input line
-C$INTR   set   $03        (ctl C - ETX) Keyboard interrupt
-C$RPRT   set   $04        (ctl D - EOT) Reprint current input line
-C$QUIT   set   $05        (ctl E - ENQ) Keyboard Abort
-C$BELL   set   $07        (ctl G - BEL) Line overflow warning
-C$BSP    set   $08        (ctl H - BS ) Back space
+C$RPET   set   $01        (CTRL-A - SOH) Repeat last input line
+C$INTR   set   $03        (CTRL-C - ETX) Keyboard interrupt
+C$RPRT   set   $04        (CTRL-D - EOT) Reprint current input line
+C$QUIT   set   $05        (CTRL-E - ENQ) Keyboard Abort
+C$BELL   set   $07        (CTRL-G - BEL) Line overflow warning
+C$BSP    set   $08        (CTRL-H - BS ) Back space
 C$RARR   set   $09        Right Arrow
 C$EL     set   $05        Erase Line
 C$LF     set   $0A        Line feed
@@ -105,18 +135,18 @@
 C$Clsgr  set   $15        Graphic screen clear (use FM-11)
 C$Clsall set   $16        Graphic & character clear (use FM-11)
 C$CR     set   $0D        Carriage return
-C$FORM   set   $0C        (ctl L - FF ) Form Feed ... screen clear
+C$FORM   set   $0C        (CTRL-L - FF ) Form Feed ... screen clear
 C$SI     set   $0F        Shift IN Code
 C$SO     set   $0E        Shift OUT Code
 C$DELETE set   $10        Delete char (for SCF enhanced line editing)
-C$XON    set   $11        (ctl Q - DC1) Transmit Enable
+C$XON    set   $11        (CTRL-Q - DC1) Transmit Enable
 C$INSERT set   C$XON      Insert char (for SCF enhanced line editing)
-C$XOFF   set   $13        (ctl S - DC3) Transmit Disable
+C$XOFF   set   $13        (CTRL-S - DC3) Transmit Disable
 C$PLINE  set   C$XOFF     Print remaining line (for SCF enhanced line editing)
-C$PAUS   set   $17        (ctl W - ETB) Pause character
-C$DEL    set   $18        (ctl X - CAN) Delete line
+C$PAUS   set   $17        (CTRL-W - ETB) Pause character
+C$DEL    set   $18        (CTRL-X - CAN) Delete line
 C$SHRARR set   $19        Shift Right-Arrow
-C$EOF    set   $1B        (ctl [ - ESC) END of file
+C$EOF    set   $1B        (CTRL-[ - ESC) END of file
 C$RGT    set   $1C        Cursor right
 C$LFT    set   $1D        Cursor left
 C$UP     set   $1E        Cursor up
@@ -125,58 +155,61 @@
 C$PERD   set   '.
 C$COMA   set   ',
 
+
          pag
-*************************
-* FILE DESCRIPTOR OFFSETS
+*********************************************
+* Sequential Character Path Descriptor Format
+*
+* A path descriptor is created for every new path that is open
+* via the I$Open system call (processed by IOMan).  Process
+* descriptors track state information of a path.
 *
          org   PD.FST
-PD.DV2   rmb   2          OUTPUT DEV TBL PTR
-PD.RAW   rmb   1          READ/WRITE OR RDLIN/WRLIN MODE
-PD.MAX   rmb   2          READLINE HIGH BYTE COUNT
-PD.MIN   rmb   1          DEVICES ARE "MINE" IF CLEAR
+PD.DV2   rmb   2          Output device table pointer
+PD.RAW   rmb   1          Read/Write or ReadLn/WritLn mode
+PD.MAX   rmb   2          ReadLn high byte count
+PD.MIN   rmb   1          Devices are "mine" if clear
 PD.STS   rmb   2          Status routine module addr
-PD.STM   rmb   2          Reserved for Status routine
+PD.STM   rmb   2          Reserved for status routine
          org   PD.OPT
-         rmb   1          DEVICE TYPE
-PD.UPC   rmb   1          CASE (0=BOTH, 1=UPPER ONLY)
-PD.BSO   rmb   1          BACKSP (0=BSE, 1=BSE,SP,BSE)
-PD.DLO   rmb   1          DELETE (0=BSE OVER LINE, 1=CRLF)
-PD.EKO   rmb   1          ECHO (0=NO ECHO)
-PD.ALF   rmb   1          AUTOLF (0=NO AUTO LF)
-PD.NUL   rmb   1          END of LINE NULL COUNT
-PD.PAU   rmb   1          PAUSE (0=NO END of PAGE PAUSE)
-PD.PAG   rmb   1          LINES PER PAGE
-PD.BSP   rmb   1          BACKSPACE charACTER
-PD.DEL   rmb   1          DELETE LINE charACTER
-PD.EOR   rmb   1          END of RECORD char (READ ONLY)
-PD.EOF   rmb   1          END of FILE char
-PD.RPR   rmb   1          REPRINT LINE char
-PD.DUP   rmb   1          DUP LAST LINE char
-PD.PSC   rmb   1          PAUSE char
-PD.INT   rmb   1          KBD INTR char (ctl c)
-PD.QUT   rmb   1          KBD QUIT char (ctl q)
-PD.BSE   rmb   1          BACKSPACE ECHO charACTER
-PD.OVF   rmb   1          LINE OVERFLOW char (BELL)
-PD.PAR   rmb   1          PARITY CODE
-PD.BAU   rmb   1          ACIA BAUD RATE (Color Computer)
-PD.D2P   rmb   2          OFFSET of DEV2 name
-PD.XON   rmb   1          ACIA X-ON char
-PD.XOFF  rmb   1          ACIA X-OFF char
+         rmb   1          Device type
+PD.UPC   rmb   1          Case (0=both, 1=upper only)
+PD.BSO   rmb   1          Backspace (0=BSE, 1=BSE,SP,BSE)
+PD.DLO   rmb   1          Delete (0=BSE over line, 1=CRLF)
+PD.EKO   rmb   1          Echo (0=No Echo)
+PD.ALF   rmb   1          Auto linefeed (0=No auto LF)
+PD.NUL   rmb   1          End of Line null count
+PD.PAU   rmb   1          Page pause (0=No end of page pause)
+PD.PAG   rmb   1          Lines per page
+PD.BSP   rmb   1          Backspace character
+PD.DEL   rmb   1          Delete Line character
+PD.EOR   rmb   1          End of Record character (read only)
+PD.EOF   rmb   1          End of File character
+PD.RPR   rmb   1          Repront Line character
+PD.DUP   rmb   1          Dup Last Line character
+PD.PSC   rmb   1          Pause character
+PD.INT   rmb   1          Keyboard interrupt character (CTRL-C)
+PD.QUT   rmb   1          Keyboard quit character (CTRL-E)
+PD.BSE   rmb   1          Backspace echo character
+PD.OVF   rmb   1          Line overflow character (BELL)
+PD.PAR   rmb   1          Parity code
+PD.BAU   rmb   1          ACIA baud rate (Color Computer)
+PD.D2P   rmb   2          Offset of DEV2 name
+PD.XON   rmb   1          ACIA X-ON character
+PD.XOFF  rmb   1          ACIA X-OFF character
 OPTCNT   equ   .-PD.OPT   Total user settable options
 PD.ERR   rmb   1          Most recent I/O error status
-PD.TBL   rmb   2          Device Table addr (copy)
+PD.TBL   rmb   2          Device table addr (copy)
 PD.PLP   rmb   2          Path Descriptor List Pointer
-PD.PST   rmb   1          Current Path Status
+PD.PST   rmb   1          Current path status
 
-********************************************
+
 * PD.PST values Path Descriptor Status byte
 *
 PST.DCD  equ   %00000001  Set if DCD is lost on Serial port
 
-         pag
-************************************************************
-*
-*     SCF PD.PAR definitions
+
+* PD.PAR definitions
 *
 * Baud rate
 B110     equ   0