Skip to content

Commit b41fd88

Browse files
committed
added more detail to manpage
1 parent 198fd6a commit b41fd88

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

patchrom.1.txt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,24 @@ Synopsis
1515
Description
1616
-----------
1717

18-
Patches a ROM file with a jump table and generates the necessary jumpt table
18+
Patches a ROM file with a jump table and generates the necessary jump table
1919
index definitions.
2020

2121
Reads the symbols for _ROM_ from stdin, keeping only those listed in _CONFIG_
2222
and generates a jump table in the order of the symbols in _CONFIG_. Symbol
2323
definition assembler code is sent to stdout. The end of the _PATH_'th page of
2424
_ROM_ is populated with the jump table.
2525

26+
Each entry in the jump table is 3 octets long and consists of the opcode for
27+
the JP instruction and the target address: 0xC3XXXX. The table grows backwards
28+
from the end of the page.
29+
30+
The output sent to stdout consists of lines of assembler code assigning names
31+
to the indicies for the jump table: .equ METHOD 0xIIPP. _II_ represents the
32+
index and _PP_ the page for _METHOD_.
33+
34+
35+
2636
Examples
2737
--------
2838

0 commit comments

Comments
 (0)