TLIGHT_PRODUCTS / WS281X

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

WS281X.cpp@0:dff187a80020, 2016-07-26 (annotated)

Committer:
mutech
Date:
Tue Jul 26 18:09:24 2016 +0000
Revision:
0:dff187a80020
Child:
2:cc8e091fd975
WS2811/WS2812 Class Library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mutech 0:dff187a80020 1 /* WS281X.cpp (for LPC82X/STM32F0x/STM32F746xx)
mutech 0:dff187a80020 2 * mbed Microcontroller Library
mutech 0:dff187a80020 3 * Copyright (c) 2016 muetch, t.kuroki, MIT License
mutech 0:dff187a80020 4 *
mutech 0:dff187a80020 5 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
mutech 0:dff187a80020 6 * and associated documentation files (the "Software"), to deal in the Software without restriction,
mutech 0:dff187a80020 7 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
mutech 0:dff187a80020 8 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
mutech 0:dff187a80020 9 * furnished to do so, subject to the following conditions:
mutech 0:dff187a80020 10 *
mutech 0:dff187a80020 11 * The above copyright notice and this permission notice shall be included in all copies or
mutech 0:dff187a80020 12 * substantial portions of the Software.
mutech 0:dff187a80020 13 *
mutech 0:dff187a80020 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
mutech 0:dff187a80020 15 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
mutech 0:dff187a80020 16 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
mutech 0:dff187a80020 17 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mutech 0:dff187a80020 18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mutech 0:dff187a80020 19 */
mutech 0:dff187a80020 20
mutech 0:dff187a80020 21 #include "WS281X.h"
mutech 0:dff187a80020 22 #include "pinmap.h"
mutech 0:dff187a80020 23
mutech 0:dff187a80020 24 // TARGET_DISCO_F746NG
mutech 0:dff187a80020 25 // TARGET_NUCLEO_F746ZG
mutech 0:dff187a80020 26 // TARGET_NUCLEO_F030R8
mutech 0:dff187a80020 27 // TARGET_NUCLEO_F070RB
mutech 0:dff187a80020 28 // TARGET_LPC824
mutech 0:dff187a80020 29
mutech 0:dff187a80020 30 //----------------------------------------------------------------------------
mutech 0:dff187a80020 31 WS281X::WS281X(PinName wirePin, PinMode pinMode, int numPixels, RGBOrder rgbOrder)
mutech 0:dff187a80020 32 : _wirePin(wirePin), _gpio(), _pixels(0)
mutech 0:dff187a80020 33 {
mutech 0:dff187a80020 34 gpio_init_inout(&_gpio, wirePin, PIN_OUTPUT, pinMode, 0);
mutech 0:dff187a80020 35 #if defined(TARGET_STM)
mutech 0:dff187a80020 36 pin_mode_ex(wirePin, pinMode);
mutech 0:dff187a80020 37 #endif
mutech 0:dff187a80020 38
mutech 0:dff187a80020 39 setRGBOrder(rgbOrder);
mutech 0:dff187a80020 40
mutech 0:dff187a80020 41 if (numPixels < 1)
mutech 0:dff187a80020 42 numPixels = 1;
mutech 0:dff187a80020 43 else if (numPixels > MAX_PIXELS)
mutech 0:dff187a80020 44 numPixels = MAX_PIXELS;
mutech 0:dff187a80020 45 _numPixels = (uint16_t)numPixels;
mutech 0:dff187a80020 46 _pixels = new RGBColor[_numPixels];
mutech 0:dff187a80020 47 _dummyPixel = 0;
mutech 0:dff187a80020 48
mutech 0:dff187a80020 49 clear();
mutech 0:dff187a80020 50 }
mutech 0:dff187a80020 51
mutech 0:dff187a80020 52 WS281X::~WS281X()
mutech 0:dff187a80020 53 {
mutech 0:dff187a80020 54 if (_pixels)
mutech 0:dff187a80020 55 delete[] _pixels;
mutech 0:dff187a80020 56 }
mutech 0:dff187a80020 57
mutech 0:dff187a80020 58 #if defined(TARGET_STM)
mutech 0:dff187a80020 59 void WS281X::pin_mode_ex(PinName pin, PinMode mode)
mutech 0:dff187a80020 60 {
mutech 0:dff187a80020 61 if (mode == OpenDrain)
mutech 0:dff187a80020 62 {
mutech 0:dff187a80020 63 int port_index = STM_PORT(pin);
mutech 0:dff187a80020 64 int pin_index = STM_PIN(pin);
mutech 0:dff187a80020 65 int offset = pin_index << 1;
mutech 0:dff187a80020 66
mutech 0:dff187a80020 67 GPIO_TypeDef * port_reg = ((GPIO_TypeDef *) (GPIOA_BASE + (port_index << 10)));
mutech 0:dff187a80020 68 // if (mode == OpenDrain)
mutech 0:dff187a80020 69 {
mutech 0:dff187a80020 70 port_reg->PUPDR &= ~(0x3 << offset);
mutech 0:dff187a80020 71 port_reg->OTYPER |= 1 << pin_index;
mutech 0:dff187a80020 72 }
mutech 0:dff187a80020 73 #if 0
mutech 0:dff187a80020 74 else
mutech 0:dff187a80020 75 {
mutech 0:dff187a80020 76 port_reg->OTYPER &= ~(1 << pin_index);
mutech 0:dff187a80020 77 port_reg->PUPDR &= ~(0x3 << offset);
mutech 0:dff187a80020 78 port_reg->PUPDR |= mode_ << offset;
mutech 0:dff187a80020 79 }
mutech 0:dff187a80020 80 #endif
mutech 0:dff187a80020 81 }
mutech 0:dff187a80020 82 else
mutech 0:dff187a80020 83 pin_mode(pin, mode);
mutech 0:dff187a80020 84 }
mutech 0:dff187a80020 85 #endif
mutech 0:dff187a80020 86
mutech 0:dff187a80020 87 void WS281X::setRGBOrder(RGBOrder rgbOrder)
mutech 0:dff187a80020 88 {
mutech 0:dff187a80020 89 _rgbOrder = rgbOrder;
mutech 0:dff187a80020 90 switch(_rgbOrder)
mutech 0:dff187a80020 91 {
mutech 0:dff187a80020 92 case RGB:
mutech 0:dff187a80020 93 _1st = 0;
mutech 0:dff187a80020 94 _2nd = 1;
mutech 0:dff187a80020 95 _3rd = 2;
mutech 0:dff187a80020 96 break;
mutech 0:dff187a80020 97
mutech 0:dff187a80020 98 case RBG:
mutech 0:dff187a80020 99 _1st = 0;
mutech 0:dff187a80020 100 _2nd = 2;
mutech 0:dff187a80020 101 _3rd = 1;
mutech 0:dff187a80020 102 break;
mutech 0:dff187a80020 103
mutech 0:dff187a80020 104 case GRB:
mutech 0:dff187a80020 105 _1st = 1;
mutech 0:dff187a80020 106 _2nd = 0;
mutech 0:dff187a80020 107 _3rd = 2;
mutech 0:dff187a80020 108 break;
mutech 0:dff187a80020 109
mutech 0:dff187a80020 110 case GBR:
mutech 0:dff187a80020 111 _1st = 2;
mutech 0:dff187a80020 112 _2nd = 0;
mutech 0:dff187a80020 113 _3rd = 1;
mutech 0:dff187a80020 114 break;
mutech 0:dff187a80020 115
mutech 0:dff187a80020 116 case BRG:
mutech 0:dff187a80020 117 _1st = 1;
mutech 0:dff187a80020 118 _2nd = 2;
mutech 0:dff187a80020 119 _3rd = 0;
mutech 0:dff187a80020 120 break;
mutech 0:dff187a80020 121
mutech 0:dff187a80020 122 case BGR:
mutech 0:dff187a80020 123 _1st = 2;
mutech 0:dff187a80020 124 _2nd = 1;
mutech 0:dff187a80020 125 _3rd = 0;
mutech 0:dff187a80020 126 break;
mutech 0:dff187a80020 127
mutech 0:dff187a80020 128 default:
mutech 0:dff187a80020 129 _1st = 0;
mutech 0:dff187a80020 130 _2nd = 1;
mutech 0:dff187a80020 131 _3rd = 2;
mutech 0:dff187a80020 132 break;
mutech 0:dff187a80020 133 }
mutech 0:dff187a80020 134 }
mutech 0:dff187a80020 135
mutech 0:dff187a80020 136 #define _nop1() __nop()
mutech 0:dff187a80020 137 #define _nop2() __nop(); __nop()
mutech 0:dff187a80020 138 #define _nop3() _nop1(); _nop2()
mutech 0:dff187a80020 139 #define _nop4() _nop2(); _nop2()
mutech 0:dff187a80020 140 #define _nop5() _nop1(); _nop4()
mutech 0:dff187a80020 141 #define _nop6() _nop2(); _nop4()
mutech 0:dff187a80020 142 #define _nop7() _nop3(); _nop4()
mutech 0:dff187a80020 143 #define _nop8() _nop4(); _nop4()
mutech 0:dff187a80020 144 #define _nop9() _nop1(); _nop8()
mutech 0:dff187a80020 145 #define _nop10() _nop2(); _nop8()
mutech 0:dff187a80020 146 #define _nop11() _nop3(); _nop8()
mutech 0:dff187a80020 147 #define _nop12() _nop4(); _nop8()
mutech 0:dff187a80020 148 #define _nop13() _nop5(); _nop8()
mutech 0:dff187a80020 149 #define _nop14() _nop6(); _nop8()
mutech 0:dff187a80020 150 #define _nop15() _nop7(); _nop8()
mutech 0:dff187a80020 151 #define _nop16() _nop8(); _nop8()
mutech 0:dff187a80020 152
mutech 0:dff187a80020 153 #if defined(TARGET_NXP)
mutech 0:dff187a80020 154 // LPC824-30MHz
mutech 0:dff187a80020 155 #define DELAY_T0H() do{ _nop2(); }while(0)
mutech 0:dff187a80020 156 #define DELAY_T1H() do{ _nop6(); }while(0)
mutech 0:dff187a80020 157 #define DELAY_TLOW() do{ _nop6(); }while(0)
mutech 0:dff187a80020 158 #define DELAY_TLOW2() //do{ _nop2(); }while(0)
mutech 0:dff187a80020 159 #define DELAY_SPACE() do{ _nop2(); }while(0)
mutech 0:dff187a80020 160 #define DELAY_NEXT() do{ _nop1(); }while(0)
mutech 0:dff187a80020 161 #endif
mutech 0:dff187a80020 162
mutech 0:dff187a80020 163 #if defined(TARGET_STM32F0)
mutech 0:dff187a80020 164 // STM32F030R8-48MHz
mutech 0:dff187a80020 165 #define DELAY_T0H() do{ _nop8(); _nop4(); }while(0)
mutech 0:dff187a80020 166 #define DELAY_T1H() do{ _nop8(); _nop8(); }while(0)
mutech 0:dff187a80020 167 #define DELAY_TLOW() do{ _nop16(); }while(0)
mutech 0:dff187a80020 168 #define DELAY_TLOW2() //do{ _nop8(); _nop4(); }while(0)
mutech 0:dff187a80020 169 #define DELAY_SPACE() do{ _nop8(); _nop4(); }while(0)
mutech 0:dff187a80020 170 #define DELAY_NEXT() do{ _nop4(); }while(0)
mutech 0:dff187a80020 171 #endif
mutech 0:dff187a80020 172
mutech 0:dff187a80020 173 #if defined(TARGET_STM32F7)
mutech 0:dff187a80020 174 // DISCO-F746NG (216MHz), NUCLEO-F746ZG (216MHz)
mutech 0:dff187a80020 175 #define T0H (35)
mutech 0:dff187a80020 176 #define T0L (128-T0H)
mutech 0:dff187a80020 177 #define T1H (100)
mutech 0:dff187a80020 178 #define T1L (128-T1H)
mutech 0:dff187a80020 179
mutech 0:dff187a80020 180 #define DELAY_T0H() _delay(T0H)
mutech 0:dff187a80020 181 #define DELAY_T1H() _delay(T1H-T0H)
mutech 0:dff187a80020 182 #define DELAY_TLOW() _delay(T1L)
mutech 0:dff187a80020 183 #define DELAY_TLOW2() //DELAY_TLOW()
mutech 0:dff187a80020 184 #define DELAY_SPACE() DELAY_TLOW()
mutech 0:dff187a80020 185 #define DELAY_NEXT() _delay(35)
mutech 0:dff187a80020 186
mutech 0:dff187a80020 187 inline __attribute__((always_inline))
mutech 0:dff187a80020 188 void WS281X::_delay(int value)
mutech 0:dff187a80020 189 {
mutech 0:dff187a80020 190 do { __nop(); } while (--value);
mutech 0:dff187a80020 191 }
mutech 0:dff187a80020 192 #endif
mutech 0:dff187a80020 193
mutech 0:dff187a80020 194 inline __attribute__((always_inline))
mutech 0:dff187a80020 195 void WS281X::writeByte(__IO regsize_t *reg_set, __IO regsize_t *reg_clr, regsize_t *mask, uint8_t value)
mutech 0:dff187a80020 196 {
mutech 0:dff187a80020 197 do
mutech 0:dff187a80020 198 {
mutech 0:dff187a80020 199 // bit7
mutech 0:dff187a80020 200 *reg_set = mask[0];
mutech 0:dff187a80020 201 DELAY_T0H();
mutech 0:dff187a80020 202 *reg_clr = mask[(value >> 7) & 1];
mutech 0:dff187a80020 203 DELAY_T1H();
mutech 0:dff187a80020 204 *reg_clr = mask[0];
mutech 0:dff187a80020 205 DELAY_TLOW();
mutech 0:dff187a80020 206
mutech 0:dff187a80020 207 // bit6
mutech 0:dff187a80020 208 *reg_set = mask[0];
mutech 0:dff187a80020 209 DELAY_T0H();
mutech 0:dff187a80020 210 *reg_clr = mask[(value >> 6) & 1];
mutech 0:dff187a80020 211 DELAY_T1H();
mutech 0:dff187a80020 212 *reg_clr = mask[0];
mutech 0:dff187a80020 213 DELAY_TLOW();
mutech 0:dff187a80020 214
mutech 0:dff187a80020 215 // bit5
mutech 0:dff187a80020 216 *reg_set = mask[0];
mutech 0:dff187a80020 217 DELAY_T0H();
mutech 0:dff187a80020 218 *reg_clr = mask[(value >> 5) & 1];
mutech 0:dff187a80020 219 DELAY_T1H();
mutech 0:dff187a80020 220 *reg_clr = mask[0];
mutech 0:dff187a80020 221 DELAY_TLOW();
mutech 0:dff187a80020 222
mutech 0:dff187a80020 223 // bit4
mutech 0:dff187a80020 224 *reg_set = mask[0];
mutech 0:dff187a80020 225 DELAY_T0H();
mutech 0:dff187a80020 226 *reg_clr = mask[(value >> 4) & 1];
mutech 0:dff187a80020 227 DELAY_T1H();
mutech 0:dff187a80020 228 *reg_clr = mask[0];
mutech 0:dff187a80020 229 DELAY_TLOW();
mutech 0:dff187a80020 230
mutech 0:dff187a80020 231 // bit3
mutech 0:dff187a80020 232 *reg_set = mask[0];
mutech 0:dff187a80020 233 DELAY_T0H();
mutech 0:dff187a80020 234 *reg_clr = mask[(value >> 3) & 1];
mutech 0:dff187a80020 235 DELAY_T1H();
mutech 0:dff187a80020 236 *reg_clr = mask[0];
mutech 0:dff187a80020 237 DELAY_TLOW();
mutech 0:dff187a80020 238
mutech 0:dff187a80020 239 // bit2
mutech 0:dff187a80020 240 *reg_set = mask[0];
mutech 0:dff187a80020 241 DELAY_T0H();
mutech 0:dff187a80020 242 *reg_clr = mask[(value >> 2) & 1];
mutech 0:dff187a80020 243 DELAY_T1H();
mutech 0:dff187a80020 244 *reg_clr = mask[0];
mutech 0:dff187a80020 245 DELAY_TLOW();
mutech 0:dff187a80020 246
mutech 0:dff187a80020 247 // bit1
mutech 0:dff187a80020 248 *reg_set = mask[0];
mutech 0:dff187a80020 249 DELAY_T0H();
mutech 0:dff187a80020 250 *reg_clr = mask[(value >> 1) & 1];
mutech 0:dff187a80020 251 DELAY_T1H();
mutech 0:dff187a80020 252 *reg_clr = mask[0];
mutech 0:dff187a80020 253 DELAY_TLOW();
mutech 0:dff187a80020 254
mutech 0:dff187a80020 255 // bit0
mutech 0:dff187a80020 256 *reg_set = mask[0];
mutech 0:dff187a80020 257 DELAY_T0H();
mutech 0:dff187a80020 258 *reg_clr = mask[(value >> 0) & 1];
mutech 0:dff187a80020 259 DELAY_T1H();
mutech 0:dff187a80020 260 *reg_clr = mask[0];
mutech 0:dff187a80020 261 DELAY_TLOW2();
mutech 0:dff187a80020 262
mutech 0:dff187a80020 263 } while (0);
mutech 0:dff187a80020 264 }
mutech 0:dff187a80020 265
mutech 0:dff187a80020 266 void WS281X::show()
mutech 0:dff187a80020 267 {
mutech 0:dff187a80020 268 // CPU_FREQ = 30MHz -> 0.0333us/cycle
mutech 0:dff187a80020 269 // WS2811 0: 0.25us+1.0us, 1: 1.0us+0.25us
mutech 0:dff187a80020 270 // WS2812 0: 0.45us+0.8us, 1: 0.8us+0.45us
mutech 0:dff187a80020 271
mutech 0:dff187a80020 272 #if defined(TARGET_NXP)
mutech 0:dff187a80020 273 __IO uint32_t *reg_set = _gpio.reg_set;
mutech 0:dff187a80020 274 __IO uint32_t *reg_clr = _gpio.reg_clr;
mutech 0:dff187a80020 275 uint32_t mask[2] = { _gpio.mask, 0 };
mutech 0:dff187a80020 276 #elif defined(TARGET_STM32F0) || defined(TARGET_STM32F1)
mutech 0:dff187a80020 277 __IO uint32_t *reg_set = _gpio.reg_set;
mutech 0:dff187a80020 278 __IO uint32_t *reg_clr = _gpio.reg_clr;
mutech 0:dff187a80020 279 uint32_t mask[2] = { _gpio.mask, 0 };
mutech 0:dff187a80020 280 #elif defined(TARGET_STM)
mutech 0:dff187a80020 281 __IO uint16_t *reg_set = (__IO uint16_t *)_gpio.reg_set_clr;
mutech 0:dff187a80020 282 __IO uint16_t *reg_clr = reg_set + 1;
mutech 0:dff187a80020 283 uint16_t mask[2] = { _gpio.mask, 0 };
mutech 0:dff187a80020 284 #endif
mutech 0:dff187a80020 285
mutech 0:dff187a80020 286 uint8_t *pix = (uint8_t *)_pixels;
mutech 0:dff187a80020 287 uint8_t *end = pix + (_numPixels * sizeof(_pixels[0]));
mutech 0:dff187a80020 288
mutech 0:dff187a80020 289 __disable_irq(); // Disable interrupts temporarily because we don't want our pulse timing to be messed up.
mutech 0:dff187a80020 290
mutech 0:dff187a80020 291 uint8_t value;
mutech 0:dff187a80020 292 do
mutech 0:dff187a80020 293 {
mutech 0:dff187a80020 294 value = pix[_1st];
mutech 0:dff187a80020 295 writeByte(reg_set, reg_clr, mask, value);
mutech 0:dff187a80020 296 DELAY_SPACE();
mutech 0:dff187a80020 297
mutech 0:dff187a80020 298 value = pix[_2nd];
mutech 0:dff187a80020 299 writeByte(reg_set, reg_clr, mask, value);
mutech 0:dff187a80020 300 DELAY_SPACE();
mutech 0:dff187a80020 301
mutech 0:dff187a80020 302 value = pix[_3rd];
mutech 0:dff187a80020 303 writeByte(reg_set, reg_clr, mask, value);
mutech 0:dff187a80020 304 pix += sizeof(_pixels[0]);
mutech 0:dff187a80020 305 DELAY_NEXT();
mutech 0:dff187a80020 306 } while (pix < end);
mutech 0:dff187a80020 307
mutech 0:dff187a80020 308 __enable_irq(); // Re-enable interrupts now that we are done.
mutech 0:dff187a80020 309
mutech 0:dff187a80020 310 wait_us(50);
mutech 0:dff187a80020 311 }
mutech 0:dff187a80020 312
mutech 0:dff187a80020 313 // 先頭から指定サイズ分のブロックをバッファの最後までコピーする
mutech 0:dff187a80020 314 void WS281X::repeatBlock(int block_size)
mutech 0:dff187a80020 315 {
mutech 0:dff187a80020 316 if (block_size < 1 || block_size >= _numPixels)
mutech 0:dff187a80020 317 return;
mutech 0:dff187a80020 318
mutech 0:dff187a80020 319 RGBColor *dest = _pixels + block_size;
mutech 0:dff187a80020 320 int left = _numPixels - block_size;
mutech 0:dff187a80020 321 while (left > block_size)
mutech 0:dff187a80020 322 {
mutech 0:dff187a80020 323 memcpy(dest, _pixels, block_size * sizeof(_pixels[0]));
mutech 0:dff187a80020 324 dest += block_size;
mutech 0:dff187a80020 325 left -= block_size;
mutech 0:dff187a80020 326 block_size <<= 1; // 次回は２倍のサイズの転送
mutech 0:dff187a80020 327 }
mutech 0:dff187a80020 328 memcpy(dest, _pixels, left * sizeof(_pixels[0]));
mutech 0:dff187a80020 329 }
mutech 0:dff187a80020 330
mutech 0:dff187a80020 331 // 指定色でバッファを埋める
mutech 0:dff187a80020 332 void WS281X::clear(uint32_t color)
mutech 0:dff187a80020 333 {
mutech 0:dff187a80020 334 _pixels[0] = color;
mutech 0:dff187a80020 335 repeatBlock(1);
mutech 0:dff187a80020 336 }
mutech 0:dff187a80020 337
mutech 0:dff187a80020 338 // 指定色でバッファを埋めた後表示
mutech 0:dff187a80020 339 void WS281X::show(uint32_t color)
mutech 0:dff187a80020 340 {
mutech 0:dff187a80020 341 clear(color);
mutech 0:dff187a80020 342 show();
mutech 0:dff187a80020 343 }
mutech 0:dff187a80020 344
mutech 0:dff187a80020 345 //----------------------------------------------------------------------------