origen_arm_debug 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 292e4be7741df68524ba13a6af2058a9ca209688ddf12ca19c63a1e2e795135c
-  data.tar.gz: 58fd3ee8010c9cba1bd4675896fd8a5aa0d9e579113aaeac7ceb30c5039467ac
+  metadata.gz: 45cc30ad35c5f7785831b3fa516ce4784e43170ccc21229d5d6744adaa7f08fb
+  data.tar.gz: 3962dec63e6fcdc94de242557b36a34472f152ded5d95a1354e16e61fc04af10
 SHA512:
-  metadata.gz: 880aef44c21b1a5030223b9d7a0155f0284109c9dcc8c711bdab5e95e0dc8f347a4920d93cfb993dcc51e7104fa91b740699c504a3d797a7c3e12252739357e8
-  data.tar.gz: 15f565c00daa931914a1b9be94894810a2bdccbd19e1553a013dc1234d1cb01b76484e2bc7e47697cb5ee3307fd03ff7e7484577171120579c35aa37e5e392b5
+  metadata.gz: a2060517cd1db17b6ef02d89355c0816f9ebe422b03277dc5a7783bb2cb4bca0ebb6aa795e8e6926800bdbd524ec5d9cc1565ded06ed75626ee4fb130dfe991f
+  data.tar.gz: 78a07d7c55c782ee78b025c20b3caf30956f8a550229479c53b53e6b0049f1fe1cb32525e8fbafd44d69ba691ff7d05e7c87d0e5f0747b786af6268394cf3a2e

data/config/commands.rb

@@ -30,6 +30,8 @@ when "examples", "test"
   load "#{Origen.top}/lib/origen/commands/generate.rb"
   ARGV = %w(workout -t jtag_axi.rb -e j750 -r approved)
   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(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 = 2
+  MINOR = 3
   BUGFIX = 0
   DEV = nil
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen_arm_debug/dap.rb

@@ -20,7 +20,11 @@ module OrigenARMDebug
       end
 
       if options[:jtag] || parent.respond_to?(:jtag)
-        options[:class_name] = 'JTAG_DP'
+        if options[:dapv6]
+          options[:class_name] = 'JTAG_DPV6'
+        else
+          options[:class_name] = 'JTAG_DP'
+        end
         dps << sub_block(:jtag_dp, options)
       end
 

data/lib/origen_arm_debug/dp_controller_v6.rb

@@ -0,0 +1,17 @@
+module OrigenARMDebug
+  # Common methods shared between the SW and JTAG DP controllers
+  module DPControllerV6
+    # Alias for the ctrlstat register
+    def ctrl_stat
+      ctrlstat
+    end
+
+    # @api private
+    def select_ap_reg(reg)
+      address = (reg.address & 0xFFFF_FFF0) >> 4
+      address1 = (reg.address & 0xFFFF_FFFF_0000_0000) >> 32
+      model.select1.write! address1 if model.select1.data != address1
+      model.select.bits(:addr).write! address if model.select.bits(:addr).data != address
+    end
+  end
+end

data/lib/origen_arm_debug/jtag_dp_v6.rb

@@ -0,0 +1,86 @@
+module OrigenARMDebug
+  class JTAG_DPV6
+    include Origen::Model
+
+    attr_reader :dpacc_select, :apacc_select
+
+    def initialize(options = {})
+      options = {
+        ir_size:       4,
+        idcode_select: 0b1110,
+        abort_select:  0b1000,
+        dpacc_select:  0b1010,
+        apacc_select:  0b1011
+      }.merge(options)
+      @dpacc_select = options[:dpacc_select]
+      @apacc_select = options[:apacc_select]
+      add_reg :ir, 0, size: options[:ir_size]
+
+      # Virtual reg used to represent all of the various 35-bit scan chains
+      reg :dr, 0, size: 35 do |reg|
+        reg.bit 34..3, :data
+        reg.bit 2..1, :a
+        reg.bit 0, :rnw
+      end
+
+      reg :idcode, options[:idcode_select], access: :ro do |reg|
+        reg.bit 31..28, :version
+        reg.bit 27..12, :partno
+        reg.bit 11..1, :designer
+        reg.bit 0, :bit0, reset: 1
+      end
+
+      reg :ctrlstat, 0x4, dpbanksel: 0 do |reg|
+        reg.bit 31, :csyspwrupack
+        reg.bit 30, :csyspwrupreq
+        reg.bit 29, :cdbgpwrupack
+        reg.bit 28, :cdbgpwrupreq
+        reg.bit 27, :cdbgrstack
+        reg.bit 26, :cdbgrstreq
+        reg.bit 23..12, :trncnt
+        reg.bit 11..8, :masklane
+        reg.bit 7, :wdataerr
+        reg.bit 6, :readok
+        reg.bit 5, :stickyerr
+        reg.bit 4, :stickycmp
+        reg.bit 3..2, :trnmode
+        reg.bit 1, :stickyorun
+        reg.bit 0, :orundetect
+      end
+
+      reg :select, 0x8 do |reg|
+        reg.bit 31..4, :addr
+        reg.bit 3..0, :dpbanksel
+      end
+
+      reg :select1, 0x4, dpbanksel: 5 do |reg|
+        reg.bit 31..0, :addr
+      end
+
+      select.write options[:dp_select_reset] if options[:dp_select_reset]
+
+      add_reg :rdbuff, 0xC, access: :ro, reset: 0
+
+      reg :abort, options[:abort_select], access: :wo do |reg|
+        reg.bit 0, :dapabort
+      end
+    end
+
+    def select
+      reg(:select)
+    end
+
+    def abort
+      reg(:abort)
+    end
+
+    def is_jtag?
+      true
+    end
+
+    def is_swd?
+      false
+    end
+    alias_method :is_sw?, :is_swd?
+  end
+end

data/lib/origen_arm_debug/jtag_dp_v6_controller.rb

@@ -0,0 +1,168 @@
+module OrigenARMDebug
+  class JTAG_DPV6Controller
+    include Origen::Controller
+    include Helpers
+    include DPControllerV6
+
+    def write_register(reg, options = {})
+      unless reg.writable?
+        fail "The :#{reg.name} register is not writeable!"
+      end
+
+      # DP register write
+      if reg.owner == model
+        # Don't log this one, not really a DP reg and will be included
+        # in the JTAG driver log anyway
+        if reg.name == :ir
+          dut.jtag.write_ir(reg)
+        else
+
+          log "Write JTAG-DP register #{reg.name.to_s.upcase}: #{reg.data.to_hex}" do
+            if reg.name == :abort
+              ir.write!(reg.offset)
+              dr.reset
+              dr.overlay(nil)
+              dr[2..0].write(0)
+              dr[34..3].copy_all(reg)
+              dut.jtag.write_dr(dr)
+
+            # DPACC
+            elsif reg.name == :select
+              dp_write(reg)
+
+            # Some other debug register
+            elsif reg.meta.include?(:dpbanksel)
+              if model.reg(:select).bits(:dpbanksel).data != reg.meta[:dpbanksel]
+                model.reg(:select).bits(:dpbanksel).write! reg.meta[:dpbanksel]
+              end
+              dp_write(reg)
+
+            else
+              fail "Can't write #{reg.name}"
+            end
+          end
+        end
+
+      # AP register write
+      else
+
+        unless reg.owner.is_a?(AP)
+          fail 'The JTAG-DP can only write to DP or AP registers!'
+        end
+
+        select_ap_reg(reg)
+        dr.reset
+        dr.overlay(nil)
+        dr[0].write(0)
+        dr[2..1].write(reg.offset >> 2)
+        dr[34..3].copy_all(reg)
+        ir.write!(apacc_select)
+        dut.jtag.write_dr(dr, options)
+      end
+    end
+
+    def read_register(reg, options = {})
+      unless reg.readable?
+        fail "The :#{reg.name} register is not readable!"
+      end
+
+      if reg.owner == model
+        # Don't log this one, not really a DP reg and will be included
+        # in the JTAG driver log anyway
+        if reg.name == :ir
+          dut.jtag.read_ir(reg)
+        else
+
+          log "Read JTAG-DP register #{reg.name.to_s.upcase}: #{Origen::Utility.read_hex(reg)}" do
+            if reg.name == :idcode
+              ir.write!(reg.offset)
+              dut.jtag.read_dr(reg)
+
+            # DPACC
+            elsif reg.name == :select || reg.name == :rdbuff
+              dp_read(reg, options)
+
+            # Some other register
+            elsif reg.meta.include?(:dpbanksel)
+              # Part 1 - Set dpbanksel if required
+              if model.reg(:select).bits(:dpbanksel).data != reg.meta[:dpbanksel]
+                model.reg(:select).bits(:dpbanksel).write! reg.meta[:dpbanksel]
+              end
+
+              dp_read(reg, options)
+
+            else
+              fail "Can't read #{reg.name}"
+            end
+          end
+        end
+
+      # AP register read
+      else
+        unless reg.owner.is_a?(AP)
+          fail 'The JTAG-DP can only write to DP or AP registers!'
+        end
+
+        # Part 1 - Request read from AP-Register by writing to APACC with RnW=1
+        select_ap_reg(reg)
+        dr.reset
+        dr.overlay(nil)
+        dr[0].write(1)
+        dr[2..1].write(reg.offset >> 2)
+        dr[34..3].write(0)
+        ir.write!(apacc_select)
+        dut.jtag.write_dr(dr)
+
+        # Calling AP should provide any delay parameter for wait states between AP read request
+        #   and when the data is available at the RDBUFF DP-Reg
+        if options[:apacc_wait_states]
+          options[:apacc_wait_states].cycles
+        end
+
+        # 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)
+        dr[34..3].copy_all(reg)
+        options[:mask] = options[:mask] << 3 unless options[:mask].nil?
+        ir.write!(dpacc_select)
+        dut.jtag.read_dr(dr, options)
+      end
+    end
+
+    def dp_read(reg, options = {})
+      # Part 1 - Request read from DP-Register by writing to DPACC with RnW=1
+      dr.reset
+      dr.overlay(nil)
+      dr[0].write(1)
+      dr[2..1].write(reg.offset >> 2)
+      dr[34..3].write(0)
+      ir.write!(dpacc_select)
+      dut.jtag.write_dr(dr)
+
+      # 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)
+      dr[34..3].copy_all(reg)
+      options[:mask] = options[:mask] << 3 unless options[:mask].nil?
+      dut.jtag.read_dr(dr, options)
+    end
+
+    def dp_write(reg)
+      dr.reset
+      dr.overlay(nil)
+      dr[0].write(0)
+      dr[2..1].write(reg.offset >> 2)
+      dr[34..3].copy_all(reg)
+      ir.write!(dpacc_select)
+      dut.jtag.write_dr(dr)
+    end
+
+    def base_address
+      model.base_address
+    end
+  end
+end

data/lib/origen_arm_debug.rb

@@ -8,8 +8,11 @@ module OrigenARMDebug
   require 'origen_arm_debug/dap'
   require 'origen_arm_debug/dap_controller'
   require 'origen_arm_debug/dp_controller'
+  require 'origen_arm_debug/dp_controller_v6'
   require 'origen_arm_debug/jtag_dp'
   require 'origen_arm_debug/jtag_dp_controller'
+  require 'origen_arm_debug/jtag_dp_v6'
+  require 'origen_arm_debug/jtag_dp_v6_controller'
   require 'origen_arm_debug/sw_dp'
   require 'origen_arm_debug/sw_dp_controller'
   require 'origen_arm_debug/ap'

data/lib/origen_arm_debug_dev/dut_jtag_axi.rb

@@ -30,6 +30,21 @@ module OrigenARMDebugDev
       options[:dp_select_reset] = 0xC2_0D00
       # 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

@@ -0,0 +1,114 @@
+pattern_name = "v6_workout_#{dut.arm_debugv6.dp.name}"
+
+Pattern.create name: pattern_name do
+
+  ss "Tests of direct DP API"
+  dp = dut.arm_debugv6.dp
+
+  dp.idcode.partno.read!(0x12)
+
+  dp.ctrlstat.write!(0x50000000)
+  dp.ctrlstat.read!(0xF0000000)
+
+  dp.select.bits(:addr).write!(0xF)
+  dp.select.read!
+  dp.select1.write! 4
+  dp.select1.read! 4
+
+  dp.abort.dapabort.write!(1)
+
+  ss "Tests of direct AP API"
+  ap = dut.arm_debugv6.mem_ap
+
+  ap.tar.write!(0x1234_0000)
+
+  ap.tar.read!
+
+  ss "Tests of high-level register API"
+
+  ss "Test write register, should write value 0xFF01"
+  dut.reg(:test).write!(0x0000FF01)
+
+  ss "Test write register with overlay, no subroutine"
+  dut.reg(:test).overlay('write_overlay')
+  dut.reg(:test).write!(0x0000FF01, no_subr: true)
+  dut.reg(:test).overlay(nil)
+
+  ss "Test write register with overlay, use subroutine if available"
+  dut.reg(:test).overlay('write_overlay_subr')
+  dut.reg(:test).write!(0x0000FF01)
+  dut.reg(:test).overlay(nil)
+
+  ss "Test read register, should read value 0x0000FF01"
+  dut.reg(:test).read!
+ 
+  ss "Test read register, with overlay, no subroutine, should read value 0x0000FF01"
+  dut.reg(:test).overlay('read_overlay')
+  dut.reg(:test).read!(no_subr: true)
+  dut.reg(:test).overlay(nil)
+
+  ss "Test read register, with overlay, use subroutine if available"
+  dut.reg(:test).overlay('read_overlay_subr')
+  dut.reg(:test).read!
+  dut.reg(:test).overlay(nil)
+  
+  ss "Test read register with mask, should read value 0xXXXxxx1"
+  dut.reg(:test).read!(mask: 0x0000_000F)
+
+  ss "Test read register with store"
+  dut.reg(:test).store!
+
+  ss "Test bit level read, should read value 0xXXXxxx1"
+  dut.reg(:test).reset
+  dut.reg(:test).data = 0x0000FF01
+  dut.reg(:test)[0].read!
+
+  if Origen.app.target.name == 'dual_dp'
+    ss "SWITCHING DP"
+    dut.arm_debugv6.set_dp(:jtag)
+
+    ss "Test write register, should write value 0xFF01"
+    dut.reg(:test).write!(0x0000FF01)
+
+    ss "Test write register with overlay, no subroutine"
+    dut.reg(:test).overlay('write_overlay')
+    dut.reg(:test).write!(0x0000FF01, no_subr: true)
+    dut.reg(:test).overlay(nil)
+
+    ss "Test write register with overlay, use subroutine if available"
+    dut.reg(:test).overlay('write_overlay_subr')
+    dut.reg(:test).write!(0x0000FF01)
+    dut.reg(:test).overlay(nil)
+
+    ss "Test read register, should read value 0x0000FF01"
+    dut.reg(:test).read!
+   
+    ss "Test read register, with overlay, no subroutine, should read value 0x0000FF01"
+    dut.reg(:test).overlay('read_overlay')
+    dut.reg(:test).read!(no_subr: true)
+    dut.reg(:test).overlay(nil)
+
+    ss "Test read register, with overlay, use subroutine if available"
+    dut.reg(:test).overlay('read_overlay_subr')
+    dut.reg(:test).read!
+    dut.reg(:test).overlay(nil)
+    
+    ss "Test read register with mask, should read value 0xXXXxxx1"
+    dut.reg(:test).read!(mask: 0x0000_000F)
+
+    ss "Test read register with store"
+    dut.reg(:test).store!
+
+    ss "Test bit level read, should read value 0xXXXxxx1"
+    dut.reg(:test).reset
+    dut.reg(:test).data = 0x0000FF01
+    dut.reg(:test)[0].read!
+
+    ss "RESETTING DP (to default)"
+    dut.arm_debugv6.reset_dp
+    ss "Test bit level read, should read value 0xXXXxxx1"
+    dut.reg(:test).reset
+    dut.reg(:test).data = 0x0000FF01
+    dut.reg(:test)[0].read!
+  end
+end

data/pattern/workout.rb

@@ -16,7 +16,11 @@ Pattern.create name: pattern_name do
   dp.ctrlstat.write!(0x50000000)
   dp.ctrlstat.read!(0xF0000000)
 
-  dp.select.apbanksel.write!(0xF)
+  if dp.select.has_bits?(:apbanksel)
+    dp.select.apbanksel.write!(0xF)
+  else
+    dp.select.bits(31..24).write!(0xF)
+  end
 
   dp.abort.dapabort.write!(1)
 

data/templates/web/index.md.erb

@@ -138,6 +138,21 @@ instantiation_options[:dp_select_reset] = 0xC2_0D00
 sub_block :arm_debug, instantiation_options
 ~~~
 
+DAP Version 6 instantiation example:
+
+~~~ruby
+mem_aps = {
+  mem_ap: { base_address: 0x001C_1000 }
+  mem2_ap: { base_address: 0x001C_2000 }
+}
+instantiation_options[:class_name] = 'OrigenARMDebug::DAP'
+instantiation_options[:mem_aps] = mem_aps
+
+instantiation_options[:dapv6] = true
+
+sub_block :arm_debug, instantiation_options
+~~~
+
 ### Company Customization
 
 It may be the case that your application needs additional, customized Access Ports (AP) which are allowed but

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_arm_debug
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ronnie Lajaunie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -87,11 +87,14 @@ files:
 - lib/origen_arm_debug/dap.rb
 - lib/origen_arm_debug/dap_controller.rb
 - lib/origen_arm_debug/dp_controller.rb
+- lib/origen_arm_debug/dp_controller_v6.rb
 - lib/origen_arm_debug/helpers.rb
 - lib/origen_arm_debug/jtag_ap.rb
 - lib/origen_arm_debug/jtag_ap_controller.rb
 - lib/origen_arm_debug/jtag_dp.rb
 - lib/origen_arm_debug/jtag_dp_controller.rb
+- lib/origen_arm_debug/jtag_dp_v6.rb
+- lib/origen_arm_debug/jtag_dp_v6_controller.rb
 - lib/origen_arm_debug/mem_ap.rb
 - lib/origen_arm_debug/mem_ap_controller.rb
 - lib/origen_arm_debug/sw_dp.rb
@@ -101,6 +104,7 @@ files:
 - lib/origen_arm_debug_dev/dut_jtag.rb
 - lib/origen_arm_debug_dev/dut_jtag_axi.rb
 - lib/origen_arm_debug_dev/dut_swd.rb
+- pattern/v6_workout.rb
 - pattern/workout.rb
 - templates/web/index.md.erb
 - templates/web/layouts/_basic.html.erb