keyboards/infinity60/keymaps/jpetermans/readme.md

   1 Backlight for Infinity60
   2 ========================
   3
   4 ## Led Controller Specs
   5
   6 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.
   7
   8 Infinity60 LED Map:
   9 digits mean "row" and "col", i.e. 45 means pin 4, column 5 in the IS31 datasheet
  10 ```c
  11   11 12 13 14 15 16 17 18 21 22 23 24 25  26 27*
  12    28 31 32 33 34 35 36 37 38 41 42 43 44 45
  13    46 47 48 51 52 53 54 55 56 57 58 61    62
  14    63 64 65 66 67 68 71 72 73 74 75      76 77*
  15    78  81  82       83         84  85  86  87
  16 ```
  17 *Unused in Alphabet Layout
  18
  19 The IS31 includes 8 pages (or frames) 0-7 and each page consists of 144 bytes
  20 - **bytes 0 - 17** - LED control (on/off).
  21     * 18 pins which alternate between A and B matrices (CA1, CB1, CA2, CB2, ..).
  22     * Each byte controls the 8 leds on that pin with bits (8 to 1).
  23 - **bytes 8 - 35** - Blink control.
  24     * Same as LED control above, but sets blink on/off.
  25 - **bytes 36 - 143** - PWM control.
  26     * One byte per LED, sets PWM from 0 to 255.
  27     * Same as above, the register alternates, every 8 *bytes* (not bits) between the A & B matrices.
  28
  29 ## Led Controller Code
  30 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).
  31
  32 One function is available to directly set leds without the mailbox:
  33 ```
  34 write_led_page(page#, array of leds by address, # of leds in array)
  35 ```
  36 This function saves a full page to the controller using a supplied array of led locations such as:
  37 ```c
  38 uint8_t led_numpad[16] =  {
  39   18,21,22,23,
  40   37,38,41,42,
  41   55,56,57,58,
  42   72,73,74,75
  43 }
  44 write_led_page(5, led_numpad, 16);
  45 ```
  46
  47 Remaining led control is done through the led mailbox using these message types:
  48 - **SET_FULL_ROW** (3 bytes) - row#, message type, 8-bit mask. Sets all leds on one pin per the bit mask.
  49 - **OFF_LED, ON_LED, TOGGLE_LED** (3 bytes) - message type, led address, and page#. Off/on/toggle specific led.
  50 - **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.
  51 - **TOGGLE_ALL** (1 byte) - Turn on/off full backlight.
  52 - **TOGGLE_BACKLIGHT** (2 bytes) - message type, on/off. Sets backlight completely off, no leds will display.
  53 - **DISPLAY_PAGE** (2 bytes) - message type, page to display. Switch to specific pre-set page.
  54 - **RESET_PAGE** (2 bytes) - message type, page to reset. Reset/erase specific page.
  55 - **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).
  56 - **TOGGLE_CAPS_LOCK** (2 bytes) - message type, on/off (CAPS_LOCK_LED_ADDRESS). Same as numlock.
  57 - **STEP_BRIGHTNESS** (2 bytes) - message type, and step up (1) or step down (0). Increase or decrease led brightness.
  58
  59 ## Sending messages in Keymap.c
  60 Sending an action to the led mailbox is done using chMBPost:
  61 ```
  62 chMBPost(&led_mailbox, message, timeout);
  63 ```
  64 - &led_mailbox - pointer to led mailbox
  65 - 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.
  66 - timeout is TIME_IMMEDIATE
  67
  68 An example:
  69 ```c
  70 //set the message to be sent. First byte (LSB) is the led address, and second is the message type
  71 msg=(42 << 8) | ON_LED
  72
  73 //send msg to the led mailbox
  74 chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
  75 ```
  76
  77 Another:
  78 ```c
  79 msg=(46 << 8) | BLINK_TOGGLE_LED
  80 chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
  81 ```
  82
  83 Finally, SET_FULL_ROW requires an extra byte with row information in the message so sending this message looks like:
  84 ```c
  85 msg=(row<<16) | (led_pin_byte << 8) | SET_FULL_ROW;
  86 chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
  87 ```