Library allowing up to 16 strings of 60 WS2811 or WS2812 LEDs to be driven from a single FRDM-KL25Z board. Uses hardware DMA to do a full 800 KHz rate without much CPU burden.

Dependents:   Multi_WS2811_test

After being frustrated by the SPI system's performance, I ended up using an approach inspired by Paul Stoffregen's OctoWS2811. This uses 3 of the 4 DMA channels triggered by the TPM0 timer PWM and overflow events.

This design will allow for up to 16 strings of up to 60 (limited by RAM space) WS2811/WS2812 LEDs to be driven on a single port. Adding more strings takes the same time to DMA, because the bits are output in parallel.

Here is my test program:

Import programMulti_WS2811_test

Test program for my Multi_WS2811 library that started out as a fork of heroic/WS2811. My library uses hardware DMA on the FRDM-KL25Z to drive up to 16 strings of WS2811 or WS2812 LEDs in parallel.

Here's 60 LEDs on a single string, at 10% brightness: https://www.icloud.com/sharedalbum/#B015oqs3qeGdFY

Note though that the 3.3V output from the FRDM-KL25Z's GPIO pins is OUT OF SPEC for driving the 5V WS2812 inputs, which require 3.5V for a logic HIGH signal. It only works on my board if I don't connect my scope or logic analyzer to the output pin. I recommend that you add a 5V buffer to the outputs to properly drive the LED strings. I added a CD4504 to do the 3.3 to 5V translation (mostly because I had one). You could use (say) a 74HCT244 to do 8 strings.

Each LED in a string takes 24/800e3 seconds to DMA, so if MAX_LEDS_PER_STRING is set to 60, then it takes 1.8 msec to actually do the DMA, plus 64 usec of guard time, or 1.87 msec per frame (538 frames/second). Of course, actually composing the frame will take most of the time in a real program.

The way I have my code set up, I can use up to 8 pins on PORTD. However, changing the defines at the top of WS2811.cpp will change the selected port.

Alternatively, you could use another port to get more strings. Watch out for pin mux conflicts, though.

Here are your choices:

  • PORTE: 15 total: PTE0-PTE5, PTE20-PTE25, PTE29-PTE31
  • PORTD: 8 total: PTD0-PTD7
  • PORTC: 16 total: PTC0-PTC13, PTC16-17
  • PORTB: 16 total: PTB0-PTB11, PTB16-19
  • PORTA: 15 total: PTA0-PTA5, PTA12-PTA20

Here is how the DMA channels are interleaved:

/media/uploads/bikeNomad/ws2812.png

The way I have it set up to generate the three phases of the required waveform is this:

I have timer TPM0 set up to generate events at overflow (OVF), at 250 nsec (CH0), and at 650 nsec (CH1). At 1250 nsec it resets to 0.

At timer count = 0, DMA0 fires, because it's triggered by TPM0's overflow (OVF) event. This results in the data lines being driven to a constant "1" level, as the data that DMA0 is programmed to transfer is a single, all-1's word. (This is the easiest way to explain what is happening; this is the way I'd wanted it to work, but I had to use as much precious RAM as for the RGB data to hold 1's to get it to work).

At 250 nsec, DMA1 fires, because it's triggered by TPM0's CH0 compare event. This drives either a 0 or 1 level to the pins, because DMA1 is programmed to transfer our data bytes to the pins.

At 650 nsec, DMA2 fires, because it's triggered by TPM0's CH1 compare event. This results in the data lines being driven to a constant "0" level, as the data that DMA2 is programmed to transfer is a single, all-0's word.

At 1250 nsec, the timer resets to 0, and the whole cycle repeats.

Because this library uses three of timer TPM0's six channels (and sets TPM0 to 800kHz), you will need to select TPM1 or TPM2 output pins if you want to use PwmOut pins in your program (for instance, for RC servos, which want a 50Hz frequency). If you just want to change discrete LED brightnesses, you can use TPM0's CH3, CH4, or CH5 pins. Just make sure that you set up your PwmOut instance at the same frequency.

Here is a table showing the assignment of timer resources to PwmOut capable pins in the FRDM-KL25Z:

KL25Z pinArduino nameTimerChannel
PTA3TPM0CH0
PTC1A5TPM0CH0
PTD0D10TPM0CH0
PTE24TPM0CH0
PTA4D4TPM0CH1
PTC2A4TPM0CH1
PTD1D13/LED_BLUETPM0CH1
PTE25TPM0CH1
PTA5D5TPM0CH2
PTC3TPM0CH2
PTD2D11TPM0CH2
PTE29TPM0CH2
PTC4TPM0CH3
PTD3D12TPM0CH3
PTE30TPM0CH3
PTC8D6TPM0CH4
PTD4D2TPM0CH4
PTE31TPM0CH4
PTA0TPM0CH5
PTC9D7TPM0CH5
PTD5D9TPM0CH5
PTE26TPM0CH5
PTA12D3TPM1CH0
PTB0A0TPM1CH0
PTE20TPM1CH0
PTA13D8TPM1CH1
PTB1A1TPM1CH1
PTE21TPM1CH1
PTA1D0/USBRXTPM2CH0
PTB18LED_REDTPM2CH0
PTB2A2TPM2CH0
PTE22TPM2CH0
PTA2D1/USBTXTPM2CH1
PTB19LED_GREENTPM2CH1
PTB3A3TPM2CH1
PTE23TPM2CH1
Committer:
Ned Konz
Date:
Sat Jun 13 00:18:32 2015 -0700
Revision:
5:2c3b76ea0b40
Parent:
1:86a910560879
Worked out flapping and color animation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bikeNomad 1:86a910560879 1 #include <stdint.h>
bikeNomad 1:86a910560879 2 #include <cstring>
bikeNomad 1:86a910560879 3
bikeNomad 0:a8535703f23b 4 #include "LedStrip.h"
bikeNomad 0:a8535703f23b 5
bikeNomad 0:a8535703f23b 6 LedStrip::LedStrip(int n)
bikeNomad 0:a8535703f23b 7 {
bikeNomad 0:a8535703f23b 8 // Allocate 3 bytes per pixel:
bikeNomad 0:a8535703f23b 9 numLEDs = n;
bikeNomad 1:86a910560879 10 pixels = new uint8_t[ numPixelBytes() ];
bikeNomad 0:a8535703f23b 11 if (pixels) {
bikeNomad 1:86a910560879 12 std::memset(pixels, 0x00, numPixelBytes()); // Init to RGB 'off' state
bikeNomad 0:a8535703f23b 13 }
bikeNomad 0:a8535703f23b 14 }
bikeNomad 0:a8535703f23b 15
bikeNomad 0:a8535703f23b 16 LedStrip::~LedStrip()
bikeNomad 0:a8535703f23b 17 {
bikeNomad 1:86a910560879 18 delete[] pixels;
bikeNomad 0:a8535703f23b 19 }
bikeNomad 0:a8535703f23b 20
bikeNomad 0:a8535703f23b 21 uint32_t LedStrip::total_luminance(void)
bikeNomad 0:a8535703f23b 22 {
bikeNomad 0:a8535703f23b 23 uint32_t running_total;
bikeNomad 0:a8535703f23b 24 running_total = 0;
bikeNomad 0:a8535703f23b 25 for (int i=0; i< numPixelBytes(); i++)
bikeNomad 0:a8535703f23b 26 running_total += pixels[i];
bikeNomad 0:a8535703f23b 27 return running_total;
bikeNomad 0:a8535703f23b 28 }
bikeNomad 0:a8535703f23b 29
bikeNomad 0:a8535703f23b 30 // Convert R,G,B to combined 32-bit color
bikeNomad 0:a8535703f23b 31 uint32_t LedStrip::Color(uint8_t r, uint8_t g, uint8_t b)
bikeNomad 0:a8535703f23b 32 {
bikeNomad 0:a8535703f23b 33 // Take the lowest 7 bits of each value and append them end to end
bikeNomad 0:a8535703f23b 34 // We have the top bit set high (its a 'parity-like' bit in the protocol
bikeNomad 0:a8535703f23b 35 // and must be set!)
bikeNomad 0:a8535703f23b 36 return ((uint32_t)g << 16) | ((uint32_t)r << 8) | (uint32_t)b;
bikeNomad 0:a8535703f23b 37 }
bikeNomad 0:a8535703f23b 38
bikeNomad 0:a8535703f23b 39 // store the rgb component in our array
bikeNomad 0:a8535703f23b 40 void LedStrip::setPixelColor(uint16_t n, uint8_t r, uint8_t g, uint8_t b)
bikeNomad 0:a8535703f23b 41 {
bikeNomad 0:a8535703f23b 42 if (n >= numLEDs) return; // '>=' because arrays are 0-indexed
bikeNomad 0:a8535703f23b 43
bikeNomad 0:a8535703f23b 44 pixels[n*3 ] = g;
bikeNomad 0:a8535703f23b 45 pixels[n*3+1] = r;
bikeNomad 0:a8535703f23b 46 pixels[n*3+2] = b;
bikeNomad 0:a8535703f23b 47 }
bikeNomad 0:a8535703f23b 48
bikeNomad 0:a8535703f23b 49 void LedStrip::setPixelR(uint16_t n, uint8_t r)
bikeNomad 0:a8535703f23b 50 {
bikeNomad 0:a8535703f23b 51 if (n >= numLEDs) return; // '>=' because arrays are 0-indexed
bikeNomad 0:a8535703f23b 52
bikeNomad 0:a8535703f23b 53 pixels[n*3+1] = r;
bikeNomad 0:a8535703f23b 54 }
bikeNomad 0:a8535703f23b 55
bikeNomad 0:a8535703f23b 56 void LedStrip::setPixelG(uint16_t n, uint8_t g)
bikeNomad 0:a8535703f23b 57 {
bikeNomad 0:a8535703f23b 58 if (n >= numLEDs) return; // '>=' because arrays are 0-indexed
bikeNomad 0:a8535703f23b 59
bikeNomad 0:a8535703f23b 60 pixels[n*3] = g;
bikeNomad 0:a8535703f23b 61 }
bikeNomad 0:a8535703f23b 62
bikeNomad 0:a8535703f23b 63 void LedStrip::setPixelB(uint16_t n, uint8_t b)
bikeNomad 0:a8535703f23b 64 {
bikeNomad 0:a8535703f23b 65 if (n >= numLEDs) return; // '>=' because arrays are 0-indexed
bikeNomad 0:a8535703f23b 66
bikeNomad 0:a8535703f23b 67 pixels[n*3+2] = b;
bikeNomad 0:a8535703f23b 68 }
bikeNomad 0:a8535703f23b 69
bikeNomad 0:a8535703f23b 70 void LedStrip::setPackedPixels(uint8_t * buffer, uint32_t n)
bikeNomad 0:a8535703f23b 71 {
bikeNomad 0:a8535703f23b 72 if (n >= numLEDs) return;
bikeNomad 1:86a910560879 73 std::memcpy(pixels, buffer, (std::size_t) (n*3));
bikeNomad 0:a8535703f23b 74 }
bikeNomad 0:a8535703f23b 75
bikeNomad 0:a8535703f23b 76 void LedStrip::setPixelColor(uint16_t n, uint32_t c)
bikeNomad 0:a8535703f23b 77 {
bikeNomad 0:a8535703f23b 78 if (n >= numLEDs) return; // '>=' because arrays are 0-indexed
bikeNomad 0:a8535703f23b 79
bikeNomad 0:a8535703f23b 80 pixels[n*3 ] = (c >> 16);
bikeNomad 0:a8535703f23b 81 pixels[n*3+1] = (c >> 8);
bikeNomad 0:a8535703f23b 82 pixels[n*3+2] = c;
bikeNomad 0:a8535703f23b 83 }