soc_maker 0.1.1

data/lib/soc_maker/lib.rb

@@ -0,0 +1,289 @@
+###############################################################
+#   
+#  File:      spc_lib.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
+
+#
+# This class represents the IP core library, which holds all
+# - cores (core-definitions and SoC definitions)
+# - interfaces (interface-specifications)
+# 
+# The cores are stored in #cores_lib and the interfaces in 
+# #ifc_lib. Furthermore, a #path_lut is used to remmeber,
+# which folder-path has been processed. This is necessary to avoid
+# circular search during loading.
+# 
+class Lib
+  include ERR
+
+  #
+  # The constructor creates two empty hashes #cores_lib and
+  # #ifc_lib, and an empty list #path_lut.
+  #
+  def initialize
+
+    # will store all cores
+    @cores_lib      = {}
+
+    # will store all interfaces
+    @ifc_lib      = {}
+
+    # we remember paths, which we've already processed
+    @path_lut = []
+
+  end
+
+
+  #
+  # This method clears all three attributes of this class.
+  #
+  def clear
+    @cores_lib.clear
+    @ifc_lib.clear
+    @path_lut.clear
+  end
+
+
+  #
+  # Method to refresh / load  the core library:
+  # it useses the global configuration entry cores_search_path,
+  # which defines, where to search for inc_fname (defined in SOCMaker::Conf) files.
+  #
+  # Before start searching, clear is called to clear the library.
+  #
+  # For each directory, we call process_include. The method process_include
+  # takes care of proessing everything else recursively.
+  # 
+  #
+  # +paths+:: eiter a single path (as String) or multiple paths (as Array of strings)
+  #
+  def refresh( paths = nil )
+
+
+    paths = [ paths ] if paths.is_a?( String )
+
+
+    SOCMaker::logger.info  "START REFRESHING CORE LIBRARY"
+
+    # clear the libs
+    clear
+
+    # use argument if given, otherwise config paths
+    paths ||= SOCMaker::conf[ :cores_search_path ]
+
+
+    paths.each do |dir|
+      process_include dir
+    end
+    SOCMaker::logger.info  "DONE REFRESHING CORE LIBRARY"
+
+  end
+
+
+
+  #
+  # This method processes a directory, which needs to be included 
+  # into the search:
+  # It uses the method get_all_yaml_in_str to read all *.yaml
+  # files and processes each yaml-object.
+  # If there is a SOCMaker::LibInc object, all entries of this
+  # object are further processed with this method 
+  # (recursively, see add_include).
+  # 
+  # +dir+:: the directory path, which is processed
+  #
+  def process_include( dir )
+
+    #
+    # this prevents the revursive call
+    # from an infinite call
+    #
+    folder_sym = File.expand_path( dir ).to_sym
+    init_error_if  @path_lut.include?( folder_sym ), 
+        "double-include: infinite resursive search?" 
+    @path_lut << folder_sym
+
+    # get all yaml files in the directory
+    SOCMaker::logger.info  "search for include in: " + dir
+
+
+    SOCMaker::from_s( get_all_yaml_in_str( dir ) ) do |o|
+      o.src_dir = dir
+      case o
+      when SOCMaker::LibInc
+        add_include( o, dir )
+      when SOCMaker::SOCDef
+        add_core( o )
+      when SOCMaker::CoreDef
+        add_core( o )
+      when SOCMaker::IfcSpc
+        add_ifc( o )
+      else
+        raise SOCMaker::ERR::InitError.new( "Can't load object", object: o )
+      end
+    end
+
+  end
+
+
+  #
+  # Search for all *.yaml files and concatenate them.
+  #
+  # +result+:: the resulting string
+  #
+  def get_all_yaml_in_str( dir )
+    yaml_str = ""
+    Dir[ File.join( dir, "*.yaml" ) ].sort.each do |yaml_file|
+      SOCMaker::logger.info "reading:" + yaml_file
+      yaml_str << File.read( yaml_file )
+    end
+    return yaml_str
+  end
+
+
+
+  # gets an SOCMaker::LibInc object and iterates
+  # over all folders.
+  # Note: this is moved from process_include to this extra function
+  # to support test capability
+  def add_include( soc_inc_object, dir )
+    soc_inc_object.dirs.each { |d| process_include( File.expand_path( File.join( dir, d ) ) ) }
+  end
+
+
+  #
+  # Method to add an IP-Core object (SOCMaker::CoreDef) to this library
+  #
+  def add_core( core )
+    # save core
+    @cores_lib[ core.id ] = core
+
+    SOCMaker::logger.info  "loaded #{core.name}, id: #{core.id}"
+  end
+
+  #
+  # Method to access IP-Core objects (SOCMaker::CoreDef) of this library
+  #
+  def get_core( id )
+    tmp = @cores_lib[ id ]
+    processing_error "Core with id '#{id}' does not exist" if !tmp
+    return tmp
+  end
+
+  #
+  # Method to remove IP-Core objects (SOCMaker::CoreDef) from this library
+  #
+  def rm_core( arg )
+
+    if arg.is_a?( Symbol )
+      processing_error  "Core with id '#{arg}' does not exist"  if !@cores_lib[ arg ]
+      @cores_lib.delete( arg )
+
+    elsif arg.is_a?( SOCMaker::CoreDef )
+      processing_error "Core with id '#{arg.id}' does not exist" if !@cores_lib[ arg.id ]
+      @cores_lib.delete( arg.id )
+
+    else
+      raise SOCMaker::ERR::ProcessingError.new( "", "Can't remove core" )
+    end
+  end
+
+
+
+
+  #
+  # Method to add an IP-Core interface (SOCMaker::IfcSpc) to this library
+  #
+  def add_ifc( ifc )
+    @ifc_lib[ ifc.id ] = ifc
+  end
+
+  #
+  # Method to access an IP-Core interface (SOCMaker::IfcSpc) of this library
+  #
+  def get_ifc( id )
+    tmp = @ifc_lib[ id ]
+      processing_error  "Interface with id '#{id}' does not exist" if !tmp
+    return tmp
+  end
+
+  #
+  # Method to remove an IP-Core interface (SOCMaker::IfcSpc) from this library
+  #
+  def rm_ifc( arg )
+
+    if arg.is_a?( Symbol )
+      processing_error "Interface with id '#{arg}' does not exist" if !@ifc_lib[ arg ]
+      @ifc_lib.delete( arg )
+
+    elsif arg.is_a?( SOCMaker::IfcSpc )
+      processing_error "Interface with id '#{arg.id}' does not exist" if !@ifc_lib[ arg.id ]
+      @ifc_lib.delete( arg.id )
+
+    else
+      raise SOCMaker::ERR::ProcessingError.new( "", "Can't remove interface" )
+    end
+
+  end
+
+  #
+  # Function to represent this library as string:
+  # A list of IP-cores and interfaces is returned as string
+  #
+  def to_s
+      "IP-Core - lib: \n"             +
+      @cores_lib.keys.to_s            +
+      "\n\nIP-Interfaces - lib: \n"    +
+      @ifc_lib.keys.to_s              
+  end
+
+
+  #
+  # Iterates over all cores and yields the block with the id (as string)
+  # and the core.
+  #
+  def cores
+    @cores_lib.each do |id,core|
+      yield( id.to_s, core )
+    end
+  end
+
+
+  private :add_include, :get_all_yaml_in_str 
+
+end #class Lib
+end #Module SOCMaker
+
+#
+# vim: noai:ts=2:sw=2

