initHEADmaster

8 files changed, 506 insertions, 0 deletions

diff --git a/keyboards/duck/octagon/v1/.noci b/keyboards/duck/octagon/v1/.noci
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/keyboards/duck/octagon/v1/.noci
diff --git a/keyboards/duck/octagon/v1/config.h b/keyboards/duck/octagon/v1/config.h
new file mode 100644
index 000000000..7bf69a7b6
--- /dev/null
+++ b/keyboards/duck/octagon/v1/config.h
@@ -0,0 +1,49 @@
+/*
+Copyright 2017 MechMerlin <[email protected]>
+
+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       0x444B // Duck ("DK")
+#define PRODUCT_ID      0x4F31 // Octagon V1 ("O1")
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Duck
+#define PRODUCT         Octagon V1
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 16
+
+#define DIODE_DIRECTION COL2ROW
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* number of backlight levels */
+#define BACKLIGHT_LEVELS 1
+
+#define RGBLIGHT_ANIMATIONS
+#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
diff --git a/keyboards/duck/octagon/v1/info.json b/keyboards/duck/octagon/v1/info.json
new file mode 100644
index 000000000..1fae48975
--- /dev/null
+++ b/keyboards/duck/octagon/v1/info.json
@@ -0,0 +1,95 @@
+{
+    "keyboard_name": "Octagon V1", 
+    "url": "", 
+    "maintainer": "qmk", 
+    "layouts": {
+        "LAYOUT_75_ansi": {
+            "layout": [
+                {"label":"Esc", "x":0, "y":0},
+                {"label":"F1", "x":1, "y":0},
+                {"label":"F2", "x":2, "y":0},
+                {"label":"F3", "x":3, "y":0},
+                {"label":"F4", "x":4, "y":0},
+                {"label":"F5", "x":5, "y":0},
+                {"label":"F6", "x":6, "y":0},
+                {"label":"F7", "x":7, "y":0},
+                {"label":"F8", "x":8, "y":0},
+                {"label":"F9", "x":9, "y":0},
+                {"label":"F10", "x":10, "y":0},
+                {"label":"F11", "x":11, "y":0},
+                {"label":"F12", "x":12, "y":0},
+                {"label":"PrtSc", "x":13, "y":0},
+                {"label":"ScrLk", "x":14, "y":0},
+                {"label":"Pause", "x":15, "y":0},
+                {"label":"~", "x":0, "y":1},
+                {"label":"!", "x":1, "y":1},
+                {"label":"@", "x":2, "y":1},
+                {"label":"#", "x":3, "y":1},
+                {"label":"$", "x":4, "y":1},
+                {"label":"%", "x":5, "y":1},
+                {"label":"^", "x":6, "y":1},
+                {"label":"&", "x":7, "y":1},
+                {"label":"*", "x":8, "y":1},
+                {"label":"(", "x":9, "y":1},
+                {"label":")", "x":10, "y":1},
+                {"label":"_", "x":11, "y":1},
+                {"label":"+", "x":12, "y":1},
+                {"label":"Backspace", "x":13, "y":1, "w":2},
+                {"label":"Home", "x":15, "y":1},
+                {"label":"Tab", "x":0, "y":2, "w":1.5},
+                {"label":"Q", "x":1.5, "y":2},
+                {"label":"W", "x":2.5, "y":2},
+                {"label":"E", "x":3.5, "y":2},
+                {"label":"R", "x":4.5, "y":2},
+                {"label":"T", "x":5.5, "y":2},
+                {"label":"Y", "x":6.5, "y":2},
+                {"label":"U", "x":7.5, "y":2},
+                {"label":"I", "x":8.5, "y":2},
+                {"label":"O", "x":9.5, "y":2},
+                {"label":"P", "x":10.5, "y":2},
+                {"label":"{", "x":11.5, "y":2},
+                {"label":"}", "x":12.5, "y":2},
+                {"label":"|", "x":13.5, "y":2, "w":1.5},
+                {"label":"Page Up", "x":15, "y":2},
+                {"label":"Caps Lock", "x":0, "y":3, "w":1.75},
+                {"label":"A", "x":1.75, "y":3},
+                {"label":"S", "x":2.75, "y":3},
+                {"label":"D", "x":3.75, "y":3},
+                {"label":"F", "x":4.75, "y":3},
+                {"label":"G", "x":5.75, "y":3},
+                {"label":"H", "x":6.75, "y":3},
+                {"label":"J", "x":7.75, "y":3},
+                {"label":"K", "x":8.75, "y":3},
+                {"label":"L", "x":9.75, "y":3},
+                {"label":":", "x":10.75, "y":3},
+                {"label":"\"", "x":11.75, "y":3},
+                {"label":"Enter", "x":12.75, "y":3, "w":2.25},
+                {"label":"Page Down", "x":15, "y":3},
+                {"label":"Shift", "x":0, "y":4, "w":2.25},
+                {"label":"Z", "x":2.25, "y":4},
+                {"label":"X", "x":3.25, "y":4},
+                {"label":"C", "x":4.25, "y":4},
+                {"label":"V", "x":5.25, "y":4},
+                {"label":"B", "x":6.25, "y":4},
+                {"label":"N", "x":7.25, "y":4},
+                {"label":"M", "x":8.25, "y":4},
+                {"label":"<", "x":9.25, "y":4},
+                {"label":">", "x":10.25, "y":4},
+                {"label":"?", "x":11.25, "y":4},
+                {"label":"Shift", "x":12.25, "y":4, "w":1.75},
+                {"label":"\u2191", "x":14, "y":4},
+                {"label":"End", "x":15, "y":4},
+                {"label":"Ctrl", "x":0, "y":5, "w":1.25},
+                {"label":"Win", "x":1.25, "y":5, "w":1.25},
+                {"label":"Alt", "x":2.5, "y":5, "w":1.25},
+                {"label":"Space", "x":3.75, "y":5, "w":6.25},
+                {"label":"Alt", "x":10, "y":5},
+                {"label":"Fn", "x":11, "y":5},
+                {"label":"Ctrl", "x":12, "y":5},
+                {"label":"\u2190", "x":13, "y":5},
+                {"label":"\u2193", "x":14, "y":5},
+                {"label":"\u2192", "x":15, "y":5}
+            ]
+        }
+    }
+}
diff --git a/keyboards/duck/octagon/v1/matrix.c b/keyboards/duck/octagon/v1/matrix.c
new file mode 100644
index 000000000..a2bea865b
--- /dev/null
+++ b/keyboards/duck/octagon/v1/matrix.c
@@ -0,0 +1,230 @@
+/*
+Copyright 2017 MechMerlin <[email protected]>
+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 <util/delay.h>
+#include <avr/io.h>
+#include <stdio.h>
+#include "matrix.h"
+#include "util.h"
+#include "print.h"
+#include "debug.h"
+
+static uint8_t debouncing = DEBOUNCE;
+
+/* matrix state(1:on, 0:off) */
+static matrix_row_t matrix[MATRIX_ROWS];
+static matrix_row_t matrix_debouncing[MATRIX_ROWS];
+
+static uint8_t read_rows(uint8_t col);
+static void init_rows(void);
+static void unselect_cols(void);
+static void select_col(uint8_t col);
+
+
+__attribute__ ((weak))
+void matrix_init_kb(void) {
+    matrix_init_user();
+}
+
+__attribute__ ((weak))
+void matrix_scan_kb(void) {
+    matrix_scan_user();
+}
+
+__attribute__ ((weak))
+void matrix_init_user(void) {
+}
+
+__attribute__ ((weak))
+void matrix_scan_user(void) {
+}
+
+void backlight_init_ports(void)
+{
+    DDRB |= 0b00011111;  // PB0 (caps), PB1 (alpha), PB2 (extra), PB3 (modnum), PB4 (caps)
+    DDRD |= 0b11010000;  // PD4, (rgb blue), PD6 (rgb red), PD7 (rgb green)
+    DDRE |= 0b01000000;  // PE6 (frow)
+}
+
+void matrix_init(void) {
+  backlight_init_ports();
+  unselect_cols();
+  init_rows();
+
+  for (uint8_t i=0; i < MATRIX_ROWS; i++)  {
+    matrix[i] = 0;
+    matrix_debouncing[i] = 0;
+  }
+
+  matrix_init_quantum();
+}
+
+uint8_t matrix_scan(void) {
+  for (uint8_t col = 0; col < MATRIX_COLS; col++) {
+    select_col(col);
+    _delay_us(3);
+
+    uint8_t rows = read_rows(col);
+
+    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+      bool prev_bit = matrix_debouncing[row] & ((matrix_row_t)1<<col);
+      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 = DEBOUNCE;
+      }
+    }
+    unselect_cols();
+  }
+
+  if (debouncing) {
+    if (--debouncing) {
+      _delay_ms(1);
+    } else {
+      for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        matrix[i] = matrix_debouncing[i];
+      }
+    }
+  }
+
+  matrix_scan_quantum();
+  return 1;
+}
+
+inline matrix_row_t matrix_get_row(uint8_t row) {
+  return matrix[row];
+}
+
+void matrix_print(void) {
+  print("\nr/c 0123456789ABCDEF\n");
+  for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+    xprintf("%02X: %032lb\n", row, bitrev32(matrix_get_row(row)));
+  }
+}
+
+/* Row pin configuration
+ * row: 0    1    2    3    4    5
+ * pin: PB7  PD0  PD1  PD2  PD3  PD5
+ *
+ * Esc uses its own pin PE2
+ */
+static void init_rows(void) {
+    DDRD  &= ~0b00101111; // PD0, PD1, PD2, PD3, PD5 input
+    PORTD &= ~0b00101111; // PD0, PD1, PD2, PD3, PD5 low
+
+    DDRB  &= ~0b10000000; // PB7 input
+    PORTB &= ~0b10000000; // PB7 low
+
+    DDRE  &= ~0b00000100; // PE2 input
+    PORTE |=  0b00000100; // PE2 high
+}
+
+static uint8_t read_rows(uint8_t col) {
+  if (col == 14) {
+    return PINE&(1<<2) ? 0 : (1<<0);        // PE2 (Row 0)
+  } else {
+      return (PIND&(1<<0) ? (1<<0) : 0) |   // PD0 (Row 0)
+             (PIND&(1<<1) ? (1<<1) : 0) |   // PD1 (Row 1)
+             (PIND&(1<<2) ? (1<<2) : 0) |   // PD2 (Row 2)
+             (PIND&(1<<3) ? (1<<3) : 0) |   // PD3 (Row 3)
+             (PIND&(1<<5) ? (1<<4) : 0) |   // PD5 (Row 4)
+             (PINB&(1<<7) ? (1<<5) : 0);    // PB7 (Row 5)
+    }
+}
+
+uint8_t read_fwkey(void)
+{
+  return PINE&(1<<2) ? 0 : (1<<0);
+}
+
+static void unselect_cols(void) {
+    DDRB  |=  0b01000000; // PB6 (U2) output
+    PORTB &= ~0b01000000; // PB6 (U2) low
+
+    DDRC  |=  0b11000000; // PC6 (U1), PC7 (A2) output
+    PORTC &= ~0b11000000; // PC6 (U1), PC7 (A2) low
+
+    DDRF  |=  0b00000011; // PF0 (A0), PF1 (A1) output
+    PORTF &= ~0b00000011; // PF0 (A0), PF1 (A1) low
+}
+
+static void select_col(uint8_t col) {
+ 
+   switch (col) {
+        case 0:
+            PORTC |= 0b01000000; // PC6 high
+            break;
+        case 1:
+            PORTC |= 0b01000000; // PC6 high
+            PORTF |= 0b00000001; // PF0 high
+            break;
+        case 2:
+            PORTC |= 0b01000000; // PC6 high
+            PORTF |= 0b00000010; // PF1 high
+            break;
+        case 3:
+            PORTC |= 0b01000000; // PC6 high
+            PORTF |= 0b00000011; // PF0, PF1 high
+            break;
+        case 4:
+            PORTC |= 0b11000000; // PC6, PC7 high
+            break;
+        case 5:
+            PORTC |= 0b11000000; // PC6, PC7 high
+            PORTF |= 0b00000001; // PF0 high
+            break;
+        case 6:
+            PORTC |= 0b11000000; // PC6, PC7 high
+            PORTF |= 0b00000010; // PF1 high
+            break;
+        case 7:
+            PORTC |= 0b11000000; // PC6, PC7 high
+            PORTF |= 0b00000011; // PF0, PF1 high
+            break;
+        case 8:
+            PORTB |= 0b01000000; // PB6 high
+            break;
+        case 9:
+            PORTB |= 0b01000000; // PB6 high
+            PORTF |= 0b00000001; // PF0 high
+            break;
+        case 10:
+            PORTB |= 0b01000000; // PB6 high
+            PORTF |= 0b00000010; // PF1 high
+            break;
+        case 11:
+            PORTB |= 0b01000000; // PB6 high
+            PORTF |= 0b00000011; // PF0, PF1 high
+            break;
+        case 12:
+            PORTB |= 0b01000000; // PB6 high
+            PORTC |= 0b10000000; // PC7 high
+            break;
+        case 13:
+            PORTB |= 0b01000000; // PB6 high
+            PORTF |= 0b00000001; // PF0 high
+            PORTC |= 0b10000000; // PC7 high
+            break;
+        case 15:
+            PORTB |= 0b01000000; // PB6 high
+            PORTF |= 0b00000010; // PF1 high
+            PORTC |= 0b10000000; // PC7 high
+            break;
+    }
+}
diff --git a/keyboards/duck/octagon/v1/readme.md b/keyboards/duck/octagon/v1/readme.md
new file mode 100644
index 000000000..f614b3577
--- /dev/null
+++ b/keyboards/duck/octagon/v1/readme.md
@@ -0,0 +1,28 @@
+# Duck Octagon V1
+
+Non official firmware for custom Korean keyboard with 75% key layout made by Duck.  
+Group buy was run October 2014 via [geekhack](https://geekhack.org/index.php?topic=65036.0) 35 keyboards total. 
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
+Hardware Supported: Duck Octagon PCB Ver 1.0, Atmega32u4  
+Hardware Availability: Wait until GB of the next revision
+
+Make example for this keyboard (after setting up your build environment):
+
+    make duck/octagon/v1:default
+
+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
+
+The Duck Octagon V1 PCB consists of:
+
+### Microchips
+2 74HC237D 3-to-8 line decoders
+1 Atmega32u4 microcontroller
+2 WS2811 LED controller
+
+## Notes
+Thanks to Ralf Schmitt for previous implementations in his [TMK fork](https://github.com/xauser/tmk_keyboard/tree/xauser/) and few helping words.
+
+Based heavily on Rasmus Schults [Duck Lightsaver QMK Port](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lightsaver)
diff --git a/keyboards/duck/octagon/v1/rules.mk b/keyboards/duck/octagon/v1/rules.mk
new file mode 100644
index 000000000..84dd4e31d
--- /dev/null
+++ b/keyboards/duck/octagon/v1/rules.mk
@@ -0,0 +1,24 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = no        # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = yes        # Commands for debug and configuration
+NKRO_ENABLE = yes           # Enable N-Key Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+BACKLIGHT_DRIVER = custom
+AUDIO_ENABLE = no           # Audio output
+RGBLIGHT_ENABLE = yes
+
+CUSTOM_MATRIX = yes
+SRC += matrix.c \
+
+LAYOUTS = 75_ansi
diff --git a/keyboards/duck/octagon/v1/v1.c b/keyboards/duck/octagon/v1/v1.c
new file mode 100644
index 000000000..e9e88c70d
--- /dev/null
+++ b/keyboards/duck/octagon/v1/v1.c
@@ -0,0 +1,46 @@
+/* Copyright 2017 MechMerlin <[email protected]>
+ *
+ * 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 "v1.h"
+
+enum BACKLIGHT_AREAS {
+  BACKLIGHT_ALPHA    = 0b0000001,
+  BACKLIGHT_EXTRA    = 0b0000010,
+  BACKLIGHT_MODNUM   = 0b0000100,
+  BACKLIGHT_FROW     = 0b0001000,
+  BACKLIGHT_RGB      = 0b0010000,
+  BACKLIGHT_RGBRED   = 0b0010000,
+  BACKLIGHT_RGBGREEN = 0b0100000,
+  BACKLIGHT_RGBBLUE  = 0b1000000,
+  BACKLIGHT_SWITCH   = 0b0001111
+};
+
+uint8_t backlight_os_state = 0;
+uint32_t backlight_layer_state = 0;
+
+void backlight_set(uint8_t level) {
+  level & BACKLIGHT_ALPHA ? (PORTB |= 0b00000010) : (PORTB &= ~0b00000010);
+  level & BACKLIGHT_EXTRA ? (PORTB |= 0b00000100) : (PORTB &= ~0b00000100);
+  level & BACKLIGHT_MODNUM ? (PORTB |= 0b00001000) : (PORTB &= ~0b00001000);
+  level & BACKLIGHT_FROW ? (PORTE |= 0b01000000) : (PORTE &= ~0b01000000);
+  level & BACKLIGHT_RGBRED ? (PORTD |= 0b01000000) : (PORTD &= ~0b01000000);
+  level & BACKLIGHT_RGBGREEN ? (PORTD |= 0b10000000) : (PORTD &= ~0b10000000);
+  level & BACKLIGHT_RGBBLUE ? (PORTD |= 0b00010000) : (PORTD &= ~0b00010000);
+}
+
+void led_set_kb(uint8_t usb_led) {
+  backlight_os_state & (1<<USB_LED_CAPS_LOCK) ? (PORTB &= ~0b00000001) : (PORTB |= 0b00000001);
+  backlight_os_state & (1<<USB_LED_SCROLL_LOCK) ? (PORTB &= ~0b00010000) : (PORTB |= 0b00010000);
+}
diff --git a/keyboards/duck/octagon/v1/v1.h b/keyboards/duck/octagon/v1/v1.h
new file mode 100644
index 000000000..9f3d1e369
--- /dev/null
+++ b/keyboards/duck/octagon/v1/v1.h
@@ -0,0 +1,34 @@
+/* Copyright 2017 MechMerlin <[email protected]>
+ *
+ * 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_75_ansi( \
+    K5A, K5B, K5C, K5D, K5E, K5F, K5G, K5H, K5I, K5J, K5K, K5L, K5M, K5N, K5O, K5P, \
+    K4A, K4B, K4C, K4D, K4E, K4F, K4G, K4H, K4I, K4J, K4K, K4L, K4M, K4N,      K4P, \
+    K3A, K3B, K3C, K3D, K3E, K3F, K3G, K3H, K3I, K3J, K3K, K3L, K3M, K3N,      K3P, \
+    K2A, K2B, K2C, K2D, K2E, K2F, K2G, K2H, K2I, K2J, K2K, K2L,      K2N,      K2P, \
+    K1A,      K1C, K1D, K1E, K1F, K1G, K1H, K1I, K1J, K1K, K1L, K1M, K1N,      K1P, \
+    K0A, K0B, K0C,                K0G,           K0J, K0K, K0L, K0M, K0N,      K0P  \
+) { \
+  { K5A, K5B, K5C, K5D,   K5E,   K5F, K5G,   K5H,   K5I, K5J, K5K, K5L,   K5M,   K5N, K5O,   K5P }, \
+  { K4A, K4B, K4C, K4D,   K4E,   K4F, K4G,   K4H,   K4I, K4J, K4K, K4L,   K4M,   K4N, KC_NO, K4P }, \
+  { K3A, K3B, K3C, K3D,   K3E,   K3F, K3G,   K3H,   K3I, K3J, K3K, K3L,   K3M,   K3N, KC_NO, K3P }, \
+  { K2A, K2B, K2C, K2D,   K2E,   K2F, K2G,   K2H,   K2I, K2J, K2K, K2L,   KC_NO, K2N, KC_NO, K2P }, \
+  { 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 }  \
+}