rpicsim 0.1.0

data/lib/rpicsim/stack_trace.rb

@@ -0,0 +1,32 @@
+module RPicSim
+  class StackTrace
+    attr_reader :entries
+
+    def initialize(entries = [])
+      @entries = entries
+    end
+
+    def output(io, padding='')
+      @entries.reverse_each do |entry|
+        output_entry(entry, io, padding)
+      end
+    end
+
+    def output_entry(entry, io, padding)
+      io.puts padding + entry.description
+    end
+  end
+
+  class StackTraceEntry
+    attr_reader :address, :description
+
+    def initialize(address, description)
+      @address = address
+      @description = description
+    end
+
+    def to_s
+      description
+    end
+  end
+end

data/lib/rpicsim/variable.rb

@@ -0,0 +1,236 @@
+module RPicSim
+  # This class and its subclasses represent firmware-defined variables
+  # in RAM or flash.
+  #
+  # Instances of this class come in two varieties:
+  # - Unbound variables are just a name and an address.
+  # - Bound variables have a name and an address and they are attached to
+  #   a memory object so you can actually read and write values from them.
+  class Variable
+    module ClassMethods
+      # @return (Integer) The size of this type of variable in memory words.
+      attr_reader :size
+
+      # Specifies the size of this class of variables in memory words.
+      # The units for this are usually bytes for RAM and more than a byte
+      # for flash.  This should be called inside the definition of a subclass of
+      # {Variable}, not from anywhere else.
+      def size_is(size)
+        @size = size
+      end
+    end
+
+    extend ClassMethods
+
+    attr_reader :name, :address
+    attr_writer :memory
+
+    # Creates a new Variable object not bound to any memory yet.
+    # @param name [Symbol] The name of the variable.
+    # @param address [Integer] should be the address of the variable
+    def initialize(name, address)
+      @name = name
+      @address = address
+    end
+
+    # Creates a new Variable that is bound to the specified memory.
+    # @param memory [RPicSim::Memory]
+    def bind(memory)
+      bound_var = dup
+      bound_var.memory = memory
+      bound_var
+    end
+
+    # @return [Range] The addresses of each byte that is part of this variable.
+    def addresses
+      address ... (address + self.class.size)
+    end
+
+    # Reads the value of the variable from memory.
+    # @return [Integer]
+    def value
+      raise NoMethodError, "value not implemented"
+    end
+
+    # Writes to the value to the variable's memory.
+    # @return [Integer]
+    def value=(val)
+      raise NoMethodError, "value= not implemented"
+    end
+
+    def to_s
+      name.to_s
+    end
+
+    def inspect
+      "<%s %s 0x%x>" % [self.class, name, address]
+    end
+    
+    private
+    def check_value(value, allowed_values)
+      if !allowed_values.include?(value)
+        raise ArgumentError, "Invalid value #{value} written to #{name}."
+      end
+    end
+  end
+
+  # Represents an unsigned 8-bit variable.
+  class VariableU8 < Variable
+    size_is 1
+
+    def value
+      @memory.read_word(@address)
+    end
+
+    def value=(val)
+      check_value val, 0..255
+      @memory.write_word(@address, val)
+    end
+
+  end
+
+  # Represents a signed 8-bit variable.
+  class VariableS8 < Variable
+    size_is 1
+
+    def value
+      val = @memory.read_word(@address)
+      val -= 0x100 if val >= 0x80
+      val
+    end
+
+    def value=(val)
+      check_value val, -0x80...0x80
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+    end
+  end
+
+  # Represents an unsigned 16-bit variable.
+  class VariableU16 < Variable
+    size_is 2
+
+    def value
+      @memory.read_word(@address) + 256 * @memory.read_word(@address + 1)
+    end
+
+    def value=(val)
+      check_value val, 0...0x10000
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+    end
+  end
+
+  # Represents a signed 16-bit variable.
+  class VariableS16 < Variable
+    size_is 2
+
+    def value
+      val = @memory.read_word(@address) + 256 * @memory.read_word(@address + 1)
+      val -= 0x10000 if val >= 0x8000
+      val
+    end
+
+    def value=(val)
+      check_value val, -0x8000...0x8000
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+    end
+  end
+
+  # Represents an unsigned 24-bit variable.
+  class VariableU24 < Variable
+    size_is 3
+
+    def value
+      @memory.read_word(@address) + 0x100 * @memory.read_word(@address + 1) +
+        0x10000 * @memory.read_word(@address + 2)
+    end
+
+    def value=(val)
+      check_value val, 0...0x1000000
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+      @memory.write_word(@address + 2, (val >> 16) & 0xFF)
+    end
+  end
+
+  # Represents a signed 24-bit variable.
+  class VariableS24 < Variable
+    size_is 3
+
+    def value
+      val = @memory.read_word(@address) + 0x100 * @memory.read_word(@address + 1) +
+        0x10000 * @memory.read_word(@address + 2)
+      val -= 0x1000000 if val >= 0x800000
+      val
+    end
+
+    def value=(val)
+      check_value val, -0x800000..0x800000
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+      @memory.write_word(@address + 2, (val >> 16) & 0xFF)
+    end
+  end
+
+  # Represents an unsigned 32-bit variable.
+  class VariableU32 < Variable
+    size_is 4
+
+    def value
+      @memory.read_word(@address) + 0x100 * @memory.read_word(@address + 1) +
+        0x10000 * @memory.read_word(@address + 2) +
+        0x1000000 * @memory.read_word(@address + 3)
+    end
+
+    def value=(val)
+      check_value val, 0...0x100000000
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+      @memory.write_word(@address + 2, (val >> 16) & 0xFF)
+      @memory.write_word(@address + 3, (val >> 24) & 0xFF)
+    end
+  end
+
+  # Represents a signed 32-bit variable.
+  class VariableS32 < Variable
+    size_is 4
+
+    def value
+      val = @memory.read_word(@address) + 0x100 * @memory.read_word(@address + 1) +
+        0x10000 * @memory.read_word(@address + 2) +
+        0x1000000 * @memory.read_word(@address + 3) +
+        0x100000000 * @memory.read_word(@address + 4)
+      val -= 0x100000000 if val >= 0x80000000
+      val
+    end
+
+    def value=(val)
+      check_value val, -0x80000000..0x80000000
+      @memory.write_word(@address, val & 0xFF)
+      @memory.write_word(@address + 1, (val >> 8) & 0xFF)
+      @memory.write_word(@address + 2, (val >> 16) & 0xFF)
+      @memory.write_word(@address + 3, (val >> 24) & 0xFF)
+    end
+  end
+
+  # Represents a word-sized variable.
+  # The size of the word will depend on the memory the variable lives in.
+  class VariableWord < Variable
+    size_is 1
+
+    attr_writer :max_value
+
+    def value
+      @memory.read_word(@address)
+    end
+
+    def value=(val)
+      if @max_value
+        check_value val, 0..@max_value
+      end
+      @memory.write_word(@address, val)
+    end
+  end
+end

data/lib/rpicsim/version.rb

@@ -0,0 +1,3 @@
+module RPicSim
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rpicsim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pololu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- Gemfile
+- Introduction.md
+- LICENSE.txt
+- README.md
+- docs/ChangeLog.md
+- docs/Contributing.md
+- docs/Debugging.md
+- docs/DefiningSimulationClass.md
+- docs/DesignDecisions.md
+- docs/HowMPLABXIsFound.md
+- docs/IntegrationTesting.md
+- docs/IntroductionToRSpec.md
+- docs/IntroductionToRuby.md
+- docs/KnownIssues.md
+- docs/Labels.md
+- docs/MakingTestsRunFaster.md
+- docs/Manual.md
+- docs/PersistentExpectations.md
+- docs/Pins.md
+- docs/PreventingCallStackOverflow.md
+- docs/QuickStartGuide.md
+- docs/RSpecIntegration.md
+- docs/RamWatcher.md
+- docs/Running.md
+- docs/SFRs.md
+- docs/Stubbing.md
+- docs/SupportedCompilers.md
+- docs/SupportedDevices.md
+- docs/SupportedMPLABXVersions.md
+- docs/SupportedOperatingSystems.md
+- docs/UnitTesting.md
+- docs/Variables.md
+- lib/rpicsim.rb
+- lib/rpicsim/call_stack_info.rb
+- lib/rpicsim/flaws.rb
+- lib/rpicsim/instruction.rb
+- lib/rpicsim/label.rb
+- lib/rpicsim/memory.rb
+- lib/rpicsim/memory_watcher.rb
+- lib/rpicsim/mplab.rb
+- lib/rpicsim/mplab/mplab_assembly.rb
+- lib/rpicsim/mplab/mplab_device_info.rb
+- lib/rpicsim/mplab/mplab_disassembler.rb
+- lib/rpicsim/mplab/mplab_instruction.rb
+- lib/rpicsim/mplab/mplab_memory.rb
+- lib/rpicsim/mplab/mplab_nmmr_info.rb
+- lib/rpicsim/mplab/mplab_observer.rb
+- lib/rpicsim/mplab/mplab_pin.rb
+- lib/rpicsim/mplab/mplab_processor.rb
+- lib/rpicsim/mplab/mplab_program_file.rb
+- lib/rpicsim/mplab/mplab_register.rb
+- lib/rpicsim/mplab/mplab_sfr_info.rb
+- lib/rpicsim/mplab/mplab_simulator.rb
+- lib/rpicsim/pin.rb
+- lib/rpicsim/program_counter.rb
+- lib/rpicsim/program_file.rb
+- lib/rpicsim/register.rb
+- lib/rpicsim/rspec.rb
+- lib/rpicsim/rspec/be_predicate.rb
+- lib/rpicsim/rspec/helpers.rb
+- lib/rpicsim/rspec/persistent_expectations.rb
+- lib/rpicsim/rspec/sim_diagnostics.rb
+- lib/rpicsim/search.rb
+- lib/rpicsim/sim.rb
+- lib/rpicsim/stack_trace.rb
+- lib/rpicsim/variable.rb
+- lib/rpicsim/version.rb
+homepage: https://github.com/pololu/rpicsim
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2'
+requirements:
+- JRuby
+- MPLAB X
+rubyforge_project:
+rubygems_version: 2.2.1
+signing_key:
+specification_version: 4
+summary: RPicSim provides an interface to the MPLAB X PIC simulator that allows you to write simulator-based automated tests of PIC firmware with Ruby and RSpec.
+test_files: []
+has_rdoc: