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