2 # Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
3 # Portions copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
4 # 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.
15 # "*" is used to indicate that the source files will be processed at the same time.
16 # "?" is used to indicate that the source files will be processed one by one.
18 # "[" <File-Type>[.<Build-Type>][.<Arch>][, <File-Type>[.<Build-Type>][.<Arch>]] "]" <EOL>
19 # <InputFile[.<ToolChainFamily>]> <EOL>
20 # (?|*).<File-Extension> [(\n|,) (?|*).<File-Extension>]
22 # <OutputFile[.<ToolChainFamily>]> <EOL>
28 # <Command[.<ToolChainFamily>]> <EOL>
32 # <Build-Type> is the MODULE_TYPE in EDK2 or COMPONENT_TYPE in EDK.
33 # Missing <InputFile> will cause an exception and break build.
34 # Missing <Command> will cause that related build target won't be generated but
38 ## Placeholders for string substitution
40 # ${src} Source file(s) to be built (full path)
41 # ${s_path} Source file directory (absolute path)
42 # ${s_dir} Source file relative directory within a module
43 # (Note: ${s_dir} is always equals to "." if source file is given in absolute path.)
44 # ${s_name} Source file name without path
45 # ${s_base} Source file name without extension and path
46 # ${s_ext} Source file extension
48 # ${dst} Destination file(s) built from ${src} (full path)
49 # ${d_path} Destination file directory (absolute path)
50 # ${d_name} Destination file name without path
51 # ${d_base} Destination file name without extension and path
52 # ${d_ext} Destination file extension
54 # (+) Directory separator
58 # $(WORKSPACE) Workspace directory
59 # $(OUTPUT_DIR) Directory for intermediate files for building a module
60 # $(DEBUG_DIR) Directory for files used to debug a module
61 # $(BUILD_DIR) All files for building a platform will be put in this directory
62 # $(BIN_DIR) Common directory for executable files
63 # $(FV_DIR) Directory to store flash image files
64 # $(INC) Search path of current module
65 # $(INC_LIST) A file containing search pathes of current module
66 # $(LIBS) Static library files of current module
67 # $(<tool>_FLAGS) Tools flags of current module
68 # $(MODULE_NAME) Current module name
69 # $(MODULE_TYPE) Current module type
70 # $(MODULE_GUID) Current module guid
71 # $(ARCH) Architecture of current module
72 # $(TOOLCHAIN) Toolchain used to build current module
73 # $(TARGET) Target of current module (DEBUG/RELEASE)
74 # $(<tool>) Path of tool
75 # $(EDK_TOOLS_PATH) Path of build tools
76 # $(<FILE_TYPES>) File list of each file type
77 # (Note: The macro name is derived from file type name. For example,
78 # C-Code-File will have C_CODE_FILES macro.)
79 # $(<FILE_TYPES_LIST>) Macro point to a file containing list of files of a file type
81 # Note: The macro and file name are derived from file type name.
82 # For example, C-Code-File will have C_CODE_FILES_LIST macro pointing
83 # to $(OUTPUT_DIR)/c_code_files.lst. The list file and macro name
84 # will be generated only when this macro is used in command line.
85 # This is intended to get over the long command line limitation.
90 # $(RM) delete command
91 # $(MD) create dir command
92 # $(RD) remove dir command
97 # Don't change following names of file types and their associated files,
98 # which are also used in tools' code
102 # Dynamic-Library-File
103 # Static-Library-File
104 # Visual-Form-Representation-File
108 ## Build Rule Version Number
109 # build_rule_version=0.1
126 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
128 <Command.MSFT, Command.INTEL>
129 "$(CC)" /Fo${dst} $(CC_FLAGS) $(INC) ${src}
131 <Command.GCC, Command.RVCT>
132 # For RVCTCYGWIN CC_FLAGS must be first to work around pathing issues
133 "$(CC)" $(CC_FLAGS) -o ${dst} $(INC) ${src}
134 "$(SYMRENAME)" $(SYMRENAME_FLAGS) ${dst}
136 <Command.ARMGCC, Command.ARMLINUXGCC>
137 "$(CC)" $(CC_FLAGS) -o ${dst} $(INC) ${src}
149 [Assembly-Code-File.COMMON.COMMON]
150 <InputFile.MSFT, InputFile.INTEL, InputFile.RVCT>
160 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
162 <Command.MSFT, Command.INTEL>
163 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
164 Trim --source-code --convert-hex -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
165 "$(ASM)" /Fo${dst} $(ASM_FLAGS) /I${s_path} $(INC) ${d_path}(+)${s_base}.iii
167 <Command.GCC, Command.RVCT>
168 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
169 Trim --trim-long --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
170 # For RVCTCYGWIN ASM_FLAGS must be first to work around pathing issues
171 "$(ASM)" $(ASM_FLAGS) -o ${dst} $(INC) ${d_path}(+)${s_base}.iii
173 [Assembly-Code-File.COMMON.IPF]
181 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
183 <Command.MSFT, Command.INTEL>
184 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
185 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
186 # For RVCTCYGWIN ASM_FLAGS must be first to work around pathing issues
187 "$(ASM)" $(ASM_FLAGS) -o ${dst} ${d_path}(+)${s_base}.iii
189 [Visual-Form-Representation-File]
199 $(DEBUG_DIR)(+)${s_dir}(+)${s_base}.c
202 "$(VFRPP)" $(VFRPP_FLAGS) $(INC) ${src} > $(OUTPUT_DIR)(+)${s_base}.i
203 "$(VFR)" $(VFR_FLAGS) --string-db $(OUTPUT_DIR)(+)$(MODULE_NAME)StrDefs.hpk --output-directory ${d_path} $(OUTPUT_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, Command.ARMLINUXGCC>
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}
246 <Command.ARMGCC, Command.ARMLINUXGCC>
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)
276 <Command.ARMGCC, Command.ARMLINUXGCC>
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, Command.ARMLINUXGCC>
298 "$(GENFW)" -e $(MODULE_TYPE) -o ${dst} ${src} $(GENFW_FLAGS)
299 $(CP) ${dst} $(OUTPUT_DIR)
300 $(CP) ${dst} $(BIN_DIR)
301 -$(CP) $(DEBUG_DIR)(+)*.map $(OUTPUT_DIR)
304 $(CP) ${src} $(DEBUG_DIR)(+)$(MODULE_NAME).debug
305 $(OBJCOPY) --strip-unneeded -R .eh_frame ${src}
308 #The below 2 lines are only needed for UNIXGCC tool chain, which genereates PE image directly
310 -$(OBJCOPY) $(OBJCOPY_ADDDEBUGFLAG) ${src}
311 -$(CP) $(DEBUG_DIR)(+)$(MODULE_NAME).debug $(BIN_DIR)
313 "$(GENFW)" -e $(MODULE_TYPE) -o ${dst} ${src} $(GENFW_FLAGS)
314 $(CP) ${dst} $(OUTPUT_DIR)
315 $(CP) ${dst} $(BIN_DIR)
316 -$(CP) $(DEBUG_DIR)(+)*.map $(OUTPUT_DIR)
319 # tool to convert Mach-O to PE/COFF
320 "$(MTOC)" -subsystem $(MODULE_TYPE) $(MTOC_FLAGS) ${src} $(DEBUG_DIR)(+)$(MODULE_NAME).pecoff
321 # create symbol file for GDB debug
323 "$(GENFW)" -e $(MODULE_TYPE) -o ${dst} $(DEBUG_DIR)(+)$(MODULE_NAME).pecoff $(GENFW_FLAGS)
324 $(CP) ${dst} $(OUTPUT_DIR)
325 $(CP) ${dst} $(BIN_DIR)
326 -$(CP) $(DEBUG_DIR)(+)*.map $(OUTPUT_DIR)
328 [Dependency-Expression-File]
333 $(OUTPUT_DIR)(+)$(MODULE_NAME).depex
339 "$(PP)" $(APP_FLAGS) $(INC) ${src} > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
340 Trim --source-code -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
341 GenDepex -t $(MODULE_TYPE) -o ${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
343 [Acpi-Source-Language-File]
348 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml
353 <Command.MSFT, Command.INTEL>
354 Trim --asl-file -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i -i $(INC_LIST) ${src}
355 "$(ASLPP)" $(ASLPP_FLAGS) $(INC) /I${s_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
356 Trim --source-code -l -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
357 "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii
360 Trim --asl-file -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i -i $(INC_LIST) ${src}
361 "$(ASLPP)" $(ASLPP_FLAGS) $(INC) -I${s_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
362 "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
364 [C-Code-File.AcpiTable]
369 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.acpi
374 <Command.MSFT, Command.INTEL>
375 "$(ASLCC)" /Fo$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASLCC_FLAGS) $(INC) ${src}
376 "$(ASLDLINK)" /OUT:$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
377 "$(GENFW)" -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(GENFW_FLAGS)
380 "$(ASLCC)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(CC_FLAGS) $(ASLCC_FLAGS) $(INC) ${src}
381 "$(ASLDLINK)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
382 "$(GENFW)" -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(GENFW_FLAGS)
384 [Acpi-Table-Code-File]
389 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.acpi
394 <Command.MSFT, Command.INTEL>
395 "$(ASLCC)" /Fo$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASLCC_FLAGS) $(INC) ${src}
396 "$(ASLDLINK)" /OUT:$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
397 "$(GENFW)" -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(GENFW_FLAGS)
400 "$(ASLCC)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(CC_FLAGS) $(ASLCC_FLAGS) $(INC) ${src}
401 "$(ASLDLINK)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
402 "$(GENFW)" -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(GENFW_FLAGS)
405 "$(ASLCC)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASLCC_FLAGS) $(INC) ${src}
406 "$(ASLDLINK)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(ASLDLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
407 "$(MTOC)" -subsystem $(MODULE_TYPE) $(MTOC_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.dll $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.efi
408 "$(GENFW)" -o ${dst} -c $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.efi $(GENFW_FLAGS)
413 ?.asm16, ?.Asm16, ?.ASM16
419 $(OUTPUT_DIR)(+)${s_base}.com
421 <Command.MSFT, Command.INTEL>
422 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
423 Trim --source-code --convert-hex -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
424 cd $(OUTPUT_DIR)(+)${s_dir}
425 "$(ASM16)" /nologo /c /omf $(INC) /Fo$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj ${d_path}(+)${s_base}.iii
426 "$(ASMLINK)" $(ASMLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj,${dst},,,,
429 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
430 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
431 "$(ASM)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASM_FLAGS) $(INC) ${d_path}(+)${s_base}.iii
432 "$(DLINK)" -o ${dst} $(DLINK_FLAGS) -\( $(DLINK_SPATH) $(LIBS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj -\)
435 "$(PP)" $(PP_FLAGS) $(INC) ${src} > ${d_path}(+)${s_base}.i
436 Trim --source-code -o ${d_path}(+)${s_base}.iii ${d_path}(+)${s_base}.i
437 "$(ASM)" -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj $(ASM_FLAGS) $(INC) ${d_path}(+)${s_base}.iii
438 "$(SLINK)" $(SLINK_FLAGS) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.slib $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.obj
439 otool -t $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.slib | hex2bin.py ${dst}
442 [Microcode-File.USER_DEFINED, Microcode-File.Microcode]
444 ?.txt, ?.TXT, ?.Txt, ?.mut, ?.inc
447 $(OUTPUT_DIR)(+)${s_base}.mcb
450 "$(GENFW)" -o ${dst} -m ${src} $(GENFW_FLAGS)
452 [Microcode-Binary-File]
460 $(OUTPUT_DIR)(+)$(MODULE_NAME).bin
463 "$(GENFW)" -o ${dst} -j $(MICROCODE_BINARY_FILES) $(GENFW_FLAGS)
464 -$(CP) ${dst} $(BIN_DIR)
479 $(DEBUG_DIR)(+)AutoGen.c
480 $(DEBUG_DIR)(+)$(MODULE_NAME)StrDefs.h
481 $(OUTPUT_DIR)(+)$(MODULE_NAME)StrDefs.hpk
485 [Efi-Image.UEFI_OPTIONROM]
490 $(BIN_DIR)(+)$(MODULE_NAME).rom
493 $(OPTROM) -i $(PCI_DEVICE_ID) -f $(PCI_VENDOR_ID) -l $(PCI_CLASS_CODE) -r $(PCI_REVISION) -o $dst $(OPTROM_FLAGS) $src
495 [Unicode-Text-File.UEFI_HII]
500 $(OUTPUT_DIR)(+)$(MODULE_NAME)StrDefs.hpk
501 $(DEBUG_DIR)(+)$(MODULE_NAME)StrDefs.h
505 [Visual-Form-Representation-File.UEFI_HII]
515 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.hpk
518 "$(VFRPP)" $(VFRPP_FLAGS) $(INC) ${src} > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
519 "$(VFR)" $(VFR_FLAGS) --create-ifr-package --string-db $(OUTPUT_DIR)(+)$(MODULE_NAME)StrDefs.hpk --output-directory $(OUTPUT_DIR)(+)${s_dir} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i
521 [Hii-Binary-Package.UEFI_HII]
525 <OutputFile.MSFT, OutputFile.INTEL, OutputFile.GCC>
526 $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.lib
528 <OutputFile.XCODE, OutputFile.RVCT, OutputFile.ARMGCC>
529 $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc
531 <Command.MSFT, Command.INTEL>
532 "$(GENFW)" -o $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc -g $(MODULE_GUID) --hiipackage $(HII_BINARY_PACKAGES) $(GENFW_FLAGS)
533 "$(RC)" /Fo${dst} $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc
536 "$(GENFW)" -o $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc -g $(MODULE_GUID) --hiibinpackage $(HII_BINARY_PACKAGES) $(GENFW_FLAGS)
537 "$(RC)" $(RC_FLAGS) $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc ${dst}
539 <Command.XCODE, Command.RVCT, Command.ARMGCC, Command.ARMLINUXGCC>
540 GenFw -o $(OUTPUT_DIR)(+)$(MODULE_NAME)hii.rc -g $(MODULE_GUID) --hiibinpackage $(HII_BINARY_PACKAGES)