2 Copyright 2016 flabbergast <s3+flabbergast@sdfeu.org>
3 Copyright 2017 jpetermans <tibcmhhm@gmail.com>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * IS31FL3731C matrix LED driver from ISSI
22 * datasheet: http://www.issi.com/WW/pdf/31FL3731C.pdf
31 #include "led_controller.h"
38 - digits mean "row" and "col", i.e. 45 means C4-5 in the IS31 datasheet, matrix A
40 11 12 13 14 15 16 17 18 21 22 23 24 25 26 27*
41 28 31 32 33 34 35 36 37 38 41 42 43 44 45
42 46 47 48 51 52 53 54 55 56 57 58 61 62
43 63 64 65 66 67 68 71 72 73 74 75 76 77*
44 78 81 82 83 84 85 86 87
46 *Unused in Alphabet Layout
50 each page has 0xB4 bytes
51 0 - 0x11: LED control (on/off):
52 order: CA1, CB1, CA2, CB2, .... (CA - matrix A, CB - matrix B)
53 CAn controls Cn-8 .. Cn-1 (LSbit)
54 0x12 - 0x23: blink control (like "LED control")
55 0x24 - 0xB3: PWM control: byte per LED, 0xFF max on
56 order same as above (CA 1st row (8bytes), CB 1st row (8bytes), ...)
59 // Which LED should be used for CAPS LOCK indicator
60 #if !defined(CAPS_LOCK_LED_ADDRESS)
61 #define CAPS_LOCK_LED_ADDRESS 46
64 #if !defined(NUM_LOCK_LED_ADDRESS)
65 #define NUM_LOCK_LED_ADDRESS 85
68 /* Which LED should breathe during sleep */
69 #if !defined(BREATHE_LED_ADDRESS)
70 #define BREATHE_LED_ADDRESS CAPS_LOCK_LED_ADDRESS
75 * ================= */
76 static const I2CConfig i2ccfg = {
77 400000 // clock speed (Hz); 400kHz max for IS31
83 // internal communication buffers
84 uint8_t tx[2] __attribute__((aligned(2)));
85 uint8_t rx[1] __attribute__((aligned(2)));
87 // buffer for sending the whole page at once (used also as a temp buffer)
88 uint8_t full_page[0xB4+1] = {0};
90 // LED mask (which LEDs are present, selected by bits)
91 // IC60 pcb uses only CA matrix.
92 // Each byte is a control pin for 8 leds ordered 8-1
93 const uint8_t all_on_leds_mask[0x12] = {
94 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF,
95 0x00, 0xFF, 0x00, 0xFF, 0x00, 0x7F, 0x00, 0x00, 0x00
98 // array to hold brightness pwm steps
99 const uint8_t pwm_levels[5] = {
100 0x00, 0x16, 0x4E, 0xA1, 0xFF
103 // array to write to pwm register
104 uint8_t pwm_register_array[9] = {0};
107 /* ============================
108 * communication functions
109 * ============================ */
110 msg_t is31_select_page(uint8_t page) {
111 tx[0] = IS31_COMMANDREGISTER;
113 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
116 msg_t is31_write_data(uint8_t page, uint8_t *buffer, uint8_t size) {
117 is31_select_page(page);
118 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, buffer, size, NULL, 0, US2ST(IS31_TIMEOUT));
121 msg_t is31_write_register(uint8_t page, uint8_t reg, uint8_t data) {
122 is31_select_page(page);
125 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
128 msg_t is31_read_register(uint8_t page, uint8_t reg, uint8_t *result) {
129 is31_select_page(page);
132 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 1, result, 1, US2ST(IS31_TIMEOUT));
135 /* ========================
136 * initialise the IS31 chip
137 * ======================== */
138 void is31_init(void) {
139 // just to be sure that it's all zeroes
140 __builtin_memset(full_page,0,0xB4+1);
141 // zero function page, all registers (assuming full_page is all zeroes)
142 is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
143 // disable hardware shutdown
144 palSetPadMode(GPIOB, 16, PAL_MODE_OUTPUT_PUSHPULL);
145 palSetPad(GPIOB, 16);
146 chThdSleepMilliseconds(10);
148 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
149 chThdSleepMilliseconds(10);
150 // zero function page, all registers
151 is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
152 chThdSleepMilliseconds(10);
153 // software shutdown disable (i.e. turn stuff on)
154 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
155 chThdSleepMilliseconds(10);
156 // zero all LED registers on all 8 pages
159 is31_write_data(i, full_page, 0xB4 + 1);
160 chThdSleepMilliseconds(5);
164 /* ==================
166 * ================== */
167 #define LED_MAILBOX_NUM_MSGS 5
168 static msg_t led_mailbox_queue[LED_MAILBOX_NUM_MSGS];
169 mailbox_t led_mailbox;
170 static THD_WORKING_AREA(waLEDthread, 256);
171 static THD_FUNCTION(LEDthread, arg) {
173 chRegSetThreadName("LEDthread");
176 uint8_t control_register_word[2] = {0};//2 bytes: register address, byte to write
177 uint8_t led_control_reg[0x13] = {0};//led control register start address + 0x12 bytes
179 //persistent status variables
180 uint8_t pwm_step_status, page_status, capslock_status, numlock_status;
183 uint8_t temp, msg_type;
187 // initialize persistent variables
188 pwm_step_status = 4; //full brightness
189 page_status = 0; //start frame 0 (all off/on)
190 numlock_status = (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) ? 1 : 0;
191 capslock_status = (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) ? 1 : 0;
194 // wait for a message (asynchronous)
195 // (messages are queued (up to LED_MAILBOX_NUM_MSGS) if they can't
196 // be processed right away
197 chMBFetch(&led_mailbox, &msg, TIME_INFINITE);
198 msg_type = msg & 0xFF; //first byte is action information
199 msg_args[0] = (msg >> 8) & 0xFF;
200 msg_args[1] = (msg >> 16) & 0XFF;
201 msg_args[2] = (msg >> 24) & 0xFF;
206 //write full byte to pin address, msg_args[1] = pin #, msg_args[0] = 8 bits to write
207 //writes only to currently displayed page
208 write_led_byte(page_status, msg_args[1], msg_args[0]);
212 //on/off/toggle single led, msg_args[0] = row/col of led, msg_args[1] = page
213 set_led_bit(msg_args[1], control_register_word, msg_args[0], 0);
216 set_led_bit(msg_args[1], control_register_word, msg_args[0], 1);
219 set_led_bit(msg_args[1], control_register_word, msg_args[0], 2);
223 //on/off/toggle single led, msg_args[0] = row/col of led
224 set_led_bit(msg_args[1], control_register_word, msg_args[0], 4);
227 set_led_bit(msg_args[1], control_register_word, msg_args[0], 5);
229 case BLINK_TOGGLE_LED:
230 set_led_bit(msg_args[1], control_register_word, msg_args[0], 6);
234 //turn on/off all leds, msg_args = unused
235 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
236 chThdSleepMilliseconds(5);
237 is31_read_register(0, 0x00, &temp);
238 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
240 led_control_reg[0] = 0;
242 //toggle led mask based on current state (temp)
243 if (temp==0 || page_status > 0) {
244 __builtin_memcpy(led_control_reg+1, all_on_leds_mask, 0x12);
246 __builtin_memset(led_control_reg+1, 0, 0x12);
248 is31_write_data(0, led_control_reg, 0x13);
250 if (page_status > 0) {
251 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
255 //maintain lock leds, reset to off and force recheck to blink of all leds toggled on
258 led_set(host_keyboard_leds());
262 case TOGGLE_BACKLIGHT:
263 //msg_args[0] = on/off
265 //populate 9 byte rows to be written to each pin, first byte is register (pin) address
266 if (msg_args[0] == 1) {
267 __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
269 __builtin_memset(pwm_register_array+1, 0, 8);
273 //first byte is register address, every 0x10 9 bytes is A-matrix pwm pins
274 pwm_register_array[0] = 0x24 + (i * 0x10);
275 is31_write_data(0,pwm_register_array,9);
280 //msg_args[0] = page to toggle on
281 if (page_status != msg_args[0]) {
282 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_args[0]);
283 page_status = msg_args[0];
285 //maintain lock leds, reset to off and force recheck for new page
288 led_set(host_keyboard_leds());
293 //led_args[0] = page to reset
294 led_control_reg[0] = 0;
295 __builtin_memset(led_control_reg+1, 0, 0x12);
296 is31_write_data(msg_args[0], led_control_reg, 0x13);
298 //repeat for blink register
299 led_control_reg[0] = 0x12;
300 is31_write_data(msg_args[0], led_control_reg, 0x13);
303 case TOGGLE_NUM_LOCK:
304 //msg_args[0] = 0 or 1, off/on
305 if (numlock_status != msg_args[0]) {
306 set_lock_leds(NUM_LOCK_LED_ADDRESS, msg_args[0], page_status);
307 numlock_status = msg_args[0];
310 case TOGGLE_CAPS_LOCK:
311 //msg_args[0] = 0 or 1, off/on
312 if (capslock_status != msg_args[0]) {
313 set_lock_leds(CAPS_LOCK_LED_ADDRESS, msg_args[0], page_status);
314 capslock_status = msg_args[0];
318 case STEP_BRIGHTNESS:
319 //led_args[0] = step up (1) or down (0)
320 switch (msg_args[0]) {
322 if (pwm_step_status == 0) {
330 if (pwm_step_status == 4) {
338 //populate 8 byte arrays to write on each pin
339 //first byte is register address, every 0x10 9 bytes are A-matrix pwm pins
340 __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
343 pwm_register_array[0] = 0x24 + (i * 0x10);
344 is31_write_data(0,pwm_register_array,9);
351 /* ==============================
352 * led processing functions
353 * ============================== */
355 void set_led_bit (uint8_t page, uint8_t *led_control_word, uint8_t led_addr, uint8_t action) {
356 //returns 2 bytes: led control register address and byte to write
357 //action: 0 - off, 1 - on, 2 - toggle, 4 - blink on, 5 - blink off, 6 - toggle blink
359 uint8_t control_reg_addr, column_bit, column_byte, temp, blink_bit;
361 //check for valid led address
362 if (led_addr < 0 || led_addr > 87 || led_addr % 10 > 8) {
366 blink_bit = action>>2;//check for blink bit
367 action &= ~(1<<2); //strip blink bit
369 //led_addr tens column is pin#, ones column is bit position in 8-bit mask
370 control_reg_addr = ((led_addr / 10) % 10 - 1 ) * 0x02;// A-matrix is every other byte
371 control_reg_addr += blink_bit == 1 ? 0x12 : 0x00;//if blink_bit, shift 12 bytes to blink register
373 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
374 chThdSleepMilliseconds(5);
375 is31_read_register(page, control_reg_addr, &temp);//maintain status of leds on this byte
376 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
378 column_bit = 1<<(led_addr % 10 - 1);
383 column_byte &= ~column_bit;
386 column_byte |= column_bit;
389 column_byte ^= column_bit;
393 //return word to be written in register
394 led_control_word[0] = control_reg_addr;
395 led_control_word[1] = column_byte;
396 is31_write_data (page, led_control_word, 0x02);
399 void write_led_byte (uint8_t page, uint8_t row, uint8_t led_byte) {
400 uint8_t led_control_word[2] = {0};//register address and on/off byte
402 led_control_word[0] = (row - 1 ) * 0x02;// A-matrix is every other byte
403 led_control_word[1] = led_byte;
404 is31_write_data(page, led_control_word, 0x02);
407 void write_led_page (uint8_t page, uint8_t *user_led_array, uint8_t led_count) {
410 uint8_t led_control_register[0x13] = {0};
412 __builtin_memset(led_control_register,0,13);
414 for(i=0;i<led_count;i++){
415 //shift pin by 1 for led register 0x00 address
416 pin = ((user_led_array[i] / 10) % 10 - 1 ) * 2 + 1;
417 col = user_led_array[i] % 10 - 1;
418 led_control_register[pin] |= 1<<(col);
421 is31_write_data(page, led_control_register, 0x13);
424 void set_lock_leds(uint8_t led_addr, uint8_t led_action, uint8_t page) {
426 uint8_t led_control_word[2] = {0};
428 //blink if all leds are on
430 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
431 chThdSleepMilliseconds(5);
432 is31_read_register(0, 0x00, &temp);
433 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
436 led_action |= (1<<2); //set blink bit
440 set_led_bit(page,led_control_word,led_addr,led_action);
443 /* =====================
444 * hook into user keymap
445 * ===================== */
446 void led_controller_init(void) {
451 palSetPadMode(GPIOB, 0, PAL_MODE_ALTERNATIVE_2); // PTB0/I2C0/SCL
452 palSetPadMode(GPIOB, 1, PAL_MODE_ALTERNATIVE_2); // PTB1/I2C0/SDA
454 i2cStart(&I2CD1, &i2ccfg);
455 // try high drive (from kiibohd)
456 I2CD1.i2c->C2 |= I2Cx_C2_HDRS;
457 // try glitch fixing (from kiibohd)
460 chThdSleepMilliseconds(10);
462 /* initialise IS31 chip */
465 //set Display Option Register so all pwm intensity is controlled from page 0
466 //enable blink and set blink period to 0.27s x rate
467 is31_write_register(IS31_FUNCTIONREG, IS31_REG_DISPLAYOPT, IS31_REG_DISPLAYOPT_INTENSITY_SAME + IS31_REG_DISPLAYOPT_BLINK_ENABLE + 4);
469 /* set full pwm on page 1 */
470 pwm_register_array[0] = 0;
471 __builtin_memset(pwm_register_array+1, 0xFF, 8);
473 pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
474 is31_write_data(0, pwm_register_array, 9);
475 chThdSleepMilliseconds(5);
478 /* enable breathing when the displayed page changes */
479 // Fade-in Fade-out, time = 26ms * 2^N, N=3
480 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (3<<4)|3);
481 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
483 /* more time consuming LED processing should be offloaded into
484 * a thread, with asynchronous messaging. */
485 chMBObjectInit(&led_mailbox, led_mailbox_queue, LED_MAILBOX_NUM_MSGS);
486 chThdCreateStatic(waLEDthread, sizeof(waLEDthread), LOWPRIO, LEDthread, NULL);