rpicsim 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffc22a3d36cfe7fe55d2bd971e0e01410e639dcc
-  data.tar.gz: a8589f0756b0cb3fd7fbd9af22727945318414e3
+  metadata.gz: d1626d315076308dfcdf30160e32e355689ac8b3
+  data.tar.gz: 07b107ae6c4aa4c34cdd8b5b684c5b242f3f361c
 SHA512:
-  metadata.gz: 9d5209c814cf043635c779466ba9687246228644a368f6d7bea5d53d4a5944b8f7dbe04f83ee548db9c77b3ec3d1151323350146bf6639105bd6c992a7656195
-  data.tar.gz: c106a56ba5c1ac8932b0563d91f9d38eb03bc3fcfc29349ab90fadc02ffdfd0c837a9ab0e27c59c57a95ef22b01996a598feb6abdc3b0d9eefc5158426db2388
+  metadata.gz: 3bc9bf16d3737047d0995df8bf144cbd067d80c7e174c8d919ffe22cc3a6eea5b23d1f23cc89121b85a74f1a2461673325d84026944bfc568859bf9123bae171
+  data.tar.gz: 48e61eb950d62b15321f11c7cfe9c79ccb78951bf1d4b47b684451ea8cf3139ba8ecf70283eec8d386d8667e71213d8c95a7773263d7539690e99555a61d4cbc

data/Introduction.md

@@ -49,7 +49,7 @@ RPicSim is distributed as a Ruby gem named `rpicsim`.  To install RPicSim, run:
     jgem install rpicsim
 
 
-RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, v2.05, v2.10, v2.15, and v2.20.
+RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, v2.05, v2.10, v2.15, v2.20, v3.05, and v3.10.
 However, it uses a lot of undocumented and internal features of the Microchip Java libraries, so it will probably need to be updated as new versions of MPLAB X are released.
 
 RPicSim is not intended to replace formal specifications, code reviews, and rigorous testing of your firmware on actual hardware.

data/README.md

@@ -51,7 +51,7 @@ RPicSim is distributed as a Ruby gem named `rpicsim`.  To install RPicSim, run:
     jgem install rpicsim
 
 
-RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, v2.05, v2.10, v2.15, and v2.20.
+RPicSim has been tested with MPLAB X v1.85, v1.90, v1.95, v2.00, v2.05, v2.10, v2.15, v2.20, v3.05, and v3.10.
 However, it uses a lot of undocumented and internal features of the Microchip Java libraries, so it will probably need to be updated as new versions of MPLAB X are released.
 
 RPicSim is not intended to replace formal specifications, code reviews, and rigorous testing of your firmware on actual hardware.

data/docs/ChangeLog.md

@@ -1,11 +1,18 @@
 Change log
 ====
 
+1.1.1
+----
+Released on 2019-04-17.
+
+- Fixes a bug in the code that reads signed 32-bit integers.
+- Allows variables defined with {RPicSim::Sim#def_var} to overlap.
+
 1.1.0
 ----
 Released on 2015-07-27.
 
-- Added support for MPLAB X v3.05.
+- Added support for MPLAB X v3.05.  This version also works with MPLAB X v3.10, which was released later.
 
 1.0.0
 ----

data/docs/DefiningSimulationClass.md

@@ -1,85 +1,85 @@
-Defining your simulation class
-====
-
-In order to run a simulation of your firmware using RPicSim, you must make a new subclass of {RPicSim::Sim}.  This class is called your _simulation class_. Below is an example:
-
-    class MySim < RPicSim::Sim
-      use_device "PIC10F322"
-      use_file File.dirname(__FILE__) + "../firmware/dist/firmware.cof"
-    end
-
-A full list of the special RPicSim methods you can call inside your class definition can be found by looking at the documentation for {RPicSim::Sim::ClassDefinitionMethods}.
-
-Required properties
-----
-
-There are two things you must do inside a simulation class.
-
-First, call {RPicSim::Sim::ClassDefinitionMethods#use_device use_device} in order to specify the PIC device your firmware runs on.  Unfortunately, RPicSim cannot just detect this information from your COF file.  The argument to `use_device` should be a simple string containing the official name of the PIC device, like "PIC10F322".
-
-Second, call {RPicSim::Sim::ClassDefinitionMethods#use_file use_file} to specify the path to your COF or HEX file.  This must be done after calling `use_device`.
-In the example, we start with `File.dirname(__FILE__)`, which is the name of the directory that the current Ruby file is in, and add a string to that.
-This allows us to move our tests and firmware files around on the disk without changing the `use_file` line.
-
-Pins
-----
-
-You can use {RPicSim::Sim::ClassDefinitionMethods#def_pin def_pin} in your simulation class to define an alternative name for a pin.  For more information, see {file:Pins.md}.
-
-
-Variables
-----
-
-You can use {RPicSim::Sim::ClassDefinitionMethods#def_var def_var} in your simulation class to define a variable in RAM, program memory, or EEPROM.
-For more information, see {file:Variables.md}.
-
-
-Methods
-----
-
-It is sometimes helpful to define your own methods in the simulation class.  For example, here are some methods that help us simulate the effect of the user placing a jumper between RA1 and GND:
-
-    class MySim < RPicSim::Sim
-      use_device "PIC10F322"
-      use_file File.dirname(__FILE__) + "../firmware/dist/firmware.cof"
-      
-      def jumper_on
-        pin(:RA1).set false
-      end
-      
-      def jumper_off
-        pin(:RA1).set true
-      end
-    end
-
-By making these `jumper_on` and `jumper_off` methods, we can write lots of tests that manipulate the jumper but we don't have to constantly worry about how the hardware jumper is implemented when writing or reading those tests.
-This makes our tests easier to read and change.
-
-If you have an instance of the simulation class, you can call such a method in the usual way:
-
-    sim.jumper_on
-
-    
-Using the simulation class
-----
-
-To start a new simulation, you can simply make a new instance of the simulation class.  For example:
-
-    sim = MySim.new
-
-However, if you are using RSpec and RPicSim's {file:RSpecIntegration.md RSpec Integration}, then you should not create a new instance yourself.
-Instead, make a before hook that calls {RPicSim::RSpec::Helpers#start_sim start_sim}.
-This will start the simulation for you and use it to make some other methods and features available in your examples.
-After running {RPicSim::RSpec::Helpers#start_sim start_sim}, you will be able to access your simulation object using the method `sim`.
-
-For example:
-
-    describe "my firmware" do
-      before do
-        start_sim MySim
-      end
-      
-      it "runs to the :abc label" do
-        sim.run_to :abc, cycle_limit: 100
-      end
-    end
+Defining your simulation class
+====
+
+In order to run a simulation of your firmware using RPicSim, you must make a new subclass of {RPicSim::Sim}.  This class is called your _simulation class_. Below is an example:
+
+    class MySim < RPicSim::Sim
+      use_device "PIC10F322"
+      use_file File.dirname(__FILE__) + "../firmware/dist/firmware.cof"
+    end
+
+A full list of the special RPicSim methods you can call inside your class definition can be found by looking at the documentation for {RPicSim::Sim::ClassDefinitionMethods}.
+
+Required properties
+----
+
+There are two things you must do inside a simulation class.
+
+First, call {RPicSim::Sim::ClassDefinitionMethods#use_device use_device} in order to specify the PIC device your firmware runs on.  Unfortunately, RPicSim cannot just detect this information from your COF file.  The argument to `use_device` should be a simple string containing the official name of the PIC device, like "PIC10F322".
+
+Second, call {RPicSim::Sim::ClassDefinitionMethods#use_file use_file} to specify the path to your COF or HEX file.  This must be done after calling `use_device`.
+In the example, we start with `File.dirname(__FILE__)`, which is the name of the directory that the current Ruby file is in, and add a string to that.
+This allows us to move our tests and firmware files around on the disk without changing the `use_file` line.
+
+Pins
+----
+
+You can use {RPicSim::Sim::ClassDefinitionMethods#def_pin def_pin} in your simulation class to define an alternative name for a pin.  For more information, see {file:Pins.md}.
+
+
+Variables
+----
+
+You can use {RPicSim::Sim::ClassDefinitionMethods#def_var def_var} in your simulation class to define a variable in RAM, program memory, or EEPROM.
+For more information, see {file:Variables.md}.
+
+
+Methods
+----
+
+It is sometimes helpful to define your own methods in the simulation class.  For example, here are some methods that help us simulate the effect of the user placing a jumper between RA1 and GND:
+
+    class MySim < RPicSim::Sim
+      use_device "PIC10F322"
+      use_file File.dirname(__FILE__) + "../firmware/dist/firmware.cof"
+      
+      def jumper_on
+        pin(:RA1).set false
+      end
+      
+      def jumper_off
+        pin(:RA1).set true
+      end
+    end
+
+By making these `jumper_on` and `jumper_off` methods, we can write lots of tests that manipulate the jumper but we don't have to constantly worry about how the hardware jumper is implemented when writing or reading those tests.
+This makes our tests easier to read and change.
+
+If you have an instance of the simulation class, you can call such a method in the usual way:
+
+    sim.jumper_on
+
+    
+Using the simulation class
+----
+
+To start a new simulation, you can simply make a new instance of the simulation class.  For example:
+
+    sim = MySim.new
+
+However, if you are using RSpec and RPicSim's {file:RSpecIntegration.md RSpec Integration}, then you should not create a new instance yourself.
+Instead, make a before hook that calls {RPicSim::RSpec::Helpers#start_sim start_sim}.
+This will set up the simulation for you and use it to make some other methods and features available in your RSpec examples.
+After running {RPicSim::RSpec::Helpers#start_sim start_sim}, you will be able to access your simulation object using the method `sim`.
+
+For example:
+
+    describe "my firmware" do
+      before do
+        start_sim MySim
+      end
+      
+      it "runs to the :abc label" do
+        sim.run_to :abc, cycle_limit: 100
+      end
+    end

data/docs/KnownIssues.md

@@ -213,7 +213,7 @@ These issues might affect other PIC architectures as well.
 * **No intermediate values:** In MPLAB X 1.85, setting a pin to any voltage other than 0 V will result in an ADC reading of 255.
 
 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.
-The midrange ADC seems to work correctly in MPLAB X 3.05.
+The midrange ADC seems to work correctly in MPLAB X v3.05 and later.
 
 
 Variables from XC8 are not correctly identified

data/docs/SupportedCompilers.md

@@ -1,5 +1,5 @@
 # Supported compilers
 
-RPicSim supports any compiler that can generate a standard Microchip COF file that is recognized by the COF-loading code in MPLAB X.  If your compiler does not generate such a file, then you could use an Intel HEX file instead, but then RPicSim will not automatically have access to your firmware's symbol table, so it will not know where variables, functions, and labels are located.
+RPicSim supports any compiler that can generate a standard Microchip COF or ELF file that is recognized by the file loading code in MPLAB X.  If your compiler does not generate such a file, then you could use an Intel HEX file instead, but then RPicSim will not automatically have access to your firmware's symbol table, so it will not know where variables, functions, and labels are located.
 
-RPicSim has been extensively tested with COF files produced by MPASM.  At the time of this writing, it has not been tested with XC8 or C18.
+RPicSim has been extensively tested with COF files produced by MPASM, and the ELF files produced by XC8.  It also has support for reading symbols from the SYM file produced by XC8.  At the time of this writing, it has not been tested with C18.

data/lib/rpicsim/storage/memory_integer.rb

@@ -202,10 +202,11 @@ module RPicSim::Storage
     end
 
     def value
-      val = @memory.read_byte(@address) + 0x100 * @memory.read_byte(@address + 1) +
+      val =
+        @memory.read_byte(@address) +
+        0x100 * @memory.read_byte(@address + 1) +
         0x10000 * @memory.read_byte(@address + 2) +
-        0x1000000 * @memory.read_byte(@address + 3) +
-        0x100000000 * @memory.read_byte(@address + 4)
+        0x1000000 * @memory.read_byte(@address + 3)
       val -= 0x100000000 if val >= 0x80000000
       val
     end

data/lib/rpicsim/variable_set.rb

@@ -12,7 +12,6 @@ module RPicSim
       @memory_types = []
       @symbols_for_memory = {}
       @vars_for_memory = {}
-      @vars_for_memory_by_address = {}
     end
 
     def def_memory_type(name, symbols)
@@ -20,7 +19,6 @@ module RPicSim
       @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 = {})
@@ -70,15 +68,6 @@ module RPicSim
         variable.size = @address_increment
       end
 
-      vars_by_address = @vars_for_memory_by_address[memory_type]
-      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[occupied_address], occupied_address]
-        end
-        vars_by_address[occupied_address] = variable
-      end
-
       @vars_for_memory[memory_type][name] = variable
     end
 

data/lib/rpicsim/version.rb

@@ -2,5 +2,5 @@
 module RPicSim
   # The version number of this gem, as a string.
   # @return [String]
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpicsim
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Pololu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2019-04-17 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -108,9 +108,8 @@ requirements:
 - JRuby
 - MPLAB X
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 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: