summaryrefslogtreecommitdiffstats
path: root/keyboards/durgod/k3x0
diff options
context:
space:
mode:
authorGabriel Oliveira <gabrieloliver8991@gmail.com>2022-06-09 22:15:44 -0300
committerGitHub <noreply@github.com>2022-06-09 18:15:44 -0700
commit9316023290148f6d0a736aedbda2ec66f04e9523 (patch)
tree9d2f744d3e1b8e7e40076f5774068cbf77ea7239 /keyboards/durgod/k3x0
parent2f8704143eb14dd2171b36f0bd67664aac909d87 (diff)
[Keyboard] Improve the durgot k3x0 readme.md (#17214)
Diffstat (limited to 'keyboards/durgod/k3x0')
-rw-r--r--keyboards/durgod/k3x0/readme.md70
1 files changed, 49 insertions, 21 deletions
diff --git a/keyboards/durgod/k3x0/readme.md b/keyboards/durgod/k3x0/readme.md
index cbb170160c..62bb97d7ec 100644
--- a/keyboards/durgod/k3x0/readme.md
+++ b/keyboards/durgod/k3x0/readme.md
@@ -18,34 +18,62 @@ Instructions for building the K310 and K320 firmware can be found here:
### Initial Flash
-For first Flashing from initial Stock Firmware
+#### Requirements
-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:
+- The Durgod K320/K310 - different batches have different controllers, so when opening the keyboard, you will have to make sure it's using SMT32 controller.
+- Another keyboard - when on bootloader mode, you can't use the keyboard to type and execute the commands (not really required if you can use any mouse interface to type and execute the commands).
+- 2 prying tools - to open the keyboard.
+- Another helping hand - it can be also done with just two hands, but it will require a lot of dexterity.
+- A small cable with both ends cut.
- dfu-util --list
- dfu-util --alt 0 --dfuse-address 0x08000000 --upload ${OLD_STOCK_BIN}
+#### Enter bootloader while using the original firmware
-2. 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](https://github.com/qmk/qmk_toolbox)
+1. Unplug USB cable.
+2. Open the keyboard case - there are plenty of youtube videos in that, but you will basically need 2 prying tools and a certain amount of force.
+3. After opening the keyboard, put the PCB upsides down, and the controller should be near the LEDs, and make sure it's using the right controller (SMT32).
+4. Use the cable to short Boot0 to Vdd, by shorting R21 to C27 on the sides closest to the processor, as shown:
+
+<img src="https://i.imgur.com/hvDnw5a.jpg" width="520" height="693" alt="Shorting Boot0 to Vdd on K320">
+
+5. While shorting both contacts as instructed in step 4, plug in the USB cable.
+6. When the USB cable is fully inserted, the LEDs should not turn on and the keyboard it's not able to type, you are probably on bootloader mode, to be sure:
+ - Using dfu-util, it should show something like "Found DFU…" after using this command:
+```
+dfu-util --list
+```
+
+Now that you are sure to be in bootloader mode, you can backup the original firmware and flash QMK Firmware.
+
+If it does not behave like described, remove the cable and go back to step 4.
+
+#### Backup original firmware
+
+1. Be in Bootloader mode.
+2. Execute this command to backup:
- Using dfu-util:
+```bash
+dfu-util -a 0 -d 0483:DF11 -s 0x08000000 -U k3x0_original.bin
+```
+
+#### Flash the QMK Firmware Image
- dfu-util --alt 0 --dfuse-address 0x08000000 --download ${NEW_QMK_BIN}
+1. Be in Bootloader mode.
+2. Here are a few options for performing the initial Flash:
+ - Using [QMK Toolbox](https://github.com/qmk/qmk_toolbox)
+ - Using qmk on command line:
-You can short Boot0 to Vdd by shorting R21 to C27 on the sides closest to the processor, as shown:
+```bash
+# k310
+qmk flash -kb durgod/k3x0/k310 -km default
-<img src="https://i.imgur.com/hvDnw5a.jpg" width="520" height="693" alt="Shorting Boot0 to Vdd on K320">
+# k320
+qmk flash -kb durgod/k3x0/k320 -km default
+```
### 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
+For repeating Flashing you can use BootMagic Lite has been enabled by default and assigned to the "Esc" key:
+
+1. Unplug USB Cable.
+2. Hold the "Esc" key.
+2. Plug in the USB Cable, the Keyboard should be in ST-Bootloader state.