blob: f72fe3856b3e95ee30549730acab1ad173109b35 [file]
<!-- 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_device_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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;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__device__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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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_device_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 Device Descriptor (section 9.6.1, table 9-8)
<a href="structtusb__descriptor__device__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>&gt;</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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a1deca1f1d6e5815b290e6e1015bce5b8">bLength</a></td></tr>
<tr class="memdesc:a1deca1f1d6e5815b290e6e1015bce5b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of this descriptor in bytes. <br/></td></tr>
<tr class="separator:a1deca1f1d6e5815b290e6e1015bce5b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67d7027b9eb9ed268d28e84fbc675707"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d7027b9eb9ed268d28e84fbc675707"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a67d7027b9eb9ed268d28e84fbc675707">bDescriptorType</a></td></tr>
<tr class="memdesc:a67d7027b9eb9ed268d28e84fbc675707"><td class="mdescLeft">&#160;</td><td class="mdescRight">DEVICE Descriptor Type. <br/></td></tr>
<tr class="separator:a67d7027b9eb9ed268d28e84fbc675707"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f2450b83d08617906b5b63640f559af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f2450b83d08617906b5b63640f559af"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a8f2450b83d08617906b5b63640f559af">bcdUSB</a></td></tr>
<tr class="memdesc:a8f2450b83d08617906b5b63640f559af"><td class="mdescLeft">&#160;</td><td class="mdescRight">BUSB Specification Release Number in Binary-Coded Decimal (i.e., 2.10 is 210H). This field identifies the release of the USB Specification with which the device and its descriptors are compliant. <br/></td></tr>
<tr class="separator:a8f2450b83d08617906b5b63640f559af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8e1b1fca77a607c39bba2278623d4f4"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#ab8e1b1fca77a607c39bba2278623d4f4">bDeviceClass</a></td></tr>
<tr class="memdesc:ab8e1b1fca77a607c39bba2278623d4f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class code (assigned by the USB-IF). <a href="#ab8e1b1fca77a607c39bba2278623d4f4">More...</a><br/></td></tr>
<tr class="separator:ab8e1b1fca77a607c39bba2278623d4f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a260eec0b4e7279e6ecae808ca34c2604"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a260eec0b4e7279e6ecae808ca34c2604">bDeviceSubClass</a></td></tr>
<tr class="memdesc:a260eec0b4e7279e6ecae808ca34c2604"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subclass code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass field. <a href="#a260eec0b4e7279e6ecae808ca34c2604">More...</a><br/></td></tr>
<tr class="separator:a260eec0b4e7279e6ecae808ca34c2604"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44e204b5f7158f4048edcb944351ce27"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a44e204b5f7158f4048edcb944351ce27">bDeviceProtocol</a></td></tr>
<tr class="memdesc:a44e204b5f7158f4048edcb944351ce27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protocol code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass and the bDeviceSubClass fields. If a device supports class-specific protocols on a device basis as opposed to an interface basis, this code identifies the protocols that the device uses as defined by the specification of the device class. <a href="#a44e204b5f7158f4048edcb944351ce27">More...</a><br/></td></tr>
<tr class="separator:a44e204b5f7158f4048edcb944351ce27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93b2c926b005917cdf2b5e7e4b3f80a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93b2c926b005917cdf2b5e7e4b3f80a2"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a93b2c926b005917cdf2b5e7e4b3f80a2">bMaxPacketSize0</a></td></tr>
<tr class="memdesc:a93b2c926b005917cdf2b5e7e4b3f80a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum packet size for endpoint zero (only 8, 16, 32, or 64 are valid). For HS devices is fixed to 64. <br/></td></tr>
<tr class="separator:a93b2c926b005917cdf2b5e7e4b3f80a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab393e07556e3858fed36ed2e260d4b4c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab393e07556e3858fed36ed2e260d4b4c"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#ab393e07556e3858fed36ed2e260d4b4c">idVendor</a></td></tr>
<tr class="memdesc:ab393e07556e3858fed36ed2e260d4b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vendor ID (assigned by the USB-IF). <br/></td></tr>
<tr class="separator:ab393e07556e3858fed36ed2e260d4b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cf29745398a958349d784b1911c6b2b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cf29745398a958349d784b1911c6b2b"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a2cf29745398a958349d784b1911c6b2b">idProduct</a></td></tr>
<tr class="memdesc:a2cf29745398a958349d784b1911c6b2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Product ID (assigned by the manufacturer). <br/></td></tr>
<tr class="separator:a2cf29745398a958349d784b1911c6b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ac87bf0a9ee1a9e0eec6d50a8b0e3f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ac87bf0a9ee1a9e0eec6d50a8b0e3f9"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a4ac87bf0a9ee1a9e0eec6d50a8b0e3f9">bcdDevice</a></td></tr>
<tr class="memdesc:a4ac87bf0a9ee1a9e0eec6d50a8b0e3f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device release number in binary-coded decimal. <br/></td></tr>
<tr class="separator:a4ac87bf0a9ee1a9e0eec6d50a8b0e3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ee6ae41b483f3c49d1ddb39a83a8a43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ee6ae41b483f3c49d1ddb39a83a8a43"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a7ee6ae41b483f3c49d1ddb39a83a8a43">iManufacturer</a></td></tr>
<tr class="memdesc:a7ee6ae41b483f3c49d1ddb39a83a8a43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of string descriptor describing manufacturer. <br/></td></tr>
<tr class="separator:a7ee6ae41b483f3c49d1ddb39a83a8a43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77c33850b90ff7617243c40ce61d9168"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77c33850b90ff7617243c40ce61d9168"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#a77c33850b90ff7617243c40ce61d9168">iProduct</a></td></tr>
<tr class="memdesc:a77c33850b90ff7617243c40ce61d9168"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of string descriptor describing product. <br/></td></tr>
<tr class="separator:a77c33850b90ff7617243c40ce61d9168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb129fc0d41494f69369da70d73eac11"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb129fc0d41494f69369da70d73eac11"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#aeb129fc0d41494f69369da70d73eac11">iSerialNumber</a></td></tr>
<tr class="memdesc:aeb129fc0d41494f69369da70d73eac11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of string descriptor describing the device's serial number. <br/></td></tr>
<tr class="separator:aeb129fc0d41494f69369da70d73eac11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abde4f60e84b2d9b10c27aa23bae62595"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abde4f60e84b2d9b10c27aa23bae62595"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtusb__descriptor__device__t.html#abde4f60e84b2d9b10c27aa23bae62595">bNumConfigurations</a></td></tr>
<tr class="memdesc:abde4f60e84b2d9b10c27aa23bae62595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of possible configurations. <br/></td></tr>
<tr class="separator:abde4f60e84b2d9b10c27aa23bae62595"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>USB Standard Device Descriptor (section 9.6.1, table 9-8) </p>
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00056">56</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="ab8e1b1fca77a607c39bba2278623d4f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bDeviceClass</td>
</tr>
</table>
</div><div class="memdoc">
<p>Class code (assigned by the USB-IF). </p>
<ul>
<li>If this field is reset to zero, each interface within a configuration specifies its own class information and the various interfaces operate independently. </li>
<li>If this field is set to a value between 1 and FEH, the device supports different class specifications on different interfaces and the interfaces may not operate independently. This value identifies the class definition used for the aggregate interfaces. </li>
<li>If this field is set to FFH, the device class is vendor-specific. </li>
</ul>
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00061">61</a> of file <a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>.</p>
</div>
</div>
<a class="anchor" id="a44e204b5f7158f4048edcb944351ce27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bDeviceProtocol</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass and the bDeviceSubClass fields. If a device supports class-specific protocols on a device basis as opposed to an interface basis, 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 class-specific protocols on a device basis. However, it may use classspecific protocols on an interface basis. </li>
<li>If this field is set to FFH, the device uses a vendor-specific protocol on a device basis. </li>
</ul>
<p>Definition at line <a class="el" href="std__descriptors_8h_source.html#l00063">63</a> of file <a class="el" href="std__descriptors_8h_source.html">std_descriptors.h</a>.</p>
</div>
</div>
<a class="anchor" id="a260eec0b4e7279e6ecae808ca34c2604"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bDeviceSubClass</td>
</tr>
</table>
</div><div class="memdoc">
<p>Subclass code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass field. </p>
<ul>
<li>If the bDeviceClass field is reset to zero, this field must also be reset to zero. </li>
<li>If the bDeviceClass 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#l00062">62</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__device__t.html">tusb_descriptor_device_t</a></li>
<li class="footer">Generated on Mon Mar 31 2014 15:49:07 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>