/*
* LED controller code
- * WF uses IS31FL3731C matrix LED driver from ISSI
+ * IS31FL3731C matrix LED driver from ISSI
* datasheet: http://www.issi.com/WW/pdf/31FL3731C.pdf
*/
#include "hal.h"
#include "print.h"
#include "led.h"
+#include "action_layer.h"
+#include "host.h"
#include "led_controller.h"
order same as above (CA 1st row (8bytes), CB 1st row (8bytes), ...)
*/
-/* Which LED should be used for CAPS LOCK indicator
- * The usual Caps Lock position is C4-6, so the address is
- * 0x24 + (4-1)*0x10 + (8-1) = 0x59 */
+// Which LED should be used for CAPS LOCK indicator
#if !defined(CAPS_LOCK_LED_ADDRESS)
#define CAPS_LOCK_LED_ADDRESS 46
#endif
uint8_t full_page[0xB4+1] = {0};
// LED mask (which LEDs are present, selected by bits)
-// See page comment above, control alternates CA matrix/CB matrix
// IC60 pcb uses only CA matrix.
// Each byte is a control pin for 8 leds ordered 8-1
const uint8_t all_on_leds_mask[0x12] = {
__builtin_memset(full_page,0,0xB4+1);
// zero function page, all registers (assuming full_page is all zeroes)
is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
- // disable hardware shutdown
palSetPadMode(GPIOB, 16, PAL_MODE_OUTPUT_PUSHPULL);
palSetPad(GPIOB, 16);
chThdSleepMilliseconds(10);
(void)arg;
chRegSetThreadName("LEDthread");
- uint8_t i, page;
- uint8_t control_register_word[2] = {0};
+ uint8_t i;
+ uint8_t control_register_word[2] = {0};//2 bytes: register address, byte to write
uint8_t led_control_reg[0x13] = {0};//led control register start address + 0x12 bytes
//persistent status variables
- uint8_t backlight_status, led_step_status, layer_status;
+ uint8_t pwm_step_status, page_status;
//mailbox variables
- uint8_t temp, msg_type, msg_led;
+ uint8_t temp, msg_type, msg_pin, msg_col, msg_led;
msg_t msg;
-/* //control register variables
- uint8_t page, save_page, save_breath1, save_breath2;
- msg_t msg, retval;
-*/
-
// initialize persistent variables
-backlight_status = 0;
-led_step_status = 4; //full brightness
-layer_status = 0;
+pwm_step_status = 4; //full brightness
+page_status = 0; //start frame 0 (all off/on)
while(true) {
// wait for a message (asynchronous)
// (messages are queued (up to LED_MAILBOX_NUM_MSGS) if they can't
// be processed right away)
chMBFetch(&led_mailbox, &msg, TIME_INFINITE);
- msg_type = (msg >> 8) & 0xFF; //first byte is msg type
- msg_led = (msg) & 0xFF; //second byte is action information
-
- xprintf("--------------------\n");
- xprintf("mailbox fetch\nmsg: %X\n", msg);
- xprintf("type: %X - led: %X\n", msg_type, msg_led); //test if msg_type is 1 or 2 bytes after mask
- switch (msg_type){
- case KEY_LIGHT:
- //TODO: lighting key led on keypress
- break;
-
- //turn on/off/toggle single led, msg_led = row/col of led
- case OFF_LED:
- xprintf("OFF_LED\n");
- set_led_bit(7, control_register_word, msg_led, 0);
- is31_write_data (7, control_register_word, 0x02);
- if (layer_status > 0) {//check current led page to prevent double blink
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 7);
- }
- layer_status = 7;
- break;
- case ON_LED:
- xprintf("ON_LED\n");
- set_led_bit(7, control_register_word, msg_led, 1);
- is31_write_data (7, control_register_word, 0x02);
- if (layer_status > 7) {
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 7);
- }
- layer_status = 7;
- break;
- case TOGGLE_LED:
- xprintf("TOGGLE_LED\n");
- set_led_bit(7, control_register_word, msg_led, 2);
-
- is31_write_data (7, control_register_word, 0x02);
- if (layer_status > 7) {
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 7);
- }
- layer_status = 7;
+ msg_col = (msg >> 24) & 0xFF;//if needed
+ msg_pin = (msg >> 16) & 0XFF;//if needed (e.g. SET_FULL_ROW)
+ msg_type = (msg >> 8) & 0xFF; //second byte is msg type
+ msg_led = (msg) & 0xFF; //first byte is action information
+
+ switch (msg_type){
+ case SET_FULL_ROW:
+ //write full byte to pin address, msg_pin = pin #, msg_led = byte to write
+ //writes only to current page
+ write_led_byte(page_status,msg_pin,msg_led);
break;
- case TOGGLE_ALL:
- xprintf("TOGGLE_ALL\n");
- //msg_led = unused, TODO: consider using msg_led to toggle layer display
+ case OFF_LED:
+ //on/off/toggle single led, msg_led = row/col of led
+ set_led_bit(7, control_register_word, msg_led, 0);
+ is31_write_data (7, control_register_word, 0x02);
+ break;
+ case ON_LED:
+ set_led_bit(7, control_register_word, msg_led, 1);
+ is31_write_data (7, control_register_word, 0x02);
+ break;
+ case TOGGLE_LED:
+ set_led_bit(7, control_register_word, msg_led, 2);
+ is31_write_data (7, control_register_word, 0x02);
+ break;
- is31_read_register(0, 0x00, &temp);//if first byte is on, then toggle frame 1 off
+ case BLINK_OFF_LED:
+ //on/off/toggle single led, msg_led = row/col of led
+ set_led_bit(7, control_register_word, msg_led, 4);
+ is31_write_data (7, control_register_word, 0x02);
+ break;
+ case BLINK_ON_LED:
+ set_led_bit(7, control_register_word, msg_led, 5);
+ is31_write_data (7, control_register_word, 0x02);
+ break;
+ case BLINK_TOGGLE_LED:
+ set_led_bit(7, control_register_word, msg_led, 6);
+ is31_write_data (7, control_register_word, 0x02);
+ break;
- led_control_reg[0] = 0;
- if (temp==0) {
- xprintf("all leds on");
- __builtin_memcpy(led_control_reg+1, all_on_leds_mask, 0x12);
- } else {
- xprintf("all leds off");
- __builtin_memset(led_control_reg+1, 0, 0x12);
- }
-
- is31_write_data(0, led_control_reg, 0x13);
- if (layer_status > 0) {
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
- }
- layer_status=0;
- //TODO: Double blink when all on
- break;
+ case TOGGLE_ALL:
+ //msg_led = unused
+ is31_read_register(0, 0x00, &temp);
+ led_control_reg[0] = 0;
- case TOGGLE_BACKLIGHT:
- //msg_led = unused
- //TODO: consider Frame 0 as on/off layer and toggle led control register here
- //TODO: need to test tracking of active layer with layer_state from qmk
- xprintf("TOGGLE_BACKLIGHT\n");
- backlight_status ^= 1;
- is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &temp);
- layer_status = temp;
-
- page = backlight_status == 0 ? 0 : layer_status;
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, page);
- break;
+ //if first byte is on, then toggle frame 0 off
+ if (temp==0 || page_status > 0) {
+ __builtin_memcpy(led_control_reg+1, all_on_leds_mask, 0x12);
+ } else {
+ __builtin_memset(led_control_reg+1, 0, 0x12);
+ }
+ is31_write_data(0, led_control_reg, 0x13);
- case TOGGLE_LAYER_LEDS://show layer indicator or full map of layer keys.
- //TODO: change so user can flag which they want, indiv or full map in fn_actions
- //msg_led = layer to toggle on
- xprintf("TOGGLE_LAYER_LEDS\n");
- is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &temp);
-
- if(temp == msg_led) {
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 7);
- layer_status = 7;
- } else {
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_led);
- layer_status = msg_led;
- }
- break;
-
- case TOGGLE_NUM_LOCK:
+ if (page_status > 0) {
+ is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
+
+ page_status=0;
+
+ //maintain lock leds
+ led_set(host_keyboard_leds());
+ }
+ break;
+
+ case TOGGLE_BACKLIGHT:
+ //msg_led = on/off
+
+ //populate the 9 byte rows to be written to each pin, first byte is register (pin) address
+ if (msg_led == 1) {
+ __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
+ } else {
+ __builtin_memset(pwm_register_array+1, 0, 8);
+ }
+
+ for(i=0; i<8; i++) {
+ //first byte is register address, every 0x10 9 bytes is A-register pwm pins
+ pwm_register_array[0] = 0x24 + (i * 0x10);
+ is31_write_data(0,pwm_register_array,9);
+ }
+ break;
+
+ case DISPLAY_PAGE:
+ //msg_led = page to toggle on
+ if (page_status != msg_led) {
+ is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_led);
+ page_status = msg_led;
+
+ //maintain lock leds
+ led_set(host_keyboard_leds());
+ }
+ break;
+
+ case RESET_PAGE:
+ //led_msg = page to reset
+ led_control_reg[0] = 0;
+ __builtin_memset(led_control_reg+1, 0, 0x12);
+ is31_write_data(msg_led, led_control_reg, 0x13);
+ break;
+
+ case TOGGLE_NUM_LOCK:
//msg_led = 0 or 1, off/on
- //TODO: confirm toggling works and doesn't get out of sync
- set_lock_leds(USB_LED_NUM_LOCK, msg_led);
- break;
-
- case TOGGLE_CAPS_LOCK:
+ set_lock_leds(NUM_LOCK_LED_ADDRESS, msg_led, page_status);
+ break;
+ case TOGGLE_CAPS_LOCK:
//msg_led = 0 or 1, off/on
- //TODO: confirm toggling works and doesn't get out of sync
- set_lock_leds(USB_LED_CAPS_LOCK, msg_led);
- break;
+ set_lock_leds(CAPS_LOCK_LED_ADDRESS, msg_led, page_status);
+ break;
- case MODE_BREATH:
- break;
- case STEP_BRIGHTNESS:
- //TEST: Step brightness code
- //pwm_levels[] bounds checking, loop through array
- //TODO: find a cleaner way to walk through this logic
- if (msg_led == 0 && led_step_status == 0) {
- led_step_status = 4;
- } else {
- led_step_status--;
- }
-
- if (msg_led == 1 && led_step_status == 4) {
- led_step_status = 0;
- } else {
- led_step_status++;
- }
-
- //TODO: this seems a messy way to populate the pwm register
- //mimic whitefox init which uses memcpy
- //populate the 9 byte rows to be written to each pin, first byte is register (pin) address
- for(i=1; i<9; i++) {
- pwm_register_array[i]=pwm_levels[led_step_status];
- }
- for(i=0; i<8; i++) {
- pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
- is31_write_data(0, pwm_register_array, 9);//first page controls pwm in all pages (init Display Option register)
- }
- break;
+ case STEP_BRIGHTNESS:
+ //led_msg = step pwm up or down
+ switch (msg_led) {
+ case 0:
+ if (pwm_step_status == 0) {
+ pwm_step_status = 4;
+ } else {
+ pwm_step_status--;
+ }
+ break;
+
+ case 1:
+ if (pwm_step_status == 4) {
+ pwm_step_status = 0;
+ } else {
+ pwm_step_status++;
+ }
+ break;
+ }
-/* case LED_MSG_SLEEP_LED_ON:
- // save current settings
- is31_read_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, &save_page);
- is31_read_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, &save_breath1);
- is31_read_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, &save_breath2);
- // use pages 7 and 8 for (hardware) breathing (assuming they're empty)
- is31_write_register(6, BREATHE_LED_ADDRESS, 0xFF);
- is31_write_register(7, BREATHE_LED_ADDRESS, 0x00);
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (6<<4)|6);
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
- retval = MSG_TIMEOUT;
- temp = 6;
- while(retval == MSG_TIMEOUT) {
- // switch to the other page
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, temp);
- temp = (temp == 6 ? 7 : 6);
- // the times should be sufficiently long for IS31 to finish switching pages
- retval = chMBFetch(&led_mailbox, &msg, MS2ST(temp == 6 ? 4000 : 6000));
+ //populate 8 byte rows to write on each pin
+ //first byte is register address, every 0x10 9 bytes are A-register pwm pins
+ __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
+
+ for(i=0; i<8; i++) {
+ pwm_register_array[0] = 0x24 + (i * 0x10);
+ is31_write_data(0,pwm_register_array,9);
}
- // received a message (should be a wakeup), so restore previous state
- chThdSleepMilliseconds(3000); // need to wait until the page change finishes
- // note: any other messages are queued
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, save_breath1);
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, save_breath2);
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, save_page);
- break;
- case LED_MSG_SLEEP_LED_OFF:
- // should not get here; wakeup should be received in the branch above break;
break;
-*/
}
- xprintf("--------------------\n");
}
}
-
/* ==============================
* led processing functions
* ============================== */
void set_led_bit (uint8_t page, uint8_t *led_control_reg, uint8_t led_addr, uint8_t action) {
- //returns 2 bytes led control register address and byte mask to write
+ //returns 2 bytes: led control register address and byte to write
+ //0 - bit off, 1 - bit on, 2 - toggle bit
+
+ uint8_t control_reg_addr, column_bit, column_byte, bit_temp, blink_on;
+
+ //check for valid led address
+ if (led_addr < 0 || led_addr > 87 || led_addr % 10 > 8) {
+ return;
+ }
+
+ //check for blink bit
+ blink_on = action>>2;
+ action &= ~(1<<2); //strip blink bit
- uint8_t control_reg_addr, column_bit, column_byte, temp;
//first byte is led control register address 0x00
//msg_led tens column is pin#, ones column is bit position in 8-bit mask
control_reg_addr = ((led_addr / 10) % 10 - 1 ) * 0x02;// A-register is every other byte
- column_bit = 1<<(led_addr % 10 - 1);
+ control_reg_addr += blink_on == 1 ? 0x12 : 0x00;//shift 12 bytes to blink register
- is31_read_register(page,control_reg_addr,&temp);//need to maintain status of leds in this row (1 byte)
- column_byte = temp;
+ is31_read_register(page, control_reg_addr, &bit_temp);//maintain status of leds on this byte
+ column_bit = 1<<(led_addr % 10 - 1);
+ column_byte = bit_temp;
switch(action) {
case 0:
- column_byte &= ~1<<(column_bit);
+ column_byte &= ~column_bit;
break;
case 1:
- column_byte |= 1<<(column_bit);
+ column_byte |= column_bit;
break;
case 2:
- column_byte ^= 1<<(column_bit);
+ column_byte ^= column_bit;
break;
}
+ //return word to be written in register
led_control_reg[0] = control_reg_addr;
led_control_reg[1] = column_byte;
}
-void set_lock_leds(uint8_t lock_type, uint8_t led_on) {
- uint8_t page, led_addr;
- uint8_t led_control_write[2] = {0};
- //TODO: consolidate control register to top level array vs. three scattered around
-
- switch(lock_type) {
- case USB_LED_NUM_LOCK:
- led_addr = NUM_LOCK_LED_ADDRESS;
- break;
- case USB_LED_CAPS_LOCK:
- led_addr = CAPS_LOCK_LED_ADDRESS;
- break;
- #ifdef SCROLL_LOCK_LED_ADDRESS
- case USB_LED_SCROLL_LOCK:
- led_addr = SCROLL_LOCK_LED_ADDRESS;
- break;
- #endif
- #ifdef COMPOSE_LED_ADDRESS
- case USB_LED_COMPOSE:
- led_addr = COMPOSE_LED_ADDRESS;
- break;
- #endif
- #ifdef SCROLL_LOCK_LED_ADDRESS
- case USB_LED_KANA:
- led_addr = KANA_LED_ADDRESS;
- break;
- #endif
- }
-
- for(page=BACKLIGHT_OFF_LOCK_LED_OFF; page<8; page++) { //set in led_controller.h
- //TODO: check if frame2 (or frame1, first byte all on), and ignore if true
- //also if BACKLIGHT_OFF_LOCK_LED_OFF set
- set_led_bit(page,led_control_write,led_addr,led_on);
- is31_write_data (page, led_control_write, 0x02);
- }
+void write_led_byte (uint8_t page, uint8_t row, uint8_t led_byte) {
+ uint8_t led_control_word[2] = {0};//register address and on/off byte
+
+ led_control_word[0] = (row - 1 ) * 0x02;// A-register is every other byte
+ led_control_word[1] = led_byte;
+ is31_write_data(page, led_control_word, 0x02);
}
-void write_led_page (uint8_t page, const uint8_t *led_array, uint8_t led_count) {
+void write_led_page (uint8_t page, uint8_t *user_led_array, uint8_t led_count) {
uint8_t i;
- uint8_t row, col;
- uint8_t led_control_register[0x13] = {0};//led control register start address + 0x12 bytes
+ uint8_t pin, col;
+ uint8_t led_control_register[0x13] = {0};
+
+ __builtin_memset(led_control_register,0,13);
for(i=0;i<led_count;i++){
- row = ((led_array[i] / 10) % 10 - 1 ) * 2 + 1;//includes 1 byte shift for led register 0x00 address
- col = led_array[i] % 10 - 1;
-
- led_control_register[row] |= 1<<(col);
+ // 1 byte shift for led register 0x00 address
+ pin = ((user_led_array[i] / 10) % 10 - 1 ) * 2 + 1;
+ col = user_led_array[i] % 10 - 1;
+ led_control_register[pin] |= 1<<(col);
}
is31_write_data(page, led_control_register, 0x13);
}
+void set_lock_leds(uint8_t led_addr, uint8_t led_action, uint8_t page) {
+ uint8_t lock_temp;
+ uint8_t led_control_word[2] = {0};
+
+ //blink if all leds are on
+ if (page == 0) {
+ is31_read_register(0, 0x00, &lock_temp);
+ if (lock_temp == 0xFF) {
+ led_action |= (1<<2); //set blink bit
+ }
+ }
+
+ set_led_bit(page,led_control_word,led_addr,led_action);
+ is31_write_data(page, led_control_word, 0x02);
+}
+
/* =====================
* hook into user keymap
* ===================== */
/* initialise IS31 chip */
is31_init();
- //set Display Option Register so all pwm intensity is controlled from Frame 1
- is31_write_register(IS31_FUNCTIONREG, IS31_REG_DISPLAYOPT, IS31_REG_DISPLAYOPT_INTENSITY_SAME);
+ //set Display Option Register so all pwm intensity is controlled from page 0
+ //enable blink and set blink period to 0.27s x rate
+ is31_write_register(IS31_FUNCTIONREG, IS31_REG_DISPLAYOPT, IS31_REG_DISPLAYOPT_INTENSITY_SAME + IS31_REG_DISPLAYOPT_BLINK_ENABLE + 4);
- /* set full pwm on Frame 1 */
- for(i=1; i<9; i++) {
- pwm_register_array[i]=0xFF;
- }
+ /* set full pwm on page 1 */
+ pwm_register_array[0] = 0;
+ __builtin_memset(pwm_register_array+1, 0xFF, 8);
for(i=0; i<8; i++) {
pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
is31_write_data(0, pwm_register_array, 9);
chThdSleepMilliseconds(5);
}
- //set all led bits on for Frame 2 LEDS_ALL
- //TODO: set all off in init
- full_page[0] = 0;
- __builtin_memset(full_page+1, 0, 0x12);
- is31_write_data(1, full_page, 1+0x12);
-
/* enable breathing when the displayed page changes */
// Fade-in Fade-out, time = 26ms * 2^N, N=3
is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (3<<4)|3);
is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
- // clean up the lock LEDs
- set_lock_leds(USB_LED_NUM_LOCK, 0);
- set_lock_leds(USB_LED_CAPS_LOCK, 0);
-
/* more time consuming LED processing should be offloaded into
* a thread, with asynchronous messaging. */
chMBObjectInit(&led_mailbox, led_mailbox_queue, LED_MAILBOX_NUM_MSGS);
chThdCreateStatic(waLEDthread, sizeof(waLEDthread), LOWPRIO, LEDthread, NULL);
}
-
-//TODO: Don't know equivalent QMK hooks for these
-//
-//void hook_usb_suspend_entry(void) {
-//#ifdef SLEEP_LED_ENABLE
-// chSysLockFromISR();
-// chMBPostI(&led_mailbox, LED_MSG_SLEEP_LED_ON);
-// chSysUnlockFromISR();
-//#endif /* SLEEP_LED_ENABLE */
-//}
-//
-//void hook_usb_suspend_loop(void) {
-// chThdSleepMilliseconds(100);
-// /* Remote wakeup */
-// if((USB_DRIVER.status & 2) && suspend_wakeup_condition()) {
-// send_remote_wakeup(&USB_DRIVER);
-// }
-//}
-//
-//void hook_usb_wakeup(void) {
-//#ifdef SLEEP_LED_ENABLE
-// chSysLockFromISR();
-// chMBPostI(&led_mailbox, LED_MSG_SLEEP_LED_OFF);
-// chSysUnlockFromISR();
-//#endif /* SLEEP_LED_ENABLE */
-//}
-//*/
projects / qmk_firmware.git / blobdiff