origen_link 0.1.2 → 0.2.0.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b819630a6b626e6c330114c40f70108f7850657
-  data.tar.gz: 51a6ddf9796af5b1569c3b61a9e8f8d2b3c955c9
+  metadata.gz: b3d2af884ce3e644373c8823c0411d1822eef7a0
+  data.tar.gz: a89e4bc1a123d78896fb60f7bb5acecd50b88752
 SHA512:
-  metadata.gz: 379e3b256c9becd833c2d2fd76fcfba2c3b1b7c3f4922986e6ca8523eb0bda24919366189c06695577aea979be102a7a2a0fb84e4b8f55973d22cd14927b6117
-  data.tar.gz: 222fdaf6916110972cacb9a25f1f2cf0b60ba8406770f8518f8777b00e771c1755eff011ecc46465c4dac7f5035e5ff19eb57ed8dd1a4acf60a423d4db174941
+  metadata.gz: b1e98d576f6ccd3f59f2cc08b26cd4572b72bd458a7ef1449851d0cf4e2d143329c6381f608a7e15d5d2e29a39721f702feb0d5b2907e3c1b19dda4817dbd482
+  data.tar.gz: 55aff1223d4ed62bf407c5fa6c68e5c51a4be44c315df30b39344aa9f5e94cd2abf00f39f895326cce1c005101a29f1becd0a5ff2aaa2462abccf11486eee5cb

data/bin/start_link_server

@@ -6,14 +6,60 @@ require 'origen_link/server/sequencer'
 server = TCPServer.open('', 12_777)
 puts 'server started'
 pinsequencer = OrigenLink::Server::Sequencer.new
+remoteuser = ''
+remotehost = ''
+sessionactivity = Time.now
+sessionactive = false
 
 loop do
   client = server.accept
-  response = ''
-  while (message = client.gets) != "\n"
-    # process the message
-    # for now only pin_ messages are accepted
-    response = response + pinsequencer.processmessage(message.chomp) + "\n"
+  thisuser = client.gets.chomp
+  thisremotehost = client.peeraddr[3]
+  
+  # for now assume that any session lasting longer than 20 minutes has timed out (will happen if the origen side app is killed or stopped at a breakpoint with no activity)
+  if (Time.now - sessionactivity) > 1200
+    sessionactive = false
+  end
+  
+  change_in_user = false
+  
+  # if there is no active session running allow one to start
+  unless sessionactive
+    #flag any change in host machine or user for collision detection
+    change_in_user = true unless (remoteuser.eql? thisuser) && (remotehost.eql? thisremotehost)
+    remoteuser = thisuser
+    remotehost = thisremotehost
+  end
+  
+  # always return whether or not the user has been changed (for collision detection)
+  if change_in_user
+    response = "user_change:user_change\n"
+  else
+    response = "\n"
+  end
+  
+  # if this connection is from the active user\host machine, then process the information
+  if (remoteuser.eql? thisuser) && (remotehost.eql? thisremotehost)
+    while (message = client.gets) != "\n"
+      # process the message
+      # for now only pin_ messages are accepted
+      if message =~ /session_end/
+        sessionactive = false
+        response = response + "session_end:session_end\n"
+      else
+        sessionactive = true
+        response = response + pinsequencer.processmessage(message.chomp) + "\n"
+      end
+    end
+    sessionactivity = Time.now
+  else
+    checkmessage = client.gets.chomp
+    if checkmessage =~ /session_kill/
+      sessionactive = false
+      response = response + "Terminated: session from #{remoteuser} at IP address #{remotehost} inactive for #{Time.now - sessionactivity} seconds has been killed\n"
+    else
+      response = response + "Busy: server is in use by #{remoteuser} from IP address #{remotehost}\n"
+    end
   end
   client.write(response)
   client.close

data/config/application.rb

@@ -40,6 +40,10 @@ class OrigenLinkApplication < Origen::Application
 
   config.semantically_version = true
 
+  config.shared = {
+    command_launcher: 'config/shared_commands.rb'
+  }
+
   # An example of how to set application specific LSF parameters
   #config.lsf.project = "msg.te"
   

data/config/shared_commands.rb

@@ -0,0 +1,40 @@
+# The requested command is passed in here as @command
+case @command
+
+when "link:listen"
+  t = Thread.new do
+    OrigenLink::Listener.run!
+  end
+  Thread.new do
+    # Get the current host
+    host = `hostname`.strip.downcase
+    if Origen.os.windows?
+      domain = ''  # Not sure what to do in this case...
+    else
+      domain = `dnsdomainname`.strip
+    end
+    port = 20020
+    puts ''
+    sleep 0.5
+    puts
+    puts
+    puts "*************************************************************"
+    puts "Point your OrigenLink app to:  http://#{host}#{domain.empty? ? '' : '.' + domain}:#{port}"
+    puts "*************************************************************"
+    puts
+    puts
+  end
+
+  # Fall through to the Origen interactive command to open up a console
+  @command = "interactive"
+
+# Always leave an else clause to allow control to fall back through to the Origen command handler.
+# You probably want to also add the command details to the help shown via 'origen -h',
+# you can do this bb adding the required text to @plugin_commands before handing control back to
+# Origen.
+else
+  @plugin_commands << <<-EOT
+ link:listen     Open a console and listen for OrigenLink requests over http (i.e. from a GUI)
+  EOT
+
+end

data/config/version.rb

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

data/lib/origen_link.rb

@@ -1,4 +1,4 @@
 require 'origen'
 require 'socket'
-
 require 'origen_link/vector_based'
+require 'origen_link/listener'

data/lib/origen_link/listener.rb

@@ -0,0 +1,78 @@
+require 'sinatra/base'
+module OrigenLink
+  class Listener < Sinatra::Base
+    def self.port
+      @port || 20_020
+    end
+
+    def self.environment
+      @environment || :production
+    end
+
+    def self.target_object
+      @target_object || dut
+    end
+
+    def self.run!(options = {})
+      @port = options[:port]
+      @environment = options[:environment]
+      @target_object = options[:dut]
+      super
+    end
+
+    def target_object
+      self.class.target_object
+    end
+
+    def expand_path(path)
+      path.split('.').each do |p|
+        if p =~ /(.*)\[(\d+)(:(\d+))?\]$/
+          msb = Regexp.last_match(2).to_i
+          lsb = Regexp.last_match(4).to_i if Regexp.last_match(4)
+          yield Regexp.last_match(1)
+          if lsb
+            yield '[]', msb..lsb
+          else
+            yield '[]', msb
+          end
+        else
+          yield p
+        end
+      end
+    end
+
+    get '/hello_world' do
+      'Hello there'
+    end
+
+    get '/dut_class' do
+      target_object.class.to_s
+    end
+
+    post '/register' do
+      t = target_object
+      expand_path(params[:path]) do |method, arg|
+        if arg
+          t = t.send(method, arg)
+        else
+          t = t.send(method)
+        end
+      end
+      t.write!(params[:data].to_i)
+      nil
+    end
+
+    get '/register' do
+      t = target_object
+      expand_path(params[:path]) do |method, arg|
+        if arg
+          t = t.send(method, arg)
+        else
+          t = t.send(method)
+        end
+      end
+      t.sync
+      t.data.to_s
+    end
+  end
+end

data/lib/origen_link/server/pin.rb

@@ -2,41 +2,7 @@
 # using exported file objects.  If the pin is not exported, it
 # will be exported when a pin is initialized
 #
-# 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
-#  ionumber - required, value indicating the pin number (BCM IO number,
-#             not the header pin number)
-#  direction - optional, specifies the pin direction.  A pin is
-#              initialized as an input if a direction isn't specified.
-#
-#
-#  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.
-#
-#
-#  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.
-#
-#
-#  update_direction:
-#    description - Sets the pin direction
-#
-#  direction - specifies the pin direction.  A pin is
-#              initialized as an input if a direction isn't specified.
-#
-#  Valid direction values:
-#    :in	-	input
-#    :out	-	output
-#    :out_high	-	output, initialized high
-#    :out_low	-	output, initialized low
+
 module OrigenLink
   module Server
     class Pin
