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

183 lines
27 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/runtime/devices/usb_comms.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li><li class="navelem"><a class="el" href="dir_8e84a2b4adc47392539d92413dc3768e.html">devices</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">usb_comms.h</div></div>
</div><!--header-->
<div class="contents">
<a href="usb__comms_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file usb_comms.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief USB comms.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author yellows8</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @author plutoo</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../../types.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="structUsbCommsInterfaceInfo.html"> 11</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> bInterfaceClass;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> bInterfaceSubClass;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> bInterfaceProtocol;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>} <a class="code hl_struct" href="structUsbCommsInterfaceInfo.html">UsbCommsInterfaceInfo</a>;</div>
</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"></span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/// Initializes usbComms with the default number of interfaces (1)</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#aa8f2d4a9954d0892784109bb9389fb05"> 18</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usb__comms_8h.html#aa8f2d4a9954d0892784109bb9389fb05">usbCommsInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">/// Initializes usbComms with a specific number of interfaces.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a85e3ab1ff5f0c5614313a01158784213"> 21</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usb__comms_8h.html#a85e3ab1ff5f0c5614313a01158784213">usbCommsInitializeEx</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> num_interfaces, <span class="keyword">const</span> <a class="code hl_struct" href="structUsbCommsInterfaceInfo.html">UsbCommsInterfaceInfo</a> *infos, <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> idVendor, <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> idProduct);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"></span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">/// Exits usbComms.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a661732ff6cb51c41ffe8b190d34b591f"> 24</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="usb__comms_8h.html#a661732ff6cb51c41ffe8b190d34b591f">usbCommsExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"></span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">/// Sets whether to throw a fatal error in usbComms{Read/Write}* on failure, or just return the transferred size. By default (false) the latter is used.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#ac54b0218545914b00f7268621634a6b1"> 27</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="usb__comms_8h.html#ac54b0218545914b00f7268621634a6b1">usbCommsSetErrorHandling</a>(<span class="keywordtype">bool</span> flag);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"></span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">///@name Synchronous API</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">///@{</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"></span><span class="comment"></span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">/// Read data with the default interface.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#ad0afcef31f349b2af30394bb1046ea2f"> 33</a></span><span class="comment"></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="usb__comms_8h.html#ad0afcef31f349b2af30394bb1046ea2f">usbCommsRead</a>(<span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"></span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">/// Write data with the default interface.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a976679b6d30249eeb80aa5a705ba00d6"> 36</a></span><span class="comment"></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="usb__comms_8h.html#a976679b6d30249eeb80aa5a705ba00d6">usbCommsWrite</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"></span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">/// Same as usbCommsRead except with the specified interface.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a8eb178fca78435a609f43ec11cefc63f"> 39</a></span><span class="comment"></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="usb__comms_8h.html#a8eb178fca78435a609f43ec11cefc63f">usbCommsReadEx</a>(<span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"></span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">/// Same as usbCommsWrite except with the specified interface.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a49c58efba9d91f0e794faa361d18bd06"> 42</a></span><span class="comment"></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="usb__comms_8h.html#a49c58efba9d91f0e794faa361d18bd06">usbCommsWriteEx</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"></span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">///@}</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"></span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">///@name Asynchronous API</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">///@{</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"></span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">/// Retrieve event used for read completion with the given interface.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#aaeddd9f643a28712612aa68b26fe023d"> 50</a></span><span class="comment"></span><a class="code hl_struct" href="structEvent.html">Event</a> *<a class="code hl_function" href="usb__comms_8h.html#aaeddd9f643a28712612aa68b26fe023d">usbCommsGetReadCompletionEvent</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"></span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment">/// Start an asynchronous read. The completion event will be signaled when the read completes.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">/// The buffer must be page-aligned and no larger than one page.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#aeed1f572cf53ad084c109d5661e2df6f"> 54</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usb__comms_8h.html#aeed1f572cf53ad084c109d5661e2df6f">usbCommsReadAsync</a>(<span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *urbId, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"></span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">/// Complete an asynchronous read, clearing the completion event, and return the amount of data which was read.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a55a0822139e94df825c9af40b4260618"> 57</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usb__comms_8h.html#a55a0822139e94df825c9af40b4260618">usbCommsGetReadResult</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> urbId, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *transferredSize, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"></span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment">/// Retrieve event used for write completion with the given interface.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a6a5f58372d021d0ccfef134bc01cba65"> 61</a></span><span class="comment"></span><a class="code hl_struct" href="structEvent.html">Event</a> *<a class="code hl_function" href="usb__comms_8h.html#a6a5f58372d021d0ccfef134bc01cba65">usbCommsGetWriteCompletionEvent</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"></span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">/// Start an asynchronous write. The completion event will be signaled when the write completes.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">/// The buffer must be page-aligned and no larger than one page.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a1ba2b3c0ed228d07f9cca74e7570448b"> 65</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usb__comms_8h.html#a1ba2b3c0ed228d07f9cca74e7570448b">usbCommsWriteAsync</a>(<span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *urbId, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"></span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment">/// Complete an asynchronous write, clearing the completion event, and return the amount of data which was written.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="usb__comms_8h.html#a16082120803fd35313b3b30ececac6b2"> 68</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usb__comms_8h.html#a16082120803fd35313b3b30ececac6b2">usbCommsGetWriteResult</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> urbId, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *transferredSize, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> interface);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"></span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">///@}</span></div>
<div class="ttc" id="astructEvent_html"><div class="ttname"><a href="structEvent.html">Event</a></div><div class="ttdoc">Kernel-mode event structure.</div><div class="ttdef"><b>Definition</b> event.h:13</div></div>
<div class="ttc" id="astructUsbCommsInterfaceInfo_html"><div class="ttname"><a href="structUsbCommsInterfaceInfo.html">UsbCommsInterfaceInfo</a></div><div class="ttdef"><b>Definition</b> usb_comms.h:11</div></div>
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">8-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:19</div></div>
<div class="ttc" id="atypes_8h_html_ace9d960e74685e2cd84b36132dbbf8aa"><div class="ttname"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a></div><div class="ttdeci">uint16_t u16</div><div class="ttdoc">16-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:20</div></div>
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:21</div></div>
<div class="ttc" id="ausb__comms_8h_html_a16082120803fd35313b3b30ececac6b2"><div class="ttname"><a href="usb__comms_8h.html#a16082120803fd35313b3b30ececac6b2">usbCommsGetWriteResult</a></div><div class="ttdeci">Result usbCommsGetWriteResult(u32 urbId, u32 *transferredSize, u32 interface)</div><div class="ttdoc">Complete an asynchronous write, clearing the completion event, and return the amount of data which wa...</div></div>
<div class="ttc" id="ausb__comms_8h_html_a1ba2b3c0ed228d07f9cca74e7570448b"><div class="ttname"><a href="usb__comms_8h.html#a1ba2b3c0ed228d07f9cca74e7570448b">usbCommsWriteAsync</a></div><div class="ttdeci">Result usbCommsWriteAsync(void *buffer, size_t size, u32 *urbId, u32 interface)</div><div class="ttdoc">Start an asynchronous write.</div></div>
<div class="ttc" id="ausb__comms_8h_html_a49c58efba9d91f0e794faa361d18bd06"><div class="ttname"><a href="usb__comms_8h.html#a49c58efba9d91f0e794faa361d18bd06">usbCommsWriteEx</a></div><div class="ttdeci">size_t usbCommsWriteEx(const void *buffer, size_t size, u32 interface)</div><div class="ttdoc">Same as usbCommsWrite except with the specified interface.</div></div>
<div class="ttc" id="ausb__comms_8h_html_a55a0822139e94df825c9af40b4260618"><div class="ttname"><a href="usb__comms_8h.html#a55a0822139e94df825c9af40b4260618">usbCommsGetReadResult</a></div><div class="ttdeci">Result usbCommsGetReadResult(u32 urbId, u32 *transferredSize, u32 interface)</div><div class="ttdoc">Complete an asynchronous read, clearing the completion event, and return the amount of data which was...</div></div>
<div class="ttc" id="ausb__comms_8h_html_a661732ff6cb51c41ffe8b190d34b591f"><div class="ttname"><a href="usb__comms_8h.html#a661732ff6cb51c41ffe8b190d34b591f">usbCommsExit</a></div><div class="ttdeci">void usbCommsExit(void)</div><div class="ttdoc">Exits usbComms.</div></div>
<div class="ttc" id="ausb__comms_8h_html_a6a5f58372d021d0ccfef134bc01cba65"><div class="ttname"><a href="usb__comms_8h.html#a6a5f58372d021d0ccfef134bc01cba65">usbCommsGetWriteCompletionEvent</a></div><div class="ttdeci">Event * usbCommsGetWriteCompletionEvent(u32 interface)</div><div class="ttdoc">Retrieve event used for write completion with the given interface.</div></div>
<div class="ttc" id="ausb__comms_8h_html_a85e3ab1ff5f0c5614313a01158784213"><div class="ttname"><a href="usb__comms_8h.html#a85e3ab1ff5f0c5614313a01158784213">usbCommsInitializeEx</a></div><div class="ttdeci">Result usbCommsInitializeEx(u32 num_interfaces, const UsbCommsInterfaceInfo *infos, u16 idVendor, u16 idProduct)</div><div class="ttdoc">Initializes usbComms with a specific number of interfaces.</div></div>
<div class="ttc" id="ausb__comms_8h_html_a8eb178fca78435a609f43ec11cefc63f"><div class="ttname"><a href="usb__comms_8h.html#a8eb178fca78435a609f43ec11cefc63f">usbCommsReadEx</a></div><div class="ttdeci">size_t usbCommsReadEx(void *buffer, size_t size, u32 interface)</div><div class="ttdoc">Same as usbCommsRead except with the specified interface.</div></div>
<div class="ttc" id="ausb__comms_8h_html_a976679b6d30249eeb80aa5a705ba00d6"><div class="ttname"><a href="usb__comms_8h.html#a976679b6d30249eeb80aa5a705ba00d6">usbCommsWrite</a></div><div class="ttdeci">size_t usbCommsWrite(const void *buffer, size_t size)</div><div class="ttdoc">Write data with the default interface.</div></div>
<div class="ttc" id="ausb__comms_8h_html_aa8f2d4a9954d0892784109bb9389fb05"><div class="ttname"><a href="usb__comms_8h.html#aa8f2d4a9954d0892784109bb9389fb05">usbCommsInitialize</a></div><div class="ttdeci">Result usbCommsInitialize(void)</div><div class="ttdoc">Initializes usbComms with the default number of interfaces (1)</div></div>
<div class="ttc" id="ausb__comms_8h_html_aaeddd9f643a28712612aa68b26fe023d"><div class="ttname"><a href="usb__comms_8h.html#aaeddd9f643a28712612aa68b26fe023d">usbCommsGetReadCompletionEvent</a></div><div class="ttdeci">Event * usbCommsGetReadCompletionEvent(u32 interface)</div><div class="ttdoc">Retrieve event used for read completion with the given interface.</div></div>
<div class="ttc" id="ausb__comms_8h_html_ac54b0218545914b00f7268621634a6b1"><div class="ttname"><a href="usb__comms_8h.html#ac54b0218545914b00f7268621634a6b1">usbCommsSetErrorHandling</a></div><div class="ttdeci">void usbCommsSetErrorHandling(bool flag)</div><div class="ttdoc">Sets whether to throw a fatal error in usbComms{Read/Write}* on failure, or just return the transferr...</div></div>
<div class="ttc" id="ausb__comms_8h_html_ad0afcef31f349b2af30394bb1046ea2f"><div class="ttname"><a href="usb__comms_8h.html#ad0afcef31f349b2af30394bb1046ea2f">usbCommsRead</a></div><div class="ttdeci">size_t usbCommsRead(void *buffer, size_t size)</div><div class="ttdoc">Read data with the default interface.</div></div>
<div class="ttc" id="ausb__comms_8h_html_aeed1f572cf53ad084c109d5661e2df6f"><div class="ttname"><a href="usb__comms_8h.html#aeed1f572cf53ad084c109d5661e2df6f">usbCommsReadAsync</a></div><div class="ttdeci">Result usbCommsReadAsync(void *buffer, size_t size, u32 *urbId, u32 interface)</div><div class="ttdoc">Start an asynchronous read.</div></div>
</div><!-- fragment --></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