diff options
Diffstat (limited to 'html/index.html')
| -rw-r--r-- | html/index.html | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/html/index.html b/html/index.html new file mode 100644 index 0000000..974f2bb --- /dev/null +++ b/html/index.html @@ -0,0 +1,213 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Lightweight USB stack: Main Page</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="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Lightweight USB stack +  <span id="projectnumber">1.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></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"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</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">Lightweight USB stack Documentation</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div class="image"> +<img src="https://img.shields.io/travis/dmitrystu/libusb_stm32/master?logo=travis" alt="Travis (.org) branch"/> +</div> +<h3>Lightweight USB Device Stack</h3> +<ul> +<li>Lightweight and fast</li> +<li>Event-driven process workflow</li> +<li>Completely separated USB hardware driver and usb core</li> +<li>Easy to use.</li> +</ul> +<h3>Requirements</h3> +<ul> +<li><a href="https://github.com/ARM-software/CMSIS">CMSIS V4</a> or <a href="https://github.com/ARM-software/CMSIS_5">CMSIS V5</a>.</li> +<li><a href="https://github.com/dmitrystu/stm32h">stm32.h</a> STM32 universal header</li> +</ul> +<p>All requirements can be downloaded into a directory specified in environment variable <code>CMSIS</code> using <code>make cmsis</code> command.</p> +<h3>Supported hardware</h3> +<table class="doxtable"> +<tr> +<th>MCU Series</th><th>Features</th><th>Driver</th><th>File </th></tr> +<tr> +<td rowspan="2">STM32L0x2 STM32L0x3 STM32F070 STM32F0x2 STM32F0x8 </td><td rowspan="2">Doublebuffered<sup>[2]</sup><br /> +8<sup>[1]</sup> endpoints<br /> + BC1.2 </td><td>usbd_devfs </td><td>usbd_stm32l052_devfs.c </td></tr> +<tr> +<td>usbd_devfs_asm </td><td>usbd_stm32l052_devfs_asm.S </td></tr> +<tr> +<td rowspan="2">STM32L4x2 STM32L4x3 STM32G4 series </td><td rowspan="2">Doublebuffered<sup>[2]</sup><br /> +8<sup>[1]</sup> endpoints<br /> + BC1.2 </td><td>usbd_devfs </td><td>usbd_stm32l433_devfs.c </td></tr> +<tr> +<td>usbd_devfs_asm </td><td>usbd_stm32l052_devfs_asm.S </td></tr> +<tr> +<td rowspan="2">STM32L1xx </td><td rowspan="2">Doublebuffered<sup>[2]</sup><br /> +8<sup>[1]</sup> endpoints </td><td>usbd_devfs </td><td>usbd_stm32l100_devfs.c </td></tr> +<tr> +<td>usbd_devfs_asm </td><td>usbd_stm32l100_devfs_asm.S </td></tr> +<tr> +<td rowspan="2">STM32F102 STM32F103 STM32F302 STM32F303 STM32F373 </td><td rowspan="2">Doublebuffered<sup>[2]</sup><br /> +External DP pullup<br /> +8<sup>[1]</sup> endpoints </td><td>usbd_devfs </td><td>usbd_stm32f103_devfs.c </td></tr> +<tr> +<td>usbd_devfs_asm </td><td>usbd_stm32f103_devfs_asm.S </td></tr> +<tr> +<td>STM32L4x5 STM32L4x6 </td><td>Doublebuffered<br /> +6 endpoints<br /> + BC1.2<br /> +VBUS detection </td><td>usbd_otgfs </td><td>usbd_stm32l476_otgfs.c </td></tr> +<tr> +<td rowspan="2">STM32F4x5 STM32F4x7 STM32F4x9 </td><td>Doublebuffered<br /> +4 endpoints<br /> +VBUS detection<br /> +SOF output </td><td>usbd_otgfs </td><td>usbd_stm32f429_otgfs.c </td></tr> +<tr> +<td>Doublebuffered<br /> +6 endpoints<br /> +VBUS detection<br /> +SOF output </td><td>usbd_otghs </td><td>usbd_stm32f429_otghs.c </td></tr> +<tr> +<td>STM32F105 STM32F107 </td><td>Doublebuffered<br /> +4 endpoints<br /> +VBUS detection<br /> +SOF output </td><td>usbd_otgfs </td><td>usbd_stm32f105_otgfs.c </td></tr> +</table> +<ol type="1"> +<li>Single physical endpoint can be used to implement<ul> +<li>one bi-directional/single-buffer logical endpoint (CONTROL)</li> +<li>one uni-directional/double-buffer logical endpoint (BULK OR ISOCHRONOUS)</li> +<li>two uni-directional/single-buffer logical endpoints (BULK OR INTERRUPT)</li> +</ul> +</li> +<li>At this moment BULK IN endpoint can use both buffers, but it is not <b>real</b> doublebuffered.</li> +<li>Tested with STM32L052K8, STM32L100RC, STM32L476RG, STM32F072C8, STM32F103C8, STM32F103CB, STM32F303CC, STM32F303RE, STM32F429ZI, STM32F105RBT6, STM32F107VCT6, STM32L433CCT6, STM32F070CBT6, STM32G431RB, STM32F411CEUx</li> +</ol> +<h3>Implemented definitions for classes</h3> +<ol type="1"> +<li>USB HID based on <a href="https://www.usb.org/sites/default/files/documents/hid1_11.pdf">Device Class Definition for Human Interface Devices (HID) Version 1.11</a></li> +<li>USB DFU based on <a href="https://www.usb.org/sites/default/files/DFU_1.1.pdf">USB Device Firmware Upgrade Specification, Revision 1.1</a></li> +<li>USB CDC based on <a href="https://www.usb.org/sites/default/files/CDC1.2_WMC1.1_012011.zip">Class definitions for Communication Devices 1.2</a></li> +<li>USB TMC based on <a href="https://www.usb.org/sites/default/files/USBTMC_1_006a.zip">USB Device Test and Measurement Class Specification, Revision 1.0</a></li> +</ol> +<h3>Using makefile</h3> +<ul> +<li>to build library module <div class="fragment"><div class="line">make module MODULE=path/module.a DEFINES="mcu spcified defines" CFLAGS="cpu cpecified compiler flags"</div></div><!-- fragment --></li> +<li>to build demo <div class="fragment"><div class="line">make bluepill program</div><div class="line">make stm32l052x8</div></div><!-- fragment --></li> +<li>to get a help <div class="fragment"><div class="line">make help</div></div><!-- fragment --></li> +</ul> +<h3>Default values:</h3> +<table class="doxtable"> +<tr> +<th>Variable </th><th>Default Value </th><th>Means </th></tr> +<tr> +<td>CMSIS </td><td>./CMSIS </td><td>path to CMSIS root folder </td></tr> +<tr> +<td>CMSISDEV </td><td>/home/fdi/proj/CMSIS_5/Device </td><td>path to CMSIS device folder </td></tr> +<tr> +<td>CMSISCORE</td><td>/home/fdi/proj/CMSIS_5/CMSIS/Include /home/fdi/proj/CMSIS_5/CMSIS/Core/Include </td><td>path to CMSIS core headers </td></tr> +<tr> +<td>MCU </td><td>stm32l100xc </td><td>MCU selection for demo project </td></tr> +<tr> +<td>CFLAGS </td><td>-mcpu=cortex-m3 -mfloat-abi=soft </td><td>MCU specified compiler flags </td></tr> +<tr> +<td>DEFINES </td><td>STM32L1 STM32L100xC </td><td>MCU specified defines </td></tr> +<tr> +<td>STPROG_CLI </td><td>~/STMicroelectronics/STM32Cube/STM32CubeProgrammer/bin/STM32_Programmer_CLI </td><td>Path to the ST Cube Programmer CLI </td></tr> +<tr> +<td>OPTFLAGS </td><td>-Os </td><td>Code optimization flags </td></tr> +</table> +<h3>Useful Resources</h3> +<ol type="1"> +<li><a href="https://www.usb.org/">USB Implementers Forum official site</a></li> +<li><a href="http://www.usbmadesimple.co.uk/">USB Made Simple</a></li> +<li><a href="https://github.com/abcminiuser/lufa">LUFA - the Lightweight USB Framework for AVRs.</a></li> +<li><a href="https://github.com/libopencm3/libopencm3">Open Source ARM cortex m microcontroller library</a> </li> +</ol> +</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 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |