ipxact-ruby 0.11.1

data/spec/integration/bus_data_extraction_spec.rb

@@ -0,0 +1,105 @@
+# Copyright (C) 2010 TIMA Laboratory
+#
+# 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/>.
+#
+
+require File.join File.dirname(__FILE__), 'general_spec'
+
+describe 'IPXACT, when using the tools for bus data extraction' do
+  it "should be able to extract data from a mirrored slave bus interface" do
+    variables = {
+      "range_slv0_mirror" => "0x00040000",
+      "range_slv1_mirror" => "0x00009000",
+      "start_addr_slv0_mirror" => "0x0",
+      "start_addr_slv1_mirror" => "0x30000000"
+    }
+    components = IPXACT::load_components(PLATFORM_PATH)
+
+    ahbbus22_component = components[['ahbbus22', '1.4']]
+    mirrored_slave_0 = ahbbus22_component.xpath(".//spirit:busInterface") \
+                                       .select{|bus| bus.xpath("./spirit:name").first.text == 'AHB_MirroredSlave0'} \
+                                       .first
+
+    IPXACT::Parser::BusData::extract_bus_data(mirrored_slave_0, ahbbus22_component, variables).should \
+      eql([:mirrored_slave, {
+        :remap => {:address => "0x0", :id => "start_addr_slv0_mirror"},
+        :range => {:value => "0x00040000", :id => "range_slv0_mirror"}
+      }])
+
+    mirrored_slave_1 = ahbbus22_component.xpath(".//spirit:busInterface") \
+                                         .select{|bus| bus.xpath("./spirit:name").first.text == 'AHB_MirroredSlave1'} \
+                                         .first
+
+    IPXACT::Parser::BusData::extract_bus_data(mirrored_slave_1, ahbbus22_component, variables).should \
+      eql([:mirrored_slave, {
+        :remap => {:address => "0x30000000", :id => "start_addr_slv1_mirror"},
+        :range => {:value => "0x00009000", :id => "range_slv1_mirror"} 
+      }])
+  end
+
+  it "should be able to extract data from a mirrored master bus interface" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    ahbbus22_component = components[['ahbbus22', '1.4']]
+    mirrored_master_0 = ahbbus22_component.xpath(".//spirit:busInterface") \
+                                       .select{|bus| bus.xpath("./spirit:name").first.text == 'AHB_MirroredMaster0'} \
+                                       .first
+    IPXACT::Parser::BusData::extract_bus_data(mirrored_master_0, ahbbus22_component, []).should \
+      eql([:mirrored_master, nil])
+  end
+
+  it "should be able to extract data from a master bus interface" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    dma_component = components[['dma', '1.4']]
+    master = dma_component.xpath(".//spirit:busInterface") \
+                          .select{|bus| bus.xpath("./spirit:name").first.text == 'AHB_Master'} \
+                          .first
+    IPXACT::Parser::BusData::extract_bus_data(master, dma_component, []).should \
+      eql([:master, {:address_space_name => 'AHB_AS', :range => '4G', :width => '32'}])
+  end
+
+  it "should be able to extract data from a slave bus interface" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    dma_component = components[['dma', '1.4']]
+    slave = dma_component.xpath(".//spirit:busInterface") \
+                          .select{|bus| bus.xpath("./spirit:name").first.text == 'APB_Slave'} \
+                          .first
+    IPXACT::Parser::BusData::extract_bus_data(slave, dma_component, []).should \
+      eql([:slave, {
+              :memory_map_name => 'APB_MM',
+              :base_address => '0',
+              :range => '16',
+              :width => '32',
+              :registers => [
+                {
+                  :name => 'sourceAddress',
+                  :offset => '0x0',
+                  :size => '32',
+                  :access => 'read-write'
+                },
+                {
+                  :name => 'destinationAddress',
+                  :offset => '0x4',
+                  :size => '32',
+                  :access => 'read-write'
+                },
+                {
+                  :name => 'control',
+                  :offset => '0x8',
+                  :size => '32',
+                  :access => 'read-write'
+                }
+              ]
+    }])
+  end
+end

data/spec/integration/data_calculation_spec.rb

