rpicsim 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd4ff6f54bf53d46e52ab338f4cf495a099e2de5
-  data.tar.gz: 5f5dc6b5693fbaca9e88699a1e340fe9c36b11b1
+  metadata.gz: a7dd67ae71f9052d9fa174cace952aa468a0001d
+  data.tar.gz: 72a07a6240931d85054651627a017677924d1a9e
 SHA512:
-  metadata.gz: 8effea68fe1786bf5d6517eaa6284827ff85867343de19ffd424ea81e1875175e92d8cd23ea4e0fa0504a890f0dacce649fa766e4e391bd0e8097393a2f40705
-  data.tar.gz: b9be314ea31c1885fa570386ab6e59ab94d0e9c7364d6a89bd4026891087d2722e9125c23aef5843445dd9c285da1014762c1f32facd6ec9ee0e4d1b0effafbb
+  metadata.gz: 94d406a34b8dc47900a487a306a3071ec2a441b039e6696c4f3c422cb2d92c27c0b200d13ea80e537df9b73dab4657db9edcf102d94fa3a7b516d39aa5128c55
+  data.tar.gz: 7c332af37e3563c1b12249c1fa690ca07f297dbb56175403b7b2d3c333fc3fdddd95825919ce40cafe90c1f1eb533a11842e61276a0b5652d765d26431637d73

data/docs/ChangeLog.md

@@ -1,6 +1,27 @@
 Change log
 ====
 
