2 # Copyright (c) 2007-2010, Intel Corporation
3 # Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
4 # All rights reserved. This program and the accompanying materials
5 # are licensed and made available under the terms and conditions of the BSD License
6 # which accompanies this distribution. The full text of the license may be found at
7 # http://opensource.org/licenses/bsd-license.php
9 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 # Filename: build_rule.template
17 # "*" is used to indicate that the source files will be processed at the same time.
18 # "?" is used to indicate that the source files will be processed one by one.
20 # "[" <File-Type>[.<Build-Type>][.<Arch>][, <File-Type>[.<Build-Type>][.<Arch>]] "]" <EOL>
21 # <InputFile[.<ToolChainFamily>]> <EOL>
22 # (?|*).<File-Extension> [(\n|,) (?|*).<File-Extension>]
24 # <OutputFile[.<ToolChainFamily>]> <EOL>
30 # <Command[.<ToolChainFamily>]> <EOL>
34 # <Build-Type> is the MODULE_TYPE in EDK2 or COMPONENT_TYPE in EDK.
35 # Missing <InputFile> will cause an exception and break build.
36 # Missing <Command> will cause that related build target won't be generated but
40 ## Placeholders for string substitution
42 # ${src} Source file(s) to be built (full path)
43 # ${s_path} Source file directory (absolute path)
44 # ${s_dir} Source file relative directory within a module
45 # (Note: ${s_dir} is always equals to "." if source file is given in absolute path.)
46 # ${s_name} Source file name without path
47 # ${s_base} Source file name without extension and path
48 # ${s_ext} Source file extension
50 # ${dst} Destination file(s) built from ${src} (full path)
51 # ${d_path} Destination file directory (absolute path)
52 # ${d_name} Destination file name without path
53 # ${d_base} Destination file name without extension and path
54 # ${d_ext} Destination file extension
56 # (+) Directory separator
60 # $(WORKSPACE) Workspace directory
61 # $(OUTPUT_DIR) Directory for intermediate files for building a module
62 # $(DEBUG_DIR) Directory for files used to debug a module
63 # $(BUILD_DIR) All files for building a platform will be put in this directory
64 # $(BIN_DIR) Common directory for executable files
65 # $(FV_DIR) Directory to store flash image files
66 # $(INC) Search path of current module
67 # $(INC_LIST) A file containing search pathes of current module
68 # $(LIBS) Static library files of current module
69 # $(<tool>_FLAGS) Tools flags of current module
70 # $(MODULE_NAME) Current module name
71 # $(MODULE_TYPE) Current module type
72 # $(MODULE_GUID) Current module guid
73 # $(ARCH) Architecture of current module
74 # $(TOOLCHAIN) Toolchain used to build current module
75 # $(TARGET) Target of current module (DEBUG/RELEASE)
76 # $(<tool>) Path of tool
77 # $(EDK_TOOLS_PATH) Path of build tools
78 # $(<FILE_TYPES>) File list of each file type
79 # (Note: The macro name is derived from file type name. For example,
80 # C-Code-File will have C_CODE_FILES macro.)
81 # $(<FILE_TYPES_LIST>) Macro point to a file containing list of files of a file type
83 # Note: The macro and file name are derived from file type name.
84 # For example, C-Code-File will have C_CODE_FILES_LIST macro pointing
85 # to $(OUTPUT_DIR)/c_code_files.lst. The list file and macro name
86 # will be generated only when this macro is used in command line.
87 # This is intended to get over the long command line limitation.
92 # $(RM) delete command
93 # $(MD) create dir command
94 # $(RD) remove dir command
99 # Don't change following names of file types and their associated files,
100 # which are also used in tools' code
104 # Dynamic-Library-File
105 # Static-Library-File
106 # Visual-Form-Representation-File
124 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
126 <Command.MSFT, Command.INTEL>
127 "$(CC)" /Fo${dst} $(CC_FLAGS) $(INC) ${src}
129 <Command.GCC, Command.RVCT>
130 # For RVCTCYGWIN CC_FLAGS must be first to work around pathing issues
131 "$(CC)" $(CC_FLAGS) -o ${dst} $(INC) ${src}
132 "$(SYMRENAME)" $(SYMRENAME_FLAGS) ${dst}
135 "$(CC)" $(CC_FLAGS) -o ${dst} $(INC) ${src}
147 [Assembly-Code-File.COMMON.COMMON]
148 <InputFile.MSFT, InputFile.INTEL, InputFile.RVCT>
158 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
160 <Command.MSFT, Command.INTEL>
161 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
162 Trim --source-code --convert-hex -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
163 "$(ASM)" /Fo${dst} $(ASM_FLAGS) /I${s_path} $(INC) ${d_path}(+)${s_base}.iii
165 <Command.GCC, Command.RVCT>
166 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
167 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
168 # For RVCTCYGWIN ASM_FLAGS must be first to work around pathing issues
169 "$(ASM)" $(ASM_FLAGS) -o ${dst} $(INC) ${d_path}(+)${s_base}.iii
171 [Assembly-Code-File.COMMON.IPF]
179 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
181 <Command.MSFT, Command.INTEL>
182 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
183 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
184 # For RVCTCYGWIN ASM_FLAGS must be first to work around pathing issues
185 "$(ASM)" $(ASM_FLAGS) -o ${dst} ${d_path}(+)${s_base}.iii
187 [Visual-Form-Representation-File]
197 $(DEBUG_DIR)(+)${s_dir}(+)${s_base}.c
200 -$(MD) $(OUTPUT_DIR)(+)${s_dir} > NUL 2>&1
201 "$(VFRPP)" $(VFRPP_FLAGS) $(INC) ${src} > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
202 -$(MD) ${d_path} > NUL 2>&1
203 "$(VFR)" $(VFR_FLAGS) --output-directory ${d_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
211 $(OUTPUT_DIR)(+)$(MODULE_NAME).lib
213 <Command.MSFT, Command.INTEL>
214 "$(SLINK)" $(SLINK_FLAGS) /OUT:${dst} @$(OBJECT_FILES_LIST)
217 "$(SLINK)" -cr ${dst} $(SLINK_FLAGS) @$(OBJECT_FILES_LIST)
220 "$(SLINK)" $(SLINK_FLAGS) ${dst} --via $(OBJECT_FILES_LIST)
222 <Command.RVCTCYGWIN, Command.ARMGCC>
223 # $(OBJECT_FILES_LIST) has wrong paths for cygwin
224 "$(SLINK)" $(SLINK_FLAGS) ${dst} $(OBJECT_FILES)
227 "$(SLINK)" $(SLINK_FLAGS) ${dst} -filelist $(OBJECT_FILES_LIST)
229 [Static-Library-File]
237 $(DEBUG_DIR)(+)$(MODULE_NAME).dll
239 <Command.MSFT, Command.INTEL>
240 "$(DLINK)" /OUT:${dst} $(DLINK_FLAGS) $(DLINK_SPATH) @$(STATIC_LIBRARY_FILES_LIST)
243 "$(DLINK)" -o ${dst} $(DLINK_FLAGS) -\( $(DLINK_SPATH) @$(STATIC_LIBRARY_FILES_LIST) -\) $(DLINK2_FLAGS)
244 "$(OBJCOPY)" $(OBJCOPY_FLAGS) ${dst}
247 "$(DLINK)" -o ${dst} $(DLINK_FLAGS) -( $(DLINK_SPATH) $(STATIC_LIBRARY_FILES) -) $(DLINK2_FLAGS)
250 "$(DLINK)" $(DLINK_FLAGS) -o ${dst} $(DLINK_SPATH) --via $(STATIC_LIBRARY_FILES_LIST) $(DLINK2_FLAGS)
253 #$(STATIC_LIBRARY_FILES_LIST) has wrong paths for cygwin
254 "$(DLINK)" $(DLINK_FLAGS) -o ${dst} $(DLINK_SPATH) $(STATIC_LIBRARY_FILES) $(DLINK2_FLAGS)
257 "$(DLINK)" $(DLINK_FLAGS) -o ${dst} $(DLINK_SPATH) -filelist $(STATIC_LIBRARY_FILES_LIST) $(DLINK2_FLAGS)
260 [Static-Library-File.USER_DEFINED]
268 $(DEBUG_DIR)(+)$(MODULE_NAME)
270 <Command.MSFT, Command.INTEL>
271 "$(DLINK)" $(DLINK_FLAGS) $(DLINK_SPATH) @$(STATIC_LIBRARY_FILES_LIST)
274 "$(DLINK)" $(DLINK_FLAGS) -\( $(DLINK_SPATH) @$(STATIC_LIBRARY_FILES_LIST) -\) $(DLINK2_FLAGS)
277 "$(DLINK)" $(DLINK_FLAGS) -( $(DLINK_SPATH) $(STATIC_LIBRARY_FILES) -) $(DLINK2_FLAGS)
280 "$(DLINK)" $(DLINK_FLAGS) -o ${dst} $(DLINK_SPATH) --via $(STATIC_LIBRARY_FILES_LIST) $(DLINK2_FLAGS)
283 #$(STATIC_LIBRARY_FILES_LIST) has the wrong paths for cygwin
284 "$(DLINK)" $(DLINK_FLAGS) -o ${dst} $(DLINK_SPATH) $(STATIC_LIBRARY_FILES) $(DLINK2_FLAGS)
287 "$(DLINK)" -o ${dst} $(DLINK_FLAGS) $(DLINK_SPATH) -filelist $(STATIC_LIBRARY_FILES_LIST) $(DLINK2_FLAGS)
290 [Dynamic-Library-File]
295 $(DEBUG_DIR)(+)$(MODULE_NAME).efi
297 <Command.MSFT, Command.INTEL, Command.RVCT, Command.ARMGCC>
298 GenFw -e $(MODULE_TYPE) -o ${dst} ${src}
299 $(CP) ${dst} $(OUTPUT_DIR)
300 $(CP) ${dst} $(BIN_DIR)
301 -$(CP) $(DEBUG_DIR)(+)*.map $(OUTPUT_DIR)
304 $(OBJCOPY) --only-keep-debug ${src} $(BIN_DIR)(+)$(MODULE_NAME).debug
305 $(OBJCOPY) --strip-unneeded ${src}
306 $(OBJCOPY) --add-gnu-debuglink=$(BIN_DIR)(+)$(MODULE_NAME).debug ${src}
307 GenFw -e $(MODULE_TYPE) -o ${dst} ${src}
308 $(CP) ${dst} $(OUTPUT_DIR)
309 $(CP) ${dst} $(BIN_DIR)
310 -$(CP) $(DEBUG_DIR)(+)*.map $(OUTPUT_DIR)
313 # tool to convert Mach-O to PE/COFF
314 "$(MTOC)" -subsystem $(MODULE_TYPE) $(MTOC_FLAGS) ${src} $(DEBUG_DIR)(+)$(MODULE_NAME).pecoff
315 # create symbol file for GDB debug
317 GenFw --xip -e $(MODULE_TYPE) -o ${dst} $(DEBUG_DIR)(+)$(MODULE_NAME).pecoff
318 $(CP) ${dst} $(OUTPUT_DIR)
319 $(CP) ${dst} $(BIN_DIR)
320 -$(CP) $(DEBUG_DIR)(+)*.map $(OUTPUT_DIR)
322 [Dependency-Expression-File]
327 $(OUTPUT_DIR)(+)$(MODULE_NAME).depex
330 "$(PP)" $(CC_FLAGS) $(APP_FLAGS) $(INC) ${src} > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
331 Trim --source-code -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
332 GenDepex -t $(MODULE_TYPE) -o ${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
334 [Acpi-Source-Language-File]
339 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml
344 <Command.MSFT, Command.INTEL>
345 Trim --asl-file -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i ${src}
346 "$(ASLPP)" $(ASLPP_FLAGS) $(INC) /I${s_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
347 "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
350 Trim --asl-file -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i ${src}
351 "$(ASLPP)" $(ASLPP_FLAGS) $(INC) -I${s_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
352 "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
354 [C-Code-File.AcpiTable]
359 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.acpi
364 <Command.MSFT, Command.INTEL>
365 "$(ASLCC)" /Fo$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(CC_FLAGS) $(ASLCC_FLAGS) $(INC) ${src}
366 "$(ASLDLINK)" /OUT:$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
367 GenFw -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll
370 "$(ASLCC)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(CC_FLAGS) $(ASLCC_FLAGS) $(INC) ${src}
371 "$(ASLDLINK)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
372 GenFw -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll
374 [Acpi-Table-Code-File]
379 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.acpi
384 <Command.MSFT, Command.INTEL>
385 "$(ASLCC)" /Fo$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(CC_FLAGS) $(ASLCC_FLAGS) $(INC) ${src}
386 "$(ASLDLINK)" /OUT:$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
387 GenFw -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll
390 "$(ASLCC)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(CC_FLAGS) $(ASLCC_FLAGS) $(INC) ${src}
391 "$(ASLDLINK)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
392 GenFw -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll
395 "$(ASLCC)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASLCC_FLAGS) $(INC) ${src}
396 "$(ASLDLINK)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
397 "$(MTOC)" -subsystem $(MODULE_TYPE) $(MTOC_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.efi
398 GenFw -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.efi
403 ?.asm16, ?.Asm16, ?.ASM16
409 $(OUTPUT_DIR)(+)${s_base}.com
411 <Command.MSFT, Command.INTEL>
412 cd $(OUTPUT_DIR)(+)${s_dir}
413 "$(ASM)" /nologo /c /omf /Fo$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj ${src}
414 "$(ASMLINK)" $(ASMLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj,${dst},,,,
417 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
418 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
419 "$(ASM)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASM_FLAGS) $(INC) ${d_path}(+)${s_base}.iii
420 "$(DLINK)" -o ${dst} $(DLINK_FLAGS) -( $(DLINK_SPATH) $(LIBS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj -)
423 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
424 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
425 "$(ASM)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASM_FLAGS) $(INC) ${d_path}(+)${s_base}.iii
426 "$(SLINK)" $(SLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.slib $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
427 otool -t $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.slib | hex2bin.py ${dst}
430 [Microcode-File.USER_DEFINED, Microcode-File.Microcode]
432 ?.txt, ?.TXT, ?.Txt, ?.mut, ?.inc
435 $(OUTPUT_DIR)(+)${s_base}.mcb
438 GenFw -o ${dst} -m ${src}
440 [Microcode-Binary-File]
448 $(OUTPUT_DIR)(+)$(MODULE_NAME).bin
451 GenFw -o ${dst} -j $(MICROCODE_BINARY_FILES)
452 -$(CP) ${dst} $(BIN_DIR)
467 $(DEBUG_DIR)(+)AutoGen.c
468 $(DEBUG_DIR)(+)$(MODULE_NAME)StrDefs.h
472 [Efi-Image.UEFI_OPTIONROM]
477 $(BIN_DIR)(+)$(MODULE_NAME).rom
480 $(OPTROM) -i $(PCI_DEVICE_ID) -f $(PCI_VENDOR_ID) -l $(PCI_CLASS_CODE) -r $(PCI_REVISION) -o $dst $(OPTROM_FLAGS) $src
482 [Unicode-Text-File.UEFI_HII]
487 $(OUTPUT_DIR)(+)$(MODULE_NAME)StrDefs.hpk
488 $(DEBUG_DIR)(+)$(MODULE_NAME)StrDefs.h
492 [Visual-Form-Representation-File.UEFI_HII]
502 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.hpk
505 -$(MD) $(OUTPUT_DIR)(+)${s_dir} > NUL 2>&1
506 "$(VFRPP)" $(VFRPP_FLAGS) $(INC) ${src} > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
507 -$(MD) $(OUTPUT_DIR)(+)${s_dir} > NUL 2>&1
508 "$(VFR)" $(VFR_FLAGS) --create-ifr-package --output-directory $(OUTPUT_DIR)(+)${s_dir} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
510 [Hii-Binary-Package.UEFI_HII]
515 $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.lib
517 <Command.MSFT, Command.INTEL>
518 GenFw -o $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc -g $(MODULE_GUID) --hiipackage $(HII_BINARY_PACKAGES)
519 "$(RC)" /Fo${dst} $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc
522 GenFw -o $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc -g $(MODULE_GUID) --hiibinpackage $(HII_BINARY_PACKAGES)
523 "$(RC)" $(RC_FLAGS) $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc ${dst}