@@ -0,0 +1,133 @@
+# Copyright (C) 2010 TIMA Laboratory
+#
+# 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/>.
+#
+
+require File.join File.dirname(__FILE__), 'general_spec'
+
+describe "The data calculation functions of our IPXACT tool" do
+  it "should be able to find valid data paths when building a driver" do
+    expected_data_path = [
+      [
+        {
+          :component_instance => 'i_proc',
+          :port_name => "AHB_Master",
+        },
+        {
+          :component_instance => 'i_ahb',
+          :port_name => 'AHB_MirroredMaster0'
+        }
+      ],
+      [
+        {
+          :component_instance => 'i_ahb',
+          :port_name => 'AHB_MirroredSlave1'
+        },
+        {
+          :component_instance => 'i_h2p',
+          :port_name => 'AHB_Slave'
+        }
+      ],
+      [
+        {
+          :component_instance => 'i_h2p',
+          :port_name => 'APB_Master'
+        },
+        {
+          :component_instance => 'i_apb',
+          :port_name => 'APB_MirroredMaster'
+        }
+      ],
+      [
+        {
+          :component_instance => 'i_apb',
+          :port_name => 'APB_MirroredSlave7'
+        },
+        {
+          :component_instance => 'i_dma',
+          :port_name => 'APB_Slave'
+        }
+      ]
+    ]
+
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+
+    data_path = nil
+    lambda {
+      data_path = platform.resolve_data_path('i_proc', 'i_dma')
+    }.should_not raise_exception
+    data_path.should eql(expected_data_path)
+  end
+
+  it "should be able to assign instance variables to mirrored slave addresses and ranges" do
+    expected_values = {
+        "range_slv0_mirror" => "0x00040000",
+        "range_slv1_mirror" => "0x00009000",
+        "start_addr_slv0_mirror" => "0x0",
+        "start_addr_slv1_mirror" => "0x30000000"
+    }
+
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+    
+    nodes_with_mirrored_slaves = platform.components.values.select do |node|
+      node.ports.any?{|port| port[:type] == :mirrored_slave}
+    end
+
+    mirrored_slave_ports = nodes_with_mirrored_slaves.collect{|node| 
+      node.ports.select{|port| port[:type] == :mirrored_slave}
+    }.flatten
+
+    expected_values.each do |expected_key, expected_value|
+      port = mirrored_slave_ports.select do | mirrored_s |
+        mirrored_s[:port_data] && (mirrored_s[:port_data][:remap][:id] == expected_key ||
+                                   mirrored_s[:port_data][:range][:id])
+      end.first
+
+      unless port.empty?
+        if port[:port_data][:remap][:id] == expected_key
+          port[:port_data][:remap][:address].should == expected_value
+        elsif port[:port_data][:range][:id] == expected_key
+          port[:port_data][:range][:value].should == expected_value
+        end
+      end
+    end
+  end
+
+  it "should be able to determine the dma component's base address from the interconnect path" do
+    # DMA remap address : 0x30000000 + 0x7000 = 0x30007000
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+    data_path = platform.resolve_data_path('i_proc', 'i_dma')
+
+    base_address = platform.resolve_base_address(data_path)
+    base_address.should == 0x30007000 # AHB remap + APB remap (as defined in the apbSubsystem design file)
+  end
+
+
+  it "should be able to determine the cgu component's base address from the interconnect path" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.2"], components, designs)
+    data_path = platform.resolve_data_path('i_proc', 'i_cgu')
+
+    base_address = platform.resolve_base_address(data_path)
+    base_address.should == 0x30004000
+  end
+
+end

data/spec/integration/data_construction_spec.rb

@@ -0,0 +1,52 @@
+# Copyright (C) 2010 TIMA Laboratory
+#
+# 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/>.
+#
+
+require File.join File.dirname(__FILE__), 'general_spec'
+
+describe "The data construction functions of our IPXACT tool" do
+  it "should be able to create an interconnect list with valid component nodes" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+
+    expected_nodes = ['i_ahb', 'i_mem', 'i_sub', 'i_cgu', 'i_dma', 'i_proc', 'i_rgu']
+    nodes = platform.components.keys
+    
+    expected_nodes.each {|expected_node| nodes.should include(expected_node)}
+    nodes.each {|node| expected_nodes.should include(node)}
+  end
+
+  it "should be able to create an interconnect list with a valid connections list" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+
+    platform.interconnections.values.should include(
+        [
+          {
+             :component_instance => "i_proc",
+             :port_name => "AHB_Master",
+             :port_type => :master
+          },
+          {
+             :component_instance => "i_ahb",
+             :port_name => "AHB_MirroredMaster0",
+             :port_type => :mirrored_master
+          }
+        ]
+    )
+  end
+end

data/spec/integration/general_spec.rb

@@ -0,0 +1,121 @@
+# Copyright (C) 2010 TIMA Laboratory
+#
+# 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/>.
+#
+
+require File.join(File.dirname(__FILE__), '../../lib/ipxact')
+
+PLATFORM_PATH = File.join File.dirname(__FILE__) , '../test_data/spiritconsortium.org/Leon2TLM'
+DESIGN_PATH = 'SystemTLM1/Leon2Platform/design_Leon2Platform.xml'
+
+
+describe "IPXACT: the tools for building transformation data" do
+
+  context "component and design validation" do
+    it "should confirm that a design file is not a valid component" do
+      IPXACT::is_valid_component?(File.join(PLATFORM_PATH,DESIGN_PATH)).should be_false
+    end
+
+    it "should confirm the validity of a valid component" do
+      IPXACT::is_valid_component?(File.join(PLATFORM_PATH, 'SystemTLM1/Leon2Platform/Leon2Platform.xml')).should be_true
+    end
+
+    it "should raise an exception when given an invalid path" do
+      lambda{
+        IPXACT::is_valid_component?(3)
+      }.should raise_exception(ArgumentError)
+
+      lambda{
+        IPXACT::is_valid_design?(3)
+      }.should raise_exception(ArgumentError)
+    end
+
+    it "should confirm a design file's validity" do
+      IPXACT::is_valid_design?(File.join(PLATFORM_PATH,DESIGN_PATH)).should be_true
+    end
+
+    it "should confirm that a component is not a valid design" do
+      IPXACT::is_valid_design?(File.join(PLATFORM_PATH, 'SystemTLM1/Leon2Platform/Leon2Platform.xml')).should be_false
+    end
+  end
+
+  context "extracting a component's identifier" do
+    it "should be able to extract a design's identifier" do
+      IPXACT::identifier(File.join(PLATFORM_PATH,DESIGN_PATH)).should == {
+        :name     => 'design_Leon2Platform',
+        :vendor   => 'spiritconsortium.org',
+        :library  => 'Leon2TLM',
+        :version  => '1.1'
+      }
+    end
+
+    it "should be able to extract a component's identifier" do
+      IPXACT::identifier(File.join(PLATFORM_PATH,'SystemTLM1/Leon2Platform/Leon2Platform.xml')).should == {
+        :name     => 'Leon2Platform',
+        :vendor   => 'spiritconsortium.org',
+        :library  => 'Leon2TLM',
+        :version  => '1.1'
+      }
+    end
+  end
+
+
+  context "data loading" do
+    it "should be able to load all the design files for the Leon2 Platform" do
+      design_docs = IPXACT::load_designs(PLATFORM_PATH)
+      design_docs.should have(6).keys
+    end
+
+    it "should be able to load all the components from the Leon2 Platform" do
+      component_docs = IPXACT::load_components(PLATFORM_PATH)
+      component_docs.should have(21).keys
+    end
+  end
+
+  context "platform creation" do
+    it "should be able to create a new platform, based on the documents that were loaded" do
+      design_docs = IPXACT::load_designs(PLATFORM_PATH)
+      component_docs = IPXACT::load_components(PLATFORM_PATH)
+      
+      platform = nil
+      lambda {
+        platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], component_docs, design_docs)
+      }.should_not raise_exception
+
+      platform.should_not be_nil
+      platform.should have(10).interconnections
+      platform.should have(7).components
+    end
+
+    it "should be able to load the subcomponents of the platform" do
+      design_docs = IPXACT::load_designs(PLATFORM_PATH)
+      component_docs = IPXACT::load_components(PLATFORM_PATH)
+      platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], component_docs, design_docs)
+      platform.components['i_ahb'].should have(0).subcomponents
+      platform.components['i_ahb'].should have(0).interconnections
+      platform.components['i_sub'].should have(4).subcomponents
+      platform.components['i_sub'].should have(5).interconnections
+      platform.components['i_sub'][:version].should == "1.1"
+      platform.should have(0).ports
+    end
+
+    it "should be able to load component ports" do
+      design_docs = IPXACT::load_designs(PLATFORM_PATH)
+      component_docs = IPXACT::load_components(PLATFORM_PATH)
+      platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], component_docs, design_docs)
+      ahb = platform.components['i_ahb']
+      ahb.should have(4).ports
+    end
+  end
+end

data/spec/test_data/spiritconsortium.org/Leon2TLM/PV/pv_initiator_port.h

