doc/memdisk.txt

   1 [This documentation is rather crufty at the moment.]
   2
   3 MEMDISK is meant to allow booting legacy operating systems via PXE,
   4 and as a workaround for BIOSes where ISOLINUX image support doesn't
   5 work.
   6
   7 MEMDISK simulates a disk by claiming a chunk of high memory for the
   8 disk and a (very small - 2K typical) chunk of low (DOS) memory for the
   9 driver itself, then hooking the INT 13h (disk driver) and INT 15h
  10 (memory query) BIOS interrupts.
  11
  12 To use it, type on the Syslinux command line:
  13
  14 memdisk initrd=diskimg.img
  15
  16 ... where diskimg.img is the disk image you want to boot from.
  17
  18 [Obviously, the memdisk binary as well as your disk image file need to
  19 be present in the boot image directory.]
  20
  21 ... or add to your syslinux.cfg/pxelinux.cfg/isolinux.cfg something like:
  22
  23 label dos
  24     kernel memdisk
  25     append initrd=dosboot.img
  26
  27 Note the following:
  28
  29 a) The disk image can be uncompressed or compressed with gzip or zip.
  30
  31 b) If the disk image is less than 4,194,304 bytes (4096K, 4 MB) it is
  32    assumed to be a floppy image and MEMDISK will try to guess its
  33    geometry based on the size of the file.  MEMDISK recognizes all the
  34    standard floppy sizes as well as common extended formats:
  35
  36      163,840 bytes  (160K) c=40 h=1 s=8         5.25" SSSD
  37      184,320 bytes  (180K) c=40 h=1 s=9         5.25" SSSD
  38      327,680 bytes  (320K) c=40 h=2 s=8         5.25" DSDD
  39      368,640 bytes  (360K) c=40 h=2 s=9         5.25" DSDD
  40      655,360 bytes  (640K) c=80 h=2 s=8         3.5"  DSDD
  41      737,280 bytes  (720K) c=80 h=2 s=9         3.5"  DSDD
  42    1,222,800 bytes (1200K) c=80 h=2 s=15        5.25" DSHD
  43    1,474,560 bytes (1440K) c=80 h=2 s=18        3.5"  DSHD
  44    1,638,400 bytes (1600K) c=80 h=2 s=20        3.5"  DSHD (extended)
  45    1,720,320 bytes (1680K) c=80 h=2 s=21        3.5"  DSHD (extended)
  46    1,763,328 bytes (1722K) c=82 h=2 s=21        3.5"  DSHD (extended)
  47    1,784,832 bytes (1743K) c=83 h=2 s=21        3.5"  DSHD (extended)
  48    1,802,240 bytes (1760K) c=80 h=2 s=22        3.5"  DSHD (extended)
  49    1,884,160 bytes (1840K) c=80 h=2 s=23        3.5"  DSHD (extended)
  50    1,966,080 bytes (1920K) c=80 h=2 s=24        3.5"  DSHD (extended)
  51    2,949,120 bytes (2880K) c=80 h=2 s=36        3.5"  DSED
  52    3,194,880 bytes (3120K) c=80 h=2 s=39        3.5"  DSED (extended)
  53    3,276,800 bytes (3200K) c=80 h=2 s=40        3.5"  DSED (extended)
  54    3,604,480 bytes (3520K) c=80 h=2 s=44        3.5"  DSED (extended)
  55    3,932,160 bytes (3840K) c=80 h=2 s=48        3.5"  DSED (extended)
  56
  57    A small perl script is included in the MEMDISK directory which can
  58    determine the geometry that MEMDISK would select for other sizes;
  59    in general MEMDISK will correctly detect most physical extended
  60    formats used, with 80 cylinders or slightly more.
  61
  62    If the image is 4 MB or larger, it is assumed to be a hard disk
  63    image, and should typically have an MBR and a partition table.  It
  64    may optionally have a DOSEMU geometry header; in which case the
  65    header is used to determine the C/H/S geometry of the disk.
  66    Otherwise, the geometry is determined by examining the partition
  67    table, so the entire image should be partitioned for proper
  68    operation (it may be divided between multiple partitions, however.)
  69
  70    You can also specify the geometry manually with the following command
  71    line options:
  72
  73    c=#          Specify number of cylinders (max 1024[*])
  74    h=#          Specify number of heads (max 256[*])
  75    s=#          Specify number of sectors (max 63)
  76    floppy[=#]   The image is a floppy image[**]
  77    harddisk[=#] The image is a hard disk image[**]
  78
  79    # represents a decimal number.
  80
  81     [*] MS-DOS only allows max 255 heads, and only allows 255 cylinders
  82         on floppy disks.
  83
  84    [**] Normally MEMDISK emulates the first floppy or hard disk.  This
  85         can be overridden by specifying an index, e.g. floppy=1 will
  86         simulate fd1 (B:). This may not work on all operating systems
  87         or BIOSes.
  88
  89 c) The disk is normally writable (although, of course, there is
  90    nothing backing it up, so it only lasts until reset.)  If you want,
  91    you can mimic a write-protected disk by specifying the command line
  92    option:
  93
  94    ro           Disk is readonly
  95
  96 d) MEMDISK normally uses the BIOS "INT 15h mover" API to access high
  97    memory.  This is well-behaved with extended memory managers which load
  98    later.  Unfortunately it appears that the "DOS boot disk" from
  99    WinME/XP *deliberately* crash the system when this API is invoked.
 100    The following command-line options tells MEMDISK to enter protected
 101    mode directly, whenever possible:
 102
 103    raw          Use raw access to protected mode memory.
 104
 105    bigraw       Use raw access to protected mode memory, and leave the
 106                 CPU in "big real" mode afterwards.
 107
 108    int          Use plain INT 15h access to protected memory.  This assumes
 109                 that anything which hooks INT 15h knows what it is doing.
 110
 111    safeint      Use INT 15h access to protected memory, but invoke
 112                 INT 15h the way it was *before* MEMDISK was loaded.
 113                 This is the default since version 3.73.
 114
 115 e) MEMDISK by default supports EDD/EBIOS on hard disks, but not on
 116    floppy disks.  This can be controlled with the options:
 117
 118    edd          Enable EDD/EBIOS
 119    noedd        Disable EDD/EBIOS
 120
 121 f) The following option can be used to pause to view the messages:
 122
 123    pause        Wait for a keypress right before booting
 124
 125 g) The following option can be used to set the real-mode stack size.
 126    The default is 512 bytes, but if there is a failure it might be
 127    interesting to set it to something larger:
 128
 129    stack=size   Set the stack to "size" bytes
 130
 131
 132 Some interesting things to note:
 133
 134 If you're using MEMDISK to boot DOS from a CD-ROM (using ISOLINUX),
 135 you might find the generic El Torito CD-ROM driver by Gary Tong and
 136 Bart Lagerweij useful:
 137
 138         http://www.nu2.nu/eltorito/
 139
 140
 141 Similarly, if you're booting DOS over the network using PXELINUX, you
 142 can use the "keeppxe" option and use the generic PXE (UNDI) NDIS
 143 network driver, which is part of the PROBOOT.EXE distribution from
 144 Intel:
 145
 146         http://www.intel.com/support/network/adapter/1000/software.htm
 147
 148
 149 Additional technical information:
 150
 151 Starting with version 2.08, MEMDISK now supports an installation check
 152 API.  This works as follows:
 153
 154         EAX = 454D08xxh ("ME") (08h = parameter query)
 155         ECX = 444Dxxxxh ("MD")
 156         EDX = 5349xxnnh ("IS") (nn = drive #)
 157         EBX = 3F4Bxxxxh ("K?")
 158         INT 13h
 159
 160 If drive nn is a MEMDISK, the registers will contain:
 161
 162         EAX = 4D21xxxxh ("!M")
 163         ECX = 4D45xxxxh ("EM")
 164         EDX = 4944xxxxh ("DI")
 165         EBX = 4B53xxxxh ("SK")
 166
 167         ES:DI -> MEMDISK info structures
 168
 169 The low parts of EAX/ECX/EDX/EBX have the normal return values for INT
 170 13h, AH=08h, i.e. information of the disk geometry etc.
 171
 172 See Ralf Brown's interrupt list,
 173 http://www.cs.cmu.edu/afs/cs.cmu.edu/user/ralf/pub/WWW/files.html or
 174 http://www.ctyme.com/rbrown.htm, for a detailed description.
 175
 176 The MEMDISK info structure currently contains:
 177
 178         [ES:DI]         word    Total size of structure (currently 30 bytes)
 179         [ES:DI+2]       byte    MEMDISK minor version
 180         [ES:DI+3]       byte    MEMDISK major version
 181         [ES:DI+4]       dword   Pointer to MEMDISK data in high memory
 182         [ES:DI+8]       dword   Size of MEMDISK data in 512-byte sectors
 183         [ES:DI+12]      16:16   Far pointer to command line
 184         [ES:DI+16]      16:16   Old INT 13h pointer
 185         [ES:DI+20]      16:16   Old INT 15h pointer
 186         [ES:DI+24]      word    Amount of DOS memory before MEMDISK loaded
 187         [ES:DI+26]      byte    Boot loader ID
 188         [ES:DI+27]      byte    Currently unused
 189         [ES:DI+28]      word    If nonzero, offset (vs ES) to installed DPT
 190                                 This pointer+16 contains the original INT 1Eh
 191
 192 Sizes of this structure:
 193
 194 3.71+           30 bytes        Added DPT pointer
 195 3.00-3.70       27 bytes        Added boot loader ID
 196 pre-3.00        26 bytes
 197
 198 In addition, the following fields are available at [ES:0]:
 199
 200         [ES:0]          word    Offset of INT 13h routine (segment == ES)
 201         [ES:2]          word    Offset of INT 15h routine (segment == ES)
 202
 203 The program mdiskchk.c in the sample directory is an example on how
 204 this API can be used.
 205
 206 The following code can be used to "disable" MEMDISK.  Note that it
 207 does not free the handler in DOS memory, and that running this from
 208 DOS will probably crash your machine (DOS doesn't like drives suddenly
 209 disappearing from underneath.)  This is also not necessarily the best
 210 method for this.
 211
 212         mov eax, 454D0800h
 213         mov ecx, 444D0000h
 214         mov edx, 53490000h
 215         mov dl,drive_number
 216         mov ebx, 3F4B0000h
 217         int 13h
 218
 219         shr eax, 16
 220         cmp ax, 4D21h
 221         jne not_memdisk
 222         shr ecx, 16
 223         cmp cx, 4D45h
 224         jne not_memdisk
 225         shr edx, 16
 226         cmp dx, 4944h
 227         jne not_memdisk
 228         shr ebx, 16
 229         cmp bx, 4B53h
 230         jne not_memdisk
 231
 232         cli
 233         mov bx,[es:0]           ; INT 13h handler offset
 234         mov eax,[es:di+16]      ; Old INT 13h handler
 235         mov byte [es:bx], 0EAh  ; FAR JMP
 236         mov [es:bx+1], eax
 237
 238         mov bx,[es:2]           ; INT 15h handler offset
 239         mov eax,[es:di+20]      ; Old INT 15h handler
 240         mov byte [es:bx], 0EAh  ; FAR JMP
 241         mov [es:bx+1], eax
 242         sti