specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_f_t_d_i.html

480 lines
21 KiB
HTML
Raw Normal View History

Added Doxygen files
2013-01-30 22:00:18 +01:00
<!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"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>USB_Host_Shield_2.0: FTDI Class 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="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>
<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 style="padding-left: 0.5em;">
<div id="projectname">USB_Host_Shield_2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</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>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_f_t_d_i-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FTDI Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="cdcftdi_8h_source.html">cdcftdi.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FTDI:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_t_d_i__inherit__graph.png" border="0" usemap="#_f_t_d_i_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_t_d_i_inherit__map" id="_f_t_d_i_inherit__map">
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,91,27"/><area shape="rect" id="node3" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="116,5,204,27"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FTDI:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_t_d_i__coll__graph.png" border="0" usemap="#_f_t_d_i_coll__map" alt="Collaboration graph"/></div>
<map name="_f_t_d_i_coll__map" id="_f_t_d_i_coll__map">
<area shape="rect" id="node2" href="class_u_s_b_device_config.html" title="USBDeviceConfig" alt="" coords="5,5,91,27"/><area shape="rect" id="node3" href="class_usb_config_xtracter.html" title="UsbConfigXtracter" alt="" coords="116,5,204,27"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae517a5435ada4145998aa7b07e78adb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#ae517a5435ada4145998aa7b07e78adb3">FTDI</a> (<a class="el" href="class_u_s_b.html">USB</a> *pusb, <a class="el" href="class_f_t_d_i_async_oper.html">FTDIAsyncOper</a> *pasync)</td></tr>
<tr class="separator:ae517a5435ada4145998aa7b07e78adb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb8efdc33bd503563018b7eee577aecf"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#acb8efdc33bd503563018b7eee577aecf">SetBaudRate</a> (uint32_t baud)</td></tr>
<tr class="separator:acb8efdc33bd503563018b7eee577aecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86130f30e67e934346c3c7faf5ee6c56"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#a86130f30e67e934346c3c7faf5ee6c56">SetModemControl</a> (uint16_t control)</td></tr>
<tr class="separator:a86130f30e67e934346c3c7faf5ee6c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c107efeff2d46cb711cadd0a6c31636"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#a7c107efeff2d46cb711cadd0a6c31636">SetFlowControl</a> (uint8_t protocol, uint8_t xon=0x11, uint8_t xoff=0x13)</td></tr>
<tr class="separator:a7c107efeff2d46cb711cadd0a6c31636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7d7c305729fe4bbc746fa0569261a71"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#ab7d7c305729fe4bbc746fa0569261a71">SetData</a> (uint16_t databm)</td></tr>
<tr class="separator:ab7d7c305729fe4bbc746fa0569261a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa367ae72fbfda931cae8ec751e9dc434"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#aa367ae72fbfda931cae8ec751e9dc434">RcvData</a> (uint16_t *bytes_rcvd, uint8_t *dataptr)</td></tr>
<tr class="separator:aa367ae72fbfda931cae8ec751e9dc434"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90309b11a160bad9ceb0b77545b7a240"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#a90309b11a160bad9ceb0b77545b7a240">SndData</a> (uint16_t nbytes, uint8_t *dataptr)</td></tr>
<tr class="separator:a90309b11a160bad9ceb0b77545b7a240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d40115414dadfee8c284e0f5d397621"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#a2d40115414dadfee8c284e0f5d397621">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:a2d40115414dadfee8c284e0f5d397621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadee262e2eda31deda790d5d10090b6f"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#aadee262e2eda31deda790d5d10090b6f">Release</a> ()</td></tr>
<tr class="separator:aadee262e2eda31deda790d5d10090b6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f383dd8eb114563194da011f1d613fd"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#a5f383dd8eb114563194da011f1d613fd">Poll</a> ()</td></tr>
<tr class="separator:a5f383dd8eb114563194da011f1d613fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae224d7ea581e5df3b11416410a679086"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#ae224d7ea581e5df3b11416410a679086">GetAddress</a> ()</td></tr>
<tr class="separator:ae224d7ea581e5df3b11416410a679086"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e3f771b9f2a99fcedf7ed665b597109"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_t_d_i.html#a3e3f771b9f2a99fcedf7ed665b597109">EndpointXtract</a> (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep)</td></tr>
<tr class="separator:a3e3f771b9f2a99fcedf7ed665b597109"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae517a5435ada4145998aa7b07e78adb3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FTDI::FTDI </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td>
<td class="paramname"><em>pusb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_f_t_d_i_async_oper.html">FTDIAsyncOper</a> *&#160;</td>
<td class="paramname"><em>pasync</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3e3f771b9f2a99fcedf7ed665b597109"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void FTDI::EndpointXtract </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>conf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>alt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>proto</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *&#160;</td>
<td class="paramname"><em>ep</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_usb_config_xtracter.html#aceb5da8339172cbb2e9ce2064e34e5ef">UsbConfigXtracter</a>.</p>
</div>
</div>
<a class="anchor" id="ae224d7ea581e5df3b11416410a679086"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t FTDI::GetAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_u_s_b_device_config.html#aae3130517514c902bad5f153849b3811">USBDeviceConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a2d40115414dadfee8c284e0f5d397621"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::Init </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>lowspeed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_u_s_b_device_config.html#a391dc824a3271671890cebeb829b35ed">USBDeviceConfig</a>.</p>
</div>
</div>
<a class="anchor" id="a5f383dd8eb114563194da011f1d613fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::Poll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_u_s_b_device_config.html#a4961e92df3e75c38e6953fb08b11f8b6">USBDeviceConfig</a>.</p>
</div>
</div>
<a class="anchor" id="aa367ae72fbfda931cae8ec751e9dc434"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::RcvData </td>
<td>(</td>
<td class="paramtype">uint16_t *&#160;</td>
<td class="paramname"><em>bytes_rcvd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aadee262e2eda31deda790d5d10090b6f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::Release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="class_u_s_b_device_config.html#a74c06c5fe641b20faeeebd39e33248b3">USBDeviceConfig</a>.</p>
</div>
</div>
<a class="anchor" id="acb8efdc33bd503563018b7eee577aecf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::SetBaudRate </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>baud</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab7d7c305729fe4bbc746fa0569261a71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::SetData </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>databm</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7c107efeff2d46cb711cadd0a6c31636"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::SetFlowControl </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>protocol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>xon</em> = <code>0x11</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>xoff</em> = <code>0x13</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a86130f30e67e934346c3c7faf5ee6c56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::SetModemControl </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>control</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a90309b11a160bad9ceb0b77545b7a240"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FTDI::SndData </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>dataptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="cdcftdi_8h_source.html">cdcftdi.h</a></li>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="cdcftdi_8cpp.html">cdcftdi.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 30 2013 21:23:57 for USB_Host_Shield_2.0 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
Reference in a new issue Copy permalink