libfst 0.1.0

data/samples/transaction_filter_process/uart.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+
+# Copyright (C) 2024 Théotime Bollengier <theotime.bollengier@ensta-bretagne.fr>
+#
+# This file is part of libfst.rb <https://gitlab.ensta-bretagne.fr/bollenth/libfst.rb>
+#
+# libfst.rb is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# libfst.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with libfst.rb. If not, see <https://www.gnu.org/licenses/>. 
+
+require_relative '../../lib/libfst'
+require 'colorize'
+
+
+class UARTDecoder < GTKWave::TransactionFilter
+  def initialize
+    super
+    puts ' UART Decoder '.center(80, '-')
+    puts "name              #{@name.inspect}"
+    puts "data_start_tocken #{@data_start_tocken.inspect}"
+    puts "min_time          #{@min_time.inspect}"
+    puts "max_time          #{@max_time.inspect}"
+    puts "max_seqn          #{@max_seqn.inspect}"
+    puts "args              #{@args.inspect}"
+    puts "signames          #{@signames.inspect}"
+    puts "#{@signames.length} signal#{@signames.length > 1 ? 's' : ''}: #{[@signames[0...-1].join(', '), @signames.last].reject(&:empty?).join(' and ')}"
+    raise "expecting a signle signal, not #{@ivcd.traces.length} signals" if @ivcd.traces.length != 1
+    raise "the signal is expected to be a single bit, not #{@ivcd.traces.values.first.width} bits wide" unless @ivcd.traces.values.first.width == 1
+    
+    @args.each do |str|
+      m = str.match(/^\s*baudrate\s*=\s*(\d+)\s*$/)
+      if m then
+        @baudrate = m[1].to_i
+        break
+      end
+    end
+    raise 'Please provide baudrate as argument (ex: "baudrate = 115200")' unless @baudrate
+    @bit_period = (1.0 / (@baudrate * @ivcd.timescale)).round
+  end
+
+
+  def puts(str)
+    $stderr.puts str
+  end
+
+
+  def read
+    state = :wait_start_bit
+    l = nil              # last value
+    word = nil           # shift register
+    start_bit_date = nil # date of the start bit
+    nb_valid_bits = nil
+
+    $stdout.write "$name #{@name}\n#0\n"
+
+    @ivcd.read do |_,v,t|
+      v = case v
+          when '0' then 0
+          when '1' then 1
+          end
+      case state
+      when :wait_start_bit
+        if v == 0 and l == 1 then
+          if start_bit_date && ((t - start_bit_date).to_f / @bit_period).round > 11
+            $stdout.write "##{start_bit_date + (10.0 / (@baudrate * @ivcd.timescale)).round}\n"
+          end
+          start_bit_date = t
+          word = 0
+          nb_valid_bits = 0
+          state = :recv_bits
+          #puts "start @ #{@ivcd.pretty_time}"
+        end
+      when :recv_bits
+        b = ((t - start_bit_date).to_f / @bit_period).round
+        #puts "b = #{b} @ #{@ivcd.pretty_time}"
+        (nb_valid_bits...[8, b].min).each do |i|
+          word |= (l == 1 ? 1 : 0) << i
+        end
+        nb_valid_bits = b
+        if b > 8 then
+          if v != 1 then
+            puts "[Stop bit not at 1! (#{v.inspect}) @ #{@ivcd.pretty_time}]".light_red
+          end
+          word = (word >> 1) & 0xff
+
+          word = case word
+                 when 0x0d
+                   w = '\r'
+                   "\e[94m\\r\e[0m"
+                 when 0x0a
+                   w = '\n'
+                   "\e[94m\\n\e[0m\n"
+                 when 0x1b
+                   w = '\e'
+                   "\e[94m\\e\e[0m"
+                 else
+                   if word >= 32
+                     w = word == 32 ? "' '" : word.chr
+                     "\e[90m#{word.chr}\e[0m"
+                   else
+                     w = "0x#{word.to_s(16).rjust(2, '0')}"
+                     "\e[33m\\x#{word.to_s(16).rjust(2, '0')}\e[0m"
+                   end
+                 end
+          $stderr.write word
+          $stdout.write "##{start_bit_date} #{w}\n"
+          if b >= 10 && v == 0 && l == 1
+            start_bit_date = t
+            word = 0
+            nb_valid_bits = 0
+          else
+            state = :wait_start_bit
+          end
+        end
+      end
+
+      l = v
+    end
+  end
+
+
+  def write
+    $stdout.write "$finish\n"
+    $stdout.flush
+    puts ''
+    puts '-'*80
+  end
+end
+
+
+UARTDecoder.run
+

data/samples/vcd/vcd_read.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require_relative '../../lib/libfst.rb'
+
+system 'unxz -k skinny_rand.vcd.xz' unless File.exist?('skinny_rand.vcd')
+system 'unxz -k skinny_rand_nvc.vcd.xz' unless File.exist?('skinny_rand_nvc.vcd')
+
+tick = Time.now
+vcd = VCD::Reader.new 'skinny_rand_nvc.vcd'
+tock = Time.now
+
+puts vcd
+#puts vcd['/test_rand/dut/clk']
+
+vcd.traces.values.each do |t|
+  puts t.variables.first.path
+end
+
+puts "Read VCD file in #{(tock - tick).round(3)} s"
+
+vcd.on_comment do |comment, time, reader|
+  puts "Comment @#{time*vcd.timescale}: #{comment.inspect}"
+  #vcd.stop_parsing
+end
+
+vcd.on_time_change do |time|
+  #puts " #{vcd.real_time} s ".center(80, '-')
+  #puts " #{time} ".center(80, '-')
+  puts " #{vcd.pretty_time} ".center(80, '-')
+end
+
+vcd.read('/test_rand', start_time: '0.5us', end_time: '0.001 ms') do |trace, value, time|
+  puts "@#{time}, #{trace.variables.first.path} = #{value}"
+end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: libfst
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Théotime Bollengier
+bindir: bin
+cert_chain: []
+date: 2025-02-08 00:00:00.000000000 Z
+dependencies: []
+description: fstlib allows to read and write FST files (Fast Signal Trace) from Ruby
+email: theotime.bollengier@ensta-bretagne.fr
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- ext/extconf.rb
+- ext/fastlz.c
+- ext/fastlz.h
+- ext/fst_config.h
+- ext/fst_win_unistd.h
+- ext/fstapi.c
+- ext/fstapi.h
+- ext/libfst_rb.c
+- ext/lz4.c
+- ext/lz4.h
+- lib/libfst.rb
+- lib/libfst/reader.rb
+- lib/libfst/tfp.rb
+- lib/libfst/vcd.rb
+- lib/libfst/version.rb
+- lib/libfst/writer.rb
+- libfst.gemspec
+- samples/create_file.rb
+- samples/gtkwave.png
+- samples/out.gtkw
+- samples/read2.rb
+- samples/read_file.rb
+- samples/skinny_rand.fst
+- samples/transaction_filter_process/full_boot.fst
+- samples/transaction_filter_process/full_boot.gtkw
+- samples/transaction_filter_process/sdcard.rb
+- samples/transaction_filter_process/uart.rb
+- samples/vcd/skinny_rand.vcd.xz
+- samples/vcd/vcd_read.rb
+homepage: https://gitlab.ensta-bretagne.fr/bollenth/fstlib.rb
+licenses:
+- GPL-3.0-or-later
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Fast Signal Trace bindings for Ruby
+test_files: []