Dean Camera
9 years ago
parent
3069b7d9d2
commit
51d3adfe18
@ -0,0 +1,9 @@
|
||||
*.lss
|
||||
*.bin
|
||||
*.elf
|
||||
*.hex
|
||||
*.eep
|
||||
*.map
|
||||
*.o
|
||||
*.d
|
||||
*.sym
|
||||
@ -0,0 +1,26 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Modules Overview
|
||||
---------------
|
||||
|
||||
The following modules are currently included:
|
||||
|
||||
- [ATPROGRAM](atprogram.md) - Device Programming
|
||||
- [AVRDUDE](avrdude.md) - Device Programming
|
||||
- [CORE](core.md) - DMBS Core Functionality
|
||||
- [CPPCHECK](cppcheck.md) - Static Code Analysis
|
||||
- [DFU](dfu.md) - Device Programming
|
||||
- [DOXYGEN](doxygen.md) - Automated Source Code Documentation
|
||||
- [GCC](gcc.md) - Compiling/Assembling/Linking with GCC
|
||||
- [HID](hid.md) - Device Programming
|
||||
|
||||
To use a module, you will need to add the following boilerplate to your
|
||||
makefile:
|
||||
|
||||
# Include DMBS build script makefiles
|
||||
DMBS_PATH ?= ../DMBS
|
||||
|
||||
Which is then used to indicate the location of your DMBS installation, relative
|
||||
to the current directory.
|
||||
@ -0,0 +1,111 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: ATPROGRAM
|
||||
-----------------
|
||||
|
||||
The ATPROGRAM module provides build targets for use with the official
|
||||
`ATPROGRAM` back-end utility distributed with the free
|
||||
[Atmel Studio](http://www.atmel.com) software released by Atmel.
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/atprogram.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
This module requires the `atprogram.exe` utility to be available in your
|
||||
system's `PATH` variable. The `atprogram.exe` utility is distributed in Atmel
|
||||
Studio (usually) inside the application install folder's `atbackend`
|
||||
subdirectory.
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>atprogram</td>
|
||||
<td>Program the device FLASH memory with the application's executable data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>atprogram-ee</td>
|
||||
<td>Program the device EEPROM memory with the application's EEPROM data.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>MCU</td>
|
||||
<td>Name of the Atmel processor model (e.g. `at90usb1287`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>TARGET</td>
|
||||
<td>Name of the application output file prefix (e.g. `TestApplication`).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>ATPROGRAM_PROGRAMMER</td>
|
||||
<td>Name of the Atmel programmer or debugger tool to communicate with (e.g. `jtagice3`). Default is `atmelice`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ATPROGRAM_INTERFACE</td>
|
||||
<td>Name of the programming interface to use when programming the target (e.g. `spi`). Default is `jtag`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ATPROGRAM_PORT</td>
|
||||
<td>Name of the communication port to use when when programming with a serially connected tool (e.g. `COM2`). Default is `usb`.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,116 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: AVRDUDE
|
||||
-----------------
|
||||
|
||||
The AVRDUDE module provides build targets for use with the official
|
||||
open source `AVRDUDE` programmer utility, for the reprogramming of Atmel devices
|
||||
using a wide variety of official and non-official programming devices and
|
||||
bootloaders.
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/avrdude.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
This module requires the `avrdude` utility to be available in your
|
||||
system's `PATH` variable. The `avrdude` utility is distributed on the project's
|
||||
[official site](https://savannah.nongnu.org/projects/avrdude) but is also
|
||||
made available in many *nix operating system's package managers.
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>avrdude</td>
|
||||
<td>Program the device FLASH memory with the application's executable data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>avrdude-ee</td>
|
||||
<td>Program the device EEPROM memory with the application's EEPROM data.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>MCU</td>
|
||||
<td>Name of the Atmel processor model (e.g. `at90usb1287`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>TARGET</td>
|
||||
<td>Name of the application output file prefix (e.g. `TestApplication`).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>AVRDUDE_PROGRAMMER</td>
|
||||
<td>Name of the programmer/debugger tool or bootloader to communicate with (e.g. `jtagicemkii`). Default is `jtagicemkii`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AVRDUDE_PORT</td>
|
||||
<td>Name of the communication port to use when when programming with a serially connected tool (e.g. `COM2`). Default is `usb`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AVRDUDE_FLAGS</td>
|
||||
<td>Additional flags to pass to `avrdude` when invoking the tool. Default is empty (no additional flags).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AVRDUDE_MEMORY</td>
|
||||
<td>Memory space to program when executing the `avrdude` target (e.g. 'application` for an XMEGA device). Default is `flash`.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,116 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: CORE
|
||||
------------
|
||||
|
||||
The CORE module provides the core DMBS infrastructure used by other DMBS
|
||||
modules, and must always be imported. Additionally, this module provides the
|
||||
help system for DMBS.
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/core.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
None.
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>help</td>
|
||||
<td>Show help for the current project, including a list of all available targets, variables and macros from the imported modules.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>list_targets</td>
|
||||
<td>Show a list of all build targets from the imported modules.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>list_modules</td>
|
||||
<td>Show a list of all imported modules.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>list_mandatory</td>
|
||||
<td>Show a list of all mandatory variables from the imported modules.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>list_optional</td>
|
||||
<td>Show a list of all optional variables from the imported modules.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>list_provided</td>
|
||||
<td>Show a list of all variables provided by the imported modules.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>list_macros</td>
|
||||
<td>Show a list of all macros provided by the imported modules.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module has no mandatory variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module has no optional variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>DMBS_VERSION</td>
|
||||
<td>Current version of this DMBS release.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,126 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: CPPCHECK
|
||||
-----------------
|
||||
|
||||
The CPPCHECK module provides build targets to perform static analysis of the
|
||||
user application, using the open source `cppcheck` tool.
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/cppcheck.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
This module requires the `cppcheck` utility to be available in your system's
|
||||
`PATH` variable. The `cppcheck` utility is distributed on the project's
|
||||
[official site](http://cppcheck.sourceforge.net/) but is also
|
||||
made available in many *nix operating system's package managers.
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>cppcheck</td>
|
||||
<td>Scan the project with CPPCHECK, and show all discovered issues.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cppcheck-config</td>
|
||||
<td>Check the project with CPPCHECK, to find missing header paths.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>SRC</td>
|
||||
<td>List of all project source files to scan.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>CPPCHECK_INCLUDES</td>
|
||||
<td>Extra include paths to search, for any missing header files. Default is empty (no additional paths).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_EXCLUDES</td>
|
||||
<td>List of source files, file paths or path fragments to exclude from the scan. Default is empty (no exclusions).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_MSG_TEMPLATE</td>
|
||||
<td>Template for error and warning message output. Default is `{file}:{line}: {severity} ({id}): {message}`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_ENABLE</td>
|
||||
<td>List of CPPCHECK checks to enable. Default is `all`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_SUPPRESS</td>
|
||||
<td>List of CPPCHECK checks to ignore. Default is `variableScope missingInclude`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_FAIL_ON_WARNING</td>
|
||||
<td>Boolean, if `Y` the build will fail if CPPCHECK discovers any errors or warnings. If `N`, fail only on errors. Default is `Y`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_QUIET</td>
|
||||
<td>Boolean, if `Y` CPPCHECK will suppress all output except for discovered errors or warnings. If `N`, scan progress will be emitted. Default is `Y`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPPCHECK_FLAGS_</td>
|
||||
<td>Additional flags to pass to CPPCHECK when scans are started. Default is empty (no additional flags).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,114 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: DFU
|
||||
-----------------
|
||||
|
||||
The DFU module provides build targets to program a USB connected target running
|
||||
a DFU class bootloader, via the official Atmel FLIP utility running via the
|
||||
command line, or the open source `DFU-Programmer` tool.
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/dfu.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
This module requires the `batchisp` utility to be available in your system's
|
||||
`PATH` variable. The `batchisp` utility is distributed as part of Atmel's FLIP
|
||||
software which can be downloaded from the [official site](http://www.atmel.com).
|
||||
|
||||
This module requires the `dfu-programmer` utility to be available in your
|
||||
system's `PATH` variable. The `dfu-programmer` utility is distributed from the
|
||||
[official project site](https://dfu-programmer.github.io/).
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>flip</td>
|
||||
<td>Program the application into the device's flash memory, using Atmel FLIP.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>flip-ee</td>
|
||||
<td>Program the application's EEPROM data into the device's EEPROM memory, using Atmel FLIP.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dfu</td>
|
||||
<td>Program the application into the device's flash memory, using `dfu-programmer`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>dfu-ee</td>
|
||||
<td>Program the application's EEPROM data into the device's EEPROM memory, using `dfu-programmer`.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>MCU</td>
|
||||
<td>Name of the Atmel processor model (e.g. `at90usb1287`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>TARGET</td>
|
||||
<td>Name of the application output file prefix (e.g. `TestApplication`).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module has no optional variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,110 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: DOXYGEN
|
||||
-----------------
|
||||
|
||||
The DOXYGEN module provides build targets to automatically generate API
|
||||
documentation for a project, using the open-source Doxygen tool.
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/doxygen.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
This module requires the `doxygen` utility to be available in your system's
|
||||
`PATH` variable. The `doxygen` utility is distributed on the project's
|
||||
[official site](http://doxygen.org/) but is also
|
||||
made available in many *nix operating system's package managers.
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>doxygen</td>
|
||||
<td>Generate project documentation, via Doxygen.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>doxygen-create</td>
|
||||
<td>Create a new project Doxygen template, which can then be customized.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>doxygen-upgrade</td>
|
||||
<td>Upgrade an existing project Doxygen template to the latest Doxygen version.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module has no mandatory variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>DOXYGEN_CONF</td>
|
||||
<td>Name of the Doxygen project configuration file that should be used when generating documentation, or creating/upgrading the configuration file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DOXYGEN_FAIL_ON_WARNING</td>
|
||||
<td>Boolean, if `Y` the build will fail if Doxygen encounters any errors or warnings. If `N`, fail only on errors. Default is `Y`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DOXYGEN_OVERRIDE_PARAMS</td>
|
||||
<td>List of `NAME=VALUE` parameters which should override the values specified in the project configuration file, when building documentation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,196 @@
|
||||
DMBS - Dean's Makefile Build System
|
||||
===================================
|
||||
|
||||
|
||||
Module: GCC
|
||||
-----------------
|
||||
|
||||
The GCC module provides build targets to compile a user application, using a
|
||||
variant of GCC for a specific target architecture (such as `avr-gcc`).
|
||||
|
||||
## Importing This Module into a Makefile:
|
||||
|
||||
To use this module in your application makefile, add the following code to your
|
||||
makefile:
|
||||
|
||||
include $(DMBS_PATH)/gcc.mk
|
||||
|
||||
## Prerequisites:
|
||||
|
||||
This module requires the GCC compiler to be installed and available in the
|
||||
system's `PATH` variable for the desired target architecture.
|
||||
|
||||
## Build Targets:
|
||||
|
||||
The following targets are supported by this module:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>size</td>
|
||||
<td>Show the compiled binary size for the various memory segments.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>symbol-sizes</td>
|
||||
<td>Show the size of each symbol in the compiled binary (useful to find large functions to optimize further).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>all</td>
|
||||
<td>Build application and generate all binary (BIN, ELF, HEX) and auxiliary (LSS, MAP, SYM, etc.) output files.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>lib</td>
|
||||
<td>Generate a static `.a` library from the application code, containing the flash region's data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>elf</td>
|
||||
<td>Generate an ELF debug file from the application code, containing all region's data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>bin</td>
|
||||
<td>Generate a flat BIN binary file from the application code, containing the flash region's data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hex</td>
|
||||
<td>Generate a pair of Intel HEX files from the application code, containing the flash region's data (HEX) and EEPROM data (EEP).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>lss</td>
|
||||
<td>Generate a LSS listing file showing the disassembly of the compiled application.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>clean</td>
|
||||
<td>Remove all generated project intermediary and binary output files.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mostlyclean</td>
|
||||
<td>Remove all generated project intermediary output files, but preserve the binary output files.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>MCU</td>
|
||||
<td>Name of the Atmel processor model (e.g. `at90usb1287`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>TARGET</td>
|
||||
<td>Name of the application output file prefix (e.g. `TestApplication`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ARCH</td>
|
||||
<td>Target device architecture (e.g. `AVR8`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>SRC</td>
|
||||
<td>List of all project source files (C, C++, ASM).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>OPTIMIZATION</td>
|
||||
<td>Optimization level to use when compiling C and C++ source files. Default is `s` (optimize for smallest size).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>C_STANDARD</td>
|
||||
<td>C language standard used when compiling C language source files. Default is `gnu99` (C99 standard with GNU extensions)./td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPP_STANDARD</td>
|
||||
<td>C++ language standard used when compiling C++ language source files. Default is `gnu++98` (C++98 standard with GNU extensions)./td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>F_CPU</td>
|
||||
<td>Processor core clock frequency, in Hz. This is used by some architectures for functions such as software spin-loop delays. Default is blank (no value defined).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>C_FLAGS</td>
|
||||
<td>Common GCC flags passed to the compiler for C language (C) input files. Default is blank (no additional flags).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CPP_FLAGS</td>
|
||||
<td>Common GCC flags passed to the compiler for C++ language (CPP) input files. Default is blank (no additional flags).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ASM_FLAGS</td>
|
||||
<td>Common GCC flags passed to the assembler for assembly language (S) input files. Default is blank (no additional flags).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>CC_FLAGS</td>
|
||||
<td>Common GCC flags passed to the compiler for all source file types. Default is blank (no additional flags).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>LD_FLAGS</td>
|
||||
<td>Extra flags to pass to the GNU linker when linking the compiled object files into the resulting binary. Default is blank (no additional flags).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>LINKER_RELAXATIONS</td>
|
||||
<td>Boolean, if `Y` linker relaxations will be enabled to slightly reduce the resulting binary's size. Default is `Y`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OBJDIR</td>
|
||||
<td>Directory to store the intermediate object files, as they are generated from the source files. Default is `obj`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OBJECT_FILES</td>
|
||||
<td>List of additional `.o` object files to link into the final binary. Default is blank (no additional objects).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DEBUG_FORMAT</td>
|
||||
<td>Debug ELF file format to generate. Default is `dwarf-2`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DEBUG_LEVEL</td>
|
||||
<td>Level of the debugging information to generate in the compiled object files. Debug is 2 (medium level debugging information).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>COMPILER_PATH</td>
|
||||
<td>Path to the compiler to use, in case a specific compiler should be substituted for the one in the system's `PATH` variable. Default is blank (use `PATH` provided compiler).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -0,0 +1,121 @@
|
||||
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](http://www.lufa-lib.org/), but is also
|
||||
made available in its original form directly from the
|
||||
[PJRC website](https://www.pjrc.com/teensy/loader_cli.html). 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](http://www.lufa-lib.org/).
|
||||
|
||||
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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>hid</td>
|
||||
<td>Program a LUFA HID class bootloader device, using the `hid_bootloader_cli.py` Python script.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hid-ee</td>
|
||||
<td>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.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>teensy</td>
|
||||
<td>Program a LUFA HID class bootloader device or Teensy board, using the `teensy_loader_cli` tool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>teensy-ee</td>
|
||||
<td>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.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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:
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>MCU</td>
|
||||
<td>Name of the Atmel processor model (e.g. `at90usb1287`).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>TARGET</td>
|
||||
<td>Name of the application output file prefix (e.g. `TestApplication`).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module has no optional variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Provided Variables:
|
||||
|
||||
The following variables may be referenced in a user makefile (via `$(NAME)`
|
||||
syntax) if desired, as they are provided by this module.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no variables.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>This module provides no macros.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
Loading…
Reference in new issue