| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274 |
- <!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 class</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
-  <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('d4/d3a/a00101.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="summary">
- <a href="#nested-classes">Data Structures</a> </div>
- <div class="headertitle">
- <div class="title">USB TMC class</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>This module contains USB Device Test and Measurement Class definitions.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/dd7/a00260.html">usb_tmc_get_capabilities_response</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/dcc/a00264.html">usb_tmc_bulk_header_specific</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d0a/a00292.html">usb_tmc_bulk_header</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USB TMC class, subclass and protocol definitions</h2></td></tr>
- <tr class="memitem:gae8f139bd05707b567ecb9a8fefb96934"><td class="memItemLeft" align="right" valign="top"><a id="gae8f139bd05707b567ecb9a8fefb96934"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_CLASS_TMC</b>   0xFE</td></tr>
- <tr class="separator:gae8f139bd05707b567ecb9a8fefb96934"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad339b36914bfae60d403369e19148aa0"><td class="memItemLeft" align="right" valign="top"><a id="gad339b36914bfae60d403369e19148aa0"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_SUBCLASS_TMC</b>   0x03</td></tr>
- <tr class="separator:gad339b36914bfae60d403369e19148aa0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae736383637bbaf1da5232db98398740c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d3a/a00101.html#gae736383637bbaf1da5232db98398740c">USB_TMC_PROTO_NONE</a>   0x00</td></tr>
- <tr class="separator:gae736383637bbaf1da5232db98398740c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4cf0c8f575aad3a9a2799cff94c9f35a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d3a/a00101.html#ga4cf0c8f575aad3a9a2799cff94c9f35a">USB_TMC_PROTO_USB488</a>   0x01</td></tr>
- <tr class="separator:ga4cf0c8f575aad3a9a2799cff94c9f35a"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USBTMC requests</h2></td></tr>
- <tr class="memitem:gafc18e987b57f2151070724f261897bb6"><td class="memItemLeft" align="right" valign="top"><a id="gafc18e987b57f2151070724f261897bb6"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_INITIATE_ABORT_BULK_OUT</b>   1</td></tr>
- <tr class="separator:gafc18e987b57f2151070724f261897bb6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga136c799351ea0d98e83d2bd8d6252b54"><td class="memItemLeft" align="right" valign="top"><a id="ga136c799351ea0d98e83d2bd8d6252b54"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_CHECK_ABORT_BULK_OUT_STATUS</b>   2</td></tr>
- <tr class="separator:ga136c799351ea0d98e83d2bd8d6252b54"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5a456db850c0980f9351151c77b4d039"><td class="memItemLeft" align="right" valign="top"><a id="ga5a456db850c0980f9351151c77b4d039"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_INITIATE_ABORT_BULK_IN</b>   3</td></tr>
- <tr class="separator:ga5a456db850c0980f9351151c77b4d039"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga445ec92e3a8eadc62a39ab5cd323786a"><td class="memItemLeft" align="right" valign="top"><a id="ga445ec92e3a8eadc62a39ab5cd323786a"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_CHECK_ABORT_BULK_IN_STATUS</b>   4</td></tr>
- <tr class="separator:ga445ec92e3a8eadc62a39ab5cd323786a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga93551209c0925627a9663dccbadea51d"><td class="memItemLeft" align="right" valign="top"><a id="ga93551209c0925627a9663dccbadea51d"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_INITIATE_CLEAR</b>   5</td></tr>
- <tr class="separator:ga93551209c0925627a9663dccbadea51d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga96bd1c674fae4e023e7e1ce368ff6e2b"><td class="memItemLeft" align="right" valign="top"><a id="ga96bd1c674fae4e023e7e1ce368ff6e2b"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_CHECK_CLEAR_STATUS</b>   6</td></tr>
- <tr class="separator:ga96bd1c674fae4e023e7e1ce368ff6e2b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa848809169e6b441d0f58f2202bf137e"><td class="memItemLeft" align="right" valign="top"><a id="gaa848809169e6b441d0f58f2202bf137e"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_GET_CAPABILITIES</b>   7</td></tr>
- <tr class="separator:gaa848809169e6b441d0f58f2202bf137e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6aaac7336ea3d8fb5bf0c2a0a4c758ea"><td class="memItemLeft" align="right" valign="top"><a id="ga6aaac7336ea3d8fb5bf0c2a0a4c758ea"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQ_INDICATOR_PULSE</b>   64</td></tr>
- <tr class="separator:ga6aaac7336ea3d8fb5bf0c2a0a4c758ea"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- USBTMC status values</h2></td></tr>
- <tr class="memitem:ga842c8923b6986ff874216a5c21db3e4d"><td class="memItemLeft" align="right" valign="top"><a id="ga842c8923b6986ff874216a5c21db3e4d"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_STATUS_SUCCESS</b>   0x01</td></tr>
- <tr class="separator:ga842c8923b6986ff874216a5c21db3e4d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0acbde3db58d222b4a2a1dcf681f3862"><td class="memItemLeft" align="right" valign="top"><a id="ga0acbde3db58d222b4a2a1dcf681f3862"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_STATUS_PENDING</b>   0x02</td></tr>
- <tr class="separator:ga0acbde3db58d222b4a2a1dcf681f3862"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0630b46b2ac53874ff9110598ba39195"><td class="memItemLeft" align="right" valign="top"><a id="ga0630b46b2ac53874ff9110598ba39195"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_STATUS_FAILED</b>   0x80</td></tr>
- <tr class="separator:ga0630b46b2ac53874ff9110598ba39195"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga94fd0430e2af73b71aea18e015492510"><td class="memItemLeft" align="right" valign="top"><a id="ga94fd0430e2af73b71aea18e015492510"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_STATUS_TRANSFER_NOT_IN_PROGRESS</b>   0x81</td></tr>
- <tr class="separator:ga94fd0430e2af73b71aea18e015492510"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2539816b12cef04aa46b194f9ca355a3"><td class="memItemLeft" align="right" valign="top"><a id="ga2539816b12cef04aa46b194f9ca355a3"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_STATUS_SPLIT_NOT_IN_PROGRESS</b>   0x82</td></tr>
- <tr class="separator:ga2539816b12cef04aa46b194f9ca355a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga46018930eefca5cc3c4804f94e1c3ea6"><td class="memItemLeft" align="right" valign="top"><a id="ga46018930eefca5cc3c4804f94e1c3ea6"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_STATUS_SPLIT_IN_PROGRESS</b>   0x83</td></tr>
- <tr class="separator:ga46018930eefca5cc3c4804f94e1c3ea6"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- MsgId values</h2></td></tr>
- <tr class="memitem:ga506d95cd73bf62f27dc57bcfa3f2813d"><td class="memItemLeft" align="right" valign="top"><a id="ga506d95cd73bf62f27dc57bcfa3f2813d"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_DEV_DEP_MSG_OUT</b>   1</td></tr>
- <tr class="separator:ga506d95cd73bf62f27dc57bcfa3f2813d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga80e978e3a8f3f975fe0081ad41e0eb59"><td class="memItemLeft" align="right" valign="top"><a id="ga80e978e3a8f3f975fe0081ad41e0eb59"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQUEST_DEV_DEP_MSG_IN</b>   2</td></tr>
- <tr class="separator:ga80e978e3a8f3f975fe0081ad41e0eb59"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa6366374e09f7abda90162fafb69b22f"><td class="memItemLeft" align="right" valign="top"><a id="gaa6366374e09f7abda90162fafb69b22f"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_DEV_DEP_MSG_IN</b>   2</td></tr>
- <tr class="separator:gaa6366374e09f7abda90162fafb69b22f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga449863048b3ae7d47bcb36aa44c67ccc"><td class="memItemLeft" align="right" valign="top"><a id="ga449863048b3ae7d47bcb36aa44c67ccc"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_VENDOR_SPECIFIC_OUT</b>   126</td></tr>
- <tr class="separator:ga449863048b3ae7d47bcb36aa44c67ccc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga23489ea9710296cd29335dad4b13e7f9"><td class="memItemLeft" align="right" valign="top"><a id="ga23489ea9710296cd29335dad4b13e7f9"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_REQUEST_VENDOR_SPECIFIC_IN</b>   127</td></tr>
- <tr class="separator:ga23489ea9710296cd29335dad4b13e7f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad307cc5ce3428fdaa2405b6365de2caa"><td class="memItemLeft" align="right" valign="top"><a id="gad307cc5ce3428fdaa2405b6365de2caa"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>USB_TMC_VENDOR_SPECIFIC_IN</b>   127</td></tr>
- <tr class="separator:gad307cc5ce3428fdaa2405b6365de2caa"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
- Transfer Attributes</h2></td></tr>
- <tr class="memitem:gadf387a39bd06cd31a35b1b6328998f20"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d3a/a00101.html#gadf387a39bd06cd31a35b1b6328998f20">USB_TMC_TRANSFER_ATTR_EOM</a>   0x01</td></tr>
- <tr class="separator:gadf387a39bd06cd31a35b1b6328998f20"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0697841d82b950452260e59d86184c2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d3a/a00101.html#ga0697841d82b950452260e59d86184c2f">USB_TMC_TRANSFER_ATTR_TERM_CHAR</a>   0x02</td></tr>
- <tr class="separator:ga0697841d82b950452260e59d86184c2f"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>This module contains USB Device Test and Measurement Class definitions. </p>
- <p>This module based on <a href="https://www.usb.org/sites/default/files/USBTMC_1_006a.zip">USB Device Test and Measurement Class Specification, Revision 1.0</a> </p>
- <h2 class="groupheader">Macro Definition Documentation</h2>
- <a id="gae736383637bbaf1da5232db98398740c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gae736383637bbaf1da5232db98398740c">◆ </a></span>USB_TMC_PROTO_NONE</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_TMC_PROTO_NONE   0x00</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>No subclass specification applies. </p>
- <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00036">36</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
- </div>
- </div>
- <a id="ga4cf0c8f575aad3a9a2799cff94c9f35a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4cf0c8f575aad3a9a2799cff94c9f35a">◆ </a></span>USB_TMC_PROTO_USB488</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_TMC_PROTO_USB488   0x01</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>USBTMC USB488 subclass interface. </p>
- <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00037">37</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
- </div>
- </div>
- <a id="gadf387a39bd06cd31a35b1b6328998f20"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gadf387a39bd06cd31a35b1b6328998f20">◆ </a></span>USB_TMC_TRANSFER_ATTR_EOM</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_TMC_TRANSFER_ATTR_EOM   0x01</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The last USBTMC message data byte in the transfer is the last byte of the USBTMC message. </p>
- <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00086">86</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
- </div>
- </div>
- <a id="ga0697841d82b950452260e59d86184c2f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0697841d82b950452260e59d86184c2f">◆ </a></span>USB_TMC_TRANSFER_ATTR_TERM_CHAR</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define USB_TMC_TRANSFER_ATTR_TERM_CHAR   0x02</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The Bulk-IN transfer must terminate on the specified TermChar. The Host may only set this bit if the USBTMC interface indicates it supports TermChar in the GET_CAPABILITIES response packet </p>
- <p class="definition">Definition at line <a class="el" href="../../d0/d89/a00071_source.html#l00090">90</a> of file <a class="el" href="../../d0/d89/a00071_source.html">usb_tmc.h</a>.</p>
- </div>
- </div>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <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>
|