[Keyboard] Adds Gray Studio HB85 Initial Support (#5311)
* Gray Studio HB85 Initial Support * Fixed README image * Updated README * Disabled Bootmagic and Console for HB85 * Fixed Numpad 4 matrix place * Fixes board crashing with RGB enabled * Moved HB85 files to gray_studio folder * Uses old i2c library since this version makes RGB underglow work * Improved default keymap with underglow control layer * Removes obsolete program and uses generic script instead As per zvecr feedback * Uses GPIO Functions to initialise and set RGB underglow PINSrgb7seg
parent
33e9f1c75a
commit
ba11a1c807
@ -0,0 +1,39 @@ |
||||
/*
|
||||
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#pragma once |
||||
|
||||
#define VENDOR_ID 0x20A0 |
||||
#define PRODUCT_ID 0x422F |
||||
// TODO: share these strings with usbconfig.h
|
||||
// Edit usbconfig.h to change these.
|
||||
#define MANUFACTURER Gray Studio |
||||
#define PRODUCT HB85 |
||||
|
||||
/* matrix size */ |
||||
#define MATRIX_ROWS 8 |
||||
#define MATRIX_COLS 15 |
||||
|
||||
#define MATRIX_ROW_PINS { B0, B1, B2, B3, B4, B5, B6, B7 } |
||||
#define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5, C4, C3, C2, D7 } |
||||
#define DIODE_DIRECTION COL2ROW |
||||
|
||||
#define RGBLED_NUM 5 |
||||
#define RGBLIGHT_ANIMATIONS |
||||
|
||||
#define NO_UART 1 |
||||
#define BOOTLOADHID_BOOTLOADER 1 |
@ -0,0 +1,74 @@ |
||||
/*
|
||||
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#include <string.h> |
||||
|
||||
#include "rgblight.h" |
||||
|
||||
#include "i2c.h" |
||||
#include "quantum.h" |
||||
|
||||
#ifdef RGBLIGHT_ENABLE |
||||
extern rgblight_config_t rgblight_config; |
||||
|
||||
void rgblight_set(void) { |
||||
if (!rgblight_config.enable) { |
||||
for (uint8_t i = 0; i < RGBLED_NUM; i++) { |
||||
led[i].r = 0; |
||||
led[i].g = 0; |
||||
led[i].b = 0; |
||||
} |
||||
} |
||||
|
||||
i2c_init(); |
||||
i2c_send(0xb0, (uint8_t*)led, 3 * RGBLED_NUM); |
||||
} |
||||
#endif |
||||
|
||||
__attribute__ ((weak)) |
||||
void matrix_scan_user(void) { |
||||
} |
||||
|
||||
void backlight_init_ports(void) { |
||||
// initialize pins D0, D1, D4 and D6 as output
|
||||
setPinOutput(D0); |
||||
setPinOutput(D1); |
||||
setPinOutput(D4); |
||||
setPinOutput(D6); |
||||
|
||||
// turn RGB LEDs on
|
||||
writePinHigh(D0); |
||||
writePinHigh(D1); |
||||
writePinHigh(D4); |
||||
writePinHigh(D6); |
||||
} |
||||
|
||||
void backlight_set(uint8_t level) { |
||||
if (level == 0) { |
||||
// turn RGB LEDs off
|
||||
writePinLow(D0); |
||||
writePinLow(D1); |
||||
writePinLow(D4); |
||||
writePinLow(D6); |
||||
} else { |
||||
// turn RGB LEDs on
|
||||
writePinHigh(D0); |
||||
writePinHigh(D1); |
||||
writePinHigh(D4); |
||||
writePinHigh(D6); |
||||
} |
||||
} |
@ -0,0 +1,48 @@ |
||||
/*
|
||||
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#pragma once |
||||
|
||||
#include "quantum.h" |
||||
|
||||
#define LAYOUT( \ |
||||
K12, K11, K10, K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K13, \
|
||||
K28, K27, K26, K25, K24, K14, K15, K16, K17, K18, K19, K20, K21, K22, K23, K77, K76, K75, \
|
||||
K43, K42, K41, K40, K39, K29, K30, K31, K32, K33, K34, K35, K36, K37, K38, K74, K73, \
|
||||
K57, K56, K55, K54, K53, K44, K45, K46, K47, K48, K49, K50, K51, K52, K88, K87, \
|
||||
K72, K71, K70, K69, K68, K58, K59, K60, K61, K62, K63, K66, K64, K65, K67, K90, K89, \
|
||||
K86, K85, K78, K79, K80, K81, K82, K83, K84, K91 \
|
||||
) \
|
||||
{ \
|
||||
{ K00 , K01 , K02 , K03 , K04 , K05 , K06 , K07 , K08 , K09 , K10 , K11 , K12 , KC_NO, K13 }, \
|
||||
{ K14 , K15 , K16 , K17 , K18 , K19 , K20 , K21 , K22 , K23 , K24 , K25 , K26 , K27 , K28 }, \
|
||||
{ K29 , K30 , K31 , K32 , K33 , K34 , K35 , K36 , K37 , K38 , K39 , K40 , K41 , K42 , K43 }, \
|
||||
{ K44 , K45 , K46 , K47 , K48 , K49 , K50 , K51 , KC_NO, K52 , K53 , K54 , K55 , K56 , K57 }, \
|
||||
{ K58 , K59 , K60 , K61 , K62 , K63 , K64 , K65 , K66 , K67 , K68 , K69 , K70 , K71 , K72 }, \
|
||||
{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K73 , K74 , K75 , K76 , K77 , KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
|
||||
{ KC_NO, K78 , KC_NO, KC_NO, K79 , K80 , K81 , K82 , K83 , K84 , KC_NO, KC_NO, K85 , K86 , KC_NO }, \
|
||||
{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K87 , K88 , K89 , K90 , K91 , KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } \
|
||||
} |
||||
|
||||
// F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F2 F1 ESC FN
|
||||
// 5 6 7 8 9 0 - = BS BS 4 3 2 1 ~
|
||||
// T Y U I O P [ ] | PAD7 R E W Q Tab
|
||||
// G H J K L ; ' ENTR PAD4 F D S A CAPS
|
||||
// V B N M , . RSFT UP / PAD1 C X Z EUR2 LSFT
|
||||
// PAD9 PAD8 PAD- PAD* PAD/
|
||||
// SPC RALT RCTL LEFT DOWN RGHT PAD0 LALT LGUI
|
||||
// PAD6 PAD5 PAD3 PAD2 PAD.
|
@ -0,0 +1,106 @@ |
||||
/*
|
||||
Copyright 2016 Luiz Ribeiro <luizribeiro@gmail.com> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
// Please do not modify this file
|
||||
|
||||
#include <avr/io.h> |
||||
#include <util/twi.h> |
||||
|
||||
#include "i2c.h" |
||||
|
||||
void i2c_set_bitrate(uint16_t bitrate_khz) { |
||||
uint8_t bitrate_div = ((F_CPU / 1000l) / bitrate_khz); |
||||
if (bitrate_div >= 16) { |
||||
bitrate_div = (bitrate_div - 16) / 2; |
||||
} |
||||
TWBR = bitrate_div; |
||||
} |
||||
|
||||
void i2c_init(void) { |
||||
// set pull-up resistors on I2C bus pins
|
||||
PORTC |= 0b11; |
||||
|
||||
i2c_set_bitrate(400); |
||||
|
||||
// enable TWI (two-wire interface)
|
||||
TWCR |= (1 << TWEN); |
||||
|
||||
// enable TWI interrupt and slave address ACK
|
||||
TWCR |= (1 << TWIE); |
||||
TWCR |= (1 << TWEA); |
||||
} |
||||
|
||||
uint8_t i2c_start(uint8_t address) { |
||||
// reset TWI control register
|
||||
TWCR = 0; |
||||
|
||||
// begin transmission and wait for it to end
|
||||
TWCR = (1<<TWINT) | (1<<TWSTA) | (1<<TWEN); |
||||
while (!(TWCR & (1<<TWINT))); |
||||
|
||||
// check if the start condition was successfully transmitted
|
||||
if ((TWSR & 0xF8) != TW_START) { |
||||
return 1; |
||||
} |
||||
|
||||
// transmit address and wait
|
||||
TWDR = address; |
||||
TWCR = (1<<TWINT) | (1<<TWEN); |
||||
while (!(TWCR & (1<<TWINT))); |
||||
|
||||
// check if the device has acknowledged the READ / WRITE mode
|
||||
uint8_t twst = TW_STATUS & 0xF8; |
||||
if ((twst != TW_MT_SLA_ACK) && (twst != TW_MR_SLA_ACK)) { |
||||
return 1; |
||||
} |
||||
|
||||
return 0; |
||||
} |
||||
|
||||
void i2c_stop(void) { |
||||
TWCR = (1<<TWINT) | (1<<TWEN) | (1<<TWSTO); |
||||
} |
||||
|
||||
uint8_t i2c_write(uint8_t data) { |
||||
TWDR = data; |
||||
|
||||
// transmit data and wait
|
||||
TWCR = (1<<TWINT) | (1<<TWEN); |
||||
while (!(TWCR & (1<<TWINT))); |
||||
|
||||
if ((TWSR & 0xF8) != TW_MT_DATA_ACK) { |
||||
return 1; |
||||
} |
||||
|
||||
return 0; |
||||
} |
||||
|
||||
uint8_t i2c_send(uint8_t address, uint8_t *data, uint16_t length) { |
||||
if (i2c_start(address)) { |
||||
return 1; |
||||
} |
||||
|
||||
for (uint16_t i = 0; i < length; i++) { |
||||
if (i2c_write(data[i])) { |
||||
return 1; |
||||
} |
||||
} |
||||
|
||||
i2c_stop(); |
||||
|
||||
return 0; |
||||
} |
@ -0,0 +1,27 @@ |
||||
/*
|
||||
Copyright 2016 Luiz Ribeiro <luizribeiro@gmail.com> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
// Please do not modify this file
|
||||
|
||||
#ifndef __I2C_H__ |
||||
#define __I2C_H__ |
||||
|
||||
void i2c_init(void); |
||||
void i2c_set_bitrate(uint16_t bitrate_khz); |
||||
uint8_t i2c_send(uint8_t address, uint8_t *data, uint16_t length); |
||||
|
||||
#endif |
@ -0,0 +1,46 @@ |
||||
/*
|
||||
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#include QMK_KEYBOARD_H |
||||
|
||||
// Layer shorthand
|
||||
enum layers { |
||||
_BASE = 0, // Base
|
||||
_CTRL // Multimedia and RGB
|
||||
}; |
||||
|
||||
#define KC_TGCT MO(_CTRL) // Toggles CTRL layer
|
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { |
||||
[_BASE] = LAYOUT( |
||||
KC_ESC , KC_F1 , KC_F2 , KC_F3 , KC_F4 , KC_F5 , KC_F6 , KC_F7 , KC_F8 , KC_F9 , KC_F10 , KC_F11 , KC_F12 , KC_TGCT, \
|
||||
KC_GRV , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_MINS, KC_EQL , KC_BSPC, KC_BSPC, KC_PSLS, KC_PAST, KC_PMNS, \
|
||||
KC_TAB , KC_Q , KC_W , KC_E , KC_R , KC_T , KC_Y , KC_U , KC_I , KC_O , KC_P , KC_LBRC, KC_RBRC, KC_BSLS, KC_P7 , KC_P8 , KC_P9 , \
|
||||
KC_CAPS, KC_A , KC_S , KC_D , KC_F , KC_G , KC_H , KC_J , KC_K , KC_L , KC_SCLN, KC_QUOT, KC_ENT , KC_P4 , KC_P5 , KC_P6 , \
|
||||
KC_LSFT, KC_NO , KC_Z , KC_Z , KC_X , KC_V , KC_B , KC_N , KC_M , KC_COMM, KC_DOT , KC_SLSH, KC_RSFT, KC_UP , KC_P1 , KC_P2 , KC_P3 , \
|
||||
KC_LCTL, KC_LALT, KC_SPC , KC_RALT, KC_RGUI, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0 , KC_PDOT \
|
||||
), |
||||
|
||||
[_CTRL] = LAYOUT( |
||||
RESET , _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
|
||||
_______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______, _______, _______, _______, \
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
|
||||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
|
||||
), |
||||
}; |
@ -0,0 +1,60 @@ |
||||
# Gray Studio HB85 |
||||
|
||||
 |
||||
|
||||
A HitBit MSX Computer inspired Keyboard. |
||||
|
||||
Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury) |
||||
Hardware Supported: Gray Studio HB85 |
||||
Hardware Availability: Group buy finished |
||||
|
||||
Make example for this keyboard (after setting up your build environment): |
||||
|
||||
make hb85:default |
||||
|
||||
See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. |
||||
|
||||
|
||||
ps2avrGB keyboard firmware |
||||
========================== |
||||
|
||||
This keyboard uses the port of the QMK firmware for boards that are based on the |
||||
ps2avrGB firmware. |
||||
|
||||
Note that this is a complete replacement for the firmware, so you won't be |
||||
using Bootmapper Client to change any keyboard settings, since not all the |
||||
USB report options are supported. |
||||
|
||||
## Installing |
||||
|
||||
First, install the requirements. These commands are for OSX, but all you |
||||
need is the AVR toolchain and `bootloadHID` for flashing: |
||||
|
||||
``` |
||||
$ brew cask install crosspack-avr |
||||
$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb |
||||
$ pip install pyusb |
||||
``` |
||||
|
||||
Then, with the keyboard plugged in, simply run this command from the |
||||
`qmk_firmware` directory: |
||||
|
||||
``` |
||||
$ make hb85 |
||||
$ bootloadHID -r hb85_default.hex |
||||
``` |
||||
|
||||
## Setting the board to bootloader mode |
||||
|
||||
Hold the F3 key while plugging the USB cable. |
||||
|
||||
## Troubleshooting |
||||
|
||||
From my experience, it's really hard to brick these boards. But these |
||||
tricks have been useful when it got stuck in a weird scenario. |
||||
|
||||
1. Try plugging the board in while holding the bootloader key. This will force |
||||
it to boot only the bootloader without loading the firmware. Once this is |
||||
done, just reflash the board with the original firmware. |
||||
2. Sometimes USB hubs can act weird, so try connecting the board directly |
||||
to your computer or plugging/unplugging the USB hub. |
@ -0,0 +1,48 @@ |
||||
# Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com>
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# MCU name
|
||||
MCU = atmega32a
|
||||
PROTOCOL = VUSB
|
||||
|
||||
# unsupported features for now
|
||||
NO_UART = yes
|
||||
NO_SUSPEND_POWER_DOWN = yes
|
||||
|
||||
# processor frequency
|
||||
F_CPU = 12000000
|
||||
|
||||
# Bootloader
|
||||
# This definition is optional, and if your keyboard supports multiple bootloaders of
|
||||
# different sizes, comment this out, and the correct address will be loaded
|
||||
# automatically (+60). See bootloader.mk for all options.
|
||||
BOOTLOADER = bootloadHID
|
||||
|
||||
# build options
|
||||
BOOTMAGIC_ENABLE = full
|
||||
MOUSEKEY_ENABLE = no
|
||||
EXTRAKEY_ENABLE = yes
|
||||
CONSOLE_ENABLE = yes
|
||||
COMMAND_ENABLE = yes
|
||||
BACKLIGHT_ENABLE = no
|
||||
RGBLIGHT_ENABLE = yes
|
||||
RGBLIGHT_CUSTOM_DRIVER = yes
|
||||
|
||||
OPT_DEFS = -DDEBUG_LEVEL=0
|
||||
|
||||
SRC += i2c.c
|
||||
|
||||
# programming options
|
||||
PROGRAM_CMD = ./util/atmega32a_program.py $(TARGET).hex
|
@ -0,0 +1,396 @@ |
||||
/* Name: usbconfig.h
|
||||
* Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers |
||||
* Author: Christian Starkjohann |
||||
* Creation Date: 2005-04-01 |
||||
* Tabsize: 4 |
||||
* Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH |
||||
* License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) |
||||
* This Revision: $Id: usbconfig-prototype.h 785 2010-05-30 17:57:07Z cs $ |
||||
*/ |
||||
|
||||
#ifndef __usbconfig_h_included__ |
||||
#define __usbconfig_h_included__ |
||||
|
||||
#include "config.h" |
||||
|
||||
/*
|
||||
General Description: |
||||
This file is an example configuration (with inline documentation) for the USB |
||||
driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is |
||||
also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may |
||||
wire the lines to any other port, as long as D+ is also wired to INT0 (or any |
||||
other hardware interrupt, as long as it is the highest level interrupt, see |
||||
section at the end of this file). |
||||
*/ |
||||
|
||||
/* ---------------------------- Hardware Config ---------------------------- */ |
||||
|
||||
#define USB_CFG_IOPORTNAME D |
||||
/* This is the port where the USB bus is connected. When you configure it to
|
||||
* "B", the registers PORTB, PINB and DDRB will be used. |
||||
*/ |
||||
#define USB_CFG_DMINUS_BIT 3 |
||||
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
|
||||
* This may be any bit in the port. |
||||
*/ |
||||
#define USB_CFG_DPLUS_BIT 2 |
||||
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
|
||||
* This may be any bit in the port. Please note that D+ must also be connected |
||||
* to interrupt pin INT0! [You can also use other interrupts, see section |
||||
* "Optional MCU Description" below, or you can connect D- to the interrupt, as |
||||
* it is required if you use the USB_COUNT_SOF feature. If you use D- for the |
||||
* interrupt, the USB interrupt will also be triggered at Start-Of-Frame |
||||
* markers every millisecond.] |
||||
*/ |
||||
#define USB_CFG_CLOCK_KHZ (F_CPU/1000) |
||||
/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000,
|
||||
* 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code |
||||
* require no crystal, they tolerate +/- 1% deviation from the nominal |
||||
* frequency. All other rates require a precision of 2000 ppm and thus a |
||||
* crystal! |
||||
* Since F_CPU should be defined to your actual clock rate anyway, you should |
||||
* not need to modify this setting. |
||||
*/ |
||||
#define USB_CFG_CHECK_CRC 0 |
||||
/* Define this to 1 if you want that the driver checks integrity of incoming
|
||||
* data packets (CRC checks). CRC checks cost quite a bit of code size and are |
||||
* currently only available for 18 MHz crystal clock. You must choose |
||||
* USB_CFG_CLOCK_KHZ = 18000 if you enable this option. |
||||
*/ |
||||
|
||||
/* ----------------------- Optional Hardware Config ------------------------ */ |
||||
|
||||
/* #define USB_CFG_PULLUP_IOPORTNAME D */ |
||||
/* If you connect the 1.5k pullup resistor from D- to a port pin instead of
|
||||
* V+, you can connect and disconnect the device from firmware by calling |
||||
* the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h). |
||||
* This constant defines the port on which the pullup resistor is connected. |
||||
*/ |
||||
/* #define USB_CFG_PULLUP_BIT 4 */ |
||||
/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
|
||||
* above) where the 1.5k pullup resistor is connected. See description |
||||
* above for details. |
||||
*/ |
||||
|
||||
/* --------------------------- Functional Range ---------------------------- */ |
||||
|
||||
#define USB_CFG_HAVE_INTRIN_ENDPOINT 1 |
||||
/* Define this to 1 if you want to compile a version with two endpoints: The
|
||||
* default control endpoint 0 and an interrupt-in endpoint (any other endpoint |
||||
* number). |
||||
*/ |
||||
#define USB_CFG_HAVE_INTRIN_ENDPOINT3 1 |
||||
/* Define this to 1 if you want to compile a version with three endpoints: The
|
||||
* default control endpoint 0, an interrupt-in endpoint 3 (or the number |
||||
* configured below) and a catch-all default interrupt-in endpoint as above. |
||||
* You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature. |
||||
*/ |
||||
#define USB_CFG_EP3_NUMBER 3 |
||||
/* If the so-called endpoint 3 is used, it can now be configured to any other
|
||||
* endpoint number (except 0) with this macro. Default if undefined is 3. |
||||
*/ |
||||
/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */ |
||||
/* The above macro defines the startup condition for data toggling on the
|
||||
* interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1. |
||||
* Since the token is toggled BEFORE sending any data, the first packet is |
||||
* sent with the oposite value of this configuration! |
||||
*/ |
||||
#define USB_CFG_IMPLEMENT_HALT 0 |
||||
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
|
||||
* for endpoint 1 (interrupt endpoint). Although you may not need this feature, |
||||
* it is required by the standard. We have made it a config option because it |
||||
* bloats the code considerably. |
||||
*/ |
||||
#define USB_CFG_SUPPRESS_INTR_CODE 0 |
||||
/* Define this to 1 if you want to declare interrupt-in endpoints, but don't
|
||||
* want to send any data over them. If this macro is defined to 1, functions |
||||
* usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if |
||||
* you need the interrupt-in endpoints in order to comply to an interface |
||||
* (e.g. HID), but never want to send any data. This option saves a couple |
||||
* of bytes in flash memory and the transmit buffers in RAM. |
||||
*/ |
||||
#define USB_CFG_INTR_POLL_INTERVAL 1 |
||||
/* If you compile a version with endpoint 1 (interrupt-in), this is the poll
|
||||
* interval. The value is in milliseconds and must not be less than 10 ms for |
||||
* low speed devices. |
||||
*/ |
||||
#define USB_CFG_IS_SELF_POWERED 0 |
||||
/* Define this to 1 if the device has its own power supply. Set it to 0 if the
|
||||
* device is powered from the USB bus. |
||||
*/ |
||||
#define USB_CFG_MAX_BUS_POWER 500 |
||||
/* Set this variable to the maximum USB bus power consumption of your device.
|
||||
* The value is in milliamperes. [It will be divided by two since USB |
||||
* communicates power requirements in units of 2 mA.] |
||||
*/ |
||||
#define USB_CFG_IMPLEMENT_FN_WRITE 1 |
||||
/* Set this to 1 if you want usbFunctionWrite() to be called for control-out
|
||||
* transfers. Set it to 0 if you don't need it and want to save a couple of |
||||
* bytes. |
||||
*/ |
||||
#define USB_CFG_IMPLEMENT_FN_READ 0 |
||||
/* Set this to 1 if you need to send control replies which are generated
|
||||
* "on the fly" when usbFunctionRead() is called. If you only want to send |
||||
* data from a static buffer, set it to 0 and return the data from |
||||
* usbFunctionSetup(). This saves a couple of bytes. |
||||
*/ |
||||
#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 |
||||
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
|
||||
* You must implement the function usbFunctionWriteOut() which receives all |
||||
* interrupt/bulk data sent to any endpoint other than 0. The endpoint number |
||||
* can be found in 'usbRxToken'. |
||||
*/ |
||||
#define USB_CFG_HAVE_FLOWCONTROL 0 |
||||
/* Define this to 1 if you want flowcontrol over USB data. See the definition
|
||||
* of the macros usbDisableAllRequests() and usbEnableAllRequests() in |
||||
* usbdrv.h. |
||||
*/ |
||||
#define USB_CFG_DRIVER_FLASH_PAGE 0 |
||||
/* If the device has more than 64 kBytes of flash, define this to the 64 k page
|
||||
* where the driver's constants (descriptors) are located. Or in other words: |
||||
* Define this to 1 for boot loaders on the ATMega128. |
||||
*/ |
||||
#define USB_CFG_LONG_TRANSFERS 0 |
||||
/* Define this to 1 if you want to send/receive blocks of more than 254 bytes
|
||||
* in a single control-in or control-out transfer. Note that the capability |
||||
* for long transfers increases the driver size. |
||||
*/ |
||||
/* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */ |
||||
/* This macro is a hook if you want to do unconventional things. If it is
|
||||
* defined, it's inserted at the beginning of received message processing. |
||||
* If you eat the received message and don't want default processing to |
||||
* proceed, do a return after doing your things. One possible application |
||||
* (besides debugging) is to flash a status LED on each packet. |
||||
*/ |
||||
/* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */ |
||||
/* This macro is a hook if you need to know when an USB RESET occurs. It has
|
||||
* one parameter which distinguishes between the start of RESET state and its |
||||
* end. |
||||
*/ |
||||
/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */ |
||||
/* This macro (if defined) is executed when a USB SET_ADDRESS request was
|
||||
* received. |
||||
*/ |
||||
#define USB_COUNT_SOF 1 |
||||
/* define this macro to 1 if you need the global variable "usbSofCount" which
|
||||
* counts SOF packets. This feature requires that the hardware interrupt is |
||||
* connected to D- instead of D+. |
||||
*/ |
||||
/* #ifdef __ASSEMBLER__
|
||||
* macro myAssemblerMacro |
||||
* in YL, TCNT0 |
||||
* sts timer0Snapshot, YL |
||||
* endm |
||||
* #endif |
||||
* #define USB_SOF_HOOK myAssemblerMacro |
||||
* This macro (if defined) is executed in the assembler module when a |
||||
* Start Of Frame condition is detected. It is recommended to define it to |
||||
* the name of an assembler macro which is defined here as well so that more |
||||
* than one assembler instruction can be used. The macro may use the register |
||||
* YL and modify SREG. If it lasts longer than a couple of cycles, USB messages |
||||
* immediately after an SOF pulse may be lost and must be retried by the host. |
||||
* What can you do with this hook? Since the SOF signal occurs exactly every |
||||
* 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in |
||||
* designs running on the internal RC oscillator. |
||||
* Please note that Start Of Frame detection works only if D- is wired to the |
||||
* interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! |
||||
*/ |
||||
#define USB_CFG_CHECK_DATA_TOGGLING 0 |
||||
/* define this macro to 1 if you want to filter out duplicate data packets
|
||||
* sent by the host. Duplicates occur only as a consequence of communication |
||||
* errors, when the host does not receive an ACK. Please note that you need to |
||||
* implement the filtering yourself in usbFunctionWriteOut() and |
||||
* usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable |
||||
* for each control- and out-endpoint to check for duplicate packets. |
||||
*/ |
||||
#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0 |
||||
/* define this macro to 1 if you want the function usbMeasureFrameLength()
|
||||
* compiled in. This function can be used to calibrate the AVR's RC oscillator. |
||||
*/ |
||||
#define USB_USE_FAST_CRC 0 |
||||
/* The assembler module has two implementations for the CRC algorithm. One is
|
||||
* faster, the other is smaller. This CRC routine is only used for transmitted |
||||
* messages where timing is not critical. The faster routine needs 31 cycles |
||||
* per byte while the smaller one needs 61 to 69 cycles. The faster routine |
||||
* may be worth the 32 bytes bigger code size if you transmit lots of data and |
||||
* run the AVR close to its limit. |
||||
*/ |
||||
|
||||
/* -------------------------- Device Description --------------------------- */ |
||||
|
||||
#define USB_CFG_VENDOR_ID (VENDOR_ID & 0xFF), ((VENDOR_ID >> 8) & 0xFF) |
||||
/* USB vendor ID for the device, low byte first. If you have registered your
|
||||
* own Vendor ID, define it here. Otherwise you may use one of obdev's free |
||||
* shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules! |
||||
* *** IMPORTANT NOTE *** |
||||
* This template uses obdev's shared VID/PID pair for Vendor Class devices |
||||
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand |
||||
* the implications! |
||||
*/ |
||||
#define USB_CFG_DEVICE_ID (PRODUCT_ID & 0xFF), ((PRODUCT_ID >> 8) & 0xFF) |
||||
/* This is the ID of the product, low byte first. It is interpreted in the
|
||||
* scope of the vendor ID. If you have registered your own VID with usb.org |
||||
* or if you have licensed a PID from somebody else, define it here. Otherwise |
||||
* you may use one of obdev's free shared VID/PID pairs. See the file |
||||
* USB-IDs-for-free.txt for details! |
||||
* *** IMPORTANT NOTE *** |
||||
* This template uses obdev's shared VID/PID pair for Vendor Class devices |
||||
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand |
||||
* the implications! |
||||
*/ |
||||
#define USB_CFG_DEVICE_VERSION 0x00, 0x02 |
||||
/* Version number of the device: Minor number first, then major number.
|
||||
*/ |
||||
#define USB_CFG_VENDOR_NAME 'G', 'r', 'a', 'y', ' ', 'S', 't', 'u', 'd', 'i', 'o' |
||||
#define USB_CFG_VENDOR_NAME_LEN 11 |
||||
/* 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 'H', 'B', '8', '5' |
||||
#define USB_CFG_DEVICE_NAME_LEN 4 |
||||
/* 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 |
||||
|
||||
#endif /* __usbconfig_h_included__ */ |
Loading…
Reference in new issue