diff options
Diffstat (limited to 'docs/3.1/fastpin_8h_source.html')
| -rw-r--r-- | docs/3.1/fastpin_8h_source.html | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/docs/3.1/fastpin_8h_source.html b/docs/3.1/fastpin_8h_source.html new file mode 100644 index 00000000..295becef --- /dev/null +++ b/docs/3.1/fastpin_8h_source.html @@ -0,0 +1,216 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.8"/> +<title>FastLED: fastpin.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">FastLED +  <span id="projectnumber">3.1</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.8 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + </ul> + </div> +</div><!-- top --> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">fastpin.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __INC_FASTPIN_H</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __INC_FASTPIN_H</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "led_sysdefs.h"</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#define NO_PIN 255</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Pin access class - needs to tune for various platforms (naive fallback solution?)</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div> +<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="class_selectable.html"> 14</a></span> <span class="keyword">class </span><a class="code" href="class_selectable.html">Selectable</a> {</div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> select() = 0;</div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() = 0;</div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isSelected() = 0;</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> };</div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#if defined(ARDUINO)</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">class </span>Pin : <span class="keyword">public</span> <a class="code" href="class_selectable.html">Selectable</a> {</div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">volatile</span> RwReg *mPort;</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">volatile</span> RoReg *mInPort;</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  RwReg mPinMask;</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  uint8_t mPin;</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">void</span> _init() {</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  mPinMask = digitalPinToBitMask(mPin);</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  mPort = portOutputRegister(digitalPinToPort(mPin));</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  mInPort = portInputRegister(digitalPinToPort(mPin));</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  Pin(<span class="keywordtype">int</span> pin) : mPin(pin) { _init(); }</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">typedef</span> <span class="keyword">volatile</span> RwReg * port_ptr_t;</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">typedef</span> RwReg port_t;</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> setOutput() { pinMode(mPin, OUTPUT); }</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> setInput() { pinMode(mPin, INPUT); }</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> hi() __attribute__ ((always_inline)) { *mPort |= mPinMask; }</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> lo() __attribute__ ((always_inline)) { *mPort &= ~mPinMask; }</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> strobe() __attribute__ ((always_inline)) { toggle(); toggle(); }</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> toggle() __attribute__ ((always_inline)) { *mInPort = mPinMask; }</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> hi(<span class="keyword">register</span> port_ptr_t port) __attribute__ ((always_inline)) { *port |= mPinMask; }</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> lo(<span class="keyword">register</span> port_ptr_t port) __attribute__ ((always_inline)) { *port &= ~mPinMask; }</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> set(<span class="keyword">register</span> port_t val) __attribute__ ((always_inline)) { *mPort = val; }</div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> fastset(<span class="keyword">register</span> port_ptr_t port, <span class="keyword">register</span> port_t val) __attribute__ ((always_inline)) { *port = val; }</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  port_t hival() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> *mPort | mPinMask; }</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  port_t loval() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> *mPort & ~mPinMask; }</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  port_ptr_t port() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> mPort; }</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  port_t mask() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> mPinMask; }</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> select() { hi(); }</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() { lo(); }</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isSelected() { <span class="keywordflow">return</span> (*mPort & mPinMask) == mPinMask; }</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> };</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">class </span>OutputPin : <span class="keyword">public</span> Pin {</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  OutputPin(<span class="keywordtype">int</span> pin) : Pin(pin) { setOutput(); }</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> };</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">class </span>InputPin : <span class="keyword">public</span> Pin {</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  InputPin(<span class="keywordtype">int</span> pin) : Pin(pin) { setInput(); }</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> };</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">template</span><u<span class="keywordtype">int</span>8_t PIN> <span class="keyword">class </span>FastPin {</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">static</span> RwReg sPinMask;</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">static</span> <span class="keyword">volatile</span> RwReg *sPort;</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">static</span> <span class="keyword">volatile</span> RoReg *sInPort;</div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> _init() {</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  sPinMask = digitalPinToBitMask(PIN);</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  sPort = portOutputRegister(digitalPinToPort(PIN));</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  sInPort = portInputRegister(digitalPinToPort(PIN));</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">typedef</span> <span class="keyword">volatile</span> RwReg * port_ptr_t;</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">typedef</span> RwReg port_t;</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> setOutput() { _init(); pinMode(PIN, OUTPUT); }</div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> setInput() { _init(); pinMode(PIN, INPUT); }</div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> hi() __attribute__ ((always_inline)) { *sPort |= sPinMask; }</div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> lo() __attribute__ ((always_inline)) { *sPort &= ~sPinMask; }</div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> strobe() __attribute__ ((always_inline)) { toggle(); toggle(); }</div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> toggle() __attribute__ ((always_inline)) { *sInPort = sPinMask; }</div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> hi(<span class="keyword">register</span> port_ptr_t port) __attribute__ ((always_inline)) { *port |= sPinMask; }</div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> lo(<span class="keyword">register</span> port_ptr_t port) __attribute__ ((always_inline)) { *port &= ~sPinMask; }</div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> set(<span class="keyword">register</span> port_t val) __attribute__ ((always_inline)) { *sPort = val; }</div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> fastset(<span class="keyword">register</span> port_ptr_t port, <span class="keyword">register</span> port_t val) __attribute__ ((always_inline)) { *port = val; }</div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> +<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">static</span> port_t hival() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> *sPort | sPinMask; }</div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">static</span> port_t loval() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> *sPort & ~sPinMask; }</div> +<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">static</span> port_ptr_t port() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> sPort; }</div> +<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">static</span> port_t mask() __attribute__ ((always_inline)) { <span class="keywordflow">return</span> sPinMask; }</div> +<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> +<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">template</span><u<span class="keywordtype">int</span>8_t PIN> RwReg FastPin<PIN>::sPinMask;</div> +<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="keyword">template</span><u<span class="keywordtype">int</span>8_t PIN> <span class="keyword">volatile</span> RwReg *FastPin<PIN>::sPort;</div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">template</span><u<span class="keywordtype">int</span>8_t PIN> <span class="keyword">volatile</span> RoReg *FastPin<PIN>::sInPort;</div> +<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">template</span><u<span class="keywordtype">int</span>8_t PIN> <span class="keyword">class </span>FastPinBB : <span class="keyword">public</span> FastPin<PIN> {};</div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#endif // defined(ARDUINO)</span></div> +<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> +<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">typedef</span> <span class="keyword">volatile</span> uint32_t & reg32_t;</div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">typedef</span> <span class="keyword">volatile</span> uint32_t * ptr_reg32_t;</div> +<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div> +<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#endif // __INC_FASTPIN_H</span></div> +<div class="ttc" id="class_selectable_html"><div class="ttname"><a href="class_selectable.html">Selectable</a></div><div class="ttdef"><b>Definition:</b> fastpin.h:14</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Sat Nov 29 2014 22:13:42 for FastLED by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.8 +</small></address> +</body> +</html> |