soc_maker 0.1.1

data/lib/soc_maker/ifc_def.rb

@@ -0,0 +1,193 @@
+###############################################################
+#   
+#  File:      ifc_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/>.
+#
+#
+###############################################################
+#
+#   Description:
+#
+
+module SOCMaker  
+
+# A small classes, used to group information
+# and to verify, auto-correct and auto-complete
+# this information:
+# The class represents an interface definition containing
+# - a #name of the interface (mandatory)
+# - an #id of the instance (mandatory)
+# - a #dir (direction) (mandatory)
+# - some #ports (hash of type SOCMaker::IfcPort, mandatory)
+#
+# Note: instances of this class are used withing core-definitions.
+# Different cores may use the same interface, but with a 
+# different naming of the ports. For this reason, the id
+# is used to identify, which interface specification (SOCMaker::IfcSpc)
+# is defined. The port-hash makes the relation between the core port-naming
+# and the IfcSpc port-naming.
+class IfcDef 
+  include ERR
+
+  # name of interface definition
+  attr_accessor :name
+
+  # direction 
+  attr_accessor :dir
+
+  # id of the interface specification
+  attr_accessor :id
+
+  # the port hash, containing the IfcPort instances
+  attr_accessor :ports
+
+  # The constructor expects a name, id, dir (direction) and ports as mandatory 
+  # arguments.
+  def initialize( name, id, dir, ports )
+    init_with( 'name'     => name,
+               'dir'      => dir,
+               'id'       => id,
+               'ports'    => ports )
+  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 dir ports ].
+          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
+    init_error 'no name defined for this interface',
+      field: 'name' if coder[ 'name' ] == nil
+
+    @name = coder[ 'name' ]
+
+    init_error 'Interface name is not defined as string', 
+      instance: @name,
+      field: 'name' if !@name.is_a?( String )
+
+
+    init_error "Name has zero length",
+        field: "name" if @name.size == 0
+
+    # id
+    init_error 'id is not given for interface',
+      instance: @name,
+      field:   'id' if coder[ 'id' ] == nil
+
+    init_error 'Interface id is not defined as string',
+      instance: @name,
+      field:    'id' if !coder[ 'id' ].is_a?( String )
+
+    init_error "Version has zero length",
+        field: "name" if coder[ 'id' ].size == 0
+
+
+    @id = coder[ 'id' ].to_sym
+
+
+    # ports
+    init_error "No ports are given for interface definition",
+      field: 'ports' if coder[ 'ports' ] == nil
+
+    @ports = coder[ 'ports' ]
+    init_error 'no ports are given for this interface', 
+      instance: @name,
+      field:    'ports' if !@ports.is_a?( Hash )  || @ports.size == 0
+
+    @ports.each do |name, port|
+      init_error 'no interface port found',
+        instance: @name + name.to_s,
+        field:    'ports' if port == nil
+
+
+      init_error 'Port is not of type SocMaker::IfcPort (use SOCM_PORT)',
+        instance: @name + name.to_s,
+        field:    'ports' if !port.is_a?( SOCMaker::IfcPort )
+
+    end
+
+    # direction
+    init_error  'Interface direction is not given',
+      instance: @name,
+      field:    'dir' if coder[ 'dir' ] == nil
+
+    @dir = coder[ 'dir' ]
+    init_error 'Interface direction must be 0 or 1',
+      instance: @name,
+      value: coder['dir' ],
+      field:    'dir' if @dir != 0 && @dir != 1
+
+
+
+  end
+
+  #
+  # Runs a consistence check: it ensures, that the port-reference is unique.
+  #
+  def consistence_check    
+    tmp = {}
+    ports.each {|k,v| tmp[v.spc_ref] = k}
+    consistence_error "The port reference must be unique",
+        name: @name if ports.size != tmp.size
+  end
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.class         == self.class       && 
+    o.name          == self.name        &&
+    o.dir           == self.dir         &&
+    o.id            == self.id     &&
+    o.ports         == self.ports       
+  end
+
+
+end # IFCDef
+end # SOCMaker

data/lib/soc_maker/ifc_port.rb

@@ -0,0 +1,133 @@
+###############################################################
+#   
+#  File:      ifc_port.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:
+# The class represents an interface port within 
+# SOCMaker::IfcDef.
+# It is used to make a relation between the naming
+# of SOCMaker::IfcDef and SOCMaker::IfcSpc.
+# The two data fiels are
+# - #spc_ref (mandatory: must be the name of the port, defined in IfcSpc)
+# - #len (optional, default is 1)
+#
+class IfcPort 
+  include ERR
+
+  #
+  # Used as reference to a port in SOCMaker::IfcSpc
+  #
+  attr_accessor :spc_ref
+
+  #
+  # Length of this port
+  #
+  attr_accessor :len
+
+
+  #
+  # Constructor, which expects #spc_ref and #len. Length has the default value 1.
+  #
+  def initialize( spc_ref, len = 1 )
+    init_with( 'spc_ref' => spc_ref,
+               'len'  => len )
+  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[ spc_ref len ].
+          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 relation to interface-definition is given for an interface port (nil)',
+      field: "spc_ref" if coder[ 'spc_ref' ] == nil
+    @spc_ref = coder[ 'spc_ref' ]
+
+    init_error 'Relation to interface definition is not of type string',
+      instance: @spc_ref.to_s,
+      field:    "spc_ref" if  !@spc_ref.is_a?( String )
+
+    init_error 'Relation to interface definition has zero length',
+      instance: @spc_ref.to_s,
+      field:    "spc_ref" if @spc_ref.size == 0
+
+    @len = coder[ 'len' ] || 1
+
+    init_error 'Length is not a fixnum',
+      instance: @spc_ref.to_s,
+      field:    "spc_ref" if !( @len.is_a?( Fixnum ) || @len.is_a?( String ) )
+  end
+
+
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.class   == self.class     && 
+    o.spc_ref == self.spc_ref   &&
+    o.len     == self.len 
+  end 
+
+
+end
+end

data/lib/soc_maker/ifc_spc.rb

@@ -0,0 +1,180 @@
+###############################################################
+#   
+#  File:      if_spec.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 an interface specification. It defines
+# the data flow of individual ports as well as how much
+# cores can be connected with this interface.
+#
+#
+class IfcSpc
+  include ERR
+  include YAML_EXT
+
+
+  # name of the interface specification
+  attr_accessor :name
+
+  # ID of the interface
+  attr_accessor :id
+
+  # Port hash
+  attr_accessor :ports
+
+  # Multiplicity definition, must be a array with two entries.
+  # Each entry must be >=0 or a '*'
+  attr_accessor :multiplicity
+
+  # This constructor expects a name and an id as mandatory arguments.
+  # Everything else can be given as optinal arguments.
+  # 
+  # +name+:: name of the interface specification
+  # +id+:: id of the interface specification
+  #
+  def initialize( name, id, optional = {} )
+    init_with( { 'name' => name, 
+                 'id' => id }.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 ports multiplicity ].
+          each { |v| coder[ v ] = instance_variable_get "@#{v}" }
+    coder[ "id" ] = @id.to_s
+  end
+
+  #
+  # Constructor:
+  # there is one mandatory attributes *type* and an optional one *params*.
+  #
+  # +type+::    The id of the core-definition, which is instanciated
+  # +params+::  Instanciation parameters
+  #
+  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 "Name is not defined",
+        field: "name" if coder[ 'name' ] == nil
+    @name = coder[ 'name' ]
+
+    init_error "Name is not defined as string",
+        field: "name" if !@name.is_a?( String )
+
+    init_error "Name has zero length",
+        field: "name" if @name.size == 0
+
+
+    init_error "Id is not defined",
+        field: "id"   if coder[ 'id' ] == nil
+
+    @id = coder[ 'id' ]
+    init_error "Version is not defined as string",
+      instance: @name,
+      field:    "id"  if !coder[ 'id' ].is_a?( String )
+
+    init_error "Version has zero length",
+        field: "name" if coder[ 'id' ].size == 0
+
+    @id = coder[ 'id' ].to_sym
+
+    @ports = coder[ 'ports' ] || {}
+    @ports.each do |pname, port| 
+
+      init_error "Port field must be organized as a hash",
+          instance: @name,
+          field: "ports" if !port.is_a?( Hash )
+
+      init_error "No port direction specified for #{pname}",
+        instance: @name,
+        field: "ports" if !port.has_key?( :dir )
+
+
+      init_error_if(  !port[ :dir ].is_a?( Fixnum ) ||
+                   ( port[ :dir ] != 0 && port[ :dir ] != 1 && port[ :dir ] != 2 ) ,
+               "Port direction value for #{pname} is neither 0 nor 1 nor 3",
+               instance: @name,
+               field:    "ports" )
+
+      port[ :mandatory ] = true if !port.has_key?( :mandatory )
+      port[ :default ]   ||= '0'
+
+    end
+
+    @multiplicity = coder[ 'multiplicity' ] || [ 1, 1 ]
+
+    init_error "multiplicity must contain exactly two entries " if @multiplicity.size != 2
+
+    @multiplicity.each do |m|
+      if !( m.is_a?( Fixnum ) && m >= 0 ||  m.is_a?( String ) && m == "*" )  
+        init_error "multiplicity must be a fixnum or the string '*'"
+      end
+    end
+
+  end
+
+  #
+  # Checks, if the number of connections for a direction is ok.
+  # +dir+:: direction (0 or 1)
+  # +n+:: number of desred connections
+  #
+  def n_connections_ok?( dir, n )
+    if @multiplicity[ dir ].is_a?( String ) && @multiplicity[ dir ] == "*"
+      return true
+    else
+      return @multiplicity[ dir ] >=  n
+    end
+  end
+
+  #
+  # Equality operator
+  #
+  def ==(o)
+    o.name                  == self.name                  && 
+    o.id                    == self.id                    &&
+    o.ports.to_yaml         == self.ports.to_yaml         &&
+    o.multiplicity.to_yaml  == self.multiplicity.to_yaml  
+  end
+end
+end
+
+
+# vim: noai:ts=2:sw=2