Bitchin100 DocGarden - User contributions [en]

M100 TS-DOS ROM TPDD Protocol

2009-04-03T17:55:01Z

208.77.91.41:

== TS-DOS Model 100/102 ROM TPDD Protocol routines ==

<pre>
; =========================================================================================
; Flush the RX output buffer to the TPDD file
; =========================================================================================
46DDH LHLD FCCEH ; Get address of FD control
46E0H LXI B,0007H ; Load offset of write buffer length
46E3H DAD B ; Calculate address of write buffer length within FD control
46E4H MOV A,M ; Load the write buffer length
46E5H PUSH H ; Save pointer to write buffer length in FD control on stack
46E6H INX H ; Skip the LSB of the write buffer pointer
46E7H INX H ; Skip the MSB of the write buffer pointer
46E8H INX H ; Point to the actual data in the file write buffer
46E9H LXI D,FD04H ; DE points to the data area in RX buffer
46ECH MOV C,A ; Load buffer length into BC
46EDH MVI B,00H ; Make MSB of BC zero
46EFH PUSH PSW ; Save write buffer length to stack
46F0H CALL 4A05H ; Move BC bytes from M to (DE) with increment
46F3H POP PSW ; Retrieve write buffer length from stack
46F4H ANA A ; Test if write buffer is empty
46F5H CNZ 4095H ; Send TPDD Write File opcode using RX buffer with length in A if not empty
46F8H POP H ; Retrieve pointer to write buffer length in FD control from stack
46F9H MVI M,00H ; Set length of write buffer to zero - it is flushed
46FBH INX H ; Increment to address in FD control of write buffer
46FCH MOV D,H ; Save HL to DE for storage of new buffer pointer address
46FDH MOV E,L ; Save MSB of HL to DE
46FEH INX H ; Increment to MSB of address in FD conrol of write buffer
46FFH INX H ; Increment to actual write buffer address
4700H SHLX ; Save new write buffer pointer to FD control
4701H RET

; =========================================================================================
; Appears to be unused code
; =========================================================================================
4702H POP PSW
4703H RET

; =========================================================================================
; Display or print all disk files and free space
; =========================================================================================
4704H LXI H,F685H ; Keyboard buffer
4707H SHLD FCDBH ; Initialize pointer to File Length table
470AH CALL 4735H ; Clear #files displayed, init TPDD and send 1st file dir referene opode
470DH JNZ 486AH ; Communication Error
4710H XRA A ; Prepare to initialize "skip page" count to zero
4711H STA FCDAH ; Load the "skip page" count
4714H STA FCD4H ; Current Page of files being displayed
4717H DCR A ; Set A to 0xFF
4718H STA FCD7H ; Save as Page size to print (print 255 files per page)
471BH MVI A,01H ;
471DH STA F63AH ; ???
4720H CALL 4747H ; Get next page of files from server (NADSBox) with page size = 255
4723H JMP 4C23H ; Send CRLF to screen or printer

; =========================================================================================
; Display Disk free space on LCD at current position
; NOT CALLED!
; Old function - reporting of Free space was merged into the printing of the function
; key display routine.
; =========================================================================================
4726H CALL 4A10H ; Multiply TPDD free sectors len x 128 = free space
4729H CALL 4C3EH ; Print binary number in HL at current position
472CH LXI H,4AD1H ; Point to "0 Bytes free" text
472FH CALL 4A2CH ; Send buffer at M to screen
4732H JMP 4C23H ; Send CRLF to screen or printer

; =========================================================================================
; Clear #files displayed, init TPDD and send 1st file dir referene opode
; =========================================================================================
4735H XRA A ; Indicate zero files being displayed
4736H STA FCD6H ; Count of files on screen
4739H CALL 4943H ; Configure baud, test for NADSBox, get NADSBox dir
473CH LXI H,0146H ; Load code for "F" attribute and First File dir reference
473FH JMP 476FH ; Send Directory Reference opcode with HL=access mode

; =========================================================================================
; Get next page of files from server (NADSBox / TPDD)
; =========================================================================================
4742H MVI A,14H ; Maximum files that will fit on the display
4744H STA FCD7H ; Save for comparison of file count
4747H LDA FCCBH ; NADSBox / Desklink / TPDD2 flag
474AH ANA A ; Test if TPDD
474BH JNZ 4757H ; Skip 1st invocation of "Next file" if NADSBox or TPDD2??
474EH LXI H,02F6H ; Load access mode code for "Next entry" dir reference
4751H CALL 476FH ; Send Directory Reference opcode with HL=access mode
4754H JNZ 47F8H ; Check RX packet for Noraml Response & report errors
4757H LDA FD04H ; 1st filename byte
475AH ANA A ; Test if 1st filename byte is zero
475BH RZ ; Return if last file retrieved
475CH LDA FCDAH ; Load the "skip page" count
475FH ANA A ; Test if this is a "skip page"
4760H CZ 4781H ; Call routine to display file if not a skip page
4763H LXI H,FCD6H ; Count of files on screen
4766H INR M ; Increment #files displayed on LCD
4767H LDA FCD7H ; Load count of max files that will fit on LCD
476AH CMP M ; Compare with current file count
476BH JNZ 474EH ; Jump back to get next file from TPDD if not full
476EH RET

; =========================================================================================
; Send Directory Reference opcode with HL=access mode
; =========================================================================================
476FH SHLD FD00H ; Save file attrib and reference mode to TX buffer
4772H LXI H,1A00H ; Load code and length for Directory Reference opcode
4775H CALL 4822H ; Send TPDD Command/Len in HL
4778H CALL 47CCH ; Receive a packet
477BH LDA FD02H ; Storage for RX packet - response byte
477EH CPI 11H ; Test if response was 0x11 (valid Dir Ref response)
4780H RET

; =========================================================================================
; Print filename in RX buffer to LCD and save length info
; =========================================================================================
4781H MVI C,09H ; Prepare to draw 9 bytes of filename to LCD
4783H LXI H,FD04H ; Location of filename in RX packet
4786H CALL 48E5H ; Redraw C characters from buffer at HL using current video mode
4789H MVI A,20H ; Prepare to draw a trailing space
478BH RST 4 ; Send char in A to LCD
478CH LHLD FD1DH ; Get file size parameter from RX buffer
478FH MOV E,H ; Save file size LSB in E
4790H MOV D,L ; Save file size MSB in D

; =========================================================================================
; Store next file length to keyboard buffer
; =========================================================================================
4791H LHLD FCDBH ; Next storage location for file size info
4794H XCHG ; HL <--> DE
4795H SHLX ; Store file length at address of next file save
4796H XCHG ; HL <--> DE
4797H INX H ; Increment storage address of next file length
4798H INX H ; Increment again (2 byte length)
4799H SHLD FCDBH ; Save new address for lenght storage for next file
479CH RET

; =========================================================================================
; Receive an RX packet. This routine gets copied into RAM and executed from there while
; the Main ROM is selected. This allows the RX packet to be recieved without
; switching to and from the Main ROM to receive each individual byte. The jump
; addresses represent the RAM execution locations.
; =========================================================================================
479DH LXI H,FD02H ; Storage for RX packet
47A0H PUSH H ; Save start of packet address on stack
47A1H CALL FDB2H ; Get next byte from RX into HL
47A4H CALL FDB2H ; Get next byte from RX into HL
47A7H MOV C,A ; Move length byte into C
47A8H CALL FDB2H ; Get next byte from RX into HL
47ABH MOV B,C ; Move length byte to B
47ACH MOV A,C ; Move length byte to A for zero test
47ADH ANA A ; Test if length is zero
47AEH JZ FDA4H ; Skip reading payload if zero length
47B1H CALL FDB2H ; Get next byte from RX into HL
47B4H DCR C ; Decrement length byte
47B5H JNZ FD9DH ; Keep looping until all data received
47B8H POP H ; Restore start of RX packet address
47B9H INR B ; Add opcode byte to length for checksum
47BAH INR B ; Add length byte to length for checksum
47BBH XRA A ; Clear A for checksum calculation
47BCH SIM ; ?Clear Interrupts
47BDH ADD M ; Add next byte to checksum
47BEH INX H ; Increment RX data pointer
47BFH DCR B ; Decrement length counter
47C0H JNZ FDA9H ; Keep looping until all bytes added
47C3H CMA ; Compliment the checksum
47C4H CMP M ; Compare with received checksum
47C5H RET ; Branch if no match - Communication Error

; =========================================================================================
; Get next RX byte and store at HL, test for drive ready & print errors
; This routine (and the one above) get copied into RAM and then executed
; when the Main ROM is selected, so a direct call to the Main ROM address
; is allowed.
; =========================================================================================
47C6H CALL 6D7EH ; Get a character from RS232 receive queue
47C9H MOV M,A ; Save byte at HL
47CAH INX H ; Increment HL
47CBH RET

; =========================================================================================
; Copy the 2 Receive RX Packet routines above to RAM and execute
; =========================================================================================
47CCH LXI H,479DH ; Point to Receive RX Packet routine
47CFH LXI D,FD89H ; Point to target destination in RAM
47D2H LXI B,002FH ; Length of the routine
47D5H CALL 4A05H ; Move BC bytes from M to (DE) with increment
47D8H CALL 4862H ; Test if DSR is set - drive ready, error otherwise
47DBH CALL 4BDBH ; Call Main ROM's Set interrupt to 1DH routine.
47DEH RST 1 ; Switch to Main ROM and execute "Receive RX Pakcet" routine
47DFH DW FD89H ; Address of our RX routine we just copied to RAM
47E1H JNZ 486AH ; Communication Error if no /DSR
47E4H RET

; =========================================================================================
; Get next RX byte and store at HL, test for drive ready & print errors
; =========================================================================================
47E5H CALL 47EBH ; Test drive and get byte from RX
47E8H MOV M,A ; Save byte at HL
47E9H INX H ; Increment HL
47EAH RET

; =========================================================================================
; Test drive ready and get byte from RX, Report error if not ready
; =========================================================================================
47EBH CALL 4862H ; Test if DSR is set - Drive Ready
47EEH CALL 4BE7H ; Get a character from RS232 receive queue
47F1H JC 488DH ; Empty Error Text
47F4H JNZ 486AH ; Communication Error
47F7H RET

; =========================================================================================
; Check RX packet for Normal Response & report errors
; =========================================================================================
47F8H LDA FD02H ; Storage for RX packet
47FBH CPI 12H ; Test for normal return code
47FDH JNZ 486AH ; Communication Error
4800H LDA FD04H ; Location of error code in RX packet
4803H ANA A ; Test if error code is zero
4804H RZ ; Return if no error
4805H CPI 10H
4807H JZ 487EH ; File Exists Error
480AH CPI 50H
480CH JZ 486DH ; Write Protect Error
480FH CPI 60H
4811H JZ 4881H ; Disk Full Error
4814H JC 486AH ; Communication Error
4817H JZ 4873H ; Disk not in drive error
481AH CPI 80H
481CH JC 4873H ; Disk not in drive error
481FH JMP 4870H ; Drive Trouble Error

; =========================================================================================
; Send TPDD Command/Len in HL, H=len, L=Cmd. 0XED8A already has data
; =========================================================================================
4822H SHLD FCE6H ; Store TDD CMD/Len passed in HL
4825H LXI H,FCE6H ; Point to Command/Len storage location

4828H PUSH H ; Save Cmd/Len storage address to stack
4829H LDA FCCAH ; TPDD Bank Numbere
482CH ANA A ; Test if reading from side zero
482DH JZ 4837H ; Skip ahead if reading from side zero
4830H ANI 01H ; Mask off all but LSB (only side 1 allowed)
4832H RAR ; Move the "1" to C
4833H RAR ; Move the "1" to bit 7
4834H RAR ; Move the "1" to bit 6 (could just do MVI 0x40 !!)
4835H ORA M ; OR the 0x40 with Cmd to access Disk Bank 1
4836H MOV M,A ; Save the updated cmd value back at (HL)
4837H MOV A,M ; Get the command value / modified value
4838H INX H ; Point to length parameter passed in
4839H ADD M ; Add the length parameter (checksum)
483AH MOV B,A ; Store checksum in B
483BH MOV A,M ; Get the Length parameter
483CH PUSH PSW ; Save length on stack
483DH INX H ; Point to data (already loaded before invocation)
483EH ANA A ; Test if length is zero
483FH JZ 484BH ; Skip data checksum if length zero
4842H MOV C,A ; Save current count
4843H MOV A,B ; Get running checksum value
4844H ADD M ; Add this byte to checksum
4845H INX H ; Point to next data byte
4846H DCR C ; Decrement count
4847H JNZ 4844H ; Keep looping until count is zero
484AH MOV B,A ; Save updated checksum in B
484BH MOV A,B ; Get Checksum from B
484CH CMA ; Compliment the checksum (protocol thing)
484DH MOV D,A ; Save complimented checksum in D
484EH LXI B,5A5AH ; Load "ZZ" header signature into BC
4851H CALL 49DBH ; Send BC to the serial port using XON/XOFF
4854H POP B ; Get the length from stack into BC
4855H MOV C,B ; Move the length into C
4856H MVI B,00H ; Clear upper MSB of count
4858H INX B ; Add Opcode byte to the TX length
4859H INX B ; Add length byte to the TX length
485AH POP H ; Get address of TX packet from stack
485BH CALL 48D9H ; Send BC bytes to RS-232 from (HL) using XON/XOFF
485EH MOV A,D ; Get checksum byte for TX

; =========================================================================================
; Send A to RS-232 using XON/XOFF and check DSR when done
; =========================================================================================
485FH CALL 4BE3H ; Call Main ROM's Send A to RS-232 using XON/XOFF routine

; =========================================================================================
; Test if DSR is set - drive ready, error otherwise
; =========================================================================================
4862H IN BBH ; Get I/O port with /DSR bit
4864H ANI 20H ; Mask all but the /DSR bit
4866H RZ ; Return if /DSR is asserted (low = asserted)

; =========================================================================================
; Error jump table. Loads A with error number and prints
; =========================================================================================
4867H (3EH) MVI A,01H
DB 0x21 ; Filler - looks like "LXI H,XXXX"
486AH MVI A,02H ; Communication Error
DB 0x21
486DH MVI A,03H ; Write Protect Error
DB 0x21
4870H MVI A,04H ; Drive Trouble Error
DB 0x21
4873H MVI A,05H ; Disk not in drive Error

; =========================================================================================
; For any of the errors above, change the RAM/Disk mode back to RAM
; =========================================================================================
4875H LXI H,FCD9H ; RAM / Disk mode (0=RAM, 1=DISK)
4878H MVI M,00H ; Go back to RAM mode
DB 0x21 ; Filler - looks like "LXI H,XXXX"

487BH MVI A,06H ; Printer Not Ready Error
DB 0x21
487EH MVI A,07H ; File Exists Error
DB 0x21
4881H MVI A,08H ; Disk Full Error
DB 0x21
4884H MVI A,09H ; File Empty Error
DB 0x21
4887H MVI A,0AH ; Directory Full Error
DB 0x21
488AH MVI A,0BH ; Ram Full Error
DB 0x21
488DH MVI A,0CH ; ID Error (No text...runtime error only)
DB 0x21
4890H MVI A,0DH ; Bad File Name Error

; =========================================================================================
; Generate the error loaded in A above
; =========================================================================================
4892H LXI H,4B02H ; Pointer to error string table
4895H MOV C,A ; Save error number for loop counting
4896H DCR C ; Decrement error counter to test if string found
4897H JZ 48A4H ; String found in table
489AH MOV A,M ; Get next byte of error string
489BH INX H ; Inrcrement pointer
489CH CPI 00H ; Test if end of string
489EH JNZ 489AH ; Loop until end of string found
48A1H JMP 4896H ; Branch back to decrement string counter

; =========================================================================================
; Print error string at HL from error table
; =========================================================================================
48A4H LDA FCD2H ; Get the "Print error messages" flag
48A7H ANA A ; Test if printing allowed
48A8H JZ 48D0H ; Jump to generate system error if not allowed to print
48ABH MVI A,07H ; Print BELL to cause a beep
48ADH RST 4 ; Send A to the LCD
48AEH INX H ; Skip the error code
48AFH CALL 48F4H ; Print string at HL to col 1 on the bottom line
48B2H CALL 48C7H ; Display "Press any key" and wait for key

; =========================================================================================
; Perform Long jump
; =========================================================================================
48B5H LHLD FCCEH ; Stack pointer upon entry
48B8H SPHL ; Restore stack frame
48B9H LHLD FCD0H ; Get return vector after error
48BCH PUSH H ; Prepare to return to return vector
48BDH RET

; =========================================================================================
; Draw "Press any key" text with pre&post CR and wait for key press
; =========================================================================================
48BEH CALL 4C23H ; Send CRLF to screen or printer
48C1H CALL 48C7H ; Display "Press any key" and wait for key
48C4H JMP 4C23H ; Send CRLF to screen or printer

; =========================================================================================
; Draw "Press any key" text and wait for key press
; =========================================================================================
48C7H LXI H,4BBBH ; Point to "Press any key" text
48CAH CALL 4A2CH ; Send buffer at M to screen
48CDH JMP 4BEBH ; Wait for key from keyboard

