path: root/docs/user-guide.md
diff options
authorJeenu Viswambharan <jeenu.viswambharan@arm.com>2014-05-15 14:47:21 +0100
committerJeenu Viswambharan <jeenu.viswambharan@arm.com>2014-05-16 17:11:31 +0100
commitc3c1e9b0abe1a879dad4400421ad00849231eb3c (patch)
treee3ceb623dd8cf2ce7fa54e0aca379d49515b6bf2 /docs/user-guide.md
parente35c404599016a8ed09c12d54bf4d1aa9e527831 (diff)
Document summary of build options in user guide
Change-Id: I6bd077955bf3780168a874705974bbe72ea0f5f1
Diffstat (limited to 'docs/user-guide.md')
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/user-guide.md b/docs/user-guide.md
index 1bb0fe9..edf03f0 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -83,6 +83,9 @@ To build the software for the FVPs, follow these steps:
BL33=<path-to>/<bl33_image> \
make PLAT=fvp all fip
+ See the "Summary of build options" for information on available build
+ options.
By default this produces a release version of the build. To produce a debug
version instead, refer to the "Debugging options" section below. UEFI can be
used as the BL3-3 image, refer to the "Obtaining the normal world software"
@@ -120,6 +123,34 @@ To build the software for the FVPs, follow these steps:
make realclean
+### Summary of build options
+ARM Trusted Firmware build system supports the following build options. Unless
+mentioned otherwise, these options are expected to be specified at the build
+command line and are not to be modified in any component makefiles. Note that
+the build system doesn't track dependency for build options. Therefore, if any
+of the build options are changed from a previous build, a clean build must be
+* `BL33`: Path to BL33 image in the host file system. This is mandatory for
+ `fip` target
+* `CROSS_COMPILE`: Prefix to tool chain binaries. Please refer to examples in
+ this document for usage
+* `DEBUG`: Chooses between a debug and release build. It can take either 0
+ (release) or 1 (debug) as values. 0 is the default
+* `PLAT`: Choose a platform to build ARM Trusted Firmware for. The chosen
+ platform name must be the name of one of the directories under the `plat/`
+ directory other than `common`
+* `SPD`: Choose a Secure Payload Dispatcher component to be built into the
+ Trusted Firmware. The value should be the path to the directory containing
+ SPD source; the directory is expected to contain `spd.mk` makefile
+* `V`: Verbose build. If assigned anything other than 0, the build commands
+ are printed. Default is 0
### Creating a Firmware Image Package