From 1a9cec9a0315c2b7dbe320a6c34646e264a99681 Mon Sep 17 00:00:00 2001 From: Oleg Kostyuk Date: Thu, 20 Nov 2014 23:55:47 +0200 Subject: [PATCH 01/78] Documentation: small mistake Originally reported as https://github.com/cub-uanic/tmk_keyboard/issues/10, all credits to @olivierpons --- doc/keycode.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/keycode.txt b/doc/keycode.txt index 4137566924..760c726e3b 100644 --- a/doc/keycode.txt +++ b/doc/keycode.txt @@ -81,7 +81,7 @@ KC_F12 45 Keyboard F12 KC_PSCREEN KC_PSCR 46 Keyboard PrintScreen1 KC_SCKLOCK KC_SLCK 47 Keyboard Scroll Lock11 KC_PAUSE KC_PAUS 48 Keyboard Pause1 -KC_INSERT KC_INT 49 Keyboard Insert1 +KC_INSERT KC_INS 49 Keyboard Insert1 KC_HOME 4A Keyboard Home1 KC_PGUP 4B Keyboard PageUp1 KC_DELETE KC_DELETE 4C Keyboard Delete Forward From 60acd8996d559f5ab0458c2e1ea46ac9790d14b3 Mon Sep 17 00:00:00 2001 From: Brooks Swinnerton Date: Sun, 30 Nov 2014 13:27:59 -0500 Subject: [PATCH 02/78] Fixing typo in console mode --- common/command.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/common/command.c b/common/command.c index 971ef7f0af..380f2d8c08 100644 --- a/common/command.c +++ b/common/command.c @@ -302,7 +302,7 @@ static bool command_common(uint8_t code) #endif " " STR(BOOTLOADER_SIZE) "\n"); - print("GCC: " STR(__GNUC__) "." STR(__GNUC_MINOR__) "." STR(__GNUC_PATCHLEVEL__) + print("GCC: " STR(__GNUC__) "." STR(__GNUC_MINOR__) "." STR(__GNUC_PATCHLEVEL__) " AVR-LIBC: " __AVR_LIBC_VERSION_STRING__ " AVR_ARCH: avr" STR(__AVR_ARCH__) "\n"); break; @@ -541,12 +541,12 @@ static void mousekey_console_help(void) print("4: select mk_time_to_max\n"); print("5: select mk_wheel_max_speed\n"); print("6: select mk_wheel_time_to_max\n"); - print("p: print prameters\n"); + print("p: print parameters\n"); print("d: set default values\n"); - print("up: increase prameters(+1)\n"); - print("down: decrease prameters(-1)\n"); - print("pgup: increase prameters(+10)\n"); - print("pgdown: decrease prameters(-10)\n"); + print("up: increase parameters(+1)\n"); + print("down: decrease parameters(-1)\n"); + print("pgup: increase parameters(+10)\n"); + print("pgdown: decrease parameters(-10)\n"); print("\nspeed = delta * max_speed * (repeat / time_to_max)\n"); print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA); print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n"); From a6d33e2c98b16fdd3c7eaccb9e8c941d4315d528 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vlastimil=20Ov=C4=8D=C3=A1=C4=8D=C3=ADk?= Date: Sun, 28 Dec 2014 09:49:57 +0100 Subject: [PATCH 03/78] Added support for The Ghost Squid controller used for CM XT keyboard. - initial commit - created as clone of the kitten_paw subproject with pins adjusted for CM XT --- README.md | 3 + keyboard/ghost_squid/Makefile.lufa | 117 ++++++++++++++ keyboard/ghost_squid/README.md | 20 +++ keyboard/ghost_squid/config.h | 43 ++++++ keyboard/ghost_squid/keymap.c | 102 +++++++++++++ keyboard/ghost_squid/keymap_ansi.h | 23 +++ keyboard/ghost_squid/led.c | 60 ++++++++ keyboard/ghost_squid/matrix.c | 237 +++++++++++++++++++++++++++++ 8 files changed, 605 insertions(+) create mode 100644 keyboard/ghost_squid/Makefile.lufa create mode 100644 keyboard/ghost_squid/README.md create mode 100644 keyboard/ghost_squid/config.h create mode 100644 keyboard/ghost_squid/keymap.c create mode 100644 keyboard/ghost_squid/keymap_ansi.h create mode 100644 keyboard/ghost_squid/led.c create mode 100644 keyboard/ghost_squid/matrix.c diff --git a/README.md b/README.md index a01de8c6f8..550f1267de 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di * [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] [retired] * [KMAC](keyboard/kmac/) - Korean custom keyboard * [Lightsaber](keyboard/lightsaber/) - Korean custom keyboard +* [ghost_squid](keyboard/ghost_squid/) - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt] [GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930 [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047 @@ -72,6 +73,8 @@ You can find some keyboard specific projects under `converter` and `keyboard` di [PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801 [Sun]: http://en.wikipedia.org/wiki/Sun-3 [IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS +[ghost_squid]: http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid +[cmxt]: http://gaming.coolermaster.com/en/products/keyboards/quickfirext/ diff --git a/keyboard/ghost_squid/Makefile.lufa b/keyboard/ghost_squid/Makefile.lufa new file mode 100644 index 0000000000..61893893a4 --- /dev/null +++ b/keyboard/ghost_squid/Makefile.lufa @@ -0,0 +1,117 @@ +#---------------------------------------------------------------------------- +# On command line: +# +# make all = Make software. +# +# make clean = Clean out built project files. +# +# make coff = Convert ELF to AVR COFF. +# +# make extcoff = Convert ELF to AVR Extended COFF. +# +# make program = Download the hex file to the device. +# Please customize your programmer settings(PROGRAM_CMD) +# +# make teensy = Download the hex file to the device, using teensy_loader_cli. +# (must have teensy_loader_cli installed). +# +# make dfu = Download the hex file to the device, using dfu-programmer (must +# have dfu-programmer installed). +# +# make flip = Download the hex file to the device, using Atmel FLIP (must +# have Atmel FLIP installed). +# +# make dfu-ee = Download the eeprom file to the device, using dfu-programmer +# (must have dfu-programmer installed). +# +# make flip-ee = Download the eeprom file to the device, using Atmel FLIP +# (must have Atmel FLIP installed). +# +# make debug = Start either simulavr or avarice as specified for debugging, +# with avr-gdb or avr-insight as the front end for debugging. +# +# make filename.s = Just compile filename.c into the assembler code only. +# +# make filename.i = Create a preprocessed source file for use in submitting +# bug reports to the GCC project. +# +# To rebuild project do "make clean" then "make all". +#---------------------------------------------------------------------------- + +# Target file name (without extension). +TARGET = ghostsquid_lufa + +# Directory common source filess exist +TOP_DIR = ../.. + +# Directory keyboard dependent files exist +TARGET_DIR = . + +# List C source files here. (C dependencies are automatically generated.) +SRC = keymap.c \ + matrix.c \ + led.c + +CONFIG_H = config.h + +# MCU name +MCU = atmega32u2 + +# Processor frequency. +# This will define a symbol, F_CPU, in all source code files equal to the +# processor frequency in Hz. You can then use this symbol in your source code to +# calculate timings. Do NOT tack on a 'UL' at the end, this will be done +# automatically to create a 32-bit value in your source code. +# +# This will be an integer division of F_USB below, as it is sourced by +# F_USB after it has run through any CPU prescalers. Note that this value +# does not *change* the processor frequency - it should merely be updated to +# reflect the processor speed set externally so that the code can use accurate +# software delays. +F_CPU = 16000000 + +# +# LUFA specific +# +# Target architecture (see library "Board Types" documentation). +ARCH = AVR8 + +# Input clock frequency. +# This will define a symbol, F_USB, in all source code files equal to the +# input clock frequency (before any prescaling is performed) in Hz. This value may +# differ from F_CPU if prescaling is used on the latter, and is required as the +# raw input clock is fed directly to the PLL sections of the AVR for high speed +# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL' +# at the end, this will be done automatically to create a 32-bit value in your +# source code. +# +# If no clock division is performed on the input clock inside the AVR (via the +# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. +F_USB = $(F_CPU) + + +# Build Options +# comment out to disable the options. +# +#BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = yes # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +#CONSOLE_ENABLE = yes # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +#SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend +#NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA + + +# Boot Section Size in bytes +# Teensy halfKay 512 +# Atmel DFU loader 4096 +# LUFA bootloader 4096 +OPT_DEFS += -DBOOTLOADER_SIZE=4096 + +# Search Path +VPATH += $(TARGET_DIR) +VPATH += $(TOP_DIR) + +include $(TOP_DIR)/protocol/lufa.mk +include $(TOP_DIR)/common.mk +include $(TOP_DIR)/rules.mk diff --git a/keyboard/ghost_squid/README.md b/keyboard/ghost_squid/README.md new file mode 100644 index 0000000000..dda67e6ba1 --- /dev/null +++ b/keyboard/ghost_squid/README.md @@ -0,0 +1,20 @@ +The Ghost Squid controller +========================== +Custom controller for the Cooler Master QuickFire XT keyboard designed by bpiphany. + +*Note that this is not the official firmware* + +Build +----- +Move to this directory then just run `make` like: + + $ make -f Makefile.lufa + +At the moment only the LUFA stack is supported. + + +Bootloader +--------- +To enter bootloader by hardware use a magnet above the controller before connecting the usb cable. + +It is still possible to use Boot Magic and Command (LSFT+RSFT+PAUS) to access the bootloader though. diff --git a/keyboard/ghost_squid/config.h b/keyboard/ghost_squid/config.h new file mode 100644 index 0000000000..54f03143c1 --- /dev/null +++ b/keyboard/ghost_squid/config.h @@ -0,0 +1,43 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#ifndef CONFIG_H +#define CONFIG_H + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED // 0x2516 (original CM XT value) +#define PRODUCT_ID 0x001A +#define DEVICE_VER 0x0000 +#define MANUFACTURER Cooler Master +#define PRODUCT Cooler Master QuickFire XT + +/* message strings */ +#define DESCRIPTION t.m.k. keyboard firmware for Cooler Master QuickFire XT + +/* matrix size */ +#define MATRIX_ROWS 8 +#define MATRIX_COLS 18 + +/* Set 0 if need no debouncing */ +#define DEBOUNCE 5 + +/* key combination for command */ +#define IS_COMMAND() ( \ + keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \ +) + +#endif diff --git a/keyboard/ghost_squid/keymap.c b/keyboard/ghost_squid/keymap.c new file mode 100644 index 0000000000..e9ad9efe1a --- /dev/null +++ b/keyboard/ghost_squid/keymap.c @@ -0,0 +1,102 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#include +#include +#include +#include "keycode.h" +#include "action.h" +#include "action_macro.h" +#include "report.h" +#include "host.h" +#include "debug.h" +#include "keymap.h" + +/* + Matrix col/row mapping + + ,----. ,-------------------. ,-------------------. ,-------------------. ,--------------. + |06/6| |07/4|08/4|08/2|08/6| |15/5|11/6|12/2|12/4| |14/4|14/5|14/6|14/0| |13/5|13/7|15/7| + `----' `-------------------' `-------------------' `-------------------' `--------------' + ,-------------------------------------------------------------------------. ,--------------. ,-------------------. + |06/4|06/5|07/5|08/5|09/5|09/4|10/4|10/5|11/5|12/5|05/5|05/4|11/4| 14/2| |17/4|02/4|04/4| |16/1|17/1|04/1|04/0| + |-------------------------------------------------------------------------| |--------------| |-------------------| + |06/2 |06/7|07/7|08/7|09/7|09/2|10/2|10/7|11/7|12/7|05/7|05/2|11/2| 14/3| |16/4|02/5|04/5| |16/7|17/7|04/7| | + |-------------------------------------------------------------------------| '--------------' |-------------- 02/7| + |02/7 |06/3|07/3|08/3|09/3|09/6|10/6|10/3|11/3|12/3|05/3|05/6| 14/1| |16/2|17/2|04/2| | + |-------------------------------------------------------------------------| ,----. |-------------------| + |01/2 |06/1|07/1|08/1|09/1|09/0|10/0|10/1|11/1|12/1|05/0| 01/3| |02/6| |16/3|17/3|04/3| | + |-------------------------------------------------------------------------| ,--------------. |-------------- 02/3| + |15/4|03/2|13/6| 16/6 |13/0|0/3|12/0|15/1| |02/0|16/0|17/0| | 17/6 |04/6| | + `-------------------------------------------------------------------------' `--------------' `-------------------' +*/ + +#define KEYMAP( \ + KG6, KH4, KI4, KI2, KI6, KP5, KL6, KM2, KM4, KO4, KO5, KO6, KO0, KN5, KN7, KP7, \ + KG4, KG5, KH5, KI5, KJ5, KJ4, KK4, KK5, KL5, KM5, KF5, KF4, KL4, KO2, KR4, KC4, KE4, KQ1, KR1, KE1, KE0, \ + KG2, KG7, KH7, KI7, KJ7, KJ2, KK2, KK7, KL7, KM7, KF7, KF2, KL2, KO3, KQ4, KC5, KE5, KQ7, KR7, KE7, KC7, \ + KH2, KG3, KH3, KI3, KJ3, KJ6, KK6, KK3, KL3, KM3, KF3, KF6, KO1, KQ2, KR2, KE2, \ + KB2, KH6, KG1, KH1, KI1, KJ1, KJ0, KK0, KK1, KL1, KM1, KF0, KB3, KC6, KQ3, KR3, KE3, KC3, \ + KP4, KD2, KN6, KQ6, KN0, KA3, KM0, KP1, KC0, KQ0, KR0, KR6, KE6 \ +) { \ +/* 0 1 2 3 4 5 6 7 */ \ +/* A 0 */ {KC_NO, KC_NO, KC_NO, KC_##KA3, KC_NO, KC_NO, KC_NO, KC_NO },\ +/* B 1 */ {KC_NO, KC_NO, KC_##KB2, KC_##KB3, KC_NO, KC_NO, KC_NO, KC_NO },\ +/* C 2 */ {KC_##KC0, KC_NO, KC_NO, KC_##KC3, KC_##KC4, KC_##KC5, KC_##KC6, KC_##KC7},\ +/* D 3 */ {KC_NO, KC_NO, KC_##KD2, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO },\ +/* E 4 */ {KC_##KE0, KC_##KE1, KC_##KE2, KC_##KE3, KC_##KE4, KC_##KE5, KC_##KE6, KC_##KE7},\ +/* F 5 */ {KC_##KF0, KC_NO, KC_##KF2, KC_##KF3, KC_##KF4, KC_##KF5, KC_##KF6, KC_##KF7},\ +/* G 6 */ {KC_NO, KC_##KG1, KC_##KG2, KC_##KG3, KC_##KG4, KC_##KG5, KC_##KG6, KC_##KG7},\ +/* H 7 */ {KC_NO, KC_##KH1, KC_##KH2, KC_##KH3, KC_##KH4, KC_##KH5, KC_##KH6, KC_##KH7},\ +/* I 8 */ {KC_NO, KC_##KI1, KC_##KI2, KC_##KI3, KC_##KI4, KC_##KI5, KC_##KI6, KC_##KI7},\ +/* J 9 */ {KC_##KJ0, KC_##KJ1, KC_##KJ2, KC_##KJ3, KC_##KJ4, KC_##KJ5, KC_##KJ6, KC_##KJ7},\ +/* K 10 */ {KC_##KK0, KC_##KK1, KC_##KK2, KC_##KK3, KC_##KK4, KC_##KK5, KC_##KK6, KC_##KK7},\ +/* L 11 */ {KC_NO, KC_##KL1, KC_##KL2, KC_##KL3, KC_##KL4, KC_##KL5, KC_##KL6, KC_##KL7},\ +/* M 12 */ {KC_##KM0, KC_##KM1, KC_##KM2, KC_##KM3, KC_##KM4, KC_##KM5, KC_NO, KC_##KM7},\ +/* N 13 */ {KC_##KN0, KC_NO, KC_NO, KC_NO, KC_NO, KC_##KN5, KC_##KN6, KC_##KN7},\ +/* O 14 */ {KC_##KO0, KC_##KO1, KC_##KO2, KC_##KO3, KC_##KO4, KC_##KO5, KC_##KO6, KC_NO },\ +/* P 15 */ {KC_NO, KC_##KP1, KC_NO, KC_NO, KC_##KP4, KC_##KP5, KC_NO, KC_##KP7},\ +/* Q 16 */ {KC_##KQ0, KC_##KQ1, KC_##KQ2, KC_##KQ3, KC_##KQ4, KC_NO, KC_##KQ6, KC_##KQ7},\ +/* R 17 */ {KC_##KR0, KC_##KR1, KC_##KR2, KC_##KR3, KC_##KR4, KC_NO, KC_##KR6, KC_##KR7} \ +} + +#include "keymap_ansi.h" + +#define KEYMAPS_SIZE (sizeof(keymaps) / sizeof(keymaps[0])) +#define FN_ACTIONS_SIZE (sizeof(fn_actions) / sizeof(fn_actions[0])) + +/* translates key to keycode */ +uint8_t keymap_key_to_keycode(uint8_t layer, keypos_t key) +{ + if (layer < KEYMAPS_SIZE) { + return pgm_read_byte(&keymaps[(layer)][(key.col)][(key.row)]); + } else { + return pgm_read_byte(&keymaps[0][(key.col)][(key.row)]); + } +} + +/* translates Fn keycode to action */ +action_t keymap_fn_to_action(uint8_t keycode) +{ + action_t action; + if (FN_INDEX(keycode) < FN_ACTIONS_SIZE) { + action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]); + } else { + action.code = ACTION_NO; + } + return action; +} diff --git a/keyboard/ghost_squid/keymap_ansi.h b/keyboard/ghost_squid/keymap_ansi.h new file mode 100644 index 0000000000..ed1088baa9 --- /dev/null +++ b/keyboard/ghost_squid/keymap_ansi.h @@ -0,0 +1,23 @@ + +static const uint8_t PROGMEM keymaps[][MATRIX_COLS][MATRIX_ROWS] = { + /* Layer 0: Standard ANSI layer */ + KEYMAP(\ + ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, PSCR,SLCK,PAUS, \ + GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS, EQL,BSPC, INS, HOME,PGUP, NLCK,PSLS,PAST,PMNS, \ + TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSLS, DEL, END, PGDN, P7, P8, P9, PPLS, \ + CAPS,A, S, D, F, G, H, J, K, L, SCLN,QUOT, ENT, P4, P5, P6, \ + LSFT,NUBS,Z, X, C, V, B, N, M, COMM,DOT, SLSH, RSFT, UP, P1, P2, P3, PENT, \ + LCTL,LGUI,LALT, SPC, RALT,RGUI, FN0,RCTL, LEFT,DOWN,RGHT, P0, PDOT), \ + /* Layer 1: Function layer */ + KEYMAP(\ + CALC,MYCM,WSCH,WHOM,MAIL,VOLD,VOLU,MSEL,MSTP,MPLY,MPRV,MNXT,TRNS, WAKE, PWR,SLEP, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, TRNS,TRNS,TRNS, TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, TRNS,TRNS,TRNS, TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, TRNS, TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS, TRNS, TRNS, TRNS,TRNS,TRNS,TRNS, \ + TRNS,TRNS,TRNS, TRNS, TRNS,TRNS,TRNS,TRNS, TRNS,TRNS,TRNS, TRNS,TRNS) +}; + +static const uint16_t PROGMEM fn_actions[] = { + [0] = ACTION_LAYER_MOMENTARY(1) +}; diff --git a/keyboard/ghost_squid/led.c b/keyboard/ghost_squid/led.c new file mode 100644 index 0000000000..da5dbd7ae2 --- /dev/null +++ b/keyboard/ghost_squid/led.c @@ -0,0 +1,60 @@ +/* +Copyright 2014 Ralf Schmitt + +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 . +*/ + +#include +#include "stdint.h" +#include "led.h" + +/* LED pin configuration + * + * Scroll Lock PB7 + * CAPS PC6 + * NUMLOCK PC5 + * + */ +void led_set(uint8_t usb_led) +{ + DDRB |= (1<<7); + DDRC |= (1<<5) | (1<<6); + + if (usb_led & (1< + +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 . +*/ + +#include +#include +#include +#include +#include "print.h" +#include "debug.h" +#include "util.h" +#include "matrix.h" + +#ifndef DEBOUNCE +# define DEBOUNCE 0 +#endif +static uint8_t debouncing = DEBOUNCE; + +static matrix_row_t matrix[MATRIX_ROWS]; +static matrix_row_t matrix_debouncing[MATRIX_ROWS]; + +static uint8_t read_rows(void); +static void init_rows(void); +static void unselect_cols(void); +static void select_col(uint8_t col); + +inline uint8_t matrix_rows(void) +{ + return MATRIX_ROWS; +} + +inline uint8_t matrix_cols(void) +{ + return MATRIX_COLS; +} + +void matrix_init(void) +{ + unselect_cols(); + init_rows(); + for (uint8_t i=0; i < MATRIX_ROWS; i++) { + matrix[i] = 0; + matrix_debouncing[i] = 0; + } +} + +uint8_t matrix_scan(void) +{ + for (uint8_t col = 0; col < MATRIX_COLS; col++) { + select_col(col); + _delay_us(3); + uint8_t rows = read_rows(); + for (uint8_t row = 0; row < MATRIX_ROWS; row++) { + bool prev_bit = matrix_debouncing[row] & ((matrix_row_t)1< Date: Sat, 3 Jan 2015 15:10:45 +0200 Subject: [PATCH 04/78] Update other_projects.md - added TMK/Ergodox --- doc/other_projects.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/other_projects.md b/doc/other_projects.md index ce24e0ab5c..bf980b0a9e 100644 --- a/doc/other_projects.md +++ b/doc/other_projects.md @@ -29,6 +29,7 @@ Other Keyboard Firmware Projects ## ErgoDox[Ergo][Split][USB][AVR] - - +- ## Suka's keyboard collection[Ergo][Split][3DPrinting][USB][AVR] - From 05795cb0034e885bec37f782cfc6bddcae262637 Mon Sep 17 00:00:00 2001 From: tmk Date: Wed, 26 Nov 2014 11:25:45 +0900 Subject: [PATCH 05/78] Compensate timer during prower down --- common/avr/suspend.c | 27 ++++++++++++++++----------- common/suspend.h | 2 +- keyboard/hhkb_rn42/MEMO.txt | 7 +++++++ keyboard/hhkb_rn42/matrix.c | 2 +- keyboard/hhkb_rn42/rn42/main.c | 2 +- protocol/lufa/lufa.c | 2 +- 6 files changed, 27 insertions(+), 15 deletions(-) diff --git a/common/avr/suspend.c b/common/avr/suspend.c index 66a579fd78..80243f02bc 100644 --- a/common/avr/suspend.c +++ b/common/avr/suspend.c @@ -7,6 +7,7 @@ #include "backlight.h" #include "suspend_avr.h" #include "suspend.h" +#include "timer.h" #ifdef PROTOCOL_LUFA #include "lufa.h" #endif @@ -52,11 +53,13 @@ void suspend_idle(uint8_t time) * WDTO_4S * WDTO_8S */ -void suspend_power_down(uint8_t wdto) +static uint8_t wdt_timeout = 0; +static void power_down(uint8_t wdto) { #ifdef PROTOCOL_LUFA if (USB_DeviceState == DEVICE_STATE_Configured) return; #endif + wdt_timeout = wdto; // Watchdog Interrupt Mode wdt_intr_enable(wdto); @@ -67,7 +70,6 @@ void suspend_power_down(uint8_t wdto) // - prescale clock // - BOD disable // - Power Reduction Register PRR - set_sleep_mode(SLEEP_MODE_PWR_DOWN); sleep_enable(); sei(); @@ -78,6 +80,11 @@ void suspend_power_down(uint8_t wdto) wdt_disable(); } +void suspend_power_down(void) +{ + power_down(WDTO_15MS); +} + bool suspend_wakeup_condition(void) { matrix_power_up(); @@ -103,15 +110,13 @@ void suspend_wakeup_init(void) /* watchdog timeout */ ISR(WDT_vect) { - /* wakeup from MCU sleep mode */ -/* - // blink LED - static uint8_t led_state = 0; - static uint8_t led_count = 0; - led_count++; - if ((led_count & 0x07) == 0) { - led_set((led_state ^= (1< Date: Wed, 26 Nov 2014 11:42:53 +0900 Subject: [PATCH 06/78] Fix USB plug-in while BT mode falls to be enumerated --- keyboard/hhkb_rn42/matrix.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/keyboard/hhkb_rn42/matrix.c b/keyboard/hhkb_rn42/matrix.c index 513a271e4e..22becd1050 100644 --- a/keyboard/hhkb_rn42/matrix.c +++ b/keyboard/hhkb_rn42/matrix.c @@ -183,7 +183,7 @@ void matrix_power_up(void) { void matrix_power_down(void) { if (!matrix_power) return; // doesn't power save while USB connection is active - if (USB_DeviceState == DEVICE_STATE_Configured) return; + if (USB_DeviceState != DEVICE_STATE_Unattached) return; if (timer_elapsed32(matrix_last_modified) <= MATRIX_POWER_SAVE) return; KEY_POWER_OFF(); suspend_power_down(); From 20caf673d8ba7fb7675e2559bfebad6ddb9d6fd0 Mon Sep 17 00:00:00 2001 From: tmk Date: Sat, 29 Nov 2014 20:47:15 +0900 Subject: [PATCH 07/78] Fix lufa sendchar() infinite wait loop - FrameNumber is not updated when adapter powered - can be blocked in sendchar() when pluged into AC adapter --- keyboard/hhkb_rn42/rn42/main.c | 3 ++- protocol/lufa/lufa.c | 36 +++++++++++++++++----------------- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/keyboard/hhkb_rn42/rn42/main.c b/keyboard/hhkb_rn42/rn42/main.c index a3a37c0747..42b09d8c8c 100644 --- a/keyboard/hhkb_rn42/rn42/main.c +++ b/keyboard/hhkb_rn42/rn42/main.c @@ -17,8 +17,8 @@ static int8_t sendchar_func(uint8_t c) { - sendchar(c); // LUFA xmit(c); // SUART + sendchar(c); // LUFA return 0; } @@ -85,6 +85,7 @@ int main(void) print("Keyboard start.\n"); while (1) { while (USB_DeviceState == DEVICE_STATE_Suspended) { + print("[s]"); suspend_power_down(); if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) { USB_Device_SendRemoteWakeup(); diff --git a/protocol/lufa/lufa.c b/protocol/lufa/lufa.c index ee15b7f455..3d6b3ea00c 100644 --- a/protocol/lufa/lufa.c +++ b/protocol/lufa/lufa.c @@ -148,6 +148,7 @@ static void Console_Task(void) */ void EVENT_USB_Device_Connect(void) { + print("[C]"); /* For battery powered device */ if (!USB_IsInitialized) { USB_Init(); @@ -157,6 +158,7 @@ void EVENT_USB_Device_Connect(void) void EVENT_USB_Device_Disconnect(void) { + print("[D]"); /* For battery powered device */ /* TODO: This doesn't work. After several plug in/outs can not be enumerated. if (USB_IsInitialized) { @@ -169,10 +171,12 @@ void EVENT_USB_Device_Disconnect(void) void EVENT_USB_Device_Reset(void) { + print("[R]"); } void EVENT_USB_Device_Suspend() { + print("[S]"); #ifdef SLEEP_LED_ENABLE sleep_led_enable(); #endif @@ -180,6 +184,7 @@ void EVENT_USB_Device_Suspend() void EVENT_USB_Device_WakeUp() { + print("[W]"); suspend_wakeup_init(); #ifdef SLEEP_LED_ENABLE @@ -489,37 +494,28 @@ int8_t sendchar(uint8_t c) uint8_t ep = Endpoint_GetCurrentEndpoint(); Endpoint_SelectEndpoint(CONSOLE_IN_EPNUM); if (!Endpoint_IsEnabled() || !Endpoint_IsConfigured()) { - Endpoint_SelectEndpoint(ep); - return -1; + goto ERROR_EXIT; } if (timeouted && !Endpoint_IsReadWriteAllowed()) { - Endpoint_SelectEndpoint(ep); - return - 1; + goto ERROR_EXIT; } timeouted = false; uint8_t timeout = SEND_TIMEOUT; - uint16_t prevFN = USB_Device_GetFrameNumber(); while (!Endpoint_IsReadWriteAllowed()) { - switch (USB_DeviceState) { - case DEVICE_STATE_Unattached: - case DEVICE_STATE_Suspended: - return -1; + if (USB_DeviceState != DEVICE_STATE_Configured) { + goto ERROR_EXIT; } if (Endpoint_IsStalled()) { - Endpoint_SelectEndpoint(ep); - return -1; + goto ERROR_EXIT; } - if (prevFN != USB_Device_GetFrameNumber()) { - if (!(timeout--)) { - timeouted = true; - Endpoint_SelectEndpoint(ep); - return -1; - } - prevFN = USB_Device_GetFrameNumber(); + if (!(timeout--)) { + timeouted = true; + goto ERROR_EXIT; } + _delay_ms(1); } Endpoint_Write_8(c); @@ -530,6 +526,9 @@ int8_t sendchar(uint8_t c) Endpoint_SelectEndpoint(ep); return 0; +ERROR_EXIT: + Endpoint_SelectEndpoint(ep); + return -1; } #else int8_t sendchar(uint8_t c) @@ -587,6 +586,7 @@ int main(void) print("Keyboard start.\n"); while (1) { while (USB_DeviceState == DEVICE_STATE_Suspended) { + print("[s]"); suspend_power_down(); if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) { USB_Device_SendRemoteWakeup(); From 570bcb2ed112b3435a09b974c20138f13de6aaaa Mon Sep 17 00:00:00 2001 From: tmk Date: Sat, 29 Nov 2014 21:12:47 +0900 Subject: [PATCH 08/78] Add LUFA device state to command info --- keyboard/hhkb_rn42/rn42/rn42_task.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/keyboard/hhkb_rn42/rn42/rn42_task.c b/keyboard/hhkb_rn42/rn42/rn42_task.c index c3359ed506..6686268624 100644 --- a/keyboard/hhkb_rn42/rn42/rn42_task.c +++ b/keyboard/hhkb_rn42/rn42/rn42_task.c @@ -197,6 +197,8 @@ bool command_extra(uint8_t code) xprintf("rn42_linked(): %X\n", rn42_linked()); xprintf("rn42_rts(): %X\n", rn42_rts()); xprintf("config_mode: %X\n", config_mode); + xprintf("USB_DeviceState: %X\n", USB_DeviceState); + xprintf("USB_Device_RemoteWakeupEnabled: %X\n", USB_Device_RemoteWakeupEnabled); xprintf("VBUS: %X\n", USBSTA&(1< Date: Sat, 29 Nov 2014 21:14:00 +0900 Subject: [PATCH 09/78] Update MEMO --- keyboard/hhkb_rn42/MEMO.txt | 58 +++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) diff --git a/keyboard/hhkb_rn42/MEMO.txt b/keyboard/hhkb_rn42/MEMO.txt index 062ee3399a..e623c00133 100644 --- a/keyboard/hhkb_rn42/MEMO.txt +++ b/keyboard/hhkb_rn42/MEMO.txt @@ -9,33 +9,84 @@ Bug: - Do not power-down during USB connection is active - DONE 11/11 (USB_DeviceState == USB_DEVICE_Configured) is used to check USB connection matrix_power_down() matrix.c - 11/23 + +- When given power only from wall wart adapter + - it sleeps. it should not sleep + - Configured state without USB connection? + - timer is slow while power down - DONE 11/26 - time out interrupt is lost while power down? - interrupt of watchdog timer compensates timer counter(avr/suspend.c) +- USB plug-in while BT failes + - it ends in suspend state + - maybe, not responsive to host enumeration process due to power-down. + - matrix_power_down() only when state is unattached - 11/26 + - need to observe a while +- repeated CHARGING/FULL_CHARGED + - In LTC sharp pulses are observed. + - MCP has no pulse but still has a problem. + - needs more wait before read pin state? +- wrongly suspended when powered from adapter without USB connection + - suspend event may occur when plug into adapter + - and never wake until conected to real USB line + - without debug print via USB no problem; CSW(wake just after suspend as real USB line) + - seems like USB print causes this problem after suspended + Todo: +- sendchar() in lufa.c block loop - 11/29 + - block loop when powered with AC adapter + - FrameNumber is not updated when adapter powered +- sendchar() in lufa.c no buffer + - no buffering. character lost can be caused. Design: - suspend.h - DONE 11/26 - remove argument from suspend_power_down() for backward compatitibility -- remove MCU dependent power saving code from core/keyboard - - it should be located in project matrix.c - DONE 11/23 +- remove MCU dependent power saving code from core/keyboard - DONE 11/23 + - it should be located in project matrix.c - HHKB matrix.c needs matrix_prev? - is_modified() is obsolete now. really needs? +- ADC: removing AREF capacitor C10 + - seems to be better while usb powered + - still bad while battery powered + http://electronics.stackexchange.com/questions/105849/avcc-and-capacitor-using-adc +- ADC: smaller resistors for voltage dividor + - 1K + 1K: not improved. - 11/27 LUFA: USB connection check: state of USB deivce - USB_DeviceState: USB_Deivce_State_t { Unattached, Powered, Default, Addressed, Configured*, Suspended* } + Unattached: unpluged + Powered: pluged with power adapter + Default: enumerate process bigin + Addressed: addressed + Configured: enumerated + Suspended: suspended + - USB_IsInitialized: state of LUFA core setup becomes true in USB_Init() USBController_AVR8.c becomes false in USB_Disable() USBController_AVR8.c - USB_VBUS_GetStatus(): state of VBUS(power/connection) - USB_Disable() detaches, disables all interrupts, controller, PLL, regulater. +- When connect to power adapter + - event happened: CW or CSW or C or DDC + - USB state: not configured + +- USB evnets + - USB connect: CSWRWRW + - USB connect but fail to enumeration: CWRWRWRWS + - USB disconnect: D + - Power adapter connect: CW, CSW, C + - Power adapter disconnect: D + Power saving: +- matrix power saving + - power saving while externally powered and not while unpluged - confirm suspend mode lufa.c: matrix_power_*, suspend_wakeup_condition - 8MHz clock - When not connected in a few minutes get into deep sleep to save battery life @@ -63,6 +114,9 @@ Improving: - ADC resolution AVR120 AVR32138 + - Enhancing ADC resolution by oversampling + AVR121 http://www.atmel.com/images/doc8003.pdf + Testing: - Factroy reset doesn't work; need to **test again** 10K pull-up is too high? From 825be9d121a9c698bf60bbdc384f2eeaf66f60d0 Mon Sep 17 00:00:00 2001 From: tmk Date: Tue, 2 Dec 2014 22:47:59 +0900 Subject: [PATCH 10/78] Disable input buffer for ADC --- keyboard/hhkb_rn42/rn42/battery.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/keyboard/hhkb_rn42/rn42/battery.c b/keyboard/hhkb_rn42/rn42/battery.c index 0320e1baf1..720d63bebb 100644 --- a/keyboard/hhkb_rn42/rn42/battery.c +++ b/keyboard/hhkb_rn42/rn42/battery.c @@ -21,6 +21,10 @@ void battery_init(void) ADMUX = (1< Date: Wed, 3 Dec 2014 02:08:27 +0900 Subject: [PATCH 11/78] Clean ADC code of battery_voltage() --- keyboard/hhkb_rn42/rn42/battery.c | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/keyboard/hhkb_rn42/rn42/battery.c b/keyboard/hhkb_rn42/rn42/battery.c index 720d63bebb..3ecde52234 100644 --- a/keyboard/hhkb_rn42/rn42/battery.c +++ b/keyboard/hhkb_rn42/rn42/battery.c @@ -20,7 +20,6 @@ void battery_init(void) // Ref:2.56V band-gap, Input:ADC0(PF0), Prescale:128(16MHz/128=125KHz) ADMUX = (1< Date: Wed, 3 Dec 2014 02:17:54 +0900 Subject: [PATCH 12/78] Fix: enable digital input for PF5 --- keyboard/hhkb_rn42/rn42/battery.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/keyboard/hhkb_rn42/rn42/battery.c b/keyboard/hhkb_rn42/rn42/battery.c index 3ecde52234..34aa18446c 100644 --- a/keyboard/hhkb_rn42/rn42/battery.c +++ b/keyboard/hhkb_rn42/rn42/battery.c @@ -21,7 +21,7 @@ void battery_init(void) ADMUX = (1< Date: Wed, 3 Dec 2014 14:22:10 +0900 Subject: [PATCH 13/78] Add wait for charging capacitance of ADC S/H --- keyboard/hhkb_rn42/rn42/battery.c | 1 + 1 file changed, 1 insertion(+) diff --git a/keyboard/hhkb_rn42/rn42/battery.c b/keyboard/hhkb_rn42/rn42/battery.c index 34aa18446c..7e868c9646 100644 --- a/keyboard/hhkb_rn42/rn42/battery.c +++ b/keyboard/hhkb_rn42/rn42/battery.c @@ -92,6 +92,7 @@ uint16_t battery_voltage(void) volatile uint16_t bat; ADCSRA |= (1< Date: Wed, 3 Dec 2014 15:50:02 +0900 Subject: [PATCH 14/78] Fix power saving while USB suspended - doesn't pwoer save while Bluetooth turns on --- keyboard/hhkb_rn42/hhkb_avr.h | 4 +++- keyboard/hhkb_rn42/matrix.c | 21 ++++++++++----------- keyboard/hhkb_rn42/rn42/main.c | 14 +++++++++++--- protocol/lufa/lufa.c | 3 +++ 4 files changed, 27 insertions(+), 15 deletions(-) diff --git a/keyboard/hhkb_rn42/hhkb_avr.h b/keyboard/hhkb_rn42/hhkb_avr.h index f007d7667a..0321977d11 100644 --- a/keyboard/hhkb_rn42/hhkb_avr.h +++ b/keyboard/hhkb_rn42/hhkb_avr.h @@ -53,9 +53,11 @@ static inline void KEY_POWER_OFF(void) { DDRB = 0x00; PORTB = 0xFF; // change pins input with pull-up DDRD |= (1<<4); PORTD &= ~(1<<4); // MOS FET switch off } +static inline bool KEY_POWER_STATE(void) { return PORTD & (1<<4); } #else static inline void KEY_POWER_ON(void) {} static inline void KEY_POWER_OFF(void) {} +static inline bool KEY_POWER_STATE(void) { return true; } #endif static inline void KEY_INIT(void) { @@ -73,7 +75,7 @@ static inline void KEY_INIT(void) KEY_UNABLE(); KEY_PREV_OFF(); - KEY_POWER_ON(); + KEY_POWER_OFF(); } static inline void KEY_SELECT(uint8_t ROW, uint8_t COL) { diff --git a/keyboard/hhkb_rn42/matrix.c b/keyboard/hhkb_rn42/matrix.c index 22becd1050..fb96997944 100644 --- a/keyboard/hhkb_rn42/matrix.c +++ b/keyboard/hhkb_rn42/matrix.c @@ -35,7 +35,6 @@ along with this program. If not, see . // matrix power saving #define MATRIX_POWER_SAVE 10000 static uint32_t matrix_last_modified = 0; -static bool matrix_power = true; // matrix state buffer(1:on, 0:off) static matrix_row_t *matrix; @@ -80,7 +79,8 @@ uint8_t matrix_scan(void) matrix_prev = matrix; matrix = tmp; - matrix_power_up(); + // power on + if (!KEY_POWER_STATE()) KEY_POWER_ON(); for (uint8_t row = 0; row < MATRIX_ROWS; row++) { for (uint8_t col = 0; col < MATRIX_COLS; col++) { KEY_SELECT(row, col); @@ -136,7 +136,14 @@ uint8_t matrix_scan(void) } if (matrix[row] ^ matrix_prev[row]) matrix_last_modified = timer_read32(); } - matrix_power_down(); + // power off + if (KEY_POWER_STATE() && + (USB_DeviceState == DEVICE_STATE_Suspended || + USB_DeviceState == DEVICE_STATE_Unattached ) && + timer_elapsed32(matrix_last_modified) > MATRIX_POWER_SAVE) { + KEY_POWER_OFF(); + suspend_power_down(); + } return 1; } @@ -176,16 +183,8 @@ void matrix_print(void) } void matrix_power_up(void) { - if (matrix_power) return; KEY_POWER_ON(); - matrix_power = true; } void matrix_power_down(void) { - if (!matrix_power) return; - // doesn't power save while USB connection is active - if (USB_DeviceState != DEVICE_STATE_Unattached) return; - if (timer_elapsed32(matrix_last_modified) <= MATRIX_POWER_SAVE) return; KEY_POWER_OFF(); - suspend_power_down(); - matrix_power = false; } diff --git a/keyboard/hhkb_rn42/rn42/main.c b/keyboard/hhkb_rn42/rn42/main.c index 42b09d8c8c..83d9950388 100644 --- a/keyboard/hhkb_rn42/rn42/main.c +++ b/keyboard/hhkb_rn42/rn42/main.c @@ -63,7 +63,7 @@ int main(void) USB_USBTask(); #endif } - print("USB configured.\n"); + print("\nUSB init\n"); rn42_init(); rn42_task_init(); @@ -82,10 +82,18 @@ int main(void) sleep_led_init(); #endif - print("Keyboard start.\n"); + print("Keyboard start\n"); while (1) { - while (USB_DeviceState == DEVICE_STATE_Suspended) { + while (rn42_rts() && // RN42 is off + USB_DeviceState == DEVICE_STATE_Suspended) { print("[s]"); + matrix_power_down(); + suspend_power_down(); + suspend_power_down(); + suspend_power_down(); + suspend_power_down(); + suspend_power_down(); + suspend_power_down(); suspend_power_down(); if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) { USB_Device_SendRemoteWakeup(); diff --git a/protocol/lufa/lufa.c b/protocol/lufa/lufa.c index 3d6b3ea00c..cdfc7bc6ad 100644 --- a/protocol/lufa/lufa.c +++ b/protocol/lufa/lufa.c @@ -151,6 +151,7 @@ void EVENT_USB_Device_Connect(void) print("[C]"); /* For battery powered device */ if (!USB_IsInitialized) { + USB_Disable(); USB_Init(); USB_Device_EnableSOFEvents(); } @@ -160,6 +161,7 @@ void EVENT_USB_Device_Disconnect(void) { print("[D]"); /* For battery powered device */ + USB_IsInitialized = false; /* TODO: This doesn't work. After several plug in/outs can not be enumerated. if (USB_IsInitialized) { USB_Disable(); // Disable all interrupts @@ -177,6 +179,7 @@ void EVENT_USB_Device_Reset(void) void EVENT_USB_Device_Suspend() { print("[S]"); + matrix_power_down(); #ifdef SLEEP_LED_ENABLE sleep_led_enable(); #endif From 160e02d06a11682d994da905adb1345bc1dde249 Mon Sep 17 00:00:00 2001 From: tmk Date: Mon, 8 Dec 2014 12:22:33 +0900 Subject: [PATCH 15/78] Change RN42 state display --- keyboard/hhkb_rn42/rn42/rn42_task.c | 42 ++++++++++++++++------------- 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/keyboard/hhkb_rn42/rn42/rn42_task.c b/keyboard/hhkb_rn42/rn42/rn42_task.c index 6686268624..1ad38d3722 100644 --- a/keyboard/hhkb_rn42/rn42/rn42_task.c +++ b/keyboard/hhkb_rn42/rn42/rn42_task.c @@ -96,18 +96,6 @@ void rn42_task(void) battery_led(LED_CHARGER); } - static uint8_t prev_status = UNKNOWN; - if (bs != prev_status) { - prev_status = bs; - switch (bs) { - case FULL_CHARGED: xprintf("FULL_CHARGED\n"); break; - case CHARGING: xprintf("CHARGING\n"); break; - case DISCHARGING: xprintf("DISCHARGING\n"); break; - case LOW_VOLTAGE: xprintf("LOW_VOLTAGE\n"); break; - default: xprintf("UNKNOWN STATUS\n"); break; - }; - } - /* every minute */ uint32_t t = timer_read32()/1000; if (t%60 == 0) { @@ -193,15 +181,33 @@ bool command_extra(uint8_t code) print("\n----- RN-42 info -----\n"); xprintf("protocol: %s\n", (host_get_driver() == &rn42_driver) ? "RN-42" : "LUFA"); xprintf("force_usb: %X\n", force_usb); + xprintf("rn42: %s\n", rn42_rts() ? "OFF" : (rn42_linked() ? "CONN" : "ON")); xprintf("rn42_autoconnecting(): %X\n", rn42_autoconnecting()); - xprintf("rn42_linked(): %X\n", rn42_linked()); - xprintf("rn42_rts(): %X\n", rn42_rts()); xprintf("config_mode: %X\n", config_mode); - xprintf("USB_DeviceState: %X\n", USB_DeviceState); - xprintf("USB_Device_RemoteWakeupEnabled: %X\n", USB_Device_RemoteWakeupEnabled); + xprintf("USB State: %s\n", + (USB_DeviceState == DEVICE_STATE_Unattached) ? "Unattached" : + (USB_DeviceState == DEVICE_STATE_Powered) ? "Powered" : + (USB_DeviceState == DEVICE_STATE_Default) ? "Default" : + (USB_DeviceState == DEVICE_STATE_Addressed) ? "Addressed" : + (USB_DeviceState == DEVICE_STATE_Configured) ? "Configured" : + (USB_DeviceState == DEVICE_STATE_Suspended) ? "Suspended" : "?"); + xprintf("battery: "); + switch (battery_status()) { + case FULL_CHARGED: xprintf("FULL"); break; + case CHARGING: xprintf("CHARG"); break; + case DISCHARGING: xprintf("DISCHG"); break; + case LOW_VOLTAGE: xprintf("LOW"); break; + default: xprintf("?"); break; + }; + xprintf("\n"); + xprintf("RemoteWakeupEnabled: %X\n", USB_Device_RemoteWakeupEnabled); xprintf("VBUS: %X\n", USBSTA&(1< Date: Fri, 12 Dec 2014 08:25:16 +0900 Subject: [PATCH 16/78] Update doc --- keyboard/hhkb_rn42/MEMO.txt | 566 +++++++------------------------ keyboard/hhkb_rn42/PowerSave.txt | 13 + 2 files changed, 128 insertions(+), 451 deletions(-) diff --git a/keyboard/hhkb_rn42/MEMO.txt b/keyboard/hhkb_rn42/MEMO.txt index e623c00133..f2aaa7c046 100644 --- a/keyboard/hhkb_rn42/MEMO.txt +++ b/keyboard/hhkb_rn42/MEMO.txt @@ -4,7 +4,7 @@ Roving RN-42 Bug: - with Nexus5 keyboard and mouse are very laggy. -- lose USB connection during power-down mode +- lose USB connection during power-down mode - DONE - USB initialize code in main() causes this - WRONG - Do not power-down during USB connection is active - DONE 11/11 (USB_DeviceState == USB_DEVICE_Configured) is used to check USB connection @@ -18,7 +18,7 @@ Bug: - time out interrupt is lost while power down? - interrupt of watchdog timer compensates timer counter(avr/suspend.c) -- USB plug-in while BT failes +- USB plug-in fails while BT - it ends in suspend state - maybe, not responsive to host enumeration process due to power-down. - matrix_power_down() only when state is unattached - 11/26 @@ -26,19 +26,49 @@ Bug: - repeated CHARGING/FULL_CHARGED - In LTC sharp pulses are observed. - MCP has no pulse but still has a problem. - - needs more wait before read pin state? -- wrongly suspended when powered from adapter without USB connection + - needs more wait before read pin state? - NO +- wrongly suspended when powered from adapter without USB connection - DONE - suspend event may occur when plug into adapter - and never wake until conected to real USB line - without debug print via USB no problem; CSW(wake just after suspend as real USB line) - seems like USB print causes this problem after suspended +- Factory Reset PIO4 doesn't work + - the reason is unclear - 12/08 NOT LOOK INTO ANY MORE + - WORKAROUND: use serial pins(3.3V, GND, RX and TX) + - SF,1 and R,1 to set factory defalult + + Todo: -- sendchar() in lufa.c block loop - 11/29 - - block loop when powered with AC adapter - - FrameNumber is not updated when adapter powered +- LED cover and switch knob and new Slide Switch +- RN42 auto configuration + - configure the module as HID device every time powering up + - this'll reduce work load of assembly + +- move rn42 to protocol directory when it becomes reusable stack + - sendchar() in lufa.c no buffer - no buffering. character lost can be caused. +- LUFA sendchar should be buffered and serial_uart.c buffur size is too large(256). + +- switch BT host connections +- BT operations + - disconnect + - new connection + - switch next connection + - remove connection + +- sendchar() in lufa.c block loop - DONE 11/29 + - block loop when powered with AC adapter + - FrameNumber is not updated when adapter powered + +Improving: +- ADC resolution + AVR120 + AVR32138 + - Enhancing ADC resolution by oversampling + AVR121 http://www.atmel.com/images/doc8003.pdf + - disable digital input buffer DIDR(7.8.6) Design: - suspend.h - DONE 11/26 @@ -85,6 +115,24 @@ USB connection check: state of USB deivce Power saving: +- Pro2 current consumption + - active: 138.2mA(no device on Hub) + - suspended: 30.9mA(WakeUp enabled DIPSW6) + - suspended: 0mA->46.0mA(WakeUp disabled DIPSW6) +- Pro current consumption + - active: 54.0mA + - suspended: 40.5mA(WakeUp enabled DIPSW6) + - suspended: 0.3mA(WakeUp disabled DIPSW6) + +- RN42 3.3V + - disconnected(Idle): 5mA (config mode) + - connected(Active): + SW,0000: 23-26mA + SW,0010: 27-29mA worse than 0000 for unknown reason + SW,0020: 17-19mA mouse NG + SW,0030: 13-16mA laggy mouse NG + SW,0050: 10-13mA laggy mouse NG + - matrix power saving - power saving while externally powered and not while unpluged - confirm suspend mode lufa.c: matrix_power_*, suspend_wakeup_condition @@ -105,135 +153,11 @@ Power saving: - Suspend: Clear Suspend Bit, Freeze clock, disable PLL, MCU sleep(21.13) - Voltage reference(8.1.1) - to reduce power consumption while power down mode - -Improving: -- BT LED; connecting, linked, sleeping, deep sleeping -- Battry LED; blink(using timer?) -- move rn42 to protocol directory when it becomes reusable stack -- LUFA sendchar should be buffered and serial_uart.c buffur size is too large(256). -- ADC resolution - AVR120 - AVR32138 - - Enhancing ADC resolution by oversampling - AVR121 http://www.atmel.com/images/doc8003.pdf - - -Testing: -- Factroy reset doesn't work; need to **test again** 10K pull-up is too high? -- Lipo voltage ADC value is not stabilized -- DCDC converter: squeaky inducter; try other inductors - -- Keymap layer bug: during space is pressed(mousekey) press Fn(HHKB) then release space before Fn, in result HHKB layer is locked(toggled) unintentionally. - - -Done: -- low battery alert(solid light) 09/04 - - -Power routing -------------- -Current: -(USB) +---(Lipo) - | | | - | | +------+ DPDT - | | |Switch/-----------------------+ - | | +------+ | - | +-------+ | | - +-|Charger| | | - | +-------+ | +---+ | - | | |MCU| | - | | +---+ | - | | | | - | | | | -+--------------+ +-----+ +------+ +---/--+ +-----+ -|Power Selector|--|DC 5V|--|DC3.3V|---|Switch|----|RN-42| -+--------------+ +-----+ +------+ +------+ +-----+ -USB Power is boosted unnecessarily, not harmful? - -Idea 1: -(USB) +---(Lipo) - | | | - | | +------+ DPDT - | | |Switch/----------+ - | | +------+ | - | +-------+ | | - +-|Charger| | | - | +-------+ | +---+ | - | +-----+ |MCU| | - | |DC 5V| +---+ | - | +-----+ | | - | | | | -+--------------+ | +---/--+ +------+ +-----+ -|Power Selector|-----+---|Switch|----|DC3.3V|-----|RN-42| -+--------------+ +------+ +------+ +-----+ -To enable BT when USB powered it still needs to turn siwtch on, Lipo consumes quinscent current at 5V converter in vain.(Not good) - -Idea 2: -(USB) +---(Lipo) - | | | - | | +------+ - | | |Switch| - | | +------+ - | +-------+ | - +-|Charger| | - | +-------+ | +---+ - | +-----+ |MCU|----+ Controlled by firmware - | |DC 5V| +---+ | On: Lipo powered - | +-----+ | | Off: USB powered - | | | |enable -+--------------+ | +------+ +-----+ -|Power Selector|-----+---|DC3.3V|-----|RN-42| -+--------------+ +------+ +-----+ -MCU can controlled power of RN-42 without hardware switch. -When USB powered and switch is on Lipo consumes quinscent current at 5V converter in vain.(Not good) - -Idea 3: -(USB) +---(Lipo) - | | | - | | +------+ - | | |Switch|SPST(or without) - | | +------+ - | +-------+ | - +-|Charger| | - | +-------+ | +---+ - | | |MCU|----+ Controlled by firmware - | | +---+ | On: Lipo powered - | | | | Off: USB powered - | | | |enable -+--------------+ +-----+ +------+ +-----+ -|Power Selector|-|DC 5V|-|DC3.3V|-----|RN-42| -+--------------+ +-----+ +------+ +-----+ -Switch is needed to save Lipo when not used because decent power saving is not available now. If firmware can turn off BT module completely and make MCU deep sleep the switch will be not even needed. - - - - - -DONE: -- BT_INDICATOR LED turns on wrongly when touching line or pin. -- pull-up enabled on PF6/GPIO2 08/30 -- Lipo charger configuration: fast charge time: USB charger spec? -- used 2kohm -- use LED of charger to alarm low battery. LED should be powered directly from Lipo? - cancel; powered from VUSB -- Use RTS in serial_uart.c to resolve missing chars from help message of RN-42 - done -- CTS/RTS lines are needed? just connect in loop back if no flow control is needed. - done -- add IO pin to charger status CHRG; LED control(low) and detect charge status(input HiZ) 07.24 -- LINKED: add trace on PIO2 to PF6 07.24 -- Lipo voltage ADC sensing -- Lipo charger MCP73831: needs capacitor 4.7uF *2 -- USB connection check - 07.01 -- BT on/off check: whether RX line is pulled up? - checking RTS 07.01 -- USB/BT switching BT is on -> BT, BT is off -> USB - 07.01 -- Under voltage lock out UVLO for protection of Lipo - Lipo has discharge protection at 3.100V 07.01 -- Power saving: HHKB scan, BT radio control - 9h with 850mAh, this is enough 07.01 -- Power selector doesn't work; Q4 MOSFET leaks from Lipo to USB power line. -- use Schottky instead 07/04 +- unset ADEN before sleep(24.7) -TROUBLE SHOOT -------------- -07/16 After fix of voltage dividor on GPIO6, had a trouble that it could not send a char to BT module, though could receive. - Found R8 had wrong 1K resistor and changed to 10K, after that it can send to the module again. Not sure how it had sent with the wrong 1K before. -07/18 On Linux, had an USB related trouble; keyobard or console didn't work for some reason. Changing PID cured this problem. Very annoying, took very long time before resolved it. @@ -249,7 +173,7 @@ Protection spec: http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Prototyping/BatteryProtection.pdf min typical max over-charge 4.255 4.280 4.305 - over-charge discover? 4.030 4.080 4.130 + over-charge discover? 4.030 4.080 4.130 over-discharge 2.827 2.900 2.973 over-discharge discover 3.022 3.100 3.178 @@ -260,325 +184,65 @@ ADC voltage monitor: voltage divider 10K+10K(0.5) ------------------ 4.20 0x347(839) 3.10 0x26b(619) - -Configuration + +TROUBLE SHOOT ------------- -Ver 6.15 04/26/2013 -(c) Roving Networks -***Settings*** -BTA=0006664B3AE3 -BTName=tmkBT-3AE3 -Baudrt(SW4)=115K -Mode =DTR -Authen=2 -Bonded=0 -Rem=000000000000 -***ADVANCED Settings*** -SrvName= keyboard/mouse -SrvClass=0000 -DevClass=0000 -InqWindw=0100 -PagWindw=0100 -CfgTimer=255 -StatuStr=NULL -HidFlags=3c -DTRtimer=8 -KeySwapr=0 -***OTHER Settings*** -Profile= HID -CfgChar= $ -SniffEna=8010 -LowPower=0 -TX Power=0 -IOPorts= 0 -IOValues=0 -Sleeptmr=0 -DebugMod=0 -RoleSwch=0 - - - -Serial connection ------------------ -Serial line: 115200bps, 8bit, 1-stopbit, non-parity, no flow control -SSP: 115200bps, 8bit, 1-stopbit, non-parity, no flow control(via Bluetooth) - -To enter command mode disconnect the module from host and type '$$$'.(you will see 'CMD') -To exit type '---'(you will see 'END') and '+' to get local echo. - - - -Setting command mode --------------------- -S-,tmkBT // Device name -SS,keyboard/mouse // service name -SM,4 // Auto Connect DTR mode -SW,8010 // Sniff enable 0x10*0.625ms=10ms; 50ms is laggish and not much power save -S~,6 // HID profile -SH,003C // HID register -SY,0004 // Transmit power - - - - -Other options: -SC,0000 // COD: 000005C0 (see HID spec/Bluegiga doc) -SD,05C0 // bit 12-8 7 6 5-0 - // 00101 1 1 0 - // peripheral pointing keybaord joystick, gamepad, ... -SM,6 // Pairing mode: auto connect -SM,4 // Master mode: Connection can be controled with GPIO6 - - - - -HID profile ------------ -S~,6 HID profile -S~,0 SPP profile -R,1 reboot - - -Apple iOS ---------- -Keyboard can be used with iPhone, but mouse cannot. -To operate iOS with keyboard is not so useful, though. -There may be iOS specific scancodes? - - -HID flag register ------------------ -SH,0200 -GH - -10 0000 0000(0200) default -00 0011 1000(0038) Combo -|| | | |\_\____ number of paired devices to which the module can reconnect -|| | | \_______ send out reports over UART (0xFF ) -|| \__\_________ descriptor type -|\______________ toggle virtual keyboard on iOS when first connected -\_______________ Force HID mode if GPIO11 is high on power-up - - Descriptor type: - 0000: keybaord - 0001: Game Pad - 0010: Mouse - 0011: Combo - 0100: Joystick - 1xxx: reserved - - -Out report - Indicator ----------------------- -0xFE 0x02 0x01 - - -LED Status ----------- -Configuring 10 times per sec -Startup/configuration timer 2 times per sec -Discoverable/Inquiring/Idle once per sec -Connected solid on - - -Pairing -------- -First, host initiates pairing process and once it is done, auto connect will work thereafter. -SM,3 Master mode -SM,4 Auto Connect DTR Mode uses GPIO6 to make and break connection(Mode =DTR) - confirm: auto connect works and control connection with GPIO6 -SM,5 Auto Connect ANY Mode (Mode =ANY) - each time GPIO is set, make inquiry and connect to the first found device -SM,6 automatically reconnect(Mode =Pair) - confirm: auto connect works well but difficult to enter command mode. - -SR,Z removes all remote addresses for reconnecting. - can be used to connect another host -SR,I registers last inquiry address - - -Fast data mode --------------- -The module enters fast data mode after 'remote configuration timer' window is passed from power on. -In this mode the module does not accept '$$$' to enter command mode. - -Power Management ----------------- -Inquiry and Page window Idle or Active (3.1.1) - Downside: delay in discovery or connection time - SI, // set inquiry scan window(discovery) on/off duty? - SJ, // set page scan window(connection) - This reduces averaege power >20mA to 5mA(3mA in Sniff mode) - -Sniff mode Transmit - Sniff mode is disabled by default and radio is active continuously when connected.(25-30mA) - In Sniff mode the radio wakes up intermittently and sleeps in very low power mode.(2mA) - SW, // set interval timer(*0.625ms) 0000-7FFF - -Deep sleep Idle (3.1.2) - In this mode the module shuts down completly and only draws about 300uA. To enable this set the most signifant bit(0x8000) of Sniff interaval timer. - SW,8320 // deep sleep enable(interval=0x320*0.625=500ms) - In normal sleep the firmware is still running in idle mode, and wakes up about 20 times per second to check ports, update LEDs, etc. During deep sleep, the firmware actually stops runnig some tasks and the LEDs only update about once per second. - To wake from deep sleep there are three ways: (in worst case wake up takes 5ms) - *send a charactor to the UART(first charactor will be lost) - *toggle CTS low to high and wait 5ms - *wake automatically every slot time(*0.625ms) - Once the radio is awake it stay active for exactly 1 second of inactivity and then sleeps again. - Downside: latency and data loss - -Disable Output driver Idle or Active (3.1.3) - S%,1000 // set all GPIO pins(0-11) to inputs. - -Lower Transmit Power Idle or Active (3.1.4) - SY, // transmit power setting(takes effect after a power cycle and reboot) - Downside: reducing effective range - - -Optimizig for Latency ---------------------- -By default the firmware is optimized for throughput. -SQ,16 // set latency bit -SQ,0 // unset latency bit - - -Configuration timer settings ----------------------------- -Remote configuration is used for the module to be configured with various commands over Bluetooth(SPP profile only?). - -The module has remote configuration timer to allow remote configuration over Bluetooth after power up in Slave mode. In Master modes the remote configuration timer is set to 0(no remote configuration). (In Trigger Master mode the timer is used as an idle timer to break the connection after time expires with no charactors receive.) - ST,0 // no remote, no local when connected - ST,<1-252> // local and remote with timeout in seconds from power up - ST,253 // local only without timeout - ST,254 // remote only without timeout - ST,255 // local and remote without timeout - - -Android -------- -3.7.1.5 Note: To connect with Android phone the modules must wake up 11ms every 2.5seconds. - - -Commands --------- -SC, -SM, -SD, -SP, Pin code(alpahnumeric) -SQ, Special configuration(GPIO, discovery mode, low latency, reboot, UART) -SR, Store remote address -SR,Z Erase all address -SS, Set service name(1-20)** -ST, Remote configuration timer(Master:0, Slave:0-255, Triger:as idle timer) -SU, UART baud rate -SW, low-power sniff mode** deep sleep and wake up every 625us * -SX,<0|1> bonding enable only acceps device that matches the stored address -SY, power setting** -SZ, non-standard raw baud rate =baud*0.004096 -S~, Profile 0:SPP, 5:APL, 6:HID -S-, Device name -15 alphanumeric charactors -S?,<0|1> role switch enable -S$, command mode char -$|, low-power connect mode deep sleep/active(discoverable and connectable) cycle -D display basic setting -E display extended setting -GB display the device's Bluetooth address -GF display Bluetooth address of connected device -GK show connection status -GR show remote address for reconnecting -G& show GPIO pin -G show stored setting -+ toggle local echo on/off -& show GPIO 3,4,6,7(DIP switch) -C connect to stored remote address -C,
connect last address -CFI connect and go into fast data mode -CFR connect and go into fast data mode -CT,
, connect to the address and disconnect after val? -F,1 fast data mod: -H display help -I,