keyboards/xwhatsit/ibm/5251/universal/config.h

   1 /*
   2 Copyright 2020 Purdea Andrei
   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 0x0481
  24 #define PRODUCT_ID 0x0002
  25 #define DEVICE_VER 0x0001
  26 #define MANUFACTURER Tom Wong-Cornall/Purdea Andrei/kmnov2017/listofoptions
  27 #define PRODUCT IBM 5251
  28 #define DESCRIPTION QMK firmware for the IBM 5251 keyboard using a 'universal' xwhatsit controller PCB
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 4
  32 #define MATRIX_COLS 23
  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 { D0, D5 }
  45 //#define MATRIX_COL_PINS { B2, B1, B0 }
  46 //#define UNUSED_PINS
  47
  48 /* COL2ROW, ROW2COL*/
  49 //#define DIODE_DIRECTION COL2ROW
  50
  51 /*
  52  * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
  53  */
  54 #define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6
  55
  56 // #define BACKLIGHT_PIN B7
  57 // #define BACKLIGHT_BREATHING
  58 // #define BACKLIGHT_LEVELS 3
  59
  60 // #define RGB_DI_PIN E2
  61 // #ifdef RGB_DI_PIN
  62 //   #define RGBLED_NUM 16
  63 //   #define RGBLIGHT_HUE_STEP 8
  64 //   #define RGBLIGHT_SAT_STEP 8
  65 //   #define RGBLIGHT_VAL_STEP 8
  66 //   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
  67 //   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
  68 // /*== all animations enable ==*/
  69 //   #define RGBLIGHT_ANIMATIONS
  70 // /*== or choose animations ==*/
  71 //   #define RGBLIGHT_EFFECT_BREATHING
  72 //   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
  73 //   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
  74 //   #define RGBLIGHT_EFFECT_SNAKE
  75 //   #define RGBLIGHT_EFFECT_KNIGHT
  76 //   #define RGBLIGHT_EFFECT_CHRISTMAS
  77 //   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
  78 //   #define RGBLIGHT_EFFECT_RGB_TEST
  79 //   #define RGBLIGHT_EFFECT_ALTERNATING
  80 // /*== customize breathing effect ==*/
  81 //   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
  82 //   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
  83 //   /*==== use exp() and sin() ====*/
  84 //   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
  85 //   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
  86 // #endif
  87
  88 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  89 #define DEBOUNCE 5
  90
  91 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  92 //#define MATRIX_HAS_GHOST
  93
  94 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  95 #define LOCKING_SUPPORT_ENABLE
  96 /* Locking resynchronize hack */
  97 #define LOCKING_RESYNC_ENABLE
  98
  99 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 100  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 101  */
 102 // #define GRAVE_ESC_CTRL_OVERRIDE
 103
 104 /*
 105  * Force NKRO
 106  *
 107  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 108  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 109  * makefile for this to work.)
 110  *
 111  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 112  * until the next keyboard reset.
 113  *
 114  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 115  * fully operational during normal computer usage.
 116  *
 117  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 118  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 119  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 120  * power-up.
 121  *
 122  */
 123 //#define FORCE_NKRO
 124
 125 /*
 126  * Magic Key Options
 127  *
 128  * Magic keys are hotkey commands that allow control over firmware functions of
 129  * the keyboard. They are best used in combination with the HID Listen program,
 130  * found here: https://www.pjrc.com/teensy/hid_listen.html
 131  *
 132  * The options below allow the magic key functionality to be changed. This is
 133  * useful if your keyboard/keypad is missing keys and you want magic key support.
 134  *
 135  */
 136
 137 /* key combination for magic key command */
 138 /* defined by default; to change, uncomment and set to the combination you want */
 139 // #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
 140
 141 /* control how magic key switches layers */
 142 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 143 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 144 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 145
 146 /* override magic key keymap */
 147 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 148 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 149 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 150 //#define MAGIC_KEY_HELP           H
 151 //#define MAGIC_KEY_HELP_ALT       SLASH
 152 //#define MAGIC_KEY_DEBUG          D
 153 //#define MAGIC_KEY_DEBUG_MATRIX   X
 154 //#define MAGIC_KEY_DEBUG_KBD      K
 155 //#define MAGIC_KEY_DEBUG_MOUSE    M
 156 //#define MAGIC_KEY_VERSION        V
 157 //#define MAGIC_KEY_STATUS         S
 158 //#define MAGIC_KEY_CONSOLE        C
 159 //#define MAGIC_KEY_LAYER0         0
 160 //#define MAGIC_KEY_LAYER0_ALT     GRAVE
 161 //#define MAGIC_KEY_LAYER1         1
 162 //#define MAGIC_KEY_LAYER2         2
 163 //#define MAGIC_KEY_LAYER3         3
 164 //#define MAGIC_KEY_LAYER4         4
 165 //#define MAGIC_KEY_LAYER5         5
 166 //#define MAGIC_KEY_LAYER6         6
 167 //#define MAGIC_KEY_LAYER7         7
 168 //#define MAGIC_KEY_LAYER8         8
 169 //#define MAGIC_KEY_LAYER9         9
 170 //#define MAGIC_KEY_BOOTLOADER     B
 171 //#define MAGIC_KEY_BOOTLOADER_ALT ESC
 172 //#define MAGIC_KEY_LOCK           CAPS
 173 //#define MAGIC_KEY_EEPROM         E
 174 //#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
 175 //#define MAGIC_KEY_NKRO           N
 176 //#define MAGIC_KEY_SLEEP_LED      Z
 177
 178 /*
 179  * Feature disable options
 180  *  These options are also useful to firmware size reduction.
 181  */
 182
 183 /* disable debug print */
 184 //#define NO_DEBUG
 185
 186 /* disable print */
 187 //#define NO_PRINT
 188
 189 /* disable action features */
 190 //#define NO_ACTION_LAYER
 191 //#define NO_ACTION_TAPPING
 192 //#define NO_ACTION_ONESHOT
 193
 194 /* disable these deprecated features by default */
 195 #ifndef LINK_TIME_OPTIMIZATION_ENABLE
 196   #define NO_ACTION_MACRO
 197   #define NO_ACTION_FUNCTION
 198 #endif
 199 /*
 200  * MIDI options
 201  */
 202
 203 /* Prevent use of disabled MIDI features in the keymap */
 204 //#define MIDI_ENABLE_STRICT 1
 205
 206 /* enable basic MIDI features:
 207    - MIDI notes can be sent when in Music mode is on
 208 */
 209 //#define MIDI_BASIC
 210
 211 /* enable advanced MIDI features:
 212    - MIDI notes can be added to the keymap
 213    - Octave shift and transpose
 214    - Virtual sustain, portamento, and modulation wheel
 215    - etc.
 216 */
 217 //#define MIDI_ADVANCED
 218
 219 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 220 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 221
 222 /*
 223  * HD44780 LCD Display Configuration
 224  */
 225 /*
 226 #define LCD_LINES           2     //< number of visible lines of the display
 227 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 228
 229 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 230
 231 #if LCD_IO_MODE
 232 #define LCD_PORT         PORTB        //< port for the LCD lines
 233 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 234 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 235 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 236 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 237 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 238 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 239 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 240 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 241 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 242 #define LCD_RS_PIN       3            //< pin  for RS line
 243 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 244 #define LCD_RW_PIN       2            //< pin  for RW line
 245 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 246 #define LCD_E_PIN        1            //< pin  for Enable line
 247 #endif
 248 */
 249
 250 /* Bootmagic Lite key configuration */
 251 // #define BOOTMAGIC_LITE_ROW 0
 252 // #define BOOTMAGIC_LITE_COLUMN 0
 253
 254 //#define CONTROLLER_IS_XWHATSIT_MODEL_F_OR_WCASS_MODEL_F
 255 //#define CONTROLLER_IS_XWHATSIT_BEAMSPRING_REV_4
 256 #define CONTROLLER_IS_THROUGH_HOLE_BEAMSPRING
 257 //#define CONTROLLER_IS_THROUGH_HOLE_MODEL_F
 258
 259 #define CAPSENSE_KEYBOARD_SETTLE_TIME_US 8
 260 #define CAPSENSE_DAC_SETTLE_TIME_US 8
 261 #define CAPSENSE_HARDCODED_SAMPLE_TIME 4
 262
 263 #define CAPSENSE_CAL_ENABLED 1
 264 // #define CAPSENSE_CAL_ENABLED 0
 265 #define CAPSENSE_CAL_DEBUG 1
 266 // #define CAPSENSE_CAL_DEBUG 0
 267 #define CAPSENSE_CAL_INIT_REPS 16
 268 #define CAPSENSE_CAL_EACHKEY_REPS 16
 269 #define CAPSENSE_CAL_BINS 15
 270 #define CAPSENSE_CAL_THRESHOLD_OFFSET 120
 271
 272 #if !CAPSENSE_CAL_ENABLED
 273 #define CAPSENSE_HARDCODED_THRESHOLD 142
 274 #endif
 275
 276 // By default we set up for support of xwhatsit's solenoid driver board.
 277 // Comment out USING_SOLENOID_ENABLE_PIN if you don't have an enable pin:
 278 #define USING_SOLENOID_ENABLE_PIN D3
 279 // Change this if you are using a different pin for the solenoid:
 280 #define SOLENOID_PIN D2
 281 // If you are not using a solenoid then commend out the above, and also in rules.mk, remove "HAPTIC_ENABLE += SOLENOID"
 282 // You can also tune the following for your solenoid:
 283 //#define SOLENOID_DEFAULT_DWELL 12
 284 //#define SOLENOID_MIN_DWELL 4
 285 //#define SOLENOID_MAX_DWELL 100
 286
 287 // If the lock lights are not used, then please don't define the below pins,
 288 // or leave them set as unused pins:
 289
 290 // The following definitions are compatible with the Model F SMD controllers
 291 // from here: https://deskthority.net/viewtopic.php?f=7&t=24597 supporting the
 292 // AT lock lights header
 293 #define LED_NUM_LOCK_PIN D7
 294 #define LED_CAPS_LOCK_PIN E6
 295 #define LED_SCROLL_LOCK_PIN B6
 296
 297 // The following definitions match the lock lights as used by the original
 298 // xwhatsit firmware, but enabling all three of these is not compatible with
 299 // solenoid support
 300 //#define LED_NUM_LOCK_PIN E6
 301 //#define LED_CAPS_LOCK_PIN D2
 302 //#define LED_SCROLL_LOCK_PIN D7
 303
 304 // Uncomment below if the leds are on when the pin is driving zero:
 305 //#define LED_NUM_LOCK_ACTIVE_LOW
 306 //#define LED_CAPS_LOCK_ACTIVE_LOW
 307 //#define LED_SCROLL_LOCK_ACTIVE_LOW
 308
 309 #include "../../../post_config.h"