libsidplayfp  2.4.0
mmu.h
1 /*
2  * This file is part of libsidplayfp, a SID player engine.
3  *
4  * Copyright 2011-2021 Leandro Nini <drfiemost@users.sourceforge.net>
5  * Copyright 2007-2010 Antti Lankila
6  * Copyright 2000 Simon White
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef MMU_H
24 #define MMU_H
25 
26 #include <stdint.h>
27 
28 #include "sidendian.h"
29 #include "sidmemory.h"
30 #include "EventScheduler.h"
31 
32 #include "Banks/pla.h"
33 #include "Banks/SystemRAMBank.h"
34 #include "Banks/SystemROMBanks.h"
35 #include "Banks/ZeroRAMBank.h"
36 
37 #include "sidcxx11.h"
38 
39 #include <string.h>
40 
41 namespace libsidplayfp
42 {
43 
44 class Bank;
45 class IOBank;
46 
50 class MMU final : public PLA, public sidmemory
51 {
52 private:
53  EventScheduler &eventScheduler;
54 
56  bool loram, hiram, charen;
57 
59  Bank* cpuReadMap[16];
60 
62  Bank* cpuWriteMap[16];
63 
65  IOBank* ioBank;
66 
68  KernalRomBank kernalRomBank;
69 
71  BasicRomBank basicRomBank;
72 
74  CharacterRomBank characterRomBank;
75 
77  SystemRAMBank ramBank;
78 
80  ZeroRAMBank zeroRAMBank;
81 
83  mutable unsigned int seed;
84 
85 private:
86  void setCpuPort(uint8_t state) override;
87  uint8_t getLastReadByte() const override;
88  event_clock_t getPhi2Time() const override { return eventScheduler.getTime(EVENT_CLOCK_PHI2); }
89 
90  void updateMappingPHI2();
91 
92 public:
93  MMU(EventScheduler &eventScheduler, IOBank* ioBank);
94 
95  void reset();
96 
97  // ROM banks methods
98  void setKernal(const uint8_t* rom) override { kernalRomBank.set(rom); }
99  void setBasic(const uint8_t* rom) override { basicRomBank.set(rom); }
100  void setChargen(const uint8_t* rom) override { characterRomBank.set(rom); }
101 
102  // RAM access methods
103  uint8_t readMemByte(uint_least16_t addr) override { return ramBank.peek(addr); }
104  uint_least16_t readMemWord(uint_least16_t addr) override { return endian_little16(ramBank.ram+addr); }
105 
106  void writeMemByte(uint_least16_t addr, uint8_t value) override { ramBank.poke(addr, value); }
107  void writeMemWord(uint_least16_t addr, uint_least16_t value) override { endian_little16(ramBank.ram+addr, value); }
108 
109  void fillRam(uint_least16_t start, uint8_t value, unsigned int size) override
110  {
111  memset(ramBank.ram+start, value, size);
112  }
113  void fillRam(uint_least16_t start, const uint8_t* source, unsigned int size) override
114  {
115  memcpy(ramBank.ram+start, source, size);
116  }
117 
118  // SID specific hacks
119  void installResetHook(uint_least16_t addr) override { kernalRomBank.installResetHook(addr); }
120 
121  void installBasicTrap(uint_least16_t addr) override { basicRomBank.installTrap(addr); }
122 
123  void setBasicSubtune(uint8_t tune) override { basicRomBank.setSubtune(tune); }
124 
131  uint8_t cpuRead(uint_least16_t addr) const { return cpuReadMap[addr >> 12]->peek(addr); }
132 
139  void cpuWrite(uint_least16_t addr, uint8_t data) { cpuWriteMap[addr >> 12]->poke(addr, data); }
140 };
141 
142 }
143 
144 #endif
Definition: Bank.h:36
virtual uint8_t peek(uint_least16_t address)=0
virtual void poke(uint_least16_t address, uint8_t value)=0
Definition: SystemROMBanks.h:153
void installTrap(uint_least16_t addr)
Definition: SystemROMBanks.h:182
Definition: SystemROMBanks.h:210
Definition: EventScheduler.h:62
event_clock_t getTime(event_phase_t phase) const
Definition: EventScheduler.h:162
Definition: IOBank.h:40
Definition: SystemROMBanks.h:89
void installResetHook(uint_least16_t addr)
Definition: SystemROMBanks.h:140
Definition: mmu.h:51
void installBasicTrap(uint_least16_t addr) override
Definition: mmu.h:121
void cpuWrite(uint_least16_t addr, uint8_t data)
Definition: mmu.h:139
void installResetHook(uint_least16_t addr) override
Definition: mmu.h:119
uint8_t readMemByte(uint_least16_t addr) override
Definition: mmu.h:103
void writeMemWord(uint_least16_t addr, uint_least16_t value) override
Definition: mmu.h:107
void setBasicSubtune(uint8_t tune) override
Definition: mmu.h:123
void writeMemByte(uint_least16_t addr, uint8_t value) override
Definition: mmu.h:106
void setKernal(const uint8_t *rom) override
Definition: mmu.h:98
void fillRam(uint_least16_t start, uint8_t value, unsigned int size) override
Definition: mmu.h:109
void fillRam(uint_least16_t start, const uint8_t *source, unsigned int size) override
Definition: mmu.h:113
uint_least16_t readMemWord(uint_least16_t addr) override
Definition: mmu.h:104
uint8_t cpuRead(uint_least16_t addr) const
Definition: mmu.h:131
Definition: pla.h:35
Definition: SystemRAMBank.h:39
uint8_t peek(uint_least16_t address) override
Definition: SystemRAMBank.h:72
void poke(uint_least16_t address, uint8_t value) override
Definition: SystemRAMBank.h:77
Definition: ZeroRAMBank.h:132
void set(const uint8_t *source)
Definition: SystemROMBanks.h:70
Definition: sidmemory.h:34