ipxact-ruby 0.11.2 → 0.12.0

data/VERSION

@@ -1 +1 @@
-0.11.2
+0.12.0

data/lib/ipxact.rb

@@ -259,5 +259,6 @@ end
 
 require File.join File.dirname(__FILE__), 'ipxact/parser'
 require File.join File.dirname(__FILE__), 'ipxact/platform'
+require File.join File.dirname(__FILE__), 'ipxact/register'
 require File.join File.dirname(__FILE__), 'ipxact/pathfinder/graph_pathfinder'
 

data/lib/ipxact/parser/bus_data_parser.rb

@@ -188,6 +188,15 @@ private
   #                       :access - The register's access (read-write,
   #                                 read-only, write-only etc.), expressed as
   #                                 a String.
+  #                       field_map - The list of register fields, if any. A
+  #                                   field is composed of:
+  #                                   :name       - The field's name.
+  #                                   :bitOffset  - The field's offset.
+  #                                   :bitWidth   - The field's width.
+  #                                   :access     - The field's access (read-
+  #                                                 write, read-only, write-
+  #                                                 only, etc.), expressed 
+  #                                                 as a String.
   #
   def self.extract_slave_data(bus_doc, host_component)
     memory_map_ref = bus_doc.xpath("./spirit:slave/spirit:memoryMapRef")
@@ -203,12 +212,23 @@ private
         
         registers_doc = address_block.xpath("./spirit:register")
         registers = registers_doc.collect do |register_doc|
-          {
-            :name => register_doc.xpath("./spirit:name").text,
-            :offset => register_doc.xpath("./spirit:addressOffset").text,
-            :size => register_doc.xpath("./spirit:size").text,
-            :access => register_doc.xpath("./spirit:access").text
-          }
+          register = IPXACT::Register.new
+          register[:name] = register_doc.xpath("./spirit:name").text
+          register[:offset] = register_doc.xpath("./spirit:addressOffset").text
+          register[:size] = register_doc.xpath("./spirit:size").text
+          register[:access] = register_doc.xpath("./spirit:access").text
+
+          fields_doc = register_doc.xpath("./spirit:field")
+          register.field_map = fields_doc.collect do |field_doc|
+            {
+              :name       => field_doc.xpath('./spirit:name').text,
+              :bitOffset  => field_doc.xpath('./spirit:bitOffset').text,
+              :bitWidth   => field_doc.xpath('./spirit:bitWidth').text,
+              :access     => field_doc.xpath('./spirit:access').text
+            }
+          end
+
+          register
         end
 
         address_block_data = {

data/lib/ipxact/register.rb

@@ -0,0 +1,26 @@
+# 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/>.
+#
+
+# A {IPXACT::Register} holds the data relative to a component's registers. Most
+# of the data is represented as a Ruby Hash, except for the registers's
+# field_map, which corresponds to an array of Hashes.
+#
+# @author Guillaume Godet-Bar
+#
+class IPXACT::Register < Hash
+  attr_accessor :field_map
+
+end

data/spec/unit/component_spec.rb

@@ -72,7 +72,61 @@ describe IPXACT::Component do
         :access => 'read-write'
       }
     )
+  end
+
+  it "should return an empty set if the current register has no field map" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+
+    dma = platform.components['i_dma']
+    dma.should_not be_nil
+    
+    registers = dma.register_map
+    registers.should include(
+      {
+        :name   => 'sourceAddress',
+        :offset => '0x0',
+        :size   => '32',
+        :access => 'read-write'
+      }
+    )
+
+    source_address_register = registers.select{|r| r[:name] == 'sourceAddress'}.first
+    source_address_register.field_map.should be_empty
+  end
+
+  it "should be able to get the bit fields for the 'control' register of a given dma device" do
+    components = IPXACT::load_components(PLATFORM_PATH)
+    designs = IPXACT::load_designs(PLATFORM_PATH)
+    platform = IPXACT::Parser::PlatformData.parse_platform(["Leon2Platform", "1.1"], components, designs)
+
+    dma = platform.components['i_dma']
+    dma.should_not be_nil
     
+    registers = dma.register_map
+    registers.should include(
+      {
+        :name   => 'control',
+        :offset => '0x8',
+        :size   => '32',
+        :access => 'read-write'
+      }
+    )
+
+    control_register = registers.select{|r| r[:name] == 'control'}.first
+    control_register.should_not be_nil
+    control_register.should be_a(IPXACT::Register)
+
+    fields = control_register.field_map
+    fields.should include(
+      {
+        :name       => 'enable',
+        :bitOffset  => '12',
+        :bitWidth   => '1',
+        :access     => 'write-only'
+      }
+    )
   end
 
   it "should raise an exception if the component has no register map" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 11
-  - 2
-  version: 0.11.2
+  - 12
+  - 0
+  version: 0.12.0
 platform: ruby
 authors: 
 - Guillaume Godet-Bar
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-14 00:00:00 +02:00
+date: 2010-11-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - lib/ipxact/parser/platform_data_parser.rb
 - lib/ipxact/pathfinder/graph_pathfinder.rb
 - lib/ipxact/platform.rb
+- lib/ipxact/register.rb
 - schemas/abstractionDefinition.xsd
 - schemas/abstractor.xsd
 - schemas/autoConfigure.xsd