rpicsim 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 360adb3e53d15c48aed0e03a171f1225da93b449
-  data.tar.gz: 6cb9ef3afd2aa5ae18921e4f8ffc7d68b2ed03bc
+  metadata.gz: afe68ca6fbd8c66eefc707b4927bbb453d2e37ef
+  data.tar.gz: fe03453f4ef52094c9f4bc7ec792c146ac1828a4
 SHA512:
-  metadata.gz: 7563dced8a0e911600556d60da82723c3162f766a11aa68efa2a23c6f369258a5a51d1d76458f2b7d57aad740cb72ba929ceb5b4555006b90e29047d89e93e94
-  data.tar.gz: f2ee852bed01b1858ff873509f4a6209b4022e258295d04a96e5b540ac07338254b3ed34aa24720d5f3028c1481b92c587ace0c4ae0d0782787c0fc5c5f03dc8
+  metadata.gz: e87d3ca4fbd555c4de565aaef804caf1214bb75cf0d742fd48ac0a2bedbca23dc974937e2ef731fd015b469a1d93c947345fa0c8b0bc3392606e16766ef65eb8
+  data.tar.gz: 5d07e1d1f9cf043b908477eba77f668205ea2460ff6df5e1484dd8e1743945c3533d0b31ca9f0c0dd4ec8e373e141d7a0ede172488cd7a1265e768b15190e67b

data/Gemfile

@@ -4,7 +4,7 @@ group :development do
   gem 'rspec'
   gem 'rake'
   gem 'simplecov'
-  gem 'deg-yard'  # My little fork of the yard gem that has some bug fixes.
+  gem 'yard'
   gem 'guard'
   gem 'guard-rspec'
   gem 'rubocop', '0.18.1'  # They made breaking changes in 0.19.x so let's not update yet.

data/docs/ChangeLog.md

@@ -1,6 +1,14 @@
 Change log
 ====
 
+0.2.5
+----
+Released on 2014-05-02.
+
+- {RPicSim::Sim#stack_push} and {RPicSim::Sim#return} now update the TOSU, TOSH, and TOSL registers if they exist.
+  This fixes bugs that were happening when using those methods in PIC18 simulations.
+- Added recognition for more types of symbols found in XC8-generated COF files, but there are still issues with proper identification of variables in programs compiled with XC8.
+
 0.2.4
 ----
 Released on 2014-03-17.

data/docs/KnownIssues.md

@@ -191,3 +191,9 @@ These issues might affect other PIC architectures as well.
 
 These issues are tested in `spec/integration/adc_midrange_spec.rb`.  The bad modulus issue was {http://www.microchip.com/forums/m760886.aspx reported to Microchip} in November 2013.
 
+
+Variables from XC8 are not correctly identified
+----
+
+RAM variables in programs using the XC8 compiler are often misidentified as being in program memory, and you need to get their address using {RPicSim::ProgramFile#symbols_in_program_memory}.
+Some variables are not be identified at all, and you would have to write code to get their addresses from the SYM file.

data/lib/rpicsim/call_stack_info.rb

@@ -70,11 +70,12 @@ module RPicSim
     end
 
     private
+
     def generate
       @max_depths = { @root => 0 }
       @back_links = Hash.new { [] }
       instructions_to_process = [root]
-      while !instructions_to_process.empty?
+      until instructions_to_process.empty?
         instruction = instructions_to_process.pop
         instruction.transitions.reverse_each do |transition|
           ni = transition.next_instruction
@@ -97,6 +98,7 @@ module RPicSim
         end
       end
     end
+
     public
 
     # Returns all the {Instruction}s that have the worse case possible call stack depth.
@@ -161,8 +163,8 @@ module RPicSim
 
       # For each instruction that has a code path leading to it, pick out
       # the shortest code path (in terms of interesting instructions).
-      code_paths = code_paths.group_by { |cp| cp.instructions.last }.map do |instr, code_paths|
-        code_paths.min_by { |cp| cp.interesting_instructions.count }
+      code_paths = code_paths.group_by { |cp| cp.instructions.last }.map do |instr, paths|
+        paths.min_by { |cp| cp.interesting_instructions.count }
       end
 
       code_paths
@@ -297,6 +299,5 @@ module RPicSim
           interesting_instructions.join("\n") + "\n"
       end
     end
-
   end
 end

data/lib/rpicsim/composite_memory.rb

@@ -35,7 +35,7 @@ module RPicSim
     end
 
     def valid_address?(address)
-      find_memory(address) != nil
+      !find_memory(address).nil?
     end
 
     private

data/lib/rpicsim/flaws.rb

@@ -83,6 +83,5 @@ module RPicSim
       flaw.affects_version '2.05', false
       flaw.probably_affects_other_versions :false
     end
-
   end
 end

data/lib/rpicsim/instruction.rb

@@ -206,9 +206,10 @@ module RPicSim
     end
 
     private
+
     # For certain opcodes, this method gets over-written.
     def generate_transitions
-      [ advance(1) ]
+      [advance(1)]
     end
 
     # Makes a transition representing the default behavior: the microcontroller
@@ -217,7 +218,7 @@ module RPicSim
       transition(address + num * size)
     end
 
-    def transition(addr, attrs={})
+    def transition(addr, attrs = {})
       Transition.new(self, addr, @instruction_store, attrs)
     end
 
@@ -260,7 +261,7 @@ module RPicSim
     module Goto
       def generate_transitions
         # Assumption: The GOTO instruction's k operand is absolute on all architectures
-        [ transition(k_address, non_local: true) ]
+        [transition(k_address, non_local: true)]
       end
     end
 
@@ -269,7 +270,7 @@ module RPicSim
     # skipped depending on some condition.
     module ConditionalSkip
       def generate_transitions
-        [ advance(1), advance(2) ]
+        [advance(1), advance(2)]
       end
     end
 
@@ -284,25 +285,25 @@ module RPicSim
     # This module is mixed into any {Instruction} that represents a subroutine call.
     module Call
       def generate_transitions
-        [ transition(k_address, call_depth_change: 1), advance(1) ]
+        [transition(k_address, call_depth_change: 1), advance(1)]
       end
     end
 
     module RelativeCall
       def generate_transitions
-        [ transition(n_address, call_depth_change: 1), advance(1) ]
+        [transition(n_address, call_depth_change: 1), advance(1)]
       end
     end
 
     module ConditionalRelativeBranch
       def generate_transitions
-        [ transition(n_address, non_local: true), advance(1) ]
+        [transition(n_address, non_local: true), advance(1)]
       end
     end
 
     module RelativeBranch
       def generate_transitions
-        [ transition(relative_target_address, non_local: true) ]
+        [transition(relative_target_address, non_local: true)]
       end
     end
 
@@ -328,7 +329,6 @@ module RPicSim
       def call_depth_change
         @attrs.fetch(:call_depth_change, 0)
       end
-
     end
   end
 end

data/lib/rpicsim/memory.rb

@@ -45,6 +45,5 @@ module RPicSim
     def valid_address?(address)
       @mplab_memory.valid_address?(address)
     end
-
   end
 end

data/lib/rpicsim/memory_watcher.rb

@@ -72,6 +72,7 @@ module RPicSim
     end
 
     private
+
     def remove_vars(vars, var_names_to_remove)
       vars.reject! do |key, val|
         name = key.is_a?(Integer) ? key : key.name
@@ -85,6 +86,5 @@ module RPicSim
 
       [:PCL, :PCLATH, :STATUS]
     end
-
   end
 end

data/lib/rpicsim/mplab/mplab_assembly.rb

@@ -64,6 +64,7 @@ module RPicSim::Mplab
     end
 
     private
+
     # Gets a com.microchip.mplab.mdbcore.debugger.Debugger object.
     def debugger
       lookup Mdbcore.debugger.Debugger.java_class
@@ -102,6 +103,5 @@ module RPicSim::Mplab
         $stderr.puts "warning: MPLAB X will be looking for files at a bad path: #{path}"
       end
     end
-
   end
 end

data/lib/rpicsim/mplab/mplab_instruction.rb

@@ -98,6 +98,5 @@ module RPicSim::Mplab
         unsigned
       end
     end
-
   end
 end

data/lib/rpicsim/mplab/mplab_loader.rb

@@ -90,7 +90,7 @@ module RPicSim::Mplab
     end
 
     def cannot_find_mplab_error
-      'Cannot find MPLABX.  Install it in the standard location or ' +
+      'Cannot find MPLABX.  Install it in the standard location or ' \
       'set the RPICSIM_MPLABX environment variable to its full path.'
     end
 

data/lib/rpicsim/mplab/mplab_memory.rb

@@ -37,7 +37,7 @@ module RPicSim::Mplab
       MplabObserver.new(@memory) do |event|
         next if event.EventType != Mdbcore.memory::MemoryEvent::EVENTS::MEMORY_CHANGED
         address_ranges = event.AffectedAddresses.map do |mr|
-          mr.Address...(mr.Address+mr.Size)
+          mr.Address...(mr.Address + mr.Size)
         end
         yield address_ranges
       end

data/lib/rpicsim/mplab/mplab_program_file.rb

@@ -7,7 +7,7 @@ module RPicSim::Mplab
       raise "File does not exist: #{filename}" if !File.exist?(filename)  # Avoid a Java exception.
 
       if !File.realdirpath(filename).split('/').include?('dist')
-        raise 'The file must be inside a directory named dist or else the MCLoader ' +
+        raise 'The file must be inside a directory named dist or else the MCLoader ' \
               'class will throw an exception saying that it cannot find the COF file.'
       end
 
@@ -56,22 +56,29 @@ module RPicSim::Mplab
     # 22        MPASM program memory or EEPROM
     # 40        XC8 local variable (pointer to a struct?)
     # 44        XC8 local variable
+    # 64        XC8 program memory function
     # 65        XC8 program memory function
+    # 66        XC8 program memory function
+    # 69        XC8 program memory function
     # 76        XC8 program memory function
+    # 78        XC8 program memory function
+    # 79        XC8 program memory function
+    # 81        XC8 program memory function
+    # 82        XC8 program memory function
+    # 104       XC8 program memory variable (array of unions) (but sometimes in RAM instead)
     # 108       XC8 program memory variable (array)
-    # 110       XC8 program memory variable (struct)
+    # 110       XC8 program memory variable (struct) (but sometimes in RAM instead)
+    # 111       XC8 program memory variable (array of uint32_t) (but sometimes it is in RAM instead)
     # 366       XC8 program memory variable (array of pointers)
     #
     # TODO: make a test for each of these cases; TestXC8.c and program_file_spec.rb only only has a few
     def memory_type(symbol)
       case symbol.m_lType
-      when 0, 2, 8, 12
+      when 0, 2, 8, 12, 40, 44, 108
         :ram
       when 22
         EepromRange.include?(symbol.address) ? :eeprom : :program_memory
-      when 12, 40, 44, 108
-        :ram
-      when 14, 65, 76, 110, 366
+      when 14, 64, 65, 66, 69, 76, 78, 79, 81, 82, 104, 110, 111, 366
         :program_memory
       else
         :unknown
@@ -80,7 +87,7 @@ module RPicSim::Mplab
 
     # Useful for debugging.
     # Just put this line in your simulation class definition temporarily:
-    # pp program_file.instance_variable_get(:@mplab_program_file).send(:symbol_dump)
+    # pp program_file.instance_variable_get(:@mplab_program_file).send(:symbol_dump).sort
     def symbol_dump
       symbols.map { |s| [s.m_Symbol, s.m_lType, s.address, memory_type(s)] }
     end

data/lib/rpicsim/program_counter.rb

@@ -1,5 +1,4 @@
 module RPicSim
-
   # Instances of this class represent the program counter in a
   # simulated microcontroller.
   class ProgramCounter

data/lib/rpicsim/program_file.rb

@@ -2,6 +2,10 @@ require_relative 'mplab'
 require_relative 'label'
 require_relative 'instruction'
 
+# TODO: interface for adding labels and/or symbols from other sources because
+# sometimes the COF file is inadequate.  When symbols have the same address,
+# think about how to choose the more interesting one in a stack trace (fewer underscores?)
+
 module RPicSim
   # Represents a PIC program file (e.g. COF or HEX).
   class ProgramFile
@@ -97,6 +101,7 @@ module RPicSim
     end
 
     private
+
     def message_for_label_not_found(name)
       message = "Cannot find label named '#{name}'."
 

data/lib/rpicsim/rspec/helpers.rb

@@ -42,7 +42,6 @@ module RPicSim
           raise "Invalid sim_shortcuts configuration value: #{configuration_value.inspect}"
         end
       end
-
     end
   end
 end

data/lib/rpicsim/search.rb

@@ -10,7 +10,7 @@ module RPicSim
     # graph backwards in order to find code_paths for a given instruction.
     def self.depth_first_search_simple(root_nodes)
       unprocessed_nodes = root_nodes.reverse
-      while !unprocessed_nodes.empty?
+      until unprocessed_nodes.empty?
         node = unprocessed_nodes.pop
         nodes = yield node
         unprocessed_nodes.concat(nodes.reverse)

data/lib/rpicsim/sim.rb

@@ -19,10 +19,8 @@ module RPicSim
   # This class keeps track of the state of the simulation and provides methods for
   # running the simulation, reading the state, and changing the state.
   class Sim
-
     # These methods should be called while defining a subclass of {Sim}.
     module ClassDefinitionMethods
-
       # Specifies what exact device the firmware runs on.
       # @param device [String] The device name, for example "PIC10F322".
       def use_device(device)
@@ -72,7 +70,7 @@ module RPicSim
       #     firmware and call it a different thing in your tests.
       #     This option is ignored if +:address is specified.
       #   * +:address+: An integer to use as the address of the variable.
-      def def_var(name, type, opts={})
+      def def_var(name, type, opts = {})
         if @variable_set.nil?
           raise 'The device and filename need to be specified before defining variables.'
         end
@@ -81,7 +79,6 @@ module RPicSim
 
         self::Shortcuts.send(:define_method, name) { var name }
       end
-
     end
 
     # These are class methods that you can call on subclasses of {Sim}.
@@ -108,6 +105,7 @@ module RPicSim
       attr_reader :program_file
 
       private
+
       # This gets called when a new subclass of PicSim is created.
       def inherited(subclass)
         subclass.instance_eval do
@@ -127,7 +125,6 @@ module RPicSim
         @variable_set.def_memory_type :program_memory, program_file.symbols_in_program_memory
         @variable_set.def_memory_type :eeprom, program_file.symbols_in_eeprom
       end
-
     end
 
     # This module is used in RPicSim's {file:RSpecIntegration.md RSpec integration}
@@ -217,11 +214,15 @@ module RPicSim
 
     # Returns a string like "PIC10F322" specifying the PIC device number.
     # @return [String]
-    def device; self.class.device; end
+    def device
+      self.class.device
+    end
 
     # Returns the path to the firmware file.
     # @return [String]
-    def filename; self.class.filename; end
+    def filename
+      self.class.filename
+    end
 
     # Makes a new simulation using the settings specified when the class was defined.
     def initialize
@@ -392,7 +393,7 @@ module RPicSim
     #    This option is a more powerful version of +cycle_limit+, so it cannot
     #    be used at the same time as +cycle_limit+.
     # @return The condition that was met which caused the run to stop.
-    def run_to(conditions, opts={})
+    def run_to(conditions, opts = {})
       conditions = Array(conditions)
       if conditions.empty?
         raise ArgumentError, 'Must specify at least one condition.'
@@ -420,8 +421,8 @@ module RPicSim
         max_cycle = start_cycle + opts[:cycle_limit] if opts[:cycle_limit]
       end
 
-      # Loop as long as none of the conditions are satisfied.
-      while !(met_condition_index = condition_procs.find_index(&:call))
+      # Loop until one of the conditions is satisfied.
+      until (met_condition_index = condition_procs.find_index(&:call))
         if max_cycle && cycle_count >= max_cycle
           raise "Failed to reach #{conditions.inspect} after #{cycle_count - start_cycle} cycles."
         end
@@ -476,7 +477,7 @@ module RPicSim
     #   generally point to a subroutine in program memory that will end by
     #   executing a return instructions.
     # @param opts Any of the options supported by {#run_to}.
-    def run_subroutine(location, opts={})
+    def run_subroutine(location, opts = {})
       stack_push pc.value
       goto location
       run_to :return, opts
@@ -509,6 +510,7 @@ module RPicSim
       # Simulate popping the stack.
       stack_pointer.value -= 1
       pc.value = @stack_memory.read_word(stack_pointer.value)
+      update_top_of_stack_registers
     end
 
     # Generates a friendly human-readable string description of where the
@@ -525,6 +527,7 @@ module RPicSim
 
       @stack_memory.write_word(stack_pointer.value, value)
       stack_pointer.value += 1
+      update_top_of_stack_registers
     end
 
     # Gets the contents of the stack as an array of integers.
@@ -553,6 +556,26 @@ module RPicSim
       StackTrace.new(entries)
     end
 
+    private
+
+    # Update the TOSU:TOSH:TOSL registers because the simulator uses those
+    # (if they exist) when simulating a return instruction.
+    def update_top_of_stack_registers
+      return unless @sfrs.key?(:TOSL)
+
+      tos = if stack_pointer.value == 0
+              0
+            else
+              @stack_memory.read_word(stack_pointer.value - 1)
+            end
+
+      reg(:TOSL).value = tos >> 0 & 0xFF
+      reg(:TOSH).value = tos >> 8 & 0xFF
+      reg(:TOSU).value = tos >> 16 & 0xFF if @sfrs.key?(:TOSU)
+    end
+
+    public
+
     def inspect
       "#<#{self.class}:0x%x, #{pc_description}, stack_pointer = #{stack_pointer.value}>" % object_id
     end
@@ -579,7 +602,7 @@ module RPicSim
         c
 
       when Integer
-        Proc.new { pc.value == c }
+        proc { pc.value == c }
 
       when :return
         current_val = stack_pointer.value
@@ -588,7 +611,7 @@ module RPicSim
         else
           target_val = current_val - 1
         end
-        Proc.new { stack_pointer.value == target_val }
+        proc { stack_pointer.value == target_val }
 
       when Label
         convert_condition_to_proc c.address
@@ -619,6 +642,7 @@ module RPicSim
     end
 
     private
+
     def ram_vars
       ram_var_names = self.class.variable_set.var_names_for_memory(:ram)
       @vars.values_at(*ram_var_names)
@@ -632,5 +656,4 @@ module RPicSim
       @assembly.device_info.code_address_increment
     end
   end
-
 end

data/lib/rpicsim/stack_trace.rb

@@ -6,7 +6,7 @@ module RPicSim
       @entries = entries
     end
 
-    def output(io, padding='')
+    def output(io, padding = '')
       @entries.reverse_each do |entry|
         output_entry(entry, io, padding)
       end

data/lib/rpicsim/storage/memory_integer.rb

@@ -54,6 +54,7 @@ module RPicSim::Storage
     end
 
     private
+
     def check_value(value, allowed_values)
       if !allowed_values.include?(value)
         raise ArgumentError, "Invalid value #{value} written to #{name}."
@@ -75,7 +76,6 @@ module RPicSim::Storage
       check_value val, 0..255
       @memory.write_byte(@address, val)
     end
-
   end
 
   # Represents a signed 8-bit variable.
@@ -231,5 +231,4 @@ module RPicSim::Storage
       @memory.write_word(@address, val)
     end
   end
-
 end

data/lib/rpicsim/variable_set.rb

@@ -21,7 +21,7 @@ module RPicSim
       @vars_for_memory_by_address[name] = {}
     end
 
-    def def_var(name, type, opts={})
+    def def_var(name, type, opts = {})
       allowed_keys = [:memory, :symbol, :address]
       invalid_keys = opts.keys - allowed_keys
       if !invalid_keys.empty?
@@ -69,12 +69,12 @@ module RPicSim
       end
 
       vars_by_address = @vars_for_memory_by_address[memory_type]
-      variable.addresses.each do |address|
-        if vars_by_address[address]
+      variable.addresses.each do |occupied_address|
+        if vars_by_address[occupied_address]
           raise 'Variable %s overlaps with %s at 0x%x' %
-            [variable, @vars_by_address[address], address]
+            [variable, vars_by_address[occupied_address], occupied_address]
         end
-        vars_by_address[address] = variable
+        vars_by_address[occupied_address] = variable
       end
 
       @vars_for_memory[memory_type][name] = variable

data/lib/rpicsim/version.rb

@@ -1,3 +1,3 @@
 module RPicSim
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpicsim
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Pololu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email: