origen_arm_debug 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd4a3c91ea754230b8e799d2fdbb6fa5ebce4405
-  data.tar.gz: a4b18c224767fe55666e0366fb11700129165be5
+  metadata.gz: d2c3661ce85842f7bf1355a7ca46cb69bd072f39
+  data.tar.gz: 2e027c17b080ecd5b2b00ec12136a4c9cbb2add4
 SHA512:
-  metadata.gz: 30e7d8fe43c7668ed2a5e8d0eb5da2e3ba2d2ea1a3a83e77e45e80c25dd98d4e907c03dbef77a6159204a31818ab484e8c5cb740153b1bd0f5107762f3f6cd44
-  data.tar.gz: a15f046b109e8b8778391ca73c1aba2afd84e0020423afd1a6e38feb1931510be99fee52360c51330b460c47b42a0c74e6b62193291a06347dedf45de02777a2
+  metadata.gz: 0110a23e5982c9a383899dc3f8c71ccffb877cf96e6c5ef630d4dccb32eb332965268b340b54e50823decaf79bbeb67c264842adde2dba17c59250058db4facc
+  data.tar.gz: b0cf696efdff3da903cbfec1e969ab62bd414e89a6202481a50b48868cc20855f05212a0014ee7c8cf0550d6dc5dc92f733c2be964487c8b89fb70429af2fe7a

data/config/version.rb

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

data/lib/origen_arm_debug/driver.rb

@@ -1,4 +1,9 @@
 module OrigenARMDebug
+  # To use this driver the owner model must include the SWD or JTAG protocol drivers:
+  #   include JTAG
+  #     or
+  #   include SWD
+  #
   class Driver
     # Returns the parent object that instantiated the driver, could be
     # either a DUT object or a protocol abstraction
@@ -16,7 +21,7 @@ module OrigenARMDebug
       @owner = owner
     end
 
-    # Create and/or return the SWJ_DP object with specified protocol 
+    # Create and/or return the SWJ_DP object with specified protocol
     def swj_dp
       if owner.respond_to?(:swd)
         @swj_dp ||= SWJ_DP.new(self, :swd)

data/lib/origen_arm_debug/dut_jtag.rb

@@ -1,4 +1,5 @@
 module OrigenARMDebug
+  # Simple JTAG-specific dut model that inherits from protocol-agnostic DUT model
   class JTAG_DUT < DUT
     include OrigenJTAG
     include Origen::Pins

data/lib/origen_arm_debug/dut_swd.rb

@@ -1,4 +1,5 @@
 module OrigenARMDebug
+  # Simple SWD-specific dut model that inherits from protocol-agnostic DUT model
   class SWD_DUT < DUT
     include OrigenSWD
     include Origen::Pins

data/lib/origen_arm_debug/mem_ap.rb

@@ -1,4 +1,8 @@
+'include rgen'
 module OrigenARMDebug
+  # Object that defines the API necessary to perform MEM-AP transactions.  Requires
+  #  a top-level protocol be defined as well as a top-level instantiation of an
+  #  SWJ-DP object.
   class MemAP
     # ARM Debug Interface v5.1
     MEM_ADDR_CSW  = 0x00000000
@@ -40,6 +44,25 @@ module OrigenARMDebug
     end
     alias_method :dp, :debug_port
 
+    # Output some instance-specific information
+    def inspect
+      Origen.log.info '=' * 30
+      Origen.log.info ' MEM-AP INFO'
+      Origen.log.info "  name: #{@name}"
+      Origen.log.info "  base address: 0x#{@base_address.to_hex}"
+      Origen.log.info ''
+      Origen.log.debug "  csw_reg_addr  = 0x#{csw_reg_addr.to_hex}"
+      Origen.log.debug "  tar_reg_addr  = 0x#{tar_reg_addr.to_hex}"
+      Origen.log.debug "  drw_reg_addr  = 0x#{drw_reg_addr.to_hex}"
+      Origen.log.debug "  bd0_reg_addr  = 0x#{bd0_reg_addr.to_hex}"
+      Origen.log.debug "  bd1_reg_addr  = 0x#{bd1_reg_addr.to_hex}"
+      Origen.log.debug "  bd2_reg_addr  = 0x#{bd2_reg_addr.to_hex}"
+      Origen.log.debug "  bd3_reg_addr  = 0x#{bd3_reg_addr.to_hex}"
+      Origen.log.debug "  cfg_reg_addr  = 0x#{cfg_reg_addr.to_hex}"
+      Origen.log.debug "  base_reg_addr = 0x#{base_reg_addr.to_hex}"
+      Origen.log.debug "  idr_reg_addr  = 0x#{idr_reg_addr.to_hex}"
+    end
+
     # -----------------------------------------------------------------------------
     # User API
     # -----------------------------------------------------------------------------
@@ -350,7 +373,7 @@ module OrigenARMDebug
     end
 
     # Returns address of BD0 register for this mem-ap instance
-    def bdo_reg_addr
+    def bd0_reg_addr
       MEM_ADDR_BD0 + @base_address
     end
 

data/lib/origen_arm_debug/swj_dp.rb

@@ -1,12 +1,21 @@
 module OrigenARMDebug
+  # Object that defines API for performing Debug AP transations using SWD or JTAG
   class SWJ_DP
     include Origen::Registers
 
     # Returns the parent object that instantiated the driver, could be
     # either a DUT object or a protocol abstraction
     attr_reader :owner
+
+    # Protocol implemented at the top-level (i.e. SWD or JTAG)
     attr_reader :imp
+
+    # Customizable delay for DUT-specific required cycles for write_ap transaction
+    #   to complete
     attr_accessor :write_ap_dly
+
+    # Customizable delay for DUT-specific required cycles for acc_access transaction
+    #   to complete
     attr_accessor :acc_access_dly
 
     # Initialize class variables
@@ -356,6 +365,9 @@ module OrigenARMDebug
       $tester.cycle(repeat: @acc_access_dly)
     end
 
+    # Returns the address of the register based on the name (string) of the register
+    #
+    # @param [String] name Name of the register
     def get_dp_addr(name)
       case name
         when 'IDCODE'    then return 0x0
@@ -369,11 +381,18 @@ module OrigenARMDebug
       end
     end
 
+    # Writes to the JTAG instruction regsiter in order to perform a transaction on the given Register
+    #
+    # @param [String] name Name of the register to be interacted with
     def set_ir(name)
       new_ir = get_ir_code(name)
       jtag.write_ir(new_ir, size: 4)
     end
 
+    # Returns the value to be written to the JTAG instruction regsiter in order to perform
+    #   a transaction on the given Register
+    #
+    # @param [String] name Name of the register to be interacted with
     def get_ir_code(name)
       case name
         when 'IDCODE'    then return 0b1110   # JTAGC_ARM_IDCODE
@@ -389,6 +408,11 @@ module OrigenARMDebug
       0
     end
 
+    # Method to select an Access Port (AP) by writing to the SELECT register in the Debug Port
+    #
+    # @param [Integer] addr Address to be written to the SELECT register.  It's value
+    #    will determine which Access Port is selected.
+    # @param [Hash] options Options to customize the operation
     def set_apselect(addr, options = {})
       if @imp == :swd
         addr &= 0xff0000f1

data/pattern/read_write_reg.rb

@@ -15,4 +15,7 @@ Pattern.create do
   $dut.arm_debug.mem_ap.W(0x10000004, 0x55555555)
   $dut.arm_debug.mem_ap.WR(0x10000004, 0x55555555)
 
+  $dut.arm_debug.mem_ap.inspect
+  $dut.arm_debug.mdm_ap.inspect
+  $dut.arm_debug.alt_ahbapi.inspect
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_arm_debug
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Ronnie Lajaunie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen