redirection
This commit is contained in:
hathach
parent
452485c458
commit
c2b744846c
116
index.html
116
index.html
|
|
@ -6,120 +6,4 @@
|
|||
<meta http-equiv="refresh" content="0; url=0.4/index.html">
|
||||
<link rel="canonical" href="0.4/index.html" />
|
||||
</head>
|
||||
<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 style="padding-left: 0.5em;">
|
||||
<div id="projectname">tinyusb
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.6 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li class="current"><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><a href="annotated.html"><span>Data Structures</span></a></li>
|
||||
<li><a href="files.html"><span>Files</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('index.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">tinyusb Documentation</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><h2>What Is tinyusb</h2>
|
||||
<p>tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controller. It is developed using Test-Driven Development (TDD) approach to eliminate bugs as soon as possible.</p>
|
||||
<div class="image">
|
||||
<img src="/docs/images/what_is_tinyusb.png" alt="tinyusb diagram"/>
|
||||
</div>
|
||||
<h2>Features</h2>
|
||||
<p>designed to run out-of-the-box and easy to configure.</p>
|
||||
<h3>Host</h3>
|
||||
<ul>
|
||||
<li>HID Mouse</li>
|
||||
<li>HID Keyboard</li>
|
||||
<li>HID Generic (comming soon)</li>
|
||||
<li>Communication Device Class (CDC)</li>
|
||||
<li>Mass Storage Class (MSC)</li>
|
||||
<li>Hub<ul>
|
||||
<li>Only support 1 level of hub (due to my laziness)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Device</h3>
|
||||
<ul>
|
||||
<li>HID Mouse</li>
|
||||
<li>HID Keyboard</li>
|
||||
<li>HID Generic (comming soon)</li>
|
||||
<li>Communication Class (CDC)</li>
|
||||
<li>Mass Storage Class (MSC)</li>
|
||||
</ul>
|
||||
<h3>RTOS</h3>
|
||||
<p>tinyusb is designed to be OS-ware and run across RTOS vendors, thanks to its OS Abstraction Layer (OSAL). However, it can also run without an RTOS (OSAL will be expanded to be a state machine in this case). Currently the following OS can be run with tinyusb (out of the box).</p>
|
||||
<ul>
|
||||
<li><b>None OS</b></li>
|
||||
<li><b>FreeRTOS</b></li>
|
||||
<li><b>CMSIS RTX</b></li>
|
||||
</ul>
|
||||
<h2>Supported Platforms</h2>
|
||||
<p>The stack supports the following MCUs</p>
|
||||
<h3>NXP</h3>
|
||||
<ul>
|
||||
<li>LPC11uxx</li>
|
||||
<li>LPC13uxx (12 bit ADC)</li>
|
||||
<li>LPC175x_6x</li>
|
||||
<li>LPC43xx</li>
|
||||
</ul>
|
||||
<p><a href="boards/">Here is the list of supported Boards</a> in the code base</p>
|
||||
<h3>Toolchains</h3>
|
||||
<p>You can compile with any of following toolchains</p>
|
||||
<ul>
|
||||
<li><em>lpcxpresso/redsuite</em></li>
|
||||
<li><em>Keil MDK</em></li>
|
||||
<li><em>IAR Workbench</em></li>
|
||||
</ul>
|
||||
<h2>Getting Started</h2>
|
||||
<p>Here is the details for getting started with the stack</p>
|
||||
<h2>Known Issues</h2>
|
||||
<ul>
|
||||
<li>LPC11uxx & LPC13uxx cannot able to STALL Control OUT endpoint !!! –> unsupported with data out request may cause host stuck with control transfer forever. (reproduce: enable keyboard + mouse, return error in set report of hid_device)</li>
|
||||
</ul>
|
||||
<h2>How Can I Help</h2>
|
||||
<p>If you find my little USB stack is useful, please take some time to file any issues that you encountered. It is not necessary to be a software bug, it can be a question, request, suggestion etc. We can consider each github's issue as a forum's topic. Alternatively, you can buy me a cup of coffee if you happen to be in Hochiminh city.</p>
|
||||
<h2>License</h2>
|
||||
<p>BSD license for most of the code base, but each file is individually licensed especially those in /vendor folder. Please make sure you understand all the license term for files you use in your project. Full license here </p>
|
||||
</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 on Wed Mar 26 2014 16:23:21 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>
|
||||
|
|
|
|||
Loading…
Reference in New Issue