soc_maker 0.1.1

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

@@ -0,0 +1,57 @@
+static_parameters:
+  :core_a_pkg.vhd.src: SOCM_SPARAM
+    dir: .
+    path: ./core_a_pkg.vhd.src
+    file_dst: core_a_pkg.vhd
+    parameters: 
+      :p1: SOCM_SENTRY
+        token: TOK1
+        type: integer
+        min:  0
+        max:  100
+        visible: true
+        editable: true
+        default: 22
+        description: Some setup
+      :p3: SOCM_SENTRY
+        token: TOK_XYZ
+        type: integer
+        min:  0
+        max:  100
+        visible: true
+        editable: true
+        default: 4
+        description: Some setup
+  :core_a_pkg2.vhd.src: SOCM_SPARAM
+    dir: .
+    path: ./core_a_pkg2.vhd.src
+    file_dst: core_a_pkg2.vhd
+    parameters:
+      :p2: SOCM_SENTRY
+        token: TOK2
+        type: integer
+        min:  0
+        max:  100
+        visible: true
+        editable: true
+        default: 5
+        description: More setup
+
+  :core_a_pkg3.v.src: SOCM_SPARAM
+    dir: .
+    path: ./core_a_pkg3.v.src
+    file_dst: core_a_pkg3.v
+    parameters:
+      :pv1: SOCM_SENTRY
+        token: TOK_V1
+        type: enum
+        min:  0
+        max:  100
+        visible: true
+        editable: true
+        default: 5
+        description: More setup
+        choice: 
+            - "`define SEL_1"
+            - "`define SEL_2"
+            - "`define SEL_3"

data/spec/test_soc_lib/cores/core_A_rel1/core_a.vhd

@@ -0,0 +1,29 @@
+library ieee;
+use ieee.std_logic_1164.ALL;
+
+
+
+
+entity core_a is
+generic(
+   param1   : natural := 8;
+   param2   : natural := 4;
+   param3   : natural := 5
+  ); 
+port(
+   sig_con1a : in  std_logic_vector( param1-1 downto 0 );
+   sig_con1b : in  std_logic_vector( param2-1 downto 0 );
+   sig_con1c : out std_logic
+);
+end entity core_a;
+
+architecture IMPL of core_a is
+
+
+begin
+
+   sig_con1c <= '1';
+
+end architecture IMPL;
+
+

data/spec/test_soc_lib/cores/core_A_rel1/core_a_pkg.vhd.src

@@ -0,0 +1,3 @@
+package core_a_pkg is
+  constant some_data : integer := TOK1;
+end core_a_pkg;

data/spec/test_soc_lib/cores/core_A_rel1/core_a_pkg2.vhd.src

@@ -0,0 +1,4 @@
+package core_a_pkg2 is
+  constant some_data2 : integer := TOK2;
+end core_a_pkg2;
+

data/spec/test_soc_lib/cores/core_A_rel1/core_a_pkg3.v.src

@@ -0,0 +1,6 @@
+
+
+TOK_V1
+
+
+

data/spec/test_soc_lib/cores/core_B_rel1/core_b.vhd

@@ -0,0 +1,25 @@
+library ieee;
+use ieee.std_logic_1164.ALL;
+
+
+
+entity core_b is
+port(
+   mysig_con1a : out std_logic_vector( 7 downto 0 );
+   mysig_con1b : out std_logic_vector( 31 downto 0 );
+   mysig_con1c : in  std_logic
+);
+end entity core_b;
+
+architecture IMPL of core_b is
+
+
+begin
+
+
+   mysig_con1a <= "11001010";
+   mysig_con1b <= ( others => '1' );
+
+end architecture IMPL;
+
+

data/spec/test_soc_lib/cores/core_B_rel1/core_b.yaml

@@ -0,0 +1,36 @@
+SOCM_CORE
+name: Core B
+description: B test IP-core
+id: core_B,rel1
+date: 1.1.2014
+license: LGPL
+licensefile: 
+author: Christian Hättich
+authormail: feddischson@gmx.com
+repocmd: 
+toplevel: core_b
+interfaces:
+  :myifc: SOCM_IFC
+    name: core_AB_ifc
+    dir: 1
+    id: core_AB_ifc,1
+    ports:
+      :mysig_con1a: SOCM_PORT
+         spc_ref: sig_a
+         len: 8
+      :mysig_con1b: SOCM_PORT 
+         spc_ref: sig_b
+         len: 16
+      :mysig_con1c: SOCM_PORT 
+         spc_ref: sig_c
+         len: 1
+
+hdlfiles:
+  :core_b.vhd: SOCM_HDL_FILE
+    use_syn: true
+    use_sys_sim: true
+    use_mod_sim: true
+    type: vhdl
+    path: ./core_b.vhd
+
+

data/spec/test_soc_lib/cores/core_C_v1/core_C.vhd

@@ -0,0 +1,57 @@
+library ieee;
+library std;
+use ieee.std_logic_1164.ALL;
+use ieee.numeric_std.ALL;
+
+
+
+entity core_c is
+  port(
+    clk_i    : in std_logic;
+    rst_i    : in std_logic;
+    en_i     : in std_logic;
+    wr_i     : in std_logic;
+    bidir_io : inout std_logic_vector( 7 downto 0 )
+      );
+end entity;
+
+
+architecture IMP of core_c is
+
+
+  signal cnt : unsigned( 7 downto 0 );
+
+begin
+
+  p : process( clk, rst )
+  begin
+    if clk'event and clk='1' then
+
+      if rst = '1' then
+        cnt     <= ( others => '0' );
+        bidir   <= ( others => 'Z' );
+      else
+
+        -- default case: we increase the counter
+        cnt <= cnt+1;
+
+        if en = '0' then
+
+          if wr = '1' then
+            cnt <= unsigned( bidir );
+          end if;
+          bidir <= ( others => 'Z' );
+        else
+          bidir <= std_logic_vector( cnt );
+        end if;
+
+
+      end if;
+
+    end if;
+  end process;
+end architecture IMP;
+
+
+
+

data/spec/test_soc_lib/cores/core_C_v1/core_c.yaml

@@ -0,0 +1,42 @@
+SOCM_CORE
+name: Core C
+description: C test IP-core
+id: core_C,v1
+date: 1.1.2014
+license: LGPL
+licensefile: 
+author: Christian Hättich
+authormail: feddischson@gmx.com
+repocmd: 
+toplevel: core_c
+interfaces:
+  :ifc01: SOCM_IFC
+    name: bidir_interface
+    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
+
+hdlfiles:
+  :core_c.vhd: SOCM_HDL_FILE
+    use_syn: true
+    use_sys_sim: true
+    use_mod_sim: true
+    type: vhdl
+    path: ./core_C.vhd
+
+

data/spec/test_soc_lib/cores/soc_A/soc_A.yaml

@@ -0,0 +1,12 @@
+SOCM_SOC
+name: SOC A
+description: A test SOC-core, which has no functionallity
+id: soc_A,rel1
+date: 1.1.2014
+license: LGPL
+licensefile: 
+author: Christian Hättich
+authormail: feddischson@opencores.org
+repocmd: 
+toplevel: soc_a
+

data/spec/test_soc_lib/cores/soc_maker_include.yaml

@@ -0,0 +1,6 @@
+SOCM_INCLUDE
+dirs:
+   - ./soc_A
+   - ./core_A_rel1
+   - ./core_B_rel1
+   - ./core_C_v1

data/spec/test_soc_lib/ifcs/core_AB_ifc/bidir_ifc.yaml

@@ -0,0 +1,19 @@
+SOCM_IFC_SPC
+name: Bidirectional interface
+id: bidir_ifc,1
+ports:
+  :clk:
+      :dir:       1
+      :mandatoru: true
+  :rst: 
+      :dir:       1
+      :mandatory: true
+  :en:
+      :dir:       1
+      :mandatory: true
+  :wr:
+      :dir:       1
+      :mandatory: true
+  :bidir:
+      :dir:       2
+      :mandatory: true

data/spec/test_soc_lib/ifcs/core_AB_ifc/core_AB_ifc.yaml

@@ -0,0 +1,15 @@
+SOCM_IFC_SPC
+name: Core AB Interface
+id: core_AB_ifc,1
+ports:
+  :sig_a: 
+      :dir:       1
+      :mandatory: true
+  :sig_b: 
+      :dir:       1
+      :mandatory: true
+      :default:   '1'
+  :sig_c: 
+      :dir:       0
+      :mandatory: false
+      :default:   'X'

data/spec/test_soc_lib/ifcs/core_AB_ifc/top_ifc.yaml

@@ -0,0 +1,9 @@
+SOCM_IFC_SPC
+name: Top IFC
+id: top_ifc,1
+ports:
+  :sig_1: 
+      :dir: 1
+  :sig_2: 
+      :dir: 1
+

data/spec/test_soc_lib/soc_maker_include.yaml

@@ -0,0 +1,4 @@
+SOCM_INCLUDE
+dirs:
+   - cores
+   - ifcs/core_AB_ifc

data/spec/yaml_examples.rb

@@ -0,0 +1,367 @@
+
+
+
+RSpec.shared_context "yaml examples", :a => :b  do
+
+ before do
+
+  @valid_yamls = []
+
+
+  #
+  # A yaml example, which contains 
+  #   - a full definition
+  #   - an interface with one port
+  #   - one hdl file
+  #   - one instance parameter
+  #   - one static parameter
+  # 
+  @FULL_YAML = '''SOCM_CORE
+name: core_A
+description: A test IP-core
+id: core_A,rel1
+date: 1.1.2014
+license: LGPL
+licensefile: 
+author: Christian Haettich
+authormail: feddischson@opencores.org
+vccmd: svn co http://some-address/
+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
+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
+static_parameters:
+  :core_a_pkg.vhd.src: SOCM_SPARAM
+    path: ./core_a.pkg.src
+    file_dst: core_a_pkg.vhd
+    parameters: 
+      :p1: SOCM_SENTRY
+        token: TOK1
+        type: integer
+        min:  0
+        max:  100
+        visible: true
+        editable: true
+        default: 3
+        description: Some setup
+'''
+  @valid_yamls << {  desc: 'should return a class of type CoreDef when loading a full core-def',
+                    yaml: @FULL_YAML }
+
+
+
+  # minimalistic def with one vhdl file
+  @MIN_YAML1 = '''SOCM_CORE
+name: core_A
+id: core_A,rel1
+toplevel: top_A
+hdlfiles: 
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+'''
+  @valid_yamls << {  desc: 'should return a class of type CoreDef when loading a minimal core-def',
+                    yaml: @MIN_YAML1 }
+
+
+  # minimalistic def with one 
+  # vhdl and one verilog file
+  @MIN_YAML2 = '''SOCM_CORE
+name: core_A
+id: core_A,rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+   :core_b.v: SOCM_HDL_FILE
+      path: ./core_b.v
+'''
+  @valid_yamls << {  desc: 'should return a class of type CoreDef when loading a core-def with two files',
+                    yaml: @MIN_YAML2 }
+
+
+
+  # minimal setup with one interface
+  @MIN_YAML_IFC = '''SOCM_CORE
+name: core_A
+id: core_A,rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+interfaces:
+  :ifc01: SOCM_IFC
+    name: a_ifc_def
+    dir: 0
+    id: a_ifc_def,1
+    ports:
+      :sig_con1a: SOCM_PORT
+         spc_ref: sig_a
+'''
+  @valid_yamls << { desc: 'should return a class of type CoreDef when loading a minimal core-def with a minimal interface',
+                   yaml: @MIN_YAML_IFC }
+
+
+
+
+
+  # minimal setup with one instance parameter
+  @MIN_YAML_INSTP = '''SOCM_CORE
+name: core_A
+id: core_A,rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+inst_parameters: 
+  :param1: SOCM_PARAM
+    type: integer
+'''
+  @valid_yamls << {  desc: 'should return a class of type CoreDef when loading a minimal core-def (with instance param.)',
+                    yaml: @MIN_YAML_INSTP }
+
+
+
+  # minimal def with one static parameter
+  @MIN_YAML_STATIC = '''SOCM_CORE
+name: core_A
+id: core_A,rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+static_parameters:
+  :a_file.vhd.src: SOCM_SPARAM
+    file_dst: a_file.vhd
+    path: ./core_a.vhd
+    parameters:
+      :p1:  SOCM_SENTRY
+        type: integer
+        token: T1
+'''
+  @valid_yamls << {  desc: 'should return a class of type CoreDef when loading a minimal core-def (with static param.)', 
+                    yaml: @MIN_YAML_STATIC }
+
+
+
+
+
+  #
+  # A yaml example, which contains 
+  #   - a full definition
+  #   - an interface with one port
+  #   - one hdl file
+  #   - one instance parameter
+  #   - one static parameter
+  # 
+  @FULL_SOC_YAML = '''SOCM_SOC
+name: my_soc
+description: A test SOC
+id: my_soc,rel2
+date: 1.1.2014
+license: LGPL
+licensefile: 
+toplevel: soc_top
+author: Christian Haettich
+authormail: feddischson@opencores.org
+repocmd: svn co http://some-address/
+'''
+
+
+  @SOC_YAML_WITH_CORE = '''SOCM_SOC
+name: my_soc
+description: A test SOC
+id: my_soc,rel2
+date: 1.1.2014
+license: LGPL
+licensefile: 
+author: Christian Haettich
+authormail: feddischson@opencores.org
+repocmd: svn co http://some-address/
+toplevel: soc_top
+cores:
+  :inst1: SOCM_INST
+    type: mycorerel1
+'''
+
+
+  @F_YAML_STATIC_NO_TOKEN = '''SOCM_CORE
+name: core_A
+version: rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+static_parameters: 
+  :a_file.vhd.src: SOCM_SPARAM
+    path: ./core_a.vhd
+    file_dst: a_file.vhd
+    parameters:
+      :p1:  SOCM_SENTRY
+        min: 4
+        type: integer
+'''
+
+  @F_YAML_STATIC_NO_PATH = '''SOCM_CORE
+name: core_A
+version: rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+static_parameters: 
+  :a_file.vhd.src: SOCM_SPARAM
+    file_dst: a_file.vhd
+    parameters:
+      :p1:  SOCM_SENTRY
+        min: 4
+        token: ABC
+        type: integer
+'''
+
+  @F_YAML_STATIC_NO_TYPE = '''SOCM_CORE
+name: core_A
+version: rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+static_parameters: 
+  :a_file.vhd.src: SOCM_SPARAM
+    file_dst: a_file.vhd
+    path: ./core_a.vhd
+    parameters:
+      :p1:  SOCM_SENTRY
+        min: 4
+        token: ABC
+'''
+
+  # missing file_dst in static parameter
+  @F_YAML_STATIC_NO_DST1 = '''SOCM_CORE
+name: core_A
+version: rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+static_parameters:
+  :a_file.vhd: SOCM_SPARAM
+    parameters:
+      :p1: SOCM_SENTRY
+        type: integer
+        token: T1
+'''
+  # no parameter entry
+  @F_YAML_STATIC_NO_SENTRY = '''SOCM_CORE
+name: core_A
+version: rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+static_parameters:
+  :a_file.vhd.src: SOCM_SPARAM
+    file_dst: a_file_xyz.vhd
+    path: ./core_a.vhd
+    parameters:
+      :p1: SOCM_SENTRY
+'''
+
+  # type is missing for param1
+  @F_YAML_INSTP_TYPE = '''SOCM_CORE
+name: core_A
+version: rel1
+toplevel: top_A
+hdlfiles:
+   :core_a.vhd: SOCM_HDL_FILE
+      path: ./core_a.vhd
+inst_parameters:
+  :param1: SOCM_PARAM
+    :min: 0
+'''
+
+
+  @IFC_YAML_VALID = """
+SOCM_IFC_SPC
+name: core_ifc
+id: 'core_ifc,1'
+ports:
+  :sig_a: 
+    :dir: 1
+  :sig_b: 
+    :dir: 1
+  :sig_c: 
+    :dir: 0
+"""
+
+  @IFC_YAML_INVALID = """
+SOCM_IFC_SPC
+name: core_ifc
+id: 'core_ifc,1'
+ports:
+  :sig_a:
+    :dir: '12'
+  :sig_b: 
+    :dir: 1
+  :sig_c: 
+    :dir: 0
+"""
+
+  @IFC_YAML_INVALID2 = """
+SOCM_IFC_SPC
+name: core_ifc
+id: 'core_ifc,1'
+ports:
+  :sig_a:
+    :dir:
+  :sig_b: 
+    :dir: 1
+  :sig_c: 
+    :dir: 0
+"""
+
+  #
+  # core definition with no info about the HDL file
+  @F_MIN_YAML_FIlE_NIL = '''SOCM_CORE
+  name: core_A
+  version: rel1
+  toplevel: top_A
+  hdlfiles:
+     :a_file.v: SOCM_HDL_FILE
+  '''
+
+  @F_YAML_FILE_TYPE = '''SOCM_CORE
+  name: core_A
+  version: rel1
+  toplevel: top_A
+  hdlfiles:
+     :core_a.vhd: SOCM_HDL_FILE
+        path: ./core_a.vhd
+        type: xhdl
+  '''
+
+
+  end
+
+end