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 / CPM / BDOS / NOVADOSI.LBR / NDOSHDR.LZB / NDOSHDR.LIB
Text File  |  2000-06-30  |  17KB  |  385 lines
  1. ;
  2. ; NOVADOS Disk Operating System Header
  3. ; 
  4. ; The current version/release designation of NovaDOS is:
  5. ; 
  6. version     macro
  7.         defb    'I    '        ; Current version/release
  8. ;            |.....|        ; MUST be 5 bytes long
  9.         endm
  10.  
  11. ; 
  12. ; ASSEMBLY INSTRUCTIONS:
  13. ; ======================
  14. ; 
  15. ; This code is written to assemble with either the SLR assembler  Z80ASM  or 
  16. ; with  Microsoft's  M80.   The  former  assembler is highly recommended for 
  17. ; speed and versatility.
  18. ;    
  19. ; All user equates are  contained  in  this  file  which  is  'included'  in 
  20. ; NOVADOS.Z80.   If  assembling  a  relocatable  file  for  NZCOM,  the file 
  21. ; Z34CMN.LIB must be available in  the  current  directory.   If  assembling 
  22. ; absolute  code, the code addresses may be set either in the header file or 
  23. ; taken from the file Z3BASE.LIB.  
  24.  
  25.  
  26.  
  27. ; ASSEMBLY OPTIONS AND ADDRESSES:
  28. ; ===============================
  29. ;
  30. ; If you set z33adr or intadr true, you will want to instruct your assembler 
  31. ; to produce a binary (COM) or HEX file with its absolute  origin  at  100h.  
  32. ; The  code will be .phased to operate at the appropriate address and can be 
  33. ; loaded into PUTSYS, written directly to system tracks or  handled  in  any 
  34. ; manner  consistent with this format.  If cmnadr is set true, then you must 
  35. ; instruct your assembler to produce a REL file.  This file  can  be  loaded 
  36. ; directly  into  memory  using  Alpha Systems' NZCOM or JetLDR.  If you are 
  37. ; using the latter option, the filename extension should be changed to ZRL.
  38.  
  39. ; Set one of the following four equates true:
  40. ; 
  41. intadr        defl    false    ; True if setting BIOS base address here
  42. z33adr        defl    false    ; True if using Z3BASE.LIB for system address
  43. cmnadr        defl    true    ; True if assembling zrl file for NZCOM
  44. reladr        defl    false    ; True if generating REL file for SPR/PRL
  45. ;
  46. ; If intadr is true, then the next three equates must be correctly set.
  47. ;
  48. idosloc        equ    8000h        ; Run time start of bdos
  49. ip2bios        equ    0de00h        ; Run time start of BIOS
  50. ramlow        equ    00000h        ; Start address of memory
  51. ;
  52. ; 
  53. ; If either intadr or z33adr are true, you may assemble to  a  HEX  file  to 
  54. ; load  into  PUTSYS with MLOAD, ZSID or DDT.  Set hexgen true to enable the 
  55. ; creation of a HEX file with it's origin at PUTSDOS.
  56. ; 
  57. hexgen        equ    false        ; True to include PUTSYS DOS origin
  58. ;
  59. putsdos        equ    1180h        ; Location of DOS image in PUTSYS.
  60.                     ; This is fairly universal
  61.  
  62.  
  63. ; FEATURE OPTIONS
  64. ; ===============
  65. ; 
  66. ; Not  all of the options below can be implemented at one time.  The size of 
  67. ; the CP/M DOS is limited by many conventions to  3.5K,  although  this  may 
  68. ; change  in  the  near  future  as  Z  system  implementations  become more 
  69. ; flexible. Image size statistics are printed  on  the  screen  following  a 
  70. ; successful assembly and you may adjust the options below accordingly.
  71.  
  72.  
  73.  
  74. ; Reset Disk System Call
  75. ; ----------------------
  76. ;  
  77. ; Some systems, like the Kaypro 10, only recognize  changes  between  single 
  78. ; and  double  sided  disks when the system is warm booted; BDOS function 13 
  79. ; (reset disk) will not work.  There are two  solutions  to  this  situation 
  80. ; which  we shall call "The AXE" and "The SCALPEL".  Both are effective, but 
  81. ; the latter is preferable for it's intelligence.   Note  that  if  you  are 
  82. ; using  Advent  Products'  TurboROM  you do not need to use EITHER of these 
  83. ; methods.  Disk format determination is done automatically with  each  disk 
  84. ; reset if the  disk has been changed.  If you  are using the  TurboROM, set 
  85. ; resdsk FALSE.
  86. ;
  87. ; 
  88. ; *** The AXE:
  89. ; 
  90. ; By  adding  a  "hook"  to  the BIOS of machines supporting multiple floppy 
  91. ; formats and setting resdsk true and resflag false BDOS  function  13  will 
  92. ; allow  changes between single and double sided disks.  Very handy for disk 
  93. ; housekeeping utilities such as nswp, nulu, and cataloging programs.  
  94. ;  
  95. ; The "hook" is added as follows: obtain the source to your computer's BIOS.  
  96. ; examine  the  code  for warm boot.  Somewhere, there should be a call to a 
  97. ; routine which initializes the disk system after  a  warm  boot,  or  which 
  98. ; detects  changes between single and double sided disks.  Call this routine 
  99. ; diskint for purposes of discussion.  Modify your BIOS's cold boot  routine 
  100. ; to  initialize 3 bytes at address setdsk as "jp diskint".  The location of 
  101. ; setdsk is arbitrary, it may be in your BIOS, or  in  a  reserved  spot  in 
  102. ; CP/M's page 0.
  103. ; 
  104. ; *** The SCALPEL:
  105. ; 
  106. ; On some systems which support more than one disk  format,  a  single  byte 
  107. ; controls  the  resetting  of the floppy format.  This byte, which we shall 
  108. ; call the resflag, when initialized by diskint (see "The  AXE")  tells  the 
  109. ; floppy  drive  support  routines  to  invoke a subroutine to determine the 
  110. ; floppy disk format.  If you know the location and  appropriate  value  for 
  111. ; the  resflag  you  may reset it directly from within NovaDOS.  This method 
  112. ; has the advantage that it does  not  generally  result  in  unlogging  the 
  113. ; permanent  media  and  so  can  be  used in the NovaDOS disk login routine 
  114. ; rather than in the disk reset (Function 13) routines, allowing the  floppy 
  115. ; format to be tested and reset more easily without the necessity of logging 
  116. ; in all the drives anew each time resdsk is called.
  117. ; 
  118. ; Finding  the  resflag generally requires that you have the source code for 
  119. ; your ROM or do some sleuthing in the ROM scratch  area.   A  good  way  of 
  120. ; locating  the resflag is to use a debugger to save the ROM scratch area to 
  121. ; a file.  Save one file with the floppy at SSDD, one  with  the  floppy  at 
  122. ; DSDD  and one after a warmboot with the floppy logged out.  Use DI or COMP 
  123. ; or any good binary file  comparitor  to  locate  the  bytes  which  differ 
  124. ; between  these  files.   A  little  experimentation should lead you to the 
  125. ; address which you can POKE with a value which will cause the floppy format 
  126. ; to be reevaluated. Look in particular for bytes which change value between 
  127. ; 0ffh and some low value such as 00, 01 or 02.  If you have a  system  with 
  128. ; more  than  one  multiple format floppy you may have to modify the NovaDOS 
  129. ; code to correctly handle your situation.  The code, which is  executed  in 
  130. ; NVDS-2.Z80, is included below as a macro for your convenience.
  131. ; 
  132. ; Set resdsk true if using either the AXE or the  SCALPEL.   If  your system 
  133. ; doesn't  support multiple floppy formats you may set resdsk false and save 
  134. ; some code.
  135. ; 
  136. ;
  137. resdsk        equ    false        ; Reset disk enabled.  Set this 
  138.                     ; true if using either the AXE or 
  139.                     ; the SCALPEL
  140. ;    
  141. resflag        equ    true        ; True if using the SCALPEL
  142.                     ; False if using the AXE 
  143.  
  144. ; If  resflag  is  TRUE  (i.e.,  using  the SCALPEL) set resflag_loc the the 
  145. ; address of the byte which tells the BIOS whether or not  the  floppy  disk 
  146. ; format has been determined.  Set resflag_val to the value which will cause 
  147. ; the BIOS to reevaluate the floppy disk format.
  148. ; 
  149. resflag_loc    equ    0fd31h        ; Address of format flag
  150. ; 
  151. resflag_val    equ    0ffh        ; Value of flag to reset format
  152.  
  153. ; If  resflag  is  FALSE  (i.e., using the AXE) set setdsk to address of the 
  154. ; routine (or address of a jump to the routine)  in  your  BIOS  which  will 
  155. ; initialize your disk hardware
  156. ; 
  157. setdsk        equ    0050h        
  158.  
  159. ; This is the code which executes if resflag is true.  Modify this code with 
  160. ; care or not at all.  All registers are available for use if necessary.  If 
  161. ; it works, DON'T fix it.
  162. ; 
  163. rflgmac        macro
  164.         ld    hl,resflag_loc        ; Reset DSDD/SSDD flag in BIOS
  165.         ld    (hl),resflag_val
  166.         endm
  167.  
  168.  
  169.  
  170. ; DOS path
  171. ; --------
  172. ; 
  173. ; NovaDOS  implements  a  file search path similar to the ZCPR3 search path.  
  174. ; NovaDOS will locate all system and public files  along  the  path  and  is 
  175. ; useful for locating overlays and other support files for non-ZCPR programs 
  176. ; in either a ZCPR or CP/M environment.  The initial address of the path  is 
  177. ; contained  in  a buffer near the start of NovaDOS and if pathcall is true, 
  178. ; Function 42 is available to get and set the path address.  If DE is  0  on 
  179. ; call  to  Function 42 then the path address is returned in HL.  Otherwise, 
  180. ; the path address is set to the value of DE.
  181. ; 
  182. ispath        equ    true        ; TRUE to incorporate path support
  183.                     ; code in NovaDOS.  If you don't 
  184.                     ; want path support you may save
  185.                     ; c.a. 110 bytes of code by setting
  186.                     ; ispath FALSE.
  187. ;
  188. pathoff        equ    0000h        ; Location of path in memory
  189.                     ; Set this to 0 to disable the
  190.                     ; DOS path at run time.
  191. ;
  192. pathcall    equ    true        ; True to  include Function 42
  193.                     ; to manipulate the path address
  194.  
  195.  
  196. ; Time and Date support
  197. ; ---------------------
  198. ; 
  199. ; NovaDOS  contains  support for Time/Date stamping of files.  If you have a 
  200. ; clock/calendar and you wish to implement time and date  stamping  you  may 
  201. ; set  this  equate  true to include the DOS routines in the assembly.  Time 
  202. ; and date information is additionally available via Function calls 200  and 
  203. ; 201,   as  discussed  in  NOVADOS.DOC.   The  format  for  time  and  date 
  204. ; information is also explained therein.
  205. ; 
  206. dotime        equ    false        ; True if time-stamping is supported 
  207. ; 
  208. timeoff        equ    0000        ; Offset of time routine in BIOS
  209.  
  210.  
  211. ; Rewrite Console Buffer Line
  212. ; ---------------------------
  213. ; 
  214. ; CP/M  BDOS  will  rewrite  the  console  buffer on the screen if ctrl-R is 
  215. ; entered during buffer input.  This is a very "old fashioned" facility  and 
  216. ; functions mainly to compensate for the nerdish behavior of the delete key.  
  217. ; The improved delete key routine in  NovaDOS  allows  this  feature  to  be 
  218. ; eliminated  will  little  loss  in versatility.  Significant code space is 
  219. ; saved.  It is recommended that this equate be left false.
  220. ; 
  221. contron        equ    false        ; False to eliminate Ctrl-R
  222.  
  223.  
  224. ; Reset unlogged disks
  225. ; --------------------
  226. ; 
  227. ; A ZRDOS Function 13 call will not reset the Read Only vector.   Similarly, 
  228. ; a  call to ZRDOS Function 37 will reset the Read Only status of only those 
  229. ; drives specified in the bit map passed in de.  A  CP/M  function  37  call 
  230. ; will unprotect ALL drives not currently logged in.  Setting this equate to 
  231. ; false will make Function 37 emulate ZRDOS for programs which require it.
  232. ; 
  233. runlog        equ    false        ; False to NOT reset the read only
  234.                     ; vector with Funcs. 13 and 37
  235.  
  236.  
  237. ; ZRDOS High Functions
  238. ; --------------------
  239. ; 
  240. ; ZRDOS provides five additional DOS  functions  which  are  employed  by  a 
  241. ; variety of Z system software.  These functions are:
  242. ; 
  243. ;       Function 39:    Return Permanent Media Bit Map
  244. ;     Function 47:    Return Current DMA Address
  245. ;     Function 48:    Return ZRDOS Version Number
  246. ;     Function 50:    Set Warm Boot Trap
  247. ;     Function 51:    Reset Warm Boot Trap
  248. ; 
  249. ; These  functions  are  included  in NovaDOS if the following equate is set 
  250. ; true. 
  251. ; 
  252. hifuncs        equ    true        ; True to include ZRDOS high 
  253.                     ; Functions 
  254. ; ZRDOS Version Number
  255. ; --------------------
  256. ;
  257. ; If hifuncs is true, NovaDOS will return a pseudo ZRDOS version number from 
  258. ; a Function 48 call.  ZRDOS compatible programs make this call to determine 
  259. ; whether or not ZRDOS is running.  ZRDOS versions emulated by NovaDOS range 
  260. ; up  to  1.9.  The  equate below probably will not have to be changed until 
  261. ; and unless ZRDOS is upgraded and software is written which requires higher 
  262. ; version numbers.
  263. ; 
  264. zrvers        equ    0019h        ; ZRDOS version number returned by
  265.                     ; Function 48
  266.  
  267.  
  268. ; Error Escaping
  269. ; --------------
  270. ;
  271. ; You  may choose to ignore NovaDOS error messages relating to R/O files and 
  272. ; disk write errors by hitting a key of your choice.  If a file R/O  message 
  273. ; is  ignored,  the  file  will  be treated as R/W.  If a disk read error is 
  274. ; ignored, another attempt will be made to read the disk.  The  key  defined 
  275. ; below  will be your error ignore key.  If you set this key to 0, the error 
  276. ; ignore feature will be omitted from the assembly with a small  savings  in 
  277. ; code.
  278. ; 
  279. erresc        equ    1bh        ; The escape key is a good one here.
  280.                     ; Some people prefer a CR (13h)
  281.  
  282.  
  283. ; High Bits Character Support
  284. ; ---------------------------
  285. ; 
  286. ; NovaDOS  can  allow  high  bits  characters to be entered into the console 
  287. ; buffer if they are available  through  the  user's  conin  routine.   This 
  288. ; feature  is  useful  for a variety of software which is keyboard intensive 
  289. ; and which allows user configurable control sequences.   If  your  keyboard 
  290. ; and  BIOS do not make high bit characters available, set this equate false 
  291. ; to save several bytes of code.  If implemented, the acceptance of high bit 
  292. ; characters is under the control of bit 2 of the flags byte.
  293. ; 
  294. ; High  bits,  if  present  in  the  data stream, are normally output to the 
  295. ; console during calls to functions 2, 6, 9 and 10.  If hibiton is true then 
  296. ; this feature will be under the control of flags bit 3.  If the bit is off, 
  297. ; high bit output will be suppressed and vice versa.
  298. ; 
  299. hibiton        equ    true        ; True to allow control of high
  300.                     ; bit character I/O with flags
  301.                     ; byte
  302.  
  303. ; Initial Flags Settings
  304. ; ----------------------
  305. ; 
  306. ; The  flags  byte  controls several functions as detailed below.  It may be 
  307. ; altered using function 41.  P2DOS originally  made  all  public  attribute 
  308. ; files R/O, however this can cause problems with utilities which attempt to 
  309. ; copy them.  Since public files do  not  ordinarily  need  protection  from 
  310. ; erasure,  the  small  savings  in  safety gained by making them R/O is not 
  311. ; worth the possible problems with copy programs and it is advised that this 
  312. ; bit be left unset.  Bit 5, if set, forces a  search of drive A for a file-
  313. ; name  starting  with "$$".  This  takes time, and  warm boots on hard disk 
  314. ; or  other permanent media  systems can be speeded up  considerably if  bit
  315. ; 5 is reset.  If you never  use the submit  facility (or the dBase II "quit
  316. ; to" operation)  you may leave  this bit reset  and enjoy  much faster disk
  317. ; system resets.   
  318. ; 
  319. flagbyte    equ    00100011b    ; Initial flag byte setting
  320. ;            ||||||||
  321. ;            ||||||| \public files enabled if set
  322. ;            |||||| \256 character delay if set (see doc file)
  323. ;            ||||| \accept high bits in function 10 if set
  324. ;            |||| \output high bits to screen if set
  325. ;            ||| \make public attribute files R/O if set
  326. ;            || \perform full disk resets on ALL media if set
  327. ;            | \unused
  328. ;             \unavailable
  329.  
  330.  
  331.  
  332. ; External DOS stack
  333. ; ------------------
  334. ; 
  335. ; If the options which you have enabled in this header  file  create  a  DOS 
  336. ; which  is larger than 3.5K the "BDOS TOO BIG" message will be displayed on 
  337. ; assembly.  If you have 36 bytes of memory available  elsewhere  in  memory 
  338. ; you  may  assign this block to the DOS stack by setting the exstack equate 
  339. ; to the address of the TOP of this  block.   This  will  leave  more  space 
  340. ; within  NovaDOS  for  code.   Setting exstack to 0 makes the NovaDOS stack 
  341. ; internal.
  342. ; 
  343. exstack        equ    0000h        ; Address of TOP of external DOS 
  344.                     ; stack, or 0 for internal stack
  345.  
  346.  
  347.  
  348. ; If you are doing work on NovaDOS and need to do rapid  sequential  assemb- 
  349. ; lies  of  the  source,  you may find it helpful to make use of the .accept 
  350. ; feature of Z80SASM.  Set the following equate TRUE to use .accept.
  351. ;
  352. debug_flag    equ    false    ; To accept information from the console
  353.  
  354.  
  355. ; Code Relocation Function
  356. ; ------------------------
  357. ;
  358. ; NovaDOS contains an optional experimental code relocation function (38) 
  359. ; which will relocate executable code, adjusting address according to an 
  360. ; SPR style bitmap.  See the manual for details of using this function.  The
  361. ; code cost for this function is substantial but it can be implemented if 
  362. ; the DOS stack is made external and pathcall and hibiton are false.  
  363. ; 
  364. relfunc        equ    false    ; True to include code relocation function
  365.  
  366.  
  367. ; END OF USER DEFINED EQUATES  ..............................
  368. ; -----------------------------------------------------------
  369.  
  370.  
  371. ; The following should not change unless you are debugging a new NovaDOS
  372. ;
  373.         if     debug_flag
  374.  
  375.         .accept    'Creating low-load version? ', bugval
  376.         if    bugval
  377. intadr        defl    true
  378. cmnadr        defl    false
  379. reladr        defl    false
  380.         endif
  381.         endif
  382.  
  383. ;
  384. ; End of file
  385. ; -----------