wut/group__nsyshid__hid.html
2020-03-26 16:49:18 +11:00

905 lines
40 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: HID API</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" />
</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">wut
&#160;<span id="projectnumber">1.0.0-beta9</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">HID API<div class="ingroups"><a class="el" href="group__nsyshid.html">nsyshid</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structHIDDevice"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#structHIDDevice">HIDDevice</a></td></tr>
<tr class="separator:structHIDDevice"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structHIDClient"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a></td></tr>
<tr class="separator:structHIDClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga26f9ce29d0bf4bb782919e78756dfbdf"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga26f9ce29d0bf4bb782919e78756dfbdf">HIDClient</a></td></tr>
<tr class="separator:ga26f9ce29d0bf4bb782919e78756dfbdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa80ad69f23fd454a293cd606a6d9d953"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__nsyshid__hid.html#structHIDDevice">HIDDevice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#gaa80ad69f23fd454a293cd606a6d9d953">HIDDevice</a></td></tr>
<tr class="separator:gaa80ad69f23fd454a293cd606a6d9d953"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65cc258229855ef8ce38591eb21db806"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga65cc258229855ef8ce38591eb21db806">HIDAttachEvent</a></td></tr>
<tr class="separator:ga65cc258229855ef8ce38591eb21db806"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2907c52bbbb78a84b675425097ec55cf"><td class="memItemLeft" align="right" valign="top">typedef int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga2907c52bbbb78a84b675425097ec55cf">HIDAttachCallback</a>) (<a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *client, <a class="el" href="group__nsyshid__hid.html#structHIDDevice">HIDDevice</a> *device, <a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a> attach)</td></tr>
<tr class="separator:ga2907c52bbbb78a84b675425097ec55cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f843e0018e8f49785d5c8db103228f8"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>) (uint32_t handle, int32_t error, uint8_t *buffer, uint32_t bytesTransferred, void *userContext)</td></tr>
<tr class="separator:ga4f843e0018e8f49785d5c8db103228f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga01cfa0df94f3e3870562d1d4f8d35005"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a> { <br />
&#160;&#160;<a class="el" href="group__nsyshid__hid.html#gga01cfa0df94f3e3870562d1d4f8d35005a1eafdd0a8215fb85f364425fc5115ca2">HID_DEVICE_DETACH</a> = 0,
<br />
&#160;&#160;<a class="el" href="group__nsyshid__hid.html#gga01cfa0df94f3e3870562d1d4f8d35005a507069db7a30c1b0e383fce3a51604bf">HID_DEVICE_ATTACH</a> = 1
<br />
}</td></tr>
<tr class="separator:ga01cfa0df94f3e3870562d1d4f8d35005"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa81b1b19467d27b76d689490bfe1c65f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#gaa81b1b19467d27b76d689490bfe1c65f">HIDSetup</a> ()</td></tr>
<tr class="separator:gaa81b1b19467d27b76d689490bfe1c65f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga514782cac13a1d21579abedfb94b16af"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga514782cac13a1d21579abedfb94b16af">HIDTeardown</a> ()</td></tr>
<tr class="separator:ga514782cac13a1d21579abedfb94b16af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4bd8a1a2fce63c49cbd79e17d569ae38"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga4bd8a1a2fce63c49cbd79e17d569ae38">HIDAddClient</a> (<a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *client, <a class="el" href="group__nsyshid__hid.html#ga2907c52bbbb78a84b675425097ec55cf">HIDAttachCallback</a> attachCallback)</td></tr>
<tr class="separator:ga4bd8a1a2fce63c49cbd79e17d569ae38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87122a013c0c0acfd54059902b514e0c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga87122a013c0c0acfd54059902b514e0c">HIDDelClient</a> (<a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *client)</td></tr>
<tr class="separator:ga87122a013c0c0acfd54059902b514e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12113ad83015db2e70ba5c342a4e2e17"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga12113ad83015db2e70ba5c342a4e2e17">HIDGetDescriptor</a> (uint32_t handle, uint8_t descriptorType, uint8_t descriptorIndex, uint16_t languageId, uint8_t *buffer, uint32_t bufferLength, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:ga12113ad83015db2e70ba5c342a4e2e17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafbc73f057275c70cfacd8203bbe026d9"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#gafbc73f057275c70cfacd8203bbe026d9">HIDSetDescriptor</a> (uint32_t handle, uint8_t descriptorType, uint8_t descriptorIndex, uint16_t languageId, uint8_t *buffer, uint32_t bufferLength, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:gafbc73f057275c70cfacd8203bbe026d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f524c938237c23b3c8c1b4e21613ba9"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga5f524c938237c23b3c8c1b4e21613ba9">HIDGetReport</a> (uint32_t handle, uint8_t reportType, uint8_t reportId, uint8_t *buffer, uint32_t bufferLength, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:ga5f524c938237c23b3c8c1b4e21613ba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3039149a2bb4b95ac00dac07f08224cd"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga3039149a2bb4b95ac00dac07f08224cd">HIDSetReport</a> (uint32_t handle, uint8_t reportType, uint8_t reportId, uint8_t *buffer, uint32_t bufferLength, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:ga3039149a2bb4b95ac00dac07f08224cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8812a717621f2122e5d8cd5fb87126bd"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga8812a717621f2122e5d8cd5fb87126bd">HIDSetIdle</a> (uint32_t handle, uint8_t interfaceIndex, uint8_t duration, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:ga8812a717621f2122e5d8cd5fb87126bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffb543d582fe46701c450049962ec6b2"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#gaffb543d582fe46701c450049962ec6b2">HIDSetProtocol</a> (uint32_t handle, uint8_t interfaceIndex, uint8_t protocol, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:gaffb543d582fe46701c450049962ec6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae29f4d9f222de91b19f9d2c43c8b27b7"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#gae29f4d9f222de91b19f9d2c43c8b27b7">HIDGetProtocol</a> (uint32_t handle, uint8_t interfaceIndex, uint8_t *protocol, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:gae29f4d9f222de91b19f9d2c43c8b27b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa274a2eafa9e8dc2658ddc778a992c21"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#gaa274a2eafa9e8dc2658ddc778a992c21">HIDRead</a> (uint32_t handle, uint8_t *buffer, uint32_t bufferLength, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> callback, void *userContext)</td></tr>
<tr class="separator:gaa274a2eafa9e8dc2658ddc778a992c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7913fc0a9551c55ea2f38534acc1eaa9"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nsyshid__hid.html#ga7913fc0a9551c55ea2f38534acc1eaa9">HIDWrite</a> (uint32_t handle, uint8_t *buffer, uint32_t bufferLength, <a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a> hc, void *userContext)</td></tr>
<tr class="separator:ga7913fc0a9551c55ea2f38534acc1eaa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structHIDDevice" id="structHIDDevice"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structHIDDevice">&#9670;&nbsp;</a></span>HIDDevice</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct HIDDevice</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00034">34</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="aa8bec03983fc2371ab6afa98ae6ddd45"></a>uint32_t</td>
<td class="fieldname">
handle</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="af64b183c62a46421de4759f198e64fd3"></a>uint32_t</td>
<td class="fieldname">
physicalDeviceInst</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="aac5ffad7f07bfef80deaef77e0eeca69"></a>uint16_t</td>
<td class="fieldname">
vid</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a9089e9c40db82122a499b9620e2cb54e"></a>uint16_t</td>
<td class="fieldname">
pid</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a5a3fc280d64e7ac506df87207fd8188f"></a>uint8_t</td>
<td class="fieldname">
interfaceIndex</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a145e5c192b5b2fc3c55934b5c47f3f2d"></a>uint8_t</td>
<td class="fieldname">
subClass</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="ad124d3d2e02c729afa303c775295278e"></a>uint8_t</td>
<td class="fieldname">
protocol</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a46d4715e17b4ac5529b7009c91c9d978"></a>uint16_t</td>
<td class="fieldname">
maxPacketSizeRx</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a7dbc37969d132e2518795afd7aa5fa09"></a>uint16_t</td>
<td class="fieldname">
maxPacketSizeTx</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structHIDClient" id="structHIDClient"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structHIDClient">&#9670;&nbsp;</a></span>HIDClient</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct HIDClient</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00058">58</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a4d06264f4e8a3ab8e095f260d5ee1ecd"></a><a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *</td>
<td class="fieldname">
next</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a273089b169843b07232ae9fdcc0b5019"></a><a class="el" href="group__nsyshid__hid.html#ga2907c52bbbb78a84b675425097ec55cf">HIDAttachCallback</a></td>
<td class="fieldname">
attachCallback</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga26f9ce29d0bf4bb782919e78756dfbdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26f9ce29d0bf4bb782919e78756dfbdf">&#9670;&nbsp;</a></span>HIDClient</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> <a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00013">13</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a id="gaa80ad69f23fd454a293cd606a6d9d953"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa80ad69f23fd454a293cd606a6d9d953">&#9670;&nbsp;</a></span>HIDDevice</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__nsyshid__hid.html#structHIDDevice">HIDDevice</a> <a class="el" href="group__nsyshid__hid.html#structHIDDevice">HIDDevice</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00014">14</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a id="ga65cc258229855ef8ce38591eb21db806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65cc258229855ef8ce38591eb21db806">&#9670;&nbsp;</a></span>HIDAttachEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a> <a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga2907c52bbbb78a84b675425097ec55cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2907c52bbbb78a84b675425097ec55cf">&#9670;&nbsp;</a></span>HIDAttachCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32_t(* HIDAttachCallback) (<a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *client, <a class="el" href="group__nsyshid__hid.html#structHIDDevice">HIDDevice</a> *device, <a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a> attach)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00023">23</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<a id="ga4f843e0018e8f49785d5c8db103228f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f843e0018e8f49785d5c8db103228f8">&#9670;&nbsp;</a></span>HIDCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* HIDCallback) (uint32_t handle, int32_t error, uint8_t *buffer, uint32_t bytesTransferred, void *userContext)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00028">28</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga01cfa0df94f3e3870562d1d4f8d35005"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga01cfa0df94f3e3870562d1d4f8d35005">&#9670;&nbsp;</a></span>HIDAttachEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__nsyshid__hid.html#ga01cfa0df94f3e3870562d1d4f8d35005">HIDAttachEvent</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga01cfa0df94f3e3870562d1d4f8d35005a1eafdd0a8215fb85f364425fc5115ca2"></a>HID_DEVICE_DETACH&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga01cfa0df94f3e3870562d1d4f8d35005a507069db7a30c1b0e383fce3a51604bf"></a>HID_DEVICE_ATTACH&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="hid_8h_source.html#l00016">16</a> of file <a class="el" href="hid_8h_source.html">hid.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa81b1b19467d27b76d689490bfe1c65f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa81b1b19467d27b76d689490bfe1c65f">&#9670;&nbsp;</a></span>HIDSetup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDSetup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga514782cac13a1d21579abedfb94b16af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga514782cac13a1d21579abedfb94b16af">&#9670;&nbsp;</a></span>HIDTeardown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDTeardown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga4bd8a1a2fce63c49cbd79e17d569ae38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4bd8a1a2fce63c49cbd79e17d569ae38">&#9670;&nbsp;</a></span>HIDAddClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDAddClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *&#160;</td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga2907c52bbbb78a84b675425097ec55cf">HIDAttachCallback</a>&#160;</td>
<td class="paramname"><em>attachCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga87122a013c0c0acfd54059902b514e0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga87122a013c0c0acfd54059902b514e0c">&#9670;&nbsp;</a></span>HIDDelClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDDelClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#structHIDClient">HIDClient</a> *&#160;</td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga12113ad83015db2e70ba5c342a4e2e17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga12113ad83015db2e70ba5c342a4e2e17">&#9670;&nbsp;</a></span>HIDGetDescriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDGetDescriptor </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>descriptorType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>descriptorIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>languageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bufferLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gafbc73f057275c70cfacd8203bbe026d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafbc73f057275c70cfacd8203bbe026d9">&#9670;&nbsp;</a></span>HIDSetDescriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDSetDescriptor </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>descriptorType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>descriptorIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>languageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bufferLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga5f524c938237c23b3c8c1b4e21613ba9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5f524c938237c23b3c8c1b4e21613ba9">&#9670;&nbsp;</a></span>HIDGetReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDGetReport </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bufferLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga3039149a2bb4b95ac00dac07f08224cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3039149a2bb4b95ac00dac07f08224cd">&#9670;&nbsp;</a></span>HIDSetReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDSetReport </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>reportId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bufferLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga8812a717621f2122e5d8cd5fb87126bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8812a717621f2122e5d8cd5fb87126bd">&#9670;&nbsp;</a></span>HIDSetIdle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDSetIdle </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>interfaceIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaffb543d582fe46701c450049962ec6b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaffb543d582fe46701c450049962ec6b2">&#9670;&nbsp;</a></span>HIDSetProtocol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDSetProtocol </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>interfaceIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></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"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gae29f4d9f222de91b19f9d2c43c8b27b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae29f4d9f222de91b19f9d2c43c8b27b7">&#9670;&nbsp;</a></span>HIDGetProtocol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDGetProtocol </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>interfaceIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></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"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaa274a2eafa9e8dc2658ddc778a992c21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa274a2eafa9e8dc2658ddc778a992c21">&#9670;&nbsp;</a></span>HIDRead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDRead </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bufferLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga7913fc0a9551c55ea2f38534acc1eaa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7913fc0a9551c55ea2f38534acc1eaa9">&#9670;&nbsp;</a></span>HIDWrite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t HIDWrite </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bufferLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__nsyshid__hid.html#ga4f843e0018e8f49785d5c8db103228f8">HIDCallback</a>&#160;</td>
<td class="paramname"><em>hc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>userContext</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</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.17
</small></address>
</body>
</html>