192 lines
14 KiB
HTML
192 lines
14 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
|
|
<meta http-equiv="Content-Style-Type" content="text/css" />
|
||
|
|
<meta name="generator" content="MediaWiki 1.14.0" />
|
||
|
|
<meta name="keywords" content="HDL guidelines" />
|
||
|
|
<link rel="alternate" type="application/x-wiki" title="Edit" href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=edit" />
|
||
|
|
<link rel="edit" title="Edit" href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=edit" />
|
||
|
|
<link rel="shortcut icon" href="../favicon.ico" />
|
||
|
|
<link rel="search" type="application/opensearchdescription+xml" href="opensearch_desc.php" title="Milkymist Wiki (en)" />
|
||
|
|
<link title="Creative Commons" type="application/rdf+xml" href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=creativecommons" rel="meta" />
|
||
|
|
<link rel="copyright" href="http://www.milkymist.org/wiki/index.php?title=Copyright" />
|
||
|
|
<link rel="alternate" type="application/rss+xml" title="Milkymist Wiki RSS Feed" href="http://milkymist.org/wiki/index.php?title=Special:RecentChanges&feed=rss" />
|
||
|
|
<link rel="alternate" type="application/atom+xml" title="Milkymist Wiki Atom Feed" href="http://milkymist.org/wiki/index.php?title=Special:RecentChanges&feed=atom" />
|
||
|
|
<title>HDL guidelines - Milkymist Wiki</title>
|
||
|
|
<link rel="stylesheet" href="skins/common/shared.css%3F195.css" type="text/css" media="screen" />
|
||
|
|
<link rel="stylesheet" href="skins/common/commonPrint.css%3F195.css" type="text/css" media="print" />
|
||
|
|
<link rel="stylesheet" href="skins/monobook/main.css%3F195.css" type="text/css" media="screen" />
|
||
|
|
<!--[if lt IE 5.5000]><link rel="stylesheet" href="/wiki/skins/monobook/IE50Fixes.css?195" type="text/css" media="screen" /><![endif]-->
|
||
|
|
<!--[if IE 5.5000]><link rel="stylesheet" href="/wiki/skins/monobook/IE55Fixes.css?195" type="text/css" media="screen" /><![endif]-->
|
||
|
|
<!--[if IE 6]><link rel="stylesheet" href="/wiki/skins/monobook/IE60Fixes.css?195" type="text/css" media="screen" /><![endif]-->
|
||
|
|
<!--[if IE 7]><link rel="stylesheet" href="/wiki/skins/monobook/IE70Fixes.css?195" type="text/css" media="screen" /><![endif]-->
|
||
|
|
<link rel="stylesheet" href="http://milkymist.org/wiki/index.php?title=MediaWiki:Common.css&usemsgcache=yes&ctype=text%2Fcss&smaxage=18000&action=raw&maxage=18000" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="http://milkymist.org/wiki/index.php?title=MediaWiki:Print.css&usemsgcache=yes&ctype=text%2Fcss&smaxage=18000&action=raw&maxage=18000" type="text/css" media="print" />
|
||
|
|
<link rel="stylesheet" href="http://milkymist.org/wiki/index.php?title=MediaWiki:Monobook.css&usemsgcache=yes&ctype=text%2Fcss&smaxage=18000&action=raw&maxage=18000" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="http://milkymist.org/wiki/index.php?title=-&action=raw&maxage=18000&gen=css" type="text/css" />
|
||
|
|
<!--[if lt IE 7]><script type="text/javascript" src="/wiki/skins/common/IEFixes.js?195"></script>
|
||
|
|
<meta http-equiv="imagetoolbar" content="no" /><![endif]-->
|
||
|
|
|
||
|
|
<script type= "text/javascript">/*<![CDATA[*/
|
||
|
|
var skin = "monobook";
|
||
|
|
var stylepath = "/wiki/skins";
|
||
|
|
var wgArticlePath = "/wiki/index.php?title=$1";
|
||
|
|
var wgScriptPath = "/wiki";
|
||
|
|
var wgScript = "/wiki/index.php";
|
||
|
|
var wgVariantArticlePath = false;
|
||
|
|
var wgActionPaths = {};
|
||
|
|
var wgServer = "http://milkymist.org";
|
||
|
|
var wgCanonicalNamespace = "";
|
||
|
|
var wgCanonicalSpecialPageName = false;
|
||
|
|
var wgNamespaceNumber = 0;
|
||
|
|
var wgPageName = "HDL_guidelines";
|
||
|
|
var wgTitle = "HDL guidelines";
|
||
|
|
var wgAction = "view";
|
||
|
|
var wgArticleId = "3";
|
||
|
|
var wgIsArticle = true;
|
||
|
|
var wgUserName = null;
|
||
|
|
var wgUserGroups = null;
|
||
|
|
var wgUserLanguage = "en";
|
||
|
|
var wgContentLanguage = "en";
|
||
|
|
var wgBreakFrames = false;
|
||
|
|
var wgCurRevisionId = "1166";
|
||
|
|
var wgVersion = "1.14.0";
|
||
|
|
var wgEnableAPI = true;
|
||
|
|
var wgEnableWriteAPI = true;
|
||
|
|
var wgSeparatorTransformTable = ["", ""];
|
||
|
|
var wgDigitTransformTable = ["", ""];
|
||
|
|
var wgRestrictionEdit = [];
|
||
|
|
var wgRestrictionMove = [];
|
||
|
|
/*]]>*/</script>
|
||
|
|
|
||
|
|
<script type="text/javascript" src="skins/common/wikibits.js%3F195"><!-- wikibits js --></script>
|
||
|
|
<!-- Head Scripts -->
|
||
|
|
<script type="text/javascript" src="skins/common/ajax.js%3F195"></script>
|
||
|
|
<script type="text/javascript" src="http://milkymist.org/wiki/index.php?title=-&action=raw&gen=js&useskin=monobook"><!-- site js --></script>
|
||
|
|
</head>
|
||
|
|
<body class="mediawiki ltr ns-0 ns-subject page-HDL_guidelines skin-monobook">
|
||
|
|
<div id="globalWrapper">
|
||
|
|
<div id="column-content">
|
||
|
|
<div id="content">
|
||
|
|
<a name="top" id="top"></a>
|
||
|
|
<h1 id="firstHeading" class="firstHeading">HDL guidelines</h1>
|
||
|
|
<div id="bodyContent">
|
||
|
|
<h3 id="siteSub">From Milkymist Wiki</h3>
|
||
|
|
<div id="contentSub"></div>
|
||
|
|
<div id="jump-to-nav">Jump to: <a href="index.php%3Ftitle=HDL_guidelines.html#column-one">navigation</a>, <a href="index.php%3Ftitle=HDL_guidelines.html#searchInput">search</a></div> <!-- start content -->
|
||
|
|
<a name="General_guidelines" id="General_guidelines"></a><h2><span class="editsection">[<a href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=edit&section=1" title="Edit section: General guidelines">edit</a>]</span> <span class="mw-headline"> General guidelines </span></h2>
|
||
|
|
<ul><li> The code quality standard for inclusion of HDL modules is higher than what you may be <a href="http://www.opencores.org" class="external text" title="http://www.opencores.org" rel="nofollow">used to</a>.
|
||
|
|
</li><li> Use Verilog HDL.
|
||
|
|
</li><li> Use available FPGA resources sparingly and carefully. System-on-chip means you cannot take the whole FPGA for yourself.
|
||
|
|
</li><li> Your design must meet timing.
|
||
|
|
</li><li> Your design must work with Xst or another free of charge synthesizer. Most people cannot afford the licenses of Mentor Graphics, Synopsys, etc.
|
||
|
|
</li><li> Your simulation must run with GPL Cver, Icarus Verilog or Verilator for the same reason. The free versions of Modelsim are tolerated as they are reasonably easy to obtain from FPGA vendors, but not recommended.
|
||
|
|
</li><li> Keep everything synchronous. Reset signal is synchronous as well. If you really need to use multiple clock domains or another form of asynchronous logic, explain why.
|
||
|
|
</li><li> Your design must come with a proper functional testbench.
|
||
|
|
</li><li> LaTeX documentation is appreciated.
|
||
|
|
</li><li> Use the same directory organization as elsewhere in the project. See <a href="http://github.com/lekernel/milkymist/tree/master/cores/hpdmc_ddr32/" class="external free" title="http://github.com/lekernel/milkymist/tree/master/cores/hpdmc_ddr32/" rel="nofollow">http://github.com/lekernel/milkymist/tree/master/cores/hpdmc_ddr32/</a> for an example.
|
||
|
|
</li><li> You must use a license compatible with GNU GPL.
|
||
|
|
</li></ul>
|
||
|
|
<a name="Coding_style" id="Coding_style"></a><h2><span class="editsection">[<a href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=edit&section=2" title="Edit section: Coding style">edit</a>]</span> <span class="mw-headline"> Coding style </span></h2>
|
||
|
|
<ul><li> Use "always @(*)" whenever possible.
|
||
|
|
</li><li> Use Verilog-2001 port definitions, e.g. "module fnord(input foo, output bar);" instead of "module fnord(foo, bar); input foo; output bar;".
|
||
|
|
</li><li> Always specify the bit lengths of the constants.
|
||
|
|
</li><li> Use the same indentation schemes as in other places. Indentation character is a tabulation (width 8). See <a href="http://github.com/lekernel/milkymist/tree/master/cores/hpdmc_ddr32/rtl" class="external free" title="http://github.com/lekernel/milkymist/tree/master/cores/hpdmc_ddr32/rtl" rel="nofollow">http://github.com/lekernel/milkymist/tree/master/cores/hpdmc_ddr32/rtl</a> for examples.
|
||
|
|
</li><li> No full_case or parallel_case directive. If your case statement is full or parallel, just make a full or parallel description.
|
||
|
|
</li><li> Give explicit names to your ports, signals, and states.
|
||
|
|
</li><li> Comment your code.
|
||
|
|
</li></ul>
|
||
|
|
|
||
|
|
<!--
|
||
|
|
NewPP limit report
|
||
|
|
Preprocessor node count: 3/1000000
|
||
|
|
Post-expand include size: 0/2097152 bytes
|
||
|
|
Template argument size: 0/2097152 bytes
|
||
|
|
Expensive parser function count: 0/100
|
||
|
|
-->
|
||
|
|
|
||
|
|
<!-- Saved in parser cache with key sbsql1-mw_:pcache:idhash:3-0!1!0!!en!2 and timestamp 20140823124210 -->
|
||
|
|
<div class="printfooter">
|
||
|
|
Retrieved from "<a href="index.php%3Ftitle=HDL_guidelines.html">http://milkymist.org/wiki/index.php?title=HDL_guidelines</a>"</div>
|
||
|
|
<!-- end content -->
|
||
|
|
<div class="visualClear"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="column-one">
|
||
|
|
<div id="p-cactions" class="portlet">
|
||
|
|
<h5>Views</h5>
|
||
|
|
<div class="pBody">
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li id="ca-nstab-main" class="selected"><a href="index.php%3Ftitle=HDL_guidelines.html" title="View the content page [c]" accesskey="c">Page</a></li>
|
||
|
|
<li id="ca-talk" class="new"><a href="http://milkymist.org/wiki/index.php?title=Talk:HDL_guidelines&action=edit&redlink=1" title="Discussion about the content page [t]" accesskey="t">Discussion</a></li>
|
||
|
|
<li id="ca-edit"><a href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=edit" title="You can edit this page. Please use the preview button before saving [e]" accesskey="e">Edit</a></li>
|
||
|
|
<li id="ca-history"><a href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&action=history" title="Past versions of this page [h]" accesskey="h">History</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="portlet" id="p-personal">
|
||
|
|
<h5>Personal tools</h5>
|
||
|
|
<div class="pBody">
|
||
|
|
<ul>
|
||
|
|
<li id="pt-login"><a href="http://milkymist.org/wiki/index.php?title=Special:UserLogin&returnto=HDL_guidelines" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o">Log in / create account</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="portlet" id="p-logo">
|
||
|
|
<a style="background-image: url(http://www.milkymist.org/wikilogo.png);" href="../wiki.html" title="Visit the main page [z]" accesskey="z"></a>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script>
|
||
|
|
<div class='generated-sidebar portlet' id='p-navigation'>
|
||
|
|
<h5>Navigation</h5>
|
||
|
|
<div class='pBody'>
|
||
|
|
<ul>
|
||
|
|
<li id="n-mainpage-description"><a href="../wiki.html">Main Page</a></li>
|
||
|
|
<li id="n-portal"><a href="http://milkymist.org/wiki/index.php?title=Milkymist_Wiki:Community_Portal" title="About the project, what you can do, where to find things">Community portal</a></li>
|
||
|
|
<li id="n-currentevents"><a href="http://milkymist.org/wiki/index.php?title=Milkymist_Wiki:Current_events" title="Find background information on current events">Current events</a></li>
|
||
|
|
<li id="n-recentchanges"><a href="http://milkymist.org/wiki/index.php?title=Special:RecentChanges" title="The list of recent changes in the wiki [r]" accesskey="r">Recent changes</a></li>
|
||
|
|
<li id="n-randompage"><a href="http://milkymist.org/wiki/index.php?title=Special:Random" title="Load a random page [x]" accesskey="x">Random page</a></li>
|
||
|
|
<li id="n-help"><a href="http://milkymist.org/wiki/index.php?title=Help:Contents" title="The place to find out">Help</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="p-search" class="portlet">
|
||
|
|
<h5><label for="searchInput">Search</label></h5>
|
||
|
|
<div id="searchBody" class="pBody">
|
||
|
|
<form action="http://milkymist.org/wiki/index.php?title=Special:Search" id="searchform"><div>
|
||
|
|
<input id="searchInput" name="search" type="text" title="Search Milkymist Wiki [f]" accesskey="f" value="" />
|
||
|
|
<input type='submit' name="go" class="searchButton" id="searchGoButton" value="Go" title="Go to a page with this exact name if exists" />
|
||
|
|
<input type='submit' name="fulltext" class="searchButton" id="mw-searchButton" value="Search" title="Search the pages for this text" />
|
||
|
|
</div></form>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="portlet" id="p-tb">
|
||
|
|
<h5>Toolbox</h5>
|
||
|
|
<div class="pBody">
|
||
|
|
<ul>
|
||
|
|
<li id="t-whatlinkshere"><a href="http://milkymist.org/wiki/index.php?title=Special:WhatLinksHere/HDL_guidelines" title="List of all wiki pages that link here [j]" accesskey="j">What links here</a></li>
|
||
|
|
<li id="t-recentchangeslinked"><a href="http://milkymist.org/wiki/index.php?title=Special:RecentChangesLinked/HDL_guidelines" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li>
|
||
|
|
<li id="t-specialpages"><a href="http://milkymist.org/wiki/index.php?title=Special:SpecialPages" title="List of all special pages [q]" accesskey="q">Special pages</a></li>
|
||
|
|
<li id="t-print"><a href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&printable=yes" title="Printable version of this page [p]" accesskey="p">Printable version</a></li> <li id="t-permalink"><a href="http://milkymist.org/wiki/index.php?title=HDL_guidelines&oldid=1166" title="Permanent link to this version of the page">Permanent link</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- end of the left (by default at least) column -->
|
||
|
|
<div class="visualClear"></div>
|
||
|
|
<div id="footer">
|
||
|
|
<div id="f-poweredbyico"><a href="http://www.mediawiki.org/"><img src="skins/common/images/poweredby_mediawiki_88x31.png" alt="Powered by MediaWiki" /></a></div>
|
||
|
|
<div id="f-copyrightico"><a href="http://www.milkymist.org/wiki/index.php?title=Copyright"><img src="skins/common/images/gnu-fdl.png" alt='GNU Free Documentation License 1.3 and CC-BY-SA 3.0 Unported' /></a></div>
|
||
|
|
<ul id="f-list">
|
||
|
|
<li id="lastmod"> This page was last modified on 5 April 2011, at 09:59.</li>
|
||
|
|
<li id="viewcount">This page has been accessed 9,809 times.</li>
|
||
|
|
<li id="copyright">Content is available under <a href="http://www.milkymist.org/wiki/index.php?title=Copyright" class="external " title="http://www.milkymist.org/wiki/index.php?title=Copyright">GNU Free Documentation License 1.3 and CC-BY-SA 3.0 Unported</a>.</li>
|
||
|
|
<li id="privacy"><a href="http://milkymist.org/wiki/index.php?title=Milkymist_Wiki:Privacy_policy" title="Milkymist Wiki:Privacy policy">Privacy policy</a></li>
|
||
|
|
<li id="about"><a href="http://milkymist.org/wiki/index.php?title=Milkymist_Wiki:About" title="Milkymist Wiki:About">About Milkymist Wiki</a></li>
|
||
|
|
<li id="disclaimer"><a href="http://milkymist.org/wiki/index.php?title=Milkymist_Wiki:General_disclaimer" title="Milkymist Wiki:General disclaimer">Disclaimers</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script>
|
||
|
|
<!-- Served in 0.189 secs. --></body></html>
|