Split HHKB to ANSI and JP layouts and Add VIA support for each (qmk#8582

)

* VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk

* Add VIA support for HHKB JP with Hasu controller - define distinct PRODUCT_ID and set dynamic layers to 3 to fit EEPROM

* Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilation successful

* Resolve jp.h erroneous diff from git merge from master

* Resolve ansi.h diff merge

* Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/mjt/

* Moved rn42 directory up, got rid of #define HHKB_JP lines

* Update keyboards/hhkb/jp/readme.md

* Update keyboards/hhkb/jp/keymaps/via/keymap.c

* Replace with #pragma once and remove ending #endif

* Remove old style guards #define... for #pragma once

* Update keyboards/hhkb/jp/keymaps/via/rules.mk

* Update keyboards/hhkb/ansi/rules.mk

* Update keyboards/hhkb/jp/rules.mk

* Updated hhkb/ansi/readme.md compiling instructions

* VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk

* Add VIA support for HHKB JP with Hasu controller - define distinct PRODUCT_ID and set dynamic layers to 3 to fit EEPROM

* Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilation successful

* Resolve ansi.h diff merge

* Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/mjt/

* Moved rn42 directory up, got rid of #define HHKB_JP lines

* Update keyboards/hhkb/jp/readme.md

* Update keyboards/hhkb/jp/keymaps/via/keymap.c

* Replace with #pragma once and remove ending #endif

* Remove old style guards #define... for #pragma once

* Update keyboards/hhkb/jp/keymaps/via/rules.mk

* Update keyboards/hhkb/ansi/rules.mk

* Update keyboards/hhkb/jp/rules.mk

* Updated hhkb/ansi/readme.md compiling instructions

keyboards/hhkb/ansi/ansi.c

@@ -0,0 +1 @@
+#include "ansi.h"

keyboards/hhkb/ansi/ansi.h

@@ -0,0 +1,23 @@
+#pragma once
+
+#include "quantum.h"
+
+#define LAYOUT(                                                                \
+    K31, K30, K00, K10, K11, K20, K21, K40, K41, K60, K61, K70, K71, K50, K51, \
+    K32, K01, K02, K13, K12, K23, K22, K42, K43, K62, K63, K73, K72, K52,      \
+    K33, K04, K03, K14, K15, K24, K25, K45, K44, K65, K64, K74, K53,           \
+    K34, K05, K06, K07, K16, K17, K26, K46, K66, K76, K75, K55, K54,           \
+         K35, K36,           K37,                K57, K56)                     \
+                                                                               \
+{                                                                              \
+    { K00, K01, K02, K03, K04, K05, K06, K07   },                              \
+    { K10, K11, K12, K13, K14, K15, K16, K17   },                              \
+    { K20, K21, K22, K23, K24, K25, K26, KC_NO },                              \
+    { K30, K31, K32, K33, K34, K35, K36, K37   },                              \
+    { K40, K41, K42, K43, K44, K45, K46, KC_NO },                              \
+    { K50, K51, K52, K53, K54, K55, K56, K57   },                              \
+    { K60, K61, K62, K63, K64, K65, K66, KC_NO },                              \
+    { K70, K71, K72, K73, K74, K75, K76, KC_NO }                               \
+}
+
+#define LAYOUT_60_hhkb LAYOUT

keyboards/hhkb/config.h → keyboards/hhkb/ansi/config.h

@@ -15,25 +15,20 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#ifndef CONFIG_H
-#define CONFIG_H
+#pragma once
 
 #include "config_common.h"
 
 /* USB Device descriptor parameter */
-#define VENDOR_ID       0xFEED
-#define PRODUCT_ID      0xCAFE
+#define VENDOR_ID       0x4848 // HH = happy hacking
+#define PRODUCT_ID      0x0001 // ANSI HHKB
 #define DEVICE_VER      0x0104
 #define MANUFACTURER    q.m.k
 #define PRODUCT         HHKB mod
 #define DESCRIPTION     q.m.k keyboard firmware for HHKB
 
 /* key matrix size */
-#ifdef HHKB_JP
-#   define MATRIX_ROWS 16
-#else
-#   define MATRIX_ROWS 8
-#endif
+#define MATRIX_ROWS 8
 #define MATRIX_COLS 8
 
 #define TAPPING_TERM    200
@@ -107,5 +102,3 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //#define NO_ACTION_ONESHOT
 //#define NO_ACTION_MACRO
 //#define NO_ACTION_FUNCTION
-
-#endif

keyboards/hhkb/ansi/hhkb_avr.h

@@ -0,0 +1,157 @@
+#pragma once
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <avr/io.h>
+#include <avr/interrupt.h>
+#include <util/delay.h>
+
+
+// Timer resolution check
+#if (1000000/TIMER_RAW_FREQ > 20)
+#   error "Timer resolution(>20us) is not enough for HHKB matrix scan tweak on V-USB."
+#endif
+
+
+/*
+ * HHKB Matrix I/O
+ *
+ * row:     HC4051[A,B,C]  selects scan row0-7
+ * row-ext: [En0,En1] row extention for JP
+ * col:     LS145[A,B,C,D] selects scan col0-7 and enable(D)
+ * key:     on: 0/off: 1
+ * prev:    hysteresis control: assert(1) when previous key state is on
+ */
+
+
+#if defined(__AVR_ATmega32U4__)
+/*
+ * For TMK HHKB alt controller(ATMega32U4)
+ *
+ * row:     PB0-2
+ * col:     PB3-5,6
+ * key:     PD7(pull-uped)
+ * prev:    PB7
+ * power:   PD4(L:off/H:on)
+ * row-ext: PC6,7 for HHKB JP(active low)
+ */
+static inline void KEY_ENABLE(void) { (PORTB &= ~(1<<6)); }
+static inline void KEY_UNABLE(void) { (PORTB |=  (1<<6)); }
+static inline bool KEY_STATE(void) { return (PIND & (1<<7)); }
+static inline void KEY_PREV_ON(void) { (PORTB |=  (1<<7)); }
+static inline void KEY_PREV_OFF(void) { (PORTB &= ~(1<<7)); }
+#ifdef HHKB_POWER_SAVING
+static inline void KEY_POWER_ON(void) {
+    DDRB = 0xFF; PORTB = 0x40;          // change pins output
+    DDRD |= (1<<4); PORTD |= (1<<4);    // MOS FET switch on
+    /* Without this wait you will miss or get false key events. */
+    _delay_ms(5);                       // wait for powering up
+}
+static inline void KEY_POWER_OFF(void) {
+    /* input with pull-up consumes less than without it when pin is open. */
+    DDRB = 0x00; PORTB = 0xFF;          // change pins input with pull-up
+    DDRD |= (1<<4); PORTD &= ~(1<<4);   // MOS FET switch off
+}
+static inline bool KEY_POWER_STATE(void) { return PORTD & (1<<4); }
+#else
+static inline void KEY_POWER_ON(void) {}
+static inline void KEY_POWER_OFF(void) {}
+static inline bool KEY_POWER_STATE(void) { return true; }
+#endif
+static inline void KEY_INIT(void)
+{
+    /* row,col,prev: output */
+    DDRB  = 0xFF;
+    PORTB = 0x40;   // unable
+    /* key: input with pull-up */
+    DDRD  &= ~0x80;
+    PORTD |=  0x80;
+
+    KEY_UNABLE();
+    KEY_PREV_OFF();
+
+    KEY_POWER_OFF();
+}
+static inline void KEY_SELECT(uint8_t ROW, uint8_t COL)
+{
+    PORTB = (PORTB & 0xC0) | (((COL) & 0x07)<<3) | ((ROW) & 0x07);
+
+}
+
+
+#elif defined(__AVR_AT90USB1286__)
+/*
+ * For Teensy++(AT90USB1286)
+ *
+ *                          HHKB pro    HHKB pro2
+ * row:     PB0-2           (6-8)       (5-7)
+ * col:     PB3-5,6         (9-12)      (8-11)
+ * key:     PE6(pull-uped)  (4)         (3)
+ * prev:    PE7             (5)         (4)
+ *
+ * TODO: convert into 'staitc inline' function
+ */
+#define KEY_INIT()              do {    \
+    DDRB |= 0x7F;                       \
+    DDRE |=  (1<<7);                    \
+    DDRE &= ~(1<<6);                    \
+    PORTE |= (1<<6);                    \
+} while (0)
+#define KEY_SELECT(ROW, COL)    (PORTB = (PORTB & 0xC0) |       \
+                                         (((COL) & 0x07)<<3) |  \
+                                         ((ROW) & 0x07))
+#define KEY_ENABLE()            (PORTB &= ~(1<<6))
+#define KEY_UNABLE()            (PORTB |=  (1<<6))
+#define KEY_STATE()             (PINE & (1<<6))
+#define KEY_PREV_ON()           (PORTE |=  (1<<7))
+#define KEY_PREV_OFF()          (PORTE &= ~(1<<7))
+#define KEY_POWER_ON()
+#define KEY_POWER_OFF()
+#define KEY_POWER_STATE()       true
+
+
+#else
+#   error "define code for matrix scan"
+#endif
+
+
+#if 0
+// For ATMega328P with V-USB
+//
+// #elif defined(__AVR_ATmega328P__)
+// Ports for V-USB
+// key:     PB0(pull-uped)
+// prev:    PB1
+// row:     PB2-4
+// col:     PC0-2,3
+// power:   PB5(Low:on/Hi-z:off)
+#define KEY_INIT()              do {    \
+    DDRB  |= 0x3E;                      \
+    DDRB  &= ~(1<<0);                   \
+    PORTB |= 1<<0;                      \
+    DDRC  |= 0x0F;                      \
+    KEY_UNABLE();                       \
+    KEY_PREV_OFF();                     \
+} while (0)
+#define KEY_SELECT(ROW, COL)    do {    \
+    PORTB = (PORTB & 0xE3) | ((ROW) & 0x07)<<2; \
+    PORTC = (PORTC & 0xF8) | ((COL) & 0x07);    \
+} while (0)
+#define KEY_ENABLE()            (PORTC &= ~(1<<3))
+#define KEY_UNABLE()            (PORTC |=  (1<<3))
+#define KEY_STATE()             (PINB & (1<<0))
+#define KEY_PREV_ON()           (PORTB |=  (1<<1))
+#define KEY_PREV_OFF()          (PORTB &= ~(1<<1))
+// Power supply switching
+#define KEY_POWER_ON()          do {    \
+    KEY_INIT();                         \
+    PORTB &= ~(1<<5);                   \
+    _delay_ms(1);                       \
+} while (0)
+#define KEY_POWER_OFF()         do {    \
+    DDRB  &= ~0x3F;                     \
+    PORTB &= ~0x3F;                     \
+    DDRC  &= ~0x0F;                     \
+    PORTC &= ~0x0F;                     \
+} while (0)
+#endif

keyboards/hhkb/ansi/info.json

@@ -0,0 +1,73 @@
+{
+  "keyboard_name": "HHKB",
+  "url": "",
+  "maintainer": "qmk",
+  "width": 15,
+  "height": 5,
+  "layouts": {
+    "LAYOUT": {
+      "layout": [
+        { "label": "Esc", "x": 0, "y": 0 },
+        { "label": "!", "x": 1, "y": 0 },
+        { "label": "@", "x": 2, "y": 0 },
+        { "label": "#", "x": 3, "y": 0 },
+        { "label": "$", "x": 4, "y": 0 },
+        { "label": "%", "x": 5, "y": 0 },
+        { "label": "^", "x": 6, "y": 0 },
+        { "label": "&", "x": 7, "y": 0 },
+        { "label": "*", "x": 8, "y": 0 },
+        { "label": "(", "x": 9, "y": 0 },
+        { "label": ")", "x": 10, "y": 0 },
+        { "label": "_", "x": 11, "y": 0 },
+        { "label": "+", "x": 12, "y": 0 },
+        { "label": "|", "x": 13, "y": 0 },
+        { "label": "~", "x": 14, "y": 0 },
+        { "label": "Tab", "x": 0, "y": 1, "w": 1.5 },
+        { "label": "Q", "x": 1.5, "y": 1 },
+        { "label": "W", "x": 2.5, "y": 1 },
+        { "label": "E", "x": 3.5, "y": 1 },
+        { "label": "R", "x": 4.5, "y": 1 },
+        { "label": "T", "x": 5.5, "y": 1 },
+        { "label": "Y", "x": 6.5, "y": 1 },
+        { "label": "U", "x": 7.5, "y": 1 },
+        { "label": "I", "x": 8.5, "y": 1 },
+        { "label": "O", "x": 9.5, "y": 1 },
+        { "label": "P", "x": 10.5, "y": 1 },
+        { "label": "{", "x": 11.5, "y": 1 },
+        { "label": "}", "x": 12.5, "y": 1 },
+        { "label": "Delete", "x": 13.5, "y": 1, "w": 1.5 },
+        { "label": "Control", "x": 0, "y": 2, "w": 1.75 },
+        { "label": "A", "x": 1.75, "y": 2 },
+        { "label": "S", "x": 2.75, "y": 2 },
+        { "label": "D", "x": 3.75, "y": 2 },
+        { "label": "F", "x": 4.75, "y": 2 },
+        { "label": "G", "x": 5.75, "y": 2 },
+        { "label": "H", "x": 6.75, "y": 2 },
+        { "label": "J", "x": 7.75, "y": 2 },
+        { "label": "K", "x": 8.75, "y": 2 },
+        { "label": "L", "x": 9.75, "y": 2 },
+        { "label": ":", "x": 10.75, "y": 2 },
+        { "label": "\"", "x": 11.75, "y": 2 },
+        { "label": "Return", "x": 12.75, "y": 2, "w": 2.25 },
+        { "label": "Shift", "x": 0, "y": 3, "w": 2.25 },
+        { "label": "Z", "x": 2.25, "y": 3 },
+        { "label": "X", "x": 3.25, "y": 3 },
+        { "label": "C", "x": 4.25, "y": 3 },
+        { "label": "V", "x": 5.25, "y": 3 },
+        { "label": "B", "x": 6.25, "y": 3 },
+        { "label": "N", "x": 7.25, "y": 3 },
+        { "label": "M", "x": 8.25, "y": 3 },
+        { "label": "<", "x": 9.25, "y": 3 },
+        { "label": ">", "x": 10.25, "y": 3 },
+        { "label": "?", "x": 11.25, "y": 3 },
+        { "label": "Shift", "x": 12.25, "y": 3, "w": 1.75 },
+        { "label": "Fn", "x": 14, "y": 3 },
+        { "label": "", "x": 1.5, "y": 4 },
+        { "label": "", "x": 2.5, "y": 4, "w": 1.5 },
+        { "x": 4, "y": 4, "w": 6 },
+        { "label": "", "x": 10, "y": 4, "w": 1.5 },
+        { "label": "", "x": 11.5, "y": 4 }
+      ]
+    }
+  }
+}

