soc_maker 0.1.1

data/spec/soc_maker_spec.rb

@@ -0,0 +1,7 @@
+require_relative( 'spec_helper' )
+describe SOCMaker do
+
+
+
+end
+

data/spec/sparameter_spec.rb

@@ -0,0 +1,182 @@
+###############################################################
+#   
+#  File:      sparameter_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/>.
+#
+#
+###############################################################
+#
+#   Description:
+#     Test specification for SOCMaker::SParameter and
+#                            SOCMaker::SParameterEntry
+#
+#
+#
+#
+###############################################################
+require_relative( 'spec_helper' )
+
+require "yaml_examples.rb"
+
+
+
+describe SOCMaker::Parameter do
+
+  include_context "yaml examples"
+
+  describe "#initialize" do
+
+    it "return an object of type SOCMaker::SParameter when creating it with new" do
+      o = SOCMaker::SParameter.new( "./path/to/file.src", "./path/to/file.dst" )
+      expect( o.class ).to be( SOCMaker::SParameter )
+      expect( o.parameters.class ).to be( Hash )
+    end
+
+    it "raises an error if the destination path has zero length" do
+      expect{ SOCMaker::SParameter.new( "./path/to/file.src", "" ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if the destination path is nil" do
+      expect{ SOCMaker::SParameter.new( "./path/to/file.src", nil ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if the destination path is not a string" do
+      expect{ SOCMaker::SParameter.new( "./path/to/file.src", 4 ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+
+    it "raises an error if the src path has zero length" do
+      expect{ SOCMaker::SParameter.new( "", "./path/to/file.dst" ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if the src path is nil" do
+      expect{ SOCMaker::SParameter.new( nil, "./path/to/file.dst" ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if the src path is not a string" do
+      expect{ SOCMaker::SParameter.new( 4,"./path/to/file.dst" ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "returns an object of type SOCMaker::SParameterentry when creating it with new" do
+      o = SOCMaker::SParameterEntry.new( "type", "mytoken" )
+      expect( o.class).to be( SOCMaker::SParameterEntry )
+    end
+
+    it "raises an error if token is nil" do
+      expect{ SOCMaker::SParameterEntry.new( "type", nil ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if token is an empty string" do
+      expect{ SOCMaker::SParameterEntry.new( "type", "" ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if token is not a string" do
+      expect{ SOCMaker::SParameterEntry.new( "type", 4 ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+    end
+
+    it "raises an error if the path is not defined" do
+      expect{ SOCMaker::from_s( @F_YAML_STATIC_NO_PATH  ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if the token is not defined" do
+      expect{ SOCMaker::from_s( @F_YAML_STATIC_NO_TOKEN  ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+    it "raises an error if the type is not defined" do
+      expect{ SOCMaker::from_s( @F_YAML_STATIC_NO_TYPE  ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+
+    it "raises an error if the destination is not defined" do
+      expect{ SOCMaker::from_s( @F_YAML_STATIC_NO_DST1  ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+
+    it "raises an error if an entry is not provided" do
+      expect{ SOCMaker::from_s( @F_YAML_STATIC_NO_SENTRY  ) }.
+        to raise_error( SOCMaker::ERR::InitError )
+    end
+
+  describe "object handling, en-decoding:" do
+
+    it "is possible to encode and decode a static parameter" do
+      o1 = SOCMaker::SParameter.new( 
+            "./path/to/file.src", 
+            "./path/to/file.dst",
+            'parameters' => { p1: SOCMaker::SParameterEntry.new( "file.src", "file.dst" ) } )
+
+      yaml_str = o1.to_yaml
+      o2 = YAML::load( yaml_str )
+      expect( o1 ).to eq( o2 )
+    end
+
+    it "returns false for two non-equal objects" do
+      o1 = SOCMaker::SParameterEntry.new( 
+          "./path/to/file.src", 
+          "./path/to/file.dst" )
+      o2 = Marshal::load(Marshal.dump(o1))
+      o2.min = 4
+      expect( o2 == o1 ).to be( false )
+    end
+
+    it "is possible to encode and decode a static parameter entry" do
+      o1 = SOCMaker::SParameterEntry.new( 
+          "./path/to/file.src", 
+          "./path/to/file.dst",
+            'default'       => 0,
+            'min'           => 0,
+            'max'           => 3,
+            'visible'       => true,
+            'editable'      => false,
+            'description'   => "test description" )
+      yaml_str = o1.to_yaml
+      o2 = YAML::load( yaml_str )
+      expect( o1 ).to eq( o2 )
+    end
+  end
+end
+
+
+
+# vim: noai:ts=2:sw=2
+

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+###############################################################
+#   
+#  File:      spec_helper.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:
+#     This little helper is included in all specifications.
+#     We initialise the SOCMaker module 
+#        - without loading the library
+#        - with logging to NULL
+#     In addition, we enable warnings and colors.
+#
+#
+###############################################################
+require 'rubygems'
+require 'rspec'
+require 'rspec/its'
+require 'simplecov'
+SimpleCov.start
+require 'soc_maker'
+
+RSpec.configure do |config|
+
+
+  SOCMaker::load(    skip_refresh: true,                       # no loading of a lib
+                     logger_out: File.open(File::NULL, "w")    # no logger output
+                     )
+  config.warnings      = true
+  config.color         = true
+
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_framework = :mocha
+  # config.mock_framework = :flexmock
+  # config.mock_framework = :rr
+end
+
+
+
+
+
+
+
+
+
+

data/spec/test_soc.yaml

@@ -0,0 +1,105 @@
+SOCM_SOC
+name: test_soc
+description: 'This is a test SOC'
+id: test_soc,v1
+date: '13. May 2014'
+license: 'GPL'
+licensefile: ''
+author: 'feddischson'
+authormail: 'feddischson [ at ] opencores.org'
+vccmd: ''
+interfaces: 
+  :top_ifc: SOCM_IFC
+    name: core_AB_ifc
+    dir: 0
+    id: core_AB_ifc,1
+    ports:
+      :sig_con1a: SOCM_PORT
+         spc_ref: sig_a
+         len:  8
+      :sig_con1b: SOCM_PORT
+         spc_ref: sig_b
+         len:  16
+      :sig_con1c: SOCM_PORT
+         spc_ref: sig_c
+         len:  1
+  :top_ifc2: SOCM_IFC
+    name: bidir_io
+    dir: 0
+    id: bidir_ifc,1
+    ports:
+      :clk_i: SOCM_PORT
+         spc_ref: clk
+         len: 1
+      :rst: SOCM_PORT
+         spc_ref: rst
+         len: 1
+      :en: SOCM_PORT
+         spc_ref: en
+         len: 1
+      :wr: SOCM_PORT
+         spc_ref: wr
+         len: 1
+      :bidir: SOCM_PORT
+         spc_ref: bidir
+         len: 8
+
+
+
+
+functions: {}
+inst_parameters: {}
+static_parameters: {}
+cores:
+  :inst_a: SOCM_INST
+    type: core_A,rel1
+    params: 
+      :param1: 8
+      :param2: 16
+      :param3: 16
+  :inst_b: SOCM_INST
+    type: core_A,rel1
+    params: 
+      :param1: 8
+      :param2: 16
+      :param3: 16
+  :inst_c: SOCM_INST
+    type: core_B,rel1
+    params: {}
+  :inst_d: SOCM_INST
+    type: core_B,rel1
+    params: {}
+
+  :inst_io: SOCM_INST
+    type: core_C,v1
+    params: {}
+
+
+static: 
+  :core_Arel1:
+    :p1: 11
+    :pv1: 0
+
+cons:
+  :a_new_con:
+    :mapping:
+    - :inst_a: :ifc01
+    - :inst_c: :myifc
+  :a_2nd_con:
+    :mapping:
+    - :inst_b:    :ifc01
+    - :test_soc:  :top_ifc
+
+  :io_con:
+    :mapping:
+    - :inst_io:    :ifc01
+    - :test_soc:  :top_ifc2
+
+
+
+# :top_con:
+#   :mapping:
+#   - :test_soc: :top_ifc1
+#   - :inst_d: :myifc
+hdlfiles: {}
+toplevel: test_soc

data/spec/test_soc2.yaml

@@ -0,0 +1,60 @@
+SOCM_SOC
+name: Test SOC Top
+description: 'This is a test SOC'
+id: test_soc_top,v1
+date: '16. Aug 2014'
+license: 'GPL'
+licensefile: ''
+author: 'feddischson'
+authormail: 'feddischson [ at ] opencores.org'
+vccmd: ''
+interfaces: 
+  :top_ifc: SOCM_IFC
+    name: core_AB_ifc
+    dir: 0
+    id: core_AB_ifc,1
+    ports:
+      :sig_con1a: SOCM_PORT
+         spc_ref: sig_a
+         len:  8
+      :sig_con1b: SOCM_PORT
+         spc_ref: sig_b
+         len:  16
+      :sig_con1c: SOCM_PORT
+         spc_ref: sig_c
+         len:  1
+
+functions: {}
+inst_parameters: {}
+static_parameters: {}
+cores:
+  :inst_t1: SOCM_INST
+    type: test_soc,v1
+  :inst_t2: SOCM_INST
+    type: test_soc,v1
+  :inst_t3: SOCM_INST
+    type: core_B,rel1
+    params: {}
+
+static: {}
+
+cons:
+  :t_con:
+    :mapping:
+    - :inst_t2:      :top_ifc
+    - :test_soc_top: :top_ifc
+  :i_con:
+    :mapping:
+    - :inst_t1:   :top_ifc
+    - :inst_t3:   :myifc
+
+
+
+
+# :top_con:
+#   :mapping:
+#   - :test_soc: :top_ifc
+#   - :inst_d: :myifc
+hdlfiles: {}
+toplevel: test_soc_top
+

data/spec/test_soc_lib/cores/core_A_rel1/00_core_a.yaml

@@ -0,0 +1,75 @@
+SOCM_CORE
+name: Core A
+description: A test IP-core, which has no functionallity
+id: core_A,rel1
+date: 1.1.2014
+license: LGPL
+licensefile: 
+author: Christian Hättich
+authormail: feddischson@opencores.org
+repocmd: 
+toplevel: core_a
+interfaces:
+  :ifc01: SOCM_IFC
+    name: core_AB_ifc
+    dir: 0
+    id: core_AB_ifc,1
+    ports:
+      :sig_con1a: SOCM_PORT
+         spc_ref: sig_a
+         len:  param1
+      :sig_con1b: SOCM_PORT
+         spc_ref: sig_b
+         len:  param2
+      :sig_con1c: SOCM_PORT
+         spc_ref: sig_c
+         len:  1
+  :ifc02: SOCM_IFC
+    name: core_AB_ifc
+    dir: 1
+    id: core_AB_ifc,1
+    ports:
+      :sig_con1ax: SOCM_PORT
+         spc_ref: sig_a
+         len:  param1
+      :sig_con1bx: SOCM_PORT
+         spc_ref: sig_b
+         len:  param2
+      :sig_con1cx: SOCM_PORT
+         spc_ref: sig_c
+         len:  1
+
+
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      use_syn: true
+      use_sys_sim: true
+      use_mod_sim: true
+      type: vhdl
+      path: ./core_a.vhd
+
+inst_parameters:
+  :param1: SOCM_PARAM
+    type: integer
+    default: 8
+    min: 0
+    max: 10
+    visible: true
+    editable: true
+    description: More setup
+  :param2: SOCM_PARAM
+    type: integer
+    default: 0
+    min: 0
+    max: 4
+    visible: true
+    editable: true
+    description: More setup
+  :param3: SOCM_PARAM
+    type: integer
+    default: 0
+    min: 0
+    max: 4
+    visible: true
+    editable: true
+    description: More setup