qmk-dactyl-manuform-a/tmk_core
Takeshi ISHII dbbab40981
Refactor rgblight_reconfig.h (#7773)
* Moved contents of rgblight_reconfig.h to rgblight_post_config.h.

In #3582, rgblight_reconfig.h had to be newly created. Now, the build system of qmk_firmware has a post_cofig feature, so that what was done in rgblight_reconfig.h can now be realized in rgblight_post_config.h.

**This commit does not change the build result.**

Testing script
```shell
  # build on master
  git checkout master
  echo master > /tmp/master_md5.txt

  # RGBLIGHT_ENABLE = no
  make HELIX=verbose helix/rev2:default:clean
  make HELIX=verbose helix/rev2:default
  md5 helix_rev2_default.hex >> /tmp/master_md5.txt

  # RGBLIGHT_ENABLE = yes, with animations
  make HELIX=verbose helix/rev2/back:default:clean
  make HELIX=verbose helix/rev2/back:default
  md5 helix_rev2_back_default.hex >> /tmp/master_md5.txt

  # RGBLIGHT_ENABLE = yes, without animations
  make HELIX=verbose,no_ani helix/rev2/back:default:clean
  make HELIX=verbose,no_ani helix/rev2/back:default
  md5 helix_rev2_back_default.hex >> /tmp/master_md5.txt

  # build on refactor_rgblight_reconfig.h
  git checkout refactor_rgblight_reconfig.h
  echo refactor_rgblight_reconfig.h > /tmp/branch_md5.txt

  # RGBLIGHT_ENABLE = no
  make HELIX=verbose helix/rev2:default:clean
  make HELIX=verbose helix/rev2:default
  md5 helix_rev2_default.hex >> /tmp/branch_md5.txt

  # RGBLIGHT_ENABLE = yes, with animations
  make HELIX=verbose helix/rev2/back:default:clean
  make HELIX=verbose helix/rev2/back:default
  md5 helix_rev2_back_default.hex >> /tmp/branch_md5.txt

  # RGBLIGHT_ENABLE = yes, without animations
  make HELIX=verbose,no_ani helix/rev2/back:default:clean
  make HELIX=verbose,no_ani helix/rev2/back:default
  md5 helix_rev2_back_default.hex >> /tmp/branch_md5.txt

  diff -u /tmp/master_md5.txt /tmp/branch_md5.txt
```

Test result:
```
--- /tmp/master_md5.txt 2020-01-03 15:42:22.000000000 +0900
+++ /tmp/branch_md5.txt 2020-01-03 15:42:42.000000000 +0900
@@ -1,4 +1,4 @@
-master
+refactor_rgblight_reconfig.h
 MD5 (helix_rev2_default.hex) = f360032edd522448366d471d8f4f8181
 MD5 (helix_rev2_back_default.hex) = 0c663acc6cccc44476b3b969ad22a48f
 MD5 (helix_rev2_back_default.hex) = e66b1195ff6d38e6e22c975b8ae42fd3
```

* Expressions that are too long are difficult to read, so wrap them.

* Edit the expression again

* remove `defined(RGBLIGHT_ANIMATIONS)` in `tmk_core/common/*/suspend.c`, `tmk_core/protocol/*/main.c`

move contents of rgblight_reconfig.h to rgblight.h.

The following changes were made to rgblight.h.

```diff
+#ifdef RGBLIGHT_USE_TIMER
 void rgblight_task(void);

 void rgblight_timer_init(void);
 void rgblight_timer_enable(void);
 void rgblight_timer_disable(void);
 void rgblight_timer_toggle(void);
+#else
+#define rgblight_task()
+#define rgblight_timer_init()
+#define rgblight_timer_enable()
+#define rgblight_timer_disable()
+#define rgblight_timer_toggle()
+#endif
```

The following changes were made to tmk_core/common/avr/suspend.c, tmk_core/common/chibios/suspend.c, tmk_core/protocol/chibios/main.c, tmk_core/protocol/lufa/lufa.c, tmk_core/protocol/vusb/main.c.

```diff
-#    ifdef RGBLIGHT_ANIMATIONS
     rgblight_timer_enable();
-#    endif
```
```diff
-#if defined(RGBLIGHT_ANIMATIONS) && defined(RGBLIGHT_ENABLE)
+#if defined(RGBLIGHT_ENABLE)
         rgblight_task();
 #endif
```

* remove 'defined(RGBLIGHT_ANIMATIONS)' in tmk_core/common/keyboard.c

Co-authored-by: Joel Challis <git@zvecr.com>
2020-03-10 01:46:03 -07:00
..
common Refactor rgblight_reconfig.h (#7773) 2020-03-10 01:46:03 -07:00
protocol Refactor rgblight_reconfig.h (#7773) 2020-03-10 01:46:03 -07:00
tool/chibios Normalize line endings 2016-08-20 17:59:18 +03:00
arm_atsam.mk Fix misunderstanding of CPPFLAGS and CXXFLAGS. 2020-01-31 15:29:23 +11:00
avr.mk Fix up Arm builds with nix-shell. (#8312) 2020-03-07 03:05:51 +11:00
chibios.mk Allow for ChibiOS 20.x (master), as well as enabling ChibiOS-Contrib HAL. (#8272) 2020-03-01 11:50:49 +11:00
common.mk Unconditionally enable ChibiOS syscalls (#8268) 2020-03-01 09:45:21 +11:00
make_dfu_header.sh Fixed grep issue in bootloader build target (#3848) 2019-02-18 10:00:33 -08:00
native.mk Fix misunderstanding of CPPFLAGS and CXXFLAGS. 2020-01-31 15:29:23 +11:00
protocol.mk core: Fix build config in protocol.mk (#7620) 2019-12-13 11:36:37 +00:00
readme.md Remove PJRC USB stack 2020-02-08 11:07:43 -08:00
ring_buffer.h clang-format changes 2019-08-30 15:01:52 -07:00
rules.mk Fix misunderstanding of CPPFLAGS and CXXFLAGS. 2020-01-31 15:29:23 +11:00

readme.md

TMK Keyboard Firmware Core Library

This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M.

Source code is available here: https://github.com/tmk/tmk_keyboard/tree/master/tmk_core

Updates

2016/02/10

flabbergast's Chibios protocol was merged from https://github.com/flabbergast/tmk_keyboard/tree/chibios. See protocol/chibios/README.md. Chibios protocol supports Cortex-M such as STM32 and Kinetis.

2015/04/22

separated with TMK Keyboard Firmware Collection

Features

These features can be used in your keyboard.

  • Multi-layer Keymap - Multiple keyboard layouts with layer switching
  • Mouse key - Mouse control with keyboard
  • System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
  • Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
  • USB NKRO - 248 keys(+ 8 modifiers) simultaneously
  • PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
  • Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
  • User Function - Customizable function of key with writing code
  • Macro - Very primitive at this time
  • Keyboard Tricks - Oneshot modifier and modifier with tapping feature
  • Debug Console - Messages for debug and interaction with firmware
  • Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
  • Locking CapsLock - Mechanical switch support for CapsLock
  • Breathing Sleep LED - Sleep indicator with charm during USB suspend
  • Backlight - Control backlight levels

TMK Keyboard Firmware Collection

Complete firmwares for various keyboards and protocol converters.

https://github.com/tmk/tmk_keyboard

License

GPLv2 or later. Some protocol files are under Modified BSD License. ChibiOS, LUFA and V-USB stack have their own license respectively.

Build Firmware and Program Controller

See doc/build.md.

Start Your Own Project

TBD

Config.h Options

1. USB vendor/product ID and device description

#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0xBEEF
#define MANUFACTURER    t.m.k.
#define PRODUCT         Macway mod
#define DESCRIPTION     t.m.k. keyboard firmware for Macway mod

2. Keyboard matrix configuration

#define MATRIX_ROWS 8
#define MATRIX_COLS 8
#define MATRIX_HAS_GHOST

Architecture

Architecture Diagram
                           +---------------+---------------+-------------+
                           |    Host       |   Keyboard    | Matrix, LED |
   ___________             |-----------+-+ +-------------+ | +-----------|
  /          /| Keys/Mouse | Protocol  |d| | Action      | | | Protocol  |
 /__________/ |<-----------|  LUFA     |r| |  Layer, Tap | | |  Matrix   |
 |.--------.| |   LED      |  V-USB    |i| |-------------| | |  PS/2,IBM |             __________________
 ||        || |----------->|  iWRAP(BT)|v| | Keymap      | | |  ADB,M0110|  Keys      / /_/_/_/_/_/_/_/ /|
 ||  Host  || |  Console   |  UART     |e| | Mousekey    | | |  SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
 ||________||/.<-----------|           |r| | Report      | | |  X68K/PC98| Control  / /_/_/_/_/_/_/_/ / /
 `_========_'/|            |---------------------------------------------|-------->/___ /_______/ ___/ /
 |_o______o_|/             | Sendchar, Print, Debug, Command, ...        |         |_________________|/
                           +---------------------------------------------+              Keyboard

Debugging

Use PJRC's hid_listen to see debug messages. You can use the tool for debug even if firmware use LUFA stack.

You can use xprintf() to display debug info on hid_listen, see common/xprintf.h.

Files and Directories

Top

  • common/ - common codes
  • protocol/ - keyboard protocol support
  • doc/ - documents
  • common.mk - Makefile for common
  • protocol.mk - Makefile for protocol
  • rules.mk - Makefile for build rules

Common

  • host.h
  • host_driver.h
  • keyboard.h
  • command.h
  • keymap.h
  • action.h
  • keycode.h
  • matrix.h
  • led.h
  • mousekey.h
  • report.h
  • debug.h
  • print.h
  • bootloader.h
  • sendchar.h
  • timer.h
  • util.h

Keyboard Protocols

  • lufa/ - LUFA USB stack
  • vusb/ - Objective Development V-USB
  • iwrap/ - Bluetooth HID for Bluegiga iWRAP
  • ps2.c - PS/2 protocol
  • adb.c - Apple Desktop Bus protocol
  • m0110.c - Macintosh 128K/512K/Plus keyboard protocol
  • news.c - Sony NEWS keyboard protocol
  • x68k.c - Sharp X68000 keyboard protocol
  • serial_soft.c - Asynchronous Serial protocol implemented by software

Coding Style

  • Doesn't use Tab to indent, use 4-spaces instead.