mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-03 23:02:34 +01:00 
			
		
		
		
	Octagon V1 Support (Port) (#2184)
* Preliminary commit for Octagon V1 support This is essentially a cp -R v2 v1 with a few things changed to get it to compile and build. * The Octagon V1 supports up to 84 keys as opposed to the V2 which supports up to 86. This commit changes the keymap to match it. * Temporary default keymap just to get things to compile * Update readme file * Fix switch matrix * Fix underglow lighting option * Fix keymap to take care of shifted columns * Fix keymap formatting * Remove un-needed files left over from rasmusx * Make Octagon V1 have its own keymap directory with default keymap * Make Octagon V2 have its own keymap directory with default keymap * Cleanups and readme edits
This commit is contained in:
		
							parent
							
								
									5ffec5d9b0
								
							
						
					
					
						commit
						c68597d9ad
					
				@ -3,6 +3,10 @@
 | 
			
		||||
 | 
			
		||||
#include "quantum.h"
 | 
			
		||||
 | 
			
		||||
#ifdef KEYBOARD_octagon_v1
 | 
			
		||||
    #include "v1.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef KEYBOARD_octagon_v2
 | 
			
		||||
    #include "v2.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
@ -4,6 +4,8 @@ Non official firmware for custom Korean keyboard with 75% key layout made by Duc
 | 
			
		||||
 | 
			
		||||
See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
 | 
			
		||||
 | 
			
		||||
Newest version is the [Octagon V2](http://duck0113.tistory.com/127)
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make octagon/v2:default
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										54
									
								
								keyboards/octagon/v1/config.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								keyboards/octagon/v1/config.h
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,54 @@
 | 
			
		||||
/*
 | 
			
		||||
Copyright 2017 MechMerlin <mechmerlin@gmail.com>
 | 
			
		||||
 | 
			
		||||
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/>.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#ifndef CONFIG_H
 | 
			
		||||
#define CONFIG_H
 | 
			
		||||
 | 
			
		||||
#include "config_common.h"
 | 
			
		||||
 | 
			
		||||
/* USB Device descriptor parameter */
 | 
			
		||||
#define VENDOR_ID       0xFEED
 | 
			
		||||
#define PRODUCT_ID      0x6050
 | 
			
		||||
#define DEVICE_VER      0x0104
 | 
			
		||||
#define MANUFACTURER    Duck
 | 
			
		||||
#define PRODUCT         Octagon V1
 | 
			
		||||
#define DESCRIPTION     Duck 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 DEBOUNCING_DELAY 5
 | 
			
		||||
 | 
			
		||||
/* number of backlight levels */
 | 
			
		||||
#define BACKLIGHT_LEVELS 1
 | 
			
		||||
 | 
			
		||||
/* key combination for magic key command */
 | 
			
		||||
#define IS_COMMAND() ( \
 | 
			
		||||
    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
#define RGBLIGHT_ANIMATIONS
 | 
			
		||||
#define RGB_DI_PIN D6
 | 
			
		||||
#define RGBLED_NUM 17
 | 
			
		||||
 | 
			
		||||
#define TAPPING_TERM 200
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
							
								
								
									
										39
									
								
								keyboards/octagon/v1/keymaps/default/keymap.c
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										39
									
								
								keyboards/octagon/v1/keymaps/default/keymap.c
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,39 @@
 | 
			
		||||
/* Copyright 2017 MechMerlin <mechmerlin@gmail.com>
 | 
			
		||||
 *
 | 
			
		||||
 * 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 "octagon.h"
 | 
			
		||||
 | 
			
		||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
			
		||||
    /* layer 0: qwerty */
 | 
			
		||||
    [0] = KEYMAP(\
 | 
			
		||||
        KC_ESC,  KC_F1,   KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  KC_F7,  KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12,  KC_PSCR, KC_PAUS,
 | 
			
		||||
        KC_GRV,  KC_1,    KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,    KC_9,   KC_0,    KC_MINS, KC_EQL,  KC_BSPC, KC_HOME,
 | 
			
		||||
        KC_TAB,  KC_Q,    KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,    KC_O,   KC_P,    KC_LBRC, KC_RBRC, KC_BSLS, KC_PGUP,
 | 
			
		||||
        KC_CAPS, KC_A,    KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,    KC_L,   KC_SCLN, KC_QUOT, KC_NO,   KC_ENT,  KC_PGDN,
 | 
			
		||||
        KC_LSFT, KC_Z,    KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,   KC_END,
 | 
			
		||||
        KC_LCTL, KC_LGUI, KC_LALT,                KC_SPC,                          MO(1),  KC_NO,   KC_RCTL, KC_LEFT, KC_DOWN, KC_RIGHT),
 | 
			
		||||
 | 
			
		||||
    [1] = KEYMAP(\
 | 
			
		||||
        KC_TRNS, RGB_TOG, RGB_MOD, RGB_VAI, 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, 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_NO,   KC_TRNS,
 | 
			
		||||
        KC_TRNS, KC_NO,   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)
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 | 
			
		||||
  return MACRO_NONE;
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										8
									
								
								keyboards/octagon/v1/keymaps/default/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								keyboards/octagon/v1/keymaps/default/readme.md
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,8 @@
 | 
			
		||||
# Default Octagon Layout
 | 
			
		||||
 | 
			
		||||
This is the default implement layout for Duck Octagon V1.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
## Features
 | 
			
		||||
 | 
			
		||||
* Default QWERTY layer
 | 
			
		||||
							
								
								
									
										236
									
								
								keyboards/octagon/v1/matrix.c
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										236
									
								
								keyboards/octagon/v1/matrix.c
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,236 @@
 | 
			
		||||
/*
 | 
			
		||||
Copyright 2017 MechMerlin <mechmerlin@gmail.com>
 | 
			
		||||
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 = DEBOUNCING_DELAY;
 | 
			
		||||
 | 
			
		||||
/* 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_quantum(void) {
 | 
			
		||||
    matrix_init_kb();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__attribute__ ((weak))
 | 
			
		||||
void matrix_scan_quantum(void) {
 | 
			
		||||
    matrix_scan_kb();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
__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);
 | 
			
		||||
        debouncing = DEBOUNCING_DELAY;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
    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;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										28
									
								
								keyboards/octagon/v1/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								keyboards/octagon/v1/readme.md
									
									
									
									
									
										Normal file
									
								
							@ -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 octagon/v1:default
 | 
			
		||||
 | 
			
		||||
See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) 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)
 | 
			
		||||
							
								
								
									
										72
									
								
								keyboards/octagon/v1/rules.mk
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										72
									
								
								keyboards/octagon/v1/rules.mk
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,72 @@
 | 
			
		||||
# MCU name
 | 
			
		||||
MCU = atmega32u4
 | 
			
		||||
 | 
			
		||||
# Processor frequency.
 | 
			
		||||
#     This will define a symbol, F_CPU, in all source code files equal to the
 | 
			
		||||
#     processor frequency in Hz. You can then use this symbol in your source code to
 | 
			
		||||
#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
 | 
			
		||||
#     automatically to create a 32-bit value in your source code.
 | 
			
		||||
#
 | 
			
		||||
#     This will be an integer division of F_USB below, as it is sourced by
 | 
			
		||||
#     F_USB after it has run through any CPU prescalers. Note that this value
 | 
			
		||||
#     does not *change* the processor frequency - it should merely be updated to
 | 
			
		||||
#     reflect the processor speed set externally so that the code can use accurate
 | 
			
		||||
#     software delays.
 | 
			
		||||
F_CPU = 16000000
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#
 | 
			
		||||
# LUFA specific
 | 
			
		||||
#
 | 
			
		||||
# Target architecture (see library "Board Types" documentation).
 | 
			
		||||
ARCH = AVR8
 | 
			
		||||
 | 
			
		||||
# Input clock frequency.
 | 
			
		||||
#     This will define a symbol, F_USB, in all source code files equal to the
 | 
			
		||||
#     input clock frequency (before any prescaling is performed) in Hz. This value may
 | 
			
		||||
#     differ from F_CPU if prescaling is used on the latter, and is required as the
 | 
			
		||||
#     raw input clock is fed directly to the PLL sections of the AVR for high speed
 | 
			
		||||
#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
 | 
			
		||||
#     at the end, this will be done automatically to create a 32-bit value in your
 | 
			
		||||
#     source code.
 | 
			
		||||
#
 | 
			
		||||
#     If no clock division is performed on the input clock inside the AVR (via the
 | 
			
		||||
#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
 | 
			
		||||
F_USB = $(F_CPU)
 | 
			
		||||
 | 
			
		||||
# Interrupt driven control endpoint task(+60)
 | 
			
		||||
#OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# Boot Section Size in *bytes*
 | 
			
		||||
#   Teensy halfKay   512
 | 
			
		||||
#   Teensy++ halfKay 1024
 | 
			
		||||
#   Atmel DFU loader 4096
 | 
			
		||||
#   LUFA bootloader  4096
 | 
			
		||||
#   USBaspLoader     2048
 | 
			
		||||
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
 | 
			
		||||
# 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 ?= 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 += matrix.c \
 | 
			
		||||
		
 | 
			
		||||
							
								
								
									
										50
									
								
								keyboards/octagon/v1/v1.c
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										50
									
								
								keyboards/octagon/v1/v1.c
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,50 @@
 | 
			
		||||
/* Copyright 2017 MechMerlin <mechmerlin@gmail.com>
 | 
			
		||||
 *
 | 
			
		||||
 * 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);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
 | 
			
		||||
  return process_record_user(keycode, record);
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										36
									
								
								keyboards/octagon/v1/v1.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								keyboards/octagon/v1/v1.h
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,36 @@
 | 
			
		||||
/* Copyright 2017 MechMerlin <mechmerlin@gmail.com>
 | 
			
		||||
 *
 | 
			
		||||
 * 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/>.
 | 
			
		||||
 */
 | 
			
		||||
#ifndef V1_H
 | 
			
		||||
#define V1_H
 | 
			
		||||
 | 
			
		||||
#include "../octagon.h"
 | 
			
		||||
 | 
			
		||||
#define KEYMAP( \
 | 
			
		||||
    K5A, K5B, K5C, K5D, K5E, K5F, K5G, K5H, K5I, K5J, K5K, K5L, K5M, K5N, 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, K5O, 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 }  \
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user