tmk_core/protocol/arm_atsam/led_matrix.h

   1 /*
   2 Copyright 2018 Massdrop Inc.
   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 #ifndef _LED_MATRIX_H_
  19 #define _LED_MATRIX_H_
  20
  21 //From keyboard
  22 #include "config_led.h"
  23
  24 //CS1-CS16 Current Source "Col"
  25 #define ISSI3733_CS_COUNT 16
  26
  27 //SW1-SW12 Switch "Row"
  28 #define ISSI3733_SW_COUNT 12
  29
  30 #define ISSI3733_LED_RGB_COUNT ISSI3733_CS_COUNT * ISSI3733_SW_COUNT
  31 #define ISSI3733_PG0_BYTES ISSI3733_LED_RGB_COUNT / 8 + 1       //+1 for first byte being memory start offset for I2C transfer
  32 #define ISSI3733_PG1_BYTES ISSI3733_LED_RGB_COUNT + 1           //+1 for first byte being memory start offset for I2C transfer
  33 #define ISSI3733_PG2_BYTES ISSI3733_LED_RGB_COUNT + 1           //+1 for first byte being memory start offset for I2C transfer
  34 #define ISSI3733_PG3_BYTES 18 + 1                               //+1 for first byte being memory start offset for I2C transfer
  35
  36 #define ISSI3733_PG_ONOFF_BYTES ISSI3733_PG0_BYTES
  37 #define ISSI3733_PG_OR_BYTES ISSI3733_PG0_BYTES
  38 #define ISSI3733_PG_SR_BYTES ISSI3733_PG0_BYTES
  39 #define ISSI3733_PG_PWM_BYTES ISSI3733_PG1_BYTES
  40 #define ISSI3733_PG_ABM_BYTES ISSI3733_PG2_BYTES
  41 #define ISSI3733_PG_FN_BYTES ISSI3733_PG3_BYTES
  42
  43 typedef struct issi3733_driver_s {
  44     uint8_t addr; //Address of the driver according to wiring "ISSI3733: Table 1 Slave Address"
  45     uint8_t onoff[ISSI3733_PG_ONOFF_BYTES]; //PG0 - LED Control Register - LED On/Off Register
  46     uint8_t open[ISSI3733_PG_OR_BYTES];     //PG0 - LED Control Register - LED Open Register
  47     uint8_t shrt[ISSI3733_PG_SR_BYTES];     //PG0 - LED Control Register - LED Short Register
  48     uint8_t pwm[ISSI3733_PG_PWM_BYTES];     //PG1 - PWM Register
  49     uint8_t abm[ISSI3733_PG_ABM_BYTES];     //PG2 - Auto Breath Mode Register
  50     uint8_t conf[ISSI3733_PG_FN_BYTES];     //PG3 - Function Register
  51 } issi3733_driver_t;
  52
  53 typedef struct issi3733_rgb_s {
  54     uint8_t *r;         //Direct access into PWM data
  55     uint8_t *g;         //Direct access into PWM data
  56     uint8_t *b;         //Direct access into PWM data
  57 } issi3733_rgb_t;
  58
  59 typedef struct issi3733_rgb_adr_s {
  60     uint8_t drv;        //Driver from given list
  61     uint8_t cs;         //CS
  62     uint8_t swr;        //SW Red
  63     uint8_t swg;        //SW Green
  64     uint8_t swb;        //SW Blue
  65 } issi3733_rgb_adr_t;
  66
  67 typedef struct issi3733_led_s {
  68     uint8_t id;                 //According to PCB ref
  69     issi3733_rgb_t rgb;         //PWM settings of R G B
  70     issi3733_rgb_adr_t adr;     //Hardware addresses
  71     float x;                    //Physical position X
  72     float y;                    //Physical position Y
  73     float px;                   //Physical position X in percent
  74     float py;                   //Physical position Y in percent
  75     uint8_t scan;               //Key scan code from wiring (set 0xFF if no key)
  76 } issi3733_led_t;
  77
  78 typedef struct led_disp_s {
  79     uint64_t frame;
  80     float left;
  81     float right;
  82     float top;
  83     float bottom;
  84     float width;
  85     float height;
  86 } led_disp_t;
  87
  88 uint8_t led_matrix_init(void);
  89 void rgb_matrix_init_user(void);
  90
  91 #define LED_MODE_NORMAL             0   //Must be 0
  92 #define LED_MODE_KEYS_ONLY          1
  93 #define LED_MODE_NON_KEYS_ONLY      2
  94 #define LED_MODE_INDICATORS_ONLY    3
  95 #define LED_MODE_MAX_INDEX          LED_MODE_INDICATORS_ONLY   //Must be highest value
  96
  97 #define EF_NONE         0x00000000  //No effect
  98 #define EF_OVER         0x00000001  //Overwrite any previous color information with new
  99 #define EF_SCR_L        0x00000002  //Scroll left
 100 #define EF_SCR_R        0x00000004  //Scroll right
 101 #define EF_SUBTRACT     0x00000008  //Subtract color values
 102
 103 typedef struct led_setup_s {
 104   float hs;         //Band begin at percent
 105   float he;         //Band end at percent
 106   uint8_t rs;       //Red start value
 107   uint8_t re;       //Red end value
 108   uint8_t gs;       //Green start value
 109   uint8_t ge;       //Green end value
 110   uint8_t bs;       //Blue start value
 111   uint8_t be;       //Blue end value
 112   uint32_t ef;      //Animation and color effects
 113   uint8_t end;      //Set to signal end of the setup
 114 } led_setup_t;
 115
 116 extern issi3733_driver_t issidrv[ISSI3733_DRIVER_COUNT];
 117
 118 extern uint8_t gcr_desired;
 119 extern uint8_t gcr_breathe;
 120 extern uint8_t gcr_actual;
 121 extern uint8_t gcr_actual_last;
 122
 123 extern uint8_t led_animation_id;
 124 extern uint8_t led_enabled;
 125 extern float led_animation_speed;
 126 extern uint8_t led_lighting_mode;
 127 extern uint8_t led_animation_direction;
 128 extern uint8_t led_animation_orientation;
 129 extern uint8_t led_animation_breathing;
 130 extern uint8_t led_animation_breathe_cur;
 131 extern uint8_t breathe_dir;
 132 extern const uint8_t led_setups_count;
 133
 134 extern void *led_setups[];
 135
 136 extern issi3733_led_t *led_cur;
 137 extern issi3733_led_t *lede;
 138
 139 void led_matrix_run(void);
 140 void led_matrix_task(void);
 141
 142 void gcr_compute(void);
 143
 144 #endif //_LED_MATRIX_H_