Skip to content

Commit

Permalink
IR examples in IP-XACT
Browse files Browse the repository at this point in the history
  • Loading branch information
mszalkowski-ant committed Dec 16, 2024
1 parent 7ac377b commit 9f85eb5
Show file tree
Hide file tree
Showing 38 changed files with 4,209 additions and 0 deletions.
557 changes: 557 additions & 0 deletions docs/source/developers_guide/ipxact-design.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,5 @@ developers_guide/examples
developers_guide/future_enhancements
developers_guide/inline_kpm_howto
developers_guide/ir-examples
developers_guide/ipxact-design
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:component xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>adder</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:model>
<ipxact:instantiations>
<ipxact:componentInstantiation>
<ipxact:name>rtl</ipxact:name>
<ipxact:displayName>rtl</ipxact:displayName>
<ipxact:language>Verilog</ipxact:language>
<ipxact:moduleParameters>
<ipxact:moduleParameter parameterId="uuid_2316bf28_4762_47dc_b46c_f9d642f6dd25" resolve="user" type="longint">
<ipxact:name>WIDTH</ipxact:name>
<ipxact:displayName>WIDTH</ipxact:displayName>
<ipxact:value>uuid_8beee66a_d8c9_4181_ab5d_84c3f023121f</ipxact:value>
</ipxact:moduleParameter>
</ipxact:moduleParameters>
</ipxact:componentInstantiation>
</ipxact:instantiations>
<ipxact:ports>
<ipxact:port>
<ipxact:name>a</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
<ipxact:vectors>
<ipxact:vector>
<ipxact:left>uuid_8beee66a_d8c9_4181_ab5d_84c3f023121f-1</ipxact:left>
<ipxact:right>0</ipxact:right>
</ipxact:vector>
</ipxact:vectors>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>b</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
<ipxact:vectors>
<ipxact:vector>
<ipxact:left>uuid_8beee66a_d8c9_4181_ab5d_84c3f023121f-1</ipxact:left>
<ipxact:right>0</ipxact:right>
</ipxact:vector>
</ipxact:vectors>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>sum</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
<ipxact:vectors>
<ipxact:vector>
<ipxact:left>uuid_8beee66a_d8c9_4181_ab5d_84c3f023121f-1</ipxact:left>
<ipxact:right>0</ipxact:right>
</ipxact:vector>
</ipxact:vectors>
</ipxact:wire>
</ipxact:port>
</ipxact:ports>
</ipxact:model>
<ipxact:parameters>
<ipxact:parameter parameterId="uuid_8beee66a_d8c9_4181_ab5d_84c3f023121f" resolve="user" type="longint">
<ipxact:name>paramWIDTH</ipxact:name>
<ipxact:displayName>paramWIDTH</ipxact:displayName>
<ipxact:value>4</ipxact:value>
</ipxact:parameter>
</ipxact:parameters>

</ipxact:component>
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:component xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>d_ff</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:model>
<ipxact:instantiations>
<ipxact:componentInstantiation>
<ipxact:name>rtl</ipxact:name>
<ipxact:moduleParameters>
<ipxact:moduleParameter parameterId="uuid_683ce26c_61ef_422b_bb6c_ed0b084bb083" resolve="user">
<ipxact:name>WIDTH</ipxact:name>
<ipxact:value>uuid_ca41c6da_3afa_4234_90d0_1e1bbbddf75d</ipxact:value>
</ipxact:moduleParameter>
</ipxact:moduleParameters>
</ipxact:componentInstantiation>
</ipxact:instantiations>
<ipxact:ports>
<ipxact:port>
<ipxact:name>clk</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>rst</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
<ipxact:vectors>
<ipxact:vector>
<ipxact:left></ipxact:left>
<ipxact:right></ipxact:right>
</ipxact:vector>
</ipxact:vectors>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>D</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
<ipxact:vectors>
<ipxact:vector>
<ipxact:left>uuid_ca41c6da_3afa_4234_90d0_1e1bbbddf75d-1</ipxact:left>
<ipxact:right>0</ipxact:right>
</ipxact:vector>
</ipxact:vectors>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>Q</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
<ipxact:vectors>
<ipxact:vector>
<ipxact:left>uuid_ca41c6da_3afa_4234_90d0_1e1bbbddf75d-1</ipxact:left>
<ipxact:right>0</ipxact:right>
</ipxact:vector>
</ipxact:vectors>
</ipxact:wire>
</ipxact:port>
</ipxact:ports>
</ipxact:model>
<ipxact:parameters>
<ipxact:parameter parameterId="uuid_ca41c6da_3afa_4234_90d0_1e1bbbddf75d" resolve="user">
<ipxact:name>paramWIDTH</ipxact:name>
<ipxact:displayName>paramWIDTH</ipxact:displayName>
<ipxact:value>4</ipxact:value>
</ipxact:parameter>
</ipxact:parameters>

</ipxact:component>
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:component xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>debouncer</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:model>
<ipxact:instantiations>
<ipxact:componentInstantiation>
<ipxact:name>rtl</ipxact:name>
<ipxact:moduleParameters>
<ipxact:moduleParameter parameterId="uuid_13ea09b9_d57e_45ad_a545_d9553f3782d3" resolve="user">
<ipxact:name>GRACE</ipxact:name>
<ipxact:value>uuid_ac02ea4d_0441_4d05_a057_75c85f832a3f</ipxact:value>
</ipxact:moduleParameter>
</ipxact:moduleParameters>
</ipxact:componentInstantiation>
</ipxact:instantiations>
<ipxact:ports>
<ipxact:port>
<ipxact:name>clk</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>in</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>
</ipxact:port>
<ipxact:port>
<ipxact:name>filtered_out</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
</ipxact:wire>
</ipxact:port>
</ipxact:ports>
</ipxact:model>
<ipxact:parameters>
<ipxact:parameter parameterId="uuid_ac02ea4d_0441_4d05_a057_75c85f832a3f" resolve="user">
<ipxact:name>paramGRACE</ipxact:name>
<ipxact:value>1000</ipxact:value>
</ipxact:parameter>
</ipxact:parameters>

</ipxact:component>
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:component xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>encoder</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:model>
<ipxact:views>
<ipxact:view>
<ipxact:name>hierarchical</ipxact:name>
<ipxact:designConfigurationInstantiationRef>_design_configuration</ipxact:designConfigurationInstantiationRef>
</ipxact:view>
</ipxact:views>
<ipxact:instantiations>
<ipxact:designConfigurationInstantiation>
<ipxact:name>_design_configuration</ipxact:name>
<ipxact:designConfigurationRef vendor="antmicro.com" library="hierarchical" name="encoder.designcfg" version="1.0"/>
</ipxact:designConfigurationInstantiation>
</ipxact:instantiations>
<ipxact:ports>
<ipxact:port>
<ipxact:name>number</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>

</ipxact:port>
<ipxact:port>
<ipxact:name>clk</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>

</ipxact:port>
<ipxact:port>
<ipxact:name>enc0</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
</ipxact:wire>

</ipxact:port>
<ipxact:port>
<ipxact:name>enc1</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
</ipxact:wire>

</ipxact:port>
<ipxact:port>
<ipxact:name>enc2</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
</ipxact:wire>

</ipxact:port>
</ipxact:ports>
</ipxact:model>

</ipxact:component>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>encoder.design</ipxact:name>
<ipxact:version>1.0</ipxact:version>

</ipxact:design>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:designConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>encoder.designcfg</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:designRef vendor="antmicro.com" library="hierarchical" name="encoder.design" version="1.0"/>

</ipxact:designConfiguration>
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:component xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>four_bit_counter</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:model>
<ipxact:views>
<ipxact:view>
<ipxact:name>hierarchical</ipxact:name>
<ipxact:designConfigurationInstantiationRef>_design_configuration</ipxact:designConfigurationInstantiationRef>
</ipxact:view>
</ipxact:views>
<ipxact:instantiations>
<ipxact:designConfigurationInstantiation>
<ipxact:name>_design_configuration</ipxact:name>
<ipxact:designConfigurationRef vendor="antmicro.com" library="hierarchical" name="four_bit_counter.designcfg" version="1.0"/>
</ipxact:designConfigurationInstantiation>
</ipxact:instantiations>
<ipxact:ports>
<ipxact:port>
<ipxact:name>impulse</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>

</ipxact:port>
<ipxact:port>
<ipxact:name>rst</ipxact:name>
<ipxact:wire>
<ipxact:direction>in</ipxact:direction>
</ipxact:wire>

</ipxact:port>
<ipxact:port>
<ipxact:name>sum</ipxact:name>
<ipxact:wire>
<ipxact:direction>out</ipxact:direction>
</ipxact:wire>

</ipxact:port>
</ipxact:ports>
</ipxact:model>

</ipxact:component>
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>four_bit_counter.design</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:componentInstances>
<ipxact:componentInstance>
<ipxact:instanceName>d_ff_0</ipxact:instanceName>
<ipxact:componentRef vendor="antmicro.com" library="hierarchical" name="d_ff" version="1.0"/>

</ipxact:componentInstance>
<ipxact:componentInstance>
<ipxact:instanceName>adder_0</ipxact:instanceName>
<ipxact:componentRef vendor="antmicro.com" library="hierarchical" name="adder" version="1.0"/>

</ipxact:componentInstance>
</ipxact:componentInstances>
<ipxact:adHocConnections>
<ipxact:adHocConnection>
<ipxact:name>d_ff_0_D_to_adder_0_sum</ipxact:name>
<ipxact:portReferences>
<ipxact:internalPortReference componentInstanceRef="d_ff_0" portRef="D"/>
<ipxact:internalPortReference componentInstanceRef="adder_0" portRef="sum"/>
</ipxact:portReferences>
</ipxact:adHocConnection>
<ipxact:adHocConnection>
<ipxact:name>d_ff_0_Q_to_sum</ipxact:name>
<ipxact:portReferences>
<ipxact:internalPortReference componentInstanceRef="d_ff_0" portRef="Q"/>
<ipxact:externalPortReference portRef="sum"/>
</ipxact:portReferences>
</ipxact:adHocConnection>
<ipxact:adHocConnection>
<ipxact:name>d_ff_0_clk_to_impulse</ipxact:name>
<ipxact:portReferences>
<ipxact:internalPortReference componentInstanceRef="d_ff_0" portRef="clk"/>
<ipxact:externalPortReference portRef="impulse"/>
</ipxact:portReferences>
</ipxact:adHocConnection>
<ipxact:adHocConnection>
<ipxact:name>d_ff_0_rst_to_rst</ipxact:name>
<ipxact:portReferences>
<ipxact:internalPortReference componentInstanceRef="d_ff_0" portRef="rst"/>
<ipxact:externalPortReference portRef="rst"/>
</ipxact:portReferences>
</ipxact:adHocConnection>
<ipxact:adHocConnection>
<ipxact:name>adder_0_a_to_d_ff_0_Q</ipxact:name>
<ipxact:portReferences>
<ipxact:internalPortReference componentInstanceRef="adder_0" portRef="a"/>
<ipxact:internalPortReference componentInstanceRef="d_ff_0" portRef="Q"/>
</ipxact:portReferences>
</ipxact:adHocConnection>
<ipxact:adHocConnection>
<ipxact:name>adder_0_b_to_impulse</ipxact:name>
<ipxact:portReferences>
<ipxact:internalPortReference componentInstanceRef="adder_0" portRef="b"/>
<ipxact:externalPortReference portRef="impulse"/>
</ipxact:portReferences>
</ipxact:adHocConnection>
</ipxact:adHocConnections>

</ipxact:design>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<ipxact:designConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ipxact="http://www.accellera.org/XMLSchema/IPXACT/1685-2022" xsi:schemaLocation="http://www.accellera.org/XMLSchema/IPXACT/1685-2022 http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd">
<ipxact:vendor>antmicro.com</ipxact:vendor>
<ipxact:library>hierarchical</ipxact:library>
<ipxact:name>four_bit_counter.designcfg</ipxact:name>
<ipxact:version>1.0</ipxact:version>
<ipxact:designRef vendor="antmicro.com" library="hierarchical" name="four_bit_counter.design" version="1.0"/>

</ipxact:designConfiguration>
Loading

0 comments on commit 9f85eb5

Please sign in to comment.