-
Notifications
You must be signed in to change notification settings - Fork 19
/
mapper.go
59 lines (51 loc) · 2.25 KB
/
mapper.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// This file is part of Gopher2600.
//
// Gopher2600 is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Gopher2600 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Gopher2600. If not, see <https://www.gnu.org/licenses/>.
package cartridge
import (
"github.com/jetsetilly/gopher2600/hardware/memory/cartridge/banks"
)
// cartMapper implementations hold the actual data from the loaded ROM and
// keeps track of which banks are mapped to individual addresses. for
// convenience, functions with an address argument recieve that address
// normalised to a range of 0x0000 to 0x0fff
type cartMapper interface {
Initialise()
ID() string
Read(addr uint16, active bool) (data uint8, err error)
Write(addr uint16, data uint8, active bool, poke bool) error
NumBanks() int
GetBank(addr uint16) banks.Details
// patch differs from write/poke in that it alters the data as though it
// was being read from disk. that is, the offset is measured from the start
// of the file. the cartmapper must translate the offset and update the
// correct data structure as appropriate.
Patch(offset int, data uint8) error
// see the commentary for the Listen() function in the Cartridge type for
// an explanation for what this does
Listen(addr uint16, data uint8)
// some cartridge mappings have indpendent clocks that tick and change
// internal cartridge state. the step() function is called every cpu cycle
// at a rate of 1.19. cartridges with slower clocks need to handle the rate
// change.
Step()
// return all the banks in the cartridge in sequence. see commentary for
// IterateBanks() function in the Cartridge type for details.
IterateBanks(prev *banks.Content) *banks.Content
}
// optionalSuperchip are implemented by cartMappers that have an optional
// superchip
type optionalSuperchip interface {
addSuperchip() bool
}