d4be07dad3
* add support for hid gamepad interface
add documentation for HID joystick
Add joystick_task to read analog axes values even when no key is pressed or release. update doc
Update docs/feature_joystick.md
Manage pin setup and read to maintain matrix scan after analog read
* Incorporates patches and changes to HID reporting
There are some patches provided by @a-chol incorporated on this commit,
and also some changes I made to the HID Report structure.
The most interesting is the one dealing with number of buttons: Linux
doesn't seem to care, but Windows requires the HID structure to be byte
aligned (that's in the spec). So if one declares 8/16/32... buttons they
should not have any issues, but this is what happens when you have 9
buttons:
```
bits |0|1|2|3|4|5|6|7|
|*|*|*|*|*|*|*|*| axis 0 (report size 8)
|*|*|*|*|*|*|*|*| ...
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*| axis 6
|*|*|*|*|*|*|*|*| first 8 buttons (report size 1)
|*| | | | | | | | last of 9 buttons, not aligned
```
So for that I added a conditonal that will add a number of reports with
size 1 to make sure it aligns to the next multiple of 8. Those reports
send dummy inputs that don't do anything aside from aligning the data.
Tested on Linux, Windows 10 and Street Fighter (where the joystick is
recognized as direct-input)
* Add save and restore of each pin used in reading joystick (AVR).
Allow output pin to be JS_VIRTUAL_AXIS if the axis is connected to Vcc
instead of an output pin from the MCU.
Fix joystick report id
Fix broken v-usb hid joystick interface. Make it more resilient to unusual settings (none multiple of eight button count, 0 buttons or 0 axes)
Correct adc reading for multiple axes. Piecewise range conversion for uncentered raw value range. Input, output and ground pin configuration per axis.
Documentation fixes
* Fix port addressing for joystick analog read
* The other required set of changes
As per the PR, the changes still holding it up.
Add onekey for testing.
Fix ARM builds.
Fix device descriptor when either axes or buttons is zero.
Add compile-time check for at least one axis or button.
Move definition to try to fix conflict.
PR review comments.
qmk cformat
* avoid float functions to compute range mapping for axis adc reading
* Remove V-USB support for now. Updated docs accordingly.
* Update tmk_core/protocol/lufa/lufa.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/usb_descriptor.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/usb_descriptor.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/usb_descriptor.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Add support for joystick adc reading for stm32 MCUs. Fix joystick hid report sending for chibios
* Fix HID joystick report sending for ChibiOS.
Add one analog axis to the onekey:joystick keymap.
Fix pin state save and restore during joystick analog read for STM32
MCUs.
* Update tmk_core/protocol/chibios/usb_main.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/lufa/lufa.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Add missing mcuconf.h and halconf.h to onekey:joystick keymap.
Add suggested fixes from PR.
* Switch saveState and restoreState signature to use pin_t type.
onekey:joystick : add a second axis, virtual and programmatically animated.
* Update docs/feature_joystick.md
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update docs/feature_joystick.md
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Add PR corrections
* Remove halconf.h and mcuconf.h from onekey keymaps
* Change ADC_PIN to A0
Co-authored-by: achol <allecooll@hotmail.com>
Co-authored-by: José Júnior <jose.junior@gmail.com>
Co-authored-by: a-chol <achol@notamail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Ryan <fauxpark@gmail.com>
|
||
|---|---|---|
| .. | ||
| common | ||
| protocol | ||
| tool/chibios | ||
| arm_atsam.mk | ||
| avr.mk | ||
| chibios.mk | ||
| common.mk | ||
| make_dfu_header.sh | ||
| native.mk | ||
| protocol.mk | ||
| readme.md | ||
| ring_buffer.h | ||
| rules.mk | ||
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
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 | __________________
|| || |----------->| UART |v| | Keymap | | | ADB,M0110| Keys / /_/_/_/_/_/_/_/ /|
|| Host || | Console | |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
- 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.