deploy: 532d078

api_html/_sources/hwip.rst.txt

@@ -13,11 +13,33 @@ cmake.hwip
    This function is a wrapper around the cmake built-in
    `add_library() <https://cmake.org/cmake/help/latest/command/add_library.html>`_ function.
    It generates the library name using the vendor, library, name, and version (VLNV) information passed
-   in arguments (see get_ipname()). It creates two alias libraries to the default <vendor>__<library>__<name>__<version>:
+   in arguments (see create_ip_vlnv()). It creates two alias libraries to the default <vendor>__<library>__<name>__<version>:
 
    * <vendor>::<library>::<name>::<version> ('__' replaced by '::')
    * <vendor>::<library>::<name> (short name without the version)
 
+   This function can be used in FULL and SHORT form:
+   Full form:
+   ```
+   add_ip(ip
+       VENDOR vendor
+       LIBRARY lib
+       VERSION 1.2.3
+       )
+   ```
+   In full form it is possible to ommit VENDOR, LIBRARY and VERSION, although it is not recommended.
+
+   Ommiting them all would have following signature:
+   ```
+   add_ip(ip2)
+   ```
+
+   Short form:
+   ```
+   add_ip(vendor2::lib2::ip2::1.2.2)
+   ```
+   In short form only the full VLNV format is accepted
+
    :param IP_NAME: The name of the IP.
    :type IP_NAME: string
 
@@ -32,7 +54,7 @@ cmake.hwip
 
 
 
-.. function:: get_ipname(OUTVAR IP_NAME **kwargs)
+.. function:: create_ip_vlnv(OUTVAR IP_NAME **kwargs)
 
    This function creates an IP name provided vendor, library, name, and version (VLNV) information.
 
@@ -57,6 +79,31 @@ cmake.hwip
 
 
 
+.. function:: parse_ip_vlnv(IP_VLNV VENDOR LIBRARY IP_NAME VERSION **kwargs)
+
+   This function parses IP name from the VLNV format e.g. (vendor::lib::ip::0.0.1)
+
+   This functions appends the vendor, library, name, and version (VLNV) information separated by '__'
+   to create a unique string representing an IP name. This string is used as the library name when
+   when calling the cmake built-in
+   `add_library() <https://cmake.org/cmake/help/latest/command/add_library.html>`_ function (see add_ip()).
+
+   :param OUTVAR: The generate IP name.
+   :type OUTVAR: string
+   :param IP_NAME: The name of the IP.
+   :type IP_NAME: string
+
+   **Keyword Arguments**
+
+   :keyword VENDOR: Name of the IP vendor.
+   :type VENDOR: string
+   :keyword LIBRARY: Name of the IP library.
+   :type LIBRARY: string
+   :keyword VERSION: Version of the IP following a three-part version number (Major.Minor.Patch, e.g., 1.0.13).
+   :type VERSION: string
+
+
+
 .. function:: ip_assume_last(VLNV IP_NAME)
 
 

api_html/genindex.html

@@ -322,6 +322,8 @@ <h2 id="C">C</h2>
       <li><a href="utils/socmake_graph.html#cmake.utils-socmake_graph.compare_lists">compare_lists() (in module cmake.utils/socmake_graph)</a>
 </li>
       <li><a href="utils/copy_rtl_files/copy_rtl_files.html#cmake.utils-copy_rtl_files-copy_rtl_files.copy_rtl_files">copy_rtl_files() (in module cmake.utils/copy_rtl_files/copy_rtl_files)</a>
+</li>
+      <li><a href="hwip.html#cmake.hwip.create_ip_vlnv">create_ip_vlnv() (in module cmake.hwip)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -364,8 +366,6 @@ <h2 id="G">G</h2>
       <li><a href="hwip.html#cmake.hwip.get_ip_property">get_ip_property() (in module cmake.hwip)</a>
 </li>
       <li><a href="hwip.html#cmake.hwip.get_ip_sources">get_ip_sources() (in module cmake.hwip)</a>
-</li>
-      <li><a href="hwip.html#cmake.hwip.get_ipname">get_ipname() (in module cmake.hwip)</a>
 </li>
       <li><a href="synth/sv2v.html#cmake.synth-sv2v.get_sv2v_sources">get_sv2v_sources() (in module cmake.synth/sv2v)</a>
 </li>
