From d85a0f8b6a82f012753a9ce7fa8046622bdd45ab Mon Sep 17 00:00:00 2001 From: Dmitry Kupriyanov Date: Thu, 12 Jan 2023 12:54:57 +0400 Subject: [PATCH] feat(boards): Add support of Dao keyboard --- app/boards/arm/dao/Kconfig | 8 ++ app/boards/arm/dao/Kconfig.board | 12 +++ app/boards/arm/dao/Kconfig.defconfig | 52 ++++++++++ app/boards/arm/dao/board.cmake | 8 ++ app/boards/arm/dao/dao.dtsi | 136 +++++++++++++++++++++++++ app/boards/arm/dao/dao.keymap | 85 ++++++++++++++++ app/boards/arm/dao/dao.yaml | 18 ++++ app/boards/arm/dao/dao.zmk.yml | 15 +++ app/boards/arm/dao/dao_left.dts | 18 ++++ app/boards/arm/dao/dao_left_defconfig | 41 ++++++++ app/boards/arm/dao/dao_right.dts | 22 ++++ app/boards/arm/dao/dao_right_defconfig | 39 +++++++ 12 files changed, 454 insertions(+) create mode 100644 app/boards/arm/dao/Kconfig create mode 100644 app/boards/arm/dao/Kconfig.board create mode 100644 app/boards/arm/dao/Kconfig.defconfig create mode 100644 app/boards/arm/dao/board.cmake create mode 100644 app/boards/arm/dao/dao.dtsi create mode 100644 app/boards/arm/dao/dao.keymap create mode 100644 app/boards/arm/dao/dao.yaml create mode 100644 app/boards/arm/dao/dao.zmk.yml create mode 100644 app/boards/arm/dao/dao_left.dts create mode 100644 app/boards/arm/dao/dao_left_defconfig create mode 100644 app/boards/arm/dao/dao_right.dts create mode 100644 app/boards/arm/dao/dao_right_defconfig diff --git a/app/boards/arm/dao/Kconfig b/app/boards/arm/dao/Kconfig new file mode 100644 index 00000000..4bc7e0de --- /dev/null +++ b/app/boards/arm/dao/Kconfig @@ -0,0 +1,8 @@ +# Copyright (c) 2021 Rafael Yumagulov +# SPDX-License-Identifier: MIT + +config BOARD_ENABLE_DCDC + bool "Enable DCDC mode" + select SOC_DCDC_NRF52X + default y + depends on (BOARD_DAO_LEFT || BOARD_DAO_RIGHT) diff --git a/app/boards/arm/dao/Kconfig.board b/app/boards/arm/dao/Kconfig.board new file mode 100644 index 00000000..accc3e29 --- /dev/null +++ b/app/boards/arm/dao/Kconfig.board @@ -0,0 +1,12 @@ +# Dao board configuration + +# Copyright (c) 2021 Rafael Yumagulov +# SPDX-License-Identifier: MIT + +config BOARD_DAO_LEFT + bool "dao_left" + depends on SOC_NRF52840_QIAA + +config BOARD_DAO_RIGHT + bool "dao_right" + depends on SOC_NRF52840_QIAA diff --git a/app/boards/arm/dao/Kconfig.defconfig b/app/boards/arm/dao/Kconfig.defconfig new file mode 100644 index 00000000..5a2407f0 --- /dev/null +++ b/app/boards/arm/dao/Kconfig.defconfig @@ -0,0 +1,52 @@ +# Copyright (c) 2021 Rafael Yumagulov +# SPDX-License-Identifier: MIT + +if BOARD_DAO_LEFT + + config ZMK_KEYBOARD_NAME + default "Dao" + + config ZMK_SPLIT_BLE_ROLE_CENTRAL + default y + +endif # BOARD_DAO_LEFT + +if BOARD_DAO_RIGHT + + config ZMK_KEYBOARD_NAME + default "Dao Right" + +endif # BOARD_DAO_RIGHT + + +if BOARD_DAO_LEFT || BOARD_DAO_RIGHT + +config BOARD + default "dao" + +config ZMK_SPLIT + default y + +config BT_CTLR + default BT + +config ZMK_BLE + default y + +config ZMK_USB + default y + +config ZMK_BATTERY_VOLTAGE_DIVIDER + default y + +if USB + +config USB_NRFX + default y + +config USB_DEVICE_STACK + default y + +endif # USB + +endif # BOARD_DAO_LEFT || BOARD_DAO_RIGHT diff --git a/app/boards/arm/dao/board.cmake b/app/boards/arm/dao/board.cmake new file mode 100644 index 00000000..677997f2 --- /dev/null +++ b/app/boards/arm/dao/board.cmake @@ -0,0 +1,8 @@ +# +# Copyright (c) 2020 The ZMK Contributors +# SPDX-License-Identifier: MIT +# + +board_runner_args(nrfjprog "--nrf-family=NRF52" "--softreset") +include(${ZEPHYR_BASE}/boards/common/nrfjprog.board.cmake) +include(${ZEPHYR_BASE}/boards/common/blackmagicprobe.board.cmake) diff --git a/app/boards/arm/dao/dao.dtsi b/app/boards/arm/dao/dao.dtsi new file mode 100644 index 00000000..a9011f66 --- /dev/null +++ b/app/boards/arm/dao/dao.dtsi @@ -0,0 +1,136 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +/dts-v1/; +#include + +#include + + +/ { + model = "dao"; + compatible = "dao"; + + chosen { + zephyr,code-partition = &code_partition; + zephyr,sram = &sram0; + zephyr,flash = &flash0; + zmk,kscan = &kscan0; + zmk,matrix_transform = &default_transform; + zmk,battery = &vbatt; + }; + + default_transform: keymap_transform_0 { + compatible = "zmk,matrix-transform"; + columns = <12>; + rows = <4>; + + // | SW19 | SW1 | SW2 | SW3 | SW4 | SW5 | SW6 | | SW6 | SW5 | SW4 | SW3 | SW2 | SW1 | SW19 | + // | | SW7 | SW8 | SW9 | SW10 | SW11 | SW12 | | SW12 | SW11 | SW10 | SW9 | SW8 | SW7 | | + // | | SW13 | SW14 | SW15 | SW16 | SW17 | SW18 | | SW18 | SW17 | SW16 | SW15 | SW14 | SW13 | | + // | | | | | SW20 | SW21 | SW22 | | SW22 | SW21 | SW20 | | | | | + map = < + RC(3,0) RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5) RC(0,11) RC(0,10) RC(0,9) RC(0,8) RC(0,7) RC(0,6) RC(3,6) + RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5) RC(1,11) RC(1,10) RC(1,9) RC(1,8) RC(1,7) RC(1,6) + RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(2,11) RC(2,10) RC(2,9) RC(2,8) RC(2,7) RC(2,6) + RC(3,3) RC(3,4) RC(3,5) RC(3,11) RC(3,10) RC(3,9) + >; + }; + + kscan0: kscan { + compatible = "zmk,kscan-gpio-matrix"; + label = "KSCAN"; + + diode-direction = "col2row"; + row-gpios + = <&gpio0 6 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 4 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 22 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 24 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + ; + }; + + vbatt: vbatt { + compatible = "zmk,battery-voltage-divider"; + label = "VBATT"; + io-channels = <&adc 7>; + output-ohms = <2000000>; + full-ohms = <(2000000 + 820000)>; + }; + +}; + + +&adc { + status = "okay"; +}; + +&gpiote { + status = "okay"; +}; + +&gpio0 { + status = "okay"; +}; + +&gpio1 { + status = "okay"; +}; + +&usbd { + status = "okay"; +}; + +&uart0 { + compatible = "nordic,nrf-uarte"; + status = "okay"; + current-speed = <115200>; + tx-pin = <19>; + rx-pin = <21>; + rts-pin = <23>; + cts-pin = <25>; +}; + + +&flash0 { + /* + * For more information, see: + * http://docs.zephyrproject.org/latest/devices/dts/flash_partitions.html + */ + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + sd_partition: partition@0 { + label = "softdevice"; + reg = <0x00000000 0x00026000>; + }; + code_partition: partition@26000 { + label = "code_partition"; + reg = <0x00026000 0x000c6000>; + }; + + /* + * The flash starting at 0x000ec000 and ending at + * 0x000f3fff is reserved for use by the application. + */ + + /* + * Storage partition will be used by FCB/LittleFS/NVS + * if enabled. + */ + storage_partition: partition@ec000 { + label = "storage"; + reg = <0x000ec000 0x00008000>; + }; + + boot_partition: partition@f4000 { + label = "adafruit_boot"; + reg = <0x000f4000 0x0000c000>; + }; + }; +}; \ No newline at end of file diff --git a/app/boards/arm/dao/dao.keymap b/app/boards/arm/dao/dao.keymap new file mode 100644 index 00000000..cfcddfaa --- /dev/null +++ b/app/boards/arm/dao/dao.keymap @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include +#include +#include + +#define DEF 0 +#define LWR 1 +#define RSE 2 +#define ADJ 3 + +< { quick_tap_ms = <200>; }; +&mt { quick_tap_ms = <200>; }; + +/ { + keymap { + compatible = "zmk,keymap"; + + default_layer { +// ------------------------------------------------------------------------------------------------- +// NOTE: For 44 version you should add map to edge buttons +// ------------------------------------------------------------------------------------------------- +// | | CMD/[ | Q | W | E | R | T | | Y | U | I | O | P | [ | | +// | CTRL/` | A | S | D | F | G | | H | J | K | L | ; | CTRL/' | +// | ALT/- | Z | X | C | V | B | | N | M | , | . | / | ALT/\ | +// | RSE/TAB | SHFT/SPC | LWR/RET | | LWR/ESC | SHFT/BKSP | RSE/DEL | + bindings = < + &none &mt LGUI RBKT &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp LBKT &none + &mt LCTRL GRAVE &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &mt RCTRL SQT + &mt LALT MINUS &kp Z &kp X &kp C &kp V &kp B &kp N &kp M &kp COMMA &kp DOT &kp FSLH &mt RALT BSLH + < RSE TAB &mt LSHFT SPACE < LWR RET < LWR ESC &mt RSHFT BSPC < RSE DEL + >; + }; + lower_layer { +// ------------------------------------------------------------------------------------------------- +// NOTE: For 44 version you should add map to edge buttons +// ------------------------------------------------------------------------------------------------- +// | | CMD/F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 | | +// | CTRL/+ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | CTRL/- | +// | ALT/= | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | ALT | +// | ADJ/TAB | | | | | | ADJ/DEL | + bindings = < + &none &mt LGUI F1 &kp F2 &kp F3 &kp F4 &kp F5 &kp F6 &kp F7 &kp F8 &kp F9 &kp F10 &kp F11 &kp F12 &none + &mt LCTRL PLUS &kp EXCL &kp AT &kp HASH &kp DLLR &kp PRCNT &kp CARET &kp AMPS &kp STAR &kp LPAR &kp RPAR &mt RCTRL MINUS + &mt LALT EQUAL &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0 &kp RALT + < ADJ TAB &trans &trans &trans &trans < ADJ DEL + >; + }; + + raise_layer { +// ------------------------------------------------------------------------------------------------- +// NOTE: For 44 version you should add map to edge buttons +// ------------------------------------------------------------------------------------------------- +// | | CMD/NLCK | / | 7 | 8 | 9 | - | | VOL_UP | HOME | PSCRN | PGUP | SLCK | CAPS | | +// | CTRL/= | * | 4 | 5 | 6 | + | | MUTE | LEFT | UP | RHGT | INS |CTRL/CTXMENU| +// | ALT | 0 | 1 | 2 | 3 | . | | VOL_DN | END | DOWN | PGDN | PAUS | ALT | +// | | | ADJ/ENT | | ADJ/ESC | | | + bindings = < + &none &mt LGUI KP_NUM &kp KP_SLASH &kp KP_N7 &kp KP_N8 &kp KP_N9 &kp KP_MINUS &kp C_VOL_UP &kp HOME &kp PSCRN &kp PG_UP &kp SLCK &kp CLCK &none + &mt LCTRL EQUAL &kp KP_MULTIPLY &kp KP_N4 &kp KP_N5 &kp KP_N6 &kp KP_PLUS &kp C_MUTE &kp LEFT &kp UP &kp RIGHT &kp INS &mt RCTRL K_APP + &kp LALT &kp KP_N0 &kp KP_N1 &kp KP_N2 &kp KP_N3 &kp KP_DOT &kp C_VOL_DN &kp END &kp DOWN &kp PG_DN &kp PAUSE_BREAK &kp RALT + &trans &trans < ADJ RET < ADJ ESC &trans &trans + >; + }; + adjust_layer { +// ------------------------------------------------------------------------------------------------- +// NOTE: For 44 version you should add map to edge buttons +// ------------------------------------------------------------------------------------------------- +// | | BTLDR | | | | | | | | | | | | BTLDR | | +// | BT_CLR | BT0 | BT1 | BT2 | BT3 | BT4 | | BT4 | BT3 | BT2 | BT1 | BT0 | BT_CLR | +// | RST | | | | | | | | | | | | RST | +// | | | | | | | | + bindings = < + &none &bootloader &none &none &none &none &none &none &none &none &none &none &bootloader &none + &bt BT_CLR &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &bt BT_SEL 4 &bt BT_SEL 3 &bt BT_SEL 2 &bt BT_SEL 1 &bt BT_SEL 0 &bt BT_CLR + &reset &none &none &none &none &none &none &none &none &none &none &reset + &trans &none &trans &none &trans &trans + >; + }; + }; +}; diff --git a/app/boards/arm/dao/dao.yaml b/app/boards/arm/dao/dao.yaml new file mode 100644 index 00000000..755b0c90 --- /dev/null +++ b/app/boards/arm/dao/dao.yaml @@ -0,0 +1,18 @@ +identifier: dao +name: Dao +type: keyboard +arch: arm +toolchain: + - zephyr + - gnuarmemb + - xtools +supported: + - adc + - usb_device + - ble + - ieee802154 + - pwm + - watchdog + - kscan + - nvs + - can diff --git a/app/boards/arm/dao/dao.zmk.yml b/app/boards/arm/dao/dao.zmk.yml new file mode 100644 index 00000000..8c3f49be --- /dev/null +++ b/app/boards/arm/dao/dao.zmk.yml @@ -0,0 +1,15 @@ +file_format: "1" +id: dao +name: Dao +url: https://github.com/yumagulovrn/dao-choc-ble +type: board +arch: arm +features: + - keys +outputs: + - usb + - ble +siblings: + - dao_left + - dao_right + diff --git a/app/boards/arm/dao/dao_left.dts b/app/boards/arm/dao/dao_left.dts new file mode 100644 index 00000000..9bb7b6b3 --- /dev/null +++ b/app/boards/arm/dao/dao_left.dts @@ -0,0 +1,18 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include "dao.dtsi" + +&kscan0 { + col-gpios + = <&gpio0 12 GPIO_ACTIVE_HIGH> + , <&gpio1 9 GPIO_ACTIVE_HIGH> + , <&gpio0 8 GPIO_ACTIVE_HIGH> + , <&gpio0 13 GPIO_ACTIVE_HIGH> + , <&gpio0 15 GPIO_ACTIVE_HIGH> + , <&gpio0 20 GPIO_ACTIVE_HIGH> + ; +}; diff --git a/app/boards/arm/dao/dao_left_defconfig b/app/boards/arm/dao/dao_left_defconfig new file mode 100644 index 00000000..7881f6c6 --- /dev/null +++ b/app/boards/arm/dao/dao_left_defconfig @@ -0,0 +1,41 @@ +# SPDX-License-Identifier: MIT + +CONFIG_ZMK_SPLIT_ROLE_CENTRAL=y + +CONFIG_SOC_SERIES_NRF52X=y +CONFIG_SOC_NRF52840_QIAA=y +CONFIG_BOARD_DAO_LEFT=y +CONFIG_ZMK_SPLIT=y +CONFIG_ZMK_SLEEP=y + +# Enable MPU +CONFIG_ARM_MPU=y + +# enable GPIO +CONFIG_GPIO=y + +# Enable writing to flash +CONFIG_USE_DT_CODE_PARTITION=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 + +# Enable external crystal +CONFIG_CLOCK_CONTROL_NRF_K32SRC_XTAL=y +CONFIG_CLOCK_CONTROL_NRF_K32SRC_30PPM=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_ZMK_USB_LOGGING=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_LOG=y +# CONFIG_ZMK_LOG_LEVEL_DBG=y + +# Turn on uf2 build +CONFIG_BUILD_OUTPUT_UF2=y + +# Increase transmit power level +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y diff --git a/app/boards/arm/dao/dao_right.dts b/app/boards/arm/dao/dao_right.dts new file mode 100644 index 00000000..68d8f71a --- /dev/null +++ b/app/boards/arm/dao/dao_right.dts @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2021 Rafael Yumagulov + * + * SPDX-License-Identifier: MIT + */ + +#include "dao.dtsi" + +&default_transform { + col-offset = <6>; +}; + +&kscan0 { + col-gpios + = <&gpio0 12 GPIO_ACTIVE_HIGH> + , <&gpio1 9 GPIO_ACTIVE_HIGH> + , <&gpio0 8 GPIO_ACTIVE_HIGH> + , <&gpio0 13 GPIO_ACTIVE_HIGH> + , <&gpio0 15 GPIO_ACTIVE_HIGH> + , <&gpio0 20 GPIO_ACTIVE_HIGH> + ; +}; diff --git a/app/boards/arm/dao/dao_right_defconfig b/app/boards/arm/dao/dao_right_defconfig new file mode 100644 index 00000000..f743acfe --- /dev/null +++ b/app/boards/arm/dao/dao_right_defconfig @@ -0,0 +1,39 @@ +# SPDX-License-Identifier: MIT + +CONFIG_SOC_SERIES_NRF52X=y +CONFIG_SOC_NRF52840_QIAA=y +CONFIG_BOARD_DAO_RIGHT=y +CONFIG_ZMK_SPLIT=y +CONFIG_ZMK_SLEEP=y + +# Enable MPU +CONFIG_ARM_MPU=y + +# enable GPIO +CONFIG_GPIO=y + +# Enable writing to flash +CONFIG_USE_DT_CODE_PARTITION=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 + +# Enable external crystal +CONFIG_CLOCK_CONTROL_NRF_K32SRC_XTAL=y +CONFIG_CLOCK_CONTROL_NRF_K32SRC_30PPM=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_ZMK_USB_LOGGING=y + +# # Turn on logging, and set ZMK logging to debug output +# CONFIG_LOG=y +# CONFIG_ZMK_LOG_LEVEL_DBG=y + +# Turn on uf2 build +CONFIG_BUILD_OUTPUT_UF2=y + +# Increase transmit power level +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y