rhdl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87d1dd60eae916a05415177bf5f3dbd9430d8b54a4922e8c98c4f8cff181524b
+  data.tar.gz: 0e50218f3df5e1fb5f375b6f4219be61e8e66a50b788e8a71f445e7cde35c4cd
+SHA512:
+  metadata.gz: 407dcc265f29e30d414f04427f49fef74c6dfbfbaa23e2419cf16a1e09a5394847bfe3b78e77497ee5fc040dc697ceeef16ff05f04bac6fed70a37d302e445be
+  data.tar.gz: 3a5977f6ff6bd7a5c4bfe8c320f0e3d965876f87a77cdc5b1ae15f06407429819599f0ce7da744bfae1db3be23d82017bc65013ddb81f7753f8f5fbfb41d272f

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rhdl.gemspec
+gemspec

data/data/README.md

@@ -0,0 +1,3 @@
+# Data folder
+
+This is where static data required for gem operation should reside

data/exe/rhdl

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'rhdl'
+
+filename = ARGV[0]
+
+contents = File.read(filename)
+
+include Rhdl
+
+dsl = TopDsl.new
+dsl.instance_eval(contents, contents)
+
+config = GenConfig.new
+config.top_module_name = "And"
+
+vg = VerilogGenerator.new(dsl, config)
+puts vg.generate_module("Test1")
+puts vg.generate_module("Test2")
+

data/lib/rhdl/assign_statement.rb

@@ -0,0 +1,33 @@
+module Rhdl
+  class AssignStatement < Statement
+    def initialize(var_name, expr)
+      @var_name = var_name
+      @expr = expr
+    end
+  
+    def generate
+      [
+        #"//#{@expr.varnames};",
+        "#{@var_name} = #{@expr.generate};"
+      ]
+    end
+  
+    def check!(check_context)
+      out_type = @expr.get_output_type(check_context)
+      var_type = check_context.get_var_type(@var_name)
+
+      # assignment type check
+      if out_type.is_equal_or_child_of(var_type)
+        raise "cannot assign type #{out_type} to var #{var_type}"
+      end
+
+      if out_type.bits != var_type.bits
+        raise "cannot assign type #{out_type} to var #{var_type}, they are not the same size"
+      end
+
+      @expr.fanout(check_context, self)
+      check_context.notify_driver(@var_name, self)
+
+    end
+  end
+end

data/lib/rhdl/bin_op.rb

@@ -0,0 +1,38 @@
+module Rhdl
+  class BinOp < Expression
+    def initialize(lhs, rhs, op)
+      @lhs = lhs
+      @rhs = rhs
+      @op = op
+    end
+  
+    def varnames
+      @lhs.varnames + @rhs.varnames
+    end
+  
+    def generate
+      "(#{@lhs.generate} #{@op} #{@rhs.generate})"
+    end
+
+    def fanout(check_context, statement)
+      @lhs.fanout(check_context, statement)
+      @rhs.fanout(check_context, statement)
+    end
+  
+    def get_output_type(check_context)
+      ltype = @lhs.get_output_type(check_context)
+      rtype = @rhs.get_output_type(check_context)
+      if @op == "&"
+  
+        if ltype.to_s != "uint_1" ||
+           rtype.to_s != "uint_1"
+           raise "& does not support types #{ltype} and #{rtype}"
+        end
+  
+        return ltype
+      else
+        raise "unknown operation '#{op}'"
+      end
+    end
+  end
+end

data/lib/rhdl/block_dsl.rb

@@ -0,0 +1,65 @@
+module Rhdl
+  class BlockDsl
+  
+    class ::Integer
+      def generate
+        "1'b#{to_s}"
+      end
+
+      def fanout(check_context, statement)
+        # literals can fanout anytime
+      end
+
+      def get_output_type(check_context)
+        if self == 0 || self == 1
+          return DataType.new("uint", 1, nil)
+        end
+
+        raise 'integer literal other than 0 or 1 not supported'
+      end
+    end
+
+    class ::Array
+      def generate
+        "{#{self.map{|x| x.generate}.join(', ')}}"
+      end
+
+      def fanout(check_context, statement)
+        self.each do |x|
+          x.fanout(check_context, statement)
+        end
+      end
+
+      def get_output_type(check_context)
+        totalbits = self.flatten.sum{|x| x.get_output_type(check_context).bits}
+        DataType.new("uint", totalbits, nil)
+      end
+    end
+
+    attr_reader :statements
+    def initialize
+      @variables = {}
+      @statements = []
+      @trap = false
+    end
+  
+    def method_missing(name, *args)
+      super if args.length != 0
+      super if @trap
+  
+      @trap = true
+      v = @variables[name]
+      if v.nil?
+        v = Variable.new(name, self)
+        @variables[name] = v
+      end
+      @trap = false
+      v
+    end
+  
+    def add_assign_statement(var_name, expr)
+      @statements << AssignStatement.new(var_name, expr)
+    end
+  
+  end
+end

data/lib/rhdl/check_context.rb

@@ -0,0 +1,111 @@
+module Rhdl
+  class CheckContext
+    def initialize
+      @variables = {}
+      @types = {
+        "uint" => DataType.new("uint", 1, nil)
+      }
+    end
+  
+    def add_input_variable(name, paramstatement)
+      raise "#{name} is already defined" if @variables[name]
+  
+      @variables[name] = {
+        name: name,
+        role: :input,
+        kind: :wire,
+        fanout: [],
+        driver: true, # always driven
+        type: @types[paramstatement.type].with_bits(paramstatement.bits)
+      }
+    end
+  
+    def add_output_variable(name, paramstatement)
+      raise "#{name} is already defined" if @variables[name]
+  
+      @variables[name] = {
+        name: name,
+        role: :output,
+        kind: :wire,
+        fanout: true,
+        driver: nil,
+        type: @types[paramstatement.type].with_bits(paramstatement.bits)
+      }
+    end
+
+    def add_wire_variable(name, paramstatement)
+      raise "#{name} is already defined" if @variables[name]
+  
+      @variables[name] = {
+        name: name,
+        role: :output,
+        kind: :wire,
+        fanout: [],
+        driver: nil,
+        type: @types[paramstatement.type].with_bits(paramstatement.bits)
+      }
+    end
+  
+    def add_register_variable(name, paramstatement)
+      raise "#{name} is already defined" if @variables[name]
+  
+      @variables[name] = {
+        name: name,
+        role: :internal,
+        kind: :register,
+        fanout: [],
+        driver: nil,
+        type: @types[paramstatement.type].with_bits(paramstatement.bits)
+      }
+    end
+  
+    def get_var_type(name)
+  
+      if @variables[name].nil?
+        raise "undefined variable '#{name}'"
+      end
+  
+      @variables[name][:type]
+    end
+
+    def notify_fanout(name, statement)
+      if @variables[name].nil?
+        raise "variable #{name} does not exist"
+      end
+
+      @variables[name][:fanout] << statement
+    end
+
+    def notify_driver(name, statement)
+      if @variables[name].nil?
+        raise "variable #{name} does not exist, and cannot be driven"
+      end
+      unless @variables[name][:driver].nil?
+        raise "variable #{name} is already being driven"
+      end
+
+      @variables[name][:driver] = statement
+    end
+
+    def fanout_check!
+
+      @variables.each do |name, var|
+        used = var[:fanout] == true || var[:fanout].length > 0
+        driven = !var[:driver].nil?
+
+        if used && !driven
+          raise "variable #{name} not driven but used"
+        end
+
+        if !used && driven
+          raise "variable #{name} driven but not used"
+        end
+
+        if !used && !driven
+          raise "variable #{name} completely unused"
+        end
+      end
+    end
+
+  end
+end

data/lib/rhdl/component.rb

@@ -0,0 +1,89 @@
+module Rhdl
+  class Component
+    def initialize(name, topdsl, theproc)
+      @name = name
+      @topdsl = topdsl
+      @proc = theproc
+      @component_dsl = nil
+      @inputs = []
+      @outputs = []
+      @wires = []
+      @comb_block_dsl = []
+    end
+  
+    def inputs
+      implement!
+  
+      @inputs
+    end
+  
+    def outputs
+      implement!
+  
+      @outputs
+    end
+  
+    def wires
+      implement!
+  
+      @wires
+    end
+  
+    def comb_block_dsl
+      implement!
+  
+      @comb_block_dsl
+    end
+  
+    def implement!
+      return unless @component_dsl.nil?
+  
+      component_dsl = ComponentDsl.new(@topdsl)
+      component_dsl.instance_eval(&@proc)
+  
+      @inputs = []
+      component_dsl.inputs.each do |k,v|
+        @inputs << v
+      end
+  
+      @outputs = []
+      component_dsl.outputs.each do |k,v|
+        @outputs << v
+      end
+  
+      @wires = []
+      component_dsl.wires.each do |k,v|
+        @wires << v
+      end
+  
+      @comb_block_dsl = component_dsl.comb_block_dsl
+  
+      check!(component_dsl)
+  
+      @component_dsl = component_dsl
+    end
+  
+    def check!(component_dsl)
+      cc = CheckContext.new
+      component_dsl.inputs.each do |k,v|
+        cc.add_input_variable(k, v)
+      end
+  
+      component_dsl.outputs.each do |k,v|
+        cc.add_output_variable(k, v)
+      end
+  
+      component_dsl.wires.each do |k,v|
+        cc.add_wire_variable(k, v)
+      end
+  
+  
+      component_dsl.comb_block_dsl.statements.each do |s|
+        s.check!(cc)
+      end
+
+      cc.fanout_check!
+    end
+  
+  end
+end

data/lib/rhdl/component_dsl.rb

@@ -0,0 +1,32 @@
+module Rhdl
+  class ComponentDsl
+    attr_reader :inputs, :outputs, :wires, :comb_block_dsl
+  
+    def initialize(topdsl)
+      @topdsl = topdsl
+      @inputs = {}
+      @outputs = {}
+      @wires = {}
+      @comb_block_dsl = nil
+    end
+  
+    def input(name, bits: 1, type: "uint")
+      @inputs[name] = NodeStatement.new('input', name, bits: bits, type: type)
+    end
+  
+    def output(name, bits: 1, type: "uint")
+      @outputs[name] = NodeStatement.new('output', name, bits: bits, type: type)
+    end
+
+    def wire(name, bits: 1, type: "uint")
+      @wires[name] = NodeStatement.new('wire', name, bits: bits, type: type)
+    end
+  
+    def comb(&block)
+      raise "Combinational block already defined" if !@comb_block_dsl.nil?
+  
+      @comb_block_dsl = BlockDsl.new
+      @comb_block_dsl.instance_eval(&block)
+    end
+  end
+end

data/lib/rhdl/data_type.rb

@@ -0,0 +1,30 @@
+module Rhdl
+  class DataType
+    attr_reader :name, :bits, :parent
+  
+    def initialize(name, bits, parent)
+      @name = name
+      @bits = bits
+      @parent = parent
+    end
+  
+    def with_bits(bits)
+      DataType.new(@name, bits, parent)
+    end
+  
+    def ==(other)
+      name == other.name && bits == other.bits
+    end
+  
+    def is_equal_or_child_of(other)
+      return false if parent.nil?
+      return true if other == self
+  
+      parent.is_equal_or_child_of(other)
+    end
+  
+    def to_s
+      "#{@name}_#{@bits}"
+    end
+  end
+end

data/lib/rhdl/expression.rb

@@ -0,0 +1,27 @@
+module Rhdl
+  class Expression
+    def varnames
+      []
+    end
+  
+    def &(rhs)
+      BinOp.new(self, rhs, "&")
+    end
+  
+    def !()
+      UnOp.new(self, "!")
+    end
+  
+    def generate
+      "<notimpl>"
+    end
+
+    def fanout(check_context, statement)
+      raise "fanout(check_context, statement) not implemented"
+    end
+  
+    def get_output_type(check_context)
+      raise "get_output_type(check_context) not implemented"
+    end
+  end
+end

data/lib/rhdl/gen_config.rb

@@ -0,0 +1,5 @@
+module Rhdl
+  class GenConfig
+    attr_accessor :top_module_name
+  end
+end

data/lib/rhdl/module_generator.rb

@@ -0,0 +1,89 @@
+module Rhdl
+  class ModuleGenerator
+    attr_reader :module_name, :component
+  
+    def initialize(module_name, component)
+      @module_name = module_name
+      @component = component
+    end
+  
+    def maxlens
+      @maxlens ||= begin
+        res = {}
+        params.each do |paraminfo|
+          paraminfo.each do |key, val|
+            res[key] ||= 0
+            len = (val&.length || 0)
+            if res[key] < len
+              res[key] = len
+            end
+          end
+        end
+  
+        res
+      end
+    end
+  
+    def params
+      @params ||= [] +
+        component.inputs.map{|x| x.generate_terms} +
+        component.outputs.map{|x| x.generate_terms}
+    end
+  
+    def params_arr
+      @params_arr ||= begin
+        res = []
+        params.each do |paraminfo|
+          arr = []
+          paraminfo.each do |key, val|
+            if val.nil?
+              arr << "".ljust(maxlens[key])
+              next
+            end
+  
+            arr << val.ljust(maxlens[key])
+          end
+          res << "  #{arr.join(' ')}"
+        end
+        res
+      end
+    end
+  
+    def params_stmt
+      @params_stmt ||= params_arr.join(",\n")
+    end
+  
+    def comb_block
+      @comb_block ||= component.
+        comb_block_dsl.
+        statements.
+        map{|x| x.generate}.flatten.map{|x| "  #{x}"}.
+        join("\n")
+    end
+
+    def wire_list
+      component.wires.map do |x|
+        terms = x.generate_terms
+        "reg #{terms[:bitterm]} #{terms[:name]}; // wire"
+      end.join("\n")
+    end
+  
+    def generate
+      result = <<~CONTENT
+        module #{module_name}
+        (
+        #{params_stmt}
+        );
+        #{wire_list}
+        always @(*) begin
+        #{comb_block}
+        end
+  
+        endmodule
+  
+      CONTENT
+  
+      result
+    end
+  end
+end

data/lib/rhdl/node_statement.rb

@@ -0,0 +1,37 @@
+module Rhdl
+  class NodeStatement
+    attr_reader :ptype, :bits, :name, :type
+  
+    def initialize(ptype ,name, bits:, type:)
+      @ptype = ptype
+      @name = name
+      @bits = bits
+      @type = type
+    end
+  
+    def theptype
+      if @ptype == 'input'
+        "input wire"
+      else
+        "output reg"
+      end
+    end
+  
+    def generate_terms
+      {
+        keyword: theptype,
+        bitterm: bitterm,
+        name:    name
+      }
+    end
+  
+  
+    def bitterm
+      if bits == 1
+        nil
+      else
+        "[#{bits-1}:0]"
+      end
+    end
+  end
+end

data/lib/rhdl/statement.rb

@@ -0,0 +1,10 @@
+module Rhdl
+  class Statement
+    def check!(check_context)
+      raise "check not implemented"
+    end
+  
+    def generate
+    end
+  end
+end

data/lib/rhdl/top_dsl.rb

@@ -0,0 +1,17 @@
+module Rhdl
+  class TopDsl
+    attr_reader :contents
+    def initialize
+      @components = {}
+      @contents = {
+        components: @components
+      }
+    end
+
+    def component(name, &block)
+      raise "component '#{name}' already defined" if @components[name]
+      @components[name] = Component.new(name, self, Proc.new(&block))
+
+    end
+  end
+end

data/lib/rhdl/un_op.rb

@@ -0,0 +1,34 @@
+module Rhdl
+  class UnOp < Expression
+    def initialize(lhs, op)
+      @lhs = lhs
+      @op = op
+    end
+  
+    def varnames
+      @lhs.varnames
+    end
+  
+    def generate
+      "!(#{@lhs.generate})"
+    end
+  
+    def fanout(check_context, statement)
+      @lhs.fanout(check_context, statement)
+    end
+  
+    def get_output_type(check_context)
+      ltype = @lhs.get_output_type(check_context)
+      if @op == "!"
+  
+        if ltype.to_s != "uint_1"
+           raise "& does not support types #{ltype}"
+        end
+  
+        return ltype
+      else
+        raise "unknown operation '#{op}'"
+      end
+    end
+  end
+end

data/lib/rhdl/variable.rb

@@ -0,0 +1,30 @@
+module Rhdl
+  class Variable < Expression
+    def initialize(name, owner)
+      @name = name.to_s
+      @owner = owner
+    end
+  
+    def <=(rhs)
+      @owner.add_assign_statement(@name, rhs)
+      nil
+    end
+  
+    def varnames
+      [@name]
+    end
+  
+    def generate
+      "#{@name}"
+    end
+  
+    def get_output_type(check_context)
+      check_context.get_var_type(@name)
+    end
+
+    def fanout(check_context, statement)
+      check_context.notify_fanout(@name, statement)
+    end
+
+  end
+end

data/lib/rhdl/verilog_generator.rb

@@ -0,0 +1,14 @@
+module Rhdl
+  class VerilogGenerator
+    def initialize(dsl, config)
+      @dsl = dsl
+      @config = config
+    end
+  
+    def generate_module(module_name)
+      thing = @dsl.contents[:components][module_name]
+  
+      ModuleGenerator.new(module_name, thing).generate
+    end
+  end
+end

data/lib/rhdl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rhdl
+  VERSION = '0.1.0'
+end

data/lib/rhdl.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rhdl/version'
+require 'rhdl/top_dsl.rb'
+require 'rhdl/component.rb'
+require 'rhdl/data_type.rb'
+require 'rhdl/check_context.rb'
+require 'rhdl/node_statement.rb'
+require 'rhdl/expression.rb'
+require 'rhdl/un_op.rb'
+require 'rhdl/bin_op.rb'
+require 'rhdl/variable.rb'
+require 'rhdl/statement.rb'
+require 'rhdl/assign_statement.rb'
+require 'rhdl/block_dsl.rb'
+require 'rhdl/component_dsl.rb'
+require 'rhdl/gen_config.rb'
+require 'rhdl/module_generator.rb'
+require 'rhdl/verilog_generator.rb'
+
+module Rhdl
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/rhdl.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rhdl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rhdl'
+  spec.version       = Rhdl::VERSION
+  spec.authors       = ['David Siaw']
+  spec.email         = ['874280+davidsiaw@users.noreply.github.com']
+
+  spec.summary       = 'Rhdl summary'
+  spec.description   = 'Rhdl description'
+  spec.homepage      = 'https://github.com/davidsiaw/rhdl'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/davidsiaw/rhdl'
+  spec.metadata['changelog_uri'] = 'https://github.com/davidsiaw/rhdl'
+
+  spec.files         = Dir['{exe,data,lib}/**/*'] + %w[Gemfile rhdl.gemspec]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rhdl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Siaw
+bindir: exe
+cert_chain: []
+date: 2025-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rhdl description
+email:
+- 874280+davidsiaw@users.noreply.github.com
+executables:
+- rhdl
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- data/README.md
+- exe/rhdl
+- lib/rhdl.rb
+- lib/rhdl/assign_statement.rb
+- lib/rhdl/bin_op.rb
+- lib/rhdl/block_dsl.rb
+- lib/rhdl/check_context.rb
+- lib/rhdl/component.rb
+- lib/rhdl/component_dsl.rb
+- lib/rhdl/data_type.rb
+- lib/rhdl/expression.rb
+- lib/rhdl/gen_config.rb
+- lib/rhdl/module_generator.rb
+- lib/rhdl/node_statement.rb
+- lib/rhdl/statement.rb
+- lib/rhdl/top_dsl.rb
+- lib/rhdl/un_op.rb
+- lib/rhdl/variable.rb
+- lib/rhdl/verilog_generator.rb
+- lib/rhdl/version.rb
+- rhdl.gemspec
+homepage: https://github.com/davidsiaw/rhdl
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/davidsiaw/rhdl
+  source_code_uri: https://github.com/davidsiaw/rhdl
+  changelog_uri: https://github.com/davidsiaw/rhdl
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rhdl summary
+test_files: []