origen_arm_debug 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c3661ce85842f7bf1355a7ca46cb69bd072f39
-  data.tar.gz: 2e027c17b080ecd5b2b00ec12136a4c9cbb2add4
+  metadata.gz: 2e004df0c8d145be274dae133a25750de5d4775d
+  data.tar.gz: 661b0086a39ef3e4287cd97e7c551ee35f81fc01
 SHA512:
-  metadata.gz: 0110a23e5982c9a383899dc3f8c71ccffb877cf96e6c5ef630d4dccb32eb332965268b340b54e50823decaf79bbeb67c264842adde2dba17c59250058db4facc
-  data.tar.gz: b0cf696efdff3da903cbfec1e969ab62bd414e89a6202481a50b48868cc20855f05212a0014ee7c8cf0550d6dc5dc92f733c2be964487c8b89fb70429af2fe7a
+  metadata.gz: f3b76b470b1247868e15f9fafd851401fa747b504df323ffb3d9c593c18401ce8ad69da7b4b92c4f38a994b7483d78c22a1c37b6d2a81f0368ce4e327244d043
+  data.tar.gz: b09cb03684e736f2f7f9adc80ae8dc05f35ae03771b4bbcabca4aebfc04442daf8532a9eb4e97cb1dfca95c69466c0034317f579188cbb9690b16e652dbc8127

data/config/version.rb

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

data/lib/origen_arm_debug/mem_ap.rb

@@ -1,4 +1,3 @@
-'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
@@ -175,7 +174,7 @@ module OrigenARMDebug
     #   of options[:edata]
     # @param [Hash] options Options to customize the operation
     # Returns nothing.
-    def R(addr, rdata, options = {})
+    def r(addr, rdata, options = {})
       # Warn caller that this method is being deprecated
       msg = 'Use mem_ap.read(addr, options) instead of R(addr, rdata, options)'
       Origen.deprecate msg
@@ -184,6 +183,7 @@ module OrigenARMDebug
       options = { rdata: rdata }.merge(options)
       read(addr, options)
     end
+    alias_method :R, :r
 
     # Method to write to a mem_ap register (legacy)
     #
@@ -191,7 +191,7 @@ module OrigenARMDebug
     # @param [Integer] wdata Data to be written
     # @param [Hash] options Options to customize the operation
     # Returns nothing.
-    def W(addr, wdata, options = {})
+    def w(addr, wdata, options = {})
       # Warn caller that this method is being deprecated
       msg = 'Use mem_ap.write(addr, wdata, options) instead of W(addr, wdata, options)'
       Origen.deprecate msg
@@ -199,6 +199,7 @@ module OrigenARMDebug
       # Patch arguments and send to new method
       write(addr, wdata, options)
     end
+    alias_method :W, :w
 
     # Method to write and then read from a mem_ap register (legacy)
     #
@@ -206,7 +207,7 @@ module OrigenARMDebug
     # @param [Integer] wdata Data to be written
     # @param [Hash] options Options to customize the operation
     # Returns nothing.
-    def WR(addr, wdata, options = {})
+    def wr(addr, wdata, options = {})
       # Warn caller that this method is being deprecated
       msg = 'Use mem_ap.write_read(addr, wdata, options) instead of WR(addr, wdata, options)'
       Origen.deprecate msg
@@ -214,6 +215,7 @@ module OrigenARMDebug
       # Patch arguments and send to new method
       write_read(addr, wdata, options)
     end
+    alias_method :WR, :wr
 
     # -----------------------------------------------------------------------------
     # Support Code

data/lib/origen_arm_debug/swj_dp.rb

@@ -297,6 +297,12 @@ module OrigenARMDebug
         "data=0x#{wdata.to_s(16).rjust(8, '0')}"
     end
 
+    # Method
+    #
+    # @param [Integer] name Name of register to be transacted
+    # @param [Integer] rwb Indicates read or write
+    # @param [Integer] wdata Value of data to be written
+    # @param [Hash] options Options to customize the operation
     def dpacc_access(name, rwb, wdata, options = {})
       addr = get_dp_addr(name)
 
@@ -307,6 +313,13 @@ module OrigenARMDebug
       acc_access(addr, rwb, 0, wdata, options)
     end
 
+    # Method
+    #
+    # @param [Integer] addr Address of register to be transacted
+    # @param [Integer] rwb Indicates read or write
+    # @param [Integer] wdata Value of data to be written
+    # @param [Integer] rdata Value of data to be read back
+    # @param [Hash] options Options to customize the operation
     def apacc_access(addr, rwb, wdata, rdata, options = {})
       set_apselect((addr & 0xFFFFFFFE) | (@current_apaddr & 1), options)
       if @imp == :swd
@@ -317,6 +330,13 @@ module OrigenARMDebug
       acc_access((addr & 0xC), rwb, 1, wdata, options)
     end
 
+    # Method
+    #
+    # @param [Integer] addr Address of register to be transacted
+    # @param [Integer] rwb Indicates read or write
+    # @param [Integer] ap_dp Indicates Access Port or Debug Port
+    # @param [Integer] wdata Value of data to be written
+    # @param [Hash] options Options to customize the operation
     def acc_access(addr, rwb, ap_dp, wdata, options = {})
       if @imp == :swd
         acc_access_swd(addr, rwb, ap_dp, wdata, options = {})
@@ -325,6 +345,13 @@ module OrigenARMDebug
       end
     end
 
