home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / DEMON / WANDERER.LBR / QTERM.PZT / QTERM.PAT
Text File  |  2000-06-30  |  10KB  |  234 lines
  1. Patching QTERM for your system.
  2.  
  3. The first thing to do is to back QTERM up, and then invoke DDT, SID, ZSID,
  4. or whatever your local patch utility is, in the following way:
  5.  
  6. A>DDT QTERM.COM
  7.  
  8. DDT (etc.) will read in QTERM, and then prompt. The following is a list of
  9. patch areas where QTERM should be changed to reflect your system. Some of
  10. these are mandatory (i.e. QTERM won't work without them), whereas others
  11. can be changed to null subroutines or empty data without preventing QTERM
  12. from working, it just won't have all the features available.
  13.  
  14.  
  15. 1. Modem input status: 0110 - 011F
  16.  
  17. QTERM calls here to check RDR: status. Return with the zero flag set if
  18. no character is available, or with the zero flag clear if a char is
  19. available. Generally this can be an input from the usart / sio / dart
  20. status port followed by an 'and'.
  21.  
  22. 2. Read modem character: 0120 - 012F
  23.  
  24. This gets a character from the RDR: port once the input status has decided
  25. it's there. Return the character in the a register. Generally this can be
  26. an input from the usart / sio / dart data port.
  27.  
  28. 3. Modem output status: 0130 - 013F
  29.  
  30. Check if the PUN: port can accept another character. Return with the zero
  31. flag set if the PUN: port can't receive a character, or with the zero flag
  32. clear if the PUN: port is ready. Generally this can be an input from the
  33. usart / sio / dart status port followed by an 'and'.
  34.  
  35. 4. Write modem character: 0140 - 014F
  36.  
  37. Send the character in the a register to the PUN: port. This will only be
  38. called after the output status routine has returned a non-zero status.
  39. Generally this can be an output to the usart / sio / dart data port.
  40.  
  41. These first four patches are all necessary for QTERM to work. The next few
  42. are not necessary, but they will be useful.
  43.  
  44. 5. Start break: 0150 - 015F
  45.    End break: 0160 - 016F
  46.  
  47. The start break subroutine at 0150 should initiate a break condition on
  48. the modem output line, and 0160 should clear the break condition. If these
  49. are to be omitted, then just put return (C9) instructions at 0150 and 0160.
  50.  
  51. 6. Drop DTR: 0170 - 017F
  52.    Restore DTR: 0180 - 018F
  53.  
  54. The drop DTR subroutine causes DTR to be made inactive, and restore DTR
  55. returns DTR to an active state. If your modem does not respond to DTR, but
  56. can be made to hang up by sending a string, then put a return (C9) at 0170.
  57. Use the space from 0171 to 018F to contain the string, with the following
  58. notes: to transmit a break, use an 0FFH byte, to cause a two second delay
  59. use an 0FEH byte, and use a 00 byte to terminate. Hence the following
  60. could be used to hang up a Hayes compatible:
  61.  
  62. FE 2B 2B 2B FE 41 54 48 30 0D 00
  63.  
  64. FE - delay
  65. 2B - '+' sent three times
  66. FE - delay
  67. 41 54 48 30 0D - ATH0 <return>
  68.  
  69. If neither DTR nor a string is to be used, then place a return (C9) at
  70. 0180 and 0171, and a nop (00) at 0170. The string is used only if a C9
  71. is found at 0170, so by placing the C9 at 0171 the string print is
  72. inhibited.
  73.  
  74. 7. Baud rate setting: 0190 - 019F
  75.    Baud rate table: 01A0 - 01AF
  76.  
  77. These two patch areas work together to allow QTERM to change the baud rate
  78. of the modem port. The baud rate table holds pairs of bytes for setting the
  79. baud rate to eight different values: 38400, 19200, 9600, 4800, 2400, 1200,
  80. 600 and 300, in that order. In these pairs, the first byte will be passed
  81. to the subroutine at 0190, and the second byte is used to enable that baud
  82. rate: an 0FFH in the second byte enables the rate, and a zero disables.
  83. So if your system only went up to 9600, (using a value of 1 to get 9600)
  84. the first six bytes in the table would be:
  85.  
  86.     00 00        no value for 38400: disable by the 00
  87.     00 00        no value for 19200: disable by the 00
  88.     01 FF        01 is the value for 9600: enable by the FF
  89.  
  90. In all cases of enabled baud rates, the subroutine at 0190 gets the
  91. appropriate value in the a register and should use it to set the baud rate.
  92. If this is to be omitted, then just put a return (C9) instruction at 0190,
  93. and fill the table from 01A0 to 01AF with 00's.
  94.  
  95. 8. Communication mode setting: 01B0 - 01BF
  96.    Communication mode table: 01C0 - 01CB
  97.  
  98. These two patch areas work together to allow QTERM to change the
  99. communications format of the modem port. The mode table holds bytes for
  100. setting 12 different formats, selecting number of data bits (7 or 8)
  101. parity (odd, even, or none) and number of stop bits (1 or 2). In order
  102. the 12 values are for 7n1, 8n1, 7n2, 8n2, 7e1, 8e1, 7e2, 8e2, 7o1, 8o1,
  103. 7o2, and 8o2. The subroutine at 01B0 gets one of these values in the a
  104. register and should use it to set the communications mode. If this is to
  105. be omitted, then just put a return (C9) instruction at 01B0.
  106.  
  107. 9. Protocol transfer size: 01CD
  108.  
  109. During protocol transfers, disk reads and writes take place every 8K. This
  110. is normally possible without causing a timeout, and reduces disk access to
  111. a minimum. However if your disk is slow, you can drop this to 4 or even 2
  112. to reduce the size of transfer, and hence prevent timeouts. Note that there
  113. is an unused byte between the end of the communications mode table, and the
  114. transfer size (i.e. at 01CC). This bytes is reserved for future use, and
  115. should not be changed.
  116.  
  117. 10. Processor speed: 01CE
  118.  
  119. This is the speed in Mhz that your Z80 runs at: 4, 6 or whatever. For
  120. a 2.5Mhz cpu, use 3.
  121.  
  122. 11. Escape character: 01CF
  123.  
  124. All special functions of QTERM are activated by the use of escape sequences.
  125. At 01CF is the byte used for the escape character (the default is ^\). Any
  126. byte can be used, but a little used value is best selected, also using a
  127. printable character (' ' thru '~') may have undesirable results. Note that to
  128. transmit the escape value itself, just type it twice.
  129.  
  130. These previous three are necessary.
  131.  
  132. 12. Signon message: 01D0 - 01EF
  133.  
  134. This must be a string that identifies your system / terminal. It must be
  135. present, and is printed when QTERM first starts. It should be composed of
  136. printable characters, and terminated by a zero byte.
  137.  
  138. 13. Clear screen: 01F0 - 01FF
  139.  
  140. This must be a string that clears the terminal screen, and leaves the
  141. cursor in the top left hand corner. This should also be terminated by a
  142. zero byte.
  143.  
  144. 14. Moveto: 0200 - 022E
  145.  
  146. QTERM requires the ability to move the cursor around the screen. It calls
  147. this subroutine with the required coordinates in hl: where h is the row,
  148. and l the column to move to. The top left hand corner of the screen is 0,0;
  149. and the bottom right corner is 23,79. This subroutine will have to do
  150. terminal output: at 0109H is a routine that prints a character in the c
  151. register, and at 010CH is a routine to print a decimal number in hl (mainly
  152. for the use of vt100 and vt220 compatibles). Note that the above two
  153. subroutines will destroy all registers, and that this subroutine can also
  154. destroy all registers.
  155.  
  156. 15. Teminal capability bit map: 022F
  157.  
  158. This byte contains one bit set for each of the following terminal
  159. capabilities:
  160.  
  161. bit 0: (01H)    bright (end highlight)
  162. bit 1: (02H)    dim (start highlight)
  163. bit 2: (04H)    delete line
  164. bit 3: (08H)    insert line
  165. bit 4: (10H)    delete character
  166. bit 5: (20H)    insert character
  167. bit 6: (40H)    clear to end of line
  168. bit 7: (80H)    clear to end of screen
  169.  
  170. 16. Terminal capability strings: 0230 - 026F
  171.  
  172. In this area are eight strings, each of which can be at most eight characters
  173. long. They are the strings to be printed to perform the terminal capabilities
  174. mentioned above. Each one of them should be terminated by a zero byte. Hence
  175. at 0230 is the string for dim (start highlight), at 0238 is the string for
  176. bright (end highlight), etc.; with 0268 being the string for clear to end of
  177. screen. Programs that use these will check the terminal capability bitmap at
  178. 022F before using them, to determine if they are available.
  179.  
  180. 17. Entry subroutine: 0270 - 0272
  181.  
  182. Upon entry to QTERM, this subroutine will be called. If it is not needed
  183. then a return instruction (0C9H) should be placed at 0270, otherwise there
  184. is enough space to put in a jump to code that is to be executed when QTERM
  185. starts.
  186.  
  187. 18. Exit subroutine: 0273 - 0275
  188.  
  189. After an <Escape> Q has been issued to exit QTERM, this subroutine will
  190. be called immediately before exiting back to CP/M. As with the entry
  191. subroutine, if not needed, a return instruction (0C9H) should be placed at
  192. 0273H, otherwise any termination code can be added.
  193.  
  194. 19. Patch area: 0276 - 02FF
  195.  
  196. Since the area provided for the above patches is limited, it may be necessary
  197. to use more space. The block of memory from 0276 to 02FF is set aside for
  198. custom patches, this can be used if the individual spaces are not big enough.
  199.  
  200.  
  201. Once all the patches have been made, exit the patch program (usually by
  202. typing ^C), and finish up by saving a new copy of QTERM:
  203.  
  204. A>SAVE 51 QTERMNEW.COM
  205.  
  206. In addition, the patch area only can be saved as follows:
  207.  
  208. A>SAVE 2 QTERMPAT.XXX
  209.  
  210. Which will create a 1/2K file containing all the patches needed to make this
  211. particular version of QTERM work. By doing this, when a new release of QTERM
  212. needs to be patched, all that is necessary is to read in the new unpatched
  213. version with DDT or whatever, then overlay the patch area. This is typically
  214. done by typing:
  215.  
  216. IQTERMPAT.XXX
  217.  
  218. to DDT, SID, ZSID etc. to set up the command line to read QTERMPAT.XXX, then
  219. follow this with a:
  220.  
  221. R
  222.  
  223. to read it. This should overlay the saved patch area on the new version,
  224. hence doing all the patches at once. Then exit DDT with ^C, and do the
  225. first save shown above to save the new working version.
  226.  
  227.  
  228. NOTE: this "overlaying" of patches will NOT work with versions 2.8 and
  229. earlier. In addition, three things have been added to the 3.3 patch
  230. area.
  231. 1. changing the DTR manipulation area to include a hangup string
  232. 2. adding the transfer read / write size at 01CD
  233. 3. adding the entry and exit subroutine hooks
  234.