origen_link 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1466528f6de1eb1b70731626991a685065ad6e0
-  data.tar.gz: 06d3028a38164e75078b9865ec5a2ff63fb0b422
+  metadata.gz: 14d0facfcb04447ab5238b62f38ee31b4332e212
+  data.tar.gz: f68f21592acc3eb1dd48301cac3e220a742b789a
 SHA512:
-  metadata.gz: 30db744c9d97bd49fe11988415c69b39ef9a71f14d54fb485209df8ca89247b7a2f52b1a917c93d74da167426d11dcb7a2a1d2da419e544e9bf1b40c94d6bcc2
-  data.tar.gz: cb73f596dc2fdfd691b31722a232e67c9969b0346520e142aaf511cf289eabad94a65e3e029324d5cfad6ac510bdd8ce7c86ca09e1ff4013e7c09799583b5023
+  metadata.gz: e162fafd6a68753e03afb20a20cd6f779b7a25a5d50473711f83a9769955453c3e1259adfedd02a9b3c36f8077fc4d9823c68ed5f802b9a8ae8c049265070010
+  data.tar.gz: 8fd17ea6f4eb541a880e9c526d36d265ba3fdfc075e276bfd65b6f535f785a854b615b576df5f2467df791a23d57c27535eb912758bfec2c4e48ecf3930071ee

data/bin/start_link_server

@@ -1,15 +1,18 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'config'))
 require 'socket'
 require 'origen_link/server/sequencer'
+require 'version'
 
 server = TCPServer.open('', 12_777)
-puts 'server started'
 pinsequencer = OrigenLink::Server::Sequencer.new
+pinsequencer.version = OrigenLink::VERSION
 remoteuser = ''
 remotehost = ''
 sessionactivity = Time.now
 sessionactive = false
+puts "server version #{pinsequencer.version} started"
 
 loop do
   client = server.accept

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenLink
   MAJOR = 0
-  MINOR = 2
+  MINOR = 3
   BUGFIX = 0
   DEV = nil
 

data/lib/origen_link/configuration_commands.rb

@@ -11,6 +11,10 @@ module OrigenLink
       @pinmap = pinmap.gsub(/\s+/, '')
       response = send_cmd('pin_assign', @pinmap)
       setup_cmd_response_logger('pin_assign', response)
+      # store pins to the pinmap hash, this is used to remove non-link pins
+      # from the pattern in cases where the app includes too many pins
+      pinmap_arr = @pinmap.split(',')
+      0.step(pinmap_arr.size - 1, 2) { |p| @pinmap_hash[pinmap_arr[p]] = true }
     end
 
     # pinorder=
@@ -24,9 +28,40 @@ module OrigenLink
     #   example:
     #     tester.pinorder = 'tclk,tms,tdi,tdo'
     def pinorder=(pinorder)
-      @pinorder = pinorder.gsub(/\s+/, '')
-      response = send_cmd('pin_patternorder', @pinorder)
-      setup_cmd_response_logger('pin_patternorder', response)
+      cmd = []
+      cmd << 'pin_patternorder'
+      cmd << pinorder.gsub(/\s+/, '')
+      @pinorder = cmd[1]
+      if @pinmap.nil?
+        @batched_setup_cmds << cmd
+      else
+        response = send_cmd(cmd[0], @pinorder)
+        setup_cmd_response_logger(cmd[0], response)
+      end
+    end
+
+    # set_pinorder
+    #   This method is called if the app has not explicitly set the pin order
+    #   for the Link server using pinorder= (above)
+    #
+    #   Origen.app.pin_pattern_order is read to get the pin pattern order
+    #   and pass it to pinorder=
+    def set_pinorder
+      pinlist = ''
+      ordered_pins_cache.each do |pin|
+        unless pin.is_a?(Hash)
+          if pin.size == 1
+            pinlist = pinlist + ',' unless pinlist.length == 0
+            pinlist = pinlist + pin.name.to_s
+          else
+            dut.pins(pin.id).map.each do |sub_pin|
+              pinlist = pinlist + ',' unless pinlist.length == 0
+              pinlist = pinlist + sub_pin.name.to_s
+            end
+          end
+        end
+      end
+      self.pinorder = pinlist
     end
 
     # pinformat=
@@ -36,9 +71,16 @@ module OrigenLink
     #   example:
     #     tester.pinformat = 'func_25mhz,tclk,rl'
     def pinformat=(pinformat)