+    # Method SWD-specific
+    #
+    # @param [Integer] addr Address of register to be transacted
+    # @param [Integer] rwb Indicates read or write
+    # @param [Integer] ap_dp Indicates Access Port or Debug Port
+    # @param [Integer] wdata Value of data to be written
+    # @param [Hash] options Options to customize the operation
     def acc_access_swd(addr, rwb, ap_dp, wdata, options = {})
       if (rwb == 1)
         swd.read(ap_dp, addr, options)
@@ -335,6 +362,13 @@ module OrigenARMDebug
       swd.swd_dio_to_0(options[:w_delay])
     end
 
+    # Method JTAG-specific
+    #
+    # @param [Integer] addr Address of register to be transacted
+    # @param [Integer] rwb Indicates read or write
+    # @param [Integer] ap_dp Indicates Access Port or Debug Port
+    # @param [Integer] wdata Value of data to be written
+    # @param [Hash] options Options to customize the operation
     def acc_access_jtag(addr, rwb, ap_dp, wdata, options = {})
       if !options[:r_attempts].nil?
         attempts = options[:r_attempts]

data/templates/web/index.md.erb

@@ -22,21 +22,23 @@ or if your application is a plugin add this to your <code>.gemspec</code>
 spec.add_development_dependency "origen_arm_debug", ">= <%= Origen.app.version %>"
 ~~~
 
-__NOTE:__ You will also need to include <code>require 'origen_arm_debug'</code> somewhere in your environment.  This can be done in <code>config/environment.rb</code> for example.
+__NOTE:__ You will also need to include <code>require 'origen_arm_debug'</code> somewhere in your environment
+if your app is a plugin.
 
 
 ### How To Use
 
-Include the <code>OrigenARMDebug</code> module in your DUT class, this provides
-<code>read_register</code> and <code>write_register</code> methods that will
-be used automatically by any register read/write operations.
-It also provides meathods using the ARM Debug protocol including:
-accessing device memory, accessing core and floating point regesters (coretx M cores only),
-entering/exiting debug mode (coretx M cores only), setting the PC (coretx M cores only)
-and stepping through code (coretx M cores only).
+Include the <code>OrigenARMDebug</code> module in your DUT class, then hook it up
+to the Origen register API via
+<code>read_register</code> and <code>write_register</code> methods.
+
+The <code>OrigenARMDebug</code> module also provides additional methods to use the ARM Debug protocol including:
+accessing device memory, accessing core and floating point registers (cortex M cores only),
+entering/exiting debug mode (cortex M cores only), setting the PC (cortex M cores only)
+and stepping through code (cortex M cores only).
 
 You must also include a compatible physical driver depending on what debug
-interface your DUT has, one of the following can be used:
+interface your device has, one of the following can be used:
 
 * [JTAG](http://origen-sdk.org/jtag)
 * [Single Wire Debug](http://origen-sdk.org/swd)
@@ -46,16 +48,29 @@ class DUT
 
   include OrigenARMDebug
   include Origen::Registers
-  # Also include the required physical driver (not shown here)
+  # Also include the required physical driver, JTAG in this example
+  include OrigenJTAG
 
   def initialize
-    add_reg :test, 0x0012, 16, :upper_byte => {pos: 8, bits: 8},
-                               :lower_byte => {pos: 0, bits: 8}
+    reg :myreg, 0x0012, size: 16 do |reg|
+      reg.bits 15..8, :upper_byte
+      reg.bits 7..0,  :lower_byte
+    end                           
+  end
+
+  # Hook the ARMDebug module into the register API, any register read
+  # requests will use the ARM Debug protocol by default
+  def read_register(reg, options={})
+    arm_debug.read_register(reg, options)
   end
 
+  # As above for write requests
+  def write_register(reg, options={})
+    arm_debug.write_register(reg, options)
+  end
 end
 
-DUT.new.reg(:test).write!(0x55AA)  # => Will generate the required vectors using the ARM debug protocol
+DUT.new.myreg.write!(0x55AA)  # => Will generate the required vectors using the ARM debug protocol
 ~~~
 
 
@@ -69,13 +84,13 @@ object for use in the console:
 ~~~
 origen i
 
-> $dut.arm_debug
+> dut.arm_debug
 => #<OrigenARMDebug::Driver:0x0000001ee48e78>
 ~~~
 
 Follow the instructions here if you want to make a 3rd party app
 workspace use your development copy of the OrigenARMDebug plugin:
-[Setting up a Plugin Development Environment](http://origen-sdk.org/origen/latest/guides/plugins)
+[Setting up a Plugin Development Environment](http://origen-sdk.org/origen/guides/plugins)
 
 This plugin also contains a test suite, makes sure this passes before committing
 any changes!

data/templates/web/partials/_navbar.html.erb

@@ -14,7 +14,7 @@
         <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
         <li class="<%= options[:tab] == :coverage ? 'active' : '' %>"><a href="<%= path "/coverage" %>">Coverage</a></li>
         <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
-        <li><a href="https://github.com/Origen-SDK/origen_swd">Github</a></li>
+        <li><a href="https://github.com/Origen-SDK/origen_arm_debug">Github</a></li>
       </ul>
       <%= import "origen/web/logo.html" %>
     </div><!--/.nav-collapse -->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_arm_debug
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Ronnie Lajaunie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: origen_testers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - Ronnie.Lajaunie@freescale.com