From d9b5f5110ebf3e7da6a11e8640fb4367114aed67 Mon Sep 17 00:00:00 2001 From: Ralf Schmitt Date: Tue, 11 Nov 2014 14:49:16 +0100 Subject: Added NerD 60% support --- keyboard/nerd/Makefile | 123 +++++++++++++++++++++++ keyboard/nerd/README.md | 45 +++++++++ keyboard/nerd/backlight.c | 75 ++++++++++++++ keyboard/nerd/backlight.h | 40 ++++++++ keyboard/nerd/config.h | 49 +++++++++ keyboard/nerd/keymap_ansi150.c | 39 ++++++++ keyboard/nerd/keymap_common.c | 29 ++++++ keyboard/nerd/keymap_common.h | 67 +++++++++++++ keyboard/nerd/led.c | 25 +++++ keyboard/nerd/matrix.c | 220 +++++++++++++++++++++++++++++++++++++++++ 10 files changed, 712 insertions(+) create mode 100644 keyboard/nerd/Makefile create mode 100644 keyboard/nerd/README.md create mode 100644 keyboard/nerd/backlight.c create mode 100644 keyboard/nerd/backlight.h create mode 100644 keyboard/nerd/config.h create mode 100644 keyboard/nerd/keymap_ansi150.c create mode 100644 keyboard/nerd/keymap_common.c create mode 100644 keyboard/nerd/keymap_common.h create mode 100644 keyboard/nerd/led.c create mode 100644 keyboard/nerd/matrix.c (limited to 'keyboard') diff --git a/keyboard/nerd/Makefile b/keyboard/nerd/Makefile new file mode 100644 index 0000000000..10fa144fbb --- /dev/null +++ b/keyboard/nerd/Makefile @@ -0,0 +1,123 @@ +#---------------------------------------------------------------------------- +# On command line: +# +# make all = Make software. +# +# make clean = Clean out built project files. +# +# make coff = Convert ELF to AVR COFF. +# +# make extcoff = Convert ELF to AVR Extended COFF. +# +# make program = Download the hex file to the device. +# Please customize your programmer settings(PROGRAM_CMD) +# +# make teensy = Download the hex file to the device, using teensy_loader_cli. +# (must have teensy_loader_cli installed). +# +# make dfu = Download the hex file to the device, using dfu-programmer (must +# have dfu-programmer installed). +# +# make flip = Download the hex file to the device, using Atmel FLIP (must +# have Atmel FLIP installed). +# +# make dfu-ee = Download the eeprom file to the device, using dfu-programmer +# (must have dfu-programmer installed). +# +# make flip-ee = Download the eeprom file to the device, using Atmel FLIP +# (must have Atmel FLIP installed). +# +# make debug = Start either simulavr or avarice as specified for debugging, +# with avr-gdb or avr-insight as the front end for debugging. +# +# make filename.s = Just compile filename.c into the assembler code only. +# +# make filename.i = Create a preprocessed source file for use in submitting +# bug reports to the GCC project. +# +# To rebuild project do "make clean" then "make all". +#---------------------------------------------------------------------------- + +# Target file name (without extension). +TARGET = nerd_lufa + +# Directory common source filess exist +TOP_DIR = ../.. + +# Directory keyboard dependent files exist +TARGET_DIR = . + +# project specific files +SRC = keymap_common.c \ + matrix.c \ + backlight.c \ + led.c \ + keymap_ansi150.c + +CONFIG_H = config.h + +# 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 = 8000000 + +# +# 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) + +# 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 +# comment out to disable the options. +# +BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000) +#MOUSEKEY_ENABLE = yes # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +CONSOLE_ENABLE = yes # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +#SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend +#NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA +BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality + +# Search Path +VPATH += $(TARGET_DIR) +VPATH += $(TOP_DIR) + +include $(TOP_DIR)/protocol/lufa.mk +include $(TOP_DIR)/common.mk +include $(TOP_DIR)/rules.mk + +winkey: OPT_DEFS += -DLAYOUT_WINKEY +winkey: all diff --git a/keyboard/nerd/README.md b/keyboard/nerd/README.md new file mode 100644 index 0000000000..0130fe49fd --- /dev/null +++ b/keyboard/nerd/README.md @@ -0,0 +1,45 @@ +NerD keyboard firmware +======================== + +Korean Keyboard designed by GON. + +*Note that this is not the official firmware* + + +Hardware revision +----------------- + +This firmware was developed and tested for NerD pcb version 1.61 and 2.0. + + +Supported features +------------------ + +* All layout options are supported +* All leds are supported + + +Changing Bootloader +------------------- + +You can't simply just upload this firmware to a new NerD board because the original +bootloader won't accept DFU connections. + +You can change the bootloader of the keyboard with an ISP programmer of your choice. +The bootloader pins are easy to access on the NerD pcb. + +*Be aware that after changing the bootloader the official configuration software +won't work anymore and you'll lose your warrenty. GON won't provide any support for this firmware.* + + +Build +----- + +Move to this directory then just run `make`. + + +Jump to Bootloader +------------------ + +You can jump to bootloader by software if you have a macro defined for this in your keymap. The +default command is (LSFT+RSFT+PAUS) to access the bootloader by software jump. diff --git a/keyboard/nerd/backlight.c b/keyboard/nerd/backlight.c new file mode 100644 index 0000000000..804b4848a6 --- /dev/null +++ b/keyboard/nerd/backlight.c @@ -0,0 +1,75 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#include +#include "backlight.h" + +void backlight_init_ports() +{ + DDRB |= 0b11100000; // PB7 (switch), PB6 (pcb), PB5 (caps) +} + +void backlight_set(uint8_t level) +{ + (level & BACKLIGHT_SWITCH) ? backlight_switch_enable() : backlight_switch_disable(); + (level & BACKLIGHT_PCB) ? backlight_pcb_enable() : backlight_pcb_disable(); +} + +void backlight_switch_enable() +{ + PORTB |= 0b10000000; +} + +void backlight_switch_disable() +{ + PORTB &= ~0b10000000; +} + +void backlight_switch_invert() +{ + PORTB ^= 0b10000000; +} + +void backlight_pcb_enable() +{ + PORTB |= 0b01000000; +} + +void backlight_pcb_disable() +{ + PORTB &= ~0b01000000; +} + +void backlight_pcb_invert() +{ + PORTB ^= 0b01000000; +} + +void backlight_caps_enable() +{ + PORTB |= 0b00100000; +} + +void backlight_caps_disable() +{ + PORTB &= ~0b00100000; +} + +void backlight_caps_invert() +{ + PORTB ^= 0b00100000; +} diff --git a/keyboard/nerd/backlight.h b/keyboard/nerd/backlight.h new file mode 100644 index 0000000000..4c75d9db65 --- /dev/null +++ b/keyboard/nerd/backlight.h @@ -0,0 +1,40 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#ifndef BACKLIGHT_H +#define BACKLIGHT_H + +enum backlight_level { + BACKLIGHT_SWITCH = 0b0000001, + BACKLIGHT_PCB = 0b0000010, +}; + +void backlight_init_ports(void); + +void backlight_switch_invert(void); +void backlight_switch_enable(void); +void backlight_switch_disable(void); + +void backlight_pcb_invert(void); +void backlight_pcb_enable(void); +void backlight_pcb_disable(void); + +void backlight_caps_invert(void); +void backlight_caps_enable(void); +void backlight_caps_disable(void); + +#endif // BACKLIGHT_H diff --git a/keyboard/nerd/config.h b/keyboard/nerd/config.h new file mode 100644 index 0000000000..7eab1cb090 --- /dev/null +++ b/keyboard/nerd/config.h @@ -0,0 +1,49 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ +#ifndef CONFIG_H +#define CONFIG_H + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED +#define PRODUCT_ID 0x6060 +#define DEVICE_VER 0x0001 +#define MANUFACTURER GON +#define PRODUCT NerD +#define DESCRIPTION t.m.k. keyboard firmware for NerD + +/* key matrix size */ +#define MATRIX_ROWS 8 +#define MATRIX_COLS 10 + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCE 5 + +/* number of backlight levels */ +#define BACKLIGHT_LEVELS 2 + +/* 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 + +/* key combination for command */ +#define IS_COMMAND() ( \ + keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \ +) + +#endif diff --git a/keyboard/nerd/keymap_ansi150.c b/keyboard/nerd/keymap_ansi150.c new file mode 100644 index 0000000000..645ad6a83d --- /dev/null +++ b/keyboard/nerd/keymap_ansi150.c @@ -0,0 +1,39 @@ +#include "keymap_common.h" +#include "action_layer.h" +#include "backlight.h" + +const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Layer 0: Default */ + KEYMAP_ANSI150(GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, \ + TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSLS, \ + ESC, A, S, D, F, G, H, J, K, L, SCLN,QUOT, ENT, \ + LSFT, Z, X, C, V, B, N, M, COMM,DOT, SLSH,RSFT, \ + LCTL,LGUI,LALT, SPC, RALT,FN0 ,RCTL), + /* Layer 1: Arrow keys */ + KEYMAP_ANSI150(TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, TRNS, \ + UP, TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + LEFT,DOWN,RGHT, TRNS, TRNS,TRNS,TRNS), + /* Layer 2: Space Fn */ + KEYMAP_ANSI150(TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, TRNS, \ + TRNS, TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS, FN1, TRNS,TRNS,TRNS), + /* Layer 3: Functions */ + KEYMAP_ANSI150(SLEP,F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, FN4, \ + TRNS,TRNS,UP, END, PSCR,SLCK,BRK, TRNS,INS, HOME,TRNS,VOLD,VOLU,FN5, \ + CAPS,LEFT,DOWN,RGHT,PGDN,TRNS,LEFT,DOWN,UP ,RGHT,TRNS,TRNS, TRNS, \ + TRNS, TRNS,DEL, TRNS,TRNS,PGUP,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, \ + MPRV,MPLY,MNXT, TRNS, FN2,TRNS,FN3), +}; + +const uint16_t PROGMEM fn_actions[] = { + [0] = ACTION_LAYER_MOMENTARY(3), // Switch to function layer + [1] = ACTION_LAYER_TAP_KEY(3, KC_SPACE), // Switch to function layer (Space Fn) + [2] = ACTION_LAYER_TOGGLE(1), // Toggle "Arrow keys" layer + [3] = ACTION_LAYER_TOGGLE(2), // Toggle "Space fn" layer + [4] = ACTION_BACKLIGHT_LEVEL(BACKLIGHT_SWITCH), // Toggle switch leds + [5] = ACTION_BACKLIGHT_LEVEL(BACKLIGHT_PCB), // Toggle pcb leds +}; diff --git a/keyboard/nerd/keymap_common.c b/keyboard/nerd/keymap_common.c new file mode 100644 index 0000000000..29ec4e53ef --- /dev/null +++ b/keyboard/nerd/keymap_common.c @@ -0,0 +1,29 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ +#include "keymap_common.h" + +/* translates key to keycode */ +uint8_t keymap_key_to_keycode(uint8_t layer, keypos_t key) +{ + return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]); +} + +/* translates Fn keycode to action */ +action_t keymap_fn_to_action(uint8_t keycode) +{ + return (action_t){ .code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]) }; +} diff --git a/keyboard/nerd/keymap_common.h b/keyboard/nerd/keymap_common.h new file mode 100644 index 0000000000..2d801654da --- /dev/null +++ b/keyboard/nerd/keymap_common.h @@ -0,0 +1,67 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#ifndef KEYMAP_COMMON_H +#define KEYMAP_COMMON_H + +#include +#include +#include "keycode.h" +#include "action.h" +#include "action_macro.h" +#include "report.h" +#include "host.h" +#include "print.h" +#include "debug.h" +#include "keymap.h" + +extern const uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS]; +extern const uint16_t fn_actions[]; + +#define KEYMAP( \ + K08, K01, K10, K11, K20, K21, K30, K31, K40, K41, K50, K51, K60, K61, \ + K02, K03, K12, K13, K22, K23, K32, K33, K42, K43, K52, K53, K62, K63, \ + K04, K14, K15, K24, K25, K34, K35, K44, K45, K54, K55, K64, K71, K65, \ + K07, K79, K16, K17, K26, K27, K36, K37, K46, K47, K56, K57, K66, K67, \ + K06, K05, K78, K70, K72, K73, K74, K75 \ +) { \ +/* 0 1 2 3 4 5 6 7 8 9 */\ +/* 0 */ { KC_NO, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07, KC_##K08, KC_NO }, \ +/* 1 */ { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17, KC_NO, KC_NO }, \ +/* 2 */ { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27, KC_NO, KC_NO }, \ +/* 3 */ { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37, KC_NO, KC_NO }, \ +/* 4 */ { KC_##K40, KC_##K41, KC_##K42, KC_##K43, KC_##K44, KC_##K45, KC_##K46, KC_##K47, KC_NO, KC_NO }, \ +/* 5 */ { KC_##K50, KC_##K51, KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57, KC_NO, KC_NO }, \ +/* 6 */ { KC_##K60, KC_##K61, KC_##K62, KC_##K63, KC_##K64, KC_##K65, KC_##K66, KC_##K67, KC_NO, KC_NO }, \ +/* 7 */ { KC_##K70, KC_##K71, KC_##K72, KC_##K73, KC_##K74, KC_##K75, KC_NO, KC_NO, KC_##K78, KC_##K79 } \ +} + +#define KEYMAP_ANSI150( \ + K08, K01, K10, K11, K20, K21, K30, K31, K40, K41, K50, K51, K60, K61, \ + K02, K03, K12, K13, K22, K23, K32, K33, K42, K43, K52, K53, K62, K63, \ + K04, K14, K15, K24, K25, K34, K35, K44, K45, K54, K55, K64, K65, \ + K07, K16, K17, K26, K27, K36, K37, K46, K47, K56, K57, K66, \ + K06, K05, K78, K70, K73, K74, K75 \ +) KEYMAP( \ + K08, K01, K10, K11, K20, K21, K30, K31, K40, K41, K50, K51, K60, K61, \ + K02, K03, K12, K13, K22, K23, K32, K33, K42, K43, K52, K53, K62, K63, \ + K04, K14, K15, K24, K25, K34, K35, K44, K45, K54, K55, K64, NO, K65, \ + K07, NO, K16, K17, K26, K27, K36, K37, K46, K47, K56, K57, K66, NO, \ + K06, K05, K78, K70, NO, K73, K74, K75 \ +) + +#endif // KEYMAP_COMMON_H diff --git a/keyboard/nerd/led.c b/keyboard/nerd/led.c new file mode 100644 index 0000000000..7d9ce6d878 --- /dev/null +++ b/keyboard/nerd/led.c @@ -0,0 +1,25 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#include +#include "stdint.h" +#include "led.h" + +void led_set(uint8_t usb_led) +{ + (usb_led & (1< + +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 . +*/ + +#include +#include +#include +#include +#include "print.h" +#include "debug.h" +#include "util.h" +#include "matrix.h" +#include "backlight.h" + + +#ifndef DEBOUNCE +# define DEBOUNCE 5 +#endif +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 uint16_t read_inputs(void); +static void init_inputs(void); +static void init_outputs(void); +static void reset_inputs(void); +static void reset_outputs(void); +static void select_output(uint8_t col); + +inline +uint8_t matrix_rows(void) +{ + return MATRIX_ROWS; +} + +inline +uint8_t matrix_cols(void) +{ + return MATRIX_COLS; +} + +void matrix_init(void) +{ + backlight_init_ports(); + init_inputs(); + init_outputs(); + + for (uint8_t i=0; i < MATRIX_ROWS; i++) { + matrix[i] = 0; + matrix_debouncing[i] = 0; + } +} + +uint8_t matrix_scan(void) +{ + for (uint8_t col = 0; col < MATRIX_COLS; col++) { + reset_inputs(); + reset_outputs(); + select_output(col); + _delay_us(3); + uint16_t rows = read_inputs(); + for (uint8_t row = 0; row < MATRIX_ROWS; row++) { + bool prev_bit = matrix_debouncing[row] & ((matrix_row_t)1<