hid.md 3.4 KB
DMBS - Dean's Makefile Build System
Module: HID
The HID module provides build targets to program a target running a PJRC Teensy or LUFA compatible HID class bootloader.
Importing This Module into a Makefile:
To use this module in your application makefile, add the following code to your makefile:
include $(DMBS_PATH)/hid.mk
Prerequisites:
This module requires the teensy_loader_cli utility to be available in your
system's PATH variable. The teensy_loader_cli utility is distributed in
a modified form (from PJRC) in the LUFA project's
official site, but is also
made available in its original form directly from the
PJRC website. Note that the
original tool works with Teensy boards only, and not LUFA HID bootloader
devices.
This module requires the hid_bootloader_cli utility to be available in your
system's PATH variable. The hid_bootloader_cli Python script utility is
distributed in LUFA project's official site.
This module requires the AVR-GCC compiler to be installed and available in the
system's PATH variable.
Build Targets:
The following targets are supported by this module:
| hid | Program a LUFA HID class bootloader device, using the `hid_bootloader_cli.py` Python script. |
| hid-ee | Program a LUFA HID class bootloader device's EEPROM, using the `hid_bootloader_cli.py` Python script and a shim application which is programmed into the target's flash. |
| teensy | Program a LUFA HID class bootloader device or Teensy board, using the `teensy_loader_cli` tool. |
| teensy-ee | Program a LUFA HID class bootloader device's EEPROM, using the `teensy_loader_cli` tool and a shim application which is programmed into the target's flash. |
Mandatory Variables:
The following variables must be defined (with a NAME = VALUE syntax, one
variable per line) in the user makefile to be able to use this module:
| MCU | Name of the Atmel processor model (e.g. `at90usb1287`). |
| TARGET | Name of the application output file prefix (e.g. `TestApplication`). |
Optional Variables:
The following variables may be defined (with a NAME = VALUE syntax, one
variable per line) in the user makefile. If not specified, a default value will
be assumed.
| N/A | This module has no optional variables. |
Provided Variables:
The following variables may be referenced in a user makefile (via $(NAME)
syntax) if desired, as they are provided by this module.
| N/A | This module provides no variables. |
Provided Macros:
The following macros may be referenced in a user makefile (via
$(call NAME, ARG1, ARG2, ...) syntax) if desired, as they are provided by
this module.
| N/A | This module provides no macros. |
Module Changelog:
The changes to this module since its initial release are listed below, as of the DMBS version where the change was made.
20160403
Initial release.