1 |
52 |
zero_gravi |
// #################################################################################################
|
2 |
|
|
// # << NEORV32: neorv32_neoled.c - Smart LED Interface (NEOLED) HW Driver >> #
|
3 |
|
|
// # ********************************************************************************************* #
|
4 |
|
|
// # BSD 3-Clause License #
|
5 |
|
|
// # #
|
6 |
|
|
// # Copyright (c) 2021, Stephan Nolting. All rights reserved. #
|
7 |
|
|
// # #
|
8 |
|
|
// # Redistribution and use in source and binary forms, with or without modification, are #
|
9 |
|
|
// # permitted provided that the following conditions are met: #
|
10 |
|
|
// # #
|
11 |
|
|
// # 1. Redistributions of source code must retain the above copyright notice, this list of #
|
12 |
|
|
// # conditions and the following disclaimer. #
|
13 |
|
|
// # #
|
14 |
|
|
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
|
15 |
|
|
// # conditions and the following disclaimer in the documentation and/or other materials #
|
16 |
|
|
// # provided with the distribution. #
|
17 |
|
|
// # #
|
18 |
|
|
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
|
19 |
|
|
// # endorse or promote products derived from this software without specific prior written #
|
20 |
|
|
// # permission. #
|
21 |
|
|
// # #
|
22 |
|
|
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
|
23 |
|
|
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
|
24 |
|
|
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
|
25 |
|
|
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
|
26 |
|
|
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
|
27 |
|
|
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
|
28 |
|
|
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
|
29 |
|
|
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
|
30 |
|
|
// # OF THE POSSIBILITY OF SUCH DAMAGE. #
|
31 |
|
|
// # ********************************************************************************************* #
|
32 |
|
|
// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
|
33 |
|
|
// #################################################################################################
|
34 |
|
|
|
35 |
|
|
|
36 |
|
|
/**********************************************************************//**
|
37 |
|
|
* @file neorv32_neoled.c
|
38 |
|
|
* @brief Smart LED Interface (NEOLED) HW driver source file.
|
39 |
|
|
*
|
40 |
|
|
* @note These functions should only be used if the NEOLED unit was synthesized (IO_NEOLED_EN = true).
|
41 |
|
|
**************************************************************************/
|
42 |
|
|
|
43 |
|
|
#include "neorv32.h"
|
44 |
|
|
#include "neorv32_neoled.h"
|
45 |
|
|
|
46 |
|
|
|
47 |
|
|
/**********************************************************************//**
|
48 |
|
|
* Check if NEOLED unit was synthesized.
|
49 |
|
|
*
|
50 |
|
|
* @return 0 if NEOLED was not synthesized, 1 if NEOLED is available.
|
51 |
|
|
**************************************************************************/
|
52 |
|
|
int neorv32_neoled_available(void) {
|
53 |
|
|
|
54 |
64 |
zero_gravi |
if (NEORV32_SYSINFO.SOC & (1 << SYSINFO_SOC_IO_NEOLED)) {
|
55 |
52 |
zero_gravi |
return 1;
|
56 |
|
|
}
|
57 |
|
|
else {
|
58 |
|
|
return 0;
|
59 |
|
|
}
|
60 |
|
|
}
|
61 |
|
|
|
62 |
|
|
|
63 |
|
|
/**********************************************************************//**
|
64 |
64 |
zero_gravi |
* Enable and configure NEOLED controller. The NEOLED control register bits are listed in #NEORV32_NEOLED_CTRL_enum.
|
65 |
52 |
zero_gravi |
* This function performs a "raw" configuration (just configuraing the according control register bit).
|
66 |
|
|
*
|
67 |
|
|
* @param[in] prsc Clock prescaler select (0..7). See #NEORV32_CLOCK_PRSC_enum.
|
68 |
|
|
* @param[in] t_total Number of pre-scaled clock ticks for total bit period (0..31).
|
69 |
|
|
* @param[in] t_high_zero Number of pre-scaled clock ticks to generate high-time for sending a '0' (0..31).
|
70 |
|
|
* @param[in] t_high_one Number of pre-scaled clock ticks to generate high-time for sending a '1' (0..31).
|
71 |
|
|
**************************************************************************/
|
72 |
62 |
zero_gravi |
void neorv32_neoled_setup(uint32_t prsc, uint32_t t_total, uint32_t t_high_zero, uint32_t t_high_one) {
|
73 |
52 |
zero_gravi |
|
74 |
64 |
zero_gravi |
NEORV32_NEOLED.CTRL = 0; // reset
|
75 |
52 |
zero_gravi |
|
76 |
|
|
// module enable
|
77 |
64 |
zero_gravi |
uint32_t ct_enable = 1 << NEOLED_CTRL_EN;
|
78 |
52 |
zero_gravi |
|
79 |
|
|
// clock pre-scaler
|
80 |
64 |
zero_gravi |
uint32_t ct_prsc = (prsc & 0x7) << NEOLED_CTRL_PRSC0;
|
81 |
52 |
zero_gravi |
|
82 |
|
|
// serial data output: total period length for one bit
|
83 |
64 |
zero_gravi |
uint32_t ct_t_total = (t_total & 0x1f) << NEOLED_CTRL_T_TOT_0;
|
84 |
52 |
zero_gravi |
|
85 |
|
|
// serial data output: high-time for sending a '0'
|
86 |
64 |
zero_gravi |
uint32_t ct_t_zero = (t_high_zero & 0x1f) << NEOLED_CTRL_T_ZERO_H_0;
|
87 |
52 |
zero_gravi |
|
88 |
|
|
// serial data output: high-time for sending a '1'
|
89 |
64 |
zero_gravi |
uint32_t ct_t_one = (t_high_one & 0x1f) << NEOLED_CTRL_T_ONE_H_0;
|
90 |
52 |
zero_gravi |
|
91 |
|
|
// set new configuration
|
92 |
64 |
zero_gravi |
NEORV32_NEOLED.CTRL = ct_enable | ct_prsc | ct_t_total | ct_t_zero | ct_t_one;
|
93 |
52 |
zero_gravi |
}
|
94 |
|
|
|
95 |
|
|
|
96 |
|
|
/**********************************************************************//**
|
97 |
|
|
* Configure NEOLED controller for using WS2812 LEDs (NeoPixel-compatible). This function computes
|
98 |
66 |
zero_gravi |
* all the required timings and finally calls #neorv32_neoled_setup.
|
99 |
52 |
zero_gravi |
*
|
100 |
|
|
* @note WS2812 timing: T_period = 1.2us, T_high_zero = 0.4us, T_high_one = 0.8us. Change the constants if required.
|
101 |
|
|
* @note This function uses the SYSINFO_CLK value (from the SYSINFO HW module) to do the timing computations.
|
102 |
|
|
**************************************************************************/
|
103 |
62 |
zero_gravi |
void neorv32_neoled_setup_ws2812(void) {
|
104 |
52 |
zero_gravi |
|
105 |
|
|
// WS2812 timing
|
106 |
|
|
const uint32_t T_TOTAL_C = 1200; // ns
|
107 |
|
|
const uint32_t T_H_ZERO_C = 400; // ns
|
108 |
|
|
const uint32_t T_H_ONE_C = 800; // ns
|
109 |
|
|
|
110 |
|
|
// processor clock pre-scalers
|
111 |
|
|
const uint32_t CLK_PRSC_FACTOR_LUT[8] = {2, 4, 8, 64, 128, 1024, 2048, 4096};
|
112 |
|
|
|
113 |
|
|
// get base clock period in multiples of 0.5ns
|
114 |
64 |
zero_gravi |
uint32_t t_clock_x500ps = (2 * 1000 * 1000 * 1000) / NEORV32_SYSINFO.CLK;
|
115 |
52 |
zero_gravi |
|
116 |
|
|
// compute LED interface timing parameters
|
117 |
|
|
uint32_t t_base = 0;
|
118 |
|
|
uint32_t t_total = 0;
|
119 |
|
|
uint32_t t_high_zero = 0;
|
120 |
|
|
uint32_t t_high_one = 0;
|
121 |
|
|
uint32_t clk_prsc_sel = CLK_PRSC_2; // initial prsc = CLK/2
|
122 |
|
|
uint32_t clk_prsc_fac = 0; // corresponding clock scaling factor
|
123 |
|
|
|
124 |
|
|
//neorv32_uart0_printf("\nNEOLED.T_clk: %u x 500ps\n", t_clock_x500ps); // DEBUG
|
125 |
|
|
|
126 |
|
|
while (clk_prsc_sel < 7) {
|
127 |
|
|
clk_prsc_fac = CLK_PRSC_FACTOR_LUT[clk_prsc_sel & 7];
|
128 |
|
|
|
129 |
|
|
//neorv32_uart0_printf("NEOLED.clk_prsc: %u\n", clk_prsc_fac); // DEBUG
|
130 |
|
|
|
131 |
|
|
t_base = t_clock_x500ps * clk_prsc_fac;
|
132 |
|
|
|
133 |
|
|
//neorv32_uart0_printf("NEOLED.t_base: %u x 0.5ns\n", t_base); // DEBUG
|
134 |
|
|
|
135 |
|
|
// compute bit period and high-times for sending a 0 or 1
|
136 |
|
|
t_total = (2*T_TOTAL_C) / t_base;
|
137 |
|
|
t_high_zero = (2*T_H_ZERO_C) / t_base;
|
138 |
|
|
t_high_one = (2*T_H_ONE_C) / t_base;
|
139 |
|
|
|
140 |
|
|
//neorv32_uart0_printf("NEOLED.t_total: %u\n", t_total); // DEBUG
|
141 |
|
|
//neorv32_uart0_printf("NEOLED.t_high_zero: %u\n", t_high_zero); // DEBUG
|
142 |
|
|
//neorv32_uart0_printf("NEOLED.t_high_one: %u\n", t_high_one); // DEBUG
|
143 |
|
|
|
144 |
|
|
if ((t_base == 0) || (t_total >= 32) || (t_high_zero == 0) || (t_high_one == 0)) { // out of range or invalid resolution
|
145 |
|
|
clk_prsc_sel++; // try next-higher clock prescaler
|
146 |
|
|
}
|
147 |
|
|
else {
|
148 |
|
|
break;
|
149 |
|
|
}
|
150 |
|
|
}
|
151 |
|
|
|
152 |
|
|
// set raw configuration
|
153 |
62 |
zero_gravi |
neorv32_neoled_setup(clk_prsc_sel, t_total, t_high_zero, t_high_one);
|
154 |
52 |
zero_gravi |
}
|
155 |
|
|
|
156 |
|
|
|
157 |
|
|
/**********************************************************************//**
|
158 |
62 |
zero_gravi |
* Set NEOLED mode (24-bit RGB / 32-bit RGBW).
|
159 |
|
|
*
|
160 |
|
|
* @param[in] mode 0 = 24-bit mode (RGB), 1 = 32-bit mode (RGBW)
|
161 |
52 |
zero_gravi |
**************************************************************************/
|
162 |
62 |
zero_gravi |
void neorv32_neoled_set_mode(uint32_t mode) {
|
163 |
52 |
zero_gravi |
|
164 |
64 |
zero_gravi |
uint32_t ctrl = NEORV32_NEOLED.CTRL;
|
165 |
|
|
ctrl &= ~(0b1 << NEOLED_CTRL_MODE); // clear current mode
|
166 |
|
|
ctrl |= ((mode & 1) << NEOLED_CTRL_MODE); // set new mode
|
167 |
|
|
NEORV32_NEOLED.CTRL = ctrl;
|
168 |
52 |
zero_gravi |
}
|
169 |
|
|
|
170 |
|
|
|
171 |
|
|
/**********************************************************************//**
|
172 |
62 |
zero_gravi |
* Send strobe command ("RESET") - blocking.
|
173 |
52 |
zero_gravi |
**************************************************************************/
|
174 |
62 |
zero_gravi |
void neorv32_neoled_strobe_blocking(void) {
|
175 |
52 |
zero_gravi |
|
176 |
62 |
zero_gravi |
while(1) { // wait for FIFO full flag to clear
|
177 |
64 |
zero_gravi |
if ((NEORV32_NEOLED.CTRL & (1 << NEOLED_CTRL_TX_FULL)) == 0) {
|
178 |
62 |
zero_gravi |
break;
|
179 |
|
|
}
|
180 |
|
|
}
|
181 |
|
|
|
182 |
|
|
neorv32_neoled_strobe_nonblocking();
|
183 |
52 |
zero_gravi |
}
|
184 |
|
|
|
185 |
|
|
|
186 |
|
|
/**********************************************************************//**
|
187 |
62 |
zero_gravi |
* Send strobe command ("RESET") - non-blocking.
|
188 |
52 |
zero_gravi |
**************************************************************************/
|
189 |
62 |
zero_gravi |
void neorv32_neoled_strobe_nonblocking(void) {
|
190 |
52 |
zero_gravi |
|
191 |
64 |
zero_gravi |
const uint32_t mask = 1 << NEOLED_CTRL_STROBE; // strobe bit
|
192 |
|
|
uint32_t ctrl = NEORV32_NEOLED.CTRL;
|
193 |
52 |
zero_gravi |
|
194 |
64 |
zero_gravi |
NEORV32_NEOLED.CTRL = ctrl | mask; // set strobe bit
|
195 |
|
|
NEORV32_NEOLED.DATA = 0; // send any data to trigger strobe command
|
196 |
|
|
NEORV32_NEOLED.CTRL = ctrl & (~mask); // clear strobe bit
|
197 |
52 |
zero_gravi |
}
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
/**********************************************************************//**
|
201 |
62 |
zero_gravi |
* Enable NEOLED controller.
|
202 |
|
|
**************************************************************************/
|
203 |
|
|
void neorv32_neoled_enable(void) {
|
204 |
|
|
|
205 |
64 |
zero_gravi |
NEORV32_NEOLED.CTRL |= ((uint32_t)(1 << NEOLED_CTRL_EN));
|
206 |
62 |
zero_gravi |
}
|
207 |
|
|
|
208 |
|
|
|
209 |
|
|
/**********************************************************************//**
|
210 |
|
|
* Disable NEOLED controller.
|
211 |
|
|
**************************************************************************/
|
212 |
|
|
void neorv32_neoled_disable(void) {
|
213 |
|
|
|
214 |
64 |
zero_gravi |
NEORV32_NEOLED.CTRL &= ~((uint32_t)(1 << NEOLED_CTRL_EN));
|
215 |
62 |
zero_gravi |
}
|
216 |
|
|
|
217 |
|
|
|
218 |
|
|
/**********************************************************************//**
|
219 |
|
|
* Send single RGB(W) data word to NEOLED module (blocking).
|
220 |
52 |
zero_gravi |
*
|
221 |
62 |
zero_gravi |
* @warning This function is blocking as it polls the NEOLED FIFO full flag.
|
222 |
52 |
zero_gravi |
*
|
223 |
62 |
zero_gravi |
* @param[in] data LSB-aligned 24-bit RGB or 32-bit RGBW data
|
224 |
52 |
zero_gravi |
**************************************************************************/
|
225 |
62 |
zero_gravi |
void neorv32_neoled_write_blocking(uint32_t data) {
|
226 |
52 |
zero_gravi |
|
227 |
62 |
zero_gravi |
while(1) { // wait for FIFO full flag to clear
|
228 |
64 |
zero_gravi |
if ((NEORV32_NEOLED.CTRL & (1 << NEOLED_CTRL_TX_FULL)) == 0) {
|
229 |
62 |
zero_gravi |
break;
|
230 |
|
|
}
|
231 |
|
|
}
|
232 |
52 |
zero_gravi |
|
233 |
62 |
zero_gravi |
neorv32_neoled_write_nonblocking(data); // send new LED data
|
234 |
52 |
zero_gravi |
}
|
235 |
|
|
|
236 |
|
|
|
237 |
|
|
/**********************************************************************//**
|
238 |
|
|
* Get NEOLED hardware buffer size.
|
239 |
|
|
*
|
240 |
|
|
* @return Number of entries in NEOLED TX buffer.
|
241 |
|
|
**************************************************************************/
|
242 |
|
|
uint32_t neorv32_neoled_get_buffer_size(void) {
|
243 |
|
|
|
244 |
64 |
zero_gravi |
uint32_t tmp = NEORV32_NEOLED.CTRL;
|
245 |
|
|
tmp = tmp >> NEOLED_CTRL_BUFS_0;
|
246 |
62 |
zero_gravi |
tmp = tmp & 0xf; // isolate buffer size bits
|
247 |
52 |
zero_gravi |
|
248 |
|
|
return (1 << tmp); // num entries = pow(2, buffer size flags)
|
249 |
|
|
}
|