; =========================================================================================
; Generate system error from code saved at (HL). This is called in liu of printing when
; the print/generate system error flag is set. The 1st byte of each error entry
; contains the system error number to generate.
; =========================================================================================
48D0H MOV E,M ; Get the error code
48D1H LHLD FCCEH ; Stack pointer upon entry
48D4H MVI M,00H ; Indicate all arguments (none) processed
48D6H JMP 4C37H ; Generate error in E

; =========================================================================================
; Send BC bytes to RS-232 from (HL) using XON/XOFF
; =========================================================================================
48D9H MOV A,M ; Get next byte from (HL)
48DAH CALL 485FH ; Send A to RS-232 using XON/XOFF
48DDH INX H ; Increment poiner
48DEH DCX B ; Decrement byte count
48DFH MOV A,C ; Get C for zero comparison
48E0H ORA B ; Or in MSB of count
48E1H JNZ 48D9H ; Jump to send next byte if not zero
48E4H RET

; =========================================================================================
; Draw C characters to LCD from buffer at HL using current video mode
; =========================================================================================
48E5H MOV A,M ; Get next byte from LCD buffer
48E6H CPI 20H ; Test if it is a space
48E8H JNC 48EDH ; Test if it's less than space, jump if not to redraw
48EBH MVI A,20H ; Draw a space for "illegal" values
48EDH RST 4 ; Draw byte with current regular/inverse video mode
48EEH INX H ; Increment to next byte in LCD buffer
48EFH DCR C ; Decrement the loop counter
48F0H JNZ 48E5H ; Branch if not done to process next character
48F3H RET ; Done

; =========================================================================================
; Print string at HL to col 1 on the bottom line
; =========================================================================================
48F4H PUSH H ; Save pointer to error text on stack
48F5H LXI H,0108H ; Position cursor on col 1 of row 16
48F8H SHLD F639H ; Cursor row (1-8)
48FBH CALL 4C2BH ; Erase from cursor to end of line
48FEH POP H ; Restore pointer to error text from stack
48FFH JMP 4A2CH ; Send buffer at M to screen

; =========================================================================================
; Copy filename at (HL) to current BASIC program
; =========================================================================================
4902H PUSH H ; Save pointer to filename on stack
4903H MVI A,20H ; Load A with code for SPACE
4905H LXI H,FC93H ; Filename of current BASIC program
4908H MVI B,08H ; Prepare to fill current BASIC program with 8 spaces
490AH CALL 4A34H ; Fill (HL) with B bytes of A
490DH POP H ; Retrieve filename pointer from stack
490EH LXI D,FC93H ; Filename of current BASIC program
4911H MVI B,06H ; Prepare to copy 6 bytes of filename before ext
4913H MOV A,M ; Get next byte of filename from source
4914H CPI 41H ; Compare byte with 'A' to test validity
4916H JC 4890H ; Bad Filename Error if invalid char
4919H MOV A,M ; Get next byte again
491AH CPI 2EH ; Compare with '.'
491CH JZ 492BH ; Branch if '.' to fill remaining with ' '
491FH ORA A ; Test for zero (NULL term)
4920H RZ ; Return if done copying filename (NULL term)
4921H STAX D ; Store next filename byte at (DE)
4922H INX H ; Increment source pointer
4923H INX D ; Increment dest pointer
4924H DCR B ; Decrement counter
4925H JNZ 4919H ; Keep looping until all bytes copied
4928H JMP 4933H ; Jump to copy 2 extension bytes

; =========================================================================================
; Fill remainder of filename at (DE) with spaces, B has count
; =========================================================================================
492BH MVI A,20H ; Load code for ' '
492DH STAX D ; Save next byte as ' '
492EH INX D ; Increment pointer
492FH DCR B ; Decrement count
4930H JNZ 492DH ; Keep looping until full

; =========================================================================================
; Copy 2 extention bytes from (HL) to (DE)
; =========================================================================================
4933H MVI B,02H ; Setup count = 2
4935H INX H ; Skip the '.' in the source name
4936H MOV A,M ; Load next extension byte from source
4937H ORA A ; Test for NULL termination
4938H RZ ; Return if NULL terminated
4939H STAX D ; Store in destination
493AH INX D ; Increment destination
493BH DCR B ; Decrement the counter
493CH JNZ 4935H ; Keep looping until done
493FH MVI A,00H ; Load NULL termination byte
4941H STAX D ; Add NULL termination to filename
4942H RET

; =========================================================================================
; Configure baud, test for NADSBox, get NADSBox dir
; =========================================================================================
4943H CALL 4A94H ; Configure baud (19200 for NADSBox/Desklink, 9600 otherwise)
4946H CALL 49A2H ; Send M1 and test for NADSBox/Desklink response
4949H CALL 47CCH ; Receive a packet
494CH CALL 47F8H ; Check RX packet for Normal Response & report errors
494FH LDA FCCBH ; NADSBo / Desklink / TPDD2 flag
4952H ANA A ; Test if server is NADSBox / Desklink
4953H RZ ; Return if not NADSBox / Desklink
4954H LXI H,0008H ; Load opcode 0x08 - FDC Emulation mode
4957H CALL 4822H ; Send TPDD Command/Len in HL
495AH CALL 47CCH ; Receive a packet - should be the current directory name
495DH LDA FD03H ; Load length byte from the RX payload area
4960H CPI 01H ; Test if length 1
4962H JZ 4977H ; Jump to send mystery opcodes if length = 1
4965H DCR A ; Subtract 1 from length (skip reserved 0x00 in filename)
4966H MOV C,A ; Save count in C
4967H MVI A,02H ; Prepare to indicate we have a NADSBox / Desklink directory name
4969H STA FCCBH ; NADSBox / Desklink flag = HAVE_NADS_DIR
496CH MVI B,00H ; Clear MSB of count
496EH LXI H,FD05H ; Point to filename in RX payload (skip 1st byte)
4971H LXI D,FCC0H ; Storage area for NADSBox directory
4974H JMP 4A05H ; Move BC bytes from M to (DE) with increment

; =========================================================================================
; Send mystery opcodes
; =========================================================================================
4977H LXI H,0023H ; Load mystery opcode 23
497AH CALL 4822H ; Send TPDD Command/Len in HL
497DH CALL 47CCH ; Receive a packet
4980H LXI H,4AE7H ; Point to mystery opcode 0x31
4983H CALL 498FH ; Send 9-byte protocol packet at HL
4986H LXI H,4AF0H ; Point to 2nd mystery opcode 0x31
4989H CALL 498FH ; Send 9-byte protocol packet at HL
498CH LXI H,4AF9H ; Point to 3rd mystery opcode 0x31

; =========================================================================================
; Send 9-byte protocol packet at HL
; =========================================================================================
498FH LXI B,0009H ; Load byte counter to send 9 bytes
4992H CALL 48D9H ; Send BC bytes at (HL) to RS-232 using XON/XOFF
4995H JMP 47CCH ; Receive a packet

; =========================================================================================
; Flush the RX queue & discard
; =========================================================================================
4998H CALL 4BDFH ; Check RS232 queue for pending characters
499BH RZ ; Return if RS232 queue is empty
499CH CALL 47EBH ; Test drive ready and get byte from RX.
499FH JMP 4998H ; Branch to get next byte from RX

; =========================================================================================
; Send M1 and test for NADSBox / Desklink response
; =========================================================================================
49A2H CALL 4862H ; Test if DSR set - drive ready
49A5H CALL 49CDH ; Send "M1",0x0D to TX and delay about 3ms
49A8H CALL 4998H ; Flush the RX queue & discard
49ABH CALL 419BH ; Send Opcode 0x08 - FDC emulation mode
49AEH CALL 49D3H ; Send 0x0D to RS-232 and Delay 3ms
49B1H CALL 4BDFH ; Check RS232 queue for pending characters
49B4H MVI A,00H ; NADSBox / Desklink / TPDD2 flag
49B6H JNZ 49BAH ; Skip setting NADSBox / Desklink flag if no response
49B9H INR A ; Indicate response from "M1" command = NADSBox / Desklink
49BAH STA FCCBH ; Store NADSBox / Desklink / TPDD2 flag
49BDH CALL 4998H ; Flush the RX queue & discard
49C0H CALL 49CDH ; Send "M1" to TX and delay about 3ms
49C3H CALL 4998H ; Flush the RX queue & discard
49C6H LXI H,0007H ; Load opcode for Drive Status
49C9H CALL 4822H ; Send TPDD Command/Len in HL
49CCH RET

; =========================================================================================
; Send "M1",0x0D to RS-232 and delay about 3ms
; =========================================================================================
49CDH LXI B,4D31H ; Load code for "M1"
49D0H CALL 49DBH ; Send BC to RS-232 using XON/XOFF
49D3H MVI A,0DH ; Load code for CR (0x0D)
49D5H CALL 485FH ; Send A to RS-232 using XON/XOFF
49D8H JMP 49E3H ; Delay routine - about 3ms

; =========================================================================================
; Send BC to RS-232 using XON/XOFF
; =========================================================================================
49DBH MOV A,B ; Get first byte to send
49DCH CALL 485FH ; Send A to RS-232 using XON/XOFF
49DFH MOV A,C ; Get 2nd byte to send
49E0H JMP 485FH ; Send A to RS-232 using XON/XOFF

; =========================================================================================
; Delay routine - about 72000 cycles = 28.9ms
; =========================================================================================
49E3H MVI H,14H ; 7 Cycles
49E5H MVI L,FFH ; 7 Cycles
49E7H DCR L ; 4 Cycles
49E8H JNZ 49E7H ; 10 Cycles to Jump back. 14 * 255 = 3570 cycles inner loop
49EBH DCR H ; 4 Cycles. But we save 3 cycles from the final JNZ, so 1 cycle
49ECH JNZ 49E5H ; 10 Cycles to jump back. (3570+1+7)*20+7 = 71567 cycles
49EFH RET ; 71567 * 403.877ns = 28.904ms

; =========================================================================================
; Wait for drive to be ready for 20480 counts of 28.9ms = 9.8 minutes???.
; Report error if no data received.
; =========================================================================================
49F0H LXI B,FF50H ; Get count of delay times to wait
49F3H CALL 49E3H ; Delay 28.9ms
49F6H CALL 4BDFH ; Check RS232 queue for pending characters
49F9H RNZ ; Return if data available
49FAH DCR B ; Decrement inner loop count
49FBH JNZ 49F3H ; Branch to delay and test again
49FEH DCR C ; Decrement outer loop count
49FFH JNZ 49F3H ; Branch to delay and test again
4A02H JMP 4867H ; No data received - Drive Not Ready error

; =========================================================================================
; Move BC bytes from M to (DE) with increment
; =========================================================================================
4A05H MOV A,M ; Get next byte from (HL)
4A06H STAX D ; Store next byte at (DE)
4A07H INX H ; Increment source pointer
4A08H INX D ; Increment destination poiner
4A09H DCX B ; Decrement loop control
4A0AH MOV A,B ; Prepare to test for zero
4A0BH ORA C ; OR in LSB to test for zero
4A0CH JNZ 4A05H ; Keep looping until done
4A0FH RET

; =========================================================================================
; Multiply TPDD free sectors len x 128 = free space. A '0' is added to LCD to convert this
; multiplication to x1280 (the TPDD sector size).
; =========================================================================================
4A10H LDA FD1FH ; Get number of free sectors reported from server (TPDD)
4A13H MOV L,A ; Move #free sectors into HL for multiply
4A14H MVI H,00H ; Clear MSB of HL
4A16H LXI D,0080H ; Prepare to multiply #sectors x 128
4A19H JMP 4C1FH ; Signed integer muliply (FAC1=HL*DE)

; =========================================================================================
; Compare (HL) with (DE), C bytes long
; =========================================================================================
4A1CH PUSH D ; Save pointer to 1st buffer
4A1DH PUSH H ; Save pointer to 2nd buffer
4A1EH LDAX D ; Load next byte from 1st buffer
4A1FH SUB M ; Compare with nex byte from 2nd buffer
4A20H JNZ 4A29H ; Jump to exit if no match
4A23H INX H ; Increment 2nd buffer pointer
4A24H INX D ; Increment 1st buffer pointer
4A25H DCR C ; Decrement length
4A26H JNZ 4A1EH ; Jump to compare next byte if not at end
4A29H POP H ; Restore pointer to 2nd buffer
4A2AH POP D ; Restore pointer to 1st buffer
4A2BH RET

; =========================================================================================
; Send buffer at M to screen
; =========================================================================================
4A2CH (7EH) MOV A,M ; Get next byte to send to LCD
4A2DH (A7H) ANA A ; Test for end of string
4A2EH (C8H) RZ ; Return if end of string (NULL terminated)
4A2FH (E7H) RST 4 ; Send character in A to screen/printer
4A30H (23H) INX H ; Increment to next byte
4A31H (C3H) JMP 4A2CH ; Branch to test next byte for zero and print

; =========================================================================================
; Fill (HL) with B bytes of A
; =========================================================================================
4A34H MOV M,A ; Load next byte at (HL) with A
4A35H INX H ; Increment pointer
4A36H DCR B ; Decrement counter
4A37H JNZ 4A34H ; Keep looping until B bytes copied
4A3AH RET

; =========================================================================================
; Initialize blank filename and attribute byte
; =========================================================================================
4A3BH MVI A,20H ; Prepare to fill TX packet with spaces
4A3DH MVI B,18H ; Fill TX buffer with 24 spaces
4A3FH LXI H,FCE8H ; Address of TX packet data
4A42H CALL 4A34H ; Fill (HL) with B bytes of A
4A45H MVI A,46H ; Load "F" TPDD file attribute flag
4A47H STA FD00H ; Store in TX packet data location
4A4AH RET

; =========================================================================================
; Get RAM directory address of selected file into HL
; =========================================================================================
4A4BH LHLD FCE4H ; LCD Buffer address of current file selection
4A4EH CALL 4902H ; Copy filename at (HL) to current BASIC program

; =========================================================================================
; Get RAM directory address of current BASIC program
; =========================================================================================
4A51H CALL 4C0FH ; Update system pointers
4A54H JMP 4BFBH ; Find catalog entry address of current BASIC program

; =========================================================================================
; Send Dir Reference for filename at (HL)
; =========================================================================================
4A57H PUSH H ; Save filename address on stack
4A58H CALL 4A3BH ; Initialize blank filename and attribute byte
4A5BH POP H ; Restore filename address
4A5CH LXI D,FCE8H ; Address of TX packet data
4A5FH LXI B,0006H ; Prepare to copy 6 bytes of TX data
4A62H CALL 4A05H ; Move BC bytes from M to (DE) with increment
4A65H MVI A,2EH ; Load code for '.'
4A67H STAX D ; Add '.' between name and extension
4A68H INX D ; Increment TX pkt address pointer
4A69H LXI B,0002H ; Prepare to copy extension from filename
4A6CH CALL 4A05H ; Move BC bytes from M to (DE) with increment
4A6FH CALL 4943H ; Configure baud, test for NADSBox, get NADSBox dir

; =========================================================================================
; Send Dir Reference opcode
; =========================================================================================
4A72H MVI A,00H ; Set dir reference type to "reference" for open
4A74H STA FD01H ; Save in dir reference location in TX buffer
4A77H LXI H,1A00H ; Load opcode for directory reference
4A7AH CALL 4822H ; Send TPDD Command/Len in HL
4A7DH CALL 47CCH ; Receive a packet
4A80H LDA FD1CH ; Load attribute byte
4A83H ANA A ; Test attribute byte for zero
4A84H RET

; =========================================================================================
; Save OS's baud rate string to storage area, A = "Print error messages" flag
; =========================================================================================
4A85H STA FCD2H ; Store "Print error messages" flag
4A88H LXI D,F9A8H ; Storage area for previous baud setting
4A8BH LXI H,F65BH ; RS232 parameter setting table
4A8EH LXI B,0005H ; Copy 7 bytes of parameter data
4A91H JMP 4A05H ; Move BC bytes from M to (DE) with increment

; =========================================================================================
; Configure baud, check for Desklink/NADSBox. Set to 9600 if not Desklink/NADSBox
; =========================================================================================
4A94H CALL 4BD7H ; Wait for TX empty and Reset UART to accept mode bits
4A97H LXI H,4ADEH ; Baud rate string for "98N1D"
4A9AH LXI D,F65BH ; RS232 parameter setting table
4A9DH LXI B,0005H ; Prepare to copy 5 bytes to Baud Parameter table
4AA0H CALL 4A05H ; Move BC bytes from M to (DE) with increment
4AA3H LXI H,F65BH ; Point to RS232 parameter setting table
4AA6H STC ; Indicate Baud rate is part of string
4AA7H CALL 4BD3H ; Set RS232 parameters from string at M
4AAAH CALL 4998H ; Flush the RX queue & discard
4AADH CALL 49A2H ; Send M1 and test for NADSBox / Desklink response
4AB0H CALL 49E3H ; Delay routine - about 3ms
4AB3H CALL 4BDFH ; Check RS232 queue for pending characters
4AB6H JNZ 4998H ; Jump to flush RX and keep 19200 if NADSBox / Desklink found
4AB9H CALL 4BD7H ; Wait for TX empty and Reset UART to accept mode bits
4ABCH LXI H,F65BH ; Baud rate string for "98N1D"
4ABFH DCR M ; Set baud rate to '8' = 9600 baud
4AC0H STC ; Indicate Baud rate is part of string
4AC1H JMP 4BD3H ; Set RS232 parameters from string at M - change to 9600 Baud

; =========================================================================================
; Restore original baud settings
; =========================================================================================
4AC4H LXI H,F9A8H ; Storage for OS's baud settings
4AC7H MOV A,M ; Get 1st byte of setting
4AC8H SUI 3AH ; Test if 1st byte is numeric
4ACAH JC 4BD3H ; Set RS232 parameters from string at M
4ACDH INX H ; Skip setting baud if 1st byte is "M"odem
4ACEH JMP 4BD3H ; Set RS232 parameters from string at M

; =========================================================================================
; Strings and table data
; =========================================================================================
4AD1H DB "0 Bytes free",0x00 ; Old Text - NOT USED in ROM version, only RAM version
4ADEH DB "98N1DNN", 0x00 ; Parameters for setting baud rate
4ADFH DB "8N1D",0x00
4AE4H DB 0x02,0x03,0x01 ; RST 7,30h open mode to TPDD Open mode mapping

4AE9H DB "ZZ1",0x04,0x01,0x00,0x84,0xFF,"F"
4AF0H DB "ZZ1",0x04,0x01,0x00,0x96,0x0F,0x24
4AF9H DB "ZZ1",0x04,0x01,0x00,0x94,0x0F,0x26

4B02H DB 0x12,"Drive Not Ready",0x00
DB 0x12,"Communication Error",0x00
DB 0x12,"Write Protect",0x00
DB 0x12,"Drive Trouble",0x00
DB 0x12,"Disk not in drive",0x00
DB 0x34,"Printer not ready",0x00
DB 0x05,"File Exists",0x00
DB 0x39,"Disk Full",0x00
DB 0x1A,"File Empty",0x00
DB 0x39,"Directory Full",0x00
DB 0x07,"Ram Full",0x00
DB 0x36,0x00
DB 0x37,"Bad File Name",0x00
4BBBH DB " Press any key.",0x00

; =========================================================================================
; RST 1 Vectors to Main ROM. At places in the code where a call is needed to the Main ROM,
; a RST 1 followed by a 2-byte address is issued. The routines will jump to one of
; the handler functions below to perform that RST 1 operation.
; =========================================================================================

4BCBH RST 1 ; Call main ROM at address in following 2 bytes
4BCCH DW 340AH
4BCEH RET

; =========================================================================================
; Call Main ROM's Evaluate expressino at M-1 routine
; =========================================================================================
4BCFH RST 1 ; Call main ROM at address in following 2 bytes
4BD0H DW 1113H
4BD2H RET

; =========================================================================================
; Call Main ROM's Set RS232 parameters from string at M routine
; =========================================================================================
4BD3H RST 1 ; Call main ROM at address in following 2 bytes
4BD4H DW 17E6H
4BD6H RET

; =========================================================================================
; Call Main ROM's Wait for TX empty and Reset UART routine
; =========================================================================================
4BD7H RST 1 ; Call main ROM at address in following 2 bytes
4BD8H DW 6ECBH
4BDAH RET

; =========================================================================================
; Call Main ROM's Set interrupt to 1DH routine.
; Seems like it would be easy enough to just do it in this ROM!
; =========================================================================================
4BDBH RST 1 ; Call main ROM at address in following 2 bytes
4BDCH DW 765CH
4BDEH RET

; =========================================================================================
; Call Main ROM's Check RS232 queue for pending characters routine
; =========================================================================================
4BDFH RST 1 ; Call main ROM at address in following 2 bytes
4BE0H DW 6D6DH
4BE2H RET

; =========================================================================================
; Call Main ROM's Send A to RS-232 using XON/XOFF routine
; =========================================================================================
4BE3H RST 1 ; Call main ROM at address in following 2 bytes
4BE4H DW 6E32H
4BE6H RET

; =========================================================================================
; Call Main ROM's Get a character from RS232 receive queue routine
; =========================================================================================
4BE7H RST 1 ; Call main ROM at address in following 2 bytes
4BE8H DW 6D7EH
4BEAH RET

; =========================================================================================
; Call Main ROM's Wait for key from keyboard routine
; =========================================================================================
4BEBH RST 1 ; Call main ROM at address in following 2 bytes
4BECH DW 12CBH
4BEEH RET

; =========================================================================================
; Call Main ROM's Scan keyboard for character (CTRL-BREAK ==> CTRL-C) routine
; =========================================================================================
4BEFH RST 1 ; Call main ROM at address in following 2 bytes
4BF0H DW 7242H
4BF2H RET

; =========================================================================================
; Call Main ROM's Power Down routine
; =========================================================================================
4BF3H RST 1 ; Call main ROM at address in following 2 bytes
4BF4H DW 13B5H
4BF6H RET

; =========================================================================================
; Call Main ROM's Renew automatic power-off counter routine
; =========================================================================================
4BF7H RST 1 ; Call main ROM at address in following 2 bytes
4BF8H DW 1BB1H
4BFAH RET

; =========================================================================================
; Call Main ROM's Find Catalog Entry Address of current BASIC program routine
; =========================================================================================
4BFBH RST 1 ; Call main ROM at address in following 2 bytes
4BFCH DW 20AFH
4BFEH RET

; =========================================================================================
; Call Main ROM's Kill .DO file routine
; =========================================================================================
4BFFH RST 1 ; Call main ROM at address in following 2 bytes
4C00H DW 1FBFH
4C02H RET

; =========================================================================================
; Call Main ROM's Kill .BA file routine
; =========================================================================================
4C03H RST 1 ; Call main ROM at address in following 2 bytes
4C04H DW 2017H
4C06H RET

; =========================================================================================
; Call Main ROM's Kill .CO file routine
; =========================================================================================
4C07H RST 1 ; Call main ROM at address in following 2 bytes
4C08H DW 1FD9H
4C0AH RET

; =========================================================================================
; Call Main ROM's Insert BC spaces at M routine
; =========================================================================================
4C0BH RST 1 ; Call main ROM at address in following 2 bytes
4C0CH DW 6B6DH
4C0EH RET

; =========================================================================================
; Call Main ROM's Update system pointers routine
; =========================================================================================
4C0FH RST 1 ; Call main ROM at address in following 2 bytes
4C10H DW 2146H
4C12H RET

; =========================================================================================
; Call Main ROM's Find BASIC end of program routine
; =========================================================================================
4C13H RST 1 ; Call main ROM at address in following 2 bytes
4C14H DW 05F4H
4C16H RET

; =========================================================================================
; Call Main Rom's Write new entry to catalog routine
; =========================================================================================
4C17H RST 1 ; Call main ROM at address in following 2 bytes
4C18H DW 2239H
4C1AH RET

; =========================================================================================
; Call Main ROM's Signed integer divide (FAC1=DE/HL) routine
; =========================================================================================
4C1BH RST 1 ; Call main ROM at address in following 2 bytes
4C1CH DW 377EH
4C1EH RET

; =========================================================================================
; Call Main ROM's Signed integer muliply (FAC1=HL*DE) routine
; =========================================================================================
4C1FH RST 1 ; Call main ROM at address in following 2 bytes
4C20H DW 3725H
4C22H RET

; =========================================================================================
; Call Main ROM's Send CRLF to LCD routine
; =========================================================================================
4C23H RST 1 ; Call main ROM at address in following 2 bytes
4C24H DW 4222H
4C26H RET

; =========================================================================================
; Call Main ROM's CLS statement routine
; =========================================================================================
4C27H RST 1 ; Call main ROM at address in following 2 bytes
4C28H DW 4231H
4C2AH RET

; =========================================================================================
; Call Main ROM's Erase from cursor to end of line routine
; =========================================================================================
4C2BH RST 1 ; Call main ROM at address in following 2 bytes
4C2CH DW 425DH
4C2EH RET

; =========================================================================================
; Call Main ROM's Start inverse character mode routine
; =========================================================================================
4C2FH RST 1 ; Call main ROM at address in following 2 bytes
4C30H DW 4269H
4C32H RET

; =========================================================================================
; Call Main ROM's Cancel inverse video routine
; =========================================================================================
4C33H RST 1 ; Call main ROM at address in following 2 bytes
4C34H DW 426EH
4C36H RET

; =========================================================================================
; Call Main ROM's Generate error in E routine
; =========================================================================================
4C37H LXI H,045DH ; Load address of Main ROM's Generate Error in E routine
4C3AH PUSH H ; Push routine to the stack
4C3BH JMP 00A6H ; Jump to Main ROM

; =========================================================================================
; Call Main ROM's Print binary number in HL at current position routine
; =========================================================================================
4C3EH RST 1 ; Call main ROM at address in following 2 bytes
4C3FH DW 39D4H
4C41H RET

; =========================================================================================
; Call Main ROM's Print A to printer, expanding tabs if necessary routine
; =========================================================================================
4C42H RST 1 ; Call main ROM at address in following 2 bytes
4C43H DW 4B55H
4C45H RET

; =========================================================================================
; Call Main ROM's Input and display (no "?") line and store routine
; =========================================================================================
4C46H RST 1 ; Call main ROM at address in following 2 bytes
4C47H DW 4644H
4C49H RET

; =========================================================================================
; Call Main ROM's Check keyboard queue for pending characters routine
; =========================================================================================
4C4AH RST 1 ; Call main ROM at address in following 2 bytes
4C4BH DW 13DBH
4C4DH RET

; =========================================================================================
; Call Main ROM's Move BC bytes from M to (DE) with decrement routine
; =========================================================================================
4C4EH RST 1 ; Call main ROM at address in following 2 bytes
4C4FH DW 6BE6H
4C51H RET

; =========================================================================================
; Call Main ROM's LCOPY statement routine
; =========================================================================================
4C52H RST 1 ; Call main ROM at address in following 2 bytes
4C53H DW 1E5EH
4C55H RET

; =========================================================================================
; Call Main ROM's Stop automatic scrolling routine
; =========================================================================================
4C56H RST 1 ; Call main ROM at address in following 2 bytes
4C57H DW 423FH
4C59H RET

; =========================================================================================
; Call Main ROM's Resume Automatic Scrolling routine
; =========================================================================================
4C5AH RST 1 ; Call main ROM at address in following 2 bytes
4C5BH DW 4244H
4C5DH RET

; =========================================================================================
; Call Main ROM's Get char at M and convert to uppercase routine
; =========================================================================================
4C5EH RST 1 ; Call main ROM at address in following 2 bytes
4C5FH DW 0FE8H
4C61H RET

; =========================================================================================
; Call Main ROM's Get file descriptor for file in A routine
; NOT CALLED
; =========================================================================================
4C62H RST 1 ; Call main ROM at address in following 2 bytes
4C63H DW 4C81H
4C65H RET

; =========================================================================================
; Call Main ROM's Update line addresses for current BASIC program routine
; =========================================================================================
4C66H RST 1 ; Call main ROM at address in following 2 bytes
4C67H DW 05F0H
4C69H RET

; =========================================================================================
; Call Main ROM's Copy CO header bytes (6) from (HL) to "active" CO Header storage area routine
; =========================================================================================
4C6AH RST 1 ; Call main ROM at address in following 2 bytes
4C6BH DW 253DH
4C6DH RET

; =========================================================================================
; Call Main ROM's print CO address, length and invocation address to LCD routine
; =========================================================================================
4C6EH RST 1 ; Call main ROM at address in following 2 bytes
4C6FH DW 25A4H
4C71H RET

; =========================================================================================
; Call Main ROM's Process SAVEM arguments for address, length and entry point routine
; =========================================================================================
4C72H RST 1 ; Call main ROM at address in following 2 bytes
4C73H DW 2346H
4C75H RET
</pre>

Navigate to:

<DPL>
category=M100 TS-DOS ROM Disassembly
</DPL>

[[Category:M100 TS-DOS ROM Disassembly]]

M100 TS-DOS ROM OptROM Support

2009-04-03T16:38:14Z

208.77.91.41:

== TS-DOS Model 100/102 ROM OptROM Support ==

This code defines the variables used throughout the TS-DOS application as well as the support routines needed to navigate between the Main ROM and the Option ROM (most of them). Also included is the TS-DOS startup code. The assembly labels defined are open for discussion and have not been applied to any of the disassembled code yet.

<pre>
=========================================================================================
; TS-DOS M100 ROM version Disassembly
;
; Initial Disassembly By Kenneth D. Pettit
; March, 2009
;
; =========================================================================================

; =========================================================================================
; Variables in ALTLCD buffer
; =========================================================================================
NB_CUR_DIR equ FCC0H ; NADSBox current directory ("MYFILE.<> ")
TPDD_BANK equ FCCAH ; TPDD2 Bank (side)
NB_TPDD_FLG equ FCCBH ; NADSBox/Desklink/TPDD2 flag (0=TPDD, 1=TPDD2, 2=NADSBox)
LAST_TAG equ FCCCH ; Tag/Untag last operation code
CUR_FILE equ FCCDH ; Currently selected file index on UI (1 based)
LJ_SP equ FCCEH ; Stack pointer upon entry for Long Jump
LJ_RET equ FCD0H ; Return vector for Long Jump "RETURN"
ERR_MODE equ FCD2H ; Print Error Messages flag, 1=Print, 0=Generate System Error
FDC_OPCODE equ FCD3H ; FDC Emulation mode opcode
CUR_PAGE equ FCD4H ; Current page of files being displayed (0 based)
TMP_FILE_IDX equ FCD5H ; Currently selected file index on UI - temp
FILE_COUNT equ FCD6H ; Count of files currently displayed on LCD
MAX_FILES equ FCD7H ; Maximum files that fit on the LCD
DISP_MODE equ FCD9H ; RAM / Disk Display mode (0=RAM, 1=DISK)
SKIP_PAGE equ FCDAH ; TPDD "skip page" count (number of pages to read and discard)
FILE_LEN equ FCDBH ; Pointer to "Current file" length bytes (in keyboard buffer)
PHYS_SCTR equ FCDDH ; FDC Emulation Physical Sector Number / Active File Length LSB
LOG_SCTR equ FCDEH ; FDC Emulation Logical Sector Number / Active File Length MSB
KEY_TYPE equ FCDFH ; Storage for FDC emulation / New file type code / Keypress storage
FILE_ADDR equ FCE0H ; Address of file being displayed/printed/loaded/saved
FILE_BUFF equ FCE2H ; Pointer for TPDD direct read data / address of file being read/written
TX_PKT_BUF equ FCE6H ; Storage for TX packets (28 bytes)
RX_PKT_BUF equ FD02H ; Storage for RX packets (130 bytes ??)

; =========================================================================================
; Main Entry point when called from "CALL 63013,1"
; =========================================================================================

.org 0000H

0000H JMP 00B2H ; Jump to entry point handler

; =========================================================================================
; Pop registers after we power back up from a powerdown (I think)
; =========================================================================================
0003H POP H
0004H POP D
0005H POP B
0006H POP PSW
0007H RET

; =========================================================================================
; RST 1 - Call Main ROM at location whose address follows RST 1 opcode
; =========================================================================================
0008H JMP 0080H ; BASIC statement keyword table END to NEW

; =========================================================================================
; RST 2 - Call Main ROM's RST 2 routine
; =========================================================================================
0010H RST 1 ; Call main ROM at address in following 2 bytes
0011H DW 0010H ; Call the Main ROM's RST 2 function
0013H RET

; =========================================================================================
; RST 3 routine - Compare HL and DE
; =========================================================================================
0018H JMP 006CH ; Jump to comparison routine

; =========================================================================================
; Return to Main ROM. After issuing the OUT E0H, we will be in Main ROM. The next opcode
; in Main ROM after this OUT statement occurs will be a RET (part of RST 1). We have
; PUSHed a return address to the stack, so the main ROM's RET instruction will get us
; where to intend to go.
; =========================================================================================
001BH OUT E0H ; Send A to the ROM bank port to switch to Main ROM
001DH RET ; Should never execute this instruction, but just in case

; =========================================================================================
; Send a space to the screen/printer - Not called from anywhere. Copy of Main ROM.
; =========================================================================================
001EH MVI A,20H ; Prepare to print a SPACE

; =========================================================================================
; RST 3 routine - Send character in A to the screen / printer
; =========================================================================================
0020H RST 1 ; Call main ROM at address in following 2 bytes
0021H DW 0020H ; Main ROM's RST 3 routine
0023H RET

; =========================================================================================
; Power down TRAP. Let Main ROM deal with it.
; =========================================================================================
0024H DI ; Disable interrupts while we jump
0025H CALL 0097H ; Jump to Main ROM's RST handler for this vector
0028H POP H
0029H JMP 0003H ; Pop regs after we power back up from a power-down?

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - Bar Code Reader
; =========================================================================================
002CH DI ; Disable interrupts while we jump
002DH CALL 0097H ; Jump to Main ROM's RST handler for this vector

; =========================================================================================
; Return from Main ROM hook in RAM returns here via RST 6
; =========================================================================================
0030H POP PSW ; Cleanup stack
0031H POP PSW ; Cleanup stack
0032H RET ; Return to OptROM execution point

0033H NOP ; Filler

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - RS232 character pending
; =========================================================================================
0034H DI ; Disable interrupts while we jump
0035H CALL 0097H ; Jump to Main ROM's RST handler for this vector
0038H JMP 00A6H ; Stack cleanup

003BH NOP ; UNUSED - filler

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - Timer background task
; =========================================================================================
003CH DI ; Disable interrupts
003DH CALL 0097H ; Jump to Main ROM's RST handler for this vector

