tinyusb/0.4/md_doxygen_started_build_demo.html
2014-04-15 12:05:21 +07:00

179 lines
9.2 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: Build Demos</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
&#160;<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&#160;Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><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><!-- 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('md_doxygen_started_build_demo.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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">Build Demos </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><b>Table of Contents</b></p>
<ul>
<li><a href="#lpcxpresso">LPCXpresso</a></li>
<li><a href="#keil">Keil</a></li>
<li><a href="#iar">IAR</a></li>
<li><a href="#configure-demo">Configure demo</a></li>
</ul>
<h2>LPCXpresso</h2>
<p>LPCXpresso is an eclipse-based IDE, so you will need to create an workspace first then import project files (.cproject &amp; .project) into it. The following step explain how to do just that.</p>
<ol type="1">
<li><p class="startli">Click <em>File-&gt;Import</em>, then expand the <em>General</em> folder and select <b>Existing Projects into Workspace</b> and click Next.</p>
<div class="image">
<img src="http://docs.tinyusb.org/images/lpcxpresso_import.png" alt="lpcxpresso_import.png"/>
</div>
</li>
<li><p class="startli">On the next dialog, Click <em>Browse</em> and choose the <b>repo/demos</b> folder inside the repo. You should see a list of all demo applications. [<b>IMPORTANT</b>] Make sure the option <b>Copy projects into workspace</b> is <b>CLEAR</b>, as demo application uses <em>link folders</em> and this option may cause problem with the copy import. Then choose any of the demo application and click <em>Finish</em>.</p>
<div class="image">
<img src="http://docs.tinyusb.org/images/lpcxpresso_import2.png" alt="lpcxpresso_import2.png"/>
</div>
</li>
<li><p class="startli">Select the configure corresponding to your development board.</p>
<div class="image">
<img src="http://docs.tinyusb.org/images/lpcxpresso_select_board.png" alt="lpcxpresso_select_board.png"/>
</div>
</li>
<li><p class="startli">Then select the correct MCU option from project properties then you are ready to go.</p>
<div class="image">
<img src="http://docs.tinyusb.org/images/lpcxpresso_mcu.png" alt="lpcxpresso_mcu.png"/>
</div>
</li>
</ol>
<h2>Keil</h2>
<p>It is relatively simple for Keil</p>
<ol type="1">
<li>Open the desired demo project e.g <em>demos/host/host_freertos/host_freertos.uvproj</em></li>
<li><p class="startli">Select the configure corresponding to your development board and build it.</p>
<div class="image">
<img src="http://docs.tinyusb.org/images/keil_select_board.png" alt="keil_select_board.png"/>
</div>
</li>
</ol>
<h2>IAR</h2>
<p>IAR is just as easy as Keil</p>
<ol type="1">
<li>Open the desired demo project e.g <em>demos/host/host_freertos/host_freertos.eww</em></li>
<li><p class="startli">Again select the configure corresponding to your development board and build it.</p>
<div class="image">
<img src="http://docs.tinyusb.org/images/iar_select_board.png" alt="iar_select_board.png"/>
</div>
</li>
</ol>
<h2>Configure demo</h2>
<p>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.</p>
<p>In addition, there are some configuration you can change such as</p>
<ul>
<li>CFG_UART_BAUDRATE in <a class="el" href="board_8h.html">board.h</a></li>
<li>CFG_PRINTF_TARGET in the specific board header (e.g <a class="el" href="board__ea4357_8h.html">board_ea4357.h</a>) to either Semihost, Uart, or SWO. </li>
</ul>
</div></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="md_doxygen_getting_started.html">Getting Started</a></li>
<li class="footer">Generated on Tue Apr 15 2014 10:49:27 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>