-      @pinformat = replace_tset_name_w_number(pinformat.gsub(/\s+/, ''))
-      response = send_cmd('pin_format', @pinformat)
-      setup_cmd_response_logger('pin_format', response)
+      cmd = []
+      cmd << 'pin_format'
+      cmd << replace_tset_name_w_number(pinformat.gsub(/\s+/, ''))
+      @pinformat = cmd[1]
+      if @pinmap.nil?
+        @batched_setup_cmds << cmd
+      else
+        response = send_cmd(cmd[0], @pinformat)
+        setup_cmd_response_logger(cmd[0], response)
+      end
     end
 
     # pintiming=
@@ -51,9 +93,119 @@ module OrigenLink
     #   example:
     #     tester.pintiming = 'func_25mhz,tms,0,tdi,0,tdo,1'
     def pintiming=(pintiming)
-      @pintiming = replace_tset_name_w_number(pintiming.gsub(/\s+/, ''))
-      response = send_cmd('pin_timing', @pintiming)
-      setup_cmd_response_logger('pin_timing', response)
+      cmd = []
+      cmd << 'pin_timing'
+      cmd << replace_tset_name_w_number(pintiming.gsub(/\s+/, ''))
+      @pintiming = cmd[1]
+      if @pinmap.nil?
+        @batched_setup_cmds << cmd
+      else
+        response = send_cmd(cmd[0], @pintiming)
+        setup_cmd_response_logger(cmd[0], response)
+      end
+    end
+
+    # process_timeset(tset)
+    #   This method will check the pin timing api for the current timeset.
+    #   If the timset is programmed, it will be processed into the Link
+    #   timing format, registered, and sent to the server.
+    #   Else, a warning message will be displayed
+    #
+    #   example generated command:
+    #     send_cmd('pin_timingv2', '2,drive,5,data,tck;10,data,tdi|compare,35,data,tck,tdo;5,data,tdi')
+    def process_timeset(tset)
+      # Check to see if this timeset has been programmed
+      if dut.timesets(tset.to_sym).nil?
+        # Timset has not been programmed through the pin timing api
+        tset_warning(tset)
+        ''	# return empty string on failure
+      else
+        # Timeset has been programmed
+        # accumulate and sort drive events
+        drive_str = tset_argstr_from_events(dut.timesets(tset.to_sym).drive_waves)
+
+        # accumulate and sort compare events
+        compare_str = tset_argstr_from_events(dut.timesets(tset.to_sym).compare_waves)
+
+        # construct the command argument string
+        argstr = get_tset_number(tset).to_s
+        if drive_str.length > 0
+          argstr = argstr + ',drive,' + drive_str
+          argstr = argstr + '|compare,' + compare_str if compare_str.length > 0
+        elsif compare_str.length > 0
+          argstr = argstr + ',compare,' + compare_str
+        else
+          fail "#{tset} timeset is programmed with no drive or compare edges"
+        end
+
+        # send the timeset information to the server
+        cmd = []
+        cmd << 'pin_timingv2'
+        cmd << argstr
+        if @pinmap.nil?
+          @batched_setup_cmds << cmd
+        else
+          response = send_cmd('pin_timingv2', argstr)
+          setup_cmd_response_logger('pin_timingv2', response)
+        end
+
+        # return the tset number from the tset hash
+        "tset#{@tsets_programmed[tset]},"
+      end
+    end
+
+    # tset_argstr_from_events(timing_waves)
+    #   consume timing wave info and return command argstr format
+    #   output: 10,data,tdi,tms;15,data,tck;25,0,tck;35,data,tms
+    def tset_argstr_from_events(waves)
+      event_time = []
+      event_setting = {}
+      event_pins = {}
+      waves.each do |w|
+        # skip any events wave that does not have any associated pins
+        unless w.pins.size == 0
+          w.evaluated_events.each do |e|
+            event_key = e[0].to_f		# time stamp for the event
+            event_time << event_key
+            event_setting[event_key] = [] unless event_setting.key?(event_key)
+            event_setting[event_key] << e[1].to_s
+
+            event_pins[event_key] = [] unless event_pins.key?(event_key)
+            event_pins[event_key] << []
+            w.pins.each do |p|
+              event_pins[event_key].last << p.id.to_s if @pinmap_hash[p.id.to_s]
+            end
+          end
+        end
+      end
+      # now sort the events into time order and build the tset argstr
+      event_time.uniq!
+      event_time.sort!
+      rtnstr = ''
+      event_time.each do |event_key|
+        rtnstr = rtnstr + ';' unless rtnstr.length == 0
+        event_setting[event_key].each_index do |i|
+          pins = event_pins[event_key][i].uniq.join(',')
+          rtnstr = rtnstr + ';' if i > 0
+          rtnstr = rtnstr + event_key.to_s + ',' + event_setting[event_key][i] + ',' + pins if pins.length > 0
+        end
+      end
+      rtnstr.gsub(/;+/, ';')
+    end
+
+    # tset_warning(tset)
+    #   This method is used to display a no timing info warning.
+    #   The warning is displayed only once per tset that is
+    #   encountered
+    def tset_warning(tset)
+      unless @tsets_warned.key?(tset)
+        Origen.log.warn("No timing information provided for timeset :#{tset}")
+        Origen.log.warn('Default timing will be used (pin operations are in pattern order)')
+        Origen.log.warn('Specify timing through the timing api or by using:')
+        Origen.log.warn("  tester.pinformat = 'func_25mhz,tclk,rl'")
+        Origen.log.warn("  tester.pintiming = 'func_25mhz,tms,0,tdi,0,tdo,1'")
+        @tsets_warned[tset] = true
+      end
     end
 
     # replace_tset_name_w_number(csl)

data/lib/origen_link/server/jtag.rb

@@ -2,11 +2,17 @@ require 'origen_link/server/pin'
 
 module OrigenLink
   module Server
+    # The Jtag class is not part of the OrigenLink plug-in/server ecosystem.
+    # It implements standard jtag protocol.  It can be used to implement a
+    # Jtag protocol server (not included in this repository presently).
     class Jtag
+      # The value read from TDO during the shift
       attr_reader :tdoval
+      # Enable extra output
       attr_accessor :verbose_enable
       attr_accessor :anytdofail
 
+      # Create the jtag pin objects
       def initialize(tdiio = 16, tdoio = 23, tmsio = 19, tckio = 26, tck_period = 0.000001)
         @tdipin = Pin.new(tdiio, :out)
         @tdopin = Pin.new(tdoio, :in)
@@ -19,10 +25,12 @@ module OrigenLink
         @anytdofail = false
       end
 
+      # not needed, no need for wait states between operations
       def tck_period=(value)
         @tck_half_period = value / 2
       end
 
+      # close out file IO objects for the pins
       def destroy
         @tdipin.destroy
         @tdopin.destroy
@@ -34,6 +42,7 @@ module OrigenLink
         @tckpin = nil
       end
 
+      # perform 1 jtag cycle
       def do_cycle(tdival, tmsval, capturetdo = false)
         @tdipin.out(tdival)
         @tmspin.out(tmsval)
@@ -47,11 +56,13 @@ module OrigenLink
         @tckpin.out(0)
       end
 
+      # advance state machine to test logic reset, then return to run/test idle
       def do_tlr
         8.times { do_cycle(0, 1) }
         do_cycle(0, 0)
       end
 
+      # shift a value in on tdi, optionall capture tdo
       def do_shift(numbits, value, capturetdo = false, suppresscomments = false, tdocompare = '')
         @tdoval = 0
         @tdostr = ''
@@ -98,6 +109,7 @@ module OrigenLink
         end
       end
 
+      # perform an ir-update
       def do_ir(numbits, value, options = {})
         defaults = {
           capturetdo:	      false,
@@ -130,6 +142,7 @@ module OrigenLink
         do_cycle(0, 0)
       end
 
+      # perform a dr update
       def do_dr(numbits, value, options = {})
         defaults = {
           capturetdo:	      true,
@@ -160,6 +173,7 @@ module OrigenLink
         do_cycle(0, 0)
       end
 
+      # traverse the pause dr state
       def pause_dr
         do_cycle(0, 1)
         do_cycle(0, 0)
@@ -171,6 +185,7 @@ module OrigenLink
         do_cycle(0, 0)
       end
 
+      # traverse the pause ir state
       def pause_ir
         do_cycle(0, 1)
         pause_dr

data/lib/origen_link/server/pin.rb

@@ -5,20 +5,31 @@
 
 module OrigenLink
   module Server
+    # The server pin class is used to perform IO using the UDOO pins
     class Pin
       @@pin_setup = {
         in:  'in',
         out: 'out'
       }
 
+      # True if this pin exists in /sys/class/gpio after export.  False otherwise.
       attr_reader :gpio_valid
+      # This pin's vector data for the pattern cycle being executed
+      attr_accessor :pattern_data
+      # This pin's index in the vector data received from the plug-in app
+      attr_accessor :pattern_index
+      # This pin's response for the executing vector
+      attr_accessor :response
 
-      # initialize:
-      #  description - This method will execute system command
-      #                "sudo echo ionumber > /sys/class/gpio/export"
-      #                to create the IO file interface.  It will
-      #                set the direction, initial pin state and initialize
-      #                instance variables
+      # Export the pin io files through the system and take control of the IO
+      #
+      # This method will execute system command
+      # "echo #{ionumber} > /sys/class/gpio/export"
+      # to create the IO file interface.  It will
+      # set the direction, initial pin state and initialize
+      # instance variables
+      #
+      # Receives
       #  ionumber - required, value indicating the pin number (BCM IO number,
       #             not the header pin number)
       #  direction - optional, specifies the pin direction.  A pin is
@@ -49,8 +60,94 @@ module OrigenLink
           end
           @pin_val_obj = File.open(@pin_val_name, 'r+') if @gpio_valid
         end
+        @pattern_data = ''
+        @pattern_index = -1
+        @response = 'W'
+        @cycle_failure = false
+        @data_is_drive = false
+      end
+
+      # data_is_drive?
+      #   returns whether the current pattern data is drive
+      def data_is_drive?
+        @data_is_drive
+      end
+
+      # data_is_compare?
+      #   returns whether the current pattern data is compare
+      def data_is_compare?
+        !@data_is_drive
       end
 
+      # cycle_failure
+      #   returns a boolean indicating pass/fail status of this pin
+      def cycle_failure
+        if @response == 'W'
+          true		# force failure if no operation performed
+        else
+          @cycle_failure
+        end
+      end
+
+      # load_pattern_data
+      #   Grab this pin's data character from the pattern data
+      def load_pattern_data(cycle)
+        if @pattern_index > -1
+          @pattern_data = cycle[@pattern_index]
+          @response = 'W'
+          @cycle_failure = false
+          if @pattern_data == '1' || @pattern_data == '0'
+            @data_is_drive = true
+          else
+            @data_is_drive = false
+          end
+        else
+          @gpio_valid = false
+        end
+      end
+
+      # process_event(event)
+      #   perform the requested pin operation and update the response (if required)
+      def process_event(operation, requested_action)
+        if operation == :drive
+          if data_is_drive?
+            if requested_action == 'data'
+              out(@pattern_data)
+              @response = @pattern_data
+            else
+              out(requested_action)
+            end # requested_action == 'data'
+          end # data_is_drive?
+        end # operation == :drive
+        if operation == :compare
+          if data_is_compare?
+            if requested_action == 'data'
+              case self.in
+                when '0'
+                  @cycle_failure = true if @pattern_data == 'H'
+                  if @pattern_data == 'X'
+                    @response = '.'
+                  else
+                    @response = 'L'
+                  end
+                # end of when '0'
+                when '1'
+                  @cycle_failure = true if @pattern_data == 'L'
+                  if @pattern_data == 'X'
+                    @response = '`'
+                  else
+                    @response = 'H'
+                  end
+                # end of when '1'
+                else
+                  @response = 'W'
+              end # case
+            end # requested_action == 'data'
+          end # data_is_compare?
+        end # operation == :compare
+      end
+
+      # Close the file IO objects associated with this pin
       def destroy
         if @gpio_valid
           @pin_dir_obj.close
@@ -60,10 +157,10 @@ module OrigenLink
         end
       end
 
-      #  out:
-      #    description - Sets the output state of the pin.  If the pin
-      #                  is setup as an input, the direction will first
-      #                  be changed to output.
+      # Sets the output state of the pin.
+      #
+      # If the pin is setup as an input,
+      # the direction will first be changed to output.
       #
       def out(value)
         if @gpio_valid
@@ -75,10 +172,10 @@ module OrigenLink
         end
       end
 
-      #  in:
-      #    description - Reads and returns state of the pin.  If the pin
-      #                  is setup as an output, the direction will first
-      #                  be changed to input.
+      # Reads and returns state of the pin.
+      #
+      # If the pin is setup as an output, the direction will first
+      # be changed to input.
       #
       def in
         if @gpio_valid
@@ -95,11 +192,10 @@ module OrigenLink
         end
       end
 
-      #  update_direction:
-      #    description - Sets the pin direction
+      # Sets the pin direction
       #
-      #  direction - specifies the pin direction.  A pin is
-      #              initialized as an input if a direction isn't specified.
+      # Receives:
+      #  direction - specifies the pin direction.  Input is default.
       #
       #  Valid direction values:
       #    :in	-	input
@@ -113,6 +209,7 @@ module OrigenLink
         end
       end
 
+      # Returns 'OrigenLinPin' + io number
       def to_s
         'OrigenLinkPin' + @ionumber.to_s
       end