usart_8h.html.svn-base

avr32100.zip Embedded demo

    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define USART_REMOTE_LOOPBACK&nbsp;&nbsp;&nbsp;3          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set usart channel to remote loopback 
<p>
Definition at line <a class="el" href="usart_8h-source.html#l00313">313</a> of file <a class="el" href="usart_8h-source.html">usart.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="deb9432170d2d09a4ffbb098a1b4335e"></a><!-- doxytag: member="usart.h::USART_RX_EMPTY" ref="deb9432170d2d09a4ffbb098a1b4335e" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define USART_RX_EMPTY&nbsp;&nbsp;&nbsp;3          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Value returned by receiver function when nothing was received 
<p>
Definition at line <a class="el" href="usart_8h-source.html#l00263">263</a> of file <a class="el" href="usart_8h-source.html">usart.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="ffa1a7abf4e6ce54c0b64cc0826f8b4d"></a><!-- doxytag: member="usart.h::USART_RX_ERROR" ref="ffa1a7abf4e6ce54c0b64cc0826f8b4d" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define USART_RX_ERROR&nbsp;&nbsp;&nbsp;4          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Value returned by receiver function when transmission error occured 
<p>
Definition at line <a class="el" href="usart_8h-source.html#l00265">265</a> of file <a class="el" href="usart_8h-source.html">usart.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="0e63ca7313cd01a9210c4a4613859a68"></a><!-- doxytag: member="usart.h::USART_SPACE_PARITY" ref="0e63ca7313cd01a9210c4a4613859a68" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define USART_SPACE_PARITY&nbsp;&nbsp;&nbsp;2          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Use a space as parity bit 
<p>
Definition at line <a class="el" href="usart_8h-source.html#l00281">281</a> of file <a class="el" href="usart_8h-source.html">usart.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="cbf846773f58a382f10f8daf94797059"></a><!-- doxytag: member="usart.h::USART_SUCCESS" ref="cbf846773f58a382f10f8daf94797059" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define USART_SUCCESS&nbsp;&nbsp;&nbsp;0          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Value returned by function when it completed successfully 
<p>
Definition at line <a class="el" href="usart_8h-source.html#l00253">253</a> of file <a class="el" href="usart_8h-source.html">usart.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="481df5bfed5fec78ff5697b335ab5947"></a><!-- doxytag: member="usart.h::USART_TX_BUSY" ref="481df5bfed5fec78ff5697b335ab5947" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">#define USART_TX_BUSY&nbsp;&nbsp;&nbsp;2          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Value returned by transmission function when transmitter was busy 
<p>
Definition at line <a class="el" href="usart_8h-source.html#l00261">261</a> of file <a class="el" href="usart_8h-source.html">usart.h</a>.    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="0cd4c3b95035f5943696ffd9b56ee494"></a><!-- doxytag: member="usart.h::usart_bw_write_char" ref="0cd4c3b95035f5943696ffd9b56ee494" args="(volatile struct avr32_usart_t *usart, int c)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void usart_bw_write_char           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">volatile struct avr32_usart_t *&nbsp;</td>
          <td class="mdname" nowrap> <em>usart</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>c</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A busy wait for writing a character to the usart. Use with *caution* <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>*usart</em>&nbsp;</td><td>Base address of the usart </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>The character (up to 9 bits) to transmit </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None </dd></dl>

<p>
Definition at line <a class="el" href="usart_8c-source.html#l00484">484</a> of file <a class="el" href="usart_8c-source.html">usart.c</a>.
<p>
References <a class="el" href="testsuite_2bravo__validation_2usart_2usart_8h-source.html#l00189">USART_SUCCESS</a>, and <a class="el" href="testsuite_2bravo__validation_2usart_2usart_8c-source.html#l00439">usart_write_char()</a>.<div class="fragment"><pre class="fragment"><a name="l00485"></a>00485 {
<a name="l00486"></a>00486         <span class="keywordflow">while</span> (<a class="code" href="testsuite_2bravo__validation_2usart_2usart_8c.html#0c36f4b2ec5445212642ee7f94672805">usart_write_char</a>(usart, c) != <a class="code" href="testsuite_2bravo__validation_2usart_2usart_8h.html#cbf846773f58a382f10f8daf94797059">USART_SUCCESS</a>) {
<a name="l00487"></a>00487         }
<a name="l00488"></a>00488 
<a name="l00489"></a>00489         <span class="keywordflow">return</span>;
<a name="l00490"></a>00490 }
</pre></div>
<p>

<p>
Here is the call graph for this function:<p><center><img src="usart_8h_0cd4c3b95035f5943696ffd9b56ee494_cgraph.png" border="0" usemap="#usart_8h_0cd4c3b95035f5943696ffd9b56ee494_cgraph_map" alt=""></center>
<map name="usart_8h_0cd4c3b95035f5943696ffd9b56ee494_cgraph_map">
<area href="testsuite_2bravo__validation_2usart_2usart_8c.html#0c36f4b2ec5445212642ee7f94672805" shape="rect" coords="203,8,323,32" alt="">
</map>
    </td>
  </tr>
</table>
<a class="anchor" name="ad19b20067ca5ccf90d584e3b09ab02a"></a><!-- doxytag: member="usart.h::usart_getchar" ref="ad19b20067ca5ccf90d584e3b09ab02a" args="(volatile struct avr32_usart_t *usart)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int usart_getchar           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">volatile struct avr32_usart_t *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>usart</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Wait until a character is recevied, and return this. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>*usart</em>&nbsp;</td><td>Base address of the usart </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The received character, or -1 upon error </dd></dl>

<p>
Definition at line <a class="el" href="usart_8c-source.html#l00524">524</a> of file <a class="el" href="usart_8c-source.html">usart.c</a>.
<p>
References <a class="el" href="testsuite_2bravo__validation_2usart_2usart_8c-source.html#l00451">usart_read_char()</a>, <a class="el" href="testsuite_2bravo__validation_2pdc_2usart_8h-source.html#l00037">USART_RX_EMPTY</a>, and <a class="el" href="testsuite_2bravo__validation_2pdc_2usart_8h-source.html#l00039">USART_RX_ERROR</a>.<div class="fragment"><pre class="fragment"><a name="l00525"></a>00525 {
<a name="l00526"></a>00526         <span class="keywordtype">int</span> c, ret;
<a name="l00527"></a>00527 
<a name="l00528"></a>00528         <span class="keywordflow">while</span> (((ret = <a class="code" href="testsuite_2bravo__validation_2usart_2usart_8c.html#b73fc2f42bd6fe66c03d598b0158436d">usart_read_char</a>(usart, &amp;c)) == <a class="code" href="testsuite_2bravo__validation_2pdc_2usart_8h.html#deb9432170d2d09a4ffbb098a1b4335e">USART_RX_EMPTY</a>)) {
<a name="l00529"></a>00529         }
<a name="l00530"></a>00530 
<a name="l00531"></a>00531         <span class="keywordflow">if</span> (ret == <a class="code" href="testsuite_2bravo__validation_2pdc_2usart_8h.html#ffa1a7abf4e6ce54c0b64cc0826f8b4d">USART_RX_ERROR</a>)
<a name="l00532"></a>00532                 <span class="keywordflow">return</span> -1;
<a name="l00533"></a>00533         <span class="keywordflow">else</span>
<a name="l00534"></a>00534                 <span class="keywordflow">return</span> c;
<a name="l00535"></a>00535 }
</pre></div>
<p>

<p>
Here is the call graph for this function:<p><center><img src="usart_8h_ad19b20067ca5ccf90d584e3b09ab02a_cgraph.png" border="0" usemap="#usart_8h_ad19b20067ca5ccf90d584e3b09ab02a_cgraph_map" alt=""></center>
<map name="usart_8h_ad19b20067ca5ccf90d584e3b09ab02a_cgraph_map">
<area href="testsuite_2bravo__validation_2usart_2usart_8c.html#b73fc2f42bd6fe66c03d598b0158436d" shape="rect" coords="161,8,278,32" alt="">
</map>
    </td>
  </tr>
</table>
<a class="anchor" name="48c8d76fc9fdde84b94a6e09184a6446"></a><!-- doxytag: member="usart.h::usart_init_rs232" ref="48c8d76fc9fdde84b94a6e09184a6446" args="(volatile struct avr32_usart_t *usart, struct usart_options_t *opt, long cpu_hz)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int usart_init_rs232           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">volatile struct avr32_usart_t *&nbsp;</td>
          <td class="mdname" nowrap> <em>usart</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>struct <a class="el" href="structusart__options__t.html">usart_options_t</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>opt</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>long&nbsp;</td>
          <td class="mdname" nowrap> <em>cpu_hz</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Setup the usart to use the standard RS232 protocol <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>*usart</em>&nbsp;</td><td>Base address of the usart </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>*opt</em>&nbsp;</td><td>Options needed to set up RS232 communcation (see <a class="el" href="structusart__options__t.html">usart_options_t</a>) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cpu_hz</em>&nbsp;</td><td>The usart clk frequency </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>USART_SUCCESS or USART_INVALID_INPUT </dd></dl>

<p>
Definition at line <a class="el" href="usart_8c-source.html#l00152">152</a> of file <a class="el" href="usart_8c-source.html">usart.c</a>.
<p>
References <a class="el" href="testsuite_2bravo__validation_2pdc_2usart_8h-source.html#l00102">