diff options
-rw-r--r-- | keyboards/keycapsss/plaid_pad/config.h | 38 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/info.json | 31 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/keymaps/default/config.h | 3 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c | 44 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/keymaps/default/readme.md | 11 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/plaid_pad.c | 1 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/plaid_pad.h | 18 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/readme.md | 25 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/rules.mk | 41 | ||||
-rw-r--r-- | keyboards/keycapsss/plaid_pad/usbconfig.h | 383 |
10 files changed, 595 insertions, 0 deletions
diff --git a/keyboards/keycapsss/plaid_pad/config.h b/keyboards/keycapsss/plaid_pad/config.h new file mode 100644 index 000000000..c4d22b663 --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/config.h | |||
@@ -0,0 +1,38 @@ | |||
1 | #pragma once | ||
2 | |||
3 | #include "config_common.h" | ||
4 | |||
5 | /* USB Device descriptor parameter */ | ||
6 | #define VENDOR_ID 0xFEED | ||
7 | #define PRODUCT_ID 0xAF12 | ||
8 | #define DEVICE_VER 0x0001 | ||
9 | #define MANUFACTURER Keycapsss | ||
10 | #define PRODUCT Plaid-Pad | ||
11 | #define DESCRIPTION 4x4 numpad with through hole components | ||
12 | |||
13 | /* key matrix size */ | ||
14 | #define MATRIX_ROWS 4 | ||
15 | #define MATRIX_COLS 4 | ||
16 | |||
17 | #define MATRIX_ROW_PINS { C0, C1, C2, C3 } | ||
18 | #define MATRIX_COL_PINS { B0, D7, D6, D5 } | ||
19 | #define UNUSED_PINS { B3, B4, B5, D4} | ||
20 | |||
21 | #define ENCODERS_PAD_A { D0, B1 } | ||
22 | #define ENCODERS_PAD_B { D1, B2 } | ||
23 | #define ENCODER_RESOLUTION 4 | ||
24 | |||
25 | /* COL2ROW, ROW2COL*/ | ||
26 | #define DIODE_DIRECTION COL2ROW | ||
27 | |||
28 | #define NO_UART 1 | ||
29 | #define USB_MAX_POWER_CONSUMPTION 100 | ||
30 | |||
31 | /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ | ||
32 | #define DEBOUNCE 5 | ||
33 | |||
34 | /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ | ||
35 | #define LOCKING_SUPPORT_ENABLE | ||
36 | |||
37 | /* Locking resynchronize hack */ | ||
38 | #define LOCKING_RESYNC_ENABLE | ||
diff --git a/keyboards/keycapsss/plaid_pad/info.json b/keyboards/keycapsss/plaid_pad/info.json new file mode 100644 index 000000000..cbc2b5210 --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/info.json | |||
@@ -0,0 +1,31 @@ | |||
1 | { | ||
2 | "keyboard_name": "Plaid-Pad", | ||
3 | "keyboard_folder": "plaid_pad", | ||
4 | "url": "https://keycapsss.com/diy-kits/104/plaid-pad-4x4-numpad", | ||
5 | "maintainer": "BenRoe", | ||
6 | "width": 4, | ||
7 | "height": 4, | ||
8 | "layouts": { | ||
9 | "LAYOUT_ortho_4x4": { | ||
10 | "key_count": 16, | ||
11 | "layout": [ | ||
12 | {"w": 1,"x": 0,"y": 0}, | ||
13 | {"w": 1,"x": 1,"y": 0}, | ||
14 | {"w": 1,"x": 2,"y": 0}, | ||
15 | {"w": 1,"x": 3,"y": 0}, | ||
16 | {"w": 1,"x": 0,"y": 1}, | ||
17 | {"w": 1,"x": 1,"y": 1}, | ||
18 | {"w": 1,"x": 2,"y": 1}, | ||
19 | {"w": 1,"x": 3,"y": 1}, | ||
20 | {"w": 1,"x": 0,"y": 2}, | ||
21 | {"w": 1,"x": 1,"y": 2}, | ||
22 | {"w": 1,"x": 2,"y": 2}, | ||
23 | {"w": 1,"x": 3,"y": 2}, | ||
24 | {"w": 1,"x": 0,"y": 3}, | ||
25 | {"w": 1,"x": 1,"y": 3}, | ||
26 | {"w": 1,"x": 2,"y": 3}, | ||
27 | {"w": 1,"x": 3,"y": 3} | ||
28 | ] | ||
29 | } | ||
30 | } | ||
31 | } | ||
diff --git a/keyboards/keycapsss/plaid_pad/keymaps/default/config.h b/keyboards/keycapsss/plaid_pad/keymaps/default/config.h new file mode 100644 index 000000000..271f48d00 --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/keymaps/default/config.h | |||
@@ -0,0 +1,3 @@ | |||
1 | #pragma once | ||
2 | |||
3 | // place overrides here | ||
diff --git a/keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c b/keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c new file mode 100644 index 000000000..bdfd7fb78 --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c | |||
@@ -0,0 +1,44 @@ | |||
1 | #include QMK_KEYBOARD_H | ||
2 | |||
3 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
4 | |||
5 | /* | ||
6 | * ,-----------------------, | ||
7 | * | 7 | 8 | 9 | / | | ||
8 | * |-----+-----+-----+-----| | ||
9 | * | 4 | 5 | 6 | * | | ||
10 | * |-----+-----+-----+-----| | ||
11 | * | 1 | 2 | 3 | - | | ||
12 | * |-----+-----+-----+-----| | ||
13 | * | 0 | . | = | + | | ||
14 | * `-----------------------' | ||
15 | */ | ||
16 | LAYOUT_ortho_4x4( | ||
17 | KC_P7, KC_P8, KC_P9, KC_PSLS, | ||
18 | KC_P4, KC_P5, KC_P6, KC_PAST, | ||
19 | KC_P1, KC_P2, KC_P3, KC_PMNS, | ||
20 | KC_P0, KC_PDOT, KC_PEQL, KC_PPLS | ||
21 | ) | ||
22 | |||
23 | }; | ||
24 | |||
25 | // Set led state during powerup | ||
26 | void keyboard_post_init_user(void) { | ||
27 | writePinHigh(LED_RED); | ||
28 | } | ||
29 | |||
30 | void encoder_update_user(uint8_t index, bool clockwise) { | ||
31 | if (index == 0) { // First encoder - top left | ||
32 | if (clockwise) { | ||
33 | tap_code(KC_UP); | ||
34 | } else { | ||
35 | tap_code(KC_DOWN); | ||
36 | } | ||
37 | } else if (index == 1) { // Second encoder - top right | ||
38 | if (clockwise) { | ||
39 | tap_code(KC_UP); | ||
40 | } else { | ||
41 | tap_code(KC_DOWN); | ||
42 | } | ||
43 | } | ||
44 | } | ||
diff --git a/keyboards/keycapsss/plaid_pad/keymaps/default/readme.md b/keyboards/keycapsss/plaid_pad/keymaps/default/readme.md new file mode 100644 index 000000000..1c1b1513d --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/keymaps/default/readme.md | |||
@@ -0,0 +1,11 @@ | |||
1 | |||
2 | <img src="https://i.imgur.com/V82cMqq.png" width="200"> | ||
3 | |||
4 | # Default Plaid-Pad Layout | ||
5 | |||
6 | This is the default layout that comes flashed on every Plaid-Pad. | ||
7 | The upper left (7) and right (/) switch, can be replaced by a rotary encoder. | ||
8 | They do "Up Arrow" (KC_UP) and "Down Arrow" (KC_DOWN). | ||
9 | Encoder with build-in switch are supported. | ||
10 | |||
11 | |||
diff --git a/keyboards/keycapsss/plaid_pad/plaid_pad.c b/keyboards/keycapsss/plaid_pad/plaid_pad.c new file mode 100644 index 000000000..befddf42a --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/plaid_pad.c | |||
@@ -0,0 +1 @@ | |||
#include "plaid_pad.h" | |||
diff --git a/keyboards/keycapsss/plaid_pad/plaid_pad.h b/keyboards/keycapsss/plaid_pad/plaid_pad.h new file mode 100644 index 000000000..fae9b132a --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/plaid_pad.h | |||
@@ -0,0 +1,18 @@ | |||
1 | #pragma once | ||
2 | |||
3 | #include "quantum.h" | ||
4 | |||
5 | #define LAYOUT_ortho_4x4( \ | ||
6 | K00, K01, K02, K03, \ | ||
7 | K10, K11, K12, K13, \ | ||
8 | K20, K21, K22, K23, \ | ||
9 | K30, K31, K32, K33 \ | ||
10 | ) { \ | ||
11 | { K00, K01, K02, K03 }, \ | ||
12 | { K10, K11, K12, K13 }, \ | ||
13 | { K20, K21, K22, K23 }, \ | ||
14 | { K30, K31, K32, K33 } \ | ||
15 | } | ||
16 | |||
17 | #define LED_RED C5 // LED1 | ||
18 | #define LED_GREEN C4 // LED2 | ||
diff --git a/keyboards/keycapsss/plaid_pad/readme.md b/keyboards/keycapsss/plaid_pad/readme.md new file mode 100644 index 000000000..ad38f119c --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/readme.md | |||
@@ -0,0 +1,25 @@ | |||
1 | # Plaid-Pad | ||
2 | <img src="https://i.imgur.com/Jovhxpr.jpg" width="400"> | ||
3 | <img src="https://i.imgur.com/V82cMqq.png" width="400"> | ||
4 | |||
5 | A 4x4 numpad with only through hole components. | ||
6 | It's a great companion to the Plaid keyboard by [hsgw](https://github.com/hsgw/) and heavily inspired by it. | ||
7 | |||
8 | * Keyboard Maintainer: BenRoe [Github](https://github.com/BenRoe) / [Twitter](https://twitter.com/keycapsss) | ||
9 | * Hardware Supported: ATmega328P with VUSB ([see Bootloader section](#Bootloader)) | ||
10 | * Hardware Availability: [Keycapsss.com](https://keycapsss.com) | ||
11 | |||
12 | Make example for this keyboard (after setting up your build environment): | ||
13 | |||
14 | make keycapsss/plaid_pad:default | ||
15 | |||
16 | Flashing example for this keyboard: | ||
17 | |||
18 | make keycapsss/plaid_pad:default:flash | ||
19 | |||
20 | ## Bootloader | ||
21 | - same usbasploader as Plaid ([Instruction](https://github.com/hsgw/plaid/blob/master/doc/en/bootloader.md), [Repository](https://github.com/hsgw/USBaspLoader/tree/plaid)) | ||
22 | |||
23 | --- | ||
24 | |||
25 | 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). | ||
diff --git a/keyboards/keycapsss/plaid_pad/rules.mk b/keyboards/keycapsss/plaid_pad/rules.mk new file mode 100644 index 000000000..f62833ca6 --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/rules.mk | |||
@@ -0,0 +1,41 @@ | |||
1 | # MCU name | ||
2 | MCU = atmega328p | ||
3 | |||
4 | # Bootloader selection | ||
5 | # Teensy halfkay | ||
6 | # Pro Micro caterina | ||
7 | # Atmel DFU atmel-dfu | ||
8 | # LUFA DFU lufa-dfu | ||
9 | # QMK DFU qmk-dfu | ||
10 | # ATmega32A bootloadHID | ||
11 | # ATmega328P USBasp | ||
12 | BOOTLOADER = USBasp | ||
13 | |||
14 | # disable debug code | ||
15 | OPT_DEFS = -DDEBUG_LEVEL=0 | ||
16 | |||
17 | |||
18 | # Build Options | ||
19 | # change yes to no to disable | ||
20 | # | ||
21 | BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration | ||
22 | MOUSEKEY_ENABLE = yes # Mouse keys | ||
23 | EXTRAKEY_ENABLE = yes # Audio control and System control | ||
24 | CONSOLE_ENABLE = no # Console for debug | ||
25 | COMMAND_ENABLE = no # Commands for debug and configuration | ||
26 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE | ||
27 | SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | ||
28 | # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | ||
29 | NKRO_ENABLE = no # USB Nkey Rollover | ||
30 | BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default | ||
31 | RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow | ||
32 | MIDI_ENABLE = no # MIDI support | ||
33 | UNICODE_ENABLE = no # Unicode | ||
34 | BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID | ||
35 | AUDIO_ENABLE = no # Audio output on port C6 | ||
36 | FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches | ||
37 | HD44780_ENABLE = no # Enable support for HD44780 based LCDs | ||
38 | ENCODER_ENABLE = yes | ||
39 | |||
40 | LAYOUTS = ortho_4x4 | ||
41 | LAYOUTS_HAS_RGB = no | ||
diff --git a/keyboards/keycapsss/plaid_pad/usbconfig.h b/keyboards/keycapsss/plaid_pad/usbconfig.h new file mode 100644 index 000000000..e208e99f2 --- /dev/null +++ b/keyboards/keycapsss/plaid_pad/usbconfig.h | |||
@@ -0,0 +1,383 @@ | |||
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 | #pragma once | ||
12 | |||
13 | #include "config.h" | ||
14 | |||
15 | /* | ||
16 | General Description: | ||
17 | This file is an example configuration (with inline documentation) for the USB | ||
18 | driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is | ||
19 | also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may | ||
20 | wire the lines to any other port, as long as D+ is also wired to INT0 (or any | ||
21 | other hardware interrupt, as long as it is the highest level interrupt, see | ||
22 | section at the end of this file). | ||
23 | */ | ||
24 | |||
25 | /* ---------------------------- Hardware Config ---------------------------- */ | ||
26 | |||
27 | #define USB_CFG_IOPORTNAME D | ||
28 | /* This is the port where the USB bus is connected. When you configure it to | ||
29 | * "B", the registers PORTB, PINB and DDRB will be used. | ||
30 | */ | ||
31 | #define USB_CFG_DMINUS_BIT 3 | ||
32 | /* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. | ||
33 | * This may be any bit in the port. | ||
34 | */ | ||
35 | #define USB_CFG_DPLUS_BIT 2 | ||
36 | /* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. | ||
37 | * This may be any bit in the port. Please note that D+ must also be connected | ||
38 | * to interrupt pin INT0! [You can also use other interrupts, see section | ||
39 | * "Optional MCU Description" below, or you can connect D- to the interrupt, as | ||
40 | * it is required if you use the USB_COUNT_SOF feature. If you use D- for the | ||
41 | * interrupt, the USB interrupt will also be triggered at Start-Of-Frame | ||
42 | * markers every millisecond.] | ||
43 | */ | ||
44 | #define USB_CFG_CLOCK_KHZ (F_CPU/1000) | ||
45 | /* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000, | ||
46 | * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code | ||
47 | * require no crystal, they tolerate +/- 1% deviation from the nominal | ||
48 | * frequency. All other rates require a precision of 2000 ppm and thus a | ||
49 | * crystal! | ||
50 | * Since F_CPU should be defined to your actual clock rate anyway, you should | ||
51 | * not need to modify this setting. | ||
52 | */ | ||
53 | #define USB_CFG_CHECK_CRC 0 | ||
54 | /* Define this to 1 if you want that the driver checks integrity of incoming | ||
55 | * data packets (CRC checks). CRC checks cost quite a bit of code size and are | ||
56 | * currently only available for 18 MHz crystal clock. You must choose | ||
57 | * USB_CFG_CLOCK_KHZ = 18000 if you enable this option. | ||
58 | */ | ||
59 | |||
60 | /* ----------------------- Optional Hardware Config ------------------------ */ | ||
61 | |||
62 | /* #define USB_CFG_PULLUP_IOPORTNAME D */ | ||
63 | /* If you connect the 1.5k pullup resistor from D- to a port pin instead of | ||
64 | * V+, you can connect and disconnect the device from firmware by calling | ||
65 | * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h). | ||
66 | * This constant defines the port on which the pullup resistor is connected. | ||
67 | */ | ||
68 | /* #define USB_CFG_PULLUP_BIT 4 */ | ||
69 | /* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined | ||
70 | * above) where the 1.5k pullup resistor is connected. See description | ||
71 | * above for details. | ||
72 | */ | ||
73 | |||
74 | /* --------------------------- Functional Range ---------------------------- */ | ||
75 | |||
76 | #define USB_CFG_HAVE_INTRIN_ENDPOINT 1 | ||
77 | /* Define this to 1 if you want to compile a version with two endpoints: The | ||
78 | * default control endpoint 0 and an interrupt-in endpoint (any other endpoint | ||
79 | * number). | ||
80 | */ | ||
81 | #define USB_CFG_HAVE_INTRIN_ENDPOINT3 1 | ||
82 | /* Define this to 1 if you want to compile a version with three endpoints: The | ||
83 | * default control endpoint 0, an interrupt-in endpoint 3 (or the number | ||
84 | * configured below) and a catch-all default interrupt-in endpoint as above. | ||
85 | * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature. | ||
86 | */ | ||
87 | #define USB_CFG_EP3_NUMBER 3 | ||
88 | /* If the so-called endpoint 3 is used, it can now be configured to any other | ||
89 | * endpoint number (except 0) with this macro. Default if undefined is 3. | ||
90 | */ | ||
91 | /* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */ | ||
92 | /* The above macro defines the startup condition for data toggling on the | ||
93 | * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1. | ||
94 | * Since the token is toggled BEFORE sending any data, the first packet is | ||
95 | * sent with the oposite value of this configuration! | ||
96 | */ | ||
97 | #define USB_CFG_IMPLEMENT_HALT 0 | ||
98 | /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature | ||
99 | * for endpoint 1 (interrupt endpoint). Although you may not need this feature, | ||
100 | * it is required by the standard. We have made it a config option because it | ||
101 | * bloats the code considerably. | ||
102 | */ | ||
103 | #define USB_CFG_SUPPRESS_INTR_CODE 0 | ||
104 | /* Define this to 1 if you want to declare interrupt-in endpoints, but don't | ||
105 | * want to send any data over them. If this macro is defined to 1, functions | ||
106 | * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if | ||
107 | * you need the interrupt-in endpoints in order to comply to an interface | ||
108 | * (e.g. HID), but never want to send any data. This option saves a couple | ||
109 | * of bytes in flash memory and the transmit buffers in RAM. | ||
110 | */ | ||
111 | #define USB_CFG_IS_SELF_POWERED 0 | ||
112 | /* Define this to 1 if the device has its own power supply. Set it to 0 if the | ||
113 | * device is powered from the USB bus. | ||
114 | */ | ||
115 | #define USB_CFG_IMPLEMENT_FN_WRITE 1 | ||
116 | /* Set this to 1 if you want usbFunctionWrite() to be called for control-out | ||
117 | * transfers. Set it to 0 if you don't need it and want to save a couple of | ||
118 | * bytes. | ||
119 | */ | ||
120 | #define USB_CFG_IMPLEMENT_FN_READ 0 | ||
121 | /* Set this to 1 if you need to send control replies which are generated | ||
122 | * "on the fly" when usbFunctionRead() is called. If you only want to send | ||
123 | * data from a static buffer, set it to 0 and return the data from | ||
124 | * usbFunctionSetup(). This saves a couple of bytes. | ||
125 | */ | ||
126 | #define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 | ||
127 | /* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints. | ||
128 | * You must implement the function usbFunctionWriteOut() which receives all | ||
129 | * interrupt/bulk data sent to any endpoint other than 0. The endpoint number | ||
130 | * can be found in 'usbRxToken'. | ||
131 | */ | ||
132 | #define USB_CFG_HAVE_FLOWCONTROL 0 | ||
133 | /* Define this to 1 if you want flowcontrol over USB data. See the definition | ||
134 | * of the macros usbDisableAllRequests() and usbEnableAllRequests() in | ||
135 | * usbdrv.h. | ||
136 | */ | ||
137 | #define USB_CFG_DRIVER_FLASH_PAGE 0 | ||
138 | /* If the device has more than 64 kBytes of flash, define this to the 64 k page | ||
139 | * where the driver's constants (descriptors) are located. Or in other words: | ||
140 | * Define this to 1 for boot loaders on the ATMega128. | ||
141 | */ | ||
142 | #define USB_CFG_LONG_TRANSFERS 0 | ||
143 | /* Define this to 1 if you want to send/receive blocks of more than 254 bytes | ||
144 | * in a single control-in or control-out transfer. Note that the capability | ||
145 | * for long transfers increases the driver size. | ||
146 | */ | ||
147 | /* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */ | ||
148 | /* This macro is a hook if you want to do unconventional things. If it is | ||
149 | * defined, it's inserted at the beginning of received message processing. | ||
150 | * If you eat the received message and don't want default processing to | ||
151 | * proceed, do a return after doing your things. One possible application | ||
152 | * (besides debugging) is to flash a status LED on each packet. | ||
153 | */ | ||
154 | /* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */ | ||
155 | /* This macro is a hook if you need to know when an USB RESET occurs. It has | ||
156 | * one parameter which distinguishes between the start of RESET state and its | ||
157 | * end. | ||
158 | */ | ||
159 | /* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */ | ||
160 | /* This macro (if defined) is executed when a USB SET_ADDRESS request was | ||
161 | * received. | ||
162 | */ | ||
163 | #define USB_COUNT_SOF 0 | ||
164 | /* define this macro to 1 if you need the global variable "usbSofCount" which | ||
165 | * counts SOF packets. This feature requires that the hardware interrupt is | ||
166 | * connected to D- instead of D+. | ||
167 | */ | ||
168 | /* #ifdef __ASSEMBLER__ | ||
169 | * macro myAssemblerMacro | ||
170 | * in YL, TCNT0 | ||
171 | * sts timer0Snapshot, YL | ||
172 | * endm | ||
173 | * #endif | ||
174 | * #define USB_SOF_HOOK myAssemblerMacro | ||
175 | * This macro (if defined) is executed in the assembler module when a | ||
176 | * Start Of Frame condition is detected. It is recommended to define it to | ||
177 | * the name of an assembler macro which is defined here as well so that more | ||
178 | * than one assembler instruction can be used. The macro may use the register | ||
179 | * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages | ||
180 | * immediately after an SOF pulse may be lost and must be retried by the host. | ||
181 | * What can you do with this hook? Since the SOF signal occurs exactly every | ||
182 | * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in | ||
183 | * designs running on the internal RC oscillator. | ||
184 | * Please note that Start Of Frame detection works only if D- is wired to the | ||
185 | * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! | ||
186 | */ | ||
187 | #define USB_CFG_CHECK_DATA_TOGGLING 0 | ||
188 | /* define this macro to 1 if you want to filter out duplicate data packets | ||
189 | * sent by the host. Duplicates occur only as a consequence of communication | ||
190 | * errors, when the host does not receive an ACK. Please note that you need to | ||
191 | * implement the filtering yourself in usbFunctionWriteOut() and | ||
192 | * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable | ||
193 | * for each control- and out-endpoint to check for duplicate packets. | ||
194 | */ | ||
195 | #define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0 | ||
196 | /* define this macro to 1 if you want the function usbMeasureFrameLength() | ||
197 | * compiled in. This function can be used to calibrate the AVR's RC oscillator. | ||
198 | */ | ||
199 | #define USB_USE_FAST_CRC 0 | ||
200 | /* The assembler module has two implementations for the CRC algorithm. One is | ||
201 | * faster, the other is smaller. This CRC routine is only used for transmitted | ||
202 | * messages where timing is not critical. The faster routine needs 31 cycles | ||
203 | * per byte while the smaller one needs 61 to 69 cycles. The faster routine | ||
204 | * may be worth the 32 bytes bigger code size if you transmit lots of data and | ||
205 | * run the AVR close to its limit. | ||
206 | */ | ||
207 | |||
208 | /* -------------------------- Device Description --------------------------- */ | ||
209 | |||
210 | #define USB_CFG_VENDOR_ID (VENDOR_ID & 0xFF), ((VENDOR_ID >> 8) & 0xFF) | ||
211 | /* USB vendor ID for the device, low byte first. If you have registered your | ||
212 | * own Vendor ID, define it here. Otherwise you may use one of obdev's free | ||
213 | * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules! | ||
214 | * *** IMPORTANT NOTE *** | ||
215 | * This template uses obdev's shared VID/PID pair for Vendor Class devices | ||
216 | * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand | ||
217 | * the implications! | ||
218 | */ | ||
219 | #define USB_CFG_DEVICE_ID (PRODUCT_ID & 0xFF), ((PRODUCT_ID >> 8) & 0xFF) | ||
220 | /* This is the ID of the product, low byte first. It is interpreted in the | ||
221 | * scope of the vendor ID. If you have registered your own VID with usb.org | ||
222 | * or if you have licensed a PID from somebody else, define it here. Otherwise | ||
223 | * you may use one of obdev's free shared VID/PID pairs. See the file | ||
224 | * USB-IDs-for-free.txt for details! | ||
225 | * *** IMPORTANT NOTE *** | ||
226 | * This template uses obdev's shared VID/PID pair for Vendor Class devices | ||
227 | * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand | ||
228 | * the implications! | ||
229 | */ | ||
230 | #define USB_CFG_DEVICE_VERSION (DEVICE_VER & 0xFF), ((DEVICE_VER >> 8) & 0xFF) | ||
231 | /* Version number of the device: Minor number first, then major number. | ||
232 | */ | ||
233 | #define USB_CFG_VENDOR_NAME 'K','e','y','c','a','p','s','s','s' | ||
234 | #define USB_CFG_VENDOR_NAME_LEN 9 | ||
235 | /* These two values define the vendor name returned by the USB device. The name | ||
236 | * must be given as a list of characters under single quotes. The characters | ||
237 | * are interpreted as Unicode (UTF-16) entities. | ||
238 | * If you don't want a vendor name string, undefine these macros. | ||
239 | * ALWAYS define a vendor name containing your Internet domain name if you use | ||
240 | * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for | ||
241 | * details. | ||
242 | */ | ||
243 | #define USB_CFG_DEVICE_NAME 'P', 'l', 'a', 'i', 'd', '-', 'P', 'a', 'd' | ||
244 | #define USB_CFG_DEVICE_NAME_LEN 9 | ||
245 | /* Same as above for the device name. If you don't want a device name, undefine | ||
246 | * the macros. See the file USB-IDs-for-free.txt before you assign a name if | ||
247 | * you use a shared VID/PID. | ||
248 | */ | ||
249 | /*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */ | ||
250 | /*#define USB_CFG_SERIAL_NUMBER_LEN 0 */ | ||
251 | /* Same as above for the serial number. If you don't want a serial number, | ||
252 | * undefine the macros. | ||
253 | * It may be useful to provide the serial number through other means than at | ||
254 | * compile time. See the section about descriptor properties below for how | ||
255 | * to fine tune control over USB descriptors such as the string descriptor | ||
256 | * for the serial number. | ||
257 | */ | ||
258 | #define USB_CFG_DEVICE_CLASS 0 | ||
259 | #define USB_CFG_DEVICE_SUBCLASS 0 | ||
260 | /* See USB specification if you want to conform to an existing device class. | ||
261 | * Class 0xff is "vendor specific". | ||
262 | */ | ||
263 | #define USB_CFG_INTERFACE_CLASS 3 /* HID */ | ||
264 | #define USB_CFG_INTERFACE_SUBCLASS 1 /* Boot */ | ||
265 | #define USB_CFG_INTERFACE_PROTOCOL 1 /* Keyboard */ | ||
266 | /* See USB specification if you want to conform to an existing device class or | ||
267 | * protocol. The following classes must be set at interface level: | ||
268 | * HID class is 3, no subclass and protocol required (but may be useful!) | ||
269 | * CDC class is 2, use subclass 2 and protocol 1 for ACM | ||
270 | */ | ||
271 | #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 0 | ||
272 | /* Define this to the length of the HID report descriptor, if you implement | ||
273 | * an HID device. Otherwise don't define it or define it to 0. | ||
274 | * If you use this define, you must add a PROGMEM character array named | ||
275 | * "usbHidReportDescriptor" to your code which contains the report descriptor. | ||
276 | * Don't forget to keep the array and this define in sync! | ||
277 | */ | ||
278 | |||
279 | /* #define USB_PUBLIC static */ | ||
280 | /* Use the define above if you #include usbdrv.c instead of linking against it. | ||
281 | * This technique saves a couple of bytes in flash memory. | ||
282 | */ | ||
283 | |||
284 | /* ------------------- Fine Control over USB Descriptors ------------------- */ | ||
285 | /* If you don't want to use the driver's default USB descriptors, you can | ||
286 | * provide our own. These can be provided as (1) fixed length static data in | ||
287 | * flash memory, (2) fixed length static data in RAM or (3) dynamically at | ||
288 | * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more | ||
289 | * information about this function. | ||
290 | * Descriptor handling is configured through the descriptor's properties. If | ||
291 | * no properties are defined or if they are 0, the default descriptor is used. | ||
292 | * Possible properties are: | ||
293 | * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched | ||
294 | * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is | ||
295 | * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if | ||
296 | * you want RAM pointers. | ||
297 | * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found | ||
298 | * in static memory is in RAM, not in flash memory. | ||
299 | * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), | ||
300 | * the driver must know the descriptor's length. The descriptor itself is | ||
301 | * found at the address of a well known identifier (see below). | ||
302 | * List of static descriptor names (must be declared PROGMEM if in flash): | ||
303 | * char usbDescriptorDevice[]; | ||
304 | * char usbDescriptorConfiguration[]; | ||
305 | * char usbDescriptorHidReport[]; | ||
306 | * char usbDescriptorString0[]; | ||
307 | * int usbDescriptorStringVendor[]; | ||
308 | * int usbDescriptorStringDevice[]; | ||
309 | * int usbDescriptorStringSerialNumber[]; | ||
310 | * Other descriptors can't be provided statically, they must be provided | ||
311 | * dynamically at runtime. | ||
312 | * | ||
313 | * Descriptor properties are or-ed or added together, e.g.: | ||
314 | * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18)) | ||
315 | * | ||
316 | * The following descriptors are defined: | ||
317 | * USB_CFG_DESCR_PROPS_DEVICE | ||
318 | * USB_CFG_DESCR_PROPS_CONFIGURATION | ||
319 | * USB_CFG_DESCR_PROPS_STRINGS | ||
320 | * USB_CFG_DESCR_PROPS_STRING_0 | ||
321 | * USB_CFG_DESCR_PROPS_STRING_VENDOR | ||
322 | * USB_CFG_DESCR_PROPS_STRING_PRODUCT | ||
323 | * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER | ||
324 | * USB_CFG_DESCR_PROPS_HID | ||
325 | * USB_CFG_DESCR_PROPS_HID_REPORT | ||
326 | * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) | ||
327 | * | ||
328 | * Note about string descriptors: String descriptors are not just strings, they | ||
329 | * are Unicode strings prefixed with a 2 byte header. Example: | ||
330 | * int serialNumberDescriptor[] = { | ||
331 | * USB_STRING_DESCRIPTOR_HEADER(6), | ||
332 | * 'S', 'e', 'r', 'i', 'a', 'l' | ||
333 | * }; | ||
334 | */ | ||
335 | |||
336 | #define USB_CFG_DESCR_PROPS_DEVICE 0 | ||
337 | #define USB_CFG_DESCR_PROPS_CONFIGURATION USB_PROP_IS_DYNAMIC | ||
338 | //#define USB_CFG_DESCR_PROPS_CONFIGURATION 0 | ||
339 | #define USB_CFG_DESCR_PROPS_STRINGS 0 | ||
340 | #define USB_CFG_DESCR_PROPS_STRING_0 0 | ||
341 | #define USB_CFG_DESCR_PROPS_STRING_VENDOR 0 | ||
342 | #define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0 | ||
343 | #define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 | ||
344 | #define USB_CFG_DESCR_PROPS_HID USB_PROP_IS_DYNAMIC | ||
345 | //#define USB_CFG_DESCR_PROPS_HID 0 | ||
346 | #define USB_CFG_DESCR_PROPS_HID_REPORT USB_PROP_IS_DYNAMIC | ||
347 | //#define USB_CFG_DESCR_PROPS_HID_REPORT 0 | ||
348 | #define USB_CFG_DESCR_PROPS_UNKNOWN 0 | ||
349 | |||
350 | #define usbMsgPtr_t unsigned short | ||
351 | /* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to | ||
352 | * a scalar type here because gcc generates slightly shorter code for scalar | ||
353 | * arithmetics than for pointer arithmetics. Remove this define for backward | ||
354 | * type compatibility or define it to an 8 bit type if you use data in RAM only | ||
355 | * and all RAM is below 256 bytes (tiny memory model in IAR CC). | ||
356 | */ | ||
357 | |||
358 | /* ----------------------- Optional MCU Description ------------------------ */ | ||
359 | |||
360 | /* The following configurations have working defaults in usbdrv.h. You | ||
361 | * usually don't need to set them explicitly. Only if you want to run | ||
362 | * the driver on a device which is not yet supported or with a compiler | ||
363 | * which is not fully supported (such as IAR C) or if you use a differnt | ||
364 | * interrupt than INT0, you may have to define some of these. | ||
365 | */ | ||
366 | /* #define USB_INTR_CFG MCUCR */ | ||
367 | /* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */ | ||
368 | /* #define USB_INTR_CFG_CLR 0 */ | ||
369 | /* #define USB_INTR_ENABLE GIMSK */ | ||
370 | /* #define USB_INTR_ENABLE_BIT INT0 */ | ||
371 | /* #define USB_INTR_PENDING GIFR */ | ||
372 | /* #define USB_INTR_PENDING_BIT INTF0 */ | ||
373 | /* #define USB_INTR_VECTOR INT0_vect */ | ||
374 | |||
375 | /* Set INT1 for D- falling edge to count SOF */ | ||
376 | /* #define USB_INTR_CFG EICRA */ | ||
377 | // #define USB_INTR_CFG_SET ((1 << ISC11) | (0 << ISC10)) | ||
378 | // /* #define USB_INTR_CFG_CLR 0 */ | ||
379 | // /* #define USB_INTR_ENABLE EIMSK */ | ||
380 | // #define USB_INTR_ENABLE_BIT INT1 | ||
381 | // /* #define USB_INTR_PENDING EIFR */ | ||
382 | // #define USB_INTR_PENDING_BIT INTF1 | ||
383 | // #define USB_INTR_VECTOR INT1_vect | ||