54a50b7a98e6c157ad069b12c0af1d8a2c8dd4ec
[dmxpainter.git] / src / tlc.c
1 #include <avr/io.h>
2
3 #include "tlc.h"
4
5 #include "mcu.h"
6
7 #include "buf.h"
8
9
10 /*********************************************************************/
11 /* Declaration of private constants.                                 */
12
13 #define TLC_N_CHANNELS_PER_TLC 16
14 #define TLC_N_TLCS_PER_PAINTER  3
15
16 #define TLC_N_CHANNELS_PER_PAINTER (TLC_N_TLCS_PER_PAINTER * TLC_N_CHANNELS_PER_TLC)
17
18 #define TLC_N_CHANNELS (N_PAINTER * TLC_N_CHANNELS_PER_PAINTER)
19
20
21 /*********************************************************************/
22 /* Declaration of private global variables.                          */
23
24 /**
25  * Flag to indicate that data is currently shifted out.
26  */
27 static volatile uint8_t shifting_;
28
29
30 /*********************************************************************/
31 /* Declaration of private functions.                                 */
32
33 static void start_gscycle(void);
34
35 static void clock_xlat(void);
36 static void clock_sclk(void);
37 static void set_blnk_on(void);
38 static void set_blnk_off(void);
39 static void set_vprg_gs_mode(void);
40 static void set_vprg_dc_mode(void);
41
42 static void send_dc_data(void);
43 static void send_gs_data(void);
44
45
46 /*********************************************************************/
47 /* Implementation of public interrupts.                              */
48
49 /**
50  * Handler for Output-Compare-Match interrupt on 16-bit timer:
51  * Syncs on GSCLK to start GS cycle.
52  */
53 void tlc_int_timer1_ocma(void)
54 {
55   // First, disable this interrupt.
56   mcu_int_timer1_ocma_disable();
57
58   // Leave BLNK mode (switch on LEDs and start GS cycle).
59   set_blnk_off();
60 }
61
62 /**
63  * Handler for Output-Compare-Match interrupt on 8-bit timer:
64  * Disables PWM when a full GSCK cycle is done.
65  */
66 void tlc_int_timer2_ocm(void)
67 {
68   // Go into BLNK mode (switch off LEDs and reset GSCLK counter)
69   set_blnk_on();
70
71   // Disable GS cycle timeout timer.
72   mcu_int_timer2_ocm_disable();
73
74   // Wait for next DMX packet.
75   shifting_ = 0;
76 }
77
78
79 /*********************************************************************/
80 /* Implementation of public functions.                               */
81
82 void tlc_init(void)
83 {
84   // We have to use the 16-bit timer for the GSCLK and the 8-bit
85   // timer for the timeout even though it would be better the other
86   // way round:  We need the OC2 pin for SPI and thus can generate 
87   // a PWM on OC1A (A because it can use ICR1 for TOP, p85) only.
88   // Do this setup before enabling the output (p86).
89
90   // Timer 1 is for our GSCLK:  We refresh with a GS cycle of
91   // about 100 Hz (cf. Timer 2), ie. each 10 ms.  For each full 
92   // cycle we needed to clock the PWM 4096 times which would be 
93   // a count of about 39 times between the pules:
94   //   n = 16 MHz / (4096 * 100 Hz) = 39.0625
95   // But we have to consider the time it takes to shift out the data
96   // so we don't have 10 ms for 4096 pulses, so we've got to speed 
97   // up, ie. count less clocks.  The count is adapted on demand later
98   // on, we'll initialize it with a reasonable default.
99   mcu_set_timer1_ic(38);
100   // Duty cycle as short as possible (see COM1A below).
101   mcu_set_timer1_ocma(1);
102   // * CS1   =  001: No prescaler. (p100)
103   // * WGM1  = 1110: Fast PWM, TOP at ICR1 (p78, p89, p98)
104   // * COM1A =   10: Set OC1A at 0, clear at OCM1A (p97)
105   // * COM1B =   00: No output on OC1B (p97)
106   TCCR1B = bits_value_indexed(CS1, 0)
107          | bits_value_indexed(WGM1, 3)
108          | bits_value_indexed(WGM1, 2);
109   TCCR1A = bits_value_indexed(WGM1, 1)
110          | bits_value_indexed(COM1A, 1);
111
112   // Timer 2 is the refresh timer which determines the time one GS
113   // cycle is finished; triggers Output Compare Match.
114   // * AS2  =   0: Use IO-clock (16 MHz) for base frequency (p119)
115   // * CS2  = 111: Use a prescaler of 1024 (p119)
116   // * WGM2 =  00: Normal mode, no PWM, count upwards (p117)
117   // * COM2 =  00: Disable Output on OC2, needed for SPI (p117)
118   TCCR2 = bits_value_indexed(CS2, 2)
119         | bits_value_indexed(CS2, 1)
120         | bits_value_indexed(CS2, 0);
121   // With a prescaler of 1024 this timer counts at 15.625 kHz,
122   // to get a 100 Hz clock we need to count 157 times (~ 99.5 Hz)
123   // and refresh after that (that equals to 4 PWM pulses when
124   // ignoring the shifting time).
125   //   n = (16 MHz / 1024) / 100 Hz = 156.25
126   mcu_set_timer2_ocm(156);
127
128   // All these pins write to the painter.
129   pin_out(PIN_TLC_GSCK);
130   pin_out(PIN_TLC_VPRG);
131   pin_out(PIN_TLC_XLAT);
132   pin_out(PIN_TLC_SCLK);
133   pin_out(PIN_TLC_SIN);
134
135   // This one writes too, but has to be initialized blanked
136   // (ie. LEDs off).  The external pullup took care against
137   // flickering on boot.
138   pin_out(PIN_TLC_BLNK);
139   set_blnk_on();
140
141   // Here we could read the return from the painter.
142   pin_in( PIN_TLC_SRTN);
143 }
144
145 void tlc_exec(void)
146 {
147   // If enabled, shift out DC once.
148   #ifdef TLC_DC_ONCE 
149     mcu_debug_on();
150     send_dc_data();
151     clock_xlat();
152   #endif
153 }
154
155 void tlc_update(void)
156 {
157   // TODO: Make this routine iterative.
158   // TODO: Is it possible to shift while GS cycle is active and 
159   //       XLAT when cycle is done?
160
161   // Don't send anything if PWM is still active.
162   if (shifting_) return;
163
164   // Restart and enable 100 Hz-timeout timer now so
165   // it includes the time we need to shift out data.
166   mcu_set_timer2_cnt(0);
167   mcu_int_timer2_ocm_enable();
168
169   // If not disabled, always shift out DC first.
170   #ifndef TLC_DC_ONCE
171     send_dc_data();
172     clock_xlat();
173   #endif
174
175   // No extra SCLK needed, just shift out all GS data.
176   send_gs_data();
177   clock_xlat();
178
179   // A final SCLK to notify 
180   clock_sclk();
181
182   // Start PWM and continue in background...
183   start_gscycle();
184 }
185
186
187 /*********************************************************************/
188 /* Implementation of private functions.                              */
189
190 // XLAT pulse to apply data to internal register.
191 static void clock_xlat(void)
192 {
193   pin_on(PIN_TLC_XLAT);
194   pin_off(PIN_TLC_XLAT);
195 }
196
197 // SCLK pulse to clock in serial data from SIN.
198 static void clock_sclk(void)
199 {
200   pin_on(PIN_TLC_SCLK);
201   pin_off(PIN_TLC_SCLK);
202 }
203
204 static void set_blnk_on(void)
205 {
206   pin_on(PIN_TLC_BLNK);
207 }
208
209 static void set_blnk_off(void)
210 {
211   pin_off(PIN_TLC_BLNK);
212 }
213
214 static void set_vprg_gs_mode(void)
215 {
216   pin_off(PIN_TLC_VPRG);
217 }
218
219 static void set_vprg_dc_mode(void)
220 {
221   pin_on(PIN_TLC_VPRG);
222 }
223
224 /*********************************************************************/
225
226 static void start_gscycle(void)
227 {
228   shifting_ = 1;
229   // Start counter with next GS pulse.
230   mcu_int_timer1_ocma_enable();
231 }
232
233 /*********************************************************************/
234
235 static void shift8(uint8_t byte)
236 {
237   // Shift out all eight bits.
238   for (uint8_t bit = bits_uint8(1, 0, 0, 0, 0, 0, 0, 0); bit; bit >>= 1) {
239     if (byte & bit) {
240       pin_on(PIN_TLC_SIN);
241     } else {
242       pin_off(PIN_TLC_SIN);
243     }
244     clock_sclk();
245   }
246 }
247
248 static void shift12(uint8_t byte)
249 {
250   // The data in the upper 8 bits.
251   shift8(byte);
252
253   // Plus 4 zero bits (makes a shift by 4).
254   pin_off(PIN_TLC_SIN);
255   for (uint8_t bit = 4; bit; bit--) {
256     clock_sclk();
257   }
258 }
259
260 /*********************************************************************/
261
262 static void send_gs_data(void)
263 {
264   // Set VPRG to GS mode.
265   set_vprg_gs_mode();
266   // Because the TLCs are daisy-chained, we have to shift out the RGB data
267   // starting at the end.  Each painter has 3 TLCs (with 16 channels each), 
268   // for the colors red, green, blue.  So we've got to shift out the 16 blue
269   // channels of the last TLC first, then 16 green ones and finally 16 red 
270   // ones.  The last data we shift out is thus the first red of the first
271   // painter.
272   // This will always point to the start of the current painter data, 
273   // starting with the last one.
274   char * painter_gs = buf_gs__
275                     + TLC_N_CHANNELS
276                     - TLC_N_CHANNELS_PER_PAINTER;
277   // Find the current data byte to shift out, starting with the last one.
278   // Its signed so we can determine when we reached the end/start, eight
279   // bit are enough to index 48 channels per painter.
280 #if TLC_N_CHANNELS_PER_PAINTER != 48
281 #error What a weird painter...
282 #endif
283   while (1) {
284     int8_t index = TLC_N_CHANNELS_PER_PAINTER - 1;
285     while (1) {
286       // Shift out current channel.
287       shift12(painter_gs[index]);
288
289       // Skip two colors.
290       index -= 3;
291
292       // If we reached the start, we jump to the next color.
293       if (index < 0) {
294         // Did we just finish the last (ie. red) channel?
295         if (index == -3)
296           break;
297
298         // Jump to end again and skip to next color.
299         index += TLC_N_CHANNELS_PER_PAINTER - 1;
300       }
301     }
302
303     // Did we just finish the last (ie. first) painter?
304     if (painter_gs == buf_gs__)
305       break;
306
307     // Move to next painter.
308     painter_gs -= TLC_N_CHANNELS_PER_PAINTER;
309   }
310 }
311
312 static void send_dc_data(void)
313 {
314   // Set VPRG to DC mode. 
315   set_vprg_dc_mode();
316
317   // All TLCs on all the connected painters will get the same DC value.
318   // That makes it easy to generate the 6-Bit format we need:  We just
319   // create a constant buffer for the packed rgb values, containing four
320   // values for each color.
321   uint8_t dc_out[3][3];
322   for (int8_t rgb = 2; rgb >= 0; rgb--) {
323     uint8_t dc_data = buf_dc__[rgb] & bits_uint8(1, 1, 1, 1, 1, 1, 0, 0);
324     dc_out[rgb][2] = (dc_data << 0) | (dc_data >> 6);
325     dc_out[rgb][1] = (dc_data << 2) | (dc_data >> 4);
326     dc_out[rgb][0] = (dc_data << 4) | (dc_data >> 2);
327   }
328
329   // Now, shift out the dc-data like we do it with the gs-data:  First the
330   // last blue, then green and red of the last painter, until we reach the
331   // first red.
332   int8_t painter = N_PAINTER;
333   do {
334     int8_t rgb = 3 - 1;
335     do {
336       int8_t index = (TLC_N_CHANNELS_PER_TLC / 4) * 3 - 1;
337       do {
338         shift8(dc_out[rgb][index % 3]);
339         index--;
340       } while (index != -1);
341       rgb--;
342     } while (rgb != -1);
343     painter--;
344   } while (painter != 0);
345 }
346
347 /*********************************************************************/