-
Notifications
You must be signed in to change notification settings - Fork 16
/
FAB_LED.h
1948 lines (1716 loc) · 66 KB
/
FAB_LED.h
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
// Fast Addressable LED Library
// Copyright (c)2015 Dan Truong
//
// Licence: limited use is authorized for the purpose of beta testing
//
// The goal of this library is to be very fast, very small and take advantage
// of the relaxed LED timings to allow other work besides bit banging while the
// LEDs are being updated.
// The library allows calling multiple times the same function to repeat
// patterns, and allows inline color palette management to save on memory space
// usage. The palette conversion is done inline as the pixels are being painted.
//
// The bit-banging is being done using GCC built-ins to avoid contrived ASM
// language code blocks support. It should work for any arduino platform of
// 16MHz or more to function.
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
#ifndef FAB_LED_H
#define FAB_LED_H
#include <stdint.h>
#include <Arduino.h>
// This code is sensitive to optimizations if you want to cascade function calls,
// so make the IDE compile at -O2 instead of -Os (size).
#pragma GCC optimize ("-O2")
// static_assert is a built-in C++ 11 assert that Arduino does not seem to support
#ifndef static_assert
#define STATIC_ASSERT4(COND,MSG,LIN) typedef char assert_##MSG##_##LIN[(!!(COND))*2-1]
#define STATIC_ASSERT3(X,M,L) STATIC_ASSERT4(X, M, L)
#define STATIC_ASSERT2(X,M,L) STATIC_ASSERT3(X,M,L)
//#define STATIC_ASSERT(X,M) STATIC_ASSERT2(X,M,__LINE__)
#define STATIC_ASSERT(X,M)
#else
#define SA2TXT2(x) # x
#define SA2TXT(x) SA2TXT2(x)
#define STATIC_ASSERT(X,M) static_assert(X, SA2TXT(M))
#endif
////////////////////////////////////////////////////////////////////////////////
/// @brief typed pixel structures for every LED protocol supported.
/// These simplify access to a pixel byte array, or even to send typed pixels
/// to the LED strip, as the programmer directly access pixel colors by name.
////////////////////////////////////////////////////////////////////////////////
// Pixel colors byte order, 0 and 7 invalid.
#define PT_RGB 0b00100000
#define PT_GRB 0b01000000
#define PT_BGR 0b10000000
//#define PT_RBG 0b11000000
//#define PT_GBR 0b10100000
//#define PT_BRG 0b01100000
#define PT_COL 0b11100000 // Mask for 3-byte colors
#define PT_IS_SAME_COLOR(v1, v2) ((v1) & T_COL == (v2) & T_COL)
// Extra pixels bytes, 0 none, 2 invalid.
#define PT_XXXW 0b00000001 // Postfix white pixel brightness (sk6812)
#define PT_BXXX 0b00000010 // APA 102 prefix brightness pixel 0b111bbbbb
#define PT_XBYT 0b00000011 // Mask for extra byte(s)
#define PT_HAS_WHITE(v) ((v) & PT_XBYT == PT_XXXW)
#define PT_HAS_BRIGHT(v) ((v) & PT_XBYT == PT_BXXX)
#define PT_IS_3B(v) ((v) & PT_XVAL == 0)
#define PT_IS_4B(v) ((v) & PT_XVAL != 0)
// apa102, apa106 native color order
typedef struct rgb_t {
static const uint8_t type = PT_RGB;
union { uint8_t r; uint8_t red; };
union { uint8_t g; uint8_t green; };
union { uint8_t b; uint8_t blue; };
} rgb;
// apa104, ws2812 native color order
typedef struct grb_t {
static const uint8_t type = PT_GRB;
union { uint8_t g; uint8_t green; };
union { uint8_t r; uint8_t red; };
union { uint8_t b; uint8_t blue; };
} grb;
typedef struct bgr_t {
static const uint8_t type = PT_BGR;
union { uint8_t b; uint8_t blue; };
union { uint8_t g; uint8_t green; };
union { uint8_t r; uint8_t red; };
} bgr;
// sk6812 native color order
typedef struct rgbw_t {
static const uint8_t type = PT_RGB | PT_XXXW;
union { uint8_t r; uint8_t red; };
union { uint8_t g; uint8_t green; };
union { uint8_t b; uint8_t blue; };
union { uint8_t w; uint8_t white; };
} rgbw;
// sk6812 native color order
typedef struct grbw_t {
static const uint8_t type = PT_GRB | PT_XXXW;
union { uint8_t g; uint8_t green; };
union { uint8_t r; uint8_t red; };
union { uint8_t b; uint8_t blue; };
union { uint8_t w; uint8_t white; };
} grbw;
// apa102 native color order
typedef struct hbgr_t {
static const uint8_t type = PT_BGR | PT_BXXX;
union { uint8_t B; uint8_t brightness;
uint8_t w; uint8_t white;
uint8_t h; uint8_t header; };
union { uint8_t b; uint8_t blue; };
union { uint8_t g; uint8_t green; };
union { uint8_t r; uint8_t red; };
} hbgr;
////////////////////////////////////////////////////////////////////////////////
/// @brief Helper macro for palette index encoding into a char * array when
/// using an 8bit or less per pixel with a uint8_t type.
////////////////////////////////////////////////////////////////////////////////
/// @brief computes the size of a uint8_t array that uses pixels encoded with a
/// palette. For example: uint8_t buffer[ARRAY_SIZE(128, 2)]; is an array of 128
/// pixels encoded with 2 bits per pixel (4 colors).
#define ARRAY_SIZE(numPixels, bitsPerPixel) (((numPixels)+7) / 8 * (bitsPerPixel))
/// @brief Encode a pixel's color
/// For example, for encoding colors on 2 bits (4 colors, 0,1,2,3, in the palette),
/// Encoding color #3, using 2 bits per pixels, in the buffer for pixel i:
/// SET_PIXEL(buffer, i, 2, 3);
#define SET_PIXEL(array, index, bitsPerPixel, color) \
_SET_PIXEL((array), (index), (bitsPerPixel), (color))
/// @brief extract a pixel's palette color index from a pixel array
/// For example, colorIndex = GET_PIXEL(buffer, i, 2);
#define GET_PIXEL(array, index, bitsPerPixel) \
_GET_PIXEL((array), (index), (bitsPerPixel))
// Internal definitions
#define _SET_PIXEL(array, index, bitsPerPixel, color) \
array[index/(8/bitsPerPixel)] = ( \
array[index/(8/bitsPerPixel)] & \
~(((1<<bitsPerPixel)-1) << ((index * bitsPerPixel)%8)) \
) | color << ((index * bitsPerPixel)%8)
#define _GET_PIXEL(array, index, bitsPerPixel) ( \
array[index/(8/bitsPerPixel)] >>(index*bitsPerPixel)%8 \
) & ((1<<bitsPerPixel)-1)
////////////////////////////////////////////////////////////////////////////////
/// @brief Conversion between cycles and nano seconds
////////////////////////////////////////////////////////////////////////////////
#define NS_PER_SEC 1000000000ULL
#define CYCLES_PER_SEC ((uint64_t) (F_CPU))
#define CYCLES(time_ns) (((CYCLES_PER_SEC * (time_ns)) + NS_PER_SEC - 1ULL) / NS_PER_SEC)
#define NANOSECONDS(cycles) (((cycles) * NS_PER_SEC + CYCLES_PER_SEC-1) / CYCLES_PER_SEC)
////////////////////////////////////////////////////////////////////////////////
/// @brief definitions for class template specializations
////////////////////////////////////////////////////////////////////////////////
/// @brief AVR ports are referenced A through F. For example ws2812b<D,6>
enum avrLedStripPort {
A = 1,
B = 2,
C = 3,
D = 4,
E = 5,
F = 6
};
/// @brief Pixel type declares the byte order for every color of the LED strip
/// when using 24/32 bit typed pixels
enum pixelFormat {
NONE = 0, // Defaults to 3 bytes per pixel of unspecified order
RGB = 1,
GRB = 2,
BGR = 3,
RGBW = 4,
GRBW = 5,
HBGR = 6
};
#define IS_PIXEL_FORMAT_3B(color) (color < RGBW)
#define IS_PIXEL_FORMAT_4B(color) (color >= RGBW)
/// @brief Type of low-level method to send data for the LED strip (see sendBytes)
enum ledProtocol {
ONE_PORT_BITBANG = 1, // Any LED with single data line
TWO_PORT_SPLIT_BITBANG = 2, // Same, but update 2 ports in parallel, sending 1/2 the array to one port, and the other 1/2 to the other
TWO_PORT_INTLV_BITBANG = 3, // Same, but update 2 ports in parallel, interleaving the pixels of the array
EIGHT_PORT_BITBANG = 4, // Experimental
ONE_PORT_PWM = 5, // Not implemented
ONE_PORT_UART = 6, // Not implemented
SPI_BITBANG = 7, // APA-102 and any LED with data and clock line
SPI_HARDWARE = 8 // Not implemented
};
#define PROTOCOL_SPI SPI_BITBANG
////////////////////////////////////////////////////////////////////////////////
/// @brief Hack to survive undefined port on Arduino
/// avoid compilation errors for arduinos that are missing some of the 4 ports
/// by defining all the unknown ports to be any of the known ones. This quiets
/// the compiler, and that fluff code optimizes away.
////////////////////////////////////////////////////////////////////////////////
// Define a DUMMY_PORT_ID that will be used to patch unknown ports to map to
// the first existing port we find. Undefined ports won't be used but this
// lets the compiler work without complaining.
#ifndef ARDUINO_ARCH_MEGAAVR
#if defined(PORTD)
#define DUMMY_PORT PORTD
#define DUMMY_DDR DDRD
#elif defined(PORTB)
#define DUMMY_PORT PORTB
#define DUMMY_DDR DDRB
#elif defined(PORTA)
#define DUMMY_PORT PORTA
#define DUMMY_DDR DDRA
#elif defined(PORTC)
#define DUMMY_PORT PORTC
#define DUMMY_DDR DDRC
#endif // PORT
// If any of the ports we support does not exist, re-map it to the dummy port.
#ifdef DUMMY_PORT
#ifndef PORTA
#define PORTA DUMMY_PORT
#define DDRA DUMMY_DDR
#endif // PORTA
#ifndef PORTB
#define PORTB DUMMY_PORT
#define DDRB DUMMY_DDR
#endif // PORTB
#ifndef PORTC
#define PORTC DUMMY_PORT
#define DDRC DUMMY_DDR
#endif // PORTC
#ifndef PORTD
#define PORTD DUMMY_PORT
#define DDRD DUMMY_DDR
#endif // PORTD
#ifndef PORTE
#define PORTE DUMMY_PORT
#define DDRE DUMMY_DDR
#endif // PORTE
#ifndef PORTF
#define PORTF DUMMY_PORT
#define DDRF DUMMY_DDR
#endif // PORTF
#endif // DUMMY_PORT
#else
// For modern AVRs (AVRxt instructionset variant, new style peripherals)
// which Arduino calls "megaavr" despite the fact that Microchip already used
// that term to refer to anything with ATmega in the name and most "megaavr"
// parts are not part of the megaAVR product line (they're tinyAVR or AVR Dx)
// These parts ALL have at least some of the pins in PORTA present (starting with
// the first letter? A novel concept!), so we can assume the existence of VPORTA
// Using "flattened" names instead of the structs since that can cause problems
// in rare cases. (ie, VPORTA_OUT instead of VPORTA.OUT).
#define DUMMY_PORT VPORTA_OUT
#define DUMMY_DDR VPORTA_DIR
#ifndef VPORTB
#define VPORTB_OUT DUMMY_PORT
#define VPORTB_DIR DUMMY_DDR
#endif
#ifndef VPORTC
#define VPORTC_OUT DUMMY_PORT
#define VPORTC_DIR DUMMY_DDR
#endif
#ifndef VPORTD
#define VPORTD_OUT DUMMY_PORT
#define VPORTD_DIR DUMMY_DDR
#endif
#ifndef VPORTE
#define VPORTE_OUT DUMMY_PORT
#define VPORTE_DIR DUMMY_DDR
#endif
#ifndef VPORTF
#define VPORTF_OUT DUMMY_PORT
#define VPORTF_DIR DUMMY_DDR
#endif
#ifndef VPORTG
#define VPORTG_OUT DUMMY_PORT
#define VPORTG_DIR DUMMY_DDR
#endif
#endif
////////////////////////////////////////////////////////////////////////////////
#ifdef ARDUINO_ARCH_AVR
////////////////////////////////////////////////////////////////////////////////
/// @brief Arduino AVR low level macros
////////////////////////////////////////////////////////////////////////////////
/// Port Data Direction control Register address
#define AVR_DDR(id) _AVR_DDR((id))
#define _AVR_DDR(id) ((id==A) ? DDRA : (id==B) ? DDRB : (id==C) ? DDRC : \
(id==D) ? DDRD : (id==E) ? DDRE : DDRF)
#define SET_DDR_HIGH( portId, portPin) AVR_DDR(portId) |= 1U << portPin
#define FAB_DDR(portId, val) AVR_DDR(portId) = val
/// Port address & pin level manipulation
#define AVR_PORT(id) _AVR_PORT((id))
#define _AVR_PORT(id) ((id==A) ? PORTA : (id==B) ? PORTB : (id==C) ? PORTC : \
(id==D) ? PORTD : (id==E) ? PORTE : PORTF)
#define FAB_PORT(portId, val) AVR_PORT(portId) = val
// Note: gcc converts these bit manipulations to sbi and cbi instructions
#define SET_PORT_HIGH(portId, portPin) AVR_PORT(portId) |= 1U << portPin
#define SET_PORT_LOW( portId, portPin) AVR_PORT(portId) &= ~(1U << portPin);
/// Method to optimally delay N cycles with nops for bitBang.
#define DELAY_CYCLES(count) if (count > 0) __builtin_avr_delay_cycles(count);
// Number of cycles sbi and cbi instructions take when using SET macros
const int sbiCycles = 2;
const int cbiCycles = 2;
#define DISABLE_INTERRUPTS {uint8_t oldSREG = SREG; __builtin_avr_cli()
#define RESTORE_INTERRUPTS SREG = oldSREG; }
////////////////////////////////////////////////////////////////////////////////
#elif defined(ARDUINO_ARCH_MEGAAVR)
////////////////////////////////////////////////////////////////////////////////
/// @brief AVRxt (tinyAVR 0/1/2, megaAVR 0, and AVR Dx-series) low level macros
////////////////////////////////////////////////////////////////////////////////
// All existing AVRxt devices, as well as any that they could release without
// doing something about the fact that they are out of registers in the low IO
// space after PORTG (the last 4 contain the GPIOR aka GPR registers) should be
// supported by this? -@SpenceKonde 2/17/2021.
/// Port Data Direction control Register address
#define AVR_DDR(id) _AVR_DDR((id))
#define _AVR_DDR(id) ((id==A) ? VPORTA_DIR : (id==B) ? VPORTB_DIR : (id==C) ? VPORTC_DIR : \
(id==D) ? VPORTD_DIR : (id==E) ? VPORTE_DIR : VPORTF_DIR )
#define SET_DDR_HIGH( portId, portPin) AVR_DDR(portId) |= 1U << portPin
#define FAB_DDR(portId, val) AVR_DDR(portId) = val
/// Port address & pin level manipulation
#define AVR_PORT(id) _AVR_PORT((id))
#define _AVR_PORT(id) ((id==A) ? VPORTA_OUT : (id==B) ? VPORTB_OUT : (id==C) ? VPORTC_OUT : \
(id==D) ? VPORTD_OUT : (id==E) ? VPORTE_OUT : VPORTF_OUT)
#define FAB_PORT(portId, val) AVR_PORT(portId) = val
// Note: gcc converts these bit manipulations to sbi and cbi instructions
#define SET_PORT_HIGH(portId, portPin) AVR_PORT(portId) |= 1U << portPin
#define SET_PORT_LOW( portId, portPin) AVR_PORT(portId) &= ~(1U << portPin);
/// Method to optimally delay N cycles with nops for bitBang.
#define DELAY_CYCLES(count) if (count > 0) __builtin_avr_delay_cycles(count);
// Number of cycles sbi and cbi instructions take when using SET macros
// AVRxt has single cycle sbi and cbi (yqaaay!)
const int sbiCycles = 1;
const int cbiCycles = 1;
#define DISABLE_INTERRUPTS {uint8_t oldSREG = SREG; __builtin_avr_cli()
#define RESTORE_INTERRUPTS SREG = oldSREG; }
////////////////////////////////////////////////////////////////////////////////
#elif defined(__arm__)
////////////////////////////////////////////////////////////////////////////////
/// @brief ARM0 - ARM3 low level macros
/// @note: Ports have no letter, just port pins. ws2812b<D,6> will ignore D and
/// just route to pin 6.
///
/// Register information:
/// http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0337h/BABJFFGJ.html
/// DWT_CYCCNT: Cycle count register
////////////////////////////////////////////////////////////////////////////////
/// @todo THE debug() function template resolution does not work on non optimized teensy
//#define DISABLE_DEBUG_METHOD
#define SET_DDR_HIGH( portId, portPin)
#define FAB_DDR( portId, val)
#define FAB_PORT(portId, val)
#define SET_PORT_HIGH(portId, pinId) digitalWriteFast(pinId, 1)
#define SET_PORT_LOW( portId, pinId) digitalWriteFast(pinId, 0)
/// Delay N cycles using cycles register
#define DELAY_CYCLES(count) {int till = count + ARM_DWT_CYCCNT; while (ARM_DWT_CYCCNT < till);}
// Number of cycles sbi and cbi instructions take
const int sbiCycles = 2;
const int cbiCycles = 2;
#define DISABLE_INTERRUPTS {uint8_t oldSREG = SREG; cli()
#define RESTORE_INTERRUPTS SREG = oldSREG; }
//mov r0, #COUNT
//L:
//subs r0, r0, #1
//bnz L
#define MACRO_CMB( A , B) A##B
#define M_RPT(__N, __macro) MACRO_CMB(M_RPT, __N)(__macro)
#define M_RPT0(__macro)
#define M_RPT1(__macro) M_RPT0(__macro) __macro(0)
#define M_RPT2(__macro) M_RPT1(__macro) __macro(1)
//...
#define MY_NOP(__N) __asm ("nop");
#define delay150cycles M_RPT(150, MY_NOP);
////////////////////////////////////////////////////////////////////////////////
#elif defined(ESP8266)
#error "Unsupported Tensilica (ARC)Architecture"
#else
////////////////////////////////////////////////////////////////////////////////
/// @brief unknown processor architecture
////////////////////////////////////////////////////////////////////////////////
#error "Unsupported Architecture"
////////////////////////////////////////////////////////////////////////////////
#endif // CPU ARCHITECTURE
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
// Base class defining LED strip operations allowed.
////////////////////////////////////////////////////////////////////////////////
static const uint8_t blank[3] = {128,128,128};
#define FAB_TDEF int16_t high1, \
int16_t low1, \
int16_t high0, \
int16_t low0, \
uint32_t minMsRefresh, \
avrLedStripPort dataPortId, \
uint8_t dataPortPin, \
avrLedStripPort clockPortId,\
uint8_t clockPortPin, \
pixelFormat colors, \
ledProtocol protocol
#define FAB_TVAR high1, low1, high0, low0, minMsRefresh, dataPortId, dataPortPin, clockPortId, clockPortPin, colors, protocol
/// @brief Class to drive LED strips. Relies on custom sendBytes() method to push data to LEDs
//template<
// int16_t high1, // Number of cycles high for logical one
// int16_t low1, // Number of cycles low for logical one
// int16_t high0, // Number of cycles high for logical zero
// int16_t low0, // Number of cycles low for logical zero
// uint32_t minMsRefresh, // Minimum milliseconds to wait to reset LED strip data stream
// avrLedStripPort dataPortId, // AVR port the LED strip is attached to
// uint8_t dataPortPin // AVR port bit the LED strip is attached to
//>
template <FAB_TDEF>
class avrBitbangLedStrip
{
static const uint8_t bytesPerPixel = IS_PIXEL_FORMAT_3B(colors) ? 3 : 4;
public:
////////////////////////////////////////////////////////////////////////
/// @brief Constructor: Set selected dataPortId.dataPortPin to digital output
////////////////////////////////////////////////////////////////////////
avrBitbangLedStrip();
////////////////////////////////////////////////////////////////////////
~avrBitbangLedStrip() { };
////////////////////////////////////////////////////////////////////////
/// @brief Prints to console the configuration
/// @note You must implement the print routines (see example)
////////////////////////////////////////////////////////////////////////
template <void printChar(const char *),void printInt(uint32_t)>
#ifndef DISABLE_DEBUG_METHOD
static inline void debug(void);
#endif
////////////////////////////////////////////////////////////////////////
/// @brief Sends N bytes to the LED using bit-banging.
///
/// @param[in] count Number of bytes sent
/// @param[in] array Array of bytes to send
///
/// @warning
/// The caller must handle interupts!
/// If interupts are not off, the timer interupt will happen, and it takes
/// too long and will cause a LED strip reset.
///
/// @note
/// __attribute__ ((always_inline)) forces gcc to inline this function in
/// the caller, to optimize there and avoid function call overhead. The
/// timing is critical at 16MHz.
/// @note
/// __builtin_avr_delay_cycles() is a gcc built-in that will generate ASM
/// to implement the exact number of cycle delays specified using the most
/// compact instruction loop, and is portable.
/// @note
/// The AVR port bit-set math will be changed by gcc to a sbi/cbi in ASM
////////////////////////////////////////////////////////////////////////
static inline void
sendBytes(const uint16_t count, const uint8_t * array)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Sends N uint32_t in a row set to zero or 0xFFFFFFFF, to build
/// a frame for each pixel, and for a whole strip, SPI protocol only
////////////////////////////////////////////////////////////////////////
static inline void
spiSoftwareSendFrame(const uint16_t count, bool high)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @bried Implements sendBytes for the 1-port SPI protocol
////////////////////////////////////////////////////////////////////////
static inline void
spiSoftwareSendBytes(const uint16_t count, const uint8_t * array)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Implements sendBytes for the 1-ports protocol
////////////////////////////////////////////////////////////////////////
static inline void
onePortSoftwareSendBytes(const uint16_t count, const uint8_t * array)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Implements sendBytes for the 2-ports protocol
////////////////////////////////////////////////////////////////////////
static inline void
twoPortSoftwareSendBytes(const uint16_t count, const uint8_t * array)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Implements sendBytes for the 8-ports protocol
////////////////////////////////////////////////////////////////////////
static inline void
eightPortSoftwareSendBytes(const uint16_t count, const uint8_t * array)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Clears the LED strip
/// @param[in] numPixels Number of pixels to erase
////////////////////////////////////////////////////////////////////////
static inline void clear( const uint16_t numPixels)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Sets the LED strip to a grey value
/// @param[in] numPixels Number of pixels to erase
/// @param[in] value Brightness of the grey [0..255]
////////////////////////////////////////////////////////////////////////
static inline void grey(
const uint16_t numPixels,
const uint8_t value)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Sends an array of 32bit words encoding 0x00bbrrgg to the LEDs
/// This is the standard encoding for most libraries and wastes 25% of
/// the SRAM.
///
/// @param[in] numPixels Number of pixels to write
/// @param[in] array Array of 1 word per pixels in native order
/// (most significant byte is ignored)
////////////////////////////////////////////////////////////////////////
static inline void sendPixels(
const uint16_t numPixels,
const uint32_t * pixelArray)
__attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Sends 3-byte pixels to the LED strip.
/// This function should be the most common used method.
///
/// @note for SK6812, which uses 4 bytes per pixels, this method will send
/// 4 bytes per pixel and expect an array containing 4 bytes per pixel.
/// @param[in] numPixels Number of pixels to write
/// @param[in] array Array of 3-bytes per pixels in native order
/// (for example GBR for WS2812B LED strips)
////////////////////////////////////////////////////////////////////////
static inline void sendPixels(
const uint16_t numPixels,
const uint8_t * array) __attribute__ ((always_inline));
static inline void sendPixels(
const uint16_t numPixels,
const rgbw * array) __attribute__ ((always_inline));
static inline void sendPixels(
const uint16_t numPixels,
const grbw * array) __attribute__ ((always_inline));
static inline void sendPixels(
const uint16_t numPixels,
const hbgr * array) __attribute__ ((always_inline));
static inline void sendPixels(
const uint16_t numPixels,
const rgb * array) __attribute__ ((always_inline));
static inline void sendPixels(
const uint16_t numPixels,
const grb * array) __attribute__ ((always_inline));
static inline void sendPixels(
const uint16_t numPixels,
const bgr * array) __attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Sends an array of bits encoded with a palette to the LEDs.
/// This is a compact method to store patterns, compressed 3x to 24x,
/// but with the overhead of a palette array.
///
/// @param[in] count Size of the array in bytes
/// @param[in] array Array of bitsPerPixel bits per pixels, where the
/// number of bits is 1,2, 4 or 8.
/// @param[in] palette Palette array with one entry per color used.
///
/// 1bit -> 6B palette
/// 2bits -> 12B palette
/// 4bits -> 48B palette
/// 8bits -> 768B palette
///
/// @note bitsPerPixel is a template constant to allow the compiler to
/// optimize the bit-masking code.
////////////////////////////////////////////////////////////////////////
template <const uint8_t bitsPerPixel, class pixelColors> // @note does not support uint32_t uint8_t.
static inline void sendPixels (
const uint16_t count,
const uint8_t * pixelArray,
const uint8_t * reds,
const uint8_t * greens,
const uint8_t * blues) __attribute__ ((always_inline));
template <const uint8_t bitsPerPixel>
static inline void sendPixels (
const uint16_t count,
const uint8_t * pixelArray,
const uint8_t * palette) __attribute__ ((always_inline));
template <const uint8_t bitsPerPixel, class paletteColors>
static inline void sendPixels (
const uint16_t count,
const uint8_t * pixelArray,
const paletteColors * palette) __attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Send an array that is remapped to a physical LED strip
/// of a different layout than the natural layout of the pixel array
/// @param[in] pixelMap An array mapping a physical pixel to an offset
/// in the array pixelMap[pix] = index
/// Note: the array size is not used as it is expected that it will be
/// at least as big as the largest index in the pixel map.
////////////////////////////////////////////////////////////////////////
template <class pixelType>
static inline void sendPixelsRemap(
const uint16_t numPixels,
const uint16_t * pixelMap,
const pixelType * array) __attribute__ ((always_inline));
template <const uint8_t bitsPerPixel, class pixelType>
static inline void sendPixelsRemap (
const uint16_t numPixels,
const uint16_t * pixelMap,
const uint8_t * pixelArray,
const pixelType * palette) __attribute__ ((always_inline));
template <const uint8_t bitsPerPixel, class pixelType>
static inline void sendPixelsRemap (
const uint8_t numPixels,
const uint8_t * pixelMap,
const uint8_t * pixelArray,
const pixelType * palette) __attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Sends an array of 3 pixels per 16bit words to the LEDs
/// This yelds 32K colors, and saves 33% RAM without using a palette.
///
/// the SRAM.
/// @brief Sends an array of 16-bit words to the LEDs. Each word encodes
/// one pixel with 64 levels (5 bits)
//
/// @note brightness is a template constant that controls the unused 3
/// bits of the color. Its value is from zero to 2. Often set to 0 when
/// LED strip is too bright.
////////////////////////////////////////////////////////////////////////
template <uint8_t brightness>
static inline void sendPixels(int count, uint16_t * pixelArray) __attribute__ ((always_inline));
////////////////////////////////////////////////////////////////////////
/// @brief Waits long enough to trigger a LED strip reset
////////////////////////////////////////////////////////////////////////
static inline void refresh() {
if (protocol == SPI_BITBANG) {
// SPI: Reset LED strip to accept a refresh with 32bit start frame
// set to zero, and an end frame set to 0 or 0xFF (we use zero)
// of 16B supporting up to 256 pixels
spiSoftwareSendFrame(4+16, false);
} else {
// 1-wire: Delay next pixels to cause a refresh
delay(minMsRefresh);
}
}
};
////////////////////////////////////////////////////////////////////////////////
/// Class methods definition
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////
template<FAB_TDEF>
avrBitbangLedStrip<FAB_TVAR>::avrBitbangLedStrip()
{
// Digital out pin mode
// bitSet(portDDR, dataPortPin);
// DDR? |= 1U << dataPortPin;
switch (protocol) {
case TWO_PORT_SPLIT_BITBANG:
case TWO_PORT_INTLV_BITBANG:
// Init two ports as out, set to low state
SET_DDR_HIGH(dataPortId, dataPortPin);
SET_DDR_HIGH(clockPortId, clockPortPin);
SET_PORT_LOW(dataPortId, dataPortPin);
SET_PORT_LOW(clockPortId, clockPortPin);
break;
case EIGHT_PORT_BITBANG:
FAB_DDR(dataPortId, 0xFF); // all pins out
FAB_PORT(dataPortId, 0x00); // all pins low
break;
case SPI_BITBANG:
// Init both ports as out
SET_DDR_HIGH(dataPortId, dataPortPin);
SET_DDR_HIGH(clockPortId, clockPortPin);
// SPI: Reset LED strip to accept a refresh
spiSoftwareSendFrame(16, false);
break;
default:
// Init data port as out, set to low state
SET_DDR_HIGH(dataPortId, dataPortPin);
SET_PORT_LOW(dataPortId, dataPortPin);
break;
}
};
#ifndef DISABLE_DEBUG_METHOD
template<FAB_TDEF>
template <void printChar(const char *),void printInt(uint32_t)>
inline void
avrBitbangLedStrip<FAB_TVAR>::debug(void)
{
printChar("\nclass avrBitbangLedStrip<...>\n");
printInt(CYCLES_PER_SEC/1000000);
printChar("MHz CPU, ");
printInt(NANOSECONDS(1000));
printChar(" picoseconds per cycle\n");
printChar("ONE HIGH=");
printInt(high1);
printChar(" LOW=");
printInt(low1);
printChar(" cycles\n");
printChar("ZERO HIGH=");
printInt(high0);
printChar(" LOW=");
printInt(low0);
printChar(" cycles\n");
switch (colors) {
case NONE: printChar("NONE"); break;
case RGB: printChar("RGB"); break;
case GRB: printChar("GRB"); break;
case BGR: printChar("BGR"); break;
case RGBW: printChar("RGBW"); break;
case GRBW: printChar("GRBW"); break;
case HBGR: printChar("HBGR"); break;
default: printChar("ERROR!"); break;
}
printChar(" REFRESH MSEC=");
printInt(minMsRefresh);
printChar("\nDATA_PORT ");
switch(dataPortId) {
case A:
printChar("A.");
break;
case B:
printChar("B.");
break;
case C:
printChar("C.");
break;
case D:
printChar("D.");
break;
case E:
printChar("E.");
break;
case F:
printChar("F.");
break;
default:
printChar("UNKNOWN.");
}
printInt(dataPortPin);
printChar(", ");
if (protocol >= PROTOCOL_SPI) {
printChar("CLOCK_PORT ");
switch(clockPortId) {
case A:
printChar("A.");
break;
case B:
printChar("B.");
break;
case C:
printChar("C.");
break;
case D:
printChar("D.");
break;
case E:
printChar("E.");
break;
case F:
printChar("F.");
break;
default:
printChar("UNKNOWN.");
}
printInt(clockPortPin);
printChar(", ");
}
switch(protocol) {
case ONE_PORT_BITBANG:
printChar("ONE-PORT (bitbang)");
break;
case TWO_PORT_SPLIT_BITBANG:
printChar("TWO-PORT-SPLIT (bitbang)");
break;
case TWO_PORT_INTLV_BITBANG:
printChar("TWO-PORT-INTERLEAVED (bitbang)");
break;
case EIGHT_PORT_BITBANG:
printChar("HEIGHT-PORT (bitbang)");
break;
case ONE_PORT_PWM:
printChar("ONE-PORT (PWM)");
break;
case ONE_PORT_UART:
printChar("ONE-PORT (UART)");
break;
case SPI_BITBANG:
printChar("SPI (bitbang)");
break;
case SPI_HARDWARE:
printChar("SPI (hardware)");
break;
default:
printChar("PROTOCOL UNKNOWN");
}
printChar("\n");
}
#endif
template<FAB_TDEF>
inline void
avrBitbangLedStrip<FAB_TVAR>::sendBytes(const uint16_t count, const uint8_t * array)
{
switch (protocol) {
case ONE_PORT_BITBANG:
onePortSoftwareSendBytes(count, array);
break;
case TWO_PORT_SPLIT_BITBANG:
case TWO_PORT_INTLV_BITBANG:
// Note: the function will detect and handle modes I and S
twoPortSoftwareSendBytes(count, array);
break;
case EIGHT_PORT_BITBANG:
eightPortSoftwareSendBytes(count, array);
break;
case SPI_BITBANG:
spiSoftwareSendBytes(count, array);
break;
}
}
template<FAB_TDEF>
inline void
avrBitbangLedStrip<FAB_TVAR>::spiSoftwareSendFrame(const uint16_t count, bool high)
{
if (high) {
SET_PORT_HIGH(dataPortId, dataPortPin);
} else {
SET_PORT_LOW(dataPortId, dataPortPin);
}
// for(uint32_t c = 0; c < 32 * count; c++) {
for(uint32_t c = 0; c < 8 * count; c++) {
SET_PORT_LOW(clockPortId, clockPortPin);
SET_PORT_HIGH(clockPortId, clockPortPin);
}
}
template<FAB_TDEF>
inline void
avrBitbangLedStrip<FAB_TVAR>::spiSoftwareSendBytes(const uint16_t count, const uint8_t * array)
{
for(uint16_t cnt = 0; cnt < count; ++cnt) {
const uint8_t val = array[cnt];
// If LED strip is defined as 3 byte type (default) then hard code the first
// byte to 0xFF, aka max brightness.
// This hard-codes the APA-102 protocol here so it is a bit hacky.
if (IS_PIXEL_FORMAT_4B(colors) && ((cnt % 3) == 0)) {
// spiSoftwareSendFrame(1, true);
}
// To send a bit to SPI, set its value, then transtion clock low-high
for(int8_t b=7; b>=0; b--) {
const bool bit = (val>>b) & 0x1;
SET_PORT_LOW(clockPortId, clockPortPin);
if (bit) {
SET_PORT_HIGH(dataPortId, dataPortPin);
} else {
SET_PORT_LOW(dataPortId, dataPortPin);
}
SET_PORT_HIGH(clockPortId, clockPortPin);
}
}
}
/// @brief sends the array split across two ports each having half the LED strip to illuminate.
/// To achieve this, we repurpose the clock port used for SPI as a second data port.
/// We support two protocols:
/// TWO_PORT_SPLIT_BITBANG: The array is split into 2 halves sent each sent to one of the ports
/// TWO_PORT_INTLV_BITBANG: The array is interleaved and each pixel of 3 byte is sent to the next port
template<FAB_TDEF>
inline void
avrBitbangLedStrip<FAB_TVAR>::twoPortSoftwareSendBytes(const uint16_t count, const uint8_t * array)
{
// Number of bytes per pixel
const uint16_t bpp = IS_PIXEL_FORMAT_3B(colors) ? 3 : 4;
// If split mode, we send a block of half size
const uint16_t blockSize = (protocol == TWO_PORT_SPLIT_BITBANG) ? count/2 : count;
// Stride is two for interlacing to jump pixels going to the other port
const uint8_t stride = (protocol == TWO_PORT_SPLIT_BITBANG) ? 1 : 2;
const uint8_t increment = stride * bpp;
// Loop to scan all pixels, potentially skipping every other pixel, or scanning 1/2 the pixels
// based on the display protocol used.
for(uint16_t pix = 0; pix < blockSize; pix += increment) {
// Loop to send 3 or 4 bytes of a pixel to the same port
for(uint16_t pos = pix; pos < pix+bpp; pos++) {
for(int8_t bit = 7; bit >= 0; bit--) {
const uint8_t mask = 1 << bit;
volatile bool isbitDhigh = array[pos] & mask;
volatile bool isbitChigh = (protocol == TWO_PORT_SPLIT_BITBANG) ?
array[pos + blockSize] & mask : // split: pixel is blockSize away.
array[pos + bpp] & mask; // interleaved: pixel is next one.
if (isbitDhigh) SET_PORT_HIGH(dataPortId, dataPortPin);
if (isbitChigh) SET_PORT_HIGH(clockPortId, clockPortPin);
if (!isbitDhigh) {
SET_PORT_HIGH(dataPortId, dataPortPin);
DELAY_CYCLES(high0 - sbiCycles);
SET_PORT_LOW(dataPortId, dataPortPin);
}
if (!isbitChigh) {
SET_PORT_HIGH(clockPortId, clockPortPin);
DELAY_CYCLES(high0 - sbiCycles);