aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvuhopkep <boy9x0@gmail.com>2019-06-27 03:41:32 +0700
committerDrashna Jaelre <drashna@live.com>2019-06-26 13:41:32 -0700
commitd4ff836d6449b442e6f5ddc31678a489d0f6b3d6 (patch)
treeed062a963aa4263d1dcf16db438aed1ad8325c10
parent2a56b61a28dde9e8ab0a9afcd22f913f988b2a0e (diff)
downloadqmk_firmware-d4ff836d6449b442e6f5ddc31678a489d0f6b3d6.tar.gz
qmk_firmware-d4ff836d6449b442e6f5ddc31678a489d0f6b3d6.zip
[Keyboard] Add Hnah40 keyboard (#6183)
* Add Hnah40 keyboard Adding new keyboard Hnah40, open source hardware * update infor * make code looks neater * move to handwired board move and update readme file * update * update * update image * change bootloader type * last change
-rw-r--r--keyboards/handwired/hnah40/config.h220
-rw-r--r--keyboards/handwired/hnah40/hnah40.c43
-rw-r--r--keyboards/handwired/hnah40/hnah40.h38
-rw-r--r--keyboards/handwired/hnah40/info.json54
-rw-r--r--keyboards/handwired/hnah40/keymaps/default/config.h18
-rw-r--r--keyboards/handwired/hnah40/keymaps/default/keymap.c48
-rw-r--r--keyboards/handwired/hnah40/keymaps/default/readme.md1
-rw-r--r--keyboards/handwired/hnah40/readme.md20
-rw-r--r--keyboards/handwired/hnah40/rules.mk73
-rw-r--r--keyboards/handwired/hnah40/usbconfig.h397
10 files changed, 912 insertions, 0 deletions
diff --git a/keyboards/handwired/hnah40/config.h b/keyboards/handwired/hnah40/config.h
new file mode 100644
index 000000000..b7a4105d0
--- /dev/null
+++ b/keyboards/handwired/hnah40/config.h
@@ -0,0 +1,220 @@
1/* Copyright 2018 HnahKB
2
3This program is free software: you can redistribute it and/or modify
4it under the terms of the GNU General Public License as published by
5the Free Software Foundation, either version 2 of the License, or
6(at your option) any later version.
7
8This program is distributed in the hope that it will be useful,
9but WITHOUT ANY WARRANTY; without even the implied warranty of
10MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11GNU General Public License for more details.
12
13You should have received a copy of the GNU General Public License
14along with this program. If not, see <http://www.gnu.org/licenses/>.
15*/
16
17#pragma once
18
19#include "config_common.h"
20
21/* USB Device descriptor parameter */
22#define VENDOR_ID 0xFEED
23#define PRODUCT_ID 0x0000
24#define DEVICE_VER 0x0002
25#define MANUFACTURER HnahKB
26#define PRODUCT hnah40
27#define DESCRIPTION Custom 40% PCB
28
29/* key matrix size */
30#define MATRIX_ROWS 4
31#define MATRIX_COLS 11
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#define MATRIX_ROW_PINS { B4, B5, B3, D4 }
44#define MATRIX_COL_PINS { B0, D7, D6, D5, B2, B1, C0, C1, C2, C3, D1 }
45#define UNUSED_PINS
46
47/* COL2ROW, ROW2COL*/
48#define DIODE_DIRECTION COL2ROW
49
50// #define BACKLIGHT_PIN B7
51// #define BACKLIGHT_BREATHING
52// #define BACKLIGHT_LEVELS 3
53
54// #define RGB_DI_PIN E2
55// #ifdef RGB_DI_PIN
56// #define RGBLIGHT_ANIMATIONS
57// #define RGBLED_NUM 16
58// #define RGBLIGHT_HUE_STEP 8
59// #define RGBLIGHT_SAT_STEP 8
60// #define RGBLIGHT_VAL_STEP 8
61// #endif
62
63/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
64#define DEBOUNCING 5
65
66/* define if matrix has ghost (lacks anti-ghosting diodes) */
67//#define MATRIX_HAS_GHOST
68
69/* number of backlight levels */
70
71/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
72#define LOCKING_SUPPORT_ENABLE
73/* Locking resynchronize hack */
74#define LOCKING_RESYNC_ENABLE
75
76/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
77 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
78 */
79// #define GRAVE_ESC_CTRL_OVERRIDE
80
81/*
82 * Force NKRO
83 *
84 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
85 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
86 * makefile for this to work.)
87 *
88 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
89 * until the next keyboard reset.
90 *
91 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
92 * fully operational during normal computer usage.
93 *
94 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
95 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
96 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
97 * power-up.
98 *
99 */
100//#define FORCE_NKRO
101
102/*
103 * Magic Key Options
104 *
105 * Magic keys are hotkey commands that allow control over firmware functions of
106 * the keyboard. They are best used in combination with the HID Listen program,
107 * found here: https://www.pjrc.com/teensy/hid_listen.html
108 *
109 * The options below allow the magic key functionality to be changed. This is
110 * useful if your keyboard/keypad is missing keys and you want magic key support.
111 *
112 */
113
114
115
116/* control how magic key switches layers */
117//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
118//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
119//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
120
121/* override magic key keymap */
122//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
123//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
124//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
125//#define MAGIC_KEY_HELP1 H
126//#define MAGIC_KEY_HELP2 SLASH
127//#define MAGIC_KEY_DEBUG D
128//#define MAGIC_KEY_DEBUG_MATRIX X
129//#define MAGIC_KEY_DEBUG_KBD K
130//#define MAGIC_KEY_DEBUG_MOUSE M
131//#define MAGIC_KEY_VERSION V
132//#define MAGIC_KEY_STATUS S
133//#define MAGIC_KEY_CONSOLE C
134//#define MAGIC_KEY_LAYER0_ALT1 ESC
135//#define MAGIC_KEY_LAYER0_ALT2 GRAVE
136//#define MAGIC_KEY_LAYER0 0
137//#define MAGIC_KEY_LAYER1 1
138//#define MAGIC_KEY_LAYER2 2
139//#define MAGIC_KEY_LAYER3 3
140//#define MAGIC_KEY_LAYER4 4
141//#define MAGIC_KEY_LAYER5 5
142//#define MAGIC_KEY_LAYER6 6
143//#define MAGIC_KEY_LAYER7 7
144//#define MAGIC_KEY_LAYER8 8
145//#define MAGIC_KEY_LAYER9 9
146//#define MAGIC_KEY_BOOTLOADER PAUSE
147//#define MAGIC_KEY_LOCK CAPS
148//#define MAGIC_KEY_EEPROM E
149//#define MAGIC_KEY_NKRO N
150//#define MAGIC_KEY_SLEEP_LED Z
151
152/*
153 * Feature disable options
154 * These options are also useful to firmware size reduction.
155 */
156
157/* disable debug print */
158//#define NO_DEBUG
159
160/* disable print */
161//#define NO_PRINT
162
163/* disable action features */
164//#define NO_ACTION_LAYER
165//#define NO_ACTION_TAPPING
166//#define NO_ACTION_ONESHOT
167//#define NO_ACTION_MACRO
168//#define NO_ACTION_FUNCTION
169
170/*
171 * MIDI options
172 */
173
174/* Prevent use of disabled MIDI features in the keymap */
175//#define MIDI_ENABLE_STRICT 1
176
177/* enable basic MIDI features:
178 - MIDI notes can be sent when in Music mode is on
179*/
180//#define MIDI_BASIC
181
182/* enable advanced MIDI features:
183 - MIDI notes can be added to the keymap
184 - Octave shift and transpose
185 - Virtual sustain, portamento, and modulation wheel
186 - etc.
187*/
188//#define MIDI_ADVANCED
189
190/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
191//#define MIDI_TONE_KEYCODE_OCTAVES 1
192
193/*
194 * HD44780 LCD Display Configuration
195 */
196/*
197#define LCD_LINES 2 //< number of visible lines of the display
198#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
199
200#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
201
202#if LCD_IO_MODE
203#define LCD_PORT PORTB //< port for the LCD lines
204#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
205#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
206#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
207#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
208#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
209#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
210#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
211#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
212#define LCD_RS_PORT LCD_PORT //< port for RS line
213#define LCD_RS_PIN 3 //< pin for RS line
214#define LCD_RW_PORT LCD_PORT //< port for RW line
215#define LCD_RW_PIN 2 //< pin for RW line
216#define LCD_E_PORT LCD_PORT //< port for Enable line
217#define LCD_E_PIN 1 //< pin for Enable line
218#endif
219*/
220
diff --git a/keyboards/handwired/hnah40/hnah40.c b/keyboards/handwired/hnah40/hnah40.c
new file mode 100644
index 000000000..0f08136c2
--- /dev/null
+++ b/keyboards/handwired/hnah40/hnah40.c
@@ -0,0 +1,43 @@
1/* Copyright 2019 HnahKB
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 "hnah40.h"
17
18void matrix_init_kb(void) {
19 // put your keyboard start-up code here
20 // runs once when the firmware starts up
21
22 matrix_init_user();
23}
24
25void matrix_scan_kb(void) {
26 // put your looping keyboard code here
27 // runs every cycle (a lot)
28
29 matrix_scan_user();
30}
31
32bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
33 // put your per-action keyboard code here
34 // runs for every action, just before processing by the firmware
35
36 return process_record_user(keycode, record);
37}
38
39void led_set_kb(uint8_t usb_led) {
40 // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
41
42 led_set_user(usb_led);
43}
diff --git a/keyboards/handwired/hnah40/hnah40.h b/keyboards/handwired/hnah40/hnah40.h
new file mode 100644
index 000000000..28e09f668
--- /dev/null
+++ b/keyboards/handwired/hnah40/hnah40.h
@@ -0,0 +1,38 @@
1/* Copyright 2019 HnahKB
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// This a shortcut to help you visually see your layout.
21// The following is an example using the Planck MIT layout
22// The first section contains all of the arguments representing the physical
23// layout of the board and position of the keys
24// The second converts the arguments into a two-dimensional array which
25// represents the switch matrix.
26
27#define LAYOUT( \
28 k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k39, \
29 k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, \
30 k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, \
31 k30, k31, k32, k33, k35, k37, k38, k3A\
32) \
33{ \
34 { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A }, \
35 { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A }, \
36 { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A }, \
37 { k30, k31, k32, k33, KC_NO, k35, KC_NO, k37, k38, k39, k3A }, \
38}
diff --git a/keyboards/handwired/hnah40/info.json b/keyboards/handwired/hnah40/info.json
new file mode 100644
index 000000000..6a577a520
--- /dev/null
+++ b/keyboards/handwired/hnah40/info.json
@@ -0,0 +1,54 @@
1{
2 "keyboard_name": "Hnah40",
3 "url": "https://github.com/vuhopkep/PCB/tree/master/Hnah40-Atmega328p/PCB_V1/PCB",
4 "maintainer": "HnahKB",
5 "width": 12,
6 "height": 4,
7 "layouts": {
8 "LAYOUT": {
9 "layout": [
10 {"label":"Esc", "x":0, "y":0},
11 {"label":"Q", "x":1, "y":0},
12 {"label":"W", "x":2, "y":0},
13 {"label":"E", "x":3, "y":0},
14 {"label":"R", "x":4, "y":0},
15 {"label":"T", "x":5, "y":0},
16 {"label":"Y", "x":6, "y":0},
17 {"label":"U", "x":7, "y":0},
18 {"label":"I", "x":8, "y":0},
19 {"label":"O", "x":9, "y":0},
20 {"label":"P", "x":10, "y":0},
21 {"label":"BSPC", "x":11, "y":0},
22 {"label":"Tab", "x":0, "y":1, "w":1.5},
23 {"label":"A", "x":1.5, "y":1},
24 {"label":"S", "x":2.5, "y":1},
25 {"label":"D", "x":3.5, "y":1},
26 {"label":"F", "x":4.5, "y":1},
27 {"label":"G", "x":5.5, "y":1},
28 {"label":"H", "x":6.5, "y":1},
29 {"label":"J", "x":7.5, "y":1},
30 {"label":"K", "x":8.5, "y":1},
31 {"label":"L", "x":9.5, "y":1},
32 {"label":"Enter", "x":10.5, "y":1, "w":1.5},
33 {"label":"Shift", "x":0, "y":2, "w":1.75},
34 {"label":"Z", "x":1.75, "y":2},
35 {"label":"X", "x":2.75, "y":2},
36 {"label":"C", "x":3.75, "y":2},
37 {"label":"V", "x":4.75, "y":2},
38 {"label":"B", "x":5.75, "y":2},
39 {"label":"N", "x":6.75, "y":2},
40 {"label":"M", "x":7.75, "y":2},
41 {"label":",", "x":8.75, "y":2},
42 {"label":"Shift", "x":9.75, "y":2, "w":2.25},
43 {"label":"Ctrl", "x":0, "y":3, "w":1.25},
44 {"label":"Win", "x":1.25, "y":3, "w":1.5},
45 {"label":"Alt", "x":2.75, "y":3, "w":1.25},
46 {"label":"Space", "x":4, "y":3, "w":2},
47 {"label":"Space", "x":6, "y":3, "w":2},
48 {"label":"App", "x":8, "y":3, "w":1.25},
49 {"label":"Fn", "x":9.25, "y":3, "w":1.5},
50 {"label":"Ctrl", "x":10.75, "y":3, "w":1.25}
51 ]
52 }
53 }
54} \ No newline at end of file
diff --git a/keyboards/handwired/hnah40/keymaps/default/config.h b/keyboards/handwired/hnah40/keymaps/default/config.h
new file mode 100644
index 000000000..74412a948
--- /dev/null
+++ b/keyboards/handwired/hnah40/keymaps/default/config.h
@@ -0,0 +1,18 @@
1/* Copyright 2019 HnahKB
2 * This program is free software: you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation, either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program. If not, see <http://www.gnu.org/licenses/>.
14 */
15
16#pragma once
17
18// place overrides here
diff --git a/keyboards/handwired/hnah40/keymaps/default/keymap.c b/keyboards/handwired/hnah40/keymaps/default/keymap.c
new file mode 100644
index 000000000..2fc67ba5e
--- /dev/null
+++ b/keyboards/handwired/hnah40/keymaps/default/keymap.c
@@ -0,0 +1,48 @@
1/* Copyright 2019 HnahKB
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// Defines the keycodes used by our macros in process_record_user
19enum hnah_layers{
20 _QWERTY,
21 _LOWER,
22 _RAISE
23};
24
25
26#define LOWER MO(_LOWER)
27#define RAISE MO(_RAISE)
28
29const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
30 [_QWERTY] = LAYOUT( /* Base */
31 KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
32 LT(RAISE, KC_CAPS), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_ENT,
33 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_RSFT,
34 KC_LCTL, KC_LGUI, KC_LALT, KC_SPACE, KC_SPACE, KC_APP, LOWER, KC_RCTL
35 ),
36 [_LOWER] = LAYOUT( /* Base */
37 RESET, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
38 RAISE, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_SCLN, KC_QUOT,
39 KC_LSFT, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_COMM, KC_DOT, KC_SLSH, KC_SLSH,
40 KC_LCTL, KC_LGUI, KC_LALT, KC_SPACE, KC_SPACE, KC_APP, KC_TRNS, KC_RCTL
41 ),
42 [_RAISE] = LAYOUT( /* Base */
43 RESET, KC_1, KC_UP, RGB_TOG, RGB_MOD, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL,
44 KC_TRNS, KC_LEFT, KC_DOWN, KC_RGHT , RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_ENT,
45 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_UP, KC_TRNS,
46 KC_TRNS, KC_TRNS, KC_TRNS, KC_SPACE, KC_SPACE, KC_LEFT, KC_DOWN, KC_RGHT
47 ),
48};
diff --git a/keyboards/handwired/hnah40/keymaps/default/readme.md b/keyboards/handwired/hnah40/keymaps/default/readme.md
new file mode 100644
index 000000000..b948ef964
--- /dev/null
+++ b/keyboards/handwired/hnah40/keymaps/default/readme.md
@@ -0,0 +1 @@
![Hnah40 Layout Image](https://i.imgur.com/7LT6Vam.jpg) \ No newline at end of file
diff --git a/keyboards/handwired/hnah40/readme.md b/keyboards/handwired/hnah40/readme.md
new file mode 100644
index 000000000..20e2d7127
--- /dev/null
+++ b/keyboards/handwired/hnah40/readme.md
@@ -0,0 +1,20 @@
1# hnah40
2
3![Hnah40](https://i.imgur.com/nXVmcyc.jpg)
4
5A custom 40% keyboard PCB, insprired by Plaid keyboard from hsgw
6
7
8Keyboard Maintainer: [vuhopkep](https://github.com/vuhopkep)
9Hardware Availability: https://github.com/vuhopkep/PCB/tree/master/Hnah40-Atmega328p
10
11Make example for this keyboard (after setting up your build environment):
12
13 make handwired/hnah40:default:program
14
15## Bootloader
16use usbasploader from hsgw.
17https://github.com/hsgw/USBaspLoader/tree/plaid
18
19
20See 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/handwired/hnah40/rules.mk b/keyboards/handwired/hnah40/rules.mk
new file mode 100644
index 000000000..efd11bfa5
--- /dev/null
+++ b/keyboards/handwired/hnah40/rules.mk
@@ -0,0 +1,73 @@
1# MCU name
2MCU = atmega328p
3PROTOCOL = VUSB
4
5# Processor frequency.
6# This will define a symbol, F_CPU, in all source code files equal to the
7# processor frequency in Hz. You can then use this symbol in your source code to
8# calculate timings. Do NOT tack on a 'UL' at the end, this will be done
9# automatically to create a 32-bit value in your source code.
10#
11# This will be an integer division of F_USB below, as it is sourced by
12# F_USB after it has run through any CPU prescalers. Note that this value
13# does not *change* the processor frequency - it should merely be updated to
14# reflect the processor speed set externally so that the code can use accurate
15# software delays.
16F_CPU = 16000000
17
18
19#
20# LUFA specific
21#
22# Target architecture (see library "Board Types" documentation).
23ARCH = AVR8
24
25# Input clock frequency.
26# This will define a symbol, F_USB, in all source code files equal to the
27# input clock frequency (before any prescaling is performed) in Hz. This value may
28# differ from F_CPU if prescaling is used on the latter, and is required as the
29# raw input clock is fed directly to the PLL sections of the AVR for high speed
30# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
31# at the end, this will be done automatically to create a 32-bit value in your
32# source code.
33#
34# If no clock division is performed on the input clock inside the AVR (via the
35# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
36F_USB = $(F_CPU)
37
38# Interrupt driven control endpoint task(+60)
39OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
40
41BOOTLOADER = bootloadHID
42
43# Flash program via avrdude, but default command is not suitable.
44# You can use hnah40:default:program
45PROGRAM_CMD = avrdude -c usbasp -p m328p -U flash:w:$(BUILD_DIR)/$(TARGET).hex
46
47
48# disable debug code
49OPT_DEFS = -DDEBUG_LEVEL=0
50
51
52# Build Options
53# change yes to no to disable
54#
55BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
56MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
57EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
58CONSOLE_ENABLE = no # Console for debug(+400)
59COMMAND_ENABLE = no # Commands for debug and configuration
60# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
61SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
62# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
63NKRO_ENABLE = no # USB Nkey Rollover
64BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default
65RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
66MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config)
67UNICODE_ENABLE = no # Unicode
68BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
69AUDIO_ENABLE = no # Audio output on port C6
70FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
71HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400)
72NO_UART = yes
73NO_SUSPEND_POWER_DOWN = yes \ No newline at end of file
diff --git a/keyboards/handwired/hnah40/usbconfig.h b/keyboards/handwired/hnah40/usbconfig.h
new file mode 100644
index 000000000..cbd37c34d
--- /dev/null
+++ b/keyboards/handwired/hnah40/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 0x00, 0x01
243/* Version number of the device: Minor number first, then major number.
244 */
245#define USB_CFG_VENDOR_NAME 'H','n','a','h','K','B'
246#define USB_CFG_VENDOR_NAME_LEN 6
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 'H', 'n', 'a', 'h', '4', '0'
256#define USB_CFG_DEVICE_NAME_LEN 6
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 'H','n','a','h','K','B'
262#define USB_CFG_SERIAL_NUMBER_LEN 6
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__ */