[kermit-80.git] / cpxlnk.asm

; CPXLNK.ASM\r
;       KERMIT - (Celtic for "FREE")\r
;\r
;       This is the CP/M-80 implementation of the Columbia University\r
;       KERMIT file transfer protocol.\r
;\r
;       Version 4.0\r
;\r
;       Copyright June 1981,1982,1983,1984\r
;       Columbia University\r
;\r
; Originally written by Bill Catchings of the Columbia University Center for\r
; Computing Activities, 612 W. 115th St., New York, NY 10025.\r
;\r
; Contributions by Frank da Cruz, Daphne Tzoar, Bernie Eiben,\r
; Bruce Tanner, Nick Bush, Greg Small, Kimmo Laaksonen, Jeff Damens, and many\r
; others. \r
;\r
;       This file describes the areas used to communicate between KERMIT\r
;       and the customizing overlay.  It is included by the overlay.\r
;       This file should be changed only to reflect changes in the\r
;       system-independent portion of Kermit (enhancements, I hope).\r
;\r
; revision history:\r
;edit 8, 14-Sep-1990 by MF.  Added variable "incflg" to hold incomplete-\r
;	file status for SET INCOMPLETE-FILES command.\r
; edit 7: 8 April, 1987 by OBSchou.  Added a new entry EXTERN to leap off to\r
;	code written by the user to emulate any terminal they want.  All \r
;	characters are sent here in stead of conout during connect state.  \r
;	In due course, Ill trap all prtstrs and dconio as well.\r
;\r
; edit 6: May 30, 1986 by OBSchou.  Added two more entries to the link area:\r
;       first to point to a "family" string giving the family name of the \r
;       system.  If the older CP4SYS.ASM still has the code, then the \r
;       string is null.  Secondly, a JMP to give printer status (should be \r
;       a BIOS function).  If 0 then printer is ready, if 0ffh then printer \r
;       busy.  This makes version 4.07 incompatable with 4.05\r
;\r
; edit 5: February 6, 1985\r
;       Added a storage variable, "PORT", for the port-in-use value \r
;       required for the port status routine (same purpose as SPEED).\r
;       Also moved the printer copy flag (PRNFLG:) into the commun-\r
;       ications storage area so machine dependant overlay can access it.\r
;       [Hal Hostetler]\r
;       Also, replace assembly-time conditional "ffussy" with run-time\r
;       switch (CJC).\r
;\r
; edit 4: August 21, 1984 (CJC)\r
;       Define a use for the third word of the linkage section: it points\r
;       to the version string for CP4SYS.ASM.  Add flsmdm, to flush comm line\r
;       on startup.  Add bufadr and bufsec for multiple-sector buffer support.\r
;       Shift the entry section up two bytes so we can exit cleanly from DDT.\r
;\r
; edit 3: August 3, 1984 (CJC)\r
;       put "mover" in CP4SYS, so we can do a Z80 block move if so inclined.\r
;\r
; edit 2: July 10, 1984 (CJC)\r
;       integrate Toad Hall changes for LASM compatibility: CP4LNK is linked\r
;       by CP4DEF, and links CP4SYS.\r
;\r
; edit 1: May, 1984 (CJC)\r
;       extracted from CPMBASE.M80 version 3.9; modifications are described\r
;       in the accompanying .UPD file.\r
;\r
\r
;       Define the entry section.  These addresses contain jumps to\r
;       useful routines in KERMIT.  To show we know what we're doing,\r
;       we store the length of this section (entsiz) in our linkage\r
;       section.  I didn't use ORG and DS because I don't want zeroes\r
;       generated for all the space between here and the actual start\r
;       of cp4sys.\r
entry	equ	105H	; start of entry section\r
kermit	equ	entry+0	; reentry address\r
nout	equ	entry+3	; output HL in decimal\r
entsiz	equ	2*3	; 2 entries, so far.\r
;\r
;       End of entry section.\r
;\r
;       Linkage section.  This block (through the definition of lnksiz)\r
;       is used by Kermit to reach the routines and data in the overlay.\r
;       The section length is stored at the beginning of the overlay\r
;       area so Kermit can verify that the overlay section is (a) present,\r
;       (b) in the right place, and (c) the same size as (and therefore\r
;       presumably the same as) the linkage section Kermit is expecting.\r
;\r
	ASEG\r
	ORG	OVLADR\r
;\r
lnkflg:	dw	lnksiz	; linkage information for consistency check.\r
	dw	entsiz	; length of entry table, for same.\r
	dw	swtver	; address of switcher.  CPXSYS now a family\r
	dw	family	;*NEW* for V4.08. Address of the family string\r
;\r
;       hooks for system-dependent routines:\r
;\r
; Input/output routines. \r
;\r
	jmp	selmdm	; select modem for I/O\r
	jmp	outmdm	; output character in E to modem\r
	jmp	inpmdm	; read character from modem. return character or 0 in A.\r
	jmp	flsmdm	; flush pending input from modem\r
	jmp	selcon	; select console for I/O\r
	jmp	outcon	; output character in E to console\r
	jmp	inpcon	; read char from console. return character or 0 in A\r
	jmp	outlpt	; output character in E to printer\r
	jmp	lptstat	;*NEW*  get the status for the printer. \r
			; 0=>ok, 0ffh=> not ok\r
	jmp	0	;*NEW for 4.09* Terminal Emulation code (optional)\r
			; If terminal is set to EXTERNAL and this address\r
			; has been filled, then user uses their own code.\r
xbdos:	jmp	0	;*NEW* Address of the BDOS trap in the independent \r
			; code. Use this enty for BDOS calls if you want \r
			; the printer handler to work properly.\r
\r
; screen formatting routines\r
	jmp	clrlin	; erase current line\r
	jmp	clrspc	; erase current position (after backspace)\r
	jmp	delchr	; make delete look like backspace\r
	jmp	clrtop	; erase screen and go home\r
;\r
; these routines are called to display a field on the screen.\r
	jmp	scrend	; move to prompt field\r
	jmp	screrr	; move to error message field\r
	jmp	scrfln	; move to filename field\r
	jmp	scrnp	; move to packet count field\r
	jmp	scrnrt	; move to retry count field\r
	jmp	scrst	; move to status field\r
	jmp	rppos	; move to receive packet field (debug)\r
	jmp	sppos	; move to send packet field (debug)\r
;\r
	jmp	sysinit	; program initialization\r
	jmp	sysexit	; program termination\r
	jmp	syscon	; remote session initialization\r
	jmp	syscls	; return to local command level\r
	jmp	sysinh	; help text for interrupt (escape) extensions\r
	jmp	sysint	; interrupt (escape) extensions, including break\r
	jmp	sysflt	; filter for incoming characters.\r
			;  called with character in E.\r
	jmp	sysbye	; terminate remote session\r
	jmp	sysspd	; baud rate change routine.\r
			; called with value from table in DE\r
	jmp	sysprt	; port change routine.\r
			; called with value from table in HL\r
	jmp	sysscr	; screen setup for file transfer\r
			; called with Kermit's version string in DE\r
	jmp	csrpos	; move cursor to row B, column C\r
	jmp	sysspc	; calculate free space for current drive\r
	jmp	mover	; do block move\r
	jmp	prtstr	; *** NEW *** Link from system indep equivalent\r
;\r
;       Local parameter values\r
;\r
pttab:	dw	ttab	; points to local equivalents to VT52 escape sequences\r
spdtab:	dw	spdtbl	; address of baud rate command table, or zero\r
spdhlp:	dw	sphtbl	; address of baud rate help table, or zero\r
prttab:	dw	prttbl	; address of port command table, or zero\r
prthlp:	dw	prhtbl	; address of port help table, or zero\r
timout:	dw	fuzval	; Fuzzy timeout.\r
vtflg:	db	vtval	; VT52 emulation flag\r
escchr:	db	defesc	; Storage for the escape character.\r
speed:	dw	0FFFFH	; storage for the baud rate (initially unknown)\r
port:	dw	0FFFFH	; storage for port value (initially unknown) [hh]\r
prnflg:	db	0	; printer copy flag [hh]\r
dbgflg:	db	0	; debugging flag\r
ecoflg:	db	0	; Local echo flag (default off).\r
flwflg:	db	1	; File warning flag (default on).\r
ibmflg:	db	0	; IBM flag (default off).\r
cpmflg:	db	0	;[bt] file-mode flag (default is DEFAULT)\r
incflg:	db	0		;[MF]incomplete-file flag (default is DISCARD)\r
parity:	db	defpar	; Parity.\r
spsiz:	db	dspsiz	; Send packet size.\r
rpsiz:	db	drpsiz	; Receive packet size.\r
stime:	db	dstime	; Send time out.\r
rtime:	db	drtime	; Receive time out.\r
spad:	db	dspad	; Send padding.\r
rpad:	db	drpad	; Receive padding.\r
spadch:	db	dspadc	; Send padding char.\r
rpadch:	db	drpadc	; Receive padding char.\r
seol:	db	dseol	; Send EOL char.\r
reol:	db	dreol	; Receive EOL char.\r
squote:	db	dsquot	; Send quote char.\r
rquote:	db	drquot	; Receive quote char.\r
chktyp:	db	dschkt	; Checksum type desired\r
tacflg:			; TACtrap status:\r
IF	tac\r
	db	tacval	; when non-zero, is current TAC intercept character;\r
ENDIF;tac\r
IF	NOT tac\r
	db	0	; when zero, TACtrap is off.\r
ENDIF;tac\r
tacchr:	db	tacval	; Desired TAC intercept character (even when off)\r
bufadr:	dw	buff	; Address of possibly multi-sector buffer for I/O\r
bufsec:	db	1	; Number of sectors big buffer can hold (0 means 256)\r
ffussy:	db	1	; if nonzero, don't permit <>.,;?*[] in CP/M filespec.\r
; space used by directory command; here because space calculation is\r
;  (operating) system-dependent\r
bmax:	ds	2	; highest block number on drive\r
bmask:	ds	1	; (records/block)-1\r
bshiftf: ds	1	; number of shifts to multiply by rec/block\r
nnams:	ds	1	; counter for filenames per line\r
\r
lnksiz	equ	$-lnkflg ; length of linkage section, for consistency check.\r
\r
IF lasm			; If we're assembling with LASM,\r
	LINK	CPXCOM	;  get the next section.\r
ENDIF;lasm\r
Commit	Line	Data
e58a7a25 L	1	; CPXLNK.ASM\r
	2	; KERMIT - (Celtic for "FREE")\r
	3	;\r
	4	; This is the CP/M-80 implementation of the Columbia University\r
	5	; KERMIT file transfer protocol.\r
	6	;\r
	7	; Version 4.0\r
	8	;\r
	9	; Copyright June 1981,1982,1983,1984\r
	10	; Columbia University\r
	11	;\r
	12	; Originally written by Bill Catchings of the Columbia University Center for\r
	13	; Computing Activities, 612 W. 115th St., New York, NY 10025.\r
	14	;\r
	15	; Contributions by Frank da Cruz, Daphne Tzoar, Bernie Eiben,\r
	16	; Bruce Tanner, Nick Bush, Greg Small, Kimmo Laaksonen, Jeff Damens, and many\r
	17	; others. \r
	18	;\r
	19	; This file describes the areas used to communicate between KERMIT\r
	20	; and the customizing overlay. It is included by the overlay.\r
	21	; This file should be changed only to reflect changes in the\r
	22	; system-independent portion of Kermit (enhancements, I hope).\r
	23	;\r
	24	; revision history:\r
	25	;edit 8, 14-Sep-1990 by MF. Added variable "incflg" to hold incomplete-\r
	26	; file status for SET INCOMPLETE-FILES command.\r
	27	; edit 7: 8 April, 1987 by OBSchou. Added a new entry EXTERN to leap off to\r
	28	; code written by the user to emulate any terminal they want. All \r
	29	; characters are sent here in stead of conout during connect state. \r
	30	; In due course, Ill trap all prtstrs and dconio as well.\r
	31	;\r
	32	; edit 6: May 30, 1986 by OBSchou. Added two more entries to the link area:\r
	33	; first to point to a "family" string giving the family name of the \r
	34	; system. If the older CP4SYS.ASM still has the code, then the \r
	35	; string is null. Secondly, a JMP to give printer status (should be \r
	36	; a BIOS function). If 0 then printer is ready, if 0ffh then printer \r
	37	; busy. This makes version 4.07 incompatable with 4.05\r
	38	;\r
	39	; edit 5: February 6, 1985\r
	40	; Added a storage variable, "PORT", for the port-in-use value \r
	41	; required for the port status routine (same purpose as SPEED).\r
	42	; Also moved the printer copy flag (PRNFLG:) into the commun-\r
	43	; ications storage area so machine dependant overlay can access it.\r
	44	; [Hal Hostetler]\r
	45	; Also, replace assembly-time conditional "ffussy" with run-time\r
	46	; switch (CJC).\r
	47	;\r
	48	; edit 4: August 21, 1984 (CJC)\r
	49	; Define a use for the third word of the linkage section: it points\r
	50	; to the version string for CP4SYS.ASM. Add flsmdm, to flush comm line\r
	51	; on startup. Add bufadr and bufsec for multiple-sector buffer support.\r
	52	; Shift the entry section up two bytes so we can exit cleanly from DDT.\r
	53	;\r
	54	; edit 3: August 3, 1984 (CJC)\r
	55	; put "mover" in CP4SYS, so we can do a Z80 block move if so inclined.\r
	56	;\r
	57	; edit 2: July 10, 1984 (CJC)\r
	58	; integrate Toad Hall changes for LASM compatibility: CP4LNK is linked\r
	59	; by CP4DEF, and links CP4SYS.\r
	60	;\r
	61	; edit 1: May, 1984 (CJC)\r
	62	; extracted from CPMBASE.M80 version 3.9; modifications are described\r
	63	; in the accompanying .UPD file.\r
	64	;\r
65	\r
66	; Define the entry section. These addresses contain jumps to\r
67	; useful routines in KERMIT. To show we know what we're doing,\r
68	; we store the length of this section (entsiz) in our linkage\r
69	; section. I didn't use ORG and DS because I don't want zeroes\r
70	; generated for all the space between here and the actual start\r
71	; of cp4sys.\r
72	entry equ 105H ; start of entry section\r
73	kermit equ entry+0 ; reentry address\r
74	nout equ entry+3 ; output HL in decimal\r
75	entsiz equ 2*3 ; 2 entries, so far.\r
76	;\r
77	; End of entry section.\r
78	;\r
79	; Linkage section. This block (through the definition of lnksiz)\r
80	; is used by Kermit to reach the routines and data in the overlay.\r
81	; The section length is stored at the beginning of the overlay\r
82	; area so Kermit can verify that the overlay section is (a) present,\r
83	; (b) in the right place, and (c) the same size as (and therefore\r
84	; presumably the same as) the linkage section Kermit is expecting.\r
85	;\r
86	ASEG\r
87	ORG OVLADR\r
88	;\r
89	lnkflg: dw lnksiz ; linkage information for consistency check.\r
90	dw entsiz ; length of entry table, for same.\r
91	dw swtver ; address of switcher. CPXSYS now a family\r
92	dw family ;NEW for V4.08. Address of the family string\r
93	;\r
94	; hooks for system-dependent routines:\r
95	;\r
96	; Input/output routines. \r
97	;\r
98	jmp selmdm ; select modem for I/O\r
99	jmp outmdm ; output character in E to modem\r
100	jmp inpmdm ; read character from modem. return character or 0 in A.\r
101	jmp flsmdm ; flush pending input from modem\r
102	jmp selcon ; select console for I/O\r
103	jmp outcon ; output character in E to console\r
104	jmp inpcon ; read char from console. return character or 0 in A\r
105	jmp outlpt ; output character in E to printer\r
106	jmp lptstat ;NEW get the status for the printer. \r
107	; 0=>ok, 0ffh=> not ok\r
108	jmp 0 ;NEW for 4.09 Terminal Emulation code (optional)\r
109	; If terminal is set to EXTERNAL and this address\r
110	; has been filled, then user uses their own code.\r
111	xbdos: jmp 0 ;NEW Address of the BDOS trap in the independent \r
112	; code. Use this enty for BDOS calls if you want \r
113	; the printer handler to work properly.\r
114	\r
115	; screen formatting routines\r
116	jmp clrlin ; erase current line\r
117	jmp clrspc ; erase current position (after backspace)\r
118	jmp delchr ; make delete look like backspace\r
119	jmp clrtop ; erase screen and go home\r
120	;\r
121	; these routines are called to display a field on the screen.\r
122	jmp scrend ; move to prompt field\r
123	jmp screrr ; move to error message field\r
124	jmp scrfln ; move to filename field\r
125	jmp scrnp ; move to packet count field\r
126	jmp scrnrt ; move to retry count field\r
127	jmp scrst ; move to status field\r
128	jmp rppos ; move to receive packet field (debug)\r
129	jmp sppos ; move to send packet field (debug)\r
130	;\r
131	jmp sysinit ; program initialization\r
132	jmp sysexit ; program termination\r
133	jmp syscon ; remote session initialization\r
134	jmp syscls ; return to local command level\r
135	jmp sysinh ; help text for interrupt (escape) extensions\r
136	jmp sysint ; interrupt (escape) extensions, including break\r
137	jmp sysflt ; filter for incoming characters.\r
138	; called with character in E.\r
139	jmp sysbye ; terminate remote session\r
140	jmp sysspd ; baud rate change routine.\r
141	; called with value from table in DE\r
142	jmp sysprt ; port change routine.\r
143	; called with value from table in HL\r
144	jmp sysscr ; screen setup for file transfer\r
145	; called with Kermit's version string in DE\r
146	jmp csrpos ; move cursor to row B, column C\r
147	jmp sysspc ; calculate free space for current drive\r
148	jmp mover ; do block move\r
149	jmp prtstr ; * NEW * Link from system indep equivalent\r
150	;\r
151	; Local parameter values\r
152	;\r
153	pttab: dw ttab ; points to local equivalents to VT52 escape sequences\r
154	spdtab: dw spdtbl ; address of baud rate command table, or zero\r
155	spdhlp: dw sphtbl ; address of baud rate help table, or zero\r
156	prttab: dw prttbl ; address of port command table, or zero\r
157	prthlp: dw prhtbl ; address of port help table, or zero\r
158	timout: dw fuzval ; Fuzzy timeout.\r
159	vtflg: db vtval ; VT52 emulation flag\r
160	escchr: db defesc ; Storage for the escape character.\r
161	speed: dw 0FFFFH ; storage for the baud rate (initially unknown)\r
162	port: dw 0FFFFH ; storage for port value (initially unknown) [hh]\r
163	prnflg: db 0 ; printer copy flag [hh]\r
164	dbgflg: db 0 ; debugging flag\r
165	ecoflg: db 0 ; Local echo flag (default off).\r
166	flwflg: db 1 ; File warning flag (default on).\r
167	ibmflg: db 0 ; IBM flag (default off).\r
168	cpmflg: db 0 ;[bt] file-mode flag (default is DEFAULT)\r
169	incflg: db 0 ;[MF]incomplete-file flag (default is DISCARD)\r
170	parity: db defpar ; Parity.\r
171	spsiz: db dspsiz ; Send packet size.\r
172	rpsiz: db drpsiz ; Receive packet size.\r
173	stime: db dstime ; Send time out.\r
174	rtime: db drtime ; Receive time out.\r
175	spad: db dspad ; Send padding.\r
176	rpad: db drpad ; Receive padding.\r
177	spadch: db dspadc ; Send padding char.\r
178	rpadch: db drpadc ; Receive padding char.\r
179	seol: db dseol ; Send EOL char.\r
180	reol: db dreol ; Receive EOL char.\r
181	squote: db dsquot ; Send quote char.\r
182	rquote: db drquot ; Receive quote char.\r
183	chktyp: db dschkt ; Checksum type desired\r
184	tacflg: ; TACtrap status:\r
185	IF tac\r
186	db tacval ; when non-zero, is current TAC intercept character;\r
187	ENDIF;tac\r
188	IF NOT tac\r
189	db 0 ; when zero, TACtrap is off.\r
190	ENDIF;tac\r
191	tacchr: db tacval ; Desired TAC intercept character (even when off)\r
192	bufadr: dw buff ; Address of possibly multi-sector buffer for I/O\r
193	bufsec: db 1 ; Number of sectors big buffer can hold (0 means 256)\r
194	ffussy: db 1 ; if nonzero, don't permit <>.,;?*[] in CP/M filespec.\r
195	; space used by directory command; here because space calculation is\r
196	; (operating) system-dependent\r
197	bmax: ds 2 ; highest block number on drive\r
198	bmask: ds 1 ; (records/block)-1\r
199	bshiftf: ds 1 ; number of shifts to multiply by rec/block\r
200	nnams: ds 1 ; counter for filenames per line\r
201	\r
202	lnksiz equ $-lnkflg ; length of linkage section, for consistency check.\r
203	\r
204	IF lasm ; If we're assembling with LASM,\r
205	LINK CPXCOM ; get the next section.\r
206	ENDIF;lasm\r