| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 |
- <!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: 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="../../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('d7/d46/a00002.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">readme.md</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> ### Lightweight USB Device Stack ###</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> + Lightweight and fast</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> + Event-driven process workflow</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> + Completely separated USB hardware driver and usb core</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> + Easy to use.</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> ### Requirements ###</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> + [CMSIS V4](https://github.com/ARM-software/CMSIS) or [CMSIS V5](https://github.com/ARM-software/CMSIS_5).</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> + [stm32.h](https://github.com/dmitrystu/stm32h) STM32 universal header</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> All requirements can be downloaded into a directory specified in environment variable `CMSIS` using</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> `make cmsis` command.</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> ### Supported hardware ###</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <table></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <tr><th>MCU Series</th><th>Features</th><th>Driver</th><th>File</th></tr></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <tr></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <td rowspan="2">STM32L0x2 STM32L0x3 STM32F070 STM32F0x2 STM32F0x8</td></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <td nowrap rowspan="2">Doublebuffered<sup>[2]</sup><br />8<sup>[1]</sup> endpoints<br /> BC1.2</td></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <td>usbd_devfs</td></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <td>usbd_stm32l052_devfs.c</td></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </tr></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <tr></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <td>usbd_devfs_asm</td></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <td>usbd_stm32l052_devfs_asm.S</td></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </tr></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <tr></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <td rowspan="2">STM32L4x2 STM32L4x3 STM32G4 series</td></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <td nowrap rowspan="2">Doublebuffered<sup>[2]</sup><br />8<sup>[1]</sup> endpoints<br /> BC1.2</td></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <td>usbd_devfs</td></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <td>usbd_stm32l433_devfs.c</td></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </tr></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <tr></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <td>usbd_devfs_asm</td></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <td>usbd_stm32l052_devfs_asm.S</td></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </tr></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <tr></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <td rowspan="2">STM32L1xx</td></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <td nowrap rowspan="2">Doublebuffered<sup>[2]</sup><br />8<sup>[1]</sup> endpoints</td></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <td>usbd_devfs</td></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <td>usbd_stm32l100_devfs.c</td></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </tr></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <tr></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <td>usbd_devfs_asm</td></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <td>usbd_stm32l100_devfs_asm.S</td></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </tr></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <tr></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <td rowspan="2">STM32F102 STM32F103 STM32F302 STM32F303 STM32F373</td></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <td nowrap rowspan="2">Doublebuffered<sup>[2]</sup><br />External DP pullup<br />8<sup>[1]</sup> endpoints</td></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <td>usbd_devfs</td></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <td>usbd_stm32f103_devfs.c</td></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </tr></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <tr></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <td>usbd_devfs_asm</td></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <td>usbd_stm32f103_devfs_asm.S</td></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </tr></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <tr></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <td>STM32L4x5 STM32L4x6</td></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <td nowrap>Doublebuffered<br />6 endpoints<br /> BC1.2<br />VBUS detection</td></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <td>usbd_otgfs</td></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <td>usbd_stm32l476_otgfs.c</td></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </tr></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <tr></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <td rowspan="2">STM32F4x5 STM32F4x7 STM32F4x9</td></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <td nowrap>Doublebuffered<br/>4 endpoints<br/>VBUS detection<br/>SOF output</td></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <td>usbd_otgfs</td></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <td>usbd_stm32f429_otgfs.c</td></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </tr></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <tr></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <td nowrap>Doublebuffered<br/>6 endpoints<br/>VBUS detection<br/>SOF output</td></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <td>usbd_otghs</td></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <td>usbd_stm32f429_otghs.c</td></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </tr></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <tr></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <td>STM32F105 STM32F107</td></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <td nowrap>Doublebuffered<br/>4 endpoints<br/>VBUS detection<br/>SOF output</td></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <td>usbd_otgfs</td></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <td>usbd_stm32f105_otgfs.c</td></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </tr></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </table></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> 1. Single physical endpoint can be used to implement</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  + one bi-directional/single-buffer logical endpoint (CONTROL)</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  + one uni-directional/double-buffer logical endpoint (BULK OR ISOCHRONOUS)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  + two uni-directional/single-buffer logical endpoints (BULK OR INTERRUPT)</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> 2. At this moment BULK IN endpoint can use both buffers, but it is not **real** doublebuffered.</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> 3. Tested with STM32L052K8, STM32L100RC, STM32L476RG, STM32F072C8, STM32F103C8, STM32F103CB, STM32F303CC, STM32F303RE, STM32F429ZI, STM32F105RBT6, STM32F107VCT6, STM32L433CCT6, STM32F070CBT6, STM32G431RB,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> STM32F411CEUx</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> ### Implemented definitions for classes ###</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> 1. USB HID based on [Device Class Definition for Human Interface Devices (HID) Version 1.11](https://www.usb.org/sites/default/files/documents/hid1_11.pdf)</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> 2. USB DFU based on [USB Device Firmware Upgrade Specification, Revision 1.1](https://www.usb.org/sites/default/files/DFU_1.1.pdf)</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> 3. USB CDC based on [Class definitions for Communication Devices 1.2](https://www.usb.org/sites/default/files/CDC1.2_WMC1.1_012011.zip)</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> 4. USB TMC based on [USB Device Test and Measurement Class Specification, Revision 1.0](https://www.usb.org/sites/default/files/USBTMC_1_006a.zip)</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> ### Using makefile ###</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> + to build library module</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> ```</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> make module MODULE=path/module.a DEFINES="mcu spcified defines" CFLAGS="cpu cpecified compiler flags"</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> ```</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> + to build demo</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> ```</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> make bluepill program</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> make stm32l052x8</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> ```</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> + to get a help</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> ```</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> make help</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> ```</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> ### Default values: ###</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> | Variable | Default Value | Means |</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> |----------|-------------------------------------|-------------------------------|</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> | CMSIS | ./CMSIS | path to CMSIS root folder |</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> | CMSISDEV | $(CMSIS)/Device | path to CMSIS device folder |</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> | CMSISCORE| $(CMSIS)/CMSIS/Include $(CMSIS)/CMSIS/Core/Include | path to CMSIS core headers |</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> | MCU | stm32l100xc | MCU selection for demo project|</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> | CFLAGS | -mcpu=cortex-m3 -mfloat-abi=soft | MCU specified compiler flags |</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> | DEFINES | STM32L1 STM32L100xC | MCU specified defines |</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> | STPROG_CLI | ~/STMicroelectronics/STM32Cube/STM32CubeProgrammer/bin/STM32_Programmer_CLI | Path to the ST Cube Programmer CLI |</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> | OPTFLAGS | -Os | Code optimization flags |</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> ### Useful Resources ###</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> 1. [USB Implementers Forum official site](https://www.usb.org/)</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> 2. [USB Made Simple](http://www.usbmadesimple.co.uk/)</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> 3. [LUFA - the Lightweight USB Framework for AVRs.](https://github.com/abcminiuser/lufa)</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> 4. [Open Source ARM cortex m microcontroller library](https://github.com/libopencm3/libopencm3)</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 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>
|
