soc_maker 0.1.1

data/lib/soc_maker/sparameter.rb

@@ -0,0 +1,289 @@
+###############################################################
+#   
+#  File:      sparameter.rb
+#
+#  Author:    Christian Hättich
+#
+#  Project:   System-On-Chip Maker
+#
+#  Target:    Linux / Windows / Mac
+#
+#  Language:  ruby
+#
+#
+###############################################################
+#
+#
+#   Copyright (C) 2014  Christian Hättich  - feddischson [ at ] opencores.org
+#
+#   This program 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.
+#
+#   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#
+###############################################################
+#
+#   Description:
+#
+
+
+module SOCMaker
+
+
+
+# A small classes, used to group information
+# and to verify, auto-correct and auto-complete
+# this information:
+# This class represents a static parameter, which is
+# only defined once within a system. Usually, these
+# static parameters are mapped into a vhdl package or 
+# verilog include file.
+# The following fields are defined:
+# - #path (of the file, which is used as input)
+# - #file_dst (output file destination)
+# - #parameters (hash of SParameterEntry values)
+# At the moment, the token within the value of the parameter-hash 
+# is used as regular expression to replace this token 
+# in the input file by the key of the parameter-hash, and 
+# write the result to the destination file.
+#
+class SParameter 
+  include ERR
+
+
+  # Path of the file, which is used as input
+  attr_accessor :path
+
+  # Path of the destination file
+  attr_accessor :file_dst
+
+  # Hash of SParameterEntry, each entry represents a parameter
+  attr_accessor :parameters
+
+  # This constructor expects the source file path, the destination 
+  # file path. The paremters can be passed as optional arguments.
+  #
+  # +path+::      source file path
+  # +file_dst+::  destination file path
+  #
+  #
+  def initialize( path, file_dst, optional = {} )
+    init_with( { 'path' => path,
+                 'file_dst' => file_dst }.merge( optional ) )
+  end
+
+  # 
+  # Encoder method (to yaml)
+  #
+  # +coder+:: An instance of the Psych::Coder to encode this class to a YAML file
+  #
+  def encode_with( coder )
+    init_error_if !coder.is_a?( Psych::Coder ), 
+                'coder is not given as Psych::Coder'
+    %w[ path file_dst parameters ].
+          each { |v| coder[ v ] = instance_variable_get "@#{v}" }
+  end
+
+  #
+  # Initialization method (from yaml)
+  #
+  # +coder+:: An instance of the Psych::Coder to init this class from a YAML file
+  #
+  #
+  def init_with( coder )
+    init_error_if !( coder.is_a?( Hash ) || coder.is_a?( Psych::Coder ) ), 
+                'coder is not given as Hash neither as Psych::Coder'
+
+    # path
+    init_error 'no file path specified for static parameter',
+      field: 'path'  if coder[ 'path' ] == nil
+    @path = coder[ 'path' ]
+
+    init_error 'file path specified for static parameter is not of type string',
+      field: 'path' if !@path.is_a?( String )
+
+    init_error 'file path specified for static parameter has zero length',
+      field: 'path'  if @path.size == 0
+
+
+    # file_dst (file-destination)
+    init_error 'no destination file directory given for static parameter',
+      instance: @path,
+      field:    'file_dst' if coder[ 'file_dst' ] == nil
+
+    @file_dst = coder[ 'file_dst' ]
+    init_error 'destination file directory given for static parameter is not of type string',
+      instance: @path,
+      field:    'file_dst' if !@file_dst.is_a?( String )
+
+    init_error 'file path specified for static parameter has zero length',
+      field: 'path'  if @file_dst.size == 0
+
+
+    @parameters = coder[ 'parameters' ] || {}
+    @parameters.each do |name, param|
+      init_error 'Static parameter entry not defined',
+            instance: name if param == nil
+
+      init_error 'Static parameter entry not SOCMaker::SParameterEntry (use SOCM_SENTRY)', 
+            instance: name if !param.is_a?( SOCMaker::SParameterEntry )
+    end
+
+  end
+
+
+
+  #
+  # Deployment function. It takes the source file from core_dir,
+  # iterates over all parameters and checks, if the parameter is
+  # in avaliable in param. If not, the default value is taken.
+  # all parameters are added to the source file and the result
+  # is saved in dst_dir.
+  #
+  # +param+:: A parameter hash, like { :name => value }
+  # +core_dir:++ The core source directory, where the parameter source file is located
+  # +dst_dir+:: The destination directory, where the result is saved. This dir. must exist.
+  #
+  def deploy( param, core_dir, dst_dir )
+
+    token_val_map = {}
+    @parameters.each do |param_name,sparam_entry|
+
+      if  param               != nil and
+          param[ param_name ] != nil
+        # use value defined in soc-spec
+        tmp = param[ param_name ]
+      else
+        # use default value from core-spec
+        tmp =  sparam_entry.default
+      end
+
+      if sparam_entry.type == "enum"
+        token_val_map[ sparam_entry.token ] = sparam_entry.choice[ tmp.to_i ]
+      elsif sparam_entry.type == "bool"
+        if tmp == true
+          token_val_map[ sparam_entry.token ] = sparam_entry.choice
+        else
+          token_val_map[ sparam_entry.token ] = ""
+        end
+      else
+        token_val_map[ sparam_entry.token ] = tmp
+      end
+
+
+    end
+
+    # create file paths
+    src_path = File.join( core_dir, @path )
+    #dst_dir  = CoreDef::get_and_ensure_dst_dir!( dir_name )
+    dst_path = File.join( dst_dir, @file_dst )
+
+
+    # process each line of input file
+    # and replace tokens by value via 
+    # regular expression
+    File.open( dst_path, 'w' ) do |dst_f|
+      File.open( src_path ) do |src_f|
+        SOCMaker::logger.proc( "create #{dst_path} from #{ src_path} " )
+        while line = src_f.gets
+          token_val_map.each { |token, val| line = line.sub( Regexp.new( token.to_s  ), val.to_s ) }
+          dst_f.puts line
+        end
+      end
+    end
+
+  end
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.class == self.class               && 
+      o.parameters == self.parameters   &&
+      o.file_dst   == self.file_dst     &&
+      o.path       == self.path
+  end
+
+
+
+end
+
+
+#
+# This class is used to organize static parameters within SOCMaker::SParameter.
+# This class is derived from Parameter and adds the attribute 'token'.
+#
+class SParameterEntry < Parameter
+
+  #
+  # Token, which is replaced during generation by the parameter.
+  #
+  attr_accessor :token
+
+  # The constructor expects 
+  def initialize( type, token, optional = {} )
+    init_with( { 'type' => type,
+                 'token' => token }.merge( optional ) )
+
+  end
+
+  # 
+  # Encoder method (to yaml)
+  #
+  # +coder+:: An instance of the Psych::Coder to encode this class to a YAML file
+  #
+  def encode_with( coder )
+    init_error_if !coder.is_a?( Psych::Coder ), 
+                'coder is not given as Psych::Coder'
+    super coder
+    coder[ 'token' ] = @token
+  end
+
+  #
+  # Initialization method (from yaml)
+  #
+  # +coder+:: An instance of the Psych::Coder to init this class from a YAML file
+  #
+  #
+  def init_with( coder )
+
+    init_error_if !( coder.is_a?( Hash ) || coder.is_a?( Psych::Coder ) ), 
+                'coder is not given as Hash neither as Psych::Coder'
+    super coder
+
+    init_error 'no token specified',
+      field: token if coder[ 'token' ] == nil
+
+    @token = coder[ 'token' ]
+    init_error 'token is not a string' if !@token.is_a?( String )
+    init_error 'token has zero size'   if @token.size == 0 
+  end
+
+
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.class == self.class   &&
+    o.token  == self.token  &&
+    super( o )
+  end
+
+
+end
+end
+
+
+# vim: noai:ts=2:sw=2

