vial_example: update for vial best practices

keyboards/vial_example/vial_atmega32u4/config.h

@@ -1,117 +1,27 @@
-/*
-Copyright %YEAR% %YOUR_NAME%
-
-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/>.
-*/
+/* SPDX-License-Identifier: GPL-2.0-or-later */
 
 #pragma once
 
-#include "config_common.h"
-
 /* USB Device descriptor parameter */
-#define VENDOR_ID    0xFEED
-#define PRODUCT_ID   0x0000
-#define DEVICE_VER   0x0001
-#define MANUFACTURER Vial
-#define PRODUCT      ATmega32u4 example
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x0000
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Vial
+#define PRODUCT         ATmega32u4 example
 
 /* key matrix size */
 #define MATRIX_ROWS 2
 #define MATRIX_COLS 2
 
-/*
- * Keyboard Matrix Assignments
- *
- * Change this to how you wired your keyboard
- * COLS: AVR pins used for columns, left to right
- * ROWS: AVR pins used for rows, top to bottom
- * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
- *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
- *
- */
 #define MATRIX_ROW_PINS { D7, E6 }
 #define MATRIX_COL_PINS { B4, B5 }
-#define UNUSED_PINS
 
-/* COL2ROW, ROW2COL */
 #define DIODE_DIRECTION COL2ROW
 
-/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
-#define DEBOUNCE 5
-
-/* define if matrix has ghost (lacks anti-ghosting diodes) */
-//#define MATRIX_HAS_GHOST
-
 /* 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
 
-/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
- * This is useful for the Windows task manager shortcut (ctrl+shift+esc).
- */
-//#define GRAVE_ESC_CTRL_OVERRIDE
-
-/*
- * Force NKRO
- *
- * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
- * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
- * makefile for this to work.)
- *
- * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
- * until the next keyboard reset.
- *
- * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
- * fully operational during normal computer usage.
- *
- * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
- * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
- * bootmagic, NKRO mode will always be enabled until it is toggled again during a
- * power-up.
- *
- */
-//#define FORCE_NKRO
-
-/*
- * Feature disable options
- *  These options are also useful to firmware size reduction.
- */
-
-/* disable debug print */
-//#define NO_DEBUG
-
-/* disable print */
-//#define NO_PRINT
-
-/* disable action features */
-//#define NO_ACTION_LAYER
-//#define NO_ACTION_TAPPING
-//#define NO_ACTION_ONESHOT
-
-/* disable these deprecated features by default */
-#define NO_ACTION_MACRO
-#define NO_ACTION_FUNCTION
-
-/* Bootmagic Lite key configuration */
-//#define BOOTMAGIC_LITE_ROW 0
-//#define BOOTMAGIC_LITE_COLUMN 0
-
+/* Use 1000hz polling */
 #define USB_POLLING_INTERVAL_MS 1
-
-#define VIAL_KEYBOARD_UID {0x7B, 0x23, 0xF2, 0xEE, 0xC2, 0x2B, 0xF6, 0x32}
-
-/* top-left and bottom-right keys */
-#define VIAL_UNLOCK_COMBO_ROWS {0, 1}
-#define VIAL_UNLOCK_COMBO_COLS {0, 1}

keyboards/vial_example/vial_atmega32u4/keymaps/default/keymap.c

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@@ -9,15 +11,5 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     [1] = LAYOUT(
         KC_A, KC_B,
         KC_C, KC_D
-    ),
-
-    [2] = LAYOUT(
-        KC_TRNS, KC_TRNS,
-        KC_TRNS, KC_TRNS
-    ),
-
-    [3] = LAYOUT(
-        KC_TRNS, KC_TRNS,
-        KC_TRNS, KC_TRNS
     )
 };

keyboards/vial_example/vial_atmega32u4/keymaps/vial/config.h

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+#define VIAL_KEYBOARD_UID {0x7B, 0x23, 0xF2, 0xEE, 0xC2, 0x2B, 0xF6, 0x32}
+#define VIAL_UNLOCK_COMBO_ROWS {0, 1}
+#define VIAL_UNLOCK_COMBO_COLS {0, 1}

keyboards/vial_example/vial_atmega32u4/keymaps/vial/keymap.c

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

keyboards/vial_example/vial_atmega32u4/vial_atmega32u4.c

@@ -1 +1,3 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include "vial_atmega32u4.h"

keyboards/vial_example/vial_atmega32u4/vial_atmega32u4.h

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #pragma once
 
 #include "quantum.h"

keyboards/vial_example/vial_stm32f072/config.h

@@ -1,19 +1,4 @@
-/*
-Copyright %YEAR% %YOUR_NAME%
-
-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/>.
-*/
+/* SPDX-License-Identifier: GPL-2.0-or-later */
 
 #pragma once
 
@@ -33,20 +18,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #define DIODE_DIRECTION COL2ROW
 
-/* 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
 
-/*
- * Feature disable options
- *  These options are also useful to firmware size reduction.
- */
-
-#define VIAL_KEYBOARD_UID {0xA5, 0x46, 0x30, 0xF2, 0x20, 0xA3, 0xCE, 0x38}
-#define VIAL_UNLOCK_COMBO_ROWS { 0, 1 }
-#define VIAL_UNLOCK_COMBO_COLS { 0, 1 }
-
+/* Use 1000hz polling */
 #define USB_POLLING_INTERVAL_MS 1

keyboards/vial_example/vial_stm32f072/keymaps/default/keymap.c

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@@ -9,15 +11,5 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     [1] = LAYOUT(
         KC_A, KC_B,
         KC_C, KC_D
-    ),
-
-    [2] = LAYOUT(
-        KC_TRNS, KC_TRNS,
-        KC_TRNS, KC_TRNS
-    ),
-
-    [3] = LAYOUT(
-        KC_TRNS, KC_TRNS,
-        KC_TRNS, KC_TRNS
     )
 };

keyboards/vial_example/vial_stm32f072/keymaps/vial/config.h

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+#define VIAL_KEYBOARD_UID {0xA5, 0x46, 0x30, 0xF2, 0x20, 0xA3, 0xCE, 0x38}
+#define VIAL_UNLOCK_COMBO_ROWS { 0, 1 }
+#define VIAL_UNLOCK_COMBO_COLS { 0, 1 }

keyboards/vial_example/vial_stm32f072/keymaps/vial/keymap.c

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

keyboards/vial_example/vial_stm32f072/vial_stm32f072.c

@@ -1 +1,3 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include "vial_stm32f072.h"

keyboards/vial_example/vial_stm32f072/vial_stm32f072.h

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #pragma once
 
 #include "quantum.h"

keyboards/vial_example/vial_stm32f103_vibl/config.h

@@ -1,19 +1,4 @@
-/*
-Copyright %YEAR% %YOUR_NAME%
-
-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/>.
-*/
+/* SPDX-License-Identifier: GPL-2.0-or-later */
 
 #pragma once
 
@@ -33,20 +18,13 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #define DIODE_DIRECTION COL2ROW
 
-/* 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
 
-/*
- * Feature disable options
- *  These options are also useful to firmware size reduction.
- */
-
-#define VIAL_KEYBOARD_UID {0x07, 0x30, 0x3E, 0x60, 0x00, 0x62, 0xA3, 0xD4}
-#define VIAL_UNLOCK_COMBO_ROWS { 0, 1 }
-#define VIAL_UNLOCK_COMBO_COLS { 0, 1 }
-
+/* Use 1000hz polling */
 #define USB_POLLING_INTERVAL_MS 1
+
+/* Because we use vibl, this has to be defined here instead of under keymaps/vial/config.h */
+#define VIAL_KEYBOARD_UID {0x07, 0x30, 0x3E, 0x60, 0x00, 0x62, 0xA3, 0xD4}

keyboards/vial_example/vial_stm32f103_vibl/keymaps/default/keymap.c

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@@ -9,15 +11,5 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     [1] = LAYOUT(
         KC_A, KC_B,
         KC_C, KC_D
-    ),
-
-    [2] = LAYOUT(
-        KC_TRNS, KC_TRNS,
-        KC_TRNS, KC_TRNS
-    ),
-
-    [3] = LAYOUT(
-        KC_TRNS, KC_TRNS,
-        KC_TRNS, KC_TRNS
     )
 };

keyboards/vial_example/vial_stm32f103_vibl/keymaps/vial/config.h

@@ -0,0 +1,6 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+#define VIAL_UNLOCK_COMBO_ROWS { 0, 1 }
+#define VIAL_UNLOCK_COMBO_COLS { 0, 1 }

keyboards/vial_example/vial_stm32f103_vibl/keymaps/vial/keymap.c

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

keyboards/vial_example/vial_stm32f103_vibl/vial_stm32f103_vibl.c

@@ -1 +1,3 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #include "vial_stm32f103_vibl.h"

keyboards/vial_example/vial_stm32f103_vibl/vial_stm32f103_vibl.h

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 #pragma once
 
 #include "quantum.h"