]> begriffs open source - cmsis-driver-validation/blob - docs/html/resource_requirements.html
Update documentation hosted on github
[cmsis-driver-validation] / docs / html / resource_requirements.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>Resource Requirements</title>
7 <title>CMSIS-Driver Validation: Resource Requirements</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="drv.css" rel="stylesheet" type="text/css" />
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="printComponentTabs.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 <link href="stylsheetf" rel="stylesheet" type="text/css" />
26 </head>
27 <body>
28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <div id="titlearea">
30 <table cellspacing="0" cellpadding="0">
31  <tbody>
32  <tr style="height: 46px;">
33   <td id="projectlogo"><img alt="Logo" src="keilarm.png"/></td>
34   <td style="padding-left: 0.5em;">
35    <div id="projectname">CMSIS-Driver Validation
36    &#160;<span id="projectnumber">Version 2.0.0</span>
37    </div>
38    <div id="projectbrief">Driver Validation</div>
39   </td>
40  </tr>
41  </tbody>
42 </table>
43 </div>
44 <!-- end header part -->
45 <div id="DRVnav" class="tabs1">
46     <ul class="tablist">
47       <script type="text/javascript">
48                 <!--
49                 writeComponentTabs.call(this);
50                 //-->
51       </script>
52           </ul>
53 </div>
54 <!-- Generated by Doxygen 1.8.6 -->
55 <script type="text/javascript">
56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
57 </script>
58   <div id="navrow1" class="tabs">
59     <ul class="tablist">
60       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
61       <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
62       <li><a href="modules.html"><span>Reference</span></a></li>
63       <li>
64         <div id="MSearchBox" class="MSearchBoxInactive">
65         <span class="left">
66           <img id="MSearchSelect" src="search/mag_sel.png"
67                onmouseover="return searchBox.OnSearchSelectShow()"
68                onmouseout="return searchBox.OnSearchSelectHide()"
69                alt=""/>
70           <input type="text" id="MSearchField" value="Search" accesskey="S"
71                onfocus="searchBox.OnSearchFieldFocus(true)" 
72                onblur="searchBox.OnSearchFieldFocus(false)" 
73                onkeyup="searchBox.OnSearchFieldChange(event)"/>
74           </span><span class="right">
75             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
76           </span>
77         </div>
78       </li>
79     </ul>
80   </div>
81 </div><!-- top -->
82 <div id="side-nav" class="ui-resizable side-nav-resizable">
83   <div id="nav-tree">
84     <div id="nav-tree-contents">
85       <div id="nav-sync" class="sync"></div>
86     </div>
87   </div>
88   <div id="splitbar" style="-moz-user-select:none;" 
89        class="ui-resizable-handle">
90   </div>
91 </div>
92 <script type="text/javascript">
93 $(document).ready(function(){initNavTree('resource_requirements.html','');});
94 </script>
95 <div id="doc-content">
96 <!-- window showing the filter options -->
97 <div id="MSearchSelectWindow"
98      onmouseover="return searchBox.OnSearchSelectShow()"
99      onmouseout="return searchBox.OnSearchSelectHide()"
100      onkeydown="return searchBox.OnSearchSelectKey(event)">
101 <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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
102
103 <!-- iframe showing the search results (closed by default) -->
104 <div id="MSearchResultsWindow">
105 <iframe src="javascript:void(0)" frameborder="0" 
106         name="MSearchResults" id="MSearchResults">
107 </iframe>
108 </div>
109
110 <div class="header">
111   <div class="headertitle">
112 <div class="title">Resource Requirements </div>  </div>
113 </div><!--header-->
114 <div class="contents">
115 <div class="textblock"><h1><a class="anchor" id="heap_req"></a>
116 Heap Memory</h1>
117 <p>Heap memory is used by the memory allocation functions.<br/>
118  It is usually configured in the <a href="http://www.keil.com/support/man/docs/gsac/gsac_startupcodecortex.htm" class="el" target="_blank">startup_device.s</a> file located under the <b>Device</b> component class but it can also, in some cases, be configured by a <b>linker script</b> instead.</p>
119 <p>Some interface test functions allocate additional buffers from the heap memory.</p>
120 <p>The CMSIS-Driver Validation framework does not impose heap requirements because it does not use heap memory.</p>
121 <p>Each interface test module has specific requirements for the heap memory, default requirements are listed below:</p>
122 <table class="doxtable">
123 <tr>
124 <th align="center">Interface test module </th><th align="center">Heap memory requirement (in bytes)  </th></tr>
125 <tr>
126 <td align="center">CAN </td><td align="center">128 </td></tr>
127 <tr>
128 <td align="center">Ethernet </td><td align="center">1024 </td></tr>
129 <tr>
130 <td align="center">SPI </td><td align="center">12288 </td></tr>
131 <tr>
132 <td align="center">USART </td><td align="center">2048 </td></tr>
133 </table>
134 <p>Interface test modules that are not listed in the previous table do not use heap memory.</p>
135 <p>The system heap memory size must support the largest heap requirement of any used interface test module.<br/>
136  For example, if SPI driver testing is selected heap memory size should be set to at least 12 kB.</p>
137 <p>Suggested value for heap memory size is <b>16384</b> bytes.</p>
138 <dl class="section note"><dt>Note</dt><dd>Each module contains additional settings in related configuration file which are not exposed through Configuration Wizard and impact the heap memory requirement.<br/>
139  If these values are changed please adjust heap memory size accordingly.</dd></dl>
140 <h1><a class="anchor" id="rtos2_req"></a>
141 CMSIS-RTOS2</h1>
142 <p>The thread requirements need to be reflected in the CMSIS-RTOS2 configuration. Refer to the <a href="http://www.keil.com/pack/doc/cmsis/RTOS2/html/index.html" class="el" target="_blank">CMSIS-RTOS2 Reference</a> for further details.</p>
143 <p>For <a href="http://www.keil.com/pack/doc/cmsis/RTOS2/html/rtx5_impl.html" class="el" target="_blank">CMSIS-RTOS2 RTX5</a>, thread requirements are configured in the <a href="http://www.keil.com/pack/doc/cmsis/RTOS2/html/config_rtx5.html" class="el" target="_blank">RTX_Config.h</a> file located under the <b>CMSIS</b> component class:</p>
144 <table class="doxtable">
145 <tr>
146 <th align="left">Option </th><th align="center">Value  </th></tr>
147 <tr>
148 <td align="left">System Configuration: Global Dynamic Memory size [bytes] (Note 1) </td><td align="center">16384 </td></tr>
149 <tr>
150 <td align="left">Thread Configuration: Default Thread Stack size [bytes] </td><td align="center">3072 </td></tr>
151 </table>
152 <dl class="section note"><dt>Note</dt><dd>Note 1: This setting is only necessary for WiFi driver testing, for other driver testing value of 4096 bytes is sufficient. </dd></dl>
153 </div></div><!-- contents -->
154 </div><!-- doc-content -->
155 <!-- start footer part -->
156 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
157   <ul>
158     <li class="footer">Generated on Wed Jul 15 2020 10:47:10 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
159         <!--
160     <a href="http://www.doxygen.org/index.html">
161     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
162         -->
163         </li>
164   </ul>
165 </div>
166 </body>
167 </html>