keyboards/rama/koyu/config.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 #include "config_common.h"
  19
  20 // USB Device descriptor parameter
  21 #define VENDOR_ID       0x5241 // "RW"
  22 #define PRODUCT_ID      0x4B59 // "KY"
  23 #define DEVICE_VER      0x0001
  24 #define MANUFACTURER    RAMA.WORKS
  25 #define PRODUCT         RAMA KOYU
  26 #define DESCRIPTION     RAMA KOYU Keyboard
  27
  28
  29
  30 // key matrix size
  31 #define MATRIX_ROWS 5
  32 #define MATRIX_COLS 15
  33
  34 // KOYU PCB pin-out
  35 #define MATRIX_ROW_PINS { F0, F1, F4, F6, F7 }
  36 #define MATRIX_COL_PINS { F5, D5, B1, B2, B3, D3, D2, C7, C6, B6, B5, B4, D7, D6, D4 }
  37 #define UNUSED_PINS
  38
  39 // IS31FL3731 driver
  40 #define DRIVER_COUNT 2
  41 #define DRIVER_LED_TOTAL 72
  42
  43 // COL2ROW or ROW2COL
  44 #define DIODE_DIRECTION COL2ROW
  45
  46 // Set 0 if debouncing isn't needed
  47 #define DEBOUNCE 5
  48
  49 // Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
  50 #define LOCKING_SUPPORT_ENABLE
  51 // Locking resynchronize hack
  52 #define LOCKING_RESYNC_ENABLE
  53
  54
  55 /*
  56  * Feature disable options
  57  *  These options are also useful to firmware size reduction.
  58  */
  59
  60 // disable debug print
  61 //#define NO_DEBUG
  62
  63 // disable print
  64 //#define NO_PRINT
  65
  66 // disable action features
  67 //#define NO_ACTION_LAYER
  68 //#define NO_ACTION_TAPPING
  69 //#define NO_ACTION_ONESHOT
  70 //#define NO_ACTION_MACRO
  71 //#define NO_ACTION_FUNCTION
  72
  73 #define RGB_BACKLIGHT_ENABLED 1
  74
  75 // This conditionally compiles the backlight code for KOYU specifics
  76 #define RGB_BACKLIGHT_KOYU
  77
  78 // enable/disable LEDs based on layout
  79 // they aren't really used if RGB_BACKLIGHT_M60_A defined
  80 #define RGB_BACKLIGHT_USE_SPLIT_BACKSPACE 1
  81 #define RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT 0
  82 #define RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT 1
  83 #define RGB_BACKLIGHT_USE_7U_SPACEBAR 1
  84 #define RGB_BACKLIGHT_USE_ISO_ENTER 0
  85 #define RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS 1
  86
  87 // disable backlight when USB suspended (PC sleep/hibernate/shutdown)
  88 #define RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED 0
  89
  90 // disable backlight after timeout in minutes, 0 = no timeout
  91 #define RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT 0
  92
  93 // the default brightness
  94 #define RGB_BACKLIGHT_BRIGHTNESS 255
  95
  96 // the default effect (RGB test)
  97 #define RGB_BACKLIGHT_EFFECT 255
  98
  99 // the default effect speed (0-3)
 100 #define RGB_BACKLIGHT_EFFECT_SPEED 0
 101
 102 // the default color1 and color2
 103 #define RGB_BACKLIGHT_COLOR_1 { .h = 0, .s = 255 }
 104 #define RGB_BACKLIGHT_COLOR_2 { .h = 127, .s = 255 }
 105
 106 // These define which keys in the matrix are alphas/mods
 107 // Used for backlight effects so colors are different for
 108 // alphas vs. mods
 109 // Each value is for a row, bit 0 is column 0
 110 // Alpha=0 Mod=1
 111 #define RGB_BACKLIGHT_ALPHAS_MODS_ROW_0 0b0110000000000001
 112 #define RGB_BACKLIGHT_ALPHAS_MODS_ROW_1 0b0110000000000001
 113 #define RGB_BACKLIGHT_ALPHAS_MODS_ROW_2 0b0111000000000001
 114 #define RGB_BACKLIGHT_ALPHAS_MODS_ROW_3 0b0111000000000001
 115 #define RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 0b0111100000000111
 116
 117 #define RGB_BACKLIGHT_CAPS_LOCK_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
 118 #define RGB_BACKLIGHT_LAYER_1_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
 119 #define RGB_BACKLIGHT_LAYER_2_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
 120 #define RGB_BACKLIGHT_LAYER_3_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
 121
 122 #define DYNAMIC_KEYMAP_LAYER_COUNT 4
 123
 124 // EEPROM usage
 125
 126 // TODO: refactor with new user EEPROM code (coming soon)
 127 #define EEPROM_MAGIC 0x451F
 128 #define EEPROM_MAGIC_ADDR 32
 129 // Bump this every time we change what we store
 130 // This will automatically reset the EEPROM with defaults
 131 // and avoid loading invalid data from the EEPROM
 132 #define EEPROM_VERSION 0x08
 133 #define EEPROM_VERSION_ADDR 34
 134
 135 // Backlight config starts after EEPROM version
 136 #define RGB_BACKLIGHT_CONFIG_EEPROM_ADDR 35
 137 // Dynamic keymap starts after backlight config (35+31)
 138 #define DYNAMIC_KEYMAP_EEPROM_ADDR 66
 139 // Dynamic macro starts after dynamic keymaps (66+(4*5*15*2)) = (66+600)
 140 #define DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR 666
 141 #define DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE 358
 142 #define DYNAMIC_KEYMAP_MACRO_COUNT 16