origen_app_generators 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd970f1c3187d496d80d9a9eec9778a176d03bcb
-  data.tar.gz: 30052184f57fd16a98e56a8f813dd016a6c5f21e
+  metadata.gz: 5ff04d0825d25acb5a3de404f6803423bfa64b09
+  data.tar.gz: d2722bb1659bcc25b9e1f8142f4a5bd6808d84fa
 SHA512:
-  metadata.gz: 409567a4b79e454d1489b4525785f6d3b32aed821cdea39ed42974bb614ebc86a4fbb694a2c6d58be5bf42dbedef30e912275a4f63ec94a3b901375f2e050283
-  data.tar.gz: 170b9a1478b8899b7fe701041086f6b97ef0f95b8fb38d2bb20656e5fe6e55d27826e21d7319279a4c6e65da811f043fac29bba2b2d4479e02d13ce548bbb392
+  metadata.gz: 08a461b46d822b9d7e914b0a0b646ede13f964b130f2540d0cea7235f1be1627341cdab2f970881541842cf2a65fb85e129f78b918c6260a88e7639ff66a9bc3
+  data.tar.gz: f70719cb2766fe6bd0328b38bb8f6eceb990b395629425f5d2f202109cdce910195ba6d96ebad13aae786dd9b27281a7748c8210517e33d65daf7e6e7552bd2e

data/config/version.rb

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

data/lib/origen_app_generators/plugin.rb

@@ -4,7 +4,7 @@ module OrigenAppGenerators
     def get_common_user_input
       get_name_and_namespace
       get_summary
-      get_audience
+      get_audience unless @audience
     end
 
     protected
@@ -43,7 +43,7 @@ module OrigenAppGenerators
       puts
       puts 'IS THIS PLUGIN GOING TO BE RELEASED TO AN EXTERNAL AUDIENCE?'
       puts
-      puts 'By answering yes...'
+      puts 'By answering yes, this plugin will be pushed to rubygems.org when it is released and it will be available outside of your company.'
       puts
       confirm_external = get_text(confirm: :return_boolean, default: 'no')
       @audience = :external if confirm_external

data/lib/origen_app_generators/test_engineering/test_block.rb

@@ -2,25 +2,95 @@ module OrigenAppGenerators
   module TestEngineering
     # Generates a generic plugin shell
     class TestBlock < Plugin
-      desc 'A test block intended to plugin into a top-level application'
+      desc 'An IP test module intended to plugin into a top-level (SoC) application'
+
+      def initialize(*args)
+        @audience = :internal
+        super
+      end
+
+      def get_user_input
+        # The methods to get the common user input that applies to all applications will
+        # get called at the start automatically, you have a chance here to ask any additional
+        # questions that are specific to the type of application being generated
+        get_ip_names
+        get_sub_block_name
+      end
 
       def generate_files
         @runtime_dependencies = [
-          ['origen_testers', '>= 0.3.0.pre35']
+          ['origen_testers', '>= 0.6.1']
         ]
         build_filelist
       end
 
-      def add_requires
+      def final_modifications
         prepend_to_file "lib/#{@name}.rb", "require 'origen_testers'\n"
+        # Add require line
+        doc_helpers = /gem 'origen_doc_helpers'/
+        inject_into_file 'Gemfile', "\ngem 'origen_jtag'\ngem 'origen_arm_debug'\n",
+                         after: doc_helpers
       end
 
       def conclude
-        puts "New test block created at: #{destination_root}"
+        puts "New test module created at: #{destination_root}"
+        puts
+        puts 'Generate an example pattern by running "origen g example"'
       end
 
       protected
 
