###############################################################
|
###############################################################
|
#
|
#
|
# File: core_def.rb
|
# File: core_def.rb
|
#
|
#
|
# Author: Christian Hättich
|
# Author: Christian Hättich
|
#
|
#
|
# Project: System-On-Chip Maker
|
# Project: System-On-Chip Maker
|
#
|
#
|
# Target: Linux / Windows / Mac
|
# Target: Linux / Windows / Mac
|
#
|
#
|
# Language: ruby
|
# Language: ruby
|
#
|
#
|
#
|
#
|
###############################################################
|
###############################################################
|
#
|
#
|
#
|
#
|
# Copyright (C) 2014 Christian Hättich - feddischson [ at ] opencores.org
|
# Copyright (C) 2014 Christian Hättich - feddischson [ at ] opencores.org
|
#
|
#
|
# This program is free software: you can redistribute it and/or modify
|
# 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
|
# it under the terms of the GNU General Public License as published by
|
# the Free Software Foundation, either version 3 of the License, or
|
# the Free Software Foundation, either version 3 of the License, or
|
# (at your option) any later version.
|
# (at your option) any later version.
|
#
|
#
|
# This program is distributed in the hope that it will be useful,
|
# This program is distributed in the hope that it will be useful,
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
# GNU General Public License for more details.
|
# GNU General Public License for more details.
|
#
|
#
|
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
# along with this program. If not, see .
|
# along with this program. If not, see .
|
#
|
#
|
#
|
#
|
###############################################################
|
###############################################################
|
#
|
#
|
# Description:
|
# Description:
|
#
|
#
|
########
|
########
|
#
|
|
# TODO
|
|
#
|
|
#
|
|
###############################################################
|
|
|
|
|
|
module SOCMaker
|
module SOCMaker
|
|
|
|
|
#########
|
#########
|
#
|
#
|
# This class represents a core definition.
|
# This class represents a core definition.
|
# It is one of the central classes and holds data,
|
# It is one of the central classes and holds data,
|
# which is used to describe and instanciate this core.
|
# which is used to describe and instanciate this core.
|
# In general, instances of this class desribe a core,
|
# In general, instances of this class desribe a core,
|
# it's interface and parameters as well as the files,
|
# it's interface and parameters as well as the files,
|
# which are required for synthesis/simulation.
|
# which are required for synthesis/simulation.
|
#
|
#
|
# In addition to this core, there exist SOCMaker::CoreInst,
|
# In addition to this core, there exist SOCMaker::CoreInst,
|
# which represents a concret instanciation of a definition.
|
# which represents a concret instanciation of a definition.
|
#
|
#
|
class CoreDef < Component
|
class CoreDef < Component
|
include ERR
|
include ERR
|
include YAML_EXT
|
include YAML_EXT
|
|
|
attr_accessor :hdlfiles
|
attr_accessor :hdlfiles
|
|
|
|
|
def initialize( name, version, hdl_files, toplevel, optional = {} )
|
#
|
|
# Constructor
|
|
# The four attributes are required, and all other attributes
|
|
# can be given as a optinal hash
|
|
#
|
|
# *name*:: Name of this component
|
|
# *id*:: Id of this component
|
|
# *hdl_files*:: Hash of HDL files
|
|
# *toplevel*:: Toplevel name
|
|
# *optional*:: Non-mandatory values, which can be set during initialization.
|
|
#
|
|
#
|
|
def initialize( name, id, hdl_files, toplevel, optional = {} )
|
init_with( { 'name' => name,
|
init_with( { 'name' => name,
|
'version' => version,
|
'id' => id,
|
'hdlfiles' => hdl_files,
|
'hdlfiles' => hdl_files,
|
'toplevel' => toplevel }.merge( optional ) )
|
'toplevel' => toplevel }.merge( optional ) )
|
end
|
end
|
|
|
|
#
|
|
# Encoder function (to yaml)
|
|
#
|
|
# +coder+:: An instance of the Psych::Coder to encode this class to a YAML file
|
|
#
|
def encode_with( coder )
|
def encode_with( coder )
|
super coder
|
super coder
|
coder[ 'hdlfiles' ] = @hdlfiles
|
coder[ 'hdlfiles' ] = @hdlfiles
|
end
|
end
|
|
|
|
#
|
|
# Initialization function (from yaml)
|
|
#
|
|
# +coder+:: An instance of the Psych::Coder to init this class from a YAML file
|
|
#
|
|
#
|
def init_with( coder )
|
def init_with( coder )
|
super( coder )
|
super( coder )
|
|
|
@hdlfiles = coder[ 'hdlfiles' ] || {}
|
@hdlfiles = coder[ 'hdlfiles' ] || {}
|
serr_if( !@hdlfiles.is_a?( Hash ),
|
serr_if( !@hdlfiles.is_a?( Hash ),
|
'HDL file def. != Hash',
|
'HDL file def. != Hash',
|
instance: @name,
|
instance: @name,
|
field: 'hdlfiles' )
|
field: 'hdlfiles' )
|
|
|
@hdlfiles.each do |file_name, defn |
|
@hdlfiles.each do |file_name, defn |
|
serr_if( defn == nil,
|
serr_if( defn == nil,
|
'HDL file not defined',
|
'HDL file not defined',
|
instance: @name+":"+file_name.to_s )
|
instance: @name+":"+file_name.to_s )
|
|
|
serr_if( !defn.is_a?( SOCMaker::HDLFile ),
|
serr_if( !defn.is_a?( SOCMaker::HDLFile ),
|
'HDL file not SOCMaker::HDLFile (use SOCM_HDL_FILE)',
|
'HDL file not SOCMaker::HDLFile (use SOCM_HDL_FILE)',
|
instance: @name+":"+file_name.to_s )
|
instance: @name+":"+file_name.to_s )
|
end
|
end
|
|
|
end
|
end
|
|
|
|
|
|
|
|
#
|
|
# Loop over all generic values of the core
|
|
# and yield the block with the
|
|
# - generic name
|
|
# - generic type
|
|
# - the default value
|
|
# - is-last value
|
|
#
|
|
#
|
def generics
|
def generics
|
@inst_parameters.each_with_index do |(name, val), i|
|
@inst_parameters.each_with_index do |(name, val), i|
|
yield( name.to_s, val.type, val.default, i == @inst_parameters.size-1 )
|
yield( name.to_s, val.type, val.default, i == @inst_parameters.size-1 )
|
end
|
end
|
end
|
end
|
|
|
|
|
|
#
|
# this is a core_def and doesn't have
|
# this is a core_def and doesn't have
|
# sub-cores
|
# sub-cores
|
def get_core_def( inst )
|
def get_core_def( inst )
|
|
perr_if( nil, "We don't have sub-cores" )
|
return nil
|
return nil
|
end
|
end
|
|
|
|
|
|
#
|
|
# Nothing implemented, yet.
|
|
#
|
def consistency_check
|
def consistency_check
|
super
|
super
|
end
|
end
|
|
|
|
|
def param_ok?( param_name, param_value )
|
#
|
param = inst_parameters[ param_name.to_sym ]
|
# Equality operator
|
param = static_parameters[ param_name.to_sym ] if param == nil
|
#
|
return false if param == nil
|
|
end
|
|
|
|
|
|
def ==(o)
|
def ==(o)
|
o.class == self.class &&
|
o.class == self.class &&
|
o.hdlfiles == self.hdlfiles &&
|
o.hdlfiles == self.hdlfiles &&
|
super( o )
|
super( o )
|
end
|
end
|
|
|
|
#
|
|
# Returns a string describing this instance
|
|
#
|
|
def to_s
|
|
super
|
|
end
|
|
|
|
|
end # class CoreDef
|
end # class CoreDef
|
end # module SOCMaker
|
end # module SOCMaker
|
|
|
|
|
# vim: noai:ts=2:sw=2
|
# vim: noai:ts=2:sw=2
|
|
|
