From 385d4030035dbaf41591309dbde47653bd03841b Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Wed, 5 Jul 2017 10:27:50 -0400 Subject: [PATCH] adds QMK board with definable LEDs and matrix scan --- Bootloaders/DFU/BootloaderDFU.c | 46 ++++++- Bootloaders/DFU/Descriptors.c | 4 +- Bootloaders/DFU/makefile | 10 +- LUFA/Common/BoardTypes.h | 3 + LUFA/Drivers/Board/AVR8/QMK/Board.h | 65 ++++++++++ LUFA/Drivers/Board/AVR8/QMK/LEDs.h | 194 ++++++++++++++++++++++++++++ LUFA/Drivers/Board/Board.h | 2 + LUFA/Drivers/Board/LEDs.h | 2 + 8 files changed, 312 insertions(+), 14 deletions(-) create mode 100644 LUFA/Drivers/Board/AVR8/QMK/Board.h create mode 100644 LUFA/Drivers/Board/AVR8/QMK/LEDs.h diff --git a/Bootloaders/DFU/BootloaderDFU.c b/Bootloaders/DFU/BootloaderDFU.c index 8da725d248..928cf6fe3b 100644 --- a/Bootloaders/DFU/BootloaderDFU.c +++ b/Bootloaders/DFU/BootloaderDFU.c @@ -136,8 +136,8 @@ void Application_Jump_Check(void) if (boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS) & FUSE_BOOTRST) { /* If the reset source was not an external reset or the key is correct, clear it and jump to the application */ - if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY)) - JumpToApplication = true; + //if (!(MCUSR & (1 << EXTRF)) || (MagicBootKey == MAGIC_BOOT_KEY)) + // JumpToApplication = true; /* Clear reset source */ MCUSR &= ~(1 << EXTRF); @@ -146,8 +146,8 @@ void Application_Jump_Check(void) { /* If the reset source was the bootloader and the key is correct, clear it and jump to the application; * this can happen in the HWBE fuse is set, and the HBE pin is low during the watchdog reset */ - if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY)) - JumpToApplication = true; + //if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY)) + // JumpToApplication = true; /* Clear reset source */ MCUSR &= ~(1 << WDRF); @@ -182,14 +182,32 @@ int main(void) SetupHardware(); /* Turn on first LED on the board to indicate that the bootloader has started */ - LEDs_SetAllLEDs(LEDS_LED1); + LEDs_SetAllLEDs(LEDS_LED1 | LEDS_LED2); /* Enable global interrupts so that the USB stack can function */ GlobalInterruptEnable(); + + #if (BOARD == BOARD_QMK) + uint16_t keypress = 0; + #endif + /* Run the USB management task while the bootloader is supposed to be running */ - while (RunBootloader || WaitForExit) + while (RunBootloader || WaitForExit) { USB_USBTask(); + #if (BOARD == BOARD_QMK) + bool pressed = (PIN(QMK_ESC_ROW) & NUM(QMK_ESC_ROW)); + if ((DFU_State == dfuIDLE) && (keypress > 5000) && pressed) { + break; + } + if (pressed) { + keypress++; + } else { + keypress = 0; + } + + #endif + } /* Reset configured hardware back to their original states for the user application */ ResetHardware(); @@ -212,6 +230,15 @@ static void SetupHardware(void) MCUCR = (1 << IVCE); MCUCR = (1 << IVSEL); + #if (BOARD == BOARD_QMK) + // column setup + DDR(QMK_ESC_COL) |= NUM(QMK_ESC_COL); + PORT(QMK_ESC_COL) |= NUM(QMK_ESC_COL); + + // row setup + DDR(QMK_ESC_ROW) |= NUM(QMK_ESC_ROW); + #endif + /* Initialize the USB and other board hardware drivers */ USB_Init(); LEDs_Init(); @@ -219,7 +246,8 @@ static void SetupHardware(void) /* Bootloader active LED toggle timer initialization */ TIMSK1 = (1 << TOIE1); TCCR1B = ((1 << CS11) | (1 << CS10)); -} + +} /** Resets all configured hardware required for the bootloader back to their original states. */ static void ResetHardware(void) @@ -235,6 +263,10 @@ static void ResetHardware(void) /* Relocate the interrupt vector table back to the application section */ MCUCR = (1 << IVCE); MCUCR = 0; + + #if (BOARD == BOARD_QMK) + DDR(QMK_ESC_COL) = PORT(QMK_ESC_COL) = DDR(QMK_ESC_ROW) = PORT(QMK_ESC_ROW) = 0; + #endif } /** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */ diff --git a/Bootloaders/DFU/Descriptors.c b/Bootloaders/DFU/Descriptors.c index f7fe1cbb42..6b7b6d4900 100644 --- a/Bootloaders/DFU/Descriptors.c +++ b/Bootloaders/DFU/Descriptors.c @@ -125,13 +125,13 @@ const USB_Descriptor_String_t LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGU * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device * Descriptor. */ -const USB_Descriptor_String_t ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera"); +const USB_Descriptor_String_t ManufacturerString = USB_STRING_DESCRIPTOR(L"QMK"); /** Product descriptor string. This is a Unicode string containing the product's details in human readable form, * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device * Descriptor. */ -const USB_Descriptor_String_t ProductString = USB_STRING_DESCRIPTOR(L"LUFA DFU"); +const USB_Descriptor_String_t ProductString = USB_STRING_DESCRIPTOR(L"KB"); /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors" * documentation) by the application code so that the address and size of a requested descriptor can be given diff --git a/Bootloaders/DFU/makefile b/Bootloaders/DFU/makefile index 6e15cedfc3..0d2014015d 100644 --- a/Bootloaders/DFU/makefile +++ b/Bootloaders/DFU/makefile @@ -11,10 +11,10 @@ # Run "make help" for target help. -MCU = at90usb1287 +MCU = atmega32u4 ARCH = AVR8 -BOARD = USBKEY -F_CPU = 8000000 +BOARD = QMK +F_CPU = 16000000 F_USB = $(F_CPU) OPTIMIZATION = s TARGET = BootloaderDFU @@ -26,8 +26,8 @@ LD_FLAGS = -Wl,--section-start=.text=$(BOOT_START_OFFSET) $(BOOT_API_LD_FLAG # Flash size and bootloader section sizes of the target, in KB. These must # match the target's total FLASH size and the bootloader size set in the # device's fuses. -FLASH_SIZE_KB = 128 -BOOT_SECTION_SIZE_KB = 8 +FLASH_SIZE_KB = 32 +BOOT_SECTION_SIZE_KB = 4 # Bootloader address calculation formulas # Do not modify these macros, but rather modify the dependent values above. diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h index a8bb191db0..e945523427 100644 --- a/LUFA/Common/BoardTypes.h +++ b/LUFA/Common/BoardTypes.h @@ -246,6 +246,9 @@ /** Selects the Atmel Xplained-MINI specific board drivers, including the driver for the board LEDs. */ #define BOARD_XPLAINED_MINI 60 + /** Selects the QMK specific board drivres, including the driver for the board LEDs. */ + #define BOARD_QMK 61 + #if !defined(__DOXYGEN__) #define BOARD_ BOARD_NONE diff --git a/LUFA/Drivers/Board/AVR8/QMK/Board.h b/LUFA/Drivers/Board/AVR8/QMK/Board.h new file mode 100644 index 0000000000..19a0f2dfee --- /dev/null +++ b/LUFA/Drivers/Board/AVR8/QMK/Board.h @@ -0,0 +1,65 @@ +/* +Copyright 2017 Jack Humbert + +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 . +*/ + +/** \file + * \brief General driver header for QMK-powered keyboards. + * \copydetails Group_BoardInfo_QMK + * + * \note This file should not be included directly. It is automatically included as needed by the Board driver + * dispatch header located in LUFA/Drivers/Board/Board.h. + */ + +/** \ingroup Group_BoardInfo + * \defgroup Group_BoardInfo_QMK QMK + * \brief General driver header for QMK-powered keyboards. + * + * General driver header for QMK-powered keyboards (http://qmk.fm). + * + * @{ + */ + +#ifndef __BOARD_QMK_H__ +#define __BOARD_QMK_H__ + + /* Includes: */ + #include "../../../../Common/Common.h" + #include "../../LEDs.h" + + /* Enable C linkage for C++ Compilers: */ + #if defined(__cplusplus) + extern "C" { + #endif + + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_BOARD_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/Board.h instead. + #endif + + /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Indicates the board has hardware LEDs mounted. */ + #define BOARD_HAS_LEDS + + /* Disable C linkage for C++ Compilers: */ + #if defined(__cplusplus) + } + #endif + +#endif + +/** @} */ + diff --git a/LUFA/Drivers/Board/AVR8/QMK/LEDs.h b/LUFA/Drivers/Board/AVR8/QMK/LEDs.h new file mode 100644 index 0000000000..1310612dc8 --- /dev/null +++ b/LUFA/Drivers/Board/AVR8/QMK/LEDs.h @@ -0,0 +1,194 @@ +/* +Copyright 2017 Jack Humbert + +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 . +*/ + +/** \file + * \brief General driver header for QMK-powered keyboards. + * \copydetails Group_LEDs_QMK + * + * \note This file should not be included directly. It is automatically included as needed by the LEDs driver + * dispatch header located in LUFA/Drivers/Board/LEDs.h. + */ + +/** \ingroup Group_LEDs + * \defgroup Group_LEDs_QMK QMK + * \brief General driver header for QMK-powered keyboards. + * + * General driver header for QMK-powered keyboards (http://qmk.fm). + * + * QMK: + * + * + * + *
NameColorInfoActive LevelPort Pin
LEDS_LED1GreenGeneral IndicatorHighPORT(QMK_LED).6
+ * + * @{ + */ + +#ifndef __LEDS_QMK_H__ +#define __LEDS_QMK_H__ + + /* Includes: */ + #include "../../../../Common/Common.h" + + /* Enable C linkage for C++ Compilers: */ + #if defined(__cplusplus) + extern "C" { + #endif + + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_LEDS_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead. + #endif + + #define B0 0x30 + #define B1 0x31 + #define B2 0x32 + #define B3 0x33 + #define B4 0x34 + #define B5 0x35 + #define B6 0x36 + #define B7 0x37 + #define C0 0x60 + #define C1 0x61 + #define C2 0x62 + #define C3 0x63 + #define C4 0x64 + #define C5 0x65 + #define C6 0x66 + #define C7 0x67 + #define D0 0x90 + #define D1 0x91 + #define D2 0x92 + #define D3 0x93 + #define D4 0x94 + #define D5 0x95 + #define D6 0x96 + #define D7 0x97 + #define E0 0xC0 + #define E1 0xC1 + #define E2 0xC2 + #define E3 0xC3 + #define E4 0xC4 + #define E5 0xC5 + #define E6 0xC6 + #define E7 0xC7 + #define F0 0xF0 + #define F1 0xF1 + #define F2 0xF2 + #define F3 0xF3 + #define F4 0xF4 + #define F5 0xF5 + #define F6 0xF6 + #define F7 0xF7 + #define A0 0x00 + #define A1 0x01 + #define A2 0x02 + #define A3 0x03 + #define A4 0x04 + #define A5 0x05 + #define A6 0x06 + #define A7 0x07 + + #define QMK_ESC_COL F1 + #define QMK_ESC_ROW D5 + #define QMK_LED E6 + #define QMK_SPEAKER C6 + + #define DDR(pin) _SFR_IO8(((pin) >> 4) + 1) + #define PORT(pin) _SFR_IO8(((pin) >> 4) + 2) + #define PIN(pin) _SFR_IO8((pin) >> 4) + #define NUM(pin) _BV((pin) & 0xF) + + /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** LED mask for the first LED on the board. */ + #define LEDS_LED1 NUM(QMK_LED) + #define LEDS_LED2 NUM(QMK_SPEAKER) + + /** LED mask for all the LEDs on the board. */ + #define LEDS_ALL_LEDS LEDS_LED1 | LEDS_LED2 + + /** LED mask for none of the board LEDs. */ + #define LEDS_NO_LEDS 0 + + /* Inline Functions: */ + #if !defined(__DOXYGEN__) + static inline void LEDs_Init(void) + { + DDR(QMK_LED) |= LEDS_LED1; + PORT(QMK_LED) |= LEDS_LED1; + + DDR(QMK_SPEAKER) |= LEDS_LED2; + PORT(QMK_SPEAKER) |= LEDS_LED2; + } + + static inline void LEDs_Disable(void) + { + DDR(QMK_LED) &= ~LEDS_LED1; + PORT(QMK_LED) &= ~LEDS_LED2; + + DDR(QMK_SPEAKER) &= ~LEDS_LED1; + PORT(QMK_SPEAKER) &= ~LEDS_LED2; + } + + static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask) + { + PORT(QMK_LED) &= (LEDS_LED1 & ~LEDMask); + PORT(QMK_SPEAKER) &= (LEDS_LED2 & ~LEDMask); + } + + static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask) + { + PORT(QMK_LED) |= (LEDS_LED1 & LEDMask); + PORT(QMK_SPEAKER) |= (LEDS_LED2 & LEDMask); + } + + static inline void LEDs_SetAllLEDs(const uint8_t LEDMask) + { + PORT(QMK_LED) = ((PORT(QMK_LED) | LEDS_LED1) & ~LEDMask); + PORT(QMK_SPEAKER) = ((PORT(QMK_SPEAKER) | LEDS_LED2) & ~LEDMask); + } + + static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, + const uint8_t ActiveMask) + { + PORT(QMK_LED) = ((PORT(QMK_LED) | (LEDS_LED1 & LEDMask)) & ~ActiveMask); + PORT(QMK_SPEAKER) = ((PORT(QMK_SPEAKER) | (LEDS_LED1 & LEDMask)) & ~ActiveMask); + } + + static inline void LEDs_ToggleLEDs(const uint8_t LEDMask) + { + PIN(QMK_LED) = (LEDS_LED1 & LEDMask); + PIN(QMK_SPEAKER) = (LEDS_LED2 & LEDMask); + } + + static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t LEDs_GetLEDs(void) + { + return (~PORT(QMK_LED) & LEDS_LED1) | (~(PORT(QMK_SPEAKER) & LEDS_LED2)); + } + #endif + + /* Disable C linkage for C++ Compilers: */ + #if defined(__cplusplus) + } + #endif + +#endif + +/** @} */ + diff --git a/LUFA/Drivers/Board/Board.h b/LUFA/Drivers/Board/Board.h index 55ed29a99e..3b28e6cca3 100644 --- a/LUFA/Drivers/Board/Board.h +++ b/LUFA/Drivers/Board/Board.h @@ -81,6 +81,8 @@ #include "AVR8/EVK527/Board.h" #elif ((BOARD == BOARD_TEENSY) || (BOARD == BOARD_TEENSY2)) #include "AVR8/TEENSY/Board.h" + #elif ((BOARD == BOARD_QMK)) + #include "AVR8/QMK/Board.h" #elif (BOARD == BOARD_USBTINYMKII) #include "AVR8/USBTINYMKII/Board.h" #elif (BOARD == BOARD_BENITO) diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index ba0b1bb5b6..74abb37238 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -134,6 +134,8 @@ #include "AVR8/EVK527/LEDs.h" #elif ((BOARD == BOARD_TEENSY) || (BOARD == BOARD_TEENSY2)) #include "AVR8/TEENSY/LEDs.h" + #elif ((BOARD == BOARD_QMK)) + #include "AVR8/QMK/LEDs.h" #elif (BOARD == BOARD_USBTINYMKII) #include "AVR8/USBTINYMKII/LEDs.h" #elif (BOARD == BOARD_BENITO)