+0.4.0
+----
+Released on 2014-07-30.
+
+- Adds {RPicSim::Memory#read_bytes} and {RPicSim::Memory#write_bytes}.
+- Adds {RPicSim::Sim#stack_memory}.
+- Fixes a bug in the RSpec 3.x support that was breaking the informative error messages when an example fails.
+- Adds the ability to define symbols used in your simulation from sources other than a the COF file.
+    - Adds {RPicSim::Sim::ClassDefinitionMethods#import_symbols}, which calls {RPicSim::ProgramFile#import_symbols}
+    - Adds {RPicSim::Sim::ClassDefinitionMethods#def_symbol}, which calls {RPicSim::ProgramFile#def_symbol}
+    - Adds {RPicSim::ProgramFile#symbols} so you can more easily debug symbol-related problems and get access to symbols even if RPicSim does not recognize what type they are.
+- Adds the {RPicSim::Xc8SymFile} class, which can load symbols from a SYM file produced by the XC8 compiler and then be passed to {RPicSim::Sim::ClassDefinitionMethods#import_symbols import_symbols}.  This was necessary because the COF files produced by XC8 are difficult to interpret and do not always allow us to tell what memory space a given symbol is for.
+- {RPicSim::Sim::ClassMethods#label #label} and {RPicSim::Sim::ClassMethods#labels #labels} methods are now available on both instances of a simulation class or on a simulation class itself.
+
+0.3.0
+----
+Released on 2014-06-20.
+
+- Adds support for RSpec 3.x.  This release was tested with RSpec 2.14.1, 2.99.0, and 3.0.0.
+- Adds support for MPLAB X 2.10.
+
 0.2.5
 ----
 Released on 2014-05-02.
@@ -40,4 +61,4 @@ Released on 2014-03-07.
 Released on 2014-02-12.
 This is the initial release.
 There are still some major things missing from this version that need to be added before we release 1.0.0.
-Until 1.0.0 is released, we will not worry about backwards compatibility or writing complete change logs.
+Until 1.0.0 is released, we will not worry about backwards compatibility or writing complete change logs.

data/docs/KnownIssues.md

@@ -197,3 +197,15 @@ 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.
+
+Cannot read the top byte of PIC18 flash memory
+----
+
+_Type: MPLAB X bug_
+
+_MPLAB X versions affected: all tested verions_
+
+Attempting to read from the top (last) byte of program memory will cause an exception because the top address is not considered to be valid.
+For example, you cannot use `program_memory.read_byte(0x7FFF)` on a PIC18F25K50 simulation.
+One workaround is to use `read_word` instead.
+This seems to only affect PIC18 devices.

data/docs/Labels.md

@@ -27,7 +27,7 @@ Therefore, to get the address of a C function named `foo`, you might have to acc
 If RPicSim cannot find the label you want to use, you might troubleshoot it by printing out a list of all the known labels:
 
     !!!ruby
-    p sim.program_file.labels.keys
+    p sim.labels.keys
 
 
 Using a Label object

data/lib/rpicsim.rb

@@ -1,3 +1,4 @@
 require_relative 'rpicsim/version'
 require_relative 'rpicsim/sim'
 require_relative 'rpicsim/call_stack_info'
+require_relative 'rpicsim/xc8_sym_file'

data/lib/rpicsim/memory.rb

@@ -7,7 +7,7 @@ module RPicSim
   # The behavior of +read_word+ and +write_word+ differs depending on
   # what kind of Memory is being used, as shown in the table below:
   #
-  #     Memory type                Address type   Read/write chunk
+  #     Memory type                Address type   Read/write chunk for word methods
   #     RAM and EEPROM:            Byte address   1 byte (8 bits)
   #     PIC18 program memory:      Byte address   1 word (16 bits)
   #     Non-PIC18 program memory:  Word address   1 word (12 or 14 bits)
@@ -26,24 +26,61 @@ module RPicSim
       @mplab_memory = mplab_memory
     end
 
+    # Reads the byte in memory at the specified address.
+    #
+    # @param address [Integer]
+    # @return [Integer]
     def read_byte(address)
       @mplab_memory.read_byte(address)
     end
 
+    # Writes the given integer to the byte in memory at the specified address.
+    #
+    # @param address [Integer]
+    # @param value [Integer]
     def write_byte(address, value)
       @mplab_memory.write_byte(address, value)
     end
 
+    # Reads the word in memory at the specified address.
+    # @param address [Integer]
+    # @return [Integer]
     def read_word(address)
       @mplab_memory.read_word(address)
     end
 
+    # Writes the given integer to the word in memory at the specified address.
+    # @param address [Integer]
+    # @param value [Integer]
     def write_word(address, value)
       @mplab_memory.write_word(address, value)
     end
 
+    # Returns true if the specified address is valid.
+    # @param address [Integer]
+    # @return true or false
     def valid_address?(address)
       @mplab_memory.valid_address?(address)
     end
+
+    # Reads a series of bytes from the simulated memory using +read_byte+ and
+    # returns them as an array.
+    #
+    # @param address [Integer] The address of the first byte to read.
+    # @param size [Integer] The number of bytes to read.
+    # @return [Array(Integer)]
+    def read_bytes(address, size)
+      size.times.map { |i| read_byte(address + i) }
+    end
+
+    # Writes a series of bytes to the simulated memory.
+    #
+    # @param address [Integer]
+    # @param bytes Array of integers or a string.
+    def write_bytes(address, bytes)
+      bytes = bytes.bytes if bytes.is_a?(String)
+      bytes.each_with_index { |b, i| write_byte(address + i, b) }
+      nil
+    end
   end
 end

data/lib/rpicsim/mplab/mplab_program_file.rb

@@ -16,6 +16,10 @@ module RPicSim::Mplab
       @program_file.Load
     end
 
+    def symbols
+      @symbols ||= Hash[raw_symbols.map { |s| [s.m_Symbol.to_sym, s.address] }]
+    end
+
     def symbols_in_ram
       @symbols_in_ram ||= Hash[
         grouped_symbols[:ram]
@@ -41,7 +45,7 @@ module RPicSim::Mplab
 
     def grouped_symbols
       @grouped_symbols ||= begin
-        hash = symbols.group_by(&method(:memory_type))
+        hash = raw_symbols.group_by(&method(:memory_type))
         hash.default = []
         hash
       end
@@ -71,7 +75,9 @@ module RPicSim::Mplab
     # 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
+    # The numbers above are not very well tested and probably incomplete.  This
+    # is OK because for XC8 programs people should use the HEX and SYM file
+    # instead of the COF file.
     def memory_type(symbol)
       case symbol.m_lType
       when 0, 2, 8, 12, 40, 44, 108
@@ -89,10 +95,10 @@ module RPicSim::Mplab
     # Just put this line in your simulation class definition temporarily:
     # 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)] }
+      raw_symbols.map { |s| [s.m_Symbol, s.m_lType, s.address, memory_type(s)] }
     end
 
-    def symbols
+    def raw_symbols
       @program_file.getSymbolTable.getSymbols(0, 0)
     end
   end

data/lib/rpicsim/program_file.rb

@@ -1,13 +1,15 @@
 require_relative 'mplab'
 require_relative 'label'
 require_relative 'instruction'
+require_relative 'symbol_set'
 
-# 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?)
+# TODO: 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).
+  # Keeps track of all the symbols loaded from that file and also allows you
+  # to add symbols in various ways.
   class ProgramFile
     attr_reader :filename
     attr_reader :device
@@ -27,39 +29,104 @@ module RPicSim
       @address_increment = @assembly.device_info.code_address_increment
 
       @instructions = []
+
+      @labels = {}
+
+      @symbol_set = SymbolSet.new
+      @symbol_set.def_memory_type :ram
+      @symbol_set.def_memory_type :program_memory
+      @symbol_set.def_memory_type :eeprom
+
+      @symbol_set.on_symbol_definition do |name, address, memory_type|
+        if memory_type == :program_memory
+          labels[name] = Label.new(name, address)
+        end
+      end
+
+      import_symbols @mplab_program_file
     end
 
-    # Returns a hash associating RAM variable names (as symbols) to their addresses.
-    # @return (Hash)
+    # Imports symbols from an additional symbol source.
+    #
+    # The +symbol_source+ parameter should be an object that responds to some
+    # subset of these methods: +#symbols+, +#symbols_in_ram+,
+    # +#symbols_in_program_memory+, +#symbols_in_eeprom+.  The methods should
+    # take no arguments and return a hash where the keys are symbol names
+    # (represented as Ruby symbols) and the values are addresses (as
+    # integers).
+    def import_symbols(symbol_source)
+      if symbol_source.respond_to?(:symbols)
+        @symbol_set.def_symbols symbol_source.symbols
+      end
+
+      if symbol_source.respond_to?(:symbols_in_ram)
+        @symbol_set.def_symbols symbol_source.symbols_in_ram, :ram
+      end
+
+      if symbol_source.respond_to?(:symbols_in_program_memory)
+        @symbol_set.def_symbols symbol_source.symbols_in_program_memory, :program_memory
+      end
+
+      if symbol_source.respond_to?(:symbols_in_eeprom)
+        @symbol_set.def_symbols symbol_source.symbols_in_eeprom, :eeprom
+      end
+    end
+
+    # Defines a new symbol.
+    #
+    # @param name [Symbol] The name of the symbol.
+    # @param address [Integer] The address of the symbol.
+    # @param memory_type [Symbol] (optional) The type of memory the symbol
+    #   belongs to.  This should either by +:ram+, +:program_memory+, or
+    #   +:eeprom+.
+    def def_symbol(name, address, memory_type = nil)
+      @symbol_set.def_symbol name, address, memory_type
+    end
+
+    # Returns all the symbols known to the simulation.
+    #
+    # The return value is a hash where the keys are the names of the symbols
+    # (represented as Ruby symbols) and the values are the addresses of the symbols.
+    #
+    # Warning: This is a persistent hash that will automatically be updated when
+    # new symbols are defined.
+    def symbols
+      @symbol_set.symbols
+    end
+
+    # Returns all the symbols in RAM.
+    # The return value is a hash where the keys are the names of the symbols
+    # (represented as Ruby symbols) and the values are the addresses of the symbols.
+    #
+    # Warning: This is a persistent hash that will automatically be updated when
+    # new symbols are defined.
     def symbols_in_ram
-      @mplab_program_file.symbols_in_ram
+      @symbol_set.symbols_in_memory(:ram)
     end
 
-    # Returns a hash associating program memory symbol names (as Ruby symbols)
-    # to their addresses.
-    # @return (Hash)
+    # Returns all the symbols in program memory.
+    # The return value is a hash where the keys are the names of the symbols
+    # (represented as Ruby symbols) and the values are the addresses of the symbols.
+    #
+    # Warning: This is a persistent hash that will automatically be updated when
+    # new symbols are defined.
     def symbols_in_program_memory
-      @mplab_program_file.symbols_in_program_memory
+      @symbol_set.symbols_in_memory(:program_memory)
     end
 
-    # Returns a hash associating EEPROM memory symbol names (as Ruby symbols)
-    # to their addresses.
-    # @return (Hash)
+    # Returns all the symbols in EEPROM.
+    # The return value is a hash where the keys are the names of the symbols
+    # (represented as Ruby symbols) and the values are the addresses of the symbols.
+    #
+    # Warning: This is a persistent hash that will automatically be updated when
+    # new symbols are defined.
     def symbols_in_eeprom
-      @mplab_program_file.symbols_in_eeprom
+      @symbol_set.symbols_in_memory(:eeprom)
     end
 
     # Returns a hash associating program memory label names (as symbols) to their addresses.
     # @return (Hash)
-    def labels
-      @labels ||= begin
-        hash = {}
-        symbols_in_program_memory.each do |name, address|
-          hash[name] = Label.new(name, address)
-        end
-        hash
-      end
-    end
+    attr_reader :labels
 
     # Returns a {Label} object if a program label by that name is found.
     # The name is specified in the code that defined the label.  If you are using a C compiler,

data/lib/rpicsim/rspec/sim_diagnostics.rb

@@ -41,7 +41,7 @@ RSpec.configure do |config|
            example # RSpec 2.x
          end
     if @sim && ex.exception
-      RPicSim::RSpec::SimDiagnostics.store_diagnostics(example, @sim)
+      RPicSim::RSpec::SimDiagnostics.store_diagnostics(ex, @sim)
     end
   end
 end

data/lib/rpicsim/sim.rb

@@ -29,7 +29,8 @@ module RPicSim
       end
 
       # Specifies the path to the firmware file.  The file can be a HEX or COF file, but
-      # COF is recommended so that you can access label addresses and other debugging information.
+      # COF is recommended so that you can access symbol/label addresses and other
+      # debugging information.
       # You must call {#use_device} before calling this.
       def use_file(filename)
         raise "The device needs to be specified before filename (e.g. 'use_device \"PIC10F322\"')" unless @device
@@ -37,6 +38,27 @@ module RPicSim
         load_program_file
       end
 
+      # Specifies additional symbols to use in the simulation.  Symbols might be
+      # loaded from the program file when you call {#use_file}, but if those
+      # symbols are not sufficient then you can call this method to incorporate
+      # another source of symbols.
+      #
+      # See {RPicSim::ProgramFile#import_symbols} for details on what the parameter
+      # should be.
+      def import_symbols(symbol_source)
+        program_file.import_symbols(symbol_source)
+      end
+
+      # Define a symbol.
+      # Normally symbols are loaded by {#use_file} or {#import_symbols}, but you can
+      # this method allows for adding additional symbols one at a time.
+      #
+      # See {RPicSim::ProgramFile#def_symbol} for details about the parameters
+      # this method takes.
+      def def_symbol(name, address, memory_type = nil)
+        program_file.def_symbol name, address, memory_type
+      end
+
       # Define a pin alias.
       #
       # @param our_name [Symbol] Specifies what you would like to
@@ -98,12 +120,22 @@ module RPicSim
       # with {ClassDefinitionMethods#def_var def_var}.
       attr_reader :variable_set
 
-      # A hash that associates label names as symbols to {Label} objects.
-      attr_reader :labels
-
       # The {ProgramFile} object representing the firmware.
       attr_reader :program_file
 
+      # Returns a hash that associates label names as Ruby symbols to {Label} objects.
+      def labels
+        program_file.labels
+      end
+
+      # Returns a {Label} object if a program label by that name is found.
+      # The name is specified in the code that defined the label.  If you are using a C compiler,
+      # you will probably need to prefix the name with an underscore.
+      # @return [Label]
+      def label(name)
+        program_file.label(name)
+      end
+
       private
 
       # This gets called when a new subclass of PicSim is created.
@@ -117,7 +149,6 @@ module RPicSim
 
       def load_program_file
         @program_file = ProgramFile.new(@filename, @device)
-        @labels = program_file.labels
 
         @variable_set = VariableSet.new
         @variable_set.address_increment = program_file.address_increment
@@ -143,6 +174,7 @@ module RPicSim
         :every_step,
         :goto,
         :label,
+        :labels,
         :location_address,
         :new_ram_watcher,
         :pc,
@@ -158,6 +190,7 @@ module RPicSim
         :run_to_cycle_count,
         :reg,
         :stack_contents,
+        :stack_memory,
         :stack_push,
         :stack_trace,
         :step,
@@ -212,6 +245,11 @@ module RPicSim
     # @return [Memory]
     attr_reader :eeprom
 
+    # Returns a {Memory} object that allows direct reading and writing of the
+    # bytes in the simulated hardware call stack.
+    # @return [Memory]
+    attr_reader :stack_memory
+
     # Returns a string like "PIC10F322" specifying the PIC device number.
     # @return [String]
     def device
@@ -336,6 +374,11 @@ module RPicSim
       program_file.label(name)
     end
 
+    # Returns a hash that associates label names as Ruby symbols to {Label} objects.
+    def labels
+      program_file.labels
+    end
+
     # Returns the number of instruction cycles simulated in this simulation.
     # @return [Integer]
     def cycle_count

data/lib/rpicsim/symbol_set.rb

@@ -0,0 +1,51 @@
+module RPicSim
+  # This class is used internally by {Sim} to manage the symbols from the
+  # simulated firmware's symbol table..
+  class SymbolSet
+    def initialize
+      @memory_types = []
+      @symbols = {}
+      @symbols_for_memory = {}
+      @callbacks = []
+    end
+
+    def def_memory_type(name)
+      name = name.to_sym
+      @memory_types << name
+      @symbols_for_memory[name] = {}
+    end
+
+    def def_symbol(name, address, memory_type = nil)
+      name = name.to_sym
+      address = address.to_i
+      if memory_type
+        hash = @symbols_for_memory[memory_type.to_sym]
+        raise "Invalid memory type: #{memory_type}." if !hash
+        hash[name] = address
+      end
+
+      @symbols[name] = address
+
+      @callbacks.each do |callback|
+        callback.call name, address, memory_type
+      end
+    end
+
+    def def_symbols(symbols, memory_type = nil)
+      symbols.each do |name, address|
+        def_symbol name, address, memory_type
+      end
+    end
+
+    attr_reader :symbols
+
+    def symbols_in_memory(memory_type)
+      @symbols_for_memory[memory_type.to_sym]
+    end
+
+    def on_symbol_definition(&proc)
+      raise 'Block required' if !proc
+      @callbacks << proc
+    end
+  end
+end

data/lib/rpicsim/version.rb

@@ -1,3 +1,3 @@
 module RPicSim
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/rpicsim/xc8_sym_file.rb

@@ -0,0 +1,79 @@
+require 'scanf'
+
+module RPicSim
+  class Xc8SymFile
+    attr_reader :symbols
+    attr_reader :symbols_in_ram
+    attr_reader :symbols_in_eeprom
+    attr_reader :symbols_in_program_memory
+
+    attr_reader :symbol_raw_data
+
+    def initialize(filename, opts = {})
+      @symbols = {}
+      @symbols_in_ram = {}
+      @symbols_in_eeprom = {}
+      @symbols_in_program_memory = {}
+
+      @filename = filename
+      @sections_in_ram = %w{ABS BIGRAM COMRAM RAM SFR FARRAM
+                            BANK0 BANK1 BANK2 BANK3 BANK4 BANK5 BANK6 BANK7}
+      @sections_in_code = %w{CODE CONST IDLOC MEDIUMCONST SMALLCONST}
+      @sections_in_eeprom = %w{EEDATA}
+
+      allowed_keys = [:custom_ram_sections,
+                      :custom_code_sections,
+                      :custom_eeprom_sections]
+      invalid_keys = opts.keys - allowed_keys
+      if !invalid_keys.empty?
+        raise "Invalid options: #{invalid_keys.inspect}"
+      end
+
+      if opts[:custom_ram_sections]
+        @sections_in_ram += opts[:custom_ram_sections]
+      end
+
+      if opts[:custom_code_sections]
+        @sections_in_code += opts[:custom_code_sections]
+      end
+
+      if opts[:custom_eeprom_sections]
+        @sections_in_eeprom += opts[:custom_eeprom_sections]
+      end
+
+      read_data
+      sort_data
+    end
+
+    private
+
+    def read_data
+      @symbol_raw_data = {}
+      File.foreach(@filename) do |line|
+        entry = line.scanf('%s %x %x %s %x')
+        break if entry[0].start_with? '%'
+        key = entry[0].to_sym
+        entry[0] = key
+        @symbol_raw_data[key] = entry
+      end
+    end
+
+    def sort_data
+      @symbol_raw_data.values.each do |name, address, _, section, _|
+        @symbols[name] = address
+
+        if @sections_in_ram.include?(section)
+          @symbols_in_ram[name] = address
+        end
+
+        if @sections_in_code.include?(section)
+          @symbols_in_program_memory[name] = address
+        end
+
+        if @sections_in_eeprom.include?(section)
+          @symbols_in_eeprom[name] = address
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpicsim
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pololu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -16,11 +16,52 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
-- Gemfile
+- 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
+- lib/rpicsim/memory.rb
+- lib/rpicsim/memory_watcher.rb
+- lib/rpicsim/mplab.rb
+- lib/rpicsim/pin.rb
+- lib/rpicsim/program_counter.rb
+- lib/rpicsim/program_file.rb
+- lib/rpicsim/rspec.rb
+- lib/rpicsim/search.rb
+- lib/rpicsim/sim.rb
+- lib/rpicsim/stack_pointer.rb
+- lib/rpicsim/stack_trace.rb
+- lib/rpicsim/symbol_set.rb
+- lib/rpicsim/variable.rb
+- lib/rpicsim/variable_set.rb
+- lib/rpicsim/version.rb
+- lib/rpicsim/xc8_sym_file.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_loader.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/rspec/be_predicate.rb
+- lib/rpicsim/rspec/helpers.rb
+- lib/rpicsim/rspec/persistent_expectations.rb
+- lib/rpicsim/rspec/sim_diagnostics.rb
+- lib/rpicsim/storage/memory_integer.rb
+- lib/rpicsim/storage/register.rb
 - Introduction.md
 - LICENSE.txt
 - README.md
+- Gemfile
 - docs/ChangeLog.md
 - docs/Contributing.md
 - docs/Debugging.md
@@ -39,8 +80,8 @@ files:
 - docs/Pins.md
 - docs/PreventingCallStackOverflow.md
 - docs/QuickStartGuide.md
-- docs/RSpecIntegration.md
 - docs/RamWatcher.md
+- docs/RSpecIntegration.md
 - docs/Running.md
 - docs/Stubbing.md
 - docs/SupportedCompilers.md
@@ -49,46 +90,7 @@ files:
 - docs/SupportedOperatingSystems.md
 - docs/UnitTesting.md
 - 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
-- 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_loader.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/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_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
+- .yardopts
 homepage: https://github.com/pololu/rpicsim
 licenses:
 - MIT
@@ -111,7 +113,7 @@ requirements:
 - JRuby
 - MPLAB X
 rubyforge_project:
-rubygems_version: 2.3.0
+rubygems_version: 2.1.9
 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.