Updated Ducky 2 one mini support

[fishman]

Description

Ducky One 2 Mini RGB - 60% per-key RGB keyboard. This is a full integration for this keyboard into QMK (SPI EEPROM access is still under development).

I've disabled RGB_LIGHT support for now since people seem to want a full rewrite of all the involved components.

Depends on:

Nuvoton support has already been merged to ChibiOS-Contrib

• Nuvoton NUC123SD4AN0 MCU port ChibiOS/ChibiOS-Contrib#226

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Flashing the firmware

This firmware is tested on the duckyon2mini 1861ST version. There are a few different versions.

For the 1861ST to flash you can boot the keyboard while holding D+L.

There are then two ways to flash the keyboard:

1. make ducky/one2mini:default
2. pip install --user nuvoton-isp (https://github.com/fishman/nuvoton_isp)
3. nuvoisp -f ducky_one2mini_default.bin

Alternatively you can use https://lib.rs/crates/nu-isp-cli written in rust instead. Which is more complete than the library I wrote.

Issues Fixed or Closed by This PR

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).

[fishman]

It's based on #5757

[tzarc]

As previously discussed, this PR requires the ChibiOS 20.x upgrade along with the updated ChibiOS-Contrib.

[zvecr]

Or if its a hard requirement, can it be refactored to use custom matrix lite.

[zvecr]

Also a lot of the collapsed suggestions still need to be implemented.

[dannsterr]

is this still a thing?

[elfmimi]

@dannsterr this is relying on this work here → #8976
it has already come long way but still waiting for graceful switching of ChibiOS-Contrib to a chibios-20.3.x based branch.

[shearn89]

Hey - also interested in getting this working and willing to help test, so long as I don't end up with a brick at the moment! I think I just need some help getting the flashing done in a safe-ish fashion... Please reach out if I can be of assistance.

[tzarc]

@dannsterr this is relying on this work here → #8976
it has already come long way but still waiting for graceful switching of ChibiOS-Contrib to a chibios-20.3.x based branch.

Should be in master, now.

[elfmimi]

@fishman It's your turn!

I guess you'll just need these chages.

chconf.h
-#define _CHIBIOS_RT_CONF_VER_6_0_
+#define _CHIBIOS_RT_CONF_VER_6_1_

-#define CH_CFG_USE_DELEGATES                TRUE
+#define CH_CFG_USE_DELEGATES                FALSE

-#define CH_CFG_USE_JOBS                     TRUE
+#define CH_CFG_USE_JOBS                     FALSE


halconf.h
-#define _CHIBIOS_HAL_CONF_VER_7_0_
+#define _CHIBIOS_HAL_CONF_VER_7_1_

config.h
+#define GPIO_INPUT_PIN_DELAY (NUC123_HCLK / 6 / 1000000L)

[shearn89]

@elfmimi - so I had a stab at making those changes myself. I also had to update some chibios submodules (which given @tzarc's comment I half expected). I have to admit I'm a bit out of my depth - I tend to stay the hell away from C normally! I got QMK to compile, but when I try to flash the board I'm getting nowhere... Luckily I'm not bricking my board as I can reflash with the Ducky tools, but flashing the QMK binary output by the build doesn't seem to do anything... Any ideas, or do I have to hope @fishman checks in at some point?

[fishman]

thanks @tzarc

The reason why the RGB driver is disabled is because I've had problems testing the PWM driver when it was rewritten. I'm waiting for some numicro dev boards to arrive, but until then I have no good way to debug that issue. Another issue that's a bit problematic to debug is that the rewritten USB driver seems to work when connected to some USB hubs, but doesn't work when connected to my KVM switch.

[tzarc]

@fishman looks good to go, however there are submodule changes that have apparently gotten picked up (my fault, sorry!)
If we can get those reset to match master I'll approve the merge.

[tzarc]

Another issue that's a bit problematic to debug is that the rewritten USB driver seems to work when connected to some USB hubs, but doesn't work when connected to my KVM switch.

Might want to try this board on develop as well, then -- there has been some fixes recently to do with suspend/wakeup etc.

[tzarc]

That error is caused by the bootloader responding to reset command too fast. I usually don't see this message when I connect the target boards directly to host PCs without hubs in between. If it is connected using hubs, this message shows up almost always.
I'd like to fix it. But exceptional handling of error propagation will likely make the code look messy. So I'm very reluctant.

Obviously it's not essential, but It'd be great if you could -- I think in the future if we're going to be supporting NUC123 as a valid platform, the end-to-end tooling needs to be in place too; this will include providing and hooking up the flashing binaries to the build system, as well as likely bundling prebuilt copies into QMK Toolbox. I'd strongly prefer to not have to inform people "yeah, ignore the error, it's fine" on Discord whenever someone tries to flash a NUC123-based keyboard.

This is because NUC123 do not have USB SOF interrupt. usb_sof_cb() is not being called at all.
In fact the callback do not have to be in sync with USB frames. It just have to be called periodically. So this can be solved by creating console_task() or something to do what usb_sof_cb() does.

Would be great if you could raise a PR for this in due course, especially if you're already sorting out ChibiOS-Contrib and the endpoints issue. Once extra endpoints are available, people are going to want to use them.

[fishman]

Should be fine now @tzarc thanks for looking at it. I'm happy to add Nuvoton support to the build tools, which parts should be changed?

[tzarc]

Thanks!

[tzarc]

I'm happy to add Nuvoton support to the build tools, which parts should be changed?

Long-term we'd be looking at enabling the use of the :flash target as per other boards, which means we'd need to look at either providing binaries, or instructions for procuring them. In some cases packages are upstreamed for different Linux distributions.

Additionally, we'd likely want to provide equivalent prebuilt binaries with QMK Toolbox for both Windows and macOS.

[fishman]

I think if the binary is to be bundled, then it's definitely @elfmimi s rust tool. Python make no sense in that case.

[jpfelgueiras]

Is it possible to add VIA support?

[tzarc]

There was mention of an SPI EEPROM, but there's no SPI peripheral driver. Unfortunately, at the moment, the answer is no.

[dfireBird]

Does this PR support 1861S? If not, can I test it to see if it works?

Also if the keyboard bricks (while testing), if I reflash the stock firmware will the keyboard work again?

[jpfelgueiras]

I had bricked mine and was able to restore with ducky firmware tool

[dfireBird]

So, I flashed (with @elfmimi 's tool), it worked with exception of led backlit (not RGB but white) and it's intentional right?

P.S: I changed the RGB_TOG to BL_TOGG and changed other RGB keys to BL keys.

[kryptiksage]

Does this PR support 1861S? If not, can I test it to see if it works?

Also if the keyboard bricks (while testing), if I reflash the stock firmware will the keyboard work again?

Did you try it in 1861S? I got a ducky one 2 mini horizon

[fufexan]

I can't get my board into bootloader mode. I've tried both on Linux and Windows, with no luck. Not even the ducky firmware tool was able to see it in bootloader mode. I'm wondering whether it has to do with the DIP switches or even the layout profile.

Did anyone have a similar problem, and if so, how did you solve it?

[icyphox]

Any idea on compat with One 2 SF (Mini, but with the arrow cluster etc.)? Will that be a minor addition?

[fauxpark]

If you need help with this board and QMK Firmware, please file a separate issue. This is not the place for support questions.