[Keyboard] Small Refactor of Duck boards (#5521)

* first [ass at pulling out common duck library functions

* use new library in jetfire

* use new library in duck lightsaver

* use new library in octagon v2

* put Device into the library

* refactor send_value

* refactor send_value and send_color

* use pragma once

* use pragma once

* use pragma once

* use pragma once

* rename backlight_led to indicator_leds to match with other duck boards

* rename enum

* make #define names consistent

* rename ducklib to duck_led

* update rules.mk ?= to =

* put rgb in the correct order

* add debounce debugging printouts

* turn on bootmagic lite and set it to the top left most key commonly programmed as Escape

* add reset key documentation

* fix that typo

* Update keyboards/duck/duck_led/duck_led.c

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* include the correct library

keyboards/duck/eagle_viper/v2/config.h

@@ -15,8 +15,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#ifndef CONFIG_H
-#define CONFIG_H
+#pragma once
 
 #include "config_common.h"
 
@@ -44,6 +43,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define RGB_DI_PIN D6
 #define RGBLED_NUM 17
 
+/* Set to top left most key */
+#define BOOTMAGIC_LITE_ROW 4
+#define BOOTMAGIC_LITE_COLUMN 10
+
 #define TAPPING_TERM 200
 
-#endif

keyboards/duck/eagle_viper/v2/indicator_leds.c

@@ -19,19 +19,13 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include <stdbool.h>
 #include <util/delay.h>
 #include "indicator_leds.h"
-
-#define RES 6000
+#include "duck_led/duck_led.h"
 
 #define LED_T1H	600
 #define LED_T1L 650
 #define LED_T0H 250
 #define LED_T0L 1000
 
-#define NS_PER_SEC (1000000000L)
-#define CYCLES_PER_SEC (F_CPU)
-#define NS_PER_CYCLE (NS_PER_SEC / CYCLES_PER_SEC)
-#define NS_TO_CYCLES(n) ((n) / NS_PER_CYCLE)
-
 void send_bit_d4(bool bitVal) {
   if(bitVal) {
     asm volatile (
@@ -66,14 +60,12 @@ void send_bit_d4(bool bitVal) {
   }
 }
 
-void show(void) {
-  _delay_us((RES / 1000UL) + 1);
-}
-
-void send_value(uint8_t byte) {
+void send_value(uint8_t byte, enum Device device) {
   for(uint8_t b = 0; b < 8; b++) {
-    send_bit_d4(byte & 0b10000000);
-    byte <<= 1;
+    if(device == Device_STATUSLED) {
+      send_bit_d4(byte & 0b10000000);
+      byte <<= 1;
+    }
   }
 }
 
@@ -83,7 +75,8 @@ void indicator_leds_set(bool leds[8]) {
 
   cli();
   for(led_cnt = 0; led_cnt < 8; led_cnt++)
-    send_value(leds[led_cnt] ? 255 : 0);
+    send_value(leds[led_cnt] ? 255 : 0, Device_STATUSLED);
   sei();
   show();
 }
+

keyboards/duck/eagle_viper/v2/indicator_leds.h

@@ -1,2 +1 @@
 void indicator_leds_set(bool leds[8]);
-void show(void);

keyboards/duck/eagle_viper/v2/matrix.c

@@ -89,6 +89,9 @@ uint8_t matrix_scan(void) {
       bool curr_bit = rows & (1<<row);
       if (prev_bit != curr_bit) {
         matrix_debouncing[row] ^= ((matrix_row_t)1<<col);
+        if (debouncing) {
+            dprint("bounce!: "); dprintf("%02X", debouncing); dprintln();
+        }
         debouncing = DEBOUNCING_DELAY;
       }
     }

keyboards/duck/eagle_viper/v2/readme.md

@@ -11,6 +11,8 @@ Make example for this keyboard (after setting up your build environment):
 
     make eagle_viper/v2:default
 
+**Reset Key:** To put the Eagle/Viper V2 into reset, hold caps lock key (`K2A`) while plugging in. 
+
 See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
 
 ## Hardware Notes

keyboards/duck/eagle_viper/v2/rules.mk

@@ -50,23 +50,23 @@ OPT_DEFS += -DBOOTLOADER_SIZE=4096
 # Build Options
 #   change yes to no to disable
 #
-BOOTMAGIC_ENABLE ?= no       # Virtual DIP switch configuration(+1000)
-MOUSEKEY_ENABLE ?= no        # Mouse keys(+4700)
-EXTRAKEY_ENABLE ?= yes       # Audio control and System control(+450)
-CONSOLE_ENABLE ?= no         # Console for debug(+400)
-COMMAND_ENABLE ?= yes        # Commands for debug and configuration
+BOOTMAGIC_ENABLE = lite       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = no         # Console for debug(+400)
+COMMAND_ENABLE = yes        # 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
+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 ?= yes      # Enable keyboard backlight functionality on B7 by default
-MIDI_ENABLE ?= no            # MIDI support (+2400 to 4200, depending on config)
-UNICODE_ENABLE ?= no         # Unicode
-BLUETOOTH_ENABLE ?= no       # Enable Bluetooth with the Adafruit EZ-Key HID
-AUDIO_ENABLE ?= no           # Audio output on port C6
-FAUXCLICKY_ENABLE ?= no      # Use buzzer to emulate clicky switches
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality on B7 by default
+MIDI_ENABLE = no            # MIDI support (+2400 to 4200, depending on config)
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no           # Audio output on port C6
+FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
 RGBLIGHT_ENABLE = yes
 
 CUSTOM_MATRIX = yes
 SRC += indicator_leds.c \
-			 matrix.c
+			 matrix.c duck_led/duck_led.c

keyboards/duck/eagle_viper/v2/v2.h

@@ -13,8 +13,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#ifndef V2_H
-#define V2_H
+#pragma once
 
 #include "quantum.h"
 
@@ -78,4 +77,3 @@
 
 #define LAYOUT_eagle LAYOUT_60_ansi
 
-#endif