Zephyr v3.0.0 update

[petejohanson]

WIP, opening as draft for now.

• Write up blog post w/ necessary upgrade instructions, notable changes, etc.
• Test OLEDs
• Tag zmk-docker w/ 3.0 tag and update image tag references in this branch.
• Prep PR to update https:/zmkfirmware/unified-zmk-config-template to use new docker image tag
• User testing.
• Add CDC ACM nodes to other boards for USB logging.
• Fix ZMK_SLEEP.
• Fix shield displays to set the chosen display.

[petejohanson]

Ok, so zephyrproject-rtos/zephyr#43203 is blocking splits right now.

[petejohanson]

I've created zephyrproject-rtos/zephyr#43247 which mostly fixes the split deadlock on my devkit, will test on full keyboard later.

[NCKiser]

Looks like all this needs now is a commit message change!

[petejohanson]

Ok, verified the fix for splits is fully working, typing on a split now using this branch.

Will add a checklist to the top of this for the remaining work.

[petejohanson]

Adding a bullet item, deep sleep doesn't appear to be working.

[petejohanson]

Fixed deep sleep, using the proper new PM state that works as expected on nRF52 and should do the right thing on others like stm32wb, etc.

[jcmkk3]

I was able to successfully build using the 3.0 branch. I have a couple of custom shields, one using the nice!nano v2 with direct pin and the other using the xiao. The only issue that I had was that I had to disable my build with the ble xiao because it doesn't look like it is in this branch. I was using your 2.7 branch previously.

[manna-harbour]

I ran a build with Zephyr v3.0.0 for every keyboard in Miryoku ZMK (a_dux, absolem, ahokore, ahokore, arch36, bastyl, bat43, berylline, ble_chiffre, boardsource5x12, chocv, contra, corne, corne-ish_zen, cradio, crbn, draculad, eek, ergodash, ergotravel, ferris_rev02, gatoraid40, helix, hummingbird, iris, jian, jiran, jorne, kyria, levinson, lily58, microdox, microdox_mod, naked60, one42, osprette, planck_rev6, pockettype, preonic_rev3, pteron36, rebound_v4, reviung39, reviung41, scylla_dmmpcb, sofle, sofle_rgb, splitreus62, tbkmini, technikable, tightyl, viterbi, zaphod, zodiark) and encountered the following build warnings and errors in failed builds for the keyboards listed after each error message below. All other keyboards built without error. All keyboards build without error with ZMK main. Keyboards that require a ZMK fork (corne-ish_zen, ferris_rev02, zaphod) were built with the 3.0 container but with their usual ZMK forks.

devicetree error: 'clock-frequency' is marked as required in 'properties:' in /__w/zmk-config/zmk-config/zephyr/dts/bindings/clock/st,stm32-rcc.yaml, but does not appear in <Node /soc/rcc@40021000 in '/__w/zmk-config/zmk-config/zephyr/misc/empty_file.c'>

• preonic_rev3 (@shurikai)

devicetree error: 'color-mapping' is marked as required in 'properties:' in /__w/zmk-config/zmk-config/zephyr/dts/bindings/led_strip/worldsemi,ws2812-spi.yaml, but does not appear in <Node /soc/spi@40004000/ws2812@0 in '/__w/zmk-config/zmk-config/zephyr/misc/empty_file.c'>

• arch36 (@okke-formsma)
• gatoraid40 (@freya-irl)
• reviung39 (@jshreynolds)
• viterbi (@TheRealFenrir)

node '/vbatt' compatible 'zmk,battery-voltage-divider' has unknown vendor prefix 'zmk'
node '/kscan' compatible 'zmk,kscan-gpio-matrix' has unknown vendor prefix 'zmk'
node '/keymap' compatible 'zmk,keymap' has unknown vendor prefix 'zmk'
warning: USB (defined at /__w/zmk-config/zmk-config/config/boards/shields/ergotravel/Kconfig.defconfig:17, /__w/zmk-config/zmk-config/config/boards/shields/ergotravel/Kconfig.defconfig:17) defined without a type

• ergotravel (@jchenVT)

For the keyboard maintainers mentioned, the migration guide is here: https://deploy-preview-1143--zmk.netlify.app/blog/2022/03/10/zephyr-3-0/.

See below for updated list.

[manna-harbour]

@mmccoyd

I can make this change for nice_nano v1, but for v2 I get the following error. Is a property missing for nice_nano v2?

devicetree error: 'color-mapping' appears in /soc/spi@40004000/ws2812@0 in nice_nano_v2.dts.pre.tmp, but is not declared in 'properties:' in /__w/zmk-config/zmk-config/zephyr/dts/bindings/led_strip/worldsemi,ws2812-spi.yaml

@petejohanson

@mmccoyd Looks like you're not actually building against the 3.0 branch. If checking out locally, be sure to run west update afterwards to pull the new Zephyr changes.

I can confirm that your updated shield builds with nice_nano but fails with nice_nano_v2 The error I get is:

-- Zephyr version: 3.0.0 (/__w/zmk-config/zmk-config/zephyr)
-- Board: nice_nano_v2, Shield(s): hillside_left
devicetree error: 'color-mapping' is marked as required in 'properties:' in /__w/zmk-config/zmk-config/zephyr/dts/bindings/led_strip/worldsemi,ws2812-spi.yaml, but does not appear in <Node /soc/spi@40004000/ws2812@0 in '/__w/zmk-config/zmk-config/zephyr/misc/empty_file.c'>

It might be related to #885.

Also, as I was only testing with nice_nano previously I've re-tested all shields with nice_nano_v2. arch36 (@okke-formsma) and reviung39 (@jshreynolds) fail with nice_nano but build with nice_nano_v2. I've updated the list #1143 (comment).

[mmccoyd]

Hillside now works for nice_nano v1 and v2. Identical file changes to both, which earlier failed for v2 now succeeds for v2, of adding the include and the color-mapping lines. The earlier and current tests were built on GitHub after setting to image: zmkfirmware/zmk-build-arm:stable. Thanks.