ruby-adept 1.0.3 → 1.1.0

data/bin/bprog

@@ -145,6 +145,25 @@ def configure_fpga(jtag, bitstream)
 
 end
 
+#
+# Configures the first connected PROM with the provided bitstream.
+#
+def configure_prom(jtag, bitstream)
+
+  #
+  # TEMPORARY CODE ONLY!
+  # Replace me at the soonest opportunity.
+  #
+  jtag.close
+  jtag.device.close
+
+  #Delegate PROM programming to the Digilent utility.   
+  Core.class_eval do
+    with_temporary_files(bitstream.to_s, '', '.bit') { |_, source| system("djtgcfg prog -d Basys2 -i 1 -f #{source}") }
+  end
+
+end
+
 #
 # Displays a list of available cores.
 # 
@@ -171,7 +190,7 @@ end
 # Merge the provided file into the specified core, and return the resultant
 # bitstream.
 #
-def merge_file_and_core(core_name, file, target=nil)
+def merge_file_and_core(core_name, file, target=nil, prom=false)
 
   #... try to find a core with the given name.
   core = Core.from_shortname(core_name)
@@ -186,8 +205,12 @@ def merge_file_and_core(core_name, file, target=nil)
     puts "Merging".bold + " #{File.basename(file)} into the #{core.shortname} core..."
   end
 
+  #If we're going to be programming the PROM, keep everythin in the raw string format.
+  #TODO: Remove me when the PROM is implemented correctly!
+  file_format = prom ? :to_raw_bitstream : :to_bitstream
+
   #Create a bitstream from the given core.
-  file = core.to_bitstream(target, file)
+  file = core.send(file_format, target, file, prom)
 
   #Notify the user that programming is about to begin.
   puts "Programming".bold + " the attached board with the #{core.shortname} core..."
@@ -222,6 +245,7 @@ options = Trollop::options do
 
   opt :core, "Specifies a soft-core to use. If a compiled program is provided, it will be merged into the specified core.", :type => String
   opt :'list-cores', "Display a list of all available processor cores." 
+  opt :prom, "Programs the given file to the PROM of the given board, when possible."
 
 end
 
@@ -239,6 +263,7 @@ connection = get_target_connection(options[:'list-cores'])
 # Get the name of the connected FPGA, if applicable.
 part_name = connected_fpga_part_name(connection)
 
+
 #If the list_available_cores flag is set, list the compatible cores,
 #
 #and quit.
@@ -255,13 +280,18 @@ file = get_target_file(do_not_guess, allow_none)
 # If the core option was specified, attempt to merge it with the provided
 # filename. (If no filename was provided, the core's bitstream will be returned.)
 if options[:core]
-  file = merge_file_and_core(options[:core], file, part_name) 
+  file = merge_file_and_core(options[:core], file, part_name, options[:prom]) 
 
 # Otherwise, read the file as a bitstream directly.
 else
   file = read_bitstream(file) 
 end
 
+if options[:prom]
+  configure_prom(connection, file)
+  exit!
+end
+
 begin
   configure_fpga(connection, file)
 rescue Error => e

data/cores/avr8/avr_250k.bmm

@@ -1,6 +1,6 @@
 // BMM LOC annotation file.
 //
-// Release 14.1 -  P.49d, build 2.8 Mar 16, 2012
+// Release 13.2 - Data2MEM O.61xd, build 2.2 May 20, 2011
 // Copyright (c) 1995-2013 Xilinx, Inc.  All rights reserved.
 
 
@@ -12,6 +12,7 @@
 
 ADDRESS_MAP avrmap PPC405 0
 
+
     ///////////////////////////////////////////////////////////////////////////////
     //
     // Processor 'avrmap' address space 'rom_code' 0x00000000:0x00003FFF (16 KBytes).
@@ -20,35 +21,35 @@ ADDRESS_MAP avrmap PPC405 0
 
     ADDRESS_SPACE rom_code RAMB16 [0x00000000:0x00003FFF]
         BUS_BLOCK
-            PM_Inst/RAM_Word0 RAMB16 [15:0] [0:1023] PLACED = X0Y3;
+            PM_Inst/RAM_Word0 [15:0] PLACED = X1Y1;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word1 RAMB16 [15:0] [1024:2047] PLACED = X1Y2;
+            PM_Inst/RAM_Word1 [15:0] PLACED = X1Y4;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word2 RAMB16 [15:0] [2048:3071] PLACED = X0Y2;
+            PM_Inst/RAM_Word2 [15:0] PLACED = X1Y2;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word3 RAMB16 [15:0] [3072:4095] PLACED = X1Y1;
+            PM_Inst/RAM_Word3 [15:0] PLACED = X1Y3;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word4 RAMB16 [15:0] [4096:5119] PLACED = X1Y4;
+            PM_Inst/RAM_Word4 [15:0] PLACED = X0Y3;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word5 RAMB16 [15:0] [5120:6143] PLACED = X1Y3;
+            PM_Inst/RAM_Word5 [15:0] PLACED = X1Y5;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word6 RAMB16 [15:0] [6144:7167] PLACED = X0Y1;
+            PM_Inst/RAM_Word6 [15:0] PLACED = X1Y0;
         END_BUS_BLOCK;
 
         BUS_BLOCK
-            PM_Inst/RAM_Word7 RAMB16 [15:0] [7168:8191] PLACED = X0Y0;
+            PM_Inst/RAM_Word7 [15:0] PLACED = X0Y2;
         END_BUS_BLOCK;
     END_ADDRESS_SPACE;
 

data/cores/avr8/avr_250k_prom.bmm

@@ -0,0 +1,57 @@
+// BMM LOC annotation file.
+//
+// Release 13.2 - Data2MEM O.61xd, build 2.2 May 20, 2011
+// Copyright (c) 1995-2013 Xilinx, Inc.  All rights reserved.
+
+
+///////////////////////////////////////////////////////////////////////////////
+//
+// Processor 'avrmap', ID 0, memory map.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+ADDRESS_MAP avrmap PPC405 0
+
+
+    ///////////////////////////////////////////////////////////////////////////////
+    //
+    // Processor 'avrmap' address space 'rom_code' 0x00000000:0x00003FFF (16 KBytes).
+    //
+    ///////////////////////////////////////////////////////////////////////////////
+
+    ADDRESS_SPACE rom_code RAMB16 [0x00000000:0x00003FFF]
+        BUS_BLOCK
+            PM_Inst/RAM_Word0 [15:0] PLACED = X1Y1;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word1 [15:0] PLACED = X1Y4;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word2 [15:0] PLACED = X1Y2;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word3 [15:0] PLACED = X1Y3;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word4 [15:0] PLACED = X0Y3;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word5 [15:0] PLACED = X1Y5;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word6 [15:0] PLACED = X1Y0;
+        END_BUS_BLOCK;
+
+        BUS_BLOCK
+            PM_Inst/RAM_Word7 [15:0] PLACED = X0Y2;
+        END_BUS_BLOCK;
+    END_ADDRESS_SPACE;
+
+END_ADDRESS_MAP;
+

data/cores/avr8/core.yaml

@@ -1,11 +1,17 @@
 name: ATMega103-compatible AVR
 shortname: atmega103
-version: 1.0
+version: 1.1
 targets: 
 
   #Spartan 3E 250K-gate
   3s250ecp132:
+
+    #JTAG Clock (via USB)
     bit_file: avr_250k.bit
     memory_map: avr_250k.bmm
+
+    #Confiuration Clock (via PROM)
+    bit_file_prom: avr_250k_prom.bit
+    memory_map_prom: avr_250k_prom.bmm
     
   

data/lib/adept/core.rb

@@ -75,19 +75,24 @@ module Adept
     end
 
     #
-    #  Returns a bitstream which can be use to load the given core onto the target
-    #  device. If a program is provided, it will be loaded into the resultant bitstream.
+    #  Returns a byte-string encoded bitstream which can be use to load the given core
+    #  onto the target device. If a program is provided, it will be loaded into the resultant bitstream.
     #
     #  target: The Device ID string of the board to be programmed.
+    #  program: The program that should be merged into the core.
+    #  prom: If true, the PROM version of this core will be used.
     #
-    def to_bitstream(target=@targets.keys.first, program=nil)
+    def to_raw_bitstream(target=@targets.keys.first, program=nil, prom=false)
 
       #Ensure the target is a string.
       target = target.to_s
 
+      #If we're in PROM mode, use the prom versions of the configured files.
+      suffix = prom ? '_prom' : '';
+
       #Get the path to the bitfile and memory map which will be used to generate the new bitfile.
-      memory_map = "#@base_path/#{@targets[target]['memory_map']}"
-      bit_file   = "#@base_path/#{@targets[target]['bit_file']}"
+      memory_map = "#@base_path/#{@targets[target]["memory_map#{suffix}"]}"
+      bit_file   = "#@base_path/#{@targets[target]["bit_file#{suffix}"]}"
 
       #If no program was provided, return the bitfile unmodified.
       return Adept::DataFormats::Bitstream.from_file(bit_file) unless program
@@ -97,11 +102,21 @@ module Adept
       mem = with_temporary_files(hex, '.mem', '.hex') { |dest, source| system("srec_cat #{source} -Intel -Byte_Swap 2 -Data_Only -Output_Block_Size 32 -o #{dest} -vmem 8") }
       bit = with_temporary_files(mem, '.bit', '.mem') { |dest, source| system("data2mem -bm #{memory_map} -bt #{bit_file} -bd #{source} -o b #{dest}") }
 
