Merge pull request #1038 from UltimateHackingKeyboard/master-uhk80

Master uhk80

.gitmodules

@@ -13,6 +13,3 @@
 [submodule "lib/SDK_2.8.0_MKL17Z32xxx4"]
 	path = lib/SDK_2.8.0_MKL17Z32xxx4
 	url = https://github.com/UltimateHackingKeyboard/SDK_2.8.0_MKL17Z32xxx4.git
-[submodule "lib/c2usb"]
-	path = lib/c2usb
-	url = https://github.com/IntergatedCircuits/c2usb.git

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
-    "nrf-connect.toolchain.path": "${nrf-connect.toolchain:2.6.1}",
-    "nrf-connect.topdir": "${nrf-connect.sdk:2.4.1}",
+    "nrf-connect.toolchain.path": "${nrf-connect.toolchain:2.8.0}",
+    "nrf-connect.topdir": "${nrf-connect.sdk:2.8.0}",
     "nrf-connect.applications": [
         "${workspaceFolder}/device"
     ],

.vscode/tasks.json

@@ -5,15 +5,187 @@
 			"label": "Build UHK 60 v2 firmware",
 			"type": "shell",
 			"command": "make",
-			"args": ["${command:cpptools.activeConfigName}"],
+			"args": [
+				"${command:cpptools.activeConfigName}"
+			],
 			"options": {
 				"cwd": "${workspaceFolder}/right/uhk60v2"
 			},
-			"problemMatcher": ["$gcc"],
+			"problemMatcher": [
+				"$gcc"
+			],
 			"group": {
 				"kind": "build",
 				"isDefault": true
 			}
 		},
+		{
+			"label": "Generate UHK versions",
+			"type": "shell",
+			"command": "node",
+			"args": [
+				"scripts/generate-versions.mjs"
+			],
+			"options": {
+				"cwd": "${workspaceFolder}"
+			},
+			"problemMatcher": [],
+			"group": {
+				"kind": "none",
+				"isDefault": true
+			}
+		},
+		{
+			"label": "West update",
+			"group": {
+				"kind": "none",
+				"isDefault": true
+			},
+			"options": {
+				"cwd": "${workspaceFolder}"
+			},
+			"type": "process",
+			"command": "nrfutil",
+			"args": [
+				"toolchain-manager",
+				"launch",
+				"--shell",
+				"--",
+				"west",
+				"update"
+			]
+		},
+		{
+			"label": "West patch",
+			"group": {
+				"kind": "none",
+				"isDefault": true
+			},
+			"options": {
+				"cwd": "${workspaceFolder}"
+			},
+			"type": "process",
+			"command": "nrfutil",
+			"args": [
+				"toolchain-manager",
+				"launch",
+				"--shell",
+				"--",
+				"west",
+				"patch"
+			],
+			"dependsOrder": "sequence",
+			"dependsOn": [
+				"West update"
+			]
+		},
+		{
+			"label": "Build UHK 80 left firmware",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"options": {
+				"cwd": "${workspaceFolder}"
+			},
+			"type": "process",
+			"command": "nrfutil",
+			"args": [
+				"toolchain-manager",
+				"launch",
+				"--shell",
+				"--",
+				"west",
+				"build",
+				"--build-dir",
+				"${cwd}/device/build/uhk-80-left",
+				"${cwd}/device",
+				"--pristine",
+				"--board",
+				"uhk-80-left",
+				"--no-sysbuild",
+				"--",
+				"-DNCS_TOOLCHAIN_VERSION=NONE",
+				"-DCONF_FILE=${cwd}/device/prj.conf",
+				"-DEXTRA_CONF_FILE=${cwd}/device/prj.conf.overlays/nrf_shared.conf;${cwd}/device/prj.conf.overlays/c2usb.conf;${cwd}/device/prj.conf.overlays/uhk-80.conf;${cwd}/device/prj.conf.overlays/ble_nus.conf",
+				"-DBOARD_ROOT=${cwd}",
+				"-Dmcuboot_OVERLAY_CONFIG=${cwd}/device/child_image/mcuboot.conf;${cwd}/device/child_image/uhk-80-left.mcuboot.conf"
+			],
+			"problemMatcher": [
+				"$gcc"
+			]
+		},
+		{
+			"label": "Build UHK 80 right firmware",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"options": {
+				"cwd": "${workspaceFolder}"
+			},
+			"type": "process",
+			"command": "nrfutil",
+			"args": [
+				"toolchain-manager",
+				"launch",
+				"--shell",
+				"--",
+				"west",
+				"build",
+				"--build-dir",
+				"${cwd}/device/build/uhk-80-right",
+				"${cwd}/device",
+				"--pristine",
+				"--board",
+				"uhk-80-right",
+				"--no-sysbuild",
+				"--",
+				"-DNCS_TOOLCHAIN_VERSION=NONE",
+				"-DCONF_FILE=${cwd}/device/prj.conf",
+				"-DEXTRA_CONF_FILE=${cwd}/device/prj.conf.overlays/nrf_shared.conf;${cwd}/device/prj.conf.overlays/c2usb.conf;${cwd}/device/prj.conf.overlays/uhk-80.conf;${cwd}/device/prj.conf.overlays/ble_nus.conf;${cwd}/device/prj.conf.overlays/ble_nus_client.conf;${cwd}/device/prj.conf.overlays/ble_hid.conf",
+				"-DBOARD_ROOT=${cwd}",
+				"-Dmcuboot_OVERLAY_CONFIG=${cwd}/device/child_image/mcuboot.conf;${cwd}/device/child_image/uhk-80-right.mcuboot.conf"
+			],
+			"problemMatcher": [
+				"$gcc"
+			]
+		},
+		{
+			"label": "Build UHK dongle firmware",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"options": {
+				"cwd": "${workspaceFolder}"
+			},
+			"type": "process",
+			"command": "nrfutil",
+			"args": [
+				"toolchain-manager",
+				"launch",
+				"--shell",
+				"--",
+				"west",
+				"build",
+				"--build-dir",
+				"${cwd}/device/build/uhk-dongle",
+				"${cwd}/device",
+				"--pristine",
+				"--board",
+				"uhk-dongle",
+				"--no-sysbuild",
+				"--",
+				"-DNCS_TOOLCHAIN_VERSION=NONE",
+				"-DCONF_FILE=${cwd}/device/prj.conf",
+				"-DEXTRA_CONF_FILE=${cwd}/device/prj.conf.overlays/nrf_shared.conf;${cwd}/device/prj.conf.overlays/c2usb.conf;${cwd}/device/prj.conf.overlays/ble_nus_client.conf",
+				"-DBOARD_ROOT=${cwd}",
+				"-Dmcuboot_OVERLAY_CONFIG=${cwd}/device/child_image/mcuboot.conf;${cwd}/device/child_image/uhk-dongle.mcuboot.conf"
+			],
+			"problemMatcher": [
+				"$gcc"
+			]
+		}
 	]
-}
+}

CMakeLists.txt

@@ -0,0 +1,25 @@
+cmake_minimum_required(VERSION 3.20)
+
+# until https://github.com/zephyrproject-rtos/zephyr/pull/69490 is merged
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fpermissive")
+
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# zephyr's build system doesn't define standard build type symbols, fix that here
+if(NOT CONFIG_DEBUG)
+    add_definitions(-DNDEBUG)
+endif()
+
+if(NOT CONFIG_DEVICE_ID)
+    # uhk code isn't added to bootloader
+    return()
+endif()
+
+project(uhk)
+add_library(${PROJECT_NAME})
+target_link_libraries(${PROJECT_NAME} PUBLIC
+    zephyr_interface
+)
+add_subdirectory(device/src)
+add_subdirectory(right/src)
+add_subdirectory(shared)

README.md

@@ -66,7 +66,7 @@ Then, depending whether you want a full IDE experience or just minimal tools for
 
 - If the `build.sh` doesn't suit you, then launch the nrfutil shell:
     ```
-    nrfutil toolchain-manager launch --shell --ncs-version v2.6.1
+    nrfutil toolchain-manager launch --shell --ncs-version v2.8.0
     ```
 - In the shell, you can build (e.g.) uhk-80-left as follows:
 

boards/arm/uhk-60-right/uhk-60-right.yaml → boards/ugl/uhk-60-right/uhk-60-right.yaml

@@ -19,3 +19,5 @@ supported:
   - spi
   - usb_device
   - watchdog
+
+# TODO: use board revisions: https://docs.zephyrproject.org/latest/hardware/porting/board_porting.html#multiple-board-revisions

boards/ugl/uhk-80/CMakeLists.txt

@@ -0,0 +1,4 @@
+zephyr_library()
+if(CONFIG_DEVICE_ID) # don't add it to bootloader image as well
+    zephyr_library_sources(board.c)
+endif()

boards/ugl/uhk-80/Kconfig.board

@@ -0,0 +1,14 @@
+# Copyright (c) 2023 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+config BOARD_UHK_80_LEFT
+    bool "UHK 80 left"
+    depends on SOC_NRF52840_QIAA
+
+config BOARD_UHK_80_RIGHT
+    bool "UHK 80 right"
+    depends on SOC_NRF52840_QIAA
+
+config BOARD_UHK_DONGLE
+    bool "UHK dongle"
+    depends on SOC_NRF52840_QIAA