@@ -47,6 +13,17 @@ module OrigenLink
 
       attr_reader :gpio_valid
 
+      # 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
+      #  ionumber - required, value indicating the pin number (BCM IO number,
+      #             not the header pin number)
+      #  direction - optional, specifies the pin direction.  A pin is
+      #              initialized as an input if a direction isn't specified.
+      #
       def initialize(ionumber, direction = :in)
         @ionumber = Integer(ionumber)
         @pin_dir_name = "#{Server.gpio_dir}/gpio#{@ionumber}/direction"
@@ -83,6 +60,11 @@ 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.
+      #
       def out(value)
         if @gpio_valid
           if @direction == :in
@@ -93,6 +75,11 @@ 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.
+      #
       def in
         if @gpio_valid
           if @direction == :out
@@ -108,6 +95,15 @@ module OrigenLink
         end
       end
 
+      #  update_direction:
+      #    description - Sets the pin direction
+      #
+      #  direction - specifies the pin direction.  A pin is
+      #              initialized as an input if a direction isn't specified.
+      #
+      #  Valid direction values:
+      #    :in	-	input
+      #    :out	-	output
       def update_direction(direction)
         if @gpio_valid
           @pin_dir_obj.pos = 0

data/lib/origen_link/server_com.rb

@@ -17,23 +17,46 @@ module OrigenLink
     def send_cmd(cmdstr, argstr)
       # objects have to be created outside of the block
       # to be accessible outside of the block
+      t1 = 0
       t2 = 0
       t3 = 0
       t4 = 0
       t5 = 0
       response = ''
-      t1 = Time.now
+      user_status = ''
+      success = false
 
-      # open a connection to the server, send the command and wait for a response
-      TCPSocket.open(@address, @port) do |link|
-        t2 = Time.now
-        link.write(cmdstr + ':' + argstr + "\n\n")
-        t3 = Time.now
-        response = link.gets
-        t4 = Time.now
+      until success
+        t1 = Time.now
+
+        # open a connection to the server, send the command and wait for a response
+        TCPSocket.open(@address, @port) do |link|
+          t2 = Time.now
+          link.write(@user_name + "\n" + cmdstr + ':' + argstr + "\n\n")
+          t3 = Time.now
+          user_status = link.gets
+          response = link.gets
+          t4 = Time.now
+        end
+
+        t5 = Time.now
+
+        if @initial_comm_sent && ((user_status =~ /user_change/) || (response =~ /Busy:/))
+          # there has been a collision
+          Origen.log.error 'A collision (another user interrupted your link session) has occured'
+          Origen.log.error "When using debug mode ensure that you don't exceed the 20 minute communication time out"
+          exit
+        end
+
+        if response =~ /Busy:/
+          Origen.log.error response + ' retry in 1 second'
+          sleep(1)
+        else
+          success = true
+          @initial_comm_sent = true
+        end
       end
 
-      t5 = Time.now
       @total_comm_time += (t5 - t1)
       if @max_packet_time < (t5 - t1)
         @max_packet_time = (t5 - t1)
@@ -50,23 +73,47 @@ module OrigenLink
     end
 
     def send_batch(vector_batch)
-      t2 = 0
-      t3 = 0
-      t4 = 0
-      t5 = 0
-      response = []
-      t1 = Time.now
-      TCPSocket.open(@address, @port) do |link|
-        t2 = Time.now
-        vector_batch_str = vector_batch.join("\n") + "\n\n"
-        link.write(vector_batch_str)
-        t3 =  Time.now
-        while line = link.gets
-          response << line.chomp
+      vector_batch_str = @user_name + "\n" + vector_batch.join("\n") + "\n\n"
+      user_status = ''
+      success = false
+
+      until success
+        t1 = 0
+        t2 = 0
+        t3 = 0
+        t4 = 0
+        t5 = 0
+        response = []
+        t1 = Time.now
+        TCPSocket.open(@address, @port) do |link|
+          t2 = Time.now
+          link.write(vector_batch_str)
+          t3 =  Time.now
+          while line = link.gets
+            response << line.chomp
+          end
+          t4 = Time.now
+        end
+        t5 = Time.now
+
+        user_status = response.delete_at(0)
+        if @initial_comm_sent && ((user_status =~ /user_change/) || (response[0] =~ /Busy:/))
+          # there has been a collision
+          Origen.log.error 'A collision (another user interrupted your link session) has occured'
+          Origen.log.error "When using debug mode ensure that you don't exceed the 20 minute communication time out"
+          exit
         end
-        t4 = Time.now
+
+        if response[0] =~ /Busy:/
+          Origen.log.error response[0] + ' retry in 1 second'
+          sleep(1)
+        else
+          success = true
+          @initial_comm_sent = true
+        end
+
       end
-      t5 = Time.now
+
       @total_comm_time += (t5 - t1)
       @total_connect_time += (t2 - t1)
       @total_xmit_time += (t3 - t2)

data/lib/origen_link/vector_based.rb

@@ -1,3 +1,4 @@
+require 'etc'
 require 'origen_testers'
 require 'origen_link/server_com'
 require 'origen_link/capture_support'
@@ -39,6 +40,7 @@ module OrigenLink
     attr_reader :fail_count, :vector_count, :total_comm_time, :total_connect_time, :total_xmit_time
     attr_reader :total_recv_time, :total_packets, :vector_repeatcount, :tsets_programmed, :captured_data
     attr_reader :vector_batch, :store_pins_batch, :comment_batch
+    attr_reader :user_name, :initial_comm_sent
 
     def initialize(address, port, options = {})
       @address = address
@@ -68,6 +70,8 @@ module OrigenLink
       @batch_vectors = true
       @pattern_link_messages = []
       @pattern_comments = {}
+      @user_name = Etc.getlogin
+      @initial_comm_sent = false
     end
 
     # push_comment
@@ -288,6 +292,7 @@ module OrigenLink
     def finalize_pattern(output_file)
       Origen.log.debug('Pattern generation completed. Sending all stored vector data')
       synchronize(output_file)
+      send_cmd('', 'session_end')
       # for debug, report communication times
       Origen.log.debug("total communication time: #{@total_comm_time}")
       Origen.log.debug("total connect time: #{@total_connect_time}")
@@ -316,6 +321,7 @@ module OrigenLink
           file.puts(@pattern_link_messages[index])
           file.puts(@pattern_comments[index]) if @pattern_comments.key?(index)
         end
+        file.puts(':session_end')
       end
     end
 

data/templates/web/index.md.erb

@@ -6,11 +6,17 @@
 
 ### Purpose
 
-This application...
+This is a plug-in for Origen that enables live silicon debug directly from origen source.
 
 ### How To Use
 
-Add quickstart documentation here...
+Add the following line to your application's GEMFILE:
+
+* gem 'origen_link'
+
+Add the following line to your application:
+
+* require 'origen_link'
 
 ### How To Setup the Application Environment
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_link
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0.pre0
 platform: ruby
 authors:
 - Paul Derouen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -39,47 +39,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.1
 - !ruby/object:Gem::Dependency
-  name: origen_jtag
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: origen_doc_helpers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.4.7
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.7
 description: 
 email:
 - paul.derouen@nxp.com
@@ -92,11 +70,13 @@ files:
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
+- config/shared_commands.rb
 - config/version.rb
 - lib/origen_link.rb
 - lib/origen_link/callback_handlers.rb
 - lib/origen_link/capture_support.rb
 - lib/origen_link/configuration_commands.rb
+- lib/origen_link/listener.rb
 - lib/origen_link/server/jtag.rb
 - lib/origen_link/server/pin.rb
 - lib/origen_link/server/sequencer.rb