keyboards/rama/u80_a/config.h

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