origen_swd 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34a6dec79a10f5798971c222d87e2d913cd63c47
-  data.tar.gz: cca491956939e7c6b8665ed83c310e268a7825b2
+  metadata.gz: a342912c75db291ab33ef9739b6babd1df79a0b8
+  data.tar.gz: 6d05a4646c429052e7a4d4041f710ab38cef1117
 SHA512:
-  metadata.gz: ccdfc7976acdde52b45e20e191f58441b3ea1b11112ef17a6a9fdae9121d69a497bb55b63ecd0e426cd77b9b87d762476e78349b2428dc15fabeb11919728893
-  data.tar.gz: 991dbd61c91ece8913f8ad3564b30b5796dd03d5e7470c0688ba9bf7b3e868a2ac7c54f56a56def365440d85fd389be1aeacb2bb25296465b8b89b84d25cc0b2
+  metadata.gz: 362376b2cefb1ccb0fede19bb8c61e3f818ca0f721682a4e4fe5c066cf81213242a0f2eed66e34804ed8a975ccc9af1c8e87590146ca900495bc27a336ce51b2
+  data.tar.gz: e6dd940a29994cab9ab6460ceea7c4e79f659d6876e691f3cc8f76513efd83b3bfbc3ac56ba91f6e66f32bc74eaf02b23c30ada880397f32bc87e68b9ee585f3

data/config/version.rb

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

data/lib/origen_swd/driver.rb

@@ -9,6 +9,8 @@ module OrigenSWD
     attr_reader :owner
 
     # Initialize class variables
+    # owner - parent object
+    # options - any miscellaneous custom arguments
     def initialize(owner, options = {})
       @owner = owner
       @current_apaddr = 0
@@ -16,10 +18,11 @@ module OrigenSWD
     end
 
     # 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
+    # data - data to be sent
+    # size - the length of data
+    # options - any miscellaneous custom arguments
+    # options[:overlay] - string for pattern label to facilitate pattern overlay
+    # Returns nothing.
     def send_data(data, size, options = {})
       if options.key?(:overlay)
         $tester.label(options[:overlay])
@@ -41,8 +44,10 @@ module OrigenSWD
     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
+    # size - the length of data
+    # options - any miscellaneous custom arguments
+    # options[:compare_data] - data to be compared, only compared if options is set
+    # Returns nothing.
     def get_data(size, options = {})
       should_store = $dut.pin(:swd_dio).is_to_be_stored?
       owner.pin(:swd_dio).dont_care
@@ -54,8 +59,8 @@ module OrigenSWD
     end
 
     # Sends specified number of '0' bits
-    #  -size = the length of data
-    #  -no return value
+    # size - the length of data
+    # Returns nothing.
     def swd_dio_to_0(size)
       owner.pin(:swd_dio).drive(0)
       size.times do |bit|

data/lib/origen_swd/dut.rb

@@ -10,7 +10,7 @@ module OrigenSWD
     include Origen::Registers
     include Origen::Pins
 
-    # Initialize simple dut model with test register and required swd pins
+    # Initializes 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 }
@@ -19,8 +19,8 @@ module OrigenSWD
     end
 
     # Add any custom startup business here.
-    #  -initialize timeset
-    def startup(options)
+    # Ex. initialize timeset
+    def startup(options = {})
       $tester.set_timeset('swd', 40)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: origen_swd
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Ronnie Lajaunie