origen_jtag 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f14027c16a759a2b51fa2b30d9f33cd7447f0a8b
-  data.tar.gz: 8e4c8ebb8dbc3fa97c1955a395ba478b4f2f20a1
+  metadata.gz: cb7c96360f9c37b9ee800ddeba73ade40d00ecfe
+  data.tar.gz: 40a8cfbd5ff79aa405b8bdb5a9fa619d0e1eae05
 SHA512:
-  metadata.gz: 874db41442a09c7c2ef8a9b6be7fcd2bdfe04da00e6a647af268da54bda9d41b5c69d609e639b0928bf4e0acb8b14eb1304ec734fffb2ac05070bfb13e5ed573
-  data.tar.gz: 2af49cdfdc543a9e1fa0a105dbb7b674aba124034aad6bf1398a89393cd8756f58befc8a247b9bca458a0422e85baaa0c56b942a7870412d16dc64df5967c5b2
+  metadata.gz: cd920d9c30fc4041ff89acba0ab793a2ea2a06e5093cae3582ab470817325c861d40d8e0c133da8f89ad4646e27fff7352c99d5d64708bdb2bdb84a52a5ea4b4
+  data.tar.gz: 26ff839dd8cb0c2a121b751727031310236502c4f11e2b0497e3399c585d567a684b2701b7c6296312d837ad26fddc3bd21d128bf12c0084c4d10855dc85d426

data/config/commands.rb

@@ -27,66 +27,72 @@ when "examples", "test"
   status = 0
 
   # Pattern generator tests
-  ARGV = %w(jtag_workout -t debug_RH1 -e v93k -r approved)
+  ARGV = %w(jtag_workout -t RH1.rb -e v93k -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t debug_RH1 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t RH1.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t debug_RL1 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t RL1.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(jtag_workout -t debug_RH2.rb -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t RH2.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t debug_RH2_1.rb -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t RH2_1.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(jtag_workout -t debug_RH4 -e v93k -r approved)
+  ARGV = %w(jtag_workout -t RH4.rb -e v93k -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t debug_RH4 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t RH4.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t debug_RL4 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t RL4.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
   
-  ARGV = %w(rww_test -t debug_RH4 -e j750.rb -r approved)
+  ARGV = %w(rww_test -t RH4.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(global_label_test -t debug_RH1 -e j750.rb -r approved)
+  ARGV = %w(global_label_test -t RH1.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(full_reg_ovly_cap -t debug_RH4 -e uflex.rb -r approved)
+  ARGV = %w(full_reg_ovly_cap -t RH4.rb -e uflex.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
   # Pattern generator tests -- confirm sub_block instanced jtag gives same results
-  ARGV = %w(jtag_workout -t new_style_RH1 -e v93k -r approved)
+  ARGV = %w(jtag_workout -t new_RH1 -e v93k -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t new_style_RH1 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t new_RH1 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t new_style_RL1 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t new_RL1 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(jtag_workout -t new_style_RH2.rb -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t new_RH2.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t new_style_RH2_1.rb -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t new_RH2_1.rb -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(jtag_workout -t new_style_RH4 -e v93k -r approved)
+  ARGV = %w(jtag_workout -t new_RH4 -e v93k -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t new_style_RH4 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t new_RH4 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
-  ARGV = %w(jtag_workout -t new_style_RL4 -e j750.rb -r approved)
+  ARGV = %w(jtag_workout -t new_RL4 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(rww_test -t new_style_RH4 -e j750.rb -r approved)
+  ARGV = %w(rww_test -t new_RH4 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(global_label_test -t new_style_RH1 -e j750.rb -r approved)
+  ARGV = %w(global_label_test -t new_RH1 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
-  ARGV = %w(full_reg_ovly_cap -t new_style_RH4 -e uflex.rb -r approved)
+  ARGV = %w(full_reg_ovly_cap -t new_RH4 -e uflex.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
   ARGV = %w(two_port -t new_2port_RH4 -e j750.rb -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
 
+  ARGV = %w(jtag_workout -t new_P1 -e v93k -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
+
+  ARGV = %w(jtag_workout -t new_P4 -e v93k -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
+
   if Origen.app.stats.changed_files == 0 &&
      Origen.app.stats.new_files == 0 &&
      Origen.app.stats.changed_patterns == 0 &&

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenJTAG
   MAJOR = 0
-  MINOR = 18
+  MINOR = 19
   BUGFIX = 0
   DEV = nil
 

data/lib/origen_jtag/driver.rb

@@ -71,6 +71,12 @@ module OrigenJTAG
       @tdo_store_cycle = options[:tdo_store_cycle]
       @state = options[:init_state]
       @log_state_changes = options[:log_state_changes] || false
+      if options[:tclk_vals]
+        @tclk_vals = options[:tclk_vals]
+        unless @tclk_vals.is_a?(Hash) && @tclk_vals.key?(:on) && @tclk_vals.key?(:off)
+          fail "When specifying TCLK values, you must supply a hash with both :on and :off keys, e.g. tclk_vals: { on: 'P', off: 0 }"
+        end
+      end
     end
 
     # Shift data into the TDI pin or out of the TDO pin.
@@ -291,7 +297,7 @@ module OrigenJTAG
 
         if i < (@tclk_multiple + 1) / 2
           # first half of cycle
-          @tck_pin.drive(tclk_val)
+          @tck_pin.drive(@tclk_vals ? @tclk_vals[:on] : tclk_val)
           unless tdo_already_suspended
             unless tdo_to_be_captured
               if mask_tdo_half0
@@ -305,7 +311,7 @@ module OrigenJTAG
           end
         else
           # second half of cycle
-          @tck_pin.drive(1 - tclk_val)
+          @tck_pin.drive(@tclk_vals ? @tclk_vals[:off] : (1 - tclk_val))
           unless tdo_already_suspended
             unless tdo_to_be_captured
               if mask_tdo_half1

data/lib/origen_jtag_dev/new_style.rb

@@ -23,6 +23,7 @@ module OrigenJTAGDev
       @jtag_config[:tdo_strobe] = options[:tdo_strobe] if options[:tdo_strobe]
       @jtag_config[:tdo_store_cycle] = options[:tdo_store_cycle] if options[:tdo_store_cycle]
       @jtag_config[:init_state] = options[:init_state] if options[:init_state]
+      @jtag_config[:tclk_vals] = options[:tclk_vals] if options[:tclk_vals]
 
       instantiate_registers(options)
       instantiate_pins(options)
@@ -80,6 +81,11 @@ module OrigenJTAGDev
       @jtag_config[:tclk_multiple]
     end
 
+    # Getter for top-level tclk_vals setting
+    def tclk_vals
+      @jtag_config[:tclk_vals]
+    end
+
     # Getter for top-level tdo_strobe setting
     def tdo_strobe
       @jtag_config[:tdo_strobe]

data/pattern/jtag_workout.rb

@@ -1,5 +1,6 @@
 pat_name = "jtag_workout_#{$dut.tclk_format.upcase}#{$dut.tclk_multiple}"
 pat_name = pat_name + "_#{dut.tdo_store_cycle}" if dut.tdo_store_cycle != 0
+pat_name += "_tclk_vals" if dut.try(:tclk_vals)
 
 Pattern.create(options = { name: pat_name }) do
   def test(msg)

data/templates/web/index.md.erb

@@ -88,6 +88,16 @@ dut.jtag                # => jtag driver for the first port (tclk, tdi, tdo, tms
 dut.jtag_port2          # => jtag driver for the second port (tck2, tdi2, tdo2, tms2)
 ~~~
 
+By default, the driver will apply the conventional '1' and '0' drive values on the TCK pin to turn
+the clock on and off, however
+this can be overridden by supplying the `:tclk_vals` option as shown in the example below:
+
+~~~ruby
+# My V93K timing setup uses 'P' to enable a clock pulse instead of '1'
+tclk_vals: { on: 'P', off: 0 }
+~~~
+
+
 #### Legacy Example
 
 Include the <code>OrigenJTAG</code> module to add a JTAG driver to your class and

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_jtag
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -67,7 +67,6 @@ files:
 - pattern/rww_test.rb
 - pattern/two_port.rb
 - templates/web/index.md.erb
-- templates/web/index.md.erb~
 - templates/web/layouts/_basic.html.erb
 - templates/web/partials/_navbar.html.erb
 - templates/web/release_notes.md.erb
@@ -90,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: JTAG driver for the Origen SDK

data/templates/web/index.md.erb~

@@ -1,233 +0,0 @@
-% render "layouts/basic.html" do
-
-%# HTML tags can be embedded in mark down files if you want to do specific custom
-%# formatting like this, but in most cases that is not required.
-<h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
-
-### Purpose
-
-This plugin provides an ATE driver for an IEEE 1149.1 compliant JTAG interface.
-
-It makes no assumptions about the instruction or data register attributes or higher
-level protocol concerns. For use at DUT model level this plugin would be normally be wrapped in
-a higher level protocol such as [Nexus](http://origen-sdk.org/nexus/).
-
-### How To Import
-
-In your Gemfile add:
-
-~~~ruby
-gem "origen_jtag", ">= <%= Origen.app.version %>"
-~~~
-
-or if your application is a plugin add this to your <code>.gemspec</code>
-
-~~~ruby
-spec.add_development_dependency "origen_jtag", ">= <%= Origen.app.version %>"
-~~~
-
-__NOTE:__ You will also need to include <code>require 'origen_jtag'</code> somewhere in your environment.  This can be done in <code>config/environment.rb</code> for example.
-
-### How To Use
-
-#### New Style Example
-
-The driver no longer requires specific pin names (or aliases), supports sub_block instantiation and DUTs with multiple JTAG ports.
- You are no longer required to include "OrigenJTAG" in your DUT class.
-
-Here is an example integration:
-
-~~~ruby
-class Pioneer
-
-  include Origen::TopLevel
-
-  # TCK covers 4 tester cycles, 2 high then 2 low for each effective TCK pulse
-  # Strobe TDO only when TCK high.  Only store TDO on last cycle (3)
-  JTAG_CONFIG = {
-    :tclk_format => :rl,
-    :tclk_multiple => 4,
-    :tdo_strobe => :tclk_high,
-    :tdo_store_cycle => 3,
-  }
-
-  def initialize
-    add_pin :tclk
-    add_pin :tdi
-    add_pin :tdo
-    add_pin :tms
-
-    add_pin :tck2
-    add_pin :tdi2
-    add_pin :tdo2
-    add_pin :tms2
-
-
-    # In this first instance TCK covers 4 tester cycles,
-    # 2 high then 2 low for each effective TCK pulse.
-    # Strobe TDO only when TCK high.  Only store TDO on last cycle (3)
-
-    # several pluggins use dut.jtag, your default port driver should be named jtag for compatibility
-    sub_block :jtag, class_name: 'OrigenJTAG::Driver',
-                     tclk_format:       :rl,
-                     tclk_multiple:     4,
-                     tdo_strobe:        :tclk_high,
-                     tdo_store_cycle:   3,
-                     tck_pin:           pin(:tclk),
-                     tdi_pin:           pin(:tdi),
-                     tdo_pin:           pin(:tdo),
-                     tms_pin:           pin(:tms)
-
-    # create a driver for a 2nd port like this
-    # note different configuration settings can be used
-    sub_block :jtag_port2, class_name: 'OrigenJTAG::Driver',
-                     tclk_format:       :rh,
-                     tclk_multiple:     2,
-                     tdo_strobe:        :tclk_high,
-                     tdo_store_cycle:   1,
-                     tck_pin:           pin(:tck2),
-                     tdi_pin:           pin(:tdi2),
-                     tdo_pin:           pin(:tdo2),
-                     tms_pin:           pin(:tms2)
-  end
-
-end
-
-dut.jtag                # => jtag driver for the first port (tclk, tdi, tdo, tms)
-dut.jtag_port2          # => jtag driver for the second port (tck2, tdi2, tdo2, tms2)
-~~~
-
-#### Legacy Example
-
-Include the <code>OrigenJTAG</code> module to add a JTAG driver to your class and
-define the required pins.
-Normally the pins would be an alias to existing DUT pins and therefore the
-JTAG driver module cannot assume them.
-
-Including the module adds a <code>jtag</code> method which will return an instance of
-[<code>OrigenJTAG::Driver</code>](<%= path "api/OrigenJTAG/Driver.html" %>).
-
-The following attributes can be customized by defining a <code>JTAG_CONFIG</code>
-hash:
-
-* **tclk_format** - TCLK timing format,  Return High (:rh) or Return Low (:rl). Default is :rh.
-* **tclk_multiple** - Number of cycles for a single TCLK pulse to cover, to support cases where TCLK needs to be a fraction of another clock period. Assumes 50% duty cycle, specify only even numbers if > 1. Default is :r1.
-* **tdo_strobe** - When using multiple cycles for TCK, which state of TCK to strobe for TDO, :tclk_high or :tclk_low or :tclk_all. Default :tclk_high.
-* **tdo_store_cycle** - When using multiple cycles for TCK, which cycle of TCK to store for TDO if store requested (0 to number of tclk_multiple-1). Default 0
-
-Here is an example integration:
-
-~~~ruby
-class Pioneer
-
-  include OrigenJTAG
-  include Origen::Pins
-
-  # TCK covers 4 tester cycles, 2 high then 2 low for each effective TCK pulse
-  # Strobe TDO only when TCK high.  Only store TDO on last cycle (3)
-  JTAG_CONFIG = {
-    :tclk_format => :rl,
-    :tclk_multiple => 4,
-    :tdo_strobe => :tclk_high,
-    :tdo_store_cycle => 3,
-  }
-
-  def initialize
-    add_pin :tclk
-    add_pin :tdi
-    add_pin :tdo
-    add_pin :tms
-  end
-
-end
-
-Pioneer.new.jtag  # => An instance of OrigenJTAG::Driver
-~~~
-
-#### APIs
-
-Two APIs are provided, the primary one provides canned methods to read and
-write to the IR and DR registers.
-
-These accept either an absolute data value or an Origen register/bit collection.
-
-~~~ruby
-jtag.write_dr 0x1234, :size => 16
-
-# The size option is not required when a register is supplied
-jtag.write_dr $dut.reg(:clkdiv)
-
-# Although it can still be added if the register is not the full data width
-jtag.write_dr $dut.reg(:clkdiv), :size => 32
-
-# A rich read method is available which supports bit-level read, store and overlay operations
-$dut.reg(:clkdiv).bits(:div).read(0x55)
-jtag.read $dut.reg(:clkdiv)
-
-# In cases where both shift in (TDI) and shift out data (TDO) are critical, (e.g. compare shift
-#  out data on a write, or shfit in specific data on a read) the shift_in_data and 
-#  shift_out_data options can be specified.  By default, TDO will be dont care on writes
-#  and TDI will be 0 on reads.
-jtag.write_dr $dut.reg(:clkdiv), :shift_out_data => 0x4321
-jtag.read_dr $udt.reg(:clkdiv), :shift_in_data => 0x5678
-
-# Similar methods exist for the instruction register
-jtag.write_ir 0x1F, :size => 5
-jtag.read_ir 0x1F, :size => 5
-~~~
-
-A secondary API provides low level control of the TAP Controller state machine.
-
-~~~ruby
-jtag.pause_dr do
-  jtag.shift_dr do
-    # The shift method accepts the same arguments as the canned read/write methods
-    jtag.shift 0x55, :size => 32
-  end
-end
-~~~
-
-See the [<code>OrigenJTAG::Driver</code>](<%= path "api/OrigenJTAG/Driver.html" %>) and
-[<code>OrigenJTAG::TAPController</code>](<%= path "api/OrigenJTAG/TAPController.html" %>)
-APIs for more details about the available driver methods.
-
-Any model/controller within a target runtime environment can listen out for JTAG state
-changes by implementing the following callback handler:
-
-~~~ruby
-def on_jtag_state_change(new_state)
-  if new_state == :update_dr
-    # Do something every time we enter this state
-  end
-end
-~~~
-
-
-### How To Setup a Development Environment
-
-[Clone the repository from Github](https://github.com/Origen-SDK/origen_jtag).
-
-An instance of the OrigenJTAG driver is hooked up to a dummy DUT
-object for use in the console:
-
-~~~
-origen i
-
-> $dut.jtag
-=> #<OrigenJTAG::Driver:0x0000001ee48e78>
-~~~
-
-Follow the instructions here if you want to make a 3rd party app
-workspace use your development copy of the OrigenJTAG plugin:
-[Setting up a Plugin Development Environment](http://origen-sdk.org/origen/latest/guides/plugins)
-
-This plugin also contains a test suite, makes sure this passes before committing
-any changes!
-
-~~~
-origen examples
-~~~
-
-<%= disqus_comments %>
-
-% end