From cb2f2fd258011e6637ed182f484a4317ac510db8 Mon Sep 17 00:00:00 2001
From: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
Date: Wed, 3 Apr 2019 10:17:25 -0700
Subject: [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/octagon/v1/config.h         |  9 ++++----
 keyboards/duck/octagon/v1/matrix.c         |  3 +++
 keyboards/duck/octagon/v1/rules.mk         | 26 ++++++++++-----------
 keyboards/duck/octagon/v1/v1.h             |  4 +---
 keyboards/duck/octagon/v2/config.h         |  8 ++++---
 keyboards/duck/octagon/v2/indicator_leds.c | 36 +++++++++++-------------------
 keyboards/duck/octagon/v2/indicator_leds.h |  6 +----
 keyboards/duck/octagon/v2/matrix.c         |  3 +++
 keyboards/duck/octagon/v2/readme.md        |  2 ++
 keyboards/duck/octagon/v2/rules.mk         | 28 +++++++++++------------
 keyboards/duck/octagon/v2/v2.h             |  4 +---
 11 files changed, 61 insertions(+), 68 deletions(-)

(limited to 'keyboards/duck/octagon')

diff --git a/keyboards/duck/octagon/v1/config.h b/keyboards/duck/octagon/v1/config.h
index 5400c53ef..d818cb622 100644
--- a/keyboards/duck/octagon/v1/config.h
+++ b/keyboards/duck/octagon/v1/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,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define RGB_DI_PIN D6
 #define RGBLED_NUM 17
 
-#define TAPPING_TERM 200
+/* Set to top left most key */
+#define BOOTMAGIC_LITE_ROW 5
+#define BOOTMAGIC_LITE_COLUMN 10
 
-#endif
+#define TAPPING_TERM 200
diff --git a/keyboards/duck/octagon/v1/matrix.c b/keyboards/duck/octagon/v1/matrix.c
index 855534994..233404ed3 100644
--- a/keyboards/duck/octagon/v1/matrix.c
+++ b/keyboards/duck/octagon/v1/matrix.c
@@ -84,6 +84,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;
       }
     }
diff --git a/keyboards/duck/octagon/v1/rules.mk b/keyboards/duck/octagon/v1/rules.mk
index a08695b50..66d2c8def 100644
--- a/keyboards/duck/octagon/v1/rules.mk
+++ b/keyboards/duck/octagon/v1/rules.mk
@@ -50,21 +50,21 @@ 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 ?= no        # 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 = no        # 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
diff --git a/keyboards/duck/octagon/v1/v1.h b/keyboards/duck/octagon/v1/v1.h
index d89188f22..471a91a33 100644
--- a/keyboards/duck/octagon/v1/v1.h
+++ b/keyboards/duck/octagon/v1/v1.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 V1_H
-#define V1_H
+#pragma once
 
 #include "quantum.h"
 
@@ -49,4 +48,3 @@
   { K1A, K1C, K1D, K1E,   K1F,   K1G, K1H,   K1I,   K1J, K1K, K1L, KC_NO, K1M,   K1N, KC_NO, K1P }, \
   { K0A, K0B, K0C, KC_NO, KC_NO, K0G, KC_NO, KC_NO, K0J, K0K, K0L, KC_NO, K0M,   K0N, KC_NO, K0P }  \
 }
-#endif
diff --git a/keyboards/duck/octagon/v2/config.h b/keyboards/duck/octagon/v2/config.h
index 78d18d3bb..4aab587f6 100644
--- a/keyboards/duck/octagon/v2/config.h
+++ b/keyboards/duck/octagon/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 5
+#define BOOTMAGIC_LITE_COLUMN 10
+
 #define TAPPING_TERM 200
 
-#endif
diff --git a/keyboards/duck/octagon/v2/indicator_leds.c b/keyboards/duck/octagon/v2/indicator_leds.c
index c24509f51..116306fb7 100644
--- a/keyboards/duck/octagon/v2/indicator_leds.c
+++ b/keyboards/duck/octagon/v2/indicator_leds.c
@@ -20,16 +20,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include <util/delay.h>
 #include "indicator_leds.h"
 
-#define T1H  900
-#define T1L  600
-#define T0H  400
-#define T0L  900
-#define RES 6000
-
-#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)
+#define LED_T1H  900
+#define LED_T1L  600
+#define LED_T0H  400
+#define LED_T0L  900
 
 void send_bit_d4(bool bitVal) {
   if(bitVal) {
@@ -45,8 +39,8 @@ void send_bit_d4(bool bitVal) {
         ::
         [port]      "I" (_SFR_IO_ADDR(PORTD)),
         [bit]       "I" (4),
-        [onCycles]  "I" (NS_TO_CYCLES(T1H) - 2),
-        [offCycles] "I" (NS_TO_CYCLES(T1L) - 2));
+        [onCycles]  "I" (NS_TO_CYCLES(LED_T1H) - 2),
+        [offCycles] "I" (NS_TO_CYCLES(LED_T1L) - 2));
   } else {
     asm volatile (
         "sbi %[port], %[bit] \n\t"
@@ -60,8 +54,8 @@ void send_bit_d4(bool bitVal) {
         ::
         [port]      "I" (_SFR_IO_ADDR(PORTD)),
         [bit]       "I" (4),
-        [onCycles]  "I" (NS_TO_CYCLES(T0H) - 2),
-        [offCycles] "I" (NS_TO_CYCLES(T0L) - 2));
+        [onCycles]  "I" (NS_TO_CYCLES(LED_T0H) - 2),
+        [offCycles] "I" (NS_TO_CYCLES(LED_T0L) - 2));
   }
 }
 
@@ -80,8 +74,8 @@ void send_bit_d6(bool bitVal)
         ::
         [port]      "I" (_SFR_IO_ADDR(PORTD)),
         [bit]       "I" (6),
-        [onCycles]  "I" (NS_TO_CYCLES(T1H) - 2),
-        [offCycles] "I" (NS_TO_CYCLES(T1L) - 2));
+        [onCycles]  "I" (NS_TO_CYCLES(LED_T1H) - 2),
+        [offCycles] "I" (NS_TO_CYCLES(LED_T1L) - 2));
   } else {
     asm volatile (
         "sbi %[port], %[bit] \n\t"
@@ -95,15 +89,11 @@ void send_bit_d6(bool bitVal)
         ::
         [port]      "I" (_SFR_IO_ADDR(PORTD)),
         [bit]       "I" (6),
-        [onCycles]  "I" (NS_TO_CYCLES(T0H) - 2),
-        [offCycles] "I" (NS_TO_CYCLES(T0L) - 2));
+        [onCycles]  "I" (NS_TO_CYCLES(LED_T0H) - 2),
+        [offCycles] "I" (NS_TO_CYCLES(LED_T0L) - 2));
   }
 }
 
-void show(void) {
-  _delay_us((RES / 1000UL) + 1);
-}
-
 void send_value(uint8_t byte, enum Device device) {
   for(uint8_t b = 0; b < 8; b++) {
     if(device == Device_STATUSLED) {
@@ -117,8 +107,8 @@ void send_value(uint8_t byte, enum Device device) {
 }
 
 void send_color(uint8_t r, uint8_t g, uint8_t b, enum Device device) {
-  send_value(g, device);
   send_value(r, device);
+  send_value(g, device);
   send_value(b, device);
 }
 
diff --git a/keyboards/duck/octagon/v2/indicator_leds.h b/keyboards/duck/octagon/v2/indicator_leds.h
index 9bb2c8ced..ad3ec54f5 100644
--- a/keyboards/duck/octagon/v2/indicator_leds.h
+++ b/keyboards/duck/octagon/v2/indicator_leds.h
@@ -1,11 +1,7 @@
-enum Device {
-  Device_PCBRGB,
-  Device_STATUSLED
-};
+#include "duck_led/duck_led.h"
 
 void indicator_leds_set(bool leds[8]);
 void backlight_toggle_rgb(bool enabled);
 void backlight_set_rgb(uint8_t cfg[17][3]);
 void backlight_init_ports(void);
 void send_color(uint8_t r, uint8_t g, uint8_t b, enum Device device);
-void show(void);
\ No newline at end of file
diff --git a/keyboards/duck/octagon/v2/matrix.c b/keyboards/duck/octagon/v2/matrix.c
index a63a37640..e6e7046b4 100644
--- a/keyboards/duck/octagon/v2/matrix.c
+++ b/keyboards/duck/octagon/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;
       }
     }
diff --git a/keyboards/duck/octagon/v2/readme.md b/keyboards/duck/octagon/v2/readme.md
index b409454fc..cc9474fc9 100644
--- a/keyboards/duck/octagon/v2/readme.md
+++ b/keyboards/duck/octagon/v2/readme.md
@@ -11,6 +11,8 @@ Make example for this keyboard (after setting up your build environment):
 
     make octagon/v2:default
 
+**Reset Key:** To put the Octagon V2 into reset, hold the top right most key (`K5Q`) 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
diff --git a/keyboards/duck/octagon/v2/rules.mk b/keyboards/duck/octagon/v2/rules.mk
index 37f3938d9..c40324707 100644
--- a/keyboards/duck/octagon/v2/rules.mk
+++ b/keyboards/duck/octagon/v2/rules.mk
@@ -50,25 +50,25 @@ 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 ?= no        # 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 = no        # 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
 
 LAYOUTS = 75_ansi
diff --git a/keyboards/duck/octagon/v2/v2.h b/keyboards/duck/octagon/v2/v2.h
index 1487b3640..d60631009 100644
--- a/keyboards/duck/octagon/v2/v2.h
+++ b/keyboards/duck/octagon/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"
 
@@ -49,4 +48,3 @@
   { K1A, KC_NO, K1C, K1D,   K1E,   K1F,   K1G,   K1H,   K1I,   K1J,   K1K, KC_NO, K1M, K1N,   K1O, K1P,   KC_NO    }, \
   { K0A, K0B, K0C, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K0J,   KC_NO, K0K, K0L,   K0M, K0N,   K0O, K0P,   KC_NO    }  \
 }
-#endif
-- 
cgit v1.2.3-70-g09d2