@@ -490,18 +490,20 @@ <h2 id="O">O</h2>
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="hwip.html#cmake.hwip.parse_ip_vlnv">parse_ip_vlnv() (in module cmake.hwip)</a>
+</li>
       <li><a href="peakrdl/peakrdl_docusaurus.html#cmake.peakrdl-peakrdl_docusaurus.peakrdl_docusaurus">peakrdl_docusaurus() (in module cmake.peakrdl/peakrdl_docusaurus)</a>
 </li>
       <li><a href="peakrdl/peakrdl_halcpp.html#cmake.peakrdl-peakrdl_halcpp.peakrdl_halcpp">peakrdl_halcpp() (in module cmake.peakrdl/peakrdl_halcpp)</a>
 </li>
       <li><a href="peakrdl/peakrdl_html/peakrdl_html.html#cmake.peakrdl-peakrdl_html-peakrdl_html.peakrdl_html">peakrdl_html() (in module cmake.peakrdl/peakrdl_html/peakrdl_html)</a>
 </li>
       <li><a href="peakrdl/peakrdl_html/peakrdl_html_md.html#cmake.peakrdl-peakrdl_html-peakrdl_html_md.peakrdl_html_md">peakrdl_html_md() (in module cmake.peakrdl/peakrdl_html/peakrdl_html_md)</a>
-</li>
-      <li><a href="peakrdl/peakrdl_ipblocksvg.html#cmake.peakrdl-peakrdl_ipblocksvg.peakrdl_ipblocksvg">peakrdl_ipblocksvg() (in module cmake.peakrdl/peakrdl_ipblocksvg)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="peakrdl/peakrdl_ipblocksvg.html#cmake.peakrdl-peakrdl_ipblocksvg.peakrdl_ipblocksvg">peakrdl_ipblocksvg() (in module cmake.peakrdl/peakrdl_ipblocksvg)</a>
+</li>
       <li><a href="peakrdl/peakrdl_print.html#cmake.peakrdl-peakrdl_print.peakrdl_print">peakrdl_print() (in module cmake.peakrdl/peakrdl_print)</a>
 </li>
       <li><a href="peakrdl/peakrdl_regblock.html#cmake.peakrdl-peakrdl_regblock.peakrdl_regblock">peakrdl_regblock() (in module cmake.peakrdl/peakrdl_regblock)</a>

api_html/hwip.html

@@ -40,11 +40,32 @@
 <p>This function is a wrapper around the cmake built-in
 <a class="reference external" href="https://cmake.org/cmake/help/latest/command/add_library.html">add_library()</a> function.
 It generates the library name using the vendor, library, name, and version (VLNV) information passed
-in arguments (see get_ipname()). It creates two alias libraries to the default &lt;vendor&gt;__&lt;library&gt;__&lt;name&gt;__&lt;version&gt;:</p>
+in arguments (see create_ip_vlnv()). It creates two alias libraries to the default &lt;vendor&gt;__&lt;library&gt;__&lt;name&gt;__&lt;version&gt;:</p>
 <ul class="simple">
 <li><p>&lt;vendor&gt;::&lt;library&gt;::&lt;name&gt;::&lt;version&gt; (‘__’ replaced by ‘::’)</p></li>
 <li><p>&lt;vendor&gt;::&lt;library&gt;::&lt;name&gt; (short name without the version)</p></li>
 </ul>
+<p>This function can be used in FULL and SHORT form:
+Full form:
+<a href="#id1"><span class="problematic" id="id2">``</span></a>`
+add_ip(ip</p>
+<blockquote>
+<div><p>VENDOR vendor
+LIBRARY lib
+VERSION 1.2.3
+)</p>
+</div></blockquote>
+<p><a href="#id3"><span class="problematic" id="id4">``</span></a>`
+In full form it is possible to ommit VENDOR, LIBRARY and VERSION, although it is not recommended.</p>
+<p>Ommiting them all would have following signature:
+<code class="docutils literal notranslate"><span class="pre">`</span>
+<span class="pre">add_ip(ip2)</span>
+<span class="pre">`</span></code></p>
+<p>Short form:
+<code class="docutils literal notranslate"><span class="pre">`</span>
+<span class="pre">add_ip(vendor2::lib2::ip2::1.2.2)</span>
+<span class="pre">`</span></code>
+In short form only the full VLNV format is accepted</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>IP_NAME</strong> (<em>string</em>) – The name of the IP.</p>
@@ -63,8 +84,8 @@
 </dd></dl>
 
 <dl class="py function">
-<dt class="sig sig-object py" id="cmake.hwip.get_ipname">
-<span class="sig-prename descclassname"><span class="pre">cmake.hwip.</span></span><span class="sig-name descname"><span class="pre">get_ipname</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">OUTVAR</span> <span class="pre">IP_NAME</span> <span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cmake.hwip.get_ipname" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py" id="cmake.hwip.create_ip_vlnv">
+<span class="sig-prename descclassname"><span class="pre">cmake.hwip.</span></span><span class="sig-name descname"><span class="pre">create_ip_vlnv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">OUTVAR</span> <span class="pre">IP_NAME</span> <span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cmake.hwip.create_ip_vlnv" title="Link to this definition">¶</a></dt>
 <dd><p>This function creates an IP name provided vendor, library, name, and version (VLNV) information.</p>
 <p>This functions appends the vendor, library, name, and version (VLNV) information separated by ‘__’
 to create a unique string representing an IP name. This string is used as the library name when
@@ -90,6 +111,34 @@
 </dl>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="cmake.hwip.parse_ip_vlnv">
+<span class="sig-prename descclassname"><span class="pre">cmake.hwip.</span></span><span class="sig-name descname"><span class="pre">parse_ip_vlnv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">IP_VLNV</span> <span class="pre">VENDOR</span> <span class="pre">LIBRARY</span> <span class="pre">IP_NAME</span> <span class="pre">VERSION</span> <span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cmake.hwip.parse_ip_vlnv" title="Link to this definition">¶</a></dt>
+<dd><p>This function parses IP name from the VLNV format e.g. (vendor::lib::ip::0.0.1)</p>
+<p>This functions appends the vendor, library, name, and version (VLNV) information separated by ‘__’
+to create a unique string representing an IP name. This string is used as the library name when
+when calling the cmake built-in
+<a class="reference external" href="https://cmake.org/cmake/help/latest/command/add_library.html">add_library()</a> function (see add_ip()).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>OUTVAR</strong> (<em>string</em>) – The generate IP name.</p></li>
+<li><p><strong>IP_NAME</strong> (<em>string</em>) – The name of the IP.</p></li>
+</ul>
+</dd>
+</dl>
+<p><strong>Keyword Arguments</strong></p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>VENDOR</strong> (<em>string</em>) – Name of the IP vendor.</p></li>
+<li><p><strong>LIBRARY</strong> (<em>string</em>) – Name of the IP library.</p></li>
+<li><p><strong>VERSION</strong> (<em>string</em>) – Version of the IP following a three-part version number (Major.Minor.Patch, e.g., 1.0.13).</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="cmake.hwip.ip_assume_last">
 <span class="sig-prename descclassname"><span class="pre">cmake.hwip.</span></span><span class="sig-name descname"><span class="pre">ip_assume_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">VLNV</span> <span class="pre">IP_NAME</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cmake.hwip.ip_assume_last" title="Link to this definition">¶</a></dt>
@@ -283,7 +332,8 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="verible/index.html">cmake.verible</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">cmake.hwip</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.add_ip"><code class="docutils literal notranslate"><span class="pre">add_ip()</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.get_ipname"><code class="docutils literal notranslate"><span class="pre">get_ipname()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.create_ip_vlnv"><code class="docutils literal notranslate"><span class="pre">create_ip_vlnv()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.parse_ip_vlnv"><code class="docutils literal notranslate"><span class="pre">parse_ip_vlnv()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.ip_assume_last"><code class="docutils literal notranslate"><span class="pre">ip_assume_last()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.ip_sources"><code class="docutils literal notranslate"><span class="pre">ip_sources()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#cmake.hwip.get_ip_sources"><code class="docutils literal notranslate"><span class="pre">get_ip_sources()</span></code></a></li>

api_html/index.html

@@ -83,7 +83,8 @@ <h1>cmake<a class="headerlink" href="#cmake" title="Link to this heading">¶</a>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="hwip.html">cmake.hwip</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.add_ip"><code class="docutils literal notranslate"><span class="pre">add_ip()</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.get_ipname"><code class="docutils literal notranslate"><span class="pre">get_ipname()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.create_ip_vlnv"><code class="docutils literal notranslate"><span class="pre">create_ip_vlnv()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.parse_ip_vlnv"><code class="docutils literal notranslate"><span class="pre">parse_ip_vlnv()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.ip_assume_last"><code class="docutils literal notranslate"><span class="pre">ip_assume_last()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.ip_sources"><code class="docutils literal notranslate"><span class="pre">ip_sources()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="hwip.html#cmake.hwip.get_ip_sources"><code class="docutils literal notranslate"><span class="pre">get_ip_sources()</span></code></a></li>