keyboards/zeal60/rgb_backlight.h

   1 /* Copyright 2017 Jason Williams (Wilba)
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #pragma once
  17
  18 #if RGB_BACKLIGHT_ENABLED
  19 #else
  20 #error rgb_backlight.h included when RGB_BACKLIGHT_ENABLED == 0
  21 #endif // RGB_BACKLIGHT_ENABLED
  22
  23 #include <stdint.h>
  24 #include <stdbool.h>
  25
  26 #include "quantum/color.h"
  27
  28 typedef struct PACKED
  29 {
  30         uint8_t h;
  31         uint8_t s;
  32 } HS;
  33
  34 typedef struct
  35 {
  36         HS color;
  37         uint8_t index;
  38 } backlight_config_indicator;
  39
  40 typedef struct
  41 {
  42         bool use_split_backspace:1;         // |
  43         bool use_split_left_shift:1;        // |
  44         bool use_split_right_shift:1;       // |
  45         bool use_7u_spacebar:1;             // |
  46         bool use_iso_enter:1;               // |
  47         bool disable_when_usb_suspended:1;  // |
  48         bool disable_hhkb_blocker_leds:1;   // |
  49         bool __pad7:1;                      // 1 byte
  50         uint8_t disable_after_timeout;      // 1 byte
  51         uint8_t brightness;                 // 1 byte
  52         uint8_t effect;                     // 1 byte
  53         uint8_t effect_speed;                           // 1 byte
  54         HS color_1;                         // 2 bytes
  55         HS color_2;                         // 2 bytes
  56         backlight_config_indicator caps_lock_indicator; // 3 bytes
  57         backlight_config_indicator layer_1_indicator;   // 3 bytes
  58         backlight_config_indicator layer_2_indicator;   // 3 bytes
  59         backlight_config_indicator layer_3_indicator;   // 3 bytes
  60         uint16_t alphas_mods[5];            // 10 bytes
  61 #if defined(RGB_BACKLIGHT_M6_B)
  62         HS custom_color[6];                 // 12 bytes
  63 #endif
  64 } backlight_config;                // = 31 bytes (M6-B = 43 bytes)
  65
  66 void backlight_config_load(void);
  67 void backlight_config_save(void);
  68 void backlight_config_set_value( uint8_t *data );
  69 void backlight_config_get_value( uint8_t *data );
  70
  71 void backlight_init_drivers(void);
  72
  73 void backlight_timer_init(void);
  74 void backlight_timer_enable(void);
  75 void backlight_timer_disable(void);
  76
  77 void backlight_set_suspend_state(bool state);
  78 void backlight_set_indicator_state(uint8_t state);
  79
  80 // This should not be called from an interrupt
  81 // (eg. from a timer interrupt).
  82 // Call this while idle (in between matrix scans).
  83 // If the buffer is dirty, it will update the driver with the buffer.
  84 void backlight_update_pwm_buffers(void);
  85
  86 // Handle backlight specific keycodes
  87 bool process_record_backlight(uint16_t keycode, keyrecord_t *record);
  88
  89 void backlight_set_key_hit(uint8_t row, uint8_t col);
  90
  91 void backlight_effect_increase(void);
  92 void backlight_effect_decrease(void);
  93 void backlight_effect_speed_increase(void);
  94 void backlight_effect_speed_decrease(void);
  95
  96 void backlight_brightness_increase(void);
  97 void backlight_brightness_decrease(void);
  98
  99 void backlight_color_1_hue_increase(void);
 100 void backlight_color_1_hue_decrease(void);
 101 void backlight_color_1_sat_increase(void);
 102 void backlight_color_1_sat_decrease(void);
 103 void backlight_color_2_hue_increase(void);
 104 void backlight_color_2_hue_decrease(void);
 105 void backlight_color_2_sat_increase(void);
 106 void backlight_color_2_sat_decrease(void);
 107
 108 void backlight_test_led( uint8_t index, bool red, bool green, bool blue );
 109 void backlight_debug_led(bool state);
 110