; =========================================================================================
; This routine gets copied to RAM to be used for switching back to the TS-DOS ROM after
; calling a routine in the Main ROM.
; =========================================================================================
0040H PUSH PSW ; Preserve the PSW
0041H LDA FF45H ; Contents of port E8H
0044H INR A ; Prepare to switch to OptRom
0045H OUT E0H ; Switch to OptRom
0047H RST 6 ; Get sign of FAC1

; =========================================================================================
; This routine gets copied to RAM and appears to detect the presence of the TS-DOS ROM
; after power-up and copies the original "External ROM" detection routine to RAM
; if the TS-DOS ROM is no longer present. At least I think that's what it's doing.
; =========================================================================================
0048H LXI D,F605H ; Copy address for "Ext ROM detect" routine
004BH INR A ; Set bit to enable OptROM
004CH OUT E0H ; Switch to OptROM
004EH XRA A ; Prepare to switch back to Main ROM
004FH LHLD 0049H ; Load target address of the LXI D instruction above
0052H OUT E0H ; Switch back to Main ROM
0054H RST 3 ; Compare DE and HL - Test if OptROM is TS-DOS
0055H CPI 01H ; Test for TS-DOS ROM
0057H RC ; Return if TS-DOS ROM
0058H LXI H,111DH ; Load "Return" address to the CALL below
005BH SHLD FAE0H
005EH SHLD F5F2H ; Save a "Restart signature" ???
0061H CALL 2905H ; Copy the DB number of bytes from the DW address to (DE)
0064H DB 24H ; ....copy 24H bytes
0065H DW 036FH ; ....from ROM addres 036F (external ROM detect)
0067H RST 0 ; I'm not sure it it every actually returns here or not
0068H NOP
0069H CALL FAA4H ; Call our installed RAM hook to return to TS-DOS

; =========================================================================================
; Compare HL and DE - called by the RST 3 routine
; =========================================================================================
006CH MOV A,H ; Move H into A for comparison
006DH SUB D ; Compare MSB first
006EH RNZ ; Return if no match
006FH MOV A,L ; Now move L into A
0070H SUB E ; Compare LSB
0071H RET ; Return with flags set

; =========================================================================================
; Copy 8 bytes from DE to HL
; =========================================================================================
0072H LXI B,0008H ; Prepare to copy 8 bytes

; =========================================================================================
; Copy BC bytes from DE to HL
; =========================================================================================
0075H LDAX D ; Load value from (DE)
0076H MOV M,A ; Save value to (HL)
0077H INX D ; Increment DE
0078H INX H ; Increment HL
0079H DCX B ; Decrement counter
007AH MOV A,B ; Prepare to test counter for zero
007BH ORA C ; Test counter for zero
007CH JNZ 0075H ; Keep looping until 8 bytes copied
007FH RET

