keyboards/gingham/config.h

   1 /*
   2 Copyright 2019 Yiancar
   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 #define VENDOR_ID       0x8968
  23 #define PRODUCT_ID      0x4748
  24 #define DEVICE_VER      0x0001
  25 #define MANUFACTURER    Yiancar-Designs
  26 #define PRODUCT         Gingham
  27 #define DESCRIPTION     A 65 persent keyboard with only through hole components
  28
  29 /* key matrix size */
  30 #define MATRIX_ROWS 5
  31 #define MATRIX_COLS 14
  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
  44 /* A Custom matrix.c is used to poll the port expander C6 shows that the pins are hardwired there */
  45 #define MATRIX_ROW_PINS { D0, C3, D1, C1, C2 }
  46 #define MATRIX_COL_PINS { D4, D4, C0, B5, D5, B4, D6, B1, B0, B2, D7, B3, D4, D4 }
  47 #define UNUSED_PINS
  48 #define PORT_EXPANDER_ADDRESS 0x20
  49
  50 /* COL2ROW, ROW2COL*/
  51 #define DIODE_DIRECTION COL2ROW
  52
  53 #define NO_UART 1
  54 #define USB_MAX_POWER_CONSUMPTION 100
  55
  56 /*
  57  * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
  58  */
  59 // #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
  60
  61 // #define BACKLIGHT_PIN B7
  62 // #define BACKLIGHT_BREATHING
  63 // #define BACKLIGHT_LEVELS 3
  64
  65 // #define RGB_DI_PIN E2
  66 // #ifdef RGB_DI_PIN
  67 //   #define RGBLED_NUM 16
  68 //   #define RGBLIGHT_HUE_STEP 8
  69 //   #define RGBLIGHT_SAT_STEP 8
  70 //   #define RGBLIGHT_VAL_STEP 8
  71 //   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
  72 //   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
  73 // /*== all animations enable ==*/
  74 //   #define RGBLIGHT_ANIMATIONS
  75 // /*== or choose animations ==*/
  76 //   #define RGBLIGHT_EFFECT_BREATHING
  77 //   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
  78 //   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
  79 //   #define RGBLIGHT_EFFECT_SNAKE
  80 //   #define RGBLIGHT_EFFECT_KNIGHT
  81 //   #define RGBLIGHT_EFFECT_CHRISTMAS
  82 //   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
  83 //   #define RGBLIGHT_EFFECT_RGB_TEST
  84 //   #define RGBLIGHT_EFFECT_ALTERNATING
  85 // #endif
  86
  87 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  88 #define DEBOUNCE 5
  89
  90 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  91 //#define MATRIX_HAS_GHOST
  92
  93 /* number of backlight levels */
  94
  95 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  96 #define LOCKING_SUPPORT_ENABLE
  97 /* Locking resynchronize hack */
  98 #define LOCKING_RESYNC_ENABLE
  99
 100 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 101  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 102  */
 103 // #define GRAVE_ESC_CTRL_OVERRIDE
 104
 105 /*
 106  * Force NKRO
 107  *
 108  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 109  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 110  * makefile for this to work.)
 111  *
 112  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 113  * until the next keyboard reset.
 114  *
 115  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 116  * fully operational during normal computer usage.
 117  *
 118  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 119  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 120  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 121  * power-up.
 122  *
 123  */
 124 //#define FORCE_NKRO
 125
 126 /*
 127  * Magic Key Options
 128  *
 129  * Magic keys are hotkey commands that allow control over firmware functions of
 130  * the keyboard. They are best used in combination with the HID Listen program,
 131  * found here: https://www.pjrc.com/teensy/hid_listen.html
 132  *
 133  * The options below allow the magic key functionality to be changed. This is
 134  * useful if your keyboard/keypad is missing keys and you want magic key support.
 135  *
 136  */
 137
 138 /* key combination for magic key command */
 139 /* defined by default; to change, uncomment and set to the combination you want */
 140 // #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))
 141
 142 /* control how magic key switches layers */
 143 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 144 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 145 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 146
 147 /* override magic key keymap */
 148 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 149 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 150 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 151 //#define MAGIC_KEY_HELP           H
 152 //#define MAGIC_KEY_HELP_ALT       SLASH
 153 //#define MAGIC_KEY_DEBUG          D
 154 //#define MAGIC_KEY_DEBUG_MATRIX   X
 155 //#define MAGIC_KEY_DEBUG_KBD      K
 156 //#define MAGIC_KEY_DEBUG_MOUSE    M
 157 //#define MAGIC_KEY_VERSION        V
 158 //#define MAGIC_KEY_STATUS         S
 159 //#define MAGIC_KEY_CONSOLE        C
 160 //#define MAGIC_KEY_LAYER0         0
 161 //#define MAGIC_KEY_LAYER0_ALT     GRAVE
 162 //#define MAGIC_KEY_LAYER1         1
 163 //#define MAGIC_KEY_LAYER2         2
 164 //#define MAGIC_KEY_LAYER3         3
 165 //#define MAGIC_KEY_LAYER4         4
 166 //#define MAGIC_KEY_LAYER5         5
 167 //#define MAGIC_KEY_LAYER6         6
 168 //#define MAGIC_KEY_LAYER7         7
 169 //#define MAGIC_KEY_LAYER8         8
 170 //#define MAGIC_KEY_LAYER9         9
 171 //#define MAGIC_KEY_BOOTLOADER     B
 172 //#define MAGIC_KEY_BOOTLOADER_ALT ESC
 173 //#define MAGIC_KEY_LOCK           CAPS
 174 //#define MAGIC_KEY_EEPROM         E
 175 //#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
 176 //#define MAGIC_KEY_NKRO           N
 177 //#define MAGIC_KEY_SLEEP_LED      Z
 178
 179 /*
 180  * Feature disable options
 181  *  These options are also useful to firmware size reduction.
 182  */
 183
 184 /* disable debug print */
 185 //#define NO_DEBUG
 186
 187 /* disable print */
 188 //#define NO_PRINT
 189
 190 /* disable action features */
 191 //#define NO_ACTION_LAYER
 192 //#define NO_ACTION_TAPPING
 193 //#define NO_ACTION_ONESHOT
 194 //#define NO_ACTION_MACRO
 195 //#define NO_ACTION_FUNCTION
 196
 197 /*
 198  * MIDI options
 199  */
 200
 201 /* Prevent use of disabled MIDI features in the keymap */
 202 //#define MIDI_ENABLE_STRICT 1
 203
 204 /* enable basic MIDI features:
 205    - MIDI notes can be sent when in Music mode is on
 206 */
 207 //#define MIDI_BASIC
 208
 209 /* enable advanced MIDI features:
 210    - MIDI notes can be added to the keymap
 211    - Octave shift and transpose
 212    - Virtual sustain, portamento, and modulation wheel
 213    - etc.
 214 */
 215 //#define MIDI_ADVANCED
 216
 217 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 218 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 219
 220 /*
 221  * HD44780 LCD Display Configuration
 222  */
 223 /*
 224 #define LCD_LINES           2     //< number of visible lines of the display
 225 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 226
 227 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 228
 229 #if LCD_IO_MODE
 230 #define LCD_PORT         PORTB        //< port for the LCD lines
 231 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 232 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 233 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 234 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 235 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 236 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 237 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 238 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 239 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 240 #define LCD_RS_PIN       3            //< pin  for RS line
 241 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 242 #define LCD_RW_PIN       2            //< pin  for RW line
 243 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 244 #define LCD_E_PIN        1            //< pin  for Enable line
 245 #endif
 246 */
 247
 248 /* Bootmagic Lite key configuration */
 249 #define BOOTMAGIC_LITE_ROW 0
 250 #define BOOTMAGIC_LITE_COLUMN 0
 251