origen_swd 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bbdb4d886f3fb4a3a902e11445c933e7cf1da07
-  data.tar.gz: aad012c09a3e8c9e42a7278ac8429da170328229
+  metadata.gz: 34a6dec79a10f5798971c222d87e2d913cd63c47
+  data.tar.gz: cca491956939e7c6b8665ed83c310e268a7825b2
 SHA512:
-  metadata.gz: 56b46d1f1888e993eb09a262149ca3eebde26bc4145e362f149e8fa7486988da7896e9cdea0b26b70eeaa55178339b176151f16b82a881252c8194498d0ac87f
-  data.tar.gz: ce48cd2b7228889c8c26c0d1229e5b1cad64380791fe4835fe717d62bb6a965e4664a46de3492c4e44dc3e2d1fee9d4ef730992976745787cefcc8a2b4b86460
+  metadata.gz: ccdfc7976acdde52b45e20e191f58441b3ea1b11112ef17a6a9fdae9121d69a497bb55b63ecd0e426cd77b9b87d762476e78349b2428dc15fabeb11919728893
+  data.tar.gz: 991dbd61c91ece8913f8ad3564b30b5796dd03d5e7470c0688ba9bf7b3e868a2ac7c54f56a56def365440d85fd389be1aeacb2bb25296465b8b89b84d25cc0b2

data/config/version.rb

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

data/lib/origen_swd/driver.rb

@@ -8,13 +8,18 @@ module OrigenSWD
     # either a DUT object or a protocol abstraction
     attr_reader :owner
 
+    # Initialize class variables
     def initialize(owner, options = {})
       @owner = owner
       @current_apaddr = 0
       @orundetect = 0
     end
 
-    # Hardware interface
+    # Sends data stream with SWD protocol
+    #  -data = data to be sent
+    #  -size = the length of data
+    #  -options[:overlay] = string for pattern label to facilitate pattern overlay
+    #  -no return value
     def send_data(data, size, options = {})
       if options.key?(:overlay)
         $tester.label(options[:overlay])
@@ -35,6 +40,9 @@ module OrigenSWD
       end
     end
 
+    # Recieves data stream with SWD protocol
+    #  -size = the length of data
+    #  -options[:compare_data] = data to be compared, only compared if options is set
     def get_data(size, options = {})
       should_store = $dut.pin(:swd_dio).is_to_be_stored?
       owner.pin(:swd_dio).dont_care
@@ -45,6 +53,9 @@ module OrigenSWD
       end
     end
 
+    # Sends specified number of '0' bits
+    #  -size = the length of data
+    #  -no return value
     def swd_dio_to_0(size)
       owner.pin(:swd_dio).drive(0)
       size.times do |bit|

data/lib/origen_swd/dut.rb

@@ -10,6 +10,7 @@ module OrigenSWD
     include Origen::Registers
     include Origen::Pins
 
+    # Initialize simple dut model with test register and required swd pins
     def initialize(options = {})
       add_reg :test, 0x0, 32, data: { pos: 0, bits: 32 },
                               bit:  { pos: 0 }
@@ -17,6 +18,8 @@ module OrigenSWD
       add_pin :swd_dio
     end
 
+    # Add any custom startup business here.
+    #  -initialize timeset
     def startup(options)
       $tester.set_timeset('swd', 40)
     end

data/lib/origen_swd.rb

@@ -1,6 +1,7 @@
 require 'origen'
 require_relative '../config/application.rb'
 
+# Include this module to add a SWD driver to your class
 module OrigenSWD
   autoload :Driver, 'origen_swd/driver'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_swd
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Ronnie Lajaunie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen