rpicsim 0.1.0 → 0.2.1

data/lib/rpicsim/variable_set.rb

@@ -0,0 +1,93 @@
+require_relative 'storage/memory_integer'
+require_relative 'variable'
+
+module RPicSim
+  # This class is used internally by {Sim} to manage user-defined variables.
+  class VariableSet
+    attr_writer :address_increment
+
+    def initialize
+      @memory_types = []
+      @symbols_for_memory = {}
+      @vars_for_memory = {}
+      @vars_for_memory_by_address = {}
+    end
+
+    def def_memory_type(name, symbols)
+      name = name.to_sym
+      @memory_types << name
+      @symbols_for_memory[name] = symbols
+      @vars_for_memory[name] = {}
+      @vars_for_memory_by_address[name] = {}
+    end
+
+    def def_var(name, type, opts={})
+      allowed_keys = [:memory, :symbol, :address]
+      invalid_keys = opts.keys - allowed_keys
+      if !invalid_keys.empty?
+        raise ArgumentError, "Unrecognized options: #{invalid_keys.join(', ')}"
+      end
+
+      name = name.to_sym
+
+      memory_type = opts.fetch(:memory, :ram)
+      if !@memory_types.include?(memory_type)
+        raise "Invalid memory type '#{memory_type.inspect}'."
+      end
+
+      symbol_addresses = @symbols_for_memory[memory_type]
+
+      if opts[:address]
+        address = opts[:address].to_i
+      else
+        symbol = (opts[:symbol] || name).to_sym
+        if symbol.to_s.include?('@')
+          raise 'Limitations in MPLAB X code prevent us from accessing ' +
+            "variables with '@' in the name like '#{symbol}'"
+        end
+        address = symbol_addresses[symbol] or raise ArgumentError, "Cannot find variable in #{memory_type} named '#{symbol}'."
+      end
+
+      klass = case type
+              when Class then type
+              when :word then Storage::MemoryWord
+              when :uint8 then Storage::MemoryUInt8
+              when :int8 then Storage::MemoryInt8
+              when :uint16 then Storage::MemoryUInt16
+              when :int16 then Storage::MemoryInt16
+              when :uint24 then Storage::MemoryUInt24
+              when :int24 then Storage::MemoryInt24
+              when :uint32 then Storage::MemoryUInt32
+              when :int32 then Storage::MemoryInt32
+              else raise ArgumentError, "Unknown type '#{type}'."
+              end
+
+      variable = klass.new(name, address)
+
+      if variable.is_a?(Storage::MemoryWord) && memory_type == :program_memory
+        variable.size = @address_increment
+      end
+
+      vars_by_address = @vars_for_memory_by_address[memory_type]
+      variable.addresses.each do |address|
+        if vars_by_address[address]
+          raise 'Variable %s overlaps with %s at 0x%x' %
+            [variable, @vars_by_address[address], address]
+        end
+        vars_by_address[address] = variable
+      end
+
+      @vars_for_memory[memory_type][name] = variable
+    end
+
+    def bind(memories)
+      vars = {}
+      memories.each do |memory_type, memory|
+        @vars_for_memory[memory_type].each do |name, unbound_var|
+          vars[name] = Variable.new(unbound_var.bind(memory))
+        end
+      end
+      vars
+    end
+  end
+end

data/lib/rpicsim/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpicsim
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Pololu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -34,6 +34,7 @@ files:
 - docs/Labels.md
 - docs/MakingTestsRunFaster.md
 - docs/Manual.md
+- docs/Memories.md
 - docs/PersistentExpectations.md
 - docs/Pins.md
 - docs/PreventingCallStackOverflow.md
@@ -41,7 +42,6 @@ files:
 - docs/RSpecIntegration.md
 - docs/RamWatcher.md
 - docs/Running.md
-- docs/SFRs.md
 - docs/Stubbing.md
 - docs/SupportedCompilers.md
 - docs/SupportedDevices.md
@@ -51,6 +51,7 @@ files:
 - docs/Variables.md
 - lib/rpicsim.rb
 - lib/rpicsim/call_stack_info.rb
+- lib/rpicsim/composite_memory.rb
 - lib/rpicsim/flaws.rb
 - lib/rpicsim/instruction.rb
 - lib/rpicsim/label.rb
