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   // disable hardware shutdown
 143   palSetPadMode(GPIOB, 16, PAL_MODE_OUTPUT_PUSHPULL);
 144   palSetPad(GPIOB, 16);
 145   chThdSleepMilliseconds(10);
 146   // software shutdown
 147   is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
 148   chThdSleepMilliseconds(10);
 149   // zero function page, all registers
 150   is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
 151   chThdSleepMilliseconds(10);
 152   // software shutdown disable (i.e. turn stuff on)
 153   is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
 154   chThdSleepMilliseconds(10);
 155   // zero all LED registers on all 8 pages
 156   uint8_t i;
 157   for(i=0; i<8; i++) {
 158     is31_write_data(i, full_page, 0xB4 + 1);
 159     chThdSleepMilliseconds(5);
 160   }
 161 }
 162
 163 /* ==================
 164  * LED control thread
 165  * ================== */
 166 #define LED_MAILBOX_NUM_MSGS 5
 167 static msg_t led_mailbox_queue[LED_MAILBOX_NUM_MSGS];
 168 mailbox_t led_mailbox;
 169 static THD_WORKING_AREA(waLEDthread, 256);
 170 static THD_FUNCTION(LEDthread, arg) {
 171   (void)arg;
 172   chRegSetThreadName("LEDthread");
 173
 174   uint8_t i;
 175   uint8_t control_register_word[2] = {0};//2 bytes: register address, byte to write
 176   uint8_t led_control_reg[0x13] = {0};//led control register start address + 0x12 bytes
 177
 178   //persistent status variables
 179   uint8_t pwm_step_status, page_status, capslock_status, numlock_status;
 180
 181   //mailbox variables
 182   uint8_t temp, msg_type;
 183   uint8_t msg_args[3];
 184   msg_t msg;
 185
 186   // initialize persistent variables
 187   pwm_step_status = 4; //full brightness
 188   page_status = 0; //start frame 0 (all off/on)
 189   numlock_status = (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) ? 1 : 0;
 190   capslock_status = (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) ? 1 : 0;
 191
 192   while(true) {
 193     // wait for a message (asynchronous)
 194     // (messages are queued (up to LED_MAILBOX_NUM_MSGS) if they can't
 195     //  be processed right away
 196     chMBFetch(&led_mailbox, &msg, TIME_INFINITE);
 197     msg_type = msg & 0xFF; //first byte is action information
 198     msg_args[0] = (msg >> 8) & 0xFF;
 199     msg_args[1] = (msg >> 16) & 0XFF;
 200     msg_args[2] = (msg >> 24) & 0xFF;
 201
 202
 203     switch (msg_type){
 204       case SET_FULL_ROW:
 205       //write full byte to pin address, msg_args[1] = pin #, msg_args[0] = 8 bits to write
 206       //writes only to currently displayed page
 207         write_led_byte(page_status, msg_args[1], msg_args[0]);
 208         break;
 209
 210       case OFF_LED:
 211       //on/off/toggle single led, msg_args[0] = row/col of led, msg_args[1] = page
 212         set_led_bit(msg_args[1], control_register_word, msg_args[0], 0);
 213         break;
 214       case ON_LED:
 215         set_led_bit(msg_args[1], control_register_word, msg_args[0], 1);
 216         break;
 217       case TOGGLE_LED:
 218         set_led_bit(msg_args[1], control_register_word, msg_args[0], 2);
 219         break;
 220
 221       case BLINK_OFF_LED:
 222       //on/off/toggle single led, msg_args[0] = row/col of led
 223         set_led_bit(msg_args[1], control_register_word, msg_args[0], 4);
 224         break;
 225       case BLINK_ON_LED:
 226         set_led_bit(msg_args[1], control_register_word, msg_args[0], 5);
 227         break;
 228       case BLINK_TOGGLE_LED:
 229         set_led_bit(msg_args[1], control_register_word, msg_args[0], 6);
 230         break;
 231
 232       case TOGGLE_ALL:
 233       //turn on/off all leds, msg_args = unused
 234         is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
 235         chThdSleepMilliseconds(5);
 236         is31_read_register(0, 0x00, &temp);
 237         is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
 238
 239         led_control_reg[0] = 0;
 240
 241         //toggle led mask based on current state (temp)
 242         if (temp==0 || page_status > 0) {
 243           __builtin_memcpy(led_control_reg+1, all_on_leds_mask, 0x12);
 244         } else {
 245           __builtin_memset(led_control_reg+1, 0, 0x12);
 246         }
 247         is31_write_data(0, led_control_reg, 0x13);
 248
 249         if (page_status > 0) {
 250           is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
 251
 252           page_status=0;
 253
 254           //maintain lock leds, reset to off and force recheck to blink of all leds toggled on
 255           numlock_status = 0;
 256           capslock_status = 0;
 257           led_set(host_keyboard_leds());
 258         }
 259         break;
 260
 261       case TOGGLE_BACKLIGHT:
 262         //msg_args[0] = on/off
 263
 264         //populate 9 byte rows to be written to each pin, first byte is register (pin) address
 265         if (msg_args[0] == 1) {
 266           __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
 267         } else {
 268           __builtin_memset(pwm_register_array+1, 0, 8);
 269         }
 270
 271         for(i=0; i<8; i++) {
 272         //first byte is register address, every 0x10 9 bytes is A-matrix pwm pins
 273           pwm_register_array[0] = 0x24 + (i * 0x10);
 274           is31_write_data(0,pwm_register_array,9);
 275         }
 276         break;
 277
 278       case DISPLAY_PAGE:
 279       //msg_args[0] = page to toggle on
 280         if (page_status != msg_args[0]) {
 281           is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_args[0]);
 282           page_status = msg_args[0];
 283
 284           //maintain lock leds, reset to off and force recheck for new page
 285           numlock_status = 0;
 286           capslock_status = 0;
 287           led_set(host_keyboard_leds());
 288         }
 289         break;
 290
 291       case RESET_PAGE:
 292       //led_args[0] = page to reset
 293         led_control_reg[0] = 0;
 294         __builtin_memset(led_control_reg+1, 0, 0x12);
 295         is31_write_data(msg_args[0], led_control_reg, 0x13);
 296
 297         //repeat for blink register
 298         led_control_reg[0] = 0x12;
 299         is31_write_data(msg_args[0], led_control_reg, 0x13);
 300         break;
 301
 302       case TOGGLE_NUM_LOCK:
 303       //msg_args[0] = 0 or 1, off/on
 304         if (numlock_status != msg_args[0]) {
 305           set_lock_leds(NUM_LOCK_LED_ADDRESS, msg_args[0], page_status);
 306           numlock_status = msg_args[0];
 307         }
 308         break;
 309       case TOGGLE_CAPS_LOCK:
 310       //msg_args[0] = 0 or 1, off/on
 311         if (capslock_status != msg_args[0]) {
 312           set_lock_leds(CAPS_LOCK_LED_ADDRESS, msg_args[0], page_status);
 313           capslock_status = msg_args[0];
 314         }
 315         break;
 316
 317       case STEP_BRIGHTNESS:
 318       //led_args[0] = step up (1) or down (0)
 319         switch (msg_args[0]) {
 320           case 0:
 321             if (pwm_step_status == 0) {
 322               pwm_step_status = 4;
 323             } else {
 324               pwm_step_status--;
 325             }
 326             break;
 327
 328           case 1:
 329             if (pwm_step_status == 4) {
 330               pwm_step_status = 0;
 331             } else {
 332               pwm_step_status++;
 333             }
 334             break;
 335         }
 336
 337         //populate 8 byte arrays to write on each pin
 338         //first byte is register address, every 0x10 9 bytes are A-matrix pwm pins
 339         __builtin_memset(pwm_register_array+1, pwm_levels[pwm_step_status], 8);
 340
 341         for(i=0; i<8; i++) {
 342           pwm_register_array[0] = 0x24 + (i * 0x10);
 343           is31_write_data(0,pwm_register_array,9);
 344         }
 345         break;
 346     }
 347   }
 348 }
 349
 350 /* ==============================
 351  *    led processing functions
 352  * ============================== */
 353
 354 void set_led_bit (uint8_t page, uint8_t *led_control_word, uint8_t led_addr, uint8_t action) {
 355   //returns 2 bytes: led control register address and byte to write
 356   //action: 0 - off, 1 - on, 2 - toggle, 4 - blink on, 5 - blink off, 6 - toggle blink
 357
 358   uint8_t control_reg_addr, column_bit, column_byte, temp, blink_bit;
 359
 360   //check for valid led address
 361   if (led_addr < 0 || led_addr > 87 || led_addr % 10 > 8) {
 362     return;
 363   }
 364
 365   blink_bit = action>>2;//check for blink bit
 366   action &= ~(1<<2); //strip blink bit
 367
 368   //led_addr tens column is pin#, ones column is bit position in 8-bit mask
 369   control_reg_addr = ((led_addr / 10) % 10 - 1 ) * 0x02;// A-matrix is every other byte
 370   control_reg_addr += blink_bit == 1 ? 0x12 : 0x00;//if blink_bit, shift 12 bytes to blink register
 371
 372   is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
 373   chThdSleepMilliseconds(5);
 374   is31_read_register(page, control_reg_addr, &temp);//maintain status of leds on this byte
 375   is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
 376
 377   column_bit = 1<<(led_addr % 10 - 1);
 378   column_byte = temp;
 379
 380   switch(action) {
 381     case 0:
 382       column_byte &= ~column_bit;
 383       break;
 384     case 1:
 385       column_byte |= column_bit;
 386       break;
 387     case 2:
 388       column_byte ^= column_bit;
 389       break;
 390   }
 391
 392   //return word to be written in register
 393   led_control_word[0] = control_reg_addr;
 394   led_control_word[1] = column_byte;
 395   is31_write_data (page, led_control_word, 0x02);
 396 }
 397
 398 void write_led_byte (uint8_t page, uint8_t row, uint8_t led_byte) {
 399   uint8_t led_control_word[2] = {0};//register address and on/off byte
 400
 401   led_control_word[0] = (row - 1 ) * 0x02;// A-matrix is every other byte
 402   led_control_word[1] = led_byte;
 403   is31_write_data(page, led_control_word, 0x02);
 404 }
 405
 406 void write_led_page (uint8_t page, uint8_t *user_led_array, uint8_t led_count) {
 407   uint8_t i;
 408   uint8_t pin, col;
 409   uint8_t led_control_register[0x13] = {0};
 410
 411   __builtin_memset(led_control_register,0,13);
 412
 413   for(i=0;i<led_count;i++){
 414     //shift pin by 1 for led register 0x00 address
 415     pin = ((user_led_array[i] / 10) % 10 - 1 ) * 2 + 1;
 416     col = user_led_array[i] % 10 - 1;
 417     led_control_register[pin] |= 1<<(col);
 418   }
 419
 420   is31_write_data(page, led_control_register, 0x13);
 421 }
 422
 423 void set_lock_leds(uint8_t led_addr, uint8_t led_action, uint8_t page) {
 424   uint8_t temp;
 425   uint8_t led_control_word[2] = {0};
 426
 427   //blink if all leds are on
 428   if (page == 0) {
 429     is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
 430     chThdSleepMilliseconds(5);
 431     is31_read_register(0, 0x00, &temp);
 432     is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
 433
 434     if (temp == 0xFF) {
 435       led_action |= (1<<2); //set blink bit
 436     }
 437   }
 438
 439   set_led_bit(page,led_control_word,led_addr,led_action);
 440 }
 441
 442 /* =====================
 443  * hook into user keymap
 444  * ===================== */
 445 void led_controller_init(void) {
 446   uint8_t i;
 447
 448   /* initialise I2C */
 449   /* I2C pins */
 450   palSetPadMode(GPIOB, 0, PAL_MODE_ALTERNATIVE_2); // PTB0/I2C0/SCL
 451   palSetPadMode(GPIOB, 1, PAL_MODE_ALTERNATIVE_2); // PTB1/I2C0/SDA
 452   /* start I2C */
 453   i2cStart(&I2CD1, &i2ccfg);
 454   // try high drive (from kiibohd)
 455   I2CD1.i2c->C2 |= I2Cx_C2_HDRS;
 456   // try glitch fixing (from kiibohd)
 457   I2CD1.i2c->FLT = 4;
 458
 459   chThdSleepMilliseconds(10);
 460
 461   /* initialise IS31 chip */
 462   is31_init();
 463
 464   //set Display Option Register so all pwm intensity is controlled from page 0
 465   //enable blink and set blink period to 0.27s x rate
 466   is31_write_register(IS31_FUNCTIONREG, IS31_REG_DISPLAYOPT, IS31_REG_DISPLAYOPT_INTENSITY_SAME + IS31_REG_DISPLAYOPT_BLINK_ENABLE + 4);
 467
 468   /* set full pwm on page 1 */
 469   pwm_register_array[0] = 0;
 470   __builtin_memset(pwm_register_array+1, 0xFF, 8);
 471   for(i=0; i<8; i++) {
 472     pwm_register_array[0] = 0x24 + (i * 0x10);//first byte of 9 bytes must be register address
 473     is31_write_data(0, pwm_register_array, 9);
 474     chThdSleepMilliseconds(5);
 475   }
 476
 477   /* enable breathing when the displayed page changes */
 478   // Fade-in Fade-out, time = 26ms * 2^N, N=3
 479   is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL1, (3<<4)|3);
 480   is31_write_register(IS31_FUNCTIONREG, IS31_REG_BREATHCTRL2, IS31_REG_BREATHCTRL2_ENABLE|3);
 481
 482   /* more time consuming LED processing should be offloaded into
 483    * a thread, with asynchronous messaging. */
 484   chMBObjectInit(&led_mailbox, led_mailbox_queue, LED_MAILBOX_NUM_MSGS);
 485   chThdCreateStatic(waLEDthread, sizeof(waLEDthread), LOWPRIO, LEDthread, NULL);
 486 }