keyboards/xwhatsit/ibm/f62/wcass/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/wcass/Purdea Andrei
  27 #define PRODUCT IBM 4704 F62
  28 #define DESCRIPTION QMK firmware for the IBM 4704 F62 keyboard using the wcass model F controller PCB
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 8
  32 #define MATRIX_COLS 8
  33 // Note: there is a column that is only used for calibration pads. That one is not listed here.
  34
  35 /*
  36  * Keyboard Matrix Assignments
  37  *
  38  * Change this to how you wired your keyboard
  39  * COLS: AVR pins used for columns, left to right
  40  * ROWS: AVR pins used for rows, top to bottom
  41  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
  42  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
  43  *
  44  */
  45 //#define MATRIX_ROW_PINS { D0, D5 }
  46 //#define MATRIX_COL_PINS { B2, B1, B0 }
  47 //#define UNUSED_PINS
  48
  49 /* COL2ROW, ROW2COL*/
  50 //#define DIODE_DIRECTION COL2ROW
  51
  52 /*
  53  * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
  54  */
  55 #define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6
  56
  57 // #define BACKLIGHT_PIN B7
  58 // #define BACKLIGHT_BREATHING
  59 // #define BACKLIGHT_LEVELS 3
  60
  61 // #define RGB_DI_PIN E2
  62 // #ifdef RGB_DI_PIN
  63 //   #define RGBLED_NUM 16
  64 //   #define RGBLIGHT_HUE_STEP 8
  65 //   #define RGBLIGHT_SAT_STEP 8
  66 //   #define RGBLIGHT_VAL_STEP 8
  67 //   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
  68 //   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
  69 // /*== all animations enable ==*/
  70 //   #define RGBLIGHT_ANIMATIONS
  71 // /*== or choose animations ==*/
  72 //   #define RGBLIGHT_EFFECT_BREATHING
  73 //   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
  74 //   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
  75 //   #define RGBLIGHT_EFFECT_SNAKE
  76 //   #define RGBLIGHT_EFFECT_KNIGHT
  77 //   #define RGBLIGHT_EFFECT_CHRISTMAS
  78 //   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
  79 //   #define RGBLIGHT_EFFECT_RGB_TEST
  80 //   #define RGBLIGHT_EFFECT_ALTERNATING
  81 // /*== customize breathing effect ==*/
  82 //   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
  83 //   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
  84 //   /*==== use exp() and sin() ====*/
  85 //   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
  86 //   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
  87 // #endif
  88
  89 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  90 #define DEBOUNCE 5
  91
  92 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  93 //#define MATRIX_HAS_GHOST
  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_MASK_SHIFT)
 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
 195 /* disable these deprecated features by default */
 196 #ifndef LINK_TIME_OPTIMIZATION_ENABLE
 197   #define NO_ACTION_MACRO
 198   #define NO_ACTION_FUNCTION
 199 #endif
 200 /*
 201  * MIDI options
 202  */
 203
 204 /* Prevent use of disabled MIDI features in the keymap */
 205 //#define MIDI_ENABLE_STRICT 1
 206
 207 /* enable basic MIDI features:
 208    - MIDI notes can be sent when in Music mode is on
 209 */
 210 //#define MIDI_BASIC
 211
 212 /* enable advanced MIDI features:
 213    - MIDI notes can be added to the keymap
 214    - Octave shift and transpose
 215    - Virtual sustain, portamento, and modulation wheel
 216    - etc.
 217 */
 218 //#define MIDI_ADVANCED
 219
 220 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 221 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 222
 223 /*
 224  * HD44780 LCD Display Configuration
 225  */
 226 /*
 227 #define LCD_LINES           2     //< number of visible lines of the display
 228 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 229
 230 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 231
 232 #if LCD_IO_MODE
 233 #define LCD_PORT         PORTB        //< port for the LCD lines
 234 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 235 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 236 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 237 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 238 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 239 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 240 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 241 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 242 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 243 #define LCD_RS_PIN       3            //< pin  for RS line
 244 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 245 #define LCD_RW_PIN       2            //< pin  for RW line
 246 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 247 #define LCD_E_PIN        1            //< pin  for Enable line
 248 #endif
 249 */
 250
 251 /* Bootmagic Lite key configuration */
 252 // #define BOOTMAGIC_LITE_ROW 0
 253 // #define BOOTMAGIC_LITE_COLUMN 0
 254
 255 #define CONTROLLER_IS_XWHATSIT_MODEL_F_OR_WCASS_MODEL_F
 256 //#define CONTROLLER_IS_XWHATSIT_BEAMSPRING_REV_4
 257 //#define CONTROLLER_IS_THROUGH_HOLE_BEAMSPRING
 258 //#define CONTROLLER_IS_THROUGH_HOLE_MODEL_F
 259
 260 #define CAPSENSE_KEYBOARD_SETTLE_TIME_US 8
 261 #define CAPSENSE_DAC_SETTLE_TIME_US 8
 262 #define CAPSENSE_HARDCODED_SAMPLE_TIME 4
 263
 264 #define CAPSENSE_CAL_ENABLED 1
 265 // #define CAPSENSE_CAL_ENABLED 0
 266 #define CAPSENSE_CAL_DEBUG 1
 267 // #define CAPSENSE_CAL_DEBUG 0
 268 #define CAPSENSE_CAL_INIT_REPS 16
 269 #define CAPSENSE_CAL_EACHKEY_REPS 16
 270 #define CAPSENSE_CAL_BINS 5
 271 #define CAPSENSE_CAL_THRESHOLD_OFFSET 24
 272
 273 #if !CAPSENSE_CAL_ENABLED
 274 #define CAPSENSE_HARDCODED_THRESHOLD 142
 275 #endif
 276
 277 #define CAPSENSE_KEYMAP_COL_TO_PHYSICAL_COL(col) ((col)+2)
 278
 279 // By default we set up for support of xwhatsit's solenoid driver board.
 280 // Comment out HAPTIC_ENABLE_PIN if you don't have an enable pin:
 281 #define HAPTIC_ENABLE_PIN B7
 282 // We disable haptic feedbeck during USB low power conditions:
 283 #define HAPTIC_OFF_IN_LOW_POWER
 284 // Change this if you are using a different pin for the solenoid:
 285 #define SOLENOID_PIN B6
 286 // If you are not using a solenoid then comment out the above, and also in rules.mk, remove "HAPTIC_ENABLE += SOLENOID"
 287 // You can also tune the following for your solenoid:
 288 #define SOLENOID_DEFAULT_DWELL 4
 289 #define SOLENOID_MIN_DWELL 4
 290 //#define SOLENOID_MAX_DWELL 100
 291
 292 // If the lock lights are not used, then please don't define the below pins,
 293 // or leave them set as unused pins:
 294
 295 // The following definitions match the lock lights as used by the original
 296 // xwhatsit firmware, but enabling all three of these is not compatible with
 297 // standard solenoid support, because B6 and B7 pins are already in use:
 298 //#define LED_NUM_LOCK_PIN B5
 299 //#define LED_CAPS_LOCK_PIN B6
 300 //#define LED_SCROLL_LOCK_PIN B4
 301 // Since solenoid support is enabled by default, the above lock light pin
 302 // assignments are disabled by default.
 303 // Instead the more common Num Lock and Caps Lock are assigned the following
 304 // way by default, and this can be used in combination with the solenoid:
 305 #define LED_NUM_LOCK_PIN B4
 306 #define LED_CAPS_LOCK_PIN B5
 307
 308 // Uncomment below if the leds are on when the pin is driving zero:
 309 //#define LED_NUM_LOCK_ACTIVE_LOW
 310 //#define LED_CAPS_LOCK_ACTIVE_LOW
 311 //#define LED_SCROLL_LOCK_ACTIVE_LOW
 312
 313 #include "../../../post_config.h"