mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 12:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/usbhs_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

1126 lines
77 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/services/usbhs.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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">usbhs.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>USB (usb:hs) devices service IPC wrapper.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="service_8h_source.html">../sf/service.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="usb_8h_source.html">../services/usb.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="event_8h_source.html">../kernel/event.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="tmem_8h_source.html">../kernel/tmem.h</a>&quot;</code><br />
</div>
<p><a href="usbhs_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 id="nested-classes" name="nested-classes"></a>
Data Structures</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="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface filtering struct. <a href="structUsbHsInterfaceFilter.html#details">More...</a><br /></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="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Descriptors which are not available are set to all-zero. <a href="structUsbHsInterfaceInfo.html#details">More...</a><br /></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="structUsbHsInterface.html">UsbHsInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface struct. Note that devices have a seperate <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> for each interface. <a href="structUsbHsInterface.html#details">More...</a><br /></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="structUsbHsXferReport.html">UsbHsXferReport</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="structUsbHsRingHeader.html">UsbHsRingHeader</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="structUsbHsClientIfSession.html">UsbHsClientIfSession</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The interface service object. These Events have autoclear=false. <a href="structUsbHsClientIfSession.html#details">More...</a><br /></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="structUsbHsClientEpSession.html">UsbHsClientEpSession</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 id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0dbdcc3c2cc14ea8e35146636c4ecd58" id="r_a0dbdcc3c2cc14ea8e35146636c4ecd58"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a0dbdcc3c2cc14ea8e35146636c4ecd58">UsbHsInterfaceFilterFlags</a> { <br />
&#160;&#160;<a class="el" href="usbhs_8h.html#a0dbdcc3c2cc14ea8e35146636c4ecd58a5c7b4c5d1a9d1b8de8cd3118c8bc771e">UsbHsInterfaceFilterFlags_idVendor</a> = (1U&lt;&lt;( 0 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_idProduct</b> = (1U&lt;&lt;( 1 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bcdDevice_Min</b> = (1U&lt;&lt;( 2 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bcdDevice_Max</b> = (1U&lt;&lt;( 3 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bDeviceClass</b> = (1U&lt;&lt;( 4 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bDeviceSubClass</b> = (1U&lt;&lt;( 5 ))
, <br />
&#160;&#160;<a class="el" href="usbhs_8h.html#a0dbdcc3c2cc14ea8e35146636c4ecd58ad132a78a55f9c60a43717bb87482313b">UsbHsInterfaceFilterFlags_bDeviceProtocol</a> = (1U&lt;&lt;( 6 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bInterfaceClass</b> = (1U&lt;&lt;( 7 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bInterfaceSubClass</b> = (1U&lt;&lt;( 8 ))
, <br />
&#160;&#160;<b>UsbHsInterfaceFilterFlags_bInterfaceProtocol</b> = (1U&lt;&lt;( 9 ))
<br />
}</td></tr>
<tr class="separator:a0dbdcc3c2cc14ea8e35146636c4ecd58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a143d1f40c022f771d0bccf2203e77cae" id="r_a143d1f40c022f771d0bccf2203e77cae"><td class="memItemLeft" align="right" valign="top"><a id="a143d1f40c022f771d0bccf2203e77cae" name="a143d1f40c022f771d0bccf2203e77cae"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsInitialize</b> (void)</td></tr>
<tr class="memdesc:a143d1f40c022f771d0bccf2203e77cae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize usb:hs. <br /></td></tr>
<tr class="separator:a143d1f40c022f771d0bccf2203e77cae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cf521e76dcb3abcb049daa39dda93e6" id="r_a0cf521e76dcb3abcb049daa39dda93e6"><td class="memItemLeft" align="right" valign="top"><a id="a0cf521e76dcb3abcb049daa39dda93e6" name="a0cf521e76dcb3abcb049daa39dda93e6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsExit</b> (void)</td></tr>
<tr class="memdesc:a0cf521e76dcb3abcb049daa39dda93e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit usb:hs. <br /></td></tr>
<tr class="separator:a0cf521e76dcb3abcb049daa39dda93e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49abd5bfc8ce983dd2e640a2ccc44ba3" id="r_a49abd5bfc8ce983dd2e640a2ccc44ba3"><td class="memItemLeft" align="right" valign="top"><a id="a49abd5bfc8ce983dd2e640a2ccc44ba3" name="a49abd5bfc8ce983dd2e640a2ccc44ba3"></a>
<a class="el" href="structService.html">Service</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsGetServiceSession</b> (void)</td></tr>
<tr class="memdesc:a49abd5bfc8ce983dd2e640a2ccc44ba3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the <a class="el" href="structService.html" title="Service object structure.">Service</a> object for the actual usb:hs service session. <br /></td></tr>
<tr class="separator:a49abd5bfc8ce983dd2e640a2ccc44ba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ea256940ca296804fc3f8b66d379cee" id="r_a3ea256940ca296804fc3f8b66d379cee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEvent.html">Event</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a3ea256940ca296804fc3f8b66d379cee">usbHsGetInterfaceStateChangeEvent</a> (void)</td></tr>
<tr class="memdesc:a3ea256940ca296804fc3f8b66d379cee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> loaded during init with autoclear=false. <br /></td></tr>
<tr class="separator:a3ea256940ca296804fc3f8b66d379cee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6837a22e5321182b8aad554f2955203" id="r_ad6837a22e5321182b8aad554f2955203"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#ad6837a22e5321182b8aad554f2955203">usbHsQueryAllInterfaces</a> (const <a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a> *filter, <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *interfaces, size_t interfaces_maxsize, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *total_entries)</td></tr>
<tr class="memdesc:ad6837a22e5321182b8aad554f2955203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of all <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a>. <br /></td></tr>
<tr class="separator:ad6837a22e5321182b8aad554f2955203"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9968d4a9732ce4aa8cfa9d725862c2f8" id="r_a9968d4a9732ce4aa8cfa9d725862c2f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a9968d4a9732ce4aa8cfa9d725862c2f8">usbHsQueryAvailableInterfaces</a> (const <a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a> *filter, <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *interfaces, size_t interfaces_maxsize, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *total_entries)</td></tr>
<tr class="memdesc:a9968d4a9732ce4aa8cfa9d725862c2f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> which are available. <br /></td></tr>
<tr class="separator:a9968d4a9732ce4aa8cfa9d725862c2f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22bee23047fc588203a48d8cfc3c7a6f" id="r_a22bee23047fc588203a48d8cfc3c7a6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a22bee23047fc588203a48d8cfc3c7a6f">usbHsQueryAcquiredInterfaces</a> (<a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *interfaces, size_t interfaces_maxsize, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *total_entries)</td></tr>
<tr class="memdesc:a22bee23047fc588203a48d8cfc3c7a6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> which were previously acquired. <br /></td></tr>
<tr class="separator:a22bee23047fc588203a48d8cfc3c7a6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac6d7738e8969db4f10455565d237bae" id="r_aac6d7738e8969db4f10455565d237bae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#aac6d7738e8969db4f10455565d237bae">usbHsCreateInterfaceAvailableEvent</a> (<a class="el" href="structEvent.html">Event</a> *out_event, bool autoclear, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> index, const <a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a> *filter)</td></tr>
<tr class="memdesc:aac6d7738e8969db4f10455565d237bae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event which is signaled when an interface is available which passes the filtering checks. <br /></td></tr>
<tr class="separator:aac6d7738e8969db4f10455565d237bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a036f818a979079eb60eb3155144f0032" id="r_a036f818a979079eb60eb3155144f0032"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a036f818a979079eb60eb3155144f0032">usbHsDestroyInterfaceAvailableEvent</a> (<a class="el" href="structEvent.html">Event</a> *event, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> index)</td></tr>
<tr class="memdesc:a036f818a979079eb60eb3155144f0032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys an event setup by <a class="el" href="usbhs_8h.html#aac6d7738e8969db4f10455565d237bae">usbHsCreateInterfaceAvailableEvent</a>. <br /></td></tr>
<tr class="separator:a036f818a979079eb60eb3155144f0032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41a6008fbe404a31ba1ebcd1083a3001" id="r_a41a6008fbe404a31ba1ebcd1083a3001"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a41a6008fbe404a31ba1ebcd1083a3001">usbHsAcquireUsbIf</a> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *interface)</td></tr>
<tr class="memdesc:a41a6008fbe404a31ba1ebcd1083a3001"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquires/opens the specified interface. <br /></td></tr>
<tr class="separator:a41a6008fbe404a31ba1ebcd1083a3001"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67e85073d3a9fbb29cd42e3045f68dcf" id="r_a67e85073d3a9fbb29cd42e3045f68dcf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a67e85073d3a9fbb29cd42e3045f68dcf">usbHsIfClose</a> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s)</td></tr>
<tr class="memdesc:a67e85073d3a9fbb29cd42e3045f68dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structUsbHsClientIfSession.html" title="The interface service object. These Events have autoclear=false.">UsbHsClientIfSession</a>. <br /></td></tr>
<tr class="separator:a67e85073d3a9fbb29cd42e3045f68dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa79d15b8f928489a830605ac3251abde" id="r_aa79d15b8f928489a830605ac3251abde"><td class="memItemLeft" align="right" valign="top"><a id="aa79d15b8f928489a830605ac3251abde" name="aa79d15b8f928489a830605ac3251abde"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsIfIsActive</b> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s)</td></tr>
<tr class="memdesc:aa79d15b8f928489a830605ac3251abde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the specified interface session was initialized. <br /></td></tr>
<tr class="separator:aa79d15b8f928489a830605ac3251abde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4cc2335634047799398aba4230644fc" id="r_aa4cc2335634047799398aba4230644fc"><td class="memItemLeft" align="right" valign="top"><a id="aa4cc2335634047799398aba4230644fc" name="aa4cc2335634047799398aba4230644fc"></a>
static <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a>&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsIfGetID</b> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s)</td></tr>
<tr class="memdesc:aa4cc2335634047799398aba4230644fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the ID which can be used for comparing with the ID in the output interfaces from <a class="el" href="usbhs_8h.html#a22bee23047fc588203a48d8cfc3c7a6f">usbHsQueryAcquiredInterfaces</a>. <br /></td></tr>
<tr class="separator:aa4cc2335634047799398aba4230644fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c9023e5f33814095c12047e17527bcc" id="r_a2c9023e5f33814095c12047e17527bcc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a2c9023e5f33814095c12047e17527bcc">usbHsIfSetInterface</a> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a> *inf, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> id)</td></tr>
<tr class="memdesc:a2c9023e5f33814095c12047e17527bcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects an interface. <br /></td></tr>
<tr class="separator:a2c9023e5f33814095c12047e17527bcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5d34d2f1601d378280309332fb78b11" id="r_ae5d34d2f1601d378280309332fb78b11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#ae5d34d2f1601d378280309332fb78b11">usbHsIfGetInterface</a> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a> *inf)</td></tr>
<tr class="memdesc:ae5d34d2f1601d378280309332fb78b11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an interface. <br /></td></tr>
<tr class="separator:ae5d34d2f1601d378280309332fb78b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27cc63999adde972ca2e0ea8035c21a2" id="r_a27cc63999adde972ca2e0ea8035c21a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a27cc63999adde972ca2e0ea8035c21a2">usbHsIfGetAlternateInterface</a> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a> *inf, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> id)</td></tr>
<tr class="memdesc:a27cc63999adde972ca2e0ea8035c21a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an alternate interface. <br /></td></tr>
<tr class="separator:a27cc63999adde972ca2e0ea8035c21a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58d6fdcb838c2069b9cb0c3be9449254" id="r_a58d6fdcb838c2069b9cb0c3be9449254"><td class="memItemLeft" align="right" valign="top"><a id="a58d6fdcb838c2069b9cb0c3be9449254" name="a58d6fdcb838c2069b9cb0c3be9449254"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsIfGetCurrentFrame</b> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out)</td></tr>
<tr class="memdesc:a58d6fdcb838c2069b9cb0c3be9449254"><td class="mdescLeft">&#160;</td><td class="mdescRight">On [1.0.0] this is stubbed, just returns 0 with out=0. <br /></td></tr>
<tr class="separator:a58d6fdcb838c2069b9cb0c3be9449254"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf5d082945fb0d6ec54af30f35abd102" id="r_adf5d082945fb0d6ec54af30f35abd102"><td class="memItemLeft" align="right" valign="top"><a id="adf5d082945fb0d6ec54af30f35abd102" name="adf5d082945fb0d6ec54af30f35abd102"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsIfCtrlXfer</b> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> bmRequestType, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> bRequest, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> wValue, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> wIndex, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> wLength, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *transferredSize)</td></tr>
<tr class="memdesc:adf5d082945fb0d6ec54af30f35abd102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses a control transfer, this will block until the transfer finishes. The buffer address and size should be aligned to 0x1000-bytes, where wLength is the original size. <br /></td></tr>
<tr class="separator:adf5d082945fb0d6ec54af30f35abd102"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c55fec0d4198b6a895a68e038b60c8e" id="r_a9c55fec0d4198b6a895a68e038b60c8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a9c55fec0d4198b6a895a68e038b60c8e">usbHsIfOpenUsbEp</a> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s, <a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *ep, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> maxUrbCount, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> maxXferSize, struct <a class="el" href="structusb__endpoint__descriptor.html">usb_endpoint_descriptor</a> *desc)</td></tr>
<tr class="memdesc:a9c55fec0d4198b6a895a68e038b60c8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens an endpoint. <br /></td></tr>
<tr class="separator:a9c55fec0d4198b6a895a68e038b60c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ed03258b51e4cc56d7b880d867cfb89" id="r_a1ed03258b51e4cc56d7b880d867cfb89"><td class="memItemLeft" align="right" valign="top"><a id="a1ed03258b51e4cc56d7b880d867cfb89" name="a1ed03258b51e4cc56d7b880d867cfb89"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsIfResetDevice</b> (<a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *s)</td></tr>
<tr class="memdesc:a1ed03258b51e4cc56d7b880d867cfb89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the device: has the same affect as unplugging the device and plugging it back in. <br /></td></tr>
<tr class="separator:a1ed03258b51e4cc56d7b880d867cfb89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa937552b4b573b9acd3c95dfb42e2dfa" id="r_aa937552b4b573b9acd3c95dfb42e2dfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#aa937552b4b573b9acd3c95dfb42e2dfa">usbHsEpClose</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s)</td></tr>
<tr class="memdesc:aa937552b4b573b9acd3c95dfb42e2dfa"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a>. <br /></td></tr>
<tr class="separator:aa937552b4b573b9acd3c95dfb42e2dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383d8255da2192f1a6c2cbd1e1e5d7db" id="r_a383d8255da2192f1a6c2cbd1e1e5d7db"><td class="memItemLeft" align="right" valign="top"><a id="a383d8255da2192f1a6c2cbd1e1e5d7db" name="a383d8255da2192f1a6c2cbd1e1e5d7db"></a>
static <a class="el" href="structEvent.html">Event</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsEpGetXferEvent</b> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s)</td></tr>
<tr class="memdesc:a383d8255da2192f1a6c2cbd1e1e5d7db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the Xfer <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> which is signaled when PostBufferAsync finishes. This is only valid for [2.0.0+]. If using <a class="el" href="event_8h.html#a9ef7b7f64d12b85096b5220f20e2d947">eventWait</a> with this, then <a class="el" href="event_8h.html#a689fb17af2e4e91251c93623cba04a66">eventClear</a> should be used if the event was signaled (since the autoclear is false). <br /></td></tr>
<tr class="separator:a383d8255da2192f1a6c2cbd1e1e5d7db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fa9fc5df5fe4b7781818ea0261d4d32" id="r_a3fa9fc5df5fe4b7781818ea0261d4d32"><td class="memItemLeft" align="right" valign="top"><a id="a3fa9fc5df5fe4b7781818ea0261d4d32" name="a3fa9fc5df5fe4b7781818ea0261d4d32"></a>
static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><b>usbHsEpGetReportRingSize</b> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s)</td></tr>
<tr class="memdesc:a3fa9fc5df5fe4b7781818ea0261d4d32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the buffer size to use with <a class="el" href="usbhs_8h.html#ab5eabb933b1a9fc329a5393f70982efc">usbHsEpShareReportRing</a>. <br /></td></tr>
<tr class="separator:a3fa9fc5df5fe4b7781818ea0261d4d32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a100292537479a0fb72a84660eca4a706" id="r_a100292537479a0fb72a84660eca4a706"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> id, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *xferId)</td></tr>
<tr class="memdesc:a100292537479a0fb72a84660eca4a706"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts an async data transfer with the specified endpoint. <br /></td></tr>
<tr class="separator:a100292537479a0fb72a84660eca4a706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab28f45274f05e186c34fca737cb6580e" id="r_ab28f45274f05e186c34fca737cb6580e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#ab28f45274f05e186c34fca737cb6580e">usbHsEpGetXferReport</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s, <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a> *reports, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> max_reports, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *count)</td></tr>
<tr class="memdesc:ab28f45274f05e186c34fca737cb6580e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an array of <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a> for the specified endpoint. <br /></td></tr>
<tr class="separator:ab28f45274f05e186c34fca737cb6580e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65b9b46e1169c4d83dd8d575a85f557e" id="r_a65b9b46e1169c4d83dd8d575a85f557e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a65b9b46e1169c4d83dd8d575a85f557e">usbHsEpPostBuffer</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *transferredSize)</td></tr>
<tr class="memdesc:a65b9b46e1169c4d83dd8d575a85f557e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses a data transfer with the specified endpoint, this will block until the transfer finishes. <br /></td></tr>
<tr class="separator:a65b9b46e1169c4d83dd8d575a85f557e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac9656beb528e6a6ff7176e1d94e1024" id="r_aac9656beb528e6a6ff7176e1d94e1024"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#aac9656beb528e6a6ff7176e1d94e1024">usbHsEpBatchBufferAsync</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *urbs, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> urbCount, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> id, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk1, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk2, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *xferId)</td></tr>
<tr class="memdesc:aac9656beb528e6a6ff7176e1d94e1024"><td class="mdescLeft">&#160;</td><td class="mdescRight">This uses the same functionality internally as <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> except the urbs array and unk1/unk2 are specified by the user instead. <br /></td></tr>
<tr class="separator:aac9656beb528e6a6ff7176e1d94e1024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f5366d85394212e3b983f4a9ced47c9" id="r_a3f5366d85394212e3b983f4a9ced47c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#a3f5366d85394212e3b983f4a9ced47c9">usbHsEpCreateSmmuSpace</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size)</td></tr>
<tr class="memdesc:a3f5366d85394212e3b983f4a9ced47c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This can be used to map the specified buffer as devicemem, which can then be used with <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> / <a class="el" href="usbhs_8h.html#a65b9b46e1169c4d83dd8d575a85f557e">usbHsEpPostBuffer</a> / <a class="el" href="usbhs_8h.html#aac9656beb528e6a6ff7176e1d94e1024">usbHsEpBatchBufferAsync</a>. <br /></td></tr>
<tr class="separator:a3f5366d85394212e3b983f4a9ced47c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5eabb933b1a9fc329a5393f70982efc" id="r_ab5eabb933b1a9fc329a5393f70982efc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="usbhs_8h.html#ab5eabb933b1a9fc329a5393f70982efc">usbHsEpShareReportRing</a> (<a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *s, void *buffer, size_t size)</td></tr>
<tr class="memdesc:ab5eabb933b1a9fc329a5393f70982efc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This creates <a class="el" href="structTransferMemory.html" title="Transfer memory information structure.">TransferMemory</a> which is used to read <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a> when <a class="el" href="usbhs_8h.html#ab28f45274f05e186c34fca737cb6580e">usbHsEpGetXferReport</a> is used, instead of using the service cmd. <br /></td></tr>
<tr class="separator:ab5eabb933b1a9fc329a5393f70982efc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>USB (usb:hs) devices service IPC wrapper. </p>
<dl class="section author"><dt>Author</dt><dd>yellows8 </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a0dbdcc3c2cc14ea8e35146636c4ecd58" name="a0dbdcc3c2cc14ea8e35146636c4ecd58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dbdcc3c2cc14ea8e35146636c4ecd58">&#9670;&#160;</a></span>UsbHsInterfaceFilterFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="usbhs_8h.html#a0dbdcc3c2cc14ea8e35146636c4ecd58">UsbHsInterfaceFilterFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0dbdcc3c2cc14ea8e35146636c4ecd58a5c7b4c5d1a9d1b8de8cd3118c8bc771e" name="a0dbdcc3c2cc14ea8e35146636c4ecd58a5c7b4c5d1a9d1b8de8cd3118c8bc771e"></a>UsbHsInterfaceFilterFlags_idVendor&#160;</td><td class="fielddoc"><p>These use <a class="el" href="structusb__device__descriptor.html">usb_device_descriptor</a>. Bit2..6 require [6.0.0+], these are ignored on eariler versions. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0dbdcc3c2cc14ea8e35146636c4ecd58ad132a78a55f9c60a43717bb87482313b" name="a0dbdcc3c2cc14ea8e35146636c4ecd58ad132a78a55f9c60a43717bb87482313b"></a>UsbHsInterfaceFilterFlags_bDeviceProtocol&#160;</td><td class="fielddoc"><p>These use <a class="el" href="structusb__interface__descriptor.html">usb_interface_descriptor</a>. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a41a6008fbe404a31ba1ebcd1083a3001" name="a41a6008fbe404a31ba1ebcd1083a3001"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41a6008fbe404a31ba1ebcd1083a3001">&#9670;&#160;</a></span>usbHsAcquireUsbIf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsAcquireUsbIf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *&#160;</td>
<td class="paramname"><em>interface</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquires/opens the specified interface. </p>
<p>This returns an error if the interface was already acquired by another process. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The service object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>Interface to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aac6d7738e8969db4f10455565d237bae" name="aac6d7738e8969db4f10455565d237bae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac6d7738e8969db4f10455565d237bae">&#9670;&#160;</a></span>usbHsCreateInterfaceAvailableEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsCreateInterfaceAvailableEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEvent.html">Event</a> *&#160;</td>
<td class="paramname"><em>out_event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>autoclear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a> *&#160;</td>
<td class="paramname"><em>filter</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an event which is signaled when an interface is available which passes the filtering checks. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">out_event</td><td><a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoclear</td><td><a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> autoclear. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td><a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> index, must be 0..2. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td><a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a036f818a979079eb60eb3155144f0032" name="a036f818a979079eb60eb3155144f0032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a036f818a979079eb60eb3155144f0032">&#9670;&#160;</a></span>usbHsDestroyInterfaceAvailableEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsDestroyInterfaceAvailableEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEvent.html">Event</a> *&#160;</td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys an event setup by <a class="el" href="usbhs_8h.html#aac6d7738e8969db4f10455565d237bae">usbHsCreateInterfaceAvailableEvent</a>. </p>
<p>This <em>must</em> be used at some point during cleanup. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> object to close. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td><a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> index, must be 0..2. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aac9656beb528e6a6ff7176e1d94e1024" name="aac9656beb528e6a6ff7176e1d94e1024"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac9656beb528e6a6ff7176e1d94e1024">&#9670;&#160;</a></span>usbHsEpBatchBufferAsync()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsEpBatchBufferAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>urbs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>urbCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>unk1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>unk2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>xferId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This uses the same functionality internally as <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> except the urbs array and unk1/unk2 are specified by the user instead. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [2.0.0+]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The endpoint object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">buffer</td><td>Data buffer. The buffer address and size should be aligned to 0x1000-bytes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">urbs</td><td>Input array of u32s for the size of each urb. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">urbCount</td><td>Total entries in the urbs array. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Same as <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">unk1</td><td><a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> would internally pass value 0 here. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">unk2</td><td><a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> would internally pass value 0 here. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">xferId</td><td>Output xferId. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa937552b4b573b9acd3c95dfb42e2dfa" name="aa937552b4b573b9acd3c95dfb42e2dfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa937552b4b573b9acd3c95dfb42e2dfa">&#9670;&#160;</a></span>usbHsEpClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usbHsEpClose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a>. </p>
<p>Closes the specified endpoint session. </p>
</div>
</div>
<a id="a3f5366d85394212e3b983f4a9ced47c9" name="a3f5366d85394212e3b983f4a9ced47c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f5366d85394212e3b983f4a9ced47c9">&#9670;&#160;</a></span>usbHsEpCreateSmmuSpace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsEpCreateSmmuSpace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This can be used to map the specified buffer as devicemem, which can then be used with <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> / <a class="el" href="usbhs_8h.html#a65b9b46e1169c4d83dd8d575a85f557e">usbHsEpPostBuffer</a> / <a class="el" href="usbhs_8h.html#aac9656beb528e6a6ff7176e1d94e1024">usbHsEpBatchBufferAsync</a>. </p>
<p>If the buffer address passed to those funcs is within this SmmuSpace, the specified buffer must be within the bounds of the SmmuSpace buffer. </p><dl class="section note"><dt>Note</dt><dd>Only available on [4.0.0+]. </dd>
<dd>
A buffer from usbHsEpCreateSmmuSpace can't be reused by another endpoint with the aforementioned funcs. </dd>
<dd>
This can only be used once per <a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> object. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The endpoint object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">buffer</td><td>Buffer address, this must be aligned to 0x1000-bytes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Buffer size, this must be aligned to 0x1000-bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab28f45274f05e186c34fca737cb6580e" name="ab28f45274f05e186c34fca737cb6580e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab28f45274f05e186c34fca737cb6580e">&#9670;&#160;</a></span>usbHsEpGetXferReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsEpGetXferReport </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a> *&#160;</td>
<td class="paramname"><em>reports</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>max_reports</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an array of <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a> for the specified endpoint. </p>
<p>This should be used after waiting on the <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> from <a class="el" href="usbhs_8h.html#a383d8255da2192f1a6c2cbd1e1e5d7db">usbHsEpGetXferEvent</a>. </p><dl class="section note"><dt>Note</dt><dd>Only available on [2.0.0+]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The endpoint object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">reports</td><td>Output array of <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_reports</td><td>Size of the reports array in entries. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>Number of entries written to the array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a65b9b46e1169c4d83dd8d575a85f557e" name="a65b9b46e1169c4d83dd8d575a85f557e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65b9b46e1169c4d83dd8d575a85f557e">&#9670;&#160;</a></span>usbHsEpPostBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsEpPostBuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>transferredSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses a data transfer with the specified endpoint, this will block until the transfer finishes. </p>
<p>This wraps <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> and <a class="el" href="usbhs_8h.html#ab28f45274f05e186c34fca737cb6580e">usbHsEpGetXferReport</a>, and also handles the <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> (on pre-2.0.0 this handles using the relevant cmds instead). If async is needed, use <a class="el" href="usbhs_8h.html#a100292537479a0fb72a84660eca4a706">usbHsEpPostBufferAsync</a> instead. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The endpoint object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">buffer</td><td>Data buffer. The buffer address and size should be aligned to 0x1000-bytes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The actual data size. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">transferredSize</td><td>Output transferred size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a100292537479a0fb72a84660eca4a706" name="a100292537479a0fb72a84660eca4a706"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a100292537479a0fb72a84660eca4a706">&#9670;&#160;</a></span>usbHsEpPostBufferAsync()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsEpPostBufferAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>xferId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an async data transfer with the specified endpoint. </p>
<p>The <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> from <a class="el" href="usbhs_8h.html#a383d8255da2192f1a6c2cbd1e1e5d7db">usbHsEpGetXferEvent</a> can be used to determine when the transfer finished. If you don't need async, <a class="el" href="usbhs_8h.html#a65b9b46e1169c4d83dd8d575a85f557e">usbHsEpPostBuffer</a> can be used instead. </p><dl class="section note"><dt>Note</dt><dd>Only available on [2.0.0+]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The endpoint object. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">buffer</td><td>Data buffer. The buffer address and size should be aligned to 0x1000-bytes. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The actual data size. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>This is an arbitrary value which will be later returned in <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a>. For example a value starting at 0 can be used, then if sending multiple requests at once this value can be incremented each time (with 0 for the first request in this set of requests). </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">xferId</td><td>Output xferId. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab5eabb933b1a9fc329a5393f70982efc" name="ab5eabb933b1a9fc329a5393f70982efc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5eabb933b1a9fc329a5393f70982efc">&#9670;&#160;</a></span>usbHsEpShareReportRing()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsEpShareReportRing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This creates <a class="el" href="structTransferMemory.html" title="Transfer memory information structure.">TransferMemory</a> which is used to read <a class="el" href="structUsbHsXferReport.html">UsbHsXferReport</a> when <a class="el" href="usbhs_8h.html#ab28f45274f05e186c34fca737cb6580e">usbHsEpGetXferReport</a> is used, instead of using the service cmd. </p>
<dl class="section note"><dt>Note</dt><dd>Only available on [4.0.0+]. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">buffer</td><td>Buffer, must be 0x1000-byte aligned. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Buffer size, <a class="el" href="usbhs_8h.html#a3fa9fc5df5fe4b7781818ea0261d4d32">usbHsEpGetReportRingSize</a> can be used to calculate this. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3ea256940ca296804fc3f8b66d379cee" name="a3ea256940ca296804fc3f8b66d379cee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ea256940ca296804fc3f8b66d379cee">&#9670;&#160;</a></span>usbHsGetInterfaceStateChangeEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEvent.html">Event</a> * usbHsGetInterfaceStateChangeEvent </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> loaded during init with autoclear=false. </p>
<p>Signaled when a device was removed. When signaled, the user should use <a class="el" href="usbhs_8h.html#a22bee23047fc588203a48d8cfc3c7a6f">usbHsQueryAcquiredInterfaces</a> and cleanup state for all interfaces which are not listed in the output interfaces (none of the IDs match <a class="el" href="usbhs_8h.html#aa4cc2335634047799398aba4230644fc">usbHsIfGetID</a> output). </p>
</div>
</div>
<a id="a67e85073d3a9fbb29cd42e3045f68dcf" name="a67e85073d3a9fbb29cd42e3045f68dcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67e85073d3a9fbb29cd42e3045f68dcf">&#9670;&#160;</a></span>usbHsIfClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usbHsIfClose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structUsbHsClientIfSession.html" title="The interface service object. These Events have autoclear=false.">UsbHsClientIfSession</a>. </p>
<p>Closes the specified interface session. </p>
</div>
</div>
<a id="a27cc63999adde972ca2e0ea8035c21a2" name="a27cc63999adde972ca2e0ea8035c21a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27cc63999adde972ca2e0ea8035c21a2">&#9670;&#160;</a></span>usbHsIfGetAlternateInterface()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsIfGetAlternateInterface </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a> *&#160;</td>
<td class="paramname"><em>inf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an alternate interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The service object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">inf</td><td>The output interface info. If NULL, the output is stored within s instead. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>ID </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5d34d2f1601d378280309332fb78b11" name="ae5d34d2f1601d378280309332fb78b11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5d34d2f1601d378280309332fb78b11">&#9670;&#160;</a></span>usbHsIfGetInterface()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsIfGetInterface </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a> *&#160;</td>
<td class="paramname"><em>inf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The service object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">inf</td><td>The output interface info. If NULL, the output is stored within s instead. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9c55fec0d4198b6a895a68e038b60c8e" name="a9c55fec0d4198b6a895a68e038b60c8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c55fec0d4198b6a895a68e038b60c8e">&#9670;&#160;</a></span>usbHsIfOpenUsbEp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsIfOpenUsbEp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsClientEpSession.html">UsbHsClientEpSession</a> *&#160;</td>
<td class="paramname"><em>ep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a>&#160;</td>
<td class="paramname"><em>maxUrbCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>maxXferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structusb__endpoint__descriptor.html">usb_endpoint_descriptor</a> *&#160;</td>
<td class="paramname"><em>desc</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an endpoint. </p>
<p>maxUrbCount*maxXferSize must be non-zero. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The interface object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ep</td><td>The endpoint object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maxUrbCount</td><td>maxUrbCount, must be &lt;0x11. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maxXferSize</td><td>Max transfer size for a packet. This can be desc-&gt;wMaxPacketSize. Must be &lt;=0xFF0000. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>Endpoint descriptor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2c9023e5f33814095c12047e17527bcc" name="a2c9023e5f33814095c12047e17527bcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c9023e5f33814095c12047e17527bcc">&#9670;&#160;</a></span>usbHsIfSetInterface()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsIfSetInterface </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsClientIfSession.html">UsbHsClientIfSession</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsInterfaceInfo.html">UsbHsInterfaceInfo</a> *&#160;</td>
<td class="paramname"><em>inf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selects an interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The service object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">inf</td><td>The output interface info. If NULL, the output is stored within s instead. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>ID </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a22bee23047fc588203a48d8cfc3c7a6f" name="a22bee23047fc588203a48d8cfc3c7a6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22bee23047fc588203a48d8cfc3c7a6f">&#9670;&#160;</a></span>usbHsQueryAcquiredInterfaces()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsQueryAcquiredInterfaces </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *&#160;</td>
<td class="paramname"><em>interfaces</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>interfaces_maxsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *&#160;</td>
<td class="paramname"><em>total_entries</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> which were previously acquired. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">interfaces</td><td>Array of output interfaces. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">interfaces_maxsize</td><td>Max byte-size of the interfaces buffer. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">total_entries</td><td>Total number of output interfaces. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad6837a22e5321182b8aad554f2955203" name="ad6837a22e5321182b8aad554f2955203"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6837a22e5321182b8aad554f2955203">&#9670;&#160;</a></span>usbHsQueryAllInterfaces()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsQueryAllInterfaces </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a> *&#160;</td>
<td class="paramname"><em>filter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *&#160;</td>
<td class="paramname"><em>interfaces</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>interfaces_maxsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *&#160;</td>
<td class="paramname"><em>total_entries</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of all <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a>. </p>
<p>Internally this loads the same interfaces as <a class="el" href="usbhs_8h.html#a9968d4a9732ce4aa8cfa9d725862c2f8">usbHsQueryAvailableInterfaces</a>, followed by <a class="el" href="usbhs_8h.html#a22bee23047fc588203a48d8cfc3c7a6f">usbHsQueryAcquiredInterfaces</a>. However, ID in <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> is set to -1, hence the output from this should not be used with <a class="el" href="usbhs_8h.html#a41a6008fbe404a31ba1ebcd1083a3001">usbHsAcquireUsbIf</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td><a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">interfaces</td><td>Array of output interfaces. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">interfaces_maxsize</td><td>Max byte-size of the interfaces buffer. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">total_entries</td><td>Total number of output interfaces. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9968d4a9732ce4aa8cfa9d725862c2f8" name="a9968d4a9732ce4aa8cfa9d725862c2f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9968d4a9732ce4aa8cfa9d725862c2f8">&#9670;&#160;</a></span>usbHsQueryAvailableInterfaces()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbHsQueryAvailableInterfaces </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a> *&#160;</td>
<td class="paramname"><em>filter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> *&#160;</td>
<td class="paramname"><em>interfaces</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>interfaces_maxsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *&#160;</td>
<td class="paramname"><em>total_entries</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of <a class="el" href="structUsbHsInterface.html">UsbHsInterface</a> which are available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td><a class="el" href="structUsbHsInterfaceFilter.html">UsbHsInterfaceFilter</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">interfaces</td><td>Array of output interfaces. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">interfaces_maxsize</td><td>Max byte-size of the interfaces buffer. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">total_entries</td><td>Total number of output interfaces. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink