]> git.donarmstrong.com Git - qmk_firmware.git/blob - drivers/avr/ws2812.h
fix the clueboard layout json
[qmk_firmware.git] / drivers / avr / ws2812.h
1 /*
2  * light weight WS2812 lib include
3  *
4  * Version 2.3  - Nev 29th 2015
5  * Author: Tim (cpldcpu@gmail.com)
6  *
7  * Please do not change this file! All configuration is handled in "ws2812_config.h"
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  */
22
23 #ifndef LIGHT_WS2812_H_
24 #define LIGHT_WS2812_H_
25
26 #include <avr/io.h>
27 #include <avr/interrupt.h>
28 //#include "ws2812_config.h"
29 //#include "i2cmaster.h"
30
31 #include "rgblight_types.h"
32
33
34 /* User Interface
35  *
36  * Input:
37  *         ledarray:           An array of GRB data describing the LED colors
38  *         number_of_leds:     The number of LEDs to write
39  *         pinmask (optional): Bitmask describing the output bin. e.g. _BV(PB0)
40  *
41  * The functions will perform the following actions:
42  *         - Set the data-out pin as output
43  *         - Send out the LED data
44  *         - Wait 50�s to reset the LEDs
45  */
46
47 void ws2812_setleds     (LED_TYPE *ledarray, uint16_t number_of_leds);
48 void ws2812_setleds_pin (LED_TYPE *ledarray, uint16_t number_of_leds,uint8_t pinmask);
49 void ws2812_setleds_rgbw(LED_TYPE *ledarray, uint16_t number_of_leds);
50
51 /*
52  * Old interface / Internal functions
53  *
54  * The functions take a byte-array and send to the data output as WS2812 bitstream.
55  * The length is the number of bytes to send - three per LED.
56  */
57
58 void ws2812_sendarray     (uint8_t *array,uint16_t length);
59 void ws2812_sendarray_mask(uint8_t *array,uint16_t length, uint8_t pinmask);
60
61
62 /*
63  * Internal defines
64  */
65 #ifndef CONCAT
66 #define CONCAT(a, b)            a ## b
67 #endif
68 #ifndef CONCAT_EXP
69 #define CONCAT_EXP(a, b)   CONCAT(a, b)
70 #endif
71
72 // #define ws2812_PORTREG  CONCAT_EXP(PORT,ws2812_port)
73 // #define ws2812_DDRREG   CONCAT_EXP(DDR,ws2812_port)
74
75 #endif /* LIGHT_WS2812_H_ */