@@ -61,6 +62,7 @@ files:
 - lib/rpicsim/mplab/mplab_device_info.rb
 - lib/rpicsim/mplab/mplab_disassembler.rb
 - lib/rpicsim/mplab/mplab_instruction.rb
+- lib/rpicsim/mplab/mplab_loader.rb
 - lib/rpicsim/mplab/mplab_memory.rb
 - lib/rpicsim/mplab/mplab_nmmr_info.rb
 - lib/rpicsim/mplab/mplab_observer.rb
@@ -73,7 +75,6 @@ files:
 - 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
@@ -81,8 +82,12 @@ files:
 - lib/rpicsim/rspec/sim_diagnostics.rb
 - lib/rpicsim/search.rb
 - lib/rpicsim/sim.rb
+- lib/rpicsim/stack_pointer.rb
 - lib/rpicsim/stack_trace.rb
+- lib/rpicsim/storage/memory_integer.rb
+- lib/rpicsim/storage/register.rb
 - lib/rpicsim/variable.rb
+- lib/rpicsim/variable_set.rb
 - lib/rpicsim/version.rb
 homepage: https://github.com/pololu/rpicsim
 licenses:

data/docs/SFRs.md

@@ -1,71 +0,0 @@
-SFRs
-====
-
-The Special Function Registers (SFRs) on a microcontroller enable the firmware to interact with the microcontroller's peripherals and talk to the outside world.
-RPicSim supports reading and writing these SFRs from Ruby.
-This can be useful if you want to put your PIC into a particular state and see how a part of your firmware responds.
-Each SFR is represented as an instance of the {RPicSim::Register} class.
-
-
-Getting a Register object
-----
-
-The {RPicSim::Sim#sfr} method can be called on your simulation object to retrieve a {RPicSim::Register} object:
-
-    !!!ruby
-    sim.sfr(:LATA)  # => returns a Register object
-
-If you are using RPicSim's {file:RSpecIntegration.md RSpec integration}, the `sfr` method inside an example automatically redirects to the `@sim` object:
-
-    !!!ruby
-    it "works" do
-      sfr(:LATA)  # => returns a Register object
-    end
-
-The first argument of {RPicSim::Sim#sfr} should be a symbol containing the name of the SFR.
-The name comes from the MPLAB X code, but it should match the name given in the microcontroller's datasheet.
-
-
-Using a register
-----
-
-Once you have obtained the {RPicSim::Register Register} object using one of the methods above, you can read and write the value of the SFR using the `value` attribute:
-
-    !!!ruby
-    sfr(:LATA).value = 0x7B
-    expect(sfr(:LATA).value).to eq 0x7B
-
-
-Protected bits
-----
-
-When you write to the register with {RPicSim::Register#value=}, you are probably writing to it in the same way that the simulated microcontroller would write to it.
-This means that some bits might not be writable or might have restrictions on what value can be written to them.
-For example, the TO and PD bits of the STATUS register on the PIC10F322 are not writable by the microcontroller.
-
-To get around this, you can use {RPicSim::Register#memory_value=} instead, which should allow you to write to any of the bits.
-
-
-Peripheral updating
-----
-
-The MPLAB X code contains various objects that simulate the peripherals on a chip, such as the ADC.
-It has not been determined whether writing to SFRs using the {RPicSim::Register} object updates the simulation of those peripherals in the proper way.
-Also, whether the peripherals get updated might depend on whether the `value` or the `memory_value` attribute is used for writing.
-
-
-Non-memory-mapped registers
-----
-
-The MPLAB X code considers "SFRs" to only be the special registers that have an address in memory.
-The special registers without a memory address are called Non-Memory-Mapped Registers (NMMRs).
-To access these registers, you can use {RPicSim::Sim#nmmr} which is similar to {RPicSim::Sim#sfr}.
-
-On some chips, WREG and STKPTR are SFRs and on other chips they are NMMRs.  To make it easier to access these two registers, RPicSim provides the methods {RPicSim::Sim#wreg} and {RPicSim::Sim#stkptr}.  Those methods can be called directly in RSpec examples thanks to RPicSim's {file:RSpecIntegration.md RSpec integration}:
-
-    !!!ruby
-    it "sets W to 5" do
-      expect(wreg.value).to eq 5
-    end
-
-To access other registers without worrying about what type they are, you can use {RPicSim::Sim#sfr_or_nmmr}.