FastLED 3.6.0
Loading...
Searching...
No Matches
fastspi.h
Go to the documentation of this file.
1
3
4#ifndef __INC_FASTSPI_H
5#define __INC_FASTSPI_H
6
7#include "FastLED.h"
8
9#include "controller.h"
10#include "lib8tion.h"
11
12#include "fastspi_bitbang.h"
13
14FASTLED_NAMESPACE_BEGIN
15
16#if defined(FASTLED_TEENSY3) && (F_CPU > 48000000)
17#define DATA_RATE_MHZ(X) (((48000000L / 1000000L) / X))
18#define DATA_RATE_KHZ(X) (((48000000L / 1000L) / X))
19#elif defined(FASTLED_TEENSY4) || (defined(ESP32) && defined(FASTLED_ALL_PINS_HARDWARE_SPI)) || (defined(ESP8266) && defined(FASTLED_ALL_PINS_HARDWARE_SPI))
20// just use clocks
21#define DATA_RATE_MHZ(X) (1000000 * (X))
22#define DATA_RATE_KHZ(X) (1000 * (X))
23#else
25#define DATA_RATE_MHZ(X) ((F_CPU / 1000000L) / X)
27#define DATA_RATE_KHZ(X) ((F_CPU / 1000L) / X)
28#endif
29
31//
32// External SPI template definition with partial instantiation(s) to map to hardware SPI ports on platforms/builds where the pin
33// mappings are known at compile time.
34//
36
37#if !defined(FASTLED_ALL_PINS_HARDWARE_SPI)
39template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
40class SPIOutput : public AVRSoftwareSPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
41#endif
42
44template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
45class SoftwareSPIOutput : public AVRSoftwareSPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
46
47#ifndef FASTLED_FORCE_SOFTWARE_SPI
48
49#if defined(NRF51) && defined(FASTLED_ALL_PINS_HARDWARE_SPI)
50template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
51class SPIOutput : public NRF51SPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
52#endif
53
54#if defined(NRF52_SERIES) && defined(FASTLED_ALL_PINS_HARDWARE_SPI)
55template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
56class SPIOutput : public NRF52SPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
57#endif
58
59#if defined(FASTLED_APOLLO3) && defined(FASTLED_ALL_PINS_HARDWARE_SPI)
60template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
61class SPIOutput : public APOLLO3HardwareSPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
62#endif
63
64#if defined(ESP32) && defined(FASTLED_ALL_PINS_HARDWARE_SPI)
65template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
66class SPIOutput : public ESP32SPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
67#endif
68
69#if defined(ESP8266) && defined(FASTLED_ALL_PINS_HARDWARE_SPI)
70template<uint8_t _DATA_PIN, uint8_t _CLOCK_PIN, uint32_t _SPI_CLOCK_DIVIDER>
71class SPIOutput : public ESP8266SPIOutput<_DATA_PIN, _CLOCK_PIN, _SPI_CLOCK_DIVIDER> {};
72#endif
73
74#if defined(SPI_DATA) && defined(SPI_CLOCK)
75
76#if defined(FASTLED_TEENSY3) && defined(ARM_HARDWARE_SPI)
77
78template<uint32_t SPI_SPEED>
79class SPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> : public ARMHardwareSPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED, 0x4002C000> {};
80
81#if defined(SPI2_DATA)
82
83template<uint32_t SPI_SPEED>
84class SPIOutput<SPI2_DATA, SPI2_CLOCK, SPI_SPEED> : public ARMHardwareSPIOutput<SPI2_DATA, SPI2_CLOCK, SPI_SPEED, 0x4002C000> {};
85
86template<uint32_t SPI_SPEED>
87class SPIOutput<SPI_DATA, SPI2_CLOCK, SPI_SPEED> : public ARMHardwareSPIOutput<SPI_DATA, SPI2_CLOCK, SPI_SPEED, 0x4002C000> {};
88
89template<uint32_t SPI_SPEED>
90class SPIOutput<SPI2_DATA, SPI_CLOCK, SPI_SPEED> : public ARMHardwareSPIOutput<SPI2_DATA, SPI_CLOCK, SPI_SPEED, 0x4002C000> {};
91#endif
92
93#elif defined(FASTLED_TEENSY4) && defined(ARM_HARDWARE_SPI)
94
95template<uint32_t SPI_SPEED>
96class SPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> : public Teensy4HardwareSPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED, SPI, 0> {};
97
98template<uint32_t SPI_SPEED>
99class SPIOutput<SPI1_DATA, SPI1_CLOCK, SPI_SPEED> : public Teensy4HardwareSPIOutput<SPI1_DATA, SPI1_CLOCK, SPI_SPEED, SPI1, 1> {};
100
101template<uint32_t SPI_SPEED>
102class SPIOutput<SPI2_DATA, SPI2_CLOCK, SPI_SPEED> : public Teensy4HardwareSPIOutput<SPI2_DATA, SPI2_CLOCK, SPI_SPEED, SPI2, 2> {};
103
104#elif defined(FASTLED_TEENSYLC) && defined(ARM_HARDWARE_SPI)
105
106#define DECLARE_SPI0(__DATA,__CLOCK) template<uint32_t SPI_SPEED>\
107 class SPIOutput<__DATA, __CLOCK, SPI_SPEED> : public ARMHardwareSPIOutput<__DATA, __CLOCK, SPI_SPEED, 0x40076000> {};
108 #define DECLARE_SPI1(__DATA,__CLOCK) template<uint32_t SPI_SPEED>\
109 class SPIOutput<__DATA, __CLOCK, SPI_SPEED> : public ARMHardwareSPIOutput<__DATA, __CLOCK, SPI_SPEED, 0x40077000> {};
110
111DECLARE_SPI0(7,13);
112DECLARE_SPI0(8,13);
113DECLARE_SPI0(11,13);
114DECLARE_SPI0(12,13);
115DECLARE_SPI0(7,14);
116DECLARE_SPI0(8,14);
117DECLARE_SPI0(11,14);
118DECLARE_SPI0(12,14);
119DECLARE_SPI1(0,20);
120DECLARE_SPI1(1,20);
121DECLARE_SPI1(21,20);
122
123#elif defined(__SAM3X8E__)
124
125template<uint32_t SPI_SPEED>
126class SPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> : public SAMHardwareSPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> {};
127
128#elif defined(AVR_HARDWARE_SPI)
129
130template<uint32_t SPI_SPEED>
131class SPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> : public AVRHardwareSPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> {};
132
133#if defined(SPI_UART0_DATA)
134
135template<uint32_t SPI_SPEED>
136class SPIOutput<SPI_UART0_DATA, SPI_UART0_CLOCK, SPI_SPEED> : public AVRUSART0SPIOutput<SPI_UART0_DATA, SPI_UART0_CLOCK, SPI_SPEED> {};
137
138#endif
139
140#if defined(SPI_UART1_DATA)
141
142template<uint32_t SPI_SPEED>
143class SPIOutput<SPI_UART1_DATA, SPI_UART1_CLOCK, SPI_SPEED> : public AVRUSART1SPIOutput<SPI_UART1_DATA, SPI_UART1_CLOCK, SPI_SPEED> {};
144
145#endif
146
147#elif defined(ARDUNIO_CORE_SPI)
148
149template<uint32_t SPI_SPEED>
150class SPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED> : public ArdunioCoreSPIOutput<SPI_DATA, SPI_CLOCK, SPI_SPEED, SPI> {};
151
152#endif
153
154#else
155# if !defined(FASTLED_INTERNAL) && !defined(FASTLED_ALL_PINS_HARDWARE_SPI)
156# ifdef FASTLED_HAS_PRAGMA_MESSAGE
157# pragma message "No hardware SPI pins defined. All SPI access will default to bitbanged output"
158# else
159# warning "No hardware SPI pins defined. All SPI access will default to bitbanged output"
160# endif
161# endif
162#endif
163
164// #if defined(USART_DATA) && defined(USART_CLOCK)
165// template<uint32_t SPI_SPEED>
166// class AVRSPIOutput<USART_DATA, USART_CLOCK, SPI_SPEED> : public AVRUSARTSPIOutput<USART_DATA, USART_CLOCK, SPI_SPEED> {};
167// #endif
168
169#else
170# if !defined(FASTLED_INTERNAL) && !defined(FASTLED_ALL_PINS_HARDWARE_SPI)
171# ifdef FASTLED_HAS_PRAGMA_MESSAGE
172# pragma message "Forcing software SPI - no hardware SPI for you!"
173# else
174# warning "Forcing software SPI - no hardware SPI for you!"
175# endif
176# endif
177#endif
178
179FASTLED_NAMESPACE_END
180
181#endif
FastLED.h
central include file for FastLED, defines the CFastLED class/object
AVRSoftwareSPIOutput
Software SPI (aka bit-banging) support Includes aggressive optimizations for when the clock and data ...
Definition fastspi_bitbang.h:23
SPIOutput
Hardware SPI output.
Definition fastspi.h:40
SoftwareSPIOutput
Software SPI output.
Definition fastspi.h:45
controller.h
base definitions used by led controllers for writing out led data
fastspi_bitbang.h
Software SPI (aka bit-banging) support.
lib8tion.h
Fast, efficient 8-bit math functions specifically designed for high-performance LED programming.