; =========================================================================================
; Handle the RST 1 routine. Read the Main ROM address from the 2 bytes after the RST 1
; =========================================================================================
0080H SHLD F9B2H ; Save HL off in "RickY" Cat entry so we don't clobber it
0083H POP H ; Get out return address (location of the ROM address to call
0084H PUSH D ; Push the return address back to the stack as storage
0085H MOV E,M ; Get LSB of the ROM address to call
0086H INX H ; Point to MSB of ROM address to call
0087H MOV D,M ; Get MSB of the ROM address to call
0088H INX H ; Point to return address after the RST 1 DB address
0089H XTHL ; Put the return address on the stack so we return after the RST 1
008AH XCHG ; Now get the address within ROM to call
008BH PUSH H ; Push the target ROM address to the stack so we "RETurn" there
008CH LXI H,FAA4H ; Load address of our RAM hook to switch back to our ROM bank and RET
008FH XTHL ; Push that address on the stack for after the ROM call is complete
0090H PUSH H ; Now put the ROM address back on the stack so we will RET there
0091H LHLD F9B2H ; Restore HL from temp storage in "RickY"
0094H JMP 00A6H ; Branch to switch to Main ROM and "RET" to the address we pushed

; =========================================================================================
; RST handler for calling the Main ROM's RST handlers. This routine restores the original
; RST vector address to the stack, and jumps to the Main ROM's RST routine while
; preserving all register values.
; =========================================================================================
0097H SHLD F9B4H ; Save HL temporarily (somewhere in RickY's name)
009AH LXI H,FAA4H ; Point to our RAM hook for returning to TS-DOS
009DH XTHL ; Put the hook address as the return address on the stack
009EH DCX H ; Decrement the return address by 4
009FH DCX H ; ...this will result in the starting address of the RST
00A0H DCX H ; ...that brought us here
00A1H DCX H
00A2H PUSH H ; Push the RST vector address to the stack
00A3H LHLD F9B4H ; Restore HL upon entry
00A6H PUSH PSW ; Save A to the stack
00A7H PUSH H ; Save the HL to the stack so we can preserve through XTHL
00A8H LXI H,1488H ; Load a RETurn address in the Main ROM (a POP PSW & RET)
00ABH XTHL ; Push the address and get HL back
00ACH LDA FF45H ; Contents of port E8H - prepare for jump to Main ROM
00AFH JMP 001BH ; Jump to Main ROM & our custom "RET" address in the ROM

; =========================================================================================
; Manual invocation entry point. This is where we jump when "CALL 63013,1" is invoked
; =========================================================================================
00B2H DI ; Disable interrupts so nobody bugs us yet
00B3H CPI 08H ; Check the invocation parameter to test for recovery request
00B5H JNC 0100H ; Jump to test for recovery mode
00B8H MOV B,A ; Save the calling paramter to B
00B9H PUSH B ; Save BC to the stack
00BAH PUSH D ; Save DE to the stack
00BBH PUSH H ; Save HL to the stack
00BCH LXI D,0040H ; Load address of our "Change to OptROM" routine
00BFH LXI H,FAA4H ; Load pointer to somewhere in RAM to hold our routine
00C2H CALL 0072H ; Copy 8 bytes from DE to HL
00C5H LXI B,0024H ; Now prepare to copy 36 bytes worth of "routine"
00C8H LXI H,F605H ; Point to another RAM location
00CBH CALL 0075H ; Copy the next "ROM Bank Switching" routine from our ROM
00CEH POP H ; Restore HL
00CFH POP D ; Restore DE
00D0H POP PSW ; Restore A
00D1H EI ; Allow interrupts again
00D2H JMP 0100H ; Go test if a "Cold Start" recovery is being requested

.org 100H

; =========================================================================================
; Test if cold-start recovery requested
; =========================================================================================
0100H MOV A,H ; Move H to A to test HL for zero
0101H ORA L ; Test for zero
0102H JZ 7000H ; Call recovery routine if requested
0105H POP H ; Pop the return address. We will exit manually
0106H CALL 0117H ; Ensure the TS-DOS progam is installed in the MENU
0109H JMP 3535H ; Jump to the TS-DOS UI

; =========================================================================================
; Move BC bytes from (HL) to (DE) with increment
; =========================================================================================
010CH MOV A,M ; Get next byte from (HL)
010DH STAX D ; Save byte in (DE)
010EH INX H ; Increment source pointer
010FH INX D ; Increment destination pointer
0110H DCX B ; Decrement loop control
0111H MOV A,B ; Move MSB to A to test for zero
0112H ORA C ; OR in LSB to test for zero
0113H JNZ 010CH ; Branch to copy next byte until done
0116H RET

; =========================================================================================
; Insert the "TS-DOS" invocation program (BASIC program) into the Catalog / MENU.
; we insert ourselves just before the "unsaved BASIC program".
; =========================================================================================
0117H LXI H,01E1H ; Point to "TS-DOS" catalog entry in our ROM
011AH PUSH H ; Save the address on the stack for later
011BH INX H ; Point to the text portion of the catalog entry
011CH LXI B,0008H ; Prepare to copy 8 filename byte
011FH LXI D,FC93H ; Filename of current BASIC program
0122H CALL 010CH ; Copy BC bytes from HL to DE - put "TS-DOS " in cur. BASIC prog.
0125H XCHG ; HL <--> DE DE now has the address of the invocation program
0126H LHLX ; Get the length of the BASIC program into HL
0127H SHLD FCC4H ; Save the BASIC program length in the ALTLCD buffer for now
012AH INX D ; Point to MSB of the length
012BH INX D ; Point to LSB of the pointer to the "Next" BASIC instruction
012CH XCHG ; HL <--> DE HL has the pointer to the "Next" BASIC inst address
012DH SHLD FCC8H ; Save the "Next" BASIC inst pointer to ALTLCD (start of program)
0130H CALL 01D1H ; Update the System pointers
0133H CALL 01CDH ; Search Catalog for entry matching current BASIC program
0136H POP B ; Pop address in case we return
0137H RNZ ; Return if "TS-DOS" is already in the catalog
0138H LHLD F99AH ; Get the BASIC program not saved pointer - insert before that
013BH SHLD FCC2H ; Save storage location for the TS-DOS invocation progam
013EH LDAX B ; Load the file type byte from our ROM (B has the address from above)
013FH STA FCC6H ; Store the Type byte in the ALTLCD
0142H CALL 0185H ; Find empty entry in Catalog
0145H RC ; Return if catalog full
0146H PUSH H ; Save the address of the empty catalog entry to the stack
0147H LHLD FCC4H ; Restore the BASIC program length from ALTLCD
014AH MOV B,H ; Move BASIC program length to BC for copy
014BH MOV C,L ; Move LSB of length
014CH PUSH B ; Save Length to the stack
014DH LHLD FCC2H ; Get address of insertion for TS-DOS just before the unsaved BASIC prog.
0150H CALL 01DDH ; Call Main ROM's Insert BC spaces at M routine
0153H JC 0182H ; Abort if RAM full
0156H LHLD FCC2H ; Get address of insertion point again
0159H XCHG ; DE now has insertion point for BASIC program
015AH LHLD FCC8H ; Get the address of the BASIC program (in our ROM) from ALTLCD
015DH POP B ; Restore copy length of the BASIC program
015EH CALL 010CH ; Move BC bytes from (HL) to (DE) with increment
0161H POP D ; Get the address of the empty catalog entry we will use for TS-DOS
0162H PUSH D ; Save it back to the stack
0163H LHLD FBAEH ; Load the start of DO files pointer
0166H DCX H ; Derement the start of DO files pointer
0167H SHLD F99AH ; Save it as the new BASIC program not saved pointer
016AH INX H ; Point to start of DO files again
016BH XCHG ; Move it to DE
016CH LHLD FCC4H ; Load the TS-DOS BASIC progam length from ALTLCD
016FH DAD D ; Offset the start of DO files by the insertion amount
0170H SHLD FBAEH ; Save the new start of DO files pointer
0173H POP D ; Restore the address of the empty catalog entry
0174H LHLD FCC2H ; Get the starting address of the newly inserted TS-DOS program
0177H XCHG ; HL <--> DE Swap for the call to the catalog insertion routine
0178H LDA FCC6H ; Load A with the file type byte
017BH CALL 01D5H ; Save current BASIC program to the Catalog entry at HL
017EH CALL 01D1H ; Update system pointers
0181H RET

; =========================================================================================
; Insert "TS-DOS" RAM full abort routine ... stack cleanup.
; =========================================================================================
0182H POP H ; Pop the BASIC program length from the stack
0183H POP H ; Pop the catalog entry address from the stack
0184H RET

; =========================================================================================
; Find an empty entry in the Catalog. HL points to start of new entry
; This routine appears again at address 3E48H
; =========================================================================================
0185H LXI H,F9AFH ; Point to "RickY" to start search at beginning of catalog
0188H LXI B,000BH ; Get length of each entry in the Catalog
018BH DAD B ; Point to next entry in the catalog
018CH MOV A,M ; Get the File Attribute byte from the catalog for this file
018DH CPI FFH ; Test if at end of the catalog
018FH JZ 0197H ; Jump to set Carry flag and exit if at end
0192H ADD A ; Test if MSB set (test if entry available)
0193H JC 018BH ; Branch to get next entry if this one is used
0196H RET ; Return with Carry clear to indicate entry found

; =========================================================================================
; Empty catalog entry not found in Catalog, set Carry and return
; =========================================================================================
0197H STC ; Set the Carry flag - not found
0198H RET

; =========================================================================================
; Call Main ROM's Display function key line routine
; =========================================================================================
0199H RST 1 ; Call main ROM at address in following 2 bytes
019AH DW 42A8H
019CH RET

; =========================================================================================
; Call Main ROM's Erase function key display routine
; =========================================================================================
019DH RST 1 ; Call main ROM at address in following 2 bytes
019EH DW 428AH
01A0H RET

; =========================================================================================
; Call Main ROM's Set new function key table routine
; =========================================================================================
01A1H RST 1 ; Call main ROM at address in following 2 bytes
01A2H DW 5A7CH
01A4H RET

; =========================================================================================
; Call Main ROM's Wait for key from keyboard routine
; =========================================================================================
01A5H RST 1 ; Call main ROM at address in following 2 bytes
01A6H DW 12CBH
01A8H RET

; =========================================================================================
; Call Main ROM's Scan keyboard for character (CTRL-BREAK ==> CTRL-C) routine
; This appears later in the code also
; =========================================================================================
01A9H RST 1 ; Call main ROM at address in following 2 bytes
01AAH DW 7242H
01ACH RET

; =========================================================================================
; Call Main ROM's Power Down routine
; This appears later in the code also
; =========================================================================================
01ADH RST 1 ; Call main ROM at address in following 2 bytes
01AEH DW 13B5H
01B0H RET

; =========================================================================================
; Call Main ROM's Renew automatic power-off counter routine
; This apears later in the code also
; =========================================================================================
01B1H RST 1 ; Call main ROM at address in following 2 bytes
01B2H DW 1BB1H
01B4H RET

; =========================================================================================
; Call Main ROM's CLS statement routine
; This apears later in the code also
; =========================================================================================
01B5H RST 1 ; Call main ROM at address in following 2 bytes
01B6H DW 4231H
01B8H RET

; =========================================================================================
; Call Main ROM's Start inverse character mode routine
; This appears later in the code also
; =========================================================================================
01B9H RST 1 ; Call main ROM at address in following 2 bytes
01BAH DW 4269H
01BCH RET

; =========================================================================================
; Call Main ROM's Cancel inverse video routine
; This appears later in the code also
; =========================================================================================
01BDH RST 1 ; Call main ROM at address in following 2 bytes
01BEH DW 426EH
01C0H RET

; =========================================================================================
; Call Main ROM's Check keyboard queue for pending characters routine
; This appers later in the code also
; =========================================================================================
01C1H RST 1 ; Call main ROM at address in following 2 bytes
01C2H DW 13DBH
01C4H RET

; =========================================================================================
; Call Main ROM's Stop automatic scrolling routine
; This appers later in the code also
; =========================================================================================
01C5H RST 1 ; Call main ROM at address in following 2 bytes
01C6H DW 423FH
01C8H RET

; =========================================================================================
; Call Main ROM's Reset vector routine
; =========================================================================================
01C9H RST 1 ; Call main ROM at address in following 2 bytes
01CAH DW 0000H
01CCH RET

; =========================================================================================
; Search Catalog for entry matching current BASIC program
; =========================================================================================
01CDH RST 1 ; Call main ROM at address in following 2 bytes
01CEH DW 20AFH
01D0H RET

; =========================================================================================
; Call Main ROM's Update system pointers routine
; =========================================================================================
01D1H RST 1 ; Call main ROM at address in following 2 bytes
01D2H DW 2146H
01D4H RET

; =========================================================================================
; Call Main ROM's routine to save current BASIC program to the Catalog entry at HL
; =========================================================================================
01D5H RST 1 ; Call main ROM at address in following 2 bytes
01D6H DW 2239H
01D8H RET

; =========================================================================================
; Not a valid entry into ROM and not called anywhere
; =========================================================================================
01D9H RST 1 ; Call main ROM at address in following 2 bytes
01DAH DW 5825H
01DCH RET

; =========================================================================================
; Call Main ROM's Insert BC spaces at M routine
; =========================================================================================
01DDH RST 1 ; Call main ROM at address in following 2 bytes
01DEH DB 6B6DH
01E0H RET

; =========================================================================================
; TS-DOS entry that will be inserted into the catalog for invoking TS-DOS
; =========================================================================================
01E1H DB 80H ; TS-DOS file type for catalog entry
01E2H DB "TS-DOS " ; TS-DOS Catalog name entry

; =========================================================================================
; BASIC program that will be inserted into RAM to launch TS-DOS from the MENU/Catalog entry
; =========================================================================================
01EAH DB 0FH,00H,0EH,80H ; BASIC program length and pointer to "Next" BASIC instruction
01EDH DB 0AH,00H,B9H ; BASIC Line number "10" and BASIC token for CALL
01EFH DB "63013,1" ; CALL argument
01F5H DB 00H,00H ; BASIC terminating zeros

</pre>

End of disassembly for OptROM Support.

Navigate to:
* [[Dissasembly of RAM and ROM versions of TS-DOS]]
* [[M100 TS-DOS ROM UI Code]]
* [[M100 TS-DOS ROM RST 7 Handlers]]
* [[M100 TS-DOS ROM TPDD Protocol]]
* [[M100 TS-DOS ROM Compression]]
* [[M100 TS-DOS ROM Cold Boot Recovery]]

M100 TS-DOS ROM OptROM Support

2009-04-03T16:36:51Z

208.77.91.41:

== TS-DOS Model 100/102 ROM OptROM Support ==

This code defines the variables used throughout the TS-DOS application as well as the support routines needed to navigate between the Main ROM and the Option ROM (most of them). Also included is the TS-DOS startup code. The assembly labels defined are open for discussion and have not been applied to any of the disassembled code yet.

<pre>
=========================================================================================
; TS-DOS M100 ROM version Disassembly
;
; Initial Disassembly By Kenneth D. Pettit
; March, 2009
;
; =========================================================================================

; =========================================================================================
; Variables in ALTLCD buffer
; =========================================================================================
NB_CUR_DIR equ FCC0H ; NADSBox current directory ("MYFILE.<> ")
TPDD_BANK equ FCCAH ; TPDD2 Bank (side)
NB_TPDD_FLG equ FCCBH ; NADSBox/Desklink/TPDD2 flag (0=TPDD, 1=TPDD2, 2=NADSBox)
LAST_TAG equ FCCCH ; Tag/Untag last operation code
CUR_FILE equ FCCDH ; Currently selected file index on UI (1 based)
LJ_SP equ FCCEH ; Stack pointer upon entry for Long Jump
LJ_RET equ FCD0H ; Return vector for Long Jump "RETURN"
ERR_MODE equ FCD2H ; Print Error Messages flag, 1=Print, 0=Generate System Error
FDC_OPCODE equ FCD3H ; FDC Emulation mode opcode
CUR_PAGE equ FCD4H ; Current page of files being displayed (0 based)
TMP_FILE_IDX equ FCD5H ; Currently selected file index on UI - temp
FILE_COUNT equ FCD6H ; Count of files currently displayed on LCD
MAX_FILES equ FCD7H ; Maximum files that fit on the LCD
DISP_MODE equ FCD9H ; RAM / Disk Display mode (0=RAM, 1=DISK)
SKIP_PAGE equ FCDAH ; TPDD "skip page" count (number of pages to read and discard)
FILE_LEN equ FCDBH ; Pointer to "Current file" length bytes (in keyboard buffer)
PHYS_SCTR equ FCDDH ; FDC Emulation Physical Sector Number / Active File Length LSB
LOG_SCTR equ FCDEH ; FDC Emulation Logical Sector Number / Active File Length MSB
KEY_TYPE equ FCDFH ; Storage for FDC emulation / New file type code / Keypress storage
FILE_ADDR equ FCE0H ; Address of file being displayed/printed/loaded/saved
FILE_BUFF equ FCE2H ; Pointer for TPDD direct read data / address of file being read/written
TX_PKT_BUF equ FCE6H ; Storage for TX packets (28 bytes)
RX_PKT_BUF equ FD02H ; Storage for RX packets (130 bytes ??)

; =========================================================================================
; Main Entry point when called from "CALL 63013,1"
; =========================================================================================

.org 0000H

0000H JMP 00B2H ; Jump to entry point handler

; =========================================================================================
; Pop registers after we power back up from a powerdown (I think)
; =========================================================================================
0003H POP H
0004H POP D
0005H POP B
0006H POP PSW
0007H RET

; =========================================================================================
; RST 1 - Call Main ROM at location whose address follows RST 1 opcode
; =========================================================================================
0008H JMP 0080H ; BASIC statement keyword table END to NEW

; =========================================================================================
; RST 2 - Call Main ROM's RST 2 routine
; =========================================================================================
0010H RST 1 ; Call main ROM at address in following 2 bytes
0011H DW 0010H ; Call the Main ROM's RST 2 function
0013H RET

; =========================================================================================
; RST 3 routine - Compare HL and DE
; =========================================================================================
0018H JMP 006CH ; Jump to comparison routine

; =========================================================================================
; Return to Main ROM. After issuing the OUT E0H, we will be in Main ROM. The next opcode
; in Main ROM after this OUT statement occurs will be a RET (part of RST 1). We have
; PUSHed a return address to the stack, so the main ROM's RET instruction will get us
; where to intend to go.
; =========================================================================================
001BH OUT E0H ; Send A to the ROM bank port to switch to Main ROM
001DH RET ; Should never execute this instruction, but just in case

; =========================================================================================
; Send a space to the screen/printer - Not called from anywhere. Copy of Main ROM.
; =========================================================================================
001EH MVI A,20H ; Prepare to print a SPACE

; =========================================================================================
; RST 3 routine - Send character in A to the screen / printer
; =========================================================================================
0020H RST 1 ; Call main ROM at address in following 2 bytes
0021H DW 0020H ; Main ROM's RST 3 routine
0023H RET

; =========================================================================================
; Power down TRAP. Let Main ROM deal with it.
; =========================================================================================
0024H DI ; Disable interrupts while we jump
0025H CALL 0097H ; Jump to Main ROM's RST handler for this vector
0028H POP H
0029H JMP 0003H ; Pop regs after we power back up from a power-down?

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - Bar Code Reader
; =========================================================================================
002CH DI ; Disable interrupts while we jump
002DH CALL 0097H ; Jump to Main ROM's RST handler for this vector

; =========================================================================================
; Return from Main ROM hook in RAM returns here via RST 6
; =========================================================================================
0030H POP PSW ; Cleanup stack
0031H POP PSW ; Cleanup stack
0032H RET ; Return to OptROM execution point

0033H NOP ; Filler

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - RS232 character pending
; =========================================================================================
0034H DI ; Disable interrupts while we jump
0035H CALL 0097H ; Jump to Main ROM's RST handler for this vector
0038H JMP 00A6H ; Stack cleanup

003BH NOP ; UNUSED - filler

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - Timer background task
; =========================================================================================
003CH DI ; Disable interrupts
003DH CALL 0097H ; Jump to Main ROM's RST handler for this vector

; =========================================================================================
; This routine gets copied to RAM to be used for switching back to the TS-DOS ROM after
; calling a routine in the Main ROM.
; =========================================================================================
0040H PUSH PSW ; Preserve the PSW
0041H LDA FF45H ; Contents of port E8H
0044H INR A ; Prepare to switch to OptRom
0045H OUT E0H ; Switch to OptRom
0047H RST 6 ; Get sign of FAC1

; =========================================================================================
; This routine gets copied to RAM and appears to detect the presence of the TS-DOS ROM
; after power-up and copies the original "External ROM" detection routine to RAM
; if the TS-DOS ROM is no longer present. At least I think that's what it's doing.
; =========================================================================================
0048H LXI D,F605H ; Copy address for "Ext ROM detect" routine
004BH INR A ; Set bit to enable OptROM
004CH OUT E0H ; Switch to OptROM
004EH XRA A ; Prepare to switch back to Main ROM
004FH LHLD 0049H ; Load target address of the LXI D instruction above
0052H OUT E0H ; Switch back to Main ROM
0054H RST 3 ; Compare DE and HL - Test if OptROM is TS-DOS
0055H CPI 01H ; Test for TS-DOS ROM
0057H RC ; Return if TS-DOS ROM
0058H LXI H,111DH ; Load "Return" address to the CALL below
005BH SHLD FAE0H
005EH SHLD F5F2H ; Save a "Restart signature" ???
0061H CALL 2905H ; Copy the DB number of bytes from the DW address to (DE)
0064H DB 24H ; ....copy 24H bytes
0065H DW 036FH ; ....from ROM addres 036F (external ROM detect)
0067H RST 0 ; I'm not sure it it every actually returns here or not
0068H NOP
0069H CALL FAA4H ; Call our installed RAM hook to return to TS-DOS

; =========================================================================================
; Compare HL and DE - called by the RST 3 routine
; =========================================================================================
006CH MOV A,H ; Move H into A for comparison
006DH SUB D ; Compare MSB first
006EH RNZ ; Return if no match
006FH MOV A,L ; Now move L into A
0070H SUB E ; Compare LSB
0071H RET ; Return with flags set

; =========================================================================================
; Copy 8 bytes from DE to HL
; =========================================================================================
0072H LXI B,0008H ; Prepare to copy 8 bytes

; =========================================================================================
; Copy BC bytes from DE to HL
; =========================================================================================
0075H LDAX D ; Load value from (DE)
0076H MOV M,A ; Save value to (HL)
0077H INX D ; Increment DE
0078H INX H ; Increment HL
0079H DCX B ; Decrement counter
007AH MOV A,B ; Prepare to test counter for zero
007BH ORA C ; Test counter for zero
007CH JNZ 0075H ; Keep looping until 8 bytes copied
007FH RET

; =========================================================================================
; Handle the RST 1 routine. Read the Main ROM address from the 2 bytes after the RST 1
; =========================================================================================
0080H SHLD F9B2H ; Save HL off in "RickY" Cat entry so we don't clobber it
0083H POP H ; Get out return address (location of the ROM address to call
0084H PUSH D ; Push the return address back to the stack as storage
0085H MOV E,M ; Get LSB of the ROM address to call
0086H INX H ; Point to MSB of ROM address to call
0087H MOV D,M ; Get MSB of the ROM address to call
0088H INX H ; Point to return address after the RST 1 DB address
0089H XTHL ; Put the return address on the stack so we return after the RST 1
008AH XCHG ; Now get the address within ROM to call
008BH PUSH H ; Push the target ROM address to the stack so we "RETurn" there
008CH LXI H,FAA4H ; Load address of our RAM hook to switch back to our ROM bank and RET
008FH XTHL ; Push that address on the stack for after the ROM call is complete
0090H PUSH H ; Now put the ROM address back on the stack so we will RET there
0091H LHLD F9B2H ; Restore HL from temp storage in "RickY"
0094H JMP 00A6H ; Branch to switch to Main ROM and "RET" to the address we pushed

; =========================================================================================
; RST handler for calling the Main ROM's RST handlers. This routine restores the original
; RST vector address to the stack, and jumps to the Main ROM's RST routine while
; preserving all register values.
; =========================================================================================
0097H SHLD F9B4H ; Save HL temporarily (somewhere in RickY's name)
009AH LXI H,FAA4H ; Point to our RAM hook for returning to TS-DOS
009DH XTHL ; Put the hook address as the return address on the stack
009EH DCX H ; Decrement the return address by 4
009FH DCX H ; ...this will result in the starting address of the RST
00A0H DCX H ; ...that brought us here
00A1H DCX H
00A2H PUSH H ; Push the RST vector address to the stack
00A3H LHLD F9B4H ; Restore HL upon entry
00A6H PUSH PSW ; Save A to the stack
00A7H PUSH H ; Save the HL to the stack so we can preserve through XTHL
00A8H LXI H,1488H ; Load a RETurn address in the Main ROM (a POP PSW & RET)
00ABH XTHL ; Push the address and get HL back
00ACH LDA FF45H ; Contents of port E8H - prepare for jump to Main ROM
00AFH JMP 001BH ; Jump to Main ROM & our custom "RET" address in the ROM

; =========================================================================================
; Manual invocation entry point. This is where we jump when "CALL 63013,1" is invoked
; =========================================================================================
00B2H DI ; Disable interrupts so nobody bugs us yet
00B3H CPI 08H ; Check the invocation parameter to test for recovery request
00B5H JNC 0100H ; Jump to test for recovery mode
00B8H MOV B,A ; Save the calling paramter to B
00B9H PUSH B ; Save BC to the stack
00BAH PUSH D ; Save DE to the stack
00BBH PUSH H ; Save HL to the stack
00BCH LXI D,0040H ; Load address of our "Change to OptROM" routine
00BFH LXI H,FAA4H ; Load pointer to somewhere in RAM to hold our routine
00C2H CALL 0072H ; Copy 8 bytes from DE to HL
00C5H LXI B,0024H ; Now prepare to copy 36 bytes worth of "routine"
00C8H LXI H,F605H ; Point to another RAM location
00CBH CALL 0075H ; Copy the next "ROM Bank Switching" routine from our ROM
00CEH POP H ; Restore HL
00CFH POP D ; Restore DE
00D0H POP PSW ; Restore A
00D1H EI ; Allow interrupts again
00D2H JMP 0100H ; Go test if a "Cold Start" recovery is being requested

.org 100H

; =========================================================================================
; Test if cold-start recovery requested
; =========================================================================================
0100H MOV A,H ; Move H to A to test HL for zero
0101H ORA L ; Test for zero
0102H JZ 7000H ; Call recovery routine if requested
0105H POP H ; Pop the return address. We will exit manually
0106H CALL 0117H ; Ensure the TS-DOS progam is installed in the MENU
0109H JMP 3535H ; Jump to the TS-DOS UI

; =========================================================================================
; Move BC bytes from (HL) to (DE) with increment
; =========================================================================================
010CH MOV A,M ; Get next byte from (HL)
010DH STAX D ; Save byte in (DE)
010EH INX H ; Increment source pointer
010FH INX D ; Increment destination pointer
0110H DCX B ; Decrement loop control
0111H MOV A,B ; Move MSB to A to test for zero
0112H ORA C ; OR in LSB to test for zero
0113H JNZ 010CH ; Branch to copy next byte until done
0116H RET

; =========================================================================================
; Insert the "TS-DOS" invocation program (BASIC program) into the Catalog / MENU.
; we always insert ourselves at the lowest RAM address.
; =========================================================================================
0117H LXI H,01E1H ; Point to "TS-DOS" catalog entry in our ROM
011AH PUSH H ; Save the address on the stack for later
011BH INX H ; Point to the text portion of the catalog entry
011CH LXI B,0008H ; Prepare to copy 8 filename byte
011FH LXI D,FC93H ; Filename of current BASIC program
0122H CALL 010CH ; Copy BC bytes from HL to DE - put "TS-DOS " in cur. BASIC prog.
0125H XCHG ; HL <--> DE DE now has the address of the invocation program
0126H LHLX ; Get the length of the BASIC program into HL
0127H SHLD FCC4H ; Save the BASIC program length in the ALTLCD buffer for now
012AH INX D ; Point to MSB of the length
012BH INX D ; Point to LSB of the pointer to the "Next" BASIC instruction
012CH XCHG ; HL <--> DE HL has the pointer to the "Next" BASIC inst address
012DH SHLD FCC8H ; Save the "Next" BASIC inst pointer to ALTLCD (start of program)
0130H CALL 01D1H ; Update the System pointers
0133H CALL 01CDH ; Search Catalog for entry matching current BASIC program
0136H POP B ; Pop address in case we return
0137H RNZ ; Return if "TS-DOS" is already in the catalog
0138H LHLD F99AH ; Get the BASIC program not saved pointer - insert before that
013BH SHLD FCC2H ; Save storage location for the TS-DOS invocation progam
013EH LDAX B ; Load the file type byte from our ROM (B has the address from above)
013FH STA FCC6H ; Store the Type byte in the ALTLCD
0142H CALL 0185H ; Find empty entry in Catalog
0145H RC ; Return if catalog full
0146H PUSH H ; Save the address of the empty catalog entry to the stack
0147H LHLD FCC4H ; Restore the BASIC program length from ALTLCD
014AH MOV B,H ; Move BASIC program length to BC for copy
014BH MOV C,L ; Move LSB of length
014CH PUSH B ; Save Length to the stack
014DH LHLD FCC2H ; Get address of insertion for TS-DOS just before the unsaved BASIC prog.
0150H CALL 01DDH ; Call Main ROM's Insert BC spaces at M routine
0153H JC 0182H ; Abort if RAM full
0156H LHLD FCC2H ; Get address of insertion point again
0159H XCHG ; DE now has insertion point for BASIC program
015AH LHLD FCC8H ; Get the address of the BASIC program (in our ROM) from ALTLCD
015DH POP B ; Restore copy length of the BASIC program
015EH CALL 010CH ; Move BC bytes from (HL) to (DE) with increment
0161H POP D ; Get the address of the empty catalog entry we will use for TS-DOS
0162H PUSH D ; Save it back to the stack
0163H LHLD FBAEH ; Load the start of DO files pointer
0166H DCX H ; Derement the start of DO files pointer
0167H SHLD F99AH ; Save it as the new BASIC program not saved pointer
016AH INX H ; Point to start of DO files again
016BH XCHG ; Move it to DE
016CH LHLD FCC4H ; Load the TS-DOS BASIC progam length from ALTLCD
016FH DAD D ; Offset the start of DO files by the insertion amount
0170H SHLD FBAEH ; Save the new start of DO files pointer
0173H POP D ; Restore the address of the empty catalog entry
0174H LHLD FCC2H ; Get the starting address of the newly inserted TS-DOS program
0177H XCHG ; HL <--> DE Swap for the call to the catalog insertion routine
0178H LDA FCC6H ; Load A with the file type byte
017BH CALL 01D5H ; Save current BASIC program to the Catalog entry at HL
017EH CALL 01D1H ; Update system pointers
0181H RET

; =========================================================================================
; Insert "TS-DOS" RAM full abort routine ... stack cleanup.
; =========================================================================================
0182H POP H ; Pop the BASIC program length from the stack
0183H POP H ; Pop the catalog entry address from the stack
0184H RET

; =========================================================================================
; Find an empty entry in the Catalog. HL points to start of new entry
; This routine appears again at address 3E48H
; =========================================================================================
0185H LXI H,F9AFH ; Point to "RickY" to start search at beginning of catalog
0188H LXI B,000BH ; Get length of each entry in the Catalog
018BH DAD B ; Point to next entry in the catalog
018CH MOV A,M ; Get the File Attribute byte from the catalog for this file
018DH CPI FFH ; Test if at end of the catalog
018FH JZ 0197H ; Jump to set Carry flag and exit if at end
0192H ADD A ; Test if MSB set (test if entry available)
0193H JC 018BH ; Branch to get next entry if this one is used
0196H RET ; Return with Carry clear to indicate entry found

; =========================================================================================
; Empty catalog entry not found in Catalog, set Carry and return
; =========================================================================================
0197H STC ; Set the Carry flag - not found
0198H RET

; =========================================================================================
; Call Main ROM's Display function key line routine
; =========================================================================================
0199H RST 1 ; Call main ROM at address in following 2 bytes
019AH DW 42A8H
019CH RET

; =========================================================================================
; Call Main ROM's Erase function key display routine
; =========================================================================================
019DH RST 1 ; Call main ROM at address in following 2 bytes
019EH DW 428AH
01A0H RET

; =========================================================================================
; Call Main ROM's Set new function key table routine
; =========================================================================================
01A1H RST 1 ; Call main ROM at address in following 2 bytes
01A2H DW 5A7CH
01A4H RET

; =========================================================================================
; Call Main ROM's Wait for key from keyboard routine
; =========================================================================================
01A5H RST 1 ; Call main ROM at address in following 2 bytes
01A6H DW 12CBH
01A8H RET

; =========================================================================================
; Call Main ROM's Scan keyboard for character (CTRL-BREAK ==> CTRL-C) routine
; This appears later in the code also
; =========================================================================================
01A9H RST 1 ; Call main ROM at address in following 2 bytes
01AAH DW 7242H
01ACH RET

; =========================================================================================
; Call Main ROM's Power Down routine
; This appears later in the code also
; =========================================================================================
01ADH RST 1 ; Call main ROM at address in following 2 bytes
01AEH DW 13B5H
01B0H RET

; =========================================================================================
; Call Main ROM's Renew automatic power-off counter routine
; This apears later in the code also
; =========================================================================================
01B1H RST 1 ; Call main ROM at address in following 2 bytes
01B2H DW 1BB1H
01B4H RET

; =========================================================================================
; Call Main ROM's CLS statement routine
; This apears later in the code also
; =========================================================================================
01B5H RST 1 ; Call main ROM at address in following 2 bytes
01B6H DW 4231H
01B8H RET

; =========================================================================================
; Call Main ROM's Start inverse character mode routine
; This appears later in the code also
; =========================================================================================
01B9H RST 1 ; Call main ROM at address in following 2 bytes
01BAH DW 4269H
01BCH RET

; =========================================================================================
; Call Main ROM's Cancel inverse video routine
; This appears later in the code also
; =========================================================================================
01BDH RST 1 ; Call main ROM at address in following 2 bytes
01BEH DW 426EH
01C0H RET

; =========================================================================================
; Call Main ROM's Check keyboard queue for pending characters routine
; This appers later in the code also
; =========================================================================================
01C1H RST 1 ; Call main ROM at address in following 2 bytes
01C2H DW 13DBH
01C4H RET

; =========================================================================================
; Call Main ROM's Stop automatic scrolling routine
; This appers later in the code also
; =========================================================================================
01C5H RST 1 ; Call main ROM at address in following 2 bytes
01C6H DW 423FH
01C8H RET

; =========================================================================================
; Call Main ROM's Reset vector routine
; =========================================================================================
01C9H RST 1 ; Call main ROM at address in following 2 bytes
01CAH DW 0000H
01CCH RET

; =========================================================================================
; Search Catalog for entry matching current BASIC program
; =========================================================================================
01CDH RST 1 ; Call main ROM at address in following 2 bytes
01CEH DW 20AFH
01D0H RET

; =========================================================================================
; Call Main ROM's Update system pointers routine
; =========================================================================================
01D1H RST 1 ; Call main ROM at address in following 2 bytes
01D2H DW 2146H
01D4H RET

; =========================================================================================
; Call Main ROM's routine to save current BASIC program to the Catalog entry at HL
; =========================================================================================
01D5H RST 1 ; Call main ROM at address in following 2 bytes
01D6H DW 2239H
01D8H RET

; =========================================================================================
; Not a valid entry into ROM and not called anywhere
; =========================================================================================
01D9H RST 1 ; Call main ROM at address in following 2 bytes
01DAH DW 5825H
01DCH RET

; =========================================================================================
; Call Main ROM's Insert BC spaces at M routine
; =========================================================================================
01DDH RST 1 ; Call main ROM at address in following 2 bytes
01DEH DB 6B6DH
01E0H RET

; =========================================================================================
; TS-DOS entry that will be inserted into the catalog for invoking TS-DOS
; =========================================================================================
01E1H DB 80H ; TS-DOS file type for catalog entry
01E2H DB "TS-DOS " ; TS-DOS Catalog name entry

; =========================================================================================
; BASIC program that will be inserted into RAM to launch TS-DOS from the MENU/Catalog entry
; =========================================================================================
01EAH DB 0FH,00H,0EH,80H ; BASIC program length and pointer to "Next" BASIC instruction
01EDH DB 0AH,00H,B9H ; BASIC Line number "10" and BASIC token for CALL
01EFH DB "63013,1" ; CALL argument
01F5H DB 00H,00H ; BASIC terminating zeros

</pre>

End of disassembly for OptROM Support.

Navigate to:
* [[Dissasembly of RAM and ROM versions of TS-DOS]]
* [[M100 TS-DOS ROM UI Code]]
* [[M100 TS-DOS ROM RST 7 Handlers]]
* [[M100 TS-DOS ROM TPDD Protocol]]
* [[M100 TS-DOS ROM Compression]]
* [[M100 TS-DOS ROM Cold Boot Recovery]]

M100 TS-DOS ROM OptROM Support

2009-04-03T16:21:11Z

208.77.91.41:

== TS-DOS Model 100/102 ROM OptROM Support ==

This code defines the variables used throughout the TS-DOS application as well as the support routines needed to navigate between the Main ROM and the Option ROM (most of them). Also included is the TS-DOS startup code. The assembly labels defined are open for discussion and have not been applied to any of the disassembled code yet.

<pre>
=========================================================================================
; TS-DOS M100 ROM version Disassembly
;
; Initial Disassembly By Kenneth D. Pettit
; March, 2009
;
; =========================================================================================

; =========================================================================================
; Variables in ALTLCD buffer
; =========================================================================================
NB_CUR_DIR equ FCC0H ; NADSBox current directory ("MYFILE.<> ")
TPDD_BANK equ FCCAH ; TPDD2 Bank (side)
NB_TPDD_FLG equ FCCBH ; NADSBox/Desklink/TPDD2 flag (0=TPDD, 1=TPDD2, 2=NADSBox)
LAST_TAG equ FCCCH ; Tag/Untag last operation code
CUR_FILE equ FCCDH ; Currently selected file index on UI (1 based)
LJ_SP equ FCCEH ; Stack pointer upon entry for Long Jump
LJ_RET equ FCD0H ; Return vector for Long Jump "RETURN"
ERR_MODE equ FCD2H ; Print Error Messages flag, 1=Print, 0=Generate System Error
FDC_OPCODE equ FCD3H ; FDC Emulation mode opcode
CUR_PAGE equ FCD4H ; Current page of files being displayed (0 based)
TMP_FILE_IDX equ FCD5H ; Currently selected file index on UI - temp
FILE_COUNT equ FCD6H ; Count of files currently displayed on LCD
MAX_FILES equ FCD7H ; Maximum files that fit on the LCD
DISP_MODE equ FCD9H ; RAM / Disk Display mode (0=RAM, 1=DISK)
SKIP_PAGE equ FCDAH ; TPDD "skip page" count (number of pages to read and discard)
FILE_LEN equ FCDBH ; Pointer to "Current file" length bytes (in keyboard buffer)
PHYS_SCTR equ FCDDH ; FDC Emulation Physical Sector Number / Active File Length LSB
LOG_SCTR equ FCDEH ; FDC Emulation Logical Sector Number / Active File Length MSB
KEY_TYPE equ FCDFH ; Storage for FDC emulation / New file type code / Keypress storage
FILE_ADDR equ FCE0H ; Address of file being displayed/printed/loaded/saved
FILE_BUFF equ FCE2H ; Pointer for TPDD direct read data / address of file being read/written
TX_PKT_BUF equ FCE6H ; Storage for TX packets (28 bytes)
RX_PKT_BUF equ FD02H ; Storage for RX packets (130 bytes ??)

; =========================================================================================
; Main Entry point when called from "CALL 63013,1"
; =========================================================================================

.org 0000H

0000H JMP 00B2H ; Jump to entry point handler

; =========================================================================================
; Pop registers after we power back up from a powerdown (I think)
; =========================================================================================
0003H POP H
0004H POP D
0005H POP B
0006H POP PSW
0007H RET

; =========================================================================================
; RST 1 - Call Main ROM at location whose address follows RST 1 opcode
; =========================================================================================
0008H JMP 0080H ; BASIC statement keyword table END to NEW

; =========================================================================================
; RST 2 - Call Main ROM's RST 2 routine
; =========================================================================================
0010H RST 1 ; Call main ROM at address in following 2 bytes
0011H DW 0010H ; Call the Main ROM's RST 2 function
0013H RET

; =========================================================================================
; RST 3 routine - Compare HL and DE
; =========================================================================================
0018H JMP 006CH ; Jump to comparison routine

; =========================================================================================
; Return to Main ROM. After issuing the OUT E0H, we will be in Main ROM. The next opcode
; in Main ROM after this OUT statement occurs will be a RET (part of RST 1). We have
; PUSHed a return address to the stack, so the main ROM's RET instruction will get us
; where to intend to go.
; =========================================================================================
001BH OUT E0H ; Send A to the ROM bank port to switch to Main ROM
001DH RET ; Should never execute this instruction, but just in case

; =========================================================================================
; Send a space to the screen/printer - Not called from anywhere. Copy of Main ROM.
; =========================================================================================
001EH (3EH) MVI A,20H ; Prepare to print a SPACE

; =========================================================================================
; RST 3 routine - Send character in A to the screen / printer
; =========================================================================================
0020H (CFH) RST 1 ; Call main ROM at address in following 2 bytes
0021H DW 0020H ; Main ROM's RST 3 routine
0023H (C9H) RET

; =========================================================================================
; Power down TRAP. Let Main ROM deal with it.
; =========================================================================================
0024H DI ; Disable interrupts while we jump
0025H CALL 0097H ; Jump to Main ROM's RST handler for this vector
0028H POP H
0029H JMP 0003H ; Pop regs after we power back up from a power-down?

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - Bar Code Reader
; =========================================================================================
002CH DI ; Disable interrupts while we jump
002DH CALL 0097H ; Jump to Main ROM's RST handler for this vector

; =========================================================================================
; Return from Main ROM hook in RAM returns here via RST 6
; =========================================================================================
0030H POP PSW ; Cleanup stack
0031H POP PSW ; Cleanup stack
0032H RET ; Return to OptROM execution point

0033H NOP ; Filler

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - RS232 character pending
; =========================================================================================
0034H DI ; Disable interrupts while we jump
0035H CALL 0097H ; Jump to Main ROM's RST handler for this vector
0038H JMP 00A6H ; Stack cleanup

003BH NOP ; UNUSED - filler

; =========================================================================================
; Hardware Interrupt - Let Main ROM deal with it - Timer background task
; =========================================================================================
003CH DI ; Disable interrupts
003DH CALL 0097H ; Jump to Main ROM's RST handler for this vector

; =========================================================================================
; This routine gets copied to RAM to be used for switching back to the TS-DOS ROM after
; calling a routine in the Main ROM.
; =========================================================================================
0040H PUSH PSW ; Preserve the PSW
0041H LDA FF45H ; Contents of port E8H
0044H INR A ; Prepare to switch to OptRom
0045H OUT E0H ; Switch to OptRom
0047H RST 6 ; Get sign of FAC1

; =========================================================================================
; This routine gets copied to RAM and appears to detect the presence of the TS-DOS ROM
; after power-up and copies the original "External ROM" detection routine to RAM
; if the TS-DOS ROM is no longer present. At least I think that's what it's doing.
; =========================================================================================
0048H LXI D,F605H ; Copy address for "Ext ROM detect" routine
004BH INR A ; Set bit to enable OptROM
004CH OUT E0H ; Switch to OptROM
004EH XRA A ; Prepare to switch back to Main ROM
004FH LHLD 0049H ; Load target address of the LXI D instruction above
0052H OUT E0H ; Switch back to Main ROM
0054H RST 3 ; Compare DE and HL - Test if OptROM is TS-DOS
0055H CPI 01H ; Test for TS-DOS ROM
0057H RC ; Return if TS-DOS ROM
0058H LXI H,111DH ; Load "Return" address to the CALL below
005BH SHLD FAE0H
005EH SHLD F5F2H ; Save a "Restart signature" ???
0061H CALL 2905H ; Copy the DB number of bytes from the DW address to (DE)
0064H DB 24H ; ....copy 24H bytes
0065H DW 036FH ; ....from ROM addres 036F (external ROM detect)
0067H RST 0 ; I'm not sure it it every actually returns here or not
0068H NOP
0069H CALL FAA4H ; Call our installed RAM hook to return to TS-DOS

; =========================================================================================
; Compare HL and DE - called by the RST 3 routine
; =========================================================================================
006CH MOV A,H ; Move H into A for comparison
006DH SUB D ; Compare MSB first
006EH RNZ ; Return if no match
006FH MOV A,L ; Now move L into A
0070H SUB E ; Compare LSB
0071H RET ; Return with flags set

; =========================================================================================
; Copy 8 bytes from DE to HL
; =========================================================================================
0072H LXI B,0008H ; Prepare to copy 8 bytes

; =========================================================================================
; Copy BC bytes from DE to HL
; =========================================================================================
0075H LDAX D ; Load value from (DE)
0076H MOV M,A ; Save value to (HL)
0077H INX D ; Increment DE
0078H INX H ; Increment HL
0079H DCX B ; Decrement counter
007AH MOV A,B ; Prepare to test counter for zero
007BH ORA C ; Test counter for zero
007CH JNZ 0075H ; Keep looping until 8 bytes copied
007FH RET

; =========================================================================================
; Handle the RST 1 routine. Read the Main ROM address from the 2 bytes after the RST 1
; =========================================================================================
0080H SHLD F9B2H ; Save HL off in "RickY" Cat entry so we don't clobber it
0083H POP H ; Get out return address (location of the ROM address to call
0084H PUSH D ; Push the return address back to the stack as storage
0085H MOV E,M ; Get LSB of the ROM address to call
0086H INX H ; Point to MSB of ROM address to call
0087H MOV D,M ; Get MSB of the ROM address to call
0088H INX H ; Point to return address after the RST 1 DB address
0089H XTHL ; Put the return address on the stack so we return after the RST 1
008AH XCHG ; Now get the address within ROM to call
008BH PUSH H ; Push the target ROM address to the stack so we "RETurn" there
008CH LXI H,FAA4H ; Load address of our RAM hook to switch back to our ROM bank and RET
008FH XTHL ; Push that address on the stack for after the ROM call is complete
0090H PUSH H ; Now put the ROM address back on the stack so we will RET there
0091H LHLD F9B2H ; Restore HL from temp storage in "RickY"
0094H JMP 00A6H ; Branch to switch to Main ROM and "RET" to the address we pushed

; =========================================================================================
; RST handler for calling the Main ROM's RST handlers. This routine restores the original
; RST vector address to the stack, and jumps to the Main ROM's RST routine while
; preserving all register values.
; =========================================================================================
0097H SHLD F9B4H ; Save HL temporarily (somewhere in RickY's name)
009AH LXI H,FAA4H ; Point to our RAM hook for returning to TS-DOS
009DH XTHL ; Put the hook address as the return address on the stack
009EH DCX H ; Decrement the return address by 4
009FH DCX H ; ...this will result in the starting address of the RST
00A0H DCX H ; ...that brought us here
00A1H DCX H
00A2H PUSH H ; Push the RST vector address to the stack
00A3H LHLD F9B4H ; Restore HL upon entry
00A6H PUSH PSW ; Save A to the stack
00A7H PUSH H ; Save the HL to the stack so we can preserve through XTHL
00A8H LXI H,1488H ; Load a RETurn address in the Main ROM (a POP PSW & RET)
00ABH XTHL ; Push the address and get HL back
00ACH LDA FF45H ; Contents of port E8H - prepare for jump to Main ROM
00AFH JMP 001BH ; Jump to Main ROM & our custom "RET" address in the ROM

; =========================================================================================
; Manual invocation entry point. This is where we jump when "CALL 63013,1" is invoked
; =========================================================================================
00B2H DI ; Disable interrupts so nobody bugs us yet
00B3H CPI 08H ; Check the invocation parameter to test for recovery request
00B5H JNC 0100H ; Jump to test for recovery mode
00B8H MOV B,A ; Save the calling paramter to B
00B9H PUSH B ; Save BC to the stack
00BAH PUSH D ; Save DE to the stack
00BBH PUSH H ; Save HL to the stack
00BCH LXI D,0040H ; Load address of our "Change to OptROM" routine
00BFH LXI H,FAA4H ; Load pointer to somewhere in RAM to hold our routine
00C2H CALL 0072H ; Copy 8 bytes from DE to HL
00C5H LXI B,0024H ; Now prepare to copy 36 bytes worth of "routine"
00C8H LXI H,F605H ; Point to another RAM location
00CBH CALL 0075H ; Copy the next "ROM Bank Switching" routine from our ROM
00CEH POP H ; Restore HL
00CFH POP D ; Restore DE
00D0H POP PSW ; Restore A
00D1H EI ; Allow interrupts again
00D2H JMP 0100H ; Go test if a "Cold Start" recovery is being requested

.org 100H

; =========================================================================================
; Test if cold-start recovery requested
; =========================================================================================
0100H MOV A,H ; Move H to A to test HL for zero
0101H ORA L ; Test for zero
0102H JZ 7000H ; Call recovery routine if requested
0105H POP H ; Pop the return address. We will exit manually
0106H CALL 0117H ; Ensure the TS-DOS progam is installed in the MENU
0109H JMP 3535H ; Jump to the TS-DOS UI

; =========================================================================================
; Move BC bytes from (HL) to (DE) with increment
; =========================================================================================
010CH MOV A,M ; Get next byte from (HL)
010DH STAX D ; Save byte in (DE)
010EH INX H ; Increment source pointer
010FH INX D ; Increment destination pointer
0110H DCX B ; Decrement loop control
0111H MOV A,B ; Move MSB to A to test for zero
0112H ORA C ; OR in LSB to test for zero
0113H JNZ 010CH ; Branch to copy next byte until done
0116H RET

; =========================================================================================
; Insert the "TS-DOS" invocation program (BASIC program) into the Catalog / MENU.
; we always insert ourselves at the lowest RAM address.
; =========================================================================================
0117H LXI H,01E1H ; Point to "TS-DOS" catalog entry in our ROM
011AH PUSH H ; Save the address on the stack for later
011BH INX H ; Point to the text portion of the catalog entry
011CH LXI B,0008H ; Prepare to copy 8 filename byte
011FH LXI D,FC93H ; Filename of current BASIC program
0122H CALL 010CH ; Copy BC bytes from HL to DE - put "TS-DOS " in cur. BASIC prog.
0125H XCHG ; HL <--> DE DE now has the address of the invocation program
0126H LHLX ; Get the length of the BASIC program into HL
0127H SHLD FCC4H ; Save the BASIC program length in the ALTLCD buffer for now
012AH INX D ; Point to MSB of the length
012BH INX D ; Point to LSB of the pointer to the "Next" BASIC instruction
012CH XCHG ; HL <--> DE HL has the pointer to the "Next" BASIC inst address
012DH SHLD FCC8H ; Save the "Next" BASIC inst pointer to ALTLCD (start of program)
0130H CALL 01D1H ; Update the System pointers
0133H CALL 01CDH ; Search Catalog for entry matching current BASIC program
0136H POP B ; Pop address in case we return
0137H RNZ ; Return if "TS-DOS" is already in the catalog
0138H LHLD F99AH ; Get the BASIC program not saved pointer - insert before that
013BH SHLD FCC2H ; Save storage location for the TS-DOS invocation progam
013EH LDAX B ; Load the file type byte from our ROM (B has the address from above)
013FH STA FCC6H ; Store the Type byte in the ALTLCD
0142H CALL 0185H ; Find empty entry in Catalog
0145H RC ; Return if catalog full
0146H PUSH H ; Save the address of the empty catalog entry to the stack
0147H LHLD FCC4H ; Restore the BASIC program length from ALTLCD
014AH MOV B,H ; Move BASIC program length to BC for copy
014BH MOV C,L ; Move LSB of length
014CH PUSH B ; Save Length to the stack
014DH LHLD FCC2H ; Get address of insertion for TS-DOS just before the unsaved BASIC prog.
0150H CALL 01DDH ; Call Main ROM's Insert BC spaces at M routine
0153H JC 0182H ; Abort if RAM full
0156H LHLD FCC2H ; Get address of insertion point again
0159H XCHG ; DE now has insertion point for BASIC program
015AH LHLD FCC8H ; Get the address of the BASIC program (in our ROM) from ALTLCD
015DH POP B ; Restore copy length of the BASIC program
015EH CALL 010CH ; Move BC bytes from (HL) to (DE) with increment
0161H POP D ; Get the address of the empty catalog entry we will use for TS-DOS
0162H PUSH D ; Save it back to the stack
0163H LHLD FBAEH ; Load the start of DO files pointer
0166H DCX H ; Derement the start of DO files pointer
0167H SHLD F99AH ; Save it as the new BASIC program not saved pointer
016AH INX H ; Point to start of DO files again
016BH XCHG ; Move it to DE
016CH LHLD FCC4H ; Load the TS-DOS BASIC progam length from ALTLCD
016FH DAD D ; Offset the start of DO files by the insertion amount
0170H SHLD FBAEH ; Save the new start of DO files pointer
0173H POP D ; Restore the address of the empty catalog entry
0174H LHLD FCC2H ; Get the starting address of the newly inserted TS-DOS program
0177H XCHG ; HL <--> DE Swap for the call to the catalog insertion routine
0178H LDA FCC6H ; Load A with the file type byte
017BH CALL 01D5H ; Save current BASIC program to the Catalog entry at HL
017EH CALL 01D1H ; Update system pointers
0181H RET

; =========================================================================================
; Insert "TS-DOS" RAM full abort routine ... stack cleanup.
; =========================================================================================
0182H POP H ; Pop the BASIC program length from the stack
0183H POP H ; Pop the catalog entry address from the stack
0184H RET

; =========================================================================================
; Find an empty entry in the Catalog. HL points to start of new entry
; This routine appears again at address 3E48H
; =========================================================================================
0185H LXI H,F9AFH ; Point to "RickY" to start search at beginning of catalog
0188H LXI B,000BH ; Get length of each entry in the Catalog
018BH DAD B ; Point to next entry in the catalog
018CH MOV A,M ; Get the File Attribute byte from the catalog for this file
018DH CPI FFH ; Test if at end of the catalog
018FH JZ 0197H ; Jump to set Carry flag and exit if at end
0192H ADD A ; Test if MSB set (test if entry available)
0193H JC 018BH ; Branch to get next entry if this one is used
0196H RET ; Return with Carry clear to indicate entry found

; =========================================================================================
; Empty catalog entry not found in Catalog, set Carry and return
; =========================================================================================
0197H STC ; Set the Carry flag - not found
0198H RET

; =========================================================================================
; Call Main ROM's Display function key line routine
; =========================================================================================
0199H RST 1 ; Call main ROM at address in following 2 bytes
019AH DW 42A8H
019CH RET

; =========================================================================================
; Call Main ROM's Erase function key display routine
; =========================================================================================
019DH RST 1 ; Call main ROM at address in following 2 bytes
019EH DW 428AH
01A0H RET

; =========================================================================================
; Call Main ROM's Set new function key table routine
; =========================================================================================
01A1H RST 1 ; Call main ROM at address in following 2 bytes
01A2H DW 5A7CH
01A4H RET

; =========================================================================================
; Call Main ROM's Wait for key from keyboard routine
; =========================================================================================
01A5H RST 1 ; Call main ROM at address in following 2 bytes
01A6H DW 12CBH
01A8H RET

; =========================================================================================
; Call Main ROM's Scan keyboard for character (CTRL-BREAK ==> CTRL-C) routine
; This appears later in the code also
; =========================================================================================
01A9H RST 1 ; Call main ROM at address in following 2 bytes
01AAH DW 7242H
01ACH RET

; =========================================================================================
; Call Main ROM's Power Down routine
; This appears later in the code also
; =========================================================================================
01ADH RST 1 ; Call main ROM at address in following 2 bytes
01AEH DW 13B5H
01B0H RET

; =========================================================================================
; Call Main ROM's Renew automatic power-off counter routine
; This apears later in the code also
; =========================================================================================
01B1H RST 1 ; Call main ROM at address in following 2 bytes
01B2H DW 1BB1H
01B4H RET

; =========================================================================================
; Call Main ROM's CLS statement routine
; This apears later in the code also
; =========================================================================================
01B5H RST 1 ; Call main ROM at address in following 2 bytes
01B6H DW 4231H
01B8H RET

; =========================================================================================
; Call Main ROM's Start inverse character mode routine
; This appears later in the code also
; =========================================================================================
01B9H RST 1 ; Call main ROM at address in following 2 bytes
01BAH DW 4269H
01BCH RET

; =========================================================================================
; Call Main ROM's Cancel inverse video routine
; This appears later in the code also
; =========================================================================================
01BDH RST 1 ; Call main ROM at address in following 2 bytes
01BEH DW 426EH
01C0H RET

; =========================================================================================
; Call Main ROM's Check keyboard queue for pending characters routine
; This appers later in the code also
; =========================================================================================
01C1H RST 1 ; Call main ROM at address in following 2 bytes
01C2H DW 13DBH
01C4H RET

; =========================================================================================
; Call Main ROM's Stop automatic scrolling routine
; This appers later in the code also
; =========================================================================================
01C5H RST 1 ; Call main ROM at address in following 2 bytes
01C6H DW 423FH
01C8H RET

; =========================================================================================
; Call Main ROM's Reset vector routine
; =========================================================================================
01C9H RST 1 ; Call main ROM at address in following 2 bytes
01CAH DW 0000H
01CCH RET

; =========================================================================================
; Search Catalog for entry matching current BASIC program
; =========================================================================================
01CDH RST 1 ; Call main ROM at address in following 2 bytes
01CEH DW 20AFH
01D0H RET

; =========================================================================================
; Call Main ROM's Update system pointers routine
; =========================================================================================
01D1H RST 1 ; Call main ROM at address in following 2 bytes
01D2H DW 2146H
01D4H RET

; =========================================================================================
; Call Main ROM's routine to save current BASIC program to the Catalog entry at HL
; =========================================================================================
01D5H RST 1 ; Call main ROM at address in following 2 bytes
01D6H DW 2239H
01D8H RET

; =========================================================================================
; Not a valid entry into ROM and not called anywhere
; =========================================================================================
01D9H RST 1 ; Call main ROM at address in following 2 bytes
01DAH DW 5825H
01DCH RET

; =========================================================================================
; Call Main ROM's Insert BC spaces at M routine
; =========================================================================================
01DDH RST 1 ; Call main ROM at address in following 2 bytes
01DEH DB 6B6DH
01E0H RET

; =========================================================================================
; TS-DOS entry that will be inserted into the catalog for invoking TS-DOS
; =========================================================================================
01E1H DB 80H ; TS-DOS file type for catalog entry
01E2H DB "TS-DOS " ; TS-DOS Catalog name entry

; =========================================================================================
; BASIC program that will be inserted into RAM to launch TS-DOS from the MENU/Catalog entry
; =========================================================================================
01EAH DB 0FH,00H,0EH,80H ; BASIC program length and pointer to "Next" BASIC instruction
01EDH DB 0AH,00H,B9H ; BASIC Line number "10" and BASIC token for CALL
01EFH DB "63013,1" ; CALL argument
01F5H DB 00H,00H ; BASIC terminating zeros

</pre>

End of disassembly for OptROM Support.

Navigate to:
* [[Dissasembly of RAM and ROM versions of TS-DOS]]
* [[M100 TS-DOS ROM UI Code]]
* [[M100 TS-DOS ROM RST 7 Handlers]]
* [[M100 TS-DOS ROM TPDD Protocol]]
* [[M100 TS-DOS ROM Compression]]
* [[M100 TS-DOS ROM Cold Boot Recovery]]

Desklink/TS-DOS Directory Access

2008-12-31T01:13:18Z

208.77.91.41: /* TPDD Service discovery */

<div>

= TS-DOS Directory Management Extensions Programmer's GuideBy Kenneth D. Pettit =

== Overview ==

TS-DOS was developed as an alternative for accessing the TPDD and TPDD-2 drives from the Tandy and NEC line of laptops (Model 100, 102, 200 and PC-8201a). As part of the design, when used with the companion "DeskLink" PC program, TS-DOS adds the ability to create and manage a directory structure on the target media. This same directory access extension is also built into the NADSBox SD card reader and allows navigation and access of the FAT directory structure on the media card. The extensions were discovered by reverse engineering the communication between a Model 102 and Desklink (running on an HP 200LX) and between TS-DOS and a TPDD-1 using an HP 4951B serial protocol analyzer. This document describes the TS-DOS directory management extensions (DME) and is, to my knowledge, a complete description of the protocol.

== Protocol Structure ==

=== History ===

The TPDD-1 supported two modes of operation for accessing data on the floppy disc - an "Operational" mode and an "FDC Emulation" mode. Each of these modes have a very different command structure and are well documented in the TPDD-1 reference manual. The FDC Emulation mode was used for direct sector access of the data stored on the disc. Neither the TPDD-2 nor Desklink support the FDC Emulation mode and instead add sector access commands in Operational mode to provide the same functionality. 

=== Basic premise for extension addition ===

The directory management extensions in TS-DOS are implemented partially using commands to support the FDC Emulation mode, and partially using a targeted file extension ("<>") in operational mode commands to denote references to a directory or subdirectory on the media. The FDC Emulation mode commands are used to identify if the client supports DME and the "<>" extension is used to specify target directories for creation, deletion or navigation.

=== Request Format ===

Both FDC Emulation requests and Operational mode requests are issued by TS-DOS, although only a single FDC Emulation mode request is used. FDC Emulation requests consist of a single ASCII character with one or more ASCII arguments followed by a carriage return (0Dh). Operational mode requests consist of a Preamble of ZZ (5Ah 5Ah), followed by a Request ID byte, a Payload Length byte, 0 or more payload bytes, terminated by a checksum.

<blockquote>Note: All values are shown as hexadecimal. ASCII character strings are enclosed with quotation marks. The quotation marks are not part of the command or response.</blockquote>

=== Response Format ===

In operational mode, the reponse format is identical to the request format, except that no preamble is sent. In FDC Emulation mode, the reponse format varies depending on the command and the TPDD service. Specific details regarding FDC Emulation mode responses will be described as needed.

== TPDD Service discovery ==

Since TS-DOS must operate with with various TPDD servers, and since not all servers follow the same protocol, it must determine if the server is capable of supporting DME. This is done by sending an FDC Emulation mode command to go into operational mode ("M1"), followed by an operational mode command to go into FDC Emulation mode. For this operational mode sequence, TS-DOS actually terminates the command with a carriage return (0Dh) which isn't part of the standard operational mode protocol. The following two commands are sent: 

=== Directory Management Extensions Request (DMEReq) ===

{| cellspacing="10" cellpadding="10"
| "M1"
| 0D
|
{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Checksum
|-
| 5A 5A
| 08
| 00
| F7
|}
| 0D
|}

 For a TPDD service that supports FDC Emulation mode, the standard response for both commands is no response. If the server does not respond to either command, or responds with an error message, then TS-DOS knows the server does not support DME. If the server does support DME, then after the final carriage return (0Dh), it shall reply with a standard operational mode response. The response ID must be 12h and the payload field must be 11 bytes long and contain the name of the current directory, or at least the lowest level name in the tree, as shown below. The name should be 6 characters long and should be terminated with ".<>",20h. Names shorter than 6 characters should be padded with spaces before the ".<>",20h extension. TS-DOS will display the directory name reported in the DMEResp payload in the upper right corner of the display in reverse video characters. If the current directory is the root "/" directory, then the server should return "ROOT .<> " in the payload filed as a standard, although any name could be provided. TS-DOS will send the DMEReq sequence multiple times including when it has requested a directory change operation. This provides a way of reporting the new subdirectory name for display in the TS-DOS title bar.

=== Directory Management Extensions Response (DMEResp) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Response ID
| Payload Length
| Payload
| Checksum
|-
| 12
| 0B
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Rsvd
| Dir Name
| Extension
|-
| 00
| 6 bytes, space padded
| ".<>",20h
|}
| Checksum
|}

== Directory reporting from Server ==

The server device (DeskLink, NADSBox, etc.) should use the receipt of a DMEReq as an indication to provide directory and subdirectory information to TS-DOS (or any other client). If the DMEReq sequence is not received, then the server is communicating with a DOS that does not support DME, such as TEENY or FLOPPY, etc. Directory information is reported using the same protocol as regular files using the Directory Reference Request with the exception that the extension is reported as "&lt&gt ". Directory Reference Requests are part of the standard TPDD-1 and TPDD-2 protocol and can refer to a specific directory entry, or the first, next or previous entry in the directory. For filename discovery, the "first", "next" or "previous" search forms are used, and the filename is all 00h.

=== Directory Reference Request (DRReq) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Payload
| Checksum
|-
| 5A 5A
| 00
| 1A
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| File Name
| Attribute
| Search Form
|-
| 24d bytes of 00
| "F"
| 01, 02 or 03
|}
| Checksum
|}

 When DME support has been established, the server reports directory information by responding to the DRReq sequence with a Directory Reference Response (DRResp) packet with the filename field containing the directory name in 6.2 filename format. The directory name should be 6 characters or less with space padding and the 2 character extension must be set to "<>". TS-DOS uses the "<>" extension to identify the entry as a directory. When the server is reporting file / directory entries for a directory other than the root, it should provide a mechanism for navigating to the parent directory. In both DeskLink and NADSBox, this is done by reporting the first entry of a subdirectory as "PARENT.<>". The number of Free Sectors on the media should be a single byte with the value 80H or less. Sectors in the TPDD protocol are 1280 bytes in length. 

=== Directory Reference Response (DRResp) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Response ID
| Payload Length
| Payload
| Checksum
|-
| 11
| 1C
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Dir Name
| Ext.
| Spaces (or 00h)
| Attribute
| Size
| Free
|}
|-
| 6 bytes
| "<>"
| 18 (decimal) bytes
| "F"
| 00
| <nowiki># Sectors</nowiki>
|}

