Merge pull request #1349 from jpetermans/infinity60

Infinity60 backlight support

11 files changed, 1056 insertions, 11 deletions

diff --git a/keyboards/infinity60/config.h b/keyboards/infinity60/config.h
index f8346fe165..83930901cb 100644
--- a/keyboards/infinity60/config.h
+++ b/keyboards/infinity60/config.h
@@ -54,7 +54,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //#define INFINITY_PROTOTYPE
 
 /* Keymap for Infinity 1.1a (first revision with LED support) */
-//#define INFINITY_LED
+#define INFINITY_LED
 
 /*
  * Feature disable options
diff --git a/keyboards/infinity60/halconf.h b/keyboards/infinity60/halconf.h
index 46b37a4f46..f89dfc2e1e 100644
--- a/keyboards/infinity60/halconf.h
+++ b/keyboards/infinity60/halconf.h
@@ -76,7 +76,7 @@
  * @brief   Enables the I2C subsystem.
  */
 #if !defined(HAL_USE_I2C) || defined(__DOXYGEN__)
-#define HAL_USE_I2C                 FALSE
+#define HAL_USE_I2C                 TRUE
 #endif
 
 /**
@@ -139,7 +139,7 @@
  * @brief   Enables the SERIAL over USB subsystem.
  */
 #if !defined(HAL_USE_SERIAL_USB) || defined(__DOXYGEN__)
-#define HAL_USE_SERIAL_USB          TRUE
+#define HAL_USE_SERIAL_USB          FALSE
 #endif
 
 /**
diff --git a/keyboards/infinity60/keymaps/jpetermans/Makefile b/keyboards/infinity60/keymaps/jpetermans/Makefile
new file mode 100644
index 0000000000..df3d1e952f
--- /dev/null
+++ b/keyboards/infinity60/keymaps/jpetermans/Makefile
@@ -0,0 +1,4 @@
+
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif
diff --git a/keyboards/infinity60/keymaps/jpetermans/config.h b/keyboards/infinity60/keymaps/jpetermans/config.h
new file mode 100644
index 0000000000..72a2ed0810
--- /dev/null
+++ b/keyboards/infinity60/keymaps/jpetermans/config.h
@@ -0,0 +1,11 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+
+#include "../../config.h"
+
+//overrides
+#undef TAPPING_TOGGLE
+#define TAPPING_TOGGLE 2
+
+#endif
diff --git a/keyboards/infinity60/keymaps/jpetermans/keymap.c b/keyboards/infinity60/keymaps/jpetermans/keymap.c
new file mode 100644
index 0000000000..59249ff728
--- /dev/null
+++ b/keyboards/infinity60/keymaps/jpetermans/keymap.c
@@ -0,0 +1,304 @@
+#include "infinity60.h"
+#include "led_controller.h"
+
+//Helpful Defines
+#define _______ KC_TRNS
+
+//Define Layer Names
+#define _BASE 0
+#define _NUMPAD 1
+#define _FNAV 2
+#define _MEDIA 3
+#define _TILDE 4
+
+//IS31 chip has 8 available led pages, using 0 for all leds and 7 for single toggles
+#define max_pages 6
+
+enum ic60_keycodes {
+  NUMPAD,
+  FNAV,
+  MEDIA,
+  TILDE,
+  CTLALTDEL,
+  BACKLIGHT,
+  BRIGHT,
+  DIM,
+  ALL,
+  GAME,
+  MODE_SINGLE,
+  MODE_PAGE,
+  MODE_FLASH
+};
+
+uint8_t current_layer_global = 0;
+uint8_t led_mode_global = MODE_SINGLE;
+uint8_t backlight_status_global = 1; //init on/off state of backlight
+uint32_t led_layer_state = 0;
+
+/* ==================================
+ *             KEYMAPS
+ * ==================================*/
+
+const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Layer 0: Default Layer
+     * ,-----------------------------------------------------------.
+     * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  Backs|
+     * |-----------------------------------------------------------|
+     * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
+     * |-----------------------------------------------------------|
+     * |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Enter   |
+     * |-----------------------------------------------------------|
+     * |Shif|   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
+     * |-----------------------------------------------------------|
+     * |Ctrl|Gui |Alt |         Space    |Alt |Gui |  FN  | Ctrl   |
+     * `-----------------------------------------------------------'
+     */
+    /* default */
+    [_BASE] = KEYMAP( \
+        KC_ESC,    KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,   KC_MINS,KC_EQL, KC_BSLS,KC_NO,\
+        KC_TAB,    KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,   KC_LBRC,KC_RBRC,KC_BSPC,   \
+        TT(_FNAV), KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,KC_QUOT,KC_ENT,         \
+        KC_LSFT,   KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH,F(TILDE),KC_NO,          \
+        KC_LCTL,   KC_LGUI,KC_LALT,            LT(_FNAV, KC_SPC),       KC_RALT,TG(_NUMPAD),MO(_MEDIA), KC_RCTL         \
+    ),
+
+    /* numpad */
+    [_NUMPAD] = KEYMAP( \
+        _______,_______,_______,_______,_______,_______,_______, KC_P7, KC_P8, KC_P9, KC_PSLS, _______,_______,_______,KC_NO,\
+        _______,_______,_______,_______,_______,_______,_______, KC_P4, KC_P5, KC_P6, KC_PAST, _______,_______,_______, \
+        MO(_FNAV),_______,_______,_______,_______,_______,_______, KC_P1, KC_P2, KC_P3, KC_PMNS, _______,_______,      \
+        _______,_______,_______,_______,_______,_______,_______, KC_P0,KC_COMM,KC_PDOT,KC_PPLS, _______,KC_NO,      \
+        _______,_______,_______,               TO(_BASE),           _______,_______,_______,_______   \
+    ),
+
+    /* F-, arrow, and media keys */
+    [_FNAV] = KEYMAP( \
+        KC_GRV, KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  KC_F7,  KC_F8,  KC_F9,  KC_F10, KC_F11, KC_F12, _______,KC_NO,\
+        KC_CAPS,_______,_______,_______,_______,_______,_______,KC_PGUP,KC_UP,KC_PGDN,KC_PSCR,_______,_______,KC_DEL,  \
+        _______,_______,KC_BTN2,_______,_______,_______,KC_HOME,KC_LEFT,KC_DOWN,KC_RGHT,KC_INS,_______,_______,     \
+        _______,KC_APP,KC_BTN1,KC_CALC,_______,_______,KC_END,_______,_______,_______,_______,_______,KC_NO,         \
+        _______,_______,_______,               _______,         F(CTLALTDEL),KC_NLCK,_______,_______   \
+    ),
+
+    /* media */
+    [_MEDIA] = KEYMAP( \
+        _______,F(MODE_SINGLE),F(MODE_PAGE),F(MODE_FLASH),_______,_______,_______, _______, _______, _______,KC_MUTE, KC_VOLD, KC_VOLU,_______,KC_NO,\
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,_______,\
+        _______,_______,_______,_______,_______,F(GAME),_______, _______, _______, _______,_______, _______,_______,     \
+        _______,_______,F(ALL) ,F(BRIGHT),F(DIM),F(BACKLIGHT),_______, _______, KC_MPRV, KC_MNXT,KC_MSTP, _______,KC_NO,       \
+        _______,_______,_______,               KC_MPLY,             _______,_______, _______,_______      \
+    ),
+    /* ~ */
+    [_TILDE] = KEYMAP( \
+        KC_GRV,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,_______,KC_NO,\
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,_______,\
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,     \
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,KC_NO,       \
+        _______,_______,_______,               _______,             _______,_______, _______,_______      \
+    ),
+    /* template */
+    [5] = KEYMAP( \
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,_______,KC_NO,\
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,_______,\
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,_______,     \
+        _______,_______,_______,_______,_______,_______,_______, _______, _______, _______,_______, _______,KC_NO,       \
+        _______,_______,_______,               _______,             _______,_______, _______,_______      \
+    ),
+};
+
+//id for user defined functions and macros
+enum function_id {
+    NONE,
+};
+
+enum macro_id {
+    ACTION_LEDS_ALL,
+    ACTION_LEDS_GAME,
+    ACTION_LEDS_BACKLIGHT,
+    ACTION_LEDS_BRIGHT,
+    ACTION_LEDS_DIM,
+    ACTION_LEDS_SINGLE,
+    ACTION_LEDS_PAGE,
+    ACTION_LEDS_FLASH
+};
+
+/* ==================================
+ *          LED MAPPING
+ * ==================================*/
+
+/*
+    Infinity60 LED MAP
+    11 12 13 14 15 16 17 18 21 22 23 24 25  26 27*
+     28 31 32 33 34 35 36 37 38 41 42 43 44 45
+     46 47 48 51 52 53 54 55 56 57 58 61    62
+      63 64 65 66 67 68 71 72 73 74 75      76 77*
+    78  81  82       83         84  85  86  87
+    *Unused in Alphabet Layout
+*/
+
+//======== full page arrays =========
+//any change in array size needs to be mirrored in matrix_init_user
+uint8_t led_numpad[16] = {
+  18,21,22,23,
+  37,38,41,42,
+  55,56,57,58,
+  72,73,74,75
+};
+//LED Page 2 - _Nav
+uint8_t led_nav[12] = {
+                        38,
+  47,48,              55,56,57,
+     64,65,66
+};
+//LED Page 3 - _Media
+uint8_t led_media[15] = {
+  12,13,14,           23,24,25,
+     65,66,67,68,    73,74,75,
+           83,          86
+};
+//LED Page 4 - _Game "WASD"
+uint8_t led_game[5] = {
+  11,
+        32,
+     47,48,51
+};
+
+//======== qmk functions =========
+const uint16_t fn_actions[] = {
+    [CTLALTDEL] = ACTION_KEY(LALT(LCTL(KC_DEL))),
+    [TILDE] = ACTION_LAYER_MODS(_TILDE, MOD_LSFT),
+    [ALL] = ACTION_FUNCTION(ACTION_LEDS_ALL),
+    [GAME] = ACTION_FUNCTION(ACTION_LEDS_GAME),
+    [BACKLIGHT] = ACTION_FUNCTION(ACTION_LEDS_BACKLIGHT),
+    [BRIGHT] = ACTION_FUNCTION(ACTION_LEDS_BRIGHT),
+    [DIM] = ACTION_FUNCTION(ACTION_LEDS_DIM),
+    [MODE_SINGLE] = ACTION_FUNCTION(ACTION_LEDS_SINGLE),
+    [MODE_PAGE] = ACTION_FUNCTION(ACTION_LEDS_PAGE),
+    [MODE_FLASH] = ACTION_FUNCTION(ACTION_LEDS_FLASH),
+};
+
+/* custom action function */
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
+  msg_t msg;
+
+  switch(id) {
+    case ACTION_LEDS_ALL:
+      if(record->event.pressed) {
+        led_mode_global = led_mode_global == ALL ? MODE_SINGLE : ALL;
+        msg=TOGGLE_ALL;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+      }
+      break;
+
+    case ACTION_LEDS_BACKLIGHT:
+      if(record->event.pressed) {
+        backlight_status_global ^= 1;
+        msg=(backlight_status_global << 8) | TOGGLE_BACKLIGHT;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+      }
+      break;
+
+    case ACTION_LEDS_GAME:
+      if(record->event.pressed) {
+        led_mode_global = led_mode_global == GAME ? MODE_SINGLE : GAME;
+
+        msg=(4 << 8) | DISPLAY_PAGE;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+      }
+      break;
+
+    case ACTION_LEDS_BRIGHT:
+      if(record->event.pressed) {
+        msg=(1 << 8) | STEP_BRIGHTNESS;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+      }
+      break;
+
+    case ACTION_LEDS_DIM:
+      if(record->event.pressed) {
+        msg=(0 << 8) | STEP_BRIGHTNESS;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+      }
+      break;
+
+    //set led_mode for matrix_scan to toggle leds
+    case ACTION_LEDS_SINGLE:
+      led_mode_global = MODE_SINGLE;
+      break;
+    case ACTION_LEDS_PAGE:
+      led_mode_global = MODE_PAGE;
+      break;
+    case ACTION_LEDS_FLASH:
+      led_mode_global = MODE_FLASH;
+      break;
+
+  }
+}
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+    return MACRO_NONE;
+};
+
+
+bool process_record_user (uint16_t keycode, keyrecord_t *record) {
+  return true;
+}
+
+// Runs just one time when the keyboard initializes.
+void matrix_init_user(void) {
+
+    led_controller_init();
+
+    // Write predefined led pages.
+    write_led_page(_NUMPAD, led_numpad, 16);
+    chThdSleepMilliseconds(10);
+
+    write_led_page(_FNAV, led_nav, 12);
+    chThdSleepMilliseconds(10);
+
+    write_led_page(_MEDIA, led_media, 15);
+    chThdSleepMilliseconds(10);
+
+    write_led_page(4, led_game, 5);
+    chThdSleepMilliseconds(1000);
+};
+
+// Loops constantly in the background.
+void matrix_scan_user(void) {
+  uint8_t page;
+  uint8_t led_pin_byte;
+  msg_t msg;
+
+  if (backlight_status_global == 0) {//backlight is off, skip the rest
+    return;
+  }
+
+  if (led_layer_state != layer_state && led_mode_global != GAME && led_mode_global != ALL) {
+    //check mode
+    //Turn on layer indicator or page depending on mode
+    switch(led_mode_global) {
+      case MODE_FLASH: //flash preset page leds then single indicator
+        page = biton32(layer_state) > max_pages ? 7 : biton32(layer_state);
+        msg=(page << 8) | DISPLAY_PAGE;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+        chThdSleepMilliseconds(500);
+        //flow to display single layer leds
+
+      case MODE_SINGLE: //light layer indicators for all active layers
+        led_pin_byte = layer_state & 0xFF;
+        msg=(7 << 8) | DISPLAY_PAGE;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+        msg=(1 << 16) | (led_pin_byte << 8) | SET_FULL_ROW;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+        break;
+
+      case MODE_PAGE: //display pre-defined led page
+        page = biton32(layer_state) > max_pages ? 7 : biton32(layer_state);
+        msg=(page << 8) | DISPLAY_PAGE;
+        chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+        break;
+      }
+  led_layer_state = layer_state;
+  }
+}
diff --git a/keyboards/infinity60/keymaps/jpetermans/readme.md b/keyboards/infinity60/keymaps/jpetermans/readme.md
new file mode 100644
index 0000000000..b83057ea7b
--- /dev/null
+++ b/keyboards/infinity60/keymaps/jpetermans/readme.md
@@ -0,0 +1,87 @@
+Backlight for Infinity60
+========================
+
+## Led Controller Specs
+
+The Infinity60 (revision 1.1a) pcb uses the IS31FL3731C matrix LED driver from ISSI [(datasheet)](http://www.issi.com/WW/pdf/31FL3731C.pdf). The IS31 has the ability to control two led matrices (A & B), each matrix controlling 9 pins, each pin controlling 8 leds. The Infinity only utilizes matrix A.
+
+Infinity60 LED Map:
+digits mean "row" and "col", i.e. 45 means pin 4, column 5 in the IS31 datasheet
+```c
+  11 12 13 14 15 16 17 18 21 22 23 24 25  26 27*
+   28 31 32 33 34 35 36 37 38 41 42 43 44 45
+   46 47 48 51 52 53 54 55 56 57 58 61    62
+   63 64 65 66 67 68 71 72 73 74 75      76 77*
+   78  81  82       83         84  85  86  87
+```
+*Unused in Alphabet Layout
+
+The IS31 includes 8 led pages (or frames) 0-7 than can be displayed, and each page consists of 144 bytes.
+- **bytes 0 - 17** - LED control (on/off).
+    * 18 pins which alternate between A and B matrices (A1, B1, A2, B2, ..).
+    * Each byte controls the 8 leds on that pin with bits (8 to 1).
+- **bytes 8 - 35** - Blink control.
+    * Same as LED control above, but sets blink on/off.
+- **bytes 36 - 143** - PWM control.
+    * One byte per LED, sets PWM from 0 to 255.
+    * Same as above, the register alternates, every 8 *bytes* (not bits) between the A & B matrices.
+
+## Led Controller Code
+In the Infinity60 project folder, led_controller.c sets up ability to write led layers at startup or control leds on demand as part of fn_actions. By default led_controller.c assumes page 0 will be used for full on/off. The remaining 7 pages (1-7) are free for preset led maps or single led actions at init or on demand. Communication with the IS31 is primarily done through the led_mailbox using chMBPost described further below under "Sending messages in Keymap.c". This code is based on work matt3o and flabbergast did for tmk firmware on the [whitefox](https://github.com/tmk/whitefox).
+
+One function is available to directly set leds without the mailbox:
+```
+write_led_page(page#, array of leds by address, # of addresses in array)
+```
+This function saves a full page to the controller using a supplied array of led locations such as:
+```c
+uint8_t led_numpad[16] =  {
+  18,21,22,23,
+  37,38,41,42,
+  55,56,57,58,
+  72,73,74,75
+}
+write_led_page(5, led_numpad, 16);
+```
+
+Remaining led control is done through the led mailbox using these message types:
+- **SET_FULL_ROW** (3 bytes) - message type, 8-bit mask, and row#. Sets all leds on one pin per the bit mask.
+- **OFF_LED, ON_LED, TOGGLE_LED** (3 bytes) - message type, led address, and page#. Off/on/toggle specific led.
+- **BLINK_OFF_LED, BLINK_ON_LED, BLINK_OFF_LED** (3 bytes) - message type, led address, and page#. Set blink Off/on/toggle for specific led.
+- **TOGGLE_ALL** (1 byte) - Turn on/off full backlight.
+- **TOGGLE_BACKLIGHT** (2 bytes) - message type, on/off. Sets backlight completely off, no leds will display.
+- **DISPLAY_PAGE** (2 bytes) - message type, page to display. Switch to specific pre-set page.
+- **RESET_PAGE** (2 bytes) - message type, page to reset. Reset/erase specific page.
+- **TOGGLE_NUM_LOCK** (2 bytes) - message type, on/off (NUM_LOCK_LED_ADDRESS). Toggle numlock on/off. Usually run with the `set_leds` function to check state of numlock or capslock. If all leds are on (e.i. TOGGLE_ALL) then this sets numlock to blink instead (this is still a little buggy if toggling on/off quickly).
+- **TOGGLE_CAPS_LOCK** (2 bytes) - message type, on/off (CAPS_LOCK_LED_ADDRESS). Same as numlock.
+- **STEP_BRIGHTNESS** (2 bytes) - message type, and step up (1) or step down (0). Increase or decrease led brightness.
+
+## Sending messages in Keymap.c
+Sending an action to the led mailbox is done using chMBPost:
+```
+chMBPost(&led_mailbox, message, timeout);
+```
+- &led_mailbox - pointer to led mailbox
+- message - up to 4 bytes but most messages use only 2. First byte (LSB) is the message type, the remaining three bytes are the message to process.
+- timeout is TIME_IMMEDIATE
+
+An example:
+```c
+//set the message to be sent. First byte (LSB) is the led address, and second is the message type
+msg=(42 << 8) | ON_LED;
+
+//send msg to the led mailbox
+chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+```
+
+Another:
+```c
+msg=(46 << 8) | BLINK_TOGGLE_LED;
+chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+```
+
+Finally, SET_FULL_ROW requires an extra byte with row information in the message so sending this message looks like:
+```c
+msg=(row<<16) | (led_pin_byte << 8) | SET_FULL_ROW;
+chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
+```
diff --git a/keyboards/infinity60/led.c b/keyboards/infinity60/led.c
index aed66c7c03..53147a78a5 100644
--- a/keyboards/infinity60/led.c
+++ b/keyboards/infinity60/led.c
@@ -1,5 +1,5 @@
 /*
-Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jun Wako <wakojun@gmail.com>
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -19,6 +19,35 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #include "led.h"
 
+#include "led_controller.h"
 
+/* WARNING! This function needs to be callable from
+ * both regular threads and ISRs, unlocked (during resume-from-sleep).
+ * In particular, I2C functions (interrupt-driven) should NOT be called from here.
+ */
 void led_set(uint8_t usb_led) {
+    msg_t msg;
+
+    if (usb_led & (1<<USB_LED_NUM_LOCK)) {
+        chSysUnconditionalLock();
+        msg=(1 << 8) | TOGGLE_NUM_LOCK;
+        chMBPostI(&led_mailbox, msg);
+        chSysUnconditionalUnlock();
+    } else {
+        chSysUnconditionalLock();
+        msg=(0 << 8) | TOGGLE_NUM_LOCK;
+        chMBPostI(&led_mailbox, msg);
+        chSysUnconditionalUnlock();
+    }
+    if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
+        chSysUnconditionalLock();
+        msg=(1 << 8) | TOGGLE_CAPS_LOCK;
+        chMBPostI(&led_mailbox, msg);
+        chSysUnconditionalUnlock();
+    } else {
+        chSysUnconditionalLock();
+        msg=(0 << 8) | TOGGLE_CAPS_LOCK;
+        chMBPostI(&led_mailbox, msg);
+        chSysUnconditionalUnlock();
+    }
 }
diff --git a/keyboards/infinity60/led_controller.c b/keyboards/infinity60/led_controller.c
new file mode 100644
index 0000000000..21f95a9c12
--- /dev/null
+++ b/keyboards/infinity60/led_controller.c
@@ -0,0 +1,486 @@
+/*
+Copyright 2016 flabbergast <s3+flabbergast@sdfeu.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/*
+ * LED controller code
+ * IS31FL3731C matrix LED driver from ISSI
+ * datasheet: http://www.issi.com/WW/pdf/31FL3731C.pdf
+ */
+
+#include "ch.h"
+#include "hal.h"
+#include "print.h"
+#include "led.h"
+#include "host.h"
+
+#include "led_controller.h"
+
+#include "suspend.h"
+
+#include "usb_main.h"
+
+/* Infinity60 LED MAP
+    - digits mean "row" and "col", i.e. 45 means C4-5 in the IS31 datasheet, matrix A
+
+  11 12 13 14 15 16 17 18 21 22 23 24 25  26 27*
+   28 31 32 33 34 35 36 37 38 41 42 43 44 45
+   46 47 48 51 52 53 54 55 56 57 58 61    62
+    63 64 65 66 67 68 71 72 73 74 75      76 77*
+  78  81  82       83         84  85  86  87
+
+*Unused in Alphabet Layout
+*/
+
+/*
+  each page has 0xB4 bytes
+  0 - 0x11: LED control (on/off):
+    order: CA1, CB1, CA2, CB2, .... (CA - matrix A, CB - matrix B)
+      CAn controls Cn-8 .. Cn-1 (LSbit)
+  0x12 - 0x23: blink control (like "LED control")
+  0x24 - 0xB3: PWM control: byte per LED, 0xFF max on
+    order same as above (CA 1st row (8bytes), CB 1st row (8bytes), ...)
+*/
+
+// Which LED should be used for CAPS LOCK indicator
+#if !defined(CAPS_LOCK_LED_ADDRESS)
+#define CAPS_LOCK_LED_ADDRESS 46
+#endif
+
+#if !defined(NUM_LOCK_LED_ADDRESS)
+#define NUM_LOCK_LED_ADDRESS 85
+#endif
+
+/* Which LED should breathe during sleep */
+#if !defined(BREATHE_LED_ADDRESS)
+#define BREATHE_LED_ADDRESS CAPS_LOCK_LED_ADDRESS
+#endif
+
+/* =================
+ * ChibiOS I2C setup
+ * ================= */
+static const I2CConfig i2ccfg = {
+  400000 // clock speed (Hz); 400kHz max for IS31
+};
+
+/* ==============
+ *   variables
+ * ============== */
+// internal communication buffers
+uint8_t tx[2] __attribute__((aligned(2)));
+uint8_t rx[1] __attribute__((aligned(2)));
+
+// buffer for sending the whole page at once (used also as a temp buffer)
+uint8_t full_page[0xB4+1] = {0};
+
+// LED mask (which LEDs are present, selected by bits)
+// 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] = {
+  0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0xFF,
+  0x00, 0xFF, 0x00, 0xFF, 0x00, 0x7F, 0x00, 0x00, 0x00
+};
+
+// array to hold brightness pwm steps
+const uint8_t pwm_levels[5] = {
+    0x00, 0x16, 0x4E, 0xA1, 0xFF
+};
+
+// array to write to pwm register
+uint8_t pwm_register_array[9] = {0};
+
+
+/* ============================
+ *   communication functions
+ * ============================ */
+msg_t is31_select_page(uint8_t page) {
+  tx[0] = IS31_COMMANDREGISTER;
+  tx[1] = page;
+  return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
+}
+
+msg_t is31_write_data(uint8_t page, uint8_t *buffer, uint8_t size) {
+  is31_select_page(page);
+  return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, buffer, size, NULL, 0, US2ST(IS31_TIMEOUT));
+}
+
+msg_t is31_write_register(uint8_t page, uint8_t reg, uint8_t data) {
+  is31_select_page(page);
+  tx[0] = reg;
+  tx[1] = data;
+  return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 2, NULL, 0, US2ST(IS31_TIMEOUT));
+}
+
+msg_t is31_read_register(uint8_t page, uint8_t reg, uint8_t *result) {
+  is31_select_page(page);
+
+  tx[0] = reg;
+  return i2cMasterTransmitTimeout(&I2CD1, IS31_ADDR_DEFAULT, tx, 1, result, 1, US2ST(IS31_TIMEOUT));
+}
+
+/* ========================
+ * initialise the IS31 chip
+ * ======================== */
+void is31_init(void) {
+  // just to be sure that it's all zeroes
+  __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);
+  // software shutdown
+  is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
+  chThdSleepMilliseconds(10);
+  // zero function page, all registers
+  is31_write_data(IS31_FUNCTIONREG, full_page, 0xD + 1);
+  chThdSleepMilliseconds(10);
+  // software shutdown disable (i.e. turn stuff on)
+  is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
+  chThdSleepMilliseconds(10);
+  // zero all LED registers on all 8 pages
+  uint8_t i;
+  for(i=0; i<8; i++) {
+    is31_write_data(i, full_page, 0xB4 + 1);
+    chThdSleepMilliseconds(5);
+  }
+}
+
+/* ==================
+ * LED control thread
+ * ================== */
+#define LED_MAILBOX_NUM_MSGS 5
+static msg_t led_mailbox_queue[LED_MAILBOX_NUM_MSGS];
+mailbox_t led_mailbox;
+static THD_WORKING_AREA(waLEDthread, 256);
+static THD_FUNCTION(LEDthread, arg) {
+  (void)arg;
+  chRegSetThreadName("LEDthread");
+
+  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 pwm_step_status, page_status, capslock_status, numlock_status;
+
+  //mailbox variables
+  uint8_t temp, msg_type;
+  uint8_t msg_args[3];
+  msg_t msg;
+
+  // initialize persistent variables
+  pwm_step_status = 4; //full brightness
+  page_status = 0; //start frame 0 (all off/on)
+  numlock_status = (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) ? 1 : 0;
+  capslock_status = (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) ? 1 : 0;
+
+  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 & 0xFF; //first byte is action information
+    msg_args[0] = (msg >> 8) & 0xFF;
+    msg_args[1] = (msg >> 16) & 0XFF;
+    msg_args[2] = (msg >> 24) & 0xFF;
+
+
+    switch (msg_type){
+      case SET_FULL_ROW:
+      //write full byte to pin address, msg_args[1] = pin #, msg_args[0] = 8 bits to write
+      //writes only to currently displayed page
+        write_led_byte(page_status, msg_args[1], msg_args[0]);
+        break;
+
+      case OFF_LED:
+      //on/off/toggle single led, msg_args[0] = row/col of led, msg_args[1] = page
+        set_led_bit(msg_args[1], control_register_word, msg_args[0], 0);
+        break;
+      case ON_LED:
+        set_led_bit(msg_args[1], control_register_word, msg_args[0], 1);
+        break;
+      case TOGGLE_LED:
+        set_led_bit(msg_args[1], control_register_word, msg_args[0], 2);
+        break;
+
+      case BLINK_OFF_LED:
+      //on/off/toggle single led, msg_args[0] = row/col of led
+        set_led_bit(msg_args[1], control_register_word, msg_args[0], 4);
+        break;
+      case BLINK_ON_LED:
+        set_led_bit(msg_args[1], control_register_word, msg_args[0], 5);
+        break;
+      case BLINK_TOGGLE_LED:
+        set_led_bit(msg_args[1], control_register_word, msg_args[0], 6);
+        break;
+
+      case TOGGLE_ALL:
+      //turn on/off all leds, msg_args = unused
+        is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
+        chThdSleepMilliseconds(5);
+        is31_read_register(0, 0x00, &temp);
+        is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
+
+        led_control_reg[0] = 0;
+
+        //toggle led mask based on current state (temp)
+        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);
+
+        if (page_status > 0) {
+          is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, 0);
+
+          page_status=0;
+
+          //maintain lock leds, reset to off and force recheck to blink of all leds toggled on
+          numlock_status = 0;
+          capslock_status = 0;
+          led_set(host_keyboard_leds());
+        }
+        break;
+
+      case TOGGLE_BACKLIGHT:
+        //msg_args[0] = on/off
+
+        //populate 9 byte rows to be written to each pin, first byte is register (pin) address
+        if (msg_args[0] == 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-matrix pwm pins
+          pwm_register_array[0] = 0x24 + (i * 0x10);
+          is31_write_data(0,pwm_register_array,9);
+        }
+        break;
+
+      case DISPLAY_PAGE:
+      //msg_args[0] = page to toggle on
+        if (page_status != msg_args[0]) {
+          is31_write_register(IS31_FUNCTIONREG, IS31_REG_PICTDISP, msg_args[0]);
+          page_status = msg_args[0];
+
+          //maintain lock leds, reset to off and force recheck for new page
+          numlock_status = 0;
+          capslock_status = 0;
+          led_set(host_keyboard_leds());
+        }
+        break;
+
+      case RESET_PAGE:
+      //led_args[0] = page to reset
+        led_control_reg[0] = 0;
+        __builtin_memset(led_control_reg+1, 0, 0x12);
+        is31_write_data(msg_args[0], led_control_reg, 0x13);
+
+        //repeat for blink register
+        led_control_reg[0] = 0x12;
+        is31_write_data(msg_args[0], led_control_reg, 0x13);
+        break;
+
+      case TOGGLE_NUM_LOCK:
+      //msg_args[0] = 0 or 1, off/on
+        if (numlock_status != msg_args[0]) {
+          set_lock_leds(NUM_LOCK_LED_ADDRESS, msg_args[0], page_status);
+          numlock_status = msg_args[0];
+        }
+        break;
+      case TOGGLE_CAPS_LOCK:
+      //msg_args[0] = 0 or 1, off/on
+        if (capslock_status != msg_args[0]) {
+          set_lock_leds(CAPS_LOCK_LED_ADDRESS, msg_args[0], page_status);
+          capslock_status = msg_args[0];
+        }
+        break;
+
+      case STEP_BRIGHTNESS:
+      //led_args[0] = step up (1) or down (0)
+        switch (msg_args[0]) {
+          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;
+        }
+
+        //populate 8 byte arrays to write on each pin
+        //first byte is register address, every 0x10 9 bytes are A-matrix 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);
+        }
+        break;
+    }
+  }
+}
+
+/* ==============================
+ *    led processing functions
+ * ============================== */
+
+void set_led_bit (uint8_t page, uint8_t *led_control_word, uint8_t led_addr, uint8_t action) {
+  //returns 2 bytes: led control register address and byte to write
+  //action: 0 - off, 1 - on, 2 - toggle, 4 - blink on, 5 - blink off, 6 - toggle blink
+
+  uint8_t control_reg_addr, column_bit, column_byte, temp, blink_bit;
+
+  //check for valid led address
+  if (led_addr < 0 || led_addr > 87 || led_addr % 10 > 8) {
+    return;
+  }
+
+  blink_bit = action>>2;//check for blink bit
+  action &= ~(1<<2); //strip blink bit
+
+  //led_addr tens column is pin#, ones column is bit position in 8-bit mask
+  control_reg_addr = ((led_addr / 10) % 10 - 1 ) * 0x02;// A-matrix is every other byte
+  control_reg_addr += blink_bit == 1 ? 0x12 : 0x00;//if blink_bit, shift 12 bytes to blink register
+
+  is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_ON);
+  chThdSleepMilliseconds(5);
+  is31_read_register(page, control_reg_addr, &temp);//maintain status of leds on this byte
+  is31_write_register(IS31_FUNCTIONREG, IS31_REG_SHUTDOWN, IS31_REG_SHUTDOWN_OFF);
+
+  column_bit = 1<<(led_addr % 10 - 1);
+  column_byte = temp;
+
+  switch(action) {
+    case 0:
+      column_byte &= ~column_bit;
+      break;
+    case 1:
+      column_byte |= column_bit;
+      break;
+    case 2:
+      column_byte ^= column_bit;
+      break;
+  }
+
+  //return word to be written in register
+  led_control_word[0] = control_reg_addr;
+  led_control_word[1] = column_byte;
+  is31_write_data (page, led_control_word, 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-matrix 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, uint8_t *user_led_array, uint8_t led_count) {
+  uint8_t i;
+  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++){
+    //shift pin by 1 for