Header checksum

src/bus.rs

@@ -2,7 +2,7 @@ use std::ops::RangeInclusive;
 use crate::utils::{
     join_bytes
 };
-use crate::rom::ROM;
+use crate::rom::{ROM, load_rom};
 use crate::ppu::{
     PPU,
     DMA_ADDRESS,
@@ -27,7 +27,7 @@ pub const INTERRUPT_ENABLE_ADDRESS: u16 = 0xFFFF;
 pub const INTERRUPT_FLAG_ADDRESS: u16 = 0xFF0F;
 
 pub struct Bus {
-    game_rom: ROM,
+    game_rom: Box<dyn ROM>,
     data: [u8; 0x10000],
     pub ppu: PPU,
     pub joypad: Joypad,
@@ -41,44 +41,45 @@ impl Bus {
             println!("Please, specify a ROM file");
             std::process::exit(1);
         }
-        let game_rom = match ROM::load_file(&args[1]) {
+        let game_rom = match load_rom(&args[1]) {
             Ok(rom) => rom,
             Err(err) => {
                 println!("Could not read ROM: {}", err);
                 std::process::exit(1);
             },
         };
-        let mut data = [0x00; 0x10000];
+        let mut bus = Self {
-        // Hardware registers after the bootrom
+            data: [0x00; 0x10000],
-        data[0xFF00] = 0xCF;
-        data[0xFF01] = 0x00;
-        data[0xFF02] = 0x7E;
-        data[0xFF04] = 0x18;
-        data[0xFF05] = 0x00;
-        data[0xFF06] = 0x00;
-        data[0xFF07] = 0xF8;
-        data[0xFF0F] = 0xE1;
-
-        data[0xFF40] = 0x91;
-        data[0xFF41] = 0x81;
-        data[0xFF42] = 0x00;
-        data[0xFF43] = 0x00;
-        data[0xFF44] = 0x91;
-        data[0xFF45] = 0x00;
-        data[0xFF46] = 0xFF;
-        data[0xFF47] = 0xFC;
-
-        data[0xFF4A] = 0x00;
-        data[0xFF4B] = 0x00;
-        data[0xFFFF] = 0x00;
-
-        Self {
-            data,
             game_rom,
             ppu: PPU::new(),
             joypad: Joypad::new(),
             timer: Timer::new(),
-        }
+        };
+
+        // Hardware registers after the bootrom
+        bus.write(0xFF00, 0xCF);
+        bus.write(0xFF01, 0x00);
+        bus.write(0xFF02, 0x7E);
+        bus.write(0xFF04, 0x18);
+        bus.write(0xFF05, 0x00);
+        bus.write(0xFF06, 0x00);
+        bus.write(0xFF07, 0xF8);
+        bus.write(0xFF0F, 0xE1);
+
+        bus.write(0xFF40, 0x91);
+        bus.write(0xFF41, 0x81);
+        bus.write(0xFF42, 0x00);
+        bus.write(0xFF43, 0x00);
+        bus.write(0xFF44, 0x91);
+        bus.write(0xFF45, 0x00);
+        bus.write(0xFF46, 0xFF);
+        bus.write(0xFF47, 0xFC);
+
+        bus.write(0xFF4A, 0x00);
+        bus.write(0xFF4B, 0x00);
+        bus.write(0xFFFF, 0x00);
+
+        bus
     }
 
     pub fn read(&self, address: u16) -> u8 {

src/rom.rs

@@ -1,4 +1,6 @@
+#[cfg(not(test))]
 use std::fs::File;
+#[cfg(not(test))]
 use std::io::Read;
 
 use crate::bus::{
@@ -13,11 +15,56 @@ pub const SGB_FLAG_ADDRESS: u16 = 0x0146;
 pub const RAM_SIZE_ADDRESS: u16 = 0x0149;
 pub const ROM_SIZE_ADDRESS: u16 = 0x0148;
 pub const DESTINATION_CODE_ADDRESS: u16 = 0x014A;
+pub const HEADER_CHECKSUM_ADDRESS: u16 = 0x014D;
 
-#[derive(Debug)]
+#[cfg(not(test))]
-enum Region {
+fn header_checksum(data: &Vec<u8>) -> bool {
-    Japanese,
+    if data.len() < HEADER_CHECKSUM_ADDRESS as usize {
-    NonJapanese,
+        return false;
+    }
+
+    let mut checksum: u8 = 0;
+    let mut index: u16 = 0x0134;
+    while index < HEADER_CHECKSUM_ADDRESS {
+        checksum = checksum.wrapping_sub(data[index as usize]).wrapping_sub(1);
+        index += 1;
+    }
+    checksum == data[HEADER_CHECKSUM_ADDRESS as usize]
+}
+
+#[cfg(test)]
+pub fn load_rom(_filename: &str) -> std::io::Result<Box<dyn ROM>> {
+    Ok(Box::new(NoMBC::new(Vec::new(), ROMInfo {
+        mbc: MBC::NoMBC,
+        publisher: "".to_string(),
+        title: "".to_string(),
+        cgb_only: false,
+        sgb_features: false,
+        has_ram: false,
+        has_battery: false,
+        has_timer: false,
+        ram_banks: 0,
+        rom_banks: 2,
+        region: Region::NonJapanese,
+    })))
+}
+
+#[cfg(not(test))]
+pub fn load_rom(filename: &str) -> std::io::Result<Box<dyn ROM>> {
+    let mut file = File::open(filename)?;
+    let mut data = vec![];
+    file.read_to_end(&mut data)?;
+    if !header_checksum(&data) {
+        return Err(std::io::Error::new(std::io::ErrorKind::InvalidData, "Header checksum failed. Is this a Gameboy ROM?"));
+    }
+
+    let info = ROMInfo::from_bytes(&data);
+
+    Ok(match info.mbc {
+        MBC::NoMBC => Box::new(NoMBC::new(data, info)),
+        MBC::MBC1 => Box::new(MBC1::new(data, info)),
+        _ => unimplemented!(),
+    })
 }
 
 #[derive(Debug, Copy, Clone)]
@@ -36,6 +83,12 @@ enum MBC {
     BandaiTIMA5,
 }
 
+#[derive(Debug)]
+enum Region {
+    Japanese,
+    NonJapanese,
+}
+
 #[derive(Debug)]
 enum BankingMode {
     Simple,
@@ -144,7 +197,41 @@ impl ROMInfo {
     }
 }
 
-pub struct ROM {
+pub trait ROM {
+    fn read(&self, address: u16) -> u8;
+    fn write(&mut self, address: u16, data: u8);
+}
+
+pub struct NoMBC {
+    data: Vec<u8>,
+    info: ROMInfo,
+}
+
+impl NoMBC {
+    pub fn new(data: Vec<u8>, info: ROMInfo) -> Self {
+        let rom = Self {
+            data,
+            info,
+        };
+        println!("MBC {:?}", rom.info.mbc);
+        println!("Region {:?}", rom.info.region);
+
+        rom
+    }
+}
+
+impl ROM for NoMBC {
+    fn read(&self, address: u16) -> u8 {
+        match self.data.get(address as usize) {
+            Some(byte) => *byte,
+            None => 0xFF,
+        }
+    }
+
+    fn write(&mut self, _address: u16, _data: u8) {}
+}
+
+pub struct MBC1 {
     data: Vec<u8>,
     info: ROMInfo,
     ram: Vec<u8>,
@@ -154,21 +241,15 @@ pub struct ROM {
     banking_mode: BankingMode,
 }
 
-impl ROM {
+impl MBC1 {
-    pub fn load_file(filename: &str) -> std::io::Result<Self> {
+    fn new(data: Vec<u8>, info: ROMInfo) -> Self {
-        let mut file = File::open(filename)?;
-        let mut data = vec![];
-        file.read_to_end(&mut data)?;
-
-        let info = ROMInfo::from_bytes(&data);
         println!("MBC {:?}", info.mbc);
+        println!("Region {:?}", info.region);
         println!("Has RAM {}", info.has_ram);
         println!("ROM banks {}", info.rom_banks);
         println!("RAM banks {}", info.ram_banks);
-        println!("Region {:?}", info.region);
         let ram = Vec::with_capacity(info.ram_size() as usize);
-
+        Self {
-        Ok(Self {
             data,
             info,
             ram,
@@ -176,78 +257,10 @@ impl ROM {
             ram_bank: 0,
             ram_enable: false,
             banking_mode: BankingMode::Simple,
-        })
-    }
-
-    pub fn read(&self, address: u16) -> u8 {
-        match self.info.mbc {
-            MBC::NoMBC => {
-                return match self.data.get(address as usize) {
-                    Some(data) => *data,
-                    None => 0xFF,
-                };
-            },
-            MBC::MBC1 => {
-                if BANK_ZERO.contains(&address) {
-                    return self.data[address as usize];
-                } else if BANK_SWITCHABLE.contains(&address) {
-                    return self.data[((self.rom_bank as usize * 0x4000) + (address as usize & 0x3FFF)) as usize];
-                } else if EXTERNAL_RAM.contains(&address) {
-                    if !self.info.has_ram {
-                        return 0xFF;
-                    }
-                    return match self.ram.get((address - EXTERNAL_RAM.min().unwrap() + (0x2000 * self.ram_bank as u16)) as usize) {
-                        Some(data) => *data,
-                        None => 0xFF,
-                    };
-                }
-                unreachable!("ROM read: Address {} not valid", address);
-            },
-            _ => unimplemented!(),
         }
     }
 
-    pub fn write(&mut self, address: u16, data: u8) {
+    fn switch_rom_bank(&mut self, bank: u16) {
-        match self.info.mbc {
-            MBC::NoMBC => {},
-            MBC::MBC1 => {
-                if address <= 0x1FFF { // RAM enable register
-                    if !self.info.has_ram {
-                        return;
-                    }
-                    self.ram_enable = match data & 0x0F {
-                        0x0A => true,
-                        _ => false,
-                    };
-                    return;
-                } else if address >= 0x2000 && address <= 0x3FFF { // ROM bank number register
-                    // println!("Switch bank to {:02X}", data);
-                    self.switch_rom_bank(data as u16 & 0b00011111);
-                } else if address >= 0x4000 && address <= 0x5FFF { // ROM and RAM bank number register
-                    // println!("RAM bank {:02X}", data);
-                    self.ram_bank = data & 0b11;
-                } else if address >= 0x6000 && address <= 0x7FFF { // Banking mode select
-                    self.banking_mode = match data & 1 {
-                        0 => BankingMode::Simple,
-                        1 => BankingMode::Advanced,
-                        _ => unreachable!(),
-                    }
-                } else if EXTERNAL_RAM.contains(&address) {
-                    if !self.ram_enable || !self.info.has_ram {
-                        return;
-                    }
-                    let address = address as usize - EXTERNAL_RAM.min().unwrap() as usize + (EXTERNAL_RAM.min().unwrap() as usize * self.ram_bank as usize);
-                    if let Some(elem) = self.ram.get_mut(address) {
-                        *elem = data;
-                    }
-                    self.switch_rom_bank(self.rom_bank + (data as u16 >> 5));
-                }
-            },
-            _ => unimplemented!(),
-        }
-    }
-
-    pub fn switch_rom_bank(&mut self, bank: u16) {
         self.rom_bank = bank;
         if self.rom_bank > self.info.rom_banks.saturating_sub(1) {
             self.rom_bank = self.info.rom_banks.saturating_sub(1);
@@ -257,3 +270,56 @@ impl ROM {
         }
     }
 }
+
+impl ROM for MBC1 {
+    fn read(&self, address: u16) -> u8 {
+        if BANK_ZERO.contains(&address) {
+            return self.data[address as usize];
+        } else if BANK_SWITCHABLE.contains(&address) {
+            return self.data[((self.rom_bank as usize * 0x4000) + (address as usize & 0x3FFF)) as usize];
+        } else if EXTERNAL_RAM.contains(&address) {
+            if !self.info.has_ram {
+                return 0xFF;
+            }
+            return match self.ram.get((address - EXTERNAL_RAM.min().unwrap() + (0x2000 * self.ram_bank as u16)) as usize) {
+                Some(data) => *data,
+                None => 0xFF,
+            };
+        }
+        unreachable!("ROM read: Address {} not valid", address);
+    }
+
+    fn write(&mut self, address: u16, data: u8) {
+        if address <= 0x1FFF { // RAM enable register
+            if !self.info.has_ram {
+                return;
+            }
+            self.ram_enable = match data & 0x0F {
+                0x0A => true,
+                _ => false,
+            };
+            return;
+        } else if address >= 0x2000 && address <= 0x3FFF { // ROM bank number register
+            // println!("Switch bank to {:02X}", data);
+            self.switch_rom_bank(data as u16 & 0b00011111);
+        } else if address >= 0x4000 && address <= 0x5FFF { // ROM and RAM bank number register
+            // println!("RAM bank {:02X}", data);
+            self.ram_bank = data & 0b11;
+        } else if address >= 0x6000 && address <= 0x7FFF { // Banking mode select
+            self.banking_mode = match data & 1 {
+                0 => BankingMode::Simple,
+                1 => BankingMode::Advanced,
+                _ => unreachable!(),
+            }
+        } else if EXTERNAL_RAM.contains(&address) {
+            if !self.ram_enable || !self.info.has_ram {
+                return;
+            }
+            let address = address as usize - EXTERNAL_RAM.min().unwrap() as usize + (EXTERNAL_RAM.min().unwrap() as usize * self.ram_bank as usize);
+            if let Some(elem) = self.ram.get_mut(address) {
+                *elem = data;
+            }
+            self.switch_rom_bank(self.rom_bank + (data as u16 >> 5));
+        }
+    }
+}