+      def get_ip_names
+        puts
+        puts 'NAME THE IP BLOCKS THAT THIS MODULE WILL SUPPORT'
+        puts
+        puts "You don't need to name them all up front, but you must declare at least one."
+        puts 'We recommend that you use the official name(s) for the IP(s) as used by your design team.'
+        puts 'Separate multiple names with a comma:    FLASH_C40_512K, FLASH_C40_2M'
+        puts
+
+        valid = false
+        until valid
+          @ip_names = get_text(single: true).strip.split(',').map do |name|
+            n = name.strip.symbolize.to_s.upcase
+            unless n.empty?
+              n
+            end
+          end.compact
+          unless @ip_names.empty?
+            # Should we check anything here?
+            valid = true
+          end
+        end
+        @ip_names
+      end
+
+      def get_sub_block_name
+        puts
+        puts "WHAT SHOULD BE THE PATH TO #{@ip_names.first} WHEN IT IS INSTANTIATED IN AN SOC?"
+        puts
+        puts 'Your IPs will be instantiated by a top-level (SoC) model, at which point it should be given a generic nickname'
+        puts 'that will provide an easy way to access it.'
+        puts 'For example, if you had an IP model for an NVM block, the IP name might be "FLASH_C40_512K_128K", but when it is'
+        puts 'instantiated it would be given the name "flash", allowing it be easily accessed as "dut.flash".'
+        puts
+
+        valid = false
+        until valid
+          @sub_block_name = get_text(single: true).strip.split(',').map do |name|
+            n = name.strip.symbolize.to_s.downcase
+            unless n.empty?
+              n
+            end
+          end.compact
+          unless @sub_block_name.empty?
+            # Should we check anything here?
+            valid = true
+          end
+        end
+        @sub_block_name = @sub_block_name.first
+      end
+
       # Defines the filelist for the generator, the default list is inherited from the
       # parent class (Plugin).
       # The filelist can contain references to generate files, directories or symlinks in the
@@ -45,9 +115,10 @@ module OrigenAppGenerators
           list.delete(:target_production)
           # Example of how to add a file, in this case the file will be compiled and copied to
           # the same location in the new app
-          list[:target_v93k] = { source: 'target/v93k.rb' }
-          list[:target_j750] = { source: 'target/j750.rb' }
-          list[:target_ultraflex] = { source: 'target/ultraflex.rb' }
+          list[:target_default] = { source: 'target/default.rb' }
+          list[:environment_v93k] = { source: 'environment/v93k.rb' }
+          list[:environment_j750] = { source: 'environment/j750.rb' }
+          list[:environment_ultraflex] = { source: 'environment/ultraflex.rb' }
           list[:program_prb1] = { source: 'program/prb1.rb' }
           list[:lib_interface] = { source: 'lib/interface.rb', dest: "lib/#{@name}/interface.rb" }
           # Alternatively specifying a different destination, typically you would do this when
@@ -56,9 +127,32 @@ module OrigenAppGenerators
           # Example of how to create a directory
           list[:pattern_dir] = { dest: 'pattern', type: :directory }
           # Example of how to create a symlink
-          list[:target_default] = { source: 'j750.rb',          # Relative to the file being linked to
-                                    dest:   'target/default.rb', # Relative to destination_root
-                                    type:   :symlink }
+          list[:environment_default] = { source: 'ultraflex.rb',           # Relative to the file being linked to
+                                         dest:   'environment/default.rb', # Relative to destination_root
+                                         type:   :symlink }
+          list[:test_dut] = { source:  'lib/test/dut.rb',
+                              dest:    "lib/#{@name}/test/dut.rb",
+                              options: { class_name: @ip_names.first, sub_block_name: @sub_block_name }
+                            }
+          list[:test_dutc] = { source: 'lib/test/dut_controller.rb',
+                               dest:   "lib/#{@name}/test/dut_controller.rb"
+                            }
+
+          @ip_names.each_with_index do |name, i|
+            list["ip_#{i}"] = { source:  'lib/model.rb',
+                                dest:    "lib/#{@name}/#{name.underscore}.rb",
+                                options: { name: name }
+                              }
+
+            list["ip_controller_#{i}"] = { source:  'lib/controller.rb',
+                                           dest:    "lib/#{@name}/#{name.underscore}_controller.rb",
+                                           options: { name: name }
+                                         }
+          end
+
+          list[:pattern_example] = { source:  'pattern/example.rb',
+                                     options: { sub_block_name: @sub_block_name }
+                                   }
           # Remember to return the final list
           list
         end

data/lib/origen_app_generators.rb

@@ -18,14 +18,16 @@ module OrigenAppGenerators
     # Empty plugin
     ['0', '1', :default, :default, 'A test block', 'yes', []],
     # Stand alone test engineering app
-    ['1', '0', :default, :default, 'Falcon, Eagle', 'Falcon[ram, atd(2), comm[ram(2), osc](3)], Eagle[ram(2), atd(4)]', ['origen g example']]
+    ['1', '0', :default, :default, 'Falcon, Eagle', 'Falcon[ram, atd(2), comm[ram(2), osc](3)], Eagle[ram(2), atd(4)]', ['origen g example']],
+    # Test module
+    ['1', '1', :default, :default, 'Test module for all flash IPs', 'FLASH_512K, FLASH_1024K', 'flash', ['origen g example']]
   ]
 
   # If adding any new generators manually always add them at the top, but
   # generally speaking don't, use 'rake new' to create a new generator instead
   AVAILABLE = {
     'Test Engineering' => [
-      # OrigenAppGenerators::TestEngineering::TestBlock,
+      OrigenAppGenerators::TestEngineering::TestBlock,
       OrigenAppGenerators::TestEngineering::StandAloneApplication
     ]
   }

data/lib/tasks/app_generators.rake

@@ -70,7 +70,6 @@ def _execute_generator(klass)
   # With the generator identified this now launches it in a standalone shell
   # This is to emulate how it will run in real life and cause it to fail if there are
   # any dependencies on running within an Origen app environment
-
   boot = "#{File.expand_path(File.dirname(__FILE__))}/boot.rb"
   origen_lib = "#{Origen.top}/lib"
   origen_lib = '/proj/mem_c40tfs_testeng/r49409/origen/lib'

data/lib/tasks/boot.rb

@@ -25,11 +25,7 @@ begin
   Dir.chdir tmp_dir do
     # For some reason this is not being defined by required origen anymore
     User = Origen::Users::User unless defined? User
-    if RUBY_VERSION >= '2.0.0'
-      gem 'byebug', '~>3.5'
-    else
-      gem 'debugger', '~>1.6'
-    end
+    gem 'byebug'
     require 'origen_app_generators'
     if ARGV[1] == 'invoke'
       OrigenAppGenerators.invoke('tmp')

data/templates/app_generators/application/Gemfile

@@ -7,4 +7,8 @@ gem 'origen', '>= <%= @latest_origen_version %>'
 
 gem 'origen_doc_helpers'
 
-gem 'byebug', '~>3.5'
+gem 'byebug'
+
+# Uncomment these if you want to use a visual debugger (e.g. Visual Studio Code) to debug your app
+#gem 'ruby-debug-ide'
+#gem 'debase'

data/templates/app_generators/plugin/Gemfile

@@ -3,13 +3,19 @@ source 'https://rubygems.org'
 source '<%= Origen.site_config.gem_server %>'
 <% end -%>
 
-# Specify your gem's dependencies in <%= @name %>.gemspec
-gemspec
-
-# Only these gems should be added here
+# Only development dependencies (things your only plugin needs when running in its own workspace) should
+# be listed here in the Gemfile
 <% if @audience == :external -%>
 # This gem provides integration with https://coveralls.io/ to monitor
 # your application's test coverage
 gem 'coveralls', require: false
 <% end -%>
-gem 'byebug', '~>3.5'
+gem 'byebug'
+gem 'origen_doc_helpers'
+# Uncomment these if you want to use a visual debugger (e.g. Visual Studio Code) to debug your app
+#gem 'ruby-debug-ide'
+#gem 'debase'
+
+# Specify your gem's runtime dependencies in <%= @name %>.gemspec
+# THIS LINE SHOULD BE LEFT AT THE END
+gemspec

data/templates/app_generators/plugin/gemspec.rb

@@ -34,7 +34,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
   <% end -%>
 <% end -%>
-
-  # Add any gems that your plugin needs for its development environment only
-  spec.add_development_dependency "origen_doc_helpers"
 end

data/templates/app_generators/test_engineering/test_block/environment/j750.rb

