]> begriffs open source - cmsis-driver-validation/blob - docs/html/group__framework__funcs.html
Update documentation hosted on github
[cmsis-driver-validation] / docs / html / group__framework__funcs.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>Functions</title>
7 <title>CMSIS-Driver Validation: Functions</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 3.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><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('group__framework__funcs.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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><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="summary">
112 <a href="#func-members">Functions</a>  </div>
113   <div class="headertitle">
114 <div class="title">Functions<div class="ingroups"><a class="el" href="group__dv__framework.html">Framework</a></div></div>  </div>
115 </div><!--header-->
116 <div class="contents">
117 <table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
119 Functions</h2></td></tr>
120 <tr class="memitem:gab619c5d0a237afcf7ec113ff7b8c5ced"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__framework__funcs.html#gab619c5d0a237afcf7ec113ff7b8c5ced">closeDebug</a> (void)</td></tr>
121 <tr class="memdesc:gab619c5d0a237afcf7ec113ff7b8c5ced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the debug session.  <a href="#gab619c5d0a237afcf7ec113ff7b8c5ced">More...</a><br/></td></tr>
122 <tr class="separator:gab619c5d0a237afcf7ec113ff7b8c5ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <tr class="memitem:ga6e9dc1a6a5392afdf07478bd6b159287"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__framework__funcs.html#ga6e9dc1a6a5392afdf07478bd6b159287">cmsis_dv</a> (void *argument)</td></tr>
124 <tr class="memdesc:ga6e9dc1a6a5392afdf07478bd6b159287"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the entry point of the test framework.  <a href="#ga6e9dc1a6a5392afdf07478bd6b159287">More...</a><br/></td></tr>
125 <tr class="separator:ga6e9dc1a6a5392afdf07478bd6b159287"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 </table>
127 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
128 <h2 class="groupheader">Function Documentation</h2>
129 <a class="anchor" id="gab619c5d0a237afcf7ec113ff7b8c5ced"></a>
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname">void closeDebug </td>
135           <td>(</td>
136           <td class="paramtype">void&#160;</td>
137           <td class="paramname"></td><td>)</td>
138           <td></td>
139         </tr>
140       </table>
141 </div><div class="memdoc">
142 <p>Debug session dead end - debug script should close session here. This function is called by <a class="el" href="group__framework__funcs.html#ga6e9dc1a6a5392afdf07478bd6b159287">cmsis_dv</a>. </p>
143
144 </div>
145 </div>
146 <a class="anchor" id="ga6e9dc1a6a5392afdf07478bd6b159287"></a>
147 <div class="memitem">
148 <div class="memproto">
149       <table class="memname">
150         <tr>
151           <td class="memname">void cmsis_dv </td>
152           <td>(</td>
153           <td class="paramtype">void *&#160;</td>
154           <td class="paramname"><em>argument</em></td><td>)</td>
155           <td></td>
156         </tr>
157       </table>
158 </div><div class="memdoc">
159 <p>Program flow:</p>
160 <ol type="1">
161 <li>Test report is initialized</li>
162 <li>For each test group following steps are executed:<ol type="a">
163 <li>Test group initialization is called (custom test group initialization)</li>
164 <li>Test group header is written to standard output</li>
165 <li>All tests in a group are executed as follows:<ul>
166 <li>Test statistics are initialized</li>
167 <li>Test report header is written to the standard output</li>
168 <li>Test function is executed</li>
169 <li>Test results are written to the standard output</li>
170 <li>Test report footer is written to the standard output</li>
171 </ul>
172 </li>
173 <li>Test group footer is written to standard output</li>
174 <li>Test group uninitialization is called (custom test group uninitialization)</li>
175 </ol>
176 </li>
177 <li>Debug session ends when closeDebug function is reached </li>
178 </ol>
179
180 </div>
181 </div>
182 </div><!-- contents -->
183 </div><!-- doc-content -->
184 <!-- start footer part -->
185 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
186   <ul>
187     <li class="footer">Generated on Fri Jul 15 2022 08:42:09 for CMSIS-Driver Validation by ARM Ltd. All rights reserved.
188         <!--
189     <a href="http://www.doxygen.org/index.html">
190     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
191         -->
192         </li>
193   </ul>
194 </div>
195 </body>
196 </html>