Change Lufa-MS size (#13183)

Co-authored-by: Drashna Jaelre <drashna@live.com>

.vscode/settings.json

@@ -22,5 +22,6 @@
     "[markdown]": {
         "editor.trimAutoWhitespace": false,
         "files.trimTrailingWhitespace": false
-    }
+    },
+    "python.formatting.provider": "yapf"
 }

bin/qmk

@@ -35,6 +35,7 @@ def main():
     print('Warning: The bin/qmk script is being deprecated. Please install the QMK CLI: python3 -m pip install qmk', file=sys.stderr)
 
     # Import the subcommands
+    import milc.subcommand.config  # noqa
     import qmk.cli  # noqa
 
     # Execute

bootloader.mk

@@ -90,12 +90,16 @@ ifeq ($(strip $(BOOTLOADER)), USBasp)
 endif
 ifeq ($(strip $(BOOTLOADER)), lufa-ms)
     OPT_DEFS += -DBOOTLOADER_MS
-    BOOTLOADER_SIZE = 6144
+    BOOTLOADER_SIZE ?= 8192
     FIRMWARE_FORMAT = bin
-    $(info LUFA MASS STORAGE Bootloader selected)
-    $(info DO NOT USE THIS BOOTLOADER IN NEW PROJECTS!)
-    $(info It is extremely prone to bricking, and is only included to support existing boards.)
-    $(info )
+cpfirmware: lufa_warning
+.INTERMEDIATE: lufa_warning
+lufa_warning: $(FIRMWARE_FORMAT)
+	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
+	$(info LUFA MASS STORAGE Bootloader selected)
+	$(info DO NOT USE THIS BOOTLOADER IN NEW PROJECTS!)
+	$(info It is extremely prone to bricking, and is only included to support existing boards.)
+	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
 endif
 ifdef BOOTLOADER_SIZE
     OPT_DEFS += -DBOOTLOADER_SIZE=$(strip $(BOOTLOADER_SIZE))

docs/_summary.md

@@ -108,6 +108,7 @@
     * [Haptic Feedback](feature_haptic_feedback.md)
     * [Joystick](feature_joystick.md)
     * [LED Indicators](feature_led_indicators.md)
+    * [MIDI](feature_midi.md)
     * [Proton C Conversion](proton_c_conversion.md)
     * [PS/2 Mouse](feature_ps2_mouse.md)
     * [Split Keyboard](feature_split_keyboard.md)

docs/feature_audio.md

@@ -301,8 +301,7 @@ You can configure the default, min and max frequencies, the stepping and built i
 
 ## MIDI Functionality
 
-This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile.
-
+See [MIDI](feature_midi.md)
 
 ## Audio Keycodes
 
@@ -319,114 +318,3 @@ This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to s
 |`MU_OFF`        |         |Turns off Music Mode              |
 |`MU_TOG`        |         |Toggles Music Mode                |
 |`MU_MOD`        |         |Cycles through the music modes    |
-
-<!-- FIXME: this formatting needs work
-
-## Audio
-
-```c
-#ifdef AUDIO_ENABLE
-    AU_ON,
-    AU_OFF,
-    AU_TOG,
-
-    // Music mode on/off/toggle
-    MU_ON,
-    MU_OFF,
-    MU_TOG,
-
-    // Music voice iterate
-    MUV_IN,
-    MUV_DE,
-#endif
-```
-
-### Midi
-
-#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
-    MI_ON,  // send midi notes when music mode is enabled
-    MI_OFF, // don't send midi notes when music mode is enabled
-#endif
-
-MIDI_TONE_MIN,
-MIDI_TONE_MAX
-
-MI_C = MIDI_TONE_MIN,
-MI_Cs,
-MI_Db = MI_Cs,
-MI_D,
-MI_Ds,
-MI_Eb = MI_Ds,
-MI_E,
-MI_F,
-MI_Fs,
-MI_Gb = MI_Fs,
-MI_G,
-MI_Gs,
-MI_Ab = MI_Gs,
-MI_A,
-MI_As,
-MI_Bb = MI_As,
-MI_B,
-
-MIDI_TONE_KEYCODE_OCTAVES > 1
-
-where x = 1-5:
-MI_C_x,
-MI_Cs_x,
-MI_Db_x = MI_Cs_x,
-MI_D_x,
-MI_Ds_x,
-MI_Eb_x = MI_Ds_x,
-MI_E_x,
-MI_F_x,
-MI_Fs_x,
-MI_Gb_x = MI_Fs_x,
-MI_G_x,
-MI_Gs_x,
-MI_Ab_x = MI_Gs_x,
-MI_A_x,
-MI_As_x,
-MI_Bb_x = MI_As_x,
-MI_B_x,
-
-MI_OCT_Nx 1-2
-MI_OCT_x 0-7
-MIDI_OCTAVE_MIN = MI_OCT_N2,
-MIDI_OCTAVE_MAX = MI_OCT_7,
-MI_OCTD, // octave down
-MI_OCTU, // octave up
-
-MI_TRNS_Nx 1-6
-MI_TRNS_x 0-6
-MIDI_TRANSPOSE_MIN = MI_TRNS_N6,
-MIDI_TRANSPOSE_MAX = MI_TRNS_6,
-MI_TRNSD, // transpose down
-MI_TRNSU, // transpose up
-
-MI_VEL_x 1-10
-MIDI_VELOCITY_MIN = MI_VEL_1,
-MIDI_VELOCITY_MAX = MI_VEL_9,
-MI_VELD, // velocity down
-MI_VELU, // velocity up
-
-MI_CHx 1-16
-MIDI_CHANNEL_MIN = MI_CH1
-MIDI_CHANNEL_MAX = MI_CH16,
-MI_CHD, // previous channel
-MI_CHU, // next channel
-
-MI_ALLOFF, // all notes off
-
-MI_SUS, // sustain
-MI_PORT, // portamento
-MI_SOST, // sostenuto
-MI_SOFT, // soft pedal
-MI_LEG,  // legato
-
-MI_MOD, // modulation
-MI_MODSD, // decrease modulation speed
-MI_MODSU, // increase modulation speed
-#endif // MIDI_ADVANCED
-
--->

docs/feature_midi.md

@@ -0,0 +1,260 @@
+# MIDI
+
+## Usage
+
+First, enable MIDI by adding the following to your `rules.mk`:
+
+```makefile
+MIDI_ENABLE = yes
+```
+
+There are two MIDI systems in QMK: basic and advanced. With basic MIDI you will only be able to send Note On and Note Off messages using the note keycodes, meaning that keycodes like `MI_OCTU` and `MI_OCTD` will not work. Advanced MIDI allows you to do things like octave shifts, channel changes, velocity changes, modulation, and more.
+
+### Basic MIDI
+
+To enable basic MIDI, add the following to your `config.h`:
+
+```c
+#define MIDI_BASIC
+```
+
+### Advanced MIDI
+
+To enable advanced MIDI, add the following to your `config.h`:
+
+```c
+#define MIDI_ADVANCED
+```
+
+#### Sending Control Change (CC) Messages
+
+If you're aiming to emulate the features of something like a Launchpad or other MIDI controller you'll need to access the internal MIDI device directly.
+
+Because there are so many possible CC messages, not all of them are implemented as keycodes. Additionally, you might need to provide more than just two values that you would get from a keycode (pressed and released) - for example, the analog values from a fader or a potentiometer. So, you will need to implement [custom keycodes](feature_macros.md) if you want to use them in your keymap directly using `process_record_user()`.
+
+
+For reference of all the possible control code numbers see [MIDI Specification](#midi-specification)
+
+#### Example code for using Generic On Off Switches as per MIDI Specification.
+```c
+#include QMK_KEYBOARD_H
+
+extern MidiDevice midi_device;
+
+// MIDI CC codes for generic on/off switches (80, 81, 82, 83)
+// Off: 0-63
+// On:  64-127
+
+#define MIDI_CC_OFF 0
+#define MIDI_CC_ON  127
+
+enum custom_keycodes {
+    MIDI_CC80 = SAFE_RANGE,
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case MIDI_CC80:
+            if (record->event.pressed) {
+                midi_send_cc(&midi_device, midi_config.channel, 80, ON);
+            } else {
+                midi_send_cc(&midi_device, midi_config.channel, 80, OFF);
+            }
+            return true;
+    }
+    return true;
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    LAYOUT(
+        // ...
+        MIDI_CC80,
+        // ...
+    )
+};
+```
+
+### Keycodes
+
+|Keycode     |Aliases  |Description                      |
+|------------|---------|---------------------------------|
+|`MI_ON`     |         |Turn MIDI on                     |
+|`MI_OFF`    |         |Turn MIDI off                    |
+|`MI_TOG`    |         |Toggle MIDI enabled              |
+|`MI_C`      |         |C octave 0                       |
+|`MI_Cs`     |`MI_Db`  |C♯/D♭ octave 0                   |
+|`MI_D`      |         |D octave 0                       |
+|`MI_Ds`     |`MI_Eb`  |D♯/E♭ octave 0                   |
+|`MI_E`      |         |E octave 0                       |
+|`MI_F`      |         |F octave 0                       |
+|`MI_Fs`     |`MI_Gb`  |F♯/G♭ octave 0                   |
+|`MI_G`      |         |G octave 0                       |
+|`MI_Gs`     |`MI_Gs`  |G♯/A♭ octave 0                   |
+|`MI_A`      |         |A octave 0                       |
+|`MI_As`     |`MI_Bb`  |A♯/B♭ octave 0                   |
+|`MI_B`      |         |B octave 0                       |
+|`MI_C_1`    |         |C octave 1                       |
+|`MI_Cs_1`   |`MI_Db_1`|C♯/D♭ octave 1                   |
+|`MI_D_1`    |         |D octave 1                       |
+|`MI_Ds_1`   |`MI_Eb_1`|D♯/E♭ octave 1                   |
+|`MI_E_1`    |         |E octave 1                       |
+|`MI_F_1`    |         |F octave 1                       |
+|`MI_Fs_1`   |`MI_Gb_1`|F♯/G♭ octave 1                   |
+|`MI_G_1`    |         |G octave 1                       |
+|`MI_Gs_1`   |`MI_Ab_1`|G♯/A♭ octave 1                   |
+|`MI_A_1`    |         |A octave 1                       |
+|`MI_As_1`   |`MI_Bb_1`|A♯/B♭ octave 1                   |
+|`MI_B_1`    |         |B octave 1                       |
+|`MI_C_2`    |         |C octave 2                       |
+|`MI_Cs_2`   |`MI_Db_2`|C♯/D♭ octave 2                   |
+|`MI_D_2`    |         |D octave 2                       |
+|`MI_Ds_2`   |`MI_Eb_2`|D♯/E♭ octave 2                   |
+|`MI_E_2`    |         |E octave 2                       |
+|`MI_F_2`    |         |F octave 2                       |
+|`MI_Fs_2`   |`MI_Gb_2`|F♯/G♭ octave 2                   |
+|`MI_G_2`    |         |G octave 2                       |
+|`MI_Gs_2`   |`MI_Ab_2`|G♯/A♭ octave 2                   |
+|`MI_A_2`    |         |A octave 2                       |
+|`MI_As_2`   |`MI_Bb_2`|A♯/B♭ octave 2                   |
+|`MI_B_2`    |         |B octave 2                       |
+|`MI_C_3`    |         |C octave 3                       |
+|`MI_Cs_3`   |`MI_Db_3`|C♯/D♭ octave 3                   |
+|`MI_D_3`    |         |D octave 3                       |
+|`MI_Ds_3`   |`MI_Eb_3`|D♯/E♭ octave 3                   |
+|`MI_E_3`    |         |E octave 3                       |
+|`MI_F_3`    |         |F octave 3                       |
+|`MI_Fs_3`   |`MI_Gb_3`|F♯/G♭ octave 3                   |
+|`MI_G_3`    |         |G octave 3                       |
+|`MI_Gs_3`   |`MI_Ab_3`|G♯/A♭ octave 3                   |
+|`MI_A_3`    |         |A octave 3                       |
+|`MI_As_3`   |`MI_Bb_3`|A♯/B♭ octave 3                   |
+|`MI_B_3`    |         |B octave 3                       |
+|`MI_C_4`    |         |C octave 4                       |
+|`MI_Cs_4`   |`MI_Db_4`|C♯/D♭ octave 4                   |
+|`MI_D_4`    |         |D octave 4                       |
+|`MI_Ds_4`   |`MI_Eb_4`|D♯/E♭ octave 4                   |
+|`MI_E_4`    |         |E octave 4                       |
+|`MI_F_4`    |         |F octave 4                       |
+|`MI_Fs_4`   |`MI_Gb_4`|F♯/G♭ octave 4                   |
+|`MI_G_4`    |         |G octave 4                       |
+|`MI_Gs_4`   |`MI_Ab_4`|G♯/A♭ octave 4                   |
+|`MI_A_4`    |         |A octave 4                       |
+|`MI_As_4`   |`MI_Bb_4`|A♯/B♭ octave 4                   |
+|`MI_B_4`    |         |B octave 4                       |
+|`MI_C_5`    |         |C octave 5                       |
+|`MI_Cs_5`   |`MI_Db_5`|C♯/D♭ octave 5                   |
+|`MI_D_5`    |         |D octave 5                       |
+|`MI_Ds_5`   |`MI_Eb_5`|D♯/E♭ octave 5                   |
+|`MI_E_5`    |         |E octave 5                       |
+|`MI_F_5`    |         |F octave 5                       |
+|`MI_Fs_5`   |`MI_Gb_5`|F♯/G♭ octave 5                   |
+|`MI_G_5`    |         |G octave 5                       |
+|`MI_Gs_5`   |`MI_Ab_5`|G♯/A♭ octave 5                   |
+|`MI_A_5`    |         |A octave 5                       |
+|`MI_As_5`   |`MI_Bb_5`|A♯/B♭ octave 5                   |
+|`MI_B_5`    |         |B octave 5                       |
+|`MI_OCT_N2` |         |Set octave to -2                 |
+|`MI_OCT_N1` |         |Set octave to -1                 |
+|`MI_OCT_0`  |         |Set octave to 0                  |
+|`MI_OCT_1`  |         |Set octave to 1                  |
+|`MI_OCT_2`  |         |Set octave to 2                  |
+|`MI_OCT_3`  |         |Set octave to 3                  |
+|`MI_OCT_4`  |         |Set octave to 4                  |
+|`MI_OCT_5`  |         |Set octave to 5                  |
+|`MI_OCT_6`  |         |Set octave to 6                  |
+|`MI_OCT_7`  |         |Set octave to 7                  |
+|`MI_OCTD`   |         |Move down an octave              |
+|`MI_OCTU`   |         |Move up an octave                |
+|`MI_TRNS_N6`|         |Set transposition to -6 semitones|
+|`MI_TRNS_N5`|         |Set transposition to -5 semitones|
+|`MI_TRNS_N4`|         |Set transposition to -4 semitones|
+|`MI_TRNS_N3`|         |Set transposition to -3 semitones|
+|`MI_TRNS_N2`|         |Set transposition to -2 semitones|
+|`MI_TRNS_N1`|         |Set transposition to -1 semitone |
+|`MI_TRNS_0` |         |No transposition                 |
+|`MI_TRNS_1` |         |Set transposition to +1 semitone |
+|`MI_TRNS_2` |         |Set transposition to +2 semitones|
+|`MI_TRNS_3` |         |Set transposition to +3 semitones|
+|`MI_TRNS_4` |         |Set transposition to +4 semitones|
+|`MI_TRNS_5` |         |Set transposition to +5 semitones|
+|`MI_TRNS_6` |         |Set transposition to +6 semitones|
+|`MI_TRNSD`  |         |Decrease transposition           |
+|`MI_TRNSU`  |         |Increase transposition           |
+|`MI_VEL_0`  |         |Set velocity to 0                |
+|`MI_VEL_1`  |         |Set velocity to 12               |
+|`MI_VEL_2`  |         |Set velocity to 25               |
+|`MI_VEL_3`  |         |Set velocity to 38               |
+|`MI_VEL_4`  |         |Set velocity to 51               |
+|`MI_VEL_5`  |         |Set velocity to 64               |
+|`MI_VEL_6`  |         |Set velocity to 76               |
+|`MI_VEL_7`  |         |Set velocity to 89               |
+|`MI_VEL_8`  |         |Set velocity to 102              |
+|`MI_VEL_9`  |         |Set velocity to 114              |
+|`MI_VEL_10` |         |Set velocity to 127              |
+|`MI_VELD`   |         |Decrease velocity                |
+|`MI_VELU`   |         |Increase velocity                |
+|`MI_CH1`    |         |Set channel to 1                 |
+|`MI_CH2`    |         |Set channel to 2                 |
+|`MI_CH3`    |         |Set channel to 3                 |
+|`MI_CH4`    |         |Set channel to 4                 |
+|`MI_CH5`    |         |Set channel to 5                 |
+|`MI_CH6`    |         |Set channel to 6                 |
+|`MI_CH7`    |         |Set channel to 7                 |
+|`MI_CH8`    |         |Set channel to 8                 |
+|`MI_CH9`    |         |Set channel to 9                 |
+|`MI_CH10`   |         |Set channel to 10                |
+|`MI_CH11`   |         |Set channel to 11                |
+|`MI_CH12`   |         |Set channel to 12                |
+|`MI_CH13`   |         |Set channel to 13                |
+|`MI_CH14`   |         |Set channel to 14                |
+|`MI_CH15`   |         |Set channel to 15                |
+|`MI_CH16`   |         |Set channel to 16                |
+|`MI_CHD`    |         |Decrease channel                 |
+|`MI_CHU`    |         |Increase channel                 |
+|`MI_ALLOFF` |         |Stop all notes                   |
+|`MI_SUS`    |         |Sustain                          |
+|`MI_PORT`   |         |Portmento                        |
+|`MI_SOST`   |         |Sostenuto                        |
+|`MI_SOFT`   |         |Soft Pedal                       |
+|`MI_LEG`    |         |Legato                           |
+|`MI_MOD`    |         |Modulation                       |
+|`MI_MODSD`  |         |Decrease modulation speed        |
+|`MI_MODSU`  |         |Increase modulation speed        |
+|`MI_BENDD`  |         |Bend pitch down                  |
+|`MI_BENDU`  |         |Bend pitch up                    |
+
+### Configuration
+
+Certain values are stored in the `midi_config` struct. This configuration is not persisted to EEPROM. By default, these values are:
+
+|Configuration      |Value|Comments                 |
+|-------------------|-----|-------------------------|
+|Octave             |`4`  |Corresponds to `MI_OCT_2`|
+|Transposition      |`0`  |                         |
+|Velocity           |`127`|                         |
+|Channel            |`0`  |                         |
+|Modulation Interval|`8`  |                         |
+
+For the above, the `MI_C` keycode will produce a C3 (note number 48), and so on.
+
+### References
+#### MIDI Specification
+
+ * [MIDI.org](https://www.midi.org/specifications-old/item/table-1-summary-of-midi-message)
+ * [CMU MIDI Programmer's Reference](https://www.cs.cmu.edu/~music/cmsip/readings/MIDI%20tutorial%20for%20programmers.html)
+#### QMK C Files
+
+ * `quantum/process_keycode/process_midi.c`
+ * `quantum/quantum_keycodes.h`
+ * `tmk_core/protocol/midi.h`
+ * `tmk_core/protocol/midi.c`
+ * `tmk_core/protocol/qmk_midi.c`
+ * `tmk_core/protocol/midi_device.h`
+
+<!--
+#### QMK Internals (Autogenerated)
+ 
+ * [Internals/MIDI Device Setup Process](internals_midi_device_setup_process.md)
+ * [Internals/MIDI Device](internals_midi_device.md)
+ * [Internals/MIDI Util](internals_midi_util.md)
+-->

docs/feature_split_keyboard.md

@@ -60,6 +60,7 @@ The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and D0/D1/D2/D3 (aka
 The 4 wires of the TRRS cable need to connect GND, VCC, and SCL and SDA (aka PD0/pin 3 and PD1/pin 2, respectively) between the two Pro Micros. 
 
 The pull-up resistors may be placed on either half. If you wish to use the halves independently, it is also possible to use 4 resistors and have the pull-ups in both halves.
+Note that the total resistance for the connected system should be within spec at 2.2k-10kOhm, with an 'ideal' at 4.7kOhm, regardless of the placement and number.
 
 <img alt="sk-i2c-connection-mono" src="https://user-images.githubusercontent.com/2170248/92297182-92b98580-ef77-11ea-9d7d-d6033914af43.JPG" width="50%"/>
 

docs/ja/_summary.md

@@ -155,6 +155,7 @@
     * [QMK への貢献](ja/contributing.md)
     * [QMK ドキュメントの翻訳](ja/translating.md)
     * [設定オプション](ja/config_options.md)
+    * [データ駆動型コンフィギュレーション](ja/data_driven_config.md)
     * [Make ドキュメント](ja/getting_started_make_guide.md)
     * [ドキュメント ベストプラクティス](ja/documentation_best_practices.md)
     * [ドキュメント テンプレート](ja/documentation_templates.md)

docs/ja/custom_quantum_functions.md

@@ -1,8 +1,8 @@
 # キーボードの挙動をカスタマイズする方法
 
 <!---
-  original document: 0.10.52:docs/custom_quantum_functions.md
-  git diff 0.10.52 HEAD -- docs/custom_quantum_functions.md | cat
+  original document: 0.12.41:docs/custom_quantum_functions.md
+  git diff 0.12.41 HEAD -- docs/custom_quantum_functions.md | cat
 -->
 
 多くの人にとって、カスタムキーボードはボタンの押下をコンピュータに送信するだけではありません。単純なボタンの押下やマクロよりも複雑なことを実行できるようにしたいでしょう。QMK にはコードを挿入したり、機能を上書きしたり、様々な状況でキーボードの挙動をカスタマイズできるフックがあります。
@@ -190,6 +190,14 @@ void keyboard_post_init_user(void) {
 
 カスタムマトリックススキャンコードが必要な場合は、この関数を使う必要があります。また、カスタムステータス出力 (LED あるいはディスプレイなど)や、ユーザが入力していない場合でも定期的にトリガーするその他の機能のために使うことができます。
 
+# キーボードハウスキーピング :id=keyboard-housekeeping
+
+* キーボード/リビジョン: `void housekeeping_task_kb(void)`
+* キーマップ: `void housekeeping_task_user(void)`
+
+この関数は、全ての QMK 処理の最後に、次の繰り返しを開始する前に呼び出されます。`housekeeping_task_*` の関数が呼び出された時点で、QMK が最後のマトリックススキャンを処理したと、安全に見なすことができます -- レイヤーの状態が更新され、USB レポートが送信され、LED が更新され、表示が描画されています。
+
+`matrix_scan_*` と同様に、これらは MCU が処理できる頻度で呼び出されます。キーボードの応答性を維持するために、これらの関数の呼び出し中にできるだけ何もしないことをお勧めします。実際に何か特別なものを実装する必要がある場合に動作を停止させる可能性があります。
 
 # キーボードアイドリング/ウェイクコード
 

docs/ja/data_driven_config.md

@@ -0,0 +1,123 @@
+# データ駆動型コンフィギュレーション
+
+<!---
+  grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
+  original document: 0.12.7:docs/data_driven_config.md
+  git diff 0.12.7 HEAD -- docs/data_driven_config.md | cat
+-->
+
+このページでは、QMK のデータ駆動型 JSON コンフィギュレーションシステムがどのように動作するかを説明します。これは、QMK 自体に取り組みたい開発者を対象としています。
+
+## ヒストリー
+
+これまで、QMK は、`rules.mk` と `config.h` の2つのメカニズムを組み合わせてコンフィギュレーションされてきました。
+この方法は、QMK がほんの一握りのキーボードをサポートしていたときは上手く機能していましたが、今では、サポートするキーボードは1500近くまで成長しました。
+`keyboards` の下だけで6000個の設定ファイルがあることが推定されます。
+これらのファイルの自由形式の性質と、重複を避けるために人々が使用してきたユニークなパターンが継続的なメンテナンスを困難にしており、また、多くのキーボードが時代遅れで時には理解が難しいパターンに従っています。
+
+また、CLI に慣れていない人に QMK のパワーを提供することにも取り組んでおり、VIA などの他のプロジェクトでは、プログラムをインストールするのと同じくらい簡単に QMK を使用できるように取り組んでいます。
+これらのツールには、ユーザーが QMK を最大限に活用できるように、キーボードのレイアウト方法や使用可能なピンと機能に関する情報が必要です。
+その第一歩として `info.json` を導入しました。
+QMK API は、これら3つの情報源（`config.h`、` rules.mk`、および `info.json`）を、エンドユーザーツールが使用できる信頼できる単一の情報源に結合するための取り組みです。
+
+これで、`info.json`から `rules.mk` と `config.h` の値を生成することがサポートされ、信頼できる単一の情報源を持つことができます。
+これにより、自動化されたツールを使用してキーボードを保守できるため、時間と保守作業を大幅に節約できます。
+
+## 概要
+
+C 側では何も変わりません。
+新しいルールを作成したり、定義したりする必要がある場合は、同じプロセスに従います。
+
+1. `docs/config_options.md` に追加します。
+1. 適切なコアファイルにデフォルトを設定します。
+1. 必要に応じて ifdef 文を追加します。
+
+次に、新しい構成のサポートを `info.json` に追加する必要があります。
+基本的なプロセスは次のとおりです。
+
+1. `data/schemas/keyboards.jsonschema` のスキーマに追加します
+1. `data/maps` にマッピングを追加します
+1. （オプションおよび非推奨）構成を抽出/生成するコードを追加します。
+   * `lib/python/qmk/info.py`
+   * `lib/python/qmk/cli/generate/config_h.py`
+   * `lib/python/qmk/cli/generate/rules_mk.py`
+
+## info.json にオプションを追加する
+
+このセクションでは、info.json に `config.h`/`rules.mk` の値のサポートを追加することについて説明します。
+
+### スキーマに追加する
+
+QMK では、[jsonschema](https:json-schema.org) のファイルを `data/schemas` に保持しています。
+キーボード固有の `info.json` ファイルに入る値は `keyboard.jsonschema` に保持されています。
+エンドユーザーが編集できるようにしたい値はすべてここに入れなければなりません。
+
+場合によっては、新しいトップレベルキーを追加するだけで済みます。
+従うべきいくつかの例は、 `keyboard_name`、`maintainer`、 `processor`、および `url` です。
+これは、オプションが自己完結型で、他のオプションと直接関係がない場合に適しています。
+
+その他の場合、1つの `object` の中に、似ているオプションを集める必要があります。
+これは、機能のサポートを追加する場合に特に当てはまります。
+このために従うべきいくつかの例は、`indicators`、`matrix_pins`、および `rgblight` です。
+新しいオプションを統合する方法がわからない場合は、[問題を開く](https://github.com/qmk/qmk_firmware/issues/new?assignees=&labels=cli%2C+python&template=other_issues.md&title=)か、[Discord で #cli に参加](https://discord.gg/heQPAgy)して、そこで会話を始めてください。
+
+### マッピングを追加する
+
+ほとんどの場合、単純なマッピングを追加することができます。
+これらは `data/mappings/info_config.json` と `data/mappings/info_rules.json` に JSON ファイルとして保持され、それぞれ `config.h` と `rules.mk` のマッピングを制御します。
+各マッピングは `config.h` または `rules.mk` 変数名をキーとし、値は以下のキーを持つハッシュです。
+
+* `info_key`: (必須）この値の `info.json` 内の場所。 下記参照。
+* `value_type`: (オプション）デフォルトは `str`。 この変数の値の形式。 下記参照。
+* `to_json`: (オプション）デフォルトは `true`。 このマッピングを info.json から除外するには、`false` に設定します
+* `to_c`: (オプション）デフォルトは `true`。 このマッピングを config.h から除外するには、`false` に設定します
+* `warn_duplicate`: (オプション）デフォルトは `true`。 値が両方の場所に存在する場合に警告をオフにするには、`false` に設定します
+
+#### Info Key
+
+info.json 内の変数をアドレス指定するために JSON ドット表記を使用します。
+たとえば、`info_json["rgblight"]["split_count"]` にアクセスするには、`rgblight.split_count` を指定します。
+これにより、深くネストされたキーを単純な文字列でアドレス指定できます。
+
+内部では [Dotty Dict](https://dotty-dict.readthedocs.io/en/latest/) を使用しています。これらの文字列がオブジェクトアクセスに変換される方法についてはそのドキュメントを参照してください。
+
+#### Value Types
+
+デフォルトでは、すべての値を単純な文字列として扱います。
+値がより複雑な場合は、次のいずれかのタイプを使用してデータをインテリジェントに解析できます。
+
+* `array`: 文字列のコンマ区切りの配列
+* `array.int`: 整数のコンマ区切り配列
+* `int`: 整数
+* `hex`: 16進数としてフォーマットされた数値
+* `list`: 文字列のスペース区切りの配列
+* `mapping`: キーと値のペアのハッシュ
+
+### 抽出するコードを追加する
+
+ほとんどのユースケースは、上記のマッピングファイルによって解決できます。
+できない場合は、代わりに設定値を抽出するコードを書くことができます。
+
+QMK が完全な `info.json` を生成するときはいつでも、`config.h` と `rules.mk` から情報を抽出します。
+あなたの新しい設定値のためのコードを `lib/python/qmk/info.py` に追加する必要があります。
+通常、これは、新しい `_extract_<feature>()` 関数を追加してから、 `_extract_config_h()` または `_extract_rules_mk()` のいずれかで関数を呼び出すことを意味します。
+
+このファイルの編集方法がわからない場合、または Python に慣れていない場合は、[issue を開く](https://github.com/qmk/qmk_firmware/issues/new?assignees=&labels=cli%2C+python&template=other_issues.md&title=）か [Discord で #cli に参加](https://discord.gg/heQPAgy)すると、この部分を誰かが手伝ってくれるでしょう。
+
+### 生成するコードを追加する
+
+パズルの最後のピースは、ビルドシステムに新しいオプションを提供することです。
+これは、2つのファイルを生成することによって行われます。
+
+* `.build/obj_<keyboard>/src/info_config.h`
+* `.build/obj_<keyboard>/src/rules.mk`
+
+この2つのファイルは、次のコードによって生成されます。
+
+* `lib/python/qmk/cli/generate/config_h.py`
+* `lib/python/qmk/cli/generate/rules_mk.py`
+
+`config.h`値の場合、ルール用の関数を記述し、その関数を `generate_config_h()` で呼び出す必要があります。
+
+`rules.mk` の新しいトップレベルの `info.json` キーがある場合は、`lib/python/qmk/cli/generate/rules_mk.py` の上部にある `info_to_rules` にキーを追加するだけです。
+それ以外の場合は、`generate_rules_mk()` で機能の新しい if ブロックを作成する必要があります。

docs/ja/feature_layers.md

@@ -1,8 +1,8 @@
 # レイヤー :id=layers
 
 <!---
-  original document: 0.9.43:docs/feature_layers.md
-  git diff 0.9.43 HEAD -- docs/feature_layers.md | cat
+  original document: 0.12.41:docs/feature_layers.md
+  git diff 0.12.41 HEAD -- docs/feature_layers.md | cat
 -->
 
 QMK ファームウェアの最も強力で良く使われている機能の一つは、レイヤーを使う機能です。ほとんどの人にとって、これはラップトップやタブレットキーボードにあるのと同じように、様々なキーを可能にするファンクションキーに相当します。
@@ -24,12 +24,10 @@ QMK ファームウェアの最も強力で良く使われている機能の一
 
 ### 注意事項 :id=caveats
 
-現在のところ、`LT()` と `MT()` は[基本的なキーコードセット](ja/keycodes_basic.md)に制限されています。つまり、`LCTL()`、`KC_TILD` あるいは `0xFF` より大きなキーコードを使うことができません。特に、`LT` と `MT` のような二重の機能キーは16ビットキーコードを使います。4ビットは機能の識別のために使われ、次の12ビットはパラメータに分かれます。レイヤータップはレイヤーに4ビットを使います(実はレイヤータップがレイヤー 0-15 に制限されている理由です)。モッドタップも同じですが、識別子に4ビット、モッドのために4ビットが使われ、全体でキーコードに8ビットを使います。このため、使用されるキーコードは `0xFF` (0-255) に制限され、基本的なキーコードのみです。
+現在のところ、`LT()` の `layer` 引数はレイヤー 0-15 に制限され、`kc` 引数は[基本的なキーコードセット](ja/keycodes_basic.md)に制限されています。つまり、`LCTL()`、`KC_TILD` あるいは `0xFF` より大きなキーコードを使うことができません。これは、QMK が16ビットのキーコードを使うためです。4ビットは機能の識別のために使われ、4ビットはレイヤーのために使われ、キーコードには8ビットしか残されていません。
 
 これを拡張してもせいぜい複雑になるだけでしょう。32ビットキーコードに移行すると、これの多くが解決されますが、キーマップマトリックスが使用する領域が2倍になります。また、問題が起きる可能性もあります。タップしたキーコードにモディファイアを適用する必要がある場合は、[タップダンス](ja/feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys)を使うことができます。
 
-さらに、モッドタップあるいはレイヤータップで少なくとも1つの右手用のモディファイアが指定された場合、指定された全てのモディファイアが右手用になるため、2つをうまく組み合わせて一致させることはできません。
-
 ## レイヤーとの連携 :id=working-with-layers
 
 レイヤーを切り替える時は注意してください。(キーボードを取り外さずに)そのレイヤーを非アクティブにすることができずレイヤーから移動できなくなる可能性があります。最も一般的な問題を避けるためのガイドラインを作成しました。

docs/ja/feature_pointing_device.md

@@ -1,8 +1,8 @@
 # ポインティングデバイス :id=pointing-device
 
 <!---
-  original document: 0.9.43:docs/feature_pointing_device.md
-  git diff 0.9.43 HEAD -- docs/feature_pointing_device.md | cat
+  original document: 0.12.41:docs/feature_pointing_device.md
+  git diff 0.12.41 HEAD -- docs/feature_pointing_device.md | cat
 -->
 
 ポインティングデバイスは汎用的な機能の総称です: システムポインタを移動します。マウスキーのような他のオプションも確かにありますが、これは簡単に変更可能で軽量であることを目指しています。機能を制御するためにカスタムキーを実装したり、他の周辺機器から情報を収集してここに直接挿入したりできます - QMK に処理を任せてください。
@@ -24,7 +24,7 @@ report_mouse_t (ここでは "mouseReport") が以下のプロパティを持つ
 * `mouseReport.y` - これは、y軸の動き(+ 上へ、- 下へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
 * `mouseReport.v` - これは、垂直スクロール(+ 上へ、- 下へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
 * `mouseReport.h` - これは、水平スクロール(+ 右へ、- 左へ)を表す -127 から 127 (128ではなく、USB HID 仕様で定義されています)の符号付き整数です。
-* `mouseReport.buttons` - これは uint8_t で、上位の5ビットを使っています。これらのビットはマウスボタンの状態を表します - ビット 3 はマウスボタン 5、ビット 7 はマウスボタン 1 です。
+* `mouseReport.buttons` - これは uint8_t で、8ビット全てを使っています。これらのビットはマウスボタンの状態を表します - ビット 0 はマウスボタン 1、ビット 7 はマウスボタン 8 です。
 
 マウスレポートに必要な変更を行ったら、それを送信する必要があります:
 
@@ -32,6 +32,10 @@ report_mouse_t (ここでは "mouseReport") が以下のプロパティを持つ
 
 マウスレポートが送信されると、x、y、v、h のいずれの値も 0 に設定されます (これは `pointing_device_send()` で行われます。この挙動を回避するためにオーバーライドすることができます)。このように、ボタンの状態は持続しますが、動きは1度だけ起こります。さらにカスタマイズするために、`pointing_device_init` と `pointing_device_task` のどちらもオーバーライドすることができます。
 
+さらに、デフォルトでは、`pointing_device_send()` はレポートが実際に変更された場合のみレポートを送信します。これにより、マウスレポートが継続的に送信されてホストシステムが起動されたままになることを防ぎます。この動作は、独自の `pointing_device_send()` 関数を作成することで変更できます。
+
+また、`has_mouse_report_changed(new, old)` 関数を使って、レポートが変更されたかどうかを確認できます。(訳注：独自の `pointing_device_send()` 関数を作成する場合でも、その中で `has_mouse_report_changed(new, old)` 関数でチェックして、デフォルトの `pointing_device_send()` と類似の無駄なレポートの抑制をして、ホストシステムがスリープ状態に入れる余地を残すようにしておくのが良いでしょう。)
+
 以下の例では、カスタムキーを使ってマウスをクリックし垂直および水平方向に127単位スクロールし、リリースされた時にそれを全て元に戻します - なぜならこれは完全に便利な機能だからです。いいですか、以下はひとつの例です:
 
 ```c

docs/ja/feature_rawhid.md

@@ -1,8 +1,8 @@
 # Raw HID
 
 <!---
-  original document: 0.10.47:docs/feature_rawhid.md
-  git diff 0.10.47 HEAD -- docs/feature_rawhid.md | cat
+  original document: 0.12.41:docs/feature_rawhid.md
+  git diff 0.12.41 HEAD -- docs/feature_rawhid.md | cat
 -->
 
 Raw HID は、HID インタフェースを介して QMK とホストコンピュータ間の双方向通信を可能にします。これには、キーマップをその場で切り替えたり、RGB LED の色とモードを変更したりなど、多くの潜在的な使用方法があります。
@@ -34,7 +34,7 @@ void raw_hid_receive(uint8_t *data, uint8_t length) {
 }
 ```
 
-`raw_hid_receive` はホストから最大長 `RAW_EPSIZE` の可変サイズのパケットを受信することができます。一方、`raw_hid_send` はパケットを厳密に `RAW_EPSIZE` の長さで送信するため、長さ `RAW_EPSIZE` のデータを使う必要があります。
+これら2つの関数は、ホストとの間で長さ `RAW_EPSIZE` バイトのパケットを送受信します (LUFA/ChibiOS/V-USB では 32、ATSAM では 64)。
 
 ホスト側での作業を進める前に、raw 対応のファームウェアを書き込むようにしてください。
 

docs/ja/hardware_avr.md

@@ -2,8 +2,8 @@
 
 <!---
   grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
-  original document: 0.10.33:docs/hardware_avr.md
-  git diff 0.10.33 HEAD -- docs/hardware_avr.md | cat
+  original document: 0.12.41:docs/hardware_avr.md
+  git diff 0.12.41 HEAD -- docs/hardware_avr.md | cat
 -->
 
 このページでは QMK における AVR マイコンのサポートについて説明します。AVR マイコンには、Atmel 社製の atmega32u4、atmega32u2、at90usb1286 やその他のマイコンを含みます。AVR マイコンは、簡単に動かせるよう設計された8ビットの MCU です。キーボードでよく使用される AVR マイコンには USB 機能や大きなキーボードマトリックスのためのたくさんの GPIO を搭載しています。これらは、現在、キーボードで使われる最も一般的な MCU です。
@@ -83,7 +83,7 @@ or open the directory in your favourite text editor.
 #define PRODUCT         my_awesome_keyboard
 ```
 
-?> Windows や macOS では、`MANUFACTURER` と `PRODUCT` が USBデバイスのリストに表示されます。Linux 上の `lsusb` では、代わりにデフォルトで [USB ID Repository](http://www.linux-usb.org/usb-ids.html) によって維持されているリストからこれらを取得します。`lsusb -v` を使用するとデバイスから示された値を表示します。また、接続したときのカーネルログにも表示されます。
+?> Windows や macOS では、`MANUFACTURER` と `PRODUCT` が USBデバイスのリストに表示されます。Linux 上の `lsusb` では、代わりに [USB ID Repository](http://www.linux-usb.org/usb-ids.html) によって維持されているリストの値を優先します。デフォルトでは、リストに `VENDOR_ID` / `PRODUCT_ID` を含まない場合にのみ、`MANUFACTURER` と `PRODUCT` を使います。`sudo lsusb -v` を使用するとデバイスから示された値を表示します。また、接続したときのカーネルログにも表示されます。
 
 ### キーボードマトリックスの設定
 

docs/ja/mod_tap.md

@@ -1,8 +1,8 @@
 # モッドタップ
 
 <!---
-  original document: 0.9.34:docs/mod_tap.md
-  git diff 0.9.34 HEAD -- docs/mod_tap.md | cat
+  original document: 0.10.36:docs/mod_tap.md
+  git diff 0.10.36 HEAD -- docs/mod_tap.md | cat
 -->
 
 モッドタップキー `MT(mod, kc)` は、押したままの時にモディファイアのように機能し、タップされた時に通常のキーのように振舞います。別の言い方をすると、タップした時に Escape を送信しますが、押したままの時に Control あるいは Shift キーとして機能するキーを持つことができます。
@@ -32,23 +32,26 @@ MT(MOD_LCTL | MOD_LSFT, KC_ESC)
 
 便利なように、QMK はキーマップで一般的な組み合わせをよりコンパクトにするためのモッドタップショートカットを含んでいます:
 
-| キー         | エイリアス                  | 説明                                                        |
-|--------------|-----------------------------|-------------------------------------------------------------|
-| `LCTL_T(kc)` | `CTL_T(kc)`                 | 押したままの場合は左 Control、タップした場合は `kc`         |
-| `LSFT_T(kc)` | `SFT_T(kc)`                 | 押したままの場合は左 Shift、タップした場合は `kc`           |
-| `LALT_T(kc)` | `LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)`                            | 押したままの場合は左 Alt、タップした場合は `kc` |
-| `LGUI_T(kc)` | `LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)` | 押したままの場合は左 GUI、タップした場合は `kc` |
-| `RCTL_T(kc)` |                             | 押したままの場合は右 Control、タップした場合は `kc`         |
-| `RSFT_T(kc)` |                             | 押したままの場合は右 Shift、タップした場合は `kc`           |
-| `RALT_T(kc)` | `ROPT_T(kc)`, `ALGR_T(kc)`  | 押したままの場合は右 Alt、タップした場合は `kc`             |
-| `RGUI_T(kc)` | `RCMD_T(kc)`, `RWIN_T(kc)`  | 押したままの場合は右 GUI、タップした場合は `kc`             |
-| `SGUI_T(kc)` | `SCMD_T(kc)`, `SWIN_T(kc)`  | 押したままの場合は左 Shift と左 GUI、タップした場合は `kc`             |
-| `LCA_T(kc)`  |                             | 押したままの場合は左 Control と左 Alt、タップした場合は `kc`           |
-| `LCAG_T(kc)` |                             | 押したままの場合は左 Control、左 Alt と左 GUI、タップした場合は `kc`   |
-| `RCAG_T(kc)` |                             | 押したままの場合は右 Control、右 Alt と右 GUI、タップした場合は `kc`   |
-| `C_S_T(kc)`  |                             | 押したままの場合は左 Control と左 Shift、タップした場合は `kc`         |
-| `MEH_T(kc)`  |                             | 押したままの場合は左 Control、左 Shift と左 Alt、タップした場合は `kc` |
-| `HYPR_T(kc)` | `ALL_T(kc)`  | 押したままの場合は左 Control、左 Shift、左 Alt と左 GUI、タップした場合は `kc` - より詳しくは[ここ](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)を見てください |
+| キー         | エイリアス                                                        | 説明                                                                   |
+| ------------ | ----------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| `LCTL_T(kc)` | `CTL_T(kc)`                                                       | 押したままの場合は左 Control、タップした場合は `kc`                    |
+| `LSFT_T(kc)` | `SFT_T(kc)`                                                       | 押したままの場合は左 Shift、タップした場合は `kc`                      |
+| `LALT_T(kc)` | `LOPT_T(kc)`, `ALT_T(kc)`, `OPT_T(kc)`                            | 押したままの場合は左 Alt、タップした場合は `kc`                        |
+| `LGUI_T(kc)` | `LCMD_T(kc)`, `LWIN_T(kc)`, `GUI_T(kc)`, `CMD_T(kc)`, `WIN_T(kc)` | 押したままの場合は左 GUI、タップした場合は `kc`                        |
+| `RCTL_T(kc)` |                                                                   | 押したままの場合は右 Control、タップした場合は `kc`                    |
+| `RSFT_T(kc)` |                                                                   | 押したままの場合は右 Shift、タップした場合は `kc`                      |
+| `RALT_T(kc)` | `ROPT_T(kc)`, `ALGR_T(kc)`                                        | 押したままの場合は右 Alt、タップした場合は `kc`                        |
+| `RGUI_T(kc)` | `RCMD_T(kc)`, `RWIN_T(kc)`                                        | 押したままの場合は右 GUI、タップした場合は `kc`                        |
+| `SGUI_T(kc)` | `SCMD_T(kc)`, `SWIN_T(kc)`                                        | 押したままの場合は左 Shift と左 GUI、タップした場合は `kc`             |
+| `LCA_T(kc)`  |                                                                   | 押したままの場合は左 Control と左 Alt、タップした場合は `kc`           |
+| `LSA_T(kc)`  |                                                                   | 押したままの場合は左 Shift と Alt、タップした場合は `kc`               |
+| `RSA_T(kc)`  | `SAGR_T(kc)`                                                      | 押したままの場合は右 Shift と Alt (AltGr)、タップした場合は `kc`       |
+| `RCS_T(kc)`  |                                                                   | 押したままの場合は右 Control と Shift、タップした場合は `kc`           |
+| `LCAG_T(kc)` |                                                                   | 押したままの場合は左 Control、左 Alt と左 GUI、タップした場合は `kc`   |
+| `RCAG_T(kc)` |                                                                   | 押したままの場合は右 Control、右 Alt と右 GUI、タップした場合は `kc`   |
+| `C_S_T(kc)`  |                                                                   | 押したままの場合は左 Control と左 Shift、タップした場合は `kc`         |
+| `MEH_T(kc)`  |                                                                   | 押したままの場合は左 Control、左 Shift と左 Alt、タップした場合は `kc` |
+| `HYPR_T(kc)` | `ALL_T(kc)`                                                       | 押したままの場合は左 Control、左 Shift、左 Alt と左 GUI、タップした場合は `kc` - より詳しくは[ここ](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)を見てください |
 
 ## 注意事項
 
@@ -57,3 +60,7 @@ MT(MOD_LCTL | MOD_LSFT, KC_ESC)
 さらに、Windows でリモートデスクトップ接続を使う場合に、問題が発生する場合があります。これらのコードはシフトを非常に高速に送信するため、リモートデスクトップはコードを見逃すかもしれません。
 
 これを修正するには、リモートデスクトップ接続を開き、「オプションの表示」を開き、「ローカル リソース」タブを開きます。キーボードセクションで、ドロップダウンを「このコンピューター」に変更します。これにより問題が修正され、キャラクタが正しく動作するようになります。
+
+## 他のリソース
+
+モッドタップの動作を調整する追加フラグについては、[タップホールド設定オプション](ja/tap_hold.md)を参照してください。

docs/ja/newbs.md

@@ -1,9 +1,9 @@
-# QMK 初心者ガイド
+# QMK チュートリアル
 
 <!---
   grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
-  original document: 0.9.0:docs/newbs.md
-  git diff 0.9.0 HEAD -- docs/newbs.md | cat
+  original document: 0.12.45:docs/newbs.md
+  git diff 0.12.45 HEAD -- docs/newbs.md | cat
 -->
 
 キーボードには、コンピュータ入っているものと似たようなプロセッサが入っています。
@@ -19,20 +19,16 @@ QMK は、簡単なことは簡単に、そして、難しいことを可能な
 QMK は[多くの趣味のキーボード](https://qmk.fm/keyboards/)をサポートしています。
 現在使用しているキーボードが QMK を実行できない場合、QMK を実行できるキーボードの選択肢はたくさんあります。
 
-## このガイドは私のためにあるのでしょうか？
-
-このガイドは、ソースコードを使ってキーボードのファームウェアを構築したいと考えている人に適しています。
-もしあなたがすでにプログラマーであれば、このプロセスはとても身近で簡単に理解できるでしょう。
-もし、プログラミングの考え方に抵抗があるのであれば、代わりに[私たちのオンラインGUI](ja/newbs_building_firmware_configurator.md)を見てみてください。
+?> **このガイドは私のためにあるのでしょうか？**<br>
+もし、プログラミングの考え方に抵抗があるのであれば、代わりに[私たちのオンライン GUI](ja/newbs_building_firmware_configurator.md) を見てみてください。
 
 ## 概要
 
-このガイドには4つの主要なセクションがあります。
+このガイドは、ソースコードを使ってキーボードのファームウェアを構築したいと考えている人に適しています。 もしあなたがすでにプログラマーであれば、このプロセスはとても身近で簡単に理解できるでしょう。このガイドには3つの主要なセクションがあります:
 
 1. [環境設定](ja/newbs_getting_started.md)
 2. [コマンドラインを使用して初めてのファームウェアを構築する](ja/newbs_building_firmware.md)
 3. [ファームウェアを書きこむ](ja/newbs_flashing.md)
-4. [テストとデバッグ](ja/newbs_testing_debugging.md)
 
 このガイドは、これまでソフトウェアをコンパイルしたことがない人を支援することに特化しています。
 その観点から選択と推奨を行います。
@@ -41,8 +37,4 @@ QMK は[多くの趣味のキーボード](https://qmk.fm/keyboards/)をサポ
 
 ## 追加のリソース
 
-このガイドの他にも、QMK の学習に役立つリソースがいくつかあります。[学習リソース](ja/newbs_learn_more_resources.md)のページにまとめました。
-
-## オープンソース
-
-QMKは GNU General Public License でリリースされているオープンソース・ソフトウェアです。
+このガイドの他にも、QMK の学習に役立つリソースがいくつかあります。[シラバス](ja/syllabus.md)と[学習リソース](ja/newbs_learn_more_resources.md)のページにまとめました。

docs/ja/newbs_building_firmware_configurator.md

@@ -2,13 +2,13 @@
 
 <!---
   grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
-  original document: 0.9.0:docs/newbs_building_firmware_configurator.md
-  git diff 0.9.0 HEAD -- docs/newbs_building_firmware_configurator.md | cat
+  original document: 0.12.45:docs/newbs_building_firmware_configurator.md
+  git diff 0.12.45 HEAD -- docs/newbs_building_firmware_configurator.md | cat
 -->
 
 [![QMK Configurator Screenshot](https://i.imgur.com/anw9cOL.png)](https://config.qmk.fm/)
 
-[QMK Configurator](https://config.qmk.fm) は、QMKファームウェアの hex ファイルを生成するオンライングラフィカルユーザーインターフェイスです。
+[QMK Configurator](https://config.qmk.fm) は、QMKファームウェアの `.hex` や `.bin` ファイルを生成するオンライングラフィカルユーザーインターフェイスです。
 
 [ビデオチュートリアル](https://www.youtube.com/watch?v=-imgglzDMdY) を見てください。
 多くの人は、それが自分のキーボードのプログラミングを始めるのに十分な情報であることに気づくでしょう。

docs/ja/newbs_flashing.md

@@ -1,12 +1,12 @@
-# ファームウェアを書きこむ
+# ファームウェアを書き込む
 
 <!---
   grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
-  original document: 0.9.44:docs/newbs_flashing.md
-  git diff 0.9.44 HEAD -- docs/newbs_flashing.md | cat
+  original document: 0.12.45:docs/newbs_flashing.md
+  git diff 0.12.45 HEAD -- docs/newbs_flashing.md | cat
 -->
 
-カスタムファームウェアは出来たので、キーボードに書き込みたくなるでしょう/フラッシュしたくなるでしょう。
+カスタムファームウェアは出来たので、いよいよキーボードへの書き込み(フラッシュ)です。
 
 ## キーボードを DFU (Bootloader) モードにする
 
@@ -50,18 +50,22 @@ Finder またはエクスプローラーでファームウェアのファイル
 
 Windows か macOS を使用している場合、現在のフォルダをエクスプローラーか Finder で簡単に開くためのコマンドがあります。
 
-#### Windows
+<!-- tabs:start -->
+
+#### ** Windows **
 
 ```
 start .
 ```
 
-#### macOS
+#### ** macOS **
 
 ```
 open .
 ```
 
+<!-- tabs:end -->
+
 ファームウェアファイルは常に以下の命名形式に従っています:
 
 ```
@@ -117,11 +121,13 @@ QMK Toolbox の `Flash` ボタンをクリックします。次のような出
 
     WARNING: This board's bootloader is not specified or is not supported by the ":flash" target at this time.
 
-この場合、あなたは明示的にブートローダを指定する方法を使わなければなりません。詳細は、[ファームウェアのフラッシュ](ja/flashing.md) ガイドを参照してください。
+この場合、あなたは明示的にブートローダを指定する方法を使わなければなりません。詳細は、[ファームウェアのフラッシュ](ja/flashing.md)ガイドを参照してください。
 
 ## テストしましょう！
 
-おめでとうございます！ カスタムファームウェアがキーボードにプログラムされました！
+おめでとうございます！カスタムファームウェアがキーボードにプログラムされ、テストする準備ができました！
 
-使ってみて、すべてがあなたの望むように動作するかどうか確認してください。
-この初心者ガイドを完全なものにするために [テストとデバッグ](ja/newbs_testing_debugging.md) を書いたので、ファームウェアの検証とカスタム機能のトラブルシューティング方法について学ぶには、こちらをご覧ください。
+少し運が良ければ全てが完璧に機能しますが、そうでない場合は何が問題なのかを理解するのに役立つ手順があります。
+通常、キーボードのテストは非常に簡単です。全てのキーをひとつずつ押して、期待するキーが送信されることを確認します。例え QMK で動作していない場合でも、[QMK Configurator](https://config.qmk.fm/#/test/) のテストモードを使用すると、キーボードをチェックできます。
+
+まだ動作しませんか？詳細については FAQ トピックを参照するか、[Discord でチャット](https://discord.gg/Uq7gcHh)してください。

docs/ja/newbs_learn_more_resources.md

@@ -2,13 +2,13 @@
 
 <!---
   grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
-  original document: 0.9.0:docs/newbs_learn_more_resources.md
-  git diff 0.9.0 HEAD -- docs/newbs_learn_more_resources.md | cat
+  original document: 0.12.45:docs/newbs_learn_more_resources.md
+  git diff 0.12.45 HEAD -- docs/newbs_learn_more_resources.md | cat
 -->
 
 これらのリソースは、QMK コミュニティの新しいメンバーに、初心者向けドキュメントで提供されている情報に対する理解を深めることを目的としています。
 
-## QMK に関するリソース:
+## QMK に関するリソース
 
 ### 英語 :id=english-resources-qmk
 
@@ -18,17 +18,35 @@
 
 _日本語のリソース情報を募集中です。_
 
-## コマンドラインに関するリソース:
+## コマンドラインに関するリソース :id=command-line-resources
 
 ### 英語 :id=english-resources-cli
 
 * [Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)
+* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br>
+* [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
 
 ### 日本語 :id=japanese-resources-cli
 
 _日本語のリソース情報を募集中です。_
 
-## Git に関するリソース:
+## テキストエディタに関するリソース :id=text-editor-resources
+
+どのテキストエディタを使えば良いか分かりませんか？
+
+### 英語 :id=english-resources-text-editor
+
+* [a great introduction to the subject](https://learntocodewith.me/programming/basics/text-editors/)
+
+### 日本語 :id=japanese-resources-text-editor
+
+_日本語のリソース情報を募集中です。_
+
+コーディング用に特別に作成されたエディタ:
+* [Sublime Text](https://www.sublimetext.com/)
+* [VS Code](https://code.visualstudio.com/)
+
+## Git に関するリソース
 
 ### 英語 :id=english-resources-git
 

docs/ja/one_shot_keys.md

@@ -1,8 +1,8 @@
 # ワンショットキー
 
 <!---
-  original document: 0.9.34:docs/one_shot_keys.md
-  git diff 0.9.34 HEAD -- docs/one_shot_keys.md | cat
+  original document: 0.12.41:docs/one_shot_keys.md
+  git diff 0.12.41 HEAD -- docs/one_shot_keys.md | cat
 -->
 
 ワンショットキーは次のキーが押されるまでアクティブのままになり、そのあと放されるキーです。これにより一度に1つ以上のキーを押すことなく、キーボードの組み合わせを入力することができます。これらのキーは通常「スティッキーキー」あるいは「デッドキー」と呼ばれます。
@@ -27,7 +27,7 @@
 
 ワンショットレイヤーについては、キーを押した時に `set_oneshot_layer(LAYER, ONESHOT_START)` を呼び出し、キーを放した時に `clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED)` を呼び出す必要があります。ワンショットをキャンセルする場合は、`reset_oneshot_layer()` を呼び出してください。
 
-ワンショットモッドについては、設定するためには `set_oneshot_mods(MOD)` を呼び出し、キャンセルするためには `clear_oneshot_mods()` を呼び出す必要があります。
+ワンショットモッドについては、設定するためには `set_oneshot_mods(MOD_BIT(KC_*))` を呼び出し、キャンセルするためには `clear_oneshot_mods()` を呼び出す必要があります。
 
 !> リモートデスクトップ接続で OSM 変換に問題がある場合は、設定を開いて「ローカル リソース」タブに移動し、キーボードセクションでドロップダウンを「このコンピューター」に変更することで修正することができます。これにより問題が修正され、OSM がリモートデスクトップ上で適切に動作するようになります。
 

docs/ja/ref_functions.md

@@ -1,8 +1,8 @@
 # キーボードをより良くするための便利なコア関数のリスト
 
 <!---
-  original document: 0.10.33:docs/ref_functions.md
-  git diff 0.10.33 HEAD -- docs/ref_functions.md | cat
+  original document: 0.12.41:docs/ref_functions.md
+  git diff 0.12.41 HEAD -- docs/ref_functions.md | cat
 -->
 
 QMK には、信じられないほど便利な、またはあなたが望んでいた機能を少し追加する、隠された関数がたくさんあります。特定の機能に固有の関数はそれぞれの機能のページにあるため、ここには含まれていません。
@@ -98,7 +98,7 @@ layer_state_t layer_state_set_user(layer_state_t state) {
 
 ## EEPROM (永続ストレージ)の消去
 
-オーディオ、RGB アンダーグロー、バックライト、キーの動作に問題がある場合は、EEPROM (永続的な設定のストレージ)をリセットすることができます。ブートマジックはこれを行う方法の1つですが、有効になっていない場合はカスタムマクロを使って行うことができます。
+オーディオ、RGB アンダーグロー、バックライト、キーの動作に問題がある場合は、EEPROM (永続的な設定のストレージ)をリセットすることができます。EEPROM を強制的にリセットするには、[`EEP_RST` キーコード](ja/quantum_keycodes.md)あるいは[ブートマジック](ja/feature_bootmagic.md)機能を使います。それらのいずれも選択肢にない場合は、カスタムマクロを使って行うことができます。
 
 EEPROM を消去するには、関数またはマクロから `eeconfig_init()` を実行し、ほとんどの設定をデフォルトにリセットします。
 

docs/one_shot_keys.md

@@ -23,7 +23,7 @@ You can control the behavior of one shot keys by defining these in `config.h`:
 
 Sometimes, you want to activate a one-shot key as part of a macro or tap dance routine.  
 
-For one shot layers, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`.
+For one shot layers, you need to call `set_oneshot_layer(LAYER, ONESHOT_START)` on key down, and `clear_oneshot_layer_state(ONESHOT_PRESSED)` on key up. If you want to cancel the oneshot, call `reset_oneshot_layer()`.
 
 For one shot mods, you need to call `set_oneshot_mods(MOD_BIT(KC_*))` to set it, or `clear_oneshot_mods()` to cancel it.
 

docs/ws2812_driver.md

@@ -72,7 +72,9 @@ WS2812_DRIVER = spi
 Configure the hardware via your config.h:
 ```c
 #define WS2812_SPI SPID1 // default: SPID1
-#define WS2812_SPI_MOSI_PAL_MODE 5 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 5
+#define WS2812_SPI_MOSI_PAL_MODE 5 // MOSI pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 5
+#define WS2812_SPI_SCK_PIN B3 // Required for F072, may be for others -- SCK pin, see the respective datasheet for the appropriate values for your MCU. default: unspecified
+#define WS2812_SPI_SCK_PAL_MODE 5 // SCK pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 5
 ```
 
 You must also turn on the SPI feature in your halconf.h and mcuconf.h
@@ -100,11 +102,11 @@ Only divisors of 2, 4, 8, 16, 32, 64, 128 and 256 are supported by hardware.
 
 While not an exhaustive list, the following table provides the scenarios that have been partially validated:
 
-| | SPI1 | SPI2 | SPI3 |
-|-|-|-|-|
-| f072 | ? | B15 :heavy_check_mark: | N/A |
-| f103 | A7 :heavy_check_mark: | B15 :heavy_check_mark: | N/A |
-| f303 | A7 :heavy_check_mark: B5 :heavy_check_mark:  | B15 :heavy_check_mark: | B5 :heavy_check_mark: |
+|      | SPI1                                        | SPI2                                    | SPI3                  |
+|------|---------------------------------------------|-----------------------------------------|-----------------------|
+| f072 | ?                                           | B15 :heavy_check_mark: (needs SCK: B13) | N/A                   |
+| f103 | A7 :heavy_check_mark:                       | B15 :heavy_check_mark:                  | N/A                   |
+| f303 | A7 :heavy_check_mark: B5 :heavy_check_mark: | B15 :heavy_check_mark:                  | B5 :heavy_check_mark: |
 
 *Other supported ChibiOS boards and/or pins may function, it will be highly chip and configuration dependent.*
 

drivers/avr/spi_master.c

@@ -14,10 +14,8 @@
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#include <avr/io.h>
-
 #include "spi_master.h"
-#include "quantum.h"
+
 #include "timer.h"
 
 #if defined(__AVR_AT90USB162__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)

drivers/avr/spi_master.h

@@ -16,7 +16,9 @@
 
 #pragma once
 
-#include "quantum.h"
+#include <stdbool.h>
+
+#include "gpio.h"
 
 typedef int16_t spi_status_t;
 

drivers/chibios/spi_master.c

@@ -15,7 +15,7 @@
  */
 
 #include "spi_master.h"
-#include "quantum.h"
+
 #include "timer.h"
 
 static pin_t     currentSlavePin = NO_PIN;

drivers/chibios/spi_master.h

@@ -18,7 +18,9 @@
 
 #include <ch.h>
 #include <hal.h>
-#include "quantum.h"
+#include <stdbool.h>
+
+#include "gpio.h"
 
 #ifndef SPI_DRIVER
 #    define SPI_DRIVER SPID2

drivers/chibios/ws2812_spi.c

@@ -16,19 +16,23 @@
 #    define WS2812_SPI_MOSI_PAL_MODE 5
 #endif
 
+#ifndef WS2812_SPI_SCK_PAL_MODE
+#    define WS2812_SPI_SCK_PAL_MODE 5
+#endif
+
 // Push Pull or Open Drain Configuration
 // Default Push Pull
 #ifndef WS2812_EXTERNAL_PULLUP
 #    if defined(USE_GPIOV1)
-#        define WS2812_OUTPUT_MODE PAL_MODE_STM32_ALTERNATE_PUSHPULL
+#        define WS2812_MOSI_OUTPUT_MODE PAL_MODE_STM32_ALTERNATE_PUSHPULL
 #    else
-#        define WS2812_OUTPUT_MODE PAL_MODE_ALTERNATE(WS2812_SPI_MOSI_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL
+#        define WS2812_MOSI_OUTPUT_MODE PAL_MODE_ALTERNATE(WS2812_SPI_MOSI_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL
 #    endif
 #else
 #    if defined(USE_GPIOV1)
-#        define WS2812_OUTPUT_MODE PAL_MODE_STM32_ALTERNATE_OPENDRAIN
+#        define WS2812_MOSI_OUTPUT_MODE PAL_MODE_STM32_ALTERNATE_OPENDRAIN
 #    else
-#        define WS2812_OUTPUT_MODE PAL_MODE_ALTERNATE(WS2812_SPI_MOSI_PAL_MODE) | PAL_STM32_OTYPE_OPENDRAIN
+#        define WS2812_MOSI_OUTPUT_MODE PAL_MODE_ALTERNATE(WS2812_SPI_MOSI_PAL_MODE) | PAL_STM32_OTYPE_OPENDRAIN
 #    endif
 #endif
 
@@ -63,6 +67,12 @@
 #    define WS2812_SPI_BUFFER_MODE 0  // normal buffer
 #endif
 
+#if defined(USE_GPIOV1)
+#    define WS2812_SCK_OUTPUT_MODE PAL_MODE_STM32_ALTERNATE_PUSHPULL
+#else
+#    define WS2812_SCK_OUTPUT_MODE PAL_MODE_ALTERNATE(WS2812_SPI_SCK_PAL_MODE) | PAL_STM32_OTYPE_PUSHPULL
+#endif
+
 #define BYTES_FOR_LED_BYTE 4
 #define NB_COLORS 3
 #define BYTES_FOR_LED (BYTES_FOR_LED_BYTE * NB_COLORS)
@@ -109,7 +119,11 @@ static void set_led_color_rgb(LED_TYPE color, int pos) {
 }
 
 void ws2812_init(void) {
-    palSetLineMode(RGB_DI_PIN, WS2812_OUTPUT_MODE);
+    palSetLineMode(RGB_DI_PIN, WS2812_MOSI_OUTPUT_MODE);
+
+#ifdef WS2812_SPI_SCK_PIN
+    palSetLineMode(WS2812_SPI_SCK_PIN, WS2812_SCK_OUTPUT_MODE);
+#endif  // WS2812_SPI_SCK_PIN
 
     // TODO: more dynamic baudrate
     static const SPIConfig spicfg = {WS2812_SPI_BUFFER_MODE, NULL, PAL_PORT(RGB_DI_PIN), PAL_PAD(RGB_DI_PIN), WS2812_SPI_DIVISOR};

keyboards/1upkeyboards/sweet16/v2/proton_c/rules.mk

@@ -2,6 +2,9 @@
 MCU = STM32F303
 BOARD = QMK_PROTON_C
 
+# Bootloader selection
+BOOTLOADER = stm32-dfu
+
 ## Features
 CONSOLE_ENABLE = yes
 ENCODER_ENABLE = yes

keyboards/acheron/arctic/rules.mk

@@ -1,6 +1,9 @@
 # MCU name
 MCU = STM32F072
 
+# Bootloader selection
+BOOTLOADER = stm32-dfu
+
 # Build Options
 #   change yes to no to disable
 #