ipxact-tools 0.2.0

data/lib/ipxact_tools/interrupt_line_detector.rb

@@ -0,0 +1,98 @@
+# Copyright (C) 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 'yaml'
+
+# {IPXACT::Tools::InterruptLineDetector} instances are used for
+# detecting interrupt lines from a data path.
+#
+# @author Guillaume Godet-Bar
+#
+class IPXACT::Tools::InterruptLineDetector
+
+  @@detector_stats = []
+
+  def symbol_probability(symbol, state)
+    port = symbol
+
+    bus_name_p = @@detector_stats[:bus_name_regex].collect {|el| port[:name] =~ el[0] ? el[1] : 0.1}.max
+    bus_library_name_p = @@detector_stats[:bus_library_regex].collect {|el| port[:bus_id].name =~ el[0] ? el[1] : 0.1}.max
+
+    res = nil
+    if state == :int
+      (bus_name_p * bus_library_name_p) / (bus_name_p * bus_library_name_p + (1.0 - bus_name_p) * (1.0 - bus_library_name_p))
+    else
+      ((1.0 - bus_name_p) * (1.0 - bus_library_name_p)) / (bus_name_p * bus_library_name_p + (1.0 - bus_name_p) * (1.0 - bus_library_name_p))
+    end
+  end
+
+  def viterbi(symbol_queue)
+    return [] if symbol_queue.empty?
+
+    current_symbol = symbol_queue.shift
+
+    initial_values = @@detector_stats[:states].inject({}) do |acc, state|
+      acc[state] = {
+        :prob => @@detector_stats[:initial_state][state] * symbol_probability(current_symbol, state),
+        :previous => nil
+      }
+      acc
+    end
+
+    stat_stack = [initial_values]
+
+    @previous = initial_values
+
+    stat_stack += symbol_queue.collect do |symbol|
+      new_states = {}
+      previous_max = @previous.max {|a, b| a[1][:prob] <=> b[1][:prob]}
+      @@detector_stats[:states].inject({}) do |acc, state|
+        stats = @@detector_stats[:states].collect{|o_state| {:prob => previous_max[1][:prob] * @@detector_stats[:transition_matrix][o_state][state] * symbol_probability(symbol, state), :previous => previous_max[0]}}
+        acc[state] = stats.max{|a, b| a[:prob] <=> b[:prob]}
+        new_states[state] = acc[state]
+        acc
+      end
+      @previous = new_states
+    end
+
+    stat_stack
+  end
+
+  def render_seq(viterbi_stack)
+    seq = []
+    stack_el = viterbi_stack.pop
+    while stack_el
+      el = stack_el.max{|a, b| a[1][:prob] <=> b[1][:prob]}
+      seq << el[0]
+      stack_el = viterbi_stack.pop
+    end
+    seq.reverse
+  end
+
+  def self.convert_pairs(pairs)
+    pairs.collect do |pair|
+      regex = Regexp.new(pair[0].gsub(/^\/(.+)\/.?$/, '\1'), pair[0].end_with?('i'))
+      [regex, pair[1]]
+    end
+  end
+
+  if @@detector_stats.empty?
+    @@detector_stats = YAML.load(File.open(File.join(File.dirname(__FILE__), '../../config/detector.yml')).read)
+    @@detector_stats[:bus_name_regex] = convert_pairs(@@detector_stats[:bus_name_regex])
+    @@detector_stats[:bus_library_regex] = convert_pairs(@@detector_stats[:bus_library_regex])
+  end
+
+end

data/spec/integration/integration_spec.rb

@@ -0,0 +1,254 @@
+require File.join File.dirname(__FILE__), '../../lib/ipxact_tools'
+
+PLATFORM_PATH = File.join File.dirname(__FILE__), '../test_data/spiritconsortium.org/Leon2TLM'
+DESIGN_PATH   = File.join File.dirname(__FILE__), '../test_data/spiritconsortium.org/Leon2TLM'
+
+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 = IPXACT::Tools.resolve_data_path(platform, 'i_proc', 'i_dma')
+    }.should_not raise_exception
+    data_path.should eql(expected_data_path)
+  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 = IPXACT::Tools::resolve_data_path(platform, 'i_proc', 'i_dma')
+
+    base_address = IPXACT::Tools::resolve_base_address(platform, 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 = IPXACT::Tools::resolve_data_path(platform, 'i_proc', 'i_cgu')
+
+    base_address = IPXACT::Tools::resolve_base_address(platform, data_path)
+    base_address.should == 0x30004000
+  end
+
+  it "should be able to take into account the component registers' corresponding address block's base address" 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 = IPXACT::Tools::resolve_data_path(platform, 'i_proc', 'i_uart_scml')
+
+    base_address = IPXACT::Tools::resolve_base_address(platform, data_path)
+    port_id = data_path.last[1]
+    component = platform.rec_get_subcomponent('i_uart_scml')
+    port = component.port(port_id[:port_name])
+
+    # N.B. There's a remap address error in the "IP-XACT_TLM_Examples_AppNote_V1.5" document that's 
+    # released with the IP-XACT specification: remap address for the i_uart_scml instance does not match
+    # what is actually in the Leon2Platform file.
+    (base_address + port[:port_data][:base_address].to_i(16)).should == 0x30000000 + 0x2000 + 0xB0000000
+  end
+
+  context "data path validation" do
+    it "should return an empty diagnosis if the given path is valid" do
+      valid_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)
+
+      diagnosis = IPXACT::Tools.validate_data_path(platform, valid_data_path)
+      diagnosis.errors.should be_empty
+      diagnosis.warnings.should be_empty
+    end
+
+    it "should return an error if the first element of the data path is not a master" do
+      first_element = \
+        [
+          {
+            :component_instance => 'i_ahb',
+            :port_name => 'AHB_MirroredSlave1'
+          },
+          {
+            :component_instance => 'i_h2p',
+            :port_name => 'AHB_Slave'
+          }
+        ]
+      incomplete_data_path = [
+        first_element,
+        [
+          {
+            :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)
+
+      diagnosis = IPXACT::Tools.validate_data_path(platform, incomplete_data_path)
+      diagnosis.errors.should_not be_empty
+      diagnosis.errors.should include(IPXACT::Tools::ValidationError.new(:first_element_not_a_master => first_element))
+    end
+
+    it "should be able to discover potential interrupt lines in an interconnect path" do
+      interrupt_line = \
+        [
+          {
+            :component_instance => 'i_dma',
+            :port_name => "INT_Master",
+          },
+          {
+            :component_instance => 'i_sub',
+            :port_name => 'INT_Slave'
+          }
+        ]
+      data_path_with_interrupt = \
+        [
+          [
+            {
+              :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'
+            }
+          ],
+          interrupt_line,
+          [
+            {
+              :component_instance => 'i_proc',
+              :port_name => 'APB_Slave'
+            },
+            {
+              :component_instance => 'i_sub',
+              :port_name => 'APB_MSlave_6'
+            }
+          ]
+        ]
+      components = IPXACT::load_components(PLATFORM_PATH)
+      designs = IPXACT::load_designs(PLATFORM_PATH)
+      platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+
+      diagnosis = IPXACT::Tools.validate_data_path(platform, data_path_with_interrupt)
+      diagnosis.errors.should_not be_empty
+      diagnosis.errors.should include(IPXACT::Tools::ValidationError.new(:probable_interrupt_line => interrupt_line))
+    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_ */
+
+