feat(shields): Microdox V2 shield definition

* Refactor common parts of the Microdox sheild into a separate file. This is in preparation for adding Microdox V2 as another shield in the same directory.
* Refactor Microdox keymap into a common file in preparation for Microdox V2
* Add Microdox V2 shield definition
* Added a README to explain v1/v2 differences.

app/boards/shields/microdox/Kconfig.defconfig

@@ -1,7 +1,7 @@
 # Copyright (c) 2020 The ZMK Contributors
 # SPDX-License-Identifier: MIT
 
-if SHIELD_MICRODOX_LEFT
+if SHIELD_MICRODOX_LEFT || SHIELD_MICRODOX_V2_LEFT
 
 config ZMK_KEYBOARD_NAME
     default "Microdox"
@@ -11,7 +11,7 @@ config ZMK_SPLIT_ROLE_CENTRAL
 
 endif
 
-if SHIELD_MICRODOX_LEFT || SHIELD_MICRODOX_RIGHT
+if SHIELD_MICRODOX_LEFT || SHIELD_MICRODOX_RIGHT || SHIELD_MICRODOX_V2_LEFT || SHIELD_MICRODOX_V2_RIGHT
 
 config ZMK_SPLIT
     default y

app/boards/shields/microdox/Kconfig.shield

@@ -6,3 +6,9 @@ config SHIELD_MICRODOX_LEFT
 
 config SHIELD_MICRODOX_RIGHT
     def_bool $(shields_list_contains,microdox_right)
+
+config SHIELD_MICRODOX_V2_LEFT
+    def_bool $(shields_list_contains,microdox_v2_left)
+
+config SHIELD_MICRODOX_V2_RIGHT
+    def_bool $(shields_list_contains,microdox_v2_right)

app/boards/shields/microdox/README.md

@@ -0,0 +1,8 @@
+# Microdox
+
+Microdox is a 36 key split keyboard by Boardsource.
+
+Two variants are defined for this shield – V1 and V2. The layout is exactly the same between the
+two. Per [help documentation](https://www.boardsource.xyz/help/6129be4a9c85c6050be190d2), if you
+purchased your PCB before April 2022, use `microdox_left`/`microdox_right`. Otherwise, use
+`microdox_v2_left`/`microdox_v2_right`.

app/boards/shields/microdox/microdox.dtsi

@@ -4,35 +4,12 @@
  * SPDX-License-Identifier: MIT
  */
 
-#include <dt-bindings/zmk/matrix_transform.h>
+#include "microdox_common.dtsi"
 
 / {
-    chosen {
-        zephyr,display = &oled;
-        zmk,kscan = &kscan0;
-        zmk,matrix_transform = &default_transform;
-    };
-
-    default_transform: keymap_transform_0 {
-        compatible = "zmk,matrix-transform";
-        columns = <10>;
-        rows = <4>;
-// | SW1  | SW2  | SW3  | SW4  | SW5  |   | SW5  | SW4  | SW3  | SW2  | SW1  |
-// | SW6  | SW7  | SW8  | SW9  | SW10 |   | SW10 | SW9  | SW8  | SW7  | SW6  |
-// | SW11 | SW12 | SW13 | SW14 | SW15 |   | SW15 | SW14 | SW13 | SW12 | SW11 |
-//               | SW16 | SW17 | SW18 |   | SW18 | SW17 | SW16 |
-        map = <
-RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4)  RC(0,5) RC(0,6) RC(0,7) RC(0,8) RC(0,9)
-RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4)  RC(1,5) RC(1,6) RC(1,7) RC(1,8) RC(1,9)
-RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4)  RC(2,5) RC(2,6) RC(2,7) RC(2,8) RC(2,9)
-                RC(3,2) RC(3,3) RC(3,4)  RC(3,5) RC(3,6) RC(3,7)
-        >;
-    };
-
     kscan0: kscan {
         compatible = "zmk,kscan-gpio-matrix";
         label = "KSCAN";
-
         diode-direction = "col2row";
         row-gpios
             = <&pro_micro 16 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
@@ -40,26 +17,5 @@ RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4)  RC(2,5) RC(2,6) RC(2,7) RC(2,8) RC(2,9)
             , <&pro_micro 8  (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
             , <&pro_micro 9  (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
             ;
-
-    };
-
-    // TODO: per-key RGB node(s)?
-};
-
-&pro_micro_i2c {
-    status = "okay";
-
-    oled: ssd1306@3c {
-        compatible = "solomon,ssd1306fb";
-        reg = <0x3c>;
-        label = "DISPLAY";
-        width = <128>;
-        height = <32>;
-        segment-offset = <0>;
-        page-offset = <0>;
-        display-offset = <0>;
-        multiplex-ratio = <31>;
-        com-sequential;
-        prechargep = <0x22>;
     };
 };

app/boards/shields/microdox/microdox_common.dtsi

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2023 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <dt-bindings/zmk/matrix_transform.h>
+
+/ {
+    chosen {
+        zephyr,display = &oled;
+        zmk,kscan = &kscan0;
+        zmk,matrix_transform = &default_transform;
+
+    };
+
+    default_transform: keymap_transform_0 {
+        compatible = "zmk,matrix-transform";
+        columns = <10>;
+        rows = <4>;
+// | SW1  | SW2  | SW3  | SW4  | SW5  |   | SW5  | SW4  | SW3  | SW2  | SW1  |
+// | SW6  | SW7  | SW8  | SW9  | SW10 |   | SW10 | SW9  | SW8  | SW7  | SW6  |
+// | SW11 | SW12 | SW13 | SW14 | SW15 |   | SW15 | SW14 | SW13 | SW12 | SW11 |
+//               | SW16 | SW17 | SW18 |   | SW18 | SW17 | SW16 |
+        map = <
+RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4)  RC(0,5) RC(0,6) RC(0,7) RC(0,8) RC(0,9)
+RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4)  RC(1,5) RC(1,6) RC(1,7) RC(1,8) RC(1,9)
+RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4)  RC(2,5) RC(2,6) RC(2,7) RC(2,8) RC(2,9)
+                RC(3,2) RC(3,3) RC(3,4)  RC(3,5) RC(3,6) RC(3,7)
+        >;
+    };
+
+    // TODO: per-key RGB node(s)?
+};
+
+&pro_micro_i2c {
+    status = "okay";
+    oled: ssd1306@3c {
+        compatible = "solomon,ssd1306fb";
+        reg = <0x3c>;
+        label = "DISPLAY";
+        width = <128>;
+        height = <32>;
+        segment-offset = <0>;
+        page-offset = <0>;
+        display-offset = <0>;
+        multiplex-ratio = <31>;
+        com-sequential;
+        prechargep = <0x22>;
+    };
+};

app/boards/shields/microdox/microdox_v2.conf

@@ -0,0 +1,6 @@
+# Uncomment the following lines to enable the Microdox RGB Underglow
+# CONFIG_ZMK_RGB_UNDERGLOW=y
+# CONFIG_WS2812_STRIP=y
+
+# Uncomment the following line to enable the Microdox OLED Display
+# CONFIG_ZMK_DISPLAY=y

app/boards/shields/microdox/microdox_v2.dtsi

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2023 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "microdox_common.dtsi"
+
+/ {
+    kscan0: kscan {
+        compatible = "zmk,kscan-gpio-matrix";
+        label = "KSCAN";
+        diode-direction = "col2row";
+    };
+};

app/boards/shields/microdox/microdox_v2.zmk.yml

@@ -0,0 +1,13 @@
+file_format: "1"
+id: microdox_v2
+name: Microdox V2
+type: shield
+url: https://boardsource.xyz/store/5f2e7e4a2902de7151494f92
+requires: [pro_micro]
+exposes: [i2c_oled]
+features:
+  - keys
+  - display
+siblings:
+  - microdox_v2_left
+  - microdox_v2_right

app/boards/shields/microdox/microdox_v2_left.overlay

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "microdox_v2.dtsi"
+
+&kscan0 {
+    col-gpios
+        = <&pro_micro 4  GPIO_ACTIVE_HIGH>
+        , <&pro_micro 6  GPIO_ACTIVE_HIGH>
+        , <&pro_micro 14 GPIO_ACTIVE_HIGH>
+        , <&pro_micro 18 GPIO_ACTIVE_HIGH>
+        , <&pro_micro 19 GPIO_ACTIVE_HIGH>
+        ;
+    row-gpios
+        = <&pro_micro 21 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        , <&pro_micro 0  (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        , <&pro_micro 5  (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        , <&pro_micro 15 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        ;
+};

app/boards/shields/microdox/microdox_v2_right.overlay

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2023 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "microdox.dtsi"
+
+&default_transform {
+    col-offset = <5>;
+};
+
+&oled {
+    segment-remap;
+    com-invdir;
+};
+
+&kscan0 {
+    col-gpios
+        = <&pro_micro 14 GPIO_ACTIVE_HIGH>
+        , <&pro_micro 5  GPIO_ACTIVE_HIGH>
+        , <&pro_micro 6  GPIO_ACTIVE_HIGH>
+        , <&pro_micro 15 GPIO_ACTIVE_HIGH>
+        , <&pro_micro 21 GPIO_ACTIVE_HIGH>
+        ;
+    row-gpios
+        = <&pro_micro 20 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        , <&pro_micro 18 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        , <&pro_micro 19 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        , <&pro_micro 7  (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+        ;
+};