libsidplayfp  2.0.5
mos6526.h
1 /*
2  * This file is part of libsidplayfp, a SID player engine.
3  *
4  * Copyright 2011-2020 Leandro Nini <drfiemost@users.sourceforge.net>
5  * Copyright 2009-2014 VICE Project
6  * Copyright 2007-2010 Antti Lankila
7  * Copyright 2000 Simon White
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  */
23 
24 #ifndef MOS6526_H
25 #define MOS6526_H
26 
27 #include <memory>
28 
29 #include <stdint.h>
30 
31 #include "interrupt.h"
32 #include "timer.h"
33 #include "tod.h"
34 #include "SerialPort.h"
35 #include "EventScheduler.h"
36 
37 #include "sidcxx11.h"
38 
39 class EventContext;
40 
41 namespace libsidplayfp
42 {
43 
44 class MOS6526;
45 
52 class TimerA final : public Timer
53 {
54 private:
58  void underFlow() override;
59 
60  void serialPort() override;
61 
62 public:
67  Timer("CIA Timer A", scheduler, parent) {}
68 };
69 
76 class TimerB final : public Timer
77 {
78 private:
79  void underFlow() override;
80 
81 public:
86  Timer("CIA Timer B", scheduler, parent) {}
87 
91  void cascade()
92  {
93  // we pretend that we are CPU doing a write to ctrl register
94  syncWithCpu();
95  state |= CIAT_STEP;
97  }
98 
104  bool started() const { return (state & CIAT_CR_START) != 0; }
105 };
106 
111 {
112 public:
113  InterruptSource8521(EventScheduler &scheduler, MOS6526 &parent) :
114  InterruptSource(scheduler, parent)
115  {}
116 
117  void trigger(uint8_t interruptMask) override;
118 
119  uint8_t clear() override;
120 };
121 
126 {
127 private:
129  bool tbBug;
130 
131 private:
132  void triggerBug() { idr &= ~INTERRUPT_UNDERFLOW_B; }
133 
134 public:
135  InterruptSource6526(EventScheduler &scheduler, MOS6526 &parent) :
136  InterruptSource(scheduler, parent),
137  tbBug(false)
138  {}
139 
140  void trigger(uint8_t interruptMask) override;
141 
142  uint8_t clear() override;
143 
144  void reset() override;
145 };
146 
152 class MOS6526
153 {
154  friend class InterruptSource;
155  friend class SerialPort;
156  friend class TimerA;
157  friend class TimerB;
158  friend class Tod;
159 
160 private:
161  static const char *credit;
162 
163 protected:
166 
168 
169  uint8_t &pra, &prb, &ddra, &ddrb;
171 
173  uint8_t regs[0x10];
174 
176 
178  TimerB timerB;
180 
182  std::unique_ptr<InterruptSource> interruptSource;
183 
186 
189 
191 
194 
195 private:
199  void todInterrupt();
200 
204  void spInterrupt();
205 
218  void bTick();
219 
223  void underflowA();
224 
226  void underflowB();
227 
231  void handleSerialPort();
232 
233 protected:
239  MOS6526(EventScheduler &scheduler);
240 
247  virtual void interrupt(bool state) = 0;
248 
249  virtual void portA() {}
250  virtual void portB() {}
251 
255  uint8_t adjustDataPort(uint8_t data);
256 
263  uint8_t read(uint_least8_t addr);
264 
273  void write(uint_least8_t addr, uint8_t data);
274 
275 public:
281  void setModel(bool newModel);
282 
286  virtual void reset();
287 
293  static const char *credits();
294 
300  void setDayOfTimeRate(unsigned int clock) { tod.setPeriod(clock); }
301 };
302 
303 }
304 
305 #endif // MOS6526_H
libsidplayfp::TimerA
Definition: mos6526.h:53
libsidplayfp::MOS6526::write
void write(uint_least8_t addr, uint8_t data)
Definition: mos6526.cpp:269
libsidplayfp::MOS6526::regs
uint8_t regs[0x10]
These are all CIA registers.
Definition: mos6526.h:173
libsidplayfp::MOS6526::read
uint8_t read(uint_least8_t addr)
Definition: mos6526.cpp:230
libsidplayfp::MOS6526::pra
uint8_t & pra
Ports.
Definition: mos6526.h:169
libsidplayfp::Tod::setPeriod
void setPeriod(event_clock_t clock)
Definition: tod.h:118
libsidplayfp::MOS6526
Definition: mos6526.h:153
libsidplayfp::MOS6526::timerA
TimerA timerA
Timers A and B.
Definition: mos6526.h:177
libsidplayfp::InterruptSource8521::trigger
void trigger(uint8_t interruptMask) override
Definition: mos6526.cpp:75
libsidplayfp::InterruptSource6526::trigger
void trigger(uint8_t interruptMask) override
Definition: mos6526.cpp:106
libsidplayfp::MOS6526::interrupt
virtual void interrupt(bool state)=0
libsidplayfp::EventScheduler
Definition: EventScheduler.h:62
libsidplayfp::MOS6526::bTickEvent
EventCallback< MOS6526 > bTickEvent
Events.
Definition: mos6526.h:192
libsidplayfp::MOS6526::serialPort
SerialPort serialPort
Serial Data Registers.
Definition: mos6526.h:188
libsidplayfp::InterruptSource6526::clear
uint8_t clear() override
Definition: mos6526.cpp:137
libsidplayfp::MOS6526::adjustDataPort
uint8_t adjustDataPort(uint8_t data)
Definition: mos6526.cpp:213
libsidplayfp::Timer::wakeUpAfterSyncWithCpu
void wakeUpAfterSyncWithCpu()
Definition: timer.cpp:60
libsidplayfp::InterruptSource::INTERRUPT_UNDERFLOW_B
@ INTERRUPT_UNDERFLOW_B
underflow Timer B
Definition: interrupt.h:48
libsidplayfp::InterruptSource8521
Definition: mos6526.h:111
libsidplayfp::Timer::state
int_least32_t state
CRA/CRB control register / state.
Definition: timer.h:95
libsidplayfp::InterruptSource
Definition: interrupt.h:42
libsidplayfp::Timer::syncWithCpu
void syncWithCpu()
Definition: timer.cpp:37
libsidplayfp::MOS6526::eventScheduler
EventScheduler & eventScheduler
Event context.
Definition: mos6526.h:165
libsidplayfp::MOS6526::setModel
void setModel(bool newModel)
Definition: mos6526.cpp:370
libsidplayfp::TimerA::TimerA
TimerA(EventScheduler &scheduler, MOS6526 &parent)
Definition: mos6526.h:66
libsidplayfp::MOS6526::interruptSource
std::unique_ptr< InterruptSource > interruptSource
Interrupt Source.
Definition: mos6526.h:182
libsidplayfp::MOS6526::tod
Tod tod
TOD.
Definition: mos6526.h:185
libsidplayfp::InterruptSource8521::clear
uint8_t clear() override
Definition: mos6526.cpp:94
libsidplayfp::Timer
Definition: timer.h:43
libsidplayfp::InterruptSource6526::reset
void reset() override
Definition: mos6526.cpp:153
libsidplayfp::MOS6526::credits
static const char * credits()
Definition: mos6526.cpp:160
libsidplayfp::InterruptSource::InterruptSource
InterruptSource(EventScheduler &scheduler, MOS6526 &parent)
Definition: interrupt.h:90
libsidplayfp::TimerB::TimerB
TimerB(EventScheduler &scheduler, MOS6526 &parent)
Definition: mos6526.h:85
libsidplayfp::SerialPort
Definition: SerialPort.h:37
libsidplayfp::MOS6526::setDayOfTimeRate
void setDayOfTimeRate(unsigned int clock)
Definition: mos6526.h:300
libsidplayfp::Tod
Definition: tod.h:40
libsidplayfp::InterruptSource6526
Definition: mos6526.h:126
libsidplayfp::TimerB
Definition: mos6526.h:77
libsidplayfp::TimerB::started
bool started() const
Definition: mos6526.h:104
libsidplayfp::TimerB::cascade
void cascade()
Definition: mos6526.h:91
libsidplayfp::Timer::parent
MOS6526 & parent
Pointer to the MOS6526 which this Timer belongs to.
Definition: timer.h:92
libsidplayfp::InterruptSource::idr
uint8_t idr
Interrupt data register.
Definition: interrupt.h:70
libsidplayfp::MOS6526::reset
virtual void reset()
Definition: mos6526.cpp:194
libsidplayfp::MOS6526::MOS6526
MOS6526(EventScheduler &scheduler)
Definition: mos6526.cpp:170
libsidplayfp::EventCallback
Definition: EventCallback.h:36