Skip to content

Commit 071e7e7

Browse files
committed
README.md: Update for 1.1.0 release.
1 parent c1ceeb4 commit 071e7e7

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,47 @@
22

33
Booted from a floppy, it will load an Option ROM image into the end of conventional memory.
44

5-
![PCem IBM XT screenshot](https://b.rvalles.net/unsorted/pcem_ibmxt_optromboot_xtide.png)
5+
![PCem IBM PC screenshot](https://b.rvalles.net/unsorted/pcem_ibmpc_optromboot_xtide.png)
66

77
## Use cases (non-exhaustive)
88
* Test boot ROMs before burning them.
99
* Netboot with etherboot/gpxe/ipxe.
1010
* IDE support (including LBA!) with XTIDE Universal BIOS.
1111

1212
## Highlights
13-
* flat assembler syntax.
13+
* Flat assembler syntax.
1414
* Pure 8086 code.
15-
* Works on newer hardware, such as the 486 I wrote it for.
1615
* Fits in a floppy bootblock.
16+
* Verifies ROM image checksum after loading.
17+
* Works on PC/XT/AT and clones.
18+
* Also works on newer hardware, such as the 486 with AMI BIOS I wrote it for.
1719
* Trivial to use. Concatenate loader and the ROM image, write into floppy.
1820
* Makefile will prepare 5.25" 360K/1.2M and 3.5" 720K/1.44M floppy images.
1921
* MIT License. See LICENSE file.
2022

2123
## Usage
2224
* Ensure fasm (flat assembler) is installed.
2325
* Copy your ROM image as the `optrom.bin` file.
24-
* Optionally test ROM image with qemu: `make emulaterom`.
26+
* Ensure the ROM image is signed (has correct checksum).
27+
* optromloader will loudly refuse to run the ROM image if not signed.
28+
* Test with `make emulaterom`. Qemu's BIOS won't see the ROM if it's not signed.
29+
* Qemu provides a python tool to sign ROMs:
30+
* https://github.com/qemu/qemu/blob/master/scripts/signrom.py
31+
* For XTIDE Universal BIOS ROMs, use its XTIDECFG tool to configure and sign ROM images.
2532
* Run `make`.
2633
* Floppy images will be created (fd*.img).
2734
* Optionally test 1.44M image with qemu: `make emulate`.
2835
* Alternatively, use a binary release. Concatenate:
29-
* optromloader9/15/18 (according to sectors per track in your floppy format).
30-
* 9 for 5.25" 360K and 3.5" 720K.
31-
* 15 for 5.25" 1.2M.
32-
* 18 for 3.5" 1.44M.
36+
* optromloader9/15/18, according to sectors per track in your floppy format:
37+
* `9` for 5.25" 360K and 3.5" 720K.
38+
* `15` for 5.25" 1.2M.
39+
* `18` for 3.5" 1.44M.
3340
* the ROM image.
3441
* pad to floppy size.
3542

3643
## Caveats
37-
* ROM size limited to <= 64KB.
44+
* ROM size cannot be over 64KB (one 8086 segment).
3845
* Hardcoded to use the first floppy drive.
39-
* ROM checksum isn't checked (yet).
40-
* Always ensure a boot ROM is signed before burning.
41-
* Test with `make emulaterom`. Qemu's BIOS won't see the ROM if it's not signed.
42-
* Qemu provides a python tool to sign ROMs:
43-
* https://github.com/qemu/qemu/blob/master/scripts/signrom.py
44-
* For XTIDE Universal BIOS roms, use its XTIDECFG tool to configure and sign ROM images.
4546

4647
## Author
4748
Roc Vallès Domènech

0 commit comments

Comments
 (0)