190 lines
16 KiB
HTML
190 lines
16 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/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_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/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"># Build 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">- [LPCXpresso](#lpcxpresso)</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="stringliteral">- [Keil](#keil)</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="stringliteral">- [IAR](#iar)</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="stringliteral">- [Configure demo](#configure-demo)</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="stringliteral"><!-- END doctoc generated TOC please keep comment here to allow auto update --></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="stringliteral">## LPCXpresso</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="stringliteral">LPCXpresso is an eclipse-based IDE, so you will need to create an workspace first then import project files (.cproject & .project) into it. The following step explain how to do just that. </span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="stringliteral">1. Click *File->Import*, then expand the *General* folder and select **Existing Projects into Workspace** and click Next.</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="stringliteral"></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"> </span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="stringliteral">2. On the next dialog, Click *Browse* and choose the **repo/demos** folder inside the repo. You should see a list of all demo applications. \[**IMPORTANT**\] Make sure the option **Copy projects into workspace** is **CLEAR**, as demo application uses *link folders* and this option may cause problem with the copy import. Then choose any of the demo application and click *Finish*.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="stringliteral">3. Select the configure corresponding to your development board.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="stringliteral"> </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"> </span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="stringliteral">4. Then select the correct MCU option from project properties then you are ready to go.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="stringliteral"> </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"></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="stringliteral">*TIPS* Working with eclipse-based IDE like lpcxpresso, you should change the indexer option in *Preferences->C/C++->Indexer* to "active build" to have a better code viewer. Those lines that are opt out by #if will be gray, I found this extremely helpful.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="stringliteral"></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"></span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="stringliteral">## Keil</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="stringliteral">It is relatively simple for Keil</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="stringliteral">1. Open the desired demo project e.g *demos/host/host\_freertos/host_freertos.uvproj*</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="stringliteral">2. Select the configure corresponding to your development board and build it. </span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="stringliteral">  </span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="stringliteral">## IAR</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">IAR is just as easy as Keil</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">1. Open the desired demo project e.g *demos/host/host\_freertos/host_freertos.eww*</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="stringliteral">2. Again select the configure corresponding to your development board and build it. </span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="stringliteral"> </span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="stringliteral">## Configure demo</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="stringliteral">Application demo is written to have the code excluded if its required option is not enabled in [tusb_config.h](). Some of combination may exceed the 32KB limit of IAR/Keil so you may want to re-configure to disable some class support, decrease TUSB_CFG_DEBUG or increase the compiler optimization level.</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="stringliteral">In addition, there are some configuration you can change such as</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="stringliteral"></span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="stringliteral">- CFG_UART_BAUDRATE in board.h</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="stringliteral">- CFG_PRINTF_TARGET in the specific board header (e.g board_ea4357.h) to either Semihost, Uart, or SWO.</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>
|