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