soc_maker 0.1.1

data/lib/soc_maker/conf.rb

@@ -0,0 +1,310 @@
+###############################################################
+#   
+#  File:      conf.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 holds all the configuration and is 
+# realized as singleton.
+# The instance can be accessed via Conf.instance
+# The configuration is splitted into two parts:
+# - @data     -> user-configurable 
+# - @data_ro  -> read-only
+#
+# Examples:
+#  c = Conf.instance
+#  c[ :app_nam ]   # SOC-Maker
+#  c[ :build_dir ] # build
+#
+#
+#
+class Conf
+  include YAML_EXT 
+  include ERR
+
+  #
+  # Config file path. This is fixed and can't be modified.
+  # 
+  @@conf_file_path = 'socm_conf.yaml'
+
+
+
+  #
+  # new is private to ensure singleton behaviour
+  #
+  private_class_method :new
+
+  #
+  # Method to access the singleton instance:
+  # Within the first call,  this method tries to load the config from 
+  # the file. If the file doesn exist, a new instance is created.
+  # 
+  # *return*:: the config instance
+  #
+  def Conf.instance
+    if @@inst == nil
+      if File.file?( @@conf_file_path )
+        @@inst = YAML::load_file( @@conf_file_path )
+      else
+        @@inst = new 
+      end
+    end
+    return @@inst
+  end
+
+  # 
+  # Method to write the config to the file system
+  #
+  def Conf.write
+    File.open( 'socm_conf.yaml', 'w' ) { |f| f.write( @@inst.to_yaml  ) }
+  end
+
+  #
+  # Private constructor: it initializes all data
+  #
+  def initialize( )
+
+
+      init_with( { 'data' => {
+
+        # array of core search paths
+        :cores_search_path => [ './' ],
+
+        # VHDL include directive
+        :vhdl_include     => "library ieee;\nuse ieee.std_logic_1164.ALL;",
+
+        # build directory, where the whole synthese and build process 
+        # happens
+        :build_dir        =>  'build',
+
+        # the folder inside build_dir, where all the vhdl source is placed
+        :hdl_dir          =>  'hdl',
+
+        # synthesis directory inside build_dir
+        :syn_dir          =>  'syn',
+
+        # simulation directory inside build_dir
+        :sim_dir          =>  'sim'
+
+        } } )
+  end
+
+  # 
+  # Encoder function (to yaml)
+  #
+  # +coder+:: An instance of the Psych::Coder to encode this class to a YAML file
+  #
+  def encode_with( coder )
+    puts "ENCODE_WITH CALLED"
+    init_error_if !coder.is_a?( Psych::Coder ), 
+                'coder is not given as Psych::Coder'
+    coder[ 'data' ] = @data
+  end
+
+  #
+  # Initialization function (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 configuration data provided",
+      field: 'data' if coder[ 'data' ] == nil
+
+    @data = coder[ 'data' ]
+
+    %w[ vhdl_include 
+        build_dir hdl_dir
+        syn_dir sim_dir ].each do |d|
+      raise InitError.new( 
+        "Data field '#{d}' is not provided",
+        field: 'data' ) if @data[ d.to_sym ] == nil
+
+      raise InitError.new( 
+        "Data field '#{d}' is not of type String",
+        field: 'data' ) if !@data[ d.to_sym ].is_a?( String )
+
+      raise InitError.new( 
+        "Data field '#{d}' is not of type String",
+        field: 'data' ) if @data[ d.to_sym ].size == 0
+    end
+
+
+    @data_ro = { 
+
+      # the name of this application/tool
+      :app_name         => 'SOC-Maker',
+
+      # the name of the tool's commandline interface
+      :app_cli_name     => 'SOC-Maker CLI',
+
+
+      # All classes, which can be loaded by this software
+      :yaml_classes     => [  SOCMaker::CoreDef, 
+                              SOCMaker::SOCDef, 
+                              SOCMaker::IfcSpc, 
+                              SOCMaker::LibInc, 
+                              SOCMaker::Conf, 
+                              SOCMaker::CoreInst ],
+
+      # Regular expression, which is evaluatted to detect values like
+      #    eval function_name
+      # The function_name is used for further processing
+      :eval_regex       =>  /eval +([a-zA-Z_1-9]+)/,
+
+      # Regular expression to check, if it is VHDL or verilog
+      :hdl_type_regex   => /(\bvhdl\b)|(\bverilog\b)/,
+
+      #
+      # Regular expression for vhdl file detection 
+      #
+      :vhdl_file_regex    =>  /\A\S+\.vhd\Z/,
+
+      #
+      # Regular expression for verilog file detection
+      #
+      :verilog_file_regex =>  /\A\S+\.v\Z/,
+
+
+      #
+      # Regular expression to match names starting with non-number
+      #
+      :length_regex     =>  /\A[^0-9]+.*\Z/,
+
+      #
+      # Regular expression to match a component's name (core-name or SOC-name)
+      # (Obsolete)
+      #
+      :name_regex       =>  /^[a-zA-Z]+[a-zA-Z0-9_\-]*$/,
+
+
+      :YPP_LUT          => {
+                /\bSOCM_CONF\b/     =>  '--- !ruby/object:SOCMaker::Conf',
+                /\bSOCM_CORE\b/     =>  '--- !ruby/object:SOCMaker::CoreDef',
+                /\bSOCM_SOC\b/      =>  '--- !ruby/object:SOCMaker::SOCDef',
+                /\bSOCM_IFC_SPC\b/  =>  '--- !ruby/object:SOCMaker::IfcSpc',
+                /\bSOCM_INCLUDE\b/  =>  '--- !ruby/object:SOCMaker::LibInc',
+                /\bSOCM_INST\b/     =>  '!ruby/object:SOCMaker::CoreInst',
+                /\bSOCM_IFC\b/      =>  '!ruby/object:SOCMaker::IfcDef',
+                /\bSOCM_PORT\b/     =>  '!ruby/object:SOCMaker::IfcPort',
+                /\bSOCM_HDL_FILE\b/ =>  '!ruby/object:SOCMaker::HDLFile',
+                /\bSOCM_PARAM\b/    =>  '!ruby/object:SOCMaker::Parameter',
+                /\bSOCM_SPARAM\b/   =>  '!ruby/object:SOCMaker::SParameter',
+                /\bSOCM_SENTRY\b/   =>  '!ruby/object:SOCMaker::SParameterEntry'
+              },
+      #
+      # $1 provides the white spaces
+      # $2 the name
+      #
+      :YPP_INV_REGEX      => /(\s)*-{0,3}\s*!ruby\/object:SOCMaker::([a-zA-Z]+)/,  
+
+      :YPP_INV_LUT        => {
+                'Conf'            => 'SOCM_CONF',
+                'CoreDef'         => 'SOCM_CORE',
+                'SOCDef'          => 'SOCM_SOC',
+                'CoreInst'        => 'SOCM_INST',
+                'IfcSpc'          => 'SOCM_IFC_SPC',
+                'IfcDef'          => 'SOCM_IFC',
+                'IfcPort'         => 'SOCM_PORT',
+                'HDLFile'         => 'SOCM_HDL_FILE',
+                'Parameter'       => 'SOCM_PARAM',
+                'SParameter'      => 'SOCM_SPARAM',
+                'SParameterEntry' => 'SOCM_SENTRY',
+                'LibInc'          => 'SOCM_INCLUDE'
+              },
+
+      # used to split yaml files 
+      #
+      :YPP_SPLIT_REGEX    => /^\s*---\s*!ruby\/(object|object):SOCMaker/,
+
+
+      :COMMENT_REGEX      => /([^#]*)(#.*)?/,
+
+      :EMPTY_CMD_REGEX    => /(\s*)(.*)/,
+
+      :LIC =>        
+"""
+Copyright (C) 2014  Christian Haettich  - 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/>.
+"""
+
+
+    }
+  end
+
+  # 
+  # Read access via array operator: 
+  # config from @data and @data_ro can be accessed.
+  #
+  def [](y)
+    @data.merge( @data_ro )[y]
+  end
+
+  #
+  # Write access via array operator:
+  # config from @data can be accessed, @data_ro not.
+  #
+  def []=(y, value)
+    @data[y] = value if @data.has_key?( y )
+  end
+
+  #
+  # The singleton instance. It is initialized by the first 
+  # Conf::instance mehtod call.
+  #
+  @@inst = nil 
+
+end
+
+end 
+
+
+# vim: noai:ts=2:sw=2

data/lib/soc_maker/core_def.rb

@@ -0,0 +1,579 @@
+###############################################################
+#   
+#  File:      core_def.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 a core definition.
+# It is one of the central classes and holds data,
+# which is used to describe and instanciate a IP core.
+# In general, instances of this class desribe a core,
+# it's interface and parameters as well as the files,
+# which are required for synthesis/simulation.
+#
+# In addition to this core, there exist SOCMaker::CoreInst,
+# which represents a concret instanciation of a definition.
+#
+class CoreDef 
+  include ERR
+  include YAML_EXT
+
+
+  # name of the core  (mandatory)
+  attr_accessor :name
+
+  # ID of the core  (mandatory, stored as hash key)
+  attr_accessor :id
+
+  # toplevel name (mandatory)
+  attr_accessor :toplevel
+
+  # description of this core
+  attr_accessor :description
+
+  # creation date
+  attr_accessor :date
+
+  # license of this core
+  attr_accessor :license
+
+  # location of the license file
+  attr_accessor :licensefile
+
+  # author of this core
+  attr_accessor :author
+
+  # author-mail of this core
+  attr_accessor :authormail
+
+  # a version control command, which is used to download the files
+  attr_accessor :vccmd
+
+  # interfaces which are implemented see SOCMaker::IfcSpc
+  attr_accessor :interfaces
+
+  # reserved and not implemented
+  attr_accessor :functions
+
+  # hash of instantiation parameters see SOCMaker::Parameter
+  attr_accessor :inst_parameters
+
+  # hash of static parameters see SOCMaker::SParameter
+  attr_accessor :static_parameters
+
+  # the ID, but withou commata and as string, can be used
+  # for creating paths and so on 
+  attr_accessor :id_clean
+
+  # Hash of SOCMaker::HDLFile
+  attr_accessor :hdlfiles 
+
+
+  #
+  # Constructor:
+  # the three attributes name, id and toplevel are required. All other attributes
+  # can be given as a optinal hash.
+  #
+  # +name+:: Name of this core (string)
+  # +id+:: Id of this core (string)
+  # +toplevel+:: Toplevel name of this core (string)
+  # +optional+:: Non-mandatory values, which can be set during initialization. 
+  #            
+  #
+  def initialize( name, id, toplevel, optional = {} )
+    init_with( { 'name'      => name, 
+                 'id'        => id, 
+                 'toplevel'  => toplevel }.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[ name description date license licensefile 
+        author authormail vccmd toplevel interfaces 
+        functions inst_parameters static_parameters hdlfiles ].
+          each { |v| coder[ v ] = instance_variable_get "@#{v}" }
+
+    coder[ "id" ] = @id.to_s
+  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'
+
+    @name     = coder[ 'name'     ]
+    @toplevel = coder[ 'toplevel' ]
+
+    # check name
+    init_error 'Name must be of type string',     field: 'name' if !@name.is_a?( String )
+    init_error 'Name is not defined (size == 0)', field: 'name' if @name.size  == 0
+
+    # check id
+    init_error 'Id must be of type string', 
+                  field: 'id' if !coder[ 'id' ].is_a?( String )
+
+    @id       = coder[ 'id'       ].to_sym
+
+    init_error 'Id not defined (size == 0)', 
+        instance: @name, 
+        field:    'id'        if @id.size == 0
+    @id_clean = coder[ 'id' ].split(',').join("_")
+
+
+
+
+
+    init_error "toplevel must be of type string",
+      instance: @name, 
+      field:    "toplevel"    if !@toplevel.is_a?( String )
+
+    init_error 'Toplevel not defined (size == 0 )',
+      instance: @name, 
+      field:    'toplevel'    if @toplevel.size  == 0
+
+
+
+
+    # set non-nil values
+    #  -> we don't need to check for nil in the rest of the 
+    #     processing
+    @description       = coder[ 'description'       ] || ""
+    @date              = coder[ 'date'              ] || ""
+    @license           = coder[ 'license'           ] || ""
+    @licensefile       = coder[ 'licensefile'       ] || ""
+    @author            = coder[ 'author'            ] || ""
+    @authormail        = coder[ 'authormail'        ] || ""
+    @vccmd             = coder[ 'vccmd'             ] || ""
+    @interfaces        = coder[ 'interfaces'        ] || {}
+    @functions         = coder[ 'functions'         ] || {}
+    @inst_parameters   = coder[ 'inst_parameters'   ] || {}
+    @static_parameters = coder[ 'static_parameters' ] || {}
+    @hdlfiles          = coder[ 'hdlfiles'          ] || {}
+
+
+    # ensure, that these fields are of type String
+    %w[ description date license licensefile 
+        author authormail vccmd ].each do |n|
+
+      init_error "#{n} must be of type String", 
+        instance: @name, 
+        field:    n               if !instance_variable_get( '@'+n ).is_a?( String )
+    end
+
+    # ensure, that these fields are of type Hash
+    %w[ interfaces inst_parameters
+        functions  static_parameters ].each do |n|
+      init_error "#{n} must be of type Hash", 
+          instance: @name, 
+          field:    n             if  !instance_variable_get( '@'+n ).is_a?( Hash )
+
+    end
+
+
+
+    # check interfaces
+    @interfaces.each do |ifc_name, ifc|
+      init_error 'Interface not defined', 
+            instance: @name,
+            interface: ifc_name   if ifc == nil
+
+      init_error 'Interface definition is not SOCMaker::IfcDef (please use SOCM_IFC)', 
+            instance:  @name,
+            interface: ifc_name   if  !ifc.is_a?( SOCMaker::IfcDef )
+    end
+
+    # check instance parameters
+    @inst_parameters.each do |name, param |
+
+      init_error  'Instance parameter not SOCMaker::Parameter (please use SOCM_PARAM)', 
+            instance: @name, 
+            parameter: name       if !param.is_a?( SOCMaker::Parameter )
+    end
+
+    # check instance parameters
+    @static_parameters.each do |name, sparam |
+
+      init_error 'Static parameter not SOCMaker::Parameter (please use SOCM_SPARAM)', 
+            instance: @name,
+            parameter: name       if !sparam.is_a?( SOCMaker::SParameter )
+    end
+
+
+    init_error  'HDL files argument is not of type Hash',
+      instance: @name, 
+      field:    'hdlfiles' if !@hdlfiles.is_a?( Hash )
+
+
+    # check hdl files
+    @hdlfiles.each do |file_name, file_info |
+
+      init_error 'HDL file not defined', 
+            instance:   @name,
+            filename:   file_name if file_info == nil
+
+      init_error 'HDL file is not of type SOCMaker::HDLFile (use SOCM_HDL_FILE)', 
+            instance: @name,
+            filename: file_name if !file_info.is_a?( SOCMaker::HDLFile )
+    end
+
+  end
+
+  #
+  # The directory name of this core (returns @id_clean)
+  #
+  def dir_name
+    @id_clean
+  end
+
+
+  #
+  # Method to get an interface specification, used
+  # by this core. The interface is identified by it's 
+  # name (within this core)
+  #
+  # +ifc_name+:: Interface name (within this core, not the ID)
+  # 
+  def ifc_specification( ifc_name )
+    SOCMaker::lib.get_ifc( @interfaces[ ifc_name ].id )
+  end
+
+
+  #
+  # Runs the Version Control System command via system(....)
+  #
+  def update_vcs
+    unless self.vccmd.nil? or @vccmd.size == 0
+      #puts"cd #{@dir} && #{@vccmd}" 
+      system( "cd #{@src_dir} && #{vccmd}" )
+    end
+  end  
+
+
+
+
+
+
+  #
+  # Runs a consistence check: 
+  # Iterate over all interfaces and check, if the interface is
+  # in the SOCMaker::Lib.
+  # The method also checks also, if the ports defined by this
+  # core is also defined in the interface.
+  #
+  def consistence_check
+    @interfaces.values.each_with_index do | ifc, i_ifc; ifc_spc|
+
+      # get interface definition
+      ifc_spc = SOCMaker::lib.get_ifc( ifc.id )
+
+
+
+      # check if all refereces (to the ports) exist
+      ifc.ports.each_with_index do |(port_name, port_def), i_port |
+        spc_ref      = port_def.spc_ref.to_sym
+        consistence_error_if( 
+            !ifc_spc.ports.has_key?( spc_ref ), 
+            "Can't find #{port_def} in" + 
+            "interface definition #{ifc_spc.name} ",
+            id: ifc_spc.id,
+            portname: port_name )
+      end
+
+
+      # check, if all mandatory ports are implemented by this interface
+      ifc_spc.ports.each do | port_name, port |
+        consistence_error_if( 
+            port[ :mandatory ] == true &&  
+            ifc.ports.select{ |key,port_def| port_def.spc_ref.to_sym == port_name }.size == 0,  
+          "Mandatory port #{port_name} is not implemented in interface #{ifc.name}",
+          port: port_name,
+          interface: ifc.name )
+      end
+
+    end
+
+  end
+
+
+
+
+
+  #
+  # Iterates over all generic values of this core
+  # and yield the call block with
+  # - generic name
+  # - generic type
+  # - generic default
+  # - is-last value
+  def generics
+    @inst_parameters.each_with_index do |(name, val), i|
+
+      _generic_name     = name.to_s
+      _generic_type     = val.type
+      _generic_default  = val.default
+      _is_last          = i == @inst_parameters.size-1
+      yield( _generic_name   , 
+             _generic_type   , 
+             _generic_default, 
+             _is_last         )
+
+    end
+  end
+
+
+
+  #
+  # Iterates over interface list (if no argument is given)
+  # or all specified interfaces.
+  # For each interface, all ports are processed.
+  # For each port within each interface, we lookup the port spc_ref
+  # and yield the call block with  
+  # - port-name 
+  # - port length
+  # - default value
+  # - the spec-reference
+  # - is-last value
+  # as argument
+  #
+  # An xor mechanism between port_dir and ifc=>dir is used
+  # to determine the direction of a port, for example:
+  # If the interface is declared as input (1) and a port is declared as input (1)
+  # the resulting direction will be an output 1^1 = 0.
+  # But if the overall interface direction is an output (0) and a port is declared 
+  # as input, the resulting direction will an input 0^1 = 1.
+  # This allows to define a port-direction in the interface definition, 
+  # and toggle the directions on core-definition level.
+  #
+  #
+  # +args+:: An optional list of interface names
+  def ports( *args )
+
+    if args.size == 0
+      ifc_sel = @interfaces
+    else
+      ifc_sel = @interfaces.select{ |k,v| args.include?( k.to_s ) }
+    end
+
+
+
+    ifc_sel.values.each_with_index do | ifc, i_ifc; ifc_spc|
+
+      # get interface specification
+      ifc_spc = SOCMaker::lib.get_ifc( ifc.id )
+
+      # loop over ports in this interface 
+      ifc.ports.each_with_index do |(port_name, port_def), i_port |
+
+        # the reference to the port in the definition
+        spc_ref      = port_def.spc_ref.to_sym
+
+        _port_name    = port_name.to_s
+        if ifc_spc.ports[ spc_ref ][:dir] != 2
+          _port_dir     = ifc_spc.ports[ spc_ref ][:dir] ^ ifc.dir
+        else
+          _port_dir     = 2
+        end
+        _port_length  = port_def.len
+        _port_default = ifc_spc.ports[ spc_ref ][ :default  ]
+        _is_last      = ( (i_port == ifc.ports.size-1 ) and (i_ifc == ifc_sel.size-1 ) )
+        yield(  _port_name, _port_dir, _port_length, _port_default, port_def.spc_ref, _is_last )
+      end
+    end
+  end
+
+  def add_interface( ifc_name, ifc_id, dir, ports )
+    processing_error_if( @interfaces.has_key?( ifc_name.to_sym ),
+        "Interface name #{ifc_name} already exist",
+        name: ifc_name,
+        id_to_add: ifc_id )
+    @interfaces[ ifc_name.to_sym ] = SOCMaker::IfcDef.new( ifc_name, ifc_id, dir, ports );
+
+  end
+
+
+  def core_definition( inst )
+    return nil;
+  end
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+
+    tmp    = ( o.class   == self.class )
+    return tmp if !tmp
+
+    %w[ name id description date license licensefile 
+        author authormail vccmd toplevel interfaces 
+        functions inst_parameters static_parameters hdlfiles ].
+          each do |v| 
+      return false if instance_variable_get( "@#{v}" ) != o.instance_variable_get( "@#{v}" )
+    end
+    return true
+  end
+
+  #
+  # Returns a string describing this instance
+  #
+  def to_s
+    "id:                #{@id}\n"              +
+    "toplevel:          #{@toplevel}\n"             +
+    "description:       #{@description}\n"          +
+    "date:              #{@date}\n"                 +
+    "license:           #{@license}\n"              +
+    "licensefile:       #{@licensefile}\n"          +
+    "author:            #{@author}\n"               +
+    "authormail:        #{@authormail}\n"           +
+    "vccmd:             #{@vccmd}\n"                +
+    "interfaces:        #{@interfaces}\n"           +
+    "functions:         #{@functions}\n"            +
+    "inst_parameters:   #{@inst_parameters}\n"      +
+    "static_parameters: #{@static_parameters}\n"
+  end
+
+
+
+  #
+  # Method, which counts the core occurence:
+  #
+  # +core_id_array+:: An array with id's, for example [ 'id1', 'id1', 'id2', 'id3' ]
+  # +return+:: A Hash with id => #ofOccurence mapping, for example { 'id1' => 2, 'id2' => 1, 'id3' => 1 }
+  #
+  def self.core_cnt( core_id_array )
+    cnt_hash = Hash.new( 0 )
+    core_id_array.each do |v|
+      cnt_hash[v] += 1
+    end
+    return cnt_hash
+  end
+
+
+
+  #
+  # Creates a core directory, if it doesn't exist.
+  # The path of the target directoy depends
+  # on SOCMaker::conf[ :build_dir ] and
+  # on SOCMaker::conf[ :hdl_dir ].
+  # The resulting path is
+  #     ./build_dir/hdl_dir/dir_name
+  #
+  # +dir_name+:: Name of the target directory
+  #
+  def self.get_and_ensure_dst_dir!( dir_name )
+      dst_dir =  File.expand_path(
+            File.join( 
+              SOCMaker::conf[ :build_dir ], 
+              SOCMaker::conf[ :hdl_dir   ],
+              dir_name ) )
+      FileUtils.mkdir_p dst_dir
+      return dst_dir
+  end
+
+
+
+
+  #
+  # This method is required to allow recursive static parameter
+  # collection. Because this is a sigle core and doesn't have sub-cores 
+  # (which might have some static parameters), an empty hash is returned.
+  #
+  def all_static_parameters
+    Hash.new()
+  end
+
+
+
+  #
+  # Method to deploy this core: all files are copied and deployed:
+  # - all hdl-files 
+  # - all files with static-parameters 
+  #
+  # +options+:: Optinal arguments: usually the static parameters are passed via
+  #             options[ :static ]
+  #
+  def deploy( options={} )
+    options = { static: {} }.merge( options )
+
+    # create destination directory name and ensure, that it is exist
+    dst_dir  = CoreDef::get_and_ensure_dst_dir!( dir_name )
+
+
+
+    # copy each file into destination dir
+    @hdlfiles.each do |file, val|
+      file_path = File.join( @src_dir, val.path )
+      dst_path = File.join( dst_dir, val.path )
+      SOCMaker::logger.proc( "copy #{file_path} to #{ dst_path} " )
+      FileUtils.mkdir_p(File.dirname(dst_path))
+      FileUtils.cp( file_path, dst_path )
+    end
+
+    # deploy all static-parameter files
+    @static_parameters.each do |file, sparam|
+      sparam.deploy( options[ :static ][ @id ], @src_dir, dst_dir )
+    end
+
+  end
+
+
+  # 
+  # This method is required to allow recursive search of all IDs
+  # and returns only it's ID (because there are no sub-cores).
+  #
+  def all_core_id
+    [ @id ]
+  end
+
+
+
+end # class CoreDef
+end # module SOCMaker
+
+
+
+# vim: noai:ts=2:sw=2