-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation for branch main
- Loading branch information
github-actions
committed
Mar 6, 2024
1 parent
30e602b
commit 32d868f
Showing
47 changed files
with
1,529 additions
and
671 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| function writeHeader() { | ||
| document.write('Version 3.0.1-dev20'); | ||
| document.write('Version 3.0.1-dev21'); | ||
| }; | ||
|
|
||
| function writeFooter() { | ||
| document.write('Generated on Wed Jun 28 2023 11:00:20 for CMSIS-Driver Validation 3.0.1-dev20+g9d3b808. Copyright © 2022-2023 Arm Limited (or its affiliates). All rights reserved.'); | ||
| document.write('Generated on Wed Mar 6 2024 10:47:08 for CMSIS-Driver Validation 3.0.1-dev21+g41e49a1. Copyright © 2022-2024 Arm Limited (or its affiliates). All rights reserved.'); | ||
| }; |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| <!-- HTML header for doxygen 1.9.2--> | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>CMSIS-Driver Validation: GPIO Validation</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> | ||
| <script type="text/javascript" src="footer.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> | ||
| <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> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(document).ready(function() { init_search(); }); | ||
| /* @license-end */ | ||
| </script> | ||
| <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/> | ||
| <link href="version.css" rel="stylesheet" type="text/css" /> | ||
| <script type="text/javascript" src="../version.js"></script> | ||
| </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: 55px;"> | ||
| <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td> | ||
| <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;"> | ||
| <div id="projectname">CMSIS-Driver Validation | ||
|  <span id="projectnumber"><script type="text/javascript"> | ||
| <!-- | ||
| writeHeader.call(this); | ||
| writeVersionDropdown(this); | ||
| //--> | ||
| </script> | ||
| </span> | ||
| </div> | ||
| <div id="projectbrief">Driver Validation</div> | ||
| </td> | ||
| <!--END !PROJECT_NAME--> | ||
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> | ||
| <span class="left"> | ||
| <img id="MSearchSelect" src="search/mag_sel.svg" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| alt=""/> | ||
| <input type="text" id="MSearchField" value="Search" accesskey="S" | ||
| onfocus="searchBox.OnSearchFieldFocus(true)" | ||
| onblur="searchBox.OnSearchFieldFocus(false)" | ||
| onkeyup="searchBox.OnSearchFieldChange(event)"/> | ||
| </span><span class="right"> | ||
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> | ||
| </span> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.2 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search",'Search','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| </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"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(document).ready(function(){initNavTree('group__dv__gpio.html',''); initResizable(); }); | ||
| /* @license-end */ | ||
| </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="summary"> | ||
| <a href="#groups">Content</a> </div> | ||
| <div class="headertitle"><div class="title">GPIO Validation</div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
|
|
||
| <p>GPIO driver validation. | ||
| <a href="#details">More...</a></p> | ||
| <table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a> | ||
| Content</h2></td></tr> | ||
| <tr class="memitem:group__gpio__config"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__config.html">Configuration</a></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:group__gpio__tests"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__tests.html">Tests</a></td></tr> | ||
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table> | ||
| <a name="details" id="details"></a><h2 class="groupheader">Description</h2> | ||
| <p >The GPIO validation performs the following tests:</p><ul> | ||
| <li>API interface compliance</li> | ||
| <li>Functions operation</li> | ||
| <li>Event signaling</li> | ||
| </ul> | ||
| <p >To perform GPIO validation tests, it is required to select and configure two pins in the <b>DV_GPIO_Config.h</b> configuration file:</p><ul> | ||
| <li>Pin Under Test: pin to be tested</li> | ||
| <li>Auxiliary Pin: pin with serial low resistance resistor connected to Pin Under Test (suggested resistance of this resistor is around 1 kOhm)</li> | ||
| </ul> | ||
| <div class="image"> | ||
| <img src="gpio_loopback.png" alt=""/> | ||
| </div> | ||
| <dl class="section note"><dt>Note</dt><dd><ul> | ||
| <li>Pins (Pin Under Test and Auxiliary Pin) should not have any external resistors or any external devices connected to it except the low resistance resistor used for testing. </li> | ||
| </ul> | ||
| </dd></dl> | ||
| </div><!-- contents --> | ||
| </div><!-- doc-content --> | ||
| <!-- start footer part --> | ||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| <ul> | ||
| <li class="footer"> | ||
| <script type="text/javascript"> | ||
| <!-- | ||
| writeFooter.call(this); | ||
| //--> | ||
| </script> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| var group__dv__gpio = | ||
| [ | ||
| [ "Configuration", "group__gpio__config.html", null ], | ||
| [ "Tests", "group__gpio__tests.html", "group__gpio__tests" ] | ||
| ]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <!-- HTML header for doxygen 1.9.2--> | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>CMSIS-Driver Validation: Configuration</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> | ||
| <script type="text/javascript" src="footer.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> | ||
| <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> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(document).ready(function() { init_search(); }); | ||
| /* @license-end */ | ||
| </script> | ||
| <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/> | ||
| <link href="version.css" rel="stylesheet" type="text/css" /> | ||
| <script type="text/javascript" src="../version.js"></script> | ||
| </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: 55px;"> | ||
| <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td> | ||
| <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;"> | ||
| <div id="projectname">CMSIS-Driver Validation | ||
|  <span id="projectnumber"><script type="text/javascript"> | ||
| <!-- | ||
| writeHeader.call(this); | ||
| writeVersionDropdown(this); | ||
| //--> | ||
| </script> | ||
| </span> | ||
| </div> | ||
| <div id="projectbrief">Driver Validation</div> | ||
| </td> | ||
| <!--END !PROJECT_NAME--> | ||
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> | ||
| <span class="left"> | ||
| <img id="MSearchSelect" src="search/mag_sel.svg" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| alt=""/> | ||
| <input type="text" id="MSearchField" value="Search" accesskey="S" | ||
| onfocus="searchBox.OnSearchFieldFocus(true)" | ||
| onblur="searchBox.OnSearchFieldFocus(false)" | ||
| onkeyup="searchBox.OnSearchFieldChange(event)"/> | ||
| </span><span class="right"> | ||
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> | ||
| </span> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.2 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search",'Search','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| </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"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(document).ready(function(){initNavTree('group__gpio__config.html',''); initResizable(); }); | ||
| /* @license-end */ | ||
| </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">Configuration<div class="ingroups"><a class="el" href="group__dv__gpio.html">GPIO Validation</a></div></div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| <p >The GPIO driver validation settings are available in the <b>DV_GPIO_Config.h</b> configuration file.</p> | ||
| <div class="image"> | ||
| <img src="dv_gpio_config_h.png" alt=""/> | ||
| <div class="caption"> | ||
| DV_GPIO_Config.h configuration file in Configuration Wizard view mode</div></div> | ||
| <h1><a class="anchor" id="gpio_config_detail"></a> | ||
| Configuration settings</h1> | ||
| <p ><b>Driver_GPIO#</b> selects the driver instance that will be tested.<br /> | ||
| For example if we want to test <code>Driver_GPIO0</code> then this setting would be set to <code>0</code>.</p> | ||
| <p ><b>Configuration</b> section contains configuration of two pins:</p><ul> | ||
| <li><b>Pin Under Test</b> specifying the pin that will be tested.<br /> | ||
| </li> | ||
| <li><b>Auxiliary Pin</b> specifies the auxiliary pin with serial low resistance resistor connected to Pin Under Test. Suggested resistance of this serial resistor is around 1 kOhm.<br /> | ||
| </li> | ||
| </ul> | ||
| <p ><b>Pins</b> should not have any external resistors or any external devices connected to it except the low resistance resistor used for testing.<br /> | ||
| </p> | ||
| <p ><b>Tests</b> section contains selections of tests to be executed. For details on tests performed by each test function please refer to <a class="el" href="group__gpio__tests.html">GPIO Tests</a>. </p> | ||
| </div><!-- contents --> | ||
| </div><!-- doc-content --> | ||
| <!-- start footer part --> | ||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| <ul> | ||
| <li class="footer"> | ||
| <script type="text/javascript"> | ||
| <!-- | ||
| writeFooter.call(this); | ||
| //--> | ||
| </script> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.