origen_spi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83377bd6ba21533463dfa2f7b8a55ad734f53d4b
+  data.tar.gz: 375eee9fca4d3ff5482cae9ce6742515587e498e
+SHA512:
+  metadata.gz: 548a96549d1c0fb2f21a3c42377fba70735092efc6c2be46bd2f6661c5e4558f1cd22890f6a47098163829289d1e616fc0933ef81289f40c12e4160216fcaff6
+  data.tar.gz: 976eff869da5fe052bfa92c756089b6328990f2e6fbeef0cc46c319b03ac25acfe1218b491edf8646ac3a9dc9f865235d6ec7461990f5deb636146cb2f6b5b9f

data/bin/fix_my_workspace

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+$VERBOSE = nil  # Don't care about world writable dir warnings and the like
+
+if $_fix_my_workspace_version_check
+  $_fix_my_workspace_version = '0.7.0'
+else
+  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
+    # If this script is being run from within an origen-core workspace, use that Origen-core,
+    # not the system-installed origen-core version.
+    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+    require 'origen'
+  else
+    # Use system-installed Origen (the gem in system Ruby)
+    require 'origen'
+  end
+
+  if !Origen.site_config.gem_manage_bundler
+    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
+    puts 'that I cannot make certain assumptions about how your workspace is configured.'
+    puts 'You will need to either resolve this problem yourself, or else change the value of'
+    puts 'gem_mange_bundler to true.'
+    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
+
+  else
+    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
+    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
+    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
+
+    # Force copy system gems to local gems
+    if Origen.site_config.gem_use_from_system
+      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
+      gem_dir = Pathname.new(Gem.dir)
+
+      Origen.site_config.gem_use_from_system.each do |gem, version|
+        begin
+          # This will raise an error if the system doesn't have this gem installed, that
+          # will be rescued below
+          spec = Gem::Specification.find_by_name(gem, version)
+
+          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
+          FileUtils.mkdir_p local_dir
+          FileUtils.cp_r("#{spec.gem_dir}/.", local_dir)
+
+          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
+          FileUtils.mkdir_p local_file.dirname
+          FileUtils.cp(spec.cache_file, local_file)
+
+          if spec.extension_dir && File.exist?(spec.extension_dir)
+            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
+            FileUtils.mkdir_p local_dir
+            FileUtils.cp_r("#{spec.extension_dir}/.", local_dir)
+          end
+
+          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
+          FileUtils.mkdir_p local_file.dirname
+          FileUtils.cp(spec.spec_file, local_file)
+
+        rescue Gem::LoadError
+          # This just means that one of the gems that should be copied from the system
+          # was not actually installed in the system, so nothing we can do about that here
+        end
+      end
+    end
+
+    # Delete lbin
+    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
+
+    # Run bundler with correct switches
+    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
+    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
+    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
+    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
+
+    # Try again, this time updating the bundle
+    if system(cmd)
+      fixed = true
+    elsif system 'bundle update'
+      fixed = true
+    end
+
+    if File.exist?(ENV['BUNDLE_BIN'])
+      `chmod o-w #{ENV['BUNDLE_BIN']}`
+
+      # Make .bat versions of all executables, Bundler should really be doing this when running
+      # on windows
+      if Origen.os.windows?
+        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
+          unless bin =~ /.bat$/
+            bat = "#{bin}.bat"
+            unless File.exist?(bat)
+              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
+            end
+          end
+        end
+      end
+    end
+
+    system 'origen -v' if fixed
+  end
+end

data/config/application.rb

@@ -0,0 +1,103 @@
+require 'origen'
+class OrigenSpiApplication < Origen::Application
+
+  # See http://origen-sdk.org/origen/api/Origen/Application/Configuration.html
+  # for a full list of the configuration options available
+
+  # These attributes should never be changed, the duplication here will be resolved in future
+  # by condensing these attributes that do similar things
+  self.name       = "origen_spi"
+  self.namespace  = "OrigenSpi"
+  config.name     = "origen_spi"
+  config.initials = "OrigenSpi"
+  # Change this to point to the revision control repository for this plugin
+  config.rc_url   = "https://github.com/Origen-SDK/origen_spi.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/origen_spi"
+  config.web_domain = "http://origen-sdk.org/origen_spi"
+
+  # When false Origen will be less strict about checking for some common coding errors,
+  # it is recommended that you leave this to true for better feedback and easier debug.
+  # This will be the default setting in Origen v3.
+  config.strict_errors = true
+
+  # See: http://origen-sdk.org/origen/latest/guides/utilities/lint/
+  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"],
+  }
+
+  config.semantically_version = true
+
+  # An example of how to set application specific LSF parameters
+  #config.lsf.project = "msg.te"
+  
+  # An example of how to specify a prefix to add to all generated patterns
+  #config.pattern_prefix = "nvm"
+
+  # An example of how to add header comments to all generated patterns
+  #config.pattern_header do
+  #  cc "This is a pattern created by the example origen application"
+  #end
+
+  # By default all generated output will end up in ./output.
+  # Here you can specify an alternative directory entirely, or make it dynamic such that
+  # the output ends up in a setup specific directory. 
+  #config.output_directory do
+  #  "#{Origen.root}/output/#{$dut.class}"
+  #end
+
+  # Similarly for the reference files, generally you want to setup the reference directory
+  # structure to mirror that of your output directory structure.
+  #config.reference_directory do
+  #  "#{Origen.root}/.ref/#{$dut.class}"
+  #end
+ 
+  # This will automatically deploy your documentation after every 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
+
+  # Ensure that all tests pass before allowing a release to continue
+  #def validate_release
+  #  if !system("origen specs") || !system("origen examples")
+  #    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
+
+  # To enabled source-less pattern generation create a class (for example PatternDispatcher)
+  # to generate the pattern. This should return false if the requested pattern has been
+  # dispatched, otherwise Origen will proceed with looking up a pattern source as normal.
+  #def before_pattern_lookup(requested_pattern)
+  #  PatternDispatcher.new.dispatch_or_return(requested_pattern)
+  #end
+
+  # If you use pattern iterators you may come across the case where you request a pattern
+  # like this:
+  #   origen g example_pat_b0.atp
+  #
+  # However it cannot be found by Origen since the pattern name is actually example_pat_bx.atp
+  # In the case where the pattern cannot be found Origen will pass the name to this translator
+  # if it exists, and here you can make any substitutions to help Origen find the file you 
+  # want. In this example any instances of _b\d, where \d means a number, are replaced by
+  # _bx.
+  #config.pattern_name_translator do |name|
+  #  name.gsub(/_b\d/, "_bx")
+  #end
+
+end

data/config/boot.rb

@@ -0,0 +1,24 @@
+# This file is used to boot your plugin when it is running in standalone mode
+# from its own workspace - i.e. when the plugin is being developed.
+#
+# It will not be loaded when the plugin is imported by a 3rd party app - in that
+# case only lib/origen_spi.rb is loaded.
+#
+# Therefore this file can be used to load anything extra that you need to boot
+# the development environment for this app. For example, this is typically used
+# to load some additional test classes to use your plugin APIs so that they can
+# be tested and/or interacted with in the console.
+require "origen_spi"
+
+module OrigenSpiDev
+  # Example of how to explicitly require a file
+  # require "origen_spi_dev/my_file"
+    
+  # Load all files in the lib/origen_spi_dev directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/../lib/origen_spi_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/config/commands.rb

@@ -0,0 +1,81 @@
+# This file should be used to extend the origen with application specific commands
+
+# Map any command aliases here, for example to allow 'origen ex' to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "ex" => "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
+
+# (Working) example of how to create an application specific comment, here to generate
+# a tags file for you application to enable method definition lookup and similar within
+# editors/IDEs
+when "tags"  
+  # Here the logic is just written in-line, alternatively it could be written in a
+  # dedicated file and required here, e.g.
+  #require "origen_spi/commands/my_command"    # Would load file lib/origen_spi/commands/my_command.rb
+  Dir.chdir Origen.root do
+    system("ripper-tags -R")
+  end
+  # You must always exit upon successfully capturing and executing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+when "specs"
+  require "rspec"
+  exit RSpec::Core::Runner.run(['spec'])
+
+## Example of how to make a command to run diff-based tests
+when "examples", "test"
+  Origen.load_application
+  status = 0
+
+  ARGV = %w(pattern/clock_test.rb -t default.rb -e default.rb -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"#  #ARGV = %w(some_pattern -t debug -r approved)
+
+  ARGV = %w(pattern/shift_test.rb -t default.rb -e default.rb -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"#  #ARGV = %w(some_pattern -t debug -r approved)
+
+  ARGV = %w(pattern/overlay_test.rb -t default.rb -e default.rb -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"#  #ARGV = %w(some_pattern -t debug -r approved)
+
+  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
+  if @command == "test"
+    Origen.app.unload_target!
+    require "rspec"
+    result = RSpec::Core::Runner.run(['spec'])
+    status = status == 1 ? 1 : result
+  end
+  exit status  # Exit with a 1 on the event of a failure per std unix result codes
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+else
+  # You probably want to also add the your commands to the help shown via
+  # origen -h, you can do this by assigning the required text to @application_commands
+  # before handing control back to Origen.
+  @application_commands = <<-EOT
+ tags         Build a tags file for this app
+  EOT
+# specs        Run the specs (tests), -c will enable coverage
+# examples     Run the examples (tests), -c will enable coverage
+# test         Run both specs and examples, -c will enable coverage
+end 

data/config/version.rb

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

data/lib/origen_spi/driver.rb

@@ -0,0 +1,362 @@
+module OrigenSpi
+  class Driver
+    include Origen::Model
+
+    # Dut pin that serves as the spi clock
+    # @example
+    #   spi_instance.sclk_pin = dut.pin(:p1)
+    attr_reader :sclk_pin
+
+    # Dut pin that serves as the master out slave in pin
+    # @example
+    #   spi_instance.mosi_pin = dut.pin(:p2)
+    attr_reader :mosi_pin
+
+    # Dut pin that serves as the master in slave out
+    # @example
+    #   spi_instance.miso_pin = dut.pin(:p3)
+    attr_reader :miso_pin
+
+    # Dut pin that serves as the slave select
+    # @example
+    #   spi_instance.ss_pin = dut.pin(:p4)
+    # @example
+    #   spi_instance.ss_pin = nil   # no ss pin
+    attr_reader :ss_pin
+
+    # clock format
+    #
+    # available options are:
+    #   :rl   # return low - data changes while sclk is low, latches on rising edge
+    #   :rh   # return high
+    #
+    # @example
+    #   spi_instance.clk_format = :rl
+    attr_reader :clk_format
+
+    # pin state corresponding to slave select active
+    # @example
+    #   spi_instance.ss_active = 0
+    attr_reader :ss_active
+
+    # time between ss_active and the first spi clock
+    #
+    # hash containing the wait time
+    #
+    # @example
+    #   spi_instance.clk_wait_time = {time_in_us: 0}        # no delay
+    #   spi_instance.clk_wait_time = {time_in_ms: 1}        # 1ms delay
+    #   spi_instance.clk_wait_time = {time_in_cycles: 2}    # 2 cycle delay
+    attr_reader :clk_wait_time
+
+    # number of tester cycles per spi clock
+    attr_reader :clk_multiple
+
+    # cycle on which miso compares are placed (0 is the first cycle)
+    attr_reader :miso_compare_cycle
+
+    # data order
+    #
+    # available options are:
+    #   :msb0 - MSB is shifted first
+    #   :lsb0
+    #
+    # @example
+    #   spi_instance.data_order = :lsb0
+    attr_reader :data_order
+
+    # internal attribute
+    attr_reader :settings_validated
+
+    # options hash can configure
+    #
+    # @example
+    #   options = {
+    #     sclk_pin: dut.pin(:p1),
+    #     mosi_pin: dut.pin(:p2),
+    #     miso_pin: dut.pin(:p3),
+    #     ss_pin: dut.pin(:p4),
+    #     clk_format: :rl,
+    #     ss_active: 0,
+    #     clk_wait_time: {time_in_cycles: 2},
+    #     clk_multiple: 2,
+    #     miso_compare_cycle: 1,
+    #     data_order: :msb0
+    #   }
+    #   spi = OrigenSpi::Driver.new(options)
+    def initialize(options = {})
+      options = {
+        sclk_pin:      nil,
+        mosi_pin:      nil,
+        miso_pin:      nil,
+        ss_pin:        nil,
+        clk_format:    :nr,
+        ss_active:     0,
+        clk_wait_time: { time_in_us: 0 },
+        clk_multiple:  2,
+        data_order:    :msb0
+      }.merge(options)
+
+      @sclk_pin = options[:sclk_pin]
+      @mosi_pin = options[:mosi_pin]
+      @miso_pin = options[:miso_pin]
+      @ss_pin = options[:ss_pin]
+      @clk_format = options[:clk_format]
+      @ss_active = options[:ss_active]
+      @clk_wait_time = options[:clk_wait_time]
+      @clk_multiple = options[:clk_multiple]
+      @miso_compare_cycle = options[:miso_compare_cycle] ? options[:miso_compare_cycle] : @clk_multiple - 1
+      @data_order = options[:data_order]
+      @settings_validated = false
+    end
+
+    def sclk_pin=(pin)
+      @sclk_pin = pin
+      @settings_validated = false
+    end
+
+    def mosi_pin=(pin)
+      @mosi_pin = pin
+      @settings_validated = false
+    end
+
+    def miso_pin=(pin)
+      @miso_pin = pin
+      @settings_validated = false
+    end
+
+    def ss_pin=(pin)
+      @ss_pin = pin
+      @settings_validated = false
+    end
+
+    def clk_format=(format)
+      if format == :nr || format == :rl || format == :rh
+        @clk_format = format
+      else
+        Origen.log.error "Invalid clock format for OrigenSpi::Driver -> #{format}"
+        Origen.log.error 'Valid formats are :rl, :rh'
+      end
+      @settings_validated = false
+    end
+
+    def ss_active=(state)
+      if state == 0 || state == 1
+        @ss_active = state
+      else
+        Origen.log.error 'Invalid OrigenSpi::Driver.ss_active state (valid states are 0 and 1)'
+      end
+      @settings_validated = false
+    end
+
+    def clk_wait_time=(clk_wait)
+      @clk_wait_time = clk_wait
+      @settings_validated = false
+    end
+
+    def clk_multiple=(mult)
+      @clk_multiple = mult
+      @settings_validated = false
+    end
+
+    def miso_compare_cycle=(cycle)
+      @miso_compare_cycle = cycle
+      @settings_validated = false
+    end
+
+    def data_order=(order)
+      if order == :msb0 || order == :lsb0
+        @data_order = order
+      else
+        Origen.log.error "Invalid OrigenSpi::Driver.data_order -> #{order}, (use :msb0 or :lsb0)"
+      end
+    end
+
+    # Check settings
+    def validate_settings
+      unless @settings_validated
+        settings_valid = true
+
+        # check that clock and miso are provided
+        unless @sclk_pin.is_a?(Origen::Pins::Pin)
+          settings_valid = false
+          Origen.log.error 'OrigenSpi::Driver.sclk_pin must be an Origen pin object'
+        end
+
+        unless @clk_format == :rl || @clk_format == :rh
+          settings_valid = false
+          Origen.log.error 'OrigenSpi::Driver.clk_format must be one of :rl, :rh'
+        end
+
+        unless @ss_active == 0 || @ss_active == 1
+          settings_valid = false
+          Origen.log.error 'OrigenSpi::Driver.ss_active must be either 0 or 1'
+        end
+
+        @clk_multiple = 1 if @clk_multiple < 1
+        @half_cycle = @clk_multiple / 2
+
+        @miso_compare_cycle = @clk_multiple - 1 if @miso_compare_cycle > @clk_multiple - 1
+
+        unless @data_order == :msb0 || @data_order == :lsb0
+          settings_valid = false
+          Origen.log.error 'OrigenSpi::Driver.data_order must be either :msb0 or :lsb0'
+        end
+
+        @settings_validated = settings_valid
+      end
+    end
+
+    # Run a spi clock cycle
+    #
+    # This method can be used to clock the spi port without specifying shift data
+    def sclk_cycle
+      validate_settings
+      cc 'OrigenSpi::Driver - Issue a clock cycle'
+      @sclk_pin.restore_state do
+        @sclk_pin.drive @clk_format == :rl ? 0 : 1
+        @half_cycle.times { tester.cycle }
+        @sclk_pin.drive @clk_format == :rl ? 1 : 0
+        @half_cycle.upto(@clk_multiple - 1) { tester.cycle }
+      end
+    end
+
+    # Shift a spi packet
+    #
+    # Overlay and capture is specified through reg.overlay and reg.store
+    #
+    # @example
+    #   spi_instance.shift master_out: out_reg, master_in: in_cmp_reg
+    # @example
+    #   spi_instance.shift master_out: 0x7a, size: 32
+    # @example
+    #   spi_instance.shift master_in: in_cmp_reg
+    def shift(options = {})
+      options = {
+        master_out: 0
+      }.merge(options)
+
+      validate_settings
+      options = validate_options(options)
+      out_reg = build_output_packet(options).bits
+      in_reg = build_input_packet(options).bits
+
+      # reverse bit order if :msb0
+      if @data_order == :msb0
+        out_reg = out_reg.reverse
+        in_reg = in_reg.reverse
+      end
+
+      # set ss active
+      @ss_pin.drive @ss_active unless @ss_pin.nil?
+
+      # apply wait time if requested
+      tester.wait @clk_wait_time unless @clk_wait_time == { time_in_us: 0 }
+
+      # now do the shifting
+      0.upto(out_reg.size - 1) do |bit|
+        # park the clock
+        @sclk_pin.drive @clk_format == :rl ? 0 : 1
+        @miso_pin.dont_care unless @miso_pin.nil?
+
+        # setup the bit to be driven, prep for overlay if requested
+        overlay_options = {}
+        unless @mosi_pin.nil?
+          @mosi_pin.drive out_reg[bit].data
+          if out_reg[bit].has_overlay?
+            overlay_options[:pins] = @mosi_pin
+            overlay_options[:overlay_str] = out_reg[bit].overlay_str
+          end
+        end
+
+        # advance to clock active edge
+        @half_cycle.times do |c|
+          handle_miso c, in_reg[bit]
+          cycle overlay_options
+          overlay_options[:change_data] = false unless overlay_options == {}
+        end
+
+        # drive the clock to active
+        @sclk_pin.drive @clk_format == :rl ? 1 : 0
+
+        # advance to the end of the sclk cycle checking for appropriate miso compare placement
+        @half_cycle.upto(@clk_multiple - 1) do |c|
+          handle_miso c, in_reg[bit]
+          cycle overlay_options
+        end
+      end
+
+      # park the clock, mask miso, clear ss
+      @sclk_pin.drive @clk_format == :rl ? 0 : 1
+      @miso_pin.dont_care unless @miso_pin.nil?
+      @mosi_pin.drive 0 unless @mosi_pin.nil?
+      @ss_pin.drive @ss_active == 1 ? 0 : 1 unless @ss_pin.nil?
+    end
+
+    # Internal method
+    #
+    # Set the state of miso
+    def handle_miso(c, bit)
+      unless @miso_pin.nil?
+        if c == @miso_compare_cycle
+          @miso_pin.assert bit.data if bit.is_to_be_read?
+          tester.store_next_cycle @miso_pin if bit.is_to_be_stored?
+        else
+          @miso_pin.dont_care
+        end
+      end
+    end
+
+    # Internal method
+    #
+    # Issue a tester cycle, conditionally with overlay options supplied
+    def cycle(overlay_options = {})
+      overlay_options == {} ? tester.cycle : (tester.cycle overlay: overlay_options)
+    end
+
+    # Build the shift out packet
+    #
+    # This is an internal method used by the shift method
+    def build_output_packet(options)
+      out_reg = Origen::Registers::Reg.dummy(options[:size])
+      if options[:master_out].respond_to?(:data)
+        out_reg.copy_all(options[:master_out])
+      else
+        out_reg.write options[:master_out]
+      end
+      out_reg
+    end
+
+    # Build the input packet
+    #
+    # This is an internal method used by the shift method
+    def build_input_packet(options)
+      in_reg = Origen::Registers::Reg.dummy(options[:size])
+      if options[:master_in].respond_to?(:data)
+        in_reg.copy_all(options[:master_in])
+      else
+        unless options[:master_in].nil?
+          in_reg.write options[:master_in]
+          in_reg.read
+        end
+      end
+      in_reg
+    end
+
+    # Internal method that logs errors in options passed to the shift method
+    def validate_options(options)
+      # check that size of the packet can be determined
+      unless options[:size]
+        options[:size] = options[:master_in].size if options[:master_in].respond_to?(:data)
+      end
+      unless options[:size]
+        options[:size] = options[:master_out].size if options[:master_out].respond_to?(:data)
+      end
+      unless options[:size]
+        Origen.log.error "OrigenSpi::Driver can't determine the packet size"
+        exit
+      end
+      options
+    end
+  end
+end

data/lib/origen_spi.rb

@@ -0,0 +1,19 @@
+require 'origen'
+require 'origen_testers'
+require_relative '../config/application.rb'
+module OrigenSpi
+  # THIS FILE SHOULD ONLY BE USED TO LOAD RUNTIME DEPENDENCIES
+  # If this plugin has any development dependencies (e.g. dummy DUT or other models that are only used
+  # for testing), then these should be loaded from config/boot.rb
+
+  # Example of how to explicitly require a file
+  # require "origen_spi/my_file"
+
+  # Load all files in the lib/origen_spi directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/origen_spi/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/lib/tasks/origen_spi.rake

@@ -0,0 +1,6 @@
+# You can define any Rake tasks to support your application here (or in any file
+# ending in .rake in this directory).
+#
+# Rake (Ruby Make) is very useful for creating build scripts, see this short video
+# for a quick introduction:
+# http://railscasts.com/episodes/66-custom-rake-tasks

data/pattern/clock_test.rb

@@ -0,0 +1,39 @@
+Pattern.create do
+  tester.set_timeset 'tp0', 20
+  dut.pin(:ss).drive 1
+  dut.pin(:sclk).drive 0
+  dut.pin(:mosi).drive 0
+  dut.pin(:miso).dont_care
+  
+  tester.cycle
+  dut.spi.sclk_cycle
+  tester.cycle
+  
+  cc 'change multiple to 2'
+  dut.spi.clk_multiple = 2
+  dut.spi.sclk_cycle
+  tester.cycle
+  
+  cc 'change multiple to 80'
+  dut.spi.clk_multiple = 80
+  dut.spi.sclk_cycle
+  tester.cycle
+  
+  cc 'change clock format and repeat'
+  dut.pin(:sclk).drive 1
+  dut.spi.clk_format = :rh
+  dut.spi.clk_multiple = 1
+  dut.spi.sclk_cycle
+  tester.cycle
+
+  cc 'change multiple to 2'
+  dut.spi.clk_multiple = 2
+  dut.spi.sclk_cycle
+  tester.cycle
+  
+  cc 'change multiple to 80'
+  dut.spi.clk_multiple = 80
+  dut.spi.sclk_cycle
+  tester.cycle
+  
+end

data/pattern/overlay_test.rb

@@ -0,0 +1,18 @@
+Pattern.create do
+  tester.set_timeset 'tp0', 20
+  dut.pin(:ss).drive 1
+  dut.pin(:sclk).drive 0
+  dut.pin(:mosi).drive 0
+  dut.pin(:miso).dont_care
+  
+  tester.cycle
+  tester.overlay_style = :label
+  out_data = Origen::Registers::Reg.dummy(12).write 7
+  out_data.bits[3..0].overlay 'heres_the_label'
+  dut.spi.shift master_out: out_data
+  
+  cc 'repeat test reversing bit order'
+  dut.spi.data_order = :msb0
+  out_data.bits[3..0].overlay 'heres_the_other_label'
+  dut.spi.shift master_out: out_data
+end

data/pattern/shift_test.rb

@@ -0,0 +1,61 @@
+Pattern.create do
+  tester.set_timeset 'tp0', 20
+  dut.pin(:ss).drive 1
+  dut.pin(:sclk).drive 0
+  dut.pin(:mosi).drive 0
+  dut.pin(:miso).dont_care
+  
+  tester.cycle
+
+  out_data = Origen::Registers::Reg.dummy(12).write 7
+  in_data = Origen::Registers::Reg.dummy(12).read 0x5a5
+  cc 'shifting 12-bits lsb first, 0x7 out, 0x5a5 in'
+  dut.spi.shift master_out: out_data, master_in: in_data
+  
+  tester.cycle
+  
+  cc 'repeat 12-bits lsb first, 0x7 out, 0x5a5 in; clock multiple = 4'
+  dut.spi.clk_multiple = 4
+  dut.spi.shift master_out: out_data, master_in: in_data
+  
+  tester.cycle
+  
+  cc 'repeat 12-bits, 0x7 out, 0x5a5 in; clock multiple = 4, with msb first, move miso compare to cycle 3'
+  dut.spi.data_order = :msb0
+  dut.spi.miso_compare_cycle = 3
+  dut.spi.shift master_out: out_data, master_in: in_data
+
+  tester.cycle
+  
+  cc 'Now check bit masking'
+  cc 'shift 0xa5a, 12-bits, msb first, multiple = 1, clk format :rh, all bits masked'
+  dut.spi.clk_format = :rh
+  dut.spi.clk_multiple = 1
+  dut.spi.shift master_out: 0xa5a, size: 12
+  
+  tester.cycle
+  
+  cc 'repeat same, comparing for LLLL_XXXX_HHHH, clock back to :rl'
+  dut.spi.clk_format = :rl
+  in_data.write 0xf
+  in_data.bits[11..8].read
+  in_data.bits[7..4].clear_flags
+  in_data.bits[3..0].read
+  dut.spi.shift master_out: 0xa5a, master_in: in_data
+  
+  tester.cycle
+  
+  cc 'test capture'
+  in_data.bits[7..4].store
+  dut.spi.shift master_out: 0xa5a, master_in: in_data
+  
+  tester.cycle
+  
+  # cc 'test overlay, label should appear at bit 3'
+  # out_data.write 0xa5a
+  # out_data.bits[3..0].overlay 'heres_the_label'
+  # tester.overlay_style = :label
+  # dut.spi.shift master_out: out_data
+  
+  # tester.cycle
+end

data/templates/web/index.md.erb

@@ -0,0 +1,68 @@
+% 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 plugin implements SPI protocol with the tester acting as the master. There are 4 pins standard to SPI, 
+however only sclk is required by this plugin. Any pins that aren't provided are ignored. This plugin seeks
+to be very flexible given that the SPI standard is itself very flexible.
+
+### How To Install
+
+In your Gemfile add:
+
+~~~ruby
+gem "<%= Origen.app.name %>"
+~~~
+
+or if your application is a plugin, then add this to your <code>.gemspec</code>
+
+~~~ruby
+spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+__NOTE:__  In the case of a plugin, you will also need to <code>require '<%= Origen.app.name %>'</code> somewhere in your environment.
+
+
+### How To Use
+
+The spi driver is intended to be instantiated as a sub_block. The configuration can be passed in as a hash and / or 
+can be changed after instantiation. See API for more details.
+
+~~~ruby
+        sub_block :spi, class_name:   'OrigenSpi::Driver',
+                        sclk_pin:     dut.pin(:sclk),
+                        mosi_pin:     dut.pin(:mosi),
+                        miso_pin:     dut.pin(:miso),
+                        ss_pin:       dut.pin(:ss),
+                        # :rl - return low - input data changes while sclk is low and is latched on rising edge
+                        clk_format:   :rl,
+                        # drive state of 0 activates the slave port
+                        ss_active:    0,
+                        # wait time after ss_active and before any sclk activity
+                        clk_wait_time: {time_in_cycles: 2},
+                        # number of sclks per tester.cycle
+                        clk_multiple: 1,
+                        data_order:   :lsb0
+~~~
+
+~~~ruby
+  # configuration can be changed after instantiation like this
+  dut.spi.clk_multiple = 80
+  dut.spi.miso_compare_cycle = 79
+  dut.spi.ss_pin = nil
+~~~
+
+
+### How To Setup a Development Environment
+
+To setup a development environment:
+
+~~~
+  git clone https://github.com/Origen-SDK/origen_spi.git
+~~~
+
+% end

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

@@ -0,0 +1,13 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= render "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 %>    
+
+</div>
+</div>

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

@@ -0,0 +1,20 @@
+<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] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</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,86 @@
+--- !ruby/object:Gem::Specification
+name: origen_spi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul DeRouen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-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.28.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.28.2
+- !ruby/object:Gem::Dependency
+  name: origen_testers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: 
+email:
+- paul.derouen@nxp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/fix_my_workspace
+- config/application.rb
+- config/boot.rb
+- config/commands.rb
+- config/version.rb
+- lib/origen_spi.rb
+- lib/origen_spi/driver.rb
+- lib/tasks/origen_spi.rake
+- pattern/clock_test.rb
+- pattern/overlay_test.rb
+- pattern/shift_test.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: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Driver for SPI protocol
+test_files: []