qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

is31fl3731-mono.h (6008B)


      1 /* Copyright 2017 Jason Williams
      2  * Copyright 2018 Jack Humbert
      3  * Copyright 2019 Clueboard
      4  *
      5  * This program is free software: you can redistribute it and/or modify
      6  * it under the terms of the GNU General Public License as published by
      7  * the Free Software Foundation, either version 2 of the License, or
      8  * (at your option) any later version.
      9  *
     10  * This program is distributed in the hope that it will be useful,
     11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
     12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     13  * GNU General Public License for more details.
     14  *
     15  * You should have received a copy of the GNU General Public License
     16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
     17  */
     18 
     19 #pragma once
     20 
     21 #include <stdint.h>
     22 #include <stdbool.h>
     23 #include "progmem.h"
     24 #include "util.h"
     25 
     26 #define IS31FL3731_REG_COMMAND 0xFD
     27 #define IS31FL3731_COMMAND_FRAME_1 0x00
     28 #define IS31FL3731_COMMAND_FRAME_2 0x01
     29 #define IS31FL3731_COMMAND_FRAME_3 0x02
     30 #define IS31FL3731_COMMAND_FRAME_4 0x03
     31 #define IS31FL3731_COMMAND_FRAME_5 0x04
     32 #define IS31FL3731_COMMAND_FRAME_6 0x05
     33 #define IS31FL3731_COMMAND_FRAME_7 0x06
     34 #define IS31FL3731_COMMAND_FRAME_8 0x07
     35 #define IS31FL3731_COMMAND_FUNCTION 0x0B
     36 
     37 #define IS31FL3731_FRAME_REG_LED_CONTROL 0x00
     38 #define IS31FL3731_FRAME_REG_BLINK_CONTROL 0x12
     39 #define IS31FL3731_FRAME_REG_PWM 0x24
     40 
     41 #define IS31FL3731_FUNCTION_REG_CONFIG 0x00
     42 #define IS31FL3731_CONFIG_MODE_PICTURE 0x00
     43 #define IS31FL3731_CONFIG_MODE_AUTO_PLAY 0x08
     44 #define IS31FL3731_CONFIG_MODE_AUDIO_PLAY 0x18
     45 
     46 #define IS31FL3731_FUNCTION_REG_PICTURE_DISPLAY 0x01
     47 #define IS31FL3731_FUNCTION_REG_AUDIO_SYNC 0x06
     48 #define IS31FL3731_FUNCTION_REG_SHUTDOWN 0x0A
     49 
     50 // Not defined in the datasheet -- See AN for IC
     51 #define IS31FL3731_FUNCTION_REG_GHOST_IMAGE_PREVENTION 0xC2
     52 #define IS31FL3731_GHOST_IMAGE_PREVENTION_GEN 0x10
     53 
     54 #define IS31FL3731_I2C_ADDRESS_GND 0x74
     55 #define IS31FL3731_I2C_ADDRESS_SCL 0x75
     56 #define IS31FL3731_I2C_ADDRESS_SDA 0x76
     57 #define IS31FL3731_I2C_ADDRESS_VCC 0x77
     58 
     59 #if defined(LED_MATRIX_IS31FL3731)
     60 #    define IS31FL3731_LED_COUNT LED_MATRIX_LED_COUNT
     61 #endif
     62 
     63 #if defined IS31FL3731_I2C_ADDRESS_4
     64 #    define IS31FL3731_DRIVER_COUNT 4
     65 #elif defined IS31FL3731_I2C_ADDRESS_3
     66 #    define IS31FL3731_DRIVER_COUNT 3
     67 #elif defined IS31FL3731_I2C_ADDRESS_2
     68 #    define IS31FL3731_DRIVER_COUNT 2
     69 #elif defined IS31FL3731_I2C_ADDRESS_1
     70 #    define IS31FL3731_DRIVER_COUNT 1
     71 #endif
     72 
     73 typedef struct is31fl3731_led_t {
     74     uint8_t driver : 2;
     75     uint8_t v;
     76 } PACKED is31fl3731_led_t;
     77 
     78 extern const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT];
     79 
     80 void is31fl3731_init_drivers(void);
     81 void is31fl3731_init(uint8_t index);
     82 void is31fl3731_write_register(uint8_t index, uint8_t reg, uint8_t data);
     83 void is31fl3731_select_page(uint8_t index, uint8_t page);
     84 
     85 void is31fl3731_set_value(int index, uint8_t value);
     86 void is31fl3731_set_value_all(uint8_t value);
     87 
     88 void is31fl3731_set_led_control_register(uint8_t index, bool value);
     89 
     90 // This should not be called from an interrupt
     91 // (eg. from a timer interrupt).
     92 // Call this while idle (in between matrix scans).
     93 // If the buffer is dirty, it will update the driver with the buffer.
     94 void is31fl3731_update_pwm_buffers(uint8_t index);
     95 void is31fl3731_update_led_control_registers(uint8_t index);
     96 
     97 void is31fl3731_flush(void);
     98 
     99 #define C1_1 0x00
    100 #define C1_2 0x01
    101 #define C1_3 0x02
    102 #define C1_4 0x03
    103 #define C1_5 0x04
    104 #define C1_6 0x05
    105 #define C1_7 0x06
    106 #define C1_8 0x07
    107 
    108 #define C1_9 0x08
    109 #define C1_10 0x09
    110 #define C1_11 0x0A
    111 #define C1_12 0x0B
    112 #define C1_13 0x0C
    113 #define C1_14 0x0D
    114 #define C1_15 0x0E
    115 #define C1_16 0x0F
    116 
    117 #define C2_1 0x10
    118 #define C2_2 0x11
    119 #define C2_3 0x12
    120 #define C2_4 0x13
    121 #define C2_5 0x14
    122 #define C2_6 0x15
    123 #define C2_7 0x16
    124 #define C2_8 0x17
    125 
    126 #define C2_9 0x18
    127 #define C2_10 0x19
    128 #define C2_11 0x1A
    129 #define C2_12 0x1B
    130 #define C2_13 0x1C
    131 #define C2_14 0x1D
    132 #define C2_15 0x1E
    133 #define C2_16 0x1F
    134 
    135 #define C3_1 0x20
    136 #define C3_2 0x21
    137 #define C3_3 0x22
    138 #define C3_4 0x23
    139 #define C3_5 0x24
    140 #define C3_6 0x25
    141 #define C3_7 0x26
    142 #define C3_8 0x27
    143 
    144 #define C3_9 0x28
    145 #define C3_10 0x29
    146 #define C3_11 0x2A
    147 #define C3_12 0x2B
    148 #define C3_13 0x2C
    149 #define C3_14 0x2D
    150 #define C3_15 0x2E
    151 #define C3_16 0x2F
    152 
    153 #define C4_1 0x30
    154 #define C4_2 0x31
    155 #define C4_3 0x32
    156 #define C4_4 0x33
    157 #define C4_5 0x34
    158 #define C4_6 0x35
    159 #define C4_7 0x36
    160 #define C4_8 0x37
    161 
    162 #define C4_9 0x38
    163 #define C4_10 0x39
    164 #define C4_11 0x3A
    165 #define C4_12 0x3B
    166 #define C4_13 0x3C
    167 #define C4_14 0x3D
    168 #define C4_15 0x3E
    169 #define C4_16 0x3F
    170 
    171 #define C5_1 0x40
    172 #define C5_2 0x41
    173 #define C5_3 0x42
    174 #define C5_4 0x43
    175 #define C5_5 0x44
    176 #define C5_6 0x45
    177 #define C5_7 0x46
    178 #define C5_8 0x47
    179 
    180 #define C5_9 0x48
    181 #define C5_10 0x49
    182 #define C5_11 0x4A
    183 #define C5_12 0x4B
    184 #define C5_13 0x4C
    185 #define C5_14 0x4D
    186 #define C5_15 0x4E
    187 #define C5_16 0x4F
    188 
    189 #define C6_1 0x50
    190 #define C6_2 0x51
    191 #define C6_3 0x52
    192 #define C6_4 0x53
    193 #define C6_5 0x54
    194 #define C6_6 0x55
    195 #define C6_7 0x56
    196 #define C6_8 0x57
    197 
    198 #define C6_9 0x58
    199 #define C6_10 0x59
    200 #define C6_11 0x5A
    201 #define C6_12 0x5B
    202 #define C6_13 0x5C
    203 #define C6_14 0x5D
    204 #define C6_15 0x5E
    205 #define C6_16 0x5F
    206 
    207 #define C7_1 0x60
    208 #define C7_2 0x61
    209 #define C7_3 0x62
    210 #define C7_4 0x63
    211 #define C7_5 0x64
    212 #define C7_6 0x65
    213 #define C7_7 0x66
    214 #define C7_8 0x67
    215 
    216 #define C7_9 0x68
    217 #define C7_10 0x69
    218 #define C7_11 0x6A
    219 #define C7_12 0x6B
    220 #define C7_13 0x6C
    221 #define C7_14 0x6D
    222 #define C7_15 0x6E
    223 #define C7_16 0x6F
    224 
    225 #define C8_1 0x70
    226 #define C8_2 0x71
    227 #define C8_3 0x72
    228 #define C8_4 0x73
    229 #define C8_5 0x74
    230 #define C8_6 0x75
    231 #define C8_7 0x76
    232 #define C8_8 0x77
    233 
    234 #define C8_9 0x78
    235 #define C8_10 0x79
    236 #define C8_11 0x7A
    237 #define C8_12 0x7B
    238 #define C8_13 0x7C
    239 #define C8_14 0x7D
    240 #define C8_15 0x7E
    241 #define C8_16 0x7F
    242 
    243 #define C9_1 0x80
    244 #define C9_2 0x81
    245 #define C9_3 0x82
    246 #define C9_4 0x83
    247 #define C9_5 0x84
    248 #define C9_6 0x85
    249 #define C9_7 0x86
    250 #define C9_8 0x87
    251 
    252 #define C9_9 0x88
    253 #define C9_10 0x89
    254 #define C9_11 0x8A
    255 #define C9_12 0x8B
    256 #define C9_13 0x8C
    257 #define C9_14 0x8D
    258 #define C9_15 0x8E
    259 #define C9_16 0x8F