Merge pull request #82 from qmk/master

Fork Sync
gm2211 · Nov 3, 2021 · 148c999 · 148c999
2 parents 85178ff + 712c01e
commit 148c999
Show file tree

Hide file tree

Showing 497 changed files with 15,292 additions and 5,872 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -5,7 +5,6 @@
     "xaver.clang-format",
     "ms-vscode.cpptools",
     "bierner.github-markdown-preview",
-    "donjayamanne.git-extension-pack",
-    "CoenraadS.bracket-pair-colorizer-2"
+    "donjayamanne.git-extension-pack"
   ]
 }
diff --git a/docs/cli_tab_complete.md b/docs/cli_tab_complete.md
@@ -18,7 +18,7 @@ If you put `qmk_firmware` into another location you will need to adjust this pat
 
 If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:
 
-    `ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh`
+    ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh
 
 ### System Wide Copy
 

diff --git a/docs/config_options.md b/docs/config_options.md
@@ -404,6 +404,8 @@ However, this will automatically disable the legacy TMK Macros and Functions fea
 
 Use these to enable or disable building certain features. The more you have enabled the bigger your firmware will be, and you run the risk of building a firmware too large for your MCU.
 
+* `MAGIC_ENABLE`
+  * MAGIC actions (BOOTMAGIC without the boot)
 * `BOOTMAGIC_ENABLE`
   * Virtual DIP switch configuration
 * `MOUSEKEY_ENABLE`

diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
@@ -146,6 +146,11 @@ void oled_task_user(void) {
 
 ## Basic Configuration
 
+These configuration options should be placed in `config.h`. Example:
+```c
+#define OLED_BRIGHTNESS 128
+```
+
 |Define                     |Default          |Description                                                                                                               |
 |---------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------|
 |`OLED_DISPLAY_ADDRESS`     |`0x3C`           |The i2c address of the OLED Display                                                                                       |

diff --git a/docs/feature_stenography.md b/docs/feature_stenography.md
@@ -129,7 +129,8 @@ As defined in `keymap_steno.h`.
 |`STN_RES2`||(GeminiPR only)|
 |`STN_PWR`||(GeminiPR only)|
 
-If you do not want to hit two keys with one finger combined keycodes can be used. These are also defined in `keymap_steno.h`, and causes both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file 
+If you do not want to hit two keys with one finger combined keycodes can be used. These are also defined in `keymap_steno.h`, and causes both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file.
+
 |Combined key   | Key1   | Key 2    |
 |---------------|--------|----------|
 |STN_S3         | STN_S1 | STN_S2   |

diff --git a/docs/feature_tap_dance.md b/docs/feature_tap_dance.md
@@ -393,6 +393,9 @@ void altlp_finished(qk_tap_dance_state_t *state, void *user_data) {
         case TD_DOUBLE_SINGLE_TAP: // Allow nesting of 2 parens `((` within tapping term
             tap_code16(KC_LPRN);
             register_code16(KC_LPRN);
+            break;
+        default:
+            break;
     }
 }
 
@@ -406,6 +409,9 @@ void altlp_reset(qk_tap_dance_state_t *state, void *user_data) {
             break;
         case TD_DOUBLE_SINGLE_TAP:
             unregister_code16(KC_LPRN);
+            break;
+        default:
+            break;
     }
 }
 

diff --git a/docs/internals_gpio_control.md b/docs/internals_gpio_control.md
@@ -4,7 +4,7 @@ QMK has a GPIO control abstraction layer which is microcontroller agnostic. This
 
 ## Functions :id=functions
 
-The following functions can provide basic control of GPIOs and are found in `quantum/quantum.h`.
+The following functions provide basic control of GPIOs and are found in `tmk_core/common/<platform>/gpio.h`.
 
 |Function                |Description                                       | Old AVR Examples                                | Old ChibiOS/ARM Examples                        |
 |------------------------|--------------------------------------------------|-------------------------------------------------|-------------------------------------------------|

diff --git a/docs/ja/ja_doc_status.sh b/docs/ja/ja_doc_status.sh
@@ -0,0 +1,34 @@
+#! /bin/sh
+#
+# Script to display the Japanese translation status of documents
+#
+if [ ! -d docs/ja ]; then
+    echo "'docs/ja' not found."
+    echo "do:"
+    echo "  cd \$(QMK_TOP)"
+    echo "  ./docs/ja/ja_doc_status.sh"
+    exit 1
+fi
+
+en_docs=`cd docs;ls -1 [a-z]*.md`
+ja_docs=`cd docs/ja;ls -1 [a-z]*.md`
+en_count=`echo $en_docs | wc -w`
+ja_count=`echo $ja_docs | wc -w`
+echo "English documents  $en_count files."
+echo "Japanese documents $ja_count files."
+
+echo "Files that have not been translated yet:"
+for docfile in $en_docs
+do
+    if [ ! -f docs/ja/$docfile ]; then
+        wc docs/$docfile
+    fi
+done | sort
+echo "Files that have not been updated yet:"
+grep --no-filename "^[ ]*git diff" docs/ja/*.md | while read cmd
+do
+  cline=`echo $cmd | sh | wc -l`
+  if [ $cline -gt 0 ]; then
+    echo "$cline $cmd"
+ fi
+done | sort
diff --git a/docs/keycodes.md b/docs/keycodes.md
@@ -344,6 +344,7 @@ See also: [Magic Keycodes](keycodes_magic.md)
 |`MAGIC_TOGGLE_ALT_GUI`            |`AG_TOGG`|Toggle Alt and GUI swap on both sides                                     |
 |`MAGIC_NO_GUI`                    |`GUI_OFF`|Disable the GUI keys                                                      |
 |`MAGIC_UNNO_GUI`                  |`GUI_ON` |Enable the GUI keys                                                       |
+|`MAGIC_TOGGLE_GUI`                |`GUI_TOG`|Toggles the status of the GUI keys                                        |
 |`MAGIC_SWAP_GRAVE_ESC`            |`GE_SWAP`|Swap <code>&#96;</code> and Escape                                        |
 |`MAGIC_UNSWAP_GRAVE_ESC`          |`GE_NORM`|Unswap <code>&#96;</code> and Escape                                      |
 |`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |`BS_SWAP`|Swap `\` and Backspace                                                    |

diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
@@ -194,7 +194,7 @@ You can also set your default keymap name. Most people use their GitHub username
 
     qmk config user.keymap=<github_username>
 
-After this you can leave those arguments off and compile your keyboard like this:
+The keyboard can now be compiled without arguments using the following command after creating your keymap in the next section:
 
     qmk compile
 

diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
@@ -9,33 +9,39 @@ You can create `info.json` files at every level under `qmk_firmware/keyboards/<n
 The `info.json` file is a JSON formatted dictionary with the following keys available to be set. You do not have to set all of them, merely the keys that apply to your keyboard.
 
 * `keyboard_name`
-  * A free-form text string describing the keyboard.
-  * Example: `Clueboard 66%`
+    * A free-form text string describing the keyboard.
+    * Example: `Clueboard 66%`
+* `manufacturer`
+    * A free-form text string describing the keyboard's manufacturer.
+    * Example: `Clueboard`
 * `url`
-  * A URL to the keyboard's product page, [QMK.fm/keyboards](https://qmk.fm/keyboards) page, or other page describing information about the keyboard.
+    * A URL to the keyboard's product page, [QMK.fm/keyboards](https://qmk.fm/keyboards) page, or other page describing information about the keyboard.
+    * Example: `https://clueboard.co`
 * `maintainer`
-  * GitHub username of the maintainer, or `qmk` for community maintained boards
+    * GitHub username of the maintainer, or `qmk` for community maintained boards.
+    * Example: `skullydazed`
 * `debounce`
-  * How many milliseconds (ms) to wait for debounce to happen. (Default: 5)
+    * The amount of time in milliseconds to wait for debounce to happen.
+    * Default: `5`
 * `diode_direction`
-  * The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
+    * The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
 * `layout_aliases`
-  * A dictionary containing layout aliases. The key is the alias and the value is a layout in `layouts` it maps to.
+    * A dictionary containing layout aliases. The key is the alias and the value is a layout in `layouts` it maps to.
 * `layouts`
-  * Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
+    * Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
 * `matrix_pins`
-  * Configure the pins corresponding to columns and rows, or direct pins. See [Matrix Pins](#matrix_pins) for more detail.
+    * Configure the pins corresponding to columns and rows, or direct pins. See the [Matrix Pins](#matrix_pins) section for more detail.
 * `rgblight`
-  * Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
+    * Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
 * `usb`
-  * Configure USB VID, PID, and other parameters. See [USB](#USB) for more detail.
+    * Configure USB VID, PID, and other parameters. See the [USB](#USB) section for more detail.
 
 ### Layout Format
 
 Within our `info.json` file the `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example `LAYOUT_ansi` or `LAYOUT_iso`.
 
 * `layout`
-  * A list of Key Dictionaries describing the physical layout. See the next section for more details.
+    * A list of Key Dictionaries describing the physical layout. See the next section for more details.
 
 ### Key Dictionary Format
 
@@ -44,18 +50,20 @@ Each Key Dictionary in a layout describes the physical properties of a key. If y
 All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
 
 * `x`
-  * **Required**: The absolute position of the key in the horizontal axis, in Key Units.
+    * **Required**. The absolute position of the key in the horizontal axis, in Key Units.
 * `y`
-  * **Required**: The absolute position of the key in the vertical axis, in Key Units.
+    * **Required**. The absolute position of the key in the vertical axis, in Key Units.
 * `w`
-  * The width of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
+    * The width of the key, in Key Units.
+    * Default: `1`
 * `h`
-  * The height of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
+    * The height of the key, in Key Units.
+    * Default: `1`
 * `label`
-  * What to name this position in the matrix.
-  * This should usually correspond to the keycode for the first layer of the default keymap.
+    * What to name this position in the matrix. This should usually correspond to the keycode for the first layer of the default keymap.
 * `matrix`
-  * A 2 item list describing the row and column location for this key.
+    * A two item list describing the row and column location for this key.
+    * Example: `[0, 4]`
 
 ### Matrix Pins
 
@@ -69,11 +77,11 @@ Example:
 
 ```json
 {
-  "diode_direction": "COL2ROW",
-  "matrix_pins": {
-    "cols": ["F4", "E6", "B1", "D2"],
-    "rows": ["B0", "D3", "D5", "D4", "D6"]
-  }
+    "diode_direction": "COL2ROW",
+    "matrix_pins": {
+        "cols": ["F4", "E6", "B1", "D2"],
+        "rows": ["B0", "D3", "D5", "D4", "D6"]
+    }
 }
 ```
 
@@ -144,23 +152,23 @@ Example:
 }
 ```
 
-#### RGB Light Animations
+#### RGBLight Animations
 
 The following animations can be enabled:
 
-| Key | Description |
-|-----|-------------|
-| `all` | Enable all additional animation modes. |
-| `alternating` | Enable alternating animation mode. |
-| `breathing` | Enable breathing animation mode. |
-| `christmas` | Enable christmas animation mode. |
-| `knight` | Enable knight animation mode. |
-| `rainbow_mood` | Enable rainbow mood animation mode. |
-| `rainbow_swirl` | Enable rainbow swirl animation mode. |
-| `rgb_test` | Enable RGB test animation mode. |
-| `snake` | Enable snake animation mode. |
-| `static_gradient` | Enable static gradient mode. |
-| `twinkle` | Enable twinkle animation mode. |
+|Key              |Description                           |
+|-----------------|--------------------------------------|
+|`all`            |Enable all additional animation modes.|
+|`alternating`    |Enable alternating animation mode.    |
+|`breathing`      |Enable breathing animation mode.      |
+|`christmas`      |Enable christmas animation mode.      |
+|`knight`         |Enable knight animation mode.         |
+|`rainbow_mood`   |Enable rainbow mood animation mode.   |
+|`rainbow_swirl`  |Enable rainbow swirl animation mode.  |
+|`rgb_test`       |Enable RGB test animation mode.       |
+|`snake`          |Enable snake animation mode.          |
+|`static_gradient`|Enable static gradient mode.          |
+|`twinkle`        |Enable twinkle animation mode.        |
 
 ### USB
 
@@ -170,10 +178,10 @@ Example:
 
 ```json
 {
-  "usb": {
-    "vid": "0xC1ED",
-    "pid": "0x23B0",
-    "device_ver": "0x0001"
-  }
+    "usb": {
+        "vid": "0xC1ED",
+        "pid": "0x23B0",
+        "device_ver": "0x0001"
+    }
 }
 ```
diff --git a/drivers/sensors/adns9800.c b/drivers/sensors/adns9800.c
@@ -78,8 +78,7 @@
 #define US_BEFORE_MOTION 100
 #define MSB1 0x80
 
-extern const uint16_t adns_firmware_length;
-extern const uint8_t adns_firmware_data[];
+extern const uint8_t firmware_data[];
 
 void adns_spi_start(void){
     spi_start(SPI_SS_PIN, false, SPI_MODE, SPI_DIVISOR);
@@ -145,8 +144,8 @@ void adns_init() {
 
     // send all bytes of the firmware
     unsigned char c;
-    for(int i = 0; i < adns_firmware_length; i++){
-        c = (unsigned char)pgm_read_byte(adns_firmware_data + i);
+    for(int i = 0; i < FIRMWARE_LENGTH; i++){
+        c = (unsigned char)pgm_read_byte(firmware_data + i);
         spi_write(c);
         wait_us(15);
     }