155 lines
6.8 KiB
HTML
155 lines
6.8 KiB
HTML
|
<!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: Get Started</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="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 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><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li class="current"><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('md_tinyusb_doxygen_get_started.html','');});
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Get Started </div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><h2>Download</h2>
|
||
|
|
<p>tinyusb uses github as online repository <a href="https://github.com/hathach/tinyusb">https://github.com/hathach/tinyusb</a> since it is the best place for open source project.</p>
|
||
|
|
<p>If you are using Linux, you already know how to what to do. But If Windows is your OS, I would suggest to install <a href="http://git-scm.com/">git</a> and front-end gui such as <a href="http://code.google.com/p/tortoisegit">tortoisegit</a> to begin with.</p>
|
||
|
|
<p>After downloading/cloning, the code base is composed of</p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>Folder </th><th>Description </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td>boards </td><td>Source files of supported boards </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>demos </td><td>Source & project files for demonstration application </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>docs </td><td>Documentation </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>mcu </td><td>Low level mcu core & peripheral drivers (e.g CMSIS ) </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>tests </td><td>Unit tests for the stack </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>tinyusb </td><td>All sources files for tinyusb stack itself. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>vendor </td><td>Source files from 3rd party such as freeRTOS, fatfs etc ... </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2>Import & Build</h2>
|
||
|
|
<p>*/demos* is the folder where all the application & project files are located. There are demos for both device and hosts. For each, there are different projects for each of supported RTOS.</p>
|
||
|
|
<h3>Prerequisites</h3>
|
||
|
|
<p>In order to build and run application demo, you would need</p>
|
||
|
|
<ul>
|
||
|
|
<li>A ../../boards/readme.md "supported development board"</li>
|
||
|
|
<li>A supported toolchain: LPCXpresso, Keil, IAR.</li>
|
||
|
|
</ul>
|
||
|
|
<h3>LPCXpresso</h3>
|
||
|
|
<p>To prevent any sort of problems, it is recommended to do <b>EXACTLY</b> as follows (esp the item 4)</p>
|
||
|
|
<ol type="1">
|
||
|
|
<li>Copy the whole repo folder to your lpcxpresso's workspace.</li>
|
||
|
|
<li>Click <em>File->Import</em>, then expand the <em>General</em> folder and select <b>Existing Projects into Workspace</b> and click Next <div class="image">
|
||
|
|
<img src="lpcxpresso_import.png" alt="lpcxpresso_import.png"/>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>On the next dialog, Click <em>Browse</em> and choose the **/demos** folder inside the repo. You should see a list of all demo applications <div class="image">
|
||
|
|
<img src="lpcxpresso_import2.png" alt="lpcxpresso_import2.png"/>
|
||
|
|
</div>
|
||
|
|
.</li>
|
||
|
|
<li><b>IMPORTANT</b> make sure the option **"Copy projects into workspace"** is <b>clear</b>. As demo application uses link folders and this option may cause problem for the import.</li>
|
||
|
|
<li>Choose any of the demo application and click <em>Finish</em></li>
|
||
|
|
<li>Select the configure corresponding to your development board <div class="image">
|
||
|
|
<img src="lpcxpresso_select_config.png" alt="lpcxpresso_select_config.png"/>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>Then select the correct MCU option from project properties <div class="image">
|
||
|
|
<img src="lpcxpresso_mcu.png" alt="lpcxpresso_mcu.png"/>
|
||
|
|
</div>
|
||
|
|
then you are ready to go.</li>
|
||
|
|
</ol>
|
||
|
|
<h3>Keil</h3>
|
||
|
|
<p>It is relatively simple for Keil</p>
|
||
|
|
<ol type="1">
|
||
|
|
<li>Open the desired demo project e.g */demos/host/host_freertos/host_freertos.uvproj*</li>
|
||
|
|
<li>Select the configure corresponding to your development board <div class="image">
|
||
|
|
<img src="keil_select_board.png" alt="keil_select_board.png"/>
|
||
|
|
</div>
|
||
|
|
and build it.</li>
|
||
|
|
</ol>
|
||
|
|
<h3>IAR</h3>
|
||
|
|
<p>IAR is just as easy as Keil</p>
|
||
|
|
<ol type="1">
|
||
|
|
<li>Open the desired demo project e.g */demos/host/host_freertos/host_freertos.eww*</li>
|
||
|
|
<li>Again select the configure corresponding to your development board <div class="image">
|
||
|
|
<img src="iar_select_board.png" alt="iar_select_board.png"/>
|
||
|
|
</div>
|
||
|
|
and build it.</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="footer">Generated on Wed Mar 26 2014 16:23:18 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>
|