origen_ahb 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06d5486adbf227d790c21a749776bb37f6b8fcb5
-  data.tar.gz: 507d86514f3aefd1354aabfe50faba3279cd1a4b
+  metadata.gz: b2ed1c06cd02df81855eb2e585c01b199dae234a
+  data.tar.gz: 5d82e6df1f9ec407f2c4a958756db5b3cb2400eb
 SHA512:
-  metadata.gz: 6fac1e5cd87620dc41baf47a6dde3a0109547e4f970ca3e9eacef5f7497884eb42444aa89e627c5f5e6ac2689b5c644b20449d572b7d2eea3eb0ef08872f0e36
-  data.tar.gz: a88de68b04fd8aac082a1ed259a79d46cc9a09102ea0fd193fa12a447560be845e33ce7184486231353577ee6afff70b5037fca0a0294c1aba7b07ea75ddae4f
+  metadata.gz: baec50e73bc25a6937148f3d17d156010f1af98ee5cb29db5b3fdb436d718a585aa2c8b1f10452d696170cc9e4d77b05645ef364ccd0be4fbb39289010fbef6d
+  data.tar.gz: 96e2278fbb8904d5e221e1f71967be0b370a350302864a79b72bd81f649a9f0393e5d079f7325c89c1211d5c862f609f9135f0a3c6fef80a131a55d0505334bc

data/config/commands.rb

@@ -25,7 +25,7 @@ when 'specs'
   exit RSpec::Core::Runner.run(['spec'])
 
 
-when 'examples'  
+when 'examples', 'test'
   Origen.load_application
   status = 0
 
@@ -44,6 +44,12 @@ when 'examples'
     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
@@ -52,6 +58,7 @@ else
   @application_commands = <<-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/config/version.rb

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

data/lib/origen_ahb/driver.rb

@@ -2,10 +2,14 @@ module OrigenAhb
   class Driver
     attr_reader :owner
 
+    # Initialize owner
     def initialize(owner, options = {})
       @owner = owner
     end
 
+    # Read register. Handles register model as input or data/address pair.
+    # Sets up AHB parameters values and passes along to pin-layer ahb
+    # transaction method.
     def read_register(reg_or_val, options = {})
       options = {
         haddr:     options[:address] || reg_or_val.address,
@@ -29,6 +33,9 @@ module OrigenAhb
       $dut.ahb_trans(options)
     end
 
+    # Read register. Handles register model as input or data/address pair.
+    # Sets up AHB parameters values and passes along to pin-layer ahb
+    # transaction method.
     def write_register(reg_or_val, options = {})
       options = {
         haddr:     options[:address] || reg_or_val.address,
@@ -52,6 +59,7 @@ module OrigenAhb
       $dut.ahb_trans(options)
     end
 
+    # Convert bit width to HSIZE
     def get_hsize(size)
       if size <= 8
         hsize = 0

data/lib/origen_ahb_dev/block.rb

@@ -1,11 +1,14 @@
 module OrigenAhbDev
+  # Dummy sub-block for inclusion in top-level dut
   class BLOCK
     include Origen::Model
 
+    # Initialize block
     def initialize(options = {})
       instantiate_registers(options)
     end
 
+    # Create block-level registers
     def instantiate_registers(options = {})
       add_reg :control, 0x00, 32, data: { pos: 0, bits: 32 }
       add_reg :status, 0x04, 32, data: { pos: 0, bits: 32 }

data/lib/origen_ahb_dev/dut.rb

@@ -1,14 +1,17 @@
 module OrigenAhbDev
+  # Top-level chip model for development and unit testing
   class DUT
     include Origen::TopLevel
     include OrigenAhb
 
+    # Initializer method to setup dut
     def initialize(options = {})
       instantiate_pins(options)
       instantiate_registers(options)
       instantiate_sub_blocks(options)
     end
 
+    # Add standard DUT pins and pins necessary for AHB protocol
     def instantiate_pins(options = {})
       # Standard DUT pins
       add_pin :tclk
@@ -33,10 +36,12 @@ module OrigenAhbDev
       add_pin :hrdata, size: 32
     end
 
+    # Create a top-level test register
     def instantiate_registers(options = {})
       add_reg :top_reg, 0x20000000, 32, data: { pos: 0, bits: 32 }
     end
 
+    # Create a sub-block for test dut
     def instantiate_sub_blocks(options = {})
       sub_block :block, class_name: 'OrigenAhbDev::BLOCK', base_address: 0x2200_0000
     end

data/lib/origen_ahb_dev/dut_controller.rb

@@ -2,6 +2,7 @@ module OrigenAhbDev
   class DUTController
     include Origen::Controller
 
+    # Method called on any pattern startup to init timeset and pin values
     def startup(options = {})
       tester.set_timeset('ahb', 40)
 
@@ -13,6 +14,7 @@ module OrigenAhbDev
       pin(:resetb).drive(1)
     end
 
+    # Method called on any pattern shutdown to leave pin values in known state
     def shutdown(options = {})
       # Shut everything down
       tester.wait time_in_ns: 250
@@ -21,6 +23,7 @@ module OrigenAhbDev
       cleanup_pins  # Give patterns a known exit condition
     end
 
+    # Set pins to initial pin value
     def init_pins
       pin(:resetb).drive(0)
       pin(:tclk).drive(0)
@@ -29,6 +32,7 @@ module OrigenAhbDev
       pin(:tdo).dont_care
     end
 
+    # Set pins to safe state for pattern end
     def cleanup_pins
       pin(:resetb).drive(0)
       pin(:tclk).drive(0)
@@ -37,14 +41,17 @@ module OrigenAhbDev
       pin(:tdo).dont_care
     end
 
-    def write_register(reg, options = {})
-      ahb.write_register(reg, options)
+    # Dut-level register write using AHB driver
+    def write_register(reg_or_val, options = {})
+      ahb.write_register(reg_or_val, options)
     end
 
-    def read_register(reg, options = {})
-      ahb.read_register(reg, options)
+    # Dut-level register read using AHB driver
+    def read_register(reg_or_val, options = {})
+      ahb.read_register(reg_or_val, options)
     end
 
+    # Pin driver layer of AHB protocol, used by AHB
     def ahb_trans(options = {})
       pin(:hclk).drive(0)
       pins(:htrans).drive(0)

data/pattern/example.rb

@@ -1,9 +1,15 @@
 Pattern.create do
   
-  cc 'Write to top-level register'
+  cc 'Write to top-level register using reg model'
   $dut.reg(:top_reg).write!(0x5555_AAAA)
   
-  cc 'Write to block-level register'
+  cc 'Write to top-level register using data/address'
+  $dut.write_register(0xAAAA_5555, address: 0x20000000)
+
+  cc 'Read from top-level register using data/address'
+  $dut.read_register(0xAAAA_5555, address: 0x20000000)
+
+   cc 'Write to block-level register'
   $dut.block.reg(:control).write!(0xBA5E_BA11)
   
   cc 'Read from block-level register'

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: origen_ahb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Chris P Nappi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency