origen_spi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83377bd6ba21533463dfa2f7b8a55ad734f53d4b
-  data.tar.gz: 375eee9fca4d3ff5482cae9ce6742515587e498e
+  metadata.gz: 5b2aa171d3d509833161d1af44a6ea81008adf43
+  data.tar.gz: 0dc35eea797735445f905b7fe30f8619562c529b
 SHA512:
-  metadata.gz: 548a96549d1c0fb2f21a3c42377fba70735092efc6c2be46bd2f6661c5e4558f1cd22890f6a47098163829289d1e616fc0933ef81289f40c12e4160216fcaff6
-  data.tar.gz: 976eff869da5fe052bfa92c756089b6328990f2e6fbeef0cc46c319b03ac25acfe1218b491edf8646ac3a9dc9f865235d6ec7461990f5deb636146cb2f6b5b9f
+  metadata.gz: bd96f3bb400a1379e86878f47ae18baeb72bcfb1c3de91a4ddca74d52164b29adfb153a36d7bc74fc8e96f1055236dc635868bffe892dd45969fd6f2f3f8404c
+  data.tar.gz: 818d433c0eaff60bf7a96045d48b3e496a6058f4c01a446e21abea3d9dc868ab747f49c65566ac1c36408ae6b7cf35e0f1e89fd3b1f9c9bfd5e81e3eb8a130b0

data/config/commands.rb

@@ -39,13 +39,19 @@ when "examples", "test"
   status = 0
 
   ARGV = %w(pattern/clock_test.rb -t default.rb -e default.rb -r approved)
-  load "#{Origen.top}/lib/origen/commands/generate.rb"#  #ARGV = %w(some_pattern -t debug -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
 
   ARGV = %w(pattern/shift_test.rb -t default.rb -e default.rb -r approved)
-  load "#{Origen.top}/lib/origen/commands/generate.rb"#  #ARGV = %w(some_pattern -t debug -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
 
   ARGV = %w(pattern/overlay_test.rb -t default.rb -e default.rb -r approved)
-  load "#{Origen.top}/lib/origen/commands/generate.rb"#  #ARGV = %w(some_pattern -t debug -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
+
+  ARGV = %w(pattern/keep_ss_active.rb -t default.rb -e default.rb -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
+
+  ARGV = %w(pattern/clear_flags_test.rb -t default.rb -e default.rb -r approved)
+  load "#{Origen.top}/lib/origen/commands/generate.rb"
 
   if Origen.app.stats.changed_files == 0 &&
      Origen.app.stats.new_files == 0 &&

data/config/version.rb

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

data/lib/origen_spi/driver.rb

@@ -233,7 +233,8 @@ module OrigenSpi
     #   spi_instance.shift master_in: in_cmp_reg
     def shift(options = {})
       options = {
-        master_out: 0
+        master_out:     0,
+        keep_ss_active: false
       }.merge(options)
 
       validate_settings
@@ -290,7 +291,11 @@ module OrigenSpi
       @sclk_pin.drive @clk_format == :rl ? 0 : 1
       @miso_pin.dont_care unless @miso_pin.nil?
       @mosi_pin.drive 0 unless @mosi_pin.nil?
-      @ss_pin.drive @ss_active == 1 ? 0 : 1 unless @ss_pin.nil?
+      @ss_pin.drive @ss_active == 1 ? 0 : 1 unless @ss_pin.nil? || options[:keep_ss_active]
+
+      # clear flags if registers were provided
+      options[:master_out].clear_flags if options[:master_out].respond_to?(:clear_flags)
+      options[:master_in].clear_flags if options[:master_in].respond_to?(:clear_flags)
     end
 
     # Internal method

data/pattern/clear_flags_test.rb

@@ -0,0 +1,18 @@
+Pattern.create do
+  tester.set_timeset 'tp0', 20
+  dut.pin(:ss).drive 1
+  dut.pin(:sclk).drive 0
+  dut.pin(:mosi).drive 0
+  dut.pin(:miso).dont_care
+  
+  tester.cycle
+
+  out_data = Origen::Registers::Reg.dummy(12).write 7
+  in_data = Origen::Registers::Reg.dummy(12).read 0x5a5
+  cc 'shifting 12-bits lsb first, 0x7 out, 0x5a5 in'
+  dut.spi.shift master_out: out_data, master_in: in_data
+
+  tester.cycle
+  cc 'shifting in same register, should be no compares'
+  dut.spi.shift master_in: in_data
+end

data/pattern/keep_ss_active.rb

@@ -0,0 +1,25 @@
+Pattern.create do
+  tester.set_timeset 'tp0', 20
+  dut.pin(:ss).drive 1
+  dut.pin(:sclk).drive 0
+  dut.pin(:mosi).drive 0
+  dut.pin(:miso).dont_care
+  
+  tester.cycle
+
+  out_data = Origen::Registers::Reg.dummy(12).write 7
+  in_data = Origen::Registers::Reg.dummy(12).read 0x5a5
+  cc 'shifting 12-bits lsb first, 0x7 out, 0x5a5 in -- keeping ss active'
+  dut.spi.shift master_out: out_data, master_in: in_data, keep_ss_active: true
+  
+  cc 'cycle with ss active'
+  tester.cycle
+
+  cc 'shifting 12-bits lsb first, 0x7 out, 0x5a5 in -- allow ss inactive'
+  in_data.read
+  dut.spi.shift master_out: out_data, master_in: in_data
+  
+  cc 'cycle with ss inactive'
+  tester.cycle
+
+end

data/pattern/shift_test.rb

@@ -15,12 +15,16 @@ Pattern.create do
   tester.cycle
   
   cc 'repeat 12-bits lsb first, 0x7 out, 0x5a5 in; clock multiple = 4'
+  out_data.write 7
+  in_data.read 0x5a5
   dut.spi.clk_multiple = 4
   dut.spi.shift master_out: out_data, master_in: in_data
   
   tester.cycle
   
   cc 'repeat 12-bits, 0x7 out, 0x5a5 in; clock multiple = 4, with msb first, move miso compare to cycle 3'
+  out_data.write 7
+  in_data.read 0x5a5
   dut.spi.data_order = :msb0
   dut.spi.miso_compare_cycle = 3
   dut.spi.shift master_out: out_data, master_in: in_data
@@ -46,7 +50,9 @@ Pattern.create do
   tester.cycle
   
   cc 'test capture'
+  in_data.bits[11..8].read
   in_data.bits[7..4].store
+  in_data.bits[3..0].read
   dut.spi.shift master_out: 0xa5a, master_in: in_data
   
   tester.cycle

data/templates/web/index.md.erb

@@ -56,6 +56,25 @@ can be changed after instantiation. See API for more details.
   dut.spi.ss_pin = nil
 ~~~
 
+Once the driver is instantiated shift operations can be performed by calls to the shift method (overlay/store/masking etc. is handled):
+
+~~~ruby
+  # shift out, masking input compares
+  dut.spi.shift master_out: 0xFF, size: 32
+  
+  # shift out, register - size doesn't need to be passed when register is provided
+  dut.spi.shift master_out: dut.my_reg
+  
+  # shift in read examples:
+  dut.spi.shift master_in: 0xFF, size: 32
+  
+  # provide a register to mask or store (mark the bits appropriately)
+  dut.spi.shift master_in: dut.my_reg
+  
+  # simultaneous shift in/out
+  dut.spi.shift master_out: some_value_or_reg, master_in: some_other_value_or_reg
+~~~
+
 
 ### How To Setup a Development Environment
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_spi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paul DeRouen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -53,7 +53,9 @@ files:
 - lib/origen_spi.rb
 - lib/origen_spi/driver.rb
 - lib/tasks/origen_spi.rake
+- pattern/clear_flags_test.rb
 - pattern/clock_test.rb
+- pattern/keep_ss_active.rb
 - pattern/overlay_test.rb
 - pattern/shift_test.rb
 - templates/web/index.md.erb