Add a list of module provided make variables and macros to the build system modules.
This commit is contained in:
Dean Camera
parent
b9952f4809
commit
44ff0af68c
10 changed files with 305 additions and 39 deletions
|
|
@ -1,574 +0,0 @@
|
|||
/** \file
|
||||
*
|
||||
* This file contains special DoxyGen information for the generation of the main page and other special
|
||||
* documentation pages. It is not a project source file.
|
||||
*/
|
||||
|
||||
/** \page Page_BuildSystem The LUFA Build System
|
||||
*
|
||||
* \section Sec_BuildSystemOverview Overview of the LUFA Build System
|
||||
* The LUFA build system is an attempt at making a set of re-usable, modular build make files which
|
||||
* can be referenced in a LUFA powered project, to minimise the amount of code required in an
|
||||
* application makefile. The system is written in GNU Make, and each module is independant of
|
||||
* one-another.
|
||||
*
|
||||
* To use a LUFA build system module, simply add an include to your project makefile:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.core.in
|
||||
* \endcode
|
||||
*
|
||||
* And the associated build module targets will be added to your project's build makefile automatically.
|
||||
* To call a build target, run <tt>make {TARGET_NAME}</tt> from the command line, substituting in
|
||||
* the appropriate target name.
|
||||
*
|
||||
* \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile.
|
||||
*
|
||||
* Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
|
||||
* be supplied in the project makefile for the module to work, and one or more optional parameters which
|
||||
* may be defined and which will assume a sensible default if not.
|
||||
*
|
||||
* \section SSec_BuildSystemModules Available Modules
|
||||
*
|
||||
* The following modules are included in this LUFA release:
|
||||
*
|
||||
* \li \subpage Page_BuildModule_ATPROGRAM - Device Programming
|
||||
* \li \subpage Page_BuildModule_AVRDUDE - Device Programming
|
||||
* \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking
|
||||
* \li \subpage Page_BuildModule_CORE - Core Build System Functions
|
||||
* \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis
|
||||
* \li \subpage Page_BuildModule_DFU - Device Programming
|
||||
* \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation
|
||||
* \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_BUILD The BUILD build module
|
||||
*
|
||||
* The BUILD LUFA build system module, providing targets for the compilation,
|
||||
* assembling and linking of an application from source code into binary files
|
||||
* suitable for programming into a target device.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.build.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_BUILD_Requirements Requirements
|
||||
* This module requires the the architecture appropriate binaries of the GCC compiler are available in your
|
||||
* system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio
|
||||
* 5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages.
|
||||
*
|
||||
* \section SSec_BuildModule_BUILD_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>size</tt></td>
|
||||
* <td>Display size of the compiled application FLASH and SRAM segments.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>symbol-sizes</tt></td>
|
||||
* <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>all</tt></td>
|
||||
* <td>Build and link the application into ELF debug and HEX binary files.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>elf</tt></td>
|
||||
* <td>Build and link the application into an ELF debug file.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>hex</tt></td>
|
||||
* <td>Build and link the application and produce HEX and EEP binary files.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>lss</tt></td>
|
||||
* <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>clean</tt></td>
|
||||
* <td>Remove all intermediatary files and binary output files.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>TARGET</tt></td>
|
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ARCH</tt></td>
|
||||
* <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>MCU</tt></td>
|
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>SRC</tt></td>
|
||||
* <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>F_USB</tt></td>
|
||||
* <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>LUFA_PATH</tt></td>
|
||||
* <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>BOARD</tt></td>
|
||||
* <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>OPTIMIZATION</tt></td>
|
||||
* <td>Optimization level to use when compiling source files (see GCC manual).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>C_STANDARD</tt></td>
|
||||
* <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPP_STANDARD</tt></td>
|
||||
* <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>F_CPU</tt></td>
|
||||
* <td>Speed of the processor CPU clock, in Hz.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>C_FLAGS</tt></td>
|
||||
* <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPP_FLAGS</tt></td>
|
||||
* <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ASM_FLAGS</tt></td>
|
||||
* <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CC_FLAGS</tt></td>
|
||||
* <td>Common flags to pass to the compiler, assembler and linker, after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>LD_FLAGS</tt></td>
|
||||
* <td>Flags to pass to the linker, after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_CORE The CORE build module
|
||||
*
|
||||
* The core LUFA build system module, providing common build system help and information targets.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.core.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_CORE_Requirements Requirements
|
||||
* This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt>
|
||||
* shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.).
|
||||
*
|
||||
* \section SSec_BuildModule_CORE_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>help</tt></td>
|
||||
* <td>Display build system help and configuration information.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>list_targets</tt></td>
|
||||
* <td>List all available build targets from the build system.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>list_modules</tt></td>
|
||||
* <td>List all available build modules from the build system.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>list_mandatory</tt></td>
|
||||
* <td>List all mandatory parameters required by the included modules.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>list_optional</tt></td>
|
||||
* <td>List all optional parameters required by the included modules.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><i>None</i></td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><i>None</i></td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
|
||||
*
|
||||
* The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an
|
||||
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.atprogram.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_ATPROGRAM_Requirements Requirements
|
||||
* This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>
|
||||
* variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x
|
||||
* inside the application install folder's "\avrdbg" subdirectory.
|
||||
*
|
||||
* \section SSec_BuildModule_ATPROGRAM_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>atprogram</tt></td>
|
||||
* <td>Program the device FLASH memory with the application's executable data.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>atprogram-ee</tt></td>
|
||||
* <td>Program the device EEPROM memory with the application's EEPROM data.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>MCU</tt></td>
|
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>TARGET</tt></td>
|
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>ATPROGRAM_PROGRAMMER</tt></td>
|
||||
* <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ATPROGRAM_INTERFACE</tt></td>
|
||||
* <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ATPROGRAM_PORT</tt></td>
|
||||
* <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
|
||||
*
|
||||
* The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an
|
||||
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.avrdude.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_AVRDUDE_Requirements Requirements
|
||||
* This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b>
|
||||
* variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for
|
||||
* Windows (<a>winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's
|
||||
* source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager.
|
||||
*
|
||||
* \section SSec_BuildModule_AVRDUDE_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>avrdude</tt></td>
|
||||
* <td>Program the device FLASH memory with the application's executable data.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>avrdude</tt></td>
|
||||
* <td>Program the device EEPROM memory with the application's EEPROM data.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>MCU</tt></td>
|
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>TARGET</tt></td>
|
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>AVRDUDE_PROGRAMMER</tt></td>
|
||||
* <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ATPROGRAM_PORT</tt></td>
|
||||
* <td>Name of the communication port to use when when programming with the connected tool (e.g. <tt>COM2</tt>, <tt>/dev/ttyUSB0</tt> or <tt>usb</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ATPROGRAM_FLAGS</tt></td>
|
||||
* <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
|
||||
*
|
||||
* The CPPCHECK programming utility LUFA build system module, providing targets to statically
|
||||
* analyze C and C++ source code for errors and performance/style issues.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.cppcheck.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_CPPCHECK_Requirements Requirements
|
||||
* This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b>
|
||||
* variable. The <tt>cppcheck</tt> utility is distributed through the project's home page
|
||||
* (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via
|
||||
* the project's source code or through the package manager.
|
||||
*
|
||||
* \section SSec_BuildModule_CPPCHECK_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>cppcheck</tt></td>
|
||||
* <td>Statically analyze the project source code for issues.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>cppcheck-config</tt></td>
|
||||
* <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>SRC</tt></td>
|
||||
* <td>List of source files to statically analyze.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_INCLUDES</tt></td>
|
||||
* <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_EXCLUDES</tt></td>
|
||||
* <td>Paths or path fragments to exclude when analyzing.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td>
|
||||
* <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_ENABLE</tt></td>
|
||||
* <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_SUPPRESS</tt></td>
|
||||
* <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td>
|
||||
* <td>Set to <b>Y</b> to fail the analysis job with an error exit code if warnings are found, <b>N</b> to continue without failing.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_QUIET</tt></td>
|
||||
* <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>CPPCHECK_FLAGS</tt></td>
|
||||
* <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_DFU The DFU build module
|
||||
*
|
||||
* The DFU programming utility LUFA build system module, providing targets to reprogram an
|
||||
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
|
||||
* This module requires a DFU class bootloader to be running in the target.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.dfu.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_DFU_Requirements Requirements
|
||||
* This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open
|
||||
* source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be
|
||||
* available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility
|
||||
* can be installed via the project's source code or through the package manager.
|
||||
*
|
||||
* \section SSec_BuildModule_DFU_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>dfu</tt></td>
|
||||
* <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>dfu-ee</tt></td>
|
||||
* <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>flip</tt></td>
|
||||
* <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>flip-ee</tt></td>
|
||||
* <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>MCU</tt></td>
|
||||
* <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>TARGET</tt></td>
|
||||
* <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><i>None</i></td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
|
||||
*
|
||||
* The DOXYGEN code documentation utility LUFA build system module, providing targets to generate
|
||||
* project HTML and other format documentation from a set of source files that include special
|
||||
* Doxygen comments.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.doxygen.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_DOXYGEN_Requirements Requirements
|
||||
* This module requires the <tt>doxygen</tt> utility from the Doxygen website
|
||||
* (<a>http://www.stack.nl/~dimitri/doxygen/</a>) to be available in your system's <b>PATH</b>
|
||||
* variable. On *nix systems the <tt>doxygen</tt> utility can be installed via the project's source
|
||||
* code or through the package manager.
|
||||
*
|
||||
* \section SSec_BuildModule_DOXYGEN_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>doxygen</tt></td>
|
||||
* <td>Generate project documentation.</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>LUFA_PATH</tt></td>
|
||||
* <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>DOXYGEN_CONF</tt></td>
|
||||
* <td>Name and path of the base Doxygen configuration file for the project.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td>
|
||||
* <td>Set to <b>Y</b> to fail the generation with an error exit code if warnings are found other than unsupported configuration parameters, <b>N</b> to continue without failing.</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td>
|
||||
* <td>Extra Doxygen configuration parameters to apply, overriding the corresponding config entry in the project's configuration file (e.g. <tt>QUIET=YES</tt>).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
||||
/** \page Page_BuildModule_SOURCES The SOURCES build module
|
||||
*
|
||||
* The SOURCES LUFA build system module, providing variables listing the various LUFA source files
|
||||
* required to be build by a project for a given LUFA module. This module gives a way to reference
|
||||
* LUFA source files symbollically, so that changes to the library structure do not break the library
|
||||
* makefile.
|
||||
*
|
||||
* To use this module in your application makefile, add the following code:
|
||||
* \code
|
||||
* include $(LUFA_PATH)/Build/lufa.sources.in
|
||||
* \endcode
|
||||
*
|
||||
* \section SSec_BuildModule_SOURCES_Requirements Requirements
|
||||
* None.
|
||||
*
|
||||
* \section SSec_BuildModule_SOURCES_Targets Targets
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><i>None</i></td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><tt>LUFA_PATH</tt></td>
|
||||
* <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
|
||||
* </tr>
|
||||
* <tr>
|
||||
* <td><tt>ARCH</tt></td>
|
||||
* <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
* <td><i>None</i></td>
|
||||
* </tr>
|
||||
* </table>
|
||||
*/
|
||||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += ATPROGRAM
|
||||
LUFA_BUILD_TARGETS += atprogram atprogram-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS += ATPROGRAM_PROGRAMMER ATPROGRAM_INTERFACE ATPROGRAM_PORT
|
||||
LUFA_BUILD_MODULES += ATPROGRAM
|
||||
LUFA_BUILD_TARGETS += atprogram atprogram-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS += ATPROGRAM_PROGRAMMER ATPROGRAM_INTERFACE ATPROGRAM_PORT
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA ATPROGRAM Programmer Buildsystem Makefile Module.
|
||||
|
|
@ -36,6 +38,14 @@ LUFA_BUILD_OPTIONAL_VARS += ATPROGRAM_PROGRAMMER ATPROGRAM_INTERFACE ATPROGRAM_
|
|||
# ATPROGRAM_INTERFACE - Name of programming interface to use
|
||||
# ATPROGRAM_PORT - Name of communication port to use
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += AVRDUDE
|
||||
LUFA_BUILD_TARGETS += avrdude avrdude-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS += AVRDUDE_PROGRAMMER AVRDUDE_PORT AVRDUDE_FLAGS
|
||||
LUFA_BUILD_MODULES += AVRDUDE
|
||||
LUFA_BUILD_TARGETS += avrdude avrdude-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS += AVRDUDE_PROGRAMMER AVRDUDE_PORT AVRDUDE_FLAGS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA AVRDUDE Programmer Buildsystem Makefile Module.
|
||||
|
|
@ -36,6 +38,14 @@ LUFA_BUILD_OPTIONAL_VARS += AVRDUDE_PROGRAMMER AVRDUDE_PORT AVRDUDE_FLAGS
|
|||
# AVRDUDE_PORT - Name of communication port to use
|
||||
# AVRDUDE_FLAGS - Flags to pass to avr-dude
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += BUILD
|
||||
LUFA_BUILD_TARGETS += size symbol-sizes all elf hex lss clean
|
||||
LUFA_BUILD_MANDATORY_VARS += TARGET ARCH MCU SRC F_USB LUFA_PATH
|
||||
LUFA_BUILD_OPTIONAL_VARS += BOARD OPTIMIZATION C_STANDARD CPP_STANDARD F_CPU C_FLAGS CPP_FLAGS ASM_FLAGS CC_FLAGS LD_FLAGS
|
||||
LUFA_BUILD_MODULES += BUILD
|
||||
LUFA_BUILD_TARGETS += size symbol-sizes all elf hex lss clean
|
||||
LUFA_BUILD_MANDATORY_VARS += TARGET ARCH MCU SRC F_USB LUFA_PATH
|
||||
LUFA_BUILD_OPTIONAL_VARS += BOARD OPTIMIZATION C_STANDARD CPP_STANDARD F_CPU C_FLAGS CPP_FLAGS ASM_FLAGS CC_FLAGS LD_FLAGS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA GCC Compiler Buildsystem Makefile Module.
|
||||
|
|
@ -53,6 +55,14 @@ LUFA_BUILD_OPTIONAL_VARS += BOARD OPTIMIZATION C_STANDARD CPP_STANDARD F_CPU C_
|
|||
# assembler
|
||||
# LD_FLAGS - Flags to pass to the linker
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += CORE
|
||||
LUFA_BUILD_TARGETS += help list_targets list_modules list_mandatory list_optional
|
||||
LUFA_BUILD_MANDATORY_VARS +=
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_MODULES += CORE
|
||||
LUFA_BUILD_TARGETS += help list_targets list_modules list_mandatory list_optional list_provided list_macros
|
||||
LUFA_BUILD_MANDATORY_VARS +=
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA Core Build System Makefile Module.
|
||||
|
|
@ -26,6 +28,10 @@ LUFA_BUILD_OPTIONAL_VARS +=
|
|||
# the included build modules of the application
|
||||
# list_optional - List all optional make variables required by
|
||||
# the included build modules of the application
|
||||
# list_provided - List all provided make variables from the
|
||||
# included build modules of the application
|
||||
# list_macros - List all provided make macros from the
|
||||
# included build modules of the application
|
||||
#
|
||||
# MANDATORY PARAMETERS:
|
||||
#
|
||||
|
|
@ -35,13 +41,23 @@ LUFA_BUILD_OPTIONAL_VARS +=
|
|||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
# Build sorted and filtered lists of the included build module data
|
||||
SORTED_LUFA_BUILD_MODULES = $(sort $(LUFA_BUILD_MODULES))
|
||||
SORTED_LUFA_BUILD_TARGETS = $(sort $(LUFA_BUILD_TARGETS))
|
||||
SORTED_LUFA_MANDATORY_VARS = $(sort $(LUFA_BUILD_MANDATORY_VARS))
|
||||
SORTED_LUFA_OPTIONAL_VARS = $(filter-out $(SORTED_LUFA_MANDATORY_VARS), $(sort $(LUFA_BUILD_OPTIONAL_VARS)))
|
||||
SORTED_LUFA_BUILD_MODULES = $(sort $(LUFA_BUILD_MODULES))
|
||||
SORTED_LUFA_BUILD_TARGETS = $(sort $(LUFA_BUILD_TARGETS))
|
||||
SORTED_LUFA_MANDATORY_VARS = $(sort $(LUFA_BUILD_MANDATORY_VARS))
|
||||
SORTED_LUFA_OPTIONAL_VARS = $(filter-out $(SORTED_LUFA_MANDATORY_VARS), $(sort $(LUFA_BUILD_OPTIONAL_VARS)))
|
||||
SORTED_LUFA_PROVIDED_VARS = $(sort $(LUFA_BUILD_PROVIDED_VARS))
|
||||
SORTED_LUFA_PROVIDED_MACROS = $(sort $(LUFA_BUILD_PROVIDED_MACROS))
|
||||
|
||||
help:
|
||||
@echo "==================================================================="
|
||||
|
|
@ -85,6 +101,16 @@ help:
|
|||
@echo " "
|
||||
@printf " %b" "$(SORTED_LUFA_OPTIONAL_VARS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Variables provided by the selected build Modules: "
|
||||
@echo " "
|
||||
@printf " %b" "$(SORTED_LUFA_PROVIDED_VARS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo " "
|
||||
@echo " Macros provided by the selected build Modules: "
|
||||
@echo " "
|
||||
@printf " %b" "$(SORTED_LUFA_PROVIDED_MACROS:%= - %\n)"
|
||||
@echo " "
|
||||
@echo "==================================================================="
|
||||
@echo " The LUFA BuildSystem 2.0 - Powered By Unicorns (tm) "
|
||||
@echo "==================================================================="
|
||||
|
|
@ -101,9 +127,15 @@ list_mandatory:
|
|||
list_optional:
|
||||
@echo Optional Variables for Included Modules: $(SORTED_LUFA_OPTIONAL_VARS)
|
||||
|
||||
list_provided:
|
||||
@echo Variables Provided by the Included Modules $(SORTED_LUFA_PROVIDED_VARS)
|
||||
|
||||
list_macros:
|
||||
@echo Macros Provided by the Included Modules $(SORTED_LUFA_PROVIDED_MACROS)
|
||||
|
||||
# Disable default in-built make rules (those that are needed are explicitly
|
||||
# defined, and doing so has performance benefits when recursively building)
|
||||
.SUFFIXES:
|
||||
|
||||
# Phony build targets for this module
|
||||
.PHONY: help list_modules list_targets list_mandatory list_optional
|
||||
.PHONY: help list_modules list_targets list_mandatory list_optional list_provided list_macros
|
||||
|
|
|
|||
|
|
@ -6,11 +6,13 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += CPPCHECK
|
||||
LUFA_BUILD_TARGETS += cppcheck cppcheck-config
|
||||
LUFA_BUILD_MANDATORY_VARS += SRC
|
||||
LUFA_BUILD_OPTIONAL_VARS += CPPCHECK_INCLUDES CPPCHECK_EXCLUDES CPPCHECK_MSG_TEMPLATE CPPCHECK_ENABLE \
|
||||
CPPCHECK_SUPPRESS CPPCHECK_FAIL_ON_WARNING CPPCHECK_QUIET CPPCHECK_FLAGS
|
||||
LUFA_BUILD_MODULES += CPPCHECK
|
||||
LUFA_BUILD_TARGETS += cppcheck cppcheck-config
|
||||
LUFA_BUILD_MANDATORY_VARS += SRC
|
||||
LUFA_BUILD_OPTIONAL_VARS += CPPCHECK_INCLUDES CPPCHECK_EXCLUDES CPPCHECK_MSG_TEMPLATE CPPCHECK_ENABLE \
|
||||
CPPCHECK_SUPPRESS CPPCHECK_FAIL_ON_WARNING CPPCHECK_QUIET CPPCHECK_FLAGS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA CPPCheck Buildsystem Makefile Module.
|
||||
|
|
@ -42,6 +44,14 @@ LUFA_BUILD_OPTIONAL_VARS += CPPCHECK_INCLUDES CPPCHECK_EXCLUDES CPPCHECK_MSG_TE
|
|||
# CPPCHECK_QUIET - Enable cppcheck verbose or quiet output mode
|
||||
# CPPCHECK_FLAGS - Additional flags to pass to cppcheck
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += DFU
|
||||
LUFA_BUILD_TARGETS += flip flip-ee dfu dfu-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_MODULES += DFU
|
||||
LUFA_BUILD_TARGETS += flip flip-ee dfu dfu-ee
|
||||
LUFA_BUILD_MANDATORY_VARS += MCU TARGET
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA DFU Bootloader Buildsystem Makefile Module.
|
||||
|
|
@ -34,6 +36,14 @@ LUFA_BUILD_OPTIONAL_VARS +=
|
|||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += DOXYGEN
|
||||
LUFA_BUILD_TARGETS += doxygen
|
||||
LUFA_BUILD_MANDATORY_VARS += LUFA_PATH
|
||||
LUFA_BUILD_OPTIONAL_VARS += DOXYGEN_CONF DOXYGEN_FAIL_ON_WARNING DOXYGEN_OVERRIDE_PARAMS
|
||||
LUFA_BUILD_MODULES += DOXYGEN
|
||||
LUFA_BUILD_TARGETS += doxygen
|
||||
LUFA_BUILD_MANDATORY_VARS += LUFA_PATH
|
||||
LUFA_BUILD_OPTIONAL_VARS += DOXYGEN_CONF DOXYGEN_FAIL_ON_WARNING DOXYGEN_OVERRIDE_PARAMS
|
||||
LUFA_BUILD_PROVIDED_VARS +=
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA Doxygen Buildsystem Makefile Module.
|
||||
|
|
@ -33,6 +35,14 @@ LUFA_BUILD_OPTIONAL_VARS += DOXYGEN_CONF DOXYGEN_FAIL_ON_WARNING DOXYGEN_OVERRI
|
|||
# N to continue even if warnings occur
|
||||
# DOXYGEN_OVERRIDE_PARAMS - Parameters to override in the doxygen
|
||||
# configuration file
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@
|
|||
# www.lufa-lib.org
|
||||
#
|
||||
|
||||
LUFA_BUILD_MODULES += SOURCES
|
||||
LUFA_BUILD_TARGETS +=
|
||||
LUFA_BUILD_MANDATORY_VARS += LUFA_PATH ARCH
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_MODULES += SOURCES
|
||||
LUFA_BUILD_TARGETS +=
|
||||
LUFA_BUILD_MANDATORY_VARS += LUFA_PATH ARCH
|
||||
LUFA_BUILD_OPTIONAL_VARS +=
|
||||
LUFA_BUILD_PROVIDED_VARS += LUFA_SRC_USB LUFA_SRC_USBCLASS LUFA_SRC_TEMPERATURE LUFA_SRC_SERIAL LUFA_SRC_TWI LUFA_SRC_PLATFORM
|
||||
LUFA_BUILD_PROVIDED_MACROS +=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# LUFA Sources Buildsystem Makefile Module.
|
||||
|
|
@ -33,6 +35,21 @@ LUFA_BUILD_OPTIONAL_VARS +=
|
|||
#
|
||||
# (None)
|
||||
#
|
||||
# PROVIDED VARIABLES:
|
||||
#
|
||||
# LUFA_SRC_USB - List of LUFA USB driver source files
|
||||
# LUFA_SRC_USBCLASS - List of LUFA USB Class driver source files
|
||||
# LUFA_SRC_TEMPERATURE - List of LUFA temperature sensor driver source
|
||||
# files
|
||||
# LUFA_SRC_SERIAL - List of LUFA Serial U(S)ART driver source files
|
||||
# LUFA_SRC_TWI - List of LUFA TWI driver source files
|
||||
# LUFA_SRC_PLATFORM - List of LUFA architecture specific platform
|
||||
# management source files
|
||||
#
|
||||
# PROVIDED MACROS:
|
||||
#
|
||||
# (None)
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
ERROR_IF_UNSET = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue