USB_Host_Shield_2.0/avrpins_8h.html
Kristian Sloth Lauszus bbaadbcfc4 Added Doxygen files
2013-01-30 22:00:18 +01:00

239 lines
20 KiB
HTML

<!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: /Users/Lauszus/GitHub/USB_Host_Shield_2.0/avrpins.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="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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_c8a8870798f18a14afbce47230dc4059.html">GitHub</a></li><li class="navelem"><a class="el" href="dir_8d22a5dfb299d0b3a2bdc551c5cdbd10.html">USB_Host_Shield_2.0</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">avrpins.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;avr/io.h&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for avrpins.h:</div>
<div class="dyncontent">
<div class="center"><img src="avrpins_8h__incl.png" border="0" usemap="#_2_users_2_lauszus_2_git_hub_2_u_s_b___host___shield__2_80_2avrpins_8h" alt=""/></div>
<map name="_2_users_2_lauszus_2_git_hub_2_u_s_b___host___shield__2_80_2avrpins_8h" id="_2_users_2_lauszus_2_git_hub_2_u_s_b___host___shield__2_80_2avrpins_8h">
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="avrpins_8h__dep__incl.png" border="0" usemap="#_2_users_2_lauszus_2_git_hub_2_u_s_b___host___shield__2_80_2avrpins_8hdep" alt=""/></div>
<map name="_2_users_2_lauszus_2_git_hub_2_u_s_b___host___shield__2_80_2avrpins_8hdep" id="_2_users_2_lauszus_2_git_hub_2_u_s_b___host___shield__2_80_2avrpins_8hdep">
<area shape="rect" id="node2" href="adk_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0/adk.h" alt="" coords="808,266,933,297"/><area shape="rect" id="node4" href="usbhost_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/usbhost.h" alt="" coords="1739,93,1843,133"/><area shape="rect" id="node5" href="_usb_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0/Usb.h" alt="" coords="1419,182,1545,213"/><area shape="rect" id="node14" href="cdcacm_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/cdcacm.h" alt="" coords="296,261,400,301"/><area shape="rect" id="node18" href="cdcftdi_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/cdcftdi.h" alt="" coords="680,261,784,301"/><area shape="rect" id="node16" href="cdcprolific_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/cdcprolific.h" alt="" coords="133,355,237,395"/><area shape="rect" id="node20" href="le3dp__rptparser_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/examples/HID/le3dp/le3dp\l_rptparser.h" alt="" coords="2121,350,2239,399"/><area shape="rect" id="node22" href="hidjoystickrptparser_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/examples/HID/USBHIDJoystick\l/hidjoystickrptparser.h" alt="" coords="2520,350,2656,399"/><area shape="rect" id="node24" href="hid_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0/hid.h" alt="" coords="2259,266,2383,297"/><area shape="rect" id="node26" href="hidboot_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hidboot.h" alt="" coords="1992,355,2096,395"/><area shape="rect" id="node28" href="hidescriptorparser_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hidescriptorparser.h" alt="" coords="1864,355,1968,395"/><area shape="rect" id="node32" href="masstorage_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/masstorage.h" alt="" coords="1749,261,1853,301"/><area shape="rect" id="node38" href="_usb_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/Usb.cpp" alt="" coords="1979,261,2083,301"/><area shape="rect" id="node39" href="usbhub_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/usbhub.h" alt="" coords="1621,261,1725,301"/><area shape="rect" id="node3" href="adk_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/adk.cpp" alt="" coords="949,355,1053,395"/><area shape="rect" id="node6" href="_b_t_d_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0/BTD.h" alt="" coords="526,266,655,297"/><area shape="rect" id="node34" href="max___l_c_d_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/max_LCD.h" alt="" coords="1085,261,1189,301"/><area shape="rect" id="node36" href="_p_s3_u_s_b_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/PS3USB.h" alt="" coords="1213,261,1317,301"/><area shape="rect" id="node41" href="_x_b_o_x_r_e_c_v_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/XBOXRECV.h" alt="" coords="957,261,1061,301"/><area shape="rect" id="node43" href="_x_b_o_x_u_s_b_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/XBOXUSB.h" alt="" coords="1341,261,1445,301"/><area shape="rect" id="node7" href="_b_t_d_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/BTD.cpp" alt="" coords="411,355,515,395"/><area shape="rect" id="node8" href="_p_s3_b_t_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/PS3BT.h" alt="" coords="539,355,643,395"/><area shape="rect" id="node10" href="_s_p_p_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0/SPP.h" alt="" coords="667,359,796,390"/><area shape="rect" id="node12" href="_wii_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0/Wii.h" alt="" coords="262,359,385,390"/><area shape="rect" id="node9" href="_p_s3_b_t_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/PS3BT.cpp" alt="" coords="539,453,643,493"/><area shape="rect" id="node11" href="_s_p_p_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/SPP.cpp" alt="" coords="680,453,784,493"/><area shape="rect" id="node13" href="_wii_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/Wii.cpp" alt="" coords="272,453,376,493"/><area shape="rect" id="node15" href="cdcacm_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/cdcacm.cpp" alt="" coords="5,355,109,395"/><area shape="rect" id="node17" href="cdcprolific_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/cdcprolific.cpp" alt="" coords="133,453,237,493"/><area shape="rect" id="node19" href="cdcftdi_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/cdcftdi.cpp" alt="" coords="821,355,925,395"/><area shape="rect" id="node21" href="le3dp__rptparser_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/examples/HID/le3dp/le3dp\l_rptparser.cpp" alt="" coords="2121,449,2239,498"/><area shape="rect" id="node23" href="hidjoystickrptparser_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/examples/HID/USBHIDJoystick\l/hidjoystickrptparser.cpp" alt="" coords="2520,449,2656,498"/><area shape="rect" id="node25" href="hid_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hid.cpp" alt="" coords="2392,355,2496,395"/><area shape="rect" id="node30" href="hiduniversal_8h.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hiduniversal.h" alt="" coords="2264,355,2368,395"/><area shape="rect" id="node27" href="hidboot_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hidboot.cpp" alt="" coords="1992,453,2096,493"/><area shape="rect" id="node29" href="hidescriptorparser_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hidescriptorparser.cpp" alt="" coords="1864,453,1968,493"/><area shape="rect" id="node31" href="hiduniversal_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/hiduniversal.cpp" alt="" coords="2264,453,2368,493"/><area shape="rect" id="node33" href="masstorage_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/masstorage.cpp" alt="" coords="1736,355,1840,395"/><area shape="rect" id="node35" href="max___l_c_d_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/max_LCD.cpp" alt="" coords="1205,355,1309,395"/><area shape="rect" id="node37" href="_p_s3_u_s_b_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/PS3USB.cpp" alt="" coords="1333,355,1437,395"/><area shape="rect" id="node40" href="usbhub_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/usbhub.cpp" alt="" coords="1608,355,1712,395"/><area shape="rect" id="node42" href="_x_b_o_x_r_e_c_v_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/XBOXRECV.cpp" alt="" coords="1077,355,1181,395"/><area shape="rect" id="node44" href="_x_b_o_x_u_s_b_8cpp.html" title="/Users/Lauszus/GitHub\l/USB_Host_Shield_2.0\l/XBOXUSB.cpp" alt="" coords="1461,355,1565,395"/></map>
</div>
</div>
<p><a href="avrpins_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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_pin.html">TPin&lt; PORT, PIN &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_com.html">TCom&lt; TCCR, COM &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tp___tc.html">Tp_Tc&lt; Tp_pin, Tc_bit &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a007409bc8f4dbfad293d3e4c59bd2921"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="avrpins_8h.html#a007409bc8f4dbfad293d3e4c59bd2921">MAKE_PORT</a>(portName, ddrName, pinName, className, ID)</td></tr>
<tr class="separator:a007409bc8f4dbfad293d3e4c59bd2921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade418bf397968e1b184b4342e16e950f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="avrpins_8h.html#ade418bf397968e1b184b4342e16e950f">MAKE_TCCR</a>(TccrName, className)</td></tr>
<tr class="separator:ade418bf397968e1b184b4342e16e950f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a007409bc8f4dbfad293d3e4c59bd2921"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAKE_PORT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">portName, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">ddrName, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">pinName, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">className, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">ID&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">class </span>className{\</div>
<div class="line"> public:\</div>
<div class="line"> typedef uint8_t DataT;\</div>
<div class="line"> public:\</div>
<div class="line"> static <span class="keywordtype">void</span> Write(DataT value){portName = value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> ClearAndSet(DataT clearMask, DataT value){portName = (portName &amp; ~clearMask) | value;}\</div>
<div class="line"> static DataT Read(){<span class="keywordflow">return</span> portName;}\</div>
<div class="line"> static <span class="keywordtype">void</span> DirWrite(DataT value){ddrName = value;}\</div>
<div class="line"> static DataT DirRead(){<span class="keywordflow">return</span> ddrName;}\</div>
<div class="line"> static <span class="keywordtype">void</span> Set(DataT value){portName |= value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> Clear(DataT value){portName &amp;= ~value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> Toggle(DataT value){portName ^= value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> DirSet(DataT value){ddrName |= value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> DirClear(DataT value){ddrName &amp;= ~value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> DirToggle(DataT value){ddrName ^= value;}\</div>
<div class="line"> static DataT PinRead(){<span class="keywordflow">return</span> pinName;}\</div>
<div class="line"> enum{Id = ID};\</div>
<div class="line"> enum{Width=<span class="keyword">sizeof</span>(DataT)*8};\</div>
<div class="line"> };</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ade418bf397968e1b184b4342e16e950f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAKE_TCCR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">TccrName, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">className&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">class </span>className{\</div>
<div class="line"> public:\</div>
<div class="line"> typedef uint8_t DataT;\</div>
<div class="line"> public:\</div>
<div class="line"> static <span class="keywordtype">void</span> Write(DataT value){TccrName = value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> ClearAndSet(DataT clearMask, DataT value){TccrName = (TccrName &amp; ~clearMask) | value;}\</div>
<div class="line"> static DataT Read(){<span class="keywordflow">return</span> TccrName;}\</div>
<div class="line"> static <span class="keywordtype">void</span> Set(DataT value){TccrName |= value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> Clear(DataT value){TccrName &amp;= ~value;}\</div>
<div class="line"> static <span class="keywordtype">void</span> Toggle(DataT value){TccrName ^= value;}\</div>
<div class="line"> enum{Width=<span class="keyword">sizeof</span>(DataT)*8};\</div>
<div class="line"> };</div>
</div><!-- fragment -->
</div>
</div>
</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>