src/main/drivers/light_ws2811strip.h

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #pragma once
  22
  23 #include "platform.h"
  24
  25 #include "drivers/io_types.h"
  26
  27 #define WS2811_LED_STRIP_LENGTH    32
  28
  29 #define WS2811_BITS_PER_LED        24
  30
  31 #if defined(USE_WS2811_SINGLE_COLOUR)
  32 #define WS2811_DATA_BUFFER_SIZE    1
  33 #define WS2811_DMA_BUFFER_SIZE     (WS2811_DATA_BUFFER_SIZE * WS2811_BITS_PER_LED)
  34 // Do 2 extra iterations of the DMA transfer with the ouptut set to low to generate the > 50us delay.
  35 #define WS2811_DELAY_ITERATIONS    2
  36 #else
  37 #define WS2811_DATA_BUFFER_SIZE    WS2811_LED_STRIP_LENGTH
  38 // for 50us delay
  39 #define WS2811_DELAY_BUFFER_LENGTH 42
  40 // number of bytes needed is #LEDs * 24 bytes + 42 trailing bytes)
  41 #define WS2811_DMA_BUFFER_SIZE     (WS2811_DATA_BUFFER_SIZE * WS2811_BITS_PER_LED + WS2811_DELAY_BUFFER_LENGTH)
  42 #endif
  43
  44 #define WS2811_TIMER_MHZ           48
  45 #define WS2811_CARRIER_HZ          800000
  46
  47 // Enumeration to match the string options defined in lookupLedStripFormatRGB in settings.c
  48 typedef enum {
  49     LED_GRB,
  50     LED_RGB
  51 } ledStripFormatRGB_e;
  52
  53 void ws2811LedStripInit(ioTag_t ioTag);
  54 void ws2811LedStripEnable(void);
  55
  56 bool ws2811LedStripHardwareInit(ioTag_t ioTag);
  57 void ws2811LedStripDMAEnable(void);
  58
  59 void ws2811UpdateStrip(ledStripFormatRGB_e ledFormat);
  60
  61 void setLedHsv(uint16_t index, const hsvColor_t *color);
  62 void getLedHsv(uint16_t index, hsvColor_t *color);
  63
  64 void scaleLedValue(uint16_t index, const uint8_t scalePercent);
  65 void setLedValue(uint16_t index, const uint8_t value);
  66
  67 void setStripColor(const hsvColor_t *color);
  68 void setStripColors(const hsvColor_t *colors);
  69
  70 void setUsedLedCount(unsigned ledCount);
  71
  72 bool isWS2811LedStripReady(void);
  73
  74 #if defined(STM32F1) || defined(STM32F3)
  75 extern uint8_t ledStripDMABuffer[WS2811_DMA_BUFFER_SIZE];
  76 #else
  77 extern uint32_t ledStripDMABuffer[WS2811_DMA_BUFFER_SIZE];
  78 #endif
  79 extern volatile bool ws2811LedDataTransferInProgress;
  80
  81 extern uint16_t BIT_COMPARE_1;
  82 extern uint16_t BIT_COMPARE_0;