rpicsim 0.1.0 → 0.2.1

data/lib/rpicsim/mplab/mplab_program_file.rb

@@ -1,35 +1,47 @@
 module RPicSim::Mplab
   # This class creates and wraps a com.microchip.mplab.mdbcore.program.interfaces.IProgramFile
   class MplabProgramFile
+    EepromRange = 0xF00000..0xFFFFFF
+
     def initialize(filename, device)
       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 " +
-              "class will throw an exception saying that it cannot find the COF file."
+
+      if !File.realdirpath(filename).split('/').include?('dist')
+        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
-      
-      factory = Lookup.getDefault.lookup(Mdbcore.program.spi.IProgramFileProviderFactory.java_class)      
+
+      factory = Lookup.getDefault.lookup(Mdbcore.program.spi.IProgramFileProviderFactory.java_class)
       @program_file = factory.getProvider(filename, device)
       @program_file.Load
     end
-    
-    def symbols_in_code_space
-      @symbols_in_code_space ||= Hash[
-        symbols.select { |s| s.m_lType != 0 }.map { |s| [s.m_Symbol.to_sym, s.address] }
-      ]
-    end
-    
+
     def symbols_in_ram
       @symbols_in_ram ||= Hash[
         symbols.select { |s| s.m_lType == 0 }.map { |s| [s.m_Symbol.to_sym, s.address] }
       ]
     end
-    
+
+    def symbols_in_program_memory
+      @symbols_in_code_space ||= Hash[
+        symbols
+          .select { |s| s.m_lType != 0 && !EepromRange.include?(s.address) }
+          .map { |s| [s.m_Symbol.to_sym, s.address] }
+      ]
+    end
+
+    def symbols_in_eeprom
+      @symbols_in_eeprom ||= Hash[
+        symbols
+          .select { |s| s.m_lType != 0 && EepromRange.include?(s.address) }
+          .map { |s| [s.m_Symbol.to_sym, s.address - EepromRange.min] }
+      ]
+    end
+
     private
-    
+
     def symbols
       @program_file.getSymbolTable.getSymbols(0, 0)
     end
-  end 
-end
+  end
+end

data/lib/rpicsim/mplab/mplab_register.rb

@@ -4,22 +4,22 @@ module RPicSim::Mplab
     def initialize(register)
       @register = register
     end
-    
+
     def write(value)
       @register.write(value)
       value
     end
-    
+
     def read
       @register.read
     end
-    
+
     def name
       @register.getName
     end
-    
+
     def address
       @register.getAddress
     end
   end
-end
+end

data/lib/rpicsim/mplab/mplab_sfr_info.rb

@@ -1,21 +1,21 @@
 module RPicSim::Mplab
   class MplabSfrInfo
     attr_reader :address
-  
+
     # @param address The address of the register.
     # @param register [com.microchip.crownking.edc.Register]
     def initialize(address, register)
       @address = address
       @register = register
     end
-    
+
     # Returns how many bits the register has.
     def width
       @register.width
     end
-    
+
     def name
       @register.name
     end
   end
-end
+end

data/lib/rpicsim/mplab/mplab_simulator.rb

@@ -2,10 +2,10 @@ require_relative 'mplab_memory'
 require_relative 'mplab_processor'
 
 module RPicSim::Mplab
-  # DeviceInfo is a wrapper for the MPLAB xPIC class which gives us information
-  # about the target PIC device.
+  # This class is a wrapper for thecom.microchip.mplab.mdbcore.simulator.Simulator
+  # class, which helps manage running a simulation.
   class MplabSimulator
-    # Makes a new DeviceInfo object.
+    # Makes a new MplabSimulator object.
     # @param simulator [com.microchip.mplab.mdbcore.simulator.Simulator]
     def initialize(simulator)
       @simulator = simulator
@@ -18,7 +18,7 @@ module RPicSim::Mplab
     def fr_memory
       @fr_memory ||= MplabMemory.new data_store.getFileMemory
     end
-    
+
     def sfr_memory
       @sfr_memory ||= MplabMemory.new data_store.getSFRMemory
     end
@@ -26,25 +26,33 @@ module RPicSim::Mplab
     def nmmr_memory
       @nmmr_memory ||= MplabMemory.new data_store.getNMMRMemory
     end
-    
+
     def program_memory
       @program_memory ||= MplabMemory.new data_store.getProgMemory
     end
-    
+
     def stack_memory
       @stack_memory ||= MplabMemory.new data_store.getStackMemory
     end
-    
+
     def test_memory
       @test_memory ||= MplabMemory.new data_store.getTestMemory
     end
-    
+
+    def config_memory
+      @config_memory ||= MplabMemory.new data_store.getCFGMemory
+    end
+
+    def eeprom_memory
+      @eeprom_memory ||= MplabMemory.new data_store.getEEDataMemory
+    end
+
     def processor
       @processor ||= MplabProcessor.new data_store.getProcessor
     end
-    
+
     def pins
-      pin_descs = (0...data_store.getNumPins).collect { |i| data_store.getPinDesc(i) }
+      pin_descs = (0...data_store.getNumPins).map { |i| data_store.getPinDesc(i) }
 
       pin_set = data_store.getProcessor.getPinSet
 
@@ -56,11 +64,11 @@ module RPicSim::Mplab
         pin_set.getPin name                # Trigger the lazy loading.
       end
 
-      pins = (0...pin_set.getNumPins).collect do |i|
+      (0...pin_set.getNumPins).map do |i|
         MplabPin.new pin_set.getPin(i)
       end
     end
-    
+
     def check_peripherals
       check_peripherals_in_data_store
       check_peripheral_set
@@ -71,32 +79,21 @@ module RPicSim::Mplab
     def data_store
       @simulator.getDataStore
     end
-    
+
     def check_peripherals_in_data_store
       if data_store.getNumPeriphs == 0
-        raise "MPLAB X failed to load any peripheral descriptions into the data store."
+        raise 'MPLAB X failed to load any peripheral descriptions into the data store.'
       end
     end
 
     def check_peripheral_set
       peripherals = data_store.getProcessor.getPeripheralSet
       if peripherals.getNumPeripherals == 0
-        raise "MPLAB X failed to load any peripherals into the PeripheralSet."
+        raise 'MPLAB X failed to load any peripherals into the PeripheralSet.'
       end
     end
-    
-    # This is commented out because MPLAB X v2.00 with the PIC18F25K50
-    # reports three missing peripherals:
-    #  PBADEN_PCFG
-    #  config
-    #  CONFIG3H.PBADEN
-    #
-    #def check_missing_peripherals
-    #  peripherals = data_store.getProcessor.getPeripheralSet
-    #  if peripherals.getMissingPeripherals.to_a.size > 0
-    #    raise "This device has missing peripherals: " + peripherals.getMissingReasons().to_a.inspect
-    #  end
-    #end
-    
+
+    # Note: if you are troubleshooting missing peripherals, you could check:
+    #  data_store.getProcessor.getPeripheralSet.getMissingPeripherals.to_a
   end
-end
+end

data/lib/rpicsim/pin.rb

@@ -6,7 +6,7 @@ module RPicSim
     # Initializes a new Pin object to wrap the given MplabPin.
     # @param mplab_pin [Mplab::MplabPin]
     def initialize(mplab_pin)
-      raise ArgumentError, "mplab_pin is nil" if mplab_pin.nil?
+      raise ArgumentError, 'mplab_pin is nil' if mplab_pin.nil?
       @mplab_pin = mplab_pin
     end
 
@@ -26,12 +26,12 @@ module RPicSim
     def output?
       @mplab_pin.output?
     end
-    
+
     # Returns true if the pin is currently configured to be an input.
     def input?
       !@mplab_pin.output?
     end
-    
+
     # Returns true if the pin is currently configured to be an output and
     # it is driving high.
     def driving_high?
@@ -49,13 +49,13 @@ module RPicSim
     def names
       @mplab_pin.names
     end
-    
+
     def to_s
       @mplab_pin.name
-    end    
+    end
 
     def inspect
-      "#<%s %s>" % [self.class, to_s]
+      '#<%s %s>' % [self.class, to_s]
     end
   end
 end

data/lib/rpicsim/program_counter.rb

@@ -7,13 +7,13 @@ module RPicSim
     def initialize(processor)
       @processor = processor
     end
-    
+
     def value
       @processor.get_pc
     end
-    
+
     def value=(val)
       @processor.set_pc(val)
     end
   end
-end
+end

data/lib/rpicsim/program_file.rb

@@ -7,33 +7,50 @@ module RPicSim
   class ProgramFile
     attr_reader :filename
     attr_reader :device
-  
+
+    attr_reader :address_increment
+
     # @param filename [String] The path to the program file.
     # @param device [String] The name of the device the file is for (e.g. "PIC10F322").
     def initialize(filename, device)
       @filename = filename
       @device = device
+
       @mplab_program_file = Mplab::MplabProgramFile.new(filename, device)
-      
+
       @assembly = Mplab::MplabAssembly.new(device)
       @assembly.load_file(filename)
       @address_increment = @assembly.device_info.code_address_increment
-      
+
       @instructions = []
     end
-    
+
     # Returns a hash associating RAM variable names (as symbols) to their addresses.
     # @return (Hash)
-    def var_addresses
-      @var_addresses ||= @mplab_program_file.symbols_in_ram
+    def symbols_in_ram
+      @mplab_program_file.symbols_in_ram
+    end
+
+    # Returns a hash associating program memory symbol names (as Ruby symbols)
+    # to their addresses.
+    # @return (Hash)
+    def symbols_in_program_memory
+      @mplab_program_file.symbols_in_program_memory
+    end
+
+    # Returns a hash associating EEPROM memory symbol names (as Ruby symbols)
+    # to their addresses.
+    # @return (Hash)
+    def symbols_in_eeprom
+      @mplab_program_file.symbols_in_eeprom
     end
