diff level1/modules/boot_sdc.asm @ 3130:e0614e08fa5e

l1 boot modules: Expand documentation and clean up code Tidy up white-space and indentation. Expand documentation to show C flag is important on return from HWRead. Expand documentation to show how/why/when filler is needed at end of file. Delete dead code in some places. No functional changes.
author Neal Crook <foofoobedoo@gmail.com>
date Sun, 04 Dec 2016 21:01:42 +0000
parents 47cd23dcf55e
children
line wrap: on
line diff
--- a/level1/modules/boot_sdc.asm	Wed Nov 30 22:10:56 2016 +0000
+++ b/level1/modules/boot_sdc.asm	Sun Dec 04 21:01:42 2016 +0000
@@ -1,5 +1,7 @@
 ********************************************************************
 * Boot - CoCo SDC Boot module
+* Provides HWInit, HWTerm, HWRead which are called by code in
+* "use"d boot_common.asm
 *
 * $Id$
 *
@@ -112,7 +114,7 @@
 *
 *    Exit:
 *       X  = ptr to data (i.e. ptr in blockloc,u)
-*       Carry set => ERROR
+*       Carry Clear = OK, Set = Error
 *
 * multicomp09:
 * for now, the image starts at SDcard block $02.8000
@@ -230,7 +232,15 @@
 *--------------------------------------------------------------------------
 
      IFGT Level-1
-* Filler to get $1D0
+* L2 kernel file is composed of rel, boot, krn. The size of each of these
+* is controlled with filler, so that (after relocation):
+* rel  starts at $ED00 and is $130 bytes in size
+* boot starts at $EE30 and is $1D0 bytes in size
+* krn  starts at $F000 and ends at $FEFF (there is no 'emod' at the end
+*      of krn and so there are no module-end boilerplate bytes)
+*
+* Filler to get to a total size of $1D0. 3, 2, 1 represent bytes after
+* the filler: the end boilerplate for the module, fdb and fcb respectively.
 Filler         fill      $39,$1D0-3-2-1-*
      ENDC