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/hidboot_8h.html
Kristian Sloth Lauszus 9b34049782 Updated the documentation
2018-10-13 15:47:19 +02:00

341 lines
19 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" 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.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_69161428018e52ad84691a5947f27cc9.html">Github</a></li><li class="navelem"><a class="el" href="dir_ee762931928e29ae94e054d18c99dc9e.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">hidboot.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="usbhid_8h_source.html">usbhid.h</a>&quot;</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="usbhid_8h.html" title="usbhid.h" alt="" coords="8,79,79,104"/>
<area shape="rect" id="node3" href="_usb_8h.html" title="Usb.h" alt="" coords="15,225,72,251"/>
<area shape="rect" id="node4" href="hidusagestr_8h.html" title="hidusagestr.h" alt="" coords="37,152,138,177"/>
</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="64,79,137,104"/>
<area shape="rect" id="node5" href="hidboot_8cpp.html" title="hidboot.cpp" alt="" coords="161,79,251,104"/>
<area shape="rect" id="node3" href="_b_t_h_i_d_8cpp.html" title="BTHID.cpp" alt="" coords="5,152,92,177"/>
<area shape="rect" id="node4" href="_p_s4_b_t_8h.html" title="PS4BT.h" alt="" coords="116,152,189,177"/>
</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 &#160;</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">&#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_mouse_report_parser.html">MouseReportParser</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</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">&#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_keyboard_report_parser.html">KeyboardReportParser</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_h_i_d_boot.html">HIDBoot&lt; BOOT_PROTOCOL &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:a2458c33386b5c5d5bd2fc0544c9ff70c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a2458c33386b5c5d5bd2fc0544c9ff70c">UHS_HID_BOOT_KEY_ZERO</a>&#160;&#160;&#160;0x27</td></tr>
<tr class="separator:a2458c33386b5c5d5bd2fc0544c9ff70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42f71f6d2b7e4f543826af0234834237"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a42f71f6d2b7e4f543826af0234834237">UHS_HID_BOOT_KEY_ENTER</a>&#160;&#160;&#160;0x28</td></tr>
<tr class="separator:a42f71f6d2b7e4f543826af0234834237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abedef4cc17add7fafbbcda43b442964b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#abedef4cc17add7fafbbcda43b442964b">UHS_HID_BOOT_KEY_SPACE</a>&#160;&#160;&#160;0x2c</td></tr>
<tr class="separator:abedef4cc17add7fafbbcda43b442964b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85200689879c7520e38541fa8ba29ade"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a85200689879c7520e38541fa8ba29ade">UHS_HID_BOOT_KEY_CAPS_LOCK</a>&#160;&#160;&#160;0x39</td></tr>
<tr class="separator:a85200689879c7520e38541fa8ba29ade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad13513d5056e7bfe9f5a2f17e7cc8e42"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#ad13513d5056e7bfe9f5a2f17e7cc8e42">UHS_HID_BOOT_KEY_SCROLL_LOCK</a>&#160;&#160;&#160;0x47</td></tr>
<tr class="separator:ad13513d5056e7bfe9f5a2f17e7cc8e42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abed3f994055e37e80bede60fda7ea056"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#abed3f994055e37e80bede60fda7ea056">UHS_HID_BOOT_KEY_NUM_LOCK</a>&#160;&#160;&#160;0x53</td></tr>
<tr class="separator:abed3f994055e37e80bede60fda7ea056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69193f2a5138ebecc6819e21e6b31c45"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a69193f2a5138ebecc6819e21e6b31c45">UHS_HID_BOOT_KEY_ZERO2</a>&#160;&#160;&#160;0x62</td></tr>
<tr class="separator:a69193f2a5138ebecc6819e21e6b31c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70520f779398f17618bbf6848472eecd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#a70520f779398f17618bbf6848472eecd">UHS_HID_BOOT_KEY_PERIOD</a>&#160;&#160;&#160;0x63</td></tr>
<tr class="separator:a70520f779398f17618bbf6848472eecd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeec5ae1b55787b14d82c653eb9b920ee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#aeec5ae1b55787b14d82c653eb9b920ee">bitsEndpoints</a>(p)&#160;&#160;&#160;((((p) &amp; <a class="el" href="usbhid_8h.html#ad19f323d7585e5a41cc4f8125447552b">USB_HID_PROTOCOL_KEYBOARD</a>)? 2 : 0) | (((p) &amp; <a class="el" href="usbhid_8h.html#a538d261ce3c8526071211fdbde1a67ec">USB_HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td></tr>
<tr class="separator:aeec5ae1b55787b14d82c653eb9b920ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1e198c16d2e9fad0e5c025e801f2fae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#aa1e198c16d2e9fad0e5c025e801f2fae">totalEndpoints</a>(p)&#160;&#160;&#160;((<a class="el" href="hidboot_8h.html#aeec5ae1b55787b14d82c653eb9b920ee">bitsEndpoints</a>(p) == 3) ? 3 : 2)</td></tr>
<tr class="separator:aa1e198c16d2e9fad0e5c025e801f2fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd1564d789b53fcf08fa5c4d9b0121d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hidboot_8h.html#abbd1564d789b53fcf08fa5c4d9b0121d">epMUL</a>(p)&#160;&#160;&#160;((((p) &amp; <a class="el" href="usbhid_8h.html#ad19f323d7585e5a41cc4f8125447552b">USB_HID_PROTOCOL_KEYBOARD</a>)? 1 : 0) + (((p) &amp; <a class="el" href="usbhid_8h.html#a538d261ce3c8526071211fdbde1a67ec">USB_HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td></tr>
<tr class="separator:abbd1564d789b53fcf08fa5c4d9b0121d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a2458c33386b5c5d5bd2fc0544c9ff70c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2458c33386b5c5d5bd2fc0544c9ff70c">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_ZERO</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_ZERO&#160;&#160;&#160;0x27</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">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 id="a42f71f6d2b7e4f543826af0234834237"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42f71f6d2b7e4f543826af0234834237">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_ENTER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_ENTER&#160;&#160;&#160;0x28</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">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 id="abedef4cc17add7fafbbcda43b442964b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abedef4cc17add7fafbbcda43b442964b">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_SPACE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_SPACE&#160;&#160;&#160;0x2c</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">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 id="a85200689879c7520e38541fa8ba29ade"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85200689879c7520e38541fa8ba29ade">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_CAPS_LOCK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_CAPS_LOCK&#160;&#160;&#160;0x39</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">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 id="ad13513d5056e7bfe9f5a2f17e7cc8e42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad13513d5056e7bfe9f5a2f17e7cc8e42">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_SCROLL_LOCK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_SCROLL_LOCK&#160;&#160;&#160;0x47</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">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 id="abed3f994055e37e80bede60fda7ea056"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abed3f994055e37e80bede60fda7ea056">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_NUM_LOCK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_NUM_LOCK&#160;&#160;&#160;0x53</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00027">27</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="a69193f2a5138ebecc6819e21e6b31c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69193f2a5138ebecc6819e21e6b31c45">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_ZERO2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_ZERO2&#160;&#160;&#160;0x62</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00028">28</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="a70520f779398f17618bbf6848472eecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70520f779398f17618bbf6848472eecd">&#9670;&nbsp;</a></span>UHS_HID_BOOT_KEY_PERIOD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UHS_HID_BOOT_KEY_PERIOD&#160;&#160;&#160;0x63</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00029">29</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="aeec5ae1b55787b14d82c653eb9b920ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeec5ae1b55787b14d82c653eb9b920ee">&#9670;&nbsp;</a></span>bitsEndpoints</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bitsEndpoints</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">p</td><td>)</td>
<td>&#160;&#160;&#160;((((p) &amp; <a class="el" href="usbhid_8h.html#ad19f323d7585e5a41cc4f8125447552b">USB_HID_PROTOCOL_KEYBOARD</a>)? 2 : 0) | (((p) &amp; <a class="el" href="usbhid_8h.html#a538d261ce3c8526071211fdbde1a67ec">USB_HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00032">32</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="aa1e198c16d2e9fad0e5c025e801f2fae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1e198c16d2e9fad0e5c025e801f2fae">&#9670;&nbsp;</a></span>totalEndpoints</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define totalEndpoints</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">p</td><td>)</td>
<td>&#160;&#160;&#160;((<a class="el" href="hidboot_8h.html#aeec5ae1b55787b14d82c653eb9b920ee">bitsEndpoints</a>(p) == 3) ? 3 : 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00033">33</a> of file <a class="el" href="hidboot_8h_source.html">hidboot.h</a>.</p>
</div>
</div>
<a id="abbd1564d789b53fcf08fa5c4d9b0121d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbd1564d789b53fcf08fa5c4d9b0121d">&#9670;&nbsp;</a></span>epMUL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define epMUL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">p</td><td>)</td>
<td>&#160;&#160;&#160;((((p) &amp; <a class="el" href="usbhid_8h.html#ad19f323d7585e5a41cc4f8125447552b">USB_HID_PROTOCOL_KEYBOARD</a>)? 1 : 0) + (((p) &amp; <a class="el" href="usbhid_8h.html#a538d261ce3c8526071211fdbde1a67ec">USB_HID_PROTOCOL_MOUSE</a>)? 1 : 0))</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hidboot_8h_source.html#l00034">34</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink