Skip to content

Commit

Permalink
update cd6ebf2
Browse files Browse the repository at this point in the history
  • Loading branch information
BuildTheDocs authored and BuildTheDocs committed Oct 31, 2024
0 parents commit db9f02a
Show file tree
Hide file tree
Showing 72 changed files with 9,741 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d90fa55169160b15f1be8ca33a5499c4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
166 changes: 166 additions & 0 deletions Attributes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>HDL attributes/annotations &mdash; FPGA Board Constraints latest documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/documentation_options.js?v=c6e86fd7"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Similar resources" href="Similar.html" />
<link rel="prev" title="Contributing" href="Contributing.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> FPGA Board Constraints
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Structure.html">Structure of the repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="Usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Contributing.html">Contributing</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">HDL attributes/annotations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#vhdl">VHDL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#verilog">Verilog</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Similar.html">Similar resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ProgDebug.html">Programming and debugging</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Data</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Data/Boards/index.html">Boards</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data/Devices.html">Devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data/Flash.html">Flash</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data/SDRAM.html">SDRAM</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="References.html">References</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">FPGA Board Constraints</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">


<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>HDL attributes/annotations</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/hdl/constraints/blob/main/doc/Attributes.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="hdl-attributes-annotations">
<h1>HDL attributes/annotations<a class="headerlink" href="#hdl-attributes-annotations" title="Link to this heading"></a></h1>
<p>Some tools/vendors support specifying implementation constraints through attributes/annotations in HDL sources.</p>
<section id="vhdl">
<h2>VHDL<a class="headerlink" href="#vhdl" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Timing</p>
<ul>
<li><p>Specify SDC timing constraints inside a module</p></li>
<li><p>Setting cross-clock options</p></li>
<li><p>Disable optimizations like shiftregister extraction</p></li>
</ul>
</li>
<li><p>Physical</p>
<ul>
<li><p>Setting pin locations</p></li>
</ul>
</li>
<li><p>Encoding</p>
<ul>
<li><p>FSM encoding</p></li>
<li><p>Type/enum encoding</p></li>
</ul>
</li>
<li><p>Disable renaming optimization so a wire can be used for debugging</p>
<ul>
<li><p>Attach a logic analyzer</p></li>
</ul>
</li>
<li><p>Translation hints</p>
<ul>
<li><p>Setting memory styles (register, distributedRAM/LUTRAM, BlockRAM, UltraRAM, …)</p></li>
</ul>
</li>
</ul>
</section>
<section id="verilog">
<h2>Verilog<a class="headerlink" href="#verilog" title="Link to this heading"></a></h2>
<p>See <a class="reference internal" href="Similar.html#similar-yosys-symbiflow-plugins"><span class="std std-ref">yosys-symbiflow-plugin</span></a>.</p>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Similar.html" class="btn btn-neutral float-right" title="Similar resources" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2021-2022 The HDL Authors.
<span class="lastupdated">Last updated on 2024.10.31.
</span></p>
</div>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/buildthedocs/sphinx.theme">theme</a>
provided by <a href="https://buildthedocs.github.io">Build the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
139 changes: 139 additions & 0 deletions Contributing.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; FPGA Board Constraints latest documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/documentation_options.js?v=c6e86fd7"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="HDL attributes/annotations" href="Attributes.html" />
<link rel="prev" title="Usage" href="Usage.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> FPGA Board Constraints
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Structure.html">Structure of the repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="Usage.html">Usage</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#future-work">Future work</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Attributes.html">HDL attributes/annotations</a></li>
<li class="toctree-l1"><a class="reference internal" href="Similar.html">Similar resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="ProgDebug.html">Programming and debugging</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Data</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Data/Boards/index.html">Boards</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data/Devices.html">Devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data/Flash.html">Flash</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data/SDRAM.html">SDRAM</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="References.html">References</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">FPGA Board Constraints</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">


<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Contributing</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/hdl/constraints/blob/main/doc/Contributing.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"></a></h1>
<p>Should you find something wrong, missing or outdated; or if you miss your favourite board/device, you are welcome to
contribute!
Check the <a class="reference external" href="https://github.com/hdl/awesome/issues?q=is%3Aopen">open issues and pull request</a>.
If no one is working on it, let us know and go ahead according to the rules explained in <a class="reference internal" href="Structure.html#structure"><span class="std std-ref">Structure of the repository</span></a>.</p>
<section id="future-work">
<h2>Future work<a class="headerlink" href="#future-work" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Define constraints in YAML files.</p></li>
<li><p>Write generators that export the content to vendor specific formats.</p></li>
<li><p>Write importers that read existing vendor specific constraint files and generate a YAML file.</p></li>
</ul>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Attributes.html" class="btn btn-neutral float-right" title="HDL attributes/annotations" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2021-2022 The HDL Authors.
<span class="lastupdated">Last updated on 2024.10.31.
</span></p>
</div>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/buildthedocs/sphinx.theme">theme</a>
provided by <a href="https://buildthedocs.github.io">Build the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit db9f02a

Please sign in to comment.