keyboards/rama/m6_a/config.h

   1 /*
   2 Copyright 2018 Wilba
   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 #pragma once
  19
  20 #include "config_common.h"
  21
  22 /* USB Device descriptor parameter */
  23 #define VENDOR_ID       0x5241 // "RW"
  24 #define PRODUCT_ID      0x006A // 6-A
  25 #define DEVICE_VER      0x0001
  26 #define MANUFACTURER    RAMA.WORKS
  27 #define PRODUCT         RAMA M6-A
  28 #define DESCRIPTION     RAMA M6-A Macropad
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 1
  32 #define MATRIX_COLS 6
  33
  34 /*
  35  * Keyboard Matrix Assignments
  36  *
  37  * Change this to how you wired your keyboard
  38  * COLS: AVR pins used for columns, left to right
  39  * ROWS: AVR pins used for rows, top to bottom
  40  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
  41  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
  42  *
  43 */
  44 #define MATRIX_ROW_PINS { E6 }
  45 #define MATRIX_COL_PINS { D4, B5, F4, D7, C6, F6 }
  46 #define UNUSED_PINS
  47
  48 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
  49 #define DIODE_DIRECTION COL2ROW
  50
  51 // #define BACKLIGHT_PIN B7
  52 // #define BACKLIGHT_BREATHING
  53 // #define BACKLIGHT_LEVELS 3
  54
  55
  56 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  57 #define DEBOUNCING_DELAY 5
  58
  59 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  60 //#define MATRIX_HAS_GHOST
  61
  62 /* number of backlight levels */
  63
  64 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  65 #define LOCKING_SUPPORT_ENABLE
  66 /* Locking resynchronize hack */
  67 #define LOCKING_RESYNC_ENABLE
  68
  69 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
  70  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
  71  */
  72 // #define GRAVE_ESC_CTRL_OVERRIDE
  73
  74 /*
  75  * Force NKRO
  76  *
  77  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  78  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  79  * makefile for this to work.)
  80  *
  81  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  82  * until the next keyboard reset.
  83  *
  84  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  85  * fully operational during normal computer usage.
  86  *
  87  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  88  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  89  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
  90  * power-up.
  91  *
  92  */
  93 //#define FORCE_NKRO
  94
  95 /*
  96  * Magic Key Options
  97  *
  98  * Magic keys are hotkey commands that allow control over firmware functions of
  99  * the keyboard. They are best used in combination with the HID Listen program,
 100  * found here: https://www.pjrc.com/teensy/hid_listen.html
 101  *
 102  * The options below allow the magic key functionality to be changed. This is
 103  * useful if your keyboard/keypad is missing keys and you want magic key support.
 104  *
 105  */
 106
 107 /* key combination for magic key command */
 108 #define IS_COMMAND() ( \
 109     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 110 )
 111
 112 /* control how magic key switches layers */
 113 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 114 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 115 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 116
 117 /* override magic key keymap */
 118 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 119 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 120 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 121 //#define MAGIC_KEY_HELP1          H
 122 //#define MAGIC_KEY_HELP2          SLASH
 123 //#define MAGIC_KEY_DEBUG          D
 124 //#define MAGIC_KEY_DEBUG_MATRIX   X
 125 //#define MAGIC_KEY_DEBUG_KBD      K
 126 //#define MAGIC_KEY_DEBUG_MOUSE    M
 127 //#define MAGIC_KEY_VERSION        V
 128 //#define MAGIC_KEY_STATUS         S
 129 //#define MAGIC_KEY_CONSOLE        C
 130 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 131 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 132 //#define MAGIC_KEY_LAYER0         0
 133 //#define MAGIC_KEY_LAYER1         1
 134 //#define MAGIC_KEY_LAYER2         2
 135 //#define MAGIC_KEY_LAYER3         3
 136 //#define MAGIC_KEY_LAYER4         4
 137 //#define MAGIC_KEY_LAYER5         5
 138 //#define MAGIC_KEY_LAYER6         6
 139 //#define MAGIC_KEY_LAYER7         7
 140 //#define MAGIC_KEY_LAYER8         8
 141 //#define MAGIC_KEY_LAYER9         9
 142 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 143 //#define MAGIC_KEY_LOCK           CAPS
 144 //#define MAGIC_KEY_EEPROM         E
 145 //#define MAGIC_KEY_NKRO           N
 146 //#define MAGIC_KEY_SLEEP_LED      Z
 147
 148 /*
 149  * Feature disable options
 150  *  These options are also useful to firmware size reduction.
 151  */
 152
 153 /* disable debug print */
 154 //#define NO_DEBUG
 155
 156 /* disable print */
 157 //#define NO_PRINT
 158
 159 /* disable action features */
 160 //#define NO_ACTION_LAYER
 161 //#define NO_ACTION_TAPPING
 162 //#define NO_ACTION_ONESHOT
 163 //#define NO_ACTION_MACRO
 164 //#define NO_ACTION_FUNCTION
 165
 166 /*
 167  * MIDI options
 168  */
 169
 170 /* Prevent use of disabled MIDI features in the keymap */
 171 //#define MIDI_ENABLE_STRICT 1
 172
 173 /* enable basic MIDI features:
 174    - MIDI notes can be sent when in Music mode is on
 175 */
 176 //#define MIDI_BASIC
 177
 178 /* enable advanced MIDI features:
 179    - MIDI notes can be added to the keymap
 180    - Octave shift and transpose
 181    - Virtual sustain, portamento, and modulation wheel
 182    - etc.
 183 */
 184 //#define MIDI_ADVANCED
 185
 186 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 187 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 188
 189 #define RGB_BACKLIGHT_ENABLED 0
 190
 191 #define DYNAMIC_KEYMAP_LAYER_COUNT 4
 192
 193
 194 // EEPROM usage
 195
 196 // TODO: refactor with new user EEPROM code (coming soon)
 197 #define EEPROM_MAGIC 0x451F
 198 #define EEPROM_MAGIC_ADDR 32
 199 // Bump this every time we change what we store
 200 // This will automatically reset the EEPROM with defaults
 201 // and avoid loading invalid data from the EEPROM
 202 #define EEPROM_VERSION 0x07
 203 #define EEPROM_VERSION_ADDR 34
 204
 205 // Backlight config starts after EEPROM version
 206 #define RGB_BACKLIGHT_CONFIG_EEPROM_ADDR 35
 207 // Dynamic keymap starts after backlight config (35+37)
 208 #define DYNAMIC_KEYMAP_EEPROM_ADDR 72