@@ -0,0 +1,135 @@
+/*****************************************************************************
+  Revision:    $Revision: 1506 $
+  Date:        $Date: 2009-04-26 01:51:56 -0500 (Sun, 26 Apr 2009) $
+  
+  Copyright (c) 2008, 2009 The SPIRIT Consortium.
+  
+  This work forms part of a deliverable of The SPIRIT Consortium.
+  
+  Use of these materials are governed by the legal terms and conditions
+  outlined in the disclaimer available from www.spiritconsortium.org.
+  
+  This source file is provided on an AS IS basis.  The SPIRIT
+  Consortium disclaims any warranty express or implied including
+  any warranty of merchantability and fitness for use for a
+  particular purpose.
+  
+  The user of the source file shall indemnify and hold The SPIRIT
+  Consortium and its members harmless from any damages or liability.
+  Users are requested to provide feedback to The SPIRIT Consortium
+  using either mailto:feedback@lists.spiritconsortium.org or the forms at 
+  http://www.spiritconsortium.org/about/contact_us/
+  
+  This file may be copied, and distributed, with or without
+  modifications; but these notices must be included on any copy.
+
+  The following code is derived, directly or indirectly, from the SystemC
+  source code Copyright (c) 1996-2004 by all Contributors.
+  All Rights reserved.
+
+  The contents of this file are subject to the restrictions and limitations
+  set forth in the SystemC Open Source License Version 2.4 (the "License");
+  You may not use this file except in compliance with such restrictions and
+  limitations. You may obtain instructions on how to receive a copy of the
+  License at http://www.systemc.org/. Software distributed by Contributors
+  under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
+  ANY KIND, either express or implied. See the License for the specific
+  language governing rights and limitations under the License.
+
+*****************************************************************************/
+
+
+#ifndef _PV_INITIATOR_PORT_H_
+#define _PV_INITIATOR_PORT_H_
+
+/*------------------------------------------------------------------------------
+ * Includes
+ *----------------------------------------------------------------------------*/
+#include <vector>
+
+#include "systemc.h"
+
+#include "tlm.h"
+
+#include "pv_tlm_if.h"
+#include "pv_initiator_port_base.h"
+#include "pv_target_port.h"
+
+//----------------------------------------------------------------------------
+template<typename ADDRESS,typename DATA,int N = 1>
+class pv_initiator_port :
+  public sc_port<tlm::tlm_transport_if<pv_request<ADDRESS,DATA>,pv_response<DATA> >, N>,
+  public pv_initiator_port_base,
+  public virtual pv_tlm_if<ADDRESS,DATA> {
+    
+  typedef pv_request<ADDRESS,DATA> request_type;
+  typedef pv_response<DATA> response_type;
+
+  typedef tlm::tlm_transport_if<request_type,response_type> interface_type;
+
+  typedef sc_export<interface_type> sc_target_port_type;
+  typedef sc_port<interface_type,N> sc_initiator_port_type;
+
+  typedef pv_target_port<ADDRESS,DATA> pv_target_port_type;
+  typedef pv_initiator_port<ADDRESS,DATA,N> pv_initiator_port_type;
+
+  typedef pv_target_port_base target_port_base_type;
+  typedef pv_initiator_port_base initiator_port_base_type;
+    
+public:
+
+  //--------------
+  // Constructor
+  //--------------
+  pv_initiator_port(const char * port_name);
+
+    
+  //---------------------------------------
+  // Execute the transaction transfer	
+  void do_transport(request_type& request,
+		    response_type& response,
+		    unsigned int target_port_rank = 0);
+
+  //-------------------------------------------------------------------
+  //Abstract class pv_tlm_if methods implementation: used as convenience API
+
+  virtual tlm::tlm_status read(const ADDRESS& address,
+			       DATA& data,
+			       const unsigned int byte_enable = tlm::NO_BE,
+			       const tlm::tlm_mode mode = tlm::REGULAR,
+			       const unsigned int export_id = 0
+			       );
+    
+  virtual tlm::tlm_status write(const ADDRESS& address,
+				const DATA& data,
+				const unsigned int byte_enable = tlm::NO_BE,
+				const tlm::tlm_mode mode = tlm::REGULAR,
+				const unsigned int export_id = 0
+				);  
+
+  //------------------
+  //Additional methods
+  void before_end_of_elaboration();
+  void end_of_elaboration();
+
+  void bind(pv_target_port_type&);
+  void operator() (pv_target_port_type&);
+
+  void bind(sc_port_b<interface_type>&);
+  void operator() (sc_port_b<interface_type>&);
+
+  void bind(interface_type&);
+  void operator() (interface_type&);
+
+protected:
+  bool is_interface_bound_twice(sc_export_base&);
+};
+
+
+
+// Class implementation
+#include "./pv_initiator_port.tpp"
+
+#endif /* _PV_INITIATOR_PORT_H_ */
+
+