Documentation
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
use bitvec::prelude::*;
use log::{debug, info, trace, warn};
use serde::{Deserialize, Serialize};
use std::cmp::max;

use crate::{
    config, context,
    io::Io,
    mbc::{Mbc, MbcTrait},
    ppu,
    util::{pack, trait_alias},
};

#[derive(Serialize, Deserialize)]
pub struct Bus {
    #[serde(with = "serde_bytes")]
    ram: Vec<u8>,
    ram_bank: u8,
    #[serde(with = "serde_bytes")]
    hiram: Vec<u8>,
    #[serde(with = "serde_bytes")]
    boot_rom: Option<Vec<u8>>,
    map_boot_rom: bool,
    vram_bank: u8,
    current_speed: u8,
    prepare_speed_switch: u8,
    switch_delay: u16,
    mbc: Mbc,
    io: Io,
    dma: Dma,
    hdma: Hdma,
    // Undocumented registers
    reg_ff72: u8,
    reg_ff73: u8,
    reg_ff75: u8,
}

trait_alias!(pub trait Context =
    context::Rom + context::ExternalRam + context::Vram +
    context::Oam + context::Ppu + context::Apu + context::InterruptFlag + context::Model);

#[derive(Default, Serialize, Deserialize)]
struct Dma {
    source: u8,
    pos: u8,
    enabled: bool,
    delay: usize,
}

#[derive(Default, Serialize, Deserialize)]
struct Hdma {
    source: u16,
    dest: u16,
    mode: HdmaMode,
    length: u8,
    enabled_general_dma: bool,
    enabled_hblank_dma: bool,
    prev_hblank: bool,
}

#[derive(Serialize, Deserialize)]
enum HdmaMode {
    General,
    HBlank,
}

impl Default for HdmaMode {
    fn default() -> Self {
        HdmaMode::General
    }
}

impl Bus {
    pub fn new(model: config::Model, mbc: Mbc, boot_rom: &Option<Vec<u8>>, io: Io) -> Self {
        if let Some(boot_rom) = boot_rom {
            if !model.is_cgb() {
                assert_eq!(boot_rom.len(), 0x100, "DMG Boot ROM must be 256 bytes");
            } else {
                assert_eq!(boot_rom.len(), 0x900, "CGB Boot ROM must be 2304 bytes");
            }
        }

        let ram_size = if model.is_cgb() { 0x8000 } else { 0x2000 };

        Self {
            ram: vec![0; ram_size],
            ram_bank: 1,
            hiram: vec![0; 0x7F],
            boot_rom: boot_rom.clone(),
            map_boot_rom: boot_rom.is_some(),
            vram_bank: 0,
            current_speed: 0,
            prepare_speed_switch: 0,
            switch_delay: 0,
            mbc,
            io,
            dma: Dma::default(),
            hdma: Hdma::default(),
            reg_ff72: 0,
            reg_ff73: 0,
            reg_ff75: 0,
        }
    }

    pub fn read(&mut self, ctx: &mut impl Context, addr: u16) -> u8 {
        let data = self.read_(ctx, addr);
        trace!("<-- Read:  ${addr:04X} = ${data:02X}");
        data
    }

    pub fn read_immutable(&mut self, ctx: &mut impl Context, addr: u16) -> Option<u8> {
        match addr {
            0xFF00..=0xFF7F | 0xFFFF => None,
            _ => Some(self.read_(ctx, addr)),
        }
    }

    fn read_(&mut self, ctx: &mut impl Context, addr: u16) -> u8 {
        match addr {
            0x0100..=0x01FF => self.mbc.read(ctx, addr),
            0x0000..=0x08FF => {
                let is_boot_rom = self.map_boot_rom
                    && self
                        .boot_rom
                        .as_ref()
                        .map_or(false, |r| r.len() > addr as usize);
                if is_boot_rom {
                    if let Some(boot_rom) = &self.boot_rom {
                        boot_rom[addr as usize]
                    } else {
                        !0
                    }
                } else {
                    self.mbc.read(ctx, addr)
                }
            }
            0x0900..=0x7FFF => self.mbc.read(ctx, addr),
            0x8000..=0x9FFF => {
                ctx.vram()[((addr & 0x1FFF) | (self.vram_bank as u16 * 0x2000)) as usize]
            }
            0xA000..=0xBFFF => self.mbc.read(ctx, addr),
            0xC000..=0xFDFF => {
                let bank = addr & 0x1000;
                self.ram[((addr & 0x0FFF) + bank * self.ram_bank as u16) as usize]
            }
            0xFE00..=0xFE9F => {
                if !self.dma.enabled {
                    ctx.oam()[(addr & 0xff) as usize]
                } else {
                    !0
                }
            }
            0xFEA0..=0xFEFF => {
                warn!("Read from Unusable address: ${addr:04x}");
                !0
            }
            0xFF46 => self.dma.source, // DMA
            0xFF50 => !0,              // BANK

            0xFF4C => !0, // KEY0 CPU mode register

            // KEY1 - CGB Mode Only - Prepare Speed Switch
            0xFF4D => {
                if ctx.running_mode().is_cgb() {
                    pack! {
                        7..=7 => self.current_speed,
                        1..=6 => !0,
                        0..=0 => self.prepare_speed_switch,
                    }
                } else {
                    !0
                }
            }
            0xFF4E => !0, // ???

            // VBK - CGB Mode Only - VRAM Bank (R/W)
            0xFF4F => {
                if ctx.running_mode().is_cgb() {
                    pack!(0..=0 => self.vram_bank, 1..=7 => !0)
                } else {
                    !0
                }
            }

            0xFF51 => {
                warn!("Load HDMA1");
                !0
            } // HDMA1 (New DMA Source, High) (W) - CGB Mode Only
            0xFF52 => {
                warn!("Load HDMA2");
                !0
            } // HDMA2 (New DMA Source, Low) (W) - CGB Mode Only
            0xFF53 => {
                warn!("Load HDMA3");
                !0
            } // HDMA3 (New DMA Destination, High) (W) - CGB Mode Only
            0xFF54 => {
                warn!("Load HDMA4");
                !0
            } // HDMA4 (New DMA Destination, Low) (W) - CGB Mode Only

            // HDMA5 (New DMA Length/Mode/Start) (W) - CGB Mode Only
            0xFF55 => {
                if ctx.running_mode().is_cgb() {
                    pack! {
                        7 => !self.hdma.enabled_hblank_dma,
                        0..=6 => self.hdma.length,
                    }
                } else {
                    !0
                }
            }
            // SVBK - CGB Mode Only - WRAM Bank
            0xFF70 => {
                if ctx.running_mode().is_cgb() {
                    pack!(0..=2 => self.ram_bank, 3..=7 => !0)
                } else {
                    !0
                }
            }

            // Undocumented registers
            0xFF72 => self.reg_ff72,
            0xFF73 => self.reg_ff73,
            0xFF75 => pack! {
                7..=7 => !0,
                4..=6 => self.reg_ff75,
                0..=3 => !0,
            },

            0xFF00..=0xFF7F => self.io.read(ctx, addr),
            0xFF80..=0xFFFE => self.hiram[(addr & 0x7F) as usize],
            0xFFFF => self.io.read(ctx, addr),
        }
    }

