Skip to content

Commit ebffcd9

Browse files
authored
glossary link fixes (#2)
1 parent 58ff225 commit ebffcd9

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This is the repo for the Pokémon mini documentation hosted [here](https://www.p
2626
- This needs to be double-checked on the console with better/confirmed use of the scientific method. Not just the tester tool, but ROMs specifically written to test everything
2727
- Some info like "crashes" was turned into ??? here, because we don't know the actual operation (it crashes because of some important reason!)
2828
- Check all terminology, make sure it matches up with EPSON docs.
29-
- Glossary page, move Open-Bus.md there.
29+
- ~~Glossary page, move Open-Bus.md there.~~ Tho the glossary page is on-going
3030
- New layout with sub-directories, see below.
3131

3232
### Proposed layout

hardware/cpu/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ In order to access 24-bit addresses using registers, separate page registers are
6161

6262
### PC register
6363

64-
Since the program cursor is only 16 bits, it uses a special "delayed" register to account for the upper 8 bits of program access space. When PC has its [most significant bit](Glossary.md#significant-bits) set, the register CB takes the place of the upper 8 bits, extending PC out to 23 bits in total. To prevent bank switch problems, CB is "delayed" by the means of register NB. After each branch instruction, the value of NB is copied to register CB implicitly, allowing for full 23 bit jumps without special programming tricks or special functions.
64+
Since the program cursor is only 16 bits, it uses a special "delayed" register to account for the upper 8 bits of program access space. When PC has its [most significant bit](/Glossary.md#significant-bits) set, the register CB takes the place of the upper 8 bits, extending PC out to 23 bits in total. To prevent bank switch problems, CB is "delayed" by the means of register NB. After each branch instruction, the value of NB is copied to register CB implicitly, allowing for full 23 bit jumps without special programming tricks or special functions.
6565

6666
### SP register
6767

@@ -102,7 +102,7 @@ The overflow flag is set when the signed value overflows, that is, loops around.
102102

103103
#### Negative flag
104104

105-
For most operations, this is a copy of the [most significant bit](Glossary.md#significant bits), which represents whether or not a signed value is negative. As expected, 0 is positive and 1 is negative.
105+
For most operations, this is a copy of the [most significant bit](/Glossary.md#significant-bits), which represents whether or not a signed value is negative. As expected, 0 is positive and 1 is negative.
106106

107107
#### Decimal mode
108108

hardware/cpu/Registers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
The Pokémon mini maps $2000 \~ $20FF as hardware control registers. This area is reserved for hardware related functions such as video, audio, general purpose timers, hardware I/O and system control.
44

5-
Much of this address space is mapped as [Open-Bus](Open-Bus.md "wikilink"), leading us to believe that this area is not used for any purpose. Other areas respond to requests but their purpose is yet undetermined.
5+
Much of this address space is mapped as [Open-Bus](/Glossary.md#open-bus "wikilink"), leading us to believe that this area is not used for any purpose. Other areas respond to requests but their purpose is yet undetermined.
66

77
Registers tend to be controlled on a bit level, so for the sanity purposes, they will be broken down to this level. At any point they are shown spanning multiple columns, that indicates that it is a multi-bit value and should be treated as if they were a number.
88

99
The bits themselves come in four flavors: Read-only, Write-Only, Read-Write, and S-R Strobe. Write-Only registers typically return a zero value, and are generally only used for things such as resetting timers. S-R Strobes are used for clearing interrupt events, writting a logical '1' to any bit that is set will result in a bit being cleared, where as '0' leaves them unchanged. Unused bits always return '0'.
1010

11-
Any register not included on this list reads as [Open-Bus](Open-Bus.md "wikilink") and will be excluded unless a function has otherwise been determined.
11+
Any register not included on this list reads as [Open-Bus](/Glossary.md#open-bus "wikilink") and will be excluded unless a function has otherwise been determined.
1212

1313
## Register Mapping
1414

hardware/cpu/Registers.md.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
The Pokémon mini maps $2000 \~ $20FF as hardware control registers. This area is reserved for hardware related functions such as video, audio, general purpose timers, hardware I/O and system control.
44

5-
Much of this address space is mapped as [Open-Bus](Open-Bus.md "wikilink"), leading us to believe that this area is not used for any purpose. Other areas respond to requests but their purpose is yet undetermined.
5+
Much of this address space is mapped as [Open-Bus](/Glossary.md#open-bus "wikilink"), leading us to believe that this area is not used for any purpose. Other areas respond to requests but their purpose is yet undetermined.
66

77
Registers tend to be controlled on a bit level, so for the sanity purposes, they will be broken down to this level. At any point they are shown spanning multiple columns, that indicates that it is a multi-bit value and should be treated as if they were a number.
88

99
The bits themselves come in four flavors: Read-only, Write-Only, Read-Write, and S-R Strobe. Write-Only registers typically return a zero value, and are generally only used for things such as resetting timers. S-R Strobes are used for clearing interrupt events, writting a logical '1' to any bit that is set will result in a bit being cleared, where as '0' leaves them unchanged. Unused bits always return '0'.
1010

11-
Any register not included on this list reads as [Open-Bus](Open-Bus.md "wikilink") and will be excluded unless a function has otherwise been determined.
11+
Any register not included on this list reads as [Open-Bus](/Glossary.md#open-bus "wikilink") and will be excluded unless a function has otherwise been determined.
1212

1313
## Register Mapping
1414

0 commit comments

Comments
 (0)