* add plaid * Change usb vid/pid to free id from vusb Trivial fix for vusb core * update readme * update info.json default keymap * fix typo * Replace copyrightpull/5387/head
@ -0,0 +1,248 @@ | |||
/* | |||
Copyright 2019 Takuya Urakawa (dm9records.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/>. | |||
*/ | |||
#pragma once | |||
#include "config_common.h" | |||
/* USB Device descriptor parameter */ | |||
/* VID & PID from vusb project, see tmk_core/protocol/vusb/USB-IDs-for-free.txt"*/ | |||
#define VENDOR_ID 0x16c0 | |||
#define PRODUCT_ID 0x27db | |||
#define DEVICE_VER 0x0002 | |||
#define MANUFACTURER dm9records | |||
#define PRODUCT plaid | |||
#define DESCRIPTION 12x4 ortholinear keyboard with through hole components | |||
/* key matrix size */ | |||
#define MATRIX_ROWS 4 | |||
#define MATRIX_COLS 12 | |||
/* | |||
* Keyboard Matrix Assignments | |||
* | |||
* Change this to how you wired your keyboard | |||
* COLS: AVR pins used for columns, left to right | |||
* ROWS: AVR pins used for rows, top to bottom | |||
* DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) | |||
* ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) | |||
* | |||
*/ | |||
#define MATRIX_ROW_PINS { B4, B5, B3, D4 } | |||
#define MATRIX_COL_PINS { B0, D7, D6, D5, B2, B1, C0, C1, C2, C3, D1, D0 } | |||
#define UNUSED_PINS | |||
/* COL2ROW, ROW2COL*/ | |||
#define DIODE_DIRECTION COL2ROW | |||
#define NO_UART 1 | |||
/* | |||
* Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN. | |||
*/ | |||
// #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6 | |||
// #define BACKLIGHT_PIN B7 | |||
// #define BACKLIGHT_BREATHING | |||
// #define BACKLIGHT_LEVELS 3 | |||
// #define RGB_DI_PIN E2 | |||
// #ifdef RGB_DI_PIN | |||
// #define RGBLED_NUM 16 | |||
// #define RGBLIGHT_HUE_STEP 8 | |||
// #define RGBLIGHT_SAT_STEP 8 | |||
// #define RGBLIGHT_VAL_STEP 8 | |||
// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */ | |||
// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */ | |||
// /*== all animations enable ==*/ | |||
// #define RGBLIGHT_ANIMATIONS | |||
// /*== or choose animations ==*/ | |||
// #define RGBLIGHT_EFFECT_BREATHING | |||
// #define RGBLIGHT_EFFECT_RAINBOW_MOOD | |||
// #define RGBLIGHT_EFFECT_RAINBOW_SWIRL | |||
// #define RGBLIGHT_EFFECT_SNAKE | |||
// #define RGBLIGHT_EFFECT_KNIGHT | |||
// #define RGBLIGHT_EFFECT_CHRISTMAS | |||
// #define RGBLIGHT_EFFECT_STATIC_GRADIENT | |||
// #define RGBLIGHT_EFFECT_RGB_TEST | |||
// #define RGBLIGHT_EFFECT_ALTERNATING | |||
// #endif | |||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ | |||
#define DEBOUNCING_DELAY 5 | |||
/* define if matrix has ghost (lacks anti-ghosting diodes) */ | |||
//#define MATRIX_HAS_GHOST | |||
/* number of backlight levels */ | |||
/* 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 | |||
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held. | |||
* This is userful for the Windows task manager shortcut (ctrl+shift+esc). | |||
*/ | |||
// #define GRAVE_ESC_CTRL_OVERRIDE | |||
/* | |||
* Force NKRO | |||
* | |||
* Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved | |||
* state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the | |||
* makefile for this to work.) | |||
* | |||
* If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N) | |||
* until the next keyboard reset. | |||
* | |||
* NKRO may prevent your keystrokes from being detected in the BIOS, but it is | |||
* fully operational during normal computer usage. | |||
* | |||
* For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N) | |||
* or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by | |||
* bootmagic, NKRO mode will always be enabled until it is toggled again during a | |||
* power-up. | |||
* | |||
*/ | |||
//#define FORCE_NKRO | |||
/* | |||
* Magic Key Options | |||
* | |||
* Magic keys are hotkey commands that allow control over firmware functions of | |||
* the keyboard. They are best used in combination with the HID Listen program, | |||
* found here: https://www.pjrc.com/teensy/hid_listen.html | |||
* | |||
* The options below allow the magic key functionality to be changed. This is | |||
* useful if your keyboard/keypad is missing keys and you want magic key support. | |||
* | |||
*/ | |||
/* key combination for magic key command */ | |||
/* defined by default; to change, uncomment and set to the combination you want */ | |||
// #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))) | |||
/* control how magic key switches layers */ | |||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true | |||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true | |||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false | |||
/* override magic key keymap */ | |||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS | |||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS | |||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM | |||
//#define MAGIC_KEY_HELP H | |||
//#define MAGIC_KEY_HELP_ALT SLASH | |||
//#define MAGIC_KEY_DEBUG D | |||
//#define MAGIC_KEY_DEBUG_MATRIX X | |||
//#define MAGIC_KEY_DEBUG_KBD K | |||
//#define MAGIC_KEY_DEBUG_MOUSE M | |||
//#define MAGIC_KEY_VERSION V | |||
//#define MAGIC_KEY_STATUS S | |||
//#define MAGIC_KEY_CONSOLE C | |||
//#define MAGIC_KEY_LAYER0 0 | |||
//#define MAGIC_KEY_LAYER0_ALT GRAVE | |||
//#define MAGIC_KEY_LAYER1 1 | |||
//#define MAGIC_KEY_LAYER2 2 | |||
//#define MAGIC_KEY_LAYER3 3 | |||
//#define MAGIC_KEY_LAYER4 4 | |||
//#define MAGIC_KEY_LAYER5 5 | |||
//#define MAGIC_KEY_LAYER6 6 | |||
//#define MAGIC_KEY_LAYER7 7 | |||
//#define MAGIC_KEY_LAYER8 8 | |||
//#define MAGIC_KEY_LAYER9 9 | |||
//#define MAGIC_KEY_BOOTLOADER B | |||
//#define MAGIC_KEY_BOOTLOADER_ALT ESC | |||
//#define MAGIC_KEY_LOCK CAPS | |||
//#define MAGIC_KEY_EEPROM E | |||
//#define MAGIC_KEY_EEPROM_CLEAR BSPACE | |||
//#define MAGIC_KEY_NKRO N | |||
//#define MAGIC_KEY_SLEEP_LED Z | |||
/* | |||
* Feature disable options | |||
* These options are also useful to firmware size reduction. | |||
*/ | |||
/* 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 | |||
/* | |||
* MIDI options | |||
*/ | |||
/* Prevent use of disabled MIDI features in the keymap */ | |||
//#define MIDI_ENABLE_STRICT 1 | |||
/* enable basic MIDI features: | |||
- MIDI notes can be sent when in Music mode is on | |||
*/ | |||
//#define MIDI_BASIC | |||
/* enable advanced MIDI features: | |||
- MIDI notes can be added to the keymap | |||
- Octave shift and transpose | |||
- Virtual sustain, portamento, and modulation wheel | |||
- etc. | |||
*/ | |||
//#define MIDI_ADVANCED | |||
/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */ | |||
//#define MIDI_TONE_KEYCODE_OCTAVES 1 | |||
/* | |||
* HD44780 LCD Display Configuration | |||
*/ | |||
/* | |||
#define LCD_LINES 2 //< number of visible lines of the display | |||
#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display | |||
#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode | |||
#if LCD_IO_MODE | |||
#define LCD_PORT PORTB //< port for the LCD lines | |||
#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0 | |||
#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1 | |||
#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2 | |||
#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3 | |||
#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0 | |||
#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1 | |||
#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2 | |||
#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3 | |||
#define LCD_RS_PORT LCD_PORT //< port for RS line | |||
#define LCD_RS_PIN 3 //< pin for RS line | |||
#define LCD_RW_PORT LCD_PORT //< port for RW line | |||
#define LCD_RW_PIN 2 //< pin for RW line | |||
#define LCD_E_PORT LCD_PORT //< port for Enable line | |||
#define LCD_E_PIN 1 //< pin for Enable line | |||
#endif | |||
*/ | |||
/* Bootmagic Lite key configuration */ | |||
// #define BOOTMAGIC_LITE_ROW 0 | |||
// #define BOOTMAGIC_LITE_COLUMN 0 |
@ -0,0 +1,113 @@ | |||
{ | |||
"keyboard_name": "Plaid // Through Hole", | |||
"keyboard_folder": "planid", | |||
"url": "https://github.com/hsgw/plaid", | |||
"maintainer": "hsgw", | |||
"width": 12, | |||
"height": 4, | |||
"layouts": { | |||
"LAYOUT_plaid_mit": { | |||
"key_count": 47, | |||
"layout": [ | |||
{ "w": 1, "x": 0, "y": 0 }, | |||
{ "w": 1, "x": 1, "y": 0 }, | |||
{ "w": 1, "x": 2, "y": 0 }, | |||
{ "w": 1, "x": 3, "y": 0 }, | |||
{ "w": 1, "x": 4, "y": 0 }, | |||
{ "w": 1, "x": 5, "y": 0 }, | |||
{ "w": 1, "x": 6, "y": 0 }, | |||
{ "w": 1, "x": 7, "y": 0 }, | |||
{ "w": 1, "x": 8, "y": 0 }, | |||
{ "w": 1, "x": 9, "y": 0 }, | |||
{ "w": 1, "x": 10, "y": 0 }, | |||
{ "w": 1, "x": 11, "y": 0 }, | |||
{ "w": 1, "x": 0, "y": 1 }, | |||
{ "w": 1, "x": 1, "y": 1 }, | |||
{ "w": 1, "x": 2, "y": 1 }, | |||
{ "w": 1, "x": 3, "y": 1 }, | |||
{ "w": 1, "x": 4, "y": 1 }, | |||
{ "w": 1, "x": 5, "y": 1 }, | |||
{ "w": 1, "x": 6, "y": 1 }, | |||
{ "w": 1, "x": 7, "y": 1 }, | |||
{ "w": 1, "x": 8, "y": 1 }, | |||
{ "w": 1, "x": 9, "y": 1 }, | |||
{ "w": 1, "x": 10, "y": 1 }, | |||
{ "w": 1, "x": 11, "y": 1 }, | |||
{ "w": 1, "x": 0, "y": 2 }, | |||
{ "w": 1, "x": 1, "y": 2 }, | |||
{ "w": 1, "x": 2, "y": 2 }, | |||
{ "w": 1, "x": 3, "y": 2 }, | |||
{ "w": 1, "x": 4, "y": 2 }, | |||
{ "w": 1, "x": 5, "y": 2 }, | |||
{ "w": 1, "x": 6, "y": 2 }, | |||
{ "w": 1, "x": 7, "y": 2 }, | |||
{ "w": 1, "x": 8, "y": 2 }, | |||
{ "w": 1, "x": 9, "y": 2 }, | |||
{ "w": 1, "x": 10, "y": 2 }, | |||
{ "w": 1, "x": 11, "y": 2 }, | |||
{ "w": 1, "x": 0, "y": 3 }, | |||
{ "w": 1, "x": 1, "y": 3 }, | |||
{ "w": 1, "x": 2, "y": 3 }, | |||
{ "w": 1, "x": 3, "y": 3 }, | |||
{ "w": 1, "x": 4, "y": 3 }, | |||
{ "w": 2, "x": 5, "y": 3 }, | |||
{ "w": 1, "x": 7, "y": 3 }, | |||
{ "w": 1, "x": 8, "y": 3 }, | |||
{ "w": 1, "x": 9, "y": 3 }, | |||
{ "w": 1, "x": 10, "y": 3 }, | |||
{ "w": 1, "x": 11, "y": 3 } ] | |||
}, | |||
"LAYOUT_plaid_grid": { | |||
"key_count": 48, | |||
"layout": [ | |||
{ "w": 1, "x": 0, "y": 0 }, | |||
{ "w": 1, "x": 1, "y": 0 }, | |||
{ "w": 1, "x": 2, "y": 0 }, | |||
{ "w": 1, "x": 3, "y": 0 }, | |||
{ "w": 1, "x": 4, "y": 0 }, | |||
{ "w": 1, "x": 5, "y": 0 }, | |||
{ "w": 1, "x": 6, "y": 0 }, | |||
{ "w": 1, "x": 7, "y": 0 }, | |||
{ "w": 1, "x": 8, "y": 0 }, | |||
{ "w": 1, "x": 9, "y": 0 }, | |||
{ "w": 1, "x": 10, "y": 0 }, | |||
{ "w": 1, "x": 11, "y": 0 }, | |||
{ "w": 1, "x": 0, "y": 1 }, | |||
{ "w": 1, "x": 1, "y": 1 }, | |||
{ "w": 1, "x": 2, "y": 1 }, | |||
{ "w": 1, "x": 3, "y": 1 }, | |||
{ "w": 1, "x": 4, "y": 1 }, | |||
{ "w": 1, "x": 5, "y": 1 }, | |||
{ "w": 1, "x": 6, "y": 1 }, | |||
{ "w": 1, "x": 7, "y": 1 }, | |||
{ "w": 1, "x": 8, "y": 1 }, | |||
{ "w": 1, "x": 9, "y": 1 }, | |||
{ "w": 1, "x": 10, "y": 1 }, | |||
{ "w": 1, "x": 11, "y": 1 }, | |||
{ "w": 1, "x": 0, "y": 2 }, | |||
{ "w": 1, "x": 1, "y": 2 }, | |||
{ "w": 1, "x": 2, "y": 2 }, | |||
{ "w": 1, "x": 3, "y": 2 }, | |||
{ "w": 1, "x": 4, "y": 2 }, | |||
{ "w": 1, "x": 5, "y": 2 }, | |||
{ "w": 1, "x": 6, "y": 2 }, | |||
{ "w": 1, "x": 7, "y": 2 }, | |||
{ "w": 1, "x": 8, "y": 2 }, | |||
{ "w": 1, "x": 9, "y": 2 }, | |||
{ "w": 1, "x": 10, "y": 2 }, | |||
{ "w": 1, "x": 11, "y": 2 }, | |||
{ "w": 1, "x": 0, "y": 3 }, | |||
{ "w": 1, "x": 1, "y": 3 }, | |||
{ "w": 1, "x": 2, "y": 3 }, | |||
{ "w": 1, "x": 3, "y": 3 }, | |||
{ "w": 1, "x": 4, "y": 3 }, | |||
{ "w": 1, "x": 5, "y": 3 }, | |||
{ "w": 1, "x": 6, "y": 3 }, | |||
{ "w": 1, "x": 7, "y": 3 }, | |||
{ "w": 1, "x": 8, "y": 3 }, | |||
{ "w": 1, "x": 9, "y": 3 }, | |||
{ "w": 1, "x": 10, "y": 3 }, | |||
{ "w": 1, "x": 11, "y": 3 } ] | |||
} | |||
} | |||
} |
@ -0,0 +1,19 @@ | |||
/* Copyright 2019 Takuya Urakawa (dm9records.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/>. | |||
*/ | |||
#pragma once | |||
// place overrides here |
@ -0,0 +1,222 @@ | |||
/* Copyright 2019 Takuya Urakawa (dm9records.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 QMK_KEYBOARD_H | |||
extern keymap_config_t keymap_config; | |||
enum plaid_layers { | |||
_QWERTY, | |||
_COLEMAK, | |||
_DVORAK, | |||
_LOWER, | |||
_RAISE, | |||
_PLOVER, | |||
_ADJUST | |||
}; | |||
enum plaid_keycodes { | |||
QWERTY = SAFE_RANGE, | |||
COLEMAK, | |||
DVORAK, | |||
PLOVER, | |||
EXT_PLV | |||
}; | |||
#define LOWER MO(_LOWER) | |||
#define RAISE MO(_RAISE) | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
/* Qwerty | |||
* ,-----------------------------------------------------------------------------------. | |||
* | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | Esc | A | S | D | F | G | H | J | K | L | ; | " | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | Shift| Z | X | C | V | B | N | M | , | . | / |Enter | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | Ctrl | RAlt | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_QWERTY] = LAYOUT_plaid_grid( | |||
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, | |||
KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, | |||
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , | |||
KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT | |||
), | |||
/* Colemak | |||
* ,-----------------------------------------------------------------------------------. | |||
* | Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | Esc | A | R | S | T | D | H | N | E | I | O | " | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | Shift| Z | X | C | V | B | K | M | , | . | / |Enter | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | Ctrl | RAlt | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_COLEMAK] = LAYOUT_plaid_grid( | |||
KC_TAB, KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_SCLN, KC_BSPC, | |||
KC_ESC, KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O, KC_QUOT, | |||
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT , | |||
KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT | |||
), | |||
/* Dvorak | |||
* ,-----------------------------------------------------------------------------------. | |||
* | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | Esc | A | O | E | U | I | D | H | T | N | S | / | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | Ctrl | RAlt | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_DVORAK] = LAYOUT_plaid_grid( | |||
KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_BSPC, | |||
KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_SLSH, | |||
KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_ENT , | |||
KC_LCTL, KC_RALT, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT | |||
), | |||
/* Lower | |||
* ,-----------------------------------------------------------------------------------. | |||
* | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | | | | | | | | Next | Vol- | Vol+ | Play | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_LOWER] = LAYOUT_plaid_grid( | |||
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC, | |||
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, | |||
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, S(KC_NUHS), S(KC_NUBS), KC_HOME, KC_END, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY | |||
), | |||
/* Raise | |||
* ,-----------------------------------------------------------------------------------. | |||
* | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | | | | | | | | Next | Vol- | Vol+ | Play | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_RAISE] = LAYOUT_plaid_grid( | |||
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC, | |||
KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, | |||
_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY | |||
), | |||
/* Plover layer (http://opensteno.org) | |||
* ,-----------------------------------------------------------------------------------. | |||
* | # | # | # | # | # | # | # | # | # | # | # | # | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | | S | T | P | H | * | * | F | P | L | T | D | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | | S | K | W | R | * | * | R | B | G | S | Z | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | Exit | | | A | O | | E | U | | | | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_PLOVER] = LAYOUT_plaid_grid( | |||
KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1, KC_1 , | |||
XXXXXXX, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, | |||
XXXXXXX, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, | |||
EXT_PLV, XXXXXXX, XXXXXXX, KC_C, KC_V, XXXXXXX, XXXXXXX, KC_N, KC_M, XXXXXXX, XXXXXXX, XXXXXXX | |||
), | |||
/* Adjust (Lower + Raise) | |||
* ,-----------------------------------------------------------------------------------. | |||
* | | Reset| | | | | | | | | | Del | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------| | |||
* | | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover| | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------| | |||
* | |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------| | |||
* | | | | | | | | | | | | | |||
* `-----------------------------------------------------------------------------------' | |||
*/ | |||
[_ADJUST] = LAYOUT_plaid_grid( | |||
_______, RESET, DEBUG, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL , | |||
_______, _______, MU_MOD, AU_ON, AU_OFF, AG_NORM, AG_SWAP, QWERTY, COLEMAK, DVORAK, PLOVER, _______, | |||
_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, TERM_ON, TERM_OFF, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ | |||
) | |||
}; | |||
uint32_t layer_state_set_user(uint32_t state) { | |||
return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); | |||
} | |||
bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
switch (keycode) { | |||
case QWERTY: | |||
if (record->event.pressed) { | |||
print("mode just switched to qwerty and this is a huge string\n"); | |||
set_single_persistent_default_layer(_QWERTY); | |||
} | |||
return false; | |||
break; | |||
case COLEMAK: | |||
if (record->event.pressed) { | |||
set_single_persistent_default_layer(_COLEMAK); | |||
} | |||
return false; | |||
break; | |||
case DVORAK: | |||
if (record->event.pressed) { | |||
set_single_persistent_default_layer(_DVORAK); | |||
} | |||
return false; | |||
break; | |||
case PLOVER: | |||
if (record->event.pressed) { | |||
layer_off(_RAISE); | |||
layer_off(_LOWER); | |||
layer_off(_ADJUST); | |||
layer_on(_PLOVER); | |||
if (!eeconfig_is_enabled()) { | |||
eeconfig_init(); | |||
} | |||
keymap_config.raw = eeconfig_read_keymap(); | |||
keymap_config.nkro = 1; | |||
eeconfig_update_keymap(keymap_config.raw); | |||
} | |||
return false; | |||
break; | |||
case EXT_PLV: | |||
if (record->event.pressed) { | |||
layer_off(_PLOVER); | |||
} | |||
return false; | |||
break; | |||
} | |||
return true; | |||
} |
@ -0,0 +1,2 @@ | |||
# The default keymap for plaid | |||
folk from planck |
@ -0,0 +1,43 @@ | |||
/* Copyright 2019 Takuya Urakawa (dm9records.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 "plaid.h" | |||
void matrix_init_kb(void) { | |||
// put your keyboard start-up code here | |||
// runs once when the firmware starts up | |||
matrix_init_user(); | |||
} | |||
void matrix_scan_kb(void) { | |||
// put your looping keyboard code here | |||
// runs every cycle (a lot) | |||
matrix_scan_user(); | |||
} | |||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) { | |||
// put your per-action keyboard code here | |||
// runs for every action, just before processing by the firmware | |||
return process_record_user(keycode, record); | |||
} | |||
void led_set_kb(uint8_t usb_led) { | |||
// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here | |||
led_set_user(usb_led); | |||
} |
@ -0,0 +1,63 @@ | |||
/* Copyright 2019 Takuya Urakawa (dm9records.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/>. | |||
*/ | |||
#pragma once | |||
#include "quantum.h" | |||
#define LAYOUT_plaid_mit( \ | |||
k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \ | |||
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \ | |||
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \ | |||
k30, k31, k32, k33, k34, k35, k37, k38, k39, k3a, k3b \ | |||
) \ | |||
{ \ | |||
{ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \ | |||
{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \ | |||
{ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \ | |||
{ k30, k31, k32, k33, k34, k35, k35, k37, k38, k39, k3a, k3b } \ | |||
} | |||
#define LAYOUT_plaid_grid( \ | |||
k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \ | |||
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \ | |||
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \ | |||
k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \ | |||
) \ | |||
{ \ | |||
{ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \ | |||
{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \ | |||
{ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \ | |||
{ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b } \ | |||
} | |||
// Used to create a keymap using only KC_ prefixed keys | |||
#define KC_KEYMAP( \ | |||
k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \ | |||
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \ | |||
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \ | |||
k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \ | |||
) \ | |||
LAYOUT_plaid_grid( \ | |||
KC_##k00, KC_##k01, KC_##k02, KC_##k03, KC_##k04, KC_##k05, KC_##k06, KC_##k07, KC_##k08, KC_##k09, KC_##k0a, KC_##k0b, \ | |||
KC_##k10, KC_##k11, KC_##k12, KC_##k13, KC_##k14, KC_##k15, KC_##k16, KC_##k17, KC_##k18, KC_##k19, KC_##k1a, KC_##k1b, \ | |||
KC_##k20, KC_##k21, KC_##k22, KC_##k23, KC_##k24, KC_##k25, KC_##k26, KC_##k27, KC_##k28, KC_##k29, KC_##k2a, KC_##k2b, \ | |||
KC_##k30, KC_##k31, KC_##k32, KC_##k33, KC_##k34, KC_##k35, KC_##k36, KC_##k37, KC_##k38, KC_##k39, KC_##k3a, KC_##k3b \ | |||
) | |||
#define KEYMAP LAYOUT_plaid_grid | |||
#define LAYOUT_ortho_4x12 LAYOUT_plaid_grid | |||
#define KC_LAYOUT_ortho_4x12 KC_KEYMAP |
@ -0,0 +1,23 @@ | |||
# plaid // Through Hole | |||
![plaid](https://i.imgur.com/tTi9yR9h.jpg) | |||
12x4 ortholinear keyboard with only through hole components. | |||
Keyboard Maintainer: [hsgw](https://github.com/hsgw) | |||
Hardware Supported: ATMEGA328p with vusb [PCB](https://github.com/hsgw/plaid) | |||
Hardware Availability: Group buy in r/mk | |||
Make example for this keyboard (after setting up your build environment): | |||
make plaid:default | |||
Flash firmware: | |||
// In bootloader mode | |||
make plaid:default:program | |||
## Bootloader | |||
use usbasploader in my repository. | |||
https://github.com/hsgw/USBaspLoader/tree/plaid | |||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |
@ -0,0 +1,101 @@ | |||
# MCU name | |||
#MCU = at90usb1286 | |||
MCU = atmega328p | |||
PROTOCOL = VUSB | |||
# 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 | |||
# Bootloader selection | |||
# Teensy halfkay | |||
# Pro Micro caterina | |||
# Atmel DFU atmel-dfu | |||
# LUFA DFU lufa-dfu | |||
# QMK DFU qmk-dfu | |||
# atmega32a bootloadHID | |||
# | |||
# This uses usbaspbootloader | |||
# BOOTLOADER = atmel-dfu | |||
# If you don't know the bootloader type, then you can specify the | |||
# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line | |||
# Teensy halfKay 512 | |||
# Teensy++ halfKay 1024 | |||
# Atmel DFU loader 4096 | |||
# LUFA bootloader 4096 | |||
# USBaspLoader 2048 | |||
# OPT_DEFS += -DBOOTLOADER_SIZE=4096 | |||
OPT_DEFS += -DBOOTLOADER_SIZE=2048 | |||
# Flash program via avrdude, but default command is not suitable. | |||
# You can use plaid:default:program | |||
PROGRAM_CMD = avrdude -c usbasp -p m328p -U flash:w:$(BUILD_DIR)/$(TARGET).hex | |||
# disable debug code | |||
OPT_DEFS = -DDEBUG_LEVEL=0 | |||
# Build Options | |||
# change yes to no to disable | |||
# | |||
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) | |||
MOUSEKEY_ENABLE = yes # Mouse keys(+4700) | |||
EXTRAKEY_ENABLE = yes # Audio control and System control(+450) | |||
CONSOLE_ENABLE = no # Console for debug(+400) | |||
COMMAND_ENABLE = no # 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 = no # USB Nkey Rollover | |||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default | |||
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow | |||
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 | |||
HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400) | |||
# unsupported features for now | |||
NO_UART = yes | |||
NO_SUSPEND_POWER_DOWN = yes | |||
LAYOUTS = ortho_4x12 planck_mit planck_grid | |||
LAYOUTS_HAS_RGB = no |
@ -0,0 +1,397 @@ | |||
/* Name: usbconfig.h | |||
* Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers | |||
* Author: Christian Starkjohann | |||
* Creation Date: 2005-04-01 | |||
* Tabsize: 4 | |||
* Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH | |||
* License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) | |||
* This Revision: $Id: usbconfig-prototype.h 785 2010-05-30 17:57:07Z cs $ | |||
*/ | |||
#ifndef __usbconfig_h_included__ | |||
#define __usbconfig_h_included__ | |||
#include "config.h" | |||
/* | |||
General Description: | |||
This file is an example configuration (with inline documentation) for the USB | |||
driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is | |||
also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may | |||
wire the lines to any other port, as long as D+ is also wired to INT0 (or any | |||
other hardware interrupt, as long as it is the highest level interrupt, see | |||
section at the end of this file). | |||
*/ | |||
/* ---------------------------- Hardware Config ---------------------------- */ | |||
#define USB_CFG_IOPORTNAME D | |||
/* This is the port where the USB bus is connected. When you configure it to | |||
* "B", the registers PORTB, PINB and DDRB will be used. | |||
*/ | |||
#define USB_CFG_DMINUS_BIT 3 | |||
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. | |||
* This may be any bit in the port. | |||
*/ | |||
#define USB_CFG_DPLUS_BIT 2 | |||
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. | |||
* This may be any bit in the port. Please note that D+ must also be connected | |||
* to interrupt pin INT0! [You can also use other interrupts, see section | |||
* "Optional MCU Description" below, or you can connect D- to the interrupt, as | |||
* it is required if you use the USB_COUNT_SOF feature. If you use D- for the | |||
* interrupt, the USB interrupt will also be triggered at Start-Of-Frame | |||
* markers every millisecond.] | |||
*/ | |||
#define USB_CFG_CLOCK_KHZ (F_CPU/1000) | |||
/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000, | |||
* 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code | |||
* require no crystal, they tolerate +/- 1% deviation from the nominal | |||
* frequency. All other rates require a precision of 2000 ppm and thus a | |||
* crystal! | |||
* Since F_CPU should be defined to your actual clock rate anyway, you should | |||
* not need to modify this setting. | |||
*/ | |||
#define USB_CFG_CHECK_CRC 0 | |||
/* Define this to 1 if you want that the driver checks integrity of incoming | |||
* data packets (CRC checks). CRC checks cost quite a bit of code size and are | |||
* currently only available for 18 MHz crystal clock. You must choose | |||
* USB_CFG_CLOCK_KHZ = 18000 if you enable this option. | |||
*/ | |||
/* ----------------------- Optional Hardware Config ------------------------ */ | |||
/* #define USB_CFG_PULLUP_IOPORTNAME D */ | |||
/* If you connect the 1.5k pullup resistor from D- to a port pin instead of | |||
* V+, you can connect and disconnect the device from firmware by calling | |||
* the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h). | |||
* This constant defines the port on which the pullup resistor is connected. | |||
*/ | |||
/* #define USB_CFG_PULLUP_BIT 4 */ | |||
/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined | |||
* above) where the 1.5k pullup resistor is connected. See description | |||
* above for details. | |||
*/ | |||
/* --------------------------- Functional Range ---------------------------- */ | |||
#define USB_CFG_HAVE_INTRIN_ENDPOINT 1 | |||
/* Define this to 1 if you want to compile a version with two endpoints: The | |||
* default control endpoint 0 and an interrupt-in endpoint (any other endpoint | |||
* number). | |||
*/ | |||
#define USB_CFG_HAVE_INTRIN_ENDPOINT3 1 | |||
/* Define this to 1 if you want to compile a version with three endpoints: The | |||
* default control endpoint 0, an interrupt-in endpoint 3 (or the number | |||
* configured below) and a catch-all default interrupt-in endpoint as above. | |||
* You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature. | |||
*/ | |||
#define USB_CFG_EP3_NUMBER 3 | |||
/* If the so-called endpoint 3 is used, it can now be configured to any other | |||
* endpoint number (except 0) with this macro. Default if undefined is 3. | |||
*/ | |||
/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */ | |||
/* The above macro defines the startup condition for data toggling on the | |||
* interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1. | |||
* Since the token is toggled BEFORE sending any data, the first packet is | |||
* sent with the oposite value of this configuration! | |||
*/ | |||
#define USB_CFG_IMPLEMENT_HALT 0 | |||
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature | |||
* for endpoint 1 (interrupt endpoint). Although you may not need this feature, | |||
* it is required by the standard. We have made it a config option because it | |||
* bloats the code considerably. | |||
*/ | |||
#define USB_CFG_SUPPRESS_INTR_CODE 0 | |||
/* Define this to 1 if you want to declare interrupt-in endpoints, but don't | |||
* want to send any data over them. If this macro is defined to 1, functions | |||
* usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if | |||
* you need the interrupt-in endpoints in order to comply to an interface | |||
* (e.g. HID), but never want to send any data. This option saves a couple | |||
* of bytes in flash memory and the transmit buffers in RAM. | |||
*/ | |||
#define USB_CFG_INTR_POLL_INTERVAL 1 | |||
/* If you compile a version with endpoint 1 (interrupt-in), this is the poll | |||
* interval. The value is in milliseconds and must not be less than 10 ms for | |||
* low speed devices. | |||
*/ | |||
#define USB_CFG_IS_SELF_POWERED 0 | |||
/* Define this to 1 if the device has its own power supply. Set it to 0 if the | |||
* device is powered from the USB bus. | |||
*/ | |||
// max power draw with maxed white underglow measured at 120 mA (peaks) | |||
#define USB_CFG_MAX_BUS_POWER 100 | |||
/* Set this variable to the maximum USB bus power consumption of your device. | |||
* The value is in milliamperes. [It will be divided by two since USB | |||
* communicates power requirements in units of 2 mA.] | |||
*/ | |||
#define USB_CFG_IMPLEMENT_FN_WRITE 1 | |||
/* Set this to 1 if you want usbFunctionWrite() to be called for control-out | |||
* transfers. Set it to 0 if you don't need it and want to save a couple of | |||
* bytes. | |||
*/ | |||
#define USB_CFG_IMPLEMENT_FN_READ 0 | |||
/* Set this to 1 if you need to send control replies which are generated | |||
* "on the fly" when usbFunctionRead() is called. If you only want to send | |||
* data from a static buffer, set it to 0 and return the data from | |||
* usbFunctionSetup(). This saves a couple of bytes. | |||
*/ | |||
#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 | |||
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints. | |||
* You must implement the function usbFunctionWriteOut() which receives all | |||
* interrupt/bulk data sent to any endpoint other than 0. The endpoint number | |||
* can be found in 'usbRxToken'. | |||
*/ | |||
#define USB_CFG_HAVE_FLOWCONTROL 0 | |||
/* Define this to 1 if you want flowcontrol over USB data. See the definition | |||
* of the macros usbDisableAllRequests() and usbEnableAllRequests() in | |||
* usbdrv.h. | |||
*/ | |||
#define USB_CFG_DRIVER_FLASH_PAGE 0 | |||
/* If the device has more than 64 kBytes of flash, define this to the 64 k page | |||
* where the driver's constants (descriptors) are located. Or in other words: | |||
* Define this to 1 for boot loaders on the ATMega128. | |||
*/ | |||
#define USB_CFG_LONG_TRANSFERS 0 | |||
/* Define this to 1 if you want to send/receive blocks of more than 254 bytes | |||
* in a single control-in or control-out transfer. Note that the capability | |||
* for long transfers increases the driver size. | |||
*/ | |||
/* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */ | |||
/* This macro is a hook if you want to do unconventional things. If it is | |||
* defined, it's inserted at the beginning of received message processing. | |||
* If you eat the received message and don't want default processing to | |||
* proceed, do a return after doing your things. One possible application | |||
* (besides debugging) is to flash a status LED on each packet. | |||
*/ | |||
/* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */ | |||
/* This macro is a hook if you need to know when an USB RESET occurs. It has | |||
* one parameter which distinguishes between the start of RESET state and its | |||
* end. | |||
*/ | |||
/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */ | |||
/* This macro (if defined) is executed when a USB SET_ADDRESS request was | |||
* received. | |||
*/ | |||
#define USB_COUNT_SOF 0 | |||
/* define this macro to 1 if you need the global variable "usbSofCount" which | |||
* counts SOF packets. This feature requires that the hardware interrupt is | |||
* connected to D- instead of D+. | |||
*/ | |||
/* #ifdef __ASSEMBLER__ | |||
* macro myAssemblerMacro | |||
* in YL, TCNT0 | |||
* sts timer0Snapshot, YL | |||
* endm | |||
* #endif | |||
* #define USB_SOF_HOOK myAssemblerMacro | |||
* This macro (if defined) is executed in the assembler module when a | |||
* Start Of Frame condition is detected. It is recommended to define it to | |||
* the name of an assembler macro which is defined here as well so that more | |||
* than one assembler instruction can be used. The macro may use the register | |||
* YL and modify SREG. If it lasts longer than a couple of cycles, USB messages | |||
* immediately after an SOF pulse may be lost and must be retried by the host. | |||
* What can you do with this hook? Since the SOF signal occurs exactly every | |||
* 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in | |||
* designs running on the internal RC oscillator. | |||
* Please note that Start Of Frame detection works only if D- is wired to the | |||
* interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! | |||
*/ | |||
#define USB_CFG_CHECK_DATA_TOGGLING 0 | |||
/* define this macro to 1 if you want to filter out duplicate data packets | |||
* sent by the host. Duplicates occur only as a consequence of communication | |||
* errors, when the host does not receive an ACK. Please note that you need to | |||
* implement the filtering yourself in usbFunctionWriteOut() and | |||
* usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable | |||
* for each control- and out-endpoint to check for duplicate packets. | |||
*/ | |||
#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0 | |||
/* define this macro to 1 if you want the function usbMeasureFrameLength() | |||
* compiled in. This function can be used to calibrate the AVR's RC oscillator. | |||
*/ | |||
#define USB_USE_FAST_CRC 0 | |||
/* The assembler module has two implementations for the CRC algorithm. One is | |||
* faster, the other is smaller. This CRC routine is only used for transmitted | |||
* messages where timing is not critical. The faster routine needs 31 cycles | |||
* per byte while the smaller one needs 61 to 69 cycles. The faster routine | |||
* may be worth the 32 bytes bigger code size if you transmit lots of data and | |||
* run the AVR close to its limit. | |||
*/ | |||
/* -------------------------- Device Description --------------------------- */ | |||
#define USB_CFG_VENDOR_ID (VENDOR_ID & 0xFF), ((VENDOR_ID >> 8) & 0xFF) | |||
/* USB vendor ID for the device, low byte first. If you have registered your | |||
* own Vendor ID, define it here. Otherwise you may use one of obdev's free | |||
* shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules! | |||
* *** IMPORTANT NOTE *** | |||
* This template uses obdev's shared VID/PID pair for Vendor Class devices | |||
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand | |||
* the implications! | |||
*/ | |||
#define USB_CFG_DEVICE_ID (PRODUCT_ID & 0xFF), ((PRODUCT_ID >> 8) & 0xFF) | |||
/* This is the ID of the product, low byte first. It is interpreted in the | |||
* scope of the vendor ID. If you have registered your own VID with usb.org | |||
* or if you have licensed a PID from somebody else, define it here. Otherwise | |||
* you may use one of obdev's free shared VID/PID pairs. See the file | |||
* USB-IDs-for-free.txt for details! | |||
* *** IMPORTANT NOTE *** | |||
* This template uses obdev's shared VID/PID pair for Vendor Class devices | |||
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand | |||
* the implications! | |||
*/ | |||
#define USB_CFG_DEVICE_VERSION 0x00, 0x01 | |||
/* Version number of the device: Minor number first, then major number. | |||
*/ | |||
#define USB_CFG_VENDOR_NAME 'd','m','9','r','e','c','o','r','d','s' | |||
#define USB_CFG_VENDOR_NAME_LEN 10 | |||
/* These two values define the vendor name returned by the USB device. The name | |||
* must be given as a list of characters under single quotes. The characters | |||
* are interpreted as Unicode (UTF-16) entities. | |||
* If you don't want a vendor name string, undefine these macros. | |||
* ALWAYS define a vendor name containing your Internet domain name if you use | |||
* obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for | |||
* details. | |||
*/ | |||
#define USB_CFG_DEVICE_NAME 'P', 'l', 'a', 'i', 'd' | |||
#define USB_CFG_DEVICE_NAME_LEN 5 | |||
/* Same as above for the device name. If you don't want a device name, undefine | |||
* the macros. See the file USB-IDs-for-free.txt before you assign a name if | |||
* you use a shared VID/PID. | |||
*/ | |||
#define USB_CFG_SERIAL_NUMBER 'd','m','9','r','e','c','o','r','d','s','.','c','o','m',':','p','1' | |||
#define USB_CFG_SERIAL_NUMBER_LEN 17 | |||
/* Same as above for the serial number. If you don't want a serial number, | |||
* undefine the macros. | |||
* It may be useful to provide the serial number through other means than at | |||
* compile time. See the section about descriptor properties below for how | |||
* to fine tune control over USB descriptors such as the string descriptor | |||
* for the serial number. | |||
*/ | |||
#define USB_CFG_DEVICE_CLASS 0 | |||
#define USB_CFG_DEVICE_SUBCLASS 0 | |||
/* See USB specification if you want to conform to an existing device class. | |||
* Class 0xff is "vendor specific". | |||
*/ | |||
#define USB_CFG_INTERFACE_CLASS 3 /* HID */ | |||
#define USB_CFG_INTERFACE_SUBCLASS 1 /* Boot */ | |||
#define USB_CFG_INTERFACE_PROTOCOL 1 /* Keyboard */ | |||
/* See USB specification if you want to conform to an existing device class or | |||
* protocol. The following classes must be set at interface level: | |||
* HID class is 3, no subclass and protocol required (but may be useful!) | |||
* CDC class is 2, use subclass 2 and protocol 1 for ACM | |||
*/ | |||
#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 0 | |||
/* Define this to the length of the HID report descriptor, if you implement | |||
* an HID device. Otherwise don't define it or define it to 0. | |||
* If you use this define, you must add a PROGMEM character array named | |||
* "usbHidReportDescriptor" to your code which contains the report descriptor. | |||
* Don't forget to keep the array and this define in sync! | |||
*/ | |||
/* #define USB_PUBLIC static */ | |||
/* Use the define above if you #include usbdrv.c instead of linking against it. | |||
* This technique saves a couple of bytes in flash memory. | |||
*/ | |||
/* ------------------- Fine Control over USB Descriptors ------------------- */ | |||
/* If you don't want to use the driver's default USB descriptors, you can | |||
* provide our own. These can be provided as (1) fixed length static data in | |||
* flash memory, (2) fixed length static data in RAM or (3) dynamically at | |||
* runtime in the function usbFunctionDescriptor(). See usbdrv.h for more | |||
* information about this function. | |||
* Descriptor handling is configured through the descriptor's properties. If | |||
* no properties are defined or if they are 0, the default descriptor is used. | |||
* Possible properties are: | |||
* + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched | |||
* at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is | |||
* used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if | |||
* you want RAM pointers. | |||
* + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found | |||
* in static memory is in RAM, not in flash memory. | |||
* + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), | |||
* the driver must know the descriptor's length. The descriptor itself is | |||
* found at the address of a well known identifier (see below). | |||
* List of static descriptor names (must be declared PROGMEM if in flash): | |||
* char usbDescriptorDevice[]; | |||
* char usbDescriptorConfiguration[]; | |||
* char usbDescriptorHidReport[]; | |||
* char usbDescriptorString0[]; | |||
* int usbDescriptorStringVendor[]; | |||
* int usbDescriptorStringDevice[]; | |||
* int usbDescriptorStringSerialNumber[]; | |||
* Other descriptors can't be provided statically, they must be provided | |||
* dynamically at runtime. | |||
* | |||
* Descriptor properties are or-ed or added together, e.g.: | |||
* #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18)) | |||
* | |||
* The following descriptors are defined: | |||
* USB_CFG_DESCR_PROPS_DEVICE | |||
* USB_CFG_DESCR_PROPS_CONFIGURATION | |||
* USB_CFG_DESCR_PROPS_STRINGS | |||
* USB_CFG_DESCR_PROPS_STRING_0 | |||
* USB_CFG_DESCR_PROPS_STRING_VENDOR | |||
* USB_CFG_DESCR_PROPS_STRING_PRODUCT | |||
* USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER | |||
* USB_CFG_DESCR_PROPS_HID | |||
* USB_CFG_DESCR_PROPS_HID_REPORT | |||
* USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) | |||
* | |||
* Note about string descriptors: String descriptors are not just strings, they | |||
* are Unicode strings prefixed with a 2 byte header. Example: | |||
* int serialNumberDescriptor[] = { | |||
* USB_STRING_DESCRIPTOR_HEADER(6), | |||
* 'S', 'e', 'r', 'i', 'a', 'l' | |||
* }; | |||
*/ | |||
#define USB_CFG_DESCR_PROPS_DEVICE 0 | |||
#define USB_CFG_DESCR_PROPS_CONFIGURATION USB_PROP_IS_DYNAMIC | |||
//#define USB_CFG_DESCR_PROPS_CONFIGURATION 0 | |||
#define USB_CFG_DESCR_PROPS_STRINGS 0 | |||
#define USB_CFG_DESCR_PROPS_STRING_0 0 | |||
#define USB_CFG_DESCR_PROPS_STRING_VENDOR 0 | |||
#define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0 | |||
#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 | |||
#define USB_CFG_DESCR_PROPS_HID USB_PROP_IS_DYNAMIC | |||
//#define USB_CFG_DESCR_PROPS_HID 0 | |||
#define USB_CFG_DESCR_PROPS_HID_REPORT USB_PROP_IS_DYNAMIC | |||
//#define USB_CFG_DESCR_PROPS_HID_REPORT 0 | |||
#define USB_CFG_DESCR_PROPS_UNKNOWN 0 | |||
#define usbMsgPtr_t unsigned short | |||
/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to | |||
* a scalar type here because gcc generates slightly shorter code for scalar | |||
* arithmetics than for pointer arithmetics. Remove this define for backward | |||
* type compatibility or define it to an 8 bit type if you use data in RAM only | |||
* and all RAM is below 256 bytes (tiny memory model in IAR CC). | |||
*/ | |||
/* ----------------------- Optional MCU Description ------------------------ */ | |||
/* The following configurations have working defaults in usbdrv.h. You | |||
* usually don't need to set them explicitly. Only if you want to run | |||
* the driver on a device which is not yet supported or with a compiler | |||
* which is not fully supported (such as IAR C) or if you use a differnt | |||
* interrupt than INT0, you may have to define some of these. | |||
*/ | |||
/* #define USB_INTR_CFG MCUCR */ | |||
/* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */ | |||
/* #define USB_INTR_CFG_CLR 0 */ | |||
/* #define USB_INTR_ENABLE GIMSK */ | |||
/* #define USB_INTR_ENABLE_BIT INT0 */ | |||
/* #define USB_INTR_PENDING GIFR */ | |||
/* #define USB_INTR_PENDING_BIT INTF0 */ | |||
/* #define USB_INTR_VECTOR INT0_vect */ | |||
/* Set INT1 for D- falling edge to count SOF */ | |||
/* #define USB_INTR_CFG EICRA */ | |||
// #define USB_INTR_CFG_SET ((1 << ISC11) | (0 << ISC10)) | |||
// /* #define USB_INTR_CFG_CLR 0 */ | |||
// /* #define USB_INTR_ENABLE EIMSK */ | |||
// #define USB_INTR_ENABLE_BIT INT1 | |||
// /* #define USB_INTR_PENDING EIFR */ | |||
// #define USB_INTR_PENDING_BIT INTF1 | |||
// #define USB_INTR_VECTOR INT1_vect | |||
#endif /* __usbconfig_h_included__ */ |