origen_swd 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f760d7e0b8b2b523a41db1db1c4408b59003f5a8
+  data.tar.gz: e7901ced8faff7f18ad00345ec9c0a67f0e5bfad
+SHA512:
+  metadata.gz: 968243cdbf15859e482874e51526e3a7ef58edc628e39cd101328bd9cf1dd9cc597c3a84e3ef7606a218154701259ce9129e0c413380c888f987d3a334cc31ad
+  data.tar.gz: a5171a1d4a1f8f3d2a6f147a5b2e9c58d5ba1f4cdd10f8693a2d75183cc63e238e340ef9d6a65e194d8ba777b8db9c42a0cc505120199137d1009bec4144a8b0

data/config/application.rb

@@ -0,0 +1,59 @@
+class OrigenSWDApplication < Origen::Application
+
+  # This information is used in headers and email templates, set it specific
+  # to your application
+  config.name     = "Origen SWD"
+  config.initials = "OrigenSWD"
+
+  self.name = "origen_swd"
+  self.namespace = "OrigenSWD"
+  config.rc_url = "git@github.com/Origen-SDK/origen_swd.git"
+  config.release_externally = true
+
+  # To enable deployment of your documentation to a web server (via the 'origen web'
+  # command) fill in these attributes.
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/swd"
+  config.web_domain = "http://origen-sdk.org/swd"
+  
+  config.semantically_version = true
+
+  config.lint_test = { 
+    # Require the lint tests to pass before allowing a release to proceed 
+    run_on_tag: true, 
+    # Auto correct violations where possible whenever 'origen lint' is run 
+    auto_correct: true,  
+    # Limit the testing for large legacy applications 
+    #level: :easy, 
+    # Run on these directories/files by default 
+    #files: ["lib", "config/application.rb"], 
+  } 
+  
+  # Ensure that all tests pass before allowing a release to continue 
+  def validate_release 
+    if !system("origen examples") #|| !system("origen specs") 
+      puts "Sorry but you can't release with failing tests, please fix them and try again." 
+      exit 1 
+    else 
+      puts "All tests passing, proceeding with release process!" 
+    end 
+  end 
+  
+  # Run code coverage when deploying the web site 
+  def before_deploy_site 
+    Dir.chdir Origen.root do 
+      system "origen examples -c" 
+      dir = "#{Origen.root}/web/output/coverage"        
+      FileUtils.remove_dir(dir, true) if File.exists?(dir)  
+      system "mv #{Origen.root}/coverage #{dir}" 
+    end 
+  end 
+ 
+  # Deploy the website automatically after a production tag 
+  def after_release_email(tag, note, type, selector, options) 
+    command = "origen web compile --remote --api" 
+    Dir.chdir Origen.root do 
+      system command 
+    end 
+  end 
+
+end

data/config/commands.rb

@@ -0,0 +1,51 @@
+# This file should be used to extend the origen command line tool with tasks 
+# specific to your application.
+#
+# Also see the official docs on adding commands:
+#   http://origen-sdk.org/origen/latest/guides/custom/commands/
+
+# Map any command aliases here, for example to allow origen -x to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "-x" => "execute",
+}
+
+# The requested command is passed in here as @command, this checks it against
+# the above alias table and should not be removed.
+@command = aliases[@command] || @command
+
+# Now branch to the specific task code
+case @command
+
+when "examples"  
+  Origen.load_application
+  status = 0
+  
+  # Pattern generator tests
+  ARGV = %w(example -t debug -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
+    
+  if Origen.app.stats.changed_files == 0 &&
+     Origen.app.stats.new_files == 0 &&
+     Origen.app.stats.changed_patterns == 0 &&
+     Origen.app.stats.new_patterns == 0
+
+     Origen.app.stats.report_pass
+  else
+     Origen.app.stats.report_fail
+     status = 1
+  end
+  puts
+  exit status
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+# You probably want to also add the command details to the help shown via
+# origen -h, you can do this be assigning the required text to @application_commands
+# before handing control back to Origen. Un-comment the example below to get started.
+else
+  @application_commands = <<-EOT
+ examples     Run the examples (tests), -c will enable coverage
+  EOT
+
+end 

data/config/development.rb

@@ -0,0 +1,15 @@
+# This file is similar to environment.rb and will be loaded
+# automatically at the start of each invocation of Origen.
+#
+# However the major difference is that it will not be loaded
+# if the application is imported by a 3rd party app - in that
+# case only environment.rb is loaded.
+#
+# Therefore this file should be used to load anything you need
+# to setup a development environment for this app, normally
+# this would be used to define some dummy classes to instantiate
+# your objects so that they can be tested and/or interacted with
+# in the console.
+module OrigenSWD
+  autoload :DUT, "origen_swd/dut"
+end

data/config/environment.rb

@@ -0,0 +1 @@
+require "origen_swd"

data/config/users.rb

@@ -0,0 +1,19 @@
+# This file defines the users associated with your project, it is basically the 
+# mailing list for release notes.
+#
+# You can split your users into "admin" and "user" groups, the main difference 
+# between the two is that admin users will get all tag emails, users will get
+# emails on external/official releases only.
+#
+# Users are also prohibited from running the "origen tag" task, but this is 
+# really just to prevent a casual user from executing it inadvertently and is
+# not intended to be a serious security gate.
+module Origen
+  module Users
+    def users
+      @users ||= [
+        
+      ]
+    end
+  end
+end

data/config/version.rb

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

data/lib/origen_swd.rb

@@ -0,0 +1,11 @@
+require 'origen'
+require_relative '../config/application.rb'
+
+module OrigenSWD
+  autoload :Driver, 'origen_swd/driver'
+
+  # Returns an instance of the OrigenSWD::Driver
+  def swd
+    @swd ||= Driver.new(self)
+  end
+end

data/lib/origen_swd/driver.rb

@@ -0,0 +1,55 @@
+module OrigenSWD
+  # To use this driver the owner model must define the following pins (an alias is fine):
+  #   :swd_clk
+  #   :swd_dio
+  #
+  class Driver
+    # Returns the parent object that instantiated the driver, could be
+    # either a DUT object or a protocol abstraction
+    attr_reader :owner
+
+    def initialize(owner, options = {})
+      @owner = owner
+      @current_apaddr = 0
+      @orundetect = 0
+    end
+
+    # Hardware interface
+    def send_data(data, size, options = {})
+      if options.key?(:overlay)
+        $tester.label(options[:overlay])
+        size.times do |bit|
+          owner.pin(:swd_clk).drive(1)
+          $tester.label("// SWD Data Pin #{bit}")
+          owner.pin(:swd_dio).drive(data[bit])
+          $tester.cycle
+        end
+        owner.pin(:swd_dio).dont_care
+      else
+        size.times do |bit|
+          owner.pin(:swd_clk).drive(1)
+          owner.pin(:swd_dio).drive(data[bit])
+          $tester.cycle
+        end
+        owner.pin(:swd_dio).dont_care
+      end
+    end
+
+    def get_data(size, options = {})
+      should_store = $dut.pin(:swd_dio).is_to_be_stored?
+      owner.pin(:swd_dio).dont_care
+      size.times do |bit|
+        $tester.store_next_cycle($dut.pin(:swd_dio)) if should_store
+        $dut.pin(:swd_dio).assert(options[:compare_data][bit]) if options.key?(:compare_data)
+        $tester.cycle
+      end
+    end
+
+    def swd_dio_to_0(size)
+      owner.pin(:swd_dio).drive(0)
+      size.times do |bit|
+        $tester.cycle
+      end
+    end
+  end
+end

data/lib/origen_swd/dut.rb

@@ -0,0 +1,24 @@
+module OrigenSWD
+  # This is a dummy DUT model which is used
+  # to instantiate and test the SWD locally
+  # during development.
+  #
+  # It is not included when this library is imported.
+  class DUT
+    include OrigenSWD
+    include Origen::Callbacks
+    include Origen::Registers
+    include Origen::Pins
+
+    def initialize(options = {})
+      add_reg :test, 0x0, 32, data: { pos: 0, bits: 32 },
+                              bit:  { pos: 0 }
+      add_pin :swd_clk
+      add_pin :swd_dio
+    end
+
+    def startup(options)
+      $tester.set_timeset('swd', 40)
+    end
+  end
+end

data/pattern/example.rb

@@ -0,0 +1,59 @@
+Pattern.create do
+
+  address    = 0x00002020
+  rwb        = 0
+  ap_dp      = 1
+  wdata      = 0xAAAA5555
+  start      = 1
+  apndp      = 1
+  rnw        = rwb
+  addr       = address >> 2
+  parity_pr  = ap_dp ^ rwb ^ (addr >> 3) ^ (addr >> 2) & (0x01) ^ (addr >> 1) & (0x01) ^ addr & 0x01
+  trn        = 0
+  data       = wdata
+  require_dp = 0
+  line_reset = 0
+  stop       = 0
+  park       = 1
+
+  cc 'SWD transaction'
+  cc 'Packet Request Phase'
+
+  annotate 'Send Start Bit'
+  $dut.swd.send_data(start, 1)
+  cc('Send APnDP Bit (DP or AP Access Register Bit)', prefix: true)
+  $dut.swd.send_data(apndp, 1)
+  c2 'Send RnW Bit (read or write bit)'
+  $dut.swd.send_data(rnw, 1)
+  c2 'Send Address Bits (2 bits)'
+  $dut.swd.send_data(addr, 2)
+  c2 'Send Parity Bit'
+  $dut.swd.send_data(parity_pr, 1)
+  c2 'Send Stop Bit'
+  $dut.swd.send_data(stop, 1)
+  c2 'Send Park Bit'
+  $dut.swd.send_data(park, 1)
+
+  cc 'Acknowledge Response phase'
+  $dut.swd.send_data(0xf, trn + 1)
+  $dut.swd.get_data(3)
+
+  cc 'Write Data Phase'
+  cc 'Write'
+  cc 'Send ACK Bits'
+  $dut.swd.send_data(0xf, trn + 1)
+  cc 'SWD 32-Bit Write Start'
+  $dut.swd.send_data(data, 32, overlay: 'write_ovl')
+  cc 'SWD 32-Bit Write End'
+  cc 'Send Write Parity Bit'
+  xor = 0
+  32.times do |bit|
+    xor ^= (data >> bit) & 0x01
+  end
+  xor
+  $dut.swd.send_data(xor, 1)
+
+  cc 'SWD DIO to 0 for 10 cycles'
+  $dut.swd.swd_dio_to_0(10)
+
+end

data/templates/web/index.md.erb

@@ -0,0 +1,82 @@
+% 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 application provides a SWD driver.
+
+### How To Import
+
+In your Gemfile add:
+
+~~~ruby
+gem "origen_swd", ">= <%= Origen.app.version %>"
+~~~
+
+or if your application is a plugin add this to your <code>.gemspec</code>
+
+~~~ruby
+spec.add_development_dependency "origen_swd", ">= <%= Origen.app.version %>"
+~~~
+
+__NOTE:__ You will also need to include <code>require 'origen_swd'</code> somewhere in your environment.  This can be done in <code>config/environment.rb</code> for example.
+
+
+### How To Use
+
+Include the <code>OrigenSWD</code> module to add a JTAG driver to your class and
+define the required pins.
+
+Including the module adds a <code>swd</code> method which will return an instance of
+[<code>OrigenSWD::Driver</code>](<%= path "api/OrigenSWD/Driver.html" %>).
+
+Here is an example integration:
+
+~~~ruby
+
+class DUT
+  include OrigenSWD
+  include Origen::Pins 
+
+  def initialize(options = {})
+    add_pin :swd_clk 
+    add_pin :swd_dio
+  end
+end
+
+
+DUT.new.swd # => An instance of OrigenSWD::Driver
+~~~
+
+
+### How To Setup a Development Environment
+
+[Clone the repository from Github](https://github.com/Origen-SDK/origen_swd).
+
+An instance of the OrigenSWD driver is hooked up to a dummy DUT
+object for use in the console:
+
+~~~
+origen i
+
+> $dut.swd
+=> #<OrigenSWD::Driver:0x0000001ee48e78>
+~~~
+
+Follow the instructions here if you want to make a 3rd party app
+workspace use your development copy of the OrigenSWD 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>

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: origen_swd
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Ronnie Lajaunie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-18 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_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_swd.rb
+- lib/origen_swd/driver.rb
+- lib/origen_swd/dut.rb
+- pattern/example.rb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+homepage: http://origen-sdk.org/origen_swd
+licenses: []
+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: Driver for single-wire-debug interface.
+test_files: []
+has_rdoc: