Migrate Sandy from 0.18 to 0.22, as Jones did

[jpskenn]

Issue Description

対応方針

JonesがQMKへマージされて以降におこなわれたアップデート、つまりjpskenn以外のメンテナー等によりおこなわれたアップデートを、Sandyへ適用する。

Jonesのv1に対するアップデートを元とする。

Sandyは開発経緯によりdn0020, dn0030, v01の3バージョンのファームウェアが存在するが、それらすべてに適用する。

注意点

自宅とリモート環境からの適用作業となるが、リモート環境にはビルド環境がないため、ビルド結果を見ずにコミットする。

それらコミットは、自宅においてビルド結果を確認する。

アップデート: 対応済み

• Move RGBLight animations to data driven (Move RGBLight animations to data driven qmk/qmk_firmware#21635)

  RGBアニメをinfo.json化。
  dn0030のみ。

• jones/v1: fix layout offset and disable audio on via keymap (jones/v1: fix layout offset and disable audio on via keymap qmk/qmk_firmware#21468)

  レイアウトオフセット修正
  →Jonesのみ。対応不要

• Fix encoder map declarations (Fix encoder map declarations qmk/qmk_firmware#21435)

  エンコーダーマッピングの方向指定
  →マジックナンバーから定数へ変更

  + const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
  - const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {

• Move miscellaneous defines to data driven (Move miscellaneous defines to data driven qmk/qmk_firmware#21382)

  コメント内の古い定義は、コメントごと消す。

  /* COL2ROW, ROW2COL*/
  // No need to define DIODE_DIRECTION for Jones' custom Round-Robin matrix.
  //#define DIODE_DIRECTION COL2ROW

  SandyはCOL2ROWを使っていてinfo.json化するので、これは対象外。

• Move RGBLIGHT_HUE/SAT/VAL_STEP to data driven (Move RGBLIGHT_HUE/SAT/VAL_STEP to data driven qmk/qmk_firmware#21292)

  RGBLIGHT_HUEとかをinfo.jsonへ。
  VALはデフォルト値のため、喜寿せず。

• Remove encoder in-matrix workaround code (Remove encoder in-matrix workaround code qmk/qmk_firmware#20389)

  エンコーダーの仮想マッピングを廃止

  • config.h
    エンコーダからマトリクスの仮想定義を削除

  • info.json
    エンコーダからマトリクスの仮想定義を削除

  • keyboard.c
    エンコーダーへ割り当てた処理を削除

    • keymap.cでキーコードの仮想割り当てやめる

    -　キーマップ/rules.mk

    + ENCODER_MAP_ENABLE = yes

    • キーマップ/keymap.c
      仮想定義に割り当ててきたキーコードを削除
      encoder_mapに、エンコーダーで動作させたいキーコードを割り当て（注意：キーマップレベルでの定義）

    • VIA定義ファイル（QMK外）
      QMKには直接関係しないが、VIAとRemapがEncoder mapに対応したため、VIA V3向けの定義ファイルも作成した。
      Sandyプロジェクトにファイルを追加。

• Move RGBLED_NUM to data driven (Move RGBLED_NUM to data driven qmk/qmk_firmware#21278)

  →info.json化

• Move RGBLIGHT_SLEEP to data driven (Move RGBLIGHT_SLEEP to data driven qmk/qmk_firmware#21072)

  - // #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */

  Sandy未使用だが、rules.mkの関連記述を削除した。

• Move RGBLIGHT_LED_MAP to data driven (Move RGBLIGHT_LED_MAP to data driven qmk/qmk_firmware#21095)

  LEDマッピングしてるときのみ。
  Sandy未使用。

• Move RGBLIGHT_LIMIT_VAL to data driven (Move RGBLIGHT_LIMIT_VAL to data driven qmk/qmk_firmware#20974)

  info.json化の対象だが、defaultが255なので、あえて記述する必要なし。

• Remove use of layout macros for music_map (Remove use of layout macros for music_map qmk/qmk_firmware#20634)

  →musicでmusic_map使用の場合のみ。対応不要

• Move single LAYOUTs to data driven (Move single LAYOUTs to data driven qmk/qmk_firmware#20365)

  →info.jsonでマトリックス指定
  →v1.cでv1.hをincludeせず、QMK_KEYBOARD_Hをインクルード

  - #include "v1.h"
  + #include QMK_KEYBOARD_H

  →v1.h削除（レイアウト部分）

• Migrate rgblight.pin and RGB_DI_PIN to ws2812.pin (Migrate rgblight.pin and RGB_DI_PIN to ws2812.pin qmk/qmk_firmware#20303)

  config.hで　RGB_DI_PIN -> WS2812_DI_PIN

  -> info.jsonへ

  + "ws2812": {
  +   "pin": "B7"
  + },

• [Core] Refactor keyevent_t for 1ms timing resolution ([Core] Refactor keyevent_t for 1ms timing resolution  qmk/qmk_firmware#15847)

  →キーイベントのタイマー指定方法変更

      keyevent_t encoder_event = (keyevent_t) {
          .key = encoder_state[index] >> 1 ? encoder_cw[index] : encoder_ccw[index],
          .pressed = false,
  -       .time = (timer_read() | 1)
  +       .time = timer_read(),
  +       .type = KEY_EVENT

• Remove RGB_DI_PIN ifdefs (Remove RGB_DI_PIN ifdefs qmk/qmk_firmware#20218)

  →RGB_DI_PINについての#ifdefをやめる

  - #ifdef RGB_DI_PIN
  -
  - hogehoge
  -
  - #endif

• Remove more empty headers (Remove more empty headers qmk/qmk_firmware#20155)

  keyboard.hを#includeするだけのkeyboard.cを消す
  →Sandyはエンコーダーのマッピングに関する処理が書いてあるので、対象外。

• Fix layout macro keys with no matrix position (Fix layout macro keys with no matrix position qmk/qmk_firmware#20033)

  マトリクス定義をミスってるところの修正。
  →Sandyは大丈夫っぽい

• Move matrix config to info.json, part 1 (Move matrix config to info.json, part 1 qmk/qmk_firmware#19985)

  →マトリックスピン（MATRIX_ROW_PINSとか）をinfo.json化

• Move encoder config to data driven (Move encoder config to data driven qmk/qmk_firmware#19923)

  →エンコーダー指定をinfo.json化

• Remove matrix size defines (Remove matrix size defines qmk/qmk_firmware#19581)

  →マトリックスサイズ（MATRIX_ROWSとCOLS）の記述を削除
  →info.jsonにも記述はないが、普通にビルドOK

• Move Bootmagic config to data driven (Move Bootmagic config to data driven qmk/qmk_firmware#19860)

  →Bootmagic指定をinfo.json化
  →Sandyは使ってないはず？

• Remove unused RGBLight defines from config.h (Remove unused RGBLight defines from config.h qmk/qmk_firmware#19859)

  未使用の定義（コメントアウトしてあるもの）があれば消す。

• Migrate MCU and BOOTLOADER to data-driven (Migrate MCU and BOOTLOADER to data-driven qmk/qmk_firmware#19529)

  →MCUまわりをinfo.json化

  info.json

  +   "processor": "atmega32u4",
  +   "bootloader": "atmel-dfu",

  rules.mk

  -   # MCU name
  -   MCU = atmega32u4
  -
  -   # Bootloader selection
  -   BOOTLOADER = atmel-dfu

• Remove unused SOFT_SERIAL_PIN from config.h (Remove unused SOFT_SERIAL_PIN from config.h qmk/qmk_firmware#19768)

  →Sandy未使用

• Remove unused Bootmagic row/col defines from config.h (Remove unused Bootmagic row/col defines from config.h qmk/qmk_firmware#19761)

  →Sandy未使用

• Remove unused GRAVE_ESC_CTRL_OVERRIDE from config.h (Remove unused GRAVE_ESC_CTRL_OVERRIDE from config.h qmk/qmk_firmware#19752)

  →Sandy未使用

• Remove IS_HOST_LED_ON and migrate usages (Remove IS_HOST_LED_ON and migrate usages qmk/qmk_firmware#19753)

  →ホストのLED状態読み取りを変更。

  -    if (IS_HOST_LED_ON(USB_LED_CAPS_LOCK)) {
  +    if (host_keyboard_led_state().caps_lock) {

• Remove unused LOCKING_SUPPORT_ENABLE from config.h (Remove unused LOCKING_SUPPORT_ENABLE from config.h qmk/qmk_firmware#19748)

  →Sandy未使用

• Debounce defines cleanup (Debounce defines cleanup qmk/qmk_firmware#19742)

  →debounceの設定は消す

  - /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  - #define DEBOUNCE 5

  →25keysさんのチャタリング防止ネタは、コメントアウトで書いてるだけなので、実害はない。
  →が、どうせ使ってないので消す。

• Remove usages of config_common.h from config.h files. (Remove usages of config_common.h from config.h files. qmk/qmk_firmware#19714)

  →#include "config_common.h"削除

  作業メモ

  develop_Sandyへ、2件コミットしてしまっていた分は、家にてRevertをかけた。
  
  topic_sandy_qmk_v22_migrationブランチに切り替えて、最初（一番下）から作業やりなおし
  

• Update use of legacy keycodes (Update use of legacy keycodes qmk/qmk_firmware#19120)

  古いキーコードを更新（音楽系）
  →Sandy対応不要

• Remove legacy keycodes, part 5 (Remove legacy keycodes, part 5 qmk/qmk_firmware#18710)

  →KC_SLCK -> KC_SCRL

• Remove legacy international keycodes (Remove legacy international keycodes qmk/qmk_firmware#18588)

  →LANG1 -> LNG1, LANG2 -> LNG2

• Move keyboard USB IDs and strings to data driven: J (Move keyboard USB IDs and strings to data driven: J qmk/qmk_firmware#17837)

  →USB関連をinfo.json化。

• Rename keymap_extras headers for consistency (Rename keymap_extras headers for consistency qmk/qmk_firmware#16939)

  →日本語キーマップのヘッダファイル名変更

  -   #include "keymap_jp.h"
  +   #include "keymap_japanese.h"

  →Sandyは変更済みのkeymap_japanese.hを使用済み。

• Remove NO_ACTION_MACRO and NO_ACTION_FUNCTION from keyboard config.h

  →定義削除

  -   #define NO_ACTION_MACRO
  -   #define NO_ACTION_FUNCTION

  →Sandyに該当箇所なし。

• [keyboard]Add v1 to jones keyboard ([keyboard]Add v1 to jones keyboard qmk/qmk_firmware#14405)

  ここからはじまり

その他の確認事項

• Bootmagic関連

  rules.mkに以下の記述があるが、残しておいてもよいのか？
  削除必要？

  BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration

  →info.jsonではbootmagic, enabledのデフォルトがfalseなので、消してOK。

• Sandy固有機能

  ダイナミックマクロの引数が変更になって、ビルドでエラー。
  →引数変更に対応。