origen_jtag 0.21.1 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f63bbad6eac9c0d88a2e7970a16d2746375a25575bbae735b2f2626a457ebf4
-  data.tar.gz: 8ba113303e5906a9da5c739663600828a57cb74a8953f0d1a967bb655848d6f1
+  metadata.gz: cc6050891bc69e2a38991157a3423a8765284b257a56d68c2fb87a8b5844f98b
+  data.tar.gz: 4e491ddb526412da9761cd1d5a6886a7a17a009e60ea2736db46365035cf94e2
 SHA512:
-  metadata.gz: 9488fbea2784700dd849ce1eff4c279ff413f7c006dbb358a3cdcd1e7a8955ce42851aea7873c2818eb20821ad3f181f74c556801e6540dec93ec00462f606b2
-  data.tar.gz: 37709e182313b91c0e4da8464a39e0161e5d89a287ed1eee632ebef60c744f22eb3b875b8a4262b97b15ac50ffb5944d522de2ec5aaa3e83ac5747b89f0fbd3d
+  metadata.gz: dbb5ac9d278793a4994d8a50079bb587f326186701ed760edc119824b899cb29bb0551693d4d8f7f72e7eaff2fefc2c7fd2e6fd4f4563ed2049b208f63b6b8a6
+  data.tar.gz: 93668e735cb0c23de2788bb6be7bb057a2e58a41bfff14a3a204de7c6a33f1ab6b2aaee427804869f62c9bf474fd888e6e82ab85ecf2b764a2f193c63db16f5d

data/config/version.rb

@@ -1,8 +1,7 @@
 module OrigenJTAG
   MAJOR = 0
-  MINOR = 21
-  BUGFIX = 1
+  MINOR = 22
+  BUGFIX = 2
   DEV = nil
-
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
 end

data/lib/origen_jtag/driver.rb

@@ -35,7 +35,8 @@ module OrigenJTAG
     alias_method :tclk_format, :tck_format
     alias_method :tclk_format=, :tck_format=
 
-    attr_reader :tdo_strobe
+    attr_accessor :tdo_strobe
+    attr_accessor :tdo_store_cycle
 
     # Set true to print out debug comments about all state transitions
     attr_accessor :verbose
@@ -57,7 +58,7 @@ module OrigenJTAG
       end
 
       @cycle_callback = options[:cycle_callback]
-      validate_pins(options) unless @cycle_callback
+      @given_options = options.dup  # Save these for later use in the pins method
 
       # Fallback defaults
       options = {
@@ -211,7 +212,7 @@ module OrigenJTAG
         overlay_options = {}
         if tester.respond_to?(:source_memory) && !cycle_callback?
           if ovl_reg[i] && ovl_reg[i].has_overlay? && !Origen.mode.simulation?
-            overlay_options[:pins] = @pins[:tdi]
+            overlay_options[:pins] = pins[:tdi]
             if global_ovl
               overlay_options[:overlay_str] = global_ovl
             else
@@ -280,7 +281,7 @@ module OrigenJTAG
                 overlay_options[:change_data] = false			# data change only on first cycle if overlay
               end
             end
-            @pins[:tdo].dont_care unless cycle_callback?
+            pins[:tdo].dont_care unless cycle_callback?
           else
             @deferred_compare = true
             @deferred_store = true if store_tdo_this_tck
@@ -323,7 +324,7 @@ module OrigenJTAG
 
         # If TDO is already suspended (by an application) then don't do the
         # suspends below since the resume will clear the application's suspend
-        tdo_already_suspended = !cycle_callback? && @pins[:tdo].suspended? && !@tdo_suspended_by_driver
+        tdo_already_suspended = !cycle_callback? && pins[:tdo].suspended? && !@tdo_suspended_by_driver
 
         @tck_multiple.times do |i|
           # 50% duty cycle if @tck_multiple is even, otherwise slightly off
@@ -332,26 +333,26 @@ module OrigenJTAG
 
           if i < (@tck_multiple + 1) / 2
             # first half of cycle
-            @pins[:tck].drive(@tck_vals ? @tck_vals[:on] : tck_val)
+            pins[:tck].drive(@tck_vals ? @tck_vals[:on] : tck_val)
             unless tdo_already_suspended
               if mask_tdo_half0
                 @tdo_suspended_by_driver = true
-                @pins[:tdo].suspend
+                pins[:tdo].suspend
               else
                 @tdo_suspended_by_driver = false
-                @pins[:tdo].resume
+                pins[:tdo].resume
               end
             end
           else
             # second half of cycle
-            @pins[:tck].drive(@tck_vals ? @tck_vals[:off] : (1 - tck_val))
+            pins[:tck].drive(@tck_vals ? @tck_vals[:off] : (1 - tck_val))
             unless tdo_already_suspended
               if mask_tdo_half1
                 @tdo_suspended_by_driver = true
-                @pins[:tdo].suspend
+                pins[:tdo].suspend
               else
                 @tdo_suspended_by_driver = false
-                @pins[:tdo].resume
+                pins[:tdo].resume
               end
             end
           end
@@ -359,7 +360,7 @@ module OrigenJTAG
         end
         if @tdo_suspended_by_driver
           @tdo_suspended_by_driver = false
-          @pins[:tdo].resume
+          pins[:tdo].resume
         end
       end
     end
@@ -415,7 +416,7 @@ module OrigenJTAG
           cc "#{options[:msg]}\n"
         end
         val = reg_or_val.respond_to?(:data) ? reg_or_val.data : reg_or_val
-        shift_dr(write: val.to_hex) do
+        shift_dr(options.merge(write: val.to_hex)) do
           shift(reg_or_val, options)
         end
       end
@@ -448,7 +449,7 @@ module OrigenJTAG
         if options[:msg]
           cc "#{options[:msg]}\n"
         end
-        shift_dr(read: Origen::Utility.read_hex(reg_or_val)) do
+        shift_dr(options.merge(read: Origen::Utility.read_hex(reg_or_val))) do
           shift(reg_or_val, options)
         end
       end
@@ -475,19 +476,19 @@ module OrigenJTAG
     #   a msg to be written out prior to shifting in IR data.  Will not write comment only if write
     #   occurs.
     def write_ir(reg_or_val, options = {})
-      if Origen.tester.respond_to?(:write_ir)
-        Origen.tester.write_ir(reg_or_val, options)
-      else
-        val = reg_or_val.respond_to?(:data) ? reg_or_val.data : reg_or_val
-        if val != ir_value || options[:force]
-          if options[:msg]
-            cc "#{options[:msg]}\n"
-          end
-          shift_ir(write: val.to_hex) do
+      val = reg_or_val.respond_to?(:data) ? reg_or_val.data : reg_or_val
+      if val != ir_value || options[:force]
+        if options[:msg]
+          cc "#{options[:msg]}\n"
+        end
+        if Origen.tester.respond_to?(:write_ir)
+          Origen.tester.write_ir(reg_or_val, options)
+        else
+          shift_ir(options.merge(write: val.to_hex)) do
             shift(reg_or_val, options)
           end
-          @ir_value = val
         end
+        @ir_value = val
       end
     end
 
@@ -548,10 +549,10 @@ module OrigenJTAG
         if cycle_callback?
           @owner.send(@cycle_callback, @actions, options)
         else
-          apply_action(@pins[:tms], @actions[:tms])
-          apply_action(@pins[:tdi], @actions[:tdi])
-          apply_action(@pins[:tdo], @actions[:tdo])
-          tester.store_next_cycle(@pins[:tdo]) if @actions[:store]
+          apply_action(pins[:tms], @actions[:tms])
+          apply_action(pins[:tdi], @actions[:tdi])
+          apply_action(pins[:tdo], @actions[:tdo])
+          tester.store_next_cycle(pins[:tdo]) if @actions[:store]
           tester.cycle(options)
         end
         clear_actions
@@ -665,30 +666,42 @@ module OrigenJTAG
       tdo
     end
 
-    # Validates that the parent object (the owner) has defined the necessary
-    # pins to implement the JTAG
-    def validate_pins(options)
-      @pins = {}
-      @pins[:tck] = options[:tck_pin]
-      @pins[:tdi] = options[:tdi_pin]
-      @pins[:tdo] = options[:tdo_pin]
-      @pins[:tms] = options[:tms_pin]
-
-      # Support legacy implementation where tck was incorrectly called tclk, in case of both being
-      # defined then :tck has priority
-      @pins[:tck] ||= @owner.pin(:tck) if @owner.has_pin?(:tck)
-      @pins[:tck] ||= @owner.pin(:tclk)
-      @pins[:tdi] ||= @owner.pin(:tdi)
-      @pins[:tdo] ||= @owner.pin(:tdo)
-      @pins[:tms] ||= @owner.pin(:tms)
+    def to_pin(pin_or_id)
+      if pin_or_id
+        if pin_or_id.is_a?(Symbol) || pin_or_id.is_a?(String)
+          @owner.pin(pin_or_id)
+        else
+          pin_or_id
+        end
+      end
+    end
+
+    def pins
+      @pins ||= begin
+        pins = {}
+        pins[:tck] = to_pin(@given_options[:tck_pin])
+        pins[:tdi] = to_pin(@given_options[:tdi_pin])
+        pins[:tdo] = to_pin(@given_options[:tdo_pin])
+        pins[:tms] = to_pin(@given_options[:tms_pin])
+
+        # Support legacy implementation where tck was incorrectly called tclk, in case of both being
+        # defined then :tck has priority
+        pins[:tck] ||= @owner.pin(:tck) if @owner.has_pin?(:tck)
+        pins[:tck] ||= @owner.pin(:tclk)
+        pins[:tdi] ||= @owner.pin(:tdi)
+        pins[:tdo] ||= @owner.pin(:tdo)
+        pins[:tms] ||= @owner.pin(:tms)
+
+        pins
+      end
     rescue
       puts 'Missing JTAG pins!'
       puts "In order to use the JTAG driver your #{owner.class} class must either define"
       puts 'the following pins (an alias is fine):'
       puts REQUIRED_PINS
       puts '-- or --'
-      puts 'Pass the pins in the initialization options:'
-      puts "sub_block :jtag, class_name: 'OrigenJTAG::Driver', tck_pin: dut.pin(:tck), tdi_pin: dut.pin(:tdi), tdo_pin: dut.pin(:tdo), tms_pin: dut.pin(:tms)"
+      puts 'Pass the pin IDs to be used instead in the initialization options:'
+      puts "sub_block :jtag, class_name: 'OrigenJTAG::Driver', tck_pin: :clk, tdi_pin: :gpio1, tdo_pin: :gpio2, tms_pin: :gpio3"
       raise 'JTAG driver error!'
     end
   end

data/lib/origen_jtag/tap_controller.rb

@@ -4,22 +4,22 @@ module OrigenJTAG
   module TAPController
     # Map of internal state symbols to human readable names
     STATES = {
-      reset:      'Test-Logic-Reset',
-      idle:       'Run-Test/Idle',
-      select_dr:  'Select-DR',
-      capture_dr: 'Capture-DR',
-      shift_dr:   'Shift-DR',
-      exit1_dr:   'Exit1-DR',
-      pause_dr:   'Pause-DR',
-      exit2_dr:   'Exit2-DR',
-      update_dr:  'Update-DR',
-      select_ir:  'Select-IR',
-      capture_ir: 'Capture-IR',
-      shift_ir:   'Shift-IR',
-      exit1_ir:   'Exit1-IR',
-      pause_ir:   'Pause-IR',
-      exit2_ir:   'Exit2-IR',
-      update_ir:  'Update-IR'
+      reset:          'Test-Logic-Reset',
+      idle:           'Run-Test/Idle',
+      select_dr_scan: 'Select-DR-Scan',
+      capture_dr:     'Capture-DR',
+      shift_dr:       'Shift-DR',
+      exit1_dr:       'Exit1-DR',
+      pause_dr:       'Pause-DR',
+      exit2_dr:       'Exit2-DR',
+      update_dr:      'Update-DR',
+      select_ir_scan: 'Select-IR-Scan',
+      capture_ir:     'Capture-IR',
+      shift_ir:       'Shift-IR',
+      exit1_ir:       'Exit1-IR',
+      pause_ir:       'Pause-IR',
+      exit2_ir:       'Exit2-IR',
+      update_ir:      'Update-IR'
     }
 
     # Returns the current state of the JTAG TAP Controller
@@ -50,11 +50,27 @@ module OrigenJTAG
     #   end
     #   # State is Run-Test/Idle
     def shift_dr(options = {})
-      validate_state(:idle, :pause_dr)
+      options = {
+        start_state: :idle,   # Allowed start states: :idle, :select_dr_scan, :update_ir, :update_dr
+        end_state:   :idle    # Allowed end states: :idle, :update_dr
+      }.merge(options)
+
+      if options[:start_state] == :idle  # allow for pause_dr state also if called from pause_dr block
+        validate_state(:idle, :pause_dr)
+      elsif options[:state_state] == :select_dr_scan
+        validate_state(:select_dr_scan, :pause_dr)
+      elsif options[:state_state] == :update_dr
+        validate_state(:update_dr, :pause_dr)
+      elsif options[:state_state] == :update_ir
+        validate_state(:update_ir, :pause_dr)
+      end
       log 'Transition to Shift-DR...'
-      if state == :idle
-        tms!(1)  # => Select-DR-Scan
-        update_state :select_dr_scan
+      if state == :idle || state == :select_dr_scan || state == :update_ir || state == :update_dr
+        # Non-pause states
+        unless state == :select_dr_scan
+          tms!(1)  # => Select-DR-Scan
+          update_state :select_dr_scan
+        end
         tms!(0)  # => Capture-DR
         update_state :capture_dr
         tms!(0)  # => Shift-DR
@@ -78,8 +94,10 @@ module OrigenJTAG
         end
         tms!(1)  # => Update-DR
         update_state :update_dr
-        tms!(0)  # => Run-Test/Idle
-        update_state :idle
+        if options[:end_state] == :idle
+          tms!(0)  # => Run-Test/Idle
+          update_state :idle
+        end
       else # :pause_dr
         tms!(1)  # => Exit2-DR
         update_state :exit2_dr
@@ -175,13 +193,23 @@ module OrigenJTAG
     #   end
     #   # State is Run-Test/Idle
     def shift_ir(options = {})
-      validate_state(:idle, :pause_ir)
+      options = {
+        start_state: :idle,   # Allowed start states: :idle, :select_ir_scan
+        end_state:   :idle    # Allowed end states: :idle, :update_ir, :select_dr_scan
+      }.merge(options)
+      if options[:start_state] == :idle
+        validate_state(:idle, :pause_ir)
+      else
+        validate_state(:select_ir_scan, :pause_ir)
+      end
       log 'Transition to Shift-IR...'
-      if state == :idle
-        tms!(1)  # => Select-DR-Scan
-        update_state :select_dr_scan
-        tms!(1)  # => Select-IR-Scan
-        update_state :select_ir_scan
+      if state == :idle || state == :select_ir_scan
+        unless state == :select_ir_scan
+          tms!(1)  # => Select-DR-Scan
+          update_state :select_dr_scan
+          tms!(1)  # => Select-IR-Scan
+          update_state :select_ir_scan
+        end
         tms!(0)  # => Capture-IR
         update_state :capture_ir
         tms!(0)  # => Shift-IR
@@ -195,7 +223,13 @@ module OrigenJTAG
         end
         log msg, always: true do
           yield
-          log 'Transition to Run-Test/Idle...'
+          if options[:end_state] == :idle
+            log 'Transition to Run-Test/Idle...'
+          elsif options[:end_state] == :update_ir
+            log 'Transition to Update-IR...'
+          elsif options[:end_state] == :select_dr_scan
+            log 'Transition to Select-DR-Scan...'
+          end
           if @last_data_vector_shifted
             @last_data_vector_shifted = false
           else
@@ -205,8 +239,13 @@ module OrigenJTAG
         end
         tms!(1)  # => Update-IR
         update_state :update_ir
-        tms!(0)  # => Run-Test/Idle
-        update_state :idle
+        if options[:end_state] == :idle
+          tms!(0)  # => Run-Test/Idle
+          update_state :idle
+        elsif options[:end_state] == :select_dr_scan
+          tms!(1)  # => Select-DR-Scan
+          update_state :select_dr_scan
+        end
       else # :pause_ir
         tms!(1)  # => Exit2-IR
         update_state :exit2_ir

data/lib/origen_jtag_dev/new_style.rb

@@ -30,7 +30,8 @@ module OrigenJTAGDev
       instantiate_pins(options)
       sub_block :jtag, { class_name: 'OrigenJTAG::Driver' }.merge(@jtag_config)
       if options[:extra_port]
-        sub_block :jtag2, { class_name: 'OrigenJTAG::Driver', tck_pin: pin(:tck_2), tdi_pin: pin(:tdi_2), tdo_pin: pin(:tdo_2), tms_pin: pin(:tms_2) }.merge(@jtag_config)
+        # Test supplying both pin IDs (recommended) and pin objects (legacy)
+        sub_block :jtag2, { class_name: 'OrigenJTAG::Driver', tck_pin: :tck_2, tdi_pin: :tdi_2, tdo_pin: pin(:tdo_2), tms_pin: pin(:tms_2) }.merge(@jtag_config)
       end
     end
 

data/pattern/full_reg_subr_overlay.rb

@@ -0,0 +1,26 @@
+Pattern.create do
+  def test(msg)
+    ss "Test - #{msg}"
+  end
+
+  jtag = $dut.jtag
+  reg16 = $dut.reg(:test16)
+  reg32 = $dut.reg(:test32)
+
+
+  test 'Shift register into TDI with overlay'
+
+
+  cc 'Full register (16 bits)'
+  reg16.overlay('write_overlay16')
+  reg16.write!
+#  tester.cycle  # Give a padding cycle as a place for the subroutine call to go
+#  jtag.shift reg, cycle_last: true
+
+  cc 'Full register with additional size (32 bits)'
+  reg32.overlay('write_overlay32')
+  reg32.write!
+#  tester.cycle  # Give a padding cycle as a place for the subroutine call to go
+#  jtag.shift reg, cycle_last: true, size: 32
+
+end

data/pattern/jtag_workout.rb

@@ -193,7 +193,13 @@ Pattern.create(options = { name: pat_name }) do
 
   test 'Unless forced'
   jtag.write_ir 0xF, size: 4, force: true
- 
+
+  test 'Write IR, starting with Idle, leave in Select-DR-Scan state'
+  jtag.write_ir(0x7, size: 8, end_state: :select_dr_scan, force: true)
+
+  test 'Write DR starting with Select-DR-Scan state, end with Idle'
+  jtag.write_dr(0x12345678, size: 32, start_state: :select_dr_scan)
+
   test 'Reset'
   jtag.reset
 

data/pattern/overlay_subr.rb

@@ -0,0 +1,56 @@
+Pattern.create do
+  def test(msg)
+    ss "Test - #{msg}"
+  end
+
+  def subroutine(name, options = {})
+    options = {
+      compress:  false,
+    }.merge(options)
+    
+    tester.start_subroutine(name)
+#    $tester.set_timeset('intram', 40)
+#    $dut.init_pins_for_first_vector
+#    $dut.pin(:RESET_B).drive(1)
+#    $dut.pin(:JTAG_TRST_B).drive(1)
+
+
+    if options[:compress]
+      yield options
+    else
+      tester.dont_compress do
+        yield options
+      end
+    end
+    tester.end_subroutine(options)
+  end
+  def write_partial(thing_to_shift, options = {})
+    options = {
+      read:             false,
+      length:           false,     # Set to the number of bits you want to shift when supplying a data value
+      includes_last_bit: false,
+      cycle_last:       true
+    }.merge(options)
+
+    dut.jtag.shift thing_to_shift, size: options[:length], cycle_last: options[:cycle_last], includes_last_bit: options[:includes_last_bit], read: options[:read]
+  end
+
+
+  jtag = $dut.jtag
+  reg16 = $dut.reg(:test16)
+  reg32 = $dut.reg(:test32)
+
+  test 'Shift register into TDI with overlay'
+
+  subroutine 'write_overlay16' do
+#    write_partial(0, length: 16, includes_last_bit: true)
+    dut.jtag.shift 0, size: 16, cycle_last: true, includes_last_bit: true, read: false
+  end
+
+  subroutine 'write_overlay32' do
+#    write_partial(5, length: 32, includes_last_bit: true)
+    dut.jtag.shift 0, size: 32, cycle_last: true, includes_last_bit: false
+  end
+
+
+end

data/templates/web/index.md.erb

@@ -89,10 +89,10 @@ class MyApp::MyDUT
                      tck_multiple:      2,
                      tdo_strobe:        :tck_high,
                      tdo_store_cycle:   1,
-                     tck_pin:           pin(:tck2),
-                     tdi_pin:           pin(:tdi2),
-                     tdo_pin:           pin(:tdo2),
-                     tms_pin:           pin(:tms2)
+                     tck_pin:           :tck2,
+                     tdi_pin:           :tdi2,
+                     tdo_pin:           :tdo2,
+                     tms_pin:           :tms2
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_jtag
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.2
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -62,8 +62,10 @@ files:
 - lib/origen_jtag_dev/serial.rb
 - lib/origen_jtag_dev/top_level.rb
 - pattern/full_reg_ovly_cap.rb
+- pattern/full_reg_subr_overlay.rb
 - pattern/global_label_test.rb
 - pattern/jtag_workout.rb
+- pattern/overlay_subr.rb
 - pattern/rww_test.rb
 - pattern/two_port.rb
 - templates/web/index.md.erb
@@ -89,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: JTAG driver for the Origen SDK