[Keyboard] Add Plaid-Pad 4x4 numpad (#7900)
* Add Plaid-Pad code * Move ENCODER_ENABLE under Build Options * Update keyboards/keycapsss/plaid_pad/info.json * Update keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c * Update keyboards/keycapsss/plaid_pad/plaid_pad.h * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/readme.md * Update keyboards/keycapsss/plaid_pad/readme.md * Update keyboards/keycapsss/plaid_pad/readme.md * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/config.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/rules.mk * Update keyboards/keycapsss/plaid_pad/config.h * Update keyboards/keycapsss/plaid_pad/config.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/usbconfig.h * Update keyboards/keycapsss/plaid_pad/config.h
This commit is contained in:
		
							
								
								
									
										38
									
								
								keyboards/keycapsss/plaid_pad/config.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								keyboards/keycapsss/plaid_pad/config.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,38 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "config_common.h"
 | 
			
		||||
 | 
			
		||||
/* USB Device descriptor parameter */
 | 
			
		||||
#define VENDOR_ID 0xFEED
 | 
			
		||||
#define PRODUCT_ID 0xAF12
 | 
			
		||||
#define DEVICE_VER 0x0001
 | 
			
		||||
#define MANUFACTURER Keycapsss
 | 
			
		||||
#define PRODUCT Plaid-Pad
 | 
			
		||||
#define DESCRIPTION 4x4 numpad with through hole components
 | 
			
		||||
 | 
			
		||||
/* key matrix size */
 | 
			
		||||
#define MATRIX_ROWS 4
 | 
			
		||||
#define MATRIX_COLS 4
 | 
			
		||||
 | 
			
		||||
#define MATRIX_ROW_PINS { C0, C1, C2, C3 }
 | 
			
		||||
#define MATRIX_COL_PINS { B0, D7, D6, D5 }
 | 
			
		||||
#define UNUSED_PINS     { B3, B4, B5, D4}
 | 
			
		||||
 | 
			
		||||
#define ENCODERS_PAD_A { D0, B1 }
 | 
			
		||||
#define ENCODERS_PAD_B { D1, B2 }
 | 
			
		||||
#define ENCODER_RESOLUTION 4
 | 
			
		||||
 | 
			
		||||
/* COL2ROW, ROW2COL*/
 | 
			
		||||
#define DIODE_DIRECTION COL2ROW
 | 
			
		||||
 | 
			
		||||
#define NO_UART 1
 | 
			
		||||
#define USB_MAX_POWER_CONSUMPTION 100
 | 
			
		||||
 | 
			
		||||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 | 
			
		||||
#define DEBOUNCE 5
 | 
			
		||||
 | 
			
		||||
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
 | 
			
		||||
#define LOCKING_SUPPORT_ENABLE
 | 
			
		||||
 | 
			
		||||
/* Locking resynchronize hack */
 | 
			
		||||
#define LOCKING_RESYNC_ENABLE
 | 
			
		||||
							
								
								
									
										31
									
								
								keyboards/keycapsss/plaid_pad/info.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										31
									
								
								keyboards/keycapsss/plaid_pad/info.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,31 @@
 | 
			
		||||
{
 | 
			
		||||
    "keyboard_name": "Plaid-Pad",
 | 
			
		||||
    "keyboard_folder": "plaid_pad",
 | 
			
		||||
    "url": "https://keycapsss.com/diy-kits/104/plaid-pad-4x4-numpad",
 | 
			
		||||
    "maintainer": "BenRoe",
 | 
			
		||||
    "width": 4,
 | 
			
		||||
    "height": 4,
 | 
			
		||||
    "layouts": {
 | 
			
		||||
        "LAYOUT_ortho_4x4": {
 | 
			
		||||
            "key_count": 16,
 | 
			
		||||
            "layout": [
 | 
			
		||||
                {"w": 1,"x": 0,"y": 0},
 | 
			
		||||
                {"w": 1,"x": 1,"y": 0},
 | 
			
		||||
                {"w": 1,"x": 2,"y": 0},
 | 
			
		||||
                {"w": 1,"x": 3,"y": 0},
 | 
			
		||||
                {"w": 1,"x": 0,"y": 1},
 | 
			
		||||
                {"w": 1,"x": 1,"y": 1},
 | 
			
		||||
                {"w": 1,"x": 2,"y": 1},
 | 
			
		||||
                {"w": 1,"x": 3,"y": 1},
 | 
			
		||||
                {"w": 1,"x": 0,"y": 2},
 | 
			
		||||
                {"w": 1,"x": 1,"y": 2},
 | 
			
		||||
                {"w": 1,"x": 2,"y": 2},
 | 
			
		||||
                {"w": 1,"x": 3,"y": 2},
 | 
			
		||||
                {"w": 1,"x": 0,"y": 3},
 | 
			
		||||
                {"w": 1,"x": 1,"y": 3},
 | 
			
		||||
                {"w": 1,"x": 2,"y": 3},
 | 
			
		||||
                {"w": 1,"x": 3,"y": 3}
 | 
			
		||||
            ]
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										3
									
								
								keyboards/keycapsss/plaid_pad/keymaps/default/config.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								keyboards/keycapsss/plaid_pad/keymaps/default/config.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
// place overrides here
 | 
			
		||||
							
								
								
									
										44
									
								
								keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								keyboards/keycapsss/plaid_pad/keymaps/default/keymap.c
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,44 @@
 | 
			
		||||
#include QMK_KEYBOARD_H
 | 
			
		||||
 | 
			
		||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * ,-----------------------,
 | 
			
		||||
 * |  7  |  8  |  9  |  /  |
 | 
			
		||||
 * |-----+-----+-----+-----|
 | 
			
		||||
 * |  4  |  5  |  6  |  *  |
 | 
			
		||||
 * |-----+-----+-----+-----|
 | 
			
		||||
 * |  1  |  2  |  3  |  -  |
 | 
			
		||||
 * |-----+-----+-----+-----|
 | 
			
		||||
 * |  0  |  .  |  =  |  +  |
 | 
			
		||||
 * `-----------------------'
 | 
			
		||||
 */
 | 
			
		||||
LAYOUT_ortho_4x4(
 | 
			
		||||
		KC_P7, KC_P8,   KC_P9,      KC_PSLS,
 | 
			
		||||
		KC_P4, KC_P5,   KC_P6,      KC_PAST,
 | 
			
		||||
		KC_P1, KC_P2,   KC_P3,      KC_PMNS,
 | 
			
		||||
		KC_P0, KC_PDOT, KC_PEQL,    KC_PPLS
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Set led state during powerup
 | 
			
		||||
void keyboard_post_init_user(void) {
 | 
			
		||||
    writePinHigh(LED_RED);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void encoder_update_user(uint8_t index, bool clockwise) {
 | 
			
		||||
  if (index == 0) {         // First encoder - top left
 | 
			
		||||
    if (clockwise) {
 | 
			
		||||
      tap_code(KC_UP);
 | 
			
		||||
    } else {
 | 
			
		||||
      tap_code(KC_DOWN);
 | 
			
		||||
    }
 | 
			
		||||
  } else if (index == 1) {  // Second encoder - top right
 | 
			
		||||
    if (clockwise) {
 | 
			
		||||
      tap_code(KC_UP);
 | 
			
		||||
    } else {
 | 
			
		||||
      tap_code(KC_DOWN);
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										11
									
								
								keyboards/keycapsss/plaid_pad/keymaps/default/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								keyboards/keycapsss/plaid_pad/keymaps/default/readme.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,11 @@
 | 
			
		||||
 | 
			
		||||
<img src="https://i.imgur.com/V82cMqq.png" width="200">
 | 
			
		||||
 | 
			
		||||
# Default Plaid-Pad Layout
 | 
			
		||||
 | 
			
		||||
This is the default layout that comes flashed on every Plaid-Pad.  
 | 
			
		||||
The upper left (7) and right (/) switch, can be replaced by a rotary encoder.
 | 
			
		||||
They do "Up Arrow" (KC_UP) and "Down Arrow" (KC_DOWN).  
 | 
			
		||||
Encoder with build-in switch are supported.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										1
									
								
								keyboards/keycapsss/plaid_pad/plaid_pad.c
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								keyboards/keycapsss/plaid_pad/plaid_pad.c
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1 @@
 | 
			
		||||
#include "plaid_pad.h"
 | 
			
		||||
							
								
								
									
										18
									
								
								keyboards/keycapsss/plaid_pad/plaid_pad.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								keyboards/keycapsss/plaid_pad/plaid_pad.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,18 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "quantum.h"
 | 
			
		||||
 | 
			
		||||
#define LAYOUT_ortho_4x4( \
 | 
			
		||||
    K00, K01, K02, K03, \
 | 
			
		||||
    K10, K11, K12, K13, \
 | 
			
		||||
    K20, K21, K22, K23, \
 | 
			
		||||
    K30, K31, K32, K33  \
 | 
			
		||||
) { \
 | 
			
		||||
    { K00,   K01,   K02,   K03 }, \
 | 
			
		||||
    { K10,   K11,   K12,   K13 }, \
 | 
			
		||||
    { K20,   K21,   K22,   K23 }, \
 | 
			
		||||
    { K30,   K31,   K32,   K33 }  \
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#define LED_RED C5      // LED1
 | 
			
		||||
#define LED_GREEN C4    // LED2
 | 
			
		||||
							
								
								
									
										25
									
								
								keyboards/keycapsss/plaid_pad/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										25
									
								
								keyboards/keycapsss/plaid_pad/readme.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,25 @@
 | 
			
		||||
# Plaid-Pad
 | 
			
		||||
<img src="https://i.imgur.com/Jovhxpr.jpg" width="400">
 | 
			
		||||
<img src="https://i.imgur.com/V82cMqq.png" width="400">
 | 
			
		||||
 | 
			
		||||
A 4x4 numpad with only through hole components.  
 | 
			
		||||
It's a great companion to the Plaid keyboard by [hsgw](https://github.com/hsgw/) and heavily inspired by it.
 | 
			
		||||
 | 
			
		||||
* Keyboard Maintainer: BenRoe [Github](https://github.com/BenRoe) / [Twitter](https://twitter.com/keycapsss)
 | 
			
		||||
* Hardware Supported: ATmega328P with VUSB ([see Bootloader section](#Bootloader))
 | 
			
		||||
* Hardware Availability: [Keycapsss.com](https://keycapsss.com)
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make keycapsss/plaid_pad:default
 | 
			
		||||
 | 
			
		||||
Flashing example for this keyboard:
 | 
			
		||||
 | 
			
		||||
    make keycapsss/plaid_pad:default:flash
 | 
			
		||||
 | 
			
		||||
## Bootloader
 | 
			
		||||
- same usbasploader as Plaid ([Instruction](https://github.com/hsgw/plaid/blob/master/doc/en/bootloader.md), [Repository](https://github.com/hsgw/USBaspLoader/tree/plaid))
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
 | 
			
		||||
							
								
								
									
										41
									
								
								keyboards/keycapsss/plaid_pad/rules.mk
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								keyboards/keycapsss/plaid_pad/rules.mk
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,41 @@
 | 
			
		||||
# MCU name
 | 
			
		||||
MCU = atmega328p
 | 
			
		||||
 | 
			
		||||
# Bootloader selection
 | 
			
		||||
#   Teensy       halfkay
 | 
			
		||||
#   Pro Micro    caterina
 | 
			
		||||
#   Atmel DFU    atmel-dfu
 | 
			
		||||
#   LUFA DFU     lufa-dfu
 | 
			
		||||
#   QMK DFU      qmk-dfu
 | 
			
		||||
#   ATmega32A    bootloadHID
 | 
			
		||||
#   ATmega328P   USBasp
 | 
			
		||||
BOOTLOADER = USBasp
 | 
			
		||||
 | 
			
		||||
# disable debug code
 | 
			
		||||
OPT_DEFS = -DDEBUG_LEVEL=0
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# Build Options
 | 
			
		||||
#   change yes to no to disable
 | 
			
		||||
#
 | 
			
		||||
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
 | 
			
		||||
MOUSEKEY_ENABLE = yes       # Mouse keys
 | 
			
		||||
EXTRAKEY_ENABLE = yes       # Audio control and System control
 | 
			
		||||
CONSOLE_ENABLE = no         # Console for debug
 | 
			
		||||
COMMAND_ENABLE = no         # Commands for debug and configuration
 | 
			
		||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 | 
			
		||||
SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
 | 
			
		||||
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 | 
			
		||||
NKRO_ENABLE = no            # USB Nkey Rollover
 | 
			
		||||
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality on B7 by default
 | 
			
		||||
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
 | 
			
		||||
MIDI_ENABLE = no            # MIDI support
 | 
			
		||||
UNICODE_ENABLE = no         # Unicode
 | 
			
		||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
			
		||||
AUDIO_ENABLE = no           # Audio output on port C6
 | 
			
		||||
FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
 | 
			
		||||
HD44780_ENABLE = no         # Enable support for HD44780 based LCDs
 | 
			
		||||
ENCODER_ENABLE = yes
 | 
			
		||||
 | 
			
		||||
LAYOUTS = ortho_4x4
 | 
			
		||||
LAYOUTS_HAS_RGB = no
 | 
			
		||||
							
								
								
									
										383
									
								
								keyboards/keycapsss/plaid_pad/usbconfig.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										383
									
								
								keyboards/keycapsss/plaid_pad/usbconfig.h
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,383 @@
 | 
			
		||||
/* Name: usbconfig.h
 | 
			
		||||
 * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers
 | 
			
		||||
 * Author: Christian Starkjohann
 | 
			
		||||
 * Creation Date: 2005-04-01
 | 
			
		||||
 * Tabsize: 4
 | 
			
		||||
 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH
 | 
			
		||||
 * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt)
 | 
			
		||||
 * This Revision: $Id: usbconfig-prototype.h 785 2010-05-30 17:57:07Z cs $
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "config.h"
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
General Description:
 | 
			
		||||
This file is an example configuration (with inline documentation) for the USB
 | 
			
		||||
driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is
 | 
			
		||||
also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may
 | 
			
		||||
wire the lines to any other port, as long as D+ is also wired to INT0 (or any
 | 
			
		||||
other hardware interrupt, as long as it is the highest level interrupt, see
 | 
			
		||||
section at the end of this file).
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
/* ---------------------------- Hardware Config ---------------------------- */
 | 
			
		||||
 | 
			
		||||
#define USB_CFG_IOPORTNAME      D
 | 
			
		||||
/* This is the port where the USB bus is connected. When you configure it to
 | 
			
		||||
 * "B", the registers PORTB, PINB and DDRB will be used.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DMINUS_BIT      3
 | 
			
		||||
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
 | 
			
		||||
 * This may be any bit in the port.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DPLUS_BIT       2
 | 
			
		||||
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
 | 
			
		||||
 * This may be any bit in the port. Please note that D+ must also be connected
 | 
			
		||||
 * to interrupt pin INT0! [You can also use other interrupts, see section
 | 
			
		||||
 * "Optional MCU Description" below, or you can connect D- to the interrupt, as
 | 
			
		||||
 * it is required if you use the USB_COUNT_SOF feature. If you use D- for the
 | 
			
		||||
 * interrupt, the USB interrupt will also be triggered at Start-Of-Frame
 | 
			
		||||
 * markers every millisecond.]
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_CLOCK_KHZ       (F_CPU/1000)
 | 
			
		||||
/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000,
 | 
			
		||||
 * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code
 | 
			
		||||
 * require no crystal, they tolerate +/- 1% deviation from the nominal
 | 
			
		||||
 * frequency. All other rates require a precision of 2000 ppm and thus a
 | 
			
		||||
 * crystal!
 | 
			
		||||
 * Since F_CPU should be defined to your actual clock rate anyway, you should
 | 
			
		||||
 * not need to modify this setting.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_CHECK_CRC       0
 | 
			
		||||
/* Define this to 1 if you want that the driver checks integrity of incoming
 | 
			
		||||
 * data packets (CRC checks). CRC checks cost quite a bit of code size and are
 | 
			
		||||
 * currently only available for 18 MHz crystal clock. You must choose
 | 
			
		||||
 * USB_CFG_CLOCK_KHZ = 18000 if you enable this option.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* ----------------------- Optional Hardware Config ------------------------ */
 | 
			
		||||
 | 
			
		||||
/* #define USB_CFG_PULLUP_IOPORTNAME   D */
 | 
			
		||||
/* If you connect the 1.5k pullup resistor from D- to a port pin instead of
 | 
			
		||||
 * V+, you can connect and disconnect the device from firmware by calling
 | 
			
		||||
 * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
 | 
			
		||||
 * This constant defines the port on which the pullup resistor is connected.
 | 
			
		||||
 */
 | 
			
		||||
/* #define USB_CFG_PULLUP_BIT          4 */
 | 
			
		||||
/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
 | 
			
		||||
 * above) where the 1.5k pullup resistor is connected. See description
 | 
			
		||||
 * above for details.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* --------------------------- Functional Range ---------------------------- */
 | 
			
		||||
 | 
			
		||||
#define USB_CFG_HAVE_INTRIN_ENDPOINT    1
 | 
			
		||||
/* Define this to 1 if you want to compile a version with two endpoints: The
 | 
			
		||||
 * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
 | 
			
		||||
 * number).
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_HAVE_INTRIN_ENDPOINT3   1
 | 
			
		||||
/* Define this to 1 if you want to compile a version with three endpoints: The
 | 
			
		||||
 * default control endpoint 0, an interrupt-in endpoint 3 (or the number
 | 
			
		||||
 * configured below) and a catch-all default interrupt-in endpoint as above.
 | 
			
		||||
 * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_EP3_NUMBER              3
 | 
			
		||||
/* If the so-called endpoint 3 is used, it can now be configured to any other
 | 
			
		||||
 * endpoint number (except 0) with this macro. Default if undefined is 3.
 | 
			
		||||
 */
 | 
			
		||||
/* #define USB_INITIAL_DATATOKEN           USBPID_DATA1 */
 | 
			
		||||
/* The above macro defines the startup condition for data toggling on the
 | 
			
		||||
 * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
 | 
			
		||||
 * Since the token is toggled BEFORE sending any data, the first packet is
 | 
			
		||||
 * sent with the oposite value of this configuration!
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_IMPLEMENT_HALT          0
 | 
			
		||||
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
 | 
			
		||||
 * for endpoint 1 (interrupt endpoint). Although you may not need this feature,
 | 
			
		||||
 * it is required by the standard. We have made it a config option because it
 | 
			
		||||
 * bloats the code considerably.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_SUPPRESS_INTR_CODE      0
 | 
			
		||||
/* Define this to 1 if you want to declare interrupt-in endpoints, but don't
 | 
			
		||||
 * want to send any data over them. If this macro is defined to 1, functions
 | 
			
		||||
 * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
 | 
			
		||||
 * you need the interrupt-in endpoints in order to comply to an interface
 | 
			
		||||
 * (e.g. HID), but never want to send any data. This option saves a couple
 | 
			
		||||
 * of bytes in flash memory and the transmit buffers in RAM.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_IS_SELF_POWERED         0
 | 
			
		||||
/* Define this to 1 if the device has its own power supply. Set it to 0 if the
 | 
			
		||||
 * device is powered from the USB bus.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_IMPLEMENT_FN_WRITE      1
 | 
			
		||||
/* Set this to 1 if you want usbFunctionWrite() to be called for control-out
 | 
			
		||||
 * transfers. Set it to 0 if you don't need it and want to save a couple of
 | 
			
		||||
 * bytes.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_IMPLEMENT_FN_READ       0
 | 
			
		||||
/* Set this to 1 if you need to send control replies which are generated
 | 
			
		||||
 * "on the fly" when usbFunctionRead() is called. If you only want to send
 | 
			
		||||
 * data from a static buffer, set it to 0 and return the data from
 | 
			
		||||
 * usbFunctionSetup(). This saves a couple of bytes.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_IMPLEMENT_FN_WRITEOUT   0
 | 
			
		||||
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
 | 
			
		||||
 * You must implement the function usbFunctionWriteOut() which receives all
 | 
			
		||||
 * interrupt/bulk data sent to any endpoint other than 0. The endpoint number
 | 
			
		||||
 * can be found in 'usbRxToken'.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_HAVE_FLOWCONTROL        0
 | 
			
		||||
/* Define this to 1 if you want flowcontrol over USB data. See the definition
 | 
			
		||||
 * of the macros usbDisableAllRequests() and usbEnableAllRequests() in
 | 
			
		||||
 * usbdrv.h.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DRIVER_FLASH_PAGE       0
 | 
			
		||||
/* If the device has more than 64 kBytes of flash, define this to the 64 k page
 | 
			
		||||
 * where the driver's constants (descriptors) are located. Or in other words:
 | 
			
		||||
 * Define this to 1 for boot loaders on the ATMega128.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_LONG_TRANSFERS          0
 | 
			
		||||
/* Define this to 1 if you want to send/receive blocks of more than 254 bytes
 | 
			
		||||
 * in a single control-in or control-out transfer. Note that the capability
 | 
			
		||||
 * for long transfers increases the driver size.
 | 
			
		||||
 */
 | 
			
		||||
/* #define USB_RX_USER_HOOK(data, len)     if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
 | 
			
		||||
/* This macro is a hook if you want to do unconventional things. If it is
 | 
			
		||||
 * defined, it's inserted at the beginning of received message processing.
 | 
			
		||||
 * If you eat the received message and don't want default processing to
 | 
			
		||||
 * proceed, do a return after doing your things. One possible application
 | 
			
		||||
 * (besides debugging) is to flash a status LED on each packet.
 | 
			
		||||
 */
 | 
			
		||||
/* #define USB_RESET_HOOK(resetStarts)     if(!resetStarts){hadUsbReset();} */
 | 
			
		||||
/* This macro is a hook if you need to know when an USB RESET occurs. It has
 | 
			
		||||
 * one parameter which distinguishes between the start of RESET state and its
 | 
			
		||||
 * end.
 | 
			
		||||
 */
 | 
			
		||||
/* #define USB_SET_ADDRESS_HOOK()              hadAddressAssigned(); */
 | 
			
		||||
/* This macro (if defined) is executed when a USB SET_ADDRESS request was
 | 
			
		||||
 * received.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_COUNT_SOF                   0
 | 
			
		||||
/* define this macro to 1 if you need the global variable "usbSofCount" which
 | 
			
		||||
 * counts SOF packets. This feature requires that the hardware interrupt is
 | 
			
		||||
 * connected to D- instead of D+.
 | 
			
		||||
 */
 | 
			
		||||
/* #ifdef __ASSEMBLER__
 | 
			
		||||
 * macro myAssemblerMacro
 | 
			
		||||
 *     in      YL, TCNT0
 | 
			
		||||
 *     sts     timer0Snapshot, YL
 | 
			
		||||
 *     endm
 | 
			
		||||
 * #endif
 | 
			
		||||
 * #define USB_SOF_HOOK                    myAssemblerMacro
 | 
			
		||||
 * This macro (if defined) is executed in the assembler module when a
 | 
			
		||||
 * Start Of Frame condition is detected. It is recommended to define it to
 | 
			
		||||
 * the name of an assembler macro which is defined here as well so that more
 | 
			
		||||
 * than one assembler instruction can be used. The macro may use the register
 | 
			
		||||
 * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
 | 
			
		||||
 * immediately after an SOF pulse may be lost and must be retried by the host.
 | 
			
		||||
 * What can you do with this hook? Since the SOF signal occurs exactly every
 | 
			
		||||
 * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
 | 
			
		||||
 * designs running on the internal RC oscillator.
 | 
			
		||||
 * Please note that Start Of Frame detection works only if D- is wired to the
 | 
			
		||||
 * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_CHECK_DATA_TOGGLING     0
 | 
			
		||||
/* define this macro to 1 if you want to filter out duplicate data packets
 | 
			
		||||
 * sent by the host. Duplicates occur only as a consequence of communication
 | 
			
		||||
 * errors, when the host does not receive an ACK. Please note that you need to
 | 
			
		||||
 * implement the filtering yourself in usbFunctionWriteOut() and
 | 
			
		||||
 * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
 | 
			
		||||
 * for each control- and out-endpoint to check for duplicate packets.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH   0
 | 
			
		||||
/* define this macro to 1 if you want the function usbMeasureFrameLength()
 | 
			
		||||
 * compiled in. This function can be used to calibrate the AVR's RC oscillator.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_USE_FAST_CRC                0
 | 
			
		||||
/* The assembler module has two implementations for the CRC algorithm. One is
 | 
			
		||||
 * faster, the other is smaller. This CRC routine is only used for transmitted
 | 
			
		||||
 * messages where timing is not critical. The faster routine needs 31 cycles
 | 
			
		||||
 * per byte while the smaller one needs 61 to 69 cycles. The faster routine
 | 
			
		||||
 * may be worth the 32 bytes bigger code size if you transmit lots of data and
 | 
			
		||||
 * run the AVR close to its limit.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* -------------------------- Device Description --------------------------- */
 | 
			
		||||
 | 
			
		||||
#define USB_CFG_VENDOR_ID       (VENDOR_ID & 0xFF), ((VENDOR_ID >> 8) & 0xFF)
 | 
			
		||||
/* USB vendor ID for the device, low byte first. If you have registered your
 | 
			
		||||
 * own Vendor ID, define it here. Otherwise you may use one of obdev's free
 | 
			
		||||
 * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules!
 | 
			
		||||
 * *** IMPORTANT NOTE ***
 | 
			
		||||
 * This template uses obdev's shared VID/PID pair for Vendor Class devices
 | 
			
		||||
 * with libusb: 0x16c0/0x5dc.  Use this VID/PID pair ONLY if you understand
 | 
			
		||||
 * the implications!
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DEVICE_ID       (PRODUCT_ID & 0xFF), ((PRODUCT_ID >> 8) & 0xFF)
 | 
			
		||||
/* This is the ID of the product, low byte first. It is interpreted in the
 | 
			
		||||
 * scope of the vendor ID. If you have registered your own VID with usb.org
 | 
			
		||||
 * or if you have licensed a PID from somebody else, define it here. Otherwise
 | 
			
		||||
 * you may use one of obdev's free shared VID/PID pairs. See the file
 | 
			
		||||
 * USB-IDs-for-free.txt for details!
 | 
			
		||||
 * *** IMPORTANT NOTE ***
 | 
			
		||||
 * This template uses obdev's shared VID/PID pair for Vendor Class devices
 | 
			
		||||
 * with libusb: 0x16c0/0x5dc.  Use this VID/PID pair ONLY if you understand
 | 
			
		||||
 * the implications!
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DEVICE_VERSION  (DEVICE_VER & 0xFF), ((DEVICE_VER >> 8) & 0xFF)
 | 
			
		||||
/* Version number of the device: Minor number first, then major number.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_VENDOR_NAME     'K','e','y','c','a','p','s','s','s'
 | 
			
		||||
#define USB_CFG_VENDOR_NAME_LEN 9
 | 
			
		||||
/* These two values define the vendor name returned by the USB device. The name
 | 
			
		||||
 * must be given as a list of characters under single quotes. The characters
 | 
			
		||||
 * are interpreted as Unicode (UTF-16) entities.
 | 
			
		||||
 * If you don't want a vendor name string, undefine these macros.
 | 
			
		||||
 * ALWAYS define a vendor name containing your Internet domain name if you use
 | 
			
		||||
 * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for
 | 
			
		||||
 * details.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DEVICE_NAME     'P', 'l', 'a', 'i', 'd', '-', 'P', 'a', 'd'
 | 
			
		||||
#define USB_CFG_DEVICE_NAME_LEN 9
 | 
			
		||||
/* Same as above for the device name. If you don't want a device name, undefine
 | 
			
		||||
 * the macros. See the file USB-IDs-for-free.txt before you assign a name if
 | 
			
		||||
 * you use a shared VID/PID.
 | 
			
		||||
 */
 | 
			
		||||
/*#define USB_CFG_SERIAL_NUMBER   'N', 'o', 'n', 'e' */
 | 
			
		||||
/*#define USB_CFG_SERIAL_NUMBER_LEN   0 */
 | 
			
		||||
/* Same as above for the serial number. If you don't want a serial number,
 | 
			
		||||
 * undefine the macros.
 | 
			
		||||
 * It may be useful to provide the serial number through other means than at
 | 
			
		||||
 * compile time. See the section about descriptor properties below for how
 | 
			
		||||
 * to fine tune control over USB descriptors such as the string descriptor
 | 
			
		||||
 * for the serial number.
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_DEVICE_CLASS        0
 | 
			
		||||
#define USB_CFG_DEVICE_SUBCLASS     0
 | 
			
		||||
/* See USB specification if you want to conform to an existing device class.
 | 
			
		||||
 * Class 0xff is "vendor specific".
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_INTERFACE_CLASS     3   /* HID */
 | 
			
		||||
#define USB_CFG_INTERFACE_SUBCLASS  1   /* Boot */
 | 
			
		||||
#define USB_CFG_INTERFACE_PROTOCOL  1   /* Keyboard */
 | 
			
		||||
/* See USB specification if you want to conform to an existing device class or
 | 
			
		||||
 * protocol. The following classes must be set at interface level:
 | 
			
		||||
 * HID class is 3, no subclass and protocol required (but may be useful!)
 | 
			
		||||
 * CDC class is 2, use subclass 2 and protocol 1 for ACM
 | 
			
		||||
 */
 | 
			
		||||
#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH    0
 | 
			
		||||
/* Define this to the length of the HID report descriptor, if you implement
 | 
			
		||||
 * an HID device. Otherwise don't define it or define it to 0.
 | 
			
		||||
 * If you use this define, you must add a PROGMEM character array named
 | 
			
		||||
 * "usbHidReportDescriptor" to your code which contains the report descriptor.
 | 
			
		||||
 * Don't forget to keep the array and this define in sync!
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* #define USB_PUBLIC static */
 | 
			
		||||
/* Use the define above if you #include usbdrv.c instead of linking against it.
 | 
			
		||||
 * This technique saves a couple of bytes in flash memory.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* ------------------- Fine Control over USB Descriptors ------------------- */
 | 
			
		||||
/* If you don't want to use the driver's default USB descriptors, you can
 | 
			
		||||
 * provide our own. These can be provided as (1) fixed length static data in
 | 
			
		||||
 * flash memory, (2) fixed length static data in RAM or (3) dynamically at
 | 
			
		||||
 * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
 | 
			
		||||
 * information about this function.
 | 
			
		||||
 * Descriptor handling is configured through the descriptor's properties. If
 | 
			
		||||
 * no properties are defined or if they are 0, the default descriptor is used.
 | 
			
		||||
 * Possible properties are:
 | 
			
		||||
 *   + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
 | 
			
		||||
 *     at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is
 | 
			
		||||
 *     used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
 | 
			
		||||
 *     you want RAM pointers.
 | 
			
		||||
 *   + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
 | 
			
		||||
 *     in static memory is in RAM, not in flash memory.
 | 
			
		||||
 *   + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
 | 
			
		||||
 *     the driver must know the descriptor's length. The descriptor itself is
 | 
			
		||||
 *     found at the address of a well known identifier (see below).
 | 
			
		||||
 * List of static descriptor names (must be declared PROGMEM if in flash):
 | 
			
		||||
 *   char usbDescriptorDevice[];
 | 
			
		||||
 *   char usbDescriptorConfiguration[];
 | 
			
		||||
 *   char usbDescriptorHidReport[];
 | 
			
		||||
 *   char usbDescriptorString0[];
 | 
			
		||||
 *   int usbDescriptorStringVendor[];
 | 
			
		||||
 *   int usbDescriptorStringDevice[];
 | 
			
		||||
 *   int usbDescriptorStringSerialNumber[];
 | 
			
		||||
 * Other descriptors can't be provided statically, they must be provided
 | 
			
		||||
 * dynamically at runtime.
 | 
			
		||||
 *
 | 
			
		||||
 * Descriptor properties are or-ed or added together, e.g.:
 | 
			
		||||
 * #define USB_CFG_DESCR_PROPS_DEVICE   (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
 | 
			
		||||
 *
 | 
			
		||||
 * The following descriptors are defined:
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_DEVICE
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_CONFIGURATION
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_STRINGS
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_STRING_0
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_STRING_VENDOR
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_STRING_PRODUCT
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_HID
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_HID_REPORT
 | 
			
		||||
 *   USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
 | 
			
		||||
 *
 | 
			
		||||
 * Note about string descriptors: String descriptors are not just strings, they
 | 
			
		||||
 * are Unicode strings prefixed with a 2 byte header. Example:
 | 
			
		||||
 * int  serialNumberDescriptor[] = {
 | 
			
		||||
 *     USB_STRING_DESCRIPTOR_HEADER(6),
 | 
			
		||||
 *     'S', 'e', 'r', 'i', 'a', 'l'
 | 
			
		||||
 * };
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_DEVICE                  0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_CONFIGURATION           USB_PROP_IS_DYNAMIC
 | 
			
		||||
//#define USB_CFG_DESCR_PROPS_CONFIGURATION           0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_STRINGS                 0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_STRING_0                0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_STRING_VENDOR           0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_STRING_PRODUCT          0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER    0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_HID                     USB_PROP_IS_DYNAMIC
 | 
			
		||||
//#define USB_CFG_DESCR_PROPS_HID                     0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_HID_REPORT              USB_PROP_IS_DYNAMIC
 | 
			
		||||
//#define USB_CFG_DESCR_PROPS_HID_REPORT              0
 | 
			
		||||
#define USB_CFG_DESCR_PROPS_UNKNOWN                 0
 | 
			
		||||
 | 
			
		||||
#define usbMsgPtr_t unsigned short
 | 
			
		||||
/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to
 | 
			
		||||
 * a scalar type here because gcc generates slightly shorter code for scalar
 | 
			
		||||
 * arithmetics than for pointer arithmetics. Remove this define for backward
 | 
			
		||||
 * type compatibility or define it to an 8 bit type if you use data in RAM only
 | 
			
		||||
 * and all RAM is below 256 bytes (tiny memory model in IAR CC).
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* ----------------------- Optional MCU Description ------------------------ */
 | 
			
		||||
 | 
			
		||||
/* The following configurations have working defaults in usbdrv.h. You
 | 
			
		||||
 * usually don't need to set them explicitly. Only if you want to run
 | 
			
		||||
 * the driver on a device which is not yet supported or with a compiler
 | 
			
		||||
 * which is not fully supported (such as IAR C) or if you use a differnt
 | 
			
		||||
 * interrupt than INT0, you may have to define some of these.
 | 
			
		||||
 */
 | 
			
		||||
/* #define USB_INTR_CFG            MCUCR */
 | 
			
		||||
/* #define USB_INTR_CFG_SET        ((1 << ISC00) | (1 << ISC01)) */
 | 
			
		||||
/* #define USB_INTR_CFG_CLR        0 */
 | 
			
		||||
/* #define USB_INTR_ENABLE         GIMSK */
 | 
			
		||||
/* #define USB_INTR_ENABLE_BIT     INT0 */
 | 
			
		||||
/* #define USB_INTR_PENDING        GIFR */
 | 
			
		||||
/* #define USB_INTR_PENDING_BIT    INTF0 */
 | 
			
		||||
/* #define USB_INTR_VECTOR         INT0_vect */
 | 
			
		||||
 | 
			
		||||
/* Set INT1 for D- falling edge to count SOF */
 | 
			
		||||
/* #define USB_INTR_CFG            EICRA */
 | 
			
		||||
// #define USB_INTR_CFG_SET        ((1 << ISC11) | (0 << ISC10))
 | 
			
		||||
// /* #define USB_INTR_CFG_CLR        0 */
 | 
			
		||||
// /* #define USB_INTR_ENABLE         EIMSK */
 | 
			
		||||
// #define USB_INTR_ENABLE_BIT     INT1
 | 
			
		||||
// /* #define USB_INTR_PENDING        EIFR */
 | 
			
		||||
// #define USB_INTR_PENDING_BIT    INTF1
 | 
			
		||||
// #define USB_INTR_VECTOR         INT1_vect
 | 
			
		||||
		Reference in New Issue
	
	Block a user