mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-23 21:32:39 +02:00
308 lines
54 KiB
HTML
308 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" 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/usbds.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"> 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&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&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&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_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">usbds.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="usbds_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 usbds.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief USB (usb:ds) service IPC wrapper.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @brief Switch-as-device<>host USB comms, see also here: https://switchbrew.org/wiki/USB_services</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @author SciresM, yellows8</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 "../types.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "../sf/service.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "../services/usb.h"</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "../kernel/event.h"</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#define USBDS_DEFAULT_InterfaceNumber 0x4 </span><span class="comment">///Value for usb_interface_descriptor bInterfaceNumber for automatically allocating the actual bInterfaceNumber.</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structUsbDsInterface.html"> 16</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordtype">bool</span> initialized;</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> interface_index;</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_struct" href="structService.html">Service</a> s;</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_struct" href="structEvent.html">Event</a> SetupEvent;</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_struct" href="structEvent.html">Event</a> CtrlInCompletionEvent;</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_struct" href="structEvent.html">Event</a> CtrlOutCompletionEvent;</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>} <a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="foldopen" id="foldopen00026" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structUsbDsEndpoint.html"> 26</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">bool</span> initialized;</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_struct" href="structService.html">Service</a> s;</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_struct" href="structEvent.html">Event</a> CompletionEvent;</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>} <a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structUsbDsDeviceInfo.html"> 32</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structUsbDsDeviceInfo.html#ae134a59615562781c8c1c32ff5a12739"> 33</a></span> <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> <a class="code hl_variable" href="structUsbDsDeviceInfo.html#ae134a59615562781c8c1c32ff5a12739">idVendor</a>; <span class="comment">///< VID</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structUsbDsDeviceInfo.html#a051c8df79a11e5913abb26712b7f8ece"> 34</a></span> <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> <a class="code hl_variable" href="structUsbDsDeviceInfo.html#a051c8df79a11e5913abb26712b7f8ece">idProduct</a>; <span class="comment">///< PID</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> bcdDevice;</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">char</span> Manufacturer[0x20];</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">char</span> Product[0x20];</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">char</span> SerialNumber[0x20];</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>} <a class="code hl_struct" href="structUsbDsDeviceInfo.html">UsbDsDeviceInfo</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="foldopen" id="foldopen00041" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structUsbDsReportEntry.html"> 41</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structUsbDsReportEntry.html#a584c0101d94179d4304c9aa362cc7c1a"> 42</a></span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_variable" href="structUsbDsReportEntry.html#a584c0101d94179d4304c9aa362cc7c1a">id</a>; <span class="comment">///< urbId from post-buffer cmds</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> requestedSize;</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> transferredSize;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> urb_status;</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>} <a class="code hl_struct" href="structUsbDsReportEntry.html">UsbDsReportEntry</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="foldopen" id="foldopen00048" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structUsbDsReportData.html"> 48</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_struct" href="structUsbDsReportEntry.html">UsbDsReportEntry</a> report[8];</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> report_count;</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>} <a class="code hl_struct" href="structUsbDsReportData.html">UsbDsReportData</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> UsbComplexId_Default = 0x2</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>} UsbComplexId;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="foldopen" id="foldopen00057" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595b"> 57</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba541e38dfe4bebcace36a5cf3f739b086"> 58</a></span> <a class="code hl_enumvalue" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba541e38dfe4bebcace36a5cf3f739b086">UsbDeviceSpeed_Full</a> = 0x2, <span class="comment">///< USB 1.1 Full Speed</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba6a94de503345d3bdb84a5190a998b0c4"> 59</a></span> <a class="code hl_enumvalue" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba6a94de503345d3bdb84a5190a998b0c4">UsbDeviceSpeed_High</a> = 0x3, <span class="comment">///< USB 2.0 High Speed</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba8b91d204dcdd4e58151bfd9829720989"> 60</a></span> <a class="code hl_enumvalue" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba8b91d204dcdd4e58151bfd9829720989">UsbDeviceSpeed_Super</a> = 0x4, <span class="comment">///< USB 3.0 Super Speed</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>} <a class="code hl_enumeration" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595b">UsbDeviceSpeed</a>;</div>
|
|
</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">/// Opens a session with usb:ds.</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="usbds_8h.html#a84052e12fa451ac1d14699b34c6d076a"> 64</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a84052e12fa451ac1d14699b34c6d076a">usbDsInitialize</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment">/// Closes the usb:ds session. Any interfaces/endpoints which are left open are automatically closed, since otherwise usb-sysmodule won't fully reset usb:ds to defaults.</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="usbds_8h.html#a942cc1498adbe4817bb273b9bf7a795d"> 67</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="usbds_8h.html#a942cc1498adbe4817bb273b9bf7a795d">usbDsExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">/// Gets the Service object for the actual usb:ds service session.</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="usbds_8h.html#a4d8a6fad7bfc837ca7de14317b70de78"> 70</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="usbds_8h.html#a4d8a6fad7bfc837ca7de14317b70de78">usbDsGetServiceSession</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">/// Helper func.</span></div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="usbds_8h.html#a151377df0ed949f4c1257acb76d63112"> 73</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a151377df0ed949f4c1257acb76d63112">usbDsWaitReady</a>(<a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout);</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">/// Helper func.</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="usbds_8h.html#a71fa248c0509cada33859a77de6d7991"> 76</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a71fa248c0509cada33859a77de6d7991">usbDsParseReportData</a>(<a class="code hl_struct" href="structUsbDsReportData.html">UsbDsReportData</a> *reportdata, <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> *requestedSize, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *transferredSize);</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">///@name IDsService</span></div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment">///@{</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><a class="code hl_struct" href="structEvent.html">Event</a>* usbDsGetStateChangeEvent(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">/// Gets the device state. See \ref UsbState.</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="usbds_8h.html#a73c3a53115d382eb34250fcedffd0bc8"> 84</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a73c3a53115d382eb34250fcedffd0bc8">usbDsGetState</a>(<a class="code hl_enumeration" href="usb_8h.html#a7b4994a3d515390e4db5392fdd7230e5">UsbState</a>* out);</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment">/// Removed in [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="usbds_8h.html#a14cf0f6b8529da73c4ad4c6ffbaccaa7"> 87</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a14cf0f6b8529da73c4ad4c6ffbaccaa7">usbDsGetDsInterface</a>(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>** out, <span class="keyword">struct</span> <a class="code hl_struct" href="structusb__interface__descriptor.html">usb_interface_descriptor</a>* descriptor, <span class="keyword">const</span> <span class="keywordtype">char</span>* interface_name);</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment">/// Removed in [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="usbds_8h.html#af0ecb09d794e91a585ca6f683a3d30bd"> 90</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#af0ecb09d794e91a585ca6f683a3d30bd">usbDsSetVidPidBcd</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structUsbDsDeviceInfo.html">UsbDsDeviceInfo</a>* deviceinfo);</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="usbds_8h.html#a007b08ce3dc7d1677396f76df272fcdf"> 93</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a007b08ce3dc7d1677396f76df272fcdf">usbDsRegisterInterface</a>(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>** out);</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="usbds_8h.html#ac8ee21d2bee8565313851c817272ad5a"> 96</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#ac8ee21d2bee8565313851c817272ad5a">usbDsRegisterInterfaceEx</a>(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>** out, <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> intf_num);</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="usbds_8h.html#a487528933d4ababeb76bc89a95c57e0b"> 99</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a487528933d4ababeb76bc89a95c57e0b">usbDsClearDeviceData</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="usbds_8h.html#a1f3902cadde680971b49aecfbaef3121"> 102</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a1f3902cadde680971b49aecfbaef3121">usbDsAddUsbStringDescriptor</a>(<a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* out_index, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>);</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="usbds_8h.html#aa30ae3ba55ead597cfe3645b15859fa6"> 105</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#aa30ae3ba55ead597cfe3645b15859fa6">usbDsAddUsbLanguageStringDescriptor</a>(<a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* out_index, <span class="keyword">const</span> <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a>* lang_ids, <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> num_langs);</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="usbds_8h.html#ae073e0fe07f2ca9537e5ad305a2240b3"> 108</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#ae073e0fe07f2ca9537e5ad305a2240b3">usbDsDeleteUsbStringDescriptor</a>(<a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> index);</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="usbds_8h.html#a4c1c7cc16230a9e854057883c3981c5f"> 111</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a4c1c7cc16230a9e854057883c3981c5f">usbDsSetUsbDeviceDescriptor</a>(<a class="code hl_enumeration" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595b">UsbDeviceSpeed</a> speed, <span class="keyword">struct</span> <a class="code hl_struct" href="structusb__device__descriptor.html">usb_device_descriptor</a>* descriptor);</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="usbds_8h.html#a2e65d948397d935f689523a127ccbaa4"> 114</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a2e65d948397d935f689523a127ccbaa4">usbDsSetBinaryObjectStore</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* bos, <span class="keywordtype">size_t</span> bos_size);</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="usbds_8h.html#a82251f1420a06d6498b13e301744b9ba"> 117</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a82251f1420a06d6498b13e301744b9ba">usbDsEnable</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="usbds_8h.html#a0b4081828194f1480dbe233f54d3d812"> 120</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a0b4081828194f1480dbe233f54d3d812">usbDsDisable</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment">///@}</span></div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment"></span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment">///@name IDsInterface</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="comment">///@{</span></div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="keywordtype">void</span> usbDsInterface_Close(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface);</div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_GetSetupPacket(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_EnableInterface(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface);</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_DisableInterface(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface);</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_CtrlInPostBufferAsync(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <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);</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_CtrlOutPostBufferAsync(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <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);</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_GetCtrlInReportData(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <a class="code hl_struct" href="structUsbDsReportData.html">UsbDsReportData</a>* out);</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_GetCtrlOutReportData(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <a class="code hl_struct" href="structUsbDsReportData.html">UsbDsReportData</a>* out);</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsInterface_StallCtrl(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface);</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment">/// Removed in [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="usbds_8h.html#afb1ee593fe8f0bfd7100894f7427f07e"> 139</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#afb1ee593fe8f0bfd7100894f7427f07e">usbDsInterface_GetDsEndpoint</a>(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>** endpoint, <span class="keyword">struct</span> <a class="code hl_struct" href="structusb__endpoint__descriptor.html">usb_endpoint_descriptor</a>* descriptor);</div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="usbds_8h.html#a19c3909d164fc9dabbf6f5e9f5e075a1"> 142</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#a19c3909d164fc9dabbf6f5e9f5e075a1">usbDsInterface_RegisterEndpoint</a>(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>** endpoint, <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> endpoint_address);</div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="comment">/// Only available on [5.0.0+].</span></div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="usbds_8h.html#ac73382bf7289088d73c19c33bc2a7215"> 145</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="usbds_8h.html#ac73382bf7289088d73c19c33bc2a7215">usbDsInterface_AppendConfigurationData</a>(<a class="code hl_struct" href="structUsbDsInterface.html">UsbDsInterface</a>* interface, <a class="code hl_enumeration" href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595b">UsbDeviceSpeed</a> speed, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="comment">///@}</span></div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="comment"></span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="comment">///@name IDsEndpoint</span></div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="comment">///@{</span></div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span><span class="keywordtype">void</span> usbDsEndpoint_Close(<a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>* endpoint);</div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsEndpoint_Cancel(<a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>* endpoint);</div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsEndpoint_PostBufferAsync(<a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>* endpoint, <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);</div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsEndpoint_GetReportData(<a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>* endpoint, <a class="code hl_struct" href="structUsbDsReportData.html">UsbDsReportData</a>* out);</div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsEndpoint_Stall(<a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>* endpoint);</div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> usbDsEndpoint_SetZlt(<a class="code hl_struct" href="structUsbDsEndpoint.html">UsbDsEndpoint</a>* endpoint, <span class="keywordtype">bool</span> zlt); <span class="comment">// Sets Zero Length Termination for endpoint</span></div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="comment">///@}</span></div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</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="astructService_html"><div class="ttname"><a href="structService.html">Service</a></div><div class="ttdoc">Service object structure.</div><div class="ttdef"><b>Definition</b> service.h:14</div></div>
|
|
<div class="ttc" id="astructUsbDsDeviceInfo_html"><div class="ttname"><a href="structUsbDsDeviceInfo.html">UsbDsDeviceInfo</a></div><div class="ttdef"><b>Definition</b> usbds.h:32</div></div>
|
|
<div class="ttc" id="astructUsbDsDeviceInfo_html_a051c8df79a11e5913abb26712b7f8ece"><div class="ttname"><a href="structUsbDsDeviceInfo.html#a051c8df79a11e5913abb26712b7f8ece">UsbDsDeviceInfo::idProduct</a></div><div class="ttdeci">u16 idProduct</div><div class="ttdoc">PID.</div><div class="ttdef"><b>Definition</b> usbds.h:34</div></div>
|
|
<div class="ttc" id="astructUsbDsDeviceInfo_html_ae134a59615562781c8c1c32ff5a12739"><div class="ttname"><a href="structUsbDsDeviceInfo.html#ae134a59615562781c8c1c32ff5a12739">UsbDsDeviceInfo::idVendor</a></div><div class="ttdeci">u16 idVendor</div><div class="ttdoc">VID.</div><div class="ttdef"><b>Definition</b> usbds.h:33</div></div>
|
|
<div class="ttc" id="astructUsbDsEndpoint_html"><div class="ttname"><a href="structUsbDsEndpoint.html">UsbDsEndpoint</a></div><div class="ttdef"><b>Definition</b> usbds.h:26</div></div>
|
|
<div class="ttc" id="astructUsbDsInterface_html"><div class="ttname"><a href="structUsbDsInterface.html">UsbDsInterface</a></div><div class="ttdef"><b>Definition</b> usbds.h:16</div></div>
|
|
<div class="ttc" id="astructUsbDsReportData_html"><div class="ttname"><a href="structUsbDsReportData.html">UsbDsReportData</a></div><div class="ttdef"><b>Definition</b> usbds.h:48</div></div>
|
|
<div class="ttc" id="astructUsbDsReportEntry_html"><div class="ttname"><a href="structUsbDsReportEntry.html">UsbDsReportEntry</a></div><div class="ttdef"><b>Definition</b> usbds.h:41</div></div>
|
|
<div class="ttc" id="astructUsbDsReportEntry_html_a584c0101d94179d4304c9aa362cc7c1a"><div class="ttname"><a href="structUsbDsReportEntry.html#a584c0101d94179d4304c9aa362cc7c1a">UsbDsReportEntry::id</a></div><div class="ttdeci">u32 id</div><div class="ttdoc">urbId from post-buffer cmds</div><div class="ttdef"><b>Definition</b> usbds.h:42</div></div>
|
|
<div class="ttc" id="astructusb__device__descriptor_html"><div class="ttname"><a href="structusb__device__descriptor.html">usb_device_descriptor</a></div><div class="ttdoc">Imported from libusb, with some adjustments.</div><div class="ttdef"><b>Definition</b> usb.h:48</div></div>
|
|
<div class="ttc" id="astructusb__endpoint__descriptor_html"><div class="ttname"><a href="structusb__endpoint__descriptor.html">usb_endpoint_descriptor</a></div><div class="ttdoc">Imported from libusb, with some adjustments.</div><div class="ttdef"><b>Definition</b> usb.h:25</div></div>
|
|
<div class="ttc" id="astructusb__interface__descriptor_html"><div class="ttname"><a href="structusb__interface__descriptor.html">usb_interface_descriptor</a></div><div class="ttdoc">Imported from libusb, with some adjustments.</div><div class="ttdef"><b>Definition</b> usb.h:35</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</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_8h_html_a7b4994a3d515390e4db5392fdd7230e5"><div class="ttname"><a href="usb_8h.html#a7b4994a3d515390e4db5392fdd7230e5">UsbState</a></div><div class="ttdeci">UsbState</div><div class="ttdoc">USB Device States, per USB 2.0 spec.</div><div class="ttdef"><b>Definition</b> usb.h:211</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a007b08ce3dc7d1677396f76df272fcdf"><div class="ttname"><a href="usbds_8h.html#a007b08ce3dc7d1677396f76df272fcdf">usbDsRegisterInterface</a></div><div class="ttdeci">Result usbDsRegisterInterface(UsbDsInterface **out)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a0b4081828194f1480dbe233f54d3d812"><div class="ttname"><a href="usbds_8h.html#a0b4081828194f1480dbe233f54d3d812">usbDsDisable</a></div><div class="ttdeci">Result usbDsDisable(void)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a14cf0f6b8529da73c4ad4c6ffbaccaa7"><div class="ttname"><a href="usbds_8h.html#a14cf0f6b8529da73c4ad4c6ffbaccaa7">usbDsGetDsInterface</a></div><div class="ttdeci">Result usbDsGetDsInterface(UsbDsInterface **out, struct usb_interface_descriptor *descriptor, const char *interface_name)</div><div class="ttdoc">Removed in [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a151377df0ed949f4c1257acb76d63112"><div class="ttname"><a href="usbds_8h.html#a151377df0ed949f4c1257acb76d63112">usbDsWaitReady</a></div><div class="ttdeci">Result usbDsWaitReady(u64 timeout)</div><div class="ttdoc">Helper func.</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a19c3909d164fc9dabbf6f5e9f5e075a1"><div class="ttname"><a href="usbds_8h.html#a19c3909d164fc9dabbf6f5e9f5e075a1">usbDsInterface_RegisterEndpoint</a></div><div class="ttdeci">Result usbDsInterface_RegisterEndpoint(UsbDsInterface *interface, UsbDsEndpoint **endpoint, u8 endpoint_address)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a1f3902cadde680971b49aecfbaef3121"><div class="ttname"><a href="usbds_8h.html#a1f3902cadde680971b49aecfbaef3121">usbDsAddUsbStringDescriptor</a></div><div class="ttdeci">Result usbDsAddUsbStringDescriptor(u8 *out_index, const char *string)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a2e65d948397d935f689523a127ccbaa4"><div class="ttname"><a href="usbds_8h.html#a2e65d948397d935f689523a127ccbaa4">usbDsSetBinaryObjectStore</a></div><div class="ttdeci">Result usbDsSetBinaryObjectStore(const void *bos, size_t bos_size)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a487528933d4ababeb76bc89a95c57e0b"><div class="ttname"><a href="usbds_8h.html#a487528933d4ababeb76bc89a95c57e0b">usbDsClearDeviceData</a></div><div class="ttdeci">Result usbDsClearDeviceData(void)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a4c1c7cc16230a9e854057883c3981c5f"><div class="ttname"><a href="usbds_8h.html#a4c1c7cc16230a9e854057883c3981c5f">usbDsSetUsbDeviceDescriptor</a></div><div class="ttdeci">Result usbDsSetUsbDeviceDescriptor(UsbDeviceSpeed speed, struct usb_device_descriptor *descriptor)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a4d8a6fad7bfc837ca7de14317b70de78"><div class="ttname"><a href="usbds_8h.html#a4d8a6fad7bfc837ca7de14317b70de78">usbDsGetServiceSession</a></div><div class="ttdeci">Service * usbDsGetServiceSession(void)</div><div class="ttdoc">Gets the Service object for the actual usb:ds service session.</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a71fa248c0509cada33859a77de6d7991"><div class="ttname"><a href="usbds_8h.html#a71fa248c0509cada33859a77de6d7991">usbDsParseReportData</a></div><div class="ttdeci">Result usbDsParseReportData(UsbDsReportData *reportdata, u32 urbId, u32 *requestedSize, u32 *transferredSize)</div><div class="ttdoc">Helper func.</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a73c3a53115d382eb34250fcedffd0bc8"><div class="ttname"><a href="usbds_8h.html#a73c3a53115d382eb34250fcedffd0bc8">usbDsGetState</a></div><div class="ttdeci">Result usbDsGetState(UsbState *out)</div><div class="ttdoc">Gets the device state. See UsbState.</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a82251f1420a06d6498b13e301744b9ba"><div class="ttname"><a href="usbds_8h.html#a82251f1420a06d6498b13e301744b9ba">usbDsEnable</a></div><div class="ttdeci">Result usbDsEnable(void)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a84052e12fa451ac1d14699b34c6d076a"><div class="ttname"><a href="usbds_8h.html#a84052e12fa451ac1d14699b34c6d076a">usbDsInitialize</a></div><div class="ttdeci">Result usbDsInitialize(void)</div><div class="ttdoc">Opens a session with usb:ds.</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_a942cc1498adbe4817bb273b9bf7a795d"><div class="ttname"><a href="usbds_8h.html#a942cc1498adbe4817bb273b9bf7a795d">usbDsExit</a></div><div class="ttdeci">void usbDsExit(void)</div><div class="ttdoc">Closes the usb:ds session. Any interfaces/endpoints which are left open are automatically closed,...</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_aa30ae3ba55ead597cfe3645b15859fa6"><div class="ttname"><a href="usbds_8h.html#aa30ae3ba55ead597cfe3645b15859fa6">usbDsAddUsbLanguageStringDescriptor</a></div><div class="ttdeci">Result usbDsAddUsbLanguageStringDescriptor(u8 *out_index, const u16 *lang_ids, u16 num_langs)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ac73382bf7289088d73c19c33bc2a7215"><div class="ttname"><a href="usbds_8h.html#ac73382bf7289088d73c19c33bc2a7215">usbDsInterface_AppendConfigurationData</a></div><div class="ttdeci">Result usbDsInterface_AppendConfigurationData(UsbDsInterface *interface, UsbDeviceSpeed speed, const void *buffer, size_t size)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ac8ee21d2bee8565313851c817272ad5a"><div class="ttname"><a href="usbds_8h.html#ac8ee21d2bee8565313851c817272ad5a">usbDsRegisterInterfaceEx</a></div><div class="ttdeci">Result usbDsRegisterInterfaceEx(UsbDsInterface **out, u8 intf_num)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ada9c240a24f496cd37eb744d4ece595b"><div class="ttname"><a href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595b">UsbDeviceSpeed</a></div><div class="ttdeci">UsbDeviceSpeed</div><div class="ttdef"><b>Definition</b> usbds.h:57</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ada9c240a24f496cd37eb744d4ece595ba541e38dfe4bebcace36a5cf3f739b086"><div class="ttname"><a href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba541e38dfe4bebcace36a5cf3f739b086">UsbDeviceSpeed_Full</a></div><div class="ttdeci">@ UsbDeviceSpeed_Full</div><div class="ttdoc">USB 1.1 Full Speed.</div><div class="ttdef"><b>Definition</b> usbds.h:58</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ada9c240a24f496cd37eb744d4ece595ba6a94de503345d3bdb84a5190a998b0c4"><div class="ttname"><a href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba6a94de503345d3bdb84a5190a998b0c4">UsbDeviceSpeed_High</a></div><div class="ttdeci">@ UsbDeviceSpeed_High</div><div class="ttdoc">USB 2.0 High Speed.</div><div class="ttdef"><b>Definition</b> usbds.h:59</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ada9c240a24f496cd37eb744d4ece595ba8b91d204dcdd4e58151bfd9829720989"><div class="ttname"><a href="usbds_8h.html#ada9c240a24f496cd37eb744d4ece595ba8b91d204dcdd4e58151bfd9829720989">UsbDeviceSpeed_Super</a></div><div class="ttdeci">@ UsbDeviceSpeed_Super</div><div class="ttdoc">USB 3.0 Super Speed.</div><div class="ttdef"><b>Definition</b> usbds.h:60</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_ae073e0fe07f2ca9537e5ad305a2240b3"><div class="ttname"><a href="usbds_8h.html#ae073e0fe07f2ca9537e5ad305a2240b3">usbDsDeleteUsbStringDescriptor</a></div><div class="ttdeci">Result usbDsDeleteUsbStringDescriptor(u8 index)</div><div class="ttdoc">Only available on [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_af0ecb09d794e91a585ca6f683a3d30bd"><div class="ttname"><a href="usbds_8h.html#af0ecb09d794e91a585ca6f683a3d30bd">usbDsSetVidPidBcd</a></div><div class="ttdeci">Result usbDsSetVidPidBcd(const UsbDsDeviceInfo *deviceinfo)</div><div class="ttdoc">Removed in [5.0.0+].</div></div>
|
|
<div class="ttc" id="ausbds_8h_html_afb1ee593fe8f0bfd7100894f7427f07e"><div class="ttname"><a href="usbds_8h.html#afb1ee593fe8f0bfd7100894f7427f07e">usbDsInterface_GetDsEndpoint</a></div><div class="ttdeci">Result usbDsInterface_GetDsEndpoint(UsbDsInterface *interface, UsbDsEndpoint **endpoint, struct usb_endpoint_descriptor *descriptor)</div><div class="ttdoc">Removed in [5.0.0+].</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|