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
|
<!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: fastspi_nop.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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><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>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fastspi__nop_8h_source.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">fastspi_nop.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_FASTSPI_NOP_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __INC_FASTSPI_NOP_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> FASTLED_NAMESPACE_BEGIN</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">template</span> <u<span class="keywordtype">int</span>8_t _DATA_PIN, u<span class="keywordtype">int</span>8_t _CLOCK_PIN, u<span class="keywordtype">int</span>8_t _SPI_CLOCK_DIVIDER></div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html"> 10</a></span> <span class="keyword">class </span><a class="code" href="class_n_o_p_s_p_i_output.html">NOPSPIOutput</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <a class="code" href="class_selectable.html">Selectable</a> *m_pSelect;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <a class="code" href="class_n_o_p_s_p_i_output.html">NOPSPIOutput</a>() { m_pSelect = NULL; }</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <a class="code" href="class_n_o_p_s_p_i_output.html">NOPSPIOutput</a>(<a class="code" href="class_selectable.html">Selectable</a> *pSelect) { m_pSelect = pSelect; }</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a6fca9a7e475aecae123879044d33f195"> 18</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a6fca9a7e475aecae123879044d33f195">setSelect</a>(<a class="code" href="class_selectable.html">Selectable</a> *pSelect) { m_pSelect = pSelect; }</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#ad9ff9bf62427b69e3bb578699e0ce561"> 21</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#ad9ff9bf62427b69e3bb578699e0ce561">init</a>() { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#ae07bb6f787879f28979cccec9ec4965d"> 24</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#ae07bb6f787879f28979cccec9ec4965d">select</a>() { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a0599fbdf5e04a633d24ff17033443237"> 27</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a0599fbdf5e04a633d24ff17033443237">release</a>() { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a6d1c46106879fc835ad6ba8149b20068">waitFully</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a9b0cd7fa63b1cff86c61f796aa8a6637"> 33</a></span>  <span class="keyword">template</span> <u<span class="keywordtype">int</span>8_t BIT> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a9b0cd7fa63b1cff86c61f796aa8a6637">writeBit</a>(uint8_t b) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#af5485fc346e12c50480b969e5b242636"> 36</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#af5485fc346e12c50480b969e5b242636">writeByte</a>(uint8_t b) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a31ccabe3e4987751ad67a5d06e502df2"> 38</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a31ccabe3e4987751ad67a5d06e502df2">writeWord</a>(uint16_t w) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a7c67ce1f9d44cfcac9b94fa9f097835f"> 41</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a7c67ce1f9d44cfcac9b94fa9f097835f">writeBytesValueRaw</a>(uint8_t value, <span class="keywordtype">int</span> len) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a2f8e72323c827eb869b222b5a36ebbc1"> 44</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a2f8e72323c827eb869b222b5a36ebbc1">writeBytesValue</a>(uint8_t value, <span class="keywordtype">int</span> len) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a7b33548cfee1f5cda7a8a48fa45ee460"> 47</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a7b33548cfee1f5cda7a8a48fa45ee460">writeBytes</a>(uint8_t *data, <span class="keywordtype">int</span> len) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#a9b0cd7fa63b1cff86c61f796aa8a6637"> 50</a></span>  <span class="keyword">template</span> <u<span class="keywordtype">int</span>8_t BIT> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#a9b0cd7fa63b1cff86c61f796aa8a6637">writeBit</a>(uint8_t b) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_n_o_p_s_p_i_output.html#aa192a8b0f727e7c9fc399e94532e287f"> 53</a></span>  <span class="keyword">template</span> <u<span class="keywordtype">int</span>8_t FLAGS, <span class="keyword">class</span> D, EOrder RGB_ORDER> <span class="keywordtype">void</span> <a class="code" href="class_n_o_p_s_p_i_output.html#aa192a8b0f727e7c9fc399e94532e287f">writePixels</a>(<a class="code" href="struct_pixel_controller.html">PixelController<RGB_ORDER></a> pixels) { <span class="comment">/* TODO */</span> }</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> };</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> FASTLED_NAMESPACE_END</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a0599fbdf5e04a633d24ff17033443237"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a0599fbdf5e04a633d24ff17033443237">NOPSPIOutput::release</a></div><div class="ttdeci">void release()</div><div class="ttdoc">release the CS select </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00027">fastspi_nop.h:27</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a7b33548cfee1f5cda7a8a48fa45ee460"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a7b33548cfee1f5cda7a8a48fa45ee460">NOPSPIOutput::writeBytes</a></div><div class="ttdeci">void writeBytes(uint8_t *data, int len)</div><div class="ttdoc">A full cycle of writing a raw block of data out, including select, release, and waiting. </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00047">fastspi_nop.h:47</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a9b0cd7fa63b1cff86c61f796aa8a6637"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a9b0cd7fa63b1cff86c61f796aa8a6637">NOPSPIOutput::writeBit</a></div><div class="ttdeci">static void writeBit(uint8_t b)</div><div class="ttdoc">not the most efficient mechanism in the world - but should be enough for sm16716 and friends ...</div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00033">fastspi_nop.h:33</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_af5485fc346e12c50480b969e5b242636"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#af5485fc346e12c50480b969e5b242636">NOPSPIOutput::writeByte</a></div><div class="ttdeci">void writeByte(uint8_t b)</div><div class="ttdoc">write a byte out via SPI (returns immediately on writing register) </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00036">fastspi_nop.h:36</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a6fca9a7e475aecae123879044d33f195"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a6fca9a7e475aecae123879044d33f195">NOPSPIOutput::setSelect</a></div><div class="ttdeci">void setSelect(Selectable *pSelect)</div><div class="ttdoc">set the object representing the selectable </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00018">fastspi_nop.h:18</a></div></div>
<div class="ttc" id="struct_pixel_controller_html"><div class="ttname"><a href="struct_pixel_controller.html">PixelController</a></div><div class="ttdoc">Pixel controller class. </div><div class="ttdef"><b>Definition:</b> <a href="controller_8h_source.html#l00187">controller.h:187</a></div></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> <a href="fastpin_8h_source.html#l00022">fastpin.h:22</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_ad9ff9bf62427b69e3bb578699e0ce561"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#ad9ff9bf62427b69e3bb578699e0ce561">NOPSPIOutput::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">initialize the SPI subssytem </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00021">fastspi_nop.h:21</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html">NOPSPIOutput</a></div><div class="ttdoc">A nop/stub class, mostly to show the SPI methods that are needed/used by the various SPI chipset impl...</div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00010">fastspi_nop.h:10</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_ae07bb6f787879f28979cccec9ec4965d"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#ae07bb6f787879f28979cccec9ec4965d">NOPSPIOutput::select</a></div><div class="ttdeci">void select()</div><div class="ttdoc">latch the CS select </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00024">fastspi_nop.h:24</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a2f8e72323c827eb869b222b5a36ebbc1"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a2f8e72323c827eb869b222b5a36ebbc1">NOPSPIOutput::writeBytesValue</a></div><div class="ttdeci">void writeBytesValue(uint8_t value, int len)</div><div class="ttdoc">A full cycle of writing a value for len bytes, including select, release, and waiting. </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00044">fastspi_nop.h:44</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a7c67ce1f9d44cfcac9b94fa9f097835f"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a7c67ce1f9d44cfcac9b94fa9f097835f">NOPSPIOutput::writeBytesValueRaw</a></div><div class="ttdeci">static void writeBytesValueRaw(uint8_t value, int len)</div><div class="ttdoc">A raw set of writing byte values, assumes setup/init/waiting done elsewhere (static for use by adjust...</div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00041">fastspi_nop.h:41</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a6d1c46106879fc835ad6ba8149b20068"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a6d1c46106879fc835ad6ba8149b20068">NOPSPIOutput::waitFully</a></div><div class="ttdeci">void waitFully()</div><div class="ttdoc">wait until all queued up data has been written </div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_aa192a8b0f727e7c9fc399e94532e287f"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#aa192a8b0f727e7c9fc399e94532e287f">NOPSPIOutput::writePixels</a></div><div class="ttdeci">void writePixels(PixelController< RGB_ORDER > pixels)</div><div class="ttdoc">write out pixel data from the given PixelController object </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00053">fastspi_nop.h:53</a></div></div>
<div class="ttc" id="class_n_o_p_s_p_i_output_html_a31ccabe3e4987751ad67a5d06e502df2"><div class="ttname"><a href="class_n_o_p_s_p_i_output.html#a31ccabe3e4987751ad67a5d06e502df2">NOPSPIOutput::writeWord</a></div><div class="ttdeci">void writeWord(uint16_t w)</div><div class="ttdoc">write a word out via SPI (returns immediately on writing register) </div><div class="ttdef"><b>Definition:</b> <a href="fastspi__nop_8h_source.html#l00038">fastspi_nop.h:38</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>fastspi_nop.h</b></li>
<li class="footer">Generated on Wed Nov 18 2015 11:53:18 for FastLED by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
|