@@ -0,0 +1,2 @@
+# Instantiate a tester driver, this will be globally available as 'tester'
+OrigenTesters::J750.new

data/templates/app_generators/test_engineering/test_block/environment/ultraflex.rb

@@ -0,0 +1,2 @@
+# Instantiate a tester driver, this will be globally available as 'tester'
+OrigenTesters::UltraFLEX.new

data/templates/app_generators/test_engineering/test_block/environment/v93k.rb

@@ -0,0 +1,2 @@
+# Instantiate a tester driver, this will be globally available as 'tester'
+OrigenTesters::V93K.new

data/templates/app_generators/test_engineering/test_block/lib/controller.rb

@@ -0,0 +1,12 @@
+module <%= @namespace %>
+  class <%= @options[:name] %>Controller
+    include Origen::Controller
+
+    def do_something
+      # The config register is defined in the corresponding model
+      config.mode.write!(0x14)
+      tester.wait(time_in_us: 100)
+      config.secure.read!(0)
+    end
+  end
+end

data/templates/app_generators/test_engineering/test_block/lib/interface.rb

@@ -1,6 +1,5 @@
 module <%= @namespace %>
   class Interface
-    include Testers::ProgramGenerators
-    include Testers::BasicTestSetups
+    include OrigenTesters::ProgramGenerators
   end
 end

data/templates/app_generators/test_engineering/test_block/lib/model.rb

@@ -0,0 +1,18 @@
+module <%= @namespace %>
+  class <%= @options[:name] %>
+    include Origen::Model
+
+    def initialize(options = {})
+      instantiate_registers(options)
+    end
+
+    def instantiate_registers(options)
+      # Define your IP's registers here
+      reg :config, 0x0, size: 32 do |reg|
+        reg.bits 15..8, :mode
+        reg.bit 1, :ext_clk, reset: 1
+        reg.bit 0, :secure, access: :ro
+      end
+    end
+  end
+end

data/templates/app_generators/test_engineering/test_block/lib/test/dut.rb

@@ -0,0 +1,27 @@
+module <%= @namespace %>
+  module Test
+    # This is a dummy DUT class that should be used to test that your test module can
+    # integrate into a top-level app
+    class DUT
+      include Origen::TopLevel
+
+      def initialize(options = {})
+        instantiate_pins(options)
+        instantiate_sub_blocks(options)
+      end
+
+      def instantiate_pins(options)
+        add_pin :tclk
+        add_pin :tdi
+        add_pin :tdo
+        add_pin :tms
+        add_pin :resetb
+      end
+
+      def instantiate_sub_blocks(options)
+        sub_block :arm_debug, class_name: 'OrigenARMDebug::Driver', aps: { mem_ap: 0x0, mdmap: 0x0100_0000 }
+        sub_block :<%= options[:sub_block_name] %>, class_name: '<%= @namespace %>::<%= options[:class_name] %>', base_address: 0x1000_0000
+      end
+    end
+  end
+end

data/templates/app_generators/test_engineering/test_block/lib/test/dut_controller.rb

@@ -0,0 +1,32 @@
+module <%= @namespace %>
+  module Test
+    # This is a dummy DUT controller that should be used to test that your test module can
+    # integrate into a top-level app
+    class DUTController
+      include Origen::TopLevel
+      include OrigenJTAG
+      include OrigenARMDebug
+
+      def startup(options = {})
+        tester.set_timeset('func_25', 40)
+        ss 'Startup the SoC'
+        pin(:resetb).drive!(0)
+        100.cycles
+        pin(:resetb).dont_care
+      end
+
+      def shutdown(options = {})
+        ss 'Shutdown the SoC'
+        pin(:resetb).drive!(0)
+      end
+
+      def write_register(reg, options = {})
+        arm_debug.write_register(reg, options)
+      end
+
+      def read_register(reg, options = {})
+        arm_debug.read_register(reg, options)
+      end
+    end
+  end
+end

data/templates/app_generators/test_engineering/test_block/pattern/example.rb

@@ -0,0 +1,5 @@
+Pattern.create do
+  # Registers should never be written directly from here, always call API methods
+  # that are defined by your controllers
+  dut.<%= options[:sub_block_name] %>.do_something
+end

data/templates/app_generators/test_engineering/test_block/program/prb1.rb

@@ -1,9 +1,11 @@
 Flow.create interface: '<%= @namespace %>::Interface' do
 
   if_job :p1 do
-    functional :test1, bin: 10, id: :t1
+    test :test1, bin: 10, id: :t1
 
-    functional :test2, bin: 15, if_failed: :t1
+    test :test2, bin: 15, if_failed: :t1
   end
 
+  pass 1, softbin: 55
+
 end

data/templates/app_generators/test_engineering/test_block/target/default.rb

@@ -0,0 +1,2 @@
+# Instantiate a DUT instance, this will be globally available as 'dut'
+<%= @namespace %>::Test::DUT.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -93,11 +93,17 @@ files:
 - templates/app_generators/test_engineering/stand_alone_application/lib/top_level_controller.rb
 - templates/app_generators/test_engineering/stand_alone_application/pattern/example.rb
 - templates/app_generators/test_engineering/stand_alone_application/target/top_level.rb
+- templates/app_generators/test_engineering/test_block/environment/j750.rb
+- templates/app_generators/test_engineering/test_block/environment/ultraflex.rb
+- templates/app_generators/test_engineering/test_block/environment/v93k.rb
+- templates/app_generators/test_engineering/test_block/lib/controller.rb
 - templates/app_generators/test_engineering/test_block/lib/interface.rb
+- templates/app_generators/test_engineering/test_block/lib/model.rb
+- templates/app_generators/test_engineering/test_block/lib/test/dut.rb
+- templates/app_generators/test_engineering/test_block/lib/test/dut_controller.rb
+- templates/app_generators/test_engineering/test_block/pattern/example.rb
 - templates/app_generators/test_engineering/test_block/program/prb1.rb
-- templates/app_generators/test_engineering/test_block/target/j750.rb
-- templates/app_generators/test_engineering/test_block/target/ultraflex.rb
-- templates/app_generators/test_engineering/test_block/target/v93k.rb
+- templates/app_generators/test_engineering/test_block/target/default.rb
 homepage: http://origen-sdk.org/origen_app_generators
 licenses:
 - LGPL-3
@@ -118,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Origen application generators

data/templates/app_generators/test_engineering/test_block/target/j750.rb

@@ -1,10 +0,0 @@
-# The target file is run before *every* Origen operation and is used to instantiate
-# the runtime environment - usually this means instantiating a top-level SoC or
-# IP model.
-#
-# Naming is arbitrary but instances names should be prefixed with $ which indicates a 
-# global variable in Ruby, and this is required in order for the objects instantiated
-# here to be visible throughout your application code.
-
-$dut = <%= @namespace %>::TopLevel.new   # Instantiate a DUT instance
-$tester = Testers::J750.new

data/templates/app_generators/test_engineering/test_block/target/ultraflex.rb

@@ -1,10 +0,0 @@
-# The target file is run before *every* Origen operation and is used to instantiate
-# the runtime environment - usually this means instantiating a top-level SoC or
-# IP model.
-#
-# Naming is arbitrary but instances names should be prefixed with $ which indicates a 
-# global variable in Ruby, and this is required in order for the objects instantiated
-# here to be visible throughout your application code.
-
-$dut = <%= @namespace %>::TopLevel.new   # Instantiate a DUT instance
-$tester = Testers::UltraFLEX.new

data/templates/app_generators/test_engineering/test_block/target/v93k.rb

@@ -1,10 +0,0 @@
-# The target file is run before *every* Origen operation and is used to instantiate
-# the runtime environment - usually this means instantiating a top-level SoC or
-# IP model.
-#
-# Naming is arbitrary but instances names should be prefixed with $ which indicates a 
-# global variable in Ruby, and this is required in order for the objects instantiated
-# here to be visible throughout your application code.
-
-$dut = <%= @namespace %>::TopLevel.new   # Instantiate a DUT instance
-$tester = Testers::V93K.new