mos6502 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0f60d69f4e61e6400589a302cab4ab6a5c8f3052a302a789b1be82504cd0229
+  data.tar.gz: 022bfe7359508151fc2c0bb3264f0ae3b7b92983480c6ba1bb663975ddd9b14a
+SHA512:
+  metadata.gz: 5509c6b51da8016c38a3bbadd87763b6532d6e9c4cf6283b78392e6fb08c6c876533a793a3af923ad084e179f0936cfa03b88879947e0abfc9e16a71c231a57c
+  data.tar.gz: e684259a02e6826bafb12e994176dd10feee2f1ea9e2d5f9cf05e07c9ea0ddbfad13c6fa3427cc341103c4609e4ff3c847c16bbb2ee9f246f456adf8da802faf

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+
+.ruby-version
+.ruby-gemset
+
+Gemfile.lock

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/suites/klaus2m5/6502_65C02_functional_tests"]
+	path = test/suites/klaus2m5/6502_65C02_functional_tests
+	url = https://github.com/klaus2m5/6502_65C02_functional_tests

data/.rubocop.yml

@@ -0,0 +1,71 @@
+require: rubocop-performance
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+# Set a slightly bigger default, and ignore ABC failures in the tests.
+# Also ignore in the CPU instructions files, which are unavoidably big.
+Metrics/AbcSize:
+  Max: 25
+  Exclude:
+    - 'lib/mos6502/cpu_instructions.rb'
+    - 'lib/mos6502/cpu_ops.rb'
+    - 'test/**/*.rb'
+
+# Ignore block length failures in the tests.
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Ignore class length failures in the tests.
+# Also ignore in the CPU instructions files, which are unavoidably big.
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/mos6502/cpu_instructions.rb'
+    - 'lib/mos6502/cpu_ops.rb'
+    - 'test/**/*.rb'
+
+# Set a slightly higher default for this.
+# Also ignore the CPU instructions file, which looks complex to this sort
+# of tool, but isn't really.
+Metrics/CyclomaticComplexity:
+  Max: 10
+  Exclude:
+    - 'lib/mos6502/cpu_instructions.rb'
+
+# Ignore method length failures in the tests.
+# Also ignore in the CPU instructions files, which are unavoidably big.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/mos6502/cpu_instructions.rb'
+    - 'lib/mos6502/cpu_ops.rb'
+    - 'test/**/*.rb'
+
+# Ignore module length failures in the tests.
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Ignore parameter list lengths in the tests.
+Metrics/ParameterLists:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Set a slightly higher default for this.
+# Also ignore the CPU instructions file, which looks complex to this sort
+# of tool, but isn't really.
+Metrics/PerceivedComplexity:
+  Max: 10
+  Exclude:
+    - 'lib/mos6502/cpu_instructions.rb'
+
+# Allow compact child definitions in the tests for brevity.
+Style/ClassAndModuleChildren:
+  Exclude:
+    - test/**/*.rb
+
+# Just allow simple formatting rules. We're not doing anything complex.
+Style/FormatStringToken:
+  EnforcedStyle: unannotated

data/.rubocop_todo.yml

@@ -0,0 +1,19 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-10-08 16:36:35 UTC using RuboCop version 0.93.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'mos6502.gemspec'
+
+# Sort this out later :-s.
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,28 @@
+---
+dist: bionic
+language: ruby
+
+cache: bundler
+
+before_install: gem install bundler -v 2.1.2
+
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+
+env:
+  - MOS6502_KLAUS2M5=on
+
+matrix:
+  fast_finish: true
+  include:
+    - name: Rubocop
+      rvm: 2.4
+      script:
+      - bundle info rubocop
+      - bundle exec rubocop
+  allow_failures:
+    - rvm: ruby-head

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rhaines@manchester.ac.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE

@@ -0,0 +1,26 @@
+MOS 6502 is released under the BSD licence.
+
+Copyright (c) 2020, Robert Haines
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the OpenMPT project nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,119 @@
+# Ruby MOS 6502
+
+A ruby implementation of the [MOS Technology 6502 microprocessor][wp-6502].
+
+![Image of a MOS Technology 6502 microprocessor (from Wikipedia)](https://upload.wikimedia.org/wikipedia/commons/4/49/MOS_6502AD_4585_top.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mos6502'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mos6502
+
+## Usage
+
+The entry point to this library is `Mos6502::Cpu`. You can create a new `Cpu` with the program counter (PC) set to a specific memory address as follows:
+
+```ruby
+cpu = Mos6502::Cpu.new(initial_pc: 0x400)
+```
+
+You can load a snippet of code like this:
+
+```ruby
+cpu.load!([0xa9, 0x33, 0x69, 0x55])
+```
+
+`Cpu#load!` also resets the CPU; all memory is cleared first, then the registers are set to zero, the PC is returned to its initial value, the stack pointer (SP) is reset to `0xff` and the status bits are set to their defaults.
+
+There is no assembler (yet?). The above code is:
+
+```
+LDA #$33 ; load immediate
+ADC #$55 ; add with carry
+```
+
+It will load the hex value `0x33` (51) into the accumulator and add the hex value `0x55` (85) to it and store the result back in the accumulator.
+
+To run the next instruction, call `Cpu#step`. The PC will be advanced to point to the next instruction. To run the above code, which is just two instructions, use:
+
+```ruby
+cpu.step
+cpu.step
+```
+
+You can then inspect the current state of the CPU with:
+
+```ruby
+puts cpu.inspect
+
+# a: 0x88, x: 0x00, y: 0x00, sp: 0xff, pc: 0x0404, op: 0x00, status: 0b11110000
+```
+
+You can see here that the accumulator (`a`) holds the result of `0x33` + `0x55` = `0x88` and that the PC has moved on 4 places to `0x404`. You can also see from the status bits that the result is negative in two's complement (bit 7) and that overflow has occurred (bit 6).
+
+For more complex code, you will need to load in an assembled image:
+
+```ruby
+image = File.read(IMAGE_PATH)
+cpu.load_image!(image, 0x400)
+```
+
+You will need to know the entry point, and set the initial PC when initializing the `Cpu` upfront. The above example loads the image at memory location 1024. `Cpu#load_image!` will reset the CPU in the same way as `Cpu#load!` above. If you need to load an image in parts (e.g. assembled code and data) you can use `Cpu#load_image`, which is non-destructive.
+
+There is loads more information on the 6502, and how to program it here:
+
+* [Obelisk][obelisk]
+* [6502.org][6502org]
+* [Visual 6502][vis6502]
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### 6502 test suites
+
+This repository includes external test suites to more comprehensively test all the features of the 6502 microprocessor. They are not run by default because they can take a few minutes to complete, but can be turned on with environment variables passed into `rake`. Once this code supports all of a test suite's features it will be run by default in CI.
+
+#### Klaus Dormann's test suite
+
+This is included as a submodule. Once you've initialized it you can run it as part of the normal test suite with:
+
+```shell
+MOS6502_KLAUS2M5=on rake
+```
+
+If you want to see a full debug stream of it running, use `MOS6502_KLAUS2M5=debug` instead.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hainesr/mos6502.
+
+
+## Code of Conduct
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct][coc].
+
+Everyone interacting in the MOS 6502 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
+
+## Licence
+
+Copyright (c) 2020, Robert Haines.
+
+Released under the BSD Licence. See LICENCE for details.
+
+[wp-6502]: https://en.wikipedia.org/wiki/MOS_Technology_6502
+[coc]: https://github.com/hainesr/mos6502/blob/master/CODE_OF_CONDUCT.md
+[obelisk]: http://www.obelisk.me.uk/6502/
+[6502org]: http://www.6502.org/
+[vis6502]: http://www.visual6502.org/

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020, Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mos6502'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/mos6502.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020, Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+require_relative 'mos6502/version'
+require_relative 'mos6502/cpu'

data/lib/mos6502/cpu.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020, Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+require 'forwardable'
+
+require_relative 'cpu_flags'
+require_relative 'cpu_instructions'
+require_relative 'memory'
+
+module Mos6502
+  class Cpu
+    extend Forwardable
+
+    attr_reader :a, :pc, :sp, :x, :y
+
+    def_delegators :@status, :break?, :carry?, :decimal_mode?,
+                   :interupt_disable?, :negative?, :overflow?, :zero?
+
+    def initialize(initial_pc: 0x600, code: nil)
+      @initial_pc = initial_pc
+      @status = CpuFlags.new
+      load!(code)
+      @instructions = instructions
+    end
+
+    def step
+      inst = next_byte
+      @instructions[inst].call
+    end
+
+    def load!(code = nil)
+      reset!
+      return if code.nil?
+
+      loc = @pc
+      code = code.bytes if code.respond_to?(:bytes)
+      code.each do |b|
+        @memory.set(loc, b)
+        loc += 1
+      end
+    end
+
+    def load_image(image = nil, start = 0)
+      return if image.nil?
+
+      @memory.load(image, start)
+    end
+
+    def load_image!(image = nil, start = 0)
+      reset!
+      load_image(image, start)
+    end
+
+    def dump_memory(start, length)
+      @memory.dump(start, length)
+    end
+
+    def inspect
+      format(
+        'a: 0x%02x, x: 0x%02x, y: 0x%02x, sp: 0x%02x, ' \
+        'pc: 0x%04x, op: 0x%02x, status: 0b%08b',
+        @a, @x, @y, @sp, @pc, @memory.get(@pc), @status.encode
+      )
+    end
+
+    private
+
+    # Stack access.
+    def stack_push(value)
+      @memory.set((@sp & 0xff) + 0x0100, value)
+
+      # Decrement the stack pointer, and wrap it if it goes below 0.
+      @sp -= 1
+      @sp = @sp &= 0xff if @sp < 0 # rubocop:disable Style/NumericPredicate
+    end
+
+    def stack_pop
+      # Increment the stack pointer, and wrap it if it goes above 255.
+      @sp += 1
+      @sp = @sp &= 0xff if @sp > 0xff
+
+      @memory.get((@sp & 0xff) + 0x0100)
+    end
+
+    # Program access.
+    def next_byte
+      pc = @pc
+      @pc += 1
+      @memory.get(pc)
+    end
+
+    def next_word
+      pc = @pc
+      @pc += 2
+      @memory.get_word(pc)
+    end
+
+    # Memory access.
+    def zero_page(register = 0)
+      (next_byte + register) & 0xff
+    end
+
+    def absolute(register = 0)
+      (next_word + register)
+    end
+
+    def indirect
+      @memory.get_word(next_word)
+    end
+
+    def indexed_indirect
+      @memory.get_word(zero_page(@x))
+    end
+
+    def indirect_indexed
+      @memory.get_word(next_byte) + @y
+    end
+
+    # Status access.
+    def set_nz_flags(value) # rubocop:disable Naming/AccessorMethodName
+      @status.zero = value.zero?
+      @status.negative = value & 0x80
+    end
+
+    def set_carry(value, bit)
+      @status.carry = (value >> bit) & 1
+    end
+
+    # Reset!
+    def reset!
+      @memory = Memory.new
+      @pc = @initial_pc
+      @sp = 0xff
+      @a = 0x00
+      @x = 0x00
+      @y = 0x00
+      @status.reset!
+    end
+  end
+end