-      #... wrap it in a Bitstream object, and return it.
-      Adept::DataFormats::Bitstream.from_string(bit)
 
     end
 
+    #
+    #  Returns a bitstream which can be use to load the given core onto the target
+    #  device. If a program is provided, it will be loaded into the resultant bitstream.
+    #
+    #  target: The Device ID string of the board to be programmed.
+    #  program: The program that should be merged into the core.
+    #  prom: If true, the PROM version of this core will be used.
+    #
+    def to_bitstream(target=@targets.keys.first, program=nil, prom=false)
+      Adept::DataFormats::Bitstream.from_string(to_raw_bitstream(target, program, prom))
+    end
+
     #
     # Print a debugging represntation of the core.
     #
@@ -111,12 +126,20 @@ module Adept
 
     private
 
+    #
+    # Convenience delegate which allows instance access to the with_temporary_files class method.
+    # (This allows for prettier code; e.g. with_temporary_files { do_something } ).
+    #
+    def with_temporary_files(*args, &block)
+      self.class.with_temporary_files(*args, &block)
+    end
+
     #
     # Executes a given block with an "anonymous" temporary file.
     # The temporary file is deleted at the end of the block, and its contents
     # are returned.
     # 
-    def with_temporary_files(file_contents='', dest_extension = '', source_extension = '', message=nil)
+    def self.with_temporary_files(file_contents='', dest_extension = '', source_extension = '', message=nil)
 
       #File mode for all of the created temporary files.
       #Create the files, and allow read/write, but do not lock for exclusive access.

data/lib/adept/data_formats/bitstream.rb

@@ -96,7 +96,7 @@ module Adept
       #
       # Returns the bitstream as a bit string.
       #
-      def to_s
+      def to_s(with_headers=false)
         to_a.pack("C*")
       end
 

data/lib/adept/device.rb

@@ -71,8 +71,8 @@ module Adept
     #
     # Closes the given device.
     #
-    def close
-      ensure_handle_is_valid
+    def close(check_handle=true)
+      ensure_handle_is_valid if check_handle
       DeviceManager::close_device(@handle)
     end
 

data/lib/adept/jtag/connection.rb

@@ -13,6 +13,7 @@ module Adept
       extend ConnectionProvider
 
       attr_reader :tap_state
+      attr_reader :device
 
       #
       # Sets up a new JTAG connection.

data/lib/adept/version.rb

@@ -1,3 +1,3 @@
 module Adept
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: ruby-adept
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Kyle J. Temkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_colored
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,6 +94,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-elf
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -90,6 +102,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -97,6 +110,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-ise
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -104,6 +118,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -111,6 +126,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,6 +134,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -125,6 +142,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -132,6 +150,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -156,6 +175,8 @@ files:
 - bin/bprog
 - cores/avr8/avr_250k.bit
 - cores/avr8/avr_250k.bmm
+- cores/avr8/avr_250k_prom.bit
+- cores/avr8/avr_250k_prom.bmm
 - cores/avr8/core.yaml
 - firmware/.gitignore
 - firmware/epp_stream/Basys2_100_250General.ucf
@@ -207,26 +228,27 @@ files:
 - spec/spec_helpers.rb
 homepage: http://www.github.com/ktemkin/ruby-adept
 licenses: []
-metadata: {}
 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: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Framework for working with Digilent Adept devices.
 test_files:
 - spec/firmware/epp_loopback.bit

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTI4YTUxMDg5MzE1MWVlOWVmMTJhNzEyZWZkZWVlZDlhNDJlZGI1OA==
-  data.tar.gz: !binary |-
-    YmZlMmQ3OTE3NWE2MjI3MTc4NDUxZDAxMTg4NDUzZWIzNDliODEzZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZGM2NTJkZWVmNzM2NzgyOTM0ZGY0ZGYzYWZjZjBkODU3ZGI3YTRlZWY3Yzc1
-    Y2Q1ZTUyMDc4YTRiYjE5NDBmZmVhMjAwZjgwNjZmN2IwODIyY2U0YTc2ZGE3
-    NTE2N2Y1ZDRlZDM4YmQ5YmNlMzRkMzIwY2I3ZGFjYjg2NjM1ZWQ=
-  data.tar.gz: !binary |-
-    NWI5M2QyODkwZjQ4MjBjM2QyYWQxMWQ2OTY0ZmQxMWY4MmM5N2UwMDVkYzVh
-    N2JiMDc1NzU1ZWVmZGMyOGEzZDU4NWU1ZWY3ZDE3NjJlYTI0ZTNiNjdlOTA1
-    ZmMzMTg4YzM2NGFjYjUwZDMwY2MyNzcwNDQ2OTU2MGEwNDUxMTg=