ipxact-tools 0.2.0

data/spec/test_data/spiritconsortium.org/Leon2TLM/uart_tac/1.0/tlmsrc/src/user_specific_Leon2_uart.cc

@@ -0,0 +1,146 @@
+// 
+// Revision:    $Revision: 1506 $
+// Date:        $Date: 2009-04-26 01:51:56 -0500 (Sun, 26 Apr 2009) $
+// 
+// Copyright (c) 2005, 2006, 2007, 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; this notice must be included on any copy.
+
+/* -----------------------------------------------------------------------
+ * Includes
+ * ----------------------------------------------------------------------- */
+
+#include "systemc.h"                              /* SystemC include file */
+#include "Leon2_uart.h"
+
+#include "def_Leon2_uart.h"
+
+namespace Leon2 {
+
+  /* -----------------------------------------------------------------------
+   * define the method and thread sensitivity and the end of the constructor
+   * ----------------------------------------------------------------------- */
+
+  void uart::method_and_thread_sensitivity()
+  {
+  }
+
+
+  /***************************************************************************
+   * \brief   Slave read_block Interface
+   **************************************************************************/
+
+  
+  prt_tlm_tac::tac_status uart::read_block(const tlm_uint32_t & address_tlmske,
+                                                 tlm_uint32_t * block_data_tlmske,
+                                                 const unsigned int number,
+                                                 prt_tlm_tac::tac_error_reason& error_reason,
+                                                 unsigned int * block_byte_enable,
+                                                 const unsigned int block_byte_enable_period,
+                                                 const prt_tlm_tac::tac_mode mode,
+                                                 const unsigned int target_port_id
+                                                 ) {
+    prt_tlm_tac::tac_status status_tlmske;
+
+    switch(target_port_id)
+    {
+
+      case Leon2_uart_ambaAPB_ID:
+        DEBUG_REPORT(3,"\ttarget_port_id = Leon2_uart_ambaAPB_ID\n");
+        break;
+
+      default:
+        status_tlmske.set_error();
+        error_reason.set_reason("Error,  no businterface at that ID ");
+        string msg_tlmske = "Error, can not write at address ";
+        ERROR_REPORT(2,"\t%s: %s 0x%X T:%9.9f\n",
+                     name(),msg_tlmske.c_str(),(unsigned int)address_tlmske,(float)(sc_time_stamp().to_seconds()));
+        break;
+    }
+  }
+
+  /***************************************************************************
+   * \brief   Slave write_block Interface
+   **************************************************************************/
+
+  
+  prt_tlm_tac::tac_status uart::write_block(const tlm_uint32_t& address_tlmske,
+                                                  const tlm_uint32_t * block_data_tlmske,
+                                                  const unsigned int number,
+                                                  prt_tlm_tac::tac_error_reason& error_reason,
+                                                  unsigned int * block_byte_enable,
+                                                  const unsigned int block_byte_enable_period,
+                                                  const prt_tlm_tac::tac_mode mode,
+                                                  const unsigned int target_port_id
+                                                  ) {
+    prt_tlm_tac::tac_status status_tlmske;
+
+    switch(target_port_id)
+    {
+
+      case Leon2_uart_ambaAPB_ID:
+        DEBUG_REPORT(3,"\ttarget_port_id = Leon2_uart_ambaAPB_ID\n");
+        break;
+
+      default:
+        status_tlmske.set_error();
+        error_reason.set_reason("Error, no businterface at that ID ");
+        string msg_tlmske = "Error, can not write at address ";
+        ERROR_REPORT(2,"\t%s: %s 0x%X T:%9.9f\n",
+                     name(),msg_tlmske.c_str(),(unsigned int)address_tlmske,(float)(sc_time_stamp().to_seconds()));
+        break;
+    }
+  };
+
+  /***************************************************************************
+   * \brief   Slave set_target_info Interface
+   **************************************************************************/
+
+  
+  prt_tlm_tac::tac_status uart::set_target_info(const tlm_uint32_t& address_tlmske,
+                                                      const prt_tlm_tac::tac_metadata& metadata,
+                                                      prt_tlm_tac::tac_error_reason& error_reason,
+                                                      const unsigned int target_port_id
+                                                      ) {
+    prt_tlm_tac::tac_status status_tlmske;
+
+    switch(target_port_id)
+    {
+
+      case Leon2_uart_ambaAPB_ID:
+        error_reason.set_reason("set info for port ID : Leon2_uart_ambaAPB_ID using metadata not supported");
+        ERROR_REPORT(2,"\t%s: %s T:%9.9f\n",
+                     name(),error_reason.get_reason().c_str(),
+                     (float)(sc_time_stamp().to_seconds()));
+        status_tlmske.set_error();
+        break;
+
+      default:
+        status_tlmske.set_error();
+        break;
+    }
+
+    DEBUG_REPORT(3,"\t%s: set_target_info at 0x%X T:%9.9f\n", 
+                 name(),(unsigned int)address_tlmske,(float)(sc_time_stamp().to_seconds()));
+
+    return(status_tlmske);
+  }
+
+}                                                 // end namespace Leon2

