[Keyboard] add treeadstone48 (#5405)

* Keyboard: add treeadstone48

* rename layout defines

* Use of pragma once

* move common include code

* fixed info.json

* change keymap layout from kc to normal

* fix alpha revision keymap

* fixed info.json

* remove USE_Link_Time_Optimization

keyboards/treadstone48/keymaps/default/config.h

@@ -0,0 +1,60 @@
+/*
+This is the c configuration file for the keymap
+
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+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
+
+// place overrides here
+
+#ifdef TAPPING_TERM
+#undef TAPPING_TERM
+#endif
+#define TAPPING_TERM 225
+// #define PREVENT_STUCK_MODIFIERS
+// #define IGNORE_MOD_TAP_INTERRUPT
+
+#ifdef MOUSEKEY_ENABLE
+  #undef MOUSEKEY_INTERVAL
+  #define MOUSEKEY_INTERVAL 1
+
+  #undef MOUSEKEY_TIME_TO_MAX
+  #define MOUSEKEY_TIME_TO_MAX 150
+
+  #undef MOUSEKEY_MAX_SPEED
+  #define MOUSEKEY_MAX_SPEED 3
+
+  #undef MOUSEKEY_MOVE_DELTA
+  #define MOUSEKEY_MOVE_DELTA 4
+
+  #undef MOUSEKEY_DELAY
+  #define MOUSEKEY_DELAY 0
+#endif
+
+// Selection of RGBLIGHT MODE to use.
+#if defined(LED_ANIMATIONS)
+   //#define RGBLIGHT_EFFECT_BREATHING
+   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+   //#define RGBLIGHT_EFFECT_SNAKE
+   #define RGBLIGHT_EFFECT_KNIGHT
+   //#define RGBLIGHT_EFFECT_CHRISTMAS
+   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+   //#define RGBLIGHT_EFFECT_RGB_TEST
+   //#define RGBLIGHT_EFFECT_ALTERNATING
+#endif

keyboards/treadstone48/keymaps/default/keymap.c

@@ -0,0 +1,278 @@
+#include QMK_KEYBOARD_H
+#include "keymap_jp.h"
+#include "../common/oled_helper.h"
+
+extern keymap_config_t keymap_config;
+
+#ifdef RGBLIGHT_ENABLE
+//Following line allows macro to read current RGB settings
+extern rgblight_config_t rgblight_config;
+#endif
+
+extern uint8_t is_master;
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum layer_number {
+  _BASE = 0,
+  _LOWER,
+  _RAISE,
+  _ADJUST,
+};
+
+enum custom_keycodes {
+  LOWER = SAFE_RANGE,
+  RAISE,
+  ADJUST,
+  KANJI,
+  RGBRST
+};
+
+enum tapdances{
+  TD_SCCL = 0,
+  TD_SLRO,
+};
+
+// Layer Mode aliases
+#define _____ KC_TRNS
+#define XXXXX KC_NO
+
+#define KC_TBSF  LSFT_T(KC_TAB)
+// #define KC_SPSF  LSFT_T(KC_SPC)
+#define KC_ALAP  LALT_T(KC_APP)
+#define KC_JEQL  LSFT(KC_MINS)
+
+#define KC_SCCL  TD(TD_SCCL)
+#define KC_SLRO  TD(TD_SLRO)
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [TD_SCCL] = ACTION_TAP_DANCE_DOUBLE(KC_SCLN, KC_QUOT),
+  [TD_SLRO] = ACTION_TAP_DANCE_DOUBLE(KC_SLSH, KC_RO),
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT_base( \
+  //,--------------------------------------------------------------------------------------------------------------------.
+       KC_ESC,    KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,          KC_MINS,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+-----------------|
+      KC_TBSF,    KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L, KC_SCCL,           KC_ENT,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+      KC_LSFT,    KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M, KC_COMM,  KC_DOT, KC_SLRO,   KC_UP,         \
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+     KC_LCTRL, KC_LALT, KC_LGUI,   LOWER,          KC_BSPC,           KC_SPC,   RAISE, KC_ALAP, KC_LEFT, KC_DOWN, KC_RGHT,\
+  //`-------------------------------------------------------------------------------------------------------------------'
+       KC_DEL \
+  // ExtraKey: Split backspace key or it is below the enter key.
+  ),
+
+  [_LOWER] = LAYOUT_base( \
+  //,--------------------------------------------------------------------------------------------------------------------.
+        _____,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5, KC_MINS,  KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,           KC_DEL,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+-----------------|
+        _____,   KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,   XXXXX,   XXXXX,   XXXXX, KC_SCLN, KC_QUOT,            _____,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+        _____,  KC_F11,  KC_F12,   XXXXX,   KANJI,  KC_ENT,   XXXXX,   XXXXX, KC_COMM,  KC_DOT,  KC_GRV, KC_PGUP,         \
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+        _____,   _____,   _____,   _____,           KC_DEL,            _____,   _____,   XXXXX, KC_HOME, KC_PGDN,  KC_END,\
+  //`-------------------------------------------------------------------------------------------------------------------'
+      XXXXX \
+  // ExtraKey: Split backspace key or it is below the enter key.
+  ),
+
+  [_RAISE] = LAYOUT_base( \
+  //,--------------------------------------------------------------------------------------------------------------------.
+        _____,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,            XXXXX,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+-----------------|
+        _____,   XXXXX,   XXXXX,   XXXXX,   XXXXX,   XXXXX,   XXXXX,    KC_4,    KC_5,    KC_6, KC_QUOT,            _____,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+        _____,   XXXXX,   XXXXX,   XXXXX,   XXXXX,   XXXXX,   XXXXX,    KC_1,    KC_2,    KC_3,   KC_RO,   XXXXX,         \
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+        _____,   _____,   _____,   _____,            _____,            _____,   _____,    KC_0,  KC_DOT, KC_COMM, KC_SLSH,\
+  //`-------------------------------------------------------------------------------------------------------------------'
+      XXXXX \
+  // ExtraKey: Split backspace key or it is below the enter key.
+  ),
+
+  [_ADJUST] = LAYOUT_base( \
+  //,--------------------------------------------------------------------------------------------------------------------.
+        XXXXX,   RESET,  RGBRST, AG_NORM, AG_SWAP,   XXXXX,   XXXXX, KC_WH_L, KC_WH_U, KC_HOME, KC_PGUP,            XXXXX,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+-----------------|
+        XXXXX, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI,   XXXXX,   XXXXX, KC_WH_R, KC_WH_D,  KC_END, KC_PGDN,            XXXXX,\
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+        _____, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD,   XXXXX,   XXXXX,   XXXXX, KC_BTN1, KC_BTN2,   XXXXX, KC_MS_U,         \
+  //|--------+--------+--------+--------+--------+--------|--------+--------+--------+--------+--------+--------+--------|
+        _____,   _____,   _____,   _____,            XXXXX,            XXXXX,   _____,   XXXXX, KC_MS_L, KC_MS_D, KC_MS_R,\
+  //`-------------------------------------------------------------------------------------------------------------------'
+      XXXXX \
+  // ExtraKey: Split backspace key or it is below the enter key.
+  )
+};
+
+#define L_BASE _BASE
+#define L_LOWER (1<<_LOWER)
+#define L_RAISE (1<<_RAISE)
+#define L_ADJUST (1<<_ADJUST)
+#define L_ADJUST_TRI (L_ADJUST|L_RAISE|L_LOWER)
+
+#ifdef SSD1306OLED
+typedef struct {
+  uint8_t state;
+  char name[8];
+}LAYER_DISPLAY_NAME;
+
+#define LAYER_DISPLAY_MAX 5
+const LAYER_DISPLAY_NAME layer_display_name[LAYER_DISPLAY_MAX] = {
+  {L_BASE, "Base"},
+  {L_BASE + 1, "Base"},
+  {L_LOWER, "Lower"},
+  {L_RAISE, "Raise"},
+  {L_ADJUST_TRI, "Adjust"}
+};
+
+static inline const char* get_leyer_status(void) {
+
+  for (uint8_t i = 0; i < LAYER_DISPLAY_MAX; ++i) {
+    if (layer_state == 0 && layer_display_name[i].state == default_layer_state) {
+
+      return layer_display_name[i].name;
+    } else if (layer_state != 0 && layer_display_name[i].state == layer_state) {
+
+      return layer_display_name[i].name;
+    }
+  }
+
+  return "?";
+}
+
+static char layer_status_buf[24] = "Layer state ready.\n";
+static inline void update_keymap_status(void) {
+
+  snprintf(layer_status_buf, sizeof(layer_status_buf) - 1, "OS:%s Layer:%s\n",
+    keymap_config.swap_lalt_lgui? "win" : "mac", get_leyer_status());
+}
+
+static inline void render_keymap_status(struct CharacterMatrix *matrix) {
+
+  matrix_write(matrix, layer_status_buf);
+}
+
+#define UPDATE_KEYMAP_STATUS() update_keymap_status()
+#define RENDER_KEYMAP_STATUS(a) render_keymap_status(a)
+
+#else
+
+#define UPDATE_KEYMAP_STATUS()
+#define RENDER_KEYMAP_STATUS(a)
+
+#endif
+
+static inline void update_change_layer(bool pressed, uint8_t layer1, uint8_t layer2, uint8_t layer3) {
+
+  pressed ? layer_on(layer1) : layer_off(layer1);
+  IS_LAYER_ON(layer1) && IS_LAYER_ON(layer2) ? layer_on(layer3) : layer_off(layer3);
+}
+
+int RGB_current_mode;
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+
+  UPDATE_KEY_STATUS(keycode, record);
+
+  bool result = false;
+  switch (keycode) {
+    case LOWER:
+      update_change_layer(record->event.pressed, _LOWER, _RAISE, _ADJUST);
+      break;
+    case RAISE:
+      update_change_layer(record->event.pressed, _RAISE, _LOWER, _ADJUST);
+        break;
+    case KANJI:
+      if (record->event.pressed) {
+        if (keymap_config.swap_lalt_lgui == false) {
+          register_code(KC_LANG2);
+        } else {
+          SEND_STRING(SS_LALT("`"));
+        }
+      } else {
+        unregister_code(KC_LANG2);
+      }
+      break;
+    #ifdef RGBLIGHT_ENABLE
+      case RGB_MOD:
+          if (record->event.pressed) {
+            rgblight_mode(RGB_current_mode);
+            rgblight_step();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+      case RGBRST:
+          if (record->event.pressed) {
+            eeconfig_update_rgblight_default();
+            rgblight_enable();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+    #endif
+    default:
+      result = true;
+      break;
+  }
+
+  UPDATE_KEYMAP_STATUS();
+  return result;
+}
+
+void matrix_init_user(void) {
+  #ifdef RGBLIGHT_ENABLE
+    RGB_current_mode = rgblight_config.mode;
+  #endif
+  //SSD1306 OLED init, make sure to add #define SSD1306OLED in config.h
+  #ifdef SSD1306OLED
+    iota_gfx_init(!has_usb()); // turns on the display
+  #endif
+}
+
+//SSD1306 OLED update loop, make sure to add #define SSD1306OLED in config.h
+#ifdef SSD1306OLED
+
+void matrix_scan_user(void) {
+  iota_gfx_task();  // this is what updates the display continuously
+}
+
+static inline void matrix_update(struct CharacterMatrix *dest,
+                          const struct CharacterMatrix *source) {
+  if (memcmp(dest->display, source->display, sizeof(dest->display))) {
+    memcpy(dest->display, source->display, sizeof(dest->display));
+    dest->dirty = true;
+  }
+}
+
+static inline void render_status(struct CharacterMatrix *matrix) {
+
+  UPDATE_LED_STATUS();
+  RENDER_LED_STATUS(matrix);
+  RENDER_KEYMAP_STATUS(matrix);
+  UPDATE_LOCK_STATUS();
+  RENDER_LOCK_STATUS(matrix);
+  RENDER_KEY_STATUS(matrix);
+}
+
+void iota_gfx_task_user(void) {
+  struct CharacterMatrix matrix;
+
+  #if DEBUG_TO_SCREEN
+    if (debug_enable) {
+      return;
+    }
+  #endif
+
+  matrix_clear(&matrix);
+  if (is_master) {
+    render_status(&matrix);
+  }
+
+  matrix_update(&display, &matrix);
+}
+
+#endif

keyboards/treadstone48/keymaps/default/readme.md

@@ -0,0 +1,5 @@
+# Default keymap for treadstone48
+
+## Description
+
+## How to use

keyboards/treadstone48/keymaps/default/readme_jp.md

@@ -0,0 +1,80 @@
+# US配列ライクデフォルトキーマップ
+
+## 概要
+
+　US配列ライクなデフォルトキーマップです。  
+
+## キーマップの見かた
+
+qmk_firmware\tmk_core\common\keycode.h  
+に基本的なキーコードがあります。また、Keymap.cの上部にカスタムしたKC_で始まるものを登録しています。  
+キーマップに書くときは「KC_」を省略して書いています。
+例：KC_A → A  
+
+Leyer Tap、Mod Tap、Tap DanceというQMKの機能を使っています。  
+
+Layer Tapはタップで指定したキー、長押しで指定したレイヤーに移動します。  
+例：LT(RAISE, KC_V) → タップでV、長押しでRAISEレイヤー移動
+
+Mod Tapはタップで視程したキー、長押しで視程したレイヤーに移動します。  
+例：LSFT_T(KC_Z) → タップでZ、長押しで左シフト
+
+Tap Danceは指定した二つのキーをシングルタップ、ダブルタップで切り替えられます。  
+例：[TD_CODO] = ACTION_TAP_DANCE_DOUBLE(KC_COMM, KC_DOT) → シングルタップでCOMM、ダブルタップでDOT
+
+もう少し詳しい内容についてはQMK Documentをお読みいただくかネットを検索すれば情報が載っていますので別途検索してみてください。  
+
+## 機能
+
+　QWERTYキーマップをベースにしていて、LowerレイヤーとRaiseレイヤーに他のキーを配置しています。  
+　LowerとRaiseを同時押しでAdjustレイヤーを使うことが出来ます。  
+　DOTの横、SLROと書いてあるのはシングルタップで/記号、ダブルタップで\記号が入力出来るようになっています。
+　Lの横、SCCLと書いてあるのはシングルタップで;記号、ダブルタップで:記号が入力出来るようになっています。
+　マウスキーの割り当てがありますので、もし使用したい場合はrules.mkでMOUSEKEY_ENABLE = yesにしてmakeすると使用することができます。  
+
+## 48キー目について
+
+　このキーボードはEnterキーの上の2Uキーを1Ux2個にして使用する事が出来るようになっています。  使用する場合はキーマップの書き換えが必要です。  
+
+　各レイヤーの最下段の
+
+```c
+      XXXXX \
+  // ExtraKey: Split backspace key or it is below the enter key.
+```
+
+　のXXXXXに任意のキーを入れることでPの右隣のキーとして動作するようになっています。その右隣りに従来のキーが配置されています。  
+
+## OS切り替え方法
+
+　Adjustレイヤーにあります。LowerとRaiseを同時押しでAdjustレイヤーを使うことが出来ます。  
+
+- KNRM: QMKのノーマル状態です。macだと正常に使える（はず）です
+- KSWP: ノーマル状態のままWindowsで使用するとALTキーとGUI（win）キーが逆ですので、それを入れ換えます。Windowsユーザーはこちらのモードにしてください
+
+## NUMPADモードについて
+
+　Lower + DLNPキーを一度押下するとNumpadモードになります。通常モードに戻す場合はDLBSキーを押下してください。  
+
+## IME切り替え方法
+
+　Winの場合、LowerレイヤーにKANJIキー（半角/全角　漢字）がありますので、Lower+KANJIで切り替えてください。  
+
+## ソフトウェアリセットについて
+
+　キーボードにはハードウェアのリセットボタンが付いていますが、ソフトウェアリセットをかけられます。  
+　LowerとRaiseを同時押しでAdjustレイヤーを使うことが出来、AdjustレイヤーのRESETを押下するとリセットがかかります。  
+
+## LEDの点灯切り替え方法
+
+　Adjustレイヤーにあります。LowerとRaiseを同時押しでAdjustレイヤーを使うことが出来ます。  
+
+- RGBRST: LEDのリセット
+- RGB_TOG: LEDのON/OFF切り替え
+- RGB_MOD: LEDの光り方の変更
+- RGB_HUI: Hue+ 色合いを変更
+- RGB_HUD: Hue- 色合いを変更
+- RGB_SAI: Saturation+ 色の濃さを変更
+- RGB_SAD: Saturation- 色の濃さを変更
+- RGB_VAI: Value+ 明るさを変更
+- RGB_VAD: Value- 明るさを変更

keyboards/treadstone48/keymaps/default/rules.mk

@@ -0,0 +1,67 @@
+
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE =  no       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = no        # Audio control and System control(+450)
+CONSOLE_ENABLE = no         # Console for debug(+400)
+COMMAND_ENABLE = no         # Commands for debug and configuration
+NKRO_ENABLE = no            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = no           # Audio output on port C6
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+SWAP_HANDS_ENABLE = no      # Enable one-hand typing
+TAP_DANCE_ENABLE = yes
+
+# If your custom treadstone48 pcb, you can rewrite to yes.
+OLED_ENABLE = no            # OLED_ENABLE
+LED_UNDERGLOW_ENABLE = yes  # LED underglow (Enable WS2812 RGB underlight.)
+LED_ANIMATIONS = yes        # LED animations
+
+# Other selectable option
+IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
+LOCAL_GLCDFONT = no         # use each keymaps "font.h" insted of "common/glcdfont.c"
+# RHYMESTONE_RIGHTHAND = no   # If connect right hand side of the Rhymestone, set to yes.
+ANGELINA_KEYMAP = no        # If Alfa verstion use set to yes.
+
+ifeq ($(strip $(OLED_ENABLE)), yes)
+    OPT_DEFS += -DOLED_ENABLE
+endif
+
+ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
+  RGBLIGHT_ENABLE = yes
+else
+  RGBLIGHT_ENABLE = no
+endif
+
+ifeq ($(strip $(LED_ANIMATIONS)), yes)
+    # OPT_DEFS += -DRGBLIGHT_ANIMATIONS
+    OPT_DEFS += -DLED_ANIMATIONS
+endif
+
+ifeq ($(strip $(IOS_DEVICE_ENABLE)), yes)
+    OPT_DEFS += -DIOS_DEVICE_ENABLE
+endif
+
+ifeq ($(strip $(LOCAL_GLCDFONT)), yes)
+    OPT_DEFS += -DLOCAL_GLCDFONT
+endif
+
+# ifeq ($(strip $(RHYMESTONE_RIGHTHAND)), yes)
+#     OPT_DEFS += -DRHYMESTONE_RIGHTHAND
+# endif
+
+ifeq ($(strip $(ANGELINA_KEYMAP)), yes)
+    OPT_DEFS += -DANGELINA_KEYMAP
+endif
+
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+# If you want to change the display of OLED, you need to change here
+SRC +=  ./common/oled_helper.c \