ruby-adept 0.0.1

data/spec/lib/adept/low_level/jtag_spec.rb

@@ -0,0 +1,204 @@
+#
+# These tests assume _one_ single connected Basys2 board!
+#
+
+require 'adept'
+require 'adept/low_level'
+
+#Pull the relevant modules into the main namespace, for convenience.
+include Adept
+
+#
+# Specification for the low-level Adept JTAG interface.
+# These tests assume _only_ one connected Basys2 board!
+#
+describe LowLevel::JTAG do
+
+  #
+  # Tests which do not require a connected Basys2 board.
+  #
+  describe "offline functionality" do
+
+    describe ".interleave_tms_tdi_byte_pairs" do
+
+      it "should be able to interleave a single byte of TMS/TDI data" do
+
+        #Since we're testing a private method, test from inside of the module.
+        LowLevel::JTAG.module_eval do 
+
+          #Attempt to interleave the bytes. Note the little endian byte ordering.
+          tms, tdi = 0b1010_1011, 0b1100_1101 
+          LowLevel::JTAG.interleave_tms_tdi_byte_pair(tms, tdi).should == [0b1101_1011, 0b1101_1000]
+
+        end
+
+      end
+
+    end
+
+    describe ".interlace_tms_tdi_byte_pairs" do
+
+      it "should be able to interleave two arrays of bytes into a single string" do
+
+
+        #Since we're testing a private method, test from inside of the module.
+        LowLevel::JTAG.module_eval do 
+
+          tms = [0b1010_1011, 0b1111_0000]
+          tdi = [0b1100_1101, 0b0000_1111]
+
+          string = LowLevel::JTAG.interleave_tms_tdi_bytes(tms, tdi)
+          string.should == [0b1101_1011, 0b1101_1000, 0b0101_0101, 0b1010_1010].pack('C*').force_encoding('UTF-8')
+
+        end
+
+      end
+
+    end
+
+  end
+
+  #
+  # Tests which require a connectd Basys2-250K board.
+  # 
+  describe "online functionality", :online => true do
+
+    #Before each test, create a connection to a Basys board
+    before :each do
+      @device = Adept::Device.by_name('Basys2')
+    end
+
+    #Close the Basys connection after each test.
+    after :each do
+      @device.close
+    end
+
+    describe "pre-connection tests" do
+
+      it "should detect that a Basys2 board supports JTAG" do
+        LowLevel::JTAG.supported?(@device.handle).should be_true
+      end
+
+      it "should detect exactly one JTAG port on a Basys2 board" do 
+        LowLevel::JTAG.port_count(@device.handle).should == 1
+      end
+
+      it "should detect that a Basys2 board supports set the JTAG connection speed" do
+        support = LowLevel::JTAG.supported_calls(@device.handle, 0)
+        support[:set_speed].should be_true
+      end
+
+      it "should detect that a Basys2 board can't set the individual JTAG pins" do
+        support = LowLevel::JTAG.supported_calls(@device.handle, 0)
+        support[:set_pins].should be_false
+      end
+
+      it "should be able to open a JTAG connection to the FPGA on a Basys 2" do
+        LowLevel::JTAG.EnableEx(@device.handle, 0)
+      end
+
+      it "should be able to _close_ a JTAG connection" do
+        LowLevel::JTAG.EnableEx(@device.handle, 0)
+        LowLevel::JTAG.Disable(@device.handle)
+      end
+
+    end
+
+    describe "post-connection tests" do
+
+      #Create a new JTAG connection before each test.
+      before :each do
+        LowLevel::JTAG.EnableEx(@device.handle, 0)
+      end
+
+      #Disconnect from the JTAG device after each test.
+      after :each do
+        LowLevel::JTAG.Disable(@device.handle)
+      end
+
+      #
+      # To test each of the JTAG features below, we request that the devices in the scan chain
+      # identify themselves.
+      # 
+    
+      IDCode_Basys2_250K = "\xD5\x04\x50\x93"
+      IDCode_Platform_Flash = "\x11\xC1\xA0\x93"
+
+      it "should be able to send/recieve using interleaved byte strings" do
+
+        #Request that each of the devices identify themselves.
+        sequence = "\xAA\x22\x00"
+       
+        #Send the command to the device...
+        LowLevel::JTAG.transmit_interleave(@device.handle, sequence, 9)
+
+        #And shift in zeroes, simultaneously recieving the device's ID codes.
+        response = LowLevel::JTAG.transmit_interleave(@device.handle, "\x00" * 16, 64)
+
+        #Check for the correct ID codes.
+        response.reverse.should == IDCode_Platform_Flash + IDCode_Basys2_250K
+
+      end
+
+
+      it "should be able to send/recieve using interleaved arrays of bytes" do
+
+        #Request that each of the devices identify themselves.
+        sequence = [0xAA, 0x22, 0x00] # 1010_1010, 0010_0010, 0000_0000; TMS = 1111 0101
+       
+        #Send the command to the device...
+        LowLevel::JTAG.transmit_interleave(@device.handle, sequence, 9)
+
+        #And shift in zeroes, simultaneously recieving the device's ID codes.
+        response = LowLevel::JTAG.transmit_interleave(@device.handle, "\x00" * 16, 64)
+
+        #Check for the correct ID codes.
+        response.reverse.should == IDCode_Platform_Flash + IDCode_Basys2_250K
+
+      end
+
+      it "should be able to send/recieve using linear arrays of bytes" do
+
+        #Request that each of the devices identify themselves.
+        #tms = [0x5F, 0x00] #1010 1010 =  1111 0101 ; 1010 1111
+        tdi = [0x00, 0x00]
+
+        tms = [0x09, 0x00]
+
+        #Send the command to the device...
+        LowLevel::JTAG.transmit(@device.handle, tms, tdi, 6)
+
+        #And shift in zeroes, simultaneously recieving the device's ID codes.
+        response = LowLevel::JTAG.transmit(@device.handle, "\x00" * 8, "\x00" * 8, 64)
+
+        #Check for the correct ID codes.
+        response.reverse.should == IDCode_Platform_Flash + IDCode_Basys2_250K
+
+      end
+
+      it "should be able to accept more optimized transmit/recieve functions " do
+
+        #Request that each of the devices identify themselves.
+        LowLevel::JTAG.transmit(@device.handle, [0x09], false, 6)
+
+        #Recieve the device's ID codes.
+        response = LowLevel::JTAG.receive(@device.handle, false, false, 64)
+
+        #Check for the correct ID codes.
+        response.reverse.should == IDCode_Platform_Flash + IDCode_Basys2_250K
+
+      end
+
+      it "should be able to set the speed of a JTAG connection" do
+        LowLevel::JTAG::set_speed(@device.handle, 62500).should == 62500
+      end
+
+      it "should be able to read the speed of a JTAG connection" do
+        actual_speed = LowLevel::JTAG::set_speed(@device.handle, 62500)
+        LowLevel::JTAG::get_speed(@device.handle).should == actual_speed
+      end
+
+
+    end
+  end
+end

data/spec/spec_helpers.rb

@@ -0,0 +1,25 @@
+
+require 'adept'
+
+module SpecHelpers
+
+  #Stores the path to the testing firmware files.
+  FirmwarePath = '../firmware'
+
+  #
+  # Loads a given piece of firmware onto a connected 
+  #
+  def preload_firmware(filename, board_class=Boards::Basys2)
+
+    #Compute the relative path to the specified piece of firmware...
+    path = File.expand_path("#{FirmwarePath}/#{filename}.bit", __FILE__)
+
+    #... read the bitstream file at that path...
+    bitfile = DataFormats::Bitstream.from_file(path)
+
+    #... and program the file to the connected board.
+    board_class.open { |board| board.configure_fpga(bitfile) }
+
+  end
+
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: ruby-adept
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle J. Temkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-ise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: smart_colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Ruby library for working with Digilent devices via the Adept SDK.\n
+  \    Provides both low-level wrappers for the Adept SDK elements and high-level\n
+  \    interfaces, including simple programming and configuration routines."
+email:
+- ktemkin@binghamton.edu
+executables:
+- bprog
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adept.gemspec
+- autotest/discover.rb
+- bin/bprog
+- firmware/.gitignore
+- firmware/epp_stream/Basys2_100_250General.ucf
+- firmware/epp_stream/epp_controller.vhd
+- firmware/epp_stream/epp_stream.xise
+- firmware/epp_stream/fifo.vhd
+- firmware/epp_stream/tests/fifo_testbench.vhdl
+- lib/adept.rb
+- lib/adept/boards.rb
+- lib/adept/boards/basys2.rb
+- lib/adept/connection_provider.rb
+- lib/adept/data_formats.rb
+- lib/adept/data_formats/bitstream.rb
+- lib/adept/data_formats/data_factories.rb
+- lib/adept/device.rb
+- lib/adept/error.rb
+- lib/adept/jtag.rb
+- lib/adept/jtag/connection.rb
+- lib/adept/jtag/device.rb
+- lib/adept/jtag/devices.rb
+- lib/adept/jtag/devices/fpga.rb
+- lib/adept/jtag/devices/null.rb
+- lib/adept/jtag/devices/platform_flash.rb
+- lib/adept/jtag/error.rb
+- lib/adept/jtag/tap_state.rb
+- lib/adept/jtag/tap_states.rb
+- lib/adept/low_level.rb
+- lib/adept/low_level/connection.rb
+- lib/adept/low_level/device.rb
+- lib/adept/low_level/device_error.rb
+- lib/adept/low_level/device_manager.rb
+- lib/adept/low_level/enhanced_parallel.rb
+- lib/adept/low_level/error_handler.rb
+- lib/adept/low_level/jtag.rb
+- lib/adept/low_level/library.rb
+- lib/adept/version.rb
+- spec/firmware/epp_loopback.bit
+- spec/lib/adept/data_formats/bitstream_spec.rb
+- spec/lib/adept/data_formats/data_factories_spec.rb
+- spec/lib/adept/device_spec.rb
+- spec/lib/adept/jtag/connection_spec.rb
+- spec/lib/adept/jtag/device_spec.rb
+- spec/lib/adept/jtag/devices/fpga_spec.rb
+- spec/lib/adept/low_level/enhanced_parallel_spec.rb
+- spec/lib/adept/low_level/jtag_spec.rb
+- spec/spec_helpers.rb
+homepage: http://www.github.com/ktemkin/ruby-adept
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Framework for working with Digilent Adept devices.
+test_files:
+- spec/firmware/epp_loopback.bit
+- spec/lib/adept/data_formats/bitstream_spec.rb
+- spec/lib/adept/data_formats/data_factories_spec.rb
+- spec/lib/adept/device_spec.rb
+- spec/lib/adept/jtag/connection_spec.rb
+- spec/lib/adept/jtag/device_spec.rb
+- spec/lib/adept/jtag/devices/fpga_spec.rb
+- spec/lib/adept/low_level/enhanced_parallel_spec.rb
+- spec/lib/adept/low_level/jtag_spec.rb
+- spec/spec_helpers.rb