]> begriffs open source - cmsis/blob - main/Driver/html/group__gpio__interface__gr.html
Update documentation for branch main
[cmsis] / main / Driver / html / group__gpio__interface__gr.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: GPIO Interface</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, "CMSIS-Driver");
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('group__gpio__interface__gr.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="#groups">Content</a> &#124;
132 <a href="#nested-classes">Data Structures</a> &#124;
133 <a href="#typedef-members">Typedefs</a> &#124;
134 <a href="#enum-members">Enumerations</a> &#124;
135 <a href="#func-members">Functions</a>  </div>
136   <div class="headertitle"><div class="title">GPIO Interface</div></div>
137 </div><!--header-->
138 <div class="contents">
139
140 <p>Driver API for GPIO Interface (Driver_GPIO.h)  
141 <a href="#details">More...</a></p>
142 <table class="memberdecls">
143 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
144 Content</h2></td></tr>
145 <tr class="memitem:group__gpio__execution__status"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__execution__status.html">Status Error Codes</a></td></tr>
146 <tr class="memdesc:group__gpio__execution__status"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negative values indicate errors (GPIO has specific codes in addition to common <a class="el" href="group__execution__status.html">Status Error Codes</a>). <br /></td></tr>
147 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:group__GPIO__events"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__GPIO__events.html">GPIO Events</a></td></tr>
149 <tr class="memdesc:group__GPIO__events"><td class="mdescLeft">&#160;</td><td class="mdescRight">The GPIO driver generates call back events that are notified via the function <a class="el" href="group__gpio__interface__gr.html#ga85dd1634405efb2eae2d3775ecdc6081">ARM_GPIO_SignalEvent</a>. <br /></td></tr>
150 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 </table><table class="memberdecls">
152 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
153 Data Structures</h2></td></tr>
154 <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>
155 <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>
156 <tr class="separator:structARM__DRIVER__GPIO"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 </table><table class="memberdecls">
158 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
159 Typedefs</h2></td></tr>
160 <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>
161 <tr class="separator:gaf08560b02fd3c47a474eb9be26631640"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 </table><table class="memberdecls">
163 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
164 Enumerations</h2></td></tr>
165 <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 />
166 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18">ARM_GPIO_INPUT</a>
167 , <br />
168 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06">ARM_GPIO_OUTPUT</a>
169 <br />
170  }</td></tr>
171 <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>
172 <tr class="separator:gadb33882caa9dc3a481d19ab16573dd4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <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 />
174 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480bac4b9f2ea6c849cf47d9ed2cf7ccf7a93">ARM_GPIO_PUSH_PULL</a>
175 , <br />
176 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f">ARM_GPIO_OPEN_DRAIN</a>
177 <br />
178  }</td></tr>
179 <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>
180 <tr class="separator:ga1fc02461f93fabddb49fd46513c7480b"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 <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 />
182 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913a187a7bb55ed81726845c8c194f28d49c">ARM_GPIO_PULL_NONE</a>
183 , <br />
184 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188">ARM_GPIO_PULL_UP</a>
185 , <br />
186 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913a4fc8779c762a502dd029b7a676cc022b">ARM_GPIO_PULL_DOWN</a>
187 <br />
188  }</td></tr>
189 <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>
190 <tr class="separator:ga3e46add7954c3c9ba9617d630565c913"><td class="memSeparator" colspan="2">&#160;</td></tr>
191 <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 />
192 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cda93171249f006c83b7661df73d976556d">ARM_GPIO_TRIGGER_NONE</a>
193 , <br />
194 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cdaba20b1e31878cce514240db48ff72936">ARM_GPIO_TRIGGER_RISING_EDGE</a>
195 , <br />
196 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cdafa65dc9f0e518b4d640e69e194ffd847">ARM_GPIO_TRIGGER_FALLING_EDGE</a>
197 , <br />
198 &#160;&#160;<a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873">ARM_GPIO_TRIGGER_EITHER_EDGE</a>
199 <br />
200  }</td></tr>
201 <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>
202 <tr class="separator:ga0df966ec6b2ebedd7880a3efc75976cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
203 </table><table class="memberdecls">
204 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
205 Functions</h2></td></tr>
206 <tr class="memitem:ga10924781db8b42f1fc506bb83a6b7284"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga10924781db8b42f1fc506bb83a6b7284">ARM_GPIO_Setup</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#gaf08560b02fd3c47a474eb9be26631640">ARM_GPIO_SignalEvent_t</a> cb_event)</td></tr>
207 <tr class="memdesc:ga10924781db8b42f1fc506bb83a6b7284"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup GPIO Interface.  <br /></td></tr>
208 <tr class="separator:ga10924781db8b42f1fc506bb83a6b7284"><td class="memSeparator" colspan="2">&#160;</td></tr>
209 <tr class="memitem:ga518a307a98aec9d227db18819851363a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga518a307a98aec9d227db18819851363a">ARM_GPIO_SetDirection</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a> direction)</td></tr>
210 <tr class="memdesc:ga518a307a98aec9d227db18819851363a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set GPIO Direction.  <br /></td></tr>
211 <tr class="separator:ga518a307a98aec9d227db18819851363a"><td class="memSeparator" colspan="2">&#160;</td></tr>
212 <tr class="memitem:gab47e3266116c09442a3b3672a8224835"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#gab47e3266116c09442a3b3672a8224835">ARM_GPIO_SetOutputMode</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a> mode)</td></tr>
213 <tr class="memdesc:gab47e3266116c09442a3b3672a8224835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set GPIO Output Mode.  <br /></td></tr>
214 <tr class="separator:gab47e3266116c09442a3b3672a8224835"><td class="memSeparator" colspan="2">&#160;</td></tr>
215 <tr class="memitem:ga2c6ded4151e86ac0ee84d108fcfb661f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga2c6ded4151e86ac0ee84d108fcfb661f">ARM_GPIO_SetPullResistor</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a> resistor)</td></tr>
216 <tr class="memdesc:ga2c6ded4151e86ac0ee84d108fcfb661f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set GPIO Pull Resistor.  <br /></td></tr>
217 <tr class="separator:ga2c6ded4151e86ac0ee84d108fcfb661f"><td class="memSeparator" colspan="2">&#160;</td></tr>
218 <tr class="memitem:ga03c0ab613fa56b461be82777feea1a6d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga03c0ab613fa56b461be82777feea1a6d">ARM_GPIO_SetEventTrigger</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a> trigger)</td></tr>
219 <tr class="memdesc:ga03c0ab613fa56b461be82777feea1a6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set GPIO Event Trigger.  <br /></td></tr>
220 <tr class="separator:ga03c0ab613fa56b461be82777feea1a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
221 <tr class="memitem:gacdac385c2d5e420b95740749d3f428af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#gacdac385c2d5e420b95740749d3f428af">ARM_GPIO_SetOutput</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, uint32_t val)</td></tr>
222 <tr class="memdesc:gacdac385c2d5e420b95740749d3f428af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set GPIO Output Level.  <br /></td></tr>
223 <tr class="separator:gacdac385c2d5e420b95740749d3f428af"><td class="memSeparator" colspan="2">&#160;</td></tr>
224 <tr class="memitem:ga6259ec39507a5a59a47ef935bd83e41c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga6259ec39507a5a59a47ef935bd83e41c">ARM_GPIO_GetInput</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin)</td></tr>
225 <tr class="memdesc:ga6259ec39507a5a59a47ef935bd83e41c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get GPIO Input Level.  <br /></td></tr>
226 <tr class="separator:ga6259ec39507a5a59a47ef935bd83e41c"><td class="memSeparator" colspan="2">&#160;</td></tr>
227 <tr class="memitem:ga85dd1634405efb2eae2d3775ecdc6081"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ga85dd1634405efb2eae2d3775ecdc6081">ARM_GPIO_SignalEvent</a> (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, uint32_t event)</td></tr>
228 <tr class="memdesc:ga85dd1634405efb2eae2d3775ecdc6081"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal GPIO Events.  <br /></td></tr>
229 <tr class="separator:ga85dd1634405efb2eae2d3775ecdc6081"><td class="memSeparator" colspan="2">&#160;</td></tr>
230 </table>
231 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
232 <p>Driver API for GPIO Interface (Driver_GPIO.h) </p>
233 <p>The <b>General-purpose Input/Output Interface</b> (GPIO) features Input/Output operations on pin level (does not support simultaneous operations on multiple pins belonging to the same port).</p>
234 <p>Features:</p><ul>
235 <li>basic pin configuration (direction, output mode, pull-resistor, event trigger) excluding advanced settings (drive strength or speed, input filter, ...),</li>
236 <li>events on edge detection,</li>
237 <li>setting outputs,</li>
238 <li>reading inputs.</li>
239 </ul>
240 <p>Each function operates on a pin level and uses a pin identification as the first parameter. Pin identification is a virtual number which is mapped to an actual pin.</p>
241 <p><b>GPIO API</b></p>
242 <p>The following header files define the Application Programming Interface (API) for the GPIO interface:</p><ul>
243 <li><b>Driver_GPIO.h</b> : Driver API for GPIO Interface</li>
244 </ul>
245 <p>The driver implementation is a typical part of the Device Family Pack (DFP) that supports the peripherals of the microcontroller family.</p>
246 <p><b>Driver Functions</b></p>
247 <p>The driver functions are published in the access struct as explained in <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a></p><ul>
248 <li><a class="el" href="group__gpio__interface__gr.html#structARM__DRIVER__GPIO">ARM_DRIVER_GPIO</a> : access struct for GPIO driver functions</li>
249 </ul>
250 <p><b>Example Code</b></p>
251 <p>The following example code shows the usage of the GPIO interface.</p>
252 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="Driver__GPIO_8h.html">Driver_GPIO.h</a>&quot;</span></div>
253 <div class="line"> </div>
254 <div class="line"><span class="comment">/* GPIO driver instance */</span></div>
255 <div class="line"><span class="keyword">extern</span> <a class="code hl_struct" href="group__gpio__interface__gr.html#structARM__DRIVER__GPIO">ARM_DRIVER_GPIO</a>             Driver_GPIO0;</div>
256 <div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__gpio__interface__gr.html#structARM__DRIVER__GPIO">ARM_DRIVER_GPIO</a> *GPIOdrv = &amp;Driver_GPIO0;</div>
257 <div class="line"> </div>
258 <div class="line"><span class="comment">/* Pin mapping */</span></div>
259 <div class="line"><span class="preprocessor">#define GPIO_PIN0       0U</span></div>
260 <div class="line"><span class="preprocessor">#define GPIO_PIN1       1U</span></div>
261 <div class="line"><span class="preprocessor">#define GPIO_PIN2       2U</span></div>
262 <div class="line"><span class="preprocessor">#define GPIO_PIN3       3U</span></div>
263 <div class="line"> </div>
264 <div class="line"><span class="comment">/* GPIO Signal Event callback */</span></div>
265 <div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> GPIO_SignalEvent (<a class="code hl_typedef" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, uint32_t event) {</div>
266 <div class="line"> </div>
267 <div class="line">  <span class="keywordflow">switch</span> (pin) {</div>
268 <div class="line">    <span class="keywordflow">case</span> GPIO_PIN1:</div>
269 <div class="line">      <span class="comment">/* Events on pin GPIO_PIN1 */</span></div>
270 <div class="line">      <span class="keywordflow">if</span> (event &amp; <a class="code hl_define" href="group__GPIO__events.html#ga5b3eebcd265811423a9e3cfc86de7981">ARM_GPIO_EVENT_RISING_EDGE</a>) {</div>
271 <div class="line">        <span class="comment">/* Rising-edge detected */</span></div>
272 <div class="line">      }</div>
273 <div class="line">      <span class="keywordflow">if</span> (event &amp; <a class="code hl_define" href="group__GPIO__events.html#ga786063babcfbf55e38bb09e62e6b4e8e">ARM_GPIO_EVENT_FALLING_EDGE</a>) {</div>
274 <div class="line">        <span class="comment">/* Falling-edge detected */</span></div>
275 <div class="line">      }</div>
276 <div class="line">      <span class="keywordflow">break</span>;</div>
277 <div class="line">  }</div>
278 <div class="line">}</div>
279 <div class="line"> </div>
280 <div class="line"><span class="comment">/* Get GPIO Input 0 */</span></div>
281 <div class="line">uint32_t GPIO_GetInput0 (<span class="keywordtype">void</span>) {</div>
282 <div class="line">  <span class="keywordflow">return</span> (GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#abeffcbd4e00b34c08cd650605f4965d5">GetInput</a>(GPIO_PIN0));</div>
283 <div class="line">}</div>
284 <div class="line"> </div>
285 <div class="line"><span class="comment">/* Get GPIO Input 1 */</span></div>
286 <div class="line">uint32_t GPIO_GetInput1 (<span class="keywordtype">void</span>) {</div>
287 <div class="line">  <span class="keywordflow">return</span> (GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#abeffcbd4e00b34c08cd650605f4965d5">GetInput</a>(GPIO_PIN1));</div>
288 <div class="line">}</div>
289 <div class="line"> </div>
290 <div class="line"><span class="comment">/* Set GPIO Output Pin 2 */</span></div>
291 <div class="line"><span class="keywordtype">void</span> GPIO_SetOutput2 (uint32_t val) {</div>
292 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#ae3f787c2130ea5b9fd0246c08054e28a">SetOutput</a>(GPIO_PIN2, val);</div>
293 <div class="line">}</div>
294 <div class="line"> </div>
295 <div class="line"><span class="comment">/* Set GPIO Output Pin 3 */</span></div>
296 <div class="line"><span class="keywordtype">void</span> GPIO_SetOutput3 (uint32_t val) {</div>
297 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#ae3f787c2130ea5b9fd0246c08054e28a">SetOutput</a>(GPIO_PIN3, val);</div>
298 <div class="line">}</div>
299 <div class="line"> </div>
300 <div class="line"><span class="comment">/* Setup GPIO pins */</span></div>
301 <div class="line"><span class="keywordtype">void</span> GPIO_Setup (<span class="keywordtype">void</span>) {</div>
302 <div class="line"> </div>
303 <div class="line">  <span class="comment">/* Pin GPIO_PIN0: Input */</span></div>
304 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a1752c368ad90bf9d0f520de9b94b726c">Setup</a>          (GPIO_PIN0, NULL);</div>
305 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a357c46bfdc11484fd08daaf27255440f">SetDirection</a>   (GPIO_PIN0, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18">ARM_GPIO_INPUT</a>);</div>
306 <div class="line"> </div>
307 <div class="line">  <span class="comment">/* Pin GPIO_PIN1: Input with trigger on rising and falling edge */</span></div>
308 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a1752c368ad90bf9d0f520de9b94b726c">Setup</a>          (GPIO_PIN1, GPIO_SignalEvent);</div>
309 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a357c46bfdc11484fd08daaf27255440f">SetDirection</a>   (GPIO_PIN1, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18">ARM_GPIO_INPUT</a>);</div>
310 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#aa1e00b5d33fa1f09e96c7b8b1de1deec">SetEventTrigger</a>(GPIO_PIN1, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873">ARM_GPIO_TRIGGER_EITHER_EDGE</a>);</div>
311 <div class="line"> </div>
312 <div class="line">  <span class="comment">/* Pin GPIO_PIN2: Output push-pull (initial level 0) */</span></div>
313 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a1752c368ad90bf9d0f520de9b94b726c">Setup</a>          (GPIO_PIN2, NULL);</div>
314 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#ae3f787c2130ea5b9fd0246c08054e28a">SetOutput</a>      (GPIO_PIN2, 0U);</div>
315 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a357c46bfdc11484fd08daaf27255440f">SetDirection</a>   (GPIO_PIN2, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06">ARM_GPIO_OUTPUT</a>);</div>
316 <div class="line"> </div>
317 <div class="line">  <span class="comment">/* Pin GPIO_PIN3: Output open-drain with pull-up resistor (initial level 1) */</span></div>
318 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a1752c368ad90bf9d0f520de9b94b726c">Setup</a>          (GPIO_PIN3, NULL);</div>
319 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a26beab12383d7ec6036da59fc1bb7251">SetPullResistor</a>(GPIO_PIN3, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188">ARM_GPIO_PULL_UP</a>);</div>
320 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#af5b45e3d2a2399ad693437a4e26ff119">SetOutputMode</a>  (GPIO_PIN3, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f">ARM_GPIO_OPEN_DRAIN</a>);</div>
321 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#ae3f787c2130ea5b9fd0246c08054e28a">SetOutput</a>      (GPIO_PIN3, 1U);</div>
322 <div class="line">  GPIOdrv-&gt;<a class="code hl_variable" href="group__gpio__interface__gr.html#a357c46bfdc11484fd08daaf27255440f">SetDirection</a>   (GPIO_PIN3, <a class="code hl_enumvalue" href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06">ARM_GPIO_OUTPUT</a>);</div>
323 <div class="line">}</div>
324 <div class="ttc" id="aDriver__GPIO_8h_html"><div class="ttname"><a href="Driver__GPIO_8h.html">Driver_GPIO.h</a></div></div>
325 <div class="ttc" id="aDriver__GPIO_8h_html_aa610a72c0924a56973780d7d1d4e538a"><div class="ttname"><a href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a></div><div class="ttdeci">uint32_t ARM_GPIO_Pin_t</div><div class="ttdoc">GPIO Pin.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:38</div></div>
326 <div class="ttc" id="aDriver__GPIO_8h_html_ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873"><div class="ttname"><a href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873">ARM_GPIO_TRIGGER_EITHER_EDGE</a></div><div class="ttdeci">@ ARM_GPIO_TRIGGER_EITHER_EDGE</div><div class="ttdoc">Either edge (rising and falling)</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:72</div></div>
327 <div class="ttc" id="aDriver__GPIO_8h_html_ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f"><div class="ttname"><a href="Driver__GPIO_8h.html#ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f">ARM_GPIO_OPEN_DRAIN</a></div><div class="ttdeci">@ ARM_GPIO_OPEN_DRAIN</div><div class="ttdoc">Open-drain.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:53</div></div>
328 <div class="ttc" id="aDriver__GPIO_8h_html_ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188"><div class="ttname"><a href="Driver__GPIO_8h.html#ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188">ARM_GPIO_PULL_UP</a></div><div class="ttdeci">@ ARM_GPIO_PULL_UP</div><div class="ttdoc">Pull-up.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:61</div></div>
329 <div class="ttc" id="aDriver__GPIO_8h_html_gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18"><div class="ttname"><a href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18">ARM_GPIO_INPUT</a></div><div class="ttdeci">@ ARM_GPIO_INPUT</div><div class="ttdoc">Input (default)</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:44</div></div>
330 <div class="ttc" id="aDriver__GPIO_8h_html_gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06"><div class="ttname"><a href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06">ARM_GPIO_OUTPUT</a></div><div class="ttdeci">@ ARM_GPIO_OUTPUT</div><div class="ttdoc">Output.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:45</div></div>
331 <div class="ttc" id="agroup__GPIO__events_html_ga5b3eebcd265811423a9e3cfc86de7981"><div class="ttname"><a href="group__GPIO__events.html#ga5b3eebcd265811423a9e3cfc86de7981">ARM_GPIO_EVENT_RISING_EDGE</a></div><div class="ttdeci">#define ARM_GPIO_EVENT_RISING_EDGE</div><div class="ttdoc">Rising-edge detected.</div></div>
332 <div class="ttc" id="agroup__GPIO__events_html_ga786063babcfbf55e38bb09e62e6b4e8e"><div class="ttname"><a href="group__GPIO__events.html#ga786063babcfbf55e38bb09e62e6b4e8e">ARM_GPIO_EVENT_FALLING_EDGE</a></div><div class="ttdeci">#define ARM_GPIO_EVENT_FALLING_EDGE</div><div class="ttdoc">Falling-edge detected.</div></div>
333 <div class="ttc" id="agroup__gpio__interface__gr_html_a1752c368ad90bf9d0f520de9b94b726c"><div class="ttname"><a href="group__gpio__interface__gr.html#a1752c368ad90bf9d0f520de9b94b726c">ARM_DRIVER_GPIO::Setup</a></div><div class="ttdeci">int32_t(* Setup)(ARM_GPIO_Pin_t pin, ARM_GPIO_SignalEvent_t cb_event)</div><div class="ttdoc">Pointer to ARM_GPIO_Setup : Setup GPIO Interface.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:141</div></div>
334 <div class="ttc" id="agroup__gpio__interface__gr_html_a26beab12383d7ec6036da59fc1bb7251"><div class="ttname"><a href="group__gpio__interface__gr.html#a26beab12383d7ec6036da59fc1bb7251">ARM_DRIVER_GPIO::SetPullResistor</a></div><div class="ttdeci">int32_t(* SetPullResistor)(ARM_GPIO_Pin_t pin, ARM_GPIO_PULL_RESISTOR resistor)</div><div class="ttdoc">Pointer to ARM_GPIO_SetPullResistor : Set GPIO Pull Resistor.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:144</div></div>
335 <div class="ttc" id="agroup__gpio__interface__gr_html_a357c46bfdc11484fd08daaf27255440f"><div class="ttname"><a href="group__gpio__interface__gr.html#a357c46bfdc11484fd08daaf27255440f">ARM_DRIVER_GPIO::SetDirection</a></div><div class="ttdeci">int32_t(* SetDirection)(ARM_GPIO_Pin_t pin, ARM_GPIO_DIRECTION direction)</div><div class="ttdoc">Pointer to ARM_GPIO_SetDirection : Set GPIO Direction.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:142</div></div>
336 <div class="ttc" id="agroup__gpio__interface__gr_html_aa1e00b5d33fa1f09e96c7b8b1de1deec"><div class="ttname"><a href="group__gpio__interface__gr.html#aa1e00b5d33fa1f09e96c7b8b1de1deec">ARM_DRIVER_GPIO::SetEventTrigger</a></div><div class="ttdeci">int32_t(* SetEventTrigger)(ARM_GPIO_Pin_t pin, ARM_GPIO_EVENT_TRIGGER trigger)</div><div class="ttdoc">Pointer to ARM_GPIO_SetEventTrigger : Set GPIO Event Trigger.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:145</div></div>
337 <div class="ttc" id="agroup__gpio__interface__gr_html_abeffcbd4e00b34c08cd650605f4965d5"><div class="ttname"><a href="group__gpio__interface__gr.html#abeffcbd4e00b34c08cd650605f4965d5">ARM_DRIVER_GPIO::GetInput</a></div><div class="ttdeci">uint32_t(* GetInput)(ARM_GPIO_Pin_t pin)</div><div class="ttdoc">Pointer to ARM_GPIO_GetInput : Get GPIO Input Level.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:147</div></div>
338 <div class="ttc" id="agroup__gpio__interface__gr_html_ae3f787c2130ea5b9fd0246c08054e28a"><div class="ttname"><a href="group__gpio__interface__gr.html#ae3f787c2130ea5b9fd0246c08054e28a">ARM_DRIVER_GPIO::SetOutput</a></div><div class="ttdeci">void(* SetOutput)(ARM_GPIO_Pin_t pin, uint32_t val)</div><div class="ttdoc">Pointer to ARM_GPIO_SetOutput : Set GPIO Output Level.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:146</div></div>
339 <div class="ttc" id="agroup__gpio__interface__gr_html_af5b45e3d2a2399ad693437a4e26ff119"><div class="ttname"><a href="group__gpio__interface__gr.html#af5b45e3d2a2399ad693437a4e26ff119">ARM_DRIVER_GPIO::SetOutputMode</a></div><div class="ttdeci">int32_t(* SetOutputMode)(ARM_GPIO_Pin_t pin, ARM_GPIO_OUTPUT_MODE mode)</div><div class="ttdoc">Pointer to ARM_GPIO_SetOutputMode : Set GPIO Output Mode.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:143</div></div>
340 <div class="ttc" id="agroup__gpio__interface__gr_html_structARM__DRIVER__GPIO"><div class="ttname"><a href="group__gpio__interface__gr.html#structARM__DRIVER__GPIO">ARM_DRIVER_GPIO</a></div><div class="ttdoc">Access structure of the GPIO Driver.</div><div class="ttdef"><b>Definition:</b> Driver_GPIO.h:140</div></div>
341 </div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
342 <a name="structARM__DRIVER__GPIO" id="structARM__DRIVER__GPIO"></a>
343 <h2 class="memtitle"><span class="permalink"><a href="#structARM__DRIVER__GPIO">&#9670;&#160;</a></span>ARM_DRIVER_GPIO</h2>
344
345 <div class="memitem">
346 <div class="memproto">
347       <table class="memname">
348         <tr>
349           <td class="memname">struct ARM_DRIVER_GPIO</td>
350         </tr>
351       </table>
352 </div><div class="memdoc">
353 <div class="textblock"><p>Access structure of the GPIO Driver. </p>
354 <p>The functions of the GPIO driver are accessed by function pointers exposed by this structure. Refer to <a class="el" href="theoryOperation.html#DriverFunctions">Common Driver Functions</a> for overview information.</p>
355 <p>Each instance of a GPIO interface provides such an access structure. The instance is identified by a postfix number in the symbol name of the access structure, for example:</p><ul>
356 <li><b>Driver_GPIO0</b> is the name of the access struct of the first instance (no. 0).</li>
357 <li><b>Driver_GPIO1</b> is the name of the access struct of the second instance (no. 1).</li>
358 </ul>
359 <p>A middleware configuration setting allows connecting the middleware to a specific driver instance <b>Driver_GPIO<em>n</em></b>. The default is <span class="XML-Token">0</span>, which connects a middleware to the first instance of a driver. </p>
360 </div><table class="memberdecls">
361 <tr><td colspan="2"><h3>Data Fields</h3></td></tr>
362 <tr class="memitem:a1752c368ad90bf9d0f520de9b94b726c"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#a1752c368ad90bf9d0f520de9b94b726c">Setup</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#gaf08560b02fd3c47a474eb9be26631640">ARM_GPIO_SignalEvent_t</a> cb_event)</td></tr>
363 <tr class="memdesc:a1752c368ad90bf9d0f520de9b94b726c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#ga10924781db8b42f1fc506bb83a6b7284">ARM_GPIO_Setup</a> : Setup GPIO Interface.  <br /></td></tr>
364 <tr class="separator:a1752c368ad90bf9d0f520de9b94b726c"><td class="memSeparator" colspan="2">&#160;</td></tr>
365 <tr class="memitem:a357c46bfdc11484fd08daaf27255440f"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#a357c46bfdc11484fd08daaf27255440f">SetDirection</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a> direction)</td></tr>
366 <tr class="memdesc:a357c46bfdc11484fd08daaf27255440f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#ga518a307a98aec9d227db18819851363a">ARM_GPIO_SetDirection</a> : Set GPIO Direction.  <br /></td></tr>
367 <tr class="separator:a357c46bfdc11484fd08daaf27255440f"><td class="memSeparator" colspan="2">&#160;</td></tr>
368 <tr class="memitem:af5b45e3d2a2399ad693437a4e26ff119"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#af5b45e3d2a2399ad693437a4e26ff119">SetOutputMode</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a> mode)</td></tr>
369 <tr class="memdesc:af5b45e3d2a2399ad693437a4e26ff119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#gab47e3266116c09442a3b3672a8224835">ARM_GPIO_SetOutputMode</a> : Set GPIO Output Mode.  <br /></td></tr>
370 <tr class="separator:af5b45e3d2a2399ad693437a4e26ff119"><td class="memSeparator" colspan="2">&#160;</td></tr>
371 <tr class="memitem:a26beab12383d7ec6036da59fc1bb7251"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#a26beab12383d7ec6036da59fc1bb7251">SetPullResistor</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a> resistor)</td></tr>
372 <tr class="memdesc:a26beab12383d7ec6036da59fc1bb7251"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#ga2c6ded4151e86ac0ee84d108fcfb661f">ARM_GPIO_SetPullResistor</a> : Set GPIO Pull Resistor.  <br /></td></tr>
373 <tr class="separator:a26beab12383d7ec6036da59fc1bb7251"><td class="memSeparator" colspan="2">&#160;</td></tr>
374 <tr class="memitem:aa1e00b5d33fa1f09e96c7b8b1de1deec"><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#aa1e00b5d33fa1f09e96c7b8b1de1deec">SetEventTrigger</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a> trigger)</td></tr>
375 <tr class="memdesc:aa1e00b5d33fa1f09e96c7b8b1de1deec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#ga03c0ab613fa56b461be82777feea1a6d">ARM_GPIO_SetEventTrigger</a> : Set GPIO Event Trigger.  <br /></td></tr>
376 <tr class="separator:aa1e00b5d33fa1f09e96c7b8b1de1deec"><td class="memSeparator" colspan="2">&#160;</td></tr>
377 <tr class="memitem:ae3f787c2130ea5b9fd0246c08054e28a"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#ae3f787c2130ea5b9fd0246c08054e28a">SetOutput</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, uint32_t val)</td></tr>
378 <tr class="memdesc:ae3f787c2130ea5b9fd0246c08054e28a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#gacdac385c2d5e420b95740749d3f428af">ARM_GPIO_SetOutput</a> : Set GPIO Output Level.  <br /></td></tr>
379 <tr class="separator:ae3f787c2130ea5b9fd0246c08054e28a"><td class="memSeparator" colspan="2">&#160;</td></tr>
380 <tr class="memitem:abeffcbd4e00b34c08cd650605f4965d5"><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio__interface__gr.html#abeffcbd4e00b34c08cd650605f4965d5">GetInput</a> )(<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin)</td></tr>
381 <tr class="memdesc:abeffcbd4e00b34c08cd650605f4965d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to <a class="el" href="group__gpio__interface__gr.html#ga6259ec39507a5a59a47ef935bd83e41c">ARM_GPIO_GetInput</a> : Get GPIO Input Level.  <br /></td></tr>
382 <tr class="separator:abeffcbd4e00b34c08cd650605f4965d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
383 </table>
384 <h4 class="groupheader">Field Documentation</h4>
385 <a id="a1752c368ad90bf9d0f520de9b94b726c" name="a1752c368ad90bf9d0f520de9b94b726c"></a>
386 <h2 class="memtitle"><span class="permalink"><a href="#a1752c368ad90bf9d0f520de9b94b726c">&#9670;&#160;</a></span>Setup</h2>
387
388 <div class="memitem">
389 <div class="memproto">
390       <table class="memname">
391         <tr>
392           <td class="memname">int32_t(* Setup) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#gaf08560b02fd3c47a474eb9be26631640">ARM_GPIO_SignalEvent_t</a> cb_event)</td>
393         </tr>
394       </table>
395 </div><div class="memdoc">
396
397 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#ga10924781db8b42f1fc506bb83a6b7284">ARM_GPIO_Setup</a> : Setup GPIO Interface. </p>
398
399 </div>
400 </div>
401 <a id="a357c46bfdc11484fd08daaf27255440f" name="a357c46bfdc11484fd08daaf27255440f"></a>
402 <h2 class="memtitle"><span class="permalink"><a href="#a357c46bfdc11484fd08daaf27255440f">&#9670;&#160;</a></span>SetDirection</h2>
403
404 <div class="memitem">
405 <div class="memproto">
406       <table class="memname">
407         <tr>
408           <td class="memname">int32_t(* SetDirection) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a> direction)</td>
409         </tr>
410       </table>
411 </div><div class="memdoc">
412
413 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#ga518a307a98aec9d227db18819851363a">ARM_GPIO_SetDirection</a> : Set GPIO Direction. </p>
414
415 </div>
416 </div>
417 <a id="af5b45e3d2a2399ad693437a4e26ff119" name="af5b45e3d2a2399ad693437a4e26ff119"></a>
418 <h2 class="memtitle"><span class="permalink"><a href="#af5b45e3d2a2399ad693437a4e26ff119">&#9670;&#160;</a></span>SetOutputMode</h2>
419
420 <div class="memitem">
421 <div class="memproto">
422       <table class="memname">
423         <tr>
424           <td class="memname">int32_t(* SetOutputMode) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a> mode)</td>
425         </tr>
426       </table>
427 </div><div class="memdoc">
428
429 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#gab47e3266116c09442a3b3672a8224835">ARM_GPIO_SetOutputMode</a> : Set GPIO Output Mode. </p>
430
431 </div>
432 </div>
433 <a id="a26beab12383d7ec6036da59fc1bb7251" name="a26beab12383d7ec6036da59fc1bb7251"></a>
434 <h2 class="memtitle"><span class="permalink"><a href="#a26beab12383d7ec6036da59fc1bb7251">&#9670;&#160;</a></span>SetPullResistor</h2>
435
436 <div class="memitem">
437 <div class="memproto">
438       <table class="memname">
439         <tr>
440           <td class="memname">int32_t(* SetPullResistor) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a> resistor)</td>
441         </tr>
442       </table>
443 </div><div class="memdoc">
444
445 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#ga2c6ded4151e86ac0ee84d108fcfb661f">ARM_GPIO_SetPullResistor</a> : Set GPIO Pull Resistor. </p>
446
447 </div>
448 </div>
449 <a id="aa1e00b5d33fa1f09e96c7b8b1de1deec" name="aa1e00b5d33fa1f09e96c7b8b1de1deec"></a>
450 <h2 class="memtitle"><span class="permalink"><a href="#aa1e00b5d33fa1f09e96c7b8b1de1deec">&#9670;&#160;</a></span>SetEventTrigger</h2>
451
452 <div class="memitem">
453 <div class="memproto">
454       <table class="memname">
455         <tr>
456           <td class="memname">int32_t(* SetEventTrigger) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, <a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a> trigger)</td>
457         </tr>
458       </table>
459 </div><div class="memdoc">
460
461 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#ga03c0ab613fa56b461be82777feea1a6d">ARM_GPIO_SetEventTrigger</a> : Set GPIO Event Trigger. </p>
462
463 </div>
464 </div>
465 <a id="ae3f787c2130ea5b9fd0246c08054e28a" name="ae3f787c2130ea5b9fd0246c08054e28a"></a>
466 <h2 class="memtitle"><span class="permalink"><a href="#ae3f787c2130ea5b9fd0246c08054e28a">&#9670;&#160;</a></span>SetOutput</h2>
467
468 <div class="memitem">
469 <div class="memproto">
470       <table class="memname">
471         <tr>
472           <td class="memname">void(* SetOutput) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin, uint32_t val)</td>
473         </tr>
474       </table>
475 </div><div class="memdoc">
476
477 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#gacdac385c2d5e420b95740749d3f428af">ARM_GPIO_SetOutput</a> : Set GPIO Output Level. </p>
478
479 </div>
480 </div>
481 <a id="abeffcbd4e00b34c08cd650605f4965d5" name="abeffcbd4e00b34c08cd650605f4965d5"></a>
482 <h2 class="memtitle"><span class="permalink"><a href="#abeffcbd4e00b34c08cd650605f4965d5">&#9670;&#160;</a></span>GetInput</h2>
483
484 <div class="memitem">
485 <div class="memproto">
486       <table class="memname">
487         <tr>
488           <td class="memname">uint32_t(* GetInput) (<a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a> pin)</td>
489         </tr>
490       </table>
491 </div><div class="memdoc">
492
493 <p>Pointer to <a class="el" href="group__gpio__interface__gr.html#ga6259ec39507a5a59a47ef935bd83e41c">ARM_GPIO_GetInput</a> : Get GPIO Input Level. </p>
494
495 </div>
496 </div>
497
498 </div>
499 </div>
500 <h2 class="groupheader">Typedef Documentation</h2>
501 <a id="gaf08560b02fd3c47a474eb9be26631640" name="gaf08560b02fd3c47a474eb9be26631640"></a>
502 <h2 class="memtitle"><span class="permalink"><a href="#gaf08560b02fd3c47a474eb9be26631640">&#9670;&#160;</a></span>ARM_GPIO_SignalEvent_t</h2>
503
504 <div class="memitem">
505 <div class="memproto">
506       <table class="memname">
507         <tr>
508           <td class="memname">ARM_GPIO_SignalEvent_t</td>
509         </tr>
510       </table>
511 </div><div class="memdoc">
512 <p>Provides the typedef for the callback function <a class="el" href="group__gpio__interface__gr.html#ga85dd1634405efb2eae2d3775ecdc6081">ARM_GPIO_SignalEvent</a>.</p>
513 <p><b>Parameter for:</b></p><ul>
514 <li><a class="el" href="group__gpio__interface__gr.html#ga10924781db8b42f1fc506bb83a6b7284">ARM_GPIO_Setup</a> </li>
515 </ul>
516
517 </div>
518 </div>
519 <h2 class="groupheader">Enumeration Type Documentation</h2>
520 <a id="gadb33882caa9dc3a481d19ab16573dd4c" name="gadb33882caa9dc3a481d19ab16573dd4c"></a>
521 <h2 class="memtitle"><span class="permalink"><a href="#gadb33882caa9dc3a481d19ab16573dd4c">&#9670;&#160;</a></span>ARM_GPIO_DIRECTION</h2>
522
523 <div class="memitem">
524 <div class="memproto">
525       <table class="memname">
526         <tr>
527           <td class="memname">enum <a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a></td>
528         </tr>
529       </table>
530 </div><div class="memdoc">
531
532 <p>GPIO Direction. </p>
533 <p>Specifies values for setting the direction.</p>
534 <p><b>Parameter for:</b></p><ul>
535 <li><a class="el" href="group__gpio__interface__gr.html#ga518a307a98aec9d227db18819851363a">ARM_GPIO_SetDirection</a> </li>
536 </ul>
537 <table class="fieldtable">
538 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18" name="gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18"></a>ARM_GPIO_INPUT&#160;</td><td class="fielddoc"><p>Input (default) </p>
539 </td></tr>
540 <tr><td class="fieldname"><a id="gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06" name="gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06"></a>ARM_GPIO_OUTPUT&#160;</td><td class="fielddoc"><p>Output. </p>
541 </td></tr>
542 </table>
543
544 </div>
545 </div>
546 <a id="ga1fc02461f93fabddb49fd46513c7480b" name="ga1fc02461f93fabddb49fd46513c7480b"></a>
547 <h2 class="memtitle"><span class="permalink"><a href="#ga1fc02461f93fabddb49fd46513c7480b">&#9670;&#160;</a></span>ARM_GPIO_OUTPUT_MODE</h2>
548
549 <div class="memitem">
550 <div class="memproto">
551       <table class="memname">
552         <tr>
553           <td class="memname">enum <a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a></td>
554         </tr>
555       </table>
556 </div><div class="memdoc">
557
558 <p>GPIO Output Mode. </p>
559 <p>Specifies values for setting the output mode.</p>
560 <p><b>Parameter for:</b></p><ul>
561 <li><a class="el" href="group__gpio__interface__gr.html#gab47e3266116c09442a3b3672a8224835">ARM_GPIO_SetOutputMode</a> </li>
562 </ul>
563 <table class="fieldtable">
564 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga1fc02461f93fabddb49fd46513c7480bac4b9f2ea6c849cf47d9ed2cf7ccf7a93" name="ga1fc02461f93fabddb49fd46513c7480bac4b9f2ea6c849cf47d9ed2cf7ccf7a93"></a>ARM_GPIO_PUSH_PULL&#160;</td><td class="fielddoc"><p>Push-pull (default) </p>
565 </td></tr>
566 <tr><td class="fieldname"><a id="ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f" name="ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f"></a>ARM_GPIO_OPEN_DRAIN&#160;</td><td class="fielddoc"><p>Open-drain. </p>
567 </td></tr>
568 </table>
569
570 </div>
571 </div>
572 <a id="ga3e46add7954c3c9ba9617d630565c913" name="ga3e46add7954c3c9ba9617d630565c913"></a>
573 <h2 class="memtitle"><span class="permalink"><a href="#ga3e46add7954c3c9ba9617d630565c913">&#9670;&#160;</a></span>ARM_GPIO_PULL_RESISTOR</h2>
574
575 <div class="memitem">
576 <div class="memproto">
577       <table class="memname">
578         <tr>
579           <td class="memname">enum <a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a></td>
580         </tr>
581       </table>
582 </div><div class="memdoc">
583
584 <p>GPIO Pull Resistor. </p>
585 <p>Specifies values for setting the pull resistor.</p>
586 <p><b>Parameter for:</b></p><ul>
587 <li><a class="el" href="group__gpio__interface__gr.html#ga2c6ded4151e86ac0ee84d108fcfb661f">ARM_GPIO_SetPullResistor</a> </li>
588 </ul>
589 <table class="fieldtable">
590 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga3e46add7954c3c9ba9617d630565c913a187a7bb55ed81726845c8c194f28d49c" name="ga3e46add7954c3c9ba9617d630565c913a187a7bb55ed81726845c8c194f28d49c"></a>ARM_GPIO_PULL_NONE&#160;</td><td class="fielddoc"><p>None (default) </p>
591 </td></tr>
592 <tr><td class="fieldname"><a id="ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188" name="ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188"></a>ARM_GPIO_PULL_UP&#160;</td><td class="fielddoc"><p>Pull-up. </p>
593 </td></tr>
594 <tr><td class="fieldname"><a id="ga3e46add7954c3c9ba9617d630565c913a4fc8779c762a502dd029b7a676cc022b" name="ga3e46add7954c3c9ba9617d630565c913a4fc8779c762a502dd029b7a676cc022b"></a>ARM_GPIO_PULL_DOWN&#160;</td><td class="fielddoc"><p>Pull-down. </p>
595 </td></tr>
596 </table>
597
598 </div>
599 </div>
600 <a id="ga0df966ec6b2ebedd7880a3efc75976cd" name="ga0df966ec6b2ebedd7880a3efc75976cd"></a>
601 <h2 class="memtitle"><span class="permalink"><a href="#ga0df966ec6b2ebedd7880a3efc75976cd">&#9670;&#160;</a></span>ARM_GPIO_EVENT_TRIGGER</h2>
602
603 <div class="memitem">
604 <div class="memproto">
605       <table class="memname">
606         <tr>
607           <td class="memname">enum <a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a></td>
608         </tr>
609       </table>
610 </div><div class="memdoc">
611
612 <p>GPIO Event Trigger. </p>
613 <p>Specifies values for setting the event trigger.</p>
614 <p><b>Parameter for:</b></p><ul>
615 <li><a class="el" href="group__gpio__interface__gr.html#ga03c0ab613fa56b461be82777feea1a6d">ARM_GPIO_SetEventTrigger</a> </li>
616 </ul>
617 <table class="fieldtable">
618 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ga0df966ec6b2ebedd7880a3efc75976cda93171249f006c83b7661df73d976556d" name="ga0df966ec6b2ebedd7880a3efc75976cda93171249f006c83b7661df73d976556d"></a>ARM_GPIO_TRIGGER_NONE&#160;</td><td class="fielddoc"><p>None (default) </p>
619 </td></tr>
620 <tr><td class="fieldname"><a id="ga0df966ec6b2ebedd7880a3efc75976cdaba20b1e31878cce514240db48ff72936" name="ga0df966ec6b2ebedd7880a3efc75976cdaba20b1e31878cce514240db48ff72936"></a>ARM_GPIO_TRIGGER_RISING_EDGE&#160;</td><td class="fielddoc"><p>Rising-edge. </p>
621 </td></tr>
622 <tr><td class="fieldname"><a id="ga0df966ec6b2ebedd7880a3efc75976cdafa65dc9f0e518b4d640e69e194ffd847" name="ga0df966ec6b2ebedd7880a3efc75976cdafa65dc9f0e518b4d640e69e194ffd847"></a>ARM_GPIO_TRIGGER_FALLING_EDGE&#160;</td><td class="fielddoc"><p>Falling-edge. </p>
623 </td></tr>
624 <tr><td class="fieldname"><a id="ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873" name="ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873"></a>ARM_GPIO_TRIGGER_EITHER_EDGE&#160;</td><td class="fielddoc"><p>Either edge (rising and falling) </p>
625 </td></tr>
626 </table>
627
628 </div>
629 </div>
630 <h2 class="groupheader">Function Documentation</h2>
631 <a id="ga10924781db8b42f1fc506bb83a6b7284" name="ga10924781db8b42f1fc506bb83a6b7284"></a>
632 <h2 class="memtitle"><span class="permalink"><a href="#ga10924781db8b42f1fc506bb83a6b7284">&#9670;&#160;</a></span>ARM_GPIO_Setup()</h2>
633
634 <div class="memitem">
635 <div class="memproto">
636       <table class="memname">
637         <tr>
638           <td class="memname">int32_t ARM_GPIO_Setup </td>
639           <td>(</td>
640           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
641           <td class="paramname"><em>pin</em>, </td>
642         </tr>
643         <tr>
644           <td class="paramkey"></td>
645           <td></td>
646           <td class="paramtype"><a class="el" href="group__gpio__interface__gr.html#gaf08560b02fd3c47a474eb9be26631640">ARM_GPIO_SignalEvent_t</a>&#160;</td>
647           <td class="paramname"><em>cb_event</em>&#160;</td>
648         </tr>
649         <tr>
650           <td></td>
651           <td>)</td>
652           <td></td><td></td>
653         </tr>
654       </table>
655 </div><div class="memdoc">
656
657 <p>Setup GPIO Interface. </p>
658 <dl class="params"><dt>Parameters</dt><dd>
659   <table class="params">
660     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
661     <tr><td class="paramdir">[in]</td><td class="paramname">cb_event</td><td>Pointer to <a class="el" href="group__gpio__interface__gr.html#ga85dd1634405efb2eae2d3775ecdc6081">ARM_GPIO_SignalEvent</a> </td></tr>
662   </table>
663   </dd>
664 </dl>
665 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
666 <p>The function <b>ARM_GPIO_Setup</b> sets-up the specified <em>pin</em> as GPIO with default configuration. Pin is configured as input without pull-resistor and without event trigger.</p>
667 <p>The parameter <em>cb_event</em> specifies a pointer to the <a class="el" href="group__gpio__interface__gr.html#ga85dd1634405efb2eae2d3775ecdc6081">ARM_GPIO_SignalEvent</a> callback function. Use a NULL pointer when no callback events are required. </p>
668
669 </div>
670 </div>
671 <a id="ga518a307a98aec9d227db18819851363a" name="ga518a307a98aec9d227db18819851363a"></a>
672 <h2 class="memtitle"><span class="permalink"><a href="#ga518a307a98aec9d227db18819851363a">&#9670;&#160;</a></span>ARM_GPIO_SetDirection()</h2>
673
674 <div class="memitem">
675 <div class="memproto">
676       <table class="memname">
677         <tr>
678           <td class="memname">int32_t ARM_GPIO_SetDirection </td>
679           <td>(</td>
680           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
681           <td class="paramname"><em>pin</em>, </td>
682         </tr>
683         <tr>
684           <td class="paramkey"></td>
685           <td></td>
686           <td class="paramtype"><a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a>&#160;</td>
687           <td class="paramname"><em>direction</em>&#160;</td>
688         </tr>
689         <tr>
690           <td></td>
691           <td>)</td>
692           <td></td><td></td>
693         </tr>
694       </table>
695 </div><div class="memdoc">
696
697 <p>Set GPIO Direction. </p>
698 <dl class="params"><dt>Parameters</dt><dd>
699   <table class="params">
700     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
701     <tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td><a class="el" href="group__gpio__interface__gr.html#gadb33882caa9dc3a481d19ab16573dd4c">ARM_GPIO_DIRECTION</a> </td></tr>
702   </table>
703   </dd>
704 </dl>
705 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
706 <p>The function <b>ARM_GPIO_SetDirection</b> configures the direction of the specified <em>pin</em>.</p>
707 <p>Direction is specified with parameter <em>direction:</em> </p><ul>
708 <li><a class="el" href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4ca58fb239e72a3f93e94f2efe71477bd18">ARM_GPIO_INPUT</a> : Input (default),</li>
709 <li><a class="el" href="Driver__GPIO_8h.html#gadb33882caa9dc3a481d19ab16573dd4cad4685767096d17e5acb6abf6c6495d06">ARM_GPIO_OUTPUT</a> : Output. </li>
710 </ul>
711
712 </div>
713 </div>
714 <a id="gab47e3266116c09442a3b3672a8224835" name="gab47e3266116c09442a3b3672a8224835"></a>
715 <h2 class="memtitle"><span class="permalink"><a href="#gab47e3266116c09442a3b3672a8224835">&#9670;&#160;</a></span>ARM_GPIO_SetOutputMode()</h2>
716
717 <div class="memitem">
718 <div class="memproto">
719       <table class="memname">
720         <tr>
721           <td class="memname">int32_t ARM_GPIO_SetOutputMode </td>
722           <td>(</td>
723           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
724           <td class="paramname"><em>pin</em>, </td>
725         </tr>
726         <tr>
727           <td class="paramkey"></td>
728           <td></td>
729           <td class="paramtype"><a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a>&#160;</td>
730           <td class="paramname"><em>mode</em>&#160;</td>
731         </tr>
732         <tr>
733           <td></td>
734           <td>)</td>
735           <td></td><td></td>
736         </tr>
737       </table>
738 </div><div class="memdoc">
739
740 <p>Set GPIO Output Mode. </p>
741 <dl class="params"><dt>Parameters</dt><dd>
742   <table class="params">
743     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
744     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td><a class="el" href="group__gpio__interface__gr.html#ga1fc02461f93fabddb49fd46513c7480b">ARM_GPIO_OUTPUT_MODE</a> </td></tr>
745   </table>
746   </dd>
747 </dl>
748 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
749 <p>The function <b>ARM_GPIO_SetOutputMode</b> configures the output mode of the specified <em>pin</em>.</p>
750 <p>Output mode is specified with parameter <em>mode:</em> </p><ul>
751 <li><a class="el" href="Driver__GPIO_8h.html#ga1fc02461f93fabddb49fd46513c7480bac4b9f2ea6c849cf47d9ed2cf7ccf7a93">ARM_GPIO_PUSH_PULL</a> : Push-pull (default),</li>
752 <li><a class="el" href="Driver__GPIO_8h.html#ga1fc02461f93fabddb49fd46513c7480ba0a24a2221d2d9a31dff9a81e3b7e888f">ARM_GPIO_OPEN_DRAIN</a> : Open-drain.</li>
753 </ul>
754 <dl class="section note"><dt>Note</dt><dd>Output mode is relevant only when the pin is configured as output. </dd></dl>
755
756 </div>
757 </div>
758 <a id="ga2c6ded4151e86ac0ee84d108fcfb661f" name="ga2c6ded4151e86ac0ee84d108fcfb661f"></a>
759 <h2 class="memtitle"><span class="permalink"><a href="#ga2c6ded4151e86ac0ee84d108fcfb661f">&#9670;&#160;</a></span>ARM_GPIO_SetPullResistor()</h2>
760
761 <div class="memitem">
762 <div class="memproto">
763       <table class="memname">
764         <tr>
765           <td class="memname">int32_t ARM_GPIO_SetPullResistor </td>
766           <td>(</td>
767           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
768           <td class="paramname"><em>pin</em>, </td>
769         </tr>
770         <tr>
771           <td class="paramkey"></td>
772           <td></td>
773           <td class="paramtype"><a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a>&#160;</td>
774           <td class="paramname"><em>resistor</em>&#160;</td>
775         </tr>
776         <tr>
777           <td></td>
778           <td>)</td>
779           <td></td><td></td>
780         </tr>
781       </table>
782 </div><div class="memdoc">
783
784 <p>Set GPIO Pull Resistor. </p>
785 <dl class="params"><dt>Parameters</dt><dd>
786   <table class="params">
787     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
788     <tr><td class="paramdir">[in]</td><td class="paramname">resistor</td><td><a class="el" href="group__gpio__interface__gr.html#ga3e46add7954c3c9ba9617d630565c913">ARM_GPIO_PULL_RESISTOR</a> </td></tr>
789   </table>
790   </dd>
791 </dl>
792 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
793 <p>The function <b>ARM_GPIO_SetPullResistor</b> configures the pull resistor of the specified <em>pin</em>.</p>
794 <p>Pull resistor is specified with parameter <em>resistor:</em> </p><ul>
795 <li><a class="el" href="Driver__GPIO_8h.html#ga3e46add7954c3c9ba9617d630565c913a187a7bb55ed81726845c8c194f28d49c">ARM_GPIO_PULL_NONE</a> : None (default),</li>
796 <li><a class="el" href="Driver__GPIO_8h.html#ga3e46add7954c3c9ba9617d630565c913a73c7ba703ce0cd40f77392bb28a4a188">ARM_GPIO_PULL_UP</a> : Pull-up,</li>
797 <li><a class="el" href="Driver__GPIO_8h.html#ga3e46add7954c3c9ba9617d630565c913a4fc8779c762a502dd029b7a676cc022b">ARM_GPIO_PULL_DOWN</a> : Pull-down.</li>
798 </ul>
799 <dl class="section note"><dt>Note</dt><dd>Pull resistor applies to the pin regardless of pin direction. </dd></dl>
800
801 </div>
802 </div>
803 <a id="ga03c0ab613fa56b461be82777feea1a6d" name="ga03c0ab613fa56b461be82777feea1a6d"></a>
804 <h2 class="memtitle"><span class="permalink"><a href="#ga03c0ab613fa56b461be82777feea1a6d">&#9670;&#160;</a></span>ARM_GPIO_SetEventTrigger()</h2>
805
806 <div class="memitem">
807 <div class="memproto">
808       <table class="memname">
809         <tr>
810           <td class="memname">int32_t ARM_GPIO_SetEventTrigger </td>
811           <td>(</td>
812           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
813           <td class="paramname"><em>pin</em>, </td>
814         </tr>
815         <tr>
816           <td class="paramkey"></td>
817           <td></td>
818           <td class="paramtype"><a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a>&#160;</td>
819           <td class="paramname"><em>trigger</em>&#160;</td>
820         </tr>
821         <tr>
822           <td></td>
823           <td>)</td>
824           <td></td><td></td>
825         </tr>
826       </table>
827 </div><div class="memdoc">
828
829 <p>Set GPIO Event Trigger. </p>
830 <dl class="params"><dt>Parameters</dt><dd>
831   <table class="params">
832     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
833     <tr><td class="paramdir">[in]</td><td class="paramname">trigger</td><td><a class="el" href="group__gpio__interface__gr.html#ga0df966ec6b2ebedd7880a3efc75976cd">ARM_GPIO_EVENT_TRIGGER</a> </td></tr>
834   </table>
835   </dd>
836 </dl>
837 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__execution__status.html">Status Error Codes</a></dd></dl>
838 <p>The function <b>ARM_GPIO_SetEventTrigger</b> configures the event trigger of the specified <em>pin</em>.</p>
839 <p>Event trigger is specified with parameter <em>trigger:</em> </p><ul>
840 <li><a class="el" href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cda93171249f006c83b7661df73d976556d">ARM_GPIO_TRIGGER_NONE</a> : None (default),</li>
841 <li><a class="el" href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cdaba20b1e31878cce514240db48ff72936">ARM_GPIO_TRIGGER_RISING_EDGE</a> : Rising-edge,</li>
842 <li><a class="el" href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cdafa65dc9f0e518b4d640e69e194ffd847">ARM_GPIO_TRIGGER_FALLING_EDGE</a> : Falling-edge,</li>
843 <li><a class="el" href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873">ARM_GPIO_TRIGGER_EITHER_EDGE</a> : Either edge (rising and falling). </li>
844 </ul>
845
846 </div>
847 </div>
848 <a id="gacdac385c2d5e420b95740749d3f428af" name="gacdac385c2d5e420b95740749d3f428af"></a>
849 <h2 class="memtitle"><span class="permalink"><a href="#gacdac385c2d5e420b95740749d3f428af">&#9670;&#160;</a></span>ARM_GPIO_SetOutput()</h2>
850
851 <div class="memitem">
852 <div class="memproto">
853       <table class="memname">
854         <tr>
855           <td class="memname">void ARM_GPIO_SetOutput </td>
856           <td>(</td>
857           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
858           <td class="paramname"><em>pin</em>, </td>
859         </tr>
860         <tr>
861           <td class="paramkey"></td>
862           <td></td>
863           <td class="paramtype">uint32_t&#160;</td>
864           <td class="paramname"><em>val</em>&#160;</td>
865         </tr>
866         <tr>
867           <td></td>
868           <td>)</td>
869           <td></td><td></td>
870         </tr>
871       </table>
872 </div><div class="memdoc">
873
874 <p>Set GPIO Output Level. </p>
875 <dl class="params"><dt>Parameters</dt><dd>
876   <table class="params">
877     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
878     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>GPIO Pin Level (0 or 1)</td></tr>
879   </table>
880   </dd>
881 </dl>
882 <p>The function <b>ARM_GPIO_SetOutput</b> sets the level of the specified <em>pin</em> defined as output to the value specified by <em>val</em>.</p>
883 <dl class="section note"><dt>Note</dt><dd>When a pin is configured as input, the level is latched and will be driven once the pin is configured as output. </dd></dl>
884
885 </div>
886 </div>
887 <a id="ga6259ec39507a5a59a47ef935bd83e41c" name="ga6259ec39507a5a59a47ef935bd83e41c"></a>
888 <h2 class="memtitle"><span class="permalink"><a href="#ga6259ec39507a5a59a47ef935bd83e41c">&#9670;&#160;</a></span>ARM_GPIO_GetInput()</h2>
889
890 <div class="memitem">
891 <div class="memproto">
892       <table class="memname">
893         <tr>
894           <td class="memname">uint32_t ARM_GPIO_GetInput </td>
895           <td>(</td>
896           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
897           <td class="paramname"><em>pin</em></td><td>)</td>
898           <td></td>
899         </tr>
900       </table>
901 </div><div class="memdoc">
902
903 <p>Get GPIO Input Level. </p>
904 <dl class="params"><dt>Parameters</dt><dd>
905   <table class="params">
906     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin </td></tr>
907   </table>
908   </dd>
909 </dl>
910 <dl class="section return"><dt>Returns</dt><dd>GPIO Pin Level (0 or 1)</dd></dl>
911 <p>The function <b>ARM_GPIO_GetInput</b> reads the level of the specified <em>pin</em>. </p>
912
913 </div>
914 </div>
915 <a id="ga85dd1634405efb2eae2d3775ecdc6081" name="ga85dd1634405efb2eae2d3775ecdc6081"></a>
916 <h2 class="memtitle"><span class="permalink"><a href="#ga85dd1634405efb2eae2d3775ecdc6081">&#9670;&#160;</a></span>ARM_GPIO_SignalEvent()</h2>
917
918 <div class="memitem">
919 <div class="memproto">
920       <table class="memname">
921         <tr>
922           <td class="memname">void ARM_GPIO_SignalEvent </td>
923           <td>(</td>
924           <td class="paramtype"><a class="el" href="Driver__GPIO_8h.html#aa610a72c0924a56973780d7d1d4e538a">ARM_GPIO_Pin_t</a>&#160;</td>
925           <td class="paramname"><em>pin</em>, </td>
926         </tr>
927         <tr>
928           <td class="paramkey"></td>
929           <td></td>
930           <td class="paramtype">uint32_t&#160;</td>
931           <td class="paramname"><em>event</em>&#160;</td>
932         </tr>
933         <tr>
934           <td></td>
935           <td>)</td>
936           <td></td><td></td>
937         </tr>
938       </table>
939 </div><div class="memdoc">
940
941 <p>Signal GPIO Events. </p>
942 <dl class="params"><dt>Parameters</dt><dd>
943   <table class="params">
944     <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO Pin on which event occurred </td></tr>
945     <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td><a class="el" href="group__GPIO__events.html">GPIO Events</a> notification mask</td></tr>
946   </table>
947   </dd>
948 </dl>
949 <p>The function <b>ARM_GPIO_SignalEvent</b> is a callback functions registered by the function <a class="el" href="group__gpio__interface__gr.html#ga10924781db8b42f1fc506bb83a6b7284">ARM_GPIO_Setup</a>. It is called by the GPIO driver to notify the application about <a class="el" href="group__GPIO__events.html">GPIO Events</a> occurred during operation.</p>
950 <p>The parameter <em>pin</em> indicates on which pin the event occurred and parameter <em>event</em> indicates one or more events that occurred.</p>
951 <p>The following events can be generated:</p>
952 <table class="cmtable">
953 <tr>
954 <th>Parameter <em>event</em> </th><th>Bit </th><th>Description   </th></tr>
955 <tr>
956 <td><a class="el" href="group__GPIO__events.html#ga5b3eebcd265811423a9e3cfc86de7981">ARM_GPIO_EVENT_RISING_EDGE</a> </td><td>0 </td><td>Occurs when rising-edge is detected on the indicated pin.   </td></tr>
957 <tr>
958 <td><a class="el" href="group__GPIO__events.html#ga786063babcfbf55e38bb09e62e6b4e8e">ARM_GPIO_EVENT_FALLING_EDGE</a> </td><td>1 </td><td>Occurs when falling-edge is detected on the indicated pin.   </td></tr>
959 <tr>
960 <td><a class="el" href="group__GPIO__events.html#gac2d649951a265a3508b16b0775cd2647">ARM_GPIO_EVENT_EITHER_EDGE</a> </td><td>2 </td><td>Occurs when either edge is detected on the indicated pin when trigger is configured as <a class="el" href="Driver__GPIO_8h.html#ga0df966ec6b2ebedd7880a3efc75976cdaf08214415e90ef3b65e3438b1b523873">ARM_GPIO_TRIGGER_EITHER_EDGE</a> and hardware is not able to distinguish between rising and falling edge.   </td></tr>
961 </table>
962
963 </div>
964 </div>
965 </div><!-- contents -->
966 </div><!-- doc-content -->
967 <!-- start footer part -->
968 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
969   <ul>
970     <li class="footer">
971       <script type="text/javascript">
972         <!--
973         writeFooter.call(this);
974         //-->
975       </script> 
976     </li>
977   </ul>
978 </div>
979 </body>
980 </html>