tmk_core/protocol/lufa/LUFA-git/LUFA/DoxygenPages/ConfiguringApps.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \page Page_ConfiguringApps Configuring the Demos, Bootloaders and Projects
   8  *
   9  *  If the target microcontroller model, architecture, clock speed, board or other settings are different from the current
  10  *  settings, they must be changed and the project recompiled from the source code before being programmed into the microcontroller.
  11  *  Most project configuration options are located in the <tt>makefile</tt> build script inside each LUFA application's folder,
  12  *  however some demo or application-specific configuration settings are located in one or more of the source files of the project.
  13  *  See each project's individual documentation for application-specific configuration values.
  14  *
  15  *  Each project "makefile" contains all the script and configuration data required to compile each project. When opened with
  16  *  any regular basic text editor such as Notepad or WordPad (ensure that the save format is a pure ASCII text format) the
  17  *  build configuration settings may be altered.
  18  *
  19  *  \see \ref Page_BuildSystem for information on the LUFA build system.
  20  *
  21  *  \section Sec_ConfiguringApps_AppMakefileParams The Default Application Makefile Template
  22  *
  23  *  Below is a copy of the default LUFA application makefile, which can be used as a template for each application.
  24  *
  25  *  \verbinclude makefile_template
  26  *
  27  *  Inside each makefile, a number of configuration variables are listed with the syntax "<VARIABLE NAME> = <VALUE>". For
  28  *  each application, the important standard variables which should be altered are:
  29  *
  30  *    - <b>MCU</b>, the target processor model
  31  *    - <b>ARCH</b>, the target microcontroller architecture
  32  *    - <b>BOARD</b>, the target board hardware
  33  *    - <b>F_CPU</b>, the target CPU master clock frequency, after any prescaling
  34  *    - <b>F_USB</b>, the target raw input clock to the USB module of the processor
  35  *    - <b>OPTIMIZATION</b>, the level of optimization to compile with
  36  *    - <b>TARGET</b>, the name of the target output binary and other files
  37  *    - <b>SRC</b>, the list of source files to compile/assemble/link
  38  *    - <b>LUFA_PATH</b>, the path to the LUFA library core source code
  39  *    - <b>CC_FLAGS</b>, the common command line flags to pass to the C/C++ compiler, assembler and linker
  40  *    - <b>LD_FLAGS</b>, the command line flags to pass to the linker
  41  *
  42  *  These values should be changed to reflect the build hardware.
  43  *
  44  *  \subsection SSec_ConfiguringApps_MCU The MCU Parameter
  45  *  This parameter indicates the target microcontroller model for the compiled application. This should be set to the model of the target
  46  *  microcontroller (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the
  47  *  microcontroller models and architectures, as they may make use of peripherals or modes only present in some devices.
  48  *
  49  *  For supported processor models, see \ref Page_DeviceSupport.
  50  *
  51  *  \subsection SSec_ConfiguringApps_ARCH The ARCH Parameter
  52  *  This parameter indicates the target microcontroller architecture the library is to be compiled for. Different microcontroller
  53  *  architectures require different source files to be compiled into the final binary, and so this option must be set to the correct
  54  *  architecture for the selected platform.
  55  *
  56  *  For supported processor architectures, see \ref Page_DeviceSupport.
  57  *
  58  *  \subsection SSec_ConfiguringApps_BOARD The BOARD Parameter
  59  *  This parameter indicates the target board hardware for the compiled application. Some LUFA library drivers are board-specific,
  60  *  such as the LED driver, and the library needs to know the layout of the target board. If you are using one of the board models listed
  61  *  on the main library page, change this parameter to the board name in all UPPER-case.
  62  *
  63  *  If you are not using any board-specific drivers in the LUFA library, or you are using a custom board layout, change this to read
  64  *  "USER" (no quotes) instead of a standard board name. If the USER board type is selected and the application makes use of one or more
  65  *  board-specific hardware drivers inside the LUFA library, then the appropriate stub drives files should be copied from the \c /CodeTemplates/DriverStubs/
  66  *  directory into a /Board/ folder inside the application directory, and the stub driver completed with the appropriate code to drive the
  67  *  custom board's hardware.
  68  *
  69  *  For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport.
  70  *
  71  *  \subsection SSec_ConfiguringApps_F_CPU The F_CPU Parameter
  72  *  This parameter indicates the target microcontroller's main CPU clock frequency, in Hz. This is used by many libraries (and applications) for
  73  *  timing related purposes, and should reflect the actual CPU speed after any prescaling or adjustments are performed.
  74  *
  75  *  \subsection SSec_ConfiguringApps_F_USB The F_USB Parameter
  76  *  This parameter indicates the raw input clock frequency to the USB module within the microcontroller in Hz. This may be very different on some platforms
  77  *  to the main CPU clock or other peripheral/bus clocks.
  78  *
  79  *    \note On AVR8 platforms, this must be equal to \c 8000000 or \c 16000000.
  80  *
  81  *    \note On XMEGA platforms, this must be equal to a multiple of 6000000 from \c 6000000 to \c 48000000.
  82  *
  83  *    \note On UC3 platforms, this must be equal to a multiple of 12000000 from \c 12000000 to \c 48000000.
  84  *
  85  *  \subsection SSec_ConfiguringApps_OPTIMIZATION The OPTIMIZATION Parameter
  86  *  This parameter indicates the level of optimization to use when compiling the application. This will allow you to compile with an optimization level
  87  *  supported by GCC, from <tt>0</tt> (no optimization) to <tt>3</tt> (fastest runtime optimization) or <tt>s</tt> (smallest size).
  88  *
  89  *  \subsection SSec_ConfiguringApps_TARGET The TARGET Parameter
  90  *  This parameter indicates the application target name, which is used as the base filename for the build binary and debugging files. This will be the
  91  *  name of the output files once linked together into the final application, ready to load into the target.
  92  *
  93  *  \subsection SSec_ConfiguringApps_SRC The SRC Parameter
  94  *  This parameter indicates the source files used to compile the application, as a list of C (<tt>*.c</tt>), C++ (<tt>*.cpp</tt>) and Assembly (<tt>*.S</tt>) files. Note that
  95  *  all assembly files must end in a <b>capital</b> .S extension, as lowercase .s files are reserved for GCC intermediate files.
  96  *
  97  *  \subsection SSec_ConfiguringApps_LUFA_PATH The LUFA_PATH Parameter
  98  *  As each LUFA program requires the LUFA library source code to compile correctly, the application must know where the LUFA library is located. This
  99  *  value specifies the path to the LUFA library core. This path may be relative or absolute, however note than even under Windows based systems the
 100  *  forward-slash (/) path separator must be used.
 101  *
 102  *  \subsection SSec_ConfiguringApps_CC_FLAGS The CC_FLAGS Parameter
 103  *  This parameter lists the compiler flags passed to the C/C++ compiler, the assembler and the linker. These are used as-is directly to GCC and thus
 104  *  must match GCC's command line options as given in the GCC manual. This variable may be used to define tokens directly on the command line, enable or
 105  *  disable warnings, adjust the target-specific tuning parameters or other options.
 106  *
 107  *  \subsection SSec_ConfiguringApps_LD_FLAGS The LD_FLAGS Parameter
 108  *  This parameter lists the linker flags passed exclusively to the linker. These are used as-is directly to GCC and thus must match GCC's command line
 109  *  linker options as given in the GCC manual. This variable may be used to create or relocate custom data sections, or enable linker specific behaviors.
 110  *
 111  *
 112  *  \section Sec_ExampleAppConfig Example Application Makefile Configurations
 113  *  Below is an example makefile for an AVR8 based AT90USB1287 running at 8MHz, to compile a program called "MyApplication":
 114  *  \verbatim
 115     MCU          = at90usb1287
 116     ARCH         = AVR8
 117     BOARD        = NONE
 118     F_CPU        = 8000000
 119     F_USB        = $(F_CPU)
 120     OPTIMIZATION = s
 121     TARGET       = MyApplication
 122     SRC          = MyApplication.c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS)
 123     LUFA_PATH    = ../../../../LUFA
 124     CC_FLAGS     = -DUSE_LUFA_CONFIG_HEADER -IConfig/
 125     LD_FLAGS     =
 126     \endverbatim
 127  *
 128  *  Below is an example makefile for an XMEGA based ATXMEGA128A1U running at 32MHz, to compile a program called "MyApplication":
 129  *  \verbatim
 130     MCU          = atxmega128a1u
 131     ARCH         = XMEGA
 132     BOARD        = NONE
 133     F_CPU        = 32000000
 134     F_USB        = 48000000
 135     OPTIMIZATION = s
 136     TARGET       = MyApplication
 137     SRC          = MyApplication.c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS)
 138     LUFA_PATH    = ../../../../LUFA
 139     CC_FLAGS     = -DUSE_LUFA_CONFIG_HEADER -IConfig/
 140     LD_FLAGS     =
 141     \endverbatim
 142  *
 143  *  Below is an example makefile for a UC3 based AT32UC3A0512 running at 50MHz, to compile a program called "MyApplication":
 144  *  \verbatim
 145     MCU          = uc3a0512
 146     ARCH         = UC3
 147     BOARD        = NONE
 148     F_CPU        = 50000000
 149     F_USB        = 48000000
 150     OPTIMIZATION = s
 151     TARGET       = MyApplication
 152     SRC          = MyApplication.c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS)
 153     LUFA_PATH    = ../../../../LUFA
 154     CC_FLAGS     = -DUSE_LUFA_CONFIG_HEADER -IConfig/
 155     LD_FLAGS     =
 156     \endverbatim
 157  */