data/lib/soc_maker/version.rb

@@ -0,0 +1,8 @@
+module SOCMaker
+
+  #
+  # The SoC-Maker Version
+  #
+  VERSION = "0.1.1"
+
+end

data/lib/soc_maker/ypp.rb

@@ -0,0 +1,130 @@
+###############################################################
+#   
+#  File:      ypp.rb
+#
+#  Author:    Christian Hättich
+#
+#  Project:   System-On-Chip Maker
+#
+#  Target:    Linux / Windows / Mac
+#
+#  Language:  ruby
+#
+#
+###############################################################
+#
+#
+#   Copyright (C) 2014  Christian Hättich  - feddischson [ at ] opencores.org
+#
+#   This program 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.
+#
+#   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+#
+###############################################################
+
+
+
+module SOCMaker
+
+
+#
+#
+# YAML Pre-Processor:
+# We use it only in a static way, no objects are created 
+# (private ctor).
+# There are two methods:
+# - SOCMaker::YPP::to_yaml( a_string )
+# - SOCMaker::YPP::from_yaml( a_string )
+#
+# The static method to_yaml replaces our custom tags (like SOCM_CORE)
+# with YAML object identifiers (like '--- ruby/object::SOCMaker::CoreDef')
+#
+# The static method from_yaml does the inverse to to_yaml: it replaces the 
+# object identifiers with our custom tags.
+#
+# See also SOCMaker::Conf YPP_LUT YPP_INV_LUT and YPP_INV_REGEX,
+# these are the lookup tables and regular expressions used for this 
+# processing
+#
+# Goal:
+# This is used to have a nicer YAML file and without the need of writing
+# loong object identifier lines.
+#
+#
+class YPP 
+
+  class << self
+
+
+    #
+    # This method does the pre-processing and 
+    # replaces our custom tags with yaml-tags, like
+    #   --- !ruby/object:SOCMaker:: ....
+    # In addition, if a block is given, the string 
+    # is separated into substrings and each sub-string is passed to
+    # the block. This allows to process YAML strings, which contain multiple
+    # objects. Each object is passed (as yaml string) to the block.
+    #
+    def to_yaml( string )
+
+      SOCMaker::conf[ :YPP_LUT ].each do |r, repl|
+        string = string.gsub r, repl
+      end
+      if block_given?
+        strings = split_with_match( string, SOCMaker::conf[ :YPP_SPLIT_REGEX ] ) if string != nil
+        strings.each{ |x| yield( x ) }
+      end
+      return string
+    end
+
+
+    #
+    # This method does the inverse to to_yaml.
+    #
+    def from_yaml( string )
+      string.gsub SOCMaker::conf[ :YPP_INV_REGEX ] do |words|
+
+         # if there is a white-space at the beginning ($1 != nil), we keep
+         # the white-space, if there is no white-space we won't keep it
+         ws = $1.nil? ? "" : " "
+         SOCMaker::conf[ :YPP_INV_LUT ].has_key?( $2 ) ?  ws + SOCMaker::conf[ :YPP_INV_LUT ][ $2 ] : words
+      end
+    end
+
+
+    #
+    # This method is used to split concatenated yaml object strings.
+    #
+    def split_with_match(string, regex)
+      indices = []
+      strings = []
+      return [] if string == nil or string.size == 0
+      string.scan( regex ) { |c| indices << $~.offset(0)[0] }
+      return [] if indices.size == 0
+      indices = [ indices, indices[ 1..-1].map{ |x| x-1 } << string.size-1 ]
+      indices[0].zip( indices[1] ).each{ |x| strings<< string[ x[0]..x[1] ] }
+      return strings
+    end
+
+
+  end
+
+  private
+  def initialize
+  end
+
+
+end # CoreDef
+end # SOCMaker
+
+# vim: noai:ts=2:sw=2

data/soc_maker.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "soc_maker/version"
+
+Gem::Specification.new do |s|
+  s.name        = "soc_maker"
+  s.version     = SOCMaker::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christian Haettich"]
+  s.email       = ["feddischson [ at ] opencores.org"]
+  s.homepage    = "https://github.com/feddischson/soc_maker"
+  s.summary     = %q{System-On-Chip Maker}
+  s.description = %q{System-On-Chip Maker: a tool to design and create SoCs in a simple way, written in Ruby. }
+  s.licenses    = ['LGPL-3.0']
+
+
+  s.add_development_dependency "rspec",      "~>3.2"
+  s.add_development_dependency "rspec-its",  "~>1.2"
+  s.add_development_dependency "bones",      "~>3.8"
+  s.add_development_dependency "simplecov",  "~>0.10"
+
+  s.required_ruby_version = '>=2.0.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end