[Keyboard] Polarity works CRBN support (#11107)

* Initial CRBN compatibility

Updated readme.md too

* formatting tweaks to meet requirements

* Update crbn.c

* Create readme.md

* Required fixes and licence header

* Fixes

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/crbn/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update crbn.c

* Update keyboards/crbn/crbn.c

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Licence headers

* Create info.json

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* Configurator support

* Update keymap.c

* Update keymap.c

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>

keyboards/crbn/config.h

@@ -0,0 +1,54 @@
+/* Copyright 2020 Harry Herring
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x726F
+#define PRODUCT_ID      0x0002
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Polarity Works
+#define PRODUCT         CRBN
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 12
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { B3, B1, F7, F6 }
+#define MATRIX_COL_PINS { D3, D2, D1, D0, D4, C6, D7, E6, B4, B5, B6, B2 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/*Rotary Encoder Pins*/
+#define ENCODERS_PAD_A { F5 }
+#define ENCODERS_PAD_B { F4 }
+
+/*Sets the number of pulses per increment*/
+#define ENCODER_RESOLUTION 2
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE

keyboards/crbn/crbn.c

@@ -0,0 +1,24 @@
+/* Copyright 2020 Harry Herring
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include "crbn.h"
+/* Encoder setting. only one encoder despite 4 possible spots */
+__attribute__((weak)) void encoder_update_user(uint8_t index, bool clockwise) {
+    if (clockwise) {
+        tap_code(KC_VOLU);
+    } else {
+        tap_code(KC_VOLD);
+    }
+}

keyboards/crbn/crbn.h

@@ -0,0 +1,42 @@
+/* Copyright 2020 Harry Herring
+	*
+	* This program is free software: you can redistribute it and/or modify
+	* it under the terms of the GNU General Public License as published by
+	* the Free Software Foundation, either version 2 of the License, or
+	* (at your option) any later version.
+	*
+	* This program is distributed in the hope that it will be useful,
+	* but WITHOUT ANY WARRANTY; without even the implied warranty of
+	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	* GNU General Public License for more details.
+	*
+	* You should have received a copy of the GNU General Public License
+	* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+	*/
+#pragma once
+
+#include "quantum.h"
+
+#define LAYOUT_crbn_1x2u( \
+		K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, \
+		K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, \
+		K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, \
+		K300, K301, K302, K303, K304,    K305,    K307, K308, K309, K310, K311  \
+) { \
+		{ K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011 }, \
+		{ K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111 }, \
+		{ K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211 }, \
+		{ K300,  K301,  K302,  K303,  K304,  K305, KC_NO,  K307,  K308,  K309,  K310,  K311 }  \
+}
+
+#define LAYOUT_crbn_2x2u( \
+		K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, \
+		K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, \
+		K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, \
+		K300, K301, K302, K303,    K304,       K307,    K308, K309, K310, K311  \
+) { \
+		{ K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011 }, \
+		{ K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111 }, \
+		{ K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211 }, \
+		{ K300,  K301,  K302,  K303,  K304, KC_NO, KC_NO,  K307,  K308,  K309,  K310,  K311 }  \
+}

keyboards/crbn/info.json

@@ -0,0 +1,109 @@
+{
+  "keyboard_name": "CRBN",
+  "keyboard_folder": "crbn",
+  "url": "polarityworks.com",
+  "maintainer": "qmk",
+  "width": 12,
+  "height": 4,
+  "layouts": {
+    "LAYOUT_crbn_1x2u": {
+      "layout": [
+        { "w": 1, "x": 0, "y": 0 },
+        { "w": 1, "x": 1, "y": 0 },
+        { "w": 1, "x": 2, "y": 0 },
+        { "w": 1, "x": 3, "y": 0 },
+        { "w": 1, "x": 4, "y": 0 },
+        { "w": 1, "x": 5, "y": 0 },
+        { "w": 1, "x": 6, "y": 0 },
+        { "w": 1, "x": 7, "y": 0 },
+        { "w": 1, "x": 8, "y": 0 },
+        { "w": 1, "x": 9, "y": 0 },
+        { "w": 1, "x": 10, "y": 0 },
+        { "w": 1, "x": 11, "y": 0 },
+        { "w": 1, "x": 0, "y": 1 },
+        { "w": 1, "x": 1, "y": 1 },
+        { "w": 1, "x": 2, "y": 1 },
+        { "w": 1, "x": 3, "y": 1 },
+        { "w": 1, "x": 4, "y": 1 },
+        { "w": 1, "x": 5, "y": 1 },
+        { "w": 1, "x": 6, "y": 1 },
+        { "w": 1, "x": 7, "y": 1 },
+        { "w": 1, "x": 8, "y": 1 },
+        { "w": 1, "x": 9, "y": 1 },
+        { "w": 1, "x": 10, "y": 1 },
+        { "w": 1, "x": 11, "y": 1 },
+        { "w": 1, "x": 0, "y": 2 },
+        { "w": 1, "x": 1, "y": 2 },
+        { "w": 1, "x": 2, "y": 2 },
+        { "w": 1, "x": 3, "y": 2 },
+        { "w": 1, "x": 4, "y": 2 },
+        { "w": 1, "x": 5, "y": 2 },
+        { "w": 1, "x": 6, "y": 2 },
+        { "w": 1, "x": 7, "y": 2 },
+        { "w": 1, "x": 8, "y": 2 },
+        { "w": 1, "x": 9, "y": 2 },
+        { "w": 1, "x": 10, "y": 2 },
+        { "w": 1, "x": 11, "y": 2 },
+        { "w": 1, "x": 0, "y": 3 },
+        { "w": 1, "x": 1, "y": 3 },
+        { "w": 1, "x": 2, "y": 3 },
+        { "w": 1, "x": 3, "y": 3 },
+        { "w": 1, "x": 4, "y": 3 },
+        { "w": 2, "x": 5, "y": 3 },
+        { "w": 1, "x": 7, "y": 3 },
+        { "w": 1, "x": 8, "y": 3 },
+        { "w": 1, "x": 9, "y": 3 },
+        { "w": 1, "x": 10, "y": 3 },
+        { "w": 1, "x": 11, "y": 3 } ]
+    },
+    "LAYOUT_crbn_2x2u": {
+      "layout": [
+        { "w": 1, "x": 0, "y": 0 },
+        { "w": 1, "x": 1, "y": 0 },
+        { "w": 1, "x": 2, "y": 0 },
+        { "w": 1, "x": 3, "y": 0 },
+        { "w": 1, "x": 4, "y": 0 },
+        { "w": 1, "x": 5, "y": 0 },
+        { "w": 1, "x": 6, "y": 0 },
+        { "w": 1, "x": 7, "y": 0 },
+        { "w": 1, "x": 8, "y": 0 },
+        { "w": 1, "x": 9, "y": 0 },
+        { "w": 1, "x": 10, "y": 0 },
+        { "w": 1, "x": 11, "y": 0 },
+        { "w": 1, "x": 0, "y": 1 },
+        { "w": 1, "x": 1, "y": 1 },
+        { "w": 1, "x": 2, "y": 1 },
+        { "w": 1, "x": 3, "y": 1 },
+        { "w": 1, "x": 4, "y": 1 },
+        { "w": 1, "x": 5, "y": 1 },
+        { "w": 1, "x": 6, "y": 1 },
+        { "w": 1, "x": 7, "y": 1 },
+        { "w": 1, "x": 8, "y": 1 },
+        { "w": 1, "x": 9, "y": 1 },
+        { "w": 1, "x": 10, "y": 1 },
+        { "w": 1, "x": 11, "y": 1 },
+        { "w": 1, "x": 0, "y": 2 },
+        { "w": 1, "x": 1, "y": 2 },
+        { "w": 1, "x": 2, "y": 2 },
+        { "w": 1, "x": 3, "y": 2 },
+        { "w": 1, "x": 4, "y": 2 },
+        { "w": 1, "x": 5, "y": 2 },
+        { "w": 1, "x": 6, "y": 2 },
+        { "w": 1, "x": 7, "y": 2 },
+        { "w": 1, "x": 8, "y": 2 },
+        { "w": 1, "x": 9, "y": 2 },
+        { "w": 1, "x": 10, "y": 2 },
+        { "w": 1, "x": 11, "y": 2 },
+        { "w": 1, "x": 0, "y": 3 },
+        { "w": 1, "x": 1, "y": 3 },
+        { "w": 1, "x": 2, "y": 3 },
+        { "w": 1, "x": 3, "y": 3 },
+        { "w": 2, "x": 4, "y": 3 },
+        { "w": 2, "x": 6, "y": 3 },
+        { "w": 1, "x": 8, "y": 3 },
+        { "w": 1, "x": 9, "y": 3 },
+        { "w": 1, "x": 10, "y": 3 },
+        { "w": 1, "x": 11, "y": 3 } ]
+    }
+  }
+}

keyboards/crbn/keymaps/default/keymap.c

@@ -0,0 +1,45 @@
+/* Copyright 2020 Harry Herring
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+		LAYOUT_crbn_1x2u(
+				KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
+				KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+				KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT,
+				MO(3), KC_LCTL, KC_LALT, KC_LGUI, MO(1), KC_SPC, MO(2), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT),
+
+		LAYOUT_crbn_1x2u(
+				KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_TRNS,
+				KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
+				KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, LSFT(KC_NUHS), LSFT(KC_NUBS), KC_HOME, KC_END, KC_TRNS,
+				KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY),
+
+		LAYOUT_crbn_1x2u(
+				KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_TRNS,
+				KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
+				KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, KC_TRNS,
+				KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY),
+
+		LAYOUT_crbn_1x2u(
+				RESET, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+				KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+				KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+				KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+};

keyboards/crbn/readme.md

@@ -0,0 +1,19 @@
+# CRBN
+
+A compact 40% (12x4) ortholinear keyboard kit made by Polarity Works and sold by keygem
+
+* Keyboard Maintainer: [ReFil](https://github.com/ReFil)
+* Hardware Supported: CRBN kit with a pro micro
+* Hardware Availability: [Keygem](https://keygem.store/collections/group-buys/products/group-buy-featherlight-40-kit)
+
+Support for this keyboard is available in the Polarity Works [discord](https://discord.gg/NysAH3Gser)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make crbn:default
+
+Flashing example for this keyboard:
+
+    make crbn:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

keyboards/crbn/rules.mk

@@ -0,0 +1,23 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = full     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+ENCODER_ENABLE = yes