memdisk/memdisk.doc

   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 one of the following sizes, it's assumed to be a
  32    floppy image:
  33
  34      368,640 bytes -  360K floppy
  35      737,280 bytes -  720K floppy
  36    1,222,800 bytes - 1200K floppy
  37    1,474,560 bytes - 1440K floppy
  38    1,720,320 bytes - 1680K floppy (common extended format)
  39    1,763,328 bytes - 1722K floppy (common extended format)
  40    2,949,120 bytes - 2880K floppy
  41    3,932,160 bytes - 3840K floppy (extended format)
  42
  43    For any other size, the image is assumed to be a hard disk image,
  44    and should typically have an MBR and a partition table.  It may
  45    optionally have a DOSEMU geometry header; in which case the header
  46    is used to determine the C/H/S geometry of the disk.  Otherwise,
  47    the geometry is determined by examining the partition table, so the
  48    entire image should be partitioned for proper operation (it may be
  49    divided between multiple partitions, however.)
  50
  51    You can also specify the geometry manually with the following command
  52    line options:
  53
  54    c=#          Specify number of cylinders (max 1024[*])
  55    h=#          Specify number of heads (max 256[*])
  56    s=#          Specify number of sectors (max 63)
  57    floppy[=#]   The image is a floppy image[**]
  58    harddisk[=#] The image is a hard disk image[**]
  59
  60    # represents a decimal number.
  61
  62     [*] MS-DOS only allows max 255 heads, and only allows 255 cylinders
  63         on floppy disks.
  64
  65    [**] Normally MEMDISK emulates the first floppy or hard disk.  This
  66         can be overridden by specifying an index, e.g. floppy=1 will
  67         simulate fd1 (B:). This may not work on all operating systems
  68         or BIOSes.
  69
  70 c) The disk is normally writable (although, of course, there is
  71    nothing backing it up, so it only lasts until reset.)  If you want,
  72    you can mimic a write-protected disk by specifying the command line
  73    option:
  74
  75    ro           Disk is readonly
  76
  77 d) MEMDISK normally uses the BIOS "INT 15h mover" API to access high
  78    memory.  This is well-behaved with extended memory managers which load
  79    later.  Unfortunately it appears that the "DOS boot disk" from
  80    WinME/XP *deliberately* crash the system when this API is invoked.
  81    The following command-line options tells MEMDISK to enter protected
  82    mode directly, whenever possible:
  83
  84    raw          Use raw access to protected mode memory.
  85
  86    bigraw       Use raw access to protected mode memory, and leave the
  87                 CPU in "big real" mode afterwards.
  88
  89    safeint      Use INT 15h access to protected memory, but invoke
  90                 INT 15h the way it was *before* MEMDISK was loaded.
  91
  92
  93 Some interesting things to note:
  94
  95 If you're using MEMDISK to boot DOS from a CD-ROM (using ISOLINUX),
  96 you might find the generic El Torito CD-ROM driver by Gary Tong and
  97 Bart Lagerweij useful:
  98
  99         http://www.nu2.nu/eltorito/
 100
 101
 102 Similarly, if you're booting DOS over the network using PXELINUX, you
 103 can use the "keeppxe" option and use the generic PXE (UNDI) NDIS
 104 network driver, which is part of the PROBOOT.EXE distribution from
 105 Intel:
 106
 107         http://www.intel.com/support/network/adapter/1000/software.htm
 108
 109
 110 Additional technical information:
 111
 112 Starting with version 2.08, MEMDISK now supports an installation check
 113 API.  This works as follows:
 114
 115         EAX = 454D08xxh ("ME") (08h = parameter query)
 116         ECX = 444Dxxxxh ("MD")
 117         EDX = 5349xxnnh ("IS") (nn = drive #)
 118         EBX = 3F4Bxxxxh ("K?")
 119         INT 13h
 120
 121 If drive nn is a MEMDISK, the registers will contain:
 122
 123         EAX = 4D21xxxxh ("!M")
 124         ECX = 4D45xxxxh ("EM")
 125         EDX = 4944xxxxh ("DI")
 126         EBX = 4B53xxxxh ("SK")
 127
 128         ES:DI -> MEMDISK info structures
 129
 130 The low parts of EAX/ECX/EDX/EBX have the normal return values for INT
 131 13h, AH=08h, i.e. information of the disk geometry etc.
 132
 133 See Ralf Brown's interrupt list,
 134 http://www.cs.cmu.edu/afs/cs.cmu.edu/user/ralf/pub/WWW/files.html or
 135 http://www.ctyme.com/rbrown.htm, for a detailed description.
 136
 137 The MEMDISK info structure currently contains:
 138
 139         [ES:DI]         word    Total size of structure (currently 27 bytes)
 140         [ES:DI+2]       byte    MEMDISK minor version
 141         [ES:DI+3]       byte    MEMDISK major version
 142         [ES:DI+4]       dword   Pointer to MEMDISK data in high memory
 143         [ES:DI+8]       dword   Size of MEMDISK data in 512-byte sectors
 144         [ES:DI+12]      16:16   Far pointer to command line
 145         [ES:DI+16]      16:16   Old INT 13h pointer
 146         [ES:DI+20]      16:16   Old INT 15h pointer
 147         [ES:DI+24]      word    Amount of DOS memory before MEMDISK loaded
 148         [ES:DI+26]      byte    Boot loader ID
 149
 150 MEMDISK 3.00 and higher has the size of this structure as 27; earlier
 151 versions had size 26 and did not include the boot loader ID.
 152
 153 In addition, the following fields are available at [ES:0]:
 154
 155         [ES:0]          word    Offset of INT 13h routine (segment == ES)
 156         [ES:2]          word    Offset of INT 15h routine (segment == ES)
 157
 158 The program mdiskchk.c in the sample directory is an example on how
 159 this API can be used.
 160
 161 The following code can be used to "disable" MEMDISK.  Note that it
 162 does not free the handler in DOS memory, and that running this from
 163 DOS will probably crash your machine (DOS doesn't like drives
 164 suddenly disappearing from underneath):
 165
 166         mov eax, 454D0800h
 167         mov ecx, 444D0000h
 168         mov edx, 53490000h
 169         mov dl,drive_number
 170         mov ebx, 3F4B0000h
 171         int 13h
 172
 173         shr eax, 16
 174         cmp ax, 4D21h
 175         jne not_memdisk
 176         shr ecx, 16
 177         cmp cx, 4D45h
 178         jne not_memdisk
 179         shr edx, 16
 180         cmp dx, 4944h
 181         jne not_memdisk
 182         shr ebx, 16
 183         cmp bx, 4B53h
 184         jne not_memdisk
 185
 186         cli
 187         mov bx,[es:0]           ; INT 13h handler offset
 188         mov eax,[es:di+16]      ; Old INT 13h handler
 189         mov byte [es:bx], 0EAh  ; FAR JMP
 190         mov [es:bx+1], eax
 191
 192         mov bx,[es:2]           ; INT 15h handler offset
 193         mov eax,[es:di+20]      ; Old INT 15h handler
 194         mov byte [es:bx], 0EAh  ; FAR JMP
 195         mov [es:bx+1], eax
 196         sti