    pub fn write(&mut self, ctx: &mut impl Context, addr: u16, data: u8) {
        trace!("--> Write: ${addr:04X} = ${data:02X}");
        match addr {
            0x0000..=0x7FFF => self.mbc.write(ctx, addr, data),
            0x8000..=0x9FFF => {
                ctx.vram_mut()[((addr & 0x1FFF) | (self.vram_bank as u16 * 0x2000)) as usize] = data
            }
            0xA000..=0xBFFF => self.mbc.write(ctx, addr, data),
            0xC000..=0xFDFF => {
                let bank = addr & 0x1000;
                self.ram[((addr & 0x0FFF) + bank * self.ram_bank as u16) as usize] = data;
            }
            0xFE00..=0xFE9F => {
                if !self.dma.enabled && !ctx.oam_lock() {
                    ctx.oam_mut()[(addr & 0xff) as usize] = data;
                }
            }
            0xFEA0..=0xFEFF => {
                // warn!("Write to Unusable address: ${addr:04X} = ${data:02X}")
            }

            0xFF46 => {
                // DMA
                self.dma.source = data;
                self.dma.pos = 0;
                self.dma.enabled = false;
                self.dma.delay = 2;
            }
            0xFF50 => self.map_boot_rom = data & 1 == 0, // BANK

            // KEY0 CPU mode register
            0xFF4C => {
                if ctx.model().is_cgb() {
                    let mode = match data.view_bits::<Lsb0>()[2..=3].load::<u8>() {
                        0 => context::RunningMode::Cgb,
                        1 => context::RunningMode::Dmg,
                        2 => context::RunningMode::Pgb1,
                        3 => context::RunningMode::Pgb2,
                        _ => unreachable!(),
                    };

                    ctx.set_running_mode(mode);
                    debug!("KEY0: CGB mode changed: {mode:?}");
                } else {
                    warn!("KEY0 write on non-CGB");
                }
            }

            // KEY1 - CGB Mode Only - Prepare Speed Switch
            0xFF4D => {
                if ctx.model().is_cgb() {
                    debug!("KEY1: {data:02X}");
                    self.prepare_speed_switch = data & 1;
                } else {
                    warn!("KEY1 write on non-CGB");
                }
            }

            // VBK - CGB Mode Only - VRAM Bank (R/W)
            0xFF4F => {
                if ctx.model().is_cgb() {
                    self.vram_bank = data & 1;
                } else {
                    warn!("VBK write on non-CGB");
                }
            }
            // HDMA1 (New DMA Source, High) (W) - CGB Mode Only
            0xFF51 => {
                if ctx.model().is_cgb() {
                    self.hdma.source.view_bits_mut::<Lsb0>()[8..=15].store(data);
                } else {
                    warn!("HDMA1 write on non-CGB");
                }
            }
            // HDMA2 (New DMA Source, Low) (W) - CGB Mode Only
            0xFF52 => {
                if ctx.model().is_cgb() {
                    self.hdma.source.view_bits_mut::<Lsb0>()[0..=7].store(data & !0xf);
                } else {
                    warn!("HDMA2 write on non-CGB");
                }
            }
            // HDMA3 (New DMA Destination, High) (W) - CGB Mode Only
            0xFF53 => {
                if ctx.model().is_cgb() {
                    self.hdma.dest.view_bits_mut::<Lsb0>()[8..=12].store(data & 0x1f);
                } else {
                    warn!("HDMA3 write on non-CGB");
                }
            }
            // HDMA4 (New DMA Destination, Low) (W) - CGB Mode Only
            0xFF54 => {
                if ctx.model().is_cgb() {
                    self.hdma.dest.view_bits_mut::<Lsb0>()[0..=7].store(data & !0xf);
                } else {
                    warn!("HDMA4 write on non-CGB");
                }
            }
            // HDMA5 (New DMA Length/Mode/Start) (W) - CGB Mode Only
            0xFF55 => {
                if ctx.model().is_cgb() {
                    let v = data.view_bits::<Lsb0>();

                    assert!(!self.hdma.enabled_general_dma);

                    if self.hdma.enabled_hblank_dma {
                        assert!(!v[7], "General DMA start on doing HBLANK DMA");
                        self.hdma.enabled_hblank_dma = false;
                    } else if v[7] {
                        // HBlank DMA
                        self.hdma.enabled_hblank_dma = true;
                        self.hdma.length = v[0..=6].load();
                    } else {
                        // General Purpose DMA
                        self.hdma.enabled_general_dma = true;
                        self.hdma.length = v[0..=6].load();
                    }
                } else {
                    warn!("HDMA5 write on non-CGB");
                }
            }

            // SVBK - CGB Mode Only - WRAM Bank
            0xFF70 => {
                if ctx.model().is_cgb() {
                    self.ram_bank = max(1, data & 0x7);
                } else {
                    warn!("SVBK write on non-CGB");
                }
            }

            // Undocumented registers
            0xFF72 => self.reg_ff72 = data,
            0xFF73 => self.reg_ff73 = data,
            0xFF75 => self.reg_ff75.view_bits_mut::<Lsb0>()[4..=6]
                .store(data.view_bits::<Lsb0>()[4..=6].load::<u8>()),

            0xFF00..=0xFF7F => self.io.write(ctx, addr, data),
            0xFF80..=0xFFFE => self.hiram[(addr & 0x7f) as usize] = data,
            0xFFFF => self.io.write(ctx, addr, data),
        };
    }

    pub fn io(&mut self) -> &mut Io {
        &mut self.io
    }

    pub fn mbc(&self) -> &Mbc {
        &self.mbc
    }

    pub fn mbc_mut(&mut self) -> &mut Mbc {
        &mut self.mbc
    }

    pub fn boot_rom(&self) -> &Option<Vec<u8>> {
        &self.boot_rom
    }

    pub fn current_speed(&self) -> u8 {
        self.current_speed
    }

    pub fn stop(&mut self) {
        if self.prepare_speed_switch != 0 {
            self.prepare_speed_switch = 0;
            self.switch_delay = 2050;
        }
    }

    pub fn tick(&mut self, ctx: &mut impl Context) {
        self.process_dma(ctx);
        self.process_hdma(ctx);

        if self.switch_delay > 0 {
            self.switch_delay -= 1;
            if self.switch_delay == 0 {
                info!(
                    "Switch speed: {} -> {}",
                    self.current_speed,
                    self.current_speed ^ 1
                );
                self.current_speed ^= 1;
                ctx.wake();
            }
        }
    }

    fn process_dma(&mut self, ctx: &mut impl Context) {
        if self.dma.delay > 0 {
            self.dma.delay -= 1;
            if self.dma.delay == 0 {
                self.dma.enabled = true;
            }
            return;
        }
        if !self.dma.enabled {
            return;
        }
        log::trace!(
            "<-> DMA:   ${:02X}{:02X} -> $FE{:02X}",
            self.dma.source,
            self.dma.pos,
            self.dma.pos
        );
        let data = self.read_(ctx, (self.dma.source as u16) << 8 | self.dma.pos as u16);
        ctx.oam_mut()[self.dma.pos as usize] = data;
        self.dma.pos += 1;
        if self.dma.pos == 0xA0 {
            self.dma.enabled = false;
        }
    }

    fn process_hdma(&mut self, ctx: &mut impl Context) {
        assert!(!(self.hdma.enabled_general_dma && self.hdma.enabled_hblank_dma));

        let cur_hblank = ctx.mode() == ppu::Mode::Hblank;
        let enter_hblank = !self.hdma.prev_hblank && cur_hblank;
        self.hdma.prev_hblank = cur_hblank;

        if self.hdma.enabled_general_dma || (self.hdma.enabled_hblank_dma && enter_hblank) {
            log::trace!("HDMA: ${:04X} -> ${:04X}", self.hdma.source, self.hdma.dest);
            for i in 0..16 {
                let dat = self.read_(ctx, self.hdma.source + i);
                self.write(ctx, 0x8000 | (self.hdma.dest + i), dat);
            }
            self.hdma.source = self.hdma.source.wrapping_add(16);
            self.hdma.dest = self.hdma.dest.wrapping_add(16);

            let (new_length, ovf) = self.hdma.length.overflowing_sub(1);
            self.hdma.length = new_length;
            if ovf || self.hdma.dest >= 0x2000 {
                self.hdma.enabled_general_dma = false;
                self.hdma.enabled_hblank_dma = false;
                self.hdma.dest &= 0x1FFF;
            }

            ctx.stall_cpu(if self.current_speed == 0 { 8 } else { 16 });
        }
    }
}