245 lines
16 KiB
HTML
245 lines
16 KiB
HTML
<!-- HTML header for doxygen 1.8.6-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>tinyusb: tusb_descriptor_interface_t Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 width="100%" cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">tinyusb
|
|
 <span id="projectnumber">0.4</span>
|
|
</div>
|
|
</td>
|
|
<td align="right">
|
|
<a href="https://pledgie.com/campaigns/24694"><img border="0" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com"></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
|
|
<li><a href="functions.html"><span>Data Fields</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('structtusb__descriptor__interface__t.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">tusb_descriptor_interface_t Struct Reference<div class="ingroups"><a class="el" href="group___group___std_descriptor.html">Standard Descriptors</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>USB Standard Interface Descriptor (section 9.6.1 table 9-12)
|
|
<a href="structtusb__descriptor__interface__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a1deca1f1d6e5815b290e6e1015bce5b8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1deca1f1d6e5815b290e6e1015bce5b8"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a1deca1f1d6e5815b290e6e1015bce5b8">bLength</a></td></tr>
|
|
<tr class="memdesc:a1deca1f1d6e5815b290e6e1015bce5b8"><td class="mdescLeft"> </td><td class="mdescRight">Size of this descriptor in bytes. <br/></td></tr>
|
|
<tr class="separator:a1deca1f1d6e5815b290e6e1015bce5b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67d7027b9eb9ed268d28e84fbc675707"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d7027b9eb9ed268d28e84fbc675707"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a67d7027b9eb9ed268d28e84fbc675707">bDescriptorType</a></td></tr>
|
|
<tr class="memdesc:a67d7027b9eb9ed268d28e84fbc675707"><td class="mdescLeft"> </td><td class="mdescRight">INTERFACE Descriptor Type. <br/></td></tr>
|
|
<tr class="separator:a67d7027b9eb9ed268d28e84fbc675707"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d66d88c5e928462aef62633449f1eb0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d66d88c5e928462aef62633449f1eb0"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a3d66d88c5e928462aef62633449f1eb0">bInterfaceNumber</a></td></tr>
|
|
<tr class="memdesc:a3d66d88c5e928462aef62633449f1eb0"><td class="mdescLeft"> </td><td class="mdescRight">Number of this interface. Zero-based value identifying the index in the array of concurrent interfaces supported by this configuration. <br/></td></tr>
|
|
<tr class="separator:a3d66d88c5e928462aef62633449f1eb0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cdd7aab185365e51a1e722f43073b8c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cdd7aab185365e51a1e722f43073b8c"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a4cdd7aab185365e51a1e722f43073b8c">bAlternateSetting</a></td></tr>
|
|
<tr class="memdesc:a4cdd7aab185365e51a1e722f43073b8c"><td class="mdescLeft"> </td><td class="mdescRight">Value used to select this alternate setting for the interface identified in the prior field. <br/></td></tr>
|
|
<tr class="separator:a4cdd7aab185365e51a1e722f43073b8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acec2e7d68271baace354a0539f3d7e3d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec2e7d68271baace354a0539f3d7e3d"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#acec2e7d68271baace354a0539f3d7e3d">bNumEndpoints</a></td></tr>
|
|
<tr class="memdesc:acec2e7d68271baace354a0539f3d7e3d"><td class="mdescLeft"> </td><td class="mdescRight">Number of endpoints used by this interface (excluding endpoint zero). If this value is zero, this interface only uses the Default Control Pipe. <br/></td></tr>
|
|
<tr class="separator:acec2e7d68271baace354a0539f3d7e3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae899427763e325f03241afc69a6e1ea0"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#ae899427763e325f03241afc69a6e1ea0">bInterfaceClass</a></td></tr>
|
|
<tr class="memdesc:ae899427763e325f03241afc69a6e1ea0"><td class="mdescLeft"> </td><td class="mdescRight">Class code (assigned by the USB-IF). <a href="#ae899427763e325f03241afc69a6e1ea0">More...</a><br/></td></tr>
|
|
<tr class="separator:ae899427763e325f03241afc69a6e1ea0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b3919d1203cd42550d77287f7585595"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a3b3919d1203cd42550d77287f7585595">bInterfaceSubClass</a></td></tr>
|
|
<tr class="memdesc:a3b3919d1203cd42550d77287f7585595"><td class="mdescLeft"> </td><td class="mdescRight">Subclass code (assigned by the USB-IF). <br/>
|
|
These codes are qualified by the value of the bInterfaceClass field. <a href="#a3b3919d1203cd42550d77287f7585595">More...</a><br/></td></tr>
|
|
<tr class="separator:a3b3919d1203cd42550d77287f7585595"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6872c4ec51fd061e2955f84d97bea2a7"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a6872c4ec51fd061e2955f84d97bea2a7">bInterfaceProtocol</a></td></tr>
|
|
<tr class="memdesc:a6872c4ec51fd061e2955f84d97bea2a7"><td class="mdescLeft"> </td><td class="mdescRight">Protocol code (assigned by the USB). <br/>
|
|
These codes are qualified by the value of the bInterfaceClass and the bInterfaceSubClass fields. If an interface supports class-specific requests, this code identifies the protocols that the device uses as defined by the specification of the device class. <a href="#a6872c4ec51fd061e2955f84d97bea2a7">More...</a><br/></td></tr>
|
|
<tr class="separator:a6872c4ec51fd061e2955f84d97bea2a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e4535908d90f195c6347a91e15b544d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e4535908d90f195c6347a91e15b544d"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__interface__t.html#a2e4535908d90f195c6347a91e15b544d">iInterface</a></td></tr>
|
|
<tr class="memdesc:a2e4535908d90f195c6347a91e15b544d"><td class="mdescLeft"> </td><td class="mdescRight">Index of string descriptor describing this interface. <br/></td></tr>
|
|
<tr class="separator:a2e4535908d90f195c6347a91e15b544d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>USB Standard Interface Descriptor (section 9.6.1 table 9-12) </p>
|
|
|
|
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00090">90</a> of file <a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>.</p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a class="anchor" id="ae899427763e325f03241afc69a6e1ea0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t bInterfaceClass</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Class code (assigned by the USB-IF). </p>
|
|
<ul>
|
|
<li>A value of zero is reserved for future standardization. </li>
|
|
<li>If this field is set to FFH, the interface class is vendor-specific. </li>
|
|
<li>All other values are reserved for assignment by the USB-IF. </li>
|
|
</ul>
|
|
|
|
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00097">97</a> of file <a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6872c4ec51fd061e2955f84d97bea2a7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t bInterfaceProtocol</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Protocol code (assigned by the USB). <br/>
|
|
These codes are qualified by the value of the bInterfaceClass and the bInterfaceSubClass fields. If an interface supports class-specific requests, this code identifies the protocols that the device uses as defined by the specification of the device class. </p>
|
|
<ul>
|
|
<li>If this field is reset to zero, the device does not use a class-specific protocol on this interface. </li>
|
|
<li>If this field is set to FFH, the device uses a vendor-specific protocol for this interface. </li>
|
|
</ul>
|
|
|
|
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00099">99</a> of file <a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3b3919d1203cd42550d77287f7585595"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t bInterfaceSubClass</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Subclass code (assigned by the USB-IF). <br/>
|
|
These codes are qualified by the value of the bInterfaceClass field. </p>
|
|
<ul>
|
|
<li>If the bInterfaceClass field is reset to zero, this field must also be reset to zero. </li>
|
|
<li>If the bInterfaceClass field is not set to FFH, all values are reserved for assignment by the USB-IF. </li>
|
|
</ul>
|
|
|
|
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00098">98</a> of file <a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>tinyusb/common/<a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structtusb__descriptor__interface__t.html">tusb_descriptor_interface_t</a></li>
|
|
<li class="footer">Generated on Thu Apr 17 2014 13:05:31 for tinyusb by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|