Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

commit!

  • Loading branch information...
commit eb05ec9c1154ba15fab6e886b2c8ab149960a6b7 0 parents
Limor "Ladyada" Fried ladyada authored
547 Adafruit_NeoPixel.cpp
... ... @@ -0,0 +1,547 @@
  1 +/*--------------------------------------------------------------------
  2 + Arduino library to control a wide variety of WS2811-based RGB LED
  3 + devices. Currently handles 400 and 800 KHz bitstreams on both 8 MHz
  4 + and 16 MHz ATmega MCUs, with LEDs wired for RGB or GRB color order.
  5 + 8 MHz MCUs provide output on PORTB and PORTD, while 16 MHz chips can
  6 + handle most output pins (possible exception with some of the upper
  7 + PORT registers on the Arduino Mega).
  8 +
  9 + WILL NOT COMPILE OR WORK ON ARDUINO DUE. Uses inline assembly.
  10 +
  11 + Written by Phil Burgess / Paint Your Dragon for Adafruit Industries.
  12 +
  13 + Adafruit invests time and resources providing this open source code,
  14 + please support Adafruit and open-source hardware by purchasing
  15 + products from Adafruit!
  16 +
  17 + --------------------------------------------------------------------
  18 + This file is part of the Adafruit NeoPixel library.
  19 +
  20 + NeoPixel is free software: you can redistribute it and/or modify
  21 + it under the terms of the GNU Lesser General Public License as
  22 + published by the Free Software Foundation, either version 3 of
  23 + the License, or (at your option) any later version.
  24 +
  25 + NeoPixel is distributed in the hope that it will be useful,
  26 + but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  28 + GNU Lesser General Public License for more details.
  29 +
  30 + You should have received a copy of the GNU Lesser General Public
  31 + License along with NeoPixel. If not, see
  32 + <http://www.gnu.org/licenses/>.
  33 + --------------------------------------------------------------------*/
  34 +
  35 +#include "Adafruit_Adafruit_NeoPixel.h"
  36 +
  37 +Adafruit_NeoPixel::Adafruit_NeoPixel(uint16_t n, uint8_t p, uint8_t t) {
  38 + numBytes = n * 3;
  39 + if((pixels = (uint8_t *)malloc(numBytes))) {
  40 + memset(pixels, 0, numBytes);
  41 + numLEDs = n;
  42 + type = t;
  43 + pin = p;
  44 + port = portOutputRegister(digitalPinToPort(p));
  45 + pinMask = digitalPinToBitMask(p);
  46 + } else {
  47 + numLEDs = 0;
  48 + }
  49 +}
  50 +
  51 +void Adafruit_NeoPixel::begin(void) {
  52 + pinMode(pin, OUTPUT);
  53 + digitalWrite(pin, LOW);
  54 +}
  55 +
  56 +void Adafruit_NeoPixel::show(void) {
  57 +
  58 + static uint32_t endTime = 0L;
  59 +
  60 + if(!numLEDs) return;
  61 +
  62 + volatile uint16_t
  63 + i = numBytes; // Loop counter
  64 + volatile uint8_t
  65 + *ptr = pixels, // Pointer to next byte
  66 + b = *ptr++, // Current byte value
  67 + hi, // PORT w/output bit set high
  68 + lo; // PORT w/output bit set low
  69 +
  70 + // A 50+ microsecond pause in the output stream = data latch.
  71 + // Rather than put a delay at the end of the function, the ending
  72 + // time is noted and the function will simply hold off (if needed)
  73 + // on issuing the subsequent round of data until the latch time has
  74 + // elapsed. This allows the mainline code to start generating the
  75 + // next frame of data rather than stalling for the latch.
  76 + while((micros() - endTime) < 50L);
  77 +
  78 + // In order to make this code runtime-configurable to work with
  79 + // any pin, SBI/CBI instructions are eschewed in favor of full
  80 + // PORT writes via the OUT instruction. It relies on two facts:
  81 + // that peripheral functions (such as PWM) take precedence on
  82 + // output pins, so our PORT-wide writes won't interfere, and that
  83 + // interrupts are globally disabled while data is being issued to
  84 + // the LEDs, so no other code will be accessing the PORT. The
  85 + // code takes an initial 'snapshot' of the PORT state, computes
  86 + // 'pin high' and 'pin low' values, and writes these back to the
  87 + // PORT register as needed.
  88 +
  89 + cli(); // Disable interrupts; need 100% focus on instruction timing
  90 +
  91 +#if (F_CPU == 8000000UL) // FLORA, Arduino Pro 8 MHz, etc.
  92 +
  93 + if((type & NEO_SPDMASK) == NEO_KHZ800) { // 800 KHz bitstream
  94 +
  95 + volatile uint8_t n1, n2 = 0; // First, next bits out
  96 +
  97 + // Squeezing an 800 KHz stream out of an 8 MHz chip requires code
  98 + // specific to each PORT register. At present this is only written
  99 + // to work with pins on PORTD or PORTB, the most likely use case --
  100 + // this covers all the pins on the Adafruit Flora and the bulk of
  101 + // digital pins on the Arduino Pro 8 MHz (keep in mind, this code
  102 + // doesn't even get compiled for 16 MHz boards like the Uno, Mega,
  103 + // Leonardo, etc., so don't bother extending this out of hand).
  104 + // Additional PORTs could be added if you really need them, just
  105 + // duplicate the else and loop and change the PORT. Each add'l
  106 + // PORT will require about 150(ish) bytes of program space.
  107 +
  108 + // 10 instruction clocks per bit: HHxxxxxxLL
  109 + // OUT instructions: ^ ^ ^
  110 +
  111 + if(port == &PORTD) {
  112 +
  113 + hi = PORTD | pinMask;
  114 + lo = hi & ~pinMask;
  115 + n1 = lo;
  116 + if(b & 0x80) n1 = hi;
  117 +
  118 + // Dirty trick here: meaningless MULs are used to delay two clock
  119 + // cycles in one instruction word (rather than using two NOPs).
  120 + // This was necessary in order to squeeze the loop down to exactly
  121 + // 64 words -- the maximum possible for a relative branch.
  122 +
  123 + asm volatile(
  124 + "headD:\n\t" // Clk Pseudocode
  125 + // Bit 7:
  126 + "out %0, %1\n\t" // 1 PORT = hi
  127 + "mov %3, %4\n\t" // 1 n2 = lo
  128 + "out %0, %2\n\t" // 1 PORT = n1
  129 + "mul r0, r0\n\t" // 2 nop nop
  130 + "sbrc %5, 6\n\t" // 1-2 if(b & 0x40)
  131 + "mov %3, %1\n\t" // 0-1 n2 = hi
  132 + "out %0, %4\n\t" // 1 PORT = lo
  133 + "mul r0, r0\n\t" // 2 nop nop
  134 + // Bit 6:
  135 + "out %0, %1\n\t" // 1 PORT = hi
  136 + "mov %2, %4\n\t" // 1 n1 = lo
  137 + "out %0, %3\n\t" // 1 PORT = n2
  138 + "mul r0, r0\n\t" // 2 nop nop
  139 + "sbrc %5, 5\n\t" // 1-2 if(b & 0x20)
  140 + "mov %2, %1\n\t" // 0-1 n1 = hi
  141 + "out %0, %4\n\t" // 1 PORT = lo
  142 + "mul r0, r0\n\t" // 2 nop nop
  143 + // Bit 5:
  144 + "out %0, %1\n\t" // 1 PORT = hi
  145 + "mov %3, %4\n\t" // 1 n2 = lo
  146 + "out %0, %2\n\t" // 1 PORT = n1
  147 + "mul r0, r0\n\t" // 2 nop nop
  148 + "sbrc %5, 4\n\t" // 1-2 if(b & 0x10)
  149 + "mov %3, %1\n\t" // 0-1 n2 = hi
  150 + "out %0, %4\n\t" // 1 PORT = lo
  151 + "mul r0, r0\n\t" // 2 nop nop
  152 + // Bit 4:
  153 + "out %0, %1\n\t" // 1 PORT = hi
  154 + "mov %2, %4\n\t" // 1 n1 = lo
  155 + "out %0, %3\n\t" // 1 PORT = n2
  156 + "mul r0, r0\n\t" // 2 nop nop
  157 + "sbrc %5, 3\n\t" // 1-2 if(b & 0x08)
  158 + "mov %2, %1\n\t" // 0-1 n1 = hi
  159 + "out %0, %4\n\t" // 1 PORT = lo
  160 + "mul r0, r0\n\t" // 2 nop nop
  161 + // Bit 3:
  162 + "out %0, %1\n\t" // 1 PORT = hi
  163 + "mov %3, %4\n\t" // 1 n2 = lo
  164 + "out %0, %2\n\t" // 1 PORT = n1
  165 + "mul r0, r0\n\t" // 2 nop nop
  166 + "sbrc %5, 2\n\t" // 1-2 if(b & 0x04)
  167 + "mov %3, %1\n\t" // 0-1 n2 = hi
  168 + "out %0, %4\n\t" // 1 PORT = lo
  169 + "mul r0, r0\n\t" // 2 nop nop
  170 + // Bit 2:
  171 + "out %0, %1\n\t" // 1 PORT = hi
  172 + "mov %2, %4\n\t" // 1 n1 = lo
  173 + "out %0, %3\n\t" // 1 PORT = n2
  174 + "mul r0, r0\n\t" // 2 nop nop
  175 + "sbrc %5, 1\n\t" // 1-2 if(b & 0x02)
  176 + "mov %2, %1\n\t" // 0-1 n1 = hi
  177 + "out %0, %4\n\t" // 1 PORT = lo
  178 + "mul r0, r0\n\t" // 2 nop nop
  179 + // Bit 1:
  180 + "out %0, %1\n\t" // 1 PORT = hi
  181 + "mov %3, %4\n\t" // 1 n2 = lo
  182 + "out %0, %2\n\t" // 1 PORT = n1
  183 + "mul r0, r0\n\t" // 2 nop nop
  184 + "sbrc %5, 0\n\t" // 1-2 if(b & 0x01)
  185 + "mov %3, %1\n\t" // 0-1 n2 = hi
  186 + "out %0, %4\n\t" // 1 PORT = lo
  187 + "sbiw %6, 1\n\t" // 2 i-- (dec. but don't act on zero flag yet)
  188 + // Bit 0:
  189 + "out %0, %1\n\t" // 1 PORT = hi
  190 + "mov %2, %4\n\t" // 1 n1 = lo
  191 + "out %0, %3\n\t" // 1 PORT = n2
  192 + "ld %5, %a7+\n\t" // 2 b = *ptr++
  193 + "sbrc %5, 7\n\t" // 1-2 if(b & 0x80)
  194 + "mov %2, %1\n\t" // 0-1 n1 = hi
  195 + "out %0, %4\n\t" // 1 PORT = lo
  196 + "brne headD\n" // 2 while(i) (zero flag determined above)
  197 + ::
  198 + "I" (_SFR_IO_ADDR(PORTD)), // %0
  199 + "r" (hi), // %1
  200 + "r" (n1), // %2
  201 + "r" (n2), // %3
  202 + "r" (lo), // %4
  203 + "r" (b), // %5
  204 + "w" (i), // %6
  205 + "e" (ptr) // %a7
  206 + ); // end asm
  207 +
  208 + } else if(port == &PORTB) {
  209 +
  210 + // Same as above, just switched to PORTB and stripped of comments.
  211 + hi = PORTB | pinMask;
  212 + lo = hi & ~pinMask;
  213 + n1 = lo;
  214 + if(b & 0x80) n1 = hi;
  215 + asm volatile(
  216 + "headB:\n\t"
  217 + "out %0, %1\n\t"
  218 + "mov %3, %4\n\t"
  219 + "out %0, %2\n\t"
  220 + "mul r0, r0\n\t"
  221 + "sbrc %5, 6\n\t"
  222 + "mov %3, %1\n\t"
  223 + "out %0, %4\n\t"
  224 + "mul r0, r0\n\t"
  225 + "out %0, %1\n\t"
  226 + "mov %2, %4\n\t"
  227 + "out %0, %3\n\t"
  228 + "mul r0, r0\n\t"
  229 + "sbrc %5, 5\n\t"
  230 + "mov %2, %1\n\t"
  231 + "out %0, %4\n\t"
  232 + "mul r0, r0\n\t"
  233 + "out %0, %1\n\t"
  234 + "mov %3, %4\n\t"
  235 + "out %0, %2\n\t"
  236 + "mul r0, r0\n\t"
  237 + "sbrc %5, 4\n\t"
  238 + "mov %3, %1\n\t"
  239 + "out %0, %4\n\t"
  240 + "mul r0, r0\n\t"
  241 + "out %0, %1\n\t"
  242 + "mov %2, %4\n\t"
  243 + "out %0, %3\n\t"
  244 + "mul r0, r0\n\t"
  245 + "sbrc %5, 3\n\t"
  246 + "mov %2, %1\n\t"
  247 + "out %0, %4\n\t"
  248 + "mul r0, r0\n\t"
  249 + "out %0, %1\n\t"
  250 + "mov %3, %4\n\t"
  251 + "out %0, %2\n\t"
  252 + "mul r0, r0\n\t"
  253 + "sbrc %5, 2\n\t"
  254 + "mov %3, %1\n\t"
  255 + "out %0, %4\n\t"
  256 + "mul r0, r0\n\t"
  257 + "out %0, %1\n\t"
  258 + "mov %2, %4\n\t"
  259 + "out %0, %3\n\t"
  260 + "mul r0, r0\n\t"
  261 + "sbrc %5, 1\n\t"
  262 + "mov %2, %1\n\t"
  263 + "out %0, %4\n\t"
  264 + "mul r0, r0\n\t"
  265 + "out %0, %1\n\t"
  266 + "mov %3, %4\n\t"
  267 + "out %0, %2\n\t"
  268 + "mul r0, r0\n\t"
  269 + "sbrc %5, 0\n\t"
  270 + "mov %3, %1\n\t"
  271 + "out %0, %4\n\t"
  272 + "sbiw %6, 1\n\t"
  273 + "out %0, %1\n\t"
  274 + "mov %2, %4\n\t"
  275 + "out %0, %3\n\t"
  276 + "ld %5, %a7+\n\t"
  277 + "sbrc %5, 7\n\t"
  278 + "mov %2, %1\n\t"
  279 + "out %0, %4\n\t"
  280 + "brne headB\n" :: "I" (_SFR_IO_ADDR(PORTB)), "r" (hi),
  281 + "r" (n1), "r" (n2), "r" (lo), "r" (b), "w" (i), "e" (ptr)
  282 + ); // end asm
  283 + } // endif PORTB
  284 + } // end 800 KHz, see comments later re 'else'
  285 +
  286 +#elif (F_CPU == 16000000UL)
  287 +
  288 + if((type & NEO_SPDMASK) == NEO_KHZ400) { // 400 KHz bitstream
  289 +
  290 + // The 400 KHz clock on 16 MHz MCU is the most 'relaxed' version.
  291 + // Unrolling the inner loop for each bit is not necessary...but
  292 + // getting the timing right does involve some loop shenanigans.
  293 +
  294 + // 40 inst. clocks per bit: HHHHHHHHxxxxxxxxxxxxxxxxxxxxxxxxLLLLLLLL
  295 + // ST instructions: ^ ^ ^
  296 +
  297 + volatile uint8_t next, bit;
  298 +
  299 + hi = *port | pinMask;
  300 + lo = hi & ~pinMask;
  301 + bit = 0x80;
  302 +
  303 + asm volatile(
  304 + "head40:\n\t" // Clk Pseudocode
  305 + "st %a0, %1\n\t" // 2 PORT = hi
  306 + "mov %2, %3\n\t" // 1 next = lo
  307 + "rol %5\n\t" // 1 b <<= 1
  308 + "brcc .+2\n\t" // 1-2 if(b & 0x80) before shift
  309 + "mov %2, %1\n\t" // 0-1 next = hi
  310 + "mul r0, r0\n\t" // 2 nop nop (T = 8)
  311 + "st %a0, %2\n\t" // 2 PORT = next
  312 + "mul r0, r0\n\t" // 2 nop nop
  313 + "mul r0, r0\n\t" // 2 nop nop
  314 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  315 + "mul r0, r0\n\t" // 2 nop nop
  316 + "mul r0, r0\n\t" // 2 nop nop
  317 + "mul r0, r0\n\t" // 2 nop nop
  318 + "mul r0, r0\n\t" // 2 nop nop (T = 24)
  319 + "mul r0, r0\n\t" // 2 nop nop
  320 + "nop\n\t" // 1 nop
  321 + "lsr %4\n\t" // 1 bit >>= 1 (T = 28)
  322 + "brne nextbit40\n\t" // 1-2 if(bit == 0)
  323 + "ldi %4, 0x80\n\t" // 1 bit = 0x80
  324 + "sbiw %7, 1\n\t" // 2 i-- (T = 32)
  325 + "st %a0, %3\n\t" // 2 PORT = lo
  326 + "breq done40\n\t" // 1-2 if(i)
  327 + "nop\n\t" // 1
  328 + "ld %5, %a6+\n\t" // 2 b = *ptr++
  329 + "rjmp head40\n\t" // 2 -> head (T = 40)
  330 + "nextbit40:\n\t"
  331 + "mul r0, r0\n\t" // 2 nop nop (balance sbiw, T=32)
  332 + "st %a0, %3\n\t" // 2 PORT = lo
  333 + "mul r0, r0\n\t" // 2 nop nop
  334 + "mul r0, r0\n\t" // 2 nop nop
  335 + "rjmp head40\n\t" // 2 -> head (T = 40)
  336 + "done40:\n\t"
  337 + ::
  338 + "e" (port), // %a0
  339 + "r" (hi), // %1
  340 + "r" (next), // %2
  341 + "r" (lo), // %3
  342 + "r" (bit), // %4
  343 + "r" (b), // %5
  344 + "e" (ptr), // %a6
  345 + "w" (i) // %7
  346 + ); // end asm
  347 +
  348 + } // See comments later re 'else'
  349 +
  350 +#else
  351 + #error "CPU SPEED NOT SUPPORTED"
  352 + if(0) {}
  353 +#endif
  354 +
  355 + // This bizarre floating 'else' is intentional. Only one of the above
  356 + // blocks is actually compiled (depending on CPU speed), each with one
  357 + // specific 'if' case for pixel speed. This block now handles the
  358 + // commonalternate case for either: 800 KHz pixels w/16 MHz CPU clock,
  359 + // or 400 KHz pixels w/8 MHz CPU. Instruction timing is the same.
  360 + else {
  361 +
  362 + // 20 inst. clocks per bit: HHHHxxxxxxxxxxxxLLLL
  363 + // ST instructions: ^ ^ ^
  364 +
  365 + volatile uint8_t next;
  366 +
  367 + hi = *port | pinMask;
  368 + lo = hi & ~pinMask;
  369 + next = lo;
  370 + if(b & 0x80) next = hi;
  371 +
  372 + // Unrolled...couldn't *quite* fit it in a nested loop like above.
  373 + // Close though, might revisit later.
  374 + asm volatile(
  375 + "head20:\n\t" // Clk Pseudocode
  376 + // Bit 7
  377 + "st %a0, %1\n\t" // 2 PORT = hi
  378 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  379 + "st %a0, %2\n\t" // 2 PORT = next
  380 + "nop\n\t" // 1 nop
  381 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  382 + "sbrc %4, 6\n\t" // 1-2 if(b & 0x40)
  383 + "mov %2, %1\n\t" // 0-1 next = hi
  384 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  385 + "mul r0, r0\n\t" // 2 nop nop
  386 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  387 + "st %a0, %3\n\t" // 2 PORT = lo
  388 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  389 + // Bit 6
  390 + "st %a0, %1\n\t" // 2 PORT = hi
  391 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  392 + "st %a0, %2\n\t" // 2 PORT = next
  393 + "nop\n\t" // 1 nop
  394 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  395 + "sbrc %4, 5\n\t" // 1-2 if(b & 0x20)
  396 + "mov %2, %1\n\t" // 0-1 next = hi
  397 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  398 + "mul r0, r0\n\t" // 2 nop nop
  399 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  400 + "st %a0, %3\n\t" // 2 PORT = lo
  401 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  402 + // Bit 5
  403 + "st %a0, %1\n\t" // 2 PORT = hi
  404 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  405 + "st %a0, %2\n\t" // 2 PORT = next
  406 + "nop\n\t" // 1 nop
  407 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  408 + "sbrc %4, 4\n\t" // 1-2 if(b & 0x10)
  409 + "mov %2, %1\n\t" // 0-1 next = hi
  410 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  411 + "mul r0, r0\n\t" // 2 nop nop
  412 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  413 + "st %a0, %3\n\t" // 2 PORT = lo
  414 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  415 + // Bit 4
  416 + "st %a0, %1\n\t" // 2 PORT = hi
  417 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  418 + "st %a0, %2\n\t" // 2 PORT = next
  419 + "nop\n\t" // 1 nop
  420 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  421 + "sbrc %4, 3\n\t" // 1-2 if(b & 0x08)
  422 + "mov %2, %1\n\t" // 0-1 next = hi
  423 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  424 + "mul r0, r0\n\t" // 2 nop nop
  425 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  426 + "st %a0, %3\n\t" // 2 PORT = lo
  427 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  428 + // Bit 3
  429 + "st %a0, %1\n\t" // 2 PORT = hi
  430 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  431 + "st %a0, %2\n\t" // 2 PORT = next
  432 + "nop\n\t" // 1 nop
  433 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  434 + "sbrc %4, 2\n\t" // 1-2 if(b & 0x04)
  435 + "mov %2, %1\n\t" // 0-1 next = hi
  436 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  437 + "mul r0, r0\n\t" // 2 nop nop
  438 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  439 + "st %a0, %3\n\t" // 2 PORT = lo
  440 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  441 + // Bit 2
  442 + "st %a0, %1\n\t" // 2 PORT = hi
  443 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  444 + "st %a0, %2\n\t" // 2 PORT = next
  445 + "nop\n\t" // 1 nop
  446 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  447 + "sbrc %4, 1\n\t" // 1-2 if(b & 0x02)
  448 + "mov %2, %1\n\t" // 0-1 next = hi
  449 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  450 + "mul r0, r0\n\t" // 2 nop nop
  451 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  452 + "st %a0, %3\n\t" // 2 PORT = lo
  453 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  454 + // Bit 1
  455 + "st %a0, %1\n\t" // 2 PORT = hi
  456 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  457 + "st %a0, %2\n\t" // 2 PORT = next
  458 + "nop\n\t" // 1 nop
  459 + "mov %2, %3\n\t" // 1 next = lo (T = 8)
  460 + "sbrc %4, 0\n\t" // 1-2 if(b & 0x01)
  461 + "mov %2, %1\n\t" // 0-1 next = hi
  462 + "mul r0, r0\n\t" // 2 nop nop (T = 12)
  463 + "mul r0, r0\n\t" // 2 nop nop
  464 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  465 + "st %a0, %3\n\t" // 2 PORT = lo
  466 + "mul r0, r0\n\t" // 2 nop nop (T = 20)
  467 + // Bit 0
  468 + "st %a0, %1\n\t" // 2 PORT = hi
  469 + "mul r0, r0\n\t" // 2 nop nop (T = 4)
  470 + "st %a0, %2\n\t" // 2 PORT = next
  471 + "subi %5, 1\n\t" // 2 i-- (T = 8)
  472 + "breq done20\n\t" // 1-2 if(!i) -> done
  473 + "nop\n\t" // 1 nop
  474 + "ld %4, %a6+\n\t" // 2 b = *ptr++
  475 + "mov %2, %3\n\t" // 1 next = lo (T = 12)
  476 + "sbrc %4, 7\n\t" // 1-2 if(b & 0x80)
  477 + "mov %2, %1\n\t" // 0-1 next = hi
  478 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  479 + "st %a0, %3\n\t" // 2 PORT = lo (T = 18)
  480 + "rjmp head20\n\t" // 2 -> head (T = 20)
  481 + "done20:\n\t" // (T = 10)
  482 + "mul r0, r0\n\t" // 2 nop nop
  483 + "mul r0, r0\n\t" // 2 nop nop
  484 + "mul r0, r0\n\t" // 2 nop nop (T = 16)
  485 + "st %a0, %3\n\t" // 2 PORT = lo (T = 18)
  486 + ::
  487 + "e" (port), // %a0
  488 + "r" (hi), // %1
  489 + "r" (next), // %2
  490 + "r" (lo), // %3
  491 + "r" (b), // %4
  492 + "w" (i), // %5
  493 + "e" (ptr) // %a6
  494 + ); // end asm
  495 +
  496 + } // end wacky else (see comment above)
  497 +
  498 + sei(); // Re-enable interrupts
  499 + endTime = micros(); // Note EOD time for latch on next call
  500 +}
  501 +
  502 +// Set pixel color from separate R,G,B components:
  503 +void Adafruit_NeoPixel::setPixelColor(uint16_t n, uint8_t r, uint8_t g, uint8_t b) {
  504 + if(n < numLEDs) {
  505 + uint8_t *p = &pixels[n * 3];
  506 + if((type & NEO_COLMASK) == NEO_GRB) { *p++ = g; *p++ = r; }
  507 + else { *p++ = r; *p++ = g; }
  508 + *p = b;
  509 + }
  510 +}
  511 +
  512 +// Set pixel color from 'packed' 32-bit RGB color:
  513 +void Adafruit_NeoPixel::setPixelColor(uint16_t n, uint32_t c) {
  514 + if(n < numLEDs) {
  515 + uint8_t *p = &pixels[n * 3];
  516 + if((type & NEO_COLMASK) == NEO_GRB) { *p++ = c >> 8; *p++ = c >> 16; }
  517 + else { *p++ = c >> 16; *p++ = c >> 8; }
  518 + *p = c;
  519 + }
  520 +}
  521 +
  522 +// Convert separate R,G,B into packed 32-bit RGB color.
  523 +// Packed format is always RGB, regardless of LED strand color order.
  524 +uint32_t Adafruit_NeoPixel::Color(uint8_t r, uint8_t g, uint8_t b) {
  525 + return ((uint32_t)r << 16) | ((uint32_t)g << 8) | b;
  526 +}
  527 +
  528 +// Query color from previously-set pixel (returns packed 32-bit RGB value)
  529 +uint32_t Adafruit_NeoPixel::getPixelColor(uint16_t n) {
  530 +
  531 + if(n < numLEDs) {
  532 + uint16_t ofs = n * 3;
  533 + return (uint32_t)(pixels[ofs + 2]) |
  534 + (((type & NEO_COLMASK) == NEO_GRB) ?
  535 + ((uint32_t)(pixels[ofs ]) << 8) |
  536 + ((uint32_t)(pixels[ofs + 1]) << 16)
  537 + :
  538 + ((uint32_t)(pixels[ofs ]) << 16) |
  539 + ((uint32_t)(pixels[ofs + 1]) << 8) );
  540 + }
  541 +
  542 + return 0; // Pixel # is out of bounds
  543 +}
  544 +
  545 +uint16_t Adafruit_NeoPixel::numPixels(void) {
  546 + return numLEDs;
  547 +}
65 Adafruit_NeoPixel.h
... ... @@ -0,0 +1,65 @@
  1 +/*--------------------------------------------------------------------
  2 + This file is part of the NeoPixel library.
  3 +
  4 + NeoPixel is free software: you can redistribute it and/or modify
  5 + it under the terms of the GNU Lesser General Public License as
  6 + published by the Free Software Foundation, either version 3 of
  7 + the License, or (at your option) any later version.
  8 +
  9 + NeoPixel is distributed in the hope that it will be useful,
  10 + but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12 + GNU Lesser General Public License for more details.
  13 +
  14 + You should have received a copy of the GNU Lesser General Public
  15 + License along with NeoPixel. If not, see
  16 + <http://www.gnu.org/licenses/>.
  17 + --------------------------------------------------------------------*/
  18 +
  19 +#if (ARDUINO >= 100)
  20 + #include <Arduino.h>
  21 +#else
  22 + #include <WProgram.h>
  23 + #include <pins_arduino.h>
  24 +#endif
  25 +
  26 +// 'type' flags for LED pixels (third parameter to constructor):
  27 +#define NEO_RGB 0x00 // Wired for RGB data order
  28 +#define NEO_GRB 0x01 // Wired for GRB data order
  29 +#define NEO_COLMASK 0x01
  30 +#define NEO_KHZ400 0x00 // 400 KHz datastream
  31 +#define NEO_KHZ800 0x02 // 800 KHz datastream
  32 +#define NEO_SPDMASK 0x02
  33 +
  34 +class NeoPixel {
  35 +
  36 + public:
  37 +
  38 + // Constructor: number of LEDs, pin number, LED type
  39 + NeoPixel(uint16_t n, uint8_t p = 6, uint8_t t = NEO_GRB + NEO_KHZ800);
  40 +
  41 + void
  42 + begin(void),
  43 + show(void),
  44 + setPixelColor(uint16_t n, uint8_t r, uint8_t g, uint8_t b),
  45 + setPixelColor(uint16_t n, uint32_t c);
  46 + uint16_t
  47 + numPixels(void);
  48 + uint32_t
  49 + Color(uint8_t r, uint8_t g, uint8_t b),
  50 + getPixelColor(uint16_t n);
  51 +
  52 + private:
  53 +
  54 + uint16_t
  55 + numLEDs, // Number of RGB LEDs in strip
  56 + numBytes; // Size of 'pixels' buffer below
  57 + uint8_t
  58 + *pixels, // Holds LED color values (3 bytes each)
  59 + pin, // Output pin number
  60 + pinMask, // Output PORT bitmask
  61 + type; // Pixel flags (400 vs 800 KHz, RGB vs GRB color)
  62 + volatile uint8_t
  63 + *port; // Output PORT register
  64 +
  65 +};
794 COPYING
... ... @@ -0,0 +1,794 @@
  1 +
  2 + GNU GENERAL PUBLIC LICENSE
  3 + Version 3, 29 June 2007
  4 +
  5 + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  6 + Everyone is permitted to copy and distribute verbatim copies
  7 + of this license document, but changing it is not allowed.
  8 +
  9 + Preamble
  10 +
  11 + The GNU General Public License is a free, copyleft license for
  12 +software and other kinds of works.
  13 +
  14 + The licenses for most software and other practical works are designed
  15 +to take away your freedom to share and change the works. By contrast,
  16 +the GNU General Public License is intended to guarantee your freedom to
  17 +share and change all versions of a program--to make sure it remains free
  18 +software for all its users. We, the Free Software Foundation, use the
  19 +GNU General Public License for most of our software; it applies also to
  20 +any other work released this way by its authors. You can apply it to
  21 +your programs, too.
  22 +
  23 + When we speak of free software, we are referring to freedom, not
  24 +price. Our General Public Licenses are designed to make sure that you
  25 +have the freedom to distribute copies of free software (and charge for
  26 +them if you wish), that you receive source code or can get it if you
  27 +want it, that you can change the software or use pieces of it in new
  28 +free programs, and that you know you can do these things.
  29 +
  30 + To protect your rights, we need to prevent others from denying you
  31 +these rights or asking you to surrender the rights. Therefore, you have
  32 +certain responsibilities if you distribute copies of the software, or if
  33 +you modify it: responsibilities to respect the freedom of others.
  34 +
  35 + For example, if you distribute copies of such a program, whether
  36 +gratis or for a fee, you must pass on to the recipients the same
  37 +freedoms that you received. You must make sure that they, too, receive
  38 +or can get the source code. And you must show them these terms so they
  39 +know their rights.
  40 +
  41 + Developers that use the GNU GPL protect your rights with two steps:
  42 +(1) assert copyright on the software, and (2) offer you this License
  43 +giving you legal permission to copy, distribute and/or modify it.
  44 +
  45 + For the developers' and authors' protection, the GPL clearly explains
  46 +that there is no warranty for this free software. For both users' and
  47 +authors' sake, the GPL requires that modified versions be marked as
  48 +changed, so that their problems will not be attributed erroneously to
  49 +authors of previous versions.
  50 +
  51 + Some devices are designed to deny users access to install or run
  52 +modified versions of the software inside them, although the manufacturer
  53 +can do so. This is fundamentally incompatible with the aim of
  54 +protecting users' freedom to change the software. The systematic
  55 +pattern of such abuse occurs in the area of products for individuals to
  56 +use, which is precisely where it is most unacceptable. Therefore, we
  57 +have designed this version of the GPL to prohibit the practice for those
  58 +products. If such problems arise substantially in other domains, we
  59 +stand ready to extend this provision to those domains in future versions
  60 +of the GPL, as needed to protect the freedom of users.
  61 +
  62 + Finally, every program is threatened constantly by software patents.
  63 +States should not allow patents to restrict development and use of
  64 +software on general-purpose computers, but in those that do, we wish to
  65 +avoid the special danger that patents applied to a free program could
  66 +make it effectively proprietary. To prevent this, the GPL assures that
  67 +patents cannot be used to render the program non-free.
  68 +
  69 + The precise terms and conditions for copying, distribution and
  70 +modification follow.
  71 +
  72 + TERMS AND CONDITIONS
  73 +
  74 + 0. Definitions.
  75 +
  76 + "This License" refers to version 3 of the GNU General Public License.
  77 +
  78 + "Copyright" also means copyright-like laws that apply to other kinds of
  79 +works, such as semiconductor masks.
  80 +
  81 + "The Program" refers to any copyrightable work licensed under this
  82 +License. Each licensee is addressed as "you". "Licensees" and
  83 +"recipients" may be individuals or organizations.
  84 +
  85 + To "modify" a work means to copy from or adapt all or part of the work
  86 +in a fashion requiring copyright permission, other than the making of an
  87 +exact copy. The resulting work is called a "modified version" of the
  88 +earlier work or a work "based on" the earlier work.
  89 +
  90 + A "covered work" means either the unmodified Program or a work based
  91 +on the Program.
  92 +
  93 + To "propagate" a work means to do anything with it that, without
  94 +permission, would make you directly or secondarily liable for
  95 +infringement under applicable copyright law, except executing it on a
  96 +computer or modifying a private copy. Propagation includes copying,
  97 +distribution (with or without modification), making available to the
  98 +public, and in some countries other activities as well.
  99 +
  100 + To "convey" a work means any kind of propagation that enables other
  101 +parties to make or receive copies. Mere interaction with a user through
  102 +a computer network, with no transfer of a copy, is not conveying.
  103 +
  104 + An interactive user interface displays "Appropriate Legal Notices"
  105 +to the extent that it includes a convenient and prominently visible
  106 +feature that (1) displays an appropriate copyright notice, and (2)
  107 +tells the user that there is no warranty for the work (except to the
  108 +extent that warranties are provided), that licensees may convey the
  109 +work under this License, and how to view a copy of this License. If
  110 +the interface presents a list of user commands or options, such as a
  111 +menu, a prominent item in the list meets this criterion.
  112 +
  113 + 1. Source Code.
  114 +
  115 + The "source code" for a work means the preferred form of the work
  116 +for making modifications to it. "Object code" means any non-source
  117 +form of a work.
  118 +
  119 + A "Standard Interface" means an interface that either is an official
  120 +standard defined by a recognized standards body, or, in the case of
  121 +interfaces specified for a particular programming language, one that
  122 +is widely used among developers working in that language.
  123 +
  124 + The "System Libraries" of an executable work include anything, other
  125 +than the work as a whole, that (a) is included in the normal form of
  126 +packaging a Major Component, but which is not part of that Major
  127 +Component, and (b) serves only to enable use of the work with that
  128 +Major Component, or to implement a Standard Interface for which an
  129 +implementation is available to the public in source code form. A
  130 +"Major Component", in this context, means a major essential component
  131 +(kernel, window system, and so on) of the specific operating system
  132 +(if any) on which the executable work runs, or a compiler used to
  133 +produce the work, or an object code interpreter used to run it.
  134 +
  135 + The "Corresponding Source" for a work in object code form means all
  136 +the source code needed to generate, install, and (for an executable
  137 +work) run the object code and to modify the work, including scripts to
  138 +control those activities. However, it does not include the work's
  139 +System Libraries, or general-purpose tools or generally available free
  140 +programs which are used unmodified in performing those activities but
  141 +which are not part of the work. For example, Corresponding Source
  142 +includes interface definition files associated with source files for
  143 +the work, and the source code for shared libraries and dynamically
  144 +linked subprograms that the work is specifically designed to require,
  145 +such as by intimate data communication or control flow between those
  146 +subprograms and other parts of the work.
  147 +
  148 + The Corresponding Source need not include anything that users
  149 +can regenerate automatically from other parts of the Corresponding
  150 +Source.
  151 +
  152 + The Corresponding Source for a work in source code form is that
  153 +same work.
  154 +
  155 + 2. Basic Permissions.
  156 +
  157 + All rights granted under this License are granted for the term of
  158 +copyright on the Program, and are irrevocable provided the stated
  159 +conditions are met. This License explicitly affirms your unlimited
  160 +permission to run the unmodified Program. The output from running a
  161 +covered work is covered by this License only if the output, given its
  162 +content, constitutes a covered work. This License acknowledges your
  163 +rights of fair use or other equivalent, as provided by copyright law.
  164 +
  165 + You may make, run and propagate covered works that you do not
  166 +convey, without conditions so long as your license otherwise remains
  167 +in force. You may convey covered works to others for the sole purpose
  168 +of having them make modifications exclusively for you, or provide you
  169 +with facilities for running those works, provided that you comply with
  170 +the terms of this License in conveying all material for which you do
  171 +not control copyright. Those thus making or running the covered works
  172 +for you must do so exclusively on your behalf, under your direction
  173 +and control, on terms that prohibit them from making any copies of
  174 +your copyrighted material outside their relationship with you.
  175 +
  176 + Conveying under any other circumstances is permitted solely under
  177 +the conditions stated below. Sublicensing is not allowed; section 10
  178 +makes it unnecessary.
  179 +
  180 + 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
  181 +
  182 + No covered work shall be deemed part of an effective technological
  183 +measure under any applicable law fulfilling obligations under article
  184 +11 of the WIPO copyright treaty adopted on 20 December 1996, or
  185 +similar laws prohibiting or restricting circumvention of such
  186 +measures.
  187 +
  188 + When you convey a covered work, you waive any legal power to forbid
  189 +circumvention of technological measures to the extent such circumvention
  190 +is effected by exercising rights under this License with respect to
  191 +the covered work, and you disclaim any intention to limit operation or
  192 +modification of the work as a means of enforcing, against the work's
  193 +users, your or third parties' legal rights to forbid circumvention of
  194 +technological measures.
  195 +
  196 + 4. Conveying Verbatim Copies.
  197 +
  198 + You may convey verbatim copies of the Program's source code as you
  199 +receive it, in any medium, provided that you conspicuously and
  200 +appropriately publish on each copy an appropriate copyright notice;
  201 +keep intact all notices stating that this License and any
  202 +non-permissive terms added in accord with section 7 apply to the code;
  203 +keep intact all notices of the absence of any warranty; and give all
  204 +recipients a copy of this License along with the Program.
  205 +
  206 + You may charge any price or no price for each copy that you convey,
  207 +and you may offer support or warranty protection for a fee.
  208 +
  209 + 5. Conveying Modified Source Versions.
  210 +
  211 + You may convey a work based on the Program, or the modifications to
  212 +produce it from the Program, in the form of source code under the
  213 +terms of section 4, provided that you also meet all of these conditions:
  214 +
  215 + a) The work must carry prominent notices stating that you modified
  216 + it, and giving a relevant date.
  217 +
  218 + b) The work must carry prominent notices stating that it is
  219 + released under this License and any conditions added under section
  220 + 7. This requirement modifies the requirement in section 4 to
  221 + "keep intact all notices".
  222 +
  223 + c) You must license the entire work, as a whole, under this
  224 + License to anyone who comes into possession of a copy. This
  225 + License will therefore apply, along with any applicable section 7
  226 + additional terms, to the whole of the work, and all its parts,
  227 + regardless of how they are packaged. This License gives no
  228 + permission to license the work in any other way, but it does not
  229 + invalidate such permission if you have separately received it.
  230 +
  231 + d) If the work has interactive user interfaces, each must display
  232 + Appropriate Legal Notices; however, if the Program has interactive
  233 + interfaces that do not display Appropriate Legal Notices, your
  234 + work need not make them do so.
  235 +
  236 + A compilation of a covered work with other separate and independent
  237 +works, which are not by their nature extensions of the covered work,
  238 +and which are not combined with it such as to form a larger program,
  239 +in or on a volume of a storage or distribution medium, is called an
  240 +"aggregate" if the compilation and its resulting copyright are not
  241 +used to limit the access or legal rights of the compilation's users
  242 +beyond what the individual works permit. Inclusion of a covered work
  243 +in an aggregate does not cause this License to apply to the other
  244 +parts of the aggregate.
  245 +
  246 + 6. Conveying Non-Source Forms.
  247 +
  248 + You may convey a covered work in object code form under the terms
  249 +of sections 4 and 5, provided that you also convey the
  250 +machine-readable Corresponding Source under the terms of this License,
  251 +in one of these ways:
  252 +
  253 + a) Convey the object code in, or embodied in, a physical product
  254 + (including a physical distribution medium), accompanied by the
  255 + Corresponding Source fixed on a durable physical medium
  256 + customarily used for software interchange.
  257 +
  258 + b) Convey the object code in, or embodied in, a physical product
  259 + (including a physical distribution medium), accompanied by a
  260 + written offer, valid for at least three years and valid for as
  261 + long as you offer spare parts or customer support for that product
  262 + model, to give anyone who possesses the object code either (1) a
  263 + copy of the Corresponding Source for all the software in the
  264 + product that is covered by this License, on a durable physical
  265 + medium customarily used for software interchange, for a price no
  266 + more than your reasonable cost of physically performing this
  267 + conveying of source, or (2) access to copy the
  268 + Corresponding Source from a network server at no charge.
  269 +
  270 + c) Convey individual copies of the object code with a copy of the
  271 + written offer to provide the Corresponding Source. This
  272 + alternative is allowed only occasionally and noncommercially, and
  273 + only if you received the object code with such an offer, in accord
  274 + with subsection 6b.
  275 +
  276 + d) Convey the object code by offering access from a designated
  277 + place (gratis or for a charge), and offer equivalent access to the
  278 + Corresponding Source in the same way through the same place at no
  279 + further charge. You need not require recipients to copy the
  280 + Corresponding Source along with the object code. If the place to
  281 + copy the object code is a network server, the Corresponding Source
  282 + may be on a different server (operated by you or a third party)
  283 + that supports equivalent copying facilities, provided you maintain
  284 + clear directions next to the object code saying where to find the
  285 + Corresponding Source. Regardless of what server hosts the
  286 + Corresponding Source, you remain obligated to ensure that it is
  287 + available for as long as needed to satisfy these requirements.
  288 +
  289 + e) Convey the object code using peer-to-peer transmission, provided
  290 + you inform other peers where the object code and Corresponding
  291 + Source of the work are being offered to the general public at no
  292 + charge under subsection 6d.
  293 +
  294 + A separable portion of the object code, whose source code is excluded
  295 +from the Corresponding Source as a System Library, need not be
  296 +included in conveying the object code work.
  297 +
  298 + A "User Product" is either (1) a "consumer product", which means any
  299 +tangible personal property which is normally used for personal, family,
  300 +or household purposes, or (2) anything designed or sold for incorporation
  301 +into a dwelling. In determining whether a product is a consumer product,
  302 +doubtful cases shall be resolved in favor of coverage. For a particular
  303 +product received by a particular user, "normally used" refers to a
  304 +typical or common use of that class of product, regardless of the status
  305 +of the particular user or of the way in which the particular user
  306 +actually uses, or expects or is expected to use, the product. A product
  307 +is a consumer product regardless of whether the product has substantial
  308 +commercial, industrial or non-consumer uses, unless such uses represent
  309 +the only significant mode of use of the product.
  310 +
  311 + "Installation Information" for a User Product means any methods,
  312 +procedures, authorization keys, or other information required to install
  313 +and execute modified versions of a covered work in that User Product from
  314 +a modified version of its Corresponding Source. The information must
  315 +suffice to ensure that the continued functioning of the modified object
  316 +code is in no case prevented or interfered with solely because
  317 +modification has been made.
  318 +
  319 + If you convey an object code work under this section in, or with, or
  320 +specifically for use in, a User Product, and the conveying occurs as
  321 +part of a transaction in which the right of possession and use of the
  322 +User Product is transferred to the recipient in perpetuity or for a
  323 +fixed term (regardless of how the transaction is characterized), the
  324 +Corresponding Source conveyed under this section must be accompanied
  325 +by the Installation Information. But this requirement does not apply
  326 +if neither you nor any third party retains the ability to install
  327 +modified object code on the User Product (for example, the work has
  328 +been installed in ROM).
  329 +
  330 + The requirement to provide Installation Information does not include a
  331 +requirement to continue to provide support service, warranty, or updates
  332 +for a work that has been modified or installed by the recipient, or for
  333 +the User Product in which it has been modified or installed. Access to a
  334 +network may be denied when the modification itself materially and
  335 +adversely affects the operation of the network or violates the rules and
  336 +protocols for communication across the network.
  337 +
  338 + Corresponding Source conveyed, and Installation Information provided,
  339 +in accord with this section must be in a format that is publicly
  340 +documented (and with an implementation available to the public in
  341 +source code form), and must require no special password or key for
  342 +unpacking, reading or copying.
  343 +
  344 + 7. Additional Terms.
  345 +
  346 + "Additional permissions" are terms that supplement the terms of this
  347 +License by making exceptions from one or more of its conditions.
  348 +Additional permissions that are applicable to the entire Program shall
  349 +be treated as though they were included in this License, to the extent
  350 +that they are valid under applicable law. If additional permissions
  351 +apply only to part of the Program, that part may be used separately
  352 +under those permissions, but the entire Program remains governed by
  353 +this License without regard to the additional permissions.
  354 +
  355 + When you convey a copy of a covered work, you may at your option
  356 +remove any additional permissions from that copy, or from any part of
  357 +it. (Additional permissions may be written to require their own
  358 +removal in certain cases when you modify the work.) You may place
  359 +additional permissions on material, added by you to a covered work,
  360 +for which you have or can give appropriate copyright permission.
  361 +
  362 + Notwithstanding any other provision of this License, for material you
  363 +add to a covered work, you may (if authorized by the copyright holders of
  364 +that material) supplement the terms of this License with terms:
  365 +
  366 + a) Disclaiming warranty or limiting liability differently from the
  367 + terms of sections 15 and 16 of this License; or
  368 +
  369 + b) Requiring preservation of specified reasonable legal notices or
  370 + author attributions in that material or in the Appropriate Legal
  371 + Notices displayed by works containing it; or
  372 +
  373 + c) Prohibiting misrepresentation of the origin of that material, or
  374 + requiring that modified versions of such material be marked in
  375 + reasonable ways as different from the original version; or
  376 +
  377 + d) Limiting the use for publicity purposes of names of licensors or
  378 + authors of the material; or
  379 +
  380 + e) Declining to grant rights under trademark law for use of some
  381 + trade names, trademarks, or service marks; or
  382 +
  383 + f) Requiring indemnification of licensors and authors of that
  384 + material by anyone who conveys the material (or modified versions of
  385 + it) with contractual assumptions of liability to the recipient, for
  386 + any liability that these contractual assumptions directly impose on
  387 + those licensors and authors.
  388 +
  389 + All other non-permissive additional terms are considered "further
  390 +restrictions" within the meaning of section 10. If the Program as you
  391 +received it, or any part of it, contains a notice stating that it is
  392 +governed by this License along with a term that is a further
  393 +restriction, you may remove that term. If a license document contains
  394 +a further restriction but permits relicensing or conveying under this
  395 +License, you may add to a covered work material governed by the terms
  396 +of that license document, provided that the further restriction does
  397 +not survive such relicensing or conveying.
  398 +
  399 + If you add terms to a covered work in accord with this section, you
  400 +must place, in the relevant source files, a statement of the
  401 +additional terms that apply to those files, or a notice indicating
  402 +where to find the applicable terms.
  403 +
  404 + Additional terms, permissive or non-permissive, may be stated in the
  405 +form of a separately written license, or stated as exceptions;
  406 +the above requirements apply either way.
  407 +
  408 + 8. Termination.
  409 +
  410 + You may not propagate or modify a covered work except as expressly
  411 +provided under this License. Any attempt otherwise to propagate or
  412 +modify it is void, and will automatically terminate your rights under
  413 +this License (including any patent licenses granted under the third
  414 +paragraph of section 11).
  415 +
  416 + However, if you cease all violation of this License, then your
  417 +license from a particular copyright holder is reinstated (a)
  418 +provisionally, unless and until the copyright holder explicitly and
  419 +finally terminates your license, and (b) permanently, if the copyright
  420 +holder fails to notify you of the violation by some reasonable means
  421 +prior to 60 days after the cessation.
  422 +
  423 + Moreover, your license from a particular copyright holder is
  424 +reinstated permanently if the copyright holder notifies you of the
  425 +violation by some reasonable means, this is the first time you have
  426 +received notice of violation of this License (for any work) from that
  427 +copyright holder, and you cure the violation prior to 30 days after
  428 +your receipt of the notice.
  429 +
  430 + Termination of your rights under this section does not terminate the
  431 +licenses of parties who have received copies or rights from you under
  432 +this License. If your rights have been terminated and not permanently
  433 +reinstated, you do not qualify to receive new licenses for the same
  434 +material under section 10.
  435 +
  436 + 9. Acceptance Not Required for Having Copies.
  437 +
  438 + You are not required to accept this License in order to receive or
  439 +run a copy of the Program. Ancillary propagation of a covered work
  440 +occurring solely as a consequence of using peer-to-peer transmission
  441 +to receive a copy likewise does not require acceptance. However,
  442 +nothing other than this License grants you permission to propagate or
  443 +modify any covered work. These actions infringe copyright if you do
  444 +not accept this License. Therefore, by modifying or propagating a
  445 +covered work, you indicate your acceptance of this License to do so.
  446 +
  447 + 10. Automatic Licensing of Downstream Recipients.
  448 +
  449 + Each time you convey a covered work, the recipient automatically
  450 +receives a license from the original licensors, to run, modify and
  451 +propagate that work, subject to this License. You are not responsible
  452 +for enforcing compliance by third parties with this License.
  453 +
  454 + An "entity transaction" is a transaction transferring control of an
  455 +organization, or substantially all assets of one, or subdividing an
  456 +organization, or merging organizations. If propagation of a covered
  457 +work results from an entity transaction, each party to that
  458 +transaction who receives a copy of the work also receives whatever
  459 +licenses to the work the party's predecessor in interest had or could
  460 +give under the previous paragraph, plus a right to possession of the
  461 +Corresponding Source of the work from the predecessor in interest, if
  462 +the predecessor has it or can get it with reasonable efforts.
  463 +
  464 + You may not impose any further restrictions on the exercise of the
  465 +rights granted or affirmed under this License. For example, you may
  466 +not impose a license fee, royalty, or other charge for exercise of
  467 +rights granted under this License, and you may not initiate litigation
  468 +(including a cross-claim or counterclaim in a lawsuit) alleging that
  469 +any patent claim is infringed by making, using, selling, offering for
  470 +sale, or importing the Program or any portion of it.
  471 +
  472 + 11. Patents.
  473 +
  474 + A "contributor" is a copyright holder who authorizes use under this
  475 +License of the Program or a work on which the Program is based. The
  476 +work thus licensed is called the contributor's "contributor version".
  477 +
  478 + A contributor's "essential patent claims" are all patent claims
  479 +owned or controlled by the contributor, whether already acquired or
  480 +hereafter acquired, that would be infringed by some manner, permitted
  481 +by this License, of making, using, or selling its contributor version,
  482 +but do not include claims that would be infringed only as a
  483 +consequence of further modification of the contributor version. For
  484 +purposes of this definition, "control" includes the right to grant
  485 +patent sublicenses in a manner consistent with the requirements of
  486 +this License.
  487 +
  488 + Each contributor grants you a non-exclusive, worldwide, royalty-free
  489 +patent license under the contributor's essential patent claims, to
  490 +make, use, sell, offer for sale, import and otherwise run, modify and
  491 +propagate the contents of its contributor version.
  492 +
  493 + In the following three paragraphs, a "patent license" is any express
  494 +agreement or commitment, however denominated, not to enforce a patent
  495 +(such as an express permission to practice a patent or covenant not to
  496 +sue for patent infringement). To "grant" such a patent license to a
  497 +party means to make such an agreement or commitment not to enforce a
  498 +patent against the party.
  499 +
  500 + If you convey a covered work, knowingly relying on a patent license,
  501 +and the Corresponding Source of the work is not available for anyone
  502 +to copy, free of charge and under the terms of this License, through a
  503 +publicly available network server or other readily accessible means,
  504 +then you must either (1) cause the Corresponding Source to be so
  505 +available, or (2) arrange to deprive yourself of the benefit of the
  506 +patent license for this particular work, or (3) arrange, in a manner
  507 +consistent with the requirements of this License, to extend the patent
  508 +license to downstream recipients. "Knowingly relying" means you have
  509 +actual knowledge that, but for the patent license, your conveying the
  510 +covered work in a country, or your recipient's use of the covered work
  511 +in a country, would infringe one or more identifiable patents in that
  512 +country that you have reason to believe are valid.
  513 +
  514 + If, pursuant to or in connection with a single transaction or
  515 +arrangement, you convey, or propagate by procuring conveyance of, a
  516 +covered work, and grant a patent license to some of the parties
  517 +receiving the covered work authorizing them to use, propagate, modify
  518 +or convey a specific copy of the covered work, then the patent license
  519 +you grant is automatically extended to all recipients of the covered
  520 +work and works based on it.
  521 +
  522 + A patent license is "discriminatory" if it does not include within
  523 +the scope of its coverage, prohibits the exercise of, or is
  524 +conditioned on the non-exercise of one or more of the rights that are
  525 +specifically granted under this License. You may not convey a covered
  526 +work if you are a party to an arrangement with a third party that is
  527 +in the business of distributing software, under which you make payment
  528 +to the third party based on the extent of your activity of conveying
  529 +the work, and under which the third party grants, to any of the
  530 +parties who would receive the covered work from you, a discriminatory
  531 +patent license (a) in connection with copies of the covered work
  532 +conveyed by you (or copies made from those copies), or (b) primarily
  533 +for and in connection with specific products or compilations that
  534 +contain the covered work, unless you entered into that arrangement,
  535 +or that patent license was granted, prior to 28 March 2007.
  536 +
  537 + Nothing in this License shall be construed as excluding or limiting
  538 +any implied license or other defenses to infringement that may
  539 +otherwise be available to you under applicable patent law.
  540 +
  541 + 12. No Surrender of Others' Freedom.
  542 +
  543 + If conditions are imposed on you (whether by court order, agreement or
  544 +otherwise) that contradict the conditions of this License, they do not
  545 +excuse you from the conditions of this License. If you cannot convey a
  546 +covered work so as to satisfy simultaneously your obligations under this
  547 +License and any other pertinent obligations, then as a consequence you may
  548 +not convey it at all. For example, if you agree to terms that obligate you
  549 +to collect a royalty for further conveying from those to whom you convey
  550 +the Program, the only way you could satisfy both those terms and this
  551 +License would be to refrain entirely from conveying the Program.
  552 +
  553 + 13. Use with the GNU Affero General Public License.
  554 +
  555 + Notwithstanding any other provision of this License, you have
  556 +permission to link or combine any covered work with a work licensed
  557 +under version 3 of the GNU Affero General Public License into a single
  558 +combined work, and to convey the resulting work. The terms of this
  559 +License will continue to apply to the part which is the covered work,
  560 +but the special requirements of the GNU Affero General Public License,
  561 +section 13, concerning interaction through a network will apply to the
  562 +combination as such.
  563 +
  564 + 14. Revised Versions of this License.
  565 +
  566 + The Free Software Foundation may publish revised and/or new versions of
  567 +the GNU General Public License from time to time. Such new versions will
  568 +be similar in spirit to the present version, but may differ in detail to
  569 +address new problems or concerns.
  570 +
  571 + Each version is given a distinguishing version number. If the
  572 +Program specifies that a certain numbered version of the GNU General
  573 +Public License "or any later version" applies to it, you have the
  574 +option of following the terms and conditions either of that numbered
  575 +version or of any later version published by the Free Software
  576 +Foundation. If the Program does not specify a version number of the
  577 +GNU General Public License, you may choose any version ever published
  578 +by the Free Software Foundation.
  579 +
  580 + If the Program specifies that a proxy can decide which future
  581 +versions of the GNU General Public License can be used, that proxy's
  582 +public statement of acceptance of a version permanently authorizes you
  583 +to choose that version for the Program.
  584 +
  585 + Later license versions may give you additional or different
  586 +permissions. However, no additional obligations are imposed on any
  587 +author or copyright holder as a result of your choosing to follow a
  588 +later version.
  589 +
  590 + 15. Disclaimer of Warranty.
  591 +
  592 + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
  593 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  594 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
  595 +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
  596 +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  597 +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
  598 +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
  599 +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  600 +
  601 + 16. Limitation of Liability.
  602 +