rnes 0.1.0

data/lib/rnes/cpu_bus.rb

@@ -0,0 +1,105 @@
+require 'rnes/errors'
+
+module Rnes
+  class CpuBus
+    # @param [Rnes::Rom]
+    # @return [Rnes::Rom]
+    attr_accessor :program_rom
+
+    # @param [Rnes::DmaController] dma_controller
+    # @param [Rnes::Keypad] keypad1
+    # @param [Rnes::Keypad] keypad2
+    # @param [Rnes::Ppu] ppu
+    # @param [Rnes::Ram] ram
+    def initialize(dma_controller:, keypad1:, keypad2:, ppu:, ram:)
+      @dma_controller = dma_controller
+      @keypad1 = keypad1
+      @keypad2 = keypad2
+      @ppu = ppu
+      @ram = ram
+    end
+
+    # @todo
+    # @param [Integer]
+    # @return [Integer]
+    def read(address)
+      case address
+      when 0x0000..0x07FF
+        @ram.read(address)
+      when 0x0800..0x1FFF
+        @ram.read(address - 0x0800)
+      when 0x2000..0x2007
+        @ppu.read(address - 0x2000)
+      when 0x2008..0x3FFF
+        @ppu.read(address - 0x2008)
+      when 0x4016
+        @keypad1.read
+      when 0x4017
+        @keypad2.read
+      when 0x4000..0x401F
+        0 # TODO: I/O port for APU, etc
+      when 0x4020..0x5FFF
+        0 # TODO: extended RAM on special mappers
+      when 0x6000..0x7FFF
+        0 # TODO: battery-backed-up RAM
+      when 0x8000..0xBFFF
+        try_to_read_program_rom(address - 0x8000)
+      when 0xC000..0xFFFF
+        try_to_read_program_rom(address - offset_on_reading_program_rom_higher_region)
+      else
+        raise ::Rnes::Errors::InvalidCpuBusAddressError, address
+      end
+    end
+
+    # @todo
+    # @param [Integer] address
+    # @param [Integer] value
+    def write(address, value)
+      case address
+      when 0x0000..0x07FF
+        @ram.write(address, value)
+      when 0x0800..0x1FFF
+        @ram.write(address - 0x0800, value)
+      when 0x2000..0x2007
+        @ppu.write(address - 0x2000, value)
+      when 0x2008..0x3FFF
+        @ppu.write(address - 0x2008, value)
+      when 0x4014
+        @dma_controller.request_transfer(address_hint: value)
+      when 0x4016
+        @keypad1.write(value)
+      when 0x4017
+        @keypad2.write(value)
+      when 0x4000..0x401F
+        0 # TODO: I/O port for APU, etc
+      when 0x4020..0x5FFF
+        0 # TODO: extended RAM on special mappers
+      when 0x6000..0x7FFF
+        0 # TODO: battery-backed-up RAM
+      else
+        raise ::Rnes::Errors::InvalidCpuBusAddressError, address
+      end
+    end
+
+    private
+
+    # @return [Boolean]
+    def attatched_to_large_program_rom?
+      @program_rom.bytesize > 16 * 2**10
+    end
+
+    # @return [Integer]
+    def offset_on_reading_program_rom_higher_region
+      attatched_to_large_program_rom? ? 0x8000 : 0xC000
+    end
+
+    # @param [Integer] address
+    def try_to_read_program_rom(address)
+      if @program_rom
+        @program_rom.read(address)
+      else
+        raise ::Rnes::Errors::ProgramRomNotConnectedError
+      end
+    end
+  end
+end

data/lib/rnes/cpu_registers.rb

@@ -0,0 +1,151 @@
+module Rnes
+  class CpuRegisters
+    CARRY_BIT_INDEX = 0
+    ZERO_BIT_INDEX = 1
+    INTERRUPT_BIT_INDEX = 2
+    DECIMAL_BIT_INDEX = 3
+    BREAK_BIT_INDEX = 4
+    RESERVED_BIT_INDEX = 5
+    OVERFLOW_BIT_INDEX = 6
+    NEGATIVE_BIT_INDEX = 7
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :accumulator
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :index_x
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :index_y
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :program_counter
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :stack_pointer
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :status
+
+    def initialize
+      @accumulator = 0x00
+      @index_x = 0x00
+      @index_y = 0x00
+      @program_counter = 0x0000
+      @stack_pointer = 0x0000
+      @status = 0b00000000
+    end
+
+    # @return [Boolean]
+    def break?
+      @status[BREAK_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def break=(boolean)
+      toggle_bit(BREAK_BIT_INDEX, boolean)
+    end
+
+    # @return [Boolean]
+    def carry?
+      @status[CARRY_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def carry=(boolean)
+      toggle_bit(CARRY_BIT_INDEX, boolean)
+    end
+
+    # @return [Integer]
+    def carry_bit
+      @status[CARRY_BIT_INDEX]
+    end
+
+    # @return [Boolean]
+    def decimal?
+      @status[DECIMAL_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def decimal=(boolean)
+      toggle_bit(DECIMAL_BIT_INDEX, boolean)
+    end
+
+    # @return [Boolean]
+    def interrupt?
+      @status[INTERRUPT_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def interrupt=(boolean)
+      toggle_bit(INTERRUPT_BIT_INDEX, boolean)
+    end
+
+    # @return [Boolean]
+    def negative?
+      @status[NEGATIVE_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def negative=(boolean)
+      toggle_bit(NEGATIVE_BIT_INDEX, boolean)
+    end
+
+    # @return [Boolean]
+    def overflow?
+      @status[OVERFLOW_BIT_INDEX] == 1
+    end
+
+    # @return [Boolean]
+    def reserved?
+      @status[RESERVED_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def reserved=(boolean)
+      toggle_bit(RESERVED_BIT_INDEX, boolean)
+    end
+
+    def reset
+      @accumulator = 0x00
+      @index_x = 0x00
+      @index_y = 0x00
+      @program_counter = 0x0000
+      @stack_pointer = 0x1FD
+      @status = 0b00110100
+    end
+
+    # @param [Boolean] boolean
+    def overflow=(boolean)
+      toggle_bit(OVERFLOW_BIT_INDEX, boolean)
+    end
+
+    # @return [Boolean]
+    def zero?
+      @status[ZERO_BIT_INDEX] == 1
+    end
+
+    # @param [Boolean] boolean
+    def zero=(boolean)
+      toggle_bit(ZERO_BIT_INDEX, boolean)
+    end
+
+    private
+
+    # @param [Integer] index
+    # @param [Boolean] boolean
+    def toggle_bit(index, boolean)
+      if boolean
+        @status |= 1 << index
+      else
+        @status &= ~(1 << index)
+      end
+    end
+  end
+end

data/lib/rnes/dma_controller.rb

@@ -0,0 +1,35 @@
+module Rnes
+  class DmaController
+    TRANSFER_BYTESIZE = 2**8
+
+    # @param [Rnes::Ppu] ppu
+    # @param [Rnes::Ram] working_ram
+    def initialize(ppu:, working_ram:)
+      @ppu = ppu
+      @requested = false
+      @working_ram = working_ram
+    end
+
+    def transfer_if_requested
+      if @requested
+        transfer
+      end
+    end
+
+    # @param [Integer] address_hint
+    def request_transfer(address_hint:)
+      @requested = true
+      @working_ram_address = address_hint << 8
+    end
+
+    private
+
+    def transfer
+      TRANSFER_BYTESIZE.times do |index|
+        value = @working_ram.read(@working_ram_address + index)
+        @ppu.transfer_sprite_data(index: index, value: value)
+      end
+      @requested = false
+    end
+  end
+end

data/lib/rnes/emulator.rb

@@ -0,0 +1,61 @@
+require 'io/console'
+require 'rnes/logger'
+require 'rnes/parts_factory'
+require 'rnes/rom_loader'
+
+module Rnes
+  class Emulator
+    LOG_FILE_NAME = 'rnes.log'.freeze
+
+    def initialize
+      parts_factory = ::Rnes::PartsFactory.new
+      @cpu = parts_factory.cpu
+      @cpu_bus = parts_factory.cpu_bus
+      @dma_controller = parts_factory.dma_controller
+      @keypad1 = parts_factory.keypad1
+      @keypad2 = parts_factory.keypad2
+      @ppu = parts_factory.ppu
+      @ppu_bus = parts_factory.ppu_bus
+      @logger = ::Rnes::Logger.new(cpu: @cpu, path: LOG_FILE_NAME, ppu: @ppu)
+    end
+
+    # @param [Array<Integer>] rom_bytes
+    def load_rom(rom_bytes)
+      rom_loader = ::Rnes::RomLoader.new(rom_bytes)
+      copy(from: rom_loader.character_rom, to: @ppu_bus.character_ram)
+      @cpu_bus.program_rom = rom_loader.program_rom
+      @cpu.reset
+    end
+
+    def run
+      $stdin.noecho do
+        loop do
+          if @logger
+            @logger.puts
+          end
+          tick
+        end
+      end
+    end
+
+    def tick
+      @dma_controller.transfer_if_requested
+      (@cpu.tick * 3).times do
+        @ppu.tick
+      end
+      @keypad1.check
+      @keypad2.check
+    end
+
+    private
+
+    # @param [Rnes::Rom] from
+    # @param [Rnes::Ram] to
+    def copy(from:, to:)
+      from.bytesize.times do |address|
+        value = from.read(address)
+        to.write(address, value)
+      end
+    end
+  end
+end

data/lib/rnes/errors.rb

@@ -0,0 +1,46 @@
+module Rnes
+  module Errors
+    class BaseError < ::StandardError
+    end
+
+    class BaseInvalidAddressError < BaseError
+      # @param [Integer] address
+      def initialize(address)
+        @address = address
+        super(to_s)
+      end
+
+      # @return [String]
+      def to_s
+        format('Invalid address: 0x%04X', @address)
+      end
+    end
+
+    class InvalidAddressingModeError < BaseError
+    end
+
+    class InvalidCpuBusAddressError < BaseInvalidAddressError
+    end
+
+    class InvalidInesFormatError < BaseError
+    end
+
+    class InvalidOperationCodeError < BaseError
+    end
+
+    class InvalidOperationError < BaseError
+    end
+
+    class InvalidPpuAddressError < BaseInvalidAddressError
+    end
+
+    class InvalidPpuBusAddressError < BaseInvalidAddressError
+    end
+
+    class ProgramRomNotConnectedError < BaseError
+    end
+
+    class StackPointerOverflowError < BaseError
+    end
+  end
+end

data/lib/rnes/image.rb

@@ -0,0 +1,32 @@
+module Rnes
+  class Image
+    # @return [Integer]
+    attr_reader :height
+
+    # @return [Integer]
+    attr_reader :width
+
+    # @param [Integer] height
+    # @param [Integer] width
+    def initialize(height:, width:)
+      @bytes = Array.new(height * width) do
+        [0, 0, 0]
+      end
+      @height = height
+      @width = width
+    end
+
+    # @param [Integer] x
+    # @param [Integer] y
+    def read(x:, y:)
+      @bytes[@width * y + x]
+    end
+
+    # @param [Array<Integer>] rgb
+    # @param [Integer] x
+    # @param [Integer] y
+    def write(value:, x:, y:)
+      @bytes[@width * y + x] = value
+    end
+  end
+end

data/lib/rnes/ines_header.rb

@@ -0,0 +1,89 @@
+module Rnes
+  class InesHeader
+    BYTESIZE = 16
+
+    PREFIX_BYTES = [
+      0x4E, # N
+      0x45, # E
+      0x53, # S
+      0x1A, # end-of-file in MS-DOS
+    ].freeze
+
+    # @param [Array<Integer>] bytes
+    def initialize(bytes)
+      @bytes = bytes
+    end
+
+    # @return [Integer]
+    def bytesize
+      BYTESIZE
+    end
+
+    # @return [Integer]
+    def character_ram_bytesize
+      @bytes[8]
+    end
+
+    # @return [Integer]
+    def character_rom_bytesize
+      @bytes[5] * 8 * 2**10
+    end
+
+    # @return [Boolean]
+    def has_battery_backed_program_rom_bit?
+      flags1[1] == 1
+    end
+
+    # @return [Boolean]
+    def has_mirror_ignoring_bit?
+      flags1[3] == 1
+    end
+
+    # @note Trainers are 512 bytes of code which is loaded into $7000 before the game starts for hacker use.
+    # @return [Boolean]
+    def has_trainer_bit?
+      flags1[2] == 1
+    end
+
+    # @return [Boolean]
+    def has_vertical_mirroring_bit?
+      flags1[0] == 1
+    end
+
+    # @return [Integer]
+    def mapper_number
+      flags2 & 0b11110000 | flags1 >> 4
+    end
+
+    # @return [Integer]
+    def program_rom_bytesize
+      @bytes[4] * 16 * 2**10
+    end
+
+    # @return [Integer]
+    def trainer_bytesize
+      if has_trainer_bit?
+        512
+      else
+        0
+      end
+    end
+
+    # @return [Boolean]
+    def valid?
+      @bytes[0..3] == PREFIX_BYTES
+    end
+
+    private
+
+    # @return [Integer]
+    def flags1
+      @bytes[6]
+    end
+
+    # @return [Integer]
+    def flags2
+      @bytes[7]
+    end
+  end
+end