aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcoseyfannitutti <43188488+coseyfannitutti@users.noreply.github.com>2019-09-21 01:07:21 -0400
committerDrashna Jaelre <drashna@live.com>2019-09-20 22:07:21 -0700
commitc7d0262be7f3bc2c709fd45bd41327433285a11e (patch)
tree5e76a2cdeab44b1e12bf6638ee47ea4eceb03236
parentde4a47f1cc28c4ef66e7560eac2a50f717070ae2 (diff)
downloadqmk_firmware-c7d0262be7f3bc2c709fd45bd41327433285a11e.tar.gz
qmk_firmware-c7d0262be7f3bc2c709fd45bd41327433285a11e.zip
[Keyboard] Add Discipad, Update Zadig doc for USBaspLoader (#6771)
* add discipad * Update driver_installation_zadig.md * Update keyboards/coseyfannitutti/discipad/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/coseyfannitutti/discipad/readme.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update rules.mk * Update keyboards/coseyfannitutti/discipad/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/coseyfannitutti/discipad/discipad.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update rules.mk * Update discipad.c * Update driver_installation_zadig.md * Update config.h
-rw-r--r--docs/driver_installation_zadig.md6
-rw-r--r--keyboards/coseyfannitutti/discipad/config.h249
-rw-r--r--keyboards/coseyfannitutti/discipad/discipad.c24
-rw-r--r--keyboards/coseyfannitutti/discipad/discipad.h43
-rw-r--r--keyboards/coseyfannitutti/discipad/info.json12
-rw-r--r--keyboards/coseyfannitutti/discipad/keymaps/default/keymap.c27
-rw-r--r--keyboards/coseyfannitutti/discipad/readme.md15
-rw-r--r--keyboards/coseyfannitutti/discipad/rules.mk34
-rw-r--r--keyboards/coseyfannitutti/discipad/usbconfig.h397
9 files changed, 806 insertions, 1 deletions
diff --git a/docs/driver_installation_zadig.md b/docs/driver_installation_zadig.md
index 72c263734..71e4cc440 100644
--- a/docs/driver_installation_zadig.md
+++ b/docs/driver_installation_zadig.md
@@ -11,7 +11,11 @@ We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have
11Put your keyboard into bootloader mode, either by hitting the `RESET` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic](feature_bootmagic.md) docs for more details). Some boards use [Command](feature_command.md) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in. 11Put your keyboard into bootloader mode, either by hitting the `RESET` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic](feature_bootmagic.md) docs for more details). Some boards use [Command](feature_command.md) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
12Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](feature_bootmagic.md#bootmagic-lite) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure. 12Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](feature_bootmagic.md#bootmagic-lite) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.
13 13
14To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button.
15Alternatively, hold `BOOT` while inserting the USB cable.
16
14Zadig will automatically detect the bootloader device. You may sometimes need to check **Options → List All Devices**. 17Zadig will automatically detect the bootloader device. You may sometimes need to check **Options → List All Devices**.
18
15 - For keyboards with Atmel AVR MCUs, the bootloader will be named something similar to `ATm32U4DFU`, and have a Vendor ID of `03EB`. 19 - For keyboards with Atmel AVR MCUs, the bootloader will be named something similar to `ATm32U4DFU`, and have a Vendor ID of `03EB`.
16 - USBasp bootloaders will appear as `USBasp`, with a VID/PID of `16C0:05DC`. 20 - USBasp bootloaders will appear as `USBasp`, with a VID/PID of `16C0:05DC`.
17 - AVR keyboards flashed with the QMK-DFU bootloader will be named `<keyboard name> Bootloader` and will also have the VID `03EB`. 21 - AVR keyboards flashed with the QMK-DFU bootloader will be named `<keyboard name> Bootloader` and will also have the VID `03EB`.
@@ -19,7 +23,7 @@ Zadig will automatically detect the bootloader device. You may sometimes need to
19 23
20!> If Zadig lists one or more devices with the `HidUsb` driver, your keyboard is probably not in bootloader mode. The arrow will be colored orange and you will be asked to confirm modifying a system driver. **Do not** proceed if this is the case! 24!> If Zadig lists one or more devices with the `HidUsb` driver, your keyboard is probably not in bootloader mode. The arrow will be colored orange and you will be asked to confirm modifying a system driver. **Do not** proceed if this is the case!
21 25
22If the arrow appears green, select the driver, and click **Install Driver**. The `libusb-win32` driver will usually work for AVR, and `WinUSB` for ARM, but if you still cannot flash the board, try installing a different driver from the list. 26If the arrow appears green, select the driver, and click **Install Driver**. The `libusb-win32` driver will usually work for AVR, and `WinUSB` for ARM, but if you still cannot flash the board, try installing a different driver from the list. For flashing a USBaspLoader device via command line with msys2, the `libusbk` driver is recommended, otherwise `libusb-win32` will work fine if you are using QMK Toolbox for flashing.
23 27
24![Zadig with a bootloader driver correctly installed](https://i.imgur.com/b8VgXzx.png) 28![Zadig with a bootloader driver correctly installed](https://i.imgur.com/b8VgXzx.png)
25 29
diff --git a/keyboards/coseyfannitutti/discipad/config.h b/keyboards/coseyfannitutti/discipad/config.h
new file mode 100644
index 000000000..ffa06ee25
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/config.h
@@ -0,0 +1,249 @@
1/*
2Copyright 2019 coseyfannitutti
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18#pragma once
19
20#include "config_common.h"
21
22#define VENDOR_ID 0xFEED
23#define PRODUCT_ID 0x1769
24#define DEVICE_VER 0x0001
25#define MANUFACTURER coseyfannitutti
26#define PRODUCT DISCIPAD
27#define DESCRIPTION 17-key numpad assembled with only through hole components
28
29/* key matrix size */
30#define MATRIX_ROWS 5
31#define MATRIX_COLS 4
32
33/*
34 * Keyboard Matrix Assignments
35 *
36 * Change this to how you wired your keyboard
37 * COLS: AVR pins used for columns, left to right
38 * ROWS: AVR pins used for rows, top to bottom
39 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
40 * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
41 *
42 */
43
44/* A Custom matrix.c is used to poll the port expander C6 shows that the pins are hardwired there */
45#define MATRIX_ROW_PINS { B1, B0, D7, D6, D4 }
46#define MATRIX_COL_PINS { C0, C1, C2, C3 }
47#define UNUSED_PINS
48
49/* COL2ROW, ROW2COL*/
50#define DIODE_DIRECTION COL2ROW
51
52#define NO_UART 1
53
54/*
55 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
56 */
57// #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
58
59// #define BACKLIGHT_PIN B7
60// #define BACKLIGHT_BREATHING
61// #define BACKLIGHT_LEVELS 3
62
63// #define RGB_DI_PIN E2
64// #ifdef RGB_DI_PIN
65// #define RGBLED_NUM 16
66// #define RGBLIGHT_HUE_STEP 8
67// #define RGBLIGHT_SAT_STEP 8
68// #define RGBLIGHT_VAL_STEP 8
69// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
70// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
71// /*== all animations enable ==*/
72// #define RGBLIGHT_ANIMATIONS
73// /*== or choose animations ==*/
74// #define RGBLIGHT_EFFECT_BREATHING
75// #define RGBLIGHT_EFFECT_RAINBOW_MOOD
76// #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
77// #define RGBLIGHT_EFFECT_SNAKE
78// #define RGBLIGHT_EFFECT_KNIGHT
79// #define RGBLIGHT_EFFECT_CHRISTMAS
80// #define RGBLIGHT_EFFECT_STATIC_GRADIENT
81// #define RGBLIGHT_EFFECT_RGB_TEST
82// #define RGBLIGHT_EFFECT_ALTERNATING
83// #endif
84
85/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
86#define DEBOUNCE 5
87
88/* define if matrix has ghost (lacks anti-ghosting diodes) */
89//#define MATRIX_HAS_GHOST
90
91/* number of backlight levels */
92
93/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
94#define LOCKING_SUPPORT_ENABLE
95/* Locking resynchronize hack */
96#define LOCKING_RESYNC_ENABLE
97
98/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
99 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
100 */
101// #define GRAVE_ESC_CTRL_OVERRIDE
102
103/*
104 * Force NKRO
105 *
106 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
107 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
108 * makefile for this to work.)
109 *
110 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
111 * until the next keyboard reset.
112 *
113 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
114 * fully operational during normal computer usage.
115 *
116 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
117 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
118 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
119 * power-up.
120 *
121 */
122//#define FORCE_NKRO
123
124/*
125 * Magic Key Options
126 *
127 * Magic keys are hotkey commands that allow control over firmware functions of
128 * the keyboard. They are best used in combination with the HID Listen program,
129 * found here: https://www.pjrc.com/teensy/hid_listen.html
130 *
131 * The options below allow the magic key functionality to be changed. This is
132 * useful if your keyboard/keypad is missing keys and you want magic key support.
133 *
134 */
135
136/* key combination for magic key command */
137/* defined by default; to change, uncomment and set to the combination you want */
138// #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))
139
140/* control how magic key switches layers */
141//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
142//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
143//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
144
145/* override magic key keymap */
146//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
147//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
148//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
149//#define MAGIC_KEY_HELP H
150//#define MAGIC_KEY_HELP_ALT SLASH
151//#define MAGIC_KEY_DEBUG D
152//#define MAGIC_KEY_DEBUG_MATRIX X
153//#define MAGIC_KEY_DEBUG_KBD K
154//#define MAGIC_KEY_DEBUG_MOUSE M
155//#define MAGIC_KEY_VERSION V
156//#define MAGIC_KEY_STATUS S
157//#define MAGIC_KEY_CONSOLE C
158//#define MAGIC_KEY_LAYER0 0
159//#define MAGIC_KEY_LAYER0_ALT GRAVE
160//#define MAGIC_KEY_LAYER1 1
161//#define MAGIC_KEY_LAYER2 2
162//#define MAGIC_KEY_LAYER3 3
163//#define MAGIC_KEY_LAYER4 4
164//#define MAGIC_KEY_LAYER5 5
165//#define MAGIC_KEY_LAYER6 6
166//#define MAGIC_KEY_LAYER7 7
167//#define MAGIC_KEY_LAYER8 8
168//#define MAGIC_KEY_LAYER9 9
169//#define MAGIC_KEY_BOOTLOADER B
170//#define MAGIC_KEY_BOOTLOADER_ALT ESC
171//#define MAGIC_KEY_LOCK CAPS
172//#define MAGIC_KEY_EEPROM E
173//#define MAGIC_KEY_EEPROM_CLEAR BSPACE
174//#define MAGIC_KEY_NKRO N
175//#define MAGIC_KEY_SLEEP_LED Z
176
177/*
178 * Feature disable options
179 * These options are also useful to firmware size reduction.
180 */
181
182/* disable debug print */
183//#define NO_DEBUG
184
185/* disable print */
186//#define NO_PRINT
187
188/* disable action features */
189//#define NO_ACTION_LAYER
190//#define NO_ACTION_TAPPING
191//#define NO_ACTION_ONESHOT
192//#define NO_ACTION_MACRO
193//#define NO_ACTION_FUNCTION
194
195/*
196 * MIDI options
197 */
198
199/* Prevent use of disabled MIDI features in the keymap */
200//#define MIDI_ENABLE_STRICT 1
201
202/* enable basic MIDI features:
203 - MIDI notes can be sent when in Music mode is on
204*/
205//#define MIDI_BASIC
206
207/* enable advanced MIDI features:
208 - MIDI notes can be added to the keymap
209 - Octave shift and transpose
210 - Virtual sustain, portamento, and modulation wheel
211 - etc.
212*/
213//#define MIDI_ADVANCED
214
215/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
216//#define MIDI_TONE_KEYCODE_OCTAVES 1
217
218/*
219 * HD44780 LCD Display Configuration
220 */
221/*
222#define LCD_LINES 2 //< number of visible lines of the display
223#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
224
225#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
226
227#if LCD_IO_MODE
228#define LCD_PORT PORTB //< port for the LCD lines
229#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
230#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
231#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
232#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
233#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
234#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
235#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
236#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
237#define LCD_RS_PORT LCD_PORT //< port for RS line
238#define LCD_RS_PIN 3 //< pin for RS line
239#define LCD_RW_PORT LCD_PORT //< port for RW line
240#define LCD_RW_PIN 2 //< pin for RW line
241#define LCD_E_PORT LCD_PORT //< port for Enable line
242#define LCD_E_PIN 1 //< pin for Enable line
243#endif
244*/
245
246/* Bootmagic Lite key configuration
247#define BOOTMAGIC_LITE_ROW 0
248#define BOOTMAGIC_LITE_COLUMN 0
249*/
diff --git a/keyboards/coseyfannitutti/discipad/discipad.c b/keyboards/coseyfannitutti/discipad/discipad.c
new file mode 100644
index 000000000..c8f6e0a17
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/discipad.c
@@ -0,0 +1,24 @@
1/* Copyright 2019 coseyfannitutti
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#include "discipad.h"
17
18
19void matrix_init_kb(void) {
20 // put your keyboard start-up code here
21 // runs once when the firmware starts up
22
23 matrix_init_user();
24}
diff --git a/keyboards/coseyfannitutti/discipad/discipad.h b/keyboards/coseyfannitutti/discipad/discipad.h
new file mode 100644
index 000000000..5ce8b4634
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/discipad.h
@@ -0,0 +1,43 @@
1/* Copyright 2019 coseyfannitutti
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#pragma once
17
18#include "quantum.h"
19
20#define _x_ KC_NO
21
22/* This a shortcut to help you visually see your layout.
23 *
24 * The first section contains all of the arguments representing the physical
25 * layout of the board and position of the keys.
26 *
27 * The second converts the arguments into a two-dimensional array which
28 * represents the switch matrix.
29 */
30#define LAYOUT_numpad_5x4( \
31 K00, K01, K02, K03, \
32 K10, K11, K12, \
33 K20, K21, K22, K23, \
34 K30, K31, K32, \
35 K40, K42, K43 \
36) { \
37{ K00, K01, K02, K03, }, \
38{ K10, K11, K12, _x_, }, \
39{ K20, K21, K22, K23, }, \
40{ K30, K31, K32, _x_, }, \
41{ K40, _x_, K42, K43, }, \
42}
43
diff --git a/keyboards/coseyfannitutti/discipad/info.json b/keyboards/coseyfannitutti/discipad/info.json
new file mode 100644
index 000000000..fc50d3a18
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/info.json
@@ -0,0 +1,12 @@
1{
2 "keyboard_name": "DISCIPAD",
3 "url": "https://github.com/coseyfannitutti/discipad",
4 "maintainer": "coseyfannitutti",
5 "width": 4,
6 "height": 5,
7 "layouts": {
8 "LAYOUT_numpad_5x4": {
9 "layout": [{"label":"Num Lock", "x":0, "y":0}, {"label":"/", "x":1, "y":0}, {"label":"*", "x":2, "y":0}, {"label":"-", "x":3, "y":0}, {"label":"7", "x":0, "y":1}, {"label":"8", "x":1, "y":1}, {"label":"9", "x":2, "y":1}, {"label":"4", "x":0, "y":2}, {"label":"5", "x":1, "y":2}, {"label":"6", "x":2, "y":2}, {"label":"+", "x":3, "y":1, "h":2}, {"label":"1", "x":0, "y":3}, {"label":"2", "x":1, "y":3}, {"label":"3", "x":2, "y":3}, {"label":"0", "x":0, "y":4, "w":2}, {"label":".", "x":2, "y":4}, {"label":"Enter", "x":3, "y":3, "h":2}]
10 }
11 }
12}
diff --git a/keyboards/coseyfannitutti/discipad/keymaps/default/keymap.c b/keyboards/coseyfannitutti/discipad/keymaps/default/keymap.c
new file mode 100644
index 000000000..ffdc1044d
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/keymaps/default/keymap.c
@@ -0,0 +1,27 @@
1/* Copyright 2019 COSEYFANNITUTTI
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#include QMK_KEYBOARD_H
17
18#define _BL 0
19
20const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
21 [_BL] = LAYOUT_numpad_5x4(
22 KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
23 KC_P7, KC_P8, KC_P9,
24 KC_P4, KC_P5, KC_P6, KC_PPLS,
25 KC_P1, KC_P2, KC_P3,
26 KC_P0, KC_PDOT, KC_PENT )
27};
diff --git a/keyboards/coseyfannitutti/discipad/readme.md b/keyboards/coseyfannitutti/discipad/readme.md
new file mode 100644
index 000000000..4d5365fce
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/readme.md
@@ -0,0 +1,15 @@
1# DISCIPAD
2
3![discipline](https://i.imgur.com/3Coydx7.jpg)
4
5A 17-key numpad that can be assembled with only through hole components, including usb type-c
6
7Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti)
8Hardware Supported: DISCIPAD, atmega328p
9Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipad)
10
11Make example for this keyboard (after setting up your build environment):
12
13 make coseyfannitutti/discipad:default
14
15See 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).
diff --git a/keyboards/coseyfannitutti/discipad/rules.mk b/keyboards/coseyfannitutti/discipad/rules.mk
new file mode 100644
index 000000000..64f618854
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/rules.mk
@@ -0,0 +1,34 @@
1# MCU name
2MCU = atmega328p
3
4# Bootloader selection
5BOOTLOADER = USBasp
6
7# Flash program via avrdude, but default command is not suitable.
8# You can use coseyfannitutti/discipad:default:program
9PROGRAM_CMD = avrdude -c usbasp -p m328p -U flash:w:$(BUILD_DIR)/$(TARGET).hex
10
11# disable debug code
12OPT_DEFS = -DDEBUG_LEVEL=0
13
14
15# Build Options
16# change yes to no to disable
17#
18BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration(+1000)
19MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
20EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
21CONSOLE_ENABLE = no # Console for debug(+400)
22COMMAND_ENABLE = no # Commands for debug and configuration
23# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
24SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
25# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
26NKRO_ENABLE = no # USB Nkey Rollover
27BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default
28RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
29MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config)
30UNICODE_ENABLE = no # Unicode
31BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
32AUDIO_ENABLE = no # Audio output on port C6
33FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
34HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400)
diff --git a/keyboards/coseyfannitutti/discipad/usbconfig.h b/keyboards/coseyfannitutti/discipad/usbconfig.h
new file mode 100644
index 000000000..505f0e5c8
--- /dev/null
+++ b/keyboards/coseyfannitutti/discipad/usbconfig.h
@@ -0,0 +1,397 @@
1/* Name: usbconfig.h
2 * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers
3 * Author: Christian Starkjohann
4 * Creation Date: 2005-04-01
5 * Tabsize: 4
6 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH
7 * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt)
8 * This Revision: $Id: usbconfig-prototype.h 785 2010-05-30 17:57:07Z cs $
9 */
10
11#ifndef __usbconfig_h_included__
12#define __usbconfig_h_included__
13
14#include "config.h"
15
16/*
17General Description:
18This file is an example configuration (with inline documentation) for the USB
19driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is
20also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may
21wire the lines to any other port, as long as D+ is also wired to INT0 (or any
22other hardware interrupt, as long as it is the highest level interrupt, see
23section at the end of this file).
24*/
25
26/* ---------------------------- Hardware Config ---------------------------- */
27
28#define USB_CFG_IOPORTNAME D
29/* This is the port where the USB bus is connected. When you configure it to
30 * "B", the registers PORTB, PINB and DDRB will be used.
31 */
32#define USB_CFG_DMINUS_BIT 3
33/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
34 * This may be any bit in the port.
35 */
36#define USB_CFG_DPLUS_BIT 2
37/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
38 * This may be any bit in the port. Please note that D+ must also be connected
39 * to interrupt pin INT0! [You can also use other interrupts, see section
40 * "Optional MCU Description" below, or you can connect D- to the interrupt, as
41 * it is required if you use the USB_COUNT_SOF feature. If you use D- for the
42 * interrupt, the USB interrupt will also be triggered at Start-Of-Frame
43 * markers every millisecond.]
44 */
45#define USB_CFG_CLOCK_KHZ (F_CPU/1000)
46/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000,
47 * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code
48 * require no crystal, they tolerate +/- 1% deviation from the nominal
49 * frequency. All other rates require a precision of 2000 ppm and thus a
50 * crystal!
51 * Since F_CPU should be defined to your actual clock rate anyway, you should
52 * not need to modify this setting.
53 */
54#define USB_CFG_CHECK_CRC 0
55/* Define this to 1 if you want that the driver checks integrity of incoming
56 * data packets (CRC checks). CRC checks cost quite a bit of code size and are
57 * currently only available for 18 MHz crystal clock. You must choose
58 * USB_CFG_CLOCK_KHZ = 18000 if you enable this option.
59 */
60
61/* ----------------------- Optional Hardware Config ------------------------ */
62
63/* #define USB_CFG_PULLUP_IOPORTNAME D */
64/* If you connect the 1.5k pullup resistor from D- to a port pin instead of
65 * V+, you can connect and disconnect the device from firmware by calling
66 * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
67 * This constant defines the port on which the pullup resistor is connected.
68 */
69/* #define USB_CFG_PULLUP_BIT 4 */
70/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
71 * above) where the 1.5k pullup resistor is connected. See description
72 * above for details.
73 */
74
75/* --------------------------- Functional Range ---------------------------- */
76
77#define USB_CFG_HAVE_INTRIN_ENDPOINT 1
78/* Define this to 1 if you want to compile a version with two endpoints: The
79 * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
80 * number).
81 */
82#define USB_CFG_HAVE_INTRIN_ENDPOINT3 1
83/* Define this to 1 if you want to compile a version with three endpoints: The
84 * default control endpoint 0, an interrupt-in endpoint 3 (or the number
85 * configured below) and a catch-all default interrupt-in endpoint as above.
86 * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
87 */
88#define USB_CFG_EP3_NUMBER 3
89/* If the so-called endpoint 3 is used, it can now be configured to any other
90 * endpoint number (except 0) with this macro. Default if undefined is 3.
91 */
92/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */
93/* The above macro defines the startup condition for data toggling on the
94 * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
95 * Since the token is toggled BEFORE sending any data, the first packet is
96 * sent with the oposite value of this configuration!
97 */
98#define USB_CFG_IMPLEMENT_HALT 0
99/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
100 * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
101 * it is required by the standard. We have made it a config option because it
102 * bloats the code considerably.
103 */
104#define USB_CFG_SUPPRESS_INTR_CODE 0
105/* Define this to 1 if you want to declare interrupt-in endpoints, but don't
106 * want to send any data over them. If this macro is defined to 1, functions
107 * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
108 * you need the interrupt-in endpoints in order to comply to an interface
109 * (e.g. HID), but never want to send any data. This option saves a couple
110 * of bytes in flash memory and the transmit buffers in RAM.
111 */
112#define USB_CFG_INTR_POLL_INTERVAL 1
113/* If you compile a version with endpoint 1 (interrupt-in), this is the poll
114 * interval. The value is in milliseconds and must not be less than 10 ms for
115 * low speed devices.
116 */
117#define USB_CFG_IS_SELF_POWERED 0
118/* Define this to 1 if the device has its own power supply. Set it to 0 if the
119 * device is powered from the USB bus.
120 */
121// max power draw with maxed white underglow measured at 120 mA (peaks)
122#define USB_CFG_MAX_BUS_POWER 100
123/* Set this variable to the maximum USB bus power consumption of your device.
124 * The value is in milliamperes. [It will be divided by two since USB
125 * communicates power requirements in units of 2 mA.]
126 */
127#define USB_CFG_IMPLEMENT_FN_WRITE 1
128/* Set this to 1 if you want usbFunctionWrite() to be called for control-out
129 * transfers. Set it to 0 if you don't need it and want to save a couple of
130 * bytes.
131 */
132#define USB_CFG_IMPLEMENT_FN_READ 0
133/* Set this to 1 if you need to send control replies which are generated
134 * "on the fly" when usbFunctionRead() is called. If you only want to send
135 * data from a static buffer, set it to 0 and return the data from
136 * usbFunctionSetup(). This saves a couple of bytes.
137 */
138#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0
139/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
140 * You must implement the function usbFunctionWriteOut() which receives all
141 * interrupt/bulk data sent to any endpoint other than 0. The endpoint number
142 * can be found in 'usbRxToken'.
143 */
144#define USB_CFG_HAVE_FLOWCONTROL 0
145/* Define this to 1 if you want flowcontrol over USB data. See the definition
146 * of the macros usbDisableAllRequests() and usbEnableAllRequests() in
147 * usbdrv.h.
148 */
149#define USB_CFG_DRIVER_FLASH_PAGE 0
150/* If the device has more than 64 kBytes of flash, define this to the 64 k page
151 * where the driver's constants (descriptors) are located. Or in other words:
152 * Define this to 1 for boot loaders on the ATMega128.
153 */
154#define USB_CFG_LONG_TRANSFERS 0
155/* Define this to 1 if you want to send/receive blocks of more than 254 bytes
156 * in a single control-in or control-out transfer. Note that the capability
157 * for long transfers increases the driver size.
158 */
159/* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
160/* This macro is a hook if you want to do unconventional things. If it is
161 * defined, it's inserted at the beginning of received message processing.
162 * If you eat the received message and don't want default processing to
163 * proceed, do a return after doing your things. One possible application
164 * (besides debugging) is to flash a status LED on each packet.
165 */
166/* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */
167/* This macro is a hook if you need to know when an USB RESET occurs. It has
168 * one parameter which distinguishes between the start of RESET state and its
169 * end.
170 */
171/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */
172/* This macro (if defined) is executed when a USB SET_ADDRESS request was
173 * received.
174 */
175#define USB_COUNT_SOF 0
176/* define this macro to 1 if you need the global variable "usbSofCount" which
177 * counts SOF packets. This feature requires that the hardware interrupt is
178 * connected to D- instead of D+.
179 */
180/* #ifdef __ASSEMBLER__
181 * macro myAssemblerMacro
182 * in YL, TCNT0
183 * sts timer0Snapshot, YL
184 * endm
185 * #endif
186 * #define USB_SOF_HOOK myAssemblerMacro
187 * This macro (if defined) is executed in the assembler module when a
188 * Start Of Frame condition is detected. It is recommended to define it to
189 * the name of an assembler macro which is defined here as well so that more
190 * than one assembler instruction can be used. The macro may use the register
191 * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
192 * immediately after an SOF pulse may be lost and must be retried by the host.
193 * What can you do with this hook? Since the SOF signal occurs exactly every
194 * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
195 * designs running on the internal RC oscillator.
196 * Please note that Start Of Frame detection works only if D- is wired to the
197 * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
198 */
199#define USB_CFG_CHECK_DATA_TOGGLING 0
200/* define this macro to 1 if you want to filter out duplicate data packets
201 * sent by the host. Duplicates occur only as a consequence of communication
202 * errors, when the host does not receive an ACK. Please note that you need to
203 * implement the filtering yourself in usbFunctionWriteOut() and
204 * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
205 * for each control- and out-endpoint to check for duplicate packets.
206 */
207#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0
208/* define this macro to 1 if you want the function usbMeasureFrameLength()
209 * compiled in. This function can be used to calibrate the AVR's RC oscillator.
210 */
211#define USB_USE_FAST_CRC 0
212/* The assembler module has two implementations for the CRC algorithm. One is
213 * faster, the other is smaller. This CRC routine is only used for transmitted
214 * messages where timing is not critical. The faster routine needs 31 cycles
215 * per byte while the smaller one needs 61 to 69 cycles. The faster routine
216 * may be worth the 32 bytes bigger code size if you transmit lots of data and
217 * run the AVR close to its limit.
218 */
219
220/* -------------------------- Device Description --------------------------- */
221
222#define USB_CFG_VENDOR_ID (VENDOR_ID & 0xFF), ((VENDOR_ID >> 8) & 0xFF)
223/* USB vendor ID for the device, low byte first. If you have registered your
224 * own Vendor ID, define it here. Otherwise you may use one of obdev's free
225 * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules!
226 * *** IMPORTANT NOTE ***
227 * This template uses obdev's shared VID/PID pair for Vendor Class devices
228 * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand
229 * the implications!
230 */
231#define USB_CFG_DEVICE_ID (PRODUCT_ID & 0xFF), ((PRODUCT_ID >> 8) & 0xFF)
232/* This is the ID of the product, low byte first. It is interpreted in the
233 * scope of the vendor ID. If you have registered your own VID with usb.org
234 * or if you have licensed a PID from somebody else, define it here. Otherwise
235 * you may use one of obdev's free shared VID/PID pairs. See the file
236 * USB-IDs-for-free.txt for details!
237 * *** IMPORTANT NOTE ***
238 * This template uses obdev's shared VID/PID pair for Vendor Class devices
239 * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand
240 * the implications!
241 */
242#define USB_CFG_DEVICE_VERSION 0x01, 0x00
243/* Version number of the device: Minor number first, then major number.
244 */
245#define USB_CFG_VENDOR_NAME 'c','o','s','e','y','f','a','n','n','i','t','u','t','t','i'
246#define USB_CFG_VENDOR_NAME_LEN 15
247/* These two values define the vendor name returned by the USB device. The name
248 * must be given as a list of characters under single quotes. The characters
249 * are interpreted as Unicode (UTF-16) entities.
250 * If you don't want a vendor name string, undefine these macros.
251 * ALWAYS define a vendor name containing your Internet domain name if you use
252 * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for
253 * details.
254 */
255#define USB_CFG_DEVICE_NAME 'D','I','S','C','I','P','A','D'
256#define USB_CFG_DEVICE_NAME_LEN 8
257/* Same as above for the device name. If you don't want a device name, undefine
258 * the macros. See the file USB-IDs-for-free.txt before you assign a name if
259 * you use a shared VID/PID.
260 */
261#define USB_CFG_SERIAL_NUMBER '0'
262#define USB_CFG_SERIAL_NUMBER_LEN 1
263/* Same as above for the serial number. If you don't want a serial number,
264 * undefine the macros.
265 * It may be useful to provide the serial number through other means than at
266 * compile time. See the section about descriptor properties below for how
267 * to fine tune control over USB descriptors such as the string descriptor
268 * for the serial number.
269 */
270#define USB_CFG_DEVICE_CLASS 0
271#define USB_CFG_DEVICE_SUBCLASS 0
272/* See USB specification if you want to conform to an existing device class.
273 * Class 0xff is "vendor specific".
274 */
275#define USB_CFG_INTERFACE_CLASS 3 /* HID */
276#define USB_CFG_INTERFACE_SUBCLASS 1 /* Boot */
277#define USB_CFG_INTERFACE_PROTOCOL 1 /* Keyboard */
278/* See USB specification if you want to conform to an existing device class or
279 * protocol. The following classes must be set at interface level:
280 * HID class is 3, no subclass and protocol required (but may be useful!)
281 * CDC class is 2, use subclass 2 and protocol 1 for ACM
282 */
283#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 0
284/* Define this to the length of the HID report descriptor, if you implement
285 * an HID device. Otherwise don't define it or define it to 0.
286 * If you use this define, you must add a PROGMEM character array named
287 * "usbHidReportDescriptor" to your code which contains the report descriptor.
288 * Don't forget to keep the array and this define in sync!
289 */
290
291/* #define USB_PUBLIC static */
292/* Use the define above if you #include usbdrv.c instead of linking against it.
293 * This technique saves a couple of bytes in flash memory.
294 */
295
296/* ------------------- Fine Control over USB Descriptors ------------------- */
297/* If you don't want to use the driver's default USB descriptors, you can
298 * provide our own. These can be provided as (1) fixed length static data in
299 * flash memory, (2) fixed length static data in RAM or (3) dynamically at
300 * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
301 * information about this function.
302 * Descriptor handling is configured through the descriptor's properties. If
303 * no properties are defined or if they are 0, the default descriptor is used.
304 * Possible properties are:
305 * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
306 * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is
307 * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
308 * you want RAM pointers.
309 * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
310 * in static memory is in RAM, not in flash memory.
311 * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
312 * the driver must know the descriptor's length. The descriptor itself is
313 * found at the address of a well known identifier (see below).
314 * List of static descriptor names (must be declared PROGMEM if in flash):
315 * char usbDescriptorDevice[];
316 * char usbDescriptorConfiguration[];
317 * char usbDescriptorHidReport[];
318 * char usbDescriptorString0[];
319 * int usbDescriptorStringVendor[];
320 * int usbDescriptorStringDevice[];
321 * int usbDescriptorStringSerialNumber[];
322 * Other descriptors can't be provided statically, they must be provided
323 * dynamically at runtime.
324 *
325 * Descriptor properties are or-ed or added together, e.g.:
326 * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
327 *
328 * The following descriptors are defined:
329 * USB_CFG_DESCR_PROPS_DEVICE
330 * USB_CFG_DESCR_PROPS_CONFIGURATION
331 * USB_CFG_DESCR_PROPS_STRINGS
332 * USB_CFG_DESCR_PROPS_STRING_0
333 * USB_CFG_DESCR_PROPS_STRING_VENDOR
334 * USB_CFG_DESCR_PROPS_STRING_PRODUCT
335 * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
336 * USB_CFG_DESCR_PROPS_HID
337 * USB_CFG_DESCR_PROPS_HID_REPORT
338 * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
339 *
340 * Note about string descriptors: String descriptors are not just strings, they
341 * are Unicode strings prefixed with a 2 byte header. Example:
342 * int serialNumberDescriptor[] = {
343 * USB_STRING_DESCRIPTOR_HEADER(6),
344 * 'S', 'e', 'r', 'i', 'a', 'l'
345 * };
346 */
347
348#define USB_CFG_DESCR_PROPS_DEVICE 0
349#define USB_CFG_DESCR_PROPS_CONFIGURATION USB_PROP_IS_DYNAMIC
350//#define USB_CFG_DESCR_PROPS_CONFIGURATION 0
351#define USB_CFG_DESCR_PROPS_STRINGS 0
352#define USB_CFG_DESCR_PROPS_STRING_0 0
353#define USB_CFG_DESCR_PROPS_STRING_VENDOR 0
354#define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0
355#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0
356#define USB_CFG_DESCR_PROPS_HID USB_PROP_IS_DYNAMIC
357//#define USB_CFG_DESCR_PROPS_HID 0
358#define USB_CFG_DESCR_PROPS_HID_REPORT USB_PROP_IS_DYNAMIC
359//#define USB_CFG_DESCR_PROPS_HID_REPORT 0
360#define USB_CFG_DESCR_PROPS_UNKNOWN 0
361
362#define usbMsgPtr_t unsigned short
363/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to
364 * a scalar type here because gcc generates slightly shorter code for scalar
365 * arithmetics than for pointer arithmetics. Remove this define for backward
366 * type compatibility or define it to an 8 bit type if you use data in RAM only
367 * and all RAM is below 256 bytes (tiny memory model in IAR CC).
368 */
369
370/* ----------------------- Optional MCU Description ------------------------ */
371
372/* The following configurations have working defaults in usbdrv.h. You
373 * usually don't need to set them explicitly. Only if you want to run
374 * the driver on a device which is not yet supported or with a compiler
375 * which is not fully supported (such as IAR C) or if you use a differnt
376 * interrupt than INT0, you may have to define some of these.
377 */
378/* #define USB_INTR_CFG MCUCR */
379/* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */
380/* #define USB_INTR_CFG_CLR 0 */
381/* #define USB_INTR_ENABLE GIMSK */
382/* #define USB_INTR_ENABLE_BIT INT0 */
383/* #define USB_INTR_PENDING GIFR */
384/* #define USB_INTR_PENDING_BIT INTF0 */
385/* #define USB_INTR_VECTOR INT0_vect */
386
387/* Set INT1 for D- falling edge to count SOF */
388/* #define USB_INTR_CFG EICRA */
389// #define USB_INTR_CFG_SET ((1 << ISC11) | (0 << ISC10))
390// /* #define USB_INTR_CFG_CLR 0 */
391// /* #define USB_INTR_ENABLE EIMSK */
392// #define USB_INTR_ENABLE_BIT INT1
393// /* #define USB_INTR_PENDING EIFR */
394// #define USB_INTR_PENDING_BIT INTF1
395// #define USB_INTR_VECTOR INT1_vect
396
397#endif /* __usbconfig_h_included__ */