origen_arm_debug 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45cc30ad35c5f7785831b3fa516ce4784e43170ccc21229d5d6744adaa7f08fb
-  data.tar.gz: 3962dec63e6fcdc94de242557b36a34472f152ded5d95a1354e16e61fc04af10
+  metadata.gz: aa3ce5cc5d92d65c765cba5bf48f02427fe30335c55dc5b9674e222735f6d923
+  data.tar.gz: 71eb47e71ed6b5f3523fc256b0e3078a6d5745d236a18dedb8cc46d49df5ff21
 SHA512:
-  metadata.gz: a2060517cd1db17b6ef02d89355c0816f9ebe422b03277dc5a7783bb2cb4bca0ebb6aa795e8e6926800bdbd524ec5d9cc1565ded06ed75626ee4fb130dfe991f
-  data.tar.gz: 78a07d7c55c782ee78b025c20b3caf30956f8a550229479c53b53e6b0049f1fe1cb32525e8fbafd44d69ba691ff7d05e7c87d0e5f0747b786af6268394cf3a2e
+  metadata.gz: 251da1812e326e442c2348d44a5e75916f8f8d8dfe44268124bf394af5f5fea131071bf14f2c839baf6a8be8a972bacb4a5e366b7dea214256221fb6ba05e6de
+  data.tar.gz: f33584da53ac0b6e8bbc82e3102bd5de12424f2e3eea33e9b8d554234c16cabb1f6fdf7631061c64945b531792b470dc2fc5c9c0f60a3176a7a18d8d65d8ae71

data/config/boot.rb

@@ -5,3 +5,4 @@ require "origen_arm_debug_dev/dut_jtag"
 require "origen_arm_debug_dev/dut_swd"
 require "origen_arm_debug_dev/dut_dual_dp"
 require "origen_arm_debug_dev/dut_jtag_axi"
+require "origen_arm_debug_dev/dut_jtag_axi_ack.rb"

data/config/commands.rb