data/spec/test_data/spiritconsortium.org/Leon2TLM/uart_tac/1.0/uart_tac.xml

@@ -0,0 +1,222 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+// 
+// Revision:    $Revision: 1506 $
+// Date:        $Date: 2009-04-26 01:51:56 -0500 (Sun, 26 Apr 2009) $
+// 
+// Copyright (c) 2005, 2006, 2007, 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 this notice must be included on any copy.
+-->
+<spirit:component xmlns:spirit="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5 http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5/index.xsd">
+  <spirit:vendor>spiritconsortium.org</spirit:vendor>
+  <spirit:library>Leon2TLM</spirit:library>
+  <spirit:name>uart_tac</spirit:name>
+  <spirit:version>1.0</spirit:version>
+  <spirit:busInterfaces>
+    <spirit:busInterface>
+      <spirit:name>ambaAPB</spirit:name>
+      <spirit:busType spirit:library="AMBA2" spirit:name="APB" spirit:vendor="amba.com" spirit:version="r2p0_4"/>
+      <spirit:abstractionType spirit:library="SPG" spirit:name="tlm_tac" spirit:vendor="st.com" spirit:version="2.0"/>
+      <spirit:slave>
+        <spirit:memoryMapRef spirit:memoryMapRef="ambaAPB"/>
+      </spirit:slave>
+      <spirit:portMaps>
+        <spirit:portMap>
+          <spirit:logicalPort>
+            <spirit:name>tac_if</spirit:name>
+          </spirit:logicalPort>
+          <spirit:physicalPort>
+            <spirit:name>ambaAPB</spirit:name>
+          </spirit:physicalPort>
+        </spirit:portMap>
+      </spirit:portMaps>
+    </spirit:busInterface>
+  </spirit:busInterfaces>
+  <spirit:memoryMaps>
+    <spirit:memoryMap>
+      <spirit:name>ambaAPB</spirit:name>
+      <spirit:addressBlock>
+        <spirit:name>ambaAPB</spirit:name>
+        <spirit:baseAddress>0</spirit:baseAddress>
+        <spirit:range>24</spirit:range>
+        <spirit:width>32</spirit:width>
+        <spirit:usage>register</spirit:usage>
+        <spirit:register>
+          <spirit:name>data</spirit:name>
+          <spirit:description>Data read/write register</spirit:description>
+          <spirit:addressOffset>0x0</spirit:addressOffset>
+          <spirit:size>32</spirit:size>
+          <spirit:access>read-write</spirit:access>
+          <spirit:reset>
+            <spirit:value>0x0</spirit:value>
+          </spirit:reset>
+        </spirit:register>
+        <spirit:register>
+          <spirit:name>status</spirit:name>
+          <spirit:description>Status register</spirit:description>
+          <spirit:addressOffset>0x4</spirit:addressOffset>
+          <spirit:size>32</spirit:size>
+          <spirit:access>read-only</spirit:access>
+          <spirit:reset>
+            <spirit:value>0x6</spirit:value>
+          </spirit:reset>
+        </spirit:register>
+        <spirit:register>
+          <spirit:name>control</spirit:name>
+          <spirit:description>Control register</spirit:description>
+          <spirit:addressOffset>0x8</spirit:addressOffset>
+          <spirit:size>32</spirit:size>
+          <spirit:access>read-write</spirit:access>
+          <spirit:reset>
+            <spirit:value>0x0</spirit:value>
+          </spirit:reset>
+        </spirit:register>
+        <spirit:register>
+          <spirit:name>scalarReload</spirit:name>
+          <spirit:description>Scalar reload register</spirit:description>
+          <spirit:addressOffset>0xC</spirit:addressOffset>
+          <spirit:size>32</spirit:size>
+          <spirit:access>read-write</spirit:access>
+          <spirit:reset>
+            <spirit:value>0x0</spirit:value>
+          </spirit:reset>
+        </spirit:register>
+      </spirit:addressBlock>
+    </spirit:memoryMap>
+  </spirit:memoryMaps>
+  <spirit:model>
+    <spirit:views>
+      <spirit:view>
+        <spirit:name>PV</spirit:name>
+        <spirit:envIdentifier>systemCSource::</spirit:envIdentifier>
+        <spirit:language>systemCSource</spirit:language>
+        <spirit:modelName>Leon2::uart</spirit:modelName>
+        <spirit:fileSetRef>
+          <spirit:localName>fs-scSource</spirit:localName>
+        </spirit:fileSetRef>
+      </spirit:view>
+    </spirit:views>
+    <spirit:ports>
+      <spirit:port>
+        <spirit:name>ambaAPB</spirit:name>
+        <spirit:transactional>
+          <spirit:transTypeDef>
+            <spirit:typeName>prt_tlm_tac::tac_target_port</spirit:typeName>
+            <spirit:typeDefinition>tac_target_port.h</spirit:typeDefinition>
+          </spirit:transTypeDef>
+          <spirit:service>
+            <spirit:initiative>provides</spirit:initiative>
+            <spirit:serviceTypeDefs>
+              <spirit:serviceTypeDef>
+                <spirit:typeName spirit:implicit="true">TAC</spirit:typeName>
+                <spirit:parameters>
+                  <spirit:parameter>
+                    <spirit:name>BFM_ADDRESS_TYPE</spirit:name>
+                    <spirit:value spirit:resolve="immediate">tlm_uint32_t</spirit:value>
+                  </spirit:parameter>
+                  <spirit:parameter>
+                    <spirit:name>BFM_DATA_TYPE</spirit:name>
+                    <spirit:value spirit:resolve="immediate">tlm_uint32_t</spirit:value>
+                  </spirit:parameter>
+                </spirit:parameters>
+              </spirit:serviceTypeDef>
+            </spirit:serviceTypeDefs>
+          </spirit:service>
+        </spirit:transactional>
+        <spirit:access>
+          <spirit:portAccessType>ref</spirit:portAccessType>
+          <spirit:portAccessHandle>ambaAPB</spirit:portAccessHandle>
+        </spirit:access>
+      </spirit:port>
+    </spirit:ports>
+    <spirit:modelParameters>
+      <spirit:modelParameter spirit:dataType="sc_module_name" spirit:usageType="nontyped">
+        <spirit:name>module_name</spirit:name>
+        <spirit:value spirit:id="moduleName_id" spirit:resolve="generated" spirit:configGroups="requiredConfig" spirit:format="string" spirit:prompt="module name"/>
+      </spirit:modelParameter>
+      <spirit:modelParameter spirit:dataType="bool" spirit:usageType="nontyped">
+        <spirit:name>resetOnInitialize</spirit:name>
+        <spirit:value spirit:id="resetOnInitialize_id" spirit:resolve="user" spirit:configGroups="requiredConfig" spirit:format="bool" spirit:prompt="whether reset() should be invoked at startup time">true</spirit:value>
+      </spirit:modelParameter>
+      <spirit:modelParameter spirit:dataType="unsigned int" spirit:usageType="nontyped">
+        <spirit:name>debug_level</spirit:name>
+        <spirit:value spirit:id="debug_level_id" spirit:resolve="user" spirit:configGroups="requiredConfig" spirit:format="long" spirit:prompt="debug level">0</spirit:value>
+      </spirit:modelParameter>
+      <spirit:modelParameter spirit:dataType="tlm_endianness endianness" spirit:usageType="nontyped">
+        <spirit:name>endianness</spirit:name>
+        <spirit:value spirit:id="endianness_id" spirit:resolve="user" spirit:choiceRef="endianness" spirit:configGroups="requiredConfig" spirit:prompt="use specific endianness">TLM_BIG_ENDIAN</spirit:value>
+      </spirit:modelParameter>
+    </spirit:modelParameters>
+  </spirit:model>
+  <spirit:choices>
+    <spirit:choice>
+      <spirit:name>endianness</spirit:name>
+      <spirit:enumeration spirit:text="TLM_BIG_ENDIAN">TLM_BIG_ENDIAN</spirit:enumeration>
+      <spirit:enumeration spirit:text="TLM_LITTLE_ENDIAN">TLM_LITTLE_ENDIAN</spirit:enumeration>
+      <spirit:enumeration spirit:text="TLM_HOST_ENDIAN">TLM_HOST_ENDIAN</spirit:enumeration>
+    </spirit:choice>
+  </spirit:choices>
+  <spirit:fileSets>
+    <spirit:fileSet>
+      <spirit:name>fs-scSource</spirit:name>
+      <spirit:file>
+        <spirit:name>./tlmsrc/src/Leon2_uart.cpp</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:dependency>./include</spirit:dependency>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/src/tlmreg_Leon2_uart.cpp</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:dependency>./include</spirit:dependency>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/src/user_specific_Leon2_uart.cpp</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:dependency>./include</spirit:dependency>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/include/Leon2_uart.h</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:isIncludeFile spirit:externalDeclarations="true">true</spirit:isIncludeFile>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/include/def_Leon2_uart.h</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:isIncludeFile>true</spirit:isIncludeFile>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/include/tlmreg_Leon2_uart.h</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:isIncludeFile>true</spirit:isIncludeFile>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/include/tlm_field.h</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:isIncludeFile>true</spirit:isIncludeFile>
+      </spirit:file>
+      <spirit:file>
+        <spirit:name>./tlmsrc/include/tlm_register.h</spirit:name>
+        <spirit:fileType>systemCSource</spirit:fileType>
+        <spirit:isIncludeFile>true</spirit:isIncludeFile>
+      </spirit:file>
+    </spirit:fileSet>
+  </spirit:fileSets>
+</spirit:component>

data/spec/unit/graph_pathfinder_spec.rb

@@ -0,0 +1,128 @@
+# Copyright (C) 2010, 2011 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_tools'
+
+
+describe IPXACT::Tools::GraphPathFinder do
+
+  before(:each) do
+      @simple_graph = {
+        :nodes => ['component_a', 'component_b', 'component_c',
+                   'component_d'],
+        :connections =>
+          [
+            {:link => [0,1], :via => 'connect_1'},
+            {:link => [1,2], :via => 'connect_2'},
+            {:link => [2,0], :via => 'connect_3.1'},
+            {:link => [2,3], :via => 'connect_3.2'}
+          ]
+      }
+
+      @complete_graph = {
+        :nodes => ['i_proc', 'i_ahb', 'i_dma', 'i_sub', 'i_mem',
+                   'i_cgu', 'i_rgu'],
+        :connections =>
+          [
+            {:link => [0,1], :via => 'connect_1'},
+            {:link => [2,1], :via => 'connect_2'},
+            {:link => [1,4], :via => 'connect_3'},
+            {:link => [1,3], :via => 'connect_4'},
+            {:link => [3,0], :via => 'connect_5'},
+            {:link => [3,5], :via => 'connect_6'},
+            {:link => [3,6], :via => 'connect_7'},
+            {:link => [3,2], :via => 'connect_8'}
+          ]
+      }
+
+      @cheapest_path_graph = {
+        :nodes => ['component_a', 'component_b', 'component_c',
+                   'component_d'],
+        :connections =>
+          [
+            {:link => [0,1], :via => 'connect_1'},
+            {:link => [1,2], :cost => 8, :via => 'connect_expensive'},
+            {:link => [2,3], :via => 'connect_2'},
+            {:link => [1,3], :cost => 9, :via => 'connect_cheaper'}
+          ]
+      }
+  end
+
+  context "incorrect graph/arguments" do
+    it "should return an exception when the graph is empty" do
+      finder = IPXACT::Tools::GraphPathFinder.new({})
+      lambda {
+        finder.resolve('component_a', 'component_b')
+      }.should raise_exception
+    end
+
+    it "should return an exception if any component is not unique" do
+      @simple_graph[:nodes][1] = 'component_a'
+      finder = IPXACT::Tools::GraphPathFinder.new @simple_graph
+      lambda {
+        finder.resolve('component_a', 'component_c')
+      }.should raise_exception
+    end
+
+    it "should return an exception if the source or target component does not exist" do
+      finder = IPXACT::Tools::GraphPathFinder.new @simple_graph
+      lambda {
+        finder.resolve('component_a', 'component_z')
+      }.should raise_exception
+      lambda {
+        finder.resolve('component_z', 'component_a')
+      }.should raise_exception
+    end
+
+  end
+
+  context "graph pathfinding" do
+    it "should return an empty array if the source equals the destination" do
+      finder = IPXACT::Tools::GraphPathFinder.new @simple_graph
+      finder.resolve('component_a', 'component_a').should eql([])
+    end
+
+    it "should return an array with a single element if the source is right next to the destination" do
+      finder = IPXACT::Tools::GraphPathFinder.new(@simple_graph)
+      finder.resolve('component_a', 'component_b').should eql([0])
+      finder.resolve('component_c', 'component_a').should eql([2])
+    end
+
+    it "should raise an exception if the destination cannot be reached" do
+      finder = IPXACT::Tools::GraphPathFinder.new(@simple_graph)
+      lambda {
+        finder.resolve('component_d', 'component_a')
+      }.should raise_exception
+    end
+
+    it "should return a correct path from a simple graph" do
+      finder = IPXACT::Tools::GraphPathFinder.new(@simple_graph)
+      finder.resolve('component_a', 'component_d').should eql([0,1,3])
+    end
+
+    it "should be able to favor a cheaper path" do
+      finder = IPXACT::Tools::GraphPathFinder.new(@cheapest_path_graph)
+      finder.resolve('component_a', 'component_d').should eql([0,3])
+    end
+
+    it "should return a correct path from a realistic connection graph" do
+      finder = IPXACT::Tools::GraphPathFinder.new(@complete_graph)
+      finder.resolve('i_proc', 'i_dma').should eql([0,3,7])
+      finder.resolve('i_dma', 'i_proc').should eql([1,3,4])
+    end
+
+  end
+end