git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc/html/apiref/tty.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>TTY &#8212; Freedom Metal v201905 documentation</title>
  10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../_static/doctools.js"></script>
  16     <link rel="index" title="Index" href="../genindex.html" />
  17     <link rel="search" title="Search" href="../search.html" />
  18     <link rel="next" title="UARTs" href="uart.html" />
  19     <link rel="prev" title="Timer API" href="timer.html" />
  20
  21   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  22
  23
  24   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  25
  26   </head><body>
  27
  28
  29     <div class="document">
  30       <div class="documentwrapper">
  31         <div class="bodywrapper">
  32
  33
  34           <div class="body" role="main">
  35
  36   <div class="section" id="tty">
  37 <h1>TTY<a class="headerlink" href="#tty" title="Permalink to this headline">¶</a></h1>
  38 <p>API for emulated serial teriminals. </p>
  39 <div class="breathe-sectiondef docutils container">
  40 <p class="breathe-sectiondef-title rubric">Functions</p>
  41 <dl class="function">
  42 <dt id="_CPPv314metal_tty_putch">
  43 <span id="_CPPv214metal_tty_putch"></span><span id="metal_tty_putc__unsigned-c"></span><span class="target" id="tty_8h_1a6579460d1aedc49234c40ac17db370cd"></span>int <code class="descname">metal_tty_putc</code><span class="sig-paren">(</span>unsigned char <em>c</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv314metal_tty_putch" title="Permalink to this definition">¶</a><br /></dt>
  44 <dd><p>Write a character to the default output device. </p>
  45 <p>Write a character to the default output device, which for most targets is the UART serial port.</p>
  46 <p><dl class="docutils">
  47 <dt><strong>Return</strong></dt>
  48 <dd>0 on success, or -1 on failure. </dd>
  49 <dt><strong>Parameters</strong></dt>
  50 <dd><ul class="breatheparameterlist first last simple">
  51 <li><code class="docutils literal notranslate"><span class="pre">c</span></code>: The character to write to the terminal </li>
  52 </ul>
  53 </dd>
  54 </dl>
  55 </p>
  56 </dd></dl>
  57
  58 </div>
  59 </div>
  60
  61
  62           </div>
  63
  64         </div>
  65       </div>
  66       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  67         <div class="sphinxsidebarwrapper">
  68 <h1 class="logo"><a href="../index.html">Freedom Metal</a></h1>
  69
  70
  71
  72
  73
  74
  75
  76
  77 <h3>Navigation</h3>
  78 <ul class="current">
  79 <li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction to Freedom Metal</a></li>
  80 <li class="toctree-l1"><a class="reference internal" href="../devguide.html">Developer Guide</a></li>
  81 <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
  82 <li class="toctree-l2"><a class="reference internal" href="button.html">Buttons</a></li>
  83 <li class="toctree-l2"><a class="reference internal" href="cache.html">Caches</a></li>
  84 <li class="toctree-l2"><a class="reference internal" href="clock.html">Clocks</a></li>
  85 <li class="toctree-l2"><a class="reference internal" href="cpu.html">CPU</a></li>
  86 <li class="toctree-l2"><a class="reference internal" href="gpio.html">GPIO</a></li>
  87 <li class="toctree-l2"><a class="reference internal" href="interrupt.html">Interrupts</a></li>
  88 <li class="toctree-l2"><a class="reference internal" href="itim.html">ITIM</a></li>
  89 <li class="toctree-l2"><a class="reference internal" href="led.html">LEDs</a></li>
  90 <li class="toctree-l2"><a class="reference internal" href="lock.html">Locks</a></li>
  91 <li class="toctree-l2"><a class="reference internal" href="memory.html">Memory Enumeration</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="pmp.html">PMPs</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="shutdown.html">Shutdown</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="spi.html">SPIs</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="switch.html">Switches</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="timer.html">Timer API</a></li>
  97 <li class="toctree-l2 current"><a class="current reference internal" href="#">TTY</a></li>
  98 <li class="toctree-l2"><a class="reference internal" href="uart.html">UARTs</a></li>
  99 </ul>
 100 </li>
 101 </ul>
 102
 103 <div class="relations">
 104 <h3>Related Topics</h3>
 105 <ul>
 106   <li><a href="../index.html">Documentation overview</a><ul>
 107   <li><a href="../api.html">API Reference</a><ul>
 108       <li>Previous: <a href="timer.html" title="previous chapter">Timer API</a></li>
 109       <li>Next: <a href="uart.html" title="next chapter">UARTs</a></li>
 110   </ul></li>
 111   </ul></li>
 112 </ul>
 113 </div>
 114 <div id="searchbox" style="display: none" role="search">
 115   <h3>Quick search</h3>
 116     <div class="searchformwrapper">
 117     <form class="search" action="../search.html" method="get">
 118       <input type="text" name="q" />
 119       <input type="submit" value="Go" />
 120       <input type="hidden" name="check_keywords" value="yes" />
 121       <input type="hidden" name="area" value="default" />
 122     </form>
 123     </div>
 124 </div>
 125 <script type="text/javascript">$('#searchbox').show(0);</script>
 126         </div>
 127       </div>
 128       <div class="clearer"></div>
 129     </div>
 130     <div class="footer">
 131       &copy;2019, SiFive Inc..
 132
 133       |
 134       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
 135       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
 136
 137       |
 138       <a href="../_sources/apiref/tty.rst.txt"
 139           rel="nofollow">Page source</a>
 140     </div>
 141
 142
 143
 144
 145   </body>
 146 </html>