USB_Host_Shield_2.0/class_m_a_x3421e.html

445 lines
21 KiB
HTML
Raw Normal View History

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: MAX3421e&lt; SS, INTR &gt; Class Template 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_m_a_x3421e-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MAX3421e&lt; SS, INTR &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="usbhost_8h_source.html">usbhost.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for MAX3421e&lt; SS, INTR &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_m_a_x3421e__inherit__graph.png" border="0" usemap="#_m_a_x3421e_3_01_s_s_00_01_i_n_t_r_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_m_a_x3421e_3_01_s_s_00_01_i_n_t_r_01_4_inherit__map" id="_m_a_x3421e_3_01_s_s_00_01_i_n_t_r_01_4_inherit__map">
<area shape="rect" id="node2" href="class_u_s_b.html" title="USB\&lt; P10, P9 \&gt;" alt="" coords="19,75,100,96"/></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:ac8b4177b9941d02042605d564fb37d0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#ac8b4177b9941d02042605d564fb37d0b">MAX3421e</a> ()</td></tr>
<tr class="separator:ac8b4177b9941d02042605d564fb37d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74e387200f57bc03152247d630c166aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a74e387200f57bc03152247d630c166aa">regWr</a> (uint8_t reg, uint8_t data)</td></tr>
<tr class="separator:a74e387200f57bc03152247d630c166aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac61db72bd5952916cdc6edc20e1c763c"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#ac61db72bd5952916cdc6edc20e1c763c">bytesWr</a> (uint8_t reg, uint8_t nbytes, uint8_t *data_p)</td></tr>
<tr class="separator:ac61db72bd5952916cdc6edc20e1c763c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b925f552f25cb26eb317f73f9ade664"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a7b925f552f25cb26eb317f73f9ade664">gpioWr</a> (uint8_t data)</td></tr>
<tr class="separator:a7b925f552f25cb26eb317f73f9ade664"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7faae82a8d68c38b43833b8fddcb8e8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#ae7faae82a8d68c38b43833b8fddcb8e8">regRd</a> (uint8_t reg)</td></tr>
<tr class="separator:ae7faae82a8d68c38b43833b8fddcb8e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1ceb905ac614b98d58579946587b083"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#af1ceb905ac614b98d58579946587b083">bytesRd</a> (uint8_t reg, uint8_t nbytes, uint8_t *data_p)</td></tr>
<tr class="separator:af1ceb905ac614b98d58579946587b083"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ceb313de4a652ebd49b9b4eeb763826"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a3ceb313de4a652ebd49b9b4eeb763826">gpioRd</a> ()</td></tr>
<tr class="separator:a3ceb313de4a652ebd49b9b4eeb763826"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2b85831a551d8e30496882ce7e57fd2"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#ad2b85831a551d8e30496882ce7e57fd2">reset</a> ()</td></tr>
<tr class="separator:ad2b85831a551d8e30496882ce7e57fd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8414e5a161ca272e435b9ab7f5db92ea"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a8414e5a161ca272e435b9ab7f5db92ea">Init</a> ()</td></tr>
<tr class="separator:a8414e5a161ca272e435b9ab7f5db92ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0353d430ba18466706337ed623a224e3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a0353d430ba18466706337ed623a224e3">getVbusState</a> (void)</td></tr>
<tr class="separator:a0353d430ba18466706337ed623a224e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23e4762107dd807520c8a8ed21ed97a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a23e4762107dd807520c8a8ed21ed97a2">busprobe</a> ()</td></tr>
<tr class="separator:a23e4762107dd807520c8a8ed21ed97a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1b6b02fc7dc05a2c7ae660076d9961a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#af1b6b02fc7dc05a2c7ae660076d9961a">GpxHandler</a> ()</td></tr>
<tr class="separator:af1b6b02fc7dc05a2c7ae660076d9961a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6da568ef3f5a7188d94f0287f6e7ad3a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#a6da568ef3f5a7188d94f0287f6e7ad3a">IntHandler</a> ()</td></tr>
<tr class="separator:a6da568ef3f5a7188d94f0287f6e7ad3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb5728095a05814d6ae3c8ddb0452969"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_a_x3421e.html#acb5728095a05814d6ae3c8ddb0452969">Task</a> ()</td></tr>
<tr class="separator:acb5728095a05814d6ae3c8ddb0452969"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac8b4177b9941d02042605d564fb37d0b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::<a class="el" href="class_m_a_x3421e.html">MAX3421e</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a23e4762107dd807520c8a8ed21ed97a2"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::busprobe </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af1ceb905ac614b98d58579946587b083"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t * <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::bytesRd </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_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>data_p</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="ac61db72bd5952916cdc6edc20e1c763c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t * <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::bytesWr </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_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>data_p</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="a0353d430ba18466706337ed623a224e3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::getVbusState </td>
<td>(</td>
<td class="paramtype">void&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3ceb313de4a652ebd49b9b4eeb763826"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::gpioRd </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7b925f552f25cb26eb317f73f9ade664"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::gpioWr </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af1b6b02fc7dc05a2c7ae660076d9961a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::GpxHandler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8414e5a161ca272e435b9ab7f5db92ea"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">int8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::Init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<ul>
<li>initialize MAX3421E. Set Host mode, pullups, and stuff. Returns 0 if success, -1 if not */ </li>
</ul>
</div>
</div>
<a class="anchor" id="a6da568ef3f5a7188d94f0287f6e7ad3a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::IntHandler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae7faae82a8d68c38b43833b8fddcb8e8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::regRd </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a74e387200f57bc03152247d630c166aa"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::regWr </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>data</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="ad2b85831a551d8e30496882ce7e57fd2"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acb5728095a05814d6ae3c8ddb0452969"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename SS , typename INTR &gt; </div>
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_m_a_x3421e.html">MAX3421e</a>&lt; SS, INTR &gt;::Task </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Users/Lauszus/GitHub/USB_Host_Shield_2.0/<a class="el" href="usbhost_8h_source.html">usbhost.h</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>