logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

is31fl3736.c (9241B)

    

  1. /* Copyright 2018 Jason Williams (Wilba)
  2.  * Copyright 2021 Doni Crosby
  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.  */
  18. #include "is31fl3736.h"
  19. #include "i2c_master.h"
  20. #include "gpio.h"
  21. #include "wait.h"
  23. #define IS31FL3736_PWM_REGISTER_COUNT 192 // actually 96
  24. #define IS31FL3736_LED_CONTROL_REGISTER_COUNT 24
  26. #ifndef IS31FL3736_I2C_TIMEOUT
  27. #    define IS31FL3736_I2C_TIMEOUT 100
  28. #endif
  30. #ifndef IS31FL3736_I2C_PERSISTENCE
  31. #    define IS31FL3736_I2C_PERSISTENCE 0
  32. #endif
  34. #ifndef IS31FL3736_PWM_FREQUENCY
  35. #    define IS31FL3736_PWM_FREQUENCY IS31FL3736_PWM_FREQUENCY_8K4_HZ // PFS - IS31FL3736B only
  36. #endif
  38. #ifndef IS31FL3736_SW_PULLUP
  39. #    define IS31FL3736_SW_PULLUP IS31FL3736_PUR_0_OHM
  40. #endif
  42. #ifndef IS31FL3736_CS_PULLDOWN
  43. #    define IS31FL3736_CS_PULLDOWN IS31FL3736_PDR_0_OHM
  44. #endif
  46. #ifndef IS31FL3736_GLOBAL_CURRENT
  47. #    define IS31FL3736_GLOBAL_CURRENT 0xFF
  48. #endif
  50. const uint8_t i2c_addresses[IS31FL3736_DRIVER_COUNT] = {
  51.     IS31FL3736_I2C_ADDRESS_1,
  52. #ifdef IS31FL3736_I2C_ADDRESS_2
  53.     IS31FL3736_I2C_ADDRESS_2,
  54. #    ifdef IS31FL3736_I2C_ADDRESS_3
  55.     IS31FL3736_I2C_ADDRESS_3,
  56. #        ifdef IS31FL3736_I2C_ADDRESS_4
  57.     IS31FL3736_I2C_ADDRESS_4,
  58. #        endif
  59. #    endif
  60. #endif
  61. };
  63. // These buffers match the IS31FL3736 PWM registers.
  64. // The control buffers match the page 0 LED On/Off registers.
  65. // Storing them like this is optimal for I2C transfers to the registers.
  66. // We could optimize this and take out the unused registers from these
  67. // buffers and the transfers in is31fl3736_write_pwm_buffer() but it's
  68. // probably not worth the extra complexity.
  69. typedef struct is31fl3736_driver_t {
  70.     uint8_t pwm_buffer[IS31FL3736_PWM_REGISTER_COUNT];
  71.     bool    pwm_buffer_dirty;
  72.     uint8_t led_control_buffer[IS31FL3736_LED_CONTROL_REGISTER_COUNT];
  73.     bool    led_control_buffer_dirty;
  74. } PACKED is31fl3736_driver_t;
  76. is31fl3736_driver_t driver_buffers[IS31FL3736_DRIVER_COUNT] = {{
  77.     .pwm_buffer               = {0},
  78.     .pwm_buffer_dirty         = false,
  79.     .led_control_buffer       = {0},
  80.     .led_control_buffer_dirty = false,
  81. }};
  83. void is31fl3736_write_register(uint8_t index, uint8_t reg, uint8_t data) {
  84. #if IS31FL3736_I2C_PERSISTENCE > 0
  85.     for (uint8_t i = 0; i < IS31FL3736_I2C_PERSISTENCE; i++) {
  86.         if (i2c_write_register(i2c_addresses[index] << 1, reg, &data, 1, IS31FL3736_I2C_TIMEOUT) == I2C_STATUS_SUCCESS) break;
  87.     }
  88. #else
  89.     i2c_write_register(i2c_addresses[index] << 1, reg, &data, 1, IS31FL3736_I2C_TIMEOUT);
  90. #endif
  91. }
  93. void is31fl3736_select_page(uint8_t index, uint8_t page) {
  94.     is31fl3736_write_register(index, IS31FL3736_REG_COMMAND_WRITE_LOCK, IS31FL3736_COMMAND_WRITE_LOCK_MAGIC);
  95.     is31fl3736_write_register(index, IS31FL3736_REG_COMMAND, page);
  96. }
  98. void is31fl3736_write_pwm_buffer(uint8_t index) {
  99.     // Assumes page 1 is already selected.
  100.     // Transmit PWM registers in 12 transfers of 16 bytes.
  102.     // Iterate over the pwm_buffer contents at 16 byte intervals.
  103.     for (uint8_t i = 0; i < IS31FL3736_PWM_REGISTER_COUNT; i += 16) {
  104. #if IS31FL3736_I2C_PERSISTENCE > 0
  105.         for (uint8_t j = 0; j < IS31FL3736_I2C_PERSISTENCE; j++) {
  106.             if (i2c_write_register(i2c_addresses[index] << 1, i, driver_buffers[index].pwm_buffer + i, 16, IS31FL3736_I2C_TIMEOUT) == I2C_STATUS_SUCCESS) break;
  107.         }
  108. #else
  109.         i2c_write_register(i2c_addresses[index] << 1, i, driver_buffers[index].pwm_buffer + i, 16, IS31FL3736_I2C_TIMEOUT);
  110. #endif
  111.     }
  112. }
  114. void is31fl3736_init_drivers(void) {
  115.     i2c_init();
  117. #if defined(IS31FL3736_SDB_PIN)
  118.     gpio_set_pin_output(IS31FL3736_SDB_PIN);
  119.     gpio_write_pin_high(IS31FL3736_SDB_PIN);
  120. #endif
  122.     for (uint8_t i = 0; i < IS31FL3736_DRIVER_COUNT; i++) {
  123.         is31fl3736_init(i);
  124.     }
  126.     for (int i = 0; i < IS31FL3736_LED_COUNT; i++) {
  127.         is31fl3736_set_led_control_register(i, true, true, true);
  128.     }
  130.     for (uint8_t i = 0; i < IS31FL3736_DRIVER_COUNT; i++) {
  131.         is31fl3736_update_led_control_registers(i);
  132.     }
  133. }
  135. void is31fl3736_init(uint8_t index) {
  136.     // In order to avoid the LEDs being driven with garbage data
  137.     // in the LED driver's PWM registers, shutdown is enabled last.
  138.     // Set up the mode and other settings, clear the PWM registers,
  139.     // then disable software shutdown.
  141.     is31fl3736_select_page(index, IS31FL3736_COMMAND_LED_CONTROL);
  143.     // Turn off all LEDs.
  144.     for (uint8_t i = 0; i < IS31FL3736_LED_CONTROL_REGISTER_COUNT; i++) {
  145.         is31fl3736_write_register(index, i, 0x00);
  146.     }
  148.     is31fl3736_select_page(index, IS31FL3736_COMMAND_PWM);
  150.     // Set PWM on all LEDs to 0
  151.     // No need to setup Breath registers to PWM as that is the default.
  152.     for (uint8_t i = 0; i < IS31FL3736_PWM_REGISTER_COUNT; i++) {
  153.         is31fl3736_write_register(index, i, 0x00);
  154.     }
  156.     is31fl3736_select_page(index, IS31FL3736_COMMAND_FUNCTION);
  158.     // Set de-ghost pull-up resistors (SWx)
  159.     is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_SW_PULLUP, IS31FL3736_SW_PULLUP);
  160.     // Set de-ghost pull-down resistors (CSx)
  161.     is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_CS_PULLDOWN, IS31FL3736_CS_PULLDOWN);
  162.     // Set global current to maximum.
  163.     is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_GLOBAL_CURRENT, IS31FL3736_GLOBAL_CURRENT);
  164.     // Disable software shutdown.
  165.     is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_CONFIGURATION, ((IS31FL3736_PWM_FREQUENCY & 0b111) << 3) | 0x01);
  167.     // Wait 10ms to ensure the device has woken up.
  168.     wait_ms(10);
  169. }
  171. void is31fl3736_set_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
  172.     is31fl3736_led_t led;
  174.     if (index >= 0 && index < IS31FL3736_LED_COUNT) {
  175.         memcpy_P(&led, (&g_is31fl3736_leds[index]), sizeof(led));
  177.         if (driver_buffers[led.driver].pwm_buffer[led.r] == red && driver_buffers[led.driver].pwm_buffer[led.g] == green && driver_buffers[led.driver].pwm_buffer[led.b] == blue) {
  178.             return;
  179.         }
  181.         driver_buffers[led.driver].pwm_buffer[led.r] = red;
  182.         driver_buffers[led.driver].pwm_buffer[led.g] = green;
  183.         driver_buffers[led.driver].pwm_buffer[led.b] = blue;
  184.         driver_buffers[led.driver].pwm_buffer_dirty  = true;
  185.     }
  186. }
  188. void is31fl3736_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
  189.     for (int i = 0; i < IS31FL3736_LED_COUNT; i++) {
  190.         is31fl3736_set_color(i, red, green, blue);
  191.     }
  192. }
  194. void is31fl3736_set_led_control_register(uint8_t index, bool red, bool green, bool blue) {
  195.     is31fl3736_led_t led;
  196.     memcpy_P(&led, (&g_is31fl3736_leds[index]), sizeof(led));
  198.     // The PWM register for a matrix position (0x00 to 0xBF) is interleaved, so:
  199.     // A1=0x00 A2=0x02 A3=0x04 A4=0x06 A5=0x08 A6=0x0A A7=0x0C A8=0x0E
  200.     // B1=0x10 B2=0x12 B3=0x14
  201.     // But also, the LED control registers (0x00 to 0x17) are also interleaved, so:
  202.     // A1-A4=0x00 A5-A8=0x01
  204.     uint8_t control_register_r = led.r / 8;
  205.     uint8_t control_register_g = led.g / 8;
  206.     uint8_t control_register_b = led.b / 8;
  208.     uint8_t bit_r = led.r % 8;
  209.     uint8_t bit_g = led.g % 8;
  210.     uint8_t bit_b = led.b % 8;
  212.     if (red) {
  213.         driver_buffers[led.driver].led_control_buffer[control_register_r] |= (1 << bit_r);
  214.     } else {
  215.         driver_buffers[led.driver].led_control_buffer[control_register_r] &= ~(1 << bit_r);
  216.     }
  217.     if (green) {
  218.         driver_buffers[led.driver].led_control_buffer[control_register_g] |= (1 << bit_g);
  219.     } else {
  220.         driver_buffers[led.driver].led_control_buffer[control_register_g] &= ~(1 << bit_g);
  221.     }
  222.     if (blue) {
  223.         driver_buffers[led.driver].led_control_buffer[control_register_b] |= (1 << bit_b);
  224.     } else {
  225.         driver_buffers[led.driver].led_control_buffer[control_register_b] &= ~(1 << bit_b);
  226.     }
  228.     driver_buffers[led.driver].led_control_buffer_dirty = true;
  229. }
  231. void is31fl3736_update_pwm_buffers(uint8_t index) {
  232.     if (driver_buffers[index].pwm_buffer_dirty) {
  233.         is31fl3736_select_page(index, IS31FL3736_COMMAND_PWM);
  235.         is31fl3736_write_pwm_buffer(index);
  237.         driver_buffers[index].pwm_buffer_dirty = false;
  238.     }
  239. }
  241. void is31fl3736_update_led_control_registers(uint8_t index) {
  242.     if (driver_buffers[index].led_control_buffer_dirty) {
  243.         is31fl3736_select_page(index, IS31FL3736_COMMAND_LED_CONTROL);
  245.         for (uint8_t i = 0; i < IS31FL3736_LED_CONTROL_REGISTER_COUNT; i++) {
  246.             is31fl3736_write_register(index, i, driver_buffers[index].led_control_buffer[i]);
  247.         }
  249.         driver_buffers[index].led_control_buffer_dirty = false;
  250.     }
  251. }
  253. void is31fl3736_flush(void) {
  254.     for (uint8_t i = 0; i < IS31FL3736_DRIVER_COUNT; i++) {
  255.         is31fl3736_update_pwm_buffers(i);
  256.     }
  257. }