2 Copyright 2016 flabbergast <s3+flabbergast@sdfeu.org>
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
9 This program 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 General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * WF uses IS31FL3731C matrix LED driver from ISSI
21 * datasheet: http://www.issi.com/WW/pdf/31FL3731C.pdf
29 #include "led_controller.h"
36 - digits mean "row" and "col", i.e. 45 means C4-5 in the IS31 datasheet, matrix A
38 11 12 13 14 15 16 17 18 21 22 23 24 25 26 27*
39 28 31 32 33 34 35 36 37 38 41 42 43 44 45
40 46 47 48 51 52 53 54 55 56 57 58 61 62
41 63 64 65 66 67 68 71 72 73 74 75 76 77*
42 78 81 82 83 84 85 86 87
44 *Unused in Alphabet Layout
48 each page has 0xB4 bytes
49 0 - 0x11: LED control (on/off):
50 order: CA1, CB1, CA2, CB2, .... (CA - matrix A, CB - matrix B)
51 CAn controls Cn-8 .. Cn-1 (LSbit)
52 0x12 - 0x23: blink control (like "LED control")
53 0x24 - 0xB3: PWM control: byte per LED, 0xFF max on
54 order same as above (CA 1st row (8bytes), CB 1st row (8bytes), ...)
57 /* Which LED should be used for CAPS LOCK indicator
58 * The usual Caps Lock position is C4-6, so the address is
59 * 0x24 + (4-1)*0x10 + (8-1) = 0x59 */
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 // See page comment above, control alternates CA matrix/CB matrix
92 // IC60 pcb uses only CA matrix.
93 // Each byte is a control pin for 8 leds ordered 8-1
94 const uint8_t is31_ic60_leds_mask[0x12] = {
95 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF,
96 0x00, 0xFF, 0x00, 0xFF, 0x00, 0x7F, 0x00, 0x00, 0x00
99 // array to hold brightness pwm steps
100 const uint8_t pwm_levels[5] = {
101 0x00, 0x16, 0x4E, 0xA1, 0xFF
104 // array to write to pwm register
105 uint8_t pwm_register_array[9] = {0};
108 /* ============================
109 * communication functions
110 * ============================ */
111 msg_t is31_select_page(uint8_t page) {
112 tx[0] = IS31_COMMANDREGISTER;
114 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
117 msg_t is31_write_data(uint8_t page, uint8_t *buffer, uint8_t size) {
118 is31_select_page(page);
119 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, buffer, size, NULL, 0, US2ST(IS31_TIMEOUT));
122 msg_t is31_write_register(uint8_t page, uint8_t reg, uint8_t data) {
123 is31_select_page(page);
126 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
129 msg_t is31_read_register(uint8_t page, uint8_t reg, uint8_t *result) {
130 is31_select_page(page);
133 return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 1, result, 1, US2ST(IS31_TIMEOUT));
136 /* ========================
137 * initialise the IS31 chip
138 * ======================== */
139 void is31_init(void) {
140 // just to be sure that it's all zeroes
141 __builtin_memset(full_page,0,0xB4+1);
142 // zero function page, all registers (assuming full_page is all zeroes)
143 is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
144 // disable hardware shutdown
145 palSetPadMode(GPIOB, 16, PAL_MODE_OUTPUT_PUSHPULL);
146 palSetPad(GPIOB, 16);
147 chThdSleepMilliseconds(10);
149 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, 0);
150 chThdSleepMilliseconds(10);
151 // software shutdown disable (i.e. turn stuff on)
152 is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
153 chThdSleepMilliseconds(10);
154 // zero all LED registers on all 8 pages
157 is31_write_data(i, full_page, 0xB4 + 1);
158 chThdSleepMilliseconds(1);
162 /* ==================
164 * ================== */
165 #define LED_MAILBOX_NUM_MSGS 5
166 static msg_t led_mailbox_queue[LED_MAILBOX_NUM_MSGS];
167 mailbox_t led_mailbox;
168 static THD_WORKING_AREA(waLEDthread, 256);
169 static THD_FUNCTION(LEDthread, arg) {
171 chRegSetThreadName("LEDthread");
175 //persistent status variables
176 uint8_t backlight_status, lock_status, led_step_status, layer_status;
177 uint8_t led_control_reg[0x13] = {0};//led control register start address + 0x12 bytes
180 uint8_t temp, msg_type, msg_led;
183 /* //control register variables
184 uint8_t page, save_page, save_breath1, save_breath2;
188 // initialize persistent variables
189 backlight_status = 0;
190 lock_status = 0;//TODO: does keyboard remember locks?
191 led_step_status = 4; //full brightness
195 // wait for a message (asynchronous)
196 // (messages are queued (up to LED_MAILBOX_NUM_MSGS) if they can't
197 // be processed right away)
198 chMBFetch(&led_mailbox, &msg, TIME_INFINITE);
199 msg_type = (msg >> 8) & 0xFF; //first byte is msg type
200 msg_led = (msg) & 0xFF; //second byte is action information
202 xprintf("--------------------\n");
203 xprintf("mailbox fetch\nmsg: %X\n", msg);
204 xprintf("type: %X - led: %X\n", msg_type, msg_led); //test if msg_type is 1 or 2 bytes after mask
207 //TODO: lighting key led on keypress
211 //TODO: toggle existing indicator off, or let user do this, but write frame 7 for every led change
212 //turn on single led, msg_led = row/col of led
213 xprintf("TOGGLE_LED\n");
214 set_led_bit(led_control_reg, msg_led, 1);
216 is31_write_data (7, led_control_reg, 0x12+1);
217 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 7);
222 xprintf("TOGGLE_ALL\n");
223 //msg_led = unused, TODO: consider using msg_led to toggle layer display
224 is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &temp);
226 //if LED_ALL is on then toggle off, any other layer, turn on LED_ALL
228 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
230 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 1);
232 is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &temp);
235 case TOGGLE_BACKLIGHT:
237 //TODO: consider Frame 0 as on/off layer and toggle led control register here
238 xprintf("TOGGLE_BACKLIGHT\n");
239 backlight_status ^= 1;
240 is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &temp);
243 page = backlight_status == 0 ? 0 : layer_status;
244 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, page);
247 case TOGGLE_LAYER_LEDS://show layer indicator or full map of layer keys.
248 //TODO: change so user can flag which they want, indiv or full map in fn_actions
249 //msg_led = layer to toggle on
250 xprintf("TOGGLE_LAYER_LEDS\n");
251 is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &temp);
253 if(temp == msg_led) {
254 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 7);
257 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_led);
258 layer_status = msg_led;
262 case TOGGLE_NUM_LOCK:
263 //msg_led = 0 or 1, off/on
264 //TODO: confirm toggling works and doesn't get out of sync
265 set_lock_leds(USB_LED_NUM_LOCK, msg_led);
268 case TOGGLE_CAPS_LOCK:
269 //msg_led = 0 or 1, off/on
270 //TODO: confirm toggling works and doesn't get out of sync
271 set_lock_leds(USB_LED_CAPS_LOCK, msg_led);
276 case STEP_BRIGHTNESS:
277 //pwm_levels[] bounds checking, loop through array
278 //TODO: find a cleaner way to walk through this logic
279 if (msg_led == 0 && led_step_status == 0) {
285 if (msg_led == 1 && led_step_status == 4) {
291 //TODO: this seems a messy way to populate the pwm register
292 //mimic whitefox init which uses memcpy
293 //populate the 9 byte rows to be written to each pin, first byte is register (pin) address
295 pwm_register_array[i]=pwm_levels[led_step_status];
298 pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
299 is31_write_data(0, pwm_register_array, 9);//first page controls pwm in all pages (init Display Option register)
303 /* case LED_MSG_SLEEP_LED_ON:
304 // save current settings
305 is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &save_page);
306 is31_read_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, &save_breath1);
307 is31_read_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, &save_breath2);
308 // use pages 7 and 8 for (hardware) breathing (assuming they're empty)
309 is31_write_register(6, BREATHE_LED_ADDRESS, 0xFF);
310 is31_write_register(7, BREATHE_LED_ADDRESS, 0x00);
311 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (6<<4)|6);
312 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
313 retval = MSG_TIMEOUT;
315 while(retval == MSG_TIMEOUT) {
316 // switch to the other page
317 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, temp);
318 temp = (temp == 6 ? 7 : 6);
319 // the times should be sufficiently long for IS31 to finish switching pages
320 retval = chMBFetch(&led_mailbox, &msg, MS2ST(temp == 6 ? 4000 : 6000));
322 // received a message (should be a wakeup), so restore previous state
323 chThdSleepMilliseconds(3000); // need to wait until the page change finishes
324 // note: any other messages are queued
325 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, save_breath1);
326 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, save_breath2);
327 is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, save_page);
329 case LED_MSG_SLEEP_LED_OFF:
330 // should not get here; wakeup should be received in the branch above break;
334 xprintf("--------------------\n");
339 /* ========================
341 * ======================== */
342 void set_led_bit (uint8_t *led_control_reg, uint8_t msg_led, uint8_t toggle_on) {
343 uint8_t row_byte, column_bit;
344 //msg_led tens column is pin#
345 //ones column is bit position in 8-bit mask
346 //first byte is register address 0x00
347 row_byte = ((msg_led / 10) % 10 - 1 ) * 2 + 1;// A register is every other 8 bits
348 column_bit = 1<<(msg_led % 10 - 1);
351 led_control_reg[row_byte] |= 1<<(column_bit);
353 led_control_reg[row_byte] &= ~1<<(column_bit);
357 //TODO: not toggling off correctly
358 //TODO: confirm led_off page still has FF pwm for all
359 void set_lock_leds(uint8_t lock_type, uint8_t lock_status) {
361 uint8_t led_addr, temp;
362 uint8_t control_reg[2] = {0};//register address and led bits
365 case USB_LED_NUM_LOCK:
366 led_addr = NUM_LOCK_LED_ADDRESS;
368 case USB_LED_CAPS_LOCK:
369 led_addr = CAPS_LOCK_LED_ADDRESS;
371 #ifdef SCROLL_LOCK_LED_ADDRESS
372 case USB_LED_SCROLL_LOCK:
373 led_addr = SCROLL_LOCK_LED_ADDRESS;
376 #ifdef COMPOSE_LED_ADDRESS
377 case USB_LED_COMPOSE:
378 led_addr = COMPOSE_LED_ADDRESS;
381 #ifdef SCROLL_LOCK_LED_ADDRESS
383 led_addr = KANA_LED_ADDRESS;
387 xprintf("led_addr: %X\n", led_addr);
388 chThdSleepMilliseconds(30);
389 control_reg[0] = ((led_addr / 10) % 10 - 1 ) * 0x02;// A-register is every other byte
390 xprintf("control_reg: %X\n", control_reg[0]);
391 chThdSleepMilliseconds(30);
393 for(page=BACKLIGHT_OFF_LOCK_LED_OFF; page<8; page++) { //set in led_controller.h
394 is31_read_register(page,control_reg[0],&temp);//need to maintain status of leds in this row (1 byte)
395 chThdSleepMilliseconds(30);
396 xprintf("1lock byte: %X\n", temp);
397 chThdSleepMilliseconds(30);
399 temp |= 1<<(led_addr % 10 - 1);
401 temp &= ~1<<(led_addr % 10 - 1);
403 chThdSleepMilliseconds(30);
404 xprintf("2lock byte: %X\n", temp);
405 chThdSleepMilliseconds(30);
406 control_reg[1] = temp;
407 is31_write_data (page, control_reg, 0x02);
411 void write_led_page (uint8_t page, const uint8_t *led_array, uint8_t led_count) {
414 uint8_t temp_control_reg[0x13] = {0};//led control register start address + 0x12 bytes
416 for(i=0;i<led_count;i++){
417 row = ((led_array[i] / 10) % 10 - 1 ) * 2 + 1;//includes 1 byte shift for led register 0x00 address
418 col = led_array[i] % 10 - 1;
420 temp_control_reg[row] |= 1<<(col);
423 is31_write_data(page, temp_control_reg, 0x13);
425 /* =====================
426 * hook into user keymap
427 * ===================== */
428 void led_controller_init(void) {
433 palSetPadMode(GPIOB, 0, PAL_MODE_ALTERNATIVE_2); // PTB0/I2C0/SCL
434 palSetPadMode(GPIOB, 1, PAL_MODE_ALTERNATIVE_2); // PTB1/I2C0/SDA
436 i2cStart(&I2CD1, &i2ccfg);
437 // try high drive (from kiibohd)
438 I2CD1.i2c->C2 |= I2Cx_C2_HDRS;
439 // try glitch fixing (from kiibohd)
442 chThdSleepMilliseconds(10);
444 /* initialise IS31 chip */
447 //set Display Option Register so all pwm intensity is controlled from Frame 1
448 is31_write_register(IS31_FUNCTIONREG, IS31_REG_DISPLAYOPT, IS31_REG_DISPLAYOPT_INTENSITY_SAME);
450 /* set full pwm on Frame 1 */
452 pwm_register_array[i]=0xFF;
455 pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
456 is31_write_data(0, pwm_register_array, 9);
457 chThdSleepMilliseconds(5);
460 //set all led bits on for Frame 2 LEDS_ALL
462 __builtin_memcpy(full_page+1, is31_ic60_leds_mask, 0x12);
463 is31_write_data(1, full_page, 1+0x12);
465 /* enable breathing when the displayed page changes */
466 // Fade-in Fade-out, time = 26ms * 2^N, N=3
467 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (3<<4)|3);
468 is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
470 // clean up the lock LEDs
471 set_lock_leds(USB_LED_NUM_LOCK, 0);
472 set_lock_leds(USB_LED_CAPS_LOCK, 0);
474 /* more time consuming LED processing should be offloaded into
475 * a thread, with asynchronous messaging. */
476 chMBObjectInit(&led_mailbox, led_mailbox_queue, LED_MAILBOX_NUM_MSGS);
477 chThdCreateStatic(waLEDthread, sizeof(waLEDthread), LOWPRIO, LEDthread, NULL);
480 //TODO: Don't know equivalent QMK hooks for these
482 //void hook_usb_suspend_entry(void) {
483 //#ifdef SLEEP_LED_ENABLE
484 // chSysLockFromISR();
485 // chMBPostI(&led_mailbox, LED_MSG_SLEEP_LED_ON);
486 // chSysUnlockFromISR();
487 //#endif /* SLEEP_LED_ENABLE */
490 //void hook_usb_suspend_loop(void) {
491 // chThdSleepMilliseconds(100);
492 // /* Remote wakeup */
493 // if((USB_DRIVER.status & 2) && suspend_wakeup_condition()) {
494 // send_remote_wakeup(&USB_DRIVER);
498 //void hook_usb_wakeup(void) {
499 //#ifdef SLEEP_LED_ENABLE
500 // chSysLockFromISR();
501 // chMBPostI(&led_mailbox, LED_MSG_SLEEP_LED_OFF);
502 // chSysUnlockFromISR();
503 //#endif /* SLEEP_LED_ENABLE */