data/lib/soc_maker/lib_inc.rb

@@ -0,0 +1,109 @@
+###############################################################
+#   
+#  File:      lib_inc.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
+
+
+#
+# A small class, which represents a library-include information.
+# The included directories are stored in @dirs
+#
+#
+#
+class LibInc
+  include ERR
+  include YAML_EXT
+
+  # the included directories
+  attr_accessor :dirs
+
+  #
+  # This constructor does nothing special. The directories can be passed
+  # via optional arguments
+  #
+  def initialize( opts = {} )
+    init_with( opts )
+  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[ dirs ].
+      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'
+
+    init_error 'no dirs are given' if coder[ 'dirs' ] == nil
+    @dirs = coder[ 'dirs' ] 
+
+    init_error 'dirs must be of type array' if  !@dirs.is_a?( Array )
+    init_error 'there must be at least one dir-entry' if @dirs.size == 0
+
+
+    @dirs.each do |f|
+      init_error  "The dir must be defined as string",
+        field: 'dirs' if !f.is_a?( String )
+
+      init_error "The path string has zero length",
+        field: 'dirs' if f.size == 0
+    end
+  end 
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.class == self.class && o.dirs == self.dirs
+  end
+
+end
+end
+
+# vim: noai:ts=2:sw=2
+
+

data/lib/soc_maker/parameter.rb

@@ -0,0 +1,149 @@
+###############################################################
+#   
+#  File:      parameter.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
+#
+#
+# A small classes, used to group information
+# and to verify, auto-correct and auto-complete
+# this information:
+# This class represents an instance parameter for 
+# a core with the following values:
+# - type (mandatory)
+# - default
+# - min
+# - max 
+# - visible 
+# - editable
+# - description
+# Most of the fields are reserved for future implementations.
+#
+class Parameter 
+  include ERR
+
+  # type of the parameter
+  attr_accessor :type
+
+  # default value
+  attr_accessor :default
+
+  # min value
+  attr_accessor :min
+
+  # max value
+  attr_accessor :max
+
+  # visibility
+  attr_accessor :visible
+
+  # editable flag
+  attr_accessor :editable
+
+  # description
+  attr_accessor :description
+
+  # choice: if type == 'enum', choice must be an array of choices
+  attr_accessor :choice
+
+  #
+  # This constructor expects only the type as mandatory parameter, 
+  # everything else can be passed as optional parameter.
+  #
+  def initialize( type, optional = {} )
+    init_with( { 'type' => type }.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[ type default min max
+        visible editable description ].
+          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'
+
+    init_error 'no parameter type specified',
+      field: "type" if coder[ 'type' ] == nil
+
+    @type = coder[ 'type' ]
+    init_error "Parameter type is not defined with string",
+      field: "parameter" if !@type.is_a?( String )
+
+    init_error "Parameter type string has zero length",
+      field: "parameter" if @type.size == 0
+
+    @default      = coder[ 'default'     ] || 0
+    @min          = coder[ 'min'         ] || 0
+    @max          = coder[ 'max'         ] || 0
+    @visible      = coder[ 'visible'     ] || true
+    @editable     = coder[ 'editable'    ] || false
+    @description  = coder[ 'description' ] || ''
+    @choice       = coder[ 'choice'      ] || []
+  end
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.class         == self.class       && 
+      o.type        == self.type        &&
+      o.default     == self.default     &&
+      o.min         == self.min         &&
+      o.max         == self.max         &&
+      o.visible     == self.visible     &&
+      o.editable    == self.editable    &&
+      o.description == self.description &&
+      o.choice      == self.choice
+  end
+
+
+end
+end
+