@@ -32,6 +32,8 @@ when "examples", "test"
   load "#{Origen.top}/lib/origen/commands/generate.rb"
   ARGV = %w(v6_workout -t jtag_axi.rb -e j750 -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
+  ARGV = %w(v6_workout -t jtag_ack.rb -e j750 -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
   ARGV = %w(workout -t swd -e j750 -r approved)
   load "#{Origen.top}/lib/origen/commands/generate.rb"
   ARGV = %w(workout -t dual_dp -e j750 -r approved)

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenARMDebug
   MAJOR = 1
-  MINOR = 3
+  MINOR = 4
   BUGFIX = 0
   DEV = nil
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen_arm_debug/dap.rb

@@ -55,6 +55,7 @@ module OrigenARMDebug
           if klass.nil? || addr.nil?
             fail "[ARM DEBUG] Error: Must specify class_name and base_address if using 'aps' hash to define APs"
           end
+
           ap_opts = { class_name: klass, base_address: addr }.merge(opts)
         else
           fail "[ARM DEBUG] Error: Must specify class_name and base_address if using 'aps' hash to define APs"

data/lib/origen_arm_debug/dap_controller.rb

@@ -3,6 +3,7 @@ module OrigenARMDebug
     include Origen::Controller
     include Helpers
 
+    # rubocop:disable Lint/DuplicateMethods
     attr_accessor :dp
 
     # Returns the currently enabled DP (or the only DP if only one
@@ -12,6 +13,7 @@ module OrigenARMDebug
     def dp
       @dp ||= dps.first
     end
+    # rubocop:enable Lint/DuplicateMethods
 
     def set_dp(dp)
       if dps.size > 1

data/lib/origen_arm_debug/helpers.rb

@@ -14,6 +14,7 @@ module OrigenARMDebug
       return addr if addr
       return reg_or_val.address if reg_or_val.respond_to?('address')
       return reg_or_val.addr if reg_or_val.respond_to?('addr')
+
       fail 'No address given, if supplying a data value instead of a register object, you must supply an :address option'
     end
 

data/lib/origen_arm_debug/jtag_dp.rb

@@ -2,7 +2,7 @@ module OrigenARMDebug
   class JTAG_DP
     include Origen::Model
 
-    attr_reader :dpacc_select, :apacc_select
+    attr_reader :dpacc_select, :apacc_select, :read_ack
 
     def initialize(options = {})
       options = {
@@ -14,6 +14,14 @@ module OrigenARMDebug
       }.merge(options)
       @dpacc_select = options[:dpacc_select]
       @apacc_select = options[:apacc_select]
+      # the acknowledge signature is LHL (2), but allow an override
+      if options[:read_ack]
+        if options[:read_ack] == true
+          @read_ack = 2
+        else
+          @read_ack = options[:read_ack]
+        end
+      end
       add_reg :ir, 0, size: options[:ir_size]
 
       # Virtual reg used to represent all of the various 35-bit scan chains

data/lib/origen_arm_debug/jtag_dp_controller.rb

@@ -92,6 +92,7 @@ module OrigenARMDebug
               # Part 2 - Now read real data from RDBUFF (DP-Reg)
               dr.reset
               dr.overlay(nil)
+              # Should compare of ack be added here as well?
               dr[0].write(1)
               dr[2..1].write(rdbuff.offset >> 2)
               dr[34..3].copy_all(reg)
@@ -129,10 +130,21 @@ module OrigenARMDebug
         # Part 2 - Now read real data from RDBUFF (DP-Reg)
         dr.reset
         dr.overlay(nil)
-        dr[0].write(1)
-        dr[2..1].write(rdbuff.offset >> 2)
+
+        read_ack = options[:read_ack] || model.read_ack
+        if read_ack
+          # Add in check of acknowledge bits (confirms the operation completed)
+          dr[2..0].read read_ack
+        else
+          # Default previous behavior is to mask, no way to know if the operation successfully completed
+          dr[0].write(1)
+          dr[2..1].write(rdbuff.offset >> 2)
+        end
         dr[34..3].copy_all(reg)
-        options[:mask] = options[:mask] << 3 unless options[:mask].nil?
+        unless options[:mask].nil?
+          options[:mask] = options[:mask] << 3
+          options[:mask] += 7 if read_ack
+        end
         ir.write!(dpacc_select)
         dut.jtag.read_dr(dr, options)
       end

data/lib/origen_arm_debug/jtag_dp_v6.rb

@@ -2,7 +2,7 @@ module OrigenARMDebug
   class JTAG_DPV6
     include Origen::Model
 
-    attr_reader :dpacc_select, :apacc_select
+    attr_reader :dpacc_select, :apacc_select, :read_ack
 
     def initialize(options = {})
       options = {
@@ -14,6 +14,14 @@ module OrigenARMDebug
       }.merge(options)
       @dpacc_select = options[:dpacc_select]
       @apacc_select = options[:apacc_select]
+      # the acknowledge signature is HLL (4), but allow an override
+      if options[:read_ack]
+        if options[:read_ack] == true
+          @read_ack = 4
+        else
+          @read_ack = options[:read_ack]
+        end
+      end
       add_reg :ir, 0, size: options[:ir_size]
 
       # Virtual reg used to represent all of the various 35-bit scan chains

data/lib/origen_arm_debug/jtag_dp_v6_controller.rb

@@ -122,10 +122,21 @@ module OrigenARMDebug
         # Part 2 - Now read real data from RDBUFF (DP-Reg)
         dr.reset
         dr.overlay(nil)
-        dr[0].write(1)
-        dr[2..1].write(rdbuff.offset >> 2)
+
+        read_ack = options[:read_ack] || model.read_ack
+        if read_ack
+          # Add in check of acknowledge bits (confirms the operation completed)
+          dr[2..0].read read_ack
+        else
+          # Default previous behavior is to mask, no way to know if the operation successfully completed
+          dr[0].write(1)
+          dr[2..1].write(rdbuff.offset >> 2)
+        end
         dr[34..3].copy_all(reg)
-        options[:mask] = options[:mask] << 3 unless options[:mask].nil?
+        unless options[:mask].nil?
+          options[:mask] = options[:mask] << 3
+          options[:mask] += 7 if read_ack
+        end
         ir.write!(dpacc_select)
         dut.jtag.read_dr(dr, options)
       end

data/lib/origen_arm_debug.rb

@@ -1,5 +1,5 @@
 require 'origen'
-require_relative '../config/application.rb'
+require_relative '../config/application'
 require 'origen_jtag'
 require 'origen_swd'
 

data/lib/origen_arm_debug_dev/dut_jtag_axi_ack.rb

@@ -0,0 +1,51 @@
+module OrigenARMDebugDev
+  # Simple JTAG-specific dut model that inherits from protocol-agnostic DUT model
+  class JTAG_AXI_ACK_DUT < DUT
+    include OrigenJTAG
+
+    # Adds jtag-required pins to the simple dut model
+    # Returns nothing.
+    def initialize(options = {})
+      super
+      add_pin :tclk
+      add_pin :tdi
+      add_pin :tdo
+      add_pin :tms
+      add_pin :trst
+      add_pin :swd_clk
+      add_pin :swd_dio
+
+      options[:class_name] = 'OrigenARMDebug::DAP'
+      options[:mem_aps] = {
+        mem_ap: {
+          base_address:      0x00000000,
+          latency:           16,
+          apreg_access_wait: 8,
+          apmem_access_wait: 8,
+          is_axi:            true,
+          csw_reset:         0x1080_6002
+        },
+        mdm_ap: 0x01000000
+      }
+      options[:dp_select_reset] = 0xC2_0D00
+      options[:read_ack] = true
+      # Specify (customize) ARM Debug implementation details
+      sub_block :arm_debug, options
+
+      options[:dapv6] = true
+      options[:class_name] = 'OrigenARMDebug::DAP'
+      options[:mem_aps] = {
+        mem_ap: {
+          base_address:      0x00C2_0000,
+          latency:           16,
+          apreg_access_wait: 8,
+          apmem_access_wait: 8,
+          is_axi:            true,
+          csw_reset:         0x1080_6002
+        },
+        mdm_ap: 0x00C3_0000
+      }
+      sub_block :arm_debugv6, options
+    end
+  end
+end

data/pattern/v6_workout.rb

@@ -1,4 +1,8 @@
-pattern_name = "v6_workout_#{dut.arm_debugv6.dp.name}"
+if Origen.app.target.name == 'jtag_axi'
+  pattern_name = "v6_workout_#{dut.arm_debugv6.dp.name}"
+elsif Origen.app.target.name == 'jtag_ack'
+  pattern_name = "v6_workout_#{dut.arm_debugv6.dp.name}_w_ack"
+end
 
 Pattern.create name: pattern_name do
 

data/templates/web/index.md.erb

@@ -138,6 +138,21 @@ instantiation_options[:dp_select_reset] = 0xC2_0D00
 sub_block :arm_debug, instantiation_options
 ~~~
 
+By default the acknowledge signature is masked (not compared). To enable comparison of the acknowledge signature during a read operation add this instantiation option:
+
+~~~ruby
+mem_aps = {
+  mem_ap: { base_address: 0x00000000 }
+  mem2_ap: { base_address: 0x10000000 }
+}
+instantiation_options[:class_name] = 'OrigenARMDebug::DAP'
+instantiation_options[:mem_aps] = mem_aps
+
+instantiation_options[:read_ack] = true  # Check for the acknowledge signature when reading an AP
+
+sub_block :arm_debug, instantiation_options
+~~~
+
 DAP Version 6 instantiation example:
 
 ~~~ruby

metadata

@@ -1,22 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: origen_arm_debug
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ronnie Lajaunie
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2025-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.36
@@ -24,9 +20,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.36
@@ -34,9 +27,6 @@ dependencies:
   name: origen_jtag
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
@@ -44,9 +34,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
@@ -54,9 +41,6 @@ dependencies:
   name: origen_swd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
@@ -64,13 +48,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
-description: 
 email:
 - ronnie.lajaunie@nxp.com
 executables: []
@@ -103,6 +83,7 @@ files:
 - lib/origen_arm_debug_dev/dut_dual_dp.rb
 - lib/origen_arm_debug_dev/dut_jtag.rb
 - lib/origen_arm_debug_dev/dut_jtag_axi.rb
+- lib/origen_arm_debug_dev/dut_jtag_axi_ack.rb
 - lib/origen_arm_debug_dev/dut_swd.rb
 - pattern/v6_workout.rb
 - pattern/workout.rb
@@ -114,7 +95,6 @@ homepage: http://origen-sdk.org/origen_arm_debug
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -122,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.11
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Provides an Origen API to perform register read and write operations via
   the ARM_DEBUG protocol.