Add keyboard QK65 R2 #21896

Siilwyn · 2023-09-03T22:53:22Z

Description

Add Qwertykey's keyboard the QK65 round 2.
I've based this on Owllab's fork, for copied files I've kept their original copyright notice.
The default layout is a copy of the default 65_ansi_blocker keymap with a couple of less second layer keys.

Big thanks to the support in Discord!

Types of Changes

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

keyboards/qwertykeys/qk65/r2/mcuconf.h

keyboards/qwertykeys/qk65/r2/config.h

keyboards/qwertykeys/qk65/r2/chconf.h

keyboards/qwertykeys/qk65/r2/halconf.h

keyboards/qwertykeys/qk65/r2/info.json

keyboards/qwertykeys/qk65/r2/rules.mk

keyboards/qwertykeys/qk65/r2/info.json

Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>

Siilwyn · 2023-09-05T18:23:38Z

Looks like the CI fails on other keyboard configurations, don't think they're related to the changes in this PR.

dunk2k · 2023-09-05T19:14:01Z

Looks like the CI fails on other keyboard configurations, don't think they're related to the changes in this PR.

That's correct, the failing keymaps are from QMK userspaces, which:

Thankfully isn't contributer's responsibility to fix
Are currently undergoing a revamp, hence keymaps and userspace PRs are no being longer accepted (at time of writing).

haunt98 · 2023-09-10T08:44:03Z

keyboards/qwertykeys/qk65/r2/rules.mk

@@ -0,0 +1,5 @@
+MCU_LDSCRIPT = STM32F103x8_0x08006000_bootloader
+BOOTLOADER_TYPE = stm32duino


BOOTLOADER_TYPE = stm32duino can move to info.json

If I move this the compile fails sadly.

bootloader in info.json sets BOOTLOADER, not BOOTLOADER_TYPE, and then for BOOTLOADER = stm32duino it is impossible to override DFU_ARGS and DFU_SUFFIX_ARGS with the proper values that match the custom bootloader used on this PCB.

One possible option here is to specify "bootloader": "custom" (bootloader_jump() as provided by stm32duino.c apparently does not work on this PCB anyway).

Sorry I don't fully follow, would you like me to add "bootloader": "custom" to the info.json?

Sorry I don't fully follow, would you like me to add "bootloader": "custom" to the info.json?

Ideally, yes, and provide a bootloader_jump and mcu_reset function that works correctly with the bootloader that is being used here.

Without the correct functions+handling, that is why bootmagic and QMK_BOOT are not working.

sigprof · 2023-09-10T15:14:44Z

keyboards/qwertykeys/qk65/r2/readme.md

+
+Enter the bootloader in two ways:
+
+* **Bootmagic reset**: Hold down the B key and plug in the keyboard


This is actually not the bootmagic reset (the old “full bootmagic” code did that, but that code had been removed from QMK some time ago). If the “hold down the B key” method actually works on the board flashed with this QMK firmware, that method is actually implemented by the bootloader.

Also apparently the bootmagic reset does not work on this PCB (and neither does QK_BOOT), because the bootloader is not actually stm32duino, and the method to communicate with the bootloader is not actually known? Unfortunately, the code from https://github.com/owlab-git/qmk_firmware/tree/qk65/keyboards/qwertykeys/qk65/r2 does not offer anything better (it also pretends that the bootloader is stm32duino).

If the “hold down the B key” method actually works on the board flashed with this QMK firmware, that method is actually implemented by the bootloader.

Yes this does work, should I call this by a different name? Maybe "Bootloader reset"?

Sadly QK_BOOT indeed does not work, shall I mention this in the readme?

sigprof · 2023-09-10T15:18:37Z

keyboards/qwertykeys/qk65/r2/rules.mk

@@ -0,0 +1,5 @@
+MCU_LDSCRIPT = STM32F103x8_0x08006000_bootloader
+BOOTLOADER_TYPE = stm32duino


bootloader in info.json sets BOOTLOADER, not BOOTLOADER_TYPE, and then for BOOTLOADER = stm32duino it is impossible to override DFU_ARGS and DFU_SUFFIX_ARGS with the proper values that match the custom bootloader used on this PCB.

One possible option here is to specify "bootloader": "custom" (bootloader_jump() as provided by stm32duino.c apparently does not work on this PCB anyway).

keyboards/qwertykeys/qk65/r2/readme.md

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

ForsakenRei

Here's a photo I took from my board reflecting the R2 white PCB, just in case if you want to use.
https://i.imgur.com/hHxxshc.jpg

github-actions · 2023-11-14T02:18:41Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

Siilwyn · 2023-11-14T09:01:40Z

This PR is in progress, need to provide a bootloader_jump and mcu_reset function for the bootloader so GMK_BOOT works. Need help to figure out how to get these though.

drashna · 2023-12-23T08:33:38Z

This PR is in progress, need to provide a bootloader_jump and mcu_reset function for the bootloader so GMK_BOOT works. Need help to figure out how to get these though.

Set the bootloader to custom, and add those functions to a c file for the keyboard.

drashna · 2023-12-23T08:35:03Z

keyboards/qwertykeys/qk65/r2/info.json

+    "processor": "STM32F103",
+    "board": "STM32_F103_STM32DUINO",


Suggested change

"processor": "STM32F103",

"board": "STM32_F103_STM32DUINO",

"development_board": "bluepill",

github-actions · 2024-02-07T01:47:26Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

github-actions · 2024-03-08T01:47:31Z

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.
// [stale-action-closed]

Siilwyn · 2024-03-23T13:55:27Z

@drashna could this PR be merged without the bootloader_jump and mcu_reset functions or are they a requirement?

Siilwyn added 3 commits September 3, 2023 11:02

Add keyboard QK65 R2

98ccf76

Remove redefine of default usb polling rate

81406d3

Fix use of custom bootloader

18ec0a1

github-actions bot added keyboard keymap labels Sep 3, 2023

zvecr requested changes Sep 3, 2023

View reviewed changes

dunk2k suggested changes Sep 4, 2023

View reviewed changes

keyboards/qwertykeys/qk65/r2/info.json Show resolved Hide resolved

keyboards/qwertykeys/qk65/r2/rules.mk Outdated Show resolved Hide resolved

keyboards/qwertykeys/qk65/r2/info.json Show resolved Hide resolved

Siilwyn force-pushed the add-qk65-r2 branch 2 times, most recently from 7fe8b86 to c96e046 Compare September 5, 2023 07:26

Apply suggestions from code review

0937870

Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>

Siilwyn force-pushed the add-qk65-r2 branch from 20d320c to 0937870 Compare September 5, 2023 07:39

Siilwyn requested a review from zvecr September 5, 2023 07:39

haunt98 reviewed Sep 10, 2023

View reviewed changes

sigprof reviewed Sep 10, 2023

View reviewed changes

drashna reviewed Sep 21, 2023

View reviewed changes

keyboards/qwertykeys/qk65/r2/readme.md Outdated Show resolved Hide resolved

Siilwyn and others added 2 commits September 21, 2023 16:46

Use drashna's keyboard image re-upload

481ee48

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

Set bootloader info to custom

c48b73c

ForsakenRei reviewed Sep 24, 2023

View reviewed changes

Use photo showing the R2 white PCB

e69d160

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Nov 14, 2023

github-actions bot removed the stale Issues or pull requests that have become inactive without resolution. label Nov 15, 2023

drashna reviewed Dec 23, 2023

View reviewed changes

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Feb 7, 2024

github-actions bot closed this Mar 8, 2024

Siilwyn mentioned this pull request Jul 4, 2024

Add keyboard QK65 R2 #24050

Draft

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add keyboard QK65 R2 #21896

Add keyboard QK65 R2 #21896

Siilwyn commented Sep 3, 2023 •

edited

Loading

Siilwyn commented Sep 5, 2023

dunk2k commented Sep 5, 2023

haunt98 Sep 10, 2023

Siilwyn Sep 10, 2023

sigprof Sep 10, 2023

Siilwyn Sep 17, 2023

drashna Sep 21, 2023

sigprof Sep 10, 2023

Siilwyn Sep 17, 2023

sigprof Sep 10, 2023

ForsakenRei left a comment •

edited

Loading

github-actions bot commented Nov 14, 2023

Siilwyn commented Nov 14, 2023

drashna commented Dec 23, 2023

drashna Dec 23, 2023

github-actions bot commented Feb 7, 2024

github-actions bot commented Mar 8, 2024

Siilwyn commented Mar 23, 2024

		@@ -0,0 +1,5 @@
		MCU_LDSCRIPT = STM32F103x8_0x08006000_bootloader
		BOOTLOADER_TYPE = stm32duino


		Enter the bootloader in two ways:

		* Bootmagic reset: Hold down the B key and plug in the keyboard

	"processor": "STM32F103",
	"board": "STM32_F103_STM32DUINO",
	"development_board": "bluepill",

Add keyboard QK65 R2 #21896

Add keyboard QK65 R2 #21896

Conversation

Siilwyn commented Sep 3, 2023 • edited Loading

Description

Types of Changes

Checklist

Siilwyn commented Sep 5, 2023

dunk2k commented Sep 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ForsakenRei left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Nov 14, 2023

Siilwyn commented Nov 14, 2023

drashna commented Dec 23, 2023

Choose a reason for hiding this comment

github-actions bot commented Feb 7, 2024

github-actions bot commented Mar 8, 2024

Siilwyn commented Mar 23, 2024

Siilwyn commented Sep 3, 2023 •

edited

Loading

ForsakenRei left a comment •

edited

Loading