bootloader/README.md

Ultimate Hacking Keyboard bootloader

This repository contains the bootloader of the Ultimate Hacking Keyboard which is a fully functional port of KBOOT v2.0.

The codebase of the bootloader actually resides in targets/MK22F51212/src.

Build

Install Kinetis Design Studio (KDS) and import the project by invoking File -> Import -> General -> Existing Projects into Workspace, select the targets/MK22F51212/kds/freedom_bootloader directory, and click on the Finish button. At this point, you should be able to build the firmware in KDS.

Flash the bootloader

First up, let's take care of the physical connections:

• make sure to power the UHK via USB,
• connect your SEGGER J-Link debug probe to USB,
• connect SEGGER J-Link to one of the SWD ports of the right half of the UHK.

Next up, it's wise to explicitly erase the MCU because an application firmware might have already been uploaded via the bootloader, in which case the bootloader may treat the already existing CRC as valid, causing it not to timeout.

• Visit the J-Link / J-Trace Downloads page. In the J-Link Software and Documentation Pack section click on the Click for downloads, then download and install the package of your operating system.
• Start up JLink.exe and type the following:

device MK22FN512xxx12
erase

Lastly, Use KDS to build and upload the firmware to the MCU.

Upload the application firmware via the bootloader

To test the bootloader a binary properly configured has been added to the root folder of this repository. This binary is based on the UHK_Right Firmware project. To understand these modifications and apply them to the current version of the UHK Right firmware, follow the procedure in "Adapting UHK Project to KBOOT.docx" (Work in progress...)

The device can be controlled and erased/programmed easily using the blhost.exe tool provided by NXP and included in this repository. A GUI with a reduced set of features has also been created for Windows (KinetisFlashTool.exe).

Key features

• Communication through HID with any PC without the need of an additional driver.
• Automatic timeout and jump to user application without any action from the user.
• If no valid application is present, the bootloader will keep waiting for communication through the HID USB port.
• Every command sent to the bootloader includes a validation process inside the MCU to avoid any error in the communication.
• The memory area of the bootloader is protected, so even if the update fails, user just needs to do a Power on Reset (Plug and Unplug the Keyboard) in order to launch the bootloader again.
• Smart reset behavior: If the MCU has been reset by the user (SW reset or Reset-pin-to-GND short) a timeout will be enabled. If the reset is a Power on Reset (meaning that the user has just connected the keyboard to the power) it will jump to the application firmware if its present on the memory.