keyboards/hhkb/keymaps/mjt/keymap.c → keyboards/hhkb/ansi/keymaps/mjt/keymap.c

@@ -17,7 +17,6 @@ enum hhkb_keycodes
     DYNAMIC_MACRO_RANGE,
 };
 
-#include "dynamic_macro.h"
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
@@ -104,7 +103,7 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 bool process_record_user(uint16_t keycode, keyrecord_t *record)
 {
     uint16_t macro_kc = (keycode == MO(DYN) ? DYN_REC_STOP : keycode);
-    if (!process_record_dynamic_macro(macro_kc, record))
+    if (!process_dynamic_macro(macro_kc, record))
     {
         return false;
     }

keyboards/hhkb/ansi/keymaps/mjt/rules.mk

@@ -0,0 +1 @@
+DYNAMIC_MACRO_ENABLE = yes

keyboards/hhkb/ansi/keymaps/via/keymap.c

@@ -0,0 +1,68 @@
+#include QMK_KEYBOARD_H
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    /* BASE Level: Default Layer
+     |-------+---+---+---+---+---+---+---+---+---+---+-------+-----+-------+---|
+     | Esc   | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | -     | =   | \     | ` |
+     |-------+---+---+---+---+---+---+---+---+---+---+-------+-----+-------+---|
+     | Tab   | Q | W | E | R | T | Y | U | I | O | P | [     | ]   | Backs |   |
+     |-------+---+---+---+---+---+---+---+---+---+---+-------+-----+-------+---|
+     | Cont  | A | S | D | F | G | H | J | K | L | ; | '     | Ent |       |   |
+     |-------+---+---+---+---+---+---+---+---+---+---+-------+-----+-------+---|
+     | Shift | Z | X | C | V | B | N | M | , | . | / | Shift | Fn0 |       |   |
+     |-------+---+---+---+---+---+---+---+---+---+---+-------+-----+-------+---|
+
+            |------+------+-----------------------+------+------|
+            | LAlt | LGUI | ******* Space ******* | RGUI | RAlt |
+            |------+------+-----------------------+------+------|
+    */
+
+    [0] = LAYOUT( //  default layer
+        KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_GRV,
+        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC,
+        KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
+        KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(1),
+        KC_LALT, KC_LGUI, /*        */ KC_SPC, KC_RGUI, KC_RALT
+    ),
+
+    /* Layer HHKB: HHKB mode (HHKB Fn)
+      |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
+      | Pwr  | F1  | F2  | F3  | F4 | F5 | F6 | F7 | F8  | F9  | F10 | F11 | F12   | Ins   | Del |
+      |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
+      | Caps |     |     |     |    |    |    |    | Psc | Slk | Pus | Up  |       | Backs |     |
+      |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
+      |      | VoD | VoU | Mut |    |    | *  | /  | Hom | PgU | Lef | Rig | Enter |       |     |
+      |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
+      |      |     |     |     |    |    | +  | -  | End | PgD | Dow |     |       |       |     |
+      |------+-----+-----+-----+----+----+----+----+-----+-----+-----+-----+-------+-------+-----|
+
+                 |------+------+----------------------+------+------+
+                 | **** | **** | ******************** | **** | **** |
+                 |------+------+----------------------+------+------+
+
+     */
+
+    [1] = LAYOUT(
+        KC_PWR, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_INS, KC_DEL,
+        KC_CAPS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PSCR, KC_SLCK, KC_PAUS, KC_UP, KC_TRNS, KC_BSPC,
+        KC_TRNS, KC_VOLD, KC_VOLU, KC_MUTE, KC_TRNS, KC_TRNS, KC_PAST, KC_PSLS, KC_HOME, KC_PGUP, KC_LEFT, KC_RGHT, KC_PENT,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PPLS, KC_PMNS, KC_END, KC_PGDN, KC_DOWN, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
+    ),
+    [2] = LAYOUT(
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
+    ),
+    [3] = LAYOUT(
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
+    )
+};

keyboards/hhkb/ansi/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes