Zeal60/Zeal65/M60-A implementation (#3879)
* Initial version of zeal60
* WIP
* Fixes issue #900
* Adding RGB underglow functionality.
Fixed a compile-time conflict caused by enabling RGB underglow functionality.
* Refactor RPC protocol
* Fix last merge
* README for RGB underglow updated.
* Additional README changes.
* Adding RGBW strip software-based current-limiting functionality.
* RGBW current-limiting functionality should be handled by RGBSTRIP_MAX_CURRENT_PER_LIGHT instead.
* Updated README to reflect implementation of built-in current limiting.
* Keymap readability improvements.
* Minor keymap improvements.
* Fixed LED driver init sequence, formatting
* Dimming implementation tested, working.
* Stab LEDs synced with spacebar hits in effects.
* RGB underglow tested and functional. Simplified README for RGB underglow.
* Undid accidental file deletion from previous merge conflict. Safer values for RGB underglow.
* Improved arrow key positions in keymap.
* Added functionality to correct uneven RGB underglow. Refactored related code.
* Reverted to safer values for underglow.
* Changes for v0.3
* Custom LED brightness scaling will take place after current adjustment in order to avoid being overridden.
* Create keymap.c
Added split backspace and split shift to ISO layout
* Create config.h
Turned on LEDs for new layout
* Fixed bug where left spacebar stabilizer LED (LC06) would adopt color of row above.
* Added hhkb_wilba keymap
* Update keymap.c
* Update keymap.c
* Update keymap.c
* Added indicators, full param setting via host
* Added "mousekey" layout
* Added Zeal65 support, factory test mode
* Keycode safe range changed, caused bugs
* Bumped EEPROM version due to change in QMK keycodes
* Disable HHKB "blocked" LEDs if KC_NO in keymap
* Added "disable_hhkb_blocker_leds"
* Required overridden function for keymaps in EEPROM
* Added polar coordinate mapping, effect speed
* Force Raw HID interface number to 1 always
* Fixed last merge from master
* Added effect speed to default keymaps
* add BACKLIGHT_ prefix to vars
* add BACKLIGHT_ prefix to vars
* Keymap speed effect; keymap improvements/fixes
Readme updated to match changes
* Refactored to use common IS31FL3731/I2C drivers
* Fixed make rules, backlight disabled feature
* Make split rightshift default for Zeal65
* Added M60-A as a "version" of Zeal60.
* Renamed IS31FL3731 driver functions
* Fix suspend_wakeup_init_kb() being defined twice
* First pass refactor dynamic keymaps
* Updated to changed I2C and ISSI drivers
* Refactor zeal_color.* usage to quantum/color.*
* Updated Zeal65, fixed dynamic_keymap
* Major refactoring of Zeal60 backlight and API
* Lots of little cleanups
* Added readme.md
* Added readme.md
* Added LAYOUT_60*() macros, refactored and cleaned up default keymaps
* Fix compile error in suspend.c
* Added Zeal65 LAYOUT macros, info.json
* Added rama/m60_a, deleted zeal60/keymaps/m60_a
* Fixed rama/m60_a/keymaps/proto
* Fixed compilation error for suspend.c
* Requested changes for PR
* Fixed readme.md images
* Another readme.md fix
* Added drashna's requested changes
2018-09-13 18:37:13 +00:00
|
|
|
/* Copyright 2017 Jason Williams (Wilba)
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "config_common.h"
|
|
|
|
|
|
|
|
// USB Device descriptor parameter
|
2018-09-28 16:01:00 +00:00
|
|
|
#define VENDOR_ID 0x5241 // "RW"
|
|
|
|
#define PRODUCT_ID 0x060A // 60-A
|
Zeal60/Zeal65/M60-A implementation (#3879)
* Initial version of zeal60
* WIP
* Fixes issue #900
* Adding RGB underglow functionality.
Fixed a compile-time conflict caused by enabling RGB underglow functionality.
* Refactor RPC protocol
* Fix last merge
* README for RGB underglow updated.
* Additional README changes.
* Adding RGBW strip software-based current-limiting functionality.
* RGBW current-limiting functionality should be handled by RGBSTRIP_MAX_CURRENT_PER_LIGHT instead.
* Updated README to reflect implementation of built-in current limiting.
* Keymap readability improvements.
* Minor keymap improvements.
* Fixed LED driver init sequence, formatting
* Dimming implementation tested, working.
* Stab LEDs synced with spacebar hits in effects.
* RGB underglow tested and functional. Simplified README for RGB underglow.
* Undid accidental file deletion from previous merge conflict. Safer values for RGB underglow.
* Improved arrow key positions in keymap.
* Added functionality to correct uneven RGB underglow. Refactored related code.
* Reverted to safer values for underglow.
* Changes for v0.3
* Custom LED brightness scaling will take place after current adjustment in order to avoid being overridden.
* Create keymap.c
Added split backspace and split shift to ISO layout
* Create config.h
Turned on LEDs for new layout
* Fixed bug where left spacebar stabilizer LED (LC06) would adopt color of row above.
* Added hhkb_wilba keymap
* Update keymap.c
* Update keymap.c
* Update keymap.c
* Added indicators, full param setting via host
* Added "mousekey" layout
* Added Zeal65 support, factory test mode
* Keycode safe range changed, caused bugs
* Bumped EEPROM version due to change in QMK keycodes
* Disable HHKB "blocked" LEDs if KC_NO in keymap
* Added "disable_hhkb_blocker_leds"
* Required overridden function for keymaps in EEPROM
* Added polar coordinate mapping, effect speed
* Force Raw HID interface number to 1 always
* Fixed last merge from master
* Added effect speed to default keymaps
* add BACKLIGHT_ prefix to vars
* add BACKLIGHT_ prefix to vars
* Keymap speed effect; keymap improvements/fixes
Readme updated to match changes
* Refactored to use common IS31FL3731/I2C drivers
* Fixed make rules, backlight disabled feature
* Make split rightshift default for Zeal65
* Added M60-A as a "version" of Zeal60.
* Renamed IS31FL3731 driver functions
* Fix suspend_wakeup_init_kb() being defined twice
* First pass refactor dynamic keymaps
* Updated to changed I2C and ISSI drivers
* Refactor zeal_color.* usage to quantum/color.*
* Updated Zeal65, fixed dynamic_keymap
* Major refactoring of Zeal60 backlight and API
* Lots of little cleanups
* Added readme.md
* Added readme.md
* Added LAYOUT_60*() macros, refactored and cleaned up default keymaps
* Fix compile error in suspend.c
* Added Zeal65 LAYOUT macros, info.json
* Added rama/m60_a, deleted zeal60/keymaps/m60_a
* Fixed rama/m60_a/keymaps/proto
* Fixed compilation error for suspend.c
* Requested changes for PR
* Fixed readme.md images
* Another readme.md fix
* Added drashna's requested changes
2018-09-13 18:37:13 +00:00
|
|
|
#define DEVICE_VER 0x0001
|
|
|
|
#define MANUFACTURER RAMA.WORKS
|
|
|
|
#define PRODUCT RAMA M60-A
|
|
|
|
#define DESCRIPTION RAMA M60-A Keyboard
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// key matrix size
|
|
|
|
#define MATRIX_ROWS 5
|
|
|
|
#define MATRIX_COLS 14
|
|
|
|
|
|
|
|
// Zeal60 PCB default pin-out
|
|
|
|
#define MATRIX_ROW_PINS { F0, F1, F4, F6, F7 }
|
|
|
|
#define MATRIX_COL_PINS { F5, D5, B1, B2, B3, D3, D2, C7, C6, B6, B5, B4, D7, D6 }
|
|
|
|
#define UNUSED_PINS
|
|
|
|
|
|
|
|
// IS31FL3731 driver
|
|
|
|
#define DRIVER_COUNT 2
|
|
|
|
#define DRIVER_LED_TOTAL 72
|
|
|
|
|
|
|
|
// COL2ROW or ROW2COL
|
|
|
|
#define DIODE_DIRECTION COL2ROW
|
|
|
|
|
|
|
|
// Set 0 if debouncing isn't needed
|
|
|
|
#define DEBOUNCING_DELAY 5
|
|
|
|
|
|
|
|
// Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
|
|
|
|
#define LOCKING_SUPPORT_ENABLE
|
|
|
|
// Locking resynchronize hack
|
|
|
|
#define LOCKING_RESYNC_ENABLE
|
|
|
|
|
|
|
|
// key combination for command
|
|
|
|
#define IS_COMMAND() ( \
|
|
|
|
keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
|
|
|
|
)
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Feature disable options
|
|
|
|
* These options are also useful to firmware size reduction.
|
|
|
|
*/
|
|
|
|
|
|
|
|
// disable debug print
|
|
|
|
//#define NO_DEBUG
|
|
|
|
|
|
|
|
// disable print
|
|
|
|
//#define NO_PRINT
|
|
|
|
|
|
|
|
// disable action features
|
|
|
|
//#define NO_ACTION_LAYER
|
|
|
|
//#define NO_ACTION_TAPPING
|
|
|
|
//#define NO_ACTION_ONESHOT
|
|
|
|
//#define NO_ACTION_MACRO
|
|
|
|
//#define NO_ACTION_FUNCTION
|
|
|
|
|
|
|
|
#define RGB_BACKLIGHT_ENABLED 1
|
|
|
|
|
|
|
|
// This conditionally compiles the backlight code for M60-A specifics
|
|
|
|
#define RGB_BACKLIGHT_M60_A
|
|
|
|
|
|
|
|
// enable/disable LEDs based on layout
|
|
|
|
// they aren't really used if RGB_BACKLIGHT_M60_A defined
|
|
|
|
#define RGB_BACKLIGHT_USE_SPLIT_BACKSPACE 1
|
|
|
|
#define RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT 0
|
|
|
|
#define RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT 1
|
|
|
|
#define RGB_BACKLIGHT_USE_7U_SPACEBAR 1
|
|
|
|
#define RGB_BACKLIGHT_USE_ISO_ENTER 0
|
|
|
|
#define RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS 1
|
|
|
|
|
|
|
|
// disable backlight when USB suspended (PC sleep/hibernate/shutdown)
|
|
|
|
#define RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED 0
|
|
|
|
|
|
|
|
// disable backlight after timeout in minutes, 0 = no timeout
|
|
|
|
#define RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT 0
|
|
|
|
|
|
|
|
// the default effect (RGB test)
|
|
|
|
#define RGB_BACKLIGHT_EFFECT 255
|
|
|
|
|
|
|
|
// These define which keys in the matrix are alphas/mods
|
|
|
|
// Used for backlight effects so colors are different for
|
|
|
|
// alphas vs. mods
|
|
|
|
// Each value is for a row, bit 0 is column 0
|
|
|
|
// Alpha=0 Mod=1
|
|
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_0 0b0000000000000001
|
|
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_1 0b0010000000000001
|
|
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_2 0b0011000000000001
|
|
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_3 0b0011000000000001
|
|
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 0b0011100000000111
|
|
|
|
|
|
|
|
#define DYNAMIC_KEYMAP_LAYER_COUNT 4
|
|
|
|
|
|
|
|
// EEPROM usage
|
|
|
|
|
|
|
|
// TODO: refactor with new user EEPROM code (coming soon)
|
|
|
|
#define EEPROM_MAGIC 0x451F
|
|
|
|
#define EEPROM_MAGIC_ADDR 32
|
|
|
|
// Bump this every time we change what we store
|
|
|
|
// This will automatically reset the EEPROM with defaults
|
|
|
|
// and avoid loading invalid data from the EEPROM
|
|
|
|
#define EEPROM_VERSION 0x07
|
|
|
|
#define EEPROM_VERSION_ADDR 34
|
|
|
|
|
|
|
|
// Backlight config starts after EEPROM version
|
|
|
|
#define RGB_BACKLIGHT_CONFIG_EEPROM_ADDR 35
|
|
|
|
// Dynamic keymap starts after backlight config (35+37)
|
|
|
|
#define DYNAMIC_KEYMAP_EEPROM_ADDR 72
|
|
|
|
|