group__digital_pin.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>SdFat: Fast Pin I/O</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#nested-classes">Classes</a> &#124;
  78. <a href="#define-members">Macros</a> &#124;
  79. <a href="#func-members">Functions</a> </div>
  80. <div class="headertitle">
  81. <div class="title">Fast Pin I/O</div> </div>
  82. </div><!--header-->
  83. <div class="contents">
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  86. Classes</h2></td></tr>
  87. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_digital_pin.html">DigitalPin&lt; PinNumber &gt;</a></td></tr>
  88. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast digital port I/O. <a href="class_digital_pin.html#details">More...</a><br /></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gpio_pin_map__t.html">GpioPinMap_t</a></td></tr>
  91. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  94. Macros</h2></td></tr>
  95. <tr class="memitem:gaeea7c59480c0a4e25aad3890545cef52"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#gaeea7c59480c0a4e25aad3890545cef52">fastPinConfig</a>(pin, mode, level)&#160;&#160;&#160;{<a class="el" href="group__digital_pin.html#ga5b9c17432f07f0eb39283c8b23665fe7">fastPinMode</a>(pin, mode); <a class="el" href="group__digital_pin.html#gac4f52b5038c366dd4ac081b18709f19c">fastDigitalWrite</a>(pin, level);}</td></tr>
  96. <tr class="separator:gaeea7c59480c0a4e25aad3890545cef52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:gacf92f370944e233db04f7423bde1c164"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#gacf92f370944e233db04f7423bde1c164">GPIO_PIN</a>(reg, bit)&#160;&#160;&#160;{&amp;PIN##reg, &amp;DDR##reg, &amp;PORT##reg, 1 &lt;&lt; bit}</td></tr>
  98. <tr class="separator:gacf92f370944e233db04f7423bde1c164"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  101. Functions</h2></td></tr>
  102. <tr class="memitem:ga107992311bca47c7ebee5afdedc280e0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga107992311bca47c7ebee5afdedc280e0">badPinCheck</a> (uint8_t pin)</td></tr>
  103. <tr class="separator:ga107992311bca47c7ebee5afdedc280e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ga2a50c39692fdc6a7be0f614f6d730bfe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga2a50c39692fdc6a7be0f614f6d730bfe">badPinNumber</a> (void)</td></tr>
  105. <tr class="separator:ga2a50c39692fdc6a7be0f614f6d730bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:gaa28ed1bee40bd072ba33554ac6d36ed8"><td class="memItemLeft" align="right" valign="top">static volatile uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#gaa28ed1bee40bd072ba33554ac6d36ed8">ddrReg</a> (uint8_t pin)</td></tr>
  107. <tr class="separator:gaa28ed1bee40bd072ba33554ac6d36ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:gaff40f792e0b2aefb3ef6f11f32bae3dd"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#gaff40f792e0b2aefb3ef6f11f32bae3dd">fastBitWriteSafe</a> (volatile uint8_t *address, uint8_t mask, bool level)</td></tr>
  109. <tr class="separator:gaff40f792e0b2aefb3ef6f11f32bae3dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:gada03ef0d2522fe5639f5239991993409"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#gada03ef0d2522fe5639f5239991993409">fastDdrWrite</a> (uint8_t pin, bool level)</td></tr>
  111. <tr class="separator:gada03ef0d2522fe5639f5239991993409"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ga618a9ee1c3d1b9fc5c8a2c6a43014b08"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga618a9ee1c3d1b9fc5c8a2c6a43014b08">fastDigitalRead</a> (uint8_t pin)</td></tr>
  113. <tr class="separator:ga618a9ee1c3d1b9fc5c8a2c6a43014b08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ga5314f1aaede89a4090b44779c8c551f1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga5314f1aaede89a4090b44779c8c551f1">fastDigitalToggle</a> (uint8_t pin)</td></tr>
  115. <tr class="separator:ga5314f1aaede89a4090b44779c8c551f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:gac4f52b5038c366dd4ac081b18709f19c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#gac4f52b5038c366dd4ac081b18709f19c">fastDigitalWrite</a> (uint8_t pin, bool level)</td></tr>
  117. <tr class="separator:gac4f52b5038c366dd4ac081b18709f19c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ga5b9c17432f07f0eb39283c8b23665fe7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga5b9c17432f07f0eb39283c8b23665fe7">fastPinMode</a> (uint8_t pin, uint8_t mode)</td></tr>
  119. <tr class="separator:ga5b9c17432f07f0eb39283c8b23665fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ga99fe9f7aeaaae3764a7b7c40d9d9837b"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga99fe9f7aeaaae3764a7b7c40d9d9837b">pinMask</a> (uint8_t pin)</td></tr>
  121. <tr class="separator:ga99fe9f7aeaaae3764a7b7c40d9d9837b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ga213b72ce9a61eddce1e85fa057e9e3b6"><td class="memItemLeft" align="right" valign="top">static volatile uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga213b72ce9a61eddce1e85fa057e9e3b6">pinReg</a> (uint8_t pin)</td></tr>
  123. <tr class="separator:ga213b72ce9a61eddce1e85fa057e9e3b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ga1e2ef44778ccf79ac2c02afe0633ef88"><td class="memItemLeft" align="right" valign="top">static volatile uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__digital_pin.html#ga1e2ef44778ccf79ac2c02afe0633ef88">portReg</a> (uint8_t pin)</td></tr>
  125. <tr class="separator:ga1e2ef44778ccf79ac2c02afe0633ef88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  128. <p>Fast Digital I/O functions and template class. </p>
  129. <h2 class="groupheader">Macro Definition Documentation</h2>
  130. <a class="anchor" id="gaeea7c59480c0a4e25aad3890545cef52"></a>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">#define fastPinConfig</td>
  136. <td>(</td>
  137. <td class="paramtype">&#160;</td>
  138. <td class="paramname">pin, </td>
  139. </tr>
  140. <tr>
  141. <td class="paramkey"></td>
  142. <td></td>
  143. <td class="paramtype">&#160;</td>
  144. <td class="paramname">mode, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype">&#160;</td>
  150. <td class="paramname">level&#160;</td>
  151. </tr>
  152. <tr>
  153. <td></td>
  154. <td>)</td>
  155. <td></td><td>&#160;&#160;&#160;{<a class="el" href="group__digital_pin.html#ga5b9c17432f07f0eb39283c8b23665fe7">fastPinMode</a>(pin, mode); <a class="el" href="group__digital_pin.html#gac4f52b5038c366dd4ac081b18709f19c">fastDigitalWrite</a>(pin, level);}</td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>set pin configuration </p><dl class="params"><dt>Parameters</dt><dd>
  160. <table class="params">
  161. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  162. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>mode INPUT or OUTPUT. </td></tr>
  163. <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>If mode is output, set level high/low. If mode is input, enable or disable the pin's 20K pullup. </td></tr>
  164. </table>
  165. </dd>
  166. </dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="gacf92f370944e233db04f7423bde1c164"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">#define GPIO_PIN</td>
  175. <td>(</td>
  176. <td class="paramtype">&#160;</td>
  177. <td class="paramname">reg, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">&#160;</td>
  183. <td class="paramname">bit&#160;</td>
  184. </tr>
  185. <tr>
  186. <td></td>
  187. <td>)</td>
  188. <td></td><td>&#160;&#160;&#160;{&amp;PIN##reg, &amp;DDR##reg, &amp;PORT##reg, 1 &lt;&lt; bit}</td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Initializer macro. </p>
  193. </div>
  194. </div>
  195. <h2 class="groupheader">Function Documentation</h2>
  196. <a class="anchor" id="ga107992311bca47c7ebee5afdedc280e0"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="mlabels">
  200. <tr>
  201. <td class="mlabels-left">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">static void badPinCheck </td>
  205. <td>(</td>
  206. <td class="paramtype">uint8_t&#160;</td>
  207. <td class="paramname"><em>pin</em></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Check for valid pin number </p><dl class="params"><dt>Parameters</dt><dd>
  218. <table class="params">
  219. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Number of pin to be checked. </td></tr>
  220. </table>
  221. </dd>
  222. </dl>
  223. </div>
  224. </div>
  225. <a class="anchor" id="ga2a50c39692fdc6a7be0f614f6d730bfe"></a>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">void badPinNumber </td>
  231. <td>(</td>
  232. <td class="paramtype">void&#160;</td>
  233. <td class="paramname"></td><td>)</td>
  234. <td></td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>generate bad pin number error </p>
  239. </div>
  240. </div>
  241. <a class="anchor" id="gaa28ed1bee40bd072ba33554ac6d36ed8"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">static volatile uint8_t* ddrReg </td>
  250. <td>(</td>
  251. <td class="paramtype">uint8_t&#160;</td>
  252. <td class="paramname"><em>pin</em></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>DDR register address </p><dl class="params"><dt>Parameters</dt><dd>
  263. <table class="params">
  264. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  265. </table>
  266. </dd>
  267. </dl>
  268. <dl class="section return"><dt>Returns</dt><dd>register address </dd></dl>
  269. </div>
  270. </div>
  271. <a class="anchor" id="gaff40f792e0b2aefb3ef6f11f32bae3dd"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">static void fastBitWriteSafe </td>
  280. <td>(</td>
  281. <td class="paramtype">volatile uint8_t *&#160;</td>
  282. <td class="paramname"><em>address</em>, </td>
  283. </tr>
  284. <tr>
  285. <td class="paramkey"></td>
  286. <td></td>
  287. <td class="paramtype">uint8_t&#160;</td>
  288. <td class="paramname"><em>mask</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype">bool&#160;</td>
  294. <td class="paramname"><em>level</em>&#160;</td>
  295. </tr>
  296. <tr>
  297. <td></td>
  298. <td>)</td>
  299. <td></td><td></td>
  300. </tr>
  301. </table>
  302. </td>
  303. <td class="mlabels-right">
  304. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Fast write helper. </p><dl class="params"><dt>Parameters</dt><dd>
  309. <table class="params">
  310. <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>I/O register address </td></tr>
  311. <tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>bit mask for pin </td></tr>
  312. <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>value for bit </td></tr>
  313. </table>
  314. </dd>
  315. </dl>
  316. </div>
  317. </div>
  318. <a class="anchor" id="gada03ef0d2522fe5639f5239991993409"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="mlabels">
  322. <tr>
  323. <td class="mlabels-left">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">static void fastDdrWrite </td>
  327. <td>(</td>
  328. <td class="paramtype">uint8_t&#160;</td>
  329. <td class="paramname"><em>pin</em>, </td>
  330. </tr>
  331. <tr>
  332. <td class="paramkey"></td>
  333. <td></td>
  334. <td class="paramtype">bool&#160;</td>
  335. <td class="paramname"><em>level</em>&#160;</td>
  336. </tr>
  337. <tr>
  338. <td></td>
  339. <td>)</td>
  340. <td></td><td></td>
  341. </tr>
  342. </table>
  343. </td>
  344. <td class="mlabels-right">
  345. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. <p>Write the DDR register. </p><dl class="params"><dt>Parameters</dt><dd>
  350. <table class="params">
  351. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  352. <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>value to write </td></tr>
  353. </table>
  354. </dd>
  355. </dl>
  356. </div>
  357. </div>
  358. <a class="anchor" id="ga618a9ee1c3d1b9fc5c8a2c6a43014b08"></a>
  359. <div class="memitem">
  360. <div class="memproto">
  361. <table class="mlabels">
  362. <tr>
  363. <td class="mlabels-left">
  364. <table class="memname">
  365. <tr>
  366. <td class="memname">static bool fastDigitalRead </td>
  367. <td>(</td>
  368. <td class="paramtype">uint8_t&#160;</td>
  369. <td class="paramname"><em>pin</em></td><td>)</td>
  370. <td></td>
  371. </tr>
  372. </table>
  373. </td>
  374. <td class="mlabels-right">
  375. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. <p>Read pin value. </p><dl class="params"><dt>Parameters</dt><dd>
  380. <table class="params">
  381. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  382. </table>
  383. </dd>
  384. </dl>
  385. <dl class="section return"><dt>Returns</dt><dd>value read </dd></dl>
  386. </div>
  387. </div>
  388. <a class="anchor" id="ga5314f1aaede89a4090b44779c8c551f1"></a>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <table class="mlabels">
  392. <tr>
  393. <td class="mlabels-left">
  394. <table class="memname">
  395. <tr>
  396. <td class="memname">static void fastDigitalToggle </td>
  397. <td>(</td>
  398. <td class="paramtype">uint8_t&#160;</td>
  399. <td class="paramname"><em>pin</em></td><td>)</td>
  400. <td></td>
  401. </tr>
  402. </table>
  403. </td>
  404. <td class="mlabels-right">
  405. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Toggle a pin. </p><dl class="params"><dt>Parameters</dt><dd>
  410. <table class="params">
  411. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number</td></tr>
  412. </table>
  413. </dd>
  414. </dl>
  415. <p>If the pin is in output mode toggle the pin level. If the pin is in input mode toggle the state of the 20K pullup. </p>
  416. </div>
  417. </div>
  418. <a class="anchor" id="gac4f52b5038c366dd4ac081b18709f19c"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">static void fastDigitalWrite </td>
  427. <td>(</td>
  428. <td class="paramtype">uint8_t&#160;</td>
  429. <td class="paramname"><em>pin</em>, </td>
  430. </tr>
  431. <tr>
  432. <td class="paramkey"></td>
  433. <td></td>
  434. <td class="paramtype">bool&#160;</td>
  435. <td class="paramname"><em>level</em>&#160;</td>
  436. </tr>
  437. <tr>
  438. <td></td>
  439. <td>)</td>
  440. <td></td><td></td>
  441. </tr>
  442. </table>
  443. </td>
  444. <td class="mlabels-right">
  445. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>Set pin value. </p><dl class="params"><dt>Parameters</dt><dd>
  450. <table class="params">
  451. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  452. <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>value to write </td></tr>
  453. </table>
  454. </dd>
  455. </dl>
  456. </div>
  457. </div>
  458. <a class="anchor" id="ga5b9c17432f07f0eb39283c8b23665fe7"></a>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">static void fastPinMode </td>
  467. <td>(</td>
  468. <td class="paramtype">uint8_t&#160;</td>
  469. <td class="paramname"><em>pin</em>, </td>
  470. </tr>
  471. <tr>
  472. <td class="paramkey"></td>
  473. <td></td>
  474. <td class="paramtype">uint8_t&#160;</td>
  475. <td class="paramname"><em>mode</em>&#160;</td>
  476. </tr>
  477. <tr>
  478. <td></td>
  479. <td>)</td>
  480. <td></td><td></td>
  481. </tr>
  482. </table>
  483. </td>
  484. <td class="mlabels-right">
  485. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  486. </tr>
  487. </table>
  488. </div><div class="memdoc">
  489. <p>Set pin mode. </p><dl class="params"><dt>Parameters</dt><dd>
  490. <table class="params">
  491. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  492. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>INPUT, OUTPUT, or INPUT_PULLUP.</td></tr>
  493. </table>
  494. </dd>
  495. </dl>
  496. <p>The internal pullup resistors will be enabled if mode is INPUT_PULLUP and disabled if the mode is INPUT. </p>
  497. </div>
  498. </div>
  499. <a class="anchor" id="ga99fe9f7aeaaae3764a7b7c40d9d9837b"></a>
  500. <div class="memitem">
  501. <div class="memproto">
  502. <table class="mlabels">
  503. <tr>
  504. <td class="mlabels-left">
  505. <table class="memname">
  506. <tr>
  507. <td class="memname">static uint8_t pinMask </td>
  508. <td>(</td>
  509. <td class="paramtype">uint8_t&#160;</td>
  510. <td class="paramname"><em>pin</em></td><td>)</td>
  511. <td></td>
  512. </tr>
  513. </table>
  514. </td>
  515. <td class="mlabels-right">
  516. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  517. </tr>
  518. </table>
  519. </div><div class="memdoc">
  520. <p>Bit mask for pin </p><dl class="params"><dt>Parameters</dt><dd>
  521. <table class="params">
  522. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  523. </table>
  524. </dd>
  525. </dl>
  526. <dl class="section return"><dt>Returns</dt><dd>mask </dd></dl>
  527. </div>
  528. </div>
  529. <a class="anchor" id="ga213b72ce9a61eddce1e85fa057e9e3b6"></a>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="mlabels">
  533. <tr>
  534. <td class="mlabels-left">
  535. <table class="memname">
  536. <tr>
  537. <td class="memname">static volatile uint8_t* pinReg </td>
  538. <td>(</td>
  539. <td class="paramtype">uint8_t&#160;</td>
  540. <td class="paramname"><em>pin</em></td><td>)</td>
  541. <td></td>
  542. </tr>
  543. </table>
  544. </td>
  545. <td class="mlabels-right">
  546. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  547. </tr>
  548. </table>
  549. </div><div class="memdoc">
  550. <p>PIN register address </p><dl class="params"><dt>Parameters</dt><dd>
  551. <table class="params">
  552. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  553. </table>
  554. </dd>
  555. </dl>
  556. <dl class="section return"><dt>Returns</dt><dd>register address </dd></dl>
  557. </div>
  558. </div>
  559. <a class="anchor" id="ga1e2ef44778ccf79ac2c02afe0633ef88"></a>
  560. <div class="memitem">
  561. <div class="memproto">
  562. <table class="mlabels">
  563. <tr>
  564. <td class="mlabels-left">
  565. <table class="memname">
  566. <tr>
  567. <td class="memname">static volatile uint8_t* portReg </td>
  568. <td>(</td>
  569. <td class="paramtype">uint8_t&#160;</td>
  570. <td class="paramname"><em>pin</em></td><td>)</td>
  571. <td></td>
  572. </tr>
  573. </table>
  574. </td>
  575. <td class="mlabels-right">
  576. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  577. </tr>
  578. </table>
  579. </div><div class="memdoc">
  580. <p>PORT register address </p><dl class="params"><dt>Parameters</dt><dd>
  581. <table class="params">
  582. <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>Arduino pin number </td></tr>
  583. </table>
  584. </dd>
  585. </dl>
  586. <dl class="section return"><dt>Returns</dt><dd>register address </dd></dl>
  587. </div>
  588. </div>
  589. </div><!-- contents -->
  590. <!-- start footer part -->
  591. <hr class="footer"/><address class="footer"><small>
  592. Generated on Tue Jul 19 2016 06:31:51 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  593. <img class="footer" src="doxygen.png" alt="doxygen"/>
  594. </a> 1.8.10
  595. </small></address>
  596. </body>
  597. </html>