origen_arm_debug 0.4.0

data/templates/web/index.md.erb

@@ -0,0 +1,89 @@
+% 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 library provides register and memory read/write and debug control capability via the ARM debug protocol. 
+
+### How To Import
+
+In your Gemfile add:
+
+~~~ruby
+gem "origen_arm_debug", ">= <%= Origen.app.version %>"
+~~~
+
+or if your application is a plugin add this to your <code>.gemspec</code>
+
+~~~ruby
+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.
+
+
+### 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).
+
+You must also include a compatible physical driver depending on what debug
+interface your DUT has, one of the following can be used:
+
+* [JTAG](http://origen-sdk.org/jtag)
+* [Single Wire Debug](http://origen-sdk.org/swd)
+
+~~~ruby
+class DUT
+
+  include OrigenARMDebug
+  include Origen::Registers
+  # Also include the required physical driver (not shown here)
+
+  def initialize
+    add_reg :test, 0x0012, 16, :upper_byte => {pos: 8, bits: 8},
+                               :lower_byte => {pos: 0, bits: 8}
+  end
+
+end
+
+DUT.new.reg(:test).write!(0x55AA)  # => Will generate the required vectors using the ARM debug protocol
+~~~
+
+
+### How To Setup a Development Environment
+
+[Clone the repository from Github](https://github.com/Origen-SDK/origen_arm_debug).
+
+An instance of the OrigenARMDebug driver is hooked up to a dummy DUT
+object for use in the console:
+
+~~~
+origen i
+
+> $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)
+
+This plugin also contains a test suite, makes sure this passes before committing
+any changes!
+
+~~~
+origen examples
+~~~
+
+<%= disqus_comments %>
+
+% end

data/templates/web/layouts/_basic.html.erb

@@ -0,0 +1,16 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+analytics: UA-64455560-1
+---
+<%= render "templates/web/partials/navbar.html", :tab => options[:tab] %>
+
+<div class="row">
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span12" markdown="1">
+<%= yield %>    
+
+<%= disqus_comments %>
+
+</div>
+</div>

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

@@ -0,0 +1,22 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <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>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/templates/web/release_notes.md.erb

@@ -0,0 +1,5 @@
+% render "layouts/basic.html", tab: :release do 
+
+<%= render "#{Origen.root}/doc/history" %> 
+
+% end 

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: origen_arm_debug
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Ronnie Lajaunie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: origen_jtag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: origen_swd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: origen_doc_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 
+email:
+- Ronnie.Lajaunie@freescale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/commands.rb
+- config/development.rb
+- config/environment.rb
+- config/users.rb
+- config/version.rb
+- lib/origen_arm_debug.rb
+- lib/origen_arm_debug/abs_if_jtag.rb
+- lib/origen_arm_debug/abs_if_swd.rb
+- lib/origen_arm_debug/core_access_M4.rb
+- lib/origen_arm_debug/driver.rb
+- lib/origen_arm_debug/dut.rb
+- lib/origen_arm_debug/dut_jtag.rb
+- lib/origen_arm_debug/dut_swd.rb
+- lib/origen_arm_debug/jtag_ap.rb
+- lib/origen_arm_debug/jtag_dp.rb
+- lib/origen_arm_debug/mem_ap.rb
+- lib/origen_arm_debug/sw_dp.rb
+- lib/origen_arm_debug/swj_dp.rb
+- pattern/read_write_reg.rb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: http://origen-sdk.org/origen_arm_debug
+licenses:
+- LGPL-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a Origen API to perform register read and write operations via the
+  ARM_DEBUG protocol.
+test_files: []
+has_rdoc: