<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS V2: C:/Dev/git/UbixOS/sys/include/net/sio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UbixOS V2
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('sio_8h.html','');});
/* @license-end */
</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)">
</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="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">sio.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="arch_8h_source.html">net/arch.h</a>"</code><br />
<code>#include "<a class="el" href="opt_8h_source.html">net/opt.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sio.h:</div>
<div class="dyncontent">
<div class="center"><img src="sio_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2sio_8h" alt=""/></div>
</div>
</div>
<p><a href="sio_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ac868e938508a529a77cdc81a6765bd0b"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a></td></tr>
<tr class="separator:ac868e938508a529a77cdc81a6765bd0b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a127c33a3c36b7de915a9fe0e1223e063"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#a127c33a3c36b7de915a9fe0e1223e063">sio_open</a> (<a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> devnum)</td></tr>
<tr class="separator:a127c33a3c36b7de915a9fe0e1223e063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5a6563ee5f12459451010139a04a03b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#ac5a6563ee5f12459451010139a04a03b">sio_read</a> (<a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> fd, <a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> *data, <a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> len)</td></tr>
<tr class="separator:ac5a6563ee5f12459451010139a04a03b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee1b714fc5a4f0fa198537fa7ea48359"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#aee1b714fc5a4f0fa198537fa7ea48359">sio_read_abort</a> (<a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> fd)</td></tr>
<tr class="separator:aee1b714fc5a4f0fa198537fa7ea48359"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5747f8d8042b712aa5219d5338bf2721"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#a5747f8d8042b712aa5219d5338bf2721">sio_recv</a> (<a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> fd)</td></tr>
<tr class="separator:a5747f8d8042b712aa5219d5338bf2721"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c60bae2a81c07930ee504308f6a38b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#a2c60bae2a81c07930ee504308f6a38b2">sio_send</a> (<a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> c, <a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> fd)</td></tr>
<tr class="separator:a2c60bae2a81c07930ee504308f6a38b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3780ab1928702f82974ee66988220040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#a3780ab1928702f82974ee66988220040">sio_tryread</a> (<a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> fd, <a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> *data, <a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> len)</td></tr>
<tr class="separator:a3780ab1928702f82974ee66988220040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23df0f187d94bc56513062032289c488"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sio_8h.html#a23df0f187d94bc56513062032289c488">sio_write</a> (<a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> fd, <a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> *data, <a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> len)</td></tr>
<tr class="separator:a23df0f187d94bc56513062032289c488"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ac868e938508a529a77cdc81a6765bd0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac868e938508a529a77cdc81a6765bd0b">◆ </a></span>sio_fd_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sio_8h_source.html#l00048">48</a> of file <a class="el" href="sio_8h_source.html">sio.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a127c33a3c36b7de915a9fe0e1223e063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a127c33a3c36b7de915a9fe0e1223e063">◆ </a></span>sio_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> sio_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td>
<td class="paramname"><em>devnum</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a serial device for communication.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">devnum</td><td>device number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>handle to serial device if successful, NULL otherwise </dd></dl>
</div>
</div>
<a id="ac5a6563ee5f12459451010139a04a03b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5a6563ee5f12459451010139a04a03b">◆ </a></span>sio_read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> sio_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads from the serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>serial device handle </td></tr>
<tr><td class="paramname">data</td><td>pointer to data buffer for receiving </td></tr>
<tr><td class="paramname">len</td><td>maximum length (in bytes) of data to receive </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes actually received - may be 0 if aborted by sio_read_abort</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function will block until data can be received. The blocking can be cancelled by calling <a class="el" href="sio_8h.html#aee1b714fc5a4f0fa198537fa7ea48359">sio_read_abort()</a>. </dd></dl>
</div>
</div>
<a id="aee1b714fc5a4f0fa198537fa7ea48359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee1b714fc5a4f0fa198537fa7ea48359">◆ </a></span>sio_read_abort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sio_read_abort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Aborts a blocking <a class="el" href="sio_8h.html#ac5a6563ee5f12459451010139a04a03b">sio_read()</a> call.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>serial device handle </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5747f8d8042b712aa5219d5338bf2721"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5747f8d8042b712aa5219d5338bf2721">◆ </a></span>sio_recv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> sio_recv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives a single character from the serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>serial device handle</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function will block until a character is received. </dd></dl>
</div>
</div>
<a id="a2c60bae2a81c07930ee504308f6a38b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c60bae2a81c07930ee504308f6a38b2">◆ </a></span>sio_send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sio_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td>
<td class="paramname"><em>fd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a single character to the serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>character to send </td></tr>
<tr><td class="paramname">fd</td><td>serial device handle</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function will block until the character can be sent. </dd></dl>
</div>
</div>
<a id="a3780ab1928702f82974ee66988220040"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3780ab1928702f82974ee66988220040">◆ </a></span>sio_tryread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> sio_tryread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to read from the serial device. Same as sio_read but returns immediately if no data is available and never blocks.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>serial device handle </td></tr>
<tr><td class="paramname">data</td><td>pointer to data buffer for receiving </td></tr>
<tr><td class="paramname">len</td><td>maximum length (in bytes) of data to receive </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes actually received </dd></dl>
</div>
</div>
<a id="a23df0f187d94bc56513062032289c488"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23df0f187d94bc56513062032289c488">◆ </a></span>sio_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> sio_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sio_8h.html#ac868e938508a529a77cdc81a6765bd0b">sio_fd_t</a> </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4c14294869aceba3ef9d4c0c302d0f33">u32_t</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes to the serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>serial device handle </td></tr>
<tr><td class="paramname">data</td><td>pointer to data to send </td></tr>
<tr><td class="paramname">len</td><td>length (in bytes) of data to send </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes actually sent</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function will block until all data can be sent. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_8a452844cab5a537277ef786999bc939.html">net</a></li><li class="navelem"><a class="el" href="sio_8h.html">sio.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
