dmitrystu
/
libusbdev
miroir de https://github.com/dmitrystu/libusb_stm32


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
							<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Lightweight USB stack: usb_tmc.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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Lightweight USB stack
   &#160;<span id="projectnumber">1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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('d0/d89/a00071_source.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)">
</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="headertitle">
<div class="title">usb_tmc.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* This file is the part of the Lightweight USB device Stack for STM32 microcontrollers</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright ©2020 Alexander Voronov &lt;avv.0@ya.ru&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *   http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef _USB_TMC_H_</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define _USB_TMC_H_</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#define USB_CLASS_TMC           0xFE</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#define USB_TMC_SUBCLASS_TMC    0x03</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="../../d4/d3a/a00101.html#gae736383637bbaf1da5232db98398740c">   36</a></span>&#160;<span class="preprocessor">#define USB_TMC_PROTO_NONE      0x00 </span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="../../d4/d3a/a00101.html#ga4cf0c8f575aad3a9a2799cff94c9f35a">   37</a></span>&#160;<span class="preprocessor">#define USB_TMC_PROTO_USB488    0x01 </span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_INITIATE_ABORT_BULK_OUT     1</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_CHECK_ABORT_BULK_OUT_STATUS 2</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_INITIATE_ABORT_BULK_IN      3</span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_CHECK_ABORT_BULK_IN_STATUS  4</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_INITIATE_CLEAR              5</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_CHECK_CLEAR_STATUS          6</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_GET_CAPABILITIES            7</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">#define USB_TMC_REQ_INDICATOR_PULSE             64</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#define USB_TMC_STATUS_SUCCESS                  0x01</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#define USB_TMC_STATUS_PENDING                  0x02</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">#define USB_TMC_STATUS_FAILED                   0x80</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#define USB_TMC_STATUS_TRANSFER_NOT_IN_PROGRESS 0x81</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#define USB_TMC_STATUS_SPLIT_NOT_IN_PROGRESS    0x82</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#define USB_TMC_STATUS_SPLIT_IN_PROGRESS        0x83</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="../../dd/dd7/a00260.html">   63</a></span>&#160;<span class="keyword">struct </span><a class="code" href="../../dd/dd7/a00260.html">usb_tmc_get_capabilities_response</a> {</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    uint8_t USBTMC_status;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    uint8_t Reserved0;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    uint16_t bcdUSBTMC;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    uint8_t InterfaceCapabilities;</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    uint8_t DeviceCapabilities;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    uint8_t Reserved1[18];</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;} __attribute__((packed));</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#define USB_TMC_DEV_DEP_MSG_OUT             1</span></div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor">#define USB_TMC_REQUEST_DEV_DEP_MSG_IN      2</span></div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="preprocessor">#define USB_TMC_DEV_DEP_MSG_IN              2</span></div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="preprocessor">#define USB_TMC_VENDOR_SPECIFIC_OUT         126</span></div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="preprocessor">#define USB_TMC_REQUEST_VENDOR_SPECIFIC_IN  127</span></div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#define USB_TMC_VENDOR_SPECIFIC_IN          127</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="../../d4/d3a/a00101.html#gadf387a39bd06cd31a35b1b6328998f20">   86</a></span>&#160;<span class="preprocessor">#define USB_TMC_TRANSFER_ATTR_EOM           0x01</span></div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="../../d4/d3a/a00101.html#ga0697841d82b950452260e59d86184c2f">   90</a></span>&#160;<span class="preprocessor">#define USB_TMC_TRANSFER_ATTR_TERM_CHAR     0x02</span></div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="../../d3/dcc/a00264.html">   94</a></span>&#160;<span class="keyword">union </span><a class="code" href="../../d3/dcc/a00264.html">usb_tmc_bulk_header_specific</a> {</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keyword">struct </span>{</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        uint32_t TransferSize;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        uint8_t bmTransferAttributes;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;        uint8_t Reserved[3];</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    } dev_dep_msg_out;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    <span class="keyword">struct </span>{</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        uint32_t TransferSize;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        uint8_t bmTransferAttributes;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        uint8_t TermChar;</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        uint8_t Reserved[2];</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    } request_dev_dep_msg_in;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keyword">struct </span>{</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        uint32_t TransferSize;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;        uint8_t bmTransferAttributes;</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;        uint8_t Reserved[3];</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    } dev_dep_msg_in;</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    <span class="keyword">struct </span>{</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        uint32_t TransferSize;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        uint8_t Reserved[4];</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    } vendor_specific_out;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    <span class="keyword">struct </span>{</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;        uint32_t TransferSize;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        uint8_t Reserved[4];</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    } request_vendor_specific_in;</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    <span class="keyword">struct </span>{</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;        uint32_t TransferSize;</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;        uint8_t Reserved[4];</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    } vendor_specific_in;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;};</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="../../d8/d0a/a00292.html">  132</a></span>&#160;<span class="keyword">struct </span><a class="code" href="../../d8/d0a/a00292.html">usb_tmc_bulk_header</a> {</div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="../../d8/d0a/a00292.html#aa145afb979d299ec97bf98850f500746">  134</a></span>&#160;    uint8_t <a class="code" href="../../d8/d0a/a00292.html#aa145afb979d299ec97bf98850f500746">MsgId</a>;</div><div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="../../d8/d0a/a00292.html#a6a867a46ec6d60b3640286c320c50420">  138</a></span>&#160;    uint8_t <a class="code" href="../../d8/d0a/a00292.html#a6a867a46ec6d60b3640286c320c50420">bTag</a>;</div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="../../d8/d0a/a00292.html#aa907cb14813049fbd788e88c3a22b6d9">  140</a></span>&#160;    uint8_t <a class="code" href="../../d8/d0a/a00292.html#aa907cb14813049fbd788e88c3a22b6d9">bTagInverse</a>;</div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    uint8_t Reserved;</div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="../../d8/d0a/a00292.html#a4c0fb1582e86b78e9c767571e0ba1d33">  143</a></span>&#160;    <span class="keyword">union </span><a class="code" href="../../d3/dcc/a00264.html">usb_tmc_bulk_header_specific</a> MsgSpecific;</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;} __attribute__((packed));</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="preprocessor">#if defined(__cplusplus)</span></div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;}</div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _USB_TMC_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="a00264_html"><div class="ttname"><a href="../../d3/dcc/a00264.html">usb_tmc_bulk_header_specific</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d89/a00071_source.html#l00094">usb_tmc.h:94</a></div></div>
<div class="ttc" id="a00292_html_a6a867a46ec6d60b3640286c320c50420"><div class="ttname"><a href="../../d8/d0a/a00292.html#a6a867a46ec6d60b3640286c320c50420">usb_tmc_bulk_header::bTag</a></div><div class="ttdeci">uint8_t bTag</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d89/a00071_source.html#l00138">usb_tmc.h:138</a></div></div>
<div class="ttc" id="a00292_html_aa907cb14813049fbd788e88c3a22b6d9"><div class="ttname"><a href="../../d8/d0a/a00292.html#aa907cb14813049fbd788e88c3a22b6d9">usb_tmc_bulk_header::bTagInverse</a></div><div class="ttdeci">uint8_t bTagInverse</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d89/a00071_source.html#l00140">usb_tmc.h:140</a></div></div>
<div class="ttc" id="a00292_html_aa145afb979d299ec97bf98850f500746"><div class="ttname"><a href="../../d8/d0a/a00292.html#aa145afb979d299ec97bf98850f500746">usb_tmc_bulk_header::MsgId</a></div><div class="ttdeci">uint8_t MsgId</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d89/a00071_source.html#l00134">usb_tmc.h:134</a></div></div>
<div class="ttc" id="a00260_html"><div class="ttname"><a href="../../dd/dd7/a00260.html">usb_tmc_get_capabilities_response</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d89/a00071_source.html#l00063">usb_tmc.h:63</a></div></div>
<div class="ttc" id="a00292_html"><div class="ttname"><a href="../../d8/d0a/a00292.html">usb_tmc_bulk_header</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d89/a00071_source.html#l00132">usb_tmc.h:132</a></div></div>
</div><!-- fragment --></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="../../dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><b>usb_tmc.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>