Merge 42835a8bd8 into b74cd39ab5

app/boards/arm/nrf52dk_nrf52832/CMakeLists.txt

@@ -0,0 +1,3 @@
+zephyr_library()
+zephyr_library_sources(custom_runtime_code.c)
+zephyr_library_include_directories(${ZEPHYR_BASE}/drivers)

app/boards/arm/nrf52dk_nrf52832/Kconfig

@@ -0,0 +1,13 @@
+# nRF52 DK board configuration
+
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+config BOARD_ENABLE_DCDC
+	bool "Enable DCDC mode"
+	select SOC_DCDC_NRF52X
+	default y
+	depends on BOARD_NRF52DK_NRF52832

app/boards/arm/nrf52dk_nrf52832/Kconfig.board

@@ -0,0 +1,11 @@
+# nRF52 DK NRF52832 board configuration
+
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+config BOARD_NRF52DK_NRF52832
+	bool "nRF52 DK NRF52832"
+	depends on SOC_NRF52832_QFAA

app/boards/arm/nrf52dk_nrf52832/Kconfig.defconfig

@@ -0,0 +1,19 @@
+# nRF52 DK NRF52832 board configuration
+
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+config BOARD
+	default "nrf52dk_nrf52832"
+
+config ZMK_KEYBOARD_NAME
+	default "nrf52dk_nrf52832"
+	
+config BT_CTLR
+default BT
+
+config ZMK_BLE
+	default y

app/boards/arm/nrf52dk_nrf52832/README.md

@@ -0,0 +1,21 @@
+# NRF52 DK
+
+This is a sample self-contained ZMK board that is built for the ubiquitous NRF52 DK from Nordic. This can help jumpstart new board projects for people by showcasing various features on a known standard
+
+You should be able to use this by plugging in an NRF52 DK, turning on the power switch, then running the following from the zmk/app folder:
+
+````
+west build --pristine -b nrf52dk_nrf52832  && west flash
+````
+
+## Features
+
+- BLE functionality
+- Simple keymap with modifiers
+- Direct GPIO kscan
+- Additonal custom code alongside ZMK runtime
+- Connection LED
+
+##  Other details
+
+Many of the files are from zmk/zepjhyr/boards/arm/nrf52dk_nrf52832, with additional modifications for ZMK.

app/boards/arm/nrf52dk_nrf52832/board.cmake

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+
+board_runner_args(jlink "--device=nrf52" "--speed=4000")
+board_runner_args(pyocd "--target=nrf52" "--frequency=4000000")
+include(${ZEPHYR_BASE}/boards/common/nrfjprog.board.cmake)
+include(${ZEPHYR_BASE}/boards/common/jlink.board.cmake)
+include(${ZEPHYR_BASE}/boards/common/pyocd.board.cmake)
+include(${ZEPHYR_BASE}/boards/common/openocd-nrf5.board.cmake)

app/boards/arm/nrf52dk_nrf52832/custom_runtime_code.c

@@ -0,0 +1,136 @@
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <bluetooth/conn.h>
+#include <kernel.h>
+#include <device.h>
+#include <init.h>
+#include <drivers/gpio.h>
+#include <sys/sys_io.h>
+#include <devicetree.h>
+
+#define SW0_NODE	DT_ALIAS(sw0)
+#if !DT_NODE_HAS_STATUS(SW0_NODE, okay)
+#error "Unsupported board: sw0 devicetree alias is not defined"
+#endif
+static const struct gpio_dt_spec _button = GPIO_DT_SPEC_GET_OR(SW0_NODE, gpios,
+							      {0});
+static const struct gpio_dt_spec led_one = GPIO_DT_SPEC_GET_OR(DT_ALIAS(led0), gpios,
+						     {0});
+static const struct gpio_dt_spec led_two = GPIO_DT_SPEC_GET_OR(DT_ALIAS(led1), gpios,
+						     {0});
+
+/**
+ * Set up an LED DT Spec, default off
+ */
+void configure_led(struct gpio_dt_spec l) {
+	int ret = 0;
+	if (l.port && !device_is_ready(l.port)) {
+		printk("Error %d: LED device %s is not ready; ignoring it\n",
+		       ret, l.port->name);
+		l.port = NULL;
+	}
+	if (l.port) {
+		ret = gpio_pin_configure_dt(&l, (GPIO_OUTPUT | GPIO_OUTPUT_LOW));
+		if (ret != 0) {
+			printk("Error %d: failed to configure LED device %s pin %d\n",
+			       ret, l.port->name, l.pin);
+			l.port = NULL;
+		} else {
+			printk("Set up LED at %s pin %d\n", l.port->name, l.pin);
+		}
+	}
+}
+
+static struct gpio_callback button_cb_data;
+/**
+ * When the button is pressed, toggle an LED
+ */
+void button_pressed(const struct device *dev, struct gpio_callback *cb,
+		    uint32_t pins)
+{
+	printk("Button pressed at %" PRIu32 "\n", k_cycle_get_32());
+	gpio_pin_toggle_dt(&led_two);
+}
+
+/**
+ * Configure a button to be clickable and callback to a method
+ */
+void configure_button(struct gpio_dt_spec button) {
+	if (!device_is_ready(button.port)) {
+		printk("Error: button device %s is not ready\n",
+		       button.port->name);
+		return;
+	}
+
+	int ret = gpio_pin_configure_dt(&button, GPIO_INPUT);
+	if (ret != 0) {
+		printk("Error %d: failed to configure %s pin %d\n",
+		       ret, button.port->name, button.pin);
+		return;
+	}
+
+	ret = gpio_pin_interrupt_configure_dt(&button,
+					      GPIO_INT_EDGE_TO_ACTIVE);
+	if (ret != 0) {
+		printk("Error %d: failed to configure interrupt on %s pin %d\n",
+			ret, button.port->name, button.pin);
+		return;
+	}
+	gpio_init_callback(&button_cb_data, button_pressed, BIT(button.pin));
+	gpio_add_callback(button.port, &button_cb_data);
+	printk("Set up button at %s pin %d\n", button.port->name, button.pin);
+
+}
+
+/**
+ * When the BT is connected, turn on an LED
+ */
+static void connected(struct bt_conn *conn, uint8_t err)
+{
+	if (err) {
+		printk("Connection failed (err 0x%02x)\n", err);
+		int err = gpio_pin_set_dt(&led_one, 0);
+		if (err) {
+			printk("LED Set failed (err 0x%02x)\n", err);
+		}
+	} else {
+		int err = gpio_pin_set_dt(&led_one, 1);
+		if (err) {
+			printk("LED Set failed (err 0x%02x)\n", err);
+		}
+		printk("Connected\n");
+	}
+}
+
+/**
+ * When the BT is disconnected, turn o ff an LED
+ */
+static void disconnected(struct bt_conn *conn, uint8_t reason)
+{
+		int err = gpio_pin_set_dt(&led_one, 0);
+		if (err) {
+			printk("LED Set failed (err 0x%02x)\n", err);
+		}
+	printk("Disconnected (reason 0x%02x)\n", reason);
+}
+
+// Configure the connection callbacks
+BT_CONN_CB_DEFINE(conn_callbacks) = {
+	.connected = connected,
+	.disconnected = disconnected,
+};
+
+
+static int init(const struct device *port) {
+	configure_led(led_one);
+	configure_led(led_two);
+	configure_button(_button);
+
+	return 0;	
+}
+
+SYS_INIT(init, APPLICATION, CONFIG_APPLICATION_INIT_PRIORITY);

app/boards/arm/nrf52dk_nrf52832/nrf52dk_nrf52832.dts

@@ -0,0 +1,236 @@
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+/dts-v1/;
+#include <nordic/nrf52832_qfaa.dtsi>
+
+/ {
+	model = "Nordic nRF52 DK NRF52832";
+	compatible = "nordic,nrf52-dk-nrf52832";
+	kscan0: kscan {
+		compatible = "zmk,kscan-gpio-direct";
+		label = "KSCAN";
+
+		input-gpios
+		= <&gpio0 13 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
+			, <&gpio0 14 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
+			, <&gpio0 15 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
+			, <&gpio0 16 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
+		;	
+	};
+
+	chosen {
+		zephyr,console = &uart0;
+		zephyr,shell-uart = &uart0;
+		zephyr,uart-mcumgr = &uart0;
+		zephyr,bt-mon-uart = &uart0;
+		zephyr,bt-c2h-uart = &uart0;
+		zephyr,sram = &sram0;
+		zephyr,flash = &flash0;
+		zephyr,code-partition = &slot0_partition;
+		zmk,kscan = &kscan0;
+	};
+
+	leds {
+		compatible = "gpio-leds";
+		led0: led_0 {
+			gpios = <&gpio0 17 GPIO_ACTIVE_LOW>;
+			label = "Green LED 0";
+		};
+		led1: led_1 {
+			gpios = <&gpio0 18 GPIO_ACTIVE_LOW>;
+			label = "Green LED 1";
+		};
+		led2: led_2 {
+			gpios = <&gpio0 19 GPIO_ACTIVE_LOW>;
+			label = "Green LED 2";
+		};
+		led3: led_3 {
+			gpios = <&gpio0 20 GPIO_ACTIVE_LOW>;
+			label = "Green LED 3";
+		};
+	};
+
+	pwmleds {
+		compatible = "pwm-leds";
+		pwm_led0: pwm_led_0 {
+			pwms = <&pwm0 17>;
+		};
+	};
+
+	buttons {
+		compatible = "gpio-keys";
+		button0: button_0 {
+			gpios = <&gpio0 13 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
+			label = "Push button switch 0";
+		};
+		button1: button_1 {
+			gpios = <&gpio0 14 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
+			label = "Push button switch 1";
+		};
+		button2: button_2 {
+			gpios = <&gpio0 15 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
+			label = "Push button switch 2";
+		};
+		button3: button_3 {
+			gpios = <&gpio0 16 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
+			label = "Push button switch 3";
+		};
+	};
+
+	arduino_header: connector {
+		compatible = "arduino-header-r3";
+		#gpio-cells = <2>;
+		gpio-map-mask = <0xffffffff 0xffffffc0>;
+		gpio-map-pass-thru = <0 0x3f>;
+		gpio-map = <0 0 &gpio0 3 0>,	/* A0 */
+			   <1 0 &gpio0 4 0>,	/* A1 */
+			   <2 0 &gpio0 28 0>,	/* A2 */
+			   <3 0 &gpio0 29 0>,	/* A3 */
+			   <4 0 &gpio0 30 0>,	/* A4 */
+			   <5 0 &gpio0 31 0>,	/* A5 */
+			   <6 0 &gpio0 11 0>,	/* D0 */
+			   <7 0 &gpio0 12 0>,	/* D1 */
+			   <8 0 &gpio0 13 0>,	/* D2 */
+			   <9 0 &gpio0 14 0>,	/* D3 */
+			   <10 0 &gpio0 15 0>,	/* D4 */
+			   <11 0 &gpio0 16 0>,	/* D5 */
+			   <12 0 &gpio0 17 0>,	/* D6 */
+			   <13 0 &gpio0 18 0>,	/* D7 */
+			   <14 0 &gpio0 19 0>,	/* D8 */
+			   <15 0 &gpio0 20 0>,	/* D9 */
+			   <16 0 &gpio0 22 0>,	/* D10 */
+			   <17 0 &gpio0 23 0>,	/* D11 */
+			   <18 0 &gpio0 24 0>,	/* D12 */
+			   <19 0 &gpio0 25 0>,	/* D13 */
+			   <20 0 &gpio0 26 0>,	/* D14 */
+			   <21 0 &gpio0 27 0>;	/* D15 */
+	};
+
+	arduino_adc: analog-connector {
+		compatible = "arduino,uno-adc";
+		#io-channel-cells = <1>;
+		io-channel-map = <0 &adc 1>,	/* A0 = P0.3 = AIN1 */
+				 <1 &adc 2>,	/* A1 = P0.4 = AIN2 */
+				 <2 &adc 4>,	/* A2 = P0.28 = AIN4 */
+				 <3 &adc 5>,	/* A3 = P0.29 = AIN5 */
+				 <4 &adc 6>,	/* A4 = P0.30 = AIN6 */
+				 <5 &adc 7>;	/* A5 = P0.31 = AIN7 */
+	};
+
+	/* These aliases are provided for compatibility with samples */
+	aliases {
+		led0 = &led0;
+		led1 = &led1;
+		led2 = &led2;
+		led3 = &led3;
+		pwm-led0 = &pwm_led0;
+		sw0 = &button0;
+		sw1 = &button1;
+		sw2 = &button2;
+		sw3 = &button3;
+		bootloader-led0 = &led0;
+	};
+};
+
+&adc {
+	status = "okay";
+};
+
+&gpiote {
+	status = "okay";
+};
+
+&gpio0 {
+	status = "okay";
+};
+
+arduino_serial: &uart0 {
+	status = "okay";
+	compatible = "nordic,nrf-uarte";
+	current-speed = <115200>;
+	tx-pin = <6>;
+	rx-pin = <8>;
+	rts-pin = <5>;
+	cts-pin = <7>;
+};
+
+arduino_i2c: &i2c0 {
+	compatible = "nordic,nrf-twi";
+	status = "okay";
+	sda-pin = <26>;
+	scl-pin = <27>;
+};
+
+&i2c1 {
+	compatible = "nordic,nrf-twi";
+	/* Cannot be used together with spi1. */
+	/* status = "okay"; */
+	sda-pin = <30>;
+	scl-pin = <31>;
+};
+
+&pwm0 {
+	status = "okay";
+	ch0-pin = <17>;
+	ch0-inverted;
+};
+
+&spi0 {
+	compatible = "nordic,nrf-spi";
+	/* Cannot be used together with i2c0. */
+	/* status = "okay"; */
+	sck-pin = <27>;
+	mosi-pin = <26>;
+	miso-pin = <28>;
+};
+
+&spi1 {
+	compatible = "nordic,nrf-spi";
+	status = "okay";
+	sck-pin = <31>;
+	mosi-pin = <30>;
+	miso-pin = <29>;
+};
+
+arduino_spi: &spi2 {
+	compatible = "nordic,nrf-spi";
+	status = "okay";
+	sck-pin = <25>;
+	mosi-pin = <23>;
+	miso-pin = <24>;
+	cs-gpios = <&arduino_header 16 GPIO_ACTIVE_LOW>; /* D10 */
+};
+
+&flash0 {
+
+	partitions {
+		compatible = "fixed-partitions";
+		#address-cells = <1>;
+		#size-cells = <1>;
+
+		boot_partition: partition@0 {
+			label = "mcuboot";
+			reg = <0x00000000 0xc000>;
+		};
+		slot0_partition: partition@c000 {
+			label = "image-0";
+			reg = <0x0000C000 0x32000>;
+		};
+		slot1_partition: partition@3e000 {
+			label = "image-1";
+			reg = <0x0003E000 0x32000>;
+		};
+		scratch_partition: partition@70000 {
+			label = "image-scratch";
+			reg = <0x00070000 0xa000>;
+		};
+		storage_partition: partition@7a000 {
+			label = "storage";
+			reg = <0x0007a000 0x00006000>;
+		};
+	};
+};

app/boards/arm/nrf52dk_nrf52832/nrf52dk_nrf52832.keymap

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2022 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <behaviors.dtsi>
+#include <dt-bindings/zmk/bt.h>
+#include <dt-bindings/zmk/keys.h>
+#include <dt-bindings/zmk/outputs.h>
+
+/ {
+	keymap {
+		compatible = "zmk,keymap";
+		default_layer {
+			bindings = <
+		  &kp Z &kp M &kp K &kp LEFT_SHIFT 
+		  >;
+		};
+	};
+};

app/boards/arm/nrf52dk_nrf52832/nrf52dk_nrf52832.yaml

@@ -0,0 +1,23 @@
+identifier: nrf52dk_nrf52832
+name: nRF52-DK-NRF52832
+type: mcu
+arch: arm
+toolchain:
+  - zephyr
+  - gnuarmemb
+  - xtools
+ram: 64
+flash: 512
+supported:
+  - adc
+  - arduino_gpio
+  - arduino_i2c
+  - arduino_spi
+  - ble
+  - gpio
+  - counter
+  - nvs
+  - i2c
+  - pwm
+  - spi
+  - watchdog

app/boards/arm/nrf52dk_nrf52832/nrf52dk_nrf52832.zmk.yaml

@@ -0,0 +1,12 @@
+file_format: "1"
+id: nrf52dk_nrf52832
+name: nrf52dk_nrf52832
+type: board
+arch: arm
+features:
+  - keys
+  - ble
+outputs:
+  - usb
+  - ble
+url: https://nicekeyboards.com/nice-60

app/boards/arm/nrf52dk_nrf52832/nrf52dk_nrf52832_defconfig

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+
+CONFIG_SOC_SERIES_NRF52X=y
+CONFIG_SOC_NRF52832_QFAA=y
+CONFIG_BOARD_NRF52DK_NRF52832=y
+# CONFIG_BUILD_OUTPUT_UF2=y
+
+CONFIG_ZMK_KSCAN_DIRECT_POLLING=y	
+CONFIG_ZMK_BLE=y
+# CONFIG_LOG=y #causes crashes
+# CONFIG_LOG_BACKEND_SHOW_COLOR=n
+# CONFIG_ZMK_LOG_LEVEL_DBG=y
+# CONFIG_DEBUG=y
+CONFIG_MAIN_STACK_SIZE=2048
+CONFIG_ISR_STACK_SIZE=2048
+
+# Enable MPU
+CONFIG_ARM_MPU=y
+
+# Enable hardware stack protection
+CONFIG_HW_STACK_PROTECTION=y
+
+# Enable RTT
+CONFIG_USE_SEGGER_RTT=y
+
+# enable GPIO
+CONFIG_GPIO=y
+
+# enable uart driver
+CONFIG_SERIAL=y
+
+# enable console
+CONFIG_CONSOLE=y
+CONFIG_UART_CONSOLE=y
+
+# additional board options
+CONFIG_GPIO_AS_PINRESET=y
+
+CONFIG_MPU_ALLOW_FLASH_WRITE=y
+CONFIG_NVS=y
+CONFIG_SETTINGS_NVS=y
+CONFIG_FLASH=y
+CONFIG_FLASH_PAGE_LAYOUT=y
+CONFIG_FLASH_MAP=y