208 lines
20 KiB
HTML
208 lines
20 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: demos/device/readme.md 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="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><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</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('demos_2device_2readme_8md.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="headertitle">
|
|
<div class="title">demos/device/readme.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor"># Device Demos #</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <!-- START doctoc generated TOC please keep comment here to allow <span class="keyword">auto</span> update --></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <!-- DON<span class="stringliteral">'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="stringliteral">**Table of Contents**</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="stringliteral">- [Prerequisites](#prerequisites)</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="stringliteral">- [Human Interface Device (HID)](#human-interface-device-hid)</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="stringliteral"> - [Keyboard](#keyboard)</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="stringliteral"> - [Mouse](#mouse)</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="stringliteral">- [Mass Storage Class Device (MSC)](#mass-storage-class-device-msc)</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="stringliteral">- [Communication Class Device (CDC)](#communication-class-device-cdc)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="stringliteral"> - [Serial](#serial)</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="stringliteral"><!-- END doctoc generated TOC please keep comment here to allow auto update --></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="stringliteral">device application code is store at *demos/device/src* containing</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="stringliteral">File | Description</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="stringliteral">----- | -------------</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="stringliteral">main.c | Initialization (board, stack) and a RTOS task scheduler call or just simple a indefinite loop for non OS to invoke class-specific tasks.</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="stringliteral">tusb_config.h | tinyusb stack configuration.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="stringliteral">tusb_descriptors(c,h) | contains all the required usb descriptors for all combination of supported classes. And definition of stack-required variable *tusbd_descriptor_pointers*.</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="stringliteral">app_os_prio.h | RTOS task priority definitions</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="stringliteral">Class-specific | Application files for supported classes.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="stringliteral">The demo will start with the greeting of enabled classes and chosen RTOS then start to blink an LED at 1 Hz.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="stringliteral">## Prerequisites ##</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="stringliteral">In order to run application demo, you would need</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="stringliteral">- A [supported development board](../../boards/readme.md) with at least a button for mouse, keyboard demo.</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="stringliteral">- A supported toolchain: LPCXpresso, Keil, IAR.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="stringliteral">- A decent terminal such as [Tera Term](http://en.sourceforge.jp/projects/ttssh2/) for CDC Serial.</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="stringliteral">## Human Interface Device (HID)</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="stringliteral">### Keyboard</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="stringliteral">After the board get enumerated successfully, you can try to press some buttons while opening notepad. It should get some characters out accordingly. In addition, when you press Capslock or Numlock key on your own pc'</span>s keyboard, the LED will blink faster twice. This demonstrates that keyboard application can receive Set Report via control pipe. </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> Notes: The very same buttons may also used by Mouse application. You can <span class="keyword">get</span> the mouse moving and character, should you enable both.</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> ### Mouse</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> After the board <span class="keyword">get</span> enumerated successfully, you can <span class="keywordflow">try</span> to press some buttons. The mouse<span class="stringliteral">'s cursor should move accordingly.</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="stringliteral">Notes: The very same buttons may also used by Keyboard application. You can get the mouse moving and character, should you enable both.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="stringliteral">## Mass Storage Class Device (MSC)</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="stringliteral">This class is very simple, as soon as the demo work, you could open the demo drive. Inside, you should find a *README.TXT* file which contains a few lines of descriptions. The demo drive'</span>s format is FAT12 and only has 8KB, which is the smallest possible to work with most host OS (Windows/Linux).</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> Notes: The entire disk contents ( 8KB ) is located on MCU's SRAM if possible (such as lpc43xx, lpc175x_6x). For MCU (lpc11u, lpc13u) that cannot afford that, the contents is instead on internal Flash which make the demo drive is read-only. </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">## Communication Class Device (CDC)</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> CDC has several subclass, currently tinyusb only supports the popular *Abstract Control Model (ACM)*</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">### Serial</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> The <span class="keyword">virtual</span> COM is also as easy as MSC. Except that we need to <span class="stringliteral">"install"</span> driver <span class="keywordflow">for</span> the first plug <span class="keywordflow">if</span> your host OS is Windows, Linux should be able to work right away.</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> **Install Driver <span class="keywordflow">for</span> Windows**</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> Actually Windows already has the needed driver to operate with <span class="keyword">virtual</span> serial of CDC-ACM, the *usbser*. However, since it also use Abstract Control Model <span class="keywordflow">for</span> other purposes, it requires us to tell exactly which VendorID/ProductID comibination should be used as a <span class="keyword">virtual</span> serial. The demo<span class="stringliteral">'s src folder includes *WinCDCdriver.inf* to do just that.</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="stringliteral">Firstly open *Device Manager*, we should find our board under "Other devices", right click on it and choose "Update Driver Software..."</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="stringliteral">Then choose "Browse my computer for driver software" then navigate to the device demo'</span>s *src* and click next. Since I am nowhere near a known publisher to Microsoft, it will warn you with a scary dialog. With all your trust in me, click next and hope that nothing harmful will ever happen and we are done with the driver.</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> ![Serial Install Driver](http:<span class="comment">//docs.tinyusb.org/images/demo_serial_driver2.png)</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> **Testing Demo**</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> Connect to the <span class="stringliteral">"tinyusb Serial Port"</span> with your terminal application, and start to type. You should <span class="keyword">get</span> echo back as the CDC serial application demo is written to transmit what it received.</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> ![Serial Connect](http:<span class="comment">//docs.tinyusb.org/images/demo_cdc_connect.png)</span></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"><b>readme.md</b></li>
|
|
<li class="footer">Generated on Thu Apr 17 2014 13:05:22 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>
|