URL
https://opencores.org/ocsvn/uart_block/uart_block/trunk
Subversion Repositories uart_block
[/] [uart_block/] [trunk/] [docs/] [doxygenDocs/] [html/] [classuart__communication__blocks.html] - Rev 40
Compare with Previous | Blame | View Log
<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Uart wishbone slave Documentation: uart_communication_blocks Entity Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Uart wishbone slave Documentation </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.8.0 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Packages</span></a></li> <li class="current"><a href="annotated.html"><span>Design Unit List</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Design Unit List</span></a></li> <li><a href="classes.html"><span>Design Units</span></a></li> <li><a href="hierarchy.html"><span>Design Unit Hierarchy</span></a></li> <li><a href="functions.html"><span>Design Unit Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('classuart__communication__blocks.html',''); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#Ports">Ports</a> | <a href="#Use Clauses">Use Clauses</a> </div> <div class="headertitle"> <div class="title">uart_communication_blocks Entity Reference</div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Inheritance diagram for uart_communication_blocks:</div> <div class="dyncontent"> <div class="center"> <img src="classuart__communication__blocks.png" usemap="#uart_communication_blocks_map" alt=""/> <map id="uart_communication_blocks_map" name="uart_communication_blocks_map"> <area href="classtest_uart__communication__block.html" alt="testUart_communication_block" shape="rect" coords="0,56,181,80"/> </map> </div></div> <p><a href="classuart__communication__blocks-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Entities</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuart__communication__blocks_1_1_behavioral.html">Behavioral</a>  </td><td class="memItemRight" valign="bottom">architecture</td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Top level for interconnection between communication blocks: <a class="el" href="classserial__transmitter.html">serial_transmitter</a>, <a class="el" href="classserial__receiver.html">serial_receiver</a>, <a class="el" href="classbaud__generator.html">baud_generator</a>. <a href="classuart__communication__blocks_1_1_behavioral.html#details">More...</a><br/></td></tr> <br/> <br/> <tr><td colspan="2"><h2><a name="Use Clauses"></a> Use Clauses</h2></td></tr> <tr class="memitem:ac442dca664056131bdaf5c92e4351e01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac442dca664056131bdaf5c92e4351e01"></a> <a class="el" href="classuart__communication__blocks.html#ac442dca664056131bdaf5c92e4351e01">pkgDefinitions</a> </td><td class="memItemRight" valign="bottom"> <b>Package</b><em><a class="el" href="classpkg_definitions.html"> <pkgDefinitions></a></td></tr> <tr class="memdesc:ac442dca664056131bdaf5c92e4351e01"><td class="mdescLeft"> </td><td class="mdescRight">Use CPU Definitions package. <br/></td></tr> <tr><td colspan="2"><h2><a name="Ports"></a> Ports</h2></td></tr> <tr class="memitem:a8951f9e34071cb1a681f0339ce4b63c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8951f9e34071cb1a681f0339ce4b63c4"></a> <a class="el" href="classuart__communication__blocks.html#a8951f9e34071cb1a681f0339ce4b63c4">rst</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">in</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a8951f9e34071cb1a681f0339ce4b63c4"><td class="mdescLeft"> </td><td class="mdescRight">Global reset. <br/></td></tr> <tr class="memitem:a3fe846251d47f950195c2f54bd129c61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fe846251d47f950195c2f54bd129c61"></a> <a class="el" href="classuart__communication__blocks.html#a3fe846251d47f950195c2f54bd129c61">clk</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">in</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a3fe846251d47f950195c2f54bd129c61"><td class="mdescLeft"> </td><td class="mdescRight">Global clock. <br/></td></tr> <tr class="memitem:afa18bfa78951934bdb69cd7109c05aa3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa18bfa78951934bdb69cd7109c05aa3"></a> <a class="el" href="classuart__communication__blocks.html#afa18bfa78951934bdb69cd7109c05aa3">cycle_wait_baud</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">in</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">std_logic_vector</span><span class="vhdlchar"> </span><span class="vhdlchar">(</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar">(</span><span class="vhdlchar"> </span><span class="vhdlchar">nBitsLarge</span><span class="vhdlchar"> </span><span class="vhdlchar">-</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span> <span class="vhdldigit">1</span> <span class="vhdlchar"> </span><span class="vhdlchar">)</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlkeyword">downto</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span> <span class="vhdldigit">0</span> <span class="vhdlchar"> </span><span class="vhdlchar">)</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:afa18bfa78951934bdb69cd7109c05aa3"><td class="mdescLeft"> </td><td class="mdescRight">Number of cycles to wait in order to generate desired baud. <br/></td></tr> <tr class="memitem:a8cf74bfe6ea9ebd58f54385e60bcdb81"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cf74bfe6ea9ebd58f54385e60bcdb81"></a> <a class="el" href="classuart__communication__blocks.html#a8cf74bfe6ea9ebd58f54385e60bcdb81">byte_tx</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">in</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC_VECTOR</span><span class="vhdlchar"> </span><span class="vhdlchar">(</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar">(</span><span class="vhdlchar"> </span><span class="vhdlchar">nBits</span><span class="vhdlchar"> </span><span class="vhdlchar">-</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span> <span class="vhdldigit">1</span> <span class="vhdlchar"> </span><span class="vhdlchar">)</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlkeyword">downto</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span> <span class="vhdldigit">0</span> <span class="vhdlchar"> </span><span class="vhdlchar">)</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a8cf74bfe6ea9ebd58f54385e60bcdb81"><td class="mdescLeft"> </td><td class="mdescRight">Byte to transmit. <br/></td></tr> <tr class="memitem:af86c06321eda298448164ea4af314d9d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af86c06321eda298448164ea4af314d9d"></a> <a class="el" href="classuart__communication__blocks.html#af86c06321eda298448164ea4af314d9d">byte_rx</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">out</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC_VECTOR</span><span class="vhdlchar"> </span><span class="vhdlchar">(</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar">(</span><span class="vhdlchar"> </span><span class="vhdlchar">nBits</span><span class="vhdlchar"> </span><span class="vhdlchar">-</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span> <span class="vhdldigit">1</span> <span class="vhdlchar"> </span><span class="vhdlchar">)</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlkeyword">downto</span><span class="vhdlchar"> </span><span class="vhdlchar"> </span><span class="vhdlchar"> </span> <span class="vhdldigit">0</span> <span class="vhdlchar"> </span><span class="vhdlchar">)</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:af86c06321eda298448164ea4af314d9d"><td class="mdescLeft"> </td><td class="mdescRight">Byte to receive. <br/></td></tr> <tr class="memitem:a6911204ed04f303c8c0aeb381132178f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6911204ed04f303c8c0aeb381132178f"></a> <a class="el" href="classuart__communication__blocks.html#a6911204ed04f303c8c0aeb381132178f">data_sent_tx</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">out</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a6911204ed04f303c8c0aeb381132178f"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that byte has been sent. <br/></td></tr> <tr class="memitem:a660ac404fdc70a7d4ac57286d0916c4a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a660ac404fdc70a7d4ac57286d0916c4a"></a> <a class="el" href="classuart__communication__blocks.html#a660ac404fdc70a7d4ac57286d0916c4a">data_received_rx</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">out</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a660ac404fdc70a7d4ac57286d0916c4a"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that we got a byte. <br/></td></tr> <tr class="memitem:a663f39bc9103a1c89116711a4d4f2fbc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a663f39bc9103a1c89116711a4d4f2fbc"></a> <a class="el" href="classuart__communication__blocks.html#a663f39bc9103a1c89116711a4d4f2fbc">serial_out</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">out</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">std_logic</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a663f39bc9103a1c89116711a4d4f2fbc"><td class="mdescLeft"> </td><td class="mdescRight">Uart serial out. <br/></td></tr> <tr class="memitem:ab5c23ea4f1cdfe2567b19e81909ecfc0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5c23ea4f1cdfe2567b19e81909ecfc0"></a> <a class="el" href="classuart__communication__blocks.html#ab5c23ea4f1cdfe2567b19e81909ecfc0">serial_in</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">in</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">std_logic</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:ab5c23ea4f1cdfe2567b19e81909ecfc0"><td class="mdescLeft"> </td><td class="mdescRight">Uart serial in. <br/></td></tr> <tr class="memitem:a2e4fb6cc48dc8f0ec684c80468ae6801"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e4fb6cc48dc8f0ec684c80468ae6801"></a> <a class="el" href="classuart__communication__blocks.html#a2e4fb6cc48dc8f0ec684c80468ae6801">start_tx</a>  </td><td class="memItemRight" valign="bottom"> <b><b><span class="vhdlkeyword">in</span><span class="vhdlchar"> </span></b></b> <b><span class="comment">STD_LOGIC</span><span class="vhdlchar"> </span></b></td></tr> <tr class="memdesc:a2e4fb6cc48dc8f0ec684c80468ae6801"><td class="mdescLeft"> </td><td class="mdescRight">Initiate transmission. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"> <p>Definition at line <a class="el" href="uart__communication__blocks_8vhd_source.html#l00009">9</a> of file <a class="el" href="uart__communication__blocks_8vhd_source.html">uart_communication_blocks.vhd</a>.</p> </div><hr/>The documentation for this class was generated from the following file:<ul> <li>E:/uart_block/hdl/iseProject/<a class="el" href="uart__communication__blocks_8vhd_source.html">uart_communication_blocks.vhd</a></li> </ul> </div><!-- contents --> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classuart__communication__blocks.html">uart_communication_blocks</a> </li> <li class="footer">Generated on Sat May 12 2012 22:28:09 for Uart wishbone slave Documentation by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> </ul> </div> </body> </html>