origen_app_generators 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0db247768f806c9048a8a170957e6d7911495b29
-  data.tar.gz: 20fc9fd317c56b32ed52fcb88d3c7737c70bf395
+  metadata.gz: c72ec7c295367269fb14603d3d5e0685e27c1302
+  data.tar.gz: 2b017360b1a782945a2bd950c07667eb4f12951f
 SHA512:
-  metadata.gz: b3e5028c9bcdd7b4d705c9aadc7f1f78ca072c1d71ca93d7a9a4a0e304709ca487be09b2df824b3210dd84c6ff294bc96058f64e125f24e6d6144f98e6a52826
-  data.tar.gz: 265df3f84efee3c51223351a9c6b70b1086d28b830187b0c966f935aa75bdefbdef027ef9dbb1a2c490b68c62a0cae8d8ea78c5f37ecc1bbb03eb98e579552a3
+  metadata.gz: 4b8a4fafa1c1f106b10dcc34311277e7fe986dcc5d65c485e4e0a9135b69bd0d41a5ee2e54a20619687b23fbb68be0047c8e599d97402ad096c7024dc6fa5463
+  data.tar.gz: 7575ca6ad90c50c62fc4561cf608f2c7c36423dd3d8d29a73a8206ab064346a4ab55d01c2ef205002a7b6da5f8c0b8952e2dd717535b5a9a64600292f23eac58

data/bin/fix_my_workspace

@@ -0,0 +1,92 @@
+#!/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.6.0'
+else
+  require 'origen'
+
+  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/version.rb

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

data/templates/app_generators/application/Gemfile

@@ -9,6 +9,8 @@ gem 'origen_doc_helpers'
 
 gem 'byebug'
 
+gem 'origen_updater'
+
 # 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/application/config/commands.rb

@@ -13,12 +13,17 @@ aliases ={
 # Now branch to the specific task code
 case @command
 
-# Here is an example of how to implement a command, the logic can go straight
-# in here or you can require an external file if preferred.
-when "my_command"
-  puts "Doing something..."
-  #require "commands/my_command"    # Would load file lib/commands/my_command.rb
-  # You must always exit upon successfully capturing a command to prevent 
+# (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 "<%= @name %>/commands/my_command"    # Would load file lib/<%= @name %>/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
 
@@ -63,12 +68,12 @@ when "my_command"
 # Origen command handler.
 else
   # You probably want to also add the your commands 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.
-#  @application_commands = <<-EOT
+  # 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
-#  EOT
-
 end 

data/templates/app_generators/plugin/Gemfile

@@ -11,7 +11,9 @@ source '<%= Origen.site_config.gem_server %>'
 gem 'coveralls', require: false
 <% end -%>
 gem 'byebug'
+gem 'ripper-tags'
 gem 'origen_doc_helpers'
+gem 'origen_updater'
 # 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/gemspec.rb

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   # Only the files that are hit by these wildcards will be included in the
   # packaged gem, the default should hit everything in most cases but this will
   # need to be added to if you have any custom directories
-  spec.files         = Dir["lib/**/*.rb", "templates/**/*", "config/**/*.rb",
+  spec.files         = Dir["lib/<%= @name %>.rb", "lib/<%= @name %>/**/*.rb", "templates/**/*", "config/**/*.rb",
                            "bin/*", "lib/tasks/**/*.rake", "pattern/**/*.rb",
                            "program/**/*.rb"
                           ]

data/templates/app_generators/plugin/lib/README

@@ -1,5 +1,4 @@
-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.
+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 will be required when used within a 3rd party application, should be placed
-in lib/<%= @name %> instead.
+Any code that is only for testing, should be placed in lib/<%= @name %>_dev instead.

data/templates/app_generators/plugin/lib_dev/README

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

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

@@ -1,5 +1,21 @@
 module <%= @namespace %>
   class Interface
     include OrigenTesters::ProgramGenerators
+
+    # This will be called at the start of every flow or sub-flow (whenever Flow.create
+    # is called).
+    # Any options passed to Flow.create will be passed in here.
+    # The options will contain top_level: true, whenever this is called at the start of
+    # a new top-level flow.
+    def startup(options = {})
+    end
+
+    # This will be called at the end of every flow or sub-flow (at the end of every
+    # Flow.create block).
+    # Any options passed to Flow.create will be passed in here.
+    # The options will contain top_level: true, whenever this is called at the end of a
+    # top-level flow file.
+    def shutdown(options = {})
+    end
   end
 end

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

@@ -3,6 +3,8 @@ module <%= @namespace %>Dev
   # integrate into a top-level app
   class DUT
     include Origen::TopLevel
+    include OrigenJTAG
+    include OrigenARMDebug
 
     def initialize(options = {})
       instantiate_pins(options)
@@ -18,7 +20,7 @@ module <%= @namespace %>Dev
     end
 
     def instantiate_sub_blocks(options)
-      sub_block :arm_debug, class_name: 'OrigenARMDebug::Driver', aps: { mem_ap: 0x0, mdmap: 0x0100_0000 }
+      sub_block :arm_debug, class_name: 'OrigenARMDebug::DAP', mem_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

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

@@ -2,10 +2,6 @@ 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'
@@ -20,11 +16,11 @@ module <%= @namespace %>Dev
     end
 
     def write_register(reg, options = {})
-      arm_debug.write_register(reg, options)
+      arm_debug.mem_ap.write_register(reg, options)
     end
 
     def read_register(reg, options = {})
-      arm_debug.read_register(reg, options)
+      arm_debug.mem_ap.read_register(reg, options)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_app_generators
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/fix_my_workspace
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
@@ -61,7 +62,6 @@ 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
@@ -127,9 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Origen application generators
 test_files: []
-has_rdoc: