di0ib
/
tmk_keyboard
Watch 1
Star 0
Fork 0
Code Releases 4 Activity
Browse Source

gherkin

master
di0ib 6 years ago
parent
5b05207b69
commit
98225c31a6
8 changed files with 661 additions and 0 deletions
Split View Show Diff Stats
  1. 136
    0
      keyboard/gherkin/Makefile
  2. 34
    0
      keyboard/gherkin/actionmap_common.h
  3. 67
    0
      keyboard/gherkin/actionmap_gherkin.c
  4. 54
    0
      keyboard/gherkin/backlight.c
  5. 74
    0
      keyboard/gherkin/config.h
  6. 38
    0
      keyboard/gherkin/led.c
  7. 245
    0
      keyboard/gherkin/matrix.c
  8. 13
    0
      keyboard/gherkin/readme.md

+ 136
- 0
keyboard/gherkin/Makefile View File

@@ -0,0 +1,136 @@
#----------------------------------------------------------------------------
# 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 = gherkin

# Directory common source filess exist
TMK_DIR = ../../tmk_core

# Directory keyboard dependent files exist
TARGET_DIR = .

# project specific files
SRC = matrix.c \
led.c \
backlight.c

ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
else
SRC := actionmap_gherkin.c $(SRC)
endif

CONFIG_H = config.h


# MCU name
#MCU = at90usb1287
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
# comment out to disable the options.
#
ACTIONMAP_ENABLE = yes # Use 16bit action codes in keymap instead of 8bit keycodes
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

# Optimize size but this may cause error "relocation truncated to fit"
#EXTRALDFLAGS = -Wl,--relax

# Search Path
VPATH += $(TARGET_DIR)
VPATH += $(TMK_DIR)

include $(TMK_DIR)/protocol/lufa.mk
include $(TMK_DIR)/common.mk
include $(TMK_DIR)/rules.mk

+ 34
- 0
keyboard/gherkin/actionmap_common.h View File

@@ -0,0 +1,34 @@
/*
Copyright 2015 Jun Wako <[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/>.
*/
#ifndef ACTIONMAP_COMMON_H
#define ACTIONMAP_COMMON_H


/* keymap definition macro */

