<!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.5"/>
<title>USB Host Shield 2.0: hidboot.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" />
<link href="imageStyle.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.5 -->
<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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="globals.html"><span>File 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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_e5fbe6d2783ccd4c93c7856d92d7be6e.html">GitHub</a></li><li class="navelem"><a class="el" href="dir_397a095372f04465e811d0ee219bbf8f.html">USB_Host_Shield_2.0</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">hidboot.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="hid_8h_source.html">hid.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for hidboot.h:</div>
<div class="dyncontent">
<div class="center"><img src="hidboot_8h__incl.png" border="0" usemap="#hidboot_8h" alt=""/></div>
<map name="hidboot_8h" id="hidboot_8h">
<area shape="rect" id="node2" href="hid_8h.html" title="hid.h" alt="" coords="59,83,108,111"/><area shape="rect" id="node3" href="_usb_8h.html" title="Usb.h" alt="" coords="5,161,61,189"/><area shape="rect" id="node4" href="hidusagestr_8h.html" title="hidusagestr.h" alt="" coords="86,161,185,189"/></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="hidboot_8h__dep__incl.png" border="0" usemap="#hidboot_8hdep" alt=""/></div>
<map name="hidboot_8hdep" id="hidboot_8hdep">
<area shape="rect" id="node2" href="_b_t_h_i_d_8h.html" title="BTHID.h" alt="" coords="12,83,84,111"/><area shape="rect" id="node4" href="hidboot_8cpp.html" title="hidboot.cpp" alt="" coords="108,83,197,111"/><area shape="rect" id="node3" href="_b_t_h_i_d_8cpp.html" title="BTHID.cpp" alt="" coords="5,161,91,189"/></map>
</div>
</div>
<p><a href="hidboot_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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_o_u_s_e_i_n_f_o.html">MOUSEINFO</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mouse_report_parser.html">MouseReportParser</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_o_d_i_f_i_e_r_k_e_y_s.html">MODIFIERKEYS</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_k_b_d_i_n_f_o.html">KBDINFO</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_k_b_d_l_e_d_s.html">KBDLEDS</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keyboard_report_parser.html">KeyboardReportParser</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_boot.html">HIDBoot< BOOT_PROTOCOL ></a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a8a5ff83d21dfa704c1c3eff56d5b3a4b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a8a5ff83d21dfa704c1c3eff56d5b3a4b">KEY_SPACE</a>   0x2c</td></tr>
<tr class="separator:a8a5ff83d21dfa704c1c3eff56d5b3a4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a814922ab1199d78d521bc9157b108063"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a814922ab1199d78d521bc9157b108063">KEY_ZERO</a>   0x27</td></tr>
<tr class="separator:a814922ab1199d78d521bc9157b108063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8ccc5884206b4200185b8899b80b390"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#aa8ccc5884206b4200185b8899b80b390">KEY_ZERO2</a>   0x62</td></tr>
<tr class="separator:aa8ccc5884206b4200185b8899b80b390"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaee5edb96e542206ae6c8102ac228af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#abaee5edb96e542206ae6c8102ac228af">KEY_ENTER</a>   0x28</td></tr>
<tr class="separator:abaee5edb96e542206ae6c8102ac228af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53f3c246f66d6cd725ff79bb3b1e0c74"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a53f3c246f66d6cd725ff79bb3b1e0c74">KEY_PERIOD</a>   0x63</td></tr>
<tr class="separator:a53f3c246f66d6cd725ff79bb3b1e0c74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accb7a413ed6fa7db7192fc957d477ab8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#accb7a413ed6fa7db7192fc957d477ab8">KEY_NUM_LOCK</a>   0x53</td></tr>
<tr class="separator:accb7a413ed6fa7db7192fc957d477ab8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaac34940ff83d1431044aaca015639ce"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#aaac34940ff83d1431044aaca015639ce">KEY_CAPS_LOCK</a>   0x39</td></tr>
<tr class="separator:aaac34940ff83d1431044aaca015639ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab94d4309f6059492ef7dbf1a880cf7e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#ab94d4309f6059492ef7dbf1a880cf7e0">KEY_SCROLL_LOCK</a>   0x47</td></tr>
<tr class="separator:ab94d4309f6059492ef7dbf1a880cf7e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0baace07f695b00819059462a19f34fd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a0baace07f695b00819059462a19f34fd">totalEndpoints</a>   (((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#a059227938fbd1b45ce693d91d2856ca9">HID_PROTOCOL_KEYBOARD</a>)? 2 : 0)+((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#aeabcfc288ffa25ac6896d19e0642b104">HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td></tr>
<tr class="separator:a0baace07f695b00819059462a19f34fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3dce23ba2c4c289645510dc8f51b65a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#ab3dce23ba2c4c289645510dc8f51b65a">epMUL</a>   (((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#a059227938fbd1b45ce693d91d2856ca9">HID_PROTOCOL_KEYBOARD</a>)? 1 : 0)+((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#aeabcfc288ffa25ac6896d19e0642b104">HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td></tr>
<tr class="separator:ab3dce23ba2c4c289645510dc8f51b65a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9901c86718db1fefe5d116aa254361cf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a9901c86718db1fefe5d116aa254361cf">HID_MAX_HID_CLASS_DESCRIPTORS</a>   5</td></tr>
<tr class="separator:a9901c86718db1fefe5d116aa254361cf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a8a5ff83d21dfa704c1c3eff56d5b3a4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_SPACE   0x2c</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00022">22</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a814922ab1199d78d521bc9157b108063"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_ZERO   0x27</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00023">23</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa8ccc5884206b4200185b8899b80b390"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_ZERO2   0x62</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00024">24</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="abaee5edb96e542206ae6c8102ac228af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_ENTER   0x28</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00025">25</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a53f3c246f66d6cd725ff79bb3b1e0c74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_PERIOD   0x63</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00026">26</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="accb7a413ed6fa7db7192fc957d477ab8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_NUM_LOCK   0x53</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00110">110</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaac34940ff83d1431044aaca015639ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_CAPS_LOCK   0x39</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00111">111</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab94d4309f6059492ef7dbf1a880cf7e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_SCROLL_LOCK   0x47</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00112">112</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0baace07f695b00819059462a19f34fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define totalEndpoints   (((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#a059227938fbd1b45ce693d91d2856ca9">HID_PROTOCOL_KEYBOARD</a>)? 2 : 0)+((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#aeabcfc288ffa25ac6896d19e0642b104">HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00155">155</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab3dce23ba2c4c289645510dc8f51b65a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define epMUL   (((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#a059227938fbd1b45ce693d91d2856ca9">HID_PROTOCOL_KEYBOARD</a>)? 1 : 0)+((BOOT_PROTOCOL & <a class="el" href="hid_8h.html#aeabcfc288ffa25ac6896d19e0642b104">HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00156">156</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9901c86718db1fefe5d116aa254361cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HID_MAX_HID_CLASS_DESCRIPTORS   5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hidboot_8h_source.html#l00157">157</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>