{|
| Checksum
|}

== Change Directory requests from TS-DOS ==

When the user navigates the cursor to a directory entry that has the "<>" extension and pressed Enter, TS-DOS will perform a Directory Change operation to naviagte to that directory. This is accomplished by sending a Change Direcotry Reference Request (CDRReq) followed by a standard Open File Request and then a Close File Request. The CDRReq packet is the same as a standard DRReq packet except the filename extension is set to "<>".

=== Change Directory Reference Request (CDRReq) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Payload
| Checksum
|-
| 5A 5A
| 00
| 1A
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Dir Name
| Ext.
| Spaces (or 00h)
| Attribute
| Search Form
|-
| 6 bytes
| "<>"
| 18 (decimal) bytes
| "F"
| 00
|}
| Checksum
|}

 The server should respond to the CDRReq packet with a DRResp response packet containing the same directory name that was passed in the CDRReq. The server should save the directory name and expect to receive a subsequent Open File Request. When the Open File Request is received, the server should process it as a Change Directory operation to the directory specified in the CDRReq packet and return a standard Normal Response Packet (Id = 12H) with the appropriate error code. If the directory name matches the special name given for the parent directory ("PARENT.<>"), then the server should change to the parent of the current directory. The the server should then expect a Close File Request and respond as usual. 

