keyboards/infinity60/led_controller.c

   1 /*
   2 Copyright 2016 flabbergast <s3+flabbergast@sdfeu.org>
   3
   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.
   8
   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.
  13
  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/>.
  16 */
  17
  18 /*
  19  * LED controller code
  20  * IS31FL3731C matrix LED driver from ISSI
  21  * datasheet: http://www.issi.com/WW/pdf/31FL3731C.pdf
  22  */
  23
  24 #include "ch.h"
  25 #include "hal.h"
  26 #include "print.h"
  27 #include "led.h"
  28 #include "host.h"
  29
  30 #include "led_controller.h"
  31
  32 #include "suspend.h"
  33
  34 #include "usb_main.h"
  35
  36 /* Infinity60 LED MAP
  37     - digits mean "row" and "col", i.e. 45 means C4-5 in the IS31 datasheet, matrix A
  38
  39   11 12 13 14 15 16 17 18 21 22 23 24 25  26 27*
  40    28 31 32 33 34 35 36 37 38 41 42 43 44 45
  41    46 47 48 51 52 53 54 55 56 57 58 61    62
  42     63 64 65 66 67 68 71 72 73 74 75      76 77*
  43   78  81  82       83         84  85  86  87
  44
  45 *Unused in Alphabet Layout
  46 */
  47
  48 /*
  49   each page has 0xB4 bytes
  50   0 - 0x11: LED control (on/off):
  51     order: CA1, CB1, CA2, CB2, .... (CA - matrix A, CB - matrix B)
  52       CAn controls Cn-8 .. Cn-1 (LSbit)
  53   0x12 - 0x23: blink control (like "LED control")
  54   0x24 - 0xB3: PWM control: byte per LED, 0xFF max on
  55     order same as above (CA 1st row (8bytes), CB 1st row (8bytes), ...)
  56 */
  57
  58 // Which LED should be used for CAPS LOCK indicator
  59 #if !defined(CAPS_LOCK_LED_ADDRESS)
  60 #define CAPS_LOCK_LED_ADDRESS 46
  61 #endif
  62
  63 #if !defined(NUM_LOCK_LED_ADDRESS)
  64 #define NUM_LOCK_LED_ADDRESS 85
  65 #endif
  66
  67 /* Which LED should breathe during sleep */
  68 #if !defined(BREATHE_LED_ADDRESS)
  69 #define BREATHE_LED_ADDRESS CAPS_LOCK_LED_ADDRESS
  70 #endif
  71
  72 /* =================
  73  * ChibiOS I2C setup
  74  * ================= */
  75 static const I2CConfig i2ccfg = {
  76   400000 // clock speed (Hz); 400kHz max for IS31
  77 };
  78
  79 /* ==============
  80  *   variables
  81  * ============== */
  82 // internal communication buffers
  83 uint8_t tx[2] __attribute__((aligned(2)));
  84 uint8_t rx[1] __attribute__((aligned(2)));
  85
  86 // buffer for sending the whole page at once (used also as a temp buffer)
  87 uint8_t full_page[0xB4+1] = {0};
  88
  89 // LED mask (which LEDs are present, selected by bits)
  90 // IC60 pcb uses only CA matrix.
  91 // Each byte is a control pin for 8 leds ordered 8-1
  92 const uint8_t all_on_leds_mask[0x12] = {
  93   0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF,
  94   0x00, 0xFF, 0x00, 0xFF, 0x00, 0x7F, 0x00, 0x00, 0x00
  95 };
  96
  97 // array to hold brightness pwm steps
  98 const uint8_t pwm_levels[5] = {
  99     0x00, 0x16, 0x4E, 0xA1, 0xFF
 100 };
 101
 102 // array to write to pwm register
 103 uint8_t pwm_register_array[9] = {0};
 104
 105
 106 /* ============================
 107  *   communication functions
 108  * ============================ */
 109 msg_t is31_select_page(uint8_t page) {
 110   tx[0] = IS31_COMMANDREGISTER;
 111   tx[1] = page;
 112   return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
 113 }
 114
 115 msg_t is31_write_data(uint8_t page, uint8_t *buffer, uint8_t size) {
 116   is31_select_page(page);
 117   return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, buffer, size, NULL, 0, US2ST(IS31_TIMEOUT));
 118 }
 119
 120 msg_t is31_write_register(uint8_t page, uint8_t reg, uint8_t data) {
 121   is31_select_page(page);
 122   tx[0] = reg;
 123   tx[1] = data;
 124   return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
 125 }
 126
 127 msg_t is31_read_register(uint8_t page, uint8_t reg, uint8_t *result) {
 128   is31_select_page(page);
 129
 130   tx[0] = reg;
 131   return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 1, result, 1, US2ST(IS31_TIMEOUT));
 132 }
 133
 134 /* ========================
 135  * initialise the IS31 chip
 136  * ======================== */
 137 void is31_init(void) {
 138   // just to be sure that it's all zeroes
 139   __builtin_memset(full_page,0,0xB4+1);
 140   // zero function page, all registers (assuming full_page is all zeroes)
 141   is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
 142   palSetPadMode(GPIOB, 16, PAL_MODE_OUTPUT_PUSHPULL);
 143   palSetPad(GPIOB, 16);
 144   chThdSleepMilliseconds(10);
 145   // software shutdown disable (i.e. turn stuff on)
 146   is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
 147   chThdSleepMilliseconds(10);
 148   // zero all LED registers on all 8 pages
 149   uint8_t i;
 150   for(i=0; i<8; i++) {
 151     is31_write_data(i, full_page, 0xB4 + 1);
 152     chThdSleepMilliseconds(5);
 153   }
 154 }
 155
 156 /* ==================
 157  * LED control thread
 158  * ================== */
 159 #define LED_MAILBOX_NUM_MSGS 5
 160 static msg_t led_mailbox_queue[LED_MAILBOX_NUM_MSGS];
 161 mailbox_t led_mailbox;
 162 static THD_WORKING_AREA(waLEDthread, 256);
 163 static THD_FUNCTION(LEDthread, arg) {
 164   (void)arg;
 165   chRegSetThreadName("LEDthread");
 166
 167   uint8_t i;
 168   uint8_t control_register_word[2] = {0};//2 bytes: register address, byte to write
 169   uint8_t led_control_reg[0x13] = {0};//led control register start address + 0x12 bytes
 170
 171   //persistent status variables
 172   uint8_t pwm_step_status, page_status;
 173
 174   //mailbox variables
 175   uint8_t temp, msg_type;
 176   uint8_t msg_args[3];
 177   msg_t msg;
 178
 179   // initialize persistent variables
 180   pwm_step_status = 4; //full brightness
 181   page_status = 0; //start frame 0 (all off/on)
 182
 183   while(true) {
 184     // wait for a message (asynchronous)
 185     // (messages are queued (up to LED_MAILBOX_NUM_MSGS) if they can't
 186     //  be processed right away
 187     chMBFetch(&led_mailbox, &msg, TIME_INFINITE);
 188     msg_type = msg & 0xFF; //first byte is action information
 189     msg_args[0] = (msg >> 8) & 0xFF;
 190     msg_args[1] = (msg >> 16) & 0XFF;
 191     msg_args[2] = (msg >> 24) & 0xFF;
 192
 193     switch (msg_type){
 194       case SET_FULL_ROW:
 195       //write full byte to pin address, msg_args[1] = pin #, msg_args[0] = 8 bits to write
 196       //writes only to currently displayed page
 197         write_led_byte(page_status, msg_args[1], msg_args[0]);
 198         break;
 199
 200       case OFF_LED:
 201       //on/off/toggle single led, msg_args[0] = row/col of led, msg_args[1] = page
 202         set_led_bit(msg_args[1], control_register_word, msg_args[0], 0);
 203         break;
 204       case ON_LED:
 205         set_led_bit(msg_args[1], control_register_word, msg_args[0], 1);
 206         break;
 207       case TOGGLE_LED:
 208         set_led_bit(msg_args[1], control_register_word, msg_args[0], 2);
 209         break;
 210
 211       case BLINK_OFF_LED:
 212       //on/off/toggle single led, msg_args[0] = row/col of led
 213         set_led_bit(msg_args[1], control_register_word, msg_args[0], 4);
 214         break;
 215       case BLINK_ON_LED:
 216         set_led_bit(msg_args[1], control_register_word, msg_args[0], 5);
 217         break;
 218       case BLINK_TOGGLE_LED:
 219         set_led_bit(msg_args[1], control_register_word, msg_args[0], 6);
 220         break;
 221
 222       case TOGGLE_ALL:
 223       //turn on/off all leds, msg_args = unused
 224         is31_read_register(0, 0x00, &temp);
 225         led_control_reg[0] = 0;
 226
 227         //if first leds are already on, toggle frame 0 off
 228         if (temp==0 || page_status > 0) {
 229           __builtin_memcpy(led_control_reg+1, all_on_leds_mask, 0x12);
 230         } else {
 231           __builtin_memset(led_control_reg+1, 0, 0x12);
 232         }
 233         is31_write_data(0, led_control_reg, 0x13);
 234
 235         if (page_status > 0) {
 236           is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
 237
 238           page_status=0;
 239
 240           //maintain lock leds
 241           led_set(host_keyboard_leds());
 242         }
 243         break;
 244
 245       case TOGGLE_BACKLIGHT:
 246         //msg_args[0] = on/off
 247
 248         //populate 9 byte rows to be written to each pin, first byte is register (pin) address
 249         if (msg_args[0] == 1) {
 250           __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
 251         } else {
 252           __builtin_memset(pwm_register_array+1, 0, 8);
 253         }
 254
 255         for(i=0; i<8; i++) {
 256         //first byte is register address, every 0x10 9 bytes is A-matrix pwm pins
 257           pwm_register_array[0] = 0x24 + (i * 0x10);
 258           is31_write_data(0,pwm_register_array,9);
 259         }
 260         break;
 261
 262       case DISPLAY_PAGE:
 263       //msg_args[0] = page to toggle on
 264         if (page_status != msg_args[0]) {
 265           is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_args[0]);
 266           page_status = msg_args[0];
 267
 268           //maintain lock leds
 269           led_set(host_keyboard_leds());
 270         }
 271         break;
 272
 273       case RESET_PAGE:
 274       //led_args[0] = page to reset
 275         led_control_reg[0] = 0;
 276         __builtin_memset(led_control_reg+1, 0, 0x12);
 277         is31_write_data(msg_args[0], led_control_reg, 0x13);
 278
 279         //repeat for blink register
 280         led_control_reg[0] = 0x12;
 281         is31_write_data(msg_args[0], led_control_reg, 0x13);
 282         break;
 283
 284       case TOGGLE_NUM_LOCK:
 285       //msg_args[0] = 0 or 1, off/on
 286         set_lock_leds(NUM_LOCK_LED_ADDRESS, msg_args[0], page_status);
 287         break;
 288       case TOGGLE_CAPS_LOCK:
 289       //msg_args[0] = 0 or 1, off/on
 290         set_lock_leds(CAPS_LOCK_LED_ADDRESS, msg_args[0], page_status);
 291         break;
 292
 293       case STEP_BRIGHTNESS:
 294       //led_args[0] = step up (1) or down (0)
 295         switch (msg_args[0]) {
 296           case 0:
 297             if (pwm_step_status == 0) {
 298               pwm_step_status = 4;
 299             } else {
 300               pwm_step_status--;
 301             }
 302             break;
 303
 304           case 1:
 305             if (pwm_step_status == 4) {
 306               pwm_step_status = 0;
 307             } else {
 308               pwm_step_status++;
 309             }
 310             break;
 311         }
 312
 313         //populate 8 byte arrays to write on each pin
 314         //first byte is register address, every 0x10 9 bytes are A-matrix pwm pins
 315         __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
 316
 317         for(i=0; i<8; i++) {
 318           pwm_register_array[0] = 0x24 + (i * 0x10);
 319           is31_write_data(0,pwm_register_array,9);
 320         }
 321         break;
 322     }
 323   }
 324 }
 325
 326 /* ==============================
 327  *    led processing functions
 328  * ============================== */
 329
 330 void set_led_bit (uint8_t page, uint8_t *led_control_word, uint8_t led_addr, uint8_t action) {
 331   //returns 2 bytes: led control register address and byte to write
 332   //action: 0 - off, 1 - on, 2 - toggle, 4 - blink on, 5 - blink off, 6 - toggle blink
 333
 334   uint8_t control_reg_addr, column_bit, column_byte, temp, blink_bit;
 335
 336   //check for valid led address
 337   if (led_addr < 0 || led_addr > 87 || led_addr % 10 > 8) {
 338     return;
 339   }
 340
 341   blink_bit = action>>2;//check for blink bit
 342   action &= ~(1<<2); //strip blink bit
 343
 344   //led_addr tens column is pin#, ones column is bit position in 8-bit mask
 345   control_reg_addr = ((led_addr / 10) % 10 - 1 ) * 0x02;// A-matrix is every other byte
 346   control_reg_addr += blink_bit == 1 ? 0x12 : 0x00;//if blink_bit, shift 12 bytes to blink register
 347
 348   is31_read_register(page, control_reg_addr, &temp);//maintain status of leds on this byte
 349   column_bit = 1<<(led_addr % 10 - 1);
 350   column_byte = temp;
 351
 352   switch(action) {
 353     case 0:
 354       column_byte &= ~column_bit;
 355       break;
 356     case 1:
 357       column_byte |= column_bit;
 358       break;
 359     case 2:
 360       column_byte ^= column_bit;
 361       break;
 362   }
 363
 364   //return word to be written in register
 365   led_control_word[0] = control_reg_addr;
 366   led_control_word[1] = column_byte;
 367   is31_write_data (page, led_control_word, 0x02);
 368 }
 369
 370 void write_led_byte (uint8_t page, uint8_t row, uint8_t led_byte) {
 371   uint8_t led_control_word[2] = {0};//register address and on/off byte
 372
 373   led_control_word[0] = (row - 1 ) * 0x02;// A-matrix is every other byte
 374   led_control_word[1] = led_byte;
 375   is31_write_data(page, led_control_word, 0x02);
 376 }
 377
 378 void write_led_page (uint8_t page, uint8_t *user_led_array, uint8_t led_count) {
 379   uint8_t i;
 380   uint8_t pin, col;
 381   uint8_t led_control_register[0x13] = {0};
 382
 383   __builtin_memset(led_control_register,0,13);
 384
 385   for(i=0;i<led_count;i++){
 386     //shift pin by 1 for led register 0x00 address
 387     pin = ((user_led_array[i] / 10) % 10 - 1 ) * 2 + 1;
 388     col = user_led_array[i] % 10 - 1;
 389     led_control_register[pin] |= 1<<(col);
 390   }
 391
 392   is31_write_data(page, led_control_register, 0x13);
 393 }
 394
 395 void set_lock_leds(uint8_t led_addr, uint8_t led_action, uint8_t page) {
 396   uint8_t temp;
 397   uint8_t led_control_word[2] = {0};
 398
 399   //blink if all leds are on
 400   if (page == 0) {
 401     is31_read_register(0, 0x00, &temp);
 402     chThdSleepMilliseconds(10);
 403
 404     if (temp == 0xFF) {
 405       led_action |= (1<<2); //set blink bit
 406     }
 407   }
 408
 409   set_led_bit(page,led_control_word,led_addr,led_action);
 410 }
 411
 412 /* =====================
 413  * hook into user keymap
 414  * ===================== */
 415 void led_controller_init(void) {
 416   uint8_t i;
 417
 418   /* initialise I2C */
 419   /* I2C pins */
 420   palSetPadMode(GPIOB, 0, PAL_MODE_ALTERNATIVE_2); // PTB0/I2C0/SCL
 421   palSetPadMode(GPIOB, 1, PAL_MODE_ALTERNATIVE_2); // PTB1/I2C0/SDA
 422   /* start I2C */
 423   i2cStart(&I2CD1, &i2ccfg);
 424   // try high drive (from kiibohd)
 425   I2CD1.i2c->C2 |= I2Cx_C2_HDRS;
 426   // try glitch fixing (from kiibohd)
 427   I2CD1.i2c->FLT = 4;
 428
 429   chThdSleepMilliseconds(10);
 430
 431   /* initialise IS31 chip */
 432   is31_init();
 433
 434   //set Display Option Register so all pwm intensity is controlled from page 0
 435   //enable blink and set blink period to 0.27s x rate
 436   is31_write_register(IS31_FUNCTIONREG, IS31_REG_DISPLAYOPT, IS31_REG_DISPLAYOPT_INTENSITY_SAME + IS31_REG_DISPLAYOPT_BLINK_ENABLE + 4);
 437
 438   /* set full pwm on page 1 */
 439   pwm_register_array[0] = 0;
 440   __builtin_memset(pwm_register_array+1, 0xFF, 8);
 441   for(i=0; i<8; i++) {
 442     pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
 443     is31_write_data(0, pwm_register_array, 9);
 444     chThdSleepMilliseconds(5);
 445   }
 446
 447   /* enable breathing when the displayed page changes */
 448   // Fade-in Fade-out, time = 26ms * 2^N, N=3
 449   is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (3<<4)|3);
 450   is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
 451
 452   /* more time consuming LED processing should be offloaded into
 453    * a thread, with asynchronous messaging. */
 454   chMBObjectInit(&led_mailbox, led_mailbox_queue, LED_MAILBOX_NUM_MSGS);
 455   chThdCreateStatic(waLEDthread, sizeof(waLEDthread), LOWPRIO, LEDthread, NULL);
 456 }