1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
<!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.9.1"/>
<title>FastLED: FastPin< PIN > Class Template Reference</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.9.1 -->
<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="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="class_fast_pin-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FastPin< PIN > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The simplest level of <a class="el" href="class_pin.html">Pin</a> class.
<a href="class_fast_pin.html#details">More...</a></p>
<p><code>#include <<a class="el" href="fastpin_8h_source.html">fastpin.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FastPin< PIN >:</div>
<div class="dyncontent">
<div class="center"><img src="class_fast_pin__inherit__graph.png" border="0" usemap="#_fast_pin_3_01_p_i_n_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_fast_pin_3_01_p_i_n_01_4_inherit__map" id="_fast_pin_3_01_p_i_n_01_4_inherit__map">
<area shape="rect" id="node2" href="class_fast_pin_b_b.html" title="FastPinBB\< PIN \>" alt="" coords="5,80,136,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9f23acc7c8c6ce0c760745d32d14932f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f23acc7c8c6ce0c760745d32d14932f"></a>
typedef volatile RwReg * </td><td class="memItemRight" valign="bottom"><b>port_ptr_t</b></td></tr>
<tr class="separator:a9f23acc7c8c6ce0c760745d32d14932f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23ad28734f9597c28afbba8b4bfcda09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23ad28734f9597c28afbba8b4bfcda09"></a>
typedef RwReg </td><td class="memItemRight" valign="bottom"><b>port_t</b></td></tr>
<tr class="separator:a23ad28734f9597c28afbba8b4bfcda09"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab4b349c1763a7565c3ee7b2de52a50c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b349c1763a7565c3ee7b2de52a50c8"></a>
static void </td><td class="memItemRight" valign="bottom"><b>setOutput</b> ()</td></tr>
<tr class="separator:ab4b349c1763a7565c3ee7b2de52a50c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0543e3ac851ca56f30150fbaf1a109d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0543e3ac851ca56f30150fbaf1a109d"></a>
static void </td><td class="memItemRight" valign="bottom"><b>setInput</b> ()</td></tr>
<tr class="separator:af0543e3ac851ca56f30150fbaf1a109d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7693f53f66b9b6f6e4ecbe03ad0fea6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7693f53f66b9b6f6e4ecbe03ad0fea6b"></a>
static void </td><td class="memItemRight" valign="bottom"><b>hi</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:a7693f53f66b9b6f6e4ecbe03ad0fea6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2321395038a879e2f1adccae8afce5b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2321395038a879e2f1adccae8afce5b5"></a>
static void </td><td class="memItemRight" valign="bottom"><b>lo</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:a2321395038a879e2f1adccae8afce5b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69b8d94e33ca56dfec3fa249affbac32"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69b8d94e33ca56dfec3fa249affbac32"></a>
static void </td><td class="memItemRight" valign="bottom"><b>strobe</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:a69b8d94e33ca56dfec3fa249affbac32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8de59c1701bd256fb9b25bd88f92bd61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8de59c1701bd256fb9b25bd88f92bd61"></a>
static void </td><td class="memItemRight" valign="bottom"><b>toggle</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:a8de59c1701bd256fb9b25bd88f92bd61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdb303c3de97f6b2a0b1ac5369dec87f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdb303c3de97f6b2a0b1ac5369dec87f"></a>
static void </td><td class="memItemRight" valign="bottom"><b>hi</b> (register port_ptr_t port) <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:abdb303c3de97f6b2a0b1ac5369dec87f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca5b2f25bbbd4fa61f435ff2577fb728"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca5b2f25bbbd4fa61f435ff2577fb728"></a>
static void </td><td class="memItemRight" valign="bottom"><b>lo</b> (register port_ptr_t port) <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:aca5b2f25bbbd4fa61f435ff2577fb728"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6416c88feed72cc5a59b012ad45902b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6416c88feed72cc5a59b012ad45902b"></a>
static void </td><td class="memItemRight" valign="bottom"><b>set</b> (register port_t val) <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:af6416c88feed72cc5a59b012ad45902b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8bea00ff59320915271dace678c6e00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8bea00ff59320915271dace678c6e00"></a>
static void </td><td class="memItemRight" valign="bottom"><b>fastset</b> (register port_ptr_t port, register port_t val) <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:af8bea00ff59320915271dace678c6e00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab365936a660e1432e8c93eb4be01f7a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab365936a660e1432e8c93eb4be01f7a6"></a>
static port_t </td><td class="memItemRight" valign="bottom"><b>hival</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:ab365936a660e1432e8c93eb4be01f7a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1668395cdbe4f93d24e789fdc6501279"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1668395cdbe4f93d24e789fdc6501279"></a>
static port_t </td><td class="memItemRight" valign="bottom"><b>loval</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:a1668395cdbe4f93d24e789fdc6501279"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5256244d2cb8e4404bcfec58e6c64f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5256244d2cb8e4404bcfec58e6c64f6"></a>
static port_ptr_t </td><td class="memItemRight" valign="bottom"><b>port</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:ae5256244d2cb8e4404bcfec58e6c64f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace4b21f3980bbca6a4be16130053e8f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace4b21f3980bbca6a4be16130053e8f3"></a>
static port_t </td><td class="memItemRight" valign="bottom"><b>mask</b> () <a class="el" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline))</td></tr>
<tr class="separator:ace4b21f3980bbca6a4be16130053e8f3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<uint8_t PIN><br />
class FastPin< PIN ></h3>
<p>The simplest level of <a class="el" href="class_pin.html">Pin</a> class. </p>
<p>This relies on runtime functions durinig initialization to get the port/pin mask for the pin. Most of the accesses involve references to these static globals that get set up. This won't be the fastest set of pin operations, but it will provide pin level access on pretty much all arduino environments. In addition, it includes some methods to help optimize access in various ways. Namely, the versions of hi, lo, and fastset that take the port register as a passed in register variable (saving a global dereference), since these functions are aggressively inlined, that can help collapse out a lot of extraneous memory loads/dereferences.</p>
<p>In addition, if, while writing a bunch of data to a pin, you know no other pins will be getting written to, you can get/cache a value of the pin's port register and use that to do a full set to the register. This results in one being able to simply do a store to the register, vs. the load, and/or, and store that would be done normally.</p>
<p>There are platform specific instantiations of this class that provide direct i/o register access to pins for much higher speed pin twiddling.</p>
<p>Note that these classes are all static functions. So the proper usage is Pin<13>::hi(); or such. Instantiating objects is not recommended, as passing <a class="el" href="class_pin.html">Pin</a> objects around will likely -not- have the effect you're expecting. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fastpin_8h_source.html">fastpin.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 10 2015 22:21:16 for FastLED by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|