=== Checksum Algorithm ===

Total = Sum of all bytes from TypeID..Last byte of Payload Checksum = (Total & FFh) XOR FFh

Desklink/TS-DOS Directory Access

2008-12-31T01:06:22Z

208.77.91.41: /* Change Directory requests from TS-DOS */

<div>

= TS-DOS Directory Management Extensions Programmer's GuideBy Kenneth D. Pettit =

== Overview ==

TS-DOS was developed as an alternative for accessing the TPDD and TPDD-2 drives from the Tandy and NEC line of laptops (Model 100, 102, 200 and PC-8201a). As part of the design, when used with the companion "DeskLink" PC program, TS-DOS adds the ability to create and manage a directory structure on the target media. This same directory access extension is also built into the NADSBox SD card reader and allows navigation and access of the FAT directory structure on the media card. The extensions were discovered by reverse engineering the communication between a Model 102 and Desklink (running on an HP 200LX) and between TS-DOS and a TPDD-1 using an HP 4951B serial protocol analyzer. This document describes the TS-DOS directory management extensions (DME) and is, to my knowledge, a complete description of the protocol.

== Protocol Structure ==

=== History ===

The TPDD-1 supported two modes of operation for accessing data on the floppy disc - an "Operational" mode and an "FDC Emulation" mode. Each of these modes have a very different command structure and are well documented in the TPDD-1 reference manual. The FDC Emulation mode was used for direct sector access of the data stored on the disc. Neither the TPDD-2 nor Desklink support the FDC Emulation mode and instead add sector access commands in Operational mode to provide the same functionality. 

=== Basic premise for extension addition ===

The directory management extensions in TS-DOS are implemented partially using commands to support the FDC Emulation mode, and partially using a targeted file extension ("<>") in operational mode commands to denote references to a directory or subdirectory on the media. The FDC Emulation mode commands are used to identify if the client supports DME and the "<>" extension is used to specify target directories for creation, deletion or navigation.

=== Request Format ===

Both FDC Emulation requests and Operational mode requests are issued by TS-DOS, although only a single FDC Emulation mode request is used. FDC Emulation requests consist of a single ASCII character with one or more ASCII arguments followed by a carriage return (0Dh). Operational mode requests consist of a Preamble of ZZ (5Ah 5Ah), followed by a Request ID byte, a Payload Length byte, 0 or more payload bytes, terminated by a checksum.

<blockquote>Note: All values are shown as hexadecimal. ASCII character strings are enclosed with quotation marks. The quotation marks are not part of the command or response.</blockquote>

=== Response Format ===

In operational mode, the reponse format is identical to the request format, except that no preamble is sent. In FDC Emulation mode, the reponse format varies depending on the command and the TPDD service. Specific details regarding FDC Emulation mode responses will be described as needed.

== TPDD Service discovery ==

Since TS-DOS must operate with with various TPDD servers, and since not all servers follow the same protocol, it must determine if the server is capable of supporting DME. This is done by sending an FDC Emulation mode command to go into operational mode ("M1"), followed by an operational mode command to go into FDC Emulation mode. For this operational mode sequence, TS-DOS actually terminates the command with a carriage return (0Dh) which isn't part of the standard operational mode protocol. The following two commands are sent: 

=== Directory Management Extensions Request (DMEReq) ===

{| cellspacing="10" cellpadding="10"
| "M1"
| 0D
|
{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Checksum
|-
| 5A 5A
| 08
| 00
| F7
|}
| 0D
|}

 For a TPDD service that supports FDC Emulation mode, the standard response for both commands is no response. If the server does not respond to either command, or responds with an error message, then TS-DOS knows the client does not support DME. If the client does support DME, then after the final carriage return (0Dh), it shall reply with a standard operational mode response. The response ID must be 12h and the payload field must be 11 bytes long and contain the name of the current directory, or at least the lowest level name in the tree, as shown below. The name should be 6 characters long and should be terminated with ".<>",20h. Names shorter than 6 characters should be padded with spaces before the ".<>",20h extension. TS-DOS will display the directory name reported in the DMEResp payload in the upper right corner of the display in reverse video characters. If the current directory is the root "/" directory, then the client should return "ROOT .<> " in the payload filed as a standard, although any name could be provided. TS-DOS will send the DMEReq sequence multiple times including when it has requested a directory change operation. This provides a way of reporting the new subdirectory name for display in the TS-DOS title bar.

=== Directory Management Extensions Response (DMEResp) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Response ID
| Payload Length
| Payload
| Checksum
|-
| 12
| 0B
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Rsvd
| Dir Name
| Extension
|-
| 00
| 6 bytes, space padded
| ".<>",20h
|}
| Checksum
|}

== Directory reporting from Server ==

The server device (DeskLink, NADSBox, etc.) should use the receipt of a DMEReq as an indication to provide directory and subdirectory information to TS-DOS (or any other client). If the DMEReq sequence is not received, then the server is communicating with a DOS that does not support DME, such as TEENY or FLOPPY, etc. Directory information is reported using the same protocol as regular files using the Directory Reference Request with the exception that the extension is reported as "&lt&gt ". Directory Reference Requests are part of the standard TPDD-1 and TPDD-2 protocol and can refer to a specific directory entry, or the first, next or previous entry in the directory. For filename discovery, the "first", "next" or "previous" search forms are used, and the filename is all 00h.

=== Directory Reference Request (DRReq) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Payload
| Checksum
|-
| 5A 5A
| 00
| 1A
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| File Name
| Attribute
| Search Form
|-
| 24d bytes of 00
| "F"
| 01, 02 or 03
|}
| Checksum
|}

 When DME support has been established, the server reports directory information by responding to the DRReq sequence with a Directory Reference Response (DRResp) packet with the filename field containing the directory name in 6.2 filename format. The directory name should be 6 characters or less with space padding and the 2 character extension must be set to "<>". TS-DOS uses the "<>" extension to identify the entry as a directory. When the server is reporting file / directory entries for a directory other than the root, it should provide a mechanism for navigating to the parent directory. In both DeskLink and NADSBox, this is done by reporting the first entry of a subdirectory as "PARENT.<>". The number of Free Sectors on the media should be a single byte with the value 80H or less. Sectors in the TPDD protocol are 1280 bytes in length. 

=== Directory Reference Response (DRResp) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Response ID
| Payload Length
| Payload
| Checksum
|-
| 11
| 1C
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Dir Name
| Ext.
| Spaces (or 00h)
| Attribute
| Size
| Free
|}
|-
| 6 bytes
| "<>"
| 18 (decimal) bytes
| "F"
| 00
| <nowiki># Sectors</nowiki>
|}

{|
| Checksum
|}

== Change Directory requests from TS-DOS ==

When the user navigates the cursor to a directory entry that has the "<>" extension and pressed Enter, TS-DOS will perform a Directory Change operation to naviagte to that directory. This is accomplished by sending a Change Direcotry Reference Request (CDRReq) followed by a standard Open File Request and then a Close File Request. The CDRReq packet is the same as a standard DRReq packet except the filename extension is set to "<>".

=== Change Directory Reference Request (CDRReq) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Payload
| Checksum
|-
| 5A 5A
| 00
| 1A
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Dir Name
| Ext.
| Spaces (or 00h)
| Attribute
| Search Form
|-
| 6 bytes
| "<>"
| 18 (decimal) bytes
| "F"
| 00
|}
| Checksum
|}

 The server should respond to the CDRReq packet with a DRResp response packet containing the same directory name that was passed in the CDRReq. The server should save the directory name and expect to receive a subsequent Open File Request. When the Open File Request is received, the server should process it as a Change Directory operation to the directory specified in the CDRReq packet and return a standard Normal Response Packet (Id = 12H) with the appropriate error code. If the directory name matches the special name given for the parent directory ("PARENT.<>"), then the server should change to the parent of the current directory. The the server should then expect a Close File Request and respond as usual. 

=== Checksum Algorithm ===

Total = Sum of all bytes from TypeID..Last byte of Payload Checksum = (Total & FFh) XOR FFh

Desklink/TS-DOS Directory Access

2008-12-31T01:03:23Z

208.77.91.41: /* Directory reporting from Client */

<div>

= TS-DOS Directory Management Extensions Programmer's GuideBy Kenneth D. Pettit =

== Overview ==

TS-DOS was developed as an alternative for accessing the TPDD and TPDD-2 drives from the Tandy and NEC line of laptops (Model 100, 102, 200 and PC-8201a). As part of the design, when used with the companion "DeskLink" PC program, TS-DOS adds the ability to create and manage a directory structure on the target media. This same directory access extension is also built into the NADSBox SD card reader and allows navigation and access of the FAT directory structure on the media card. The extensions were discovered by reverse engineering the communication between a Model 102 and Desklink (running on an HP 200LX) and between TS-DOS and a TPDD-1 using an HP 4951B serial protocol analyzer. This document describes the TS-DOS directory management extensions (DME) and is, to my knowledge, a complete description of the protocol.

== Protocol Structure ==

=== History ===

The TPDD-1 supported two modes of operation for accessing data on the floppy disc - an "Operational" mode and an "FDC Emulation" mode. Each of these modes have a very different command structure and are well documented in the TPDD-1 reference manual. The FDC Emulation mode was used for direct sector access of the data stored on the disc. Neither the TPDD-2 nor Desklink support the FDC Emulation mode and instead add sector access commands in Operational mode to provide the same functionality. 

=== Basic premise for extension addition ===

The directory management extensions in TS-DOS are implemented partially using commands to support the FDC Emulation mode, and partially using a targeted file extension ("<>") in operational mode commands to denote references to a directory or subdirectory on the media. The FDC Emulation mode commands are used to identify if the client supports DME and the "<>" extension is used to specify target directories for creation, deletion or navigation.

=== Request Format ===

Both FDC Emulation requests and Operational mode requests are issued by TS-DOS, although only a single FDC Emulation mode request is used. FDC Emulation requests consist of a single ASCII character with one or more ASCII arguments followed by a carriage return (0Dh). Operational mode requests consist of a Preamble of ZZ (5Ah 5Ah), followed by a Request ID byte, a Payload Length byte, 0 or more payload bytes, terminated by a checksum.

<blockquote>Note: All values are shown as hexadecimal. ASCII character strings are enclosed with quotation marks. The quotation marks are not part of the command or response.</blockquote>

=== Response Format ===

In operational mode, the reponse format is identical to the request format, except that no preamble is sent. In FDC Emulation mode, the reponse format varies depending on the command and the TPDD service. Specific details regarding FDC Emulation mode responses will be described as needed.

== TPDD Service discovery ==

Since TS-DOS must operate with with various TPDD servers, and since not all servers follow the same protocol, it must determine if the server is capable of supporting DME. This is done by sending an FDC Emulation mode command to go into operational mode ("M1"), followed by an operational mode command to go into FDC Emulation mode. For this operational mode sequence, TS-DOS actually terminates the command with a carriage return (0Dh) which isn't part of the standard operational mode protocol. The following two commands are sent: 

=== Directory Management Extensions Request (DMEReq) ===

{| cellspacing="10" cellpadding="10"
| "M1"
| 0D
|
{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Checksum
|-
| 5A 5A
| 08
| 00
| F7
|}
| 0D
|}

 For a TPDD service that supports FDC Emulation mode, the standard response for both commands is no response. If the server does not respond to either command, or responds with an error message, then TS-DOS knows the client does not support DME. If the client does support DME, then after the final carriage return (0Dh), it shall reply with a standard operational mode response. The response ID must be 12h and the payload field must be 11 bytes long and contain the name of the current directory, or at least the lowest level name in the tree, as shown below. The name should be 6 characters long and should be terminated with ".<>",20h. Names shorter than 6 characters should be padded with spaces before the ".<>",20h extension. TS-DOS will display the directory name reported in the DMEResp payload in the upper right corner of the display in reverse video characters. If the current directory is the root "/" directory, then the client should return "ROOT .<> " in the payload filed as a standard, although any name could be provided. TS-DOS will send the DMEReq sequence multiple times including when it has requested a directory change operation. This provides a way of reporting the new subdirectory name for display in the TS-DOS title bar.

=== Directory Management Extensions Response (DMEResp) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Response ID
| Payload Length
| Payload
| Checksum
|-
| 12
| 0B
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Rsvd
| Dir Name
| Extension
|-
| 00
| 6 bytes, space padded
| ".<>",20h
|}
| Checksum
|}

== Directory reporting from Server ==

The server device (DeskLink, NADSBox, etc.) should use the receipt of a DMEReq as an indication to provide directory and subdirectory information to TS-DOS (or any other client). If the DMEReq sequence is not received, then the server is communicating with a DOS that does not support DME, such as TEENY or FLOPPY, etc. Directory information is reported using the same protocol as regular files using the Directory Reference Request with the exception that the extension is reported as "&lt&gt ". Directory Reference Requests are part of the standard TPDD-1 and TPDD-2 protocol and can refer to a specific directory entry, or the first, next or previous entry in the directory. For filename discovery, the "first", "next" or "previous" search forms are used, and the filename is all 00h.

=== Directory Reference Request (DRReq) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Payload
| Checksum
|-
| 5A 5A
| 00
| 1A
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| File Name
| Attribute
| Search Form
|-
| 24d bytes of 00
| "F"
| 01, 02 or 03
|}
| Checksum
|}

 When DME support has been established, the server reports directory information by responding to the DRReq sequence with a Directory Reference Response (DRResp) packet with the filename field containing the directory name in 6.2 filename format. The directory name should be 6 characters or less with space padding and the 2 character extension must be set to "<>". TS-DOS uses the "<>" extension to identify the entry as a directory. When the server is reporting file / directory entries for a directory other than the root, it should provide a mechanism for navigating to the parent directory. In both DeskLink and NADSBox, this is done by reporting the first entry of a subdirectory as "PARENT.<>". The number of Free Sectors on the media should be a single byte with the value 80H or less. Sectors in the TPDD protocol are 1280 bytes in length. 

=== Directory Reference Response (DRResp) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Response ID
| Payload Length
| Payload
| Checksum
|-
| 11
| 1C
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Dir Name
| Ext.
| Spaces (or 00h)
| Attribute
| Size
| Free
|}
|-
| 6 bytes
| "<>"
| 18 (decimal) bytes
| "F"
| 00
| <nowiki># Sectors</nowiki>
|}

{|
| Checksum
|}

== Change Directory requests from TS-DOS ==

When the user navigates the cursor to a directory entry that has the "&lt&gt" extension and pressed Enter, TS-DOS will perform a Directory Change operation to naviagte to that directory. This is accomplished by sending a Change Direcotry Reference Request (CDRReq) followed by a standard Open File Request and then a Close File Request. The CDRReq packet is the same as a standard DRReq packet except the filename extension is set to "<>".

=== Change Directory Reference Request (CDRReq) ===

{| style="text-align: left; background-color: rgb(255, 255, 204); height: 113px" border="1" cellspacing="2" cellpadding="2"
| Preamble
| Request ID
| Payload Length
| Payload
| Checksum
|-
| 5A 5A
| 00
| 1A
|
{| style="text-align: left; width: 100%" border="1" frame="box" cellspacing="2" cellpadding="2" frame="box"
| Dir Name
| Ext.
| Spaces (or 00h)
| Attribute
| Search Form
|-
| 6 bytes
| "<>"
| 18 (decimal) bytes
| "F"
| 00
|}
| Checksum
|}

 The client should respond to the CDRReq packet with a DRResp response packet containing the same directory name that was passed in the CDRReq. The client should save the directory name and expect to receive a subsequent Open File Request. When the Open File Request is received, the client should process it as a Change Directory operation to the directory specified in the CDRReq packet and return a standard Normal Response Packet (Id = 12H) with the appropriate error code. If the directory name matches the special name given for the parent directory ("PARENT.<>"), then the client should change to the parent of the current directory. The the client should then expect a Close File Request and respond as usual. 

=== Checksum Algorithm ===

Total = Sum of all bytes from TypeID..Last byte of Payload Checksum = (Total & FFh) XOR FFh