origen_app_generators 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baaaf6651be7c3e72a8c096f41aa9216367d3957
-  data.tar.gz: fe6fccc7a9b7fe51b6932662b646eb996c434ef5
+  metadata.gz: 0db247768f806c9048a8a170957e6d7911495b29
+  data.tar.gz: 20fc9fd317c56b32ed52fcb88d3c7737c70bf395
 SHA512:
-  metadata.gz: 63c696618bf5beb61fef8a94bc6273b992c782a5e62eb0752149c1ee897cd08109324ac87e4488f91db540cd6367945437c6cb177254019f34a9ae5047c8087c
-  data.tar.gz: db3d5df4369cbbfcda5d88f71f02fa69d935ce020cc3f105b2a4ea79b50d7f06ac772791d47950f230ded5851fcfa53fba43fd7f613890c77a058e70e31db085
+  metadata.gz: b3e5028c9bcdd7b4d705c9aadc7f1f78ca072c1d71ca93d7a9a4a0e304709ca487be09b2df824b3210dd84c6ff294bc96058f64e125f24e6d6144f98e6a52826
+  data.tar.gz: 265df3f84efee3c51223351a9c6b70b1086d28b830187b0c966f935aa75bdefbdef027ef9dbb1a2c490b68c62a0cae8d8ea78c5f37ecc1bbb03eb98e579552a3

data/config/version.rb

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

data/lib/origen_app_generators/plugin.rb

@@ -26,6 +26,8 @@ module OrigenAppGenerators
         else
           list[:web_navbar] = { source: 'templates/web/partials/_navbar_internal.html.erb', dest: 'templates/web/partials/_navbar.html.erb' }
         end
+        list[:lib_readme] = { source: 'lib/README', dest: "lib/#{@name}/README" }
+        list[:lib_reame_dev] = { source: 'lib_dev/README', dest: "lib/#{@name}_dev/README" }
         list
       end
     end

data/lib/origen_app_generators/test_engineering/test_block.rb

@@ -69,7 +69,7 @@ module OrigenAppGenerators
         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 'Your IP(s) 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".'
@@ -130,12 +130,12 @@ module OrigenAppGenerators
           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"
+          list[:dev_dut] = { source:  'lib_dev/dut.rb',
+                             dest:    "lib/#{@name}_dev/dut.rb",
+                             options: { class_name: @ip_names.first, sub_block_name: @sub_block_name }
+                           }
+          list[:dev_dutc] = { source: 'lib_dev/dut_controller.rb',
+                              dest:   "lib/#{@name}_dev/dut_controller.rb"
                             }
 
           @ip_names.each_with_index do |name, i|

data/templates/app_generators/application/lib/module.rb

@@ -3,13 +3,20 @@ require 'origen'
 require_relative '../config/application.rb'
 <% end -%>
 module <%= @namespace %>
-  # Load all files in the lib directory via a wildcard, if your project becomes
-  # large or load order dependencies start to creep in then you may need to
-  # start taking control of this manually as described above.
+<% if @type == :plugin -%>
+  # 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
+
+<% end -%>
+  # Example of how to explicitly require a file
+  # require "<%= @name %>/my_file"
+
+  # Load all files in the lib/<%= @name %> 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 up front
-  # you can do that one manually and the let the wildcard take care of the rest.
-  Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").sort.each do |file|
+  # 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__)}/<%= @name %>/**/*.rb").sort.each do |file|
     require file
   end
 end

data/templates/app_generators/plugin/config/boot.rb

@@ -5,13 +5,20 @@
 # case only lib/<%= @name %>.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
+# 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 "<%= @name %>"
 
-# Load a Top-level/DUT class that is defined within this plugin's lib directory
-# and is required by some of our tests.
-# Normally such a class should not be exposed to 3rd party users of the plugin,
-# so we required it here rather than in lib/<%= @name %>.rb.
-#require "<%= @name %>/test/top_level"
+module <%= @namespace %>Dev
+  # Example of how to explicitly require a file
+  # require "<%= @name %>_dev/my_file"
+    
+  # Load all files in the lib/<%= @name %>_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/<%= @name %>_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/templates/app_generators/plugin/lib/README

@@ -0,0 +1,5 @@
+This directory should include any code related to testing, documentation, etc., but which
+will not be required whenever this plugin is actually used within a 3rd party application.
+
+Any code that will be required when used within a 3rd party application, should be placed
+in lib/<%= @name %> instead.

data/templates/app_generators/plugin/lib_dev/README

@@ -0,0 +1,4 @@
+This directory should include all of the code that will be required by this plugin whenever
+it is used within a 3rd party application.
+
+Any code that is only for testing, should be placed in lib/<%= @name %>_dev instead.

data/templates/app_generators/test_engineering/test_block/lib_dev/dut.rb

@@ -0,0 +1,25 @@
+module <%= @namespace %>Dev
+  # 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

data/templates/app_generators/test_engineering/test_block/lib_dev/dut_controller.rb

@@ -0,0 +1,30 @@
+module <%= @namespace %>Dev
+  # 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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -61,6 +61,7 @@ files:
 - templates/app_generators/application/config/maillist_prod.txt
 - templates/app_generators/application/config/version.rb
 - templates/app_generators/application/doc/history
+- templates/app_generators/application/lib/.module.rb.swp
 - templates/app_generators/application/lib/app.rake
 - templates/app_generators/application/lib/module.rb
 - templates/app_generators/application/lib/top_level.rb
@@ -79,6 +80,8 @@ files:
 - templates/app_generators/plugin/Rakefile
 - templates/app_generators/plugin/config/boot.rb
 - templates/app_generators/plugin/gemspec.rb
+- templates/app_generators/plugin/lib/README
+- templates/app_generators/plugin/lib_dev/README
 - templates/app_generators/plugin/templates/web/index.md.erb
 - templates/app_generators/plugin/templates/web/partials/_navbar_external.html.erb
 - templates/app_generators/plugin/templates/web/partials/_navbar_internal.html.erb
@@ -99,8 +102,8 @@ files:
 - 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/lib_dev/dut.rb
+- templates/app_generators/test_engineering/test_block/lib_dev/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/default.rb
@@ -124,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Origen application generators

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

@@ -1,27 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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