opensteno_qmk/keyboards/durgod/k3x0
James Young a03aa301de
Remove Full Bootmagic (#13846)
* disambiguate Bootmagic rules in keymaps

The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.

This commit edits the files to specify that full Bootmagic is intended.

* remove BOOTMAGIC_ENABLE=full setting

* unify commented BOOTMAGIC_ENABLE rules in keyboards

Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no       # Virtual DIP switch configuration;g' {} +
```

* remove commented Bootmagic rules from keymap/user level

Command:

```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```

* update keyboard BOOTMAGIC_ENABLE rule formatting

Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```

* update keyboards' BOOTMAGIC_ENABLE settings

Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```

* update keymap/user BOOTMAGIC_ENABLE settings

Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```

* remove and replace inline comments in keyboards and keymap/user files

Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1     # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1      # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1       # Enable Bootmagic Lite;g' '{}' +
```

* rename improperly named makefiles

Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.

This commit corrects the filenames of the affected files.

* update renamed file with new rule formatting

* update QMK's template files

Updates QMK's `rules.mk` templates to use the new inline comment.

* update QMK Docs

- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes

* rules.mk patch for coarse/ixora and coarse/vinta
2021-08-06 23:59:56 -07:00
..
k310 [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
k320 [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
keymaps [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
config.h [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
halconf.h [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
k3x0.c [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
k3x0.h [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
readme.md [Keyboard] Add Durgod Taurus K310 keyboard (#12314) 2021-07-22 00:09:00 -07:00
rules.mk Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00

K3X0 = K310, K320, etc.

This K3X0 code is shared between both the ANSI and ISO variants of both the K310 full-sized 104/105-key and K320 TKL 87/88-key keyboards.

Instructions

Build

Instructions for building the K310 and K320 firmware can be found here:

Initial Flash

For first Flashing from initial Stock Firmware

  1. Back up original Firmware Image:
  • Unplug
  • Short Boot0 to Vdd (See below)
  • Plug In USB
  • Make a Flash Image's Backup in case you wanted to restore the Keyboard to Stock's Image:
    • Using dfu-util:

      dfu-util --list
      dfu-util --alt 0 --dfuse-address 0x08000000 --upload ${OLD_STOCK_BIN}
      
  1. Flash the QMK Firmware Image.
  • Put board into Bootloader mode, using the same method as when backing up the original Firmware (above)
  • Here are a few options for performing the initial Flash:
    • Using QMK Toolbox

    • Using dfu-util:

      dfu-util --alt 0 --dfuse-address 0x08000000 --download ${NEW_QMK_BIN}
      

You can short Boot0 to Vdd by shorting R21 to C27 on the sides closest to the processor, as shown:

Shorting Boot0 to Vdd on K320

Subsequent Flashing

For repeating Flashing you can use BootMagic:

  • BootMagic Lite has been enabled with Assigned "Esc" key
  • Unplug USB Cable
  • Holding Esc Button
  • Plug in USB Cable, Keyboard should be in ST-Bootloader state