-    
+
     # Returns a hash associating program memory label names (as symbols) to their addresses.
     # @return (Hash)
     def labels
       @labels ||= begin
         hash = {}
-        @mplab_program_file.symbols_in_code_space.each do |name, address|
+        symbols_in_program_memory.each do |name, address|
           hash[name] = Label.new(name, address)
         end
         hash
@@ -50,7 +67,7 @@ module RPicSim
       if !label
         raise ArgumentError, message_for_label_not_found(name)
       end
-      return label
+      label
     end
 
     # Generates a friendly human-readable string description of the given address in
@@ -58,19 +75,19 @@ module RPicSim
     # @param address [Integer] An address in program memory.
     # @return [String]
     def address_description(address)
-      desc = address < 0 ? address.to_s : ("0x%04x" % [address])
+      desc = address < 0 ? address.to_s : ('0x%04x' % [address])
       reference_points = labels.values.reject { |label| label.address > address }
-      label = reference_points.max_by &:address
-      
+      label = reference_points.max_by(&:address)
+
       if label
         offset = address - label.address
-        desc << " = " + label.name.to_s
-        desc << "+%#x" % [offset] if offset != 0
+        desc << ' = ' + label.name.to_s
+        desc << '+%#x' % [offset] if offset != 0
       end
-      
-      return desc
+
+      desc
     end
-    
+
     # Gets an {Instruction} object representing the PIC instruction at the given
     # address in program memory.
     # @param address [Integer]
@@ -78,7 +95,7 @@ module RPicSim
     def instruction(address)
       @instructions[address] ||= make_instruction(address)
     end
-    
+
     private
     def message_for_label_not_found(name)
       message = "Cannot find label named '#{name}'."
@@ -87,74 +104,15 @@ module RPicSim
         name.to_s.start_with?(label_sym.to_s)
       end
       if !maybe_intended_labels.empty?
-        message << "  MPASM truncates labels.  You might have meant: " +
-                   maybe_intended_labels.join(", ") + "."
+        message << '  MPASM truncates labels.  You might have meant: ' +
+                   maybe_intended_labels.join(', ') + '.'
       end
       message
     end
 
     def make_instruction(address)
       mplab_instruction = @assembly.disassembler.disassemble(address)
-      
-      # Convert the increment, which is the number of bytes, into 'size',
-      # which is the same units as the flash address space.
-      if @address_increment == 1
-        # Non-PIC18 architectures: flash addresses are in terms of words
-        # so we devide by two to convert from bytes to words.
-        size = mplab_instruction.inc / 2
-      elsif @address_increment == 2
-        # PIC18 architecture: No change necessary because both are in terms
-        # of bytes.
-        size = mplab_instruction.inc
-      else
-        raise "Cannot handle address increment value of #{@address_increment}."
-      end
-
-      # TODO: add support for all other 8-bit PIC architectures
-      properties = Array case mplab_instruction.opcode
-      when 'ADDWF'
-      when 'ANDWF'
-      when 'CPFSEQ' then [:conditional_skip]
-      when 'CLRF'
-      when 'CLRW'
-      when 'COMF'
-      when 'DECF'
-      when 'DECFSZ' then [:conditional_skip]
-      when 'INCF'
-      when 'INCFSZ' then [:conditional_skip]
-      when 'IORWF'
-      when 'MOVWF'
-      when 'MOVF'
-      when 'NOP'
-      when 'RLF'
-      when 'RRF'
-      when 'SUBWF'
-      when 'SWAPF'
-      when 'XORWF'
-      when 'BCF'
-      when 'BSF'
-      when 'BTFSC'  then [:conditional_skip]
-      when 'BTFSS'  then [:conditional_skip]
-      when 'ADDLW'
-      when 'ANDLW'
-      when 'CALL'   then [:call]
-      when 'CLRWDT'
-      when 'GOTO'   then [:goto]
-      when 'IORLW'
-      when 'MOVLW'
-      when 'RETFIE' then [:return]
-      when 'RETLW'  then [:return]
-      when 'RETURN' then [:return]
-      when 'SLEEP'
-      when 'XORLW'
-      else
-        raise "Unrecognized opcode #{mplab_instruction.opcode} " +
-          "(#{address_description(address)}, operands #{mplab_instruction.operands.inspect})."
-      end
-      
-      Instruction.new(address, self, mplab_instruction.opcode,
-        mplab_instruction.operands, size, @address_increment,
-        mplab_instruction.instruction_string, properties)
+      Instruction.new(mplab_instruction, address, @address_increment, self)
     end
   end
-end
+end