Merged upstream changes from tmk repo

Author: Christoph

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tmk_core/protocol/usb_hid/USB_Host_Shield_2.0-tmk"]
+	path = tmk_core/protocol/usb_hid/USB_Host_Shield_2.0-tmk
+	url = https://github.com/tmk/USB_Host_Shield_2.0.git

converter/adb_usb/MEMO.txt

@@ -9,7 +9,6 @@ TARGET_DIR ?= .
 
 # project specific files
 SRC ?=	matrix.c \
-	led.c \
 	adb.c
 
 CONFIG_H = config.h
@@ -64,26 +63,27 @@ OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
 #   Atmel DFU loader 4096	for TMK Converter rev.1/rev.2
 #   LUFA bootloader  4096
 #   USBaspLoader     2048
-OPT_DEFS += -DBOOTLOADER_SIZE=4096
+BOOTLOADER_SIZE ?= 4096
+OPT_DEFS += -DBOOTLOADER_SIZE=$(BOOTLOADER_SIZE)
 
 
 # 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
-ADB_MOUSE_ENABLE = yes
-#UNIMAP_ENABLE = yes
-#ACTIONMAP_ENABLE = yes         # Use 16bit actionmap instead of 8bit keymap
-#KEYMAP_SECTION_ENABLE = yes	# fixed address keymap for keymap editor
+BOOTMAGIC_ENABLE ?= no		# 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
+NKRO_ENABLE ?= no		# USB Nkey Rollover
+ADB_MOUSE_ENABLE ?= yes		# ADB Mouse support
+UNIMAP_ENABLE ?= yes		# Use unimap
+ACTIONMAP_ENABLE ?= no          # Use 16bit actionmap instead of 8bit keymap
+KEYMAP_SECTION_ENABLE ?= yes	# fixed address keymap for keymap editor
 
 # ADB Mice need acceleration for todays much bigger screens. 
-OPT_DEFS += -DADB_MOUSE_MAXACC=8
+ADB_MOUSE_MAXACC ?= 8
+OPT_DEFS += -DADB_MOUSE_MAXACC=$(ADB_MOUSE_MAXACC)
 
 
 # Optimize size but this may cause error "relocation truncated to fit"
@@ -93,10 +93,10 @@ OPT_DEFS += -DADB_MOUSE_MAXACC=8
 #
 # Keymap file
 #
-ifdef UNIMAP_ENABLE
+ifeq (yes,$(strip $(UNIMAP_ENABLE)))
     KEYMAP_FILE = unimap
 else
-    ifdef ACTIONMAP_ENABLE
+    ifeq (yes,$(strip $(ACTIONMAP_ENABLE)))
 	KEYMAP_FILE = actionmap
     else
 	KEYMAP_FILE = keymap

converter/adb_usb/Makefile

@@ -1,10 +1,10 @@
 ADB to USB keyboard converter
 =============================
-This firmware converts Apple ADB keyboard protocol to USB, you can use it to plug old ADB keyboard into modern computer. It works on TMK ADB-USB Converter, PJRC Teensy2.0 and other USB AVR MCU(ATMega32U4, AT90USB64/128 or etc) and needs more than 10KB flash at least.
+This firmware converts Apple ADB keyboard/mouse protocol to USB, you can use it to plug old ADB keyboard/mouse into modern computer. It works on prebuilt TMK ADB-USB Converter or generic dev board with USB AVR MCU(ATMega32U4/2) like Teensy2.0.
 
-Discuss here: http://geekhack.org/showwiki.php?title=Island:14290
+Discuss about this here: http://geekhack.org/showwiki.php?title=Island:14290
 
-You can buy a TMK converter here: https://geekhack.org/index.php?topic=72052.0
+Prebuilt TMK ADB-USB converter is available here: https://geekhack.org/index.php?topic=72052.0
 
 
 
@@ -16,18 +16,20 @@ https://github.com/tmk/tmk_keyboard/tree/master/converter/adb_usb
 Also check these when you are in trouble.
 
 https://github.com/tmk/tmk_keyboard/wiki
-https://github.com/tmk/tmk_keyboard/labels/NOTE
+https://github.com/tmk/tmk_keyboard/issues
 
 
 Wiring
 ------
-Connect ADB pins to controller just by 3 lines(Vcc, GND, Data). By default Data line uses port PD0.
+If you build this yourself you have to solder some wires.
+Connect ADB pins to controller just by 3 lines(Vcc, GND, Data) at least. By default Data line uses port PD0.
+This is not needed but you can connect PSW to PD1 optionally.
 
 ADB female socket from the front:
 
       ,--_--.
      / o4 3o \      1: DATA
-    | o2   1o |     2: Power SW
+    | o2   1o |     2: PSW(Power SW)
      -  ===  -      3: VCC
       `-___-'       4: GND
 
@@ -36,13 +38,13 @@ https://github.com/tmk/tmk_keyboard/wiki/FAQ#pull-up-resistor
 
 Pull-up resister:
 
-    Keyboard       Conveter
+    Keyboard       AVR MCU
                    ,------.
     5V------+------|VCC   |
             |      |      |
            [R]     |      |
             |      |      |
-    Signal--+------|PD0   |
+    DATA----+------|PD0   |
                    |      |
     GND------------|GND   |
                    `------'
@@ -58,59 +60,60 @@ Build firmware and Program microcontroller
 ------------------------------------------
 See [doc/build.md](../../tmk_core/doc/build.md).
 
-To build firmware and program TMK Converter run these commands:
+To build firmware and program TMK ADB-USB Converter run these commands:
 
     $ make -f Makefile clean
-    $ make -f Makefile [KEYMAP=(plain|ansi|iso|hasu)]
-    $ make -f Makefile [KEYMAP=(plain|ansi|iso|hasu)] dfu
+    $ make -f Makefile [KEYMAP=yourname]
+    $ make -f Makefile [KEYMAP=yourname] dfu
 
-You can select keymap with optional `KEYMAP=` (plain is default). Push button on the converter before running `dfu` target.
+You can select keymap name with optional `KEYMAP=` ('plain' is default name). Push button on the converter before running `dfu` target.
 
-Use **Makefile.rev1** for old TMK Converter rev.1 and **Makefile.teensy** for Teensy2.0 instead of **Makefile**. For TMK Converter rev.2 just use **Makefile**.
-
-To program Teensy you can use `teensy` target:
-
-    $ make -f Makefile.teensy [KEYMAP=(plain|ansi|iso|hasu)] teensy
+Use **Makefile.rev1** for old TMK Converter rev.1 and Teensy2.0 instead of **Makefile**.
 
 
 
 Keymap
 ------
-You can change a keymap by editing code of keymap_[plain|ansi|iso|hasu|yours].c.
+You can change keymap by editing code of unimap_plain.c directly, or copy it to your own keymap file like unimap_yourname.c and edit the file.
 How to define the keymap is probably obvious. You can find key symbols in common/keycode.h. And see [doc/keymap.md](../../tmk_core/doc/keymap.md) for more detail.
 
 
 Magic command
 -------------
-To get help press `h` holding Magic key. Magic key is `Power key`.
+To get help message in hid_listen press `h` holding Magic key. Magic key is `Power key`.
+
+https://github.com/tmk/tmk_keyboard/wiki#debug
 
 
 Locking CapsLock
 ----------------
-Many of old ADB keyboards have mechanical push-lock switch for Capslock key and this converter supports the locking Capslock key by default. See README in top directory for more detail about this feature.
+Many of old ADB keyboards have mechanical push-lock switch for Capslock key and this converter supports the locking Capslock key by default. Use keycode `LCAP` instead of `CAPS` in your keymap in short. See README in top directory for more detail.
 https://github.com/tmk/tmk_keyboard/blob/master/README.md#mechanical-locking-support
 
-Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
+If you want to remap Capslock key you will have to remove locking pin or just replace with normal momentary switch. Some keyboards like Apple Adujstable keyboard use firmware-base locking with momentary switch for Capslock and remapping it won't be useful in most cases.
 
 
-Mouse support
--------------
-ADB mouse support was added by @mek-apelsin on Apr,2015. It supports only one button as of now.
-https://github.com/tmk/tmk_keyboard/pull/207
-
-
-Notes
------
+Notes for keyboard
+------------------
 Not-extended ADB keyboards have no discrimination between right modifier and left one,
 you will always see left control even if you press right control key.
 Apple Extended Keyboard and Apple Extended Keyboard II can discriminate both side
 modifiers except for GUI key(Windows/Command).
 
-And most ADB keyboard has no diodes in its matrix so they are not NKRO,
-though ADB protocol itself supports it. See protocol/adb.c for more info.
+And most of ADB keyboards have no diodes in its matrix so they are not NKRO unfortunately,
+though ADB protocol itself supports it. See tmk_core/protocol/adb.c for more info.
+
+
+Notes for mouse
+---------------
+ADB mouse support was added by @mek-apelsin on Apr,2015.
+https://github.com/tmk/tmk_keyboard/pull/207
+
+All one-button mouses should be supported.
 
-If keyboard has ISO layout you may have swapped keys problem, see this for the detail.
+As of 2019 June, the converter can handle multi-button mice and trackball up to eight buttons if the pointing device supports Apple Extended Mouse protocol. But some devices use their own specific protocol unfortunately and they will work as one-button mouse unless device specific code is added.
 
-https://github.com/tmk/tmk_keyboard/issues/35
+Kensington Turbo Mouse 5(#64210) is supported now.
+https://github.com/tmk/tmk_keyboard/issues/274#issuecomment-504726633
 
 EOF