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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<!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_ref.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/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 -->
<!-- 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_ref.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_ARM_SAM_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __INC_FASTSPI_ARM_SAM_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="l00006"></a><span class="lineno"> 6</span> <span class="comment">// A skeletal implementation of hardware SPI support. Fill in the necessary code for init, waiting, and writing. The rest of</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// the method implementations should provide a starting point, even if not hte most efficient to start with</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</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="l00009"></a><span class="lineno"> 9</span> <span class="keyword">class </span>REFHardwareSPIOutput {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <a class="code" href="class_selectable.html">Selectable</a> *m_pSelect;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  SAMHardwareSPIOutput() { m_pSelect = NULL; }</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  SAMHArdwareSPIOutput(<a class="code" href="class_selectable.html">Selectable</a> *pSelect) { m_pSelect = pSelect; }</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="comment">// set the object representing the selectable</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keywordtype">void</span> setSelect(<a class="code" href="class_selectable.html">Selectable</a> *pSelect) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// initialize the SPI subssytem</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">void</span> init() { <span class="comment">/* TODO */</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="comment">// latch the CS select</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">void</span> <span class="keyword">inline</span> select() <a class="code" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline)) { <span class="keywordflow">if</span>(m_pSelect != NULL) { m_pSelect->select(); } } </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment">// release the CS select </span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordtype">void</span> <span class="keyword">inline</span> release() <a class="code" href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a>((always_inline)) { <span class="keywordflow">if</span>(m_pSelect != NULL) { m_pSelect->release(); } } </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// wait until all queued up data has been written</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> waitFully() { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// write a byte out via SPI (returns immediately on writing register)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> writeByte(uint8_t b) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// write a word out via SPI (returns immediately on writing register)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> writeWord(uint16_t w) { <span class="comment">/* TODO */</span> }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// A raw set of writing byte values, assumes setup/init/waiting done elsewhere</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> writeBytesValueRaw(uint8_t value, <span class="keywordtype">int</span> len) {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">while</span>(len--) { writeByte(value); }</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> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// A full cycle of writing a value for len bytes, including select, release, and waiting</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> writeBytesValue(uint8_t value, <span class="keywordtype">int</span> len) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  select(); writeBytesValueRaw(value, len); release();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</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="comment">// A full cycle of writing a value for len bytes, including select, release, and waiting</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">template</span> <<span class="keyword">class</span> D> <span class="keywordtype">void</span> writeBytes(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len) { </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  uint8_t *end = data + len;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  select();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// could be optimized to write 16bit words out instead of 8bit bytes</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">while</span>(data != end) { </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  writeByte(D::adjust(*data++));</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  D::postBlock(len);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  waitFully();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  release(); </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</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="comment">// A full cycle of writing a value for len bytes, including select, release, and waiting</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> writeBytes(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len) { writeBytes<DATA_NOP>(data, len); }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// write a single bit out, which bit from the passed in byte is determined by template parameter</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</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> writeBit(uint8_t b) { <span class="comment">/* TODO */</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="comment">// write a block of uint8_ts out in groups of three. len is the total number of uint8_ts to write out. The template</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// parameters indicate how many uint8_ts to skip at the beginning and/or end of each grouping</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</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> writeBytes3(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len, <span class="keyword">register</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a> scale, <span class="keywordtype">bool</span> advance=<span class="keyword">true</span>, uint8_t skip=0) {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  select();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">while</span>(data != end) { </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span>(FLAGS & FLAG_START_BIT) { </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  writeBit<0>(1);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  writeByte(D::adjust(pixels.loadAndScale0()));</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  writeByte(D::adjust(pixels.loadAndScale1()));</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  writeByte(D::adjust(pixels.loadAndScale2()));</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  pixels.advanceData();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  pixels.stepDithering();</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  data += (3+skip);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  D::postBlock(len);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  release();</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// template instantiations for writeBytes 3</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">template</span> <u<span class="keywordtype">int</span>8_t FLAGS, EOrder RGB_ORDER> <span class="keywordtype">void</span> writeBytes3(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len, <span class="keyword">register</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a> scale, <span class="keywordtype">bool</span> advance=<span class="keyword">true</span>, uint8_t skip=0) { </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  writeBytes3<FLAGS, DATA_NOP, RGB_ORDER>(data, len, scale, advance, skip); </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">template</span> <<span class="keyword">class</span> D, EOrder RGB_ORDER> <span class="keywordtype">void</span> writeBytes3(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len, <span class="keyword">register</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a> scale, <span class="keywordtype">bool</span> advance=<span class="keyword">true</span>, uint8_t skip=0) { </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  writeBytes3<0, D, RGB_ORDER>(data, len, scale, advance, skip); </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">template</span> <EOrder RGB_ORDER> <span class="keywordtype">void</span> writeBytes3(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len, <span class="keyword">register</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a> scale, <span class="keywordtype">bool</span> advance=<span class="keyword">true</span>, uint8_t skip=0) { </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  writeBytes3<0, DATA_NOP, RGB_ORDER>(data, len, scale, advance, skip); </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> writeBytes3(<span class="keyword">register</span> uint8_t *data, <span class="keywordtype">int</span> len, <span class="keyword">register</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a> scale, <span class="keywordtype">bool</span> advance=<span class="keyword">true</span>, uint8_t skip=0) { </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  writeBytes3<0, DATA_NOP, RGB>(data, len, scale, advance, skip); </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> };</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> FASTLED_NAMESPACE_END</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="preprocessor">#endif</span></div>
<div class="ttc" id="struct_c_r_g_b_html"><div class="ttname"><a href="struct_c_r_g_b.html">CRGB</a></div><div class="ttdef"><b>Definition:</b> pixeltypes.h:83</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> fastpin.h:16</div></div>
<div class="ttc" id="group___bitswap_html_ga01396a2e40133293c3badab349ac99f0"><div class="ttname"><a href="group___bitswap.html#ga01396a2e40133293c3badab349ac99f0">__attribute__</a></div><div class="ttdeci">__attribute__((always_inline)) inline void swapbits8(bitswap_type in</div><div class="ttdoc">Do an 8byte by 8bit rotation. </div><div class="ttdef"><b>Definition:</b> fastled_delay.h:82</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 10 2015 22:46:45 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>
|