#define ACTIONMAP( \
K00, K01, K02, K03, K04, K05, K10, K11, K12, K13, \
K14, K15, K20, K21, K22, K23, K24, K25, K30, K31, \
K32, K33, K34, K35, K40, K41, K42, K43, K44, K45 \
) { \
{ AC_##K00, AC_##K01, AC_##K02, AC_##K03, AC_##K04, AC_##K05 }, \
{ AC_##K10, AC_##K11, AC_##K12, AC_##K13, AC_##K14, AC_##K15 }, \
{ AC_##K20, AC_##K21, AC_##K22, AC_##K23, AC_##K24, AC_##K25 }, \
{ AC_##K30, AC_##K31, AC_##K32, AC_##K33, AC_##K34, AC_##K35 }, \
{ AC_##K40, AC_##K41, AC_##K42, AC_##K43, AC_##K44, AC_##K45 } \
}
#endif

+ 67
- 0
keyboard/gherkin/actionmap_gherkin.c View File

@@ -0,0 +1,67 @@
#include "actionmap.h"
#include "action_code.h"
#include "actionmap_common.h"


/*
* Actions
*/
#define AC_BLD ACTION_BACKLIGHT_DECREASE()
#define AC_BLI ACTION_BACKLIGHT_INCREASE()
#define AC_TL1 ACTION_LAYER_TAP_KEY(1, KC_SPACE)
#define AC_TL2 ACTION_LAYER_TAP_KEY(2, KC_BSPACE)
#define AC_TL3 ACTION_LAYER_TAP_KEY(3, KC_C)
#define AC_TL4 ACTION_LAYER_TAP_KEY(4, KC_V)
#define AC_TL5 ACTION_LAYER_TAP_KEY(5, KC_B)
#define AC_TM1 ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT)
#define AC_TM2 ACTION_MODS_TAP_KEY(MOD_LCTL, KC_Z)
#define AC_TM3 ACTION_MODS_TAP_KEY(MOD_LALT, KC_X)
#define AC_TM4 ACTION_MODS_TAP_KEY(MOD_RALT, KC_N)
#define AC_TM5 ACTION_MODS_TAP_KEY(MOD_RCTL, KC_M)
#define AC_S01 ACTION_MODS_KEY(MOD_LSFT, KC_1)
#define AC_S02 ACTION_MODS_KEY(MOD_LSFT, KC_2)
#define AC_S03 ACTION_MODS_KEY(MOD_LSFT, KC_3)
#define AC_S04 ACTION_MODS_KEY(MOD_LSFT, KC_4)
#define AC_S05 ACTION_MODS_KEY(MOD_LSFT, KC_5)
#define AC_S06 ACTION_MODS_KEY(MOD_LSFT, KC_6)
#define AC_S07 ACTION_MODS_KEY(MOD_LSFT, KC_7)
#define AC_S08 ACTION_MODS_KEY(MOD_LSFT, KC_8)
#define AC_S09 ACTION_MODS_KEY(MOD_LSFT, KC_9)
#define AC_S10 ACTION_MODS_KEY(MOD_LSFT, KC_0)
#define AC_S11 ACTION_MODS_KEY(MOD_LSFT, KC_MINS)
#define AC_S12 ACTION_MODS_KEY(MOD_LSFT, KC_EQL)
#define AC_S13 ACTION_MODS_KEY(MOD_LSFT, KC_LBRC)
#define AC_S14 ACTION_MODS_KEY(MOD_LSFT, KC_RBRC)
#define AC_S15 ACTION_MODS_KEY(MOD_LSFT, KC_BSLS)
#define AC_S16 ACTION_MODS_KEY(MOD_LSFT, KC_COMM)
#define AC_S17 ACTION_MODS_KEY(MOD_LSFT, KC_DOT)
#define AC_S18 ACTION_MODS_KEY(MOD_LSFT, KC_SLSH)
#define AC_S19 ACTION_MODS_KEY(MOD_LSFT, KC_SCLN)
#define AC_S20 ACTION_MODS_KEY(MOD_LSFT, KC_QUOT)

const action_t PROGMEM actionmaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = ACTIONMAP( \
Q, W, E, R, T, Y, U, I, O, P, \
A, S, D, F, G, H, J, K, L, ESC, \
TM2, TM3, TL3, TL4, TL2, TL1, TL5, TM4, TM5, TM1),
[1] = ACTIONMAP( \
1, 2, 3, 4, 5, 6, 7, 8, 9, 0, \
F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, \
TRNS, TRNS, TRNS, TRNS, DEL, TRNS, TRNS, TRNS, TRNS, TRNS),
[2] = ACTIONMAP( \
S01, S02, S03, S04, S05, S06, S07, S08, S09, S10, \
F11, F12, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, GRV, \
TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS),
[3] = ACTIONMAP( \
TRNS, TRNS, TRNS, TRNS, TRNS, MINS, EQL, LBRC, RBRC, BSLS, \
TAB, TRNS, TRNS, TRNS, TRNS, COMM, DOT, SLSH, SCLN, QUOT, \
TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, LEFT, DOWN, UP, RGHT),
[4] = ACTIONMAP( \
TRNS, TRNS, TRNS, TRNS, TRNS, S11, S12, S13, S14, S15, \
TAB, TRNS, TRNS, TRNS, TRNS, S16, S17, S18, S19, S20, \
TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, HOME, PGDN, PGUP, END),
[5] = ACTIONMAP( \
CALC, WHOM, MAIL, MYCM, TRNS, TRNS, TRNS, TRNS, TRNS, PSCR, \
TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, TRNS, BLD, BLI, \
TRNS, TRNS, TRNS, TRNS, BTLD, TRNS, TRNS, TRNS, TRNS, TRNS),
};

+ 54
- 0
keyboard/gherkin/backlight.c View File

@@ -0,0 +1,54 @@
// http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
#include <avr/io.h>
#include "backlight.h"

#define FET OCR1A

uint8_t led_counter = 0;
uint8_t led_level = 0;


void backlight_init_ports()
{
DDRB |= (1<<5);
PORTB &= ~(1<<5);

TCCR1A = _BV(COM1A1) | _BV(WGM11); // = 0b10000010;
TCCR1B = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;

ICR1 = 0xFFFF;

FET = 0x0000;

backlight_init();
}

void backlight_set(uint8_t level)
{
if ( level == 0 )
{
// Turn off PWM control on PB5, revert to output low.
TCCR1A &= ~(_BV(COM1A1));
FET = 0x0000;
// Prevent backlight blink on lowest level
PORTB &= ~(_BV(PORTB5));
}
else if ( level == BACKLIGHT_LEVELS )
{
// Prevent backlight blink on lowest level
PORTB &= ~(_BV(PORTB5));
// Turn on PWM control of PB5
TCCR1A |= _BV(COM1A1);
// Set the brightness
FET = 0xFFFF;
}
else
{
// Prevent backlight blink on lowest level
PORTB &= ~(_BV(PORTB5));
// Turn on PWM control of PB5
TCCR1A |= _BV(COM1A1);
// Set the brightness
FET = 0xFFFF >> ((BACKLIGHT_LEVELS - level) * ((BACKLIGHT_LEVELS + 1) / 2));
}
}

+ 74
- 0
keyboard/gherkin/config.h View File

@@ -0,0 +1,74 @@
/*
Copyright 2012 Jun Wako <[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/>.
*/

#ifndef CONFIG_H
#define CONFIG_H


/* USB Device descriptor parameter */
#define VENDOR_ID 0xFEED
#define PRODUCT_ID 0x0A0C
#define DEVICE_VER 0x0070
#define MANUFACTURER di0ib
#define PRODUCT The gherkin Keyboard
#define DESCRIPTION A 30 key keyboard

/* Bootmagic */
#define BOOTMAGIC_KEY_SALT KC_Q

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 6

/* define if matrix has ghost */
//#define MATRIX_HAS_GHOST

/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5

/* 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)) \
)

/*
* Feature disable options
* These options are also useful to firmware size reduction.
*/
/* number of backlight levels */
#define BACKLIGHT_LEVELS 4

/* disable debug print */
//#define NO_DEBUG

/* disable print */
//#define NO_PRINT

/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
//#define NO_ACTION_MACRO
//#define NO_ACTION_FUNCTION

#endif

+ 38
- 0
keyboard/gherkin/led.c View File

@@ -0,0 +1,38 @@
/*
Copyright 2012 Jun Wako <[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 <avr/io.h>
#include "stdint.h"
#include "led.h"


void led_set(uint8_t usb_led)
{
if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
// output low
DDRB |= (1<<0);
PORTB &= ~(1<<0);
DDRD |= (1<<5);
PORTD &= ~(1<<5);
} else {
// Hi-Z
DDRB &= ~(1<<0);
PORTB &= ~(1<<0);
DDRD &= ~(1<<5);
PORTD &= ~(1<<5);
}
}

+ 245
- 0
keyboard/gherkin/matrix.c View File

@@ -0,0 +1,245 @@
/*
Copyright 2012 Jun Wako <[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/>.
*/

/*
* scan matrix
*/
#include <stdint.h>
#include <stdbool.h>
#include <avr/io.h>
#include <util/delay.h>
#include "print.h"
#include "debug.h"
#include "util.h"
#include "matrix.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 matrix_row_t read_cols(void);
static void init_cols(void);
static void unselect_rows(void);
static void select_row(uint8_t row);


inline
uint8_t matrix_rows(void)
{
return MATRIX_ROWS;
}

inline
uint8_t matrix_cols(void)
{
return MATRIX_COLS;
}

void matrix_init(void)
{
// To use PORTF disable JTAG with writing JTD bit twice within four cycles.
MCUCR |= (1<<JTD);
MCUCR |= (1<<JTD);

backlight_init_ports();

// initialize row and col
unselect_rows();
init_cols();

// initialize matrix state: all keys off
for (uint8_t i=0; i < MATRIX_ROWS; i++) {
matrix[i] = 0;
matrix_debouncing[i] = 0;
}
}

uint8_t matrix_scan(void)
{

for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
select_row(i);
_delay_us(30); // without this wait read unstable value.
matrix_row_t cols = read_cols();
if (matrix_debouncing[i] != cols) {
matrix_debouncing[i] = cols;
if (debouncing) {
debug("bounce!: "); debug_hex(debouncing); debug("\n");
}
debouncing = DEBOUNCE;
}
unselect_rows();
}

if (debouncing) {
if (--debouncing) {
_delay_ms(1);
} else {
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
matrix[i] = matrix_debouncing[i];
}
}
}

return 1;
}

bool matrix_is_modified(void)
{
if (debouncing) return false;
return true;
}

inline
bool matrix_is_on(uint8_t row, uint8_t col)
{
return (matrix[row] & ((matrix_row_t)1<<col));
}

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++) {
phex(row); print(": ");
pbin_reverse16(matrix_get_row(row));
print("\n");
}
}

uint8_t matrix_key_count(void)
{
uint8_t count = 0;
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
count += bitpop16(matrix[i]);
}
return count;
}

/* Column pin configuration
* col: 0 1 2 3 4 5
* pin: D0, D4, C6, D7, E6, B4
*/
static void init_cols(void)
{
// Input with pull-up(DDR:0, PORT:1)
DDRD &= ~(1<<0 | 1<<4 | 1<<7 );
PORTD |= (1<<0 | 1<<4 | 1<<7 );
DDRB &= ~(1<<4);
PORTB |= (1<<4);
DDRC &= ~(1<<6);
PORTC |= (1<<6);
DDRE &= ~(1<<6);
PORTE |= (1<<6);
}

static matrix_row_t read_cols(void)
{
/* //LED on Bottom of switch
return (PIND&(1<<0) ? 0 : (1<<0)) |
(PIND&(1<<4) ? 0 : (1<<1)) |
(PINC&(1<<6) ? 0 : (1<<2)) |
(PIND&(1<<7) ? 0 : (1<<3)) |
(PINE&(1<<6) ? 0 : (1<<4)) |
(PINB&(1<<4) ? 0 : (1<<5));
*/
//LED on Top of switch
return (PIND&(1<<0) ? 0 : (1<<5)) |
(PIND&(1<<4) ? 0 : (1<<4)) |
(PINC&(1<<6) ? 0 : (1<<3)) |
(PIND&(1<<7) ? 0 : (1<<2)) |
(PINE&(1<<6) ? 0 : (1<<1)) |
(PINB&(1<<4) ? 0 : (1<<0));
}

/* Row pin configuration
* row: 0 1 2 3 4
* pin: B6, B2, B3, B1, F7
*/
static void unselect_rows(void)
{
// Hi-Z(DDR:0, PORT:0) to unselect
DDRF &= ~0b10000000;
PORTF &= ~0b10000000;
DDRB &= ~0b01001110;
PORTB &= ~0b01001110;
}

static void select_row(uint8_t row)
{
// Output low(DDR:1, PORT:0) to select
/* //LED on Bottom of switch
switch (row) {
case 0:
DDRB |= (1<<6);
PORTB &= ~(1<<6);
break;
case 1:
DDRB |= (1<<2);
PORTB &= ~(1<<2);
break;
case 2:
DDRB |= (1<<3);
PORTB &= ~(1<<3);
break;
case 3:
DDRB |= (1<<1);
PORTB &= ~(1<<1);
break;
case 4:
DDRF |= (1<<7);
PORTF &= ~(1<<7);
break;
}
*/
//LED on Top of switch
switch (row) {
case 4:
DDRB |= (1<<6);
PORTB &= ~(1<<6);
break;
case 3:
DDRB |= (1<<2);
PORTB &= ~(1<<2);
break;
case 2:
DDRB |= (1<<3);
PORTB &= ~(1<<3);
break;
case 1:
DDRB |= (1<<1);
PORTB &= ~(1<<1);
break;
case 0:
DDRF |= (1<<7);
PORTF &= ~(1<<7);
break;
}

}

+ 13
- 0
keyboard/gherkin/readme.md View File

@@ -0,0 +1,13 @@
## gherkin keyboard firmware
![gherkin 1.0 Assembled](gherkin.jpg)
======================
gherkin keyboard. 6x5 matrix.
![gherkin 1.0 PCB Front](pcb-top.png)
![gherkin 1.0 PCB Bottom](pcb-bottom.png)

Pinout

col: D0, D4, C6, D7, E6, B4
row: B6, B2, B3, B1, F7

Mosfet on B5 to control backlight.

Write Preview
Loading…
Cancel
Save