]> begriffs open source - cmsis/blob - dev/v6.0.0-dev53/Driver/html/Driver__GPIO_8h.html
Update documentation for release dev/v6.0.0-dev53
[cmsis] / dev / v6.0.0-dev53 / Driver / html / Driver__GPIO_8h.html
1 <!-- HTML header for doxygen 1.9.6-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-Driver: Driver_GPIO.h File Reference</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="jquery.js"></script>
15 <script type="text/javascript" src="dynsections.js"></script>
16 <script type="text/javascript" src="printComponentTabs.js"></script>
17 <script type="text/javascript" src="footer.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="resize.js"></script>
21 <script type="text/javascript" src="navtreedata.js"></script>
22 <script type="text/javascript" src="navtree.js"></script>
23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
24 <script type="text/javascript" src="search/searchdata.js"></script>
25 <script type="text/javascript" src="search/search.js"></script>
26 <script type="text/javascript">
27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
28   $(document).ready(function() { init_search(); });
29 /* @license-end */
30 </script>
31 <script type="text/javascript" src="darkmode_toggle.js"></script>
32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
35 <link href="version.css" rel="stylesheet" type="text/css" />
36 <script type="text/javascript" src="../../../version.js"></script>
37 </head>
38 <body>
39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
40 <div id="titlearea">
41 <table cellspacing="0" cellpadding="0">
42  <tbody>
43  <tr style="height: 55px;">
44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
46    <div id="projectname">CMSIS-Driver
47    &#160;<span id="projectnumber"><script type="text/javascript">
48      <!--
49      writeHeader.call(this);
50      writeVersionDropdown.call(this);
51      //-->
52     </script>
53    </span>
54    </div>
55    <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
56   </td>
57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
58         <span class="left">
59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
61                onfocus="searchBox.OnSearchFieldFocus(true)" 
62                onblur="searchBox.OnSearchFieldFocus(false)" 
63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
64           </span><span class="right">
65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
66           </span>
67         </div>
68 </td>
69   <!--END !PROJECT_NAME-->
70  </tr>
71  </tbody>
72 </table>
73 </div>
74 <!-- end header part -->
75 <div id="CMSISnav" class="tabs1">
76   <ul class="tablist">
77     <script type="text/javascript">
78       writeComponentTabs.call(this);
79     </script>
80   </ul>
81 </div>
82 <script type="text/javascript">
83   writeSubComponentTabs.call(this);
84 </script>
85 <!-- Generated by Doxygen 1.9.6 -->
86 <script type="text/javascript">
87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
88 var searchBox = new SearchBox("searchBox", "search/",'.html');
89 /* @license-end */
90 </script>
91 </div><!-- top -->
92 <div id="side-nav" class="ui-resizable side-nav-resizable">
93   <div id="nav-tree">
94     <div id="nav-tree-contents">
95       <div id="nav-sync" class="sync"></div>
96     </div>
97   </div>
98   <div id="splitbar" style="-moz-user-select:none;" 
99        class="ui-resizable-handle">
100   </div>
101 </div>
102 <script type="text/javascript">
103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
104 $(document).ready(function(){initNavTree('Driver__GPIO_8h.html',''); initResizable(); });
105 /* @license-end */
106 </script>
107 <div id="doc-content">
108 <!-- window showing the filter options -->
109 <div id="MSearchSelectWindow"
110      onmouseover="return searchBox.OnSearchSelectShow()"
111      onmouseout="return searchBox.OnSearchSelectHide()"
112      onkeydown="return searchBox.OnSearchSelectKey(event)">
113 </div>
114
115 <!-- iframe showing the search results (closed by default) -->
116 <div id="MSearchResultsWindow">
117 <div id="MSearchResults">
118 <div class="SRPage">
119 <div id="SRIndex">
120 <div id="SRResults"></div>
121 <div class="SRStatus" id="Loading">Loading...</div>
122 <div class="SRStatus" id="Searching">Searching...</div>
123 <div class="SRStatus" id="NoMatches">No Matches</div>
124 </div>
125 </div>
126 </div>
127 </div>
128
129 <div class="header">
130   <div class="summary">
131 <a href="#nested-classes">Data Structures</a> &#124;
132 <a href="#define-members">Macros</a> &#124;
133 <a href="#typedef-members">Typedefs</a> &#124;
134 <a href="#enum-members">Enumerations</a>  </div>
135   <div class="headertitle"><div class="title">Driver_GPIO.h File Reference</div></div>
136 </div><!--header-->
137 <div class="contents">
138 <table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
140 Data Structures</h2></td></tr>
141 <tr class="memitem:structARM__DRIVER__GPIO"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#structARM__DRIVER__GPIO">ARM_DRIVER_GPIO</a></td></tr>
142 <tr class="memdesc:structARM__DRIVER__GPIO"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access structure of the GPIO Driver.  <a href="group__gpio__interface__gr.html#structARM__DRIVER__GPIO">More...</a><br /></td></tr>
143 <tr class="separator:structARM__DRIVER__GPIO"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 </table><table class="memberdecls">
145 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
146 Macros</h2></td></tr>
147 <tr class="memitem:ga5b3eebcd265811423a9e3cfc86de7981"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__GPIO__events.html#ga5b3eebcd265811423a9e3cfc86de7981">ARM_GPIO_EVENT_RISING_EDGE</a>&#160;&#160;&#160;(1UL &lt;&lt; 0)</td></tr>
148 <tr class="memdesc:ga5b3eebcd265811423a9e3cfc86de7981"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rising-edge detected.  <br /></td></tr>
149 <tr class="separator:ga5b3eebcd265811423a9e3cfc86de7981"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:ga786063babcfbf55e38bb09e62e6b4e8e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__GPIO__events.html#ga786063babcfbf55e38bb09e62e6b4e8e">ARM_GPIO_EVENT_FALLING_EDGE</a>&#160;&#160;&#160;(1UL &lt;&lt; 1)</td></tr>
151 <tr class="memdesc:ga786063babcfbf55e38bb09e62e6b4e8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Falling-edge detected.  <br /></td></tr>
152 <tr class="separator:ga786063babcfbf55e38bb09e62e6b4e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:gac2d649951a265a3508b16b0775cd2647"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__GPIO__events.html#gac2d649951a265a3508b16b0775cd2647">ARM_GPIO_EVENT_EITHER_EDGE</a>&#160;&#160;&#160;(1UL &lt;&lt; 2)</td></tr>
154 <tr class="memdesc:gac2d649951a265a3508b16b0775cd2647"><td class="mdescLeft">&#160;</td><td class="mdescRight">Either edge detected (only when hardware cannot distinguish between rising and falling edge)  <br /></td></tr>
155 <tr class="separator:gac2d649951a265a3508b16b0775cd2647"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:ga173c97677f23796c490b128ba7fff3d7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__execution__status.html#ga173c97677f23796c490b128ba7fff3d7">ARM_GPIO_ERROR_PIN</a>&#160;&#160;&#160;(<a class="el" href="group__execution__status.html#ga5a2b5d68f6649598d099b88c0eaee3e5">ARM_DRIVER_ERROR_SPECIFIC</a> - 1)</td></tr>
157 <tr class="memdesc:ga173c97677f23796c490b128ba7fff3d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified Pin not available.  <br /></td></tr>
158 <tr class="separator:ga173c97677f23796c490b128ba7fff3d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 </table><table class="memberdecls">
160 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
161 Typedefs</h2></td></tr>
162 <tr class="memitem:aa610a72c0924a56973780d7d1d4e538a"><td class="memItemLeft" align="right" valign="top">typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a></td></tr>
163 <tr class="memdesc:aa610a72c0924a56973780d7d1d4e538a"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPIO Pin.  <br /></td></tr>
164 <tr class="separator:aa610a72c0924a56973780d7d1d4e538a"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:gaf08560b02fd3c47a474eb9be26631640"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#gaf08560b02fd3c47a474eb9be26631640">ARM_GPIO_SignalEvent_t</a>) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, uint32_t event)</td></tr>
166 <tr class="separator:gaf08560b02fd3c47a474eb9be26631640"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 </table><table class="memberdecls">
168 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
169 Enumerations</h2></td></tr>
170 <tr class="memitem:gadb33882caa9dc3a481d19ab16573dd4c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a> { <br />
171 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18">ARM_GPIO_INPUT</a>
172 , <br />
173 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06">ARM_GPIO_OUTPUT</a>
174 <br />
175  }</td></tr>
176 <tr class="memdesc:gadb33882caa9dc3a481d19ab16573dd4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPIO Direction.  <a href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">More...</a><br /></td></tr>
177 <tr class="separator:gadb33882caa9dc3a481d19ab16573dd4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 <tr class="memitem:ga1fc02461f93fabddb49fd46513c7480b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a> { <br />
179 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480bac4b9f2ea6c849cf47d9ed2cf7ccf7a93">ARM_GPIO_PUSH_PULL</a>
180 , <br />
181 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f">ARM_GPIO_OPEN_DRAIN</a>
182 <br />
183  }</td></tr>
184 <tr class="memdesc:ga1fc02461f93fabddb49fd46513c7480b"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPIO Output Mode.  <a href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">More...</a><br /></td></tr>
185 <tr class="separator:ga1fc02461f93fabddb49fd46513c7480b"><td class="memSeparator" colspan="2">&#160;</td></tr>
186 <tr class="memitem:ga3e46add7954c3c9ba9617d630565c913"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a> { <br />
187 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913a187a7bb55ed81726845c8c194f28d49c">ARM_GPIO_PULL_NONE</a>
188 , <br />
189 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188">ARM_GPIO_PULL_UP</a>
190 , <br />
191 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913a4fc8779c762a502dd029b7a676cc022b">ARM_GPIO_PULL_DOWN</a>
192 <br />
193  }</td></tr>
194 <tr class="memdesc:ga3e46add7954c3c9ba9617d630565c913"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPIO Pull Resistor.  <a href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">More...</a><br /></td></tr>
195 <tr class="separator:ga3e46add7954c3c9ba9617d630565c913"><td class="memSeparator" colspan="2">&#160;</td></tr>
196 <tr class="memitem:ga0df966ec6b2ebedd7880a3efc75976cd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a> { <br />
197 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cda93171249f006c83b7661df73d976556d">ARM_GPIO_TRIGGER_NONE</a>
198 , <br />
199 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cdaba20b1e31878cce514240db48ff72936">ARM_GPIO_TRIGGER_RISING_EDGE</a>
200 , <br />
201 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cdafa65dc9f0e518b4d640e69e194ffd847">ARM_GPIO_TRIGGER_FALLING_EDGE</a>
202 , <br />
203 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873">ARM_GPIO_TRIGGER_EITHER_EDGE</a>
204 <br />
205  }</td></tr>
206 <tr class="memdesc:ga0df966ec6b2ebedd7880a3efc75976cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPIO Event Trigger.  <a href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">More...</a><br /></td></tr>
207 <tr class="separator:ga0df966ec6b2ebedd7880a3efc75976cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
208 </table>
209 <h2 class="groupheader">Typedef Documentation</h2>
210 <a id="aa610a72c0924a56973780d7d1d4e538a" name="aa610a72c0924a56973780d7d1d4e538a"></a>
211 <h2 class="memtitle"><span class="permalink"><a href="#aa610a72c0924a56973780d7d1d4e538a">&#9670;&#160;</a></span>ARM_GPIO_Pin_t</h2>
212
213 <div class="memitem">
214 <div class="memproto">
215       <table class="memname">
216         <tr>
217           <td class="memname">typedef uint32_t <a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a></td>
218         </tr>
219       </table>
220 </div><div class="memdoc">
221
222 <p>GPIO Pin. </p>
223
224 </div>
225 </div>
226 </div><!-- contents -->
227 </div><!-- doc-content -->
228 <!-- start footer part -->
229 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
230   <ul>
231     <li class="navelem"><a class="el" href="dir_7151b3cc910409bb744bd274374c738d.html">Driver</a></li><li class="navelem"><a class="el" href="dir_9c39448ea46a8e15f1aabc7dec307fcf.html">Include</a></li><li class="navelem"><a class="el" href="Driver__GPIO_8h.html">Driver_GPIO.h</a></li>
232     <li class="footer">
233       <script type="text/javascript">
234         <!--
235         writeFooter.call(this);
236         //-->
237       </script> 
238     </li>
239   </ul>
240 </div>
241 </body>
242 </html>